All files / src/abap/types method_parameters.ts

93.93% Statements 217/231
86.56% Branches 58/67
85.71% Functions 12/14
93.93% Lines 217/231

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 2311x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 421x     421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 1x 1x     1x 1x 36x 36x 1x 1x 443x 443x 443x 60x 60x 443x 443x 443x 443x 443x 1x 1x 33x   33x 29x 33x 2x 2x 2x 2x 2x 33x 1x 1x 1x 1x 1x 1x 1x 626x 626x 1x 1x 90x 90x 90x 32x 7x 7x 25x 25x 90x 4x     4x 4x 90x 90x 90x 1x 1x 450x 450x 1x 1x 540x 540x 1x 1x 547x 547x 1x 1x     1x 1x 2x 2x 1x 1x 1x 1x 421x 421x 421x 15x 15x 15x 15x 15x 7x 15x 8x 8x 8x 15x 15x 15x 15x 22x 22x 22x 22x 1x 1x 1x 22x 22x 6x 22x 15x 15x       22x 15x 15x 406x 406x 421x 131x 131x 2x 2x 1x 1x 2x 131x 406x 406x 421x 9x 9x 406x 406x 421x 6x 6x 406x 406x 421x 54x 54x 421x 1x 1x 146x 149x 149x     149x 149x 3x 149x 140x 140x 149x 149x 9x 9x 149x 13x 13x 13x 13x 13x 13x 13x 13x 149x 146x 137x 137x 9x 9x 9x 9x 9x 9x 1x 1x
import {StatementNode} from "../nodes/statement_node";
import {MethodDef} from "../2_statements/statements/method_def";
import * as Expressions from "../2_statements/expressions";
import {ExpressionNode} from "../nodes";
import {TypedIdentifier, IdentifierMeta} from "./_typed_identifier";
import {ObjectReferenceType, UnknownType, VoidType} from "./basic";
import {CurrentScope} from "../5_syntax/_current_scope";
import {MethodDefReturning} from "../5_syntax/expressions/method_def_returning";
import {MethodParam} from "../5_syntax/expressions/method_param";
import {IMethodParameters} from "./_method_parameters";
import {ObjectOriented} from "../5_syntax/_object_oriented";
import {ReferenceType} from "../5_syntax/_reference";
 
// todo:
// this.exceptions = [];
// also consider RAISING vs EXCEPTIONS
 
export class MethodParameters implements IMethodParameters {
  private readonly importing: TypedIdentifier[];
  private readonly optional: string[];
  private readonly exporting: TypedIdentifier[];
  private readonly changing: TypedIdentifier[];
  private preferred: string | undefined;
  private returning: TypedIdentifier | undefined;
  private readonly exceptions: string[]; // todo, not filled
  private readonly defaults: {[index: string]: ExpressionNode};
  private readonly filename: string;
 
  public constructor(node: StatementNode, filename: string, scope: CurrentScope) {
    if (!(node.get() instanceof MethodDef)) {
      throw new Error("MethodDefinition, expected MethodDef as part of input node");
    }
 
    this.importing = [];
    this.exporting = [];
    this.changing = [];
    this.optional = [];
    this.defaults = {};
    this.returning = undefined;
    this.preferred = undefined;
    this.exceptions = [];
    this.filename = filename;
 
    this.parse(node, scope, filename);
  }
 
  public getFilename(): string {
    return this.filename;
  }
 
  public getOptional(): string[] {
    return this.optional;
  }
 
  public getAll(): TypedIdentifier[] {
    const ret: TypedIdentifier[] = [];
    const returning = this.getReturning();
    if (returning) {
      ret.push(returning);
    }
    ret.push(...this.getImporting());
    ret.push(...this.getExporting());
    ret.push(...this.getChanging());
    return ret;
  }
 
  public getDefaultImporting(): string | undefined {
    if (this.importing.length === 0) {
      return undefined;
    } else if (this.importing.length === 1) {
      return this.importing[0].getName().toUpperCase();
    } else if (this.preferred) {
      return this.preferred;
    }
 
    let candidates = this.importing.map(i => i.getName().toUpperCase());
    candidates = candidates.filter(c => this.optional.indexOf(c) < 0);
    if (candidates.length === 1) {
      return candidates[0];
    }
 
    return undefined;
  }
 
  public getImporting() {
    return this.importing;
  }
 
  public getRequiredParameters() {
    const ret: TypedIdentifier[] = [];
 
    for (const i of this.getImporting()) {
      if (this.getOptional().some(o => o.toUpperCase() === i.getName().toUpperCase()) === true) {
        continue;
      }
      ret.push(i);
    }
    for (const i of this.getChanging()) {
      if (this.getOptional().some(o => o.toUpperCase() === i.getName().toUpperCase()) === true) {
        continue;
      }
      ret.push(i);
    }
 
    return ret;
  }
 
  public getExporting() {
    return this.exporting;
  }
 
  public getChanging() {
    return this.changing;
  }
 
