1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2006, 2007 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 3, or (at your option) any
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; see the file COPYING3. If not see
17 <http://www.gnu.org/licenses/>. */
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:
41 <body of include file>
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
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.
63 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
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. */
76 #include "coretypes.h"
84 #ifdef TARGET_EXTRA_INCLUDES
86 TARGET_EXTRA_INCLUDES (const char *sysroot ATTRIBUTE_UNUSED,
87 const char *iprefix ATTRIBUTE_UNUSED,
88 int stdinc ATTRIBUTE_UNUSED)
93 #ifdef TARGET_EXTRA_PRE_INCLUDES
95 TARGET_EXTRA_PRE_INCLUDES (const char *sysroot ATTRIBUTE_UNUSED,
96 const char *iprefix ATTRIBUTE_UNUSED,
97 int stdinc ATTRIBUTE_UNUSED)
102 struct line_maps line_table;
107 int partial_count = 0;
110 #if ADD_MISSING_EXTERN_C
111 int missing_extern_C_count = 0;
114 #include "xsys-protos.h"
116 #ifdef FIXPROTO_IGNORE_LIST
117 /* This is a currently unused feature. */
119 /* List of files and directories to ignore.
120 A directory name (ending in '/') means ignore anything in that
121 directory. (It might be more efficient to do directory pruning
122 earlier in fixproto, but this is simpler and easier to customize.) */
124 static const char *const files_to_ignore[] = {
134 static const char *cur_file;
136 /* Certain standard files get extra treatment */
159 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
160 by an empty name (i.e. by "\0\0"). */
162 typedef const char *namelist;
164 /* The following macros provide the bits for symbol_flags. */
165 typedef int symbol_flags;
167 /* Used to mark names defined in the ANSI/ISO C standard. */
168 #define ANSI_SYMBOL 1
170 /* We no longer massage include files for POSIX or XOPEN symbols,
171 as there are now several versions of the POSIX and XOPEN standards,
172 and it would be a maintenance nightmare for us to track them all.
173 Better to be compatible with the system include files. */
174 /*#define ADD_MISSING_POSIX 1 */
175 /*#define ADD_MISSING_XOPEN 1 */
177 #if ADD_MISSING_POSIX
178 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
179 #define POSIX1_SYMBOL 2
180 #define POSIX2_SYMBOL 4
182 #define POSIX1_SYMBOL 0
183 #define POSIX2_SYMBOL 0
186 #if ADD_MISSING_XOPEN
187 /* Used to mark names defined in X/Open Portability Guide. */
188 #define XOPEN_SYMBOL 8
189 /* Used to mark names defined in X/Open UNIX Extensions. */
190 #define XOPEN_EXTENDED_SYMBOL 16
192 #define XOPEN_SYMBOL 0
193 #define XOPEN_EXTENDED_SYMBOL 0
196 /* Used to indicate names that are not functions */
197 #define MACRO_SYMBOL 512
204 #define SYMBOL_TABLE_SIZE 10
205 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
206 int cur_symbol_table_size;
208 static void add_symbols (symbol_flags, namelist);
209 static struct fn_decl *lookup_std_proto (const char *, int);
210 static void write_lbrac (void);
211 static void recognized_macro (const char *);
212 static void check_macro_names (cpp_reader *, namelist);
213 static void read_scan_file (char *, int, char **);
214 static void write_rbrac (void);
215 static int inf_skip_spaces (int);
216 static int inf_read_upto (sstring *, int);
217 static int inf_scan_ident (sstring *, int);
218 static int check_protection (int *, int *);
219 static void cb_file_change (cpp_reader *, const struct line_map *);
222 add_symbols (symbol_flags flags, namelist names)
224 symbol_table[cur_symbol_table_size].flags = flags;
225 symbol_table[cur_symbol_table_size].names = names;
226 cur_symbol_table_size++;
227 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
228 fatal ("too many calls to add_symbols");
229 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
232 struct std_include_entry {
233 const char *const name;
234 const symbol_flags flags;
235 const namelist names;
238 const char NONE[] = ""; /* The empty namelist. */
240 /* Special name to indicate a continuation line in std_include_table. */
241 const char CONTINUED[] = "";
243 const struct std_include_entry *include_entry;
245 const struct std_include_entry std_include_table [] = {
246 { "ctype.h", ANSI_SYMBOL,
247 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
248 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
250 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
252 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
254 /* ANSI_SYMBOL is wrong, but ... */
255 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
256 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
257 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
258 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
259 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
261 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
263 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
264 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
266 /*{ "limit.h", ... provided by gcc }, */
268 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
270 { "math.h", ANSI_SYMBOL,
271 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
272 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
275 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
277 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
279 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
280 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
282 /* Left out signal() - its prototype is too complex for us!
283 Also left out "sigaction sigaddset sigdelset sigemptyset
284 sigfillset sigismember sigpending sigprocmask sigsuspend"
285 because these need sigset_t or struct sigaction.
286 Most systems that provide them will also declare them. */
287 { "signal.h", ANSI_SYMBOL, "raise\0" },
288 { CONTINUED, POSIX1_SYMBOL, "kill\0" },
290 { "stdio.h", ANSI_SYMBOL,
291 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
292 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
293 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
294 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
295 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
297 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
298 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
299 /* Should perhaps also handle NULL, EOF, ... ? */
301 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
302 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
303 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
304 Should perhaps also add NULL */
305 { "stdlib.h", ANSI_SYMBOL,
306 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
307 exit\0free\0getenv\0labs\0malloc\0qsort\0rand\0realloc\0\
308 srand\0strtod\0strtol\0strtoul\0system\0" },
309 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
310 { CONTINUED, POSIX1_SYMBOL, "putenv\0" },
312 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
313 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
314 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
315 strtok\0strxfrm\0" },
316 /* Should perhaps also add NULL and size_t */
318 { "strings.h", XOPEN_EXTENDED_SYMBOL,
319 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
321 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
323 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
324 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
325 and many systems do have <sys/ioctl.h> but not <strops.h>. */
326 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
328 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
330 { "sys/stat.h", POSIX1_SYMBOL,
331 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
332 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
333 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
334 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
335 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
338 /* How do we handle fd_set? */
339 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
340 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
343 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
344 /* "sys/types.h" add types (not in old g++-include) */
346 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
348 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
349 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
350 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
351 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
353 { "tar.h", POSIX1_SYMBOL, NONE },
355 { "termios.h", POSIX1_SYMBOL,
356 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
358 { "time.h", ANSI_SYMBOL,
359 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0" },
360 { CONTINUED, POSIX1_SYMBOL, "tzset\0" },
362 { "unistd.h", POSIX1_SYMBOL,
363 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
364 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
365 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
366 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
367 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
368 ttyname\0unlink\0write\0" },
369 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
370 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
371 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
373 { "utime.h", POSIX1_SYMBOL, "utime\0" },
378 enum special_file special_file_handling = no_special;
380 /* They are set if the corresponding macro has been seen. */
381 /* The following are only used when handling sys/stat.h */
382 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
383 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
384 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
385 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
386 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
387 int seen_S_IFREG = 0, seen_S_ISREG = 0;
388 /* The following are only used when handling errno.h */
390 /* The following are only used when handling stdlib.h */
391 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
393 struct obstack scan_file_obstack;
395 /* NOTE: If you edit this, also edit gen-protos.c !! */
397 static struct fn_decl *
398 lookup_std_proto (const char *name, int name_length)
400 int i = hashstr (name, name_length) % HASH_SIZE;
405 if (hash_tab[i] == 0)
407 fn = &std_protos[hash_tab[i]];
408 if ((int) strlen (fn->fname) == name_length
409 && strncmp (fn->fname, name, name_length) == 0)
411 i = (i+1) % HASH_SIZE;
412 gcc_assert (i != i0);
417 int inc_filename_length;
421 int lbrac_line, rbrac_line;
423 int required_unseen_count = 0;
424 int required_other = 0;
431 fprintf (outf, "#ifndef _PARAMS\n");
432 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
433 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
434 fprintf (outf, "#else\n");
435 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
436 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
442 struct partial_proto *next;
447 struct partial_proto *partial_proto_list = NULL;
449 struct partial_proto required_dummy_proto, seen_dummy_proto;
450 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
451 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
452 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
453 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
456 recognized_macro (const char *fname)
458 /* The original include file defines fname as a macro. */
459 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
461 /* Since fname is a macro, don't require a prototype for it. */
465 required_unseen_count--;
469 switch (special_file_handling)
472 if (strcmp (fname, "errno") == 0 && !seen_errno)
473 seen_errno = 1, required_other--;
476 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
477 seen_EXIT_FAILURE = 1, required_other--;
478 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
479 seen_EXIT_SUCCESS = 1, required_other--;
482 if (fname[0] == 'S' && fname[1] == '_')
484 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
485 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
486 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
487 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
488 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
489 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
490 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
491 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
492 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
493 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
494 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
495 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
505 recognized_extern (const cpp_token *name)
507 switch (special_file_handling)
510 if (cpp_ideq (name, "errno"))
511 seen_errno = 1, required_other--;
519 /* Called by scan_decls if it saw a function definition for a function
520 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
521 function declaration preceded by 'extern "C"' (or nested inside
522 'extern "C"' braces); or 'f' for other function declarations. */
525 recognized_function (const cpp_token *fname, unsigned int line, int kind,
528 struct partial_proto *partial;
532 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
533 NODE_LEN (fname->val.node));
535 /* Remove the function from the list of required function. */
539 required_unseen_count--;
543 /* If we have a full prototype, we're done. */
547 if (kind == 'I') /* don't edit inline function */
550 /* If the partial prototype was included from some other file,
551 we don't need to patch it up (in this run). */
552 i = strlen (cur_file);
553 if (i < inc_filename_length
554 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
559 if (fn->params[0] == '\0')
562 /* We only have a partial function declaration,
563 so remember that we have to add a complete prototype. */
566 = (struct partial_proto *)
567 obstack_alloc (&scan_file_obstack,
568 sizeof (struct partial_proto));
569 partial->line_seen = line;
571 fn->partial = partial;
572 partial->next = partial_proto_list;
573 partial_proto_list = partial;
576 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
577 inc_filename, fn->fname);
581 /* For any name in NAMES that is defined as a macro,
582 call recognized_macro on it. */
585 check_macro_names (cpp_reader *pfile, namelist names)
590 len = strlen (names);
591 if (cpp_defined (pfile, (const unsigned char *)names, len))
592 recognized_macro (names);
598 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
599 const struct line_map *map)
601 /* Just keep track of current file name. */
602 cur_file = map == NULL ? NULL : map->to_file;
606 read_scan_file (char *in_fname, int argc, char **argv)
610 cpp_options *options;
612 int i, strings_processed;
613 struct symbol_list *cur_symbols;
615 obstack_init (&scan_file_obstack);
617 linemap_init (&line_table);
618 scan_in = cpp_create_reader (CLK_GNUC89, NULL, &line_table);
619 cb = cpp_get_callbacks (scan_in);
620 cb->file_change = cb_file_change;
622 /* We are going to be scanning a header file out of its proper context,
623 so ignore warnings and errors. */
624 options = cpp_get_options (scan_in);
625 options->inhibit_warnings = 1;
626 options->inhibit_errors = 1;
627 cpp_post_options (scan_in);
629 if (!cpp_read_main_file (scan_in, in_fname))
630 exit (FATAL_EXIT_CODE);
632 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
633 cpp_init_builtins (scan_in, true);
634 cpp_change_file (scan_in, LC_RENAME, in_fname);
636 /* Process switches after builtins so -D can override them. */
637 for (i = 0; i < argc; i += strings_processed)
639 strings_processed = 0;
640 if (argv[i][0] == '-')
642 if (argv[i][1] == 'I')
644 if (argv[i][2] != '\0')
646 strings_processed = 1;
647 add_path (xstrdup (argv[i] + 2), BRACKET, false, false);
649 else if (i + 1 != argc)
651 strings_processed = 2;
652 add_path (xstrdup (argv[i + 1]), BRACKET, false, false);
655 else if (argv[i][1] == 'D')
657 if (argv[i][2] != '\0')
658 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
659 else if (i + 1 != argc)
660 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
664 if (strings_processed == 0)
669 cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
670 if (cpp_errors (scan_in))
671 exit (FATAL_EXIT_CODE);
673 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
674 NULL /* imultilib */, true /* stdinc */,
675 false /* cxx_stdinc */, false /* verbose */);
677 /* We are scanning a system header, so mark it as such. */
678 cpp_make_system_header (scan_in, 1, 0);
680 scan_decls (scan_in, argc, argv);
681 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
682 check_macro_names (scan_in, cur_symbols->names);
684 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
685 If so, those functions are also required. */
686 if (special_file_handling == stdio_h
687 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
689 unsigned char getchar_call[] = "getchar();\n";
692 /* Scan the macro expansion of "getchar();". */
693 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
694 /* from_stage3 */ true);
697 const cpp_token *t = cpp_get_token (scan_in);
699 if (t->type == CPP_EOF)
701 else if (cpp_ideq (t, "_filbuf"))
707 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
708 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
710 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
712 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
713 if (need_filbuf + need_flsbuf)
715 const char *new_list;
719 SET_REQUIRED (flsbuf_fn);
720 if (need_flsbuf && need_filbuf)
721 new_list = "_filbuf\0_flsbuf\0";
722 else if (need_flsbuf)
723 new_list = "_flsbuf\0";
724 else /* if (need_flsbuf) */
725 new_list = "_filbuf\0";
726 add_symbols (ANSI_SYMBOL, new_list);
727 required_unseen_count += need_filbuf + need_flsbuf;
732 if (required_unseen_count + partial_count + required_other == 0)
735 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
736 exit (SUCCESS_EXIT_CODE);
739 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
742 if (required_unseen_count)
743 fprintf (stderr, "%s: %d missing function declarations.\n",
744 inc_filename, required_unseen_count);
746 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
747 inc_filename, partial_count);
756 struct symbol_list *cur_symbols;
758 if (required_unseen_count)
760 #ifdef NO_IMPLICIT_EXTERN_C
761 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
765 /* Now we print out prototypes for those functions that we haven't seen. */
766 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
768 int if_was_emitted = 0;
770 cptr = cur_symbols->names;
771 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
773 int macro_protect = 0;
775 if (cur_symbols->flags & MACRO_SYMBOL)
778 fn = lookup_std_proto (cptr, name_len);
779 if (fn == NULL || !REQUIRED (fn))
784 /* what about curses. ??? or _flsbuf/_filbuf ??? */
785 if (cur_symbols->flags & ANSI_SYMBOL)
787 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
788 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
790 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
791 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
792 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
793 else if (cur_symbols->flags & XOPEN_SYMBOL)
796 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
797 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
799 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
802 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
803 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
807 fatal ("internal error for function %s", fn->fname);
812 /* In the case of memmove, protect in case the application
813 defines it as a macro before including the header. */
814 if (!strcmp (fn->fname, "memmove")
815 || !strcmp (fn->fname, "putc")
816 || !strcmp (fn->fname, "getc")
817 || !strcmp (fn->fname, "vprintf")
818 || !strcmp (fn->fname, "vfprintf")
819 || !strcmp (fn->fname, "vsprintf")
820 || !strcmp (fn->fname, "rewinddir")
821 || !strcmp (fn->fname, "abort"))
825 fprintf (outf, "#ifndef %s\n", fn->fname);
826 fprintf (outf, "extern %s %s (%s);\n",
827 fn->rtype, fn->fname, fn->params);
829 fprintf (outf, "#endif\n");
833 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
835 if (required_unseen_count)
837 #ifdef NO_IMPLICIT_EXTERN_C
838 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
842 switch (special_file_handling)
846 fprintf (outf, "extern int errno;\n");
849 if (!seen_EXIT_FAILURE)
850 fprintf (outf, "#define EXIT_FAILURE 1\n");
851 if (!seen_EXIT_SUCCESS)
852 fprintf (outf, "#define EXIT_SUCCESS 0\n");
855 if (!seen_S_ISBLK && seen_S_IFBLK)
857 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
858 if (!seen_S_ISCHR && seen_S_IFCHR)
860 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
861 if (!seen_S_ISDIR && seen_S_IFDIR)
863 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
864 if (!seen_S_ISFIFO && seen_S_IFIFO)
866 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
867 if (!seen_S_ISLNK && seen_S_IFLNK)
869 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
870 if (!seen_S_ISREG && seen_S_IFREG)
872 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
881 /* Returns 1 iff the file is properly protected from multiple inclusion:
888 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
889 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
892 inf_skip_spaces (int c)
896 if (c == ' ' || c == '\t')
903 (void) INF_UNGET (c);
914 source_lineno++, lineno++;
917 else if ((c = INF_GET ()) == '/')
927 /* Read into STR from inf_buffer upto DELIM. */
930 inf_read_upto (sstring *str, int delim)
936 if (ch == EOF || ch == delim)
938 SSTRING_PUT (str, ch);
940 MAKE_SSTRING_SPACE (str, 1);
946 inf_scan_ident (sstring *s, int c)
955 if (c == EOF || !(ISIDNUM (c)))
959 MAKE_SSTRING_SPACE (s, 1);
964 /* Returns 1 if the file is correctly protected against multiple
965 inclusion, setting *ifndef_line to the line number of the initial #ifndef
966 and setting *endif_line to the final #endif.
967 Otherwise return 0. */
970 check_protection (int *ifndef_line, int *endif_line)
973 int if_nesting = 1; /* Level of nesting of #if's */
974 char *protect_name = NULL; /* Identifier following initial #ifndef */
977 /* Skip initial white space (including comments). */
980 c = inf_skip_spaces (' ');
988 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
989 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
992 /* So far so good: We've seen an initial #ifndef. */
993 *ifndef_line = lineno;
994 c = inf_scan_ident (&buf, inf_skip_spaces (c));
995 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
997 protect_name = xstrdup (buf.base);
999 (void) INF_UNGET (c);
1000 c = inf_read_upto (&buf, '\n');
1007 c = inf_skip_spaces (' ');
1017 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1018 if (SSTRING_LENGTH (&buf) == 0)
1020 else if (!strcmp (buf.base, "ifndef")
1021 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1025 else if (!strcmp (buf.base, "endif"))
1028 if (if_nesting == 0)
1031 else if (!strcmp (buf.base, "else"))
1033 if (if_nesting == 1)
1036 else if (!strcmp (buf.base, "define"))
1038 c = inf_skip_spaces (c);
1039 c = inf_scan_ident (&buf, c);
1040 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1046 if (c == '\n' || c == EOF)
1057 *endif_line = lineno;
1058 /* Skip final white space (including comments). */
1061 c = inf_skip_spaces (' ');
1071 extern int main (int, char **);
1074 main (int argc, char **argv)
1079 #ifdef FIXPROTO_IGNORE_LIST
1087 struct symbol_list *cur_symbols;
1089 progname = "fix-header";
1090 if (argv[0] && argv[0][0])
1095 for (p = argv[0]; *p; p++)
1098 progname = progname ? progname+1 : argv[0];
1103 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1105 exit (FATAL_EXIT_CODE);
1108 inc_filename = argv[1];
1109 inc_filename_length = strlen (inc_filename);
1111 #ifdef FIXPROTO_IGNORE_LIST
1112 for (i = 0; files_to_ignore[i] != NULL; i++)
1114 const char *const ignore_name = files_to_ignore[i];
1115 int ignore_len = strlen (ignore_name);
1116 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1118 if (ignore_name[ignore_len-1] == '/'
1119 || inc_filename[ignore_len] == '\0')
1122 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1123 exit (SUCCESS_EXIT_CODE);
1130 if (strcmp (inc_filename, "sys/stat.h") == 0)
1131 special_file_handling = sys_stat_h;
1132 else if (strcmp (inc_filename, "errno.h") == 0)
1133 special_file_handling = errno_h, required_other++;
1134 else if (strcmp (inc_filename, "stdlib.h") == 0)
1135 special_file_handling = stdlib_h, required_other+=2;
1136 else if (strcmp (inc_filename, "stdio.h") == 0)
1137 special_file_handling = stdio_h;
1138 include_entry = std_include_table;
1139 while (include_entry->name != NULL
1140 && ((strcmp (include_entry->name, CONTINUED) == 0)
1141 || strcmp (inc_filename, include_entry->name) != 0))
1144 if (include_entry->name != NULL)
1146 const struct std_include_entry *entry;
1147 cur_symbol_table_size = 0;
1148 for (entry = include_entry; ;)
1151 add_symbols (entry->flags, entry->names);
1153 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1158 symbol_table[0].names = NULL;
1160 /* Count and mark the prototypes required for this include file. */
1161 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1164 if (cur_symbols->flags & MACRO_SYMBOL)
1166 cptr = cur_symbols->names;
1167 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1169 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1170 required_unseen_count++;
1172 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1178 read_scan_file (argv[2], argc - 4, argv + 4);
1180 inf_fd = open (argv[2], O_RDONLY, 0666);
1183 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1186 exit (FATAL_EXIT_CODE);
1188 if (fstat (inf_fd, &sbuf) < 0)
1190 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1192 exit (FATAL_EXIT_CODE);
1194 inf_size = sbuf.st_size;
1195 inf_buffer = XNEWVEC (char, inf_size + 2);
1196 inf_ptr = inf_buffer;
1201 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1204 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1206 exit (FATAL_EXIT_CODE);
1210 inf_size -= to_read;
1218 /* Inf_size may have changed if read was short (as on VMS) */
1219 inf_buffer[inf_size] = '\n';
1220 inf_buffer[inf_size + 1] = '\0';
1221 inf_limit = inf_buffer + inf_size;
1223 /* If file doesn't end with '\n', add one. */
1224 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1228 outf = fopen (argv[3], "w");
1231 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1234 exit (FATAL_EXIT_CODE);
1239 if (check_protection (&ifndef_line, &endif_line))
1241 lbrac_line = ifndef_line+1;
1242 rbrac_line = endif_line;
1250 /* Reset input file. */
1251 inf_ptr = inf_buffer;
1256 if (lineno == lbrac_line)
1258 if (lineno == rbrac_line)
1268 c = inf_scan_ident (&buf, c);
1269 (void) INF_UNGET (c);
1270 fputs (buf.base, outf);
1271 fn = lookup_std_proto (buf.base, strlen (buf.base));
1272 /* We only want to edit the declaration matching the one
1273 seen by scan-decls, as there can be multiple
1274 declarations, selected by #ifdef __STDC__ or whatever. */
1275 if (fn && fn->partial && fn->partial->line_seen == lineno)
1277 c = inf_skip_spaces (' ');
1282 c = inf_skip_spaces (' ');
1285 fprintf (outf, " _PARAMS((%s))", fn->params);
1290 (void) INF_UNGET (c);
1294 fprintf (outf, " %c", c);