All files / src/abap/5_syntax spaghetti_scope.ts

97.57% Statements 362/371
97.05% Branches 99/102
100% Functions 32/32
97.57% Lines 362/371

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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 3711x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 24271x 1x 1x 667328x 667328x 1x 1x 1x 1x 1x 1x 1x     1x 24271x 24271x 24271x 24271x 24271x 1x 1x 353785x 353785x 1x 1x 15148x 15148x 1x 1x 19453x 19453x 1x 1x 60x 60x 1x 1x 352475x 352475x 1x 1x 8096x     8096x 8096x 1x 1x 10627x 10627x 1x 1x 177x 177x 177x 549x 549x 5x 5x 5x 5x 5x 544x 544x 172x 172x 172x 1x 1x 4478x 4478x 4478x 4478x 11432x 11432x 2173x 2173x 9259x 9259x 2305x 2305x 2305x 1x 1x 76x 76x 76x 76x 283x 283x 283x 76x 76x 76x 1x 1x 76x 76x 76x 76x 283x 283x 283x 76x 76x 76x 1x 1x 13x 13x 13x 13x 32x 12x 11x 11x 12x 21x 21x 2x 2x 2x 1x 1x 1031x 1031x 1031x 1031x 2914x 2914x 436x 436x 2478x 2478x 595x 595x 595x 1x 1x 2008x 2008x 2008x 2008x 5550x 5550x 757x 757x 4793x 4793x 1251x 1251x 1251x 1x 1x 15x 15x 15x 15x 43x 43x 1x 1x 42x 42x 14x 14x 14x 1x 1x 5123x 5123x 5123x 5123x 9646x 9646x 3758x 3758x 5888x 5888x 1365x 1365x 1365x 1x 1x 5x 8x 8x 3x 3x 3x 3x 8x 2x 2x 2x 1x 1x 14x 20x 20x 20x 7x 7x 20x 7x 7x 7x 1x 1x 3x 7x 7x 2x 2x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x       1x 1x 1x 1x 1x 1x 1x 10627x 10627x 1x 1x 1x 3x 3x 3x 9x 3x 3x 3x 3x 3x 3x 3x 9x 3x 3x 3x 1x 1x 3x 3x 3x 17x 11x 11x 3x 3x 11x 11x 17x 3x 3x 3x 1x 1x 2x 2x 2x 6x 2x 4x 3x 3x 4x 2x 6x 2x 2x 2x 1x 1x 1890x     1890x 1890x 1x 1x 7x 7x 1x 1x 9216x 9216x 1x 1x 1x 1x 8x 8x 8x 8x 32x 32x 32x 32x 8x 8x 8x 1x 1x 8011x 8011x 1414x 1414x 6597x 6597x 8011x 6121x 6121x 4659x 4659x 6121x 1938x 1938x 8011x 1887x 1887x 51x 51x 51x 1x 1x
import {Position} from "../../position";
import {TypedIdentifier} from "../types/_typed_identifier";
import {Identifier} from "../4_file_information/_identifier";
import {IClassDefinition} from "../types/_class_definition";
import {IInterfaceDefinition} from "../types/_interface_definition";
import {IFormDefinition} from "../types/_form_definition";
import {IScopeData, IScopeIdentifier, IScopeVariable, ISpaghettiScopeNode, ISpaghettiScope} from "./_spaghetti_scope";
import {ReferenceType} from "./_reference";
 
abstract class ScopeData {
  private readonly data: IScopeData;
 
  public constructor() {
    this.data = {
      vars: {},
      cdefs: {},
      idefs: {},
      forms: [], // todo, refactor to object
      types: {},
      extraLikeTypes: {},
      deferred: {},
      references: [],
      sqlConversion: [],
    };
  }
 
  public getData(): IScopeData {
    return this.data;
  }
}
 
export class SpaghettiScopeNode extends ScopeData implements ISpaghettiScopeNode {
  private readonly identifier: IScopeIdentifier;
  private readonly children: SpaghettiScopeNode[];
  private readonly parent: SpaghettiScopeNode | undefined;
  public [Symbol.for("debug.description")](){
    return `SpaghettiSN ${this.identifier.sname} ${this.identifier.stype}`;
  }
  public constructor(identifier: IScopeIdentifier, parent: SpaghettiScopeNode | undefined) {
    super();
    this.identifier = identifier;
    this.parent = parent;
    this.children = [];
  }
 
  public getParent(): SpaghettiScopeNode | undefined {
    return this.parent;
  }
 
  public addChild(node: SpaghettiScopeNode) {
    this.children.push(node);
  }
 
  public getChildren(): SpaghettiScopeNode[] {
    return this.children;
  }
 
  public getFirstChild(): SpaghettiScopeNode | undefined {
    return this.children[0];
  }
 
  public getIdentifier(): IScopeIdentifier {
    return this.identifier;
  }
 
  public calcCoverage(): {start: Position, end: Position} {
    if (this.identifier.end === undefined) {
      throw new Error("internal error, caclCoverage");
    }
    return {start: this.identifier.start, end: this.identifier.end};
  }
 
  public setEnd(end: Position): void {
    this.identifier.end = end;
  }
 
