CrashRpt.h

Go to the documentation of this file.

/************************************************************************************* 
  This file is a part of CrashRpt library.

  Copyright (c) 2003, Michael Carruth
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without modification, 
  are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice, this 
     list of conditions and the following disclaimer.
 
   * Redistributions in binary form must reproduce the above copyright notice, 
     this list of conditions and the following disclaimer in the documentation 
     and/or other materials provided with the distribution.
 
   * Neither the name of the author nor the names of its contributors 
     may be used to endorse or promote products derived from this software without 
     specific prior written permission.
 

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
  SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
***************************************************************************************/

#ifndef _CRASHRPT_H_
#define _CRASHRPT_H_

#include <windows.h>
#include <dbghelp.h>

// Define SAL macros to be empty if some old Visual Studio used
#ifndef __reserved
  #define __reserved
#endif
#ifndef __in
  #define __in
#endif
#ifndef __in_opt
  #define __in_opt
#endif
#ifndef __out_ecount_z
  #define __out_ecount_z(x)
#endif

#ifdef __cplusplus
#define CRASHRPT_EXTERNC extern "C"
#else
#define CRASHRPT_EXTERNC
#endif

#define CRASHRPTAPI(rettype) CRASHRPT_EXTERNC rettype WINAPI

#define CRASHRPT_VER 1210

typedef BOOL (CALLBACK *LPGETLOGFILE) (__reserved LPVOID lpvState);

#ifndef _CRASHRPT_REMOVE_DEPRECATED

CRASHRPTAPI(LPVOID)
InstallW(
   __in_opt LPGETLOGFILE pfnCallback,
   LPCWSTR pszEmailTo,    
   LPCWSTR pszEmailSubject
   );

CRASHRPTAPI(LPVOID)
InstallA(
   __in_opt LPGETLOGFILE pfnCallback,
   LPCSTR pszEmailTo,    
   LPCSTR pszEmailSubject
   );

#ifdef UNICODE
#define Install InstallW 
#else
#define Install InstallA
#endif //UNICODE


CRASHRPTAPI(void)
Uninstall(
   __reserved LPVOID lpState                            
   );

CRASHRPTAPI(void)
AddFileW(
   __reserved LPVOID lpState,                         
   LPCWSTR pszFile,                         
   LPCWSTR pszDesc                          
   );

CRASHRPTAPI(void)
AddFileA(
   __reserved LPVOID lpState,                         
   LPCSTR pszFile,                         
   LPCSTR pszDesc                          
   );

#ifdef UNICODE
#define AddFile AddFileW
#else
#define AddFile AddFileA
#endif //UNICODE



CRASHRPTAPI(void)
GenerateErrorReport(
   __reserved LPVOID lpState,
   PEXCEPTION_POINTERS pExInfo
   );

#endif //_CRASHRPT_REMOVE_DEPRECATED

// Array indices for CR_INSTALL_INFO::uPriorities.
#define CR_HTTP 0  //!< Send error report via HTTP (or HTTPS) connection.
#define CR_SMTP 1  //!< Send error report via SMTP connection.
#define CR_SMAPI 2 //!< Send error report via simple MAPI (using default mail client).

#define CR_NEGATIVE_PRIORITY ((UINT)-1)

// Flags for CR_INSTALL_INFO::dwFlags
#define CR_INST_STRUCTURED_EXCEPTION_HANDLER   0x1    //!< Install SEH handler (deprecated name, use \ref CR_INST_SEH_EXCEPTION_HANDLER instead).
#define CR_INST_SEH_EXCEPTION_HANDLER          0x1    //!< Install SEH handler.
#define CR_INST_TERMINATE_HANDLER              0x2    //!< Install terminate handler.
#define CR_INST_UNEXPECTED_HANDLER             0x4    //!< Install unexpected handler.
#define CR_INST_PURE_CALL_HANDLER              0x8    //!< Install pure call handler (VS .NET and later).
#define CR_INST_NEW_OPERATOR_ERROR_HANDLER     0x10   //!< Install new operator error handler (VS .NET and later).
#define CR_INST_SECURITY_ERROR_HANDLER         0x20   //!< Install security error handler (VS .NET and later).
#define CR_INST_INVALID_PARAMETER_HANDLER      0x40   //!< Install invalid parameter handler (VS 2005 and later).
#define CR_INST_SIGABRT_HANDLER                0x80   //!< Install SIGABRT signal handler.
#define CR_INST_SIGFPE_HANDLER                 0x100  //!< Install SIGFPE signal handler.   
#define CR_INST_SIGILL_HANDLER                 0x200  //!< Install SIGILL signal handler.  
#define CR_INST_SIGINT_HANDLER                 0x400  //!< Install SIGINT signal handler.  
#define CR_INST_SIGSEGV_HANDLER                0x800  //!< Install SIGSEGV signal handler.
#define CR_INST_SIGTERM_HANDLER                0x1000 //!< Install SIGTERM signal handler.  

