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, 1994 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 FIX_HEADER=${FIX_HEADER-$original_dir/fix-header}
  61 DEFINES="-D__STDC__=0 -D__cplusplus ${FIXPROTO_DEFINES}"
  62
  63 if [ `echo $1 | wc -w` = 0 ] ; then
  64   echo $progname\: usage\: $progname target-dir \[ source-dir \.\.\. \]
  65   exit 1
  66 fi
  67
  68 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"
  69
  70 rel_target_dir=$1
  71 # All files in $src_dir_all (normally same as $rel_target_dir) are
  72 # processed.
  73 src_dir_all=$2
  74 # In $src_dir_std (normally same as /usr/include), only the
  75 # "standard" ANSI/POSIX files listed in $std_files are processed.
  76 src_dir_std=$3
  77
  78 if [ `expr $rel_target_dir : '\(.\)'` != '/' ] ; then
  79   abs_target_dir=$original_dir/$rel_target_dir
  80 else
  81   abs_target_dir=$rel_target_dir
  82 fi
  83
  84 # Determine whether this system has symbolic links.
  85 if ln -s X $rel_target_dir/ShouldNotExist 2>/dev/null; then
  86   rm -f $rel_target_dir/ShouldNotExist
  87   LINKS=true
  88 elif ln -s X /tmp/ShouldNotExist 2>/dev/null; then
  89   rm -f /tmp/ShouldNotExist
  90   LINKS=true
  91 else
  92   LINKS=false
  93 fi
  94
  95 if [ \! -d $abs_target_dir ] ; then
  96   echo $progname\: creating directory $rel_target_dir
  97   mkdir $abs_target_dir
  98 fi
  99
 100 echo $progname\: populating \`$rel_target_dir\'
 101
 102 include_path=""
 103
 104 if [ `echo $* | wc -w` != 0 ] ; then
 105   for rel_source_dir in $src_dir_all $src_dir_std; do
 106     if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 107       abs_source_dir=$original_dir/$rel_source_dir
 108     else
 109       abs_source_dir=$rel_source_dir
 110     fi
 111     include_path="$include_path -I$abs_source_dir"
 112   done
 113 fi
 114
 115 required_stdlib_h="abort abs atexit atof atoi atol bsearch calloc exit free getenv labs malloc putenv qsort rand realloc srand strtod strtol strtoul system"
 116 # "div ldiv", - ignored because these depend on div_t, ldiv_t
 117 # ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
 118 # Left out getgroups, because SunOS4 has incompatible BSD and SVR4 versions.
 119 # Should perhaps also add NULL
 120 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 getlogin getopt getpgrp getpid getppid getuid isatty link lseek pathconf pause pipe read rmdir setgid setpgid setsid setuid sleep sysconf tcgetpgrp tcsetpgrp ttyname unlink write"
 121
 122 done_dirs=""
 123 echo "" >fixproto.list
 124
 125 for code in ALL STD ; do
 126
 127   subdirs="."
 128
 129   case $code in
 130     ALL)
 131       rel_source_dir=$src_dir_all
 132
 133       dirs="."
 134       levels=2
 135       while $LINKS && test -n "$dirs" -a $levels -gt 0
 136       do
 137         levels=`expr $levels - 1`
 138         newdirs=
 139         for d in $dirs ; do
 140           # Find all directories under $d, relative to $d, excluding $d itself.
 141           # Assume directory names ending in CC or containing ++ are
 142           # for C++, so skip those.
 143           subdirs="$subdirs "`cd $rel_source_dir/$d; find . -type d -print | \
 144                    sed -e '/^\.$/d' -e "s|^\./|${d}/|" -e 's|^\./||' \
 145                      -e '/CC$/d' -e '/\+\+/d'`
 146           links=
 147           links=`cd $rel_source_dir; find $d/. -type l -print | \
 148                        sed -e "s|$d/./|$d/|" -e 's|^\./||'`
 149           for link in $links --dummy-- ; do
 150             test -d $rel_source_dir/$link/. && newdirs="$newdirs $link"
 151           done
 152         done
 153         dirs="$newdirs"
 154         subdirs="$subdirs $newdirs"
 155       done
 156       ;;
 157     STD)
 158       rel_source_dir=$src_dir_std
 159       ;;
 160   esac
 161
 162   if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 163     abs_source_dir=$original_dir/$rel_source_dir
 164   else
 165     abs_source_dir=$rel_source_dir
 166   fi
 167
 168   if [ \! -d $abs_source_dir ] ; then
 169     echo $progname\: warning\: no such directory\: \`$rel_source_dir\'
 170     continue
 171   fi
 172
 173   for rel_source_subdir in $subdirs; do
 174
 175       abs_target_subdir=${abs_target_dir}/${rel_source_subdir}
 176       if [ \! -d $abs_target_subdir ] ; then
 177         mkdir $abs_target_subdir
 178       fi
 179       # Append "/"; remove initial "./". Hence "." -> "" and "sys" -> "sys/".
 180       rel_source_prefix=`echo $rel_source_subdir | sed -e 's|$|/|' -e 's|^./||'`
 181
 182       case $code in
 183         ALL)
 184           # The 'sed' is in case the *.h matches nothing, which yields "*.h"
 185           # which would then get re-globbed in the current directory.  Sigh.
 186           rel_source_files=`cd ${abs_source_dir}/${rel_source_subdir}; echo *.h | sed -e 's|[*].h|NONE|'`
 187           ;;
 188
 189         STD)
 190           files_to_check="$std_files"
 191           rel_source_files=""
 192
 193           # Also process files #included by the $std_files.
 194           while [ -n "${files_to_check}" ]
 195           do
 196             new_files_to_check=""
 197             for file in $files_to_check ; do
 198               xxfile=`echo $file | sed -e 's|/\([^/\.][^/\.]*\)/\.\./|/|'`
 199               # Create the dir where this file will go when fixed.
 200               xxdir=`echo ./$file | sed -e 's|/[^/]*$||'`
 201               if [ \! -d $abs_target_subdir/$xxdir ] ; then
 202                 mkdir $abs_target_subdir/$xxdir
 203               fi
 204               # Just in case we have edited out a symbolic link
 205               if [ -f $src_dir_std/$file -a -f $src_dir_std/$xxfile ] ; then
 206                 file=$xxfile
 207               fi
 208               case " $rel_source_files " in
 209                 *" ${file} "*)
 210                   # Already seen $file; nothing to do
 211                   ;;
 212                 *)
 213                   if test -f $src_dir_std/$file ; then
 214                     rel_dir=`echo $file | sed -n -e 's|^\(.*/\)[^/]*$|\1|p'`
 215                     # For #include "foo.h", that might be either "foo.h"
 216                     # or "${rel_dir}foo.h (or something bogus).
 217                     new_files_to_check="$new_files_to_check "`sed -n \
 218                         -e 's@  @ @g' \
 219                         -e 's@^ *# *include *<\([^>]*\)>.*$@\1@p' -e \
 220                         's@^ *# *include *\"\([^\"]*\)\".*$@\1 '$rel_dir'\1@p'\
 221                         <$src_dir_std/$file`
 222                     rel_source_files="$rel_source_files $file"
 223                   fi
 224                   ;;
 225               esac
 226             done
 227             files_to_check="$new_files_to_check"
 228           done
 229           rel_source_files="$rel_source_files"
 230           ;;
 231       esac
 232
 233       for filename in $rel_source_files ; do
 234         rel_source_file=${rel_source_prefix}${filename}
 235         abs_source_file=$abs_source_dir/$rel_source_file
 236         abs_target_file=$abs_target_dir/$rel_source_file
 237
 238         if test "$filename" = 'NONE' ; then
 239           echo "(No *.h files in $abs_source_dir/$rel_source_subdir)"
 240         # If target file exists, check if was written while processing one
 241         # of the earlier source directories;  if so ignore it.
 242         elif test -f $abs_target_file -a -n "$done_dirs" \
 243           && grep "$rel_source_file" fixproto.list >/dev/null
 244         then true
 245         else
 246           # echo doing $rel_source_file from $abs_source_dir
 247           required_list=
 248           extra_check_list=
 249           case $rel_source_file in
 250             ctype.h)
 251               required_list="isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper" ;;
 252             dirent.h)
 253               required_list="closedir opendir readdir rewinddir" ;;
 254             errno.h)
 255               extra_check_list="errno" ;;
 256             curses.h)
 257               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" ;;
 258             fcntl.h)
 259               required_list="creat fcntl open" ;;
 260             grp.h)
 261               #Maybe also "getgrent fgetgrent setgrent endgrent" */
 262               required_list="getgrgid getgrnam" ;;
 263             limit.h)
 264               required_list= /* Lots of macros */ ;;
 265             locale.h)
 266               required_list="localeconv setlocale" ;;
 267             math.h)
 268               required_list="acos asin atan atan2 ceil cos cosh exp fabs floor fmod frexp ldexp log10 log modf pow sin sinh sqrt tan tanh"
 269               extra_check_list="HUGE_VAL" ;;
 270             pwd.h)
 271               required_list="getpwnam getpwuid" ;;
 272             setjmp.h)
 273               # Left out siglongjmp sigsetjmp - these depend on sigjmp_buf.
 274               required_list="longjmp setjmp" ;;
 275             signal.h)
 276               # Left out signal() - its prototype is too complex for us!
 277               # Also left out "sigaction sigaddset sigdelset sigemptyset
 278               # sigfillset sigismember sigpending sigprocmask sigsuspend"
 279               # because these need sigset_t or struct sigaction.
 280               # Most systems that provide them will also declare them.
 281               required_list="kill raise" ;;
 282             stdio.h)
 283               required_list="clearerr fclose feof ferror fflush fgetc fgetpos fgets fopen fprintf fputc fputs fread freopen fscanf fseek fsetpos ftell fwrite getc getchar gets pclose perror popen printf putc putchar puts remove rename rewind scanf setbuf setvbuf sprintf sscanf vprintf vsprintf vfprintf tmpfile tmpnam ungetc"
 284               if grep '[^_a-zA-Z0-9]_flsbuf' <$abs_source_file >/dev/null; then
 285                 required_list="$required_list _flsbuf _filbuf"
 286               fi
 287               # Should perhaps also handle NULL, EOF, ... ?
 288               ;;
 289             stdlib.h)
 290               required_list="$required_stdlib_h" ;;
 291             string.h)
 292               required_list="memchr memcmp memcpy memmove memset strcat strchr strcmp strcoll strcpy strcspn strerror strlen strncat strncmp strncpy strpbrk strrchr strspn strstr strtok strxfrm" ;;
 293 # Should perhaps also add NULL and size_t
 294             sys/stat.h)
 295               required_list="chmod fstat mkdir mkfifo stat lstat umask"
 296               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" ;;
 297             sys/times.h)
 298               required_list="times" ;;
 299 # "sys/types.h" add types (not in old g++-include)
 300             sys/utsname.h)
 301               required_list="uname" ;;
 302             sys/wait.h)
 303               required_list="wait waitpid"
 304               extra_check_list="WEXITSTATUS WIFEXITED WIFSIGNALED WIFSTOPPED WSTOPSIG WTERMSIG WNOHANG WNOTRACED" ;;
 305             tar.h)
 306               required_list=  ;;
 307             termios.h)
 308               required_list="cfgetispeed cfgetospeed cfsetispeed cfsetospeed tcdrain tcflow tcflush tcgetattr tcsendbreak tcsetattr" ;;
 309             time.h)
 310               required_list="asctime clock ctime difftime gmtime localtime mktime strftime time tzset" ;;
 311             unistd.h)
 312               required_list="$required_unistd_h" ;;
 313           esac
 314           rm -f fixtmp.c fixtmp.i
 315           echo "#include <${rel_source_file}>" >fixtmp.c
 316           for macro in ${required_list} ${extra_check_list}
 317           do
 318             echo "#ifdef ${macro}" >>fixtmp.c
 319             echo "__DEFINED_MACRO_${macro};" >>fixtmp.c
 320             echo "#endif" >>fixtmp.c
 321           done
 322           if ${CPP} ${DEFINES} $include_path fixtmp.c >fixtmp.i 2>/dev/null
 323           then
 324            $FIX_HEADER $rel_source_file $abs_source_file $abs_target_file "$required_list" <fixtmp.i
 325           else
 326             echo "${progname}: cpp could not parse ${abs_source_file} (ignored)"
 327           fi
 328           echo "${rel_source_file}" >>fixproto.list
 329         fi
 330       done
 331       rm -f fixtmp.c fixtmp.i
 332     done
 333     done_dirs="$done_dir $rel_source_dir"
 334 done
 335
 336 # This might be more cleanly moved into the main loop, by adding
 337 # a <dummy> source directory at the end.  FIXME!
 338 for rel_source_file in unistd.h stdlib.h
 339 do
 340   if grep "$rel_source_file" fixproto.list >/dev/null
 341   then true
 342   else
 343     echo Adding missing $rel_source_file
 344     rel_source_ident=`echo $rel_source_file | tr ./ __`
 345     required_list=`eval echo '${required_'${rel_source_ident}'-}'`
 346     cat >tmp.h <<EOF
 347 #ifndef ${rel_source_ident}
 348 #define ${rel_source_ident}
 349 #endif
 350 EOF
 351     ${FIX_HEADER} $rel_source_file tmp.h $abs_target_dir/$rel_source_file "$required_list" </dev/null
 352     rm tmp.h
 353   fi
 354 done
 355 exit 0