---

IgModuleDef.h File Reference

#include "Iguana/Framework/interface/IgPluginDef.h"
#include "classlib/utils/Callback.h"
#include <string>
#include <list>

Go to the source code of this file.

Classes
class	IgModuleDef
	A base class for modules. More...
class	IgSimpleModuleDef
	IgModuleDef used by DEFINE_IGUANA_MODULE(). More...
Defines
#define	DEFINE_IG_PLUGIN_DEFAULT_NAME(factory, type)
	Register type into factory as stringized type name.
#define	DEFINE_IG_PLUGIN_NAME(factory, name)
	Register name into factory without any object type.
#define	DEFINE_IGUANA_MODULE()
	Define module entry point to register this IgModule.
#define	DEFINE_IGUANA_PLUGIN(factory, type, name)
	Register type into factory as name.
#define	IG_MODULE_ATTACH_ACTION(cbargs)
#define	IG_MODULE_ATTACH_MDACTION(cbargs)
#define	IG_MODULE_DETACH_ACTION(cbargs)
#define	IG_MODULE_DETACH_MDACTION(cbargs)
#define	IG_MODULE_QUERY_ACTION(cbargs)
#define	IG_MODULE_QUERY_MDACTION(cbargs)
#define	IG_MODULE_SYM(x, y)   IG_MODULE_SYM2(x,y)
#define	IG_MODULE_SYM2(x, y)   x ## y
#define	IG_MODULE_USED
#define	IG_PLUGIN_API
	Windows DLL API used for module entry point.

---

Define Documentation

#define DEFINE_IG_PLUGIN_DEFAULT_NAME	(	factory,
		type		)

Value:

IG_MODULE_QUERY_MDACTION                                        \
        ((&IgPluginDef<factory, type>::declareName, std::string (#type)));\
     IG_MODULE_ATTACH_MDACTION                                  \
        ((&IgPluginDef<factory, type>::installFactoryName,std::string (#type)))

Register type into factory as stringized type name.

See also:

IGUANA_BUILTIN_PLUGINS.

Definition at line 50 of file IgModuleDef.h.

#define DEFINE_IG_PLUGIN_NAME	(	factory,
		name		)

Value:

IG_MODULE_QUERY_MDACTION                                        \
        ((&IgPluginDef<factory, void>::declareName, std::string (name)))

Register name into factory without any object type.

See also:

IGUANA_BUILTIN_PLUGINS.

Definition at line 56 of file IgModuleDef.h.

 

#define DEFINE_IGUANA_MODULE

(

)

Value:

namespace { IgSimpleModuleDef IGUANA_THIS_MODULE; }             \
     extern "C" IG_PLUGIN_API IgModuleDef *IGUANA_MODULE (void)         \
        { return &IGUANA_THIS_MODULE; }                                 \
     extern "C" IG_PLUGIN_API IgModuleDef *IGUANA_MODULE (void)

Define module entry point to register this IgModule.

See also:

IGUANA_BUILTIN_PLUGINS.

Definition at line 76 of file IgModuleDef.h.

#define DEFINE_IGUANA_PLUGIN	(	factory,
		type,
		name		)

Value:

IG_MODULE_QUERY_MDACTION                                        \
        ((&IgPluginDef<factory, type>::declareName, std::string (name)));\
     IG_MODULE_ATTACH_MDACTION                                  \
        ((&IgPluginDef<factory, type>::installFactoryName,std::string (name)))

Register type into factory as name.

See also:

IGUANA_BUILTIN_PLUGINS.

Definition at line 44 of file IgModuleDef.h.

#define IG_MODULE_ATTACH_ACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitAttachAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onAttach.push_back(lat::CreateCallback cbargs), true)

Definition at line 89 of file IgModuleDef.h.

#define IG_MODULE_ATTACH_MDACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitAttachAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onAttachMD.push_back(lat::CreateCallback cbargs), true)

Definition at line 92 of file IgModuleDef.h.

#define IG_MODULE_DETACH_ACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitDetachAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onDetach.push_back(lat::CreateCallback cbargs), true)

Definition at line 96 of file IgModuleDef.h.

#define IG_MODULE_DETACH_MDACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitDetachAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onDetachMD.push_back(lat::CreateCallback cbargs), true)

Definition at line 99 of file IgModuleDef.h.

#define IG_MODULE_QUERY_ACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitQueryAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onQuery.push_back(lat::CreateCallback cbargs), true)

Definition at line 82 of file IgModuleDef.h.

#define IG_MODULE_QUERY_MDACTION

(

cbargs

)

Value:

static bool IG_MODULE_USED IG_MODULE_SYM (moduleInitQueryAction, __LINE__) = \
        (IGUANA_THIS_MODULE.onQueryMD.push_back(lat::CreateCallback cbargs), true)

Definition at line 85 of file IgModuleDef.h.

#define IG_MODULE_SYM	(	x,
		y		)	IG_MODULE_SYM2(x,y)

Definition at line 60 of file IgModuleDef.h.

#define IG_MODULE_SYM2	(	x,
		y		)	x ## y

Definition at line 61 of file IgModuleDef.h.

#define IG_MODULE_USED

Definition at line 73 of file IgModuleDef.h.

#define IG_PLUGIN_API

Windows DLL API used for module entry point.

Automatically determined from IGUANA_BUILTIN_PLUGINS.

Definition at line 67 of file IgModuleDef.h.

---