factory.h File Reference

Include dependency graph for factory.h:

Go to the source code of this file.

Classes
class	FactoryBase
	Base class for Factories ( Factory, Factory1Param, Factory2Param and Factory3Param. ) More...
class	Factory< T >
	Generalized static factory that can deliver instances of T, when no variable is needed in the creation. More...
class	Factory1Param< T, P >
	Generalized static factory that can deliver instances of T, when a variable is needed in the creation. More...
class	Factory2Param< T, P0, P1 >
	Subclass of FactoryBase. More...
class	Factory3Param< T, P0, P1, P2 >
	Subclass of FactoryBase. More...

Macros
#define	mDefaultFactoryStringImpl
#define	mDefaultStaticFactoryStringDeclaration
#define	mDefaultFactoryInitClassImpl(baseclss, createfunc)
#define	mDefaultFactoryInstanciationBase(keywrd, usernm)
#define	mDefaultFactoryCreatorImpl(baseclss, clss)   static baseclss* createInstance() { return new clss; } \
#define	mDefaultFactoryInstantiation(baseclss, clss, keywrd, usernm)
#define	mDefaultFactoryCreatorImpl1Param(baseclss, clss, parclss)
#define	mDefaultFactoryInstantiation1Param(baseclss, clss, parclss, keywrd, usernm)
#define	mDefaultFactoryCreatorImpl2Param(baseclss, clss, parclss1, parclss2)
#define	mDefaultFactoryInstantiation2Param(baseclss, clss, parclss1, parclss2, keywrd, usernm)
#define	mCreateImpl(donames, createfunc)
#define	mAddCreator
#define	mDefineFactory(mod, T, funcname)   mGlobal(mod) ::Factory<T>& funcname()
#define	mDefineFactoryInClasswKW(T, funcname, kw)
#define	mDefineFactoryInClass(T, funcname)   mDefineFactoryInClasswKW( T, funcname, 0 )
#define	mImplFactory(T, funcname)
#define	mDefineFactory1Param(mod, T, P, funcname)   mGlobal(mod) ::Factory1Param<T,P>& funcname()
#define	mDefineFactory1ParamInClasswKW(T, P, funcname, kw)
#define	mDefineFactory1ParamInClass(T, P, funcname)   mDefineFactory1ParamInClasswKW( T, P, funcname, 0 )
#define	mImplFactory1Param(T, P, funcname)
#define	mDefineFactory2Param(mod, T, P0, P1, funcname)   mGlobal(mod) ::Factory2Param<T,P0,P1>& funcname()
#define	mDefineFactory2ParamInClasswKW(T, P0, P1, funcname, kw)
#define	mDefineFactory2ParamInClass(T, P0, P1, funcname)   mDefineFactory2ParamInClasswKW( T, P0, P1, funcname, 0 )
#define	mImplFactory2Param(T, P0, P1, funcname)
#define	mDefineFactory3Param(mod, T, P0, P1, P2, funcname)   mGlobal(mod) ::Factory3Param<T,P0,P1,P2>& funcname()
#define	mDefineFactory3ParamInClasswKW(T, P0, P1, P2, funcname, kw)
#define	mDefineFactory3ParamInClass(T, P0, P1, P2, funcname)   mDefineFactory3ParamInClasswKW( T, P0, P1, P2, funcname, 0 )
#define	mImplFactory3Param(T, P0, P1, P2, funcname)

Macro Definition Documentation

#define mAddCreator

Value:

const int idx = indexOf( name );\
\
    if ( idx==-1 )\
    { \
	addNames( name, username ); \
        creators_ += cr; \
    } \
    else\
    {\
        setNames( idx, name, username ); \
        creators_[idx] = cr;\
    }

#define mCreateImpl	(		donames,
			createfunc
	)

Value:

currentname_.getObject() = name; \
    if ( donames ) \
    { \
        const int idx = indexOf( name ); \
	if ( idx==-1 ) \
        { \
            errmsgs_.getObject() = "Name "; \
            errmsgs_.getObject().add( name ).add(" not found.\n" ) \
                                .add( "Perhaps all plugins are not loaded\n" );\
            return 0; \
        } \
        return createfunc; \
    } \
 \
    for ( int idx=0; idx<creators_.size(); idx++ ) \
    { \
        T* res = createfunc; \
	if ( res ) return res; \
    } \
 \
    return 0

#define mDefaultFactoryCreatorImpl	(		baseclss,
			clss
	)		static baseclss* createInstance() { return new clss; } \

#define mDefaultFactoryCreatorImpl1Param	(		baseclss,
			clss,
			parclss
	)

Value:

static baseclss*        createInstance( parclss p1 ) \
                        { return new clss( p1 ); }

#define mDefaultFactoryCreatorImpl2Param	(		baseclss,
			clss,
			parclss1,
			parclss2
	)

Value:

static baseclss*        createInstance( parclss1 p1, parclss2 p2 ) \
                        { return new clss( p1, p2 ); }

#define mDefaultFactoryInitClassImpl	(		baseclss,
			createfunc
	)

Value:

{ \
    baseclss::factory().addCreator(createfunc,sFactoryKeyword(), \
                                   sFactoryDisplayName()); \
}

#define mDefaultFactoryInstanciationBase	(		keywrd,
			usernm
	)

Value:

mDefaultFactoryStringImpl \
    static const char*  sFactoryKeyword() { return keywrd; } \
    static uiString     sFactoryDisplayName() { return usernm; } \
    static void         initClass()

#define mDefaultFactoryInstantiation	(		baseclss,
			clss,
			keywrd,
			usernm
	)

Value:

