OSDN Git Service

* array.c: Don't include assert.h.
[pf3gnuchains/gcc-fork.git] / gcc / fix-header.c
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.
4
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
8 later version.
9
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.
14
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.  */
18
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++.
21
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.
25
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.
31
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.
36
37    * If all of the non-comment code of the original file is protected
38    against multiple inclusion:
39         #ifndef FOO
40         #define FOO
41         <body of include file>
42         #endif
43    then extra matter added to the include file is placed inside the <body>.
44
45    * If the input file is OK (nothing needs to be done);
46    the output file is not written (nor removed if it exists).
47
48    There are also some special actions that are done for certain
49    well-known standard include files:
50
51    * If argv[1] is "sys/stat.h", the Posix.1 macros
52    S_ISBLK, S_ISCHR, S_ISDIR, S_ISFIFO, S_ISLNK, S_ISREG are added if
53    they were missing, and the corresponding "traditional" S_IFxxx
54    macros were defined.
55
56    * If argv[1] is "errno.h", errno is declared if it was missing.
57
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.
61
62    Usage:
63         fix-header FOO.H INFILE.H OUTFILE.H [OPTIONS]
64    where:
65    * FOO.H is the relative file name of the include file,
66    as it would be #include'd by a C file.  (E.g. stdio.h)
67    * INFILE.H is a full pathname for the input file (e.g. /usr/include/stdio.h)
68    * OUTFILE.H is the full pathname for where to write the output file,
69    if anything needs to be done.  (e.g. ./include/stdio.h)
70    * OPTIONS can be -D or -I switches as you would pass to cpp.
71
72    Written by Per Bothner <bothner@cygnus.com>, July 1993.  */
73
74 #include "bconfig.h"
75 #include "system.h"
76 #include "coretypes.h"
77 #include "tm.h"
78 #include "obstack.h"
79 #include "scan.h"
80 #include "cpplib.h"
81 #include "c-incpath.h"
82 #include "errors.h"
83
84 #ifdef TARGET_EXTRA_INCLUDES
85 static void hook_void_int(int u ATTRIBUTE_UNUSED) { }
86
87 struct target_c_incpath_s target_c_incpath = { hook_void_int };
88 #endif
89
90 struct line_maps line_table;
91
92 sstring buf;
93
94 int verbose = 0;
95 int partial_count = 0;
96 int warnings = 0;
97
98 #if ADD_MISSING_EXTERN_C
99 int missing_extern_C_count = 0;
100 #endif
101
102 #include "xsys-protos.h"
103
104 #ifdef FIXPROTO_IGNORE_LIST
105 /* This is a currently unused feature.  */
106
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.) */
111
112 static const char *const files_to_ignore[] = {
113   "X11/",
114   FIXPROTO_IGNORE_LIST
115   0
116 };
117 #endif
118
119 char *inf_buffer;
120 char *inf_limit;
121 char *inf_ptr;
122 static const char *cur_file;
123
124 /* Certain standard files get extra treatment */
125
126 enum special_file
127 {
128   no_special,
129 #ifdef errno_h
130 #undef errno_h
131 #endif
132   errno_h,
133 #ifdef stdio_h
134 #undef stdio_h
135 #endif
136   stdio_h,
137 #ifdef stdlib_h
138 #undef stdlib_h
139 #endif
140   stdlib_h,
141 #ifdef sys_stat_h
142 #undef sys_stat_h
143 #endif
144   sys_stat_h
145 };
146
147 /* A NAMELIST is a sequence of names, separated by '\0', and terminated
148    by an empty name (i.e. by "\0\0").  */
149
150 typedef const char *namelist;
151
152 /* The following macros provide the bits for symbol_flags.  */
153 typedef int symbol_flags;
154
155 /* Used to mark names defined in the ANSI/ISO C standard.  */
156 #define ANSI_SYMBOL 1
157
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 */
164
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
169 #else
170 #define POSIX1_SYMBOL 0
171 #define POSIX2_SYMBOL 0
172 #endif
173
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
179 #else
180 #define XOPEN_SYMBOL 0
181 #define XOPEN_EXTENDED_SYMBOL 0
182 #endif
183
184 /* Used to indicate names that are not functions */
185 #define MACRO_SYMBOL 512
186
187 struct symbol_list {
188   symbol_flags flags;
189   namelist names;
190 };
191
192 #define SYMBOL_TABLE_SIZE 10
193 struct symbol_list symbol_table[SYMBOL_TABLE_SIZE];
194 int cur_symbol_table_size;
195
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 *);
208
209 static void
210 add_symbols (symbol_flags flags, namelist names)
211 {
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.  */
218 }
219
220 struct std_include_entry {
221   const char *const name;
222   const symbol_flags flags;
223   const namelist names;
224 };
225
226 const char NONE[] = "";  /* The empty namelist.  */
227
228 /* Special name to indicate a continuation line in std_include_table.  */
229 const char CONTINUED[] = "";
230
231 const struct std_include_entry *include_entry;
232
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" },
237
238   { "dirent.h", POSIX1_SYMBOL, "closedir\0opendir\0readdir\0rewinddir\0"},
239
240   { "errno.h", ANSI_SYMBOL|MACRO_SYMBOL, "errno\0" },
241
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" },
248
249   { "fcntl.h", POSIX1_SYMBOL, "creat\0fcntl\0open\0" },
250
251   /* Maybe also "getgrent fgetgrent setgrent endgrent" */
252   { "grp.h", POSIX1_SYMBOL, "getgrgid\0getgrnam\0" },
253
254 /*{ "limit.h", ... provided by gcc }, */
255
256   { "locale.h", ANSI_SYMBOL, "localeconv\0setlocale\0" },
257
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\
261 tan\0tanh\0" },
262
263   { CONTINUED, ANSI_SYMBOL|MACRO_SYMBOL, "HUGE_VAL\0" },
264
265   { "pwd.h", POSIX1_SYMBOL, "getpwnam\0getpwuid\0" },
266
267   /* Left out siglongjmp sigsetjmp - these depend on sigjmp_buf.  */
268   { "setjmp.h", ANSI_SYMBOL, "longjmp\0setjmp\0" },
269
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" },
277
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\
284 tmpnam\0ungetc\0" },
285   { CONTINUED, POSIX1_SYMBOL, "fdopen\0fileno\0" },
286   { CONTINUED, POSIX2_SYMBOL, "pclose\0popen\0" },  /* I think ...  */
287 /* Should perhaps also handle NULL, EOF, ... ? */
288
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" },
299
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 */
305
306   { "strings.h", XOPEN_EXTENDED_SYMBOL,
307       "bcmp\0bcopy\0bzero\0ffs\0index\0rindex\0strcasecmp\0strncasecmp\0" },
308
309   { "strops.h", XOPEN_EXTENDED_SYMBOL, "ioctl\0" },
310
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" },
315
316   { "sys/socket.h", XOPEN_EXTENDED_SYMBOL, "socket\0" },
317
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" },
324
325 #if 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" },
329 #endif
330
331   { "sys/times.h", POSIX1_SYMBOL, "times\0" },
332   /* "sys/types.h" add types (not in old g++-include) */
333
334   { "sys/utsname.h", POSIX1_SYMBOL, "uname\0" },
335
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" },
340
341   { "tar.h", POSIX1_SYMBOL, NONE },
342
343   { "termios.h", POSIX1_SYMBOL,
344       "cfgetispeed\0cfgetospeed\0cfsetispeed\0cfsetospeed\0tcdrain\0tcflow\0tcflush\0tcgetattr\0tcsendbreak\0tcsetattr\0" },
345
346   { "time.h", ANSI_SYMBOL,
347       "asctime\0clock\0ctime\0difftime\0gmtime\0localtime\0mktime\0strftime\0time\0" },
348   { CONTINUED, POSIX1_SYMBOL, "tzset\0" },
349
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" },
360
361   { "utime.h", POSIX1_SYMBOL, "utime\0" },
362
363   { NULL, 0, NONE }
364 };
365
366 enum special_file special_file_handling = no_special;
367
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 */
377 int seen_errno = 0;
378 /* The following are only used when handling stdlib.h */
379 int seen_EXIT_FAILURE = 0, seen_EXIT_SUCCESS = 0;
380 \f
381 struct obstack scan_file_obstack;
382
383 /* NOTE:  If you edit this, also edit gen-protos.c !! */
384
385 static struct fn_decl *
386 lookup_std_proto (const char *name, int name_length)
387 {
388   int i = hashstr (name, name_length) % HASH_SIZE;
389   int i0 = i;
390   for (;;)
391     {
392       struct fn_decl *fn;
393       if (hash_tab[i] == 0)
394         return NULL;
395       fn = &std_protos[hash_tab[i]];
396       if ((int) strlen (fn->fname) == name_length
397           && strncmp (fn->fname, name, name_length) == 0)
398         return fn;
399       i = (i+1) % HASH_SIZE;
400       if (i == i0)
401         abort ();
402     }
403 }
404
405 char *inc_filename;
406 int inc_filename_length;
407 FILE *outf;
408 sstring line;
409
410 int lbrac_line, rbrac_line;
411
412 int required_unseen_count = 0;
413 int required_other = 0;
414
415 static void
416 write_lbrac (void)
417 {
418   if (partial_count)
419     {
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");
426     }
427 }
428
429 struct partial_proto
430 {
431   struct partial_proto *next;
432   struct fn_decl *fn;
433   int line_seen;
434 };
435
436 struct partial_proto *partial_proto_list = NULL;
437
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)
443
444 static void
445 recognized_macro (const char *fname)
446 {
447   /* The original include file defines fname as a macro.  */
448   struct fn_decl *fn = lookup_std_proto (fname, strlen (fname));
449
450   /* Since fname is a macro, don't require a prototype for it.  */
451   if (fn)
452     {
453       if (REQUIRED (fn))
454         required_unseen_count--;
455       SET_SEEN (fn);
456     }
457
458   switch (special_file_handling)
459     {
460     case errno_h:
461       if (strcmp (fname, "errno") == 0 && !seen_errno)
462         seen_errno = 1, required_other--;
463       break;
464     case stdlib_h:
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--;
469       break;
470     case sys_stat_h:
471       if (fname[0] == 'S' && fname[1] == '_')
472         {
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++;
485         }
486       break;
487
488     default:
489       break;
490     }
491 }
492
493 void
494 recognized_extern (const cpp_token *name)
495 {
496   switch (special_file_handling)
497     {
498     case errno_h:
499       if (cpp_ideq (name, "errno"))
500         seen_errno = 1, required_other--;
501       break;
502
503     default:
504       break;
505     }
506 }
507
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.  */
512
513 void
514 recognized_function (const cpp_token *fname, unsigned int line, int kind,
515                      int have_arg_list)
516 {
517   struct partial_proto *partial;
518   int i;
519   struct fn_decl *fn;
520
521   fn = lookup_std_proto ((const char *) NODE_NAME (fname->val.node),
522                          NODE_LEN (fname->val.node));
523
524   /* Remove the function from the list of required function.  */
525   if (fn)
526     {
527       if (REQUIRED (fn))
528         required_unseen_count--;
529       SET_SEEN (fn);
530     }
531
532   /* If we have a full prototype, we're done.  */
533   if (have_arg_list)
534     return;
535
536   if (kind == 'I')  /* don't edit inline function */
537     return;
538
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)
544     return;
545
546   if (fn == NULL)
547     return;
548   if (fn->params[0] == '\0')
549     return;
550
551   /* We only have a partial function declaration,
552      so remember that we have to add a complete prototype.  */
553   partial_count++;
554   partial = obstack_alloc (&scan_file_obstack, sizeof (struct partial_proto));
555   partial->line_seen = line;
556   partial->fn = fn;
557   fn->partial = partial;
558   partial->next = partial_proto_list;
559   partial_proto_list = partial;
560   if (verbose)
561     {
562       fprintf (stderr, "(%s: %s non-prototype function declaration.)\n",
563                inc_filename, fn->fname);
564     }
565 }
566
567 /* For any name in NAMES that is defined as a macro,
568    call recognized_macro on it.  */
569
570 static void
571 check_macro_names (cpp_reader *pfile, namelist names)
572 {
573   size_t len;
574   while (*names)
575     {
576       len = strlen (names);
577       if (cpp_defined (pfile, (const unsigned char *)names, len))
578         recognized_macro (names);
579       names += len + 1;
580     }
581 }
582
583 static void
584 cb_file_change (cpp_reader *pfile ATTRIBUTE_UNUSED,
585                 const struct line_map *map)
586 {
587   /* Just keep track of current file name.  */
588   cur_file = map == NULL ? NULL : map->to_file;
589 }
590
591 static void
592 read_scan_file (char *in_fname, int argc, char **argv)
593 {
594   cpp_reader *scan_in;
595   cpp_callbacks *cb;
596   cpp_options *options;
597   struct fn_decl *fn;
598   int i, strings_processed;
599   struct symbol_list *cur_symbols;
600
601   obstack_init (&scan_file_obstack);
602
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;
607
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);
614
615   if (!cpp_read_main_file (scan_in, in_fname))
616     exit (FATAL_EXIT_CODE);
617
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);
621
622   /* Process switches after builtins so -D can override them.  */
623   for (i = 0; i < argc; i += strings_processed)
624     {
625       strings_processed = 0;
626       if (argv[i][0] == '-')
627         {
628           if (argv[i][1] == 'I')
629             {
630               if (argv[i][2] != '\0')
631                 {
632                   strings_processed = 1;
633                   add_path (xstrdup (argv[i] + 2), BRACKET, false, false);
634                 }
635               else if (i + 1 != argc)
636                 {
637                   strings_processed = 2;
638                   add_path (xstrdup (argv[i + 1]), BRACKET, false, false);
639                 }
640             }
641           else if (argv[i][1] == 'D')
642             {
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]);
647             }
648         }
649
650       if (strings_processed == 0)
651         break;
652     }
653
654   if (i < argc)
655     cpp_error (scan_in, CPP_DL_ERROR, "invalid option `%s'", argv[i]);
656   if (cpp_errors (scan_in))
657     exit (FATAL_EXIT_CODE);
658
659   register_include_chains (scan_in, NULL /* sysroot */, NULL /* iprefix */,
660                            true /* stdinc */, false /* cxx_stdinc */,
661                            false /* verbose */);
662
663   /* We are scanning a system header, so mark it as such.  */
664   cpp_make_system_header (scan_in, 1, 0);
665
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);
669
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)
674     {
675       unsigned char getchar_call[] = "getchar();\n";
676       int seen_filbuf = 0;
677
678       /* Scan the macro expansion of "getchar();".  */
679       cpp_push_buffer (scan_in, getchar_call, sizeof(getchar_call) - 1,
680                        /* from_stage3 */ true);
681       for (;;)
682         {
683           const cpp_token *t = cpp_get_token (scan_in);
684
685           if (t->type == CPP_EOF)
686             break;
687           else if (cpp_ideq (t, "_filbuf"))
688             seen_filbuf++;
689         }
690
691       if (seen_filbuf)
692         {
693           int need_filbuf = !SEEN (fn) && !REQUIRED (fn);
694           struct fn_decl *flsbuf_fn = lookup_std_proto ("_flsbuf", 7);
695           int need_flsbuf
696             = flsbuf_fn && !SEEN (flsbuf_fn) && !REQUIRED (flsbuf_fn);
697
698           /* Append "_filbuf" and/or "_flsbuf" to the required functions.  */
699           if (need_filbuf + need_flsbuf)
700             {
701               const char *new_list;
702               if (need_filbuf)
703                 SET_REQUIRED (fn);
704               if (need_flsbuf)
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;
714             }
715         }
716     }
717
718   if (required_unseen_count + partial_count + required_other == 0)
719     {
720       if (verbose)
721         fprintf (stderr, "%s: OK, nothing needs to be done.\n", inc_filename);
722       exit (SUCCESS_EXIT_CODE);
723     }
724   if (!verbose)
725     fprintf (stderr, "%s: fixing %s\n", progname, inc_filename);
726   else
727     {
728       if (required_unseen_count)
729         fprintf (stderr, "%s: %d missing function declarations.\n",
730                  inc_filename, required_unseen_count);
731       if (partial_count)
732         fprintf (stderr, "%s: %d non-prototype function declarations.\n",
733                  inc_filename, partial_count);
734     }
735 }
736
737 static void
738 write_rbrac (void)
739 {
740   struct fn_decl *fn;
741   const char *cptr;
742   struct symbol_list *cur_symbols;
743
744   if (required_unseen_count)
745     {
746 #ifdef NO_IMPLICIT_EXTERN_C
747       fprintf (outf, "#ifdef __cplusplus\nextern \"C\" {\n#endif\n");
748 #endif
749     }
750
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++)
753     {
754       int if_was_emitted = 0;
755       int name_len;
756       cptr = cur_symbols->names;
757       for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
758         {
759           int macro_protect = 0;
760
761           if (cur_symbols->flags & MACRO_SYMBOL)
762             continue;
763
764           fn = lookup_std_proto (cptr, name_len);
765           if (fn == NULL || !REQUIRED (fn))
766             continue;
767
768           if (!if_was_emitted)
769             {
770 /*            what about curses. ??? or _flsbuf/_filbuf ??? */
771               if (cur_symbols->flags & ANSI_SYMBOL)
772                 fprintf (outf,
773          "#if defined(__USE_FIXED_PROTOTYPES__) || defined(__cplusplus) || defined (__STRICT_ANSI__)\n");
774               else if (cur_symbols->flags & (POSIX1_SYMBOL|POSIX2_SYMBOL))
775                 fprintf (outf,
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)
780                 {
781                 fprintf (outf,
782        "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
783    || (defined(__STRICT_ANSI__) && defined(_XOPEN_SOURCE))\n");
784                 }
785               else if (cur_symbols->flags & XOPEN_EXTENDED_SYMBOL)
786                 {
787                 fprintf (outf,
788        "#if defined(__USE_FIXED_PROTOTYPES__) \\\n\
789    || (defined(__STRICT_ANSI__) && defined(_XOPEN_EXTENDED_SOURCE))\n");
790                 }
791               else
792                 {
793                   fatal ("internal error for function %s", fn->fname);
794                 }
795               if_was_emitted = 1;
796             }
797
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"))
808             macro_protect = 1;
809
810           if (macro_protect)
811             fprintf (outf, "#ifndef %s\n", fn->fname);
812           fprintf (outf, "extern %s %s (%s);\n",
813                    fn->rtype, fn->fname, fn->params);
814           if (macro_protect)
815             fprintf (outf, "#endif\n");
816         }
817       if (if_was_emitted)
818         fprintf (outf,
819                  "#endif /* defined(__USE_FIXED_PROTOTYPES__) || ... */\n");
820     }
821   if (required_unseen_count)
822     {
823 #ifdef NO_IMPLICIT_EXTERN_C
824       fprintf (outf, "#ifdef __cplusplus\n}\n#endif\n");
825 #endif
826     }
827
828   switch (special_file_handling)
829     {
830     case errno_h:
831       if (!seen_errno)
832         fprintf (outf, "extern int errno;\n");
833       break;
834     case stdlib_h:
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");
839       break;
840     case sys_stat_h:
841       if (!seen_S_ISBLK && seen_S_IFBLK)
842         fprintf (outf,
843                  "#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK)\n");
844       if (!seen_S_ISCHR && seen_S_IFCHR)
845         fprintf (outf,
846                  "#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)\n");
847       if (!seen_S_ISDIR && seen_S_IFDIR)
848         fprintf (outf,
849                  "#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)\n");
850       if (!seen_S_ISFIFO && seen_S_IFIFO)
851         fprintf (outf,
852                  "#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)\n");
853       if (!seen_S_ISLNK && seen_S_IFLNK)
854         fprintf (outf,
855                  "#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK)\n");
856       if (!seen_S_ISREG && seen_S_IFREG)
857         fprintf (outf,
858                  "#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)\n");
859       break;
860
861     default:
862       break;
863     }
864
865 }
866
867 /* Returns 1 iff the file is properly protected from multiple inclusion:
868    #ifndef PROTECT_NAME
869    #define PROTECT_NAME
870    #endif
871
872  */
873
874 #define INF_GET() (inf_ptr < inf_limit ? *(unsigned char *) inf_ptr++ : EOF)
875 #define INF_UNGET(c) ((c)!=EOF && inf_ptr--)
876
877 static int
878 inf_skip_spaces (int c)
879 {
880   for (;;)
881     {
882       if (c == ' ' || c == '\t')
883         c = INF_GET ();
884       else if (c == '/')
885         {
886           c = INF_GET ();
887           if (c != '*')
888             {
889               (void) INF_UNGET (c);
890               return '/';
891             }
892           c = INF_GET ();
893           for (;;)
894             {
895               if (c == EOF)
896                 return EOF;
897               else if (c != '*')
898                 {
899                   if (c == '\n')
900                     source_lineno++, lineno++;
901                   c = INF_GET ();
902                 }
903               else if ((c = INF_GET ()) == '/')
904                 return INF_GET ();
905             }
906         }
907       else
908         break;
909     }
910   return c;
911 }
912
913 /* Read into STR from inf_buffer upto DELIM.  */
914
915 static int
916 inf_read_upto (sstring *str, int delim)
917 {
918   int ch;
919   for (;;)
920     {
921       ch = INF_GET ();
922       if (ch == EOF || ch == delim)
923         break;
924       SSTRING_PUT (str, ch);
925     }
926   MAKE_SSTRING_SPACE (str, 1);
927   *str->ptr = 0;
928   return ch;
929 }
930
931 static int
932 inf_scan_ident (sstring *s, int c)
933 {
934   s->ptr = s->base;
935   if (ISIDST (c))
936     {
937       for (;;)
938         {
939           SSTRING_PUT (s, c);
940           c = INF_GET ();
941           if (c == EOF || !(ISIDNUM (c)))
942             break;
943         }
944     }
945   MAKE_SSTRING_SPACE (s, 1);
946   *s->ptr = 0;
947   return c;
948 }
949
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.  */
954
955 static int
956 check_protection (int *ifndef_line, int *endif_line)
957 {
958   int c;
959   int if_nesting = 1; /* Level of nesting of #if's */
960   char *protect_name = NULL; /* Identifier following initial #ifndef */
961   int define_seen = 0;
962
963   /* Skip initial white space (including comments).  */
964   for (;; lineno++)
965     {
966       c = inf_skip_spaces (' ');
967       if (c == EOF)
968         return 0;
969       if (c != '\n')
970         break;
971     }
972   if (c != '#')
973     return 0;
974   c = inf_scan_ident (&buf, inf_skip_spaces (' '));
975   if (SSTRING_LENGTH (&buf) == 0 || strcmp (buf.base, "ifndef") != 0)
976     return 0;
977
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)
982     return 0;
983   protect_name = xstrdup (buf.base);
984
985   (void) INF_UNGET (c);
986   c = inf_read_upto (&buf, '\n');
987   if (c == EOF)
988     return 0;
989   lineno++;
990
991   for (;;)
992     {
993       c = inf_skip_spaces (' ');
994       if (c == EOF)
995         return 0;
996       if (c == '\n')
997         {
998           lineno++;
999           continue;
1000         }
1001       if (c != '#')
1002         goto skip_to_eol;
1003       c = inf_scan_ident (&buf, inf_skip_spaces (' '));
1004       if (SSTRING_LENGTH (&buf) == 0)
1005         ;
1006       else if (!strcmp (buf.base, "ifndef")
1007           || !strcmp (buf.base, "ifdef") || !strcmp (buf.base, "if"))
1008         {
1009           if_nesting++;
1010         }
1011       else if (!strcmp (buf.base, "endif"))
1012         {
1013           if_nesting--;
1014           if (if_nesting == 0)
1015             break;
1016         }
1017       else if (!strcmp (buf.base, "else"))
1018         {
1019           if (if_nesting == 1)
1020             return 0;
1021         }
1022       else if (!strcmp (buf.base, "define"))
1023         {
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)
1027             define_seen = 1;
1028         }
1029     skip_to_eol:
1030       for (;;)
1031         {
1032           if (c == '\n' || c == EOF)
1033             break;
1034           c = INF_GET ();
1035         }
1036       if (c == EOF)
1037         return 0;
1038       lineno++;
1039     }
1040
1041   if (!define_seen)
1042      return 0;
1043   *endif_line = lineno;
1044   /* Skip final white space (including comments).  */
1045   for (;;)
1046     {
1047       c = inf_skip_spaces (' ');
1048       if (c == EOF)
1049         break;
1050       if (c != '\n')
1051         return 0;
1052     }
1053
1054   return 1;
1055 }
1056
1057 extern int main (int, char **);
1058
1059 int
1060 main (int argc, char **argv)
1061 {
1062   int inf_fd;
1063   struct stat sbuf;
1064   int c;
1065 #ifdef FIXPROTO_IGNORE_LIST
1066   int i;
1067 #endif
1068   const char *cptr;
1069   int ifndef_line;
1070   int endif_line;
1071   long to_read;
1072   long int inf_size;
1073   struct symbol_list *cur_symbols;
1074
1075   progname = "fix-header";
1076   if (argv[0] && argv[0][0])
1077     {
1078       char *p;
1079
1080       progname = 0;
1081       for (p = argv[0]; *p; p++)
1082         if (*p == '/')
1083           progname = p;
1084       progname = progname ? progname+1 : argv[0];
1085     }
1086
1087   if (argc < 4)
1088     {
1089       fprintf (stderr, "%s: Usage: foo.h infile.h outfile.h options\n",
1090                progname);
1091       exit (FATAL_EXIT_CODE);
1092     }
1093
1094   inc_filename = argv[1];
1095   inc_filename_length = strlen (inc_filename);
1096
1097 #ifdef FIXPROTO_IGNORE_LIST
1098   for (i = 0; files_to_ignore[i] != NULL; i++)
1099     {
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)
1103         {
1104           if (ignore_name[ignore_len-1] == '/'
1105               || inc_filename[ignore_len] == '\0')
1106             {
1107               if (verbose)
1108                 fprintf (stderr, "%s: ignoring %s\n", progname, inc_filename);
1109               exit (SUCCESS_EXIT_CODE);
1110             }
1111         }
1112
1113     }
1114 #endif
1115
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))
1128     include_entry++;
1129
1130   if (include_entry->name != NULL)
1131     {
1132       const struct std_include_entry *entry;
1133       cur_symbol_table_size = 0;
1134       for (entry = include_entry; ;)
1135         {
1136           if (entry->flags)
1137             add_symbols (entry->flags, entry->names);
1138           entry++;
1139           if (!entry->name || strcmp (entry->name, CONTINUED) != 0)
1140             break;
1141         }
1142     }
1143   else
1144     symbol_table[0].names = NULL;
1145
1146   /* Count and mark the prototypes required for this include file.  */
1147   for (cur_symbols = &symbol_table[0]; cur_symbols->names; cur_symbols++)
1148     {
1149       int name_len;
1150       if (cur_symbols->flags & MACRO_SYMBOL)
1151         continue;
1152       cptr = cur_symbols->names;
1153       for ( ; (name_len = strlen (cptr)) != 0; cptr+= name_len + 1)
1154         {
1155           struct fn_decl *fn = lookup_std_proto (cptr, name_len);
1156           required_unseen_count++;
1157           if (fn == NULL)
1158             fprintf (stderr, "Internal error:  No prototype for %s\n", cptr);
1159           else
1160             SET_REQUIRED (fn);
1161         }
1162     }
1163
1164   read_scan_file (argv[2], argc - 4, argv + 4);
1165
1166   inf_fd = open (argv[2], O_RDONLY, 0666);
1167   if (inf_fd < 0)
1168     {
1169       fprintf (stderr, "%s: Cannot open '%s' for reading -",
1170                progname, argv[2]);
1171       perror (NULL);
1172       exit (FATAL_EXIT_CODE);
1173     }
1174   if (fstat (inf_fd, &sbuf) < 0)
1175     {
1176       fprintf (stderr, "%s: Cannot get size of '%s' -", progname, argv[2]);
1177       perror (NULL);
1178       exit (FATAL_EXIT_CODE);
1179     }
1180   inf_size = sbuf.st_size;
1181   inf_buffer = xmalloc (inf_size + 2);
1182   inf_ptr = inf_buffer;
1183
1184   to_read = inf_size;
1185   while (to_read > 0)
1186     {
1187       long i = read (inf_fd, inf_buffer + inf_size - to_read, to_read);
1188       if (i < 0)
1189         {
1190           fprintf (stderr, "%s: Failed to read '%s' -", progname, argv[2]);
1191           perror (NULL);
1192           exit (FATAL_EXIT_CODE);
1193         }
1194       if (i == 0)
1195         {
1196           inf_size -= to_read;
1197           break;
1198         }
1199       to_read -= i;
1200     }
1201
1202   close (inf_fd);
1203
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;
1208
1209   /* If file doesn't end with '\n', add one.  */
1210   if (inf_limit > inf_buffer && inf_limit[-1] != '\n')
1211     inf_limit++;
1212
1213   unlink (argv[3]);
1214   outf = fopen (argv[3], "w");
1215   if (outf == NULL)
1216     {
1217       fprintf (stderr, "%s: Cannot open '%s' for writing -",
1218                progname, argv[3]);
1219       perror (NULL);
1220       exit (FATAL_EXIT_CODE);
1221     }
1222
1223   lineno = 1;
1224
1225   if (check_protection (&ifndef_line, &endif_line))
1226     {
1227       lbrac_line = ifndef_line+1;
1228       rbrac_line = endif_line;
1229     }
1230   else
1231     {
1232       lbrac_line = 1;
1233       rbrac_line = -1;
1234     }
1235
1236   /* Reset input file.  */
1237   inf_ptr = inf_buffer;
1238   lineno = 1;
1239
1240   for (;;)
1241     {
1242       if (lineno == lbrac_line)
1243         write_lbrac ();
1244       if (lineno == rbrac_line)
1245         write_rbrac ();
1246       for (;;)
1247         {
1248           struct fn_decl *fn;
1249           c = INF_GET ();
1250           if (c == EOF)
1251             break;
1252           if (ISIDST (c))
1253             {
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)
1262                 {
1263                   c = inf_skip_spaces (' ');
1264                   if (c == EOF)
1265                     break;
1266                   if (c == '(')
1267                     {
1268                       c = inf_skip_spaces (' ');
1269                       if (c == ')')
1270                         {
1271                           fprintf (outf, " _PARAMS((%s))", fn->params);
1272                         }
1273                       else
1274                         {
1275                           putc ('(', outf);
1276                           (void) INF_UNGET (c);
1277                         }
1278                     }
1279                   else
1280                     fprintf (outf, " %c", c);
1281                 }
1282             }
1283           else
1284             {
1285               putc (c, outf);
1286               if (c == '\n')
1287                 break;
1288             }
1289         }
1290       if (c == EOF)
1291         break;
1292       lineno++;
1293     }
1294   if (rbrac_line < 0)
1295     write_rbrac ();
1296
1297   fclose (outf);
1298
1299   return 0;
1300 }