@abaplint/core 2.112.21 → 2.113.0

package/build/abaplint.d.ts

@@ -6053,7 +6053,7 @@ declare class StartOfSelection implements IStatement {
 
 export declare class StatementFlow {
     private counter;
-    build(stru: StructureNode): FlowGraph[];
+    build(stru: StructureNode, obj: IObject): FlowGraph[];
     private runEvent;
     private run;
     private findBody;

package/build/src/abap/flow/selection_events.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DECLARATION_STUFF = exports.SELECTION_EVENTS = void 0;
+const Statements = require("../2_statements/statements");
+exports.SELECTION_EVENTS = [
+    Statements.StartOfSelection,
+    Statements.AtSelectionScreen,
+    Statements.AtLineSelection,
+    Statements.AtUserCommand,
+    Statements.EndOfSelection,
+    Statements.Initialization,
+    Statements.TopOfPage,
+    Statements.EndOfPage,
+];
+exports.DECLARATION_STUFF = [
+    Statements.Data,
+    Statements.DataBegin,
+    Statements.Constant,
+    Statements.Parameter,
+    Statements.SelectionScreen,
+    Statements.ConstantBegin,
+];
+//# sourceMappingURL=selection_events.js.map

package/build/src/abap/flow/statement_flow.js

@@ -6,35 +6,13 @@ const Structures = require("../3_structures/structures");
 const Statements = require("../2_statements/statements");
 const Expressions = require("../2_statements/expressions");
 const flow_graph_1 = require("./flow_graph");
-// Levels: top, FORM, METHOD, FUNCTION-MODULE, (MODULE, AT, END-OF-*, GET, START-OF-SELECTION, TOP-OF-PAGE)
-//
-// Loop branching: LOOP, DO, WHILE, SELECT(loop), WITH, PROVIDE
-//
-// Branching: IF, CASE, CASE TYPE OF, TRY, ON, CATCH SYSTEM-EXCEPTIONS, AT
-//
-// Conditional exits: CHECK, ASSERT
-//
-// Exits: RETURN, EXIT, RAISE(not RESUMABLE), MESSAGE(type E and A?), CONTINUE, REJECT, RESUME, STOP
-//
-// Not handled? INCLUDE + malplaced macro calls
-/////////////////////////////////////
-// TODO: handling static exceptions(only static), refactor some logic from UncaughtException to common file
-// TODO: RAISE
-const FLOW_EVENTS = [
-    Statements.StartOfSelection,
-    Statements.AtSelectionScreen,
-    Statements.AtLineSelection,
-    Statements.AtUserCommand,
-    Statements.EndOfSelection,
-    Statements.Initialization,
-    Statements.TopOfPage,
-    Statements.EndOfPage,
-];
+const objects_1 = require("../../objects");
+const selection_events_1 = require("./selection_events");
 class StatementFlow {
     constructor() {
         this.counter = 0;
     }
-    build(stru) {
+    build(stru, obj) {
         var _a, _b, _c, _d;
         const ret = [];
         let name = "";
@@ -60,34 +38,38 @@ class StatementFlow {
                 throw new Error("StatementFlow, unknown structure");
             }
         }
-        // find the top level events
-        let inFlow = false;
-        let collected = [];
-        for (const s of stru.getChildren() || []) {
-            if (FLOW_EVENTS.some(f => s.get() instanceof f)) {
-                if (inFlow === true) {
-                    ret.push(this.runEvent(collected, name));
+        if (obj instanceof objects_1.Program) {
+            // find the top level events
+            let inEvent = false;
+            let collected = [];
+            for (const s of stru.getChildren() || []) {
+                if (selection_events_1.SELECTION_EVENTS.some(f => s.get() instanceof f)) {
+                    if (inEvent === true) {
+                        ret.push(this.runEvent(collected, name));
+                    }
+                    collected = [];
+                    inEvent = true;
+                    name = s.concatTokens();
+                }
+                else if (s.get() instanceof Structures.Normal) {
+                    collected.push(s);
+                }
+                else {
+                    if (inEvent === true) {
+                        ret.push(this.runEvent(collected, name));
+                        inEvent = false;
+                    }
+                    collected = [];
                 }
-                collected = [];
-                inFlow = true;
-                name = s.concatTokens();
             }
-            else if (s.get() instanceof Structures.Normal) {
-                collected.push(s);
+            if (inEvent === true) {
+                ret.push(this.runEvent(collected, name));
             }
-            else {
-                if (inFlow === true) {
-                    ret.push(this.runEvent(collected, name));
-                    inFlow = false;
-                }
-                collected = [];
+            else if (collected.length > 0) {
+                // implicit START-OF-SELECTION
+                ret.push(this.runEvent(collected, "START-OF-SELECTION."));
             }
         }
-        if (inFlow === true) {
-            ret.push(this.runEvent(collected, name));
-            inFlow = false;
-            collected = [];
-        }
         return ret.map(f => f.reduce());
     }
     ////////////////////

package/build/src/lsp/language_server.js

@@ -132,11 +132,15 @@ class LanguageServer {
         if (file === undefined) {
             return "file not found";
         }
+        const obj = this.reg.findObjectForFile(file);
+        if (obj === undefined) {
+            return "obj not found";
+        }
         const stru = file.getStructure();
         if (stru === undefined) {
             return "empty structure";
         }
-        const graphs = new statement_flow_1.StatementFlow().build(stru);
+        const graphs = new statement_flow_1.StatementFlow().build(stru, obj);
         const wiz = graphs.map(g => g.toDigraph());
         return JSON.stringify(wiz);
     }

package/build/src/registry.js

@@ -67,7 +67,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.sh"
-        return "2.112.21";
+        return "2.113.0";
     }
     getDDICReferences() {
         return this.ddicReferences;

package/build/src/rules/add_test_attributes.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddTestAttributes = exports.AddTestAttributesConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const Statements = require("../abap/2_statements/statements");
+const Structures = require("../abap/3_structures/structures");
+const _irule_1 = require("./_irule");
+class AddTestAttributesConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.AddTestAttributesConf = AddTestAttributesConf;
+class AddTestAttributes extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new AddTestAttributesConf();
+    }
+    getMetadata() {
+        return {
+            key: "add_test_attributes",
+            title: "Add test attributes for tests classes with test methods",
+            shortDescription: `Add test attributes DURATION and RISK LEVEL for tests classes with test methods`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `CLASS ltcl_test DEFINITION FINAL FOR TESTING.
+  PUBLIC SECTION.
+  PROTECTED SECTION.
+  PRIVATE SECTION.
+    METHODS test FOR TESTING RAISING cx_static_check.
+ENDCLASS.
+
+CLASS ltcl_test IMPLEMENTATION.
+  METHOD test.
+  ENDMETHOD.
+ENDCLASS.`,
+            goodExample: `CLASS ltcl_test DEFINITION FINAL FOR TESTING DURATION SHORT RISK LEVEL HARMLESS.
+  PUBLIC SECTION.
+  PROTECTED SECTION.
+  PRIVATE SECTION.
+    METHODS test FOR TESTING RAISING cx_static_check.
+ENDCLASS.
+
+CLASS ltcl_test IMPLEMENTATION.
+  METHOD test.
+  ENDMETHOD.
+ENDCLASS.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        const stru = file.getStructure();
+        if (stru === undefined) {
+            return [];
+        }
+        for (const classStructure of stru.findAllStructures(Structures.ClassDefinition)) {
+            const cdef = classStructure.findFirstStatement(Statements.ClassDefinition);
+            if (cdef === undefined) {
+                continue;
+            }
+            const cdefConcat = cdef === null || cdef === void 0 ? void 0 : cdef.concatTokens().toUpperCase();
+            if ((cdefConcat === null || cdefConcat === void 0 ? void 0 : cdefConcat.includes(" FOR TESTING")) === false) {
+                continue;
+            }
+            const hasDuration = cdefConcat === null || cdefConcat === void 0 ? void 0 : cdefConcat.includes(" DURATION ");
+            const hasRiskLevel = cdefConcat === null || cdefConcat === void 0 ? void 0 : cdefConcat.includes(" RISK LEVEL ");
+            if (hasDuration === true && hasRiskLevel === true) {
+                continue;
+            }
+            let hasTestMethod = false;
+            for (const mdef of classStructure.findAllStatements(Statements.MethodDef)) {
+                const concat = mdef.concatTokens().toUpperCase();
+                if (concat.includes(" FOR TESTING")) {
+                    hasTestMethod = true;
+                }
+            }
+            if (hasTestMethod === false) {
+                continue;
+            }
+            if (hasDuration === false) {
+                issues.push(issue_1.Issue.atStatement(file, cdef, "Add DURATION", this.getMetadata().key, this.getConfig().severity));
+            }
+            if (hasRiskLevel === false) {
+                issues.push(issue_1.Issue.atStatement(file, cdef, "Add RISK LEVEL", this.getMetadata().key, this.getConfig().severity));
+            }
+        }
+        return issues;
+    }
+}
+exports.AddTestAttributes = AddTestAttributes;
+//# sourceMappingURL=add_test_attributes.js.map

package/build/src/rules/empty_event.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmptyEvent = exports.EmptyEventConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const Structures = require("../abap/3_structures/structures");
+const _irule_1 = require("./_irule");
+const objects_1 = require("../objects");
+const selection_events_1 = require("../abap/flow/selection_events");
+class EmptyEventConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.EmptyEventConf = EmptyEventConf;
+class EmptyEvent extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new EmptyEventConf();
+    }
+    getMetadata() {
+        return {
+            key: "empty_event",
+            title: "Empty selection screen or list processing event block",
+            shortDescription: `Empty selection screen or list processing event block`,
+            extendedInformation: ``,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `REPORT zfoo.
+START-OF-SELECTION.
+  PERFORM sdf.
+  COMMIT WORK.
+END-OF-SELECTION.`,
+            goodExample: `REPORT zfoo.
+START-OF-SELECTION.
+  PERFORM sdf.
+  COMMIT WORK.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file, obj) {
+        const issues = [];
+        if (!(obj instanceof objects_1.Program) || obj.isInclude()) {
+            return issues;
+        }
+        const stru = file.getStructure();
+        if (stru === undefined) {
+            return [];
+        }
+        let currentEvent = undefined;
+        let children = [];
+        for (const s of stru.getChildren() || []) {
+            if (selection_events_1.SELECTION_EVENTS.some(f => s.get() instanceof f)) {
+                children = [];
+                currentEvent = s;
+            }
+            else if (s.get() instanceof Structures.Normal) {
+                const stru = s;
+                // ignore declaration stuff
+                if (selection_events_1.DECLARATION_STUFF.some(d => { var _a; return ((_a = stru.getFirstStatement()) === null || _a === void 0 ? void 0 : _a.get()) instanceof d; })) {
+                    continue;
+                }
+                children.push(s);
+            }
+            else {
+                children = [];
+            }
+        }
+        if (currentEvent !== undefined && children.length === 0) {
+            issues.push(issue_1.Issue.atStatement(file, currentEvent, "Empty event", this.getMetadata().key, this.getConfig().severity));
+        }
+        return issues;
+    }
+}
+exports.EmptyEvent = EmptyEvent;
+//# sourceMappingURL=empty_event.js.map

package/build/src/rules/implicit_start_of_selection.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImplicitStartOfSelection = exports.ImplicitStartOfSelectionConf = void 0;
+const issue_1 = require("../issue");
+const _abap_rule_1 = require("./_abap_rule");
+const _basic_rule_config_1 = require("./_basic_rule_config");
+const Structures = require("../abap/3_structures/structures");
+const _irule_1 = require("./_irule");
+const objects_1 = require("../objects");
+const nodes_1 = require("../abap/nodes");
+const selection_events_1 = require("../abap/flow/selection_events");
+class ImplicitStartOfSelectionConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.ImplicitStartOfSelectionConf = ImplicitStartOfSelectionConf;
+class ImplicitStartOfSelection extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new ImplicitStartOfSelectionConf();
+    }
+    getMetadata() {
+        return {
+            key: "implicit_start_of_selection",
+            title: "Implicit START-OF-SELECTION",
+            shortDescription: `Add explicit selection screen event handling`,
+            extendedInformation: `Only runs for executable programs
+
+https://help.sap.com/doc/abapdocu_751_index_htm/7.51/en-us/abapstart-of-selection.htm`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `REPORT zfoo.
+WRITE 'hello'.`,
+            goodExample: `REPORT zfoo.
+START-OF-SELECTION.
+  WRITE 'hello'.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file, obj) {
+        const issues = [];
+        if (!(obj instanceof objects_1.Program) || obj.isInclude()) {
+            return issues;
+        }
+        const stru = file.getStructure();
+        if (stru === undefined) {
+            return [];
+        }
+        let inEvent = false;
+        let collected = [];
+        for (const s of stru.getChildren() || []) {
+            if (selection_events_1.SELECTION_EVENTS.some(f => s.get() instanceof f)) {
+                if (inEvent === false && collected.length > 0) {
+                    // implicit START-OF-SELECTION
+                    let first = collected[0];
+                    if (first instanceof nodes_1.StructureNode) {
+                        first = first.getFirstStatement();
+                    }
+                    issues.push(issue_1.Issue.atStatement(file, first, "Implicit START-OF-SELECTION", this.getMetadata().key, this.getConfig().severity));
+                }
+                collected = [];
+                inEvent = true;
+            }
+            else if (s.get() instanceof Structures.Normal) {
+                const stru = s;
+                // ignore declaration stuff
+                if (selection_events_1.DECLARATION_STUFF.some(d => { var _a; return ((_a = stru.getFirstStatement()) === null || _a === void 0 ? void 0 : _a.get()) instanceof d; })) {
+                    continue;
+                }
+                collected.push(s);
+            }
+            else {
+                if (inEvent === true) {
+                    inEvent = false;
+                }
+                collected = [];
+            }
+        }
+        if (inEvent === false && collected.length > 0) {
+            // implicit START-OF-SELECTION
+            let first = collected[0];
+            if (first instanceof nodes_1.StructureNode) {
+                first = first.getFirstStatement();
+            }
+            issues.push(issue_1.Issue.atStatement(file, first, "Implicit START-OF-SELECTION", this.getMetadata().key, this.getConfig().severity));
+        }
+        return issues;
+    }
+}
+exports.ImplicitStartOfSelection = ImplicitStartOfSelection;
+//# sourceMappingURL=implicit_start_of_selection.js.map

package/build/src/rules/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./7bit_ascii"), exports);
 __exportStar(require("./abapdoc"), exports);
+__exportStar(require("./add_test_attributes"), exports);
 __exportStar(require("./align_parameters"), exports);
 __exportStar(require("./align_pseudo_comments"), exports);
 __exportStar(require("./align_type_expressions"), exports);
@@ -57,6 +58,7 @@ __exportStar(require("./double_space"), exports);
 __exportStar(require("./downport"), exports);
 __exportStar(require("./dynpro_checks"), exports);
 __exportStar(require("./easy_to_find_messages"), exports);
+__exportStar(require("./empty_event"), exports);
 __exportStar(require("./empty_line_in_statement"), exports);
 __exportStar(require("./empty_statement"), exports);
 __exportStar(require("./empty_structure"), exports);
@@ -78,6 +80,7 @@ __exportStar(require("./identical_descriptions"), exports);
 __exportStar(require("./identical_form_names"), exports);
 __exportStar(require("./if_in_if"), exports);
 __exportStar(require("./implement_methods"), exports);
+__exportStar(require("./implicit_start_of_selection"), exports);
 __exportStar(require("./in_statement_indentation"), exports);
 __exportStar(require("./indentation"), exports);
 __exportStar(require("./inline_data_old_versions"), exports);

package/package.json

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