CJson.h

[詳解]

//=============================================================================
/// @file
/// JSONクラスヘッダファイル
///
/// JSONクラスヘッダファイルです。
///
/// $Id: CJson.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <LibJsonDef.h>
#include <CStream.h>
#include <CArray.h>

//=============================================================================
// JSONライブラリ名前空間
namespace LibJson {
    //=========================================================================
    // 前方宣言
    class CJsonObject;    // JSONオブジェクトクラス
    class CJsonArray;     // JSON配列クラス
    class CJsonString;    // JSON文字列クラス
    class CJsonNumber;    // JSON数値クラス
    class CJsonFixed;     // JSON固定値クラス
    class CJsonPair;      // JSONペアクラス
    class CJsonValue;     // JSONバリュークラス
    class CJsonContainer; // JSONコンテナクラス
    class CJsonToken;     // JSONトークンクラス

    //=========================================================================
    /// JSONクラス
    ///
    /// JSONクラスです。
    ///
    /// @attention なし
    ///
    class LIB_JSON_API CJson {
        //=====================================================================
        // 公開型定義
    public:
        //---------------------------------------------------------------------
        /// JSONクラス種別列挙体
        ///
        /// JSONクラス種別列挙体です。
        ///
        /// @attention なし
        ///
        enum class EJsonClass {
            Invalid,       ///< 無効値
            JsonObject,    ///< JSONオブジェクトクラス
            JsonArray,     ///< JSON配列クラス
            JsonString,    ///< JSON文字列クラス
            JsonNumber,    ///< JSON数値クラス
            JsonFixed,     ///< JSON固定値クラス
            JsonPair,      ///< JSONペアクラス
            JsonValue,     ///< JSONバリュークラス
            JsonContainer, ///< JSONコンテナクラス
            JsonToken,     ///< JSONトークンクラス
            Size           ///< 列挙体サイズ
        };

        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pcParent 親JSONクラスポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CJson( CJson* pcParent ) noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CJson() noexcept;

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 親JSONクラス取得関数
        ///
        /// 親JSONクラス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスポインタ
        /// @attention なし
        ///
        inline virtual CJson* GetJsonParent() noexcept { return m_pcParent; }

        //---------------------------------------------------------------------
        /// 親JSONクラス設定関数
        ///
        /// 親JSONクラス設定関数です。
        ///
        /// @param[in] pcParent 親JSONクラスポインタ
        /// @return    なし
        /// @attention なし
        ///
        inline virtual void SetJsonParent( CJson* pcParent ) noexcept { m_pcParent = pcParent; }

        //---------------------------------------------------------------------
        /// JSONクラス種別取得関数
        ///
        /// JSONクラス種別取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラス種別
        /// @attention なし
        ///
        inline virtual EJsonClass GetJsonClass() noexcept { return EJsonClass::Invalid; }

        //---------------------------------------------------------------------
        /// JSONクラス種別判定関数
        ///
        /// JSONクラス種別判定関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        inline virtual bool IsJsonObject()    noexcept { return false; } // JSONオブジェクトクラス種別判定関数
        inline virtual bool IsJsonArray()     noexcept { return false; } // JSON配列クラス種別判定関数
        inline virtual bool IsJsonString()    noexcept { return false; } // JSON文字列クラス種別判定関数
        inline virtual bool IsJsonNumber()    noexcept { return false; } // JSON数値クラス種別判定関数
        inline virtual bool IsJsonFixed()     noexcept { return false; } // JSON固定値クラス種別判定関数
        inline virtual bool IsJsonPair()      noexcept { return false; } // JSONペアクラス種別判定関数
        inline virtual bool IsJsonValue()     noexcept { return false; } // JSONバリュークラス種別判定関数
        inline virtual bool IsJsonContainer() noexcept { return false; } // JSONコンテナクラス種別判定関数
        inline virtual bool IsJsonToken()     noexcept { return false; } // JSONトークンクラス種別判定関数

        //---------------------------------------------------------------------
        /// JSONクラスインスタンス取得関数
        ///
        /// JSONクラスインスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスインスタンスポインタ
        /// @attention なし
        ///
        inline virtual CJsonObject*    GetJsonObject()    noexcept { return nullptr; } // JSONオブジェクトクラスインスタンス取得関数
        inline virtual CJsonArray*     GetJsonArray()     noexcept { return nullptr; } // JSON配列クラスインスタンス取得関数
        inline virtual CJsonString*    GetJsonString()    noexcept { return nullptr; } // JSON文字列クラスインスタンス取得関数
        inline virtual CJsonNumber*    GetJsonNumber()    noexcept { return nullptr; } // JSON数値クラスインスタンス取得関数
        inline virtual CJsonFixed*     GetJsonFixed()     noexcept { return nullptr; } // JSON固定値クラスインスタンス取得関数
        inline virtual CJsonPair*      GetJsonPair()      noexcept { return nullptr; } // JSONペアクラスインスタンス取得関数
        inline virtual CJsonValue*     GetJsonValue()     noexcept { return nullptr; } // JSONバリュークラスインスタンス取得関数
        inline virtual CJsonContainer* GetJsonContainer() noexcept { return nullptr; } // JSONコンテナクラスインスタンス取得関数
        inline virtual CJsonToken*     GetJsonToken()     noexcept { return nullptr; } // JSONトークンクラスインスタンス取得関数

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// ルートJSONクラス取得関数
        ///
        /// ルートJSONクラス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスポインタ
        /// @attention なし
        ///
        virtual CJson* GetJsonRoot() noexcept;

        //---------------------------------------------------------------------
        /// JSONクラスクリア関数
        ///
        /// JSONクラスクリア関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual void ClearJson() noexcept;

        //---------------------------------------------------------------------
        /// JSONクラスコンパクト化関数
        ///
        /// JSONクラスコンパクト化関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CompactJson() noexcept;

        //---------------------------------------------------------------------
        /// JSONクラス入力関数
        ///
        /// JSONクラス入力関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InputJson( CStream& rcStream ) noexcept { return false; }

        //---------------------------------------------------------------------
        /// JSONクラス出力関数
        ///
        /// JSONクラス出力関数です。
        ///
        /// @param[in] rcStreamOut 出力ストリーム参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputJson( CStreamOut& rcStreamOut ) noexcept { return false; }

        //=====================================================================
        // 限定公開変数
    protected:
        CJson*         m_pcParent;           ///< 親JSONクラスポインタ
        CArray< int >* m_pcInputPointerList; ///< 入力ストリームポインタリストポインタ

        //=====================================================================
        // 削除関数
    private:
        CJson( CJson const& ) = delete;
        CJson& operator=( CJson const& ) = delete;
    };
}

#pragma managed( pop )