CStringStream.h

[詳解]

//=============================================================================
/// @file
/// 文字列ストリームクラスヘッダ文字列
///
/// 文字列ストリームクラスヘッダ文字列です。
///
/// $Id: CStringStream.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 <CString.h>
#include <CStream.h>

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// 文字列ストリームクラス
    ///
    /// 文字列ストリームクラスです。
    ///
    /// @attention なし
    ///
    class LIB_COMMON_API CStringStream: public CString, public CStream {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CStringStream( wchar_t const* pszString = nullptr ) noexcept;

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

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

        //---------------------------------------------------------------------
        /// １文字出力関数
        ///
        /// １文字出力関数です。
        ///
        /// @param[in] ch 文字コード
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバーライド関数です。
        ///
        virtual bool OutputChar( wchar_t ch ) noexcept override;

        //---------------------------------------------------------------------
        /// 文字列出力関数
        ///
        /// 文字列出力関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバーライド関数です。
        ///
        virtual bool OutputString( wchar_t const* pszString ) noexcept override;

        //---------------------------------------------------------------------
        /// １文字入力関数
        ///
        /// １文字入力関数です。
        ///
        /// @param[out] rCh 文字コード参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  オーバーライド関数です。
        ///
        virtual bool InputChar( wchar_t& rCh ) noexcept override;

        //---------------------------------------------------------------------
        /// ストリームサイズ取得関数
        ///
        /// ストリームサイズ取得関数です。
        ///
        /// @param     なし
        /// @return    ストリームサイズ
        /// @attention オーバライド関数です。
        ///
        virtual int GetStreamSize() const noexcept override { return GetCount(); }

        //---------------------------------------------------------------------
        /// ストリームポインタ取得関数
        ///
        /// ストリームポインタ取得関数です。
        ///
        /// @param     なし
        /// @return    ストリームポインタ
        /// @attention オーバライド関数です。
        ///
        virtual int GetStreamPoint() const noexcept override { return m_nStreamPoint; }

        //---------------------------------------------------------------------
        /// ストリームポインタ設定関数
        ///
        /// ストリームポインタ設定関数です。
        ///
        /// @param[in] nPoint ストリームポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool SetStreamPoint( int nPoint ) noexcept override { return UpdateStreamPoint( nPoint ); }

        //---------------------------------------------------------------------
        /// ストリーム終端設定関数
        ///
        /// ストリーム終端設定関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool SetStreamEnd() noexcept override { return UpdateEndPoint( m_nStreamPoint ); }

        //=====================================================================
        // 限定公開関数
    protected:
        //---------------------------------------------------------------------
        /// ストリームポインタ更新関数
        ///
        /// ストリームポインタ更新関数です。
        ///
        /// @param[in] nPoint ストリームポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateStreamPoint( int nPoint ) noexcept;

        //---------------------------------------------------------------------
        /// 終端ストリームポインタ更新関数
        ///
        /// 終端ストリームポインタ更新関数です。
        ///
        /// @param[in] nPoint ストリームポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateEndPoint( int nPoint ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        int m_nStreamPoint; ///< ストリームポインタ

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

#pragma managed( pop )