dbgrpt.cpp File Reference

#include <crtdbg.h>
#include <stdio.h>
#include <signal.h>
#include <windows.h>

Include dependency graph for dbgrpt.cpp:

Go to the source code of this file.

Classes
struct	dbgrpt_char_traits< char >
struct	dbgrpt_char_traits< wchar_t >

Macros
#define	DBGRPT_MAX_BUFFER_SIZE   4096
#define	DBGRPT_ASSERT_PREFIX_MESSAGE   "Assertion failed: "
#define	DBGRPT_ASSERT_PREFIX_NOMESSAGE   "Assertion failed!"
#define	DBGRPT_STRING_TOO_LONG   "_CrtDbgReport: String too long"

Typedefs
typedef int(WINAPI *	tMessageBoxW) (_In_opt_ HWND hWnd, _In_opt_ LPCWSTR lpText, _In_opt_ LPCWSTR lpCaption, _In_ UINT uType)
typedef dbgrpt_char_traits< char >	achar_traits
typedef dbgrpt_char_traits< wchar_t >	wchar_traits

Functions
static HMODULE	_CrtGetUser32 ()
static tMessageBoxW	_CrtGetMessageBox ()
template<typename char_t >
static int	_CrtDbgReportWindow (int reportType, const char_t *filename, int linenumber, const char_t *moduleName, const char_t *message)
template<typename char_t >
static int	_CrtEnterDbgReport (int reportType, const char_t *filename, int linenumber)
static void	_CrtLeaveDbgReport (int reportType)
EXTERN_C int __cdecl	_CrtSetReportMode (int reportType, int reportMode)
EXTERN_C _HFILE __cdecl	_CrtSetReportFile (int reportType, _HFILE reportFile)
template<typename char_t >
static BOOL	_CrtDbgReportToFile (HANDLE hFile, const char_t *szMsg)
template<typename char_t >
static int	_CrtHandleDbgReport (int reportType, const char_t *szCompleteMessage, const char_t *szFormatted, const char_t *filename, int linenumber, const char_t *moduleName)
EXTERN_C int __cdecl	_VCrtDbgReportA (int reportType, const char *filename, int linenumber, const char *moduleName, const char *format, va_list arglist)
EXTERN_C int __cdecl	_VCrtDbgReportW (int reportType, const wchar_t *filename, int linenumber, const wchar_t *moduleName, const wchar_t *format, va_list arglist)
EXTERN_C int __cdecl	_CrtDbgReportV (int reportType, const char *filename, int linenumber, const char *moduleName, const char *format, va_list arglist)
EXTERN_C int __cdecl	_CrtDbgReportWV (int reportType, const wchar_t *filename, int linenumber, const wchar_t *moduleName, const wchar_t *format, va_list arglist)
EXTERN_C int __cdecl	_CrtDbgReport (int reportType, const char *filename, int linenumber, const char *moduleName, const char *format,...)
EXTERN_C int __cdecl	_CrtDbgReportW (int reportType, const wchar_t *filename, int linenumber, const wchar_t *moduleName, const wchar_t *format,...)

Variables
static long	_CrtInAssert = -1
static int	_CrtModeOutputFormat [_CRT_ERRCNT]
static const wchar_t *	_CrtModeMessages [_CRT_ERRCNT]
static _HFILE	_CrtReportFiles [_CRT_ERRCNT]
static HMODULE	_CrtUser32Handle = NULL
static tMessageBoxW	_CrtMessageBoxW = NULL

Macro Definition Documentation

DBGRPT_ASSERT_PREFIX_MESSAGE

#define DBGRPT_ASSERT_PREFIX_MESSAGE   "Assertion failed: "

Definition at line 23 of file dbgrpt.cpp.

DBGRPT_ASSERT_PREFIX_NOMESSAGE

#define DBGRPT_ASSERT_PREFIX_NOMESSAGE   "Assertion failed!"

Definition at line 24 of file dbgrpt.cpp.

DBGRPT_MAX_BUFFER_SIZE

#define DBGRPT_MAX_BUFFER_SIZE   4096

Definition at line 22 of file dbgrpt.cpp.

DBGRPT_STRING_TOO_LONG

#define DBGRPT_STRING_TOO_LONG   "_CrtDbgReport: String too long"

