File Coverage

blib/lib/XS/Install.pm

Criterion	Covered	Total	%
statement	494	848	58.2
branch	143	382	37.4
condition	67	225	29.7
subroutine	66	85	77.6
pod	2	44	4.5
total	772	1584	48.7

package XS::Install;
use strict;
use warnings;
use Config;
use Cwd qw/getcwd abs_path/;
use Exporter 'import';
use ExtUtils::MakeMaker;
use XS::Loader;
use XS::Install::Deps;
use XS::Install::Util;
use XS::Install::Payload;
use XS::Install::CMake;
use Data::Dumper;

our $VERSION = '1.5.2';
my $THIS_MODULE = 'XS::Install';

our @EXPORT_OK = qw/write_makefile not_available/;
our @EXPORT;

if ($0 =~ /Makefile.PL$/) {
    @EXPORT = qw/write_makefile not_available/;
    _require_makemaker();
}

my $xs_mask  = '*.xs';
my $c_mask   = '*.c *.cc *.cpp *.cxx';
my $h_mask   = '*.h *.hh *.hpp *.hxx';
my $map_mask = '*.map';

my $win32     = $^O eq 'MSWin32';
my $linux     = $^O eq 'linux';
my $freebsd   = $^O eq 'freebsd';
my $mac       = $^O eq 'darwin';
my $dragonfly = $^O eq 'dragonfly';
my $netbsd    = $^O eq 'netbsd';
my $openbsd   = $^O eq 'openbsd';
my $solaris   = $^O eq 'solaris';

my $native_bsd_make = $freebsd || $dragonfly || $netbsd || $openbsd || $solaris;
my $fix_bsd_make_j  = $freebsd || $dragonfly || $netbsd;

sub write_makefile {
    _require_makemaker();

    my ($main_params, $test_params) = makemaker_args(@_);

    MY::init_methods();
    WriteMakefile(%$main_params);

    if ($test_params) {
        MY::init_methods();
        WriteMakefile(%$test_params);
    }
}

sub makemaker_args {
    my $params = ref($_[0]) eq 'HASH' ? $_[0] : {@_};
    _sync();
    die "You must define a NAME param" unless $params->{NAME};

    pre_process($params);
    process_FROM($params);
    process_REQUIRES($params);
    process_BIN_DEPS($params);
    process_PARSE_XS($params);
    process_CPLUS($params);
    process_CCFLAGS($params);
    $params->{OPTIMIZE} = merge_optimize($Config{optimize}, '-O2', $params->{OPTIMIZE});
    process_PKG_CONFIG($params);
    process_SANITIZE($params);
    process_CLIB($params);
    process_binary($params);
    process_PM($params);
    process_PAYLOAD($params);
    process_LD($params);

    my $test_mm_args;
    if ($params->{_XSTEST}) {
        process_test_makefile($params);
    } else {
        $test_mm_args = process_test($params);
        my $cmake_params = process_cmake_test($params, $params->{CMAKE_PARAMS}, $test_mm_args);
        run_cmake($params, $cmake_params, $test_mm_args) if ($cmake_params);
    }
    process_BIN_SHARE($params);
    attach_BIN_DEPENDENT($params);
    warn_BIN_DEPENDENT($params);
    fix_flags($params);

    process_INSTALL_SKIP($params);
    post_process($params);

    return ($params, $test_mm_args) if wantarray();
    return $params;
}

sub pre_process {
    my $params = shift;

    my $postamble = $params->{postamble};
    if ($postamble) {
        my $ref = ref $postamble;
        if    (!$ref)           { $postamble = [$postamble] }
        elsif ($ref eq 'HASH')  { $postamble = [values %$postamble] }
        elsif ($ref ne 'ARRAY') { die "postamble must be string or array ref" }
    }
    $postamble ||= [];
    $params->{postamble} = $postamble;

    $params->{clean} ||= {};
    $params->{clean}{FILES} ||= '';

    if (my $comp = ($ENV{COMPILER} || $ENV{CC})) {
        $params->{CC} = $comp;
    }

    if (my $opt = $ENV{OPTIMIZE}) {
        $params->{OPTIMIZE} = $opt;
    }

    canonize_array_split($params->{TYPEMAPS});
    canonize_array_split($params->{PARSE_XS});

    my $module_info = XS::Install::Payload::binary_module_info($params->{NAME}) || {};
    $params->{MODULE_INFO} = {
        BIN_DEPENDENT => $module_info->{BIN_DEPENDENT},
        STATIC_LIBS   => [],
        SHARED_LIBS   => [],
        ORIG          => {
            INC       => $params->{INC} || '',
            CCFLAGS   => $params->{CCFLAGS},
            LDDLFLAGS => $params->{LDDLFLAGS},
            LINK      => $params->{LINK},
        },
        INSTALL_SKIP  => [],
    };

    $params->{UNIQUE_LIBNAME} //= $win32;
    *DynaLoader::mod2fname = \&XS::Loader::mod2fname_unique if delete $params->{UNIQUE_LIBNAME};

    $params->{BIN_SHARE} = {} if $params->{BIN_SHARE} && !ref($params->{BIN_SHARE});
    $params->{BIN_SHARE}{LINK} //= $params->{LINK} if $params->{BIN_SHARE} && $params->{LINK};
}

sub process_FROM {
    my $params = shift;
    my $module = $params->{NAME} or die "You must define a NAME param";

    if (my $file = delete $params->{ALL_FROM}) {
        $params->{VERSION_FROM}  = $file unless $params->{VERSION};
        $params->{ABSTRACT_FROM} = $file unless $params->{ABSTRACT};
    }

    my $pm = 'lib/'._pkg_file($module);
    my $pod = 'lib/'._pkg_slash($module).'.pod';

    $params->{VERSION_FROM}  ||= $pm unless $params->{VERSION};
    $params->{ABSTRACT_FROM} ||= (-f $pod) ? $pod : $pm unless $params->{ABSTRACT};
}

