LibUtility.h

[詳解]

//=============================================================================
/// @file
/// ユーティリティライブラリヘッダファイル
///
/// ユーティリティライブラリヘッダファイルです。
///
/// $Id: LibUtility.h 249 2019-03-21 18:16:30Z admin $
/// $Date: 2019-03-22 03:16:30 +0900 (2019/03/22 (金)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <LibCommonDef.h>

//=============================================================================
// マクロ定義
#define NotifyFatalError()  LibCommon::UtilNotifyFatalError(__FILEW__,__FUNCTIONW__,__LINE__) ///< 致命的エラー発生通知マクロ
#define NotifyDllMain(...)  LibCommon::UtilNotifyDllMain(__VA_ARGS__)                         ///< DLLメイン関数実行通知マクロ
#define NotifyConstructor() LibCommon::UtilNotifyConstructor(__FUNCTIONW__)                   ///< コンストラクタ実行通知マクロ
#define NotifyDestructor()  LibCommon::UtilNotifyDestructor(__FUNCTIONW__)                    ///< デストラクタ実行通知マクロ

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    // グローバル型定義
    //-------------------------------------------------------------------------
    /// ウィンドウ表示位置種別列挙体
    ///
    /// ウィンドウ表示位置種別列挙体です。
    ///
    /// @attention なし
    ///
    enum class EWindowPosition {
        Left,   ///< 左
        Top,    ///< 上
        Right,  ///< 右
        Bottom, ///< 下
        Full,   ///< フルサイズ
        Size    ///< 列挙体サイズ
    };

    //=========================================================================
    // グローバル関数
    //-------------------------------------------------------------------------
    /// 致命的エラー発生通知関数
    ///
    /// 致命的エラー発生通知関数です。
    ///
    /// @param[in] pszFileName ファイル名
    /// @param[in] pszFuncName 関数名
    /// @param[in] uLineNumber 行番号
    /// @return    なし
    /// @attention なし
    ///
    LIB_COMMON_API void UtilNotifyFatalError( wchar_t const* pszFileName, wchar_t const* pszFuncName, UINT uLineNumber ) noexcept;

    //-------------------------------------------------------------------------
    /// DLLメイン関数実行通知関数
    ///
    /// DLLメイン関数実行通知関数です。
    ///
    /// @param[in] hInstance DLLモジュールハンドル
    /// @param[in] dwReason  関数を呼び出す理由
    /// @return    なし
    /// @attention なし
    ///
    LIB_COMMON_API void UtilNotifyDllMain( HINSTANCE hInstance, DWORD dwReason ) noexcept;

    //-------------------------------------------------------------------------
    /// コンストラクタ実行通知関数
    ///
    /// コンストラクタ実行通知関数です。
    ///
    /// @param[in] pszFuncName 関数名
    /// @return    なし
    /// @attention なし
    ///
    LIB_COMMON_API void UtilNotifyConstructor( wchar_t const* pszFuncName ) noexcept;

    //-------------------------------------------------------------------------
    /// デストラクタ実行通知関数
    ///
    /// デストラクタ実行通知関数です。
    ///
    /// @param[in] pszFuncName 関数名
    /// @return    なし
    /// @attention なし
    ///
    LIB_COMMON_API void UtilNotifyDestructor( wchar_t const* pszFuncName ) noexcept;

    //-------------------------------------------------------------------------
    /// メッセージ表示関数
    ///
    /// メッセージ表示関数です。
    ///
    /// @param[in] pszMessage メッセージ文字列
    /// @param[in] hWnd       ウィンドウハンドル
    /// @param[in] uType      メッセージ種別
    /// @return    実行結果
    /// @attention なし
    ///
    LIB_COMMON_API int ShowMessage( wchar_t const* pszMessage, HWND hWnd = nullptr, UINT uType = ( MB_OK | MB_ICONEXCLAMATION ) ) noexcept;

    //-------------------------------------------------------------------------
    /// デバッグ出力関数
    ///
    /// デバッグ出力関数です。
    ///
    /// @param[in] pszFormat 書式設定文字列
    /// @param[in] ...       可変長引数リスト
    /// @return    なし
    /// @attention なし
    ///
    LIB_COMMON_API void OutputDebugFormat( wchar_t const* pszFormat, ... ) noexcept;

    //-------------------------------------------------------------------------
    /// 書式設定文字列展開関数
    ///
    /// 書式設定文字列展開関数です。
    ///
    /// @param[out] pszBuffer 文字列バッファポインタ
    /// @param[in]  uSize     バッファサイズ
    /// @param[in]  pszFormat 書式設定文字列
    /// @param[in]  vaArgs    引数リスト
    /// @return     実行結果
    /// -           true  成功
    /// -           false 失敗
    /// @attention  なし
    ///
    LIB_COMMON_API bool ExpandFormatArgs( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszFormat, va_list vaArgs ) noexcept;

    //-------------------------------------------------------------------------
    /// 実行ファイルパス取得関数
    ///
    /// 実行ファイルパス取得関数です。
    ///
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetExeFilePath( wchar_t* pszBuffer, size_t uSize ) noexcept;

    //-------------------------------------------------------------------------
    /// 実行ファイルディレクトリパス取得関数
    ///
    /// 実行ファイルディレクトリパス取得関数です。
    ///
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetExeFileDir( wchar_t* pszBuffer, size_t uSize ) noexcept;

    //-------------------------------------------------------------------------
    /// 実行ファイル名取得関数
    ///
    /// 実行ファイル名取得関数です。
    ///
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetExeFileName( wchar_t* pszBuffer, size_t uSize ) noexcept;

    //-------------------------------------------------------------------------
    /// ディレクトリパス取得関数
    ///
    /// ディレクトリパス取得関数です。
    ///
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @param[in] pszPath   ファイルパス
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetDirPath( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszPath ) noexcept;

    //-------------------------------------------------------------------------
    /// ファイル名取得関数
    ///
    /// ファイル名取得関数です。
    ///
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @param[in] pszPath   ファイルパス
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetFileName( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszPath ) noexcept;

    //-------------------------------------------------------------------------
    /// モジュール名取得関数
    ///
    /// モジュール名取得関数です。
    ///
    /// @param[in] hInstance インスタンスハンドル
    /// @param[in] pszBuffer 文字列バッファポインタ
    /// @param[in] uSize     バッファサイズ
    /// @return    文字列ポインタ
    /// @attention なし
    ///
    LIB_COMMON_API wchar_t const* GetModuleName( HINSTANCE hInstance, wchar_t* pszBuffer = nullptr, size_t uSize = 0 ) noexcept;

    //---------------------------------------------------------------------
    /// 文字コード比較関数
    ///
    /// 文字コード比較関数です。
    ///
    /// @param[in] ch1     比較元文字コード
    /// @param[in] ch2     比較先文字コード
    /// @param[in] bIgnore 最小文字無視フラグ
    /// @return    比較結果
    /// -          true  一致
    /// -          false 不一致
    /// @attention なし
    ///
    LIB_COMMON_API bool CompareCharCode( wchar_t ch1, wchar_t ch2, bool bIgnore ) noexcept;

    //---------------------------------------------------------------------
    /// 文字コード比較関数
    ///
    /// 文字コード比較関数です。
    ///
    /// @param[in] ch        比較元文字コード
    /// @param[in] pszString 比較先文字列ポインタ
    /// @param[in] bIgnore   最小文字無視フラグ
    /// @return    比較結果
    /// -          true  一致
    /// -          false 不一致
    /// @attention なし
    ///
    LIB_COMMON_API bool CompareCharCode( wchar_t ch, wchar_t const* pszString, bool bIgnore ) noexcept;

    //-------------------------------------------------------------------------
    /// ウィンドウ表示位置設定関数
    ///
    /// ウィンドウ表示位置設定関数です。
    ///
    /// @param[in] hWnd ウィンドウハンドル
    /// @param[in] ePos ウィンドウ表示位置種別
    /// @return    実行結果
    /// -          true  成功
    /// -          false 失敗
    /// @attention なし
    ///
    LIB_COMMON_API bool SetWindowPosition( HWND hWnd, EWindowPosition ePos ) noexcept;

    //-------------------------------------------------------------------------
    /// プロセス検索関数
    ///
    /// プロセス検索関数です。
    ///
    /// @param[in] pszPath プロセス実行ファイルパス
    /// @return    プロセス識別子
    /// @attention なし
    ///
    LIB_COMMON_API DWORD SearchProcess( wchar_t const* pszPath );
}

#pragma managed( pop )