@traqula/core 0.0.18 → 0.0.20

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

@@ -31,40 +31,36 @@ export interface RuleDefArg {
      * @param rule the rule to be called
      * @param input the ast input to work on
      * @param arg the remaining parameters required by this rule.
-     * @constructor
      */
     SUBRULE: <T, U extends any[]>(rule: GeneratorRule<any, any, T, U>, input: T, ...arg: U) => void;
     /**
      * Print the characters to the output string
      * @param args arguments to be printed
-     * @constructor
      */
     PRINT: (...args: string[]) => void;
     /**
-     * Print the character  to the output stream ensuring there is a space to the left oif what you print.
-     * If a space was printed right before this, it will not print a space.
-     * @param args
-     * @constructor
-     */
-    PRINT_SPACE_LEFT: (...args: string[]) => void;
-    /**
-     * Prints all arguments as one word, ensuring it has a space before and behind each word
-     * @param args
-     * @constructor
+     * Ensures the requested characters are printed at the current location.
+     * Will not change the constructed string in case either:
+     *  1. The string builder ends in the to ensure string.
+     *  2: The next printed string starts with the ensure string.
+     * Otherwise, prints the sting.
      */
-    PRINT_WORD: (...args: string[]) => void;
+    ENSURE: (...args: string[]) => void;
     /**
-     * Prints all arguments as words, ensuring they all have a space before and behind them.
-     * @param args
-     * @constructor
+     * Ensures either one of the provided strings. If no string can be ensured, it will print the first argument.
      */
-    PRINT_WORDS: (...args: string[]) => void;
+    ENSURE_EITHER: (...args: string[]) => void;
     /**
-     * Ensures that what you print is on a newline with the indentation equal to the indentation currently setup.
-     * @param args
-     * @constructor
+     * Create a new line, will ensure the previous line does not end in blank characters.
+     * Will only print a newline if the pointer is not currently on a new line.
+     * When the traqulaIndentation is changed in the meanwhile, this will ensure the indentation of teh pointer updated.
      */
-    PRINT_ON_EMPTY: (...args: string[]) => void;
+    NEW_LINE: (arg?: {
+        /**
+         * Whether the newline should be printed regardless of the pointer is already on an empty newline.
+         */
+        force?: boolean;
+    }) => void;
     /**
      * Handles the location of a node as if it was generated using a SUBRULE.
      * Can be used to generate many nodes within a single subrule call while still having correct localization handling.
@@ -80,4 +76,22 @@ export interface RuleDefArg {
      * @constructor
      */
     CATCHUP: (until: number) => void;
+    /**
+     * Prints all arguments as one word, ensuring it has a space before and behind each word
+     * @param args
+     */
+    PRINT_WORD: (...args: string[]) => void;
+    /**
+     * Prints all arguments as words, ensuring they all have a space before and behind them.
+     * @param args
+     */
+    PRINT_WORDS: (...args: string[]) => void;
+    /**
+     * Start a newline to print arguments on
+     */
+    PRINT_ON_EMPTY: (...args: string[]) => void;
+    /**
+     * Prints arguments on its own (shared) line
+     */
+    PRINT_ON_OWN_LINE: (...args: string[]) => void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"generatorTypes.js","sourceRoot":"","sources":["generatorTypes.ts"],"names":[],"mappings":"","sourcesContent":["import type { Localized } from '../nodeTypings.js';\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  AstType = any,\n  /**\n   * Function arguments that can be given to convey the state of the current parse operation.\n   */\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  gImpl: (def: RuleDefArg) =>\n  (ast: AstType, context: Context, ...params: ParamType) => void;\n};\n\nexport interface RuleDefArg {\n  /**\n   * Call another generator rule so it can generate its string representation.\n   * @param rule the rule to be called\n   * @param input the ast input to work on\n   * @param arg the remaining parameters required by this rule.\n   * @constructor\n   */\n  SUBRULE: <T, U extends any[]>(rule: GeneratorRule<any, any, T, U>, input: T, ...arg: U) => void;\n  /**\n   * Print the characters to the output string\n   * @param args arguments to be printed\n   * @constructor\n   */\n  PRINT: (...args: string[]) => void;\n  /**\n   * Print the character  to the output stream ensuring there is a space to the left oif what you print.\n   * If a space was printed right before this, it will not print a space.\n   * @param args\n   * @constructor\n   */\n  PRINT_SPACE_LEFT: (...args: string[]) => void;\n  /**\n   * Prints all arguments as one word, ensuring it has a space before and behind each word\n   * @param args\n   * @constructor\n   */\n  PRINT_WORD: (...args: string[]) => void;\n  /**\n   * Prints all arguments as words, ensuring they all have a space before and behind them.\n   * @param args\n   * @constructor\n   */\n  PRINT_WORDS: (...args: string[]) => void;\n  /**\n   * Ensures that what you print is on a newline with the indentation equal to the indentation currently setup.\n   * @param args\n   * @constructor\n   */\n  PRINT_ON_EMPTY: (...args: string[]) => void;\n  /**\n   * Handles the location of a node as if it was generated using a SUBRULE.\n   * Can be used to generate many nodes within a single subrule call while still having correct localization handling.\n   * @param loc\n   * @param nodeHandle\n   * @constructor\n   */\n  HANDLE_LOC: <T>(loc: Localized, nodeHandle: () => T) => T | undefined;\n  /**\n   * Catchup the string until a given length,\n   * printing everything from the current catchup location until the index you provide.\n   * @param until\n   * @constructor\n   */\n  CATCHUP: (until: number) => void;\n}\n"]}
+{"version":3,"file":"generatorTypes.js","sourceRoot":"","sources":["generatorTypes.ts"],"names":[],"mappings":"","sourcesContent":["import type { Localized } from '../nodeTypings.js';\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  AstType = any,\n  /**\n   * Function arguments that can be given to convey the state of the current parse operation.\n   */\n  ParamType extends any[] = any[],\n> = {\n  name: NameType;\n  gImpl: (def: RuleDefArg) =>\n  (ast: AstType, context: Context, ...params: ParamType) => void;\n};\n\nexport interface RuleDefArg {\n  /**\n   * Call another generator rule so it can generate its string representation.\n   * @param rule the rule to be called\n   * @param input the ast input to work on\n   * @param arg the remaining parameters required by this rule.\n   */\n  SUBRULE: <T, U extends any[]>(rule: GeneratorRule<any, any, T, U>, input: T, ...arg: U) => void;\n  /**\n   * Print the characters to the output string\n   * @param args arguments to be printed\n   */\n  PRINT: (...args: string[]) => void;\n  /**\n   * Ensures the requested characters are printed at the current location.\n   * Will not change the constructed string in case either:\n   *  1. The string builder ends in the to ensure string.\n   *  2: The next printed string starts with the ensure string.\n   * Otherwise, prints the sting.\n   */\n  ENSURE: (...args: string[]) => void;\n  /**\n   * Ensures either one of the provided strings. If no string can be ensured, it will print the first argument.\n   */\n  ENSURE_EITHER: (...args: string[]) => void;\n  /**\n   * Create a new line, will ensure the previous line does not end in blank characters.\n   * Will only print a newline if the pointer is not currently on a new line.\n   * When the traqulaIndentation is changed in the meanwhile, this will ensure the indentation of teh pointer updated.\n   */\n  NEW_LINE: (arg?: {\n    /**\n     * Whether the newline should be printed regardless of the pointer is already on an empty newline.\n     */\n    force?: boolean;\n  }) => void;\n  /**\n   * Handles the location of a node as if it was generated using a SUBRULE.\n   * Can be used to generate many nodes within a single subrule call while still having correct localization handling.\n   * @param loc\n   * @param nodeHandle\n   * @constructor\n   */\n  HANDLE_LOC: <T>(loc: Localized, nodeHandle: () => T) => T | undefined;\n  /**\n   * Catchup the string until a given length,\n   * printing everything from the current catchup location until the index you provide.\n   * @param until\n   * @constructor\n   */\n  CATCHUP: (until: number) => void;\n\n  // Derivations from the above fundamental functions\n  /**\n   * Prints all arguments as one word, ensuring it has a space before and behind each word\n   * @param args\n   */\n  PRINT_WORD: (...args: string[]) => void;\n  /**\n   * Prints all arguments as words, ensuring they all have a space before and behind them.\n   * @param args\n   */\n  PRINT_WORDS: (...args: string[]) => void;\n  /**\n   * Start a newline to print arguments on\n   */\n  PRINT_ON_EMPTY: (...args: string[]) => void;\n  /**\n   * Prints arguments on its own (shared) line\n   */\n  PRINT_ON_OWN_LINE: (...args: string[]) => void;\n}\n"]}