-# Defines debhelper buildsystem class interface and implementation
+# Defines debhelper build system class interface and implementation
# of common functionality.
#
# Copyright: © 2008-2009 Modestas Vainius
use Debian::Debhelper::Dh_Lib;
# Cache DEB_BUILD_GNU_TYPE value. Performance hit of multiple
-# invocations is noticable when listing buildsystems.
+# invocations is noticable when listing build systems.
our $DEB_BUILD_GNU_TYPE = dpkg_architecture_value("DEB_BUILD_GNU_TYPE");
# Build system name. Defaults to the last component of the class
return $1;
}
else {
- error("ınvalid buildsystem class name: $class");
+ error("ınvalid build system class name: $class");
}
}
# directory) where the sources to be built live. If not
# specified or empty, defaults to the current directory.
# - builddir - specifies build directory to use. Path is relative to the
-# source directory unless it starts with ./, then it is
-# assumed to be relative to the top directory. If undef or
-# empty, DEFAULT_BUILD_DIRECTORY relative to the source
-# directory will be used. If not specified, in source build
-# will be attempted.
-# - build_step - set this parameter to the name of the build step
-# if you want the object to determine its is_buidable
-# status automatically (with check_auto_buildable()).
-# Do not pass this parameter if is_buildable flag should
-# be forced to true or set this parameter to undef if
-# is_buildable flag should be false.
+# current (top) directory. If undef or empty,
+# DEFAULT_BUILD_DIRECTORY directory will be used.
# Derived class can override the constructor to initialize common object
-# parameters and execute commands to configure build environment if
-# is_buildable flag is set on the object.
+# parameters. Do NOT use constructor to execute commands or otherwise
+# configure/setup build environment. There is absolutely no guarantee the
+# constructed object will be used to build something. Use pre_building_step(),
+# $build_step() or post_building_step() methods for this.
sub new {
my ($class, %opts)=@_;
my $this = bless({ sourcedir => '.',
- builddir => undef,
- is_buildable => 1 }, $class);
+ builddir => undef, }, $class);
if (exists $opts{sourcedir}) {
# Get relative sourcedir abs_path (without symlinks)
my $curdir = Cwd::getcwd();
my $abspath = Cwd::abs_path($opts{sourcedir});
if (! -d $abspath || $abspath !~ /^\Q$curdir\E/) {
- error("Invalid or non-existing path to the source directory: ".$opts{sourcedir});
+ error("invalid or non-existing path to the source directory: ".$opts{sourcedir});
}
$this->{sourcedir} = File::Spec->abs2rel($abspath, $curdir);
}
if (exists $opts{builddir}) {
$this->_set_builddir($opts{builddir});
}
- if (exists $opts{build_step}) {
- if (defined $opts{build_step}) {
- $this->{is_buildable} = $this->check_auto_buildable($opts{build_step});
- }
- else {
- $this->{is_buildable} = 0;
- }
- }
return $this;
}
sub _set_builddir {
my $this=shift;
my $builddir=shift;
- if ($builddir) {
- if ($builddir =~ m!^\./(.*)!) {
- # Specified as relative to the current directory
- $this->{builddir} = $1;
- }
- else {
- # Specified as relative to the source directory
- $this->{builddir} = $this->get_sourcepath($builddir);
- }
- }
- else {
- # Relative to the source directory by default
- $this->{builddir} = $this->get_sourcepath($this->DEFAULT_BUILD_DIRECTORY());
- }
+ $this->{builddir} = ($builddir) ? $builddir : $this->DEFAULT_BUILD_DIRECTORY;
# Canonicalize. If build directory ends up the same as source directory, drop it
if (defined $this->{builddir}) {
}
}
-# Test is_buildable flag of the object.
-sub is_buildable {
- my $this=shift;
- return $this->{is_buildable};
-}
-
-# This instance method is called to check if the build system is capable
+# This instance method is called to check if the build system is able
# to auto build a source package. Additional argument $step describes
# which operation the caller is going to perform (either configure,
# build, test, install or clean). You must override this method for the
# build system module to be ever picked up automatically. This method is
# used in conjuction with @Dh_Buildsystems::BUILDSYSTEMS.
#
-# This method is supposed to be called with source root directory being
-# working directory. Use $this->get_buildpath($path) method to get full
-# path to the files in the build directory.
+# This method is supposed to be called inside the source root directory.
+# Use $this->get_buildpath($path) method to get full path to the files
+# in the build directory.
sub check_auto_buildable {
my $this=shift;
my ($step) = @_;
# to enforce in source building even if the user requested otherwise.
sub enforce_in_source_building {
my $this=shift;
- if ($this->{builddir}) {
- # Do not emit warning unless the object is buildable.
- if ($this->is_buildable()) {
- warning("warning: " . $this->NAME() .
- " does not support building out of source tree. In source building enforced.");
- }
+ if ($this->get_builddir()) {
+ $this->{warn_insource} = 1;
$this->{builddir} = undef;
}
}
# Derived class can call this method in its constructor to enforce
-# out of source building even if the user didn't request it.
+# out of source building even if the user didn't request it. However,
+# if 'builddir' named parameter is passed, accept its value as the
+# build directory even if it matches the source directory (meaning out
+# of source is only prefered to in source, not enforced).
sub enforce_out_of_source_building {
- my ($this, $builddir) = @_;
+ my $this=shift;
+ my %args=@_;
if (!defined $this->get_builddir()) {
- $this->_set_builddir($builddir);
- # The build directory might have been dropped if it matched the
- # source directory. Just set to default in this case.
- if (!defined $this->get_builddir()) {
- $this->_set_builddir();
+ $this->_set_builddir($args{builddir});
+ if (!defined $this->get_builddir() && !$args{builddir}) {
+ # If we are here, DEFAULT_BUILD_DIRECTORY matches
+ # the source directory, building might fail.
+ error("default build directory is the same as the source directory." .
+ " Please specify a custom build directory");
}
}
}
# converts and returns path of $path being relative the $base.
sub _rel2rel {
my ($this, $path, $base, $root)=@_;
- $root = File::Spec->rootdir() if !defined $root;
+ $root = "/tmp" if !defined $root;
return File::Spec->abs2rel(
File::Spec->rel2abs($path, $root),
}
# Get path to the build directory if it was specified
-# (relative to the current (top) directory). undef otherwise.
+# (relative to the current (top) directory). undef if the same
+# as the source directory.
sub get_builddir {
my $this=shift;
return $this->{builddir};
}
}
-# Changes working directory to the source directory (if needed)
+# Changes working directory to the source directory (if needed),
# calls doit(@_) and changes working directory back to the top
# directory.
sub doit_in_sourcedir {
my $this=shift;
if ($this->get_sourcedir() ne '.') {
- my $sourcedir = get_sourcedir();
+ my $sourcedir = $this->get_sourcedir();
my $curdir = Cwd::getcwd();
$this->_cd($sourcedir);
doit(@_);
# If build directory does not exist, nothing is done and 0 is returned.
sub rmdir_builddir {
my $this=shift;
+ my $only_empty=shift;
if ($this->get_builddir()) {
my $buildpath = $this->get_buildpath();
if (-d $buildpath && ! $dh{NO_ACT}) {
- doit("rm", "-rf", $buildpath);
- # If build directory had 2 or more levels, delete empty
- # parent directories until the source directory level.
my @spdir = File::Spec->splitdir($this->get_build_rel2sourcedir());
my $peek;
- pop @spdir;
+ if (!$only_empty) {
+ doit("rm", "-rf", $buildpath);
+ pop @spdir;
+ }
+ # If build directory had 2 or more levels, delete empty
+ # parent directories until the source directory level.
while (($peek=pop(@spdir)) && $peek ne '.' && $peek ne '..') {
last if ! rmdir($this->get_sourcepath(File::Spec->catdir(@spdir, $peek)));
}
sub pre_building_step {
my $this=shift;
my ($step)=@_;
+
+ # Warn if in source building was enforced but build directory was
+ # specified. See enforce_in_source_building().
+ if ($this->{warn_insource}) {
+ warning("warning: " . $this->NAME() .
+ " does not support building out of source tree. In source building enforced.");
+ delete $this->{warn_insource};
+ }
}
# Instance method that is called after performing any step (see below).
# In case of failure, the method may just error() out.
#
# These methods should be overriden by derived classes to
-# implement buildsystem specific steps needed to build the
+# implement build system specific steps needed to build the
# source. Arbitary number of custom step arguments might be
# passed. Default implementations do nothing.
sub configure {
my $this=shift;
}
-1;
+1
projects / debhelper.git / blobdiff