1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000 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 are such as you would pass to cpp.
72 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
80 static void v_fatal
PARAMS ((const char *, va_list)) ATTRIBUTE_NORETURN
;
81 static void fatal
PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN
;
86 int partial_count
= 0;
89 /* We no longer need to add extern "C", because cpp implicitly
90 forces the standard include files to be treated as C. */
91 /*#define ADD_MISSING_EXTERN_C 1 */
93 #if ADD_MISSING_EXTERN_C
94 int missing_extern_C_count
= 0;
97 #include "xsys-protos.h"
99 #ifdef FIXPROTO_IGNORE_LIST
100 /* This is a currently unused feature. */
102 /* List of files and directories to ignore.
103 A directory name (ending in '/') means ignore anything in that
104 directory. (It might be more efficient to do directory pruning
105 earlier in fixproto, but this is simpler and easier to customize.) */
107 static char *files_to_ignore
[] = {
118 /* Certain standard files get extra treatment */
141 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
142 by an empty name (i.e. by "\0\0"). */
144 typedef const char *namelist
;
146 /* The following macros provide the bits for symbol_flags. */
147 typedef int symbol_flags
;
149 /* Used to mark names defined in the ANSI/ISO C standard. */
150 #define ANSI_SYMBOL 1
152 /* We no longer massage include files for POSIX or XOPEN symbols,
153 as there are now several versions of the POSIX and XOPEN standards,
154 and it would be a maintenance nightmare for us to track them all.
155 Better to be compatible with the system include files. */
156 /*#define ADD_MISSING_POSIX 1 */
157 /*#define ADD_MISSING_XOPEN 1 */
159 #if ADD_MISSING_POSIX
160 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
161 #define POSIX1_SYMBOL 2
162 #define POSIX2_SYMBOL 4
164 #define POSIX1_SYMBOL 0
165 #define POSIX2_SYMBOL 0
168 #if ADD_MISSING_XOPEN
169 /* Used to mark names defined in X/Open Portability Guide. */
170 #define XOPEN_SYMBOL 8
171 /* Used to mark names defined in X/Open UNIX Extensions. */
172 #define XOPEN_EXTENDED_SYMBOL 16
174 #define XOPEN_SYMBOL 0
175 #define XOPEN_EXTENDED_SYMBOL 0
178 /* Used to indicate names that are not functions */
179 #define MACRO_SYMBOL 512
186 #define SYMBOL_TABLE_SIZE 10
187 struct symbol_list symbol_table
[SYMBOL_TABLE_SIZE
];
188 int cur_symbol_table_size
;
190 static void add_symbols
PARAMS ((symbol_flags
, namelist
));
191 static struct fn_decl
*lookup_std_proto
PARAMS ((const char *, int));
192 static void write_lbrac
PARAMS ((void));
193 static void recognized_macro
PARAMS ((const char *));
194 static void check_macro_names
PARAMS ((cpp_reader
*, namelist
));
195 static void read_scan_file
PARAMS ((char *, int, char **));
196 static void write_rbrac
PARAMS ((void));
197 static int inf_skip_spaces
PARAMS ((int));
198 static int inf_read_upto
PARAMS ((sstring
*, int));
199 static int inf_scan_ident
PARAMS ((sstring
*, int));
200 static int check_protection
PARAMS ((int *, int *));
203 add_symbols (flags
, names
)
207 symbol_table
[cur_symbol_table_size
].flags
= flags
;
208 symbol_table
[cur_symbol_table_size
].names
= names
;
209 cur_symbol_table_size
++;
210 if (cur_symbol_table_size
>= SYMBOL_TABLE_SIZE
)
211 fatal ("too many calls to add_symbols");
212 symbol_table
[cur_symbol_table_size
].names
= NULL
; /* Termination. */
215 struct std_include_entry
{
221 const char NONE
[] = ""; /* The empty namelist. */
223 /* Special name to indicate a continuation line in std_include_table. */
224 const char CONTINUED
[] = "";
226 struct std_include_entry
*include_entry
;
228 struct std_include_entry std_include_table
[] = {
229 { "ctype.h", ANSI_SYMBOL
,
230 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
231 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
233 { "dirent.h", POSIX1_SYMBOL
, "closedir\0opendir\0readdir\0rewinddir\0"},
235 { "errno.h", ANSI_SYMBOL
|MACRO_SYMBOL
, "errno\0" },
237 /* ANSI_SYMBOL is wrong, but ... */
238 { "curses.h", ANSI_SYMBOL
, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
239 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
240 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
241 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
242 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
244 { "fcntl.h", POSIX1_SYMBOL
, "creat\0fcntl\0open\0" },
246 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
247 { "grp.h", POSIX1_SYMBOL
, "getgrgid\0getgrnam\0" },
249 /*{ "limit.h", ... provided by gcc }, */
251 { "locale.h", ANSI_SYMBOL
, "localeconv\0setlocale\0" },
253 { "math.h", ANSI_SYMBOL
,
254 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
255 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
258 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "HUGE_VAL\0" },
260 { "pwd.h", POSIX1_SYMBOL
, "getpwnam\0getpwuid\0" },
262 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
263 { "setjmp.h", ANSI_SYMBOL
, "longjmp\0setjmp\0" },
265 /* Left out signal() - its prototype is too complex for us!
266 Also left out "sigaction sigaddset sigdelset sigemptyset
267 sigfillset sigismember sigpending sigprocmask sigsuspend"
268 because these need sigset_t or struct sigaction.
269 Most systems that provide them will also declare them. */
270 { "signal.h", ANSI_SYMBOL
, "kill\0raise\0" },
272 { "stdio.h", ANSI_SYMBOL
,
273 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
274 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
275 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
276 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
277 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
279 { CONTINUED
, POSIX1_SYMBOL
, "fdopen\0fileno\0" },
280 { CONTINUED
, POSIX2_SYMBOL
, "pclose\0popen\0" }, /* I think ... */
281 /* Should perhaps also handle NULL, EOF, ... ? */
283 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
284 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
285 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
286 Should perhaps also add NULL */
287 { "stdlib.h", ANSI_SYMBOL
,
288 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
289 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
290 srand\0strtod\0strtol\0strtoul\0system\0" },
291 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
293 { "string.h", ANSI_SYMBOL
, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
294 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
295 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
296 strtok\0strxfrm\0" },
297 /* Should perhaps also add NULL and size_t */
299 { "strings.h", XOPEN_EXTENDED_SYMBOL
,
300 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
302 { "strops.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
304 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
305 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
306 and many systems do have <sys/ioctl.h> but not <strops.h>. */
307 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
309 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL
, "socket\0" },
311 { "sys/stat.h", POSIX1_SYMBOL
,
312 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
313 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
314 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
315 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
316 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
, "fchmod\0" },
319 /* How do we handle fd_set? */
320 { "sys/time.h", XOPEN_EXTENDED_SYMBOL
, "select\0" },
321 { "sys/select.h", XOPEN_EXTENDED_SYMBOL
/* fake */, "select\0" },
324 { "sys/times.h", POSIX1_SYMBOL
, "times\0" },
325 /* "sys/types.h" add types (not in old g++-include) */
327 { "sys/utsname.h", POSIX1_SYMBOL
, "uname\0" },
329 { "sys/wait.h", POSIX1_SYMBOL
, "wait\0waitpid\0" },
330 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
331 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
332 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
334 { "tar.h", POSIX1_SYMBOL
, NONE
},
336 { "termios.h", POSIX1_SYMBOL
,
337 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
339 { "time.h", ANSI_SYMBOL
,
340 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
342 { "unistd.h", POSIX1_SYMBOL
,
343 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
344 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
345 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
346 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
347 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
348 ttyname\0unlink\0write\0" },
349 { CONTINUED
, POSIX2_SYMBOL
, "getopt\0" },
350 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
,
351 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
353 { "utime.h", POSIX1_SYMBOL
, "utime\0" },
358 enum special_file special_file_handling
= no_special
;
360 /* They are set if the corresponding macro has been seen. */
361 /* The following are only used when handling sys/stat.h */
362 int seen_S_IFBLK
= 0, seen_S_ISBLK
= 0;
363 int seen_S_IFCHR
= 0, seen_S_ISCHR
= 0;
364 int seen_S_IFDIR
= 0, seen_S_ISDIR
= 0;
365 int seen_S_IFIFO
= 0, seen_S_ISFIFO
= 0;
366 int seen_S_IFLNK
= 0, seen_S_ISLNK
= 0;
367 int seen_S_IFREG
= 0, seen_S_ISREG
= 0;
368 /* The following are only used when handling errno.h */
370 /* The following are only used when handling stdlib.h */
371 int seen_EXIT_FAILURE
= 0, seen_EXIT_SUCCESS
= 0;
373 #define obstack_chunk_alloc xmalloc
374 #define obstack_chunk_free free
375 struct obstack scan_file_obstack
;
377 /* NOTE: If you edit this, also edit gen-protos.c !! */
379 static struct fn_decl
*
380 lookup_std_proto (name
, name_length
)
384 int i
= hashstr (name
, name_length
) % HASH_SIZE
;
389 if (hash_tab
[i
] == 0)
391 fn
= &std_protos
[hash_tab
[i
]];
392 if ((int) strlen (fn
->fname
) == name_length
393 && strncmp (fn
->fname
, name
, name_length
) == 0)
395 i
= (i
+1) % HASH_SIZE
;
402 int inc_filename_length
;
403 const char *progname
= "fix-header";
407 int lbrac_line
, rbrac_line
;
409 int required_unseen_count
= 0;
410 int required_other
= 0;
416 #if ADD_MISSING_EXTERN_C
417 if (missing_extern_C_count
+ required_unseen_count
> 0)
418 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
423 fprintf (outf
, "#ifndef _PARAMS\n");
424 fprintf (outf
, "#if defined(__STDC__) || defined(__cplusplus)\n");
425 fprintf (outf
, "#define _PARAMS(ARGS) ARGS\n");
426 fprintf (outf
, "#else\n");
427 fprintf (outf
, "#define _PARAMS(ARGS) ()\n");
428 fprintf (outf
, "#endif\n#endif /* _PARAMS */\n");
434 struct partial_proto
*next
;
435 char *fname
; /* name of function */
436 char *rtype
; /* return type */
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)
450 recognized_macro (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. */
460 required_unseen_count
--;
464 switch (special_file_handling
)
467 if (strcmp (fname
, "errno") == 0 && !seen_errno
)
468 seen_errno
= 1, required_other
--;
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
--;
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
++;
500 recognized_extern (name
, name_length
, type
, type_length
)
502 const char *type ATTRIBUTE_UNUSED
;
503 int name_length
, type_length ATTRIBUTE_UNUSED
;
505 switch (special_file_handling
)
508 if (name_length
== 5 && strncmp (name
, "errno", 5) == 0 && !seen_errno
)
509 seen_errno
= 1, required_other
--;
517 /* Called by scan_decls if it saw a function definition for a function
518 named FNAME, with return type RTYPE, and argument list ARGS,
519 in source file FILE_SEEN on line LINE_SEEN.
520 KIND is 'I' for an inline function;
521 'F' if a normal function declaration preceded by 'extern "C"'
522 (or nested inside 'extern "C"' braces); or
523 'f' for other function declarations. */
526 recognized_function (fname
, fname_length
,
527 kind
, rtype
, rtype_length
,
528 have_arg_list
, file_seen
, line_seen
)
531 int kind
; /* One of 'f' 'F' or 'I' */
535 const char *file_seen
;
538 struct partial_proto
*partial
;
541 #if ADD_MISSING_EXTERN_C
543 missing_extern_C_count
++;
546 fn
= lookup_std_proto (fname
, fname_length
);
548 /* Remove the function from the list of required function. */
552 required_unseen_count
--;
556 /* If we have a full prototype, we're done. */
560 if (kind
== 'I') /* don't edit inline function */
563 /* If the partial prototype was included from some other file,
564 we don't need to patch it up (in this run). */
565 i
= strlen (file_seen
);
566 if (i
< inc_filename_length
567 || strcmp (inc_filename
, file_seen
+ (i
- inc_filename_length
)) != 0)
572 if (fn
->params
[0] == '\0')
575 /* We only have a partial function declaration,
576 so remember that we have to add a complete prototype. */
578 partial
= (struct partial_proto
*)
579 obstack_alloc (&scan_file_obstack
, sizeof (struct partial_proto
));
580 partial
->fname
= obstack_alloc (&scan_file_obstack
, fname_length
+ 1);
581 bcopy (fname
, partial
->fname
, fname_length
);
582 partial
->fname
[fname_length
] = 0;
583 partial
->rtype
= obstack_alloc (&scan_file_obstack
, rtype_length
+ 1);
584 sprintf (partial
->rtype
, "%.*s", rtype_length
, rtype
);
585 partial
->line_seen
= line_seen
;
587 fn
->partial
= partial
;
588 partial
->next
= partial_proto_list
;
589 partial_proto_list
= partial
;
592 fprintf (stderr
, "(%s: %s non-prototype function declaration.)\n",
593 inc_filename
, partial
->fname
);
597 /* For any name in NAMES that is defined as a macro,
598 call recognized_macro on it. */
601 check_macro_names (pfile
, names
)
607 if (cpp_defined (pfile
, names
, -1))
608 recognized_macro (names
);
609 names
+= strlen (names
) + 1;
614 read_scan_file (in_fname
, argc
, argv
)
620 cpp_options scan_options
;
623 register struct symbol_list
*cur_symbols
;
625 obstack_init (&scan_file_obstack
);
627 cpp_reader_init (&scan_in
);
628 scan_in
.opts
= &scan_options
;
629 cpp_options_init (&scan_options
);
630 /* We are going to be scanning a header file out of its proper context,
631 so ignore warnings and errors. */
632 scan_options
.inhibit_warnings
= 1;
633 scan_options
.inhibit_errors
= 1;
634 scan_options
.no_line_commands
= 1;
635 i
= cpp_handle_options (&scan_in
, argc
, argv
);
636 if (i
< argc
&& ! CPP_FATAL_ERRORS (&scan_in
))
637 cpp_fatal (&scan_in
, "Invalid option `%s'", argv
[i
]);
638 if (CPP_FATAL_ERRORS (&scan_in
))
639 exit (FATAL_EXIT_CODE
);
641 if (! cpp_start_read (&scan_in
, in_fname
))
642 exit (FATAL_EXIT_CODE
);
644 scan_decls (&scan_in
, argc
, argv
);
645 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
646 check_macro_names (&scan_in
, cur_symbols
->names
);
648 if (verbose
&& (scan_in
.errors
+ warnings
) > 0)
649 fprintf (stderr
, "(%s: %d errors and %d warnings from cpp)\n",
650 inc_filename
, scan_in
.errors
, warnings
);
652 exit (SUCCESS_EXIT_CODE
);
654 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
655 If so, those functions are also required. */
656 if (special_file_handling
== stdio_h
657 && (fn
= lookup_std_proto ("_filbuf", 7)) != NULL
)
659 static char getchar_call
[] = "getchar();";
661 = cpp_push_buffer (&scan_in
, getchar_call
, sizeof(getchar_call
) - 1);
662 int old_written
= CPP_WRITTEN (&scan_in
);
665 /* Scan the macro expansion of "getchar();". */
668 enum cpp_token token
= cpp_get_token (&scan_in
);
669 int length
= CPP_WRITTEN (&scan_in
) - old_written
;
670 CPP_SET_WRITTEN (&scan_in
, old_written
);
671 if (token
== CPP_EOF
) /* Should not happen ... */
673 if (token
== CPP_POP
&& CPP_BUFFER (&scan_in
) == buf
)
675 cpp_pop_buffer (&scan_in
);
678 if (token
== CPP_NAME
&& length
== 7
679 && strcmp ("_filbuf", scan_in
.token_buffer
+ old_written
) == 0)
684 int need_filbuf
= !SEEN (fn
) && !REQUIRED (fn
);
685 struct fn_decl
*flsbuf_fn
= lookup_std_proto ("_flsbuf", 7);
687 = flsbuf_fn
&& !SEEN (flsbuf_fn
) && !REQUIRED (flsbuf_fn
);
689 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
690 if (need_filbuf
+ need_flsbuf
)
692 const char *new_list
;
696 SET_REQUIRED (flsbuf_fn
);
697 if (need_flsbuf
+ need_filbuf
== 2)
698 new_list
= "_filbuf\0_flsbuf\0";
699 else if (need_flsbuf
)
700 new_list
= "_flsbuf\0";
701 else /* if (need_flsbuf) */
702 new_list
= "_filbuf\0";
703 add_symbols (ANSI_SYMBOL
, new_list
);
704 required_unseen_count
+= need_filbuf
+ need_flsbuf
;
709 if (required_unseen_count
+ partial_count
+ required_other
710 #if ADD_MISSING_EXTERN_C
711 + missing_extern_C_count
716 fprintf (stderr
, "%s: OK, nothing needs to be done.\n", inc_filename
);
717 exit (SUCCESS_EXIT_CODE
);
720 fprintf (stderr
, "%s: fixing %s\n", progname
, inc_filename
);
723 if (required_unseen_count
)
724 fprintf (stderr
, "%s: %d missing function declarations.\n",
725 inc_filename
, required_unseen_count
);
727 fprintf (stderr
, "%s: %d non-prototype function declarations.\n",
728 inc_filename
, partial_count
);
729 #if ADD_MISSING_EXTERN_C
730 if (missing_extern_C_count
)
732 "%s: %d declarations not protected by extern \"C\".\n",
733 inc_filename
, missing_extern_C_count
);
743 register struct symbol_list
*cur_symbols
;
745 if (required_unseen_count
)
747 #ifdef NO_IMPLICIT_EXTERN_C
748 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
752 /* Now we print out prototypes for those functions that we haven't seen. */
753 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
755 int if_was_emitted
= 0;
757 cptr
= cur_symbols
->names
;
758 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
760 int macro_protect
= 0;
762 if (cur_symbols
->flags
& MACRO_SYMBOL
)
765 fn
= lookup_std_proto (cptr
, name_len
);
766 if (fn
== NULL
|| !REQUIRED (fn
))
771 /* what about curses. ??? or _flsbuf/_filbuf ??? */
772 if (cur_symbols
->flags
& ANSI_SYMBOL
)
774 "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
775 else if (cur_symbols
->flags
& (POSIX1_SYMBOL
|POSIX2_SYMBOL
))
777 "#if defined(__USE_FIXED_PROTOTYPES__) || (defined(__cplusplus) \\\n\
778 ? (!defined(__STRICT_ANSI__) || defined(_POSIX_SOURCE)) \\\n\
779 : (defined(__STRICT_ANSI__) && defined(_POSIX_SOURCE)))\n");
780 else if (cur_symbols
->flags
& XOPEN_SYMBOL
)
783 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
784 || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
786 else if (cur_symbols
->flags
& XOPEN_EXTENDED_SYMBOL
)
789 "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
790 || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
794 fatal ("internal error for function %s", fn
->fname
);
799 /* In the case of memmove, protect in case the application
800 defines it as a macro before including the header. */
801 if (!strcmp (fn
->fname
, "memmove")
802 || !strcmp (fn
->fname
, "vprintf")
803 || !strcmp (fn
->fname
, "vfprintf")
804 || !strcmp (fn
->fname
, "vsprintf")
805 || !strcmp (fn
->fname
, "rewinddir")
806 || !strcmp (fn
->fname
, "abort"))
810 fprintf (outf
, "#ifndef %s\n", fn
->fname
);
811 fprintf (outf
, "extern %s %s (%s);\n",
812 fn
->rtype
, fn
->fname
, fn
->params
);
814 fprintf (outf
, "#endif\n");
818 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
820 if (required_unseen_count
)
822 #ifdef NO_IMPLICIT_EXTERN_C
823 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
827 switch (special_file_handling
)
831 fprintf (outf
, "extern int errno;\n");
834 if (!seen_EXIT_FAILURE
)
835 fprintf (outf
, "#define EXIT_FAILURE 1\n");
836 if (!seen_EXIT_SUCCESS
)
837 fprintf (outf
, "#define EXIT_SUCCESS 0\n");
840 if (!seen_S_ISBLK
&& seen_S_IFBLK
)
842 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
843 if (!seen_S_ISCHR
&& seen_S_IFCHR
)
845 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
846 if (!seen_S_ISDIR
&& seen_S_IFDIR
)
848 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
849 if (!seen_S_ISFIFO
&& seen_S_IFIFO
)
851 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
852 if (!seen_S_ISLNK
&& seen_S_IFLNK
)
854 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
855 if (!seen_S_ISREG
&& seen_S_IFREG
)
857 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
865 #if ADD_MISSING_EXTERN_C
866 if (missing_extern_C_count
+ required_unseen_count
> 0)
867 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
871 /* Returns 1 iff the file is properly protected from multiple inclusion:
878 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
879 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
887 if (c
== ' ' || c
== '\t')
894 (void) INF_UNGET (c
);
905 source_lineno
++, lineno
++;
908 else if ((c
= INF_GET ()) == '/')
918 /* Read into STR from inf_buffer upto DELIM. */
921 inf_read_upto (str
, delim
)
929 if (ch
== EOF
|| ch
== delim
)
931 SSTRING_PUT (str
, ch
);
933 MAKE_SSTRING_SPACE (str
, 1);
939 inf_scan_ident (s
, c
)
944 if (ISALPHA (c
) || c
== '_')
950 if (c
== EOF
|| !(ISALNUM (c
) || c
== '_'))
954 MAKE_SSTRING_SPACE (s
, 1);
959 /* Returns 1 if the file is correctly protected against multiple
960 inclusion, setting *ifndef_line to the line number of the initial #ifndef
961 and setting *endif_line to the final #endif.
962 Otherwise return 0. */
965 check_protection (ifndef_line
, endif_line
)
966 int *ifndef_line
, *endif_line
;
969 int if_nesting
= 1; /* Level of nesting of #if's */
970 char *protect_name
= NULL
; /* Identifier following initial #ifndef */
973 /* Skip initial white space (including comments). */
976 c
= inf_skip_spaces (' ');
984 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
985 if (SSTRING_LENGTH (&buf
) == 0 || strcmp (buf
.base
, "ifndef") != 0)
988 /* So far so good: We've seen an initial #ifndef. */
989 *ifndef_line
= lineno
;
990 c
= inf_scan_ident (&buf
, inf_skip_spaces (c
));
991 if (SSTRING_LENGTH (&buf
) == 0 || c
== EOF
)
993 protect_name
= xstrdup (buf
.base
);
995 (void) INF_UNGET (c
);
996 c
= inf_read_upto (&buf
, '\n');
1003 c
= inf_skip_spaces (' ');
1013 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
1014 if (SSTRING_LENGTH (&buf
) == 0)
1016 else if (!strcmp (buf
.base
, "ifndef")
1017 || !strcmp (buf
.base
, "ifdef") || !strcmp (buf
.base
, "if"))
1021 else if (!strcmp (buf
.base
, "endif"))
1024 if (if_nesting
== 0)
1027 else if (!strcmp (buf
.base
, "else"))
1029 if (if_nesting
== 1)
1032 else if (!strcmp (buf
.base
, "define"))
1034 if (if_nesting
!= 1)
1036 c
= inf_skip_spaces (c
);
1037 c
= inf_scan_ident (&buf
, c
);
1038 if (buf
.base
[0] > 0 && strcmp (buf
.base
, protect_name
) == 0)
1044 if (c
== '\n' || c
== EOF
)
1055 *endif_line
= lineno
;
1056 /* Skip final white space (including comments). */
1059 c
= inf_skip_spaces (' ');
1069 extern int main
PARAMS ((int, char **));
1079 #ifdef FIXPROTO_IGNORE_LIST
1087 register struct symbol_list
*cur_symbols
;
1089 if (argv
[0] && argv
[0][0])
1094 for (p
= argv
[0]; *p
; p
++)
1097 progname
= progname
? progname
+1 : argv
[0];
1102 fprintf (stderr
, "%s: Usage: foo.h infile.h outfile.h options\n",
1104 exit (FATAL_EXIT_CODE
);
1107 inc_filename
= argv
[1];
1108 inc_filename_length
= strlen (inc_filename
);
1110 #ifdef FIXPROTO_IGNORE_LIST
1111 for (i
= 0; files_to_ignore
[i
] != NULL
; i
++)
1113 char *ignore_name
= files_to_ignore
[i
];
1114 int ignore_len
= strlen (ignore_name
);
1115 if (strncmp (inc_filename
, ignore_name
, ignore_len
) == 0)
1117 if (ignore_name
[ignore_len
-1] == '/'
1118 || inc_filename
[ignore_len
] == '\0')
1121 fprintf (stderr
, "%s: ignoring %s\n", progname
, inc_filename
);
1122 exit (SUCCESS_EXIT_CODE
);
1129 if (strcmp (inc_filename
, "sys/stat.h") == 0)
1130 special_file_handling
= sys_stat_h
;
1131 else if (strcmp (inc_filename
, "errno.h") == 0)
1132 special_file_handling
= errno_h
, required_other
++;
1133 else if (strcmp (inc_filename
, "stdlib.h") == 0)
1134 special_file_handling
= stdlib_h
, required_other
+=2;
1135 else if (strcmp (inc_filename
, "stdio.h") == 0)
1136 special_file_handling
= stdio_h
;
1137 include_entry
= std_include_table
;
1138 while (include_entry
->name
!= NULL
1139 && ((strcmp (include_entry
->name
, CONTINUED
) == 0)
1140 || strcmp (inc_filename
, include_entry
->name
) != 0))
1143 if (include_entry
->name
!= NULL
)
1145 struct std_include_entry
*entry
;
1146 cur_symbol_table_size
= 0;
1147 for (entry
= include_entry
; ;)
1150 add_symbols (entry
->flags
, entry
->names
);
1152 if (!entry
->name
|| strcmp (entry
->name
, CONTINUED
) != 0)
1157 symbol_table
[0].names
= NULL
;
1159 /* Count and mark the prototypes required for this include file. */
1160 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
1163 if (cur_symbols
->flags
& MACRO_SYMBOL
)
1165 cptr
= cur_symbols
->names
;
1166 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
1168 struct fn_decl
*fn
= lookup_std_proto (cptr
, name_len
);
1169 required_unseen_count
++;
1171 fprintf (stderr
, "Internal error: No prototype for %s\n", cptr
);
1177 read_scan_file (argv
[2], argc
- 4, argv
+ 4);
1179 inf_fd
= open (argv
[2], O_RDONLY
, 0666);
1182 fprintf (stderr
, "%s: Cannot open '%s' for reading -",
1185 exit (FATAL_EXIT_CODE
);
1187 if (fstat (inf_fd
, &sbuf
) < 0)
1189 fprintf (stderr
, "%s: Cannot get size of '%s' -", progname
, argv
[2]);
1191 exit (FATAL_EXIT_CODE
);
1193 inf_size
= sbuf
.st_size
;
1194 inf_buffer
= (char *) xmalloc (inf_size
+ 2);
1195 inf_buffer
[inf_size
] = '\n';
1196 inf_buffer
[inf_size
+ 1] = '\0';
1197 inf_limit
= inf_buffer
+ inf_size
;
1198 inf_ptr
= inf_buffer
;
1203 long i
= read (inf_fd
, inf_buffer
+ inf_size
- to_read
, to_read
);
1206 fprintf (stderr
, "%s: Failed to read '%s' -", progname
, argv
[2]);
1208 exit (FATAL_EXIT_CODE
);
1212 inf_size
-= to_read
;
1220 /* If file doesn't end with '\n', add one. */
1221 if (inf_limit
> inf_buffer
&& inf_limit
[-1] != '\n')
1225 outf
= fopen (argv
[3], "w");
1228 fprintf (stderr
, "%s: Cannot open '%s' for writing -",
1231 exit (FATAL_EXIT_CODE
);
1236 if (check_protection (&ifndef_line
, &endif_line
))
1238 lbrac_line
= ifndef_line
+1;
1239 rbrac_line
= endif_line
;
1247 /* Reset input file. */
1248 inf_ptr
= inf_buffer
;
1253 if (lineno
== lbrac_line
)
1255 if (lineno
== rbrac_line
)
1263 if (ISALPHA (c
) || c
== '_')
1265 c
= inf_scan_ident (&buf
, c
);
1266 (void) INF_UNGET (c
);
1267 fputs (buf
.base
, outf
);
1268 fn
= lookup_std_proto (buf
.base
, strlen (buf
.base
));
1269 /* We only want to edit the declaration matching the one
1270 seen by scan-decls, as there can be multiple
1271 declarations, selected by #ifdef __STDC__ or whatever. */
1272 if (fn
&& fn
->partial
&& fn
->partial
->line_seen
== lineno
)
1274 c
= inf_skip_spaces (' ');
1279 c
= inf_skip_spaces (' ');
1282 fprintf (outf
, " _PARAMS((%s))", fn
->params
);
1287 (void) INF_UNGET (c
);
1291 fprintf (outf
, " %c", c
);
1319 fprintf (stderr
, "%s: %s: ", progname
, inc_filename
);
1320 vfprintf (stderr
, str
, ap
);
1321 fprintf (stderr
, "\n");
1323 exit (FATAL_EXIT_CODE
);
1327 fatal
VPARAMS ((const char *str
, ...))
1329 #ifndef ANSI_PROTOTYPES
1336 #ifndef ANSI_PROTOTYPES
1337 str
= va_arg (ap
, const char *);