2 ** Splint - annotation-assisted static program checker
3 ** Copyright (C) 1994-2002 University of Virginia,
4 ** Massachusetts Institute of Technology
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.
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.
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.
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://www.splint.org
27 ** Main module for Splint annotation-assisted program checker
33 ** Ensure that WIN32 and _WIN32 are both defined or both undefined.
38 # error "Inconsistent definitions."
42 # error "Inconsistent definitions."
51 # include "lclintMacros.nf"
58 # include "scanline.h"
59 # include "lclscanline.h"
60 # include "lclsyntable.h"
61 # include "lcltokentable.h"
62 # include "lslparse.h"
64 # include "syntable.h"
65 # include "tokentable.h"
73 # include "fileIdList.h"
75 # include "cgrammar.h"
80 extern /*@external@*/ int yydebug;
82 static void printMail (void);
83 static void printMaintainer (void);
84 static void printReferences (void);
85 static void printFlags (void);
86 static void printAnnotations (void);
87 static void printParseErrors (void);
88 static void printComments (void);
89 static void describePrefixCodes (void);
90 static void cleanupFiles (void);
91 static void showHelp (void);
92 static void interrupt (int p_i);
94 static bool readOptionsFile (cstring p_fname,
95 cstringSList *p_passThroughArgs,
97 /*@modifies fileSystem, internalState, *p_passThroughArgs@*/ ;
99 static void loadrc (FILE *p_rcfile, cstringSList *p_passThroughArgs)
100 /*@modifies *p_passThroughArgs, p_rcfile@*/
101 /*@ensures closed p_rcfile@*/ ;
103 static void describeVars (void);
104 static bool specialFlagsHelp (char *p_next);
105 static bool hasShownHerald = FALSE;
106 static char *specFullName (char *p_specfile, /*@out@*/ char **p_inpath)
107 /*@modifies *p_inpath@*/ ;
109 static bool anylcl = FALSE;
110 static clock_t inittime;
112 static /*@only@*/ /*@null@*/ inputStream initFile = inputStream_undefined;
114 static fileIdList preprocessFiles (fileIdList, bool)
115 /*@modifies fileSystem@*/ ;
120 void lslCleanup (void)
121 /*@globals killed g_symtab@*/
122 /*@modifies internalState, g_symtab@*/
125 ** Cleanup all the LCL/LSL.
128 static bool didCleanup = FALSE;
130 llassert (!didCleanup);
135 lsymbol_destroyMod ();
136 LCLSynTableCleanup ();
137 LCLTokenTableCleanup ();
138 LCLScanLineCleanup ();
141 /* clean up LSL parsing */
144 ltokenTableCleanup ();
148 symtable_free (g_symtab);
154 /*@globals undef g_symtab; @*/
155 /*@modifies g_symtab, internalState, fileSystem; @*/
158 ** Open init file provided by user, or use the default LCL init file
161 cstring larchpath = context_getLarchPath ();
162 inputStream LSLinitFile = inputStream_undefined;
166 if (inputStream_isUndefined (initFile))
168 initFile = inputStream_create (cstring_makeLiteral (INITFILENAME),
169 cstring_makeLiteralTemp (LCLINIT_SUFFIX),
172 if (!inputStream_getPath (larchpath, initFile))
174 lldiagmsg (message ("Continuing without LCL init file: %s",
175 inputStream_fileName (initFile)));
179 if (!inputStream_open (initFile))
181 lldiagmsg (message ("Continuing without LCL init file: %s",
182 inputStream_fileName (initFile)));
188 if (!inputStream_open (initFile))
190 lldiagmsg (message ("Continuing without LCL init file: %s",
191 inputStream_fileName (initFile)));
195 /* Initialize checker */
203 LCLTokenTableInit ();
215 /* need this to initialize LCL checker */
217 llassert (inputStream_isDefined (initFile));
218 if (inputStream_isOpen (initFile))
222 LCLScanReset (initFile);
223 LCLProcessInitFileInit ();
224 LCLProcessInitFileReset ();
227 LCLProcessInitFile ();
228 LCLProcessInitFileCleanup ();
231 check (inputStream_close (initFile));
234 /* Initialize LSL init files, for parsing LSL signatures from LSL */
236 LSLinitFile = inputStream_create (cstring_makeLiteral ("lslinit.lsi"),
237 cstring_makeLiteralTemp (".lsi"),
240 if (!inputStream_getPath (larchpath, LSLinitFile))
242 lldiagmsg (message ("Continuing without LSL init file: %s",
243 inputStream_fileName (LSLinitFile)));
247 if (!inputStream_open (LSLinitFile))
249 lldiagmsg (message ("Continuing without LSL init file: %s",
250 inputStream_fileName (LSLinitFile)));
266 if (inputStream_isOpen (LSLinitFile))
269 LSLScanReset (LSLinitFile);
270 LSLProcessInitFileInit ();
272 LSLProcessInitFile ();
274 check (inputStream_close (LSLinitFile));
277 inputStream_free (LSLinitFile);
282 (cstring_makeLiteral ("LSL init file error. Attempting to continue."));
286 g_symtab = symtable_new ();
289 ** sort_init must come after symtab has been initialized
298 ** Equivalent to importing old spec_csupport.lcl
299 ** define immutable LCL type "bool" and bool constants TRUE and FALSE
300 ** and initialized them to be equal to LSL's "true" and "false".
302 ** Reads in CTrait.syms (derived from CTrait.lsl) on LARCH_PATH.
306 LCLReportEolTokens (FALSE);
310 lslProcess (fileIdList lclfiles)
311 /*@globals undef g_currentSpec, undef g_currentSpecName, g_currentloc,
312 undef killed g_symtab; @*/
313 /*@modifies g_currentSpec, g_currentSpecName, g_currentloc, internalState, fileSystem; @*/
316 bool parser_status = FALSE;
317 bool overallStatus = FALSE;
321 context_resetSpecLines ();
323 fileIdList_elements (lclfiles, fid)
325 cstring actualName = cstring_undefined;
326 cstring fname = fileName (fid);
328 if (osd_getPath (cstring_fromChars (g_localSpecPath),
329 fname, &actualName) == OSD_FILENOTFOUND)
331 if (mstring_equal (g_localSpecPath, "."))
333 lldiagmsg (message ("Spec file not found: %q", osd_outputPath (fname)));
337 lldiagmsg (message ("Spec file not found: %q (on %s)",
338 osd_outputPath (fname),
339 cstring_fromChars (g_localSpecPath)));
344 inputStream specFile;
346 char *namePtr = actualName;
348 while (*namePtr == '.' && *(namePtr + 1) == CONNECTCHAR)
352 /*@noaccess cstring@*/
354 g_currentSpec = cstring_fromCharsNew (namePtr);
356 specFile = inputStream_create (cstring_copy (g_currentSpec),
357 LCL_EXTENSION, TRUE);
359 llassert (inputStream_isDefined (specFile));
361 g_currentSpecName = specFullName
362 (cstring_toCharsSafe (g_currentSpec),
367 if (context_getFlag (FLG_SHOWSCAN))
369 lldiagmsg (message ("< reading spec %s >", g_currentSpec));
372 /* Open source file */
374 if (!inputStream_open (specFile))
376 lldiagmsg (message ("Cannot open file: %q",
377 osd_outputPath (inputStream_fileName (specFile))));
378 inputStream_free (specFile);
382 scopeInfo dummy_scope = (scopeInfo) dmalloc (sizeof (*dummy_scope));
383 dummy_scope->kind = SPE_INVALID;
386 LCLScanReset (specFile);
389 ** Minor hacks to allow more than one LCL file to
390 ** be scanned, while keeping initializations
393 symtable_enterScope (g_symtab, dummy_scope);
394 resetImports (cstring_fromChars (g_currentSpecName));
395 context_enterLCLfile ();
396 (void) lclHadNewError ();
398 parser_status = (ylparse () != 0);
399 context_exitLCLfile ();
401 overallStatus = parser_status || lclHadNewError ();
403 if (context_getFlag (FLG_DOLCS))
407 outputLCSFile (path, "%FAILED Output from ",
412 outputLCSFile (path, "%PASSED Output from ",
417 (void) inputStream_close (specFile);
418 inputStream_free (specFile);
420 symtable_exitScope (g_symtab);
423 cstring_free (actualName);
424 } end_fileIdList_elements;
426 /* Can cleanup lsl stuff right away */
430 g_currentSpec = cstring_undefined;
431 g_currentSpecName = NULL;
435 static void handlePassThroughFlag (char *arg)
438 char *quotechar = strchr (curarg, '\"');
441 char *freearg = NULL;
443 while (quotechar != NULL)
445 if (*(quotechar - 1) == '\\')
447 char *tp = quotechar - 2;
458 curarg = quotechar + 1;
459 quotechar = strchr (curarg, '\"');
464 llassert (quotechar != NULL);
466 offset = (quotechar - arg) + 2;
470 arg = cstring_toCharsSafe
471 (message ("%s\"\'%s",
472 cstring_fromChars (arg),
473 cstring_fromChars (quotechar + 1)));
479 arg = cstring_toCharsSafe
480 (message ("%s\'\"%s",
481 cstring_fromChars (arg),
482 cstring_fromChars (quotechar + 1)));
487 curarg = arg + offset;
488 quotechar = strchr (curarg, '\"');
494 voptgenerror (FLG_BADFLAG,
495 message ("Unclosed quote in flag: %s",
496 cstring_fromChars (arg)),
505 ** If the value is surrounded by single quotes ('), remove
506 ** them. This is an artifact of UNIX command line?
509 def = osd_fixDefine (cstring_fromChars (arg + 1));
510 DPRINTF (("Do define: %s", def));
512 DPRINTF (("After define"));
514 } else if (arg[0] == 'U') {
515 cppDoUndefine (cstring_fromChars (arg + 1));
524 void showHerald (void)
526 if (hasShownHerald || context_getFlag (FLG_QUIET)) return;
530 fprintf (g_msgstream, "%s\n\n", SPLINT_VERSION);
531 hasShownHerald = TRUE;
536 static cstring findLarchPathFile (/*@temp@*/ cstring s)
541 status = osd_getPath (context_getLarchPath (), s, &pathName);
543 if (status == OSD_FILEFOUND)
547 else if (status == OSD_FILENOTFOUND)
550 lldiagmsg (message ("Cannot find file on LARCHPATH: %s", s));
552 else if (status == OSD_PATHTOOLONG)
554 /* Directory and filename are too long. Report error. */
555 llbuglit ("soure_getPath: Filename plus directory from search path too long");
562 return cstring_undefined;
565 static void addLarchPathFile (fileIdList files, /*@temp@*/ cstring s)
567 cstring pathName = findLarchPathFile (s);
569 if (cstring_isDefined (pathName))
571 if (fileTable_exists (context_fileTable (), pathName))
574 lldiagmsg (message ("File listed multiple times: %s", pathName));
575 cstring_free (pathName);
579 fileIdList_add (files, fileTable_addFileOnly (context_fileTable (), pathName));
584 static void addFile (fileIdList files, /*@only@*/ cstring s)
586 if (fileTable_exists (context_fileTable (), s))
589 lldiagmsg (message ("File listed multiple times: %s", s));
594 fileIdList_add (files, fileTable_addFileOnly (context_fileTable (), s));
598 static void addXHFile (fileIdList files, /*@temp@*/ cstring s)
600 cstring pathName = findLarchPathFile (s);
602 if (cstring_isDefined (pathName))
604 if (fileTable_exists (context_fileTable (), pathName))
607 lldiagmsg (message ("File listed multiple times: %s", s));
611 fileIdList_add (files, fileTable_addXHFile (context_fileTable (), pathName));
615 cstring_free (pathName);
619 ** Disable MSVC++ warning about return value. Methinks humbly lclint control
620 ** comments are a mite more legible.
624 # pragma warning (disable:4035)
627 int main (int argc, char *argv[])
629 /*@globals killed undef g_currentloc,
633 /*@modifies g_currentloc, fileSystem,
637 /*@globals killed undef g_currentloc,
638 killed undef initFile,
639 killed g_localSpecPath,
640 killed undef g_currentSpec,
641 killed undef g_currentSpecName,
645 /*@modifies g_currentloc, initFile,
646 g_localSpecPath, g_currentSpec, g_currentSpecName, fileSystem,
651 bool first_time = TRUE;
652 bool showhelp = FALSE;
655 inputStream sourceFile = inputStream_undefined;
657 fileIdList dercfiles;
658 cstringSList fl = cstringSList_undefined;
659 cstringSList passThroughArgs = cstringSList_undefined;
660 fileIdList cfiles, xfiles, lclfiles, mtfiles;
661 clock_t before, lcltime, libtime, pptime, cptime, rstime;
665 _wildcard (&argc, &argv);
668 g_msgstream = stdout;
670 (void) signal (SIGINT, interrupt);
671 (void) signal (SIGSEGV, interrupt);
673 cfiles = fileIdList_create ();
674 xfiles = fileIdList_create ();
675 lclfiles = fileIdList_create ();
676 mtfiles = fileIdList_create ();
679 clabstract_initMod ();
680 typeIdSet_initMod ();
681 cppReader_initMod ();
686 g_currentloc = fileloc_createBuiltin ();
691 context_setInCommandLine ();
703 ** Add include directories from environment.
707 cstring incval = cstring_copy (osd_getEnvironmentVariable (INCLUDEPATH_VAR));
708 cstring oincval = incval;
710 if (cstring_isDefined (incval))
713 ** Each directory on the include path is a system include directory.
716 DPRINTF (("include: %s", incval));
717 context_setString (FLG_SYSTEMDIRS, cstring_copy (incval));
719 while (cstring_isDefined (incval))
722 char *nextsep = strchr (incval, PATH_SEPARATOR);
728 dir = cstring_copy (incval);
730 if (cstring_length (dir) == 0
731 || !isalpha ((int) cstring_firstChar (dir)))
734 ** win32 environment values can have special values,
740 cppAddIncludeDir (dir);
743 *nextsep = PATH_SEPARATOR;
744 incval = cstring_fromChars (nextsep + 1);
752 /*@noaccess cstring@*/
755 else /* 2001-09-09: herbert */
757 /* Put C_INCLUDE_PATH directories in sysdirs */
758 cstring cincval = osd_getEnvironmentVariable (cstring_makeLiteralTemp ("C_INCLUDE_PATH"));
759 if (cstring_isDefined (cincval))
761 context_setString (FLG_SYSTEMDIRS, cstring_copy (cincval));
766 cstring_free (oincval);
770 ** check RCFILE for default flags
774 cstring home = osd_getHomeDir ();
775 cstring fname = cstring_undefined;
776 bool defaultf = TRUE;
779 for (i = 1; i < argc; i++)
784 if (*thisarg == '-' || *thisarg == '+')
786 bool set = (*thisarg == '+');
792 ** Don't report warnings this time
795 opt = flags_identifyFlagQuiet (cstring_fromChars (thisarg));
801 else if (opt == FLG_SHOWSCAN || opt == FLG_WARNRC)
804 ** Need to set it immediately, so rc file scan is displayed
807 context_userSetFlag (opt, set);
809 else if (opt == FLG_OPTF)
814 fname = cstring_fromChars (argv[i]);
815 (void) readOptionsFile (fname, &passThroughArgs, TRUE);
819 (cstring_makeLiteral ("Flag f to select options file "
820 "requires an argument"));
824 ; /* wait to process later */
831 if (!nof && defaultf)
834 ** No explicit rc file, first try reading ~/.splintrc
837 if (cstring_isUndefined (fname))
839 if (!cstring_isEmpty (home))
841 bool readhomerc, readaltrc;
842 cstring homename, altname;
844 homename = message ("%s%h%s", home, CONNECTCHAR,
845 cstring_fromChars (RCFILE));
846 readhomerc = readOptionsFile (homename, &passThroughArgs, FALSE);
849 ** Try ~/.lclintrc also for historical accuracy
852 altname = message ("%s%h%s", home, CONNECTCHAR,
853 cstring_fromChars (ALTRCFILE));
854 readaltrc = readOptionsFile (altname, &passThroughArgs, FALSE);
856 if (readhomerc && readaltrc)
861 message ("Found both %s and %s files. Using both files, "
862 "but recommend using only %s to avoid confusion.",
863 homename, altname, homename),
867 cstring_free (homename);
868 cstring_free (altname);
873 ** Next, read .splintrc in the current working directory
877 cstring rcname = message ("%s%s",osd_getCurrentDirectory (), cstring_fromChars (RCFILE));
878 cstring altname = message ("%s%s",osd_getCurrentDirectory (), cstring_fromChars (ALTRCFILE));
879 bool readrc, readaltrc;
881 readrc = readOptionsFile (rcname, &passThroughArgs, FALSE);
882 readaltrc = readOptionsFile (altname, &passThroughArgs, FALSE);
884 if (readrc && readaltrc)
886 voptgenerror (FLG_WARNRC,
887 message ("Found both %s and %s files. Using both files, "
888 "but recommend using only %s to avoid confusion.",
889 rcname, altname, rcname),
894 cstring_free (rcname);
895 cstring_free (altname);
902 for (i = 1; i < argc; i++)
918 if (*thisarg == '-' || *thisarg == '+')
920 thisarg++; /* skip '-' */
922 if (mstring_equal (thisarg, "modes"))
924 llmsg (describeModes ());
926 else if (mstring_equal (thisarg, "vars")
927 || mstring_equal (thisarg, "env"))
931 else if (mstring_equal (thisarg, "annotations"))
935 else if (mstring_equal (thisarg, "parseerrors"))
939 else if (mstring_equal (thisarg, "comments"))
943 else if (mstring_equal (thisarg, "prefixcodes"))
945 describePrefixCodes ();
947 else if (mstring_equal (thisarg, "references")
948 || mstring_equal (thisarg, "refs"))
952 else if (mstring_equal (thisarg, "mail"))
956 else if (mstring_equal (thisarg, "maintainer")
957 || mstring_equal (thisarg, "version"))
961 else if (mstring_equal (thisarg, "flags"))
965 char *next = argv[i + 1];
967 if (specialFlagsHelp (next))
973 flagkind k = identifyCategory (cstring_fromChars (next));
989 cstring s = describeFlag (cstring_fromChars (thisarg));
991 if (cstring_isDefined (s))
999 if (*thisarg == '-' || *thisarg == '+')
1001 bool set = (*thisarg == '+');
1004 thisarg++; /* skip '-' */
1005 flagname = cstring_fromChars (thisarg);
1007 DPRINTF (("Flag: %s", flagname));
1008 opt = flags_identifyFlag (flagname);
1009 DPRINTF (("Flag: %s", flagcode_unparse (opt)));
1011 if (flagcode_isSkip (opt) || opt == FLG_SHOWSCAN || opt == FLG_WARNRC)
1013 /* showscan already processed */
1014 DPRINTF (("Skipping!"));
1016 else if (flagcode_isInvalid (opt))
1018 DPRINTF (("Invalid: %s", flagname));
1020 if (isMode (flagname))
1022 context_setMode (flagname);
1026 DPRINTF (("Error!"));
1027 voptgenerror (FLG_BADFLAG,
1028 message ("Unrecognized option: %s",
1029 cstring_fromChars (thisarg)),
1035 context_userSetFlag (opt, set);
1037 if (flagcode_hasArgument (opt))
1039 if (opt == FLG_HELP)
1043 else if (flagcode_isPassThrough (opt)) /* -D or -U */
1045 passThroughArgs = cstringSList_add
1046 (passThroughArgs, cstring_fromChars (thisarg));
1048 else if (flagcode_hasValue (opt))
1052 setValueFlag (opt, cstring_fromChars (argv[i]));
1058 ("Flag %s must be followed by a number",
1059 flagcode_unparse (opt)));
1062 else if (opt == FLG_INCLUDEPATH || opt == FLG_SPECPATH)
1064 cstring dir = cstring_suffix (cstring_fromChars (thisarg), 1); /* skip over I */
1068 case FLG_INCLUDEPATH:
1069 cppAddIncludeDir (dir);
1070 /*@switchbreak@*/ break;
1073 g_localSpecPath = cstring_toCharsSafe
1075 cstring_fromChars (g_localSpecPath),
1079 /*@switchbreak@*/ break;
1083 else if (flagcode_hasString (opt)
1084 || opt == FLG_INIT || opt == FLG_OPTF)
1088 cstring arg = cstring_fromChars (argv[i]);
1090 if (opt == FLG_OPTF)
1092 ; /* -f already processed */
1094 else if (opt == FLG_INIT)
1097 initFile = inputStream_create
1099 cstring_makeLiteralTemp (LCLINIT_SUFFIX),
1106 DPRINTF (("String flag: %s / %s",
1107 flagcode_unparse (opt), arg));
1108 if (opt == FLG_MTSFILE)
1111 ** arg identifies mts files
1113 cstring tmp = message ("%s%s", arg, MTS_EXTENSION);
1114 addLarchPathFile (mtfiles, tmp);
1116 tmp = message ("%s%s", arg, XH_EXTENSION);
1117 addXHFile (xfiles, tmp);
1122 setStringFlag (opt, arg);
1130 ("Flag %s must be followed by a string",
1131 flagcode_unparse (opt)));
1141 else /* its a filename */
1143 DPRINTF (("Adding filename: %s", thisarg));
1144 fl = cstringSList_add (fl, cstring_fromChars (thisarg));
1153 ** create lists of C and LCL files
1156 cstringSList_elements (fl, current)
1158 cstring ext = fileLib_getExtension (current);
1160 if (cstring_isUndefined (ext))
1162 /* no extension --- both C and LCL with default extensions */
1164 addFile (cfiles, message ("%s%s", current, C_EXTENSION));
1165 addFile (lclfiles, message ("%s%s", current, LCL_EXTENSION));
1167 else if (cstring_equal (ext, XH_EXTENSION))
1169 addXHFile (xfiles, current);
1171 else if (cstring_equal (ext, PP_EXTENSION))
1173 if (!context_getFlag (FLG_NOPP))
1176 (FLG_FILEEXTENSIONS,
1177 message ("File extension %s used without +nopp flag (will be processed as C source code): %s",
1182 addFile (cfiles, cstring_copy (current));
1184 else if (cstring_equal (ext, LCL_EXTENSION))
1186 addFile (lclfiles, cstring_copy (current));
1188 else if (fileLib_isCExtension (ext))
1190 addFile (cfiles, cstring_copy (current));
1192 else if (cstring_equal (ext, MTS_EXTENSION))
1194 addLarchPathFile (mtfiles, current);
1199 (FLG_FILEEXTENSIONS,
1200 message ("Unrecognized file extension: %s (assuming %s is C source code)",
1204 addFile (cfiles, cstring_copy (current));
1206 } end_cstringSList_elements;
1214 fprintf (g_msgstream, "\n");
1216 fileIdList_free (cfiles);
1217 fileIdList_free (xfiles);
1218 fileIdList_free (lclfiles);
1227 inittime = clock ();
1229 context_resetErrors ();
1230 context_clearInCommandLine ();
1232 anylcl = !fileIdList_isEmpty (lclfiles);
1234 if (context_doMerge ())
1236 cstring m = context_getMerge ();
1238 if (context_getFlag (FLG_SHOWSCAN))
1240 fprintf (g_msgstream, "< loading %s ", cstring_toCharsSafe (m));
1245 if (context_getFlag (FLG_SHOWSCAN))
1247 fprintf (g_msgstream, " >\n");
1250 if (!usymtab_existsType (context_getBoolName ()))
1252 usymtab_initBool ();
1257 if (!context_getFlag (FLG_NOLIB) && loadStandardState ())
1266 /* setup bool type and constants */
1267 usymtab_initBool ();
1270 fileloc_free (g_currentloc);
1271 g_currentloc = fileloc_createBuiltin ();
1274 ** Read metastate files (must happen before loading libraries)
1277 fileIdList_elements (mtfiles, mtfile)
1279 context_setFileId (mtfile);
1281 if (context_getFlag (FLG_SHOWSCAN))
1283 lldiagmsg (message ("< processing %s >", rootFileName (mtfile)));
1286 mtreader_readFile (cstring_copy (fileName (mtfile)));
1287 } end_fileIdList_elements;
1294 llfatalerror (cstring_makeLiteral ("This version of Splint does not handle LCL files."));
1296 lslProcess (lclfiles);
1300 usymtab_initGlobalMarker ();
1305 ** call the pre-preprocessor and /lib/cpp to generate appropriate
1310 context_setInCommandLine ();
1312 DPRINTF (("Pass through: %s", cstringSList_unparse (passThroughArgs)));
1314 cstringSList_elements (passThroughArgs, thisarg) {
1315 handlePassThroughFlag (cstring_toCharsSafe (thisarg));
1316 } end_cstringSList_elements;
1318 cstringSList_free (passThroughArgs);
1322 DPRINTF (("Initializing cpp reader!"));
1323 cppReader_initialize ();
1324 cppReader_saveDefinitions ();
1326 context_clearInCommandLine ();
1328 if (!context_getFlag (FLG_NOPP))
1334 if (context_getFlag (FLG_SHOWSCAN))
1336 fprintf (stderr, "< preprocessing");
1341 context_setPreprocessing ();
1342 dercfiles = preprocessFiles (xfiles, TRUE);
1343 tfiles = preprocessFiles (cfiles, FALSE);
1344 dercfiles = fileIdList_append (dercfiles, tfiles);
1345 fileIdList_free (tfiles);
1347 context_clearPreprocessing ();
1349 fileIdList_free (cfiles);
1351 if (context_getFlag (FLG_SHOWSCAN))
1353 fprintf (stderr, " >\n");
1361 dercfiles = fileIdList_append (cfiles, xfiles);
1366 ** now, check all the corresponding C files
1368 ** (for now these are just <file>.c, but after pre-processing
1369 ** will be <tmpprefix>.<file>.c)
1374 int nfiles = /*@-unrecog@*/ _fcloseall (); /*@=unrecog@*/
1378 llbug (message ("Files unclosed: %d", nfiles));
1383 DPRINTF (("Initializing..."));
1385 exprNode_initMod ();
1387 DPRINTF (("Okay..."));
1389 fileIdList_elements (dercfiles, fid)
1391 sourceFile = inputStream_create (cstring_copy (fileName (fid)), C_EXTENSION, TRUE);
1392 context_setFileId (fid);
1394 /* Open source file */
1396 if (inputStream_isUndefined (sourceFile) || (!inputStream_open (sourceFile)))
1398 /* previously, this was ignored ?! */
1399 llbug (message ("Could not open temp file: %s", fileName (fid)));
1403 yyin = inputStream_getFile (sourceFile); /*< shared <- only */
1405 llassert (yyin != NULL);
1407 if (context_getFlag (FLG_SHOWSCAN))
1409 lldiagmsg (message ("< checking %q >", osd_outputPath (rootFileName (fid))));
1413 ** Every time, except the first time, through the loop,
1414 ** need to call yyrestart to clean up the parse buffer.
1419 (void) yyrestart (yyin);
1426 DPRINTF (("Entering..."));
1427 context_enterFile ();
1429 context_exitCFile ();
1431 (void) inputStream_close (sourceFile);
1433 } end_fileIdList_elements;
1437 /* process any leftover macros */
1439 context_processAllMacros ();
1441 /* check everything that was specified was defined */
1443 /* don't check if no c files were processed ?
1444 ** is this correct behaviour?
1447 if (context_getFlag (FLG_SHOWSCAN))
1449 lldiagmsg (cstring_makeLiteral ("< global checks >"));
1454 if (context_getLinesProcessed () > 0)
1456 usymtab_allDefined ();
1459 if (context_maybeSet (FLG_TOPUNUSED))
1461 uentry ue = usymtab_lookupSafe (cstring_makeLiteralTemp ("main"));
1463 if (uentry_isValid (ue))
1465 uentry_setUsed (ue, fileloc_observeBuiltin ());
1471 if (context_maybeSet (FLG_EXPORTLOCAL))
1473 usymtab_exportLocal ();
1477 if (context_maybeSet (FLG_EXPORTHEADER))
1479 usymtab_exportHeader ();
1482 if (context_getFlag (FLG_SHOWUSES))
1484 usymtab_displayAllUses ();
1487 context_checkSuppressCounts ();
1489 if (context_doDump ())
1491 cstring dump = context_getDump ();
1502 if (context_getFlag (FLG_SHOWSUMMARY))
1509 bool isQuiet = context_getFlag (FLG_QUIET);
1510 cstring specErrors = cstring_undefined;
1512 int nspecErrors = lclNumberErrors ();
1517 if (context_neednl ())
1518 fprintf (g_msgstream, "\n");
1521 if (nspecErrors > 0)
1523 if (nspecErrors == context_getLCLExpect ())
1526 message ("%d spec warning%&, as expected\n ",
1531 if (context_getLCLExpect () > 0)
1534 message ("%d spec warning%&, expected %d\n ",
1536 (int) context_getLCLExpect ());
1540 specErrors = message ("%d spec warning%& found\n ",
1548 if (context_getLCLExpect () > 0)
1550 specErrors = message ("No spec warnings, expected %d\n ",
1551 (int) context_getLCLExpect ());
1557 if (context_anyErrors ())
1559 if (context_numErrors () == context_getExpect ())
1562 llmsg (message ("Finished checking --- "
1563 "%s%d code warning%&, as expected",
1564 specErrors, context_numErrors ()));
1569 if (context_getExpect () > 0)
1573 ("Finished checking --- "
1574 "%s%d code warning%&, expected %d",
1575 specErrors, context_numErrors (),
1576 (int) context_getExpect ()));
1586 llmsg (message ("Finished checking --- "
1587 "%s%d code warning%& found",
1588 specErrors, context_numErrors ()));
1597 if (context_getExpect () > 0)
1601 ("Finished checking --- "
1602 "%sno code warnings, expected %d",
1604 (int) context_getExpect ()));
1611 if (context_getLinesProcessed () > 0)
1613 if (cstring_isEmpty (specErrors))
1617 llmsg (message ("Finished checking --- no warnings"));
1624 llmsg (message ("Finished checking --- %sno code warnings",
1632 llmsg (message ("Finished checking --- %sno code processed",
1639 cstring_free (specErrors);
1642 if (context_getFlag (FLG_STATS))
1644 clock_t ttime = clock () - before;
1645 int specLines = context_getSpecLinesProcessed ();
1651 fprintf (g_msgstream, "%d spec, ", specLines);
1654 # ifndef CLOCKS_PER_SEC
1655 fprintf (g_msgstream, "%d source lines in %ld time steps (steps/sec unknown)\n",
1656 context_getLinesProcessed (),
1659 fprintf (g_msgstream, "%d source lines in %.2f s.\n",
1660 context_getLinesProcessed (),
1661 (double) ttime / CLOCKS_PER_SEC);
1669 if (context_getFlag (FLG_TIMEDIST))
1671 clock_t ttime = clock () - before;
1675 char *msg = (char *) dmalloc (256 * sizeof (*msg));
1680 "Time distribution (percent): initialize %.2f / lcl %.2f / "
1681 "pre-process %.2f / c check %.2f / finalize %.2f \n",
1682 (100.0 * (double) (libtime - before) / ttime),
1683 (100.0 * (double) (lcltime - libtime) / ttime),
1684 (100.0 * (double) (pptime - lcltime) / ttime),
1685 (100.0 * (double) (cptime - pptime) / ttime),
1686 (100.0 * (double) (rstime - cptime) / ttime));
1691 "Time distribution (percent): initialize %.2f / "
1692 "pre-process %.2f / c check %.2f / finalize %.2f \n",
1693 (100.0 * (double) (libtime - before) / ttime),
1694 (100.0 * (double) (pptime - libtime) / ttime),
1695 (100.0 * (double) (cptime - pptime) / ttime),
1696 (100.0 * (double) (rstime - cptime) / ttime));
1699 llgenindentmsgnoloc (cstring_fromCharsO (msg));
1703 llexit (expsuccess ? LLSUCCESS : LLFAILURE);
1704 BADBRANCHRET (LLFAILURE);
1709 ** Reenable return value warnings.
1711 # pragma warning (default:4035)
1719 llmsg (message ("Source files are .c, .h and %s files. If there is no suffix,",
1721 llmsg (message (" Splint will look for <file>.c and <file>%s.", LCL_EXTENSION));
1723 llmsglit ("Use splint -help <topic or flag name> for more information");
1725 llmsglit ("Topics:");
1727 llmsglit (" annotations (describes source-code annotations)");
1728 llmsglit (" comments (describes control comments)");
1729 llmsglit (" flags (describes flag categories)");
1730 llmsglit (" flags <category> (describes flags in category)");
1731 llmsglit (" flags all (short description of all flags)");
1732 llmsglit (" flags alpha (list all flags alphabetically)");
1733 llmsglit (" flags full (full description of all flags)");
1734 llmsglit (" mail (information on mailing lists)");
1735 llmsglit (" modes (show mode settings)");
1736 llmsglit (" parseerrors (help on handling parser errors)");
1737 llmsglit (" prefixcodes (character codes in namespace prefixes)");
1738 llmsglit (" references (sources for more information)");
1739 llmsglit (" vars (environment variables)");
1740 llmsglit (" version (information on compilation, maintainer)");
1745 specialFlagsHelp (char *next)
1747 if ((next != NULL) && (*next != '-') && (*next != '+'))
1749 if (mstring_equal (next, "alpha"))
1754 else if (mstring_equal (next, "all"))
1756 printAllFlags (TRUE, FALSE);
1759 else if (mstring_equal (next, "categories")
1760 || mstring_equal (next, "cats"))
1762 listAllCategories ();
1765 else if (mstring_equal (next, "full"))
1767 printAllFlags (FALSE, TRUE);
1782 printParseErrors (void)
1784 llmsglit ("Parse Errors");
1785 llmsglit ("------------");
1787 llmsglit ("LCLint will sometimes encounter a parse error for code that "
1788 "can be parsed with a local compiler. There are a few likely "
1789 "causes for this and a number of techniques that can be used "
1790 "to work around the problem.");
1792 llmsglit ("Compiler extensions --- compilers sometimes extend the C "
1793 "language with compiler-specific keywords and syntax. While "
1794 "it is not advisible to use these, oftentimes one has no choice "
1795 "when the system header files use compiler extensions. ");
1797 llmsglit ("Splint supports some of the GNU (gcc) compiler extensions, "
1798 "if the +gnuextensions flag is set. You may be able to workaround "
1799 "other compiler extensions by using a pre-processor define. "
1800 "Alternately, you can surround the unparseable code with");
1802 llmsglit (" # ifndef S_SPLINT_S");
1804 llmsglit (" # endif");
1806 /* evans 2000-12-21 fixed typo reported by Jeroen Ruigrok/Asmodai */
1807 llmsglit ("Missing type definitions --- an undefined type name will usually "
1808 "lead to a parse error. This often occurs when a standard header "
1809 "file defines some type that is not part of the standard library. ");
1810 llmsglit ("By default, Splint does not process the local files corresponding "
1811 "to standard library headers, but uses a library specification "
1812 "instead so dependencies on local system headers can be detected. "
1813 "If another system header file that does not correspond to a "
1814 "standard library header uses one of these superfluous types, "
1815 "a parse error will result.");
1817 llmsglit ("If the parse error is inside a posix standard header file, the "
1818 "first thing to try is +posixlib. This makes Splint use "
1819 "the posix library specification instead of reading the posix "
1822 llmsglit ("Otherwise, you may need to either manually define the problematic "
1823 "type (e.g., add -Dmlink_t=int to your .lclintrc file) or force "
1824 "lclint to process the header file that defines it. This is done "
1825 "by setting -skipansiheaders or -skipposixheaders before "
1826 "the file that defines the type is #include'd.");
1827 llmsglit ("(See lclint -help "
1828 "skipansiheaders and lclint -help skipposixheaders for a list of "
1829 "standard headers.) For example, if <sys/local.h> uses a type "
1830 "defined by posix header <sys/types.h> but not defined by the "
1831 "posix library, we might do: ");
1833 llmsglit (" /*@-skipposixheaders@*/");
1834 llmsglit (" # include <sys/types.h>");
1835 llmsglit (" /*@=skipposixheaders@*/");
1836 llmsglit (" # include <sys/local.h>");
1838 llmsglit ("to force Splint to process <sys/types.h>.");
1840 llmsglit ("At last resort, +trytorecover can be used to make Splint attempt "
1841 "to continue after a parse error. This is usually not successful "
1842 "and the author does not consider assertion failures when +trytorecover "
1843 "is used to be bugs.");
1847 printAnnotations (void)
1849 llmsglit ("Annotations");
1850 llmsglit ("-----------");
1852 llmsglit ("Annotations are semantic comments that document certain "
1853 "assumptions about functions, variables, parameters, and types. ");
1855 llmsglit ("They may be used to indicate where the representation of a "
1856 "user-defined type is hidden, to limit where a global variable may "
1857 "be used or modified, to constrain what a function implementation "
1858 "may do to its parameters, and to express checked assumptions about "
1859 "variables, types, structure fields, function parameters, and "
1860 "function results.");
1862 llmsglit ("Annotations are introduced by \"/*@\". The role of the @ may be "
1863 "played by any printable character, selected using -commentchar <char>.");
1865 llmsglit ("Consult the User's Guide for descriptions of checking associated with each annotation.");
1867 llmsglit ("Globals: (in function declarations)");
1868 llmsglit (" /*@globals <globitem>,+ @*/");
1869 llmsglit (" globitem is an identifier, internalState or fileSystem");
1871 llmsglit ("Modifies: (in function declarations)");
1872 llmsglit (" /*@modifies <moditem>,+ @*/");
1873 llmsglit (" moditem is an lvalue");
1874 llmsglit (" /*@modifies nothing @*/");
1875 llmsglit (" /*@*/ (Abbreviation for no globals and modifies nothing.)");
1877 llmsglit ("Iterators:");
1878 llmsglit (" /*@iter <identifier> (<parameter-type-list>) @*/ - declare an iterator");
1880 llmsglit ("Constants:");
1881 llmsglit (" /*@constant <declaration> @*/ - declares a constant");
1883 llmsglit ("Alternate Types:");
1884 llmsglit (" /*@alt <basic-type>,+ @*/");
1885 llmsglit (" (e.g., int /*@alt char@*/ is a type matching either int or char)");
1887 llmsglit ("Declarator Annotations");
1889 llmsglit ("Type Definitions:");
1890 llmsglit (" /*@abstract@*/ - representation is hidden from clients");
1891 llmsglit (" /*@concrete@*/ - representation is visible to clients");
1892 llmsglit (" /*@immutable@*/ - instances of the type cannot change value");
1893 llmsglit (" /*@mutable@*/ - instances of the type can change value");
1894 llmsglit (" /*@refcounted@*/ - reference counted type");
1896 llmsglit ("Global Variables:");
1897 llmsglit (" /*@unchecked@*/ - weakest checking for global use");
1898 llmsglit (" /*@checkmod@*/ - check modification by not use of global");
1899 llmsglit (" /*@checked@*/ - check use and modification of global");
1900 llmsglit (" /*@checkedstrict@*/ - check use of global strictly");
1902 llmsglit ("Memory Management:");
1903 llmsglit (" /*@dependent@*/ - a reference to externally-owned storage");
1904 llmsglit (" /*@keep@*/ - a parameter that is kept by the called function");
1905 llmsglit (" /*@killref@*/ - a refcounted parameter, killed by the call");
1906 llmsglit (" /*@only@*/ - an unshared reference");
1907 llmsglit (" /*@owned@*/ - owner of storage that may be shared by /*@dependent@*/ references");
1908 llmsglit (" /*@shared@*/ - shared reference that is never deallocated");
1909 llmsglit (" /*@temp@*/ - temporary parameter");
1911 llmsglit ("Aliasing:");
1912 llmsglit (" /*@unique@*/ - may not be aliased by any other visible reference");
1913 llmsglit (" /*@returned@*/ - may be aliased by the return value");
1915 llmsglit ("Exposure:");
1916 llmsglit (" /*@observer@*/ - reference that cannot be modified");
1917 llmsglit (" /*@exposed@*/ - exposed reference to storage in another object");
1919 llmsglit ("Definition State:");
1920 llmsglit (" /*@out@*/ - storage reachable from reference need not be defined");
1921 llmsglit (" /*@in@*/ - all storage reachable from reference must be defined");
1922 llmsglit (" /*@partial@*/ - partially defined, may have undefined fields");
1923 llmsglit (" /*@reldef@*/ - relax definition checking");
1925 llmsglit ("Global State: (for globals lists, no /*@, since list is already in /*@\'s)");
1926 llmsglit (" undef - variable is undefined before the call");
1927 llmsglit (" killed - variable is undefined after the call");
1929 llmsglit ("Null State:");
1930 llmsglit (" /*@null@*/ - possibly null pointer");
1931 llmsglit (" /*@notnull@*/ - non-null pointer");
1932 llmsglit (" /*@relnull@*/ - relax null checking");
1934 llmsglit ("Null Predicates:");
1935 llmsglit (" /*@truenull@*/ - if result is TRUE, first parameter is NULL");
1936 llmsglit (" /*@falsenull@*/ - if result is TRUE, first parameter is not NULL");
1938 llmsglit ("Execution:");
1939 llmsglit (" /*@exits@*/ - function never returns");
1940 llmsglit (" /*@mayexit@*/ - function may or may not return");
1941 llmsglit (" /*@trueexit@*/ - function does not return if first parameter is TRUE");
1942 llmsglit (" /*@falseexit@*/ - function does not return if first parameter if FALSE");
1943 llmsglit (" /*@neverexit@*/ - function always returns");
1945 llmsglit ("Side-Effects:");
1946 llmsglit (" /*@sef@*/ - corresponding actual parameter has no side effects");
1948 llmsglit ("Declaration:");
1949 llmsglit (" /*@unused@*/ - need not be used (no unused errors reported)");
1950 llmsglit (" /*@external@*/ - defined externally (no undefined error reported)");
1953 llmsglit (" /*@fallthrough@*/ - fall-through case");
1955 llmsglit ("Break:");
1956 llmsglit (" /*@innerbreak@*/ - break is breaking an inner loop or switch");
1957 llmsglit (" /*@loopbreak@*/ - break is breaking a loop");
1958 llmsglit (" /*@switchbreak@*/ - break is breaking a switch");
1959 llmsglit (" /*@innercontinue@*/ - continue is continuing an inner loop");
1961 llmsglit ("Unreachable Code:");
1962 llmsglit (" /*@notreached@*/ - statement may be unreachable.");
1964 llmsglit ("Special Functions:");
1965 llmsglit (" /*@printflike@*/ - check variable arguments like printf");
1966 llmsglit (" /*@scanflike@*/ - check variable arguments like scanf");
1970 printComments (void)
1972 llmsglit ("Control Comments");
1973 llmsglit ("----------------");
1975 llmsglit ("Setting Flags");
1977 llmsglit ("Most flags (all except those characterized as \"globally-settable only\") can be set locally using control comments. A control comment can set flags locally to override the command line settings. The original flag settings are restored before processing the next file.");
1979 llmsglit ("The syntax for setting flags in control comments is the same as that of the command line, except that flags may also be preceded by = to restore their setting to the original command-line value. For instance,");
1980 llmsglit (" /*@+boolint -modifies =showfunc@*/");
1981 llmsglit ("sets boolint on (this makes bool and int indistinguishable types), sets modifies off (this prevents reporting of modification errors), and sets showfunc to its original setting (this controls whether or not the name of a function is displayed before a message).");
1983 llmsglit ("Error Suppression");
1985 llmsglit ("Several comments are provided for suppressing messages. In general, it is usually better to use specific flags to suppress a particular error permanently, but the general error suppression flags may be more convenient for quickly suppressing messages for code that will be corrected or documented later.");
1987 llmsglit ("/*@ignore@*/ ... /*@end@*/");
1989 (cstring_makeLiteral
1990 ("No errors will be reported in code regions between /*@ignore@*/ and /*@end@*/. These comments can be used to easily suppress an unlimited number of messages."));
1991 llmsglit ("/*@i@*/");
1993 (cstring_makeLiteral
1994 ("No errors will be reported from an /*@i@*/ comment to the end of the line."));
1995 llmsglit ("/*@i<n>@*/");
1997 (cstring_makeLiteral
1998 ("No errors will be reported from an /*@i<n>@*/ (e.g., /*@i3@*/) comment to the end of the line. If there are not exactly n errors suppressed from the comment point to the end of the line, Splint will report an error."));
1999 llmsglit ("/*@t@*/, /*@t<n>@*/");
2001 (cstring_makeLiteral
2002 ("Like i and i<n>, except controlled by +tmpcomments flag. These can be used to temporarily suppress certain errors. Then, -tmpcomments can be set to find them again."));
2004 llmsglit ("Type Access");
2006 llmsglit ("/*@access <type>@*/");
2007 llmsglit (" Allows the following code to access the representation of <type>");
2008 llmsglit ("/*@noaccess <type>@*/");
2009 llmsglit (" Hides the representation of <type>");
2011 llmsglit ("Macro Expansion");
2013 llmsglit ("/*@notfunction@*/");
2015 (cstring_makeLiteral
2016 ("Indicates that the next macro definition is not intended to be a "
2017 "function, and should be expanded in line instead of checked as a "
2018 "macro function definition."));
2025 llmsglit ("Flag Categories");
2026 llmsglit ("---------------");
2027 listAllCategories ();
2028 llmsglit ("\nTo see the flags in a flag category, do\n lclint -help flags <category>");
2029 llmsglit ("To see a list of all flags in alphabetical order, do\n lclint -help flags alpha");
2030 llmsglit ("To see a full description of all flags, do\n lclint -help flags full");
2034 printMaintainer (void)
2036 llmsg (message ("Maintainer: %s", cstring_makeLiteralTemp (LCLINT_MAINTAINER)));
2037 llmsglit (LCL_COMPILE);
2043 llmsglit ("Mailing Lists");
2044 llmsglit ("-------------");
2046 llmsglit ("There are two mailing lists associated with Splint: ");
2048 llmsglit (" lclint-announce@virginia.edu");
2050 llmsglit (" Reserved for announcements of new releases and bug fixes.");
2051 llmsglit (" To subscribe, send a message to majordomo@virginia.edu with body: ");
2052 llmsglit (" subscribe lclint-announce");
2054 llmsglit (" lclint-interest@virginia.edu");
2056 llmsglit (" Informal discussions on the use and development of lclint.");
2057 llmsglit (" To subscribe, send a message to majordomo@virginia.edu with body: ");
2058 llmsglit (" subscribe lclint-interest");
2062 printReferences (void)
2064 llmsglit ("References");
2065 llmsglit ("----------");
2067 llmsglit ("For more information, see the Splint web site: http://www.splint.org");
2071 describePrefixCodes (void)
2073 llmsglit ("Prefix Codes");
2074 llmsglit ("------------");
2076 llmsglit ("These characters have special meaning in name prefixes:");
2078 llmsg (message (" %h Any uppercase letter [A-Z]", PFX_UPPERCASE));
2079 llmsg (message (" %h Any lowercase letter [a-z]", PFX_LOWERCASE));
2080 llmsg (message (" %h Any character (valid in a C identifier)", PFX_ANY));
2081 llmsg (message (" %h Any digit [0-9]", PFX_DIGIT));
2082 llmsg (message (" %h Any non-uppercase letter [a-z0-9_]", PFX_NOTUPPER));
2083 llmsg (message (" %h Any non-lowercase letter [A-Z0-9_]", PFX_NOTLOWER));
2084 llmsg (message (" %h Any letter [A-Za-z]", PFX_ANYLETTER));
2085 llmsg (message (" %h Any letter or digit [A-Za-z0-9]", PFX_ANYLETTERDIGIT));
2086 llmsglit (" * Zero or more repetitions of the previous character class until the end of the name");
2095 eval = context_getLarchPath ();
2096 def = osd_getEnvironmentVariable (LARCH_PATH);
2098 if (cstring_isDefined (def) ||
2099 !cstring_equal (eval, cstring_fromChars (DEFAULT_LARCHPATH)))
2101 llmsg (message ("LARCH_PATH = %s", eval));
2105 llmsg (message ("LARCH_PATH = <not set> (default = %s)",
2106 cstring_fromChars (DEFAULT_LARCHPATH)));
2109 llmsglit (" --- path used to find larch initialization files and LSL traits");
2111 eval = context_getLCLImportDir ();
2112 def = osd_getEnvironmentVariable (cstring_makeLiteralTemp (LCLIMPORTDIR));
2114 if (cstring_isDefined (def) ||
2115 !cstring_equal (eval, cstring_fromChars (DEFAULT_LCLIMPORTDIR)))
2117 llmsg (message ("%q = %s", cstring_makeLiteral (LCLIMPORTDIR), eval));
2121 llmsg (message ("%s = <not set, default: %s>", cstring_makeLiteralTemp (LCLIMPORTDIR),
2122 cstring_makeLiteralTemp (DEFAULT_LCLIMPORTDIR)));
2125 llmsglit (" --- directory containing lcl standard library files "
2126 "(import with < ... >)");;
2129 ("include path = %q (set by environment variable %s and -I flags)",
2130 cppReader_getIncludePath (), INCLUDEPATH_VAR));
2132 llmsglit (" --- path used to find #include'd files");
2135 ("systemdirs = %s (set by -systemdirs or environment variable %s)", /*@i413223@*/
2136 context_getString (FLG_SYSTEMDIRS),
2139 llmsglit (" --- if file is found on this path, it is treated as a system file for error reporting");
2148 fprintf (stderr, "*** Interrupt\n");
2149 llexit (LLINTERRUPT);
2154 /* Cheat when there are parse errors */
2157 fprintf (stderr, "*** Segmentation Violation\n");
2159 /* Don't catch it if fileloc_unparse causes a signal */
2160 (void) signal (SIGSEGV, NULL);
2162 loc = fileloc_unparse (g_currentloc);
2164 fprintf (stderr, "*** Location (not trusted): %s\n",
2165 cstring_toCharsSafe (loc));
2168 fprintf (stderr, "*** Please report bug to %s\n", LCLINT_MAINTAINER);
2172 fprintf (stderr, "*** Signal: %d\n", i);
2174 fprintf (stderr, "*** Location (not trusted): %s\n",
2175 cstring_toCharsSafe (fileloc_unparse (g_currentloc)));
2178 fprintf (stderr, "*** Please report bug to %s ***\n", LCLINT_MAINTAINER);
2186 static bool doneCleanup = FALSE;
2188 /* make sure this is only called once! */
2190 if (doneCleanup) return;
2195 ** Close all open files
2196 ** (There should only be open files, if we exited after a fatal error.)
2199 fileTable_closeAll (context_fileTable ());
2201 if (context_getFlag (FLG_KEEP))
2203 check (fputs ("Temporary files kept:\n", stderr) != EOF);
2204 fileTable_printTemps (context_fileTable ());
2209 int nfiles = /*@-unrecog@*/ _fcloseall (); /*@=unrecog@*/
2213 llbug (message ("Files unclosed: %d", nfiles));
2216 fileTable_cleanup (context_fileTable ());
2223 ** cleans up temp files (if necessary) and exits
2229 DPRINTF (("llexit: %d", status));
2232 if (status == LLFAILURE)
2240 if (status != LLFAILURE)
2242 context_destroyMod ();
2243 exprNode_destroyMod ();
2246 uentry_destroyMod ();
2247 typeIdSet_destroyMod ();
2250 dmalloc_shutdown ();
2254 exit ((status == LLSUCCESS) ? EXIT_SUCCESS : EXIT_FAILURE);
2257 bool readOptionsFile (cstring fname, cstringSList *passThroughArgs, bool report)
2261 if (fileTable_exists (context_fileTable (), fname))
2267 message ("Multiple attempts to read options file: %s", fname),
2273 FILE *innerf = fileTable_openFile (context_fileTable (), fname, "r");
2277 fileloc fc = g_currentloc;
2278 g_currentloc = fileloc_createRc (fname);
2280 if (context_getFlag (FLG_SHOWSCAN))
2282 lldiagmsg (message ("< reading options from %q >",
2283 fileloc_outputFilename (g_currentloc)));
2286 loadrc (innerf, passThroughArgs);
2287 fileloc_reallyFree (g_currentloc);
2297 message ("Cannot open options file: %s", fname),
2307 ** This shouldn't be necessary, but Apple Darwin can't handle '"''s.
2311 loadrc (/*:open:*/ FILE *rcfile, cstringSList *passThroughArgs)
2312 /*@modifies rcfile@*/
2313 /*@ensures closed rcfile@*/
2315 char *s = mstring_create (MAX_LINE_LENGTH);
2318 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2322 while (reader_readLine (rcfile, s, MAX_LINE_LENGTH) != NULL)
2329 DPRINTF (("Line: %s", s));
2330 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2332 while (*s == ' ' || *s == '\t')
2340 bool escaped = FALSE;
2341 bool quoted = FALSE;
2344 DPRINTF (("Process: %s", s));
2345 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2346 /* comment characters */
2347 if (c == '#' || c == ';' || c == '\n')
2353 if (c == '-' || c == '+')
2360 voptgenerror (FLG_BADFLAG,
2361 message ("Bad flag syntax (+ or - expected, "
2362 "+ is assumed): %s",
2363 cstring_fromChars (s)),
2374 while ((c = *s) != '\0')
2375 { /* remember to handle spaces and quotes in -D and -U ... */
2401 if (c == ' ' || c == '\t' || c == '\n')
2403 /*@innerbreak@*/ break;
2411 DPRINTF (("Nulling: %c", *s));
2414 if (mstring_isEmpty (thisflag))
2416 llfatalerror (message ("Missing flag: %s",
2417 cstring_fromChars (os)));
2420 DPRINTF (("Flag: %s", thisflag));
2422 opt = flags_identifyFlag (cstring_fromChars (thisflag));
2424 if (flagcode_isSkip (opt))
2428 else if (flagcode_isInvalid (opt))
2430 DPRINTF (("Invalid: %s", thisflag));
2432 if (isMode (cstring_fromChars (thisflag)))
2434 context_setMode (cstring_fromChars (thisflag));
2438 voptgenerror (FLG_BADFLAG,
2439 message ("Unrecognized option: %s",
2440 cstring_fromChars (thisflag)),
2446 context_userSetFlag (opt, set);
2448 if (flagcode_hasArgument (opt))
2450 if (opt == FLG_HELP)
2453 voptgenerror (FLG_BADFLAG,
2454 message ("Cannot use help in rc files"),
2457 else if (flagcode_isPassThrough (opt)) /* -D or -U */
2459 cstring arg = cstring_fromCharsNew (thisflag);
2460 cstring_markOwned (arg);
2461 *passThroughArgs = cstringSList_add (*passThroughArgs, arg);
2462 DPRINTF (("Pass through: %s",
2463 cstringSList_unparse (*passThroughArgs)));
2465 else if (opt == FLG_INCLUDEPATH
2466 || opt == FLG_SPECPATH)
2468 cstring dir = cstring_suffix (cstring_fromChars (thisflag), 1); /* skip over I/S */
2472 case FLG_INCLUDEPATH:
2473 cppAddIncludeDir (dir);
2474 /*@switchbreak@*/ break;
2477 g_localSpecPath = cstring_toCharsSafe
2478 (message ("%s:%s", cstring_fromChars (g_localSpecPath), dir));
2480 /*@switchbreak@*/ break;
2484 else if (flagcode_hasString (opt)
2485 || flagcode_hasValue (opt)
2486 || opt == FLG_INIT || opt == FLG_OPTF)
2488 cstring extra = cstring_undefined;
2493 rest = mstring_copy (s);
2494 DPRINTF (("Here: rest = %s", rest));
2498 while ((rchar = *rest) != '\0'
2499 && (isspace ((int) rchar)))
2505 DPRINTF (("Yo: %s", rest));
2507 while ((rchar = *rest) != '\0'
2508 && !isspace ((int) rchar))
2510 extra = cstring_appendChar (extra, rchar);
2515 DPRINTF (("Yo: %s", extra));
2518 if (cstring_isUndefined (extra))
2524 ("Flag %s must be followed by an argument",
2525 flagcode_unparse (opt)),
2532 DPRINTF (("Here we are: %s", extra));
2534 if (flagcode_hasValue (opt))
2536 DPRINTF (("Set value flag: %s", extra));
2537 setValueFlag (opt, extra);
2539 else if (opt == FLG_OPTF)
2541 (void) readOptionsFile (extra, passThroughArgs, TRUE);
2543 else if (opt == FLG_INIT)
2546 llassert (inputStream_isUndefined (initFile));
2548 initFile = inputStream_create
2549 (cstring_copy (extra),
2550 cstring_makeLiteralTemp (LCLINIT_SUFFIX),
2554 else if (flagcode_hasString (opt))
2556 DPRINTF (("Here: %s", extra));
2559 ** If it has "'s, we need to remove them.
2562 if (cstring_firstChar (extra) == '\"')
2564 if (cstring_lastChar (extra) == '\"')
2566 cstring unquoted = cstring_copyLength
2567 (cstring_toCharsSafe (cstring_suffix (extra, 1)),
2568 cstring_length (extra) - 2);
2570 DPRINTF (("string flag: %s -> %s", extra, unquoted));
2571 setStringFlag (opt, unquoted);
2572 cstring_free (extra);
2578 message ("Unmatched \" in option string: %s",
2581 setStringFlag (opt, extra);
2586 DPRINTF (("No quotes: %s", extra));
2587 setStringFlag (opt, extra);
2590 extra = cstring_undefined;
2598 cstring_free (extra);
2608 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2609 while ((c == ' ') || (c == '\t'))
2615 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2619 DPRINTF (("Pass through: %s", cstringSList_unparse (*passThroughArgs)));
2621 check (fileTable_closeFile (context_fileTable (), rcfile));
2624 static fileIdList preprocessFiles (fileIdList fl, bool xhfiles)
2625 /*@modifies fileSystem@*/
2627 bool msg = (context_getFlag (FLG_SHOWSCAN) && fileIdList_size (fl) > 10);
2628 int skip = (fileIdList_size (fl) / 5);
2629 int filesprocessed = 0;
2630 fileIdList dfiles = fileIdList_create ();
2632 fileloc_free (g_currentloc);
2633 g_currentloc = fileloc_createBuiltin ();
2635 fileIdList_elements (fl, fid)
2637 cstring ppfname = fileName (fid);
2639 if (!(osd_fileIsReadable (ppfname)))
2641 lldiagmsg (message ("Cannot open file: %q", osd_outputPath (ppfname)));
2642 ppfname = cstring_undefined;
2645 if (cstring_isDefined (ppfname))
2647 fileId dfile = fileTable_addCTempFile (context_fileTable (), fid);
2651 llassert (fileTable_isXHFile (context_fileTable (), dfile));
2654 llassert (cstring_isNonEmpty (ppfname));
2658 if ((filesprocessed % skip) == 0)
2660 if (filesprocessed == 0) {
2661 fprintf (stderr, " ");
2664 fprintf (stderr, ".");
2667 (void) fflush (stderr);
2672 if (cppProcess (ppfname, fileName (dfile)) != 0)
2674 llfatalerror (message ("Preprocessing error for file: %s",
2675 rootFileName (fid)));
2678 fileIdList_add (dfiles, dfile);
2680 } end_fileIdList_elements;
2685 /* This should be in an lclUtils.c file... */
2687 char *specFullName (char *specfile, /*@out@*/ char **inpath)
2689 /* extract the path and the specname associated with the given file */
2690 char *specname = (char *) dmalloc (sizeof (*specname)
2691 * (strlen (specfile) + 9));
2692 char *ospecname = specname;
2693 char *path = (char *) dmalloc (sizeof (*path) * (strlen (specfile)));
2697 /* initialized path to empty string or may have accidental garbage */
2700 /*@-mayaliasunique@*/
2701 strcpy (specname, specfile);
2702 /*@=mayaliasunique@*/
2704 /* trim off pathnames in specfile */
2705 size = strlen (specname);
2707 for (i = size_toInt (size) - 1; i >= 0; i--)
2709 if (specname[i] == CONNECTCHAR)
2711 /* strcpy (specname, (char *)specname+i+1); */
2712 for (j = 0; j <= i; j++) /* include '/' */
2714 path[j] = specname[j];
2724 ** also remove .lcl file extension, assume it's the last extension
2728 size = strlen (specname);
2730 for (i = size_toInt (size) - 1; i >= 0; i--)
2732 if (specname[i] == '.')
2742 ** If specname no longer points to the original char,
2743 ** we need to allocate a new pointer and copy the string.
2746 if (specname != ospecname) {
2747 char *rspecname = (char *) dmalloc (sizeof (*rspecname) * (strlen (specname) + 1));
2748 strcpy (rspecname, specname); /* evs 2000-05-16: Bug: was ospecname! */