#

# Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

#

# This code is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License version 2 only, as

# published by the Free Software Foundation.  Oracle designates this

# particular file as subject to the "Classpath" exception as provided

# by Oracle in the LICENSE file that accompanied this code.

#

# This code 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

# version 2 for more details (a copy is included in the LICENSE file that

# accompanied this code).

#

# You should have received a copy of the GNU General Public License version

# 2 along with this work; if not, write to the Free Software Foundation,

# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

#

# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

# or visit www.oracle.com if you need additional information or have any

# questions.

#

# Test if $1 is a valid argument to $3 (often is $JAVA passed as $3)

# If so, then append $1 to $2 \

# Also set JVM_ARG_OK to true/false depending on outcome.

AC_DEFUN([ADD_JVM_ARG_IF_OK],

[

  $ECHO "Check if jvm arg is ok: $1" >&AS_MESSAGE_LOG_FD

  $ECHO "Command: $3 $1 -version" >&AS_MESSAGE_LOG_FD

  OUTPUT=`$3 $1 -version 2>&1`

  FOUND_WARN=`$ECHO "$OUTPUT" | grep -i warn`

  FOUND_VERSION=`$ECHO $OUTPUT | grep " version \""`

  if test "x$FOUND_VERSION" != x && test "x$FOUND_WARN" = x; then

    $2="[$]$2 $1"

    JVM_ARG_OK=true

  else

    $ECHO "Arg failed:" >&AS_MESSAGE_LOG_FD

    $ECHO "$OUTPUT" >&AS_MESSAGE_LOG_FD

    JVM_ARG_OK=false

  fi

])

# Appends a string to a path variable, only adding the : when needed.

AC_DEFUN([BASIC_APPEND_TO_PATH],

[

  if test "x$2" != x; then

    if test "x[$]$1" = x; then

      $1="$2"

    else

      $1="[$]$1:$2"

    fi

  fi

])

# Prepends a string to a path variable, only adding the : when needed.

AC_DEFUN([BASIC_PREPEND_TO_PATH],

[

  if test "x$2" != x; then

    if test "x[$]$1" = x; then

      $1="$2"

    else

      $1="$2:[$]$1"

    fi

  fi

])

# This will make sure the given variable points to a full and proper

# path. This means:

# 1) There will be no spaces in the path. On posix platforms,

#    spaces in the path will result in an error. On Windows,

#    the path will be rewritten using short-style to be space-free.

# 2) The path will be absolute, and it will be in unix-style (on

#     cygwin).

# $1: The name of the variable to fix

AC_DEFUN([BASIC_FIXUP_PATH],

[

  if test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.cygwin"; then

    BASIC_FIXUP_PATH_CYGWIN($1)

  elif test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.msys"; then

    BASIC_FIXUP_PATH_MSYS($1)

  else

    # We're on a posix platform. Hooray! :)

    path="[$]$1"

    has_space=`$ECHO "$path" | $GREP " "`

    if test "x$has_space" != x; then

      AC_MSG_NOTICE([The path of $1, which resolves as "$path", is invalid.])

      AC_MSG_ERROR([Spaces are not allowed in this path.])

    fi

    # Use eval to expand a potential ~

    eval path="$path"

    if test ! -f "$path" && test ! -d "$path"; then

      AC_MSG_ERROR([The path of $1, which resolves as "$path", is not found.])

    fi

    $1="`cd "$path"; $THEPWDCMD -L`"

  fi

])

# This will make sure the given variable points to a executable

# with a full and proper path. This means:

# 1) There will be no spaces in the path. On posix platforms,

#    spaces in the path will result in an error. On Windows,

#    the path will be rewritten using short-style to be space-free.

# 2) The path will be absolute, and it will be in unix-style (on

#     cygwin).

# Any arguments given to the executable is preserved.

# If the input variable does not have a directory specification, then

# it need to be in the PATH.

# $1: The name of the variable to fix

