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

package/lib/generator-builder/dynamicGenerator.js

@@ -0,0 +1,115 @@
+import { CoreFactory } from '../CoreFactory';
+export class DynamicGenerator {
+    constructor(rules) {
+        this.rules = rules;
+        this.factory = new CoreFactory();
+        this.__context = undefined;
+        this.origSource = '';
+        this.generatedUntil = 0;
+        this.stringBuilder = [];
+        this.subrule = (cstDef, ast, arg) => {
+            const def = this.rules[cstDef.name];
+            if (!def) {
+                throw new Error(`Rule ${cstDef.name} not found`);
+            }
+            const generate = () => def.gImpl({
+                SUBRULE: this.subrule,
+                PRINT: this.print,
+                PRINT_SPACE_LEFT: this.printSpaceLeft,
+                PRINT_WORD: this.printWord,
+                PRINT_WORDS: this.printWords,
+                CATCHUP: this.catchup,
+                HANDLE_LOC: this.handleLoc,
+            })(ast, this.getSafeContext(), arg);
+            if (this.factory.isLocalized(ast)) {
+                this.handleLoc(ast, generate);
+            }
+            else {
+                generate();
+            }
+        };
+        this.handleLoc = (localized, handle) => {
+            if (this.factory.isSourceLocationNoMaterialize(localized.loc)) {
+                return;
+            }
+            if (this.factory.isSourceLocationStringReplace(localized.loc)) {
+                this.catchup(localized.loc.start);
+                this.print(localized.loc.newSource);
+                this.generatedUntil = localized.loc.end;
+                return;
+            }
+            if (this.factory.isSourceLocationNodeReplace(localized.loc)) {
+                this.catchup(localized.loc.start);
+                this.generatedUntil = localized.loc.end;
+            }
+            if (this.factory.isSourceLocationSource(localized.loc)) {
+                this.catchup(localized.loc.start);
+            }
+            // If autoGenerate - do nothing
+            const ret = handle();
+            if (this.factory.isSourceLocationSource(localized.loc)) {
+                this.catchup(localized.loc.end);
+            }
+            return ret;
+        };
+        this.catchup = (until) => {
+            const start = this.generatedUntil;
+            if (start < until) {
+                this.print(this.origSource.slice(start, until));
+            }
+            this.generatedUntil = Math.max(this.generatedUntil, until);
+        };
+        this.print = (...args) => {
+            const pureArgs = args.filter(x => x.length > 0);
+            if (pureArgs.length > 0) {
+                const [head, ...tail] = pureArgs;
+                if (this.expectsSpace) {
+                    this.expectsSpace = false;
+                    const blanks = new Set(['\n', ' ', '\t']);
+                    if (this.stringBuilder.length > 0 &&
+                        !(blanks.has(head[0]) || blanks.has(this.stringBuilder.at(-1).at(-1)))) {
+                        this.stringBuilder.push(' ');
+                    }
+                }
+                this.stringBuilder.push(head);
+                this.stringBuilder.push(...tail);
+            }
+        };
+        this.printWord = (...args) => {
+            this.expectsSpace = true;
+            this.print(...args);
+            this.expectsSpace = true;
+        };
+        this.printSpaceLeft = (...args) => {
+            this.expectsSpace = true;
+            this.print(...args);
+        };
+        this.printWords = (...args) => {
+            for (const arg of args) {
+                this.printWord(arg);
+            }
+        };
+        // eslint-disable-next-line ts/no-unnecessary-type-assertion
+        for (const rule of Object.values(rules)) {
+            // Define function implementation
+            this[rule.name] =
+                ((input, context, args) => {
+                    this.expectsSpace = false;
+                    this.stringBuilder.length = 0;
+                    this.origSource = context.origSource;
+                    this.generatedUntil = context?.offset ?? 0;
+                    this.setContext(context);
+                    this.subrule(rule, input, args);
+                    this.catchup(this.origSource.length);
+                    return this.stringBuilder.join('');
+                });
+        }
+    }
+    setContext(context) {
+        this.__context = context;
+    }
+    getSafeContext() {
+        return this.__context;
+    }
+}
+//# sourceMappingURL=dynamicGenerator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dynamicGenerator.js","sourceRoot":"","sources":["dynamicGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAI7C,MAAM,OAAO,gBAAgB;IAQ3B,YAA6B,KAAe;QAAf,UAAK,GAAL,KAAK,CAAU;QAPzB,YAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QACrC,cAAS,GAAwB,SAAS,CAAC;QAC3C,eAAU,GAAG,EAAE,CAAC;QAChB,mBAAc,GAAG,CAAC,CAAC;QAEV,kBAAa,GAAa,EAAE,CAAC;QA+B7B,YAAO,GAA0B,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;YACvE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAS,MAAM,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,QAAQ,MAAM,CAAC,IAAI,YAAY,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,QAAQ,GAAG,GAAS,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;gBACrC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,gBAAgB,EAAE,IAAI,CAAC,cAAc;gBACrC,UAAU,EAAE,IAAI,CAAC,SAAS;gBAC1B,WAAW,EAAE,IAAI,CAAC,UAAU;gBAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,UAAU,EAAE,IAAI,CAAC,SAAS;aAC3B,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,EAAE,EAAE,GAAG,CAAC,CAAC;YAEpC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,QAAQ,EAAE,CAAC;YACb,CAAC;QACH,CAAC,CAAC;QAEiB,cAAS,GAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE;YAC7E,IAAI,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9D,OAAO;YACT,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACpC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;gBACxC,OAAO;YACT,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;YAC1C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACpC,CAAC;YACD,+BAA+B;YAE/B,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC;YAErB,IAAI,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEiB,YAAO,GAA0B,CAAC,KAAK,EAAE,EAAE;YAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC;YAClC,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC;QAEiB,UAAK,GAAwB,CAAC,GAAG,IAAI,EAAE,EAAE;YAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAChD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,CAAE,IAAI,EAAE,GAAG,IAAI,CAAE,GAAG,QAAQ,CAAC;gBACnC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACtB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;oBAC1B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAE,CAAC,CAAC;oBAC5C,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;wBAC/B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,EAAE,CAAC;wBAC3E,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACnC,CAAC;QACH,CAAC,CAAC;QAEe,cAAS,GAA6B,CAAC,GAAG,IAAI,EAAE,EAAE;YACjE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACpB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,CAAC,CAAC;QAEe,mBAAc,GAA6B,CAAC,GAAG,IAAI,EAAE,EAAE;YACtE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC;QAEe,eAAU,GAA6B,CAAC,GAAG,IAAI,EAAE,EAAE;YAClE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC;QAtHA,4DAA4D;QAC5D,KAAK,MAAM,IAAI,IAAsB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1D,iCAAiC;YACjC,IAAI,CAAuB,IAAI,CAAC,IAAI,CAAC;gBAC7B,CAAC,CAAC,KAAU,EAAE,OAA0D,EAAE,IAAS,EAAE,EAAE;oBAC3F,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;oBAC1B,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;oBAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;oBACrC,IAAI,CAAC,cAAc,GAAG,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC;oBAC3C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;oBAEzB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;oBAEhC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;oBAErC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACrC,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,OAAgB;QAChC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;IAC3B,CAAC;IAES,cAAc;QACtB,OAAiB,IAAI,CAAC,SAAS,CAAC;IAClC,CAAC;CA6FF","sourcesContent":["import { CoreFactory } from '../CoreFactory';\nimport type { GenRuleMap } from './builderTypes';\nimport type { GeneratorRule, RuleDefArg } from './generatorTypes';\n\nexport class DynamicGenerator<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  protected readonly factory = new CoreFactory();\n  protected __context: Context | undefined = undefined;\n  protected origSource = '';\n  protected generatedUntil = 0;\n  protected expectsSpace: boolean;\n  protected readonly stringBuilder: string[] = [];\n\n  public constructor(protected rules: RuleDefs) {\n    // eslint-disable-next-line ts/no-unnecessary-type-assertion\n    for (const rule of <GeneratorRule[]> Object.values(rules)) {\n      // Define function implementation\n      this[<keyof (typeof this)> rule.name] =\n        <any> ((input: any, context: Context & { origSource: string; offset?: number }, args: any) => {\n          this.expectsSpace = false;\n          this.stringBuilder.length = 0;\n          this.origSource = context.origSource;\n          this.generatedUntil = context?.offset ?? 0;\n          this.setContext(context);\n\n          this.subrule(rule, input, args);\n\n          this.catchup(this.origSource.length);\n\n          return this.stringBuilder.join('');\n        });\n    }\n  }\n\n  public setContext(context: Context): void {\n    this.__context = context;\n  }\n\n  protected getSafeContext(): Context {\n    return <Context> this.__context;\n  }\n\n  protected readonly subrule: RuleDefArg['SUBRULE'] = (cstDef, ast, arg) => {\n    const def = this.rules[<Names> cstDef.name];\n    if (!def) {\n      throw new Error(`Rule ${cstDef.name} not found`);\n    }\n\n    const generate = (): void => def.gImpl({\n      SUBRULE: this.subrule,\n      PRINT: this.print,\n      PRINT_SPACE_LEFT: this.printSpaceLeft,\n      PRINT_WORD: this.printWord,\n      PRINT_WORDS: this.printWords,\n      CATCHUP: this.catchup,\n      HANDLE_LOC: this.handleLoc,\n    })(ast, this.getSafeContext(), arg);\n\n    if (this.factory.isLocalized(ast)) {\n      this.handleLoc(ast, generate);\n    } else {\n      generate();\n    }\n  };\n\n  protected readonly handleLoc: RuleDefArg['HANDLE_LOC'] = (localized, handle) => {\n    if (this.factory.isSourceLocationNoMaterialize(localized.loc)) {\n      return;\n    }\n    if (this.factory.isSourceLocationStringReplace(localized.loc)) {\n      this.catchup(localized.loc.start);\n      this.print(localized.loc.newSource);\n      this.generatedUntil = localized.loc.end;\n      return;\n    }\n    if (this.factory.isSourceLocationNodeReplace(localized.loc)) {\n      this.catchup(localized.loc.start);\n      this.generatedUntil = localized.loc.end;\n    }\n    if (this.factory.isSourceLocationSource(localized.loc)) {\n      this.catchup(localized.loc.start);\n    }\n    // If autoGenerate - do nothing\n\n    const ret = handle();\n\n    if (this.factory.isSourceLocationSource(localized.loc)) {\n      this.catchup(localized.loc.end);\n    }\n    return ret;\n  };\n\n  protected readonly catchup: RuleDefArg['CATCHUP'] = (until) => {\n    const start = this.generatedUntil;\n    if (start < until) {\n      this.print(this.origSource.slice(start, until));\n    }\n    this.generatedUntil = Math.max(this.generatedUntil, until);\n  };\n\n  protected readonly print: RuleDefArg['PRINT'] = (...args) => {\n    const pureArgs = args.filter(x => x.length > 0);\n    if (pureArgs.length > 0) {\n      const [ head, ...tail ] = pureArgs;\n      if (this.expectsSpace) {\n        this.expectsSpace = false;\n        const blanks = new Set([ '\\n', ' ', '\\t' ]);\n        if (this.stringBuilder.length > 0 &&\n          !(blanks.has(head[0]) || blanks.has(this.stringBuilder.at(-1)!.at(-1)!))) {\n          this.stringBuilder.push(' ');\n        }\n      }\n      this.stringBuilder.push(head);\n      this.stringBuilder.push(...tail);\n    }\n  };\n\n  private readonly printWord: RuleDefArg['PRINT_WORD'] = (...args) => {\n    this.expectsSpace = true;\n    this.print(...args);\n    this.expectsSpace = true;\n  };\n\n  private readonly printSpaceLeft: RuleDefArg['PRINT_WORD'] = (...args) => {\n    this.expectsSpace = true;\n    this.print(...args);\n  };\n\n  private readonly printWords: RuleDefArg['PRINT_WORD'] = (...args) => {\n    for (const arg of args) {\n      this.printWord(arg);\n    }\n  };\n}\n"]}

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

