All files / src ddic.ts

88.55% Statements 410/463
71.87% Branches 138/192
100% Functions 16/16
88.55% Lines 410/463

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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 4641x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9378x 9378x 1x 1x 1x 1x 991x 4x 4x 991x 21x 21x 966x 991x 791x 791x 175x 175x 175x 991x 259x 259x 46x 46x 213x 259x 259x     213x 259x 84x 259x 129x 129x 259x 175x 175x 991x 991x 991x 991x 1x 1x 3762x 3762x 787x 3762x 38x 3762x 21x 21x 21x 21x 21x 21x 21x 21x 3762x 4x 4x 4x 4x 4x 4x 4x 4x 3762x 3x 3762x 10x 3762x 1x 3762x 51x 3762x 6x 3762x 1x 3762x 3x 3762x 39x 3762x 1x 3762x 2x 3762x 1x 3762x 3x 3762x 4x 3762x 1014x 3762x 13x 3762x 11x 11x 11x 11x 11x 11x 11x 11x 3762x 14x 2x 14x 12x 12x     3762x 411x 408x 411x 3x 3x 3762x 52x 51x 52x 1x 1x 3762x 12x 12x 12x     3762x 1260x 1260x 1x 1x 474x     474x 474x 1x 1x 8x 8x 8x 6x 6x 6x 6x 6x 2x 8x 8x 1x 1x 1x 1x 1x 8x   8x 1x 1x 8x 1x 1x 856x 856x 40x 40x 816x 816x 856x     816x 816x 856x 14x 14x 802x 802x 856x 68x 68x 734x 734x 856x 1x 1x 733x 733x 733x 1x 1x 1042x     1042x 1042x 1042x 13x 13x 2x 2x 13x 1040x 1040x 1040x 1x 1x 1x 466x 466x 67x 67x 399x 466x 64x 466x 335x 335x 466x 1x 1x 7x 7x 5x 7x   2x 2x 2x 7x 1x 1x 116x     116x 116x 18x 116x 23x 98x 75x 75x 116x 1x 1x 174x     174x 174x 64x 64x 110x 174x     110x 110x 1x 1x 1x 193x     193x 193x 34x 34x 159x 193x     159x 193x     159x 159x 1x 1x 3x     3x 3x 1x 3x 1x 1x 1x 1x 3x 1x 1x 110x     110x 110x 2x 110x 10x 108x 98x 98x 110x 1x 1x 1x     1x 1x 1x 1x         1x 1x 1x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 2x   2x 1x 1x 1x 251x 251x 251x 9x 251x 2x 251x   251x   251x 251x   251x         251x 251x 184x     184x 251x 251x 2x     2x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 1x     1x 251x 251x 251x 251x 251x 251x 27x 251x   251x 251x 251x 251x 22x 251x 251x 251x 2x 251x 251x 251x 251x 251x 251x   251x   251x 251x 1x 1x  
/* eslint-disable default-case */
import {IRegistry} from "./_iregistry";
import {AbstractType} from "./abap/types/basic/_abstract_type";
import {Domain} from "./objects/domain";
import {DataElement} from "./objects/data_element";
import {Table} from "./objects/table";
import {TableType} from "./objects/table_type";
import * as Types from "./abap/types/basic";
import {ABAPObject} from "./objects/_abap_object";
import {InfoClassDefinition} from "./abap/4_file_information/_abap_file_information";
import {ObjectReferenceType, UnknownType, VoidType} from "./abap/types/basic";
import {View} from "./objects/view";
import {DataDefinition} from "./objects";
import {IObject} from "./objects/_iobject";
 
export interface ILookupResult {
  type: AbstractType;
  object?: IObject;
}
 
export class DDIC {
  private readonly reg: IRegistry;
 
  public constructor(reg: IRegistry) {
    this.reg = reg;
  }
 
  // the class might be local with a local super class with a global exception class as super
  // todo: returns true for both local and global exception classes
  public isException(def: InfoClassDefinition | undefined, _obj: ABAPObject): boolean {
    if (def === undefined) {
      return false;
    }
    if (def.name.toUpperCase() === "CX_ROOT") {
      return true;
    }
    let superClassName = def.superClassName;
    if (superClassName === undefined) {
      return false;
    }
 
    let i = 0;
    // max depth, make sure not to hit cyclic super class defintions
    while (i++ < 10 && superClassName !== undefined) {
      const found = this.reg.getObject("CLAS", superClassName) as ABAPObject | undefined;
      if (found === undefined) {
        break;
      }
 
      const superDef: InfoClassDefinition | undefined = found.getMainABAPFile()?.getInfo().getClassDefinitionByName(superClassName);
      if (superDef === undefined) {
        break;
      }
 
      if (superDef.superClassName) {
        superClassName = superDef.superClassName;
      } else {
        break;
      }
    }
 
    // todo, this should check for "CX_ROOT"
    const isException = (superClassName?.match(/^.?cx_.*$/i) || superClassName?.match(/^\/.+\/cx_.*$/i)) ? true : false;
 
    return isException;
  }
 
