All files / src/abap/5_syntax/expressions method_parameters.ts

84.1% Statements 217/258
62.19% Branches 51/82
100% Functions 9/9
84.1% Lines 217/258

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 2581x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 38x 38x 38x 38x 38x 13x     13x 13x 13x 4x 13x 9x 9x 13x 13x 16x 16x 16x 4x 4x 16x 4x 4x 16x 4x 4x 16x 4x 4x 16x     16x   16x 16x 10x 10x 10x 38x 38x 38x 38x 4x 4x 4x   4x     4x 4x 4x 4x 1x 4x 3x 3x     3x 4x 38x 38x 4x 4x 4x 1x 4x 3x 3x     3x 3x 4x 4x 4x 1x 4x   3x     4x 4x 38x 38x 4x 4x 4x 1x 4x 3x 3x     3x 3x 4x 4x     4x 4x 4x 4x 38x 38x 29x 29x 29x 29x 6x 6x 22x 22x 29x 18x 18x 22x 29x 28x 28x 2x 28x     26x 26x 20x 29x 17x 17x 29x 38x 38x 27x 1x 1x 26x 38x 38x 29x 29x 29x 29x 29x 29x   29x     29x 29x 29x 29x 38x     38x 38x 38x     38x 38x 38x     38x 38x 38x 29x 95x 27x 27x 95x 29x 38x 38x 38x 4x 4x 4x     4x 37x 37x 37x 28x 28x 28x 38x 38x 8x 8x 8x 8x 8x   8x     8x 8x 8x 8x 8x     8x 8x 8x     8x 8x 8x     8x 8x 8x 8x 8x 8x 8x 8x 38x 38x
import {CurrentScope} from "../_current_scope";
import {VoidType} from "../../types/basic";
import * as Expressions from "../../2_statements/expressions";
import {IMethodDefinition} from "../../types/_method_definition";
import {ExpressionNode} from "../../nodes";
import {InlineData} from "./inline_data";
import {Target} from "./target";
import {AbstractType} from "../../types/basic/_abstract_type";
import {INode} from "../../nodes/_inode";
import {Source} from "./source";
import {TypeUtils} from "../_type_utils";
 
interface IListItemT {
  name: string;
  target: ExpressionNode;
  targetType: AbstractType | undefined;
}
 
interface IListItemS {
  name: string;
  source: ExpressionNode;
  sourceType: AbstractType | undefined;
}
 
export class MethodParameters {
 
  private requiredParameters: Set<string> | undefined = undefined;
 
  public runSyntax(node: INode, scope: CurrentScope, method: IMethodDefinition | VoidType, filename: string): void {
    if (!(node.get() instanceof Expressions.MethodParameters)) {
      throw new Error("MethodParameters, unexpected input");
    }
 
    const children = node.getChildren().slice();
    if (method instanceof VoidType) {
      this.requiredParameters = new Set();
    } else {
      this.requiredParameters = new Set(method.getParameters().getRequiredParameters().map(i => i.getName().toUpperCase()));
    }
 
    while (children.length > 0) {
      const name = children.shift()?.getFirstToken().getStr().toUpperCase();
      switch (name) {
        case "EXPORTING":
          this.checkExporting(children.shift(), scope, method, filename, false);
          break;
        case "IMPORTING":
          this.checkImporting(children.shift(), scope, method, filename);
          break;
        case "CHANGING":
          this.checkChanging(children.shift(), scope, method, filename);
          break;
        case "RECEIVING":
          this.checkReceiving(children.shift(), scope, method, filename);
          break;
        case "EXCEPTIONS":
          children.shift(); // todo, old style exceptions
          break;
        default:
          throw new Error("MethodParameters, unexpected token, " + name);
      }
    }
 
    this.reportErrors();
  }
 
///////////////////////
 
  private checkReceiving(node: INode | undefined, scope: CurrentScope, method: IMethodDefinition | VoidType, filename: string) {
 
    const type = method instanceof VoidType ? method : method.getParameters().getReturning()?.getType();
    if (type === undefined) {
      throw new Error("Method does not have a returning parameter");
    } else if (!(node instanceof ExpressionNode)) {
      throw new Error("checkReceiving, not an expression node");
    }
 
    const target = node.findDirectExpression(Expressions.Target);
    const inline = target?.findDirectExpression(Expressions.InlineData);
    if (inline) {
      new InlineData().runSyntax(inline, scope, filename, type);
    } else if (target) {
      const targetType = new Target().runSyntax(target, scope, filename);
      if (targetType && new TypeUtils(scope).isAssignable(type, targetType) === false) {
        throw new Error("Method returning value not type compatible");
      }
    }
  }
 
