ZFSerializableUtil.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFSerializableUtil_h_
#define _ZFI_ZFSerializableUtil_h_
 
#include "ZFSerializable.h"
#include "ZFOutputDefault.h"
ZF_NAMESPACE_GLOBAL_BEGIN
ZF_NAMESPACE_BEGIN_REGISTER(ZFSerializableUtil, ZF_NAMESPACE_GLOBAL)
 

#define ZFSerializableUtilErrorOccurredAt(outErrorHint, outErrorPos, errorPos, fmt, ...) \
        ZFSerializableUtil::_ZFP_errorOccurredAt(outErrorHint, outErrorPos, errorPos, zfstr(fmt, ##__VA_ARGS__))

#define ZFSerializableUtilErrorOccurred(outErrorHint, fmt, ...) \
        ZFSerializableUtil::_ZFP_errorOccurred(outErrorHint, zfstr(fmt, ##__VA_ARGS__))
 
extern ZFLIB_ZFCore void _ZFP_errorOccurredAt(
        ZF_OUT_OPT zfstring *outErrorHint
        , ZF_OUT_OPT ZFSerializableData *outErrorPos
        , ZF_IN const ZFSerializableData &errorPos
        , ZF_IN const zfstring &text
        );
extern ZFLIB_ZFCore void _ZFP_errorOccurred(
        ZF_OUT_OPT zfstring *outErrorHint
        , ZF_IN const zfstring &text
        );

extern ZFLIB_ZFCore zfstring checkItemClass(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredClass
        );
extern ZFLIB_ZFCore zfstring requireItemClass(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredClass
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );

extern ZFLIB_ZFCore zfstring checkAttr(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredAttr
        );
extern ZFLIB_ZFCore zfstring requireAttr(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredAttr
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );

extern ZFLIB_ZFCore ZFSerializableData checkElementByName(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredElementName
        );
extern ZFLIB_ZFCore ZFSerializableData requireElementByName(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredElementName
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );

extern ZFLIB_ZFCore ZFSerializableData checkElementByCategory(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredElementCategory
        );
extern ZFLIB_ZFCore ZFSerializableData requireElementByCategory(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN const zfstring &desiredElementCategory
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        );

inline zfstring checkPropertyName(ZF_IN const ZFSerializableData &serializableData) {
    return ZFSerializableUtil::checkAttr(serializableData, ZFSerializableKeyword_prop);
}

inline zfstring requirePropertyName(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        ) {
    return ZFSerializableUtil::requireAttr(serializableData, ZFSerializableKeyword_prop, outErrorHint, outErrorPos);
}

inline zfstring checkPropertyValue(ZF_IN const ZFSerializableData &serializableData) {
    return ZFSerializableUtil::checkAttr(serializableData, ZFSerializableKeyword_value);
}

inline zfstring requirePropertyValue(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        ) {
    return ZFSerializableUtil::requireAttr(serializableData, ZFSerializableKeyword_value, outErrorHint, outErrorPos);
}

inline zfstring checkCategory(ZF_IN const ZFSerializableData &serializableData) {
    return ZFSerializableUtil::checkAttr(serializableData, ZFSerializableKeyword_category);
}

inline zfstring requireCategory(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_OUT_OPT zfstring *outErrorHint = zfnull
        , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
        ) {
    return ZFSerializableUtil::requireAttr(serializableData, ZFSerializableKeyword_category, outErrorHint, outErrorPos);
}

extern ZFLIB_ZFCore zfbool printResolveStatus(
        ZF_IN const ZFSerializableData &serializableData
        , ZF_IN_OPT const ZFOutput &outputCallback = ZFOutputDefault()
        );
 
// ============================================================
// util macro for impl
#define _ZFP_ZFSerializableUtilSerializeFromData_check(outErrorHint, outErrorPos)
#define _ZFP_ZFSerializableUtilSerializeFromData_require(outErrorHint, outErrorPos) , outErrorHint, outErrorPos
#define _ZFP_ZFSerializableUtilSerializeFromData_(check_or_require, outErrorHint, outErrorPos) \
    _ZFP_ZFSerializableUtilSerializeFromData_##check_or_require(outErrorHint, outErrorPos)
#define _ZFP_ZFSerializableUtilSerializeFromData(check_or_require, outErrorHint, outErrorPos) \
    _ZFP_ZFSerializableUtilSerializeFromData_(check_or_require, outErrorHint, outErrorPos)

#define ZFSerializableUtilSerializeAttrFromData(serializableData, outErrorHint, outErrorPos, \
    check_or_require, key, TypeName, value, failAction) \
    do { \
        zfstring valueString = ZFSerializableUtil::check_or_require##Attr(serializableData, key \
            _ZFP_ZFSerializableUtilSerializeFromData(check_or_require, outErrorHint, outErrorPos)); \
        if(valueString != zfnull) { \
            if(!TypeName##FromStringT(value, valueString)) { \
                ZFSerializableUtilErrorOccurredAt(outErrorHint, outErrorPos, serializableData, \
                    "failed to convert from \"%s\"", valueString); \
                failAction \
            } \
        } \
    } while(zffalse)
#define ZFSerializableUtilSerializeAttrToData(serializableData, outErrorHint, ref, \
    key, TypeName, thisValue, refData, defaultValue, failAction) \
    do { \
        if((ref == zfnull && ZFComparerDefault(thisValue, defaultValue) != ZFCompareEqual) \
                || (ref != zfnull && ZFComparerDefault(thisValue, refData) != ZFCompareEqual) \
                ) { \
            zfstring valueString; \
            if(!TypeName##ToStringT(valueString, thisValue)) { \
                ZFSerializableUtilErrorOccurred(outErrorHint, \
                    "failed to convert %s to string", key); \
                failAction \
            } \
            else { \
                serializableData.attr(key, valueString); \
            } \
        } \
    } while(zffalse)
#define ZFSerializableUtilSerializeAttrToDataNoRef(serializableData, outErrorHint, \
    key, TypeName, thisValue, defaultValue, failAction) \
    do { \
        if(ZFComparerDefault(thisValue, defaultValue) != ZFCompareEqual) { \
            zfstring valueString; \
            if(!TypeName##ToStringT(valueString, thisValue)) { \
                ZFSerializableUtilErrorOccurred(outErrorHint, \
                    "failed to convert %s to string", key); \
                failAction \
            } \
            else { \
                serializableData.attr(key, valueString); \
            } \
        } \
    } while(zffalse)
 
