dbt-antlr-runtime 0.7.0

Dbt fork of ANTLR4 runtime for Rust
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
//! Base parser implementation
use std::borrow::{Borrow, Cow};
use std::cell::Cell;
use std::fmt::{Debug, Formatter};
use std::marker::PhantomData;
use std::ops::{Deref, DerefMut};

use crate::arena::Arena;
use crate::atn::ATN;
use crate::atn_simulator::{IATNSimulator, ParserATNSimulatorManager};
use crate::error_listener::{
    ConsoleErrorListener, ErrorListener, ErrorListenerDelegate, ProxyErrorListener,
};
use crate::error_strategy::ErrorStrategy;
use crate::errors::ANTLRError;
use crate::interval_set::IntervalSet;
use crate::parser_atn_simulator::ParserATNSimulator;
use crate::prediction_mode::PredictionMode;
use crate::recognizer::{Actions, Recognizer};
use crate::rule_context::{states_stack, RuleContext as _};
use crate::token::{OwningToken, Token, TOKEN_EOF};
use crate::token_factory::TokenFactory;
use crate::token_stream::TokenStream;
use crate::tree::{NodeKindType, ParseTreeListener, Tree as _, TreeNode};
use crate::utils::cell_update;
use crate::vocabulary::Vocabulary;

#[cfg(feature = "recursion-limit")]
const DEFAULT_RECURSION_LIMIT: u32 = 2000;

/// parser functionality required for `ParserATNSimulator` to work
#[allow(missing_docs)]
pub trait Parser<'input, 'arena, TF>: Recognizer<'input, 'arena, TF::Tok>
where
    'input: 'arena,
    TF: TokenFactory<'input, 'arena> + 'arena,
{
    fn get_arena(&self) -> &'arena Arena;

    fn get_interpreter(&self) -> &'arena ParserATNSimulator<'arena>;

    fn get_token_factory(&self) -> &TF;

    fn get_current_context(&self) -> &'arena TreeNode<'input, 'arena, Self::Node, TF::Tok>;

    /// Current rule context, or `None` when the parser is not inside a rule.
    ///
    /// Java has no equivalent accessor: `ParserATNSimulator.adaptivePredict`
    /// takes the outer context as an explicit parameter, and the tool's
    /// interpreter tests pass `ParserRuleContext.EMPTY`. This accessor lets
    /// [crate::parser_atn_simulator::ParserATNSimulator::adaptive_predict]
    /// treat a missing context as Java's `ParserRuleContext.EMPTY`.
    fn get_current_context_opt(
        &self,
    ) -> Option<&'arena TreeNode<'input, 'arena, Self::Node, TF::Tok>> {
        Some(self.get_current_context())
    }

    fn consume(
        &mut self,
        err_handler: &mut impl ErrorStrategy<'input, 'arena, TF, Self>,
    ) -> Result<(), ANTLRError>
    where
        Self: Sized;

    fn precpred(
        &self,
        localctx: Option<&TreeNode<'input, 'arena, Self::Node, TF::Tok>>,
        precedence: i32,
    ) -> bool;

    fn get_input_stream_mut(&mut self) -> &mut dyn TokenStream<'input, 'arena, TF>;
    fn get_input_stream(&self) -> &dyn TokenStream<'input, 'arena, TF>;
    fn get_current_token(&self) -> &'arena TF::Tok;
    fn get_expected_tokens<'a>(&'a self) -> Cow<'a, IntervalSet>;

    fn add_error_listener(
        &mut self,
        listener: Box<dyn ErrorListener<'input, 'arena, Self, TF::Tok> + 'input>,
    ) where
        Self: Sized;

    fn remove_error_listeners(&mut self);

    fn notify_error_listeners(
        &self,
        msg: String,
        offending_token: Option<isize>,
        err: Option<&ANTLRError>,
    );
    fn get_error_lister_dispatch<'a>(
        &'a self,
    ) -> Box<dyn ErrorListener<'input, 'arena, Self, TF::Tok> + 'a>
    where
        Self: Sized;

    fn is_expected_token(&self, symbol: i32) -> bool;

    /// The `(parent_ctx_ptr, call_sites)` pairs of the active neutral parses,
    /// outermost first.
    #[doc(hidden)]
    fn neutral_call_sites(&self) -> &[(*const (), &'static [i32])] {
        &[]
    }
    fn get_precedence(&self) -> i32;

    fn get_state(&self) -> i32;
    fn set_state(&mut self, v: i32);
    fn get_rule_invocation_stack(&self) -> Vec<String>;

    #[cfg(feature = "recursion-limit")]
    fn get_recursion_limit(&self) -> u32;
    #[cfg(feature = "recursion-limit")]
    fn set_recursion_limit(&mut self, v: u32);
}

/// The parser state that the neutral parse of a shared-descent group saves and
/// restores (see [`BaseParser::begin_neutral_parse`]).
#[doc(hidden)]
#[derive(Debug)]
pub struct NeutralParse {
    start_index: isize,
    mark: isize,
    /// The stream index where the shared rule starts, after the prefix.
    shared_index: isize,
    state: i32,
    children: usize,
    matched_eof: bool,
}

/// A shared rule parsed by a neutral parse, waiting for the re-descent to call
/// it (see [`BaseParser::resume_take`]).
struct Resume<'input, 'arena, Node, Tok>
where
    'input: 'arena,
    Node: NodeKindType<'arena, Tok>,
    Tok: Token + 'input,
{
    node: &'arena TreeNode<'input, 'arena, Node, Tok>,
    rule: usize,
    shared_index: isize,
    tail_index: isize,
    /// `matched_eof` after the shared rule.
    matched_eof: bool,
    mark: isize,
}

