CJsonDocument.h

[詳解]

//=============================================================================
/// @file
/// JSONドキュメントクラスヘッダファイル
///
/// JSONドキュメントクラスヘッダファイルです。
///
/// $Id: CJsonDocument.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 <CString.h>
#include <CStream.h>

//=============================================================================
// JSONライブラリ名前空間
namespace LibJson {
    //=========================================================================
    /// JSONドキュメントクラス
    ///
    /// JSONドキュメントクラスです。
    ///
    /// @attention なし
    ///
    class LIB_JSON_API CJsonDocument {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pcJson JSONクラスポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CJsonDocument( CJson* pcJson = nullptr ) noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 空状態取得関数
        ///
        /// 空状態取得関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  空である
        /// -          false 空でない
        /// @attention なし
        ///
        inline virtual bool IsEmpty() noexcept { return ( nullptr == m_pcJsonRoot ); }

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

        //---------------------------------------------------------------------
        /// ルートJSONクラス設定関数
        ///
        /// ルートJSONクラス設定関数です。
        ///
        /// @param[in] pcJson JSONクラスポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetRootJson( CJson* pcJson ) noexcept;

        //---------------------------------------------------------------------
        /// カレントJSONクラス取得関数
        ///
        /// カレントJSONクラス取得関数です。
        ///
        /// @param     なし
        /// @return    JSONクラスポインタ
        /// @attention なし
        ///
        virtual CJson* GetCurrentJson() noexcept { return m_pcJsonCurrent; }

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

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

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

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

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

        //---------------------------------------------------------------------
        /// カレントJSONクラス削除関数
        ///
        /// カレントJSONクラス削除関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool DeleteCurrentJson() noexcept;

        //---------------------------------------------------------------------
        /// カレントパス取得関数
        ///
        /// カレントパス取得関数です。
        ///
        /// @param[out] rcPath 文字列クラス参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetCurrentPath( CString& rcPath ) noexcept;

        //---------------------------------------------------------------------
        /// カレントパス設定関数
        ///
        /// カレントパス設定関数です。
        ///
        /// @param[in] pszPath JSONパス文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetCurrentPath( wchar_t const* pszPath ) noexcept;

        //---------------------------------------------------------------------
        /// カレント設定値文字列取得関数
        ///
        /// カレント設定値文字列取得関数です。
        ///
        /// @param[out] rcValue    設定値文字列参照
        /// @param[in]  bClassName クラス名取得フラグ
        /// @param[in]  bQuotes    JSON文字列二重引用符なしフラグ
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetCurrentSetValue( CString& rcValue, bool bClassName = false, bool bQuotes = true ) noexcept;

        //---------------------------------------------------------------------
        /// カレント設定値文字列設定関数
        ///
        /// カレント設定値文字列設定関数です。
        ///
        /// @param[in] pszValue 設定値文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetCurrentSetValue( wchar_t const* pszValue ) noexcept;

