-
Notifications
You must be signed in to change notification settings - Fork 203
/
api.d.ts
2562 lines (2305 loc) · 73.4 KB
/
api.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export as namespace chevrotain
export declare const VERSION: string
export type ParserMethod<ARGS extends unknown[], R> = (...args: ARGS) => R
/**
* This class does not actually exists nor is exposed at runtime.
* This is just a helper to avoid duplications in the Type Definitions
* Of `CstParser` and `EmbeddedActionsParser`
*/
declare abstract class BaseParser {
/**
* This must be called at the end of a Parser constructor.
* See: http://chevrotain.io/docs/tutorial/step2_parsing.html#under-the-hood
*/
protected performSelfAnalysis(): void
/**
* It is recommended to reuse the same Parser instance
* by passing an empty array to the input argument
* and only later setting the input by using the input property.
* See: http://chevrotain.io/docs/FAQ.html#major-performance-benefits
*
* @param tokenVocabulary - A data structure containing all the Tokens used by the Parser.
* @param config - The Parser's configuration.
*/
constructor(tokenVocabulary: TokenVocabulary, config?: IParserConfig)
errors: IRecognitionException[]
/**
* Flag indicating the Parser is at the recording phase.
* Can be used to implement methods similar to {@link BaseParser.ACTION}
* Or any other logic to requires knowledge of the recording phase.
* See:
* - https://chevrotain.io/docs/guide/internals.html#grammar-recording
* to learn more on the recording phase and how Chevrotain works.
*/
RECORDING_PHASE: boolean
/**
* Resets the parser state, should be overridden for custom parsers which "carry" additional state.
* When overriding, remember to also invoke the super implementation!
*/
reset(): void
getBaseCstVisitorConstructor(): {
new (...args: any[]): ICstVisitor<any, any>
}
getBaseCstVisitorConstructorWithDefaults(): {
new (...args: any[]): ICstVisitor<any, any>
}
getGAstProductions(): Record<string, Rule>
getSerializedGastProductions(): ISerializedGast[]
/**
* @param startRuleName
* @param precedingInput - The token vector up to (not including) the content assist point
*/
computeContentAssist(
startRuleName: string,
precedingInput: IToken[]
): ISyntacticContentAssistPath[]
/**
* @param grammarRule - The rule to try and parse in backtracking mode.
* @param args - argument to be passed to the grammar rule execution
*
* @return a lookahead function that will try to parse the given grammarRule and will return true if succeed.
*/
protected BACKTRACK<T>(
grammarRule: (...args: any[]) => T,
args?: any[]
): () => boolean
/**
* The Semantic Actions wrapper.
* Should be used to wrap semantic actions that either:
* - May fail when executing in "recording phase".
* - Have global side effects that should be avoided during "recording phase".
*
* For more information see:
* - https://chevrotain.io/docs/guide/internals.html#grammar-recording
*/
protected ACTION<T>(impl: () => T): T
/**
* Like `CONSUME` with the numerical suffix as a parameter, e.g:
* consume(0, X) === CONSUME(X)
* consume(1, X) === CONSUME1(X)
* consume(2, X) === CONSUME2(X)
* ...
* @see CONSUME
*/
protected consume(
idx: number,
tokType: TokenType,
options?: ConsumeMethodOpts
): IToken
/**
* Like `OPTION` with the numerical suffix as a parameter, e.g:
* option(0, X) === OPTION(X)
* option(1, X) === OPTION1(X)
* option(2, X) === OPTION2(X)
* ...
* @see OPTION
*/
protected option<OUT>(
idx: number,
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* Like `OR` with the numerical suffix as a parameter, e.g:
* or(0, X) === OR(X)
* or(1, X) === OR1(X)
* or(2, X) === OR2(X)
* ...
* @see OR
*/
protected or(idx: number, altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
protected or<T>(idx: number, altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
/**
* Like `MANY` with the numerical suffix as a parameter, e.g:
* many(0, X) === MANY(X)
* many(1, X) === MANY1(X)
* many(2, X) === MANY2(X)
* ...
* @see MANY
*/
protected many(
idx: number,
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* Like `AT_LEAST_ONE` with the numerical suffix as a parameter, e.g:
* atLeastOne(0, X) === AT_LEAST_ONE(X)
* atLeastOne(1, X) === AT_LEAST_ONE1(X)
* atLeastOne(2, X) === AT_LEAST_ONE2(X)
* ...
* @see AT_LEAST_ONE
*/
protected atLeastOne(
idx: number,
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
*
* A Parsing DSL method use to consume a single Token.
* In EBNF terms this is equivalent to a Terminal.
*
* A Token will be consumed, IFF the next token in the token vector matches <tokType>.
* otherwise the parser may attempt to perform error recovery (if enabled).
*
* The index in the method name indicates the unique occurrence of a terminal consumption
* inside a the top level rule. What this means is that if a terminal appears
* more than once in a single rule, each appearance must have a **different** index.
*
* For example:
* ```
* this.RULE("qualifiedName", () => {
* this.CONSUME1(Identifier);
* this.MANY(() => {
* this.CONSUME1(Dot);
* // here we use CONSUME2 because the terminal
* // 'Identifier' has already appeared previously in the
* // the rule 'parseQualifiedName'
* this.CONSUME2(Identifier);
* });
* })
* ```
*
* - See more details on the [unique suffixes requirement](http://chevrotain.io/docs/FAQ.html#NUMERICAL_SUFFIXES).
*
* @param tokType - The Type of the token to be consumed.
* @param options - optional properties to modify the behavior of CONSUME.
*/
protected CONSUME(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME1(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME2(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME3(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME4(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME5(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME6(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME7(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME8(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* @see CONSUME
* @hidden
*/
protected CONSUME9(tokType: TokenType, options?: ConsumeMethodOpts): IToken
/**
* Parsing DSL Method that Indicates an Optional production.
* in EBNF notation this is equivalent to: "[...]".
*
* Note that there are two syntax forms:
* - Passing the grammar action directly:
* ```
* this.OPTION(() => {
* this.CONSUME(Digit)}
* );
* ```
*
* - using an "options" object:
* ```
* this.OPTION({
* GATE:predicateFunc,
* DEF: () => {
* this.CONSUME(Digit)
* }});
* ```
*
* The optional 'GATE' property in "options" object form can be used to add constraints
* to invoking the grammar action.
*
* As in CONSUME the index in the method name indicates the occurrence
* of the optional production in it's top rule.
*
* @param actionORMethodDef - The grammar action to optionally invoke once
* or an "OPTIONS" object describing the grammar action and optional properties.
*
* @returns The `GrammarAction` return value (OUT) if the optional syntax is encountered
* or `undefined` if not.
*/
protected OPTION<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION1<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION2<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION3<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION4<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION5<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION6<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION7<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION8<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* @see OPTION
* @hidden
*/
protected OPTION9<OUT>(
actionORMethodDef: GrammarAction<OUT> | DSLMethodOpts<OUT>
): OUT | undefined
/**
* Parsing DSL method that indicates a choice between a set of alternatives must be made.
* This is equivalent to an EBNF alternation (A | B | C | D ...), except
* that the alternatives are ordered like in a PEG grammar.
* This means that the **first** matching alternative is always chosen.
*
* There are several forms for the inner alternatives array:
*
* - Passing alternatives array directly:
* ```
* this.OR([
* { ALT:() => { this.CONSUME(One) }},
* { ALT:() => { this.CONSUME(Two) }},
* { ALT:() => { this.CONSUME(Three) }}
* ])
* ```
*
* - Passing alternative array directly with predicates (GATE):
* ```
* this.OR([
* { GATE: predicateFunc1, ALT:() => { this.CONSUME(One) }},
* { GATE: predicateFuncX, ALT:() => { this.CONSUME(Two) }},
* { GATE: predicateFuncX, ALT:() => { this.CONSUME(Three) }}
* ])
* ```
*
* - These syntax forms can also be mixed:
* ```
* this.OR([
* {
* GATE: predicateFunc1,
* ALT:() => { this.CONSUME(One) }
* },
* { ALT:() => { this.CONSUME(Two) }},
* { ALT:() => { this.CONSUME(Three) }}
* ])
* ```
*
* - Additionally an "options" object may be used:
* ```
* this.OR({
* DEF:[
* { ALT:() => { this.CONSUME(One) }},
* { ALT:() => { this.CONSUME(Two) }},
* { ALT:() => { this.CONSUME(Three) }}
* ],
* // OPTIONAL property
* ERR_MSG: "A Number"
* })
* ```
*
* The 'predicateFuncX' in the long form can be used to add constraints to choosing the alternative.
*
* As in CONSUME the index in the method name indicates the occurrence
* of the alternation production in it's top rule.
*
* @param altsOrOpts - A set of alternatives or an "OPTIONS" object describing the alternatives and optional properties.
*
* @returns The result of invoking the chosen alternative.
*/
protected OR<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR1<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR1(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR2<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR2(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR3<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR3(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR4<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR4(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR5<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR5(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR6<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR6(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR7<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR7(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR8<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR8(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* @see OR
* @hidden
*/
protected OR9<T>(altsOrOpts: IOrAlt<T>[] | OrMethodOpts<T>): T
protected OR9(altsOrOpts: IOrAlt<any>[] | OrMethodOpts<any>): any
/**
* Parsing DSL method, that indicates a repetition of zero or more.
* This is equivalent to EBNF repetition {...}.
*
* Note that there are two syntax forms:
* - Passing the grammar action directly:
* ```
* this.MANY(() => {
* this.CONSUME(Comma)
* this.CONSUME(Digit)
* })
* ```
*
* - using an "options" object:
* ```
* this.MANY({
* GATE: predicateFunc,
* DEF: () => {
* this.CONSUME(Comma)
* this.CONSUME(Digit)
* }
* });
* ```
*
* The optional 'GATE' property in "options" object form can be used to add constraints
* to invoking the grammar action.
*
* As in CONSUME the index in the method name indicates the occurrence
* of the repetition production in it's top rule.
*
* @param actionORMethodDef - The grammar action to optionally invoke multiple times
* or an "OPTIONS" object describing the grammar action and optional properties.
*
*/
protected MANY(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY1(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY2(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY3(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY4(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY5(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY6(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY7(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY8(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* @see MANY
* @hidden
*/
protected MANY9(
actionORMethodDef: GrammarAction<any> | DSLMethodOpts<any>
): void
/**
* Parsing DSL method, that indicates a repetition of zero or more with a separator
* Token between the repetitions.
*
* Example:
*
* ```
* this.MANY_SEP({
* SEP:Comma,
* DEF: () => {
* this.CONSUME(Number};
* // ...
* })
* ```
*
* Note that because this DSL method always requires more than one argument the options object is always required
* and it is not possible to use a shorter form like in the MANY DSL method.
*
* Note that for the purposes of deciding on whether or not another iteration exists
* Only a single Token is examined (The separator). Therefore if the grammar being implemented is
* so "crazy" to require multiple tokens to identify an item separator please use the more basic DSL methods
* to implement it.
*
* As in CONSUME the index in the method name indicates the occurrence
* of the repetition production in it's top rule.
*
* @param options - An object defining the grammar of each iteration and the separator between iterations
*
*/
protected MANY_SEP(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP1(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP2(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP3(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP4(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP5(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP6(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP7(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP8(options: ManySepMethodOpts<any>): void
/**
* @see MANY_SEP
* @hidden
*/
protected MANY_SEP9(options: ManySepMethodOpts<any>): void
/**
* Convenience method, same as MANY but the repetition is of one or more.
* failing to match at least one repetition will result in a parsing error and
* cause a parsing error.
*
* @see MANY
*
* @param actionORMethodDef - The grammar action to optionally invoke multiple times
* or an "OPTIONS" object describing the grammar action and optional properties.
*
*/
protected AT_LEAST_ONE(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE1(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE2(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE3(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE4(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE5(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE6(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE7(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE8(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* @see AT_LEAST_ONE
* @hidden
*/
protected AT_LEAST_ONE9(
actionORMethodDef: GrammarAction<any> | DSLMethodOptsWithErr<any>
): void
/**
* Convenience method, same as MANY_SEP but the repetition is of one or more.
* failing to match at least one repetition will result in a parsing error and
* cause the parser to attempt error recovery.
*
* Note that an additional optional property ERR_MSG can be used to provide custom error messages.
*
* @see MANY_SEP
*
* @param options - An object defining the grammar of each iteration and the separator between iterations
*
* @return {ISeparatedIterationResult<OUT>}
*/
protected AT_LEAST_ONE_SEP(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP1(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP2(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP3(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP4(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP5(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP6(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP7(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP8(options: AtLeastOneSepMethodOpts<any>): void
/**
* @see AT_LEAST_ONE_SEP
* @hidden
*/
protected AT_LEAST_ONE_SEP9(options: AtLeastOneSepMethodOpts<any>): void
/**
* Returns an "imaginary" Token to insert when Single Token Insertion is done
* Override this if you require special behavior in your grammar.
* For example if an IntegerToken is required provide one with the image '0' so it would be valid syntactically.
*/
protected getTokenToInsert(tokType: TokenType): IToken
/**
* By default all tokens type may be inserted. This behavior may be overridden in inheriting Recognizers
* for example: One may decide that only punctuation tokens may be inserted automatically as they have no additional
* semantic value. (A mandatory semicolon has no additional semantic meaning, but an Integer may have additional meaning
* depending on its int value and context (Inserting an integer 0 in cardinality: "[1..]" will cause semantic issues
* as the max of the cardinality will be greater than the min value (and this is a false error!).
*/
protected canTokenTypeBeInsertedInRecovery(tokType: TokenType): boolean
/**
* @deprecated - will be removed in the future
*/
protected getNextPossibleTokenTypes(
grammarPath: ITokenGrammarPath
): TokenType[]
input: IToken[]
protected SKIP_TOKEN(): IToken
/**
* Look-Ahead for the Token Vector
* LA(1) is the next Token ahead.
* LA(n) is the nth Token ahead.
* LA(0) is the previously consumed Token.
*
* Looking beyond the end of the Token Vector or before its begining
* will return in an IToken of type EOF {@link EOF}.
* This behavior can be used to avoid infinite loops.
*
* This is often used to implement custom lookahead logic for GATES.
* https://chevrotain.io/docs/features/gates.html
*/
protected LA(howMuch: number): IToken
}
/**
* A Parser that outputs a Concrete Syntax Tree.
* See:
* - https://chevrotain.io/docs/tutorial/step3_adding_actions_root.html#alternatives
* - https://chevrotain.io/docs/guide/concrete_syntax_tree.html
* For in depth docs.
*/
export declare class CstParser extends BaseParser {
/**
* Creates a Grammar Rule
*
* Note that any parameters of your implementation must be optional as it will
* be called without parameters during the grammar recording phase.
*/
protected RULE<F extends () => void>(
name: string,
implementation: F,
config?: IRuleConfig<CstNode>
): ParserMethod<Parameters<F>, CstNode>
/**
* Overrides a Grammar Rule
* See usage example in: https://github.com/chevrotain/chevrotain/blob/master/examples/parser/versioning/versioning.js
*/
protected OVERRIDE_RULE<F extends () => void>(
name: string,
implementation: F,
config?: IRuleConfig<CstNode>
): ParserMethod<Parameters<F>, CstNode>
/**
* Like `SUBRULE` with the numerical suffix as a parameter, e.g:
* subrule(0, X) === SUBRULE(X)
* subrule(1, X) === SUBRULE1(X)
* subrule(2, X) === SUBRULE2(X)
* ...
* @see SUBRULE
*/
protected subrule<ARGS extends unknown[]>(
idx: number,
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* The Parsing DSL Method is used by one rule to call another.
* It is equivalent to a non-Terminal in EBNF notation.
*
* This may seem redundant as it does not actually do much.
* However using it is **mandatory** for all sub rule invocations.
*
* Calling another rule without wrapping in SUBRULE(...)
* will cause errors/mistakes in the Parser's self analysis phase,
* which will lead to errors in error recovery/automatic lookahead calculation
* and any other functionality relying on the Parser's self analysis
* output.
*
* As in CONSUME the index in the method name indicates the occurrence
* of the sub rule invocation in its rule.
*
*/
protected SUBRULE<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE1<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE2<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE3<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE4<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE5<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE6<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**
* @see SUBRULE
* @hidden
*/
protected SUBRULE7<ARGS extends unknown[]>(
ruleToCall: ParserMethod<ARGS, CstNode>,
options?: SubruleMethodOpts<ARGS>
): CstNode
/**