ZFPropertyUserRegister.h File Reference

user registered ZFProperty More...

#include "ZFMethodUserRegister.h"
#include "ZFObjectAutoPtr.h"
#include "ZFNull.h"

Go to the source code of this file.

Classes
class	ZFPropertyUserRegisterDefaultImplRetain< T_Type >
	default impl for ZFPropertyUserRegisterRetain More...
class	ZFPropertyUserRegisterDefaultImplAssign< T_Type >
	default impl for ZFPropertyUserRegisterAssign More...

Macros
#define	ZFPropertyUserRegisterRetain(resultProperty, ownerClass, Type, propertyNameString, InitValueOrEmpty, SetterAccessType, GetterAccessType)
	register a custom property to existing class, for advanced reflection use only
#define	ZFPropertyUserRegisterRetainDetail(resultProperty, ownerClass, Type, propertyNameString, InitValueOrEmpty, SetterAccessType, GetterAccessType, Func_ZFPropertySetterInvoker, Func_ZFPropertyGetterInvoker, Func_ZFPropertyCallbackIsValueAccessed, Func_ZFPropertyCallbackIsInitValue, Func_ZFPropertyCallbackValueReset)
	see ZFPropertyUserRegisterRetain
#define	ZFPROPERTY_USER_REGISTER_RETAIN(ownerClassSig, Type, propertyNameSig, InitValueOrEmpty, SetterAccessType, GetterAccessType)
	see ZFPropertyUserRegisterRetain
#define	ZFPROPERTY_USER_REGISTER_RETAIN_DETAIL(ownerClassSig, Type, propertyNameSig, InitValueOrEmpty, SetterAccessType, GetterAccessType, Func_ZFPropertySetterInvoker, Func_ZFPropertyGetterInvoker, Func_ZFPropertyCallbackIsValueAccessed, Func_ZFPropertyCallbackIsInitValue, Func_ZFPropertyCallbackValueReset)
	see ZFPropertyUserRegisterRetain
#define	ZFPropertyUserRegisterAssign(resultProperty, ownerClass, Type, propertyNameString, InitValueOrEmpty, SetterAccessType, GetterAccessType)
	see ZFPropertyUserRegisterRetain
#define	ZFPropertyUserRegisterAssignDetail(resultProperty, ownerClass, Type, propertyNameString, InitValueOrEmpty, SetterAccessType, GetterAccessType, Func_ZFPropertySetterInvoker, Func_ZFPropertyGetterInvoker, Func_ZFPropertyCallbackIsValueAccessed, Func_ZFPropertyCallbackIsInitValue, Func_ZFPropertyCallbackValueReset)
	see ZFPropertyUserRegisterRetain
#define	ZFPROPERTY_USER_REGISTER_ASSIGN(ownerClassSig, Type, propertyNameSig, InitValueOrEmpty, SetterAccessType, GetterAccessType)
	see ZFPropertyUserRegisterAssign
#define	ZFPROPERTY_USER_REGISTER_ASSIGN_DETAIL(ownerClassSig, Type, propertyNameSig, InitValueOrEmpty, SetterAccessType, GetterAccessType, Func_ZFPropertySetterInvoker, Func_ZFPropertyGetterInvoker, Func_ZFPropertyCallbackIsValueAccessed, Func_ZFPropertyCallbackIsInitValue, Func_ZFPropertyCallbackValueReset)
	see ZFPropertyUserRegisterAssign

Functions
void	ZFPropertyUserRegisterNotifyUpdate (ZFObject *ownerObject, const ZFProperty *property, const void *propertyValueOld)
	see ZFPropertyUserRegisterRetain, ZFObject::objectPropertyValueOnUpdate
void	ZFPropertyUserRegisterNotifyReset (ZFObject *ownerObject, const ZFProperty *property)
	see ZFPropertyUserRegisterRetain
void	ZFPropertyUserUnregister (const ZFProperty *zfproperty)
	see ZFPropertyUserRegisterRetain

Detailed Description

user registered ZFProperty

Macro Definition Documentation

ZFPropertyUserRegisterRetain

