global instance holder More...

#include "ZFTypeId.h"
#include "ZFMethodDeclare.h"

Macros
#define	ZFCLASS_SINGLETON_DECLARE(AccessTypeName, accessMethodName)
	util macro to declare a singleton instance access for normal object type

#define	ZFCLASS_SINGLETON_DECLARE_DETAIL(SetterAccessType, GetterAccessType, AccessTypeName, accessMethodName)
	see ZFCLASS_SINGLETON_DECLARE

#define	ZFCLASS_SINGLETON_DEFINE(OwnerClass, accessMethodName)
	see ZFCLASS_SINGLETON_DECLARE

#define	ZFCLASS_SINGLETON_DEFINE_WITH_LEVEL(OwnerClass, accessMethodName, ZFLevel_)
	see ZFCLASS_SINGLETON_DECLARE

#define	ZFCLASS_SINGLETON_DEFINE_DETAIL(OwnerClass, AccessTypeName, ObjectTypeName, accessMethodName, ZFLevel_)
	see ZFCLASS_SINGLETON_DECLARE

#define	ZFOBJECT_SINGLETON_DECLARE(AccessTypeName, accessMethodName)
	util macro to declare a singleton instance access for ZFObject type

#define	ZFOBJECT_SINGLETON_DECLARE_DETAIL(SetterAccessType, GetterAccessType, AccessTypeName, accessMethodName)
	see ZFOBJECT_SINGLETON_DECLARE

#define	ZFOBJECT_SINGLETON_DEFINE(OwnerClass, accessMethodName)
	see ZFOBJECT_SINGLETON_DECLARE

#define	ZFOBJECT_SINGLETON_DEFINE_WITH_LEVEL(OwnerClass, accessMethodName, ZFLevel_)
	see ZFOBJECT_SINGLETON_DECLARE

#define	ZFOBJECT_SINGLETON_DEFINE_DETAIL(OwnerClass, AccessTypeName, ObjectTypeName, accessMethodName, ZFLevel_)
	see ZFOBJECT_SINGLETON_DECLARE

Functions
const ZFCorePointer *	ZFObjectGlobalInstanceAdd (const ZFCorePointer &sp, ZFLevel level=ZFLevelAppNormal)
	add a global instance that would be auto deleted while ZFFrameworkCleanup

const ZFCorePointer *	ZFObjectGlobalInstanceAdd (ZFObject *obj, ZFLevel level=ZFLevelAppNormal)
	see ZFObjectGlobalInstanceAdd

void	ZFObjectGlobalInstanceRemove (const ZFCorePointer *sp, ZFLevel level)
	see ZFObjectGlobalInstanceAdd

Detailed Description

global instance holder

Macro Definition Documentation

◆ ZFCLASS_SINGLETON_DECLARE

#define ZFCLASS_SINGLETON_DECLARE	(		AccessTypeName,
			accessMethodName )

util macro to declare a singleton instance access for normal object type

usage:

// in *.h file
zfclass YourObject {
    / **
     * comment here
     * /
    ZFCLASS_SINGLETON_DECLARE(YourObject, instance)
};
// in *.cpp file
ZFCLASS_SINGLETON_DEFINE(YourObject, instance)
 
// then you can access the instance by
YourObject::instance();

you may change the internal singleton instance by:

newInstance = zfnew(YourType); // must be created by zfnew
YourObject::instance(newInstance); // set
newInstance = YourObject::instance(); // must re-check new pointer value

◆ ZFOBJECT_SINGLETON_DECLARE

#define ZFOBJECT_SINGLETON_DECLARE	(		AccessTypeName,
			accessMethodName )

util macro to declare a singleton instance access for ZFObject type

usage:

// in *.h file
zfclass YourObject : zfextend ZFObject {
    / **
     * comment here (optional)
     * /
    ZFOBJECT_SINGLETON_DECLARE(YourObject, instance)
};
// in *.cpp file
ZFOBJECT_SINGLETON_DEFINE(YourObject, instance)
 
// then you can access the instance by
YourObject::instance();
// or manually change the instance by
YourObject::instance(yourInstance);

Note

this macro would generate these reflectable ZFMethod for you, with this proto type:

YourObject *instance(void);
void instance(ZF_IN YourObject *);

Function Documentation

◆ ZFObjectGlobalInstanceAdd()

const ZFCorePointer * ZFObjectGlobalInstanceAdd	(	const ZFCorePointer &	sp,
		ZFLevel	level = ZFLevelAppNormal )

extern

add a global instance that would be auto deleted while ZFFrameworkCleanup

you must ensure the smart pointer is safe to be cleanup during the assigned level, if necessary, use ZFObjectGlobalInstanceRemove to remove manually before ZFFrameworkCleanup

ZFFramework