[wxWidgets.git] / include / wx / debug.h

/**
*  Name:        wx/debug.h
*  Purpose:     Misc debug functions and macros
*  Author:      Vadim Zeitlin
*  Modified by: Ryan Norton (Converted to C)
*  Created:     29/01/98
*  RCS-ID:      $Id$
*  Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
*  Licence:     wxWindows licence
*/

/* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */

#ifndef   _WX_DEBUG_H_
#define   _WX_DEBUG_H_

#ifndef __WXPALMOS5__
#ifndef __WXWINCE__
#include  <assert.h>
#endif
#endif // ! __WXPALMOS5__
#include  <limits.h>            /*  for CHAR_BIT used below */

#include  "wx/chartype.h"     /*  for __TFILE__ and wxChar */

/*  ---------------------------------------------------------------------------- */
/*  Defines controlling the debugging macros */
/*  ---------------------------------------------------------------------------- */

/*  if _DEBUG is defined (MS VC++ and others use it in debug builds), define */
/*  __WXDEBUG__ too */
#ifdef _DEBUG
    #ifndef __WXDEBUG__
        #define __WXDEBUG__
    #endif /*  !__WXDEBUG__ */
#endif /*  _DEBUG */

/*  if NDEBUG is defined (<assert.h> uses it), undef __WXDEBUG__ and WXDEBUG */
#ifdef NDEBUG
    #undef __WXDEBUG__
    #undef WXDEBUG
#endif /*  NDEBUG */

/*  if __WXDEBUG__ is defined, make sure that WXDEBUG is defined and >= 1 */
#ifdef __WXDEBUG__
    #if !defined(WXDEBUG) || !WXDEBUG
        #undef WXDEBUG
        #define WXDEBUG 1
    #endif /*  !WXDEBUG */
#endif /*  __WXDEBUG__ */

#ifndef __WXFUNCTION__
    /* TODO: add more compilers supporting __FUNCTION__ */
    #if defined(__DMC__)
        /* 
           __FUNCTION__ happens to be not defined within class members
           http://www.digitalmars.com/drn-bin/wwwnews?c%2B%2B.beta/485
        */
        #define __WXFUNCTION__ (NULL)
    #elif defined(__GNUC__) || \
          (defined(_MSC_VER) && _MSC_VER >= 1300) || \
          defined(__FUNCTION__)
        #define __WXFUNCTION__ __FUNCTION__
    #else
        /* still define __WXFUNCTION__ to avoid #ifdefs elsewhere */
        #define __WXFUNCTION__ (NULL)
    #endif
#endif /* __WXFUNCTION__ already defined */

/*  ---------------------------------------------------------------------------- */
/*  Debugging macros */
/*  */
/*  All debugging macros rely on ASSERT() which in turn calls the user-defined */
/*  OnAssert() function. To keep things simple, it's called even when the */
/*  expression is true (i.e. everything is ok) and by default does nothing: just */
/*  returns the same value back. But if you redefine it to do something more sexy */
/*  (popping up a message box in your favourite GUI, sending you e-mail or */
/*  whatever) it will affect all ASSERTs, FAILs and CHECKs in your code. */
/*  */
/*  Warning: if you don't like advice on programming style, don't read */
/*  further! ;-) */
/*  */
/*  Extensive use of these macros is recommended! Remember that ASSERTs are */
/*  disabled in final build (without __WXDEBUG__ defined), so they add strictly */
/*  nothing to your program's code. On the other hand, CHECK macros do stay */
/*  even in release builds, but in general are not much of a burden, while */
/*  a judicious use of them might increase your program's stability. */
/*  ---------------------------------------------------------------------------- */

/*  Macros which are completely disabled in 'release' mode */
/*  */
/*  NB: these functions are implemented in src/common/appcmn.cpp */
#if defined(__cplusplus) && defined(__WXDEBUG__)
  /*
    This function is called whenever one of debugging macros fails (i.e.
    condition is false in an assertion). To customize its behaviour, override
    wxApp::OnAssertFailure().

    Parameters:
       szFile and nLine - file name and line number of the ASSERT
       szFunc           - function name of the ASSERT, may be NULL (NB: ASCII)
       szCond           - text form of the condition which failed
       szMsg            - optional message explaining the reason
  */

  /* this version is for compatibility with wx 2.8 Unicode build only: */
  extern void WXDLLIMPEXP_BASE wxOnAssert(const wxChar *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const wxChar *szCond,
                                          const wxChar *szMsg = NULL);