mDefaultFactoryCreatorImpl( baseclss, clss ); \
    mDefaultFactoryInstanciationBase( keywrd, usernm ) \
    mDefaultFactoryInitClassImpl( baseclss, createInstance )

#define mDefaultFactoryInstantiation1Param	(		baseclss,
			clss,
			parclss,
			keywrd,
			usernm
	)

Value:

mDefaultFactoryCreatorImpl1Param( baseclss, clss, parclss ) \
    mDefaultFactoryInstanciationBase( keywrd, usernm ) \
    mDefaultFactoryInitClassImpl( baseclss, createInstance )

#define mDefaultFactoryInstantiation2Param	(		baseclss,
			clss,
			parclss1,
			parclss2,
			keywrd,
			usernm
	)

Value:

mDefaultFactoryCreatorImpl2Param( baseclss, clss, parclss1, parclss2 ) \
    mDefaultFactoryInstanciationBase( keywrd, usernm ) \
    mDefaultFactoryInitClassImpl( baseclss, createInstance )

#define mDefaultFactoryStringImpl

Value:

const char*             factoryKeyword() const { return sFactoryKeyword(); } \
    uiString            factoryDisplayName() const \
                                        { return sFactoryDisplayName(); }

#define mDefaultStaticFactoryStringDeclaration

Value:

static const char*      sFactoryKeyword(); \
    static uiString     sFactoryDisplayName()

#define mDefineFactory	(		mod,
			T,
			funcname
	)		mGlobal(mod) ::Factory<T>& funcname()

#define mDefineFactory1Param	(		mod,
			T,
			P,
			funcname
	)		mGlobal(mod) ::Factory1Param<T,P>& funcname()

#define mDefineFactory1ParamInClass	(		T,
			P,
			funcname
	)		mDefineFactory1ParamInClasswKW( T, P, funcname, 0 )

#define mDefineFactory1ParamInClasswKW	(		T,
			P,
			funcname,
			kw
	)

Value:

static ::Factory1Param<T,P>& funcname(); \
virtual uiString factoryDisplayName() const \
{ return ::toUiString(factoryKeyword()); } \
virtual const char* factoryKeyword() const { return kw; }

#define mDefineFactory2Param	(		mod,
			T,
			P0,
			P1,
			funcname
	)		mGlobal(mod) ::Factory2Param<T,P0,P1>& funcname()

#define mDefineFactory2ParamInClass	(		T,
			P0,
			P1,
			funcname
	)		mDefineFactory2ParamInClasswKW( T, P0, P1, funcname, 0 )

#define mDefineFactory2ParamInClasswKW	(		T,
			P0,
			P1,
			funcname,
			kw
	)

Value:

static ::Factory2Param<T,P0,P1>& funcname(); \
virtual uiString factoryDisplayName() const \
{ return ::toUiString( factoryKeyword() ); } \
virtual const char* factoryKeyword() const { return kw; }

#define mDefineFactory3Param	(		mod,
			T,
			P0,
			P1,
			P2,
			funcname
	)		mGlobal(mod) ::Factory3Param<T,P0,P1,P2>& funcname()

#define mDefineFactory3ParamInClass	(		T,
			P0,
			P1,
			P2,
			funcname
	)		mDefineFactory3ParamInClasswKW( T, P0, P1, P2, funcname, 0 )

#define mDefineFactory3ParamInClasswKW	(		T,
			P0,
			P1,
			P2,
			funcname,
			kw
	)

Value:

static ::Factory3Param<T,P0,P1,P2>& funcname(); \
virtual uiString factoryDisplayName() const \
{ return ::toUiString( factoryKeyword() ); } \
virtual const char* factoryKeyword() const { return kw; }

#define mDefineFactoryInClass	(		T,
			funcname
	)		mDefineFactoryInClasswKW( T, funcname, 0 )

#define mDefineFactoryInClasswKW	(		T,
			funcname,
			kw
	)

Value:

static ::Factory<T>& funcname(); \
virtual uiString factoryDisplayName() const \
{ return ::toUiString( factoryKeyword() ); } \
virtual const char* factoryKeyword() const { return kw; }

#define mImplFactory	(		T,
			funcname
	)

Value:

::Factory<T>& funcname() \
{ \
    mDefineStaticLocalObject(PtrMan< ::Factory<T> >,inst,(new ::Factory<T>)); \
    return *inst; \
}

#define mImplFactory1Param	(		T,
			P,
			funcname
	)

Value:

::Factory1Param<T,P>& funcname() \
{ \
    mLockStaticInitLock( static_inst_lck__ ); \
    static PtrMan< ::Factory1Param<T,P> > \
        inst(new ::Factory1Param<T,P>); \
    mUnlockStaticInitLock( static_inst_lck__ ); \
     \
    return *inst; \
}

#define mImplFactory2Param	(		T,
			P0,
			P1,
			funcname
	)

Value:

::Factory2Param<T,P0,P1>& funcname() \
{ \
    mLockStaticInitLock( static_inst_lck__ ); \
    static PtrMan< ::Factory2Param<T,P0,P1> > \
        inst(new ::Factory2Param<T,P0,P1>); \
    mUnlockStaticInitLock( static_inst_lck__ ); \
    \
    return *inst; \
}

#define mImplFactory3Param	(		T,
			P0,
			P1,
			P2,
			funcname
	)

Value:

::Factory3Param<T,P0,P1,P2>& funcname() \
{ \
    mLockStaticInitLock( static_inst_lck__ ); \
    static PtrMan< ::Factory3Param<T,P0,P1,P2> > \
        inst(new ::Factory3Param<T,P0,P1,P2>); \
    mUnlockStaticInitLock( static_inst_lck__ ); \
\
    return *inst; \
}