Definition at line 25 of file dbgrpt.cpp.

Typedef Documentation

achar_traits

typedef dbgrpt_char_traits<char> achar_traits

Definition at line 86 of file dbgrpt.cpp.

tMessageBoxW

typedef int(WINAPI * tMessageBoxW) (_In_opt_ HWND hWnd, _In_opt_ LPCWSTR lpText, _In_opt_ LPCWSTR lpCaption, _In_ UINT uType)

Definition at line 52 of file dbgrpt.cpp.

wchar_traits

typedef dbgrpt_char_traits<wchar_t> wchar_traits

Definition at line 87 of file dbgrpt.cpp.

Function Documentation

_CrtDbgReport()

EXTERN_C int __cdecl _CrtDbgReport	(	int	reportType,
		const char *	filename,
		int	linenumber,
		const char *	moduleName,
		const char *	format,
			...
	)

Definition at line 464 of file dbgrpt.cpp.

{
    va_list arglist;
    int result;
 
    va_start(arglist, format);
    result = _VCrtDbgReportA(reportType, filename, linenumber, moduleName, format, arglist);
    va_end(arglist);
    return result;
}

_CrtDbgReportToFile()

template<typename char_t >

static BOOL _CrtDbgReportToFile ( HANDLE  hFile, const char_t *  szMsg  )

inlinestatic

Definition at line 259 of file dbgrpt.cpp.

{
    typedef dbgrpt_char_traits<char_t> traits;
 
    if (hFile == _CRTDBG_INVALID_HFILE || hFile == NULL)
        return FALSE;
 
    if (hFile == _CRTDBG_FILE_STDOUT)
        hFile = ::GetStdHandle(STD_OUTPUT_HANDLE);
    else if (hFile == _CRTDBG_FILE_STDERR)
        hFile = ::GetStdHandle(STD_ERROR_HANDLE);
 
    DWORD cbMsg = (DWORD)(traits::StringLength(szMsg) * sizeof(char_t));
    return ::WriteFile(hFile, szMsg, cbMsg, &cbMsg, NULL);
}

_CrtDbgReportV()

EXTERN_C int __cdecl _CrtDbgReportV	(	int	reportType,
		const char *	filename,
		int	linenumber,
		const char *	moduleName,
		const char *	format,
		va_list	arglist
	)

Definition at line 438 of file dbgrpt.cpp.

{
    return _VCrtDbgReportA(reportType, filename, linenumber, moduleName, format, arglist);
}

_CrtDbgReportW()

EXTERN_C int __cdecl _CrtDbgReportW	(	int	reportType,
		const wchar_t *	filename,
		int	linenumber,
		const wchar_t *	moduleName,
		const wchar_t *	format,
			...
	)

Definition at line 483 of file dbgrpt.cpp.

{
    va_list arglist;
    int result;
 
    va_start(arglist, format);
    result = _VCrtDbgReportW(reportType, filename, linenumber, moduleName, format, arglist);
    va_end(arglist);
    return result;
}

_CrtDbgReportWindow()

template<typename char_t >

static int _CrtDbgReportWindow ( int  reportType, const char_t *  filename, int  linenumber, const char_t *  moduleName, const char_t *  message  )

static

Definition at line 157 of file dbgrpt.cpp.

{
    typedef dbgrpt_char_traits<char_t> traits;
 
    wchar_t szCompleteMessage[DBGRPT_MAX_BUFFER_SIZE] = {0};
    wchar_t LineBuffer[20] = {0};
 
    if (filename && !filename[0])
        filename = NULL;
    if (moduleName && !moduleName[0])
        moduleName = NULL;
    if (message && !message[0])
        message = NULL;
    if (linenumber)
        _itow(linenumber, LineBuffer, 10);
 
    _snwprintf(szCompleteMessage,
               _countof(szCompleteMessage) - 1,
               traits::szAssertionMessage,
               _CrtModeMessages[reportType],
               moduleName ? L"\nModule: " : L"", moduleName ? moduleName : traits::szEmptyString,
               filename ? L"\nFile: " : L"", filename ? filename : traits::szEmptyString,
               LineBuffer[0] ? L"\nLine: " : L"", LineBuffer[0] ? LineBuffer : L"",
               message ? L"\n\n" : L"", message ? message : traits::szEmptyString);
 
    if (IsDebuggerPresent())
    {
        OutputDebugStringW(szCompleteMessage);
    }
 
    tMessageBoxW messageBox = _CrtGetMessageBox();
    if (!messageBox)
        return (IsDebuggerPresent() ? IDRETRY : IDABORT);
 
    // TODO: If we are not interacive, add MB_SERVICE_NOTIFICATION
    return messageBox(NULL, szCompleteMessage, L"ReactOS C++ Runtime Library",
                      MB_ABORTRETRYIGNORE | MB_ICONHAND | MB_SETFOREGROUND | MB_TASKMODAL);
}

