Make the link between ScriptEngine server side and the python console client side. More...

#include <NScriptEngine.hpp>

Inherits QObject, and CNode.

Public Types
enum	debug_command { INVALID =-1, STOP =0, CONTINUE =1, LINE_BY_LINE_EXECUTION =2, NORMAL_EXECUTION =3, BREAK =4, TOGGLE_BREAK_POINT =5 }

Public Types inherited from CNode
enum	Type { STANDARD_NODE = 0, LOCAL_NODE = 1, DEBUG_NODE = 2 }
	Defines the sub-node types. More...

Public Types inherited from Component
typedef ComponentIterator< Component >	iterator
	type of the iterator to Component More...

typedef ComponentIterator< Component const >	const_iterator
	type of the iterator to constant Component More...

Public Types inherited from SignalHandler
typedef std::vector< SignalPtr >	storage_t
	storage type for signals More...

Public Slots
void	client_connected ()
	Called when the client is connected to the server, this allow NScriptEngine to send signal to the server. More...

Signals
void	completion_list_received (const QStringList &add, const QStringList &sub)
	Signal emitted when the server find new entries in the python scope. More...

void	debug_trace_received (int fragment, int line)
	Send the debug trace to the python console. More...

void	documentation_received (const QString &documentation)
	Emitted when a documentation string is sent fromthe server. More...

void	change_fragment_request (int old_fragment, int new_fragment)
	Emitted when the server compile a fragment and send the real fragment number, for multi client execution. More...

void	execute_code_request (QString)
	Send a command to execute to the python console. More...

void	append_false_command_request (QString)
	Send a command to execute to the python console. More...

Public Member Functions
	NScriptEngine ()

virtual QString	tool_tip () const
	Gives the text to put on a tool tip. More...

void	execute_line (const QString &line, int fragment_number, QVector< int > break_points)

void	emit_debug_command (debug_command command, int fragment=0, int line=0)

void	request_documentation (QString &doc)

void	signal_documentation (common::SignalArgs &node)
	Called when the server send new documentation about an expression. More...

void	signal_completion (common::SignalArgs &node)
	Called when the server send his completion list. More...

void	signal_debug_trace (common::SignalArgs &node)
	Called when the server send debugging information. More...

void	signal_execute_script_reply (common::SignalArgs &node)
	Called after an execute reply to give the real fragment number. More...

void	append_command_to_python_console (std::string &command)
	Allow to execute script on the console (not used anymore) More...

void	append_false_command_to_python_console (std::string &command)
	Allow to append command that are juste display on the console (used in signal conversion) More...

Public Member Functions inherited from CNode
	CNode (const std::string &name, const QString &component_type, Type type)

std::string	derived_type_name () const
	Component::derived_type_name implementation. More...

QString	component_type () const

Handle< CNode >	child (Uint index)

bool	is_local_component () const

Type	type () const

bool	is_root ()

void	set_properties (const common::SignalArgs &node)

void	set_signals (const common::SignalArgs &node)

void	modify_options (const QMap< QString, QString > &options)
	Modifies options. More...

void	list_options (QList< boost::shared_ptr< common::Option > > &list)

void	list_properties (QMap< QString, QString > &props)

void	list_signals (QList< ActionInfo > &actions)

template<class TYPE >
Handle< const TYPE >	castTo () const

template<class TYPE >
Handle< TYPE >	castTo ()

void	connect_notifier (QObject reciever, const char signal, const char *slot)

void	add_node (boost::shared_ptr< CNode > node)
	Adds a sub-node. More...

void	remove_node (const QString &node_name)
	Removes a sub-node. More...

CNodeNotifier *	notifier () const

void	list_child_paths (QStringList &list, bool recursive, bool client_node=true) const
	Lists all children paths in a string list. More...

void	request_signal_signature (const QString &name)

void	local_signature (const QString &name, common::SignalArgs &node)
	Retrieves the signature of a local signal. More...

void	finish_setup ()

virtual void	about_to_be_removed ()

void	reply_update_tree (common::SignalArgs &node)

void	reply_configure (common::SignalArgs &node)

void	reply_list_content (common::SignalArgs &node)

