ZFSerializableData.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFSerializableData_h_
#define _ZFI_ZFSerializableData_h_
 
#include "zfany.h"
#include "zfautoFwd.h"
#include "ZFPathInfo.h"
ZF_NAMESPACE_GLOBAL_BEGIN

extern ZFLIB_ZFCore zfbool ZFSerializableDataResolveCheckEnable;

#define ZFSerializableKeyword_node "node"
#define ZFSerializableKeyword_prop "prop"
#define ZFSerializableKeyword_value "value"
#define ZFSerializableKeyword_category "category"
#define ZFSerializableKeyword_null "null"
 
// ============================================================
zfclassFwd ZFSerializable;
zfclassFwd _ZFP_ZFSerializableDataPrivate;
zffinal zfclassLikePOD ZFLIB_ZFCore ZFSerializableData {
public:
    explicit ZFSerializableData(ZF_IN _ZFP_ZFSerializableDataPrivate *d);
    ZFSerializableData(void);
    ZFSerializableData(ZF_IN const ZFSerializableData &ref);
    ZFSerializableData(ZF_IN const zfnullT &dummy);
    ZFSerializableData &operator = (ZF_IN const zfnullT &dummy);
    ZFSerializableData &operator = (ZF_IN const ZFSerializableData &ref);
    zfbool operator == (ZF_IN const ZFSerializableData &ref) const;
    inline zfbool operator != (ZF_IN const ZFSerializableData &ref) const {return !this->operator == (ref);}
    inline zfbool operator == (ZF_IN const zfnullT &dummy) const {return !this->valid();}
    inline zfbool operator != (ZF_IN const zfnullT &dummy) const {return this->valid();}
    inline operator bool (void) const {return this->valid();}
    ~ZFSerializableData(void);
 
public:
    zffinal void copyFrom(ZF_IN const ZFSerializableData &ref);
    inline ZFSerializableData copy(void) const {
        ZFSerializableData ret;
        ret.copyFrom(*this);
        return ret;
    }

    zffinal zfindex objectRetainCount(void) const;
 
    // ============================================================
    // local path logic
public:
    zffinal ZFPathInfo pathInfo(void) const;
    zffinal void pathInfo(ZF_IN const ZFPathInfo &pathInfo);
    zffinal ZFPathInfo pathInfoCheck(void) const;
 
    // ============================================================
    // parent
public:
    zffinal zfbool serializableDataParent(ZF_OUT ZFSerializableData &ret) const;
 
    // ============================================================
    // class
public:
    zffinal void itemClass(ZF_IN const zfstring &classNameFull);
    zffinal const zfstring &itemClass(void) const;
 
    // ============================================================
    // other types
public:
    inline void propertyName(ZF_IN const zfstring &name) {
        this->attr(ZFSerializableKeyword_prop, name);
    }

    inline zfstring propertyName(void) const {
        return this->attr(ZFSerializableKeyword_prop);
    }

    inline void propertyValue(ZF_IN const zfstring &value) {
        this->attr(ZFSerializableKeyword_value, value);
    }

    inline zfstring propertyValue(void) const {
        return this->attr(ZFSerializableKeyword_value);
    }

    inline void category(ZF_IN const zfstring &category) {
        this->attr(ZFSerializableKeyword_category, category);
    }

    inline zfstring category(void) const {
        return this->attr(ZFSerializableKeyword_category);
    }
 
    // ============================================================
public:
    zffinal void removeAll(void);
 
    // ============================================================
public:
    zffinal void serializableDataTag(
            ZF_IN const zfstring &key
            , ZF_IN ZFObject *tag
            );
    zffinal zfany serializableDataTag(ZF_IN const zfstring &key) const;
    zffinal void serializableDataTagGetAllKeyValue(
            ZF_IN_OUT ZFCoreArray<zfstring> &allKey
            , ZF_IN_OUT ZFCoreArray<zfauto> &allValue
            ) const;
    zffinal void serializableDataTagRemove(ZF_IN const zfstring &key);
    zffinal zfauto serializableDataTagRemoveAndGet(ZF_IN const zfstring &key);
    zffinal void serializableDataTagRemoveAll(void);
 
    // ============================================================
    // attribute
public:
    zffinal void attr(
            ZF_IN const zfstring &name
            , ZF_IN const zfstring &value
            );
    zffinal zfstring attr(ZF_IN const zfstring &name) const;

    zffinal zfindex attrCount(void) const;

    zffinal void attrRemove(ZF_IN const zfstring &name);

    zffinal void attrRemoveAll(void);

    zffinal zfiter attrIterFind(ZF_IN const zfstring &name) const;
    zffinal zfiter attrIter(void) const;
    zffinal zfstring attrIterKey(ZF_IN const zfiter &it) const;
    zffinal zfstring attrIterValue(ZF_IN const zfiter &it) const;

    zffinal void attrIterValue(
            ZF_IN_OUT zfiter &it
            , ZF_IN const zfstring &value
            );
    zffinal void attrIterRemove(ZF_IN_OUT zfiter &it);

    zffinal zfbool attrIterResolved(ZF_IN const zfiter &it) const;
    zffinal void attrIterResolveMark(ZF_IN const zfiter &it) const;
    zffinal void attrIterResolveUnmark(ZF_IN const zfiter &it) const;
 
    // ============================================================
    // element
public:
    zffinal void child(ZF_IN const ZFSerializableData &element);
    zffinal void child(
            ZF_IN const ZFSerializableData &element
            , ZF_IN zfindex atIndex
            );

    zffinal void childReplace(
            ZF_IN zfindex index
            , ZF_IN const ZFSerializableData &element
            );

    zffinal zfindex childForName(ZF_IN const zfstring &name) const;
    zffinal zfindex childForCategory(ZF_IN const zfstring &name) const;

    zffinal zfindex childCount(void) const;
    zffinal const ZFSerializableData &childAt(ZF_IN zfindex index) const;
    zffinal ZFSerializableData &childAt(ZF_IN zfindex index);

    zffinal void childRemoveAt(ZF_IN zfindex index);
    zffinal void childRemoveAll(void);
 
    // ============================================================
    // resolved state
public:
    zffinal zfbool resolved(void) const;
    zffinal void resolveMark(void) const;
    zffinal void resolveUnmark(void) const;

    zffinal zfbool resolvedAttr(ZF_IN const zfstring &name) const;
    zffinal void resolveAttrMark(ZF_IN const zfstring &name) const;
    zffinal void resolveAttrUnmark(ZF_IN const zfstring &name) const;

    zffinal zfbool resolvedPropertyName(void) const {
        return this->resolvedAttr(ZFSerializableKeyword_prop);
    }

    zffinal void resolvePropertyNameMark(void) const {
        this->resolveAttrMark(ZFSerializableKeyword_prop);
    }

    zffinal void resolvePropertyNameUnmark(void) const {
        this->resolveAttrUnmark(ZFSerializableKeyword_prop);
    }

    zffinal zfbool resolvedPropertyValue(void) const {
        return this->resolvedAttr(ZFSerializableKeyword_value);
    }

    zffinal void resolvePropertyValueMark(void) const {
        this->resolveAttrMark(ZFSerializableKeyword_value);
    }

    zffinal void resolvePropertyValueUnmark(void) const {
        this->resolveAttrUnmark(ZFSerializableKeyword_value);
    }

    zffinal zfbool resolvedCategory(void) const {
        return this->resolvedAttr(ZFSerializableKeyword_category);
    }

    zffinal void resolveCategoryMark(void) const {
        this->resolveAttrMark(ZFSerializableKeyword_category);
    }

    zffinal void resolveCategoryUnmark(void) const {
        this->resolveAttrUnmark(ZFSerializableKeyword_category);
    }

    zffinal zfbool resolvedAll(
            ZF_OUT_OPT ZFSerializableData *firstNotResolvedElement = zfnull
            , ZF_OUT_OPT zfstring *firstNotResolvedAttr = zfnull
            ) const;
    zffinal void resolveMarkAll(void) const;
    zffinal void resolveUnmarkAll(void) const;
    zffinal void resolveAttrMarkAll(void) const;
    zffinal void resolveAttrUnmarkAll(void) const;
 
    // ============================================================
    // other functions
public:
    zffinal void objectInfoT(ZF_IN_OUT zfstring &ret) const;
    zffinal zfstring objectInfo(void) const {
        zfstring ret;
        this->objectInfoT(ret);
        return ret;
    }

    zffinal ZFCompareResult objectCompare(ZF_IN const ZFSerializableData &another) const {
        return d == another.d ? ZFCompareEqual : ZFCompareUncomparable;
    }

    zffinal ZFCompareResult objectCompareValue(ZF_IN const ZFSerializableData &another) const;
 
public:
    inline zfbool valid(void) const {return d;}
 
private:
    _ZFP_ZFSerializableDataPrivate *d;
    friend zfclassFwd _ZFP_ZFSerializableDataPrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFSerializableData_h_