Referenced by _CrtHandleDbgReport().

_CrtDbgReportWV()

EXTERN_C int __cdecl _CrtDbgReportWV	(	int	reportType,
		const wchar_t *	filename,
		int	linenumber,
		const wchar_t *	moduleName,
		const wchar_t *	format,
		va_list	arglist
	)

Definition at line 451 of file dbgrpt.cpp.

{
    return _VCrtDbgReportW(reportType, filename, linenumber, moduleName, format, arglist);
}

_CrtEnterDbgReport()

template<typename char_t >

static int _CrtEnterDbgReport ( int  reportType, const char_t *  filename, int  linenumber  )

static

Definition at line 197 of file dbgrpt.cpp.

{
    typedef dbgrpt_char_traits<char_t> traits;
 
    if (reportType < 0 || reportType >= _CRT_ERRCNT)
        return FALSE;
 
    if (reportType == _CRT_ASSERT)
    {
        if (_InterlockedIncrement(&_CrtInAssert) > 0)
        {
            char LineBuffer[20] = {0};
 
            _itoa(linenumber, LineBuffer, 10);
 
            OutputDebugStringA("Nested Assert from File: ");
            traits::OutputDebugString(filename ? filename : traits::szUnknownFile);
            OutputDebugStringA(", Line: ");
            OutputDebugStringA(LineBuffer);
            OutputDebugStringA("\n");
 
            _CrtDbgBreak();
 
            _InterlockedDecrement(&_CrtInAssert);
            return FALSE;
        }
    }
    return TRUE;
}

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtGetMessageBox()

static tMessageBoxW _CrtGetMessageBox ( )

static

Definition at line 139 of file dbgrpt.cpp.

{
    HMODULE mod = _CrtGetUser32();
 
    if (_CrtMessageBoxW == NULL && mod != INVALID_HANDLE_VALUE)
    {
        tMessageBoxW proc = (tMessageBoxW)GetProcAddress(mod, "MessageBoxW");
        if (proc == NULL)
            proc = (tMessageBoxW)INVALID_HANDLE_VALUE;
 
        _InterlockedCompareExchangePointer((PVOID*)&_CrtMessageBoxW, (PVOID)proc, NULL);
    }
 
    return (_CrtMessageBoxW != INVALID_HANDLE_VALUE ? _CrtMessageBoxW : NULL);
}

Referenced by _CrtDbgReportWindow().

_CrtGetUser32()

static HMODULE _CrtGetUser32 ( )

static

Definition at line 121 of file dbgrpt.cpp.

{
    if (_CrtUser32Handle == NULL)
    {
        HMODULE mod = LoadLibraryExW(L"user32.dll", NULL, 0 /* NT6+: LOAD_LIBRARY_SEARCH_SYSTEM32 */);
        if (mod == NULL)
            mod = (HMODULE)INVALID_HANDLE_VALUE;
 
        if (_InterlockedCompareExchangePointer((PVOID*)&_CrtUser32Handle, mod, NULL))
        {
            if (mod != INVALID_HANDLE_VALUE)
                FreeLibrary(mod);
        }
    }
 
    return (_CrtUser32Handle != INVALID_HANDLE_VALUE ? _CrtUser32Handle : NULL);
}

Referenced by _CrtGetMessageBox().

_CrtHandleDbgReport()

template<typename char_t >

static int _CrtHandleDbgReport ( int  reportType, const char_t *  szCompleteMessage, const char_t *  szFormatted, const char_t *  filename, int  linenumber, const char_t *  moduleName  )

static

Definition at line 276 of file dbgrpt.cpp.

