ZFSerializable.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFSerializable_h_
#define _ZFI_ZFSerializable_h_
 
#include "ZFObjectCore.h"
#include "ZFIOCallback.h"
ZF_NAMESPACE_GLOBAL_BEGIN

#define ZFSerializableKeyword_styleKey "styleKey"

#define ZFSerializableKeyword_serializableNewInstanceId serializableNewInstance
#define ZFSerializableKeyword_serializableNewInstance ZFM_TOSTRING(ZFSerializableKeyword_serializableNewInstanceId)
 
// ============================================================
typedef enum {
    ZFSerializablePropertyTypeUnspecified,
    ZFSerializablePropertyTypeNotSerializable,
    ZFSerializablePropertyTypeSerializable,
    ZFSerializablePropertyTypeEmbeded,
} ZFSerializablePropertyType;

#define ZFTOKEN_ZFSerializablePropertyTypeUnspecified "Unspecified"
#define ZFTOKEN_ZFSerializablePropertyTypeNotSerializable "NotSerializable"
#define ZFTOKEN_ZFSerializablePropertyTypeSerializable "Serializable"
#define ZFTOKEN_ZFSerializablePropertyTypeEmbeded "Embeded"
 
// ============================================================
zfclassFwd _ZFP_I_ZFSerializablePropertyTypeHolder;
zfinterface ZFLIB_ZFCore ZFSerializable : zfextend ZFInterface {
    ZFINTERFACE_DECLARE(ZFSerializable, ZFInterface)
 
    // ============================================================
public:
    zffinal zfbool serializable(void);
    zffinal zfbool serializeFromData(
            ZF_IN const ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            );
    zffinal zfbool serializeToData(
            ZF_OUT ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_IN_OPT ZFSerializable *refOwner = zfnull
            );

    zffinal zfbool serializeFromString(
            ZF_IN const zfchar *src
            , ZF_IN_OPT zfindex srcLen = zfindexMax()
            , ZF_OUT_OPT zfstring *errorHint = zfnull
            );
    zffinal zfbool serializeToString(
            ZF_IN_OUT zfstring &ret
            , ZF_OUT_OPT zfstring *errorHint = zfnull
            );

    zffinal void serializablePropertyTypeGetAll(
            ZF_OUT ZFCoreArray<const ZFProperty *> &notSerializableProperty
            , ZF_OUT ZFCoreArray<const ZFProperty *> &serializableProperty
            , ZF_OUT ZFCoreArray<const ZFProperty *> &embededProperty
            );
    zffinal zfstring serializablePropertyTypeInfo(void);
 
private:
    zffinal _ZFP_I_ZFSerializablePropertyTypeHolder *_ZFP_ZFSerializable_getPropertyTypeHolder(void);
public:
    zffinal void serializableGetAllSerializablePropertyT(ZF_IN_OUT ZFCoreArray<const ZFProperty *> &ret);
    inline ZFCoreArray<const ZFProperty *> serializableGetAllSerializableProperty(void) {
        ZFCoreArray<const ZFProperty *> ret;
        this->serializableGetAllSerializablePropertyT(ret);
        return ret;
    }

    zffinal void serializableGetAllSerializableEmbededPropertyT(ZF_IN_OUT ZFCoreArray<const ZFProperty *> &ret);
    inline ZFCoreArray<const ZFProperty *> serializableGetAllSerializableEmbededProperty(void) {
        ZFCoreArray<const ZFProperty *> ret;
        this->serializableGetAllSerializableEmbededPropertyT(ret);
        return ret;
    }
 
protected:
    virtual ZFSerializablePropertyType serializableOnCheckPropertyType(ZF_IN const ZFProperty *property);
 
protected:
    virtual zfbool serializableOnCheck(void) {
        return zftrue;
    }

    virtual inline zfbool serializableOnSerializeFromData(
            ZF_IN const ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            ) {
        return zftrue;
    }

    virtual inline zfbool serializableOnSerializeToData(
            ZF_IN_OUT ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_IN_OPT ZFSerializable *refOwner = zfnull
            ) {
        return zftrue;
    }

    virtual zfbool serializableOnSerializePropertyFromData(
            ZF_IN const ZFSerializableData &propertyData
            , ZF_IN const ZFProperty *property
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            );
    virtual zfbool serializableOnSerializePropertyToData(
            ZF_OUT ZFSerializableData &ownerData
            , ZF_IN const ZFProperty *property
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_IN_OPT ZFSerializable *refOwner = zfnull
            );
    virtual zfbool serializableOnSerializeEmbededPropertyFromData(
            ZF_IN const ZFSerializableData &propertyData
            , ZF_IN const ZFProperty *property
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            );
    virtual zfbool serializableOnSerializeEmbededPropertyToData(
            ZF_OUT ZFSerializableData &ownerData
            , ZF_IN const ZFProperty *property
            , ZF_IN ZFSerializable *refOwner
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            );
 
protected:
    virtual zfbool serializableOnSerializeFromString(
            ZF_IN const zfchar *src
            , ZF_IN_OPT zfindex srcLen = zfindexMax()
            , ZF_OUT_OPT zfstring *errorHint = zfnull
            ) {
        return zffalse;
    }

    virtual zfbool serializableOnSerializeToString(
            ZF_IN_OUT zfstring &ret
            , ZF_OUT_OPT zfstring *errorHint = zfnull
            ) {
        return zffalse;
    }
 
public:
    virtual void serializableInfoT(ZF_IN_OUT zfstring &ret);
    virtual inline zfstring serializableInfo(void) {
        zfstring ret;
        this->serializableInfoT(ret);
        return ret;
    }
};
 
