CJsonConfig.h

[詳解]

//=============================================================================
/// @file
/// JSON構成情報クラスヘッダファイル
///
/// JSON構成情報クラスヘッダファイルです。
///
/// $Id: CJsonConfig.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 <CJsonDocument.h>
#include <initializer_list>

//=============================================================================
// JSONライブラリ名前空間
namespace LibJson {
    //=========================================================================
    /// JSON構成情報クラス
    ///
    /// JSON構成情報クラスです。
    ///
    /// @attention なし
    ///
    class LIB_JSON_API CJsonConfig: public CJsonDocument {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CJsonConfig() noexcept;

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

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 構成ファイルロード関数
        ///
        /// 構成ファイルロード関数です。
        ///
        /// @param[in] pszPath ファイルパス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Load( wchar_t const* pszPath ) noexcept;

        //---------------------------------------------------------------------
        /// 構成ファイルセーブ関数
        ///
        /// 構成ファイルセーブ関数です。
        ///
        /// @param[in] pszPath ファイルパス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Save( wchar_t const* pszPath ) noexcept;

        //---------------------------------------------------------------------
        /// JSONパス取得関数
        ///
        /// JSONパス取得関数です。
        ///
        /// @param[out] rcPath 文字列参照
        /// @param[in]  pszKey キー文字列
        /// @param[in]  nIndex インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetPath( CString& rcPath, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// キー設定値削除関数
        ///
        /// キー設定値削除関数です。
        ///
        /// @param[in]  pszKey キー文字列
        /// @param[in]  nIndex インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool Delete( wchar_t const* pszKey, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// 整数型設定値取得関数
        ///
        /// 整数型設定値取得関数です。
        ///
        /// @param[out] rnValue 整数型参照
        /// @param[in]  pszKey  キー文字列
        /// @param[in]  nIndex  インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool Get( int& rnValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// 整数型設定値設定関数
        ///
        /// 整数型設定値設定関数です。
        ///
        /// @param[in] nValue 整数型設定値
        /// @param[in] pszKey キー文字列
        /// @param[in] nIndex インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( int nValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// 整数型設定値取得関数
        ///
        /// 整数型設定値取得関数です。
        ///
        /// @param[in] rpnValueList 整数型ポインタリスト参照
        /// @param[in] pszKey       キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Get( std::initializer_list< int* > const& rpnValueList, wchar_t const* pszKey = nullptr ) noexcept;

        //---------------------------------------------------------------------
        /// 整数型設定値設定関数
        ///
        /// 整数型設定値設定関数です。
        ///
        /// @param[in] rnValueList 整数型設定値リスト参照
        /// @param[in] pszKey      キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( std::initializer_list< int > const& rnValueList, wchar_t const* pszKey = nullptr ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値浮動小数取得関数
        ///
        /// JSON設定値浮動小数取得関数です。
        ///
        /// @param[out] rfValue 浮動小数参照
        /// @param[in]  pszKey  キー文字列
        /// @param[in]  nIndex  インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool Get( double& rfValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値浮動小数設定関数
        ///
        /// JSON設定値浮動小数設定関数です。
        ///
        /// @param[in] fValue 設定値浮動小数
        /// @param[in] pszKey キー文字列
        /// @param[in] nIndex インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( double fValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値真理値取得関数
        ///
        /// JSON設定値真理値取得関数です。
        ///
        /// @param[out] rbValue 真理値参照
        /// @param[in]  pszKey  キー文字列
        /// @param[in]  nIndex  インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool Get( bool& rbValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値真理値設定関数
        ///
        /// JSON設定値真理値設定関数です。
        ///
        /// @param[in] bValue 設定値真理値
        /// @param[in] pszKey キー文字列
        /// @param[in] nIndex インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( bool bValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値文字列取得関数
        ///
        /// JSON設定値文字列取得関数です。
        ///
        /// @param[out] rcValue 文字列参照
        /// @param[in]  pszKey  キー文字列
        /// @param[in]  nIndex  インデックス
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool Get( CString& rcValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// JSON設定値文字列設定関数
        ///
        /// JSON設定値文字列設定関数です。
        ///
        /// @param[in] pszValue 設定値文字列
        /// @param[in] pszKey   キー文字列
        /// @param[in] nIndex   インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( wchar_t const* pszValue, wchar_t const* pszKey = nullptr, int nIndex = -1 ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示位置復元関数
        ///
        /// ウィンドウ表示位置復元関数です。
        ///
        /// @param[in] hWnd   ウィンドウハンドル
        /// @param[in] pszKey キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ResumeWindowPosition( HWND hWnd, wchar_t const* pszKey = KEY_WINDOW_POS ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示位置保存関数
        ///
        /// ウィンドウ表示位置保存関数です。
        ///
        /// @param[in] hWnd   ウィンドウハンドル
        /// @param[in] pszKey キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SaveWindowPosition( HWND hWnd, wchar_t const* pszKey = KEY_WINDOW_POS ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示状態復元関数
        ///
        /// ウィンドウ表示状態復元関数です。
        ///
        /// @param[in] hWnd   ウィンドウハンドル
        /// @param[in] pszKey キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ResumeShowWindow( HWND hWnd, wchar_t const* pszKey = KEY_SHOW_WINDOW ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示状態保存関数
        ///
        /// ウィンドウ表示状態保存関数です。
        ///
        /// @param[in] hWnd   ウィンドウハンドル
        /// @param[in] pszKey キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SaveShowWindow( HWND hWnd, wchar_t const* pszKey = KEY_SHOW_WINDOW ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示状態取得関数
        ///
        /// ウィンドウ表示状態取得関数です。
        ///
        /// @param[in]  hWnd      ウィンドウハンドル
        /// @param[out] rbVisible WS_VISIBLEスタイルフラグ参照
        /// @param[out] rnShow    表示状態参照
        /// @param[in]  pszKey    キー文字列
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        virtual bool GetShowWindow( HWND hWnd, bool& rbVisible, int& rnShow, wchar_t const* pszKey = KEY_SHOW_WINDOW ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示状態設定関数
        ///
        /// ウィンドウ表示状態設定関数です。
        ///
        /// @param[in] hWnd     ウィンドウハンドル
        /// @param[in] bVisible WS_VISIBLEスタイルフラグ
        /// @param[in] nShow    表示状態
        /// @param[in] pszKey   キー文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetShowWindow( HWND hWnd, bool bVisible, int nShow, wchar_t const* pszKey = KEY_SHOW_WINDOW ) noexcept;

        //=====================================================================
        // 静的公開文字列定数
    public:
        static wchar_t const* const KEY_WINDOW_POS;  ///< ウィンドウ表示位置キー文字列
        static wchar_t const* const KEY_SHOW_WINDOW; ///< ウィンドウ表示状態キー文字列

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

#pragma managed( pop )