gnulib-tool

   1 #! /bin/sh
   2 #
   3 # Copyright (C) 2002, 2003 Free Software Foundation, Inc.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2, or (at your option)
   8 # any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18 #
  19
  20 # This program is meant for authors or maintainers which want to import
  21 # modules from gnulib into their packages.
  22
  23 progname=$0
  24 package=gnulib
  25 cvsdatestamp='$Date: 2003-01-01 14:49:10 $'
  26 last_checkin_date=`echo "$cvsdatestamp" | sed -e 's,^\$[D]ate: ,,'`
  27 version=`echo "$last_checkin_date" | sed -e 's/ .*$//' -e 's,/,-,g'`
  28
  29 # You can set AUTOCONFPATH to empty if autoconf 2.57 is already in your PATH.
  30 AUTOCONFPATH=
  31 case $USER in
  32   bruno )
  33     AUTOCONFBINDIR=/packages/gnu-inst-autoconf/2.57/bin
  34     AUTOCONFPATH="eval env PATH=${AUTOCONFBINDIR}:\$PATH "
  35     ;;
  36 esac
  37
  38 AUTOCONF="${AUTOCONFPATH}autoconf"
  39 AUTOHEADER="${AUTOCONFPATH}autoheader"
  40 AUTOMAKE="${AUTOCONFPATH}automake-1.7"
  41 ACLOCAL="aclocal-1.7"
  42
  43 # func_usage
  44 # outputs to stdout the --help usage message.
  45 func_usage ()
  46 {
  47   echo "\
  48 Usage: gnulib-tool --list
  49        gnulib-tool --import module1 ... moduleN
  50        gnulib-tool --create-testdir --dir=directory module1 ... moduleN
  51        gnulib-tool --create-megatestdir --dir=directory [module1 ... moduleN]
  52        gnulib-tool --test --dir=directory module1 ... moduleN
  53        gnulib-tool --megatest --dir=directory [module1 ... moduleN]
  54        gnulib-tool --extract-description module
  55        gnulib-tool --extract-filelist module
  56        gnulib-tool --extract-dependencies module
  57        gnulib-tool --extract-autoconf-snippet module
  58        gnulib-tool --extract-automake-snippet module
  59        gnulib-tool --extract-include-directive module
  60
  61 Operation modes:
  62       --list                print the available module names
  63       --import              import the given modules into the current package
  64       --create-testdir      create a scratch package with the given modules
  65       --create-megatestdir  create a mega scratch package with the given modules
  66                             one by one and all together
  67       --test                test the combination of the given modules
  68                             (recommended to use CC="gcc -Wall -Werror" here)
  69       --megatest            test the given modules one by one and all together
  70                             (recommended to use CC="gcc -Wall -Werror" here)
  71       --extract-description        extract the description
  72       --extract-filelist           extract the list of files
  73       --extract-dependencies       extract the dependencies
  74       --extract-autoconf-snippet   extract the snippet for configure.ac
  75       --extract-automake-snippet   extract the snippet for lib/Makefile.am
  76       --extract-include-directive  extract the #include directive
  77
  78 Options:
  79       --dir=DIRECTORY       specify the target directory
  80       --lib=libRARY         specify the library name
  81       --no-changelog        don't update or create ChangeLog files
  82
  83 Report bugs to <bug-gnulib@gnu.org>."
  84 }
  85
  86 # func_version
  87 # outputs to stdout the --version message.
  88 func_version ()
  89 {
  90   echo "$progname (GNU $package) $version"
  91   echo "Copyright (C) 2002 Free Software Foundation, Inc.
  92 This is free software; see the source for copying conditions.  There is NO
  93 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE."
  94   echo "Written by" "Bruno Haible"
  95 }
  96
  97 # func_fatal_error message
  98 # outputs to stderr a fatal error message, and terminates the program.
  99 func_fatal_error ()
 100 {
 101   echo "gnulib-tool: *** $1" 1>&2
 102   echo "gnulib-tool: *** Stop." 1>&2
 103   exit 1
 104 }
 105
 106 # Command-line option processing.
 107 # Removes the OPTIONS from the arguments. Sets the variables:
 108 # - mode            list or import or create-testdir or create-megatestdir
 109 # - destdir         from --dir
 110 # - libname         from --lib
 111 # - do_changelog    false if --no-changelog was given, : otherwise
 112 {
 113   mode=
 114   destdir=
 115   libname=libfoo
 116   do_changelog=:
 117
 118   while test $# -gt 0; do
 119     case "$1" in
 120       --list | --lis )
 121         mode=list
 122         shift ;;
 123       --import | --impor | --impo | --imp | --im | --i )
 124         mode=import
 125         shift ;;
 126       --create-testdir | --create-testdi | --create-testd | --create-test | --create-tes | --create-te | --create-t )
 127         mode=create-testdir
 128         shift ;;
 129       --create-megatestdir | --create-megatestdi | --create-megatestd | --create-megatest | --create-megates | --create-megate | --create-megat | --create-mega | --create-meg | --create-me | --create-m )
 130         mode=create-megatestdir
 131         shift ;;
 132       --test | --tes | --te | --t )
 133         mode=test
 134         shift ;;
 135       --megatest | --megates | --megate | --megat | --mega | --meg | --me | --m )
 136         mode=megatest
 137         shift ;;
 138       --extract-* )
 139         mode=`echo "X$1" | sed -e 's/^X--//'`
 140         shift ;;
 141       --dir )
 142         shift
 143         if test $# = 0; then
 144           func_fatal_error "missing argument for --dir"
 145         fi
 146         destdir=$1
 147         shift ;;
 148       --dir=* )
 149         destdir=`echo "X$1" | sed -e 's/^X--dir=//'`
 150         shift ;;
 151       --lib )
 152         shift
 153         if test $# = 0; then
 154           func_fatal_error "missing argument for --lib"
 155         fi
 156         libname=$1
 157         shift ;;
 158       --lib=* )
 159         libname=`echo "X$1" | sed -e 's/^X--lib=//'`
 160         shift ;;
 161       --no-changelog | --no-changelo | --no-changel | --no-change | --no-chang | --no-chan | --no-cha | --no-ch | --no-c )
 162         do_changelog=false
 163         shift ;;
 164       --help | --hel | --he | --h )
 165         func_usage
 166         exit 0 ;;
 167       --version | --versio | --versi | --vers | --ver | --ve | --v )
 168         func_version
 169         exit 0 ;;
 170       -- )
 171         # Stop option prcessing
 172         shift
 173         break ;;
 174       -* )
 175         echo "gnulib-tool: unknown option $1" 1>&2
 176         echo "Try 'gnulib-tool --help' for more information." 1>&2
 177         exit 1 ;;
 178       * )
 179         break ;;
 180     esac
 181   done
 182 }
 183
 184 case "$0" in
 185   /*) self_abspathname="$0" ;;
 186   */*) self_abspathname=`pwd`/"$0" ;;
 187   *) for d in `echo ":$PATH:" | sed -e 's/:::*/:.:/g' | sed -e 's/:/ /g'`; do
 188        if test -x "$d/$0" && test ! -d "$d/$0"; then
 189          self_abspathname="$d/$0"
 190          break
 191        fi
 192      done
 193      if test -z "$self_abspathname"; then
 194        func_fatal_error "could not locate the gnulib-tool program - how did you invoke it?"
 195      fi
 196      ;;
 197 esac
 198 while test -L "$self_abspathname"; do
 199   # Resolve symbolic link.
 200   sedexpr1='s, -> ,#%%#,'
 201   sedexpr2='s,^.*#%%#\(.*\)$,\1,p'
 202   linkval=`LC_ALL=C ls -l "$self_abspathname" | sed -e "$sedexpr1" | sed -n -e "$sedexpr2"`
 203   test -n "$linkval" || break
 204   case "$linkval" in
 205     /* ) self_abspathname="$linkval" ;;
 206     * ) self_abspathname=`echo "$self_abspathname" | sed -e 's,/[^/]*$,,'`/"$linkval" ;;
 207   esac
 208 done
 209 gnulib_dir=`echo "$self_abspathname" | sed -e 's,/[^/]*$,,'`
 210
 211 # func_all_modules
 212 func_all_modules ()
 213 {
 214   (cd "$gnulib_dir/modules" && ls -1) \
 215       | sed -e '/^CVS$/d' -e '/^ChangeLog$/d' -e '/^TEMPLATE$/d' \
 216       | sort
 217 }
 218
 219 # func_verify_module
 220 # verifies a module name
 221 func_verify_module ()
 222 {
 223   if test ! -f "$gnulib_dir/modules/$module" \
 224      || test "CVS" = "$module" || test "ChangeLog" = "$module" || test "TEMPLATE" = "$module"; then
 225     echo "gnulib-tool: module $1 doesn't exist" 1>&2
 226     module=
 227   fi
 228 }
 229
 230 tags_regexp='\(Description\|Files\|Depends-on\|configure\.ac\|Makefile\.am\|Include\)'
 231 sed_extract_prog=':[    ]*$/ {
 232   :a
 233     n
 234     s/^'"$tags_regexp"':[       ]*$//
 235     tb
 236     p
 237     ba
 238   :b
 239 }'
 240
 241 # func_get_description module
 242 func_get_description ()
 243 {
 244   sed -n -e "/^Description$sed_extract_prog" < "$gnulib_dir/modules/$1"
 245 }
 246
 247 # func_get_filelist module
 248 func_get_filelist ()
 249 {
 250   sed -n -e "/^Files$sed_extract_prog" < "$gnulib_dir/modules/$1"
 251   #echo m4/onceonly.m4
 252   echo m4/onceonly_2_57.m4
 253 }
 254
 255 # func_get_dependencies module
 256 func_get_dependencies ()
 257 {
 258   sed -n -e "/^Depends-on$sed_extract_prog" < "$gnulib_dir/modules/$1"
 259 }
 260
 261 # func_get_autoconf_snippet module
 262 func_get_autoconf_snippet ()
 263 {
 264   sed -n -e "/^configure\.ac$sed_extract_prog" < "$gnulib_dir/modules/$1"
 265 }
 266
 267 # func_get_automake_snippet module
 268 func_get_automake_snippet ()
 269 {
 270   sed -n -e "/^Makefile\.am$sed_extract_prog" < "$gnulib_dir/modules/$1"
 271 }
 272
 273 # func_get_include_directive module
 274 func_get_include_directive ()
 275 {
 276   sed -n -e "/^Include$sed_extract_prog" < "$gnulib_dir/modules/$1" | \
 277   sed -e 's/^\(["<]\)/#include \1/'
 278 }
 279
 280 # func_create_testdir testdir modules
 281 func_create_testdir ()
 282 {
 283   testdir="$1"
 284   modules="$2"
 285   modules=`for m in $modules; do echo $m; done | sort | uniq`
 286
 287   # Determine final module list.
 288   while true; do
 289     xmodules=
 290     for module in $modules; do
 291       func_verify_module
 292       if test -n "$module"; then
 293         xmodules="$xmodules $module "`func_get_dependencies $module`
 294       fi
 295     done
 296     xmodules=`for m in $xmodules; do echo $m; done | sort | uniq`
 297     if test "$xmodules" = "$modules"; then
 298       break
 299     fi
 300     modules="$xmodules"
 301   done
 302   echo "Module list with included dependencies:"
 303   echo "$modules" | sed -e 's/^/  /'
 304
 305   # Determine final file list.
 306   files=
 307   for module in $modules; do
 308     func_verify_module
 309     if test -n "$module"; then
 310       files="$files "`func_get_filelist $module`
 311     fi
 312   done
 313   files=`for f in $files; do echo $f; done | sort | uniq`
 314   echo "File list:"
 315   echo "$files" | sed -e 's/^/  /'
 316
 317   # Create directories.
 318   for d in `echo "$files" | sed -n -e 's,^\(.*\)/[^/]*,\1,p'`; do
 319     mkdir -p "$testdir/$d"
 320   done
 321
 322   # Copy files.
 323   for f in $files; do
 324     ln "$gnulib_dir/$f" "$testdir/$f" 2>/dev/null ||
 325     cp -p "$gnulib_dir/$f" "$testdir/$f"
 326   done
 327
 328   # Create lib/Makefile.am.
 329   mkdir -p "$testdir/lib"
 330   (echo "## Process this file with automake to produce Makefile.in."
 331    echo
 332    echo "AUTOMAKE_OPTIONS = 1.5 gnits no-dependencies"
 333    echo
 334    echo "noinst_LIBRARIES = $libname.a"
 335    echo
 336    echo "$libname"'_a_SOURCES ='
 337    echo "$libname"'_a_LIBADD = @LIBOBJS@'
 338    echo '#'"$libname"'_la_LIBADD = @LTLIBOBJS@'
 339    echo "EXTRA_DIST ="
 340    echo "BUILT_SOURCES ="
 341    echo "SUFFIXES ="
 342    echo "MOSTLYCLEANFILES ="
 343    echo "CLEANFILES ="
 344    echo "DISTCLEANFILES ="
 345    echo "MAINTAINERCLEANFILES ="
 346    for module in $modules; do
 347      func_verify_module
 348      if test -n "$module"; then
 349        func_get_automake_snippet "$module" | sed -e "s,lib_SOURCES,$libname"'_a_SOURCES,g'
 350        if test "$module" = 'alloca'; then
 351          echo "$libname"'_a_LIBADD += @ALLOCA@'
 352          echo '#'"$libname"'_la_LIBADD += @LTALLOCA@'
 353        fi
 354      fi
 355    done
 356   ) > "$testdir/lib/Makefile.am"
 357
 358   # Create m4/Makefile.am.
 359   mkdir -p "$testdir/m4"
 360   (echo "## Process this file with automake to produce Makefile.in."
 361    echo
 362    echo "EXTRA_DIST ="
 363    for f in $files; do
 364      case "$f" in
 365        m4/* )
 366          echo "EXTRA_DIST += "`echo "$f" | sed -e 's,^m4/,,'` ;;
 367      esac
 368    done
 369   ) > "$testdir/m4/Makefile.am"
 370
 371   subdirs="lib m4"
 372
 373   if test -f "$testdir"/m4/gettext.m4; then
 374     # Avoid stupid error message from automake:
 375     # "AM_GNU_GETTEXT used but `po' not in SUBDIRS"
 376     mkdir -p "$testdir/po"
 377     (echo "## Process this file with automake to produce Makefile.in."
 378     ) > "$testdir/po/Makefile.am"
 379     subdirs="$subdirs po"
 380   fi
 381
 382   # Create Makefile.am.
 383   (echo "## Process this file with automake to produce Makefile.in."
 384    echo
 385    echo "AUTOMAKE_OPTIONS = 1.5 foreign"
 386    echo
 387    echo "SUBDIRS = $subdirs"
 388    echo
 389    echo "ACLOCAL_AMFLAGS = -I m4"
 390   ) > "$testdir/Makefile.am"
 391
 392   # Create configure.ac.
 393   (echo "# Process this file with autoconf to produce a configure script."
 394    echo "AC_INIT(dummy,0)"
 395    echo "AM_INIT_AUTOMAKE"
 396    echo
 397    echo "AM_CONFIG_HEADER(config.h)"
 398    echo
 399    echo "AC_PROG_CC"
 400    echo "AC_PROG_INSTALL"
 401    echo "AC_PROG_MAKE_SET"
 402    echo "AC_PROG_RANLIB"
 403    echo
 404    if grep AC_GNU_SOURCE "$testdir"/m4/*.m4 > /dev/null; then
 405      echo "AC_GNU_SOURCE"
 406      echo
 407    fi
 408    for module in $modules; do
 409      func_verify_module
 410      if test -n "$module"; then
 411        func_get_autoconf_snippet "$module"
 412      fi
 413    done
 414    echo
 415    makefiles="Makefile"
 416    for d in $subdirs; do
 417      makefiles="$makefiles $d/Makefile"
 418    done
 419    echo "AC_OUTPUT([$makefiles])"
 420   ) > "$testdir/configure.ac"
 421
 422   # Create autogenerated files.
 423   (cd "$testdir"
 424    echo "executing ${ACLOCAL} -I m4"
 425    ${ACLOCAL} -I m4
 426    echo "executing ${AUTOHEADER}"
 427    ${AUTOHEADER}
 428    echo "executing ${AUTOCONF}"
 429    ${AUTOCONF}
 430    echo "executing ${AUTOMAKE} --add-missing --copy"
 431    ${AUTOMAKE} --add-missing --copy
 432   )
 433   if grep '^BUILT_SOURCES *+=' "$testdir/lib/Makefile.am" > /dev/null; then
 434     (cd "$testdir"
 435      ./configure
 436        cd lib
 437        built_sources=`grep '^BUILT_SOURCES *=' Makefile.in | sed -e 's/^BUILT_SOURCES *=//'`
 438        if test -n "$built_sources"; then
 439          make $built_sources
 440        fi
 441        cd ..
 442      make distclean
 443     )
 444   fi
 445 }
 446
 447 # func_create_megatestdir megatestdir allmodules
 448 func_create_megatestdir ()
 449 {
 450   megatestdir="$1"
 451   allmodules="$2"
 452   if test -z "$allmodules"; then
 453     allmodules=`func_all_modules`
 454   fi
 455
 456   megasubdirs=
 457   # First, all modules one by one.
 458   for onemodule in $allmodules; do
 459     func_create_testdir "$megatestdir/$onemodule" $onemodule
 460     megasubdirs="${megasubdirs}$onemodule "
 461   done
 462   # Then, all modules all together.
 463   # Except fnmatch-posix, which conflicts with fnmatch-gnu. FIXME.
 464   allmodules=`for m in $allmodules; do if test $m != fnmatch-posix; then echo $m; fi; done`
 465   func_create_testdir "$megatestdir/ALL" "$allmodules"
 466   megasubdirs="${megasubdirs}ALL"
 467
 468   # Create Makefile.am.
 469   (echo "## Process this file with automake to produce Makefile.in."
 470    echo
 471    echo "AUTOMAKE_OPTIONS = 1.5 foreign"
 472    echo
 473    echo "SUBDIRS = $megasubdirs"
 474   ) > "$megatestdir/Makefile.am"
 475
 476   # Create configure.ac.
 477   (echo "# Process this file with autoconf to produce a configure script."
 478    echo "AC_INIT(dummy,0)"
 479    echo "AM_INIT_AUTOMAKE"
 480    echo
 481    echo "AC_PROG_MAKE_SET"
 482    echo
 483    echo "AC_CONFIG_SUBDIRS([$megasubdirs])"
 484    echo "AC_OUTPUT([Makefile])"
 485   ) > "$megatestdir/configure.ac"
 486
 487   # Create autogenerated files.
 488   (cd "$megatestdir"
 489    echo "executing ${ACLOCAL}"
 490    ${ACLOCAL}
 491    echo "executing ${AUTOCONF}"
 492    ${AUTOCONF}
 493    echo "executing ${AUTOMAKE} --add-missing --copy Makefile"
 494    ${AUTOMAKE} --add-missing --copy Makefile
 495   )
 496 }
 497
 498 case $mode in
 499   "" )
 500     func_fatal_error "no mode specified" ;;
 501
 502   list )
 503     func_all_modules
 504     ;;
 505
 506   import )
 507     func_fatal_error "NYI" ;;
 508
 509   create-testdir )
 510     if test -z "$destdir"; then
 511       func_fatal_error "please specify --dir option"
 512     fi
 513     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 514     func_create_testdir "$destdir" "$*"
 515     ;;
 516
 517   create-megatestdir )
 518     if test -z "$destdir"; then
 519       func_fatal_error "please specify --dir option"
 520     fi
 521     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 522     func_create_megatestdir "$destdir" "$*"
 523     ;;
 524
 525   test )
 526     test -n "$destdir" || destdir=testdir$$
 527     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 528     func_create_testdir "$destdir" "$*"
 529     cd "$destdir"
 530       mkdir build
 531       cd build
 532         ../configure
 533         make
 534         make check
 535         make distclean
 536         remaining=`find . -type f -print`
 537         if test -n "$remaining"; then
 538           echo "Remaining files:" $remaining 1>&2
 539           echo "gnulib-tool: *** Stop." 1>&2
 540           exit 1
 541         fi
 542       cd ..
 543     cd ..
 544     rm -rf "$destdir"
 545     ;;
 546
 547   megatest )
 548     test -n "$destdir" || destdir=testdir$$
 549     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 550     func_create_megatestdir "$destdir" "$*"
 551     cd "$destdir"
 552       mkdir build
 553       cd build
 554         ../configure
 555         make
 556         make check
 557         make distclean
 558         remaining=`find . -type f -print`
 559         if test -n "$remaining"; then
 560           echo "Remaining files:" $remaining 1>&2
 561           echo "gnulib-tool: *** Stop." 1>&2
 562           exit 1
 563         fi
 564       cd ..
 565     cd ..
 566     rm -rf "$destdir"
 567     ;;
 568
 569   extract-description )
 570     for module
 571     do
 572       func_verify_module
 573       if test -n "$module"; then
 574         func_get_description "$module"
 575       fi
 576     done
 577     ;;
 578
 579   extract-filelist )
 580     for module
 581     do
 582       func_verify_module
 583       if test -n "$module"; then
 584         func_get_filelist "$module"
 585       fi
 586     done
 587     ;;
 588
 589   extract-dependencies )
 590     for module
 591     do
 592       func_verify_module
 593       if test -n "$module"; then
 594         func_get_dependencies "$module"
 595       fi
 596     done
 597     ;;
 598
 599   extract-autoconf-snippet )
 600     for module
 601     do
 602       func_verify_module
 603       if test -n "$module"; then
 604         func_get_autoconf_snippet "$module"
 605       fi
 606     done
 607     ;;
 608
 609   extract-automake-snippet )
 610     for module
 611     do
 612       func_verify_module
 613       if test -n "$module"; then
 614         func_get_automake_snippet "$module"
 615       fi
 616     done
 617     ;;
 618
 619   extract-include-directive )
 620     for module
 621     do
 622       func_verify_module
 623       if test -n "$module"; then
 624         func_get_include_directive "$module"
 625       fi
 626     done
 627     ;;
 628
 629   * )
 630     func_fatal_error "unknown operation mode --$mode" ;;
 631 esac
 632
 633 exit 0