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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                  check.h                                  */
   4 /*                                                                           */
   5 /*                            Assert like macros                             */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2001 Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@cc65.org                                                 */
  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 #include "attrib.h"
  42
  43
  44
  45 /*****************************************************************************/
  46 /*                                   Data                                    */
  47 /*****************************************************************************/
  48
  49
  50
  51 extern const char* MsgInternalError;            /* "Internal error: "        */
  52 extern const char* MsgPrecondition;             /* "Precondition violated: " */
  53 extern const char* MsgCheckFailed;              /* "Check failed: "          */
  54 extern const char* MsgProgramAborted;           /* "Program aborted: "       */
  55
  56
  57
  58 extern void (*CheckFailed) (const char* Msg, const char* Cond,
  59                             const char* File, unsigned Line)
  60                             attribute ((noreturn));
  61 /* Function pointer that is called from check if the condition code is true. */
  62
  63
  64
  65 /*****************************************************************************/
  66 /*                                   Code                                    */
  67 /*****************************************************************************/
  68
  69
  70
  71 #define FAIL(s) CheckFailed (MsgInternalError, s, __FILE__, __LINE__)
  72 /* Fail macro. Is used if something evil happens, calls checkfailed directly. */
  73
  74 #define ABORT(s) CheckFailed (MsgProgramAborted, s, __FILE__, __LINE__)
  75 /* Use this one instead of FAIL if there is no internal program error but an
  76 ** error condition that is caused by the user or operating system (FAIL and
  77 ** ABORT are essentially the same but the message differs).
  78 */
  79
  80 #define PRECONDITION(c) \
  81     ((void) ((c)? 0 : (CheckFailed (MsgPrecondition, #c, __FILE__, __LINE__), 0)))
  82
  83 #define CHECK(c)        \
  84     ((void) ((c)? 0 : (CheckFailed (MsgCheckFailed, #c, __FILE__, __LINE__), 0)))
  85
  86
  87
  88 /* End of check.h */
  89
  90 #endif