KVIrc 5.2.4
Developer APIs
Macros
object_macros.h File Reference
#include "KviKvsKernel.h"
#include "KviKvsObject.h"
#include "KviKvsObjectClass.h"
#include "KviKvsObjectController.h"
#include "KviKvsObjectFunctionCall.h"

Go to the source code of this file.

Macros

#define CHECK_HOBJECT_IS_WIDGET(__pObject)
 
#define CHECK_INTERNAL_POINTER(__pointer)
 
#define KVSO_BEGIN_CONSTRUCTOR(__className, __baseClass)
 
#define KVSO_BEGIN_DESTRUCTOR(__className)
 
#define KVSO_BEGIN_REGISTERCLASS(__className, __stringName, __baseClass)
 
#define KVSO_CLASS_FUNCTION(__className, __functionName)    bool KvsObject_##__className::__functionName([[maybe_unused]] KviKvsObjectFunctionCall * c)
 
#define KVSO_DECLARE_OBJECT(__className)
 
#define KVSO_END_CONSTRUCTOR(__className)    }
 
#define KVSO_END_DESTRUCTOR(__className)    }
 
#define KVSO_END_REGISTERCLASS(__className)    }
 
#define KVSO_REGISTER_HANDLER(__className, __szName, __proc)    g_pKvs##__className##Class->registerFunctionHandler(__szName, (KviKvsObjectFunctionHandlerProc)(KVI_PTR2MEMBER(__className::__proc)));
 
#define KVSO_REGISTER_HANDLER_BY_NAME(__className, __szName)    g_pKvs##__className##Class->registerFunctionHandler(#__szName, (KviKvsObjectFunctionHandlerProc)(KVI_PTR2MEMBER(__className::__szName)));
 
#define KVSO_REGISTER_STANDARD_FALSERETURN_HANDLER(__className, __szName)    g_pKvs##__className##Class->registerStandardFalseReturnFunctionHandler(__szName);
 
#define KVSO_REGISTER_STANDARD_NOTHINGRETURN_HANDLER(__className, __szName)    g_pKvs##__className##Class->registerStandardNothingReturnFunctionHandler(__szName);
 
#define KVSO_REGISTER_STANDARD_TRUERETURN_HANDLER(__className, __szName)    g_pKvs##__className##Class->registerStandardTrueReturnFunctionHandler(__szName);
 
#define SET_OBJECT(__className)
 

Macro Definition Documentation

◆ CHECK_HOBJECT_IS_WIDGET

#define CHECK_HOBJECT_IS_WIDGET (   __pObject)
Value:
if(!__pObject) \
{ \
c->warning(__tr2qs_ctx("Widget parameter is not an object", "objects")); \
return true; \
} \
if(!__pObject->object()) \
{ \
c->warning(__tr2qs_ctx("Widget parameter is not a valid object", "objects")); \
return true; \
} \
if(!__pObject->object()->isWidgetType()) \
{ \
c->warning(__tr2qs_ctx("Widget object required", "objects")); \
return true; \
}
#define __tr2qs_ctx(text, context)
Definition KviLocale.h:223

◆ CHECK_INTERNAL_POINTER

#define CHECK_INTERNAL_POINTER (   __pointer)
Value:
if(!__pointer) \
{ \
c->error(__tr2qs_ctx("Internal error: no valid pointer for this object", "objects")); \
return false; \
}

◆ KVSO_BEGIN_CONSTRUCTOR

#define KVSO_BEGIN_CONSTRUCTOR (   __className,
  __baseClass 
)
Value:
__className::__className(KviKvsObjectClass * pClass, KviKvsObject * pParent, const QString & szName) \
: __baseClass(pClass, pParent, szName) \
{
Definition KviKvsObjectClass.h:50
Definition KviKvsObject.h:51

◆ KVSO_BEGIN_DESTRUCTOR

#define KVSO_BEGIN_DESTRUCTOR (   __className)
Value:
__className::~__className() \
{

◆ KVSO_BEGIN_REGISTERCLASS

#define KVSO_BEGIN_REGISTERCLASS (   __className,
  __stringName,
  __baseClass 
)
Value:
static KviKvsObjectClass * g_pKvs##__className##Class = nullptr; \
static KviKvsObject * kvs_##__className##_createInstance(KviKvsObjectClass * pClass, KviKvsObject * pParent, const QString & szName) \
{ \
return new __className(pClass, pParent, szName); \
} \
void __className::unregisterSelf() \
{ \
delete g_pKvs##__className##Class; \
g_pKvs##__className##Class = nullptr; \
} \
void __className::registerSelf() \
{ \
g_pKvs##__className##Class = new KviKvsObjectClass(base, __stringName, kvs_##__className##_createInstance, true);
static KviKvsKernel * instance()
Definition KviKvsKernel.h:94
KviKvsObjectController * objectController()
Definition KviKvsKernel.h:100
KviKvsObjectClass * lookupClass(const QString &szClass, bool bBuiltinOnly=false)
Definition KviKvsObjectController.cpp:206

◆ KVSO_CLASS_FUNCTION

#define KVSO_CLASS_FUNCTION (   __className,
  __functionName 
)     bool KvsObject_##__className::__functionName([[maybe_unused]] KviKvsObjectFunctionCall * c)

◆ KVSO_DECLARE_OBJECT

#define KVSO_DECLARE_OBJECT (   __className)
Value:
__className(KviKvsObjectClass * pClass, KviKvsObject * pParent, const QString & szName); \
~__className(); \
static void registerSelf(); \
static void unregisterSelf();

◆ KVSO_END_CONSTRUCTOR

#define KVSO_END_CONSTRUCTOR (   __className)     }

◆ KVSO_END_DESTRUCTOR

#define KVSO_END_DESTRUCTOR (   __className)     }

◆ KVSO_END_REGISTERCLASS

#define KVSO_END_REGISTERCLASS (   __className)     }

◆ KVSO_REGISTER_HANDLER

#define KVSO_REGISTER_HANDLER (   __className,
  __szName,
  __proc 
)     g_pKvs##__className##Class->registerFunctionHandler(__szName, (KviKvsObjectFunctionHandlerProc)(KVI_PTR2MEMBER(__className::__proc)));

◆ KVSO_REGISTER_HANDLER_BY_NAME

#define KVSO_REGISTER_HANDLER_BY_NAME (   __className,
  __szName 
)     g_pKvs##__className##Class->registerFunctionHandler(#__szName, (KviKvsObjectFunctionHandlerProc)(KVI_PTR2MEMBER(__className::__szName)));

◆ KVSO_REGISTER_STANDARD_FALSERETURN_HANDLER

#define KVSO_REGISTER_STANDARD_FALSERETURN_HANDLER (   __className,
  __szName 
)     g_pKvs##__className##Class->registerStandardFalseReturnFunctionHandler(__szName);

◆ KVSO_REGISTER_STANDARD_NOTHINGRETURN_HANDLER

#define KVSO_REGISTER_STANDARD_NOTHINGRETURN_HANDLER (   __className,
  __szName 
)     g_pKvs##__className##Class->registerStandardNothingReturnFunctionHandler(__szName);

◆ KVSO_REGISTER_STANDARD_TRUERETURN_HANDLER

#define KVSO_REGISTER_STANDARD_TRUERETURN_HANDLER (   __className,
  __szName 
)     g_pKvs##__className##Class->registerStandardTrueReturnFunctionHandler(__szName);

◆ SET_OBJECT

#define SET_OBJECT (   __className)
Value:
__className * obj = new __className(parentScriptWidget()); \
obj->setObjectName(getName()); \
setObject(obj, true);