path: root/gcc/fixproto

#!/bin/sh
#
# SYNOPSIS
#	fixproto TARGET-DIR [ SOURCE-DIR ... ]
#
# COPYRIGHT
#	Copyright (C) 1993 Free Software Foundation, Inc.
#	This file is part of GNU CC.
#
#	GNU CC is free software; you can redistribute it and/or modify
#	it under the terms of the GNU General Public License as published by
#	the Free Software Foundation; either version 2, or (at your option)
#	any later version.
#
#	GNU CC is distributed in the hope that it will be useful,
#	but WITHOUT ANY WARRANTY; without even the implied warranty of
#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#	GNU General Public License for more details.
#
#	You should have received a copy of the GNU General Public License
#	along with GNU CC; see the file COPYING.  If not, write to
#	the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
#
# DESCRIPTION
#	Adjunct script for GNU CC to populate a directory with ANSI,
#	Posix.1, and C++ compatible header files.
#
#	Each file found under each SOURCE-DIR is analized and "fixed."
#	The SOURCE-DIRs are searched in order; a file found
#	under multiple SOURCE-DIRs is only handled for the first one.
#
# STRATEGY
#       Each include file is fed through cpp, and the scan-decls program
#	parses it, and emits any found function declarations.
#	The patch-header program analyzes the scan-decls output,
#	together with the original include file, and writes a "fixed"
#	include file, if needed.
#
#	The comment at the beginning of patch-header.c lists specifically
#	what kind of changes are made.
#
# NOTE
#	Some file space will be wasted, because the original header
#	files are copied.  An earlier version just included the original
#	by "reference", using GNU cpp's #include_next mechanism.
#	This is currently not done, partly because #include_next is
#	fragile (susceptible to version incompatibilties, and depends
#	and GCC-specific features), and partly for performance reasons.
#
# AUTHORS
#	Ron Guilmette (rfg@netcom.com) (original idea and code)
#	Per Bothner (bothner@cygnus.com) (major re-write)

progname=$0
progname=`basename $progname`
original_dir=`pwd`
CPP=${CPP-./cpp}

if [ `echo $1 | wc -w` = 0 ] ; then
  echo $progname\: usage\: $progname target-dir \[ source-dir \.\.\. \]
  exit 1
fi
rel_target_dir=$1
shift

if [ `expr $rel_target_dir : '\(.\)'` != '/' ] ; then
  abs_target_dir=$original_dir/$rel_target_dir
else
  abs_target_dir=$rel_target_dir
fi

# Determine whether this system has symbolic links.
if ln -s X $rel_target_dir/ShouldNotExist 2>/dev/null; then
  rm -f $rel_target_dir/ShouldNotExist
  LINKS=true
elif ln -s X /tmp/ShouldNotExist 2>/dev/null; then
  rm -f /tmp/ShouldNotExist
  LINKS=true
else
  LINKS=false
fi

if [ \! -d $abs_target_dir ] ; then
  echo $progname\: creating directory $rel_target_dir
  mkdir $abs_target_dir
fi

