abl-tmlanguage 1.3.16 → 1.3.18

package/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '24.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Running tests
+        run: |
+          npm install
+          npm run test
+
+      - name: Publish to npm
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        run: npm publish

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+1.3.18
+======
+
+- ✨ Refactoring of preprocessor and string scopes (#65)
+
+1.3.17
+======
+
+- ✨ Scientific notation (#64)
+
 1.3.16
 ======
 

package/README.md

@@ -58,25 +58,25 @@ This project uses the [vscode-textmate](https://www.npmjs.com/package/vscode-tex
 ## Keywords
 Part of this grammar is generated from a keyword list file. See [index.js] for information on how to generate that file, as well as the others required for the generation.
 
-When `npm run build` is executed, a file called grammer.json is created, which contains properties for `keywords` (all the keywords), `abl-functions` and `handle-attributes` (attributes and method calls on ABL handles). The contents of this file should be copied into the `abl.tmLanguage.json` file, replacing the existing contents.
+When `npm run build` is executed, a file called grammar.json is created, which contains properties for `keywords` (all the keywords), `abl-functions` and `handle-attributes` (attributes and method calls on ABL handles). The contents of this file should be copied into the `abl.tmLanguage.json` file, replacing the existing contents.
 
 
 
 # Scopes
 
-The ABL-specific scopes produced by the ABL grammer listed in the table below. The scope names are largely based on the naming conventions at https://macromates.com/manual/en/language_grammars#language_rules and https://www.sublimetext.com/docs/scope_naming.html .
+The ABL-specific scopes produced by the ABL grammar listed in the table below. The scope names are largely based on the naming conventions at https://macromates.com/manual/en/language_grammars#language_rules and https://www.sublimetext.com/docs/scope_naming.html .
 
 | Scope Name | Used for/by |
 | ------------- | ------------- |
 |comment.block.source.abl                         | Everything between `/*` and `*/` |
-|comment.line.double-slash.abl                    | Everything in a `//` comment, incl slashes |
+|comment.line.double-slash.abl                    | Everything in a `//` comment, incl. slashes |
 |comment.preprocessor.analyze-suspend.abl         | `&analyze-suspend`, `&analyze-resume` |
 |constant.character.escape.abl                    |  `~` and the next char |
 |constant.language.abl                            | `today`, `now`, `true`, `false`, `yes`, `no`, `?` (unknown value) |
 |constant.language.source.abl                     | `99/99/9999` (or similar) when used as a format clause |
-|constant.numeric.source.abl                      | 0x00-0xFF, 0-9 |
+|constant.numeric.source.abl                      | 0x00-0xFF, 0-9, scientific notation |
 |entity.name.function.abl                         | Method call, property call, method name, property name, handle attributes, handle methods, event names |
-|entity.name.function.preprocessor.abl            | `&scoped-define`, `&global-define` |
+|entity.name.function.preprocessor.abl            | Preprocessor names, including built-ins like `opsys` and `process-architecture` |
 |entity.name.include.abl                          | Include file names |
 |entity.name.label.abl                            | Block label names |
 |entity.name.package.abl                          | Package names for `using` |
@@ -85,16 +85,20 @@ The ABL-specific scopes produced by the ABL grammer listed in the table below. T
 |entity.name.type.abl                             | Class/interface/enum names |
 |entity.name.type.generic.abl                     | Generic type names |
 |entity.other.attribute-name.abl                  | Annotation attribute names |
+|keyword.control.directive.conditional.abl        | `&if` , `&else`, `&elsif` `&end` |
+|keyword.control.directive.define.abl             | `&scoped-define`, `&global-define`, `&undefine` |
 |keyword.operator.source.abl                      | `contains`, `begins`, `matches`, `eq`, `le`, `lt`, `ge`, `gt`, `ne`, `<=`, `<>`, `>=`, `=`, `+`, `-`, `/`, `<`, `>`, `*`, `+=`, `-=`, `/=`, `*=` |
 |keyword.other.abl                                | Any ABL keyword (incl those covered by other scopes like `support.function.abl` and `entity.name.function.abl`) |
 |punctuation.definition.bracket.square.begin.abl  |  `[` used for array arguments |
 |punctuation.definition.bracket.square.end.abl    |  `]` used for array arguments |
 |punctuation.definition.generic.begin.abl         |  `<` used for generic type arguments |
 |punctuation.definition.generic.end.abl           |  `>` used for generic type arguments |
+|punctuation.definition.preprocessor.abl          | Leading `&` of referenced preprocessor and directives |
 |punctuation.definition.string.begin.abl          | Start of a quoted string |
 |punctuation.definition.string.end.abl            | End of a quoted string |
 |punctuation.section.abl                          | `{` and `}` |
 |punctuation.separator.comma.abl                  | `,` |
+|punctuation.separator.continuation               |  `~` at the end of a line (preprocessor) |
 |punctuation.separator.period.abl                 | `.` |
 |punctuation.separator.colon.abl                  | `:` |
 |punctuation.terminator.abl                       | `.` and `:` |
@@ -103,12 +107,12 @@ The ABL-specific scopes produced by the ABL grammer listed in the table below. T
 |storage.data.table.abl                           | (Temp-)Table names, field names, index names |
 |storage.other.opsys-device.abl                   | Files and other operating system devices |
 |storage.type.abl                                 | Primitive datatypes |
-|storage.type.function.abl                        | ABL preprocessors, `defined` keyword |
-|string.double.complex.abl                        | String in `"` quotes |
-|string.single.complex.abl                        | String in `'` quotes |
+|storage.type.function.abl                        |  `defined` keyword and preprocessor directives like `&message` |
+|string.quoted.double.abl                         | String in `"` quotes |
+|string.quoted.single.abl                         | String in `'` quotes |
 |support.function.abl                             | `opsys`, `proversion`, ABL functions (eg `base64-encode`) |
 |support.other.abl                                | Translation attributes `:L`, `:R`, `:T`, `:C`, `:U` |
-|support.other.argument.abl                       | `&<name\|number>` arguments in includes, preprocessor values |
+|support.other.argument.abl                       | `&<name\|number>` arguments in includes |
 |variable.language.abl                            | ABL system handles (eg `session` or `this-object`) |
 |variable.other.abl                               | Variable names |
 |variable.parameter.abl                           | Parameter names in method, function, procedure definition |
@@ -116,6 +120,7 @@ The ABL-specific scopes produced by the ABL grammer listed in the table below. T
 There are also a number of 'meta' scopes that usually cover multiple other scopes.
 | Scope Name | Used for/by |
 | ------------- | ------------- |
+|meta.argument.abl                | Unnamed arguments like `{1}` |
 |meta.array.literal.abl           | Literal values in an array |
 |meta.block.abl                   | A block statement like `do`, `repeat` and ` finally |
 |meta.brace.round.js              | `(` and `)`  |
@@ -125,7 +130,7 @@ There are also a number of 'meta' scopes that usually cover multiple other scope
 |meta.define.enum.abl             | An enum definition, from the `enum` keyword to its closing `:`  |
 |meta.define.function.abl         | A user-defined function definition, from the `function` keyword to its closing `:`  |
 |meta.define.interface.abl        | An interface definition, from the `interface` keyword to its closing `:`  |
-|meta.define.method.abl           | A method, constructor or destructor definition, from the `method`keyword to the ending `:` or `.` Includes parameter definions, if any.  |
+|meta.define.method.abl           | A method, constructor or destructor definition, from the `method`keyword to the ending `:` or `.` Includes parameter definitions, if any.  |
 |meta.define.parameter.abl        | An individual parameter definition  |
 |meta.define.stream.abl           | A stream definition  |
 |meta.define-type.implements.abl  | The type names that a type implements and/or inherits  |
@@ -135,9 +140,9 @@ There are also a number of 'meta' scopes that usually cover multiple other scope
 |meta.generic.abl                 | Generic type names  |
 |meta.include.abl                 | Include file references, from `{` to `}`  |
 |meta.include.argument.abl        | Include argument references like `&arg` and `&arg=` |
-|meta.preprocessor.define.abl     | Preprocessor definitions for `&global-define` and `&scoped-define`  |
+|meta.preprocessor.abl            | Preprocessor definitions, functions and usage |
 |meta.procedure.abl               | An internal procedure definition, from the `procedure` keyword to its closing `:` or `.`  |
-|meta.statements.abl              | All ABL statmements |
+|meta.statements.abl              | All ABL statements |
 |meta.using.abl                   | A `using` definition |
 
 ## Checking scopes

package/abl.tmLanguage.json

@@ -58,7 +58,7 @@
     "procedure-definition": {
       "name": "meta.procedure.abl",
       "comment": "Look ahead to the procedure name, quoted or not. It will be resolved in the patterns. 'Names must begin with a letter.' from https://docs.progress.com/bundle/openedge-abl-manage-applications/page/Name-limits.html",
-      "begin": "(?i)\\b(proce(?:dure|dur|du|d)?)\\s+(?=[a-zA-Z_])",
+      "begin": "(?i)\\s*(proce(?:dure|dur|du|d)?)\\s+(?=[a-zA-Z_])",
       "beginCaptures": {
         "1": {
           "name": "keyword.other.abl"
@@ -94,6 +94,9 @@
         {
           "include": "#argument-reference"
         },
+        {
+          "include": "#preprocessor-reference"
+        },
         {
           "include": "#numeric"
         },
@@ -479,6 +482,12 @@
         {
           "include": "#buffer-copy"
         },
+        {
+          "include": "#preprocessors"
+        },
+        {
+          "include": "#argument-reference"
+        },
         {
           "include": "#trigger-procedure"
         },
@@ -637,12 +646,6 @@
         {
           "include": "#operator"
         },
-        {
-          "include": "#analyze-suspend-resume"
-        },
-        {
-          "include": "#global-scoped-define"
-        },
         {
           "include": "#label-variable"
         },
@@ -656,7 +659,7 @@
           "include": "#format-constant"
         },
         {
-          "include": "#preprocessors"
+          "include": "#escape-endline"
         },
         {
           "include": "#dll-type"
@@ -746,16 +749,95 @@
         }
       }
     },
+    "preprocessor-directives": {
+      "patterns": [
+        {
+          "match": "(?i)((&)(elseif|endif|else|then|if))\\s*",
+          "captures": {
+            "2": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "3": {
+              "name": "keyword.control.directive.conditional.abl"
+            }
+          }
+        },
+        {
+          "match": "(?i)((&)(message))\\s*",
+          "captures": {
+            "2": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "3": {
+              "name": "storage.type.function.abl"
+            }
+          }
+        }
+      ]
+    },
+    "preprocessor-reference": {
+      "patterns": [
+        {
+          "comment": "https://docs.progress.com/bundle/abl-reference/page/Preprocessor-name-reference.html#Preprocessor-name-reference",
+          "match": "(?i)\\s*(({)(&)(window-system|line-number|batch-mode|file-name|sequence|opsys|process-architecture)\\s*(}))",
+          "captures": {
+            "1": {
+              "name": "meta.preprocessor.abl"
+            },
+            "2": {
+              "name": "punctuation.section.abl"
+            },
+            "3": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "4": {
+              "name": "entity.name.function.preprocessor.abl"
+            },
+            "5": {
+              "name": "punctuation.section.abl"
+            }
+          }
+        },
+        {
+          "match": "\\s*(({)(&)([a-zA-Z0-9_\\-#$%\\s\\(\\)]+)\\s*(}))",
+          "captures": {
+            "1": {
+              "name": "meta.preprocessor.abl"
+            },
+            "2": {
+              "name": "punctuation.section.abl"
+            },
+            "3": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "4": {
+              "name": "entity.name.function.preprocessor.abl"
+            },
+            "5": {
+              "name": "punctuation.section.abl"
+            }
+          }
+        }
+      ]
+    },
     "preprocessors": {
-      "match": "(?i)(&window-system|&text-height|&line-number|&batch-mode|&file-name|&undefine|&sequence|&message|defined|&elseif|(?:&scop(?:ed-define|ed-defin|ed-defi|ed-def|ed-de|ed-d|ed-|ed|e)?)|(?:&glob(?:al-define|al-defin|al-defi|al-def|al-de|al-d|al-|al|a)?)|&opsys|&endif|&else|&then|&if)|({&[a-zA-Z0-9_\\-#$%\\s\\(\\)]+})|(&[a-zA-Z0-9_\\-#$%]+)",
-      "captures": {
-        "1": {
-          "name": "storage.type.function.abl"
+      "patterns": [
+        {
+          "include": "#analyze-suspend-resume"
         },
-        "2": {
-          "name": "storage.type.function.abl"
+        {
+          "include": "#global-scoped-define"
+        },
+        {
+          "include": "#preprocessor-directives"
+        },
+        {
+          "include": "#preprocessor-functions"
+        },
+        {
+          "include": "#preprocessor-reference"
         }
-      }
+      ]
     },
     "type-names": {
       "patterns": [
@@ -2852,6 +2934,28 @@
         {
           "include": "#for-record"
         },
+        {
+          "match": "(?i)\\b((transact(?:ion|io|i)?)|stop-after)\\b",
+          "name": "keyword.other.abl"
+        },
+        {
+          "include": "#numeric"
+        },
+        {
+          "include": "#type-member-call"
+        },
+        {
+          "include": "#language-functions"
+        },
+        {
+          "include": "#abl-functions"
+        },
+        {
+          "include": "#punctuation-comma"
+        },
+        {
+          "include": "#punctuation-colon"
+        },
         {
           "include": "#branch-options"
         }
@@ -3085,7 +3189,7 @@
           "name": "punctuation.definition.string.begin.abl"
         }
       },
-      "name": "string.single.complex.abl",
+      "name": "string.quoted.single.abl",
       "end": "(')",
       "endCaptures": {
         "1": {
@@ -3102,6 +3206,14 @@
       "match": "~.",
       "name": "constant.character.escape.abl"
     },
+    "escape-endline": {
+      "match": "(~)\\s*$",
+      "captures": {
+        "1": {
+          "name": "punctuation.separator.continuation"
+        }
+      }
+    },
     "branch-return-value-double": {
       "comment": "RETURN \"return-value\"",
       "begin": "(?i)\\s*(return)(\\s+(error))?\\s+(\")",
@@ -3280,77 +3392,119 @@
       "name": "comment.preprocessor.analyze-suspend.abl"
     },
     "global-scoped-define": {
-      "begin": "(?i)((?:&scop(?:ed-define|ed-defin|ed-defi|ed-def|ed-de|ed-d|ed-|ed|e)?)|(?:&glob(?:al-define|al-defin|al-defi|al-def|al-de|al-d|al-|al|a)?))\\s*([\\.a-zA-Z0-9_\\-#$%\\\\/]*)\\s*",
-      "beginCaptures": {
-        "1": {
-          "name": "keyword.other.abl"
-        },
-        "2": {
-          "name": "entity.name.function.preprocessor.abl"
-        }
-      },
-      "end": "(?=//|/\\*)|$",
-      "name": "meta.preprocessor.define.abl",
       "patterns": [
         {
-          "include": "#string"
+          "begin": "(?i)^\\s*((&)(scop(?:ed-define|ed-defin|ed-defi|ed-def|ed-de|ed-d|ed-|ed|e)?))\\s*",
+          "name": "meta.preprocessor.abl",
+          "beginCaptures": {
+            "2": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "3": {
+              "name": "keyword.control.directive.define.abl"
+            },
+            "4": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "end": "([\\.a-zA-Z0-9_\\-#$%\\/]+)\\s*",
+          "endCaptures": {
+            "1": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "patterns": [
+            {
+              "include": "#escape-endline"
+            }
+          ]
+        },
+        {
+          "begin": "(?i)^\\s*((&)(glob(?:al-define|al-defin|al-defi|al-def|al-de|al-d|al-|al|a)?))\\s*",
+          "name": "meta.preprocessor.abl",
+          "beginCaptures": {
+            "2": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "3": {
+              "name": "keyword.control.directive.define.abl"
+            },
+            "4": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "end": "([\\.a-zA-Z0-9_\\-#$%\\/]+)\\s*",
+          "endCaptures": {
+            "1": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "patterns": [
+            {
+              "include": "#escape-endline"
+            }
+          ]
+        },
+        {
+          "begin": "(?i)((&)(undef(?:ine|in|i)?))\\s*([\\.a-zA-Z0-9_\\-#$%\\/]*)\\s*",
+          "name": "meta.preprocessor.abl",
+          "beginCaptures": {
+            "2": {
+              "name": "punctuation.definition.preprocessor.abl"
+            },
+            "3": {
+              "name": "keyword.control.directive.define.abl"
+            },
+            "4": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "end": "([\\.a-zA-Z0-9_\\-#$%\\/]+)\\s*",
+          "endCaptures": {
+            "1": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          },
+          "patterns": [
+            {
+              "include": "#escape-char"
+            }
+          ]
         }
       ]
     },
-    "X-if-then": {
-      "begin": "(?i)\\b(if)\\b",
+    "preprocessor-functions": {
+      "begin": "\\s*([Dd][Ee][Ff][Ii][Nn][Ee][Dd])\\b",
       "beginCaptures": {
         "1": {
-          "name": "keyword.other.abl"
+          "name": "storage.type.function.abl"
         }
       },
       "patterns": [
-        {
-          "match": "(?i)\\b(and|or)\\b",
-          "captures": {
-            "1": {
-              "name": "keyword.other.abl"
-            }
-          }
-        },
         {
           "include": "#parens"
         },
-        {
-          "include": "#function-arguments"
-        },
-        {
-          "include": "#type-member-call"
-        },
-        {
-          "include": "#db-dot-table-dot-field"
-        },
         {
           "include": "#comment"
         },
         {
-          "include": "#operator"
-        },
-        {
-          "include": "#code-block"
-        },
-        {
-          "include": "#handle-attributes"
-        },
-        {
-          "include": "#preprocessors"
-        },
-        {
-          "include": "#abl-system-handles"
-        },
-        {
-          "include": "#keywords"
+          "match": "([a-zA-Z0-9_\\-#$%]+)",
+          "captures": {
+            "1": {
+              "name": "entity.name.function.preprocessor.abl"
+            }
+          }
         }
       ],
-      "end": "(?i)\\b(?=then)\\b"
+      "end": "(\\))",
+      "endCaptures": {
+        "1": {
+          "name": "meta.brace.round.js"
+        }
+      }
     },
     "if-then": {
-      "begin": "(?i)\\b(if)\\b",
+      "begin": "\\b([Ii][Ff])\\b",
       "beginCaptures": {
         "1": {
           "name": "keyword.other.abl"
@@ -3361,7 +3515,7 @@
           "include": "#logical-expression"
         }
       ],
-      "end": "(?i)\\b(?=then)\\b"
+      "end": "\\b(?=[Tt][Hh][Ee][Nn])\\b"
     },
     "logical-expression": {
       "patterns": [
@@ -3711,6 +3865,9 @@
         {
           "include": "#string"
         },
+        {
+          "include": "#preprocessor-reference"
+        },
         {
           "include": "#argument-reference"
         },
@@ -3751,6 +3908,9 @@
         }
       },
       "patterns": [
+        {
+          "include": "#preprocessor-reference"
+        },
         {
           "include": "#argument-reference"
         },
@@ -3788,6 +3948,9 @@
             }
           }
         },
+        {
+          "include": "#preprocessor-reference"
+        },
         {
           "comment": "Argument references can be passed into includes as arguments",
           "include": "#argument-reference"
@@ -3798,11 +3961,20 @@
       ]
     },
     "argument-reference": {
-      "comment": "https://docs.progress.com/bundle/abl-reference/page/Argument-reference.html",
-      "match": "\\s*((\\{\\s*&[\\.a-zA-Z0-9_\\-#$%\\\/]+\\})|(\\{\\s*\\d+\\})|(\\{\\s*\\*\\}))\\s*",
+      "comment": "ONly unnamed arguments are captured here. Names arguments are treated as preprocessors, since its impossible to tell them apart https://docs.progress.com/bundle/abl-reference/page/Argument-reference.html",
+      "match": "\\s*(({)([0-9]+|\\*\\s*)(}))\\s*",
       "captures": {
         "1": {
+          "name": "meta.argument.abl"
+        },
+        "2": {
+          "name": "punctuation.section.abl"
+        },
+        "3": {
           "name": "support.other.argument.abl"
+        },
+        "4": {
+          "name": "punctuation.section.abl"
         }
       }
     },
@@ -3862,7 +4034,7 @@
           "name": "support.other.abl"
         }
       },
-      "name": "string.single.complex.abl",
+      "name": "string.quoted.single.abl",
       "patterns": [
         {
           "include": "#escape-char"
@@ -3885,7 +4057,7 @@
           "name": "support.other.abl"
         }
       },
-      "name": "string.double.complex.abl",
+      "name": "string.quoted.double.abl",
       "patterns": [
         {
           "include": "#escape-char"
@@ -3902,7 +4074,7 @@
       "comment": "https://docs.progress.com/bundle/abl-reference/page/Data-types.html"
     },
     "primitive-type": {
-      "match": "(?i)(?<=^|\\s)(blob|(char(?:acter|acte|act|ac|a)?)|cha|ch|c|clob|com-handle|date|da|datetime|datetime-tz|(dec(?:imal|ima|im|i)?)|de|handle|int64|(int(?:eger|ege|eg|e)?)|in|i|(log(?:ical|ica|ic|i)?)|lo|l|(longch(?:ar|a)?)|memptr|raw|recid|rowid|widget-handle)(?![=a-zA-Z0-9_\\-#$%\\-])",
+      "match": "(?i)(?<=^|\\s)(blob|(ch(?:aracter|aracte|aract|arac|ara|ar|a)?)|c|clob|com-handle|(da(?:tetime-tz|tetime|te|t)?)|(de(?:cimal|cima|cim|ci|c)?)|handle|int64|(int(?:eger|ege|eg|e)?)|in|i|(log(?:ical|ica|ic|i)?)|lo|l|(longch(?:ar|a)?)|memptr|raw|recid|rowid|widget-handle)(?![=a-zA-Z0-9_\\-#$%\\-])",
       "captures": {
         "1": {
           "name": "storage.type.abl"
@@ -3911,7 +4083,7 @@
       "comment": "https://docs.progress.com/bundle/abl-reference/page/Data-types.html"
     },
     "numeric": {
-      "match": "(?<![a-zA-Z0-9_\\-#$%-])(0[xX]\\h+)|(\\-?\\.?[0-9]+(\\.[0-9]+)?)",
+      "match": "(?<![a-zA-Z0-9_\\-#$%-])(0[xX]\\h+)|([+\\-]?\\.?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+\\-]?[0-9]+)?)",
       "name": "constant.numeric.source.abl"
     },
     "abl-system-handles": {
@@ -5865,4 +6037,4 @@
   },
   "scopeName": "source.abl",
   "uuid": "075bb86e-03ea-4fea-bac0-e11b9dc73e03"
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abl-tmlanguage",
-  "version": "1.3.16",
+  "version": "1.3.18",
   "description": "TextMate grammar for Progress OpenEdge ABL Language",
   "main": "",
   "type": "commonjs",