LibLogOut.h

[詳解]

//=============================================================================
/// @file
/// ログ出力ライブラリヘッダファイル
///
/// ログ出力ライブラリヘッダファイルです。
///
/// $Id: LibLogOut.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 <LibLogOutDef.h>
#include <CMapping.h>
#include <CStreamOut.h>
#include <CEvent.h>
#include <CFileStream.h>
#include <CThread.h>

//=============================================================================
// マクロ定義
#define LogOutDebug             LibLogOut::CLibLogOut::EOutputDevice::Debug                   ///< デバッグ出力デバイスマクロ
#define LogOutConsole           LibLogOut::CLibLogOut::EOutputDevice::Console                 ///< コンソール出力デバイスマクロ
#define LogOutFile              LibLogOut::CLibLogOut::EOutputDevice::File                    ///< ファイル出力デバイスマクロ
#define LogOutDeviceMax         LibLogOut::CLibLogOut::DEVICE_MAX                             ///< 出力デバイス最大値マクロ
#define LogOutInstance()        LibLogOut::CLibLogOut::GetInstance()                          ///< インスタンス取得マクロ
#define LogOutChar(...)         LogOutInstance().OutputChar(__VA_ARGS__)                      ///< １文字出力マクロ
#define LogOutString(...)       LogOutInstance().OutputString(__VA_ARGS__)                    ///< 文字列出力マクロ
#define LogOutFormat(...)       LogOutInstance().OutputFormat(__VA_ARGS__)                    ///< 書式設定文字列出力マクロ
#define LogOutNewLine()         LogOutInstance().OutputNewLine()                              ///< 改行出力マクロ
#define LogOutLineString(...)   LogOutInstance().OutputLineString(__VA_ARGS__)                ///< 文字列行出力マクロ
#define LogOutLineFormat(...)   LogOutInstance().OutputLineFormat(__VA_ARGS__)                ///< 書式設定文字列行出力マクロ
#define LogOutExLineFormat(...) LogOutInstance().ExOutputLineFormat(__VA_ARGS__)              ///< 拡張書式設定文字列行出力マクロ
#define LogOutNoIndent(...)     LogOutInstance().ExOutputLineFormat(true,false,__VA_ARGS__)   ///< インデントなし書式設定文字列行出力マクロ
#define LogOutLine(...)         LogOutInstance().ExOutputLineFormat(false,false,__VA_ARGS__)  ///< ヘッダインデントなし書式設定文字列行出力マクロ
#define LogOutExeFile()         LogOutInstance().GetExeFile()                                 ///< 実行ファイル名取得マクロ
#define LogOutFunction()        LogOutLineFormat(L"%s!%s()",LogOutExeFile(),__FUNCTIONW__)    ///< 関数マクロ
#define LogOutIndent()          LogOutInstance().Indent()                                     ///< インデントマクロ
#define LogOutUnindent()        LogOutInstance().Unindent()                                   ///< アンインデントマクロ
#define LogOutBlockIn(...)      LogOutLineFormat(__VA_ARGS__);LogOutIndent()                  ///< ブロック開始マクロ
#define LogOutBlockOut(...)     LogOutUnindent();LogOutLineFormat(__VA_ARGS__)                ///< ブロック終了マクロ
#define LogOutHeader()          LogOutBlockIn (L"%s!%s() {",   LogOutExeFile(),__FUNCTIONW__) ///< 関数ヘッダマクロ
#define LogOutRefferCount()     LogOutInstance().GetRefferCount()                             ///< 参照プロセスカウント取得マクロ
#define LogOutBufferCount()     LogOutInstance().GetCount()                             ///< バッファカウント取得マクロ
#define LogOutFooter()          LogOutBlockOut(L"} // %s!%s()",LogOutExeFile(),__FUNCTIONW__) ///< 関数フッタマクロ
#define LogOutFlush()           LogOutInstance().Flush()                                      ///< フラッシュマクロ
#define LogOutDevice(...)       LogOutInstance().SetDeviceProcess(__VA_ARGS__)                ///< 出力デバイスプロセス設定マクロ

//=============================================================================
// ログ出力ライブラリ名前空間
namespace LibLogOut {
    //=========================================================================
    /// ログ出力ライブラリクラス
    ///
    /// ログ出力ライブラリクラスです。
    ///
    /// @attention シングルトンクラスです。
    ///
    class LIB_LOGOUT_API CLibLogOut final: public CMapping, public CStreamOut {
        //=====================================================================
        // 公開型定義
    public:
        //---------------------------------------------------------------------
        /// 出力デバイス種別列挙体
        ///
        /// 出力デバイス種別列挙体です。
        ///
        /// @attention なし
        ///
        enum class EOutputDevice {
            Debug = 0, ///< デバッグ出力
            Console,   ///< コンソール出力
            File,      ///< ファイル出力
            Size       ///< 列挙体サイズ
        };

        //=====================================================================
        // 静的公開定数
    public:
        static int const DEVICE_MAX = static_cast< int >( EOutputDevice::Size ); ///< 出力デバイス最大値

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

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 実行ファイル名取得関数
        ///
        /// 実行ファイル名取得関数です。
        ///
        /// @param     なし
        /// @return    文字列ポインタ
        /// @attention なし
        ///
        inline virtual wchar_t const* GetExeFile() noexcept { return m_szExeFile; }

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

        //---------------------------------------------------------------------
        /// 行番号更新関数
        ///
        /// 行番号更新関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバーライド関数です。
        ///
        virtual bool UpdateLineNumber() noexcept override;

