[inseparable changes from patch from perl5.003_24 to perl5.003_25]
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Liblist.pm
CommitLineData
005c1a0e 1package ExtUtils::Liblist;
8a1da95f 2use vars qw($VERSION);
005c1a0e 3# Broken out of MakeMaker from version 4.11
4
bab2b58e 5$VERSION = substr q$Revision: 1.21 $, 10;
f1387719 6
005c1a0e 7use Config;
8f1aa56b 8use Cwd 'cwd';
4633a7c4 9use File::Basename;
10
005c1a0e 11sub ext {
55497cff 12 if ($^O eq 'VMS') { return &_vms_ext; }
13 else { return &_unix_os2_ext; }
14}
15
16sub _unix_os2_ext {
c2e89b3d 17 my($self,$potential_libs, $Verbose) = @_;
f1387719 18 if ($^O =~ 'os2' and $Config{libs}) {
4e68a208 19 # Dynamic libraries are not transitive, so we may need including
20 # the libraries linked against perl.dll again.
21
22 $potential_libs .= " " if $potential_libs;
23 $potential_libs .= $Config{libs};
24 }
4633a7c4 25 return ("", "", "", "") unless $potential_libs;
8e07c86e 26 print STDOUT "Potential libraries are '$potential_libs':\n" if $Verbose;
005c1a0e 27
28 my($so) = $Config{'so'};
29 my($libs) = $Config{'libs'};
55497cff 30 my $Config_libext = $Config{lib_ext} || ".a";
31
005c1a0e 32
33 # compute $extralibs, $bsloadlibs and $ldloadlibs from
34 # $potential_libs
35 # this is a rewrite of Andy Dougherty's extliblist in perl
36 # its home is in <distribution>/ext/util
37
38 my(@searchpath); # from "-L/path" entries in $potential_libs
39 my(@libpath) = split " ", $Config{'libpth'};
4633a7c4 40 my(@ldloadlibs, @bsloadlibs, @extralibs, @ld_run_path, %ld_run_path_seen);
005c1a0e 41 my($fullname, $thislib, $thispth, @fullname);
8f1aa56b 42 my($pwd) = cwd(); # from Cwd.pm
005c1a0e 43 my($found) = 0;
44
45 foreach $thislib (split ' ', $potential_libs){
46
47 # Handle possible linker path arguments.
48 if ($thislib =~ s/^(-[LR])//){ # save path flag type
49 my($ptype) = $1;
50 unless (-d $thislib){
51 print STDOUT "$ptype$thislib ignored, directory does not exist\n"
52 if $Verbose;
53 next;
54 }
f1387719 55 unless ($self->file_name_is_absolute($thislib)) {
005c1a0e 56 print STDOUT "Warning: $ptype$thislib changed to $ptype$pwd/$thislib\n";
f1387719 57 $thislib = $self->catdir($pwd,$thislib);
005c1a0e 58 }
59 push(@searchpath, $thislib);
60 push(@extralibs, "$ptype$thislib");
61 push(@ldloadlibs, "$ptype$thislib");
62 next;
63 }
64
65 # Handle possible library arguments.
66 unless ($thislib =~ s/^-l//){
67 print STDOUT "Unrecognized argument in LIBS ignored: '$thislib'\n";
68 next;
69 }
70
71 my($found_lib)=0;
72 foreach $thispth (@searchpath, @libpath){
73
74 # Try to find the full name of the library. We need this to
75 # determine whether it's a dynamically-loadable library or not.
76 # This tends to be subject to various os-specific quirks.
77 # For gcc-2.6.2 on linux (March 1995), DLD can not load
78 # .sa libraries, with the exception of libm.sa, so we
79 # deliberately skip them.
4e1fac24 80 if (@fullname =
81 $self->lsdir($thispth,"^\Qlib$thislib.$so.\E[0-9]+")){
005c1a0e 82 # Take care that libfoo.so.10 wins against libfoo.so.9.
83 # Compare two libraries to find the most recent version
84 # number. E.g. if you have libfoo.so.9.0.7 and
85 # libfoo.so.10.1, first convert all digits into two
86 # decimal places. Then we'll add ".00" to the shorter
87 # strings so that we're comparing strings of equal length
88 # Thus we'll compare libfoo.so.09.07.00 with
89 # libfoo.so.10.01.00. Some libraries might have letters
90 # in the version. We don't know what they mean, but will
91 # try to skip them gracefully -- we'll set any letter to
92 # '0'. Finally, sort in reverse so we can take the
93 # first element.
94
95 #TODO: iterate through the directory instead of sorting
96
97 $fullname = "$thispth/" .
98 (sort { my($ma) = $a;
99 my($mb) = $b;
100 $ma =~ tr/A-Za-z/0/s;
101 $ma =~ s/\b(\d)\b/0$1/g;
102 $mb =~ tr/A-Za-z/0/s;
103 $mb =~ s/\b(\d)\b/0$1/g;
104 while (length($ma) < length($mb)) { $ma .= ".00"; }
105 while (length($mb) < length($ma)) { $mb .= ".00"; }
106 # Comparison deliberately backwards
107 $mb cmp $ma;} @fullname)[0];
108 } elsif (-f ($fullname="$thispth/lib$thislib.$so")
109 && (($Config{'dlsrc'} ne "dl_dld.xs") || ($thislib eq "m"))){
4633a7c4 110 } elsif (-f ($fullname="$thispth/lib${thislib}_s$Config_libext")
005c1a0e 111 && ($thislib .= "_s") ){ # we must explicitly use _s version
4633a7c4 112 } elsif (-f ($fullname="$thispth/lib$thislib$Config_libext")){
864a5fa8 113 } elsif (-f ($fullname="$thispth/$thislib$Config_libext")){
4633a7c4 114 } elsif (-f ($fullname="$thispth/Slib$thislib$Config_libext")){
8f1aa56b 115 } elsif ($^O eq 'dgux'
c07a80fd 116 && -l ($fullname="$thispth/lib$thislib$Config_libext")
117 && readlink($fullname) =~ /^elink:/) {
118 # Some of DG's libraries look like misconnected symbolic
119 # links, but development tools can follow them. (They
120 # look like this:
121 #
122 # libm.a -> elink:${SDE_PATH:-/usr}/sde/\
123 # ${TARGET_BINARY_INTERFACE:-m88kdgux}/usr/lib/libm.a
124 #
125 # , the compilation tools expand the environment variables.)
005c1a0e 126 } else {
8e07c86e 127 print STDOUT "$thislib not found in $thispth\n" if $Verbose;
005c1a0e 128 next;
129 }
8e07c86e 130 print STDOUT "'-l$thislib' found at $fullname\n" if $Verbose;
4633a7c4 131 my($fullnamedir) = dirname($fullname);
132 push @ld_run_path, $fullnamedir unless $ld_run_path_seen{$fullnamedir}++;
005c1a0e 133 $found++;
134 $found_lib++;
135
136 # Now update library lists
137
138 # what do we know about this library...
4633a7c4 139 my $is_dyna = ($fullname !~ /\Q$Config_libext\E$/);
4e68a208 140 my $in_perl = ($libs =~ /\B-l\Q$ {thislib}\E\b/s);
005c1a0e 141
142 # Do not add it into the list if it is already linked in
143 # with the main perl executable.
974f612f 144 # We have to special-case the NeXT, because math and ndbm
145 # are both in libsys_s
005c1a0e 146 unless ($in_perl ||
974f612f 147 ($Config{'osname'} eq 'next' &&
148 ($thislib eq 'm' || $thislib eq 'ndbm')) ){
005c1a0e 149 push(@extralibs, "-l$thislib");
150 }
151
152 # We might be able to load this archive file dynamically
974f612f 153 if ( ($Config{'dlsrc'} =~ /dl_next/ && $Config{'osvers'} lt '4_0')
154 || ($Config{'dlsrc'} =~ /dl_dld/) )
155 {
005c1a0e 156 # We push -l$thislib instead of $fullname because
157 # it avoids hardwiring a fixed path into the .bs file.
158 # Mkbootstrap will automatically add dl_findfile() to
159 # the .bs file if it sees a name in the -l format.
160 # USE THIS, when dl_findfile() is fixed:
161 # push(@bsloadlibs, "-l$thislib");
162 # OLD USE WAS while checking results against old_extliblist
163 push(@bsloadlibs, "$fullname");
164 } else {
165 if ($is_dyna){
166 # For SunOS4, do not add in this shared library if
167 # it is already linked in the main perl executable
168 push(@ldloadlibs, "-l$thislib")
8f1aa56b 169 unless ($in_perl and $^O eq 'sunos');
005c1a0e 170 } else {
171 push(@ldloadlibs, "-l$thislib");
172 }
173 }
174 last; # found one here so don't bother looking further
175 }
864a5fa8 176 print STDOUT "Warning (will try anyway): No library found for -l$thislib\n"
005c1a0e 177 unless $found_lib>0;
178 }
4633a7c4 179 return ('','','','') unless $found;
180 ("@extralibs", "@bsloadlibs", "@ldloadlibs",join(":",@ld_run_path));
005c1a0e 181}
182
55497cff 183
184sub _vms_ext {
185 my($self, $potential_libs,$verbose) = @_;
186 return ('', '', '', '') unless $potential_libs;
187
188 my(@dirs,@libs,$dir,$lib,%sh,%olb,%obj);
189 my $cwd = cwd();
190 my($so,$lib_ext,$obj_ext) = @Config{'so','lib_ext','obj_ext'};
191 # List of common Unix library names and there VMS equivalents
192 # (VMS equivalent of '' indicates that the library is automatially
193 # searched by the linker, and should be skipped here.)
194 my %libmap = ( 'm' => '', 'f77' => '', 'F77' => '', 'V77' => '', 'c' => '',
195 'malloc' => '', 'crypt' => '', 'resolv' => '', 'c_s' => '',
196 'socket' => '', 'X11' => 'DECW$XLIBSHR',
197 'Xt' => 'DECW$XTSHR', 'Xm' => 'DECW$XMLIBSHR',
198 'Xmu' => 'DECW$XMULIBSHR');
199 if ($Config{'vms_cc_type'} ne 'decc') { $libmap{'curses'} = 'VAXCCURSE'; }
200
201 print STDOUT "Potential libraries are '$potential_libs'\n" if $verbose;
202
203 # First, sort out directories and library names in the input
204 foreach $lib (split ' ',$potential_libs) {
205 push(@dirs,$1), next if $lib =~ /^-L(.*)/;
206 push(@dirs,$lib), next if $lib =~ /[:>\]]$/;
207 push(@dirs,$lib), next if -d $lib;
208 push(@libs,$1), next if $lib =~ /^-l(.*)/;
209 push(@libs,$lib);
210 }
211 push(@dirs,split(' ',$Config{'libpth'}));
212
213 # Now make sure we've got VMS-syntax absolute directory specs
214 # (We don't, however, check whether someone's hidden a relative
215 # path in a logical name.)
216 foreach $dir (@dirs) {
217 unless (-d $dir) {
218 print STDOUT "Skipping nonexistent Directory $dir\n" if $verbose > 1;
219 $dir = '';
220 next;
221 }
222 print STDOUT "Resolving directory $dir\n" if $verbose;
223 if ($self->file_name_is_absolute($dir)) { $dir = $self->fixpath($dir,1); }
224 else { $dir = $self->catdir($cwd,$dir); }
225 }
226 @dirs = grep { length($_) } @dirs;
227 unshift(@dirs,''); # Check each $lib without additions first
228
229 LIB: foreach $lib (@libs) {
230 if (exists $libmap{$lib}) {
231 next unless length $libmap{$lib};
232 $lib = $libmap{$lib};
233 }
234
235 my(@variants,$variant,$name,$test,$cand);
236 my($ctype) = '';
237
238 # If we don't have a file type, consider it a possibly abbreviated name and
239 # check for common variants. We try these first to grab libraries before
240 # a like-named executable image (e.g. -lperl resolves to perlshr.exe
241 # before perl.exe).
242 if ($lib !~ /\.[^:>\]]*$/) {
243 push(@variants,"${lib}shr","${lib}rtl","${lib}lib");
244 push(@variants,"lib$lib") if $lib !~ /[:>\]]/;
245 }
246 push(@variants,$lib);
247 print STDOUT "Looking for $lib\n" if $verbose;
248 foreach $variant (@variants) {
249 foreach $dir (@dirs) {
250 my($type);
251
252 $name = "$dir$variant";
253 print "\tChecking $name\n" if $verbose > 2;
254 if (-f ($test = VMS::Filespec::rmsexpand($name))) {
255 # It's got its own suffix, so we'll have to figure out the type
256 if ($test =~ /(?:$so|exe)$/i) { $type = 'sh'; }
257 elsif ($test =~ /(?:$lib_ext|olb)$/i) { $type = 'olb'; }
258 elsif ($test =~ /(?:$obj_ext|obj)$/i) {
259 print STDOUT "Warning (will try anyway): Plain object file $test found in library list\n";
260 $type = 'obj';
261 }
262 else {
263 print STDOUT "Warning (will try anyway): Unknown library type for $test; assuming shared\n";
264 $type = 'sh';
265 }
266 }
267 elsif (-f ($test = VMS::Filespec::rmsexpand($name,$so)) or
268 -f ($test = VMS::Filespec::rmsexpand($name,'.exe'))) {
269 $type = 'sh';
270 $name = $test unless $test =~ /exe;?\d*$/i;
271 }
272 elsif (not length($ctype) and # If we've got a lib already, don't bother
273 ( -f ($test = VMS::Filespec::rmsexpand($name,$lib_ext)) or
274 -f ($test = VMS::Filespec::rmsexpand($name,'.olb')))) {
275 $type = 'olb';
276 $name = $test unless $test =~ /olb;?\d*$/i;
277 }
278 elsif (not length($ctype) and # If we've got a lib already, don't bother
279 ( -f ($test = VMS::Filespec::rmsexpand($name,$obj_ext)) or
280 -f ($test = VMS::Filespec::rmsexpand($name,'.obj')))) {
281 print STDOUT "Warning (will try anyway): Plain object file $test found in library list\n";
282 $type = 'obj';
283 $name = $test unless $test =~ /obj;?\d*$/i;
284 }
285 if (defined $type) {
286 $ctype = $type; $cand = $name;
287 last if $ctype eq 'sh';
288 }
289 }
290 if ($ctype) {
291 eval '$' . $ctype . "{'$cand'}++";
292 die "Error recording library: $@" if $@;
293 print STDOUT "\tFound as $name (really $test), type $type\n" if $verbose > 1;
294 next LIB;
295 }
296 }
297 print STDOUT "Warning (will try anyway): No library found for $lib\n";
298 }
299
300 @libs = sort keys %obj;
301 # This has to precede any other CRTLs, so just make it first
302 if ($olb{VAXCCURSE}) {
303 push(@libs,"$olb{VAXCCURSE}/Library");
304 delete $olb{VAXCCURSE};
305 }
306 push(@libs, map { "$_/Library" } sort keys %olb);
307 push(@libs, map { "$_/Share" } sort keys %sh);
308 $lib = join(' ',@libs);
309 print "Result: $lib\n" if $verbose;
310 wantarray ? ($lib, '', $lib, '') : $lib;
311}
312
005c1a0e 3131;
c2e89b3d 314
864a5fa8 315__END__
cb1a09d0 316
864a5fa8 317=head1 NAME
318
319ExtUtils::Liblist - determine libraries to use and how to use them
320
321=head1 SYNOPSIS
322
323C<require ExtUtils::Liblist;>
324
325C<ExtUtils::Liblist::ext($potential_libs, $Verbose);>
326
327=head1 DESCRIPTION
328
329This utility takes a list of libraries in the form C<-llib1 -llib2
330-llib3> and prints out lines suitable for inclusion in an extension
331Makefile. Extra library paths may be included with the form
332C<-L/another/path> this will affect the searches for all subsequent
333libraries.
334
335It returns an array of four scalar values: EXTRALIBS, BSLOADLIBS,
336LDLOADLIBS, and LD_RUN_PATH.
337
338Dependent libraries can be linked in one of three ways:
339
340=over 2
341
342=item * For static extensions
343
344by the ld command when the perl binary is linked with the extension
345library. See EXTRALIBS below.
346
347=item * For dynamic extensions
348
349by the ld command when the shared object is built/linked. See
350LDLOADLIBS below.
351
352=item * For dynamic extensions
353
354by the DynaLoader when the shared object is loaded. See BSLOADLIBS
355below.
356
357=back
358
359=head2 EXTRALIBS
360
361List of libraries that need to be linked with when linking a perl
362binary which includes this extension Only those libraries that
363actually exist are included. These are written to a file and used
364when linking perl.
365
366=head2 LDLOADLIBS and LD_RUN_PATH
367
368List of those libraries which can or must be linked into the shared
369library when created using ld. These may be static or dynamic
370libraries. LD_RUN_PATH is a colon separated list of the directories
371in LDLOADLIBS. It is passed as an environment variable to the process
372that links the shared library.
373
374=head2 BSLOADLIBS
375
376List of those libraries that are needed but can be linked in
377dynamically at run time on this platform. SunOS/Solaris does not need
378this because ld records the information (from LDLOADLIBS) into the
379object file. This list is used to create a .bs (bootstrap) file.
380
381=head1 PORTABILITY
382
383This module deals with a lot of system dependencies and has quite a
384few architecture specific B<if>s in the code.
385
55497cff 386=head2 VMS implementation
387
388The version of ext() which is executed under VMS differs from the
389Unix-OS/2 version in several respects:
390
391=over 2
392
393=item *
394
395Input library and path specifications are accepted with or without the
396C<-l> and C<-L> prefices used by Unix linkers. If neither prefix is
397present, a token is considered a directory to search if it is in fact
398a directory, and a library to search for otherwise. Authors who wish
399their extensions to be portable to Unix or OS/2 should use the Unix
400prefixes, since the Unix-OS/2 version of ext() requires them.
401
402=item *
403
404Wherever possible, shareable images are preferred to object libraries,
405and object libraries to plain object files. In accordance with VMS
406naming conventions, ext() looks for files named I<lib>shr and I<lib>rtl;
407it also looks for I<lib>lib and libI<lib> to accomodate Unix conventions
408used in some ported software.
409
410=item *
411
412For each library that is found, an appropriate directive for a linker options
413file is generated. The return values are space-separated strings of
414these directives, rather than elements used on the linker command line.
415
416=item *
417
418LDLOADLIBS and EXTRALIBS are always identical under VMS, and BSLOADLIBS
419and LD_RIN_PATH are always empty.
420
421=back
422
423In addition, an attempt is made to recognize several common Unix library
424names, and filter them out or convert them to their VMS equivalents, as
425appropriate.
426
427In general, the VMS version of ext() should properly handle input from
428extensions originally designed for a Unix or VMS environment. If you
429encounter problems, or discover cases where the search could be improved,
430please let us know.
431
864a5fa8 432=head1 SEE ALSO
433
434L<ExtUtils::MakeMaker>
435
436=cut
437