KVIrc 5.2.0
Developer APIs
Classes | Macros | Typedefs
KviKvsModuleInterface.h File Reference
#include "kvi_settings.h"
#include "KviPointerHashTable.h"
#include "KviKvsRunTimeCall.h"
#include "KviKvsParameterProcessor.h"
#include "KviKvsSwitchList.h"
#include "KviKvsScript.h"
#include "KviQString.h"
#include <vector>

Go to the source code of this file.

Classes

class  KviKvsModuleCallbackCommandCall
 
class  KviKvsModuleCommandCall
 
class  KviKvsModuleEventCall
 
class  KviKvsModuleFunctionCall
 
class  KviKvsModuleInterface
 
class  KviKvsModuleRunTimeCall
 

Macros

#define KVSM_PARAMETER(a, b, c, d)   KVS_PARAMETER(a, b, c, d)
 
#define KVSM_PARAMETER_IGNORED(a)   KVS_PARAMETER_IGNORED(a)
 
#define KVSM_PARAMETERS_BEGIN(pCall)    KVS_PARAMETERS_BEGIN(parameter_format_list)
 
#define KVSM_PARAMETERS_END(pCall)
 
#define KVSM_REGISTER_CALLBACK_COMMAND(_pModule, _szCmd, _procname)    _pModule->kvsRegisterCallbackCommand(_szCmd, _procname);
 
#define KVSM_REGISTER_FUNCTION(_pModule, _szFnc, _procname)    _pModule->kvsRegisterFunction(_szFnc, _procname);
 
#define KVSM_REGISTER_SIMPLE_COMMAND(_pModule, _szCmd, _procname)    _pModule->kvsRegisterSimpleCommand(_szCmd, _procname);
 
#define KVSM_REQUIRE_CONNECTION(pCall)
 
#define KVSM_UNREGISTER_ALL_CALLBACK_COMMANDS(_pModule)    _pModule->kvsUnregisterAllCallbackCommands();
 
#define KVSM_UNREGISTER_ALL_FUNCTIONS(_pModule)    _pModule->kvsUnregisterAllFunctions();
 
#define KVSM_UNREGISTER_ALL_SIMPLE_COMMANDS(_pModule)    _pModule->kvsUnregisterAllSimpleCommands();
 
#define KVSM_UNREGISTER_CALLBACK_COMMAND(_pModule, _szCmd)    _pModule->kvsUnregisterCallbackCommand(_szCmd);
 
#define KVSM_UNREGISTER_FUNCTION(_pModule, _szFnc)    _pModule->kvsUnregisterFunction(_szFnc);
 
#define KVSM_UNREGISTER_SIMPLE_COMMAND(_pModule, _szCmd)    _pModule->kvsUnregisterSimpleCommand(_szCmd);
 

Typedefs

typedef bool(* KviKvsModuleCallbackCommandExecRoutine) (KviKvsModuleCallbackCommandCall *c)
 
typedef bool(* KviKvsModuleEventHandlerRoutine) (KviKvsModuleEventCall *c)
 
typedef bool(* KviKvsModuleFunctionExecRoutine) (KviKvsModuleFunctionCall *c)
 
typedef bool(* KviKvsModuleSimpleCommandExecRoutine) (KviKvsModuleCommandCall *c)
 

Macro Definition Documentation

◆ KVSM_PARAMETER

#define KVSM_PARAMETER (   a,
  b,
  c,
  d 
)    KVS_PARAMETER(a, b, c, d)

◆ KVSM_PARAMETER_IGNORED

#define KVSM_PARAMETER_IGNORED (   a)    KVS_PARAMETER_IGNORED(a)

◆ KVSM_PARAMETERS_BEGIN

#define KVSM_PARAMETERS_BEGIN (   pCall)     KVS_PARAMETERS_BEGIN(parameter_format_list)

◆ KVSM_PARAMETERS_END

#define KVSM_PARAMETERS_END (   pCall)
Value:
KVS_PARAMETERS_END \
if(!KviKvsParameterProcessor::process(pCall->params(), pCall->context(), parameter_format_list)) \
return false;
bool process(KviKvsVariantList *pVariantList, KviKvsRunTimeContext *pContext, KviKvsParameterProcessor::ParameterFormat *pFmtArray)
Definition KviKvsParameterProcessor.cpp:136

◆ KVSM_REGISTER_CALLBACK_COMMAND

#define KVSM_REGISTER_CALLBACK_COMMAND (   _pModule,
  _szCmd,
  _procname 
)     _pModule->kvsRegisterCallbackCommand(_szCmd, _procname);

◆ KVSM_REGISTER_FUNCTION

#define KVSM_REGISTER_FUNCTION (   _pModule,
  _szFnc,
  _procname 
)     _pModule->kvsRegisterFunction(_szFnc, _procname);

◆ KVSM_REGISTER_SIMPLE_COMMAND

#define KVSM_REGISTER_SIMPLE_COMMAND (   _pModule,
  _szCmd,
  _procname 
)     _pModule->kvsRegisterSimpleCommand(_szCmd, _procname);

◆ KVSM_REQUIRE_CONNECTION

#define KVSM_REQUIRE_CONNECTION (   pCall)
Value:
if(!pCall->window()->context()) \
return c->context()->errorNoIrcContext(); \
if(!pCall->window()->connection()) \
return c->context()->warningNoIrcConnection();

◆ KVSM_UNREGISTER_ALL_CALLBACK_COMMANDS

#define KVSM_UNREGISTER_ALL_CALLBACK_COMMANDS (   _pModule)     _pModule->kvsUnregisterAllCallbackCommands();

◆ KVSM_UNREGISTER_ALL_FUNCTIONS

#define KVSM_UNREGISTER_ALL_FUNCTIONS (   _pModule)     _pModule->kvsUnregisterAllFunctions();

◆ KVSM_UNREGISTER_ALL_SIMPLE_COMMANDS

#define KVSM_UNREGISTER_ALL_SIMPLE_COMMANDS (   _pModule)     _pModule->kvsUnregisterAllSimpleCommands();

◆ KVSM_UNREGISTER_CALLBACK_COMMAND

#define KVSM_UNREGISTER_CALLBACK_COMMAND (   _pModule,
  _szCmd 
)     _pModule->kvsUnregisterCallbackCommand(_szCmd);

◆ KVSM_UNREGISTER_FUNCTION

#define KVSM_UNREGISTER_FUNCTION (   _pModule,
  _szFnc 
)     _pModule->kvsUnregisterFunction(_szFnc);

◆ KVSM_UNREGISTER_SIMPLE_COMMAND

#define KVSM_UNREGISTER_SIMPLE_COMMAND (   _pModule,
  _szCmd 
)     _pModule->kvsUnregisterSimpleCommand(_szCmd);

Typedef Documentation

◆ KviKvsModuleCallbackCommandExecRoutine

typedef bool(* KviKvsModuleCallbackCommandExecRoutine) (KviKvsModuleCallbackCommandCall *c)

◆ KviKvsModuleEventHandlerRoutine

typedef bool(* KviKvsModuleEventHandlerRoutine) (KviKvsModuleEventCall *c)

◆ KviKvsModuleFunctionExecRoutine

typedef bool(* KviKvsModuleFunctionExecRoutine) (KviKvsModuleFunctionCall *c)

◆ KviKvsModuleSimpleCommandExecRoutine

typedef bool(* KviKvsModuleSimpleCommandExecRoutine) (KviKvsModuleCommandCall *c)