@abaplint/core 2.120.55 → 2.120.57

package/build/src/abap/2_statements/expressions/method_def_returning.js

@@ -39,7 +39,8 @@ const Expressions = __importStar(require("."));
 const tokens_1 = require("../../1_lexer/tokens");
 class MethodDefReturning extends combi_1.Expression {
     getRunnable() {
-        const value = (0, combi_1.seq)("VALUE", (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
+        // see MethodParam: the lexer gives "!VALUE" as one Identifier
+        const value = (0, combi_1.seq)((0, combi_1.altPrio)("VALUE", "!VALUE"), (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
         return (0, combi_1.seq)("RETURNING", value, Expressions.TypeParam);
     }
 }

package/build/src/abap/2_statements/expressions/method_param.js

@@ -39,8 +39,11 @@ const Expressions = __importStar(require("."));
 const tokens_1 = require("../../1_lexer/tokens");
 class MethodParam extends combi_1.Expression {
     getRunnable() {
-        const ref = (0, combi_1.seq)("REFERENCE", (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
-        const value = (0, combi_1.seq)("VALUE", (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
+        // The escape is part of the token: the lexer gives "!VALUE" as a single
+        // Identifier, so a literal "VALUE" cannot match it and the whole METHODS
+        // statement falls back to Unknown.
+        const ref = (0, combi_1.seq)((0, combi_1.altPrio)("REFERENCE", "!REFERENCE"), (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
+        const value = (0, combi_1.seq)((0, combi_1.altPrio)("VALUE", "!VALUE"), (0, combi_1.tok)(tokens_1.ParenLeft), Expressions.MethodParamName, (0, combi_1.tok)(tokens_1.ParenRightW));
         const fieldsOrValue = (0, combi_1.seq)((0, combi_1.altPrio)(value, ref, Expressions.MethodParamName), Expressions.TypeParam);
         return fieldsOrValue;
     }

package/build/src/abap/2_statements/statement_parser.js

@@ -305,6 +305,10 @@ class StatementParser {
         let add = [];
         let pre = [];
         let colon = undefined;
+        // inside EXEC SQL and an AMDP body a colon reads a host variable, ":lv_a",
+        // and is not the chaining marker; recognized here because nativeSQL() runs
+        // afterwards and can only re-wrap what this has already cut
+        let native = false;
         for (const token of wa.tokens) {
             if (token instanceof Tokens.Comment) {
                 wa.statements.push(new nodes_1.StatementNode(new _statement_1.Comment()).setChildren(this.tokensToNodes([token])));
@@ -314,6 +318,7 @@ class StatementParser {
             const str = token.getStr();
             if (str.length === 1) {
                 if (str === ".") {
+                    native = this.nativeAfter(native, add, colon);
                     wa.addUnknown(pre, add, colon);
                     add = [];
                     pre = [];
@@ -323,13 +328,13 @@ class StatementParser {
                     wa.addUnknown(pre, add, colon);
                     add = [];
                 }
-                else if (str === ":" && colon === undefined) {
+                else if (str === ":" && colon === undefined && native === false) {
                     colon = token;
                     add.pop(); // do not add colon token to statement
                     pre.push(...add);
                     add = [];
                 }
-                else if (str === ":") {
+                else if (str === ":" && native === false) {
                     add.pop(); // do not add colon token to statement
                 }
             }
@@ -338,6 +343,36 @@ class StatementParser {
             wa.addUnknown(pre, add, colon);
         }
     }
+    /** whether the statement that just ended opens or closes a region where a
+     * colon belongs to the statement rather than chaining it */
+    nativeAfter(native, tokens, colon) {
+        // a pragma sits between the closing keyword and the period, so it is left
+        // out before the last word is read: "ENDEXEC ##NEEDED." closes the region
+        const words = tokens.filter(t => !(t instanceof Tokens.Pragma)).map(t => t.getStr().toUpperCase());
+        // a native body usually arrives as one blob terminated by its own closing
+        // keyword, so the terminator is the word before the period
+        if (words[words.length - 2] === "ENDEXEC" || words[words.length - 2] === "ENDMETHOD") {
+            return false;
+        }
+        if (colon !== undefined) {
+            // a fragment of a chain cannot OPEN a region: it is only part of a
+            // statement, and taking "DATA: lv_a TYPE i, exec sql." for one would
+            // turn chaining off for the rest of the file
+            return native;
+        }
+        if (words[0] === "EXEC" && words[1] === "SQL") {
+            return true;
+        }
+        // "BY DATABASE" as well as LANGUAGE, and not LANGUAGE alone: a method
+        // may be NAMED language
+        if (words[0] === "METHOD"
+            && words.includes("BY")
+            && words.includes("DATABASE")
+            && words.includes("LANGUAGE")) {
+            return true;
+        }
+        return native;
+    }
 }
 exports.StatementParser = StatementParser;
 //# sourceMappingURL=statement_parser.js.map

package/build/src/abap/types/method_parameters.js

@@ -333,7 +333,9 @@ class MethodParameters {
     }
     isPassByValue(param) {
         var _a;
-        return param.getFirstToken().getStr().toUpperCase() === "VALUE"
+        // "!" is the identifier escape, generated code has eg. "IMPORTING !VALUE(iv_foo)"
+        const first = param.getFirstToken().getStr().toUpperCase();
+        return (first === "VALUE" || first === "!VALUE")
             && ((_a = param.getChildren()[1]) === null || _a === void 0 ? void 0 : _a.getFirstToken().getStr()) === "(";
     }
 }

package/build/src/registry.js

@@ -75,7 +75,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.js"
-        return "2.120.55";
+        return "2.120.57";
     }
     getDDICReferences() {
         return this.ddicReferences;

package/build/src/rules/index.js

@@ -148,6 +148,7 @@ __exportStar(require("./prefer_inline"), exports);
 __exportStar(require("./prefer_insert_into_table"), exports);
 __exportStar(require("./prefer_is_not"), exports);
 __exportStar(require("./prefer_pragmas"), exports);
+__exportStar(require("./prefer_abap_bool"), exports);
 __exportStar(require("./prefer_raise_exception_new"), exports);
 __exportStar(require("./prefer_returning_to_exporting"), exports);
 __exportStar(require("./prefer_xsdbool"), exports);

package/build/src/rules/prefer_abap_bool.js

@@ -0,0 +1,100 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreferAbapBool = exports.PreferAbapBoolConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const Expressions = __importStar(require("../abap/2_statements/expressions"));
+const Statements = __importStar(require("../abap/2_statements/statements"));
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+const edit_helper_1 = require("../edit_helper");
+const FORBIDDEN_TYPES = new Set(["XFELD", "SAP_BOOL", "BOOLE_D", "FLAG"]);
+class PreferAbapBoolConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.PreferAbapBoolConf = PreferAbapBoolConf;
+class PreferAbapBool extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new PreferAbapBoolConf();
+    }
+    getMetadata() {
+        return {
+            key: "prefer_abap_bool",
+            title: "Prefer abap_bool",
+            shortDescription: `Use abap_bool instead of XFELD, SAP_BOOL, BOOLE_D, FLAG for boolean variables`,
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-abap_bool-for-booleans`,
+            tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Quickfix],
+            badExample: `DATA foo TYPE xfeld.`,
+            goodExample: `DATA foo TYPE abap_bool.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        const structure = file.getStructure();
+        if (structure === undefined) {
+            return [];
+        }
+        const statements = [
+            ...structure.findAllStatements(Statements.Data),
+            ...structure.findAllStatements(Statements.ClassData),
+            ...structure.findAllStatements(Statements.Constant),
+            ...structure.findAllStatements(Statements.Type),
+            ...structure.findAllStatements(Statements.FieldSymbol),
+        ];
+        for (const stat of statements) {
+            const typeNameExpr = stat.findFirstExpression(Expressions.TypeName);
+            if (typeNameExpr === undefined) {
+                continue;
+            }
+            const typeName = typeNameExpr.concatTokens().toUpperCase();
+            if (FORBIDDEN_TYPES.has(typeName) === false) {
+                continue;
+            }
+            const token = typeNameExpr.getFirstToken();
+            const fix = edit_helper_1.EditHelper.replaceToken(file, token, "abap_bool");
+            issues.push(issue_1.Issue.atToken(file, token, `Use abap_bool instead of ${typeName}`, this.getMetadata().key, this.conf.severity, fix));
+        }
+        return issues;
+    }
+}
+exports.PreferAbapBool = PreferAbapBool;
+//# sourceMappingURL=prefer_abap_bool.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.120.55",
+    "version": "2.120.57",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",