@abaplint/cli 2.120.50 → 2.120.52

package/build/cli.js

@@ -53,6 +53,13 @@ const BUFS = new Set([
     CH_DOT, CH_COMMA, CH_COLON, 40 /* ( */, 41 /* ) */, 91 /* [ */,
     93 /* ] */, 43 /* + */, CH_AT
 ]);
+// characters that may follow the closing "'", "`" or "|" of a literal, anything else
+// is a syntax error, "There must be a space or equivalent character after ...",
+// note that "(" is allowed, ie. text elements like 'text'(001)
+const AFTER_LITERAL = new Set([
+    EOF, CH_SPACE, CH_TAB, CH_NL, CH_DOT, CH_COMMA, CH_COLON, CH_DQUOTE,
+    40 /* ( */, 41 /* ) */, 91 /* [ */, 93 /* ] */
+]);
 class Lexer {
     run(file, virtual) {
         this.virtual = virtual;
@@ -332,7 +339,11 @@ class Lexer {
                 && ahead !== CH_BACKTICK
                 && this.buffer.countIsEven(CH_BACKTICK)) {
                 // end of ping
-                this.add();
+                if (AFTER_LITERAL.has(ahead)) {
+                    this.add();
+                }
+                // else: no separator after the literal, keep the buffer so the following
+                // characters are glued onto the token, the parser will report the error
                 if (ahead === CH_DQUOTE) {
                     this.m = ModeComment;
                 }
@@ -345,7 +356,9 @@ class Lexer {
                 && (current === CH_PIPE || current === CH_LBRACE)
                 && (stream.prevChar() !== CH_BACKSLASH || (stream.prevPrevChar() === CH_BACKSLASH && stream.prevChar() === CH_BACKSLASH))) {
                 // end of template
-                this.add();
+                if (current === CH_LBRACE || AFTER_LITERAL.has(ahead)) {
+                    this.add();
+                }
                 this.m = ModeNormal;
             }
             else if (this.m === ModeTemplate
@@ -360,7 +373,9 @@ class Lexer {
                 && ahead !== CH_QUOTE
                 && this.buffer.countIsEven(CH_QUOTE)) {
                 // end of string
-                this.add();
+                if (AFTER_LITERAL.has(ahead)) {
+                    this.add();
+                }
                 if (ahead === CH_DQUOTE) {
                     this.m = ModeComment;
                 }
@@ -27714,6 +27729,20 @@ class TypeUtils {
             || node.findFirstExpression(Expressions.ArithOperator) !== undefined;
         return calculated;
     }
+    // a character constant is only assignable to a hexadecimal target if it can be
+    // interpreted as a hexadecimal value
+    isHexConstant(node) {
+        const constant = node === null || node === void 0 ? void 0 : node.concatTokens();
+        if (constant === undefined) {
+            return true;
+        }
+        if ((constant.startsWith("'") && constant.endsWith("'"))
+            || (constant.startsWith("`") && constant.endsWith("`"))) {
+            const value = constant.substring(1, constant.length - 1);
+            return value.length > 0 && /^[0-9A-Fa-f]+$/.test(value);
+        }
+        return true;
+    }
     isAssignableNew(source, target, node) {
         const calculated = (node === null || node === void 0 ? void 0 : node.findFirstExpression(Expressions.ArithOperator)) !== undefined;
         if (calculated && source instanceof basic_1.HexType && target instanceof basic_1.IntegerType) {
@@ -27779,7 +27808,7 @@ class TypeUtils {
             }
             else if (target instanceof basic_1.XStringType) {
                 if (((_d = source.getAbstractTypeData()) === null || _d === void 0 ? void 0 : _d.derivedFromConstant) === true) {
-                    return (node === null || node === void 0 ? void 0 : node.concatTokens()) !== "''";
+                    return this.isHexConstant(node);
                 }
                 return false;
             }
@@ -34711,6 +34740,7 @@ class Source {
                             return basic_1.VoidType.get(_syntax_input_1.CheckSyntaxKey);
                         }
                         this.addIfInferred(node, input, foundType);
+                        this.traverseRemainingChildren(children, input);
                         return foundType;
                     }
                 case "REF":
@@ -70549,7 +70579,7 @@ class Registry {
     }
     static abaplintVersion() {
         // magic, see build script "version.js"
-        return "2.120.50";
+        return "2.120.52";
     }
     getDDICReferences() {
         return this.ddicReferences;
@@ -78686,15 +78716,19 @@ ${indentation}${uniqueName} = ${source.concatTokens()}.\n${indentation}`);
                 continue;
             }
             const condition = this.tableCondition(tableExpression);
-            const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
+            // ASSIGNING, not INTO: from v740 a table expression in a read position addresses the
+            // row rather than copying it, so "REF #( tab[ i ]-comp )" and "ASSIGN tab[ i ]-comp"
+            // hand back an address INTO a work area would not preserve. The write path
+            // (moveWithTableTarget) already lowers to ASSIGNING for the same reason.
+            const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax, true);
             const tabixBackup = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
             const indentation = " ".repeat(high.getFirstToken().getStart().getCol() - 1);
             const firstToken = high.getFirstToken();
             // note that the tabix restore should be done before throwing the exception
-            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `DATA ${uniqueName} LIKE LINE OF ${pre}.
+            const fix1 = edit_helper_1.EditHelper.insertAt(lowFile, firstToken.getStart(), `FIELD-SYMBOLS ${uniqueName} LIKE LINE OF ${pre}.
 ${indentation}DATA ${tabixBackup} LIKE sy-tabix.
 ${indentation}${tabixBackup} = sy-tabix.
-${indentation}READ TABLE ${pre} ${condition}INTO ${uniqueName}.
+${indentation}READ TABLE ${pre} ${condition}ASSIGNING ${uniqueName}.
 ${indentation}sy-tabix = ${tabixBackup}.
 ${indentation}IF sy-subrc <> 0.
 ${indentation}  RAISE EXCEPTION TYPE cx_sy_itab_line_not_found.
@@ -79448,8 +79482,7 @@ CONSTANTS: BEGIN OF ${structureName},\n`;
         if (index === undefined) {
             return undefined;
         }
-        let uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
-        uniqueName = `<${uniqueName}>`;
+        const uniqueName = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax, true);
         const tName = target.concatTokens().split("[")[0];
         const condition = this.tableCondition(tableExpression);
         const tabixBackup = this.uniqueName(high.getFirstToken().getStart(), lowFile.getFilename(), highSyntax);
@@ -80461,12 +80494,16 @@ ${indentation}    output = ${uniqueName}.\n`;
         }
         return undefined;
     }
-    uniqueName(position, filename, highSyntax) {
+    /** a FIELD-SYMBOLS declaration is known to the scope under its bracketed spelling, so
+     * the collision check has to use that spelling too - otherwise a second outline in the
+     * same method is handed a name that is already taken and the result does not compile */
+    uniqueName(position, filename, highSyntax, fieldSymbol = false) {
+        const decorate = (name) => fieldSymbol === true ? `<${name}>` : name;
         const spag = highSyntax.spaghetti.lookupPosition(position, filename);
         if (spag === undefined) {
             const name = "temprr" + this.counter;
             this.counter++;
-            return name;
+            return decorate(name);
         }
         let postfix = "";
         if (spag.getIdentifier().stype === _scope_type_1.ScopeType.ClassDefinition) {
@@ -80475,7 +80512,7 @@ ${indentation}    output = ${uniqueName}.\n`;
             postfix = "_" + hash.substring(0, 10);
         }
         while (true) {
-            const name = "temp" + this.counter + postfix;
+            const name = decorate("temp" + this.counter + postfix);
             const exists = this.existsRecursive(spag, name);
             this.counter++;
             if (exists === false) {
@@ -84957,6 +84994,7 @@ __exportStar(__webpack_require__(/*! ./use_line_exists */ "../core/build/src/rul
 __exportStar(__webpack_require__(/*! ./use_new */ "../core/build/src/rules/use_new.js"), exports);
 __exportStar(__webpack_require__(/*! ./when_others_last */ "../core/build/src/rules/when_others_last.js"), exports);
 __exportStar(__webpack_require__(/*! ./whitespace_end */ "../core/build/src/rules/whitespace_end.js"), exports);
+__exportStar(__webpack_require__(/*! ./wrong_abapdoc_position */ "../core/build/src/rules/wrong_abapdoc_position.js"), exports);
 __exportStar(__webpack_require__(/*! ./xml_consistency */ "../core/build/src/rules/xml_consistency.js"), exports);
 __exportStar(__webpack_require__(/*! ./no_exclamation_escape */ "../core/build/src/rules/no_exclamation_escape.js"), exports);
 __exportStar(__webpack_require__(/*! ./xml_bom */ "../core/build/src/rules/xml_bom.js"), exports);
@@ -100439,6 +100477,178 @@ exports.WhitespaceEnd = WhitespaceEnd;
 
 /***/ },
 
+/***/ "../core/build/src/rules/wrong_abapdoc_position.js"
+/*!*********************************************************!*\
+  !*** ../core/build/src/rules/wrong_abapdoc_position.js ***!
+  \*********************************************************/
+(__unused_webpack_module, exports, __webpack_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.WrongAbapdocPosition = exports.WrongAbapdocPositionConf = void 0;
+const Statements = __importStar(__webpack_require__(/*! ../abap/2_statements/statements */ "../core/build/src/abap/2_statements/statements/index.js"));
+const issue_1 = __webpack_require__(/*! ../issue */ "../core/build/src/issue.js");
+const _abap_rule_1 = __webpack_require__(/*! ./_abap_rule */ "../core/build/src/rules/_abap_rule.js");
+const _basic_rule_config_1 = __webpack_require__(/*! ./_basic_rule_config */ "../core/build/src/rules/_basic_rule_config.js");
+const _irule_1 = __webpack_require__(/*! ./_irule */ "../core/build/src/rules/_irule.js");
+const _statement_1 = __webpack_require__(/*! ../abap/2_statements/statements/_statement */ "../core/build/src/abap/2_statements/statements/_statement.js");
+class WrongAbapdocPositionConf extends _basic_rule_config_1.BasicRuleConfig {
+}
+exports.WrongAbapdocPositionConf = WrongAbapdocPositionConf;
+class WrongAbapdocPosition extends _abap_rule_1.ABAPRule {
+    constructor() {
+        super(...arguments);
+        this.conf = new WrongAbapdocPositionConf();
+    }
+    getMetadata() {
+        return {
+            key: "wrong_abapdoc_position",
+            title: "Wrong ABAP Doc position",
+            shortDescription: `ABAP Doc must be placed directly in front of the declaration it documents.`,
+            extendedInformation: `ABAP Doc documents the single declaration following it, an ABAP Doc block placed
+elsewhere is silently ignored, leaving the declaration undocumented.
+
+The following positions are reported,
+* in front of a chained keyword, ie. before "CONSTANTS:" instead of after the colon,
+* in the middle of a statement, ie. between the parameters of a METHODS definition,
+* directly in front of ENDCLASS, ENDINTERFACE or a SECTION statement.
+
+Only checks ABAP Doc inside class definitions and interfaces.`,
+            tags: [_irule_1.RuleTag.SingleFile],
+            badExample: `CLASS zcl_foo DEFINITION PUBLIC.
+  PUBLIC SECTION.
+    "! Navigation modes
+    CONSTANTS:
+      BEGIN OF cs_nav_mode,
+        back TYPE i VALUE 1,
+      END OF cs_nav_mode.
+ENDCLASS.`,
+            goodExample: `CLASS zcl_foo DEFINITION PUBLIC.
+  PUBLIC SECTION.
+    CONSTANTS:
+      "! Navigation modes
+      BEGIN OF cs_nav_mode,
+        back TYPE i VALUE 1,
+      END OF cs_nav_mode.
+ENDCLASS.`,
+        };
+    }
+    getConfig() {
+        return this.conf;
+    }
+    setConfig(conf) {
+        this.conf = conf;
+    }
+    runParsed(file) {
+        const issues = [];
+        const statements = file.getStatements();
+        let definition = false;
+        for (let i = 0; i < statements.length; i++) {
+            const statement = statements[i];
+            const type = statement.get();
+            if (type instanceof Statements.ClassDefinition || type instanceof Statements.Interface) {
+                definition = true;
+                continue;
+            }
+            else if (type instanceof Statements.EndClass || type instanceof Statements.EndInterface) {
+                definition = false;
+                continue;
+            }
+            else if (definition === false || this.isAbapdoc(statement) === false) {
+                continue;
+            }
+            else if (this.isAbapdoc(statements[i - 1]) === true
+                && statements[i - 1].getStart().getRow() + 1 === statement.getStart().getRow()) {
+                continue; // only report the first row of each block
+            }
+            let next = undefined;
+            for (let j = i + 1; j < statements.length; j++) {
+                if (statements[j].get() instanceof _statement_1.Comment) {
+                    continue;
+                }
+                next = statements[j];
+                break;
+            }
+            if (next === undefined) {
+                continue;
+            }
+            const message = this.check(statement, next);
+            if (message !== undefined) {
+                issues.push(issue_1.Issue.atStatement(file, statement, message, this.getMetadata().key, this.conf.severity));
+            }
+        }
+        return issues;
+    }
+    isAbapdoc(statement) {
+        return (statement === null || statement === void 0 ? void 0 : statement.get()) instanceof _statement_1.Comment
+            && statement.getFirstToken().getStr().startsWith(`"!`);
+    }
+    check(abapdoc, next) {
+        const type = next.get();
+        if (type instanceof Statements.EndClass
+            || type instanceof Statements.EndInterface
+            || type instanceof Statements.Public
+            || type instanceof Statements.Protected
+            || type instanceof Statements.Private) {
+            return "ABAP Doc does not document anything, move or delete it";
+        }
+        const position = abapdoc.getStart();
+        const colon = next.getColon();
+        if (colon === undefined) {
+            if (position.isAfter(next.getStart()) === true) {
+                return "ABAP Doc inside statement, move it in front of the statement";
+            }
+            return undefined;
+        }
+        if (position.isBefore(colon.getStart()) === true) {
+            return "ABAP Doc in front of chained statement, move it after the colon";
+        }
+        const member = next.getTokens().find(t => t.getStart().isAfter(colon.getStart()));
+        if (member !== undefined && position.isAfter(member.getStart()) === true) {
+            return "ABAP Doc inside statement, move it in front of the chained declaration";
+        }
+        return undefined;
+    }
+}
+exports.WrongAbapdocPosition = WrongAbapdocPosition;
+//# sourceMappingURL=wrong_abapdoc_position.js.map
+
+/***/ },
+
 /***/ "../core/build/src/rules/xml_bom.js"
 /*!******************************************!*\
   !*** ../core/build/src/rules/xml_bom.js ***!

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@abaplint/cli",
-    "version": "2.120.50",
+    "version": "2.120.52",
     "description": "abaplint - Command Line Interface",
     "funding": "https://github.com/sponsors/larshp",
     "bin": {
@@ -39,7 +39,7 @@
     },
     "homepage": "https://abaplint.org",
     "devDependencies": {
-        "@abaplint/core": "^2.120.50",
+        "@abaplint/core": "^2.120.52",
         "@types/chai": "^4.3.20",
         "@types/minimist": "^1.2.5",
         "@types/mocha": "^10.0.10",