echo $progname\: populating \`$rel_target_dir\'

include_path=""

if [ `echo $* | wc -w` != 0 ] ; then
  for rel_source_dir in $*; do
    if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
      abs_source_dir=$original_dir/$rel_source_dir
    else
      abs_source_dir=$rel_source_dir
    fi
    include_path="$include_path -I$abs_source_dir"
  done
fi

required_stdlib_h="abort abs atexit atof atoi atol bsearch calloc exit free getenv labs malloc qsort rand realloc srand strtod strtol strtoul system"
# "div ldiv", - ignored because these depend on div_t, ldiv_t
# ignore these: "mblen mbstowcs mbstowc wcstombs wctomb"
# Should perhaps also add NULL
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"

done_dirs=""
echo "" >fixproto.list

if [ `echo $* | wc -w` != 0 ] ; then
  for rel_source_dir in $* ; do
    if [ `expr $rel_source_dir : '\(.\)'` != '/' ] ; then
      abs_source_dir=$original_dir/$rel_source_dir
    else
      abs_source_dir=$rel_source_dir
    fi
    if [ \! -d $abs_source_dir ] ; then
      echo $progname\: warning\: no such directory\: \`$rel_source_dir\'
      continue
    fi

    dirs="."
    levels=2
    subdirs="."
    while $LINKS && test -n "$dirs" -a $levels -gt 0
    do
      levels=`expr $levels - 1`
      newdirs=
      for d in $dirs ; do
	# Find all directories under $d, relative to $d, excluding $d itself.
        subdirs="$subdirs "`cd $abs_source_dir/$d; find . -type d -print | \
		       sed -e '/^\.$/d' -e "s|^\./|${d}/|" -e 's|^\./||'`
	links=
	links=`cd $abs_source_dir; find $d/. -type l -print | \
		       sed -e "s|$d/./|$d/|" -e 's|^\./||'`
	for link in $links --dummy-- ; do
	  if test -d $abs_source_dir/$link/. ; then
	    newdirs="$newdirs $link"
	  fi
	done
      done
      dirs="$newdirs"
      subdirs="$subdirs $newdirs"
    done

    for rel_source_subdir in $subdirs; do
      abs_target_subdir=${abs_target_dir}/${rel_source_subdir}
      if [ \! -d $abs_target_subdir ] ; then
        mkdir $abs_target_subdir
      fi
      # Append "/"; remove initial "./". Hence "." -> "" and "sys" -> "sys/".
      rel_source_prefix=`echo $rel_source_subdir | sed -e 's|$|/|' -e 's|^./||'`

      # The 'sed' is in case the *.h matches nothing, which yields "*.h"
      # which would then get re-globbed in the current directory.  Sigh.
      rel_source_files=`cd ${abs_source_dir}/${rel_source_subdir}; echo *.h | sed -e 's|[*].h|NONE|'`

      for filename in $rel_source_files ; do
	rel_source_file=${rel_source_prefix}${filename}
	abs_source_file=$abs_source_dir/$rel_source_file
	abs_target_file=$abs_target_dir/$rel_source_file

	if test "$filename" = 'NONE' ; then
	  echo "(No *.h files in $abs_source_dir/$rel_source_subdir)"
	# If target file exists, check if was written while processing one
	# of the earlier source directories;  if so ignore it.
	elif test -f $abs_target_file -a -n "$done_dirs" \
	  && grep "$rel_source_file" fixproto.list >/dev/null
	then true
#	  echo $abs_target_file exists, $abs_source_file is ignored
	else
	  # echo doing $rel_source_file from $abs_source_dir
	  required_list=
	  extra_check_list=
	  case $rel_source_file in
	    ctype.h)
	      required_list="isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper" ;;
	    dirent.h)
	      required_list="closedir opendir readdir rewinddir" ;;
	    errno.h)
	      extra_check_list="errno" ;;
	    curses.h)
	      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" ;;
	    fcntl.h)
	      required_list="creat fcntl open" ;;
	    grp.h)
	      #Maybe also "getgrent fgetgrent setgrent endgrent" */
	      required_list="getgrgid getgrnam" ;;
	    limit.h)
	      required_list= /* Lots of macros */ ;;
	    locale.h)
	      required_list="localeconv setlocale" ;;
	    math.h)
	      required_list="acos asin atan atan2 ceil cos cosh exp fabs floor fmod frexp ldexp log10 log modf pow sin sinh sqrt tan tanh"
	      extra_check_list="HUGE_VAL" ;;
	    pwd.h)
	      required_list="getpwnam getpwuid" ;;
	    setjmp.h)
	      required_list="longjmp setjmp siglongjmp sigsetjmp" ;;
	    signal.h)
	      required_list="kill raise sigaction sigaddset sigdelset sigemptyset sigfillset sigismember sigpending sigprocmask sigsuspend" ;;
	      # Left out signal() - its prototype is too complex for us!
	    stdio.h)
	      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"
	      if grep _flsbuf <$abs_source_file >/dev/null ; then
		required_list="$required_list _flsbuf _filbuf"
	      fi
	      # Should perhaps also handle NULL, EOF, ... ?
	      ;;
	    stdlib.h)
	      required_list="$required_stdlib_h" ;;
	    string.h)
	      required_list="memchr memcmp memcpy memmove memset strcat strchr strcmp strcoll strcpy strcspn strerror strlen strncat strncmp" ;;
# Should perhaps also add NULL and size_t
	    sys/stat.h)
	      required_list="chmod fstat mkdir mkfifo stat umask"
	      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" ;;
	    sys/times.h)
	      required_list="times" ;;
# "sys/types.h" add types (not in old g++-include)
	    sys/resource.h)
	      required_list="getrusage getrlimit setrlimit getpriority setpriority" ;;
	    sys/utsname.h)
	      required_list="uname" ;;
	    sys/wait.h)
	      required_list="wait waitpid"
	      extra_check_list="WEXITSTATUS WIFEXITED WIFSIGNALED WIFSTOPPED WSTOPSIG WTERMSIG WNOHANG WNOTRACED" ;;
	    tar.h)
	      required_list=  ;;
	    termios.h)
	      required_list="cfgetispeed cfgetospeed cfsetispeed cfsetospeed tcdrain tcflow tcflush tcgetattr tcsendbreak tcsetattr" ;;
	    time.h)
	      required_list="asctime clock ctime difftime gmtime localtime mktime strftime time tzset" ;;
	    unistd.h)
	      required_list="$required_unistd_h" ;;
	  esac
	  rm -f fixtmp.c fixtmp.i
	  echo "#include <${rel_source_file}>" >fixtmp.c
	  for macro in ${required_list} ${extra_check_list}
	  do
	    echo "#ifdef ${macro}" >>fixtmp.c
	    echo "__DEFINED_MACRO_${macro};" >>fixtmp.c
	    echo "#endif" >>fixtmp.c
	  done
	  if ${CPP} -D__STDC__ -D__cplusplus -D_POSIX_SOURCE $include_path fixtmp.c >fixtmp.i 2>/dev/null
	  then
	    cat $abs_source_file >fixtmp.c
#	    echo Doing: "$original_dir/scan-decls <fixtmp.i | $original_dir/patch-header $rel_source_file fixtmp.c $abs_target_file \"$required_list\""

	    $original_dir/scan-decls <fixtmp.i | \
	     $original_dir/patch-header $rel_source_file fixtmp.c $abs_target_file "$required_list"
	  else
	    echo "${progname}: cpp could not parse ${abs_source_file} (ignored)"
	  fi
	  echo "${rel_source_file}" >>fixproto.list
	fi
      done
      rm -f fixtmp.c fixtmp.i
    done
    # check for broken assert.h that needs stdio.h
    if test -f $abs_source_dir/assert.h -a \! -f $abs_target_dir/assert.h \
      && grep 'stderr' $abs_source_dir/assert.h >/dev/null
    then
      if grep 'include.*stdio.h' $abs_source_dir/assert.h >/dev/null
      then true
      else
	echo 'Fixing broken assert.h (needs stdio.h)'
	cat $abs_source_dir/assert.h >$abs_target_dir/assert.h
	echo '#include <stdio.h>' >>$abs_target_dir/assert.h
      fi
    fi
    done_dirs="$done_dir $rel_source_dir"
  done
fi

# This might be more cleanly moved into the main loop, by adding
# a <dummy> source directory at the end.  FIXME!
for rel_source_file in unistd.h stdlib.h
do
  if grep "$rel_source_file" fixproto.list >/dev/null
  then true
  else
    echo Adding missing $rel_source_file
    rel_source_ident=`echo $rel_source_file | tr ./ __`
    required_list=`eval echo '${required_'${rel_source_ident}'-}'`
    cat >tmp.h <<EOF
#ifndef ${rel_source_ident}
#define ${rel_source_ident}
#endif
EOF
    $original_dir/patch-header $rel_source_file tmp.h $abs_target_dir/$rel_source_file "$required_list" </dev/null
    rm tmp.h
  fi
done
exit 0