  public lookupBuiltinType(name: string, length?: number, decimals?: number, qualifiedName?: string): AbstractType | undefined {
    switch (name) {
      case "STRING":
        return Types.StringType.get({qualifiedName: qualifiedName || name});
      case "XSTRING":
        return Types.XStringType.get({qualifiedName: qualifiedName || name});
      case "D":
        /*
        if (length && length > 0) {
          throw new Error("Length for type D not possible");
        } else if (decimals && decimals > 0) {
          throw new Error("Decimals for type D not possible");
        }
        */
        return new Types.DateType({qualifiedName: qualifiedName || name});
      case "T":
        /*
        if (length && length > 0) {
          throw new Error("Length for type T not possible");
        } else if (decimals && decimals > 0) {
          throw new Error("Decimals for type T not possible");
        }
        */
        return new Types.TimeType({qualifiedName: qualifiedName || name});
      case "XSEQUENCE":
        return new Types.XSequenceType({qualifiedName: qualifiedName});
      case "CLIKE":
        return Types.CLikeType.get();
      case "DECFLOAT":
        return new Types.DecFloatType({qualifiedName: qualifiedName});
      case "ANY":
        return Types.AnyType.get({qualifiedName: qualifiedName});
      case "SIMPLE":
        return new Types.SimpleType({qualifiedName: qualifiedName});
      case "%_C_POINTER":
        return new Types.HexType(8, qualifiedName);
      case "TABLE":
        return new Types.TableType(Types.AnyType.get(), {withHeader: false, keyType: Types.TableKeyType.default});
      case "DATA":
        return new Types.DataType({qualifiedName: qualifiedName});
      case "NUMERIC":
        return new Types.NumericGenericType({qualifiedName: qualifiedName});
      case "UTCLONG": // todo, take version into account
        return new Types.UTCLongType({qualifiedName: qualifiedName});
      case "DECFLOAT16":
        return new Types.DecFloat16Type({qualifiedName: qualifiedName});
      case "DECFLOAT34":
        return new Types.DecFloat34Type({qualifiedName: qualifiedName});
      case "CSEQUENCE":
        return new Types.CSequenceType({qualifiedName: qualifiedName});
      case "I":
        return Types.IntegerType.get({qualifiedName: qualifiedName || name});
      case "INT8": // todo, take version into account
        return new Types.Integer8Type({qualifiedName: qualifiedName || name});
      case "F":
        /*
        if (length && length > 0) {
          throw new Error("Length for type F not possible");
        } else if (decimals && decimals > 0) {
          throw new Error("Decimals for type F not possible");
        }
        */
        return new Types.FloatType({qualifiedName: qualifiedName || name});
      case "P":
        if (length && decimals) {
          return new Types.PackedType(length, decimals, {qualifiedName: qualifiedName});
        } else if (length) {
          return new Types.PackedType(length, 0, {qualifiedName: qualifiedName});
        } else {
          return new Types.PackedType(1, 0, {qualifiedName: qualifiedName});
        }
      case "C":
        if (length) {
          return new Types.CharacterType(length, {qualifiedName: qualifiedName});
        } else {
          return new Types.CharacterType(1, {qualifiedName: qualifiedName});
        }
      case "X":
        if (length) {
          return new Types.HexType(length, qualifiedName);
        } else {
          return new Types.HexType(1, qualifiedName);
        }
      case "N":
        if (length) {
          return new Types.NumericType(length, qualifiedName);
        } else {
          return new Types.NumericType(1, qualifiedName);
        }
    }
    return undefined;
  }
 
  public inErrorNamespace(name: string | undefined): boolean {
    if (name === undefined) {
      return true;
    }
    return this.reg.inErrorNamespace(name);
  }
 
  public lookupObject(name: string): ILookupResult {
    const clas = this.reg.getObject("CLAS", name);
    const globalClas = clas?.getIdentifier();
    if (globalClas) {
      return {
        type: new ObjectReferenceType(globalClas, {qualifiedName: name, RTTIName: "\\CLASS=" + name}),
        object: clas,
      };
    }
    const intf = this.reg.getObject("INTF", name);
    const globalIntf = intf?.getIdentifier();
    if (globalIntf) {
      return {
        type: new ObjectReferenceType(globalIntf, {qualifiedName: name, RTTIName: "\\INTERFACE=" + name}),
        object: intf,
      };
    }
    if (this.inErrorNamespace(name) === true) {
      return {type: new UnknownType(name)};
    } else {
      return {type: VoidType.get(name)};
    }
  }
 