void	reply_signal_signature (common::SignalArgs &node)
	Method called when the server replies to a signal. More...

Public Member Functions inherited from Component
	Component (const std::string &name)

virtual	~Component ()
	Virtual destructor. More...

const std::string &	name () const
	Access the name of the component. More...

void	rename (const std::string &name)
	Rename the component. More...

URI	uri () const
	Construct the full path. More...

void	complete_path (URI &path) const

Handle< Component >	access_component (const URI &path) const

Handle< Component >	access_component_checked (const URI &path)

Handle< Component const >	access_component_checked (const URI &path) const

Handle< Component >	handle ()
	Get a handle to the component. More...

Handle< Component const >	handle () const

template<typename ComponentT >
Handle< ComponentT >	handle ()

template<typename ComponentT >
Handle< ComponentT const >	handle () const

Handle< Component >	parent () const

Handle< Component const >	root () const

Handle< Component >	root ()

Handle< Component >	get_child (const std::string &name)

Handle< Component const >	get_child (const std::string &name) const

Handle< Component >	get_child_checked (const std::string &name)

Handle< Component const >	get_child_checked (const std::string &name) const

Handle< Component >	create_component (const std::string &name, const std::string &builder)
	Build a (sub)component of this component using the extended type_name of the component. More...

template<typename T >
Handle< T >	create_component (const std::string &name)
	Create a (sub)component of this component automatically cast to the specified type. More...

template<typename T >
Handle< T >	create_static_component (const std::string &name)
	Create a static "always there" subcomponent. More...

Component &	add_component (const boost::shared_ptr< Component > &subcomp)
	Add the passed component as a subcomponent. More...

void	add_link (Component &linked_component)

boost::shared_ptr< Component >	remove_component (const std::string &name)
	Remove a (sub)component of this component. More...

boost::shared_ptr< Component >	remove_component (Component &subcomp)
	Remove a (sub)component of this component. More...

void	clear ()
	Remove all sub-components of this component, except for the static ones. More...

void	move_to (Component &to_parent)

std::string	tree (bool basic_mode=false, Uint depth=0, Uint recursion_level=0) const

std::string	info (const std::string &what=std::string("cospt")) const

size_t	count_children () const

PropertyList &	properties ()

const PropertyList &	properties () const

OptionList &	options ()

const OptionList &	options () const

void	reset_options ()
	Reset all options to their default value. More...

void	configure_option_recursively (const std::string &optname, const boost::any &val)

Component &	mark_basic ()
	marks this component as basic. More...

template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT > > &vec, const bool recurse)

template<typename ComponentT >
void	put_components (std::vector< boost::shared_ptr< ComponentT const > > &vec, const bool recurse) const

template<>
void	put_components (std::vector< boost::shared_ptr< Component > > &vec, const bool recurse)

template<>
void	put_components (std::vector< boost::shared_ptr< Component const > > &vec, const bool recurse) const

Component::iterator	begin ()
	The begin iterator for a range containing Components. More...

Component::iterator	end ()
	The end iterator for a range containing Components. More...

Component::const_iterator	begin () const
	The begin iterator for a range containing Components (const version) More...

Component::const_iterator	end () const
	The end iterator for a range containing Components (const version) More...

Component::iterator	recursive_begin ()
	The begin iterator for a recursive range containing Components. More...

Component::iterator	recursive_end ()
	The end iterator for a recursive range containing Components. More...

Component::const_iterator	recursive_begin () const
	The begin iterator for a recursive range containing Components (const version) More...

Component::const_iterator	recursive_end () const
	The end iterator for a recursive range containing Components (const version) More...

template<typename T >
Handle< T >	create_component (const std::string &name, const std::string &builder)
	Create a component using the reduced builder name. More...

void	signal_configure (SignalArgs &args)
	configures all the options on this class More...

void	signal_create_component (SignalArgs &args)
	creates a component from this component More...

void	signal_delete_component (SignalArgs &args)
	delete this component More...

void	signal_move_component (SignalArgs &args)
	moves a component from this component to another More...

void	signal_list_tree (SignalArgs &args) const
	lists the sub components and puts them on the xml_tree More...

void	signal_list_tree_recursive (SignalArgs &args) const
	prints tree recursively More...

