2003-06-19 Aldy Hernandez <aldyh@redhat.com>
[official-gcc.git] / gcc / fix-header.c
blob6f486dea2164ec08af63df19fa78341614884f63
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003 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 can be -D or -I switches as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
74 #include "bconfig.h"
75 #include "system.h"
76 #include "coretypes.h"
77 #include "tm.h"
78 #include "obstack.h"
79 #include "scan.h"
80 #include "cpplib.h"
81 #include "c-incpath.h"
83 static void v_fatal PARAMS ((const char *, va_list)) ATTRIBUTE_PRINTF (1,0) ATTRIBUTE_NORETURN;
84 static void fatal PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
86 sstring buf;
88 int verbose = 0;
89 int partial_count = 0;
90 int warnings = 0;
92 #if ADD_MISSING_EXTERN_C
93 int missing_extern_C_count = 0;
94 #endif
96 #include "xsys-protos.h"
98 #ifdef FIXPROTO_IGNORE_LIST
99 /* This is a currently unused feature. */
101 /* List of files and directories to ignore.
102 A directory name (ending in '/') means ignore anything in that
103 directory. (It might be more efficient to do directory pruning
104 earlier in fixproto, but this is simpler and easier to customize.) */
106 static const char *const files_to_ignore[] = {
107 "X11/",
108 FIXPROTO_IGNORE_LIST
111 #endif
113 char *inf_buffer;
114 char *inf_limit;
115 char *inf_ptr;
116 static const char *cur_file;
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 *));
201 static void cb_file_change PARAMS ((cpp_reader *, const struct line_map *));
203 static void
204 add_symbols (flags, names)
205 symbol_flags flags;
206 namelist names;
208 symbol_table[cur_symbol_table_size].flags = flags;
209 symbol_table[cur_symbol_table_size].names = names;
210 cur_symbol_table_size++;
211 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
212 fatal ("too many calls to add_symbols");
213 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
216 struct std_include_entry {
217 const char *const name;
218 const symbol_flags flags;
219 const namelist names;
222 const char NONE[] = ""; /* The empty namelist. */
224 /* Special name to indicate a continuation line in std_include_table. */
225 const char CONTINUED[] = "";
227 const struct std_include_entry *include_entry;
229 const struct std_include_entry std_include_table [] = {
230 { "ctype.h", ANSI_SYMBOL,
231 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
232 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
234 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
236 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
238 /* ANSI_SYMBOL is wrong, but ... */
239 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
240 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
241 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
242 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
243 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
245 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
247 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
248 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
250 /*{ "limit.h", ... provided by gcc }, */
252 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
254 { "math.h", ANSI_SYMBOL,
255 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
256 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
257 tan\0tanh\0" },
259 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
261 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
263 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
264 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
266 /* Left out signal() - its prototype is too complex for us!
267 Also left out "sigaction sigaddset sigdelset sigemptyset
268 sigfillset sigismember sigpending sigprocmask sigsuspend"
269 because these need sigset_t or struct sigaction.
270 Most systems that provide them will also declare them. */
271 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
273 { "stdio.h", ANSI_SYMBOL,
274 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
275 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
276 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
277 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
278 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
279 tmpnam\0ungetc\0" },
280 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
281 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
282 /* Should perhaps also handle NULL, EOF, ... ? */
284 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
285 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
286 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
287 Should perhaps also add NULL */
288 { "stdlib.h", ANSI_SYMBOL,
289 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
290 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
291 srand\0strtod\0strtol\0strtoul\0system\0" },
292 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
294 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
295 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
296 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
297 strtok\0strxfrm\0" },
298 /* Should perhaps also add NULL and size_t */
300 { "strings.h", XOPEN_EXTENDED_SYMBOL,
301 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
303 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
305 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
306 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
307 and many systems do have <sys/ioctl.h> but not <strops.h>. */
308 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
310 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
312 { "sys/stat.h", POSIX1_SYMBOL,
313 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
314 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
315 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
316 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
317 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
319 #if 0
320 /* How do we handle fd_set? */
321 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
322 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
323 #endif
325 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
326 /* "sys/types.h" add types (not in old g++-include) */
328 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
330 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
331 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
332 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
333 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
335 { "tar.h", POSIX1_SYMBOL, NONE },
337 { "termios.h", POSIX1_SYMBOL,
338 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
340 { "time.h", ANSI_SYMBOL,
341 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
343 { "unistd.h", POSIX1_SYMBOL,
344 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
345 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
346 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
347 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
348 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
349 ttyname\0unlink\0write\0" },
350 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
351 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
352 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
354 { "utime.h", POSIX1_SYMBOL, "utime\0" },
356 { NULL, 0, NONE }
359 enum special_file special_file_handling = no_special;
361 /* They are set if the corresponding macro has been seen. */
362 /* The following are only used when handling sys/stat.h */
363 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
364 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
365 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
366 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
367 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
368 int seen_S_IFREG = 0, seen_S_ISREG = 0;
369 /* The following are only used when handling errno.h */
370 int seen_errno = 0;
371 /* The following are only used when handling stdlib.h */
372 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
374 struct obstack scan_file_obstack;
376 /* NOTE: If you edit this, also edit gen-protos.c !! */
378 static struct fn_decl *
379 lookup_std_proto (name, name_length)
380 const char *name;
381 int name_length;
383 int i = hashstr (name, name_length) % HASH_SIZE;
384 int i0 = i;
385 for (;;)
387 struct fn_decl *fn;
388 if (hash_tab[i] == 0)
389 return NULL;
390 fn = &std_protos[hash_tab[i]];
391 if ((int) strlen (fn->fname) == name_length
392 && strncmp (fn->fname, name, name_length) == 0)
393 return fn;
394 i = (i+1) % HASH_SIZE;
395 if (i == i0)
396 abort ();
400 char *inc_filename;
401 int inc_filename_length;
402 const char *progname = "fix-header";
403 FILE *outf;
404 sstring line;
406 int lbrac_line, rbrac_line;
408 int required_unseen_count = 0;
409 int required_other = 0;
411 static void
412 write_lbrac ()
414 if (partial_count)
416 fprintf (outf, "#ifndef _PARAMS\n");
417 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
418 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
419 fprintf (outf, "#else\n");
420 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
421 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
425 struct partial_proto
427 struct partial_proto *next;
428 struct fn_decl *fn;
429 int line_seen;
432 struct partial_proto *partial_proto_list = NULL;
434 struct partial_proto required_dummy_proto, seen_dummy_proto;
435 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
436 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
437 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
438 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
440 static void
441 recognized_macro (fname)
442 const char *fname;
444 /* The original include file defines fname as a macro. */
445 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
447 /* Since fname is a macro, don't require a prototype for it. */
448 if (fn)
450 if (REQUIRED (fn))
451 required_unseen_count--;
452 SET_SEEN (fn);
455 switch (special_file_handling)
457 case errno_h:
458 if (strcmp (fname, "errno") == 0 && !seen_errno)
459 seen_errno = 1, required_other--;
460 break;
461 case stdlib_h:
462 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
463 seen_EXIT_FAILURE = 1, required_other--;
464 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
465 seen_EXIT_SUCCESS = 1, required_other--;
466 break;
467 case sys_stat_h:
468 if (fname[0] == 'S' && fname[1] == '_')
470 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
471 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
472 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
473 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
474 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
475 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
476 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
477 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
478 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
479 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
480 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
481 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
483 break;
485 default:
486 break;
490 void
491 recognized_extern (name)
492 const cpp_token *name;
494 switch (special_file_handling)
496 case errno_h:
497 if (cpp_ideq (name, "errno"))
498 seen_errno = 1, required_other--;
499 break;
501 default:
502 break;
506 /* Called by scan_decls if it saw a function definition for a function
507 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
508 function declaration preceded by 'extern "C"' (or nested inside
509 'extern "C"' braces); or 'f' for other function declarations. */
511 void
512 recognized_function (fname, line, kind, have_arg_list)
513 const cpp_token *fname;
514 unsigned int line;
515 int kind; /* One of 'f' 'F' or 'I' */
516 int have_arg_list;
518 struct partial_proto *partial;
519 int i;
520 struct fn_decl *fn;
522 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
523 NODE_LEN (fname->val.node));
525 /* Remove the function from the list of required function. */
526 if (fn)
528 if (REQUIRED (fn))
529 required_unseen_count--;
530 SET_SEEN (fn);
533 /* If we have a full prototype, we're done. */
534 if (have_arg_list)
535 return;
537 if (kind == 'I') /* don't edit inline function */
538 return;
540 /* If the partial prototype was included from some other file,
541 we don't need to patch it up (in this run). */
542 i = strlen (cur_file);
543 if (i < inc_filename_length
544 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
545 return;
547 if (fn == NULL)
548 return;
549 if (fn->params[0] == '\0')
550 return;
552 /* We only have a partial function declaration,
553 so remember that we have to add a complete prototype. */
554 partial_count++;
555 partial = (struct partial_proto *)
556 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
557 partial->line_seen = line;
558 partial->fn = fn;
559 fn->partial = partial;
560 partial->next = partial_proto_list;
561 partial_proto_list = partial;
562 if (verbose)
564 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
565 inc_filename, fn->fname);
569 /* For any name in NAMES that is defined as a macro,
570 call recognized_macro on it. */
572 static void
573 check_macro_names (pfile, names)
574 cpp_reader *pfile;
575 namelist names;
577 size_t len;
578 while (*names)
580 len = strlen (names);
581 if (cpp_defined (pfile, (const unsigned char *)names, len))
582 recognized_macro (names);
583 names += len + 1;
587 static void
588 cb_file_change (pfile, map)
589 cpp_reader *pfile ATTRIBUTE_UNUSED;
590 const struct line_map *map;
592 /* Just keep track of current file name. */
593 cur_file = map->to_file;
596 static void
597 read_scan_file (in_fname, argc, argv)
598 char *in_fname;
599 int argc;
600 char **argv;
602 cpp_reader *scan_in;
603 cpp_callbacks *cb;
604 cpp_options *options;
605 struct fn_decl *fn;
606 int i, strings_processed;
607 struct symbol_list *cur_symbols;
609 obstack_init (&scan_file_obstack);
611 scan_in = cpp_create_reader (CLK_GNUC89, NULL);
612 cb = cpp_get_callbacks (scan_in);
613 cb->file_change = cb_file_change;
615 /* We are going to be scanning a header file out of its proper context,
616 so ignore warnings and errors. */
617 options = cpp_get_options (scan_in);
618 options->inhibit_warnings = 1;
619 options->inhibit_errors = 1;
621 if (! cpp_read_main_file (scan_in, in_fname))
622 exit (FATAL_EXIT_CODE);
624 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
625 cpp_init_builtins (scan_in, true);
626 cpp_change_file (scan_in, LC_RENAME, in_fname);
628 /* Process switches after builtins so -D can override them. */
629 for (i = 0; i < argc; i += strings_processed)
631 strings_processed = 0;
632 if (argv[i][0] == '-')
634 if (argv[i][1] == 'I')
636 if (argv[i][2] != '\0')
638 strings_processed = 1;
639 add_path (xstrdup (argv[i] + 2), BRACKET, false);
641 else if (i + 1 != argc)
643 strings_processed = 2;
644 add_path (xstrdup (argv[i + 1]), BRACKET, false);
647 else if (argv[i][1] == 'D')
649 if (argv[i][2] != '\0')
650 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
651 else if (i + 1 != argc)
652 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
656 if (strings_processed == 0)
657 break;
660 if (i < argc)
661 cpp_error (scan_in, DL_ERROR, "invalid option `%s'", argv[i]);
662 if (cpp_errors (scan_in))
663 exit (FATAL_EXIT_CODE);
665 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
666 true /* stdinc */, false /* cxx_stdinc */,
667 false /* verbose */);
669 /* We are scanning a system header, so mark it as such. */
670 cpp_make_system_header (scan_in, 1, 0);
672 scan_decls (scan_in, argc, argv);
673 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
674 check_macro_names (scan_in, cur_symbols->names);
676 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
677 If so, those functions are also required. */
678 if (special_file_handling == stdio_h
679 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
681 unsigned char getchar_call[] = "getchar();\n";
682 int seen_filbuf = 0;
684 /* Scan the macro expansion of "getchar();". */
685 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
686 /* from_stage3 */ true, 1);
687 for (;;)
689 const cpp_token *t = cpp_get_token (scan_in);
691 if (t->type == CPP_EOF)
692 break;
693 else if (cpp_ideq (t, "_filbuf"))
694 seen_filbuf++;
697 if (seen_filbuf)
699 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
700 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
701 int need_flsbuf
702 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
704 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
705 if (need_filbuf + need_flsbuf)
707 const char *new_list;
708 if (need_filbuf)
709 SET_REQUIRED (fn);
710 if (need_flsbuf)
711 SET_REQUIRED (flsbuf_fn);
712 if (need_flsbuf && need_filbuf)
713 new_list = "_filbuf\0_flsbuf\0";
714 else if (need_flsbuf)
715 new_list = "_flsbuf\0";
716 else /* if (need_flsbuf) */
717 new_list = "_filbuf\0";
718 add_symbols (ANSI_SYMBOL, new_list);
719 required_unseen_count += need_filbuf + need_flsbuf;
724 if (required_unseen_count + partial_count + required_other == 0)
726 if (verbose)
727 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
728 exit (SUCCESS_EXIT_CODE);
730 if (!verbose)
731 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
732 else
734 if (required_unseen_count)
735 fprintf (stderr, "%s: %d missing function declarations.\n",
736 inc_filename, required_unseen_count);
737 if (partial_count)
738 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
739 inc_filename, partial_count);
743 static void
744 write_rbrac ()
746 struct fn_decl *fn;
747 const char *cptr;
748 struct symbol_list *cur_symbols;
750 if (required_unseen_count)
752 #ifdef NO_IMPLICIT_EXTERN_C
753 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
754 #endif
757 /* Now we print out prototypes for those functions that we haven't seen. */
758 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
760 int if_was_emitted = 0;
761 int name_len;
762 cptr = cur_symbols->names;
763 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
765 int macro_protect = 0;
767 if (cur_symbols->flags & MACRO_SYMBOL)
768 continue;
770 fn = lookup_std_proto (cptr, name_len);
771 if (fn == NULL || !REQUIRED (fn))
772 continue;
774 if (!if_was_emitted)
776 /* what about curses. ??? or _flsbuf/_filbuf ??? */
777 if (cur_symbols->flags & ANSI_SYMBOL)
778 fprintf (outf,
779 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
780 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
781 fprintf (outf,
782 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
783 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
784 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
785 else if (cur_symbols->flags & XOPEN_SYMBOL)
787 fprintf (outf,
788 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
789 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
791 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
793 fprintf (outf,
794 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
795 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
797 else
799 fatal ("internal error for function %s", fn->fname);
801 if_was_emitted = 1;
804 /* In the case of memmove, protect in case the application
805 defines it as a macro before including the header. */
806 if (!strcmp (fn->fname, "memmove")
807 || !strcmp (fn->fname, "putc")
808 || !strcmp (fn->fname, "getc")
809 || !strcmp (fn->fname, "vprintf")
810 || !strcmp (fn->fname, "vfprintf")
811 || !strcmp (fn->fname, "vsprintf")
812 || !strcmp (fn->fname, "rewinddir")
813 || !strcmp (fn->fname, "abort"))
814 macro_protect = 1;
816 if (macro_protect)
817 fprintf (outf, "#ifndef %s\n", fn->fname);
818 fprintf (outf, "extern %s %s (%s);\n",
819 fn->rtype, fn->fname, fn->params);
820 if (macro_protect)
821 fprintf (outf, "#endif\n");
823 if (if_was_emitted)
824 fprintf (outf,
825 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
827 if (required_unseen_count)
829 #ifdef NO_IMPLICIT_EXTERN_C
830 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
831 #endif
834 switch (special_file_handling)
836 case errno_h:
837 if (!seen_errno)
838 fprintf (outf, "extern int errno;\n");
839 break;
840 case stdlib_h:
841 if (!seen_EXIT_FAILURE)
842 fprintf (outf, "#define EXIT_FAILURE 1\n");
843 if (!seen_EXIT_SUCCESS)
844 fprintf (outf, "#define EXIT_SUCCESS 0\n");
845 break;
846 case sys_stat_h:
847 if (!seen_S_ISBLK && seen_S_IFBLK)
848 fprintf (outf,
849 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
850 if (!seen_S_ISCHR && seen_S_IFCHR)
851 fprintf (outf,
852 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
853 if (!seen_S_ISDIR && seen_S_IFDIR)
854 fprintf (outf,
855 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
856 if (!seen_S_ISFIFO && seen_S_IFIFO)
857 fprintf (outf,
858 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
859 if (!seen_S_ISLNK && seen_S_IFLNK)
860 fprintf (outf,
861 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
862 if (!seen_S_ISREG && seen_S_IFREG)
863 fprintf (outf,
864 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
865 break;
867 default:
868 break;
873 /* Returns 1 iff the file is properly protected from multiple inclusion:
874 #ifndef PROTECT_NAME
875 #define PROTECT_NAME
876 #endif
880 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
881 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
883 static int
884 inf_skip_spaces (c)
885 int c;
887 for (;;)
889 if (c == ' ' || c == '\t')
890 c = INF_GET ();
891 else if (c == '/')
893 c = INF_GET ();
894 if (c != '*')
896 (void) INF_UNGET (c);
897 return '/';
899 c = INF_GET ();
900 for (;;)
902 if (c == EOF)
903 return EOF;
904 else if (c != '*')
906 if (c == '\n')
907 source_lineno++, lineno++;
908 c = INF_GET ();
910 else if ((c = INF_GET ()) == '/')
911 return INF_GET ();
914 else
915 break;
917 return c;
920 /* Read into STR from inf_buffer upto DELIM. */
922 static int
923 inf_read_upto (str, delim)
924 sstring *str;
925 int delim;
927 int ch;
928 for (;;)
930 ch = INF_GET ();
931 if (ch == EOF || ch == delim)
932 break;
933 SSTRING_PUT (str, ch);
935 MAKE_SSTRING_SPACE (str, 1);
936 *str->ptr = 0;
937 return ch;
940 static int
941 inf_scan_ident (s, c)
942 sstring *s;
943 int c;
945 s->ptr = s->base;
946 if (ISIDST (c))
948 for (;;)
950 SSTRING_PUT (s, c);
951 c = INF_GET ();
952 if (c == EOF || !(ISIDNUM (c)))
953 break;
956 MAKE_SSTRING_SPACE (s, 1);
957 *s->ptr = 0;
958 return c;
961 /* Returns 1 if the file is correctly protected against multiple
962 inclusion, setting *ifndef_line to the line number of the initial #ifndef
963 and setting *endif_line to the final #endif.
964 Otherwise return 0. */
966 static int
967 check_protection (ifndef_line, endif_line)
968 int *ifndef_line, *endif_line;
970 int c;
971 int if_nesting = 1; /* Level of nesting of #if's */
972 char *protect_name = NULL; /* Identifier following initial #ifndef */
973 int define_seen = 0;
975 /* Skip initial white space (including comments). */
976 for (;; lineno++)
978 c = inf_skip_spaces (' ');
979 if (c == EOF)
980 return 0;
981 if (c != '\n')
982 break;
984 if (c != '#')
985 return 0;
986 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
987 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
988 return 0;
990 /* So far so good: We've seen an initial #ifndef. */
991 *ifndef_line = lineno;
992 c = inf_scan_ident (&buf, inf_skip_spaces (c));
993 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
994 return 0;
995 protect_name = xstrdup (buf.base);
997 (void) INF_UNGET (c);
998 c = inf_read_upto (&buf, '\n');
999 if (c == EOF)
1000 return 0;
1001 lineno++;
1003 for (;;)
1005 c = inf_skip_spaces (' ');
1006 if (c == EOF)
1007 return 0;
1008 if (c == '\n')
1010 lineno++;
1011 continue;
1013 if (c != '#')
1014 goto skip_to_eol;
1015 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1016 if (SSTRING_LENGTH (&buf) == 0)
1018 else if (!strcmp (buf.base, "ifndef")
1019 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1021 if_nesting++;
1023 else if (!strcmp (buf.base, "endif"))
1025 if_nesting--;
1026 if (if_nesting == 0)
1027 break;
1029 else if (!strcmp (buf.base, "else"))
1031 if (if_nesting == 1)
1032 return 0;
1034 else if (!strcmp (buf.base, "define"))
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 struct symbol_list *cur_symbols;
1089 if (argv[0] && argv[0][0])
1091 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 const char *const 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 const 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_ptr = inf_buffer;
1197 to_read = inf_size;
1198 while (to_read > 0)
1200 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1201 if (i < 0)
1203 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1204 perror (NULL);
1205 exit (FATAL_EXIT_CODE);
1207 if (i == 0)
1209 inf_size -= to_read;
1210 break;
1212 to_read -= i;
1215 close (inf_fd);
1217 /* Inf_size may have changed if read was short (as on VMS) */
1218 inf_buffer[inf_size] = '\n';
1219 inf_buffer[inf_size + 1] = '\0';
1220 inf_limit = inf_buffer + inf_size;
1222 /* If file doesn't end with '\n', add one. */
1223 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1224 inf_limit++;
1226 unlink (argv[3]);
1227 outf = fopen (argv[3], "w");
1228 if (outf == NULL)
1230 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1231 progname, argv[3]);
1232 perror (NULL);
1233 exit (FATAL_EXIT_CODE);
1236 lineno = 1;
1238 if (check_protection (&ifndef_line, &endif_line))
1240 lbrac_line = ifndef_line+1;
1241 rbrac_line = endif_line;
1243 else
1245 lbrac_line = 1;
1246 rbrac_line = -1;
1249 /* Reset input file. */
1250 inf_ptr = inf_buffer;
1251 lineno = 1;
1253 for (;;)
1255 if (lineno == lbrac_line)
1256 write_lbrac ();
1257 if (lineno == rbrac_line)
1258 write_rbrac ();
1259 for (;;)
1261 struct fn_decl *fn;
1262 c = INF_GET ();
1263 if (c == EOF)
1264 break;
1265 if (ISIDST (c))
1267 c = inf_scan_ident (&buf, c);
1268 (void) INF_UNGET (c);
1269 fputs (buf.base, outf);
1270 fn = lookup_std_proto (buf.base, strlen (buf.base));
1271 /* We only want to edit the declaration matching the one
1272 seen by scan-decls, as there can be multiple
1273 declarations, selected by #ifdef __STDC__ or whatever. */
1274 if (fn && fn->partial && fn->partial->line_seen == lineno)
1276 c = inf_skip_spaces (' ');
1277 if (c == EOF)
1278 break;
1279 if (c == '(')
1281 c = inf_skip_spaces (' ');
1282 if (c == ')')
1284 fprintf (outf, " _PARAMS((%s))", fn->params);
1286 else
1288 putc ('(', outf);
1289 (void) INF_UNGET (c);
1292 else
1293 fprintf (outf, " %c", c);
1296 else
1298 putc (c, outf);
1299 if (c == '\n')
1300 break;
1303 if (c == EOF)
1304 break;
1305 lineno++;
1307 if (rbrac_line < 0)
1308 write_rbrac ();
1310 fclose (outf);
1312 return 0;
1316 static void
1317 v_fatal (str, ap)
1318 const char * str;
1319 va_list ap;
1321 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1322 vfprintf (stderr, str, ap);
1323 fprintf (stderr, "\n");
1325 exit (FATAL_EXIT_CODE);
1328 static void
1329 fatal (const char *str, ...)
1331 va_list ap;
1333 va_start (ap, str);
1334 v_fatal (str, ap);
1335 va_end (ap);