  public lookupNoVoid(name: string): ILookupResult | undefined {
    const foundTABL = this.reg.getObject("TABL", name) as Table | undefined;
    if (foundTABL) {
      return {type: foundTABL.parseType(this.reg), object: foundTABL};
    }
 
    const foundVIEW = this.reg.getObject("VIEW", name) as Table | undefined;
    if (foundVIEW) {
      return {type: foundVIEW.parseType(this.reg), object: foundVIEW};
    }
 
    const foundTTYP = this.reg.getObject("TTYP", name) as TableType | undefined;
    if (foundTTYP) {
      return {type: foundTTYP.parseType(this.reg), object: foundTTYP};
    }
 
    const foundDTEL = this.reg.getObject("DTEL", name) as DataElement | undefined;
    if (foundDTEL) {
      return {type: foundDTEL.parseType(this.reg), object: foundDTEL};
    }
 
    const foundDDLS = this.lookupDDLS(name);
    if (foundDDLS) {
      return foundDDLS;
    }
 
    return undefined;
  }
 
  public lookupDDLS(name?: string) {
    if (name === undefined) {
      return undefined;
    }
 
    const upper = name.toUpperCase();
    for (const obj of this.reg.getObjectsByType("DDLS")) {
      const ddls = obj as DataDefinition;
      if (ddls.getSQLViewName() === upper || ddls.getDefinitionName()?.toUpperCase() === upper) {
        return {type: ddls.parseType(this.reg), object: ddls};
      }
    }
 
    return undefined;
  }
 