/// Abstract base parser implementation
///
/// Only meant to be instantiated by generated parsers
pub struct BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    // Grammar-specific implementation of parser functionality required for
    // `ParserATNSimulator` to work
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    // Token factory used by the input stream
    TF: TokenFactory<'input, 'arena> + 'arena,
    // Token stream (lexer)
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    interp: Option<ParserATNSimulator<'arena>>,
    atn_manager: &'static ParserATNSimulatorManager,
    global_cache_threshold: usize,

    /// Rule context parser is currently processing
    ctx: *mut (),

    /// Track the {@link ParserRuleContext} objects during the parse and hook
    /// them up using the {@link ParserRuleContext#children} list so that it
    /// forms a parse tree. The {@link ParserRuleContext} returned from the start
    /// rule represents the root of the parse tree.
    ///
    /// <p>Note that if we are not building parse trees, rule contexts only point
    /// upwards. When a rule exits, it returns the context bute that gets garbage
    /// collected if nobody holds a reference. It points upwards but nobody
    /// points at it. </p>
    ///
    /// <p>When we build parse trees, we are adding all of these contexts to
    /// {@link ParserRuleContext#children} list. Contexts are then not candidates
    /// for garbage collection.</p>
    ///
    /// Returns {@code true} if a complete parse tree will be constructed while
    /// parsing, otherwise {@code false}
    pub build_parse_trees: bool,

    /// true if parser reached EOF
    pub matched_eof: bool,

    state: i32,
    /// Token stream that is currently used by this parser
    pub input: Input,
    precedence_stack: Vec<i32>,
    #[cfg(feature = "recursion-limit")]
    pub recursion_limit: u32,
    #[cfg(feature = "recursion-limit")]
    current_recursion_depth: u32,

    parse_listeners: Vec<Box<Node::Listener>>,
    _syntax_errors: Cell<i32>,
    error_listeners: Vec<ErrorListenerDelegate<'input, 'arena, Self, TF::Tok>>,
    /// Mutes the parse listeners while it is above zero. A counter, because
    /// the neutral parses of nested shared-descent groups nest (see
    /// [`Self::begin_neutral_parse`]).
    muted: u32,
    /// The pending re-descent of a shared-descent group (see
    /// [`Self::resume_neutral_parse`]).
    resume: Option<Resume<'input, 'arena, Node, TF::Tok>>,
    /// The `(parent_ctx_ptr, call_sites)` pairs of the active neutral parses,
    /// outermost first.
    neutral_call_sites: Vec<(*const (), &'static [i32])>,

    pub arena: &'arena Arena,
    ext: Ext,
    pd: PhantomData<(
        &'input (),
        &'arena TF,
        //        &'arena TreeNode<'input, 'arena, Node, TF::Tok>,
    )>,
}

impl<'input, 'arena, Ext, Node, Input, TF> Debug
    for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BaseParser")
            .field("state", &self.state)
            .field("matched_eof", &self.matched_eof)
            .field("build_parse_trees", &self.build_parse_trees)
            .finish_non_exhaustive()
    }
}

impl<'input, 'arena, Ext, Node, Input, TF> Deref
    for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    type Target = Ext;

    fn deref(&self) -> &Self::Target {
        &self.ext
    }
}

impl<'input, 'arena, Ext, Node, Input, TF> DerefMut
    for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.ext
    }
}

pub trait ParserRecog<'input, 'arena, R, Tok>: Actions<'input, 'arena, R, Tok>
where
    'input: 'arena,
    R: Recognizer<'input, 'arena, Tok>,
    Tok: Token + 'input,
{
    fn get_atn_simulator_man(&self) -> &'static ParserATNSimulatorManager;
}

impl<'input, 'arena, Ext, Node, Input, TF> Recognizer<'input, 'arena, TF::Tok>
    for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    type Node = Node;

    fn sempred(
        &mut self,
        localctx: Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>>,
        rule_index: i32,
        action_index: i32,
    ) -> bool {
        Ext::sempred(localctx, rule_index, action_index, self)
    }

    fn get_rule_names(&self) -> &[&str] {
        self.ext.get_rule_names()
    }

    fn get_vocabulary(&self) -> &dyn Vocabulary {
        self.ext.get_vocabulary()
    }

    fn get_grammar_file_name(&self) -> &str {
        self.ext.get_grammar_file_name()
    }

    fn get_atn(&self) -> &ATN {
        self.interp.as_ref().unwrap().atn()
    }
}

