src/qual.c

   1 /*
   2 ** LCLint - annotation-assisted static program checker
   3 ** Copyright (C) 1994-2001 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 lclint: lclint-request@cs.virginia.edu
  21 ** To report a bug: lclint-bug@cs.virginia.edu
  22 ** For more information: http://lclint.cs.virginia.edu
  23 */
  24 /*
  25 ** qual.c
  26 **
  27 ** representation of type qualifiers
  28 */
  29
  30 # include "lclintMacros.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   /*@i23@*/ return res;
  40 }
  41
  42 extern qual qual_createPlain (quenum q)
  43 {
  44   static bool isinit = FALSE;
  45   static qual qtable[QU_LAST];
  46
  47   if (!isinit) {
  48     int i = (int) QU_UNKNOWN;
  49
  50     while (i < (int) QU_LAST) {
  51       qtable[i] = qual_createPlainAux (i);
  52       i++;
  53     }
  54
  55     isinit = TRUE;
  56   }
  57
  58   llassert (q != QU_USERANNOT && q < QU_LAST);
  59   return qtable[(int) q];
  60 }
  61
  62 extern qual qual_createMetaState (annotationInfo info)
  63 {
  64   qual res;
  65
  66   res = (qual) dmalloc (sizeof (*res));
  67   res->kind = QU_USERANNOT;
  68   /*@i423@*/ res->info = info;
  69
  70   /*@i2583@*/ return res;
  71 }
  72
  73 static bool quenum_isValid (int q)
  74 {
  75   return ((quenum) q >= QU_UNKNOWN
  76           && ((quenum) q < QU_LAST));
  77 }
  78
  79 qual qual_fromInt (int q)
  80 {
  81   llassertprint (quenum_isValid (q), ("Invalid qual: %d", q));
  82   return (qual_createPlain ((quenum) q));
  83 }
  84
  85 cstring qual_unparse (qual q)
  86 {
  87   if (q->kind == QU_USERANNOT) {
  88     return (annotationInfo_unparse (q->info));
  89   } else {
  90     switch (q->kind)
  91       {
  92       case QU_UNKNOWN:    return cstring_makeLiteralTemp ("unknown");
  93       case QU_ABSTRACT:   return cstring_makeLiteralTemp ("abstract");
  94       case QU_CONCRETE:   return cstring_makeLiteralTemp ("concrete");
  95       case QU_MUTABLE:    return cstring_makeLiteralTemp ("mutable");
  96       case QU_IMMUTABLE:  return cstring_makeLiteralTemp ("immutable");
  97       case QU_SHORT:      return cstring_makeLiteralTemp ("short");
  98       case QU_LONG:       return cstring_makeLiteralTemp ("long");
  99       case QU_SIGNED:     return cstring_makeLiteralTemp ("signed");
 100       case QU_UNSIGNED:   return cstring_makeLiteralTemp ("unsigned");
 101       case QU_CONST:      return cstring_makeLiteralTemp ("const");
 102       case QU_VOLATILE:   return cstring_makeLiteralTemp ("volatile");
 103       case QU_INLINE:     return cstring_makeLiteralTemp ("inline");
 104       case QU_EXTERN:     return cstring_makeLiteralTemp ("extern");
 105       case QU_STATIC:     return cstring_makeLiteralTemp ("static");
 106       case QU_AUTO:       return cstring_makeLiteralTemp ("auto");
 107       case QU_REGISTER:   return cstring_makeLiteralTemp ("register");
 108       case QU_OUT:        return cstring_makeLiteralTemp ("out");
 109       case QU_IN:         return cstring_makeLiteralTemp ("in");
 110       case QU_RELDEF:     return cstring_makeLiteralTemp ("reldef");
 111       case QU_ONLY:       return cstring_makeLiteralTemp ("only");
 112       case QU_IMPONLY:    return cstring_makeLiteralTemp ("only");
 113       case QU_PARTIAL:    return cstring_makeLiteralTemp ("partial");
 114       case QU_SPECIAL:    return cstring_makeLiteralTemp ("special");
 115       case QU_KEEP:       return cstring_makeLiteralTemp ("keep");
 116       case QU_KEPT:       return cstring_makeLiteralTemp ("kept");
 117       case QU_YIELD:      return cstring_makeLiteralTemp ("yield");
 118       case QU_TEMP:       return cstring_makeLiteralTemp ("temp");
 119       case QU_SHARED:     return cstring_makeLiteralTemp ("shared");
 120       case QU_UNIQUE:     return cstring_makeLiteralTemp ("unique");
 121       case QU_UNCHECKED:  return cstring_makeLiteralTemp ("unchecked");
 122       case QU_CHECKED:    return cstring_makeLiteralTemp ("checked");
 123       case QU_CHECKMOD:   return cstring_makeLiteralTemp ("checkmod");
 124       case QU_CHECKEDSTRICT: return cstring_makeLiteralTemp ("checkedstrict");
 125       case QU_TRUENULL:   return cstring_makeLiteralTemp ("truenull");
 126       case QU_FALSENULL:  return cstring_makeLiteralTemp ("falsenull");
 127       case QU_NULL:       return cstring_makeLiteralTemp ("null");
 128       case QU_ISNULL:     return cstring_makeLiteralTemp ("isnull");
 129       case QU_RELNULL:    return cstring_makeLiteralTemp ("relnull");
 130       case QU_NOTNULL:    return cstring_makeLiteralTemp ("notnull");
 131       case QU_NULLTERMINATED: return cstring_makeLiteralTemp ("nullterminated");
 132       case QU_RETURNED:   return cstring_makeLiteralTemp ("  returned");
 133       case QU_EXPOSED:    return cstring_makeLiteralTemp ("exposed");
 134       case QU_EXITS:      return cstring_makeLiteralTemp ("exits");
 135       case QU_MAYEXIT:    return cstring_makeLiteralTemp ("mayexit");
 136       case QU_UNUSED:     return cstring_makeLiteralTemp ("unused");
 137       case QU_EXTERNAL:   return cstring_makeLiteralTemp ("external");
 138       case QU_SEF:        return cstring_makeLiteralTemp ("sef");
 139       case QU_OBSERVER:   return cstring_makeLiteralTemp ("observer");
 140       case QU_REFCOUNTED: return cstring_makeLiteralTemp ("refcounted");
 141       case QU_REFS:       return cstring_makeLiteralTemp ("refs");
 142       case QU_NEWREF:     return cstring_makeLiteralTemp ("newref");
 143       case QU_KILLREF:    return cstring_makeLiteralTemp ("killref");
 144       case QU_TEMPREF:    return cstring_makeLiteralTemp ("tempref");
 145       case QU_OWNED:      return cstring_makeLiteralTemp ("owned");
 146       case QU_DEPENDENT:  return cstring_makeLiteralTemp ("dependent");
 147       case QU_NEVEREXIT:  return cstring_makeLiteralTemp ("neverexit");
 148       case QU_TRUEEXIT:   return cstring_makeLiteralTemp ("trueexit");
 149       case QU_FALSEEXIT:  return cstring_makeLiteralTemp ("falseexit");
 150       case QU_UNDEF:      return cstring_makeLiteralTemp ("undef");
 151       case QU_KILLED:     return cstring_makeLiteralTemp ("killed");
 152       case QU_PRINTFLIKE: return cstring_makeLiteralTemp ("printflike");
 153       case QU_SCANFLIKE:  return cstring_makeLiteralTemp ("scanflike");
 154       case QU_MESSAGELIKE:return cstring_makeLiteralTemp ("messagelike");
 155       case QU_SETBUFFERSIZE: return cstring_makeLiteralTemp("<qsetbuffersize>");
 156       case QU_LAST:       return cstring_makeLiteralTemp ("< last >");
 157       case QU_USERANNOT:  return cstring_makeLiteralTemp ("<user>");
 158       }
 159   }
 160
 161   BADEXIT;
 162 }
 163
 164 extern bool qual_match (qual q1, qual q2)
 165 {
 166   if (q1->kind == q2->kind) {
 167     if (q1->kind == QU_USERANNOT) {
 168       return (annotationInfo_equal (q1->info, q2->info));
 169     } else {
 170       return TRUE;
 171     }
 172   }
 173
 174   return FALSE;
 175 }
 176
 177 extern annotationInfo qual_getAnnotationInfo (qual q)
 178 {
 179   llassert (qual_isMetaState (q));
 180   return q->info;
 181 }
 182
 183 /* Cannot call qual_create after this... */
 184
 185 /*@i23@*/ static void qual_free (qual q)
 186 {
 187   llassert (FALSE);
 188   sfree (q);
 189 }
 190
 191 extern cstring qual_dump (qual q)
 192 {
 193   if (q->kind == QU_USERANNOT)
 194     {
 195       return message ("%d.%s",
 196                       (int) q->kind,
 197                       annotationInfo_dump (q->info));
 198     }
 199   else
 200     {
 201       return message ("%d", (int) q->kind);
 202     }
 203 }
 204
 205
 206 extern qual qual_undump (char **s)
 207 {
 208   quenum q = (quenum) reader_getInt (s);
 209
 210   if (q == QU_USERANNOT)
 211     {
 212       annotationInfo ai;
 213
 214       reader_checkChar (s, '.');
 215       ai = annotationInfo_undump (s);
 216
 217       return qual_createMetaState (ai);
 218     }
 219   else
 220     {
 221       return qual_createPlain (q);
 222     }
 223 }
 224
 225