Import final gcc2 snapshot (990109)
[official-gcc.git] / gcc / fix-header.c
blobd998114d3e0be050ac47290e1a3038ea94a600c0
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 94, 95, 96, 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 lust 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 extern void cpp_fatal ();
82 #if !__STDC__ && !defined(const)
83 #define const /* nothing */
84 #endif
86 sstring buf;
88 int verbose = 0;
89 int partial_count = 0;
90 int warnings = 0;
92 /* We no longer need to add extern "C", because cpp implicitly
93 forces the standard include files to be treated as C. */
94 /*#define ADD_MISSING_EXTERN_C 1 */
96 #if ADD_MISSING_EXTERN_C
97 int missing_extern_C_count = 0;
98 #endif
100 #include "xsys-protos.h"
102 #ifdef FIXPROTO_IGNORE_LIST
103 /* This is a currently unused feature. */
105 /* List of files and directories to ignore.
106 A directory name (ending in '/') means ignore anything in that
107 directory. (It might be more efficient to do directory pruning
108 earlier in fixproto, but this is simpler and easier to customize.) */
110 static char *files_to_ignore[] = {
111 "X11/",
112 FIXPROTO_IGNORE_LIST
115 #endif
117 char *inf_buffer;
118 char *inf_limit;
119 char *inf_ptr;
121 /* Certain standard files get extra treatment */
123 enum special_file
125 no_special,
126 errno_h,
127 stdio_h,
128 stdlib_h,
129 sys_stat_h
132 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
133 by an empty name (i.e. by "\0\0"). */
135 typedef const char *namelist;
137 /* The following macros provide the bits for symbol_flags. */
138 typedef int symbol_flags;
140 /* Used to mark names defined in the ANSI/ISO C standard. */
141 #define ANSI_SYMBOL 1
143 /* We no longer massage include files for POSIX or XOPEN symbols,
144 as there are now several versions of the POSIX and XOPEN standards,
145 and it would be a maintenance nightmare for us to track them all.
146 Better to be compatible with the system include files. */
147 /*#define ADD_MISSING_POSIX 1 */
148 /*#define ADD_MISSING_XOPEN 1 */
150 #if ADD_MISSING_POSIX
151 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
152 #define POSIX1_SYMBOL 2
153 #define POSIX2_SYMBOL 4
154 #else
155 #define POSIX1_SYMBOL 0
156 #define POSIX2_SYMBOL 0
157 #endif
159 #if ADD_MISSING_XOPEN
160 /* Used to mark names defined in X/Open Portability Guide. */
161 #define XOPEN_SYMBOL 8
162 /* Used to mark names defined in X/Open UNIX Extensions. */
163 #define XOPEN_EXTENDED_SYMBOL 16
164 #else
165 #define XOPEN_SYMBOL 0
166 #define XOPEN_EXTENDED_SYMBOL 0
167 #endif
169 /* Used to indicate names that are not functions */
170 #define MACRO_SYMBOL 512
172 struct symbol_list {
173 symbol_flags flags;
174 namelist names;
177 #define SYMBOL_TABLE_SIZE 10
178 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
179 int cur_symbol_table_size;
181 void
182 add_symbols (flags, names)
183 symbol_flags flags;
184 namelist names;
186 symbol_table[cur_symbol_table_size].flags = flags;
187 symbol_table[cur_symbol_table_size].names = names;
188 cur_symbol_table_size++;
189 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
190 fatal ("too many calls to add_symbols");
191 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
194 struct std_include_entry {
195 const char *name;
196 symbol_flags flags;
197 namelist names;
200 const char NONE[] = ""; /* The empty namelist. */
202 /* Special name to indicate a continuation line in std_include_table. */
203 const char CONTINUED[] = "";
205 struct std_include_entry *include_entry;
207 struct std_include_entry std_include_table [] = {
208 { "ctype.h", ANSI_SYMBOL,
209 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
210 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
212 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
214 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
216 /* ANSI_SYMBOL is wrong, but ... */
217 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
218 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
219 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
220 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
221 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
223 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
225 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
226 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
228 /*{ "limit.h", ... provided by gcc }, */
230 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
232 { "math.h", ANSI_SYMBOL,
233 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
234 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
235 tan\0tanh\0" },
237 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
239 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
241 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
242 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
244 /* Left out signal() - its prototype is too complex for us!
245 Also left out "sigaction sigaddset sigdelset sigemptyset
246 sigfillset sigismember sigpending sigprocmask sigsuspend"
247 because these need sigset_t or struct sigaction.
248 Most systems that provide them will also declare them. */
249 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
251 { "stdio.h", ANSI_SYMBOL,
252 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
253 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
254 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
255 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
256 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
257 tmpnam\0ungetc\0" },
258 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
259 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
260 /* Should perhaps also handle NULL, EOF, ... ? */
262 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
263 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
264 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
265 Should perhaps also add NULL */
266 { "stdlib.h", ANSI_SYMBOL,
267 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
268 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
269 srand\0strtod\0strtol\0strtoul\0system\0" },
270 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
272 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
273 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
274 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
275 strtok\0strxfrm\0" },
276 /* Should perhaps also add NULL and size_t */
278 { "strings.h", XOPEN_EXTENDED_SYMBOL,
279 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
281 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
283 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
284 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
285 and many systems do have <sys/ioctl.h> but not <strops.h>. */
286 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
288 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
290 { "sys/stat.h", POSIX1_SYMBOL,
291 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
292 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
293 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
294 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
295 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
297 #if 0
298 /* How do we handle fd_set? */
299 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
300 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
301 #endif
303 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
304 /* "sys/types.h" add types (not in old g++-include) */
306 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
308 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
309 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
310 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
311 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
313 { "tar.h", POSIX1_SYMBOL, NONE },
315 { "termios.h", POSIX1_SYMBOL,
316 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
318 { "time.h", ANSI_SYMBOL,
319 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
321 { "unistd.h", POSIX1_SYMBOL,
322 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
323 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
324 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
325 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
326 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
327 ttyname\0unlink\0write\0" },
328 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
329 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
330 "lockf\0gethostid\0gethostname\0readlink\0" },
332 { "utime.h", POSIX1_SYMBOL, "utime\0" },
334 { NULL, 0, NONE }
337 enum special_file special_file_handling = no_special;
339 /* They are set if the corresponding macro has been seen. */
340 /* The following are only used when handling sys/stat.h */
341 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
342 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
343 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
344 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
345 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
346 int seen_S_IFREG = 0, seen_S_ISREG = 0;
347 /* The following are only used when handling errno.h */
348 int seen_errno = 0;
349 /* The following are only used when handling stdlib.h */
350 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
352 /* Wrapper around free, to avoid prototype clashes. */
354 void
355 xfree (ptr)
356 char *ptr;
358 free (ptr);
361 /* Avoid error if config defines abort as fancy_abort.
362 It's not worth "really" implementing this because ordinary
363 compiler users never run fix-header. */
365 void
366 fancy_abort ()
368 abort ();
371 #define obstack_chunk_alloc xmalloc
372 #define obstack_chunk_free xfree
373 struct obstack scan_file_obstack;
375 /* NOTE: If you edit this, also edit gen-protos.c !! */
377 struct fn_decl *
378 lookup_std_proto (name, name_length)
379 const char *name;
380 int name_length;
382 int i = hashf (name, name_length, HASH_SIZE);
383 int i0 = i;
384 for (;;)
386 struct fn_decl *fn;
387 if (hash_tab[i] == 0)
388 return NULL;
389 fn = &std_protos[hash_tab[i]];
390 if (strlen (fn->fname) == name_length
391 && strncmp (fn->fname, name, name_length) == 0)
392 return fn;
393 i = (i+1) % HASH_SIZE;
394 if (i == i0)
395 abort ();
399 char *inc_filename;
400 int inc_filename_length;
401 char *progname = "fix-header";
402 FILE *outf;
403 sstring line;
405 int lbrac_line, rbrac_line;
407 int required_unseen_count = 0;
408 int required_other = 0;
410 void
411 write_lbrac ()
414 #if ADD_MISSING_EXTERN_C
415 if (missing_extern_C_count + required_unseen_count > 0)
416 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
417 #endif
419 if (partial_count)
421 fprintf (outf, "#ifndef _PARAMS\n");
422 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
423 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
424 fprintf (outf, "#else\n");
425 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
426 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
430 struct partial_proto
432 struct partial_proto *next;
433 char *fname; /* name of function */
434 char *rtype; /* return type */
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 void
448 recognized_macro (fname)
449 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++;
493 void
494 recognized_extern (name, name_length, type, type_length)
495 char *name;
496 char *type;
497 int name_length, type_length;
499 switch (special_file_handling)
501 case errno_h:
502 if (name_length == 5 && strncmp (name, "errno", 5) == 0 && !seen_errno)
503 seen_errno = 1, required_other--;
504 break;
508 /* Called by scan_decls if it saw a function definition for a function
509 named FNAME, with return type RTYPE, and argument list ARGS,
510 in source file FILE_SEEN on line LINE_SEEN.
511 KIND is 'I' for an inline function;
512 'F' if a normal function declaration preceded by 'extern "C"'
513 (or nested inside 'extern "C"' braces); or
514 'f' for other function declarations. */
516 void
517 recognized_function (fname, fname_length,
518 kind, rtype, rtype_length,
519 have_arg_list, file_seen, line_seen)
520 char *fname;
521 int fname_length;
522 int kind; /* One of 'f' 'F' or 'I' */
523 char *rtype;
524 int rtype_length;
525 int have_arg_list;
526 char *file_seen;
527 int line_seen;
529 struct partial_proto *partial;
530 int i;
531 struct fn_decl *fn;
532 #if ADD_MISSING_EXTERN_C
533 if (kind == 'f')
534 missing_extern_C_count++;
535 #endif
537 fn = lookup_std_proto (fname, fname_length);
539 /* Remove the function from the list of required function. */
540 if (fn)
542 if (REQUIRED (fn))
543 required_unseen_count--;
544 SET_SEEN (fn);
547 /* If we have a full prototype, we're done. */
548 if (have_arg_list)
549 return;
551 if (kind == 'I') /* don't edit inline function */
552 return;
554 /* If the partial prototype was included from some other file,
555 we don't need to patch it up (in this run). */
556 i = strlen (file_seen);
557 if (i < inc_filename_length
558 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
559 return;
561 if (fn == NULL)
562 return;
563 if (fn->params[0] == '\0' || strcmp (fn->params, "void") == 0)
564 return;
566 /* We only have a partial function declaration,
567 so remember that we have to add a complete prototype. */
568 partial_count++;
569 partial = (struct partial_proto *)
570 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
571 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
572 bcopy (fname, partial->fname, fname_length);
573 partial->fname[fname_length] = 0;
574 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
575 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
576 partial->line_seen = line_seen;
577 partial->fn = fn;
578 fn->partial = partial;
579 partial->next = partial_proto_list;
580 partial_proto_list = partial;
581 if (verbose)
583 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
584 inc_filename, partial->fname);
588 /* For any name in NAMES that is defined as a macro,
589 call recognized_macro on it. */
591 void
592 check_macro_names (pfile, names)
593 cpp_reader *pfile;
594 namelist names;
596 while (*names)
598 if (cpp_lookup (pfile, names, -1, -1))
599 recognized_macro (names);
600 names += strlen (names) + 1;
604 void
605 read_scan_file (in_fname, argc, argv)
606 char *in_fname;
607 int argc;
608 char **argv;
610 cpp_reader scan_in;
611 cpp_options scan_options;
612 struct fn_decl *fn;
613 int i;
614 register struct symbol_list *cur_symbols;
616 obstack_init (&scan_file_obstack);
618 cpp_reader_init (&scan_in);
619 scan_in.data = &scan_options;
620 cpp_options_init (&scan_options);
621 i = cpp_handle_options (&scan_in, argc, argv);
622 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
623 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
624 if (CPP_FATAL_ERRORS (&scan_in))
625 exit (FATAL_EXIT_CODE);
627 if (! cpp_start_read (&scan_in, in_fname))
628 exit (FATAL_EXIT_CODE);
629 CPP_OPTIONS (&scan_in)->no_line_commands = 1;
631 scan_decls (&scan_in, argc, argv);
632 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
633 check_macro_names (&scan_in, cur_symbols->names);
635 if (verbose && (scan_in.errors + warnings) > 0)
636 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
637 inc_filename, scan_in.errors, warnings);
638 if (scan_in.errors)
639 exit (SUCCESS_EXIT_CODE);
641 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
642 If so, those functions are also required. */
643 if (special_file_handling == stdio_h
644 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
646 static char getchar_call[] = "getchar();";
647 cpp_buffer *buf
648 = cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
649 int old_written = CPP_WRITTEN (&scan_in);
650 int seen_filbuf = 0;
652 /* Scan the macro expansion of "getchar();". */
653 for (;;)
655 enum cpp_token token = cpp_get_token (&scan_in);
656 int length = CPP_WRITTEN (&scan_in) - old_written;
657 CPP_SET_WRITTEN (&scan_in, old_written);
658 if (token == CPP_EOF) /* Should not happen ... */
659 break;
660 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
662 cpp_pop_buffer (&scan_in);
663 break;
665 if (token == CPP_NAME && length == 7
666 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
667 seen_filbuf++;
669 if (seen_filbuf)
671 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
672 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
673 int need_flsbuf
674 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
676 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
677 if (need_filbuf + need_flsbuf)
679 char *new_list;
680 if (need_filbuf)
681 SET_REQUIRED (fn);
682 if (need_flsbuf)
683 SET_REQUIRED (flsbuf_fn);
684 if (need_flsbuf + need_filbuf == 2)
685 new_list = "_filbuf\0_flsbuf\0";
686 else if (need_flsbuf)
687 new_list = "_flsbuf\0";
688 else /* if (need_flsbuf) */
689 new_list = "_filbuf\0";
690 add_symbols (ANSI_SYMBOL, new_list);
691 required_unseen_count += need_filbuf + need_flsbuf;
696 if (required_unseen_count + partial_count + required_other
697 #if ADD_MISSING_EXTERN_C
698 + missing_extern_C_count
699 #endif
700 == 0)
702 if (verbose)
703 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
704 exit (SUCCESS_EXIT_CODE);
706 if (!verbose)
707 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
708 else
710 if (required_unseen_count)
711 fprintf (stderr, "%s: %d missing function declarations.\n",
712 inc_filename, required_unseen_count);
713 if (partial_count)
714 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
715 inc_filename, partial_count);
716 #if ADD_MISSING_EXTERN_C
717 if (missing_extern_C_count)
718 fprintf (stderr,
719 "%s: %d declarations not protected by extern \"C\".\n",
720 inc_filename, missing_extern_C_count);
721 #endif
725 void
726 write_rbrac ()
728 struct fn_decl *fn;
729 const char *cptr;
730 register struct symbol_list *cur_symbols;
732 if (required_unseen_count)
734 #ifdef NO_IMPLICIT_EXTERN_C
735 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
736 #endif
739 /* Now we print out prototypes for those functions that we haven't seen. */
740 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
742 int if_was_emitted = 0;
743 int name_len;
744 cptr = cur_symbols->names;
745 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
747 int macro_protect = 0;
749 if (cur_symbols->flags & MACRO_SYMBOL)
750 continue;
752 fn = lookup_std_proto (cptr, name_len);
753 if (fn == NULL || !REQUIRED (fn))
754 continue;
756 if (!if_was_emitted)
758 /* what about curses. ??? or _flsbuf/_filbuf ??? */
759 if (cur_symbols->flags & ANSI_SYMBOL)
760 fprintf (outf,
761 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
762 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
763 fprintf (outf,
764 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
765 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
766 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
767 else if (cur_symbols->flags & XOPEN_SYMBOL)
769 fprintf (outf,
770 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
771 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
773 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
775 fprintf (outf,
776 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
777 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
779 else
781 fatal ("internal error for function %s", fn->fname);
783 if_was_emitted = 1;
786 /* In the case of memmove, protect in case the application
787 defines it as a macro before including the header. */
788 if (!strcmp (fn->fname, "memmove")
789 || !strcmp (fn->fname, "vprintf")
790 || !strcmp (fn->fname, "vfprintf")
791 || !strcmp (fn->fname, "vsprintf")
792 || !strcmp (fn->fname, "rewinddir"))
793 macro_protect = 1;
795 if (macro_protect)
796 fprintf (outf, "#ifndef %s\n", fn->fname);
797 fprintf (outf, "extern %s %s (%s);\n",
798 fn->rtype, fn->fname, fn->params);
799 if (macro_protect)
800 fprintf (outf, "#endif\n");
802 if (if_was_emitted)
803 fprintf (outf,
804 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
806 if (required_unseen_count)
808 #ifdef NO_IMPLICIT_EXTERN_C
809 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
810 #endif
813 switch (special_file_handling)
815 case errno_h:
816 if (!seen_errno)
817 fprintf (outf, "extern int errno;\n");
818 break;
819 case stdlib_h:
820 if (!seen_EXIT_FAILURE)
821 fprintf (outf, "#define EXIT_FAILURE 1\n");
822 if (!seen_EXIT_SUCCESS)
823 fprintf (outf, "#define EXIT_SUCCESS 0\n");
824 break;
825 case sys_stat_h:
826 if (!seen_S_ISBLK && seen_S_IFBLK)
827 fprintf (outf,
828 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
829 if (!seen_S_ISCHR && seen_S_IFCHR)
830 fprintf (outf,
831 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
832 if (!seen_S_ISDIR && seen_S_IFDIR)
833 fprintf (outf,
834 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
835 if (!seen_S_ISFIFO && seen_S_IFIFO)
836 fprintf (outf,
837 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
838 if (!seen_S_ISLNK && seen_S_IFLNK)
839 fprintf (outf,
840 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
841 if (!seen_S_ISREG && seen_S_IFREG)
842 fprintf (outf,
843 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
844 break;
848 #if ADD_MISSING_EXTERN_C
849 if (missing_extern_C_count + required_unseen_count > 0)
850 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
851 #endif
854 char *
855 xstrdup (str)
856 char *str;
858 char *copy = (char *) xmalloc (strlen (str) + 1);
859 strcpy (copy, str);
860 return copy;
863 /* Returns 1 iff the file is properly protected from multiple inclusion:
864 #ifndef PROTECT_NAME
865 #define PROTECT_NAME
866 #endif
870 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
871 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
874 inf_skip_spaces (c)
875 int c;
877 for (;;)
879 if (c == ' ' || c == '\t')
880 c = INF_GET ();
881 else if (c == '/')
883 c = INF_GET ();
884 if (c != '*')
886 INF_UNGET (c);
887 return '/';
889 c = INF_GET ();
890 for (;;)
892 if (c == EOF)
893 return EOF;
894 else if (c != '*')
896 if (c == '\n')
897 source_lineno++, lineno++;
898 c = INF_GET ();
900 else if ((c = INF_GET ()) == '/')
901 return INF_GET ();
904 else
905 break;
907 return c;
910 /* Read into STR from inf_buffer upto DELIM. */
913 inf_read_upto (str, delim)
914 sstring *str;
915 int delim;
917 int ch;
918 for (;;)
920 ch = INF_GET ();
921 if (ch == EOF || ch == delim)
922 break;
923 SSTRING_PUT (str, ch);
925 MAKE_SSTRING_SPACE (str, 1);
926 *str->ptr = 0;
927 return ch;
931 inf_scan_ident (s, c)
932 register sstring *s;
933 int c;
935 s->ptr = s->base;
936 if (isalpha (c) || c == '_')
938 for (;;)
940 SSTRING_PUT (s, c);
941 c = INF_GET ();
942 if (c == EOF || !(isalnum (c) || c == '_'))
943 break;
946 MAKE_SSTRING_SPACE (s, 1);
947 *s->ptr = 0;
948 return c;
951 /* Returns 1 if the file is correctly protected against multiple
952 inclusion, setting *ifndef_line to the line number of the initial #ifndef
953 and setting *endif_line to the final #endif.
954 Otherwise return 0. */
957 check_protection (ifndef_line, endif_line)
958 int *ifndef_line, *endif_line;
960 int c;
961 int if_nesting = 1; /* Level of nesting of #if's */
962 char *protect_name = NULL; /* Identifier following initial #ifndef */
963 int define_seen = 0;
965 /* Skip initial white space (including comments). */
966 for (;; lineno++)
968 c = inf_skip_spaces (' ');
969 if (c == EOF)
970 return 0;
971 if (c != '\n')
972 break;
974 if (c != '#')
975 return 0;
976 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
977 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
978 return 0;
980 /* So far so good: We've seen an initial #ifndef. */
981 *ifndef_line = lineno;
982 c = inf_scan_ident (&buf, inf_skip_spaces (c));
983 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
984 return 0;
985 protect_name = xstrdup (buf.base);
987 INF_UNGET (c);
988 c = inf_read_upto (&buf, '\n');
989 if (c == EOF)
990 return 0;
991 lineno++;
993 for (;;)
995 c = inf_skip_spaces (' ');
996 if (c == EOF)
997 return 0;
998 if (c == '\n')
1000 lineno++;
1001 continue;
1003 if (c != '#')
1004 goto skip_to_eol;
1005 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1006 if (SSTRING_LENGTH (&buf) == 0)
1008 else if (!strcmp (buf.base, "ifndef")
1009 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1011 if_nesting++;
1013 else if (!strcmp (buf.base, "endif"))
1015 if_nesting--;
1016 if (if_nesting == 0)
1017 break;
1019 else if (!strcmp (buf.base, "else"))
1021 if (if_nesting == 1)
1022 return 0;
1024 else if (!strcmp (buf.base, "define"))
1026 if (if_nesting != 1)
1027 goto skip_to_eol;
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)
1031 define_seen = 1;
1033 skip_to_eol:
1034 for (;;)
1036 if (c == '\n' || c == EOF)
1037 break;
1038 c = INF_GET ();
1040 if (c == EOF)
1041 return 0;
1042 lineno++;
1045 if (!define_seen)
1046 return 0;
1047 *endif_line = lineno;
1048 /* Skip final white space (including comments). */
1049 for (;;)
1051 c = inf_skip_spaces (' ');
1052 if (c == EOF)
1053 break;
1054 if (c != '\n')
1055 return 0;
1058 return 1;
1062 main (argc, argv)
1063 int argc;
1064 char **argv;
1066 int inf_fd;
1067 struct stat sbuf;
1068 int c;
1069 int i, done;
1070 const char *cptr, **pptr;
1071 int ifndef_line;
1072 int endif_line;
1073 long to_read;
1074 long int inf_size;
1075 register struct symbol_list *cur_symbols;
1077 if (argv[0] && argv[0][0])
1079 register char *p;
1081 progname = 0;
1082 for (p = argv[0]; *p; p++)
1083 if (*p == '/')
1084 progname = p;
1085 progname = progname ? progname+1 : argv[0];
1088 if (argc < 4)
1090 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1091 progname);
1092 exit (FATAL_EXIT_CODE);
1095 inc_filename = argv[1];
1096 inc_filename_length = strlen (inc_filename);
1098 #ifdef FIXPROTO_IGNORE_LIST
1099 for (i = 0; files_to_ignore[i] != NULL; i++)
1101 char *ignore_name = files_to_ignore[i];
1102 int ignore_len = strlen (ignore_name);
1103 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1105 if (ignore_name[ignore_len-1] == '/'
1106 || inc_filename[ignore_len] == '\0')
1108 if (verbose)
1109 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1110 exit (SUCCESS_EXIT_CODE);
1115 #endif
1117 if (strcmp (inc_filename, "sys/stat.h") == 0)
1118 special_file_handling = sys_stat_h;
1119 else if (strcmp (inc_filename, "errno.h") == 0)
1120 special_file_handling = errno_h, required_other++;
1121 else if (strcmp (inc_filename, "stdlib.h") == 0)
1122 special_file_handling = stdlib_h, required_other+=2;
1123 else if (strcmp (inc_filename, "stdio.h") == 0)
1124 special_file_handling = stdio_h;
1125 include_entry = std_include_table;
1126 while (include_entry->name != NULL
1127 && (include_entry->name == CONTINUED
1128 || strcmp (inc_filename, include_entry->name) != 0))
1129 include_entry++;
1131 if (include_entry->name != NULL)
1133 struct std_include_entry *entry;
1134 cur_symbol_table_size = 0;
1135 for (entry = include_entry; ;)
1137 if (entry->flags)
1138 add_symbols (entry->flags, entry->names);
1139 entry++;
1140 if (entry->name != CONTINUED)
1141 break;
1144 else
1145 symbol_table[0].names = NULL;
1147 /* Count and mark the prototypes required for this include file. */
1148 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1150 int name_len;
1151 if (cur_symbols->flags & MACRO_SYMBOL)
1152 continue;
1153 cptr = cur_symbols->names;
1154 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1156 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1157 required_unseen_count++;
1158 if (fn == NULL)
1159 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1160 else
1161 SET_REQUIRED (fn);
1165 read_scan_file (argv[2], argc - 4, argv + 4);
1167 inf_fd = open (argv[2], O_RDONLY, 0666);
1168 if (inf_fd < 0)
1170 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1171 progname, argv[2]);
1172 perror (NULL);
1173 exit (FATAL_EXIT_CODE);
1175 if (fstat (inf_fd, &sbuf) < 0)
1177 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1178 perror (NULL);
1179 exit (FATAL_EXIT_CODE);
1181 inf_size = sbuf.st_size;
1182 inf_buffer = (char *) xmalloc (inf_size + 2);
1183 inf_buffer[inf_size] = '\n';
1184 inf_buffer[inf_size + 1] = '\0';
1185 inf_limit = inf_buffer + inf_size;
1186 inf_ptr = inf_buffer;
1188 to_read = inf_size;
1189 while (to_read > 0)
1191 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1192 if (i < 0)
1194 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1195 perror (NULL);
1196 exit (FATAL_EXIT_CODE);
1198 if (i == 0)
1200 inf_size -= to_read;
1201 break;
1203 to_read -= i;
1206 close (inf_fd);
1208 /* If file doesn't end with '\n', add one. */
1209 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1210 inf_limit++;
1212 unlink (argv[3]);
1213 outf = fopen (argv[3], "w");
1214 if (outf == NULL)
1216 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1217 progname, argv[3]);
1218 perror (NULL);
1219 exit (FATAL_EXIT_CODE);
1222 lineno = 1;
1224 if (check_protection (&ifndef_line, &endif_line))
1226 lbrac_line = ifndef_line+1;
1227 rbrac_line = endif_line;
1229 else
1231 lbrac_line = 1;
1232 rbrac_line = -1;
1235 /* Reset input file. */
1236 inf_ptr = inf_buffer;
1237 lineno = 1;
1239 for (;;)
1241 if (lineno == lbrac_line)
1242 write_lbrac ();
1243 if (lineno == rbrac_line)
1244 write_rbrac ();
1245 for (;;)
1247 struct fn_decl *fn;
1248 c = INF_GET ();
1249 if (c == EOF)
1250 break;
1251 if (isalpha (c) || c == '_')
1253 c = inf_scan_ident (&buf, c);
1254 INF_UNGET (c);
1255 fputs (buf.base, outf);
1256 fn = lookup_std_proto (buf.base, strlen (buf.base));
1257 /* We only want to edit the declaration matching the one
1258 seen by scan-decls, as there can be multiple
1259 declarations, selected by #ifdef __STDC__ or whatever. */
1260 if (fn && fn->partial && fn->partial->line_seen == lineno)
1262 c = inf_skip_spaces (' ');
1263 if (c == EOF)
1264 break;
1265 if (c == '(')
1267 c = inf_skip_spaces (' ');
1268 if (c == ')')
1270 fprintf (outf, " _PARAMS((%s))", fn->params);
1272 else
1274 putc ('(', outf);
1275 INF_UNGET (c);
1278 else
1279 fprintf (outf, " %c", c);
1282 else
1284 putc (c, outf);
1285 if (c == '\n')
1286 break;
1289 if (c == EOF)
1290 break;
1291 lineno++;
1293 if (rbrac_line < 0)
1294 write_rbrac ();
1296 fclose (outf);
1298 return 0;
1301 /* Stub error functions. These replace cpperror.c,
1302 because we want to suppress error messages. */
1304 void
1305 cpp_file_line_for_message (pfile, filename, line, column)
1306 cpp_reader *pfile;
1307 char *filename;
1308 int line, column;
1310 if (!verbose)
1311 return;
1312 if (column > 0)
1313 fprintf (stderr, "%s:%d:%d: ", filename, line, column);
1314 else
1315 fprintf (stderr, "%s:%d: ", filename, line);
1318 void
1319 cpp_print_containing_files (pfile)
1320 cpp_reader *pfile;
1324 /* IS_ERROR is 2 for fatal error, 1 for error, 0 for warning */
1326 void cpp_message (pfile, is_error, msg, arg1, arg2, arg3)
1327 int is_error;
1328 cpp_reader *pfile;
1329 char *msg;
1330 char *arg1, *arg2, *arg3;
1332 if (is_error == 1)
1333 pfile->errors++;
1334 else if (is_error > 1)
1335 pfile->errors = CPP_FATAL_LIMIT;
1336 if (!verbose)
1337 return;
1338 if (!is_error)
1339 fprintf (stderr, "warning: ");
1340 fprintf (stderr, msg, arg1, arg2, arg3);
1341 fprintf (stderr, "\n");
1344 void
1345 fatal (str, arg)
1346 char *str, *arg;
1348 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1349 fprintf (stderr, str, arg);
1350 fprintf (stderr, "\n");
1351 exit (FATAL_EXIT_CODE);
1354 void
1355 cpp_fatal (pfile, str, arg)
1356 cpp_reader *pfile;
1357 char *str, *arg;
1359 fatal (str, arg);
1362 void
1363 cpp_pfatal_with_name (pfile, name)
1364 cpp_reader *pfile;
1365 char *name;
1367 cpp_perror_with_name (pfile, name);
1368 exit (FATAL_EXIT_CODE);