{
    typedef dbgrpt_char_traits<char_t> traits;
 
    if (_CrtModeOutputFormat[reportType] & _CRTDBG_MODE_FILE)
    {
        _CrtDbgReportToFile<char_t>(_CrtReportFiles[reportType], szCompleteMessage);
    }
 
    if (_CrtModeOutputFormat[reportType] & _CRTDBG_MODE_DEBUG)
    {
        traits::OutputDebugString(szCompleteMessage);
    }
 
    if (_CrtModeOutputFormat[reportType] & _CRTDBG_MODE_WNDW)
    {
        int nResult = _CrtDbgReportWindow(reportType, filename, linenumber, moduleName, szFormatted);
        switch (nResult)
        {
        case IDRETRY:
            return TRUE;
        case IDIGNORE:
        default:
            return FALSE;
        case IDABORT:
            raise(SIGABRT);
            _exit(3);
            return FALSE;   // Unreachable
        }
    }
 
    return FALSE;
}

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtLeaveDbgReport()

static void _CrtLeaveDbgReport ( int  reportType )

static

Definition at line 228 of file dbgrpt.cpp.

{
    if (reportType == _CRT_ASSERT)
        _InterlockedDecrement(&_CrtInAssert);
}

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtSetReportFile()

EXTERN_C _HFILE __cdecl _CrtSetReportFile	(	int	reportType,
		_HFILE	reportFile
	)

Definition at line 247 of file dbgrpt.cpp.

{
    if (reportType >= _CRT_ERRCNT || reportType < 0)
        return NULL;
 
    _HFILE oldReportFile = _CrtReportFiles[reportType];
    if (reportFile != _CRTDBG_REPORT_FILE)
        _CrtReportFiles[reportType] = reportFile;
    return oldReportFile;
}

_CrtSetReportMode()

EXTERN_C int __cdecl _CrtSetReportMode	(	int	reportType,
		int	reportMode
	)

Definition at line 235 of file dbgrpt.cpp.

{
    if (reportType >= _CRT_ERRCNT || reportType < 0)
        return 0;
 
    int oldReportMode = _CrtModeOutputFormat[reportType];
    if (reportMode != _CRTDBG_REPORT_MODE)
        _CrtModeOutputFormat[reportType] = reportMode;
    return oldReportMode;
}

_VCrtDbgReportA()

EXTERN_C int __cdecl _VCrtDbgReportA	(	int	reportType,
		const char *	filename,
		int	linenumber,
		const char *	moduleName,
		const char *	format,
		va_list	arglist
	)

Definition at line 314 of file dbgrpt.cpp.

{
    char szFormatted[DBGRPT_MAX_BUFFER_SIZE] = {0};       // The user provided message
    char szCompleteMessage[DBGRPT_MAX_BUFFER_SIZE] = {0}; // The output for debug / file
 
    // Check for recursive _CrtDbgReport calls, and validate reportType
    if (!_CrtEnterDbgReport(reportType, filename, linenumber))
        return -1;
 
    if (filename)
    {
        _snprintf(szCompleteMessage,
                  _countof(szCompleteMessage) - 1,
                  "%s(%d) : ",
                  filename,
                  linenumber);
    }
 
    if (format)
    {
        int len = _vsnprintf(szFormatted,
                             _countof(szFormatted) - 2 - _countof(DBGRPT_ASSERT_PREFIX_MESSAGE),
                             format,
                             arglist);
        if (len < 0)
        {
            strcpy(szFormatted, DBGRPT_STRING_TOO_LONG);
        }
 
        if (reportType == _CRT_ASSERT)
            strcat(szCompleteMessage, DBGRPT_ASSERT_PREFIX_MESSAGE);
        strcat(szCompleteMessage, szFormatted);
    }
    else if (reportType == _CRT_ASSERT)
    {
        strcat(szCompleteMessage, DBGRPT_ASSERT_PREFIX_NOMESSAGE);
    }
 
    if (reportType == _CRT_ASSERT)
    {
        if (_CrtModeOutputFormat[reportType] & _CRTDBG_MODE_FILE)
            strcat(szCompleteMessage, "\r");
        strcat(szCompleteMessage, "\n");
    }
 
    // FIXME: Handle user report hooks here
 
    int nResult = _CrtHandleDbgReport(reportType, szCompleteMessage, szFormatted, filename, linenumber, moduleName);
 
    _CrtLeaveDbgReport(reportType);
 
    return nResult;
}

