* fixinc/inclhack.def (avoid_bool_define, avoid_bool_type): Bypass
[official-gcc.git] / gcc / fix-header.c
blob8f5383983a2060074c87e3fef7d860a863848c2f
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 (const char *, va_list)
84 ATTRIBUTE_PRINTF (1,0) ATTRIBUTE_NORETURN;
85 static void fatal (const char *, ...) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
87 sstring buf;
89 int verbose = 0;
90 int partial_count = 0;
91 int warnings = 0;
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 const char *const files_to_ignore[] = {
108 "X11/",
109 FIXPROTO_IGNORE_LIST
112 #endif
114 char *inf_buffer;
115 char *inf_limit;
116 char *inf_ptr;
117 static const char *cur_file;
119 /* Certain standard files get extra treatment */
121 enum special_file
123 no_special,
124 #ifdef errno_h
125 #undef errno_h
126 #endif
127 errno_h,
128 #ifdef stdio_h
129 #undef stdio_h
130 #endif
131 stdio_h,
132 #ifdef stdlib_h
133 #undef stdlib_h
134 #endif
135 stdlib_h,
136 #ifdef sys_stat_h
137 #undef sys_stat_h
138 #endif
139 sys_stat_h
142 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
143 by an empty name (i.e. by "\0\0"). */
145 typedef const char *namelist;
147 /* The following macros provide the bits for symbol_flags. */
148 typedef int symbol_flags;
150 /* Used to mark names defined in the ANSI/ISO C standard. */
151 #define ANSI_SYMBOL 1
153 /* We no longer massage include files for POSIX or XOPEN symbols,
154 as there are now several versions of the POSIX and XOPEN standards,
155 and it would be a maintenance nightmare for us to track them all.
156 Better to be compatible with the system include files. */
157 /*#define ADD_MISSING_POSIX 1 */
158 /*#define ADD_MISSING_XOPEN 1 */
160 #if ADD_MISSING_POSIX
161 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
162 #define POSIX1_SYMBOL 2
163 #define POSIX2_SYMBOL 4
164 #else
165 #define POSIX1_SYMBOL 0
166 #define POSIX2_SYMBOL 0
167 #endif
169 #if ADD_MISSING_XOPEN
170 /* Used to mark names defined in X/Open Portability Guide. */
171 #define XOPEN_SYMBOL 8
172 /* Used to mark names defined in X/Open UNIX Extensions. */
173 #define XOPEN_EXTENDED_SYMBOL 16
174 #else
175 #define XOPEN_SYMBOL 0
176 #define XOPEN_EXTENDED_SYMBOL 0
177 #endif
179 /* Used to indicate names that are not functions */
180 #define MACRO_SYMBOL 512
182 struct symbol_list {
183 symbol_flags flags;
184 namelist names;
187 #define SYMBOL_TABLE_SIZE 10
188 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
189 int cur_symbol_table_size;
191 static void add_symbols (symbol_flags, namelist);
192 static struct fn_decl *lookup_std_proto (const char *, int);
193 static void write_lbrac (void);
194 static void recognized_macro (const char *);
195 static void check_macro_names (cpp_reader *, namelist);
196 static void read_scan_file (char *, int, char **);
197 static void write_rbrac (void);
198 static int inf_skip_spaces (int);
199 static int inf_read_upto (sstring *, int);
200 static int inf_scan_ident (sstring *, int);
201 static int check_protection (int *, int *);
202 static void cb_file_change (cpp_reader *, const struct line_map *);
204 static void
205 add_symbols (symbol_flags flags, 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 *const name;
217 const symbol_flags flags;
218 const 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 const struct std_include_entry *include_entry;
228 const 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 struct obstack scan_file_obstack;
375 /* NOTE: If you edit this, also edit gen-protos.c !! */
377 static struct fn_decl *
378 lookup_std_proto (const char *name, int name_length)
380 int i = hashstr (name, name_length) % HASH_SIZE;
381 int i0 = i;
382 for (;;)
384 struct fn_decl *fn;
385 if (hash_tab[i] == 0)
386 return NULL;
387 fn = &std_protos[hash_tab[i]];
388 if ((int) strlen (fn->fname) == name_length
389 && strncmp (fn->fname, name, name_length) == 0)
390 return fn;
391 i = (i+1) % HASH_SIZE;
392 if (i == i0)
393 abort ();
397 char *inc_filename;
398 int inc_filename_length;
399 const char *progname = "fix-header";
400 FILE *outf;
401 sstring line;
403 int lbrac_line, rbrac_line;
405 int required_unseen_count = 0;
406 int required_other = 0;
408 static void
409 write_lbrac (void)
411 if (partial_count)
413 fprintf (outf, "#ifndef _PARAMS\n");
414 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
415 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
416 fprintf (outf, "#else\n");
417 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
418 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
422 struct partial_proto
424 struct partial_proto *next;
425 struct fn_decl *fn;
426 int line_seen;
429 struct partial_proto *partial_proto_list = NULL;
431 struct partial_proto required_dummy_proto, seen_dummy_proto;
432 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
433 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
434 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
435 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
437 static void
438 recognized_macro (const char *fname)
440 /* The original include file defines fname as a macro. */
441 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
443 /* Since fname is a macro, don't require a prototype for it. */
444 if (fn)
446 if (REQUIRED (fn))
447 required_unseen_count--;
448 SET_SEEN (fn);
451 switch (special_file_handling)
453 case errno_h:
454 if (strcmp (fname, "errno") == 0 && !seen_errno)
455 seen_errno = 1, required_other--;
456 break;
457 case stdlib_h:
458 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
459 seen_EXIT_FAILURE = 1, required_other--;
460 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
461 seen_EXIT_SUCCESS = 1, required_other--;
462 break;
463 case sys_stat_h:
464 if (fname[0] == 'S' && fname[1] == '_')
466 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
467 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
468 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
469 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
470 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
471 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
472 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
473 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
474 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
475 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
476 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
477 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
479 break;
481 default:
482 break;
486 void
487 recognized_extern (const cpp_token *name)
489 switch (special_file_handling)
491 case errno_h:
492 if (cpp_ideq (name, "errno"))
493 seen_errno = 1, required_other--;
494 break;
496 default:
497 break;
501 /* Called by scan_decls if it saw a function definition for a function
502 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
503 function declaration preceded by 'extern "C"' (or nested inside
504 'extern "C"' braces); or 'f' for other function declarations. */
506 void
507 recognized_function (const cpp_token *fname, unsigned int line, int kind,
508 int have_arg_list)
510 struct partial_proto *partial;
511 int i;
512 struct fn_decl *fn;
514 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
515 NODE_LEN (fname->val.node));
517 /* Remove the function from the list of required function. */
518 if (fn)
520 if (REQUIRED (fn))
521 required_unseen_count--;
522 SET_SEEN (fn);
525 /* If we have a full prototype, we're done. */
526 if (have_arg_list)
527 return;
529 if (kind == 'I') /* don't edit inline function */
530 return;
532 /* If the partial prototype was included from some other file,
533 we don't need to patch it up (in this run). */
534 i = strlen (cur_file);
535 if (i < inc_filename_length
536 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
537 return;
539 if (fn == NULL)
540 return;
541 if (fn->params[0] == '\0')
542 return;
544 /* We only have a partial function declaration,
545 so remember that we have to add a complete prototype. */
546 partial_count++;
547 partial = (struct partial_proto *)
548 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
549 partial->line_seen = line;
550 partial->fn = fn;
551 fn->partial = partial;
552 partial->next = partial_proto_list;
553 partial_proto_list = partial;
554 if (verbose)
556 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
557 inc_filename, fn->fname);
561 /* For any name in NAMES that is defined as a macro,
562 call recognized_macro on it. */
564 static void
565 check_macro_names (cpp_reader *pfile, namelist names)
567 size_t len;
568 while (*names)
570 len = strlen (names);
571 if (cpp_defined (pfile, (const unsigned char *)names, len))
572 recognized_macro (names);
573 names += len + 1;
577 static void
578 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
579 const struct line_map *map)
581 /* Just keep track of current file name. */
582 cur_file = map->to_file;
585 static void
586 read_scan_file (char *in_fname, int argc, char **argv)
588 cpp_reader *scan_in;
589 cpp_callbacks *cb;
590 cpp_options *options;
591 struct fn_decl *fn;
592 int i, strings_processed;
593 struct symbol_list *cur_symbols;
595 obstack_init (&scan_file_obstack);
597 scan_in = cpp_create_reader (CLK_GNUC89, NULL);
598 cb = cpp_get_callbacks (scan_in);
599 cb->file_change = cb_file_change;
601 /* We are going to be scanning a header file out of its proper context,
602 so ignore warnings and errors. */
603 options = cpp_get_options (scan_in);
604 options->inhibit_warnings = 1;
605 options->inhibit_errors = 1;
607 if (! cpp_read_main_file (scan_in, in_fname))
608 exit (FATAL_EXIT_CODE);
610 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
611 cpp_init_builtins (scan_in, true);
612 cpp_change_file (scan_in, LC_RENAME, in_fname);
614 /* Process switches after builtins so -D can override them. */
615 for (i = 0; i < argc; i += strings_processed)
617 strings_processed = 0;
618 if (argv[i][0] == '-')
620 if (argv[i][1] == 'I')
622 if (argv[i][2] != '\0')
624 strings_processed = 1;
625 add_path (xstrdup (argv[i] + 2), BRACKET, false);
627 else if (i + 1 != argc)
629 strings_processed = 2;
630 add_path (xstrdup (argv[i + 1]), BRACKET, false);
633 else if (argv[i][1] == 'D')
635 if (argv[i][2] != '\0')
636 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
637 else if (i + 1 != argc)
638 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
642 if (strings_processed == 0)
643 break;
646 if (i < argc)
647 cpp_error (scan_in, DL_ERROR, "invalid option `%s'", argv[i]);
648 if (cpp_errors (scan_in))
649 exit (FATAL_EXIT_CODE);
651 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
652 true /* stdinc */, false /* cxx_stdinc */,
653 false /* verbose */);
655 /* We are scanning a system header, so mark it as such. */
656 cpp_make_system_header (scan_in, 1, 0);
658 scan_decls (scan_in, argc, argv);
659 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
660 check_macro_names (scan_in, cur_symbols->names);
662 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
663 If so, those functions are also required. */
664 if (special_file_handling == stdio_h
665 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
667 unsigned char getchar_call[] = "getchar();\n";
668 int seen_filbuf = 0;
670 /* Scan the macro expansion of "getchar();". */
671 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
672 /* from_stage3 */ true, 1);
673 for (;;)
675 const cpp_token *t = cpp_get_token (scan_in);
677 if (t->type == CPP_EOF)
678 break;
679 else if (cpp_ideq (t, "_filbuf"))
680 seen_filbuf++;
683 if (seen_filbuf)
685 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
686 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
687 int need_flsbuf
688 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
690 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
691 if (need_filbuf + need_flsbuf)
693 const char *new_list;
694 if (need_filbuf)
695 SET_REQUIRED (fn);
696 if (need_flsbuf)
697 SET_REQUIRED (flsbuf_fn);
698 if (need_flsbuf && need_filbuf)
699 new_list = "_filbuf\0_flsbuf\0";
700 else if (need_flsbuf)
701 new_list = "_flsbuf\0";
702 else /* if (need_flsbuf) */
703 new_list = "_filbuf\0";
704 add_symbols (ANSI_SYMBOL, new_list);
705 required_unseen_count += need_filbuf + need_flsbuf;
710 if (required_unseen_count + partial_count + required_other == 0)
712 if (verbose)
713 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
714 exit (SUCCESS_EXIT_CODE);
716 if (!verbose)
717 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
718 else
720 if (required_unseen_count)
721 fprintf (stderr, "%s: %d missing function declarations.\n",
722 inc_filename, required_unseen_count);
723 if (partial_count)
724 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
725 inc_filename, partial_count);
729 static void
730 write_rbrac (void)
732 struct fn_decl *fn;
733 const char *cptr;
734 struct symbol_list *cur_symbols;
736 if (required_unseen_count)
738 #ifdef NO_IMPLICIT_EXTERN_C
739 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
740 #endif
743 /* Now we print out prototypes for those functions that we haven't seen. */
744 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
746 int if_was_emitted = 0;
747 int name_len;
748 cptr = cur_symbols->names;
749 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
751 int macro_protect = 0;
753 if (cur_symbols->flags & MACRO_SYMBOL)
754 continue;
756 fn = lookup_std_proto (cptr, name_len);
757 if (fn == NULL || !REQUIRED (fn))
758 continue;
760 if (!if_was_emitted)
762 /* what about curses. ??? or _flsbuf/_filbuf ??? */
763 if (cur_symbols->flags & ANSI_SYMBOL)
764 fprintf (outf,
765 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
766 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
767 fprintf (outf,
768 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
769 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
770 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
771 else if (cur_symbols->flags & XOPEN_SYMBOL)
773 fprintf (outf,
774 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
775 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
777 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
779 fprintf (outf,
780 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
781 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
783 else
785 fatal ("internal error for function %s", fn->fname);
787 if_was_emitted = 1;
790 /* In the case of memmove, protect in case the application
791 defines it as a macro before including the header. */
792 if (!strcmp (fn->fname, "memmove")
793 || !strcmp (fn->fname, "putc")
794 || !strcmp (fn->fname, "getc")
795 || !strcmp (fn->fname, "vprintf")
796 || !strcmp (fn->fname, "vfprintf")
797 || !strcmp (fn->fname, "vsprintf")
798 || !strcmp (fn->fname, "rewinddir")
799 || !strcmp (fn->fname, "abort"))
800 macro_protect = 1;
802 if (macro_protect)
803 fprintf (outf, "#ifndef %s\n", fn->fname);
804 fprintf (outf, "extern %s %s (%s);\n",
805 fn->rtype, fn->fname, fn->params);
806 if (macro_protect)
807 fprintf (outf, "#endif\n");
809 if (if_was_emitted)
810 fprintf (outf,
811 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
813 if (required_unseen_count)
815 #ifdef NO_IMPLICIT_EXTERN_C
816 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
817 #endif
820 switch (special_file_handling)
822 case errno_h:
823 if (!seen_errno)
824 fprintf (outf, "extern int errno;\n");
825 break;
826 case stdlib_h:
827 if (!seen_EXIT_FAILURE)
828 fprintf (outf, "#define EXIT_FAILURE 1\n");
829 if (!seen_EXIT_SUCCESS)
830 fprintf (outf, "#define EXIT_SUCCESS 0\n");
831 break;
832 case sys_stat_h:
833 if (!seen_S_ISBLK && seen_S_IFBLK)
834 fprintf (outf,
835 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
836 if (!seen_S_ISCHR && seen_S_IFCHR)
837 fprintf (outf,
838 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
839 if (!seen_S_ISDIR && seen_S_IFDIR)
840 fprintf (outf,
841 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
842 if (!seen_S_ISFIFO && seen_S_IFIFO)
843 fprintf (outf,
844 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
845 if (!seen_S_ISLNK && seen_S_IFLNK)
846 fprintf (outf,
847 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
848 if (!seen_S_ISREG && seen_S_IFREG)
849 fprintf (outf,
850 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
851 break;
853 default:
854 break;
859 /* Returns 1 iff the file is properly protected from multiple inclusion:
860 #ifndef PROTECT_NAME
861 #define PROTECT_NAME
862 #endif
866 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
867 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
869 static int
870 inf_skip_spaces (int c)
872 for (;;)
874 if (c == ' ' || c == '\t')
875 c = INF_GET ();
876 else if (c == '/')
878 c = INF_GET ();
879 if (c != '*')
881 (void) INF_UNGET (c);
882 return '/';
884 c = INF_GET ();
885 for (;;)
887 if (c == EOF)
888 return EOF;
889 else if (c != '*')
891 if (c == '\n')
892 source_lineno++, lineno++;
893 c = INF_GET ();
895 else if ((c = INF_GET ()) == '/')
896 return INF_GET ();
899 else
900 break;
902 return c;
905 /* Read into STR from inf_buffer upto DELIM. */
907 static int
908 inf_read_upto (sstring *str, int delim)
910 int ch;
911 for (;;)
913 ch = INF_GET ();
914 if (ch == EOF || ch == delim)
915 break;
916 SSTRING_PUT (str, ch);
918 MAKE_SSTRING_SPACE (str, 1);
919 *str->ptr = 0;
920 return ch;
923 static int
924 inf_scan_ident (sstring *s, int c)
926 s->ptr = s->base;
927 if (ISIDST (c))
929 for (;;)
931 SSTRING_PUT (s, c);
932 c = INF_GET ();
933 if (c == EOF || !(ISIDNUM (c)))
934 break;
937 MAKE_SSTRING_SPACE (s, 1);
938 *s->ptr = 0;
939 return c;
942 /* Returns 1 if the file is correctly protected against multiple
943 inclusion, setting *ifndef_line to the line number of the initial #ifndef
944 and setting *endif_line to the final #endif.
945 Otherwise return 0. */
947 static int
948 check_protection (int *ifndef_line, int *endif_line)
950 int c;
951 int if_nesting = 1; /* Level of nesting of #if's */
952 char *protect_name = NULL; /* Identifier following initial #ifndef */
953 int define_seen = 0;
955 /* Skip initial white space (including comments). */
956 for (;; lineno++)
958 c = inf_skip_spaces (' ');
959 if (c == EOF)
960 return 0;
961 if (c != '\n')
962 break;
964 if (c != '#')
965 return 0;
966 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
967 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
968 return 0;
970 /* So far so good: We've seen an initial #ifndef. */
971 *ifndef_line = lineno;
972 c = inf_scan_ident (&buf, inf_skip_spaces (c));
973 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
974 return 0;
975 protect_name = xstrdup (buf.base);
977 (void) INF_UNGET (c);
978 c = inf_read_upto (&buf, '\n');
979 if (c == EOF)
980 return 0;
981 lineno++;
983 for (;;)
985 c = inf_skip_spaces (' ');
986 if (c == EOF)
987 return 0;
988 if (c == '\n')
990 lineno++;
991 continue;
993 if (c != '#')
994 goto skip_to_eol;
995 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
996 if (SSTRING_LENGTH (&buf) == 0)
998 else if (!strcmp (buf.base, "ifndef")
999 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1001 if_nesting++;
1003 else if (!strcmp (buf.base, "endif"))
1005 if_nesting--;
1006 if (if_nesting == 0)
1007 break;
1009 else if (!strcmp (buf.base, "else"))
1011 if (if_nesting == 1)
1012 return 0;
1014 else if (!strcmp (buf.base, "define"))
1016 c = inf_skip_spaces (c);
1017 c = inf_scan_ident (&buf, c);
1018 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1019 define_seen = 1;
1021 skip_to_eol:
1022 for (;;)
1024 if (c == '\n' || c == EOF)
1025 break;
1026 c = INF_GET ();
1028 if (c == EOF)
1029 return 0;
1030 lineno++;
1033 if (!define_seen)
1034 return 0;
1035 *endif_line = lineno;
1036 /* Skip final white space (including comments). */
1037 for (;;)
1039 c = inf_skip_spaces (' ');
1040 if (c == EOF)
1041 break;
1042 if (c != '\n')
1043 return 0;
1046 return 1;
1049 extern int main (int, char **);
1052 main (int argc, char **argv)
1054 int inf_fd;
1055 struct stat sbuf;
1056 int c;
1057 #ifdef FIXPROTO_IGNORE_LIST
1058 int i;
1059 #endif
1060 const char *cptr;
1061 int ifndef_line;
1062 int endif_line;
1063 long to_read;
1064 long int inf_size;
1065 struct symbol_list *cur_symbols;
1067 if (argv[0] && argv[0][0])
1069 char *p;
1071 progname = 0;
1072 for (p = argv[0]; *p; p++)
1073 if (*p == '/')
1074 progname = p;
1075 progname = progname ? progname+1 : argv[0];
1078 if (argc < 4)
1080 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1081 progname);
1082 exit (FATAL_EXIT_CODE);
1085 inc_filename = argv[1];
1086 inc_filename_length = strlen (inc_filename);
1088 #ifdef FIXPROTO_IGNORE_LIST
1089 for (i = 0; files_to_ignore[i] != NULL; i++)
1091 const char *const ignore_name = files_to_ignore[i];
1092 int ignore_len = strlen (ignore_name);
1093 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1095 if (ignore_name[ignore_len-1] == '/'
1096 || inc_filename[ignore_len] == '\0')
1098 if (verbose)
1099 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1100 exit (SUCCESS_EXIT_CODE);
1105 #endif
1107 if (strcmp (inc_filename, "sys/stat.h") == 0)
1108 special_file_handling = sys_stat_h;
1109 else if (strcmp (inc_filename, "errno.h") == 0)
1110 special_file_handling = errno_h, required_other++;
1111 else if (strcmp (inc_filename, "stdlib.h") == 0)
1112 special_file_handling = stdlib_h, required_other+=2;
1113 else if (strcmp (inc_filename, "stdio.h") == 0)
1114 special_file_handling = stdio_h;
1115 include_entry = std_include_table;
1116 while (include_entry->name != NULL
1117 && ((strcmp (include_entry->name, CONTINUED) == 0)
1118 || strcmp (inc_filename, include_entry->name) != 0))
1119 include_entry++;
1121 if (include_entry->name != NULL)
1123 const struct std_include_entry *entry;
1124 cur_symbol_table_size = 0;
1125 for (entry = include_entry; ;)
1127 if (entry->flags)
1128 add_symbols (entry->flags, entry->names);
1129 entry++;
1130 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1131 break;
1134 else
1135 symbol_table[0].names = NULL;
1137 /* Count and mark the prototypes required for this include file. */
1138 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1140 int name_len;
1141 if (cur_symbols->flags & MACRO_SYMBOL)
1142 continue;
1143 cptr = cur_symbols->names;
1144 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1146 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1147 required_unseen_count++;
1148 if (fn == NULL)
1149 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1150 else
1151 SET_REQUIRED (fn);
1155 read_scan_file (argv[2], argc - 4, argv + 4);
1157 inf_fd = open (argv[2], O_RDONLY, 0666);
1158 if (inf_fd < 0)
1160 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1161 progname, argv[2]);
1162 perror (NULL);
1163 exit (FATAL_EXIT_CODE);
1165 if (fstat (inf_fd, &sbuf) < 0)
1167 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1168 perror (NULL);
1169 exit (FATAL_EXIT_CODE);
1171 inf_size = sbuf.st_size;
1172 inf_buffer = (char *) xmalloc (inf_size + 2);
1173 inf_ptr = inf_buffer;
1175 to_read = inf_size;
1176 while (to_read > 0)
1178 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1179 if (i < 0)
1181 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1182 perror (NULL);
1183 exit (FATAL_EXIT_CODE);
1185 if (i == 0)
1187 inf_size -= to_read;
1188 break;
1190 to_read -= i;
1193 close (inf_fd);
1195 /* Inf_size may have changed if read was short (as on VMS) */
1196 inf_buffer[inf_size] = '\n';
1197 inf_buffer[inf_size + 1] = '\0';
1198 inf_limit = inf_buffer + inf_size;
1200 /* If file doesn't end with '\n', add one. */
1201 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1202 inf_limit++;
1204 unlink (argv[3]);
1205 outf = fopen (argv[3], "w");
1206 if (outf == NULL)
1208 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1209 progname, argv[3]);
1210 perror (NULL);
1211 exit (FATAL_EXIT_CODE);
1214 lineno = 1;
1216 if (check_protection (&ifndef_line, &endif_line))
1218 lbrac_line = ifndef_line+1;
1219 rbrac_line = endif_line;
1221 else
1223 lbrac_line = 1;
1224 rbrac_line = -1;
1227 /* Reset input file. */
1228 inf_ptr = inf_buffer;
1229 lineno = 1;
1231 for (;;)
1233 if (lineno == lbrac_line)
1234 write_lbrac ();
1235 if (lineno == rbrac_line)
1236 write_rbrac ();
1237 for (;;)
1239 struct fn_decl *fn;
1240 c = INF_GET ();
1241 if (c == EOF)
1242 break;
1243 if (ISIDST (c))
1245 c = inf_scan_ident (&buf, c);
1246 (void) INF_UNGET (c);
1247 fputs (buf.base, outf);
1248 fn = lookup_std_proto (buf.base, strlen (buf.base));
1249 /* We only want to edit the declaration matching the one
1250 seen by scan-decls, as there can be multiple
1251 declarations, selected by #ifdef __STDC__ or whatever. */
1252 if (fn && fn->partial && fn->partial->line_seen == lineno)
1254 c = inf_skip_spaces (' ');
1255 if (c == EOF)
1256 break;
1257 if (c == '(')
1259 c = inf_skip_spaces (' ');
1260 if (c == ')')
1262 fprintf (outf, " _PARAMS((%s))", fn->params);
1264 else
1266 putc ('(', outf);
1267 (void) INF_UNGET (c);
1270 else
1271 fprintf (outf, " %c", c);
1274 else
1276 putc (c, outf);
1277 if (c == '\n')
1278 break;
1281 if (c == EOF)
1282 break;
1283 lineno++;
1285 if (rbrac_line < 0)
1286 write_rbrac ();
1288 fclose (outf);
1290 return 0;
1294 static void
1295 v_fatal (const char *str, va_list ap)
1297 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1298 vfprintf (stderr, str, ap);
1299 fprintf (stderr, "\n");
1301 exit (FATAL_EXIT_CODE);
1304 static void
1305 fatal (const char *str, ...)
1307 va_list ap;
1309 va_start (ap, str);
1310 v_fatal (str, ap);
1311 va_end (ap);