        //---------------------------------------------------------------------
        /// JSONパス作成関数
        ///
        /// JSONパス作成関数です。
        ///
        /// @param[in] pszPath JSONパス文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CreatePath( wchar_t const* pszPath ) noexcept;

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// JSONパス取得関数
        ///
        /// JSONパス取得関数です。
        ///
        /// @param[out] rcPath JSONパス文字列参照
        /// @param[in]  pcJson JSONクラスポインタ
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetJsonPath( CString& rcPath, CJson* pcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSONパス検索関数
        ///
        /// JSONパス検索関数です。
        ///
        /// @param[in] pszPath JSONパス文字列
        /// @param[in] pcJson  JSONクラスポインタ
        /// @return    JSOBクラスポインタ
        /// @attention なし
        ///
        static CJson* FindJsonPath( wchar_t const* pszPath, CJson* pcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値文字列取得関数
        ///
        /// JSON設定値文字列取得関数です。
        ///
        /// @param[out] rcValue    JSON設定値文字列参照
        /// @param[in]  pcJson     JSONクラスポインタ
        /// @param[in]  bClassName JSONクラス名取得フラグ
        /// @param[in]  bQuotes    JSON文字列二重引用符なしフラグ
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetJsonSetValue( CString& rcValue, CJson* pcJson, bool bClassName = false, bool bQuotes = true ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値設定関数
        ///
        /// JSON設定値設定関数です。
        ///
        /// @param[in]     pszValue JSON設定値文字列
        /// @param[in,out] rpcJson  JSONクラスポインタ参照
        /// @return        実行結果
        /// -              true  成功
        /// -              false 失敗
        /// @attention     なし
        ///
        static bool SetJsonSetValue( wchar_t const* pszValue, CJson*& rpcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値ストリーム設定関数
        ///
        /// JSON設定値ストリーム設定関数です。
        ///
        /// @param[in]     rcStream JSON設定値ストリーム参照
        /// @param[in,out] rpcJson  JSONクラスポインタ参照
        /// @return        実行結果
        /// -              true  成功
        /// -              false 失敗
        /// @attention     なし
        ///
        static bool SetJsonSetValueByStream( CStream& rcStream, CJson*& rpcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSONクラス削除関数
        ///
        /// JSONクラス削除関数です。
        ///
        /// @param[in,out] rpcJson JSONクラスポインタ参照
        /// @return        実行結果
        /// -              true  成功
        /// -              false 失敗
        /// @attention     なし
        ///
        static bool DeleteJson( CJson*& rpcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSONパス作成関数
        ///
        /// JSONパス作成関数です。
        ///
        /// @param[in]     pszPath JSONパス文字列
        /// @param[in,out] rpcJson JSONクラスポインタ参照
        /// @return        実行結果
        /// -              true  成功
        /// -              false 失敗
        /// @attention     なし
        ///
        static bool CreateJsonPath( wchar_t const* pszPath, CJson*& rpcJson ) noexcept;

        //---------------------------------------------------------------------
        /// JSONパスリスト取得関数
        ///
        /// JSONパスリスト取得関数です。
        ///
        /// @param[out] rcPathList 文字列クラス参照
        /// @param[in]  pcJson     JSONクラスポインタ
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetJsonPathList( CString& rcPathList, CJson* pcJson ) noexcept;

        //=====================================================================
        // 限定公開型定義
    protected:
        //---------------------------------------------------------------------
        /// JSONパストークン種別列挙体
        ///
        /// JSONパストークン種別列挙体です。
        ///
        /// @attention なし
        ///
        enum class EJsonPathToken {
            Invalid,   ///< 無効値
            Separator, ///< セパレータ
            Dot,       ///< ドット
            DotDot,    ///< 二重ドット
            Name,      ///< 名前
            Index,     ///< インデックス
            Equal,     ///< 等号
            Size       ///< 列挙体サイズ
        };

        //=====================================================================
        // 静的限定公開関数
    protected:
        //---------------------------------------------------------------------
        /// JSONパストークン入力関数
        ///
        /// JSONパストークン入力関数です。
        ///
        /// @param[in]  rcStream 入力ストリーム参照
        /// @param[out] rcToken  文字列クラス参照
        /// @param[in]  bEqual   等号許可フラグ
        /// @return     JSONパストークン種別
        /// @attention  なし
        ///
        static EJsonPathToken InputPathToken( CStream& rcStream, CString& rcString, bool bEqual = false ) noexcept;

        //---------------------------------------------------------------------
        /// JSON文字列二重引用符削除関数
        ///
        /// JSON文字列二重引用符削除関数です。
        ///
        /// @param[out] rcString 文字列参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool DeleteQuotes( CString& rcString ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        CJson* m_pcJsonRoot;    ///< ルートJSONクラスポインタ
        CJson* m_pcJsonCurrent; ///< カレントJSONクラスポインタ

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

#pragma managed( pop )