[bpt/emacs.git] / autogen.sh

#!/bin/sh
### autogen.sh - tool to help build Emacs from a bzr checkout

## Copyright (C) 2011-2014 Free Software Foundation, Inc.

## Author: Glenn Morris <rgm@gnu.org>
## Maintainer: emacs-devel@gnu.org

## This file is part of GNU Emacs.

## GNU Emacs 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 3 of the License, or
## (at your option) any later version.

## GNU Emacs 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 Emacs.  If not, see <http://www.gnu.org/licenses/>.

### Commentary:

## The Emacs bzr repository does not include the configure script
## (and associated helpers).  The first time you fetch Emacs from bzr,
## run this script to generate the necessary files.
## For more details, see the file INSTALL.REPO.

### Code:

## Tools we need:
## Note that we respect the values of AUTOCONF etc, like autoreconf does.
progs="autoconf automake pkg-config"

## Minimum versions we need:
autoconf_min=`sed -n 's/^ *AC_PREREQ(\([0-9\.]*\)).*/\1/p' configure.ac`

## This will need improving if more options are ever added to the
## AM_INIT_AUTOMAKE call.
automake_min=`sed -n 's/^ *AM_INIT_AUTOMAKE(\([0-9\.]*\)).*/\1/p' configure.ac`

pkg_config_min=`sed -n 's/^ *PKG_PROG_PKG_CONFIG(\([0-9\.]*\)).*/\1/p' configure.ac`

## $1 = program, eg "autoconf".
## Echo the version string, eg "2.59".
## FIXME does not handle things like "1.4a", but AFAIK those are
## all old versions, so it is OK to fail there.
## Also note that we do not handle micro versions.
get_version ()
{
    ## Remove eg "./autogen.sh: line 50: autoconf: command not found".
    $1 --version 2>&1 | sed -e '/not found/d' -e 's/.* //' -n -e '1 s/\([0-9][0-9\.]*\).*/\1/p'
}

## $1 = version string, eg "2.59"
## Echo the major version, eg "2".
major_version ()
{
    echo $1 | sed -e 's/\([0-9][0-9]*\)\..*/\1/'
}

## $1 = version string, eg "2.59"
## Echo the minor version, eg "59".
minor_version ()
{
    echo $1 | sed -e 's/[0-9][0-9]*\.\([0-9][0-9]*\).*/\1/'
}

## $1 = program
## $2 = minimum version.
## Return 0 if program is present with version >= minimum version.
## Return 1 if program is missing.
## Return 2 if program is present but too old.
## Return 3 for unexpected error (eg failed to parse version).
check_version ()
{
    ## Respect eg $AUTOMAKE if it is set, like autoreconf does.
    uprog=`echo $1 | sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`

    eval uprog=\$${uprog}

    [ x"$uprog" = x ] && uprog=$1

    have_version=`get_version $uprog`

    [ x"$have_version" = x ] && return 1

    have_maj=`major_version $have_version`
    need_maj=`major_version $2`

    [ x"$have_maj" != x ] && [ x"$need_maj" != x ] || return 3

    [ $have_maj -gt $need_maj ] && return 0
    [ $have_maj -lt $need_maj ] && return 2

    have_min=`minor_version $have_version`
    need_min=`minor_version $2`

    [ x"$have_min" != x ] && [ x"$need_min" != x ] || return 3

    [ $have_min -ge $need_min ] && return 0
    return 2
}


cat <<EOF
Checking whether you have the necessary tools...
(Read INSTALL.REPO for more details on building Emacs)

EOF

missing=

for prog in $progs; do

    sprog=`echo "$prog" | sed 's/-/_/g'`

    eval min=\$${sprog}_min

    echo "Checking for $prog (need at least version $min)..."

    check_version $prog $min

    retval=$?

    case $retval in
        0) stat="ok" ;;
        1) stat="missing" ;;
        2) stat="too old" ;;
        *) stat="unable to check" ;;
    esac

    echo $stat

    if [ $retval -ne 0 ]; then
        missing="$missing $prog"
        eval ${sprog}_why=\""$stat"\"
    fi

done


if [ x"$missing" != x ]; then

    cat <<EOF

