/*
** Splint - annotation-assisted static program checker
-** Copyright (C) 1994-2001 University of Virginia,
+** Copyright (C) 1994-2002 University of Virginia,
** Massachusetts Institute of Technology
**
** This program is free software; you can redistribute it and/or modify it
{ FK_ANSI, "ansi", "violations of constraints imposed by ANSI/ISO standard" } ,
{ FK_ARRAY, "arrays", "special checking involving arrays" } ,
{ FK_BOOL, "booleans", "checking and naming of boolean types" } ,
- { FK_COMMENTS, "comments", "interpretation of semantic comments" } ,
+ { FK_COMMENTS, "comments", "warnings about (normal) comments" } ,
+ { FK_SYNCOMMENTS, "syncomments", "interpretation of annotation comments" } ,
{ FK_COMPLETE, "complete", "completely defined, used, or specified system" } ,
{ FK_CONTROL, "controlflow", "suspicious control structures" } ,
{ FK_DEBUG, "debug", "flags for debugging lclint" } ,
{ FK_ERRORS, "errors", "control expected errors, summary reporting" } ,
{ FK_EXPORT, "export", "control what may be exported" } ,
{ FK_EXPOSURE, "exposure", "representation exposure" } ,
+ { FK_EXTENSIBLE, "extensible", "user-defined checks and annotations" },
{ FK_FILES, "files", "control system files" } ,
{ FK_FORMAT, "format", "control format of warning messages" } ,
{ FK_GLOBALS, "globals", "use of global and file static variables" },
{ FK_HEADERS, "headers", "control inclusion and generation of header files" },
{ FK_HELP, "help", "on-line help" },
+ { FK_BOUNDS, "memorybounds", "out-of-bounds memory accesses" },
+ { FK_HINTS, "hints", "control display of warning hints" },
+ { FK_SYSTEMFUNCTIONS, "systemfunctions", "special properties of exit and main" },
{ FK_IMPLICIT, "implicit", "control implicit annotations and interpretations" } ,
{ FK_INIT, "initializations", "initialization files" } ,
{ FK_ITER, "iterators", "checking iterator definitions and uses" } ,
{ FK_UNRECOG, "unrecognized", "unrecognized identifiers" } ,
{ FK_UNSPEC, "unconstrained", "checking in the presence of unconstrained functions" } ,
{ FK_WARNUSE, "warnuse", "use of possibly problematic function" } ,
+ { FK_ITS4, "its4", "its4 compatibility flags (report warnings for uses of possibly insecure functions)" } ,
{ FK_SYNTAX, NULL, NULL } ,
{ FK_TYPE, NULL, NULL } ,
{ FK_SECRET, NULL, NULL } ,
typedef enum {
ARG_NONE,
- ARG_VALUE,
- ARG_STRING,
- ARG_SPECIAL
+ ARG_NUMBER, /* number */
+ ARG_CHAR, /* char */
+ ARG_STRING, /* string */
+ ARG_FILE, /* filename (also a string) */
+ ARG_DIRECTORY, /* directory (also a string) */
+ ARG_PATH, /* path */
+ ARG_SPECIAL /* ? */
} argcode;
+static /*@observer@*/ cstring argcode_unparse (argcode arg)
+{
+ switch (arg)
+ {
+ case ARG_STRING: return cstring_makeLiteralTemp ("string");
+ case ARG_FILE: return cstring_makeLiteralTemp ("filename");
+ case ARG_DIRECTORY: return cstring_makeLiteralTemp ("directory");
+ case ARG_PATH: return cstring_makeLiteralTemp ("path");
+ case ARG_NUMBER: return cstring_makeLiteralTemp ("number");
+ case ARG_CHAR: return cstring_makeLiteralTemp ("character");
+ case ARG_NONE:
+ BADBRANCH;
+ case ARG_SPECIAL:
+ BADBRANCH;
+ }
+}
+
typedef struct {
flagkind main;
flagkind sub;
/*@+enumint@*/
+static cstring getFlagModeSettings (flagcode p_flag) /*@modifies internalState@*/ ;
static cstring describeFlagCode (flagcode p_flag) /*@*/ ;
static cstringSList sortedFlags (void) /*@*/ ;
static /*@observer@*/ cstring categoryName (flagkind p_kind) /*@*/ ;
+static flagcode flags_identifyFlagAux (cstring p_s, bool p_quiet) /*@modifies g_msgstream@*/ ;
+
# if 0
static /*@unused@*/ cstring listModes (void) /*@*/ ;
# endif
}
}
+void
+printFlagManual (void)
+{
+ /*
+ ** Prints all flags by category, in order they appear in flags.def
+ */
+
+ flagkind lastCategory = FK_NONE;
+
+ allFlags (f) {
+ cstring flagname;
+ cstring flagtype = cstring_undefined;
+
+ if (f.main != lastCategory)
+ {
+ llmsg (message ("\n%s\n%s\n",
+ categoryName (f.main),
+ cstring_makeLiteralTemp ("===================================")));
+
+ lastCategory = f.main;
+ }
+
+ if (f.argtype == ARG_NONE || f.argtype == ARG_SPECIAL)
+ {
+ flagname = cstring_fromCharsNew (f.flag);
+ }
+ else
+ {
+ if (flagcode_hasString (f.code))
+ {
+ flagname = message ("%s <%s>", cstring_fromChars (f.flag), argcode_unparse (f.argtype));
+
+ if (cstring_isDefined (context_getString (f.code)))
+ {
+ flagname = message ("%q [%s]", flagname,
+ context_getString (f.code));
+ }
+ }
+ else if (f.argtype == ARG_CHAR)
+ {
+ flagname = message ("%s <%s> [%c]", cstring_fromChars (f.flag), argcode_unparse (f.argtype),
+ (char) context_getValue (f.code));
+ }
+ else
+ {
+ llassert (f.argtype == ARG_NUMBER);
+ flagname = message ("%s <%s> [%d]", cstring_fromChars (f.flag), argcode_unparse (f.argtype),
+ context_getValue (f.code));
+ }
+ }
+
+ if (f.isIdem)
+ {
+ flagtype = message("%q<->", flagtype);
+ }
+
+ if (f.isGlobal)
+ {
+ flagtype = message ("%q<G>", flagtype);
+ }
+
+ if (f.isSpecial)
+ {
+ flagtype = message("%q<S>", flagtype);
+ }
+
+ if (f.isModeFlag)
+ {
+ flagtype = message ("%q<M:%q>", flagtype, getFlagModeSettings (f.code));
+ }
+ else /* its a plain flag */
+ {
+ flagtype = message ("%q<P:%s>", flagtype,
+ cstring_makeLiteralTemp (context_getFlag (f.code) ? "+" : "-"));
+ }
+
+ llmsg (message ("%s: %s", flagname, flagtype));
+
+ if (mstring_isDefined (f.hint))
+ {
+ llgenindentmsgnoloc (cstring_fromCharsNew (f.hint));
+ }
+ else
+ {
+ llgenindentmsgnoloc (message ("%q.", cstring_capitalize (cstring_fromChars (f.desc))));
+ }
+ } end_allFlags ;
+}
+
cstring
describeFlagCode (flagcode flag)
{
cstring ret = cstring_undefined;
fflag f;
-
+
if (flagcode_isInvalid (flag))
{
return (cstring_makeLiteral ("<invalid>"));
f = flags[flag];
ret = cstring_copy (cstring_fromChars (f.desc));
-
if (f.sub != FK_NONE)
{
}
}
}
-
+
if (f.isModeFlag)
{
- bool first = TRUE;
-
- allModes (mname)
- {
- context_setMode (cstring_fromChars (mname));
-
- if (first)
- {
- ret = message ("%q\nMode Settings: %s %s",
- ret, cstring_fromChars (mname),
- cstring_makeLiteralTemp
- (context_getFlag (flag) ? "+" : "-"));
- first = FALSE;
- }
- else
- {
- ret = message ("%q, %s %s",
- ret, cstring_fromChars (mname),
- cstring_makeLiteralTemp
- (context_getFlag (flag) ? "+" : "-"));
- }
- } end_allModes;
+ ret = message ("%q\nMode Settings: %q",
+ ret, getFlagModeSettings (flag));
}
else
{
ret = message ("%q\nDefault Setting: %s",
ret,
- cstring_makeLiteralTemp
- (context_getFlag (flag) ? "+" : "-"));
+ cstring_makeLiteralTemp (context_getFlag (flag) ? "+" : "-"));
}
-
+
if (f.isGlobal)
{
ret = message("%q\nSet globally only", ret);
{
ret = message("%q\nSet locally", ret);
}
-
+
switch (f.argtype)
{
case ARG_NONE:
case ARG_SPECIAL:
break;
- case ARG_VALUE:
- if (flag == FLG_COMMENTCHAR)
- {
- ret = message("%q\nCharacter Argument. Default: %h",
- ret, (char) context_getValue (flag));
- }
- else
- {
- ret = message("%q\nNumeric Argument. Default: %d",
- ret,
- context_getValue (flag));
- }
+ case ARG_NUMBER:
+ ret = message("%q\nNumeric Argument. Default: %d",
+ ret,
+ context_getValue (flag));
+ break;
+ case ARG_CHAR:
+ ret = message("%q\nCharacter Argument. Default: %h",
+ ret, (char) context_getValue (flag));
break;
case ARG_STRING:
+ case ARG_FILE:
+ case ARG_PATH:
+ case ARG_DIRECTORY:
+ {
if (cstring_isDefined (context_getString (flag)))
{
- ret = message("%q\nString Argument. Default: %s",
+ ret = message("%q\n%q argument. Default: %s",
ret,
+ cstring_capitalize (argcode_unparse (f.argtype)),
context_getString (flag));
}
else
{
- ret = message("%q\nString Argument. No default.", ret);
+ ret = message("%q\n%s argument. No default.",
+ ret,
+ cstring_capitalize (argcode_unparse (f.argtype)));
}
break;
+ }
}
-
+
if (mstring_isDefined (f.hint))
{
ret = message("%q\n\3%s", ret, cstring_fromChars (f.hint));
}
-
+
return ret;
}
+
+static cstring getFlagModeSettings (flagcode flag)
+{
+ cstring res = cstring_undefined;
+
+ allModes (mname)
+ {
+ context_setModeNoWarn (cstring_fromChars (mname));
+
+ res = message ("%q%s", res, cstring_makeLiteralTemp (context_getFlag (flag) ? "+" : "-"));
+ } end_allModes;
+
+ return res;
+}
cstring
describeFlag (cstring flagname)
{
cstring oflagname = cstring_copy (flagname);
- flagcode f = identifyFlag (flagname);
+ flagcode f = flags_identifyFlag (flagname);
if (flagcode_isSkip (f))
{
cstring_free (oflagname);
return
- (message ("%s: predefined mode (see User's Guide for information)",
+ (message ("%s: predefined mode (see Manual for information)",
flagname));
}
else
}
flagcode
-identifyFlag (cstring s)
+flags_identifyFlag (cstring s)
+{
+ return flags_identifyFlagAux (s, FALSE);
+}
+
+flagcode
+flags_identifyFlagQuiet (cstring s)
+{
+ return flags_identifyFlagAux (s, TRUE);
+}
+
+static flagcode
+flags_identifyFlagAux (cstring s, bool quiet)
{
if (cstring_length (s) == 0) {
/* evs 2000-06-25: A malformed flag. */
}
/*
- ** For our European friends...
+ ** Backwards compatibility for our American friends...
*/
- if (cstring_equalLit (s, "isolib"))
+ if (cstring_equalLit (s, "ansilib"))
{
return FLG_ANSILIB;
}
- if (cstring_equalLit (s, "isostrictlib"))
- {
- return FLG_STRICTLIB;
- }
-
if (cstring_equalLit (s, "ansistrictlib"))
{
return FLG_STRICTLIB;
}
- if (cstring_equalLit (s, "skipisoheaders"))
+ if (cstring_equalLit (s, "skipansiheaders"))
{
return FLG_SKIPANSIHEADERS;
}
- if (cstring_equalLit (s, "isoreserved"))
+ if (cstring_equalLit (s, "ansireserved"))
{
return FLG_ANSIRESERVED;
}
- if (cstring_equalLit (s, "isoreservedinternal"))
+ if (cstring_equalLit (s, "ansireservedinternal"))
{
return FLG_ANSIRESERVEDLOCAL;
}
- if (cstring_equalLit (s, "isolimits"))
- {
- return FLG_ANSILIMITS;
- }
-
/*
** Obsolete Flags
*/
if (cstring_equalLit (s, "accessunspec"))
{
- llerror_flagWarning
- (cstring_makeLiteral
- ("accessunspec flag is no longer supported. It has been replaced by accessmodule, accessfile and "
- "accessfunction to provide more precise control of accessibility "
- "of representations. For more information, "
- "see lclint -help accessmodule"));
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral
+ ("accessunspec flag is no longer supported. It has been replaced by accessmodule, accessfile and "
+ "accessfunction to provide more precise control of accessibility "
+ "of representations. For more information, "
+ "see lclint -help accessmodule"));
+ }
return SKIP_FLAG;
}
+ else if (cstring_equalLit (s, "ansilimits"))
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral
+ ("ansilimits flag is no longer supported. It has been replaced by ansi89limits and "
+ "iso99limits to select either the lower translation limits imposed by the ANSI89 "
+ "standard or the typically higher limits prescribed by ISO C99."));
+
+ return SKIP_FLAG;
+ }
+ else if (cstring_equalLit (s, "staticmods"))
+ {
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral
+ ("staticmods flag is obsolete. You probably "
+ "want impcheckmodstatics. For more information, "
+ "see lclint -help impcheckmodstatics"));
+ }
- if (cstring_equalLit (s, "staticmods"))
+ return SKIP_FLAG;
+ }
+ else if (cstring_equalLit (s, "bool"))
{
- llerror_flagWarning
- (cstring_makeLiteral
- ("staticmods flag is obsolete. You probably "
- "want impcheckmodstatics. For more information, "
- "see lclint -help impcheckmodstatics"));
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral ("bool flag is obsolete. It never really "
+ "made sense in the first place."));
+ }
return SKIP_FLAG;
}
-
- if (cstring_equalLit (s, "bool"))
+ else if (cstring_equalLit (s, "shiftsigned"))
{
- llerror_flagWarning
- (cstring_makeLiteral ("bool flag is obsolete. It never really "
- "made sense in the first place."));
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral ("shiftsigned flag is obsolete. You probably "
+ "want bitwisesigned, shiftnegative or shiftsize."));
+ }
return SKIP_FLAG;
}
-
- if (cstring_equalLit (s, "ansi"))
+ else if (cstring_equalLit (s, "ansi"))
{
- llerror_flagWarning
- (cstring_makeLiteral ("ansi flag is obsolete. You probably "
- "want noparams and/or oldstyle."));
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral ("ansi flag is obsolete. You probably "
+ "want noparams and/or oldstyle."));
+ }
return SKIP_FLAG;
}
-
- if (cstring_equalLit (s, "stdio"))
- {
- llerror_flagWarning
- (cstring_makeLiteral
- ("stdio flag is obsolete. You may "
- "want strictlib or one of the gloabls "
- "checking flags. For more information, "
- "see lclint -help strictlib or lclint -help flags globals"));
+ else if (cstring_equalLit (s, "stdio"))
+ {
+ if (!quiet)
+ {
+ llerror_flagWarning
+ (cstring_makeLiteral
+ ("stdio flag is obsolete. You may "
+ "want strictlib or one of the gloabls "
+ "checking flags. For more information, "
+ "see lclint -help strictlib or lclint -help flags globals"));
+ }
return SKIP_FLAG;
}
-
- return INVALID_FLAG;
+ else
+ {
+ return INVALID_FLAG;
+ }
}
void setValueFlag (flagcode opt, cstring arg)
cstringSList_elements (sflags, flagname)
{
- flagcode code = identifyFlag (flagname);
+ flagcode code = flags_identifyFlag (flagname);
fflag currentflag = flags[code];
if (mstring_isDefined (currentflag.desc) && flagcode_isModeFlag (code))
return (flags[f].argtype != ARG_NONE);
}
-extern bool flagcode_hasValue (flagcode f)
+extern bool flagcode_hasNumber (flagcode f)
+{
+ return (flags[f].argtype == ARG_NUMBER);
+}
+
+extern bool flagcode_hasChar (flagcode f)
{
- return (flags[f].argtype == ARG_VALUE);
+ return (flags[f].argtype == ARG_CHAR);
}
extern bool flagcode_hasString (flagcode f)
{
- return (flags[f].argtype == ARG_STRING);
+ return (flags[f].argtype == ARG_STRING
+ || flags[f].argtype == ARG_FILE
+ || flags[f].argtype == ARG_DIRECTORY
+ || flags[f].argtype == ARG_PATH);
}
extern int flagcode_valueIndex (flagcode f)
allFlagCodes (code)
{
- if (flagcode_hasValue (code))
+ if (flagcode_hasNumber (code) || flagcode_hasChar (code))
{
llassert (nv < NUMVALUEFLAGS);
DPRINTF (("Value flag: %s [%d]", flagcode_unparse (code), (int) code));
andersk / splint.git / blobdiff