This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Perldelta for 22a3069
[perl5.git] / cpan / ExtUtils-CBuilder / lib / ExtUtils / CBuilder / Base.pm
CommitLineData
6b09c160
YST
1package ExtUtils::CBuilder::Base;
2
3use strict;
4use File::Spec;
5use File::Basename;
8a6e5c04 6use Cwd ();
6b09c160
YST
7use Config;
8use Text::ParseWords;
c3fb68a3 9use IO::File;
6b09c160
YST
10
11use vars qw($VERSION);
0425eb33 12$VERSION = '0.2703_01';
6b09c160
YST
13
14sub new {
15 my $class = shift;
16 my $self = bless {@_}, $class;
17
18 $self->{properties}{perl} = $class->find_perl_interpreter
19 or warn "Warning: Can't locate your perl binary";
20
21 while (my ($k,$v) = each %Config) {
22 $self->{config}{$k} = $v unless exists $self->{config}{$k};
23 }
506098d4 24 $self->{config}{cc} = $ENV{CC} if exists $ENV{CC};
6b09c160
YST
25 return $self;
26}
27
28sub find_perl_interpreter {
29 my $perl;
30 File::Spec->file_name_is_absolute($perl = $^X)
31 or -f ($perl = $Config::Config{perlpath})
32 or ($perl = $^X);
33 return $perl;
34}
35
36sub add_to_cleanup {
37 my $self = shift;
da2b6f33
SH
38 foreach (@_) {
39 $self->{files_to_clean}{$_} = 1;
40 }
41}
42
43sub cleanup {
44 my $self = shift;
45 foreach my $file (keys %{$self->{files_to_clean}}) {
46 unlink $file;
47 }
6b09c160
YST
48}
49
50sub object_file {
51 my ($self, $filename) = @_;
52
53 # File name, minus the suffix
54 (my $file_base = $filename) =~ s/\.[^.]+$//;
55 return "$file_base$self->{config}{obj_ext}";
56}
57
58sub arg_include_dirs {
59 my $self = shift;
60 return map {"-I$_"} @_;
61}
62
63sub arg_nolink { '-c' }
64
65sub arg_object_file {
66 my ($self, $file) = @_;
67 return ('-o', $file);
68}
69
70sub arg_share_object_file {
71 my ($self, $file) = @_;
72 return ($self->split_like_shell($self->{config}{lddlflags}), '-o', $file);
73}
74
75sub arg_exec_file {
76 my ($self, $file) = @_;
77 return ('-o', $file);
78}
79
d1cf867f
SP
80sub arg_defines {
81 my ($self, %args) = @_;
82 return map "-D$_=$args{$_}", keys %args;
83}
84
6b09c160
YST
85sub compile {
86 my ($self, %args) = @_;
87 die "Missing 'source' argument to compile()" unless defined $args{source};
88
89 my $cf = $self->{config}; # For convenience
90
91 $args{object_file} ||= $self->object_file($args{source});
7b0eef92
CBW
92
93 $args{include_dirs} = [ $args{include_dirs} ]
94 if exists($args{include_dirs}) && ref($args{include_dirs}) ne "ARRAY";
95
6b09c160
YST
96 my @include_dirs = $self->arg_include_dirs
97 (@{$args{include_dirs} || []},
98 $self->perl_inc());
99
d1cf867f
SP
100 my @defines = $self->arg_defines( %{$args{defines} || {}} );
101
6b09c160
YST
102 my @extra_compiler_flags = $self->split_like_shell($args{extra_compiler_flags});
103 my @cccdlflags = $self->split_like_shell($cf->{cccdlflags});
104 my @ccflags = $self->split_like_shell($cf->{ccflags});
506098d4 105 push @ccflags, qw/-x c++/ if $args{'C++'};
6b09c160 106 my @optimize = $self->split_like_shell($cf->{optimize});
d1cf867f 107 my @flags = (@include_dirs, @defines, @cccdlflags, @extra_compiler_flags,
6b09c160
YST
108 $self->arg_nolink,
109 @ccflags, @optimize,
110 $self->arg_object_file($args{object_file}),
111 );
112
113 my @cc = $self->split_like_shell($cf->{cc});
114
115 $self->do_system(@cc, @flags, $args{source})
116 or die "error building $args{object_file} from '$args{source}'";
117
118 return $args{object_file};
119}
120
121sub have_compiler {
506098d4 122 my ($self, $is_cplusplus) = @_;
6b09c160 123 return $self->{have_compiler} if defined $self->{have_compiler};
6b09c160 124
9015f106
DG
125 my $result;
126 my $attempts = 3;
127 # tmpdir has issues for some people so fall back to current dir
128 DIR: for my $dir ( File::Spec->tmpdir, '.' ) {
129
130 # don't clobber existing files (rare, but possible)
131 my $rand = int(rand(2**31));
132 my $tmpfile = File::Spec->catfile($dir, "compilet-$rand.c");
506098d4 133 $tmpfile .= "c" if $is_cplusplus;
9015f106
DG
134 if ( -e $tmpfile ) {
135 redo DIR if $attempts--;
136 next DIR;
137 }
138
139 {
140 my $FH = IO::File->new("> $tmpfile") or die "Can't create $tmpfile: $!";
506098d4
DG
141 if ( $is_cplusplus ) {
142 print $FH "class Bogus { public: int boot_compilet() { return 1; } };\n";
143 }
144 else {
145 print $FH "int boot_compilet() { return 1; }\n";
146 }
9015f106
DG
147 }
148
149 my ($obj_file, @lib_files);
150 eval {
151 local $^W = 0;
506098d4
DG
152 local $self->{quiet} = 1;
153 $obj_file = $self->compile('C++' => $is_cplusplus, source => $tmpfile);
9015f106
DG
154 @lib_files = $self->link(objects => $obj_file, module_name => 'compilet');
155 };
156 $result = $@ ? 0 : 1;
157
158 foreach (grep defined, $tmpfile, $obj_file, @lib_files) {
159 1 while unlink;
160 }
161 last DIR if $result;
6b09c160 162 }
9015f106
DG
163
164 return $self->{have_compiler} = $result;
6b09c160
YST
165}
166
506098d4
DG
167sub have_cplusplus {
168 push @_, 1;
169 goto &have_compiler;
170}
171
6b09c160
YST
172sub lib_file {
173 my ($self, $dl_file) = @_;
174 $dl_file =~ s/\.[^.]+$//;
175 $dl_file =~ tr/"//d;
176 return "$dl_file.$self->{config}{dlext}";
177}
178
179
180sub exe_file {
181 my ($self, $dl_file) = @_;
182 $dl_file =~ s/\.[^.]+$//;
183 $dl_file =~ tr/"//d;
184 return "$dl_file$self->{config}{_exe}";
185}
186
187sub need_prelink { 0 }
188
d1cf867f
SP
189sub extra_link_args_after_prelink { return }
190
6b09c160
YST
191sub prelink {
192 my ($self, %args) = @_;
193
194 ($args{dl_file} = $args{dl_name}) =~ s/.*::// unless $args{dl_file};
195
196 require ExtUtils::Mksymlists;
197 ExtUtils::Mksymlists::Mksymlists( # dl. abbrev for dynamic library
198 DL_VARS => $args{dl_vars} || [],
199 DL_FUNCS => $args{dl_funcs} || {},
200 FUNCLIST => $args{dl_func_list} || [],
201 IMPORTS => $args{dl_imports} || {},
3fa7b0d2
RGS
202 NAME => $args{dl_name}, # Name of the Perl module
203 DLBASE => $args{dl_base}, # Basename of DLL file
204 FILE => $args{dl_file}, # Dir + Basename of symlist file
d1cf867f 205 VERSION => (defined $args{dl_version} ? $args{dl_version} : '0.0'),
6b09c160
YST
206 );
207
208 # Mksymlists will create one of these files
209 return grep -e, map "$args{dl_file}.$_", qw(ext def opt);
210}
211
212sub link {
213 my ($self, %args) = @_;
214 return $self->_do_link('lib_file', lddl => 1, %args);
215}
216
217sub link_executable {
218 my ($self, %args) = @_;
219 return $self->_do_link('exe_file', lddl => 0, %args);
220}
2bd31f1a 221
6b09c160
YST
222sub _do_link {
223 my ($self, $type, %args) = @_;
224
225 my $cf = $self->{config}; # For convenience
226
227 my $objects = delete $args{objects};
228 $objects = [$objects] unless ref $objects;
229 my $out = $args{$type} || $self->$type($objects->[0]);
230
231 my @temp_files;
232 @temp_files =
233 $self->prelink(%args,
345dbb93 234 dl_name => $args{module_name}) if $args{lddl} && $self->need_prelink;
6b09c160 235
d1cf867f
SP
236 my @linker_flags = ($self->split_like_shell($args{extra_linker_flags}),
237 $self->extra_link_args_after_prelink(%args, dl_name => $args{module_name},
238 prelink_res => \@temp_files));
239
6b09c160
YST
240 my @output = $args{lddl} ? $self->arg_share_object_file($out) : $self->arg_exec_file($out);
241 my @shrp = $self->split_like_shell($cf->{shrpenv});
242 my @ld = $self->split_like_shell($cf->{ld});
2bd31f1a 243
6b09c160
YST
244 $self->do_system(@shrp, @ld, @output, @$objects, @linker_flags)
245 or die "error building $out from @$objects";
246
247 return wantarray ? ($out, @temp_files) : $out;
248}
249
250
251sub do_system {
252 my ($self, @cmd) = @_;
253 print "@cmd\n" if !$self->{quiet};
254 return !system(@cmd);
255}
256
257sub split_like_shell {
258 my ($self, $string) = @_;
259
260 return () unless defined($string);
261 return @$string if UNIVERSAL::isa($string, 'ARRAY');
262 $string =~ s/^\s+|\s+$//g;
263 return () unless length($string);
264
265 return Text::ParseWords::shellwords($string);
266}
267
268# if building perl, perl's main source directory
269sub perl_src {
270 # N.B. makemaker actually searches regardless of PERL_CORE, but
271 # only squawks at not finding it if PERL_CORE is set
272
345dbb93
RGS
273 return unless $ENV{PERL_CORE};
274
ea2e6518
RGS
275 my $Updir = File::Spec->updir;
276 my $dir = File::Spec->curdir;
345dbb93
RGS
277
278 # Try up to 5 levels upwards
33d1b122 279 for (0..10) {
345dbb93
RGS
280 if (
281 -f File::Spec->catfile($dir,"config_h.SH")
282 &&
283 -f File::Spec->catfile($dir,"perl.h")
284 &&
285 -f File::Spec->catfile($dir,"lib","Exporter.pm")
286 ) {
8a6e5c04 287 return Cwd::realpath( $dir );
6b09c160
YST
288 }
289
345dbb93 290 $dir = File::Spec->catdir($dir, $Updir);
6b09c160 291 }
ea2e6518 292
345dbb93 293 warn "PERL_CORE is set but I can't find your perl source!\n";
ea2e6518 294 return ''; # return empty string if $ENV{PERL_CORE} but can't find dir ???
6b09c160
YST
295}
296
297# directory of perl's include files
298sub perl_inc {
299 my $self = shift;
300
301 $self->perl_src() || File::Spec->catdir($self->{config}{archlibexp},"CORE");
302}
303
da2b6f33
SH
304sub DESTROY {
305 my $self = shift;
8a6e5c04 306 local($., $@, $!, $^E, $?);
da2b6f33
SH
307 $self->cleanup();
308}
309
6b09c160 3101;