@abaplint/core 2.108.14 → 2.109.1

package/build/abaplint.d.ts

@@ -3132,6 +3132,11 @@ export declare interface IFile {
     getRawRows(): string[];
 }
 
+declare interface IFilenameAndToken {
+    filename: string;
+    token: Token;
+}
+
 declare interface IFormDefinition extends Identifier {
     getTablesParameters(): readonly TypedIdentifier[];
     getUsingParameters(): readonly TypedIdentifier[];
@@ -3211,6 +3216,18 @@ declare interface ILookupResult {
     object?: IObject;
 }
 
+declare interface IMacroReferences {
+    addDefinition(ref: IFilenameAndToken, start: Position, end: Position): void;
+    addReference(ref: IFilenameAndToken): void;
+    listDefinitionsByFile(filename: string): Token[];
+    listUsagesbyMacro(filename: string, token: Token): IFilenameAndToken[];
+    getDefinitionPosition(filename: string, token: Token): {
+        start: Position;
+        end: Position;
+    } | undefined;
+    clear(filename: string): void;
+}
+
 declare interface IMatch {
     matched: StatementNode[];
     unmatched: StatementNode[];
@@ -3651,6 +3668,7 @@ export declare interface IRegistry {
     inErrorNamespace(name: string): boolean;
     getDDICReferences(): IDDICReferences;
     getMSAGReferences(): IMSAGReferences;
+    getMacroReferences(): IMacroReferences;
     getConfig(): IConfiguration;
     setConfig(conf: IConfiguration): IRegistry;
     /** Get all objects, including dependencies */
@@ -5246,11 +5264,13 @@ export declare class Registry implements IRegistry {
     private readonly dependencies;
     private readonly ddicReferences;
     private readonly msagReferences;
+    private readonly macroReferences;
     private conf;
     constructor(conf?: IConfiguration);
     static abaplintVersion(): string;
     getDDICReferences(): IDDICReferences;
     getMSAGReferences(): IMSAGReferences;
+    getMacroReferences(): IMacroReferences;
     getObjects(): Generator<IObject, void, undefined>;
     getObjectsByType(type: string): Generator<IObject, void, undefined>;
     getFiles(): Generator<IFile, void, undefined>;

package/build/src/_imacro_references.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=_imacro_references.js.map

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

@@ -15,17 +15,23 @@ class Macros {
     constructor(globalMacros) {
         this.macros = {};
         for (const m of globalMacros) {
-            this.macros[m.toUpperCase()] = [];
+            this.macros[m.toUpperCase()] = {
+                statements: [],
+                filename: undefined,
+            };
         }
     }
-    addMacro(name, contents) {
+    addMacro(name, contents, filename) {
         if (this.isMacro(name)) {
             return;
         }
-        this.macros[name.toUpperCase()] = contents;
+        this.macros[name.toUpperCase()] = {
+            statements: contents,
+            filename: filename,
+        };
     }
     getContents(name) {
-        return this.macros[name.toUpperCase()];
+        return this.macros[name.toUpperCase()].statements;
     }
     listMacroNames() {
         return Object.keys(this.macros);
@@ -36,6 +42,9 @@ class Macros {
         }
         return false;
     }
+    getMacroFilename(name) {
+        return this.macros[name.toUpperCase()].filename;
+    }
 }
 class ExpandMacros {
     // "reg" must be supplied if there are cross object macros via INCLUDE
@@ -45,35 +54,42 @@ class ExpandMacros {
         this.globalMacros = globalMacros;
         this.reg = reg;
     }
-    find(statements) {
-        var _a, _b;
-        let name = undefined;
+    find(statements, file, clear = true) {
+        var _a, _b, _c;
+        let nameToken = undefined;
+        let start = undefined;
         let contents = [];
+        const macroReferences = (_a = this.reg) === null || _a === void 0 ? void 0 : _a.getMacroReferences();
+        if (clear) {
+            macroReferences === null || macroReferences === void 0 ? void 0 : macroReferences.clear(file.getFilename());
+        }
         for (let i = 0; i < statements.length; i++) {
             const statement = statements[i];
             const type = statement.get();
             if (type instanceof Statements.Define) {
                 // todo, will this break if first token is a pragma?
-                name = statement.getTokens()[1].getStr();
+                nameToken = statement.getTokens()[1];
+                start = statement.getFirstToken().getStart();
                 contents = [];
             }
             else if (type instanceof Statements.Include) {
-                const includeName = (_a = statement.findDirectExpression(Expressions.IncludeName)) === null || _a === void 0 ? void 0 : _a.concatTokens();
+                const includeName = (_b = statement.findDirectExpression(Expressions.IncludeName)) === null || _b === void 0 ? void 0 : _b.concatTokens();
                 // todo, this does not take function module includes into account
-                const prog = (_b = this.reg) === null || _b === void 0 ? void 0 : _b.getObject("PROG", includeName);
+                const prog = (_c = this.reg) === null || _c === void 0 ? void 0 : _c.getObject("PROG", includeName);
                 if (prog) {
                     prog.parse(this.version, this.globalMacros, this.reg);
-                    const main = prog.getMainABAPFile();
-                    if (main) {
+                    const includeMainFile = prog.getMainABAPFile();
+                    if (includeMainFile) {
                         // slow, this copies everything,
-                        this.find([...main.getStatements()]);
+                        this.find([...includeMainFile.getStatements()], includeMainFile, false);
                     }
                 }
             }
-            else if (name) {
+            else if (nameToken) {
                 if (type instanceof Statements.EndOfDefinition) {
-                    this.macros.addMacro(name, contents);
-                    name = undefined;
+                    this.macros.addMacro(nameToken.getStr(), contents, file.getFilename());
+                    macroReferences === null || macroReferences === void 0 ? void 0 : macroReferences.addDefinition({ filename: file.getFilename(), token: nameToken }, start, statement.getLastToken().getEnd());
+                    nameToken = undefined;
                 }
                 else if (!(type instanceof _statement_1.Comment)) {
                     statements[i] = new statement_node_1.StatementNode(new _statement_1.MacroContent()).setChildren(this.tokensToNodes(statement.getTokens()));
@@ -82,17 +98,26 @@ class ExpandMacros {
             }
         }
     }
-    handleMacros(statements) {
+    handleMacros(statements, file) {
+        var _a;
         const result = [];
         let containsUnknown = false;
+        const macroReferences = (_a = this.reg) === null || _a === void 0 ? void 0 : _a.getMacroReferences();
         for (const statement of statements) {
             const type = statement.get();
             if (type instanceof _statement_1.Unknown || type instanceof _statement_1.MacroCall) {
                 const macroName = this.findName(statement.getTokens());
                 if (macroName && this.macros.isMacro(macroName)) {
+                    const filename = this.macros.getMacroFilename(macroName);
+                    if (filename) {
+                        macroReferences === null || macroReferences === void 0 ? void 0 : macroReferences.addReference({
+                            filename: filename,
+                            token: statement.getFirstToken(),
+                        });
+                    }
                     result.push(new statement_node_1.StatementNode(new _statement_1.MacroCall(), statement.getColon()).setChildren(this.tokensToNodes(statement.getTokens())));
                     const expanded = this.expandContents(macroName, statement);
-                    const handled = this.handleMacros(expanded);
+                    const handled = this.handleMacros(expanded, file);
                     for (const e of handled.statements) {
                         result.push(e);
                     }

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

@@ -82,10 +82,10 @@ class StatementParser {
         for (const w of wa) {
             this.process(w);
             this.categorize(w);
-            macros.find(w.statements);
+            macros.find(w.statements, w.file);
         }
         for (const w of wa) {
-            const res = macros.handleMacros(w.statements);
+            const res = macros.handleMacros(w.statements, w.file);
             w.statements = res.statements;
             if (res.containsUnknown === true) {
                 this.lazyUnknown(w);

package/build/src/lsp/hover.js

@@ -7,6 +7,7 @@ const LServer = require("vscode-languageserver-types");
 const _abap_object_1 = require("../objects/_abap_object");
 const _lsp_utils_1 = require("./_lsp_utils");
 const _lookup_1 = require("./_lookup");
+const _statement_1 = require("../abap/2_statements/statements/_statement");
 class Hover {
     constructor(reg) {
         this.reg = reg;
@@ -30,6 +31,9 @@ class Hover {
             || found.token instanceof Tokens.StringTemplateMiddle) {
             return { kind: LServer.MarkupKind.Markdown, value: "String Template" };
         }
+        else if (found.snode.get() instanceof _statement_1.MacroCall) {
+            return { kind: LServer.MarkupKind.Markdown, value: "Macro Call" };
+        }
         else if (found.snode.get() instanceof Statements.Define && found.stack.length === 2) {
             return { kind: LServer.MarkupKind.Markdown, value: "Macro Name" };
         }

package/build/src/macro_references.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MacroReferences = void 0;
+class MacroReferences {
+    constructor() {
+        this.definitions = {};
+        this.references = {};
+    }
+    addDefinition(ref, start, end) {
+        if (this.definitions[ref.filename] === undefined) {
+            this.definitions[ref.filename] = [];
+        }
+        else if (this.definitions[ref.filename].find((d) => d.token.getStart().equals(ref.token.getStart()))) {
+            return;
+        }
+        this.definitions[ref.filename].push({ token: ref.token, start, end });
+    }
+    getDefinitionPosition(filename, token) {
+        for (const d of this.definitions[filename] || []) {
+            if (d.token.getStart().equals(token.getStart())) {
+                return { start: d.token.getStart(), end: d.token.getEnd() };
+            }
+        }
+        return undefined;
+    }
+    addReference(ref) {
+        if (this.references[ref.filename] === undefined) {
+            this.references[ref.filename] = [];
+        }
+        this.references[ref.filename].push(ref);
+    }
+    listDefinitionsByFile(filename) {
+        const ret = [];
+        for (const d of this.definitions[filename] || []) {
+            ret.push(d.token);
+        }
+        return ret;
+    }
+    listUsagesbyMacro(filename, token) {
+        const ret = [];
+        const tokenStr = token.getStr().toUpperCase();
+        for (const ref of this.references[filename] || []) {
+            if (ref.token.getStr().toUpperCase() === tokenStr) {
+                ret.push(ref);
+            }
+        }
+        return ret;
+    }
+    clear(filename) {
+        delete this.definitions[filename];
+        delete this.references[filename];
+    }
+}
+exports.MacroReferences = MacroReferences;
+//# sourceMappingURL=macro_references.js.map

package/build/src/registry.js

@@ -8,6 +8,7 @@ const excludeHelper_1 = require("./utils/excludeHelper");
 const ddic_references_1 = require("./ddic_references");
 const rules_runner_1 = require("./rules_runner");
 const msag_references_1 = require("./msag_references");
+const macro_references_1 = require("./macro_references");
 // todo, this should really be an instance in case there are multiple Registry'ies
 class ParsingPerformance {
     static clear() {
@@ -62,10 +63,11 @@ class Registry {
         this.conf = conf ? conf : config_1.Config.getDefault();
         this.ddicReferences = new ddic_references_1.DDICReferences();
         this.msagReferences = new msag_references_1.MSAGReferences();
+        this.macroReferences = new macro_references_1.MacroReferences();
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.108.14";
+        return "2.109.1";
     }
     getDDICReferences() {
         return this.ddicReferences;
@@ -73,6 +75,9 @@ class Registry {
     getMSAGReferences() {
         return this.msagReferences;
     }
+    getMacroReferences() {
+        return this.macroReferences;
+    }
     *getObjects() {
         for (const name in this.objects) {
             for (const type in this.objects[name]) {

package/build/src/rules/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./cds_legacy_view"), exports);
 __exportStar(require("./cds_parser_error"), exports);
 __exportStar(require("./chain_mainly_declarations"), exports);
 __exportStar(require("./change_if_to_case"), exports);
+__exportStar(require("./unused_macros"), exports);
 __exportStar(require("./check_abstract"), exports);
 __exportStar(require("./check_comments"), exports);
 __exportStar(require("./check_ddic"), exports);

package/build/src/rules/unused_macros.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnusedMacros = exports.UnusedMacrosConf = void 0;
+const issue_1 = require("../issue");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const _irule_1 = require("./_irule");
+const _abap_object_1 = require("../objects/_abap_object");
+const edit_helper_1 = require("../edit_helper");
+class UnusedMacrosConf extends _basic_rule_config_1.BasicRuleConfig {
+    constructor() {
+        super(...arguments);
+        /** skip specific names, case insensitive
+         * @uniqueItems true
+         */
+        this.skipNames = [];
+    }
+}
+exports.UnusedMacrosConf = UnusedMacrosConf;
+class UnusedMacros {
+    constructor() {
+        this.conf = new UnusedMacrosConf();
+    }
+    getMetadata() {
+        return {
+            key: "unused_macros",
+            title: "Unused macros",
+            shortDescription: `Checks for unused macro definitions definitions`,
+            tags: [_irule_1.RuleTag.Quickfix],
+            badExample: `DEFINE foobar1.
+  WRITE 'hello'.
+END-OF-DEFINITION.`,
+            goodExample: `DEFINE foobar2.
+  WRITE 'hello'.
+END-OF-DEFINITION.
+
+foobar2.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+        if (this.conf.skipNames === undefined) {
+            this.conf.skipNames = [];
+        }
+    }
+    initialize(reg) {
+        this.reg = reg;
+        return this;
+    }
+    run(obj) {
+        var _a;
+        const result = [];
+        if (!(obj instanceof _abap_object_1.ABAPObject)) {
+            return [];
+        }
+        const references = this.reg.getMacroReferences();
+        for (const file of obj.getABAPFiles()) {
+            for (const macroToken of references.listDefinitionsByFile(file.getFilename())) {
+                const usages = references.listUsagesbyMacro(file.getFilename(), macroToken);
+                if (usages.length === 0 && ((_a = this.conf.skipNames) === null || _a === void 0 ? void 0 : _a.includes(macroToken.getStr().toUpperCase())) === false) {
+                    const message = "Unused macro definition: " + macroToken.getStr();
+                    const pos = references.getDefinitionPosition(file.getFilename(), macroToken);
+                    const fix = edit_helper_1.EditHelper.deleteRange(file, pos.start, pos.end);
+                    result.push(issue_1.Issue.atToken(file, macroToken, message, this.getMetadata().key, this.conf.severity, fix));
+                }
+            }
+        }
+        return result;
+    }
+}
+exports.UnusedMacros = UnusedMacros;
+//# sourceMappingURL=unused_macros.js.map

package/package.json

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