Fixup --enable-target-optspace
[official-gcc.git] / gcc / fix-header.c
blob979cde3fb544c3e3d5bfa58c9aaeff0349dab79d
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 94-97, 1998 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
7 later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* This program massages a system include file (such as stdio.h),
19 into a form that is compatible with GNU C and GNU C++.
21 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
22 if they seem to be needed. These prevent C++ compilers from name
23 mangling the functions inside the braces.
25 * If an old-style incomplete function declaration is seen (without
26 an argument list), and it is a "standard" function listed in
27 the file sys-protos.h (and with a non-empty argument list), then
28 the declaration is converted to a complete prototype by replacing
29 the empty parameter list with the argument list from sys-protos.h.
31 * The program can be given a list of (names of) required standard
32 functions (such as fclose for stdio.h). If a required function
33 is not seen in the input, then a prototype for it will be
34 written to the output.
36 * If all of the non-comment code of the original file is protected
37 against multiple inclusion:
38 #ifndef FOO
39 #define FOO
40 <body of include file>
41 #endif
42 then extra matter added to the include file is placed inside the <body>.
44 * If the input file is OK (nothing needs to be done);
45 the output file is not written (nor removed if it exists).
47 There are also some special actions that are done for certain
48 well-known standard include files:
50 * If argv[1] is "sys/stat.h", the Posix.1 macros
51 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
52 they were missing, and the corresponding "traditional" S_IFxxx
53 macros were defined.
55 * If argv[1] is "errno.h", errno is declared if it was missing.
57 * TODO: The input file should be read complete into memory, because:
58 a) it needs to be scanned twice anyway, and
59 b) it would be nice to allow update in place.
61 Usage:
62 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
63 where:
64 * FOO.H is the relative file name of the include file,
65 as it would be #include'd by a C file. (E.g. stdio.h)
66 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
67 * OUTFILE.H is the full pathname for where to write the output file,
68 if anything needs to be done. (e.g. ./include/stdio.h)
69 * OPTIONS are such as you would pass to cpp.
71 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
73 #include "hconfig.h"
74 #include "system.h"
75 #include "obstack.h"
76 #include "scan.h"
77 #include "cpplib.h"
78 #include "gansidecl.h"
80 #ifndef O_RDONLY
81 #define O_RDONLY 0
82 #endif
84 extern void cpp_fatal ();
86 #if !__STDC__ && !defined(const)
87 #define const /* nothing */
88 #endif
90 sstring buf;
92 int verbose = 0;
93 int partial_count = 0;
94 int warnings = 0;
96 /* We no longer need to add extern "C", because cpp implicitly
97 forces the standard include files to be treated as C. */
98 /*#define ADD_MISSING_EXTERN_C 1 */
100 #if ADD_MISSING_EXTERN_C
101 int missing_extern_C_count = 0;
102 #endif
104 #include "xsys-protos.h"
106 #ifdef FIXPROTO_IGNORE_LIST
107 /* This is a currently unused feature. */
109 /* List of files and directories to ignore.
110 A directory name (ending in '/') means ignore anything in that
111 directory. (It might be more efficient to do directory pruning
112 earlier in fixproto, but this is simpler and easier to customize.) */
114 static char *files_to_ignore[] = {
115 "X11/",
116 FIXPROTO_IGNORE_LIST
119 #endif
121 char *inf_buffer;
122 char *inf_limit;
123 char *inf_ptr;
125 /* Certain standard files get extra treatment */
127 enum special_file
129 no_special,
130 #ifdef errno_h
131 #undef errno_h
132 #endif
133 errno_h,
134 #ifdef stdio_h
135 #undef stdio_h
136 #endif
137 stdio_h,
138 #ifdef stdlib_h
139 #undef stdlib_h
140 #endif
141 stdlib_h,
142 #ifdef sys_stat_h
143 #undef sys_stat_h
144 #endif
145 sys_stat_h
148 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
149 by an empty name (i.e. by "\0\0"). */
151 typedef const char *namelist;
153 /* The following macros provide the bits for symbol_flags. */
154 typedef int symbol_flags;
156 /* Used to mark names defined in the ANSI/ISO C standard. */
157 #define ANSI_SYMBOL 1
159 /* We no longer massage include files for POSIX or XOPEN symbols,
160 as there are now several versions of the POSIX and XOPEN standards,
161 and it would be a maintenance nightmare for us to track them all.
162 Better to be compatible with the system include files. */
163 /*#define ADD_MISSING_POSIX 1 */
164 /*#define ADD_MISSING_XOPEN 1 */
166 #if ADD_MISSING_POSIX
167 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
168 #define POSIX1_SYMBOL 2
169 #define POSIX2_SYMBOL 4
170 #else
171 #define POSIX1_SYMBOL 0
172 #define POSIX2_SYMBOL 0
173 #endif
175 #if ADD_MISSING_XOPEN
176 /* Used to mark names defined in X/Open Portability Guide. */
177 #define XOPEN_SYMBOL 8
178 /* Used to mark names defined in X/Open UNIX Extensions. */
179 #define XOPEN_EXTENDED_SYMBOL 16
180 #else
181 #define XOPEN_SYMBOL 0
182 #define XOPEN_EXTENDED_SYMBOL 0
183 #endif
185 /* Used to indicate names that are not functions */
186 #define MACRO_SYMBOL 512
188 struct symbol_list {
189 symbol_flags flags;
190 namelist names;
193 #define SYMBOL_TABLE_SIZE 10
194 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
195 int cur_symbol_table_size;
197 void
198 add_symbols (flags, names)
199 symbol_flags flags;
200 namelist names;
202 symbol_table[cur_symbol_table_size].flags = flags;
203 symbol_table[cur_symbol_table_size].names = names;
204 cur_symbol_table_size++;
205 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
206 fatal ("too many calls to add_symbols");
207 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
210 struct std_include_entry {
211 const char *name;
212 symbol_flags flags;
213 namelist names;
216 const char NONE[] = ""; /* The empty namelist. */
218 /* Special name to indicate a continuation line in std_include_table. */
219 const char CONTINUED[] = "";
221 struct std_include_entry *include_entry;
223 struct std_include_entry std_include_table [] = {
224 { "ctype.h", ANSI_SYMBOL,
225 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
226 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
228 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
230 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
232 /* ANSI_SYMBOL is wrong, but ... */
233 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
234 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
235 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
236 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
237 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
239 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
241 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
242 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
244 /*{ "limit.h", ... provided by gcc }, */
246 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
248 { "math.h", ANSI_SYMBOL,
249 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
250 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
251 tan\0tanh\0" },
253 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
255 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
257 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
258 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
260 /* Left out signal() - its prototype is too complex for us!
261 Also left out "sigaction sigaddset sigdelset sigemptyset
262 sigfillset sigismember sigpending sigprocmask sigsuspend"
263 because these need sigset_t or struct sigaction.
264 Most systems that provide them will also declare them. */
265 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
267 { "stdio.h", ANSI_SYMBOL,
268 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
269 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
270 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
271 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
272 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
273 tmpnam\0ungetc\0" },
274 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
275 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
276 /* Should perhaps also handle NULL, EOF, ... ? */
278 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
279 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
280 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
281 Should perhaps also add NULL */
282 { "stdlib.h", ANSI_SYMBOL,
283 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
284 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
285 srand\0strtod\0strtol\0strtoul\0system\0" },
286 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
288 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
289 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
290 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
291 strtok\0strxfrm\0" },
292 /* Should perhaps also add NULL and size_t */
294 { "strings.h", XOPEN_EXTENDED_SYMBOL,
295 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
297 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
299 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
300 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
301 and many systems do have <sys/ioctl.h> but not <strops.h>. */
302 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
304 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
306 { "sys/stat.h", POSIX1_SYMBOL,
307 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
308 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
309 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
310 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
311 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
313 #if 0
314 /* How do we handle fd_set? */
315 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
316 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
317 #endif
319 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
320 /* "sys/types.h" add types (not in old g++-include) */
322 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
324 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
325 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
326 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
327 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
329 { "tar.h", POSIX1_SYMBOL, NONE },
331 { "termios.h", POSIX1_SYMBOL,
332 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
334 { "time.h", ANSI_SYMBOL,
335 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
337 { "unistd.h", POSIX1_SYMBOL,
338 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
339 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
340 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
341 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
342 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
343 ttyname\0unlink\0write\0" },
344 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
345 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
346 "lockf\0gethostid\0gethostname\0readlink\0" },
348 { "utime.h", POSIX1_SYMBOL, "utime\0" },
350 { NULL, 0, NONE }
353 enum special_file special_file_handling = no_special;
355 /* They are set if the corresponding macro has been seen. */
356 /* The following are only used when handling sys/stat.h */
357 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
358 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
359 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
360 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
361 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
362 int seen_S_IFREG = 0, seen_S_ISREG = 0;
363 /* The following are only used when handling errno.h */
364 int seen_errno = 0;
365 /* The following are only used when handling stdlib.h */
366 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
368 /* Wrapper around free, to avoid prototype clashes. */
370 void
371 xfree (ptr)
372 char *ptr;
374 free (ptr);
377 /* Avoid error if config defines abort as fancy_abort.
378 It's not worth "really" implementing this because ordinary
379 compiler users never run fix-header. */
381 void
382 fancy_abort ()
384 abort ();
387 #define obstack_chunk_alloc xmalloc
388 #define obstack_chunk_free xfree
389 struct obstack scan_file_obstack;
391 /* NOTE: If you edit this, also edit gen-protos.c !! */
393 struct fn_decl *
394 lookup_std_proto (name, name_length)
395 const char *name;
396 int name_length;
398 int i = hashf (name, name_length, HASH_SIZE);
399 int i0 = i;
400 for (;;)
402 struct fn_decl *fn;
403 if (hash_tab[i] == 0)
404 return NULL;
405 fn = &std_protos[hash_tab[i]];
406 if (strlen (fn->fname) == name_length
407 && strncmp (fn->fname, name, name_length) == 0)
408 return fn;
409 i = (i+1) % HASH_SIZE;
410 if (i == i0)
411 abort ();
415 char *inc_filename;
416 int inc_filename_length;
417 char *progname = "fix-header";
418 FILE *outf;
419 sstring line;
421 int lbrac_line, rbrac_line;
423 int required_unseen_count = 0;
424 int required_other = 0;
426 void
427 write_lbrac ()
430 #if ADD_MISSING_EXTERN_C
431 if (missing_extern_C_count + required_unseen_count > 0)
432 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
433 #endif
435 if (partial_count)
437 fprintf (outf, "#ifndef _PARAMS\n");
438 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
439 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
440 fprintf (outf, "#else\n");
441 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
442 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
446 struct partial_proto
448 struct partial_proto *next;
449 char *fname; /* name of function */
450 char *rtype; /* return type */
451 struct fn_decl *fn;
452 int line_seen;
455 struct partial_proto *partial_proto_list = NULL;
457 struct partial_proto required_dummy_proto, seen_dummy_proto;
458 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
459 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
460 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
461 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
463 void
464 recognized_macro (fname)
465 char *fname;
467 /* The original include file defines fname as a macro. */
468 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
470 /* Since fname is a macro, don't require a prototype for it. */
471 if (fn)
473 if (REQUIRED (fn))
474 required_unseen_count--;
475 SET_SEEN (fn);
478 switch (special_file_handling)
480 case errno_h:
481 if (strcmp (fname, "errno") == 0 && !seen_errno)
482 seen_errno = 1, required_other--;
483 break;
484 case stdlib_h:
485 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
486 seen_EXIT_FAILURE = 1, required_other--;
487 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
488 seen_EXIT_SUCCESS = 1, required_other--;
489 break;
490 case sys_stat_h:
491 if (fname[0] == 'S' && fname[1] == '_')
493 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
494 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
495 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
496 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
497 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
498 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
499 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
500 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
501 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
502 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
503 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
504 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
506 break;
508 default:
509 break;
513 void
514 recognized_extern (name, name_length, type, type_length)
515 char *name;
516 char *type;
517 int name_length, type_length;
519 switch (special_file_handling)
521 case errno_h:
522 if (name_length == 5 && strncmp (name, "errno", 5) == 0 && !seen_errno)
523 seen_errno = 1, required_other--;
524 break;
526 default:
527 break;
531 /* Called by scan_decls if it saw a function definition for a function
532 named FNAME, with return type RTYPE, and argument list ARGS,
533 in source file FILE_SEEN on line LINE_SEEN.
534 KIND is 'I' for an inline function;
535 'F' if a normal function declaration preceded by 'extern "C"'
536 (or nested inside 'extern "C"' braces); or
537 'f' for other function declarations. */
539 void
540 recognized_function (fname, fname_length,
541 kind, rtype, rtype_length,
542 have_arg_list, file_seen, line_seen)
543 char *fname;
544 int fname_length;
545 int kind; /* One of 'f' 'F' or 'I' */
546 char *rtype;
547 int rtype_length;
548 int have_arg_list;
549 char *file_seen;
550 int line_seen;
552 struct partial_proto *partial;
553 int i;
554 struct fn_decl *fn;
555 #if ADD_MISSING_EXTERN_C
556 if (kind == 'f')
557 missing_extern_C_count++;
558 #endif
560 fn = lookup_std_proto (fname, fname_length);
562 /* Remove the function from the list of required function. */
563 if (fn)
565 if (REQUIRED (fn))
566 required_unseen_count--;
567 SET_SEEN (fn);
570 /* If we have a full prototype, we're done. */
571 if (have_arg_list)
572 return;
574 if (kind == 'I') /* don't edit inline function */
575 return;
577 /* If the partial prototype was included from some other file,
578 we don't need to patch it up (in this run). */
579 i = strlen (file_seen);
580 if (i < inc_filename_length
581 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
582 return;
584 if (fn == NULL)
585 return;
586 if (fn->params[0] == '\0' || strcmp (fn->params, "void") == 0)
587 return;
589 /* We only have a partial function declaration,
590 so remember that we have to add a complete prototype. */
591 partial_count++;
592 partial = (struct partial_proto *)
593 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
594 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
595 bcopy (fname, partial->fname, fname_length);
596 partial->fname[fname_length] = 0;
597 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
598 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
599 partial->line_seen = line_seen;
600 partial->fn = fn;
601 fn->partial = partial;
602 partial->next = partial_proto_list;
603 partial_proto_list = partial;
604 if (verbose)
606 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
607 inc_filename, partial->fname);
611 /* For any name in NAMES that is defined as a macro,
612 call recognized_macro on it. */
614 void
615 check_macro_names (pfile, names)
616 cpp_reader *pfile;
617 namelist names;
619 while (*names)
621 if (cpp_lookup (pfile, names, -1, -1))
622 recognized_macro (names);
623 names += strlen (names) + 1;
627 void
628 read_scan_file (in_fname, argc, argv)
629 char *in_fname;
630 int argc;
631 char **argv;
633 cpp_reader scan_in;
634 cpp_options scan_options;
635 struct fn_decl *fn;
636 int i;
637 register struct symbol_list *cur_symbols;
639 obstack_init (&scan_file_obstack);
641 cpp_reader_init (&scan_in);
642 scan_in.data = &scan_options;
643 cpp_options_init (&scan_options);
644 i = cpp_handle_options (&scan_in, argc, argv);
645 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
646 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
647 if (CPP_FATAL_ERRORS (&scan_in))
648 exit (FATAL_EXIT_CODE);
650 if (! cpp_start_read (&scan_in, in_fname))
651 exit (FATAL_EXIT_CODE);
652 CPP_OPTIONS (&scan_in)->no_line_commands = 1;
654 scan_decls (&scan_in, argc, argv);
655 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
656 check_macro_names (&scan_in, cur_symbols->names);
658 if (verbose && (scan_in.errors + warnings) > 0)
659 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
660 inc_filename, scan_in.errors, warnings);
661 if (scan_in.errors)
662 exit (SUCCESS_EXIT_CODE);
664 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
665 If so, those functions are also required. */
666 if (special_file_handling == stdio_h
667 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
669 static char getchar_call[] = "getchar();";
670 cpp_buffer *buf
671 = cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
672 int old_written = CPP_WRITTEN (&scan_in);
673 int seen_filbuf = 0;
675 /* Scan the macro expansion of "getchar();". */
676 for (;;)
678 enum cpp_token token = cpp_get_token (&scan_in);
679 int length = CPP_WRITTEN (&scan_in) - old_written;
680 CPP_SET_WRITTEN (&scan_in, old_written);
681 if (token == CPP_EOF) /* Should not happen ... */
682 break;
683 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
685 cpp_pop_buffer (&scan_in);
686 break;
688 if (token == CPP_NAME && length == 7
689 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
690 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 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 == 2)
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
720 #if ADD_MISSING_EXTERN_C
721 + missing_extern_C_count
722 #endif
723 == 0)
725 if (verbose)
726 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
727 exit (SUCCESS_EXIT_CODE);
729 if (!verbose)
730 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
731 else
733 if (required_unseen_count)
734 fprintf (stderr, "%s: %d missing function declarations.\n",
735 inc_filename, required_unseen_count);
736 if (partial_count)
737 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
738 inc_filename, partial_count);
739 #if ADD_MISSING_EXTERN_C
740 if (missing_extern_C_count)
741 fprintf (stderr,
742 "%s: %d declarations not protected by extern \"C\".\n",
743 inc_filename, missing_extern_C_count);
744 #endif
748 void
749 write_rbrac ()
751 struct fn_decl *fn;
752 const char *cptr;
753 register struct symbol_list *cur_symbols;
755 if (required_unseen_count)
757 #ifdef NO_IMPLICIT_EXTERN_C
758 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
759 #endif
762 /* Now we print out prototypes for those functions that we haven't seen. */
763 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
765 int if_was_emitted = 0;
766 int name_len;
767 cptr = cur_symbols->names;
768 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
770 int macro_protect = 0;
772 if (cur_symbols->flags & MACRO_SYMBOL)
773 continue;
775 fn = lookup_std_proto (cptr, name_len);
776 if (fn == NULL || !REQUIRED (fn))
777 continue;
779 if (!if_was_emitted)
781 /* what about curses. ??? or _flsbuf/_filbuf ??? */
782 if (cur_symbols->flags & ANSI_SYMBOL)
783 fprintf (outf,
784 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
785 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
786 fprintf (outf,
787 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
788 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
789 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
790 else if (cur_symbols->flags & XOPEN_SYMBOL)
792 fprintf (outf,
793 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
794 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
796 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
798 fprintf (outf,
799 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
800 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
802 else
804 fatal ("internal error for function %s", fn->fname);
806 if_was_emitted = 1;
809 /* In the case of memmove, protect in case the application
810 defines it as a macro before including the header. */
811 if (!strcmp (fn->fname, "memmove")
812 || !strcmp (fn->fname, "vprintf")
813 || !strcmp (fn->fname, "vfprintf")
814 || !strcmp (fn->fname, "vsprintf")
815 || !strcmp (fn->fname, "rewinddir"))
816 macro_protect = 1;
818 if (macro_protect)
819 fprintf (outf, "#ifndef %s\n", fn->fname);
820 fprintf (outf, "extern %s %s (%s);\n",
821 fn->rtype, fn->fname, fn->params);
822 if (macro_protect)
823 fprintf (outf, "#endif\n");
825 if (if_was_emitted)
826 fprintf (outf,
827 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
829 if (required_unseen_count)
831 #ifdef NO_IMPLICIT_EXTERN_C
832 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
833 #endif
836 switch (special_file_handling)
838 case errno_h:
839 if (!seen_errno)
840 fprintf (outf, "extern int errno;\n");
841 break;
842 case stdlib_h:
843 if (!seen_EXIT_FAILURE)
844 fprintf (outf, "#define EXIT_FAILURE 1\n");
845 if (!seen_EXIT_SUCCESS)
846 fprintf (outf, "#define EXIT_SUCCESS 0\n");
847 break;
848 case sys_stat_h:
849 if (!seen_S_ISBLK && seen_S_IFBLK)
850 fprintf (outf,
851 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
852 if (!seen_S_ISCHR && seen_S_IFCHR)
853 fprintf (outf,
854 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
855 if (!seen_S_ISDIR && seen_S_IFDIR)
856 fprintf (outf,
857 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
858 if (!seen_S_ISFIFO && seen_S_IFIFO)
859 fprintf (outf,
860 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
861 if (!seen_S_ISLNK && seen_S_IFLNK)
862 fprintf (outf,
863 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
864 if (!seen_S_ISREG && seen_S_IFREG)
865 fprintf (outf,
866 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
867 break;
869 default:
870 break;
874 #if ADD_MISSING_EXTERN_C
875 if (missing_extern_C_count + required_unseen_count > 0)
876 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
877 #endif
880 char *
881 xstrdup (str)
882 char *str;
884 char *copy = (char *) xmalloc (strlen (str) + 1);
885 strcpy (copy, str);
886 return copy;
889 /* Returns 1 iff the file is properly protected from multiple inclusion:
890 #ifndef PROTECT_NAME
891 #define PROTECT_NAME
892 #endif
896 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
897 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
900 inf_skip_spaces (c)
901 int c;
903 for (;;)
905 if (c == ' ' || c == '\t')
906 c = INF_GET ();
907 else if (c == '/')
909 c = INF_GET ();
910 if (c != '*')
912 (void) INF_UNGET (c);
913 return '/';
915 c = INF_GET ();
916 for (;;)
918 if (c == EOF)
919 return EOF;
920 else if (c != '*')
922 if (c == '\n')
923 source_lineno++, lineno++;
924 c = INF_GET ();
926 else if ((c = INF_GET ()) == '/')
927 return INF_GET ();
930 else
931 break;
933 return c;
936 /* Read into STR from inf_buffer upto DELIM. */
939 inf_read_upto (str, delim)
940 sstring *str;
941 int delim;
943 int ch;
944 for (;;)
946 ch = INF_GET ();
947 if (ch == EOF || ch == delim)
948 break;
949 SSTRING_PUT (str, ch);
951 MAKE_SSTRING_SPACE (str, 1);
952 *str->ptr = 0;
953 return ch;
957 inf_scan_ident (s, c)
958 register sstring *s;
959 int c;
961 s->ptr = s->base;
962 if (isalpha (c) || c == '_')
964 for (;;)
966 SSTRING_PUT (s, c);
967 c = INF_GET ();
968 if (c == EOF || !(isalnum (c) || c == '_'))
969 break;
972 MAKE_SSTRING_SPACE (s, 1);
973 *s->ptr = 0;
974 return c;
977 /* Returns 1 if the file is correctly protected against multiple
978 inclusion, setting *ifndef_line to the line number of the initial #ifndef
979 and setting *endif_line to the final #endif.
980 Otherwise return 0. */
983 check_protection (ifndef_line, endif_line)
984 int *ifndef_line, *endif_line;
986 int c;
987 int if_nesting = 1; /* Level of nesting of #if's */
988 char *protect_name = NULL; /* Identifier following initial #ifndef */
989 int define_seen = 0;
991 /* Skip initial white space (including comments). */
992 for (;; lineno++)
994 c = inf_skip_spaces (' ');
995 if (c == EOF)
996 return 0;
997 if (c != '\n')
998 break;
1000 if (c != '#')
1001 return 0;
1002 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1003 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
1004 return 0;
1006 /* So far so good: We've seen an initial #ifndef. */
1007 *ifndef_line = lineno;
1008 c = inf_scan_ident (&buf, inf_skip_spaces (c));
1009 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
1010 return 0;
1011 protect_name = xstrdup (buf.base);
1013 (void) INF_UNGET (c);
1014 c = inf_read_upto (&buf, '\n');
1015 if (c == EOF)
1016 return 0;
1017 lineno++;
1019 for (;;)
1021 c = inf_skip_spaces (' ');
1022 if (c == EOF)
1023 return 0;
1024 if (c == '\n')
1026 lineno++;
1027 continue;
1029 if (c != '#')
1030 goto skip_to_eol;
1031 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1032 if (SSTRING_LENGTH (&buf) == 0)
1034 else if (!strcmp (buf.base, "ifndef")
1035 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1037 if_nesting++;
1039 else if (!strcmp (buf.base, "endif"))
1041 if_nesting--;
1042 if (if_nesting == 0)
1043 break;
1045 else if (!strcmp (buf.base, "else"))
1047 if (if_nesting == 1)
1048 return 0;
1050 else if (!strcmp (buf.base, "define"))
1052 if (if_nesting != 1)
1053 goto skip_to_eol;
1054 c = inf_skip_spaces (c);
1055 c = inf_scan_ident (&buf, c);
1056 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1057 define_seen = 1;
1059 skip_to_eol:
1060 for (;;)
1062 if (c == '\n' || c == EOF)
1063 break;
1064 c = INF_GET ();
1066 if (c == EOF)
1067 return 0;
1068 lineno++;
1071 if (!define_seen)
1072 return 0;
1073 *endif_line = lineno;
1074 /* Skip final white space (including comments). */
1075 for (;;)
1077 c = inf_skip_spaces (' ');
1078 if (c == EOF)
1079 break;
1080 if (c != '\n')
1081 return 0;
1084 return 1;
1088 main (argc, argv)
1089 int argc;
1090 char **argv;
1092 int inf_fd;
1093 struct stat sbuf;
1094 int c;
1095 #ifdef FIXPROTO_IGNORE_LIST
1096 int i;
1097 #endif
1098 const char *cptr;
1099 int ifndef_line;
1100 int endif_line;
1101 long to_read;
1102 long int inf_size;
1103 register struct symbol_list *cur_symbols;
1105 if (argv[0] && argv[0][0])
1107 register char *p;
1109 progname = 0;
1110 for (p = argv[0]; *p; p++)
1111 if (*p == '/')
1112 progname = p;
1113 progname = progname ? progname+1 : argv[0];
1116 if (argc < 4)
1118 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1119 progname);
1120 exit (FATAL_EXIT_CODE);
1123 inc_filename = argv[1];
1124 inc_filename_length = strlen (inc_filename);
1126 #ifdef FIXPROTO_IGNORE_LIST
1127 for (i = 0; files_to_ignore[i] != NULL; i++)
1129 char *ignore_name = files_to_ignore[i];
1130 int ignore_len = strlen (ignore_name);
1131 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1133 if (ignore_name[ignore_len-1] == '/'
1134 || inc_filename[ignore_len] == '\0')
1136 if (verbose)
1137 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1138 exit (SUCCESS_EXIT_CODE);
1143 #endif
1145 if (strcmp (inc_filename, "sys/stat.h") == 0)
1146 special_file_handling = sys_stat_h;
1147 else if (strcmp (inc_filename, "errno.h") == 0)
1148 special_file_handling = errno_h, required_other++;
1149 else if (strcmp (inc_filename, "stdlib.h") == 0)
1150 special_file_handling = stdlib_h, required_other+=2;
1151 else if (strcmp (inc_filename, "stdio.h") == 0)
1152 special_file_handling = stdio_h;
1153 include_entry = std_include_table;
1154 while (include_entry->name != NULL
1155 && (include_entry->name == CONTINUED
1156 || strcmp (inc_filename, include_entry->name) != 0))
1157 include_entry++;
1159 if (include_entry->name != NULL)
1161 struct std_include_entry *entry;
1162 cur_symbol_table_size = 0;
1163 for (entry = include_entry; ;)
1165 if (entry->flags)
1166 add_symbols (entry->flags, entry->names);
1167 entry++;
1168 if (entry->name != CONTINUED)
1169 break;
1172 else
1173 symbol_table[0].names = NULL;
1175 /* Count and mark the prototypes required for this include file. */
1176 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1178 int name_len;
1179 if (cur_symbols->flags & MACRO_SYMBOL)
1180 continue;
1181 cptr = cur_symbols->names;
1182 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1184 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1185 required_unseen_count++;
1186 if (fn == NULL)
1187 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1188 else
1189 SET_REQUIRED (fn);
1193 read_scan_file (argv[2], argc - 4, argv + 4);
1195 inf_fd = open (argv[2], O_RDONLY, 0666);
1196 if (inf_fd < 0)
1198 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1199 progname, argv[2]);
1200 perror (NULL);
1201 exit (FATAL_EXIT_CODE);
1203 if (fstat (inf_fd, &sbuf) < 0)
1205 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1206 perror (NULL);
1207 exit (FATAL_EXIT_CODE);
1209 inf_size = sbuf.st_size;
1210 inf_buffer = (char *) xmalloc (inf_size + 2);
1211 inf_buffer[inf_size] = '\n';
1212 inf_buffer[inf_size + 1] = '\0';
1213 inf_limit = inf_buffer + inf_size;
1214 inf_ptr = inf_buffer;
1216 to_read = inf_size;
1217 while (to_read > 0)
1219 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1220 if (i < 0)
1222 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1223 perror (NULL);
1224 exit (FATAL_EXIT_CODE);
1226 if (i == 0)
1228 inf_size -= to_read;
1229 break;
1231 to_read -= i;
1234 close (inf_fd);
1236 /* If file doesn't end with '\n', add one. */
1237 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1238 inf_limit++;
1240 unlink (argv[3]);
1241 outf = fopen (argv[3], "w");
1242 if (outf == NULL)
1244 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1245 progname, argv[3]);
1246 perror (NULL);
1247 exit (FATAL_EXIT_CODE);
1250 lineno = 1;
1252 if (check_protection (&ifndef_line, &endif_line))
1254 lbrac_line = ifndef_line+1;
1255 rbrac_line = endif_line;
1257 else
1259 lbrac_line = 1;
1260 rbrac_line = -1;
1263 /* Reset input file. */
1264 inf_ptr = inf_buffer;
1265 lineno = 1;
1267 for (;;)
1269 if (lineno == lbrac_line)
1270 write_lbrac ();
1271 if (lineno == rbrac_line)
1272 write_rbrac ();
1273 for (;;)
1275 struct fn_decl *fn;
1276 c = INF_GET ();
1277 if (c == EOF)
1278 break;
1279 if (isalpha (c) || c == '_')
1281 c = inf_scan_ident (&buf, c);
1282 (void) INF_UNGET (c);
1283 fputs (buf.base, outf);
1284 fn = lookup_std_proto (buf.base, strlen (buf.base));
1285 /* We only want to edit the declaration matching the one
1286 seen by scan-decls, as there can be multiple
1287 declarations, selected by #ifdef __STDC__ or whatever. */
1288 if (fn && fn->partial && fn->partial->line_seen == lineno)
1290 c = inf_skip_spaces (' ');
1291 if (c == EOF)
1292 break;
1293 if (c == '(')
1295 c = inf_skip_spaces (' ');
1296 if (c == ')')
1298 fprintf (outf, " _PARAMS((%s))", fn->params);
1300 else
1302 putc ('(', outf);
1303 (void) INF_UNGET (c);
1306 else
1307 fprintf (outf, " %c", c);
1310 else
1312 putc (c, outf);
1313 if (c == '\n')
1314 break;
1317 if (c == EOF)
1318 break;
1319 lineno++;
1321 if (rbrac_line < 0)
1322 write_rbrac ();
1324 fclose (outf);
1326 return 0;
1329 /* Stub error functions. These replace cpperror.c,
1330 because we want to suppress error messages. */
1332 void
1333 cpp_file_line_for_message (filename, line, column)
1334 char *filename;
1335 int line, column;
1337 if (!verbose)
1338 return;
1339 if (column > 0)
1340 fprintf (stderr, "%s:%d:%d: ", filename, line, column);
1341 else
1342 fprintf (stderr, "%s:%d: ", filename, line);
1345 void
1346 cpp_print_containing_files (pfile)
1347 cpp_reader *pfile;
1351 /* IS_ERROR is 2 for fatal error, 1 for error, 0 for warning */
1353 void cpp_message (pfile, is_error, msg, arg1, arg2, arg3)
1354 int is_error;
1355 cpp_reader *pfile;
1356 char *msg;
1357 char *arg1, *arg2, *arg3;
1359 if (is_error == 1)
1360 pfile->errors++;
1361 else if (is_error > 1)
1362 pfile->errors = CPP_FATAL_LIMIT;
1363 if (!verbose)
1364 return;
1365 if (!is_error)
1366 fprintf (stderr, "warning: ");
1367 fprintf (stderr, msg, arg1, arg2, arg3);
1368 fprintf (stderr, "\n");
1371 void
1372 fatal (str, arg)
1373 char *str, *arg;
1375 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1376 fprintf (stderr, str, arg);
1377 fprintf (stderr, "\n");
1378 exit (FATAL_EXIT_CODE);
1381 void
1382 cpp_fatal (pfile, str, arg)
1383 cpp_reader *pfile;
1384 char *str, *arg;
1386 fatal (str, arg);
1389 void
1390 cpp_pfatal_with_name (pfile, name)
1391 cpp_reader *pfile;
1392 char *name;
1394 cpp_perror_with_name (pfile, name);
1395 exit (FATAL_EXIT_CODE);