#define CR_INST_ALL_EXCEPTION_HANDLERS         0       //!< Install all possible exception handlers.
#define CR_INST_CRT_EXCEPTION_HANDLERS         0x1FFE  //!< Install exception handlers for the linked CRT module.

#define CR_INST_NO_GUI                         0x2000  //!< Do not show GUI, send report silently (use for non-GUI apps only).
#define CR_INST_HTTP_BINARY_ENCODING           0x4000  //!< Use multi-part HTTP uploads with binary attachment encoding.
#define CR_INST_DONT_SEND_REPORT               0x8000  //!< Don't send error report immediately, just save it locally.
#define CR_INST_APP_RESTART                    0x10000 //!< Restart the application on crash.
#define CR_INST_NO_MINIDUMP                    0x20000 //!< Do not include minidump file to crash report.
#define CR_INST_SEND_QUEUED_REPORTS            0x40000 //!< CrashRpt should send error reports that are waiting to be delivered.
#define CR_INST_STORE_ZIP_ARCHIVES             0x80000 //!< CrashRpt should store both uncompressed error report files and ZIP archives.

typedef struct tagCR_INSTALL_INFOW
{
  WORD cb;                        
  LPCWSTR pszAppName;             
  LPCWSTR pszAppVersion;          
  LPCWSTR pszEmailTo;             
  LPCWSTR pszEmailSubject;        
  LPCWSTR pszUrl;                 
  LPCWSTR pszCrashSenderPath;     
  LPGETLOGFILE pfnCrashCallback;  
  UINT uPriorities[5];            
  DWORD dwFlags;                  
  LPCWSTR pszPrivacyPolicyURL;    
  LPCWSTR pszDebugHelpDLL;        
  MINIDUMP_TYPE uMiniDumpType;    
  LPCWSTR pszErrorReportSaveDir;  
  LPCWSTR pszRestartCmdLine;      
  LPCWSTR pszLangFilePath;        
  LPCWSTR pszEmailText;           
  LPCWSTR pszSmtpProxy;           
  LPCWSTR pszCustomSenderIcon;    
}
CR_INSTALL_INFOW;

typedef CR_INSTALL_INFOW *PCR_INSTALL_INFOW;

typedef struct tagCR_INSTALL_INFOA
{
  WORD cb;                       
  LPCSTR pszAppName;             
  LPCSTR pszAppVersion;          
  LPCSTR pszEmailTo;             
  LPCSTR pszEmailSubject;        
  LPCSTR pszUrl;                 
  LPCSTR pszCrashSenderPath;     
  LPGETLOGFILE pfnCrashCallback; 
  UINT uPriorities[3];           
  DWORD dwFlags;                 
  LPCSTR pszPrivacyPolicyURL;    
  LPCSTR pszDebugHelpDLL;        
  MINIDUMP_TYPE uMiniDumpType;   
  LPCSTR pszErrorReportSaveDir;  
  LPCSTR pszRestartCmdLine;      
  LPCSTR pszLangFilePath;        
  LPCSTR pszEmailText;           
  LPCSTR pszSmtpProxy;           
  LPCSTR pszCustomSenderIcon;    
}
CR_INSTALL_INFOA;

typedef CR_INSTALL_INFOA *PCR_INSTALL_INFOA;

