serializer.h

[詳解]

//############################################################################
/*!
    @brief      TheolizerライブラリのAPI部
    @details    下記Theolizer(Theolizer Serializer)のAPI定義<br>
                　　標準派生Serializer<br>
                　　標準Serializableクラス<br>
    @ingroup    TheolizerLib
    @file       serializer.h
    @author     Yoshinori Tahara
    @date       2016/03/21 Created
*/
/*
    © 2016 Theoride Technology (http://theolizer.com/) All Rights Reserved.
    "Theolizer" is a registered trademark of Theoride Technology.

    "Theolizer" License
        In the case where you are in possession of a valid “Theolizer” License,
        you may use this file in accordance with the terms and conditions of 
        the use license determined by Theoride Technology.

    General Public License Version 3 ("GPLv3")
        You may use this file in accordance with the terms and conditions of 
        GPLv3 published by Free Software Foundation.
        Please confirm the contents of GPLv3 at https://www.gnu.org/licenses/gpl.txt .
        A copy of GPLv3 is also saved in a LICENSE.TXT file.

    商用ライセンス
        あなたが有効なTheolizer商用ライセンスを保持している場合、
        セオライド テクノロジーの定める使用許諾書の条件に従って、
        このファイルを取り扱うことができます。

    General Public License Version 3(以下GPLv3)
        Free Software Foundationが公表するGPLv3の使用条件に従って、
        あなたはこのファイルを取り扱うことができます。
        GPLv3の内容を https://www.gnu.org/licenses/gpl.txt にて確認して下さい。
        またGPLv3のコピーをLICENSE.TXTファイルにおいてます。
*/
//############################################################################

#if !defined(THEOLIZER_INTERNAL_SERIALIZER_H)
#define THEOLIZER_INTERNAL_SERIALIZER_H

#include "internal/core.h"

//############################################################################
//      Begin
//############################################################################

