@abaplint/core 2.80.7 → 2.80.8

package/build/src/rules/prefer_returning_to_exporting.js

@@ -20,7 +20,7 @@ class PreferReturningToExporting extends _abap_rule_1.ABAPRule {
             key: "prefer_returning_to_exporting",
             title: "Prefer RETURNING to EXPORTING",
             shortDescription: `Prefer RETURNING to EXPORTING. Generic types cannot be RETURNING.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-returning-to-exporting
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-returning-to-exporting
 https://docs.abapopenchecks.org/checks/44/`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/prefer_xsdbool.js

@@ -21,8 +21,8 @@ class PreferXsdbool extends _abap_rule_1.ABAPRule {
             key: "prefer_xsdbool",
             title: "Prefer xsdbool over boolc",
             shortDescription: `Prefer xsdbool over boolc`,
-            extendedInformation: `Activates if language version is v740sp08 or above.
-
+            extendedInformation: `Activates if language version is v740sp08 or above.
+
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-xsdbool-to-set-boolean-variables`,
             tags: [_irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Upport, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
             badExample: `DATA(sdf) = boolc( 1 = 2 ).`,

package/build/src/rules/remove_descriptions.js

@@ -26,10 +26,10 @@ class RemoveDescriptions {
         return {
             key: "remove_descriptions",
             title: "Remove descriptions",
-            shortDescription: `Ensures you have no descriptions in metadata of methods, parameters, etc.
-
-Class descriptions are required, see rule description_empty.
-
+            shortDescription: `Ensures you have no descriptions in metadata of methods, parameters, etc.
+
+Class descriptions are required, see rule description_empty.
+
 Consider using ABAP Doc for documentation.`,
             tags: [],
         };

package/build/src/rules/rfc_error_handling.js

@@ -22,16 +22,16 @@ class RFCErrorHandling extends _abap_rule_1.ABAPRule {
             tags: [_irule_1.RuleTag.SingleFile],
             shortDescription: `Checks that exceptions 'system_failure' and 'communication_failure' are handled in RFC calls`,
             extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abenrfc_exception.htm`,
-            badExample: `
-CALL FUNCTION 'ZRFC'
+            badExample: `
+CALL FUNCTION 'ZRFC'
   DESTINATION lv_rfc.`,
-            goodExample: `
-CALL FUNCTION 'ZRFC'
-  DESTINATION lv_rfc
-  EXCEPTIONS
-    system_failure        = 1 MESSAGE msg
-    communication_failure = 2 MESSAGE msg
-    resource_failure      = 3
+            goodExample: `
+CALL FUNCTION 'ZRFC'
+  DESTINATION lv_rfc
+  EXCEPTIONS
+    system_failure        = 1 MESSAGE msg
+    communication_failure = 2 MESSAGE msg
+    resource_failure      = 3
     OTHERS                = 4.`,
         };
     }

package/build/src/rules/select_add_order_by.js

@@ -21,11 +21,11 @@ class SelectAddOrderBy {
             key: "select_add_order_by",
             title: "SELECT add ORDER BY",
             shortDescription: `SELECTs add ORDER BY clause`,
-            extendedInformation: `
-This will make sure that the SELECT statement returns results in the same sequence on different databases
-
-add ORDER BY PRIMARY KEY if in doubt
-
+            extendedInformation: `
+This will make sure that the SELECT statement returns results in the same sequence on different databases
+
+add ORDER BY PRIMARY KEY if in doubt
+
 If the target is a sorted/hashed table, no issue is reported`,
             tags: [_irule_1.RuleTag.SingleFile],
         };

package/build/src/rules/select_performance.js

@@ -32,8 +32,8 @@ class SelectPerformance {
             key: "select_performance",
             title: "SELECT performance",
             shortDescription: `Various checks regarding SELECT performance.`,
-            extendedInformation: `ENDSELECT: not reported when the corresponding SELECT has PACKAGE SIZE
-
+            extendedInformation: `ENDSELECT: not reported when the corresponding SELECT has PACKAGE SIZE
+
 SELECT *: not reported if using INTO/APPENDING CORRESPONDING FIELDS OF`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Performance],
         };

package/build/src/rules/sicf_consistency.js

@@ -16,10 +16,10 @@ class SICFConsistency {
         return {
             key: "sicf_consistency",
             title: "SICF consistency",
-            shortDescription: `Checks the validity of ICF services:
-
-* Class defined in handler must exist
-* Class must not have any syntax errors
+            shortDescription: `Checks the validity of ICF services:
+
+* Class defined in handler must exist
+* Class must not have any syntax errors
 * Class must implement interface IF_HTTP_EXTENSION`,
         };
     }

