1 # A module for loading and managing debhelper build system classes.
2 # This module is intended to be used by all dh_auto_* programs.
4 # Copyright: © 2009 Modestas Vainius
7 package Debian::Debhelper::Dh_Buildsystems;
11 use Debian::Debhelper::Dh_Lib;
15 our @EXPORT=qw(&buildsystems_init &buildsystems_do &load_buildsystem &load_all_buildsystems);
17 use constant BUILD_STEPS => qw(configure build test install clean);
19 # Historical order must be kept for backwards compatibility. New
20 # build systems MUST be added to the END of the list.
38 sub create_buildsystem_instance {
41 my $module = "Debian::Debhelper::Buildsystem::$system";
45 error("unable to load build system class '$system': $@");
48 if (!exists $bsopts{builddir} && defined $opt_builddir) {
49 $bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir;
51 if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) {
52 $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir;
54 if (!exists $bsopts{parallel}) {
55 $bsopts{parallel} = $opt_parallel;
57 return $module->new(%bsopts);
60 # Autoselect a build system from the list of instances
61 sub autoselect_buildsystem {
64 my $selected_level = 0;
66 foreach my $inst (@_) {
67 # Only derived (i.e. more specific) build system can be
68 # considered beyond the currently selected one.
69 next if defined $selected && !$inst->isa(ref $selected);
71 # If the build system says it is auto-buildable at the current
72 # step and it can provide more specific information about its
73 # status than its parent (if any), auto-select it.
74 my $level = $inst->check_auto_buildable($step);
75 if ($level > $selected_level) {
77 $selected_level = $level;
83 # Similar to create_build system_instance(), but it attempts to autoselect
84 # a build system if none was specified. In case autoselection fails, undef
86 sub load_buildsystem {
89 if (defined $system) {
90 my $inst = create_buildsystem_instance($system, @_);
94 # Try to determine build system automatically
96 foreach $system (@BUILDSYSTEMS) {
97 push @buildsystems, create_buildsystem_instance($system, @_);
99 return autoselect_buildsystem($step, @buildsystems);
103 sub load_all_buildsystems {
104 my $incs=shift || \@INC;
105 my (%buildsystems, @buildsystems);
107 foreach my $inc (@$incs) {
108 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Buildsystem");
110 foreach my $module_path (glob "$path/*.pm") {
111 my $name = basename($module_path);
113 next if exists $buildsystems{$name};
114 $buildsystems{$name} = create_buildsystem_instance($name, @_);
119 # Standard debhelper build systems first
120 foreach my $name (@BUILDSYSTEMS) {
121 error("standard debhelper build system '$name' could not be found/loaded")
122 if not exists $buildsystems{$name};
123 push @buildsystems, $buildsystems{$name};
124 delete $buildsystems{$name};
127 # The rest are 3rd party build systems
128 foreach my $name (keys %buildsystems) {
129 my $inst = $buildsystems{$name};
130 $inst->{thirdparty} = 1;
131 push @buildsystems, $inst;
134 return @buildsystems;
137 sub buildsystems_init {
142 # Available command line options
144 "D=s" => \$opt_sourcedir,
145 "sourcedirectory=s" => \$opt_sourcedir,
147 "B:s" => \$opt_builddir,
148 "builddirectory:s" => \$opt_builddir,
150 "S=s" => \$opt_buildsys,
151 "buildsystem=s" => \$opt_buildsys,
154 "list" => \$opt_list,
156 "parallel" => sub { $max_parallel = -1 },
157 "max-parallel=i" => \$max_parallel,
159 $args{options}{$_} = $options{$_} foreach keys(%options);
160 Debian::Debhelper::Dh_Lib::init(%args);
161 set_parallel($max_parallel);
169 if (exists $ENV{DEB_BUILD_OPTIONS}) {
170 # Get number of processes from parallel=n tag limiting it
171 # with $max if needed
172 foreach my $opt (split(/\s+/, $ENV{DEB_BUILD_OPTIONS})) {
173 if ($opt =~ /^parallel=(-?\d+)$/) {
175 if ($max > 0 && $opt_parallel > $max) {
176 $opt_parallel = $max;
183 sub buildsystems_list {
186 my @buildsystems = load_all_buildsystems();
187 my $auto = autoselect_buildsystem($step, grep { ! $_->{thirdparty} } @buildsystems);
190 # List build systems (including auto and specified status)
191 foreach my $inst (@buildsystems) {
192 if (! defined $specified && defined $opt_buildsys && $opt_buildsys eq $inst->NAME()) {
195 printf("%-20s %s", $inst->NAME(), $inst->DESCRIPTION());
196 print " [3rd party]" if $inst->{thirdparty};
200 print "Auto-selected: ", $auto->NAME(), "\n" if defined $auto;
201 print "Specified: ", $specified->NAME(), "\n" if defined $specified;
202 print "No system auto-selected or specified\n"
203 if ! defined $auto && ! defined $specified;
206 sub buildsystems_do {
209 if (!defined $step) {
210 $step = basename($0);
211 $step =~ s/^dh_auto_//;
214 if (grep(/^\Q$step\E$/, BUILD_STEPS) == 0) {
215 error("unrecognized build step: " . $step);
219 buildsystems_list($step);
223 my $buildsystem = load_buildsystem($opt_buildsys, $step);
224 if (defined $buildsystem) {
225 $buildsystem->pre_building_step($step);
226 $buildsystem->$step(@_, @{$dh{U_PARAMS}});
227 $buildsystem->post_building_step($step);