Class DebugEventSocketProxy

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

(inherited documentation)

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).

Overrides: DebugEventListener.commence

(inherited documentation)

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.

Overrides: DebugEventListener.terminate

(inherited documentation)

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.

Overrides: DebugEventListener.enterRule

(inherited documentation)

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.

Overrides: DebugEventListener.enterAlt

(inherited documentation)

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.

Overrides: DebugEventListener.exitRule

(inherited documentation)

Track entry into any (...) subrule other EBNF construct

Overrides: DebugEventListener.enterSubRule

(inherited documentation)

Overrides: DebugEventListener.exitSubRule

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.

Overrides: DebugEventListener.enterDecision

(inherited documentation)

Overrides: DebugEventListener.exitDecision

An input token was consumed; matched by any kind of element. Trigger after the token was matched by things like match(), matchAny().

Overrides: DebugEventListener.consumeToken

(inherited documentation)

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).

Overrides: DebugEventListener.consumeHiddenToken

(inherited documentation)

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.

Overrides: DebugEventListener.LT

(inherited documentation)

The parser is going to look arbitrarily ahead; mark this location, the token stream's marker is sent in case you need it.

Overrides: DebugEventListener.mark

(inherited documentation)

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.

Overrides: DebugEventListener.rewind

(inherited documentation)

Overrides: DebugEventListener.beginBacktrack

Overrides: DebugEventListener.endBacktrack

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.

Overrides: DebugEventListener.location

(inherited documentation)

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

Overrides: DebugEventListener.recognitionException

(inherited documentation)

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.

Overrides: DebugEventListener.beginResync

(inherited documentation)

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.

Overrides: DebugEventListener.endResync

(inherited documentation)

A semantic predicate was evaluate with this result and action text

Overrides: DebugEventListener.semanticPredicate

(inherited documentation)

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.

Overrides: DebugEventListener.consumeNode

(inherited documentation)

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.

Overrides: DebugEventListener.nilNode

(inherited documentation)

Upon syntax error, recognizers bracket the error with an error node if they are building ASTs.

Overrides: DebugEventListener.errorNode

(inherited documentation)

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.

Overrides: DebugEventListener.createNode

(inherited documentation)

Make a node the new root of an existing root.

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.

@see antlr3.tree.TreeAdaptor.becomeRoot()

Overrides: DebugEventListener.becomeRoot

(inherited documentation)

Make childID a child of rootID.

If you are receiving this event over a socket via RemoteDebugEventSocketListener then only IDs are set.

@see antlr3.tree.TreeAdaptor.addChild()

Overrides: DebugEventListener.addChild

(inherited documentation)

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.

Overrides: DebugEventListener.setTokenBoundaries

(inherited documentation)