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
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:
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"
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 };
93 struct line_maps line_table;
98 int partial_count = 0;
101 #if ADD_MISSING_EXTERN_C
102 int missing_extern_C_count = 0;
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[] = {
125 static const char *cur_file;
127 /* Certain standard files get extra treatment */
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
173 #define POSIX1_SYMBOL 0
174 #define POSIX2_SYMBOL 0
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
183 #define XOPEN_SYMBOL 0
184 #define XOPEN_EXTENDED_SYMBOL 0
187 /* Used to indicate names that are not functions */
188 #define MACRO_SYMBOL 512
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 *);
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\
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, "raise\0" },
279 { CONTINUED, POSIX1_SYMBOL, "kill\0" },
281 { "stdio.h", ANSI_SYMBOL,
282 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
283 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
284 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
285 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
286 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
288 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
289 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
290 /* Should perhaps also handle NULL, EOF, ... ? */
292 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
293 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
294 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
295 Should perhaps also add NULL */
296 { "stdlib.h", ANSI_SYMBOL,
297 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
298 exit\0free\0getenv\0labs\0malloc\0qsort\0rand\0realloc\0\
299 srand\0strtod\0strtol\0strtoul\0system\0" },
300 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
301 { CONTINUED, POSIX1_SYMBOL, "putenv\0" },
303 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
304 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
305 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
306 strtok\0strxfrm\0" },
307 /* Should perhaps also add NULL and size_t */
309 { "strings.h", XOPEN_EXTENDED_SYMBOL,
310 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
312 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
314 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
315 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
316 and many systems do have <sys/ioctl.h> but not <strops.h>. */
317 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
319 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
321 { "sys/stat.h", POSIX1_SYMBOL,
322 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
323 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
324 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
325 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
326 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
329 /* How do we handle fd_set? */
330 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
331 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
334 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
335 /* "sys/types.h" add types (not in old g++-include) */
337 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
339 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
340 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
341 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
342 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
344 { "tar.h", POSIX1_SYMBOL, NONE },
346 { "termios.h", POSIX1_SYMBOL,
347 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
349 { "time.h", ANSI_SYMBOL,
350 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0" },
351 { CONTINUED, POSIX1_SYMBOL, "tzset\0" },
353 { "unistd.h", POSIX1_SYMBOL,
354 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
355 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
356 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
357 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
358 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
359 ttyname\0unlink\0write\0" },
360 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
361 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
362 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
364 { "utime.h", POSIX1_SYMBOL, "utime\0" },
369 enum special_file special_file_handling = no_special;
371 /* They are set if the corresponding macro has been seen. */
372 /* The following are only used when handling sys/stat.h */
373 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
374 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
375 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
376 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
377 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
378 int seen_S_IFREG = 0, seen_S_ISREG = 0;
379 /* The following are only used when handling errno.h */
381 /* The following are only used when handling stdlib.h */
382 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
384 struct obstack scan_file_obstack;
386 /* NOTE: If you edit this, also edit gen-protos.c !! */
388 static struct fn_decl *
389 lookup_std_proto (const char *name, int name_length)
391 int i = hashstr (name, name_length) % HASH_SIZE;
396 if (hash_tab[i] == 0)
398 fn = &std_protos[hash_tab[i]];
399 if ((int) strlen (fn->fname) == name_length
400 && strncmp (fn->fname, name, name_length) == 0)
402 i = (i+1) % HASH_SIZE;
409 int inc_filename_length;
410 const char *progname = "fix-header";
414 int lbrac_line, rbrac_line;
416 int required_unseen_count = 0;
417 int required_other = 0;
424 fprintf (outf, "#ifndef _PARAMS\n");
425 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
426 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
427 fprintf (outf, "#else\n");
428 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
429 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
435 struct partial_proto *next;
440 struct partial_proto *partial_proto_list = NULL;
442 struct partial_proto required_dummy_proto, seen_dummy_proto;
443 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
444 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
445 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
446 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
449 recognized_macro (const char *fname)
451 /* The original include file defines fname as a macro. */
452 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
454 /* Since fname is a macro, don't require a prototype for it. */
458 required_unseen_count--;
462 switch (special_file_handling)
465 if (strcmp (fname, "errno") == 0 && !seen_errno)
466 seen_errno = 1, required_other--;
469 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
470 seen_EXIT_FAILURE = 1, required_other--;
471 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
472 seen_EXIT_SUCCESS = 1, required_other--;
475 if (fname[0] == 'S' && fname[1] == '_')
477 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
478 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
479 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
480 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
481 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
482 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
483 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
484 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
485 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
486 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
487 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
488 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
498 recognized_extern (const cpp_token *name)
500 switch (special_file_handling)
503 if (cpp_ideq (name, "errno"))
504 seen_errno = 1, required_other--;
512 /* Called by scan_decls if it saw a function definition for a function
513 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
514 function declaration preceded by 'extern "C"' (or nested inside
515 'extern "C"' braces); or 'f' for other function declarations. */
518 recognized_function (const cpp_token *fname, unsigned int line, int kind,
521 struct partial_proto *partial;
525 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
526 NODE_LEN (fname->val.node));
528 /* Remove the function from the list of required function. */
532 required_unseen_count--;
536 /* If we have a full prototype, we're done. */
540 if (kind == 'I') /* don't edit inline function */
543 /* If the partial prototype was included from some other file,
544 we don't need to patch it up (in this run). */
545 i = strlen (cur_file);
546 if (i < inc_filename_length
547 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
552 if (fn->params[0] == '\0')
555 /* We only have a partial function declaration,
556 so remember that we have to add a complete prototype. */
558 partial = obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
559 partial->line_seen = line;
561 fn->partial = partial;
562 partial->next = partial_proto_list;
563 partial_proto_list = partial;
566 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
567 inc_filename, fn->fname);
571 /* For any name in NAMES that is defined as a macro,
572 call recognized_macro on it. */
575 check_macro_names (cpp_reader *pfile, namelist names)
580 len = strlen (names);
581 if (cpp_defined (pfile, (const unsigned char *)names, len))
582 recognized_macro (names);
588 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
589 const struct line_map *map)
591 /* Just keep track of current file name. */
592 cur_file = map == NULL ? NULL : map->to_file;
596 read_scan_file (char *in_fname, int argc, char **argv)
600 cpp_options *options;
602 int i, strings_processed;
603 struct symbol_list *cur_symbols;
605 obstack_init (&scan_file_obstack);
607 linemap_init (&line_table);
608 scan_in = cpp_create_reader (CLK_GNUC89, NULL, &line_table);
609 cb = cpp_get_callbacks (scan_in);
610 cb->file_change = cb_file_change;
612 /* We are going to be scanning a header file out of its proper context,
613 so ignore warnings and errors. */
614 options = cpp_get_options (scan_in);
615 options->inhibit_warnings = 1;
616 options->inhibit_errors = 1;
617 cpp_post_options (scan_in);
619 if (!cpp_read_main_file (scan_in, in_fname))
620 exit (FATAL_EXIT_CODE);
622 cpp_change_file (scan_in, LC_RENAME, "<built-in>");
623 cpp_init_builtins (scan_in, true);
624 cpp_change_file (scan_in, LC_RENAME, in_fname);
626 /* Process switches after builtins so -D can override them. */
627 for (i = 0; i < argc; i += strings_processed)
629 strings_processed = 0;
630 if (argv[i][0] == '-')
632 if (argv[i][1] == 'I')
634 if (argv[i][2] != '\0')
636 strings_processed = 1;
637 add_path (xstrdup (argv[i] + 2), BRACKET, false, false);
639 else if (i + 1 != argc)
641 strings_processed = 2;
642 add_path (xstrdup (argv[i + 1]), BRACKET, false, false);
645 else if (argv[i][1] == 'D')
647 if (argv[i][2] != '\0')
648 strings_processed = 1, cpp_define (scan_in, argv[i] + 2);
649 else if (i + 1 != argc)
650 strings_processed = 2, cpp_define (scan_in, argv[i + 1]);
654 if (strings_processed == 0)
659 cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
660 if (cpp_errors (scan_in))
661 exit (FATAL_EXIT_CODE);
663 register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
664 true /* stdinc */, false /* cxx_stdinc */,
665 false /* verbose */);
667 /* We are scanning a system header, so mark it as such. */
668 cpp_make_system_header (scan_in, 1, 0);
670 scan_decls (scan_in, argc, argv);
671 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
672 check_macro_names (scan_in, cur_symbols->names);
674 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
675 If so, those functions are also required. */
676 if (special_file_handling == stdio_h
677 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
679 unsigned char getchar_call[] = "getchar();\n";
682 /* Scan the macro expansion of "getchar();". */
683 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
684 /* from_stage3 */ true);
687 const cpp_token *t = cpp_get_token (scan_in);
689 if (t->type == CPP_EOF)
691 else if (cpp_ideq (t, "_filbuf"))
697 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
698 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
700 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
702 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
703 if (need_filbuf + need_flsbuf)
705 const char *new_list;
709 SET_REQUIRED (flsbuf_fn);
710 if (need_flsbuf && need_filbuf)
711 new_list = "_filbuf\0_flsbuf\0";
712 else if (need_flsbuf)
713 new_list = "_flsbuf\0";
714 else /* if (need_flsbuf) */
715 new_list = "_filbuf\0";
716 add_symbols (ANSI_SYMBOL, new_list);
717 required_unseen_count += need_filbuf + need_flsbuf;
722 if (required_unseen_count + partial_count + required_other == 0)
725 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
726 exit (SUCCESS_EXIT_CODE);
729 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
732 if (required_unseen_count)
733 fprintf (stderr, "%s: %d missing function declarations.\n",
734 inc_filename, required_unseen_count);
736 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
737 inc_filename, partial_count);
746 struct symbol_list *cur_symbols;
748 if (required_unseen_count)
750 #ifdef NO_IMPLICIT_EXTERN_C
751 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
755 /* Now we print out prototypes for those functions that we haven't seen. */
756 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
758 int if_was_emitted = 0;
760 cptr = cur_symbols->names;
761 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
763 int macro_protect = 0;
765 if (cur_symbols->flags & MACRO_SYMBOL)
768 fn = lookup_std_proto (cptr, name_len);
769 if (fn == NULL || !REQUIRED (fn))
774 /* what about curses. ??? or _flsbuf/_filbuf ??? */
775 if (cur_symbols->flags & ANSI_SYMBOL)
777 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
778 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
780 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
781 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
782 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
783 else if (cur_symbols->flags & XOPEN_SYMBOL)
786 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
787 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
789 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
792 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
793 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
797 fatal ("internal error for function %s", fn->fname);
802 /* In the case of memmove, protect in case the application
803 defines it as a macro before including the header. */
804 if (!strcmp (fn->fname, "memmove")
805 || !strcmp (fn->fname, "putc")
806 || !strcmp (fn->fname, "getc")
807 || !strcmp (fn->fname, "vprintf")
808 || !strcmp (fn->fname, "vfprintf")
809 || !strcmp (fn->fname, "vsprintf")
810 || !strcmp (fn->fname, "rewinddir")
811 || !strcmp (fn->fname, "abort"))
815 fprintf (outf, "#ifndef %s\n", fn->fname);
816 fprintf (outf, "extern %s %s (%s);\n",
817 fn->rtype, fn->fname, fn->params);
819 fprintf (outf, "#endif\n");
823 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
825 if (required_unseen_count)
827 #ifdef NO_IMPLICIT_EXTERN_C
828 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
832 switch (special_file_handling)
836 fprintf (outf, "extern int errno;\n");
839 if (!seen_EXIT_FAILURE)
840 fprintf (outf, "#define EXIT_FAILURE 1\n");
841 if (!seen_EXIT_SUCCESS)
842 fprintf (outf, "#define EXIT_SUCCESS 0\n");
845 if (!seen_S_ISBLK && seen_S_IFBLK)
847 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
848 if (!seen_S_ISCHR && seen_S_IFCHR)
850 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
851 if (!seen_S_ISDIR && seen_S_IFDIR)
853 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
854 if (!seen_S_ISFIFO && seen_S_IFIFO)
856 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
857 if (!seen_S_ISLNK && seen_S_IFLNK)
859 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
860 if (!seen_S_ISREG && seen_S_IFREG)
862 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
871 /* Returns 1 iff the file is properly protected from multiple inclusion:
878 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
879 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
882 inf_skip_spaces (int c)
886 if (c == ' ' || c == '\t')
893 (void) INF_UNGET (c);
904 source_lineno++, lineno++;
907 else if ((c = INF_GET ()) == '/')
917 /* Read into STR from inf_buffer upto DELIM. */
920 inf_read_upto (sstring *str, int delim)
926 if (ch == EOF || ch == delim)
928 SSTRING_PUT (str, ch);
930 MAKE_SSTRING_SPACE (str, 1);
936 inf_scan_ident (sstring *s, int c)
945 if (c == EOF || !(ISIDNUM (c)))
949 MAKE_SSTRING_SPACE (s, 1);
954 /* Returns 1 if the file is correctly protected against multiple
955 inclusion, setting *ifndef_line to the line number of the initial #ifndef
956 and setting *endif_line to the final #endif.
957 Otherwise return 0. */
960 check_protection (int *ifndef_line, int *endif_line)
963 int if_nesting = 1; /* Level of nesting of #if's */
964 char *protect_name = NULL; /* Identifier following initial #ifndef */
967 /* Skip initial white space (including comments). */
970 c = inf_skip_spaces (' ');
978 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
979 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
982 /* So far so good: We've seen an initial #ifndef. */
983 *ifndef_line = lineno;
984 c = inf_scan_ident (&buf, inf_skip_spaces (c));
985 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
987 protect_name = xstrdup (buf.base);
989 (void) INF_UNGET (c);
990 c = inf_read_upto (&buf, '\n');
997 c = inf_skip_spaces (' ');
1007 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1008 if (SSTRING_LENGTH (&buf) == 0)
1010 else if (!strcmp (buf.base, "ifndef")
1011 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1015 else if (!strcmp (buf.base, "endif"))
1018 if (if_nesting == 0)
1021 else if (!strcmp (buf.base, "else"))
1023 if (if_nesting == 1)
1026 else if (!strcmp (buf.base, "define"))
1028 c = inf_skip_spaces (c);
1029 c = inf_scan_ident (&buf, c);
1030 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1036 if (c == '\n' || c == EOF)
1047 *endif_line = lineno;
1048 /* Skip final white space (including comments). */
1051 c = inf_skip_spaces (' ');
1061 extern int main (int, char **);
1064 main (int argc, char **argv)
1069 #ifdef FIXPROTO_IGNORE_LIST
1077 struct symbol_list *cur_symbols;
1079 if (argv[0] && argv[0][0])
1084 for (p = argv[0]; *p; p++)
1087 progname = progname ? progname+1 : argv[0];
1092 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1094 exit (FATAL_EXIT_CODE);
1097 inc_filename = argv[1];
1098 inc_filename_length = strlen (inc_filename);
1100 #ifdef FIXPROTO_IGNORE_LIST
1101 for (i = 0; files_to_ignore[i] != NULL; i++)
1103 const char *const ignore_name = files_to_ignore[i];
1104 int ignore_len = strlen (ignore_name);
1105 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1107 if (ignore_name[ignore_len-1] == '/'
1108 || inc_filename[ignore_len] == '\0')
1111 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1112 exit (SUCCESS_EXIT_CODE);
1119 if (strcmp (inc_filename, "sys/stat.h") == 0)
1120 special_file_handling = sys_stat_h;
1121 else if (strcmp (inc_filename, "errno.h") == 0)
1122 special_file_handling = errno_h, required_other++;
1123 else if (strcmp (inc_filename, "stdlib.h") == 0)
1124 special_file_handling = stdlib_h, required_other+=2;
1125 else if (strcmp (inc_filename, "stdio.h") == 0)
1126 special_file_handling = stdio_h;
1127 include_entry = std_include_table;
1128 while (include_entry->name != NULL
1129 && ((strcmp (include_entry->name, CONTINUED) == 0)
1130 || strcmp (inc_filename, include_entry->name) != 0))
1133 if (include_entry->name != NULL)
1135 const struct std_include_entry *entry;
1136 cur_symbol_table_size = 0;
1137 for (entry = include_entry; ;)
1140 add_symbols (entry->flags, entry->names);
1142 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1147 symbol_table[0].names = NULL;
1149 /* Count and mark the prototypes required for this include file. */
1150 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1153 if (cur_symbols->flags & MACRO_SYMBOL)
1155 cptr = cur_symbols->names;
1156 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1158 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1159 required_unseen_count++;
1161 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1167 read_scan_file (argv[2], argc - 4, argv + 4);
1169 inf_fd = open (argv[2], O_RDONLY, 0666);
1172 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1175 exit (FATAL_EXIT_CODE);
1177 if (fstat (inf_fd, &sbuf) < 0)
1179 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1181 exit (FATAL_EXIT_CODE);
1183 inf_size = sbuf.st_size;
1184 inf_buffer = xmalloc (inf_size + 2);
1185 inf_ptr = inf_buffer;
1190 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1193 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1195 exit (FATAL_EXIT_CODE);
1199 inf_size -= to_read;
1207 /* Inf_size may have changed if read was short (as on VMS) */
1208 inf_buffer[inf_size] = '\n';
1209 inf_buffer[inf_size + 1] = '\0';
1210 inf_limit = inf_buffer + inf_size;
1212 /* If file doesn't end with '\n', add one. */
1213 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1217 outf = fopen (argv[3], "w");
1220 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1223 exit (FATAL_EXIT_CODE);
1228 if (check_protection (&ifndef_line, &endif_line))
1230 lbrac_line = ifndef_line+1;
1231 rbrac_line = endif_line;
1239 /* Reset input file. */
1240 inf_ptr = inf_buffer;
1245 if (lineno == lbrac_line)
1247 if (lineno == rbrac_line)
1257 c = inf_scan_ident (&buf, c);
1258 (void) INF_UNGET (c);
1259 fputs (buf.base, outf);
1260 fn = lookup_std_proto (buf.base, strlen (buf.base));
1261 /* We only want to edit the declaration matching the one
1262 seen by scan-decls, as there can be multiple
1263 declarations, selected by #ifdef __STDC__ or whatever. */
1264 if (fn && fn->partial && fn->partial->line_seen == lineno)
1266 c = inf_skip_spaces (' ');
1271 c = inf_skip_spaces (' ');
1274 fprintf (outf, " _PARAMS((%s))", fn->params);
1279 (void) INF_UNGET (c);
1283 fprintf (outf, " %c", c);
1307 v_fatal (const char *str, va_list ap)
1309 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1310 vfprintf (stderr, str, ap);
1311 fprintf (stderr, "\n");
1313 exit (FATAL_EXIT_CODE);
1317 fatal (const char *str, ...)