@abaplint/core 2.86.8 → 2.88.1

package/build/abaplint.d.ts

@@ -2646,6 +2646,7 @@ export declare const enum IdentifierMeta {
     EventParameter = "event_parameter",
     FormParameter = "form_parameter",
     ReadOnly = "read_only",
+    PassByValue = "pass_by_value",
     InlineDefinition = "inline",
     BuiltIn = "built-in",
     DDIC = "ddic",

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

@@ -163,7 +163,14 @@ class MethodParameters {
             if (p === undefined) {
                 continue;
             }
-            target.push(new method_param_1.MethodParam().runSyntax(p, scope, this.filename, meta));
+            const extraMeta = [];
+            if (opt.concatTokens().toUpperCase().startsWith("VALUE(")) {
+                extraMeta.push("pass_by_value" /* PassByValue */);
+            }
+            else if (meta.includes("importing" /* MethodImporting */)) {
+                extraMeta.push("read_only" /* ReadOnly */);
+            }
+            target.push(new method_param_1.MethodParam().runSyntax(p, scope, this.filename, [...meta, ...extraMeta]));
             if (opt.getLastToken().getStr().toUpperCase() === "OPTIONAL") {
                 const name = target[target.length - 1].getName().toUpperCase();
                 this.optional.push(name);

package/build/src/registry.js

@@ -68,7 +68,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.86.8";
+        return "2.88.1";
     }
     getDDICReferences() {
         return this.references;

package/build/src/rules/global_class.js

@@ -18,9 +18,8 @@ class GlobalClass extends _abap_rule_1.ABAPRule {
         return {
             key: "global_class",
             title: "Global class checks",
-            shortDescription: `Checks related to global classes.
-
-* global classes must be in own files
+            shortDescription: `Checks related to global classes`,
+            extendedInformation: `* global classes must be in own files
 
 * file names must match class name
 

package/build/src/rules/index.js

@@ -30,7 +30,7 @@ __exportStar(require("./check_abstract"), exports);
 __exportStar(require("./check_comments"), exports);
 __exportStar(require("./check_ddic"), exports);
 __exportStar(require("./check_include"), exports);
-__exportStar(require("./check_no_handler_pragma"), exports);
+__exportStar(require("./unnecessary_pragma"), exports);
 __exportStar(require("./check_subrc"), exports);
 __exportStar(require("./check_syntax"), exports);
 __exportStar(require("./check_text_elements"), exports);
@@ -110,7 +110,7 @@ __exportStar(require("./omit_receiving"), exports);
 __exportStar(require("./parser_702_chaining"), exports);
 __exportStar(require("./parser_error"), exports);
 __exportStar(require("./parser_missing_space"), exports);
-__exportStar(require("./pragma_placement"), exports);
+__exportStar(require("./pragma_style"), exports);
 __exportStar(require("./prefer_corresponding"), exports);
 __exportStar(require("./prefer_inline"), exports);
 __exportStar(require("./prefer_is_not"), exports);
@@ -129,6 +129,7 @@ __exportStar(require("./selection_screen_naming"), exports);
 __exportStar(require("./sequential_blank"), exports);
 __exportStar(require("./short_case"), exports);
 __exportStar(require("./sicf_consistency"), exports);
+__exportStar(require("./slow_parameter_passing"), exports);
 __exportStar(require("./space_before_colon"), exports);
 __exportStar(require("./space_before_dot"), exports);
 __exportStar(require("./sql_escape_host_variables"), exports);

package/build/src/rules/{pragma_placement.js → pragma_style.js}

@@ -1,23 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PragmaPlacement = exports.PragmaPlacementConf = void 0;
+exports.PragmaStyle = exports.PragmaStyleConf = void 0;
 const issue_1 = require("../issue");
 const _abap_rule_1 = require("./_abap_rule");
 const _basic_rule_config_1 = require("./_basic_rule_config");
 const _irule_1 = require("./_irule");
-class PragmaPlacementConf extends _basic_rule_config_1.BasicRuleConfig {
+const keyword_case_1 = require("./keyword_case");
+class PragmaStyleConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        this.style = keyword_case_1.KeywordCaseStyle.Upper;
+    }
 }
-exports.PragmaPlacementConf = PragmaPlacementConf;
-class PragmaPlacement extends _abap_rule_1.ABAPRule {
+exports.PragmaStyleConf = PragmaStyleConf;
+class PragmaStyle extends _abap_rule_1.ABAPRule {
     constructor() {
         super(...arguments);
-        this.conf = new PragmaPlacementConf();
+        this.conf = new PragmaStyleConf();
     }
     getMetadata() {
         return {
-            key: "pragma_placement",
-            title: "Pragma Placement",
-            shortDescription: `Place pragmas at end of statements`,
+            key: "pragma_style",
+            title: "Pragma Style",
+            shortDescription: `Check pragmas placment and case`,
             tags: [_irule_1.RuleTag.SingleFile],
             extendedInformation: `https://help.sap.com/doc/abapdocu_cp_index_htm/CLOUD/en-US/abenpragma.htm`,
             badExample: `DATA field ##NO_TEXT TYPE i.`,
@@ -29,6 +34,9 @@ class PragmaPlacement extends _abap_rule_1.ABAPRule {
     }
     setConfig(conf) {
         this.conf = conf;
+        if (this.conf.style === undefined) {
+            this.conf.style = keyword_case_1.KeywordCaseStyle.Upper;
+        }
     }
     runParsed(file) {
         const issues = [];
@@ -47,10 +55,20 @@ class PragmaPlacement extends _abap_rule_1.ABAPRule {
                     issues.push(issue);
                     continue; // max one finding per statement
                 }
+                if (this.conf.style === keyword_case_1.KeywordCaseStyle.Upper && p.getStr() !== p.getStr().toUpperCase()) {
+                    const message = "Upper case pragmas";
+                    const issue = issue_1.Issue.atToken(file, p, message, this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
+                else if (this.conf.style === keyword_case_1.KeywordCaseStyle.Lower && p.getStr() !== p.getStr().toLowerCase()) {
+                    const message = "Lower case pragmas";
+                    const issue = issue_1.Issue.atToken(file, p, message, this.getMetadata().key, this.conf.severity);
+                    issues.push(issue);
+                }
             }
         }
         return issues;
     }
 }
-exports.PragmaPlacement = PragmaPlacement;
-//# sourceMappingURL=pragma_placement.js.map
+exports.PragmaStyle = PragmaStyle;
+//# sourceMappingURL=pragma_style.js.map

package/build/src/rules/slow_parameter_passing.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlowParameterPassing = exports.SlowParameterPassingConf = void 0;
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const issue_1 = require("../issue");
+const _irule_1 = require("./_irule");
+const _abap_object_1 = require("../objects/_abap_object");
+const syntax_1 = require("../abap/5_syntax/syntax");
+const _scope_type_1 = require("../abap/5_syntax/_scope_type");
+const _reference_1 = require("../abap/5_syntax/_reference");
+class SlowParameterPassingConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.SlowParameterPassingConf = SlowParameterPassingConf;
+class SlowParameterPassing {
+    constructor() {
+        this.conf = new SlowParameterPassingConf();
+    }
+    getMetadata() {
+        return {
+            key: "slow_parameter_passing",
+            title: "Slow Parameter Passing",
+            shortDescription: `Detects show pass by value passing for methods where parameter is not changed`,
+            tags: [_irule_1.RuleTag.Performance],
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    initialize(reg) {
+        this.reg = reg;
+        return this;
+    }
+    run(obj) {
+        const issues = [];
+        if (!(obj instanceof _abap_object_1.ABAPObject)) {
+            return [];
+        }
+        const top = new syntax_1.SyntaxLogic(this.reg, obj).run().spaghetti.getTop();
+        const methods = this.listMethodNodes(top);
+        for (const m of methods) {
+            const vars = m.getData().vars;
+            for (const v in vars) {
+                const id = vars[v];
+                if (id.getMeta().includes("pass_by_value" /* PassByValue */) === false) {
+                    continue;
+                }
+                const writes = this.listWritePositions(m, id);
+                if (writes.length === 0) {
+                    const message = "Parameter " + id.getName() + " passed by VALUE but not changed";
+                    issues.push(issue_1.Issue.atIdentifier(id, message, this.getMetadata().key, this.getConfig().severity));
+                }
+            }
+        }
+        return issues;
+    }
+    listWritePositions(node, id) {
+        var _a, _b;
+        const ret = [];
+        for (const v of node.getData().references) {
+            if (v.referenceType === _reference_1.ReferenceType.DataWriteReference
+                && ((_a = v.resolved) === null || _a === void 0 ? void 0 : _a.getFilename()) === id.getFilename()
+                && ((_b = v.resolved) === null || _b === void 0 ? void 0 : _b.getStart().equals(id.getStart()))) {
+                ret.push(v.position.getStart());
+            }
+        }
+        return ret;
+    }
+    listMethodNodes(node) {
+        const ret = [];
+        if (node.getIdentifier().stype === _scope_type_1.ScopeType.Method) {
+            ret.push(node);
+        }
+        else {
+            for (const c of node.getChildren()) {
+                ret.push(...this.listMethodNodes(c));
+            }
+        }
+        return ret;
+    }
+}
+exports.SlowParameterPassing = SlowParameterPassing;
+//# sourceMappingURL=slow_parameter_passing.js.map

package/build/src/rules/unnecessary_pragma.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnnecessaryPragma = exports.UnnecessaryPragmaConf = void 0;
+const issue_1 = require("../issue");
+const Statements = require("../abap/2_statements/statements");
+const Expressions = require("../abap/2_statements/expressions");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _statement_1 = require("../abap/2_statements/statements/_statement");
+const _irule_1 = require("./_irule");
+class UnnecessaryPragmaConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.UnnecessaryPragmaConf = UnnecessaryPragmaConf;
+class UnnecessaryPragma extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new UnnecessaryPragmaConf();
+    }
+    getMetadata() {
+        return {
+            key: "unnecessary_pragma",
+            title: "Unnecessary Pragma",
+            shortDescription: `Finds pragmas which can be removed`,
+            extendedInformation: `* NO_HANDLER with handler
+
+* NEEDED without definition
+
+* NO_TEXT without texts`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `TRY.
+    ...
+  CATCH zcx_abapgit_exception ##NO_HANDLER.
+    RETURN. " it has a handler
+ENDTRY.
+MESSAGE w125(zbar) WITH c_foo INTO message ##NEEDED ##NO_TEXT.`,
+            goodExample: `TRY.
+    ...
+  CATCH zcx_abapgit_exception.
+    RETURN.
+ENDTRY.
+MESSAGE w125(zbar) WITH c_foo INTO message.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        let noHandler = false;
+        const statements = file.getStatements();
+        for (let i = 0; i < statements.length; i++) {
+            const statement = statements[i];
+            if (statement.get() instanceof Statements.EndTry) {
+                noHandler = false;
+            }
+            else if (statement.get() instanceof _statement_1.Comment) {
+                continue;
+            }
+            else if (noHandler === true && !(statement.get() instanceof Statements.Catch)) {
+                const message = "NO_HANDLER pragma or pseudo comment can be removed";
+                const issue = issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity);
+                issues.push(issue);
+                noHandler = false;
+            }
+            else {
+                noHandler = this.containsNoHandler(statement, statements[i + 1]);
+            }
+            issues.push(...this.checkText(statement, file));
+            issues.push(...this.checkNeeded(statement, file));
+        }
+        return issues;
+    }
+    checkText(statement, file) {
+        const p = statement.getPragmas().find(t => t.getStr().toUpperCase() === "##NO_TEXT");
+        if (p === undefined) {
+            return [];
+        }
+        if (statement.findFirstExpression(Expressions.ConstantString) === undefined
+            && statement.findFirstExpression(Expressions.StringTemplate) === undefined) {
+            const message = "There is no text, NO_TEXT can be removed";
+            return [issue_1.Issue.atToken(file, p, message, this.getMetadata().key, this.getConfig().severity)];
+        }
+        return [];
+    }
+    checkNeeded(statement, file) {
+        const p = statement.getPragmas().find(t => t.getStr().toUpperCase() === "##NEEDED");
+        if (p === undefined) {
+            return [];
+        }
+        if (statement.findFirstExpression(Expressions.InlineData) === undefined
+            && !(statement.get() instanceof Statements.Parameter)
+            && !(statement.get() instanceof Statements.Data)
+            && !(statement.get() instanceof Statements.Type)
+            && !(statement.get() instanceof Statements.Constant)
+            && !(statement.get() instanceof Statements.TypeEnum)
+            && !(statement.get() instanceof Statements.MethodImplementation)
+            && !(statement.get() instanceof Statements.MethodDef)
+            && statement.findFirstExpression(Expressions.InlineFS) === undefined) {
+            const message = "There is no data definition, NEEDED can be removed";
+            return [issue_1.Issue.atToken(file, p, message, this.getMetadata().key, this.getConfig().severity)];
+        }
+        return [];
+    }
+    containsNoHandler(statement, next) {
+        for (const t of statement.getPragmas()) {
+            if (t.getStr().toUpperCase() === "##NO_HANDLER") {
+                return true;
+            }
+        }
+        if (next
+            && next.get() instanceof _statement_1.Comment
+            && next.concatTokens().toUpperCase().includes("#EC NO_HANDLER")) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.UnnecessaryPragma = UnnecessaryPragma;
+//# sourceMappingURL=unnecessary_pragma.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/core",
-    "version": "2.86.8",
+    "version": "2.88.1",
     "description": "abaplint - Core API",
     "main": "build/src/index.js",
     "typings": "build/abaplint.d.ts",
@@ -45,7 +45,7 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@microsoft/api-extractor": "^7.20.0",
+        "@microsoft/api-extractor": "^7.20.1",
         "@types/chai": "^4.3.0",
         "@types/mocha": "^9.1.0",
         "@types/node": "^17.0.23",

package/build/src/rules/check_no_handler_pragma.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CheckNoHandlerPragma = exports.CheckNoHandlerPragmaConf = void 0;
-const issue_1 = require("../issue");
-const Statements = require("../abap/2_statements/statements");
-const _abap_rule_1 = require("./_abap_rule");
-const _basic_rule_config_1 = require("./_basic_rule_config");
-const _statement_1 = require("../abap/2_statements/statements/_statement");
-const _irule_1 = require("./_irule");
-class CheckNoHandlerPragmaConf extends _basic_rule_config_1.BasicRuleConfig {
-}
-exports.CheckNoHandlerPragmaConf = CheckNoHandlerPragmaConf;
-class CheckNoHandlerPragma extends _abap_rule_1.ABAPRule {
-    constructor() {
-        super(...arguments);
-        this.conf = new CheckNoHandlerPragmaConf();
-    }
-    getMetadata() {
-        return {
-            key: "check_no_handler_pragma",
-            title: "Check if NO_HANDLER can be removed",
-            shortDescription: `Checks NO_HANDLER pragmas that can be removed`,
-            tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `TRY.
-    ...
-  CATCH zcx_abapgit_exception ##NO_HANDLER.
-    RETURN. " it has a handler
-ENDTRY.`,
-            goodExample: `TRY.
-    ...
-  CATCH zcx_abapgit_exception.
-    RETURN.
-ENDTRY.`,
-        };
-    }
-    getConfig() {
-        return this.conf;
-    }
-    setConfig(conf) {
-        this.conf = conf;
-    }
-    runParsed(file) {
-        const issues = [];
-        let noHandler = false;
-        const statements = file.getStatements();
-        for (let i = 0; i < statements.length; i++) {
-            const statement = statements[i];
-            if (statement.get() instanceof Statements.EndTry) {
-                noHandler = false;
-            }
-            else if (statement.get() instanceof _statement_1.Comment) {
-                continue;
-            }
-            else if (noHandler === true && !(statement.get() instanceof Statements.Catch)) {
-                const message = "NO_HANDLER pragma or pseudo comment can be removed";
-                const issue = issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity);
-                issues.push(issue);
-                noHandler = false;
-            }
-            else {
-                noHandler = this.containsNoHandler(statement, statements[i + 1]);
-            }
-        }
-        return issues;
-    }
-    containsNoHandler(statement, next) {
-        for (const t of statement.getPragmas()) {
-            if (t.getStr().toUpperCase() === "##NO_HANDLER") {
-                return true;
-            }
-        }
-        if (next
-            && next.get() instanceof _statement_1.Comment
-            && next.concatTokens().toUpperCase().includes("#EC NO_HANDLER")) {
-            return true;
-        }
-        return false;
-    }
-}
-exports.CheckNoHandlerPragma = CheckNoHandlerPragma;
-//# sourceMappingURL=check_no_handler_pragma.js.map