vici.h File Reference

Project wide declarations and definitions. More...

#include <string>
#include <vector>
#include <map>
#include <memory>
#include <vici/vx.h>
#include <vici/stringy.h>

Go to the source code of this file.

Classes
class	VICI::Factory
	An abstract type for factories. More...
class	VICI::FactoryFactory
	Responsible for creating and supplying factories for the main modules. More...
class	VICI::Window
	A wrapper class for windows. More...
class	VICI::Scene
	A wrapper for QGraphicsScene class. More...
class	VICI::EBNF::ParseTree
	A type for the parsed form of EBNF. More...
class	VICI::EBNF::EBNF
	A parser for EBNF. More...
class	VICI::EBNF::EBNF_Factory
	An abstract factory for making an instance of EBNF. More...
class	VICI::Syntax::Syntax
	Display a syntax chart of command options. More...
class	VICI::Syntax::SyntaxFactory
	An abstract factory for making an instance of Syntax. More...
class	VICI::Admin::ViciAdmin
	Application for preparing commands. More...
class	VICI::Admin::ViciAdminFactory
	An abstract factory for making an instance of ViciAdmin. More...
class	VICI::Search::SearchClient
	The interface that must implemented for clients of Search. More...
class	VICI::Search::Search
	Allow the user to search for, and organise commands. More...
class	VICI::Search::SearchFactory
	An abstract factory for making an instance of Search. More...
class	VICI::Interp::InterpreterClient
	The interface that must be implemented by clients of the interpreter. More...
class	VICI::Interp::Interpreter
	The API for interpreter library. More...
class	VICI::Interp::InterpreterFactory
	An abstract factory for making an instance of Interpreter. More...
class	VICI::Symbol::SymbolAttributes
	Holds the attributes of a symbol. More...
class	VICI::Symbol::TextAttributes
	Hold the attributes of a text comment. More...
class	VICI::Symbol::SymbolOwner
	Represents something that is notified about events occurring on a symbol. More...
class	VICI::Symbol::Symbol
	Represents something that is drawn on the canvas. More...
class	VICI::Symbol::SymbolClient
	An interface that is notified of changes to symbol manager. More...
class	VICI::Symbol::SymbolMgr
	The facade for the symbol library. More...
class	VICI::Symbol::SymbolFactory
	An abstract factory for making an instance of SymbolMgr. More...
class	VICI::Canvas::CanvasClient
	An interface that is notified of canvas actions. More...
class	VICI::Canvas::Canvas
	The facade for canvas library. More...
class	VICI::Canvas::CanvasFactory
	An abstract factory for making an instance of Canvas. More...
class	VICI::Cmnd::CommandClient
	An interface that is notified of a command selection. More...
class	VICI::Cmnd::Command
	The facade for the command library. More...
class	VICI::Cmnd::CommandFactory
	An abstract factory for making an instance of Command. More...
class	VICI::Sec::Secure
	Provide security for the scripts. More...
class	VICI::Sec::SecureFactory
	An abstract factory for making an instance of Secure. More...
class	VICI::Cron::Cron
	Allow scripts to be scheduled for later running. More...
class	VICI::Cron::CronFactory
	An abstract factory for making an instance of Cron. More...
class	VICI::Inst::Installer
	Install a script into the user's desktop. More...
class	VICI::Inst::InstallerFactory
	An abstract factory for making an instance of Installer. More...
class	VICI::Ed::ViciEditor
	The flowchart editor. More...
class	VICI::Ed::ViciEditorFactory
	An abstract factory for making an instance of ViciEditor. More...
class	VICI::Vici
	An API for the vici runtime gui. More...
class	VICI::ViciFactory
	An abstract factory for making an instance of Vici. More...

Namespaces
	VICI
	The namespace for the Visual Chart Interpreter project.
	VICI::EBNF
	An API for the libebnf library.
	VICI::Syntax
	An API for libsyntax.
	VICI::Admin
	An API for the vici-adm program.
	VICI::Search
	An API for libsearch.
	VICI::Sec
	An API for libsecure.
	VICI::Interp
	An API for the vici script interpreter.
	VICI::Symbol
	An API for libsymbol.
	VICI::Canvas
	An API for the Canvas which handles the drawing and layout.
	VICI::Cmnd
	An API for libcommand.
	VICI::Cron
	an API for libcron
	VICI::Inst
	An API for the installer.
	VICI::Ed
	An API for the vici editor.