@@ -0,0 +1,59 @@
+import type { CheckOverlap } from '../utils';
+import type { GeneratorFromRules, GenRuleMap, GenRulesToObject, GenNamesFromList } from './builderTypes';
+import type { GeneratorRule } from './generatorTypes';
+export declare class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {
+    /**
+     * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.
+     * If a GeneratorBuilder is provided, a new copy will be created.
+     */
+    static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(args: GeneratorBuilder<Context, Names, RuleDefs>): GeneratorBuilder<Context, Names, RuleDefs>;
+    static create<Rules extends readonly GeneratorRule[] = readonly GeneratorRule[], Context = Rules[0] extends GeneratorRule<infer context> ? context : never, Names extends string = GenNamesFromList<Rules>, RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>>(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;
+    private rules;
+    private constructor();
+    widenContext<NewContext extends Context>(): GeneratorBuilder<NewContext, Names, RuleDefs>;
+    typePatch<Patch extends {
+        [Key in Names]?: any;
+    }>(): GeneratorBuilder<Context, Names, {
+        [Key in Names]: Key extends keyof Patch ? (RuleDefs[Key] extends GeneratorRule<Context, Key, any, infer Args> ? GeneratorRule<Context, Key, Patch[Key], Args> : never) : (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never);
+    }>;
+    /**
+     * Change the implementation of an existing generator rule.
+     */
+    patchRule<U extends Names, RET, ARGS>(patch: GeneratorRule<Context, U, RET, ARGS>): GeneratorBuilder<Context, Names, {
+        [Key in Names]: Key extends U ? GeneratorRule<Context, Key, RET, ARGS> : (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never);
+    }>;
+    /**
+     * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.
+     */
+    addRuleRedundant<U extends string, RET, ARGS>(rule: GeneratorRule<Context, U, RET, ARGS>): GeneratorBuilder<Context, Names | U, {
+        [K in Names | U]: K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never);
+    }>;
+    /**
+     * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.
+     */
+    addRule<U extends string, RET, ARGS>(rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>): GeneratorBuilder<Context, Names | U, {
+        [K in Names | U]: K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never);
+    }>;
+    addMany<U extends readonly GeneratorRule<Context>[]>(...rules: CheckOverlap<GenNamesFromList<U>, Names, U>): GeneratorBuilder<Context, Names | GenNamesFromList<U>, {
+        [K in Names | GenNamesFromList<U>]: K extends keyof GenRulesToObject<typeof rules> ? (GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never) : (K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never);
+    }>;
+    /**
+     * Delete a grammar rule by its name.
+     */
+    deleteRule<U extends Names>(ruleName: U): GeneratorBuilder<Context, Exclude<Names, U>, {
+        [K in Exclude<Names, U>]: RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never;
+    }>;
+    /**
+     * Merge this grammar GeneratorBuilder with another.
+     * It is best to merge the bigger grammar with the smaller one.
+     * If the two builders both have a grammar rule with the same name,
+     * no error will be thrown case they map to the same ruledef object.
+     * If they map to a different object, an error will be thrown.
+     * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,
+     * this rule implementation will be used.
+     */
+    merge<OtherNames extends string, OtherRules extends GenRuleMap<OtherNames>, OW extends readonly GeneratorRule<Context>[]>(GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>, overridingRules: OW): GeneratorBuilder<Context, Names | OtherNames | GenNamesFromList<OW>, {
+        [K in Names | OtherNames | GenNamesFromList<OW>]: K extends keyof GenRulesToObject<OW> ? (GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never) : (K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never) : never);
+    }>;
+    build(): GeneratorFromRules<Context, Names, RuleDefs>;
+}

