git.sur5r.net Git - cc65/blob - src/cc65/check.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  check.h                                  */
   4 /*                                                                           */
   5 /*                   Assert macros for the cc65 C compiler                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998     Ullrich von Bassewitz                                        */
  10 /*              Wacholderweg 14                                              */
  11 /*              D-70597 Stuttgart                                            */
  12 /* EMail:       uz@musoftware.de                                             */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef CHECK_H
  37 #define CHECK_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                   Data                                    */
  43 /*****************************************************************************/
  44
  45
  46
  47 extern const char* _MsgInternalError;           /* "Internal error: "        */
  48 extern const char* _MsgPrecondition;            /* "Precondition violated: " */
  49 extern const char* _MsgCheckFailed;             /* "Check failed: "          */
  50 extern const char* _MsgProgramAborted;          /* "Program aborted: "       */
  51
  52
  53
  54 extern void (*CheckFailed) (const char* Msg, const char* Cond,
  55                             int Code, const char* File, unsigned Line);
  56 /* Function pointer that is called from check if the condition code is true. */
  57
  58
  59
  60 /*****************************************************************************/
  61 /*                                   Code                                    */
  62 /*****************************************************************************/
  63
  64
  65
  66 void Check (const char* Msg, const char* Cond, int Code,
  67             const char* File, unsigned Line);
  68 /* This function is called from all check macros (see below). It checks,
  69  * wether the given Code is true (!= 0). If so, it calls the CheckFailed
  70  * vector with the given strings. If not, it simply returns.
  71  */
  72
  73
  74
  75 #define FAIL(s) CheckFailed (_MsgInternalError, s, 0, __FILE__, __LINE__)
  76 /* Fail macro. Is used if something evil happens, calls checkfailed directly. */
  77
  78 #define ABORT(s) CheckFailed (_MsgProgramAborted, s, 0, __FILE__, __LINE__)
  79 /* Use this one instead of FAIL if there is no internal program error but an
  80  * error condition that is caused by the user or operating system (FAIL and
  81  * ABORT are essentially the same but the message differs).
  82  */
  83
  84 #define PRECONDITION(c) Check (_MsgPrecondition, #c, !(c), __FILE__, __LINE__)
  85
  86 #define CHECK(c)        Check (_MsgCheckFailed, #c, !(c), __FILE__, __LINE__)
  87
  88 #define ZCHECK(c)       Check (_MsgCheckFailed, #c, c, __FILE__, __LINE__)
  89
  90
  91
  92 /* End of check.h */
  93 #endif
  94
  95
  96