Typedefs
typedef const std::string &	VICI::csr
	short cut for string constants
typedef int	VICI::NodeId
	Type for identifying a node of the flowchart.
typedef int	VICI::ThreadId
	type for identifying a thread in the running script
typedef std::vector< std::string >	VICI::ArgList
	Type for a list of command arguments and options.
typedef std::shared_ptr< Factory >	VICI::FactoryPtr
	Shared pointer for factory.
typedef std::shared_ptr < EBNF_Factory >	VICI::EBNF::EBNF_FactoryPtr
	Shared pointer for EBNF_Factory.
typedef std::shared_ptr < SyntaxFactory >	VICI::Syntax::SyntaxFactoryPtr
	Shared pointer for SyntaxFactory.
typedef std::shared_ptr < ViciAdminFactory >	VICI::Admin::ViciAdminFactoryPtr
	Shared pointer for Admin Factory.
typedef std::shared_ptr < SearchFactory >	VICI::Search::SearchFactoryPtr
	Shared pointer for Search Factory.
typedef std::shared_ptr < InterpreterFactory >	VICI::Interp::InterpreterFactoryPtr
	Shared pointer for Interpreter Factory.
typedef long	VICI::Symbol::Colour
	Specialisation for holding colour values.
typedef std::shared_ptr < SymbolFactory >	VICI::Symbol::SymbolFactoryPtr
	Shared pointer for Symbol Factory.
typedef std::shared_ptr < CanvasFactory >	VICI::Canvas::CanvasFactoryPtr
	Shared pointer for Canvas Factory.
typedef std::shared_ptr < CommandFactory >	VICI::Cmnd::CommandFactoryPtr
	Shared pointer for Command Factory.
typedef std::shared_ptr < SecureFactory >	VICI::Sec::SecureFactoryPtr
	Shared pointer for Secure Factory.
typedef std::shared_ptr < CronFactory >	VICI::Cron::CronFactoryPtr
	Shared pointer for Cron Factory.
typedef std::shared_ptr < InstallerFactory >	VICI::Inst::InstallerFactoryPtr
	Shared pointer for Installer Factory.
typedef std::shared_ptr < ViciEditorFactory >	VICI::Ed::ViciEditorFactoryPtr
	Shared pointer for Editor Factory.
typedef std::shared_ptr < ViciFactory >	VICI::ViciFactoryPtr
	Shared pointer for Vici Factory.

Enumerations
enum	VICI::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.
enum	VICI::Symbol::Style {   VICI::Symbol::SymCommand, VICI::Symbol::SymChoice, VICI::Symbol::SymFuncRef, VICI::Symbol::SymFunc,   VICI::Symbol::SymVar, VICI::Symbol::SymConst, VICI::Symbol::SymMutex, VICI::Symbol::SymSem,   VICI::Symbol::SymFile, VICI::Symbol::SymInline, VICI::Symbol::SymPipe, VICI::Symbol::SymDisplay,   VICI::Symbol::SymLock, VICI::Symbol::SymUnlock, VICI::Symbol::SymWait, VICI::Symbol::SymPost,   VICI::Symbol::SymFlow, VICI::Symbol::SymSuccess, VICI::Symbol::SymFail, VICI::Symbol::SymSignal,   VICI::Symbol::SymStdIn, VICI::Symbol::SymStdOut, VICI::Symbol::SymStdErr }
	The possible styles for symbols and lines. More...

Functions
void *	makeEBNFFactory ()
	create a new EBNF Factory
void *	makeSyntaxFactory ()
	create a new Syntax Factory
void *	makeAdminFactory ()
	create a new Admin Factory
void *	makeSearchFactory ()
	create a new Search Factory
void *	makeCommandFactory ()
	create a new Command Factory
void *	makeSymbolFactory ()
	create a new Symbol Factory
void *	makeCanvasFactory ()
	create a new Canvas Factory
void *	makeSecureFactory ()
	create a new Secure Factory
void *	makeCronFactory ()
	create a new Cron Factory
void *	makeInstallerFactory ()
	create a new Installer Factory
void *	makeInterpreterFactory ()
	create a new Interpreter Factory
void *	makeEditorFactory ()
	create a new Editor Factory
void *	makeViciFactory ()
	create a new Vici Factory

Detailed Description

Project wide declarations and definitions.