  private checkImporting(node: INode | undefined, scope: CurrentScope, method: IMethodDefinition | VoidType, filename: string) {
    for (const item of this.parameterListT(node, scope, filename)) {
      let parameterType: AbstractType | undefined = undefined;
      if (method instanceof VoidType) {
        parameterType = method;
      } else {
        const parameter = method.getParameters().getExporting().find(p => p.getName().toUpperCase() === item.name);
        if (parameter === undefined) {
          throw new Error("Method exporting parameter \"" + item.name + "\" does not exist");
        }
        parameterType = parameter.getType();
      }
 
      const inline = item.target.findDirectExpression(Expressions.InlineData);
      if (inline) {
        new InlineData().runSyntax(inline, scope, filename, parameterType);
      } else if (item.targetType === undefined) {
        throw new Error("Could not determine target type");
      } else if (item.targetType && new TypeUtils(scope).isAssignable(parameterType, item.targetType) === false) {
        throw new Error("Method parameter type not compatible, " + item.name);
      }
    }
  }
 
  private checkChanging(node: INode | undefined, scope: CurrentScope, method: IMethodDefinition | VoidType, filename: string) {
    for (const item of this.parameterListT(node, scope, filename)) {
      let parameterType: AbstractType | undefined = undefined;
      if (method instanceof VoidType) {
        parameterType = method;
      } else {
        const parameter = method.getParameters().getChanging().find(p => p.getName().toUpperCase() === item.name);
        if (parameter === undefined) {
          throw new Error("Method changing parameter \"" + item.name + "\" does not exist");
        }
        parameterType = parameter.getType();
      }
 
      if (item.targetType && new TypeUtils(scope).isAssignable(parameterType, item.targetType) === false) {
        throw new Error("Method parameter type not compatible, " + item.name);
      }
 
      this.requiredParameters?.delete(item.name);
    }
  }
 
  public checkExporting(node: INode | undefined, scope: CurrentScope,
                        method: IMethodDefinition | VoidType, filename: string, errors = true): void {
 
    const items = this.parameterListS(node, scope, filename, method);
    if (method instanceof VoidType) {
      return;
    }
 
    const allImporting = method.getParameters().getImporting();
    if (this.requiredParameters === undefined) {
      this.requiredParameters = new Set(method.getParameters().getRequiredParameters().map(i => i.getName().toUpperCase()));
    }
 
    for (const item of items) {
      const parameter = allImporting.find(p => p.getName().toUpperCase() === item.name);
      if (parameter === undefined) {
        throw new Error("Method importing parameter \"" + item.name + "\" does not exist");
      } else if (new TypeUtils(scope).isAssignable(item.sourceType, parameter.getType()) === false) {
        throw new Error("Method parameter type not compatible, " + item.name);
      }
      this.requiredParameters.delete(item.name);
    }
 
    if (errors === true) {
      this.reportErrors();
    }
  }
 
  private reportErrors() {
    for (const r of this.requiredParameters?.values() || []) {
      throw new Error(`method parameter "${r}" must be supplied`);
    }
  }
 
  private parameterListS(
    node: INode | undefined,
    scope: CurrentScope,
    filename: string,
    method: IMethodDefinition | VoidType): IListItemS[] {
 
    if (node === undefined) {
      return [];
    } else if (!(node.get() instanceof Expressions.ParameterListS)) {
      throw new Error("parameterListS, unexpected node");
    }
 
    const ret: IListItemS[] = [];
 
    for (const c of node.getChildren()) {
      if (!(c.get() instanceof Expressions.ParameterS) || !(c instanceof ExpressionNode)) {
        throw new Error("parameterListS, unexpected node, child");
      }
 
      const name = c.findDirectExpression(Expressions.ParameterName)?.getFirstToken().getStr().toUpperCase();
      if (name === undefined) {
        throw new Error("parameterListS, no name determined");
      }
 
      const source = c.findDirectExpression(Expressions.Source);
      if (source === undefined) {
        throw new Error("parameterListS, no source found");
      }
 
      let targetType: AbstractType | undefined = undefined;
      if (!(method instanceof VoidType)) {
        for (const i of method.getParameters().getImporting()) {
          if (i.getName().toUpperCase() === name) {
            targetType = i.getType();
          }
        }
      }
      let sourceType = new Source().runSyntax(source, scope, filename, targetType);
 
      if (sourceType === undefined) {
        if (method instanceof VoidType) {
          sourceType = method;
        } else {
          throw new Error("No source type determined for parameter " + name + " input");
        }
      }
 
      ret.push({name, source, sourceType});
    }
 
    return ret;
  }
 
  private parameterListT(
    node: INode | undefined,
    scope: CurrentScope,
    filename: string): IListItemT[] {
 
    if (node === undefined) {
      return [];
    } else if (!(node.get() instanceof Expressions.ParameterListT)) {
      throw new Error("parameterListT, unexpected node");
    }
 
    const ret: IListItemT[] = [];
 
    for (const c of node.getChildren()) {
      if (!(c.get() instanceof Expressions.ParameterT) || !(c instanceof ExpressionNode)) {
        throw new Error("parameterListT, unexpected node, child");
      }
 
      const name = c.findDirectExpression(Expressions.ParameterName)?.getFirstToken().getStr().toUpperCase();
      if (name === undefined) {
        throw new Error("parameterListT, no name determined");
      }
 
      const target = c.findDirectExpression(Expressions.Target);
      if (target === undefined) {
        throw new Error("parameterListT, no target found");
      }
 
      const targetType = new Target().runSyntax(target, scope, filename);
 
      ret.push({name, target, targetType});
    }
 
    return ret;
  }
 
}