bugsplat.h

Go to the documentation of this file.

//
// BugSplat.h
//
// This header file contains the code used to add BugSplat crash reporting to
// native Windows applications.
//
// For more information, see the documentation at https://www.bugsplat.com/docs/sdk/cplusplus
//
// Copyright 2003-2017, BugSplat 
// All rights reserved.
//



#ifndef BUGSPLAT_H
#define BUGSPLAT_H

#ifdef BUGSPLAT_EXPORTS
    #define MDS_EXPORT __declspec(dllexport)
#else
    #define MDS_EXPORT __declspec(dllimport)
#endif

#include <Windows.h>

typedef bool (__cdecl *MiniDmpSenderCallback)(UINT nCode, LPVOID lVal1, LPVOID lVal2);

// forward declare internal class
class MiniDumper;

class MDS_EXPORT MiniDmpSender 
{
public:
    MiniDmpSender(__wchar_t const *szDatabase,
                  __wchar_t const *szApp,
                  __wchar_t const *szVersion,
                  __wchar_t const *szAppIdentifier = NULL,
                  DWORD dwFlags = 0x04 /* MDSF_PREVENTHIJACKING */
                  );
    virtual ~MiniDmpSender();
public:
    bool enableExceptionFilter(bool enable = true);

    bool isExceptionFilterEnabled() const;

    // the following typedef is identical to MINIDUMP_TYPE; copied here for convenience
    typedef enum _BS_MINIDUMP_TYPE {
        MiniDumpNormal = 0x00000000,
        MiniDumpWithDataSegs = 0x00000001,
        MiniDumpWithFullMemory = 0x00000002,
        MiniDumpWithHandleData = 0x00000004,
        MiniDumpFilterMemory = 0x00000008,
        MiniDumpScanMemory = 0x00000010,
        MiniDumpWithUnloadedModules = 0x00000020,
        MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
        MiniDumpFilterModulePaths = 0x00000080,
        MiniDumpWithProcessThreadData = 0x00000100,
        MiniDumpWithPrivateReadWriteMemory = 0x00000200,
        MiniDumpWithoutOptionalData = 0x00000400,
        MiniDumpWithFullMemoryInfo = 0x00000800,
        MiniDumpWithThreadInfo = 0x00001000,
        MiniDumpWithCodeSegs = 0x00002000,
        MiniDumpWithoutAuxiliaryState = 0x00004000,
        MiniDumpWithFullAuxiliaryState = 0x00008000,
        MiniDumpWithPrivateWriteCopyMemory = 0x00010000,
        MiniDumpIgnoreInaccessibleMemory = 0x00020000,
        MiniDumpWithTokenInformation = 0x00040000,
        MiniDumpWithModuleHeaders = 0x00080000,
        MiniDumpFilterTriage = 0x00100000,
        MiniDumpWithAvxXStateContext = 0x00200000,
        MiniDumpValidTypeFlags = 0x003fffff,
    } BS_MINIDUMP_TYPE;

    MiniDmpSender::BS_MINIDUMP_TYPE getMiniDumpType() const;

    void setMiniDumpType(MiniDmpSender::BS_MINIDUMP_TYPE eType);

    bool enableFullMemoryDumpAndExit(bool enable = true);
    bool isFullMemoryDumpAndExitEnabled() const;

    bool setFlags( DWORD dwFlags );
    DWORD getFlags() const;

    void resetVersionString(const __wchar_t * wszVersion);

    void resetAppIdentifier(const __wchar_t * wszDescription);

    void sendAdditionalFile(const __wchar_t * wszPath);

    bool removeAdditionalFile(const __wchar_t * wszPath);

    void setUserZipPath(const __wchar_t * wszPath);

    void setResourceDllPath(const __wchar_t * wszPath);

    void setDefaultUserName(const __wchar_t * wszName);

    void setDefaultUserEmail(const __wchar_t * wszEmail);

    void setDefaultUserDescription(const __wchar_t * wszDescription);

    void createReport(EXCEPTION_POINTERS * pExcepInfo);
    void createReport(const __wchar_t * wszStackTracePath);
    inline void createReportAndExit() { setFlags(getFlags() | 0x02/*MDSF_FORCEEXIT*/); throw NULL; }

    LONG unhandledExceptionHandler( PEXCEPTION_POINTERS pExceptionInfo );

    void setCallback(MiniDmpSenderCallback fnCallback);

    void getMinidumpPath(__wchar_t * buffer, size_t len);

    LPVOID imp();

private:
    MiniDumper * m_pMiniDumper;
};


// ***************************
// Definitions for the dwFlags parameter of MiniDmpSender constructor and the getFlags/setFlags methods.
// The non-interactive flag is for applications that run unattended or without a user interface.  

#define MDSF_NONINTERACTIVE     0x0001

#define MDSF_FORCEEXIT          0x0002

#define MDSF_PREVENTHIJACKING   0x0004

#define MDSF_DETECTHANGS        0x0008

#define MDSF_USEGUARDMEMORY     0x0010

#define MDSF_CUSTOMEXCEPTIONFILTER 0x0020

#define MDSF_SUSPENDALLTHREADS  0x0800

#define MDSF_LOGCONSOLE         0x1000
#define MDSF_LOGFILE            0x2000
#define MDSF_LOG_VERBOSE        0x4000


#define MDSCB_EXCEPTIONCODE            0x0050

//#define MDSCB_GETADDITIONALFILECOUNT   0x0100  // obsolete:  please use sendAdditionalFile() instead
#endif //~BUGSPLAT_H