package/lib/generator-builder/generatorBuilder.js

@@ -0,0 +1,104 @@
+import { DynamicGenerator } from './dynamicGenerator';
+/**
+ * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.
+ */
+function listToRuleDefMap(rules) {
+    const newRules = {};
+    for (const rule of rules) {
+        newRules[rule.name] = rule;
+    }
+    return newRules;
+}
+export class GeneratorBuilder {
+    static create(start) {
+        if (start instanceof GeneratorBuilder) {
+            return new GeneratorBuilder({ ...start.rules });
+        }
+        return new GeneratorBuilder(listToRuleDefMap(start));
+    }
+    constructor(startRules) {
+        this.rules = startRules;
+    }
+    widenContext() {
+        return this;
+    }
+    typePatch() {
+        return this;
+    }
+    /**
+     * Change the implementation of an existing generator rule.
+     */
+    patchRule(patch) {
+        const self = this;
+        self.rules[patch.name] = patch;
+        return self;
+    }
+    /**
+     * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.
+     */
+    addRuleRedundant(rule) {
+        const self = this;
+        const rules = self.rules;
+        if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {
+            throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);
+        }
+        rules[rule.name] = rule;
+        return self;
+    }
+    /**
+     * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.
+     */
+    addRule(rule) {
+        return this.addRuleRedundant(rule);
+    }
+    addMany(...rules) {
+        this.rules = { ...this.rules, ...listToRuleDefMap(rules) };
+        return this;
+    }
+    /**
+     * Delete a grammar rule by its name.
+     */
+    deleteRule(ruleName) {
+        delete this.rules[ruleName];
+        return this;
+    }
+    /**
+     * Merge this grammar GeneratorBuilder with another.
+     * It is best to merge the bigger grammar with the smaller one.
+     * If the two builders both have a grammar rule with the same name,
+     * no error will be thrown case they map to the same ruledef object.
+     * If they map to a different object, an error will be thrown.
+     * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,
+     * this rule implementation will be used.
+     */
+    merge(GeneratorBuilder, overridingRules) {
+        // Assume the other grammar is bigger than yours. So start from that one and add this one
+        const otherRules = { ...GeneratorBuilder.rules };
+        const myRules = this.rules;
+        for (const rule of Object.values(myRules)) {
+            if (otherRules[rule.name] === undefined) {
+                otherRules[rule.name] = rule;
+            }
+            else {
+                const existingRule = otherRules[rule.name];
+                // If same rule, no issue, move on. Else
+                if (existingRule !== rule) {
+                    const override = overridingRules.find(x => x.name === rule.name);
+                    // If override specified, take override, else, inform user that there is a conflict
+                    if (override) {
+                        otherRules[rule.name] = override;
+                    }
+                    else {
+                        throw new Error(`Rule with name "${rule.name}" already exists in the GeneratorBuilder, specify an override to resolve conflict`);
+                    }
+                }
+            }
+        }
+        this.rules = otherRules;
+        return this;
+    }
+    build() {
+        return new DynamicGenerator(this.rules);
+    }
+}
+//# sourceMappingURL=generatorBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generatorBuilder.js","sourceRoot":"","sources":["generatorBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;GAEG;AACH,SAAS,gBAAgB,CAAqC,KAAQ;IACpE,MAAM,QAAQ,GAAkC,EAAE,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,CAAC;IACD,OAA4B,QAAQ,CAAC;AACvC,CAAC;AAED,MAAM,OAAO,gBAAgB;IAcpB,MAAM,CAAC,MAAM,CAMlB,KAAyD;QAEzD,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;YACtC,OAAO,IAAI,gBAAgB,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,OAA8D,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9G,CAAC;IAID,YAAoB,UAAoB;QACtC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;IAC1B,CAAC;IAEM,YAAY;QACjB,OAAiE,IAAI,CAAC;IACxE,CAAC;IAEM,SAAS;QAKd,OAG8F,IAAI,CAAC;IACrG,CAAC;IAED;;OAEG;IACI,SAAS,CAA6B,KAA2C;QAKtF,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAS,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAA8B,IAA0C;QAK7F,MAAM,IAAI,GAGE,IAAI,CAAC;QACjB,MAAM,KAAK,GAA4C,IAAI,CAAC,KAAK,CAAC;QAClE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;QAC9E,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO,CACZ,IAAkE;QAKlE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,GAAG,KAAkD;QAYrD,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,UAAU,CAAkB,QAAW;QAG5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,OAEY,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAKV,gBAAmE,EACnE,eAAmB;QAenB,yFAAyF;QACzF,MAAM,UAAU,GAA2C,EAAE,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzF,MAAM,OAAO,GAA2C,IAAI,CAAC,KAAK,CAAC;QAEnE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3C,wCAAwC;gBACxC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjE,mFAAmF;oBACnF,IAAI,QAAQ,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;oBACnC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,IAAI,mFAAmF,CAAC,CAAC;oBACnI,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAmB,UAAU,CAAC;QACxC,OAAuB,IAAI,CAAC;IAC9B,CAAC;IAEM,KAAK;QACV,OAAsD,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC;CACF","sourcesContent":["import type { CheckOverlap } from '../utils';\nimport type { GeneratorFromRules, GenRuleMap, GenRulesToObject, GenNamesFromList } from './builderTypes';\nimport { DynamicGenerator } from './dynamicGenerator';\nimport type { GeneratorRule } from './generatorTypes';\n\n/**\n * Converts a list of ruledefs to a record mapping a name to the corresponding ruledef.\n */\nfunction listToRuleDefMap<T extends readonly GeneratorRule[]>(rules: T): GenRulesToObject<T> {\n  const newRules: Record<string, GeneratorRule> = {};\n  for (const rule of rules) {\n    newRules[rule.name] = rule;\n  }\n  return <GenRulesToObject<T>>newRules;\n}\n\nexport class GeneratorBuilder<Context, Names extends string, RuleDefs extends GenRuleMap<Names>> {\n  /**\n   * Create a GeneratorBuilder from some initial grammar rules or an existing GeneratorBuilder.\n   * If a GeneratorBuilder is provided, a new copy will be created.\n   */\n  public static create<Context, Names extends string, RuleDefs extends GenRuleMap<Names>>(\n    args: GeneratorBuilder<Context, Names, RuleDefs>\n  ): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = GenNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(rules: Rules): GeneratorBuilder<Context, Names, RuleDefs>;\n  public static create<\n    Rules extends readonly GeneratorRule[] = readonly GeneratorRule[],\n    Context = Rules[0] extends GeneratorRule<infer context> ? context : never,\n    Names extends string = GenNamesFromList<Rules>,\n    RuleDefs extends GenRuleMap<Names> = GenRulesToObject<Rules>,\n  >(\n    start: Rules | GeneratorBuilder<Context, Names, RuleDefs>,\n  ): GeneratorBuilder<Context, Names, RuleDefs> {\n    if (start instanceof GeneratorBuilder) {\n      return new GeneratorBuilder({ ...start.rules });\n    }\n    return <GeneratorBuilder<Context, Names, RuleDefs>> <unknown> new GeneratorBuilder(listToRuleDefMap(start));\n  }\n\n  private rules: RuleDefs;\n\n  private constructor(startRules: RuleDefs) {\n    this.rules = startRules;\n  }\n\n  public widenContext<NewContext extends Context>(): GeneratorBuilder<NewContext, Names, RuleDefs> {\n    return <GeneratorBuilder<NewContext, Names, RuleDefs>> <unknown> this;\n  }\n\n  public typePatch<Patch extends {[Key in Names]?: any }>():\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n    RuleDefs[Key] extends GeneratorRule<Context, Key, any, infer Args> ?\n      GeneratorRule<Context, Key, Patch[Key], Args> : never\n  ) : (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }> {\n    return <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends keyof Patch ? (\n      RuleDefs[Key] extends GeneratorRule<Context, Key, any, infer Args> ?\n        GeneratorRule<Context, Key, Patch[Key], Args> : never\n    ) : (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>> <unknown> this;\n  }\n\n  /**\n   * Change the implementation of an existing generator rule.\n   */\n  public patchRule<U extends Names, RET, ARGS>(patch: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n    GeneratorRule<Context, Key, RET, ARGS> :\n      (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never)\n  } > {\n    const self = <GeneratorBuilder<Context, Names, {[Key in Names]: Key extends U ?\n      GeneratorRule<Context, Key, RET, ARGS> :\n        (RuleDefs[Key] extends GeneratorRule<Context, Key> ? RuleDefs[Key] : never) }>>\n      <unknown> this;\n    self.rules[patch.name] = <any> patch;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.\n   */\n  public addRuleRedundant<U extends string, RET, ARGS>(rule: GeneratorRule<Context, U, RET, ARGS>):\n  GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    const self = <GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n        (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n      : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never) }>>\n      <unknown> this;\n    const rules = <Record<string, GeneratorRule<Context>>> self.rules;\n    if (rules[rule.name] !== undefined && rules[rule.name] !== rule) {\n      throw new Error(`Rule ${rule.name} already exists in the GeneratorBuilder`);\n    }\n    rules[rule.name] = rule;\n    return self;\n  }\n\n  /**\n   * Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.\n   */\n  public addRule<U extends string, RET, ARGS>(\n    rule: CheckOverlap<U, Names, GeneratorRule<Context, U, RET, ARGS>>,\n  ): GeneratorBuilder<Context, Names | U, {[K in Names | U]: K extends Names ?\n      (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n    : (K extends U ? GeneratorRule<Context, K, RET, ARGS> : never)\n  }> {\n    return this.addRuleRedundant(rule);\n  }\n\n  public addMany<U extends readonly GeneratorRule<Context>[]>(\n    ...rules: CheckOverlap<GenNamesFromList<U>, Names, U>\n  ): GeneratorBuilder<\n    Context,\n    Names | GenNamesFromList<U>,\n    {[K in Names | GenNamesFromList<U>]:\n      K extends keyof GenRulesToObject<typeof rules> ? (\n        GenRulesToObject<typeof rules>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<typeof rules>[K] : never\n      ) : (\n        K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never) : never\n      )\n    }\n  > {\n    this.rules = { ...this.rules, ...listToRuleDefMap(rules) };\n    return <any> <unknown> this;\n  }\n\n  /**\n   * Delete a grammar rule by its name.\n   */\n  public deleteRule<U extends Names>(ruleName: U):\n  GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n    RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }> {\n    delete this.rules[ruleName];\n    return <GeneratorBuilder<Context, Exclude<Names, U>, {[K in Exclude<Names, U>]:\n      RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never }>>\n      <unknown> this;\n  }\n\n  /**\n   * Merge this grammar GeneratorBuilder with another.\n   * It is best to merge the bigger grammar with the smaller one.\n   * If the two builders both have a grammar rule with the same name,\n   * no error will be thrown case they map to the same ruledef object.\n   * If they map to a different object, an error will be thrown.\n   * To fix this problem, the overridingRules array should contain a rule with the same conflicting name,\n   * this rule implementation will be used.\n   */\n  public merge<\n    OtherNames extends string,\n    OtherRules extends GenRuleMap<OtherNames>,\n    OW extends readonly GeneratorRule<Context>[],\n  >(\n    GeneratorBuilder: GeneratorBuilder<Context, OtherNames, OtherRules>,\n    overridingRules: OW,\n  ):\n    GeneratorBuilder<\n      Context,\n      Names | OtherNames | GenNamesFromList<OW>,\n      {[K in Names | OtherNames | GenNamesFromList<OW>]:\n        K extends keyof GenRulesToObject<OW> ? (\n          GenRulesToObject<OW>[K] extends GeneratorRule<Context, K> ? GenRulesToObject<OW>[K] : never\n        )\n          : (\n              K extends Names ? (RuleDefs[K] extends GeneratorRule<Context, K> ? RuleDefs[K] : never)\n                : K extends OtherNames ? (OtherRules[K] extends GeneratorRule<Context, K> ? OtherRules[K] : never)\n                  : never\n            ) }\n    > {\n    // Assume the other grammar is bigger than yours. So start from that one and add this one\n    const otherRules: Record<string, GeneratorRule<Context>> = { ...GeneratorBuilder.rules };\n    const myRules: Record<string, GeneratorRule<Context>> = this.rules;\n\n    for (const rule of Object.values(myRules)) {\n      if (otherRules[rule.name] === undefined) {\n        otherRules[rule.name] = rule;\n      } else {\n        const existingRule = otherRules[rule.name];\n        // If same rule, no issue, move on. Else\n        if (existingRule !== rule) {\n          const override = overridingRules.find(x => x.name === rule.name);\n          // If override specified, take override, else, inform user that there is a conflict\n          if (override) {\n            otherRules[rule.name] = override;\n          } else {\n            throw new Error(`Rule with name \"${rule.name}\" already exists in the GeneratorBuilder, specify an override to resolve conflict`);\n          }\n        }\n      }\n    }\n\n    this.rules = <any> <unknown> otherRules;\n    return <any> <unknown> this;\n  }\n\n  public build(): GeneratorFromRules<Context, Names, RuleDefs> {\n    return <GeneratorFromRules<Context, Names, RuleDefs>> new DynamicGenerator(this.rules);\n  }\n}\n"]}

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