#ifdef UNICODE
typedef CR_INSTALL_INFOW CR_INSTALL_INFO;
typedef PCR_INSTALL_INFOW PCR_INSTALL_INFO;
#else
typedef CR_INSTALL_INFOA CR_INSTALL_INFO;
typedef PCR_INSTALL_INFOA PCR_INSTALL_INFO; 
#endif // UNICODE

CRASHRPTAPI(int)
crInstallW(
  __in PCR_INSTALL_INFOW pInfo
);

CRASHRPTAPI(int)
crInstallA(
  __in PCR_INSTALL_INFOA pInfo
);

#ifdef UNICODE
#define crInstall crInstallW
#else
#define crInstall crInstallA
#endif //UNICODE

CRASHRPTAPI(int)
crUninstall();


CRASHRPTAPI(int)
crInstallToCurrentThread();

CRASHRPTAPI(int)
crInstallToCurrentThread2(DWORD dwFlags);

CRASHRPTAPI(int)
crUninstallFromCurrentThread();

CRASHRPTAPI(int)
crAddFileW(
   LPCWSTR pszFile,
   LPCWSTR pszDesc 
   );

CRASHRPTAPI(int)
crAddFileA(
   LPCSTR pszFile,
   LPCSTR pszDesc 
   );

#ifdef UNICODE
#define crAddFile crAddFileW
#else
#define crAddFile crAddFileA
#endif //UNICODE

// Flags for crAddFile2() function.

#define CR_AF_TAKE_ORIGINAL_FILE  0 //!< Take the original file (do not copy it to the error report folder).
#define CR_AF_MAKE_FILE_COPY      1 //!< Copy the file to the error report folder.

#define CR_AF_FILE_MUST_EXIST     0 //!< Function will fail if file doesn't exist at the moment of function call.
#define CR_AF_MISSING_FILE_OK     2 //!< Do not fail if file is missing (assume it will be created later).

CRASHRPTAPI(int)
crAddFile2W(
   LPCWSTR pszFile,
   LPCWSTR pszDestFile,
   LPCWSTR pszDesc,
   DWORD dwFlags
   );

CRASHRPTAPI(int)
crAddFile2A(
   LPCSTR pszFile,
   LPCSTR pszDestFile,
   LPCSTR pszDesc,
   DWORD dwFlags
   );

#ifdef UNICODE
#define crAddFile2 crAddFile2W
#else
#define crAddFile2 crAddFile2A
#endif //UNICODE


// Flags for crAddScreenshot function.
#define CR_AS_VIRTUAL_SCREEN  0  //!< Take a screenshot of the virtual screen.
#define CR_AS_MAIN_WINDOW     1  //!< Take a screenshot of application's main window.
#define CR_AS_PROCESS_WINDOWS 2  //!< Take a screenshot of all visible process windows.
#define CR_AS_GRAYSCALE_IMAGE 4  //!< Make a grayscale image instead of a full-color one.
#define CR_AS_USE_JPEG_FORMAT 8  //!< Store screenshots as JPG files.

CRASHRPTAPI(int)
crAddScreenshot(
   DWORD dwFlags
   );

CRASHRPTAPI(int)
crAddScreenshot2(
   DWORD dwFlags,
   int nJpegQuality
   );

CRASHRPTAPI(int)
crAddPropertyW(
   LPCWSTR pszPropName,
   LPCWSTR pszPropValue
   );

CRASHRPTAPI(int)
crAddPropertyA(
   LPCSTR pszPropName,
   LPCSTR pszPropValue
   );

#ifdef UNICODE
#define crAddProperty crAddPropertyW
#else
#define crAddProperty crAddPropertyA
#endif //UNICODE

CRASHRPTAPI(int)
crAddRegKeyW(   
   LPCWSTR pszRegKey,
   LPCWSTR pszDstFileName,
   DWORD dwFlags
   );

CRASHRPTAPI(int)
crAddRegKeyA(   
   LPCSTR pszRegKey,
   LPCSTR pszDstFileName,
   DWORD dwFlags
   );

#ifdef UNICODE
#define crAddRegKey crAddRegKeyW
#else
#define crAddRegKey crAddRegKeyA
#endif //UNICODE

