-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathAntlr4.Runtime.xml
11293 lines (11225 loc) · 509 KB
/
Antlr4.Runtime.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Antlr4.Runtime</name>
</assembly>
<members>
<member name="T:Antlr4.Runtime.AntlrFileStream">
<summary>
This is an
<see cref="T:Antlr4.Runtime.AntlrInputStream"/>
that is loaded from a file all at once
when you construct the object.
</summary>
</member>
<member name="M:Antlr4.Runtime.AntlrFileStream.#ctor(System.String)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrFileStream.#ctor(System.String,System.Text.Encoding)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrFileStream.Load(System.String,System.Text.Encoding)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="T:Antlr4.Runtime.AntlrInputStream">
<summary>
Vacuum all input from a
<see cref="T:System.IO.TextReader"/>
/
<see cref="T:System.IO.Stream"/>
and then treat it
like a
<c>char[]</c>
buffer. Can also pass in a
<see cref="T:System.String"/>
or
<c>char[]</c>
to use.
<p>If you need encoding, pass in stream/reader with correct encoding.</p>
</summary>
</member>
<member name="F:Antlr4.Runtime.AntlrInputStream.data">
<summary>The data being scanned</summary>
</member>
<member name="F:Antlr4.Runtime.AntlrInputStream.n">
<summary>How many characters are actually in the buffer</summary>
</member>
<member name="F:Antlr4.Runtime.AntlrInputStream.p">
<summary>0..n-1 index into string of next char</summary>
</member>
<member name="F:Antlr4.Runtime.AntlrInputStream.name">
<summary>What is name or source of this char stream?</summary>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.String)">
<summary>Copy data in string to a local char array</summary>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.Char[],System.Int32)">
<summary>This is the preferred constructor for strings as no data is copied</summary>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.TextReader)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.TextReader,System.Int32)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.TextReader,System.Int32,System.Int32)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.Stream)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.Stream,System.Int32)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.#ctor(System.IO.Stream,System.Int32,System.Int32)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.Load(System.IO.TextReader,System.Int32,System.Int32)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.Reset">
<summary>
Reset the stream so that it's in the same state it was
when the object was created *except* the data array is not
touched.
</summary>
</member>
<member name="P:Antlr4.Runtime.AntlrInputStream.Index">
<summary>
Return the current input symbol index 0..n where n indicates the
last symbol has been read.
</summary>
<remarks>
Return the current input symbol index 0..n where n indicates the
last symbol has been read. The index is the index of char to
be returned from LA(1).
</remarks>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.Mark">
<summary>mark/release do nothing; we have entire buffer</summary>
</member>
<member name="M:Antlr4.Runtime.AntlrInputStream.Seek(System.Int32)">
<summary>
consume() ahead until p==index; can't just set p=index as we must
update line and charPositionInLine.
</summary>
<remarks>
consume() ahead until p==index; can't just set p=index as we must
update line and charPositionInLine. If we seek backwards, just set p
</remarks>
</member>
<member name="T:Antlr4.Runtime.Atn.AbstractPredicateTransition">
<author>Sam Harwell</author>
</member>
<member name="T:Antlr4.Runtime.Atn.AmbiguityInfo">
<summary>This class represents profiling event information for an ambiguity.</summary>
<remarks>
This class represents profiling event information for an ambiguity.
Ambiguities are decisions where a particular input resulted in an SLL
conflict, followed by LL prediction also reaching a conflict state
(indicating a true ambiguity in the grammar).
<p>
This event may be reported during SLL prediction in cases where the
conflicting SLL configuration set provides sufficient information to
determine that the SLL conflict is truly an ambiguity. For example, if none
of the ATN configurations in the conflicting SLL configuration set have
traversed a global follow transition (i.e.
<see cref="P:Antlr4.Runtime.Atn.ATNConfig.ReachesIntoOuterContext"/>
is
<see langword="false"/>
for all
configurations), then the result of SLL prediction for that input is known to
be equivalent to the result of LL prediction for that input.</p>
<p>
In some cases, the minimum represented alternative in the conflicting LL
configuration set is not equal to the minimum represented alternative in the
conflicting SLL configuration set. Grammars and inputs which result in this
scenario are unable to use
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Sll"/>
, which in turn means
they cannot use the two-stage parsing strategy to improve parsing performance
for that input.</p>
</remarks>
<seealso cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.ReportAmbiguity(Antlr4.Runtime.Dfa.DFA,Antlr4.Runtime.Dfa.DFAState,System.Int32,System.Int32,System.Boolean,Antlr4.Runtime.Sharpen.BitSet,Antlr4.Runtime.Atn.ATNConfigSet)"/>
<seealso cref="M:Antlr4.Runtime.IParserErrorListener.ReportAmbiguity(Antlr4.Runtime.Parser,Antlr4.Runtime.Dfa.DFA,System.Int32,System.Int32,System.Boolean,Antlr4.Runtime.Sharpen.BitSet,Antlr4.Runtime.Atn.ATNConfigSet)"/>
<since>4.3</since>
</member>
<member name="F:Antlr4.Runtime.Atn.AmbiguityInfo.ambigAlts">
<summary>The set of alternative numbers for this decision event that lead to a valid parse.</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.AmbiguityInfo.#ctor(System.Int32,Antlr4.Runtime.Atn.SimulatorState,Antlr4.Runtime.Sharpen.BitSet,Antlr4.Runtime.ITokenStream,System.Int32,System.Int32)">
<summary>
Constructs a new instance of the
<see cref="T:Antlr4.Runtime.Atn.AmbiguityInfo"/>
class with the
specified detailed ambiguity information.
</summary>
<param name="decision">The decision number</param>
<param name="state">
The final simulator state identifying the ambiguous
alternatives for the current input
</param>
<param name="ambigAlts">
The set of alternatives in the decision that lead to a valid parse.
The predicted alt is the min(ambigAlts)
</param>
<param name="input">The input token stream</param>
<param name="startIndex">The start index for the current prediction</param>
<param name="stopIndex">
The index at which the ambiguity was identified during
prediction
</param>
</member>
<member name="P:Antlr4.Runtime.Atn.AmbiguityInfo.AmbiguousAlternatives">
<summary>Gets the set of alternatives in the decision that lead to a valid parse.</summary>
<since>4.5</since>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.decisionToState">
<summary>
Each subrule/rule is a decision point and we must track them so we
can go back later and build DFA predictors for them.
</summary>
<remarks>
Each subrule/rule is a decision point and we must track them so we
can go back later and build DFA predictors for them. This includes
all the rules, subrules, optional blocks, ()+, ()* etc...
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.ruleToStartState">
<summary>Maps from rule index to starting state number.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.ruleToStopState">
<summary>Maps from rule index to stop state number.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.grammarType">
<summary>The type of the ATN.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.maxTokenType">
<summary>The maximum value for any symbol recognized by a transition in the ATN.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.ruleToTokenType">
<summary>For lexer ATNs, this maps the rule index to the resulting token type.</summary>
<remarks>
For lexer ATNs, this maps the rule index to the resulting token type.
For parser ATNs, this maps the rule index to the generated bypass token
type if the
<see cref="P:Antlr4.Runtime.Atn.ATNDeserializationOptions.GenerateRuleBypassTransitions"/>
deserialization option was specified; otherwise, this is
<see langword="null"/>
.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.ATN.lexerActions">
<summary>
For lexer ATNs, this is an array of
<see cref="T:Antlr4.Runtime.Atn.ILexerAction"/>
objects which may
be referenced by action transitions in the ATN.
</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATN.#ctor(Antlr4.Runtime.Atn.ATNType,System.Int32)">
<summary>Used for runtime deserialization of ATNs from strings</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATN.ClearDFA">
<summary>
Clears the DFA cached for this ATN.
</summary>
<remarks>
<para>This method is not safe for concurrent use. Since recognizers by default share an <see cref="T:Antlr4.Runtime.Atn.ATN"/>
instance, all parsing operations by all recognizers using this instance must be stopped before the DFA can
be safely cleared.</para>
</remarks>
</member>
<member name="M:Antlr4.Runtime.Atn.ATN.NextTokens(Antlr4.Runtime.Atn.ATNState,Antlr4.Runtime.Atn.PredictionContext)">
<summary>
Compute the set of valid tokens that can occur starting in state
<paramref name="s"/>
.
If
<paramref name="ctx"/>
is
<see cref="F:Antlr4.Runtime.Atn.PredictionContext.EmptyLocal"/>
, the set of tokens will not include what can follow
the rule surrounding
<paramref name="s"/>
. In other words, the set will be
restricted to tokens reachable staying within
<paramref name="s"/>
's rule.
</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATN.NextTokens(Antlr4.Runtime.Atn.ATNState)">
<summary>
Compute the set of valid tokens that can occur starting in
<paramref name="s"/>
and
staying in same rule.
<see cref="F:Antlr4.Runtime.TokenConstants.Epsilon"/>
is in set if we reach end of
rule.
</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATN.GetExpectedTokens(System.Int32,Antlr4.Runtime.RuleContext)">
<summary>
Computes the set of input symbols which could follow ATN state number
<paramref name="stateNumber"/>
in the specified full
<paramref name="context"/>
. This method
considers the complete parser context, but does not evaluate semantic
predicates (i.e. all predicates encountered during the calculation are
assumed true). If a path in the ATN exists from the starting state to the
<see cref="T:Antlr4.Runtime.Atn.RuleStopState"/>
of the outermost context without matching any
symbols,
<see cref="F:Antlr4.Runtime.TokenConstants.Eof"/>
is added to the returned set.
<p>If
<paramref name="context"/>
is
<see langword="null"/>
, it is treated as
<see cref="P:Antlr4.Runtime.ParserRuleContext.EmptyContext"/>
.</p>
<p>Note that this does NOT give you the set of all tokens that could
appear at a given token position in the input phrase. In other words, it
does not answer:</p>
<quote>"Given a specific partial input phrase, return the set of all
tokens that can follow the last token in the input phrase."</quote>
<p>The big difference is that with just the input, the parser could land
right in the middle of a lookahead decision. Getting all
<em>possible</em> tokens given a partial input stream is a separate
computation. See https://github.com/antlr/antlr4/issues/1428</p>
<p>For this function, we are specifying an ATN state and call stack to
compute what token(s) can come next and specifically: outside of a
lookahead decision. That is what you want for error reporting and
recovery upon parse error.</p>
</summary>
<param name="stateNumber">the ATN state number</param>
<param name="context">the full parse context</param>
<returns>
The set of potentially valid input symbols which could follow the
specified state in the specified context.
</returns>
<exception cref="T:System.ArgumentException">
if the ATN does not contain a state with
number
<paramref name="stateNumber"/>
</exception>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNConfig">
<summary>A tuple: (ATN state, predicted alt, syntactic, semantic context).</summary>
<remarks>
A tuple: (ATN state, predicted alt, syntactic, semantic context).
The syntactic context is a graph-structured stack node whose
path(s) to the root is the rule invocation(s)
chain used to arrive at the state. The semantic context is
the tree of semantic predicates encountered before reaching
an ATN state.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfig.SuppressPrecedenceFilter">
<summary>
This field stores the bit mask for implementing the
<see cref="P:Antlr4.Runtime.Atn.ATNConfig.PrecedenceFilterSuppressed"/>
property as a bit within the
existing
<see cref="F:Antlr4.Runtime.Atn.ATNConfig.altAndOuterContextDepth"/>
field.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfig.state">
<summary>The ATN state associated with this configuration</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfig.altAndOuterContextDepth">
<summary>This is a bit-field currently containing the following values.</summary>
<remarks>
This is a bit-field currently containing the following values.
<ul>
<li>0x00FFFFFF: Alternative</li>
<li>0x7F000000: Outer context depth</li>
<li>0x80000000: Suppress precedence filter</li>
</ul>
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfig.context">
<summary>
The stack of invoking states leading to the rule/states associated
with this config.
</summary>
<remarks>
The stack of invoking states leading to the rule/states associated
with this config. We track only those contexts pushed during
execution of the ATN simulator.
</remarks>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNConfig.State">
<summary>Gets the ATN state associated with this configuration.</summary>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNConfig.Alt">
<summary>What alt (or lexer rule) is predicted by this configuration.</summary>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNConfig.OuterContextDepth">
<summary>
We cannot execute predicates dependent upon local context unless
we know for sure we are in the correct context.
</summary>
<remarks>
We cannot execute predicates dependent upon local context unless
we know for sure we are in the correct context. Because there is
no way to do this efficiently, we simply cannot evaluate
dependent predicates unless we are in the rule that initially
invokes the ATN simulator.
<p>
closure() tracks the depth of how far we dip into the outer context:
depth > 0. Note that it may not be totally accurate depth since I
don't ever decrement. TODO: make it a boolean then</p>
</remarks>
</member>
<member name="M:Antlr4.Runtime.Atn.ATNConfig.Equals(System.Object)">
<summary>
An ATN configuration is equal to another if both have
the same state, they predict the same alternative, and
syntactic/semantic contexts are the same.
</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNConfigSet">
<author>Sam Harwell</author>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfigSet.mergedConfigs">
<summary>
This maps (state, alt) -> merged
<see cref="T:Antlr4.Runtime.Atn.ATNConfig"/>
. The key does not account for
the
<see cref="P:Antlr4.Runtime.Atn.ATNConfig.SemanticContext"/>
of the value, which is only a problem if a single
<c>ATNConfigSet</c>
contains two configs with the same state and alternative
but different semantic contexts. When this case arises, the first config
added to this map stays, and the remaining configs are placed in
<see cref="F:Antlr4.Runtime.Atn.ATNConfigSet.unmerged"/>
.
<p/>
This map is only used for optimizing the process of adding configs to the set,
and is
<see langword="null"/>
for read-only sets stored in the DFA.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfigSet.unmerged">
<summary>
This is an "overflow" list holding configs which cannot be merged with one
of the configs in
<see cref="F:Antlr4.Runtime.Atn.ATNConfigSet.mergedConfigs"/>
but have a colliding key. This
occurs when two configs in the set have the same state and alternative but
different semantic contexts.
<p/>
This list is only used for optimizing the process of adding configs to the set,
and is
<see langword="null"/>
for read-only sets stored in the DFA.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfigSet.configs">
<summary>This is a list of all configs in this set.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNConfigSet.outermostConfigSet">
<summary>
When
<see langword="true"/>
, this config set represents configurations where the entire
outer context has been consumed by the ATN interpreter. This prevents the
<see cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.Closure(Antlr4.Runtime.Atn.ATNConfigSet,Antlr4.Runtime.Atn.ATNConfigSet,System.Boolean,System.Boolean,Antlr4.Runtime.Atn.PredictionContextCache,System.Boolean)"/>
from pursuing the global FOLLOW when a
rule stop state is reached with an empty prediction context.
<p/>
Note:
<c>outermostConfigSet</c>
and
<see cref="F:Antlr4.Runtime.Atn.ATNConfigSet.dipsIntoOuterContext"/>
should never
be true at the same time.
</summary>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNConfigSet.RepresentedAlternatives">
<summary>
Get the set of all alternatives represented by configurations in this
set.
</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNDeserializationOptions">
<author>Sam Harwell</author>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNDeserializer">
<author>Sam Harwell</author>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNDeserializer.BaseSerializedUuid">
<summary>This is the earliest supported serialized UUID.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNDeserializer.AddedLexerActions">
<summary>
This UUID indicates an extension of
<see cref="F:Antlr4.Runtime.Atn.ATNDeserializer.BaseSerializedUuid"/>
for the addition of lexer actions encoded as a sequence of
<see cref="T:Antlr4.Runtime.Atn.ILexerAction"/>
instances.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNDeserializer.SupportedUuids">
<summary>
This list contains all of the currently supported UUIDs, ordered by when
the feature first appeared in this branch.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNDeserializer.SerializedUuid">
<summary>This is the current serialized UUID.</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATNDeserializer.IsFeatureSupported(System.Guid,System.Guid)">
<summary>
Determines if a particular serialized representation of an ATN supports
a particular feature, identified by the
<see cref="T:System.Guid"/>
used for serializing
the ATN at the time the feature was first introduced.
</summary>
<param name="feature">
The
<see cref="T:System.Guid"/>
marking the first time the feature was
supported in the serialized ATN.
</param>
<param name="actualUuid">
The
<see cref="T:System.Guid"/>
of the actual serialized ATN which is
currently being deserialized.
</param>
<returns>
<see langword="true"/>
if the
<paramref name="actualUuid"/>
value represents a
serialized ATN at or after the feature identified by
<paramref name="feature"/>
was
introduced; otherwise,
<see langword="false"/>
.
</returns>
</member>
<member name="M:Antlr4.Runtime.Atn.ATNDeserializer.MarkPrecedenceDecisions(Antlr4.Runtime.Atn.ATN)">
<summary>
Analyze the
<see cref="T:Antlr4.Runtime.Atn.StarLoopEntryState"/>
states in the specified ATN to set
the
<see cref="F:Antlr4.Runtime.Atn.StarLoopEntryState.precedenceRuleDecision"/>
field to the
correct value.
</summary>
<param name="atn">The ATN.</param>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNSimulator.SerializedUuid">
<summary>This is the current serialized UUID.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNSimulator.Error">
<summary>Must distinguish between missing edge and edge we know leads nowhere</summary>
</member>
<member name="M:Antlr4.Runtime.Atn.ATNSimulator.ClearDFA">
<summary>Clear the DFA cache used by the current instance.</summary>
<remarks>
Clear the DFA cache used by the current instance. Since the DFA cache may
be shared by multiple ATN simulators, this method may affect the
performance (but not accuracy) of other parsers which are being used
concurrently.
</remarks>
<exception cref="T:System.NotSupportedException">
if the current instance does not
support clearing the DFA.
</exception>
<since>4.3</since>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNState">
<summary>
The following images show the relation of states and
<see cref="F:Antlr4.Runtime.Atn.ATNState.transitions"/>
for various grammar constructs.
<ul>
<li>Solid edges marked with an ε indicate a required
<see cref="T:Antlr4.Runtime.Atn.EpsilonTransition"/>
.</li>
<li>Dashed edges indicate locations where any transition derived from
<see cref="M:Antlr4.Runtime.Atn.ATNState.Transition(System.Int32)"/>
might appear.</li>
<li>Dashed nodes are place holders for either a sequence of linked
<see cref="T:Antlr4.Runtime.Atn.BasicState"/>
states or the inclusion of a block representing a nested
construct in one of the forms below.</li>
<li>Nodes showing multiple outgoing alternatives with a
<c>...</c>
support
any number of alternatives (one or more). Nodes without the
<c>...</c>
only
support the exact number of alternatives shown in the diagram.</li>
</ul>
<h2>Basic Blocks</h2>
<h3>Rule</h3>
<embed src="images/Rule.svg" type="image/svg+xml"/>
<h3>Block of 1 or more alternatives</h3>
<embed src="images/Block.svg" type="image/svg+xml"/>
<h2>Greedy Loops</h2>
<h3>Greedy Closure:
<c>(...)*</c>
</h3>
<embed src="images/ClosureGreedy.svg" type="image/svg+xml"/>
<h3>Greedy Positive Closure:
<c>(...)+</c>
</h3>
<embed src="images/PositiveClosureGreedy.svg" type="image/svg+xml"/>
<h3>Greedy Optional:
<c>(...)?</c>
</h3>
<embed src="images/OptionalGreedy.svg" type="image/svg+xml"/>
<h2>Non-Greedy Loops</h2>
<h3>Non-Greedy Closure:
<c>(...)*?</c>
</h3>
<embed src="images/ClosureNonGreedy.svg" type="image/svg+xml"/>
<h3>Non-Greedy Positive Closure:
<c>(...)+?</c>
</h3>
<embed src="images/PositiveClosureNonGreedy.svg" type="image/svg+xml"/>
<h3>Non-Greedy Optional:
<c>(...)??</c>
</h3>
<embed src="images/OptionalNonGreedy.svg" type="image/svg+xml"/>
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNState.atn">
<summary>Which ATN are we in?</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNState.transitions">
<summary>Track the transitions emanating from this ATN state.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.ATNState.nextTokenWithinRule">
<summary>Used to cache lookahead during parsing, not used during construction</summary>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNState.StateNumber">
<summary>Gets the state number.</summary>
<returns>the state number</returns>
</member>
<member name="P:Antlr4.Runtime.Atn.ATNState.NonStopStateNumber">
<summary>
For all states except
<see cref="T:Antlr4.Runtime.Atn.RuleStopState"/>
, this returns the state
number. Returns -1 for stop states.
</summary>
<returns>
-1 for
<see cref="T:Antlr4.Runtime.Atn.RuleStopState"/>
, otherwise the state number
</returns>
</member>
<member name="T:Antlr4.Runtime.Atn.ATNType">
<summary>Represents the type of recognizer an ATN applies to.</summary>
<author>Sam Harwell</author>
</member>
<member name="T:Antlr4.Runtime.Atn.AtomTransition">
<summary>TODO: make all transitions sets? no, should remove set edges</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.AtomTransition.label">
<summary>The token type or character value; or, signifies special label.</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.BasicBlockStartState">
<author>Sam Harwell</author>
</member>
<member name="T:Antlr4.Runtime.Atn.BasicState">
<author>Sam Harwell</author>
</member>
<member name="T:Antlr4.Runtime.Atn.BlockEndState">
<summary>
Terminal node of a simple
<c>(a|b|c)</c>
block.
</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.BlockStartState">
<summary>
The start of a regular
<c>(...)</c>
block.
</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.ConflictInfo">
<summary>This class stores information about a configuration conflict.</summary>
<author>Sam Harwell</author>
</member>
<member name="P:Antlr4.Runtime.Atn.ConflictInfo.ConflictedAlts">
<summary>Gets the set of conflicting alternatives for the configuration set.</summary>
</member>
<member name="P:Antlr4.Runtime.Atn.ConflictInfo.IsExact">
<summary>Gets whether or not the configuration conflict is an exact conflict.</summary>
<remarks>
Gets whether or not the configuration conflict is an exact conflict.
An exact conflict occurs when the prediction algorithm determines that
the represented alternatives for a particular configuration set cannot be
further reduced by consuming additional input. After reaching an exact
conflict during an SLL prediction, only switch to full-context prediction
could reduce the set of viable alternatives. In LL prediction, an exact
conflict indicates a true ambiguity in the input.
<p>
For the
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.LlExactAmbigDetection"/>
prediction mode,
accept states are conflicting but not exact are treated as non-accept
states.</p>
</remarks>
</member>
<member name="T:Antlr4.Runtime.Atn.ContextSensitivityInfo">
<summary>This class represents profiling event information for a context sensitivity.</summary>
<remarks>
This class represents profiling event information for a context sensitivity.
Context sensitivities are decisions where a particular input resulted in an
SLL conflict, but LL prediction produced a single unique alternative.
<p>
In some cases, the unique alternative identified by LL prediction is not
equal to the minimum represented alternative in the conflicting SLL
configuration set. Grammars and inputs which result in this scenario are
unable to use
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Sll"/>
, which in turn means they cannot use
the two-stage parsing strategy to improve parsing performance for that
input.</p>
</remarks>
<seealso cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.ReportContextSensitivity(Antlr4.Runtime.Dfa.DFA,System.Int32,Antlr4.Runtime.Atn.SimulatorState,System.Int32,System.Int32)"/>
<seealso cref="M:Antlr4.Runtime.IParserErrorListener.ReportContextSensitivity(Antlr4.Runtime.Parser,Antlr4.Runtime.Dfa.DFA,System.Int32,System.Int32,System.Int32,Antlr4.Runtime.Atn.SimulatorState)"/>
<since>4.3</since>
</member>
<member name="M:Antlr4.Runtime.Atn.ContextSensitivityInfo.#ctor(System.Int32,Antlr4.Runtime.Atn.SimulatorState,Antlr4.Runtime.ITokenStream,System.Int32,System.Int32)">
<summary>
Constructs a new instance of the
<see cref="T:Antlr4.Runtime.Atn.ContextSensitivityInfo"/>
class
with the specified detailed context sensitivity information.
</summary>
<param name="decision">The decision number</param>
<param name="state">
The final simulator state containing the unique
alternative identified by full-context prediction
</param>
<param name="input">The input token stream</param>
<param name="startIndex">The start index for the current prediction</param>
<param name="stopIndex">
The index at which the context sensitivity was
identified during full-context prediction
</param>
</member>
<member name="T:Antlr4.Runtime.Atn.DecisionEventInfo">
<summary>
This is the base class for gathering detailed information about prediction
events which occur during parsing.
</summary>
<remarks>
This is the base class for gathering detailed information about prediction
events which occur during parsing.
Note that we could record the parser call stack at the time this event
occurred but in the presence of left recursive rules, the stack is kind of
meaningless. It's better to look at the individual configurations for their
individual stacks. Of course that is a
<see cref="T:Antlr4.Runtime.Atn.PredictionContext"/>
object
not a parse tree node and so it does not have information about the extent
(start...stop) of the various subtrees. Examining the stack tops of all
configurations provide the return states for the rule invocations.
From there you can get the enclosing rule.
</remarks>
<since>4.3</since>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.decision">
<summary>The invoked decision number which this event is related to.</summary>
<seealso cref="F:Antlr4.Runtime.Atn.ATN.decisionToState"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.state">
<summary>
The simulator state containing additional information relevant to the
prediction state when the current event occurred, or
<see langword="null"/>
if no
additional information is relevant or available.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.input">
<summary>The input token stream which is being parsed.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.startIndex">
<summary>
The token index in the input stream at which the current prediction was
originally invoked.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.stopIndex">
<summary>The token index in the input stream at which the current event occurred.</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionEventInfo.fullCtx">
<summary>
<see langword="true"/>
if the current event occurred during LL prediction;
otherwise,
<see langword="false"/>
if the input occurred during SLL prediction.
</summary>
</member>
<member name="T:Antlr4.Runtime.Atn.DecisionInfo">
<summary>This class contains profiling gathered for a particular decision.</summary>
<remarks>
This class contains profiling gathered for a particular decision.
<p>
Parsing performance in ANTLR 4 is heavily influenced by both static factors
(e.g. the form of the rules in the grammar) and dynamic factors (e.g. the
choice of input and the state of the DFA cache at the time profiling
operations are started). For best results, gather and use aggregate
statistics from a large sample of inputs representing the inputs expected in
production before using the results to make changes in the grammar.</p>
</remarks>
<since>4.3</since>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.decision">
<summary>
The decision number, which is an index into
<see cref="F:Antlr4.Runtime.Atn.ATN.decisionToState"/>
.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.invocations">
<summary>
The total number of times
<see cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.AdaptivePredict(Antlr4.Runtime.ITokenStream,System.Int32,Antlr4.Runtime.ParserRuleContext)"/>
was
invoked for this decision.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.timeInPrediction">
<summary>
The total time spent in
<see cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.AdaptivePredict(Antlr4.Runtime.ITokenStream,System.Int32,Antlr4.Runtime.ParserRuleContext)"/>
for
this decision, in nanoseconds.
<p>
The value of this field is computed by <see cref="T:System.Diagnostics.Stopwatch"/>,
and is not adjusted to compensate for JIT
and/or garbage collection overhead. For best accuracy, perform profiling
in a separate process which is warmed up by parsing the input prior to
profiling. If desired, call <see cref="M:Antlr4.Runtime.Atn.ATNSimulator.ClearDFA"/>
to reset the DFA cache to its initial
state before starting the profiling measurement pass.</p>
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_TotalLook">
<summary>The sum of the lookahead required for SLL prediction for this decision.</summary>
<remarks>
The sum of the lookahead required for SLL prediction for this decision.
Note that SLL prediction is used before LL prediction for performance
reasons even when
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Ll"/>
or
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.LlExactAmbigDetection"/>
is used.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_MinLook">
<summary>
Gets the minimum lookahead required for any single SLL prediction to
complete for this decision, by reaching a unique prediction, reaching an
SLL conflict state, or encountering a syntax error.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_MaxLook">
<summary>
Gets the maximum lookahead required for any single SLL prediction to
complete for this decision, by reaching a unique prediction, reaching an
SLL conflict state, or encountering a syntax error.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_MaxLookEvent">
<summary>
Gets the
<see cref="T:Antlr4.Runtime.Atn.LookaheadEventInfo"/>
associated with the event where the
<see cref="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_MaxLook"/>
value was set.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_TotalLook">
<summary>The sum of the lookahead required for LL prediction for this decision.</summary>
<remarks>
The sum of the lookahead required for LL prediction for this decision.
Note that LL prediction is only used when SLL prediction reaches a
conflict state.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_MinLook">
<summary>
Gets the minimum lookahead required for any single LL prediction to
complete for this decision.
</summary>
<remarks>
Gets the minimum lookahead required for any single LL prediction to
complete for this decision. An LL prediction completes when the algorithm
reaches a unique prediction, a conflict state (for
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Ll"/>
, an ambiguity state (for
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.LlExactAmbigDetection"/>
, or a syntax error.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_MaxLook">
<summary>
Gets the maximum lookahead required for any single LL prediction to
complete for this decision.
</summary>
<remarks>
Gets the maximum lookahead required for any single LL prediction to
complete for this decision. An LL prediction completes when the algorithm
reaches a unique prediction, a conflict state (for
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Ll"/>
, an ambiguity state (for
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.LlExactAmbigDetection"/>
, or a syntax error.
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_MaxLookEvent">
<summary>
Gets the
<see cref="T:Antlr4.Runtime.Atn.LookaheadEventInfo"/>
associated with the event where the
<see cref="F:Antlr4.Runtime.Atn.DecisionInfo.LL_MaxLook"/>
value was set.
</summary>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.contextSensitivities">
<summary>
A collection of
<see cref="T:Antlr4.Runtime.Atn.ContextSensitivityInfo"/>
instances describing the
context sensitivities encountered during LL prediction for this decision.
</summary>
<seealso cref="T:Antlr4.Runtime.Atn.ContextSensitivityInfo"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.errors">
<summary>
A collection of
<see cref="T:Antlr4.Runtime.Atn.ErrorInfo"/>
instances describing the parse errors
identified during calls to
<see cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.AdaptivePredict(Antlr4.Runtime.ITokenStream,System.Int32,Antlr4.Runtime.ParserRuleContext)"/>
for
this decision.
</summary>
<seealso cref="T:Antlr4.Runtime.Atn.ErrorInfo"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.ambiguities">
<summary>
A collection of
<see cref="T:Antlr4.Runtime.Atn.AmbiguityInfo"/>
instances describing the
ambiguities encountered during LL prediction for this decision.
</summary>
<seealso cref="T:Antlr4.Runtime.Atn.AmbiguityInfo"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.predicateEvals">
<summary>
A collection of
<see cref="T:Antlr4.Runtime.Atn.PredicateEvalInfo"/>
instances describing the
results of evaluating individual predicates during prediction for this
decision.
</summary>
<seealso cref="T:Antlr4.Runtime.Atn.PredicateEvalInfo"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_ATNTransitions">
<summary>
The total number of ATN transitions required during SLL prediction for
this decision.
</summary>
<remarks>
The total number of ATN transitions required during SLL prediction for
this decision. An ATN transition is determined by the number of times the
DFA does not contain an edge that is required for prediction, resulting
in on-the-fly computation of that edge.
<p>
If DFA caching of SLL transitions is employed by the implementation, ATN
computation may cache the computed edge for efficient lookup during
future parsing of this decision. Otherwise, the SLL parsing algorithm
will use ATN transitions exclusively.</p>
</remarks>
<seealso cref="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_ATNTransitions"/>
<seealso cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.ComputeTargetState(Antlr4.Runtime.Dfa.DFA,Antlr4.Runtime.Dfa.DFAState,Antlr4.Runtime.ParserRuleContext,System.Int32,System.Boolean,Antlr4.Runtime.Atn.PredictionContextCache)"/>
<seealso cref="M:Antlr4.Runtime.Atn.LexerATNSimulator.ComputeTargetState(Antlr4.Runtime.ICharStream,Antlr4.Runtime.Dfa.DFAState,System.Int32)"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.SLL_DFATransitions">
<summary>
The total number of DFA transitions required during SLL prediction for
this decision.
</summary>
<remarks>
The total number of DFA transitions required during SLL prediction for
this decision.
<p>If the ATN simulator implementation does not use DFA caching for SLL
transitions, this value will be 0.</p>
</remarks>
<seealso cref="M:Antlr4.Runtime.Atn.ParserATNSimulator.GetExistingTargetState(Antlr4.Runtime.Dfa.DFAState,System.Int32)"/>
<seealso cref="M:Antlr4.Runtime.Atn.LexerATNSimulator.GetExistingTargetState(Antlr4.Runtime.Dfa.DFAState,System.Int32)"/>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_Fallback">
<summary>
Gets the total number of times SLL prediction completed in a conflict
state, resulting in fallback to LL prediction.
</summary>
<remarks>
Gets the total number of times SLL prediction completed in a conflict
state, resulting in fallback to LL prediction.
<p>Note that this value is not related to whether or not
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Sll"/>
may be used successfully with a particular
grammar. If the ambiguity resolution algorithm applied to the SLL
conflicts for this decision produce the same result as LL prediction for
this decision,
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Sll"/>
would produce the same overall
parsing result as
<see cref="F:Antlr4.Runtime.Atn.PredictionMode.Ll"/>
.</p>
</remarks>
</member>
<member name="F:Antlr4.Runtime.Atn.DecisionInfo.LL_ATNTransitions">
<summary>