// ============================================================
#define ZFSerializableUtilSerializeCategoryFromData(serializableData, outErrorHint, outErrorPos, \
    check_or_require, key, TypeName, value, failAction) \
    do { \
        ZFSerializableData valueData = ZFSerializableUtil::check_or_require##ElementByCategory(serializableData, key \
            _ZFP_ZFSerializableUtilSerializeFromData(check_or_require, outErrorHint, outErrorPos)); \
        if(valueData != zfnull) { \
            if(!TypeName##FromDataT(value, valueData, outErrorHint, outErrorPos)) { \
                failAction \
            } \
        } \
    } while(zffalse)
#define ZFSerializableUtilSerializeCategoryToData(serializableData, outErrorHint, ref, \
    key, TypeName, thisValue, refData, defaultValue, failAction) \
    do { \
        if((ref == zfnull && ZFComparerDefault(thisValue, defaultValue) != ZFCompareEqual) \
                || (ref != zfnull && ZFComparerDefault(thisValue, refData) != ZFCompareEqual) \
                ) { \
            ZFSerializableData categoryData; \
            if(!TypeName##ToDataT(categoryData, thisValue, outErrorHint)) { \
                failAction \
            } \
            else { \
                categoryData.category(key); \
                serializableData.child(categoryData); \
            } \
        } \
    } while(zffalse)
#define ZFSerializableUtilSerializeCategoryToDataNoRef(serializableData, outErrorHint, \
    key, TypeName, thisValue, defaultValue, failAction) \
    do { \
        if(ZFComparerDefault(thisValue, defaultValue) != ZFCompareEqual) { \
            ZFSerializableData categoryData; \
            if(!TypeName##ToDataT(categoryData, thisValue, outErrorHint)) { \
                failAction \
            } \
            else { \
                categoryData.category(key); \
                serializableData.child(categoryData); \
            } \
        } \
    } while(zffalse)
 
ZF_NAMESPACE_END(ZFSerializableUtil)
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFSerializableUtil_h_