void	signal_list_properties (SignalArgs &args) const
	lists the properties of this component More...

void	signal_list_options (SignalArgs &args) const
	lists the properties of this component More...

void	signal_list_options_recursive (SignalArgs &args) const
	prints all options recursive More...

void	signal_list_signals (SignalArgs &args) const
	lists the signals of this component More...

void	signal_list_signals_recursive (SignalArgs &args) const
	prints all signals recursive More...

void	signal_print_info (SignalArgs &args) const
	gets info on this component More...

void	signal_print_tree (SignalArgs &args) const
	signal to print the tree More...

void	signature_print_tree (SignalArgs &args) const
	signature to signal_print_tree More...

void	signal_rename_component (SignalArgs &args)
	renames this component More...

void	signal_save_tree (SignalArgs &args)
	dumps the tree to a file More...

void	signal_list_content (SignalArgs &args)
	gives information about this component such as options, signals, ... More...

void	signal_signature (SignalArgs &args)
	Gives a signal signature, if any. More...

void	signature_create_component (SignalArgs &args)

void	signature_rename_component (SignalArgs &args)

void	signature_move_component (SignalArgs &args)

void	signal_store_timings (SignalArgs &args)
	Signal to store the timings (if enabled) into properties, i.e. for readout from python or the GUI. More...

void	signal_clear (SignalArgs &args)
	Signal to remove all sub-components. More...

void	signal_reset_options (SignalArgs &args)
	Signal to set all options to their default value. More...

void	signal_add_tag (SignalArgs &args)
	Signal to add a tag. More...

void	signature_add_tag (SignalArgs &args)

Public Member Functions inherited from SignalHandler
	~SignalHandler ()

const storage_t &	signal_list () const

SignalPtr	signal (const SignalID &sname)

SignalCPtr	signal (const SignalID &sname) const

SignalRet	call_signal (const SignalID &sname, SignalArgs &sinput)
	Calls the signal by providing its name and input. More...

SignalRet	call_signal (const SignalID &sname, std::vector< std::string > &sinput)
	Calls the signal by providing its name and input. More...

bool	signal_exists (const SignalID &sname) const
	Checks if a signal exists or not. More...

Signal &	regist_signal (const SignalID &sname)
	Regist signal. More...

void	unregist_signal (const SignalID &sname)
	Unregist signal. More...

Public Member Functions inherited from ConnectionManager
	~ConnectionManager ()
	destructor closes all connections More...

Connection *	connection (const std::string &name)

Connection *	manage_connection (const std::string &name)
	manages a connection (creates if necessary) More...

Public Member Functions inherited from TaggedObject
	TaggedObject ()
	Constructor. More...

bool	has_tag (const std::string &tag) const

void	add_tag (const std::string &tag)

std::vector< std::string >	get_tags () const

void	remove_tag (const std::string &tag)

Static Public Member Functions
static Handle< NScriptEngine >	global ()
	Acces to the "singelton" instance. More...

Static Public Member Functions inherited from CNode
static std::string	type_name ()

static boost::shared_ptr< CNode >	create_from_xml (common::XML::XmlNode node)
	Creates an object tree from a given node. More...

Static Public Member Functions inherited from Component
static std::string	type_name ()
	Get the class name. More...

Protected Member Functions
virtual void	disable_local_signals (QMap< QString, bool > &localSignals) const

Protected Member Functions inherited from CNode
virtual void	setup_finished ()

Protected Member Functions inherited from Component
Component &	add_static_component (const boost::shared_ptr< Component > &subcomp)
	Add a static (sub)component of this component. More...

void	raise_tree_updated_event ()
	raise event that the path has changed More...

Private Member Functions
QStringList	std_vector_to_QStringList (std::vector< std::string > vector)

Private Attributes
bool	connected

int	vector_int_type

Additional Inherited Members
Public Attributes inherited from SignalHandler
storage_t	m_signals
	storage of the signals More...

Protected Attributes inherited from CNode
CNodeNotifier *	m_notifier
	This internal notifier. More...

QStringList	m_local_signals
	Lists the names of the local signals. More...

QMutex *	m_mutex

bool	m_content_listed