impl<'input, 'arena, Ext, Node, Input, TF> Parser<'input, 'arena, TF>
    for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    fn get_arena(&self) -> &'arena Arena {
        self.arena
    }

    #[inline(always)]
    fn get_interpreter(&self) -> &'arena ParserATNSimulator<'arena> {
        unsafe {
            std::mem::transmute::<&ParserATNSimulator<'arena>, &'arena ParserATNSimulator<'arena>>(
                self.interp.as_ref().unwrap(),
            )
        }
    }

    fn get_token_factory(&self) -> &TF {
        self.input.get_token_source().get_token_factory()
    }

    #[inline(always)]
    fn get_current_context(&self) -> &'arena TreeNode<'input, 'arena, Node, TF::Tok> {
        self.ctx().unwrap()
    }

    #[inline(always)]
    fn get_current_context_opt(&self) -> Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>> {
        self.ctx()
    }

    fn consume(
        &mut self,
        err_handler: &mut impl ErrorStrategy<'input, 'arena, TF, Self>,
    ) -> Result<(), ANTLRError> {
        let o = self.get_current_token();
        if o.borrow().get_token_type() != TOKEN_EOF {
            self.input.consume();
        }
        if self.build_parse_trees || !self.parse_listeners.is_empty() {
            if err_handler.in_error_recovery_mode(self) {
                // todo report ructc inference issue
                let node = self.create_error_node(o)?;
                self.add_child_to_ctx(node);
                if self.muted == 0 {
                    for listener in &mut self.parse_listeners {
                        listener.visit_error_node(
                            node.as_error_node()
                                .expect("node was created as error node"),
                        )?
                    }
                }
            } else {
                let node = self.create_token_node(o)?;
                self.add_child_to_ctx(node);
                if self.muted == 0 {
                    for listener in &mut self.parse_listeners {
                        listener.visit_terminal(
                            node.as_terminal_node()
                                .expect("node was created as terminal node"),
                        )?
                    }
                }
            }
        }
        Ok(())
    }

    fn precpred(
        &self,
        _localctx: Option<&TreeNode<'input, 'arena, Node, TF::Tok>>,
        precedence: i32,
    ) -> bool {
        //        localctx.map(|it|println!("check at{}",it.to_string_tree(self)));
        //        println!("{}",self.get_precedence());
        precedence >= self.get_precedence()
    }

    fn get_input_stream_mut(&mut self) -> &mut dyn TokenStream<'input, 'arena, TF> {
        &mut self.input //.as_mut()
    }

    fn get_input_stream(&self) -> &dyn TokenStream<'input, 'arena, TF> {
        &self.input
    }

    #[inline]
    fn get_current_token(&self) -> &'arena TF::Tok {
        self.input.get(self.input.index())
    }

    fn get_expected_tokens<'a>(&'a self) -> Cow<'a, IntervalSet> {
        let states_stack = states_stack(self.ctx().unwrap());
        self.interp
            .as_ref()
            .unwrap()
            .atn()
            .get_expected_tokens::<TF::Tok>(self.state, states_stack)
    }

    fn add_error_listener(
        &mut self,
        listener: Box<dyn ErrorListener<'input, 'arena, Self, TF::Tok> + 'input>,
    ) {
        self.error_listeners
            .push(ErrorListenerDelegate::new(listener))
    }

    fn remove_error_listeners(&mut self) {
        self.error_listeners.clear();
    }

    fn notify_error_listeners(
        &self,
        msg: String,
        offending_token: Option<isize>,
        err: Option<&ANTLRError>,
    ) {
        cell_update(&self._syntax_errors, |it| it + 1);
        let offending_token: Option<&_> = match offending_token {
            None => Some(self.get_current_token().borrow()),
            Some(x) => Some(self.input.get(x).borrow()),
        };
        let line = offending_token.map_or(0, |x| x.get_line());
        let column = offending_token.map_or(-1, |x| x.get_char_position_in_line());

        for listener in self.error_listeners.iter() {
            listener.syntax_error(
                self,
                offending_token.map(|x| x as _),
                line,
                column,
                &msg,
                err,
            )
        }
    }

    fn get_error_lister_dispatch<'a>(
        &'a self,
    ) -> Box<dyn ErrorListener<'input, 'arena, Self, TF::Tok> + 'a> {
        Box::new(ProxyErrorListener {
            delegates: self.error_listeners.borrow(),
        })
    }

    fn is_expected_token(&self, _symbol: i32) -> bool {
        unimplemented!()
    }

    fn get_precedence(&self) -> i32 {
        *self.precedence_stack.last().unwrap_or(&-1)
    }

    #[inline(always)]
    fn neutral_call_sites(&self) -> &[(*const (), &'static [i32])] {
        &self.neutral_call_sites
    }

    #[inline(always)]
    fn get_state(&self) -> i32 {
        self.state
    }

    #[inline(always)]
    fn set_state(&mut self, v: i32) {
        self.state = v;
    }

    fn get_rule_invocation_stack(&self) -> Vec<String> {
        let mut vec = Vec::new();
        let rule_names = self.get_rule_names();
        let mut ctx = self.get_current_context();
        loop {
            let rule_index = ctx.get_rule_index();
            vec.push(rule_names.get(rule_index).unwrap_or(&"n/a").to_string());
            ctx = if let Some(parent) = ctx.get_parent() {
                parent
            } else {
                break;
            }
        }
        vec
    }

    #[cfg(feature = "recursion-limit")]
    fn get_recursion_limit(&self) -> u32 {
        self.recursion_limit
    }

    #[cfg(feature = "recursion-limit")]
    fn set_recursion_limit(&mut self, v: u32) {
        self.recursion_limit = v;
    }

    //    fn get_rule_invocation_stack(&self, c: _) -> Vec<String> {
    //        unimplemented!()
    //    }
}

