(*zeroextract[qs]i_compare0_scratch): Use const_int_operand
[official-gcc.git] / gcc / fix-header.c
blob2a51f53e13867a62658d0ca61e2015e1d20e54ac
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995 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 more conforming with ANSI/POSIX, and more suitable for 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 <stdio.h>
74 #include <ctype.h>
75 #include "hconfig.h"
76 #include "obstack.h"
77 #include "scan.h"
78 #include "cpplib.h"
79 #ifndef O_RDONLY
80 #define O_RDONLY 0
81 #endif
83 #if !__STDC__
84 #define const /* nothing */
85 #endif
87 sstring buf;
89 int verbose = 0;
90 int partial_count = 0;
91 int warnings = 0;
93 /* We no longer need to add extern "C", because cpp implicitly
94 forces the standard include files to be treated as C. */
95 /*#define ADD_MISSING_EXTERN_C 1 */
97 #if ADD_MISSING_EXTERN_C
98 int missing_extern_C_count = 0;
99 #endif
101 #include "xsys-protos.h"
103 #ifdef FIXPROTO_IGNORE_LIST
104 /* This is a currently unused feature. */
106 /* List of files and directories to ignore.
107 A directory name (ending in '/') means ignore anything in that
108 directory. (It might be more efficient to do directory pruning
109 earlier in fixproto, but this is simpler and easier to customize.) */
111 static char *files_to_ignore[] = {
112 "X11/",
113 FIXPROTO_IGNORE_LIST
116 #endif
118 char *inf_buffer;
119 char *inf_limit;
120 char *inf_ptr;
122 /* Certain standard files get extra treatment */
124 enum special_file
126 no_special,
127 errno_h,
128 stdio_h,
129 stdlib_h,
130 sys_stat_h
133 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
134 by an empty name (i.e. by "\0\0"). */
136 typedef const char* namelist;
138 /* The following macros provide the bits for symbol_flags. */
139 typedef int symbol_flags;
141 /* Used to mark names defined in the ANSI/ISO C standard. */
142 #define ANSI_SYMBOL 1
144 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
145 #define POSIX1_SYMBOL 2
146 #define POSIX2_SYMBOL 4
148 /* Used to mark names defined in X/Open Portability Guide. */
149 #define XOPEN_SYMBOL 8
150 /* Used to mark names defined in X/Open UNIX Extensions. */
151 #define XOPEN_EXTENDED_SYMBOL 16
153 /* Used to indicate names that are not functions */
154 #define MACRO_SYMBOL 512
156 struct symbol_list {
157 symbol_flags flags;
158 namelist names;
161 #define SYMBOL_TABLE_SIZE 10
162 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
163 int cur_symbol_table_size;
165 void
166 add_symbols (flags, names)
167 symbol_flags flags;
168 namelist names;
170 symbol_table[cur_symbol_table_size].flags = flags;
171 symbol_table[cur_symbol_table_size].names = names;
172 cur_symbol_table_size++;
173 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
174 fatal ("too many calls to add_symbols");
175 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
178 struct std_include_entry {
179 const char *name;
180 symbol_flags flags;
181 namelist names;
184 const char NONE[] = ""; /* The empty namelist. */
186 /* Special name to indicate a continuation line in std_include_table. */
187 const char CONTINUED[] = "";
189 struct std_include_entry *include_entry;
191 struct std_include_entry std_include_table [] = {
192 { "ctype.h", ANSI_SYMBOL,
193 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
194 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
196 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
198 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
200 /* ANSI_SYMBOL is wrong, but ... */
201 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
202 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
203 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
204 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
205 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
207 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
209 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
210 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
212 /*{ "limit.h", ... provided by gcc }, */
214 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
216 { "math.h", ANSI_SYMBOL,
217 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
218 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
219 tan\0tanh\0" },
221 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
223 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
225 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
226 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
228 /* Left out signal() - its prototype is too complex for us!
229 Also left out "sigaction sigaddset sigdelset sigemptyset
230 sigfillset sigismember sigpending sigprocmask sigsuspend"
231 because these need sigset_t or struct sigaction.
232 Most systems that provide them will also declare them. */
233 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
235 { "stdio.h", ANSI_SYMBOL,
236 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
237 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
238 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\00perror\0popen\0\
239 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
240 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
241 tmpnam\0ungetc\0" },
242 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
243 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
244 /* Should perhaps also handle NULL, EOF, ... ? */
246 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
247 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
248 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
249 Should perhaps also add NULL */
250 { "stdlib.h", ANSI_SYMBOL,
251 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
252 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
253 srand\0strtod\0strtol\0strtoul\0system\0" },
254 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
256 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
257 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
258 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
259 strtok\0strxfrm\0" },
260 /* Should perhaps also add NULL and size_t */
262 { "strings.h", XOPEN_EXTENDED_SYMBOL,
263 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
265 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
267 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
268 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
269 and many systems do have <sys/ioctl.h> but not <strops.h>. */
270 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
272 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
274 { "sys/stat.h", POSIX1_SYMBOL,
275 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
276 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
277 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
278 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
279 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
281 #if 0
282 /* How do we handle fd_set? */
283 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
284 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
285 #endif
287 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
288 /* "sys/types.h" add types (not in old g++-include) */
290 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
292 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
293 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
294 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
295 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
297 { "tar.h", POSIX1_SYMBOL, NONE },
299 { "termios.h", POSIX1_SYMBOL,
300 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
302 { "time.h", ANSI_SYMBOL,
303 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
305 { "unistd.h", POSIX1_SYMBOL,
306 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
307 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
308 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
309 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
310 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
311 ttyname\0unlink\0write\0" },
312 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
313 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
314 "lockf\0gethostid\0gethostname\0readlink\0" },
316 { "utime.h", POSIX1_SYMBOL, "utime\0" },
318 { NULL, 0, NONE }
321 enum special_file special_file_handling = no_special;
323 /* They are set if the corresponding macro has been seen. */
324 /* The following are only used when handling sys/stat.h */
325 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
326 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
327 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
328 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
329 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
330 int seen_S_IFREG = 0, seen_S_ISREG = 0;
331 /* The following are only used when handling errno.h */
332 int seen_errno = 0;
333 /* The following are only used when handling stdlib.h */
334 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
336 /* Wrapper around free, to avoid prototype clashes. */
338 void
339 xfree (ptr)
340 char *ptr;
342 free (ptr);
345 /* Avoid error if config defines abort as fancy_abort.
346 It's not worth "really" implementing this because ordinary
347 compiler users never run fix-header. */
349 void
350 fancy_abort ()
352 abort ();
355 #define obstack_chunk_alloc xmalloc
356 #define obstack_chunk_free xfree
357 struct obstack scan_file_obstack;
359 /* NOTE: If you edit this, also edit gen-protos.c !! */
360 struct fn_decl *
361 lookup_std_proto (name, name_length)
362 const char *name;
363 int name_length;
365 int i = hashf (name, name_length, HASH_SIZE);
366 int i0 = i;
367 for (;;)
369 struct fn_decl *fn;
370 if (hash_tab[i] == 0)
371 return NULL;
372 fn = &std_protos[hash_tab[i]];
373 if (strlen (fn->fname) == name_length
374 && strncmp (fn->fname, name, name_length) == 0)
375 return fn;
376 i = (i+1) % HASH_SIZE;
377 if (i == i0)
378 abort ();
382 char *inc_filename;
383 int inc_filename_length;
384 char *progname = "fix-header";
385 FILE *outf;
386 sstring line;
388 int lbrac_line, rbrac_line;
390 int required_unseen_count = 0;
391 int required_other = 0;
393 void
394 write_lbrac ()
397 #if ADD_MISSING_EXTERN_C
398 if (missing_extern_C_count + required_unseen_count > 0)
399 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
400 #endif
402 if (partial_count)
404 fprintf (outf, "#ifndef _PARAMS\n");
405 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
406 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
407 fprintf (outf, "#else\n");
408 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
409 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
413 struct partial_proto
415 struct partial_proto *next;
416 char *fname; /* name of function */
417 char *rtype; /* return type */
418 struct fn_decl *fn;
419 int line_seen;
422 struct partial_proto *partial_proto_list = NULL;
424 struct partial_proto required_dummy_proto, seen_dummy_proto;
425 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
426 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
427 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
428 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
430 void
431 recognized_macro (fname)
432 char *fname;
434 /* The original include file defines fname as a macro. */
435 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
437 /* Since fname is a macro, don't require a prototype for it. */
438 if (fn)
440 if (REQUIRED (fn))
441 required_unseen_count--;
442 SET_SEEN (fn);
445 switch (special_file_handling)
447 case errno_h:
448 if (strcmp (fname, "errno") == 0 && !seen_errno)
449 seen_errno = 1, required_other--;
450 break;
451 case stdlib_h:
452 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
453 seen_EXIT_FAILURE = 1, required_other--;
454 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
455 seen_EXIT_SUCCESS = 1, required_other--;
456 break;
457 case sys_stat_h:
458 if (fname[0] == 'S' && fname[1] == '_')
460 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
461 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
462 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
463 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
464 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
465 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
466 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
467 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
468 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
469 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
470 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
471 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
476 void
477 recognized_extern (name, name_length, type, type_length)
478 char *name;
479 char *type;
480 int name_length, type_length;
482 switch (special_file_handling)
484 case errno_h:
485 if (strcmp (name, "errno") == 0 && !seen_errno)
486 seen_errno = 1, required_other--;
487 break;
491 /* Called by scan_decls if it saw a function definition for a function
492 named FNAME, with return type RTYPE, and argument list ARGS,
493 in source file FILE_SEEN on line LINE_SEEN.
494 KIND is 'I' for an inline function;
495 'F' if a normal function declaration preceded by 'extern "C"'
496 (or nested inside 'extern "C"' braces); or
497 'f' for other function declarations. */
499 void
500 recognized_function (fname, fname_length,
501 kind, rtype, rtype_length,
502 have_arg_list, file_seen, line_seen)
503 char *fname;
504 int fname_length;
505 int kind; /* One of 'f' 'F' or 'I' */
506 char *rtype;
507 int rtype_length;
508 int have_arg_list;
509 char *file_seen;
510 int line_seen;
512 struct partial_proto *partial;
513 int i;
514 struct fn_decl *fn;
515 #if ADD_MISSING_EXTERN_C
516 if (kind == 'f')
517 missing_extern_C_count++;
518 #endif
520 fn = lookup_std_proto (fname, fname_length);
522 /* Remove the function from the list of required function. */
523 if (fn)
525 if (REQUIRED (fn))
526 required_unseen_count--;
527 SET_SEEN (fn);
530 /* If we have a full prototype, we're done. */
531 if (have_arg_list)
532 return;
534 if (kind == 'I') /* don't edit inline function */
535 return;
537 /* If the partial prototype was included from some other file,
538 we don't need to patch it up (in this run). */
539 i = strlen (file_seen);
540 if (i < inc_filename_length
541 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
542 return;
544 if (fn == NULL)
545 return;
546 if (fn->params[0] == '\0' || strcmp (fn->params, "void") == 0)
547 return;
549 /* We only have a partial function declaration,
550 so remember that we have to add a complete prototype. */
551 partial_count++;
552 partial = (struct partial_proto*)
553 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
554 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
555 bcopy (fname, partial->fname, fname_length);
556 partial->fname[fname_length] = 0;
557 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
558 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
559 partial->line_seen = line_seen;
560 partial->fn = fn;
561 fn->partial = partial;
562 partial->next = partial_proto_list;
563 partial_proto_list = partial;
564 if (verbose)
566 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
567 inc_filename, partial->fname);
571 /* For any name in NAMES that is defined as a macro,
572 call recognized_macro on it. */
574 void
575 check_macro_names (pfile, names)
576 struct parse_file *pfile;
577 namelist names;
579 while (*names)
581 if (cpp_lookup (pfile, names, -1, -1))
582 recognized_macro (names);
583 names += strlen (names) + 1;
587 void
588 read_scan_file (in_fname, argc, argv)
589 char *in_fname;
590 int argc;
591 char **argv;
593 cpp_reader scan_in;
594 cpp_options scan_options;
595 struct fn_decl *fn;
596 int i;
597 register struct symbol_list *cur_symbols;
599 obstack_init (&scan_file_obstack);
601 init_parse_file (&scan_in);
602 scan_in.data = &scan_options;
603 init_parse_options (&scan_options);
604 i = cpp_handle_options (&scan_in, argc, argv);
605 if (i < argc)
606 fatal ("Invalid option `%s'", argv[i]);
607 push_parse_file (&scan_in, in_fname);
608 CPP_OPTIONS (&scan_in)->no_line_commands = 1;
610 scan_decls (&scan_in, argc, argv);
611 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
612 check_macro_names (&scan_in, cur_symbols->names);
614 if (verbose && (scan_in.errors + warnings) > 0)
615 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
616 inc_filename, scan_in.errors, warnings);
617 if (scan_in.errors)
618 exit (0);
620 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
621 If so, those functions are also required. */
622 if (special_file_handling == stdio_h
623 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
625 static char getchar_call[] = "getchar();";
626 cpp_buffer *buf =
627 cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
628 int old_written = CPP_WRITTEN (&scan_in);
629 int seen_filbuf = 0;
631 /* Scan the macro expansion of "getchar();". */
632 for (;;)
634 enum cpp_token token = cpp_get_token (&scan_in);
635 int length = CPP_WRITTEN (&scan_in) - old_written;
636 CPP_SET_WRITTEN (&scan_in, old_written);
637 if (token == CPP_EOF) /* Should not happen ... */
638 break;
639 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
641 cpp_pop_buffer (&scan_in);
642 break;
644 if (token == CPP_NAME && length == 7
645 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
646 seen_filbuf++;
648 if (seen_filbuf)
650 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
651 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
652 int need_flsbuf
653 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
655 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
656 if (need_filbuf + need_flsbuf)
658 char *new_list;
659 if (need_filbuf)
660 SET_REQUIRED (fn);
661 if (need_flsbuf)
662 SET_REQUIRED (flsbuf_fn);
663 if (need_flsbuf + need_filbuf == 2)
664 new_list = "_filbuf\0_flsbuf\0";
665 else if (need_flsbuf)
666 new_list = "_flsbuf\0";
667 else /* if (need_flsbuf) */
668 new_list = "_filbuf\0";
669 add_symbols (ANSI_SYMBOL, new_list);
670 required_unseen_count += need_filbuf + need_flsbuf;
675 if (required_unseen_count + partial_count + required_other
676 #if ADD_MISSING_EXTERN_C
677 + missing_extern_C_count
678 #endif
679 == 0)
681 if (verbose)
682 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
683 exit (0);
685 if (!verbose)
686 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
687 else
689 if (required_unseen_count)
690 fprintf (stderr, "%s: %d missing function declarations.\n",
691 inc_filename, required_unseen_count);
692 if (partial_count)
693 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
694 inc_filename, partial_count);
695 #if ADD_MISSING_EXTERN_C
696 if (missing_extern_C_count)
697 fprintf (stderr,
698 "%s: %d declarations not protected by extern \"C\".\n",
699 inc_filename, missing_extern_C_count);
700 #endif
704 void
705 write_rbrac ()
707 struct fn_decl *fn;
708 const char *cptr;
709 register struct symbol_list *cur_symbols;
711 if (required_unseen_count)
713 #ifdef NO_IMPLICIT_EXTERN_C
714 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
715 #endif
718 /* Now we print out prototypes for those functions that we haven't seen. */
719 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
721 int if_was_emitted = 0;
722 int name_len;
723 cptr = cur_symbols->names;
724 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
726 int macro_protect = 0;
728 if (cur_symbols->flags & MACRO_SYMBOL)
729 continue;
731 fn = lookup_std_proto (cptr, name_len);
732 if (fn == NULL || !REQUIRED (fn))
733 continue;
735 if (!if_was_emitted)
737 /* what about curses. ??? or _flsbuf/_filbuf ??? */
738 if (cur_symbols->flags & ANSI_SYMBOL)
739 fprintf (outf,
740 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
741 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
742 fprintf (outf,
743 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
744 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
745 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
746 else if (cur_symbols->flags & XOPEN_SYMBOL)
748 fprintf (outf,
749 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
750 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
752 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
754 fprintf (outf,
755 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
756 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
758 else
760 fatal ("internal error for function %s", fn->fname);
762 if_was_emitted = 1;
765 /* In the case of memmove, protect in case the application
766 defines it as a macro before including the header. */
767 if (!strcmp (fn->fname, "memmove")
768 || !strcmp (fn->fname, "vprintf")
769 || !strcmp (fn->fname, "vfprintf")
770 || !strcmp (fn->fname, "vsprintf")
771 || !strcmp (fn->fname, "rewinddir"))
772 macro_protect = 1;
774 if (macro_protect)
775 fprintf (outf, "#ifndef %s\n", fn->fname);
776 fprintf (outf, "extern %s %s (%s);\n",
777 fn->rtype, fn->fname, fn->params);
778 if (macro_protect)
779 fprintf (outf, "#endif\n");
781 if (if_was_emitted)
782 fprintf (outf,
783 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
785 if (required_unseen_count)
787 #ifdef NO_IMPLICIT_EXTERN_C
788 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
789 #endif
792 switch (special_file_handling)
794 case errno_h:
795 if (!seen_errno)
796 fprintf (outf, "extern int errno;\n");
797 break;
798 case stdlib_h:
799 if (!seen_EXIT_FAILURE)
800 fprintf (outf, "#define EXIT_FAILURE 1\n");
801 if (!seen_EXIT_SUCCESS)
802 fprintf (outf, "#define EXIT_SUCCESS 0\n");
803 break;
804 case sys_stat_h:
805 if (!seen_S_ISBLK && seen_S_IFBLK)
806 fprintf (outf,
807 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
808 if (!seen_S_ISCHR && seen_S_IFCHR)
809 fprintf (outf,
810 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
811 if (!seen_S_ISDIR && seen_S_IFDIR)
812 fprintf (outf,
813 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
814 if (!seen_S_ISFIFO && seen_S_IFIFO)
815 fprintf (outf,
816 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
817 if (!seen_S_ISLNK && seen_S_IFLNK)
818 fprintf (outf,
819 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
820 if (!seen_S_ISREG && seen_S_IFREG)
821 fprintf (outf,
822 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
823 break;
827 #if ADD_MISSING_EXTERN_C
828 if (missing_extern_C_count + required_unseen_count > 0)
829 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
830 #endif
833 char *
834 xstrdup (str)
835 char *str;
837 char *copy = (char *) xmalloc (strlen (str) + 1);
838 strcpy (copy, str);
839 return copy;
842 /* Returns 1 iff the file is properly protected from multiple inclusion:
843 #ifndef PROTECT_NAME
844 #define PROTECT_NAME
845 #endif
849 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char*)inf_ptr++ : EOF)
850 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
853 inf_skip_spaces (c)
854 int c;
856 for (;;)
858 if (c == ' ' || c == '\t')
859 c = INF_GET ();
860 else if (c == '/')
862 c = INF_GET ();
863 if (c != '*')
865 INF_UNGET (c);
866 return '/';
868 c = INF_GET ();
869 for (;;)
871 if (c == EOF)
872 return EOF;
873 else if (c != '*')
875 if (c == '\n')
876 source_lineno++, lineno++;
877 c = INF_GET ();
879 else if ((c = INF_GET ()) == '/')
880 return INF_GET ();
883 else
884 break;
886 return c;
889 /* Read into STR from inf_buffer upto DELIM. */
892 inf_read_upto (str, delim)
893 sstring *str;
894 int delim;
896 int ch;
897 for (;;)
899 ch = INF_GET ();
900 if (ch == EOF || ch == delim)
901 break;
902 SSTRING_PUT (str, ch);
904 MAKE_SSTRING_SPACE (str, 1);
905 *str->ptr = 0;
906 return ch;
910 inf_scan_ident (s, c)
911 register sstring *s;
912 int c;
914 s->ptr = s->base;
915 if (isalpha (c) || c == '_')
917 for (;;)
919 SSTRING_PUT (s, c);
920 c = INF_GET ();
921 if (c == EOF || !(isalnum (c) || c == '_'))
922 break;
925 MAKE_SSTRING_SPACE (s, 1);
926 *s->ptr = 0;
927 return c;
930 /* Returns 1 if the file is correctly protected against multiple
931 inclusion, setting *ifndef_line to the line number of the initial #ifndef
932 and setting *endif_line to the final #endif.
933 Otherwise return 0. */
936 check_protection (ifndef_line, endif_line)
937 int *ifndef_line, *endif_line;
939 int c;
940 int if_nesting = 1; /* Level of nesting of #if's */
941 char *protect_name = NULL; /* Identifier following initial #ifndef */
942 int define_seen = 0;
944 /* Skip initial white space (including comments). */
945 for (;; lineno++)
947 c = inf_skip_spaces (' ');
948 if (c == EOF)
949 return 0;
950 if (c != '\n')
951 break;
953 if (c != '#')
954 return 0;
955 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
956 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
957 return 0;
959 /* So far so good: We've seen an initial #ifndef. */
960 *ifndef_line = lineno;
961 c = inf_scan_ident (&buf, inf_skip_spaces (c));
962 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
963 return 0;
964 protect_name = xstrdup (buf.base);
966 INF_UNGET (c);
967 c = inf_read_upto (&buf, '\n');
968 if (c == EOF)
969 return 0;
970 lineno++;
972 for (;;)
974 c = inf_skip_spaces (' ');
975 if (c == EOF)
976 return 0;
977 if (c == '\n')
979 lineno++;
980 continue;
982 if (c != '#')
983 goto skip_to_eol;
984 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
985 if (SSTRING_LENGTH (&buf) == 0)
987 else if (!strcmp (buf.base, "ifndef")
988 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
990 if_nesting++;
992 else if (!strcmp (buf.base, "endif"))
994 if_nesting--;
995 if (if_nesting == 0)
996 break;
998 else if (!strcmp (buf.base, "else"))
1000 if (if_nesting == 1)
1001 return 0;
1003 else if (!strcmp (buf.base, "define"))
1005 if (if_nesting != 1)
1006 goto skip_to_eol;
1007 c = inf_skip_spaces (c);
1008 c = inf_scan_ident (&buf, c);
1009 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1010 define_seen = 1;
1012 skip_to_eol:
1013 for (;;)
1015 if (c == '\n' || c == EOF)
1016 break;
1017 c = INF_GET ();
1019 if (c == EOF)
1020 return 0;
1021 lineno++;
1024 if (!define_seen)
1025 return 0;
1026 *endif_line = lineno;
1027 /* Skip final white space (including comments). */
1028 for (;;)
1030 c = inf_skip_spaces (' ');
1031 if (c == EOF)
1032 break;
1033 if (c != '\n')
1034 return 0;
1037 return 1;
1041 main (argc, argv)
1042 int argc;
1043 char **argv;
1045 int inf_fd;
1046 struct stat sbuf;
1047 int c;
1048 int i, done;
1049 const char *cptr, **pptr;
1050 int ifndef_line;
1051 int endif_line;
1052 long to_read;
1053 long int inf_size;
1054 register struct symbol_list *cur_symbols;
1056 if (argv[0] && argv[0][0])
1058 register char *p;
1060 progname = 0;
1061 for (p = argv[0]; *p; p++)
1062 if (*p == '/')
1063 progname = p;
1064 progname = progname ? progname+1 : argv[0];
1067 if (argc < 4)
1069 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1070 progname);
1071 exit (-1);
1074 inc_filename = argv[1];
1075 inc_filename_length = strlen (inc_filename);
1077 #ifdef FIXPROTO_IGNORE_LIST
1078 for (i = 0; files_to_ignore[i] != NULL; i++)
1080 char *ignore_name = files_to_ignore[i];
1081 int ignore_len = strlen (ignore_name);
1082 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1084 if (ignore_name[ignore_len-1] == '/'
1085 || inc_filename[ignore_len] == '\0')
1087 if (verbose)
1088 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1089 exit (0);
1094 #endif
1096 if (strcmp (inc_filename, "sys/stat.h") == 0)
1097 special_file_handling = sys_stat_h;
1098 else if (strcmp (inc_filename, "errno.h") == 0)
1099 special_file_handling = errno_h, required_other++;
1100 else if (strcmp (inc_filename, "stdlib.h") == 0)
1101 special_file_handling = stdlib_h, required_other+=2;
1102 else if (strcmp (inc_filename, "stdio.h") == 0)
1103 special_file_handling = stdio_h;
1104 include_entry = std_include_table;
1105 while (include_entry->name != NULL
1106 && (include_entry->name == CONTINUED
1107 || strcmp (inc_filename, include_entry->name) != 0))
1108 include_entry++;
1110 if (include_entry->name != NULL)
1112 struct std_include_entry *entry;
1113 cur_symbol_table_size = 0;
1114 for (entry = include_entry; ;)
1116 add_symbols (entry->flags, entry->names);
1117 entry++;
1118 if (entry->name != CONTINUED)
1119 break;
1122 else
1123 symbol_table[0].names = NULL;
1125 /* Count and mark the prototypes required for this include file. */
1126 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1128 int name_len;
1129 if (cur_symbols->flags & MACRO_SYMBOL)
1130 continue;
1131 cptr = cur_symbols->names;
1132 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1134 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1135 required_unseen_count++;
1136 if (fn == NULL)
1137 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1138 else
1139 SET_REQUIRED (fn);
1143 read_scan_file (argv[2], argc - 4, argv + 4);
1145 inf_fd = open (argv[2], O_RDONLY, 0666);
1146 if (inf_fd < 0)
1148 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1149 progname, argv[2]);
1150 perror (NULL);
1151 exit (-1);
1153 if (fstat (inf_fd, &sbuf) < 0)
1155 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1156 perror (NULL);
1157 exit (-1);
1159 inf_size = sbuf.st_size;
1160 inf_buffer = (char*) xmalloc (inf_size + 2);
1161 inf_buffer[inf_size] = '\n';
1162 inf_buffer[inf_size + 1] = '\0';
1163 inf_limit = inf_buffer + inf_size;
1164 inf_ptr = inf_buffer;
1166 to_read = inf_size;
1167 while (to_read > 0)
1169 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1170 if (i < 0)
1172 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1173 perror (NULL);
1174 exit (-1);
1176 if (i == 0)
1178 inf_size -= to_read;
1179 break;
1181 to_read -= i;
1184 close (inf_fd);
1186 /* If file doesn't end with '\n', add one. */
1187 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1188 inf_limit++;
1190 unlink (argv[3]);
1191 outf = fopen (argv[3], "w");
1192 if (outf == NULL)
1194 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1195 progname, argv[3]);
1196 perror (NULL);
1197 exit (-1);
1200 lineno = 1;
1202 if (check_protection (&ifndef_line, &endif_line))
1204 lbrac_line = ifndef_line+1;
1205 rbrac_line = endif_line;
1207 else
1209 lbrac_line = 1;
1210 rbrac_line = -1;
1213 /* Reset input file. */
1214 inf_ptr = inf_buffer;
1215 lineno = 1;
1217 for (;;)
1219 if (lineno == lbrac_line)
1220 write_lbrac ();
1221 if (lineno == rbrac_line)
1222 write_rbrac ();
1223 for (;;)
1225 struct fn_decl *fn;
1226 c = INF_GET ();
1227 if (c == EOF)
1228 break;
1229 if (isalpha (c) || c == '_')
1231 c = inf_scan_ident (&buf, c);
1232 INF_UNGET (c);
1233 fputs (buf.base, outf);
1234 fn = lookup_std_proto (buf.base, strlen (buf.base));
1235 /* We only want to edit the declaration matching the one
1236 seen by scan-decls, as there can be multiple
1237 declarations, selected by #ifdef __STDC__ or whatever. */
1238 if (fn && fn->partial && fn->partial->line_seen == lineno)
1240 c = inf_skip_spaces (' ');
1241 if (c == EOF)
1242 break;
1243 if (c == '(')
1245 c = inf_skip_spaces (' ');
1246 if (c == ')')
1248 fprintf (outf, " _PARAMS((%s))", fn->params);
1250 else
1252 putc ('(', outf);
1253 INF_UNGET (c);
1256 else
1257 fprintf (outf, " %c", c);
1260 else
1262 putc (c, outf);
1263 if (c == '\n')
1264 break;
1267 if (c == EOF)
1268 break;
1269 lineno++;
1271 if (rbrac_line < 0)
1272 write_rbrac ();
1274 fclose (outf);
1276 return 0;
1279 /* Stub error functions. These replace cpperror.c,
1280 because we want to suppress error messages. */
1282 void
1283 cpp_file_line_for_message (pfile, filename, line, column)
1284 cpp_reader *pfile;
1285 char *filename;
1286 int line, column;
1288 if (!verbose)
1289 return;
1290 if (column > 0)
1291 fprintf (stderr, "%s:%d:%d: ", filename, line, column);
1292 else
1293 fprintf (stderr, "%s:%d: ", filename, line);
1296 void
1297 cpp_print_containing_files (pfile)
1298 cpp_reader *pfile;
1302 /* IS_ERROR is 1 for error, 0 for warning */
1303 void cpp_message (pfile, is_error, msg, arg1, arg2, arg3)
1304 int is_error;
1305 cpp_reader *pfile;
1306 char *msg;
1307 char *arg1, *arg2, *arg3;
1309 if (is_error)
1310 pfile->errors++;
1311 if (!verbose)
1312 return;
1313 if (!is_error)
1314 fprintf (stderr, "warning: ");
1315 fprintf (stderr, msg, arg1, arg2, arg3);
1316 fprintf (stderr, "\n");
1319 void
1320 fatal (str, arg)
1321 char *str, *arg;
1323 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1324 fprintf (stderr, str, arg);
1325 fprintf (stderr, "\n");
1326 exit (FATAL_EXIT_CODE);
1329 void
1330 cpp_pfatal_with_name (pfile, name)
1331 cpp_reader *pfile;
1332 char *name;
1334 cpp_perror_with_name (pfile, name);
1335 exit (FATAL_EXIT_CODE);