namespace theolizer
{

//############################################################################
//      トップ・レベルのシリアライズ／デシリアライズ要求
//############################################################################

// ***************************************************************************
//      シリアライズ／デシリアライズ処理
// ***************************************************************************

//----------------------------------------------------------------------------
//      シリアライズ／デシリアライズ共用マクロ
//----------------------------------------------------------------------------

//      ---<<< 通常 >>>---

//! 通常の保存／回復処理マクロ（@ref Request 参照）
#define THEOLIZER_PROCESS(dSerializer, dInstance)                           \
    theolizer::internal::process<theolizer::internal::etmDefault,tTheolizerVersion>\
        (dSerializer, dInstance, #dInstance, THEOLIZER_INTERNAL_FILE, __LINE__)

//      ---<<< オブジェクト追跡指定 >>>---
//          非ポインタ(静的定義領域)の追跡を指定する。
//          (なお、Theolizerは参照を静的定義領域として取り扱うので注意。)

//! 被ポインタ用の保存／回復処理マクロ（@ref Request 参照）
#define THEOLIZER_PROCESS_POINTEE(dSerializer, dInstance)                   \
    do {                                                                    \
        typedef typename std::remove_reference<decltype(dInstance)>::type Type;\
        static_assert(!std::is_pointer<Type>::value,                        \
            "THEOLIZER_PROCESS_POINTEE() does not support a pointer.");     \
        theolizer::internal::process<theolizer::internal::etmPointee,tTheolizerVersion>\
            (dSerializer, dInstance, #dInstance, THEOLIZER_INTERNAL_FILE, __LINE__);\
    } while(0)

//      ---<<< オーナー指定 >>>---
//          ポインタの指す領域について、このポインタが所有権を持つことを指定する。
//          デシリアライズ時、nullptrや型が違う場合、
//              ポイントされている領域を開放し、正しい領域を獲得する。

//! オーナ・ポインタ用の保存／回復処理マクロ（@ref Request 参照）
#define THEOLIZER_PROCESS_OWNER(dSerializer, dInstance)                     \
    do {                                                                    \
        typedef typename std::remove_reference<decltype(dInstance)>::type Type;\
        static_assert(std::is_pointer<typename std::remove_all_extents<Type>::type>::value,\
            "THEOLIZER_PROCESS_OWNER() support a pointer only.");           \
        theolizer::internal::process<theolizer::internal::etmOwner,tTheolizerVersion>\
            (dSerializer, dInstance, #dInstance, THEOLIZER_INTERNAL_FILE, __LINE__);\
    } while(0)

//      ---<<< 基底クラス（非侵入型手動専用） >>>---

//! 非侵入型手動クラスの保存／回復処理で、基底クラスを保存／回復するためのマクロ（@ref WriteManualClass 参照）
#define THEOLIZER_PROCESS_BASE(dSerializer, dBase, dInstance)               \
    {                                                                       \
        theolizer::internal::BaseSerializer::AutoBaseProcessing             \
            aAutoBaseProcessing(dSerializer);                               \
        theolizer::internal::process<theolizer::internal::etmDefault,tTheolizerVersion>\
        (                                                                   \
            dSerializer,                                                    \
            const_cast<dBase&>(static_cast<dBase const&>(*dInstance)),      \
            "(" #dBase ")", THEOLIZER_INTERNAL_FILE, __LINE__               \
        );                                                                  \
    }

//############################################################################
//      クラスとenum型のシリアライズ／デシリアライズ定義
//############################################################################

// ***************************************************************************
//      クラスのシリアライズ指定
//          クラス・テンプレートのdClassは<,>問題を避けるため、()で括って渡す。
//          通常クラスの場合はその問題がないので()で括らないで渡す。
// ***************************************************************************

//----------------------------------------------------------------------------
//      侵入型(ノーマル)
//----------------------------------------------------------------------------

//      ---<<<< 対応方法=フィールド名) >>>---

//! 侵入型半自動クラス（名前対応）指定（@ref HalfAutoClass 参照）
#define THEOLIZER_INTRUSIVE(dAnno, dClass, dLastVersionNo)                  \
    private:                                                                \
    THEOLIZER_INTERNAL_SERIALIZABLE_AUTO(                                   \
        THEOLIZER_ANNOTATE(dAnno:), dClass, dClass, dLastVersionNo,         \
        (), theolizer::internal::emName, false, false)

//      ---<<<< 対応方法=順序) >>>---

//! 侵入型半自動クラス（順序対応）指定（@ref HalfAutoClass 参照）
#define THEOLIZER_INTRUSIVE_ORDER(dAnno, dClass, dLastVersionNo)            \
    private:                                                                \
    THEOLIZER_INTERNAL_SERIALIZABLE_AUTO(                                   \
        THEOLIZER_ANNOTATE(dAnno:), dClass, dClass, dLastVersionNo,         \
        (), theolizer::internal::emOrder, false, false)

//----------------------------------------------------------------------------
//      侵入型(テンプレート)
//----------------------------------------------------------------------------

#ifndef THEOLIZER_INTERNAL_DOXYGEN

//      ---<<<< 対応方法=フィールド名) >>>---

#define THEOLIZER_INTRUSIVE_TEMPLATE(dAnno, dList, dClass, dLastVersionNo, dUniqueClass)\
    private:                                                                \
        THEOLIZER_ANNOTATE(                                                 \
            TS:THEOLIZER_INTERNAL_UNPAREN dList;THEOLIZER_INTERNAL_UNPAREN dClass)\
    THEOLIZER_INTERNAL_SERIALIZABLE_AUTO(                                   \
        THEOLIZER_ANNOTATE(dAnno:), dClass, dClass, dLastVersionNo,         \
        (friend struct dUniqueClass;), theolizer::internal::emName, false, false)

//      ---<<<< 対応方法=順序) >>>---

#define THEOLIZER_INTRUSIVE_TEMPLATE_ORDER(dAnno, dList, dClass, dLastVersionNo, dUniqueClass)\
    private:                                                                \
        THEOLIZER_ANNOTATE(                                                 \
            TS:THEOLIZER_INTERNAL_UNPAREN dList;THEOLIZER_INTERNAL_UNPAREN dClass)\
    THEOLIZER_INTERNAL_SERIALIZABLE_AUTO(                                   \
        THEOLIZER_ANNOTATE(dAnno:), dClass, dClass, dLastVersionNo,         \
        (friend struct dUniqueClass;), theolizer::internal::emOrder, false, false)

#endif  // THEOLIZER_INTERNAL_DOXYGEN

//----------------------------------------------------------------------------
//      非侵入型(手動)
//----------------------------------------------------------------------------

//      ---<<<< 対応方法=順序(ノーマル) >>>---

//! 非侵入型手動クラス指定（@ref ManualClass 参照）
#define THEOLIZER_NON_INTRUSIVE_ORDER(dClass, dLastVersionNo)               \
    template<>                                                              \
    struct TheolizerNonIntrusive<THEOLIZER_INTERNAL_UNPAREN dClass> :       \
                        public THEOLIZER_INTERNAL_UNPAREN dClass            \
    {                                                                       \
        THEOLIZER_INTERNAL_SERIALIZABLE_MANUAL(dClass, dLastVersionNo,      \
            (), theolizer::internal::emOrder, true);                        \
    }

//      ---<<<< 対応方法=順序(テンプレート) >>>---

#ifndef THEOLIZER_INTERNAL_DOXYGEN

#define THEOLIZER_NON_INTRUSIVE_TEMPLATE_ORDER(dList, dClass, dLastVersionNo,dUniqueClass)\
    THEOLIZER_INTERNAL_UNPAREN dList                                        \
    struct TheolizerNonIntrusive<THEOLIZER_INTERNAL_UNPAREN dClass> :       \
                                public THEOLIZER_INTERNAL_UNPAREN dClass    \
    {                                                                       \
        THEOLIZER_ANNOTATE(                                                 \
            TS:THEOLIZER_INTERNAL_UNPAREN dList;THEOLIZER_INTERNAL_UNPAREN dClass)\
        THEOLIZER_INTERNAL_SERIALIZABLE_MANUAL(dClass, dLastVersionNo,      \
            (friend struct dUniqueClass;), theolizer::internal::emOrder, true);\
    }

#endif  // THEOLIZER_INTERNAL_DOXYGEN

// ***************************************************************************
//      enum型のシリアライズ指定
// ***************************************************************************

//! enum型シリアライズ（シンボル名保存）指定（@ref HalfAutoEnum 参照）
#define THEOLIZER_ENUM(dEnum, dLastVersionNo)                               \
    THEOLIZER_INTERNAL_ENUM(dEnum, dLastVersionNo, theolizer::internal::estName, false)

//! enum型シリアライズ（シンボル値保存）指定（@ref HalfAutoEnum 参照）
#define THEOLIZER_ENUM_VALUE(dEnum, dLastVersionNo)                         \
    THEOLIZER_INTERNAL_ENUM(dEnum, dLastVersionNo, theolizer::internal::estValue, false)

// ***************************************************************************
//      ポリモーフィズム用派生クラス登録
// ***************************************************************************

//! ポリモーフィズム用派生クラス登録（@ref Polymorphism31 参照）
#define THEOLIZER_REGISTER_CLASS(dClass)                                    \
    namespace theolizer{namespace internal{                                 \
    template                                                                \
    class RegisterToBaseClass<THEOLIZER_INTERNAL_UNPAREN dClass>;           \
    }}

// ***************************************************************************
//      アノテーション用マクロ
// ***************************************************************************

#ifdef THEOLIZER_INTERNAL_DRIVER
    #define THEOLIZER_ANNOTATE(...)                                         \
        __attribute__((annotate("THEORIDE:" THEOLIZER_INTERNAL_STRINGIZE(__VA_ARGS__))))
#else
    /*!
        @brief      アノテーション用マクロ
        @details    @see @ref Basic11
                    @see @ref Basic21
                    @see @ref HowToObjectTracking11
                    @see @ref HowToObjectTracking12
                    @see @ref HowToSpecifySaving133
                    @see @ref ChangingEnum
                    @see @ref HowToModifyEnum1
                    @see @ref HowToModifyEnum31
                    @see @ref HowToModifyClass3
                    @see @ref HowToModifyClass5
    */
    #define THEOLIZER_ANNOTATE(...)
#endif

// ***************************************************************************
//      クラス・テンプレート対応時のクラス登録
//          例えば、std::unique_ptr<>のパラメータであるstd::default_delete<T>
//          が指定された時(第2パラメータを省略した時)、std::unique_ptr<>クラス名を
//          ヘッダへ出力する際にstd::default_delete<T>の名前を生成する。
//          そのためには、std::default_delete<T>が型テーブル(TypeInfoList)へ
//          登録されている必要がある。
//          しかし、std::default_delete<T>はシリアライズ対象ではないため、自動的には
//          登録されないため、当マクロを用いて登録する。
// ***************************************************************************

#ifndef THEOLIZER_INTERNAL_DOXYGEN

//----------------------------------------------------------------------------
//      クラス・テンプレートのパラメータのみのクラス
//          std::unique_ptr<>のstd::default_delete<T>のように処理は行うが、
//          データ保持しないようなクラスはシリアライズしない。
//          そのようなクラスでも名前を取り出せるようにするために登録する。
//----------------------------------------------------------------------------

//      ---<<<< テンプレート >>>---

#define THEOLIZER_TEMPLATE_PARAMETER_TEMPLATE(dList, dName, dParam, dUniqueClass)\
    struct dUniqueClass {};                                                 \
    THEOLIZER_INTERNAL_UNPAREN dList                                        \
    struct TheolizerNonIntrusive<dName<THEOLIZER_INTERNAL_UNPAREN dParam> > :\
        public dName<THEOLIZER_INTERNAL_UNPAREN dParam>                     \
    {                                                                       \
        THEOLIZER_ANNOTATE(                                                 \
            TS:THEOLIZER_INTERNAL_UNPAREN dList;dName<THEOLIZER_INTERNAL_UNPAREN dParam>)\
        THEOLIZER_INTERNAL_TEMPLATE_PARAMETER((dName<THEOLIZER_INTERNAL_UNPAREN dParam>),\
            dName, dParam, dUniqueClass);                                   \
    }

//----------------------------------------------------------------------------
//      上記で指定したクラスをテンプレート・パラメータとして持つクラスの
//      TheolizerUserDefine<>::save/loadClassManual()で登録する。
//----------------------------------------------------------------------------

#define THEOLIZER_REGISTER_TEMPLATE_PARAMETER(dClass)                       \
    theolizer::internal::RegisterType<tMidSerializer,dClass,tTheolizerVersion>::getInstance()

#endif  // THEOLIZER_INTERNAL_DOXYGEN

//############################################################################
//      オプション機能指定
//          保存先
//          グローバル・バージョン番号
//############################################################################

// ***************************************************************************
//      ユーザ用保存先定義マクロ
//          dPrevSymbol : 定義済保存先の最後を指定する(これに続けて新規シンボルを定義する)
//          ...         : 新規シンボルを1個～8個の範囲で,で区切って指定する
//              8個以上定義したい時は、THEOLIZER_DESTINATIONS()を 繰り返し用いる。
//              dPrevSymbolは直前のTHEOLIZER_DESTINATIONS()で定義した
//              最後の新規シンボルを指定する。
// ***************************************************************************

//! 保存先定義用マクロ
#define THEOLIZER_DESTINATIONS(dPrevSymbol, ...)                            \
    namespace theolizer{                                                    \
    namespace internal{namespace{namespace bits{                            \
    enum : unsigned {                                                       \
        THEOLIZER_INTERNAL_CAT(dPrevSymbol, Cont)=                          \
            static_cast<unsigned>(theolizerD::dPrevSymbol),                 \
        __VA_ARGS__                                                         \
    };                                                                      \
    }}} /* namespace internal */                                            \
    THEOLIZER_INTERNAL_FOR(THEOLIZER_INTERNAL_DESTINATION, __VA_ARGS__);\
    }   /* namespace theolizer */ 

// ***************************************************************************
//      グローバル・バージョン番号テーブル
// ***************************************************************************

//----------------------------------------------------------------------------
//      グローバル・バージョン・テーブル定義マクロ
//          グローバル名前空間で使用すること
//----------------------------------------------------------------------------

#ifdef THEOLIZER_WRITE_CODE

//! グローバル・バージョン番号テーブル定義用マクロ
#define THEOLIZER_DEFINE_GLOBAL_VERSION_TABLE(dName, dLastGlobalVersionNo)  \
    namespace theolizer{namespace internal{namespace global_table{          \
    class dName final : public internal::GlobalVersionNoTable<dLastGlobalVersionNo>\
    {                                                                       \
        static const unsigned kLastGlobalVersionNo=dLastGlobalVersionNo;    \
        dName();                                                            \
    public:                                                                 \
        static GlobalVersionNoTableBase* getInstance()                      \
        {                                                                   \
            static dName instance;                                          \
            return &instance;                                               \
        }                                                                   \
        char const* getTableName() const {return #dName;}                   \
    };                                                                      \
    }   /* namespace namespace */                                           \
    namespace {                                                             \
    GlobalVersionNoTableBase const*const sGlobalVersionNoTable=             \
        global_table::dName::getInstance();                                 \
    }}  /* namespace internal */                                            \
    namespace {                                                             \
    unsigned const kLastGlobalVersionNo=dLastGlobalVersionNo;               \
    }}  /* namespace theolizer */
#else
//! グローバル・バージョン番号テーブル定義用マクロ
#define THEOLIZER_DEFINE_GLOBAL_VERSION_TABLE(dName, dLastGlobalVersionNo)
#endif

#ifndef THEOLIZER_INTERNAL_DOXYGEN
    #define THEOLIZER_INTERNAL_ADD(dType, ...)  add(typeid(::dType),__VA_ARGS__)

#endif  // THEOLIZER_INTERNAL_DOXYGEN

//############################################################################
//      End
//############################################################################

}   // namespace theolizer

#endif  // THEOLIZER_INTERNAL_SERIALIZER_H