DBRecorder (ANTLRWorks 1.5.1 API)

java.lang.Object
- org.antlr.works.debugger.tivo.DBRecorder

All Implemented Interfaces:: Runnable, XJDialogProgressDelegate

public class DBRecorder
extends Object
implements Runnable, XJDialogProgressDelegate

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DBRecorder.FixBugRemoteDebugEventSocketListener

class DBRecorder.PlayEventRunnable

class DBRecorder.StepOver

Nested Classes
Modifier and Type	Class and Description
`static class`	`DBRecorder.FixBugRemoteDebugEventSocketListener`
`class`	`DBRecorder.PlayEventRunnable`
`class`	`DBRecorder.StepOver`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`address`
`protected NumberSet`	`breakEvents`
`protected boolean`	`cancelled`
`protected int`	`currentTokenIndex`
`protected int`	`currentTokenIndexEventNumber`
`protected boolean`	`debuggerReceivedTerminateEvent` This flag is used to indicate that the debugger received the terminate event.
`protected DebuggerTab`	`debuggerTab`
`protected DBRecorderEventListener`	`eventListener`
`protected List<DBEvent>`	`events`
`protected Stack<String>`	`grammarNamesStack` Current grammar the recorder is in
`protected boolean`	`ignoreBreakpoints`
`protected int`	`lastTokenIndexEventNumber`
`protected org.antlr.runtime.debug.RemoteDebugEventSocketListener`	`listener`
`static int`	`MAX_RETRY`
`protected int`	`port`
`protected int`	`position`
`protected XJDialogProgress`	`progress`
`protected boolean`	`remoteParserStateWarned` Flag used to indicate if the user has been warning about a problem with the remote parser state.
`protected int`	`status`
`static int`	`STATUS_BREAK`
`static int`	`STATUS_LAUNCHING`
`static int`	`STATUS_RUNNING`
`static int`	`STATUS_STOPPED`
`static int`	`STATUS_STOPPING`
`protected DBRecorder.StepOver`	`stepOver`
`protected int`	`stoppedOnEvent`

Constructor Summary

Constructors
Constructor and Description

DBRecorder(DebuggerTab debuggerTab)

Constructors
Constructor and Description
`DBRecorder(DebuggerTab debuggerTab)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`breaksOnEvent(boolean wait)`
`void`	`checkRemoteParserHeaders()` This method checks that the remote parser's states are in sync with the state of the debugger (i.e.
`boolean`	`checkRemoteParserState()` Check any error coming from the remote parser.
`void`	`close()`
`void`	`connect(String address, int port)`
`void`	`connectionCancelled()`
`void`	`connectionFailed()`
`void`	`connectionSuccess()`
`void`	`dialogDidCancel()`
`void`	`fastForward()`
`Set`	`getBreakEvents()`
`int`	`getCurrentEventPosition()`
`List<DBEvent>`	`getCurrentEvents()`
`DBEvent`	`getEvent()`
`DBEvent`	`getLastEvent()`
`int`	`getOnBreakEvent()` Return the event type that causes the break
`int`	`getStatus()`
`int`	`getStoppedOnEvent()`
`void`	`goToEnd()`
`void`	`goToStart()`
`void`	`handleGrammarName(DBEvent event)`
`void`	`hideProgress()`
`boolean`	`ignoreBreakpoints()`
`boolean`	`isAlive()` Return true if the debugger is alive (i.e.
`boolean`	`isAtBeginning()`
`boolean`	`isAtEnd()`
`boolean`	`isOnBreakEvent()` Return true if the debugger hitted a break event
`boolean`	`isRunning()` Return true if the debugger is running
`void`	`listenerEvent(DBEvent event)` This method is called by DBRecorderEventListener for each event received from the remote parser.
`protected void`	`playEvents(boolean reset)`
`void`	`queryGrammarBreakpoints()`
`void`	`recordIndexes(DBEvent event)` This method keeps track of the last consumed index in order to display useful information if an invalid index is detected
`void`	`requestStop()`
`void`	`reset()`
`void`	`run()`
`void`	`setBreakEvents(Set events)`
`void`	`setIgnoreBreakpoints(boolean flag)`
`void`	`setPositionToEnd()`
`void`	`setStatus(int status)`
`void`	`setStoppedOnEvent(int event)`
`void`	`showProgress()`
`void`	`stepBackward(Set breakEvents)`
`void`	`stepContinue(Set breakEvents)`
`void`	`stepForward(Set breakEvents)`
`boolean`	`stepMove(int direction)` This method returns false if no more event is available
`void`	`stepOver()`
`void`	`stop()`
`void`	`threadNotify()`
`void`	`threadWait()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATUS_STOPPED
```
public static final int STATUS_STOPPED
```
See Also:
Constant Field Values

