2003-12-26 Guilhem Lavaux <guilhem@kaffe.org>
[official-gcc.git] / gcc / fix-header.c
blobad23793a4068640f2646ce964ab536780b793729
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 = obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
548 partial->line_seen = line;
549 partial->fn = fn;
550 fn->partial = partial;
551 partial->next = partial_proto_list;
552 partial_proto_list = partial;
553 if (verbose)
555 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
556 inc_filename, fn->fname);
560 /* For any name in NAMES that is defined as a macro,
561 call recognized_macro on it. */
563 static void
564 check_macro_names (cpp_reader *pfile, namelist names)
566 size_t len;
567 while (*names)
569 len = strlen (names);
570 if (cpp_defined (pfile, (const unsigned char *)names, len))
571 recognized_macro (names);
572 names += len + 1;
576 static void
577 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
578 const struct line_map *map)
580 /* Just keep track of current file name. */
581 cur_file = map == NULL ? NULL : map->to_file;
584 static void
585 read_scan_file (char *in_fname, int argc, char **argv)
587 cpp_reader *scan_in;
588 cpp_callbacks *cb;
589 cpp_options *options;
590 struct fn_decl *fn;
591 int i, strings_processed;
592 struct symbol_list *cur_symbols;
594 obstack_init (&scan_file_obstack);
596 scan_in = cpp_create_reader (CLK_GNUC89, NULL);
597 cb = cpp_get_callbacks (scan_in);
598 cb->file_change = cb_file_change;
600 /* We are going to be scanning a header file out of its proper context,
601 so ignore warnings and errors. */
602 options = cpp_get_options (scan_in);
603 options->inhibit_warnings = 1;
604 options->inhibit_errors = 1;
605 cpp_post_options (scan_in);
607 if (!cpp_find_main_file (scan_in, in_fname))
608 exit (FATAL_EXIT_CODE);
609 cpp_push_main_file (scan_in);
611 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
612 cpp_init_builtins (scan_in, true);
613 cpp_change_file (scan_in, LC_RENAME, in_fname);
615 /* Process switches after builtins so -D can override them. */
616 for (i = 0; i < argc; i += strings_processed)
618 strings_processed = 0;
619 if (argv[i][0] == '-')
621 if (argv[i][1] == 'I')
623 if (argv[i][2] != '\0')
625 strings_processed = 1;
626 add_path (xstrdup (argv[i] + 2), BRACKET, false);
628 else if (i + 1 != argc)
630 strings_processed = 2;
631 add_path (xstrdup (argv[i + 1]), BRACKET, false);
634 else if (argv[i][1] == 'D')
636 if (argv[i][2] != '\0')
637 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
638 else if (i + 1 != argc)
639 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
643 if (strings_processed == 0)
644 break;
647 if (i < argc)
648 cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
649 if (cpp_errors (scan_in))
650 exit (FATAL_EXIT_CODE);
652 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
653 true /* stdinc */, false /* cxx_stdinc */,
654 false /* verbose */);
656 /* We are scanning a system header, so mark it as such. */
657 cpp_make_system_header (scan_in, 1, 0);
659 scan_decls (scan_in, argc, argv);
660 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
661 check_macro_names (scan_in, cur_symbols->names);
663 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
664 If so, those functions are also required. */
665 if (special_file_handling == stdio_h
666 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
668 unsigned char getchar_call[] = "getchar();\n";
669 int seen_filbuf = 0;
671 /* Scan the macro expansion of "getchar();". */
672 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
673 /* from_stage3 */ true);
674 for (;;)
676 const cpp_token *t = cpp_get_token (scan_in);
678 if (t->type == CPP_EOF)
679 break;
680 else if (cpp_ideq (t, "_filbuf"))
681 seen_filbuf++;
684 if (seen_filbuf)
686 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
687 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
688 int need_flsbuf
689 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
691 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
692 if (need_filbuf + need_flsbuf)
694 const char *new_list;
695 if (need_filbuf)
696 SET_REQUIRED (fn);
697 if (need_flsbuf)
698 SET_REQUIRED (flsbuf_fn);
699 if (need_flsbuf && need_filbuf)
700 new_list = "_filbuf\0_flsbuf\0";
701 else if (need_flsbuf)
702 new_list = "_flsbuf\0";
703 else /* if (need_flsbuf) */
704 new_list = "_filbuf\0";
705 add_symbols (ANSI_SYMBOL, new_list);
706 required_unseen_count += need_filbuf + need_flsbuf;
711 if (required_unseen_count + partial_count + required_other == 0)
713 if (verbose)
714 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
715 exit (SUCCESS_EXIT_CODE);
717 if (!verbose)
718 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
719 else
721 if (required_unseen_count)
722 fprintf (stderr, "%s: %d missing function declarations.\n",
723 inc_filename, required_unseen_count);
724 if (partial_count)
725 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
726 inc_filename, partial_count);
730 static void
731 write_rbrac (void)
733 struct fn_decl *fn;
734 const char *cptr;
735 struct symbol_list *cur_symbols;
737 if (required_unseen_count)
739 #ifdef NO_IMPLICIT_EXTERN_C
740 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
741 #endif
744 /* Now we print out prototypes for those functions that we haven't seen. */
745 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
747 int if_was_emitted = 0;
748 int name_len;
749 cptr = cur_symbols->names;
750 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
752 int macro_protect = 0;
754 if (cur_symbols->flags & MACRO_SYMBOL)
755 continue;
757 fn = lookup_std_proto (cptr, name_len);
758 if (fn == NULL || !REQUIRED (fn))
759 continue;
761 if (!if_was_emitted)
763 /* what about curses. ??? or _flsbuf/_filbuf ??? */
764 if (cur_symbols->flags & ANSI_SYMBOL)
765 fprintf (outf,
766 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
767 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
768 fprintf (outf,
769 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
770 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
771 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
772 else if (cur_symbols->flags & XOPEN_SYMBOL)
774 fprintf (outf,
775 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
776 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
778 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
780 fprintf (outf,
781 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
782 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
784 else
786 fatal ("internal error for function %s", fn->fname);
788 if_was_emitted = 1;
791 /* In the case of memmove, protect in case the application
792 defines it as a macro before including the header. */
793 if (!strcmp (fn->fname, "memmove")
794 || !strcmp (fn->fname, "putc")
795 || !strcmp (fn->fname, "getc")
796 || !strcmp (fn->fname, "vprintf")
797 || !strcmp (fn->fname, "vfprintf")
798 || !strcmp (fn->fname, "vsprintf")
799 || !strcmp (fn->fname, "rewinddir")
800 || !strcmp (fn->fname, "abort"))
801 macro_protect = 1;
803 if (macro_protect)
804 fprintf (outf, "#ifndef %s\n", fn->fname);
805 fprintf (outf, "extern %s %s (%s);\n",
806 fn->rtype, fn->fname, fn->params);
807 if (macro_protect)
808 fprintf (outf, "#endif\n");
810 if (if_was_emitted)
811 fprintf (outf,
812 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
814 if (required_unseen_count)
816 #ifdef NO_IMPLICIT_EXTERN_C
817 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
818 #endif
821 switch (special_file_handling)
823 case errno_h:
824 if (!seen_errno)
825 fprintf (outf, "extern int errno;\n");
826 break;
827 case stdlib_h:
828 if (!seen_EXIT_FAILURE)
829 fprintf (outf, "#define EXIT_FAILURE 1\n");
830 if (!seen_EXIT_SUCCESS)
831 fprintf (outf, "#define EXIT_SUCCESS 0\n");
832 break;
833 case sys_stat_h:
834 if (!seen_S_ISBLK && seen_S_IFBLK)
835 fprintf (outf,
836 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
837 if (!seen_S_ISCHR && seen_S_IFCHR)
838 fprintf (outf,
839 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
840 if (!seen_S_ISDIR && seen_S_IFDIR)
841 fprintf (outf,
842 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
843 if (!seen_S_ISFIFO && seen_S_IFIFO)
844 fprintf (outf,
845 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
846 if (!seen_S_ISLNK && seen_S_IFLNK)
847 fprintf (outf,
848 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
849 if (!seen_S_ISREG && seen_S_IFREG)
850 fprintf (outf,
851 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
852 break;
854 default:
855 break;
860 /* Returns 1 iff the file is properly protected from multiple inclusion:
861 #ifndef PROTECT_NAME
862 #define PROTECT_NAME
863 #endif
867 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
868 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
870 static int
871 inf_skip_spaces (int c)
873 for (;;)
875 if (c == ' ' || c == '\t')
876 c = INF_GET ();
877 else if (c == '/')
879 c = INF_GET ();
880 if (c != '*')
882 (void) INF_UNGET (c);
883 return '/';
885 c = INF_GET ();
886 for (;;)
888 if (c == EOF)
889 return EOF;
890 else if (c != '*')
892 if (c == '\n')
893 source_lineno++, lineno++;
894 c = INF_GET ();
896 else if ((c = INF_GET ()) == '/')
897 return INF_GET ();
900 else
901 break;
903 return c;
906 /* Read into STR from inf_buffer upto DELIM. */
908 static int
909 inf_read_upto (sstring *str, int delim)
911 int ch;
912 for (;;)
914 ch = INF_GET ();
915 if (ch == EOF || ch == delim)
916 break;
917 SSTRING_PUT (str, ch);
919 MAKE_SSTRING_SPACE (str, 1);
920 *str->ptr = 0;
921 return ch;
924 static int
925 inf_scan_ident (sstring *s, int c)
927 s->ptr = s->base;
928 if (ISIDST (c))
930 for (;;)
932 SSTRING_PUT (s, c);
933 c = INF_GET ();
934 if (c == EOF || !(ISIDNUM (c)))
935 break;
938 MAKE_SSTRING_SPACE (s, 1);
939 *s->ptr = 0;
940 return c;
943 /* Returns 1 if the file is correctly protected against multiple
944 inclusion, setting *ifndef_line to the line number of the initial #ifndef
945 and setting *endif_line to the final #endif.
946 Otherwise return 0. */
948 static int
949 check_protection (int *ifndef_line, int *endif_line)
951 int c;
952 int if_nesting = 1; /* Level of nesting of #if's */
953 char *protect_name = NULL; /* Identifier following initial #ifndef */
954 int define_seen = 0;
956 /* Skip initial white space (including comments). */
957 for (;; lineno++)
959 c = inf_skip_spaces (' ');
960 if (c == EOF)
961 return 0;
962 if (c != '\n')
963 break;
965 if (c != '#')
966 return 0;
967 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
968 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
969 return 0;
971 /* So far so good: We've seen an initial #ifndef. */
972 *ifndef_line = lineno;
973 c = inf_scan_ident (&buf, inf_skip_spaces (c));
974 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
975 return 0;
976 protect_name = xstrdup (buf.base);
978 (void) INF_UNGET (c);
979 c = inf_read_upto (&buf, '\n');
980 if (c == EOF)
981 return 0;
982 lineno++;
984 for (;;)
986 c = inf_skip_spaces (' ');
987 if (c == EOF)
988 return 0;
989 if (c == '\n')
991 lineno++;
992 continue;
994 if (c != '#')
995 goto skip_to_eol;
996 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
997 if (SSTRING_LENGTH (&buf) == 0)
999 else if (!strcmp (buf.base, "ifndef")
1000 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1002 if_nesting++;
1004 else if (!strcmp (buf.base, "endif"))
1006 if_nesting--;
1007 if (if_nesting == 0)
1008 break;
1010 else if (!strcmp (buf.base, "else"))
1012 if (if_nesting == 1)
1013 return 0;
1015 else if (!strcmp (buf.base, "define"))
1017 c = inf_skip_spaces (c);
1018 c = inf_scan_ident (&buf, c);
1019 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1020 define_seen = 1;
1022 skip_to_eol:
1023 for (;;)
1025 if (c == '\n' || c == EOF)
1026 break;
1027 c = INF_GET ();
1029 if (c == EOF)
1030 return 0;
1031 lineno++;
1034 if (!define_seen)
1035 return 0;
1036 *endif_line = lineno;
1037 /* Skip final white space (including comments). */
1038 for (;;)
1040 c = inf_skip_spaces (' ');
1041 if (c == EOF)
1042 break;
1043 if (c != '\n')
1044 return 0;
1047 return 1;
1050 extern int main (int, char **);
1053 main (int argc, char **argv)
1055 int inf_fd;
1056 struct stat sbuf;
1057 int c;
1058 #ifdef FIXPROTO_IGNORE_LIST
1059 int i;
1060 #endif
1061 const char *cptr;
1062 int ifndef_line;
1063 int endif_line;
1064 long to_read;
1065 long int inf_size;
1066 struct symbol_list *cur_symbols;
1068 if (argv[0] && argv[0][0])
1070 char *p;
1072 progname = 0;
1073 for (p = argv[0]; *p; p++)
1074 if (*p == '/')
1075 progname = p;
1076 progname = progname ? progname+1 : argv[0];
1079 if (argc < 4)
1081 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1082 progname);
1083 exit (FATAL_EXIT_CODE);
1086 inc_filename = argv[1];
1087 inc_filename_length = strlen (inc_filename);
1089 #ifdef FIXPROTO_IGNORE_LIST
1090 for (i = 0; files_to_ignore[i] != NULL; i++)
1092 const char *const ignore_name = files_to_ignore[i];
1093 int ignore_len = strlen (ignore_name);
1094 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1096 if (ignore_name[ignore_len-1] == '/'
1097 || inc_filename[ignore_len] == '\0')
1099 if (verbose)
1100 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1101 exit (SUCCESS_EXIT_CODE);
1106 #endif
1108 if (strcmp (inc_filename, "sys/stat.h") == 0)
1109 special_file_handling = sys_stat_h;
1110 else if (strcmp (inc_filename, "errno.h") == 0)
1111 special_file_handling = errno_h, required_other++;
1112 else if (strcmp (inc_filename, "stdlib.h") == 0)
1113 special_file_handling = stdlib_h, required_other+=2;
1114 else if (strcmp (inc_filename, "stdio.h") == 0)
1115 special_file_handling = stdio_h;
1116 include_entry = std_include_table;
1117 while (include_entry->name != NULL
1118 && ((strcmp (include_entry->name, CONTINUED) == 0)
1119 || strcmp (inc_filename, include_entry->name) != 0))
1120 include_entry++;
1122 if (include_entry->name != NULL)
1124 const struct std_include_entry *entry;
1125 cur_symbol_table_size = 0;
1126 for (entry = include_entry; ;)
1128 if (entry->flags)
1129 add_symbols (entry->flags, entry->names);
1130 entry++;
1131 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1132 break;
1135 else
1136 symbol_table[0].names = NULL;
1138 /* Count and mark the prototypes required for this include file. */
1139 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1141 int name_len;
1142 if (cur_symbols->flags & MACRO_SYMBOL)
1143 continue;
1144 cptr = cur_symbols->names;
1145 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1147 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1148 required_unseen_count++;
1149 if (fn == NULL)
1150 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1151 else
1152 SET_REQUIRED (fn);
1156 read_scan_file (argv[2], argc - 4, argv + 4);
1158 inf_fd = open (argv[2], O_RDONLY, 0666);
1159 if (inf_fd < 0)
1161 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1162 progname, argv[2]);
1163 perror (NULL);
1164 exit (FATAL_EXIT_CODE);
1166 if (fstat (inf_fd, &sbuf) < 0)
1168 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1169 perror (NULL);
1170 exit (FATAL_EXIT_CODE);
1172 inf_size = sbuf.st_size;
1173 inf_buffer = xmalloc (inf_size + 2);
1174 inf_ptr = inf_buffer;
1176 to_read = inf_size;
1177 while (to_read > 0)
1179 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1180 if (i < 0)
1182 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1183 perror (NULL);
1184 exit (FATAL_EXIT_CODE);
1186 if (i == 0)
1188 inf_size -= to_read;
1189 break;
1191 to_read -= i;
1194 close (inf_fd);
1196 /* Inf_size may have changed if read was short (as on VMS) */
1197 inf_buffer[inf_size] = '\n';
1198 inf_buffer[inf_size + 1] = '\0';
1199 inf_limit = inf_buffer + inf_size;
1201 /* If file doesn't end with '\n', add one. */
1202 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1203 inf_limit++;
1205 unlink (argv[3]);
1206 outf = fopen (argv[3], "w");
1207 if (outf == NULL)
1209 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1210 progname, argv[3]);
1211 perror (NULL);
1212 exit (FATAL_EXIT_CODE);
1215 lineno = 1;
1217 if (check_protection (&ifndef_line, &endif_line))
1219 lbrac_line = ifndef_line+1;
1220 rbrac_line = endif_line;
1222 else
1224 lbrac_line = 1;
1225 rbrac_line = -1;
1228 /* Reset input file. */
1229 inf_ptr = inf_buffer;
1230 lineno = 1;
1232 for (;;)
1234 if (lineno == lbrac_line)
1235 write_lbrac ();
1236 if (lineno == rbrac_line)
1237 write_rbrac ();
1238 for (;;)
1240 struct fn_decl *fn;
1241 c = INF_GET ();
1242 if (c == EOF)
1243 break;
1244 if (ISIDST (c))
1246 c = inf_scan_ident (&buf, c);
1247 (void) INF_UNGET (c);
1248 fputs (buf.base, outf);
1249 fn = lookup_std_proto (buf.base, strlen (buf.base));
1250 /* We only want to edit the declaration matching the one
1251 seen by scan-decls, as there can be multiple
1252 declarations, selected by #ifdef __STDC__ or whatever. */
1253 if (fn && fn->partial && fn->partial->line_seen == lineno)
1255 c = inf_skip_spaces (' ');
1256 if (c == EOF)
1257 break;
1258 if (c == '(')
1260 c = inf_skip_spaces (' ');
1261 if (c == ')')
1263 fprintf (outf, " _PARAMS((%s))", fn->params);
1265 else
1267 putc ('(', outf);
1268 (void) INF_UNGET (c);
1271 else
1272 fprintf (outf, " %c", c);
1275 else
1277 putc (c, outf);
1278 if (c == '\n')
1279 break;
1282 if (c == EOF)
1283 break;
1284 lineno++;
1286 if (rbrac_line < 0)
1287 write_rbrac ();
1289 fclose (outf);
1291 return 0;
1295 static void
1296 v_fatal (const char *str, va_list ap)
1298 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1299 vfprintf (stderr, str, ap);
1300 fprintf (stderr, "\n");
1302 exit (FATAL_EXIT_CODE);
1305 static void
1306 fatal (const char *str, ...)
1308 va_list ap;
1310 va_start (ap, str);
1311 v_fatal (str, ap);
1312 va_end (ap);