类 DebugEventSocketProxy
- java.lang.Object
-
- org.antlr.runtime.debug.BlankDebugEventListener
-
- org.antlr.runtime.debug.DebugEventSocketProxy
-
- 所有已实现的接口:
DebugEventListener
public class DebugEventSocketProxy extends BlankDebugEventListener
A proxy debug event listener that forwards events over a socket to a debugger (or any other listener) using a simple text-based protocol; one event per line. ANTLRWorks listens on server socket with a RemoteDebugEventSocketListener instance. These two objects must therefore be kept in sync. New events must be handled on both sides of socket.
-
-
字段概要
字段 修饰符和类型 字段 说明 protected TreeAdaptor
adaptor
Almost certainly the recognizer will have adaptor set, but we don't know how to cast it (Parser or TreeParser) to get the adaptor field.static int
DEFAULT_DEBUGGER_PORT
protected java.lang.String
grammarFileName
protected java.io.BufferedReader
in
protected java.io.PrintWriter
out
protected int
port
protected BaseRecognizer
recognizer
Who am i debugging?protected java.net.ServerSocket
serverSocket
protected java.net.Socket
socket
-
从接口继承的字段 org.antlr.runtime.debug.DebugEventListener
FALSE, PROTOCOL_VERSION, TRUE
-
-
构造器概要
构造器 构造器 说明 DebugEventSocketProxy(BaseRecognizer recognizer, int port, TreeAdaptor adaptor)
DebugEventSocketProxy(BaseRecognizer recognizer, TreeAdaptor adaptor)
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected void
ack()
void
addChild(java.lang.Object root, java.lang.Object child)
Make childID a child of rootID.void
becomeRoot(java.lang.Object newRoot, java.lang.Object oldRoot)
Make a node the new root of an existing root.void
beginBacktrack(int level)
void
beginResync()
Indicates the recognizer is about to consume tokens to resynchronize the parser.void
commence()
Announce that parsing has begun.void
consumeHiddenToken(Token t)
An off-channel input token was consumed.void
consumeNode(java.lang.Object t)
Input for a tree parser is an AST, but we know nothing for sure about a node except its type and text (obtained from the adaptor).void
consumeToken(Token t)
An input token was consumed; matched by any kind of element.void
createNode(java.lang.Object t)
Announce a new node built from token elements such as type etc...void
createNode(java.lang.Object node, Token token)
Announce a new node built from an existing token.void
endBacktrack(int level, boolean successful)
void
endResync()
Indicates that the recognizer has finished consuming tokens in order to resychronize.void
enterAlt(int alt)
Because rules can have lots of alternatives, it is very useful to know which alt you are entering.void
enterDecision(int decisionNumber, boolean couldBacktrack)
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(java.lang.String grammarFileName, java.lang.String ruleName)
The parser has just entered a rule.void
enterSubRule(int decisionNumber)
Track entry into any (...) subrule other EBNF constructvoid
errorNode(java.lang.Object t)
Upon syntax error, recognizers bracket the error with an error node if they are building ASTs.protected java.lang.String
escapeNewlines(java.lang.String txt)
void
exitDecision(int decisionNumber)
void
exitRule(java.lang.String grammarFileName, java.lang.String ruleName)
This is the last thing executed before leaving a rule.void
exitSubRule(int decisionNumber)
TreeAdaptor
getTreeAdaptor()
void
handshake()
void
location(int line, int pos)
To watch a parser move through the grammar, the parser needs to inform the debugger what line/charPos it is passing in the grammar.void
LT(int i, java.lang.Object t)
The tree parser lookedahead.void
LT(int i, Token t)
Somebody (anybody) looked ahead.void
mark(int i)
The parser is going to look arbitrarily ahead; mark this location, the token stream's marker is sent in case you need it.void
nilNode(java.lang.Object t)
A nil was created (even nil nodes have a unique ID...void
recognitionException(RecognitionException e)
A recognition exception occurred such as NoViableAltException.void
rewind()
Rewind to the input position of the last marker.void
rewind(int i)
After an arbitrairly long lookahead as with a cyclic DFA (or with any backtrack), this informs the debugger that stream should be rewound to the position associated with marker.void
semanticPredicate(boolean result, java.lang.String predicate)
A semantic predicate was evaluate with this result and action textprotected void
serializeNode(java.lang.StringBuffer buf, java.lang.Object t)
protected void
serializeText(java.lang.StringBuffer buf, java.lang.String text)
protected java.lang.String
serializeToken(Token t)
void
setTokenBoundaries(java.lang.Object t, int tokenStartIndex, int tokenStopIndex)
Set the token start/stop token index for a subtree root or node.void
setTreeAdaptor(TreeAdaptor adaptor)
void
terminate()
Parsing is over; successfully or not.protected void
transmit(java.lang.String event)
-
-
-
字段详细资料
-
DEFAULT_DEBUGGER_PORT
public static final int DEFAULT_DEBUGGER_PORT
- 另请参阅:
- 常量字段值
-
port
protected int port
-
serverSocket
protected java.net.ServerSocket serverSocket
-
socket
protected java.net.Socket socket
-
grammarFileName
protected java.lang.String grammarFileName
-
out
protected java.io.PrintWriter out
-
in
protected java.io.BufferedReader in
-
recognizer
protected BaseRecognizer recognizer
Who am i debugging?
-
adaptor
protected TreeAdaptor adaptor
Almost certainly the recognizer will have adaptor set, but we don't know how to cast it (Parser or TreeParser) to get the adaptor field. Must be set with a constructor. :(
-
-
构造器详细资料
-
DebugEventSocketProxy
public DebugEventSocketProxy(BaseRecognizer recognizer, TreeAdaptor adaptor)
-
DebugEventSocketProxy
public DebugEventSocketProxy(BaseRecognizer recognizer, int port, TreeAdaptor adaptor)
-
-
方法详细资料
-
handshake
public void handshake() throws java.io.IOException
- 抛出:
java.io.IOException
-
commence
public void commence()
从接口复制的说明:DebugEventListener
Announce that parsing has begun. Not technically useful except for sending events over a socket. A GUI for example will launch a thread to connect and communicate with a remote parser. The thread will want to notify the GUI when a connection is made. ANTLR parsers trigger this upon entry to the first rule (the ruleLevel is used to figure this out).- 指定者:
commence
在接口中DebugEventListener
- 覆盖:
commence
在类中BlankDebugEventListener
-
terminate
public void terminate()
从接口复制的说明: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.- 指定者:
terminate
在接口中DebugEventListener
- 覆盖:
terminate
在类中BlankDebugEventListener
-
ack
protected void ack()
-
transmit
protected void transmit(java.lang.String event)
-
enterRule
public void enterRule(java.lang.String grammarFileName, java.lang.String ruleName)
从接口复制的说明: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.- 指定者:
enterRule
在接口中DebugEventListener
- 覆盖:
enterRule
在类中BlankDebugEventListener
-
enterAlt
public void enterAlt(int alt)
从接口复制的说明:DebugEventListener
Because rules can have lots of alternatives, it is very useful to know which alt you are entering. This is 1..n for n alts.- 指定者:
enterAlt
在接口中DebugEventListener
- 覆盖:
enterAlt
在类中BlankDebugEventListener
-
exitRule
public void exitRule(java.lang.String grammarFileName, java.lang.String ruleName)
从接口复制的说明: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.- 指定者:
exitRule
在接口中DebugEventListener
- 覆盖:
exitRule
在类中BlankDebugEventListener
-
enterSubRule
public void enterSubRule(int decisionNumber)
从接口复制的说明:DebugEventListener
Track entry into any (...) subrule other EBNF construct- 指定者:
enterSubRule
在接口中DebugEventListener
- 覆盖:
enterSubRule
在类中BlankDebugEventListener
-
exitSubRule
public void exitSubRule(int decisionNumber)
- 指定者:
exitSubRule
在接口中DebugEventListener
- 覆盖:
exitSubRule
在类中BlankDebugEventListener
-
enterDecision
public void enterDecision(int decisionNumber, boolean couldBacktrack)
从接口复制的说明: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.- 指定者:
enterDecision
在接口中DebugEventListener
- 覆盖:
enterDecision
在类中BlankDebugEventListener
-
exitDecision
public void exitDecision(int decisionNumber)
- 指定者:
exitDecision
在接口中DebugEventListener
- 覆盖:
exitDecision
在类中BlankDebugEventListener
-
consumeToken
public void consumeToken(Token t)
从接口复制的说明:DebugEventListener
An input token was consumed; matched by any kind of element. Trigger after the token was matched by things like match(), matchAny().- 指定者:
consumeToken
在接口中DebugEventListener
- 覆盖:
consumeToken
在类中BlankDebugEventListener
-
consumeHiddenToken
public void consumeHiddenToken(Token t)
从接口复制的说明: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).- 指定者:
consumeHiddenToken
在接口中DebugEventListener
- 覆盖:
consumeHiddenToken
在类中BlankDebugEventListener
-
LT
public void LT(int i, Token t)
从接口复制的说明:DebugEventListener
Somebody (anybody) looked ahead. Note that this actually gets triggered by both LA and LT calls. The debugger will want to know which Token object was examined. Like consumeToken, this indicates what token was seen at that depth. A remote debugger cannot look ahead into a file it doesn't have so LT events must pass the token even if the info is redundant.- 指定者:
LT
在接口中DebugEventListener
- 覆盖:
LT
在类中BlankDebugEventListener
-
mark
public void mark(int i)
从接口复制的说明:DebugEventListener
The parser is going to look arbitrarily ahead; mark this location, the token stream's marker is sent in case you need it.- 指定者:
mark
在接口中DebugEventListener
- 覆盖:
mark
在类中BlankDebugEventListener
-
rewind
public void rewind(int i)
从接口复制的说明:DebugEventListener
After an arbitrairly long lookahead as with a cyclic DFA (or with any backtrack), this informs the debugger that stream should be rewound to the position associated with marker.- 指定者:
rewind
在接口中DebugEventListener
- 覆盖:
rewind
在类中BlankDebugEventListener
-
rewind
public void rewind()
从接口复制的说明:DebugEventListener
Rewind to the input position of the last marker. Used currently only after a cyclic DFA and just before starting a sem/syn predicate to get the input position back to the start of the decision. Do not "pop" the marker off the state. mark(i) and rewind(i) should balance still.- 指定者:
rewind
在接口中DebugEventListener
- 覆盖:
rewind
在类中BlankDebugEventListener
-
beginBacktrack
public void beginBacktrack(int level)
- 指定者:
beginBacktrack
在接口中DebugEventListener
- 覆盖:
beginBacktrack
在类中BlankDebugEventListener
-
endBacktrack
public void endBacktrack(int level, boolean successful)
- 指定者:
endBacktrack
在接口中DebugEventListener
- 覆盖:
endBacktrack
在类中BlankDebugEventListener
-
location
public void location(int line, int pos)
从接口复制的说明:DebugEventListener
To watch a parser move through the grammar, the parser needs to inform the debugger what line/charPos it is passing in the grammar. For now, this does not know how to switch from one grammar to the other and back for island grammars etc... This should also allow breakpoints because the debugger can stop the parser whenever it hits this line/pos.- 指定者:
location
在接口中DebugEventListener
- 覆盖:
location
在类中BlankDebugEventListener
-
recognitionException
public void recognitionException(RecognitionException e)
从接口复制的说明: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- 指定者:
recognitionException
在接口中DebugEventListener
- 覆盖:
recognitionException
在类中BlankDebugEventListener
-
beginResync
public void beginResync()
从接口复制的说明:DebugEventListener
Indicates the recognizer is about to consume tokens to resynchronize the parser. Any consume events from here until the recovered event are not part of the parse--they are dead tokens.- 指定者:
beginResync
在接口中DebugEventListener
- 覆盖:
beginResync
在类中BlankDebugEventListener
-
endResync
public void endResync()
从接口复制的说明:DebugEventListener
Indicates that the recognizer has finished consuming tokens in order to resychronize. There may be multiple beginResync/endResync pairs before the recognizer comes out of errorRecovery mode (in which multiple errors are suppressed). This will be useful in a gui where you want to probably grey out tokens that are consumed but not matched to anything in grammar. Anything between a beginResync/endResync pair was tossed out by the parser.- 指定者:
endResync
在接口中DebugEventListener
- 覆盖:
endResync
在类中BlankDebugEventListener
-
semanticPredicate
public void semanticPredicate(boolean result, java.lang.String predicate)
从接口复制的说明:DebugEventListener
A semantic predicate was evaluate with this result and action text- 指定者:
semanticPredicate
在接口中DebugEventListener
- 覆盖:
semanticPredicate
在类中BlankDebugEventListener
-
consumeNode
public void consumeNode(java.lang.Object t)
从接口复制的说明:DebugEventListener
Input for a tree parser is an AST, but we know nothing for sure about a node except its type and text (obtained from the adaptor). This is the analog of the consumeToken method. Again, the ID is the hashCode usually of the node so it only works if hashCode is not implemented. If the type is UP or DOWN, then the ID is not really meaningful as it's fixed--there is just one UP node and one DOWN navigation node.- 指定者:
consumeNode
在接口中DebugEventListener
- 覆盖:
consumeNode
在类中BlankDebugEventListener
-
LT
public void LT(int i, java.lang.Object t)
从接口复制的说明:DebugEventListener
The tree parser lookedahead. If the type is UP or DOWN, then the ID is not really meaningful as it's fixed--there is just one UP node and one DOWN navigation node.- 指定者:
LT
在接口中DebugEventListener
- 覆盖:
LT
在类中BlankDebugEventListener
-
serializeNode
protected void serializeNode(java.lang.StringBuffer buf, java.lang.Object t)
-
nilNode
public void nilNode(java.lang.Object t)
从接口复制的说明:DebugEventListener
A nil was created (even nil nodes have a unique ID... they are not "null" per se). As of 4/28/2006, this seems to be uniquely triggered when starting a new subtree such as when entering a subrule in automatic mode and when building a tree in rewrite mode. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID is set.- 指定者:
nilNode
在接口中DebugEventListener
- 覆盖:
nilNode
在类中BlankDebugEventListener
-
errorNode
public void errorNode(java.lang.Object t)
从接口复制的说明:DebugEventListener
Upon syntax error, recognizers bracket the error with an error node if they are building ASTs.- 指定者:
errorNode
在接口中DebugEventListener
- 覆盖:
errorNode
在类中BlankDebugEventListener
-
createNode
public void createNode(java.lang.Object t)
从接口复制的说明:DebugEventListener
Announce a new node built from token elements such as type etc... If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID, type, text are set.- 指定者:
createNode
在接口中DebugEventListener
- 覆盖:
createNode
在类中BlankDebugEventListener
-
createNode
public void createNode(java.lang.Object node, Token token)
从接口复制的说明:DebugEventListener
Announce a new node built from an existing token. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only node.ID and token.tokenIndex are set.- 指定者:
createNode
在接口中DebugEventListener
- 覆盖:
createNode
在类中BlankDebugEventListener
-
becomeRoot
public void becomeRoot(java.lang.Object newRoot, java.lang.Object oldRoot)
从接口复制的说明:DebugEventListener
Make a node the new root of an existing root. See Note: the newRootID parameter is possibly different than the TreeAdaptor.becomeRoot() newRoot parameter. In our case, it will always be the result of calling TreeAdaptor.becomeRoot() and not root_n or whatever. The listener should assume that this event occurs only when the current subrule (or rule) subtree is being reset to newRootID. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.
-
addChild
public void addChild(java.lang.Object root, java.lang.Object child)
从接口复制的说明:DebugEventListener
Make childID a child of rootID. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.
-
setTokenBoundaries
public void setTokenBoundaries(java.lang.Object t, int tokenStartIndex, int tokenStopIndex)
从接口复制的说明:DebugEventListener
Set the token start/stop token index for a subtree root or node. If you are receiving this event over a socket via RemoteDebugEventSocketListener then only t.ID is set.- 指定者:
setTokenBoundaries
在接口中DebugEventListener
- 覆盖:
setTokenBoundaries
在类中BlankDebugEventListener
-
setTreeAdaptor
public void setTreeAdaptor(TreeAdaptor adaptor)
-
getTreeAdaptor
public TreeAdaptor getTreeAdaptor()
-
serializeToken
protected java.lang.String serializeToken(Token t)
-
serializeText
protected void serializeText(java.lang.StringBuffer buf, java.lang.String text)
-
escapeNewlines
protected java.lang.String escapeNewlines(java.lang.String txt)
-
-