All files / src ddic.ts

83.61% Statements 347/415
68.68% Branches 125/182
100% Functions 15/15
83.61% Lines 347/415

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 4161x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5867x 5867x 1x 1x 1x 1x 730x     730x 14x 14x 716x 730x 605x 605x 111x 111x 111x 730x 167x 167x 35x 35x 132x 167x 167x     132x 167x 56x 167x 76x 76x 167x 111x 111x 730x 730x 730x 730x 1x 1x 1900x 1900x 441x 1900x 10x 1900x 12x 1900x 2x 1900x   1900x 1x 1900x 1x 1900x 18x 1900x 2x 1900x 1x 1900x 1x 1900x 7x 1900x 1x 1900x 1x 1900x 1x 1900x 2x 1900x 1x 1900x 1900x 558x 1900x 3x 1900x 4x 1x 4x 3x 3x     1900x 153x 150x 153x 3x 3x 1900x 12x 11x 12x 1x 1x 1900x 3x 3x 3x     1900x 665x 665x 1x 1x 344x     344x 344x 1x 1x 14x 14x 14x 10x 10x 4x 14x 14x 2x 2x 14x   14x 2x 2x 14x 1x 1x 318x 318x 9x 9x 309x 309x 318x     309x 309x 318x 2x 2x 307x 307x 318x 39x 39x 268x 268x 318x           268x 268x 268x 1x 1x 1x 252x 252x 45x 45x 207x 252x 32x 252x 175x 175x 252x 1x 1x 13x 13x 5x 13x   8x 8x 8x 13x 1x 1x 119x     119x 119x 22x 119x   97x 97x 97x 119x 1x 1x 100x     100x 100x 39x 39x 61x 100x           61x 61x 1x 1x 1x 87x     87x 87x 8x 8x 79x 87x     79x 87x           79x 79x 1x 1x 1x     1x 1x   1x   1x 1x 1x 1x 1x 1x 61x     61x 61x 2x 61x 9x 59x 50x 50x 61x 1x 1x 2x     2x 2x 2x 2x         2x 1x 1x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 3x   3x 1x 1x 2x 303x 303x 303x   303x 6x 303x   303x   303x   303x         303x 303x 248x     248x 303x 303x 6x     6x 303x 303x 303x 303x 303x 303x 303x 303x 303x 303x 2x     2x 303x 303x 303x 303x 303x 303x 303x 12x 303x 303x 303x 303x 22x 303x 303x 303x 4x 303x 303x 303x 303x 303x 303x   303x   303x 303x 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 || name);
      case "XSTRING":
        return new Types.XStringType(qualifiedName || name);
      case "D":
        return new Types.DateType(qualifiedName || name);
      case "T":
        return new Types.TimeType(qualifiedName || name);
      case "XSEQUENCE":
        return new Types.XSequenceType(qualifiedName);
      case "CLIKE":
        return new Types.CLikeType(qualifiedName);
      case "DECFLOAT":
        return new Types.DecFloatType(qualifiedName);
      case "ANY":
        return new Types.AnyType(qualifiedName);
      case "SIMPLE":
        return new Types.SimpleType(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);
      case "NUMERIC":
        return new Types.NumericGenericType(qualifiedName);
      case "UTCLONG": // todo, take version into account
        return new Types.UTCLongType(qualifiedName);
      case "DECFLOAT16":
        return new Types.DecFloat16Type(qualifiedName);
      case "DECFLOAT34":
        return new Types.DecFloat34Type(qualifiedName);
      case "CSEQUENCE":
        return new Types.CSequenceType(qualifiedName);
      case "I":
      case "INT8": // todo, take version into account
        return new Types.IntegerType(qualifiedName || name);
      case "F":
        return new Types.FloatType(qualifiedName || name);
      case "P":
        if (length && decimals) {
          return new Types.PackedType(length, decimals, qualifiedName);
        } else if (length) {
          return new Types.PackedType(length, 0, qualifiedName);
        } else {
          return new Types.PackedType(1, 0, qualifiedName);
        }
      case "C":
        if (length) {
          return new Types.CharacterType(length, qualifiedName);
        } else {
          return new Types.CharacterType(1, 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 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: obj};
      }
    }
 
    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, parent?: string): ILookupResult {
    const found = this.reg.getObject("DOMA", name) as Domain | undefined;
    if (found) {
      return {type: found.parseType(this.reg, parent), 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 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 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 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 ddls;
      }
    }
    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,
    parent: string,
    qualify = true): AbstractType {
 
// todo, support short strings, and length of different integers, NUMC vs CHAR, min/max length
 
    const qualified = qualify ? parent : undefined;
 
    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, " + parent, parent);
        } else if (decimals === undefined) {
          return new Types.PackedType(parseInt(length, 10), 0, qualified);
        }
        return new Types.PackedType(parseInt(length, 10), parseInt(decimals, 10), qualified);
      case "ACCP":
        return new Types.CharacterType(6, qualified); // YYYYMM
      case "LANG":
        return new Types.CharacterType(1, qualified);
      case "CLNT":
        return new Types.CharacterType(3, qualified);
      case "CUKY":
        return new Types.CharacterType(5, qualified);
      case "UNIT":  // 2 <= len <= 3
        return new Types.CharacterType(3, qualified);
      case "UTCLONG":
        return new Types.CharacterType(27, qualified);
      case "NUMC": // 1 <= len <= 255
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", parent);
        }
        return new Types.NumericType(parseInt(length, 10), qualified);
      case "CHAR": // 1 <= len <= 30000 (1333 for table fields)
      case "LCHR": // 256 <= len <= 32000
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", parent);
        }
        return new Types.CharacterType(parseInt(length, 10), qualified);
      case "RAW":  // 1 <= len <= 32000
      case "LRAW": // 256 <= len <= 32000
        if (length === undefined) {
          return new Types.UnknownType(text + " unknown length", parent);
        }
        return new Types.HexType(parseInt(length, 10), qualified);
      case "TIMN": // Native HANA
      case "TIMS":
        return new Types.TimeType(qualified); //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", parent);
        }
        return new Types.FloatingPointType(parseInt(length, 10), qualified);
      case "DATN": // Native HANA
      case "DATS":
        return new Types.DateType(qualified); //YYYYMMDD
      case "INT1":
      case "INT2":
      case "INT4":
      case "INT8":
        return new Types.IntegerType(qualified);
      case "SSTR":    // 1 <= len <= 1333
      case "SSTRING": // 1 <= len <= 1333
      case "STRG":    // 256 <= len
      case "STRING":  // 256 <= len
        return new Types.StringType(qualified);
      case "RSTR":      // 256 <= len
      case "RAWSTRING": // 256 <= len
      case "GEOM_EWKB":
        return new Types.XStringType(qualified);
      case "D16S":
      case "D34S":
      case "DF16_SCL":
      case "DF34_SCL":
      case "PREC":
      case "VARC":
        return new Types.UnknownType(text + " is an obsolete data type", parent);
      default:
        return new Types.UnknownType(text + " unknown", parent);
    }
  }
 
}