All files / src/abap/2_statements statement_parser.ts

98.78% Statements 326/330
97.84% Branches 91/93
100% Functions 17/17
98.78% Lines 326/330

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 3301x 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 303x 303x     303x 310x 139x 310x 171x 171x 310x 303x 1x 1x 1x 28216x 28216x 2084x 2084x 28216x 167x 304x 304x 167x 26132x 26132x 1x 1x 1x 1x 1x 1x 1x 1x 7559x 7559x 7559x 7559x 1x 1x 25063x 25063x 25063x 25063x 1x 1x 7559x 7559x 1x 1x 25063x 25063x 25063x 3150x 3150x 25063x 146758x 146758x 25063x 25063x 25063x 1x 1x 1x 1x 1x 1x 1x 1x 7530x 1x 1x 7530x 7530x 7530x 1x 1x 1x 7530x 7530x 7530x 7530x 7530x 7559x 7559x 7559x 7559x 7530x 7530x 7559x 7559x 7559x 638x 638x 7559x 7559x 7530x 7530x 7530x 1x 1x 1x 642x 642x 642x 4713x 4713x 642x 642x 642x 1x 1x 1x 1x 1x 638x 638x 638x 2367x 2367x 682x 682x 682x 682x 682x 682x 621x 312x 3x 3x 309x 312x 27x 27x 27x 27x 312x 621x 682x 2367x 2367x 638x 638x 638x 1x 1x 621x 621x 621x 621x 621x 7077x 312x 312x 7077x 7077x 7077x 621x 621x 621x 1x 1x 7559x 7559x 7559x 25424x 25424x 25424x 25424x 13x 25424x 14x 14x 5x 14x 9x 9x 14x 25424x 7559x 7559x 1x 1x 1x 7559x 7559x 7559x 25343x 25343x 7559x 7559x 1x 1x 25652x 25652x 25652x 25652x 25652x 25652x 25652x 15x 15x 25652x 25357x 25234x 25357x     123x 1x 1x 25357x 25652x 25652x 25652x 1x 1x 25234x 25234x 25234x 25234x 25234x 128586x 128586x 61x 128586x 128525x 128525x 128586x 25234x 25234x 25234x 1x 1x 25234x 25234x 25234x 2x 2x 25232x 25234x 55098x 55098x 22248x 22248x 22248x 22248x 55098x 2984x 25234x 5557x 5557x 2070x 2070x 2070x 2070x 5557x 914x 914x 914x 1x 1x 1x 1x 1x 7559x 7559x 7559x 7559x 7559x 149218x 280x 280x 280x 148938x 148938x 148938x 148938x 149218x 49844x 22955x 22955x 22955x 22955x 49844x 1985x 1985x 26889x 1052x 1052x 1052x 1052x 24904x 2x 2x 49844x 149218x 7559x 7559x 123x 123x 7559x 1x
import * as Statements from "./statements";
import * as Expressions from "./expressions";
import * as Tokens from "../1_lexer/tokens";
import {Version} from "../../version";
import {IFile} from "../../files/_ifile";
import {TokenNode, StatementNode} from "../nodes";
import {ArtifactsABAP} from "../artifacts";
import {Combi} from "./combi";
import {Unknown, Empty, Comment, NativeSQL, IStatement} from "./statements/_statement";
import {IStatementResult} from "./statement_result";
import {AbstractToken} from "../1_lexer/tokens/abstract_token";
import {IABAPLexerResult} from "../1_lexer/lexer_result";
import {ExpandMacros} from "./expand_macros";
import {Pragma} from "../1_lexer/tokens";
import {IRegistry} from "../../_iregistry";
import {IStatementRunnable} from "./statement_runnable";
 
export const STATEMENT_MAX_TOKENS = 1000;
 
class StatementMap {
  // this also serves as container for statement matcher singletons,
  private readonly map: {[index: string]: {statement: IStatement, matcher?: IStatementRunnable}[]};
 
  public constructor() {
    this.map = {};
 
    for (const stat of ArtifactsABAP.getStatements()) {
      const f = stat.getMatcher().first();
      if (f.length === 0) {
        throw new Error("StatementMap, first must have contents");
      }
      for (const first of f) {
        if (this.map[first]) {
          this.map[first].push({statement: stat});
        } else {
          this.map[first] = [{statement: stat}];
        }
      }
    }
  }
 
  public lookup(str: string): readonly {statement: IStatement, matcher: IStatementRunnable}[] {
    const res = this.map[str.toUpperCase()];
    if (res === undefined) {
      return [];
    }
    if (res[0].matcher === undefined) {
      for (const r of res) {
        r.matcher = r.statement.getMatcher();
      }
    }
    return res as readonly {statement: IStatement, matcher: IStatementRunnable}[];
  }
}
 