sub process_REQUIRES {
    my $params = shift;

    $params->{CONFIGURE_REQUIRES} ||= {};
    $params->{BUILD_REQUIRES} ||= {};

    $params->{TEST_REQUIRES} ||= {};
    $params->{TEST_REQUIRES}{'Test::Simple'} ||= '0.96';
    $params->{TEST_REQUIRES}{'Test::More'}   ||= 0;
    $params->{TEST_REQUIRES}{'Test::Deep'}   ||= 0;

    $params->{PREREQ_PM} ||= {};

    unless ($params->{NAME} eq $THIS_MODULE) { # skip when building XS::Install itself
        $params->{CONFIGURE_REQUIRES}{$THIS_MODULE} ||= $VERSION;
        $params->{PREREQ_PM         }{$THIS_MODULE} ||= $VERSION;
    }
}

sub process_PM {
    my $params = shift;
    return if $params->{PM}; # user-defined value overrides defaults

    my $instroot = _instroot($params);
    my @name_parts = split '::', $params->{NAME};
    $params->{PMLIBDIRS} ||= ['lib', $name_parts[-1]];
    my $pm = $params->{PM} = {};

    foreach my $dir (@{$params->{PMLIBDIRS}}) {
        next unless -d $dir;
        foreach my $file (_scan_files('*.pm *.pl *.pod', $dir)) {
            my $rel = $file;
            $rel =~ s/^$dir//;
            my $instpath = "$instroot/$rel";
            $instpath =~ s#[/\\]{2,}#/#g;
            $pm->{$file} = $instpath;
        }
    }
}

sub process_PAYLOAD {
    my $params = shift;
    my $payload = delete $params->{PAYLOAD} or return;
    _process_map($payload, '*');
    _install($params, $payload, 'payload');
}

sub process_BIN_DEPS {
    my $params = shift;
    my $bin_deps = delete $params->{BIN_DEPS};
    canonize_array_split($bin_deps);
    push @$bin_deps, $THIS_MODULE unless $params->{NAME} eq $THIS_MODULE;

    my $typemaps = $params->{TYPEMAPS};
    $params->{TYPEMAPS} = [];
    my $seen = {};
    _apply_BIN_DEPS($params, $_, $seen) for @$bin_deps;
    push @{$params->{TYPEMAPS}}, @$typemaps;
}

sub _apply_BIN_DEPS {
    my ($params, $module, $seen) = @_;
    my $stop_sharing;
    $stop_sharing = 1 if $module =~ s/^-//;

    return if $seen->{$module}++;

    my ($installed_version, $failure) = binary_module_version($module);
    die "[XS::Install] binary dependency '$module' must be installed to proceed (details: $failure)\n"
        unless $installed_version;
    $params->{CONFIGURE_REQUIRES}{$module}  ||= $installed_version;
    $params->{PREREQ_PM}{$module}           ||= $installed_version;
    $params->{MODULE_INFO}{BIN_DEPS}{$module} = $installed_version;
    push @{$params->{MODULE_INFO}{VISIBLE_BIN_DEPS} ||= []}, $module unless $stop_sharing;

    my $info = XS::Install::Payload::binary_module_info($module)
        or die "[XS::Install] this module wants '$module' as a binary dependence, however '$module' doesn't provide any binary interface\n";

    # add so/dll to linker list
    my $shared_list = $params->{MODULE_INFO}{SHARED_LIBS};
    my $module_path = $module;
    $module_path =~ s#::#/#g;
    die "SHOULDN'T EVER HAPPEN" unless $module =~ /([^:]+)$/;
    my $module_last_name = $1;
    foreach my $dir (@INC) {
        my $lib_path = "$dir/auto/$module_path/";
        if ($info->{FILE}) {
            $lib_path .= $info->{FILE};
        } else { # DEPRECATED
            $lib_path .= $module_last_name.".".$Config{dlext};
        }

        next unless -f $lib_path;
        push @$shared_list, abs_path($lib_path);
        last;
    }

    if ($info->{INCLUDE}) {
        my $incdir = XS::Install::Payload::include_dir($module);
        _string_merge($params->{INC}, "-I$incdir");
    }

    _string_merge($params->{INC},       $info->{INC});
    _string_merge($params->{CCFLAGS},   $info->{CCFLAGS});
    _string_merge($params->{LDDLFLAGS}, $info->{LDDLFLAGS});
    _string_merge($params->{LINK},      $info->{LINK});
    _string_merge($params->{DEFINE},    $info->{DEFINE});
    _string_merge($params->{XSOPT},     $info->{XSOPT});

    _merge_libs($params, $info->{LIBS});

    if (my $passthrough = $info->{PASSTHROUGH}) {
        _apply_BIN_DEPS($params, $_, $seen) for @$passthrough;
    }

    if (my $typemaps = $info->{TYPEMAPS}) {
        my $tm_dir = XS::Install::Payload::typemap_dir($module);
        foreach my $typemap (@$typemaps) {
            my $tmfile = "$tm_dir/$typemap";
            $tmfile =~ s#[/\\]{2,}#/#g;
            push @{$params->{TYPEMAPS} ||= []}, $tmfile;
        }
    }

    $params->{CPLUS} = $info->{CPLUS} if $info->{CPLUS} and (!$params->{CPLUS} or $params->{CPLUS} < $info->{CPLUS});

    if (my $parsexs = $info->{PARSE_XS}) {
    	push @{$params->{PARSE_XS}||=[]}, @$parsexs;
    }
}

sub process_PARSE_XS { # inject ParseXS plugins into xsubpp
    my $params = shift;
    my $list = $params->{PARSE_XS};
    return unless @$list;
    _uniq_list($list);
    my $inc = join ' ', map { "-M$_" } @$list;
    push @{$params->{postamble}}, "XSUBPPRUN = \$(PERLRUN) -Ilib $inc \$(XSUBPP)";
}

