src/inputStream.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 ** source.c
  26 **
  27 ** Interface to source file abstraction
  28 **
  29 **      NOTE:       This module is almost identical to the one for LCL.  The
  30 **                  only difference is that a couple of source lines have been
  31 **                  commented out.
  32 **
  33 **                  This module has too many dependencies to be in the common
  34 **                  source area.  Any of the solutions that would allow this
  35 **                  module to be common had its own set of compromises.  It
  36 **                  seemed best and most straightforward to just keep separte
  37 **                  copies for LSL and LCL.  We should examine this again if we
  38 **                  ever reorganize the module structure.
  39 **
  40 **  AUTHORS:
  41 **
  42 **     Steve Garland,
  43 **         Massachusetts Institute of Technology
  44 **     Joe Wild, Technical Languages and Environments, DECspec project
  45 */
  46
  47 # include "splintMacros.nf"
  48 # include "basic.h"
  49 # include "osd.h"
  50 # include "portab.h"
  51
  52 extern bool
  53 inputStream_close (inputStream s)
  54 {
  55   llassert (inputStream_isDefined (s));
  56
  57   if (s->file != NULL)
  58     {
  59       check (fileTable_closeFile (context_fileTable (), s->file));
  60       s->file = NULL;
  61       return TRUE;
  62     }
  63
  64   return FALSE;
  65 }
  66
  67 extern void
  68 inputStream_free (/*@null@*/ /*@only@*/ inputStream s)
  69 {
  70   if (inputStream_isDefined (s))
  71     {
  72       cstring_free (s->name);
  73       cstring_free (s->stringSource);
  74       sfree (s);
  75     }
  76 }
  77
  78 extern /*@only@*/ inputStream
  79 inputStream_create (cstring name, cstring suffix, bool echo)
  80 {
  81   char *ps;
  82   inputStream s = (inputStream) dmalloc (sizeof (*s));
  83
  84   s->name = name;
  85   s->file = NULL;
  86
  87   /*@access cstring@*/
  88   llassert (cstring_isDefined (s->name));
  89   ps = strrchr (s->name, CONNECTCHAR);
  90
  91   if (ps == NULL)
  92     {
  93       ps = s->name;
  94     }
  95   /*@noaccess cstring@*/
  96
  97   if (strchr (ps, '.') == NULL)
  98     {
  99       s->name = cstring_concatFree1 (s->name, suffix);
 100     }
 101
 102   s->name = fileLib_cleanName (s->name);
 103
 104   s->lineNo = 0;
 105   s->charNo = 0;
 106   s->curLine = NULL;
 107   s->echo = echo;
 108   s->fromString = FALSE;
 109   s->stringSource = NULL;
 110   s->stringSourceTail = NULL;
 111   s->buffer[0] = '\0';
 112
 113   return s;
 114 }
 115
 116 extern /*@only@*/ inputStream
 117 inputStream_fromString (cstring name, cstring str)
 118 {
 119   inputStream s = (inputStream) dmalloc (sizeof (*s));
 120
 121   s->name = cstring_copy (name);
 122   s->stringSource = cstring_copy (str);
 123   s->stringSourceTail = s->stringSource;
 124   s->file = 0;
 125   s->echo = FALSE;
 126   s->fromString = TRUE;
 127   s->lineNo = 0;
 128   s->charNo = 0;
 129   s->curLine = NULL;
 130   s->buffer[0] = '\0';
 131
 132   return s;
 133 }
 134
 135 extern int inputStream_nextChar (inputStream s)
 136 {
 137   int res;
 138
 139   llassert (inputStream_isDefined (s));
 140   res = inputStream_peekChar (s);
 141
 142   if (res != EOF)
 143     {
 144       if (res == (int) '\n')
 145         {
 146           s->curLine = NULL;
 147           s->charNo = 0;
 148           incLine ();
 149         }
 150       else
 151         {
 152           s->charNo++;
 153           incColumn ();
 154         }
 155     }
 156
 157   DPRINTF (("Next char: %c [%d]", (char) res, res));
 158   return res;
 159 }
 160
 161 extern int inputStream_peekNChar (inputStream s, int n)
 162      /* Doesn't work across lines! */
 163 {
 164   llassert (inputStream_isDefined (s));
 165   llassert (s->curLine != NULL);
 166   llassert (s->charNo + n < strlen (s->curLine));
 167   return ((int) s->curLine [s->charNo + n]);
 168 }
 169
 170 extern int inputStream_peekChar (inputStream s)
 171 {
 172   llassert (inputStream_isDefined (s));
 173
 174   if (s->curLine == NULL)
 175     {
 176       char *cur;
 177       s->curLine = NULL;
 178       cur = inputStream_nextLine (s);
 179       s->curLine = cur; /* split this to avoid possible undefined behavior */
 180       s->charNo = 0;
 181     }
 182
 183   if (s->curLine == NULL)
 184     {
 185       return EOF;
 186     }
 187
 188   llassert (s->charNo <= strlen (s->curLine));
 189
 190   if (s->curLine[s->charNo] == '\0')
 191     {
 192       return (int) '\n';
 193     }
 194
 195   return ((int) s->curLine [s->charNo]);
 196 }
 197
 198 extern /*@dependent@*/ /*@null@*/
 199 char *inputStream_nextLine (inputStream s)
 200 {
 201   char *currentLine;
 202   size_t len;
 203
 204   llassert (inputStream_isDefined (s));
 205   llassert (s->curLine == NULL);
 206   s->charNo = 0;
 207
 208   if (s->fromString)
 209     {
 210       if (cstring_isEmpty (s->stringSourceTail))
 211         {
 212           currentLine = 0;
 213         }
 214       else
 215         {
 216           /*@access cstring@*/
 217           char *c = strchr (s->stringSourceTail, '\n');
 218
 219           /* in case line is terminated not by newline */
 220           if (c == 0)
 221             {
 222               c = strchr (s->stringSourceTail, '\0');
 223             }
 224
 225           len = size_fromInt (c - s->stringSourceTail + 1);
 226
 227           if (len > size_fromInt (STUBMAXRECORDSIZE - 2))
 228             {
 229               len = size_fromInt (STUBMAXRECORDSIZE - 2);
 230             }
 231
 232           currentLine = &(s->buffer)[0];
 233           strncpy (currentLine, s->stringSourceTail, len);
 234           currentLine[len] = '\0';
 235           s->stringSourceTail += len;
 236           /*@noaccess cstring@*/
 237         }
 238
 239     }
 240   else
 241     {
 242       llassert (s->file != NULL);
 243       currentLine = fgets (&(s->buffer)[0], STUBMAXRECORDSIZE, s->file);
 244     }
 245   if (currentLine == 0)
 246     {
 247       strcpy (s->buffer, "*** End of File ***");
 248     }
 249   else
 250     {
 251       s->lineNo++;
 252       len = strlen (currentLine) - 1;
 253       if (s->buffer[len] == '\n')
 254         {
 255           s->buffer[len] = '\0';
 256         }
 257       else
 258         {
 259           if (len >= size_fromInt (STUBMAXRECORDSIZE - 2))
 260             {
 261               lldiagmsg (message ("Input line too long: %s",
 262                                   cstring_fromChars (currentLine)));
 263             }
 264         }
 265     }
 266
 267   /* if (s->echo) slo_echoLine (currentLine);           only needed in LCL */
 268   return currentLine;
 269 }
 270
 271 extern bool
 272 inputStream_open (inputStream s)
 273 {
 274   llassert (inputStream_isDefined (s));
 275   if (s->fromString)
 276     {
 277       /* not an error: tail is dependent */
 278       s->stringSourceTail = s->stringSource;
 279       return TRUE;
 280     }
 281
 282   DPRINTF (("Opening: %s", s->name));
 283   s->file = fileTable_openReadFile (context_fileTable (), s->name);
 284   return (s->file != 0 || s->fromString);
 285 }
 286
 287 /*
 288 ** requires
 289 **  path != NULL \and
 290 **  s != NULL \and
 291 **  *s.name == filename (*s.name) || filetype (*s.name)
 292 **      *s.name consists of a file name and type only ("<filename>.<type>)
 293 **      No path name is included
 294 **
 295 ** ensures
 296 **  if filefound (*path, *s) then
 297 **      result = true \and *s.name = filespec_where_file_found (*path, *s)
 298 **  else
 299 **      result = false
 300 */
 301
 302 extern bool inputStream_getPath (cstring path, inputStream s)
 303 {
 304   cstring returnPath;
 305   filestatus status;            /* return status of osd_getEnvPath.*/
 306   bool rVal;                    /* return value of this procedure. */
 307
 308   llassert (cstring_isDefined (path));
 309   llassert (inputStream_isDefined (s));
 310   llassert (cstring_isDefined (s->name));
 311
 312   status = osd_getPath (path, s->name, &returnPath);
 313
 314   if (status == OSD_FILEFOUND)
 315     {                           /* Should be majority of cases. */
 316       rVal = TRUE;
 317
 318       cstring_free (s->name);
 319       s->name = fileLib_cleanName (returnPath);
 320     }
 321   else if (status == OSD_FILENOTFOUND)
 322     {
 323       rVal = FALSE;
 324     }
 325   else if (status == OSD_PATHTOOLONG)
 326     {
 327       rVal = FALSE;
 328      /* Directory and filename are too long.  Report error. */
 329      llbuglit ("soure_getPath: Filename plus directory from search path too long");
 330  }
 331   else
 332     {
 333       rVal = FALSE;
 334       llbuglit ("inputStream_getPath: invalid return status");
 335     }
 336
 337   return rVal;
 338 }
 339
 340 /*:open:*/ FILE *inputStream_getFile (inputStream s)
 341 {
 342   llassert (inputStream_isDefined (s));
 343   llassert (s->file != NULL);
 344   return s->file;
 345 }
 346
 347 cstring inputStream_fileName (inputStream s)
 348 {
 349   llassert (inputStream_isDefined (s));
 350   return s->name;
 351 }
 352
 353 bool inputStream_isOpen (inputStream s)
 354 {
 355   return (inputStream_isDefined (s) && (s->file != 0 || s->fromString));
 356 }
 357
 358 int inputStream_thisLineNumber (inputStream s)
 359 {
 360   llassert (inputStream_isDefined (s));
 361   return s->lineNo;
 362 }
 363
 364
 365
 366