* java/lang/natSystem.cc (SystemClass): New define.
[official-gcc.git] / gcc / fix-header.c
blob35942d25db6a3a3aa537c05f36bda8ab24aa4524
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 94-98, 1999 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
7 later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* This program massages a system include file (such as stdio.h),
19 into a form that is compatible with GNU C and GNU C++.
21 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
22 if they seem to be needed. These prevent C++ compilers from name
23 mangling the functions inside the braces.
25 * If an old-style incomplete function declaration is seen (without
26 an argument list), and it is a "standard" function listed in
27 the file sys-protos.h (and with a non-empty argument list), then
28 the declaration is converted to a complete prototype by replacing
29 the empty parameter list with the argument list from sys-protos.h.
31 * The program can be given a list of (names of) required standard
32 functions (such as fclose for stdio.h). If a required function
33 is not seen in the input, then a prototype for it will be
34 written to the output.
36 * If all of the non-comment code of the original file is protected
37 against multiple inclusion:
38 #ifndef FOO
39 #define FOO
40 <body of include file>
41 #endif
42 then extra matter added to the include file is placed inside the <body>.
44 * If the input file is OK (nothing needs to be done);
45 the output file is not written (nor removed if it exists).
47 There are also some special actions that are done for certain
48 well-known standard include files:
50 * If argv[1] is "sys/stat.h", the Posix.1 macros
51 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
52 they were missing, and the corresponding "traditional" S_IFxxx
53 macros were defined.
55 * If argv[1] is "errno.h", errno is declared if it was missing.
57 * TODO: The input file should be read complete into memory, because:
58 a) it needs to be scanned twice anyway, and
59 b) it would be nice to allow update in place.
61 Usage:
62 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
63 where:
64 * FOO.H is the relative file name of the include file,
65 as it would be #include'd by a C file. (E.g. stdio.h)
66 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
67 * OUTFILE.H is the full pathname for where to write the output file,
68 if anything needs to be done. (e.g. ./include/stdio.h)
69 * OPTIONS are such as you would pass to cpp.
71 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
73 #include "hconfig.h"
74 #include "system.h"
75 #include "obstack.h"
76 #include "scan.h"
77 #include "cpplib.h"
78 #include "cpphash.h"
80 static void v_fatal PROTO ((const char *, va_list)) ATTRIBUTE_NORETURN;
81 void fatal PVPROTO ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
83 sstring buf;
85 int verbose = 0;
86 int partial_count = 0;
87 int warnings = 0;
89 /* We no longer need to add extern "C", because cpp implicitly
90 forces the standard include files to be treated as C. */
91 /*#define ADD_MISSING_EXTERN_C 1 */
93 #if ADD_MISSING_EXTERN_C
94 int missing_extern_C_count = 0;
95 #endif
97 #include "xsys-protos.h"
99 #ifdef FIXPROTO_IGNORE_LIST
100 /* This is a currently unused feature. */
102 /* List of files and directories to ignore.
103 A directory name (ending in '/') means ignore anything in that
104 directory. (It might be more efficient to do directory pruning
105 earlier in fixproto, but this is simpler and easier to customize.) */
107 static char *files_to_ignore[] = {
108 "X11/",
109 FIXPROTO_IGNORE_LIST
112 #endif
114 char *inf_buffer;
115 char *inf_limit;
116 char *inf_ptr;
118 /* Certain standard files get extra treatment */
120 enum special_file
122 no_special,
123 #ifdef errno_h
124 #undef errno_h
125 #endif
126 errno_h,
127 #ifdef stdio_h
128 #undef stdio_h
129 #endif
130 stdio_h,
131 #ifdef stdlib_h
132 #undef stdlib_h
133 #endif
134 stdlib_h,
135 #ifdef sys_stat_h
136 #undef sys_stat_h
137 #endif
138 sys_stat_h
141 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
142 by an empty name (i.e. by "\0\0"). */
144 typedef const char *namelist;
146 /* The following macros provide the bits for symbol_flags. */
147 typedef int symbol_flags;
149 /* Used to mark names defined in the ANSI/ISO C standard. */
150 #define ANSI_SYMBOL 1
152 /* We no longer massage include files for POSIX or XOPEN symbols,
153 as there are now several versions of the POSIX and XOPEN standards,
154 and it would be a maintenance nightmare for us to track them all.
155 Better to be compatible with the system include files. */
156 /*#define ADD_MISSING_POSIX 1 */
157 /*#define ADD_MISSING_XOPEN 1 */
159 #if ADD_MISSING_POSIX
160 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
161 #define POSIX1_SYMBOL 2
162 #define POSIX2_SYMBOL 4
163 #else
164 #define POSIX1_SYMBOL 0
165 #define POSIX2_SYMBOL 0
166 #endif
168 #if ADD_MISSING_XOPEN
169 /* Used to mark names defined in X/Open Portability Guide. */
170 #define XOPEN_SYMBOL 8
171 /* Used to mark names defined in X/Open UNIX Extensions. */
172 #define XOPEN_EXTENDED_SYMBOL 16
173 #else
174 #define XOPEN_SYMBOL 0
175 #define XOPEN_EXTENDED_SYMBOL 0
176 #endif
178 /* Used to indicate names that are not functions */
179 #define MACRO_SYMBOL 512
181 struct symbol_list {
182 symbol_flags flags;
183 namelist names;
186 #define SYMBOL_TABLE_SIZE 10
187 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
188 int cur_symbol_table_size;
190 void
191 add_symbols (flags, names)
192 symbol_flags flags;
193 namelist names;
195 symbol_table[cur_symbol_table_size].flags = flags;
196 symbol_table[cur_symbol_table_size].names = names;
197 cur_symbol_table_size++;
198 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
199 fatal ("too many calls to add_symbols");
200 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
203 struct std_include_entry {
204 const char *name;
205 symbol_flags flags;
206 namelist names;
209 const char NONE[] = ""; /* The empty namelist. */
211 /* Special name to indicate a continuation line in std_include_table. */
212 const char CONTINUED[] = "";
214 struct std_include_entry *include_entry;
216 struct std_include_entry std_include_table [] = {
217 { "ctype.h", ANSI_SYMBOL,
218 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
219 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
221 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
223 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
225 /* ANSI_SYMBOL is wrong, but ... */
226 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
227 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
228 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
229 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
230 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
232 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
234 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
235 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
237 /*{ "limit.h", ... provided by gcc }, */
239 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
241 { "math.h", ANSI_SYMBOL,
242 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
243 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
244 tan\0tanh\0" },
246 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
248 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
250 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
251 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
253 /* Left out signal() - its prototype is too complex for us!
254 Also left out "sigaction sigaddset sigdelset sigemptyset
255 sigfillset sigismember sigpending sigprocmask sigsuspend"
256 because these need sigset_t or struct sigaction.
257 Most systems that provide them will also declare them. */
258 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
260 { "stdio.h", ANSI_SYMBOL,
261 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
262 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
263 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
264 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
265 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
266 tmpnam\0ungetc\0" },
267 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
268 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
269 /* Should perhaps also handle NULL, EOF, ... ? */
271 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
272 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
273 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
274 Should perhaps also add NULL */
275 { "stdlib.h", ANSI_SYMBOL,
276 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
277 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
278 srand\0strtod\0strtol\0strtoul\0system\0" },
279 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
281 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
282 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
283 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
284 strtok\0strxfrm\0" },
285 /* Should perhaps also add NULL and size_t */
287 { "strings.h", XOPEN_EXTENDED_SYMBOL,
288 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
290 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
292 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
293 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
294 and many systems do have <sys/ioctl.h> but not <strops.h>. */
295 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
297 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
299 { "sys/stat.h", POSIX1_SYMBOL,
300 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
301 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
302 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
303 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
304 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
306 #if 0
307 /* How do we handle fd_set? */
308 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
309 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
310 #endif
312 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
313 /* "sys/types.h" add types (not in old g++-include) */
315 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
317 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
318 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
319 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
320 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
322 { "tar.h", POSIX1_SYMBOL, NONE },
324 { "termios.h", POSIX1_SYMBOL,
325 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
327 { "time.h", ANSI_SYMBOL,
328 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
330 { "unistd.h", POSIX1_SYMBOL,
331 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
332 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
333 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
334 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
335 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
336 ttyname\0unlink\0write\0" },
337 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
338 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
339 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
341 { "utime.h", POSIX1_SYMBOL, "utime\0" },
343 { NULL, 0, NONE }
346 enum special_file special_file_handling = no_special;
348 /* They are set if the corresponding macro has been seen. */
349 /* The following are only used when handling sys/stat.h */
350 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
351 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
352 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
353 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
354 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
355 int seen_S_IFREG = 0, seen_S_ISREG = 0;
356 /* The following are only used when handling errno.h */
357 int seen_errno = 0;
358 /* The following are only used when handling stdlib.h */
359 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
361 /* Wrapper around free, to avoid prototype clashes. */
363 void
364 xfree (ptr)
365 char *ptr;
367 free (ptr);
370 /* Avoid error if config defines abort as fancy_abort.
371 It's not worth "really" implementing this because ordinary
372 compiler users never run fix-header. */
374 void
375 fancy_abort ()
377 abort ();
380 #define obstack_chunk_alloc xmalloc
381 #define obstack_chunk_free xfree
382 struct obstack scan_file_obstack;
384 /* NOTE: If you edit this, also edit gen-protos.c !! */
386 struct fn_decl *
387 lookup_std_proto (name, name_length)
388 const char *name;
389 int name_length;
391 int i = hashf (name, name_length, HASH_SIZE);
392 int i0 = i;
393 for (;;)
395 struct fn_decl *fn;
396 if (hash_tab[i] == 0)
397 return NULL;
398 fn = &std_protos[hash_tab[i]];
399 if ((int) strlen (fn->fname) == name_length
400 && strncmp (fn->fname, name, name_length) == 0)
401 return fn;
402 i = (i+1) % HASH_SIZE;
403 if (i == i0)
404 abort ();
408 char *inc_filename;
409 int inc_filename_length;
410 char *progname = "fix-header";
411 FILE *outf;
412 sstring line;
414 int lbrac_line, rbrac_line;
416 int required_unseen_count = 0;
417 int required_other = 0;
419 void
420 write_lbrac ()
423 #if ADD_MISSING_EXTERN_C
424 if (missing_extern_C_count + required_unseen_count > 0)
425 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
426 #endif
428 if (partial_count)
430 fprintf (outf, "#ifndef _PARAMS\n");
431 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
432 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
433 fprintf (outf, "#else\n");
434 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
435 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
439 struct partial_proto
441 struct partial_proto *next;
442 char *fname; /* name of function */
443 char *rtype; /* return type */
444 struct fn_decl *fn;
445 int line_seen;
448 struct partial_proto *partial_proto_list = NULL;
450 struct partial_proto required_dummy_proto, seen_dummy_proto;
451 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
452 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
453 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
454 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
456 void
457 recognized_macro (fname)
458 char *fname;
460 /* The original include file defines fname as a macro. */
461 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
463 /* Since fname is a macro, don't require a prototype for it. */
464 if (fn)
466 if (REQUIRED (fn))
467 required_unseen_count--;
468 SET_SEEN (fn);
471 switch (special_file_handling)
473 case errno_h:
474 if (strcmp (fname, "errno") == 0 && !seen_errno)
475 seen_errno = 1, required_other--;
476 break;
477 case stdlib_h:
478 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
479 seen_EXIT_FAILURE = 1, required_other--;
480 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
481 seen_EXIT_SUCCESS = 1, required_other--;
482 break;
483 case sys_stat_h:
484 if (fname[0] == 'S' && fname[1] == '_')
486 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
487 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
488 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
489 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
490 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
491 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
492 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
493 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
494 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
495 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
496 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
497 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
499 break;
501 default:
502 break;
506 void
507 recognized_extern (name, name_length, type, type_length)
508 char *name;
509 char *type;
510 int name_length, type_length;
512 switch (special_file_handling)
514 case errno_h:
515 if (name_length == 5 && strncmp (name, "errno", 5) == 0 && !seen_errno)
516 seen_errno = 1, required_other--;
517 break;
519 default:
520 break;
524 /* Called by scan_decls if it saw a function definition for a function
525 named FNAME, with return type RTYPE, and argument list ARGS,
526 in source file FILE_SEEN on line LINE_SEEN.
527 KIND is 'I' for an inline function;
528 'F' if a normal function declaration preceded by 'extern "C"'
529 (or nested inside 'extern "C"' braces); or
530 'f' for other function declarations. */
532 void
533 recognized_function (fname, fname_length,
534 kind, rtype, rtype_length,
535 have_arg_list, file_seen, line_seen)
536 char *fname;
537 int fname_length;
538 int kind; /* One of 'f' 'F' or 'I' */
539 char *rtype;
540 int rtype_length;
541 int have_arg_list;
542 char *file_seen;
543 int line_seen;
545 struct partial_proto *partial;
546 int i;
547 struct fn_decl *fn;
548 #if ADD_MISSING_EXTERN_C
549 if (kind == 'f')
550 missing_extern_C_count++;
551 #endif
553 fn = lookup_std_proto (fname, fname_length);
555 /* Remove the function from the list of required function. */
556 if (fn)
558 if (REQUIRED (fn))
559 required_unseen_count--;
560 SET_SEEN (fn);
563 /* If we have a full prototype, we're done. */
564 if (have_arg_list)
565 return;
567 if (kind == 'I') /* don't edit inline function */
568 return;
570 /* If the partial prototype was included from some other file,
571 we don't need to patch it up (in this run). */
572 i = strlen (file_seen);
573 if (i < inc_filename_length
574 || strcmp (inc_filename, file_seen + (i - inc_filename_length)) != 0)
575 return;
577 if (fn == NULL)
578 return;
579 if (fn->params[0] == '\0' || strcmp (fn->params, "void") == 0)
580 return;
582 /* We only have a partial function declaration,
583 so remember that we have to add a complete prototype. */
584 partial_count++;
585 partial = (struct partial_proto *)
586 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
587 partial->fname = obstack_alloc (&scan_file_obstack, fname_length + 1);
588 bcopy (fname, partial->fname, fname_length);
589 partial->fname[fname_length] = 0;
590 partial->rtype = obstack_alloc (&scan_file_obstack, rtype_length + 1);
591 sprintf (partial->rtype, "%.*s", rtype_length, rtype);
592 partial->line_seen = line_seen;
593 partial->fn = fn;
594 fn->partial = partial;
595 partial->next = partial_proto_list;
596 partial_proto_list = partial;
597 if (verbose)
599 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
600 inc_filename, partial->fname);
604 /* For any name in NAMES that is defined as a macro,
605 call recognized_macro on it. */
607 void
608 check_macro_names (pfile, names)
609 cpp_reader *pfile;
610 namelist names;
612 while (*names)
614 if (cpp_lookup (pfile, names, -1, -1))
615 recognized_macro (names);
616 names += strlen (names) + 1;
620 void
621 read_scan_file (in_fname, argc, argv)
622 char *in_fname;
623 int argc;
624 char **argv;
626 cpp_reader scan_in;
627 cpp_options scan_options;
628 struct fn_decl *fn;
629 int i;
630 register struct symbol_list *cur_symbols;
632 obstack_init (&scan_file_obstack);
634 cpp_reader_init (&scan_in);
635 scan_in.opts = &scan_options;
636 cpp_options_init (&scan_options);
637 i = cpp_handle_options (&scan_in, argc, argv);
638 if (i < argc && ! CPP_FATAL_ERRORS (&scan_in))
639 cpp_fatal (&scan_in, "Invalid option `%s'", argv[i]);
640 if (CPP_FATAL_ERRORS (&scan_in))
641 exit (FATAL_EXIT_CODE);
643 if (! cpp_start_read (&scan_in, in_fname))
644 exit (FATAL_EXIT_CODE);
645 CPP_OPTIONS (&scan_in)->no_line_commands = 1;
647 scan_decls (&scan_in, argc, argv);
648 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
649 check_macro_names (&scan_in, cur_symbols->names);
651 if (verbose && (scan_in.errors + warnings) > 0)
652 fprintf (stderr, "(%s: %d errors and %d warnings from cpp)\n",
653 inc_filename, scan_in.errors, warnings);
654 if (scan_in.errors)
655 exit (SUCCESS_EXIT_CODE);
657 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
658 If so, those functions are also required. */
659 if (special_file_handling == stdio_h
660 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
662 static char getchar_call[] = "getchar();";
663 cpp_buffer *buf
664 = cpp_push_buffer (&scan_in, getchar_call, sizeof(getchar_call) - 1);
665 int old_written = CPP_WRITTEN (&scan_in);
666 int seen_filbuf = 0;
668 /* Scan the macro expansion of "getchar();". */
669 for (;;)
671 enum cpp_token token = cpp_get_token (&scan_in);
672 int length = CPP_WRITTEN (&scan_in) - old_written;
673 CPP_SET_WRITTEN (&scan_in, old_written);
674 if (token == CPP_EOF) /* Should not happen ... */
675 break;
676 if (token == CPP_POP && CPP_BUFFER (&scan_in) == buf)
678 cpp_pop_buffer (&scan_in);
679 break;
681 if (token == CPP_NAME && length == 7
682 && strcmp ("_filbuf", scan_in.token_buffer + old_written) == 0)
683 seen_filbuf++;
685 if (seen_filbuf)
687 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
688 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
689 int need_flsbuf
690 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
692 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
693 if (need_filbuf + need_flsbuf)
695 const char *new_list;
696 if (need_filbuf)
697 SET_REQUIRED (fn);
698 if (need_flsbuf)
699 SET_REQUIRED (flsbuf_fn);
700 if (need_flsbuf + need_filbuf == 2)
701 new_list = "_filbuf\0_flsbuf\0";
702 else if (need_flsbuf)
703 new_list = "_flsbuf\0";
704 else /* if (need_flsbuf) */
705 new_list = "_filbuf\0";
706 add_symbols (ANSI_SYMBOL, new_list);
707 required_unseen_count += need_filbuf + need_flsbuf;
712 if (required_unseen_count + partial_count + required_other
713 #if ADD_MISSING_EXTERN_C
714 + missing_extern_C_count
715 #endif
716 == 0)
718 if (verbose)
719 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
720 exit (SUCCESS_EXIT_CODE);
722 if (!verbose)
723 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
724 else
726 if (required_unseen_count)
727 fprintf (stderr, "%s: %d missing function declarations.\n",
728 inc_filename, required_unseen_count);
729 if (partial_count)
730 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
731 inc_filename, partial_count);
732 #if ADD_MISSING_EXTERN_C
733 if (missing_extern_C_count)
734 fprintf (stderr,
735 "%s: %d declarations not protected by extern \"C\".\n",
736 inc_filename, missing_extern_C_count);
737 #endif
741 void
742 write_rbrac ()
744 struct fn_decl *fn;
745 const char *cptr;
746 register struct symbol_list *cur_symbols;
748 if (required_unseen_count)
750 #ifdef NO_IMPLICIT_EXTERN_C
751 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
752 #endif
755 /* Now we print out prototypes for those functions that we haven't seen. */
756 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
758 int if_was_emitted = 0;
759 int name_len;
760 cptr = cur_symbols->names;
761 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
763 int macro_protect = 0;
765 if (cur_symbols->flags & MACRO_SYMBOL)
766 continue;
768 fn = lookup_std_proto (cptr, name_len);
769 if (fn == NULL || !REQUIRED (fn))
770 continue;
772 if (!if_was_emitted)
774 /* what about curses. ??? or _flsbuf/_filbuf ??? */
775 if (cur_symbols->flags & ANSI_SYMBOL)
776 fprintf (outf,
777 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
778 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
779 fprintf (outf,
780 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
781 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
782 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
783 else if (cur_symbols->flags & XOPEN_SYMBOL)
785 fprintf (outf,
786 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
787 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
789 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
791 fprintf (outf,
792 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
793 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
795 else
797 fatal ("internal error for function %s", fn->fname);
799 if_was_emitted = 1;
802 /* In the case of memmove, protect in case the application
803 defines it as a macro before including the header. */
804 if (!strcmp (fn->fname, "memmove")
805 || !strcmp (fn->fname, "vprintf")
806 || !strcmp (fn->fname, "vfprintf")
807 || !strcmp (fn->fname, "vsprintf")
808 || !strcmp (fn->fname, "rewinddir")
809 || !strcmp (fn->fname, "abort"))
810 macro_protect = 1;
812 if (macro_protect)
813 fprintf (outf, "#ifndef %s\n", fn->fname);
814 fprintf (outf, "extern %s %s (%s);\n",
815 fn->rtype, fn->fname, fn->params);
816 if (macro_protect)
817 fprintf (outf, "#endif\n");
819 if (if_was_emitted)
820 fprintf (outf,
821 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
823 if (required_unseen_count)
825 #ifdef NO_IMPLICIT_EXTERN_C
826 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
827 #endif
830 switch (special_file_handling)
832 case errno_h:
833 if (!seen_errno)
834 fprintf (outf, "extern int errno;\n");
835 break;
836 case stdlib_h:
837 if (!seen_EXIT_FAILURE)
838 fprintf (outf, "#define EXIT_FAILURE 1\n");
839 if (!seen_EXIT_SUCCESS)
840 fprintf (outf, "#define EXIT_SUCCESS 0\n");
841 break;
842 case sys_stat_h:
843 if (!seen_S_ISBLK && seen_S_IFBLK)
844 fprintf (outf,
845 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
846 if (!seen_S_ISCHR && seen_S_IFCHR)
847 fprintf (outf,
848 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
849 if (!seen_S_ISDIR && seen_S_IFDIR)
850 fprintf (outf,
851 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
852 if (!seen_S_ISFIFO && seen_S_IFIFO)
853 fprintf (outf,
854 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
855 if (!seen_S_ISLNK && seen_S_IFLNK)
856 fprintf (outf,
857 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
858 if (!seen_S_ISREG && seen_S_IFREG)
859 fprintf (outf,
860 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
861 break;
863 default:
864 break;
868 #if ADD_MISSING_EXTERN_C
869 if (missing_extern_C_count + required_unseen_count > 0)
870 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
871 #endif
874 /* Returns 1 iff the file is properly protected from multiple inclusion:
875 #ifndef PROTECT_NAME
876 #define PROTECT_NAME
877 #endif
881 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
882 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
885 inf_skip_spaces (c)
886 int c;
888 for (;;)
890 if (c == ' ' || c == '\t')
891 c = INF_GET ();
892 else if (c == '/')
894 c = INF_GET ();
895 if (c != '*')
897 (void) INF_UNGET (c);
898 return '/';
900 c = INF_GET ();
901 for (;;)
903 if (c == EOF)
904 return EOF;
905 else if (c != '*')
907 if (c == '\n')
908 source_lineno++, lineno++;
909 c = INF_GET ();
911 else if ((c = INF_GET ()) == '/')
912 return INF_GET ();
915 else
916 break;
918 return c;
921 /* Read into STR from inf_buffer upto DELIM. */
924 inf_read_upto (str, delim)
925 sstring *str;
926 int delim;
928 int ch;
929 for (;;)
931 ch = INF_GET ();
932 if (ch == EOF || ch == delim)
933 break;
934 SSTRING_PUT (str, ch);
936 MAKE_SSTRING_SPACE (str, 1);
937 *str->ptr = 0;
938 return ch;
942 inf_scan_ident (s, c)
943 register sstring *s;
944 int c;
946 s->ptr = s->base;
947 if (ISALPHA (c) || c == '_')
949 for (;;)
951 SSTRING_PUT (s, c);
952 c = INF_GET ();
953 if (c == EOF || !(ISALNUM (c) || c == '_'))
954 break;
957 MAKE_SSTRING_SPACE (s, 1);
958 *s->ptr = 0;
959 return c;
962 /* Returns 1 if the file is correctly protected against multiple
963 inclusion, setting *ifndef_line to the line number of the initial #ifndef
964 and setting *endif_line to the final #endif.
965 Otherwise return 0. */
968 check_protection (ifndef_line, endif_line)
969 int *ifndef_line, *endif_line;
971 int c;
972 int if_nesting = 1; /* Level of nesting of #if's */
973 char *protect_name = NULL; /* Identifier following initial #ifndef */
974 int define_seen = 0;
976 /* Skip initial white space (including comments). */
977 for (;; lineno++)
979 c = inf_skip_spaces (' ');
980 if (c == EOF)
981 return 0;
982 if (c != '\n')
983 break;
985 if (c != '#')
986 return 0;
987 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
988 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
989 return 0;
991 /* So far so good: We've seen an initial #ifndef. */
992 *ifndef_line = lineno;
993 c = inf_scan_ident (&buf, inf_skip_spaces (c));
994 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
995 return 0;
996 protect_name = xstrdup (buf.base);
998 (void) INF_UNGET (c);
999 c = inf_read_upto (&buf, '\n');
1000 if (c == EOF)
1001 return 0;
1002 lineno++;
1004 for (;;)
1006 c = inf_skip_spaces (' ');
1007 if (c == EOF)
1008 return 0;
1009 if (c == '\n')
1011 lineno++;
1012 continue;
1014 if (c != '#')
1015 goto skip_to_eol;
1016 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1017 if (SSTRING_LENGTH (&buf) == 0)
1019 else if (!strcmp (buf.base, "ifndef")
1020 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1022 if_nesting++;
1024 else if (!strcmp (buf.base, "endif"))
1026 if_nesting--;
1027 if (if_nesting == 0)
1028 break;
1030 else if (!strcmp (buf.base, "else"))
1032 if (if_nesting == 1)
1033 return 0;
1035 else if (!strcmp (buf.base, "define"))
1037 if (if_nesting != 1)
1038 goto skip_to_eol;
1039 c = inf_skip_spaces (c);
1040 c = inf_scan_ident (&buf, c);
1041 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1042 define_seen = 1;
1044 skip_to_eol:
1045 for (;;)
1047 if (c == '\n' || c == EOF)
1048 break;
1049 c = INF_GET ();
1051 if (c == EOF)
1052 return 0;
1053 lineno++;
1056 if (!define_seen)
1057 return 0;
1058 *endif_line = lineno;
1059 /* Skip final white space (including comments). */
1060 for (;;)
1062 c = inf_skip_spaces (' ');
1063 if (c == EOF)
1064 break;
1065 if (c != '\n')
1066 return 0;
1069 return 1;
1073 main (argc, argv)
1074 int argc;
1075 char **argv;
1077 int inf_fd;
1078 struct stat sbuf;
1079 int c;
1080 #ifdef FIXPROTO_IGNORE_LIST
1081 int i;
1082 #endif
1083 const char *cptr;
1084 int ifndef_line;
1085 int endif_line;
1086 long to_read;
1087 long int inf_size;
1088 register struct symbol_list *cur_symbols;
1090 if (argv[0] && argv[0][0])
1092 register char *p;
1094 progname = 0;
1095 for (p = argv[0]; *p; p++)
1096 if (*p == '/')
1097 progname = p;
1098 progname = progname ? progname+1 : argv[0];
1101 if (argc < 4)
1103 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1104 progname);
1105 exit (FATAL_EXIT_CODE);
1108 inc_filename = argv[1];
1109 inc_filename_length = strlen (inc_filename);
1111 #ifdef FIXPROTO_IGNORE_LIST
1112 for (i = 0; files_to_ignore[i] != NULL; i++)
1114 char *ignore_name = files_to_ignore[i];
1115 int ignore_len = strlen (ignore_name);
1116 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1118 if (ignore_name[ignore_len-1] == '/'
1119 || inc_filename[ignore_len] == '\0')
1121 if (verbose)
1122 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1123 exit (SUCCESS_EXIT_CODE);
1128 #endif
1130 if (strcmp (inc_filename, "sys/stat.h") == 0)
1131 special_file_handling = sys_stat_h;
1132 else if (strcmp (inc_filename, "errno.h") == 0)
1133 special_file_handling = errno_h, required_other++;
1134 else if (strcmp (inc_filename, "stdlib.h") == 0)
1135 special_file_handling = stdlib_h, required_other+=2;
1136 else if (strcmp (inc_filename, "stdio.h") == 0)
1137 special_file_handling = stdio_h;
1138 include_entry = std_include_table;
1139 while (include_entry->name != NULL
1140 && (include_entry->name == CONTINUED
1141 || strcmp (inc_filename, include_entry->name) != 0))
1142 include_entry++;
1144 if (include_entry->name != NULL)
1146 struct std_include_entry *entry;
1147 cur_symbol_table_size = 0;
1148 for (entry = include_entry; ;)
1150 if (entry->flags)
1151 add_symbols (entry->flags, entry->names);
1152 entry++;
1153 if (entry->name != CONTINUED)
1154 break;
1157 else
1158 symbol_table[0].names = NULL;
1160 /* Count and mark the prototypes required for this include file. */
1161 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1163 int name_len;
1164 if (cur_symbols->flags & MACRO_SYMBOL)
1165 continue;
1166 cptr = cur_symbols->names;
1167 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1169 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1170 required_unseen_count++;
1171 if (fn == NULL)
1172 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1173 else
1174 SET_REQUIRED (fn);
1178 read_scan_file (argv[2], argc - 4, argv + 4);
1180 inf_fd = open (argv[2], O_RDONLY, 0666);
1181 if (inf_fd < 0)
1183 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1184 progname, argv[2]);
1185 perror (NULL);
1186 exit (FATAL_EXIT_CODE);
1188 if (fstat (inf_fd, &sbuf) < 0)
1190 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1191 perror (NULL);
1192 exit (FATAL_EXIT_CODE);
1194 inf_size = sbuf.st_size;
1195 inf_buffer = (char *) xmalloc (inf_size + 2);
1196 inf_buffer[inf_size] = '\n';
1197 inf_buffer[inf_size + 1] = '\0';
1198 inf_limit = inf_buffer + inf_size;
1199 inf_ptr = inf_buffer;
1201 to_read = inf_size;
1202 while (to_read > 0)
1204 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1205 if (i < 0)
1207 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1208 perror (NULL);
1209 exit (FATAL_EXIT_CODE);
1211 if (i == 0)
1213 inf_size -= to_read;
1214 break;
1216 to_read -= i;
1219 close (inf_fd);
1221 /* If file doesn't end with '\n', add one. */
1222 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1223 inf_limit++;
1225 unlink (argv[3]);
1226 outf = fopen (argv[3], "w");
1227 if (outf == NULL)
1229 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1230 progname, argv[3]);
1231 perror (NULL);
1232 exit (FATAL_EXIT_CODE);
1235 lineno = 1;
1237 if (check_protection (&ifndef_line, &endif_line))
1239 lbrac_line = ifndef_line+1;
1240 rbrac_line = endif_line;
1242 else
1244 lbrac_line = 1;
1245 rbrac_line = -1;
1248 /* Reset input file. */
1249 inf_ptr = inf_buffer;
1250 lineno = 1;
1252 for (;;)
1254 if (lineno == lbrac_line)
1255 write_lbrac ();
1256 if (lineno == rbrac_line)
1257 write_rbrac ();
1258 for (;;)
1260 struct fn_decl *fn;
1261 c = INF_GET ();
1262 if (c == EOF)
1263 break;
1264 if (ISALPHA (c) || c == '_')
1266 c = inf_scan_ident (&buf, c);
1267 (void) INF_UNGET (c);
1268 fputs (buf.base, outf);
1269 fn = lookup_std_proto (buf.base, strlen (buf.base));
1270 /* We only want to edit the declaration matching the one
1271 seen by scan-decls, as there can be multiple
1272 declarations, selected by #ifdef __STDC__ or whatever. */
1273 if (fn && fn->partial && fn->partial->line_seen == lineno)
1275 c = inf_skip_spaces (' ');
1276 if (c == EOF)
1277 break;
1278 if (c == '(')
1280 c = inf_skip_spaces (' ');
1281 if (c == ')')
1283 fprintf (outf, " _PARAMS((%s))", fn->params);
1285 else
1287 putc ('(', outf);
1288 (void) INF_UNGET (c);
1291 else
1292 fprintf (outf, " %c", c);
1295 else
1297 putc (c, outf);
1298 if (c == '\n')
1299 break;
1302 if (c == EOF)
1303 break;
1304 lineno++;
1306 if (rbrac_line < 0)
1307 write_rbrac ();
1309 fclose (outf);
1311 return 0;
1315 static void
1316 v_fatal (str, ap)
1317 const char * str;
1318 va_list ap;
1320 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1321 vfprintf (stderr, str, ap);
1322 fprintf (stderr, "\n");
1324 exit (FATAL_EXIT_CODE);
1327 void
1328 fatal VPROTO ((const char *str, ...))
1330 #ifndef ANSI_PROTOTYPES
1331 const char *str;
1332 #endif
1333 va_list ap;
1335 VA_START(ap, str);
1337 #ifndef ANSI_PROTOTYPES
1338 str = va_arg (ap, const char *);
1339 #endif
1341 v_fatal(str, ap);
1342 va_end(ap);