# A module for loading and managing debhelper buildsystem plugins.
+# This module is intended to be used by all dh_auto_* helper commands.
#
# Copyright: © 2009 Modestas Vainius
# License: GPL-2+
use strict;
use warnings;
use Debian::Debhelper::Dh_Lib;
+use File::Spec;
-use Exporter qw( import );
-our @EXPORT_OK = qw( DEFAULT_BUILD_DIRECTORY );
+use base 'Exporter';
+our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem &load_all_buildsystems);
-# IMPORTANT: more specific buildsystems should go first
-my @BUILDSYSTEMS = (
- "autotools",
- "cmake",
- "perl_build",
- "perl_makefile",
- "python_distutils",
+# Historical order must be kept for backwards compatibility. New
+# buildsystems MUST be added to the END of the list.
+our @BUILDSYSTEMS = (
+ "autoconf",
+ "perl_makemaker",
"makefile",
+ "python_distutils",
+ "perl_build",
+ "cmake",
);
-sub DEFAULT_BUILD_DIRECTORY {
- return "obj-" . dpkg_architecture_value("DEB_BUILD_GNU_TYPE");
-}
-
-sub new {
- my $cls=shift;
- my %opts=@_;
- my $self = bless({
- 'o_dir' => undef,
- 'o_system' => undef,
- 'loaded_buildsystems' => [] }, $cls);
-
- if (!exists $opts{noenv}) {
- if (exists $ENV{DH_AUTO_BUILDDIRECTORY}) {
- $self->_set_build_directory_option("env", $ENV{DH_AUTO_BUILDDIRECTORY});
- }
- if (exists $ENV{DH_AUTO_BUILDSYSTEM}) {
- $self->{o_system} = $ENV{DH_AUTO_BUILDSYSTEM};
- }
- }
- return $self;
-}
-
-sub get_options {
- my $self=shift;
- my @options=@_;
-
- my $set_dir = sub { $self->_set_build_directory_option(@_) };
- my $list_bs = sub { $self->list_buildsystems(@_); exit 0 };
-
- push @options, (
- "b:s" => $set_dir,
- "build-directory:s" => $set_dir,
- "builddirectory:s" => $set_dir,
+my $opt_buildsys;
+my $opt_sourcedir;
+my $opt_builddir;
+my $opt_list;
- "m=s" => \$self->{o_system},
- "build-system=s" => \$self->{o_system},
- "buildsystem=s" => \$self->{o_system},
-
- "l" => $list_bs,
- "--list" => $list_bs,
- );
- my %options = @options;
- return \%options;
-}
+sub create_buildsystem_instance {
+ my $system=shift;
+ my %bsopts=@_;
+ my $module = "Debian::Debhelper::Buildsystem::$system";
-sub _set_build_directory_option {
- my ($self, $option, $value) = @_;
- if (!$value || $value eq "auto") {
- # Autogenerate build directory name
- $self->{o_dir} = DEFAULT_BUILD_DIRECTORY;
- }
- else {
- $self->{o_dir} = $value;
+ eval "use $module";
+ if ($@) {
+ error("unable to load buildsystem class '$system': $@");
}
-}
-sub _dump_options {
- my $self=shift;
- for my $opt (qw(o_dir o_system)) {
- if (defined $self->{$opt}) {
- print $opt, ": ", $self->{$opt}, "\n";
- }
+ if (!exists $bsopts{builddir} && defined $opt_builddir) {
+ $bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir;
}
-}
-
-sub _get_buildsystem_module {
- my ($self, $system) = @_;
- my $module = "Debian::Debhelper::Buildsystem::$system";
-
- if (grep $module, @{$self->{loaded_buildsystems}} == 0) {
- eval "use $module";
- if ($@) {
- error("Unable to load buildsystem '$system': $@");
- }
- push @{$self->{loaded_buildsystems}}, $module;
+ if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) {
+ $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir;
}
- return $module;
+ return $module->new(%bsopts);
}
+# Similar to create_buildsystem_instance(), but it attempts to autoselect
+# a buildsystem if none was specified. In case autoselection fails, undef
+# is returned.
sub load_buildsystem {
- my ($self, $action, $system) = @_;
-
- if (!defined $system) {
- $system = $self->{o_system};
- }
+ my $system=shift;
+ my $step=shift;
if (defined $system) {
- my $module = $self->_get_buildsystem_module($system);
- verbose_print("Selected buildsystem (specified): ".$module->NAME());
- return $module->new($self->{o_dir});
+ my $inst = create_buildsystem_instance($system, @_);
+ return $inst;
}
else {
# Try to determine build system automatically
for $system (@BUILDSYSTEMS) {
- my $module = $self->_get_buildsystem_module($system);
- my $inst = $module->new($self->{o_dir});
- if ($inst->is_buildable($action)) {
- verbose_print("Selected buildsystem (auto): ".$module->NAME());
+ my $inst = create_buildsystem_instance($system, @_);
+ if ($inst->check_auto_buildable($step)) {
return $inst;
}
}
}
sub load_all_buildsystems {
- my $self=shift;
- for my $system (@BUILDSYSTEMS) {
- $self->_get_buildsystem_module($system);
+ 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, @_);
+ }
+ }
}
- return @{$self->{loaded_buildsystems}};
-}
-sub list_buildsystems {
- my $self=shift;
- for my $system ($self->load_all_buildsystems()) {
- printf("%s - %s.\n", $system->NAME(), $system->DESCRIPTION());
+ # Push debhelper built-in buildsystems first
+ for my $name (@BUILDSYSTEMS) {
+ error("Debhelper built-in buildsystem '$name' could not be found/loaded")
+ if not exists $buildsystems{$name};
+ push @buildsystems, $buildsystems{$name};
+ delete $buildsystems{$name};
}
+
+ # The rest are 3rd party buildsystems
+ for my $name (keys %buildsystems) {
+ my $inst = $buildsystems{$name};
+ $inst->{thirdparty} = 1;
+ push @buildsystems, $inst;
+ }
+
+ return @buildsystems;
}
-sub init_dh_auto_tool {
- my $self=shift;
+sub buildsystems_init {
+ my %args=@_;
- Debian::Debhelper::Dh_Lib::init(
- options => $self->get_options(@_));
- $self->{initialized}=1;
+ # Available command line options
+ my %options = (
+ "D=s" => \$opt_sourcedir,
+ "sourcedirectory=s" => \$opt_sourcedir,
+
+ "B:s" => \$opt_builddir,
+ "builddirectory:s" => \$opt_builddir,
+
+ "S=s" => \$opt_buildsys,
+ "buildsystem=s" => \$opt_buildsys,
+
+ "l" => \$opt_list,
+ "--list" => \$opt_list,
+ );
+ $args{options}{$_} = $options{$_} foreach keys(%options);
+ Debian::Debhelper::Dh_Lib::init(%args);
}
-sub run_dh_auto_tool {
- my $self=shift;
- my $toolname = basename($0);
- my $buildsystem;
+sub buildsystems_list {
+ my $step=shift;
+
+ # List buildsystems (including auto and specified status)
+ my ($auto, $specified);
+ my @buildsystems = load_all_buildsystems();
+ for my $inst (@buildsystems) {
+ my $is_specified = defined $opt_buildsys && $opt_buildsys eq $inst->NAME();
+ if (! defined $specified && defined $opt_buildsys && $opt_buildsys eq $inst->NAME()) {
+ $specified = $inst->NAME();
+ }
+ elsif (! defined $auto && ! $inst->{thirdparty} && $inst->check_auto_buildable($step)) {
+ $auto = $inst->NAME();
+ }
+ printf("%s - %s", $inst->NAME(), $inst->DESCRIPTION());
+ print " [3rd party]" if $inst->{thirdparty};
+ print "\n";
+ }
+ print "\n";
+ print "Auto-selected: $auto\n" if defined $auto;
+ print "Specified: $specified\n" if defined $specified;
+ print "No system auto-selected or specified\n"
+ if ! defined $auto && ! defined $specified;
+}
+
+sub buildsystems_do {
+ my $step=shift;
+
+ if (!defined $step) {
+ $step = basename($0);
+ $step =~ s/^dh_auto_//;
+ }
- if (!exists $self->{initialized}) {
- $self->init_dh_auto_tool();
+ if (grep(/^\Q$step\E$/, qw{configure build test install clean}) == 0) {
+ error("unrecognized build step: " . $step);
}
- # Guess action from the dh_auto_* name
- $toolname =~ s/^dh_auto_//;
- if (grep(/^\Q$toolname\E$/, qw{configure build test install clean}) == 0) {
- error("Unrecognized dh auto tool: ".basename($0));
+ if ($opt_list) {
+ buildsystems_list($step);
+ exit 0;
}
- $buildsystem = $self->load_buildsystem($toolname);
+ my $buildsystem = load_buildsystem($opt_buildsys, $step);
if (defined $buildsystem) {
- return $buildsystem->$toolname(@_, @{$dh{U_PARAMS}});
+ $buildsystem->pre_building_step($step);
+ $buildsystem->$step(@_, @{$dh{U_PARAMS}});
+ $buildsystem->post_building_step($step);
}
return 0;
}
projects / debhelper.git / blobdiff