All files / src/abap/types class_definition.ts

95.79% Statements 228/238
82.35% Branches 56/68
85% Functions 17/20
95.79% Lines 228/238

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 2381x 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 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1244x     1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 1244x 5x 5x 1158x 1158x 1158x 1158x 1158x 1158x 1158x 1158x 1158x 1244x 1244x 1244x 1244x 1244x 1244x 1x 1x     1x 1x 498x 498x 1x 1x 2983x 2983x 1x 1x 1856x 1856x 1x 1x 7732x 7732x 1x 1x 3289x 3289x 1x 1x 144x 144x 1x 1x 2x 2x 1x 1x 3125x 3125x 1x 1x 2602x 2602x 1x 1x     1x 1x 74x 74x 1x 1x     1x 1x 1x 1x 1x 1x 1x 1x 1x 1243x 1243x 1243x 1243x 1243x 1x 1x 1154x 560x 1x 1x 1x 560x 1153x 1x 1x 1158x 1158x 1158x 1158x 419x 419x 23x 23x 1x 23x 22x 22x 6x 6x 16x 16x 419x 3x 3x 419x 419x 1158x 1158x 564x 564x 4x 4x 564x 1154x 1x 1x 1243x 1243x 1x 1x 1x 1x 1x 1243x 1243x 1x 1x 1244x 1244x 344x 344x 259x 344x 68x 68x 344x 1244x 1x 1x 1243x 83x 83x 83x     83x 83x 83x 83x 83x 57x 83x 2x 26x 24x 24x 83x 1243x 1x 1x
import {StatementNode, StructureNode} from "../nodes";
import {MethodDefinitions} from "./method_definitions";
import {SuperClassName} from "../2_statements/expressions";
import * as Statements from "../2_statements/statements";
import * as Structures from "../3_structures/structures";
import * as Expressions from "../2_statements/expressions";
import {Attributes} from "./class_attributes";
import {Identifier} from "../4_file_information/_identifier";
import {CurrentScope} from "../5_syntax/_current_scope";
import {IClassDefinition} from "./_class_definition";
import {TypeDefinitions} from "./type_definitions";
import {ScopeType} from "../5_syntax/_scope_type";
import {EventDefinition} from "./event_definition";
import {Visibility} from "../4_file_information/visibility";
import {IEventDefinition} from "./_event_definition";
import {IMethodDefinitions} from "./_method_definitions";
import {ObjectOriented} from "../5_syntax/_object_oriented";
import {IImplementing} from "./_interface_definition";
import {ReferenceType} from "../5_syntax/_reference";
import {AbstractToken} from "../1_lexer/tokens/abstract_token";
import {SyntaxInput} from "../5_syntax/_syntax_input";
import {Alias} from "./alias";
 
export class ClassDefinition extends Identifier implements IClassDefinition {
  private readonly methodDefs: MethodDefinitions;
  private readonly types: TypeDefinitions;
  private readonly attributes: Attributes;
  private readonly events: IEventDefinition[];
  private readonly friends: string[];
  private readonly superClass: string | undefined;
  private readonly implementing: IImplementing[];
  private readonly testing: boolean;
  private readonly abstract: boolean;
  private readonly finalValue: boolean;
  private readonly globalValue: boolean;
  private readonly sharedMemory: boolean;
  private readonly aliases: Alias[];
 
  public constructor(node: StructureNode, input: SyntaxInput) {
    if (!(node.get() instanceof Structures.ClassDefinition)) {
      throw new Error("ClassDefinition, unexpected node type");
    }
 
    const def = node.findFirstStatement(Statements.ClassDefinition);
    const name = def!.findDirectExpression(Expressions.ClassName)!.getFirstToken();
    super(name, input.filename);
    input.scope.addClassDefinition(this);
 
    this.events = [];
    this.implementing = [];
    this.globalValue = def!.findFirstExpression(Expressions.ClassGlobal) !== undefined;
    this.finalValue = def!.findFirstExpression(Expressions.ClassFinal) !== undefined;
 
    input.scope.push(ScopeType.ClassDefinition, name.getStr(), name.getStart(), input.filename);
 
    this.superClass = this.findSuper(def, input);
    this.friends = this.findFriends(def, input);
 
    this.parse(input, node);
 
    const helper = new ObjectOriented(input.scope);
    helper.fromSuperClassesAndInterfaces(this);
 
    this.attributes = new Attributes(node, input);
    this.types = this.attributes.getTypes();
    this.aliases = this.attributes.getAliases();
 
    const events = node.findAllStatements(Statements.Events);
    for (const e of events) {
      this.events.push(new EventDefinition(e, Visibility.Public, input)); // todo, all these are not Public
    }
 
    this.methodDefs = new MethodDefinitions(node, input);
 
    input.scope.pop(node.getLastToken().getEnd());
 
    const concat = def!.concatTokens().toUpperCase();
 
    this.testing = concat.includes(" FOR TESTING");
    this.sharedMemory = concat.includes(" SHARED MEMORY ENABLED");
    this.abstract = def?.findDirectTokenByText("ABSTRACT") !== undefined;
 
    // perform checks after everything has been initialized
    this.checkMethodsFromSuperClasses(input.scope);
    this.checkMethodNameLength();
  }
 