class WorkArea {
  public readonly file: IFile;
  public readonly tokens: readonly AbstractToken[];
  public statements: StatementNode[];
 
  public constructor(file: IFile, tokens: readonly AbstractToken[]) {
    this.file = file;
    this.tokens = tokens;
    this.statements = [];
  }
 
  public addUnknown(pre: AbstractToken[], post: AbstractToken[], colon: AbstractToken | undefined) {
    const st = new StatementNode(new Unknown(), colon);
    st.setChildren(this.tokensToNodes(pre, post));
    this.statements.push(st);
  }
 
  public toResult(): IStatementResult {
    return {file: this.file, tokens: this.tokens, statements: this.statements};
  }
 
  private tokensToNodes(tokens1: AbstractToken[], tokens2: AbstractToken[]): TokenNode[] {
    const ret: TokenNode[] = [];
 
    for (const t of tokens1) {
      ret.push(new TokenNode(t));
    }
    for (const t of tokens2) {
      ret.push(new TokenNode(t));
    }
 
    return ret;
  }
}
 
export class StatementParser {
  private static map: StatementMap;
  private readonly version: Version;
  private readonly reg?: IRegistry;
 
  public constructor(version: Version, reg?: IRegistry) {
    if (!StatementParser.map) {
      StatementParser.map = new StatementMap();
    }
    this.version = version;
    this.reg = reg;
  }
 
  /** input is one full object */
  public run(input: readonly IABAPLexerResult[], globalMacros: readonly string[]): IStatementResult[] {
    const macros = new ExpandMacros(globalMacros, this.version, this.reg);
 
    const wa = input.map(i => new WorkArea(i.file, i.tokens));
 
    for (const w of wa) {
      this.process(w);
      this.categorize(w);
      macros.find(w.statements, w.file);
    }
 
    for (const w of wa) {
      const res = macros.handleMacros(w.statements, w.file);
      w.statements = res.statements;
      if (res.containsUnknown === true) {
        this.lazyUnknown(w);
      }
      this.nativeSQL(w);
    }
 
    return wa.map(w => w.toResult());
  }
 
  // todo, refactor, remove method here and only have in WorkArea class
  private tokensToNodes(tokens: readonly AbstractToken[]): TokenNode[] {
    const ret: TokenNode[] = [];
 
    for (const t of tokens) {
      ret.push(new TokenNode(t));
    }
 
    return ret;
  }
 
// tries to split Unknown statements by newlines, when adding/writing a new statement
// in an editor, adding the statement terminator is typically the last thing to do
// note: this will not work if the second statement is a macro call, guess this is okay
  private lazyUnknown(wa: WorkArea) {
    const result: StatementNode[] = [];
 
    for (let statement of wa.statements) {
      // dont use CALL METHOD, when executing lazy, it easily gives a Move for the last statment if lazy logic is evaluated
      if (statement.get() instanceof Unknown) {
        const concat = statement.concatTokens().toUpperCase();
        if (concat.startsWith("CALL METHOD ") === false
            && concat.startsWith("RAISE EXCEPTION TYPE ") === false
            && concat.startsWith("READ TABLE ") === false
            && concat.startsWith("LOOP AT ") === false
            && concat.startsWith("CALL FUNCTION ") === false) {
          for (const {first, second} of this.buildSplits(statement.getTokens())) {
            if (second.length === 1) {
              continue; // probably punctuation
            }
            const s = this.categorizeStatement(new StatementNode(new Unknown()).setChildren(this.tokensToNodes(second)));
            if (!(s.get() instanceof Unknown)) {
              result.push(new StatementNode(new Unknown()).setChildren(this.tokensToNodes(first)));
              statement = s;
              break;
            }
          }
        }
      }
      result.push(statement);
    }
 
    wa.statements = result;
  }
 
  private buildSplits(tokens: readonly AbstractToken[]): {first: AbstractToken[], second: AbstractToken[]}[] {
    const res: {first: AbstractToken[], second: AbstractToken[]}[] = [];
    const before: AbstractToken[] = [];
    let prevRow = tokens[0].getRow();
 
    for (let i = 0; i < tokens.length; i++) {
      if (tokens[i].getRow() !== prevRow) {
        res.push({first: [...before], second: [...tokens].splice(i)});
      }
      prevRow = tokens[i].getRow();
      before.push(tokens[i]);
    }
 
    return res;
  }
 