@@ -0,0 +1,36 @@
+import type { Localized } from '../nodeTypings';
+/**
+ * Type used to declare generator rules.
+ */
+export type GeneratorRule<
+/**
+ * Context object available in rule implementation.
+ */
+Context = any, 
+/**
+ * Name of grammar rule, should be a strict subtype of string like 'myGrammarRule'.
+ */
+NameType extends string = string, 
+/**
+ * Type that of the AST that we will generate the string for.
+ * This type will be the provided when calling SUBRULE with this generator rule.
+ * Generation happens on a per AST node basis.
+ * The core will implement the generation as such. If this ever changes, we will cross that bridge when we get there.
+ */
+ReturnType = any, 
+/**
+ * Function arguments that can be given to convey the state of the current parse operation.
+ */
+ParamType = any> = {
+    name: NameType;
+    gImpl: (def: RuleDefArg) => (ast: ReturnType, context: Context, params: ParamType) => void;
+};
+export interface RuleDefArg {
+    SUBRULE: <T, U>(cstDef: GeneratorRule<any, any, T, U>, input: T, arg: U) => void;
+    PRINT: (...args: string[]) => void;
+    PRINT_SPACE_LEFT: (...args: string[]) => void;
+    PRINT_WORD: (...args: string[]) => void;
+    PRINT_WORDS: (...args: string[]) => void;
+    HANDLE_LOC: <T>(loc: Localized, nodeHandle: () => T) => T | undefined;
+    CATCHUP: (until: number) => void;
+}

