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:58:41 $'
  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" \
 225      || test "ChangeLog" = "$module" \
 226      || test "TEMPLATE" = "$module"; then
 227     echo "gnulib-tool: module $module doesn't exist" 1>&2
 228     module=
 229   fi
 230 }
 231
 232 tags_regexp='\(Description\|Files\|Depends-on\|configure\.ac\|Makefile\.am\|Include\)'
 233 sed_extract_prog=':[    ]*$/ {
 234   :a
 235     n
 236     s/^'"$tags_regexp"':[       ]*$//
 237     tb
 238     p
 239     ba
 240   :b
 241 }'
 242
 243 # func_get_description module
 244 func_get_description ()
 245 {
 246   sed -n -e "/^Description$sed_extract_prog" < "$gnulib_dir/modules/$1"
 247 }
 248
 249 # func_get_filelist module
 250 func_get_filelist ()
 251 {
 252   sed -n -e "/^Files$sed_extract_prog" < "$gnulib_dir/modules/$1"
 253   #echo m4/onceonly.m4
 254   echo m4/onceonly_2_57.m4
 255 }
 256
 257 # func_get_dependencies module
 258 func_get_dependencies ()
 259 {
 260   sed -n -e "/^Depends-on$sed_extract_prog" < "$gnulib_dir/modules/$1"
 261 }
 262
 263 # func_get_autoconf_snippet module
 264 func_get_autoconf_snippet ()
 265 {
 266   sed -n -e "/^configure\.ac$sed_extract_prog" < "$gnulib_dir/modules/$1"
 267 }
 268
 269 # func_get_automake_snippet module
 270 func_get_automake_snippet ()
 271 {
 272   sed -n -e "/^Makefile\.am$sed_extract_prog" < "$gnulib_dir/modules/$1"
 273 }
 274
 275 # func_get_include_directive module
 276 func_get_include_directive ()
 277 {
 278   sed -n -e "/^Include$sed_extract_prog" < "$gnulib_dir/modules/$1" | \
 279   sed -e 's/^\(["<]\)/#include \1/'
 280 }
 281
 282 # func_create_testdir testdir modules
 283 func_create_testdir ()
 284 {
 285   testdir="$1"
 286   modules="$2"
 287   modules=`for m in $modules; do echo $m; done | sort | uniq`
 288
 289   # Determine final module list.
 290   while true; do
 291     xmodules=
 292     for module in $modules; do
 293       func_verify_module
 294       if test -n "$module"; then
 295         xmodules="$xmodules $module "`func_get_dependencies $module`
 296       fi
 297     done
 298     xmodules=`for m in $xmodules; do echo $m; done | sort | uniq`
 299     if test "$xmodules" = "$modules"; then
 300       break
 301     fi
 302     modules="$xmodules"
 303   done
 304   echo "Module list with included dependencies:"
 305   echo "$modules" | sed -e 's/^/  /'
 306
 307   # Determine final file list.
 308   files=
 309   for module in $modules; do
 310     func_verify_module
 311     if test -n "$module"; then
 312       files="$files "`func_get_filelist $module`
 313     fi
 314   done
 315   files=`for f in $files; do echo $f; done | sort | uniq`
 316   echo "File list:"
 317   echo "$files" | sed -e 's/^/  /'
 318
 319   # Create directories.
 320   for d in `echo "$files" | sed -n -e 's,^\(.*\)/[^/]*,\1,p'`; do
 321     mkdir -p "$testdir/$d"
 322   done
 323
 324   # Copy files.
 325   for f in $files; do
 326     ln "$gnulib_dir/$f" "$testdir/$f" 2>/dev/null ||
 327     cp -p "$gnulib_dir/$f" "$testdir/$f"
 328   done
 329
 330   # Create lib/Makefile.am.
 331   mkdir -p "$testdir/lib"
 332   (echo "## Process this file with automake to produce Makefile.in."
 333    echo
 334    echo "AUTOMAKE_OPTIONS = 1.5 gnits no-dependencies"
 335    echo
 336    echo "noinst_LIBRARIES = $libname.a"
 337    echo
 338    echo "$libname"'_a_SOURCES ='
 339    echo "$libname"'_a_LIBADD = @LIBOBJS@'
 340    echo '#'"$libname"'_la_LIBADD = @LTLIBOBJS@'
 341    echo "EXTRA_DIST ="
 342    echo "BUILT_SOURCES ="
 343    echo "SUFFIXES ="
 344    echo "MOSTLYCLEANFILES ="
 345    echo "CLEANFILES ="
 346    echo "DISTCLEANFILES ="
 347    echo "MAINTAINERCLEANFILES ="
 348    for module in $modules; do
 349      func_verify_module
 350      if test -n "$module"; then
 351        func_get_automake_snippet "$module" | sed -e "s,lib_SOURCES,$libname"'_a_SOURCES,g'
 352        if test "$module" = 'alloca'; then
 353          echo "$libname"'_a_LIBADD += @ALLOCA@'
 354          echo '#'"$libname"'_la_LIBADD += @LTALLOCA@'
 355        fi
 356      fi
 357    done
 358   ) > "$testdir/lib/Makefile.am"
 359
 360   # Create m4/Makefile.am.
 361   mkdir -p "$testdir/m4"
 362   (echo "## Process this file with automake to produce Makefile.in."
 363    echo
 364    echo "EXTRA_DIST ="
 365    for f in $files; do
 366      case "$f" in
 367        m4/* )
 368          echo "EXTRA_DIST += "`echo "$f" | sed -e 's,^m4/,,'` ;;
 369      esac
 370    done
 371   ) > "$testdir/m4/Makefile.am"
 372
 373   subdirs="lib m4"
 374
 375   if test -f "$testdir"/m4/gettext.m4; then
 376     # Avoid stupid error message from automake:
 377     # "AM_GNU_GETTEXT used but `po' not in SUBDIRS"
 378     mkdir -p "$testdir/po"
 379     (echo "## Process this file with automake to produce Makefile.in."
 380     ) > "$testdir/po/Makefile.am"
 381     subdirs="$subdirs po"
 382   fi
 383
 384   # Create Makefile.am.
 385   (echo "## Process this file with automake to produce Makefile.in."
 386    echo
 387    echo "AUTOMAKE_OPTIONS = 1.5 foreign"
 388    echo
 389    echo "SUBDIRS = $subdirs"
 390    echo
 391    echo "ACLOCAL_AMFLAGS = -I m4"
 392   ) > "$testdir/Makefile.am"
 393
 394   # Create configure.ac.
 395   (echo "# Process this file with autoconf to produce a configure script."
 396    echo "AC_INIT(dummy,0)"
 397    echo "AM_INIT_AUTOMAKE"
 398    echo
 399    echo "AM_CONFIG_HEADER(config.h)"
 400    echo
 401    echo "AC_PROG_CC"
 402    echo "AC_PROG_INSTALL"
 403    echo "AC_PROG_MAKE_SET"
 404    echo "AC_PROG_RANLIB"
 405    echo
 406    if grep AC_GNU_SOURCE "$testdir"/m4/*.m4 > /dev/null; then
 407      echo "AC_GNU_SOURCE"
 408      echo
 409    fi
 410    for module in $modules; do
 411      func_verify_module
 412      if test -n "$module"; then
 413        func_get_autoconf_snippet "$module"
 414      fi
 415    done
 416    echo
 417    makefiles="Makefile"
 418    for d in $subdirs; do
 419      makefiles="$makefiles $d/Makefile"
 420    done
 421    echo "AC_OUTPUT([$makefiles])"
 422   ) > "$testdir/configure.ac"
 423
 424   # Create autogenerated files.
 425   (cd "$testdir"
 426    echo "executing ${ACLOCAL} -I m4"
 427    ${ACLOCAL} -I m4
 428    echo "executing ${AUTOHEADER}"
 429    ${AUTOHEADER}
 430    echo "executing ${AUTOCONF}"
 431    ${AUTOCONF}
 432    echo "executing ${AUTOMAKE} --add-missing --copy"
 433    ${AUTOMAKE} --add-missing --copy
 434   )
 435   if grep '^BUILT_SOURCES *+=' "$testdir/lib/Makefile.am" > /dev/null; then
 436     (cd "$testdir"
 437      ./configure
 438        cd lib
 439        built_sources=`grep '^BUILT_SOURCES *=' Makefile.in | sed -e 's/^BUILT_SOURCES *=//'`
 440        if test -n "$built_sources"; then
 441          make $built_sources
 442        fi
 443        cd ..
 444      make distclean
 445     )
 446   fi
 447 }
 448
 449 # func_create_megatestdir megatestdir allmodules
 450 func_create_megatestdir ()
 451 {
 452   megatestdir="$1"
 453   allmodules="$2"
 454   if test -z "$allmodules"; then
 455     allmodules=`func_all_modules`
 456   fi
 457
 458   megasubdirs=
 459   # First, all modules one by one.
 460   for onemodule in $allmodules; do
 461     func_create_testdir "$megatestdir/$onemodule" $onemodule
 462     megasubdirs="${megasubdirs}$onemodule "
 463   done
 464   # Then, all modules all together.
 465   # Except fnmatch-posix, which conflicts with fnmatch-gnu. FIXME.
 466   allmodules=`for m in $allmodules; do if test $m != fnmatch-posix; then echo $m; fi; done`
 467   func_create_testdir "$megatestdir/ALL" "$allmodules"
 468   megasubdirs="${megasubdirs}ALL"
 469
 470   # Create Makefile.am.
 471   (echo "## Process this file with automake to produce Makefile.in."
 472    echo
 473    echo "AUTOMAKE_OPTIONS = 1.5 foreign"
 474    echo
 475    echo "SUBDIRS = $megasubdirs"
 476   ) > "$megatestdir/Makefile.am"
 477
 478   # Create configure.ac.
 479   (echo "# Process this file with autoconf to produce a configure script."
 480    echo "AC_INIT(dummy,0)"
 481    echo "AM_INIT_AUTOMAKE"
 482    echo
 483    echo "AC_PROG_MAKE_SET"
 484    echo
 485    echo "AC_CONFIG_SUBDIRS([$megasubdirs])"
 486    echo "AC_OUTPUT([Makefile])"
 487   ) > "$megatestdir/configure.ac"
 488
 489   # Create autogenerated files.
 490   (cd "$megatestdir"
 491    echo "executing ${ACLOCAL}"
 492    ${ACLOCAL}
 493    echo "executing ${AUTOCONF}"
 494    ${AUTOCONF}
 495    echo "executing ${AUTOMAKE} --add-missing --copy Makefile"
 496    ${AUTOMAKE} --add-missing --copy Makefile
 497   )
 498 }
 499
 500 case $mode in
 501   "" )
 502     func_fatal_error "no mode specified" ;;
 503
 504   list )
 505     func_all_modules
 506     ;;
 507
 508   import )
 509     func_fatal_error "NYI" ;;
 510
 511   create-testdir )
 512     if test -z "$destdir"; then
 513       func_fatal_error "please specify --dir option"
 514     fi
 515     mkdir "$destdir"
 516     test -d "$destdir" \
 517       || func_fatal_error "could not create destination directory"
 518     func_create_testdir "$destdir" "$*"
 519     ;;
 520
 521   create-megatestdir )
 522     if test -z "$destdir"; then
 523       func_fatal_error "please specify --dir option"
 524     fi
 525     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 526     func_create_megatestdir "$destdir" "$*"
 527     ;;
 528
 529   test )
 530     test -n "$destdir" || destdir=testdir$$
 531     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 532     func_create_testdir "$destdir" "$*"
 533     cd "$destdir"
 534       mkdir build
 535       cd build
 536         ../configure
 537         make
 538         make check
 539         make distclean
 540         remaining=`find . -type f -print`
 541         if test -n "$remaining"; then
 542           echo "Remaining files:" $remaining 1>&2
 543           echo "gnulib-tool: *** Stop." 1>&2
 544           exit 1
 545         fi
 546       cd ..
 547     cd ..
 548     rm -rf "$destdir"
 549     ;;
 550
 551   megatest )
 552     test -n "$destdir" || destdir=testdir$$
 553     mkdir "$destdir" || func_fatal_error "could not create destination directory"
 554     func_create_megatestdir "$destdir" "$*"
 555     cd "$destdir"
 556       mkdir build
 557       cd build
 558         ../configure
 559         make
 560         make check
 561         make distclean
 562         remaining=`find . -type f -print`
 563         if test -n "$remaining"; then
 564           echo "Remaining files:" $remaining 1>&2
 565           echo "gnulib-tool: *** Stop." 1>&2
 566           exit 1
 567         fi
 568       cd ..
 569     cd ..
 570     rm -rf "$destdir"
 571     ;;
 572
 573   extract-description )
 574     for module
 575     do
 576       func_verify_module
 577       if test -n "$module"; then
 578         func_get_description "$module"
 579       fi
 580     done
 581     ;;
 582
 583   extract-filelist )
 584     for module
 585     do
 586       func_verify_module
 587       if test -n "$module"; then
 588         func_get_filelist "$module"
 589       fi
 590     done
 591     ;;
 592
 593   extract-dependencies )
 594     for module
 595     do
 596       func_verify_module
 597       if test -n "$module"; then
 598         func_get_dependencies "$module"
 599       fi
 600     done
 601     ;;
 602
 603   extract-autoconf-snippet )
 604     for module
 605     do
 606       func_verify_module
 607       if test -n "$module"; then
 608         func_get_autoconf_snippet "$module"
 609       fi
 610     done
 611     ;;
 612
 613   extract-automake-snippet )
 614     for module
 615     do
 616       func_verify_module
 617       if test -n "$module"; then
 618         func_get_automake_snippet "$module"
 619       fi
 620     done
 621     ;;
 622
 623   extract-include-directive )
 624     for module
 625     do
 626       func_verify_module
 627       if test -n "$module"; then
 628         func_get_include_directive "$module"
 629       fi
 630     done
 631     ;;
 632
 633   * )
 634     func_fatal_error "unknown operation mode --$mode" ;;
 635 esac
 636
 637 exit 0