CConsoleMenu.h

[詳解]

//=============================================================================
/// @file
/// コンソールメニュークラスヘッダファイル
///
/// コンソールメニュークラスヘッダファイルです。
///
/// $Id: CConsoleMenu.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 <CMutex.h>
#include <CEvent.h>
#include <CThread.h>

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// コンソールメニュークラス
    ///
    /// コンソールメニュークラスです。
    ///
    /// @attention なし
    ///
    class LIB_COMMON_API CConsoleMenu: public CMutex {
        //=====================================================================
        // 限定公開型定義
    protected:
        //---------------------------------------------------------------------
        /// メニュー項目情報構造体
        ///
        /// メニュー項目情報構造体です。
        ///
        /// @attention なし
        ///
        struct SMenuItemInfo {
            wchar_t const* const m_pszItemName; ///< 項目名称
            bool                 m_bSubMenu;    ///< サブメニューフラグ
        };

        //---------------------------------------------------------------------
        /// メニュー定義情報構造体
        ///
        /// メニュー定義情報構造体です。
        ///
        /// @attention なし
        ///
        struct SMenuInfo {
            wchar_t const* const m_pszName;    ///< メニュー名称
            int const            m_nCount;     ///< メニュー項目数
            SMenuItemInfo const* m_psItemInfo; ///< メニュー項目情報構造体配列ポインタ
        };

        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] psMenuInfo メニュー定義情報構造体ポインタ
        /// @return    なし
        /// @attention なし
        ///
        explicit CConsoleMenu( SMenuInfo const* psMenuInfo ) noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 実行状態取得関数
        ///
        /// 実行状態取得関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  実行中
        /// -          false 非実行中
        /// @attention なし
        ///
        inline virtual bool IsExecMenu() noexcept { return ( ( nullptr != m_cThreadSub.GetHandle() ) && !m_cThreadSub.Wait( 0 ) ); }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// メニュー開始関数
        ///
        /// メニュー開始関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool StartMenu() noexcept;

        //---------------------------------------------------------------------
        /// メニュー実行関数
        ///
        /// メニュー実行関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExecMenu() noexcept;

        //---------------------------------------------------------------------
        /// メニュー中止要求関数
        ///
        /// メニュー中止要求関数です。
        ///
        /// @param     なし
        /// @return    入力レコード数
        /// @attention なし
        ///
        virtual void StopMenu() noexcept;

        //---------------------------------------------------------------------
        /// メニュー終了待ち関数
        ///
        /// メニュー終了待ち関数です。
        ///
        /// @param[in] dwTime 待機時間
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool WaitForMenuFinish( DWORD dwTime = INFINITE ) noexcept { return m_cThreadSub.Wait( dwTime ); }

        //---------------------------------------------------------------------
        /// 終了可能状態取得関数
        ///
        /// 終了可能状態取得関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  終了可能
        /// -          false 終了不可能
        /// @attention なし
        ///
        virtual bool CanBeExit() const noexcept { return true; }

        //---------------------------------------------------------------------
        /// サブメニュー取得関数
        ///
        /// サブメニュー取得関数です。
        ///
        /// @param     なし
        /// @return    コンソールメニュークラスポインタ
        /// @attention なし
        ///
        virtual CConsoleMenu* GetSubMenu() const noexcept { return nullptr; }

        //---------------------------------------------------------------------
        /// メニューコールバック関数
        ///
        /// メニューコールバック関数です。
        ///
        /// @param[in] bPreCallBack 事前コールバックフラグ
        /// @return    実行結果
        /// -          true  継続
        /// -          false 中止
        /// @attention なし
        ///
        virtual bool MenuCallBackProc( bool bPreCallBack = false ) noexcept { return bPreCallBack; }

        //=====================================================================
        // 限定公開関数
    protected:
        //---------------------------------------------------------------------
        /// サブスレッド実行関数
        ///
        /// サブスレッド実行関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExecSubThread() noexcept;

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

        //=====================================================================
        // 限定公開変数
    protected:
        SMenuInfo const* m_psMenuInfo;    ///< メニュー定義情報構造体ポインタ
        CEvent           m_cEventRequest; ///< 要求イベント
        CEvent           m_cEventNotify;  ///< 通知イベント
        CEvent           m_cEventFinish;  ///< 終了イベント
        CThread          m_cThreadSub;    ///< サブスレッド
        int              m_nMenuIndex;    ///< メニュー項目インデックス
        int              m_nRepeat;       ///< リピートカウント
        bool             m_bRepeat;       ///< リピート実行フラグ
        bool             m_bSubMenu;      ///< サブメニュー要求フラグ
        CConsoleMenu*    m_pcSubMenu;     ///< サブメニューポインタ
        CConsoleMenu*    m_pcParent;      ///< 親メニューポインタ

        //=====================================================================
        // 静的限定公開定数
    protected:
        static wchar_t const* const ITEM_KEY_LIST; ///< 項目選択文字リスト

        //=====================================================================
        // 静的限定公開変数
    protected:
        static bool s_bStopMenu; ///< メニュー中止要求フラグ

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

#pragma managed( pop )