package/lib/generator-builder/generatorTypes.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generatorTypes.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generatorTypes.js","sourceRoot":"","sources":["generatorTypes.ts"],"names":[],"mappings":"","sourcesContent":["import type { Localized } from '../nodeTypings';\n\n/**\n * Type used to declare generator rules.\n */\nexport type GeneratorRule<\n  /**\n   * Context object available in rule implementation.\n   */\n  Context = any,\n  /**\n   * Name of grammar rule, should be a strict subtype of string like 'myGrammarRule'.\n   */\n  NameType extends string = string,\n  /**\n   * Type that of the AST that we will generate the string for.\n   * This type will be the provided when calling SUBRULE with this generator rule.\n   * Generation happens on a per AST node basis.\n   * The core will implement the generation as such. If this ever changes, we will cross that bridge when we get there.\n   */\n  ReturnType = any,\n  /**\n   * Function arguments that can be given to convey the state of the current parse operation.\n   */\n  ParamType = any,\n> = {\n  name: NameType;\n  gImpl: (def: RuleDefArg) =>\n  (ast: ReturnType, context: Context, params: ParamType) => void;\n};\n\nexport interface RuleDefArg {\n  SUBRULE: <T, U>(cstDef: GeneratorRule<any, any, T, U>, input: T, arg: U) => void;\n  PRINT: (...args: string[]) => void;\n  PRINT_SPACE_LEFT: (...args: string[]) => void;\n  PRINT_WORD: (...args: string[]) => void;\n  PRINT_WORDS: (...args: string[]) => void;\n  HANDLE_LOC: <T>(loc: Localized, nodeHandle: () => T) => T | undefined;\n  CATCHUP: (until: number) => void;\n}\n"]}