#define ZFPropertyUserRegisterRetain	(		resultProperty,
			ownerClass,
			Type,
			propertyNameString,
			InitValueOrEmpty,
			SetterAccessType,
			GetterAccessType )

register a custom property to existing class, for advanced reflection use only

example:

// declare each callback for ZFProperty
static void myCallbackSetterInvoker(
        ZF_IN const ZFProperty *
        , ZF_IN ZFObject *ownerObj
        , ZF_IN MyPropType const &v
        ) {
    ...
}
static MyPropType const &myCallbackGetterInvoker(
        ZF_IN const ZFProperty *property
        , ZF_IN ZFObject *ownerObj
        ) {
    ...
}
static zfbool myCallbackIsValueAccessed(
        ZF_IN const ZFProperty *
        , ZF_IN zfany const &ownerObj
        ) {
    ...
}
static zfbool myCallbackIsInitValue(
        ZF_IN const ZFProperty *property
        , ZF_IN zfany const &ownerObj
        , ZF_OUT_OPT zfauto *outInitValue
        ) {
    ...
}
static void myCallbackValueReset(
        ZF_IN const ZFProperty *property
        , ZF_IN zfany const &ownerObj
        ) {
    ...
}
 
// register it, using ZF_GLOBAL_INITIALIZER_INIT is recommended
ZF_GLOBAL_INITIALIZER_INIT(MyPropertyRegister) {
    ZFPropertyUserRegisterRetainDetail(resultProperty, MyClassToAttachTheProperty::ClassData(),
        Type, "propertyName", ZFPropertyNoInitValue,
        public, public
        , myCallbackSetterInvoker
        , myCallbackGetterInvoker
        , myCallbackIsValueAccessed
        , myCallbackIsInitValue
        , myCallbackValueReset
        );
    _property = resultProperty;
    ZFLogTrim() << resultProperty;
}
ZF_GLOBAL_INITIALIZER_DESTROY(MyPropertyRegister) {
    ZFPropertyUserUnregister(_property);
}
const ZFProperty *_property;
ZF_GLOBAL_INITIALIZER_END(MyPropertyRegister)
 
// or, you may use this macro for short, at cpp files only
ZFPROPERTY_USER_REGISTER_RETAIN_DETAIL(MyClassToAttachTheProperty, MyClassToAttachTheProperty::ClassData()
    , Type, "propertyName", ZFPropertyNoInitValue
    , public, public
    , myCallbackSetterInvoker
    , myCallbackGetterInvoker
    , myCallbackIsValueAccessed
    , myCallbackIsInitValue
    , myCallbackValueReset
    )
 
// or, if you simply want to register a raw value,
// you may use ZFPropertyUserRegisterDefaultImplRetain or ZFPropertyUserRegisterDefaultImplAssign as default impl
ZFPROPERTY_USER_REGISTER_RETAIN_DETAIL(MyClassToAttachTheProperty, MyClassToAttachTheProperty::ClassData()
    , Type, "propertyName", ZFPropertyNoInitValue
    , public, public
    , ZFPropertyUserRegisterDefaultImplRetain<Type>::setterInvoker
    , ZFPropertyUserRegisterDefaultImplRetain<Type>::getterInvoker
    , ZFPropertyUserRegisterDefaultImplRetain<Type>::callbackIsValueAccessed
    , ZFPropertyUserRegisterDefaultImplRetain<Type>::callbackIsInitValue
    , ZFPropertyUserRegisterDefaultImplRetain<Type>::callbackValueReset
    )

note:

• if there is already a property exist with same property name, register would fail
• the registered property must be unregister manually at proper time, use ZF_GLOBAL_INITIALIZER_INIT is recommeded
• when you supply custom setter or getter method, you must use ZFPropertyUserRegisterNotifyUpdate at proper time to notify ZFObject::E_ObjectPropertyValueOnUpdate
• when you supply custom value reset method, you must use ZFPropertyUserRegisterNotifyReset at proper time to notify ZFObject::E_ObjectPropertyValueOnReset
• once registered, the property can be reflected by ZFClass::propertyForName, but there's no way to access the property by object directly, it can only be accessed by ZFProperty's method