STATUS_STOPPING
```
public static final int STATUS_STOPPING
```
See Also:
Constant Field Values

STATUS_LAUNCHING
```
public static final int STATUS_LAUNCHING
```
See Also:
Constant Field Values

STATUS_RUNNING
```
public static final int STATUS_RUNNING
```
See Also:
Constant Field Values

STATUS_BREAK
```
public static final int STATUS_BREAK
```
See Also:
Constant Field Values

MAX_RETRY
```
public static final int MAX_RETRY
```
See Also:
Constant Field Values

debuggerTab
```
protected DebuggerTab debuggerTab
```

status
```
protected int status
```

cancelled
```
protected boolean cancelled
```

address
```
protected String address
```

port
```
protected int port
```

events
```
protected List<DBEvent> events
```

position
```
protected int position
```

breakEvents
```
protected NumberSet breakEvents
```

stoppedOnEvent
```
protected int stoppedOnEvent
```

ignoreBreakpoints
```
protected boolean ignoreBreakpoints
```

stepOver
```
protected DBRecorder.StepOver stepOver
```

lastTokenIndexEventNumber

protected int lastTokenIndexEventNumber

currentTokenIndexEventNumber

protected int currentTokenIndexEventNumber

currentTokenIndex
```
protected int currentTokenIndex
```

eventListener

protected DBRecorderEventListener eventListener

listener

protected org.antlr.runtime.debug.RemoteDebugEventSocketListener listener

progress
```
protected XJDialogProgress progress
```

debuggerReceivedTerminateEvent
```
protected boolean debuggerReceivedTerminateEvent
```
This flag is used to indicate that the debugger received the terminate event. It is used to force stop the debugger if it cannot be stopped by the normal method.

remoteParserStateWarned
```
protected boolean remoteParserStateWarned
```
Flag used to indicate if the user has been warning about a problem with the remote parser state. It ensure the message is only displayed once during a debugging session.

grammarNamesStack
```
protected Stack<String> grammarNamesStack
```
Current grammar the recorder is in

Constructor Detail

DBRecorder

public DBRecorder(DebuggerTab debuggerTab)

Method Detail

close
```
public void close()
```

showProgress
```
public void showProgress()
```

hideProgress
```
public void hideProgress()
```

isRunning
```
public boolean isRunning()
```
Return true if the debugger is running

isAlive
```
public boolean isAlive()
```
Return true if the debugger is alive (i.e. not stopped, stopping, starting)

reset
```
public void reset()
```

getEvent
```
public DBEvent getEvent()
```

getLastEvent
```
public DBEvent getLastEvent()
```

getCurrentEvents

public List<DBEvent> getCurrentEvents()

getCurrentEventPosition
```
public int getCurrentEventPosition()
```

setPositionToEnd
```
public void setPositionToEnd()
```

setBreakEvents

public void setBreakEvents(Set events)

getBreakEvents
```
public Set getBreakEvents()
```

setStoppedOnEvent

public void setStoppedOnEvent(int event)

getStoppedOnEvent
```
public int getStoppedOnEvent()
```

