Jumbo doc patch from Abigail (almost identical to
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Mksymlists.pm
CommitLineData
c07a80fd 1package ExtUtils::Mksymlists;
2use strict qw[ subs refs ];
3# no strict 'vars'; # until filehandles are exempted
4
5use Carp;
c07a80fd 6use Exporter;
f1387719 7use vars qw( @ISA @EXPORT $VERSION );
8@ISA = 'Exporter';
9@EXPORT = '&Mksymlists';
6ee623d5 10$VERSION = substr q$Revision: 1.17 $, 10;
c07a80fd 11
12sub Mksymlists {
13 my(%spec) = @_;
f1387719 14 my($osname) = $^O;
c07a80fd 15
16 croak("Insufficient information specified to Mksymlists")
17 unless ( $spec{NAME} or
18 ($spec{FILE} and ($spec{DL_FUNCS} or $spec{FUNCLIST})) );
19
20 $spec{DL_VARS} = [] unless $spec{DL_VARS};
21 ($spec{FILE} = $spec{NAME}) =~ s/.*::// unless $spec{FILE};
348844dc 22 $spec{FUNCLIST} = [] unless $spec{FUNCLIST};
c07a80fd 23 $spec{DL_FUNCS} = { $spec{NAME} => [] }
24 unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
348844dc 25 @{$spec{FUNCLIST}});
c07a80fd 26 if (defined $spec{DL_FUNCS}) {
27 my($package);
28 foreach $package (keys %{$spec{DL_FUNCS}}) {
29 my($packprefix,$sym,$bootseen);
30 ($packprefix = $package) =~ s/\W/_/g;
31 foreach $sym (@{$spec{DL_FUNCS}->{$package}}) {
32 if ($sym =~ /^boot_/) {
33 push(@{$spec{FUNCLIST}},$sym);
34 $bootseen++;
35 }
36 else { push(@{$spec{FUNCLIST}},"XS_${packprefix}_$sym"); }
37 }
38 push(@{$spec{FUNCLIST}},"boot_$packprefix") unless $bootseen;
39 }
40 }
41
42# We'll need this if we ever add any OS which uses mod2fname
760ac839 43# not as pseudo-builtin.
c07a80fd 44# require DynaLoader;
c2e89b3d 45 if (defined &DynaLoader::mod2fname and not $spec{DLBASE}) {
46 $spec{DLBASE} = DynaLoader::mod2fname([ split(/::/,$spec{NAME}) ]);
47 }
c07a80fd 48
f1387719 49 if ($osname eq 'aix') { _write_aix(\%spec); }
50 elsif ($osname eq 'VMS') { _write_vms(\%spec) }
bab2b58e 51 elsif ($osname eq 'os2') { _write_os2(\%spec) }
68dc0745 52 elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
f1387719 53 else { croak("Don't know how to create linker option file for $osname\n"); }
c07a80fd 54}
55
56
57sub _write_aix {
58 my($data) = @_;
59
60 rename "$data->{FILE}.exp", "$data->{FILE}.exp_old";
61
62 open(EXP,">$data->{FILE}.exp")
63 or croak("Can't create $data->{FILE}.exp: $!\n");
64 print EXP join("\n",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
65 print EXP join("\n",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
66 close EXP;
67}
68
69
70sub _write_os2 {
71 my($data) = @_;
6ee623d5 72 require Config;
73 my $threaded = ($Config::Config{archname} =~ /-thread/ ? " threaded" : "");
c07a80fd 74
75 if (not $data->{DLBASE}) {
76 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
77 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
78 }
79 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
80
81 open(DEF,">$data->{FILE}.def")
82 or croak("Can't create $data->{FILE}.def: $!\n");
83 print DEF "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
6ee623d5 84 print DEF "DESCRIPTION 'Perl (v$]$threaded) module $data->{NAME} v$data->{VERSION}'\n";
c07a80fd 85 print DEF "CODE LOADONCALL\n";
86 print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
c2e89b3d 87 print DEF "EXPORTS\n ";
88 print DEF join("\n ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
89 print DEF join("\n ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
90 if (%{$data->{IMPORTS}}) {
91 print DEF "IMPORTS\n";
875fa795 92 my ($name, $exp);
93 while (($name, $exp)= each %{$data->{IMPORTS}}) {
94 print DEF " $name=$exp\n";
95 }
c2e89b3d 96 }
c07a80fd 97 close DEF;
98}
99
68dc0745 100sub _write_win32 {
101 my($data) = @_;
102
3e3baf6d 103 require Config;
68dc0745 104 if (not $data->{DLBASE}) {
105 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
106 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
107 }
108 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
109
110 open(DEF,">$data->{FILE}.def")
111 or croak("Can't create $data->{FILE}.def: $!\n");
84902520 112 # put library name in quotes (it could be a keyword, like 'Alias')
5b0d9cbe 113 if ($Config::Config{'cc'} !~ /^gcc/i) {
114 print DEF "LIBRARY \"$data->{DLBASE}\"\n";
5b0d9cbe 115 }
68dc0745 116 print DEF "EXPORTS\n ";
84902520 117 my @syms;
118 # Export public symbols both with and without underscores to
119 # ensure compatibility between DLLs from different compilers
120 # NOTE: DynaLoader itself only uses the names without underscores,
121 # so this is only to cover the case when the extension DLL may be
122 # linked to directly from C. GSAR 97-07-10
3e3baf6d 123 if ($Config::Config{'cc'} =~ /^bcc/i) {
84902520 124 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
125 push @syms, "_$_", "$_ = _$_";
126 }
3e3baf6d 127 }
84902520 128 else {
129 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
130 push @syms, "$_", "_$_ = $_";
131 }
132 }
133 print DEF join("\n ",@syms, "\n") if @syms;
68dc0745 134 if (%{$data->{IMPORTS}}) {
135 print DEF "IMPORTS\n";
136 my ($name, $exp);
137 while (($name, $exp)= each %{$data->{IMPORTS}}) {
138 print DEF " $name=$exp\n";
139 }
140 }
141 close DEF;
142}
143
c07a80fd 144
145sub _write_vms {
146 my($data) = @_;
a6e61155 147
f1387719 148 require Config; # a reminder for once we do $^O
ff0cee69 149 require ExtUtils::XSSymSet;
a6e61155 150
151 my($isvax) = $Config::Config{'arch'} =~ /VAX/i;
ff0cee69 152 my($set) = new ExtUtils::XSSymSet;
c07a80fd 153 my($sym);
154
155 rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
156
157 open(OPT,">$data->{FILE}.opt")
158 or croak("Can't create $data->{FILE}.opt: $!\n");
159
160 # Options file declaring universal symbols
161 # Used when linking shareable image for dynamic extension,
162 # or when linking PerlShr into which we've added this package
163 # as a static extension
164 # We don't do anything to preserve order, so we won't relax
165 # the GSMATCH criteria for a dynamic extension
166
167 foreach $sym (@{$data->{FUNCLIST}}) {
ff0cee69 168 my $safe = $set->addsym($sym);
169 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
170 else { print OPT "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
c07a80fd 171 }
172 foreach $sym (@{$data->{DL_VARS}}) {
ff0cee69 173 my $safe = $set->addsym($sym);
c07a80fd 174 print OPT "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
ff0cee69 175 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
176 else { print OPT "SYMBOL_VECTOR=($safe=DATA)\n"; }
c07a80fd 177 }
178 close OPT;
179
c07a80fd 180}
181
1821;
183
184__END__
185
186=head1 NAME
187
188ExtUtils::Mksymlists - write linker options files for dynamic extension
189
190=head1 SYNOPSIS
191
192 use ExtUtils::Mksymlists;
193 Mksymlists({ NAME => $name ,
194 DL_VARS => [ $var1, $var2, $var3 ],
195 DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
196 $pkg2 => [ $func3 ] });
197
198=head1 DESCRIPTION
199
200C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
1fef88e7 201during the creation of shared libraries for dynamic extensions. It is
c07a80fd 202normally called from a MakeMaker-generated Makefile when the extension
203is built. The linker option file is generated by calling the function
204C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
205It takes one argument, a list of key-value pairs, in which the following
206keys are recognized:
207
2ae324a7 208=over
209
875fa795 210=item DLBASE
c07a80fd 211
875fa795 212This item specifies the name by which the linker knows the
213extension, which may be different from the name of the
214extension itself (for instance, some linkers add an '_' to the
215name of the extension). If it is not specified, it is derived
216from the NAME attribute. It is presently used only by OS2 and Win32.
c07a80fd 217
218=item DL_FUNCS
219
220This is identical to the DL_FUNCS attribute available via MakeMaker,
221from which it is usually taken. Its value is a reference to an
222associative array, in which each key is the name of a package, and
223each value is an a reference to an array of function names which
224should be exported by the extension. For instance, one might say
875fa795 225C<DL_FUNCS =E<gt> { Homer::Iliad =E<gt> [ qw(trojans greeks) ],
a5f75d66 226Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>. The
c07a80fd 227function names should be identical to those in the XSUB code;
228C<Mksymlists> will alter the names written to the linker option
229file to match the changes made by F<xsubpp>. In addition, if
230none of the functions in a list begin with the string B<boot_>,
231C<Mksymlists> will add a bootstrap function for that package,
232just as xsubpp does. (If a B<boot_E<lt>pkgE<gt>> function is
233present in the list, it is passed through unchanged.) If
234DL_FUNCS is not specified, it defaults to the bootstrap
235function for the extension specified in NAME.
236
237=item DL_VARS
238
239This is identical to the DL_VARS attribute available via MakeMaker,
240and, like DL_FUNCS, it is usually specified via MakeMaker. Its
241value is a reference to an array of variable names which should
242be exported by the extension.
243
244=item FILE
245
246This key can be used to specify the name of the linker option file
247(minus the OS-specific extension), if for some reason you do not
248want to use the default value, which is the last word of the NAME
875fa795 249attribute (I<e.g.> for C<Tk::Canvas>, FILE defaults to C<Canvas>).
c07a80fd 250
251=item FUNCLIST
252
253This provides an alternate means to specify function names to be
254exported from the extension. Its value is a reference to an
255array of function names to be exported by the extension. These
256names are passed through unaltered to the linker options file.
de592821 257Specifying a value for the FUNCLIST attribute suppresses automatic
875fa795 258generation of the bootstrap function for the package. To still create
259the bootstrap name you have to specify the package name in the
260DL_FUNCS hash:
c07a80fd 261
875fa795 262 Mksymlists({ NAME => $name ,
263 FUNCLIST => [ $func1, $func2 ],
264 DL_FUNCS => { $pkg => [] } });
c07a80fd 265
875fa795 266
267=item IMPORTS
268
269This attribute is used to specify names to be imported into the
270extension. It is currently only used by OS/2 and Win32.
271
272=item NAME
273
274This gives the name of the extension (I<e.g.> C<Tk::Canvas>) for which
275the linker option file will be produced.
c07a80fd 276
2ae324a7 277=back
278
c07a80fd 279When calling C<Mksymlists>, one should always specify the NAME
280attribute. In most cases, this is all that's necessary. In
281the case of unusual extensions, however, the other attributes
282can be used to provide additional information to the linker.
283
284=head1 AUTHOR
285
bd3fa61c 286Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>>
c07a80fd 287
288=head1 REVISION
289
a5f75d66 290Last revised 14-Feb-1996, for Perl 5.002.