CJsonPair.h

[詳解]

//=============================================================================
/// @file
/// JSONペアクラスヘッダファイル
///
/// JSONペアクラスヘッダファイルです。
///
/// $Id: CJsonPair.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 <CJson.h>
#include <CJsonString.h>
#include <CJsonValue.h>

//=============================================================================
// JSONライブラリ名前空間
namespace LibJson {
    //=========================================================================
    /// JSONペアクラス
    ///
    /// JSONペアクラスです。
    ///
    /// @attention なし
    ///
    class LIB_JSON_API CJsonPair: public CJson {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pcParent  親JSONクラスポインタ
        /// @param[in] pszString 文字列ポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CJsonPair( CJson* pcParent, wchar_t const* pszString = nullptr ) noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// JSONクラス種別取得関数
        ///
        /// JSONクラス種別取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラス種別
        /// @attention オーバライド関数です。
        ///
        inline virtual EJsonClass GetJsonClass() noexcept override { return EJsonClass::JsonPair; }

        //---------------------------------------------------------------------
        /// JSONクラス種別判定関数
        ///
        /// JSONクラス種別判定関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        inline virtual bool IsJsonPair() noexcept override { return true; }

        //---------------------------------------------------------------------
        /// JSONクラスインスタンス取得関数
        ///
        /// JSONクラスインスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスインスタンスポインタ
        /// @attention オーバライド関数です。
        ///
        inline virtual CJsonPair*   GetJsonPair()   noexcept override { return this; }
        inline virtual CJsonString* GetJsonString() noexcept override { return m_pcJsonString; }
        inline virtual CJsonValue*  GetJsonValue()  noexcept override { return m_pcJsonValue; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// JSONクラスクリア関数
        ///
        /// JSONクラスクリア関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention オーバライド関数です。
        ///
        virtual void ClearJson() noexcept override;

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

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

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

        //---------------------------------------------------------------------
        /// JSONバリュー設定関数
        ///
        /// JSONバリュー設定関数です。
        ///
        /// @param[in] pcJsonValue JSONバリューポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetJsonValue( CJsonValue* pcJsonValue ) noexcept;

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// JSONペア入力作成関数
        ///
        /// JSONペア入力作成関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @param[in] pcParent 親JSONクラスポインタ
        /// @return    JSONペアポインタ
        /// @attention なし
        ///
        static CJsonPair* CreateInputJson( CStream& rcStream, CJson* pcParent ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        CJsonString* m_pcJsonString; ///< JSON文字列ポインタ
        CJsonValue*  m_pcJsonValue;  ///< JSONバリューポインタ

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

#pragma managed( pop )