All files / src ddic.ts

86.25% Statements 364/422
69.35% Branches 129/186
100% Functions 16/16
86.25% Lines 364/422

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 4231x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6237x 6237x 1x 1x 1x 1x 777x     777x 14x 14x 763x 777x 646x 646x 117x 117x 117x 777x 173x 173x 41x 41x 132x 173x 173x     132x 173x 56x 173x 76x 76x 173x 117x 117x 777x 777x 777x 777x 1x 1x 2046x 2046x 471x 2046x 11x 2046x 12x 2046x 2x 2046x   2046x 1x 2046x 1x 2046x 18x 2046x 2x 2046x 1x 2046x 1x 2046x 8x 2046x 1x 2046x 1x 2046x 1x 2046x 2x 2046x 1x 2046x 2046x 623x 2046x 3x 2046x 4x 1x 4x 3x 3x     2046x 159x 156x 159x 3x 3x 2046x 13x 12x 13x 1x 1x 2046x 3x 3x 3x     2046x 707x 707x 1x 1x 352x     352x 352x 1x 1x 14x 14x 14x 10x 10x 4x 14x 14x 2x 2x 14x   14x 2x 2x 14x 1x 1x 341x 341x 11x 11x 330x 330x 341x     330x 330x 341x 2x 2x 328x 328x 341x 42x 42x 286x 286x 341x 1x 1x 285x 285x 285x 1x 1x 432x     432x 432x 432x 1x 1x 1x 1x 1x 431x 431x 431x 1x 1x 1x 267x 267x 51x 51x 216x 267x 36x 267x 180x 180x 267x 1x 1x 17x 17x 9x 17x   8x 8x 8x 17x 1x 1x 149x     149x 149x 22x 149x 3x 127x 124x 124x 149x 1x 1x 104x     104x 104x 40x 40x 64x 104x     64x 64x 1x 1x 1x 93x     93x 93x 11x 11x 82x 93x     82x 93x     82x 82x 1x 1x 1x     1x 1x   1x   1x 1x 1x 1x 1x 1x 64x     64x 64x 2x 64x 10x 62x 52x 52x 64x 1x 1x 2x     2x 2x 2x 2x         2x 1x 1x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 3x   3x 1x 1x 2x 315x 315x 315x   315x 6x 315x   315x   315x   315x         315x 315x 258x     258x 315x 315x 6x     6x 315x 315x 315x 315x 315x 315x 315x 315x 315x 315x 2x     2x 315x 315x 315x 315x 315x 315x 315x 12x 315x 315x 315x 315x 24x 315x 315x 315x 4x 315x 315x 315x 315x 315x 315x   315x   315x 315x 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 new Types.StringType({qualifiedName: qualifiedName || name});
      case "XSTRING":
        return new Types.XStringType({qualifiedName: qualifiedName || name});
      case "D":
        return new Types.DateType({qualifiedName: qualifiedName || name});
      case "T":
        return new Types.TimeType({qualifiedName: qualifiedName || name});
      case "XSEQUENCE":
        return new Types.XSequenceType({qualifiedName: qualifiedName});
      case "CLIKE":
        return new Types.CLikeType({qualifiedName: qualifiedName});
      case "DECFLOAT":
        return new Types.DecFloatType({qualifiedName: qualifiedName});
      case "ANY":
        return new Types.AnyType({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(new Types.AnyType(), {withHeader: false});
      case "DATA":
        return new Types.AnyType({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":
      case "INT8": // todo, take version into account
        return new Types.IntegerType({qualifiedName: qualifiedName || name});
      case "F":
        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, name), object: clas};
    }
    const intf = this.reg.getObject("INTF", name);
    const globalIntf = intf?.getIdentifier();
    if (globalIntf) {
      return {type: new ObjectReferenceType(globalIntf, name), object: intf};
    }
    if (this.inErrorNamespace(name) === true) {
      return {type: new UnknownType(name)};
    } else {
      return {type: new VoidType(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: new Types.VoidType(name)};
    }
  }
 
  public lookupDomain(name: string, dataElement?: string): ILookupResult {
    const found = this.reg.getObject("DOMA", name) as Domain | undefined;
    if (found) {
      return {type: found.parseType(this.reg, dataElement), object: found};
    } else if (this.reg.inErrorNamespace(name)) {
      return {type: new Types.UnknownType(name + ", lookupDomain"), object: undefined};
    } else {
      return {type: new Types.VoidType(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: new Types.VoidType(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 new Types.VoidType(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: new Types.VoidType(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: new Types.VoidType(name)};
    }
  }
 
  public textToType(
    text: string | undefined,
    length: string | undefined,
    decimals: string | undefined,
    infoText: string,
    qualifiedName?: string,
    conversionExit?: string,
    ddicName?: string): AbstractType {
 
// todo: support short strings, and length of different integers, NUMC vs CHAR, min/max length
 
    switch (text) {
      case "DEC":      // 1 <= len <= 31
      case "D16F":     // 1 <= len <= 31
      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 (length === undefined) {
          return new Types.UnknownType(text + " unknown length, " + infoText, infoText);
        } else if (decimals === undefined) {
          return new Types.PackedType(parseInt(length, 10), 0, {qualifiedName, conversionExit, ddicName});
        }
        return new Types.PackedType(parseInt(length, 10), parseInt(decimals, 10), {qualifiedName, conversionExit, ddicName});
      case "ACCP":
        return new Types.CharacterType(6, {qualifiedName, conversionExit, ddicName}); // YYYYMM
      case "LANG":
        return new Types.CharacterType(1, {qualifiedName, conversionExit, ddicName});
      case "CLNT":
        return new Types.CharacterType(3, {qualifiedName, conversionExit, ddicName});
      case "CUKY":
        return new Types.CharacterType(5, {qualifiedName, conversionExit, ddicName});
      case "UNIT":  // 2 <= len <= 3
        return new Types.CharacterType(3, {qualifiedName, conversionExit, ddicName});
      case "UTCLONG":
        return new Types.CharacterType(27, {qualifiedName, conversionExit, ddicName});
      case "NUMC": // 1 <= len <= 255
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", infoText);
        }
        return new Types.NumericType(parseInt(length, 10), qualifiedName);
      case "CHAR": // 1 <= len <= 30000 (1333 for table fields)
      case "LCHR": // 256 <= len <= 32000
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", infoText);
        }
        return new Types.CharacterType(parseInt(length, 10), {qualifiedName, conversionExit, ddicName});
      case "RAW":  // 1 <= len <= 32000
      case "LRAW": // 256 <= len <= 32000
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", infoText);
        }
        return new Types.HexType(parseInt(length, 10), qualifiedName);
      case "TIMN": // Native HANA
      case "TIMS":
        return new Types.TimeType({qualifiedName: 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 (length === undefined) {
          return new Types.UnknownType(text + " unknown length", infoText);
        }
        return new Types.FloatingPointType(parseInt(length, 10), qualifiedName);
      case "DATN": // Native HANA
      case "DATS":
        return new Types.DateType({qualifiedName: qualifiedName}); //YYYYMMDD
      case "INT1":
      case "INT2":
      case "INT4":
      case "INT8":
        return new Types.IntegerType({qualifiedName: qualifiedName});
      case "SSTR":    // 1 <= len <= 1333
      case "SSTRING": // 1 <= len <= 1333
      case "STRG":    // 256 <= len
      case "STRING":  // 256 <= len
        return new Types.StringType({qualifiedName: qualifiedName});
      case "RSTR":      // 256 <= len
      case "RAWSTRING": // 256 <= len
      case "GEOM_EWKB":
        return new Types.XStringType({qualifiedName: qualifiedName});
      case "D16S":
      case "D34S":
      case "DF16_SCL":
      case "DF34_SCL":
      case "PREC":
      case "VARC":
        return new Types.UnknownType(text + " is an obsolete data type", infoText);
      default:
        return new Types.UnknownType(text + " unknown", infoText);
    }
  }
 
}