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.
23 (! compat(7) ? "perl_build" : ()),
27 (compat(7) ? "perl_build" : ()),
40 sub create_buildsystem_instance {
43 my $module = "Debian::Debhelper::Buildsystem::$system";
47 error("unable to load build system class '$system': $@");
50 if (!exists $bsopts{builddir} && defined $opt_builddir) {
51 $bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir;
53 if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) {
54 $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir;
56 if (!exists $bsopts{parallel}) {
57 $bsopts{parallel} = $opt_parallel;
59 return $module->new(%bsopts);
62 # Autoselect a build system from the list of instances
63 sub autoselect_buildsystem {
66 my $selected_level = 0;
68 foreach my $inst (@_) {
69 # Only derived (i.e. more specific) build system can be
70 # considered beyond the currently selected one.
71 next if defined $selected && !$inst->isa(ref $selected);
73 # If the build system says it is auto-buildable at the current
74 # step and it can provide more specific information about its
75 # status than its parent (if any), auto-select it.
76 my $level = $inst->check_auto_buildable($step);
77 if ($level > $selected_level) {
79 $selected_level = $level;
85 # Similar to create_build system_instance(), but it attempts to autoselect
86 # a build system if none was specified. In case autoselection fails, undef
88 sub load_buildsystem {
91 if (defined $system) {
92 my $inst = create_buildsystem_instance($system, @_);
96 # Try to determine build system automatically
98 foreach $system (@BUILDSYSTEMS) {
99 push @buildsystems, create_buildsystem_instance($system, @_);
101 return autoselect_buildsystem($step, @buildsystems);
105 sub load_all_buildsystems {
106 my $incs=shift || \@INC;
107 my (%buildsystems, @buildsystems);
109 foreach my $inc (@$incs) {
110 my $path = File::Spec->catdir($inc, "Debian/Debhelper/Buildsystem");
112 foreach my $module_path (glob "$path/*.pm") {
113 my $name = basename($module_path);
115 next if exists $buildsystems{$name};
116 $buildsystems{$name} = create_buildsystem_instance($name, @_);
121 # Standard debhelper build systems first
122 foreach my $name (@BUILDSYSTEMS) {
123 error("standard debhelper build system '$name' could not be found/loaded")
124 if not exists $buildsystems{$name};
125 push @buildsystems, $buildsystems{$name};
126 delete $buildsystems{$name};
129 # The rest are 3rd party build systems
130 foreach my $name (keys %buildsystems) {
131 my $inst = $buildsystems{$name};
132 $inst->{thirdparty} = 1;
133 push @buildsystems, $inst;
136 return @buildsystems;
139 sub buildsystems_init {
144 # Available command line options
146 "D=s" => \$opt_sourcedir,
147 "sourcedirectory=s" => \$opt_sourcedir,
149 "B:s" => \$opt_builddir,
150 "builddirectory:s" => \$opt_builddir,
152 "S=s" => \$opt_buildsys,
153 "buildsystem=s" => \$opt_buildsys,
156 "list" => \$opt_list,
158 "parallel" => sub { $max_parallel = -1 },
159 "max-parallel=i" => \$max_parallel,
161 $args{options}{$_} = $options{$_} foreach keys(%options);
162 Debian::Debhelper::Dh_Lib::init(%args);
163 Debian::Debhelper::Dh_Lib::set_buildflags();
164 set_parallel($max_parallel);
170 # Get number of processes from parallel=n option, limiting it
171 # with $max if needed
172 $opt_parallel=get_buildoption("parallel") || 1;
174 if ($max > 0 && $opt_parallel > $max) {
175 $opt_parallel = $max;
179 sub buildsystems_list {
182 my @buildsystems = load_all_buildsystems();
183 my $auto = autoselect_buildsystem($step, grep { ! $_->{thirdparty} } @buildsystems);
186 # List build systems (including auto and specified status)
187 foreach my $inst (@buildsystems) {
188 if (! defined $specified && defined $opt_buildsys && $opt_buildsys eq $inst->NAME()) {
191 printf("%-20s %s", $inst->NAME(), $inst->DESCRIPTION());
192 print " [3rd party]" if $inst->{thirdparty};
196 print "Auto-selected: ", $auto->NAME(), "\n" if defined $auto;
197 print "Specified: ", $specified->NAME(), "\n" if defined $specified;
198 print "No system auto-selected or specified\n"
199 if ! defined $auto && ! defined $specified;
202 sub buildsystems_do {
205 if (!defined $step) {
206 $step = basename($0);
207 $step =~ s/^dh_auto_//;
210 if (grep(/^\Q$step\E$/, BUILD_STEPS) == 0) {
211 error("unrecognized build step: " . $step);
215 buildsystems_list($step);
219 my $buildsystem = load_buildsystem($opt_buildsys, $step);
220 if (defined $buildsystem) {
221 $buildsystem->pre_building_step($step);
222 $buildsystem->$step(@_, @{$dh{U_PARAMS}});
223 $buildsystem->post_building_step($step);