#[allow(missing_docs)] // todo docs
impl<'input, 'arena, Ext, Node, Input, TF> BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    /// Replaces the input token stream, mirroring Java's
    /// `Parser.setTokenStream`.
    ///
    /// Unlike Java, this does not seek the old stream back to 0 or reset
    /// parser state; it is intended for swapping in a fresh stream before any
    /// rule invocation, as the ANTLR tool's interpreter tests do when they
    /// reuse one parser (and its decision DFAs) across several inputs.
    pub fn set_input_stream(&mut self, input: Input) {
        self.input = input;
    }

    pub fn new_base_parser(arena: &'arena Arena, input: Input, ext: Ext) -> Self {
        let atn_manager = ext.get_atn_simulator_man();
        let interp = ParserATNSimulator::new(atn_manager.get_simulator(arena));
        Self {
            atn_manager,
            interp: Some(interp),
            global_cache_threshold: 0,
            ctx: std::ptr::null_mut(),
            build_parse_trees: true,
            matched_eof: false,
            state: -1,
            input,
            precedence_stack: vec![0],
            #[cfg(feature = "recursion-limit")]
            recursion_limit: DEFAULT_RECURSION_LIMIT,
            #[cfg(feature = "recursion-limit")]
            current_recursion_depth: 0,
            parse_listeners: vec![],
            _syntax_errors: Cell::new(0),
            error_listeners: vec![ErrorListenerDelegate::new(
                Box::new(ConsoleErrorListener {})
                    as Box<dyn ErrorListener<'input, 'arena, Self, TF::Tok> + 'input>,
            )],
            muted: 0,
            resume: None,
            neutral_call_sites: Vec::new(),
            arena,
            ext,
            pd: PhantomData,
        }
    }

    pub fn set_global_cache_threshold(&mut self, threshold: usize) {
        self.global_cache_threshold = threshold;
    }

    pub fn get_interpreter_mut(&mut self) -> &mut ParserATNSimulator<'arena> {
        self.interp.as_mut().unwrap()
    }

    /// Predicts the alternative of a decision with its static SLL DFA table.
    ///
    /// Returns [`INVALID_ALT`] when the decision has no table and when the walk
    /// leaves the table at an escape state the generated code must handle with
    /// [`ParserATNSimulator::adaptive_predict`]. The virtual alternative of a
    /// shared-descent group is an escape too: this block has no arm for it (see
    /// [`Self::dfa_predict_virtual`]). A lookahead that has no table edge and no
    /// fallback alternative fails like the adaptive simulation does.
    ///
    /// The walk consumes tokens while it reads them and rewinds afterwards, so
    /// every step costs one `la(1)` and one `consume`. It must not read
    /// `la(k)`: a channel-filtering token stream resolves `la(k)` by scanning
    /// from the current token, which would make a k-token lookahead O(k^2).
    ///
    /// [`INVALID_ALT`]: crate::atn::INVALID_ALT
    pub fn dfa_predict(&mut self, decision: i32) -> Result<i32, ANTLRError> {
        let alt = self.dfa_walk(decision)?;
        if alt >= crate::dfa::static_parser_dfa::VIRTUAL_ALT_BASE {
            return Ok(crate::atn::INVALID_ALT);
        }
        Ok(alt)
    }

    /// Predicts like [`Self::dfa_predict`], but returns the virtual alternative
    /// of a shared-descent group (at or above
    /// [`VIRTUAL_ALT_BASE`](crate::dfa::static_parser_dfa::VIRTUAL_ALT_BASE))
    /// instead of deferring. A generated `DescentAltBlock` resolves the group to
    /// one of its member alternatives.
    pub fn dfa_predict_virtual(&mut self, decision: i32) -> Result<i32, ANTLRError> {
        self.dfa_walk(decision)
    }
    /// The table walk of [`Self::dfa_predict`] and
    /// [`Self::dfa_predict_virtual`].
    fn dfa_walk(&mut self, decision: i32) -> Result<i32, ANTLRError> {
        use crate::dfa::static_parser_dfa::{CONFLICT_ESCAPE, ESCAPE, GUARDED};

        let tables = self.get_interpreter().atn().static_dfas();
        if tables.is_empty() {
            return Ok(crate::atn::INVALID_ALT);
        }
        let Some(table) = tables.table(decision, self.get_precedence()) else {
            return Ok(crate::atn::INVALID_ALT);
        };
        let start_index = self.input.index();
        let mark = self.input.mark();
        let mut state = 0_i32;
        let result = loop {
            let accept = table.accept(state);
            if accept > 0 {
                self.input.seek(start_index);
                break Ok(accept);
            }
            if accept == CONFLICT_ESCAPE {
                self.input.seek(start_index);
                break match table.conflict_min_alt(state) {
                    Some(min_alt) => self
                        .get_interpreter()
                        .adaptive_predict_conflict(decision, min_alt, self),
                    None => Ok(crate::atn::INVALID_ALT),
                };
            }
            if accept == GUARDED {
                // A guarded conflict (an optional-postfix take or a precedence
                // loop's iterate) resolves to the guarded alternative unless
                // the real parse stack's epsilon-pop chase can reach a guard
                // root. The walk stops at the first invoking state whose follow
                // region cannot reach its own rule's stop.
                let mut defers = false;
                let mut context = self.ctx();
                while let Some(node) = context {
                    let invoking_state = node.get_invoking_state();
                    if invoking_state < 0 {
                        break;
                    }
                    let parent = node.get_parent();
                    let parent_ptr =
                        parent.map_or(std::ptr::null(), |p| p as *const _ as *const ());
                    if let Some((_, call_sites)) =
                        self.neutral_call_sites.iter().find(|&&(ptr, sites)| {
                            ptr == parent_ptr && sites.first() == Some(&invoking_state)
                        })
                    {
                        if call_sites
                            .iter()
                            .any(|&site| table.guard_step(site) == Some(true))
                        {
                            defers = true;
                            break;
                        }
                        if call_sites
                            .iter()
                            .all(|&site| table.guard_step(site) == Some(false))
                        {
                            break;
                        }
                        context = parent;
                        continue;
                    }
                    match table.guard_step(invoking_state) {
                        Some(true) => {
                            defers = true;
                            break;
                        }
                        Some(false) => break,
                        None => context = parent,
                    }
                }
                self.input.seek(start_index);
                break if defers {
                    Ok(crate::atn::INVALID_ALT)
                } else {
                    Ok(table.guarded_alt(state).unwrap_or(crate::atn::INVALID_ALT))
                };
            }
            if accept == ESCAPE {
                // A frontier continuation resumes from the position the walk
                // reached, so it must not rewind first.
                break match table.continuation(state) {
                    Some((slot, continuation)) => self.get_interpreter().resume_from_continuation(
                        decision,
                        slot,
                        table.num_continuations(),
                        continuation,
                        start_index,
                        self,
                    ),
                    None => {
                        self.input.seek(start_index);
                        Ok(crate::atn::INVALID_ALT)
                    }
                };
            }
            let token = self.input.la(1);
            match table.edge(state, token) {
                Some(target) => {
                    state = target;
                    if token != TOKEN_EOF {
                        self.input.consume();
                    }
                }
                None => {
                    if let Some(fallback) = table.fallback(state) {
                        self.input.seek(start_index);
                        break Ok(fallback);
                    }
                    let start = OwningToken::from(self.input.get(start_index) as &dyn Token);
                    let error = match self.input.lt(1) {
                        Some(offending) => ANTLRError::no_alt_full(
                            self,
                            start,
                            OwningToken::from(offending as &dyn Token),
                        ),
                        None => ANTLRError::no_alt(self),
                    };
                    self.input.seek(start_index);
                    break Err(error);
                }
            }
        };
        self.input.release(mark);
        result
    }
    /// Whether a shared-descent group can start a neutral parse here.
    ///
    /// A group cannot start while the re-descent of another group is pending,
    /// and not while parse listeners are attached without a parse tree: the
    /// muted listener events of the shared rule are replayed from its subtree.
    ///
    /// A group also cannot start in the SLL prediction mode. For an ambiguous
    /// input, SLL resolves the conflict of the decision to its minimum
    /// alternative, but the tail dispatch after the shared rule can select
    /// another member.
    #[doc(hidden)]
    pub fn descent_ready(&mut self) -> bool {
        self.drop_stale_resume();
        self.resume.is_none()
            && (self.build_parse_trees || self.parse_listeners.is_empty())
            && self.get_interpreter().get_prediction_mode() != PredictionMode::SLL
    }

    /// Ends a re-descent that moved past the start of its shared rule without
    /// calling it. An error recovery in the prefix can do that; the kept
    /// subtree is then useless.
    fn drop_stale_resume(&mut self) {
        let index = self.input.index();
        if let Some(resume) = self.resume.take_if(|resume| index > resume.shared_index) {
            self.input.release(resume.mark);
        }
    }

    /// Starts the neutral parse of a shared-descent group: the generated block
    /// calls the shared rule once, with parse listeners muted, to read the
    /// token after it.
    ///
    /// Skips the `prefix_len` leading tokens of the group (the table walk read
    /// them) and records the group's member `call_sites` so the shared rule's
    /// context has a real invoking state and full-context prediction inside it
    /// sees every member's follow state. Finish with
    /// [`Self::resume_neutral_parse`] to keep its subtree for the re-descent,
    /// or [`Self::abort_neutral_parse`] when the shared rule exits with an
    /// unrecoverable error.
    #[doc(hidden)]
    pub fn begin_neutral_parse(
        &mut self,
        call_sites: &'static [i32],
        prefix_len: usize,
    ) -> NeutralParse {
        let ctx = self.ctx();
        let start_index = self.input.index();
        let mark = self.input.mark();
        // Skip by consuming, not by index arithmetic: a channel-filtering
        // stream has off-channel tokens between the prefix tokens.
        for _ in 0..prefix_len {
            if self.input.la(1) != TOKEN_EOF {
                self.input.consume();
            }
        }
        let neutral = NeutralParse {
            start_index,
            mark,
            shared_index: self.input.index(),
            state: self.state,
            children: ctx.map_or(0, |ctx| ctx.get_child_count()),
            matched_eof: self.matched_eof,
        };
        self.neutral_call_sites.push((self.ctx, call_sites));
        self.muted += 1;
        self.state = call_sites.first().copied().unwrap_or(-1);
        neutral
    }

    /// Releases a neutral parse when the shared rule returned an
    /// unrecoverable error.
    #[doc(hidden)]
    pub fn abort_neutral_parse(&mut self, neutral: NeutralParse) {
        debug_assert!(self.muted > 0, "no neutral parse is active");
        self.muted -= 1;
        self.neutral_call_sites.pop();
        self.input.release(neutral.mark);
    }

    /// Finishes a neutral parse and keeps the subtree `node` of the shared rule
    /// `rule` for the re-descent.
    ///
    /// Rewinds the stream to the decision start and detaches `node` from the
    /// current context so the member alternative can re-descend through its
    /// prefix to its call of the shared rule, where [`Self::resume_take`]
    /// grafts `node` back and seeks to the tail.
    #[doc(hidden)]
    pub fn resume_neutral_parse(
        &mut self,
        neutral: NeutralParse,
        node: &'arena TreeNode<'input, 'arena, Node, TF::Tok>,
        rule: usize,
    ) {
        debug_assert!(self.muted > 0, "no neutral parse is active");
        self.muted -= 1;
        self.neutral_call_sites.pop();
        // The mark stays until the re-descent seeks forward to the tail.
        self.resume = Some(Resume {
            node,
            rule,
            shared_index: neutral.shared_index,
            tail_index: self.input.index(),
            matched_eof: self.matched_eof,
            mark: neutral.mark,
        });
        self.input.seek(neutral.start_index);
        if let Some(ctx) = unsafe { self.ctx_mut() } {
            ctx.truncate_children(neutral.children);
        }
        self.state = neutral.state;
        self.matched_eof = neutral.matched_eof;
    }

    /// Returns the subtree that a neutral parse kept for the shared rule
    /// `rule`, when the re-descent calls it at the position where the neutral
    /// parse started it. The subtree is grafted under the current context, the
    /// muted listener events are replayed, and the stream moves to the token
    /// after the subtree.
    ///
    /// Returns `None` when no re-descent is pending or `rule` is another rule.
    /// A call of `rule` at another position ends the re-descent: the kept
    /// subtree does not belong there, so the rule parses normally.
    #[doc(hidden)]
    pub fn resume_take(
        &mut self,
        rule: usize,
    ) -> Result<Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>>, ANTLRError> {
        let Some(resume) = self.resume.take_if(|resume| resume.rule == rule) else {
            return Ok(None);
        };
        if self.input.index() != resume.shared_index {
            self.input.release(resume.mark);
            return Ok(None);
        }
        let node = resume.node;
        let state = self.state;
        let parent = self.ctx();
        if self.build_parse_trees {
            self.add_child_to_ctx(node);
        }
        // The neutral parse created the context under the decision's context
        // at the time; the re-descent's context and call site may differ.
        self.set_current_ctx(Some(node));
        self.with_mut_ctx(|ctx| {
            ctx.set_parent(parent);
            ctx.set_invoking_state(state);
        });
        self.set_current_ctx(parent);
        if self.muted == 0 && !self.parse_listeners.is_empty() {
            self.replay_listener_events(node)?;
        }
        self.matched_eof = resume.matched_eof;
        self.input.seek(resume.tail_index);
        self.input.release(resume.mark);
        Ok(Some(node))
    }

    /// Fires the parse listener events of the subtree `root` in the order of
    /// a live parse: enter events in listener order, exit events in reverse
    /// listener order.
    ///
    /// A live parse of a left-recursive rule exits the previous context of
    /// the operator loop before it enters the new recursion context, and that
    /// previous context is the first child of the new one. So the replay
    /// visits such a first child before it enters its parent.
    fn replay_listener_events(
        &mut self,
        root: &'arena TreeNode<'input, 'arena, Node, TF::Tok>,
    ) -> Result<(), ANTLRError> {
        struct Frame<'a, T> {
            node: &'a T,
            next_child: usize,
            entered: bool,
        }
        // An explicit stack: the subtree can be as deep as the input.
        let mut stack = vec![Frame {
            node: root,
            next_child: 0,
            entered: false,
        }];
        while let Some(Frame {
            node,
            mut next_child,
            mut entered,
        }) = stack.pop()
        {
            if let Some(terminal) = node.as_terminal_node() {
                for listener in &mut self.parse_listeners {
                    listener.visit_terminal(terminal)?;
                }
                continue;
            }
            if let Some(error) = node.as_error_node() {
                for listener in &mut self.parse_listeners {
                    listener.visit_error_node(error)?;
                }
                continue;
            }
            if !entered {
                let previous = if next_child == 0 {
                    self.recursion_predecessor(node)
                } else {
                    None
                };
                if let Some(previous) = previous {
                    stack.push(Frame {
                        node,
                        next_child: 1,
                        entered: false,
                    });
                    stack.push(Frame {
                        node: previous,
                        next_child: 0,
                        entered: false,
                    });
                    continue;
                }
                for listener in self.parse_listeners.iter_mut() {
                    listener.enter_every_rule(node)?;
                    node.enter_rule(listener)?;
                }
                entered = true;
            }
            if let Some(child) = node.get_child(next_child) {
                next_child += 1;
                stack.push(Frame {
                    node,
                    next_child,
                    entered,
                });
                stack.push(Frame {
                    node: child,
                    next_child: 0,
                    entered: false,
                });
            } else {
                for listener in self.parse_listeners.iter_mut().rev() {
                    node.exit_rule(listener)?;
                    listener.exit_every_rule(node)?;
                }
            }
        }
        Ok(())
    }

    /// The previous context of the left-recursive operator loop that created
    /// the recursion context `node`: its first child, a context of the same
    /// rule that `push_new_recursion_context` re-parented with the rule start
    /// state as its invoking state.
    fn recursion_predecessor(
        &self,
        node: &'arena TreeNode<'input, 'arena, Node, TF::Tok>,
    ) -> Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>> {
        let first = node.get_child(0)?;
        if first.as_terminal_node().is_some() || first.as_error_node().is_some() {
            return None;
        }
        let rule = node.get_rule_index();
        let start = self.get_interpreter().atn().rule_to_start_state.get(rule)?;
        (first.get_rule_index() == rule && first.get_invoking_state() == start.get_state_number())
            .then_some(first)
    }

    /// If current context is same as the given one by pointer comparison
    #[inline]
    pub fn ctx_is(&self, other: Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>>) -> bool {
        if self.ctx.is_null() && other.is_none() {
            true
        } else if self.ctx.is_null() || other.is_none() {
            false
        } else {
            std::ptr::eq(self.ctx, other.unwrap() as *const _ as *const ())
        }
    }

    /// Gets a reference to current context.
    #[inline]
    pub fn ctx(&self) -> Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>> {
        if self.ctx.is_null() {
            None
        } else {
            unsafe { Some(&*(self.ctx as *const TreeNode<'input, 'arena, Node, TF::Tok>)) }
        }
    }

    /// Gets a mutable reference to current context.
    ///
    /// # Safety
    /// Follows the same safety rules as dereferencing *mut to &mut
    #[inline]
    pub unsafe fn ctx_mut(
        &mut self,
    ) -> Option<&'arena mut TreeNode<'input, 'arena, Node, TF::Tok>> {
        if self.ctx.is_null() {
            None
        } else {
            Some(&mut *(self.ctx as *mut TreeNode<'input, 'arena, Node, TF::Tok>))
        }
    }

    #[inline]
    fn parent_ctx(&self) -> Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>> {
        self.ctx().and_then(|it| it.get_parent())
    }

    #[inline]
    fn set_current_ctx(&mut self, ctx: Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>>) {
        if let Some(ctx) = ctx {
            self.ctx = ctx as *const TreeNode<'input, 'arena, Node, TF::Tok>
                as *mut TreeNode<'input, 'arena, Node, TF::Tok> as *mut ();
        } else {
            self.ctx = std::ptr::null_mut();
        }
    }

    pub fn take_ctx(&mut self) -> Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>> {
        if self.ctx.is_null() {
            None
        } else {
            let ret = unsafe { &*(self.ctx as *const TreeNode<'input, 'arena, Node, TF::Tok>) };
            self.ctx = std::ptr::null_mut();
            Some(ret)
        }
    }

    #[inline]
    fn add_child_to_ctx(&mut self, child: &'arena TreeNode<'input, 'arena, Node, TF::Tok>) {
        if !self.ctx.is_null() {
            unsafe {
                (*(self.ctx as *mut TreeNode<'input, 'arena, Node, TF::Tok>)).add_child(child);
            }
        }
    }

    #[inline]
    pub fn with_mut_ctx<F, R>(&mut self, f: F) -> R
    where
        F: FnOnce(&mut TreeNode<'input, 'arena, Node, TF::Tok>) -> R,
    {
        assert!(!self.ctx.is_null());
        unsafe { f(&mut *(self.ctx as *mut TreeNode<'input, 'arena, Node, TF::Tok>)) }
    }

    #[inline]
    pub fn match_token(
        &mut self,
        ttype: i32,
        err_handler: &mut impl ErrorStrategy<'input, 'arena, TF, Self>,
    ) -> Result<&'arena TF::Tok, ANTLRError> {
        let mut token = self.get_current_token();
        if token.get_token_type() == ttype {
            if ttype == TOKEN_EOF {
                self.matched_eof = true;
            }

            err_handler.report_match(self);
            self.consume(err_handler)?;
        } else {
            token = err_handler.recover_inline(self)?;
            if self.build_parse_trees && token.get_token_index() == -1 {
                self.add_child_to_ctx(self.create_error_node(token)?);
            }
        }
        Ok(token)
    }

    #[inline]
    pub fn match_wildcard(
        &mut self,
        err_handler: &mut impl ErrorStrategy<'input, 'arena, TF, Self>,
    ) -> Result<&'arena TF::Tok, ANTLRError> {
        let mut token = self.get_current_token();
        if token.get_token_type() > 0 {
            err_handler.report_match(self);
            self.consume(err_handler)?;
        } else {
            token = err_handler.recover_inline(self)?;
            if self.build_parse_trees && token.get_token_index() == -1 {
                self.add_child_to_ctx(self.create_error_node(token)?);
            }
        }
        Ok(token)
    }

    /// Adds parse listener for this parser
    /// returns `listener_id` that can be used later to get listener back
    ///
    /// ### Example for listener usage:
    /// todo
    pub fn add_dyn_parse_listener(&mut self, listener: Box<Node::Listener>) {
        self.parse_listeners.push(listener);
    }

    /// Removes parse listener with corresponding `listener_id`, casts it back to user type and returns it to the caller.
    /// `listener_id` is returned when listener is added via `add_parse_listener`
    pub fn remove_parse_listener<L>(&mut self, listener_id: ListenerId<L>) -> Box<L>
    where
        L: ParseTreeListener<'arena, Node, TF::Tok>,
    {
        let index = self
            .parse_listeners
            .iter()
            .position(|it| ListenerId::new(it).actual_id == listener_id.actual_id)
            .expect("listener not found");
        unsafe { listener_id.into_listener(self.parse_listeners.remove(index)) }
    }

    /// Removes all added parse listeners without returning them
    pub fn remove_parse_listeners(&mut self) {
        self.parse_listeners.clear()
    }

    pub fn trigger_enter_rule_event(&mut self) -> Result<(), ANTLRError> {
        if self.muted > 0 {
            return Ok(());
        }
        let ctx = self.ctx().unwrap();
        for listener in self.parse_listeners.iter_mut() {
            listener.enter_every_rule(ctx)?;
            ctx.enter_rule(listener)?;
        }
        Ok(())
    }

    pub fn trigger_exit_rule_event(&mut self) -> Result<(), ANTLRError> {
        if self.muted > 0 {
            return Ok(());
        }
        let ctx = self.ctx().unwrap();
        for listener in self.parse_listeners.iter_mut().rev() {
            ctx.exit_rule(listener)?;
            listener.exit_every_rule(ctx)?;
        }
        Ok(())
    }

    //    fn get_atn_with_bypass_alts(&self) { unimplemented!() }
    //
    //    fn compile_parse_tree_pattern(&self, pattern, patternRuleIndex: Lexer, lexer: Lexer) { unimplemented!() }

    #[inline]
    pub fn enter_rule(
        &mut self,
        localctx: &'arena mut TreeNode<'input, 'arena, Node, TF::Tok>,
        state: i32,
        _rule_index: usize,
    ) -> Result<(), ANTLRError> {
        let child = localctx;
        if self.build_parse_trees {
            self.set_current_ctx(child.get_parent());
            self.add_child_to_ctx(child);
        }

        self.set_state(state);
        self.set_current_ctx(Some(child));
        let start = self.input.lt(1);
        self.with_mut_ctx(|ctx| {
            ctx.set_start(start);
        });

        if !self.parse_listeners.is_empty() {
            self.trigger_enter_rule_event()?;
        }

        #[cfg(feature = "recursion-limit")]
        {
            self.current_recursion_depth += 1;
            if self.current_recursion_depth > self.recursion_limit {
                return Err(ANTLRError::recursion_limit_exceeded(self.recursion_limit));
            }
        }
        Ok(())
    }

    #[inline]
    pub fn exit_rule(
        &mut self,
    ) -> Result<&'arena TreeNode<'input, 'arena, Node, TF::Tok>, ANTLRError> {
        assert!(self.ctx().is_some());

        #[cfg(feature = "recursion-limit")]
        {
            self.current_recursion_depth -= 1;
        }
        if self.matched_eof {
            // if we have matched EOF, it cannot consume past EOF so we use LT(1) here
            let stop = self.input.lt(1);
            self.with_mut_ctx(|ctx| {
                ctx.set_stop(stop);
            });
        } else {
            // stop node is what we just matched
            let stop = self.input.lt(-1);
            self.with_mut_ctx(|ctx| {
                ctx.set_stop(stop);
            });
        }
        if !self.parse_listeners.is_empty() {
            self.trigger_exit_rule_event()?;
        }

        self.set_state(self.ctx().unwrap().get_invoking_state());
        let child = self.ctx().unwrap();
        self.set_current_ctx(child.get_parent());

        Ok(child)
    }

    pub fn enter_recursion_rule(
        &mut self,
        localctx: &'arena mut TreeNode<'input, 'arena, Node, TF::Tok>,
        state: i32,
        _rule_index: usize,
        precedence: i32,
    ) -> Result<(), ANTLRError> {
        self.set_state(state);
        self.precedence_stack.push(precedence);
        self.set_current_ctx(Some(localctx));
        let start = self.input.lt(1);
        self.with_mut_ctx(|ctx| {
            ctx.set_start(start);
        });
        if !self.parse_listeners.is_empty() {
            self.trigger_enter_rule_event()?;
        }
        //println!("{}",self.input.lt(1).map(Token::to_owned).unwrap());

        #[cfg(feature = "recursion-limit")]
        {
            self.current_recursion_depth += 1;
            if self.current_recursion_depth > self.recursion_limit {
                return Err(ANTLRError::recursion_limit_exceeded(self.recursion_limit));
            }
        }
        Ok(())
    }

    pub fn push_new_recursion_context(
        &mut self,
        localctx: &'arena mut TreeNode<'input, 'arena, Node, TF::Tok>,
        state: i32,
        _rule_index: usize,
    ) -> Result<&'arena TreeNode<'input, 'arena, Node, TF::Tok>, ANTLRError> {
        let stop = self.input.lt(-1);
        self.with_mut_ctx(|ctx| {
            ctx.set_parent(Some(localctx));
            ctx.set_invoking_state(state);
            ctx.set_stop(stop);
        });

        let prev = self.take_ctx().unwrap();
        self.set_current_ctx(Some(localctx));
        let start = prev.get_start_token();
        self.with_mut_ctx(|ctx| {
            ctx.set_start(start);
        });
        if self.build_parse_trees {
            self.add_child_to_ctx(prev);
        }
        if !self.parse_listeners.is_empty() {
            self.trigger_enter_rule_event()?;
        }
        Ok(prev)
    }

    pub fn unroll_recursion_context(
        &mut self,
        parent_ctx: Option<&'arena TreeNode<'input, 'arena, Node, TF::Tok>>,
    ) -> Result<&'arena TreeNode<'input, 'arena, Node, TF::Tok>, ANTLRError> {
        assert!(self.ctx().is_some());

        #[cfg(feature = "recursion-limit")]
        {
            self.current_recursion_depth -= 1;
        }
        self.precedence_stack.pop();
        let stop = self.input.lt(-1);
        self.with_mut_ctx(|ctx| {
            ctx.set_stop(stop);
        });
        let retctx = self.ctx;

        // unroll so _ctx is as it was before call to recursive method
        if !self.parse_listeners.is_empty() {
            while !self.ctx_is(parent_ctx) {
                self.trigger_exit_rule_event()?;
                self.set_current_ctx(self.parent_ctx());
            }
        } else {
            self.set_current_ctx(parent_ctx);
        }

        // hook into tree
        unsafe {
            (*(retctx as *mut TreeNode<'input, 'arena, Node, TF::Tok>)).set_parent(parent_ctx);
        }

        //        println!("{:?}",self.ctx.as_ref().map(|it|it.to_string_tree(self)));
        if self.build_parse_trees && parent_ctx.is_some() {
            self.add_child_to_ctx(unsafe {
                &*(retctx as *const TreeNode<'input, 'arena, Node, TF::Tok>)
            });
        }
        Ok(unsafe { &*(retctx as *const TreeNode<'input, 'arena, Node, TF::Tok>) })
    }

    #[allow(clippy::mut_from_ref)] // &mut is from the arena allocation
    fn create_token_node(
        &self,
        token: &'arena TF::Tok,
    ) -> Result<&'arena mut TreeNode<'input, 'arena, Node, TF::Tok>, ANTLRError> {
        let ptr = TreeNode::create_token_node(self.arena, token);
        if ptr.is_null() {
            #[cfg(feature = "arena-allocation-limit")]
            {
                Err(ANTLRError::arena_allocation_limit_exceeded(
                    self.arena.allocation_limit_bytes(),
                    self.arena.total_allocated_bytes(),
                ))
            }
            #[cfg(not(feature = "arena-allocation-limit"))]
            {
                std::alloc::handle_alloc_error(std::alloc::Layout::new::<
                    TreeNode<'input, 'arena, Node, TF::Tok>,
                >())
            }
        } else {
            Ok(unsafe { &mut *ptr })
        }
    }

    #[allow(clippy::mut_from_ref)] // &mut is from the arena allocation
    fn create_error_node(
        &self,
        token: &'arena TF::Tok,
    ) -> Result<&'arena mut TreeNode<'input, 'arena, Node, TF::Tok>, ANTLRError> {
        let ptr = TreeNode::create_error_node(self.arena, token);
        if ptr.is_null() {
            Err(ANTLRError::dfa_cache_limit_exceeded(0, 0, 0))
        } else {
            Ok(unsafe { &mut *ptr })
        }
    }

    /// Text representation of generated DFA for debugging purposes
    pub fn dump_dfa(&self) {
        let mut seen_one = false;
        for i in 0..self.get_atn().decision_to_state.len() {
            let dfa = self
                .get_interpreter()
                .decision_to_dfa(i)
                .expect("dfa should exist for each decision");
            if !dfa.is_empty() {
                if seen_one {
                    println!()
                }
                println!("Decision {}:", dfa.decision);
                print!("{}", dfa.to_string(self.get_vocabulary()));
                seen_one = true;
            }
        }
    }
}