bool	m_listing_content

bool	m_is_root

QList< ActionInfo >	m_action_sigs
	List of signals that can be remotely executed. More...

Detailed Description

Make the link between ScriptEngine server side and the python console client side.

Author: Bolsee Vivian.

Definition at line 29 of file NScriptEngine.hpp.

Member Enumeration Documentation

enum debug_command

Enumerator
INVALID
STOP
CONTINUE
LINE_BY_LINE_EXECUTION
NORMAL_EXECUTION
BREAK
TOGGLE_BREAK_POINT

Definition at line 35 of file NScriptEngine.hpp.

Constructor & Destructor Documentation

NScriptEngine ( )

Definition at line 37 of file NScriptEngine.cpp.

Member Function Documentation

void append_command_to_python_console ( std::string & command )

Allow to execute script on the console (not used anymore)

Definition at line 59 of file NScriptEngine.cpp.

void append_false_command_request ( QString )

signal

Send a command to execute to the python console.

void append_false_command_to_python_console ( std::string & command )

Allow to append command that are juste display on the console (used in signal conversion)

Definition at line 65 of file NScriptEngine.cpp.

void change_fragment_request	(	int	old_fragment,
		int	new_fragment
	)

signal

Emitted when the server compile a fragment and send the real fragment number, for multi client execution.

void client_connected ( )

slot

Called when the client is connected to the server, this allow NScriptEngine to send signal to the server.

Definition at line 149 of file NScriptEngine.cpp.

void completion_list_received	(	const QStringList &	add,
		const QStringList &	sub
	)

signal

Signal emitted when the server find new entries in the python scope.

Parameters

word_list	scope entry name
doc_list	entry documentation (doc membre)

void debug_trace_received	(	int	fragment,
		int	line
	)

signal

Send the debug trace to the python console.

virtual void disable_local_signals ( QMap< QString, bool > & localSignals ) const

inlineprotectedvirtual

Disables the local signals that need to.

Parameters

localSignals Map of local signals. All values are set to true by default.

Implements CNode.

Definition at line 112 of file NScriptEngine.hpp.

void documentation_received ( const QString & documentation )

signal

Emitted when a documentation string is sent fromthe server.

void emit_debug_command	(	debug_command	command,
		int	fragment = `0`,
		int	line = `0`
	)

Definition at line 133 of file NScriptEngine.cpp.

void execute_code_request ( QString )

signal

Send a command to execute to the python console.

void execute_line	(	const QString &	line,
		int	fragment_number,
		QVector< int >	break_points
	)

Definition at line 116 of file NScriptEngine.cpp.

Handle< NScriptEngine > global ( )

static

Acces to the "singelton" instance.

Definition at line 77 of file NScriptEngine.cpp.

void request_documentation ( QString & doc )

Definition at line 159 of file NScriptEngine.cpp.

void signal_completion ( common::SignalArgs & node )

Called when the server send his completion list.

Parameters

node	Signal node

Definition at line 93 of file NScriptEngine.cpp.

void signal_debug_trace ( common::SignalArgs & node )

Called when the server send debugging information.

Parameters

node	Signal node

Definition at line 102 of file NScriptEngine.cpp.

void signal_documentation ( common::SignalArgs & node )

Called when the server send new documentation about an expression.

Parameters

node	Signal node

Definition at line 85 of file NScriptEngine.cpp.

void signal_execute_script_reply ( common::SignalArgs & node )

Called after an execute reply to give the real fragment number.

Parameters

node	Signal node

Definition at line 109 of file NScriptEngine.cpp.

QStringList std_vector_to_QStringList ( std::vector< std::string > vector )

private

Definition at line 171 of file NScriptEngine.cpp.

QString tool_tip ( ) const

virtual

Gives the text to put on a tool tip.

Returns: The name of the class.

Implements CNode.

Definition at line 71 of file NScriptEngine.cpp.

Member Data Documentation

bool connected

private

Definition at line 115 of file NScriptEngine.hpp.

int vector_int_type

private

Definition at line 116 of file NScriptEngine.hpp.

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

cf3/ui/core/NScriptEngine.hpp
cf3/ui/core/NScriptEngine.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation