remove extraneous code checked in with previous delta
[official-gcc.git] / gcc / fix-header.c
blobc4d7e728ae16f841f785101f654ad9ae0e04eaeb
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
8 later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* This program massages a system include file (such as stdio.h),
20 into a form that is compatible with GNU C and GNU C++.
22 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
23 if they seem to be needed. These prevent C++ compilers from name
24 mangling the functions inside the braces.
26 * If an old-style incomplete function declaration is seen (without
27 an argument list), and it is a "standard" function listed in
28 the file sys-protos.h (and with a non-empty argument list), then
29 the declaration is converted to a complete prototype by replacing
30 the empty parameter list with the argument list from sys-protos.h.
32 * The program can be given a list of (names of) required standard
33 functions (such as fclose for stdio.h). If a required function
34 is not seen in the input, then a prototype for it will be
35 written to the output.
37 * If all of the non-comment code of the original file is protected
38 against multiple inclusion:
39 #ifndef FOO
40 #define FOO
41 <body of include file>
42 #endif
43 then extra matter added to the include file is placed inside the <body>.
45 * If the input file is OK (nothing needs to be done);
46 the output file is not written (nor removed if it exists).
48 There are also some special actions that are done for certain
49 well-known standard include files:
51 * If argv[1] is "sys/stat.h", the Posix.1 macros
52 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
53 they were missing, and the corresponding "traditional" S_IFxxx
54 macros were defined.
56 * If argv[1] is "errno.h", errno is declared if it was missing.
58 * TODO: The input file should be read complete into memory, because:
59 a) it needs to be scanned twice anyway, and
60 b) it would be nice to allow update in place.
62 Usage:
63 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
64 where:
65 * FOO.H is the relative file name of the include file,
66 as it would be #include'd by a C file. (E.g. stdio.h)
67 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
68 * OUTFILE.H is the full pathname for where to write the output file,
69 if anything needs to be done. (e.g. ./include/stdio.h)
70 * OPTIONS are such as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
74 #include "hconfig.h"
75 #include "system.h"
76 #include "obstack.h"
77 #include "scan.h"
78 #include "cpplib.h"
80 static void v_fatal PARAMS ((const char *, va_list)) ATTRIBUTE_NORETURN;
81 static void fatal PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
83 sstring buf;
85 int verbose = 0;
86 int partial_count = 0;
87 int warnings = 0;
89 /* We no longer need to add extern "C", because cpp implicitly
90 forces the standard include files to be treated as C. */
91 /*#define ADD_MISSING_EXTERN_C 1 */
93 #if ADD_MISSING_EXTERN_C
94 int missing_extern_C_count = 0;
95 #endif
97 #include "xsys-protos.h"
99 #ifdef FIXPROTO_IGNORE_LIST
100 /* This is a currently unused feature. */
102 /* List of files and directories to ignore.
103 A directory name (ending in '/') means ignore anything in that
104 directory. (It might be more efficient to do directory pruning
105 earlier in fixproto, but this is simpler and easier to customize.) */
107 static char *files_to_ignore[] = {
108 "X11/",
109 FIXPROTO_IGNORE_LIST
112 #endif
114 char *inf_buffer;
115 char *inf_limit;
116 char *inf_ptr;
118 /* Certain standard files get extra treatment */
120 enum special_file
122 no_special,
123 #ifdef errno_h
124 #undef errno_h
125 #endif
126 errno_h,
127 #ifdef stdio_h
128 #undef stdio_h
129 #endif
130 stdio_h,
131 #ifdef stdlib_h
132 #undef stdlib_h
133 #endif
134 stdlib_h,
135 #ifdef sys_stat_h
136 #undef sys_stat_h
137 #endif
138 sys_stat_h
141 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
142 by an empty name (i.e. by "\0\0"). */
144 typedef const char *namelist;
146 /* The following macros provide the bits for symbol_flags. */
147 typedef int symbol_flags;
149 /* Used to mark names defined in the ANSI/ISO C standard. */
150 #define ANSI_SYMBOL 1
152 /* We no longer massage include files for POSIX or XOPEN symbols,
153 as there are now several versions of the POSIX and XOPEN standards,
154 and it would be a maintenance nightmare for us to track them all.
155 Better to be compatible with the system include files. */
156 /*#define ADD_MISSING_POSIX 1 */
157 /*#define ADD_MISSING_XOPEN 1 */
159 #if ADD_MISSING_POSIX
160 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
161 #define POSIX1_SYMBOL 2
162 #define POSIX2_SYMBOL 4
163 #else
164 #define POSIX1_SYMBOL 0
165 #define POSIX2_SYMBOL 0
166 #endif
168 #if ADD_MISSING_XOPEN
169 /* Used to mark names defined in X/Open Portability Guide. */
170 #define XOPEN_SYMBOL 8
171 /* Used to mark names defined in X/Open UNIX Extensions. */
172 #define XOPEN_EXTENDED_SYMBOL 16
173 #else
174 #define XOPEN_SYMBOL 0
175 #define XOPEN_EXTENDED_SYMBOL 0
176 #endif
178 /* Used to indicate names that are not functions */
179 #define MACRO_SYMBOL 512
181 struct symbol_list {
182 symbol_flags flags;
183 namelist names;
186 #define SYMBOL_TABLE_SIZE 10
187 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
188 int cur_symbol_table_size;
190 static void add_symbols PARAMS ((symbol_flags, namelist));
191 static struct fn_decl *lookup_std_proto PARAMS ((const char *, int));
192 static void write_lbrac PARAMS ((void));
193 static void recognized_macro PARAMS ((const char *));
194 static void check_macro_names PARAMS ((cpp_reader *, namelist));
195 static void read_scan_file PARAMS ((char *, int, char **));
196 static void write_rbrac PARAMS ((void));
197 static int inf_skip_spaces PARAMS ((int));
198 static int inf_read_upto PARAMS ((sstring *, int));
199 static int inf_scan_ident PARAMS ((sstring *, int));
200 static int check_protection PARAMS ((int *, int *));
202 static void
203 add_symbols (flags, names)
204 symbol_flags flags;
205 namelist names;
207 symbol_table[cur_symbol_table_size].flags = flags;
208 symbol_table[cur_symbol_table_size].names = names;
209 cur_symbol_table_size++;
210 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
211 fatal ("too many calls to add_symbols");
212 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
215 struct std_include_entry {
216 const char *name;
217 symbol_flags flags;
218 namelist names;
221 const char NONE[] = ""; /* The empty namelist. */
223 /* Special name to indicate a continuation line in std_include_table. */
224 const char CONTINUED[] = "";
226 struct std_include_entry *include_entry;
228 struct std_include_entry std_include_table [] = {
229 { "ctype.h", ANSI_SYMBOL,
230 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
231 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
233 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
235 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
237 /* ANSI_SYMBOL is wrong, but ... */
238 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
239 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
240 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
241 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
242 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
244 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
246 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
247 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
249 /*{ "limit.h", ... provided by gcc }, */
251 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
253 { "math.h", ANSI_SYMBOL,
254 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
255 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
256 tan\0tanh\0" },
258 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
260 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
262 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
263 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
265 /* Left out signal() - its prototype is too complex for us!
266 Also left out "sigaction sigaddset sigdelset sigemptyset
267 sigfillset sigismember sigpending sigprocmask sigsuspend"
268 because these need sigset_t or struct sigaction.
269 Most systems that provide them will also declare them. */
270 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
272 { "stdio.h", ANSI_SYMBOL,
273 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
274 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
275 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
276 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
277 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
278 tmpnam\0ungetc\0" },
279 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
280 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
281 /* Should perhaps also handle NULL, EOF, ... ? */
283 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
284 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
285 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
286 Should perhaps also add NULL */
287 { "stdlib.h", ANSI_SYMBOL,
288 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
289 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
290 srand\0strtod\0strtol\0strtoul\0system\0" },
291 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
293 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
294 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
295 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
296 strtok\0strxfrm\0" },
297 /* Should perhaps also add NULL and size_t */
299 { "strings.h", XOPEN_EXTENDED_SYMBOL,
300 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
302 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
304 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
305 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
306 and many systems do have <sys/ioctl.h> but not <strops.h>. */
307 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
309 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
311 { "sys/stat.h", POSIX1_SYMBOL,
312 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
313 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
314 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
315 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
316 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
318 #if 0
319 /* How do we handle fd_set? */
320 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
321 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
322 #endif
324 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
325 /* "sys/types.h" add types (not in old g++-include) */
327 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
329 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
330 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
331 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
332 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
334 { "tar.h", POSIX1_SYMBOL, NONE },
336 { "termios.h", POSIX1_SYMBOL,
337 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
339 { "time.h", ANSI_SYMBOL,
340 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
342 { "unistd.h", POSIX1_SYMBOL,
343 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
344 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
345 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
346 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
347 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
348 ttyname\0unlink\0write\0" },
349 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
350 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
351 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
353 { "utime.h", POSIX1_SYMBOL, "utime\0" },
355 { NULL, 0, NONE }
358 enum special_file special_file_handling = no_special;
360 /* They are set if the corresponding macro has been seen. */
361 /* The following are only used when handling sys/stat.h */
362 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
363 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
364 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
365 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
366 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
367 int seen_S_IFREG = 0, seen_S_ISREG = 0;
368 /* The following are only used when handling errno.h */
369 int seen_errno = 0;
370 /* The following are only used when handling stdlib.h */
371 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
373 #define obstack_chunk_alloc xmalloc
374 #define obstack_chunk_free free
375 struct obstack scan_file_obstack;
377 /* NOTE: If you edit this, also edit gen-protos.c !! */
379 static struct fn_decl *
380 lookup_std_proto (name, name_length)
381 const char *name;
382 int name_length;
384 int i = hashstr (name, name_length) % HASH_SIZE;
385 int i0 = i;
386 for (;;)
388 struct fn_decl *fn;
389 if (hash_tab[i] == 0)
390 return NULL;
391 fn = &std_protos[hash_tab[i]];
392 if ((int) strlen (fn->fname) == name_length
393 && strncmp (fn->fname, name, name_length) == 0)
394 return fn;
395 i = (i+1) % HASH_SIZE;
396 if (i == i0)
397 abort ();
401 char *inc_filename;
402 int inc_filename_length;
403 const char *progname = "fix-header";
404 FILE *outf;
405 sstring line;
407 int lbrac_line, rbrac_line;
409 int required_unseen_count = 0;
410 int required_other = 0;
412 static void
413 write_lbrac ()
416 #if ADD_MISSING_EXTERN_C
417 if (missing_extern_C_count + required_unseen_count > 0)
418 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
419 #endif
421 if (partial_count)
423 fprintf (outf, "#ifndef _PARAMS\n");
424 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
425 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
426 fprintf (outf, "#else\n");
427 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
428 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
432 struct partial_proto
434 struct partial_proto *next;
435 char *fname; /* name of function */
436 char *rtype; /* return type */
437 struct fn_decl *fn;
438 int line_seen;
441 struct partial_proto *partial_proto_list = NULL;
443 struct partial_proto required_dummy_proto, seen_dummy_proto;
444 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
445 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
446 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
447 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
449 static void
450 recognized_macro (fname)
451 const char *fname;
453 /* The original include file defines fname as a macro. */
454 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
456 /* Since fname is a macro, don't require a prototype for it. */
457 if (fn)
459 if (REQUIRED (fn))
460 required_unseen_count--;
461 SET_SEEN (fn);
464 switch (special_file_handling)
466 case errno_h:
467 if (strcmp (fname, "errno") == 0 && !seen_errno)
468 seen_errno = 1, required_other--;
469 break;
470 case stdlib_h:
471 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
472 seen_EXIT_FAILURE = 1, required_other--;
473 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
474 seen_EXIT_SUCCESS = 1, required_other--;
475 break;
476 case sys_stat_h:
477 if (fname[0] == 'S' && fname[1] == '_')
479 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
480 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
481 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
482 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
483 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
484 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
485 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
486 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
487 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
488 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
489 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
490 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
492 break;
494 default:
495 break;
499 void
500 recognized_extern (name, name_length, type, type_length)
501 const char *name;
502 const char *type ATTRIBUTE_UNUSED;
503 int name_length, type_length ATTRIBUTE_UNUSED;
505 switch (special_file_handling)
507 case errno_h:
508 if (name_length == 5 && strncmp (name, "errno", 5) == 0 && !seen_errno)
509 seen_errno = 1, required_other--;
510 break;
512 default:
513 break;
517 /* Called by scan_decls if it saw a function definition for a function
518 named FNAME, with return type RTYPE, and argument list ARGS,
519 in source file FILE_SEEN on line LINE_SEEN.
520 KIND is 'I' for an inline function;
521 'F' if a normal function declaration preceded by 'extern "C"'
522 (or nested inside 'extern "C"' braces); or
523 'f' for other function declarations. */
525 void
526 recognized_function (fname, fname_length,
527 kind, rtype, rtype_length,
528 have_arg_list, file_seen, line_seen)
529 const char *fname;
530 int fname_length;
531 int kind; /* One of 'f' 'F' or 'I' */
532 const char *rtype;
533 int rtype_length;
534 int have_arg_list;
535 const char *file_seen;
536 int line_seen;
538 struct partial_proto *partial;
539 int i;
540 struct fn_decl *fn;
541 #if ADD_MISSING_EXTERN_C
542 if (kind == 'f')
543 missing_extern_C_count++;
544 #endif
546 fn = lookup_std_proto (fname, fname_length);
548 /* Remove the function from the list of required function. */
549 if (fn)
551 if (REQUIRED (fn))
552 required_unseen_count--;
553 SET_SEEN (fn);
556 /* If we have a full prototype, we're done. */
557 if (have_arg_list)
558 return;
560 if (kind == 'I') /* don't edit inline function */
561 return;
563 /* If the partial prototype was included from some other file,
564 we don't need to patch it up (in this run). */
565 i = strlen (file_seen);
566 if (i < inc_filename_length
567 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
568 return;
570 if (fn == NULL)
571 return;
572 if (fn->params[0] == '\0')
573 return;
575 /* We only have a partial function declaration,
576 so remember that we have to add a complete prototype. */
577 partial_count++;
578 partial = (struct partial_proto *)
579 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
580 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
581 bcopy (fname, partial->fname, fname_length);
582 partial->fname[fname_length] = 0;
583 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
584 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
585 partial->line_seen = line_seen;
586 partial->fn = fn;
587 fn->partial = partial;
588 partial->next = partial_proto_list;
589 partial_proto_list = partial;
590 if (verbose)
592 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
593 inc_filename, partial->fname);
597 /* For any name in NAMES that is defined as a macro,
598 call recognized_macro on it. */
600 static void
601 check_macro_names (pfile, names)
602 cpp_reader *pfile;
603 namelist names;
605 while (*names)
607 if (cpp_defined (pfile, names, -1))
608 recognized_macro (names);
609 names += strlen (names) + 1;
613 static void
614 read_scan_file (in_fname, argc, argv)
615 char *in_fname;
616 int argc;
617 char **argv;
619 cpp_reader scan_in;
620 cpp_options scan_options;
621 struct fn_decl *fn;
622 int i;
623 register struct symbol_list *cur_symbols;
625 obstack_init (&scan_file_obstack);
627 cpp_reader_init (&scan_in);
628 scan_in.opts = &scan_options;
629 cpp_options_init (&scan_options);
630 /* We are going to be scanning a header file out of its proper context,
631 so ignore warnings and errors. */
632 scan_options.inhibit_warnings = 1;
633 scan_options.inhibit_errors = 1;
634 scan_options.no_line_commands = 1;
635 i = cpp_handle_options (&scan_in, argc, argv);
636 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
637 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
638 if (CPP_FATAL_ERRORS (&scan_in))
639 exit (FATAL_EXIT_CODE);
641 if (! cpp_start_read (&scan_in, in_fname))
642 exit (FATAL_EXIT_CODE);
644 scan_decls (&scan_in, argc, argv);
645 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
646 check_macro_names (&scan_in, cur_symbols->names);
648 if (verbose && (scan_in.errors + warnings) > 0)
649 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
650 inc_filename, scan_in.errors, warnings);
651 if (scan_in.errors)
652 exit (SUCCESS_EXIT_CODE);
654 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
655 If so, those functions are also required. */
656 if (special_file_handling == stdio_h
657 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
659 static char getchar_call[] = "getchar();";
660 cpp_buffer *buf
661 = cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
662 int old_written = CPP_WRITTEN (&scan_in);
663 int seen_filbuf = 0;
665 /* Scan the macro expansion of "getchar();". */
666 for (;;)
668 enum cpp_token token = cpp_get_token (&scan_in);
669 int length = CPP_WRITTEN (&scan_in) - old_written;
670 CPP_SET_WRITTEN (&scan_in, old_written);
671 if (token == CPP_EOF) /* Should not happen ... */
672 break;
673 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
675 cpp_pop_buffer (&scan_in);
676 break;
678 if (token == CPP_NAME && length == 7
679 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
680 seen_filbuf++;
682 if (seen_filbuf)
684 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
685 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
686 int need_flsbuf
687 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
689 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
690 if (need_filbuf + need_flsbuf)
692 const char *new_list;
693 if (need_filbuf)
694 SET_REQUIRED (fn);
695 if (need_flsbuf)
696 SET_REQUIRED (flsbuf_fn);
697 if (need_flsbuf + need_filbuf == 2)
698 new_list = "_filbuf\0_flsbuf\0";
699 else if (need_flsbuf)
700 new_list = "_flsbuf\0";
701 else /* if (need_flsbuf) */
702 new_list = "_filbuf\0";
703 add_symbols (ANSI_SYMBOL, new_list);
704 required_unseen_count += need_filbuf + need_flsbuf;
709 if (required_unseen_count + partial_count + required_other
710 #if ADD_MISSING_EXTERN_C
711 + missing_extern_C_count
712 #endif
713 == 0)
715 if (verbose)
716 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
717 exit (SUCCESS_EXIT_CODE);
719 if (!verbose)
720 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
721 else
723 if (required_unseen_count)
724 fprintf (stderr, "%s: %d missing function declarations.\n",
725 inc_filename, required_unseen_count);
726 if (partial_count)
727 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
728 inc_filename, partial_count);
729 #if ADD_MISSING_EXTERN_C
730 if (missing_extern_C_count)
731 fprintf (stderr,
732 "%s: %d declarations not protected by extern \"C\".\n",
733 inc_filename, missing_extern_C_count);
734 #endif
738 static void
739 write_rbrac ()
741 struct fn_decl *fn;
742 const char *cptr;
743 register struct symbol_list *cur_symbols;
745 if (required_unseen_count)
747 #ifdef NO_IMPLICIT_EXTERN_C
748 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
749 #endif
752 /* Now we print out prototypes for those functions that we haven't seen. */
753 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
755 int if_was_emitted = 0;
756 int name_len;
757 cptr = cur_symbols->names;
758 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
760 int macro_protect = 0;
762 if (cur_symbols->flags & MACRO_SYMBOL)
763 continue;
765 fn = lookup_std_proto (cptr, name_len);
766 if (fn == NULL || !REQUIRED (fn))
767 continue;
769 if (!if_was_emitted)
771 /* what about curses. ??? or _flsbuf/_filbuf ??? */
772 if (cur_symbols->flags & ANSI_SYMBOL)
773 fprintf (outf,
774 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
775 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
776 fprintf (outf,
777 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
778 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
779 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
780 else if (cur_symbols->flags & XOPEN_SYMBOL)
782 fprintf (outf,
783 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
784 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
786 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
788 fprintf (outf,
789 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
790 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
792 else
794 fatal ("internal error for function %s", fn->fname);
796 if_was_emitted = 1;
799 /* In the case of memmove, protect in case the application
800 defines it as a macro before including the header. */
801 if (!strcmp (fn->fname, "memmove")
802 || !strcmp (fn->fname, "vprintf")
803 || !strcmp (fn->fname, "vfprintf")
804 || !strcmp (fn->fname, "vsprintf")
805 || !strcmp (fn->fname, "rewinddir")
806 || !strcmp (fn->fname, "abort"))
807 macro_protect = 1;
809 if (macro_protect)
810 fprintf (outf, "#ifndef %s\n", fn->fname);
811 fprintf (outf, "extern %s %s (%s);\n",
812 fn->rtype, fn->fname, fn->params);
813 if (macro_protect)
814 fprintf (outf, "#endif\n");
816 if (if_was_emitted)
817 fprintf (outf,
818 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
820 if (required_unseen_count)
822 #ifdef NO_IMPLICIT_EXTERN_C
823 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
824 #endif
827 switch (special_file_handling)
829 case errno_h:
830 if (!seen_errno)
831 fprintf (outf, "extern int errno;\n");
832 break;
833 case stdlib_h:
834 if (!seen_EXIT_FAILURE)
835 fprintf (outf, "#define EXIT_FAILURE 1\n");
836 if (!seen_EXIT_SUCCESS)
837 fprintf (outf, "#define EXIT_SUCCESS 0\n");
838 break;
839 case sys_stat_h:
840 if (!seen_S_ISBLK && seen_S_IFBLK)
841 fprintf (outf,
842 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
843 if (!seen_S_ISCHR && seen_S_IFCHR)
844 fprintf (outf,
845 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
846 if (!seen_S_ISDIR && seen_S_IFDIR)
847 fprintf (outf,
848 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
849 if (!seen_S_ISFIFO && seen_S_IFIFO)
850 fprintf (outf,
851 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
852 if (!seen_S_ISLNK && seen_S_IFLNK)
853 fprintf (outf,
854 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
855 if (!seen_S_ISREG && seen_S_IFREG)
856 fprintf (outf,
857 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
858 break;
860 default:
861 break;
865 #if ADD_MISSING_EXTERN_C
866 if (missing_extern_C_count + required_unseen_count > 0)
867 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
868 #endif
871 /* Returns 1 iff the file is properly protected from multiple inclusion:
872 #ifndef PROTECT_NAME
873 #define PROTECT_NAME
874 #endif
878 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
879 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
881 static int
882 inf_skip_spaces (c)
883 int c;
885 for (;;)
887 if (c == ' ' || c == '\t')
888 c = INF_GET ();
889 else if (c == '/')
891 c = INF_GET ();
892 if (c != '*')
894 (void) INF_UNGET (c);
895 return '/';
897 c = INF_GET ();
898 for (;;)
900 if (c == EOF)
901 return EOF;
902 else if (c != '*')
904 if (c == '\n')
905 source_lineno++, lineno++;
906 c = INF_GET ();
908 else if ((c = INF_GET ()) == '/')
909 return INF_GET ();
912 else
913 break;
915 return c;
918 /* Read into STR from inf_buffer upto DELIM. */
920 static int
921 inf_read_upto (str, delim)
922 sstring *str;
923 int delim;
925 int ch;
926 for (;;)
928 ch = INF_GET ();
929 if (ch == EOF || ch == delim)
930 break;
931 SSTRING_PUT (str, ch);
933 MAKE_SSTRING_SPACE (str, 1);
934 *str->ptr = 0;
935 return ch;
938 static int
939 inf_scan_ident (s, c)
940 register sstring *s;
941 int c;
943 s->ptr = s->base;
944 if (ISALPHA (c) || c == '_')
946 for (;;)
948 SSTRING_PUT (s, c);
949 c = INF_GET ();
950 if (c == EOF || !(ISALNUM (c) || c == '_'))
951 break;
954 MAKE_SSTRING_SPACE (s, 1);
955 *s->ptr = 0;
956 return c;
959 /* Returns 1 if the file is correctly protected against multiple
960 inclusion, setting *ifndef_line to the line number of the initial #ifndef
961 and setting *endif_line to the final #endif.
962 Otherwise return 0. */
964 static int
965 check_protection (ifndef_line, endif_line)
966 int *ifndef_line, *endif_line;
968 int c;
969 int if_nesting = 1; /* Level of nesting of #if's */
970 char *protect_name = NULL; /* Identifier following initial #ifndef */
971 int define_seen = 0;
973 /* Skip initial white space (including comments). */
974 for (;; lineno++)
976 c = inf_skip_spaces (' ');
977 if (c == EOF)
978 return 0;
979 if (c != '\n')
980 break;
982 if (c != '#')
983 return 0;
984 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
985 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
986 return 0;
988 /* So far so good: We've seen an initial #ifndef. */
989 *ifndef_line = lineno;
990 c = inf_scan_ident (&buf, inf_skip_spaces (c));
991 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
992 return 0;
993 protect_name = xstrdup (buf.base);
995 (void) INF_UNGET (c);
996 c = inf_read_upto (&buf, '\n');
997 if (c == EOF)
998 return 0;
999 lineno++;
1001 for (;;)
1003 c = inf_skip_spaces (' ');
1004 if (c == EOF)
1005 return 0;
1006 if (c == '\n')
1008 lineno++;
1009 continue;
1011 if (c != '#')
1012 goto skip_to_eol;
1013 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1014 if (SSTRING_LENGTH (&buf) == 0)
1016 else if (!strcmp (buf.base, "ifndef")
1017 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1019 if_nesting++;
1021 else if (!strcmp (buf.base, "endif"))
1023 if_nesting--;
1024 if (if_nesting == 0)
1025 break;
1027 else if (!strcmp (buf.base, "else"))
1029 if (if_nesting == 1)
1030 return 0;
1032 else if (!strcmp (buf.base, "define"))
1034 if (if_nesting != 1)
1035 goto skip_to_eol;
1036 c = inf_skip_spaces (c);
1037 c = inf_scan_ident (&buf, c);
1038 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1039 define_seen = 1;
1041 skip_to_eol:
1042 for (;;)
1044 if (c == '\n' || c == EOF)
1045 break;
1046 c = INF_GET ();
1048 if (c == EOF)
1049 return 0;
1050 lineno++;
1053 if (!define_seen)
1054 return 0;
1055 *endif_line = lineno;
1056 /* Skip final white space (including comments). */
1057 for (;;)
1059 c = inf_skip_spaces (' ');
1060 if (c == EOF)
1061 break;
1062 if (c != '\n')
1063 return 0;
1066 return 1;
1069 extern int main PARAMS ((int, char **));
1072 main (argc, argv)
1073 int argc;
1074 char **argv;
1076 int inf_fd;
1077 struct stat sbuf;
1078 int c;
1079 #ifdef FIXPROTO_IGNORE_LIST
1080 int i;
1081 #endif
1082 const char *cptr;
1083 int ifndef_line;
1084 int endif_line;
1085 long to_read;
1086 long int inf_size;
1087 register struct symbol_list *cur_symbols;
1089 if (argv[0] && argv[0][0])
1091 register char *p;
1093 progname = 0;
1094 for (p = argv[0]; *p; p++)
1095 if (*p == '/')
1096 progname = p;
1097 progname = progname ? progname+1 : argv[0];
1100 if (argc < 4)
1102 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1103 progname);
1104 exit (FATAL_EXIT_CODE);
1107 inc_filename = argv[1];
1108 inc_filename_length = strlen (inc_filename);
1110 #ifdef FIXPROTO_IGNORE_LIST
1111 for (i = 0; files_to_ignore[i] != NULL; i++)
1113 char *ignore_name = files_to_ignore[i];
1114 int ignore_len = strlen (ignore_name);
1115 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1117 if (ignore_name[ignore_len-1] == '/'
1118 || inc_filename[ignore_len] == '\0')
1120 if (verbose)
1121 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1122 exit (SUCCESS_EXIT_CODE);
1127 #endif
1129 if (strcmp (inc_filename, "sys/stat.h") == 0)
1130 special_file_handling = sys_stat_h;
1131 else if (strcmp (inc_filename, "errno.h") == 0)
1132 special_file_handling = errno_h, required_other++;
1133 else if (strcmp (inc_filename, "stdlib.h") == 0)
1134 special_file_handling = stdlib_h, required_other+=2;
1135 else if (strcmp (inc_filename, "stdio.h") == 0)
1136 special_file_handling = stdio_h;
1137 include_entry = std_include_table;
1138 while (include_entry->name != NULL
1139 && ((strcmp (include_entry->name, CONTINUED) == 0)
1140 || strcmp (inc_filename, include_entry->name) != 0))
1141 include_entry++;
1143 if (include_entry->name != NULL)
1145 struct std_include_entry *entry;
1146 cur_symbol_table_size = 0;
1147 for (entry = include_entry; ;)
1149 if (entry->flags)
1150 add_symbols (entry->flags, entry->names);
1151 entry++;
1152 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1153 break;
1156 else
1157 symbol_table[0].names = NULL;
1159 /* Count and mark the prototypes required for this include file. */
1160 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1162 int name_len;
1163 if (cur_symbols->flags & MACRO_SYMBOL)
1164 continue;
1165 cptr = cur_symbols->names;
1166 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1168 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1169 required_unseen_count++;
1170 if (fn == NULL)
1171 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1172 else
1173 SET_REQUIRED (fn);
1177 read_scan_file (argv[2], argc - 4, argv + 4);
1179 inf_fd = open (argv[2], O_RDONLY, 0666);
1180 if (inf_fd < 0)
1182 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1183 progname, argv[2]);
1184 perror (NULL);
1185 exit (FATAL_EXIT_CODE);
1187 if (fstat (inf_fd, &sbuf) < 0)
1189 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1190 perror (NULL);
1191 exit (FATAL_EXIT_CODE);
1193 inf_size = sbuf.st_size;
1194 inf_buffer = (char *) xmalloc (inf_size + 2);
1195 inf_buffer[inf_size] = '\n';
1196 inf_buffer[inf_size + 1] = '\0';
1197 inf_limit = inf_buffer + inf_size;
1198 inf_ptr = inf_buffer;
1200 to_read = inf_size;
1201 while (to_read > 0)
1203 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1204 if (i < 0)
1206 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1207 perror (NULL);
1208 exit (FATAL_EXIT_CODE);
1210 if (i == 0)
1212 inf_size -= to_read;
1213 break;
1215 to_read -= i;
1218 close (inf_fd);
1220 /* If file doesn't end with '\n', add one. */
1221 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1222 inf_limit++;
1224 unlink (argv[3]);
1225 outf = fopen (argv[3], "w");
1226 if (outf == NULL)
1228 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1229 progname, argv[3]);
1230 perror (NULL);
1231 exit (FATAL_EXIT_CODE);
1234 lineno = 1;
1236 if (check_protection (&ifndef_line, &endif_line))
1238 lbrac_line = ifndef_line+1;
1239 rbrac_line = endif_line;
1241 else
1243 lbrac_line = 1;
1244 rbrac_line = -1;
1247 /* Reset input file. */
1248 inf_ptr = inf_buffer;
1249 lineno = 1;
1251 for (;;)
1253 if (lineno == lbrac_line)
1254 write_lbrac ();
1255 if (lineno == rbrac_line)
1256 write_rbrac ();
1257 for (;;)
1259 struct fn_decl *fn;
1260 c = INF_GET ();
1261 if (c == EOF)
1262 break;
1263 if (ISALPHA (c) || c == '_')
1265 c = inf_scan_ident (&buf, c);
1266 (void) INF_UNGET (c);
1267 fputs (buf.base, outf);
1268 fn = lookup_std_proto (buf.base, strlen (buf.base));
1269 /* We only want to edit the declaration matching the one
1270 seen by scan-decls, as there can be multiple
1271 declarations, selected by #ifdef __STDC__ or whatever. */
1272 if (fn && fn->partial && fn->partial->line_seen == lineno)
1274 c = inf_skip_spaces (' ');
1275 if (c == EOF)
1276 break;
1277 if (c == '(')
1279 c = inf_skip_spaces (' ');
1280 if (c == ')')
1282 fprintf (outf, " _PARAMS((%s))", fn->params);
1284 else
1286 putc ('(', outf);
1287 (void) INF_UNGET (c);
1290 else
1291 fprintf (outf, " %c", c);
1294 else
1296 putc (c, outf);
1297 if (c == '\n')
1298 break;
1301 if (c == EOF)
1302 break;
1303 lineno++;
1305 if (rbrac_line < 0)
1306 write_rbrac ();
1308 fclose (outf);
1310 return 0;
1314 static void
1315 v_fatal (str, ap)
1316 const char * str;
1317 va_list ap;
1319 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1320 vfprintf (stderr, str, ap);
1321 fprintf (stderr, "\n");
1323 exit (FATAL_EXIT_CODE);
1326 static void
1327 fatal VPARAMS ((const char *str, ...))
1329 #ifndef ANSI_PROTOTYPES
1330 const char *str;
1331 #endif
1332 va_list ap;
1334 VA_START(ap, str);
1336 #ifndef ANSI_PROTOTYPES
1337 str = va_arg (ap, const char *);
1338 #endif
1340 v_fatal(str, ap);
1341 va_end(ap);