1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003 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
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:
41 <body of include file>
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
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.
63 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
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 can be -D or -I switches as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
76 #include "coretypes.h"
81 #include "c-incpath.h"
83 static void v_fatal
PARAMS ((const char *, va_list)) ATTRIBUTE_PRINTF (1,0) ATTRIBUTE_NORETURN
;
84 static void fatal
PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN
;
89 int partial_count
= 0;
92 /* We no longer need to add extern "C", because cpp implicitly
93 forces the standard include files to be treated as C. */
94 /*#define ADD_MISSING_EXTERN_C 1 */
96 #if ADD_MISSING_EXTERN_C
97 int missing_extern_C_count
= 0;
100 #include "xsys-protos.h"
102 #ifdef FIXPROTO_IGNORE_LIST
103 /* This is a currently unused feature. */
105 /* List of files and directories to ignore.
106 A directory name (ending in '/') means ignore anything in that
107 directory. (It might be more efficient to do directory pruning
108 earlier in fixproto, but this is simpler and easier to customize.) */
110 static const char *const files_to_ignore
[] = {
120 static const char *cur_file
;
122 /* Certain standard files get extra treatment */
145 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
146 by an empty name (i.e. by "\0\0"). */
148 typedef const char *namelist
;
150 /* The following macros provide the bits for symbol_flags. */
151 typedef int symbol_flags
;
153 /* Used to mark names defined in the ANSI/ISO C standard. */
154 #define ANSI_SYMBOL 1
156 /* We no longer massage include files for POSIX or XOPEN symbols,
157 as there are now several versions of the POSIX and XOPEN standards,
158 and it would be a maintenance nightmare for us to track them all.
159 Better to be compatible with the system include files. */
160 /*#define ADD_MISSING_POSIX 1 */
161 /*#define ADD_MISSING_XOPEN 1 */
163 #if ADD_MISSING_POSIX
164 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
165 #define POSIX1_SYMBOL 2
166 #define POSIX2_SYMBOL 4
168 #define POSIX1_SYMBOL 0
169 #define POSIX2_SYMBOL 0
172 #if ADD_MISSING_XOPEN
173 /* Used to mark names defined in X/Open Portability Guide. */
174 #define XOPEN_SYMBOL 8
175 /* Used to mark names defined in X/Open UNIX Extensions. */
176 #define XOPEN_EXTENDED_SYMBOL 16
178 #define XOPEN_SYMBOL 0
179 #define XOPEN_EXTENDED_SYMBOL 0
182 /* Used to indicate names that are not functions */
183 #define MACRO_SYMBOL 512
190 #define SYMBOL_TABLE_SIZE 10
191 struct symbol_list symbol_table
[SYMBOL_TABLE_SIZE
];
192 int cur_symbol_table_size
;
194 static void add_symbols
PARAMS ((symbol_flags
, namelist
));
195 static struct fn_decl
*lookup_std_proto
PARAMS ((const char *, int));
196 static void write_lbrac
PARAMS ((void));
197 static void recognized_macro
PARAMS ((const char *));
198 static void check_macro_names
PARAMS ((cpp_reader
*, namelist
));
199 static void read_scan_file
PARAMS ((char *, int, char **));
200 static void write_rbrac
PARAMS ((void));
201 static int inf_skip_spaces
PARAMS ((int));
202 static int inf_read_upto
PARAMS ((sstring
*, int));
203 static int inf_scan_ident
PARAMS ((sstring
*, int));
204 static int check_protection
PARAMS ((int *, int *));
205 static void cb_file_change
PARAMS ((cpp_reader
*, const struct line_map
*));
208 add_symbols (flags
, names
)
212 symbol_table
[cur_symbol_table_size
].flags
= flags
;
213 symbol_table
[cur_symbol_table_size
].names
= names
;
214 cur_symbol_table_size
++;
215 if (cur_symbol_table_size
>= SYMBOL_TABLE_SIZE
)
216 fatal ("too many calls to add_symbols");
217 symbol_table
[cur_symbol_table_size
].names
= NULL
; /* Termination. */
220 struct std_include_entry
{
221 const char *const name
;
222 const symbol_flags flags
;
223 const namelist names
;
226 const char NONE
[] = ""; /* The empty namelist. */
228 /* Special name to indicate a continuation line in std_include_table. */
229 const char CONTINUED
[] = "";
231 const struct std_include_entry
*include_entry
;
233 const struct std_include_entry std_include_table
[] = {
234 { "ctype.h", ANSI_SYMBOL
,
235 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
236 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
238 { "dirent.h", POSIX1_SYMBOL
, "closedir\0opendir\0readdir\0rewinddir\0"},
240 { "errno.h", ANSI_SYMBOL
|MACRO_SYMBOL
, "errno\0" },
242 /* ANSI_SYMBOL is wrong, but ... */
243 { "curses.h", ANSI_SYMBOL
, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
244 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
245 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
246 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
247 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
249 { "fcntl.h", POSIX1_SYMBOL
, "creat\0fcntl\0open\0" },
251 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
252 { "grp.h", POSIX1_SYMBOL
, "getgrgid\0getgrnam\0" },
254 /*{ "limit.h", ... provided by gcc }, */
256 { "locale.h", ANSI_SYMBOL
, "localeconv\0setlocale\0" },
258 { "math.h", ANSI_SYMBOL
,
259 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
260 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
263 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "HUGE_VAL\0" },
265 { "pwd.h", POSIX1_SYMBOL
, "getpwnam\0getpwuid\0" },
267 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
268 { "setjmp.h", ANSI_SYMBOL
, "longjmp\0setjmp\0" },
270 /* Left out signal() - its prototype is too complex for us!
271 Also left out "sigaction sigaddset sigdelset sigemptyset
272 sigfillset sigismember sigpending sigprocmask sigsuspend"
273 because these need sigset_t or struct sigaction.
274 Most systems that provide them will also declare them. */
275 { "signal.h", ANSI_SYMBOL
, "kill\0raise\0" },
277 { "stdio.h", ANSI_SYMBOL
,
278 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
279 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
280 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
281 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
282 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
284 { CONTINUED
, POSIX1_SYMBOL
, "fdopen\0fileno\0" },
285 { CONTINUED
, POSIX2_SYMBOL
, "pclose\0popen\0" }, /* I think ... */
286 /* Should perhaps also handle NULL, EOF, ... ? */
288 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
289 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
290 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
291 Should perhaps also add NULL */
292 { "stdlib.h", ANSI_SYMBOL
,
293 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
294 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
295 srand\0strtod\0strtol\0strtoul\0system\0" },
296 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
298 { "string.h", ANSI_SYMBOL
, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
299 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
300 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
301 strtok\0strxfrm\0" },
302 /* Should perhaps also add NULL and size_t */
304 { "strings.h", XOPEN_EXTENDED_SYMBOL
,
305 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
307 { "strops.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
309 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
310 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
311 and many systems do have <sys/ioctl.h> but not <strops.h>. */
312 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
314 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL
, "socket\0" },
316 { "sys/stat.h", POSIX1_SYMBOL
,
317 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
318 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
319 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
320 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
321 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
, "fchmod\0" },
324 /* How do we handle fd_set? */
325 { "sys/time.h", XOPEN_EXTENDED_SYMBOL
, "select\0" },
326 { "sys/select.h", XOPEN_EXTENDED_SYMBOL
/* fake */, "select\0" },
329 { "sys/times.h", POSIX1_SYMBOL
, "times\0" },
330 /* "sys/types.h" add types (not in old g++-include) */
332 { "sys/utsname.h", POSIX1_SYMBOL
, "uname\0" },
334 { "sys/wait.h", POSIX1_SYMBOL
, "wait\0waitpid\0" },
335 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
336 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
337 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
339 { "tar.h", POSIX1_SYMBOL
, NONE
},
341 { "termios.h", POSIX1_SYMBOL
,
342 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
344 { "time.h", ANSI_SYMBOL
,
345 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
347 { "unistd.h", POSIX1_SYMBOL
,
348 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
349 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
350 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
351 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
352 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
353 ttyname\0unlink\0write\0" },
354 { CONTINUED
, POSIX2_SYMBOL
, "getopt\0" },
355 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
,
356 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
358 { "utime.h", POSIX1_SYMBOL
, "utime\0" },
363 enum special_file special_file_handling
= no_special
;
365 /* They are set if the corresponding macro has been seen. */
366 /* The following are only used when handling sys/stat.h */
367 int seen_S_IFBLK
= 0, seen_S_ISBLK
= 0;
368 int seen_S_IFCHR
= 0, seen_S_ISCHR
= 0;
369 int seen_S_IFDIR
= 0, seen_S_ISDIR
= 0;
370 int seen_S_IFIFO
= 0, seen_S_ISFIFO
= 0;
371 int seen_S_IFLNK
= 0, seen_S_ISLNK
= 0;
372 int seen_S_IFREG
= 0, seen_S_ISREG
= 0;
373 /* The following are only used when handling errno.h */
375 /* The following are only used when handling stdlib.h */
376 int seen_EXIT_FAILURE
= 0, seen_EXIT_SUCCESS
= 0;
378 struct obstack scan_file_obstack
;
380 /* NOTE: If you edit this, also edit gen-protos.c !! */
382 static struct fn_decl
*
383 lookup_std_proto (name
, name_length
)
387 int i
= hashstr (name
, name_length
) % HASH_SIZE
;
392 if (hash_tab
[i
] == 0)
394 fn
= &std_protos
[hash_tab
[i
]];
395 if ((int) strlen (fn
->fname
) == name_length
396 && strncmp (fn
->fname
, name
, name_length
) == 0)
398 i
= (i
+1) % HASH_SIZE
;
405 int inc_filename_length
;
406 const char *progname
= "fix-header";
410 int lbrac_line
, rbrac_line
;
412 int required_unseen_count
= 0;
413 int required_other
= 0;
419 #if ADD_MISSING_EXTERN_C
420 if (missing_extern_C_count
+ required_unseen_count
> 0)
421 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
426 fprintf (outf
, "#ifndef _PARAMS\n");
427 fprintf (outf
, "#if defined(__STDC__) || defined(__cplusplus)\n");
428 fprintf (outf
, "#define _PARAMS(ARGS) ARGS\n");
429 fprintf (outf
, "#else\n");
430 fprintf (outf
, "#define _PARAMS(ARGS) ()\n");
431 fprintf (outf
, "#endif\n#endif /* _PARAMS */\n");
437 struct partial_proto
*next
;
442 struct partial_proto
*partial_proto_list
= NULL
;
444 struct partial_proto required_dummy_proto
, seen_dummy_proto
;
445 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
446 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
447 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
448 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
451 recognized_macro (fname
)
454 /* The original include file defines fname as a macro. */
455 struct fn_decl
*fn
= lookup_std_proto (fname
, strlen (fname
));
457 /* Since fname is a macro, don't require a prototype for it. */
461 required_unseen_count
--;
465 switch (special_file_handling
)
468 if (strcmp (fname
, "errno") == 0 && !seen_errno
)
469 seen_errno
= 1, required_other
--;
472 if (strcmp (fname
, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE
)
473 seen_EXIT_FAILURE
= 1, required_other
--;
474 if (strcmp (fname
, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS
)
475 seen_EXIT_SUCCESS
= 1, required_other
--;
478 if (fname
[0] == 'S' && fname
[1] == '_')
480 if (strcmp (fname
, "S_IFBLK") == 0) seen_S_IFBLK
++;
481 else if (strcmp (fname
, "S_ISBLK") == 0) seen_S_ISBLK
++;
482 else if (strcmp (fname
, "S_IFCHR") == 0) seen_S_IFCHR
++;
483 else if (strcmp (fname
, "S_ISCHR") == 0) seen_S_ISCHR
++;
484 else if (strcmp (fname
, "S_IFDIR") == 0) seen_S_IFDIR
++;
485 else if (strcmp (fname
, "S_ISDIR") == 0) seen_S_ISDIR
++;
486 else if (strcmp (fname
, "S_IFIFO") == 0) seen_S_IFIFO
++;
487 else if (strcmp (fname
, "S_ISFIFO") == 0) seen_S_ISFIFO
++;
488 else if (strcmp (fname
, "S_IFLNK") == 0) seen_S_IFLNK
++;
489 else if (strcmp (fname
, "S_ISLNK") == 0) seen_S_ISLNK
++;
490 else if (strcmp (fname
, "S_IFREG") == 0) seen_S_IFREG
++;
491 else if (strcmp (fname
, "S_ISREG") == 0) seen_S_ISREG
++;
501 recognized_extern (name
)
502 const cpp_token
*name
;
504 switch (special_file_handling
)
507 if (cpp_ideq (name
, "errno"))
508 seen_errno
= 1, required_other
--;
516 /* Called by scan_decls if it saw a function definition for a function
517 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
518 function declaration preceded by 'extern "C"' (or nested inside
519 'extern "C"' braces); or 'f' for other function declarations. */
522 recognized_function (fname
, line
, kind
, have_arg_list
)
523 const cpp_token
*fname
;
525 int kind
; /* One of 'f' 'F' or 'I' */
528 struct partial_proto
*partial
;
531 #if ADD_MISSING_EXTERN_C
533 missing_extern_C_count
++;
536 fn
= lookup_std_proto ((const char *) NODE_NAME (fname
->val
.node
),
537 NODE_LEN (fname
->val
.node
));
539 /* Remove the function from the list of required function. */
543 required_unseen_count
--;
547 /* If we have a full prototype, we're done. */
551 if (kind
== 'I') /* don't edit inline function */
554 /* If the partial prototype was included from some other file,
555 we don't need to patch it up (in this run). */
556 i
= strlen (cur_file
);
557 if (i
< inc_filename_length
558 || strcmp (inc_filename
, cur_file
+ (i
- inc_filename_length
)) != 0)
563 if (fn
->params
[0] == '\0')
566 /* We only have a partial function declaration,
567 so remember that we have to add a complete prototype. */
569 partial
= (struct partial_proto
*)
570 obstack_alloc (&scan_file_obstack
, sizeof (struct partial_proto
));
571 partial
->line_seen
= line
;
573 fn
->partial
= partial
;
574 partial
->next
= partial_proto_list
;
575 partial_proto_list
= partial
;
578 fprintf (stderr
, "(%s: %s non-prototype function declaration.)\n",
579 inc_filename
, fn
->fname
);
583 /* For any name in NAMES that is defined as a macro,
584 call recognized_macro on it. */
587 check_macro_names (pfile
, names
)
594 len
= strlen (names
);
595 if (cpp_defined (pfile
, (const unsigned char *)names
, len
))
596 recognized_macro (names
);
602 cb_file_change (pfile
, map
)
603 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
604 const struct line_map
*map
;
606 /* Just keep track of current file name. */
607 cur_file
= map
->to_file
;
611 read_scan_file (in_fname
, argc
, argv
)
618 cpp_options
*options
;
620 int i
, strings_processed
;
621 struct symbol_list
*cur_symbols
;
623 obstack_init (&scan_file_obstack
);
625 scan_in
= cpp_create_reader (CLK_GNUC89
, NULL
);
626 cb
= cpp_get_callbacks (scan_in
);
627 cb
->file_change
= cb_file_change
;
629 /* We are going to be scanning a header file out of its proper context,
630 so ignore warnings and errors. */
631 options
= cpp_get_options (scan_in
);
632 options
->inhibit_warnings
= 1;
633 options
->inhibit_errors
= 1;
635 if (! cpp_read_main_file (scan_in
, in_fname
))
636 exit (FATAL_EXIT_CODE
);
638 cpp_change_file (scan_in
, LC_RENAME
, "<built-in>");
639 cpp_init_builtins (scan_in
);
640 cpp_change_file (scan_in
, LC_RENAME
, in_fname
);
642 /* Process switches after builtins so -D can override them. */
643 for (i
= 0; i
< argc
; i
+= strings_processed
)
645 strings_processed
= 0;
646 if (argv
[i
][0] == '-')
648 if (argv
[i
][1] == 'I')
650 if (argv
[i
][2] != '\0')
652 strings_processed
= 1;
653 add_path (xstrdup (argv
[i
] + 2), BRACKET
, false);
655 else if (i
+ 1 != argc
)
657 strings_processed
= 2;
658 add_path (xstrdup (argv
[i
+ 1]), BRACKET
, false);
661 else if (argv
[i
][1] == 'D')
663 if (argv
[i
][2] != '\0')
664 strings_processed
= 1, cpp_define (scan_in
, argv
[i
] + 2);
665 else if (i
+ 1 != argc
)
666 strings_processed
= 2, cpp_define (scan_in
, argv
[i
+ 1]);
670 if (strings_processed
== 0)
675 cpp_error (scan_in
, DL_ERROR
, "invalid option `%s'", argv
[i
]);
676 if (cpp_errors (scan_in
))
677 exit (FATAL_EXIT_CODE
);
679 register_include_chains (scan_in
, NULL
/* sysroot */, NULL
/* iprefix */,
680 true /* stdinc */, false /* cxx_stdinc */,
681 false /* verbose */);
683 /* We are scanning a system header, so mark it as such. */
684 cpp_make_system_header (scan_in
, 1, 0);
686 scan_decls (scan_in
, argc
, argv
);
687 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
688 check_macro_names (scan_in
, cur_symbols
->names
);
690 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
691 If so, those functions are also required. */
692 if (special_file_handling
== stdio_h
693 && (fn
= lookup_std_proto ("_filbuf", 7)) != NULL
)
695 static const unsigned char getchar_call
[] = "getchar();";
698 /* Scan the macro expansion of "getchar();". */
699 cpp_push_buffer (scan_in
, getchar_call
, sizeof(getchar_call
) - 1,
700 /* from_stage3 */ true, 1);
703 const cpp_token
*t
= cpp_get_token (scan_in
);
705 if (t
->type
== CPP_EOF
)
707 else if (cpp_ideq (t
, "_filbuf"))
713 int need_filbuf
= !SEEN (fn
) && !REQUIRED (fn
);
714 struct fn_decl
*flsbuf_fn
= lookup_std_proto ("_flsbuf", 7);
716 = flsbuf_fn
&& !SEEN (flsbuf_fn
) && !REQUIRED (flsbuf_fn
);
718 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
719 if (need_filbuf
+ need_flsbuf
)
721 const char *new_list
;
725 SET_REQUIRED (flsbuf_fn
);
726 if (need_flsbuf
&& need_filbuf
)
727 new_list
= "_filbuf\0_flsbuf\0";
728 else if (need_flsbuf
)
729 new_list
= "_flsbuf\0";
730 else /* if (need_flsbuf) */
731 new_list
= "_filbuf\0";
732 add_symbols (ANSI_SYMBOL
, new_list
);
733 required_unseen_count
+= need_filbuf
+ need_flsbuf
;
738 if (required_unseen_count
+ partial_count
+ required_other
739 #if ADD_MISSING_EXTERN_C
740 + missing_extern_C_count
745 fprintf (stderr
, "%s: OK, nothing needs to be done.\n", inc_filename
);
746 exit (SUCCESS_EXIT_CODE
);
749 fprintf (stderr
, "%s: fixing %s\n", progname
, inc_filename
);
752 if (required_unseen_count
)
753 fprintf (stderr
, "%s: %d missing function declarations.\n",
754 inc_filename
, required_unseen_count
);
756 fprintf (stderr
, "%s: %d non-prototype function declarations.\n",
757 inc_filename
, partial_count
);
758 #if ADD_MISSING_EXTERN_C
759 if (missing_extern_C_count
)
761 "%s: %d declarations not protected by extern \"C\".\n",
762 inc_filename
, missing_extern_C_count
);
772 struct symbol_list
*cur_symbols
;
774 if (required_unseen_count
)
776 #ifdef NO_IMPLICIT_EXTERN_C
777 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
781 /* Now we print out prototypes for those functions that we haven't seen. */
782 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
784 int if_was_emitted
= 0;
786 cptr
= cur_symbols
->names
;
787 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
789 int macro_protect
= 0;
791 if (cur_symbols
->flags
& MACRO_SYMBOL
)
794 fn
= lookup_std_proto (cptr
, name_len
);
795 if (fn
== NULL
|| !REQUIRED (fn
))
800 /* what about curses. ??? or _flsbuf/_filbuf ??? */
801 if (cur_symbols
->flags
& ANSI_SYMBOL
)
803 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
804 else if (cur_symbols
->flags
& (POSIX1_SYMBOL
|POSIX2_SYMBOL
))
806 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
807 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
808 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
809 else if (cur_symbols
->flags
& XOPEN_SYMBOL
)
812 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
813 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
815 else if (cur_symbols
->flags
& XOPEN_EXTENDED_SYMBOL
)
818 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
819 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
823 fatal ("internal error for function %s", fn
->fname
);
828 /* In the case of memmove, protect in case the application
829 defines it as a macro before including the header. */
830 if (!strcmp (fn
->fname
, "memmove")
831 || !strcmp (fn
->fname
, "putc")
832 || !strcmp (fn
->fname
, "getc")
833 || !strcmp (fn
->fname
, "vprintf")
834 || !strcmp (fn
->fname
, "vfprintf")
835 || !strcmp (fn
->fname
, "vsprintf")
836 || !strcmp (fn
->fname
, "rewinddir")
837 || !strcmp (fn
->fname
, "abort"))
841 fprintf (outf
, "#ifndef %s\n", fn
->fname
);
842 fprintf (outf
, "extern %s %s (%s);\n",
843 fn
->rtype
, fn
->fname
, fn
->params
);
845 fprintf (outf
, "#endif\n");
849 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
851 if (required_unseen_count
)
853 #ifdef NO_IMPLICIT_EXTERN_C
854 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
858 switch (special_file_handling
)
862 fprintf (outf
, "extern int errno;\n");
865 if (!seen_EXIT_FAILURE
)
866 fprintf (outf
, "#define EXIT_FAILURE 1\n");
867 if (!seen_EXIT_SUCCESS
)
868 fprintf (outf
, "#define EXIT_SUCCESS 0\n");
871 if (!seen_S_ISBLK
&& seen_S_IFBLK
)
873 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
874 if (!seen_S_ISCHR
&& seen_S_IFCHR
)
876 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
877 if (!seen_S_ISDIR
&& seen_S_IFDIR
)
879 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
880 if (!seen_S_ISFIFO
&& seen_S_IFIFO
)
882 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
883 if (!seen_S_ISLNK
&& seen_S_IFLNK
)
885 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
886 if (!seen_S_ISREG
&& seen_S_IFREG
)
888 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
896 #if ADD_MISSING_EXTERN_C
897 if (missing_extern_C_count
+ required_unseen_count
> 0)
898 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
902 /* Returns 1 iff the file is properly protected from multiple inclusion:
909 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
910 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
918 if (c
== ' ' || c
== '\t')
925 (void) INF_UNGET (c
);
936 source_lineno
++, lineno
++;
939 else if ((c
= INF_GET ()) == '/')
949 /* Read into STR from inf_buffer upto DELIM. */
952 inf_read_upto (str
, delim
)
960 if (ch
== EOF
|| ch
== delim
)
962 SSTRING_PUT (str
, ch
);
964 MAKE_SSTRING_SPACE (str
, 1);
970 inf_scan_ident (s
, c
)
981 if (c
== EOF
|| !(ISIDNUM (c
)))
985 MAKE_SSTRING_SPACE (s
, 1);
990 /* Returns 1 if the file is correctly protected against multiple
991 inclusion, setting *ifndef_line to the line number of the initial #ifndef
992 and setting *endif_line to the final #endif.
993 Otherwise return 0. */
996 check_protection (ifndef_line
, endif_line
)
997 int *ifndef_line
, *endif_line
;
1000 int if_nesting
= 1; /* Level of nesting of #if's */
1001 char *protect_name
= NULL
; /* Identifier following initial #ifndef */
1002 int define_seen
= 0;
1004 /* Skip initial white space (including comments). */
1007 c
= inf_skip_spaces (' ');
1015 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
1016 if (SSTRING_LENGTH (&buf
) == 0 || strcmp (buf
.base
, "ifndef") != 0)
1019 /* So far so good: We've seen an initial #ifndef. */
1020 *ifndef_line
= lineno
;
1021 c
= inf_scan_ident (&buf
, inf_skip_spaces (c
));
1022 if (SSTRING_LENGTH (&buf
) == 0 || c
== EOF
)
1024 protect_name
= xstrdup (buf
.base
);
1026 (void) INF_UNGET (c
);
1027 c
= inf_read_upto (&buf
, '\n');
1034 c
= inf_skip_spaces (' ');
1044 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
1045 if (SSTRING_LENGTH (&buf
) == 0)
1047 else if (!strcmp (buf
.base
, "ifndef")
1048 || !strcmp (buf
.base
, "ifdef") || !strcmp (buf
.base
, "if"))
1052 else if (!strcmp (buf
.base
, "endif"))
1055 if (if_nesting
== 0)
1058 else if (!strcmp (buf
.base
, "else"))
1060 if (if_nesting
== 1)
1063 else if (!strcmp (buf
.base
, "define"))
1065 c
= inf_skip_spaces (c
);
1066 c
= inf_scan_ident (&buf
, c
);
1067 if (buf
.base
[0] > 0 && strcmp (buf
.base
, protect_name
) == 0)
1073 if (c
== '\n' || c
== EOF
)
1084 *endif_line
= lineno
;
1085 /* Skip final white space (including comments). */
1088 c
= inf_skip_spaces (' ');
1098 extern int main
PARAMS ((int, char **));
1108 #ifdef FIXPROTO_IGNORE_LIST
1116 struct symbol_list
*cur_symbols
;
1118 if (argv
[0] && argv
[0][0])
1123 for (p
= argv
[0]; *p
; p
++)
1126 progname
= progname
? progname
+1 : argv
[0];
1131 fprintf (stderr
, "%s: Usage: foo.h infile.h outfile.h options\n",
1133 exit (FATAL_EXIT_CODE
);
1136 inc_filename
= argv
[1];
1137 inc_filename_length
= strlen (inc_filename
);
1139 #ifdef FIXPROTO_IGNORE_LIST
1140 for (i
= 0; files_to_ignore
[i
] != NULL
; i
++)
1142 const char *const ignore_name
= files_to_ignore
[i
];
1143 int ignore_len
= strlen (ignore_name
);
1144 if (strncmp (inc_filename
, ignore_name
, ignore_len
) == 0)
1146 if (ignore_name
[ignore_len
-1] == '/'
1147 || inc_filename
[ignore_len
] == '\0')
1150 fprintf (stderr
, "%s: ignoring %s\n", progname
, inc_filename
);
1151 exit (SUCCESS_EXIT_CODE
);
1158 if (strcmp (inc_filename
, "sys/stat.h") == 0)
1159 special_file_handling
= sys_stat_h
;
1160 else if (strcmp (inc_filename
, "errno.h") == 0)
1161 special_file_handling
= errno_h
, required_other
++;
1162 else if (strcmp (inc_filename
, "stdlib.h") == 0)
1163 special_file_handling
= stdlib_h
, required_other
+=2;
1164 else if (strcmp (inc_filename
, "stdio.h") == 0)
1165 special_file_handling
= stdio_h
;
1166 include_entry
= std_include_table
;
1167 while (include_entry
->name
!= NULL
1168 && ((strcmp (include_entry
->name
, CONTINUED
) == 0)
1169 || strcmp (inc_filename
, include_entry
->name
) != 0))
1172 if (include_entry
->name
!= NULL
)
1174 const struct std_include_entry
*entry
;
1175 cur_symbol_table_size
= 0;
1176 for (entry
= include_entry
; ;)
1179 add_symbols (entry
->flags
, entry
->names
);
1181 if (!entry
->name
|| strcmp (entry
->name
, CONTINUED
) != 0)
1186 symbol_table
[0].names
= NULL
;
1188 /* Count and mark the prototypes required for this include file. */
1189 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
1192 if (cur_symbols
->flags
& MACRO_SYMBOL
)
1194 cptr
= cur_symbols
->names
;
1195 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
1197 struct fn_decl
*fn
= lookup_std_proto (cptr
, name_len
);
1198 required_unseen_count
++;
1200 fprintf (stderr
, "Internal error: No prototype for %s\n", cptr
);
1206 read_scan_file (argv
[2], argc
- 4, argv
+ 4);
1208 inf_fd
= open (argv
[2], O_RDONLY
, 0666);
1211 fprintf (stderr
, "%s: Cannot open '%s' for reading -",
1214 exit (FATAL_EXIT_CODE
);
1216 if (fstat (inf_fd
, &sbuf
) < 0)
1218 fprintf (stderr
, "%s: Cannot get size of '%s' -", progname
, argv
[2]);
1220 exit (FATAL_EXIT_CODE
);
1222 inf_size
= sbuf
.st_size
;
1223 inf_buffer
= (char *) xmalloc (inf_size
+ 2);
1224 inf_ptr
= inf_buffer
;
1229 long i
= read (inf_fd
, inf_buffer
+ inf_size
- to_read
, to_read
);
1232 fprintf (stderr
, "%s: Failed to read '%s' -", progname
, argv
[2]);
1234 exit (FATAL_EXIT_CODE
);
1238 inf_size
-= to_read
;
1246 /* Inf_size may have changed if read was short (as on VMS) */
1247 inf_buffer
[inf_size
] = '\n';
1248 inf_buffer
[inf_size
+ 1] = '\0';
1249 inf_limit
= inf_buffer
+ inf_size
;
1251 /* If file doesn't end with '\n', add one. */
1252 if (inf_limit
> inf_buffer
&& inf_limit
[-1] != '\n')
1256 outf
= fopen (argv
[3], "w");
1259 fprintf (stderr
, "%s: Cannot open '%s' for writing -",
1262 exit (FATAL_EXIT_CODE
);
1267 if (check_protection (&ifndef_line
, &endif_line
))
1269 lbrac_line
= ifndef_line
+1;
1270 rbrac_line
= endif_line
;
1278 /* Reset input file. */
1279 inf_ptr
= inf_buffer
;
1284 if (lineno
== lbrac_line
)
1286 if (lineno
== rbrac_line
)
1296 c
= inf_scan_ident (&buf
, c
);
1297 (void) INF_UNGET (c
);
1298 fputs (buf
.base
, outf
);
1299 fn
= lookup_std_proto (buf
.base
, strlen (buf
.base
));
1300 /* We only want to edit the declaration matching the one
1301 seen by scan-decls, as there can be multiple
1302 declarations, selected by #ifdef __STDC__ or whatever. */
1303 if (fn
&& fn
->partial
&& fn
->partial
->line_seen
== lineno
)
1305 c
= inf_skip_spaces (' ');
1310 c
= inf_skip_spaces (' ');
1313 fprintf (outf
, " _PARAMS((%s))", fn
->params
);
1318 (void) INF_UNGET (c
);
1322 fprintf (outf
, " %c", c
);
1350 fprintf (stderr
, "%s: %s: ", progname
, inc_filename
);
1351 vfprintf (stderr
, str
, ap
);
1352 fprintf (stderr
, "\n");
1354 exit (FATAL_EXIT_CODE
);
1358 fatal
VPARAMS ((const char *str
, ...))
1361 VA_FIXEDARG (ap
, const char *, str
);