  private nativeSQL(wa: WorkArea) {
    let sql = false;
 
    for (let i = 0; i < wa.statements.length; i++) {
      const statement = wa.statements[i];
      const type = statement.get();
      if (type instanceof Statements.ExecSQL
          || (type instanceof Statements.MethodImplementation && statement.findDirectExpression(Expressions.Language))) {
        sql = true;
      } else if (sql === true) {
        if (type instanceof Statements.EndExec
            || type instanceof Statements.EndMethod) {
          sql = false;
        } else if (!(type instanceof Comment)) {
          wa.statements[i] = new StatementNode(new NativeSQL()).setChildren(this.tokensToNodes(statement.getTokens()));
        }
      }
    }
 
  }
 
// for each statement, run statement matchers to figure out which kind of statement it is
  private categorize(wa: WorkArea) {
    const result: StatementNode[] = [];
 
    for (const statement of wa.statements) {
      result.push(this.categorizeStatement(statement));
    }
    wa.statements = result;
  }
 
  private categorizeStatement(input: StatementNode) {
    let statement = input;
 
    const length = input.getChildren().length;
    const lastToken = input.getLastToken();
    const isPunctuation = lastToken instanceof Tokens.Punctuation;
 
    if (length === 1 && isPunctuation) {
      const tokens = statement.getTokens();
      statement = new StatementNode(new Empty()).setChildren(this.tokensToNodes(tokens));
    } else if (statement.get() instanceof Unknown) {
      if (isPunctuation) {
        statement = this.match(statement);
      } else if (length > STATEMENT_MAX_TOKENS) {
        // if the statement contains more than STATEMENT_MAX_TOKENS tokens, just give up
        statement = input;
      } else if (length === 1 && lastToken instanceof Pragma) {
        statement = new StatementNode(new Empty(), undefined, [lastToken]);
      }
    }
 
    return statement;
  }
 
  private removePragma(tokens: readonly AbstractToken[]): {tokens: AbstractToken[], pragmas: AbstractToken[]} {
    const result: AbstractToken[] = [];
    const pragmas: AbstractToken[] = [];
 
    // skip the last token as it is the punctuation
    for (let i = 0; i < tokens.length - 1; i++) {
      const t = tokens[i];
      if (t instanceof Tokens.Pragma) {
        pragmas.push(t);
      } else {
        result.push(t);
      }
    }
 
    return {tokens: result, pragmas: pragmas};
  }
 
  private match(statement: StatementNode): StatementNode {
    const tokens = statement.getTokens();
    const {tokens: filtered, pragmas} = this.removePragma(tokens);
    if (filtered.length === 0) {
      return new StatementNode(new Empty()).setChildren(this.tokensToNodes(tokens));
    }
 
    for (const st of StatementParser.map.lookup(filtered[0].getStr())) {
      const match = Combi.run(st.matcher, filtered, this.version);
      if (match) {
        const last = tokens[tokens.length - 1];
        match.push(new TokenNode(last));
        return new StatementNode(st.statement, statement.getColon(), pragmas).setChildren(match);
      }
    }
    // next try the statements without specific keywords
    for (const st of StatementParser.map.lookup("")) {
      const match = Combi.run(st.matcher, filtered, this.version);
      if (match) {
        const last = tokens[tokens.length - 1];
        match.push(new TokenNode(last));
        return new StatementNode(st.statement, statement.getColon(), pragmas).setChildren(match);
      }
    }
 
    return statement;
  }
 
// takes care of splitting tokens into statements, also handles chained statements
// statements are split by "," or "."
// additional colons/chaining after the first colon are ignored
  private process(wa: WorkArea) {
    let add: AbstractToken[] = [];
    let pre: AbstractToken[] = [];
    let colon: AbstractToken | undefined = undefined;
 
    for (const token of wa.tokens) {
      if (token instanceof Tokens.Comment) {
        wa.statements.push(new StatementNode(new Comment()).setChildren(this.tokensToNodes([token])));
        continue;
      }
 
      add.push(token);
 
      const str = token.getStr();
      if (str.length === 1) {
        if (str === ".") {
          wa.addUnknown(pre, add, colon);
          add = [];
          pre = [];
          colon = undefined;
        } else if (str === "," && pre.length > 0) {
          wa.addUnknown(pre, add, colon);
          add = [];
        } else if (str === ":" && colon === undefined) {
          colon = token;
          add.pop(); // do not add colon token to statement
          pre.push(...add);
          add = [];
        } else if (str === ":") {
          add.pop(); // do not add colon token to statement
        }
      }
    }
 
    if (add.length > 0) {
      wa.addUnknown(pre, add, colon);
    }
  }
}