-# A module for loading and managing debhelper buildsystem plugins.
-# This module is intended to be used by all dh_auto_* helper commands.
+# A module for loading and managing debhelper build system classes.
+# This module is intended to be used by all dh_auto_* programs.
#
# Copyright: © 2009 Modestas Vainius
# License: GPL-2+
use strict;
use warnings;
use Debian::Debhelper::Dh_Lib;
+use File::Spec;
use base 'Exporter';
-our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem);
-
-# XXX JEH as noted, this has to match historical order for back-compat
-# XXX MDX Current dh_auto_* look like:
-# configure: autotools, perl_makemaker, perl_build
-# build: makefile, python_distutils, perl_build
-# test: makefile, perl_build
-# install: makefile (with perl_makermaker) hack, python_distutils, perl_build
-# clean: makefile, python_distutils, perl_build
-# So historical @BUILDSYSTEMS order (as per autodetection, see
-# is_auto_buildable() of the respective classes):
-# autotools (+configure; the rest - next class)
-# python_distutils (+build +install +clean; the rest - next class)
-# perl_makemaker (+configure +install (special hack); the rest - next class)
-# makefile (+build +test +install +clean; configure - next class)
-# perl_build (handles everything)
+our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem &load_all_buildsystems);
+
+use constant BUILD_STEPS => qw(configure build test install clean);
# Historical order must be kept for backwards compatibility. New
-# buildsystems MUST be added to the END of the list.
+# build systems MUST be added to the END of the list.
our @BUILDSYSTEMS = (
- "autotools",
- "python_distutils",
- "perl_makemaker",
- "makefile",
- "perl_build",
- "cmake",
+ "autoconf",
+ "perl_makemaker",
+ "makefile",
+ "python_distutils",
+ "perl_build",
+ "cmake",
+ "ant",
);
+my $opt_buildsys;
+my $opt_sourcedir;
+my $opt_builddir;
+my $opt_list;
+my $opt_parallel;
+
sub create_buildsystem_instance {
my $system=shift;
my %bsopts=@_;
eval "use $module";
if ($@) {
- error("unable to load buildsystem class '$system': $@");
+ error("unable to load build system class '$system': $@");
}
- if (!exists $bsopts{builddir} && exists $dh{BUILDDIR}) {
- $bsopts{builddir} = $dh{BUILDDIR};
+ if (!exists $bsopts{builddir} && defined $opt_builddir) {
+ $bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir;
+ }
+ if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) {
+ $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir;
+ }
+ if (!exists $bsopts{parallel}) {
+ $bsopts{parallel} = $opt_parallel;
}
return $module->new(%bsopts);
}
+# Autoselect a build system from the list of instances
+sub autoselect_buildsystem {
+ my $step=shift;
+ my $selected;
+ my $selected_level = 0;
+
+ for my $inst (@_) {
+ # Only derived (i.e. more specific) build system can be
+ # considered beyond the currently selected one.
+ next if defined $selected && !$inst->isa(ref $selected);
+
+ # If the build system says it is auto-buildable at the current
+ # step and it can provide more specific information about its
+ # status than its parent (if any), auto-select it.
+ my $level = $inst->check_auto_buildable($step);
+ if ($level > $selected_level) {
+ $selected = $inst;
+ $selected_level = $level;
+ }
+ }
+ return $selected;
+}
+
+# Similar to create_build system_instance(), but it attempts to autoselect
+# a build system if none was specified. In case autoselection fails, undef
+# is returned.
sub load_buildsystem {
- # XXX JEH the $system param is never passed
- # by any call to this function
- # XXX MDX Yes, it was sort of redudant. But see buildsystems_do() now.
- my ($action, $system)=@_;
+ my $system=shift;
+ my $step=shift;
if (defined $system) {
- my $inst = create_buildsystem_instance($system);
- verbose_print("Selected buildsystem (specified): ".$inst->NAME());
+ my $inst = create_buildsystem_instance($system, @_);
return $inst;
}
else {
# Try to determine build system automatically
+ my @buildsystems;
for $system (@BUILDSYSTEMS) {
- my $inst = create_buildsystem_instance($system, is_auto=>1);
- if ($inst->is_auto_buildable($action)) {
- verbose_print("Selected buildsystem (auto): ". $inst->NAME());
- return $inst;
- }
+ push @buildsystems, create_buildsystem_instance($system, @_);
}
+ return autoselect_buildsystem($step, @buildsystems);
}
- return;
}
-sub list_buildsystems {
- for my $system (@BUILDSYSTEMS) {
- my $inst = create_buildsystem_instance($system);
- printf("%s - %s.\n", $inst->NAME(), $inst->DESCRIPTION());
+sub load_all_buildsystems {
+ my $incs=shift || \@INC;
+ my (%buildsystems, @buildsystems);
+
+ for my $inc (@$incs) {
+ my $path = File::Spec->catdir($inc, "Debian/Debhelper/Buildsystem");
+ if (-d $path) {
+ for my $module_path (glob "$path/*.pm") {
+ my $name = basename($module_path);
+ $name =~ s/\.pm$//;
+ next if exists $buildsystems{$name};
+ $buildsystems{$name} = create_buildsystem_instance($name, @_);
+ }
+ }
+ }
+
+ # Standard debhelper build systems first
+ for my $name (@BUILDSYSTEMS) {
+ error("standard debhelper build system '$name' could not be found/loaded")
+ if not exists $buildsystems{$name};
+ push @buildsystems, $buildsystems{$name};
+ delete $buildsystems{$name};
+ }
+
+ # The rest are 3rd party build systems
+ for my $name (keys %buildsystems) {
+ my $inst = $buildsystems{$name};
+ $inst->{thirdparty} = 1;
+ push @buildsystems, $inst;
}
+
+ return @buildsystems;
}
sub buildsystems_init {
my %args=@_;
-
- # XXX JEH AFAICS, these 2 env variables are never used or documented
- # XXX MDX They are used (see below), not documented though.
- # TODO: Not documented in the manual pages yet.
- # Initialize options from environment variables
- if (exists $ENV{DH_AUTO_BUILDDIRECTORY}) {
- $dh{BUILDDIR} = $ENV{DH_AUTO_BUILDDIRECTORY};
- }
- if (exists $ENV{DH_AUTO_BUILDSYSTEM}) {
- $dh{BUILDSYS} = $ENV{DH_AUTO_BUILDSYSTEM};
- }
+
+ my $max_parallel=-1; # unlimited
# Available command line options
- my $list_bs = sub { list_buildsystems(); exit 0 };
- my $set_builddir = sub { $dh{BUILDDIR} = $_[1] };
my %options = (
- "b:s" => $set_builddir,
- "build-directory:s" => $set_builddir,
- "builddirectory:s" => $set_builddir,
+ "D=s" => \$opt_sourcedir,
+ "sourcedirectory=s" => \$opt_sourcedir,
+
+ "B:s" => \$opt_builddir,
+ "builddirectory:s" => \$opt_builddir,
+
+ "S=s" => \$opt_buildsys,
+ "buildsystem=s" => \$opt_buildsys,
- "m=s" => \$dh{BUILDSYS},
- "build-system=s" => \$dh{BUILDSYS},
- "buildsystem=s" => \$dh{BUILDSYS},
+ "l" => \$opt_list,
+ "list" => \$opt_list,
- "l" => $list_bs,
- "--list" => $list_bs,
+ "max-parallel=i" => \$max_parallel,
);
- map { $args{options}{$_} = $options{$_} } keys(%options);
+ $args{options}{$_} = $options{$_} foreach keys(%options);
Debian::Debhelper::Dh_Lib::init(%args);
+ set_parallel($max_parallel);
+}
+
+sub set_parallel {
+ my $max=shift;
+
+ $opt_parallel=1;
+
+ if (exists $ENV{DEB_BUILD_OPTIONS}) {
+ # Parse parallel=n tag
+ foreach my $opt (split(/\s+/, $ENV{DEB_BUILD_OPTIONS})) {
+ if ($opt =~ /^parallel=([-\d]+)$/) {
+ my $n=$1;
+ if ($n > 0 && ($max == -1 || $n < $max)) {
+ $opt_parallel = $n;
+ }
+ else {
+ $opt_parallel = $max;
+ }
+ }
+ }
+ }
+}
+
+sub buildsystems_list {
+ my $step=shift;
+
+ my @buildsystems = load_all_buildsystems();
+ my $auto = autoselect_buildsystem($step, grep { ! $_->{thirdparty} } @buildsystems);
+ my $specified;
+
+ # List build systems (including auto and specified status)
+ for my $inst (@buildsystems) {
+ if (! defined $specified && defined $opt_buildsys && $opt_buildsys eq $inst->NAME()) {
+ $specified = $inst;
+ }
+ printf("%-20s %s", $inst->NAME(), $inst->DESCRIPTION());
+ print " [3rd party]" if $inst->{thirdparty};
+ print "\n";
+ }
+ print "\n";
+ print "Auto-selected: ", $auto->NAME(), "\n" if defined $auto;
+ print "Specified: ", $specified->NAME(), "\n" if defined $specified;
+ print "No system auto-selected or specified\n"
+ if ! defined $auto && ! defined $specified;
}
sub buildsystems_do {
- my $action=shift;
+ my $step=shift;
- if (!defined $action) {
- $action = basename($0);
- $action =~ s/^dh_auto_//;
+ if (!defined $step) {
+ $step = basename($0);
+ $step =~ s/^dh_auto_//;
}
- # XXX JEH does this if ever not fire?
- # XXX MDX See dh_auto_install. I'm removing this anyway
- # and making buildsystem_init() call in dh_auto_* mandatory.
+ if (grep(/^\Q$step\E$/, BUILD_STEPS) == 0) {
+ error("unrecognized build step: " . $step);
+ }
- if (grep(/^\Q$action\E$/, qw{configure build test install clean}) == 0) {
- error("unrecognized auto action: ".basename($0));
+ if ($opt_list) {
+ buildsystems_list($step);
+ exit 0;
}
- my $buildsystem = load_buildsystem($action, $dh{BUILDSYS});
+ my $buildsystem = load_buildsystem($opt_buildsys, $step);
if (defined $buildsystem) {
- $buildsystem->pre_action($action);
- $buildsystem->$action(@_, @{$dh{U_PARAMS}});
- $buildsystem->post_action($action);
+ $buildsystem->pre_building_step($step);
+ $buildsystem->$step(@_, @{$dh{U_PARAMS}});
+ $buildsystem->post_building_step($step);
}
return 0;
}
-# XXX JEH generally, why does this need to be an OO object at all?
-# The entire state stored in this object is o_dir and o_system;
-# and the object is used as a singleton. So why not have a single sub
-# that parses the command line, loads the specified system, and uses it,
-# passing it the build directory. It would be both shorter and easier to
-# understand.
-# XXX I refactored this into a module rather than OO class. I do not agree
-# about a single sub though as it is more complicated than that and
-# I think it is more clear to have the code segmented a bit. See also
-# dh_auto_install why both buildsystems_init() and buildsystems_do()
-# are needed.
-
-1;
+1
projects / debhelper.git / blobdiff