src/qual.c

   1 /*
   2 ** Splint - annotation-assisted static program checker
   3 ** Copyright (C) 1994-2002 University of Virginia,
   4 **         Massachusetts Institute of Technology
   5 **
   6 ** This program is free software; you can redistribute it and/or modify it
   7 ** under the terms of the GNU General Public License as published by the
   8 ** Free Software Foundation; either version 2 of the License, or (at your
   9 ** option) any later version.
  10 **
  11 ** This program is distributed in the hope that it will be useful, but
  12 ** WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ** General Public License for more details.
  15 **
  16 ** The GNU General Public License is available from http://www.gnu.org/ or
  17 ** the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  18 ** MA 02111-1307, USA.
  19 **
  20 ** For information on splint: info@splint.org
  21 ** To report a bug: splint-bug@splint.org
  22 ** For more information: http://www.splint.org
  23 */
  24 /*
  25 ** qual.c
  26 **
  27 ** representation of type qualifiers
  28 */
  29
  30 # include "splintMacros.nf"
  31 # include "basic.h"
  32
  33 static qual qual_createPlainAux (int i)
  34 {
  35   qual res = (qual) dmalloc (sizeof (*res));
  36   res->kind = (quenum) i;
  37   res->info = annotationInfo_undefined;
  38
  39   sfreeEventually (res); /* stored in qtable */
  40   return res;
  41 }
  42
  43 extern qual qual_createPlain (quenum q)
  44 {
  45   static bool isinit = FALSE;
  46   static qual qtable[QU_LAST];
  47
  48   if (!isinit) {
  49     int i = (int) QU_UNKNOWN;
  50
  51     while (i < (int) QU_LAST) {
  52       qtable[i] = qual_createPlainAux (i);
  53       i++;
  54     }
  55
  56     isinit = TRUE;
  57   }
  58
  59   llassert (q != QU_USERANNOT && q < QU_LAST);
  60   return qtable[(int) q];
  61 }
  62
  63 extern qual qual_createMetaState (annotationInfo info)
  64 {
  65   qual res;
  66
  67   res = (qual) dmalloc (sizeof (*res));
  68   res->kind = QU_USERANNOT;
  69   res->info = info;
  70
  71   sfreeEventually (res); /* Memory leak */
  72   return res;
  73 }
  74
  75 static bool quenum_isValid (int q)
  76 {
  77   return ((quenum) q >= QU_UNKNOWN
  78           && ((quenum) q < QU_LAST));
  79 }
  80
  81 qual qual_fromInt (int q)
  82 {
  83   llassertprint (quenum_isValid (q), ("Invalid qual: %d", q));
  84   return (qual_createPlain ((quenum) q));
  85 }
  86
  87 cstring qual_unparse (qual q)
  88 {
  89   if (q->kind == QU_USERANNOT)
  90     {
  91       return (annotationInfo_unparse (q->info));
  92     }
  93   else
  94     {
  95       switch (q->kind)
  96         {
  97         case QU_UNKNOWN:    return cstring_makeLiteralTemp ("unknown");
  98         case QU_ABSTRACT:   return cstring_makeLiteralTemp ("abstract");
  99         case QU_CONCRETE:   return cstring_makeLiteralTemp ("concrete");
 100         case QU_MUTABLE:    return cstring_makeLiteralTemp ("mutable");
 101         case QU_IMMUTABLE:  return cstring_makeLiteralTemp ("immutable");
 102         case QU_SHORT:      return cstring_makeLiteralTemp ("short");
 103         case QU_LONG:       return cstring_makeLiteralTemp ("long");
 104         case QU_SIGNED:     return cstring_makeLiteralTemp ("signed");
 105         case QU_UNSIGNED:   return cstring_makeLiteralTemp ("unsigned");
 106         case QU_CONST:      return cstring_makeLiteralTemp ("const");
 107         case QU_RESTRICT:   return cstring_makeLiteralTemp ("restrict");
 108         case QU_VOLATILE:   return cstring_makeLiteralTemp ("volatile");
 109         case QU_INLINE:     return cstring_makeLiteralTemp ("inline");
 110         case QU_EXTERN:     return cstring_makeLiteralTemp ("extern");
 111         case QU_STATIC:     return cstring_makeLiteralTemp ("static");
 112         case QU_AUTO:       return cstring_makeLiteralTemp ("auto");
 113         case QU_REGISTER:   return cstring_makeLiteralTemp ("register");
 114         case QU_OUT:        return cstring_makeLiteralTemp ("out");
 115         case QU_IN:         return cstring_makeLiteralTemp ("in");
 116         case QU_RELDEF:     return cstring_makeLiteralTemp ("reldef");
 117         case QU_ONLY:       return cstring_makeLiteralTemp ("only");
 118         case QU_IMPONLY:    return cstring_makeLiteralTemp ("only");
 119         case QU_PARTIAL:    return cstring_makeLiteralTemp ("partial");
 120         case QU_SPECIAL:    return cstring_makeLiteralTemp ("special");
 121         case QU_KEEP:       return cstring_makeLiteralTemp ("keep");
 122         case QU_KEPT:       return cstring_makeLiteralTemp ("kept");
 123         case QU_YIELD:      return cstring_makeLiteralTemp ("yield");
 124         case QU_TEMP:       return cstring_makeLiteralTemp ("temp");
 125         case QU_SHARED:     return cstring_makeLiteralTemp ("shared");
 126         case QU_UNIQUE:     return cstring_makeLiteralTemp ("unique");
 127         case QU_UNCHECKED:  return cstring_makeLiteralTemp ("unchecked");
 128         case QU_CHECKED:    return cstring_makeLiteralTemp ("checked");
 129         case QU_CHECKMOD:   return cstring_makeLiteralTemp ("checkmod");
 130         case QU_CHECKEDSTRICT: return cstring_makeLiteralTemp ("checkedstrict");
 131         case QU_TRUENULL:   return cstring_makeLiteralTemp ("truenull");
 132         case QU_FALSENULL:  return cstring_makeLiteralTemp ("falsenull");
 133         case QU_NULL:       return cstring_makeLiteralTemp ("null");
 134         case QU_ISNULL:     return cstring_makeLiteralTemp ("isnull");
 135         case QU_RELNULL:    return cstring_makeLiteralTemp ("relnull");
 136         case QU_NOTNULL:    return cstring_makeLiteralTemp ("notnull");
 137         case QU_NULLTERMINATED: return cstring_makeLiteralTemp ("nullterminated");
 138         case QU_RETURNED:   return cstring_makeLiteralTemp ("returned");
 139         case QU_EXPOSED:    return cstring_makeLiteralTemp ("exposed");
 140         case QU_EXITS:      return cstring_makeLiteralTemp ("noreturn");
 141         case QU_MAYEXIT:    return cstring_makeLiteralTemp ("maynotreturn");
 142         case QU_UNUSED:     return cstring_makeLiteralTemp ("unused");
 143         case QU_EXTERNAL:   return cstring_makeLiteralTemp ("external");
 144         case QU_SEF:        return cstring_makeLiteralTemp ("sef");
 145         case QU_OBSERVER:   return cstring_makeLiteralTemp ("observer");
 146         case QU_REFCOUNTED: return cstring_makeLiteralTemp ("refcounted");
 147         case QU_REFS:       return cstring_makeLiteralTemp ("refs");
 148         case QU_NEWREF:     return cstring_makeLiteralTemp ("newref");
 149         case QU_KILLREF:    return cstring_makeLiteralTemp ("killref");
 150         case QU_TEMPREF:    return cstring_makeLiteralTemp ("tempref");
 151         case QU_OWNED:      return cstring_makeLiteralTemp ("owned");
 152         case QU_DEPENDENT:  return cstring_makeLiteralTemp ("dependent");
 153         case QU_NEVEREXIT:  return cstring_makeLiteralTemp ("alwaysreturns");
 154         case QU_TRUEEXIT:   return cstring_makeLiteralTemp ("noreturnwhentrue");
 155         case QU_FALSEEXIT:  return cstring_makeLiteralTemp ("noreturnwhenfalse");
 156         case QU_UNDEF:      return cstring_makeLiteralTemp ("undef");
 157         case QU_KILLED:     return cstring_makeLiteralTemp ("killed");
 158         case QU_PRINTFLIKE: return cstring_makeLiteralTemp ("printflike");
 159         case QU_SCANFLIKE:  return cstring_makeLiteralTemp ("scanflike");
 160         case QU_MESSAGELIKE:return cstring_makeLiteralTemp ("messagelike");
 161         case QU_SETBUFFERSIZE: return cstring_makeLiteralTemp("<qsetbuffersize>");
 162         case QU_LAST:       return cstring_makeLiteralTemp ("< last >");
 163         case QU_USERANNOT:  return cstring_makeLiteralTemp ("<user>");
 164         }
 165     }
 166
 167   BADEXIT;
 168 }
 169
 170 extern bool qual_match (qual q1, qual q2)
 171 {
 172   if (q1->kind == q2->kind) {
 173     if (q1->kind == QU_USERANNOT) {
 174       return (annotationInfo_equal (q1->info, q2->info));
 175     } else {
 176       return TRUE;
 177     }
 178   }
 179
 180   return FALSE;
 181 }
 182
 183 extern annotationInfo qual_getAnnotationInfo (qual q)
 184 {
 185   llassert (qual_isMetaState (q));
 186   return q->info;
 187 }
 188
 189 /* Cannot call qual_create after this... */
 190
 191 # if 0
 192 static void qual_free (qual q)
 193 {
 194   llassert (FALSE);
 195   sfree (q);
 196 }
 197 # endif
 198
 199 extern cstring qual_dump (qual q)
 200 {
 201   if (q->kind == QU_USERANNOT)
 202     {
 203       return message ("%d.%s",
 204                       (int) q->kind,
 205                       annotationInfo_dump (q->info));
 206     }
 207   else
 208     {
 209       return message ("%d", (int) q->kind);
 210     }
 211 }
 212
 213
 214 extern qual qual_undump (char **s)
 215 {
 216   quenum q = (quenum) reader_getInt (s);
 217
 218   if (q == QU_USERANNOT)
 219     {
 220       annotationInfo ai;
 221
 222       reader_checkChar (s, '.');
 223       ai = annotationInfo_undump (s);
 224
 225       return qual_createMetaState (ai);
 226     }
 227   else
 228     {
 229       return qual_createPlain (q);
 230     }
 231 }
 232
 233