* doc/extend.texi (ARM Built-in Functions): Replace with correct
[official-gcc.git] / gcc / fix-header.c
blob7b7aee3c3371ac198024726bd06d3cd5978d0076
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"
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 #ifdef TARGET_EXTRA_INCLUDES
88 static void hook_void_int(int u ATTRIBUTE_UNUSED) { }
90 struct target_c_incpath_s target_c_incpath = { hook_void_int };
91 #endif
93 struct line_maps line_table;
95 sstring buf;
97 int verbose = 0;
98 int partial_count = 0;
99 int warnings = 0;
101 #if ADD_MISSING_EXTERN_C
102 int missing_extern_C_count = 0;
103 #endif
105 #include "xsys-protos.h"
107 #ifdef FIXPROTO_IGNORE_LIST
108 /* This is a currently unused feature. */
110 /* List of files and directories to ignore.
111 A directory name (ending in '/') means ignore anything in that
112 directory. (It might be more efficient to do directory pruning
113 earlier in fixproto, but this is simpler and easier to customize.) */
115 static const char *const files_to_ignore[] = {
116 "X11/",
117 FIXPROTO_IGNORE_LIST
120 #endif
122 char *inf_buffer;
123 char *inf_limit;
124 char *inf_ptr;
125 static const char *cur_file;
127 /* Certain standard files get extra treatment */
129 enum special_file
131 no_special,
132 #ifdef errno_h
133 #undef errno_h
134 #endif
135 errno_h,
136 #ifdef stdio_h
137 #undef stdio_h
138 #endif
139 stdio_h,
140 #ifdef stdlib_h
141 #undef stdlib_h
142 #endif
143 stdlib_h,
144 #ifdef sys_stat_h
145 #undef sys_stat_h
146 #endif
147 sys_stat_h
150 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
151 by an empty name (i.e. by "\0\0"). */
153 typedef const char *namelist;
155 /* The following macros provide the bits for symbol_flags. */
156 typedef int symbol_flags;
158 /* Used to mark names defined in the ANSI/ISO C standard. */
159 #define ANSI_SYMBOL 1
161 /* We no longer massage include files for POSIX or XOPEN symbols,
162 as there are now several versions of the POSIX and XOPEN standards,
163 and it would be a maintenance nightmare for us to track them all.
164 Better to be compatible with the system include files. */
165 /*#define ADD_MISSING_POSIX 1 */
166 /*#define ADD_MISSING_XOPEN 1 */
168 #if ADD_MISSING_POSIX
169 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
170 #define POSIX1_SYMBOL 2
171 #define POSIX2_SYMBOL 4
172 #else
173 #define POSIX1_SYMBOL 0
174 #define POSIX2_SYMBOL 0
175 #endif
177 #if ADD_MISSING_XOPEN
178 /* Used to mark names defined in X/Open Portability Guide. */
179 #define XOPEN_SYMBOL 8
180 /* Used to mark names defined in X/Open UNIX Extensions. */
181 #define XOPEN_EXTENDED_SYMBOL 16
182 #else
183 #define XOPEN_SYMBOL 0
184 #define XOPEN_EXTENDED_SYMBOL 0
185 #endif
187 /* Used to indicate names that are not functions */
188 #define MACRO_SYMBOL 512
190 struct symbol_list {
191 symbol_flags flags;
192 namelist names;
195 #define SYMBOL_TABLE_SIZE 10
196 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
197 int cur_symbol_table_size;
199 static void add_symbols (symbol_flags, namelist);
200 static struct fn_decl *lookup_std_proto (const char *, int);
201 static void write_lbrac (void);
202 static void recognized_macro (const char *);
203 static void check_macro_names (cpp_reader *, namelist);
204 static void read_scan_file (char *, int, char **);
205 static void write_rbrac (void);
206 static int inf_skip_spaces (int);
207 static int inf_read_upto (sstring *, int);
208 static int inf_scan_ident (sstring *, int);
209 static int check_protection (int *, int *);
210 static void cb_file_change (cpp_reader *, const struct line_map *);
212 static void
213 add_symbols (symbol_flags flags, namelist names)
215 symbol_table[cur_symbol_table_size].flags = flags;
216 symbol_table[cur_symbol_table_size].names = names;
217 cur_symbol_table_size++;
218 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
219 fatal ("too many calls to add_symbols");
220 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
223 struct std_include_entry {
224 const char *const name;
225 const symbol_flags flags;
226 const namelist names;
229 const char NONE[] = ""; /* The empty namelist. */
231 /* Special name to indicate a continuation line in std_include_table. */
232 const char CONTINUED[] = "";
234 const struct std_include_entry *include_entry;
236 const struct std_include_entry std_include_table [] = {
237 { "ctype.h", ANSI_SYMBOL,
238 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
239 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
241 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
243 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
245 /* ANSI_SYMBOL is wrong, but ... */
246 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
247 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
248 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
249 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
250 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
252 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
254 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
255 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
257 /*{ "limit.h", ... provided by gcc }, */
259 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
261 { "math.h", ANSI_SYMBOL,
262 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
263 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
264 tan\0tanh\0" },
266 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
268 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
270 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
271 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
273 /* Left out signal() - its prototype is too complex for us!
274 Also left out "sigaction sigaddset sigdelset sigemptyset
275 sigfillset sigismember sigpending sigprocmask sigsuspend"
276 because these need sigset_t or struct sigaction.
277 Most systems that provide them will also declare them. */
278 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
280 { "stdio.h", ANSI_SYMBOL,
281 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
282 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
283 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
284 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
285 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
286 tmpnam\0ungetc\0" },
287 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
288 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
289 /* Should perhaps also handle NULL, EOF, ... ? */
291 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
292 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
293 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
294 Should perhaps also add NULL */
295 { "stdlib.h", ANSI_SYMBOL,
296 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
297 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
298 srand\0strtod\0strtol\0strtoul\0system\0" },
299 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
301 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
302 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
303 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
304 strtok\0strxfrm\0" },
305 /* Should perhaps also add NULL and size_t */
307 { "strings.h", XOPEN_EXTENDED_SYMBOL,
308 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
310 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
312 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
313 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
314 and many systems do have <sys/ioctl.h> but not <strops.h>. */
315 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
317 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
319 { "sys/stat.h", POSIX1_SYMBOL,
320 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
321 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
322 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
323 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
324 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
326 #if 0
327 /* How do we handle fd_set? */
328 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
329 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
330 #endif
332 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
333 /* "sys/types.h" add types (not in old g++-include) */
335 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
337 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
338 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
339 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
340 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
342 { "tar.h", POSIX1_SYMBOL, NONE },
344 { "termios.h", POSIX1_SYMBOL,
345 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
347 { "time.h", ANSI_SYMBOL,
348 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\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 if (i == i0)
401 abort ();
405 char *inc_filename;
406 int inc_filename_length;
407 const char *progname = "fix-header";
408 FILE *outf;
409 sstring line;
411 int lbrac_line, rbrac_line;
413 int required_unseen_count = 0;
414 int required_other = 0;
416 static void
417 write_lbrac (void)
419 if (partial_count)
421 fprintf (outf, "#ifndef _PARAMS\n");
422 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
423 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
424 fprintf (outf, "#else\n");
425 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
426 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
430 struct partial_proto
432 struct partial_proto *next;
433 struct fn_decl *fn;
434 int line_seen;
437 struct partial_proto *partial_proto_list = NULL;
439 struct partial_proto required_dummy_proto, seen_dummy_proto;
440 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
441 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
442 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
443 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
445 static void
446 recognized_macro (const char *fname)
448 /* The original include file defines fname as a macro. */
449 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
451 /* Since fname is a macro, don't require a prototype for it. */
452 if (fn)
454 if (REQUIRED (fn))
455 required_unseen_count--;
456 SET_SEEN (fn);
459 switch (special_file_handling)
461 case errno_h:
462 if (strcmp (fname, "errno") == 0 && !seen_errno)
463 seen_errno = 1, required_other--;
464 break;
465 case stdlib_h:
466 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
467 seen_EXIT_FAILURE = 1, required_other--;
468 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
469 seen_EXIT_SUCCESS = 1, required_other--;
470 break;
471 case sys_stat_h:
472 if (fname[0] == 'S' && fname[1] == '_')
474 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
475 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
476 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
477 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
478 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
479 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
480 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
481 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
482 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
483 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
484 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
485 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
487 break;
489 default:
490 break;
494 void
495 recognized_extern (const cpp_token *name)
497 switch (special_file_handling)
499 case errno_h:
500 if (cpp_ideq (name, "errno"))
501 seen_errno = 1, required_other--;
502 break;
504 default:
505 break;
509 /* Called by scan_decls if it saw a function definition for a function
510 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
511 function declaration preceded by 'extern "C"' (or nested inside
512 'extern "C"' braces); or 'f' for other function declarations. */
514 void
515 recognized_function (const cpp_token *fname, unsigned int line, int kind,
516 int have_arg_list)
518 struct partial_proto *partial;
519 int i;
520 struct fn_decl *fn;
522 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
523 NODE_LEN (fname->val.node));
525 /* Remove the function from the list of required function. */
526 if (fn)
528 if (REQUIRED (fn))
529 required_unseen_count--;
530 SET_SEEN (fn);
533 /* If we have a full prototype, we're done. */
534 if (have_arg_list)
535 return;
537 if (kind == 'I') /* don't edit inline function */
538 return;
540 /* If the partial prototype was included from some other file,
541 we don't need to patch it up (in this run). */
542 i = strlen (cur_file);
543 if (i < inc_filename_length
544 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
545 return;
547 if (fn == NULL)
548 return;
549 if (fn->params[0] == '\0')
550 return;
552 /* We only have a partial function declaration,
553 so remember that we have to add a complete prototype. */
554 partial_count++;
555 partial = obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
556 partial->line_seen = line;
557 partial->fn = fn;
558 fn->partial = partial;
559 partial->next = partial_proto_list;
560 partial_proto_list = partial;
561 if (verbose)
563 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
564 inc_filename, fn->fname);
568 /* For any name in NAMES that is defined as a macro,
569 call recognized_macro on it. */
571 static void
572 check_macro_names (cpp_reader *pfile, namelist names)
574 size_t len;
575 while (*names)
577 len = strlen (names);
578 if (cpp_defined (pfile, (const unsigned char *)names, len))
579 recognized_macro (names);
580 names += len + 1;
584 static void
585 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
586 const struct line_map *map)
588 /* Just keep track of current file name. */
589 cur_file = map == NULL ? NULL : map->to_file;
592 static void
593 read_scan_file (char *in_fname, int argc, char **argv)
595 cpp_reader *scan_in;
596 cpp_callbacks *cb;
597 cpp_options *options;
598 struct fn_decl *fn;
599 int i, strings_processed;
600 struct symbol_list *cur_symbols;
602 obstack_init (&scan_file_obstack);
604 linemap_init (&line_table);
605 scan_in = cpp_create_reader (CLK_GNUC89, NULL, &line_table);
606 cb = cpp_get_callbacks (scan_in);
607 cb->file_change = cb_file_change;
609 /* We are going to be scanning a header file out of its proper context,
610 so ignore warnings and errors. */
611 options = cpp_get_options (scan_in);
612 options->inhibit_warnings = 1;
613 options->inhibit_errors = 1;
614 cpp_post_options (scan_in);
616 if (!cpp_read_main_file (scan_in, in_fname))
617 exit (FATAL_EXIT_CODE);
619 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
620 cpp_init_builtins (scan_in, true);
621 cpp_change_file (scan_in, LC_RENAME, in_fname);
623 /* Process switches after builtins so -D can override them. */
624 for (i = 0; i < argc; i += strings_processed)
626 strings_processed = 0;
627 if (argv[i][0] == '-')
629 if (argv[i][1] == 'I')
631 if (argv[i][2] != '\0')
633 strings_processed = 1;
634 add_path (xstrdup (argv[i] + 2), BRACKET, false);
636 else if (i + 1 != argc)
638 strings_processed = 2;
639 add_path (xstrdup (argv[i + 1]), BRACKET, false);
642 else if (argv[i][1] == 'D')
644 if (argv[i][2] != '\0')
645 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
646 else if (i + 1 != argc)
647 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
651 if (strings_processed == 0)
652 break;
655 if (i < argc)
656 cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
657 if (cpp_errors (scan_in))
658 exit (FATAL_EXIT_CODE);
660 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
661 true /* stdinc */, false /* cxx_stdinc */,
662 false /* verbose */);
664 /* We are scanning a system header, so mark it as such. */
665 cpp_make_system_header (scan_in, 1, 0);
667 scan_decls (scan_in, argc, argv);
668 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
669 check_macro_names (scan_in, cur_symbols->names);
671 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
672 If so, those functions are also required. */
673 if (special_file_handling == stdio_h
674 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
676 unsigned char getchar_call[] = "getchar();\n";
677 int seen_filbuf = 0;
679 /* Scan the macro expansion of "getchar();". */
680 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
681 /* from_stage3 */ true);
682 for (;;)
684 const cpp_token *t = cpp_get_token (scan_in);
686 if (t->type == CPP_EOF)
687 break;
688 else if (cpp_ideq (t, "_filbuf"))
689 seen_filbuf++;
692 if (seen_filbuf)
694 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
695 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
696 int need_flsbuf
697 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
699 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
700 if (need_filbuf + need_flsbuf)
702 const char *new_list;
703 if (need_filbuf)
704 SET_REQUIRED (fn);
705 if (need_flsbuf)
706 SET_REQUIRED (flsbuf_fn);
707 if (need_flsbuf && need_filbuf)
708 new_list = "_filbuf\0_flsbuf\0";
709 else if (need_flsbuf)
710 new_list = "_flsbuf\0";
711 else /* if (need_flsbuf) */
712 new_list = "_filbuf\0";
713 add_symbols (ANSI_SYMBOL, new_list);
714 required_unseen_count += need_filbuf + need_flsbuf;
719 if (required_unseen_count + partial_count + required_other == 0)
721 if (verbose)
722 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
723 exit (SUCCESS_EXIT_CODE);
725 if (!verbose)
726 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
727 else
729 if (required_unseen_count)
730 fprintf (stderr, "%s: %d missing function declarations.\n",
731 inc_filename, required_unseen_count);
732 if (partial_count)
733 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
734 inc_filename, partial_count);
738 static void
739 write_rbrac (void)
741 struct fn_decl *fn;
742 const char *cptr;
743 struct symbol_list *cur_symbols;
745 if (required_unseen_count)
747 #ifdef NO_IMPLICIT_EXTERN_C
748 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
749 #endif
752 /* Now we print out prototypes for those functions that we haven't seen. */
753 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
755 int if_was_emitted = 0;
756 int name_len;
757 cptr = cur_symbols->names;
758 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
760 int macro_protect = 0;
762 if (cur_symbols->flags & MACRO_SYMBOL)
763 continue;
765 fn = lookup_std_proto (cptr, name_len);
766 if (fn == NULL || !REQUIRED (fn))
767 continue;
769 if (!if_was_emitted)
771 /* what about curses. ??? or _flsbuf/_filbuf ??? */
772 if (cur_symbols->flags & ANSI_SYMBOL)
773 fprintf (outf,
774 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
775 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
776 fprintf (outf,
777 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
778 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
779 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
780 else if (cur_symbols->flags & XOPEN_SYMBOL)
782 fprintf (outf,
783 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
784 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
786 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
788 fprintf (outf,
789 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
790 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
792 else
794 fatal ("internal error for function %s", fn->fname);
796 if_was_emitted = 1;
799 /* In the case of memmove, protect in case the application
800 defines it as a macro before including the header. */
801 if (!strcmp (fn->fname, "memmove")
802 || !strcmp (fn->fname, "putc")
803 || !strcmp (fn->fname, "getc")
804 || !strcmp (fn->fname, "vprintf")
805 || !strcmp (fn->fname, "vfprintf")
806 || !strcmp (fn->fname, "vsprintf")
807 || !strcmp (fn->fname, "rewinddir")
808 || !strcmp (fn->fname, "abort"))
809 macro_protect = 1;
811 if (macro_protect)
812 fprintf (outf, "#ifndef %s\n", fn->fname);
813 fprintf (outf, "extern %s %s (%s);\n",
814 fn->rtype, fn->fname, fn->params);
815 if (macro_protect)
816 fprintf (outf, "#endif\n");
818 if (if_was_emitted)
819 fprintf (outf,
820 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
822 if (required_unseen_count)
824 #ifdef NO_IMPLICIT_EXTERN_C
825 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
826 #endif
829 switch (special_file_handling)
831 case errno_h:
832 if (!seen_errno)
833 fprintf (outf, "extern int errno;\n");
834 break;
835 case stdlib_h:
836 if (!seen_EXIT_FAILURE)
837 fprintf (outf, "#define EXIT_FAILURE 1\n");
838 if (!seen_EXIT_SUCCESS)
839 fprintf (outf, "#define EXIT_SUCCESS 0\n");
840 break;
841 case sys_stat_h:
842 if (!seen_S_ISBLK && seen_S_IFBLK)
843 fprintf (outf,
844 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
845 if (!seen_S_ISCHR && seen_S_IFCHR)
846 fprintf (outf,
847 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
848 if (!seen_S_ISDIR && seen_S_IFDIR)
849 fprintf (outf,
850 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
851 if (!seen_S_ISFIFO && seen_S_IFIFO)
852 fprintf (outf,
853 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
854 if (!seen_S_ISLNK && seen_S_IFLNK)
855 fprintf (outf,
856 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
857 if (!seen_S_ISREG && seen_S_IFREG)
858 fprintf (outf,
859 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
860 break;
862 default:
863 break;
868 /* Returns 1 iff the file is properly protected from multiple inclusion:
869 #ifndef PROTECT_NAME
870 #define PROTECT_NAME
871 #endif
875 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
876 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
878 static int
879 inf_skip_spaces (int c)
881 for (;;)
883 if (c == ' ' || c == '\t')
884 c = INF_GET ();
885 else if (c == '/')
887 c = INF_GET ();
888 if (c != '*')
890 (void) INF_UNGET (c);
891 return '/';
893 c = INF_GET ();
894 for (;;)
896 if (c == EOF)
897 return EOF;
898 else if (c != '*')
900 if (c == '\n')
901 source_lineno++, lineno++;
902 c = INF_GET ();
904 else if ((c = INF_GET ()) == '/')
905 return INF_GET ();
908 else
909 break;
911 return c;
914 /* Read into STR from inf_buffer upto DELIM. */
916 static int
917 inf_read_upto (sstring *str, int delim)
919 int ch;
920 for (;;)
922 ch = INF_GET ();
923 if (ch == EOF || ch == delim)
924 break;
925 SSTRING_PUT (str, ch);
927 MAKE_SSTRING_SPACE (str, 1);
928 *str->ptr = 0;
929 return ch;
932 static int
933 inf_scan_ident (sstring *s, int c)
935 s->ptr = s->base;
936 if (ISIDST (c))
938 for (;;)
940 SSTRING_PUT (s, c);
941 c = INF_GET ();
942 if (c == EOF || !(ISIDNUM (c)))
943 break;
946 MAKE_SSTRING_SPACE (s, 1);
947 *s->ptr = 0;
948 return c;
951 /* Returns 1 if the file is correctly protected against multiple
952 inclusion, setting *ifndef_line to the line number of the initial #ifndef
953 and setting *endif_line to the final #endif.
954 Otherwise return 0. */
956 static int
957 check_protection (int *ifndef_line, int *endif_line)
959 int c;
960 int if_nesting = 1; /* Level of nesting of #if's */
961 char *protect_name = NULL; /* Identifier following initial #ifndef */
962 int define_seen = 0;
964 /* Skip initial white space (including comments). */
965 for (;; lineno++)
967 c = inf_skip_spaces (' ');
968 if (c == EOF)
969 return 0;
970 if (c != '\n')
971 break;
973 if (c != '#')
974 return 0;
975 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
976 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
977 return 0;
979 /* So far so good: We've seen an initial #ifndef. */
980 *ifndef_line = lineno;
981 c = inf_scan_ident (&buf, inf_skip_spaces (c));
982 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
983 return 0;
984 protect_name = xstrdup (buf.base);
986 (void) INF_UNGET (c);
987 c = inf_read_upto (&buf, '\n');
988 if (c == EOF)
989 return 0;
990 lineno++;
992 for (;;)
994 c = inf_skip_spaces (' ');
995 if (c == EOF)
996 return 0;
997 if (c == '\n')
999 lineno++;
1000 continue;
1002 if (c != '#')
1003 goto skip_to_eol;
1004 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1005 if (SSTRING_LENGTH (&buf) == 0)
1007 else if (!strcmp (buf.base, "ifndef")
1008 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1010 if_nesting++;
1012 else if (!strcmp (buf.base, "endif"))
1014 if_nesting--;
1015 if (if_nesting == 0)
1016 break;
1018 else if (!strcmp (buf.base, "else"))
1020 if (if_nesting == 1)
1021 return 0;
1023 else if (!strcmp (buf.base, "define"))
1025 c = inf_skip_spaces (c);
1026 c = inf_scan_ident (&buf, c);
1027 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1028 define_seen = 1;
1030 skip_to_eol:
1031 for (;;)
1033 if (c == '\n' || c == EOF)
1034 break;
1035 c = INF_GET ();
1037 if (c == EOF)
1038 return 0;
1039 lineno++;
1042 if (!define_seen)
1043 return 0;
1044 *endif_line = lineno;
1045 /* Skip final white space (including comments). */
1046 for (;;)
1048 c = inf_skip_spaces (' ');
1049 if (c == EOF)
1050 break;
1051 if (c != '\n')
1052 return 0;
1055 return 1;
1058 extern int main (int, char **);
1061 main (int argc, char **argv)
1063 int inf_fd;
1064 struct stat sbuf;
1065 int c;
1066 #ifdef FIXPROTO_IGNORE_LIST
1067 int i;
1068 #endif
1069 const char *cptr;
1070 int ifndef_line;
1071 int endif_line;
1072 long to_read;
1073 long int inf_size;
1074 struct symbol_list *cur_symbols;
1076 if (argv[0] && argv[0][0])
1078 char *p;
1080 progname = 0;
1081 for (p = argv[0]; *p; p++)
1082 if (*p == '/')
1083 progname = p;
1084 progname = progname ? progname+1 : argv[0];
1087 if (argc < 4)
1089 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1090 progname);
1091 exit (FATAL_EXIT_CODE);
1094 inc_filename = argv[1];
1095 inc_filename_length = strlen (inc_filename);
1097 #ifdef FIXPROTO_IGNORE_LIST
1098 for (i = 0; files_to_ignore[i] != NULL; i++)
1100 const char *const ignore_name = files_to_ignore[i];
1101 int ignore_len = strlen (ignore_name);
1102 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1104 if (ignore_name[ignore_len-1] == '/'
1105 || inc_filename[ignore_len] == '\0')
1107 if (verbose)
1108 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1109 exit (SUCCESS_EXIT_CODE);
1114 #endif
1116 if (strcmp (inc_filename, "sys/stat.h") == 0)
1117 special_file_handling = sys_stat_h;
1118 else if (strcmp (inc_filename, "errno.h") == 0)
1119 special_file_handling = errno_h, required_other++;
1120 else if (strcmp (inc_filename, "stdlib.h") == 0)
1121 special_file_handling = stdlib_h, required_other+=2;
1122 else if (strcmp (inc_filename, "stdio.h") == 0)
1123 special_file_handling = stdio_h;
1124 include_entry = std_include_table;
1125 while (include_entry->name != NULL
1126 && ((strcmp (include_entry->name, CONTINUED) == 0)
1127 || strcmp (inc_filename, include_entry->name) != 0))
1128 include_entry++;
1130 if (include_entry->name != NULL)
1132 const struct std_include_entry *entry;
1133 cur_symbol_table_size = 0;
1134 for (entry = include_entry; ;)
1136 if (entry->flags)
1137 add_symbols (entry->flags, entry->names);
1138 entry++;
1139 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1140 break;
1143 else
1144 symbol_table[0].names = NULL;
1146 /* Count and mark the prototypes required for this include file. */
1147 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1149 int name_len;
1150 if (cur_symbols->flags & MACRO_SYMBOL)
1151 continue;
1152 cptr = cur_symbols->names;
1153 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1155 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1156 required_unseen_count++;
1157 if (fn == NULL)
1158 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1159 else
1160 SET_REQUIRED (fn);
1164 read_scan_file (argv[2], argc - 4, argv + 4);
1166 inf_fd = open (argv[2], O_RDONLY, 0666);
1167 if (inf_fd < 0)
1169 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1170 progname, argv[2]);
1171 perror (NULL);
1172 exit (FATAL_EXIT_CODE);
1174 if (fstat (inf_fd, &sbuf) < 0)
1176 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1177 perror (NULL);
1178 exit (FATAL_EXIT_CODE);
1180 inf_size = sbuf.st_size;
1181 inf_buffer = xmalloc (inf_size + 2);
1182 inf_ptr = inf_buffer;
1184 to_read = inf_size;
1185 while (to_read > 0)
1187 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1188 if (i < 0)
1190 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1191 perror (NULL);
1192 exit (FATAL_EXIT_CODE);
1194 if (i == 0)
1196 inf_size -= to_read;
1197 break;
1199 to_read -= i;
1202 close (inf_fd);
1204 /* Inf_size may have changed if read was short (as on VMS) */
1205 inf_buffer[inf_size] = '\n';
1206 inf_buffer[inf_size + 1] = '\0';
1207 inf_limit = inf_buffer + inf_size;
1209 /* If file doesn't end with '\n', add one. */
1210 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1211 inf_limit++;
1213 unlink (argv[3]);
1214 outf = fopen (argv[3], "w");
1215 if (outf == NULL)
1217 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1218 progname, argv[3]);
1219 perror (NULL);
1220 exit (FATAL_EXIT_CODE);
1223 lineno = 1;
1225 if (check_protection (&ifndef_line, &endif_line))
1227 lbrac_line = ifndef_line+1;
1228 rbrac_line = endif_line;
1230 else
1232 lbrac_line = 1;
1233 rbrac_line = -1;
1236 /* Reset input file. */
1237 inf_ptr = inf_buffer;
1238 lineno = 1;
1240 for (;;)
1242 if (lineno == lbrac_line)
1243 write_lbrac ();
1244 if (lineno == rbrac_line)
1245 write_rbrac ();
1246 for (;;)
1248 struct fn_decl *fn;
1249 c = INF_GET ();
1250 if (c == EOF)
1251 break;
1252 if (ISIDST (c))
1254 c = inf_scan_ident (&buf, c);
1255 (void) INF_UNGET (c);
1256 fputs (buf.base, outf);
1257 fn = lookup_std_proto (buf.base, strlen (buf.base));
1258 /* We only want to edit the declaration matching the one
1259 seen by scan-decls, as there can be multiple
1260 declarations, selected by #ifdef __STDC__ or whatever. */
1261 if (fn && fn->partial && fn->partial->line_seen == lineno)
1263 c = inf_skip_spaces (' ');
1264 if (c == EOF)
1265 break;
1266 if (c == '(')
1268 c = inf_skip_spaces (' ');
1269 if (c == ')')
1271 fprintf (outf, " _PARAMS((%s))", fn->params);
1273 else
1275 putc ('(', outf);
1276 (void) INF_UNGET (c);
1279 else
1280 fprintf (outf, " %c", c);
1283 else
1285 putc (c, outf);
1286 if (c == '\n')
1287 break;
1290 if (c == EOF)
1291 break;
1292 lineno++;
1294 if (rbrac_line < 0)
1295 write_rbrac ();
1297 fclose (outf);
1299 return 0;
1303 static void
1304 v_fatal (const char *str, va_list ap)
1306 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1307 vfprintf (stderr, str, ap);
1308 fprintf (stderr, "\n");
1310 exit (FATAL_EXIT_CODE);
1313 static void
1314 fatal (const char *str, ...)
1316 va_list ap;
1318 va_start (ap, str);
1319 v_fatal (str, ap);
1320 va_end (ap);