#if wxUSE_UNICODE
  /* char versions are used by debugging macros; we have to provide
     wxChar* szMsg version because it's common to use _T() in the macros
     and finally, we can't use const wx(char)* szMsg = NULL, because that
     would be ambiguous: */
  extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const char *szCond);

  extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const char *szCond,
                                          const char *szMsg);

  extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const char *szCond,
                                          const wxChar *szMsg);
#endif /* wxUSE_UNICODE */

  class WXDLLIMPEXP_FWD_BASE wxString;
  class WXDLLIMPEXP_FWD_BASE wxCStrData;

  /* these two work when szMsg passed to debug macro is a string,
     we also have to provide wxCStrData overload to resolve ambiguity
     which would otherwise arise from wxASSERT( s.c_str() ): */
  extern void WXDLLIMPEXP_BASE wxOnAssert(const wxString& szFile,
                                          int nLine,
                                          const wxString& szFunc,
                                          const wxString& szCond,
                                          const wxString& szMsg);

  extern void WXDLLIMPEXP_BASE wxOnAssert(const wxString& szFile,
                                          int nLine,
                                          const wxString& szFunc,
                                          const wxString& szCond);

  extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const char *szCond,
                                          const wxCStrData& msg);

  extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
                                          int nLine,
                                          const char *szFunc,
                                          const char *szCond,
                                          const wxString& szMsg);

  /*  call this function to break into the debugger unconditionally (assuming */
  /*  the program is running under debugger, of course) */
  extern void WXDLLIMPEXP_BASE wxTrap();

  /*  generic assert macro */
  #define wxASSERT(cond) wxASSERT_MSG(cond, (const char*)NULL)


  /*  assert with additional message explaining its cause */

  /*  compilers can give a warning (such as "possible unwanted ;") when using */
  /*  the default definition of wxASSERT_MSG so we provide an alternative */
  #if defined(__MWERKS__)
    #define wxASSERT_MSG(cond, msg)                                           \
      if ( cond )                                                             \
      {}                                                                      \
      else                                                                    \
          wxOnAssert(__FILE__, __LINE__, __WXFUNCTION__, #cond, msg)
  #else
    #define wxASSERT_MSG(cond, msg)                                           \
      if ( cond )                                                             \
          ;                                                                   \
      else                                                                    \
          wxOnAssert(__FILE__, __LINE__, __WXFUNCTION__, #cond, msg)
  #endif

  /*  special form of assert: always triggers it (in debug mode) */
  #define wxFAIL wxFAIL_MSG((const char*)NULL)

  /*  FAIL with some message */
  #define wxFAIL_MSG(msg) wxFAIL_COND_MSG("wxAssertFailure", msg)

  /*  FAIL with some message and a condition */
  #define wxFAIL_COND_MSG(cond, msg)                                          \
      wxOnAssert(__FILE__, __LINE__,  __WXFUNCTION__, cond, msg)

  /*  An assert helper used to avoid warning when testing constant expressions, */
  /*  i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */
  /*  expression being always true, but not using */
  /*  wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */
  /*  */
  /*  NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and should no */
  /*      longer be used. */
  extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
#else
  #define wxTrap()

  /*  nothing to do in release mode (hopefully at this moment there are */
  /*  no more bugs ;-) */
  #define wxASSERT(cond)
  #define wxASSERT_MSG(cond, msg)
  #define wxFAIL
  #define wxFAIL_MSG(msg)
  #define wxFAIL_COND_MSG(cond, msg)
#endif  /* __WXDEBUG__ */

#ifdef __cplusplus
    /*  Use of wxFalse instead of false suppresses compiler warnings about testing */
    /*  constant expression */
    extern WXDLLIMPEXP_DATA_BASE(const bool) wxFalse;
#endif

#define wxAssertFailure wxFalse

/*  NB: the following macros also work in release mode! */

/*
  These macros must be used only in invalid situation: for example, an
  invalid parameter (e.g. a NULL pointer) is passed to a function. Instead of
  dereferencing it and causing core dump the function might try using
  CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
*/

/*  check that expression is true, "return" if not (also FAILs in debug mode) */
#define wxCHECK(cond, rc)            wxCHECK_MSG(cond, rc, (const char*)NULL)

/*  as wxCHECK but with a message explaining why we fail */
#define wxCHECK_MSG(cond, rc, msg)   wxCHECK2_MSG(cond, return rc, msg)

/*  check that expression is true, perform op if not */
#define wxCHECK2(cond, op)           wxCHECK2_MSG(cond, op, (const char*)NULL)

/*  as wxCHECK2 but with a message explaining why we fail */

/* see comment near the definition of wxASSERT_MSG for the # if/else reason */
#if defined(__MWERKS__)
    #define wxCHECK2_MSG(cond, op, msg)                                       \
        if ( cond )                                                           \
        {}                                                                    \
        else                                                                  \
        {                                                                     \
            wxFAIL_COND_MSG(#cond, msg);                                      \
            op;                                                               \
        }                                                                     \
        struct wxDummyCheckStruct /* just to force a semicolon */
#else
    #define wxCHECK2_MSG(cond, op, msg)                                       \
        if ( cond )                                                           \
            ;                                                                 \
        else                                                                  \
        {                                                                     \
            wxFAIL_COND_MSG(#cond, msg);                                      \
            op;                                                               \
        }                                                                     \
        struct wxDummyCheckStruct /* just to force a semicolon */
#endif

/*  special form of wxCHECK2: as wxCHECK, but for use in void functions */
/*  */
/*  NB: there is only one form (with msg parameter) and it's intentional: */
/*      there is no other way to tell the caller what exactly went wrong */
/*      from the void function (of course, the function shouldn't be void */
/*      to begin with...) */
#define wxCHECK_RET(cond, msg)       wxCHECK2_MSG(cond, return, msg)

/*  ---------------------------------------------------------------------------- */
/*  Compile time asserts */
/*  */
/*  Unlike the normal assert and related macros above which are checked during */
/*  the program tun-time the macros below will result in a compilation error if */
/*  the condition they check is false. This is usually used to check the */
/*  expressions containing sizeof()s which cannot be tested with the */
/*  preprocessor. If you can use the #if's, do use them as you can give a more */
/*  detailed error message then. */
/*  ---------------------------------------------------------------------------- */

/*
  How this works (you don't have to understand it to be able to use the
  macros): we rely on the fact that it is invalid to define a named bit field
  in a struct of width 0. All the rest are just the hacks to minimize the
  possibility of the compiler warnings when compiling this macro: in
  particular, this is why we define a struct and not an object (which would
  result in a warning about unused variable) and a named struct (otherwise we'd
  get a warning about an unnamed struct not used to define an object!).
 */

#define wxMAKE_UNIQUE_ASSERT_NAME           wxMAKE_UNIQUE_NAME(wxAssert_)

/*
  The second argument of this macro must be a valid C++ identifier and not a
  string. I.e. you should use it like this:

    wxCOMPILE_TIME_ASSERT( sizeof(int) >= 2, YourIntsAreTooSmall );

 It may be used both within a function and in the global scope.
*/
#if defined(__WATCOMC__) && defined(__cplusplus)
    /* avoid "unused symbol" warning */
    #define wxCOMPILE_TIME_ASSERT(expr, msg) \
        class wxMAKE_UNIQUE_ASSERT_NAME { \
          unsigned int msg: expr; \
          wxMAKE_UNIQUE_ASSERT_NAME() { wxUnusedVar(msg); } \
        }
#else
    #define wxCOMPILE_TIME_ASSERT(expr, msg) \
        struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; }
#endif

/*
   When using VC++ 6 with "Edit and Continue" on, the compiler completely
   mishandles __LINE__ and so wxCOMPILE_TIME_ASSERT() doesn't work, provide a
   way to make "unique" assert names by specifying a unique prefix explicitly
 */
#define wxMAKE_UNIQUE_ASSERT_NAME2(text) wxCONCAT(wxAssert_, text)

#define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \
    struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; }

/*  helpers for wxCOMPILE_TIME_ASSERT below, for private use only */
#define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits

/*  a special case of compile time assert: check that the size of the given type */
/*  is at least the given number of bits */
#define wxASSERT_MIN_BITSIZE(type, size) \
    wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \
                          wxMAKE_BITSIZE_MSG(type, size))

/*  ---------------------------------------------------------------------------- */
/*  other miscellaneous debugger-related functions */
/*  ---------------------------------------------------------------------------- */

/*
    Return true if we're running under debugger.

    Currently this only really works under Win32 and Mac in CodeWarrior builds,
    it always returns false in other cases.
 */
#ifdef __cplusplus
    /* ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port */
    #if defined(__WXMAC__) || defined(__WIN32__)
        extern bool WXDLLIMPEXP_BASE wxIsDebuggerRunning();
    #else /*  !Mac */
        inline bool wxIsDebuggerRunning() { return false; }
    #endif /*  Mac/!Mac */
#endif /* __cplusplus */

#endif  /*  _WX_DEBUG_H_ */
Commit	Line	Data
e0c749a7	1	/**
68379eaf WS	2	* Name: wx/debug.h
	3	* Purpose: Misc debug functions and macros
	4	* Author: Vadim Zeitlin
e0c749a7	5	* Modified by: Ryan Norton (Converted to C)
68379eaf WS	6	* Created: 29/01/98
	7	* RCS-ID: $Id$
	8	* Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
	9	* Licence: wxWindows licence
e0c749a7 RN	10	*/
	11
	12	/* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */
c801d85f	13
34138703 JS	14	#ifndef _WX_DEBUG_H_
34138703 JS	15	#define _WX_DEBUG_H_
c801d85f	16
9b4da627	17	#ifndef __WXPALMOS5__
0e0126c2	18	#ifndef __WXWINCE__
c801d85f	19	#include <assert.h>
0e0126c2	20	#endif
9b4da627	21	#endif // ! __WXPALMOS5__
e0c749a7	22	#include <limits.h> /* for CHAR_BIT used below */
c801d85f	23
e3f6cbd9	24	#include "wx/chartype.h" /* for __TFILE__ and wxChar */
9e3d3318	25
e0c749a7 RN	26	/* ---------------------------------------------------------------------------- */
	27	/* Defines controlling the debugging macros */
	28	/* ---------------------------------------------------------------------------- */
8b0bd21b	29
e0c749a7 RN	30	/* if _DEBUG is defined (MS VC++ and others use it in debug builds), define */
e0c749a7 RN	31	/* __WXDEBUG__ too */
8b0bd21b VZ	32	#ifdef _DEBUG
	33	#ifndef __WXDEBUG__
	34	#define __WXDEBUG__
e0c749a7 RN	35	#endif /* !__WXDEBUG__ */
e0c749a7 RN	36	#endif /* _DEBUG */
8b0bd21b	37
e0c749a7	38	/* if NDEBUG is defined (<assert.h> uses it), undef __WXDEBUG__ and WXDEBUG */
8b0bd21b VZ	39	#ifdef NDEBUG
	40	#undef __WXDEBUG__
	41	#undef WXDEBUG
e0c749a7	42	#endif /* NDEBUG */
8b0bd21b	43
e0c749a7	44	/* if __WXDEBUG__ is defined, make sure that WXDEBUG is defined and >= 1 */
8b0bd21b VZ	45	#ifdef __WXDEBUG__
	46	#if !defined(WXDEBUG) \|\| !WXDEBUG
	47	#undef WXDEBUG
	48	#define WXDEBUG 1
e0c749a7 RN	49	#endif /* !WXDEBUG */
	50	#endif /* __WXDEBUG__ */
	51
986d27c3 VZ	52	#ifndef __WXFUNCTION__
986d27c3 VZ	53	/* TODO: add more compilers supporting __FUNCTION__ */
a9672e89 WS	54	#if defined(__DMC__)
	55	/*
	56	__FUNCTION__ happens to be not defined within class members
	57	http://www.digitalmars.com/drn-bin/wwwnews?c%2B%2B.beta/485
	58	*/
	59	#define __WXFUNCTION__ (NULL)
	60	#elif defined(__GNUC__) \|\| \
	61	(defined(_MSC_VER) && _MSC_VER >= 1300) \|\| \
	62	defined(__FUNCTION__)
986d27c3 VZ	63	#define __WXFUNCTION__ __FUNCTION__
	64	#else
	65	/* still define __WXFUNCTION__ to avoid #ifdefs elsewhere */
	66	#define __WXFUNCTION__ (NULL)
	67	#endif
	68	#endif /* __WXFUNCTION__ already defined */
dfa0b52f	69
e0c749a7 RN	70	/* ---------------------------------------------------------------------------- */
	71	/* Debugging macros */
	72	/* */
6a17b868	73	/* All debugging macros rely on ASSERT() which in turn calls the user-defined */
e0c749a7	74	/* OnAssert() function. To keep things simple, it's called even when the */
68379eaf	75	/* expression is true (i.e. everything is ok) and by default does nothing: just */
e0c749a7 RN	76	/* returns the same value back. But if you redefine it to do something more sexy */
	77	/* (popping up a message box in your favourite GUI, sending you e-mail or */
	78	/* whatever) it will affect all ASSERTs, FAILs and CHECKs in your code. */
	79	/* */
	80	/* Warning: if you don't like advice on programming style, don't read */
	81	/* further! ;-) */
	82	/* */
	83	/* Extensive use of these macros is recommended! Remember that ASSERTs are */
	84	/* disabled in final build (without __WXDEBUG__ defined), so they add strictly */
	85	/* nothing to your program's code. On the other hand, CHECK macros do stay */
	86	/* even in release builds, but in general are not much of a burden, while */
	87	/* a judicious use of them might increase your program's stability. */
	88	/* ---------------------------------------------------------------------------- */
	89
	90	/* Macros which are completely disabled in 'release' mode */
	91	/* */
	92	/* NB: these functions are implemented in src/common/appcmn.cpp */
34cbe514	93	#if defined(__cplusplus) && defined(__WXDEBUG__)
7ba4fbeb	94	/*
497a2d6d VZ	95	This function is called whenever one of debugging macros fails (i.e.
497a2d6d VZ	96	condition is false in an assertion). To customize its behaviour, override
2b232d20	97	wxApp::OnAssertFailure().
7ba4fbeb	98
497a2d6d	99	Parameters:
7ba4fbeb	100	szFile and nLine - file name and line number of the ASSERT
acc476c5	101	szFunc - function name of the ASSERT, may be NULL (NB: ASCII)
497a2d6d	102	szCond - text form of the condition which failed
7ba4fbeb	103	szMsg - optional message explaining the reason
c801d85f	104	*/
0accd1cf	105
2b232d20	106	/* this version is for compatibility with wx 2.8 Unicode build only: */
bddd7a8d	107	extern void WXDLLIMPEXP_BASE wxOnAssert(const wxChar *szFile,
886dd7d2	108	int nLine,
acc476c5	109	const char *szFunc,
886dd7d2 VZ	110	const wxChar *szCond,
886dd7d2 VZ	111	const wxChar *szMsg = NULL);
749b01f0	112
0accd1cf VS	113	#if wxUSE_UNICODE
	114	/* char versions are used by debugging macros; we have to provide
	115	wxChar* szMsg version because it's common to use _T() in the macros
	116	and finally, we can't use const wx(char)* szMsg = NULL, because that
	117	would be ambiguous: */
	118	extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
	119	int nLine,
	120	const char *szFunc,
	121	const char *szCond);
	122
	123	extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
	124	int nLine,
	125	const char *szFunc,
	126	const char *szCond,
	127	const char *szMsg);
	128
	129	extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
	130	int nLine,
	131	const char *szFunc,
	132	const char *szCond,
	133	const wxChar *szMsg);