Building Emacs from Bzr requires the following specialized programs:
EOF

    for prog in $progs; do
        sprog=`echo "$prog" | sed 's/-/_/g'`

        eval min=\$${sprog}_min

        echo "$prog (minimum version $min)"
    done


    cat <<EOF

Your system seems to be missing the following tool(s):
EOF

    for prog in $missing; do
        sprog=`echo "$prog" | sed 's/-/_/g'`

        eval why=\$${sprog}_why

        echo "$prog ($why)"
    done

    cat <<EOF

If you think you have the required tools, please add them to your PATH
and re-run this script.

Otherwise, please try installing them.
On systems using rpm and yum, try: "yum install PACKAGE"
On systems using dpkg and apt, try: "apt-get install PACKAGE"
Then re-run this script.

If you do not have permission to do this, or if the version provided
by your system is too old, it is normally straightforward to build
these packages from source.  You can find the sources at:

ftp://ftp.gnu.org/gnu/PACKAGE/

Download the package (make sure you get at least the minimum version
listed above), extract it using tar, then run configure, make,
make install.  Add the installation directory to your PATH and re-run
this script.

If you know that the required versions are in your PATH, but this
script has made an error, then you can simply run

autoreconf -fi -I m4

instead of this script.

Please report any problems with this script to bug-gnu-emacs@gnu.org .
EOF

    exit 1
fi

# If automake is installed in a nonstandard location, find the standard
# location if possible and append it to ACLOCAL_PATH.  That way, it will
# find the pkg.m4 that is installed in the standard location.
echo "Checking for pkg.m4..."
AUTORECONF_ENV=
env_space=
ac_dir=`aclocal --print-ac-dir` || {
    cat <<EOF
There was a problem running 'aclocal --print-ac-dir'.
The aclocal program is part of automake.
Please check your automake installation.
EOF

    exit 1
}

test -n "$ac_dir" && test -r "$ac_dir/pkg.m4" || {

  # Maybe ACLOCAL_PATH is already set-up.
  if test -n "$ACLOCAL_PATH"; then
    oIFS=$IFS
    IFS=:
    for dir in $ACLOCAL_PATH; do
      if test -r "$dir/pkg.m4"; then
  	AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
        env_space=' '
  	break
      fi
    done
    IFS=$oIFS
  fi

  if test -z "$AUTORECONF_ENV"; then
    oIFS=$IFS
    IFS=:
    before_first_aclocal=true
    for dir in $PATH; do
      if test -x "$dir/aclocal"; then
        if $before_first_aclocal; then
          before_first_aclocal=false
        elif ac_dir=`"$dir/aclocal" --print-ac-dir` && test -r "$ac_dir/pkg.m4"
        then
          case $ACLOCAL_PATH in
            '') ACLOCAL_PATH=$ac_dir;;
            ?*) ACLOCAL_PATH=$ACLOCAL_PATH:$ac_dir;;
          esac
          export ACLOCAL_PATH
          AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
          env_space=' '
          break
        fi
      fi
    done
    IFS=$oIFS
  fi

  ## OK, maybe pkg-config is in a weird place (eg on hydra).
  if test -z "$AUTORECONF_ENV"; then
    oIFS=$IFS
    IFS=:
    for dir in $PATH; do
      if test -x "$dir/pkg-config"; then
        ac_dir=`echo "$dir" | sed 's|bin$|share/aclocal|'`
        if test -r "$ac_dir/pkg.m4"; then
          case $ACLOCAL_PATH in
            '') ACLOCAL_PATH=$ac_dir;;
            ?*) ACLOCAL_PATH=$ACLOCAL_PATH:$ac_dir;;
          esac
          export ACLOCAL_PATH
          AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
          env_space=' '
          break
        fi
      fi
    done
    IFS=$oIFS
  fi

  if test -z "$AUTORECONF_ENV"; then
    cat <<EOF
The version of aclocal that you are using cannot find the pkg.m4 file that
pkg-config provides.  If it is installed in some unusual directory /FOO/BAR,
set ACLOCAL_PATH='/FOO/BAR' in the environment and run this script again.
EOF
    exit 1
  fi
}
echo ok

echo 'Your system has the required tools.'
echo "Running \"$AUTORECONF_ENV${env_space}autoreconf -fi -I m4\" ..."


