Nicer handling of hand-generated files by build system
[splint-patched.git] / src / nameChecks.c
blob5566114803eb3ba85eeaceb0f791d6d06b157585
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.
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
25 ** nameChecks.c
28 # include "splintMacros.nf"
29 # include "basic.h"
30 # include "nameChecks.h"
32 static bool checkCzechName (uentry p_ue, flagcode p_czechflag, bool p_report)
33 /*@modifies p_ue, g_warningstream@*/ ;
35 static bool checkSlovakName (uentry p_ue, flagcode p_slovakflag, bool p_report)
36 /*@modifies p_ue, g_warningstream@*/ ;
38 static cstring czechPrefix (cstring name)
40 return (cstring_beforeChar (name, '_'));
43 static cstring slovakPrefix (cstring name)
45 size_t i = 0;
47 cstring_chars (name, c)
49 if (isupper ((unsigned char) c))
51 return (cstring_prefix (name, i));
53 i++;
54 } end_cstring_chars;
56 return cstring_undefined;
59 static flagcode excludeCodes [] =
61 FLG_MACROVARPREFIXEXCLUDE,
62 FLG_TAGPREFIXEXCLUDE,
63 FLG_ENUMPREFIXEXCLUDE,
64 FLG_FILESTATICPREFIXEXCLUDE,
65 FLG_GLOBPREFIXEXCLUDE,
66 FLG_TYPEPREFIXEXCLUDE,
67 FLG_EXTERNALPREFIXEXCLUDE,
68 FLG_UNCHECKEDMACROPREFIXEXCLUDE,
69 FLG_LOCALPREFIXEXCLUDE,
70 INVALID_FLAG
71 } ;
73 /*@iter excludeFlagCodes (yield flagcode code);@*/
74 # define excludeFlagCodes(m_c) \
75 { int m_i = 0; while (flagcode_isValid (excludeCodes[m_i])) \
76 { flagcode m_c = excludeCodes[m_i]; m_i++;
78 # define end_excludeFlagCodes }}
80 static bool matchPrefixChar (int nc, int pc)
82 if (nc == pc)
84 return TRUE;
86 else
88 switch (pc)
90 case PFX_UPPERCASE:
91 return isupper (nc);
92 case PFX_LOWERCASE:
93 return islower (nc);
94 case PFX_ANY:
95 return TRUE;
96 case PFX_DIGIT:
97 return isdigit (nc);
98 case PFX_NOTUPPER:
99 return !isupper (nc);
100 case PFX_NOTLOWER:
101 return !islower (nc);
102 case PFX_ANYLETTER:
103 return isalpha (nc);
104 case PFX_ANYLETTERDIGIT:
105 return (isdigit (nc) || isalpha (nc));
106 default: return FALSE;
110 BADEXIT;
113 static bool matchPrefix (cstring name, cstring prefix)
115 if (cstring_isUndefined (name)
116 || cstring_isUndefined (prefix))
118 return TRUE;
120 else
122 size_t namelen = cstring_length (name);
123 int last = (int) '\0';
124 size_t n = 1;
126 cstring_chars (prefix, pc)
128 int nc;
130 if (pc == '*')
132 n++;
134 while (n <= namelen)
136 nc = (int) cstring_getChar (name, n);
138 if (!matchPrefixChar (nc, last))
140 return FALSE;
143 n++;
146 return TRUE;
148 else
150 if (n > namelen)
152 if (namelen > 1
153 && (cstring_length (prefix) >= n + 1)
154 && cstring_getChar (prefix, n + 1) == '*')
156 return TRUE;
158 else
160 return FALSE;
164 nc = (int) cstring_getChar (name, n);
166 if (!matchPrefixChar (nc, (int) pc))
168 return FALSE;
172 last = (int) pc;
173 n++;
174 } end_cstring_chars;
176 return TRUE;
180 static flagcode
181 namespaceExcluded (flagcode code) /*@*/
183 switch (code)
185 case FLG_MACROVARPREFIXEXCLUDE:
186 return (FLG_MACROVARPREFIX);
187 case FLG_TAGPREFIXEXCLUDE:
188 return (FLG_TAGPREFIX);
189 case FLG_ENUMPREFIXEXCLUDE:
190 return (FLG_ENUMPREFIX);
191 case FLG_FILESTATICPREFIXEXCLUDE:
192 return (FLG_FILESTATICPREFIX);
193 case FLG_GLOBPREFIXEXCLUDE:
194 return (FLG_GLOBPREFIX);
195 case FLG_TYPEPREFIXEXCLUDE:
196 return (FLG_TYPEPREFIX);
197 case FLG_EXTERNALPREFIXEXCLUDE:
198 return (FLG_EXTERNALPREFIX);
199 case FLG_UNCHECKEDMACROPREFIXEXCLUDE:
200 return (FLG_UNCHECKEDMACROPREFIX);
201 case FLG_LOCALPREFIXEXCLUDE:
202 return (FLG_LOCALPREFIX);
203 case FLG_ITERPREFIXEXCLUDE:
204 return (FLG_ITERPREFIX);
205 case FLG_CONSTPREFIXEXCLUDE:
206 return (FLG_CONSTPREFIX);
207 BADDEFAULT;
211 static /*@observer@*/ cstring
212 namespaceName (flagcode flag) /*@*/
214 switch (flag)
216 case FLG_MACROVARPREFIX:
217 return cstring_makeLiteralTemp ("macro variable");
218 case FLG_TAGPREFIX:
219 return cstring_makeLiteralTemp ("tag");
220 case FLG_ENUMPREFIX:
221 return cstring_makeLiteralTemp ("enum member");
222 case FLG_TYPEPREFIX:
223 return cstring_makeLiteralTemp ("user-defined type");
224 case FLG_FILESTATICPREFIX:
225 return cstring_makeLiteralTemp ("file static");
226 case FLG_GLOBPREFIX:
227 return cstring_makeLiteralTemp ("global variable");
228 case FLG_EXTERNALPREFIX:
229 return cstring_makeLiteralTemp ("external");
230 case FLG_LOCALPREFIX:
231 return cstring_makeLiteralTemp ("local variable");
232 case FLG_CONSTPREFIX:
233 return cstring_makeLiteralTemp ("constant");
234 case FLG_ITERPREFIX:
235 return cstring_makeLiteralTemp ("iter");
236 case FLG_UNCHECKEDMACROPREFIX:
237 return cstring_makeLiteralTemp ("unchecked macro");
238 BADDEFAULT;
242 void
243 checkPrefix (uentry ue)
245 cstring name = cstring_undefined;
246 flagcode flag;
248 if (uentry_isExpandedMacro (ue))
250 flag = FLG_UNCHECKEDMACROPREFIX;
252 else if (uentry_isAnyTag (ue))
254 flag = FLG_TAGPREFIX;
256 else if (uentry_isEnumConstant (ue))
258 flag = FLG_ENUMPREFIX;
260 else if (uentry_isDatatype (ue))
262 flag = FLG_TYPEPREFIX;
264 else if (uentry_isFileStatic (ue))
266 flag = FLG_FILESTATICPREFIX;
268 else if (uentry_isGlobalVariable (ue))
270 flag = FLG_GLOBPREFIX;
272 else if (uentry_isVariable (ue))
274 if (uentry_isRefParam (ue))
276 return; /* already checked param */
279 if (context_inMacro ())
281 if (uentry_isAnyParam (ue))
283 if (uentry_isYield (ue))
285 flag = FLG_MACROVARPREFIX;
287 else
289 flag = FLG_LOCALPREFIX;
292 else
294 flag = FLG_MACROVARPREFIX;
297 else
299 flag = FLG_LOCALPREFIX;
302 else if (uentry_isConstant (ue))
304 flag = FLG_CONSTPREFIX;
306 else if (uentry_isIter (ue))
308 flag = FLG_ITERPREFIX;
310 else if (uentry_isExported (ue))
312 flag = FLG_EXTERNALPREFIX;
314 else
316 llcontbug (message ("What is it: %q", uentry_unparseFull (ue)));
317 return;
320 if (flag == FLG_TYPEPREFIX || flag == FLG_GLOBPREFIX
321 || flag == FLG_ENUMPREFIX || flag == FLG_CONSTPREFIX)
323 if (flag == FLG_ENUMPREFIX)
325 if (!context_getFlag (flag))
327 flag = FLG_CONSTPREFIX;
331 if (!context_getFlag (flag))
333 flag = FLG_EXTERNALPREFIX;
337 if (context_getFlag (flag))
339 name = uentry_observeRealName (ue);
341 if (!matchPrefix (name, context_getString (flag)))
343 llassert (flag != FLG_NAMECHECKS);
345 if (optgenerror2
346 (flag, FLG_NAMECHECKS,
347 message ("%s %s name is not consistent with %s "
348 "namespace prefix \"%s\"",
349 uentry_ekindName (ue),
350 name,
351 namespaceName (flag),
352 context_getString (flag)),
353 uentry_whereLast (ue)))
355 uentry_setHasNameError (ue);
360 excludeFlagCodes (code)
362 bool check = FALSE;
364 if (context_getFlag (code))
366 /*@-loopswitchbreak@*/
367 switch (code)
369 case FLG_MACROVARPREFIXEXCLUDE:
370 check = (flag != FLG_MACROVARPREFIX);
371 break;
372 case FLG_TAGPREFIXEXCLUDE:
373 check = (flag != FLG_TAGPREFIX);
374 break;
375 case FLG_ENUMPREFIXEXCLUDE:
376 check = (flag != FLG_ENUMPREFIX);
377 break;
378 case FLG_FILESTATICPREFIXEXCLUDE:
379 check = (flag != FLG_FILESTATICPREFIX);
380 break;
381 case FLG_GLOBPREFIXEXCLUDE:
382 check = (flag != FLG_GLOBPREFIX);
383 break;
384 case FLG_TYPEPREFIXEXCLUDE:
385 check = (flag != FLG_TYPEPREFIX);
386 break;
387 case FLG_EXTERNALPREFIXEXCLUDE:
388 check = (flag != FLG_EXTERNALPREFIX
389 && flag != FLG_GLOBPREFIX
390 && flag != FLG_TYPEPREFIX
391 && flag != FLG_UNCHECKEDMACROPREFIX);
392 break;
393 case FLG_UNCHECKEDMACROPREFIXEXCLUDE:
394 check = (flag != FLG_UNCHECKEDMACROPREFIX);
395 break;
396 case FLG_LOCALPREFIXEXCLUDE:
397 check = (flag != FLG_LOCALPREFIX);
398 break;
399 case FLG_CONSTPREFIXEXCLUDE:
400 check = (flag != FLG_CONSTPREFIX);
401 break;
402 case FLG_ITERPREFIXEXCLUDE:
403 check = (flag != FLG_ITERPREFIX);
404 break;
405 BADDEFAULT;
407 /*@=loopswitchbreak@*/
409 if (check)
411 flagcode rcode = namespaceExcluded (code);
412 cstring pstring = context_getString (rcode);
414 if (cstring_isDefined (pstring))
416 if (cstring_isUndefined (name))
418 name = uentry_observeRealName (ue);
421 if (matchPrefix (name, context_getString (rcode)))
423 if (optgenerror2
424 (code, FLG_NAMECHECKS,
425 message
426 ("%s %s name is not a %s (it is a %s), "
427 "but matches the %s "
428 "namespace prefix \"%s\"",
429 uentry_ekindName (ue),
430 name,
431 namespaceName (rcode),
432 namespaceName (flag),
433 namespaceName (rcode),
434 context_getString (rcode)),
435 uentry_whereLast (ue)))
437 uentry_setHasNameError (ue);
443 } end_excludeFlagCodes ;
446 static void
447 checkNationalName (uentry ue)
449 flagcode czechflag;
450 flagcode slovakflag;
451 flagcode czechoslovakflag;
452 bool gcf, gsf, gcsf;
455 if (uentry_isFunction (ue)
456 || uentry_isIter (ue)
457 || uentry_isEndIter (ue))
459 czechflag = FLG_CZECHFUNCTIONS;
460 slovakflag = FLG_SLOVAKFUNCTIONS;
461 czechoslovakflag = FLG_CZECHOSLOVAKFUNCTIONS;
463 else if (uentry_isExpandedMacro (ue))
465 czechflag = FLG_CZECHMACROS;
466 slovakflag = FLG_SLOVAKMACROS;
467 czechoslovakflag = FLG_CZECHOSLOVAKMACROS;
469 else if (uentry_isVariable (ue))
471 if (uentry_isGlobalVariable (ue) && context_getFlag (FLG_GLOBPREFIX))
473 /* prefix checks supercede national naming checks */
474 return;
477 czechflag = FLG_CZECHVARS;
478 slovakflag = FLG_SLOVAKVARS;
479 czechoslovakflag = FLG_CZECHOSLOVAKVARS;
481 else if (uentry_isConstant (ue))
483 if (uentry_isGlobalVariable (ue) && context_getFlag (FLG_CONSTPREFIX))
485 /* prefix checks supercede national naming checks */
486 return;
489 czechflag = FLG_CZECHCONSTANTS;
490 slovakflag = FLG_SLOVAKCONSTANTS;
491 czechoslovakflag = FLG_CZECHOSLOVAKCONSTANTS;
493 else
495 if (uentry_isAnyTag (ue) || uentry_isEnumConstant (ue))
497 return; /* no errors for tags */
500 llassert (uentry_isDatatype (ue));
502 czechflag = FLG_CZECHTYPES;
503 slovakflag = FLG_SLOVAKTYPES;
504 czechoslovakflag = FLG_CZECHOSLOVAKTYPES;
507 gcf = context_getFlag (czechflag);
508 gsf = context_getFlag (slovakflag);
509 gcsf = context_getFlag (czechoslovakflag);
511 if (gcf || (uentry_isFunction (ue)
512 && context_getFlag (FLG_ACCESSCZECH)))
514 (void) checkCzechName (ue, czechflag, gcf);
517 if (gsf || (uentry_isFunction (ue)
518 && context_getFlag (FLG_ACCESSSLOVAK)))
520 (void) checkSlovakName (ue, slovakflag, gsf);
523 if (gcsf)
525 if (uentry_isDatatype (ue))
527 /* May not have either _'s or uppercase letter */
528 cstring name = uentry_rawName (ue);
529 int charno = 1;
531 cstring_chars (name, c)
533 if (isupper ((unsigned char) c))
535 if (optgenerror2
536 (FLG_CZECHOSLOVAKTYPES, FLG_NAMECHECKS,
537 message
538 ("%s %q name violates Czechoslovak naming convention. "
539 "Czechoslovak datatype names should not use uppercase "
540 "letters.",
541 uentry_ekindName (ue),
542 uentry_getName (ue)),
543 uentry_whereLast (ue)))
545 uentry_setHasNameError (ue);
547 break;
550 if (c == '_' && charno != 2 && charno != 3)
552 if (optgenerror2
553 (FLG_CZECHOSLOVAKTYPES, FLG_NAMECHECKS,
554 message ("%s %q name violates Czechoslovak naming "
555 "convention. Czechoslovak datatype names "
556 "should not use the _ charater.",
557 uentry_ekindName (ue),
558 uentry_getName (ue)),
559 uentry_whereLast (ue)))
561 uentry_setHasNameError (ue);
563 break;
566 charno++;
567 } end_cstring_chars;
569 else
571 bool okay = checkCzechName (ue, czechflag, FALSE);
573 /* still need to call, to set access */
574 okay |= checkSlovakName (ue, slovakflag, FALSE);
576 if (!okay)
578 if (optgenerror2
579 (czechoslovakflag, FLG_NAMECHECKS,
580 message ("%s %q name is not consistent with Czechoslovak "
581 "naming convention.",
582 uentry_ekindName (ue),
583 uentry_getName (ue)),
584 uentry_whereLast (ue)))
586 uentry_setHasNameError (ue);
593 static bool checkCzechName (uentry ue, flagcode czechflag, bool report)
595 if (uentry_isDatatype (ue))
598 ** Czech datatypes may not have _'s, except if there are 1 or 2 characters
599 ** before the only _.
602 cstring name = uentry_rawName (ue);
603 int charno = 1;
605 cstring_chars (name, c)
607 if (c == '_' && charno != 2 && charno != 3)
609 if (report)
611 if (optgenerror2
612 (FLG_CZECHTYPES, FLG_NAMECHECKS,
613 message
614 ("%s %q name violates Czech naming convention. "
615 "Czech datatype names should not use the _ charater.",
616 uentry_ekindName (ue),
617 uentry_getName (ue)),
618 uentry_whereLast (ue)))
620 uentry_setHasNameError (ue);
624 return FALSE;
627 charno++;
628 } end_cstring_chars;
630 else
632 typeIdSet acc = context_fileAccessTypes ();
633 cstring pfx = czechPrefix (uentry_rawName (ue));
635 if (cstring_isEmpty (pfx))
637 if (uentry_isVariable (ue) || uentry_isConstant (ue))
639 ctype ct = uentry_getType (ue);
641 if (ctype_isAbstract (ct)
642 && context_hasAccess (ctype_typeId (ct)))
644 if (report)
646 if (optgenerror2
647 (czechflag, FLG_NAMECHECKS,
648 message ("%s %q name is not consistent with Czech "
649 "naming convention. The name should "
650 "begin with %s_",
651 uentry_ekindName (ue),
652 uentry_getName (ue),
653 ctype_unparse (ct)),
654 uentry_whereLast (ue)))
656 uentry_setHasNameError (ue);
660 cstring_free (pfx);
661 return FALSE;
664 else if (uentry_isFunction (ue) || uentry_isIter (ue))
666 if (typeIdSet_isEmpty (acc))
668 ; /* okay - should not be czech name */
670 else
672 if (report)
674 if (optgenerror2
675 (czechflag, FLG_NAMECHECKS,
676 message ("%s %q name is not consistent with Czech "
677 "naming convention. Accessible types: %q",
678 uentry_ekindName (ue),
679 uentry_getName (ue),
680 typeIdSet_unparse (acc)),
681 uentry_whereLast (ue)))
683 uentry_setHasNameError (ue);
687 cstring_free (pfx);
688 return FALSE;
691 else
696 else
698 if (usymtab_existsTypeEither (pfx))
700 ctype ct = usymtab_lookupAbstractType (pfx);
701 typeId tid;
703 if (ctype_isUA (ct))
705 tid = ctype_typeId (ct);
707 if (ctype_isUser (ct) || context_hasAccess (tid))
711 else
713 if (context_getFlag (FLG_ACCESSCZECH)
714 || context_getFlag (FLG_ACCESSCZECHOSLOVAK))
716 if (!uentry_isVar (ue))
718 uentry_addAccessType (ue, tid);
721 else
723 if (report)
725 if (llgenhinterror
726 (czechflag,
727 message
728 ("%s %q name violates Czech naming "
729 "convention. Czech prefix %s names "
730 "an abstract type that is "
731 "not accessible.",
732 uentry_ekindName (ue),
733 uentry_getName (ue),
734 pfx),
735 cstring_makeLiteral
736 ("Use +accessczech to allow access to "
737 "type <t> in functions "
738 "named <t>_<name>."),
739 uentry_whereLast (ue)))
741 uentry_setHasNameError (ue);
745 cstring_free (pfx);
746 return FALSE;
750 else if (ctype_isManifestBool (ct))
752 if (context_canAccessBool ())
756 else
758 if (context_getFlag (FLG_ACCESSCZECH)
759 || context_getFlag (FLG_ACCESSCZECHOSLOVAK))
761 if (!uentry_isVar (ue))
763 tid = usymtab_getTypeId (context_getBoolName ());
764 uentry_addAccessType (ue, tid);
767 else
769 if (report)
771 if (llgenhinterror
772 (czechflag,
773 message
774 ("%s %q name violates Czech naming "
775 "convention. Type bool is not accessible.",
776 uentry_ekindName (ue),
777 uentry_getName (ue)),
778 cstring_makeLiteral
779 ("Use +accessczech to allow access to "
780 "type <t> in functions named <t>_<name>."),
781 uentry_whereLast (ue)))
783 uentry_setHasNameError (ue);
787 cstring_free (pfx);
788 return FALSE;
792 else
797 else
799 if (cstring_equalLit (pfx, "int")
800 || cstring_equalLit (pfx, "char")
801 || cstring_equalLit (pfx, "short")
802 || cstring_equalLit (pfx, "long")
803 || cstring_equalLit (pfx, "unsigned")
804 || cstring_equalLit (pfx, "signed")
805 || cstring_equalLit (pfx, "float")
806 || cstring_equalLit (pfx, "double"))
808 ; /* built-in types */
810 else
812 /* no accessible types, could match module name */
814 if (cstring_equal (pfx, context_moduleName ()))
818 else
820 if (report)
822 if (optgenerror2
823 (czechflag, FLG_NAMECHECKS,
824 message
825 ("%s %q name violates Czech naming convention. "
826 "Czech prefix %s is not the name of a type.",
827 uentry_ekindName (ue),
828 uentry_getName (ue),
829 pfx),
830 uentry_whereLast (ue)))
832 uentry_setHasNameError (ue);
836 cstring_free (pfx);
837 return FALSE;
842 cstring_free (pfx);
845 return TRUE;
848 static bool checkSlovakName (uentry ue, flagcode slovakflag, bool report)
850 if (uentry_isDatatype (ue))
853 ** Slovak datatypes may not have uppercase letters.
856 if (context_getFlag (FLG_SLOVAK))
858 cstring name = uentry_rawName (ue);
860 cstring_chars (name, c)
862 if (isupper ((unsigned char) c))
864 if (report)
866 if (optgenerror2
867 (FLG_SLOVAKTYPES, FLG_NAMECHECKS,
868 message
869 ("%s %q name violates Slovak naming convention. "
870 "Slovak datatype names should not use uppercase "
871 "letters.",
872 uentry_ekindName (ue),
873 uentry_getName (ue)),
874 uentry_whereLast (ue)))
876 uentry_setHasNameError (ue);
879 return FALSE;
881 } end_cstring_chars;
884 else
886 typeIdSet acc = context_fileAccessTypes ();
887 cstring pfx = slovakPrefix (uentry_rawName (ue));
889 if (cstring_isEmpty (pfx))
891 if (typeIdSet_isEmpty (acc))
893 ; /* okay - should not be slovak name */
895 else
897 if (uentry_isFunction (ue))
899 if (report)
901 if (optgenerror2
902 (slovakflag, FLG_NAMECHECKS,
903 message ("%s %q name is not consistent with Slovak "
904 "naming convention. Accessible types: %q",
905 uentry_ekindName (ue),
906 uentry_getName (ue),
907 typeIdSet_unparse (acc)),
908 uentry_whereLast (ue)))
910 uentry_setHasNameError (ue);
914 cstring_free (pfx);
915 return FALSE;
917 else
919 ctype ct = uentry_getType (ue);
921 if (ctype_isUA (ct))
923 if (report)
925 if (optgenerror2
926 (slovakflag, FLG_NAMECHECKS,
927 message ("%s %q name is not consistent with "
928 "Slovak naming convention. The "
929 "name should begin with %s followed "
930 "by an uppercase letter.",
931 uentry_ekindName (ue),
932 uentry_getName (ue),
933 ctype_unparse (ct)),
934 uentry_whereLast (ue)))
936 uentry_setHasNameError (ue);
940 cstring_free (pfx);
941 return FALSE;
946 else
948 if (usymtab_existsTypeEither (pfx))
950 ctype ct = usymtab_lookupAbstractType (pfx);
951 typeId tid;
953 if (ctype_isUA (ct))
955 tid = ctype_typeId (ct);
957 if (ctype_isUser (ct) || context_hasAccess (tid))
961 else
963 if (context_getFlag (FLG_ACCESSSLOVAK)
964 || context_getFlag (FLG_ACCESSCZECHOSLOVAK))
966 if (!uentry_isVar (ue))
968 uentry_addAccessType (ue, tid);
971 else
973 if (report)
975 if (llgenhinterror
976 (slovakflag,
977 message
978 ("%s %q name violates Slovak naming "
979 "convention. Slovak prefix %s names "
980 "an abstract type that is not accessible.",
981 uentry_ekindName (ue),
982 uentry_getName (ue),
983 pfx),
984 cstring_makeLiteral
985 ("Use +accessslovak to allow access to "
986 "type <t> in functions named <t>_<name>."),
987 uentry_whereLast (ue)))
989 uentry_setHasNameError (ue);
993 cstring_free (pfx);
994 return FALSE;
998 else if (ctype_isManifestBool (ct))
1000 if (context_canAccessBool ())
1004 else
1006 if (context_getFlag (FLG_ACCESSSLOVAK)
1007 || context_getFlag (FLG_ACCESSCZECHOSLOVAK))
1009 if (!uentry_isVar (ue))
1011 tid = usymtab_getTypeId (context_getBoolName ());
1012 uentry_addAccessType (ue, tid);
1015 else
1017 if (report)
1019 if (llgenhinterror
1020 (slovakflag,
1021 message
1022 ("%s %q name violates Slovak naming convention. "
1023 "Type bool is not accessible.",
1024 uentry_ekindName (ue),
1025 uentry_getName (ue)),
1026 cstring_makeLiteral
1027 ("Use +accessslovak to allow access to "
1028 "type <t> in functions named <t>_<name>."),
1029 uentry_whereLast (ue)))
1031 uentry_setHasNameError (ue);
1035 cstring_free (pfx);
1036 return FALSE;
1040 else
1045 else
1047 if (cstring_equalLit (pfx, "int")
1048 || cstring_equalLit (pfx, "char")
1049 || cstring_equalLit (pfx, "short")
1050 || cstring_equalLit (pfx, "long")
1051 || cstring_equalLit (pfx, "unsigned")
1052 || cstring_equalLit (pfx, "signed")
1053 || cstring_equalLit (pfx, "float")
1054 || cstring_equalLit (pfx, "double"))
1056 ; /* built-in types */
1058 else
1060 /* no accessible types, could match module name */
1062 if (cstring_equal (pfx, context_moduleName ()))
1066 else
1068 if (report)
1070 if (optgenerror2
1071 (slovakflag, FLG_NAMECHECKS,
1072 message
1073 ("%s %q name violates Slovak naming convention. "
1074 "Slovak prefix %s is not the name of a type.",
1075 uentry_ekindName (ue),
1076 uentry_getName (ue),
1077 pfx),
1078 uentry_whereLast (ue)))
1080 uentry_setHasNameError (ue);
1084 cstring_free (pfx);
1085 return FALSE;
1091 cstring_free (pfx);
1094 return TRUE;
1097 void
1098 checkExternalName (uentry ue)
1100 if (!uentry_isStatic (ue) && uentry_hasName (ue))
1102 checkNationalName (ue);
1104 else
1110 void
1111 checkLocalName (/*@unused@*/ uentry ue)
1114 ** No local checks (yet)
1117 return;
1120 void
1121 checkFileScopeName (/*@unused@*/ uentry ue)
1124 ** No file scope checks (yet)
1127 /* add a file scope naming convention policy? */
1129 return;
1133 ** Checks a name used by user source is not reserved by ANSI
1134 ** (or for future library functions).
1136 ** The restrictions are described in X3.159-1989: 4.13
1139 /*@constant int NRESERVEDNAMES; @*/
1140 # define NRESERVEDNAMES 201
1142 /*@constant int NCPPNAMES@*/
1143 # define NCPPNAMES 39
1145 void
1146 checkCppName (uentry ue)
1148 cstring name = uentry_observeRealName (ue);
1150 static ob_mstring cppNames[NCPPNAMES] =
1152 "and", "and_eq", "asm",
1153 "bitand", "bitor", "bool", /* gasp: "bool", is special for splint */
1154 "catch", "class", "compl", "const_class",
1155 "delete", "dynamic_cast", "false", "friend",
1156 "inline", "mutable", "namespace", "new",
1157 "not", "not_eq",
1158 "operator", "or", "or_eq", "overload",
1159 "private", "protected", "public",
1160 "reinterpret_cast", "static_cast",
1161 "template", "this", "throw", "true", "try",
1162 "typeid", "using", "virtual", "xor", "xor_eq"
1165 if (cstring_isDefined (cstring_bsearch (name, &cppNames[0],
1166 NCPPNAMES)))
1168 if (optgenerror2
1169 (FLG_CPPNAMES, FLG_NAMECHECKS,
1170 message ("Name %s is a keyword or reserved word in C++",
1171 name),
1172 uentry_whereLast (ue)))
1174 uentry_setHasNameError (ue);
1179 void
1180 checkAnsiName (uentry ue)
1182 bool hasError = FALSE;
1183 cstring name = uentry_observeRealName (ue);
1184 size_t length = cstring_length (name);
1185 char fchar = (length >= 1) ? cstring_firstChar (name) : '\0';
1186 char schar = (length >= 2) ? cstring_secondChar (name) : '\0';
1187 char tchar = (length >= 3) ? cstring_getChar (name, 3) : '\0';
1188 char rchar = (length >= 4) ? cstring_getChar (name, 4) : '\0';
1191 ** reservedNames
1192 ** taken from Linden, "Expert C Programming", p. 126-8.
1193 ** invariant: must be sorted (case-insensitive, lexicographically)
1194 ** must end with NULL
1197 static ob_mstring reservedNames[NRESERVEDNAMES] =
1199 # include "reservedNames.nf"
1202 # if 0
1204 ** This code is for checking reservedNames.nf
1208 int i = 0;
1209 char *lastname = NULL;
1210 char *name;
1212 while ((name = reservedNames[i]) != NULL)
1214 llassertprint (lastname == NULL
1215 || strcmp (name, lastname) > 0,
1216 ("%s / %s", lastname, name));
1217 lastname = name;
1218 i++;
1221 nreservedNames = i - 1;
1223 # endif
1225 if (fileloc_isSystemFile (uentry_whereLast (ue)) || fileloc_isBuiltin (uentry_whereLast (ue)))
1227 return; /* no errors for system files */
1230 if (cstring_isDefined (cstring_bsearch (name, &reservedNames[0],
1231 NRESERVEDNAMES)))
1233 hasError |= optgenerror2
1234 (FLG_ISORESERVED, FLG_NAMECHECKS,
1235 message ("Name %s is reserved for the standard library",
1236 name),
1237 uentry_whereLast (ue));
1240 if (uentry_isFileStatic (ue) || uentry_isVisibleExternally (ue) || uentry_isAnyTag (ue)
1241 || context_getFlag (FLG_ISORESERVEDLOCAL))
1243 if (fchar == '_')
1245 hasError |= optgenerror2
1246 (FLG_ISORESERVED, FLG_NAMECHECKS,
1247 message
1248 ("Name %s is in the implementation name space (any identifier "
1249 "beginning with underscore)",
1250 name),
1251 uentry_whereLast (ue));
1254 else
1257 ** ISO 7.1.3:
1258 ** - All identifiers that begin with an underscore and either an uppercase
1259 ** letter or another underscore are always reserved for any use.
1262 if (fchar == '_'
1263 && (schar == '_' || isupper ((int) schar)))
1265 hasError |= optgenerror2
1266 (FLG_ISORESERVED, FLG_NAMECHECKS,
1267 message
1268 ("Name %s is in the implementation name space (any identifier "
1269 "beginning with underscore and either an uppercase letter or "
1270 "another underscore is always reserved for any use)",
1271 name),
1272 uentry_whereLast (ue));
1277 ** 4.13.1 Errors <errno.h>
1279 ** Macros that begin with E and a digit or E and an uppercase letter ...
1282 if (fchar == 'E' && (isdigit ((int) schar)
1283 || isupper ((int) schar)))
1285 hasError |= optgenerror2
1286 (FLG_ISORESERVED, FLG_NAMECHECKS,
1287 message
1288 ("Name %s is reserved for future library extensions. "
1289 "Macros beginning with E and a digit or uppercase letter "
1290 "may be added to <errno.h>. (ISO99:7.26.3)",
1291 name),
1292 uentry_whereLast (ue));
1296 ** 4.13.3 Localization <locale.h>
1298 ** Macros that begin with LC_ and an uppercase letter ...
1301 if (length >= 4
1302 && ((fchar == 'L')
1303 && (schar == 'C')
1304 && (tchar == '_'))
1305 && (isupper ((int) rchar)))
1307 hasError |= optgenerror2
1308 (FLG_ISORESERVED, FLG_NAMECHECKS,
1309 message
1310 ("Name %s is reserved for future library extensions. "
1311 "Macros beginning with \"LC_\" and an uppercase letter may "
1312 "be added to <locale.h>. (ISO99:7.26.5)",
1313 name),
1314 uentry_whereLast (ue));
1318 ** 4.13.5 Signal Handling <signal.h>
1320 ** Macros that begin with either SIG or SIG_ and an uppercase letter or...
1323 if (fchar == 'S' && schar == 'I' && tchar == 'G'
1324 && ((rchar == '_' && ((length >= 5
1325 && isupper ((int) cstring_getChar (name, 5)))))
1326 || (isupper ((int) rchar))))
1328 hasError |= optgenerror2
1329 (FLG_ISORESERVED, FLG_NAMECHECKS,
1330 message
1331 ("Name %s is reserved for future library extensions. "
1332 "Macros that begin with SIG and an uppercase letter or SIG_ "
1333 "and an uppercase letter may be added to "
1334 "<signal.h>. (ISO99:7.14)",
1335 name),
1336 uentry_whereLast (ue));
1340 ** evans - 2002-12-16: added this check (even though it is not required by ISO)
1343 if (fchar == 'S' && schar == 'A' && tchar == '_')
1345 hasError |= optgenerror2
1346 (FLG_ISORESERVED, FLG_NAMECHECKS,
1347 message
1348 ("Name %s may be defined as a macro by Linux library. "
1349 "It is not research by the ISO specification, but may produce conflicts on some systems.",
1350 name),
1351 uentry_whereLast (ue));
1354 if ((uentry_isVisibleExternally (ue) && !uentry_isAnyTag (ue))
1355 || context_getFlag (FLG_ISORESERVEDLOCAL))
1357 flagcode flg;
1359 DPRINTF (("Okay...: %s", uentry_unparse (ue)));
1361 if (uentry_isVisibleExternally (ue) && !uentry_isAnyTag (ue))
1363 flg = FLG_ISORESERVED;
1365 else
1367 flg = FLG_ISORESERVEDLOCAL;
1370 DPRINTF (("ue: %s", uentry_unparseFull (ue)));
1373 ** These restrictions only apply to identifiers with global linkage.
1377 ** 4.13.2 Character Handling <ctype.h>
1379 ** Function names that begin with either "is" or "to" and a lowercase letter ...
1382 if (((fchar == 'i' && schar == 's')
1383 || (fchar == 't' && schar == 'o'))
1384 && (islower ((int) tchar)))
1386 hasError |= optgenerror2
1387 (flg, FLG_NAMECHECKS,
1388 message
1389 ("Name %s is reserved for future library extensions. "
1390 "Functions beginning with \"is\" or \"to\" and a lowercase "
1391 "letter may be added to <ctype.h>. (ISO99:7.26.2)",
1392 name),
1393 uentry_whereLast (ue));
1395 DPRINTF (("Externally visible: %s / %s",
1396 uentry_unparseFull (ue),
1397 bool_unparse (uentry_isVisibleExternally (ue))));
1402 ** 4.13.4 Mathematics <math.h>
1404 ** The names of all existing functions declared in the <math.h> header,
1405 ** suffixed with f or l...
1408 DPRINTF (("Check name: %s", name));
1410 if ((cstring_lastChar (name) == 'f' || cstring_lastChar (name) == 'l')
1412 (((length == 4)
1413 && ((cstring_equalPrefixLit (name, "cos") ||
1414 cstring_equalPrefixLit (name, "sin") ||
1415 cstring_equalPrefixLit (name, "tan") ||
1416 cstring_equalPrefixLit (name, "exp") ||
1417 cstring_equalPrefixLit (name, "log") ||
1418 cstring_equalPrefixLit (name, "pow"))))
1419 || ((length == 5)
1420 && ((cstring_equalPrefixLit (name, "acos") ||
1421 cstring_equalPrefixLit (name, "asin") ||
1422 cstring_equalPrefixLit (name, "atan") ||
1423 cstring_equalPrefixLit (name, "cosh") ||
1424 cstring_equalPrefixLit (name, "sinh") ||
1425 cstring_equalPrefixLit (name, "sqrt") ||
1426 cstring_equalPrefixLit (name, "ceil") ||
1427 cstring_equalPrefixLit (name, "fabs") ||
1428 cstring_equalPrefixLit (name, "fmod") ||
1429 cstring_equalPrefixLit (name, "tanh") ||
1430 cstring_equalPrefixLit (name, "modf"))))
1431 || ((length == 6)
1432 && ((cstring_equalPrefixLit (name, "atan2") ||
1433 cstring_equalPrefixLit (name, "floor") ||
1434 cstring_equalPrefixLit (name, "frexp") ||
1435 cstring_equalPrefixLit (name, "ldexp") ||
1436 cstring_equalPrefixLit (name, "log10"))))))
1438 hasError |= optgenerror2
1439 (flg, FLG_NAMECHECKS,
1440 message
1441 ("Name %s is reserved for future library extensions. "
1442 "The names of all existing functions in <math.h> suffixed "
1443 "with 'f' or 'l' may be added to <math.h>. (ISO:7.26.1)",
1444 name),
1445 uentry_whereLast (ue));
1449 ** 4.13.6 Input/Output <stdio.h>
1451 ** (nothing to check)
1455 ** 4.13.7 General Utilities <stdlib.h>
1457 ** Functions names that begin with str and a lowercase letter may be added to <stdlib.h>.
1460 if (fchar == 's' && schar == 't' && tchar == 'r'
1461 && (islower ((int) rchar)))
1463 hasError |= optgenerror2
1464 (flg, FLG_NAMECHECKS,
1465 message
1466 ("Name %s is reserved for future library extensions. "
1467 "Functions that begin with \"str\" and a lowercase letter "
1468 "may be added to <stdlib.h> or <string.h>. (ISO99:7.26.9)",
1469 name),
1470 uentry_whereLast (ue));
1474 ** 4.13.8 String Handling <string.h>
1476 ** Function names that begin with str, mem, or wcs and a lowercase letter ...
1478 ** (Note: already checked "str" above.)
1481 if (((fchar == 'm' && schar == 'e' && tchar == 'm')
1482 || (fchar == 'w' && schar == 'c' && tchar == 's'))
1483 && (islower ((int) rchar)))
1485 hasError |= optgenerror2
1486 (flg, FLG_NAMECHECKS,
1487 message
1488 ("Name %s is reserved for future library extensions. "
1489 "Functions that begin with \"mem\" or \"wcs\" and a "
1490 "lowercase letter may be added to <string.h>. (ISO:7.26.11)",
1491 name),
1492 uentry_whereLast (ue));
1495 else
1497 DPRINTF (("Not checked: [%s] %s", bool_unparse (uentry_isVisibleExternally (ue)),
1498 uentry_unparseFull (ue)));
1501 if (hasError)
1503 uentry_setHasNameError (ue);
1507 void checkParamNames (uentry ue)
1509 cstring fpfx = context_getString (FLG_DECLPARAMPREFIX);
1510 bool noformal = context_getFlag (FLG_DECLPARAMNAME);
1512 llassert (uentry_isFunction (ue));
1514 if (cstring_isDefined (fpfx) || noformal)
1516 uentryList params = uentry_getParams (ue);
1518 uentryList_elements (params, p)
1520 if (uentry_hasName (p))
1522 if (noformal && !cstring_isDefined (fpfx))
1524 if (optgenerror2
1525 (FLG_DECLPARAMNAME, FLG_NAMECHECKS,
1526 message ("Declaration parameter has name: %q",
1527 uentry_getName (p)),
1528 uentry_whereLast (p)))
1530 uentry_setHasNameError (p);
1533 else
1535 cstring pname = uentry_observeRealName (p);
1537 if (!cstring_equalPrefix (pname, fpfx))
1539 if (context_getFlag (FLG_NAMECHECKS))
1541 if (optgenerror2
1542 (FLG_DECLPARAMPREFIX, FLG_NAMECHECKS,
1543 message ("Declaration parameter name %s does not begin "
1544 "with protoparamprefix (%s)",
1545 pname, fpfx),
1546 uentry_whereLast (p)))
1548 uentry_setHasNameError (p);
1554 } end_uentryList_elements ;
1558 /* not yet checked: POSIX p. 527 - applications should not declare any symbols that end _MAX */