impl<'input, 'arena, Ext, Node, Input, TF> Drop for BaseParser<'input, 'arena, Ext, Node, Input, TF>
where
    'input: 'arena,
    Ext: ParserRecog<'input, 'arena, Self, TF::Tok>,
    TF: TokenFactory<'input, 'arena> + 'arena,
    Input: TokenStream<'input, 'arena, TF>,
    Node: NodeKindType<'arena, TF::Tok>,
{
    fn drop(&mut self) {
        if self.global_cache_threshold == 0 {
            return;
        }

        let Some(interp) = self.interp.take() else {
            return;
        };
        let cache_bytes = interp.total_allocated_bytes();
        drop(interp);

        if cache_bytes > self.global_cache_threshold {
            self.atn_manager.reset_all();
        }
    }
}

/// Allows to safely cast listener back to user type
#[derive(Debug)]
pub struct ListenerId<T: ?Sized> {
    pub(crate) actual_id: usize,
    phantom: PhantomData<fn() -> T>,
}

impl<T: ?Sized> ListenerId<T> {
    #[allow(clippy::borrowed_box)]
    pub fn new(listener: &Box<T>) -> ListenerId<T> {
        ListenerId {
            actual_id: listener.as_ref() as *const T as *const () as usize,
            phantom: Default::default(),
        }
    }
}

impl<T> ListenerId<T> {
    unsafe fn into_listener<U: ?Sized>(self, boxed: Box<U>) -> Box<T> {
        Box::from_raw(Box::into_raw(boxed) as *mut T)
    }
}