## Let autoreconf figure out what, if anything, needs doing.
## Use autoreconf's -f option in case autoreconf itself has changed.
autoreconf -fi -I m4 || exit $?

## Create a timestamp, so that './autogen.sh; make' doesn't
## cause 'make' to needlessly run 'autoheader'.
echo timestamp > src/stamp-h.in || exit

echo "You can now run \"./configure$env_space$AUTORECONF_ENV\"."

exit 0

### autogen.sh ends here
Commit	Line	Data
067d23c9	1	#!/bin/sh
66b87493	2	### autogen.sh - tool to help build Emacs from a bzr checkout
067d23c9	3
ba318903	4	## Copyright (C) 2011-2014 Free Software Foundation, Inc.
067d23c9	5
66b87493	6	## Author: Glenn Morris <rgm@gnu.org>
34dc21db	7	## Maintainer: emacs-devel@gnu.org
66b87493 GM	8
	9	## This file is part of GNU Emacs.
	10
	11	## GNU Emacs is free software: you can redistribute it and/or modify
	12	## it under the terms of the GNU General Public License as published by
	13	## the Free Software Foundation, either version 3 of the License, or
	14	## (at your option) any later version.
	15
	16	## GNU Emacs is distributed in the hope that it will be useful,
	17	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	## GNU General Public License for more details.
	20
	21	## You should have received a copy of the GNU General Public License
	22	## along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
	23
	24	### Commentary:
	25
	26	## The Emacs bzr repository does not include the configure script
	27	## (and associated helpers). The first time you fetch Emacs from bzr,
	28	## run this script to generate the necessary files.
ac4c50ad	29	## For more details, see the file INSTALL.REPO.
66b87493 GM	30
	31	### Code:
	32
	33	## Tools we need:
42e85a8f	34	## Note that we respect the values of AUTOCONF etc, like autoreconf does.
b05e08a4	35	progs="autoconf automake pkg-config"
66b87493 GM	36
66b87493 GM	37	## Minimum versions we need:
c4444d16	38	autoconf_min=`sed -n 's/^ AC_PREREQ(\([0-9\.]\)).*/\1/p' configure.ac`
66b87493	39
7d732d1a GM	40	## This will need improving if more options are ever added to the
	41	## AM_INIT_AUTOMAKE call.
	42	automake_min=`sed -n 's/^ AM_INIT_AUTOMAKE(\([0-9\.]\)).*/\1/p' configure.ac`
66b87493	43
b05e08a4	44	pkg_config_min=`sed -n 's/^ PKG_PROG_PKG_CONFIG(\([0-9\.]\)).*/\1/p' configure.ac`
66b87493 GM	45
	46	## $1 = program, eg "autoconf".
	47	## Echo the version string, eg "2.59".
	48	## FIXME does not handle things like "1.4a", but AFAIK those are
	49	## all old versions, so it is OK to fail there.
	50	## Also note that we do not handle micro versions.
	51	get_version ()
	52	{
42e85a8f	53	## Remove eg "./autogen.sh: line 50: autoconf: command not found".
5253ea1d	54	$1 --version 2>&1 \| sed -e '/not found/d' -e 's/.* //' -n -e '1 s/\([0-9][0-9\.]\)./\1/p'
66b87493 GM	55	}
	56
	57	## $1 = version string, eg "2.59"
	58	## Echo the major version, eg "2".
	59	major_version ()
	60	{
	61	echo $1 \| sed -e 's/\([0-9][0-9]\)\../\1/'
	62	}
	63
	64	## $1 = version string, eg "2.59"
	65	## Echo the minor version, eg "59".
	66	minor_version ()
	67	{
	68	echo $1 \| sed -e 's/[0-9][0-9]\.\([0-9][0-9]\).*/\1/'
	69	}
	70
	71	## $1 = program
	72	## $2 = minimum version.
