Add powerpc embedded targets to --with-cpu=n.
[official-gcc.git] / gcc / fix-header.c
blob24006513f641ca0f00076042f1a9ca82732791ae
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997 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 #include "gansidecl.h"
81 #ifndef O_RDONLY
82 #define O_RDONLY 0
83 #endif
85 extern void cpp_fatal ();
87 #if !__STDC__ && !defined(const)
88 #define const /* nothing */
89 #endif
91 sstring buf;
93 int verbose = 0;
94 int partial_count = 0;
95 int warnings = 0;
97 /* We no longer need to add extern "C", because cpp implicitly
98 forces the standard include files to be treated as C. */
99 /*#define ADD_MISSING_EXTERN_C 1 */
101 #if ADD_MISSING_EXTERN_C
102 int missing_extern_C_count = 0;
103 #endif
105 #include "xsys-protos.h"
107 #ifdef FIXPROTO_IGNORE_LIST
108 /* This is a currently unused feature. */
110 /* List of files and directories to ignore.
111 A directory name (ending in '/') means ignore anything in that
112 directory. (It might be more efficient to do directory pruning
113 earlier in fixproto, but this is simpler and easier to customize.) */
115 static char *files_to_ignore[] = {
116 "X11/",
117 FIXPROTO_IGNORE_LIST
120 #endif
122 char *inf_buffer;
123 char *inf_limit;
124 char *inf_ptr;
126 /* Certain standard files get extra treatment */
128 enum special_file
130 no_special,
131 errno_h,
132 stdio_h,
133 stdlib_h,
134 sys_stat_h
137 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
138 by an empty name (i.e. by "\0\0"). */
140 typedef const char *namelist;
142 /* The following macros provide the bits for symbol_flags. */
143 typedef int symbol_flags;
145 /* Used to mark names defined in the ANSI/ISO C standard. */
146 #define ANSI_SYMBOL 1
148 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
149 #define POSIX1_SYMBOL 2
150 #define POSIX2_SYMBOL 4
152 /* Used to mark names defined in X/Open Portability Guide. */
153 #define XOPEN_SYMBOL 8
154 /* Used to mark names defined in X/Open UNIX Extensions. */
155 #define XOPEN_EXTENDED_SYMBOL 16
157 /* Used to indicate names that are not functions */
158 #define MACRO_SYMBOL 512
160 struct symbol_list {
161 symbol_flags flags;
162 namelist names;
165 #define SYMBOL_TABLE_SIZE 10
166 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
167 int cur_symbol_table_size;
169 void
170 add_symbols (flags, names)
171 symbol_flags flags;
172 namelist names;
174 symbol_table[cur_symbol_table_size].flags = flags;
175 symbol_table[cur_symbol_table_size].names = names;
176 cur_symbol_table_size++;
177 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
178 fatal ("too many calls to add_symbols");
179 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
182 struct std_include_entry {
183 const char *name;
184 symbol_flags flags;
185 namelist names;
188 const char NONE[] = ""; /* The empty namelist. */
190 /* Special name to indicate a continuation line in std_include_table. */
191 const char CONTINUED[] = "";
193 struct std_include_entry *include_entry;
195 struct std_include_entry std_include_table [] = {
196 { "ctype.h", ANSI_SYMBOL,
197 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
198 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
200 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
202 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
204 /* ANSI_SYMBOL is wrong, but ... */
205 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
206 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
207 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
208 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
209 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
211 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
213 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
214 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
216 /*{ "limit.h", ... provided by gcc }, */
218 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
220 { "math.h", ANSI_SYMBOL,
221 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
222 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
223 tan\0tanh\0" },
225 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
227 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
229 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
230 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
232 /* Left out signal() - its prototype is too complex for us!
233 Also left out "sigaction sigaddset sigdelset sigemptyset
234 sigfillset sigismember sigpending sigprocmask sigsuspend"
235 because these need sigset_t or struct sigaction.
236 Most systems that provide them will also declare them. */
237 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
239 { "stdio.h", ANSI_SYMBOL,
240 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
241 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
242 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\00perror\0popen\0\
243 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
244 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
245 tmpnam\0ungetc\0" },
246 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
247 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
248 /* Should perhaps also handle NULL, EOF, ... ? */
250 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
251 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
252 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
253 Should perhaps also add NULL */
254 { "stdlib.h", ANSI_SYMBOL,
255 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
256 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
257 srand\0strtod\0strtol\0strtoul\0system\0" },
258 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
260 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
261 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
262 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
263 strtok\0strxfrm\0" },
264 /* Should perhaps also add NULL and size_t */
266 { "strings.h", XOPEN_EXTENDED_SYMBOL,
267 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
269 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
271 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
272 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
273 and many systems do have <sys/ioctl.h> but not <strops.h>. */
274 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
276 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
278 { "sys/stat.h", POSIX1_SYMBOL,
279 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
280 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
281 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
282 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
283 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
285 #if 0
286 /* How do we handle fd_set? */
287 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
288 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
289 #endif
291 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
292 /* "sys/types.h" add types (not in old g++-include) */
294 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
296 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
297 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
298 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
299 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
301 { "tar.h", POSIX1_SYMBOL, NONE },
303 { "termios.h", POSIX1_SYMBOL,
304 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
306 { "time.h", ANSI_SYMBOL,
307 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
309 { "unistd.h", POSIX1_SYMBOL,
310 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
311 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
312 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
313 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
314 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
315 ttyname\0unlink\0write\0" },
316 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
317 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
318 "lockf\0gethostid\0gethostname\0readlink\0" },
320 { "utime.h", POSIX1_SYMBOL, "utime\0" },
322 { NULL, 0, NONE }
325 enum special_file special_file_handling = no_special;
327 /* They are set if the corresponding macro has been seen. */
328 /* The following are only used when handling sys/stat.h */
329 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
330 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
331 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
332 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
333 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
334 int seen_S_IFREG = 0, seen_S_ISREG = 0;
335 /* The following are only used when handling errno.h */
336 int seen_errno = 0;
337 /* The following are only used when handling stdlib.h */
338 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
340 /* Wrapper around free, to avoid prototype clashes. */
342 void
343 xfree (ptr)
344 char *ptr;
346 free (ptr);
349 /* Avoid error if config defines abort as fancy_abort.
350 It's not worth "really" implementing this because ordinary
351 compiler users never run fix-header. */
353 void
354 fancy_abort ()
356 abort ();
359 #define obstack_chunk_alloc xmalloc
360 #define obstack_chunk_free xfree
361 struct obstack scan_file_obstack;
363 /* NOTE: If you edit this, also edit gen-protos.c !! */
365 struct fn_decl *
366 lookup_std_proto (name, name_length)
367 const char *name;
368 int name_length;
370 int i = hashf (name, name_length, HASH_SIZE);
371 int i0 = i;
372 for (;;)
374 struct fn_decl *fn;
375 if (hash_tab[i] == 0)
376 return NULL;
377 fn = &std_protos[hash_tab[i]];
378 if (strlen (fn->fname) == name_length
379 && strncmp (fn->fname, name, name_length) == 0)
380 return fn;
381 i = (i+1) % HASH_SIZE;
382 if (i == i0)
383 abort ();
387 char *inc_filename;
388 int inc_filename_length;
389 char *progname = "fix-header";
390 FILE *outf;
391 sstring line;
393 int lbrac_line, rbrac_line;
395 int required_unseen_count = 0;
396 int required_other = 0;
398 void
399 write_lbrac ()
402 #if ADD_MISSING_EXTERN_C
403 if (missing_extern_C_count + required_unseen_count > 0)
404 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
405 #endif
407 if (partial_count)
409 fprintf (outf, "#ifndef _PARAMS\n");
410 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
411 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
412 fprintf (outf, "#else\n");
413 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
414 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
418 struct partial_proto
420 struct partial_proto *next;
421 char *fname; /* name of function */
422 char *rtype; /* return type */
423 struct fn_decl *fn;
424 int line_seen;
427 struct partial_proto *partial_proto_list = NULL;
429 struct partial_proto required_dummy_proto, seen_dummy_proto;
430 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
431 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
432 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
433 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
435 void
436 recognized_macro (fname)
437 char *fname;
439 /* The original include file defines fname as a macro. */
440 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
442 /* Since fname is a macro, don't require a prototype for it. */
443 if (fn)
445 if (REQUIRED (fn))
446 required_unseen_count--;
447 SET_SEEN (fn);
450 switch (special_file_handling)
452 case errno_h:
453 if (strcmp (fname, "errno") == 0 && !seen_errno)
454 seen_errno = 1, required_other--;
455 break;
456 case stdlib_h:
457 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
458 seen_EXIT_FAILURE = 1, required_other--;
459 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
460 seen_EXIT_SUCCESS = 1, required_other--;
461 break;
462 case sys_stat_h:
463 if (fname[0] == 'S' && fname[1] == '_')
465 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
466 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
467 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
468 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
469 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
470 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
471 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
472 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
473 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
474 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
475 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
476 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
481 void
482 recognized_extern (name, name_length, type, type_length)
483 char *name;
484 char *type;
485 int name_length, type_length;
487 switch (special_file_handling)
489 case errno_h:
490 if (strcmp (name, "errno") == 0 && !seen_errno)
491 seen_errno = 1, required_other--;
492 break;
496 /* Called by scan_decls if it saw a function definition for a function
497 named FNAME, with return type RTYPE, and argument list ARGS,
498 in source file FILE_SEEN on line LINE_SEEN.
499 KIND is 'I' for an inline function;
500 'F' if a normal function declaration preceded by 'extern "C"'
501 (or nested inside 'extern "C"' braces); or
502 'f' for other function declarations. */
504 void
505 recognized_function (fname, fname_length,
506 kind, rtype, rtype_length,
507 have_arg_list, file_seen, line_seen)
508 char *fname;
509 int fname_length;
510 int kind; /* One of 'f' 'F' or 'I' */
511 char *rtype;
512 int rtype_length;
513 int have_arg_list;
514 char *file_seen;
515 int line_seen;
517 struct partial_proto *partial;
518 int i;
519 struct fn_decl *fn;
520 #if ADD_MISSING_EXTERN_C
521 if (kind == 'f')
522 missing_extern_C_count++;
523 #endif
525 fn = lookup_std_proto (fname, fname_length);
527 /* Remove the function from the list of required function. */
528 if (fn)
530 if (REQUIRED (fn))
531 required_unseen_count--;
532 SET_SEEN (fn);
535 /* If we have a full prototype, we're done. */
536 if (have_arg_list)
537 return;
539 if (kind == 'I') /* don't edit inline function */
540 return;
542 /* If the partial prototype was included from some other file,
543 we don't need to patch it up (in this run). */
544 i = strlen (file_seen);
545 if (i < inc_filename_length
546 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
547 return;
549 if (fn == NULL)
550 return;
551 if (fn->params[0] == '\0' || strcmp (fn->params, "void") == 0)
552 return;
554 /* We only have a partial function declaration,
555 so remember that we have to add a complete prototype. */
556 partial_count++;
557 partial = (struct partial_proto *)
558 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
559 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
560 bcopy (fname, partial->fname, fname_length);
561 partial->fname[fname_length] = 0;
562 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
563 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
564 partial->line_seen = line_seen;
565 partial->fn = fn;
566 fn->partial = partial;
567 partial->next = partial_proto_list;
568 partial_proto_list = partial;
569 if (verbose)
571 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
572 inc_filename, partial->fname);
576 /* For any name in NAMES that is defined as a macro,
577 call recognized_macro on it. */
579 void
580 check_macro_names (pfile, names)
581 cpp_reader *pfile;
582 namelist names;
584 while (*names)
586 if (cpp_lookup (pfile, names, -1, -1))
587 recognized_macro (names);
588 names += strlen (names) + 1;
592 void
593 read_scan_file (in_fname, argc, argv)
594 char *in_fname;
595 int argc;
596 char **argv;
598 cpp_reader scan_in;
599 cpp_options scan_options;
600 struct fn_decl *fn;
601 int i;
602 register struct symbol_list *cur_symbols;
604 obstack_init (&scan_file_obstack);
606 cpp_reader_init (&scan_in);
607 scan_in.data = &scan_options;
608 cpp_options_init (&scan_options);
609 i = cpp_handle_options (&scan_in, argc, argv);
610 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
611 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
612 if (CPP_FATAL_ERRORS (&scan_in))
613 exit (FATAL_EXIT_CODE);
615 if (! cpp_start_read (&scan_in, in_fname))
616 exit (FATAL_EXIT_CODE);
617 CPP_OPTIONS (&scan_in)->no_line_commands = 1;
619 scan_decls (&scan_in, argc, argv);
620 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
621 check_macro_names (&scan_in, cur_symbols->names);
623 if (verbose && (scan_in.errors + warnings) > 0)
624 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
625 inc_filename, scan_in.errors, warnings);
626 if (scan_in.errors)
627 exit (SUCCESS_EXIT_CODE);
629 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
630 If so, those functions are also required. */
631 if (special_file_handling == stdio_h
632 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
634 static char getchar_call[] = "getchar();";
635 cpp_buffer *buf
636 = cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
637 int old_written = CPP_WRITTEN (&scan_in);
638 int seen_filbuf = 0;
640 /* Scan the macro expansion of "getchar();". */
641 for (;;)
643 enum cpp_token token = cpp_get_token (&scan_in);
644 int length = CPP_WRITTEN (&scan_in) - old_written;
645 CPP_SET_WRITTEN (&scan_in, old_written);
646 if (token == CPP_EOF) /* Should not happen ... */
647 break;
648 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
650 cpp_pop_buffer (&scan_in);
651 break;
653 if (token == CPP_NAME && length == 7
654 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
655 seen_filbuf++;
657 if (seen_filbuf)
659 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
660 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
661 int need_flsbuf
662 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
664 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
665 if (need_filbuf + need_flsbuf)
667 char *new_list;
668 if (need_filbuf)
669 SET_REQUIRED (fn);
670 if (need_flsbuf)
671 SET_REQUIRED (flsbuf_fn);
672 if (need_flsbuf + need_filbuf == 2)
673 new_list = "_filbuf\0_flsbuf\0";
674 else if (need_flsbuf)
675 new_list = "_flsbuf\0";
676 else /* if (need_flsbuf) */
677 new_list = "_filbuf\0";
678 add_symbols (ANSI_SYMBOL, new_list);
679 required_unseen_count += need_filbuf + need_flsbuf;
684 if (required_unseen_count + partial_count + required_other
685 #if ADD_MISSING_EXTERN_C
686 + missing_extern_C_count
687 #endif
688 == 0)
690 if (verbose)
691 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
692 exit (SUCCESS_EXIT_CODE);
694 if (!verbose)
695 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
696 else
698 if (required_unseen_count)
699 fprintf (stderr, "%s: %d missing function declarations.\n",
700 inc_filename, required_unseen_count);
701 if (partial_count)
702 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
703 inc_filename, partial_count);
704 #if ADD_MISSING_EXTERN_C
705 if (missing_extern_C_count)
706 fprintf (stderr,
707 "%s: %d declarations not protected by extern \"C\".\n",
708 inc_filename, missing_extern_C_count);
709 #endif
713 void
714 write_rbrac ()
716 struct fn_decl *fn;
717 const char *cptr;
718 register struct symbol_list *cur_symbols;
720 if (required_unseen_count)
722 #ifdef NO_IMPLICIT_EXTERN_C
723 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
724 #endif
727 /* Now we print out prototypes for those functions that we haven't seen. */
728 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
730 int if_was_emitted = 0;
731 int name_len;
732 cptr = cur_symbols->names;
733 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
735 int macro_protect = 0;
737 if (cur_symbols->flags & MACRO_SYMBOL)
738 continue;
740 fn = lookup_std_proto (cptr, name_len);
741 if (fn == NULL || !REQUIRED (fn))
742 continue;
744 if (!if_was_emitted)
746 /* what about curses. ??? or _flsbuf/_filbuf ??? */
747 if (cur_symbols->flags & ANSI_SYMBOL)
748 fprintf (outf,
749 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
750 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
751 fprintf (outf,
752 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
753 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
754 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
755 else if (cur_symbols->flags & XOPEN_SYMBOL)
757 fprintf (outf,
758 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
759 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
761 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
763 fprintf (outf,
764 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
765 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
767 else
769 fatal ("internal error for function %s", fn->fname);
771 if_was_emitted = 1;
774 /* In the case of memmove, protect in case the application
775 defines it as a macro before including the header. */
776 if (!strcmp (fn->fname, "memmove")
777 || !strcmp (fn->fname, "vprintf")
778 || !strcmp (fn->fname, "vfprintf")
779 || !strcmp (fn->fname, "vsprintf")
780 || !strcmp (fn->fname, "rewinddir"))
781 macro_protect = 1;
783 if (macro_protect)
784 fprintf (outf, "#ifndef %s\n", fn->fname);
785 fprintf (outf, "extern %s %s (%s);\n",
786 fn->rtype, fn->fname, fn->params);
787 if (macro_protect)
788 fprintf (outf, "#endif\n");
790 if (if_was_emitted)
791 fprintf (outf,
792 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
794 if (required_unseen_count)
796 #ifdef NO_IMPLICIT_EXTERN_C
797 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
798 #endif
801 switch (special_file_handling)
803 case errno_h:
804 if (!seen_errno)
805 fprintf (outf, "extern int errno;\n");
806 break;
807 case stdlib_h:
808 if (!seen_EXIT_FAILURE)
809 fprintf (outf, "#define EXIT_FAILURE 1\n");
810 if (!seen_EXIT_SUCCESS)
811 fprintf (outf, "#define EXIT_SUCCESS 0\n");
812 break;
813 case sys_stat_h:
814 if (!seen_S_ISBLK && seen_S_IFBLK)
815 fprintf (outf,
816 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
817 if (!seen_S_ISCHR && seen_S_IFCHR)
818 fprintf (outf,
819 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
820 if (!seen_S_ISDIR && seen_S_IFDIR)
821 fprintf (outf,
822 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
823 if (!seen_S_ISFIFO && seen_S_IFIFO)
824 fprintf (outf,
825 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
826 if (!seen_S_ISLNK && seen_S_IFLNK)
827 fprintf (outf,
828 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
829 if (!seen_S_ISREG && seen_S_IFREG)
830 fprintf (outf,
831 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
832 break;
836 #if ADD_MISSING_EXTERN_C
837 if (missing_extern_C_count + required_unseen_count > 0)
838 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
839 #endif
842 char *
843 xstrdup (str)
844 char *str;
846 char *copy = (char *) xmalloc (strlen (str) + 1);
847 strcpy (copy, str);
848 return copy;
851 /* Returns 1 iff the file is properly protected from multiple inclusion:
852 #ifndef PROTECT_NAME
853 #define PROTECT_NAME
854 #endif
858 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
859 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
862 inf_skip_spaces (c)
863 int c;
865 for (;;)
867 if (c == ' ' || c == '\t')
868 c = INF_GET ();
869 else if (c == '/')
871 c = INF_GET ();
872 if (c != '*')
874 INF_UNGET (c);
875 return '/';
877 c = INF_GET ();
878 for (;;)
880 if (c == EOF)
881 return EOF;
882 else if (c != '*')
884 if (c == '\n')
885 source_lineno++, lineno++;
886 c = INF_GET ();
888 else if ((c = INF_GET ()) == '/')
889 return INF_GET ();
892 else
893 break;
895 return c;
898 /* Read into STR from inf_buffer upto DELIM. */
901 inf_read_upto (str, delim)
902 sstring *str;
903 int delim;
905 int ch;
906 for (;;)
908 ch = INF_GET ();
909 if (ch == EOF || ch == delim)
910 break;
911 SSTRING_PUT (str, ch);
913 MAKE_SSTRING_SPACE (str, 1);
914 *str->ptr = 0;
915 return ch;
919 inf_scan_ident (s, c)
920 register sstring *s;
921 int c;
923 s->ptr = s->base;
924 if (isalpha (c) || c == '_')
926 for (;;)
928 SSTRING_PUT (s, c);
929 c = INF_GET ();
930 if (c == EOF || !(isalnum (c) || c == '_'))
931 break;
934 MAKE_SSTRING_SPACE (s, 1);
935 *s->ptr = 0;
936 return c;
939 /* Returns 1 if the file is correctly protected against multiple
940 inclusion, setting *ifndef_line to the line number of the initial #ifndef
941 and setting *endif_line to the final #endif.
942 Otherwise return 0. */
945 check_protection (ifndef_line, endif_line)
946 int *ifndef_line, *endif_line;
948 int c;
949 int if_nesting = 1; /* Level of nesting of #if's */
950 char *protect_name = NULL; /* Identifier following initial #ifndef */
951 int define_seen = 0;
953 /* Skip initial white space (including comments). */
954 for (;; lineno++)
956 c = inf_skip_spaces (' ');
957 if (c == EOF)
958 return 0;
959 if (c != '\n')
960 break;
962 if (c != '#')
963 return 0;
964 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
965 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
966 return 0;
968 /* So far so good: We've seen an initial #ifndef. */
969 *ifndef_line = lineno;
970 c = inf_scan_ident (&buf, inf_skip_spaces (c));
971 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
972 return 0;
973 protect_name = xstrdup (buf.base);
975 INF_UNGET (c);
976 c = inf_read_upto (&buf, '\n');
977 if (c == EOF)
978 return 0;
979 lineno++;
981 for (;;)
983 c = inf_skip_spaces (' ');
984 if (c == EOF)
985 return 0;
986 if (c == '\n')
988 lineno++;
989 continue;
991 if (c != '#')
992 goto skip_to_eol;
993 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
994 if (SSTRING_LENGTH (&buf) == 0)
996 else if (!strcmp (buf.base, "ifndef")
997 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
999 if_nesting++;
1001 else if (!strcmp (buf.base, "endif"))
1003 if_nesting--;
1004 if (if_nesting == 0)
1005 break;
1007 else if (!strcmp (buf.base, "else"))
1009 if (if_nesting == 1)
1010 return 0;
1012 else if (!strcmp (buf.base, "define"))
1014 if (if_nesting != 1)
1015 goto skip_to_eol;
1016 c = inf_skip_spaces (c);
1017 c = inf_scan_ident (&buf, c);
1018 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1019 define_seen = 1;
1021 skip_to_eol:
1022 for (;;)
1024 if (c == '\n' || c == EOF)
1025 break;
1026 c = INF_GET ();
1028 if (c == EOF)
1029 return 0;
1030 lineno++;
1033 if (!define_seen)
1034 return 0;
1035 *endif_line = lineno;
1036 /* Skip final white space (including comments). */
1037 for (;;)
1039 c = inf_skip_spaces (' ');
1040 if (c == EOF)
1041 break;
1042 if (c != '\n')
1043 return 0;
1046 return 1;
1050 main (argc, argv)
1051 int argc;
1052 char **argv;
1054 int inf_fd;
1055 struct stat sbuf;
1056 int c;
1057 int i, done;
1058 const char *cptr, **pptr;
1059 int ifndef_line;
1060 int endif_line;
1061 long to_read;
1062 long int inf_size;
1063 register struct symbol_list *cur_symbols;
1065 if (argv[0] && argv[0][0])
1067 register char *p;
1069 progname = 0;
1070 for (p = argv[0]; *p; p++)
1071 if (*p == '/')
1072 progname = p;
1073 progname = progname ? progname+1 : argv[0];
1076 if (argc < 4)
1078 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1079 progname);
1080 exit (FATAL_EXIT_CODE);
1083 inc_filename = argv[1];
1084 inc_filename_length = strlen (inc_filename);
1086 #ifdef FIXPROTO_IGNORE_LIST
1087 for (i = 0; files_to_ignore[i] != NULL; i++)
1089 char *ignore_name = files_to_ignore[i];
1090 int ignore_len = strlen (ignore_name);
1091 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1093 if (ignore_name[ignore_len-1] == '/'
1094 || inc_filename[ignore_len] == '\0')
1096 if (verbose)
1097 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1098 exit (SUCCESS_EXIT_CODE);
1103 #endif
1105 if (strcmp (inc_filename, "sys/stat.h") == 0)
1106 special_file_handling = sys_stat_h;
1107 else if (strcmp (inc_filename, "errno.h") == 0)
1108 special_file_handling = errno_h, required_other++;
1109 else if (strcmp (inc_filename, "stdlib.h") == 0)
1110 special_file_handling = stdlib_h, required_other+=2;
1111 else if (strcmp (inc_filename, "stdio.h") == 0)
1112 special_file_handling = stdio_h;
1113 include_entry = std_include_table;
1114 while (include_entry->name != NULL
1115 && (include_entry->name == CONTINUED
1116 || strcmp (inc_filename, include_entry->name) != 0))
1117 include_entry++;
1119 if (include_entry->name != NULL)
1121 struct std_include_entry *entry;
1122 cur_symbol_table_size = 0;
1123 for (entry = include_entry; ;)
1125 add_symbols (entry->flags, entry->names);
1126 entry++;
1127 if (entry->name != CONTINUED)
1128 break;
1131 else
1132 symbol_table[0].names = NULL;
1134 /* Count and mark the prototypes required for this include file. */
1135 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1137 int name_len;
1138 if (cur_symbols->flags & MACRO_SYMBOL)
1139 continue;
1140 cptr = cur_symbols->names;
1141 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1143 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1144 required_unseen_count++;
1145 if (fn == NULL)
1146 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1147 else
1148 SET_REQUIRED (fn);
1152 read_scan_file (argv[2], argc - 4, argv + 4);
1154 inf_fd = open (argv[2], O_RDONLY, 0666);
1155 if (inf_fd < 0)
1157 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1158 progname, argv[2]);
1159 perror (NULL);
1160 exit (FATAL_EXIT_CODE);
1162 if (fstat (inf_fd, &sbuf) < 0)
1164 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1165 perror (NULL);
1166 exit (FATAL_EXIT_CODE);
1168 inf_size = sbuf.st_size;
1169 inf_buffer = (char *) xmalloc (inf_size + 2);
1170 inf_buffer[inf_size] = '\n';
1171 inf_buffer[inf_size + 1] = '\0';
1172 inf_limit = inf_buffer + inf_size;
1173 inf_ptr = inf_buffer;
1175 to_read = inf_size;
1176 while (to_read > 0)
1178 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1179 if (i < 0)
1181 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1182 perror (NULL);
1183 exit (FATAL_EXIT_CODE);
1185 if (i == 0)
1187 inf_size -= to_read;
1188 break;
1190 to_read -= i;
1193 close (inf_fd);
1195 /* If file doesn't end with '\n', add one. */
1196 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1197 inf_limit++;
1199 unlink (argv[3]);
1200 outf = fopen (argv[3], "w");
1201 if (outf == NULL)
1203 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1204 progname, argv[3]);
1205 perror (NULL);
1206 exit (FATAL_EXIT_CODE);
1209 lineno = 1;
1211 if (check_protection (&ifndef_line, &endif_line))
1213 lbrac_line = ifndef_line+1;
1214 rbrac_line = endif_line;
1216 else
1218 lbrac_line = 1;
1219 rbrac_line = -1;
1222 /* Reset input file. */
1223 inf_ptr = inf_buffer;
1224 lineno = 1;
1226 for (;;)
1228 if (lineno == lbrac_line)
1229 write_lbrac ();
1230 if (lineno == rbrac_line)
1231 write_rbrac ();
1232 for (;;)
1234 struct fn_decl *fn;
1235 c = INF_GET ();
1236 if (c == EOF)
1237 break;
1238 if (isalpha (c) || c == '_')
1240 c = inf_scan_ident (&buf, c);
1241 INF_UNGET (c);
1242 fputs (buf.base, outf);
1243 fn = lookup_std_proto (buf.base, strlen (buf.base));
1244 /* We only want to edit the declaration matching the one
1245 seen by scan-decls, as there can be multiple
1246 declarations, selected by #ifdef __STDC__ or whatever. */
1247 if (fn && fn->partial && fn->partial->line_seen == lineno)
1249 c = inf_skip_spaces (' ');
1250 if (c == EOF)
1251 break;
1252 if (c == '(')
1254 c = inf_skip_spaces (' ');
1255 if (c == ')')
1257 fprintf (outf, " _PARAMS((%s))", fn->params);
1259 else
1261 putc ('(', outf);
1262 INF_UNGET (c);
1265 else
1266 fprintf (outf, " %c", c);
1269 else
1271 putc (c, outf);
1272 if (c == '\n')
1273 break;
1276 if (c == EOF)
1277 break;
1278 lineno++;
1280 if (rbrac_line < 0)
1281 write_rbrac ();
1283 fclose (outf);
1285 return 0;
1288 /* Stub error functions. These replace cpperror.c,
1289 because we want to suppress error messages. */
1291 void
1292 cpp_file_line_for_message (pfile, filename, line, column)
1293 cpp_reader *pfile;
1294 char *filename;
1295 int line, column;
1297 if (!verbose)
1298 return;
1299 if (column > 0)
1300 fprintf (stderr, "%s:%d:%d: ", filename, line, column);
1301 else
1302 fprintf (stderr, "%s:%d: ", filename, line);
1305 void
1306 cpp_print_containing_files (pfile)
1307 cpp_reader *pfile;
1311 /* IS_ERROR is 2 for fatal error, 1 for error, 0 for warning */
1313 void cpp_message (pfile, is_error, msg, arg1, arg2, arg3)
1314 int is_error;
1315 cpp_reader *pfile;
1316 char *msg;
1317 char *arg1, *arg2, *arg3;
1319 if (is_error == 1)
1320 pfile->errors++;
1321 else if (is_error > 1)
1322 pfile->errors = CPP_FATAL_LIMIT;
1323 if (!verbose)
1324 return;
1325 if (!is_error)
1326 fprintf (stderr, "warning: ");
1327 fprintf (stderr, msg, arg1, arg2, arg3);
1328 fprintf (stderr, "\n");
1331 void
1332 fatal (str, arg)
1333 char *str, *arg;
1335 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1336 fprintf (stderr, str, arg);
1337 fprintf (stderr, "\n");
1338 exit (FATAL_EXIT_CODE);
1341 void
1342 cpp_fatal (pfile, str, arg)
1343 cpp_reader *pfile;
1344 char *str, *arg;
1346 fatal (str, arg);
1349 void
1350 cpp_pfatal_with_name (pfile, name)
1351 cpp_reader *pfile;
1352 char *name;
1354 cpp_perror_with_name (pfile, name);
1355 exit (FATAL_EXIT_CODE);