setIgnoreBreakpoints

public void setIgnoreBreakpoints(boolean flag)

ignoreBreakpoints
```
public boolean ignoreBreakpoints()
```

queryGrammarBreakpoints
```
public void queryGrammarBreakpoints()
```

isOnBreakEvent
```
public boolean isOnBreakEvent()
```
Return true if the debugger hitted a break event

getOnBreakEvent
```
public int getOnBreakEvent()
```
Return the event type that causes the break

setStatus
```
public void setStatus(int status)
```

getStatus
```
public int getStatus()
```

isAtBeginning
```
public boolean isAtBeginning()
```

isAtEnd
```
public boolean isAtEnd()
```

stepBackward

public void stepBackward(Set breakEvents)

stepForward

public void stepForward(Set breakEvents)

stepOver
```
public void stepOver()
```

stepContinue

public void stepContinue(Set breakEvents)

stepMove
```
public boolean stepMove(int direction)
```
This method returns false if no more event is available

goToStart
```
public void goToStart()
```

goToEnd
```
public void goToEnd()
```

fastForward
```
public void fastForward()
```

connect

public void connect(String address,
           int port)

run
```
public void run()
```
Specified by:

run in interface Runnable

connectionSuccess
```
public void connectionSuccess()
```

connectionFailed
```
public void connectionFailed()
```

connectionCancelled
```
public void connectionCancelled()
```

requestStop
```
public void requestStop()
```

stop
```
public void stop()
```

checkRemoteParserHeaders
```
public void checkRemoteParserHeaders()
```
This method checks that the remote parser's states are in sync with the state of the debugger (i.e. name of the grammar). This method is called in the event dispatch thread.

checkRemoteParserState
```
public boolean checkRemoteParserState()
```
Check any error coming from the remote parser. Return true if the debuggerTab needs to be paused

recordIndexes
```
public void recordIndexes(DBEvent event)
```
This method keeps track of the last consumed index in order to display useful information if an invalid index is detected

handleGrammarName

public void handleGrammarName(DBEvent event)

listenerEvent
```
public void listenerEvent(DBEvent event)
```
This method is called by DBRecorderEventListener for each event received from the remote parser. It is running on another thread than the event thread.

threadNotify
```
public void threadNotify()
```

threadWait
```
public void threadWait()
```

breaksOnEvent

public void breaksOnEvent(boolean wait)

playEvents

protected void playEvents(boolean reset)

dialogDidCancel
```
public void dialogDidCancel()
```
Specified by:

dialogDidCancel in interface XJDialogProgressDelegate

Class DBRecorder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_STOPPED

STATUS_STOPPING

STATUS_LAUNCHING

STATUS_RUNNING

STATUS_BREAK

MAX_RETRY

debuggerTab

status

cancelled

address

port

events

position

breakEvents

stoppedOnEvent

ignoreBreakpoints

stepOver

lastTokenIndexEventNumber

currentTokenIndexEventNumber

currentTokenIndex

eventListener

listener

progress

debuggerReceivedTerminateEvent

remoteParserStateWarned

grammarNamesStack

Constructor Detail

DBRecorder

Method Detail

close

showProgress

hideProgress

isRunning

isAlive

reset

getEvent

getLastEvent

getCurrentEvents

getCurrentEventPosition

setPositionToEnd

setBreakEvents

getBreakEvents

setStoppedOnEvent

getStoppedOnEvent

setIgnoreBreakpoints

ignoreBreakpoints

queryGrammarBreakpoints

isOnBreakEvent

getOnBreakEvent

setStatus

getStatus

isAtBeginning

isAtEnd

stepBackward

stepForward

stepOver

stepContinue

stepMove

goToStart

goToEnd

fastForward

connect

run

connectionSuccess

connectionFailed

connectionCancelled

requestStop

stop

checkRemoteParserHeaders

checkRemoteParserState

recordIndexes

handleGrammarName

listenerEvent