c80e3b4a	73	## Return 0 if program is present with version >= minimum version.
66b87493 GM	74	## Return 1 if program is missing.
	75	## Return 2 if program is present but too old.
	76	## Return 3 for unexpected error (eg failed to parse version).
	77	check_version ()
	78	{
42e85a8f	79	## Respect eg $AUTOMAKE if it is set, like autoreconf does.
5253ea1d	80	uprog=`echo $1 \| sed -e 's/-/_/g' -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'`
42e85a8f GM	81
	82	eval uprog=\$${uprog}
	83
	84	[ x"$uprog" = x ] && uprog=$1
	85
	86	have_version=`get_version $uprog`
66b87493 GM	87
	88	[ x"$have_version" = x ] && return 1
	89
	90	have_maj=`major_version $have_version`
	91	need_maj=`major_version $2`
	92
	93	[ x"$have_maj" != x ] && [ x"$need_maj" != x ] \|\| return 3
	94
	95	[ $have_maj -gt $need_maj ] && return 0
	96	[ $have_maj -lt $need_maj ] && return 2
	97
	98	have_min=`minor_version $have_version`
	99	need_min=`minor_version $2`
	100
	101	[ x"$have_min" != x ] && [ x"$need_min" != x ] \|\| return 3
	102
	103	[ $have_min -ge $need_min ] && return 0
	104	return 2
	105	}
	106
	107
	108	cat <<EOF
	109	Checking whether you have the necessary tools...
ac4c50ad	110	(Read INSTALL.REPO for more details on building Emacs)
66b87493 GM	111
	112	EOF
	113
	114	missing=
	115
	116	for prog in $progs; do
	117
5253ea1d GM	118	sprog=`echo "$prog" \| sed 's/-/_/g'`
	119
	120	eval min=\$${sprog}_min
66b87493 GM	121
	122	echo "Checking for $prog (need at least version $min)..."
	123
	124	check_version $prog $min
	125
	126	retval=$?
	127
	128	case $retval in
	129	0) stat="ok" ;;
	130	1) stat="missing" ;;
	131	2) stat="too old" ;;
	132	*) stat="unable to check" ;;
	133	esac
	134
	135	echo $stat
	136
	137	if [ $retval -ne 0 ]; then
	138	missing="$missing $prog"
5253ea1d	139	eval ${sprog}_why=\""$stat"\"
66b87493 GM	140	fi
	141
	142	done
	143
	144
	145	if [ x"$missing" != x ]; then
	146
	147	cat <<EOF
	148
	149	Building Emacs from Bzr requires the following specialized programs:
	150	EOF
	151
	152	for prog in $progs; do
5253ea1d GM	153	sprog=`echo "$prog" \| sed 's/-/_/g'`
	154
	155	eval min=\$${sprog}_min
66b87493 GM	156
	157	echo "$prog (minimum version $min)"
	158	done
	159
	160
	161	cat <<EOF
	162
	163	Your system seems to be missing the following tool(s):
	164	EOF
	165
	166	for prog in $missing; do
5253ea1d GM	167	sprog=`echo "$prog" \| sed 's/-/_/g'`
	168
	169	eval why=\$${sprog}_why
66b87493 GM	170
	171	echo "$prog ($why)"
	172	done
	173
	174	cat <<EOF
	175
	176	If you think you have the required tools, please add them to your PATH
	177	and re-run this script.
	178
	179	Otherwise, please try installing them.
	180	On systems using rpm and yum, try: "yum install PACKAGE"
	181	On systems using dpkg and apt, try: "apt-get install PACKAGE"
	182	Then re-run this script.
	183
	184	If you do not have permission to do this, or if the version provided
	185	by your system is too old, it is normally straightforward to build
	186	these packages from source. You can find the sources at:
	187
	188	ftp://ftp.gnu.org/gnu/PACKAGE/
	189
	190	Download the package (make sure you get at least the minimum version
	191	listed above), extract it using tar, then run configure, make,
	192	make install. Add the installation directory to your PATH and re-run
	193	this script.
	194
	195	If you know that the required versions are in your PATH, but this
	196	script has made an error, then you can simply run
	197
af3e4d06	198	autoreconf -fi -I m4
66b87493 GM	199
	200	instead of this script.
	201
66b87493 GM	202	Please report any problems with this script to bug-gnu-emacs@gnu.org .
	203	EOF
	204
dee26dfa	205	exit 1
66b87493 GM	206	fi
66b87493 GM	207
af3e4d06 PE	208	# If automake is installed in a nonstandard location, find the standard
	209	# location if possible and append it to ACLOCAL_PATH. That way, it will
	210	# find the pkg.m4 that is installed in the standard location.
	211	echo "Checking for pkg.m4..."
	212	AUTORECONF_ENV=
