AutoGen.pm

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # Module to generate all the initial makefiles etc.
   5 # Copyright (C) 2002 Jan Kratochvil <project-macros@jankratochvil.net>
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; exactly version 2 of June 1991 is required
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20
  21 package AutoGen;
  22 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
  23 use vars qw($VERSION);
  24 $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  25 use strict;
  26 use warnings;
  27
  28 BEGIN {
  29         my @missing;
  30         for (split "\n",<<'HERE') {
  31                 use Carp qw(cluck confess);
  32                 use Getopt::Long;       # &GetOptions, $Getopt::Long::*
  33                 use File::Basename;     # &basename
  34                 use File::Grep qw(fgrep);
  35                 use File::HomeDir;      # &home
  36                 use File::Remove qw(remove);
  37                 use File::NCopy qw(copy);
  38                 use File::chdir;        # $CWD
  39                 use File::Touch;        # &touch
  40                 use POSIX qw(WIFEXITED WEXITSTATUS WIFSIGNALED WTERMSIG WIFSTOPPED WSTOPSIG);
  41 HERE
  42                 eval "$_\n; 1;" or push @missing,(/^\s*use\s+([^\s;]+)/)[0];
  43                 }
  44         die "You are missing some modules - install them by:\n"
  45                                         ."\tperl -MCPAN -e 'install qw(".join(" ",@missing).")'\n"
  46                         if @missing;
  47         }
  48
  49 our %Options;
  50
  51 sub _help
  52 {
  53         return '
  54 Beware: '.basename($0).' is a tool only for maintainers!
  55
  56 Supported parameters:
  57  --rpm       Build RPM packages locally (needs /usr/src/(redhat|packages)/ access)
  58  --rpmtest   Build RPM like "rpm" but w/o gpg/pgp signing
  59  --clean     Standard cleanup method
  60  --fullclean Like clean but even the .cvsignore files are removed
  61  --copy      Behave exactly like in default mode but copy all instead of symlinks
  62  -h|--help   Print this help message.
  63 '.($Options{"help"} || "");
  64 }
  65
  66 sub _readfile
  67 {
  68 my($filename)=@_;
  69
  70         local $/=undef();
  71         local *F;
  72         open F,$filename or confess "Open \"$filename\": $!";
  73         my $r=<F>;
  74         close F or cluck "Close \"$filename\": $!";
  75         return $r;
  76 }
  77
  78 sub _writefile
  79 {
  80 my($filename,@content)=@_;
  81
  82         local *F;
  83         open F,">".$filename or confess "rewrite \"$filename\": $!";
  84         print F @content;
  85         close F or cluck "close \"$filename\": $!";
  86 }
  87
  88 my %_rpmeval_cache;
  89 sub _rpmeval
  90 {
  91 my(@names)=@_;
  92
  93         my @r=map({
  94                 my $name=$_;
  95                 my $nameref=\$_rpmeval_cache{$name};
  96                 $$nameref=_readfile('rpm --eval %'.$name.'|') if !defined $$nameref;
  97                 chomp $$nameref;
  98                 $$nameref;
  99                 } @names);
 100         return @r if wantarray();
 101         confess "Scalar return for ".scalar(@r)." values" if 1!=@r;
 102         return $r[0];
 103 }
 104
 105 sub _system
 106 {
 107 my(@args)=@_;
 108
 109         system(@args) and confess join(" ",@args).": $?=".join(",",
 110                         (!WIFEXITED($?)   ? () : ("EXITSTATUS(".WEXITSTATUS($?).")")),
 111                         (!WIFSIGNALED($?) ? () : ("TERMSIG("   .WTERMSIG($?)   .")")),
 112                         (!WIFSTOPPED($?)  ? () : ("STOPSIG("   .WSTOPSIG($?)   .")")),
 113                         );
 114 }
 115
 116 # Assumed wildcard pattern expansion to exactly one item if !$nocheck
 117 sub _copy
 118 {
 119 my(@files)=@_;
 120
 121         my $nocheck=shift @files if $files[0] eq "nocheck";
 122         my $dest=pop @files;
 123         @files==copy @files,$dest or $nocheck or confess "$!";
 124 }
 125
 126 # Assumed wildcard pattern expansion to exactly one item if !$nocheck
 127 sub _remove
 128 {
 129 my(@files)=@_;
 130
 131         my $nocheck=shift @files if $files[0] eq "nocheck";
 132         my $flag=shift @files if ref $files[0];
 133         @files==remove((!$flag ? () : $flag),@files) or $nocheck or confess "$!";
 134 }
 135
 136 # FIXME: File::NCopy exists but File::NMove doesn't
 137 sub _move
 138 {
 139 my(@files)=@_;
 140
 141         my $dest=pop @files;
 142         _copy @files,$dest;
 143         _remove @files;
 144 }
 145
 146 # $args{
 147 #       "sign"=>bool,
 148 #       },
 149 sub _rpmbuild
 150 {
 151 my($class,%args)=@_;
 152
 153         my $name=$Options{"name"};
 154         _remove "nocheck",\1,
 155                         _rpmeval("_tmppath" )."/$name-*-root",
 156                         _rpmeval("_builddir")."/$name-*";
 157         my($specsrc)=map((-e $_ ? $_ : "$name.spec.in"),"$name.spec.m4.in");
 158         my $spec=_readfile $specsrc;
 159         $spec=~s/\\\n/ /gs;
 160         $class->run(%Options,
 161                         "ARGV"=>["--copy"],
 162                         "configure_args"=>[split /\s+/,($spec=~/^%configure\s+(.*)$/m)[0]],
 163                         );
 164         _remove "ChangeLog";    # force its rebuild by Makefile/rcs2log
 165         _system "make dist $name.spec";
 166         _copy "$name-*.tar.gz",_rpmeval("_sourcedir");
 167         _system(join(" ","rpmbuild",
 168                         "-ba",
 169                         "--rmsource",   # _remove _rpmeval("_sourcedir")."/$name-*.tar.gz";
 170                         "--clean",      # _remove _rpmeval("_builddir")."/$name-VERSION";
 171                         (!$args{"sign"} ? () : "--sign"),
 172                         "$name.spec",
 173                         ));
 174         _system "make dist-tarZ" if $Options{"dist-tarZ"};
 175         _move _rpmeval("_srcrpmdir")."/$name-*.src.rpm",".";
 176         _move _rpmeval("_rpmdir")."/"._rpmeval("_arch")."/$name-*."._rpmeval("_arch").".rpm",".";
 177   _system "ls -l $name-*";
 178         exit 0; # should never return
 179 }
 180
 181 # WARNING: doesn't respect %Options change!
 182 my @_cleanfiles_cache;
 183 sub _cleanfiles
 184 {
 185         # maintainer-clean hack is not safe, please list all files for 'rm'.
 186         # When the filename doesn't contain '/', it is applied to ALL directories.
 187         # Please note that files exactly in root dir MUST have ./ in the front
 188         #   (to not to be considered as ALL-directories files).
 189
 190         if (!@_cleanfiles_cache) {
 191                 @_cleanfiles_cache=map({
 192                                                 local $_=$_;    # Prevent: Modification of a read-only value attempted
 193                                                 s/\Q<name>\E/$Options{"name"}/ego;
 194                                                 s#/+#/#g;
 195                                                 # "*xyzzy" basename -> "*xyzzy",".*xyzzy" for proper cleaning
 196                                                 (!m#^((?:.*/)?)([*][^/]*)$# ? ($_) : ("$1$2","$1.$2"));
 197                                                 }
 198                                 (
 199                                 ".#*",  # Possible attempt to put comments in qw() list
 200                                 qw(
 201                                                 *~
 202                                                 *.orig *.rej
 203                                                 core
 204                                                 Makefile Makefile.in
 205                                                 TAGS tags ID
 206                                                 .deps .libs
 207                                                 *.[oa] *.l[oa] *.l[oa]T
 208                                                 .cvsignore
 209
 210                                                 ./errs*
 211                                                 ./intl
 212                                                 ./configure ./configure.scan
 213                                                 ./config.guess ./config.status ./config.sub ./config.log ./config.cache
 214                                                 ./config.h ./config.h.in
 215                                                 ./confdefs.h ./conftest* ./autoh[0-9]* ./confcache
 216                                                 ./config.rpath
 217                                                 ./depcomp
 218                                                 ./compile
 219                                                 ./stamp-h ./stamp-h.in ./stamp-h1
 220                                                 ./install-sh
 221                                                 ./aclocal.m4
 222                                                 ./autom4te-*.cache
 223                                                 ./m4
 224                                                 ./missing
 225                                                 ./mkinstalldirs
 226                                                 ./libtool ./ltconfig ./ltmain.sh
 227                                                 ./ChangeLog
 228                                                 ./ABOUT-NLS
 229                                                 ./<name>-[0-9]* ./<name>-devel-[0-9]*
 230                                                 ./<name>.spec ./<name>.m4 ./<name>.spec.m4
 231                                                 ./macros/macros.dep
 232                                                 ./po/Makefile.in.in ./po/POTFILES* ./po/cat-id-tbl.c ./po/cat-id-tbl.tmp
 233                                                 ./po/*.gmo ./po/*.mo ./po/stamp-cat-id ./po/<name>.pot ./po/ChangeLog
 234                                                 ./po/Makevars ./po/Makevars.template ./po/Rules-quot ./po/*.sed ./po/*.sin ./po/*.header
 235                                                 ),
 236                                 map((!$_ ? () : do { my $dir=$_; map("$dir/$_",qw(
 237                                                 *.stamp
 238                                                 sgml*
 239                                                 tmpl*
 240                                                 html*
 241                                                 *.txt
 242                                                 *.txt.bak
 243                                                 *.args
 244                                                 *.hierarchy
 245                                                 *.signals
 246                                                 )); }),$Options{"gtk-doc-dir"}),
 247                                 map((!$_ ? () : do { my $dir=$_; map("$dir/$_",qw(
 248                                                 *.html
 249                                                 *.info*
 250                                                 *.txt
 251                                                 *.tex
 252                                                 *.sgml
 253                                                 )); }),$Options{"docbook-lite-dir"}),
 254                                 map((!$_ ? () : @$_),$Options{"clean"}),
 255                                 ));
 256                 # sanity check
 257                 for (@_cleanfiles_cache) {
 258                                 confess "dir-specific 'clean'-pattern must start with './': $_" if m#^(?!\Q./\E).*/#;
 259                                 };
 260                 }
 261         return @_cleanfiles_cache;
 262 }
 263
 264 sub _cleanfilesfordir
 265 {
 266 my($dir)=@_;
 267
 268         return map({
 269                            if (m#^\Q$dir\E/([^/]+)$#) { # this-dir: "./this-dir/file-name.c"
 270                                         ($1);
 271                                         }
 272                         elsif (m#^[^/]+$#) {    # all-dirs: "file-name.c"; the same as "./*/file-name.c"
 273                                         ($&);
 274                                         }
 275                         elsif (do {     # all-subdirs: "./parent-of-this-dir/*/file-name.c"
 276                                                         m#/[*]/([^/]+)$#;
 277                                                         ($_=$1) && $dir=~m#^\Q$`\E(?:/|$)#;
 278                                                         }) {
 279                                         ($_);
 280                                         }
 281                         else {
 282                                         ();
 283                                         }
 284                         } _cleanfiles());
 285 }
 286
 287 sub _cvsdirs
 288 {
 289 my(@startdirs)=@_;
 290
 291         my @r=();
 292         my @todo=(@startdirs);
 293         while (defined(my $dir=shift @todo)) {
 294                 local *ENTRIES;
 295                 my $entries_filename="$dir/CVS/Entries";
 296                 open ENTRIES,$entries_filename or (cluck "open \"$entries_filename\": $!" and next);
 297                 push @r,$dir;
 298                 local $/="\n";
 299                 my %local=();
 300                 local $_;
 301                 while (<ENTRIES>) {
 302                         chomp;
 303                         next if !m#^D/([^/]+)/#;
 304                         $local{$1}=1;
 305                         }
 306                 close ENTRIES or cluck "close \"$entries_filename\": $!";
 307                 if (-e (my $entries_log_filename=$dir."/CVS/Entries.Log")) {
 308                         local *ENTRIES_LOG;
 309                         if (open ENTRIES_LOG,$entries_log_filename or cluck "open \"$entries_log_filename\": $!") {
 310                                 local $_;
 311                                 while (<ENTRIES_LOG>) {
 312                                         chomp;
 313                                                  if (m#^A D/([^/]*)/#) {
 314                                                 $local{$1}=1;
 315                                                 }
 316                                         elsif (m#^R D/([^/]*)/#) {
 317                                                 delete $local{$1};
 318                                                 }
 319                                         else {
 320                                                 cluck "$entries_log_filename: Unrecognized line $.: $_";
 321                                                 }
 322                                         }
 323                                 close ENTRIES_LOG or cluck "close \"$entries_log_filename\": $!";
 324                                 }
 325                         }
 326                 push @todo,map(("$dir/$_"),keys(%local));
 327                 }
 328         return @r;
 329 }
 330
 331 sub _expandclass
 332 {
 333 my($patt)=@_;
 334
 335         return $patt if $patt!~/\Q[\E(.*?)\Q]\E/;
 336         my($pre,$post)=($`,$'); # FIXME: local($`,$') doesn't work - why?
 337         return map({ _expandclass("$pre$_$post"); } split("",$1));
 338 }
 339
 340 sub run
 341 {
 342 my($class,%options)=@_;
 343
 344         local %Options=%options;
 345         do { require $_ if -e; } for (home()."/.".$Options{"name"}.".autogen.pl");
 346         do { $$_=1 if !defined($$_) && fgrep { /^\s*AUTOMAKE_OPTIONS\s*=[^#]*\bdist-tarZ\b/m; } "Makefile.am"; }
 347                         for (\$Options{"dist-tarZ"});
 348         Getopt::Long::Configure('noignorecase','prefix_pattern=(--|-|\+|)');
 349         local @ARGV=@{$Options{"ARGV"}};
 350         print _help() and confess if !GetOptions(
 351                           "rpm"      ,sub { $class->_rpmbuild("sign"=>1); },
 352                           "rpmtest"  ,sub { $class->_rpmbuild("sign"=>0); },
 353                           "dist"     ,\$Options{"ARGV_dist"},
 354                           "copy!"    ,\$Options{"ARGV_copy"},
 355                           "fullclean",\$Options{"ARGV_fullclean"},
 356                           "clean"    ,\$Options{"ARGV_clean"},
 357                         "h|help"     ,sub { print _help(); exit 0; },
 358                         $Options{"GetOptions_args"},
 359                         ) || @ARGV;
 360
 361         for my $subdir (map((!$_ ? () : @$_),$Options{"subdirs"})) {
 362                 local $CWD=$subdir;
 363                 _system "./autogen.pl",@{$Options{"ARGV"}},"--dist";    # use "--dist" just as fallback!
 364                 }
 365
 366         for my $dir (_cvsdirs(".")) {
 367                 my @cleanfilesfordir=_cleanfilesfordir $dir;
 368                 _writefile $dir."/.cvsignore",map("$_\n",@cleanfilesfordir) if !$Options{"ARGV_fullclean"};
 369                 _remove "nocheck",\1,map({ _expandclass("$dir/$_"); } grep({
 370                                 $Options{"ARGV_fullclean"} or $_ ne ".cvsignore";
 371                                 } @cleanfilesfordir));
 372                 }
 373         return if $Options{"ARGV_clean"} || $Options{"ARGV_fullclean"};
 374
 375         $Options{"aclocal_args"}=[qw(-I macros),map((!$_ ? () : @$_),$Options{"aclocal_args"})];
 376         my $configure_in=_readfile("configure.in");
 377         do { $$_=1 if !defined($$_) && $configure_in=~/^AM_GNU_GETTEXT\b/m; }
 378                         for (\$Options{"want-gettextize"});
 379         do { $$_=1 if !defined($$_) && $configure_in=~/^AM_PROG_LIBTOOL\b/m; }
 380                         for (\$Options{"want-libtoolize"});
 381         do { $$_=1 if !defined($$_) && $configure_in=~/^A[CM]_CONFIG_HEADER\b/m; }
 382                         for (\$Options{"want-autoheader"});
 383         my @copy_arg=(!$Options{"ARGV_copy"} ? () : "--copy");
 384
 385         do { &$_ if $_; } for ($Options{"prep"});
 386         touch "po/POTFILES.in" if -d "po";
 387         if ($Options{"want-gettextize"}) {
 388                 # don't use multi-arg system() here as it would reject "</dev/null" redirection etc.
 389                 for ("expect -c '"
 390                                 .'spawn gettextize --intl --no-changelog '.join(" ",@copy_arg).';'
 391                                 .'expect -timeout -1 "Press Return to acknowledge" {send "\r";exp_continue;} eof;'
 392                                 ."'") {
 393                         _system $_ and confess $_;
 394                         }
 395                 for ("configure.in","Makefile.am") {
 396                         STDERR->printflush("gettextize recovery rename \"$_~\"->\"$_\"... ");
 397                         rename "$_~","$_" or confess "$!";
 398                         STDERR->printflush("ok\n");
 399                         }
 400                 if (!-e "po/Makevars") {
 401                         my $Makevars_template="po/Makevars.template";
 402                         my $makevars=_readfile $Makevars_template;
 403                         $makevars=~s/^(COPYRIGHT_HOLDER)\b.*$/"$1=".$Options{"COPYRIGHT_HOLDER"}/meg
 404                                         or confess "COPYRIGHT_HOLDER not found in $Makevars_template";
 405                         _writefile "po/Makevars",$makevars;
 406                         }
 407                 # Prevent updating of contents during touch of any source file;
 408                 # change the .po contents only when some data get updated
 409                 for my $Makefile_in_in ("po/Makefile.in.in") {
 410                         my $file=_readfile $Makefile_in_in;
 411                         $file=~s%(\$\Q(MSGMERGE_UPDATE)\E) (\$\$\Q{lang}.po \E\$\Q(DOMAIN).pot\E)$%
 412                                         $1.q< --backup=simple --suffix="~" >.$2.q<;>
 413                                                         .q< if test `diff -u $${lang}.po~ $${lang}.po>
 414                                                                                         .q< | sed>
 415                                                                                                         .q< -e '1,/^@@.*@@$$/d'>
 416                                                                                                         .q< -e '/^[+-]"POT-Creation-Date:/d'>
 417                                                                                                         .q< -e '/^[^+-]/d'>
 418                                                                                                         .q< -e '/^[+-]#/d'>
 419                                                                                         .q< | wc -l` -eq 0;then>
 420                                                                         .q< touch --reference=$${lang}.po $${lang}.po~;>
 421                                                                                         .q< mv -f $${lang}.po~ $${lang}.po;>
 422                                                         .q< else>
 423                                                                         .q< rm -f $${lang}.po~;>
 424                                                         .q< fi>
 425                                         %me or confess;
 426                         unlink $Makefile_in_in or confess "$!";
 427                         _writefile $Makefile_in_in,$file;
 428                         }
 429                 }
 430         _system "aclocal",map((!$_ ? () : @$_),$Options{"aclocal_args"});
 431         _system qw(libtoolize),@copy_arg if $Options{"want-libtoolize"};
 432         _system qw(autoheader) if $Options{"want-autoheader"};
 433         # "ChangeLog" is reqd by automake(1)
 434         # Don't remove it afterwards as it may still be needed during automatic automake Makefile rebuilds
 435         File::Touch->new("atime_only"=>1)->touch("ChangeLog");
 436         _system qw(automake --add-missing),@copy_arg;
 437         _system qw(autoconf);
 438         # Why it is left there after RedHat autoconf-2.53-8 ?
 439         _remove "nocheck",\1,"autom4te-*.cache";
 440
 441         return if $Options{"ARGV_dist"};
 442
 443         # 'configure' defaults to CFLAGS '-g -O2' but our --enable-maintainer-mode
 444         # should force '-ggdb3'
 445         $ENV{"CFLAGS"}||="";
 446         # shared/static switching cannot be based on maintainer-mode in configure
 447         _system(qw(./configure --enable-maintainer-mode),
 448                         ($Options{"want-libtoolize"} && qw(--enable-shared --disable-static)),
 449                         map((!$_ ? () : @$_),$Options{"configure_args"}),
 450                         );
 451 }
 452
 453 1;
 454 __END__
 455
 456 Tested with:
 457         RedHat autoconf-2.53-8
 458         RedHat automake-1.6.3-1
 459         RedHat gettext-0.11.4-3
 460         RedHat libtool-1.4.2-12
 461         RedHat perl-5.8.0-48