AC_DEFUN([BASIC_FIXUP_EXECUTABLE],

[

  if test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.cygwin"; then

    BASIC_FIXUP_EXECUTABLE_CYGWIN($1)

  elif test "x$OPENJDK_BUILD_OS_ENV" = "xwindows.msys"; then

    BASIC_FIXUP_EXECUTABLE_MSYS($1)

  else

    # We're on a posix platform. Hooray! :)

    # First separate the path from the arguments. This will split at the first

    # space.

    complete="[$]$1"

    path="${complete%% *}"

    tmp="$complete EOL"

    arguments="${tmp#* }"

    # Cannot rely on the command "which" here since it doesn't always work.

    is_absolute_path=`$ECHO "$path" | $GREP ^/`

    if test -z "$is_absolute_path"; then

      # Path to executable is not absolute. Find it.

      IFS_save="$IFS"

      IFS=:

      for p in $PATH; do

        if test -f "$p/$path" && test -x "$p/$path"; then

          new_path="$p/$path"

          break

        fi

      done

      IFS="$IFS_save"

    else

      # This is an absolute path, we can use it without further modifications.

      new_path="$path"

    fi

    if test "x$new_path" = x; then

      AC_MSG_NOTICE([The path of $1, which resolves as "$complete", is not found.])

      has_space=`$ECHO "$complete" | $GREP " "`

      if test "x$has_space" != x; then

        AC_MSG_NOTICE([This might be caused by spaces in the path, which is not allowed.])

      fi

      AC_MSG_ERROR([Cannot locate the the path of $1])

    fi

  fi

  # Now join together the path and the arguments once again

  if test "x$arguments" != xEOL; then

    new_complete="$new_path ${arguments% *}"

  else

    new_complete="$new_path"

  fi

  if test "x$complete" != "x$new_complete"; then

    $1="$new_complete"

    AC_MSG_NOTICE([Rewriting $1 to "$new_complete"])

  fi

])

AC_DEFUN([BASIC_REMOVE_SYMBOLIC_LINKS],

[

  if test "x$OPENJDK_BUILD_OS" != xwindows; then

    # Follow a chain of symbolic links. Use readlink

    # where it exists, else fall back to horribly

    # complicated shell code.

    if test "x$READLINK_TESTED" != yes; then

      # On MacOSX there is a readlink tool with a different

      # purpose than the GNU readlink tool. Check the found readlink.

      ISGNU=`$READLINK --version 2>&1 | $GREP GNU`

      if test "x$ISGNU" = x; then

        # A readlink that we do not know how to use.

        # Are there other non-GNU readlinks out there?

        READLINK_TESTED=yes

        READLINK=

      fi

    fi

    if test "x$READLINK" != x; then

      $1=`$READLINK -f [$]$1`

    else

      # Save the current directory for restoring afterwards

      STARTDIR=$PWD

      COUNTER=0

      sym_link_dir=`$DIRNAME [$]$1`

      sym_link_file=`$BASENAME [$]$1`

      cd $sym_link_dir

      # Use -P flag to resolve symlinks in directories.

      cd `$THEPWDCMD -P`

      sym_link_dir=`$THEPWDCMD -P`

      # Resolve file symlinks

      while test $COUNTER -lt 20; do

        ISLINK=`$LS -l $sym_link_dir/$sym_link_file | $GREP '\->' | $SED -e 's/.*-> \(.*\)/\1/'`

        if test "x$ISLINK" == x; then

          # This is not a symbolic link! We are done!

          break

        fi

        # Again resolve directory symlinks since the target of the just found

        # link could be in a different directory

        cd `$DIRNAME $ISLINK`

        sym_link_dir=`$THEPWDCMD -P`

        sym_link_file=`$BASENAME $ISLINK`

        let COUNTER=COUNTER+1

      done

      cd $STARTDIR

      $1=$sym_link_dir/$sym_link_file

    fi

  fi

])

# Register a --with argument but mark it as deprecated

# $1: The name of the with argument to deprecate, not including --with-

AC_DEFUN([BASIC_DEPRECATED_ARG_WITH],

[

  AC_ARG_WITH($1, [AS_HELP_STRING([--with-$1],

      [Deprecated. Option is kept for backwards compatibility and is ignored])],

      [AC_MSG_WARN([Option --with-$1 is deprecated and will be ignored.])])

])

# Register a --enable argument but mark it as deprecated

# $1: The name of the with argument to deprecate, not including --enable-

