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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
|
package Dist::Build;
$Dist::Build::VERSION = '0.020';
use strict;
use warnings;
use Exporter 5.57 'import';
our @EXPORT = qw/Build Build_PL/;
use Carp qw/croak/;
use CPAN::Meta;
use ExtUtils::Config;
use ExtUtils::Helpers 0.007 qw/split_like_shell detildefy make_executable/;
use ExtUtils::Manifest 'maniread';
use ExtUtils::InstallPaths;
use File::Spec::Functions qw/catfile catdir abs2rel /;
use Getopt::Long 2.36 qw/GetOptionsFromArray/;
use Parse::CPAN::Meta;
use version ();
use ExtUtils::Builder::Planner 0.016;
use ExtUtils::Builder::Util qw/get_perl unix_to_native_path/;
use Dist::Build::Serializer;
my $json_backend = Parse::CPAN::Meta->json_backend;
my $json = $json_backend->new->canonical->pretty->utf8;
my $serializer = 'Dist::Build::Serializer';
sub load_json {
my $filename = shift;
open my $fh, '<:raw', $filename;
my $content = do { local $/; <$fh> };
return $json->decode($content);
}
sub save_json {
my ($filename, $content) = @_;
open my $fh, '>:raw', $filename;
print $fh $json->encode($content);
return;
}
my @options = qw/install_base=s install_path=s% installdirs=s destdir=s prefix=s config=s% uninst:1 verbose:1 dry_run:1 pureperl_only|pureperl-only:1 create_packlist=i jobs=i allow_mb_mismatch:1/;
sub get_config {
my ($meta_name, @arguments) = @_;
my %options;
GetOptionsFromArray($_, \%options, @options) or die "Could not parse arguments" for @arguments;
$options{$_} = detildefy($options{$_}) for grep { exists $options{$_} } qw/install_base destdir prefix/;
if ($options{install_path}) {
$_ = detildefy($_) for values %{ $options{install_path} };
}
$options{config} = ExtUtils::Config->new($options{config});
$options{install_paths} = ExtUtils::InstallPaths->new(%options, dist_name => $meta_name);
return %options;
}
sub Build_PL {
my ($args, $env) = @_;
my $meta = CPAN::Meta->load_file('META.json', { lazy_validation => 0 });
my @env = defined $env->{PERL_MB_OPT} ? split_like_shell($env->{PERL_MB_OPT}) : ();
my %options = get_config($meta->name, [ @{$args} ], [ @env ]);
my $planner = ExtUtils::Builder::Planner->new;
$planner->create_phony('code', 'config');
$planner->create_phony('manify', 'config');
$planner->create_phony('dynamic');
$planner->create_phony('pure_all', 'code', 'manify', 'dynamic');
$planner->create_phony('build', 'pure_all');
$planner->add_delegate('meta', sub { $meta });
$planner->add_delegate('distribution', sub { $meta->name });
$planner->add_delegate('version', sub { version->new($meta->version) });
(my $main_module = $meta->name) =~ s/-/::/g;
$planner->add_delegate('main_module', sub { $main_module });
$planner->add_delegate('release_status', sub { $meta->release_status });
$planner->add_delegate('perl_path', sub { get_perl(config => $options{config}, %options) });
for my $variable (qw/config install_paths verbose uninst jobs pureperl_only/) {
$planner->add_delegate($variable, sub { $options{$variable} });
}
$planner->add_delegate('is_os', sub {
my ($self, @wanted) = @_;
return not not grep { $_ eq $^O } @wanted
});
$planner->add_delegate('is_os_type', sub {
my ($self, $wanted) = @_;
require Perl::OSType;
return Perl::OSType::is_os_type($wanted);
});
$planner->add_delegate('new_planner', sub {
my $inner = ExtUtils::Builder::Planner->new;
$inner->add_delegate('config', sub { $options{config} });
return $inner;
});
my @meta_fragments;
$planner->add_delegate('add_meta', sub {
my (undef, @fragments) = @_;
push @meta_fragments, @fragments;
});
my $core = $planner->new_scope;
$core->load_extension('Dist::Build::Core');
my @blibs = map { catfile('blib', $_) } qw/lib arch bindoc libdoc script bin/;
$core->mkdir($_) for @blibs;
$core->create_phony('config', @blibs);
$core->lib_dir('lib');
$core->add_seen(unix_to_native_path($_)) for sort keys %{ maniread() };
$core->tap_harness('test', dependencies => [ 'pure_all' ], test_dir => 't');
$core->install('install', dependencies => [ 'pure_all' ], install_map => $options{install_paths}->install_map);
for my $file (glob 'planner/*.pl') {
$planner->new_scope->run_dsl($file);
}
$core->autoclean;
my $plan = $planner->materialize;
mkdir '_build' if not -d '_build';
save_json(catfile(qw/_build graph/), $serializer->serialize_plan($plan));
save_json(catfile(qw/_build params/), [ $args, \@env ]);
if (@meta_fragments) {
require CPAN::Meta::Merge;
my $merger = CPAN::Meta::Merge->new(default_version => '2');
my $metahash = $merger->merge($meta, @meta_fragments);
$metahash->{dynamic_config} = 0;
$meta = CPAN::Meta->create($metahash, { lazy_validation => 0 });
}
$meta->save('MYMETA.json');
printf "Creating new 'Build' script for '%s' version '%s'\n", $meta->name, $meta->version;
my $dir = $meta->name eq 'Dist-Build' ? 'lib' : 'inc';
open my $fh, '>:utf8', 'Build';
print $fh "#!perl\nuse lib '$dir';\nuse Dist::Build;\nBuild(\\\@ARGV, \\\%ENV);\n";
close $fh;
make_executable('Build');
return;
}
sub Build {
my ($args, $env) = @_;
my $meta = CPAN::Meta->load_file('MYMETA.json', { lazy_validation => 0 });
my ($bpl, $mbopts) = @{ load_json(catfile(qw/_build params/)) };
my %options = get_config($meta->name, $bpl, $mbopts, $args);
my $action = @{$args} ? shift @{$args} : 'build';
my $preplan = load_json(catfile(qw/_build graph/));
my $plan = $serializer->deserialize_plan($preplan, %options);
return $plan->run($action);
}
1;
# ABSTRACT: A modern module builder, author tools not included!
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Build - A modern module builder, author tools not included!
=head1 VERSION
version 0.020
=head1 DESCRIPTION
C<Dist::Build> is a Build.PL implementation. Unlike L<Module::Build::Tiny> it is extensible, unlike L<Module::Build> it uses a build graph internally which makes it easy to combine different customizations. It's typically extended by adding a C<.pl> script in C<planner/>. E.g.
load_extension("Dist::Build::ShareDir");
dist_sharedir('share', 'Foo-Bar');
load_extension("Dist::Build::XS");
load_extension("Dist::Build::XS::Alien");
add_xs(
alien => 'foo',
extra_sources => [ glob 'src/*.c' ],
);
=head1 PLUGINS
=over 4
=item * L<Dist::Build::XS>
This plugin enables one to compile XS modules. It has a range of options, and a series of extensions that add to its capabilities.
=over 4
=item * L<Dist::Build::XS::Alien>
This is used to link to an L<Alien|Alien::Base> library.
=item * L<Dist::Build::XS::Conf>
This wraps L<ExtUtils::Builder::Conf|ExtUtils::Builder::Conf> to detect headers, libraries and features.
=item * L<Dist::Build::XS::Import>
This can be used to import headers and flags as exported by L<Dist::Build::XS::Export|Dist::Build::XS::Export>.
=item * L<Dist::Build::XS::PkgConfig>
This adds flags for a given library as configured in its pkgconfig file.
=item * L<Dist::Build::XS::WriteConstants>
This integrates L<ExtUtils::Constant|ExtUtils::Constant> into the C<add_xs> command.
=back
=item * L<Dist::Build::ShareDir>
This allows one to install sharedirs
=item * L<Dist::Build::XS::Export>
This allows one to export headers and flags, to be imported by L<Dist::Build::XS::Import|Dist::Build::XS::Import>
=item * L<Dist::Build::DynamicPrereqs>
This allows one to dynamically evaluate dependencies.
=item * L<Dist::Build::Core>
This module contains all commands used for the base actions of the module.
=back
=head1 DELEGATES
By default, the following delegates are defined on your L<planner|ExtUtils::Builder::Planner>:
=over 4
=item * meta
A L<CPAN::Meta|CPAN::Meta> object representing the C<META.json> file.
=item * distribution
The name of the distribution
=item * version
The version of the distribution
=item * main_module
The main module of the distribution.
=item * release_status
The release status of the distribution (e.g. C<'stable'>).
=item * perl_path
The path to the perl executable.
=item * config
The L<ExtUtils::Config|ExtUtils::Config> object for this build
=item * install_paths
The L<ExtUtils::InstallPaths|ExtUtils::InstallPaths> object for this build.
=item * is_os(@os_names)
This returns true if the current operating system matches any of the listed ones.
=item * is_os_type($os_type)
This returns true if the type of the OS matches C<$os_type>. Legal values are C<Unix>, C<Windows> and C<VMS>.
=item * verbose
The value of the C<verbose> command line argument.
=item * uninst
The value of the C<uninst> command line argument.
=item * jobs
The value of the C<jobs> command line argument.
=item * pureperl_only
The value of the C<pureperl_only> command line argument.
=back
=head1 AUTHOR
Leon Timmermans <fawaka@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Leon Timmermans.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|