  /** lookup with voiding and unknown types */
  public lookup(name: string): ILookupResult {
    const found = this.lookupNoVoid(name);
    if (found) {
      return found;
    }
 
    if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + " not found, lookup")};
    } else {
      return {type: Types.VoidType.get(name)};
    }
  }
 
  public lookupDomain(name: string, dataElement?: string, description?: string): ILookupResult {
    const found = this.reg.getObject("DOMA", name) as Domain | undefined;
    if (found) {
      return {type: found.parseType(this.reg, dataElement, description), object: found};
    } else if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + ", lookupDomain"), object: undefined};
    } else {
      return {type: Types.VoidType.get(name), object: undefined};
    }
  }
 
  public lookupDataElement(name: string | undefined): ILookupResult {
    if (name === undefined) {
      return {type: new Types.UnknownType("undefined, lookupDataElement")};
    }
    const found = this.reg.getObject("DTEL", name) as DataElement | undefined;
    if (found) {
      return {type: found.parseType(this.reg), object: found};
    } else if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + " not found, lookupDataElement")};
    } else {
      return {type: Types.VoidType.get(name)};
    }
  }
 
  public lookupTableOrView(name: string | undefined): ILookupResult {
    if (name === undefined) {
      return {type: new Types.UnknownType("undefined, lookupTableOrView")};
    }
    const foundTABL = this.reg.getObject("TABL", name) as Table | undefined;
    if (foundTABL) {
      return {type: foundTABL.parseType(this.reg), object: foundTABL};
    }
    const foundDDLS = this.lookupDDLS(name);
    if (foundDDLS) {
      return foundDDLS;
    }
    return this.lookupView(name);
  }
 
  /** this method only looks up the object, does not parse the type */
  public lookupTableOrView2(name: string | undefined): Table | DataDefinition | View | undefined {
    if (name === undefined) {
      return undefined;
    }
    const foundTABL = this.reg.getObject("TABL", name) as Table | undefined;
    if (foundTABL) {
      return foundTABL;
    }
    const foundVIEW = this.reg.getObject("VIEW", name) as View | undefined;
    if (foundVIEW) {
      return foundVIEW;
    }
    const foundDDLS = this.lookupDDLS(name);
    if (foundDDLS) {
      return foundDDLS.object;
    }
    return undefined;
  }
 
  public lookupTable(name: string | undefined): AbstractType {
    if (name === undefined) {
      return new Types.UnknownType("undefined, lookupTable");
    }
    const found = this.reg.getObject("TABL", name) as Table | undefined;
    if (found) {
      return found.parseType(this.reg);
    } else if (this.reg.inErrorNamespace(name)) {
      return new Types.UnknownType(name + " not found, lookupTable");
    } else {
      return Types.VoidType.get(name);
    }
  }
 
  private lookupView(name: string | undefined): ILookupResult {
    if (name === undefined) {
      return {type: new Types.UnknownType("undefined, lookupView")};
    }
    const found = this.reg.getObject("VIEW", name) as Table | undefined;
    if (found) {
      return {type: found.parseType(this.reg), object: found};
    } else if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + " not found, lookupView")};
    } else {
      return {type: Types.VoidType.get(name)};
    }
  }
 
  public lookupTableType(name: string | undefined): ILookupResult {
    if (name === undefined) {
      return {type: new Types.UnknownType("undefined, lookupTableType")};
    }
    const found = this.reg.getObject("TTYP", name) as TableType | undefined;
    if (found) {
      return {type: found.parseType(this.reg), object: found};
    } else if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + " not found, lookupTableType")};
    } else {
      return {type: Types.VoidType.get(name)};
    }
  }
 
  public textToType(input: {
      text: string | undefined,
      length: string | undefined,
      decimals: string | undefined,
      infoText: string,
      qualifiedName?: string,
      conversionExit?: string,
      ddicName?: string,
      description?: string,
    }): AbstractType {
 
// todo: support short strings, and length of different integers, NUMC vs CHAR, min/max length
 
    const extra = {
      qualifiedName: input.qualifiedName,
      conversionExit: input.conversionExit,
      ddicName: input.ddicName,
      description: input.description,
    };
 
    switch (input.text) {
      case "DEC":      // 1 <= len <= 31
      case "D16F":     // 1 <= len <= 31
      case "D16D":
      case "D34D":
      case "D34F":     // 1 <= len <= 31
      case "DF16_DEC": // 1 <= len <= 31
      case "DF34_DEC": // 1 <= len <= 31
      case "CURR":     // 1 <= len <= 31
      case "QUAN":     // 1 <= len <= 31
        if (input.length === undefined) {
          return new Types.UnknownType(input.text + " unknown length, " + input.infoText, input.infoText);
        } else if (input.decimals === undefined) {
          return new Types.PackedType(parseInt(input.length, 10), 0, extra);
        }
        return new Types.PackedType(parseInt(input.length, 10), parseInt(input.decimals, 10), extra);
      case "ACCP":
        return new Types.CharacterType(6, extra); // YYYYMM
      case "LANG":
        return new Types.CharacterType(1, extra);
      case "CLNT":
        return new Types.CharacterType(3, extra);
      case "CUKY":
        return new Types.CharacterType(5, extra);
      case "UNIT":  // 2 <= len <= 3
        return new Types.CharacterType(3, extra);
      case "UTCL":
      case "UTCLONG":
        return new Types.CharacterType(27, extra);
      case "NUMC": // 1 <= len <= 255
        if (input.length === undefined) {
          return new Types.UnknownType(input.text + " unknown length", input.infoText);
        }
        return new Types.NumericType(parseInt(input.length, 10), input.qualifiedName);
      case "CHAR": // 1 <= len <= 30000 (1333 for table fields)
      case "LCHR": // 256 <= len <= 32000
        if (input.length === undefined) {
          return new Types.UnknownType(input.text + " unknown length", input.infoText);
        }
        return new Types.CharacterType(parseInt(input.length, 10), extra);
      case "RAW":  // 1 <= len <= 32000
      case "LRAW": // 256 <= len <= 32000
        if (input.length === undefined) {
          return new Types.UnknownType(input.text + " unknown length", input.infoText);
        }
        return new Types.HexType(parseInt(input.length, 10), input.qualifiedName);
      case "TIMN": // Native HANA
      case "TIMS":
        return new Types.TimeType({qualifiedName: input.qualifiedName}); //HHMMSS
      case "DECFLOAT16": // len = 16
      case "DECFLOAT34": // len = 34
      case "D16R":       // len = 16
      case "D34R":       // len = 34
      case "DF16_RAW":   // len = 16
      case "DF34_RAW":   // len = 34
      case "FLTP":       // len = 16
        if (input.length === undefined) {
          return new Types.UnknownType(input.text + " unknown length", input.infoText);
        }
        return new Types.FloatingPointType(parseInt(input.length, 10), input.qualifiedName);
      case "DATN": // Native HANA
      case "DATS":
        return new Types.DateType({qualifiedName: input.qualifiedName}); //YYYYMMDD
      case "INT1":
      case "INT2":
      case "INT4":
        return Types.IntegerType.get({qualifiedName: input.qualifiedName});
      case "INT8":
        return new Types.Integer8Type({qualifiedName: input.qualifiedName});
      case "SSTR":    // 1 <= len <= 1333
      case "SSTRING": // 1 <= len <= 1333
      case "STRG":    // 256 <= len
      case "STRING":  // 256 <= len
        return Types.StringType.get({qualifiedName: input.qualifiedName});
      case "RSTR":      // 256 <= len
      case "RAWSTRING": // 256 <= len
      case "GEOM_EWKB":
        return Types.XStringType.get({qualifiedName: input.qualifiedName});
      case "D16S":
      case "D34S":
      case "DF16_SCL":
      case "DF34_SCL":
      case "PREC":
      case "VARC":
        return new Types.UnknownType(input.text + " is an obsolete data type", input.infoText);
      default:
        return new Types.UnknownType(input.text + " unknown basic ddic type", input.infoText);
    }
  }
 
}