  public findDeferred(name: string): {id: Identifier | undefined, ooType: "CLAS" | "INTF"} | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    while (search !== undefined) {
      const found = search.getData().deferred[name.toUpperCase()];
      if (found) {
        return {
          id: new Identifier(found.token, search.identifier.filename),
          ooType: found.ooType,
        };
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findClassDefinition(name: string): IClassDefinition | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      const c = search.getData().cdefs[upper];
      if (c !== undefined) {
        return c;
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public listClassDefinitions(): IClassDefinition[] {
    let search: SpaghettiScopeNode | undefined = this;
    const ret: IClassDefinition[] = [];
 
    while (search !== undefined) {
      ret.push(...Object.values(search.getData().cdefs));
      search = search.getParent();
    }
 
    return ret;
  }
 
  public listInterfaceDefinitions(): IInterfaceDefinition[] {
    let search: SpaghettiScopeNode | undefined = this;
    const ret: IInterfaceDefinition[] = [];
 
    while (search !== undefined) {
      ret.push(...Object.values(search.getData().idefs));
      search = search.getParent();
    }
 
    return ret;
  }
 
  public findFormDefinition(name: string): IFormDefinition | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      for (const form of search.getData().forms) {
        if (form.getName().toUpperCase() === upper) {
          return form;
        }
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findInterfaceDefinition(name: string): IInterfaceDefinition | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      const idef = search.getData().idefs[upper];
      if (idef) {
        return idef;
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findType(name: string): TypedIdentifier | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      const found = search.getData().types[upper];
      if (found) {
        return found;
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findExtraLikeType(name: string): TypedIdentifier | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      const data = search.getData();
      if (data.extraLikeTypes[upper]) {
        return data.extraLikeTypes[upper];
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findVariable(name: string): TypedIdentifier | undefined {
    let search: SpaghettiScopeNode | undefined = this;
 
    const upper = name.toUpperCase();
    while (search !== undefined) {
      const data = search.getData();
      if (data.vars[upper]) {
        return data.vars[upper];
      }
      search = search.getParent();
    }
 
    return undefined;
  }
 
  public findWriteReference(pos: Position): TypedIdentifier | undefined {
    for (const r of this.getData().references) {
      if (r.referenceType === ReferenceType.DataWriteReference
          && r.position.getStart().equals(pos)) {
        if (r.resolved instanceof TypedIdentifier) {
          return r.resolved;
        }
      }
    }
 
    return undefined;
  }
 
  public findTableReference(pos: Position): string | undefined {
    for (const r of this.getData().references) {
      if (r.referenceType === ReferenceType.TableReference
          && r.position.getStart().equals(pos)
          && r.resolved) {
        return r.resolved.getName();
      }
    }
 
    return undefined;
  }
 
  public findTableVoidReference(pos: Position): boolean {
    for (const r of this.getData().references) {
      if (r.referenceType === ReferenceType.TableVoidReference
          && r.position.getStart().equals(pos)) {
        return true;
      }
    }
 
    return false;
  }
 
  // this method is used in the transpiler
  public findScopeForVariable(name: string): IScopeIdentifier | undefined {
    let search: SpaghettiScopeNode | undefined = this;
    const upper = name.toUpperCase();
 
    while (search !== undefined) {
      if (search.getData().vars[upper] !== undefined) {
        return search.getIdentifier();
      }
      search = search.getParent();
    }

    return undefined;
  }
 
}
 
export class SpaghettiScope implements ISpaghettiScope {
  private readonly node: SpaghettiScopeNode;
 
  public constructor(top: SpaghettiScopeNode) {
    this.node = top;
  }
 
  // list variable definitions across all nodes
  public listDefinitions(filename: string): IScopeVariable[] {
    const ret: IScopeVariable[] = [];
 
    for (const n of this.allNodes()) {
      if (n.getIdentifier().filename === filename) {
        const vars = n.getData().vars;
        for (const v in vars) {
          if (vars[v].getFilename() === filename) {
            ret.push({name: v, identifier: vars[v]});
          }
        }
      }
    }
 
    return ret;
  }
 
  public listReadPositions(filename: string): Identifier[] {
    const ret: Identifier[] = [];
 
    for (const n of this.allNodes()) {
      if (n.getIdentifier().filename === filename) {
        for (const v of n.getData().references) {
          if (v.referenceType === ReferenceType.DataReadReference && v.position.getFilename() === filename) {
            ret.push(v.position);
          }
        }
      }
    }
 
    return ret;
  }
 
  public listWritePositions(filename: string): Identifier[] {
    const ret: Identifier[] = [];
 
    for (const n of this.allNodes()) {
      if (n.getIdentifier().filename === filename) {
        for (const v of n.getData().references) {
          if (v.referenceType === ReferenceType.DataWriteReference && v.position.getFilename() === filename) {
            ret.push(v.position);
          }
        }
      }
    }
 
    return ret;
  }
 
  public lookupPosition(p: Position | undefined, filename: string | undefined): SpaghettiScopeNode | undefined {
    if (p === undefined || filename === undefined) {
      return undefined;
    }
    return this.lookupPositionTraverse(p, filename, this.node);
  }
 
  public getFirstChild() {
    return this.node.getFirstChild();
  }
 
  public getTop(): SpaghettiScopeNode {
    return this.node;
  }
 
/////////////////////////////
 
  private allNodes(): SpaghettiScopeNode[] {
    const ret: SpaghettiScopeNode[] = [];
    const stack: SpaghettiScopeNode[] = [this.node];
 
    while (stack.length > 0) {
      const current = stack.pop()!;
      ret.push(current);
      stack.push(...current.getChildren());
    }
 
    return ret;
  }
 
  private lookupPositionTraverse(p: Position, filename: string, node: SpaghettiScopeNode): SpaghettiScopeNode | undefined {
    const coverage = node.calcCoverage();
    if (node.getIdentifier().filename === filename && p.isBetween(coverage.start, coverage.end) === false) {
      return undefined;
    }
 
    // possible optimization: binary search the nodes
    for (const c of node.getChildren()) {
      const result = this.lookupPositionTraverse(p, filename, c);
      if (result !== undefined) {
        return result;
      }
    }
 
    if (node.getIdentifier().filename === filename
        && p.isBetween(coverage.start, coverage.end)) {
      return node;
    }
 
    return undefined;
  }
 
}