package/build/src/rules/space_before_dot.js

@@ -29,8 +29,8 @@ class SpaceBeforeDot extends _abap_rule_1.ABAPRule {
             key: "space_before_dot",
             title: "Space before dot",
             shortDescription: `Checks for extra spaces before dots at the ends of statements`,
-            extendedInformation: `
-https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#be-consistent
+            extendedInformation: `
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#be-consistent
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#condense-your-code`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
             badExample: `WRITE bar .`,

package/build/src/rules/start_at_tab.js

@@ -20,7 +20,7 @@ class StartAtTab extends _abap_rule_1.ABAPRule {
             key: "start_at_tab",
             title: "Start at tab",
             shortDescription: `Checks that statements start at tabstops.`,
-            extendedInformation: `Reports max 100 issues per file
+            extendedInformation: `Reports max 100 issues per file
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#indent-and-snap-to-tab`,
             tags: [_irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
             badExample: ` WRITE a.`,

package/build/src/rules/sy_modification.js

@@ -21,8 +21,8 @@ class SyModification extends _abap_rule_1.ABAPRule {
             shortDescription: `Finds modification of sy fields`,
             extendedInformation: `https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abensystem_fields.htm`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `
-sy-uname = 2.
+            badExample: `
+sy-uname = 2.
 sy = sy.`,
         };
     }

package/build/src/rules/tabl_enhancement_category.js

@@ -17,8 +17,8 @@ class TABLEnhancementCategory {
             key: "tabl_enhancement_category",
             title: "TABL enhancement category must be set",
             shortDescription: `Checks that tables do not have the enhancement category 'not classified'.`,
-            extendedInformation: `SAP note 3063227 changes the default to 'Cannot be enhanced'.
-
+            extendedInformation: `SAP note 3063227 changes the default to 'Cannot be enhanced'.
+
 You may use standard report RS_DDIC_CLASSIFICATION_FINAL for adjustment.`,
             tags: [],
         };

package/build/src/rules/unused_methods.js

@@ -55,15 +55,15 @@ class UnusedMethods {
             key: "unused_methods",
             title: "Unused methods",
             shortDescription: `Checks for unused methods`,
-            extendedInformation: `Checks private and protected methods.
-
-Skips:
-* methods FOR TESTING
-* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
-* class_constructor + constructor methods
-* event handlers
-* methods that are redefined
-* INCLUDEs
+            extendedInformation: `Checks private and protected methods.
+
+Skips:
+* methods FOR TESTING
+* methods SETUP + TEARDOWN + CLASS_SETUP + CLASS_TEARDOWN in testclasses
+* class_constructor + constructor methods
+* event handlers
+* methods that are redefined
+* INCLUDEs
 `,
             tags: [],
             pragma: "##CALLED",

package/build/src/rules/unused_types.js

@@ -36,23 +36,25 @@ class WorkArea {
         return this.workarea.length;
     }
 }
-function removeDuplicates(list) {
-    const deduplicated = [];
-    for (const result of list) {
-        let cont = false;
-        for (const d of deduplicated) {
-            if (result.getStart().equals(d.getStart())) {
-                cont = true;
-                break;
-            }
-        }
-        if (cont === true) {
-            continue;
-        }
-        deduplicated.push(result);
-    }
-    return deduplicated;
+/*
+function removeDuplicates(list: readonly TypedIdentifier[]): readonly TypedIdentifier[] {
+  const deduplicated: TypedIdentifier[] = [];
+  for (const result of list) {
+    let cont = false;
+    for (const d of deduplicated) {
+      if (result.getStart().equals(d.getStart())) {
+        cont = true;
+        break;
+      }
+    }
+    if (cont === true) {
+      continue;
+    }
+    deduplicated.push(result);
+  }
+  return deduplicated;
 }
+*/
 class UnusedTypesConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
@@ -103,7 +105,10 @@ class UnusedTypes {
             return []; // exit early if all types are used in the current object
         }
         for (const o of this.reg.getObjects()) {
-            if (o instanceof _abap_object_1.ABAPObject) {
+            if (o === obj) {
+                continue;
+            }
+            else if (o instanceof _abap_object_1.ABAPObject) {
                 if (this.reg.isDependency(o)) {
                     continue; // do not search in dependencies
                 }
@@ -116,7 +121,7 @@ class UnusedTypes {
         }
         // what is left is unused
         const ret = [];
-        for (const t of removeDuplicates(this.workarea.get())) {
+        for (const t of this.workarea.get()) {
             const message = "Type \"" + t.getName() + "\" not used";
             const file = obj.getABAPFileByName(t.getFilename());
             if (file === undefined) {

package/build/src/rules/unused_variables.js

@@ -8,10 +8,10 @@ const syntax_1 = require("../abap/5_syntax/syntax");
 const _abap_object_1 = require("../objects/_abap_object");
 const _scope_type_1 = require("../abap/5_syntax/_scope_type");
 const objects_1 = require("../objects");
-const references_1 = require("../lsp/references");
 const edit_helper_1 = require("../edit_helper");
 const Statements = require("../abap/2_statements/statements");
 const _statement_1 = require("../abap/2_statements/statements/_statement");
+const _reference_1 = require("../abap/5_syntax/_reference");
 class UnusedVariablesConf extends _basic_rule_config_1.BasicRuleConfig {
     constructor() {
         super(...arguments);
@@ -22,6 +22,39 @@ class UnusedVariablesConf extends _basic_rule_config_1.BasicRuleConfig {
     }
 }
 exports.UnusedVariablesConf = UnusedVariablesConf;
+class WorkArea {
+    constructor() {
+        this.workarea = [];
+    }
+    push(id, count = 1) {
+        for (const w of this.workarea) {
+            if (id.equals(w.id)) {
+                return;
+            }
+        }
+        this.workarea.push({ id, count });
+    }
+    removeIfExists(id) {
+        if (id === undefined) {
+            return;
+        }
+        for (let i = 0; i < this.workarea.length; i++) {
+            if (id.equals(this.workarea[i].id)) {
+                this.workarea[i].count--;
+                if (this.workarea[i].count === 0) {
+                    this.workarea.splice(i, 1);
+                }
+                return;
+            }
+        }
+    }
+    get() {
+        return this.workarea;
+    }
+    count() {
+        return this.workarea.length;
+    }
+}
 class UnusedVariables {
     constructor() {
         this.conf = new UnusedVariablesConf();
@@ -31,13 +64,13 @@ class UnusedVariables {
             key: "unused_variables",
             title: "Unused variables",
             shortDescription: `Checks for unused variables and constants`,
-            extendedInformation: `WARNING: slow
-
-      Experimental, might give false positives. Skips event parameters.
-
-      Note that this currently does not work if the source code uses macros.
-
-      Unused variables are not reported if the object contains syntax errors.`,
+            extendedInformation: `WARNING: slow
+
+Experimental, might give false positives. Skips event parameters.
+
+Note that this currently does not work if the source code uses macros.
+
+Unused variables are not reported if the object contains syntax errors. Errors found in INCLUDES are reported for the main program.`,
             tags: [_irule_1.RuleTag.Quickfix],
             pragma: "##NEEDED",
             pseudoComment: "EC NEEDED",
@@ -68,67 +101,91 @@ class UnusedVariables {
         if (syntax.issues.length > 0) {
             return [];
         }
-        const results = this.traverse(syntax.spaghetti.getTop(), obj);
-        // remove duplicates, quick and dirty
-        const deduplicated = [];
-        for (const result of results) {
-            let cont = false;
-            for (const d of deduplicated) {
-                if (result.getStart().equals(d.getStart())) {
-                    cont = true;
-                    break;
-                }
-            }
-            if (cont === true) {
+        this.workarea = new WorkArea();
+        const top = syntax.spaghetti.getTop();
+        this.buildWorkarea(top, obj);
+        if (this.workarea.count() === 0) {
+            return this.buildIssues(obj); // exit early if all types are used
+        }
+        this.findUses(top, obj);
+        for (const o of this.reg.getObjects()) {
+            if (o === obj) {
                 continue;
             }
-            deduplicated.push(result);
+            else if (o instanceof _abap_object_1.ABAPObject) {
+                if (this.reg.isDependency(o)) {
+                    continue; // do not search in dependencies
+                }
+                const syntax = new syntax_1.SyntaxLogic(this.reg, o).run();
+                this.findUses(syntax.spaghetti.getTop(), o);
+                if (this.workarea.count() === 0) {
+                    return this.buildIssues(obj); // exit early if all types are used
+                }
+            }
         }
-        return deduplicated;
+        return this.buildIssues(obj);
     }
-    traverse(node, obj) {
-        const ret = [];
-        if (node.getIdentifier().stype === _scope_type_1.ScopeType.OpenSQL) {
-            return [];
-        }
-        if (node.getIdentifier().stype !== _scope_type_1.ScopeType.BuiltIn) {
-            ret.push(...this.checkNode(node, obj));
+    findUses(node, obj) {
+        for (const r of node.getData().references) {
+            if (r.referenceType === _reference_1.ReferenceType.DataReadReference
+                || r.referenceType === _reference_1.ReferenceType.DataWriteReference
+                || r.referenceType === _reference_1.ReferenceType.TypeReference) {
+                this.workarea.removeIfExists(r.resolved);
+            }
         }
         for (const c of node.getChildren()) {
-            ret.push(...this.traverse(c, obj));
+            this.findUses(c, obj);
         }
-        return ret;
     }
-    checkNode(node, obj) {
+    buildWorkarea(node, obj) {
         var _a;
+        const stype = node.getIdentifier().stype;
+        if (stype === _scope_type_1.ScopeType.OpenSQL) {
+            return;
+        }
+        for (const c of node.getChildren()) {
+            this.buildWorkarea(c, obj);
+        }
+        if (stype !== _scope_type_1.ScopeType.BuiltIn) {
+            const vars = node.getData().vars;
+            for (const name in vars) {
+                const meta = vars[name].getMeta();
+                if (((_a = this.conf.skipNames) === null || _a === void 0 ? void 0 : _a.length) > 0
+                    && this.conf.skipNames.some((a) => a.toUpperCase() === name)) {
+                    continue;
+                }
+                else if (name === "ME"
+                    || name === "SUPER"
+                    || meta.includes("event_parameter" /* EventParameter */)) {
+                    // todo, workaround for "me" and "super", these should somehow be typed to built-in
+                    continue;
+                }
+                const isInline = meta.includes("inline" /* InlineDefinition */);
+                this.workarea.push(vars[name], isInline ? 2 : 1);
+            }
+        }
+    }
+    buildIssues(obj) {
         const ret = [];
-        const vars = node.getData().vars;
-        for (const name in vars) {
-            if (((_a = this.conf.skipNames) === null || _a === void 0 ? void 0 : _a.length) > 0
-                && this.conf.skipNames.some((a) => a.toUpperCase() === name)) {
+        for (const w of this.workarea.get()) {
+            const filename = w.id.getFilename();
+            if (this.reg.isFileDependency(filename) === true) {
                 continue;
             }
-            if (name === "ME"
-                || name === "SUPER"
-                || vars[name].getMeta().includes("event_parameter" /* EventParameter */)) {
-                // todo, workaround for "me" and "super", these should somehow be typed to built-in
+            else if (obj instanceof objects_1.Program === false && obj.containsFile(filename) === false) {
                 continue;
             }
-            else if ((obj.containsFile(vars[name].getFilename())
-                || node.getIdentifier().stype === _scope_type_1.ScopeType.Program
-                || node.getIdentifier().stype === _scope_type_1.ScopeType.Form)
-                && this.isUsed(vars[name], node) === false) {
-                const message = "Variable \"" + name.toLowerCase() + "\" not used";
-                const statement = this.findStatement(vars[name]);
-                if (statement === null || statement === void 0 ? void 0 : statement.getPragmas().map(t => t.getStr()).includes(this.getMetadata().pragma + "")) {
-                    continue;
-                }
-                else if (this.suppressedbyPseudo(statement, vars[name], obj)) {
-                    continue;
-                }
-                const fix = this.buildFix(vars[name], obj);
-                ret.push(issue_1.Issue.atIdentifier(vars[name], message, this.getMetadata().key, this.conf.severity, fix));
+            const statement = this.findStatement(w.id);
+            if (statement === null || statement === void 0 ? void 0 : statement.getPragmas().map(t => t.getStr()).includes(this.getMetadata().pragma + "")) {
+                continue;
             }
+            else if (this.suppressedbyPseudo(statement, w.id, obj)) {
+                continue;
+            }
+            const name = w.id.getName();
+            const message = "Variable \"" + name.toLowerCase() + "\" not used";
+            const fix = this.buildFix(w.id, obj);
+            ret.push(issue_1.Issue.atIdentifier(w.id, message, this.getMetadata().key, this.conf.severity, fix));
         }
         return ret;
     }
@@ -151,16 +208,6 @@ class UnusedVariables {
         }
         return false;
     }
-    isUsed(id, node) {
-        const isInline = id.getMeta().includes("inline" /* InlineDefinition */);
-        const found = new references_1.References(this.reg).search(id, node, true, isInline === false);
-        if (isInline === true) {
-            return found.length > 2; // inline definitions are always written to
-        }
-        else {
-            return found.length > 1;
-        }
-    }
     findStatement(v) {
         const file = this.reg.getFileByName(v.getFilename());
         if (file === undefined) {

package/build/src/rules/use_bool_expression.js

@@ -27,15 +27,15 @@ class UseBoolExpression extends _abap_rule_1.ABAPRule {
             shortDescription: `Use boolean expression, xsdbool from 740sp08 and up, boolc from 702 and up`,
             extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#use-xsdbool-to-set-boolean-variables`,
             tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix, _irule_1.RuleTag.SingleFile],
-            badExample: `IF line IS INITIAL.
-  has_entries = abap_false.
-ELSE.
-  has_entries = abap_true.
-ENDIF.
-
+            badExample: `IF line IS INITIAL.
+  has_entries = abap_false.
+ELSE.
+  has_entries = abap_true.
+ENDIF.
+
 DATA(fsdf) = COND #( WHEN foo <> bar THEN abap_true ELSE abap_false ).`,
-            goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
-
+            goodExample: `DATA(has_entries) = xsdbool( line IS NOT INITIAL ).
+
 DATA(fsdf) = xsdbool( foo <> bar ).`,
         };
     }

package/build/src/rules/use_line_exists.js

@@ -22,15 +22,15 @@ class UseLineExists extends _abap_rule_1.ABAPRule {
             key: "use_line_exists",
             title: "Use line_exists",
             shortDescription: `Use line_exists, from 740sp02 and up`,
-            extendedInformation: `
-https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
-
+            extendedInformation: `
+https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-line_exists-to-read-table-or-loop-at
+
 Not reported if the READ TABLE statement contains BINARY SEARCH.`,
             tags: [_irule_1.RuleTag.Upport, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.SingleFile],
-            badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
-IF sy-subrc = 0.
+            badExample: `READ TABLE my_table TRANSPORTING NO FIELDS WITH KEY key = 'A'.
+IF sy-subrc = 0.
 ENDIF.`,
-            goodExample: `IF line_exists( my_table[ key = 'A' ] ).
+            goodExample: `IF line_exists( my_table[ key = 'A' ] ).
 ENDIF.`,
         };
     }

