KVIrc 5.2.6
Developer APIs
KviKvsRunTimeContext Class Reference

#include <KviKvsRunTimeContext.h>

Public Member Functions

KviKvsSwitchListaliasSwitchList ()
 
bool breakPending ()
 
void clearError ()
 
KviIrcConnectionconnection ()
 
KviConsoleWindowconsole ()
 
KviIrcContextcontext ()
 
bool continuePending ()
 
KviKvsTreeNodedefaultReportLocation ()
 
void disableReporting ()
 
void enableReporting ()
 
void enterBlockingSection ()
 
bool error () const
 
void error (KviKvsTreeNode *pNode, QString szMsgFmt,...)
 
void error (QString szMsgFmt,...)
 
bool errorNoIrcContext ()
 
KviKvsHashextendedScopeVariables ()
 
KviKvsHashglobalVariables ()
 
bool haltCalled ()
 
void handleBreak ()
 
void handleContinue ()
 
bool leaveBlockingSection ()
 
KviKvsHashlocalVariables ()
 
KviKvsVariantListparameterList ()
 
QString * popupId ()
 
bool reportingDisabled ()
 
KviKvsVariantreturnValue ()
 
KviKvsScriptscript ()
 
QString * scriptFilePath ()
 
void setBreakPending ()
 
void setContinuePending ()
 
void setDefaultReportLocation (KviKvsTreeNode *pNode)
 
void setHaltCalled ()
 
void setWindow (KviWindow *pWnd)
 
KviKvsVariantswapReturnValuePointer (KviKvsVariant *pNewPointer)
 
KviKvsObjectthisObject ()
 
void warning (KviKvsTreeNode *pNode, QString szMsgFmt,...)
 
void warning (QString szMsgFmt,...)
 
bool warningMissingParameter ()
 
bool warningNoIrcConnection ()
 
KviWindowwindow ()
 
 ~KviKvsRunTimeContext ()
 

Protected Types

enum  RunTimeFlags { BreakPending = 1 , ContinuePending = 2 , HaltCalled = 4 , DisableReporting = 8 }
 

Protected Member Functions

 KviKvsRunTimeContext (KviKvsScript *pScript, KviWindow *pWnd, KviKvsVariantList *pParams, KviKvsVariant *pRetVal, KviKvsExtendedRunTimeData *pExtData=nullptr)
 
void report (bool bError, KviKvsTreeNode *pNode, const QString &szMsgFmt, kvi_va_list va)
 

Protected Attributes

bool m_bError
 
KviKvsTreeNodem_pDefaultReportLocation
 
KviKvsExtendedRunTimeDatam_pExtendedData
 
KviKvsHashm_pLocalVariables
 
KviKvsVariantListm_pParameterList
 
KviKvsVariantm_pReturnValue
 
KviKvsScriptm_pScript
 
KviWindowm_pWindow
 
unsigned int m_uRunTimeFlags
 

Friends

class KviKvsEventManager
 
class KviKvsObject
 
class KviKvsRunTimeCall
 
class KviKvsScript
 

Member Enumeration Documentation

◆ RunTimeFlags

Enumerator
BreakPending 
ContinuePending 
HaltCalled 
DisableReporting 

Constructor & Destructor Documentation

◆ KviKvsRunTimeContext()

KviKvsRunTimeContext::KviKvsRunTimeContext ( KviKvsScript * pScript,
KviWindow * pWnd,
KviKvsVariantList * pParams,
KviKvsVariant * pRetVal,
KviKvsExtendedRunTimeData * pExtData = nullptr )
protected

◆ ~KviKvsRunTimeContext()

KviKvsRunTimeContext::~KviKvsRunTimeContext ( )

References m_pLocalVariables.

Member Function Documentation

◆ aliasSwitchList()

KviKvsSwitchList * KviKvsRunTimeContext::aliasSwitchList ( )
inline

References m_pExtendedData.

◆ breakPending()

◆ clearError()

void KviKvsRunTimeContext::clearError ( )
inline

References m_bError.

◆ connection()

KviIrcConnection * KviKvsRunTimeContext::connection ( )
inline

References m_pWindow.

◆ console()

KviConsoleWindow * KviKvsRunTimeContext::console ( )
inline

References m_pWindow.

◆ context()

KviIrcContext * KviKvsRunTimeContext::context ( )
inline

References m_pWindow.

◆ continuePending()

◆ defaultReportLocation()

KviKvsTreeNode * KviKvsRunTimeContext::defaultReportLocation ( )
inline

◆ disableReporting()

void KviKvsRunTimeContext::disableReporting ( )
inline

◆ enableReporting()

void KviKvsRunTimeContext::enableReporting ( )
inline

References DisableReporting, and m_uRunTimeFlags.

Referenced by KviKvsScript::run().

◆ enterBlockingSection()

void KviKvsRunTimeContext::enterBlockingSection ( )

◆ error() [1/3]

bool KviKvsRunTimeContext::error ( ) const
inline

References m_bError.

