CConsole.h

[詳解]

//=============================================================================
/// @file
/// コンソール入出力クラスヘッダコンソール
///
/// コンソール入出力クラスヘッダコンソールです。
///
/// $Id: CConsole.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 <CStream.h>
#include <CMutex.h>
#include <CEvent.h>
#include <CThread.h>

//=============================================================================
// マクロ定義
#define ConsoleInstance()             LibCommon::CConsole::GetInstance()                            ///< インスタンス取得マクロ
#define ConsoleChar(...)              ConsoleInstance().OutputChar(__VA_ARGS__)                     ///< １文字出力マクロ
#define ConsoleString(...)            ConsoleInstance().OutputString(__VA_ARGS__)                   ///< 文字列出力マクロ
#define ConsoleFormat(...)            ConsoleInstance().OutputFormat(__VA_ARGS__)                   ///< 書式設定文字列出力マクロ
#define ConsoleNewLine()              ConsoleInstance().OutputNewLine()                             ///< 改行出力マクロ
#define ConsoleLineString(...)        ConsoleInstance().OutputLineString(__VA_ARGS__)               ///< 文字列行出力マクロ
#define ConsoleLineFormat(...)        ConsoleInstance().OutputLineFormat(__VA_ARGS__)               ///< 書式設定文字列行出力マクロ
#define ConsoleExLineFormat(...)      ConsoleInstance().ExOutputLineFormat(__VA_ARGS__)             ///< 拡張書式設定文字列行出力マクロ
#define ConsoleNoIndent(...)          ConsoleInstance().ExOutputLineFormat(true,false,__VA_ARGS__)  ///< インデントなし書式設定文字列行出力マクロ
#define ConsoleLine(...)              ConsoleInstance().ExOutputLineFormat(false,false,__VA_ARGS__) ///< ヘッダインデントなし書式設定文字列行出力マクロ
#define ConsoleFunction()             ConsoleLineFormat(L"%s()",__FUNCTIONW__)                      ///< 関数マクロ
#define ConsoleIndent()               ConsoleInstance().Indent()                                    ///< インデントマクロ
#define ConsoleUnindent()             ConsoleInstance().Unindent()                                  ///< アンインデントマクロ
#define ConsoleBlockIn(...)           ConsoleLineFormat(__VA_ARGS__);ConsoleIndent()                ///< ブロック開始マクロ
#define ConsoleBlockOut(...)          ConsoleUnindent();ConsoleLineFormat(__VA_ARGS__)              ///< ブロック終了マクロ
#define ConsoleHeader()               ConsoleBlockIn (L"%s() {",   __FUNCTIONW__)                   ///< 関数ヘッダマクロ
#define ConsoleFooter()               ConsoleBlockOut(L"} // %s()",__FUNCTIONW__)                   ///< 関数フッタマクロ
#define ConsoleInputHandle()          ConsoleInstance().GetInputHandle()                            ///< 入力ハンドル取得マクロ
#define ConsoleOutputHandle()         ConsoleInstance().GetOutputHandle()                           ///< 出力ハンドル取得マクロ
#define ConsoleWindowHandle()         ConsoleInstance().GetWindowHandle()                           ///< ウィンドウハンドル取得マクロ
#define ConsoleGetFontSize(...)       ConsoleInstance().GetFontSize(__VA_ARGS__)                    ///< フォントサイズ取得マクロ
#define ConsoleGetBufferSize(...)     ConsoleInstance().GetSize(__VA_ARGS__)                  ///< 出力バッファサイズ取得マクロ
#define ConsoleBufferSize(...)        ConsoleInstance().SetBufferSize(__VA_ARGS__)                  ///< 出力バッファサイズ設定マクロ
#define ConsoleGetBufferPosition(...) ConsoleInstance().GetBufferPosition(__VA_ARGS__)              ///< 出力バッファ表示位置取得マクロ
#define ConsoleSetBufferPosition(...) ConsoleInstance().SetBufferPosition(__VA_ARGS__)              ///< 出力バッファ表示位置設定マクロ
#define ConsoleGetBufferArea(...)     ConsoleInstance().GetBufferArea(__VA_ARGS__)                  ///< 出力バッファ表示領域取得マクロ
#define ConsoleSetBufferArea(...)     ConsoleInstance().SetBufferArea(__VA_ARGS__)                  ///< 出力バッファ表示領域設定マクロ
#define ConsoleGetWindowArea(...)     ConsoleInstance().GetWindowArea(__VA_ARGS__)                  ///< ウィンドウ表示領域取得マクロ
#define ConsoleSetWindowArea(...)     ConsoleInstance().SetWindowArea(__VA_ARGS__)                  ///< ウィンドウ表示領域設定マクロ
#define ConsoleGetCursorPosition(...) ConsoleInstance().GetCursorPosition(__VA_ARGS__)              ///< カーソル位置取得マクロ
#define ConsoleSetCursorPosition(...) ConsoleInstance().SetCursorPosition(__VA_ARGS__)              ///< カーソル位置設定マクロ
#define ConsoleGetCursor(...)         ConsoleInstance().GetCursor(__VA_ARGS__)                      ///< カーソル位置取得マクロ
#define ConsoleSetCursor(...)         ConsoleInstance().SetCursor(__VA_ARGS__)                      ///< カーソル位置設定マクロ
#define ConsoleScroll(...)            ConsoleInstance().ScrollWindow(__VA_ARGS__)                   ///< スクロールマクロ
#define ConsoleInputCount()           ConsoleInstance().GetInputCount()                             ///< 入力レコード数取得マクロ
#define ConsoleInputChar(...)         ConsoleInstance().InputChar(__VA_ARGS__)                      ///< １文字入力マクロ
#define ConsoleInput(...)             ConsoleInstance().InputString(__VA_ARGS__)                    ///< 文字列入力マクロ
#define ConsoleInputDirect(...)       ConsoleInstance().InputDirect(__VA_ARGS__)                    ///< 直接文字入力マクロ
#define ConsoleKbHitDirect()          ConsoleInstance().KbHitDirect()                               ///< 直接入力検査マクロ
#define ConsoleClearInput()           ConsoleInstance().ClearInputBuffer()                          ///< 入力バッファクリアマクロ
#define ConsoleHitKey(...)            ConsoleInstance().HitAnyKey(__VA_ARGS__)                      ///< キー入力待ちマクロ
#define ConsoleYesNo(...)             ConsoleInstance().YesNoKey(__VA_ARGS__)                       ///< 確認入力待ちマクロ
#define ConsoleStopInput()            ConsoleInstance().StopInput()                                 ///< 入力中止要求マクロ

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// コンソール入出力クラス
    ///
    /// コンソール入出力クラスです。
    ///
    /// @attention シングルトンクラスです。
    ///
    class LIB_COMMON_API CConsole final: public CMutex, public CStream {
        //=====================================================================
        // 公開型定義
        //---------------------------------------------------------------------
        /// 入力レコード構造体
        ///
        /// 入力レコード構造体です。
        ///
        /// @attention なし
        ///
        struct SInputRecord {
            INPUT_RECORD m_sEvent;   ///< 入力イベント構造体
            bool         m_bShift;   ///< シフトキー押下状態フラグ
            bool         m_bControl; ///< コントロールキー押下状態フラグ
            bool         m_bMenu;    ///< オルトキー押下状態フラグ
        };

        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CConsole() noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 入力レコード数取得関数
        ///
        /// 入力レコード数取得関数です。
        ///
        /// @param     なし
        /// @return    入力レコード数
        /// @attention なし
        ///
        inline virtual int GetInputCount() const noexcept { return m_nRecordCount; }

        //---------------------------------------------------------------------
        /// 入力中止要求関数
        ///
        /// 入力中止要求関数です。
        ///
        /// @param     なし
        /// @return    入力レコード数
        /// @attention なし
        ///
        inline virtual void StopInput() noexcept { m_bStopInput = true; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 文字列出力関数
        ///
        /// 文字列出力関数です。
        ///
        /// @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 { return InputChar( rCh, INFINITE ); }

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

        //---------------------------------------------------------------------
        /// １文字入力関数
        ///
        /// １文字入力関数です。
        ///
        /// @param[out] rCh    文字コード参照
        /// @param[in]  dwTime 待機時間
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention なし
        ///
        virtual bool InputChar( wchar_t& rCh, DWORD dwTime ) noexcept;

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

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

        //---------------------------------------------------------------------
        /// 入力バッファクリア関数
        ///
        /// 入力バッファクリア関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual void ClearInputBuffer() noexcept;

        //---------------------------------------------------------------------
        /// 入力レコード取得関数
        ///
        /// 入力レコード取得関数です。
        ///
        /// @param[out] rsRecord 入力レコード参照
        /// @param[in]  dwTime   待機時間
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention なし
        ///
        virtual bool InputRecord( SInputRecord& rsRecord, DWORD dwTime ) noexcept;

        //---------------------------------------------------------------------
        /// キー入力待ち関数
        ///
        /// キー入力待ち関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @param[in] dwTime    待機時間
        /// @return    実行結果
        /// -          0以上 文字コード
        /// -          0未満 タイムアウト
        /// @attention なし
        ///
        virtual int HitAnyKey( wchar_t const* pszString = nullptr, DWORD dwTime = INFINITE ) noexcept;

        //---------------------------------------------------------------------
        /// 確認入力待ち関数
        ///
        /// 確認入力待ち関数です。
        ///
        /// @param[in] pszString 文字列ポインタ
        /// @param[in] dwTime    待機時間
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool YesNoKey( wchar_t const* pszString = nullptr, DWORD dwTime = INFINITE ) noexcept;

        //=====================================================================
        // インライン静的公開関数
    public:
        //---------------------------------------------------------------------
        /// インスタンス取得関数
        ///
        /// インスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    インスタンス参照
        /// @attention なし
        ///
        inline static CConsole& GetInstance() noexcept { return s_cInstance; }

        //---------------------------------------------------------------------
        /// 入力ハンドル取得関数
        ///
        /// 入力ハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    コンソール入力ハンドル
        /// @attention なし
        ///
        inline static HANDLE GetInputHandle() noexcept { return ::GetStdHandle( STD_INPUT_HANDLE ); }

        //---------------------------------------------------------------------
        /// 出力ハンドル取得関数
        ///
        /// 出力ハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    コンソール出力ハンドル
        /// @attention なし
        ///
        inline static HANDLE GetOutputHandle() noexcept { return ::GetStdHandle( STD_OUTPUT_HANDLE ); }

        //---------------------------------------------------------------------
        /// ウィンドウハンドル取得関数
        ///
        /// ウィンドウハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    ウィンドウハンドル
        /// @attention なし
        ///
        inline static HWND GetWindowHandle() noexcept { return ::GetConsoleWindow(); }

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// フォントサイズ取得関数
        ///
        /// フォントサイズ取得関数です。
        ///
        /// @param[out] rnWidth  水平サイズ参照
        /// @param[out] rnHeight 垂直サイズ参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetFontSize( int& rnWidth, int& rnHeight ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファサイズ取得関数
        ///
        /// 出力バッファサイズ取得関数です。
        ///
        /// @param[out] rnWidth  水平サイズ参照
        /// @param[out] rnHeight 垂直サイズ参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetSize( int& rnWidth, int& rnHeight ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファサイズ設定関数
        ///
        /// 出力バッファサイズ設定関数です。
        ///
        /// @param[in] nWidth  水平サイズ
        /// @param[in] nHeight 垂直サイズ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetBufferSize( int nWidth, int nHeight ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファ表示位置取得関数
        ///
        /// 出力バッファ表示位置取得関数です。
        ///
        /// @param[out] rnLeft 左位置参照
        /// @param[out] rnTop  上位置参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetBufferPosition( int& rnLeft, int& rnTop ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファ表示位置設定関数
        ///
        /// 出力バッファ表示位置設定関数です。
        ///
        /// @param[in] nLeft 左位置
        /// @param[in] nTop  上位置
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetBufferPosition( int nLeft, int nTop ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファ表示領域取得関数
        ///
        /// 出力バッファ表示領域取得関数です。
        ///
        /// @param[out] rnLeft   左位置参照
        /// @param[out] rnTop    上位置参照
        /// @param[out] rnWidth  水平サイズ参照
        /// @param[out] rnHeight 垂直サイズ参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetBufferArea( int& rnLeft, int& rnTop, int& rnWidth, int& rnHeight ) noexcept;

        //---------------------------------------------------------------------
        /// 出力バッファ表示領域設定関数
        ///
        /// 出力バッファ表示領域設定関数です。
        ///
        /// @param[in] nLeft   左位置
        /// @param[in] nTop    上位置
        /// @param[in] nWidth  水平サイズ
        /// @param[in] nHeight 垂直サイズ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetBufferArea( int nLeft, int nTop, int nWidth, int nHeight ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示領域取得関数
        ///
        /// ウィンドウ表示領域取得関数です。
        ///
        /// @param[out] rnLeft   左座標参照
        /// @param[out] rnTop    上座標参照
        /// @param[out] rnWidth  水平サイズ参照
        /// @param[out] rnHeight 垂直サイズ参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetWindowArea( int& rnLeft, int& rnTop, int& rnWidth, int& rnHeight ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ表示領域設定関数
        ///
        /// ウィンドウ表示領域設定関数です。
        ///
        /// @param[in] nLeft   左座標
        /// @param[in] nTop    上座標
        /// @param[in] nWidth  水平サイズ
        /// @param[in] nHeight 垂直サイズ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetWindowArea( int nLeft, int nTop, int nWidth, int nHeight ) noexcept;

        //---------------------------------------------------------------------
        /// カーソル位置取得関数
        ///
        /// カーソル位置取得関数です。
        ///
        /// @param[out] rnX 水平位置参照
        /// @param[out] rnY 垂直位置参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetCursorPosition( int& rnX, int& rnY ) noexcept;

        //---------------------------------------------------------------------
        /// カーソル位置設定関数
        ///
        /// カーソル位置設定関数です。
        ///
        /// @param[in] nX 水平位置
        /// @param[in] nY 垂直位置
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetCursorPosition( int nX, int nY ) noexcept;

        //---------------------------------------------------------------------
        /// カーソル位置取得関数
        ///
        /// カーソル位置取得関数です。
        ///
        /// @param[out] rsCursor カーソル位置構造体参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetCursor( COORD& rsCursor ) noexcept;

        //---------------------------------------------------------------------
        /// カーソル位置設定関数
        ///
        /// カーソル位置設定関数です。
        ///
        /// @param[in] rsCursor カーソル位置構造体参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool SetCursor( COORD const& rsCursor ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウスクロール関数
        ///
        /// ウィンドウスクロール関数です。
        ///
        /// @param[in] nX 水平スクロール量
        /// @param[in] nY 垂直スクロール量
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        static bool ScrollWindow( int nX, int nY ) noexcept;

        //---------------------------------------------------------------------
        /// コンソール入力バッファ直接入力関数
        ///
        /// コンソール入力バッファ直接入力関数です。
        ///
        /// @param[out] rCh 文字コード参照
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool InputDirect( wchar_t& rCh ) noexcept;

        //---------------------------------------------------------------------
        /// コンソール入力バッファ直接検査関数
        ///
        /// コンソール入力バッファ直接検査関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  入力あり
        /// -          false 入力なし
        /// @attention なし
        ///
        static bool KbHitDirect() noexcept;

        //=====================================================================
        // 静的限定公開関数
    protected:
        //---------------------------------------------------------------------
        /// サブスレッド関数
        ///
        /// サブスレッド関数です。
        ///
        /// @param[in] lpParam 引数ポインタ
        /// @return    終了コード
        /// @attention なし
        ///
        static DWORD WINAPI SubThreadProc( LPVOID lpParam ) noexcept;

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int const BUFFER_SIZE       = ( 512 - 1 ); ///< 文字列バッファサイズ
        static int const RECORD_SIZE       = 512;         ///< 入力レコードリングバッファサイズ
        static int const KBHIT_RECORD_SIZE = 32;          ///< 直接入力検査レコードバッファサイズ

        //=====================================================================
        // 限定公開変数
    protected:
        wchar_t      m_szBuffer[ BUFFER_SIZE + 1 ];  ///< 文字列バッファ
        SInputRecord m_sRecordBuffer[ RECORD_SIZE ]; ///< 入力レコードリングバッファ
        int          m_nRecordPos;                   ///< 入力レコード先頭位置
        int          m_nRecordCount;                 ///< 入力レコードカウント
        COORD        m_sMaxCursor;                   ///< 最大カーソル位置
        CThread      m_cThreadSub;                   ///< サブスレッド
        bool         m_bStopInput;                   ///< 入力中止要求フラグ

        //=====================================================================
        // 静的限定公開変数
    protected:
        static CConsole s_cInstance; ///< 静的インスタンス

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

#pragma managed( pop )