PR tree-optimization/17468
[official-gcc.git] / gcc / fix-header.c
blob9bd79d404ce77764098c195dfef186c4d529ccb9
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, 2004 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"
82 #include "errors.h"
84 #ifdef TARGET_EXTRA_INCLUDES
85 static void hook_void_int(int u ATTRIBUTE_UNUSED) { }
87 struct target_c_incpath_s target_c_incpath = { hook_void_int };
88 #endif
90 struct line_maps line_table;
92 sstring buf;
94 int verbose = 0;
95 int partial_count = 0;
96 int warnings = 0;
98 #if ADD_MISSING_EXTERN_C
99 int missing_extern_C_count = 0;
100 #endif
102 #include "xsys-protos.h"
104 #ifdef FIXPROTO_IGNORE_LIST
105 /* This is a currently unused feature. */
107 /* List of files and directories to ignore.
108 A directory name (ending in '/') means ignore anything in that
109 directory. (It might be more efficient to do directory pruning
110 earlier in fixproto, but this is simpler and easier to customize.) */
112 static const char *const files_to_ignore[] = {
113 "X11/",
114 FIXPROTO_IGNORE_LIST
117 #endif
119 char *inf_buffer;
120 char *inf_limit;
121 char *inf_ptr;
122 static const char *cur_file;
124 /* Certain standard files get extra treatment */
126 enum special_file
128 no_special,
129 #ifdef errno_h
130 #undef errno_h
131 #endif
132 errno_h,
133 #ifdef stdio_h
134 #undef stdio_h
135 #endif
136 stdio_h,
137 #ifdef stdlib_h
138 #undef stdlib_h
139 #endif
140 stdlib_h,
141 #ifdef sys_stat_h
142 #undef sys_stat_h
143 #endif
144 sys_stat_h
147 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
148 by an empty name (i.e. by "\0\0"). */
150 typedef const char *namelist;
152 /* The following macros provide the bits for symbol_flags. */
153 typedef int symbol_flags;
155 /* Used to mark names defined in the ANSI/ISO C standard. */
156 #define ANSI_SYMBOL 1
158 /* We no longer massage include files for POSIX or XOPEN symbols,
159 as there are now several versions of the POSIX and XOPEN standards,
160 and it would be a maintenance nightmare for us to track them all.
161 Better to be compatible with the system include files. */
162 /*#define ADD_MISSING_POSIX 1 */
163 /*#define ADD_MISSING_XOPEN 1 */
165 #if ADD_MISSING_POSIX
166 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
167 #define POSIX1_SYMBOL 2
168 #define POSIX2_SYMBOL 4
169 #else
170 #define POSIX1_SYMBOL 0
171 #define POSIX2_SYMBOL 0
172 #endif
174 #if ADD_MISSING_XOPEN
175 /* Used to mark names defined in X/Open Portability Guide. */
176 #define XOPEN_SYMBOL 8
177 /* Used to mark names defined in X/Open UNIX Extensions. */
178 #define XOPEN_EXTENDED_SYMBOL 16
179 #else
180 #define XOPEN_SYMBOL 0
181 #define XOPEN_EXTENDED_SYMBOL 0
182 #endif
184 /* Used to indicate names that are not functions */
185 #define MACRO_SYMBOL 512
187 struct symbol_list {
188 symbol_flags flags;
189 namelist names;
192 #define SYMBOL_TABLE_SIZE 10
193 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
194 int cur_symbol_table_size;
196 static void add_symbols (symbol_flags, namelist);
197 static struct fn_decl *lookup_std_proto (const char *, int);
198 static void write_lbrac (void);
199 static void recognized_macro (const char *);
200 static void check_macro_names (cpp_reader *, namelist);
201 static void read_scan_file (char *, int, char **);
202 static void write_rbrac (void);
203 static int inf_skip_spaces (int);
204 static int inf_read_upto (sstring *, int);
205 static int inf_scan_ident (sstring *, int);
206 static int check_protection (int *, int *);
207 static void cb_file_change (cpp_reader *, const struct line_map *);
209 static void
210 add_symbols (symbol_flags flags, namelist names)
212 symbol_table[cur_symbol_table_size].flags = flags;
213 symbol_table[cur_symbol_table_size].names = names;
214 cur_symbol_table_size++;
215 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
216 fatal ("too many calls to add_symbols");
217 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
220 struct std_include_entry {
221 const char *const name;
222 const symbol_flags flags;
223 const namelist names;
226 const char NONE[] = ""; /* The empty namelist. */
228 /* Special name to indicate a continuation line in std_include_table. */
229 const char CONTINUED[] = "";
231 const struct std_include_entry *include_entry;
233 const struct std_include_entry std_include_table [] = {
234 { "ctype.h", ANSI_SYMBOL,
235 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
236 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
238 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
240 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
242 /* ANSI_SYMBOL is wrong, but ... */
243 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
244 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
245 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
246 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
247 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
249 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
251 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
252 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
254 /*{ "limit.h", ... provided by gcc }, */
256 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
258 { "math.h", ANSI_SYMBOL,
259 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
260 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
261 tan\0tanh\0" },
263 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
265 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
267 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
268 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
270 /* Left out signal() - its prototype is too complex for us!
271 Also left out "sigaction sigaddset sigdelset sigemptyset
272 sigfillset sigismember sigpending sigprocmask sigsuspend"
273 because these need sigset_t or struct sigaction.
274 Most systems that provide them will also declare them. */
275 { "signal.h", ANSI_SYMBOL, "raise\0" },
276 { CONTINUED, POSIX1_SYMBOL, "kill\0" },
278 { "stdio.h", ANSI_SYMBOL,
279 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
280 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
281 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
282 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
283 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
284 tmpnam\0ungetc\0" },
285 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
286 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
287 /* Should perhaps also handle NULL, EOF, ... ? */
289 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
290 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
291 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
292 Should perhaps also add NULL */
293 { "stdlib.h", ANSI_SYMBOL,
294 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
295 exit\0free\0getenv\0labs\0malloc\0qsort\0rand\0realloc\0\
296 srand\0strtod\0strtol\0strtoul\0system\0" },
297 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
298 { CONTINUED, POSIX1_SYMBOL, "putenv\0" },
300 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
301 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
302 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
303 strtok\0strxfrm\0" },
304 /* Should perhaps also add NULL and size_t */
306 { "strings.h", XOPEN_EXTENDED_SYMBOL,
307 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
309 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
311 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
312 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
313 and many systems do have <sys/ioctl.h> but not <strops.h>. */
314 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
316 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
318 { "sys/stat.h", POSIX1_SYMBOL,
319 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
320 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
321 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
322 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
323 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
325 #if 0
326 /* How do we handle fd_set? */
327 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
328 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
329 #endif
331 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
332 /* "sys/types.h" add types (not in old g++-include) */
334 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
336 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
337 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
338 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
339 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
341 { "tar.h", POSIX1_SYMBOL, NONE },
343 { "termios.h", POSIX1_SYMBOL,
344 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
346 { "time.h", ANSI_SYMBOL,
347 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0" },
348 { CONTINUED, POSIX1_SYMBOL, "tzset\0" },
350 { "unistd.h", POSIX1_SYMBOL,
351 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
352 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
353 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
354 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
355 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
356 ttyname\0unlink\0write\0" },
357 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
358 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
359 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
361 { "utime.h", POSIX1_SYMBOL, "utime\0" },
363 { NULL, 0, NONE }
366 enum special_file special_file_handling = no_special;
368 /* They are set if the corresponding macro has been seen. */
369 /* The following are only used when handling sys/stat.h */
370 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
371 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
372 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
373 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
374 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
375 int seen_S_IFREG = 0, seen_S_ISREG = 0;
376 /* The following are only used when handling errno.h */
377 int seen_errno = 0;
378 /* The following are only used when handling stdlib.h */
379 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
381 struct obstack scan_file_obstack;
383 /* NOTE: If you edit this, also edit gen-protos.c !! */
385 static struct fn_decl *
386 lookup_std_proto (const char *name, int name_length)
388 int i = hashstr (name, name_length) % HASH_SIZE;
389 int i0 = i;
390 for (;;)
392 struct fn_decl *fn;
393 if (hash_tab[i] == 0)
394 return NULL;
395 fn = &std_protos[hash_tab[i]];
396 if ((int) strlen (fn->fname) == name_length
397 && strncmp (fn->fname, name, name_length) == 0)
398 return fn;
399 i = (i+1) % HASH_SIZE;
400 gcc_assert (i != i0);
404 char *inc_filename;
405 int inc_filename_length;
406 FILE *outf;
407 sstring line;
409 int lbrac_line, rbrac_line;
411 int required_unseen_count = 0;
412 int required_other = 0;
414 static void
415 write_lbrac (void)
417 if (partial_count)
419 fprintf (outf, "#ifndef _PARAMS\n");
420 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
421 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
422 fprintf (outf, "#else\n");
423 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
424 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
428 struct partial_proto
430 struct partial_proto *next;
431 struct fn_decl *fn;
432 int line_seen;
435 struct partial_proto *partial_proto_list = NULL;
437 struct partial_proto required_dummy_proto, seen_dummy_proto;
438 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
439 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
440 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
441 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
443 static void
444 recognized_macro (const char *fname)
446 /* The original include file defines fname as a macro. */
447 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
449 /* Since fname is a macro, don't require a prototype for it. */
450 if (fn)
452 if (REQUIRED (fn))
453 required_unseen_count--;
454 SET_SEEN (fn);
457 switch (special_file_handling)
459 case errno_h:
460 if (strcmp (fname, "errno") == 0 && !seen_errno)
461 seen_errno = 1, required_other--;
462 break;
463 case stdlib_h:
464 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
465 seen_EXIT_FAILURE = 1, required_other--;
466 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
467 seen_EXIT_SUCCESS = 1, required_other--;
468 break;
469 case sys_stat_h:
470 if (fname[0] == 'S' && fname[1] == '_')
472 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
473 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
474 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
475 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
476 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
477 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
478 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
479 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
480 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
481 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
482 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
483 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
485 break;
487 default:
488 break;
492 void
493 recognized_extern (const cpp_token *name)
495 switch (special_file_handling)
497 case errno_h:
498 if (cpp_ideq (name, "errno"))
499 seen_errno = 1, required_other--;
500 break;
502 default:
503 break;
507 /* Called by scan_decls if it saw a function definition for a function
508 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
509 function declaration preceded by 'extern "C"' (or nested inside
510 'extern "C"' braces); or 'f' for other function declarations. */
512 void
513 recognized_function (const cpp_token *fname, unsigned int line, int kind,
514 int have_arg_list)
516 struct partial_proto *partial;
517 int i;
518 struct fn_decl *fn;
520 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
521 NODE_LEN (fname->val.node));
523 /* Remove the function from the list of required function. */
524 if (fn)
526 if (REQUIRED (fn))
527 required_unseen_count--;
528 SET_SEEN (fn);
531 /* If we have a full prototype, we're done. */
532 if (have_arg_list)
533 return;
535 if (kind == 'I') /* don't edit inline function */
536 return;
538 /* If the partial prototype was included from some other file,
539 we don't need to patch it up (in this run). */
540 i = strlen (cur_file);
541 if (i < inc_filename_length
542 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
543 return;
545 if (fn == NULL)
546 return;
547 if (fn->params[0] == '\0')
548 return;
550 /* We only have a partial function declaration,
551 so remember that we have to add a complete prototype. */
552 partial_count++;
553 partial = obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
554 partial->line_seen = line;
555 partial->fn = fn;
556 fn->partial = partial;
557 partial->next = partial_proto_list;
558 partial_proto_list = partial;
559 if (verbose)
561 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
562 inc_filename, fn->fname);
566 /* For any name in NAMES that is defined as a macro,
567 call recognized_macro on it. */
569 static void
570 check_macro_names (cpp_reader *pfile, namelist names)
572 size_t len;
573 while (*names)
575 len = strlen (names);
576 if (cpp_defined (pfile, (const unsigned char *)names, len))
577 recognized_macro (names);
578 names += len + 1;
582 static void
583 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
584 const struct line_map *map)
586 /* Just keep track of current file name. */
587 cur_file = map == NULL ? NULL : map->to_file;
590 static void
591 read_scan_file (char *in_fname, int argc, char **argv)
593 cpp_reader *scan_in;
594 cpp_callbacks *cb;
595 cpp_options *options;
596 struct fn_decl *fn;
597 int i, strings_processed;
598 struct symbol_list *cur_symbols;
600 obstack_init (&scan_file_obstack);
602 linemap_init (&line_table);
603 scan_in = cpp_create_reader (CLK_GNUC89, NULL, &line_table);
604 cb = cpp_get_callbacks (scan_in);
605 cb->file_change = cb_file_change;
607 /* We are going to be scanning a header file out of its proper context,
608 so ignore warnings and errors. */
609 options = cpp_get_options (scan_in);
610 options->inhibit_warnings = 1;
611 options->inhibit_errors = 1;
612 cpp_post_options (scan_in);
614 if (!cpp_read_main_file (scan_in, in_fname))
615 exit (FATAL_EXIT_CODE);
617 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
618 cpp_init_builtins (scan_in, true);
619 cpp_change_file (scan_in, LC_RENAME, in_fname);
621 /* Process switches after builtins so -D can override them. */
622 for (i = 0; i < argc; i += strings_processed)
624 strings_processed = 0;
625 if (argv[i][0] == '-')
627 if (argv[i][1] == 'I')
629 if (argv[i][2] != '\0')
631 strings_processed = 1;
632 add_path (xstrdup (argv[i] + 2), BRACKET, false, false);
634 else if (i + 1 != argc)
636 strings_processed = 2;
637 add_path (xstrdup (argv[i + 1]), BRACKET, false, false);
640 else if (argv[i][1] == 'D')
642 if (argv[i][2] != '\0')
643 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
644 else if (i + 1 != argc)
645 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
649 if (strings_processed == 0)
650 break;
653 if (i < argc)
654 cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
655 if (cpp_errors (scan_in))
656 exit (FATAL_EXIT_CODE);
658 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
659 true /* stdinc */, false /* cxx_stdinc */,
660 false /* verbose */);
662 /* We are scanning a system header, so mark it as such. */
663 cpp_make_system_header (scan_in, 1, 0);
665 scan_decls (scan_in, argc, argv);
666 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
667 check_macro_names (scan_in, cur_symbols->names);
669 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
670 If so, those functions are also required. */
671 if (special_file_handling == stdio_h
672 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
674 unsigned char getchar_call[] = "getchar();\n";
675 int seen_filbuf = 0;
677 /* Scan the macro expansion of "getchar();". */
678 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
679 /* from_stage3 */ true);
680 for (;;)
682 const cpp_token *t = cpp_get_token (scan_in);
684 if (t->type == CPP_EOF)
685 break;
686 else if (cpp_ideq (t, "_filbuf"))
687 seen_filbuf++;
690 if (seen_filbuf)
692 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
693 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
694 int need_flsbuf
695 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
697 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
698 if (need_filbuf + need_flsbuf)
700 const char *new_list;
701 if (need_filbuf)
702 SET_REQUIRED (fn);
703 if (need_flsbuf)
704 SET_REQUIRED (flsbuf_fn);
705 if (need_flsbuf && need_filbuf)
706 new_list = "_filbuf\0_flsbuf\0";
707 else if (need_flsbuf)
708 new_list = "_flsbuf\0";
709 else /* if (need_flsbuf) */
710 new_list = "_filbuf\0";
711 add_symbols (ANSI_SYMBOL, new_list);
712 required_unseen_count += need_filbuf + need_flsbuf;
717 if (required_unseen_count + partial_count + required_other == 0)
719 if (verbose)
720 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
721 exit (SUCCESS_EXIT_CODE);
723 if (!verbose)
724 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
725 else
727 if (required_unseen_count)
728 fprintf (stderr, "%s: %d missing function declarations.\n",
729 inc_filename, required_unseen_count);
730 if (partial_count)
731 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
732 inc_filename, partial_count);
736 static void
737 write_rbrac (void)
739 struct fn_decl *fn;
740 const char *cptr;
741 struct symbol_list *cur_symbols;
743 if (required_unseen_count)
745 #ifdef NO_IMPLICIT_EXTERN_C
746 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
747 #endif
750 /* Now we print out prototypes for those functions that we haven't seen. */
751 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
753 int if_was_emitted = 0;
754 int name_len;
755 cptr = cur_symbols->names;
756 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
758 int macro_protect = 0;
760 if (cur_symbols->flags & MACRO_SYMBOL)
761 continue;
763 fn = lookup_std_proto (cptr, name_len);
764 if (fn == NULL || !REQUIRED (fn))
765 continue;
767 if (!if_was_emitted)
769 /* what about curses. ??? or _flsbuf/_filbuf ??? */
770 if (cur_symbols->flags & ANSI_SYMBOL)
771 fprintf (outf,
772 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
773 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
774 fprintf (outf,
775 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
776 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
777 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
778 else if (cur_symbols->flags & XOPEN_SYMBOL)
780 fprintf (outf,
781 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
782 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
784 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
786 fprintf (outf,
787 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
788 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
790 else
792 fatal ("internal error for function %s", fn->fname);
794 if_was_emitted = 1;
797 /* In the case of memmove, protect in case the application
798 defines it as a macro before including the header. */
799 if (!strcmp (fn->fname, "memmove")
800 || !strcmp (fn->fname, "putc")
801 || !strcmp (fn->fname, "getc")
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;
866 /* Returns 1 iff the file is properly protected from multiple inclusion:
867 #ifndef PROTECT_NAME
868 #define PROTECT_NAME
869 #endif
873 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
874 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
876 static int
877 inf_skip_spaces (int c)
879 for (;;)
881 if (c == ' ' || c == '\t')
882 c = INF_GET ();
883 else if (c == '/')
885 c = INF_GET ();
886 if (c != '*')
888 (void) INF_UNGET (c);
889 return '/';
891 c = INF_GET ();
892 for (;;)
894 if (c == EOF)
895 return EOF;
896 else if (c != '*')
898 if (c == '\n')
899 source_lineno++, lineno++;
900 c = INF_GET ();
902 else if ((c = INF_GET ()) == '/')
903 return INF_GET ();
906 else
907 break;
909 return c;
912 /* Read into STR from inf_buffer upto DELIM. */
914 static int
915 inf_read_upto (sstring *str, int delim)
917 int ch;
918 for (;;)
920 ch = INF_GET ();
921 if (ch == EOF || ch == delim)
922 break;
923 SSTRING_PUT (str, ch);
925 MAKE_SSTRING_SPACE (str, 1);
926 *str->ptr = 0;
927 return ch;
930 static int
931 inf_scan_ident (sstring *s, int c)
933 s->ptr = s->base;
934 if (ISIDST (c))
936 for (;;)
938 SSTRING_PUT (s, c);
939 c = INF_GET ();
940 if (c == EOF || !(ISIDNUM (c)))
941 break;
944 MAKE_SSTRING_SPACE (s, 1);
945 *s->ptr = 0;
946 return c;
949 /* Returns 1 if the file is correctly protected against multiple
950 inclusion, setting *ifndef_line to the line number of the initial #ifndef
951 and setting *endif_line to the final #endif.
952 Otherwise return 0. */
954 static int
955 check_protection (int *ifndef_line, int *endif_line)
957 int c;
958 int if_nesting = 1; /* Level of nesting of #if's */
959 char *protect_name = NULL; /* Identifier following initial #ifndef */
960 int define_seen = 0;
962 /* Skip initial white space (including comments). */
963 for (;; lineno++)
965 c = inf_skip_spaces (' ');
966 if (c == EOF)
967 return 0;
968 if (c != '\n')
969 break;
971 if (c != '#')
972 return 0;
973 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
974 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
975 return 0;
977 /* So far so good: We've seen an initial #ifndef. */
978 *ifndef_line = lineno;
979 c = inf_scan_ident (&buf, inf_skip_spaces (c));
980 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
981 return 0;
982 protect_name = xstrdup (buf.base);
984 (void) INF_UNGET (c);
985 c = inf_read_upto (&buf, '\n');
986 if (c == EOF)
987 return 0;
988 lineno++;
990 for (;;)
992 c = inf_skip_spaces (' ');
993 if (c == EOF)
994 return 0;
995 if (c == '\n')
997 lineno++;
998 continue;
1000 if (c != '#')
1001 goto skip_to_eol;
1002 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1003 if (SSTRING_LENGTH (&buf) == 0)
1005 else if (!strcmp (buf.base, "ifndef")
1006 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1008 if_nesting++;
1010 else if (!strcmp (buf.base, "endif"))
1012 if_nesting--;
1013 if (if_nesting == 0)
1014 break;
1016 else if (!strcmp (buf.base, "else"))
1018 if (if_nesting == 1)
1019 return 0;
1021 else if (!strcmp (buf.base, "define"))
1023 c = inf_skip_spaces (c);
1024 c = inf_scan_ident (&buf, c);
1025 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1026 define_seen = 1;
1028 skip_to_eol:
1029 for (;;)
1031 if (c == '\n' || c == EOF)
1032 break;
1033 c = INF_GET ();
1035 if (c == EOF)
1036 return 0;
1037 lineno++;
1040 if (!define_seen)
1041 return 0;
1042 *endif_line = lineno;
1043 /* Skip final white space (including comments). */
1044 for (;;)
1046 c = inf_skip_spaces (' ');
1047 if (c == EOF)
1048 break;
1049 if (c != '\n')
1050 return 0;
1053 return 1;
1056 extern int main (int, char **);
1059 main (int argc, char **argv)
1061 int inf_fd;
1062 struct stat sbuf;
1063 int c;
1064 #ifdef FIXPROTO_IGNORE_LIST
1065 int i;
1066 #endif
1067 const char *cptr;
1068 int ifndef_line;
1069 int endif_line;
1070 long to_read;
1071 long int inf_size;
1072 struct symbol_list *cur_symbols;
1074 progname = "fix-header";
1075 if (argv[0] && argv[0][0])
1077 char *p;
1079 progname = 0;
1080 for (p = argv[0]; *p; p++)
1081 if (*p == '/')
1082 progname = p;
1083 progname = progname ? progname+1 : argv[0];
1086 if (argc < 4)
1088 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1089 progname);
1090 exit (FATAL_EXIT_CODE);
1093 inc_filename = argv[1];
1094 inc_filename_length = strlen (inc_filename);
1096 #ifdef FIXPROTO_IGNORE_LIST
1097 for (i = 0; files_to_ignore[i] != NULL; i++)
1099 const char *const ignore_name = files_to_ignore[i];
1100 int ignore_len = strlen (ignore_name);
1101 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1103 if (ignore_name[ignore_len-1] == '/'
1104 || inc_filename[ignore_len] == '\0')
1106 if (verbose)
1107 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1108 exit (SUCCESS_EXIT_CODE);
1113 #endif
1115 if (strcmp (inc_filename, "sys/stat.h") == 0)
1116 special_file_handling = sys_stat_h;
1117 else if (strcmp (inc_filename, "errno.h") == 0)
1118 special_file_handling = errno_h, required_other++;
1119 else if (strcmp (inc_filename, "stdlib.h") == 0)
1120 special_file_handling = stdlib_h, required_other+=2;
1121 else if (strcmp (inc_filename, "stdio.h") == 0)
1122 special_file_handling = stdio_h;
1123 include_entry = std_include_table;
1124 while (include_entry->name != NULL
1125 && ((strcmp (include_entry->name, CONTINUED) == 0)
1126 || strcmp (inc_filename, include_entry->name) != 0))
1127 include_entry++;
1129 if (include_entry->name != NULL)
1131 const struct std_include_entry *entry;
1132 cur_symbol_table_size = 0;
1133 for (entry = include_entry; ;)
1135 if (entry->flags)
1136 add_symbols (entry->flags, entry->names);
1137 entry++;
1138 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1139 break;
1142 else
1143 symbol_table[0].names = NULL;
1145 /* Count and mark the prototypes required for this include file. */
1146 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1148 int name_len;
1149 if (cur_symbols->flags & MACRO_SYMBOL)
1150 continue;
1151 cptr = cur_symbols->names;
1152 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1154 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1155 required_unseen_count++;
1156 if (fn == NULL)
1157 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1158 else
1159 SET_REQUIRED (fn);
1163 read_scan_file (argv[2], argc - 4, argv + 4);
1165 inf_fd = open (argv[2], O_RDONLY, 0666);
1166 if (inf_fd < 0)
1168 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1169 progname, argv[2]);
1170 perror (NULL);
1171 exit (FATAL_EXIT_CODE);
1173 if (fstat (inf_fd, &sbuf) < 0)
1175 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1176 perror (NULL);
1177 exit (FATAL_EXIT_CODE);
1179 inf_size = sbuf.st_size;
1180 inf_buffer = xmalloc (inf_size + 2);
1181 inf_ptr = inf_buffer;
1183 to_read = inf_size;
1184 while (to_read > 0)
1186 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1187 if (i < 0)
1189 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1190 perror (NULL);
1191 exit (FATAL_EXIT_CODE);
1193 if (i == 0)
1195 inf_size -= to_read;
1196 break;
1198 to_read -= i;
1201 close (inf_fd);
1203 /* Inf_size may have changed if read was short (as on VMS) */
1204 inf_buffer[inf_size] = '\n';
1205 inf_buffer[inf_size + 1] = '\0';
1206 inf_limit = inf_buffer + inf_size;
1208 /* If file doesn't end with '\n', add one. */
1209 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1210 inf_limit++;
1212 unlink (argv[3]);
1213 outf = fopen (argv[3], "w");
1214 if (outf == NULL)
1216 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1217 progname, argv[3]);
1218 perror (NULL);
1219 exit (FATAL_EXIT_CODE);
1222 lineno = 1;
1224 if (check_protection (&ifndef_line, &endif_line))
1226 lbrac_line = ifndef_line+1;
1227 rbrac_line = endif_line;
1229 else
1231 lbrac_line = 1;
1232 rbrac_line = -1;
1235 /* Reset input file. */
1236 inf_ptr = inf_buffer;
1237 lineno = 1;
1239 for (;;)
1241 if (lineno == lbrac_line)
1242 write_lbrac ();
1243 if (lineno == rbrac_line)
1244 write_rbrac ();
1245 for (;;)
1247 struct fn_decl *fn;
1248 c = INF_GET ();
1249 if (c == EOF)
1250 break;
1251 if (ISIDST (c))
1253 c = inf_scan_ident (&buf, c);
1254 (void) INF_UNGET (c);
1255 fputs (buf.base, outf);
1256 fn = lookup_std_proto (buf.base, strlen (buf.base));
1257 /* We only want to edit the declaration matching the one
1258 seen by scan-decls, as there can be multiple
1259 declarations, selected by #ifdef __STDC__ or whatever. */
1260 if (fn && fn->partial && fn->partial->line_seen == lineno)
1262 c = inf_skip_spaces (' ');
1263 if (c == EOF)
1264 break;
1265 if (c == '(')
1267 c = inf_skip_spaces (' ');
1268 if (c == ')')
1270 fprintf (outf, " _PARAMS((%s))", fn->params);
1272 else
1274 putc ('(', outf);
1275 (void) INF_UNGET (c);
1278 else
1279 fprintf (outf, " %c", c);
1282 else
1284 putc (c, outf);
1285 if (c == '\n')
1286 break;
1289 if (c == EOF)
1290 break;
1291 lineno++;
1293 if (rbrac_line < 0)
1294 write_rbrac ();
1296 fclose (outf);
1298 return 0;