VICI Namespace Reference

The namespace for the Visual Chart Interpreter project. More...

Namespaces
	Admin
	An API for the vici-adm program.
	Canvas
	An API for the Canvas which handles the drawing and layout.
	cdi
	The namespace for the Common Development Infrastructure.
	cfi
	The namespace for the Common Facilities Infrastructure components.
	Cmnd
	An API for libcommand.
	Cron
	an API for libcron
	EBNF
	An API for the libebnf library.
	Ed
	An API for the vici editor.
	gth
	The namespace for the GUI Test Harness.
	Inst
	An API for the installer.
	Interp
	An API for the vici script interpreter.
	Search
	An API for libsearch.
	Sec
	An API for libsecure.
	stub
	The namespace for stub versions of modules.
	Symbol
	An API for libsymbol.
	Syntax
	An API for libsyntax.

Classes
class	Path
	Manipulate path strings. More...
class	vxt
	An exception object with severity levels. More...
class	GTHWindowWidget
	A mix-in class with the functions required for the gui test harness. More...
class	WidgetMgrClient
	An interface for the WidgetMgr to call its clients when a window registers itself. More...
class	WidgetMgr
	A singleton class that window widgets register with. More...
class	VMainWindow
	A main window class that automatically registers itself. More...
class	VDialog
	A dialog class that automatically registers itself. More...
class	ItemDelegate
	An item delegate that uses QLineEdit for editing list and table entries. More...
class	VEditList
	Builds on QListWidget to provide better editing ability. More...
class	Metrics
	A class to encapsulate measurements. More...
class	SignalToQtSignal
	A class to convert operating system signals into Qt signals. More...
class	AboutDialog
	A standard About Vici dialog for the project. More...
class	CanvasScene
	An implementation of the Scene abstract class for holding a QGraphicsScene. More...
class	EbnfNode
	A node of the EBNF parse tree. More...
class	EbnfTree
	An implementation of the ParseTree type. More...
class	EbnfXml
	A specialization of the Xml class for the parse tree. More...
class	Factory
	An abstract type for factories. More...
class	FactoryFactory
	Responsible for creating and supplying factories for the main modules. More...
class	Window
	A wrapper class for windows. More...
class	Scene
	A wrapper for QGraphicsScene class. More...
class	Vici
	An API for the vici runtime gui. More...
class	ViciFactory
	An abstract factory for making an instance of Vici. More...
class	VWindow
	An implementation of Window for holding Qt's QWidget objects. More...

Typedefs
typedef void(*	AsyncTestEventFn )(const std::string &s)
	Pointer to function used to enqueue a test event. More...
typedef const std::string &	csr
	short cut for string constants
typedef int	NodeId
	Type for identifying a node of the flowchart.
typedef int	ThreadId
	type for identifying a thread in the running script
typedef std::vector< std::string >	ArgList
	Type for a list of command arguments and options.
typedef std::shared_ptr< Factory >	FactoryPtr
	Shared pointer for factory.
typedef std::shared_ptr < ViciFactory >	ViciFactoryPtr
	Shared pointer for Vici Factory.

Enumerations
enum	Severity {   Emergency, Alert, Critical, Error,   Code, Warning, Notice, Info,   Debug }
	Severity levels for log messages. More...
enum	Module {   EBNF_Module, Syntax_Module, Admin_Module, Search_Module,   Command_Module, Symbol_Module, Canvas_Module, Secure_Module,   Cron_Module, Installer_Module, Interpreter_Module, Editor_Module,   Vici_Module }
	An enum that lists the main modules of VICI.

Functions
void	trim (std::string &s)
	rip off leading and trailing white spaces More...
int	split (csr text, std::vector< std::string > &result)
	split a string into sub-strings at spaces More...
std::string	expandMacros (csr s)
	expand a string containing $ macros More...
std::string	clean (csr s)
	Remove everything except alpha, digit, space, dot, hyphen and underscore. More...
void	defaultAsyncTestEvent (const std::string &s)
	Function used to enqueue a test event. More...

Variables
AsyncTestEventFn	asyncTestEvent = VICI::defaultAsyncTestEvent
	Pointer to function used to enqueue a test event.

Detailed Description

The namespace for the Visual Chart Interpreter project.

The namespace for the project.

Typedef Documentation

typedef void(* VICI::AsyncTestEventFn)(const std::string &s)

Pointer to function used to enqueue a test event.

Parameters

s	Identity of the event.

Enumeration Type Documentation

enum VICI::Severity

Severity levels for log messages.

Enumerator
Emergency	A fault has been detected which may compromise the computer.
Alert	A configuration error has been detected.
Critical	The program cannot continue and may have corrupted its data.
Error	The program cannot continue.
Code	A programming error has been detected.
Warning	There is a problem but the program can continue.
Notice	Something is odd.
Info	Information messages.
Debug	Debugging messages.

Function Documentation

std::string VICI::clean

(

csr

s

)

Remove everything except alpha, digit, space, dot, hyphen and underscore.

Parameters

s	The string to clean

Returns

A string devoid of all but the above

void VICI::defaultAsyncTestEvent

(

const std::string &

s

)

Function used to enqueue a test event.

The default function is defined in cfi/log.cpp and soes nothing

Parameters

s	Identity of the event.

string VICI::expandMacros

(

csr

s

)

expand a string containing $ macros

Parameters

s	The string to expand.

Returns

A string with $ macros replaced.

int VICI::split	(	csr	text,
		std::vector< std::string > &	result
	)

split a string into sub-strings at spaces

Parameters

text	the string to split
result	the vector of sub strings

Returns

a number of sub-strings

void VICI::trim

(

std::string &

s

)

rip off leading and trailing white spaces

Parameters

s	the string to trim