gnome-autogen.sh: Check for yelp.m4 with YELP_HELP_INIT
[platform/upstream/gnome-common.git] / macros2 / gnome-autogen.sh
1 #!/bin/sh
2 # Run this to generate all the initial makefiles, etc.
3
4 #name of package
5 PKG_NAME=${PKG_NAME:-Package}
6 srcdir=${srcdir:-.}
7
8 # default version requirements ...
9 REQUIRED_AUTOCONF_VERSION=${REQUIRED_AUTOCONF_VERSION:-2.53}
10 REQUIRED_AUTOMAKE_VERSION=${REQUIRED_AUTOMAKE_VERSION:-1.9}
11 REQUIRED_LIBTOOL_VERSION=${REQUIRED_LIBTOOL_VERSION:-1.4.3}
12 REQUIRED_GETTEXT_VERSION=${REQUIRED_GETTEXT_VERSION:-0.10.40}
13 REQUIRED_GLIB_GETTEXT_VERSION=${REQUIRED_GLIB_GETTEXT_VERSION:-2.2.0}
14 REQUIRED_INTLTOOL_VERSION=${REQUIRED_INTLTOOL_VERSION:-0.25}
15 REQUIRED_PKG_CONFIG_VERSION=${REQUIRED_PKG_CONFIG_VERSION:-0.14.0}
16 REQUIRED_GTK_DOC_VERSION=${REQUIRED_GTK_DOC_VERSION:-1.0}
17 REQUIRED_DOC_COMMON_VERSION=${REQUIRED_DOC_COMMON_VERSION:-2.3.0}
18 REQUIRED_GNOME_DOC_UTILS_VERSION=${REQUIRED_GNOME_DOC_UTILS_VERSION:-0.4.2}
19
20 # a list of required m4 macros.  Package can set an initial value
21 REQUIRED_M4MACROS=${REQUIRED_M4MACROS:-}
22 FORBIDDEN_M4MACROS=${FORBIDDEN_M4MACROS:-}
23
24 # Not all echo versions allow -n, so we check what is possible. This test is
25 # based on the one in autoconf.
26 ECHO_C=
27 ECHO_N=
28 case `echo -n x` in
29 -n*)
30   case `echo 'x\c'` in
31   *c*) ;;
32   *)   ECHO_C='\c';;
33   esac;;
34 *)
35   ECHO_N='-n';;
36 esac
37
38 # some terminal codes ...
39 boldface="`tput bold 2>/dev/null`"
40 normal="`tput sgr0 2>/dev/null`"
41 printbold() {
42     echo $ECHO_N "$boldface" $ECHO_C
43     echo "$@"
44     echo $ECHO_N "$normal" $ECHO_C
45 }    
46 printerr() {
47     echo "$@" >&2
48 }
49
50 # Usage:
51 #     compare_versions MIN_VERSION ACTUAL_VERSION
52 # returns true if ACTUAL_VERSION >= MIN_VERSION
53 compare_versions() {
54     ch_min_version=$1
55     ch_actual_version=$2
56     ch_status=0
57     IFS="${IFS=         }"; ch_save_IFS="$IFS"; IFS="."
58     set $ch_actual_version
59     for ch_min in $ch_min_version; do
60         ch_cur=`echo $1 | sed 's/[^0-9].*$//'`; shift # remove letter suffixes
61         if [ -z "$ch_min" ]; then break; fi
62         if [ -z "$ch_cur" ]; then ch_status=1; break; fi
63         if [ $ch_cur -gt $ch_min ]; then break; fi
64         if [ $ch_cur -lt $ch_min ]; then ch_status=1; break; fi
65     done
66     IFS="$ch_save_IFS"
67     return $ch_status
68 }
69
70 # Usage:
71 #     version_check PACKAGE VARIABLE CHECKPROGS MIN_VERSION SOURCE
72 # checks to see if the package is available
73 version_check() {
74     vc_package=$1
75     vc_variable=$2
76     vc_checkprogs=$3
77     vc_min_version=$4
78     vc_source=$5
79     vc_status=1
80
81     vc_checkprog=`eval echo "\\$$vc_variable"`
82     if [ -n "$vc_checkprog" ]; then
83         printbold "using $vc_checkprog for $vc_package"
84         return 0
85     fi
86
87     if test "x$vc_package" = "xautomake" -a "x$vc_min_version" = "x1.4"; then
88         vc_comparator="="
89     else
90         vc_comparator=">="
91     fi
92     printbold "checking for $vc_package $vc_comparator $vc_min_version..."
93     for vc_checkprog in $vc_checkprogs; do
94         echo $ECHO_N "  testing $vc_checkprog... " $ECHO_C
95         if $vc_checkprog --version < /dev/null > /dev/null 2>&1; then
96             vc_actual_version=`$vc_checkprog --version | head -n 1 | \
97                                sed 's/^.*[      ]\([0-9.]*[a-z]*\).*$/\1/'`
98             if compare_versions $vc_min_version $vc_actual_version; then
99                 echo "found $vc_actual_version"
100                 # set variables
101                 eval "$vc_variable=$vc_checkprog; \
102                         ${vc_variable}_VERSION=$vc_actual_version"
103                 vc_status=0
104                 break
105             else
106                 echo "too old (found version $vc_actual_version)"
107             fi
108         else
109             echo "not found."
110         fi
111     done
112     if [ "$vc_status" != 0 ]; then
113         printerr "***Error***: You must have $vc_package $vc_comparator $vc_min_version installed"
114         printerr "  to build $PKG_NAME.  Download the appropriate package for"
115         printerr "  from your distribution or get the source tarball at"
116         printerr "    $vc_source"
117         printerr
118         exit $vc_status
119     fi
120     return $vc_status
121 }
122
123 # Usage:
124 #     require_m4macro filename.m4
125 # adds filename.m4 to the list of required macros
126 require_m4macro() {
127     case "$REQUIRED_M4MACROS" in
128         $1\ * | *\ $1\ * | *\ $1) ;;
129         *) REQUIRED_M4MACROS="$REQUIRED_M4MACROS $1" ;;
130     esac
131 }
132
133 forbid_m4macro() {
134     case "$FORBIDDEN_M4MACROS" in
135         $1\ * | *\ $1\ * | *\ $1) ;;
136         *) FORBIDDEN_M4MACROS="$FORBIDDEN_M4MACROS $1" ;;
137     esac
138 }
139
140 # Usage:
141 #     add_to_cm_macrodirs dirname
142 # Adds the dir to $cm_macrodirs, if it's not there yet.
143 add_to_cm_macrodirs() {
144     case $cm_macrodirs in
145     "$1 "* | *" $1 "* | *" $1") ;;
146     *) cm_macrodirs="$cm_macrodirs $1";;
147     esac
148 }
149
150 # Usage:
151 #     print_m4macros_error
152 # Prints an error message saying that autoconf macros were misused
153 print_m4macros_error() {
154     printerr "***Error***: some autoconf macros required to build $PKG_NAME"
155     printerr "  were not found in your aclocal path, or some forbidden"
156     printerr "  macros were found.  Perhaps you need to adjust your"
157     printerr "  ACLOCAL_FLAGS?"
158     printerr
159 }
160
161 # Usage:
162 #     check_m4macros
163 # Checks that all the requested macro files are in the aclocal macro path
164 # Uses REQUIRED_M4MACROS and ACLOCAL variables.
165 check_m4macros() {
166     # construct list of macro directories
167     cm_macrodirs=`$ACLOCAL --print-ac-dir`
168     # aclocal also searches a version specific dir, eg. /usr/share/aclocal-1.9
169     # but it contains only Automake's own macros, so we can ignore it.
170
171     # Read the dirlist file, supported by Automake >= 1.7.
172     if compare_versions 1.7 $AUTOMAKE_VERSION && [ -s $cm_macrodirs/dirlist ]; then
173         cm_dirlist=`sed 's/[    ]*#.*//;/^$/d' $cm_macrodirs/dirlist`
174         if [ -n "$cm_dirlist" ] ; then
175             for cm_dir in $cm_dirlist; do
176                 if [ -d $cm_dir ]; then
177                     add_to_cm_macrodirs $cm_dir
178                 fi
179             done
180         fi
181     fi
182
183     # Parse $ACLOCAL_FLAGS
184     set - $ACLOCAL_FLAGS
185     while [ $# -gt 0 ]; do
186         if [ "$1" = "-I" ]; then
187             add_to_cm_macrodirs "$2"
188             shift
189         fi
190         shift
191     done
192
193     cm_status=0
194     if [ -n "$REQUIRED_M4MACROS" ]; then
195         printbold "Checking for required M4 macros..."
196         # check that each macro file is in one of the macro dirs
197         for cm_macro in $REQUIRED_M4MACROS; do
198             cm_macrofound=false
199             for cm_dir in $cm_macrodirs; do
200                 if [ -f "$cm_dir/$cm_macro" ]; then
201                     cm_macrofound=true
202                     break
203                 fi
204                 # The macro dir in Cygwin environments may contain a file
205                 # called dirlist containing other directories to look in.
206                 if [ -f "$cm_dir/dirlist" ]; then
207                     for cm_otherdir in `cat $cm_dir/dirlist`; do
208                         if [ -f "$cm_otherdir/$cm_macro" ]; then
209                             cm_macrofound=true
210                             break
211                         fi
212                     done
213                 fi
214             done
215             if $cm_macrofound; then
216                 :
217             else
218                 printerr "  $cm_macro not found"
219                 cm_status=1
220             fi
221         done
222     fi
223     if [ "$cm_status" != 0 ]; then
224         print_m4macros_error
225         exit $cm_status
226     fi
227     if [ -n "$FORBIDDEN_M4MACROS" ]; then
228         printbold "Checking for forbidden M4 macros..."
229         # check that each macro file is in one of the macro dirs
230         for cm_macro in $FORBIDDEN_M4MACROS; do
231             cm_macrofound=false
232             for cm_dir in $cm_macrodirs; do
233                 if [ -f "$cm_dir/$cm_macro" ]; then
234                     cm_macrofound=true
235                     break
236                 fi
237             done
238             if $cm_macrofound; then
239                 printerr "  $cm_macro found (should be cleared from macros dir)"
240                 cm_status=1
241             fi
242         done
243     fi
244     if [ "$cm_status" != 0 ]; then
245         print_m4macros_error
246         exit $cm_status
247     fi
248 }
249
250 # try to catch the case where the macros2/ directory hasn't been cleared out.
251 forbid_m4macro gnome-cxx-check.m4
252
253 want_libtool=false
254 want_gettext=false
255 want_glib_gettext=false
256 want_intltool=false
257 want_pkg_config=false
258 want_gtk_doc=false
259 want_gnome_doc_utils=false
260 want_maintainer_mode=false
261
262 configure_files="`find $srcdir -name '{arch}' -prune -o -name '_darcs' -prune -o -name '.??*' -prune -o -name configure.ac -print -o -name configure.in -print`"
263 for configure_ac in $configure_files; do
264     dirname=`dirname $configure_ac`
265     if [ -f $dirname/NO-AUTO-GEN ]; then
266         echo skipping $dirname -- flagged as no auto-gen
267         continue
268     fi
269     if grep "^A[CM]_PROG_LIBTOOL" $configure_ac >/dev/null ||
270        grep "^LT_INIT" $configure_ac >/dev/null; then
271         want_libtool=true
272     fi
273     if grep "^AM_GNU_GETTEXT" $configure_ac >/dev/null; then
274         want_gettext=true
275     fi
276     if grep "^AM_GLIB_GNU_GETTEXT" $configure_ac >/dev/null; then
277         want_glib_gettext=true
278     fi
279     if grep "^AC_PROG_INTLTOOL" $configure_ac >/dev/null ||
280        grep "^IT_PROG_INTLTOOL" $configure_ac >/dev/null; then
281         want_intltool=true
282     fi
283     if grep "^PKG_CHECK_MODULES" $configure_ac >/dev/null; then
284         want_pkg_config=true
285     fi
286     if grep "^GTK_DOC_CHECK" $configure_ac >/dev/null; then
287         want_gtk_doc=true
288     fi
289     if grep "^GNOME_DOC_INIT" $configure_ac >/dev/null; then
290         want_gnome_doc_utils=true
291     fi
292
293     # check that AM_MAINTAINER_MODE is used
294     if grep "^AM_MAINTAINER_MODE" $configure_ac >/dev/null; then
295         want_maintainer_mode=true
296     fi
297
298     if grep "^YELP_HELP_INIT" $configure_ac >/dev/null; then
299         require_m4macro yelp.m4
300     fi
301
302     # check to make sure gnome-common macros can be found ...
303     if grep "^GNOME_COMMON_INIT" $configure_ac >/dev/null ||
304        grep "^GNOME_DEBUG_CHECK" $configure_ac >/dev/null ||
305        grep "^GNOME_MAINTAINER_MODE_DEFINES" $configure_ac >/dev/null; then
306         require_m4macro gnome-common.m4
307     fi
308     if grep "^GNOME_COMPILE_WARNINGS" $configure_ac >/dev/null ||
309        grep "^GNOME_CXX_WARNINGS" $configure_ac >/dev/null; then
310         require_m4macro gnome-compiler-flags.m4
311     fi
312 done
313
314 #tell Mandrake autoconf wrapper we want autoconf 2.5x, not 2.13
315 WANT_AUTOCONF_2_5=1
316 export WANT_AUTOCONF_2_5
317 version_check autoconf AUTOCONF 'autoconf2.50 autoconf autoconf-2.53' $REQUIRED_AUTOCONF_VERSION \
318     "http://ftp.gnu.org/pub/gnu/autoconf/autoconf-$REQUIRED_AUTOCONF_VERSION.tar.gz"
319 AUTOHEADER=`echo $AUTOCONF | sed s/autoconf/autoheader/`
320
321 case $REQUIRED_AUTOMAKE_VERSION in
322     1.4*) automake_progs="automake-1.4" ;;
323     1.5*) automake_progs="automake-1.11 automake-1.10 automake-1.9 automake-1.8 automake-1.7 automake-1.6 automake-1.5" ;;
324     1.6*) automake_progs="automake-1.11 automake-1.10 automake-1.9 automake-1.8 automake-1.7 automake-1.6" ;;
325     1.7*) automake_progs="automake-1.11 automake-1.10 automake-1.9 automake-1.8 automake-1.7" ;;
326     1.8*) automake_progs="automake-1.11 automake-1.10 automake-1.9 automake-1.8" ;;
327     1.9*) automake_progs="automake-1.11 automake-1.10 automake-1.9" ;;
328     1.10*) automake_progs="automake-1.11 automake-1.10" ;;
329     1.11*) automake_progs="automake-1.11" ;;
330 esac
331 version_check automake AUTOMAKE "$automake_progs" $REQUIRED_AUTOMAKE_VERSION \
332     "http://ftp.gnu.org/pub/gnu/automake/automake-$REQUIRED_AUTOMAKE_VERSION.tar.gz"
333 ACLOCAL=`echo $AUTOMAKE | sed s/automake/aclocal/`
334
335 if $want_libtool; then
336     version_check libtool LIBTOOLIZE libtoolize $REQUIRED_LIBTOOL_VERSION \
337         "http://ftp.gnu.org/pub/gnu/libtool/libtool-$REQUIRED_LIBTOOL_VERSION.tar.gz"
338     require_m4macro libtool.m4
339 fi
340
341 if $want_gettext; then
342     version_check gettext GETTEXTIZE gettextize $REQUIRED_GETTEXT_VERSION \
343         "http://ftp.gnu.org/pub/gnu/gettext/gettext-$REQUIRED_GETTEXT_VERSION.tar.gz"
344     require_m4macro gettext.m4
345 fi
346
347 if $want_glib_gettext; then
348     version_check glib-gettext GLIB_GETTEXTIZE glib-gettextize $REQUIRED_GLIB_GETTEXT_VERSION \
349         "ftp://ftp.gtk.org/pub/gtk/v2.2/glib-$REQUIRED_GLIB_GETTEXT_VERSION.tar.gz"
350     require_m4macro glib-gettext.m4
351 fi
352
353 if $want_intltool; then
354     version_check intltool INTLTOOLIZE intltoolize $REQUIRED_INTLTOOL_VERSION \
355         "http://ftp.gnome.org/pub/GNOME/sources/intltool/"
356     require_m4macro intltool.m4
357 fi
358
359 if $want_pkg_config; then
360     version_check pkg-config PKG_CONFIG pkg-config $REQUIRED_PKG_CONFIG_VERSION \
361         "'http://www.freedesktop.org/software/pkgconfig/releases/pkgconfig-$REQUIRED_PKG_CONFIG_VERSION.tar.gz"
362     require_m4macro pkg.m4
363 fi
364
365 if $want_gtk_doc; then
366     version_check gtk-doc GTKDOCIZE gtkdocize $REQUIRED_GTK_DOC_VERSION \
367         "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/"
368     require_m4macro gtk-doc.m4
369 fi
370
371 if $want_gnome_doc_utils; then
372     version_check gnome-doc-utils GNOME_DOC_PREPARE gnome-doc-prepare $REQUIRED_GNOME_DOC_UTILS_VERSION \
373         "http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/"
374 fi
375
376 if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
377     version_check gnome-common DOC_COMMON gnome-doc-common \
378         $REQUIRED_DOC_COMMON_VERSION " "
379 fi
380
381 check_m4macros
382
383 if [ "$#" = 0 -a "x$NOCONFIGURE" = "x" ]; then
384   printerr "**Warning**: I am going to run \`configure' with no arguments."
385   printerr "If you wish to pass any to it, please specify them on the"
386   printerr \`$0\'" command line."
387   printerr
388 fi
389
390 topdir=`pwd`
391 for configure_ac in $configure_files; do 
392     dirname=`dirname $configure_ac`
393     basename=`basename $configure_ac`
394     if [ -f $dirname/NO-AUTO-GEN ]; then
395         echo skipping $dirname -- flagged as no auto-gen
396     elif [ ! -w $dirname ]; then
397         echo skipping $dirname -- directory is read only
398     else
399         printbold "Processing $configure_ac"
400         cd $dirname
401
402         # Note that the order these tools are called should match what
403         # autoconf's "autoupdate" package does.  See bug 138584 for
404         # details.
405
406         # programs that might install new macros get run before aclocal
407         if grep "^A[CM]_PROG_LIBTOOL" $basename >/dev/null ||
408            grep "^LT_INIT" $basename >/dev/null; then
409             printbold "Running $LIBTOOLIZE..."
410             $LIBTOOLIZE --force --copy || exit 1
411         fi
412
413         if grep "^AM_GLIB_GNU_GETTEXT" $basename >/dev/null; then
414             printbold "Running $GLIB_GETTEXTIZE... Ignore non-fatal messages."
415             echo "no" | $GLIB_GETTEXTIZE --force --copy || exit 1
416         elif grep "^AM_GNU_GETTEXT" $basename >/dev/null; then
417            if grep "^AM_GNU_GETTEXT_VERSION" $basename > /dev/null; then
418                 printbold "Running autopoint..."
419                 autopoint --force || exit 1
420            else
421                 printbold "Running $GETTEXTIZE... Ignore non-fatal messages."
422                 echo "no" | $GETTEXTIZE --force --copy || exit 1
423            fi
424         fi
425
426         if grep "^AC_PROG_INTLTOOL" $basename >/dev/null ||
427            grep "^IT_PROG_INTLTOOL" $basename >/dev/null; then
428             printbold "Running $INTLTOOLIZE..."
429             $INTLTOOLIZE --force --copy --automake || exit 1
430         fi
431         if grep "^GTK_DOC_CHECK" $basename >/dev/null; then
432             printbold "Running $GTKDOCIZE..."
433             $GTKDOCIZE --copy || exit 1
434         fi
435
436         if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
437             printbold "Running gnome-doc-common..."
438             gnome-doc-common --copy || exit 1
439         fi
440         if grep "^GNOME_DOC_INIT" $basename >/dev/null; then
441             printbold "Running $GNOME_DOC_PREPARE..."
442             $GNOME_DOC_PREPARE --force --copy || exit 1
443         fi
444
445         # Now run aclocal to pull in any additional macros needed
446
447         # if the AC_CONFIG_MACRO_DIR() macro is used, pass that
448         # directory to aclocal.
449         m4dir=`cat "$basename" | grep '^AC_CONFIG_MACRO_DIR' | sed -n -e 's/AC_CONFIG_MACRO_DIR(\([^()]*\))/\1/p' | sed -e 's/^\[\(.*\)\]$/\1/' | sed -e 1q`
450         if [ -n "$m4dir" ]; then
451             m4dir="-I $m4dir"
452         fi
453         printbold "Running $ACLOCAL..."
454         $ACLOCAL $m4dir $ACLOCAL_FLAGS || exit 1
455
456         if grep "GNOME_AUTOGEN_OBSOLETE" aclocal.m4 >/dev/null; then
457             printerr "*** obsolete gnome macros were used in $configure_ac"
458         fi
459
460         # Now that all the macros are sorted, run autoconf and autoheader ...
461         printbold "Running $AUTOCONF..."
462         $AUTOCONF || exit 1
463         if grep "^A[CM]_CONFIG_HEADER" $basename >/dev/null; then
464             printbold "Running $AUTOHEADER..."
465             $AUTOHEADER || exit 1
466             # this prevents automake from thinking config.h.in is out of
467             # date, since autoheader doesn't touch the file if it doesn't
468             # change.
469             test -f config.h.in && touch config.h.in
470         fi
471
472         # Finally, run automake to create the makefiles ...
473         printbold "Running $AUTOMAKE..."
474         if [ -f COPYING ]; then
475           cp -pf COPYING COPYING.autogen_bak
476         fi
477         if [ -f INSTALL ]; then
478           cp -pf INSTALL INSTALL.autogen_bak
479         fi
480         if [ $REQUIRED_AUTOMAKE_VERSION != 1.4 ]; then
481             $AUTOMAKE --gnu --add-missing --force --copy -Wno-portability || exit 1
482         else
483             $AUTOMAKE --gnu --add-missing --copy || exit 1
484         fi
485         if [ -f COPYING.autogen_bak ]; then
486           cmp COPYING COPYING.autogen_bak > /dev/null || cp -pf COPYING.autogen_bak COPYING
487           rm -f COPYING.autogen_bak
488         fi
489         if [ -f INSTALL.autogen_bak ]; then
490           cmp INSTALL INSTALL.autogen_bak > /dev/null || cp -pf INSTALL.autogen_bak INSTALL
491           rm -f INSTALL.autogen_bak
492         fi
493
494         cd "$topdir"
495     fi
496 done
497
498 conf_flags=""
499
500 if $want_maintainer_mode; then
501     conf_flags="--enable-maintainer-mode"
502 fi
503
504 if test x$NOCONFIGURE = x; then
505     printbold Running $srcdir/configure $conf_flags "$@" ...
506     $srcdir/configure $conf_flags "$@" \
507         && echo Now type \`make\' to compile $PKG_NAME || exit 1
508 else
509     echo Skipping configure process.
510 fi