LibUtility.cpp

[詳解]

//=============================================================================
/// @file
/// ユーティリティライブラリ実装ファイル
///
/// ユーティリティライブラリ実装ファイルです。
///
/// $Id: LibUtility.cpp 254 2019-03-25 19:47:20Z admin $
/// $Date: 2019-03-26 04:47:20 +0900 (2019/03/26 (火)) $
/// $Author: admin $
///
/// @attention なし

#pragma managed( push, off )

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

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    // グローバル関数
    //-------------------------------------------------------------------------
    // 致命的エラー発生通知関数
    void UtilNotifyFatalError( wchar_t const* pszFileName, wchar_t const* pszFuncName, UINT uLineNumber ) noexcept {
        // 実行ファイル名を取得する
        wchar_t szExeName[ MAX_PATH ];
        GetExeFileName( szExeName, MAX_PATH );

        // ソースファイル名を取得する
        wchar_t szFileName[ MAX_PATH ];
        GetFileName( szFileName, MAX_PATH, pszFileName );

        // カレントプロセスIDを取得する
        DWORD dwProcessId = ::GetCurrentProcessId();

        // カレントスレッドIDを取得する
        DWORD dwThreadId = ::GetCurrentThreadId();

        // デバッグ出力する
        wchar_t szBuffer[ 2048 ];
        ::swprintf_s( szBuffer, L"★以下の場所で致命的エラーが発生したためプログラムを終了します。\n"
            "実行ファイル名：%s\n"
            "ファイル名：%s\n"
            "関数名：%s\n"
            "行番号：%u\n"
            "プロセスID：0x%04X\n"
            "スレッドID：0x%04X\n"
            , szExeName
            , szFileName
            , pszFuncName
            , uLineNumber
            , dwProcessId
            , dwThreadId );
        OutputDebugFormat( szBuffer );

        // メッセージボックスを表示する
        int nResult = ::MessageBoxW( nullptr, szBuffer, L"★致命的エラー", MB_OKCANCEL | MB_ICONHAND );
        if ( IDOK == nResult ) {
            // アプリケーションを終了する
            // ::abort();
            ::exit( -1 );
        }
    }

    //-------------------------------------------------------------------------
    // DLLメイン関数実行通知関数
    void UtilNotifyDllMain( HINSTANCE hInstance, DWORD dwReason ) noexcept {
        // 処理ブロック
        do {
            // 関数を呼び出す理由を調べる
            wchar_t const* pszReason = nullptr;
            switch ( dwReason ) {
            case DLL_PROCESS_ATTACH: pszReason = L"プロセスアタッチ"; break;
            case DLL_THREAD_ATTACH:  pszReason = L"スレッドアタッチ"; break;
            case DLL_THREAD_DETACH:  pszReason = L"スレッドデタッチ"; break;
            case DLL_PROCESS_DETACH: pszReason = L"プロセスデタッチ"; break;
            }

            // 文字列ポインタを調べる
            if ( nullptr == pszReason ) {
                // 失敗！
                break;
            }

            // 実行ファイル名を取得する
            wchar_t szExeFile[ MAX_PATH ];
            GetExeFileName( szExeFile, MAX_PATH );

            // モジュールファイル名を取得する
            wchar_t szPath[ MAX_PATH ];
            ::GetModuleFileNameW( hInstance, szPath, MAX_PATH );

            // カレントプロセスIDを取得する
            DWORD dwProcessId = ::GetCurrentProcessId();

            // カレントスレッドIDを取得する
            DWORD dwThreadId = ::GetCurrentThreadId();

            // デバッグ出力する
            OutputDebugFormat( L"★%s：[%04X:%04X] %s, %s\n", pszReason, dwProcessId, dwThreadId, szExeFile, szPath );
        } while ( false );
    }

    //-------------------------------------------------------------------------
    // コンストラクタ実行通知関数
    void UtilNotifyConstructor( wchar_t const* pszFuncName ) noexcept {
        // 実行ファイル名を取得する
        wchar_t szExeFile[ MAX_PATH ];
        GetExeFileName( szExeFile, MAX_PATH );

        // カレントプロセスIDを取得する
        DWORD dwProcessId = ::GetCurrentProcessId();

        // カレントスレッドIDを取得する
        DWORD dwThreadId = ::GetCurrentThreadId();

        // デバッグ出力する
        OutputDebugFormat( L"▼コンストラクタ：[%04X:%04X] %s!%s\n", dwProcessId, dwThreadId, szExeFile, pszFuncName );
    }

    //-------------------------------------------------------------------------
    // デストラクタ実行通知関数
    void UtilNotifyDestructor( wchar_t const* pszFuncName ) noexcept {
        // 実行ファイル名を取得する
        wchar_t szExeFile[ MAX_PATH ];
        GetExeFileName( szExeFile, MAX_PATH );

        // カレントプロセスIDを取得する
        DWORD dwProcessId = ::GetCurrentProcessId();

        // カレントスレッドIDを取得する
        DWORD dwThreadId = ::GetCurrentThreadId();

        // デバッグ出力する
        OutputDebugFormat( L"▲デストラクタ：[%04X:%04X] %s!%s\n", dwProcessId, dwThreadId, szExeFile, pszFuncName );
    }

    //-------------------------------------------------------------------------
    // メッセージ表示関数
    int ShowMessage( wchar_t const* pszMessage, HWND hWnd, UINT uType ) noexcept {
        // 処理ブロック
        int result = 0;
        do {
            // ウィンドウハンドルを調べる
            wchar_t szCaption[ MAX_PATH ] = L"メッセージ";
            if ( nullptr != hWnd ) {
                // ウィンドウタイトルを取得する
                ::GetWindowTextW( hWnd, szCaption, MAX_PATH );
            }

            // メッセージボックスを表示する
            result = ::MessageBoxW( hWnd, pszMessage, szCaption, uType );
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // デバッグ出力関数
    void OutputDebugFormat( wchar_t const* pszFormat, ... ) noexcept {
        // 処理ブロック
        do {
            // 書式設定文字列ポインタを調べる
            if ( nullptr == pszFormat ) {
                // 失敗！
                break;
            }

            // 引数リストを作成する
            va_list vaArgs;
            va_start( vaArgs, pszFormat );

            // 書式設定文字列を展開する
            wchar_t szBuffer[ MAX_PATH ];
            if ( !ExpandFormatArgs( szBuffer, ( MAX_PATH ), pszFormat, vaArgs ) ) {
                // 失敗！
                break;
            }

            // 引数リストを解放する
            va_end( vaArgs );

            // デバッグコンソールに文字列を出力する
            ::OutputDebugStringW( szBuffer );
        } while ( false );
    }

    //-------------------------------------------------------------------------
    // 書式設定文字列展開関数
    bool ExpandFormatArgs( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszFormat, va_list vaArgs ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }
            // 書式設定文字列ポインタを調べる
            else if ( nullptr == pszFormat ) {
                // 失敗！
                break;
            }
            // 書式設定文字列を展開する
            else if ( 0 >= ::vswprintf_s( pszBuffer, uSize, pszFormat, vaArgs ) ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 実行ファイルパス取得関数
    wchar_t const* GetExeFilePath( wchar_t* pszBuffer, size_t uSize ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }

            // 実行ファイルパスを取得する
            ::GetModuleFileNameW( nullptr, pszBuffer, static_cast< DWORD >( uSize ) );

            // 成功！
            result = pszBuffer;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 実行ファイルディレクトリパス取得関数
    wchar_t const* GetExeFileDir( wchar_t* pszBuffer, size_t uSize ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }

            // 実行ファイルパスを取得する
            wchar_t szPath[ MAX_PATH ];
            GetExeFilePath( szPath, MAX_PATH );

            // ディレクトリパスを取得する
            result = GetDirPath( pszBuffer, uSize, szPath );
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 実行ファイル名取得関数
    wchar_t const* GetExeFileName( wchar_t* pszBuffer, size_t uSize ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }

            // 実行ファイルパスを取得する
            wchar_t szPath[ MAX_PATH ];
            GetExeFilePath( szPath, MAX_PATH );

            // ファイル名を取得する
            result = GetFileName( pszBuffer, uSize, szPath );
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // ディレクトリパス取得関数
    wchar_t const* GetDirPath( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszPath ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }
            // ファイルパス文字列ポインタを調べる
            else if ( nullptr == pszPath ) {
                // 失敗！
                break;
            }

            // ファイルパスを分解する
            wchar_t szDrive[ _MAX_DRIVE ];
            wchar_t szDir  [ _MAX_DIR ];
            wchar_t szFName[ _MAX_FNAME ];
            wchar_t szExt  [ _MAX_EXT ];
            ::_wsplitpath_s( pszPath, szDrive, szDir, szFName, szExt );

            // ディレクトリパスを取得する
            ::swprintf_s( pszBuffer, uSize, L"%s%s", szDrive, szDir );

            // 成功！
            result = pszBuffer;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // ファイル名取得関数
    wchar_t const* GetFileName( wchar_t* pszBuffer, size_t uSize, wchar_t const* pszPath ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // 文字列バッファポインタを調べる
            if ( nullptr == pszBuffer ) {
                // 失敗！
                break;
            }
            // ファイルパス文字列ポインタを調べる
            else if ( nullptr == pszPath ) {
                // 失敗！
                break;
            }

            // ファイルパスを分解する
            wchar_t szDrive[ _MAX_DRIVE ];
            wchar_t szDir  [ _MAX_DIR ];
            wchar_t szFName[ _MAX_FNAME ];
            wchar_t szExt  [ _MAX_EXT ];
            ::_wsplitpath_s( pszPath, szDrive, szDir, szFName, szExt );

            // ファイル名を取得する
            ::swprintf_s( pszBuffer, uSize, L"%s%s", szFName, szExt );

            // 成功！
            result = pszBuffer;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // モジュール名取得関数
    wchar_t const* GetModuleName( HINSTANCE hInstance, wchar_t* pszBuffer, size_t uSize ) noexcept {
        // 処理ブロック
        wchar_t const* result = nullptr;
        do {
            // モジュール名を取得する
            static wchar_t szPath[ MAX_PATH ];
            ::GetModuleFileNameW( hInstance, szPath, MAX_PATH );

            // 文字列ポインタを取得する
            result = szPath;

            // 文字列バッファポインタを調べる
            if ( nullptr != pszBuffer ) {
                // 文字列をコピーする
                ::wcscpy_s( pszBuffer, uSize, szPath );

                // 文字列ポインタを取得する
                result = pszBuffer;
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 文字コード比較関数
    bool CompareCharCode( wchar_t ch1, wchar_t ch2, bool bIgnore ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // 大小文字無視フラグを調べる
            if ( bIgnore ) {
                // 小文字に変換する
                ch1 = ::towlower( ch1 );
                ch2 = ::towlower( ch2 );
            }

            // 文字コードを比較する
            if ( ch1 != ch2 ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // 文字コード比較関数
    bool CompareCharCode( wchar_t ch, wchar_t const* pszString, bool bIgnore ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // 比較先文字列ポインタを調べる
            if ( nullptr == pszString ) {
                // 失敗！
                break;
            }
            // 巡回する
            else for ( ;; ) {
                // 比較先文字コードを取得する
                wchar_t ch2 = *pszString++;
                if ( L'\0' == ch2 ) {
                    // 失敗！
                    break;
                }
                // 文字コードを比較する
                else if ( CompareCharCode( ch, ch2, bIgnore ) ) {
                    // 成功！
                    result = true;
                    break;
                }
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // ウィンドウ表示位置設定関数
    bool SetWindowPosition( HWND hWnd, EWindowPosition ePos ) noexcept {
        // 処理ブロック
        bool result = false;
        do {
            // ウィンドウ表示位置のモニタハンドルを取得する
            HMONITOR hMonitor = ::MonitorFromWindow( hWnd, MONITOR_DEFAULTTONEAREST );
            if ( nullptr == hMonitor ) {
                // 失敗！
                break;
            }

            // モニタ作業領域サイズを取得する
            MONITORINFO sMonitorInfo = { sizeof( MONITORINFO ) };
            if ( 0 == ::GetMonitorInfo( hMonitor, &sMonitorInfo ) ) {
                // 失敗！
                break;
            }

            // モニタ作業領域サイズを取得する
            int nWidth  = ( sMonitorInfo.rcWork.right  - sMonitorInfo.rcWork.left );
            int nHeight = ( sMonitorInfo.rcWork.bottom - sMonitorInfo.rcWork.top );

            // 表示位置種別を調べる
            int  nLeft    = sMonitorInfo.rcWork.left;
            int  nTop     = sMonitorInfo.rcWork.top;
            bool bFailure = false;
            switch ( ePos ) {
            case EWindowPosition::Left:   nWidth  /= 2;                   break; // 左端
            case EWindowPosition::Top:    nHeight /= 2;                   break; // 上端
            case EWindowPosition::Right:  nWidth  /= 2; nLeft += nWidth;  break; // 右端
            case EWindowPosition::Bottom: nHeight /= 2; nTop  += nHeight; break; // 下端
            case EWindowPosition::Full:                                   break; // フルサイズ
            default:                      bFailure = true;                break; // 失敗！
            }

            // 失敗フラグを調べる
            if ( bFailure ) {
                // 失敗！
                break;
            }

            // ウィンドウ表示領域を設定する
            ::SetWindowPos( hWnd, HWND_TOP, nLeft, nTop, nWidth, nHeight, ( SWP_NOACTIVATE | SWP_SHOWWINDOW ) );
            ::UpdateWindow( hWnd );

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

    //-------------------------------------------------------------------------
    // プロセス検索関数
    DWORD SearchProcess( wchar_t const* pszPath ) {
        // 処理ブロック
        DWORD result = 0;
        do {
            // プロセススナップショットを作成する
            HANDLE hSnapProcess = ::CreateToolhelp32Snapshot( TH32CS_SNAPPROCESS, 0 );
            if ( nullptr == hSnapProcess ) {
                // 失敗！
                break;
            }

            // プロセス情報を巡回する
            PROCESSENTRY32W sProcessEntry = { sizeof( PROCESSENTRY32 ) };
            bool            bResult       = ( 0 != ::Process32FirstW( hSnapProcess, &sProcessEntry ) );
            for ( ; !result && bResult; bResult = ( 0 != ::Process32NextW( hSnapProcess, &sProcessEntry ) ) ) {
                // モジュールスナップショットを作成する
                HANDLE hSnapModule = ::CreateToolhelp32Snapshot( TH32CS_SNAPMODULE, sProcessEntry.th32ProcessID );
                if ( nullptr == hSnapModule ) {
                    // 失敗！
                    break;
                }

                // モジュール情報を巡回する
                MODULEENTRY32W sModuleEntry = { sizeof( MODULEENTRY32 ) };
                bool           bResult      = ( 0 != ::Module32FirstW( hSnapModule, &sModuleEntry ) );
                for ( ; bResult; bResult = ( 0 != ::Module32NextW( hSnapModule, &sModuleEntry ) ) ) {
                    // プロセス実行ファイルパスを調べる
                    if ( 0 == ::_wcsicmp( pszPath, sModuleEntry.szExePath ) ) {
                        // 成功！
                        result = sProcessEntry.th32ProcessID;
                        break;
                    }
                }
            }
        } while ( false );

        // 実行結果を返す
        return result;
    }
}

#pragma managed( pop )