Referenced by _CrtDbgReport(), and _CrtDbgReportV().

_VCrtDbgReportW()

EXTERN_C int __cdecl _VCrtDbgReportW	(	int	reportType,
		const wchar_t *	filename,
		int	linenumber,
		const wchar_t *	moduleName,
		const wchar_t *	format,
		va_list	arglist
	)

Definition at line 376 of file dbgrpt.cpp.

{
    wchar_t szFormatted[DBGRPT_MAX_BUFFER_SIZE] = {0};       // The user provided message
    wchar_t szCompleteMessage[DBGRPT_MAX_BUFFER_SIZE] = {0}; // The output for debug / file
 
    // Check for recursive _CrtDbgReportW calls, and validate reportType
    if (!_CrtEnterDbgReport(reportType, filename, linenumber))
        return -1;
 
    if (filename)
    {
        _snwprintf(szCompleteMessage,
                   _countof(szCompleteMessage) - 1,
                   L"%s(%d) : ",
                   filename,
                   linenumber);
    }
 
    if (format)
    {
        int len = _vsnwprintf(szFormatted,
                              _countof(szFormatted) - 2 - _countof(DBGRPT_ASSERT_PREFIX_MESSAGE),
                              format,
                              arglist);
        if (len < 0)
        {
            wcscpy(szFormatted, _CRT_WIDE(DBGRPT_STRING_TOO_LONG));
        }
 
        if (reportType == _CRT_ASSERT)
            wcscat(szCompleteMessage, _CRT_WIDE(DBGRPT_ASSERT_PREFIX_MESSAGE));
        wcscat(szCompleteMessage, szFormatted);
    }
    else if (reportType == _CRT_ASSERT)
    {
        wcscat(szCompleteMessage, _CRT_WIDE(DBGRPT_ASSERT_PREFIX_NOMESSAGE));
    }
 
    if (reportType == _CRT_ASSERT)
    {
        if (_CrtModeOutputFormat[reportType] & _CRTDBG_MODE_FILE)
            wcscat(szCompleteMessage, L"\r");
        wcscat(szCompleteMessage, L"\n");
    }
 
    // FIXME: Handle user report hooks here
 
    int nResult = _CrtHandleDbgReport(reportType, szCompleteMessage, szFormatted, filename, linenumber, moduleName);
 
    _CrtLeaveDbgReport(reportType);
 
    return nResult;
}

Referenced by _CrtDbgReportW(), and _CrtDbgReportWV().

Variable Documentation

_CrtInAssert

long _CrtInAssert = -1

static

Definition at line 28 of file dbgrpt.cpp.

Referenced by _CrtEnterDbgReport(), and _CrtLeaveDbgReport().

_CrtMessageBoxW

tMessageBoxW _CrtMessageBoxW = NULL

static

Definition at line 54 of file dbgrpt.cpp.

Referenced by _CrtGetMessageBox().

_CrtModeMessages

const wchar_t* _CrtModeMessages[_CRT_ERRCNT]

static

Initial value:

=
{
    L"Warning",
    L"Error",
    L"Assertion Failed"
}

Definition at line 37 of file dbgrpt.cpp.

Referenced by _CrtDbgReportWindow().

_CrtModeOutputFormat

int _CrtModeOutputFormat[_CRT_ERRCNT]

static

Initial value:

=
{
    _CRTDBG_MODE_DEBUG,
    _CRTDBG_MODE_WNDW,
    _CRTDBG_MODE_WNDW,
}

Definition at line 30 of file dbgrpt.cpp.

Referenced by _CrtHandleDbgReport(), _CrtSetReportMode(), _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtReportFiles

_HFILE _CrtReportFiles[_CRT_ERRCNT]

static

Initial value:

=
{
    _CRTDBG_INVALID_HFILE,
    _CRTDBG_INVALID_HFILE,
    _CRTDBG_INVALID_HFILE
}

Definition at line 44 of file dbgrpt.cpp.

Referenced by _CrtHandleDbgReport(), and _CrtSetReportFile().

_CrtUser32Handle

HMODULE _CrtUser32Handle = NULL

static

Definition at line 53 of file dbgrpt.cpp.

Referenced by _CrtGetUser32().