tree.c (build_tree_list): Fix parameter names in comment.
[official-gcc.git] / gcc / fix-header.c
blobd722450a6223d99b7cc0a106203269032b4226f4
1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
8 later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
19 /* This program massages a system include file (such as stdio.h),
20 into a form that is compatible with GNU C and GNU C++.
22 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
23 if they seem to be needed. These prevent C++ compilers from name
24 mangling the functions inside the braces.
26 * If an old-style incomplete function declaration is seen (without
27 an argument list), and it is a "standard" function listed in
28 the file sys-protos.h (and with a non-empty argument list), then
29 the declaration is converted to a complete prototype by replacing
30 the empty parameter list with the argument list from sys-protos.h.
32 * The program can be given a list of (names of) required standard
33 functions (such as fclose for stdio.h). If a required function
34 is not seen in the input, then a prototype for it will be
35 written to the output.
37 * If all of the non-comment code of the original file is protected
38 against multiple inclusion:
39 #ifndef FOO
40 #define FOO
41 <body of include file>
42 #endif
43 then extra matter added to the include file is placed inside the <body>.
45 * If the input file is OK (nothing needs to be done);
46 the output file is not written (nor removed if it exists).
48 There are also some special actions that are done for certain
49 well-known standard include files:
51 * If argv[1] is "sys/stat.h", the Posix.1 macros
52 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
53 they were missing, and the corresponding "traditional" S_IFxxx
54 macros were defined.
56 * If argv[1] is "errno.h", errno is declared if it was missing.
58 * TODO: The input file should be read complete into memory, because:
59 a) it needs to be scanned twice anyway, and
60 b) it would be nice to allow update in place.
62 Usage:
63 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
64 where:
65 * FOO.H is the relative file name of the include file,
66 as it would be #include'd by a C file. (E.g. stdio.h)
67 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
68 * OUTFILE.H is the full pathname for where to write the output file,
69 if anything needs to be done. (e.g. ./include/stdio.h)
70 * OPTIONS are such as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
74 #include "bconfig.h"
75 #include "system.h"
76 #include "coretypes.h"
77 #include "tm.h"
78 #include "obstack.h"
79 #include "scan.h"
80 #include "cpplib.h"
82 static void v_fatal PARAMS ((const char *, va_list)) ATTRIBUTE_PRINTF (1,0) ATTRIBUTE_NORETURN;
83 static void fatal PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
85 sstring buf;
87 int verbose = 0;
88 int partial_count = 0;
89 int warnings = 0;
91 /* We no longer need to add extern "C", because cpp implicitly
92 forces the standard include files to be treated as C. */
93 /*#define ADD_MISSING_EXTERN_C 1 */
95 #if ADD_MISSING_EXTERN_C
96 int missing_extern_C_count = 0;
97 #endif
99 #include "xsys-protos.h"
101 #ifdef FIXPROTO_IGNORE_LIST
102 /* This is a currently unused feature. */
104 /* List of files and directories to ignore.
105 A directory name (ending in '/') means ignore anything in that
106 directory. (It might be more efficient to do directory pruning
107 earlier in fixproto, but this is simpler and easier to customize.) */
109 static const char *const files_to_ignore[] = {
110 "X11/",
111 FIXPROTO_IGNORE_LIST
114 #endif
116 char *inf_buffer;
117 char *inf_limit;
118 char *inf_ptr;
119 static const char *cur_file;
121 /* Certain standard files get extra treatment */
123 enum special_file
125 no_special,
126 #ifdef errno_h
127 #undef errno_h
128 #endif
129 errno_h,
130 #ifdef stdio_h
131 #undef stdio_h
132 #endif
133 stdio_h,
134 #ifdef stdlib_h
135 #undef stdlib_h
136 #endif
137 stdlib_h,
138 #ifdef sys_stat_h
139 #undef sys_stat_h
140 #endif
141 sys_stat_h
144 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
145 by an empty name (i.e. by "\0\0"). */
147 typedef const char *namelist;
149 /* The following macros provide the bits for symbol_flags. */
150 typedef int symbol_flags;
152 /* Used to mark names defined in the ANSI/ISO C standard. */
153 #define ANSI_SYMBOL 1
155 /* We no longer massage include files for POSIX or XOPEN symbols,
156 as there are now several versions of the POSIX and XOPEN standards,
157 and it would be a maintenance nightmare for us to track them all.
158 Better to be compatible with the system include files. */
159 /*#define ADD_MISSING_POSIX 1 */
160 /*#define ADD_MISSING_XOPEN 1 */
162 #if ADD_MISSING_POSIX
163 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
164 #define POSIX1_SYMBOL 2
165 #define POSIX2_SYMBOL 4
166 #else
167 #define POSIX1_SYMBOL 0
168 #define POSIX2_SYMBOL 0
169 #endif
171 #if ADD_MISSING_XOPEN
172 /* Used to mark names defined in X/Open Portability Guide. */
173 #define XOPEN_SYMBOL 8
174 /* Used to mark names defined in X/Open UNIX Extensions. */
175 #define XOPEN_EXTENDED_SYMBOL 16
176 #else
177 #define XOPEN_SYMBOL 0
178 #define XOPEN_EXTENDED_SYMBOL 0
179 #endif
181 /* Used to indicate names that are not functions */
182 #define MACRO_SYMBOL 512
184 struct symbol_list {
185 symbol_flags flags;
186 namelist names;
189 #define SYMBOL_TABLE_SIZE 10
190 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
191 int cur_symbol_table_size;
193 static void add_symbols PARAMS ((symbol_flags, namelist));
194 static struct fn_decl *lookup_std_proto PARAMS ((const char *, int));
195 static void write_lbrac PARAMS ((void));
196 static void recognized_macro PARAMS ((const char *));
197 static void check_macro_names PARAMS ((cpp_reader *, namelist));
198 static void read_scan_file PARAMS ((char *, int, char **));
199 static void write_rbrac PARAMS ((void));
200 static int inf_skip_spaces PARAMS ((int));
201 static int inf_read_upto PARAMS ((sstring *, int));
202 static int inf_scan_ident PARAMS ((sstring *, int));
203 static int check_protection PARAMS ((int *, int *));
204 static void cb_file_change PARAMS ((cpp_reader *, const struct line_map *));
206 static void
207 add_symbols (flags, names)
208 symbol_flags flags;
209 namelist names;
211 symbol_table[cur_symbol_table_size].flags = flags;
212 symbol_table[cur_symbol_table_size].names = names;
213 cur_symbol_table_size++;
214 if (cur_symbol_table_size >= SYMBOL_TABLE_SIZE)
215 fatal ("too many calls to add_symbols");
216 symbol_table[cur_symbol_table_size].names = NULL; /* Termination. */
219 struct std_include_entry {
220 const char *const name;
221 const symbol_flags flags;
222 const namelist names;
225 const char NONE[] = ""; /* The empty namelist. */
227 /* Special name to indicate a continuation line in std_include_table. */
228 const char CONTINUED[] = "";
230 const struct std_include_entry *include_entry;
232 const struct std_include_entry std_include_table [] = {
233 { "ctype.h", ANSI_SYMBOL,
234 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
235 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
237 { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
239 { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
241 /* ANSI_SYMBOL is wrong, but ... */
242 { "curses.h", ANSI_SYMBOL, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
243 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
244 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
245 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
246 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
248 { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
250 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
251 { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
253 /*{ "limit.h", ... provided by gcc }, */
255 { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
257 { "math.h", ANSI_SYMBOL,
258 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
259 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
260 tan\0tanh\0" },
262 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
264 { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
266 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
267 { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
269 /* Left out signal() - its prototype is too complex for us!
270 Also left out "sigaction sigaddset sigdelset sigemptyset
271 sigfillset sigismember sigpending sigprocmask sigsuspend"
272 because these need sigset_t or struct sigaction.
273 Most systems that provide them will also declare them. */
274 { "signal.h", ANSI_SYMBOL, "kill\0raise\0" },
276 { "stdio.h", ANSI_SYMBOL,
277 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
278 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
279 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
280 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
281 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
282 tmpnam\0ungetc\0" },
283 { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
284 { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" }, /* I think ... */
285 /* Should perhaps also handle NULL, EOF, ... ? */
287 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
288 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
289 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
290 Should perhaps also add NULL */
291 { "stdlib.h", ANSI_SYMBOL,
292 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
293 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
294 srand\0strtod\0strtol\0strtoul\0system\0" },
295 { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
297 { "string.h", ANSI_SYMBOL, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
298 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
299 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
300 strtok\0strxfrm\0" },
301 /* Should perhaps also add NULL and size_t */
303 { "strings.h", XOPEN_EXTENDED_SYMBOL,
304 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
306 { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
308 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
309 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
310 and many systems do have <sys/ioctl.h> but not <strops.h>. */
311 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
313 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
315 { "sys/stat.h", POSIX1_SYMBOL,
316 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
317 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
318 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
319 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
320 { CONTINUED, XOPEN_EXTENDED_SYMBOL, "fchmod\0" },
322 #if 0
323 /* How do we handle fd_set? */
324 { "sys/time.h", XOPEN_EXTENDED_SYMBOL, "select\0" },
325 { "sys/select.h", XOPEN_EXTENDED_SYMBOL /* fake */, "select\0" },
326 #endif
328 { "sys/times.h", POSIX1_SYMBOL, "times\0" },
329 /* "sys/types.h" add types (not in old g++-include) */
331 { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
333 { "sys/wait.h", POSIX1_SYMBOL, "wait\0waitpid\0" },
334 { CONTINUED, POSIX1_SYMBOL|MACRO_SYMBOL,
335 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
336 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
338 { "tar.h", POSIX1_SYMBOL, NONE },
340 { "termios.h", POSIX1_SYMBOL,
341 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
343 { "time.h", ANSI_SYMBOL,
344 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
346 { "unistd.h", POSIX1_SYMBOL,
347 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
348 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
349 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
350 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
351 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
352 ttyname\0unlink\0write\0" },
353 { CONTINUED, POSIX2_SYMBOL, "getopt\0" },
354 { CONTINUED, XOPEN_EXTENDED_SYMBOL,
355 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
357 { "utime.h", POSIX1_SYMBOL, "utime\0" },
359 { NULL, 0, NONE }
362 enum special_file special_file_handling = no_special;
364 /* They are set if the corresponding macro has been seen. */
365 /* The following are only used when handling sys/stat.h */
366 int seen_S_IFBLK = 0, seen_S_ISBLK = 0;
367 int seen_S_IFCHR = 0, seen_S_ISCHR = 0;
368 int seen_S_IFDIR = 0, seen_S_ISDIR = 0;
369 int seen_S_IFIFO = 0, seen_S_ISFIFO = 0;
370 int seen_S_IFLNK = 0, seen_S_ISLNK = 0;
371 int seen_S_IFREG = 0, seen_S_ISREG = 0;
372 /* The following are only used when handling errno.h */
373 int seen_errno = 0;
374 /* The following are only used when handling stdlib.h */
375 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
377 struct obstack scan_file_obstack;
379 /* NOTE: If you edit this, also edit gen-protos.c !! */
381 static struct fn_decl *
382 lookup_std_proto (name, name_length)
383 const char *name;
384 int name_length;
386 int i = hashstr (name, name_length) % HASH_SIZE;
387 int i0 = i;
388 for (;;)
390 struct fn_decl *fn;
391 if (hash_tab[i] == 0)
392 return NULL;
393 fn = &std_protos[hash_tab[i]];
394 if ((int) strlen (fn->fname) == name_length
395 && strncmp (fn->fname, name, name_length) == 0)
396 return fn;
397 i = (i+1) % HASH_SIZE;
398 if (i == i0)
399 abort ();
403 char *inc_filename;
404 int inc_filename_length;
405 const char *progname = "fix-header";
406 FILE *outf;
407 sstring line;
409 int lbrac_line, rbrac_line;
411 int required_unseen_count = 0;
412 int required_other = 0;
414 static void
415 write_lbrac ()
418 #if ADD_MISSING_EXTERN_C
419 if (missing_extern_C_count + required_unseen_count > 0)
420 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
421 #endif
423 if (partial_count)
425 fprintf (outf, "#ifndef _PARAMS\n");
426 fprintf (outf, "#if defined(__STDC__) || defined(__cplusplus)\n");
427 fprintf (outf, "#define _PARAMS(ARGS) ARGS\n");
428 fprintf (outf, "#else\n");
429 fprintf (outf, "#define _PARAMS(ARGS) ()\n");
430 fprintf (outf, "#endif\n#endif /* _PARAMS */\n");
434 struct partial_proto
436 struct partial_proto *next;
437 struct fn_decl *fn;
438 int line_seen;
441 struct partial_proto *partial_proto_list = NULL;
443 struct partial_proto required_dummy_proto, seen_dummy_proto;
444 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
445 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
446 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
447 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
449 static void
450 recognized_macro (fname)
451 const char *fname;
453 /* The original include file defines fname as a macro. */
454 struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
456 /* Since fname is a macro, don't require a prototype for it. */
457 if (fn)
459 if (REQUIRED (fn))
460 required_unseen_count--;
461 SET_SEEN (fn);
464 switch (special_file_handling)
466 case errno_h:
467 if (strcmp (fname, "errno") == 0 && !seen_errno)
468 seen_errno = 1, required_other--;
469 break;
470 case stdlib_h:
471 if (strcmp (fname, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE)
472 seen_EXIT_FAILURE = 1, required_other--;
473 if (strcmp (fname, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS)
474 seen_EXIT_SUCCESS = 1, required_other--;
475 break;
476 case sys_stat_h:
477 if (fname[0] == 'S' && fname[1] == '_')
479 if (strcmp (fname, "S_IFBLK") == 0) seen_S_IFBLK++;
480 else if (strcmp (fname, "S_ISBLK") == 0) seen_S_ISBLK++;
481 else if (strcmp (fname, "S_IFCHR") == 0) seen_S_IFCHR++;
482 else if (strcmp (fname, "S_ISCHR") == 0) seen_S_ISCHR++;
483 else if (strcmp (fname, "S_IFDIR") == 0) seen_S_IFDIR++;
484 else if (strcmp (fname, "S_ISDIR") == 0) seen_S_ISDIR++;
485 else if (strcmp (fname, "S_IFIFO") == 0) seen_S_IFIFO++;
486 else if (strcmp (fname, "S_ISFIFO") == 0) seen_S_ISFIFO++;
487 else if (strcmp (fname, "S_IFLNK") == 0) seen_S_IFLNK++;
488 else if (strcmp (fname, "S_ISLNK") == 0) seen_S_ISLNK++;
489 else if (strcmp (fname, "S_IFREG") == 0) seen_S_IFREG++;
490 else if (strcmp (fname, "S_ISREG") == 0) seen_S_ISREG++;
492 break;
494 default:
495 break;
499 void
500 recognized_extern (name)
501 const cpp_token *name;
503 switch (special_file_handling)
505 case errno_h:
506 if (cpp_ideq (name, "errno"))
507 seen_errno = 1, required_other--;
508 break;
510 default:
511 break;
515 /* Called by scan_decls if it saw a function definition for a function
516 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
517 function declaration preceded by 'extern "C"' (or nested inside
518 'extern "C"' braces); or 'f' for other function declarations. */
520 void
521 recognized_function (fname, line, kind, have_arg_list)
522 const cpp_token *fname;
523 unsigned int line;
524 int kind; /* One of 'f' 'F' or 'I' */
525 int have_arg_list;
527 struct partial_proto *partial;
528 int i;
529 struct fn_decl *fn;
530 #if ADD_MISSING_EXTERN_C
531 if (kind == 'f')
532 missing_extern_C_count++;
533 #endif
535 fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
536 NODE_LEN (fname->val.node));
538 /* Remove the function from the list of required function. */
539 if (fn)
541 if (REQUIRED (fn))
542 required_unseen_count--;
543 SET_SEEN (fn);
546 /* If we have a full prototype, we're done. */
547 if (have_arg_list)
548 return;
550 if (kind == 'I') /* don't edit inline function */
551 return;
553 /* If the partial prototype was included from some other file,
554 we don't need to patch it up (in this run). */
555 i = strlen (cur_file);
556 if (i < inc_filename_length
557 || strcmp (inc_filename, cur_file + (i - inc_filename_length)) != 0)
558 return;
560 if (fn == NULL)
561 return;
562 if (fn->params[0] == '\0')
563 return;
565 /* We only have a partial function declaration,
566 so remember that we have to add a complete prototype. */
567 partial_count++;
568 partial = (struct partial_proto *)
569 obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
570 partial->line_seen = line;
571 partial->fn = fn;
572 fn->partial = partial;
573 partial->next = partial_proto_list;
574 partial_proto_list = partial;
575 if (verbose)
577 fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
578 inc_filename, fn->fname);
582 /* For any name in NAMES that is defined as a macro,
583 call recognized_macro on it. */
585 static void
586 check_macro_names (pfile, names)
587 cpp_reader *pfile;
588 namelist names;
590 size_t len;
591 while (*names)
593 len = strlen (names);
594 if (cpp_defined (pfile, (const unsigned char *)names, len))
595 recognized_macro (names);
596 names += len + 1;
600 static void
601 cb_file_change (pfile, map)
602 cpp_reader *pfile ATTRIBUTE_UNUSED;
603 const struct line_map *map;
605 /* Just keep track of current file name. */
606 cur_file = map->to_file;
609 static void
610 read_scan_file (in_fname, argc, argv)
611 char *in_fname;
612 int argc;
613 char **argv;
615 cpp_reader *scan_in;
616 cpp_callbacks *cb;
617 cpp_options *options;
618 struct fn_decl *fn;
619 int i;
620 struct symbol_list *cur_symbols;
622 obstack_init (&scan_file_obstack);
624 scan_in = cpp_create_reader (CLK_GNUC89);
625 cb = cpp_get_callbacks (scan_in);
626 cb->file_change = cb_file_change;
628 /* We are going to be scanning a header file out of its proper context,
629 so ignore warnings and errors. */
630 options = cpp_get_options (scan_in);
631 options->inhibit_warnings = 1;
632 options->inhibit_errors = 1;
634 i = cpp_handle_options (scan_in, argc, argv);
635 if (i < argc)
636 cpp_error (scan_in, DL_ERROR, "invalid option `%s'", argv[i]);
637 if (cpp_errors (scan_in))
638 exit (FATAL_EXIT_CODE);
640 if (! cpp_read_main_file (scan_in, in_fname, NULL))
641 exit (FATAL_EXIT_CODE);
643 cpp_finish_options (scan_in);
645 /* We are scanning a system header, so mark it as such. */
646 cpp_make_system_header (scan_in, 1, 0);
648 scan_decls (scan_in, argc, argv);
649 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
650 check_macro_names (scan_in, cur_symbols->names);
652 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
653 If so, those functions are also required. */
654 if (special_file_handling == stdio_h
655 && (fn = lookup_std_proto ("_filbuf", 7)) != NULL)
657 static const unsigned char getchar_call[] = "getchar();";
658 int seen_filbuf = 0;
660 /* Scan the macro expansion of "getchar();". */
661 cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
662 /* from_stage3 */ true, 1);
663 for (;;)
665 const cpp_token *t = cpp_get_token (scan_in);
667 if (t->type == CPP_EOF)
668 break;
669 else if (cpp_ideq (t, "_filbuf"))
670 seen_filbuf++;
673 if (seen_filbuf)
675 int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
676 struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
677 int need_flsbuf
678 = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
680 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
681 if (need_filbuf + need_flsbuf)
683 const char *new_list;
684 if (need_filbuf)
685 SET_REQUIRED (fn);
686 if (need_flsbuf)
687 SET_REQUIRED (flsbuf_fn);
688 if (need_flsbuf && need_filbuf)
689 new_list = "_filbuf\0_flsbuf\0";
690 else if (need_flsbuf)
691 new_list = "_flsbuf\0";
692 else /* if (need_flsbuf) */
693 new_list = "_filbuf\0";
694 add_symbols (ANSI_SYMBOL, new_list);
695 required_unseen_count += need_filbuf + need_flsbuf;
700 if (required_unseen_count + partial_count + required_other
701 #if ADD_MISSING_EXTERN_C
702 + missing_extern_C_count
703 #endif
704 == 0)
706 if (verbose)
707 fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
708 exit (SUCCESS_EXIT_CODE);
710 if (!verbose)
711 fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
712 else
714 if (required_unseen_count)
715 fprintf (stderr, "%s: %d missing function declarations.\n",
716 inc_filename, required_unseen_count);
717 if (partial_count)
718 fprintf (stderr, "%s: %d non-prototype function declarations.\n",
719 inc_filename, partial_count);
720 #if ADD_MISSING_EXTERN_C
721 if (missing_extern_C_count)
722 fprintf (stderr,
723 "%s: %d declarations not protected by extern \"C\".\n",
724 inc_filename, missing_extern_C_count);
725 #endif
729 static void
730 write_rbrac ()
732 struct fn_decl *fn;
733 const char *cptr;
734 struct symbol_list *cur_symbols;
736 if (required_unseen_count)
738 #ifdef NO_IMPLICIT_EXTERN_C
739 fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
740 #endif
743 /* Now we print out prototypes for those functions that we haven't seen. */
744 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
746 int if_was_emitted = 0;
747 int name_len;
748 cptr = cur_symbols->names;
749 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
751 int macro_protect = 0;
753 if (cur_symbols->flags & MACRO_SYMBOL)
754 continue;
756 fn = lookup_std_proto (cptr, name_len);
757 if (fn == NULL || !REQUIRED (fn))
758 continue;
760 if (!if_was_emitted)
762 /* what about curses. ??? or _flsbuf/_filbuf ??? */
763 if (cur_symbols->flags & ANSI_SYMBOL)
764 fprintf (outf,
765 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
766 else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
767 fprintf (outf,
768 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
769 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
770 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
771 else if (cur_symbols->flags & XOPEN_SYMBOL)
773 fprintf (outf,
774 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
775 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
777 else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
779 fprintf (outf,
780 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
781 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
783 else
785 fatal ("internal error for function %s", fn->fname);
787 if_was_emitted = 1;
790 /* In the case of memmove, protect in case the application
791 defines it as a macro before including the header. */
792 if (!strcmp (fn->fname, "memmove")
793 || !strcmp (fn->fname, "putc")
794 || !strcmp (fn->fname, "getc")
795 || !strcmp (fn->fname, "vprintf")
796 || !strcmp (fn->fname, "vfprintf")
797 || !strcmp (fn->fname, "vsprintf")
798 || !strcmp (fn->fname, "rewinddir")
799 || !strcmp (fn->fname, "abort"))
800 macro_protect = 1;
802 if (macro_protect)
803 fprintf (outf, "#ifndef %s\n", fn->fname);
804 fprintf (outf, "extern %s %s (%s);\n",
805 fn->rtype, fn->fname, fn->params);
806 if (macro_protect)
807 fprintf (outf, "#endif\n");
809 if (if_was_emitted)
810 fprintf (outf,
811 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
813 if (required_unseen_count)
815 #ifdef NO_IMPLICIT_EXTERN_C
816 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
817 #endif
820 switch (special_file_handling)
822 case errno_h:
823 if (!seen_errno)
824 fprintf (outf, "extern int errno;\n");
825 break;
826 case stdlib_h:
827 if (!seen_EXIT_FAILURE)
828 fprintf (outf, "#define EXIT_FAILURE 1\n");
829 if (!seen_EXIT_SUCCESS)
830 fprintf (outf, "#define EXIT_SUCCESS 0\n");
831 break;
832 case sys_stat_h:
833 if (!seen_S_ISBLK && seen_S_IFBLK)
834 fprintf (outf,
835 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
836 if (!seen_S_ISCHR && seen_S_IFCHR)
837 fprintf (outf,
838 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
839 if (!seen_S_ISDIR && seen_S_IFDIR)
840 fprintf (outf,
841 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
842 if (!seen_S_ISFIFO && seen_S_IFIFO)
843 fprintf (outf,
844 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
845 if (!seen_S_ISLNK && seen_S_IFLNK)
846 fprintf (outf,
847 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
848 if (!seen_S_ISREG && seen_S_IFREG)
849 fprintf (outf,
850 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
851 break;
853 default:
854 break;
858 #if ADD_MISSING_EXTERN_C
859 if (missing_extern_C_count + required_unseen_count > 0)
860 fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
861 #endif
864 /* Returns 1 iff the file is properly protected from multiple inclusion:
865 #ifndef PROTECT_NAME
866 #define PROTECT_NAME
867 #endif
871 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
872 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
874 static int
875 inf_skip_spaces (c)
876 int c;
878 for (;;)
880 if (c == ' ' || c == '\t')
881 c = INF_GET ();
882 else if (c == '/')
884 c = INF_GET ();
885 if (c != '*')
887 (void) INF_UNGET (c);
888 return '/';
890 c = INF_GET ();
891 for (;;)
893 if (c == EOF)
894 return EOF;
895 else if (c != '*')
897 if (c == '\n')
898 source_lineno++, lineno++;
899 c = INF_GET ();
901 else if ((c = INF_GET ()) == '/')
902 return INF_GET ();
905 else
906 break;
908 return c;
911 /* Read into STR from inf_buffer upto DELIM. */
913 static int
914 inf_read_upto (str, delim)
915 sstring *str;
916 int delim;
918 int ch;
919 for (;;)
921 ch = INF_GET ();
922 if (ch == EOF || ch == delim)
923 break;
924 SSTRING_PUT (str, ch);
926 MAKE_SSTRING_SPACE (str, 1);
927 *str->ptr = 0;
928 return ch;
931 static int
932 inf_scan_ident (s, c)
933 sstring *s;
934 int c;
936 s->ptr = s->base;
937 if (ISIDST (c))
939 for (;;)
941 SSTRING_PUT (s, c);
942 c = INF_GET ();
943 if (c == EOF || !(ISIDNUM (c)))
944 break;
947 MAKE_SSTRING_SPACE (s, 1);
948 *s->ptr = 0;
949 return c;
952 /* Returns 1 if the file is correctly protected against multiple
953 inclusion, setting *ifndef_line to the line number of the initial #ifndef
954 and setting *endif_line to the final #endif.
955 Otherwise return 0. */
957 static int
958 check_protection (ifndef_line, endif_line)
959 int *ifndef_line, *endif_line;
961 int c;
962 int if_nesting = 1; /* Level of nesting of #if's */
963 char *protect_name = NULL; /* Identifier following initial #ifndef */
964 int define_seen = 0;
966 /* Skip initial white space (including comments). */
967 for (;; lineno++)
969 c = inf_skip_spaces (' ');
970 if (c == EOF)
971 return 0;
972 if (c != '\n')
973 break;
975 if (c != '#')
976 return 0;
977 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
978 if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
979 return 0;
981 /* So far so good: We've seen an initial #ifndef. */
982 *ifndef_line = lineno;
983 c = inf_scan_ident (&buf, inf_skip_spaces (c));
984 if (SSTRING_LENGTH (&buf) == 0 || c == EOF)
985 return 0;
986 protect_name = xstrdup (buf.base);
988 (void) INF_UNGET (c);
989 c = inf_read_upto (&buf, '\n');
990 if (c == EOF)
991 return 0;
992 lineno++;
994 for (;;)
996 c = inf_skip_spaces (' ');
997 if (c == EOF)
998 return 0;
999 if (c == '\n')
1001 lineno++;
1002 continue;
1004 if (c != '#')
1005 goto skip_to_eol;
1006 c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1007 if (SSTRING_LENGTH (&buf) == 0)
1009 else if (!strcmp (buf.base, "ifndef")
1010 || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1012 if_nesting++;
1014 else if (!strcmp (buf.base, "endif"))
1016 if_nesting--;
1017 if (if_nesting == 0)
1018 break;
1020 else if (!strcmp (buf.base, "else"))
1022 if (if_nesting == 1)
1023 return 0;
1025 else if (!strcmp (buf.base, "define"))
1027 c = inf_skip_spaces (c);
1028 c = inf_scan_ident (&buf, c);
1029 if (buf.base[0] > 0 && strcmp (buf.base, protect_name) == 0)
1030 define_seen = 1;
1032 skip_to_eol:
1033 for (;;)
1035 if (c == '\n' || c == EOF)
1036 break;
1037 c = INF_GET ();
1039 if (c == EOF)
1040 return 0;
1041 lineno++;
1044 if (!define_seen)
1045 return 0;
1046 *endif_line = lineno;
1047 /* Skip final white space (including comments). */
1048 for (;;)
1050 c = inf_skip_spaces (' ');
1051 if (c == EOF)
1052 break;
1053 if (c != '\n')
1054 return 0;
1057 return 1;
1060 extern int main PARAMS ((int, char **));
1063 main (argc, argv)
1064 int argc;
1065 char **argv;
1067 int inf_fd;
1068 struct stat sbuf;
1069 int c;
1070 #ifdef FIXPROTO_IGNORE_LIST
1071 int i;
1072 #endif
1073 const char *cptr;
1074 int ifndef_line;
1075 int endif_line;
1076 long to_read;
1077 long int inf_size;
1078 struct symbol_list *cur_symbols;
1080 if (argv[0] && argv[0][0])
1082 char *p;
1084 progname = 0;
1085 for (p = argv[0]; *p; p++)
1086 if (*p == '/')
1087 progname = p;
1088 progname = progname ? progname+1 : argv[0];
1091 if (argc < 4)
1093 fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1094 progname);
1095 exit (FATAL_EXIT_CODE);
1098 inc_filename = argv[1];
1099 inc_filename_length = strlen (inc_filename);
1101 #ifdef FIXPROTO_IGNORE_LIST
1102 for (i = 0; files_to_ignore[i] != NULL; i++)
1104 const char *const ignore_name = files_to_ignore[i];
1105 int ignore_len = strlen (ignore_name);
1106 if (strncmp (inc_filename, ignore_name, ignore_len) == 0)
1108 if (ignore_name[ignore_len-1] == '/'
1109 || inc_filename[ignore_len] == '\0')
1111 if (verbose)
1112 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1113 exit (SUCCESS_EXIT_CODE);
1118 #endif
1120 if (strcmp (inc_filename, "sys/stat.h") == 0)
1121 special_file_handling = sys_stat_h;
1122 else if (strcmp (inc_filename, "errno.h") == 0)
1123 special_file_handling = errno_h, required_other++;
1124 else if (strcmp (inc_filename, "stdlib.h") == 0)
1125 special_file_handling = stdlib_h, required_other+=2;
1126 else if (strcmp (inc_filename, "stdio.h") == 0)
1127 special_file_handling = stdio_h;
1128 include_entry = std_include_table;
1129 while (include_entry->name != NULL
1130 && ((strcmp (include_entry->name, CONTINUED) == 0)
1131 || strcmp (inc_filename, include_entry->name) != 0))
1132 include_entry++;
1134 if (include_entry->name != NULL)
1136 const struct std_include_entry *entry;
1137 cur_symbol_table_size = 0;
1138 for (entry = include_entry; ;)
1140 if (entry->flags)
1141 add_symbols (entry->flags, entry->names);
1142 entry++;
1143 if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1144 break;
1147 else
1148 symbol_table[0].names = NULL;
1150 /* Count and mark the prototypes required for this include file. */
1151 for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1153 int name_len;
1154 if (cur_symbols->flags & MACRO_SYMBOL)
1155 continue;
1156 cptr = cur_symbols->names;
1157 for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1159 struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1160 required_unseen_count++;
1161 if (fn == NULL)
1162 fprintf (stderr, "Internal error: No prototype for %s\n", cptr);
1163 else
1164 SET_REQUIRED (fn);
1168 read_scan_file (argv[2], argc - 4, argv + 4);
1170 inf_fd = open (argv[2], O_RDONLY, 0666);
1171 if (inf_fd < 0)
1173 fprintf (stderr, "%s: Cannot open '%s' for reading -",
1174 progname, argv[2]);
1175 perror (NULL);
1176 exit (FATAL_EXIT_CODE);
1178 if (fstat (inf_fd, &sbuf) < 0)
1180 fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1181 perror (NULL);
1182 exit (FATAL_EXIT_CODE);
1184 inf_size = sbuf.st_size;
1185 inf_buffer = (char *) xmalloc (inf_size + 2);
1186 inf_ptr = inf_buffer;
1188 to_read = inf_size;
1189 while (to_read > 0)
1191 long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1192 if (i < 0)
1194 fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1195 perror (NULL);
1196 exit (FATAL_EXIT_CODE);
1198 if (i == 0)
1200 inf_size -= to_read;
1201 break;
1203 to_read -= i;
1206 close (inf_fd);
1208 /* Inf_size may have changed if read was short (as on VMS) */
1209 inf_buffer[inf_size] = '\n';
1210 inf_buffer[inf_size + 1] = '\0';
1211 inf_limit = inf_buffer + inf_size;
1213 /* If file doesn't end with '\n', add one. */
1214 if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1215 inf_limit++;
1217 unlink (argv[3]);
1218 outf = fopen (argv[3], "w");
1219 if (outf == NULL)
1221 fprintf (stderr, "%s: Cannot open '%s' for writing -",
1222 progname, argv[3]);
1223 perror (NULL);
1224 exit (FATAL_EXIT_CODE);
1227 lineno = 1;
1229 if (check_protection (&ifndef_line, &endif_line))
1231 lbrac_line = ifndef_line+1;
1232 rbrac_line = endif_line;
1234 else
1236 lbrac_line = 1;
1237 rbrac_line = -1;
1240 /* Reset input file. */
1241 inf_ptr = inf_buffer;
1242 lineno = 1;
1244 for (;;)
1246 if (lineno == lbrac_line)
1247 write_lbrac ();
1248 if (lineno == rbrac_line)
1249 write_rbrac ();
1250 for (;;)
1252 struct fn_decl *fn;
1253 c = INF_GET ();
1254 if (c == EOF)
1255 break;
1256 if (ISIDST (c))
1258 c = inf_scan_ident (&buf, c);
1259 (void) INF_UNGET (c);
1260 fputs (buf.base, outf);
1261 fn = lookup_std_proto (buf.base, strlen (buf.base));
1262 /* We only want to edit the declaration matching the one
1263 seen by scan-decls, as there can be multiple
1264 declarations, selected by #ifdef __STDC__ or whatever. */
1265 if (fn && fn->partial && fn->partial->line_seen == lineno)
1267 c = inf_skip_spaces (' ');
1268 if (c == EOF)
1269 break;
1270 if (c == '(')
1272 c = inf_skip_spaces (' ');
1273 if (c == ')')
1275 fprintf (outf, " _PARAMS((%s))", fn->params);
1277 else
1279 putc ('(', outf);
1280 (void) INF_UNGET (c);
1283 else
1284 fprintf (outf, " %c", c);
1287 else
1289 putc (c, outf);
1290 if (c == '\n')
1291 break;
1294 if (c == EOF)
1295 break;
1296 lineno++;
1298 if (rbrac_line < 0)
1299 write_rbrac ();
1301 fclose (outf);
1303 return 0;
1307 static void
1308 v_fatal (str, ap)
1309 const char * str;
1310 va_list ap;
1312 fprintf (stderr, "%s: %s: ", progname, inc_filename);
1313 vfprintf (stderr, str, ap);
1314 fprintf (stderr, "\n");
1316 exit (FATAL_EXIT_CODE);
1319 static void
1320 fatal VPARAMS ((const char *str, ...))
1322 VA_OPEN (ap, str);
1323 VA_FIXEDARG (ap, const char *, str);
1325 v_fatal (str, ap);
1326 VA_CLOSE (ap);