  public getFriends() {
    return this.friends;
  }
 
  public getEvents() {
    return this.events;
  }
 
  public getMethodDefinitions(): IMethodDefinitions {
    return this.methodDefs;
  }
 
  public getTypeDefinitions(): TypeDefinitions {
    return this.types;
  }
 
  public getSuperClass(): string | undefined {
    return this.superClass;
  }
 
  public getAttributes(): Attributes {
    return this.attributes;
  }
 
  public isGlobal(): boolean {
    return this.globalValue;
  }
 
  public isFinal(): boolean {
    return this.finalValue;
  }
 
  public getImplementing(): readonly IImplementing[] {
    return this.implementing;
  }
 
  public getAliases() {
    return this.aliases;
  }
 
  public isForTesting(): boolean {
    return this.testing;
  }
 
  public isAbstract(): boolean {
    return this.abstract;
  }
 
  public isSharedMemory(): boolean {
    return this.sharedMemory;
  }
 
/*
  public getEvents() {
  }
*/
 
  ///////////////////
 
  private findSuper(def: StatementNode | undefined, input: SyntaxInput): string | undefined {
    const token = def?.findDirectExpression(SuperClassName)?.getFirstToken();
    this.addReference(token, input);
    const name = token?.getStr();
    return name;
  }
 
  private checkMethodNameLength() {
    for (const m of this.methodDefs.getAll()) {
      if (m.getName().length > 30 && m.getName().includes("~") === false) {
        const message = `Method name "${m.getName()}" is too long, maximum length is 30 characters`;
        throw new Error(message);
      }
    }
  }
 
  private checkMethodsFromSuperClasses(scope: CurrentScope) {
    let sup = this.getSuperClass();
    const names: Set<string> = new Set();
 
    while (sup !== undefined) {
      const cdef = scope.findClassDefinition(sup);
      for (const m of cdef?.getMethodDefinitions()?.getAll() || []) {
        const name = m.getName().toUpperCase();
        if (m.getVisibility() === Visibility.Private) {
          continue;
        } else if (name === "CONSTRUCTOR"
            || name === "DESTRUCTOR"
            || name === "CLASS_CONSTRUCTOR") {
          continue;
        }
        names.add(name);
      }
      for (const a of cdef?.getAliases() || []) {
        names.add(a.getName().toUpperCase());
      }
      sup = cdef?.getSuperClass();
    }
 
    for (const m of this.getMethodDefinitions().getAll()) {
      if (names.has(m.getName().toUpperCase())
          && m.isRedefinition() === false) {
        throw new Error(`${m.getName().toUpperCase()} already declared in superclass`);
      }
    }
  }
 
  private findFriends(def: StatementNode | undefined, input: SyntaxInput): string[] {
    const result: string[] = [];
    for (const n of def?.findDirectExpression(Expressions.ClassFriends)?.findDirectExpressions(Expressions.ClassName) || []) {
      const token = n.getFirstToken();
      this.addReference(token, input);
      const name = token.getStr();
      result.push(name);
    }
    return result;
  }
 
  private addReference(token: AbstractToken | undefined, input: SyntaxInput) {
    const name = token?.getStr();
    if (name) {
      const s = input.scope.findClassDefinition(name);
      if (s) {
        input.scope.addReference(token, s, ReferenceType.ObjectOrientedReference, input.filename, {ooName: name.toUpperCase(), ooType: "CLAS"});
      } else if (input.scope.getDDIC().inErrorNamespace(name) === false) {
        input.scope.addReference(token, undefined, ReferenceType.ObjectOrientedVoidReference, input.filename);
      }
    }
  }
 
  private parse(input: SyntaxInput, inputNode: StructureNode) {
    for (const node of inputNode.findAllStatements(Statements.InterfaceDef)) {
      const partial = node.findDirectTokenByText("PARTIALLY") !== undefined;
      const token = node.findFirstExpression(Expressions.InterfaceName)?.getFirstToken();
      if (token === undefined) {
        throw new Error("ClassDefinition, unable to find interface token");
      }
      const name = token.getStr().toUpperCase();
      this.implementing.push({name, partial});
 
      const intf = input.scope.findInterfaceDefinition(name);
      if (intf) {
        input.scope.addReference(token, intf, ReferenceType.ObjectOrientedReference, input.filename, {ooName: name.toUpperCase(), ooType: "INTF"});
      } else if (input.scope.getDDIC().inErrorNamespace(name) === false) {
        input.scope.addReference(token, undefined, ReferenceType.ObjectOrientedVoidReference, input.filename, {ooName: name.toUpperCase(), ooType: "INTF"});
      } else {
        input.scope.addReference(token, undefined, ReferenceType.ObjectOrientedUnknownReference, input.filename, {ooName: name.toUpperCase(), ooType: "INTF"});
      }
    }
  }
 
}