summaryrefslogtreecommitdiff
path: root/Debian/Debhelper/Dh_Buildsystems.pm
blob: aa2dff99635710815b1f5193cc479b6db645be78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# A module for loading and managing debhelper buildsystem plugins.
#
# Copyright: © 2009 Modestas Vainius
# License: GPL-2+

package Debian::Debhelper::Dh_Buildsystems;

use strict;
use warnings;
use Debian::Debhelper::Dh_Lib;

use Exporter qw( import );
our @EXPORT_OK = qw( DEFAULT_BUILD_DIRECTORY );

# IMPORTANT: more specific buildsystems should go first
# XXX JEH as noted, this has to match historical order for back-compat
my @BUILDSYSTEMS = (
    "autotools",
    "cmake",
    "perl_build",
    "perl_makefile",
    "python_distutils",
    "makefile",
);

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);

	# XXX JEH AFAICS, these 2 env variables are never used or documented
	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,

	    "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 _set_build_directory_option {
	# XXX JEH option argument is not used, would be less confusing to
	# not pass extra getopt value in
	my ($self, $option, $value) = @_;
	if (!$value || $value eq "auto") {
		# Autogenerate build directory name
		$self->{o_dir} = DEFAULT_BUILD_DIRECTORY;
	}
	else {
		$self->{o_dir} = $value;
	}
}

# XXX JEH this sub is not used
sub _dump_options {
	my $self=shift;
	for my $opt (qw(o_dir o_system)) {
		if (defined $self->{$opt}) {
			print $opt, ": ", $self->{$opt}, "\n";
		}
	}
}

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;
	}
	return $module;
}

sub load_buildsystem {
	# XXX JEH the $system param is never passed
	# by any call to this function
	my ($self, $action, $system) = @_;

	if (!defined $system) {
		$system = $self->{o_system};
	}
	if (defined $system) {
		my $module =  $self->_get_buildsystem_module($system);
		verbose_print("Selected buildsystem (specified): ".$module->NAME());
		return $module->new($self->{o_dir});
	}
	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());
				return $inst;
			}
		}
	}
	return;
}

sub load_all_buildsystems {
	my $self=shift;
	for my $system (@BUILDSYSTEMS) {
		$self->_get_buildsystem_module($system);
	}
	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());
	}
}

sub init_dh_auto_tool {
	my $self=shift;

	Debian::Debhelper::Dh_Lib::init(
	    options => $self->get_options(@_));
	$self->{initialized}=1;
}

sub run_dh_auto_tool {
	my $self=shift;
	my $toolname = basename($0);
	my $buildsystem;

	# XXX JEH does this if ever not fire?
	if (!exists $self->{initialized}) {
		$self->init_dh_auto_tool();
	}

	# 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));
	}

	$buildsystem = $self->load_buildsystem($toolname);
	if (defined $buildsystem) {
		return $buildsystem->$toolname(@_, @{$dh{U_PARAMS}});
	}
	return 0;
}

# XXX JEH generally, why does this need to be an OO object at all?
# The entire state stored in this object is o_dir and o_system;
# and the object is used as a singleton. So why not have a single sub
# that parses the command line, loads the specified system, and uses it,
# passing it the build directory. It would be both shorter and easier to
# understand.

1;