# $2: The name of the argument to deprecate, in shell variable style (i.e. with _ instead of -)

AC_DEFUN([BASIC_DEPRECATED_ARG_ENABLE],

[

  AC_ARG_ENABLE($1, [AS_HELP_STRING([--enable-$1],

      [Deprecated. Option is kept for backwards compatibility and is ignored])])

  if test "x$enable_$2" != x; then

    AC_MSG_WARN([Option --enable-$1 is deprecated and will be ignored.])

  fi

])

AC_DEFUN_ONCE([BASIC_INIT],

[

  # Save the original command line. This is passed to us by the wrapper configure script.

  AC_SUBST(CONFIGURE_COMMAND_LINE)

  DATE_WHEN_CONFIGURED=`LANG=C date`

  AC_SUBST(DATE_WHEN_CONFIGURED)

  AC_MSG_NOTICE([Configuration created at $DATE_WHEN_CONFIGURED.])

  AC_MSG_NOTICE([configure script generated at timestamp $DATE_WHEN_GENERATED.])

])

# Test that variable $1 denoting a program is not empty. If empty, exit with an error.

# $1: variable to check

AC_DEFUN([BASIC_CHECK_NONEMPTY],

[

  if test "x[$]$1" = x; then

    AC_MSG_ERROR([Could not find required tool for $1])

  fi

])

# Check that there are no unprocessed overridden variables left.

# If so, they are an incorrect argument and we will exit with an error.

