]> git.donarmstrong.com Git - debhelper.git/blobdiff - Debian/Debhelper/Dh_Buildsystems.pm
refactor --parallel processing
[debhelper.git] / Debian / Debhelper / Dh_Buildsystems.pm
index 3d45e1307025f6c62ec28a3f419543cb9ee45152..b0e0a568a7d5d00c9505b2206a1423e632c996af 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,40 +9,28 @@ 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);
-
-# 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
-# check_auto_buildable() of the respective classes):
-#   autotools (+configure; the rest - next class)
-#   perl_makemaker (+configure +install (special hack); the rest - next class)
-#   makefile (+build +test +install +clean; configure - next class)
-#   python_distutils (handles everything)
-#   perl_build (handles everything)
-# XXX JEH I think that makes sense..
+our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem &load_all_buildsystems);
 
 # 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",
-    "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;
@@ -51,28 +39,36 @@ 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);
 }
 
+# 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);
-               verbose_print("Selected buildsystem (specified): ".$inst->NAME());
+               my $inst = create_buildsystem_instance($system, @_);
                return $inst;
        }
        else {
                # Try to determine build system automatically
                for $system (@BUILDSYSTEMS) {
-                       my $inst = create_buildsystem_instance($system, build_action=>$action);
-                       if ($inst->is_buildable()) {
-                               verbose_print("Selected buildsystem (auto): ". $inst->NAME());
+                       my $inst = create_buildsystem_instance($system, @_);
+                       if ($inst->check_auto_buildable($step)) {
                                return $inst;
                        }
                }
@@ -80,82 +76,139 @@ sub load_buildsystem {
        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=@_;
+
        # 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,
+
+           "j:i" => \&set_parallel,
+           "parallel:i" => \&set_parallel,
        );
-       map { $args{options}{$_} = $options{$_} } keys(%options);
+       $args{options}{$_} = $options{$_} foreach keys(%options);
        Debian::Debhelper::Dh_Lib::init(%args);
 }
 
+sub set_parallel {
+       my ($option, $value)=@_;
+
+       if ($value >= 0 && exists $ENV{DEB_BUILD_OPTIONS}) {
+               # Parse parallel=n tag
+               my $n;
+               foreach my $opt (split(/\s+/, $ENV{DEB_BUILD_OPTIONS})) {
+                       $n = $1 if $opt =~ /^parallel=(\d+)$/;
+               }
+               if (defined $n && $n > 0) {
+                       if ($value == 0 || $n < $value) {
+                               $opt_parallel = $n;
+                       }
+                       else {
+                               $opt_parallel = $value;
+                       }
+               }
+               else {
+                       # Invalid value in the parallel tag. Disable.
+                       $opt_parallel = 1;
+               }
+       }
+       else {
+               $opt_parallel = 1;
+       }
+}
+
+sub buildsystems_list {
+       my $step=shift;
+
+       # List build systems (including auto and specified status)
+       my ($auto, $specified);
+       for my $inst (load_all_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("%-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 "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$/, qw{configure build test install clean}) == 0) {
+               error("unrecognized build step: " . $step);
        }
 
        if ($opt_list) {
-               # List buildsystems (including auto and specified status)
-               my $auto_found;
-               my $specified_found;
-               print "STATUS (* auto, + specified) NAME - DESCRIPTION", "\n";
-               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 $status;
-                       if ($is_specified) {
-                               $status = "+";
-                               $specified_found = 1;
-                       }
-                       elsif (!$auto_found && $inst->check_auto_buildable($action)) {
-                               $status = "*";
-                               $auto_found = 1;
-                       }
-                       else {
-                               $status = " ";
-                       }
-                       printf("%s %s - %s.\n", $status, $inst->NAME(), $inst->DESCRIPTION());
-               }
-               # List a 3rd party buildsystem too.
-               if (!$specified_found && defined $opt_buildsys) {
-                       my $inst = create_buildsystem_instance($opt_buildsys, build_action => undef);
-                       printf("+ %s - %s.\n", $inst->NAME(), $inst->DESCRIPTION());
-               }
+               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