LibNewDel.h

[詳解]

//=============================================================================
/// @file
/// 生成消滅演算子ライブラリヘッダファイル
///
/// 生成消滅演算子ライブラリヘッダファイルです。
///
/// $Id: LibNewDel.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 <LibNewDelDef.h>
#include <CMapping.h>

//=============================================================================
// マクロ定義
#define NewDelInstance()          LibNewDel::CLibNewDel::GetInstance()               ///< インスタンス取得マクロ
#define NewDelOperatorNew(...)    NewDelInstance().NotifyOperatorNew(__VA_ARGS__)    ///< 生成演算子実行通知マクロ
#define NewDelOperatorDelete(...) NewDelInstance().NotifyOperatorDelete(__VA_ARGS__) ///< 消滅演算子実行通知マクロ
#define NewDelLogOut()            NewDelInstance().GetLogOutFlag()                   ///< ログ出力許可フラグ取得マクロ

//=============================================================================
// 生成消滅演算子ライブラリ名前空間
namespace LibNewDel {
    //=========================================================================
    /// 生成消滅演算子ライブラリクラス
    ///
    /// 生成消滅演算子ライブラリクラスです。
    ///
    /// @attention シングルトンクラスです。
    ///
    class LIB_NEWDEL_API CLibNewDel final: public CMapping {
        //=====================================================================
        // 構築子と解体子
    protected:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CLibNewDel() noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// ログ出力許可状態取得関数
        ///
        /// ログ出力許可状態取得関数です。
        ///
        /// @param     なし
        /// @return    ログ出力許可フラグ参照
        /// @attention なし
        ///
        inline virtual bool& GetLogOutFlag() noexcept { return m_bLogOut; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 生成演算子実行通知関数
        ///
        /// 生成演算子実行通知関数です。
        ///
        /// @param[in] pAddr       メモリアドレス
        /// @param[in] uSize       メモリサイズ
        /// @param[in] pszFuncName 関数名
        /// @return    なし
        /// @attention なし
        ///
        virtual void NotifyOperatorNew( void* pAddr, size_t uSize, wchar_t const* pszFuncName ) noexcept;

        //---------------------------------------------------------------------
        /// 消滅演算子実行通知関数
        ///
        /// 消滅演算子実行通知関数です。
        ///
        /// @param[in] pAddr       メモリアドレス
        /// @param[in] uSize       メモリサイズ
        /// @param[in] pszFuncName 関数名
        /// @return    なし
        /// @attention なし
        ///
        virtual void NotifyOperatorDelete( void* pAddr, size_t uSize, wchar_t const* pszFuncName ) noexcept;

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

        //---------------------------------------------------------------------
        /// 生成消滅演算子ログ出力関数
        ///
        /// 生成消滅演算子ログ出力関数です。
        ///
        /// @param[in] nCount      生成消滅カウント
        /// @param[in] pAddr       メモリアドレス
        /// @param[in] uSize       メモリサイズ
        /// @param[in] nTotalSize  トータルメモリサイズ
        /// @param[in] nMaxSize    最大メモリサイズ
        /// @param[in] pszFuncName 関数名
        /// @return    なし
        /// @attention なし
        ///
        virtual void LogOutOperatorNewDelete( int nCount, void* pAddr, size_t uSize, LONGLONG nTotalSize, LONGLONG nMaxSize, wchar_t const* pszFuncName ) noexcept;

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

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

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

        //=====================================================================
        // 静的限定公開定数
    protected:
        static int const PROCESS_MAX = 256; ///< 最大参照プロセス数

        //=====================================================================
        // 限定公開型定義
    protected:
        //---------------------------------------------------------------------
        /// 参照プロセス情報構造体
        ///
        /// 参照プロセス情報構造体です。
        ///
        /// @attention なし
        ///
        struct SProcessInfo {
            DWORD    m_dwProcessId; ///< プロセスID
            int      m_nCount;      ///< 生成消滅カウント
            LONGLONG m_nTotalSize;  ///< トータルメモリサイズ
        };

        //---------------------------------------------------------------------
        /// 共有メモリ情報構造体
        ///
        /// 共有メモリ情報構造体です。
        ///
        /// @attention なし
        ///
        struct SMappingInfo {
            int          m_nReffer;                 ///< 参照カウント
            int          m_nCount;                  ///< 生成消滅カウント
            LONGLONG     m_nTotalSize;              ///< トータルメモリサイズ
            LONGLONG     m_nMaxSize;                ///< 最大メモリサイズ
            SProcessInfo m_sProcess[ PROCESS_MAX ]; ///< 参照プロセス情報構造体配列
        };

        //=====================================================================
        // 限定公開変数
    protected:
        SMappingInfo* m_psMappingInfo; ///< 共有メモリ情報構造体ポインタ
        bool          m_bLogOut;       ///< ログ出力許可フラグ

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const OBJECT_NAME; ///< オブジェクト名

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

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

#pragma managed( pop )