type wrapper for ZFTypeId::Value More...

#include <ZFTypeId_CoreType.h>

Inheritance diagram for v_zfstring:

Public Types
enum

Public Types inherited from ZFStyleableObject
enum

Public Types inherited from ZFObject
enum

Public Member Functions
virtual const ZFClass *	classData (void)
	get instance's class info

virtual void	objectInfoT (zfstring &ret)
	see objectInfo

virtual ZFCompareResult	objectCompare (ZFObject *anotherObj)
	compare with anotherObj

virtual void	wrappedValueOnAssign (ZFTypeIdWrapper *ref)
	see wrappedValueAssign

virtual const zfchar *	wrappedValueTypeId (void)
	type id for this wrapper type

virtual void *	wrappedValue (void)
	access the value's address

virtual void	wrappedValue (const void *v)
	set the value, no type safe check

virtual void	wrappedValueCopy (void *v)
	get the value, no type safe check

virtual void	wrappedValueReset (void)
	reset the value to it's init value

virtual zfbool	wrappedValueIsInit (void)
	true if the value is in init value state

virtual zfbool	wrappedValuePreferStringConverter (void)
	whether prefer string converter during serialization, which would result much shorter result

virtual zfbool	wrappedValueFromData (const ZFSerializableData &serializableData, zfstring outErrorHint=0, ZFSerializableData outErrorPos=0)
	convert from serializable data

virtual zfbool	wrappedValueToData (ZFSerializableData &serializableData, zfstring *outErrorHint=0)
	convert to serializable data

virtual zfbool	wrappedValueFromString (const zfchar src, zfindex srcLen=((zfindex) -1), zfstring errorHint=0)
	convert from string

virtual zfbool	wrappedValueToString (zfstring &s, zfstring *errorHint=0)
	convert to string

virtual zfbool	progressUpdate (ZFProgressable from, ZFProgressable to, zffloat progress)
	see ZFProgressable

Public Member Functions inherited from ZFTypeIdWrapper
ZFTypeIdWrapper *	wrappedValueAssign (ZFTypeIdWrapper *ref)
	copy internal value, assert fail if wrappedValueIsConst

virtual zfbool	objectIsInternal (void)
	whether this object is internal object or its class is ZFClass::classIsInternal

Public Member Functions inherited from ZFObject
zfindex	objectRetainCount (void)
	return the object's retain count

ZFObjectHolder *	objectHolder (void)
	return an object holder that hold this object without affecting retain count

virtual void	objectInfoOfInstanceT (zfstring &ret)
	see objectInfoOfInstance

virtual zfstring	objectInfoOfInstance (void)
	return a short string describe the object instance

virtual zfstring	objectInfo (void)
	return object info

virtual zfidentity	objectHash (void)
	get hash of this object

virtual zfbool	equalTo (ZFObject *anotherObj)
	util to objectCompare

virtual zfauto	invoke (const zfchar *methodName)
	util method to perform ZFDI_invoke, do nothing if fail

virtual zfauto	invoke (const zfchar methodName, ZFObject param0, ZFObject param1=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param2=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param3=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param4=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param5=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param6=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef), ZFObject param7=((ZFObject const &) _ZFP_ZFMethodGenericInvokerDefaultParamRef))
	util method to perform ZFDI_invoke, do nothing if fail

virtual zfauto	invokeDetail (const zfchar methodName, const ZFCoreArray< zfauto > &params, zfbool success=0, zfstring *errorHint=0)
	util method to perform ZFDI_invoke, do nothing if fail

zfbool	objectTagExist (void)
	see objectTag, true if this object has tag, and tag can be checked by objectTagGetAllKeyValue

void	objectTag (const zfchar key, ZFObject tag)
	used to hold a object for app's use, auto retained

zfany	objectTag (const zfchar *key)
	see objectTag

void	objectTagGetAllKeyValue (ZFCoreArray< zfstring > &allKey, ZFCoreArray< zfauto > &allValue)
	get all key value

void	objectTagRemove (const zfchar *key)
	remove tag, same as set tag to null

zfauto	objectTagRemoveAndGet (const zfchar *key)
	remove tag, return removed tag or null if not exist

void	objectTagRemoveAll (void)
	remove all tag

