This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
bump ExtUtils-CBuilder version for blead change
[perl5.git] / dist / 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;
06e8058f
CBW
10use Data::Dumper;$Data::Dumper::Indent=1;
11use IPC::Cmd qw(can_run);
12use File::Temp qw(tempfile);
6b09c160
YST
13
14use vars qw($VERSION);
ed6b886e 15$VERSION = '0.280201';
06e8058f
CBW
16
17# More details about C/C++ compilers:
18# http://developers.sun.com/sunstudio/documentation/product/compiler.jsp
19# http://gcc.gnu.org/
20# http://publib.boulder.ibm.com/infocenter/comphelp/v101v121/index.jsp
21# http://msdn.microsoft.com/en-us/vstudio/default.aspx
22
23my %cc2cxx = (
24 # first line order is important to support wrappers like in pkgsrc
25 cc => [ 'c++', 'CC', 'aCC', 'cxx', ], # Sun Studio, HP ANSI C/C++ Compilers
26 gcc => [ 'g++' ], # GNU Compiler Collection
27 xlc => [ 'xlC' ], # IBM C/C++ Set, xlc without thread-safety
28 xlc_r => [ 'xlC_r' ], # IBM C/C++ Set, xlc with thread-safety
29 cl => [ 'cl' ], # Microsoft Visual Studio
30);
6b09c160
YST
31
32sub new {
33 my $class = shift;
34 my $self = bless {@_}, $class;
35
36 $self->{properties}{perl} = $class->find_perl_interpreter
37 or warn "Warning: Can't locate your perl binary";
38
39 while (my ($k,$v) = each %Config) {
40 $self->{config}{$k} = $v unless exists $self->{config}{$k};
41 }
06e8058f
CBW
42 $self->{config}{cc} = $ENV{CC} if defined $ENV{CC};
43 $self->{config}{ccflags} = $ENV{CFLAGS} if defined $ENV{CFLAGS};
44 $self->{config}{cxx} = $ENV{CXX} if defined $ENV{CXX};
45 $self->{config}{cxxflags} = $ENV{CXXFLAGS} if defined $ENV{CXXFLAGS};
46 $self->{config}{ld} = $ENV{LD} if defined $ENV{LD};
47 $self->{config}{ldflags} = $ENV{LDFLAGS} if defined $ENV{LDFLAGS};
48
49 unless ( exists $self->{config}{cxx} ) {
50 my ($ccpath, $ccbase, $ccsfx ) = fileparse($self->{config}{cc}, qr/\.[^.]*/);
51 foreach my $cxx (@{$cc2cxx{$ccbase}}) {
52 if( can_run( File::Spec->catfile( $ccpath, $cxx, $ccsfx ) ) ) {
53 $self->{config}{cxx} = File::Spec->catfile( $ccpath, $cxx, $ccsfx );
54 last;
55 }
56 if( can_run( File::Spec->catfile( $cxx, $ccsfx ) ) ) {
57 $self->{config}{cxx} = File::Spec->catfile( $cxx, $ccsfx );
58 last;
59 }
60 if( can_run( $cxx ) ) {
61 $self->{config}{cxx} = $cxx;
62 last;
63 }
64 }
65 unless ( exists $self->{config}{cxx} ) {
66 $self->{config}{cxx} = $self->{config}{cc};
67 my $cflags = $self->{config}{cflags};
68 $self->{config}{cxxflags} = '-x c++';
69 $self->{config}{cxxflags} .= " $cflags" if defined $cflags;
70 }
71 }
72
6b09c160
YST
73 return $self;
74}
75
76sub find_perl_interpreter {
77 my $perl;
78 File::Spec->file_name_is_absolute($perl = $^X)
79 or -f ($perl = $Config::Config{perlpath})
06e8058f 80 or ($perl = $^X); # XXX how about using IPC::Cmd::can_run here?
6b09c160
YST
81 return $perl;
82}
83
84sub add_to_cleanup {
85 my $self = shift;
da2b6f33
SH
86 foreach (@_) {
87 $self->{files_to_clean}{$_} = 1;
88 }
89}
90
91sub cleanup {
92 my $self = shift;
93 foreach my $file (keys %{$self->{files_to_clean}}) {
94 unlink $file;
95 }
6b09c160
YST
96}
97
06e8058f
CBW
98sub get_config {
99 return %{ $_[0]->{config} };
100}
101
6b09c160
YST
102sub object_file {
103 my ($self, $filename) = @_;
104
105 # File name, minus the suffix
106 (my $file_base = $filename) =~ s/\.[^.]+$//;
107 return "$file_base$self->{config}{obj_ext}";
108}
109
110sub arg_include_dirs {
111 my $self = shift;
112 return map {"-I$_"} @_;
113}
114
115sub arg_nolink { '-c' }
116
117sub arg_object_file {
118 my ($self, $file) = @_;
119 return ('-o', $file);
120}
121
122sub arg_share_object_file {
123 my ($self, $file) = @_;
124 return ($self->split_like_shell($self->{config}{lddlflags}), '-o', $file);
125}
126
127sub arg_exec_file {
128 my ($self, $file) = @_;
129 return ('-o', $file);
130}
131
d1cf867f
SP
132sub arg_defines {
133 my ($self, %args) = @_;
134 return map "-D$_=$args{$_}", keys %args;
135}
136
6b09c160
YST
137sub compile {
138 my ($self, %args) = @_;
139 die "Missing 'source' argument to compile()" unless defined $args{source};
140
141 my $cf = $self->{config}; # For convenience
06e8058f
CBW
142
143 my $object_file = $args{object_file}
144 ? $args{object_file}
145 : $self->object_file($args{source});
146
147 my $include_dirs_ref =
148 (exists($args{include_dirs}) && ref($args{include_dirs}) ne "ARRAY")
149 ? [ $args{include_dirs} ]
150 : $args{include_dirs};
151 my @include_dirs = $self->arg_include_dirs(
152 @{ $include_dirs_ref || [] },
153 $self->perl_inc(),
154 );
6b09c160 155
d1cf867f
SP
156 my @defines = $self->arg_defines( %{$args{defines} || {}} );
157
06e8058f
CBW
158 my @extra_compiler_flags =
159 $self->split_like_shell($args{extra_compiler_flags});
6b09c160 160 my @cccdlflags = $self->split_like_shell($cf->{cccdlflags});
06e8058f 161 my @ccflags = $self->split_like_shell($args{'C++'} ? $cf->{cxxflags} : $cf->{ccflags});
6b09c160 162 my @optimize = $self->split_like_shell($cf->{optimize});
06e8058f
CBW
163 my @flags = (
164 @include_dirs,
165 @defines,
166 @cccdlflags,
167 @extra_compiler_flags,
168 $self->arg_nolink,
169 @ccflags,
170 @optimize,
171 $self->arg_object_file($object_file),
172 );
173 my @cc = $self->split_like_shell($args{'C++'} ? $cf->{cxx} : $cf->{cc});
6b09c160
YST
174
175 $self->do_system(@cc, @flags, $args{source})
06e8058f 176 or die "error building $object_file from '$args{source}'";
6b09c160 177
06e8058f 178 return $object_file;
6b09c160
YST
179}
180
181sub have_compiler {
506098d4 182 my ($self, $is_cplusplus) = @_;
06e8058f
CBW
183 my $have_compiler_flag = $is_cplusplus ? "have_cxx" : "have_cc";
184 my $suffix = $is_cplusplus ? ".cc" : ".c";
185 return $self->{$have_compiler_flag} if defined $self->{$have_compiler_flag};
6b09c160 186
9015f106
DG
187 my $result;
188 my $attempts = 3;
189 # tmpdir has issues for some people so fall back to current dir
9015f106 190
06e8058f
CBW
191 # don't clobber existing files (rare, but possible)
192 my ( $FH, $tmpfile ) = tempfile( "compilet-XXXXX", SUFFIX => $suffix );
193 binmode $FH;
9015f106 194
06e8058f
CBW
195 if ( $is_cplusplus ) {
196 print $FH "class Bogus { public: int boot_compilet() { return 1; } };\n";
197 }
198 else {
199 print $FH "int boot_compilet() { return 1; }\n";
200 }
ef9721fc 201 close $FH;
06e8058f
CBW
202
203 my ($obj_file, @lib_files);
204 eval {
205 local $^W = 0;
206 local $self->{quiet} = 1;
207 $obj_file = $self->compile('C++' => $is_cplusplus, source => $tmpfile);
208 @lib_files = $self->link(objects => $obj_file, module_name => 'compilet');
209 };
210 $result = $@ ? 0 : 1;
211
212 foreach (grep defined, $tmpfile, $obj_file, @lib_files) {
213 1 while unlink;
6b09c160 214 }
9015f106 215
06e8058f 216 return $self->{$have_compiler_flag} = $result;
6b09c160
YST
217}
218
506098d4
DG
219sub have_cplusplus {
220 push @_, 1;
221 goto &have_compiler;
222}
223
6b09c160
YST
224sub lib_file {
225 my ($self, $dl_file) = @_;
226 $dl_file =~ s/\.[^.]+$//;
227 $dl_file =~ tr/"//d;
228 return "$dl_file.$self->{config}{dlext}";
229}
230
231
232sub exe_file {
233 my ($self, $dl_file) = @_;
234 $dl_file =~ s/\.[^.]+$//;
235 $dl_file =~ tr/"//d;
236 return "$dl_file$self->{config}{_exe}";
237}
238
239sub need_prelink { 0 }
240
d1cf867f
SP
241sub extra_link_args_after_prelink { return }
242
6b09c160
YST
243sub prelink {
244 my ($self, %args) = @_;
06e8058f
CBW
245
246 my ($dl_file_out, $mksymlists_args) = _prepare_mksymlists_args(\%args);
247
6b09c160 248 require ExtUtils::Mksymlists;
06e8058f
CBW
249 # dl. abbrev for dynamic library
250 ExtUtils::Mksymlists::Mksymlists( %{ $mksymlists_args } );
251
6b09c160 252 # Mksymlists will create one of these files
06e8058f
CBW
253 return grep -e, map "$dl_file_out.$_", qw(ext def opt);
254}
255
256sub _prepare_mksymlists_args {
257 my $args = shift;
258 ($args->{dl_file} = $args->{dl_name}) =~ s/.*::// unless $args->{dl_file};
259
260 my %mksymlists_args = (
261 DL_VARS => $args->{dl_vars} || [],
262 DL_FUNCS => $args->{dl_funcs} || {},
263 FUNCLIST => $args->{dl_func_list} || [],
264 IMPORTS => $args->{dl_imports} || {},
265 NAME => $args->{dl_name}, # Name of the Perl module
266 DLBASE => $args->{dl_base}, # Basename of DLL file
267 FILE => $args->{dl_file}, # Dir + Basename of symlist file
268 VERSION => (defined $args->{dl_version} ? $args->{dl_version} : '0.0'),
269 );
270 return ($args->{dl_file}, \%mksymlists_args);
6b09c160
YST
271}
272
273sub link {
274 my ($self, %args) = @_;
275 return $self->_do_link('lib_file', lddl => 1, %args);
276}
277
278sub link_executable {
279 my ($self, %args) = @_;
280 return $self->_do_link('exe_file', lddl => 0, %args);
281}
2bd31f1a 282
6b09c160
YST
283sub _do_link {
284 my ($self, $type, %args) = @_;
285
286 my $cf = $self->{config}; # For convenience
287
288 my $objects = delete $args{objects};
289 $objects = [$objects] unless ref $objects;
290 my $out = $args{$type} || $self->$type($objects->[0]);
291
292 my @temp_files;
293 @temp_files =
06e8058f
CBW
294 $self->prelink(%args, dl_name => $args{module_name})
295 if $args{lddl} && $self->need_prelink;
6b09c160 296
06e8058f
CBW
297 my @linker_flags = (
298 $self->split_like_shell($args{extra_linker_flags}),
299 $self->extra_link_args_after_prelink(
300 %args, dl_name => $args{module_name}, prelink_res => \@temp_files
301 )
302 );
d1cf867f 303
06e8058f
CBW
304 my @output = $args{lddl}
305 ? $self->arg_share_object_file($out)
306 : $self->arg_exec_file($out);
6b09c160
YST
307 my @shrp = $self->split_like_shell($cf->{shrpenv});
308 my @ld = $self->split_like_shell($cf->{ld});
2bd31f1a 309
6b09c160
YST
310 $self->do_system(@shrp, @ld, @output, @$objects, @linker_flags)
311 or die "error building $out from @$objects";
312
313 return wantarray ? ($out, @temp_files) : $out;
314}
315
316
317sub do_system {
318 my ($self, @cmd) = @_;
319 print "@cmd\n" if !$self->{quiet};
320 return !system(@cmd);
321}
322
323sub split_like_shell {
324 my ($self, $string) = @_;
325
326 return () unless defined($string);
327 return @$string if UNIVERSAL::isa($string, 'ARRAY');
328 $string =~ s/^\s+|\s+$//g;
329 return () unless length($string);
330
06e8058f
CBW
331 # Text::ParseWords replaces all 'escaped' characters with themselves, which completely
332 # breaks paths under windows. As such, we forcibly replace backwards slashes with forward
333 # slashes on windows.
334 $string =~ s@\\@/@g if $^O eq 'MSWin32';
335
6b09c160
YST
336 return Text::ParseWords::shellwords($string);
337}
338
339# if building perl, perl's main source directory
340sub perl_src {
341 # N.B. makemaker actually searches regardless of PERL_CORE, but
342 # only squawks at not finding it if PERL_CORE is set
343
345dbb93
RGS
344 return unless $ENV{PERL_CORE};
345
ea2e6518
RGS
346 my $Updir = File::Spec->updir;
347 my $dir = File::Spec->curdir;
345dbb93
RGS
348
349 # Try up to 5 levels upwards
33d1b122 350 for (0..10) {
345dbb93 351 if (
06e8058f
CBW
352 -f File::Spec->catfile($dir,"config_h.SH")
353 &&
354 -f File::Spec->catfile($dir,"perl.h")
355 &&
356 -f File::Spec->catfile($dir,"lib","Exporter.pm")
357 ) {
8a6e5c04 358 return Cwd::realpath( $dir );
6b09c160
YST
359 }
360
345dbb93 361 $dir = File::Spec->catdir($dir, $Updir);
6b09c160 362 }
ea2e6518 363
345dbb93 364 warn "PERL_CORE is set but I can't find your perl source!\n";
ea2e6518 365 return ''; # return empty string if $ENV{PERL_CORE} but can't find dir ???
6b09c160
YST
366}
367
368# directory of perl's include files
369sub perl_inc {
370 my $self = shift;
371
372 $self->perl_src() || File::Spec->catdir($self->{config}{archlibexp},"CORE");
373}
374
da2b6f33
SH
375sub DESTROY {
376 my $self = shift;
8a6e5c04 377 local($., $@, $!, $^E, $?);
da2b6f33
SH
378 $self->cleanup();
379}
380
6b09c160 3811;
06e8058f
CBW
382
383# vim: ts=2 sw=2 et: