src/filelocStack.c

   1 /*
   2 ** Splint - annotation-assisted static program checker
   3 ** Copyright (C) 1994-2003 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 ** filelocStack.c (from slist_template.c)
  26 */
  27
  28 # include "splintMacros.nf"
  29 # include "basic.h"
  30 # include "filelocStack.h"
  31
  32 /*@constant int filelocStackBASESIZE;@*/
  33 # define filelocStackBASESIZE MIDBASESIZE
  34
  35 static /*@notnull@*/ /*@only@*/ filelocStack
  36 filelocStack_newEmpty (void)
  37 {
  38   filelocStack s = (filelocStack) dmalloc (sizeof (*s));
  39
  40   s->nelements = 0;
  41   s->free = filelocStackBASESIZE;
  42   s->elements = (fileloc *) dmalloc (sizeof (*s->elements) * filelocStackBASESIZE);
  43
  44   return (s);
  45 }
  46
  47 filelocStack
  48 filelocStack_new (void)
  49 {
  50   return (filelocStack_newEmpty ());
  51 }
  52
  53 static void
  54 filelocStack_grow (/*@notnull@*/ filelocStack s)
  55 {
  56   o_fileloc *oldelements = s->elements;
  57   int i;
  58
  59   s->free += filelocStackBASESIZE;
  60   s->elements = (fileloc *) dmalloc (sizeof (*s->elements)
  61                                      * (s->nelements + s->free));
  62
  63   for (i = 0; i < s->nelements; i++)
  64     {
  65                   s->elements[i] = oldelements[i];
  66     }
  67
  68   sfree (oldelements);
  69 }
  70
  71 static void
  72   filelocStack_push (/*@returned@*/ filelocStack s, /*@keep@*/ fileloc el)
  73   /*@modifies s@*/
  74 {
  75   llassert (filelocStack_isDefined (s));
  76
  77   if (s->free <= 0)
  78     {
  79       filelocStack_grow (s);
  80     }
  81
  82   s->free--;
  83     s->elements[s->nelements] = el;
  84   s->nelements++;
  85 }
  86
  87 fileloc filelocStack_nextTop (filelocStack s)
  88 {
  89   llassert (filelocStack_isDefined (s) && s->nelements > 1);
  90
  91   return (s->elements[s->nelements - 2]);
  92 }
  93
  94 void filelocStack_clear (filelocStack s)
  95 {
  96   if (filelocStack_isDefined (s))
  97     {
  98       int i;
  99
 100       for (i = 0; i < s->nelements; i++)
 101         {
 102                           fileloc_free (s->elements[i]);
 103         }
 104
 105       s->free += s->nelements;
 106       s->nelements = 0;
 107     }
 108 }
 109
 110 /*
 111 ** Returns TRUE of el is a new file.
 112 */
 113
 114 bool filelocStack_popPushFile (filelocStack s, fileloc el)
 115 {
 116   int i;
 117
 118   llassert (filelocStack_isDefined (s));
 119
 120   for (i = s->nelements - 1; i >= 0; i--)
 121     {
 122                   if (fileloc_sameBaseFile (s->elements[i], el))
 123         {
 124           int j;
 125
 126           for (j = i; j < s->nelements; j++)
 127             {
 128                               fileloc_free (s->elements[j]);
 129             }
 130           s->elements[i] = el;
 131           s->nelements = i + 1;
 132           return FALSE;
 133         }
 134     }
 135
 136   filelocStack_push (s, el);
 137   return TRUE;
 138 }
 139
 140 # ifdef DEADCODE
 141 /*@only@*/ cstring
 142 filelocStack_unparse (filelocStack s)
 143 {
 144    int i;
 145    cstring st = cstring_makeLiteral ("[");
 146
 147    if (filelocStack_isDefined (s))
 148      {
 149        for (i = s->nelements - 1; i >= 0; i--)
 150          {
 151            if (i == s->nelements - 1)
 152              {
 153                                st = message ("%q %q", st, fileloc_unparse (s->elements[i]));
 154              }
 155            else
 156              {
 157                                st = message ("%q, %q", st, fileloc_unparse (s->elements[i]));
 158              }
 159          }
 160      }
 161
 162    st = message ("%q ]", st);
 163    return st;
 164 }
 165 # endif /* DEADCODE */
 166
 167 int filelocStack_includeDepth (filelocStack s)
 168 {
 169   int depth = 0;
 170   int i;
 171
 172   if (filelocStack_isDefined (s))
 173     {
 174       /* the zeroth element doesn't count! */
 175       for (i = s->nelements - 1; i > 0; i--)
 176         {
 177                           if (!fileloc_isSpecialFile (s->elements[i]))
 178             {
 179               depth++;
 180             }
 181         }
 182     }
 183
 184   return depth;
 185 }
 186
 187 void
 188 filelocStack_printIncludes (filelocStack s)
 189 {
 190   if (filelocStack_isDefined (s))
 191     {
 192       int i;
 193       bool prep = context_isPreprocessing ();
 194
 195       if (prep)
 196         {
 197           /* need to do this for messages */
 198           context_clearPreprocessing ();
 199         }
 200
 201       /* don't show last two files pushed */
 202       for (i = s->nelements - 3; i >= 0; i--)
 203         {
 204                           if (i == 0 || !fileloc_isSpecialFile (s->elements[i]))
 205             {
 206                               llgenindentmsg (cstring_makeLiteral ("Include site"),
 207                               s->elements[i]);
 208             }
 209         }
 210
 211       if (prep)
 212         {
 213           context_setPreprocessing ();
 214         }
 215     }
 216 }
 217
 218 void
 219 filelocStack_free (/*@only@*/ filelocStack s)
 220 {
 221   if (filelocStack_isDefined (s))
 222     {
 223       int i;
 224       for (i = 0; i < s->nelements; i++)
 225         {
 226                           fileloc_free (s->elements[i]);
 227         }
 228
 229       sfree (s->elements);
 230       sfree (s);
 231     }
 232 }
 233