gcc/fixproto

   1 #!/bin/sh
   2 #
   3 # SYNOPSIS
   4 #       fixproto TARGET-DIR SOURCE-DIR-ALL SOURCE-DIR-STD
   5 #
   6 # COPYRIGHT
   7 #       Copyright (C) 1993 Free Software Foundation, Inc.
   8 #       This file is part of GNU CC.
   9 #
  10 #       GNU CC is free software; you can redistribute it and/or modify
  11 #       it under the terms of the GNU General Public License as published by
  12 #       the Free Software Foundation; either version 2, or (at your option)
  13 #       any later version.
  14 #
  15 #       GNU CC is distributed in the hope that it will be useful,
  16 #       but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 #       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 #       GNU General Public License for more details.
  19 #
  20 #       You should have received a copy of the GNU General Public License
  21 #       along with GNU CC; see the file COPYING.  If not, write to
  22 #       the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23 #
  24 # DESCRIPTION
  25 #       Adjunct script for GNU CC to populate a directory with ANSI,
  26 #       Posix.1, and C++ compatible header files.
  27 #
  28 #       Each file found under SOURCE-DIR-ALL is analyzed and "fixed."
  29 #       Only standard ANSI/POSIX files found under SOURCE-DIR-STD
  30 #       are analyzed and "fixed."
  31 #       The SOURCE-DIRs are searched in order; a file found
  32 #       under multiple SOURCE-DIRs is only handled for the first one.
  33 #
  34 # STRATEGY
  35 #       Each include file is fed through cpp, and the scan-decls program
  36 #       parses it, and emits any found function declarations.
  37 #       The fix-header program analyzes the scan-decls output,
  38 #       together with the original include file, and writes a "fixed"
  39 #       include file, if needed.
  40 #
  41 #       The comment at the beginning of fix-header.c lists specifically
  42 #       what kind of changes are made.
  43 #
  44 # NOTE
  45 #       Some file space will be wasted, because the original header
  46 #       files are copied.  An earlier version just included the original
  47 #       by "reference", using GNU cpp's #include_next mechanism.
  48 #       This is currently not done, partly because #include_next is
  49 #       fragile (susceptible to version incompatibilties, and depends
  50 #       and GCC-specific features), and partly for performance reasons.
  51 #
  52 # AUTHORS
  53 #       Ron Guilmette (rfg@netcom.com) (original idea and code)
  54 #       Per Bothner (bothner@cygnus.com) (major re-write)
  55
  56 progname=$0
  57 progname=`basename $progname`
  58 original_dir=`pwd`
  59 CPP=${CPP-./cpp}
  60
  61 if [ `echo $1 | wc -w` = 0 ] ; then
  62   echo $progname\: usage\: $progname target-dir \[ source-dir \.\.\. \]
  63   exit 1
  64 fi
  65
  66 std_files="ctype.h dirent.h errno.h curses.h fcntl.h grp.h locale.h math.h pwd.h setjmp.h signal.h stdio.h stdlib.h string.h sys/stat.h sys/times.h sys/resource.h sys/utsname.h sys/wait.h tar.h termios.h time.h unistd.h"
  67
  68 rel_target_dir=$1
  69 # All files in $src_dir_all (normally same as $rel_target_dir) are
  70 # processed.
  71 src_dir_all=$2
  72 # In $src_dir_std (normally same as /usr/include), only the
  73 # "standard" ANSI/POSIX files listed in $std_files are processed.
  74 src_dir_std=$3
  75
  76 if [ `expr $rel_target_dir : '\(.\)'` != '/' ] ; then
  77   abs_target_dir=$original_dir/$rel_target_dir
  78 else
  79   abs_target_dir=$rel_target_dir
  80 fi
  81
  82 # Determine whether this system has symbolic links.
  83 if ln -s X $rel_target_dir/ShouldNotExist 2>/dev/null; then
  84   rm -f $rel_target_dir/ShouldNotExist
  85   LINKS=true
  86 elif ln -s X /tmp/ShouldNotExist 2>/dev/null; then
  87   rm -f /tmp/ShouldNotExist
  88   LINKS=true
  89 else
  90   LINKS=false
  91 fi
  92
  93 if [ \! -d $abs_target_dir ] ; then
  94   echo $progname\: creating directory $rel_target_dir
  95   mkdir $abs_target_dir
  96 fi
  97
  98 echo $progname\: populating \`$rel_target_dir\'
  99
 100 include_path=""
 101
 102 if [ `echo $* | wc -w` != 0 ] ; then
 103   for rel_source_dir in $src_dir_all $src_dir_std; do
 104     if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 105       abs_source_dir=$original_dir/$rel_source_dir
 106     else
 107       abs_source_dir=$rel_source_dir
 108     fi
 109     include_path="$include_path -I$abs_source_dir"
 110   done
 111 fi
 112
 113 required_stdlib_h="abort abs atexit atof atoi atol bsearch calloc exit free getenv labs malloc qsort rand realloc srand strtod strtol strtoul system"
 114 # "div ldiv", - ignored because these depend on div_t, ldiv_t
 115 # ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
 116 # Should perhaps also add NULL
 117 required_unistd_h="_exit access alarm chdir chown close ctermid cuserid dup dup2 execl execle execlp execv execve execvp fork fpathconf getcwd getegid geteuid getgid getgroups getlogin getpgrp getpid getppid getuid isatty link lseek pathconf pause pipe read rmdir setgid setpgid setsid setuid sleep sysconf tcgetpgrp tcsetpgrp ttyname unlink write"
 118
 119 done_dirs=""
 120 echo "" >fixproto.list
 121
 122 for code in ALL STD ; do
 123
 124   subdirs="."
 125
 126   case $code in
 127     ALL)
 128       rel_source_dir=$src_dir_all
 129
 130       dirs="."
 131       levels=2
 132       while $LINKS && test -n "$dirs" -a $levels -gt 0
 133       do
 134         levels=`expr $levels - 1`
 135         newdirs=
 136         for d in $dirs ; do
 137           # Find all directories under $d, relative to $d, excluding $d itself.
 138           subdirs="$subdirs "`cd $rel_source_dir/$d; find . -type d -print | \
 139                    sed -e '/^\.$/d' -e "s|^\./|${d}/|" -e 's|^\./||'`
 140           links=
 141           links=`cd $rel_source_dir; find $d/. -type l -print | \
 142                        sed -e "s|$d/./|$d/|" -e 's|^\./||'`
 143           for link in $links --dummy-- ; do
 144             test -d $rel_source_dir/$link/. && newdirs="$newdirs $link"
 145           done
 146         done
 147         dirs="$newdirs"
 148         subdirs="$subdirs $newdirs"
 149       done
 150       ;;
 151     STD)
 152       rel_source_dir=$src_dir_std
 153       ;;
 154   esac
 155
 156   if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 157     abs_source_dir=$original_dir/$rel_source_dir
 158   else
 159     abs_source_dir=$rel_source_dir
 160   fi
 161
 162   if [ \! -d $abs_source_dir ] ; then
 163     echo $progname\: warning\: no such directory\: \`$rel_source_dir\'
 164     continue
 165   fi
 166
 167   for rel_source_subdir in $subdirs; do
 168
 169       abs_target_subdir=${abs_target_dir}/${rel_source_subdir}
 170       if [ \! -d $abs_target_subdir ] ; then
 171         mkdir $abs_target_subdir
 172       fi
 173       # Append "/"; remove initial "./". Hence "." -> "" and "sys" -> "sys/".
 174       rel_source_prefix=`echo $rel_source_subdir | sed -e 's|$|/|' -e 's|^./||'`
 175
 176       case $code in
 177         ALL)
 178           # The 'sed' is in case the *.h matches nothing, which yields "*.h"
 179           # which would then get re-globbed in the current directory.  Sigh.
 180           rel_source_files=`cd ${abs_source_dir}/${rel_source_subdir}; echo *.h | sed -e 's|[*].h|NONE|'`
 181           ;;
 182
 183         STD)
 184           files_to_check="$std_files"
 185           rel_source_files=""
 186
 187           # Also process files #included by the $std_files.
 188           while [ -n "${files_to_check}" ]
 189           do
 190             new_files_to_check=""
 191             for file in $files_to_check ; do
 192               case " $rel_source_files " in
 193                 *" ${file} "*)
 194                   # Already seen $file; nothing to do
 195                   ;;
 196                 *)
 197                   new_files_to_check="$new_files_to_check `sed -n \
 198                         -e 's@  @ @g' \
 199                         -e 's@^ *# *include *<\([^>]*\)>.*$@\1@p' \
 200                         -e 's@^ *# *include *\"\([^\"]*\)\".*$@\1@p' \
 201                         <$src_dir_std/$file`"
 202                   rel_source_files="$rel_source_files $file"
 203                   ;;
 204               esac
 205             done
 206             files_to_check="$new_files_to_check"
 207           done
 208           rel_source_files="$rel_source_files"
 209           ;;
 210       esac
 211
 212       for filename in $rel_source_files ; do
 213         rel_source_file=${rel_source_prefix}${filename}
 214         abs_source_file=$abs_source_dir/$rel_source_file
 215         abs_target_file=$abs_target_dir/$rel_source_file
 216
 217         if test "$filename" = 'NONE' ; then
 218           echo "(No *.h files in $abs_source_dir/$rel_source_subdir)"
 219         # If target file exists, check if was written while processing one
 220         # of the earlier source directories;  if so ignore it.
 221         elif test -f $abs_target_file -a -n "$done_dirs" \
 222           && grep "$rel_source_file" fixproto.list >/dev/null
 223         then true
 224         else
 225           # echo doing $rel_source_file from $abs_source_dir
 226           required_list=
 227           extra_check_list=
 228           case $rel_source_file in
 229             ctype.h)
 230               required_list="isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper" ;;
 231             dirent.h)
 232               required_list="closedir opendir readdir rewinddir" ;;
 233             errno.h)
 234               extra_check_list="errno" ;;
 235             curses.h)
 236               required_list="box delwin endwin getcurx getcury initscr mvcur mvwprintw mvwscanw newwin overlay overwrite scroll subwin touchwin waddstr wclear wclrtobot wclrtoeol waddch wdelch wdeleteln werase wgetch wgetstr winsch winsertln wmove wprintw wrefresh wscanw wstandend wstandout" ;;
 237             fcntl.h)
 238               required_list="creat fcntl open" ;;
 239             grp.h)
 240               #Maybe also "getgrent fgetgrent setgrent endgrent" */
 241               required_list="getgrgid getgrnam" ;;
 242             limit.h)
 243               required_list= /* Lots of macros */ ;;
 244             locale.h)
 245               required_list="localeconv setlocale" ;;
 246             math.h)
 247               required_list="acos asin atan atan2 ceil cos cosh exp fabs floor fmod frexp ldexp log10 log modf pow sin sinh sqrt tan tanh"
 248               extra_check_list="HUGE_VAL" ;;
 249             pwd.h)
 250               required_list="getpwnam getpwuid" ;;
 251             setjmp.h)
 252               # Left out siglongjmp sigsetjmp - these depend on sigjmp_buf.
 253               required_list="longjmp setjmp" ;;
 254             signal.h)
 255               # Left out signal() - its prototype is too complex for us!
 256               # Also left out "sigaction sigaddset sigdelset sigemptyset
 257               # sigfillset sigismember sigpending sigprocmask sigsuspend"
 258               # because these need sigset_t or struct sigaction.
 259               # Most systems that provide them will also declare them.
 260               required_list="kill raise" ;;
 261             stdio.h)
 262               required_list="clearerr fclose feof ferror fflush fgetc fgetpos fgets fopen fprintf fputc fputs fread freopen fscanf fseek fsetpos ftell fwrite getc getchar gets perror printf putc putchar puts remove rename rewind scanf setbuf setvbuf sprintf sscanf tmpfile tmpnam ungetc vfprintf vprintf vsprintf"
 263               if grep _flsbuf <$abs_source_file >/dev/null ; then
 264                 required_list="$required_list _flsbuf _filbuf"
 265               fi
 266               # Should perhaps also handle NULL, EOF, ... ?
 267               ;;
 268             stdlib.h)
 269               required_list="$required_stdlib_h" ;;
 270             string.h)
 271               required_list="memchr memcmp memcpy memmove memset strcat strchr strcmp strcoll strcpy strcspn strerror strlen strncat strncmp" ;;
 272 # Should perhaps also add NULL and size_t
 273             sys/stat.h)
 274               required_list="chmod fstat mkdir mkfifo stat umask"
 275               extra_check_list="S_ISDIR S_ISBLK S_ISCHR S_ISFIFO S_ISREG S_ISLNK S_IFDIR S_IFBLK S_IFCHR S_IFIFO S_IFREG S_IFLNK" ;;
 276             sys/times.h)
 277               required_list="times" ;;
 278 # "sys/types.h" add types (not in old g++-include)
 279             sys/utsname.h)
 280               required_list="uname" ;;
 281             sys/wait.h)
 282               required_list="wait waitpid"
 283               extra_check_list="WEXITSTATUS WIFEXITED WIFSIGNALED WIFSTOPPED WSTOPSIG WTERMSIG WNOHANG WNOTRACED" ;;
 284             tar.h)
 285               required_list=  ;;
 286             termios.h)
 287               required_list="cfgetispeed cfgetospeed cfsetispeed cfsetospeed tcdrain tcflow tcflush tcgetattr tcsendbreak tcsetattr" ;;
 288             time.h)
 289               required_list="asctime clock ctime difftime gmtime localtime mktime strftime time tzset" ;;
 290             unistd.h)
 291               required_list="$required_unistd_h" ;;
 292           esac
 293           rm -f fixtmp.c fixtmp.i
 294           echo "#include <${rel_source_file}>" >fixtmp.c
 295           for macro in ${required_list} ${extra_check_list}
 296           do
 297             echo "#ifdef ${macro}" >>fixtmp.c
 298             echo "__DEFINED_MACRO_${macro};" >>fixtmp.c
 299             echo "#endif" >>fixtmp.c
 300           done
 301           if ${CPP} -D__STDC__ -D__cplusplus -D_POSIX_SOURCE $include_path fixtmp.c >fixtmp.i 2>/dev/null
 302           then
 303            $original_dir/fix-header $rel_source_file $abs_source_file $abs_target_file "$required_list" <fixtmp.i
 304           else
 305             echo "${progname}: cpp could not parse ${abs_source_file} (ignored)"
 306           fi
 307           echo "${rel_source_file}" >>fixproto.list
 308         fi
 309       done
 310       rm -f fixtmp.c fixtmp.i
 311     done
 312     # check for broken assert.h that needs stdio.h
 313     if test -f $abs_source_dir/assert.h -a \! -f $abs_target_dir/assert.h \
 314       && grep 'stderr' $abs_source_dir/assert.h >/dev/null
 315     then
 316       if grep 'include.*stdio.h' $abs_source_dir/assert.h >/dev/null
 317       then true
 318       else
 319         echo 'Fixing broken assert.h (needs stdio.h)'
 320         cat $abs_source_dir/assert.h >$abs_target_dir/assert.h
 321         echo '#include <stdio.h>' >>$abs_target_dir/assert.h
 322       fi
 323     fi
 324     done_dirs="$done_dir $rel_source_dir"
 325 done
 326
 327 # This might be more cleanly moved into the main loop, by adding
 328 # a <dummy> source directory at the end.  FIXME!
 329 for rel_source_file in unistd.h stdlib.h
 330 do
 331   if grep "$rel_source_file" fixproto.list >/dev/null
 332   then true
 333   else
 334     echo Adding missing $rel_source_file
 335     rel_source_ident=`echo $rel_source_file | tr ./ __`
 336     required_list=`eval echo '${required_'${rel_source_ident}'-}'`
 337     cat >tmp.h <<EOF
 338 #ifndef ${rel_source_ident}
 339 #define ${rel_source_ident}
 340 #endif
 341 EOF
 342     $original_dir/fix-header $rel_source_file tmp.h $abs_target_dir/$rel_source_file "$required_list" </dev/null
 343     rm tmp.h
 344   fi
 345 done
 346 exit 0