Class ParserBuilder<Context, Names, RuleDefs>

The grammar builder. This is the core of traqula (besides using the amazing chevrotain framework). Using the builder you can create a grammar + AST creator. At any point in time, a parser can be constructed from the added rules. Constructing a parser will cause a validation which will validate the correctness of the grammar.

Type Parameters

Context
Names extends string
RuleDefs extends ParseRuleMap<Names>

Index

Methods

addMany addRule addRuleRedundant build deleteRule merge patchRule typePatch widenContext create

Methods

addMany

addMany[]>(
 ...rules: CheckOverlap<ParseNamesFromList, Names, U>,
): ParserBuilder<
 Context,
 Names
 | ParseNamesFromList,
 {
 [K in string]: K extends keyof ParseRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >
 ? ParseRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
Type Parameters
- U extends readonly ParserRule<Context>[]
Parameters
- ...rules: CheckOverlap<ParseNamesFromList, Names, U>
Returns ParserBuilder<
 Context,
 Names
 | ParseNamesFromList,
 {
 [K in string]: K extends keyof ParseRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >
 ? ParseRulesToObject<
 CheckOverlap<ParseNamesFromList, Names, U, never>,
 ParseNamesFromList<CheckOverlap<ParseNamesFromList, Names, U, never>>,
 Record<never, never>,
 >[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
- Defined in parser-builder/parserBuilder.ts:121

addRule

addRule(
 rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>,
): ParserBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends U
 ? ParserRule<Context, K<K>, RET, ARGS>
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
Add a rule to the grammar. Will raise a typescript error if the rule already exists in the grammar.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- rule: CheckOverlap<U, Names, ParserRule<Context, U, RET, ARGS>>
Returns ParserBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends U
 ? ParserRule<Context, K<K>, RET, ARGS>
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
- Defined in parser-builder/parserBuilder.ts:113

addRuleRedundant

addRuleRedundant(
 rule: ParserRule<Context, U, RET, ARGS>,
): ParserBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends U
 ? ParserRule<Context, K<K>, RET, ARGS>
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
Add a rule to the grammar. If the rule already exists, but the implementation differs, an error will be thrown.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- rule: ParserRule<Context, U, RET, ARGS>
Returns ParserBuilder<
 Context,
 Names
 | U,
 {
 [K in string]: K extends U
 ? ParserRule<Context, K<K>, RET, ARGS>
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : never
 },
>
- Defined in parser-builder/parserBuilder.ts:93

build

build(
 __namedParameters: {
 errorHandler?: (errors: IRecognitionException[]) => void;
 lexerConfig?: ILexerConfig;
 parserConfig?: IParserConfig;
 queryPreProcessor?: (input: string) => string;
 tokenVocabulary: readonly TokenType[];
 },
): ParserFromRules<Context, Names, RuleDefs>
Parameters
- __namedParameters: {
 errorHandler?: (errors: IRecognitionException[]) => void;
 lexerConfig?: ILexerConfig;
 parserConfig?: IParserConfig;
 queryPreProcessor?: (input: string) => string;
 tokenVocabulary: readonly TokenType[];
 }
Returns ParserFromRules<Context, Names, RuleDefs>
- Defined in parser-builder/parserBuilder.ts:222

deleteRule

deleteRule(
 ruleName: U,
): ParserBuilder<
 Context,
 Exclude<Names, U>,
 {
 [K in string]: RuleDefs[K] extends ParserRule<Context, K>
 ? any[any]
 : never
 },
>
Delete a grammar rule by its name.
Type Parameters
- U extends string
Parameters
- ruleName: U
Returns ParserBuilder<
 Context,
 Exclude<Names, U>,
 {
 [K in string]: RuleDefs[K] extends ParserRule<Context, K>
 ? any[any]
 : never
 },
>
- Defined in parser-builder/parserBuilder.ts:141

merge

merge<
 OtherNames extends string,
 OtherRules extends ParseRuleMap<OtherNames>,
 OW extends readonly ParserRule<Context>[],
>(
 builder: ParserBuilder<Context, OtherNames, OtherRules>,
 overridingRules: OW,
): ParserBuilder<
 Context,
 Names
 | OtherNames
 | ParseNamesFromList<OW>,
 {
 [K in string]: K extends keyof ParseRulesToObject<OW>
 ? ParseRulesToObject<OW>[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : K extends OtherNames
 ? OtherRules[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
Merge this grammar builder 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.
Type Parameters
- OtherNames extends string
- OtherRules extends ParseRuleMap<OtherNames>
- OW extends readonly ParserRule<Context>[]
Parameters
- builder: ParserBuilder<Context, OtherNames, OtherRules>
- overridingRules: OW
Returns ParserBuilder<
 Context,
 Names
 | OtherNames
 | ParseNamesFromList<OW>,
 {
 [K in string]: K extends keyof ParseRulesToObject<OW>
 ? ParseRulesToObject<OW>[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : K extends Names
 ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
 : K extends OtherNames
 ? OtherRules[K<K>] extends ParserRule<Context, K<K>>
 ? any[any]
 : never
 : never
 },
>
- Defined in parser-builder/parserBuilder.ts:159

patchRule

patchRule(
 patch: ParserRule<Context, U, RET, ARGS>,
): ParserBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends U
 ? ParserRule<Context, Key<Key>, RET, ARGS>
 : RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never
 },
>
Change the implementation of an existing grammar rule.
Type Parameters
- U extends string
- RET
- ARGS extends any[]
Parameters
- patch: ParserRule<Context, U, RET, ARGS>
Returns ParserBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends U
 ? ParserRule<Context, Key<Key>, RET, ARGS>
 : RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never
 },
>
- Defined in parser-builder/parserBuilder.ts:78

typePatch

typePatch<Patch extends { [Key in string]?: [any] | [any, any] }>(): ParserBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends keyof Patch
 ? Patch[Key<Key>] extends [any, any]
 ? ParserRule<Context, Key<Key>, any[any][0], any[any][1]>
 : Patch[Key<Key>] extends [any]
 ? RuleDefs[Key<Key>] extends ParserRule<any, any, any, Par>
 ? ParserRule<Context, Key<Key>, any[any][0], Par>
 : never
 : never
 : RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never
 },
>
Type Parameters
- Patch extends { [Key in string]?: [any] | [any, any] }
Returns ParserBuilder<
 Context,
 Names,
 {
 [Key in string]: Key extends keyof Patch
 ? Patch[Key<Key>] extends [any, any]
 ? ParserRule<Context, Key<Key>, any[any][0], any[any][1]>
 : Patch[Key<Key>] extends [any]
 ? RuleDefs[Key<Key>] extends ParserRule<any, any, any, Par>
 ? ParserRule<Context, Key<Key>, any[any][0], Par>
 : never
 : never
 : RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never
 },
>
- Defined in parser-builder/parserBuilder.ts:62

widenContext

widenContext<NewContext>(): ParserBuilder<NewContext, Names, RuleDefs>
Type Parameters
- NewContext
Returns ParserBuilder<NewContext, Names, RuleDefs>
- Defined in parser-builder/parserBuilder.ts:58

`Static`create

create<
 Rules extends readonly ParserRule[] = readonly ParserRule[],
 Context = Rules[0] extends ParserRule<context> ? context : never,
 Names extends string = ParseNamesFromList<Rules>,
 RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>,
>(
 start: Rules | ParserBuilder<Context, Names, RuleDefs>,
): ParserBuilder<Context, Names, RuleDefs>
Create a builder from some initial grammar rules or an existing builder. If a builder is provided, a new copy will be created.
Type Parameters
- Rules extends readonly ParserRule[] = readonly ParserRule[]
- Context = Rules[0] extends ParserRule<context> ? context : never
- Names extends string = ParseNamesFromList<Rules>
- RuleDefs extends ParseRuleMap<Names> = ParseRulesToObject<Rules>
Parameters
- start: Rules | ParserBuilder<Context, Names, RuleDefs>
Returns ParserBuilder<Context, Names, RuleDefs>
- Defined in parser-builder/parserBuilder.ts:38

Class ParserBuilder<Context, Names, RuleDefs>

Type Parameters

Index

Methods

Methods

addMany

Type Parameters

Parameters

addRule

Type Parameters

Parameters

Returns ParserBuilder< Context, Names | U, { [K in string]: K extends U ? ParserRule<Context, K<K>, RET, ARGS> : K extends Names ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never : never },>

addRuleRedundant

Type Parameters

Parameters

Returns ParserBuilder< Context, Names | U, { [K in string]: K extends U ? ParserRule<Context, K<K>, RET, ARGS> : K extends Names ? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never : never },>

build

Parameters

Returns ParserFromRules<Context, Names, RuleDefs>

deleteRule

Type Parameters

Parameters

Returns ParserBuilder< Context, Exclude<Names, U>, { [K in string]: RuleDefs[K] extends ParserRule<Context, K> ? any[any] : never },>

merge

Type Parameters

Parameters

patchRule

Type Parameters

Parameters

Returns ParserBuilder< Context, Names, { [Key in string]: Key extends U ? ParserRule<Context, Key<Key>, RET, ARGS> : RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never },>

typePatch

Type Parameters

widenContext

Type Parameters

Returns ParserBuilder<NewContext, Names, RuleDefs>

Staticcreate

Type Parameters

Parameters

Returns ParserBuilder<Context, Names, RuleDefs>

Settings

On This Page

Returns ParserBuilder<
Context,
Names
| U,
{
[K in string]: K extends U
? ParserRule<Context, K<K>, RET, ARGS>
: K extends Names
? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
: never
},
>

Returns ParserBuilder<
Context,
Names
| U,
{
[K in string]: K extends U
? ParserRule<Context, K<K>, RET, ARGS>
: K extends Names
? RuleDefs[K<K>] extends ParserRule<Context, K<K>> ? any[any] : never
: never
},
>

Returns ParserBuilder<
Context,
Exclude<Names, U>,
{
[K in string]: RuleDefs[K] extends ParserRule<Context, K>
? any[any]
: never
},
>

Returns ParserBuilder<
Context,
Names,
{
[Key in string]: Key extends U
? ParserRule<Context, Key<Key>, RET, ARGS>
: RuleDefs[Key] extends ParserRule<Context, Key> ? any[any] : never
},
>

`Static`create