CJsonContainer.h

[詳解]

//=============================================================================
/// @file
/// JSONコンテナクラスヘッダファイル
///
/// JSONコンテナクラスヘッダファイルです。
///
/// $Id: CJsonContainer.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 <CJsonValue.h>
#include <CArray.h>

//=============================================================================
// JSONライブラリ名前空間
namespace LibJson {
    //=========================================================================
    /// JSONコンテナクラス
    ///
    /// JSONコンテナクラスです。
    ///
    /// @attention 抽象クラスです。
    ///
    class LIB_JSON_API CJsonContainer abstract: public CJsonValue, public CArray< CJson* > {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pcParent 親JSONクラスポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CJsonContainer( CJson* pcParent ) noexcept;

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

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

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

        //---------------------------------------------------------------------
        /// JSONクラスインスタンス取得関数
        ///
        /// JSONクラスインスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスインスタンスポインタ
        /// @attention オーバライド関数です。
        ///
        inline virtual CJsonContainer* GetJsonContainer() noexcept override { return this; }

        //---------------------------------------------------------------------
        /// オープン文字取得関数
        ///
        /// オープン文字取得関数です。
        ///
        /// @param     なし
        /// @return    文字コード
        /// @attention 純粋仮想関数です。
        ///
        inline virtual wchar_t GetOpenChar() noexcept = 0;

        //---------------------------------------------------------------------
        /// クローズ文字取得関数
        ///
        /// クローズ文字取得関数です。
        ///
        /// @param     なし
        /// @return    文字コード
        /// @attention 純粋仮想関数です。
        ///
        inline virtual wchar_t GetCloseChar() noexcept = 0;

        //---------------------------------------------------------------------
        /// JSONエレメント入力作成関数
        ///
        /// JSONエレメント入力作成関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @param[in] pcParent 親JSONクラスポインタ
        /// @return    JSON派生クラスポインタ
        /// @attention 純粋仮想関数です。
        ///
        inline virtual CJson* CreateInputJsonElement( CStream& rcStream, CJson* pcParent ) noexcept = 0;

        //=====================================================================
        // 公開関数
    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] nIndex インデックス
        /// @return    JSONクラスポインタ
        /// @attention なし
        ///
        virtual CJson* GetJsonElement( int nIndex ) noexcept;

        //---------------------------------------------------------------------
        /// JSONエレメント設定関数
        ///
        /// JSONエレメント設定関数です。
        ///
        /// @param[in] nIndex インデックス
        /// @param[in] pcJson JSONクラスポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetJsonElement( int nIndex, CJson* pcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSONエレメント数拡張関数
        ///
        /// JSONエレメント数拡張関数です。
        ///
        /// @param[in] nCount エレメント数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExtendJsonElementCount( int nCount ) noexcept;

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

#pragma managed( pop )