28efe654	134	#endif /* wxUSE_UNICODE */
0accd1cf	135
b5dbe15d VS	136	class WXDLLIMPEXP_FWD_BASE wxString;
b5dbe15d VS	137	class WXDLLIMPEXP_FWD_BASE wxCStrData;
2b232d20 VZ	138
	139	/* these two work when szMsg passed to debug macro is a string,
	140	we also have to provide wxCStrData overload to resolve ambiguity
	141	which would otherwise arise from wxASSERT( s.c_str() ): */
0accd1cf VS	142	extern void WXDLLIMPEXP_BASE wxOnAssert(const wxString& szFile,
	143	int nLine,
	144	const wxString& szFunc,
	145	const wxString& szCond,
	146	const wxString& szMsg);
	147
	148	extern void WXDLLIMPEXP_BASE wxOnAssert(const wxString& szFile,
	149	int nLine,
	150	const wxString& szFunc,
	151	const wxString& szCond);
	152
2b232d20 VZ	153	extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
	154	int nLine,
	155	const char *szFunc,
	156	const char *szCond,
	157	const wxCStrData& msg);
	158
fbaf7d45 VS	159	extern void WXDLLIMPEXP_BASE wxOnAssert(const char *szFile,
	160	int nLine,
	161	const char *szFunc,
	162	const char *szCond,
	163	const wxString& szMsg);
	164