AC_DEFUN([BASIC_CHECK_LEFTOVER_OVERRIDDEN],

[

  if test "x$CONFIGURE_OVERRIDDEN_VARIABLES" != x; then

    # Replace the separating ! with spaces before presenting for end user.

    unknown_variables=${CONFIGURE_OVERRIDDEN_VARIABLES//!/ }

    AC_MSG_WARN([The following variables might be unknown to configure: $unknown_variables])

  fi

])

# Setup a tool for the given variable. If correctly specified by the user, 

# use that value, otherwise search for the tool using the supplied code snippet.

# $1: variable to set

# $2: code snippet to call to look for the tool

AC_DEFUN([BASIC_SETUP_TOOL],

[

  # Publish this variable in the help.

  AC_ARG_VAR($1, [Override default value for $1])

  if test "x[$]$1" = x; then

    # The variable is not set by user, try to locate tool using the code snippet

    $2

  else

    # The variable is set, but is it from the command line or the environment?

    # Try to remove the string !$1! from our list.

    try_remove_var=${CONFIGURE_OVERRIDDEN_VARIABLES//!$1!/}

    if test "x$try_remove_var" = "x$CONFIGURE_OVERRIDDEN_VARIABLES"; then

      # If it failed, the variable was not from the command line. Ignore it,

      # but warn the user (except for BASH, which is always set by the calling BASH).

      if test "x$1" != xBASH; then

        AC_MSG_WARN([Ignoring value of $1 from the environment. Use command line variables instead.])

      fi

      # Try to locate tool using the code snippet

      $2

    else

      # If it succeeded, then it was overridden by the user. We will use it

      # for the tool.

      # First remove it from the list of overridden variables, so we can test

      # for unknown variables in the end.

      CONFIGURE_OVERRIDDEN_VARIABLES="$try_remove_var"

      # Check if the provided tool contains a complete path.

      tool_specified="[$]$1"

      tool_basename="${tool_specified##*/}"

      if test "x$tool_basename" = "x$tool_specified"; then

        # A command without a complete path is provided, search $PATH.

        AC_MSG_NOTICE([Will search for user supplied tool $1=$tool_basename])

        AC_PATH_PROG($1, $tool_basename)

        if test "x[$]$1" = x; then

          AC_MSG_ERROR([User supplied tool $tool_basename could not be found])

        fi

      else

        # Otherwise we believe it is a complete path. Use it as it is.

        AC_MSG_NOTICE([Will use user supplied tool $1=$tool_specified])

        AC_MSG_CHECKING([for $1])

        if test ! -x "$tool_specified"; then

          AC_MSG_RESULT([not found])

          AC_MSG_ERROR([User supplied tool $1=$tool_specified does not exist or is not executable])

        fi

        AC_MSG_RESULT([$tool_specified])

      fi

    fi

  fi

])

# Call BASIC_SETUP_TOOL with AC_PATH_PROGS to locate the tool

# $1: variable to set

# $2: executable name (or list of names) to look for

AC_DEFUN([BASIC_PATH_PROGS],

[

  BASIC_SETUP_TOOL($1, [AC_PATH_PROGS($1, $2)])

])

# Call BASIC_SETUP_TOOL with AC_CHECK_TOOLS to locate the tool

# $1: variable to set

# $2: executable name (or list of names) to look for

AC_DEFUN([BASIC_CHECK_TOOLS],

[

  BASIC_SETUP_TOOL($1, [AC_CHECK_TOOLS($1, $2)])

])

# Like BASIC_PATH_PROGS but fails if no tool was found.

# $1: variable to set

# $2: executable name (or list of names) to look for

AC_DEFUN([BASIC_REQUIRE_PROGS],

[

  BASIC_PATH_PROGS($1, $2)

  BASIC_CHECK_NONEMPTY($1)

])

# Like BASIC_SETUP_TOOL but fails if no tool was found.

# $1: variable to set

# $2: autoconf macro to call to look for the special tool

AC_DEFUN([BASIC_REQUIRE_SPECIAL],

[

  BASIC_SETUP_TOOL($1, [$2])

  BASIC_CHECK_NONEMPTY($1)

])

# Setup the most fundamental tools that relies on not much else to set up,

# but is used by much of the early bootstrap code.

AC_DEFUN_ONCE([BASIC_SETUP_FUNDAMENTAL_TOOLS],

[

  # Start with tools that do not need have cross compilation support

  # and can be expected to be found in the default PATH. These tools are

  # used by configure. Nor are these tools expected to be found in the

  # devkit from the builddeps server either, since they are

  # needed to download the devkit.

  # First are all the simple required tools.

  BASIC_REQUIRE_PROGS(BASENAME, basename)

  BASIC_REQUIRE_PROGS(BASH, bash)

  BASIC_REQUIRE_PROGS(CAT, cat)

  BASIC_REQUIRE_PROGS(CHMOD, chmod)

  BASIC_REQUIRE_PROGS(CMP, cmp)

  BASIC_REQUIRE_PROGS(COMM, comm)

  BASIC_REQUIRE_PROGS(CP, cp)

  BASIC_REQUIRE_PROGS(CPIO, cpio)

  BASIC_REQUIRE_PROGS(CUT, cut)

  BASIC_REQUIRE_PROGS(DATE, date)

  BASIC_REQUIRE_PROGS(DIFF, [gdiff diff])

  BASIC_REQUIRE_PROGS(DIRNAME, dirname)

  BASIC_REQUIRE_PROGS(ECHO, echo)

  BASIC_REQUIRE_PROGS(EXPR, expr)

  BASIC_REQUIRE_PROGS(FILE, file)

  BASIC_REQUIRE_PROGS(FIND, find)

  BASIC_REQUIRE_PROGS(HEAD, head)

  BASIC_REQUIRE_PROGS(LN, ln)

  BASIC_REQUIRE_PROGS(LS, ls)

  BASIC_REQUIRE_PROGS(MKDIR, mkdir)

  BASIC_REQUIRE_PROGS(MKTEMP, mktemp)

  BASIC_REQUIRE_PROGS(MV, mv)

  BASIC_REQUIRE_PROGS(NAWK, [nawk gawk awk])

  BASIC_REQUIRE_PROGS(PRINTF, printf)

  BASIC_REQUIRE_PROGS(RM, rm)

  BASIC_REQUIRE_PROGS(SH, sh)

  BASIC_REQUIRE_PROGS(SORT, sort)

  BASIC_REQUIRE_PROGS(TAIL, tail)

  BASIC_REQUIRE_PROGS(TAR, tar)

  BASIC_REQUIRE_PROGS(TEE, tee)

  BASIC_REQUIRE_PROGS(TOUCH, touch)

  BASIC_REQUIRE_PROGS(TR, tr)

  BASIC_REQUIRE_PROGS(UNAME, uname)

  BASIC_REQUIRE_PROGS(UNIQ, uniq)

  BASIC_REQUIRE_PROGS(WC, wc)

  BASIC_REQUIRE_PROGS(WHICH, which)

  BASIC_REQUIRE_PROGS(XARGS, xargs)

  # Then required tools that require some special treatment.

  BASIC_REQUIRE_SPECIAL(AWK, [AC_PROG_AWK])

  BASIC_REQUIRE_SPECIAL(GREP, [AC_PROG_GREP])

  BASIC_REQUIRE_SPECIAL(EGREP, [AC_PROG_EGREP])

  BASIC_REQUIRE_SPECIAL(FGREP, [AC_PROG_FGREP])

  BASIC_REQUIRE_SPECIAL(SED, [AC_PROG_SED])

  # Always force rm.

  RM="$RM -f"

  # pwd behaves differently on various platforms and some don't support the -L flag.

  # Always use the bash builtin pwd to get uniform behavior.

  THEPWDCMD=pwd

  # These are not required on all platforms

  BASIC_PATH_PROGS(CYGPATH, cygpath)

  BASIC_PATH_PROGS(READLINK, [greadlink readlink])

  BASIC_PATH_PROGS(DF, df)

  BASIC_PATH_PROGS(SETFILE, SetFile)

])

# Setup basic configuration paths, and platform-specific stuff related to PATHs.

AC_DEFUN_ONCE([BASIC_SETUP_PATHS],

[

  # Save the current directory this script was started from

  CURDIR="$PWD"

  if test "x$OPENJDK_TARGET_OS" = "xwindows"; then

    PATH_SEP=";"

    BASIC_CHECK_PATHS_WINDOWS

  else

    PATH_SEP=":"

  fi

  AC_SUBST(PATH_SEP)

  # We get the top-level directory from the supporting wrappers.

  AC_MSG_CHECKING([for top-level directory])

  AC_MSG_RESULT([$TOPDIR])

  AC_SUBST(TOPDIR)

  # We can only call BASIC_FIXUP_PATH after BASIC_CHECK_PATHS_WINDOWS.

  BASIC_FIXUP_PATH(CURDIR)

  BASIC_FIXUP_PATH(TOPDIR)

  # SRC_ROOT is a traditional alias for TOPDIR.

  SRC_ROOT=$TOPDIR

  # Locate the directory of this script.

  AUTOCONF_DIR=$TOPDIR/common/autoconf

])

AC_DEFUN_ONCE([BASIC_SETUP_DEVKIT],

[

  AC_ARG_WITH([devkit], [AS_HELP_STRING([--with-devkit],

      [use this devkit for compilers, tools and resources])],

      [

        BASIC_FIXUP_PATH([with_devkit])

        DEVKIT_ROOT="$with_devkit"

        # Check for a meta data info file in the root of the devkit

        if test -f "$DEVKIT_ROOT/devkit.info"; then

          # This potentially sets the following:

          # DEVKIT_NAME: A descriptive name of the devkit

          # DEVKIT_TOOLCHAIN_PATH: Corresponds to --with-toolchain-path

          # DEVKIT_EXTRA_PATH: Corresponds to --with-extra-path

          # DEVKIT_SYSROOT: Corresponds to --with-sysroot

          . $DEVKIT_ROOT/devkit.info

        fi

        AC_MSG_CHECKING([for devkit])

        if test "x$DEVKIT_NAME" != x; then

          AC_MSG_RESULT([$DEVKIT_NAME in $DEVKIT_ROOT])

        else

          AC_MSG_RESULT([$DEVKIT_ROOT])

        fi

        if test "x$DEVKIT_EXTRA_PATH" != x; then

          BASIC_PREPEND_TO_PATH([EXTRA_PATH],$DEVKIT_EXTRA_PATH)

        fi

        # Fallback default of just /bin if DEVKIT_PATH is not defined

        if test "x$DEVKIT_TOOLCHAIN_PATH" = x; then

          DEVKIT_TOOLCHAIN_PATH="$DEVKIT_ROOT/bin"

        fi

        BASIC_PREPEND_TO_PATH([TOOLCHAIN_PATH],$DEVKIT_TOOLCHAIN_PATH)