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, 2004 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"
84 #ifdef TARGET_EXTRA_INCLUDES
85 static void hook_void_int(int u ATTRIBUTE_UNUSED
) { }
87 struct target_c_incpath_s target_c_incpath
= { hook_void_int
};
90 struct line_maps line_table
;
95 int partial_count
= 0;
98 #if ADD_MISSING_EXTERN_C
99 int missing_extern_C_count
= 0;
102 #include "xsys-protos.h"
104 #ifdef FIXPROTO_IGNORE_LIST
105 /* This is a currently unused feature. */
107 /* List of files and directories to ignore.
108 A directory name (ending in '/') means ignore anything in that
109 directory. (It might be more efficient to do directory pruning
110 earlier in fixproto, but this is simpler and easier to customize.) */
112 static const char *const files_to_ignore
[] = {
122 static const char *cur_file
;
124 /* Certain standard files get extra treatment */
147 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
148 by an empty name (i.e. by "\0\0"). */
150 typedef const char *namelist
;
152 /* The following macros provide the bits for symbol_flags. */
153 typedef int symbol_flags
;
155 /* Used to mark names defined in the ANSI/ISO C standard. */
156 #define ANSI_SYMBOL 1
158 /* We no longer massage include files for POSIX or XOPEN symbols,
159 as there are now several versions of the POSIX and XOPEN standards,
160 and it would be a maintenance nightmare for us to track them all.
161 Better to be compatible with the system include files. */
162 /*#define ADD_MISSING_POSIX 1 */
163 /*#define ADD_MISSING_XOPEN 1 */
165 #if ADD_MISSING_POSIX
166 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
167 #define POSIX1_SYMBOL 2
168 #define POSIX2_SYMBOL 4
170 #define POSIX1_SYMBOL 0
171 #define POSIX2_SYMBOL 0
174 #if ADD_MISSING_XOPEN
175 /* Used to mark names defined in X/Open Portability Guide. */
176 #define XOPEN_SYMBOL 8
177 /* Used to mark names defined in X/Open UNIX Extensions. */
178 #define XOPEN_EXTENDED_SYMBOL 16
180 #define XOPEN_SYMBOL 0
181 #define XOPEN_EXTENDED_SYMBOL 0
184 /* Used to indicate names that are not functions */
185 #define MACRO_SYMBOL 512
192 #define SYMBOL_TABLE_SIZE 10
193 struct symbol_list symbol_table
[SYMBOL_TABLE_SIZE
];
194 int cur_symbol_table_size
;
196 static void add_symbols (symbol_flags
, namelist
);
197 static struct fn_decl
*lookup_std_proto (const char *, int);
198 static void write_lbrac (void);
199 static void recognized_macro (const char *);
200 static void check_macro_names (cpp_reader
*, namelist
);
201 static void read_scan_file (char *, int, char **);
202 static void write_rbrac (void);
203 static int inf_skip_spaces (int);
204 static int inf_read_upto (sstring
*, int);
205 static int inf_scan_ident (sstring
*, int);
206 static int check_protection (int *, int *);
207 static void cb_file_change (cpp_reader
*, const struct line_map
*);
210 add_symbols (symbol_flags flags
, namelist 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
, "raise\0" },
276 { CONTINUED
, POSIX1_SYMBOL
, "kill\0" },
278 { "stdio.h", ANSI_SYMBOL
,
279 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
280 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
281 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
282 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
283 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
285 { CONTINUED
, POSIX1_SYMBOL
, "fdopen\0fileno\0" },
286 { CONTINUED
, POSIX2_SYMBOL
, "pclose\0popen\0" }, /* I think ... */
287 /* Should perhaps also handle NULL, EOF, ... ? */
289 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
290 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
291 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
292 Should perhaps also add NULL */
293 { "stdlib.h", ANSI_SYMBOL
,
294 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
295 exit\0free\0getenv\0labs\0malloc\0qsort\0rand\0realloc\0\
296 srand\0strtod\0strtol\0strtoul\0system\0" },
297 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
298 { CONTINUED
, POSIX1_SYMBOL
, "putenv\0" },
300 { "string.h", ANSI_SYMBOL
, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
301 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
302 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
303 strtok\0strxfrm\0" },
304 /* Should perhaps also add NULL and size_t */
306 { "strings.h", XOPEN_EXTENDED_SYMBOL
,
307 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
309 { "strops.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
311 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
312 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
313 and many systems do have <sys/ioctl.h> but not <strops.h>. */
314 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
316 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL
, "socket\0" },
318 { "sys/stat.h", POSIX1_SYMBOL
,
319 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
320 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
321 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
322 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
323 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
, "fchmod\0" },
326 /* How do we handle fd_set? */
327 { "sys/time.h", XOPEN_EXTENDED_SYMBOL
, "select\0" },
328 { "sys/select.h", XOPEN_EXTENDED_SYMBOL
/* fake */, "select\0" },
331 { "sys/times.h", POSIX1_SYMBOL
, "times\0" },
332 /* "sys/types.h" add types (not in old g++-include) */
334 { "sys/utsname.h", POSIX1_SYMBOL
, "uname\0" },
336 { "sys/wait.h", POSIX1_SYMBOL
, "wait\0waitpid\0" },
337 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
338 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
339 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
341 { "tar.h", POSIX1_SYMBOL
, NONE
},
343 { "termios.h", POSIX1_SYMBOL
,
344 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
346 { "time.h", ANSI_SYMBOL
,
347 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0" },
348 { CONTINUED
, POSIX1_SYMBOL
, "tzset\0" },
350 { "unistd.h", POSIX1_SYMBOL
,
351 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
352 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
353 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
354 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
355 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
356 ttyname\0unlink\0write\0" },
357 { CONTINUED
, POSIX2_SYMBOL
, "getopt\0" },
358 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
,
359 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
361 { "utime.h", POSIX1_SYMBOL
, "utime\0" },
366 enum special_file special_file_handling
= no_special
;
368 /* They are set if the corresponding macro has been seen. */
369 /* The following are only used when handling sys/stat.h */
370 int seen_S_IFBLK
= 0, seen_S_ISBLK
= 0;
371 int seen_S_IFCHR
= 0, seen_S_ISCHR
= 0;
372 int seen_S_IFDIR
= 0, seen_S_ISDIR
= 0;
373 int seen_S_IFIFO
= 0, seen_S_ISFIFO
= 0;
374 int seen_S_IFLNK
= 0, seen_S_ISLNK
= 0;
375 int seen_S_IFREG
= 0, seen_S_ISREG
= 0;
376 /* The following are only used when handling errno.h */
378 /* The following are only used when handling stdlib.h */
379 int seen_EXIT_FAILURE
= 0, seen_EXIT_SUCCESS
= 0;
381 struct obstack scan_file_obstack
;
383 /* NOTE: If you edit this, also edit gen-protos.c !! */
385 static struct fn_decl
*
386 lookup_std_proto (const char *name
, int name_length
)
388 int i
= hashstr (name
, name_length
) % HASH_SIZE
;
393 if (hash_tab
[i
] == 0)
395 fn
= &std_protos
[hash_tab
[i
]];
396 if ((int) strlen (fn
->fname
) == name_length
397 && strncmp (fn
->fname
, name
, name_length
) == 0)
399 i
= (i
+1) % HASH_SIZE
;
406 int inc_filename_length
;
410 int lbrac_line
, rbrac_line
;
412 int required_unseen_count
= 0;
413 int required_other
= 0;
420 fprintf (outf
, "#ifndef _PARAMS\n");
421 fprintf (outf
, "#if defined(__STDC__) || defined(__cplusplus)\n");
422 fprintf (outf
, "#define _PARAMS(ARGS) ARGS\n");
423 fprintf (outf
, "#else\n");
424 fprintf (outf
, "#define _PARAMS(ARGS) ()\n");
425 fprintf (outf
, "#endif\n#endif /* _PARAMS */\n");
431 struct partial_proto
*next
;
436 struct partial_proto
*partial_proto_list
= NULL
;
438 struct partial_proto required_dummy_proto
, seen_dummy_proto
;
439 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
440 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
441 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
442 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
445 recognized_macro (const char *fname
)
447 /* The original include file defines fname as a macro. */
448 struct fn_decl
*fn
= lookup_std_proto (fname
, strlen (fname
));
450 /* Since fname is a macro, don't require a prototype for it. */
454 required_unseen_count
--;
458 switch (special_file_handling
)
461 if (strcmp (fname
, "errno") == 0 && !seen_errno
)
462 seen_errno
= 1, required_other
--;
465 if (strcmp (fname
, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE
)
466 seen_EXIT_FAILURE
= 1, required_other
--;
467 if (strcmp (fname
, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS
)
468 seen_EXIT_SUCCESS
= 1, required_other
--;
471 if (fname
[0] == 'S' && fname
[1] == '_')
473 if (strcmp (fname
, "S_IFBLK") == 0) seen_S_IFBLK
++;
474 else if (strcmp (fname
, "S_ISBLK") == 0) seen_S_ISBLK
++;
475 else if (strcmp (fname
, "S_IFCHR") == 0) seen_S_IFCHR
++;
476 else if (strcmp (fname
, "S_ISCHR") == 0) seen_S_ISCHR
++;
477 else if (strcmp (fname
, "S_IFDIR") == 0) seen_S_IFDIR
++;
478 else if (strcmp (fname
, "S_ISDIR") == 0) seen_S_ISDIR
++;
479 else if (strcmp (fname
, "S_IFIFO") == 0) seen_S_IFIFO
++;
480 else if (strcmp (fname
, "S_ISFIFO") == 0) seen_S_ISFIFO
++;
481 else if (strcmp (fname
, "S_IFLNK") == 0) seen_S_IFLNK
++;
482 else if (strcmp (fname
, "S_ISLNK") == 0) seen_S_ISLNK
++;
483 else if (strcmp (fname
, "S_IFREG") == 0) seen_S_IFREG
++;
484 else if (strcmp (fname
, "S_ISREG") == 0) seen_S_ISREG
++;
494 recognized_extern (const cpp_token
*name
)
496 switch (special_file_handling
)
499 if (cpp_ideq (name
, "errno"))
500 seen_errno
= 1, required_other
--;
508 /* Called by scan_decls if it saw a function definition for a function
509 named FNAME. KIND is 'I' for an inline function; 'F' if a normal
510 function declaration preceded by 'extern "C"' (or nested inside
511 'extern "C"' braces); or 'f' for other function declarations. */
514 recognized_function (const cpp_token
*fname
, unsigned int line
, int kind
,
517 struct partial_proto
*partial
;
521 fn
= lookup_std_proto ((const char *) NODE_NAME (fname
->val
.node
),
522 NODE_LEN (fname
->val
.node
));
524 /* Remove the function from the list of required function. */
528 required_unseen_count
--;
532 /* If we have a full prototype, we're done. */
536 if (kind
== 'I') /* don't edit inline function */
539 /* If the partial prototype was included from some other file,
540 we don't need to patch it up (in this run). */
541 i
= strlen (cur_file
);
542 if (i
< inc_filename_length
543 || strcmp (inc_filename
, cur_file
+ (i
- inc_filename_length
)) != 0)
548 if (fn
->params
[0] == '\0')
551 /* We only have a partial function declaration,
552 so remember that we have to add a complete prototype. */
554 partial
= obstack_alloc (&scan_file_obstack
, sizeof (struct partial_proto
));
555 partial
->line_seen
= line
;
557 fn
->partial
= partial
;
558 partial
->next
= partial_proto_list
;
559 partial_proto_list
= partial
;
562 fprintf (stderr
, "(%s: %s non-prototype function declaration.)\n",
563 inc_filename
, fn
->fname
);
567 /* For any name in NAMES that is defined as a macro,
568 call recognized_macro on it. */
571 check_macro_names (cpp_reader
*pfile
, namelist names
)
576 len
= strlen (names
);
577 if (cpp_defined (pfile
, (const unsigned char *)names
, len
))
578 recognized_macro (names
);
584 cb_file_change (cpp_reader
*pfile ATTRIBUTE_UNUSED
,
585 const struct line_map
*map
)
587 /* Just keep track of current file name. */
588 cur_file
= map
== NULL
? NULL
: map
->to_file
;
592 read_scan_file (char *in_fname
, int argc
, char **argv
)
596 cpp_options
*options
;
598 int i
, strings_processed
;
599 struct symbol_list
*cur_symbols
;
601 obstack_init (&scan_file_obstack
);
603 linemap_init (&line_table
);
604 scan_in
= cpp_create_reader (CLK_GNUC89
, NULL
, &line_table
);
605 cb
= cpp_get_callbacks (scan_in
);
606 cb
->file_change
= cb_file_change
;
608 /* We are going to be scanning a header file out of its proper context,
609 so ignore warnings and errors. */
610 options
= cpp_get_options (scan_in
);
611 options
->inhibit_warnings
= 1;
612 options
->inhibit_errors
= 1;
613 cpp_post_options (scan_in
);
615 if (!cpp_read_main_file (scan_in
, in_fname
))
616 exit (FATAL_EXIT_CODE
);
618 cpp_change_file (scan_in
, LC_RENAME
, "<built-in>");
619 cpp_init_builtins (scan_in
, true);
620 cpp_change_file (scan_in
, LC_RENAME
, in_fname
);
622 /* Process switches after builtins so -D can override them. */
623 for (i
= 0; i
< argc
; i
+= strings_processed
)
625 strings_processed
= 0;
626 if (argv
[i
][0] == '-')
628 if (argv
[i
][1] == 'I')
630 if (argv
[i
][2] != '\0')
632 strings_processed
= 1;
633 add_path (xstrdup (argv
[i
] + 2), BRACKET
, false, false);
635 else if (i
+ 1 != argc
)
637 strings_processed
= 2;
638 add_path (xstrdup (argv
[i
+ 1]), BRACKET
, false, false);
641 else if (argv
[i
][1] == 'D')
643 if (argv
[i
][2] != '\0')
644 strings_processed
= 1, cpp_define (scan_in
, argv
[i
] + 2);
645 else if (i
+ 1 != argc
)
646 strings_processed
= 2, cpp_define (scan_in
, argv
[i
+ 1]);
650 if (strings_processed
== 0)
655 cpp_error (scan_in
, CPP_DL_ERROR
, "invalid option `%s'", argv
[i
]);
656 if (cpp_errors (scan_in
))
657 exit (FATAL_EXIT_CODE
);
659 register_include_chains (scan_in
, NULL
/* sysroot */, NULL
/* iprefix */,
660 true /* stdinc */, false /* cxx_stdinc */,
661 false /* verbose */);
663 /* We are scanning a system header, so mark it as such. */
664 cpp_make_system_header (scan_in
, 1, 0);
666 scan_decls (scan_in
, argc
, argv
);
667 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
668 check_macro_names (scan_in
, cur_symbols
->names
);
670 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
671 If so, those functions are also required. */
672 if (special_file_handling
== stdio_h
673 && (fn
= lookup_std_proto ("_filbuf", 7)) != NULL
)
675 unsigned char getchar_call
[] = "getchar();\n";
678 /* Scan the macro expansion of "getchar();". */
679 cpp_push_buffer (scan_in
, getchar_call
, sizeof(getchar_call
) - 1,
680 /* from_stage3 */ true);
683 const cpp_token
*t
= cpp_get_token (scan_in
);
685 if (t
->type
== CPP_EOF
)
687 else if (cpp_ideq (t
, "_filbuf"))
693 int need_filbuf
= !SEEN (fn
) && !REQUIRED (fn
);
694 struct fn_decl
*flsbuf_fn
= lookup_std_proto ("_flsbuf", 7);
696 = flsbuf_fn
&& !SEEN (flsbuf_fn
) && !REQUIRED (flsbuf_fn
);
698 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
699 if (need_filbuf
+ need_flsbuf
)
701 const char *new_list
;
705 SET_REQUIRED (flsbuf_fn
);
706 if (need_flsbuf
&& need_filbuf
)
707 new_list
= "_filbuf\0_flsbuf\0";
708 else if (need_flsbuf
)
709 new_list
= "_flsbuf\0";
710 else /* if (need_flsbuf) */
711 new_list
= "_filbuf\0";
712 add_symbols (ANSI_SYMBOL
, new_list
);
713 required_unseen_count
+= need_filbuf
+ need_flsbuf
;
718 if (required_unseen_count
+ partial_count
+ required_other
== 0)
721 fprintf (stderr
, "%s: OK, nothing needs to be done.\n", inc_filename
);
722 exit (SUCCESS_EXIT_CODE
);
725 fprintf (stderr
, "%s: fixing %s\n", progname
, inc_filename
);
728 if (required_unseen_count
)
729 fprintf (stderr
, "%s: %d missing function declarations.\n",
730 inc_filename
, required_unseen_count
);
732 fprintf (stderr
, "%s: %d non-prototype function declarations.\n",
733 inc_filename
, partial_count
);
742 struct symbol_list
*cur_symbols
;
744 if (required_unseen_count
)
746 #ifdef NO_IMPLICIT_EXTERN_C
747 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
751 /* Now we print out prototypes for those functions that we haven't seen. */
752 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
754 int if_was_emitted
= 0;
756 cptr
= cur_symbols
->names
;
757 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
759 int macro_protect
= 0;
761 if (cur_symbols
->flags
& MACRO_SYMBOL
)
764 fn
= lookup_std_proto (cptr
, name_len
);
765 if (fn
== NULL
|| !REQUIRED (fn
))
770 /* what about curses. ??? or _flsbuf/_filbuf ??? */
771 if (cur_symbols
->flags
& ANSI_SYMBOL
)
773 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
774 else if (cur_symbols
->flags
& (POSIX1_SYMBOL
|POSIX2_SYMBOL
))
776 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
777 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
778 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
779 else if (cur_symbols
->flags
& XOPEN_SYMBOL
)
782 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
783 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
785 else if (cur_symbols
->flags
& XOPEN_EXTENDED_SYMBOL
)
788 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
789 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
793 fatal ("internal error for function %s", fn
->fname
);
798 /* In the case of memmove, protect in case the application
799 defines it as a macro before including the header. */
800 if (!strcmp (fn
->fname
, "memmove")
801 || !strcmp (fn
->fname
, "putc")
802 || !strcmp (fn
->fname
, "getc")
803 || !strcmp (fn
->fname
, "vprintf")
804 || !strcmp (fn
->fname
, "vfprintf")
805 || !strcmp (fn
->fname
, "vsprintf")
806 || !strcmp (fn
->fname
, "rewinddir")
807 || !strcmp (fn
->fname
, "abort"))
811 fprintf (outf
, "#ifndef %s\n", fn
->fname
);
812 fprintf (outf
, "extern %s %s (%s);\n",
813 fn
->rtype
, fn
->fname
, fn
->params
);
815 fprintf (outf
, "#endif\n");
819 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
821 if (required_unseen_count
)
823 #ifdef NO_IMPLICIT_EXTERN_C
824 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
828 switch (special_file_handling
)
832 fprintf (outf
, "extern int errno;\n");
835 if (!seen_EXIT_FAILURE
)
836 fprintf (outf
, "#define EXIT_FAILURE 1\n");
837 if (!seen_EXIT_SUCCESS
)
838 fprintf (outf
, "#define EXIT_SUCCESS 0\n");
841 if (!seen_S_ISBLK
&& seen_S_IFBLK
)
843 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
844 if (!seen_S_ISCHR
&& seen_S_IFCHR
)
846 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
847 if (!seen_S_ISDIR
&& seen_S_IFDIR
)
849 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
850 if (!seen_S_ISFIFO
&& seen_S_IFIFO
)
852 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
853 if (!seen_S_ISLNK
&& seen_S_IFLNK
)
855 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
856 if (!seen_S_ISREG
&& seen_S_IFREG
)
858 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
867 /* Returns 1 iff the file is properly protected from multiple inclusion:
874 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
875 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
878 inf_skip_spaces (int c
)
882 if (c
== ' ' || c
== '\t')
889 (void) INF_UNGET (c
);
900 source_lineno
++, lineno
++;
903 else if ((c
= INF_GET ()) == '/')
913 /* Read into STR from inf_buffer upto DELIM. */
916 inf_read_upto (sstring
*str
, int delim
)
922 if (ch
== EOF
|| ch
== delim
)
924 SSTRING_PUT (str
, ch
);
926 MAKE_SSTRING_SPACE (str
, 1);
932 inf_scan_ident (sstring
*s
, int c
)
941 if (c
== EOF
|| !(ISIDNUM (c
)))
945 MAKE_SSTRING_SPACE (s
, 1);
950 /* Returns 1 if the file is correctly protected against multiple
951 inclusion, setting *ifndef_line to the line number of the initial #ifndef
952 and setting *endif_line to the final #endif.
953 Otherwise return 0. */
956 check_protection (int *ifndef_line
, int *endif_line
)
959 int if_nesting
= 1; /* Level of nesting of #if's */
960 char *protect_name
= NULL
; /* Identifier following initial #ifndef */
963 /* Skip initial white space (including comments). */
966 c
= inf_skip_spaces (' ');
974 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
975 if (SSTRING_LENGTH (&buf
) == 0 || strcmp (buf
.base
, "ifndef") != 0)
978 /* So far so good: We've seen an initial #ifndef. */
979 *ifndef_line
= lineno
;
980 c
= inf_scan_ident (&buf
, inf_skip_spaces (c
));
981 if (SSTRING_LENGTH (&buf
) == 0 || c
== EOF
)
983 protect_name
= xstrdup (buf
.base
);
985 (void) INF_UNGET (c
);
986 c
= inf_read_upto (&buf
, '\n');
993 c
= inf_skip_spaces (' ');
1003 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
1004 if (SSTRING_LENGTH (&buf
) == 0)
1006 else if (!strcmp (buf
.base
, "ifndef")
1007 || !strcmp (buf
.base
, "ifdef") || !strcmp (buf
.base
, "if"))
1011 else if (!strcmp (buf
.base
, "endif"))
1014 if (if_nesting
== 0)
1017 else if (!strcmp (buf
.base
, "else"))
1019 if (if_nesting
== 1)
1022 else if (!strcmp (buf
.base
, "define"))
1024 c
= inf_skip_spaces (c
);
1025 c
= inf_scan_ident (&buf
, c
);
1026 if (buf
.base
[0] > 0 && strcmp (buf
.base
, protect_name
) == 0)
1032 if (c
== '\n' || c
== EOF
)
1043 *endif_line
= lineno
;
1044 /* Skip final white space (including comments). */
1047 c
= inf_skip_spaces (' ');
1057 extern int main (int, char **);
1060 main (int argc
, char **argv
)
1065 #ifdef FIXPROTO_IGNORE_LIST
1073 struct symbol_list
*cur_symbols
;
1075 progname
= "fix-header";
1076 if (argv
[0] && argv
[0][0])
1081 for (p
= argv
[0]; *p
; p
++)
1084 progname
= progname
? progname
+1 : argv
[0];
1089 fprintf (stderr
, "%s: Usage: foo.h infile.h outfile.h options\n",
1091 exit (FATAL_EXIT_CODE
);
1094 inc_filename
= argv
[1];
1095 inc_filename_length
= strlen (inc_filename
);
1097 #ifdef FIXPROTO_IGNORE_LIST
1098 for (i
= 0; files_to_ignore
[i
] != NULL
; i
++)
1100 const char *const ignore_name
= files_to_ignore
[i
];
1101 int ignore_len
= strlen (ignore_name
);
1102 if (strncmp (inc_filename
, ignore_name
, ignore_len
) == 0)
1104 if (ignore_name
[ignore_len
-1] == '/'
1105 || inc_filename
[ignore_len
] == '\0')
1108 fprintf (stderr
, "%s: ignoring %s\n", progname
, inc_filename
);
1109 exit (SUCCESS_EXIT_CODE
);
1116 if (strcmp (inc_filename
, "sys/stat.h") == 0)
1117 special_file_handling
= sys_stat_h
;
1118 else if (strcmp (inc_filename
, "errno.h") == 0)
1119 special_file_handling
= errno_h
, required_other
++;
1120 else if (strcmp (inc_filename
, "stdlib.h") == 0)
1121 special_file_handling
= stdlib_h
, required_other
+=2;
1122 else if (strcmp (inc_filename
, "stdio.h") == 0)
1123 special_file_handling
= stdio_h
;
1124 include_entry
= std_include_table
;
1125 while (include_entry
->name
!= NULL
1126 && ((strcmp (include_entry
->name
, CONTINUED
) == 0)
1127 || strcmp (inc_filename
, include_entry
->name
) != 0))
1130 if (include_entry
->name
!= NULL
)
1132 const struct std_include_entry
*entry
;
1133 cur_symbol_table_size
= 0;
1134 for (entry
= include_entry
; ;)
1137 add_symbols (entry
->flags
, entry
->names
);
1139 if (!entry
->name
|| strcmp (entry
->name
, CONTINUED
) != 0)
1144 symbol_table
[0].names
= NULL
;
1146 /* Count and mark the prototypes required for this include file. */
1147 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
1150 if (cur_symbols
->flags
& MACRO_SYMBOL
)
1152 cptr
= cur_symbols
->names
;
1153 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
1155 struct fn_decl
*fn
= lookup_std_proto (cptr
, name_len
);
1156 required_unseen_count
++;
1158 fprintf (stderr
, "Internal error: No prototype for %s\n", cptr
);
1164 read_scan_file (argv
[2], argc
- 4, argv
+ 4);
1166 inf_fd
= open (argv
[2], O_RDONLY
, 0666);
1169 fprintf (stderr
, "%s: Cannot open '%s' for reading -",
1172 exit (FATAL_EXIT_CODE
);
1174 if (fstat (inf_fd
, &sbuf
) < 0)
1176 fprintf (stderr
, "%s: Cannot get size of '%s' -", progname
, argv
[2]);
1178 exit (FATAL_EXIT_CODE
);
1180 inf_size
= sbuf
.st_size
;
1181 inf_buffer
= xmalloc (inf_size
+ 2);
1182 inf_ptr
= inf_buffer
;
1187 long i
= read (inf_fd
, inf_buffer
+ inf_size
- to_read
, to_read
);
1190 fprintf (stderr
, "%s: Failed to read '%s' -", progname
, argv
[2]);
1192 exit (FATAL_EXIT_CODE
);
1196 inf_size
-= to_read
;
1204 /* Inf_size may have changed if read was short (as on VMS) */
1205 inf_buffer
[inf_size
] = '\n';
1206 inf_buffer
[inf_size
+ 1] = '\0';
1207 inf_limit
= inf_buffer
+ inf_size
;
1209 /* If file doesn't end with '\n', add one. */
1210 if (inf_limit
> inf_buffer
&& inf_limit
[-1] != '\n')
1214 outf
= fopen (argv
[3], "w");
1217 fprintf (stderr
, "%s: Cannot open '%s' for writing -",
1220 exit (FATAL_EXIT_CODE
);
1225 if (check_protection (&ifndef_line
, &endif_line
))
1227 lbrac_line
= ifndef_line
+1;
1228 rbrac_line
= endif_line
;
1236 /* Reset input file. */
1237 inf_ptr
= inf_buffer
;
1242 if (lineno
== lbrac_line
)
1244 if (lineno
== rbrac_line
)
1254 c
= inf_scan_ident (&buf
, c
);
1255 (void) INF_UNGET (c
);
1256 fputs (buf
.base
, outf
);
1257 fn
= lookup_std_proto (buf
.base
, strlen (buf
.base
));
1258 /* We only want to edit the declaration matching the one
1259 seen by scan-decls, as there can be multiple
1260 declarations, selected by #ifdef __STDC__ or whatever. */
1261 if (fn
&& fn
->partial
&& fn
->partial
->line_seen
== lineno
)
1263 c
= inf_skip_spaces (' ');
1268 c
= inf_skip_spaces (' ');
1271 fprintf (outf
, " _PARAMS((%s))", fn
->params
);
1276 (void) INF_UNGET (c
);
1280 fprintf (outf
, " %c", c
);