        //---------------------------------------------------------------------
        /// 行番号取得関数
        ///
        /// 行番号取得関数です。
        ///
        /// @param     なし
        /// @return    行番号
        /// @attention オーバーライド関数です。
        ///
        virtual int GetLineNumber() noexcept override;

        //---------------------------------------------------------------------
        /// インデントカウント取得関数
        ///
        /// インデントカウント取得関数です。
        ///
        /// @param     なし
        /// @return    インデントカウント
        /// @attention オーバライド関数です。
        ///
        virtual int GetIndentCount() noexcept override;

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

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

        //---------------------------------------------------------------------
        /// 参照プロセスカウント取得関数
        ///
        /// 参照プロセスカウント取得関数です。
        ///
        /// @param     なし
        /// @return    バッファカウント
        /// @attention なし
        ///
        virtual int GetRefferCount() noexcept;

        //---------------------------------------------------------------------
        /// バッファカウント取得関数
        ///
        /// バッファカウント取得関数です。
        ///
        /// @param     なし
        /// @return    バッファカウント
        /// @attention なし
        ///
        virtual int GetCount() noexcept;

        //---------------------------------------------------------------------
        /// フラッシュ関数
        ///
        /// フラッシュ関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Flush() noexcept;

        //---------------------------------------------------------------------
        /// 出力デバイスプロセス設定関数
        ///
        /// 出力デバイスプロセス設定関数です。
        ///
        /// @param[in] eDevice     デバイス種別
        /// @param[in] dwProcessId プロセスID
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetDeviceProcess( EOutputDevice eDevice, DWORD dwProcessId ) noexcept;

        //=====================================================================
        // 限定公開関数
    protected:
        //---------------------------------------------------------------------
        /// プロセス情報更新関数
        ///
        /// プロセス情報更新関数です。
        ///
        /// @param[in] bCurrent カレントプロセス削除フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateProcessInfo( bool bCurrent = false ) noexcept;

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

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

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// プロジェクト種別取得関数
        ///
        /// プロジェクト種別取得関数です。
        ///
        /// @param     なし
        /// @return    文字列ポインタ
        /// @attention なし
        ///
        static wchar_t const* GetProjectType() noexcept;

        //---------------------------------------------------------------------
        /// インスタンスハンドル取得関数
        ///
        /// インスタンスハンドル取得関数です。
        ///
        /// @param     なし
        /// @return    インスタンスハンドル
        /// @attention なし
        ///
        static HINSTANCE GetInstanceHandle() noexcept;

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

        //---------------------------------------------------------------------
        /// 新規ログ出力ファイルパス取得関数
        ///
        /// 新規ログ出力ファイルパス取得関数です。
        ///
        /// @param[out] pszPath 文字列バッファポインタ
        /// @param[in]  nSize   バッファサイズ
        /// @return     実行結果
        /// -           true  成功
        /// -           false 失敗
        /// @attention  なし
        ///
        static bool GetNewLogFilePath( wchar_t* pszPath, int nSize ) noexcept;

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int   const BUFFER_SIZE = ( 1024 * 1024 - 1 ); ///< 文字列バッファサイズ
        static int   const PROCESS_MAX = 256;                 ///< 最大参照プロセス数
        static DWORD const NOTIFY_WAIT = 3000;                ///< 通知イベント待機時間

        //=====================================================================
        // 限定公開型定義
    protected:
        //---------------------------------------------------------------------
        /// 参照プロセス情報構造体
        ///
        /// 参照プロセス情報構造体です。
        ///
        /// @attention なし
        ///
        struct SProcessInfo {
            DWORD m_dwProcessId; ///< プロセスID
            int   m_nIndent;     ///< インデントカウント
        };

        //---------------------------------------------------------------------
        /// 共有メモリ情報構造体
        ///
        /// 共有メモリ情報構造体です。
        ///
        /// @attention なし
        ///
        struct SMappingInfo {
            int           m_nReffer;                     ///< 参照プロセスカウント
            wchar_t       m_szBuffer[ BUFFER_SIZE + 1 ]; ///< 文字列バッファ
            int           m_nCount;                      ///< バッファカウント
            int           m_nIndent;                     ///< インデントカウント
            int           m_nLine;                       ///< 行番号
            wchar_t       m_szPath[ MAX_PATH ];          ///< ログ出力ファイルパス
            bool          m_bEnable[ DEVICE_MAX ];       ///< 出力許可フラグ配列
            DWORD         m_dwProcessId[ DEVICE_MAX ];   ///< 出力プロセスID配列
            SProcessInfo  m_sProcess[ PROCESS_MAX ];     ///< 参照プロセス情報構造体配列
            EOutputDevice m_eDevice;                     ///< 出力要求デバイス種別
            int           m_nRequestPos;                 ///< 出力要求開始位置
            int           m_nRequestSize;                ///< 出力要求サイズ
        };

        //=====================================================================
        // 限定公開変数
    protected:
        SMappingInfo* m_psMappingInfo;         ///< 共有メモリ情報構造体ポインタ
        CEvent        m_cEventRequest;         ///< 要求イベント
        CEvent        m_cEventNotify;          ///< 通知イベント
        CFileStream   m_cFileLog;              ///< ログ出力ファイル
        CThread       m_cThreadSub;            ///< サブスレッド
        wchar_t       m_szExeFile[ MAX_PATH ]; ///< 実行ファイル名

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const OBJECT_NAME;          ///< オブジェクト名
        static wchar_t const* const EVENT_REQUEST_FORMAT; ///< 要求イベント名書式設定文字列
        static wchar_t const* const EVENT_NOTIFY_NAME;    ///< 通知イベント名

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

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

#pragma managed( pop )