src/Headers/splintMacros.nf

   1 /* ;-*-C-*-;
   2 **    Copyright (c) Massachusetts Institute of Technology 1994, 1995.
   3 **          All Rights Reserved.
   4 **          Unpublished rights reserved under the copyright laws of
   5 **          the United States.
   6 **
   7 ** THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   8 ** OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   9 **
  10 ** This code is distributed freely and may be used freely under the
  11 ** following conditions:
  12 **
  13 **     1. This notice may not be removed or altered.
  14 **
  15 **     2. This code may not be re-distributed or modified
  16 **        without permission from MIT (contact
  17 **        lclint-request@larch.lcs.mit.edu.)
  18 **
  19 **        Modification and re-distribution are encouraged,
  20 **        but we want to keep track of changes and
  21 **        distribution sites.
  22 */
  23
  24 # ifndef LCLINTMACROS_H
  25 # define LCLINTMACROS_H
  26
  27
  28 /*
  29 ** This file contains notfunction macros (hence, the .nf extension to
  30 ** prevent it being skipped when +neverinclude is used.)
  31 */
  32
  33 /*@notfunction@*/
  34 # define BADEXIT \
  35  /*@notreached@*/ do { llassertprint(FALSE, ("Reached dead code!")); \
  36                        exit(EXIT_FAILURE); } while (FALSE)
  37
  38 /*@notfunction@*/
  39 # define BADBRANCH \
  40   /*@notreached@*/ BADBRANCHCONT
  41
  42 /*@notfunction@*/
  43 # define BADBRANCHNULL \
  44   /*@notreached@*/ BADBRANCHCONT ; /*@notreached@*/ /*@-mustfree@*/ /*@-globstate@*/ return NULL; /*@=mustfree@*/ /*@=globstate@*/
  45
  46 /*@notfunction@*/
  47 # define BADBRANCHCONT \
  48   do { llassertprint (FALSE, ("Bad branch taken!")); } while (FALSE)
  49
  50 /*@notfunction@*/
  51 # define BADBRANCHRET(r) \
  52   /*@notreached@*/ BADBRANCHCONT ; /*@notreached@*/ /*@-mustfree@*/ /*@-globstate@*/ return (r); /*@=mustfree@*/ /*@=globstate@*/
  53
  54 /*@notfunction@*/
  55 # define BADDEFAULT \
  56   default: llassertprint (FALSE, ("Unexpected default case reached!")); \
  57            exit (EXIT_FAILURE);
  58
  59 /*@-namechecks@*/
  60 /*@notfunction@*/
  61 # define llassertprint(tst,p) \
  62    do { \
  63      if (!(tst)) { \
  64       llbug (message("%q:%d: llassert failed: " #tst ": %q", \
  65                      cstring_makeLiteral (__FILE__), __LINE__,\
  66                      /*@-mustfree@*/ message p) /*@=mustfree@*/ ); \
  67      }} while (FALSE)
  68
  69 /*@notfunction@*/
  70 # define abst_typedef typedef /*@abstract@*/
  71
  72 /*@notfunction@*/
  73 # define immut_typedef typedef /*@abstract@*/ /*@immutable@*/
  74
  75 /*@=namechecks@*/
  76
  77 /*
  78 ** SunOS4 can't handle bit fields correctly.
  79 */
  80
  81 # ifdef SYSSunOS
  82 /*@notfunction@*/
  83 # define BOOLBITS
  84 # else
  85 /*@notfunction@*/
  86 # define BOOLBITS : 1
  87 # endif
  88
  89 /*
  90 ** some stupid proprocessors replace the s in %s...had
  91 ** to change s to arg.
  92 */
  93
  94 /*@notfunction@*/
  95 # define NOALIAS(s,t) (/*@ignore@*/ (s == NULL) || (s != t) /*@end@*/)
  96
  97 /* evans 2002-02-24: got rid of -formatconst */
  98
  99 /*@notfunction@*/
 100 # define TPRINTF(arg) \
 101   do { /*@-mustfree@*/ /*@-null@*/ (void) fflush (stderr); (void) fflush (stdout); \
 102         printf ("%s:%d [%s]: >> ", __FILE__, __LINE__, cstring_toCharsSafe (fileloc_unparse(g_currentloc))); \
 103         (void)printf arg; printf("\n"); /*@=mustfree@*/ /*@=null@*/ (void) fflush (stdout); \
 104         } while (FALSE)
 105
 106 /*
 107 ** DPRINTF does nothing, just a marker to save TPRINTF's
 108 */
 109
 110 /*@notfunction@*/
 111 # define DPRINTF(s)
 112
 113 /*@notfunction@*/
 114 # define INTCOMPARERETURN(x,y) \
 115    do { if ((x) > (y)) { return 1; } \
 116         else { if ((x) < (y)) { return -1; }}} while (FALSE);
 117
 118 /*@notfunction@*/
 119 # define COMPARERETURN(z) \
 120    do { if (z != 0) { return z; } } while (FALSE);
 121
 122 # else
 123 # error "Multiple include"
 124 # endif
 125
 126