CJsonToken.h

[詳解]

//=============================================================================
/// @file
/// JSONトークンクラスヘッダファイル
///
/// JSONトークンクラスヘッダファイルです。
///
/// $Id: CJsonToken.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 <CStringStream.h>
#include <CArray.h>

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

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

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

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

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

        //=====================================================================
        // 公開関数
    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] rcStreamOut 出力ストリーム参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool OutputJson( CStreamOut& rcStreamOut ) noexcept override;

        //---------------------------------------------------------------------
        /// JSON文字集合入力関数
        ///
        /// JSON文字集合入力関数です。
        ///
        /// @param[in] rcStream   入力ストリーム参照
        /// @param[in] pszNgChars 入力禁止文字列
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InputJsonChars( CStream& rcStream, wchar_t const* pszNgChars = nullptr ) noexcept;

        //---------------------------------------------------------------------
        /// JSON文字入力関数
        ///
        /// JSON文字入力関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InputJsonChar( CStream& rcStream, wchar_t const* pszNgChars = nullptr ) noexcept;

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

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

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

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

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

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

        //---------------------------------------------------------------------
        /// JSON固定文字入力関数
        ///
        /// JSON固定文字入力関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @param[in] ch       文字コード
        /// @param[in] bIgnore  大小文字無視フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InputJsonFixedChar( CStream& rcStream, wchar_t ch, bool bIgnore = false ) noexcept;

        //---------------------------------------------------------------------
        /// JSON固定文字列入力関数
        ///
        /// JSON固定文字列入力関数です。
        ///
        /// @param[in] rcStream  ストリーム参照
        /// @param[in] pszString 文字列ポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InputJsonFixedString( CStream& rcStream, wchar_t const* pszString ) noexcept;

        //---------------------------------------------------------------------
        /// 最後尾文字取得関数
        ///
        /// 最後尾文字取得関数です。
        ///
        /// @param     なし
        /// @return    文字コード
        /// @attention なし
        ///
        virtual wchar_t GetLastChar() noexcept;

        //---------------------------------------------------------------------
        /// ストリームポインタプッシュ関数
        ///
        /// ストリームポインタプッシュ関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool PushStreamPoints( CStream& rcStream ) noexcept;

        //---------------------------------------------------------------------
        /// ストリームポインタポップ関数
        ///
        /// ストリームポインタポップ関数です。
        ///
        /// @param[in] rcStream 入力ストリーム参照
        /// @param[in] bResume  ポインタ復元フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool PopStreamPoints( CStream& rcStream, bool bResume ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        CArray< int >* m_pcStringPointerList; ///< 文字列ストリームポインタリストポインタ

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

#pragma managed( pop )