1 /* fix-header.c - Make C header file suitable for C++.
2 Copyright (C) 1993, 94-99, 2000 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* This program massages a system include file (such as stdio.h),
19 into a form that is compatible with GNU C and GNU C++.
21 * extern "C" { ... } braces are added (inside #ifndef __cplusplus),
22 if they seem to be needed. These prevent C++ compilers from name
23 mangling the functions inside the braces.
25 * If an old-style incomplete function declaration is seen (without
26 an argument list), and it is a "standard" function listed in
27 the file sys-protos.h (and with a non-empty argument list), then
28 the declaration is converted to a complete prototype by replacing
29 the empty parameter list with the argument list from sys-protos.h.
31 * The program can be given a list of (names of) required standard
32 functions (such as fclose for stdio.h). If a required function
33 is not seen in the input, then a prototype for it will be
34 written to the output.
36 * If all of the non-comment code of the original file is protected
37 against multiple inclusion:
40 <body of include file>
42 then extra matter added to the include file is placed inside the <body>.
44 * If the input file is OK (nothing needs to be done);
45 the output file is not written (nor removed if it exists).
47 There are also some special actions that are done for certain
48 well-known standard include files:
50 * If argv[1] is "sys/stat.h", the Posix.1 macros
51 S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
52 they were missing, and the corresponding "traditional" S_IFxxx
55 * If argv[1] is "errno.h", errno is declared if it was missing.
57 * TODO: The input file should be read complete into memory, because:
58 a) it needs to be scanned twice anyway, and
59 b) it would be nice to allow update in place.
62 fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
64 * FOO.H is the relative file name of the include file,
65 as it would be #include'd by a C file. (E.g. stdio.h)
66 * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
67 * OUTFILE.H is the full pathname for where to write the output file,
68 if anything needs to be done. (e.g. ./include/stdio.h)
69 * OPTIONS are such as you would pass to cpp.
71 Written by Per Bothner <bothner@cygnus.com>, July 1993. */
79 static void v_fatal
PARAMS ((const char *, va_list)) ATTRIBUTE_NORETURN
;
80 static void fatal
PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN
;
85 int partial_count
= 0;
88 /* We no longer need to add extern "C", because cpp implicitly
89 forces the standard include files to be treated as C. */
90 /*#define ADD_MISSING_EXTERN_C 1 */
92 #if ADD_MISSING_EXTERN_C
93 int missing_extern_C_count
= 0;
96 #include "xsys-protos.h"
98 #ifdef FIXPROTO_IGNORE_LIST
99 /* This is a currently unused feature. */
101 /* List of files and directories to ignore.
102 A directory name (ending in '/') means ignore anything in that
103 directory. (It might be more efficient to do directory pruning
104 earlier in fixproto, but this is simpler and easier to customize.) */
106 static char *files_to_ignore
[] = {
117 /* Certain standard files get extra treatment */
140 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
141 by an empty name (i.e. by "\0\0"). */
143 typedef const char *namelist
;
145 /* The following macros provide the bits for symbol_flags. */
146 typedef int symbol_flags
;
148 /* Used to mark names defined in the ANSI/ISO C standard. */
149 #define ANSI_SYMBOL 1
151 /* We no longer massage include files for POSIX or XOPEN symbols,
152 as there are now several versions of the POSIX and XOPEN standards,
153 and it would be a maintenance nightmare for us to track them all.
154 Better to be compatible with the system include files. */
155 /*#define ADD_MISSING_POSIX 1 */
156 /*#define ADD_MISSING_XOPEN 1 */
158 #if ADD_MISSING_POSIX
159 /* Used to mark names defined in the Posix.1 or Posix.2 standard. */
160 #define POSIX1_SYMBOL 2
161 #define POSIX2_SYMBOL 4
163 #define POSIX1_SYMBOL 0
164 #define POSIX2_SYMBOL 0
167 #if ADD_MISSING_XOPEN
168 /* Used to mark names defined in X/Open Portability Guide. */
169 #define XOPEN_SYMBOL 8
170 /* Used to mark names defined in X/Open UNIX Extensions. */
171 #define XOPEN_EXTENDED_SYMBOL 16
173 #define XOPEN_SYMBOL 0
174 #define XOPEN_EXTENDED_SYMBOL 0
177 /* Used to indicate names that are not functions */
178 #define MACRO_SYMBOL 512
185 #define SYMBOL_TABLE_SIZE 10
186 struct symbol_list symbol_table
[SYMBOL_TABLE_SIZE
];
187 int cur_symbol_table_size
;
189 static void add_symbols
PARAMS ((symbol_flags
, namelist
));
190 static struct fn_decl
*lookup_std_proto
PARAMS ((const char *, int));
191 static void write_lbrac
PARAMS ((void));
192 static void recognized_macro
PARAMS ((const char *));
193 static void check_macro_names
PARAMS ((cpp_reader
*, namelist
));
194 static void read_scan_file
PARAMS ((char *, int, char **));
195 static void write_rbrac
PARAMS ((void));
196 static int inf_skip_spaces
PARAMS ((int));
197 static int inf_read_upto
PARAMS ((sstring
*, int));
198 static int inf_scan_ident
PARAMS ((sstring
*, int));
199 static int check_protection
PARAMS ((int *, int *));
202 add_symbols (flags
, names
)
206 symbol_table
[cur_symbol_table_size
].flags
= flags
;
207 symbol_table
[cur_symbol_table_size
].names
= names
;
208 cur_symbol_table_size
++;
209 if (cur_symbol_table_size
>= SYMBOL_TABLE_SIZE
)
210 fatal ("too many calls to add_symbols");
211 symbol_table
[cur_symbol_table_size
].names
= NULL
; /* Termination. */
214 struct std_include_entry
{
220 const char NONE
[] = ""; /* The empty namelist. */
222 /* Special name to indicate a continuation line in std_include_table. */
223 const char CONTINUED
[] = "";
225 struct std_include_entry
*include_entry
;
227 struct std_include_entry std_include_table
[] = {
228 { "ctype.h", ANSI_SYMBOL
,
229 "isalnum\0isalpha\0iscntrl\0isdigit\0isgraph\0islower\0\
230 isprint\0ispunct\0isspace\0isupper\0isxdigit\0tolower\0toupper\0" },
232 { "dirent.h", POSIX1_SYMBOL
, "closedir\0opendir\0readdir\0rewinddir\0"},
234 { "errno.h", ANSI_SYMBOL
|MACRO_SYMBOL
, "errno\0" },
236 /* ANSI_SYMBOL is wrong, but ... */
237 { "curses.h", ANSI_SYMBOL
, "box\0delwin\0endwin\0getcurx\0getcury\0initscr\0\
238 mvcur\0mvwprintw\0mvwscanw\0newwin\0overlay\0overwrite\0\
239 scroll\0subwin\0touchwin\0waddstr\0wclear\0wclrtobot\0wclrtoeol\0\
240 waddch\0wdelch\0wdeleteln\0werase\0wgetch\0wgetstr\0winsch\0winsertln\0\
241 wmove\0wprintw\0wrefresh\0wscanw\0wstandend\0wstandout\0" },
243 { "fcntl.h", POSIX1_SYMBOL
, "creat\0fcntl\0open\0" },
245 /* Maybe also "getgrent fgetgrent setgrent endgrent" */
246 { "grp.h", POSIX1_SYMBOL
, "getgrgid\0getgrnam\0" },
248 /*{ "limit.h", ... provided by gcc }, */
250 { "locale.h", ANSI_SYMBOL
, "localeconv\0setlocale\0" },
252 { "math.h", ANSI_SYMBOL
,
253 "acos\0asin\0atan\0atan2\0ceil\0cos\0cosh\0exp\0\
254 fabs\0floor\0fmod\0frexp\0ldexp\0log10\0log\0modf\0pow\0sin\0sinh\0sqrt\0\
257 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "HUGE_VAL\0" },
259 { "pwd.h", POSIX1_SYMBOL
, "getpwnam\0getpwuid\0" },
261 /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf. */
262 { "setjmp.h", ANSI_SYMBOL
, "longjmp\0setjmp\0" },
264 /* Left out signal() - its prototype is too complex for us!
265 Also left out "sigaction sigaddset sigdelset sigemptyset
266 sigfillset sigismember sigpending sigprocmask sigsuspend"
267 because these need sigset_t or struct sigaction.
268 Most systems that provide them will also declare them. */
269 { "signal.h", ANSI_SYMBOL
, "kill\0raise\0" },
271 { "stdio.h", ANSI_SYMBOL
,
272 "clearerr\0fclose\0feof\0ferror\0fflush\0fgetc\0fgetpos\0\
273 fgets\0fopen\0fprintf\0fputc\0fputs\0fread\0freopen\0fscanf\0fseek\0\
274 fsetpos\0ftell\0fwrite\0getc\0getchar\0gets\0perror\0\
275 printf\0putc\0putchar\0puts\0remove\0rename\0rewind\0scanf\0setbuf\0\
276 setvbuf\0sprintf\0sscanf\0vprintf\0vsprintf\0vfprintf\0tmpfile\0\
278 { CONTINUED
, POSIX1_SYMBOL
, "fdopen\0fileno\0" },
279 { CONTINUED
, POSIX2_SYMBOL
, "pclose\0popen\0" }, /* I think ... */
280 /* Should perhaps also handle NULL, EOF, ... ? */
282 /* "div ldiv", - ignored because these depend on div_t, ldiv_t
283 ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
284 Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
285 Should perhaps also add NULL */
286 { "stdlib.h", ANSI_SYMBOL
,
287 "abort\0abs\0atexit\0atof\0atoi\0atol\0bsearch\0calloc\0\
288 exit\0free\0getenv\0labs\0malloc\0putenv\0qsort\0rand\0realloc\0\
289 srand\0strtod\0strtol\0strtoul\0system\0" },
290 { CONTINUED
, ANSI_SYMBOL
|MACRO_SYMBOL
, "EXIT_FAILURE\0EXIT_SUCCESS\0" },
292 { "string.h", ANSI_SYMBOL
, "memchr\0memcmp\0memcpy\0memmove\0memset\0\
293 strcat\0strchr\0strcmp\0strcoll\0strcpy\0strcspn\0strerror\0\
294 strlen\0strncat\0strncmp\0strncpy\0strpbrk\0strrchr\0strspn\0strstr\0\
295 strtok\0strxfrm\0" },
296 /* Should perhaps also add NULL and size_t */
298 { "strings.h", XOPEN_EXTENDED_SYMBOL
,
299 "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
301 { "strops.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
303 /* Actually, XPG4 does not seem to have <sys/ioctl.h>, but defines
304 ioctl in <strops.h>. However, many systems have it is sys/ioctl.h,
305 and many systems do have <sys/ioctl.h> but not <strops.h>. */
306 { "sys/ioctl.h", XOPEN_EXTENDED_SYMBOL
, "ioctl\0" },
308 { "sys/socket.h", XOPEN_EXTENDED_SYMBOL
, "socket\0" },
310 { "sys/stat.h", POSIX1_SYMBOL
,
311 "chmod\0fstat\0mkdir\0mkfifo\0stat\0lstat\0umask\0" },
312 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
313 "S_ISDIR\0S_ISBLK\0S_ISCHR\0S_ISFIFO\0S_ISREG\0S_ISLNK\0S_IFDIR\0\
314 S_IFBLK\0S_IFCHR\0S_IFIFO\0S_IFREG\0S_IFLNK\0" },
315 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
, "fchmod\0" },
318 /* How do we handle fd_set? */
319 { "sys/time.h", XOPEN_EXTENDED_SYMBOL
, "select\0" },
320 { "sys/select.h", XOPEN_EXTENDED_SYMBOL
/* fake */, "select\0" },
323 { "sys/times.h", POSIX1_SYMBOL
, "times\0" },
324 /* "sys/types.h" add types (not in old g++-include) */
326 { "sys/utsname.h", POSIX1_SYMBOL
, "uname\0" },
328 { "sys/wait.h", POSIX1_SYMBOL
, "wait\0waitpid\0" },
329 { CONTINUED
, POSIX1_SYMBOL
|MACRO_SYMBOL
,
330 "WEXITSTATUS\0WIFEXITED\0WIFSIGNALED\0WIFSTOPPED\0WSTOPSIG\0\
331 WTERMSIG\0WNOHANG\0WNOTRACED\0" },
333 { "tar.h", POSIX1_SYMBOL
, NONE
},
335 { "termios.h", POSIX1_SYMBOL
,
336 "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
338 { "time.h", ANSI_SYMBOL
,
339 "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0tzset\0" },
341 { "unistd.h", POSIX1_SYMBOL
,
342 "_exit\0access\0alarm\0chdir\0chown\0close\0ctermid\0cuserid\0\
343 dup\0dup2\0execl\0execle\0execlp\0execv\0execve\0execvp\0fork\0fpathconf\0\
344 getcwd\0getegid\0geteuid\0getgid\0getlogin\0getpgrp\0getpid\0\
345 getppid\0getuid\0isatty\0link\0lseek\0pathconf\0pause\0pipe\0read\0rmdir\0\
346 setgid\0setpgid\0setsid\0setuid\0sleep\0sysconf\0tcgetpgrp\0tcsetpgrp\0\
347 ttyname\0unlink\0write\0" },
348 { CONTINUED
, POSIX2_SYMBOL
, "getopt\0" },
349 { CONTINUED
, XOPEN_EXTENDED_SYMBOL
,
350 "lockf\0gethostid\0gethostname\0readlink\0symlink\0" },
352 { "utime.h", POSIX1_SYMBOL
, "utime\0" },
357 enum special_file special_file_handling
= no_special
;
359 /* They are set if the corresponding macro has been seen. */
360 /* The following are only used when handling sys/stat.h */
361 int seen_S_IFBLK
= 0, seen_S_ISBLK
= 0;
362 int seen_S_IFCHR
= 0, seen_S_ISCHR
= 0;
363 int seen_S_IFDIR
= 0, seen_S_ISDIR
= 0;
364 int seen_S_IFIFO
= 0, seen_S_ISFIFO
= 0;
365 int seen_S_IFLNK
= 0, seen_S_ISLNK
= 0;
366 int seen_S_IFREG
= 0, seen_S_ISREG
= 0;
367 /* The following are only used when handling errno.h */
369 /* The following are only used when handling stdlib.h */
370 int seen_EXIT_FAILURE
= 0, seen_EXIT_SUCCESS
= 0;
372 #define obstack_chunk_alloc xmalloc
373 #define obstack_chunk_free free
374 struct obstack scan_file_obstack
;
376 /* NOTE: If you edit this, also edit gen-protos.c !! */
378 static struct fn_decl
*
379 lookup_std_proto (name
, name_length
)
383 int i
= hashstr (name
, name_length
) % HASH_SIZE
;
388 if (hash_tab
[i
] == 0)
390 fn
= &std_protos
[hash_tab
[i
]];
391 if ((int) strlen (fn
->fname
) == name_length
392 && strncmp (fn
->fname
, name
, name_length
) == 0)
394 i
= (i
+1) % HASH_SIZE
;
401 int inc_filename_length
;
402 const char *progname
= "fix-header";
406 int lbrac_line
, rbrac_line
;
408 int required_unseen_count
= 0;
409 int required_other
= 0;
415 #if ADD_MISSING_EXTERN_C
416 if (missing_extern_C_count
+ required_unseen_count
> 0)
417 fprintf (outf
, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
422 fprintf (outf
, "#ifndef _PARAMS\n");
423 fprintf (outf
, "#if defined(__STDC__) || defined(__cplusplus)\n");
424 fprintf (outf
, "#define _PARAMS(ARGS) ARGS\n");
425 fprintf (outf
, "#else\n");
426 fprintf (outf
, "#define _PARAMS(ARGS) ()\n");
427 fprintf (outf
, "#endif\n#endif /* _PARAMS */\n");
433 struct partial_proto
*next
;
434 char *fname
; /* name of function */
435 char *rtype
; /* return type */
440 struct partial_proto
*partial_proto_list
= NULL
;
442 struct partial_proto required_dummy_proto
, seen_dummy_proto
;
443 #define REQUIRED(FN) ((FN)->partial == &required_dummy_proto)
444 #define SET_REQUIRED(FN) ((FN)->partial = &required_dummy_proto)
445 #define SET_SEEN(FN) ((FN)->partial = &seen_dummy_proto)
446 #define SEEN(FN) ((FN)->partial == &seen_dummy_proto)
449 recognized_macro (fname
)
452 /* The original include file defines fname as a macro. */
453 struct fn_decl
*fn
= lookup_std_proto (fname
, strlen (fname
));
455 /* Since fname is a macro, don't require a prototype for it. */
459 required_unseen_count
--;
463 switch (special_file_handling
)
466 if (strcmp (fname
, "errno") == 0 && !seen_errno
)
467 seen_errno
= 1, required_other
--;
470 if (strcmp (fname
, "EXIT_FAILURE") == 0 && !seen_EXIT_FAILURE
)
471 seen_EXIT_FAILURE
= 1, required_other
--;
472 if (strcmp (fname
, "EXIT_SUCCESS") == 0 && !seen_EXIT_SUCCESS
)
473 seen_EXIT_SUCCESS
= 1, required_other
--;
476 if (fname
[0] == 'S' && fname
[1] == '_')
478 if (strcmp (fname
, "S_IFBLK") == 0) seen_S_IFBLK
++;
479 else if (strcmp (fname
, "S_ISBLK") == 0) seen_S_ISBLK
++;
480 else if (strcmp (fname
, "S_IFCHR") == 0) seen_S_IFCHR
++;
481 else if (strcmp (fname
, "S_ISCHR") == 0) seen_S_ISCHR
++;
482 else if (strcmp (fname
, "S_IFDIR") == 0) seen_S_IFDIR
++;
483 else if (strcmp (fname
, "S_ISDIR") == 0) seen_S_ISDIR
++;
484 else if (strcmp (fname
, "S_IFIFO") == 0) seen_S_IFIFO
++;
485 else if (strcmp (fname
, "S_ISFIFO") == 0) seen_S_ISFIFO
++;
486 else if (strcmp (fname
, "S_IFLNK") == 0) seen_S_IFLNK
++;
487 else if (strcmp (fname
, "S_ISLNK") == 0) seen_S_ISLNK
++;
488 else if (strcmp (fname
, "S_IFREG") == 0) seen_S_IFREG
++;
489 else if (strcmp (fname
, "S_ISREG") == 0) seen_S_ISREG
++;
499 recognized_extern (name
, name_length
, type
, type_length
)
501 const char *type ATTRIBUTE_UNUSED
;
502 int name_length
, type_length ATTRIBUTE_UNUSED
;
504 switch (special_file_handling
)
507 if (name_length
== 5 && strncmp (name
, "errno", 5) == 0 && !seen_errno
)
508 seen_errno
= 1, required_other
--;
516 /* Called by scan_decls if it saw a function definition for a function
517 named FNAME, with return type RTYPE, and argument list ARGS,
518 in source file FILE_SEEN on line LINE_SEEN.
519 KIND is 'I' for an inline function;
520 'F' if a normal function declaration preceded by 'extern "C"'
521 (or nested inside 'extern "C"' braces); or
522 'f' for other function declarations. */
525 recognized_function (fname
, fname_length
,
526 kind
, rtype
, rtype_length
,
527 have_arg_list
, file_seen
, line_seen
)
530 int kind
; /* One of 'f' 'F' or 'I' */
534 const char *file_seen
;
537 struct partial_proto
*partial
;
540 #if ADD_MISSING_EXTERN_C
542 missing_extern_C_count
++;
545 fn
= lookup_std_proto (fname
, fname_length
);
547 /* Remove the function from the list of required function. */
551 required_unseen_count
--;
555 /* If we have a full prototype, we're done. */
559 if (kind
== 'I') /* don't edit inline function */
562 /* If the partial prototype was included from some other file,
563 we don't need to patch it up (in this run). */
564 i
= strlen (file_seen
);
565 if (i
< inc_filename_length
566 || strcmp (inc_filename
, file_seen
+ (i
- inc_filename_length
)) != 0)
571 if (fn
->params
[0] == '\0' || strcmp (fn
->params
, "void") == 0)
574 /* We only have a partial function declaration,
575 so remember that we have to add a complete prototype. */
577 partial
= (struct partial_proto
*)
578 obstack_alloc (&scan_file_obstack
, sizeof (struct partial_proto
));
579 partial
->fname
= obstack_alloc (&scan_file_obstack
, fname_length
+ 1);
580 bcopy (fname
, partial
->fname
, fname_length
);
581 partial
->fname
[fname_length
] = 0;
582 partial
->rtype
= obstack_alloc (&scan_file_obstack
, rtype_length
+ 1);
583 sprintf (partial
->rtype
, "%.*s", rtype_length
, rtype
);
584 partial
->line_seen
= line_seen
;
586 fn
->partial
= partial
;
587 partial
->next
= partial_proto_list
;
588 partial_proto_list
= partial
;
591 fprintf (stderr
, "(%s: %s non-prototype function declaration.)\n",
592 inc_filename
, partial
->fname
);
596 /* For any name in NAMES that is defined as a macro,
597 call recognized_macro on it. */
600 check_macro_names (pfile
, names
)
606 if (cpp_defined (pfile
, names
, -1))
607 recognized_macro (names
);
608 names
+= strlen (names
) + 1;
613 read_scan_file (in_fname
, argc
, argv
)
619 cpp_options scan_options
;
622 register struct symbol_list
*cur_symbols
;
624 obstack_init (&scan_file_obstack
);
626 cpp_reader_init (&scan_in
);
627 scan_in
.opts
= &scan_options
;
628 cpp_options_init (&scan_options
);
629 /* We are going to be scanning a header file out of its proper context,
630 so ignore warnings and errors. */
631 scan_options
.inhibit_warnings
= 1;
632 scan_options
.inhibit_errors
= 1;
633 i
= cpp_handle_options (&scan_in
, argc
, argv
);
634 if (i
< argc
&& ! CPP_FATAL_ERRORS (&scan_in
))
635 cpp_fatal (&scan_in
, "Invalid option `%s'", argv
[i
]);
636 if (CPP_FATAL_ERRORS (&scan_in
))
637 exit (FATAL_EXIT_CODE
);
639 if (! cpp_start_read (&scan_in
, in_fname
))
640 exit (FATAL_EXIT_CODE
);
641 CPP_OPTIONS (&scan_in
)->no_line_commands
= 1;
643 scan_decls (&scan_in
, argc
, argv
);
644 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
645 check_macro_names (&scan_in
, cur_symbols
->names
);
647 if (verbose
&& (scan_in
.errors
+ warnings
) > 0)
648 fprintf (stderr
, "(%s: %d errors and %d warnings from cpp)\n",
649 inc_filename
, scan_in
.errors
, warnings
);
651 exit (SUCCESS_EXIT_CODE
);
653 /* Traditionally, getc and putc are defined in terms of _filbuf and _flsbuf.
654 If so, those functions are also required. */
655 if (special_file_handling
== stdio_h
656 && (fn
= lookup_std_proto ("_filbuf", 7)) != NULL
)
658 static char getchar_call
[] = "getchar();";
660 = cpp_push_buffer (&scan_in
, getchar_call
, sizeof(getchar_call
) - 1);
661 int old_written
= CPP_WRITTEN (&scan_in
);
664 /* Scan the macro expansion of "getchar();". */
667 enum cpp_token token
= cpp_get_token (&scan_in
);
668 int length
= CPP_WRITTEN (&scan_in
) - old_written
;
669 CPP_SET_WRITTEN (&scan_in
, old_written
);
670 if (token
== CPP_EOF
) /* Should not happen ... */
672 if (token
== CPP_POP
&& CPP_BUFFER (&scan_in
) == buf
)
674 cpp_pop_buffer (&scan_in
);
677 if (token
== CPP_NAME
&& length
== 7
678 && strcmp ("_filbuf", scan_in
.token_buffer
+ old_written
) == 0)
683 int need_filbuf
= !SEEN (fn
) && !REQUIRED (fn
);
684 struct fn_decl
*flsbuf_fn
= lookup_std_proto ("_flsbuf", 7);
686 = flsbuf_fn
&& !SEEN (flsbuf_fn
) && !REQUIRED (flsbuf_fn
);
688 /* Append "_filbuf" and/or "_flsbuf" to the required functions. */
689 if (need_filbuf
+ need_flsbuf
)
691 const char *new_list
;
695 SET_REQUIRED (flsbuf_fn
);
696 if (need_flsbuf
+ need_filbuf
== 2)
697 new_list
= "_filbuf\0_flsbuf\0";
698 else if (need_flsbuf
)
699 new_list
= "_flsbuf\0";
700 else /* if (need_flsbuf) */
701 new_list
= "_filbuf\0";
702 add_symbols (ANSI_SYMBOL
, new_list
);
703 required_unseen_count
+= need_filbuf
+ need_flsbuf
;
708 if (required_unseen_count
+ partial_count
+ required_other
709 #if ADD_MISSING_EXTERN_C
710 + missing_extern_C_count
715 fprintf (stderr
, "%s: OK, nothing needs to be done.\n", inc_filename
);
716 exit (SUCCESS_EXIT_CODE
);
719 fprintf (stderr
, "%s: fixing %s\n", progname
, inc_filename
);
722 if (required_unseen_count
)
723 fprintf (stderr
, "%s: %d missing function declarations.\n",
724 inc_filename
, required_unseen_count
);
726 fprintf (stderr
, "%s: %d non-prototype function declarations.\n",
727 inc_filename
, partial_count
);
728 #if ADD_MISSING_EXTERN_C
729 if (missing_extern_C_count
)
731 "%s: %d declarations not protected by extern \"C\".\n",
732 inc_filename
, missing_extern_C_count
);
742 register 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
, "vprintf")
802 || !strcmp (fn
->fname
, "vfprintf")
803 || !strcmp (fn
->fname
, "vsprintf")
804 || !strcmp (fn
->fname
, "rewinddir")
805 || !strcmp (fn
->fname
, "abort"))
809 fprintf (outf
, "#ifndef %s\n", fn
->fname
);
810 fprintf (outf
, "extern %s %s (%s);\n",
811 fn
->rtype
, fn
->fname
, fn
->params
);
813 fprintf (outf
, "#endif\n");
817 "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
819 if (required_unseen_count
)
821 #ifdef NO_IMPLICIT_EXTERN_C
822 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
826 switch (special_file_handling
)
830 fprintf (outf
, "extern int errno;\n");
833 if (!seen_EXIT_FAILURE
)
834 fprintf (outf
, "#define EXIT_FAILURE 1\n");
835 if (!seen_EXIT_SUCCESS
)
836 fprintf (outf
, "#define EXIT_SUCCESS 0\n");
839 if (!seen_S_ISBLK
&& seen_S_IFBLK
)
841 "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
842 if (!seen_S_ISCHR
&& seen_S_IFCHR
)
844 "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
845 if (!seen_S_ISDIR
&& seen_S_IFDIR
)
847 "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
848 if (!seen_S_ISFIFO
&& seen_S_IFIFO
)
850 "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
851 if (!seen_S_ISLNK
&& seen_S_IFLNK
)
853 "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
854 if (!seen_S_ISREG
&& seen_S_IFREG
)
856 "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
864 #if ADD_MISSING_EXTERN_C
865 if (missing_extern_C_count
+ required_unseen_count
> 0)
866 fprintf (outf
, "#ifdef __cplusplus\n}\n#endif\n");
870 /* Returns 1 iff the file is properly protected from multiple inclusion:
877 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
878 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
886 if (c
== ' ' || c
== '\t')
893 (void) INF_UNGET (c
);
904 source_lineno
++, lineno
++;
907 else if ((c
= INF_GET ()) == '/')
917 /* Read into STR from inf_buffer upto DELIM. */
920 inf_read_upto (str
, delim
)
928 if (ch
== EOF
|| ch
== delim
)
930 SSTRING_PUT (str
, ch
);
932 MAKE_SSTRING_SPACE (str
, 1);
938 inf_scan_ident (s
, c
)
943 if (ISALPHA (c
) || c
== '_')
949 if (c
== EOF
|| !(ISALNUM (c
) || c
== '_'))
953 MAKE_SSTRING_SPACE (s
, 1);
958 /* Returns 1 if the file is correctly protected against multiple
959 inclusion, setting *ifndef_line to the line number of the initial #ifndef
960 and setting *endif_line to the final #endif.
961 Otherwise return 0. */
964 check_protection (ifndef_line
, endif_line
)
965 int *ifndef_line
, *endif_line
;
968 int if_nesting
= 1; /* Level of nesting of #if's */
969 char *protect_name
= NULL
; /* Identifier following initial #ifndef */
972 /* Skip initial white space (including comments). */
975 c
= inf_skip_spaces (' ');
983 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
984 if (SSTRING_LENGTH (&buf
) == 0 || strcmp (buf
.base
, "ifndef") != 0)
987 /* So far so good: We've seen an initial #ifndef. */
988 *ifndef_line
= lineno
;
989 c
= inf_scan_ident (&buf
, inf_skip_spaces (c
));
990 if (SSTRING_LENGTH (&buf
) == 0 || c
== EOF
)
992 protect_name
= xstrdup (buf
.base
);
994 (void) INF_UNGET (c
);
995 c
= inf_read_upto (&buf
, '\n');
1002 c
= inf_skip_spaces (' ');
1012 c
= inf_scan_ident (&buf
, inf_skip_spaces (' '));
1013 if (SSTRING_LENGTH (&buf
) == 0)
1015 else if (!strcmp (buf
.base
, "ifndef")
1016 || !strcmp (buf
.base
, "ifdef") || !strcmp (buf
.base
, "if"))
1020 else if (!strcmp (buf
.base
, "endif"))
1023 if (if_nesting
== 0)
1026 else if (!strcmp (buf
.base
, "else"))
1028 if (if_nesting
== 1)
1031 else if (!strcmp (buf
.base
, "define"))
1033 if (if_nesting
!= 1)
1035 c
= inf_skip_spaces (c
);
1036 c
= inf_scan_ident (&buf
, c
);
1037 if (buf
.base
[0] > 0 && strcmp (buf
.base
, protect_name
) == 0)
1043 if (c
== '\n' || c
== EOF
)
1054 *endif_line
= lineno
;
1055 /* Skip final white space (including comments). */
1058 c
= inf_skip_spaces (' ');
1068 extern int main
PARAMS ((int, char **));
1078 #ifdef FIXPROTO_IGNORE_LIST
1086 register struct symbol_list
*cur_symbols
;
1088 if (argv
[0] && argv
[0][0])
1093 for (p
= argv
[0]; *p
; p
++)
1096 progname
= progname
? progname
+1 : argv
[0];
1101 fprintf (stderr
, "%s: Usage: foo.h infile.h outfile.h options\n",
1103 exit (FATAL_EXIT_CODE
);
1106 inc_filename
= argv
[1];
1107 inc_filename_length
= strlen (inc_filename
);
1109 #ifdef FIXPROTO_IGNORE_LIST
1110 for (i
= 0; files_to_ignore
[i
] != NULL
; i
++)
1112 char *ignore_name
= files_to_ignore
[i
];
1113 int ignore_len
= strlen (ignore_name
);
1114 if (strncmp (inc_filename
, ignore_name
, ignore_len
) == 0)
1116 if (ignore_name
[ignore_len
-1] == '/'
1117 || inc_filename
[ignore_len
] == '\0')
1120 fprintf (stderr
, "%s: ignoring %s\n", progname
, inc_filename
);
1121 exit (SUCCESS_EXIT_CODE
);
1128 if (strcmp (inc_filename
, "sys/stat.h") == 0)
1129 special_file_handling
= sys_stat_h
;
1130 else if (strcmp (inc_filename
, "errno.h") == 0)
1131 special_file_handling
= errno_h
, required_other
++;
1132 else if (strcmp (inc_filename
, "stdlib.h") == 0)
1133 special_file_handling
= stdlib_h
, required_other
+=2;
1134 else if (strcmp (inc_filename
, "stdio.h") == 0)
1135 special_file_handling
= stdio_h
;
1136 include_entry
= std_include_table
;
1137 while (include_entry
->name
!= NULL
1138 && ((strcmp (include_entry
->name
, CONTINUED
) == 0)
1139 || strcmp (inc_filename
, include_entry
->name
) != 0))
1142 if (include_entry
->name
!= NULL
)
1144 struct std_include_entry
*entry
;
1145 cur_symbol_table_size
= 0;
1146 for (entry
= include_entry
; ;)
1149 add_symbols (entry
->flags
, entry
->names
);
1151 if (!entry
->name
|| strcmp (entry
->name
, CONTINUED
) != 0)
1156 symbol_table
[0].names
= NULL
;
1158 /* Count and mark the prototypes required for this include file. */
1159 for (cur_symbols
= &symbol_table
[0]; cur_symbols
->names
; cur_symbols
++)
1162 if (cur_symbols
->flags
& MACRO_SYMBOL
)
1164 cptr
= cur_symbols
->names
;
1165 for ( ; (name_len
= strlen (cptr
)) != 0; cptr
+= name_len
+ 1)
1167 struct fn_decl
*fn
= lookup_std_proto (cptr
, name_len
);
1168 required_unseen_count
++;
1170 fprintf (stderr
, "Internal error: No prototype for %s\n", cptr
);
1176 read_scan_file (argv
[2], argc
- 4, argv
+ 4);
1178 inf_fd
= open (argv
[2], O_RDONLY
, 0666);
1181 fprintf (stderr
, "%s: Cannot open '%s' for reading -",
1184 exit (FATAL_EXIT_CODE
);
1186 if (fstat (inf_fd
, &sbuf
) < 0)
1188 fprintf (stderr
, "%s: Cannot get size of '%s' -", progname
, argv
[2]);
1190 exit (FATAL_EXIT_CODE
);
1192 inf_size
= sbuf
.st_size
;
1193 inf_buffer
= (char *) xmalloc (inf_size
+ 2);
1194 inf_buffer
[inf_size
] = '\n';
1195 inf_buffer
[inf_size
+ 1] = '\0';
1196 inf_limit
= inf_buffer
+ inf_size
;
1197 inf_ptr
= inf_buffer
;
1202 long i
= read (inf_fd
, inf_buffer
+ inf_size
- to_read
, to_read
);
1205 fprintf (stderr
, "%s: Failed to read '%s' -", progname
, argv
[2]);
1207 exit (FATAL_EXIT_CODE
);
1211 inf_size
-= to_read
;
1219 /* If file doesn't end with '\n', add one. */
1220 if (inf_limit
> inf_buffer
&& inf_limit
[-1] != '\n')
1224 outf
= fopen (argv
[3], "w");
1227 fprintf (stderr
, "%s: Cannot open '%s' for writing -",
1230 exit (FATAL_EXIT_CODE
);
1235 if (check_protection (&ifndef_line
, &endif_line
))
1237 lbrac_line
= ifndef_line
+1;
1238 rbrac_line
= endif_line
;
1246 /* Reset input file. */
1247 inf_ptr
= inf_buffer
;
1252 if (lineno
== lbrac_line
)
1254 if (lineno
== rbrac_line
)
1262 if (ISALPHA (c
) || c
== '_')
1264 c
= inf_scan_ident (&buf
, c
);
1265 (void) INF_UNGET (c
);
1266 fputs (buf
.base
, outf
);
1267 fn
= lookup_std_proto (buf
.base
, strlen (buf
.base
));
1268 /* We only want to edit the declaration matching the one
1269 seen by scan-decls, as there can be multiple
1270 declarations, selected by #ifdef __STDC__ or whatever. */
1271 if (fn
&& fn
->partial
&& fn
->partial
->line_seen
== lineno
)
1273 c
= inf_skip_spaces (' ');
1278 c
= inf_skip_spaces (' ');
1281 fprintf (outf
, " _PARAMS((%s))", fn
->params
);
1286 (void) INF_UNGET (c
);
1290 fprintf (outf
, " %c", c
);
1318 fprintf (stderr
, "%s: %s: ", progname
, inc_filename
);
1319 vfprintf (stderr
, str
, ap
);
1320 fprintf (stderr
, "\n");
1322 exit (FATAL_EXIT_CODE
);
1326 fatal
VPARAMS ((const char *str
, ...))
1328 #ifndef ANSI_PROTOTYPES
1335 #ifndef ANSI_PROTOTYPES
1336 str
= va_arg (ap
, const char *);