@traqula/core 0.0.1-alpha.148 → 0.0.1-alpha.9

package/README.md

@@ -1,9 +1,11 @@
-# TRAQULA core package
+# Traqula core package
 
-TRAQULA core contains core components of traqula.
-Most importantly, its `lexer-builder` and `grammar-builder`.
-This library heavily relies on the amazing [chevrotain package](https://chevrotain.io/docs/).
-Knowing the basics of that package will allow you to quickly generate your own grammars
+**WARNING:** V2 will come shortly and will have lots of breaking changes.
+
+Traqula core contains core components of Traqula.
+Most importantly, its [lexer builder](./lib/lexer-builder/LexerBuilder.ts), [parser builder](./lib/parser-builder/parserBuilder.ts), and [generator builder](./lib/generator-builder/generatorBuilder.ts).
+This library heavily relies on the amazing [Chevrotain package](https://chevrotain.io/docs/).
+Knowing the basics of that package will allow you to quickly generate your own grammars.
 
 ## Installation
 
@@ -19,12 +21,12 @@ yarn add @traqula/core
 
 ## Usage
 
-Each parser contains two steps: 
+Each parser contains two steps:
 1. a lexer
 2. a grammar + abstract syntax tree generation step.
 
-Sometimes grammar definitions and abstract syntax tree generation is split into separate steps. 
-In this library, we choose to keep the two together.
+Sometimes grammar definitions and abstract syntax tree generation is split into separate steps.
+In this library, we choose to keep the two together when building a parser.
 
 ### Lexer Builder
 
@@ -38,10 +40,10 @@ To create a token definition, you use the provided function `createToken` like:
 const select = createToken({ name: 'Select', pattern: /select/i, label: 'SELECT' });
 ```
 
-Lexer definitions are then put in a list and when a lexer is build, the lexer will match a string to the first token in the list that matches.
+Lexer definitions are then put in a list and when a lexer is build, the lexer will match a string to the [**first token in the list**](https://chevrotain.io/docs/tutorial/step1_lexing.html#creating-the-lexer) that matches.
 Note that the order of definitions in the list is thus essential.
 
-We therefore use a `lexer-builder` which allows you to easily:
+We therefore use a [lexer builder](./lib/lexer-builder/LexerBuilder.ts) which allows you to easily:
 1. change the order of lexer rules,
 2. and create a new lexer staring from an existing one.
 
@@ -56,11 +58,11 @@ A new lexer can be created from an existing one by calling:
 const sparql11AdjustTokens = sparql11Tokens.addBefore(select, BuiltInAdjust);
 ```
 
-### Grammar Builder
+### Parser Builder
 
 The grammar builder is used to link together grammar rules such that they can be converted into a parser.
-Grammar rule definitions come in the form of `RuleDef` objects.
-Each `RuleDef` object contains its name and its returnType.
+Grammar rule definitions come in the form of [ParserRule](./lib/parser-builder/ruleDefTypes.ts) objects.
+Each `ParserRule` object contains its name and its returnType.
 Optionally, it can also contain arguments that should be provided to the SUBRULE calls.
 A simple example of a grammar rule is the rule bellow that allows you to parse booleanLiterals.
 
@@ -69,7 +71,7 @@ A simple example of a grammar rule is the rule bellow that allows you to parse b
  * Parses a boolean literal.
  * [[134]](https://www.w3.org/TR/sparql11-query/#rBooleanLiteral)
  */
-export const booleanLiteral: RuleDef<'booleanLiteral', LiteralTerm> = <const> {
+export const booleanLiteral: ParserRule<'booleanLiteral', LiteralTerm> = <const> {
     name: 'booleanLiteral',
     impl: ({ CONSUME, OR, context }) => () => OR([
       { ALT: () => context.dataFactory.literal(
@@ -84,20 +86,19 @@ export const booleanLiteral: RuleDef<'booleanLiteral', LiteralTerm> = <const> {
   };
 ```
 
-The `impl` member of `RuleDef` is a function that receives:
+The `impl` member of `ParserRule` is a function that receives:
 1. essential functions to create a grammar rule (capitalized members),
 2. a context object that can be used by the rules,
-3. a cache object ([WeakMap](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)) that can be used to cache the creation of long lists in the parser. 
+3. a cache object ([WeakMap](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)) that can be used to cache the creation of long lists in the parser, [increasing parser performance](https://chevrotain.io/docs/guide/performance.html#caching-arrays-of-alternatives).
 
-As a warning, we advise against unpacking the context entry in the function definition itself.
-Doing so will cause the unpacked entries to be captured in the closure which will cause unwanted behaviour since the context entry can be reset between runs.
+You cannot unpack the context entry in the function definition itself because the parser uses a [recording phase](https://chevrotain.io/docs/guide/internals.html#grammar-recording) to optimize itself. During this phase, the context entry will be undefined, as such, it can only be accessed within the `ACTION` function.
 
 The result of an `impl` call is a function called a `rule`.
 Rules can be [parameterized](https://chevrotain.io/docs/features/parameterized_rules.html), although I have not found a scenario where that is usefully.
-Personally I create a function that can be used to create multiple `RuleDef` objects.  
-The result of a rule should match the type provided in the `RuleDef` definition, and is the result of a call of `SUBRULE` with that rule.
+Personally I create a function that can be used to create multiple `ParserRule` objects.
+The result of a rule should match the type provided in the `ParserRule` definition, and is the result of a call of `SUBRULE` with that rule.
 
-### Patching rules
+#### Patching rules
 
 When a rule definition calls to a subrule using `SUBRULE(mySub)`, the implementation itself is not necessarily called.
 That is because the SUBRULE function will call the function with the same name as `mySub` that is present in the current grammarBuilder.
@@ -112,4 +113,25 @@ const myBuilder = Builder
 ```
 
 When `selectOrDescribe` calls what it thinks to be `selectRule`,
-it will instead call `selectRuleAlternative` since it overwrote the function `selectRule` with the same name. 
+it will instead call `selectRuleAlternative` since it overwrote the function `selectRule` with the same name.
+
+### Generator Builder
+
+The generator builder function in much the same as the [parser builder](#parser-builder).
+Your builder expects objects of type [GeneratorRule](lib/generator-builder/generatorTypes.ts),
+containing the implementation of the generator in the `gImpl` member.
+The `gImpl` function gets essential functions to create a generator rule (capitalized members),
+returning a function that will get the AST and context, returning a string.
+For generator rules, you can unpack the context since no recording phase is present in this case.
+The idea is that GeneratorRules and ParserRules can be tied together in the same object, as such, similar behaviour is grouped together.
+
+```typescript
+/**
+ * Parses a named node, either as an IRI or as a prefixed name.
+ * [[136]](https://www.w3.org/TR/sparql11-query/#riri)
+ */
+export const iri: GeneratorRule<'iri', IriTerm> = <const> {
+    name: 'iri',
+    gImpl: () => ast => ast.value,
+  };
+```

package/lib/CoreFactory.d.ts

@@ -0,0 +1,39 @@
+import type { IToken } from 'chevrotain';
+import type { SourceLocation, SourceLocationNodeAutoGenerate, SourceLocationNodeReplace, SourceLocationNoMaterialize, SourceLocationSource, SourceLocationStringReplace, Node, Localized, Wrap } from './nodeTypings';
+export type Typed<Type extends PropertyKey> = {
+    type: Type;
+};
+export type SubTyped<Type extends PropertyKey, Subtype extends PropertyKey> = {
+    type: Type;
+    subType: Subtype;
+};
+export declare class CoreFactory {
+    wrap<T>(val: T, loc: SourceLocation): Wrap<T>;
+    isLocalized(obj: unknown): obj is Localized;
+    sourceLocation(...elements: (undefined | IToken | Localized)[]): SourceLocation;
+    sourceLocationNoMaterialize(): SourceLocationNoMaterialize;
+    /**
+     * Returns a copy of the argument that is not materialized
+     */
+    dematerialized<T extends Node>(arg: T): T & {
+        loc: SourceLocationNoMaterialize;
+    };
+    safeObjectTransform(value: unknown, mapper: (some: object) => any): any;
+    forcedAutoGenTree<T extends object>(obj: T): T;
+    forceMaterialized<T extends Node>(arg: T): T;
+    isSourceLocation(loc: object): loc is SourceLocation;
+    sourceLocationSource(start: number, end: number): SourceLocationSource;
+    gen(): SourceLocationNodeAutoGenerate;
+    isSourceLocationSource(loc: object): loc is SourceLocationSource;
+    isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace;
+    sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace;
+    sourceLocationNodeReplace(location: SourceLocationSource): SourceLocationNodeReplace;
+    sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace;
+    isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace;
+    isSourceLocationNodeAutoGenerate(loc: object): loc is SourceLocationNodeAutoGenerate;
+    nodeShouldPrint(node: Localized): boolean;
+    printFilter(node: Localized, callback: () => void): void;
+    isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize;
+    isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type>;
+    isOfSubType<Type extends string, SubType extends string>(obj: object, type: Type, subType: SubType): obj is SubTyped<Type, SubType>;
+}

package/lib/CoreFactory.js

@@ -0,0 +1,135 @@
+export class CoreFactory {
+    wrap(val, loc) {
+        return { val, loc };
+    }
+    isLocalized(obj) {
+        return typeof obj === 'object' && obj !== null && 'loc' in obj &&
+            typeof obj.loc === 'object' && obj.loc !== null && 'sourceLocationType' in obj.loc;
+    }
+    sourceLocation(...elements) {
+        const pureElements = elements.filter(x => x !== undefined);
+        if (pureElements.length === 0) {
+            return this.sourceLocationNoMaterialize();
+        }
+        const filtered = pureElements.filter(element => !this.isLocalized(element) || this.isSourceLocationSource(element.loc) ||
+            this.isSourceLocationStringReplace(element.loc) || this.isSourceLocationNodeReplace(element.loc));
+        if (filtered.length === 0) {
+            return this.gen();
+        }
+        const first = filtered[0];
+        const last = filtered.at(-1);
+        return {
+            sourceLocationType: 'source',
+            start: this.isLocalized(first) ?
+                first.loc.start :
+                first.startOffset,
+            end: this.isLocalized(last) ?
+                last.loc.end :
+                (last.endOffset + 1),
+        };
+    }
+    sourceLocationNoMaterialize() {
+        return { sourceLocationType: 'noMaterialize' };
+    }
+    /**
+     * Returns a copy of the argument that is not materialized
+     */
+    dematerialized(arg) {
+        return { ...arg, loc: this.sourceLocationNoMaterialize() };
+    }
+    safeObjectTransform(value, mapper) {
+        if (value && typeof value === 'object') {
+            // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects
+            if (Array.isArray(value)) {
+                return value.map(x => this.safeObjectTransform(x, mapper));
+            }
+            return mapper(value);
+        }
+        return value;
+    }
+    forcedAutoGenTree(obj) {
+        const copy = { ...obj };
+        for (const [key, value] of Object.entries(copy)) {
+            copy[key] = this.safeObjectTransform(value, obj => this.forcedAutoGenTree(obj));
+        }
+        if (this.isLocalized(copy)) {
+            copy.loc = this.gen();
+        }
+        return copy;
+    }
+    forceMaterialized(arg) {
+        if (this.isSourceLocationNoMaterialize(arg.loc)) {
+            return this.forcedAutoGenTree(arg);
+        }
+        return { ...arg };
+    }
+    isSourceLocation(loc) {
+        return 'sourceLocationType' in loc;
+    }
+    sourceLocationSource(start, end) {
+        return {
+            sourceLocationType: 'source',
+            start,
+            end,
+        };
+    }
+    gen() {
+        return { sourceLocationType: 'autoGenerate' };
+    }
+    isSourceLocationSource(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'source';
+    }
+    isSourceLocationStringReplace(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'stringReplace';
+    }
+    sourceLocationNodeReplaceUnsafe(loc) {
+        if (this.isSourceLocationSource(loc)) {
+            return this.sourceLocationNodeReplace(loc);
+        }
+        throw new Error('not possible');
+    }
+    sourceLocationNodeReplace(startOrLoc, end) {
+        let starting;
+        let ending;
+        if (typeof startOrLoc === 'number') {
+            starting = startOrLoc;
+            ending = end;
+        }
+        else {
+            starting = startOrLoc.start;
+            ending = startOrLoc.end;
+        }
+        return {
+            sourceLocationType: 'nodeReplace',
+            start: starting,
+            end: ending,
+        };
+    }
+    isSourceLocationNodeReplace(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'nodeReplace';
+    }
+    isSourceLocationNodeAutoGenerate(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'autoGenerate';
+    }
+    nodeShouldPrint(node) {
+        return this.isSourceLocationNodeReplace(node.loc) ||
+            this.isSourceLocationNodeAutoGenerate(node.loc);
+    }
+    printFilter(node, callback) {
+        if (this.nodeShouldPrint(node)) {
+            callback();
+        }
+    }
+    isSourceLocationNoMaterialize(loc) {
+        return this.isSourceLocation(loc) && loc.sourceLocationType === 'noMaterialize';
+    }
+    isOfType(obj, type) {
+        const casted = obj;
+        return casted.type === type;
+    }
+    isOfSubType(obj, type, subType) {
+        const temp = obj;
+        return temp.type === type && temp.subType === subType;
+    }
+}
+//# sourceMappingURL=CoreFactory.js.map

package/lib/CoreFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreFactory.js","sourceRoot":"","sources":["CoreFactory.ts"],"names":[],"mappings":"AAiBA,MAAM,OAAO,WAAW;IACf,IAAI,CAAI,GAAM,EAAE,GAAmB;QACxC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,CAAC;IAEM,WAAW,CAAC,GAAY;QAC7B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,IAAI,GAAG;YAC5D,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,oBAAoB,IAAI,GAAG,CAAC,GAAG,CAAC;IACvF,CAAC;IAEM,cAAc,CAAC,GAAG,QAA4C;QACnE,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QAC3D,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,2BAA2B,EAAE,CAAC;QAC5C,CAAC;QACD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAC7C,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,GAAG,CAAC;YACtE,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACpG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;QAC9B,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC0B,KAAK,CAAC,GAAI,CAAC,KAAK,CAAC,CAAC;gBAC1E,KAAK,CAAC,WAAW;YACnB,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC6B,IAAI,CAAC,GAAI,CAAC,GAAG,CAAC,CAAC;gBACrE,CAAC,IAAI,CAAC,SAAU,GAAG,CAAC,CAAC;SAC1B,CAAC;IACJ,CAAC;IAEM,2BAA2B;QAChC,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,cAAc,CAAiB,GAAM;QAC1C,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,2BAA2B,EAAE,EAAE,CAAC;IAC7D,CAAC;IAEM,mBAAmB,CAAC,KAAc,EAAE,MAA6B;QACtE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,6GAA6G;YAC7G,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,iBAAiB,CAAmB,GAAM;QAC/C,MAAM,IAAI,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,IAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAiB,GAAM;QAC7C,IAAI,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,GAAG,GAAG,EAAE,CAAC;IACpB,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,OAAO,oBAAoB,IAAI,GAAG,CAAC;IACrC,CAAC;IAEM,oBAAoB,CAAC,KAAa,EAAE,GAAW;QACpD,OAAO;YACL,kBAAkB,EAAE,QAAQ;YAC5B,KAAK;YACL,GAAG;SACJ,CAAC;IACJ,CAAC;IAEM,GAAG;QACR,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAEM,sBAAsB,CAAC,GAAW;QACvC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAAC;IAC3E,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,+BAA+B,CAAC,GAAmB;QACxD,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAIM,yBAAyB,CAAC,UAAyC,EAAE,GAAY;QACtF,IAAI,QAAQ,CAAC;QACb,IAAI,MAAM,CAAC;QACX,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACnC,QAAQ,GAAG,UAAU,CAAC;YACtB,MAAM,GAAG,GAAI,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;YAC5B,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC;QAC1B,CAAC;QACD,OAAO;YACL,kBAAkB,EAAE,aAAa;YACjC,KAAK,EAAE,QAAQ;YACf,GAAG,EAAE,MAAM;SACZ,CAAC;IACJ,CAAC;IAEM,2BAA2B,CAAC,GAAW;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,aAAa,CAAC;IAChF,CAAC;IAEM,gCAAgC,CAAC,GAAW;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,cAAc,CAAC;IACjF,CAAC;IAEM,eAAe,CAAC,IAAe;QACpC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/C,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,IAAe,EAAE,QAAoB;QACtD,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,QAAQ,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAEM,6BAA6B,CAAC,GAAW;QAC9C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,kBAAkB,KAAK,eAAe,CAAC;IAClF,CAAC;IAEM,QAAQ,CAAsB,GAAW,EAAE,IAAU;QAC1D,MAAM,MAAM,GAAmB,GAAG,CAAC;QACnC,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;IAC9B,CAAC;IAEM,WAAW,CAA8C,GAAW,EAAE,IAAU,EAAE,OAAgB;QAEvG,MAAM,IAAI,GAA0C,GAAG,CAAC;QACxD,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC;IACxD,CAAC;CACF","sourcesContent":["import type { IToken } from 'chevrotain';\n\nimport type {\n  SourceLocation,\n  SourceLocationNodeAutoGenerate,\n  SourceLocationNodeReplace,\n  SourceLocationNoMaterialize,\n  SourceLocationSource,\n  SourceLocationStringReplace,\n  Node,\n  Localized,\n  Wrap,\n} from './nodeTypings';\n\nexport type Typed<Type extends PropertyKey> = { type: Type };\nexport type SubTyped<Type extends PropertyKey, Subtype extends PropertyKey> = { type: Type; subType: Subtype };\n\nexport class CoreFactory {\n  public wrap<T>(val: T, loc: SourceLocation): Wrap<T> {\n    return { val, loc };\n  }\n\n  public isLocalized(obj: unknown): obj is Localized {\n    return typeof obj === 'object' && obj !== null && 'loc' in obj &&\n      typeof obj.loc === 'object' && obj.loc !== null && 'sourceLocationType' in obj.loc;\n  }\n\n  public sourceLocation(...elements: (undefined | IToken | Localized)[]): SourceLocation {\n    const pureElements = elements.filter(x => x !== undefined);\n    if (pureElements.length === 0) {\n      return this.sourceLocationNoMaterialize();\n    }\n    const filtered = pureElements.filter(element =>\n      !this.isLocalized(element) || this.isSourceLocationSource(element.loc) ||\n      this.isSourceLocationStringReplace(element.loc) || this.isSourceLocationNodeReplace(element.loc));\n    if (filtered.length === 0) {\n      return this.gen();\n    }\n    const first = filtered[0];\n    const last = filtered.at(-1)!;\n    return {\n      sourceLocationType: 'source',\n      start: this.isLocalized(first) ?\n          (<SourceLocationSource | SourceLocationStringReplace> first.loc).start :\n        first.startOffset,\n      end: this.isLocalized(last) ?\n          (<SourceLocationSource | SourceLocationStringReplace> last.loc).end :\n          (last.endOffset! + 1),\n    };\n  }\n\n  public sourceLocationNoMaterialize(): SourceLocationNoMaterialize {\n    return { sourceLocationType: 'noMaterialize' };\n  }\n\n  /**\n   * Returns a copy of the argument that is not materialized\n   */\n  public dematerialized<T extends Node>(arg: T): T & { loc: SourceLocationNoMaterialize } {\n    return { ...arg, loc: this.sourceLocationNoMaterialize() };\n  }\n\n  public safeObjectTransform(value: unknown, mapper: (some: object) => any): any {\n    if (value && typeof value === 'object') {\n      // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects\n      if (Array.isArray(value)) {\n        return value.map(x => this.safeObjectTransform(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n\n  public forcedAutoGenTree<T extends object>(obj: T): T {\n    const copy = { ...obj };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, object>> copy)[key] = this.safeObjectTransform(value, obj => this.forcedAutoGenTree(obj));\n    }\n    if (this.isLocalized(copy)) {\n      copy.loc = this.gen();\n    }\n    return copy;\n  }\n\n  public forceMaterialized<T extends Node>(arg: T): T {\n    if (this.isSourceLocationNoMaterialize(arg.loc)) {\n      return this.forcedAutoGenTree(arg);\n    }\n    return { ...arg };\n  }\n\n  public isSourceLocation(loc: object): loc is SourceLocation {\n    return 'sourceLocationType' in loc;\n  }\n\n  public sourceLocationSource(start: number, end: number): SourceLocationSource {\n    return {\n      sourceLocationType: 'source',\n      start,\n      end,\n    };\n  }\n\n  public gen(): SourceLocationNodeAutoGenerate {\n    return { sourceLocationType: 'autoGenerate' };\n  }\n\n  public isSourceLocationSource(loc: object): loc is SourceLocationSource {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'source';\n  }\n\n  public isSourceLocationStringReplace(loc: object): loc is SourceLocationStringReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'stringReplace';\n  }\n\n  public sourceLocationNodeReplaceUnsafe(loc: SourceLocation): SourceLocationNodeReplace {\n    if (this.isSourceLocationSource(loc)) {\n      return this.sourceLocationNodeReplace(loc);\n    }\n    throw new Error('not possible');\n  }\n\n  public sourceLocationNodeReplace(location: SourceLocationSource): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(start: number, end: number): SourceLocationNodeReplace;\n  public sourceLocationNodeReplace(startOrLoc: number | SourceLocationSource, end?: number): SourceLocationNodeReplace {\n    let starting;\n    let ending;\n    if (typeof startOrLoc === 'number') {\n      starting = startOrLoc;\n      ending = end!;\n    } else {\n      starting = startOrLoc.start;\n      ending = startOrLoc.end;\n    }\n    return {\n      sourceLocationType: 'nodeReplace',\n      start: starting,\n      end: ending,\n    };\n  }\n\n  public isSourceLocationNodeReplace(loc: object): loc is SourceLocationNodeReplace {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'nodeReplace';\n  }\n\n  public isSourceLocationNodeAutoGenerate(loc: object): loc is SourceLocationNodeAutoGenerate {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'autoGenerate';\n  }\n\n  public nodeShouldPrint(node: Localized): boolean {\n    return this.isSourceLocationNodeReplace(node.loc) ||\n      this.isSourceLocationNodeAutoGenerate(node.loc);\n  }\n\n  public printFilter(node: Localized, callback: () => void): void {\n    if (this.nodeShouldPrint(node)) {\n      callback();\n    }\n  }\n\n  public isSourceLocationNoMaterialize(loc: object): loc is SourceLocationNoMaterialize {\n    return this.isSourceLocation(loc) && loc.sourceLocationType === 'noMaterialize';\n  }\n\n  public isOfType<Type extends string>(obj: object, type: Type): obj is Typed<Type> {\n    const casted: { type?: any } = obj;\n    return casted.type === type;\n  }\n\n  public isOfSubType<Type extends string, SubType extends string>(obj: object, type: Type, subType: SubType):\n    obj is SubTyped<Type, SubType> {\n    const temp: { type?: unknown; subType?: unknown } = obj;\n    return temp.type === type && temp.subType === subType;\n  }\n}\n"]}

package/lib/RangeArithmetic.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Starting inclusive, ending exclusive
+ */
+export type Range<A extends number = number, B extends number = number> = [A, B];
+export declare class RangeArithmetic {
+    ranges: Range[];
+    private readonly initRange;
+    constructor(start: number, end: number);
+    private static validate;
+    private static substractRange;
+    subtract(...range: Range): this;
+    negate(): this;
+    projection(...range: Range): Range[];
+}

package/lib/RangeArithmetic.js

@@ -0,0 +1,71 @@
+export class RangeArithmetic {
+    constructor(start, end) {
+        this.ranges = [];
+        this.initRange = RangeArithmetic.validate(start, end);
+        this.ranges.push(this.initRange);
+    }
+    static validate(...range) {
+        const [start, end] = range;
+        if (start >= end) {
+            throw new Error('Invalid range');
+        }
+        return range;
+    }
+    static substractRange(included, ...range) {
+        const [sMinus, eMinus] = RangeArithmetic.validate(...range);
+        return included.flatMap(([sCur, eCur]) => {
+            // Split in half
+            if (sCur < sMinus && eMinus < eCur) {
+                return [[sCur, sMinus], [eMinus, eCur]];
+            }
+            if (sMinus <= sCur && sCur < eMinus && eMinus < eCur) {
+                return [[eMinus, eCur]];
+            }
+            if (sCur < sMinus && sMinus < eCur && eCur <= eMinus) {
+                return [[sCur, sMinus]];
+            }
+            if (sMinus <= sCur && eCur <= eMinus) {
+                return [];
+            }
+            return [[sCur, eCur]];
+        });
+    }
+    subtract(...range) {
+        this.ranges = RangeArithmetic.substractRange(this.ranges, ...range);
+        return this;
+    }
+    negate() {
+        // Can be optimized
+        let iter = [this.initRange];
+        for (const range of this.ranges) {
+            iter = RangeArithmetic.substractRange(iter, ...range);
+        }
+        this.ranges = iter;
+        return this;
+    }
+    projection(...range) {
+        const [sProj, eProj] = range;
+        if (sProj >= eProj) {
+            return [];
+        }
+        return this.ranges.flatMap(([sCur, eCur]) => {
+            // If projection is inside the range
+            if (sCur < sProj && eProj < eCur) {
+                return [[sProj, eProj]];
+            }
+            // Projection wraps around
+            if (sProj <= sCur && eCur <= eProj) {
+                return [[sCur, eCur]];
+            }
+            // Matches left side
+            if (sProj <= sCur && sCur < eProj && eProj < eCur) {
+                return [[sCur, eProj]];
+            }
+            if (sCur < sProj && sProj < eCur && eCur < eProj) {
+                return [[sProj, eCur]];
+            }
+            return [];
+        });
+    }
+}
+//# sourceMappingURL=RangeArithmetic.js.map

package/lib/RangeArithmetic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RangeArithmetic.js","sourceRoot":"","sources":["RangeArithmetic.ts"],"names":[],"mappings":"AAKA,MAAM,OAAO,eAAe;IAG1B,YAAmB,KAAa,EAAE,GAAW;QAFtC,WAAM,GAAY,EAAE,CAAC;QAG1B,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAY;QACrC,MAAM,CAAE,KAAK,EAAE,GAAG,CAAE,GAAG,KAAK,CAAC;QAC7B,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAiB,EAAE,GAAG,KAAY;QAC9D,MAAM,CAAE,MAAM,EAAE,MAAM,CAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC;QAE9D,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAE,IAAI,EAAE,IAAI,CAAE,EAAE,EAAE;YACzC,gBAAgB;YAChB,IAAI,IAAI,GAAG,MAAM,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;gBACnC,OAAO,CAAC,CAAE,IAAI,EAAE,MAAM,CAAE,EAAE,CAAE,MAAM,EAAE,IAAI,CAAE,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,GAAG,MAAM,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrD,OAAO,CAAC,CAAE,MAAM,EAAE,IAAI,CAAE,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,IAAI,GAAG,MAAM,IAAI,MAAM,GAAG,IAAI,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;gBACrD,OAAO,CAAC,CAAE,IAAI,EAAE,MAAM,CAAE,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;gBACrC,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,CAAC,CAAE,IAAI,EAAE,IAAI,CAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,QAAQ,CAAC,GAAG,KAAY;QAC7B,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM;QACX,mBAAmB;QACnB,IAAI,IAAI,GAAG,CAAE,IAAI,CAAC,SAAS,CAAE,CAAC;QAC9B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,GAAG,eAAe,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,UAAU,CAAC,GAAG,KAAY;QAC/B,MAAM,CAAE,KAAK,EAAE,KAAK,CAAE,GAAG,KAAK,CAAC;QAC/B,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,IAAI,EAAE,IAAI,CAAE,EAAE,EAAE;YAC5C,oCAAoC;YACpC,IAAI,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBACjC,OAAO,CAAC,CAAE,KAAK,EAAE,KAAK,CAAE,CAAC,CAAC;YAC5B,CAAC;YACD,0BAA0B;YAC1B,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;gBACnC,OAAO,CAAC,CAAE,IAAI,EAAE,IAAI,CAAE,CAAC,CAAC;YAC1B,CAAC;YACD,oBAAoB;YACpB,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;gBAClD,OAAO,CAAC,CAAE,IAAI,EAAE,KAAK,CAAE,CAAC,CAAC;YAC3B,CAAC;YACD,IAAI,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,IAAI,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;gBACjD,OAAO,CAAC,CAAE,KAAK,EAAE,IAAI,CAAE,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/**\n * Starting inclusive, ending exclusive\n */\nexport type Range<A extends number = number, B extends number = number> = [A, B];\n\nexport class RangeArithmetic {\n  public ranges: Range[] = [];\n  private readonly initRange: Range;\n  public constructor(start: number, end: number) {\n    this.initRange = RangeArithmetic.validate(start, end);\n    this.ranges.push(this.initRange);\n  }\n\n  private static validate(...range: Range): Range {\n    const [ start, end ] = range;\n    if (start >= end) {\n      throw new Error('Invalid range');\n    }\n    return range;\n  }\n\n  private static substractRange(included: Range[], ...range: Range): Range[] {\n    const [ sMinus, eMinus ] = RangeArithmetic.validate(...range);\n\n    return included.flatMap(([ sCur, eCur ]) => {\n      // Split in half\n      if (sCur < sMinus && eMinus < eCur) {\n        return [[ sCur, sMinus ], [ eMinus, eCur ]];\n      }\n      if (sMinus <= sCur && sCur < eMinus && eMinus < eCur) {\n        return [[ eMinus, eCur ]];\n      }\n      if (sCur < sMinus && sMinus < eCur && eCur <= eMinus) {\n        return [[ sCur, sMinus ]];\n      }\n      if (sMinus <= sCur && eCur <= eMinus) {\n        return [];\n      }\n      return [[ sCur, eCur ]];\n    });\n  }\n\n  public subtract(...range: Range): this {\n    this.ranges = RangeArithmetic.substractRange(this.ranges, ...range);\n    return this;\n  }\n\n  public negate(): this {\n    // Can be optimized\n    let iter = [ this.initRange ];\n    for (const range of this.ranges) {\n      iter = RangeArithmetic.substractRange(iter, ...range);\n    }\n    this.ranges = iter;\n    return this;\n  }\n\n  public projection(...range: Range): Range[] {\n    const [ sProj, eProj ] = range;\n    if (sProj >= eProj) {\n      return [];\n    }\n    return this.ranges.flatMap(([ sCur, eCur ]) => {\n      // If projection is inside the range\n      if (sCur < sProj && eProj < eCur) {\n        return [[ sProj, eProj ]];\n      }\n      // Projection wraps around\n      if (sProj <= sCur && eCur <= eProj) {\n        return [[ sCur, eCur ]];\n      }\n      // Matches left side\n      if (sProj <= sCur && sCur < eProj && eProj < eCur) {\n        return [[ sCur, eProj ]];\n      }\n      if (sCur < sProj && sProj < eCur && eCur < eProj) {\n        return [[ sProj, eCur ]];\n      }\n      return [];\n    });\n  }\n}\n"]}

package/lib/Transformer.d.ts

@@ -0,0 +1,26 @@
+import type { SubTyped } from './CoreFactory';
+import type { Node } from './nodeTypings';
+type MapNodeTypeToImpls<Nodes extends Node> = {
+    [Node in Nodes as Node['type']]: Node;
+};
+type MapNodeSubTypeToImpls<Nodes extends Node & {
+    subType: string;
+}> = {
+    [Node in Nodes as Node['subType']]: Node;
+};
+export type AlterNodeOutput<RecursiveObject extends object, Input, Out> = {
+    [Key in keyof RecursiveObject]: RecursiveObject[Key] extends object ? (AlterNodeOutput<RecursiveObject[Key], Input, Out> extends Input ? Out : AlterNodeOutput<RecursiveObject[Key], Input, Out>) : RecursiveObject[Key];
+};
+export declare class Transformer<Nodes extends Node, NodeMapping extends MapNodeTypeToImpls<Nodes> & Record<string, unknown> = MapNodeTypeToImpls<Nodes>> {
+    transformNode<Input extends object, TypeFilter extends keyof NodeMapping, Out>(curObject: Input, searchType: TypeFilter, patch: (current: NodeMapping[TypeFilter]) => Out): AlterNodeOutput<Input, NodeMapping[TypeFilter], Out>;
+    transformNodeSpecific<Input extends object, TypeFilter extends keyof NodeMapping, SpecificType extends keyof SpecificNodes, Out, SpecificNodes = NodeMapping[TypeFilter] extends Node & {
+        subType: string;
+    } ? MapNodeSubTypeToImpls<NodeMapping[TypeFilter]> : never>(curObject: Input, searchType: TypeFilter, searchSubType: SpecificType, patch: (current: SpecificNodes[SpecificType]) => Out): AlterNodeOutput<Input, SubTyped<TypeFilter, SpecificType>, Out>;
+    visitObjects(curObject: object, visitor: (current: object) => void): void;
+    visitNode<Input extends object, TypeFilter extends keyof NodeMapping>(curObject: Input, searchType: TypeFilter, visitor: (current: Readonly<NodeMapping[TypeFilter]>) => void): void;
+    visitNodeSpecific<Input extends object, TypeFilter extends keyof NodeMapping, SpecificType extends keyof SpecificNodes, SpecificNodes = NodeMapping[TypeFilter] extends Node & {
+        subType: string;
+    } ? MapNodeSubTypeToImpls<NodeMapping[TypeFilter]> : never>(curObject: Input, searchType: TypeFilter, searchSubType: SpecificType, visitor: (current: Readonly<SpecificNodes[SpecificType]>) => void): void;
+    private safeObjectVisit;
+}
+export {};

package/lib/Transformer.js

@@ -0,0 +1,57 @@
+export class Transformer {
+    transformNode(curObject, searchType, patch) {
+        const copy = { ...curObject };
+        for (const [key, value] of Object.entries(copy)) {
+            copy[key] =
+                this.safeObjectVisit(value, obj => this.transformNode(obj, searchType, patch));
+        }
+        if (copy.type === searchType) {
+            return patch(copy);
+        }
+        return copy;
+    }
+    transformNodeSpecific(curObject, searchType, searchSubType, patch) {
+        const copy = { ...curObject };
+        for (const [key, value] of Object.entries(copy)) {
+            copy[key] =
+                this.safeObjectVisit(value, obj => this.transformNodeSpecific(obj, searchType, searchSubType, patch));
+        }
+        if (copy.type === searchType && copy.subType === searchSubType) {
+            return patch(copy);
+        }
+        return copy;
+    }
+    visitObjects(curObject, visitor) {
+        for (const value of Object.values(curObject)) {
+            this.safeObjectVisit(value, obj => this.visitObjects(obj, visitor));
+        }
+    }
+    visitNode(curObject, searchType, visitor) {
+        for (const value of Object.values(curObject)) {
+            this.safeObjectVisit(value, obj => this.visitNode(obj, searchType, visitor));
+        }
+        if (curObject.type === searchType) {
+            visitor(curObject);
+        }
+    }
+    visitNodeSpecific(curObject, searchType, searchSubType, visitor) {
+        for (const value of Object.values(curObject)) {
+            this.safeObjectVisit(value, obj => this.visitNodeSpecific(obj, searchType, searchSubType, visitor));
+        }
+        const cast = curObject;
+        if (cast.type === searchType && cast.subType === searchSubType) {
+            visitor(curObject);
+        }
+    }
+    safeObjectVisit(value, mapper) {
+        if (value && typeof value === 'object') {
+            // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects
+            if (Array.isArray(value)) {
+                return value.map(x => this.safeObjectVisit(x, mapper));
+            }
+            return mapper(value);
+        }
+        return value;
+    }
+}
+//# sourceMappingURL=Transformer.js.map

package/lib/Transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transformer.js","sourceRoot":"","sources":["Transformer.ts"],"names":[],"mappings":"AAcA,MAAM,OAAO,WAAW;IAIf,aAAa,CAClB,SAAgB,EAChB,UAAsB,EACtB,KAAgD;QAEhD,MAAM,IAAI,GAAuB,EAAE,GAAG,SAAS,EAAE,CAAC;QAClD,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAK,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7B,OAAa,KAAK,CAA2B,IAAI,CAAC,CAAC;QACrD,CAAC;QACD,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,qBAAqB,CAQ1B,SAAgB,EAChB,UAAsB,EACtB,aAA2B,EAC3B,KAAoD;QAEpD,MAAM,IAAI,GAA0C,EAAE,GAAG,SAAS,EAAE,CAAC;QACrE,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAK,CAAC,GAAG,CAAC;gBACnC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1G,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;YAC/D,OAAa,KAAK,CAA+B,IAAI,CAAC,CAAC;QACzD,CAAC;QACD,OAAa,IAAI,CAAC;IACpB,CAAC;IAEM,YAAY,CAAC,SAAiB,EAAE,OAAkC;QACvE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAEM,SAAS,CACd,SAAgB,EAChB,UAAsB,EACtB,OAA6D;QAE7D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,IAAyB,SAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxD,OAAO,CAA2B,SAAS,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAEM,iBAAiB,CAOtB,SAAgB,EAChB,UAAsB,EACtB,aAA2B,EAC3B,OAAiE;QAEjE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;QACtG,CAAC;QACD,MAAM,IAAI,GAA0C,SAAS,CAAC;QAC9D,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;YAC/D,OAAO,CAA+B,SAAS,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,eAAe,CAAC,KAAc,EAAE,MAA6B;QACnE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,6GAA6G;YAC7G,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF","sourcesContent":["import type { SubTyped } from './CoreFactory';\nimport type { Node } from './nodeTypings';\n\ntype MapNodeTypeToImpls<Nodes extends Node> = {[Node in Nodes as Node['type']]: Node };\ntype MapNodeSubTypeToImpls<Nodes extends Node & { subType: string }> = {[Node in Nodes as Node['subType']]: Node };\n\nexport type AlterNodeOutput<RecursiveObject extends object, Input, Out>\n  = {\n    [Key in keyof RecursiveObject]: RecursiveObject[Key] extends object ?\n        (AlterNodeOutput<RecursiveObject[Key], Input, Out> extends Input ?\n          Out : AlterNodeOutput<RecursiveObject[Key], Input, Out>) :\n      RecursiveObject[Key]\n  };\n\nexport class Transformer<\n  Nodes extends Node,\nNodeMapping extends MapNodeTypeToImpls<Nodes> & Record<string, unknown> = MapNodeTypeToImpls<Nodes>,\n> {\n  public transformNode<Input extends object, TypeFilter extends keyof NodeMapping, Out>(\n    curObject: Input,\n    searchType: TypeFilter,\n    patch: (current: NodeMapping[TypeFilter]) => Out,\n  ): AlterNodeOutput<Input, NodeMapping[TypeFilter], Out> {\n    const copy: { type?: unknown } = { ...curObject };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, unknown>> copy)[key] =\n        this.safeObjectVisit(value, obj => this.transformNode(obj, searchType, patch));\n    }\n    if (copy.type === searchType) {\n      return <any> patch(<NodeMapping[TypeFilter]> copy);\n    }\n    return <any> copy;\n  }\n\n  public transformNodeSpecific<\n    Input extends object,\nTypeFilter extends keyof NodeMapping,\nSpecificType extends keyof SpecificNodes,\nOut,\nSpecificNodes = NodeMapping[TypeFilter] extends Node & { subType: string } ?\n  MapNodeSubTypeToImpls<NodeMapping[TypeFilter]> : never,\n>(\n    curObject: Input,\n    searchType: TypeFilter,\n    searchSubType: SpecificType,\n    patch: (current: SpecificNodes[SpecificType]) => Out,\n  ): AlterNodeOutput<Input, SubTyped<TypeFilter, SpecificType>, Out> {\n    const copy: { type?: unknown; subType?: unknown } = { ...curObject };\n    for (const [ key, value ] of Object.entries(copy)) {\n      (<Record<string, unknown>> copy)[key] =\n        this.safeObjectVisit(value, obj => this.transformNodeSpecific(obj, searchType, searchSubType, patch));\n    }\n    if (copy.type === searchType && copy.subType === searchSubType) {\n      return <any> patch(<SpecificNodes[SpecificType]> copy);\n    }\n    return <any> copy;\n  }\n\n  public visitObjects(curObject: object, visitor: (current: object) => void): void {\n    for (const value of Object.values(curObject)) {\n      this.safeObjectVisit(value, obj => this.visitObjects(obj, visitor));\n    }\n  }\n\n  public visitNode<Input extends object, TypeFilter extends keyof NodeMapping>(\n    curObject: Input,\n    searchType: TypeFilter,\n    visitor: (current: Readonly<NodeMapping[TypeFilter]>) => void,\n  ): void {\n    for (const value of Object.values(curObject)) {\n      this.safeObjectVisit(value, obj => this.visitNode(obj, searchType, visitor));\n    }\n    if ((<{ type?: unknown }>curObject).type === searchType) {\n      visitor(<NodeMapping[TypeFilter]> curObject);\n    }\n  }\n\n  public visitNodeSpecific<\n    Input extends object,\nTypeFilter extends keyof NodeMapping,\nSpecificType extends keyof SpecificNodes,\nSpecificNodes = NodeMapping[TypeFilter] extends Node & { subType: string } ?\n  MapNodeSubTypeToImpls<NodeMapping[TypeFilter]> : never,\n >(\n    curObject: Input,\n    searchType: TypeFilter,\n    searchSubType: SpecificType,\n    visitor: (current: Readonly<SpecificNodes[SpecificType]>) => void,\n  ): void {\n    for (const value of Object.values(curObject)) {\n      this.safeObjectVisit(value, obj => this.visitNodeSpecific(obj, searchType, searchSubType, visitor));\n    }\n    const cast = <{ type?: unknown; subType?: unknown }>curObject;\n    if (cast.type === searchType && cast.subType === searchSubType) {\n      visitor(<SpecificNodes[SpecificType]> curObject);\n    }\n  }\n\n  private safeObjectVisit(value: unknown, mapper: (some: object) => any): any {\n    if (value && typeof value === 'object') {\n      // If you wonder why this is all so hard, this is the reason. We cannot lose the methods of our Array objects\n      if (Array.isArray(value)) {\n        return value.map(x => this.safeObjectVisit(x, mapper));\n      }\n      return mapper(value);\n    }\n    return value;\n  }\n}\n"]}

package/lib/generator-builder/builderTypes.d.ts

@@ -0,0 +1,23 @@
+import type { GeneratorRule } from './generatorTypes';
+/**
+ * Get union-type of names used in list of ruledefs.
+ */
+export type GenNamesFromList<T extends readonly GeneratorRule[]> = T[number]['name'];
+/**
+ * Convert a list of ruledefs to a record that maps each rule name to its definition.
+ */
+export type GenRuleMap<RuleNames extends string> = {
+    [Key in RuleNames]: GeneratorRule<any, Key>;
+};
+/**
+ * Convert a list of RuleDefs to a Record with the name of the RuleDef as the key, matching the RuleDefMap type.
+ */
+export type GenRulesToObject<T extends readonly GeneratorRule[], Names extends string = GenNamesFromList<T>, Agg extends Record<string, GeneratorRule> = Record<never, never>> = T extends readonly [infer First, ...infer Rest] ? (First extends GeneratorRule ? (Rest extends readonly GeneratorRule[] ? (GenRulesToObject<Rest, Names, {
+    [K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K];
+}>) : never) : never) : GenRuleMap<Names> & Agg;
+export type GeneratorFromRules<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> = {
+    [K in Names]: RuleDefs[K] extends GeneratorRule<Context, K, infer RET, infer ARGS> ? (input: RET, context: Context & {
+        origSource: string;
+        offset?: number;
+    }, args: ARGS) => string : never;
+};

package/lib/generator-builder/builderTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builderTypes.js","sourceRoot":"","sources":["builderTypes.ts"],"names":[],"mappings":"","sourcesContent":["import type { GeneratorRule } from './generatorTypes';\n\n/**\n * Get union-type of names used in list of ruledefs.\n */\nexport type GenNamesFromList<T extends readonly GeneratorRule[]> = T[number]['name'];\n\n/**\n * Convert a list of ruledefs to a record that maps each rule name to its definition.\n */\nexport type GenRuleMap<RuleNames extends string> = {[Key in RuleNames]: GeneratorRule<any, Key> };\n\n/**\n * Convert a list of RuleDefs to a Record with the name of the RuleDef as the key, matching the RuleDefMap type.\n */\nexport type GenRulesToObject<\n  T extends readonly GeneratorRule[],\n  Names extends string = GenNamesFromList<T>,\n  Agg extends Record<string, GeneratorRule> = Record<never, never>,\n> = T extends readonly [infer First, ...infer Rest] ? (\n  First extends GeneratorRule ? (\n    Rest extends readonly GeneratorRule[] ? (\n      GenRulesToObject<Rest, Names, {[K in keyof Agg | First['name']]: K extends First['name'] ? First : Agg[K] }>\n    ) : never\n  ) : never\n) : GenRuleMap<Names> & Agg;\n\nexport type GeneratorFromRules<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> = {\n  [K in Names]: RuleDefs[K] extends GeneratorRule<Context, K, infer RET, infer ARGS> ?\n      (input: RET, context: Context & { origSource: string; offset?: number }, args: ARGS) => string : never\n};\n"]}

package/lib/generator-builder/dynamicGenerator.d.ts

@@ -0,0 +1,22 @@
+import { CoreFactory } from '../CoreFactory';
+import type { GenRuleMap } from './builderTypes';
+import type { RuleDefArg } from './generatorTypes';
+export declare class DynamicGenerator<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {
+    protected rules: RuleDefs;
+    protected readonly factory: CoreFactory;
+    protected __context: Context | undefined;
+    protected origSource: string;
+    protected generatedUntil: number;
+    protected expectsSpace: boolean;
+    protected readonly stringBuilder: string[];
+    constructor(rules: RuleDefs);
+    setContext(context: Context): void;
+    protected getSafeContext(): Context;
+    protected readonly subrule: RuleDefArg['SUBRULE'];
+    protected readonly handleLoc: RuleDefArg['HANDLE_LOC'];
+    protected readonly catchup: RuleDefArg['CATCHUP'];
+    protected readonly print: RuleDefArg['PRINT'];
+    private readonly printWord;
+    private readonly printSpaceLeft;
+    private readonly printWords;
+}