]> git.donarmstrong.com Git - debhelper.git/blobdiff - Debian/Debhelper/Dh_Buildsystems.pm
Make buildsystems_list() use updated auto-selection code.
[debhelper.git] / Debian / Debhelper / Dh_Buildsystems.pm
index afb03dd7bf0139b9ec1d3f9d3cb23cac416a7bb5..8470eac05171f7d4e767f2703db6f202110fab1c 100644 (file)
@@ -1,5 +1,5 @@
-# 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+
@@ -9,24 +9,30 @@ package Debian::Debhelper::Dh_Buildsystems;
 use strict;
 use warnings;
 use Debian::Debhelper::Dh_Lib;
+use File::Spec;
 
 use base 'Exporter';
-our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem);
+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 = (
-    "autoconf",
-    "perl_makemaker",
-    "makefile",
-    "python_distutils",
-    "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;
@@ -35,113 +41,192 @@ sub create_buildsystem_instance {
 
        eval "use $module";
        if ($@) {
-               error("unable to load buildsystem class '$system': $@");
+               error("unable to load build system class '$system': $@");
        }
 
        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 {
-       my ($action, $system)=@_;
+       my $system=shift;
+       my $step=shift;
        if (defined $system) {
-               my $inst = create_buildsystem_instance($system);
+               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, build_action=>$action);
-                       if ($inst->is_buildable()) {
-                               return $inst;
-                       }
+                       push @buildsystems, create_buildsystem_instance($system, @_);
                }
+               return autoselect_buildsystem($step, @buildsystems);
        }
-       return;
 }
 
-sub buildsystems_init {
-       my %args=@_;
+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, @_);
+                       }
+               }
+       }
 
-       # TODO: Not documented in the manual pages yet.
-       # Initialize options from environment variables
-       if (exists $ENV{DH_AUTO_BUILDDIRECTORY}) {
-               $opt_builddir = $ENV{DH_AUTO_BUILDDIRECTORY};
+       # 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};
        }
-       if (exists $ENV{DH_AUTO_BUILDSYSTEM}) {
-               $opt_buildsys = $ENV{DH_AUTO_BUILDSYSTEM};
+
+       # 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=@_;
+       
+       my $max_parallel=-1; # unlimited
+
        # Available command line options
        my %options = (
-           "b:s" => \$opt_builddir,
+           "D=s" => \$opt_sourcedir,
+           "sourcedirectory=s" => \$opt_sourcedir,
+       
+           "B:s" => \$opt_builddir,
            "builddirectory:s" => \$opt_builddir,
 
-           "m=s" => \$opt_buildsys,
+           "S=s" => \$opt_buildsys,
            "buildsystem=s" => \$opt_buildsys,
 
            "l" => \$opt_list,
-           "--list" => \$opt_list,
+           "list" => \$opt_list,
+
+           "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 $action=shift;
+       my $step=shift;
 
-       # List buildsystems (including auto and specified status)
-       my ($auto, $specified);
-       for my $system (@BUILDSYSTEMS) {
-               my $inst = create_buildsystem_instance($system, build_action => undef);
-               my $is_specified = defined $opt_buildsys && $opt_buildsys eq $inst->NAME();
+       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->NAME();
-               }
-               elsif (! defined $auto && $inst->check_auto_buildable($action)) {
-                       $auto = $inst->NAME();
+                       $specified = $inst;
                }
-               printf("%s - %s\n", $inst->NAME(), $inst->DESCRIPTION());
-       }
-       # List a specified 3rd party buildsystem too.
-       if (! defined $specified && defined $opt_buildsys) {
-               my $inst = create_buildsystem_instance($opt_buildsys, build_action => undef);
-               printf("%s - %s.\n", $inst->NAME(), $inst->DESCRIPTION());
-               $specified = $inst->NAME();
+               printf("%-20s %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 "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_//;
        }
 
-       if (grep(/^\Q$action\E$/, qw{configure build test install clean}) == 0) {
-               error("unrecognized build action: " . $action);
+       if (grep(/^\Q$step\E$/, BUILD_STEPS) == 0) {
+               error("unrecognized build step: " . $step);
        }
 
        if ($opt_list) {
-               buildsystems_list($action);
+               buildsystems_list($step);
                exit 0;
        }
 
-       my $buildsystem = load_buildsystem($action, $opt_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;
 }
 
-1;
+1