KviKvsTreeNodeInstruction Class Reference

Treenode class to handle instructions. More...

#include <KviKvsTreeNodeInstruction.h>

Inheritance diagram for KviKvsTreeNodeInstruction:

Public Member Functions
virtual void	contextDescription (QString &szBuffer)
	Sets the buffer as Instruction. More...
virtual void	dump (const char *prefix)
	Dumps the instructions tree. More...
virtual bool	execute (KviKvsRunTimeContext *c)=0
	This is the main entry point to the tree visit. More...
	KviKvsTreeNodeInstruction (const QChar *pLocation)
	Constructs the treenode instruction object. More...
	~KviKvsTreeNodeInstruction ()
	Destroys the treenode instruction object. More...
Public Member Functions inherited from KviKvsTreeNode
	KviKvsTreeNode (const QChar *pLocation)
	Constructs the treenode object. More...
const QChar *	location ()
	Returns the location char. More...
KviKvsTreeNode *	parent ()
	Returns the parent object. More...
void	setParent (KviKvsTreeNode *p)
	Sets the parent object. More...
virtual	~KviKvsTreeNode ()
	Destroys the treenode object. More...

Additional Inherited Members
Protected Member Functions inherited from KviKvsTreeNode
void	setLocation (const QChar *pLocation)
	Sets the location char. More...
Protected Attributes inherited from KviKvsTreeNode
const QChar *	m_pLocation
KviKvsTreeNode *	m_pParent

Detailed Description

Treenode class to handle instructions.

Constructor & Destructor Documentation

KviKvsTreeNodeInstruction::KviKvsTreeNodeInstruction ( const QChar *  pLocation )

inline

Constructs the treenode instruction object.

Parameters

pLocation

The location char of the instruction

Returns

KviKvsTreeNodeInstruction

KviKvsTreeNodeInstruction::~KviKvsTreeNodeInstruction ( )

inline

Destroys the treenode instruction object.

Member Function Documentation

void KviKvsTreeNodeInstruction::contextDescription ( QString &  szBuffer )

virtual

Sets the buffer as Instruction.

Parameters

szBuffer

The buffer :)

Returns

void

Implements KviKvsTreeNode.

Reimplemented in KviKvsTreeNodeOperationStringSubstitution, KviKvsTreeNodeOperationStringTransliteration, KviKvsTreeNodeOperationStringAppendWithSpace, KviKvsTreeNodeOperationStringAppendWithComma, KviKvsTreeNodeOperationArrayAppend, KviKvsTreeNodeOperationStringAppend, KviKvsTreeNodeOperationSelfXor, KviKvsTreeNodeOperationSelfSum, KviKvsTreeNodeSpecialCommandDefpopup, KviKvsTreeNodeOperationSelfSubtraction, KviKvsTreeNodeOperationSelfShr, KviKvsTreeNodeOperationSelfShl, KviKvsTreeNodeOperationSelfOr, KviKvsTreeNodeOperationSelfMultiplication, KviKvsTreeNodeOperationSelfModulus, KviKvsTreeNodeSpecialCommandSwitch, KviKvsTreeNodeOperationSelfDivision, KviKvsTreeNodeOperationSelfAnd, KviKvsTreeNodeOperationIncrement, KviKvsTreeNodeOperationDecrement, KviKvsTreeNodeSpecialCommandClass, KviKvsTreeNodeAliasSimpleCommand, KviKvsTreeNodeOperationAssignment, KviKvsTreeNodeInstructionBlock, KviKvsTreeNodeCommand, KviKvsTreeNodeCoreCallbackCommand, KviKvsTreeNodeSpecialCommandFor, KviKvsTreeNodeSpecialCommandForeach, KviKvsTreeNodeSpecialCommandIf, KviKvsTreeNodeCommandWithParameters, KviKvsTreeNodeModuleCallbackCommand, KviKvsTreeNodeRebindingSwitch, KviKvsTreeNodeSpecialCommandDo, KviKvsTreeNodeSpecialCommandWhile, KviKvsTreeNodeCallbackCommand, KviKvsTreeNodeCoreSimpleCommand, KviKvsTreeNodeModuleSimpleCommand, KviKvsTreeNodeOperation, KviKvsTreeNodeSpecialCommandUnset, KviKvsTreeNodeVoidFunctionCall, KviKvsTreeNodeExpressionReturn, KviKvsTreeNodeParameterReturn, KviKvsTreeNodeSpecialCommandBreak, KviKvsTreeNodeSpecialCommandContinue, KviKvsTreeNodeSimpleCommand, and KviKvsTreeNodeSpecialCommand.

void KviKvsTreeNodeInstruction::dump ( const char *  prefix )

virtual

Dumps the instructions tree.

Parameters

prefix

The prefix of the instruction

Returns

void

Implements KviKvsTreeNode.

