2000-07-03 Donn Terry (donnte@microsoft.com)
[official-gcc.git] / gcc / fix-header.c
blob6ff458a1102018936bbd5e1716268df83c5cbed0
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
8 later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* This program massages a system include file (such as stdio.h),
20 into a form that is compatible with GNU C and GNU C++.
22 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
23 if they seem to be needed. These prevent C++ compilers from name
24 mangling the functions inside the braces.
26 * If an old-style incomplete function declaration is seen (without
27 an argument list), and it is a "standard" function listed in
28 the file sys-protos.h (and with a non-empty argument list), then
29 the declaration is converted to a complete prototype by replacing
30 the empty parameter list with the argument list from sys-protos.h.
32 * The program can be given a list of (names of) required standard
33 functions (such as fclose for stdio.h). If a required function
34 is not seen in the input, then a prototype for it will be
35 written to the output.
37 * If all of the non-comment code of the original file is protected
38 against multiple inclusion:
39 #ifndef FOO
40 #define FOO
41 <body of include file>
42 #endif
43 then extra matter added to the include file is placed inside the <body>.
45 * If the input file is OK (nothing needs to be done);
46 the output file is not written (nor removed if it exists).
48 There are also some special actions that are done for certain
49 well-known standard include files:
51 * If argv[1] is "sys/stat.h", the Posix.1 macros
52 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
53 they were missing, and the corresponding "traditional" S_IFxxx
54 macros were defined.
56 * If argv[1] is "errno.h", errno is declared if it was missing.
58 * TODO: The input file should be read complete into memory, because:
59 a) it needs to be scanned twice anyway, and
60 b) it would be nice to allow update in place.
62 Usage:
63 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
64 where:
65 * FOO.H is the relative file name of the include file,
66 as it would be #include'd by a C file. (E.g. stdio.h)
67 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
68 * OUTFILE.H is the full pathname for where to write the output file,
69 if anything needs to be done. (e.g. ./include/stdio.h)
70 * OPTIONS are such as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
74 #include "hconfig.h"
75 #include "system.h"
76 #include "obstack.h"
77 #include "scan.h"
78 #include "cpplib.h"
80 static void v_fatal PARAMS ((const char *, va_list)) ATTRIBUTE_NORETURN;
81 static void fatal PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
83 sstring buf;
85 int verbose = 0;
86 int partial_count = 0;
87 int warnings = 0;
89 /* We no longer need to add extern "C", because cpp implicitly
90 forces the standard include files to be treated as C. */
91 /*#define ADD_MISSING_EXTERN_C 1 */
93 #if ADD_MISSING_EXTERN_C
94 int missing_extern_C_count = 0;
95 #endif
97 #include "xsys-protos.h"
99 #ifdef FIXPROTO_IGNORE_LIST
100 /* This is a currently unused feature. */
102 /* List of files and directories to ignore.
103 A directory name (ending in '/') means ignore anything in that
104 directory. (It might be more efficient to do directory pruning
105 earlier in fixproto, but this is simpler and easier to customize.) */
107 static char *files_to_ignore[] = {
108 "X11/",
109 FIXPROTO_IGNORE_LIST
112 #endif
114 char *inf_buffer;
115 char *inf_limit;
116 char *inf_ptr;
118 /* Certain standard files get extra treatment */
120 enum special_file
122 no_special,
123 #ifdef errno_h
124 #undef errno_h
125 #endif
126 errno_h,
127 #ifdef stdio_h
128 #undef stdio_h
129 #endif
130 stdio_h,
131 #ifdef stdlib_h
132 #undef stdlib_h
133 #endif
134 stdlib_h,
135 #ifdef sys_stat_h
136 #undef sys_stat_h
137 #endif
138 sys_stat_h
141 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
142 by an empty name (i.e. by "\0\0"). */
144 typedef const char *namelist;
146 /* The following macros provide the bits for symbol_flags. */
147 typedef int symbol_flags;
149 /* Used to mark names defined in the ANSI/ISO C standard. */
150 #define ANSI_SYMBOL 1
152 /* We no longer massage include files for POSIX or XOPEN symbols,
153 as there are now several versions of the POSIX and XOPEN standards,
154 and it would be a maintenance nightmare for us to track them all.
155 Better to be compatible with the system include files. */
156 /*#define ADD_MISSING_POSIX 1 */
157 /*#define ADD_MISSING_XOPEN 1 */
159 #if ADD_MISSING_POSIX
160 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
161 #define POSIX1_SYMBOL 2
162 #define POSIX2_SYMBOL 4
163 #else
164 #define POSIX1_SYMBOL 0
165 #define POSIX2_SYMBOL 0
166 #endif
168 #if ADD_MISSING_XOPEN
169 /* Used to mark names defined in X/Open Portability Guide. */
170 #define XOPEN_SYMBOL 8
171 /* Used to mark names defined in X/Open UNIX Extensions. */
172 #define XOPEN_EXTENDED_SYMBOL 16
173 #else
174 #define XOPEN_SYMBOL 0
175 #define XOPEN_EXTENDED_SYMBOL 0
176 #endif
178 /* Used to indicate names that are not functions */
179 #define MACRO_SYMBOL 512
181 struct symbol_list {
182 symbol_flags flags;
183 namelist names;
186 #define SYMBOL_TABLE_SIZE 10
187 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
188 int cur_symbol_table_size;
190 static void add_symbols PARAMS ((symbol_flags, namelist));
191 static struct fn_decl *lookup_std_proto PARAMS ((const char *, int));
192 static void write_lbrac PARAMS ((void));
193 static void recognized_macro PARAMS ((const char *));
194 static void check_macro_names PARAMS ((cpp_reader *, namelist));
195 static void read_scan_file PARAMS ((char *, int, char **));
196 static void write_rbrac PARAMS ((void));
197 static int inf_skip_spaces PARAMS ((int));
198 static int inf_read_upto PARAMS ((sstring *, int));
199 static int inf_scan_ident PARAMS ((sstring *, int));
200 static int check_protection PARAMS ((int *, int *));
202 static void
203 add_symbols (flags, names)
204 symbol_flags flags;
205 namelist names;
207 symbol_table[cur_symbol_table_size].flags = flags;
208 symbol_table[cur_symbol_table_size].names = names;
209 cur_symbol_table_size++;
210 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
211 fatal ("too many calls to add_symbols");
212 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
215 struct std_include_entry {
216 const char *name;
217 symbol_flags flags;
218 namelist names;
221 const char NONE[] = ""; /* The empty namelist. */
223 /* Special name to indicate a continuation line in std_include_table. */
224 const char CONTINUED[] = "";
226 struct std_include_entry *include_entry;
228 struct std_include_entry std_include_table [] = {
229 { "ctype.h", ANSI_SYMBOL,
230 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
231 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
233 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
235 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
237 /* ANSI_SYMBOL is wrong, but ... */
238 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
239 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
240 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
241 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
242 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
244 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
246 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
247 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
249 /*{ "limit.h", ... provided by gcc }, */
251 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
253 { "math.h", ANSI_SYMBOL,
254 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
255 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
256 tan\0tanh\0" },
258 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
260 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
262 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
263 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
265 /* Left out signal() - its prototype is too complex for us!
266 Also left out "sigaction sigaddset sigdelset sigemptyset
267 sigfillset sigismember sigpending sigprocmask sigsuspend"
268 because these need sigset_t or struct sigaction.
269 Most systems that provide them will also declare them. */
270 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
272 { "stdio.h", ANSI_SYMBOL,
273 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
274 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
275 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
276 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
277 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
278 tmpnam\0ungetc\0" },
279 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
280 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
281 /* Should perhaps also handle NULL, EOF, ... ? */
283 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
284 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
285 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
286 Should perhaps also add NULL */
287 { "stdlib.h", ANSI_SYMBOL,
288 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
289 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
290 srand\0strtod\0strtol\0strtoul\0system\0" },
291 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
293 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
294 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
295 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
296 strtok\0strxfrm\0" },
297 /* Should perhaps also add NULL and size_t */
299 { "strings.h", XOPEN_EXTENDED_SYMBOL,
300 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
302 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
304 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
305 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
306 and many systems do have <sys/ioctl.h> but not <strops.h>. */
307 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
309 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
311 { "sys/stat.h", POSIX1_SYMBOL,
312 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
313 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
314 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
315 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
316 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
318 #if 0
319 /* How do we handle fd_set? */
320 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
321 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
322 #endif
324 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
325 /* "sys/types.h" add types (not in old g++-include) */
327 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
329 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
330 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
331 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
332 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
334 { "tar.h", POSIX1_SYMBOL, NONE },
336 { "termios.h", POSIX1_SYMBOL,
337 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
339 { "time.h", ANSI_SYMBOL,
340 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
342 { "unistd.h", POSIX1_SYMBOL,
343 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
344 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
345 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
346 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
347 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
348 ttyname\0unlink\0write\0" },
349 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
350 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
351 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
353 { "utime.h", POSIX1_SYMBOL, "utime\0" },
355 { NULL, 0, NONE }
358 enum special_file special_file_handling = no_special;
360 /* They are set if the corresponding macro has been seen. */
361 /* The following are only used when handling sys/stat.h */
362 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
363 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
364 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
365 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
366 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
367 int seen_S_IFREG = 0, seen_S_ISREG = 0;
368 /* The following are only used when handling errno.h */
369 int seen_errno = 0;
370 /* The following are only used when handling stdlib.h */
371 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
373 #define obstack_chunk_alloc xmalloc
374 #define obstack_chunk_free free
375 struct obstack scan_file_obstack;
377 /* NOTE: If you edit this, also edit gen-protos.c !! */
379 static struct fn_decl *
380 lookup_std_proto (name, name_length)
381 const char *name;
382 int name_length;
384 int i = hashstr (name, name_length) % HASH_SIZE;
385 int i0 = i;
386 for (;;)
388 struct fn_decl *fn;
389 if (hash_tab[i] == 0)
390 return NULL;
391 fn = &std_protos[hash_tab[i]];
392 if ((int) strlen (fn->fname) == name_length
393 && strncmp (fn->fname, name, name_length) == 0)
394 return fn;
395 i = (i+1) % HASH_SIZE;
396 if (i == i0)
397 abort ();
401 char *inc_filename;
402 int inc_filename_length;
403 const char *progname = "fix-header";
404 FILE *outf;
405 sstring line;
407 int lbrac_line, rbrac_line;
409 int required_unseen_count = 0;
410 int required_other = 0;
412 static void
413 write_lbrac ()
416 #if ADD_MISSING_EXTERN_C
417 if (missing_extern_C_count + required_unseen_count > 0)
418 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
419 #endif
421 if (partial_count)
423 fprintf (outf, "#ifndef _PARAMS\n");
424 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
425 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
426 fprintf (outf, "#else\n");
427 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
428 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
432 struct partial_proto
434 struct partial_proto *next;
435 struct fn_decl *fn;
436 int line_seen;
439 struct partial_proto *partial_proto_list = NULL;
441 struct partial_proto required_dummy_proto, seen_dummy_proto;
442 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
443 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
444 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
445 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
447 static void
448 recognized_macro (fname)
449 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. */
455 if (fn)
457 if (REQUIRED (fn))
458 required_unseen_count--;
459 SET_SEEN (fn);
462 switch (special_file_handling)
464 case errno_h:
465 if (strcmp (fname, "errno") == 0 && !seen_errno)
466 seen_errno = 1, required_other--;
467 break;
468 case stdlib_h:
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--;
473 break;
474 case sys_stat_h:
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++;
490 break;
492 default:
493 break;
497 void
498 recognized_extern (name)
499 const cpp_token *name;
501 switch (special_file_handling)
503 case errno_h:
504 if (!cpp_idcmp (name->val.name.text, name->val.name.len, "errno"))
505 seen_errno = 1, required_other--;
506 break;
508 default:
509 break;
513 /* Called by scan_decls if it saw a function definition for a function
514 named FNAME, in source file FILE_SEEN on line LINE_SEEN. KIND is
515 'I' for an inline function; 'F' if a normal function declaration
516 preceded by 'extern "C"' (or nested inside 'extern "C"' braces); or
517 'f' for other function declarations. */
519 void
520 recognized_function (fname, kind, have_arg_list, file_seen)
521 const cpp_token *fname;
522 int kind; /* One of 'f' 'F' or 'I' */
523 int have_arg_list;
524 const char *file_seen;
526 struct partial_proto *partial;
527 int i;
528 struct fn_decl *fn;
529 #if ADD_MISSING_EXTERN_C
530 if (kind == 'f')
531 missing_extern_C_count++;
532 #endif
534 fn = lookup_std_proto ((const char *)fname->val.name.text,
535 fname->val.name.len);
537 /* Remove the function from the list of required function. */
538 if (fn)
540 if (REQUIRED (fn))
541 required_unseen_count--;
542 SET_SEEN (fn);
545 /* If we have a full prototype, we're done. */
546 if (have_arg_list)
547 return;
549 if (kind == 'I') /* don't edit inline function */
550 return;
552 /* If the partial prototype was included from some other file,
553 we don't need to patch it up (in this run). */
554 i = strlen (file_seen);
555 if (i < inc_filename_length
556 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
557 return;
559 if (fn == NULL)
560 return;
561 if (fn->params[0] == '\0')
562 return;
564 /* We only have a partial function declaration,
565 so remember that we have to add a complete prototype. */
566 partial_count++;
567 partial = (struct partial_proto *)
568 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
569 partial->line_seen = fname->line;
570 partial->fn = fn;
571 fn->partial = partial;
572 partial->next = partial_proto_list;
573 partial_proto_list = partial;
574 if (verbose)
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. */
584 static void
585 check_macro_names (pfile, names)
586 cpp_reader *pfile;
587 namelist names;
589 size_t len;
590 while (*names)
592 len = strlen (names);
593 if (cpp_defined (pfile, (const unsigned char *)names, len))
594 recognized_macro (names);
595 names += len + 1;
599 static void
600 read_scan_file (in_fname, argc, argv)
601 char *in_fname;
602 int argc;
603 char **argv;
605 cpp_reader scan_in;
606 struct fn_decl *fn;
607 int i;
608 register struct symbol_list *cur_symbols;
610 obstack_init (&scan_file_obstack);
612 cpp_reader_init (&scan_in);
613 /* We are going to be scanning a header file out of its proper context,
614 so ignore warnings and errors. */
615 CPP_OPTION (&scan_in, inhibit_warnings) = 1;
616 CPP_OPTION (&scan_in, inhibit_errors) = 1;
617 i = cpp_handle_options (&scan_in, argc, argv);
618 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
619 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
620 if (CPP_FATAL_ERRORS (&scan_in))
621 exit (FATAL_EXIT_CODE);
623 if (! cpp_start_read (&scan_in, 0, in_fname))
624 exit (FATAL_EXIT_CODE);
626 /* We are scanning a system header, so mark it as such. */
627 cpp_make_system_header (&scan_in, CPP_BUFFER (&scan_in), 1);
629 scan_decls (&scan_in, argc, argv);
630 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
631 check_macro_names (&scan_in, cur_symbols->names);
633 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
634 If so, those functions are also required. */
635 if (special_file_handling == stdio_h
636 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
638 static const unsigned char getchar_call[] = "getchar();";
639 int seen_filbuf = 0;
640 cpp_buffer *buf = CPP_BUFFER (&scan_in);
641 if (cpp_push_buffer (&scan_in, getchar_call,
642 sizeof(getchar_call) - 1) == NULL)
643 return;
645 /* Scan the macro expansion of "getchar();". */
646 for (;;)
648 const cpp_token *t = cpp_get_token (&scan_in);
650 if (t->type == CPP_EOF)
652 cpp_pop_buffer (&scan_in);
653 if (CPP_BUFFER (&scan_in) == buf)
654 break;
656 else if (t->type == CPP_NAME && cpp_idcmp (t->val.name.text,
657 t->val.name.len,
658 "_filbuf") == 0)
659 seen_filbuf++;
661 if (seen_filbuf)
663 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
664 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
665 int need_flsbuf
666 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
668 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
669 if (need_filbuf + need_flsbuf)
671 const char *new_list;
672 if (need_filbuf)
673 SET_REQUIRED (fn);
674 if (need_flsbuf)
675 SET_REQUIRED (flsbuf_fn);
676 if (need_flsbuf && need_filbuf)
677 new_list = "_filbuf\0_flsbuf\0";
678 else if (need_flsbuf)
679 new_list = "_flsbuf\0";
680 else /* if (need_flsbuf) */
681 new_list = "_filbuf\0";
682 add_symbols (ANSI_SYMBOL, new_list);
683 required_unseen_count += need_filbuf + need_flsbuf;
688 if (required_unseen_count + partial_count + required_other
689 #if ADD_MISSING_EXTERN_C
690 + missing_extern_C_count
691 #endif
692 == 0)
694 if (verbose)
695 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
696 exit (SUCCESS_EXIT_CODE);
698 if (!verbose)
699 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
700 else
702 if (required_unseen_count)
703 fprintf (stderr, "%s: %d missing function declarations.\n",
704 inc_filename, required_unseen_count);
705 if (partial_count)
706 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
707 inc_filename, partial_count);
708 #if ADD_MISSING_EXTERN_C
709 if (missing_extern_C_count)
710 fprintf (stderr,
711 "%s: %d declarations not protected by extern \"C\".\n",
712 inc_filename, missing_extern_C_count);
713 #endif
717 static void
718 write_rbrac ()
720 struct fn_decl *fn;
721 const char *cptr;
722 register struct symbol_list *cur_symbols;
724 if (required_unseen_count)
726 #ifdef NO_IMPLICIT_EXTERN_C
727 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
728 #endif
731 /* Now we print out prototypes for those functions that we haven't seen. */
732 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
734 int if_was_emitted = 0;
735 int name_len;
736 cptr = cur_symbols->names;
737 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
739 int macro_protect = 0;
741 if (cur_symbols->flags & MACRO_SYMBOL)
742 continue;
744 fn = lookup_std_proto (cptr, name_len);
745 if (fn == NULL || !REQUIRED (fn))
746 continue;
748 if (!if_was_emitted)
750 /* what about curses. ??? or _flsbuf/_filbuf ??? */
751 if (cur_symbols->flags & ANSI_SYMBOL)
752 fprintf (outf,
753 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
754 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
755 fprintf (outf,
756 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
757 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
758 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
759 else if (cur_symbols->flags & XOPEN_SYMBOL)
761 fprintf (outf,
762 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
763 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
765 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
767 fprintf (outf,
768 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
769 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
771 else
773 fatal ("internal error for function %s", fn->fname);
775 if_was_emitted = 1;
778 /* In the case of memmove, protect in case the application
779 defines it as a macro before including the header. */
780 if (!strcmp (fn->fname, "memmove")
781 || !strcmp (fn->fname, "vprintf")
782 || !strcmp (fn->fname, "vfprintf")
783 || !strcmp (fn->fname, "vsprintf")
784 || !strcmp (fn->fname, "rewinddir")
785 || !strcmp (fn->fname, "abort"))
786 macro_protect = 1;
788 if (macro_protect)
789 fprintf (outf, "#ifndef %s\n", fn->fname);
790 fprintf (outf, "extern %s %s (%s);\n",
791 fn->rtype, fn->fname, fn->params);
792 if (macro_protect)
793 fprintf (outf, "#endif\n");
795 if (if_was_emitted)
796 fprintf (outf,
797 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
799 if (required_unseen_count)
801 #ifdef NO_IMPLICIT_EXTERN_C
802 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
803 #endif
806 switch (special_file_handling)
808 case errno_h:
809 if (!seen_errno)
810 fprintf (outf, "extern int errno;\n");
811 break;
812 case stdlib_h:
813 if (!seen_EXIT_FAILURE)
814 fprintf (outf, "#define EXIT_FAILURE 1\n");
815 if (!seen_EXIT_SUCCESS)
816 fprintf (outf, "#define EXIT_SUCCESS 0\n");
817 break;
818 case sys_stat_h:
819 if (!seen_S_ISBLK && seen_S_IFBLK)
820 fprintf (outf,
821 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
822 if (!seen_S_ISCHR && seen_S_IFCHR)
823 fprintf (outf,
824 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
825 if (!seen_S_ISDIR && seen_S_IFDIR)
826 fprintf (outf,
827 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
828 if (!seen_S_ISFIFO && seen_S_IFIFO)
829 fprintf (outf,
830 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
831 if (!seen_S_ISLNK && seen_S_IFLNK)
832 fprintf (outf,
833 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
834 if (!seen_S_ISREG && seen_S_IFREG)
835 fprintf (outf,
836 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
837 break;
839 default:
840 break;
844 #if ADD_MISSING_EXTERN_C
845 if (missing_extern_C_count + required_unseen_count > 0)
846 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
847 #endif
850 /* Returns 1 iff the file is properly protected from multiple inclusion:
851 #ifndef PROTECT_NAME
852 #define PROTECT_NAME
853 #endif
857 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
858 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
860 static int
861 inf_skip_spaces (c)
862 int c;
864 for (;;)
866 if (c == ' ' || c == '\t')
867 c = INF_GET ();
868 else if (c == '/')
870 c = INF_GET ();
871 if (c != '*')
873 (void) INF_UNGET (c);
874 return '/';
876 c = INF_GET ();
877 for (;;)
879 if (c == EOF)
880 return EOF;
881 else if (c != '*')
883 if (c == '\n')
884 source_lineno++, lineno++;
885 c = INF_GET ();
887 else if ((c = INF_GET ()) == '/')
888 return INF_GET ();
891 else
892 break;
894 return c;
897 /* Read into STR from inf_buffer upto DELIM. */
899 static int
900 inf_read_upto (str, delim)
901 sstring *str;
902 int delim;
904 int ch;
905 for (;;)
907 ch = INF_GET ();
908 if (ch == EOF || ch == delim)
909 break;
910 SSTRING_PUT (str, ch);
912 MAKE_SSTRING_SPACE (str, 1);
913 *str->ptr = 0;
914 return ch;
917 static int
918 inf_scan_ident (s, c)
919 register sstring *s;
920 int c;
922 s->ptr = s->base;
923 if (ISALPHA (c) || c == '_')
925 for (;;)
927 SSTRING_PUT (s, c);
928 c = INF_GET ();
929 if (c == EOF || !(ISALNUM (c) || c == '_'))
930 break;
933 MAKE_SSTRING_SPACE (s, 1);
934 *s->ptr = 0;
935 return c;
938 /* Returns 1 if the file is correctly protected against multiple
939 inclusion, setting *ifndef_line to the line number of the initial #ifndef
940 and setting *endif_line to the final #endif.
941 Otherwise return 0. */
943 static int
944 check_protection (ifndef_line, endif_line)
945 int *ifndef_line, *endif_line;
947 int c;
948 int if_nesting = 1; /* Level of nesting of #if's */
949 char *protect_name = NULL; /* Identifier following initial #ifndef */
950 int define_seen = 0;
952 /* Skip initial white space (including comments). */
953 for (;; lineno++)
955 c = inf_skip_spaces (' ');
956 if (c == EOF)
957 return 0;
958 if (c != '\n')
959 break;
961 if (c != '#')
962 return 0;
963 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
964 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
965 return 0;
967 /* So far so good: We've seen an initial #ifndef. */
968 *ifndef_line = lineno;
969 c = inf_scan_ident (&buf, inf_skip_spaces (c));
970 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
971 return 0;
972 protect_name = xstrdup (buf.base);
974 (void) INF_UNGET (c);
975 c = inf_read_upto (&buf, '\n');
976 if (c == EOF)
977 return 0;
978 lineno++;
980 for (;;)
982 c = inf_skip_spaces (' ');
983 if (c == EOF)
984 return 0;
985 if (c == '\n')
987 lineno++;
988 continue;
990 if (c != '#')
991 goto skip_to_eol;
992 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
993 if (SSTRING_LENGTH (&buf) == 0)
995 else if (!strcmp (buf.base, "ifndef")
996 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
998 if_nesting++;
1000 else if (!strcmp (buf.base, "endif"))
1002 if_nesting--;
1003 if (if_nesting == 0)
1004 break;
1006 else if (!strcmp (buf.base, "else"))
1008 if (if_nesting == 1)
1009 return 0;
1011 else if (!strcmp (buf.base, "define"))
1013 c = inf_skip_spaces (c);
1014 c = inf_scan_ident (&buf, c);
1015 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1016 define_seen = 1;
1018 skip_to_eol:
1019 for (;;)
1021 if (c == '\n' || c == EOF)
1022 break;
1023 c = INF_GET ();
1025 if (c == EOF)
1026 return 0;
1027 lineno++;
1030 if (!define_seen)
1031 return 0;
1032 *endif_line = lineno;
1033 /* Skip final white space (including comments). */
1034 for (;;)
1036 c = inf_skip_spaces (' ');
1037 if (c == EOF)
1038 break;
1039 if (c != '\n')
1040 return 0;
1043 return 1;
1046 extern int main PARAMS ((int, char **));
1049 main (argc, argv)
1050 int argc;
1051 char **argv;
1053 int inf_fd;
1054 struct stat sbuf;
1055 int c;
1056 #ifdef FIXPROTO_IGNORE_LIST
1057 int i;
1058 #endif
1059 const char *cptr;
1060 int ifndef_line;
1061 int endif_line;
1062 long to_read;
1063 long int inf_size;
1064 register struct symbol_list *cur_symbols;
1066 if (argv[0] && argv[0][0])
1068 register char *p;
1070 progname = 0;
1071 for (p = argv[0]; *p; p++)
1072 if (*p == '/')
1073 progname = p;
1074 progname = progname ? progname+1 : argv[0];
1077 if (argc < 4)
1079 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1080 progname);
1081 exit (FATAL_EXIT_CODE);
1084 inc_filename = argv[1];
1085 inc_filename_length = strlen (inc_filename);
1087 #ifdef FIXPROTO_IGNORE_LIST
1088 for (i = 0; files_to_ignore[i] != NULL; i++)
1090 char *ignore_name = files_to_ignore[i];
1091 int ignore_len = strlen (ignore_name);
1092 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1094 if (ignore_name[ignore_len-1] == '/'
1095 || inc_filename[ignore_len] == '\0')
1097 if (verbose)
1098 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1099 exit (SUCCESS_EXIT_CODE);
1104 #endif
1106 if (strcmp (inc_filename, "sys/stat.h") == 0)
1107 special_file_handling = sys_stat_h;
1108 else if (strcmp (inc_filename, "errno.h") == 0)
1109 special_file_handling = errno_h, required_other++;
1110 else if (strcmp (inc_filename, "stdlib.h") == 0)
1111 special_file_handling = stdlib_h, required_other+=2;
1112 else if (strcmp (inc_filename, "stdio.h") == 0)
1113 special_file_handling = stdio_h;
1114 include_entry = std_include_table;
1115 while (include_entry->name != NULL
1116 && ((strcmp (include_entry->name, CONTINUED) == 0)
1117 || strcmp (inc_filename, include_entry->name) != 0))
1118 include_entry++;
1120 if (include_entry->name != NULL)
1122 struct std_include_entry *entry;
1123 cur_symbol_table_size = 0;
1124 for (entry = include_entry; ;)
1126 if (entry->flags)
1127 add_symbols (entry->flags, entry->names);
1128 entry++;
1129 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1130 break;
1133 else
1134 symbol_table[0].names = NULL;
1136 /* Count and mark the prototypes required for this include file. */
1137 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1139 int name_len;
1140 if (cur_symbols->flags & MACRO_SYMBOL)
1141 continue;
1142 cptr = cur_symbols->names;
1143 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1145 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1146 required_unseen_count++;
1147 if (fn == NULL)
1148 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1149 else
1150 SET_REQUIRED (fn);
1154 read_scan_file (argv[2], argc - 4, argv + 4);
1156 inf_fd = open (argv[2], O_RDONLY, 0666);
1157 if (inf_fd < 0)
1159 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1160 progname, argv[2]);
1161 perror (NULL);
1162 exit (FATAL_EXIT_CODE);
1164 if (fstat (inf_fd, &sbuf) < 0)
1166 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1167 perror (NULL);
1168 exit (FATAL_EXIT_CODE);
1170 inf_size = sbuf.st_size;
1171 inf_buffer = (char *) xmalloc (inf_size + 2);
1172 inf_buffer[inf_size] = '\n';
1173 inf_buffer[inf_size + 1] = '\0';
1174 inf_limit = inf_buffer + inf_size;
1175 inf_ptr = inf_buffer;
1177 to_read = inf_size;
1178 while (to_read > 0)
1180 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1181 if (i < 0)
1183 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1184 perror (NULL);
1185 exit (FATAL_EXIT_CODE);
1187 if (i == 0)
1189 inf_size -= to_read;
1190 break;
1192 to_read -= i;
1195 close (inf_fd);
1197 /* If file doesn't end with '\n', add one. */
1198 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1199 inf_limit++;
1201 unlink (argv[3]);
1202 outf = fopen (argv[3], "w");
1203 if (outf == NULL)
1205 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1206 progname, argv[3]);
1207 perror (NULL);
1208 exit (FATAL_EXIT_CODE);
1211 lineno = 1;
1213 if (check_protection (&ifndef_line, &endif_line))
1215 lbrac_line = ifndef_line+1;
1216 rbrac_line = endif_line;
1218 else
1220 lbrac_line = 1;
1221 rbrac_line = -1;
1224 /* Reset input file. */
1225 inf_ptr = inf_buffer;
1226 lineno = 1;
1228 for (;;)
1230 if (lineno == lbrac_line)
1231 write_lbrac ();
1232 if (lineno == rbrac_line)
1233 write_rbrac ();
1234 for (;;)
1236 struct fn_decl *fn;
1237 c = INF_GET ();
1238 if (c == EOF)
1239 break;
1240 if (ISALPHA (c) || c == '_')
1242 c = inf_scan_ident (&buf, c);
1243 (void) INF_UNGET (c);
1244 fputs (buf.base, outf);
1245 fn = lookup_std_proto (buf.base, strlen (buf.base));
1246 /* We only want to edit the declaration matching the one
1247 seen by scan-decls, as there can be multiple
1248 declarations, selected by #ifdef __STDC__ or whatever. */
1249 if (fn && fn->partial && fn->partial->line_seen == lineno)
1251 c = inf_skip_spaces (' ');
1252 if (c == EOF)
1253 break;
1254 if (c == '(')
1256 c = inf_skip_spaces (' ');
1257 if (c == ')')
1259 fprintf (outf, " _PARAMS((%s))", fn->params);
1261 else
1263 putc ('(', outf);
1264 (void) INF_UNGET (c);
1267 else
1268 fprintf (outf, " %c", c);
1271 else
1273 putc (c, outf);
1274 if (c == '\n')
1275 break;
1278 if (c == EOF)
1279 break;
1280 lineno++;
1282 if (rbrac_line < 0)
1283 write_rbrac ();
1285 fclose (outf);
1287 return 0;
1291 static void
1292 v_fatal (str, ap)
1293 const char * str;
1294 va_list ap;
1296 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1297 vfprintf (stderr, str, ap);
1298 fprintf (stderr, "\n");
1300 exit (FATAL_EXIT_CODE);
1303 static void
1304 fatal VPARAMS ((const char *str, ...))
1306 #ifndef ANSI_PROTOTYPES
1307 const char *str;
1308 #endif
1309 va_list ap;
1311 VA_START(ap, str);
1313 #ifndef ANSI_PROTOTYPES
1314 str = va_arg (ap, const char *);
1315 #endif
1317 v_fatal(str, ap);
1318 va_end(ap);