  public getReturning() {
    return this.returning;
  }
 
  public getExceptions() {
    return this.exceptions;
  }
 
  public getParameterDefault(parameter: string) {
    return this.defaults[parameter.toUpperCase()];
  }
 
///////////////////
 
  private parse(node: StatementNode, scope: CurrentScope, filename: string): void {
 
    const handler = node.findFirstExpression(Expressions.EventHandler);
    if (handler) {
      const nameToken = node.findFirstExpression(Expressions.ClassName)?.getFirstToken();
      const ooName = nameToken?.getStr();
      const def = scope.findObjectDefinition(ooName);
      const doVoid = def ? false : !scope.getDDIC().inErrorNamespace(ooName);
      if (def) {
        scope.addReference(nameToken, def, ReferenceType.ObjectOrientedReference, filename);
      } else if (doVoid && ooName) {
        scope.addReference(nameToken, undefined, ReferenceType.ObjectOrientedVoidReference,
                           this.filename, {ooName: ooName.toUpperCase()});
      }
 
      const eventName = node.findFirstExpression(Expressions.Field)?.getFirstToken().getStr();
      const event = new ObjectOriented(scope).searchEvent(def, eventName);
      for (const p of handler.findAllExpressions(Expressions.MethodParamName)) {
        const token = p.getFirstToken();
        const search = token.getStr().toUpperCase().replace("!", "");
        this.optional.push(search); // all parameters optional for event handlers
        if (search === "SENDER" && def) {
          this.importing.push(new TypedIdentifier(token, this.filename, new ObjectReferenceType(def), [IdentifierMeta.EventParameter]));
          continue;
        }
        const found = event?.getParameters().find(p => p.getName().toUpperCase() === search);
        if (found) {
          this.importing.push(new TypedIdentifier(token, this.filename, found.getType(), [IdentifierMeta.EventParameter]));
        } else if (doVoid) {
          this.importing.push(new TypedIdentifier(token, this.filename, new VoidType(ooName), [IdentifierMeta.EventParameter]));
        } else {
          const type = new UnknownType(`handler parameter not found "${search}"`);
          this.importing.push(new TypedIdentifier(token, this.filename, type, [IdentifierMeta.EventParameter]));
        }
      }
      return;
    }
 
    const importing = node.findFirstExpression(Expressions.MethodDefImporting);
    if (importing) {
      this.add(this.importing, importing, scope, [IdentifierMeta.MethodImporting]);
      if (importing.concatTokens().toUpperCase().includes(" PREFERRED PARAMETER")) {
        this.preferred = importing.getLastToken().getStr().toUpperCase();
        if (this.preferred.startsWith("!")) {
          this.preferred = this.preferred.substring(1);
        }
      }
    }
 
    const exporting = node.findFirstExpression(Expressions.MethodDefExporting);
    if (exporting) {
      this.add(this.exporting, exporting, scope, [IdentifierMeta.MethodExporting]);
    }
 
    const changing = node.findFirstExpression(Expressions.MethodDefChanging);
    if (changing) {
      this.add(this.changing, changing, scope, [IdentifierMeta.MethodChanging]);
    }
 
    const returning = node.findFirstExpression(Expressions.MethodDefReturning);
    if (returning) {
      this.returning = new MethodDefReturning().runSyntax(returning, scope, this.filename, [IdentifierMeta.MethodReturning]);
    }
  }
 
  private add(target: TypedIdentifier[], source: ExpressionNode, scope: CurrentScope, meta: IdentifierMeta[]): void {
    for (const opt of source.findAllExpressions(Expressions.MethodParamOptional)) {
      const p = opt.findDirectExpression(Expressions.MethodParam);
      if (p === undefined) {
        continue;
      }
      const extraMeta: IdentifierMeta[] = [];
      if (opt.concatTokens().toUpperCase().startsWith("VALUE(")) {
        extraMeta.push(IdentifierMeta.PassByValue);
      } else if (meta.includes(IdentifierMeta.MethodImporting)) {
        extraMeta.push(IdentifierMeta.ReadOnly);
      }
      target.push(new MethodParam().runSyntax(p, scope, this.filename, [...meta, ...extraMeta]));
      if (opt.getLastToken().getStr().toUpperCase() === "OPTIONAL") {
        const name = target[target.length - 1].getName().toUpperCase();
        this.optional.push(name);
      } else if (opt.findFirstExpression(Expressions.Default)) {
        const name = target[target.length - 1].getName().toUpperCase();
        this.optional.push(name);
 
        const val = opt.findFirstExpression(Expressions.Default)?.getLastChild();
        if (val && val instanceof ExpressionNode) {
          this.defaults[name] = val;
        }
      }
    }
    if (target.length > 0) {
      return;
    }
 
    const params = source.findAllExpressions(Expressions.MethodParam);
    for (const param of params) {
      target.push(new MethodParam().runSyntax(param, scope, this.filename, meta));
    }
  }
 
}