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, 1997, 1998 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, 59 Temple Place - Suite 330,
  23 #       Boston, MA 02111-1307, USA.
  24 #
  25 # DESCRIPTION
  26 #       Adjunct script for GNU CC to populate a directory with ANSI,
  27 #       Posix.1, and C++ compatible header files.
  28 #
  29 #       Each file found under SOURCE-DIR-ALL is analyzed and "fixed."
  30 #       Only standard ANSI/POSIX files found under SOURCE-DIR-STD
  31 #       are analyzed and "fixed."
  32 #       The SOURCE-DIRs are searched in order; a file found
  33 #       under multiple SOURCE-DIRs is only handled for the first one.
  34 #
  35 # STRATEGY
  36 #       Each include file is fed through cpp, and the scan-decls program
  37 #       parses it, and emits any found function declarations.
  38 #       The fix-header program analyzes the scan-decls output,
  39 #       together with the original include file, and writes a "fixed"
  40 #       include file, if needed.
  41 #
  42 #       The comment at the beginning of fix-header.c lists specifically
  43 #       what kind of changes are made.
  44 #
  45 # NOTE
  46 #       Some file space will be wasted, because the original header
  47 #       files are copied.  An earlier version just included the original
  48 #       by "reference", using GNU cpp's #include_next mechanism.
  49 #       This is currently not done, partly because #include_next is
  50 #       fragile (susceptible to version incompatibilities, and depends
  51 #       and GCC-specific features), and partly for performance reasons.
  52 #
  53 # AUTHORS
  54 #       Ron Guilmette (rfg@netcom.com) (original idea and code)
  55 #       Per Bothner (bothner@cygnus.com) (major re-write)
  56
  57 progname=$0
  58 progname=`basename $progname`
  59 original_dir=`pwd`
  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/socket.h sys/stat.h sys/times.h sys/resource.h sys/utsname.h sys/wait.h tar.h termios.h time.h unistd.h utime.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 subdirs_made=""
 124 echo "" >fixproto.list
 125
 126 for code in ALL STD ; do
 127
 128   subdirs="."
 129
 130   case $code in
 131     ALL)
 132       rel_source_dir=$src_dir_all
 133
 134       dirs="."
 135       levels=2
 136       while $LINKS && test -n "$dirs" -a $levels -gt 0
 137       do
 138         levels=`expr $levels - 1`
 139         newdirs=
 140         for d in $dirs ; do
 141           # Find all directories under $d, relative to $d, excluding $d itself.
 142           # Assume directory names ending in CC or containing ++ are
 143           # for C++, so skip those.
 144           subdirs="$subdirs "`cd $rel_source_dir/$d; find . -type d -print | \
 145                    sed -e '/^\.$/d' -e "s|^\./|${d}/|" -e 's|^\./||' \
 146                      -e '/CC$/d' -e '/[+][+]/d'`
 147           links=
 148           links=`cd $rel_source_dir; find $d/. -type l -print | \
 149                        sed -e "s|$d/./|$d/|" -e 's|^\./||'`
 150           for link in $links --dummy-- ; do
 151             test -d $rel_source_dir/$link/. && newdirs="$newdirs $link"
 152           done
 153         done
 154         dirs="$newdirs"
 155         subdirs="$subdirs $newdirs"
 156       done
 157       ;;
 158     STD)
 159       rel_source_dir=$src_dir_std
 160       ;;
 161   esac
 162
 163   if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
 164     abs_source_dir=$original_dir/$rel_source_dir
 165   else
 166     abs_source_dir=$rel_source_dir
 167   fi
 168
 169   if [ \! -d $abs_source_dir ] ; then
 170     echo $progname\: warning\: no such directory\: \`$rel_source_dir\'
 171     continue
 172   fi
 173
 174   for rel_source_subdir in $subdirs; do
 175
 176       abs_target_subdir=${abs_target_dir}/${rel_source_subdir}
 177       if [ \! -d $abs_target_subdir ] ; then
 178         if mkdir $abs_target_subdir ; then
 179           subdirs_made="$abs_target_subdir $subdirs_made"
 180         fi
 181       fi
 182       # Append "/"; remove initial "./". Hence "." -> "" and "sys" -> "sys/".
 183       rel_source_prefix=`echo $rel_source_subdir | sed -e 's|$|/|' -e 's|^./||'`
 184
 185       case $code in
 186         ALL)
 187           # The 'sed' is in case the *.h matches nothing, which yields "*.h"
 188           # which would then get re-globbed in the current directory.  Sigh.
 189           rel_source_files=`cd ${abs_source_dir}/${rel_source_subdir}; echo *.h | sed -e 's|[*].h|NONE|'`
 190           ;;
 191
 192         STD)
 193           files_to_check="$std_files"
 194           rel_source_files=""
 195
 196           # Also process files #included by the $std_files.
 197           while [ -n "${files_to_check}" ]
 198           do
 199             new_files_to_check=""
 200             for file in $files_to_check ; do
 201               xxfile=`echo $file | sed -e 's|/\([^/\.][^/\.]*\)/\.\./|/|'`
 202               # Create the dir where this file will go when fixed.
 203               xxdir=`echo ./$file | sed -e 's|/[^/]*$||'`
 204               if [ \! -d $abs_target_subdir/$xxdir ] ; then
 205                 if mkdir $abs_target_subdir/$xxdir ; then
 206                   subdirs_made="$abs_target_subdir/$xxdir $subdirs_made"
 207                 fi
 208               fi
 209               # Just in case we have edited out a symbolic link
 210               if [ -f $src_dir_std/$file -a -f $src_dir_std/$xxfile ] ; then
 211                 file=$xxfile
 212               fi
 213               case " $rel_source_files " in
 214                 *" ${file} "*)
 215                   # Already seen $file; nothing to do
 216                   ;;
 217                 *)
 218                   if test -f $src_dir_std/$file ; then
 219                     rel_dir=`echo $file | sed -n -e 's|^\(.*/\)[^/]*$|\1|p'`
 220                     # For #include "foo.h", that might be either "foo.h"
 221                     # or "${rel_dir}foo.h (or something bogus).
 222                     new_files_to_check="$new_files_to_check "`sed -n \
 223                         -e 's@  @ @g' \
 224                         -e 's@^ *# *include *<\([^>]*\)>.*$@\1@p' -e \
 225                         's@^ *# *include *\"\([^\"]*\)\".*$@\1 '$rel_dir'\1@p'\
 226                         <$src_dir_std/$file`
 227                     rel_source_files="$rel_source_files $file"
 228                   fi
 229                   ;;
 230               esac
 231             done
 232             files_to_check="$new_files_to_check"
 233           done
 234           rel_source_files="$rel_source_files"
 235           ;;
 236       esac
 237
 238       for filename in $rel_source_files ; do
 239         rel_source_file=${rel_source_prefix}${filename}
 240         abs_source_file=$abs_source_dir/$rel_source_file
 241         abs_target_file=$abs_target_dir/$rel_source_file
 242
 243         if test "$filename" = 'NONE' ; then
 244           echo "(No *.h files in $abs_source_dir/$rel_source_subdir)"
 245         # If target file exists, check if was written while processing one
 246         # of the earlier source directories;  if so ignore it.
 247         elif test -f $abs_target_file -a -n "$done_dirs" \
 248           && grep "$rel_source_file" fixproto.list >/dev/null
 249         then true
 250         else
 251           $FIX_HEADER $rel_source_file $abs_source_file $abs_target_file ${DEFINES} $include_path
 252           echo "${rel_source_file}" >>fixproto.list
 253         fi
 254       done
 255     done
 256     done_dirs="$done_dir $rel_source_dir"
 257 done
 258
 259 # This might be more cleanly moved into the main loop, by adding
 260 # a <dummy> source directory at the end.  FIXME!
 261 for rel_source_file in unistd.h stdlib.h
 262 do
 263   if grep "$rel_source_file" fixproto.list >/dev/null
 264   then true
 265   else
 266     echo Adding missing $rel_source_file
 267     rel_source_ident=`echo $rel_source_file | tr ./ __`
 268     required_list=`eval echo '${required_'${rel_source_ident}'-}'`
 269     cat >tmp.h <<EOF
 270 #ifndef __${rel_source_ident}
 271 #define __${rel_source_ident}
 272 EOF
 273     if test $rel_source_file = stdlib.h
 274     then
 275       # Make sure it contains a definition of size_t.
 276       cat >>tmp.h <<EOF
 277
 278 #define __need_size_t
 279 #include <stddef.h>
 280 EOF
 281     fi
 282     cat >>tmp.h <<EOF
 283
 284 #endif /* __${rel_source_ident} */
 285 EOF
 286     ${FIX_HEADER} $rel_source_file tmp.h $abs_target_dir/$rel_source_file ${DEFINES} $include_path
 287     rm tmp.h
 288   fi
 289 done
 290
 291 # Remove any directories that we made that are still empty.
 292 rmdir $subdirs_made 2>/dev/null
 293
 294 exit 0