CStreamOut.h

[詳解]

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

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

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

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 文字列出力関数
        ///
        /// 文字列出力関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention 純粋仮想関数です。
        ///
        virtual bool OutputString( wchar_t const* pszString ) noexcept = 0;

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

        //---------------------------------------------------------------------
        /// 書式設定文字列出力関数
        ///
        /// 書式設定文字列出力関数です。
        ///
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] ...       可変長引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputFormat( wchar_t const* pszFormat, ... ) noexcept;

        //---------------------------------------------------------------------
        /// 引数リスト文字列出力関数
        ///
        /// 引数リスト文字列出力関数です。
        ///
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] vaArgs    引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputArgs( wchar_t const* pszFormat, va_list vaArgs ) noexcept;

        //---------------------------------------------------------------------
        /// 改行出力関数
        ///
        /// 改行出力関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputNewLine() noexcept;

        //---------------------------------------------------------------------
        /// 行ヘッダー出力関数
        ///
        /// 行ヘッダー出力関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputLineHeader() noexcept;

        //---------------------------------------------------------------------
        /// 行番号更新関数
        ///
        /// 行番号更新関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateLineNumber() noexcept { ++m_nLine; return true; }

        //---------------------------------------------------------------------
        /// 行番号取得関数
        ///
        /// 行番号取得関数です。
        ///
        /// @param     なし
        /// @return    行番号
        /// @attention なし
        ///
        virtual int GetLineNumber() noexcept { return m_nLine; }

        //---------------------------------------------------------------------
        /// インデントカウント取得関数
        ///
        /// インデントカウント取得関数です。
        ///
        /// @param     なし
        /// @return    インデントカウント
        /// @attention なし
        ///
        virtual int GetIndentCount() noexcept { return m_nIndent; }

        //---------------------------------------------------------------------
        /// インデント出力関数
        ///
        /// インデント出力関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputIndent() noexcept;

        //---------------------------------------------------------------------
        /// インデント関数
        ///
        /// インデント関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Indent() noexcept;

        //---------------------------------------------------------------------
        /// アンインデント関数
        ///
        /// アンインデント関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Unindent() noexcept;

        //---------------------------------------------------------------------
        /// 文字列行出力関数
        ///
        /// 文字列行出力関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @param[in] bHeader   行ヘッダ出力フラグ
        /// @param[in] bIndent   インデント出力フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputLineString( wchar_t const* pszString, bool bHeader = true, bool bIndent = true ) noexcept;

        //---------------------------------------------------------------------
        /// 書式設定文字列行出力関数
        ///
        /// 書式設定文字列行出力関数です。
        ///
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] ...       可変長引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputLineFormat( wchar_t const* pszFormat, ... ) noexcept;

        //---------------------------------------------------------------------
        /// 引数リスト文字列行出力関数
        ///
        /// 引数リスト文字列行出力関数です。
        ///
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] vaArgs    引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool OutputLineArgs( wchar_t const* pszFormat, va_list vaArgs ) noexcept;

        //---------------------------------------------------------------------
        /// 拡張書式設定文字列行出力関数
        ///
        /// 拡張書式設定文字列行出力関数です。
        ///
        /// @param[in] bHeader   行ヘッダ出力フラグ
        /// @param[in] bIndent   インデント出力フラグ
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] ...       可変長引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExOutputLineFormat( bool bHeader, bool bIndent, wchar_t const* pszFormat, ... ) noexcept;

        //---------------------------------------------------------------------
        /// 拡張引数リスト文字列行出力関数
        ///
        /// 拡張引数リスト文字列行出力関数です。
        ///
        /// @param[in] bHeader   行ヘッダ出力フラグ
        /// @param[in] bIndent   インデント出力フラグ
        /// @param[in] pszFormat 書式設定文字列
        /// @param[in] vaArgs    引数リスト
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExOutputLineArgs( bool bHeader, bool bIndent, wchar_t const* pszFormat, va_list vaArgs ) noexcept;

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int const FORMAT_BUFFER_SIZE = ( 2048 - 1 ); ///< 書式設定文字列バッファサイズ

        //=====================================================================
        // 限定公開変数
    protected:
        int m_nLine;   ///< 行番号
        int m_nIndent; ///< インデントカウント

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

#pragma managed( pop )