1 package ExtUtils::Mksymlists;
4 use strict qw[ subs refs ];
5 # no strict 'vars'; # until filehandles are exempted
11 our @ISA = qw(Exporter);
12 our @EXPORT = qw(&Mksymlists);
13 our $VERSION = '6.53_02';
19 croak("Insufficient information specified to Mksymlists")
20 unless ( $spec{NAME} or
21 ($spec{FILE} and ($spec{DL_FUNCS} or $spec{FUNCLIST})) );
23 $spec{DL_VARS} = [] unless $spec{DL_VARS};
24 ($spec{FILE} = $spec{NAME}) =~ s/.*::// unless $spec{FILE};
25 $spec{FUNCLIST} = [] unless $spec{FUNCLIST};
26 $spec{DL_FUNCS} = { $spec{NAME} => [] }
27 unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
29 if (defined $spec{DL_FUNCS}) {
30 foreach my $package (keys %{$spec{DL_FUNCS}}) {
31 my($packprefix,$bootseen);
32 ($packprefix = $package) =~ s/\W/_/g;
33 foreach my $sym (@{$spec{DL_FUNCS}->{$package}}) {
34 if ($sym =~ /^boot_/) {
35 push(@{$spec{FUNCLIST}},$sym);
39 push(@{$spec{FUNCLIST}},"XS_${packprefix}_$sym");
42 push(@{$spec{FUNCLIST}},"boot_$packprefix") unless $bootseen;
46 # We'll need this if we ever add any OS which uses mod2fname
47 # not as pseudo-builtin.
49 if (defined &DynaLoader::mod2fname and not $spec{DLBASE}) {
50 $spec{DLBASE} = DynaLoader::mod2fname([ split(/::/,$spec{NAME}) ]);
53 if ($osname eq 'aix') { _write_aix(\%spec); }
54 elsif ($osname eq 'MacOS'){ _write_aix(\%spec) }
55 elsif ($osname eq 'VMS') { _write_vms(\%spec) }
56 elsif ($osname eq 'os2') { _write_os2(\%spec) }
57 elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
59 croak("Don't know how to create linker option file for $osname\n");
67 rename "$data->{FILE}.exp", "$data->{FILE}.exp_old";
69 open( my $exp, ">", "$data->{FILE}.exp")
70 or croak("Can't create $data->{FILE}.exp: $!\n");
71 print $exp join("\n",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
72 print $exp join("\n",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
80 my $threaded = ($Config::Config{archname} =~ /-thread/ ? " threaded" : "");
82 if (not $data->{DLBASE}) {
83 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
84 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
86 my $distname = $data->{DISTNAME} || $data->{NAME};
87 $distname = "Distribution $distname";
88 my $patchlevel = " pl$Config{perl_patchlevel}" || '';
89 my $comment = sprintf "Perl (v%s%s%s) module %s",
90 $Config::Config{version}, $threaded, $patchlevel, $data->{NAME};
92 if ($data->{INSTALLDIRS} and $data->{INSTALLDIRS} eq 'perl') {
93 $distname = 'perl5-porters@perl.org';
94 $comment = "Core $comment";
96 $comment = "$comment (Perl-config: $Config{config_args})";
97 $comment = substr($comment, 0, 200) . "...)" if length $comment > 203;
98 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
100 open(my $def, ">", "$data->{FILE}.def")
101 or croak("Can't create $data->{FILE}.def: $!\n");
102 print $def "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
103 print $def "DESCRIPTION '\@#$distname:$data->{VERSION}#\@ $comment'\n";
104 print $def "CODE LOADONCALL\n";
105 print $def "DATA LOADONCALL NONSHARED MULTIPLE\n";
106 print $def "EXPORTS\n ";
107 print $def join("\n ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
108 print $def join("\n ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
109 if (%{$data->{IMPORTS}}) {
110 print $def "IMPORTS\n";
112 while (($name, $exp)= each %{$data->{IMPORTS}}) {
113 print $def " $name=$exp\n";
123 if (not $data->{DLBASE}) {
124 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
125 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
127 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
129 open( my $def, ">", "$data->{FILE}.def" )
130 or croak("Can't create $data->{FILE}.def: $!\n");
131 # put library name in quotes (it could be a keyword, like 'Alias')
132 if ($Config::Config{'cc'} !~ /^gcc/i) {
133 print $def "LIBRARY \"$data->{DLBASE}\"\n";
135 print $def "EXPORTS\n ";
137 # Export public symbols both with and without underscores to
138 # ensure compatibility between DLLs from different compilers
139 # NOTE: DynaLoader itself only uses the names without underscores,
140 # so this is only to cover the case when the extension DLL may be
141 # linked to directly from C. GSAR 97-07-10
142 if ($Config::Config{'cc'} =~ /^bcc/i) {
143 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
144 push @syms, "_$_", "$_ = _$_";
148 for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
149 push @syms, "$_", "_$_ = $_";
152 print $def join("\n ",@syms, "\n") if @syms;
153 if (%{$data->{IMPORTS}}) {
154 print $def "IMPORTS\n";
156 while (($name, $exp)= each %{$data->{IMPORTS}}) {
157 print $def " $name=$exp\n";
167 require Config; # a reminder for once we do $^O
168 require ExtUtils::XSSymSet;
170 my($isvax) = $Config::Config{'archname'} =~ /VAX/i;
171 my($set) = new ExtUtils::XSSymSet;
173 rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
175 open(my $opt,">", "$data->{FILE}.opt")
176 or croak("Can't create $data->{FILE}.opt: $!\n");
178 # Options file declaring universal symbols
179 # Used when linking shareable image for dynamic extension,
180 # or when linking PerlShr into which we've added this package
181 # as a static extension
182 # We don't do anything to preserve order, so we won't relax
183 # the GSMATCH criteria for a dynamic extension
185 print $opt "case_sensitive=yes\n"
186 if $Config::Config{d_vms_case_sensitive_symbols};
188 foreach my $sym (@{$data->{FUNCLIST}}) {
189 my $safe = $set->addsym($sym);
190 if ($isvax) { print $opt "UNIVERSAL=$safe\n" }
191 else { print $opt "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
194 foreach my $sym (@{$data->{DL_VARS}}) {
195 my $safe = $set->addsym($sym);
196 print $opt "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
197 if ($isvax) { print $opt "UNIVERSAL=$safe\n" }
198 else { print $opt "SYMBOL_VECTOR=($safe=DATA)\n"; }
210 ExtUtils::Mksymlists - write linker options files for dynamic extension
214 use ExtUtils::Mksymlists;
215 Mksymlists({ NAME => $name ,
216 DL_VARS => [ $var1, $var2, $var3 ],
217 DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
218 $pkg2 => [ $func3 ] });
222 C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
223 during the creation of shared libraries for dynamic extensions. It is
224 normally called from a MakeMaker-generated Makefile when the extension
225 is built. The linker option file is generated by calling the function
226 C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
227 It takes one argument, a list of key-value pairs, in which the following
234 This item specifies the name by which the linker knows the
235 extension, which may be different from the name of the
236 extension itself (for instance, some linkers add an '_' to the
237 name of the extension). If it is not specified, it is derived
238 from the NAME attribute. It is presently used only by OS2 and Win32.
242 This is identical to the DL_FUNCS attribute available via MakeMaker,
243 from which it is usually taken. Its value is a reference to an
244 associative array, in which each key is the name of a package, and
245 each value is an a reference to an array of function names which
246 should be exported by the extension. For instance, one might say
247 C<DL_FUNCS =E<gt> { Homer::Iliad =E<gt> [ qw(trojans greeks) ],
248 Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>. The
249 function names should be identical to those in the XSUB code;
250 C<Mksymlists> will alter the names written to the linker option
251 file to match the changes made by F<xsubpp>. In addition, if
252 none of the functions in a list begin with the string B<boot_>,
253 C<Mksymlists> will add a bootstrap function for that package,
254 just as xsubpp does. (If a B<boot_E<lt>pkgE<gt>> function is
255 present in the list, it is passed through unchanged.) If
256 DL_FUNCS is not specified, it defaults to the bootstrap
257 function for the extension specified in NAME.
261 This is identical to the DL_VARS attribute available via MakeMaker,
262 and, like DL_FUNCS, it is usually specified via MakeMaker. Its
263 value is a reference to an array of variable names which should
264 be exported by the extension.
268 This key can be used to specify the name of the linker option file
269 (minus the OS-specific extension), if for some reason you do not
270 want to use the default value, which is the last word of the NAME
271 attribute (I<e.g.> for C<Tk::Canvas>, FILE defaults to C<Canvas>).
275 This provides an alternate means to specify function names to be
276 exported from the extension. Its value is a reference to an
277 array of function names to be exported by the extension. These
278 names are passed through unaltered to the linker options file.
279 Specifying a value for the FUNCLIST attribute suppresses automatic
280 generation of the bootstrap function for the package. To still create
281 the bootstrap name you have to specify the package name in the
284 Mksymlists({ NAME => $name ,
285 FUNCLIST => [ $func1, $func2 ],
286 DL_FUNCS => { $pkg => [] } });
291 This attribute is used to specify names to be imported into the
292 extension. It is currently only used by OS/2 and Win32.
296 This gives the name of the extension (I<e.g.> C<Tk::Canvas>) for which
297 the linker option file will be produced.
301 When calling C<Mksymlists>, one should always specify the NAME
302 attribute. In most cases, this is all that's necessary. In
303 the case of unusual extensions, however, the other attributes
304 can be used to provide additional information to the linker.
308 Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>>
312 Last revised 14-Feb-1996, for Perl 5.002.