package/build/src/rules/use_new.js

@@ -23,8 +23,8 @@ class UseNew extends _abap_rule_1.ABAPRule {
             key: "use_new",
             title: "Use NEW",
             shortDescription: `Checks for deprecated CREATE OBJECT statements.`,
-            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
-
+            extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#prefer-new-to-create-object
+
 If the target variable is referenced in the CREATE OBJECT statement, no errors are issued`,
             badExample: `CREATE OBJECT ref.`,
             goodExample: `ref = NEW #( ).`,

package/build/src/rules/when_others_last.js

@@ -21,13 +21,13 @@ class WhenOthersLast extends _abap_rule_1.ABAPRule {
             title: "WHEN OTHERS last",
             shortDescription: `Checks that WHEN OTHERS is placed the last within a CASE statement.`,
             tags: [_irule_1.RuleTag.SingleFile],
-            badExample: `CASE bar.
-  WHEN OTHERS.
-  WHEN 2.
+            badExample: `CASE bar.
+  WHEN OTHERS.
+  WHEN 2.
 ENDCASE.`,
-            goodExample: `CASE bar.
-  WHEN 2.
-  WHEN OTHERS.
+            goodExample: `CASE bar.
+  WHEN 2.
+  WHEN OTHERS.
 ENDCASE.`,
         };
     }