sub process_binary {
    my $params = shift;

    $params->{XS}  ||= $params->{_XSTEST} ? [] : [_scan_files($xs_mask)];
    $params->{C}   ||= $params->{_XSTEST} ? [] : [_scan_files($c_mask)];

    canonize_array_split($params->{SRC});

    if (ref($params->{XS}) ne 'HASH') {
        canonize_array_files($params->{XS});
        $params->{XS} = { map {$_ => undef} @{$params->{XS}} };
    }

    my %xsi;
    foreach my $xsfile (keys %{$params->{XS}}, map { _scan_files($xs_mask, $_) } @{$params->{SRC}}) {
        my $cfile = $params->{XS}{$xsfile};
        my $suffix;
        unless ($cfile) {
            my $cext = $params->{CPLUS} ? 'cc' : 'c';
            if ($xsfile =~ /\.xs$/) {
                $cfile = $xsfile;
                $cfile =~ s/\.xs$/_xsgen.$cext/;
                $suffix = "_xsgen.$cext";
            } else {
                $cfile = "$xsfile.$cext";
            }
            $params->{XS}{$xsfile} = $cfile;
        }
        unless ($suffix) {
            $suffix = $cfile;
            $suffix =~ s/^[^.]+//;
        }

        my $xsi_deps = XS::Install::Deps::find_xsi_deps([$xsfile])->{$xsfile} || [];
        map { $xsi{$_} = $xsfile } @$xsi_deps;

        push @{$params->{postamble}}, "$cfile : $xsfile @$xsi_deps \$(FIRST_MAKEFILE)\n".
            "\t\$(XSUBPPRUN) \$(XSPROTOARG) \$(XSUBPPARGS) -csuffix $suffix \$(XSUBPP_EXTRA_ARGS) $xsfile > ${xsfile}c\n".
            "\t\$(MV) ${xsfile}c $cfile";
    }

    canonize_array_files($params->{C});
    push @{$params->{C}}, _scan_files($c_mask, $_) for @{$params->{SRC}};
    my @cdeps_list = (@{$params->{C}}, keys(%{$params->{XS}}), keys(%xsi));
    push @{$params->{C}}, values %{$params->{XS}};
    _uniq_list($params->{C});
    _uniq_list(\@cdeps_list);

    my $cdeps = XS::Install::Deps::find_header_deps({
        files   => \@cdeps_list,
        headers => ['./'],
        inc     => [map { s/^-I//; $_ } split(' ', $params->{MODULE_INFO}{ORIG}{INC})],
    });

    # push C to OBJECT and process C files header deps
    canonize_array_files($params->{OBJECT});
    foreach my $cfile (@{$params->{C}}) {
        my $ofile = c2obj_file($cfile);
        push @{$params->{OBJECT}}, $ofile;

        my $deps = delete $cdeps->{$cfile};
        push @{$params->{postamble}}, "$ofile : @$deps" if $deps && @$deps;
    }
    _uniq_list($params->{OBJECT});

    # process XS & XSI header deps
    foreach my $f (keys %xsi) {
        my $deps = delete $cdeps->{$f};
        next unless $deps && @$deps;
        push @{$cdeps->{$xsi{$f}} ||= []}, @$deps;
    }
    foreach my $xsfile (keys %{$params->{XS}}) {
        my $deps = delete $cdeps->{$xsfile};
        next unless $deps && @$deps;
        _uniq_list($deps);
        my $cfile = $params->{XS}{$xsfile};
        my $ofile = c2obj_file($cfile);
        push @{$params->{postamble}}, "$ofile : @$deps";
    }

    delete $params->{H}; # prevent MM from making O_FILES depend on all H_FILES

    $params->{clean}{FILES} .= ' $(O_FILES)';
}

sub process_CMAKE {
    my ($target, $params, $info) = @_;

    my $bdir = $info->{DIR}.'/build';
    my $pdir = $info->{DIR}.'/cmake_props';
    my $prefix = 'cmake_prefix';
    mkdir($bdir) unless -d $bdir;
    mkdir($pdir) unless -d $pdir;
    mkdir("$pdir/$prefix") unless -d "$pdir/$prefix";

    my $make = '$(MAKE)';
    $make = 'gmake' if $info->{GMAKE} and $native_bsd_make;

    my $cflags = $params->{INC};
    _string_merge($cflags, $params->{CCFLAGS});
    _string_merge($cflags, $params->{DEFINE});
    _string_merge($cflags, $params->{OPTIMIZE});

    _string_merge($info->{CMAKE_OPTIONS}, "-DCMAKE_INSTALL_PREFIX:PATH=$prefix");

    $params->{CMAKE_PARAMS} = {
        BUILD_DIR   => $bdir,
        PROP_DIR    => $pdir,
        MAIN_TARGET => $target,
        TARGETS => {
            $target     => "-fPIC $cflags",
        },
        OPTIONS => $info->{CMAKE_OPTIONS},
    };

    $info->{DIR} = $bdir;
    $info->{TARGET} = $target;
    $info->{FLAGS} ||= '';
    $info->{BUILD_CMD} = "cd ../cmake_props && $make $info->{FLAGS} $info->{TARGET}";
    $info->{CLEAN_CMD} = '';
    $info->{FORCE_TRACKING} = 1;

    $params->{clean}{FILES} .= " $bdir $pdir";

    push @{$params->{postamble}}, "cmake_install : dynamic\n".
        "\tcd $bdir && $make install \$(DEV_NULL)";

    my $cmake_share = run_cmake($params, $params->{CMAKE_PARAMS});
    $cmake_share->{CMAKE_TMP_INSTALL_DIR} = "$bdir/$prefix";
    apply_CMAKE($params, $cmake_share);
}

sub process_CLIB {
    my $params = shift;
    my $clibs = '';
    my $clib = delete $params->{CLIB} or return;
    $clib = [$clib] unless ref($clib) eq 'ARRAY';
    return unless @$clib;

    my $wa_open  = $mac ? '-Wl,-force_load' : '-Wl,--whole-archive';
    my $wa_close = $mac ? ''                : '-Wl,--no-whole-archive';

    foreach my $info (@$clib) {
        my $cmake_target = $info->{CMAKE_TARGET};
        if ($cmake_target) {
            process_CMAKE($cmake_target, $params, $info);
        }

        my $build_cmd = $info->{BUILD_CMD};
        my $clean_cmd = $info->{CLEAN_CMD};
        my $build_dep = $info->{BUILD_DEP};

        if (!$build_cmd and !$build_dep) {
            my $make = '$(MAKE)';
            $make = 'gmake' if $info->{GMAKE} and $native_bsd_make;
            $info->{TARGET} ||= '';
            $info->{FLAGS} ||= '';
            $build_cmd = "$make $info->{FLAGS} $info->{TARGET}";
            $clean_cmd = "$make clean";
        }
        $info->{FILE} = [$info->{FILE}] if exists $info->{FILE} && ref $info->{FILE} ne 'ARRAY';
        my $path = '';
        my $static = 0;
        for my $f (@{$info->{FILE} || []}) {
            next unless $f;
            $static = 1 if $f =~ /\.l?a$/;
            $path .= $info->{DIR}.'/'.$f.' ';
        }
        $clibs .= $path;

        my $force = $info->{FORCE_TRACKING} ? 'FORCE' : '';

        if ($build_dep) {
            push @{$params->{postamble}}, "$path : $force $build_dep;";
        } else {
            push @{$params->{postamble}}, "$path : $force; cd $info->{DIR} && $build_cmd\n";
        }

        push @{$params->{postamble}}, "clean :: ; cd $info->{DIR} && $clean_cmd\n" if $clean_cmd;

        if ($static) {
            push @{$params->{MODULE_INFO}{STATIC_LIBS}}, "$wa_open $path $wa_close";
        } else {
            push @{$params->{MODULE_INFO}{SHARED_LIBS}}, $path;
        }
    }
    push @{$params->{postamble}}, "\$(INST_DYNAMIC) : $clibs";
}

sub process_PKG_CONFIG {
    my $params = shift;
    canonize_array_split($params->{PKG_CONFIG});
    my $pkgs = $params->{PKG_CONFIG};

    my @bin_share_auto;
    for my $pkg (@$pkgs) {
        push @bin_share_auto, $pkg unless $pkg =~ s/^\s*-//;
    }

    set_pkg_config($params, $pkgs);

    my $bin_share = $params->{BIN_SHARE} or return;
    my $bin_share_pkgs = delete $bin_share->{PKG_CONFIG};
    canonize_array_split($bin_share_pkgs);
    set_pkg_config($bin_share, [@bin_share_auto, @$bin_share_pkgs]);
}

sub set_pkg_config {
    my ($params, $pkgs) = @_;
    return unless @$pkgs;
    require XS::Install::PkgConfigFixed;

    for my $pkg (@$pkgs) {
        my $res = PkgConfig->find($pkg);
        warn $res->errmsg if $res->errmsg;
        my @ccargs = $res->get_cflags;

        _string_merge($params->{INC},     join ' ', grep /^-I/,  @ccargs);
        _string_merge($params->{CCFLAGS}, join ' ', grep !/^-I/, @ccargs);
        _string_merge($params->{LINK},    scalar $res->get_ldflags);
    }
}

sub process_BIN_SHARE {
    my $params = shift;
    my $bin_share = delete $params->{BIN_SHARE} or return;
    return unless %$bin_share;
    return if $params->{_XSTEST};

    my $typemaps = delete($bin_share->{TYPEMAPS}) || {};
    _process_map($typemaps, $map_mask);
    _install($params, $typemaps, 'tm');
    $bin_share->{TYPEMAPS} = [values %$typemaps] if scalar keys %$typemaps;

    my $include = delete($bin_share->{INCLUDE}) || {};
    if ($include == 1) {
        $bin_share->{INCLUDE} = 1;
    } else {
        _process_map($include, $h_mask);
        _install($params, $include, 'i');
        $bin_share->{INCLUDE} = 1 if scalar(keys %$include);
    }

    $bin_share->{LIBS} = [$bin_share->{LIBS}] if $bin_share->{LIBS} and ref($bin_share->{LIBS}) ne 'ARRAY';

    if (my $list = $params->{MODULE_INFO}{BIN_DEPENDENT}) {
        $bin_share->{BIN_DEPENDENT} = $list if @$list;
    }

    if (my $vinfo = $params->{MODULE_INFO}{BIN_DEPS}) {
        $bin_share->{BIN_DEPS} = $vinfo if %$vinfo;
    }

    $bin_share->{PARSE_XS} = [$bin_share->{PARSE_XS}] if $bin_share->{PARSE_XS} and ref($bin_share->{PARSE_XS}) ne 'ARRAY';

    return unless %$bin_share;

    if (my $vbd = $params->{MODULE_INFO}{VISIBLE_BIN_DEPS}) {
        my $pt =
        _uniq_list($vbd);
        $bin_share->{PASSTHROUGH} = $vbd;
    }

    $bin_share->{LOADABLE} = has_binary($params);

    $bin_share->{CPLUS} //= $params->{CPLUS} if $params->{CPLUS};
    $bin_share->{FILE} = module_so_file($params);

    # generate info file
    mkdir 'blib';
    my $infopath = 'blib/info';
    XS::Install::Util::module_info_write($infopath, $bin_share);
    _install($params, {$infopath => 'info'}, '');
}

sub attach_BIN_DEPENDENT {
    my $params = shift;
    my @deps = keys %{$params->{MODULE_INFO}{BIN_DEPS} || {}};
    return unless @deps;

    push @{$params->{postamble}}, "sync_bin_deps:\n".
        "\t\$(PERL) -M${THIS_MODULE}::Util -e '${THIS_MODULE}::Util::cmd_sync_bin_deps()' $params->{NAME} @deps";
    push @{$params->{postamble}}, "install :: sync_bin_deps";
}

sub warn_BIN_DEPENDENT {
    my $params = shift;
    return unless $params->{VERSION_FROM};
    my $module = $params->{NAME};
    return if $module eq $THIS_MODULE;
    my $list = $params->{MODULE_INFO}{BIN_DEPENDENT} or return;
    return unless @$list;
    my ($installed_version, $failure) = binary_module_version($module);
    return unless $installed_version;
    my $new_version = MM->parse_version($params->{VERSION_FROM}) or return;
    return if $installed_version eq $new_version;
    warn << "EOF";
******************************************************************************
$THIS_MODULE: There are XS modules that binary depend on current XS module $module.
They were built with currently installed $module version $installed_version.
If you install $module version $new_version, you will have to reinstall all XS modules that binary depend on it:
cpanm -f @$list
******************************************************************************
EOF
}

sub process_SANITIZE {
    my $params = shift;
    my $mode = $ENV{SANITIZE} or return;

    my @preload;

    if ($mode =~ /a/i) {
        push @preload, _cc_get_so_path($params, 'libasan.so');
        _string_merge($params->{CCFLAGS}, '-fsanitize=address -fno-omit-frame-pointer');
        _string_merge($params->{LINK}, '-lasan');
    }

    if ($mode =~ /u/i) {
        push @preload, _cc_get_so_path($params, 'libubsan.so');
        _string_merge($params->{CCFLAGS}, '-fsanitize=undefined');
        _string_merge($params->{LINK}, '-lubsan');
    }

    @preload = grep {$_} @preload;

    if (@preload and !$win32) {
        my $preload = 'LD_PRELOAD='.join($win32 ? ';' : ':', @preload);
        push @{$params->{postamble}}, "ABSPERL = $preload \$(PERL)";
        push @{$params->{postamble}}, "PERLRUN = $preload \$(PERL)";
        push @{$params->{postamble}}, "FULLPERLRUN = $preload \$(FULLPERL)";
    }
}

sub _cc_get_so_path {
    my ($params, $so) = @_;
    my $cc = $params->{CC} || $Config{cc};
    my $file = `$cc -print-file-name=$so`;
    chomp($file);
    return if $file eq $so;
    return $file;
}

sub process_CPLUS {
    my $params = shift;
    my $use_cpp = $params->{CPLUS} or return;

    my $cppv = int($use_cpp);
    $cppv = 11 if $cppv < 11;
    _string_merge($params->{CCFLAGS}, "-std=c++$cppv");

    $params->{CC} = _get_cplusplus($params->{CC}, $cppv);
    $params->{LD} ||= '$(CC)';
    _string_merge($params->{XSOPT}, '-C++');

    # prevent C++ from compile errors on perls <= 5.18, as perl had buggy  prior to 5.20
    _string_merge($params->{CCFLAGS}, "-Wno-reserved-user-defined-literal -Wno-literal-suffix -Wno-unknown-warning-option") if $^V < v5.20;
}

sub process_CCFLAGS {
    my $params = shift;
    $params->{CCFLAGS} = string_merge($params->{CCFLAGS}, $Config{ccflags});
    _string_merge($params->{CCFLAGS}, '-Wno-unused-parameter') if $win32; # on Strawberry's mingw PERL_UNUSED_DECL doesn't work
}

sub fix_flags {
    my $params = shift;
    _string_merge($params->{CCFLAGS}, '-o $@');

    if ($params->{OPTIMIZE} =~ /(^|\s)-g(\s|$)/) { # remove stripping flag is debug enabled
        1 while $params->{OPTIMIZE} =~ s/(^|\s)-s(\s|$)/ /;
        $params->{OPTIMIZE} =~ s/\s+/ /g; $params->{OPTIMIZE} =~ s/^\s+//; $params->{OPTIMIZE} =~ s/\s+$//;
        1 while $params->{LDDLFLAGS} =~ s/(^|\s)-s(\s|$)/ /;
    }
}

sub process_LD {
    my $params = shift;

    $params->{LDFROM} ||= '$(OBJECT)';

    {
        my $str = join(' ', @{$params->{MODULE_INFO}{STATIC_LIBS}});
        $params->{LDFROM} .= ' '.$str if $str;
    }

    # MacOSX doesn't allow for linking with bundles :(
    # Linux/Unix does not need them, as .so-files will be loaded by perl
    if ($win32) {
        my %seen;
        my @shared_libs = grep {!$seen{$_}++} reverse @{$params->{MODULE_INFO}{SHARED_LIBS}};
        my $str = join(' ', @shared_libs);
        $params->{MODULE_INFO}{SHARED_LIBS_LINKING} = $str;
        $params->{LDFROM} .= ' '.$str if $str;
    }

    my $cfg_lddlflags = $Config{lddlflags};
    $params->{LDDLFLAGS} = string_merge($cfg_lddlflags, $params->{LDDLFLAGS}) if index($params->{LDDLFLAGS} || '', $cfg_lddlflags) == -1;
}

sub process_test {
    my $params = shift;
    my $tp = $params->{test} or return;
    return unless $tp->{SRC} or $tp->{XS} or $tp->{CLIB};

    canonize_array_split($tp->{$_}) for qw/TYPEMAPS BIN_DEPS/;

    my $array_merge = sub {
        my $a1 = shift || [];
        my $a2 = shift || [];
        return [@$a1, @$a2];
    };

    my $ldfrom = '$(OBJECT)';
    $ldfrom .= ' '.module_so($params) unless $mac; # MacOSX doesn't allow for linking with bundles :(

    my $test_module_name = $tp->{NAME} || 'MyTest';

    my %args = (
        NAME       => $test_module_name,
        VERSION    => $tp->{VERSION} || '0.0.0',
        ABSTRACT   => "test module",
        SRC        => $tp->{SRC},
        XS         => $tp->{XS},
        BIN_DEPS   => $array_merge->([keys %{$params->{MODULE_INFO}{BIN_DEPS}||{}}], $tp->{BIN_DEPS}),
        TYPEMAPS   => $array_merge->($params->{TYPEMAPS}, $tp->{TYPEMAPS}),
        CPLUS      => $tp->{CPLUS} // $params->{CPLUS},
        CC         => $tp->{CC} || $params->{CC},
        LD         => $tp->{LD} || $params->{LD},
        LDFROM     => $ldfrom,
        INC        => string_merge($params->{MODULE_INFO}{ORIG}{INC}, $tp->{INC}),
        CCFLAGS    => string_merge($params->{MODULE_INFO}{ORIG}{CCFLAGS}, $tp->{CCFLAGS}),
        DEFINE     => string_merge($params->{DEFINE}, $tp->{DEFINE}),
        LDDLFLAGS  => string_merge($params->{MODULE_INFO}{ORIG}{LDDLFLAGS}, $tp->{LDDLFLAGS}),
        LINK       => string_merge($params->{MODULE_INFO}{ORIG}{LINK}, $tp->{LINK}),
        XSOPT      => string_merge($params->{XSOPT}, $tp->{XSOPT}),
        PKG_CONFIG => $array_merge->($params->{PKG_CONFIG}, $tp->{PKG_CONFIG}),
        LIBS       => $params->{LIBS},
        CLIB       => $tp->{CLIB},
        MAKEFILE   => 'Makefile.test',
        OPTIMIZE   => merge_optimize($params->{OPTIMIZE}, "-O0", $tp->{OPTIMIZE}, $ENV{TEST_OPTIMIZE}),
        PARSE_XS   => $tp->{PARSE_XS} || $params->{PARSE_XS},
        NO_MYMETA  => 1,
        _XSTEST    => 1,
    );

    my $mm_args = makemaker_args(%args);
    return undef unless has_binary($mm_args) || $tp->{CLIB};

    push @{$params->{MODULE_INFO}{INSTALL_SKIP}}, "${test_module_name}[\\\\/]$test_module_name\\..+";

    my $make_params = '';
    $make_params .= ' --no-print-directory' if $linux;
    my $cmd = "\@\$(MAKE)$make_params -f Makefile.test";

    push @{$params->{postamble}},
        '# --- XS::Install tests compilation section',
        "ctest_object : ; $cmd object",
        "ctest_ld : ctest_object \$(INST_DYNAMIC); $cmd",
        'subdirs-test_dynamic :: ctest_object ctest_ld',
        'ctest :: ctest_object ctest_ld',
        "clean :: ; $cmd veryclean",
    ;

    # can't transfer requirements to only TEST_REQUIRES because on target machine "perl Makefile.PL" will run before they get installed,
    # and thus test's makemaker_args() will fail without binary dependency installed. We need to install it before Makefile.PL runs.
    if (my $prereq = $mm_args->{PREREQ_PM}) {
        my $creq = $params->{CONFIGURE_REQUIRES};
        my $treq = $params->{TEST_REQUIRES};
        foreach my $k (keys %$prereq) {
            next if $k eq $THIS_MODULE;
            $creq->{$k} //= $prereq->{$k};
            $treq->{$k} //= $prereq->{$k};
        }
    }

    return $mm_args;
}

sub process_test_makefile {
    my $params = shift;
    push @{$params->{postamble}}, 'object : $(OBJECT)';
}

sub process_cmake_test {
    my ($params, $cmake_params, $test) = @_;

    my $clibs = '';
    my $clib = $params->{test}{CLIB} or return $cmake_params;
    $clib = [$clib] unless ref($clib) eq 'ARRAY';
    return $cmake_params unless @$clib;

    my $cflags = $test->{INC} || '';
    _string_merge($cflags, $test->{CCFLAGS});
    _string_merge($cflags, $test->{DEFINE});
    _string_merge($cflags, $test->{OPTIMIZE});
    $cflags =~ s/-o \$@//;

    foreach my $info (@$clib) {
        my $cmake_target = $info->{CMAKE_TARGET};
        next unless ($cmake_target);

        $cmake_params->{TARGETS}{$cmake_target} = "-fPIC $cflags";
    }

    return $cmake_params;
}

sub run_cmake {
    my ($params, $cmake_params) = @_;

    my @options;
    while (my ($target, $opts) = each(%{$cmake_params->{TARGETS}})) {
        push @options, qq(-D${target}_COMP_OPTIONS="$opts");
    }

    my $targets = join(';', keys %{$cmake_params->{TARGETS}});
    push(@options, $cmake_params->{OPTIONS}) if $cmake_params->{OPTIONS};
    my $options = join(' ', @options);

    return XS::Install::CMake::configure($cmake_params->{BUILD_DIR}, $cmake_params->{PROP_DIR}, $cmake_params->{MAIN_TARGET}, qq(-DCONF_TARGETS="$targets" $options));
}

sub apply_CMAKE {
    my ($params, $props) = @_;
    my $bs = $params->{BIN_SHARE};
    my $cmake = $props->{CMAKE_BIN};
    my $make = '$(MAKE)';
    $params->{INC} ||= '';
    my $make_copy = "cmake_inc_copy :: cmake_install\n";
    for my $i (@{$props->{INSTALL_INCLUDE}}) {
        $bs->{INCLUDE} //= 1;
        $make_copy .= "\t$cmake -E copy_directory $props->{CMAKE_TMP_INSTALL_DIR}/$i \$(INST_ARCHLIB)/\$(FULLEXT).x/i/\n";
    }
    for my $i (@{$props->{BUILD_INCLUDE}}) {
        _string_merge($params->{INC}, "-I$i");
        _string_merge($params->{MODULE_INFO}{ORIG}{INC}, "-I$i");
        _string_merge($params->{test}{INC}, "-I$i") if $params->{test};
    }
    _uniq_list($props->{INC});
    my @incs = map {"-I$_"} @{$props->{INC}};
    _string_merge($params->{INC}, @incs);
    _string_merge($params->{MODULE_INFO}{ORIG}{INC}, @incs);
    _string_merge($params->{test}{INC}, @incs) if $params->{test};

    if ($bs) {
        _string_merge($bs->{CCFLAGS}, @{$props->{CCFLAGS}});
        _string_merge($bs->{DEFINE},  @{$props->{DEFINE}});
        _string_merge($bs->{INC},     @incs);
        _string_merge($bs->{LINK},    @{$props->{LIBS}});
    }

    $params->{CCFLAGS} = string_merge($params->{CCFLAGS}, @{$props->{CCFLAGS}});
    $params->{DEFINE}  = string_merge($params->{DEFINE}, @{$props->{DEFINE}});
    $params->{LINK}    = string_merge($params->{LINK}, @{$props->{LIBS}});

    push @{$params->{postamble}}, $make_copy;
    push @{$params->{postamble}}, "pm_to_blib : cmake_inc_copy";
}

sub process_INSTALL_SKIP {
    my $params = shift;
    my $list = $params->{MODULE_INFO}{INSTALL_SKIP};
    return unless $list && @$list;
    my %hash = map {$_ => 1} @$list;
    my $file = "INSTALL.SKIP";
    my $lastc;
    if (open my $fh, '<', $file) {
        my @lines = <$fh>;
        $lastc = substr($lines[-1], -1, 1) if @lines;
        map {chomp} @lines;
        delete $hash{$_} for @lines;
        close $fh;
    }
    return unless %hash;
    if (open my $fh, '>>', $file) {
        print $fh "\n" if defined($lastc) && $lastc ne "\n" && $lastc ne "\r";
        print $fh join("\n", keys %hash);
        print $fh "\n";
        close $fh;
    }
}

sub post_process {
    my $params = shift;
    my $postamble = $params->{postamble};
    my $mi = $params->{MODULE_INFO};

    if  (my $link = $params->{LINK}) {
        my $dl = $params->{dynamic_lib} ||= {};
        _string_merge($dl->{OTHERLDFLAGS}, $link);
        $dl->{OTHERLDFLAGS} = _uniq_link($dl->{OTHERLDFLAGS});
    }

    delete @$params{qw/C H OBJECT XS CCFLAGS LDFROM OPTIMIZE XSOPT/} unless has_binary($params);
    delete @$params{qw/CPLUS PARSE_XS SRC MODULE_INFO _XSTEST CMAKE_PARAMS PKG_CONFIG LINK/};

    # convert array to hash for postamble
    $params->{postamble} = {};
    my $i = 0;
    $params->{postamble}{++$i} = $_ for @$postamble;
}

sub _merge_libs {
    my ($params, $add_libs) = @_;
    return unless $add_libs and @$add_libs;
    my $libs = $params->{LIBS} || [];
    $libs = [$libs] unless ref($libs) eq 'ARRAY';
    if ($libs and @$libs) {
        my @result;
        foreach my $l1 (@$libs) {
            foreach my $l2 (@$add_libs) {
                push @result, $l2 ? "$l1 $l2" : $l1;
            }
        }
        $params->{LIBS} = \@result;
    }
    else {
        $params->{LIBS} = $add_libs;
    }
}

sub canonize_array {
    if    (!$_[0])                { $_[0] = [] }
    elsif (ref($_[0]) ne 'ARRAY') { $_[0] = [$_[0]] }
}

sub canonize_array_split {
    canonize_array($_[0]);
    @{$_[0]} = map { split ' ' } @{$_[0]};
}

sub canonize_array_files {
    canonize_array_split($_[0]);
    @{$_[0]} = map { glob } @{$_[0]};
}

# returns version of binary module which was installed with XS::Install without loading it
sub binary_module_version {
    my $module = shift;
    # user might use his own module for it's Makefile.PL (very rare case but possible, for example this module does it)
    # to avoid finding it, and find only installed pm, we must se if it has data dir (Module.x) in the same folder
    # so we will just find the data folder and get the pm from there
    my $ddir = XS::Install::Payload::data_dir($module) or return (0, "data dir for $module not found");
    my $pm = $ddir;
    $pm =~ s#\.x$#.pm#;
    return (0, "no $pm found") unless -f $pm;
    my $version = MM->parse_version($pm);
    return (0, "version from $pm cannot be parsed") unless $version;
    return ($version, undef);
}

sub has_c      { return $_[0]->{C} && scalar(@{$_[0]->{C}}) ? 1 : 0 }
sub has_object { return $_[0]->{OBJECT} && scalar(@{$_[0]->{OBJECT}}) ? 1 : 0 }
sub has_xs     { return $_[0]->{XS} && scalar(keys %{$_[0]->{XS}}) ? 1 : 0 }
sub has_ext    { return $_[0]->{MODULE_INFO} && $_[0]->{MODULE_INFO}{STATIC_LIBS} && scalar(@{$_[0]->{MODULE_INFO}{STATIC_LIBS}}) ? 1 : 0 }
sub has_binary { return has_c($_[0]) || has_object($_[0]) || has_xs($_[0]) || has_ext($_[0]) }

sub merge_optimize {
    my $to = shift;
    $to ||= '';
    my @singleton = (qr/-O[0-9]/, qr/-g[0-9]?/);
    foreach my $from (@_) {
        next unless $from;
        foreach my $tok (split ' ', $from) {
            foreach my $qr (@singleton) {
                next unless $tok =~ /^$qr$/;
                $to =~ s/(^|\s)$qr(\s|$)/ /g;
            }
            $to .= " $tok";
        }
    }
    $to =~ s/^\s+//;
    $to =~ s/\s+$//;
    $to =~ s/\s{2,}/ /g;
    return $to;
}

sub _install {
    my ($params, $map, $path) = @_;
    return unless %$map;
    my $instroot = _instroot($params);
    my $pm = $params->{PM} ||= {};
    while (my ($source, $dest) = each %$map) {
        my $instpath = "$instroot/\$(FULLEXT).x/$path/$dest";
        $instpath =~ s#[/\\]{2,}#/#g;
        $pm->{$source} = $instpath;
    }
}

sub _instroot { return has_binary($_[0]) ? '$(INST_ARCHLIB)' : '$(INST_LIB)' }

sub module_so {
    my $params = shift;
    return undef unless has_binary($params);
    return _instroot($params).'/auto/'._pkg_slash($params->{NAME}).'/'.module_so_file($params);
}

sub module_so_file {
    my $params = shift;
    return undef unless has_binary($params);
    my @modparts = split(/::/, $params->{NAME});
    my $modfname = $modparts[-1];
    $modfname = DynaLoader::mod2fname(\@modparts) if defined &DynaLoader::mod2fname;
    return $modfname.'.'.($params->{DLEXT} || $Config{dlext});
}

sub _sync {
    no strict 'refs';
    my $from = 'MYSOURCE';
    my $to = 'MY';
    foreach my $method (keys %{"${from}::"}) {
        next unless defined &{"${from}::$method"};
        *{"${to}::$method"} = \&{"${from}::$method"};
    }
}

sub _scan_files {
    my ($mask, $dir) = @_;
    return grep {_is_file_ok($_)} glob($mask) unless $dir;

    my @list = grep {_is_file_ok($_)} glob(join(' ', map {"$dir/$_"} split(' ', $mask)));

    opendir(my $dh, $dir) or die "Could not open dir '$dir' for scanning: $!";
    while (my $entry = readdir $dh) {
        next if $entry =~ /^\./;
        my $path = "$dir/$entry";
        next unless -d $path;
        push @list, _scan_files($mask, $path);
    }
    closedir $dh;

    return @list;
}

sub _is_file_ok {
    my $file = shift;
    return unless -f $file;
    return if $file =~ /\#/;
    return if $file =~ /~$/;             # emacs temp files
    return if $file =~ /,v$/;            # RCS files
    return if $file =~ m{\.swp$};        # vim swap files
    return 1;
}

sub _process_map {
    my ($map, $mask) = @_;
    foreach my $source (keys %$map) {
        my $dest = $map->{$source} || $source;
        if (-f $source) {
            $dest .= $source if $dest =~ m#[/\\]$#;
            $dest =~ s#[/\\]{2,}#/#g;
            $dest =~ s#^[/\\]+##;
            $map->{$source} = $dest;
            next;
        }
        next unless -d $source;

        delete $map->{$source};
        my @files = _scan_files($mask, $source);
        foreach my $file (@files) {
            my $dest_file = $file;
            $dest_file =~ s/^$source//;
            $dest_file = "$dest/$dest_file";
            $dest_file =~ s#[/\\]{2,}#/#g;
            $dest_file =~ s#^[/\\]+##;
            $map->{$file} = $dest_file;
        }
    }
}

sub _uniq_list {
	my $list = shift;
	my %uniq;
	@$list = grep { !$uniq{$_}++ } @$list;
}

sub _string_merge {
    return unless $_[1];
    $_[0] ||= '';
    $_[0] .= $_[0] ? " $_[1]" : $_[1];
}

sub string_merge {
    my $s = shift;
    $s //= '';
    for my $val (@_) {
        next unless defined($val) && length($val);
        if (!$s) { $s = $val }
        else { $s .= " $val"; }
    }
    return $s;
}

sub c2obj_file {
    my $file = shift;
    $file =~ s/\.[^.]+$//;
    return $file.'$(OBJ_EXT)';
}

{
    package
        MY;
    use Config;

    my $gcc_compliant = $Config{cc} =~ /\b(gcc|clang)\b/i ? 1 : 0;

    sub init_methods {
        no warnings 'redefine';

        # change "subdirs-test*" rule type from "::" to ":" as GNU make has a bug and can't do its deps in parallel
        sub _fix_subdirs {
            my $s = shift;
            $s =~ s/^((subdirs-test(?:_dynamic|_static)?\s*)+)::/$1:/mg;
            return $s;
        }

        *postamble = sub {
            my $self = shift;
            my %args = @_;

            my @list;
            my $i = 1;
            while (1) {
                last unless exists $args{$i};
                push @list, $args{$i};
                ++$i;
            }

            return _fix_subdirs(join("\n\n", @list));
        };

        *test = sub { return _fix_subdirs(shift->SUPER::test(@_)) };

        if ($fix_bsd_make_j) { # bsd's make has a bug: wrong value of $* when building in parallel, we use $< instead
            *c_o = sub {
                my $self = shift;
                my $ret = $self->SUPER::c_o(@_);
                $ret =~ s/\$\*\.c(c|pp|xx)?[ \t]*$/\$
                return $ret;
            };
        }

        if ($win32) {
            *dynamic_lib = sub {
                my ($self, %attribs) = @_;
                my $code = $self->SUPER::dynamic_lib(%attribs);

                unless ($gcc_compliant) {
                    warn(
                        "$THIS_MODULE: to maintain UNIX-like shared library behaviour on windows (export all symbols by default), we need gcc-compliant linker. ".
                        "$THIS_MODULE-dependant modules should only be installed on perls with MinGW shell (like strawberry perl), or at least having gcc compiler. ".
                        "I will continue, but this module's binary dependencies may not work."
                    );
                    return $code;
                }
                return $code unless $code;

                # remove .def-related from code, remove double DLL build, remove dll.exp from params, add export all symbols param.
                my $DLLTOOL = $Config{dlltool} || 'dlltool';
                my (@out, $last_ld);
                map { $last_ld = $_ if /\$\(LD\)\s/ } split /\n/, $code;
                foreach my $line (split /\n/, $code) {
                    next if $line =~ /$DLLTOOL/; # drop dlltool calls (we dont need .def file)
                    if ($line =~ /\$\(LD\)\s/) {
                        next if $line ne $last_ld;
                        $line =~ s/\$\(LD\)\s/\$(LD) -Wl,--export-all-symbols /;
                        $line =~ s/\bdll\.exp\b//;
                    }
                    $line =~ s/\$\(EXPORT_LIST\)//g; # remove .def from target dependency
                    push @out, $line;
                }

                $code = join("\n", @out);
                return $code;
            };

            *dlsyms = sub {
                my ($self, %attribs) = @_;
                return '' if $gcc_compliant; # our dynamic_lib target doesn't need any .def files with gcc
                return $self->SUPER::dlsyms(%attribs);
            };
        };
    }
}

sub _require_makemaker {
    unless ($INC{'ExtUtils/MakeMaker.pm'}) {
        require ExtUtils::MakeMaker;
        ExtUtils::MakeMaker->import();
    }
}

sub not_available {
    my $msg = shift;
    die "OS unsupported: $msg\n";
}

sub _get_cplusplus {
    my ($cpp, $minstd) = @_;
    $cpp ||= 'c++'; # exists on most platforms/compilers

    # check compiler existance
    my $v_out = `$cpp -v 2>&1`;
    not_available("C++ compiler not available") unless defined $v_out;

    #check if C++ compiler supports -std=XXX
    mkdir 'tmp';
    my $tmpfile = 'tmp/__xs_install_check_cpp.cc';
    my $outfile = 'tmp/__xs_install_check_cpp.out';
    if (open my $fh, '>', $tmpfile) {
        print $fh "int main () { return 0; }\n";
        close $fh;
        unlink $outfile;
        `$cpp -c -std=c++$minstd -o $outfile $tmpfile 2>&1`;
        my $success = -f $outfile;
        unlink $tmpfile, $outfile;
        rmdir 'tmp';
        not_available("C++ compiler does not support -std=c++$minstd") unless $success;
    }

    #check exceptions
    not_available(
        "SJLJ compiler detected\n".
        "***************************************************************\n".
        "You are using c++ compiler with SJLJ exceptions enabled.\n".
        "It makes it impossible to use C++ exceptions and perl together.\n".
        "You need to use compiler with DWARF2 or SEH exceptions configured.\n".
        "If you are using Strawberry Perl, install Strawberry 5.26 or higher\n".
        "where they use mingw with SEH exceptions.\n".
        "***************************************************************"
    ) if $v_out =~ /--enable-sjlj-exceptions/;

    return $cpp;
}

sub _pkg_slash {
    my $pkg = shift;
    $pkg =~ s#::#/#g;
    return $pkg;
}

sub _pkg_last {
    my $pkg = shift;
    return unless $pkg =~ /([^:]+)$/;
    return $1;
}

sub _pkg_file { return _pkg_slash(shift).'.pm'  }

sub _split_path_args {
    my $str = shift;

    my $simple_arg  = qr/[^"' \t]+/;
    my $dquoted_arg = qr/"([^"]+|\\")*"/;
    my $quoted_arg  = qr/'([^']+|\\')*'/;

    my @args;
    push @args, $1 while $str =~ s/^\s*($simple_arg|$dquoted_arg|$quoted_arg)(\s+|$)//g;

    return @args;
}

sub _uniq_link {
    my $link = shift;
    my @args = _split_path_args($link);
    my %uniq;
    @args = grep { !$uniq{$_}++ } @args;
    return join ' ', @args;
}

1;