@abaplint/core 2.108.4 → 2.108.6

package/README.md

@@ -1,7 +1,7 @@
-# @abaplint/core
-
-[abaplint](https://abaplint.org) core library
-
-Exposes functionality like the parser and rules, which can be used in other projects.
-
+# @abaplint/core
+
+[abaplint](https://abaplint.org) core library
+
+Exposes functionality like the parser and rules, which can be used in other projects.
+
 For more information see https://github.com/abaplint/abaplint

package/build/abaplint.d.ts

@@ -6739,12 +6739,19 @@ declare class TopOfPage implements IStatement {
 }
 
 declare class Transaction extends AbstractObject {
+    private parsedXML;
     getType(): string;
+    setDirty(): void;
     getAllowedNaming(): {
         maxLength: number;
         allowNamespace: boolean;
     };
+    getProgramName(): string | undefined;
     getDescription(): string | undefined;
+    parse(): {
+        updated: boolean;
+        runtime: number;
+    };
 }
 
 declare class TransactionVariant extends AbstractObject {

package/build/adhoc/syntax_performance.js

@@ -5,175 +5,175 @@ const fs = require("fs");
 console.log("========================");
 const file1 = new src_1.MemoryFile("abapgit.prog.abap", fs.readFileSync("./lexer_performance.abap", "utf-8"));
 const reg = new src_1.Registry().addFile(file1);
-reg.addFile(new src_1.MemoryFile("cx_root.clas.abap", `
-CLASS cx_root DEFINITION ABSTRACT PUBLIC.
-  PUBLIC SECTION.
-    DATA previous TYPE REF TO cx_root.
-    DATA textid   TYPE c LENGTH 32.
-
-    METHODS constructor
-      IMPORTING
-        textid   LIKE textid OPTIONAL
-        previous TYPE REF TO cx_root OPTIONAL.
-
-    METHODS get_source_position
-      EXPORTING
-        program_name TYPE string
-        include_name TYPE string
-        source_line  TYPE i.
-
-    INTERFACES if_message.
-    ALIASES get_longtext FOR if_message~get_longtext.
-    ALIASES get_text FOR if_message~get_text.
-
-ENDCLASS.
-
-CLASS cx_root IMPLEMENTATION.
-
-  METHOD constructor.
-  ENDMETHOD.
-
-  METHOD get_source_position.
-  ENDMETHOD.
-
-  METHOD if_message~get_longtext.
-  ENDMETHOD.
-
-  METHOD if_message~get_text.
-  ENDMETHOD.
-
+reg.addFile(new src_1.MemoryFile("cx_root.clas.abap", `
+CLASS cx_root DEFINITION ABSTRACT PUBLIC.
+  PUBLIC SECTION.
+    DATA previous TYPE REF TO cx_root.
+    DATA textid   TYPE c LENGTH 32.
+
+    METHODS constructor
+      IMPORTING
+        textid   LIKE textid OPTIONAL
+        previous TYPE REF TO cx_root OPTIONAL.
+
+    METHODS get_source_position
+      EXPORTING
+        program_name TYPE string
+        include_name TYPE string
+        source_line  TYPE i.
+
+    INTERFACES if_message.
+    ALIASES get_longtext FOR if_message~get_longtext.
+    ALIASES get_text FOR if_message~get_text.
+
+ENDCLASS.
+
+CLASS cx_root IMPLEMENTATION.
+
+  METHOD constructor.
+  ENDMETHOD.
+
+  METHOD get_source_position.
+  ENDMETHOD.
+
+  METHOD if_message~get_longtext.
+  ENDMETHOD.
+
+  METHOD if_message~get_text.
+  ENDMETHOD.
+
 ENDCLASS.`));
-reg.addFile(new src_1.MemoryFile("cx_static_check.clas.abap", `
-CLASS cx_static_check DEFINITION PUBLIC INHERITING FROM cx_root.
-  PUBLIC SECTION.
-    METHODS constructor
-      IMPORTING
-        textid   LIKE textid OPTIONAL
-        previous TYPE REF TO cx_root OPTIONAL.
-ENDCLASS.
-
-CLASS cx_static_check IMPLEMENTATION.
-  METHOD constructor.
-  ENDMETHOD.
+reg.addFile(new src_1.MemoryFile("cx_static_check.clas.abap", `
+CLASS cx_static_check DEFINITION PUBLIC INHERITING FROM cx_root.
+  PUBLIC SECTION.
+    METHODS constructor
+      IMPORTING
+        textid   LIKE textid OPTIONAL
+        previous TYPE REF TO cx_root OPTIONAL.
+ENDCLASS.
+
+CLASS cx_static_check IMPLEMENTATION.
+  METHOD constructor.
+  ENDMETHOD.
 ENDCLASS.`));
-reg.addFile(new src_1.MemoryFile("if_message.intf.abap", `
-INTERFACE if_message PUBLIC.
-  METHODS get_text RETURNING VALUE(result) TYPE string.
-
-  METHODS get_longtext
-    IMPORTING preserve_newlines TYPE abap_bool OPTIONAL
-    RETURNING VALUE(result) TYPE string.
+reg.addFile(new src_1.MemoryFile("if_message.intf.abap", `
+INTERFACE if_message PUBLIC.
+  METHODS get_text RETURNING VALUE(result) TYPE string.
+
+  METHODS get_longtext
+    IMPORTING preserve_newlines TYPE abap_bool OPTIONAL
+    RETURNING VALUE(result) TYPE string.
 ENDINTERFACE.`));
-reg.addFile(new src_1.MemoryFile("if_t100_message.intf.abap", `
-INTERFACE if_t100_message PUBLIC.
-
-  DATA t100key TYPE scx_t100key.
-
-  CONSTANTS:
-    BEGIN OF default_textid,
-      msgid TYPE symsgid VALUE 'AB',
-      msgno TYPE symsgno VALUE '123',
-      attr1 TYPE scx_attrname VALUE '',
-      attr2 TYPE scx_attrname VALUE '',
-      attr3 TYPE scx_attrname VALUE '',
-      attr4 TYPE scx_attrname VALUE '',
-    END OF default_textid.
-
+reg.addFile(new src_1.MemoryFile("if_t100_message.intf.abap", `
+INTERFACE if_t100_message PUBLIC.
+
+  DATA t100key TYPE scx_t100key.
+
+  CONSTANTS:
+    BEGIN OF default_textid,
+      msgid TYPE symsgid VALUE 'AB',
+      msgno TYPE symsgno VALUE '123',
+      attr1 TYPE scx_attrname VALUE '',
+      attr2 TYPE scx_attrname VALUE '',
+      attr3 TYPE scx_attrname VALUE '',
+      attr4 TYPE scx_attrname VALUE '',
+    END OF default_textid.
+
 ENDINTERFACE.`));
-reg.setConfig(new src_1.Config(`
-{
-  "global": {
-    "files": "/src/**/*.*"
-  },
-  "dependencies": [],
-  "syntax": {
-    "version": "v702",
-    "errorNamespace": "^(Z|Y|LCL_|TY_|LIF_)",
-    "globalConstants": [
-      "abap_func_exporting",
-      "abap_func_tables",
-      "cssf_formtype_text",
-      "icon_abap",
-      "icon_adopt",
-      "icon_change",
-      "icon_create",
-      "icon_delete",
-      "icon_display_text",
-      "icon_folder",
-      "icon_led_green",
-      "icon_led_inactive",
-      "icon_led_red",
-      "icon_led_yellow",
-      "icon_message_information",
-      "icon_okay",
-      "icon_set_state",
-      "icon_stack",
-      "icon_system_help",
-      "icon_workflow_fork",
-      "seoc_category_exception",
-      "seoc_category_webdynpro_class",
-      "seoc_exposure_private",
-      "seoc_exposure_protected",
-      "seoc_exposure_public",
-      "seoc_state_implemented",
-      "seoc_version_active",
-      "seoc_version_deleted",
-      "seoc_version_inactive",
-      "seok_access_free",
-      "seok_access_modify",
-      "seox_false",
-      "seok_pgmid_r3tr",
-      "seoo_cmptype_type",
-      "seoo_cmptype_event",
-      "seoo_cmptype_method",
-      "seoo_cmptype_attribute",
-      "seop_ext_class_locals_def",
-      "seop_ext_class_locals_imp",
-      "seop_ext_class_macros",
-      "seop_ext_class_testclasses",
-      "seop_incextapp_definition",
-      "seop_incextapp_implementation",
-      "seop_incextapp_macros",
-      "seop_incextapp_testclasses",
-      "seos_scotype_exception",
-      "seos_scotype_parameter",
-      "seox_true",
-      "sews_c_vif_version",
-      "skwfc_obtype_folder",
-      "skwfc_obtype_loio",
-      "so2_controller",
-      "icon_no_status",
-      "icon_package_standard",
-      "srext_ext_class_pool",
-      "srext_ext_interface_pool",
-      "ststc_c_type_dialog",
-      "ststc_c_type_object",
-      "ststc_c_type_parameters",
-      "ststc_c_type_report",
-      "swbm_c_op_delete_no_dialog",
-      "swbm_c_type_ddic_db_tabxinx",
-      "swbm_c_type_wdy_application",
-      "swbm_version_active",
-      "swbm_version_inactive",
-      "wbmr_c_skwf_folder_class",
-      "wdyn_limu_component_controller",
-      "wdyn_limu_component_definition",
-      "wdyn_limu_component_view"
-    ]
-  },
-  "rules": {
-    "begin_end_names": true,
-    "check_ddic": true,
-    "check_include": true,
-    "check_syntax": true,
-    "global_class": true,
-    "implement_methods": true,
-    "method_implemented_twice": true,
-    "parser_error": true,
-    "superclass_final": true,
-    "unknown_types": true,
-    "xml_consistency": true
-  }
+reg.setConfig(new src_1.Config(`
+{
+  "global": {
+    "files": "/src/**/*.*"
+  },
+  "dependencies": [],
+  "syntax": {
+    "version": "v702",
+    "errorNamespace": "^(Z|Y|LCL_|TY_|LIF_)",
+    "globalConstants": [
+      "abap_func_exporting",
+      "abap_func_tables",
+      "cssf_formtype_text",
+      "icon_abap",
+      "icon_adopt",
+      "icon_change",
+      "icon_create",
+      "icon_delete",
+      "icon_display_text",
+      "icon_folder",
+      "icon_led_green",
+      "icon_led_inactive",
+      "icon_led_red",
+      "icon_led_yellow",
+      "icon_message_information",
+      "icon_okay",
+      "icon_set_state",
+      "icon_stack",
+      "icon_system_help",
+      "icon_workflow_fork",
+      "seoc_category_exception",
+      "seoc_category_webdynpro_class",
+      "seoc_exposure_private",
+      "seoc_exposure_protected",
+      "seoc_exposure_public",
+      "seoc_state_implemented",
+      "seoc_version_active",
+      "seoc_version_deleted",
+      "seoc_version_inactive",
+      "seok_access_free",
+      "seok_access_modify",
+      "seox_false",
+      "seok_pgmid_r3tr",
+      "seoo_cmptype_type",
+      "seoo_cmptype_event",
+      "seoo_cmptype_method",
+      "seoo_cmptype_attribute",
+      "seop_ext_class_locals_def",
+      "seop_ext_class_locals_imp",
+      "seop_ext_class_macros",
+      "seop_ext_class_testclasses",
+      "seop_incextapp_definition",
+      "seop_incextapp_implementation",
+      "seop_incextapp_macros",
+      "seop_incextapp_testclasses",
+      "seos_scotype_exception",
+      "seos_scotype_parameter",
+      "seox_true",
+      "sews_c_vif_version",
+      "skwfc_obtype_folder",
+      "skwfc_obtype_loio",
+      "so2_controller",
+      "icon_no_status",
+      "icon_package_standard",
+      "srext_ext_class_pool",
+      "srext_ext_interface_pool",
+      "ststc_c_type_dialog",
+      "ststc_c_type_object",
+      "ststc_c_type_parameters",
+      "ststc_c_type_report",
+      "swbm_c_op_delete_no_dialog",
+      "swbm_c_type_ddic_db_tabxinx",
+      "swbm_c_type_wdy_application",
+      "swbm_version_active",
+      "swbm_version_inactive",
+      "wbmr_c_skwf_folder_class",
+      "wdyn_limu_component_controller",
+      "wdyn_limu_component_definition",
+      "wdyn_limu_component_view"
+    ]
+  },
+  "rules": {
+    "begin_end_names": true,
+    "check_ddic": true,
+    "check_include": true,
+    "check_syntax": true,
+    "global_class": true,
+    "implement_methods": true,
+    "method_implemented_twice": true,
+    "parser_error": true,
+    "superclass_final": true,
+    "unknown_types": true,
+    "xml_consistency": true
+  }
 }`));
 reg.parse();
 console.log("run syntax logic,");

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

@@ -84,13 +84,13 @@ class FlowGraph {
         this.label = label;
     }
     toDigraph() {
-        return `digraph G {
-labelloc="t";
-label="${this.label}";
-graph [fontname = "helvetica"];
-node [fontname = "helvetica", shape="box"];
-edge [fontname = "helvetica"];
-${this.toTextEdges()}
+        return `digraph G {
+labelloc="t";
+label="${this.label}";
+graph [fontname = "helvetica"];
+node [fontname = "helvetica", shape="box"];
+edge [fontname = "helvetica"];
+${this.toTextEdges()}
 }`;
     }
     listSources(node) {

package/build/src/lsp/help.js

@@ -19,13 +19,13 @@ class Help {
     /////////////////////////////////////////////////
     static dumpABAP(file, reg, textDocument, position) {
         let content = "";
-        content = `
-    <a href="#_tokens" rel="no-refresh">Tokens</a> |
-    <a href="#_statements" rel="no-refresh">Statements</a> |
-    <a href="#_structure" rel="no-refresh">Structure</a> |
-    <a href="#_files" rel="no-refresh">Files</a> |
-    <a href="#_info" rel="no-refresh">Info Dump</a>
-    <hr>
+        content = `
+    <a href="#_tokens" rel="no-refresh">Tokens</a> |
+    <a href="#_statements" rel="no-refresh">Statements</a> |
+    <a href="#_structure" rel="no-refresh">Structure</a> |
+    <a href="#_files" rel="no-refresh">Files</a> |
+    <a href="#_info" rel="no-refresh">Info Dump</a>
+    <hr>
     ` +
             "<tt>" + textDocument.uri + " (" +
             (position.line + 1) + ", " +

package/build/src/objects/transaction.js

@@ -6,15 +6,43 @@ class Transaction extends _abstract_object_1.AbstractObject {
     getType() {
         return "TRAN";
     }
+    setDirty() {
+        this.parsedXML = undefined;
+        super.setDirty();
+    }
     getAllowedNaming() {
         return {
             maxLength: 20,
             allowNamespace: true,
         };
     }
+    getProgramName() {
+        var _a;
+        this.parse();
+        return (_a = this.parsedXML) === null || _a === void 0 ? void 0 : _a.programName;
+    }
     getDescription() {
-        // todo
-        return undefined;
+        var _a;
+        this.parse();
+        return (_a = this.parsedXML) === null || _a === void 0 ? void 0 : _a.description;
+    }
+    parse() {
+        var _a, _b;
+        if (this.parsedXML) {
+            return { updated: false, runtime: 0 };
+        }
+        const start = Date.now();
+        this.parsedXML = {};
+        const parsed = super.parseRaw2();
+        if (parsed === undefined
+            || parsed.abapGit === undefined
+            || parsed.abapGit["asx:abap"]["asx:values"] === undefined) {
+            return { updated: false, runtime: 0 };
+        }
+        this.parsedXML.description = (_a = parsed.abapGit["asx:abap"]["asx:values"].TSTCT) === null || _a === void 0 ? void 0 : _a.TTEXT;
+        this.parsedXML.programName = (_b = parsed.abapGit["asx:abap"]["asx:values"].TSTC) === null || _b === void 0 ? void 0 : _b.PGMNA;
+        const end = Date.now();
+        return { updated: true, runtime: end - start };
     }
 }
 exports.Transaction = Transaction;

package/build/src/registry.js

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

package/build/src/rules/7bit_ascii.js

@@ -17,10 +17,10 @@ class SevenBitAscii {
             key: "7bit_ascii",
             title: "Check for 7bit ascii",
             shortDescription: `Only allow characters from the 7bit ASCII set.`,
-            extendedInformation: `https://docs.abapopenchecks.org/checks/05/
-
-https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
-
+            extendedInformation: `https://docs.abapopenchecks.org/checks/05/
+
+https://help.sap.com/doc/abapdocu_750_index_htm/7.50/en-US/abencharacter_set_guidl.htm
+
 Checkes files with extensions ".abap" and ".asddls"`,
             tags: [_irule_1.RuleTag.SingleFile],
             badExample: `WRITE '뽑'.`,

package/build/src/rules/abapdoc.js

@@ -28,10 +28,10 @@ class Abapdoc extends _abap_rule_1.ABAPRule {
             key: "abapdoc",
             title: "Check abapdoc",
             shortDescription: `Various checks regarding abapdoc.`,
-            extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
-
-Plus class and interface definitions.
-
+            extendedInformation: `Base rule checks for existence of abapdoc for public class methods and all interface methods.
+
+Plus class and interface definitions.
+
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#abap-doc-only-for-public-apis`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Styleguide],
         };

package/build/src/rules/align_parameters.js

@@ -22,49 +22,49 @@ class AlignParameters extends _abap_rule_1.ABAPRule {
             key: "align_parameters",
             title: "Align Parameters",
             shortDescription: `Checks for vertially aligned parameters`,
-            extendedInformation: `Checks:
-* function module calls
-* method calls
-* VALUE constructors
-* NEW constructors
-* RAISE EXCEPTION statements
-* CREATE OBJECT statements
-* RAISE EVENT statements
-
-https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
-
-Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
-
-If parameters are on the same row, no issues are reported, see
+            extendedInformation: `Checks:
+* function module calls
+* method calls
+* VALUE constructors
+* NEW constructors
+* RAISE EXCEPTION statements
+* CREATE OBJECT statements
+* RAISE EVENT statements
+
+https://github.com/SAP/styleguides/blob/master/clean-abap/CleanABAP.md#align-parameters
+
+Does not take effect on non functional method calls, use https://rules.abaplint.org/functional_writing/
+
+If parameters are on the same row, no issues are reported, see
 https://rules.abaplint.org/max_one_method_parameter_per_line/ for splitting parameters to lines`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Styleguide, _irule_1.RuleTag.Quickfix],
-            badExample: `CALL FUNCTION 'FOOBAR'
-  EXPORTING
-    foo = 2
-    parameter = 3.
-
-foobar( moo = 1
-  param = 1 ).
-
-foo = VALUE #(
-    foo = bar
+            badExample: `CALL FUNCTION 'FOOBAR'
+  EXPORTING
+    foo = 2
+    parameter = 3.
+
+foobar( moo = 1
+  param = 1 ).
+
+foo = VALUE #(
+    foo = bar
         moo = 2 ).`,
-            goodExample: `CALL FUNCTION 'FOOBAR'
-  EXPORTING
-    foo       = 2
-    parameter = 3.
-
-foobar( moo   = 1
-        param = 1 ).
-
-foo = VALUE #(
-    foo = bar
-    moo = 2 ).
-
-DATA(sdf) = VALUE type(
-  common_val     = 2
-  another_common = 5
-  ( row_value = 4
+            goodExample: `CALL FUNCTION 'FOOBAR'
+  EXPORTING
+    foo       = 2
+    parameter = 3.
+
+foobar( moo   = 1
+        param = 1 ).
+
+foo = VALUE #(
+    foo = bar
+    moo = 2 ).
+
+DATA(sdf) = VALUE type(
+  common_val     = 2
+  another_common = 5
+  ( row_value = 4
     value_foo = 5 ) ).`,
         };
     }

package/build/src/rules/align_type_expressions.js

@@ -30,37 +30,37 @@ class AlignTypeExpressions extends _abap_rule_1.ABAPRule {
             key: "align_type_expressions",
             title: "Align TYPE expressions",
             shortDescription: `Align TYPE expressions in statements`,
-            extendedInformation: `
-Currently works for METHODS + BEGIN OF
-
-If BEGIN OF has an INCLUDE TYPE its ignored
-
-Also note that clean ABAP does not recommend aligning TYPE clauses:
+            extendedInformation: `
+Currently works for METHODS + BEGIN OF
+
+If BEGIN OF has an INCLUDE TYPE its ignored
+
+Also note that clean ABAP does not recommend aligning TYPE clauses:
 https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#dont-align-type-clauses`,
             tags: [_irule_1.RuleTag.SingleFile, _irule_1.RuleTag.Whitespace, _irule_1.RuleTag.Quickfix],
-            badExample: `
-TYPES: BEGIN OF foo,
-         bar TYPE i,
-         foobar TYPE i,
-       END OF foo.
-
-INTERFACE lif.
-  METHODS bar
-    IMPORTING
-      foo TYPE i
-      foobar TYPE i.
+            badExample: `
+TYPES: BEGIN OF foo,
+         bar TYPE i,
+         foobar TYPE i,
+       END OF foo.
+
+INTERFACE lif.
+  METHODS bar
+    IMPORTING
+      foo TYPE i
+      foobar TYPE i.
 ENDINTERFACE.`,
-            goodExample: `
-TYPES: BEGIN OF foo,
-         bar    TYPE i,
-         foobar TYPE i,
-       END OF foo.
-
-INTERFACE lif.
-  METHODS bar
-    IMPORTING
-      foo    TYPE i
-      foobar TYPE i.
+            goodExample: `
+TYPES: BEGIN OF foo,
+         bar    TYPE i,
+         foobar TYPE i,
+       END OF foo.
+
+INTERFACE lif.
+  METHODS bar
+    IMPORTING
+      foo    TYPE i
+      foobar TYPE i.
 ENDINTERFACE.`,
         };
     }