e0c749a7 RN	165	/* call this function to break into the debugger unconditionally (assuming */
e0c749a7 RN	166	/* the program is running under debugger, of course) */
bddd7a8d	167	extern void WXDLLIMPEXP_BASE wxTrap();
c801d85f	168
e0c749a7	169	/* generic assert macro */
0accd1cf	170	#define wxASSERT(cond) wxASSERT_MSG(cond, (const char*)NULL)
3b1de9c2	171
9d73af58 DS	172
	173	/* assert with additional message explaining its cause */
	174
	175	/* compilers can give a warning (such as "possible unwanted ;") when using */
	176	/* the default definition of wxASSERT_MSG so we provide an alternative */
	177	#if defined(__MWERKS__)
	178	#define wxASSERT_MSG(cond, msg) \
	179	if ( cond ) \
	180	{} \
	181	else \
0accd1cf	182	wxOnAssert(__FILE__, __LINE__, __WXFUNCTION__, #cond, msg)
9d73af58 DS	183	#else
	184	#define wxASSERT_MSG(cond, msg) \
	185	if ( cond ) \
	186	; \
	187	else \
0accd1cf	188	wxOnAssert(__FILE__, __LINE__, __WXFUNCTION__, #cond, msg)
9d73af58	189	#endif
497a2d6d VZ	190
497a2d6d VZ	191	/* special form of assert: always triggers it (in debug mode) */
0accd1cf	192	#define wxFAIL wxFAIL_MSG((const char*)NULL)
497a2d6d VZ	193
497a2d6d VZ	194	/* FAIL with some message */
b503b407 VZ	195	#define wxFAIL_MSG(msg) wxFAIL_COND_MSG("wxAssertFailure", msg)
	196
	197	/* FAIL with some message and a condition */
	198	#define wxFAIL_COND_MSG(cond, msg) \
0accd1cf	199	wxOnAssert(__FILE__, __LINE__, __WXFUNCTION__, cond, msg)
749b01f0	200
6a17b868	201	/* An assert helper used to avoid warning when testing constant expressions, */
e0c749a7 RN	202	/* i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */
	203	/* expression being always true, but not using */
	204	/* wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */
	205	/* */
6a17b868 SN	206	/* NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and should no */
6a17b868 SN	207	/* longer be used. */
bddd7a8d	208	extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
c801d85f	209	#else
749b01f0 VZ	210	#define wxTrap()
749b01f0 VZ	211
6a17b868	212	/* nothing to do in release mode (hopefully at this moment there are */
e0c749a7	213	/* no more bugs ;-) */
7ba4fbeb	214	#define wxASSERT(cond)
dfa0b52f	215	#define wxASSERT_MSG(cond, msg)
497a2d6d VZ	216	#define wxFAIL
497a2d6d VZ	217	#define wxFAIL_MSG(msg)
b503b407	218	#define wxFAIL_COND_MSG(cond, msg)
e0c749a7	219	#endif /* __WXDEBUG__ */
c801d85f	220
34cbe514	221	#ifdef __cplusplus
68379eaf	222	/* Use of wxFalse instead of false suppresses compiler warnings about testing */
e0c749a7	223	/* constant expression */
16cba29d	224	extern WXDLLIMPEXP_DATA_BASE(const bool) wxFalse;
34cbe514 RN	225	#endif
34cbe514 RN	226
2b5f62a0	227	#define wxAssertFailure wxFalse
8b0bd21b	228
6a17b868	229	/* NB: the following macros also work in release mode! */
c801d85f	230
7ba4fbeb	231	/*
c801d85f	232	These macros must be used only in invalid situation: for example, an
6a17b868	233	invalid parameter (e.g. a NULL pointer) is passed to a function. Instead of
c801d85f KB	234	dereferencing it and causing core dump the function might try using
c801d85f KB	235	CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
c801d85f	236	*/
7ba4fbeb	237
e0c749a7	238	/* check that expression is true, "return" if not (also FAILs in debug mode) */
0accd1cf	239	#define wxCHECK(cond, rc) wxCHECK_MSG(cond, rc, (const char*)NULL)
7ba4fbeb	240
e0c749a7	241	/* as wxCHECK but with a message explaining why we fail */
dfa0b52f	242	#define wxCHECK_MSG(cond, rc, msg) wxCHECK2_MSG(cond, return rc, msg)
7ba4fbeb	243
e0c749a7	244	/* check that expression is true, perform op if not */
0accd1cf	245	#define wxCHECK2(cond, op) wxCHECK2_MSG(cond, op, (const char*)NULL)
7ba4fbeb	246
e0c749a7	247	/* as wxCHECK2 but with a message explaining why we fail */
9d73af58 DS	248
	249	/* see comment near the definition of wxASSERT_MSG for the # if/else reason */
	250	#if defined(__MWERKS__)
	251	#define wxCHECK2_MSG(cond, op, msg) \
	252	if ( cond ) \
	253	{} \
	254	else \
	255	{ \
	256	wxFAIL_COND_MSG(#cond, msg); \
	257	op; \
	258	} \
	259	struct wxDummyCheckStruct /* just to force a semicolon */
	260	#else
	261	#define wxCHECK2_MSG(cond, op, msg) \
	262	if ( cond ) \
	263	; \
	264	else \
	265	{ \
	266	wxFAIL_COND_MSG(#cond, msg); \
	267	op; \
	268	} \
	269	struct wxDummyCheckStruct /* just to force a semicolon */
	270	#endif
7ba4fbeb	271
e0c749a7 RN	272	/* special form of wxCHECK2: as wxCHECK, but for use in void functions */
	273	/* */
	274	/* NB: there is only one form (with msg parameter) and it's intentional: */
	275	/* there is no other way to tell the caller what exactly went wrong */
	276	/* from the void function (of course, the function shouldn't be void */
	277	/* to begin with...) */
dfa0b52f	278	#define wxCHECK_RET(cond, msg) wxCHECK2_MSG(cond, return, msg)
c801d85f	279
e0c749a7 RN	280	/* ---------------------------------------------------------------------------- */
	281	/* Compile time asserts */
	282	/* */
	283	/* Unlike the normal assert and related macros above which are checked during */
	284	/* the program tun-time the macros below will result in a compilation error if */
	285	/* the condition they check is false. This is usually used to check the */
	286	/* expressions containing sizeof()s which cannot be tested with the */
	287	/* preprocessor. If you can use the #if's, do use them as you can give a more */
	288	/* detailed error message then. */
	289	/* ---------------------------------------------------------------------------- */
8f5d9104 VZ	290
	291	/*
	292	How this works (you don't have to understand it to be able to use the
	293	macros): we rely on the fact that it is invalid to define a named bit field
	294	in a struct of width 0. All the rest are just the hacks to minimize the
	295	possibility of the compiler warnings when compiling this macro: in
	296	particular, this is why we define a struct and not an object (which would
	297	result in a warning about unused variable) and a named struct (otherwise we'd
	298	get a warning about an unnamed struct not used to define an object!).
	299	*/
	300
9bf41e06	301	#define wxMAKE_UNIQUE_ASSERT_NAME wxMAKE_UNIQUE_NAME(wxAssert_)
8f5d9104 VZ	302
	303	/*
	304	The second argument of this macro must be a valid C++ identifier and not a
	305	string. I.e. you should use it like this:
	306
	307	wxCOMPILE_TIME_ASSERT( sizeof(int) >= 2, YourIntsAreTooSmall );
	308
	309	It may be used both within a function and in the global scope.
	310	*/
0872eaf9	311	#if defined(__WATCOMC__) && defined(__cplusplus)
1c6f2414 WS	312	/* avoid "unused symbol" warning */
	313	#define wxCOMPILE_TIME_ASSERT(expr, msg) \
	314	class wxMAKE_UNIQUE_ASSERT_NAME { \
	315	unsigned int msg: expr; \
871cc651	316	wxMAKE_UNIQUE_ASSERT_NAME() { wxUnusedVar(msg); } \
1c6f2414 WS	317	}
	318	#else
	319	#define wxCOMPILE_TIME_ASSERT(expr, msg) \
	320	struct wxMAKE_UNIQUE_ASSERT_NAME { unsigned int msg: expr; }
	321	#endif
8f5d9104	322
871cc651 VZ	323	/*
	324	When using VC++ 6 with "Edit and Continue" on, the compiler completely
	325	mishandles __LINE__ and so wxCOMPILE_TIME_ASSERT() doesn't work, provide a
	326	way to make "unique" assert names by specifying a unique prefix explicitly
	327	*/
	328	#define wxMAKE_UNIQUE_ASSERT_NAME2(text) wxCONCAT(wxAssert_, text)
7bb688a8	329
17dc7ddd WS	330	#define wxCOMPILE_TIME_ASSERT2(expr, msg, text) \
17dc7ddd WS	331	struct wxMAKE_UNIQUE_ASSERT_NAME2(text) { unsigned int msg: expr; }
8de1759c	332
e0c749a7	333	/* helpers for wxCOMPILE_TIME_ASSERT below, for private use only */
8f5d9104 VZ	334	#define wxMAKE_BITSIZE_MSG(type, size) type ## SmallerThan ## size ## Bits
8f5d9104 VZ	335
e0c749a7 RN	336	/* a special case of compile time assert: check that the size of the given type */
e0c749a7 RN	337	/* is at least the given number of bits */
8f5d9104 VZ	338	#define wxASSERT_MIN_BITSIZE(type, size) \
	339	wxCOMPILE_TIME_ASSERT(sizeof(type) * CHAR_BIT >= size, \
	340	wxMAKE_BITSIZE_MSG(type, size))
	341
e0c749a7 RN	342	/* ---------------------------------------------------------------------------- */
	343	/* other miscellaneous debugger-related functions */
	344	/* ---------------------------------------------------------------------------- */
a434b43f	345
c50a4038 VZ	346	/*
	347	Return true if we're running under debugger.
	348
	349	Currently this only really works under Win32 and Mac in CodeWarrior builds,
	350	it always returns false in other cases.
	351	*/
34cbe514	352	#ifdef __cplusplus
532d575b WS	353	/* ABX: check __WIN32__ instead of __WXMSW__ for the same MSWBase in any Win32 port */
532d575b WS	354	#if defined(__WXMAC__) \|\| defined(__WIN32__)
34cbe514	355	extern bool WXDLLIMPEXP_BASE wxIsDebuggerRunning();
e0c749a7	356	#else /* !Mac */
34cbe514	357	inline bool wxIsDebuggerRunning() { return false; }
e0c749a7 RN	358	#endif /* Mac/!Mac */
e0c749a7 RN	359	#endif /* __cplusplus */
a434b43f	360
e0c749a7	361	#endif /* _WX_DEBUG_H_ */