Package org.antlr.runtime.debug
Class Profiler
- java.lang.Object
-
- org.antlr.runtime.debug.BlankDebugEventListener
-
- org.antlr.runtime.debug.Profiler
-
- All Implemented Interfaces:
DebugEventListener
public class Profiler extends BlankDebugEventListener
Using the debug event interface, track what is happening in the parser and record statistics about the runtime.
-
-
Field Summary
Fields Modifier and Type Field Description protected int
decisionLevel
int[]
decisionMaxCyclicLookaheads
int[]
decisionMaxFixedLookaheads
List
decisionMaxSynPredLookaheads
protected CommonToken
lastTokenConsumed
protected List
lookaheadStack
protected int
maxLookaheadInCurrentDecision
int
maxRuleInvocationDepth
static int
NUM_RUNTIME_STATS
int
numBacktrackDecisions
protected int
numberReportedErrors
int
numCharsMatched
int
numCyclicDecisions
int
numFixedDecisions
int
numGuessingRuleInvocations
int
numHiddenCharsMatched
int
numHiddenTokens
int
numMemoizationCacheEntries
int
numMemoizationCacheHits
int
numMemoizationCacheMisses
int
numRuleInvocations
int
numSemanticPredicates
int
numSyntacticPredicates
DebugParser
parser
protected int
ruleLevel
static String
RUNTIME_STATS_FILENAME
static String
Version
Because I may change the stats, I need to track that for later computations to be consistent.-
Fields inherited from interface org.antlr.runtime.debug.DebugEventListener
FALSE, PROTOCOL_VERSION, TRUE
-
-
Constructor Summary
Constructors Constructor Description Profiler()
Profiler(DebugParser parser)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginBacktrack(int level)
Track backtracking decisions.void
consumeHiddenToken(Token token)
An off-channel input token was consumed.void
consumeToken(Token token)
An input token was consumed; matched by any kind of element.protected static String[]
decodeReportData(String data)
void
endBacktrack(int level, boolean successful)
Successful or not, track how much lookahead synpreds usevoid
enterDecision(int decisionNumber)
Every decision, fixed k or arbitrary, has an enter/exit event so that a GUI can easily track what LT/consume events are associated with prediction.void
enterRule(String grammarFileName, String ruleName)
The parser has just entered a rule.void
examineRuleMemoization(IntStream input, int ruleIndex, String ruleName)
Track memoization; this is not part of standard debug interface but is triggered by profiling.void
exitDecision(int decisionNumber)
void
exitRule(String grammarFileName, String ruleName)
This is the last thing executed before leaving a rule.int
getNumberOfHiddenTokens(int i, int j)
Get num hidden tokens between i..j inclusiveboolean
inDecision()
The parser is in a decision if the decision depth > 0.void
LT(int i, Token t)
Track refs to lookahead if in a fixed/nonfixed decision.void
memoize(IntStream input, int ruleIndex, int ruleStartIndex, String ruleName)
void
recognitionException(RecognitionException e)
A recognition exception occurred such as NoViableAltException.void
semanticPredicate(boolean result, String predicate)
A semantic predicate was evaluate with this result and action textvoid
setParser(DebugParser parser)
void
terminate()
Parsing is over; successfully or not.protected int[]
toArray(List a)
String
toNotifyString()
String
toString()
static String
toString(String notifyDataLine)
protected int[]
trim(int[] X, int n)
-
Methods inherited from class org.antlr.runtime.debug.BlankDebugEventListener
addChild, becomeRoot, beginResync, commence, consumeNode, createNode, createNode, endResync, enterAlt, enterSubRule, errorNode, exitSubRule, location, LT, mark, nilNode, rewind, rewind, setTokenBoundaries
-
-
-
-
Field Detail
-
Version
public static final String Version
Because I may change the stats, I need to track that for later computations to be consistent.- See Also:
- Constant Field Values
-
RUNTIME_STATS_FILENAME
public static final String RUNTIME_STATS_FILENAME
- See Also:
- Constant Field Values
-
NUM_RUNTIME_STATS
public static final int NUM_RUNTIME_STATS
- See Also:
- Constant Field Values
-
parser
public DebugParser parser
-
ruleLevel
protected int ruleLevel
-
decisionLevel
protected int decisionLevel
-
maxLookaheadInCurrentDecision
protected int maxLookaheadInCurrentDecision
-
lastTokenConsumed
protected CommonToken lastTokenConsumed
-
lookaheadStack
protected List lookaheadStack
-
numRuleInvocations
public int numRuleInvocations
-
numGuessingRuleInvocations
public int numGuessingRuleInvocations
-
maxRuleInvocationDepth
public int maxRuleInvocationDepth
-
numFixedDecisions
public int numFixedDecisions
-
numCyclicDecisions
public int numCyclicDecisions
-
numBacktrackDecisions
public int numBacktrackDecisions
-
decisionMaxFixedLookaheads
public int[] decisionMaxFixedLookaheads
-
decisionMaxCyclicLookaheads
public int[] decisionMaxCyclicLookaheads
-
decisionMaxSynPredLookaheads
public List decisionMaxSynPredLookaheads
-
numHiddenTokens
public int numHiddenTokens
-
numCharsMatched
public int numCharsMatched
-
numHiddenCharsMatched
public int numHiddenCharsMatched
-
numSemanticPredicates
public int numSemanticPredicates
-
numSyntacticPredicates
public int numSyntacticPredicates
-
numberReportedErrors
protected int numberReportedErrors
-
numMemoizationCacheMisses
public int numMemoizationCacheMisses
-
numMemoizationCacheHits
public int numMemoizationCacheHits
-
numMemoizationCacheEntries
public int numMemoizationCacheEntries
-
-
Constructor Detail
-
Profiler
public Profiler()
-
Profiler
public Profiler(DebugParser parser)
-
-
Method Detail
-
enterRule
public void enterRule(String grammarFileName, String ruleName)
Description copied from interface:DebugEventListener
The parser has just entered a rule. No decision has been made about which alt is predicted. This is fired AFTER init actions have been executed. Attributes are defined and available etc... The grammarFileName allows composite grammars to jump around among multiple grammar files.- Specified by:
enterRule
in interfaceDebugEventListener
- Overrides:
enterRule
in classBlankDebugEventListener
-
examineRuleMemoization
public void examineRuleMemoization(IntStream input, int ruleIndex, String ruleName)
Track memoization; this is not part of standard debug interface but is triggered by profiling. Code gen inserts an override for this method in the recognizer, which triggers this method.
-
exitRule
public void exitRule(String grammarFileName, String ruleName)
Description copied from interface:DebugEventListener
This is the last thing executed before leaving a rule. It is executed even if an exception is thrown. This is triggered after error reporting and recovery have occurred (unless the exception is not caught in this rule). This implies an "exitAlt" event. The grammarFileName allows composite grammars to jump around among multiple grammar files.- Specified by:
exitRule
in interfaceDebugEventListener
- Overrides:
exitRule
in classBlankDebugEventListener
-
enterDecision
public void enterDecision(int decisionNumber)
Description copied from interface:DebugEventListener
Every decision, fixed k or arbitrary, has an enter/exit event so that a GUI can easily track what LT/consume events are associated with prediction. You will see a single enter/exit subrule but multiple enter/exit decision events, one for each loop iteration.- Specified by:
enterDecision
in interfaceDebugEventListener
- Overrides:
enterDecision
in classBlankDebugEventListener
-
exitDecision
public void exitDecision(int decisionNumber)
- Specified by:
exitDecision
in interfaceDebugEventListener
- Overrides:
exitDecision
in classBlankDebugEventListener
-
consumeToken
public void consumeToken(Token token)
Description copied from interface:DebugEventListener
An input token was consumed; matched by any kind of element. Trigger after the token was matched by things like match(), matchAny().- Specified by:
consumeToken
in interfaceDebugEventListener
- Overrides:
consumeToken
in classBlankDebugEventListener
-
inDecision
public boolean inDecision()
The parser is in a decision if the decision depth > 0. This works for backtracking also, which can have nested decisions.
-
consumeHiddenToken
public void consumeHiddenToken(Token token)
Description copied from interface:DebugEventListener
An off-channel input token was consumed. Trigger after the token was matched by things like match(), matchAny(). (unless of course the hidden token is first stuff in the input stream).- Specified by:
consumeHiddenToken
in interfaceDebugEventListener
- Overrides:
consumeHiddenToken
in classBlankDebugEventListener
-
LT
public void LT(int i, Token t)
Track refs to lookahead if in a fixed/nonfixed decision.- Specified by:
LT
in interfaceDebugEventListener
- Overrides:
LT
in classBlankDebugEventListener
-
beginBacktrack
public void beginBacktrack(int level)
Track backtracking decisions. You'll see a fixed or cyclic decision and then a backtrack. enter rule ... enter decision LA and possibly consumes (for cyclic DFAs) begin backtrack level mark m rewind m end backtrack level, success exit decision ... exit rule- Specified by:
beginBacktrack
in interfaceDebugEventListener
- Overrides:
beginBacktrack
in classBlankDebugEventListener
-
endBacktrack
public void endBacktrack(int level, boolean successful)
Successful or not, track how much lookahead synpreds use- Specified by:
endBacktrack
in interfaceDebugEventListener
- Overrides:
endBacktrack
in classBlankDebugEventListener
-
recognitionException
public void recognitionException(RecognitionException e)
Description copied from interface:DebugEventListener
A recognition exception occurred such as NoViableAltException. I made this a generic event so that I can alter the exception hierachy later without having to alter all the debug objects. Upon error, the stack of enter rule/subrule must be properly unwound. If no viable alt occurs it is within an enter/exit decision, which also must be rewound. Even the rewind for each mark must be unwount. In the Java target this is pretty easy using try/finally, if a bit ugly in the generated code. The rewind is generated in DFA.predict() actually so no code needs to be generated for that. For languages w/o this "finally" feature (C++?), the target implementor will have to build an event stack or something. Across a socket for remote debugging, only the RecognitionException data fields are transmitted. The token object or whatever that caused the problem was the last object referenced by LT. The immediately preceding LT event should hold the unexpected Token or char. Here is a sample event trace for grammar: b : C ({;}A|B) // {;} is there to prevent A|B becoming a set | D ; The sequence for this rule (with no viable alt in the subrule) for input 'c c' (there are 3 tokens) is: commence LT(1) enterRule b location 7 1 enter decision 3 LT(1) exit decision 3 enterAlt1 location 7 5 LT(1) consumeToken [c/<4>,1:0] location 7 7 enterSubRule 2 enter decision 2 LT(1) LT(1) recognitionException NoViableAltException 2 1 2 exit decision 2 exitSubRule 2 beginResync LT(1) consumeToken [c/<4>,1:1] LT(1) endResync LT(-1) exitRule b terminate- Specified by:
recognitionException
in interfaceDebugEventListener
- Overrides:
recognitionException
in classBlankDebugEventListener
-
semanticPredicate
public void semanticPredicate(boolean result, String predicate)
Description copied from interface:DebugEventListener
A semantic predicate was evaluate with this result and action text- Specified by:
semanticPredicate
in interfaceDebugEventListener
- Overrides:
semanticPredicate
in classBlankDebugEventListener
-
terminate
public void terminate()
Description copied from interface:DebugEventListener
Parsing is over; successfully or not. Mostly useful for telling remote debugging listeners that it's time to quit. When the rule invocation level goes to zero at the end of a rule, we are done parsing.- Specified by:
terminate
in interfaceDebugEventListener
- Overrides:
terminate
in classBlankDebugEventListener
-
setParser
public void setParser(DebugParser parser)
-
toNotifyString
public String toNotifyString()
-
trim
protected int[] trim(int[] X, int n)
-
toArray
protected int[] toArray(List a)
-
getNumberOfHiddenTokens
public int getNumberOfHiddenTokens(int i, int j)
Get num hidden tokens between i..j inclusive
-
-