void	observerAdd (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify

void	observerAddForOnce (zfidentity eventId, const ZFListener &observer, ZFLevel observerLevel=ZFLevelAppNormal)
	see observerNotify

void	observerRemove (zfidentity eventId, const ZFListener &callback)
	see observerNotify

void	observerRemoveAll (zfidentity eventId)
	see observerNotify

void	observerRemoveAll (void)
	see observerNotify

zfbool	observerHasAdd (void)
	true if any observer has been added

zfbool	observerHasAdd (zfidentity eventId)
	true if any observer with eventId has been added

void	observerNotify (zfidentity eventId, ZFObject param0=0, ZFObject param1=0)
	notify the observer with eventId

void	observerNotifyWithSender (ZFObject customSender, zfidentity eventId, ZFObject param0=0, ZFObject *param1=0)
	see observerNotify

ZFObserver &	observerHolder (void)
	access the internal observer holder

ZFObjectInstanceState	objectInstanceState (void)
	object instance's state

virtual zfbool	objectIsInternalPrivate (void)
	whether this object is internal private object or its class is ZFClass::classIsInternalPrivate

ZFV	zfv (void)
	see ZFV

Public Member Functions inherited from ZFStyleable
virtual zfanyT< ZFStyleable >	defaultStyle (void)
	return default style of this instance

void	styleableCopyFrom (ZFStyleable *anotherStyleable)
	copy style from another styleable, see ZFStyleable

virtual zfbool	styleableIsDefaultStyle (void)
	true if this object is defaultStyle

void	styleKey (const zfchar *styleKey)
	see ZFStyleSet

const zfchar *	styleKey (void)
	see ZFStyleSet

void	styleKeyForProperty (const zfchar propertyName, const zfchar styleKey)
	see ZFStyleSet

const zfchar *	styleKeyForProperty (const zfchar *propertyName)
	see ZFStyleSet

void	styleKeyForProperty (const ZFProperty property, const zfchar styleKey)
	see ZFStyleSet

const zfchar *	styleKeyForProperty (const ZFProperty *property)
	see ZFStyleSet

Public Member Functions inherited from ZFInterface
virtual ZFObject *	toObject (void)=0
	convert to ZFObject type

Public Member Functions inherited from ZFSerializable
zfbool	serializable (void)
	true if object is currently serializable, see ZFSerializable

zfbool	serializeFromData (const ZFSerializableData &serializableData, zfstring outErrorHint=0, ZFSerializableData outErrorPos=0)
	serialize from data, see ZFSerializable

zfbool	serializeToData (ZFSerializableData &serializableData, zfstring outErrorHint=0, ZFSerializable referencedOwnerOrNull=0)
	serialize to data, see ZFSerializable

zfbool	serializeFromString (const zfchar src, zfindex srcLen=((zfindex) -1), zfstring errorHint=0)
	serialize from string, return false by default

zfbool	serializeToString (zfstring &ret, zfstring *errorHint=0)
	see serializeFromString

void	serializableGetAllSerializablePropertyT (ZFCoreArray< const ZFProperty * > &ret)
	see serializableGetAllSerializableProperty

ZFCoreArray< const ZFProperty * >	serializableGetAllSerializableProperty (void)
	get all serializable property, usually for debug only, see serializableOnCheckPropertyType

void	serializableGetAllSerializableEmbededPropertyT (ZFCoreArray< const ZFProperty * > &ret)
	see serializableGetAllSerializableEmbededProperty

ZFCoreArray< const ZFProperty * >	serializableGetAllSerializableEmbededProperty (void)
	get all serializable embeded property, usually for debug only, see serializableOnCheckPropertyType

virtual void	serializableInfoT (zfstring &ret)
	get info as a serializable

virtual zfstring	serializableInfo (void)
	see serializableInfoT

Public Member Functions inherited from ZFCopyable
zfautoT< ZFCopyable >	copy (void)
	return a copy of this object

void	copyFrom (ZFObject *anotherObj)
	see copy, anotherObj must be same type as this object (by classData), otherwise, do nothing

Static Public Member Functions
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFTypeIdWrapper
static const ZFClass *	ClassData (void)
	get class info

static void	markConst (ZFObject *obj)
	util to mark wrappedValueIsConst

Static Public Member Functions inherited from ZFStyleableObject
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFObject
static const ZFClass *	ClassData (void)
	get class info

static zfidentity	EventObjectBeforeAlloc (void)
	see ZFObject::observerNotify

static zfidentity	EventObjectAfterAlloc (void)
	see ZFObject::observerNotify

static zfidentity	EventObjectBeforeDealloc (void)
	see ZFObject::observerNotify

static zfidentity	EventObjectPropertyValueOnUpdate (void)
	see ZFObject::observerNotify

Static Public Member Functions inherited from ZFStyleable
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFInterface
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFSerializable
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFCopyable
static const ZFClass *	ClassData (void)
	get class info

Static Public Member Functions inherited from ZFProgressable
static const ZFClass *	ClassData (void)
	get class info

Public Attributes
_ZFP_PropTypeW_zfstring	zfv
	the value, see ZFTypeId::Value

Public Attributes inherited from ZFTypeIdWrapper
zfbool	wrappedValueIsConst
	whether the holded value should not be changed

Protected Types
typedef ZFTypeIdWrapper	zfsuper
	class ref to super

typedef v_zfstring	zfself
	class ref to self

Protected Types inherited from ZFTypeIdWrapper
typedef ZFStyleableObject	zfsuper
	class ref to super

typedef ZFTypeIdWrapper	zfself
	class ref to self

Protected Types inherited from ZFStyleableObject
typedef ZFObject	zfsuper
	class ref to super

typedef ZFStyleableObject	zfself
	class ref to self

Protected Types inherited from ZFObject
typedef _ZFP_Obj_Base	zfsuper
	class ref to super

typedef ZFObject	zfself
	class ref to self

Protected Types inherited from ZFStyleable
enum	PropertyType { PropertyTypeNotStyleable , PropertyTypeNormal , PropertyTypeStyleable , PropertyTypeCopyable }
	see ZFStyleable::styleableOnCheckPropertyType More...

typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFStyleable	zfself
	typedef for self

Protected Types inherited from ZFInterface
typedef _ZFP_ObjI_Base	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFInterface	zfself
	typedef for self

Protected Types inherited from ZFSerializable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFSerializable	zfself
	typedef for self

Protected Types inherited from ZFCopyable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFCopyable	zfself
	typedef for self

Protected Types inherited from ZFProgressable
typedef ZFInterface	zfsuper
	typedef for super (always ZFInterface for an interface type)

typedef ZFProgressable	zfself
	typedef for self

Protected Member Functions
virtual void	objectOnInit (_ZFP_PropTypeW_zfstring const &value)
	init with value

virtual void	objectOnInit (void)
	override this to init your object

Protected Member Functions inherited from ZFTypeIdWrapper
virtual void	styleableOnCopyFrom (ZFStyleable *anotherStyleable)
	for subclass to achieve custom style copy step, called by styleableCopyFrom, see ZFStyleable

virtual zfbool	serializableOnSerializeFromData (const ZFSerializableData &serializableData, zfstring outErrorHint=0, ZFSerializableData outErrorPos=0)
	for serializable data that has "category" attribute, ZFSerializable would ignore it and leave it to subclass to resolve, see ZFSerializable

virtual zfbool	serializableOnSerializeToData (ZFSerializableData &serializableData, ZFSerializable referencedOwnerOrNull, zfstring outErrorHint=0)
	corresponding to serializableOnSerializeFromData, return whether the task is success, see ZFSerializable

virtual zfbool	serializableOnSerializeFromString (const zfchar src, zfindex srcLen=((zfindex) -1), zfstring errorHint=0)
	see serializeFromString

virtual zfbool	serializableOnSerializeToString (zfstring &ret, zfstring *errorHint=0)
	see serializeFromString

Protected Member Functions inherited from ZFStyleableObject
virtual void	copyableOnCopyFrom (ZFObject *anotherObj)
	called by copy to copy contents from anotherObj

Protected Member Functions inherited from ZFObject
virtual void	objectInfoOnAppend (zfstring &ret)
	called by objectInfoT to append object info as a chain

virtual void	observerOnAdd (zfidentity eventId)
	called when add first observer

virtual void	observerOnRemove (zfidentity eventId)
	called when remove last observer

virtual void	observerOnEvent (const ZFArgs &zfargs)
	notified when observerNotify

virtual void	objectOnInitFinish (void)
	called after objectOnInit, safe to call virtual functions here

virtual void	objectOnDeallocPrepare (void)
	called before objectOnDealloc, safe to call virtual functions here

virtual void	objectOnDealloc (void)
	override this to destroy your object

virtual void	objectOnRetain (void)
	called to retain object

virtual void	objectOnRelease (void)
	called to release object

virtual void	objectPropertyValueOnUpdate (const ZFProperty property, const void oldValue)
	see EventObjectPropertyValueOnUpdate

Protected Member Functions inherited from ZFStyleable
virtual ZFStyleable::PropertyType	styleableOnCheckPropertyType (const ZFProperty *property)
	check property type

virtual void	styleableOnCopyPropertyFrom (ZFStyleable anotherStyleable, const ZFProperty property, ZFStyleable::PropertyType propertyType)
	copy property with styleable logic

Protected Member Functions inherited from ZFSerializable
virtual ZFSerializablePropertyType	serializableOnCheckPropertyType (const ZFProperty *property)
	check the property type that serializable should do what while serializing

virtual zfbool	serializableOnCheck (void)
	see serializable

virtual zfbool	serializableOnSerializePropertyFromData (const ZFSerializableData &propertyData, const ZFProperty property, zfstring outErrorHint=0, ZFSerializableData *outErrorPos=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializePropertyToData (ZFSerializableData &ownerData, const ZFProperty property, ZFSerializable referencedOwnerOrNull, zfstring *outErrorHint=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializeEmbededPropertyFromData (const ZFSerializableData &propertyData, const ZFProperty property, zfstring outErrorHint=0, ZFSerializableData *outErrorPos=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

virtual zfbool	serializableOnSerializeEmbededPropertyToData (ZFSerializableData &ownerData, const ZFProperty property, ZFSerializable referencedOwnerOrNull, zfstring *outErrorHint=0)
	see serializableOnCheckPropertyType, usually you have no need to override this method, see ZFSerializable

Detailed Description

type wrapper for ZFTypeId::Value

Member Function Documentation

◆ classData()

virtual const ZFClass * v_zfstring::classData ( void )

inlinevirtual

get instance's class info

Reimplemented from ZFTypeIdWrapper.

Reimplemented in v_cString.

◆ objectOnInit()

virtual void v_zfstring::objectOnInit ( void )

inlineprotectedvirtual

override this to init your object

subclass must call superclass's objectOnInit before any other code if override
you may also declare objectOnInit with params like this:

zfclass Parent : ... {
    ...
protected:
    virtual void objectOnInit(void) {...};
};
zfclass Child : Parent {
protected:
    // override all parent's objectOnInit is also required,
    // because of function hiding of C++
    zfoverride
    virtual void objectOnInit(void) {
        zfsuper::objectOnInit();
    }
    // custom init entry
    virtual void objectOnInit(Params...) {
        this->objectOnInit();
        // your extra init steps
        ...
    }
};

Warning: objectOnInit and objectOnDealloc is called as a virtual function, take good care of other virtual function call, use zfself::func() instead of this->func() if necessary, or use objectOnInitFinish/objectOnDeallocPrepare, or declare your own constructor with ZFOBJECT_DECLARE_WITH_CUSTOM_CTOR

Note: (ZFTAG_LIMITATION) due to limitations of C++, if your parent type declared objectOnInit with different params, and your child type want to override part of those objectOnInit, then your child type must also override all objectOnInit that parent declared, otherwise, some may be hidden; for objects that designed not to be allocated by user, you should use ZFOBJECT_PRIVATE_ALLOC, typically usage:
zfclass MyObject : zfextend ZFObject {

ZFOBJECT_DECLARE(MyObject, ZFObject)

ZFOBJECT_PRIVATE_ALLOC("should be created by MyObject::instanceForXxx only")

public:

static zfauto instanceForXxx(xxx) {

// can only be allocated by reflection

return zfself::ClassData()->newInstance();

}

};

static void func(void) {

// MyObject *obj = zfAlloc(MyObject); // would compile error

zfauto obj = MyObject::instanceForXxx(xxx); // OK

}

zfextend
#define zfextend
dummy macro shows class inherit from another
Definition ZFCoreTypeDef_ClassType.h:53

ZFOBJECT_DECLARE
#define ZFOBJECT_DECLARE(ChildClass, SuperClass,...)
necessary for every class inherit from ZFObject
Definition ZFObjectDeclare.h:126

ZFOBJECT_PRIVATE_ALLOC
#define ZFOBJECT_PRIVATE_ALLOC(...)
mark this object can not be allocated directly
Definition ZFObjectDeclare.h:240

ZFClass::newInstance
zfauto newInstance(void) const
make a new instance of ZFObject dynamically, which is described by ZFClass

ZFObject
base class of all objects
Definition ZFObjectCore.h:209

v_zfstring::ClassData
static const ZFClass * ClassData(void)
get class info
Definition ZFTypeId_CoreType.h:171

zfauto
a ZFObject holder which would release content object automatically when destroyed
Definition zfautoFwd.h:34

Reimplemented from ZFObject.

◆ objectInfoT()

virtual void v_zfstring::objectInfoT ( zfstring & ret )

virtual

see objectInfo

Reimplemented from ZFObject.

◆ objectCompare()

virtual ZFCompareResult v_zfstring::objectCompare ( ZFObject * anotherObj )

virtual

compare with anotherObj

Returns: ZFCompareTheSame if this == anotherObj
ZFCompareUncomparable otherwise

Warning: if your override objectCompare, you must also override objectHash, and follow the rules described in objectHash

Reimplemented from ZFObject.

◆ wrappedValueOnAssign()

virtual void v_zfstring::wrappedValueOnAssign ( ZFTypeIdWrapper * ref )

virtual

see wrappedValueAssign

Implements ZFTypeIdWrapper.

◆ wrappedValueTypeId()

virtual const zfchar * v_zfstring::wrappedValueTypeId ( void )

virtual

type id for this wrapper type

Implements ZFTypeIdWrapper.

◆ wrappedValue() [1/2]

virtual void * v_zfstring::wrappedValue ( void )

inlinevirtual

access the value's address

Implements ZFTypeIdWrapper.

◆ wrappedValue() [2/2]

virtual void v_zfstring::wrappedValue ( const void * v )

inlinevirtual

set the value, no type safe check

Implements ZFTypeIdWrapper.

◆ wrappedValueCopy()

virtual void v_zfstring::wrappedValueCopy ( void * v )

inlinevirtual

get the value, no type safe check

Implements ZFTypeIdWrapper.

◆ wrappedValueReset()

virtual void v_zfstring::wrappedValueReset ( void )

inlinevirtual

reset the value to it's init value

Implements ZFTypeIdWrapper.

◆ wrappedValueIsInit()

virtual zfbool v_zfstring::wrappedValueIsInit ( void )

virtual

true if the value is in init value state

Implements ZFTypeIdWrapper.

◆ wrappedValuePreferStringConverter()

virtual zfbool v_zfstring::wrappedValuePreferStringConverter ( void )

virtual

whether prefer string converter during serialization, which would result much shorter result

// default complex serializable data:
<Owner>
    <TypeId prop="PropertyName" value="xxx"/>
</Owner>
 
// if prefer string converter
<Owner PropertyName="xxx" />

Reimplemented from ZFTypeIdWrapper.

◆ wrappedValueFromData()

virtual zfbool v_zfstring::wrappedValueFromData	(	const ZFSerializableData &	serializableData,
		zfstring *	outErrorHint = 0,
		ZFSerializableData *	outErrorPos = 0 )

virtual

convert from serializable data

Implements ZFTypeIdWrapper.

◆ wrappedValueToData()

virtual zfbool v_zfstring::wrappedValueToData	(	ZFSerializableData &	serializableData,
		zfstring *	outErrorHint = 0 )

virtual

convert to serializable data

Implements ZFTypeIdWrapper.

◆ wrappedValueFromString()

virtual zfbool v_zfstring::wrappedValueFromString	(	const zfchar *	src,
		zfindex	srcLen = ((zfindex) -1),
		zfstring *	errorHint = 0 )

virtual

convert from string

Implements ZFTypeIdWrapper.

◆ wrappedValueToString()

virtual zfbool v_zfstring::wrappedValueToString	(	zfstring &	s,
		zfstring *	errorHint = 0 )

virtual

convert to string

Implements ZFTypeIdWrapper.

◆ progressUpdate()

virtual zfbool v_zfstring::progressUpdate	(	ZFProgressable *	from,
		ZFProgressable *	to,
		zffloat	progress )

inlinevirtual

see ZFProgressable

Reimplemented from ZFTypeIdWrapper.

The documentation for this class was generated from the following file:

ZFTypeId_CoreType.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Detailed Description

Member Function Documentation

◆ classData()

◆ objectOnInit()

◆ objectInfoT()

◆ objectCompare()

◆ wrappedValueOnAssign()

◆ wrappedValueTypeId()

◆ wrappedValue() [1/2]

◆ wrappedValue() [2/2]

◆ wrappedValueCopy()

◆ wrappedValueReset()

◆ wrappedValueIsInit()

◆ wrappedValuePreferStringConverter()

◆ wrappedValueFromData()

◆ wrappedValueToData()

◆ wrappedValueFromString()

◆ wrappedValueToString()

◆ progressUpdate()