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
/* Copyright (c) 2012-2017 The ANTLR Project. All rights reserved.
* Use of this file is governed by the BSD 3-clause license that
* can be found in the LICENSE.txt file in the project root.
*/
#pragma once
#include "antlr4-common.h"
#include "atn/ATNConfigSet.h"
#include "FlatHashMap.h"
namespace antlr4 {
namespace dfa {
/// <summary>
/// A DFA state represents a set of possible ATN configurations.
/// As Aho, Sethi, Ullman p. 117 says "The DFA uses its state
/// to keep track of all possible states the ATN can be in after
/// reading each input symbol. That is to say, after reading
/// input a1a2..an, the DFA is in a state that represents the
/// subset T of the states of the ATN that are reachable from the
/// ATN's start state along some path labeled a1a2..an."
/// In conventional NFA->DFA conversion, therefore, the subset T
/// would be a bitset representing the set of states the
/// ATN could be in. We need to track the alt predicted by each
/// state as well, however. More importantly, we need to maintain
/// a stack of states, tracking the closure operations as they
/// jump from rule to rule, emulating rule invocations (method calls).
/// I have to add a stack to simulate the proper lookahead sequences for
/// the underlying LL grammar from which the ATN was derived.
/// <p/>
/// I use a set of ATNConfig objects not simple states. An ATNConfig
/// is both a state (ala normal conversion) and a RuleContext describing
/// the chain of rules (if any) followed to arrive at that state.
/// <p/>
/// A DFA state may have multiple references to a particular state,
/// but with different ATN contexts (with same or different alts)
/// meaning that state was reached via a different set of rule invocations.
/// </summary>
class ANTLR4CPP_PUBLIC DFAState final {
public:
struct ANTLR4CPP_PUBLIC PredPrediction final {
public:
Ref<const atn::SemanticContext> pred; // never null; at least SemanticContext.NONE
int alt;
PredPrediction() = delete;
PredPrediction(const PredPrediction&) = default;
PredPrediction(PredPrediction&&) = default;
PredPrediction(Ref<const atn::SemanticContext> pred, int alt) : pred(std::move(pred)), alt(alt) {}
PredPrediction& operator=(const PredPrediction&) = default;
PredPrediction& operator=(PredPrediction&&) = default;
std::string toString() const;
};
std::unique_ptr<atn::ATNConfigSet> configs;
/// {@code edges[symbol]} points to target of symbol. Shift up by 1 so (-1)
/// <seealso cref="Token#EOF"/> maps to {@code edges[0]}.
// ml: this is a sparse list, so we use a map instead of a vector.
// Watch out: we no longer have the -1 offset, as it isn't needed anymore.
FlatHashMap<size_t, DFAState*> edges;
/// if accept state, what ttype do we match or alt do we predict?
/// This is set to <seealso cref="ATN#INVALID_ALT_NUMBER"/> when <seealso cref="#predicates"/>{@code !=null} or
/// <seealso cref="#requiresFullContext"/>.
size_t prediction = 0;
Ref<const atn::LexerActionExecutor> lexerActionExecutor;
/// <summary>
/// During SLL parsing, this is a list of predicates associated with the
/// ATN configurations of the DFA state. When we have predicates,
/// <seealso cref="#requiresFullContext"/> is {@code false} since full context prediction evaluates predicates
/// on-the-fly. If this is not null, then <seealso cref="#prediction"/> is
/// <seealso cref="ATN#INVALID_ALT_NUMBER"/>.
/// <p/>
/// We only use these for non-<seealso cref="#requiresFullContext"/> but conflicting states. That
/// means we know from the context (it's $ or we don't dip into outer
/// context) that it's an ambiguity not a conflict.
/// <p/>
/// This list is computed by <seealso cref="ParserATNSimulator#predicateDFAState"/>.
/// </summary>
std::vector<PredPrediction> predicates;
int stateNumber = -1;
bool isAcceptState = false;
/// <summary>
/// Indicates that this state was created during SLL prediction that
/// discovered a conflict between the configurations in the state. Future
/// <seealso cref="ParserATNSimulator#execATN"/> invocations immediately jumped doing
/// full context prediction if this field is true.
/// </summary>
bool requiresFullContext = false;
/// Map a predicate to a predicted alternative.
DFAState() = default;
explicit DFAState(int stateNumber) : stateNumber(stateNumber) {}
explicit DFAState(std::unique_ptr<atn::ATNConfigSet> configs) : configs(std::move(configs)) {}
/// <summary>
/// Get the set of all alts mentioned by all ATN configurations in this
/// DFA state.
/// </summary>
std::set<size_t> getAltSet() const;
size_t hashCode() const;
/// Two DFAState instances are equal if their ATN configuration sets
/// are the same. This method is used to see if a state already exists.
///
/// Because the number of alternatives and number of ATN configurations are
/// finite, there is a finite number of DFA states that can be processed.
/// This is necessary to show that the algorithm terminates.
///
/// Cannot test the DFA state numbers here because in
/// ParserATNSimulator#addDFAState we need to know if any other state
/// exists that has this exact set of ATN configurations. The
/// stateNumber is irrelevant.
bool equals(const DFAState &other) const;
std::string toString() const;
};
inline bool operator==(const DFAState &lhs, const DFAState &rhs) {
return lhs.equals(rhs);
}
inline bool operator!=(const DFAState &lhs, const DFAState &rhs) {
return !operator==(lhs, rhs);
}
} // namespace dfa
} // namespace antlr4
namespace std {
template <>
struct hash<::antlr4::dfa::DFAState> {
size_t operator()(const ::antlr4::dfa::DFAState &dfaState) const {
return dfaState.hashCode();
}
};
} // namespace std