Referenced by KviKvsObject::callFunction(), errorNoIrcContext(), KviKvsTreeNodeArrayElement::evaluateIndex(), KviKvsTreeNodeExpressionUnaryOperator::evaluateOperand(), KviKvsTreeNodeExpressionBinaryOperator::evaluateOperands(), KviKvsTreeNodeAliasFunctionCall::evaluateReadOnly(), KviKvsTreeNodeData::evaluateReadOnly(), KviKvsTreeNodeExtendedScopeVariable::evaluateReadOnly(), KviKvsTreeNodeModuleFunctionCall::evaluateReadOnly(), KviKvsTreeNodeArrayReferenceAssert::evaluateReadOnlyInObjectScope(), KviKvsTreeNodeData::evaluateReadOnlyInObjectScope(), KviKvsTreeNodeHashReferenceAssert::evaluateReadOnlyInObjectScope(), KviKvsTreeNodeData::evaluateReadWrite(), KviKvsTreeNodeExtendedScopeVariable::evaluateReadWrite(), KviKvsTreeNodeData::evaluateReadWriteInObjectScope(), KviKvsTreeNodeAliasSimpleCommand::execute(), KviKvsTreeNodeModuleCallbackCommand::execute(), KviKvsTreeNodeModuleSimpleCommand::execute(), KviKvsTreeNodeOperationDecrement::execute(), KviKvsTreeNodeOperationIncrement::execute(), KviKvsTreeNodeOperationSelfAnd::execute(), KviKvsTreeNodeOperationSelfDivision::execute(), KviKvsTreeNodeOperationSelfModulus::execute(), KviKvsTreeNodeOperationSelfMultiplication::execute(), KviKvsTreeNodeOperationSelfOr::execute(), KviKvsTreeNodeOperationSelfShl::execute(), KviKvsTreeNodeOperationSelfShr::execute(), KviKvsTreeNodeOperationSelfSubtraction::execute(), KviKvsTreeNodeOperationSelfSum::execute(), KviKvsTreeNodeOperationSelfXor::execute(), KviKvsTreeNodeSpecialCommandClass::execute(), KviKvsTreeNodeSpecialCommandDefpopup::execute(), KviKvsTreeNodeSpecialCommandDo::execute(), KviKvsTreeNodeSpecialCommandFor::execute(), KviKvsTreeNodeSpecialCommandForeach::execute(), KviKvsTreeNodeSpecialCommandSwitch::execute(), KviKvsTreeNodeSpecialCommandWhile::execute(), KviKvsScript::executeInternal(), KviKvsParameterProcessor::handleParameterTypeError(), KviKvsTreeNodeScopeOperator::objectFromVariant(), and KviKvsParameterProcessor::process().

◆ error() [2/3]

void KviKvsRunTimeContext::error ( KviKvsTreeNode * pNode,
QString szMsgFmt,
... )

◆ error() [3/3]

void KviKvsRunTimeContext::error ( QString szMsgFmt,
... )

◆ errorNoIrcContext()

◆ extendedScopeVariables()

KviKvsHash * KviKvsRunTimeContext::extendedScopeVariables ( )
inline

◆ globalVariables()

◆ haltCalled()

bool KviKvsRunTimeContext::haltCalled ( )
inline

◆ handleBreak()

◆ handleContinue()

◆ leaveBlockingSection()

bool KviKvsRunTimeContext::leaveBlockingSection ( )

References g_pApp, and m_pWindow.

◆ localVariables()

KviKvsHash * KviKvsRunTimeContext::localVariables ( )
inline

◆ parameterList()

◆ popupId()

QString * KviKvsRunTimeContext::popupId ( )
inline

References m_pExtendedData.

Referenced by popup_kvs_fnc_currentItemId().

◆ report()

◆ reportingDisabled()

bool KviKvsRunTimeContext::reportingDisabled ( )
inline

References DisableReporting, and m_uRunTimeFlags.

Referenced by KviKvsScript::run().

◆ returnValue()

◆ script()

KviKvsScript * KviKvsRunTimeContext::script ( )
inline

References KviKvsScript, and m_pScript.

◆ scriptFilePath()

QString * KviKvsRunTimeContext::scriptFilePath ( )
inline

References m_pExtendedData.

◆ setBreakPending()

◆ setContinuePending()

void KviKvsRunTimeContext::setContinuePending ( )
inline

◆ setDefaultReportLocation()

◆ setHaltCalled()

void KviKvsRunTimeContext::setHaltCalled ( )
inline

References HaltCalled, and m_uRunTimeFlags.

◆ setWindow()

void KviKvsRunTimeContext::setWindow ( KviWindow * pWnd)
inline

◆ swapReturnValuePointer()

KviKvsVariant * KviKvsRunTimeContext::swapReturnValuePointer ( KviKvsVariant * pNewPointer)

◆ thisObject()

◆ warning() [1/2]

◆ warning() [2/2]

void KviKvsRunTimeContext::warning ( QString szMsgFmt,
... )

◆ warningMissingParameter()

bool KviKvsRunTimeContext::warningMissingParameter ( )

◆ warningNoIrcConnection()

bool KviKvsRunTimeContext::warningNoIrcConnection ( )

◆ window()

Friends And Related Symbol Documentation

◆ KviKvsEventManager

friend class KviKvsEventManager
friend

◆ KviKvsObject

friend class KviKvsObject
friend

References KviKvsObject.

Referenced by KviKvsObject, and thisObject().

◆ KviKvsRunTimeCall

friend class KviKvsRunTimeCall
friend

References KviKvsRunTimeCall.

Referenced by KviKvsRunTimeCall.

◆ KviKvsScript

friend class KviKvsScript
friend

Member Data Documentation

◆ m_bError

bool KviKvsRunTimeContext::m_bError
protected

◆ m_pDefaultReportLocation

◆ m_pExtendedData

◆ m_pLocalVariables

KviKvsHash* KviKvsRunTimeContext::m_pLocalVariables
protected

◆ m_pParameterList

KviKvsVariantList* KviKvsRunTimeContext::m_pParameterList
protected

◆ m_pReturnValue

KviKvsVariant* KviKvsRunTimeContext::m_pReturnValue
protected

◆ m_pScript

KviKvsScript* KviKvsRunTimeContext::m_pScript
protected

◆ m_pWindow

KviWindow* KviKvsRunTimeContext::m_pWindow
protected

◆ m_uRunTimeFlags


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