541df9f4	213	env_space=
98e12950 GM	214	ac_dir=`aclocal --print-ac-dir` \|\| {
	215	cat <<EOF
	216	There was a problem running 'aclocal --print-ac-dir'.
	217	The aclocal program is part of automake.
	218	Please check your automake installation.
	219	EOF
	220
	221	exit 1
	222	}
	223
	224	test -n "$ac_dir" && test -r "$ac_dir/pkg.m4" \|\| {
e8e2626f GM	225
	226	# Maybe ACLOCAL_PATH is already set-up.
	227	if test -n "$ACLOCAL_PATH"; then
	228	oIFS=$IFS
	229	IFS=:
	230	for dir in $ACLOCAL_PATH; do
	231	if test -r "$dir/pkg.m4"; then
	232	AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
	233	env_space=' '
	234	break
af3e4d06	235	fi
e8e2626f GM	236	done
	237	IFS=$oIFS
	238	fi
	239
	240	if test -z "$AUTORECONF_ENV"; then
	241	oIFS=$IFS
	242	IFS=:
	243	before_first_aclocal=true
	244	for dir in $PATH; do
	245	if test -x "$dir/aclocal"; then
	246	if $before_first_aclocal; then
	247	before_first_aclocal=false
	248	elif ac_dir=`"$dir/aclocal" --print-ac-dir` && test -r "$ac_dir/pkg.m4"
	249	then
	250	case $ACLOCAL_PATH in
	251	'') ACLOCAL_PATH=$ac_dir;;
	252	?*) ACLOCAL_PATH=$ACLOCAL_PATH:$ac_dir;;
	253	esac
	254	export ACLOCAL_PATH
	255	AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
	256	env_space=' '
	257	break
	258	fi
	259	fi
	260	done
	261	IFS=$oIFS
	262	fi
af3e4d06	263
c3a435fe GM	264	## OK, maybe pkg-config is in a weird place (eg on hydra).
	265	if test -z "$AUTORECONF_ENV"; then
	266	oIFS=$IFS
	267	IFS=:
	268	for dir in $PATH; do
	269	if test -x "$dir/pkg-config"; then
	270	ac_dir=`echo "$dir" \| sed 's\|bin$\|share/aclocal\|'`
	271	if test -r "$ac_dir/pkg.m4"; then
	272	case $ACLOCAL_PATH in
	273	'') ACLOCAL_PATH=$ac_dir;;
	274	?*) ACLOCAL_PATH=$ACLOCAL_PATH:$ac_dir;;
	275	esac
	276	export ACLOCAL_PATH
	277	AUTORECONF_ENV="ACLOCAL_PATH='$ACLOCAL_PATH'"
	278	env_space=' '
	279	break
	280	fi
	281	fi
	282	done
	283	IFS=$oIFS
	284	fi
	285
af3e4d06 PE	286	if test -z "$AUTORECONF_ENV"; then
	287	cat <<EOF
	288	The version of aclocal that you are using cannot find the pkg.m4 file that
	289	pkg-config provides. If it is installed in some unusual directory /FOO/BAR,
	290	set ACLOCAL_PATH='/FOO/BAR' in the environment and run this script again.
	291	EOF
	292	exit 1
	293	fi
	294	}
	295	echo ok
	296
	297	echo 'Your system has the required tools.'
541df9f4	298	echo "Running \"$AUTORECONF_ENV${env_space}autoreconf -fi -I m4\" ..."
66b87493 GM	299
	300
	301	## Let autoreconf figure out what, if anything, needs doing.
6956b278	302	## Use autoreconf's -f option in case autoreconf itself has changed.
af3e4d06	303	autoreconf -fi -I m4 \|\| exit $?
66b87493	304
3f750e43 PE	305	## Create a timestamp, so that './autogen.sh; make' doesn't
	306	## cause 'make' to needlessly run 'autoheader'.
	307	echo timestamp > src/stamp-h.in \|\| exit
	308
4a05c50a	309	echo "You can now run \"./configure$env_space$AUTORECONF_ENV\"."
66b87493 GM	310
	311	exit 0
	312
	313	### autogen.sh ends here