All files / src/abap/types class_definition.ts

97.44% Statements 267/274
83.72% Branches 72/86
95.23% Functions 20/21
97.44% Lines 267/274

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 2751x 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 1383x     1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 1383x 9x 9x 2x 2x 2x 7x 7x 1288x 1288x 1288x 1288x 1288x 1288x 1288x 1288x 1288x 1383x 1383x 33x 1383x 6x 1255x 1249x 1249x 1288x 1288x 1288x 1288x 1288x 1x 1x 5x 5x 1x 1x 533x 533x 1x 1x 3339x 3339x 1x 1x 2099x 2099x 1x 1x 8764x 8764x 1x 1x 3714x 3714x 1x 1x 160x 160x 1x 1x 2x 2x 1x 1x 3537x 3537x 1x 1x 2974x 2974x 1x 1x 548x 548x 1x 1x 89x 89x 1x 1x     1x 1x 84x 84x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1382x 1382x 1382x 1382x 1382x 1x 1x 1288x 631x 1x 1x 1x 631x 1288x 1x 1x 1288x 1288x 1288x 1288x 1288x 1288x 483x 483x 25x 25x 1x 25x 24x 24x 6x 6x 18x 18x 18x 18x 25x 483x 3x 3x 483x 483x 1288x 1288x 631x 631x 4x 4x 631x 631x 631x 631x 2x 2x 631x 1288x 1x 1x 1382x 1382x 10x 10x 10x 10x 3x 10x 5x 7x   2x 2x 2x 10x 10x 1382x 1382x 1x 1x 1382x 1382x 390x 390x 296x 390x 77x 77x 390x 1382x 1x 1x 1382x 85x 85x 85x     85x 85x 85x 85x 85x 59x 85x 2x 26x 24x 24x 85x 1382x 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 {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, syntaxIssue} 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[];
  private readonly createVisibilityValue: Visibility;
 
  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) {
      const eventName = e.findDirectExpression(Expressions.EventName)?.concatTokens().toUpperCase();
      if (this.events.find(ev => ev.getName().toUpperCase() === eventName) !== undefined) {
        input.issues.push(syntaxIssue(input, e.getFirstToken(), "Event " + eventName + " already defined"));
        continue;
      }
      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;
    if (concat.includes(" CREATE PRIVATE")) {
      this.createVisibilityValue = Visibility.Private;
    } else if (concat.includes(" CREATE PROTECTED")) {
      this.createVisibilityValue = Visibility.Protected;
    } else {
      this.createVisibilityValue = Visibility.Public;
    }
 
    // perform checks after everything has been initialized
    this.checkMethodsFromSuperClasses(input);
    this.checkMethodNameLength(input);
  }
 
  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 getCreateVisibility(): Visibility {
    return this.createVisibilityValue;
  }
 
/*
  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(input: SyntaxInput) {
    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`;
        input.issues.push(syntaxIssue(input, m.getToken(), message));
      }
    }
  }
 
  private checkMethodsFromSuperClasses(input: SyntaxInput) {
    const scope = input.scope;
    let sup = this.getSuperClass();
    const names: Set<string> = new Set();
    const methods: Map<string, Visibility> = new Map();
 
    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);
        if (methods.has(name) === false) {
          methods.set(name, m.getVisibility());
        }
      }
      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) {
        input.issues.push(syntaxIssue(input, m.getToken(), `${m.getName().toUpperCase()} already declared in superclass`));
      }
      const superVisibility = methods.get(m.getName().toUpperCase());
      if (m.isRedefinition() === true
          && superVisibility !== undefined
          && m.getVisibility() !== superVisibility) {
        input.issues.push(syntaxIssue(input, m.getToken(), `${m.getName().toUpperCase()} redefinition visibility cannot be changed`));
      }
    }
  }
 
  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();
      const name = token.getStr();
      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.existsObject(name) !== undefined) {
        // DEFINITION DEFERRED friend
      } else if (input.scope.getDDIC().inErrorNamespace(name) === false) {
        input.scope.addReference(token, undefined, ReferenceType.ObjectOrientedVoidReference, input.filename);
      } else {
        input.issues.push(syntaxIssue(input, token, "Friend class " + name.toUpperCase() + " does not exist"));
      }
      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"});
      }
    }
  }
 
}