// ============================================================
extern ZFLIB_ZFCore zfbool ZFObjectIsSerializable(ZF_IN ZFObject *obj);
 
// ============================================================
extern ZFLIB_ZFCore zfbool ZFObjectFromDataT(
        ZF_OUT zfauto &result
        , ZF_IN const ZFSerializableData &serializableData
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );
extern ZFLIB_ZFCore zfauto ZFObjectFromData(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );
extern ZFLIB_ZFCore zfbool ZFObjectToDataT(
        ZF_OUT ZFSerializableData &serializableData
        , ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_IN_OPT ZFSerializable *refOwner = zfnull
        );
extern ZFLIB_ZFCore ZFSerializableData ZFObjectToData(
        ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfbool *outSuccess = zfnull
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_IN_OPT ZFSerializable *refOwner = zfnull
        );
 
// ============================================================
extern ZFLIB_ZFCore zfbool ZFObjectFromStringT(
        ZF_OUT zfauto &result
        , ZF_IN const ZFClass *cls
        , ZF_IN const zfchar *src
        , ZF_IN_OPT zfindex srcLen = zfindexMax()
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        );
inline zfauto ZFObjectFromString(
        ZF_IN const ZFClass *cls
        , ZF_IN const zfchar *src
        , ZF_IN_OPT zfindex srcLen = zfindexMax()
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        ) {
    zfauto ret;
    ZFObjectFromStringT(ret, cls, src, srcLen, errorHint);
    return ret;
}

extern ZFLIB_ZFCore zfbool ZFObjectToStringT(
        ZF_IN_OUT zfstring &ret
        , ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        );
inline zfstring ZFObjectToString(
        ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        ) {
    zfstring ret;
    ZFObjectToStringT(ret, obj, errorHint);
    return ret;
}
 
// ============================================================
extern ZFLIB_ZFCore zfbool ZFObjectFromStringOrDataT(
        ZF_OUT zfauto &result
        , ZF_IN const ZFClass *cls
        , ZF_IN const zfchar *src
        , ZF_IN_OPT zfindex srcLen = zfindexMax()
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        );
inline zfauto ZFObjectFromStringOrData(
        ZF_IN const ZFClass *cls
        , ZF_IN const zfchar *src
        , ZF_IN_OPT zfindex srcLen = zfindexMax()
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        ) {
    zfauto ret;
    ZFObjectFromStringOrDataT(ret, cls, src, srcLen, errorHint);
    return ret;
}

extern ZFLIB_ZFCore zfbool ZFObjectToStringOrDataT(
        ZF_IN_OUT zfstring &ret
        , ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        );
inline zfstring ZFObjectToStringOrData(
        ZF_IN ZFObject *obj
        , ZF_OUT_OPT zfstring *errorHint = zfnull
        ) {
    zfstring ret;
    ZFObjectToStringOrDataT(ret, obj, errorHint);
    return ret;
}
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFSerializable_h_