The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

LEONT / Dist-Build-0.019 / lib / Dist / Build / XS / Export.pm 

            

              
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

              
package Dist::Build::XS::Export;
$Dist::Build::XS::Export::VERSION = '0.019';
use strict;
use warnings;
use parent 'ExtUtils::Builder::Planner::Extension';
use Carp 'croak';
use ExtUtils::Builder::Util qw/unix_to_native_path/;
use File::Find 'find';
use File::Spec::Functions qw/abs2rel catfile/;
use Parse::CPAN::Meta;
my $json_backend = Parse::CPAN::Meta->json_backend;
my $json = $json_backend->new->canonical->pretty->utf8;
my @allowed_flags = qw/include_dirs defines library_dirs libraries extra_compiler_flags extra_linker_flags/;
my %allowed_flag = map { $_ => 1 } @allowed_flags;
sub copy_header {
        my ($planner, $module_dir, $filename, $target) = @_;
        my $output = catfile(qw/blib lib auto share module/, $module_dir, 'include', $target);
        return $planner->copy_file(abs2rel($filename), $output);
}
sub add_methods {
        my ($self, $planner) = @_;
        $planner->add_delegate('export_headers', sub {
                my ($self, %args) = @_;
                my $module_name = $args{module} // $planner->main_module;
                (my $module_dir = $module_name) =~ s/::/-/g;
                croak 'No directory or file given to share' if not $args{dir} and not $args{file};
                my $inner = $planner->new_scope;
                $inner->load_extension('Dist::Build::Core');
                $inner->create_subst(
                        on     => $inner->create_pattern(dir => $args{dir}),
                        add_to => 'code',
                        subst  => sub {
                                my ($source) = @_;
                                my $target = abs2rel($source, $args{dir});
                                return copy_header($inner, $module_dir, $source, $target);
                        },
                );
                my @files = ref $args{file} ? @{ $args{file} } : defined $args{file} ? $args{file} : ();
                for my $file (@files) {
                        $planner->create_phony('code', copy_header($inner, $module_dir, $file, $file));
                }
        });
        $planner->add_delegate('export_flags', sub {
                my ($self, %args) = @_;
                my %flags = map { $_ => $args{$_} } grep { $allowed_flag{$_} } keys %args;
                my $module_name = $args{module} // $planner->main_module;
                (my $module_dir = $module_name) =~ s/::/-/g;
                my $filename = catfile(qw/blib lib auto share module/, $module_dir, 'compile.json');
                my $inner = $planner->new_scope;
                $inner->load_extension('Dist::Build::Core');
                $inner->dump_json($filename, \%flags);
                return $planner->create_phony('code', $filename);
        });
}
1;
# ABSTRACT: Dist::Build extension to export headers for other XS modules
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Build::XS::Export - Dist::Build extension to export headers for other XS modules
=head1 VERSION
version 0.019
=head1 SYNOPSIS
 load_extension('Dist::Build::XS::Export');
 export_headers(
     module => 'Foo::Bar',
     dir    => 'include',
 );
=head1 DESCRIPTION
This C<Dist::Build> extension will export headers for your module, so they can be used by other modules using C<Dist::Build::Import>.
=head1 METHODS
=head2 export_headers
This copies the given header for the appropriate module to the approriate sharedir.
=over 4
=item * module
The name of the module to export. This defaults to the main module.
=item * dir
The directory to export (e.g. C<'include'>).
=item * file
A file (or a list of files) to export (e.g. C<'foo.h'>).
=back
At least one of C<dir> and C<file> must be defined. Note that this function can be called multiple times (e.g. for multiple modules).
=head2 export_flags
This stores the given flags for the module in the appropriate sharedir. The module can be set using the C<module> named argument but will default to the main module of the dist. The C<include_dirs>, C<defines>, C<extra_compiler_flags>, C<libraries>, C<library_dirs>, C<extra_linker_flags> arguments are all stored as-is.
=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