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 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
|
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
use strict;
use warnings;
use lib '../clownfish/perl/blib/arch';
use lib '../clownfish/perl/blib/lib';
use lib 'clownfish/perl/blib/arch';
use lib 'clownfish/perl/blib/lib';
package Lucy::Build::CBuilder;
BEGIN { our @ISA = "ExtUtils::CBuilder"; }
use Config;
our $VERSION = '0.003003';
$VERSION = eval $VERSION;
my %cc;
sub new {
my ( $class, %args ) = @_;
require ExtUtils::CBuilder;
if ( $ENV{LUCY_VALGRIND} ) {
$args{config} ||= {};
$args{config}{optimize} ||= $Config{optimize};
$args{config}{optimize} =~ s/\-O\d+/-O1/g;
}
my $self = $class->SUPER::new(%args);
$cc{"$self"} = $args{'config'}->{'cc'};
return $self;
}
sub get_cc { $cc{"$_[0]"} }
sub DESTROY {
my $self = shift;
delete $cc{"$self"};
}
# This method isn't implemented by CBuilder for Windows, so we issue a basic
# link command that works on at least one system and hope for the best.
sub link_executable {
my ( $self, %args ) = @_;
if ( $self->get_cc eq 'cl' ) {
my ( $objects, $exe_file ) = @args{qw( objects exe_file )};
$self->do_system("link /out:$exe_file @$objects");
return $exe_file;
}
else {
return $self->SUPER::link_executable(%args);
}
}
package Lucy::Build;
use base qw( Module::Build );
our $VERSION = '0.003003';
$VERSION = eval $VERSION;
use File::Spec::Functions
qw( catdir catfile splitpath updir no_upwards rel2abs );
use File::Path qw( mkpath rmtree );
use File::Copy qw( copy move );
use File::Find qw( find );
use Config;
use Env qw( @PATH );
use Fcntl;
use Carp;
use Cwd qw( getcwd );
BEGIN { unshift @PATH, rel2abs( getcwd() ) }
sub extra_ccflags {
my $self = shift;
my $gcc_flags = '-std=gnu99 -D_GNU_SOURCE ';
if ( $Config{osname} =~ /openbsd/i && !$Config{usethreads} ) {
$gcc_flags .= '-DLUCY_NOTHREADS ';
}
if ( defined $ENV{LUCY_VALGRIND} ) {
return "$gcc_flags -DLUCY_VALGRIND -fno-inline-functions ";
}
elsif ( defined $ENV{LUCY_DEBUG} ) {
return "$gcc_flags -DLUCY_DEBUG -pedantic -Wall -Wextra "
. "-Wno-variadic-macros ";
}
elsif ( $self->config('gccversion') ) {
return $gcc_flags;
}
elsif ( $self->config('cc') =~ /^cl\b/ ) {
# Compile as C++ under MSVC.
return '/TP -D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_WARNINGS ';
}
}
=for Rationale
When the distribution tarball for the Perl binding of Lucy is built, core/,
charmonizer/, and any other needed files/directories are copied into the
perl/ directory within the main Lucy directory. Then the distro is built from
the contents of the perl/ directory, leaving out all the files in ruby/, etc.
However, during development, the files are accessed from their original
locations.
=cut
my $is_distro_not_devel = -e 'core';
my $base_dir = rel2abs( $is_distro_not_devel ? getcwd() : updir() );
my $CHARMONIZER_ORIG_DIR = catdir( $base_dir, 'charmonizer' );
my $CHARMONIZE_EXE_PATH
= catfile( $CHARMONIZER_ORIG_DIR, "charmonize$Config{_exe}" );
my $CHARMONY_PATH = 'charmony.h';
my $LEMON_DIR = catdir( $base_dir, 'lemon' );
my $LEMON_EXE_PATH = catfile( $LEMON_DIR, "lemon$Config{_exe}" );
my $SNOWSTEM_SRC_DIR
= catdir( $base_dir, qw( modules analysis snowstem source ) );
my $SNOWSTEM_INC_DIR = catdir( $SNOWSTEM_SRC_DIR, 'include' );
my $SNOWSTOP_SRC_DIR
= catdir( $base_dir, qw( modules analysis snowstop source ) );
my $UCD_INC_DIR = catdir( $base_dir, qw( modules unicode ucd ) );
my $UTF8PROC_SRC_DIR = catdir( $base_dir, qw( modules unicode utf8proc ) );
my $UTF8PROC_C = catfile( $UTF8PROC_SRC_DIR, 'utf8proc.c' );
my $CORE_SOURCE_DIR = catdir( $base_dir, 'core' );
my $CLOWNFISH_DIR = catdir( $base_dir, 'clownfish', 'perl' );
my $CLOWNFISH_BUILD = catfile( $CLOWNFISH_DIR, 'Build' );
my $AUTOGEN_DIR = 'autogen';
my $XS_SOURCE_DIR = 'xs';
my $LIB_DIR = 'lib';
my $XS_FILEPATH = catfile( $LIB_DIR, "Lucy.xs" );
my $AUTOBIND_PM_PATH = catfile( $LIB_DIR, 'Lucy', 'Autobinding.pm' );
sub new { shift->SUPER::new( recursive_test_files => 1, @_ ) }
sub _run_make {
my ( $self, %params ) = @_;
my @command = @{ $params{args} };
my $dir = $params{dir};
my $current_directory = getcwd();
chdir $dir if $dir;
unshift @command, 'CC=' . $self->config('cc');
if ( $self->config('cc') =~ /^cl\b/ ) {
unshift @command, "-f", "Makefile.MSVC";
}
elsif ( $^O =~ /mswin/i ) {
unshift @command, "-f", "Makefile.MinGW";
}
unshift @command, "$Config{make}";
system(@command) and confess("$Config{make} failed");
chdir $current_directory if $dir;
}
# Build the charmonize executable.
sub ACTION_charmonize {
my $self = shift;
print "Building $CHARMONIZE_EXE_PATH...\n\n";
$self->_run_make(
dir => $CHARMONIZER_ORIG_DIR,
args => [],
);
}
# Run the charmonize executable, creating the charmony.h file.
sub ACTION_charmony {
my $self = shift;
$self->dispatch('charmonize');
return if $self->up_to_date( $CHARMONIZE_EXE_PATH, $CHARMONY_PATH );
print "\nWriting $CHARMONY_PATH...\n\n";
# Clean up after charmonize if it doesn't succeed on its own.
$self->add_to_cleanup("_charm*");
$self->add_to_cleanup($CHARMONY_PATH);
# Prepare arguments to charmonize.
my $flags = $self->config('ccflags') . ' ' . $self->extra_ccflags;
$flags =~ s/"/\\"/g;
my @command = ( $CHARMONIZE_EXE_PATH, $self->config('cc'), $flags );
if ( $ENV{CHARM_VALGRIND} ) {
unshift @command, "valgrind", "--leak-check=yes";
}
print join( " ", @command ), $/;
system(@command) and die "Failed to write $CHARMONY_PATH: $!";
}
# Build the charmonizer tests.
sub ACTION_charmonizer_tests {
my $self = shift;
$self->dispatch('charmony');
print "Building Charmonizer Tests...\n\n";
my $flags = join( " ",
$self->config('ccflags'),
$self->extra_ccflags, '-I' . rel2abs( getcwd() ) );
$flags =~ s/"/\\"/g;
$self->_run_make(
dir => $CHARMONIZER_ORIG_DIR,
args => [ "DEFS=$flags", "tests" ],
);
}
# Build the Lemon parser generator.
sub ACTION_lemon {
my $self = shift;
print "Building the Lemon parser generator...\n\n";
$self->_run_make(
dir => $LEMON_DIR,
args => [],
);
}
sub _compile_clownfish {
my $self = shift;
require Clownfish::CFC::Hierarchy;
require Clownfish::CFC::Binding::Perl;
require Clownfish::CFC::Binding::Perl::Class;
# Compile Clownfish.
my $hierarchy = Clownfish::CFC::Hierarchy->new(
source => $CORE_SOURCE_DIR,
dest => $AUTOGEN_DIR,
);
$hierarchy->build;
# Process all __BINDING__ blocks.
my $pm_filepaths = $self->rscan_dir( $LIB_DIR, qr/\.pm$/ );
my @pm_filepaths_with_xs;
for my $pm_filepath (@$pm_filepaths) {
open( my $pm_fh, '<', $pm_filepath )
or die "Can't open '$pm_filepath': $!";
my $pm_content = do { local $/; <$pm_fh> };
my ($autobind_frag)
= $pm_content =~ /^__BINDING__\s*(.*?)(?:^__\w+__|\Z)/sm;
if ($autobind_frag) {
push @pm_filepaths_with_xs, $pm_filepath;
eval $autobind_frag;
confess("Invalid __BINDING__ from $pm_filepath: $@") if $@;
}
}
my $binding = Clownfish::CFC::Binding::Perl->new(
parcel => 'Lucy',
hierarchy => $hierarchy,
lib_dir => $LIB_DIR,
boot_class => 'Lucy',
header => $self->autogen_header,
footer => '',
);
return ( $hierarchy, $binding, \@pm_filepaths_with_xs );
}
sub ACTION_pod {
my $self = shift;
$self->dispatch("cfc");
$self->_write_pod(@_);
}
sub _write_pod {
my ( $self, $binding ) = @_;
if ( !$binding ) {
( undef, $binding ) = $self->_compile_clownfish;
}
my $pod_files = $binding->prepare_pod( lib_dir => $LIB_DIR );
print "Writing POD...\n";
while ( my ( $filepath, $pod ) = each %$pod_files ) {
$self->add_to_cleanup($filepath);
unlink $filepath;
sysopen( my $pod_fh, $filepath, O_CREAT | O_EXCL | O_WRONLY )
or confess("Can't open '$filepath': $!");
print $pod_fh $pod;
}
}
sub ACTION_cfc {
my $self = shift;
my $old_dir = getcwd();
chdir($CLOWNFISH_DIR);
if ( !-f 'Build' ) {
print "\nBuilding Clownfish compiler... \n";
system("$^X Build.PL");
system("$^X Build code");
print "\nFinished building Clownfish compiler.\n\n";
}
chdir($old_dir);
}
sub ACTION_clownfish {
my $self = shift;
$self->dispatch('charmonizer_tests');
$self->dispatch('cfc');
# Create destination dir, copy xs helper files.
if ( !-d $AUTOGEN_DIR ) {
mkdir $AUTOGEN_DIR or die "Can't mkdir '$AUTOGEN_DIR': $!";
}
$self->add_to_cleanup($AUTOGEN_DIR);
my $pm_filepaths = $self->rscan_dir( $LIB_DIR, qr/\.pm$/ );
my $cfh_filepaths = $self->rscan_dir( $CORE_SOURCE_DIR, qr/\.cfh$/ );
# XXX joes thinks this is dubious
# Don't bother parsing Clownfish files if everything's up to date.
return
if $self->up_to_date(
[ @$cfh_filepaths, @$pm_filepaths ],
[ $XS_FILEPATH, $AUTOGEN_DIR, ]
);
# Write out all autogenerated files.
print "Parsing Clownfish files...\n";
my ( $hierarchy, $perl_binding, $pm_filepaths_with_xs )
= $self->_compile_clownfish;
require Clownfish::CFC::Binding::Core;
my $core_binding = Clownfish::CFC::Binding::Core->new(
hierarchy => $hierarchy,
dest => $AUTOGEN_DIR,
header => $self->autogen_header,
footer => '',
);
print "Writing Clownfish autogenerated files...\n";
my $modified = $core_binding->write_all_modified;
if ($modified) {
unlink('typemap');
print "Writing typemap...\n";
$self->add_to_cleanup('typemap');
$perl_binding->write_xs_typemap;
}
# Rewrite XS if either any .cfh files or relevant .pm files were modified.
$modified ||=
$self->up_to_date( \@$pm_filepaths_with_xs, $XS_FILEPATH )
? 0
: 1;
if ($modified) {
$self->add_to_cleanup($XS_FILEPATH);
$self->add_to_cleanup($AUTOBIND_PM_PATH);
$perl_binding->write_boot;
$perl_binding->write_bindings;
$self->_write_pod($perl_binding);
}
# Touch autogenerated files in case the modifications were inconsequential
# and didn't trigger a rewrite, so that we won't have to check them again
# next pass.
if (!$self->up_to_date(
[ @$cfh_filepaths, @$pm_filepaths_with_xs ], $XS_FILEPATH
)
)
{
utime( time, time, $XS_FILEPATH ); # touch
}
if (!$self->up_to_date(
[ @$cfh_filepaths, @$pm_filepaths_with_xs ], $AUTOGEN_DIR
)
)
{
utime( time, time, $AUTOGEN_DIR ); # touch
}
}
# Write ppport.h, which supplies some XS routines not found in older Perls and
# allows us to use more up-to-date XS API while still supporting Perls back to
# 5.8.3.
#
# The Devel::PPPort docs recommend that we distribute ppport.h rather than
# require Devel::PPPort itself, but ppport.h isn't compatible with the Apache
# license.
sub ACTION_ppport {
my $self = shift;
if ( !-e 'ppport.h' ) {
require Devel::PPPort;
$self->add_to_cleanup('ppport.h');
Devel::PPPort::WriteFile();
}
}
sub ACTION_suppressions {
my $self = shift;
my $LOCAL_SUPP = 'local.supp';
return
if $self->up_to_date( '../devel/bin/valgrind_triggers.pl',
$LOCAL_SUPP );
# Generate suppressions.
print "Writing $LOCAL_SUPP...\n";
$self->add_to_cleanup($LOCAL_SUPP);
my $command
= "yes | "
. $self->_valgrind_base_command
. "--gen-suppressions=yes "
. $self->perl
. " ../devel/bin/valgrind_triggers.pl 2>&1";
my $suppressions = `$command`;
$suppressions =~ s/^==.*?\n//mg;
$suppressions =~ s/^--.*?\n//mg;
my $rule_number = 1;
while ( $suppressions =~ /<insert.a.*?>/ ) {
$suppressions =~ s/^\s*<insert.a.*?>/{\n <core_perl_$rule_number>/m;
$rule_number++;
}
# Change e.g. fun:_vgrZU_libcZdsoZa_calloc to fun:calloc
$suppressions =~ s/fun:\w+_((m|c|re)alloc)/fun:$1/g;
# Write local suppressions file.
open( my $supp_fh, '>', $LOCAL_SUPP )
or confess("Can't open '$LOCAL_SUPP': $!");
print $supp_fh $suppressions;
}
sub _valgrind_base_command {
return
"PERL_DESTRUCT_LEVEL=2 LUCY_VALGRIND=1 valgrind "
. "--leak-check=yes "
. "--show-reachable=yes "
. "--num-callers=10 "
. "--dsymutil=yes "
. "--suppressions=../devel/conf/lucyperl.supp ";
}
# Run the entire test suite under Valgrind.
#
# For this to work, Lucy must be compiled with the LUCY_VALGRIND environment
# variable set to a true value, under a debugging Perl.
#
# A custom suppressions file will probably be needed -- use your judgment.
# To pass in one or more local suppressions files, provide a comma separated
# list like so:
#
# $ ./Build test_valgrind --suppressions=foo.supp,bar.supp
sub ACTION_test_valgrind {
my $self = shift;
die "Must be run under a perl that was compiled with -DDEBUGGING"
unless $self->config('ccflags') =~ /-D?DEBUGGING\b/;
if ( !$ENV{LUCY_VALGRIND} ) {
warn "\$ENV{LUCY_VALGRIND} not true -- possible false positives";
}
$self->dispatch('code');
$self->dispatch('suppressions');
# Unbuffer STDOUT, grab test file names and suppressions files.
$|++;
my $t_files = $self->find_test_files; # not public M::B API, may fail
my $valgrind_command = $self->_valgrind_base_command;
$valgrind_command .= "--suppressions=local.supp ";
if ( my $local_supp = $self->args('suppressions') ) {
for my $supp ( split( ',', $local_supp ) ) {
$valgrind_command .= "--suppressions=$supp ";
}
}
# Iterate over test files.
my @failed;
for my $t_file (@$t_files) {
# Run test file under Valgrind.
print "Testing $t_file...";
die "Can't find '$t_file'" unless -f $t_file;
my $command = "$valgrind_command $^X -Mblib $t_file 2>&1";
my $output = "\n" . ( scalar localtime(time) ) . "\n$command\n";
$output .= `$command`;
# Screen-scrape Valgrind output, looking for errors and leaks.
if ( $?
or $output =~ /ERROR SUMMARY:\s+[^0\s]/
or $output =~ /definitely lost:\s+[^0\s]/
or $output =~ /possibly lost:\s+[^0\s]/
or $output =~ /still reachable:\s+[^0\s]/ )
{
print " failed.\n";
push @failed, $t_file;
print "$output\n";
}
else {
print " succeeded.\n";
}
}
# If there are failed tests, print a summary list.
if (@failed) {
print "\nFailed "
. scalar @failed . "/"
. scalar @$t_files
. " test files:\n "
. join( "\n ", @failed ) . "\n";
exit(1);
}
}
# Run all .y files through lemon.
sub ACTION_parsers {
my $self = shift;
$self->dispatch('lemon');
my $y_files = $self->rscan_dir( $CORE_SOURCE_DIR, qr/\.y$/ );
for my $y_file (@$y_files) {
my $c_file = $y_file;
my $h_file = $y_file;
$c_file =~ s/\.y$/.c/ or die "no match";
$h_file =~ s/\.y$/.h/ or die "no match";
next if $self->up_to_date( $y_file, [ $c_file, $h_file ] );
$self->add_to_cleanup( $c_file, $h_file );
system( $LEMON_EXE_PATH, '-q', $y_file ) and die "lemon failed";
}
}
sub ACTION_compile_custom_xs {
my $self = shift;
$self->dispatch('ppport');
$self->dispatch('parsers');
require ExtUtils::ParseXS;
my $cbuilder
= Lucy::Build::CBuilder->new( config => { cc => $self->config('cc') },
);
my $archdir = catdir( $self->blib, 'arch', 'auto', 'Lucy', );
mkpath( $archdir, 0, 0777 ) unless -d $archdir;
my @include_dirs = (
getcwd(), $CORE_SOURCE_DIR, $AUTOGEN_DIR,
$XS_SOURCE_DIR, $SNOWSTEM_INC_DIR, $UCD_INC_DIR,
$UTF8PROC_SRC_DIR
);
my @objects;
# Compile C source files.
my $c_files = [];
push @$c_files, @{ $self->rscan_dir( $CORE_SOURCE_DIR, qr/\.c$/ ) };
push @$c_files, @{ $self->rscan_dir( $XS_SOURCE_DIR, qr/\.c$/ ) };
push @$c_files, @{ $self->rscan_dir( $AUTOGEN_DIR, qr/\.c$/ ) };
push @$c_files, @{ $self->rscan_dir( $SNOWSTEM_SRC_DIR, qr/\.c$/ ) };
push @$c_files, @{ $self->rscan_dir( $SNOWSTOP_SRC_DIR, qr/\.c$/ ) };
push @$c_files, $UTF8PROC_C;
for my $c_file (@$c_files) {
my $o_file = $c_file;
my $ccs_file = $c_file;
$o_file =~ s/\.c$/$Config{_o}/ or die "no match";
$ccs_file =~ s/\.c$/.ccs/ or die "no match";
push @objects, $o_file;
next if $self->up_to_date( $c_file, $o_file );
$self->add_to_cleanup($o_file);
$self->add_to_cleanup($ccs_file);
$cbuilder->compile(
source => $c_file,
extra_compiler_flags => $self->extra_ccflags,
include_dirs => \@include_dirs,
object_file => $o_file,
);
}
# .xs => .c
my $perl_binding_c_file = catfile( $LIB_DIR, 'Lucy.c' );
$self->add_to_cleanup($perl_binding_c_file);
if ( !$self->up_to_date( $XS_FILEPATH, $perl_binding_c_file ) ) {
ExtUtils::ParseXS::process_file(
filename => $XS_FILEPATH,
prototypes => 0,
output => $perl_binding_c_file,
);
}
# .c => .o
my $version = $self->dist_version;
my $perl_binding_o_file = catfile( $LIB_DIR, "Lucy$Config{_o}" );
unshift @objects, $perl_binding_o_file;
$self->add_to_cleanup($perl_binding_o_file);
if ( !$self->up_to_date( $perl_binding_c_file, $perl_binding_o_file ) ) {
$cbuilder->compile(
source => $perl_binding_c_file,
extra_compiler_flags => $self->extra_ccflags,
include_dirs => \@include_dirs,
object_file => $perl_binding_o_file,
# 'defines' is an undocumented parameter to compile(), so we
# should officially roll our own variant and generate compiler
# flags. However, that involves writing a bunch of
# platform-dependent code, so we'll just take the chance that this
# will break.
defines => {
VERSION => qq|"$version"|,
XS_VERSION => qq|"$version"|,
},
);
}
# Create .bs bootstrap file, needed by Dynaloader.
my $bs_file = catfile( $archdir, "Lucy.bs" );
$self->add_to_cleanup($bs_file);
if ( !$self->up_to_date( $perl_binding_o_file, $bs_file ) ) {
require ExtUtils::Mkbootstrap;
ExtUtils::Mkbootstrap::Mkbootstrap($bs_file);
if ( !-f $bs_file ) {
# Create file in case Mkbootstrap didn't do anything.
open( my $fh, '>', $bs_file )
or confess "Can't open $bs_file: $!";
}
utime( (time) x 2, $bs_file ); # touch
}
# Clean up after CBuilder under MSVC.
$self->add_to_cleanup('compilet*');
$self->add_to_cleanup('*.ccs');
$self->add_to_cleanup( catfile( 'lib', 'Lucy.ccs' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy.def' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy_def.old' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy.exp' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy.lib' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy.lds' ) );
$self->add_to_cleanup( catfile( 'lib', 'Lucy.base' ) );
# .o => .(a|bundle)
my $lib_file = catfile( $archdir, "Lucy.$Config{dlext}" );
if ( !$self->up_to_date( [ @objects, $AUTOGEN_DIR ], $lib_file ) ) {
# TODO: use Charmonizer to determine whether pthreads are userland.
my $link_flags = '';
if ( $Config{osname} =~ /openbsd/i && $Config{usethreads} ) {
$link_flags = '-lpthread ';
}
$cbuilder->link(
module_name => 'Lucy',
objects => \@objects,
lib_file => $lib_file,
extra_linker_flags => $link_flags,
);
}
}
sub ACTION_code {
my $self = shift;
$self->dispatch('clownfish');
$self->dispatch('compile_custom_xs');
$self->SUPER::ACTION_code;
}
sub autogen_header {
my $self = shift;
return <<"END_AUTOGEN";
/***********************************************
!!!! DO NOT EDIT !!!!
This file was auto-generated by Build.PL.
***********************************************/
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
END_AUTOGEN
}
sub _check_module_build_for_dist {
eval "use Module::Build 0.38;";
die "./Build dist reqiures Module::Build 0.38 or higher--this is only "
. Module::Build->VERSION . $/ if $@;
}
sub ACTION_distdir {
_check_module_build_for_dist;
shift->SUPER::ACTION_distdir(@_);
}
sub ACTION_dist {
my $self = shift;
_check_module_build_for_dist;
# Create POD but make sure not to include build artifacts.
$self->dispatch('pod');
_clean_prereq_builds($self);
# We build our Perl release tarball from $REPOS_ROOT/perl, rather than
# from the top-level.
#
# Because some items we need are outside this directory, we need to copy a
# bunch of stuff. After the tarball is packaged up, we delete the copied
# directories.
my @items_to_copy = qw(
core
modules
charmonizer
devel
clownfish
lemon
CHANGES
CONTRIBUTING
LICENSE
NOTICE
README
);
print "Copying files...\n";
for my $item (@items_to_copy) {
confess("'$item' already exists") if -e $item;
system("cp -R ../$item $item");
}
$self->dispatch('manifest');
my $no_index = $self->_gen_pause_exclusion_list;
$self->meta_add( { no_index => $no_index } );
$self->SUPER::ACTION_dist;
# Clean up.
print "Removing copied files...\n";
rmtree($_) for @items_to_copy;
unlink("META.yml");
move( "MANIFEST.bak", "MANIFEST" ) or die "move() failed: $!";
}
sub ACTION_distmeta {
my $self = shift;
$self->SUPER::ACTION_distmeta(@_);
# Make sure everything has a version.
require CPAN::Meta;
my $v = version->new($self->dist_version);
my $meta = CPAN::Meta->load_file('META.json');
my $provides = $meta->provides;
while (my ($pkg, $data) = each %{ $provides }) {
die "$pkg, defined in $data->{file}, has no version\n"
unless $data->{version};
die "$pkg, defined in $data->{file}, is "
. version->new($data->{version})->normal
. " but should be " . $v->normal . "\n"
unless $data->{version} == $v;
}
}
# Generate a list of files for PAUSE, search.cpan.org, etc to ignore.
sub _gen_pause_exclusion_list {
my $self = shift;
# Only exclude files that are actually on-board.
open( my $man_fh, '<', 'MANIFEST' ) or die "Can't open MANIFEST: $!";
my @manifest_entries = <$man_fh>;
chomp @manifest_entries;
my @excluded_files;
for my $entry (@manifest_entries) {
# Allow README and Changes.
next if $entry =~ m#^(README|Changes)#;
# Allow public modules.
if ( $entry =~ m#^(perl/)?lib\b.+\.(pm|pod)$# ) {
open( my $fh, '<', $entry ) or die "Can't open '$entry': $!";
my $content = do { local $/; <$fh> };
next if $content =~ /=head1\s*NAME/;
}
# Disallow everything else.
push @excluded_files, $entry;
}
# Exclude redacted modules.
if ( eval { require "buildlib/Lucy/Redacted.pm" } ) {
my @redacted = map {
my @parts = split( /\W+/, $_ );
catfile( $LIB_DIR, @parts ) . '.pm'
} Lucy::Redacted->redacted, Lucy::Redacted->hidden;
push @excluded_files, @redacted;
}
my %uniquifier;
@excluded_files = sort grep { !$uniquifier{$_}++ } @excluded_files;
return { file => \@excluded_files };
}
sub ACTION_semiclean {
my $self = shift;
print "Cleaning up most build files.\n";
my @candidates
= grep { $_ !~ /(charmonizer|^_charm|charmony|charmonize|snowstem)/ }
$self->cleanup;
for my $path ( map { glob($_) } @candidates ) {
next unless -e $path;
rmtree($path);
confess("Failed to remove '$path'") if -e $path;
}
}
# Run the cleanup targets for independent prerequisite builds.
sub _clean_prereq_builds {
my $self = shift;
if ( -e $CLOWNFISH_BUILD ) {
my $old_dir = getcwd();
chdir $CLOWNFISH_DIR;
system("$^X Build realclean")
and die "Clownfish clean failed";
chdir $old_dir;
}
$self->_run_make( dir => $CHARMONIZER_ORIG_DIR, args => ['clean'] );
$self->_run_make( dir => $LEMON_DIR, args => ['clean'] );
}
sub ACTION_clean {
my $self = shift;
_clean_prereq_builds($self);
$self->SUPER::ACTION_clean;
}
1;
__END__
|