Reimplemented in KviKvsTreeNodeOperationStringSubstitution, KviKvsTreeNodeOperationStringTransliteration, KviKvsTreeNodeOperationStringAppendWithSpace, KviKvsTreeNodeOperationStringAppendWithComma, KviKvsTreeNodeOperationArrayAppend, KviKvsTreeNodeOperationStringAppend, KviKvsTreeNodeOperationSelfXor, KviKvsTreeNodeOperationSelfSum, KviKvsTreeNodeSpecialCommandDefpopup, KviKvsTreeNodeOperationSelfSubtraction, KviKvsTreeNodeOperationSelfShr, KviKvsTreeNodeOperationSelfShl, KviKvsTreeNodeOperationSelfOr, KviKvsTreeNodeOperationSelfMultiplication, KviKvsTreeNodeOperationSelfModulus, KviKvsTreeNodeSpecialCommandSwitch, KviKvsTreeNodeOperationSelfDivision, KviKvsTreeNodeOperationSelfAnd, KviKvsTreeNodeOperationIncrement, KviKvsTreeNodeAliasSimpleCommand, KviKvsTreeNodeOperationDecrement, KviKvsTreeNodeSpecialCommandClass, KviKvsTreeNodeOperationAssignment, KviKvsTreeNodeInstructionBlock, KviKvsTreeNodeCommand, KviKvsTreeNodeCoreCallbackCommand, KviKvsTreeNodeSpecialCommandFor, KviKvsTreeNodeSpecialCommandForeach, KviKvsTreeNodeSpecialCommandIf, KviKvsTreeNodeCommandWithParameters, KviKvsTreeNodeModuleCallbackCommand, KviKvsTreeNodeRebindingSwitch, KviKvsTreeNodeSpecialCommandDo, KviKvsTreeNodeSpecialCommandWhile, KviKvsTreeNodeCallbackCommand, KviKvsTreeNodeCoreSimpleCommand, KviKvsTreeNodeModuleSimpleCommand, KviKvsTreeNodeOperation, KviKvsTreeNodeSpecialCommandUnset, KviKvsTreeNodeVoidFunctionCall, KviKvsTreeNodeExpressionReturn, KviKvsTreeNodeParameterReturn, KviKvsTreeNodeSpecialCommandBreak, KviKvsTreeNodeSpecialCommandContinue, KviKvsTreeNodeSimpleCommand, and KviKvsTreeNodeSpecialCommand.

Referenced by KviKvsTreeNodeSpecialCommandFor::dump(), KviKvsTreeNodeSpecialCommandForeach::dump(), KviKvsTreeNodeSpecialCommandSwitchLabelCase::dump(), KviKvsTreeNodeSpecialCommandSwitchLabelMatch::dump(), KviKvsTreeNodeSpecialCommandSwitchLabelRegexp::dump(), KviKvsTreeNodeSpecialCommandSwitchLabelDefault::dump(), and KviKvsScript::dump().

virtual bool KviKvsTreeNodeInstruction::execute ( KviKvsRunTimeContext *  c )

pure virtual

This is the main entry point to the tree visit.

It returns false when the tree visiting has to be stopped and returns true when it has been successfully completed. A false return value may signal an error but is also used by break, halt, return and similar. The error condition is signaled by KviKvsRunTimeContext::error().

Parameters

c	The source context

Returns

bool

Implemented in KviKvsTreeNodeOperationStringSubstitution, KviKvsTreeNodeOperationStringTransliteration, KviKvsTreeNodeOperationStringAppendWithSpace, KviKvsTreeNodeOperationStringAppendWithComma, KviKvsTreeNodeOperationArrayAppend, KviKvsTreeNodeOperationStringAppend, KviKvsTreeNodeOperationSelfXor, KviKvsTreeNodeOperationSelfSum, KviKvsTreeNodeSpecialCommandDefpopup, KviKvsTreeNodeOperationSelfSubtraction, KviKvsTreeNodeOperationSelfShr, KviKvsTreeNodeOperationSelfShl, KviKvsTreeNodeOperationSelfOr, KviKvsTreeNodeOperationSelfMultiplication, KviKvsTreeNodeOperationSelfModulus, KviKvsTreeNodeSpecialCommandSwitch, KviKvsTreeNodeOperationSelfDivision, KviKvsTreeNodeOperationSelfAnd, KviKvsTreeNodeOperationIncrement, KviKvsTreeNodeAliasSimpleCommand, KviKvsTreeNodeOperationDecrement, KviKvsTreeNodeSpecialCommandClass, KviKvsTreeNodeOperationAssignment, KviKvsTreeNodeInstructionBlock, KviKvsTreeNodeCoreCallbackCommand, KviKvsTreeNodeSpecialCommandFor, KviKvsTreeNodeSpecialCommandForeach, KviKvsTreeNodeRebindingSwitch, KviKvsTreeNodeSpecialCommandIf, KviKvsTreeNodeModuleCallbackCommand, KviKvsTreeNodeSpecialCommandDo, KviKvsTreeNodeSpecialCommandWhile, KviKvsTreeNodeCoreSimpleCommand, KviKvsTreeNodeModuleSimpleCommand, KviKvsTreeNodeSpecialCommandUnset, KviKvsTreeNodeVoidFunctionCall, KviKvsTreeNodeExpressionReturn, KviKvsTreeNodeParameterReturn, KviKvsTreeNodeSpecialCommandBreak, and KviKvsTreeNodeSpecialCommandContinue.

Referenced by KviKvsTreeNodeCommandEvaluation::evaluateReadOnly(), KviKvsTreeNodeSpecialCommandDo::execute(), KviKvsTreeNodeSpecialCommandWhile::execute(), KviKvsTreeNodeRebindingSwitch::execute(), KviKvsTreeNodeSpecialCommandIf::execute(), KviKvsTreeNodeSpecialCommandForeach::execute(), KviKvsTreeNodeSpecialCommandFor::execute(), KviKvsTreeNodeSpecialCommandSwitchLabelCase::execute(), KviKvsTreeNodeSpecialCommandSwitchLabelMatch::execute(), KviKvsTreeNodeSpecialCommandSwitchLabelRegexp::execute(), KviKvsTreeNodeSpecialCommandSwitchLabelDefault::execute(), and KviKvsScript::executeInternal().

---

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

• src/kvirc/kvs/tree/KviKvsTreeNodeInstruction.h
• src/kvirc/kvs/tree/KviKvsTreeNodeInstruction.cpp