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           # Assume directory names ending in CC or containing ++ are
 139           # for C++, so skip those.
 140           subdirs="$subdirs "`cd $rel_source_dir/$d; find . -type d -print | \
 141                    sed -e '/^\.$/d' -e "s|^\./|${d}/|" -e 's|^\./||' \
 142                      -e '/CC$/d' -e '/\+\+/d'`
 143           links=
 144           links=`cd $rel_source_dir; find $d/. -type l -print | \
 145                        sed -e "s|$d/./|$d/|" -e 's|^\./||'`
 146           for link in $links --dummy-- ; do
 147             test -d $rel_source_dir/$link/. && newdirs="$newdirs $link"
 148           done
 149         done
 150         dirs="$newdirs"
 151         subdirs="$subdirs $newdirs"
 152       done
 153       ;;
 154     STD)
 155       rel_source_dir=$src_dir_std
 156       ;;
 157   esac
 158
 159   if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 160     abs_source_dir=$original_dir/$rel_source_dir
 161   else
 162     abs_source_dir=$rel_source_dir
 163   fi
 164
 165   if [ \! -d $abs_source_dir ] ; then
 166     echo $progname\: warning\: no such directory\: \`$rel_source_dir\'
 167     continue
 168   fi
 169
 170   for rel_source_subdir in $subdirs; do
 171
 172       abs_target_subdir=${abs_target_dir}/${rel_source_subdir}
 173       if [ \! -d $abs_target_subdir ] ; then
 174         mkdir $abs_target_subdir
 175       fi
 176       # Append "/"; remove initial "./". Hence "." -> "" and "sys" -> "sys/".
 177       rel_source_prefix=`echo $rel_source_subdir | sed -e 's|$|/|' -e 's|^./||'`
 178
 179       case $code in
 180         ALL)
 181           # The 'sed' is in case the *.h matches nothing, which yields "*.h"
 182           # which would then get re-globbed in the current directory.  Sigh.
 183           rel_source_files=`cd ${abs_source_dir}/${rel_source_subdir}; echo *.h | sed -e 's|[*].h|NONE|'`
 184           ;;
 185
 186         STD)
 187           files_to_check="$std_files"
 188           rel_source_files=""
 189
 190           # Also process files #included by the $std_files.
 191           while [ -n "${files_to_check}" ]
 192           do
 193             new_files_to_check=""
 194             for file in $files_to_check ; do
 195               xxfile=`echo $file | sed -e 's|/\([^/\.][^/\.]*\)/\.\./|/|'`
 196               # Create the dir where this file will go when fixed.
 197               xxdir=`echo ./$file | sed -e 's|/[^/]*$||'`
 198               if [ \! -d $abs_target_subdir/$xxdir ] ; then
 199                 mkdir $abs_target_subdir/$xxdir
 200               fi
 201               # Just in case we have edited out a symbolic link
 202               if [ -f $src_dir_std/$file -a -f $src_dir_std/$xxfile ] ; then
 203                 file=$xxfile
 204               fi
 205               case " $rel_source_files " in
 206                 *" ${file} "*)
 207                   # Already seen $file; nothing to do
 208                   ;;
 209                 *)
 210                   if test -f $src_dir_std/$file ; then
 211                     rel_dir=`echo $file | sed -n -e 's|^\(.*/\)[^/]*$|\1|p'`
 212                     # For #include "foo.h", that might be either "foo.h"
 213                     # or "${rel_dir}foo.h (or something bogus).
 214                     new_files_to_check="$new_files_to_check "`sed -n \
 215                         -e 's@  @ @g' \
 216                         -e 's@^ *# *include *<\([^>]*\)>.*$@\1@p' -e \
 217                         's@^ *# *include *\"\([^\"]*\)\".*$@\1 '$rel_dir'\1@p'\
 218                         <$src_dir_std/$file`
 219                     rel_source_files="$rel_source_files $file"
 220                   fi
 221                   ;;
 222               esac
 223             done
 224             files_to_check="$new_files_to_check"
 225           done
 226           rel_source_files="$rel_source_files"
 227           ;;
 228       esac
 229
 230       for filename in $rel_source_files ; do
 231         rel_source_file=${rel_source_prefix}${filename}
 232         abs_source_file=$abs_source_dir/$rel_source_file
 233         abs_target_file=$abs_target_dir/$rel_source_file
 234
 235         if test "$filename" = 'NONE' ; then
 236           echo "(No *.h files in $abs_source_dir/$rel_source_subdir)"
 237         # If target file exists, check if was written while processing one
 238         # of the earlier source directories;  if so ignore it.
 239         elif test -f $abs_target_file -a -n "$done_dirs" \
 240           && grep "$rel_source_file" fixproto.list >/dev/null
 241         then true
 242         else
 243           # echo doing $rel_source_file from $abs_source_dir
 244           required_list=
 245           extra_check_list=
 246           case $rel_source_file in
 247             ctype.h)
 248               required_list="isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper" ;;
 249             dirent.h)
 250               required_list="closedir opendir readdir rewinddir" ;;
 251             errno.h)
 252               extra_check_list="errno" ;;
 253             curses.h)
 254               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" ;;
 255             fcntl.h)
 256               required_list="creat fcntl open" ;;
 257             grp.h)
 258               #Maybe also "getgrent fgetgrent setgrent endgrent" */
 259               required_list="getgrgid getgrnam" ;;
 260             limit.h)
 261               required_list= /* Lots of macros */ ;;
 262             locale.h)
 263               required_list="localeconv setlocale" ;;
 264             math.h)
 265               required_list="acos asin atan atan2 ceil cos cosh exp fabs floor fmod frexp ldexp log10 log modf pow sin sinh sqrt tan tanh"
 266               extra_check_list="HUGE_VAL" ;;
 267             pwd.h)
 268               required_list="getpwnam getpwuid" ;;
 269             setjmp.h)
 270               # Left out siglongjmp sigsetjmp - these depend on sigjmp_buf.
 271               required_list="longjmp setjmp" ;;
 272             signal.h)
 273               # Left out signal() - its prototype is too complex for us!
 274               # Also left out "sigaction sigaddset sigdelset sigemptyset
 275               # sigfillset sigismember sigpending sigprocmask sigsuspend"
 276               # because these need sigset_t or struct sigaction.
 277               # Most systems that provide them will also declare them.
 278               required_list="kill raise" ;;
 279             stdio.h)
 280               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 vprintf vsprintf vfprintf tmpfile tmpnam ungetc"
 281               if grep '[^_a-zA-Z0-9]_flsbuf' <$abs_source_file >/dev/null; then
 282                 required_list="$required_list _flsbuf _filbuf"
 283               fi
 284               # Should perhaps also handle NULL, EOF, ... ?
 285               ;;
 286             stdlib.h)
 287               required_list="$required_stdlib_h" ;;
 288             string.h)
 289               required_list="memchr memcmp memcpy memmove memset strcat strchr strcmp strcoll strcpy strcspn strerror strlen strncat strncmp" ;;
 290 # Should perhaps also add NULL and size_t
 291             sys/stat.h)
 292               required_list="chmod fstat mkdir mkfifo stat umask"
 293               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" ;;
 294             sys/times.h)
 295               required_list="times" ;;
 296 # "sys/types.h" add types (not in old g++-include)
 297             sys/utsname.h)
 298               required_list="uname" ;;
 299             sys/wait.h)
 300               required_list="wait waitpid"
 301               extra_check_list="WEXITSTATUS WIFEXITED WIFSIGNALED WIFSTOPPED WSTOPSIG WTERMSIG WNOHANG WNOTRACED" ;;
 302             tar.h)
 303               required_list=  ;;
 304             termios.h)
 305               required_list="cfgetispeed cfgetospeed cfsetispeed cfsetospeed tcdrain tcflow tcflush tcgetattr tcsendbreak tcsetattr" ;;
 306             time.h)
 307               required_list="asctime clock ctime difftime gmtime localtime mktime strftime time tzset" ;;
 308             unistd.h)
 309               required_list="$required_unistd_h" ;;
 310           esac
 311           rm -f fixtmp.c fixtmp.i
 312           echo "#include <${rel_source_file}>" >fixtmp.c
 313           for macro in ${required_list} ${extra_check_list}
 314           do
 315             echo "#ifdef ${macro}" >>fixtmp.c
 316             echo "__DEFINED_MACRO_${macro};" >>fixtmp.c
 317             echo "#endif" >>fixtmp.c
 318           done
 319           if ${CPP} -D__STDC__ -D__cplusplus -D_POSIX_SOURCE $include_path fixtmp.c >fixtmp.i 2>/dev/null
 320           then
 321            $original_dir/fix-header $rel_source_file $abs_source_file $abs_target_file "$required_list" <fixtmp.i
 322           else
 323             echo "${progname}: cpp could not parse ${abs_source_file} (ignored)"
 324           fi
 325           echo "${rel_source_file}" >>fixproto.list
 326         fi
 327       done
 328       rm -f fixtmp.c fixtmp.i
 329     done
 330     # check for broken assert.h that needs stdio.h
 331     if test -f $abs_source_dir/assert.h -a \! -f $abs_target_dir/assert.h \
 332       && grep 'stderr' $abs_source_dir/assert.h >/dev/null
 333     then
 334       if grep 'include.*stdio.h' $abs_source_dir/assert.h >/dev/null
 335       then true
 336       else
 337         echo 'Fixing broken assert.h (needs stdio.h)'
 338         cat $abs_source_dir/assert.h >$abs_target_dir/assert.h
 339         echo '#include <stdio.h>' >>$abs_target_dir/assert.h
 340       fi
 341     fi
 342     done_dirs="$done_dir $rel_source_dir"
 343 done
 344
 345 # This might be more cleanly moved into the main loop, by adding
 346 # a <dummy> source directory at the end.  FIXME!
 347 for rel_source_file in unistd.h stdlib.h
 348 do
 349   if grep "$rel_source_file" fixproto.list >/dev/null
 350   then true
 351   else
 352     echo Adding missing $rel_source_file
 353     rel_source_ident=`echo $rel_source_file | tr ./ __`
 354     required_list=`eval echo '${required_'${rel_source_ident}'-}'`
 355     cat >tmp.h <<EOF
 356 #ifndef ${rel_source_ident}
 357 #define ${rel_source_ident}
 358 #endif
 359 EOF
 360     $original_dir/fix-header $rel_source_file tmp.h $abs_target_dir/$rel_source_file "$required_list" </dev/null
 361     rm tmp.h
 362   fi
 363 done
 364 exit 0