// Exception types
#define CR_WIN32_STRUCTURED_EXCEPTION   0    //!< SEH exception (deprecated name, use \ref CR_SEH_EXCEPTION instead).
#define CR_SEH_EXCEPTION                0    //!< SEH exception.
#define CR_CPP_TERMINATE_CALL           1    //!< C++ terminate() call.
#define CR_CPP_UNEXPECTED_CALL          2    //!< C++ unexpected() call.
#define CR_CPP_PURE_CALL                3    //!< C++ pure virtual function call (VS .NET and later).
#define CR_CPP_NEW_OPERATOR_ERROR       4    //!< C++ new operator fault (VS .NET and later).
#define CR_CPP_SECURITY_ERROR           5    //!< Buffer overrun error (VS .NET only).
#define CR_CPP_INVALID_PARAMETER        6    //!< Invalid parameter exception (VS 2005 and later).
#define CR_CPP_SIGABRT                  7    //!< C++ SIGABRT signal (abort).
#define CR_CPP_SIGFPE                   8    //!< C++ SIGFPE signal (flotating point exception).
#define CR_CPP_SIGILL                   9    //!< C++ SIGILL signal (illegal instruction).
#define CR_CPP_SIGINT                   10   //!< C++ SIGINT signal (CTRL+C).
#define CR_CPP_SIGSEGV                  11   //!< C++ SIGSEGV signal (invalid storage access).
#define CR_CPP_SIGTERM                  12   //!< C++ SIGTERM signal (termination request).


typedef struct tagCR_EXCEPTION_INFO
{
  WORD cb;                   
  PEXCEPTION_POINTERS pexcptrs; 
  int exctype;               
  DWORD code;                
  unsigned int fpe_subcode;  
  const wchar_t* expression; 
  const wchar_t* function;   
  const wchar_t* file;       
  unsigned int line;         
  BOOL bManual;              
  HANDLE hSenderProcess;     
}
CR_EXCEPTION_INFO;

typedef CR_EXCEPTION_INFO *PCR_EXCEPTION_INFO;

CRASHRPTAPI(int)
crGenerateErrorReport(   
   __in_opt CR_EXCEPTION_INFO* pExceptionInfo
   );


CRASHRPTAPI(int)
crExceptionFilter(
  unsigned int code, 
  __in_opt struct _EXCEPTION_POINTERS* ep);

#define CR_NONCONTINUABLE_EXCEPTION  32  //!< Non continuable sofware exception. 
#define CR_THROW                     33  //!< Throw C++ typed exception.

CRASHRPTAPI(int)
crEmulateCrash(
  unsigned ExceptionType) throw (...);



CRASHRPTAPI(int)
crGetLastErrorMsgW(
  __out_ecount_z(uBuffSize) LPWSTR pszBuffer, 
  UINT uBuffSize);

CRASHRPTAPI(int)
crGetLastErrorMsgA(
  __out_ecount_z(uBuffSize) LPSTR pszBuffer, 
  UINT uBuffSize);

#ifdef UNICODE
#define crGetLastErrorMsg crGetLastErrorMsgW
#else
#define crGetLastErrorMsg crGetLastErrorMsgA
#endif //UNICODE



#ifndef _CRASHRPT_NO_WRAPPERS

class CrAutoInstallHelper
{
public:

  CrAutoInstallHelper(__in PCR_INSTALL_INFOA pInfo)
  {
    m_nInstallStatus = crInstallA(pInfo);
  }

  CrAutoInstallHelper(__in PCR_INSTALL_INFOW pInfo)
  {
    m_nInstallStatus = crInstallW(pInfo);
  }

  ~CrAutoInstallHelper()
  {
    crUninstall();
  }

  int m_nInstallStatus;
};

class CrThreadAutoInstallHelper
{
public:

  CrThreadAutoInstallHelper(DWORD dwFlags=0)
  {
    m_nInstallStatus = crInstallToCurrentThread2(dwFlags);    
  }

  ~CrThreadAutoInstallHelper()
  {
    crUninstallFromCurrentThread();
  }

  int m_nInstallStatus;
};

#endif //!_CRASHRPT_NO_WRAPPERS

#endif //_CRASHRPT_H_