CStream.h

[詳解]

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

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// ストリームクラス
    ///
    /// ストリームクラスです。
    ///
    /// @attention 抽象クラスです。
    ///
    class LIB_COMMON_API CStream abstract: public CStreamOut {
        //=====================================================================
        // 構築子と解体子
    protected:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CStream() noexcept;

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

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// １文字入力関数
        ///
        /// １文字入力関数です。
        ///
        /// @param[out] rCh 文字コード参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  純粋仮想関数です。
        ///
        virtual bool InputChar( wchar_t& rCh ) noexcept = 0;

        //---------------------------------------------------------------------
        /// 文字列入力関数
        ///
        /// 文字列入力関数です。
        ///
        /// @param[in] pszBuffer 文字列バッファポインタ
        /// @param[in] nSize     バッファサイズ
        /// @return    入力文字数
        /// @attention なし
        ///
        virtual int InputString( wchar_t* pszBuffer, int nSize ) noexcept;

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

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

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

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

        //---------------------------------------------------------------------
        /// ストリーム終端状態取得関数
        ///
        /// ストリーム終端状態取得関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool IsStreamEnd() const noexcept;

        //---------------------------------------------------------------------
        /// 空白スキップ関数
        ///
        /// 空白スキップ関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SkipSpace() noexcept;

        //---------------------------------------------------------------------
        /// １文字スキップ関数
        ///
        /// １文字スキップ関数です。
        ///
        /// @param[in] ch      スキップ文字コード
        /// @param[in] bIgnore 大小文字無視フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SkipChar( wchar_t ch, bool bIgnore = false ) noexcept;

        //---------------------------------------------------------------------
        /// １文字スキップ関数
        ///
        /// １文字スキップ関数です。
        ///
        /// @param[in] pszString スキップ文字列ポインタ
        /// @param[in] bIgnore   最小文字無視フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SkipChar( wchar_t const* pszString, bool bIgnore = false ) noexcept;

        //---------------------------------------------------------------------
        /// ストリームポインタプッシュ関数
        ///
        /// ストリームポインタプッシュ関数です。
        ///
        /// @param[in] pcPointerList ストリームポインタリストポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool PushStreamPoint( CArray< int >* pcPointerList ) noexcept;

        //---------------------------------------------------------------------
        /// ストリームポインタポップ数
        ///
        /// ストリームポインタポップ数です。
        ///
        /// @param[in] pcPointerList ストリームポインタリストポインタ
        /// @param[in] bResume       ポインタ復元フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool PopStreamPoint( CArray< int >* pcPointerList, bool bResume ) noexcept;

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

#pragma managed( pop )