VICI::Interp::InterpreterClient Class Reference

The interface that must be implemented by clients of the interpreter. More...

#include <vici/vici.h>

Inheritance diagram for VICI::Interp::InterpreterClient:

Public Member Functions
virtual	~InterpreterClient ()
	virtual destructor
virtual void	setValue (csr varName, csr value)=0
	this gets called when a script variable has a change of value More...
virtual void	setFile (int state, csr filename)=0
	this gets called when a monitored file changes state. More...
virtual void	setCursor (ThreadId tid, NodeId node)=0
	this gets called as the shell steps through the script More...
virtual void	breakReached (ThreadId tid, NodeId node)=0
	this gets called when a break point is reached More...
virtual void	dataReady (NodeId node)=0
	this gets called when data is available on a display More...
virtual void	reportError (Severity sev, csr msg)=0
	This gets called if an error is detected. More...
virtual void	done ()=0
	this gets called when the script completes

Detailed Description

The interface that must be implemented by clients of the interpreter.

The clients of the interpreter are responsible for showing the activity during debugging and for displaying the output streams. By implementing this interface and registering with the interpreter they will notified accordingly.

Member Function Documentation

virtual void VICI::Interp::InterpreterClient::breakReached ( ThreadId  tid, NodeId  node  )

pure virtual

this gets called when a break point is reached

Parameters

tid	the thread which reached the breakpoint
node	the location of the breakpoint

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

virtual void VICI::Interp::InterpreterClient::dataReady ( NodeId  node )

pure virtual

this gets called when data is available on a display

Parameters

node	the node of the display object in the flowchart

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

virtual void VICI::Interp::InterpreterClient::reportError ( Severity  sev, csr  msg  )

pure virtual

This gets called if an error is detected.

Parameters

msg	The text of the error message.
sev	The severity of the error

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

virtual void VICI::Interp::InterpreterClient::setCursor ( ThreadId  tid, NodeId  node  )

pure virtual

this gets called as the shell steps through the script

Parameters

tid	the thread which changed to executing this node
node	the node that is currently being executed

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

virtual void VICI::Interp::InterpreterClient::setFile ( int  state, csr  filename  )

pure virtual

this gets called when a monitored file changes state.

Parameters

state	this needs to be defined
filename	the name of the file that changed

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

virtual void VICI::Interp::InterpreterClient::setValue ( csr  varName, csr  value  )

pure virtual

this gets called when a script variable has a change of value

Parameters

varName	the name of the variable that changed value
value	the new value of the variable

Implemented in VICI::stub::ViciStub, and VICI::stub::CanvasStub.

---

The documentation for this class was generated from the following file:

• vici.h