1 package ExtUtils::Mksymlists;
2 use strict qw[ subs refs ];
3 # no strict 'vars'; # until filehandles are exempted
7 use vars qw( @ISA @EXPORT $VERSION );
9 @EXPORT = '&Mksymlists';
10 $VERSION = substr q$Revision: 1.13 $, 10;
16 croak("Insufficient information specified to Mksymlists")
17 unless ( $spec{NAME} or
18 ($spec{FILE} and ($spec{DL_FUNCS} or $spec{FUNCLIST})) );
20 $spec{DL_VARS} = [] unless $spec{DL_VARS};
21 ($spec{FILE} = $spec{NAME}) =~ s/.*::// unless $spec{FILE};
22 $spec{DL_FUNCS} = { $spec{NAME} => [] }
23 unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
25 $spec{FUNCLIST} = [] unless $spec{FUNCLIST};
26 if (defined $spec{DL_FUNCS}) {
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);
36 else { push(@{$spec{FUNCLIST}},"XS_${packprefix}_$sym"); }
38 push(@{$spec{FUNCLIST}},"boot_$packprefix") unless $bootseen;
42 # We'll need this if we ever add any OS which uses mod2fname
43 # not as pseudo-builtin.
45 if (defined &DynaLoader::mod2fname and not $spec{DLBASE}) {
46 $spec{DLBASE} = DynaLoader::mod2fname([ split(/::/,$spec{NAME}) ]);
49 if ($osname eq 'aix') { _write_aix(\%spec); }
50 elsif ($osname eq 'VMS') { _write_vms(\%spec) }
51 elsif ($osname eq 'os2') { _write_os2(\%spec) }
52 elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
53 else { croak("Don't know how to create linker option file for $osname\n"); }
60 rename "$data->{FILE}.exp", "$data->{FILE}.exp_old";
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}};
73 if (not $data->{DLBASE}) {
74 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
75 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
77 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
79 open(DEF,">$data->{FILE}.def")
80 or croak("Can't create $data->{FILE}.def: $!\n");
81 print DEF "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
82 print DEF "CODE LOADONCALL\n";
83 print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
84 print DEF "EXPORTS\n ";
85 print DEF join("\n ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
86 print DEF join("\n ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
87 if (%{$data->{IMPORTS}}) {
88 print DEF "IMPORTS\n";
90 while (($name, $exp)= each %{$data->{IMPORTS}}) {
91 print DEF " $name=$exp\n";
100 if (not $data->{DLBASE}) {
101 ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
102 $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
104 rename "$data->{FILE}.def", "$data->{FILE}_def.old";
106 open(DEF,">$data->{FILE}.def")
107 or croak("Can't create $data->{FILE}.def: $!\n");
108 print DEF "LIBRARY $data->{DLBASE}\n";
109 print DEF "CODE LOADONCALL\n";
110 print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
111 print DEF "EXPORTS\n ";
112 print DEF join("\n ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
113 print DEF join("\n ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
114 if (%{$data->{IMPORTS}}) {
115 print DEF "IMPORTS\n";
117 while (($name, $exp)= each %{$data->{IMPORTS}}) {
118 print DEF " $name=$exp\n";
128 require Config; # a reminder for once we do $^O
129 require ExtUtils::XSSymSet;
131 my($isvax) = $Config::Config{'arch'} =~ /VAX/i;
132 my($set) = new ExtUtils::XSSymSet;
135 rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
137 open(OPT,">$data->{FILE}.opt")
138 or croak("Can't create $data->{FILE}.opt: $!\n");
140 # Options file declaring universal symbols
141 # Used when linking shareable image for dynamic extension,
142 # or when linking PerlShr into which we've added this package
143 # as a static extension
144 # We don't do anything to preserve order, so we won't relax
145 # the GSMATCH criteria for a dynamic extension
147 foreach $sym (@{$data->{FUNCLIST}}) {
148 my $safe = $set->addsym($sym);
149 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
150 else { print OPT "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
152 foreach $sym (@{$data->{DL_VARS}}) {
153 my $safe = $set->addsym($sym);
154 print OPT "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
155 if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
156 else { print OPT "SYMBOL_VECTOR=($safe=DATA)\n"; }
160 # Options file specifying RTLs to which this extension must be linked.
161 # Eventually, the list of libraries will be supplied by a working
162 # extliblist routine.
163 open OPT,'>rtls.opt';
164 print OPT "PerlShr/Share\n";
165 foreach $rtl (split(/\s+/,$Config::Config{'libs'})) { print OPT "$rtl\n"; }
175 ExtUtils::Mksymlists - write linker options files for dynamic extension
179 use ExtUtils::Mksymlists;
180 Mksymlists({ NAME => $name ,
181 DL_VARS => [ $var1, $var2, $var3 ],
182 DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
183 $pkg2 => [ $func3 ] });
187 C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
188 during the creation of shared libraries for dynamic extensions. It is
189 normally called from a MakeMaker-generated Makefile when the extension
190 is built. The linker option file is generated by calling the function
191 C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
192 It takes one argument, a list of key-value pairs, in which the following
199 This gives the name of the extension (I<e.g.> Tk::Canvas) for which
200 the linker option file will be produced.
204 This is identical to the DL_FUNCS attribute available via MakeMaker,
205 from which it is usually taken. Its value is a reference to an
206 associative array, in which each key is the name of a package, and
207 each value is an a reference to an array of function names which
208 should be exported by the extension. For instance, one might say
209 C<DL_FUNCS =E<gt> { Homer::Iliad =E<gt> [ qw(trojans greeks) ],
210 Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>. The
211 function names should be identical to those in the XSUB code;
212 C<Mksymlists> will alter the names written to the linker option
213 file to match the changes made by F<xsubpp>. In addition, if
214 none of the functions in a list begin with the string B<boot_>,
215 C<Mksymlists> will add a bootstrap function for that package,
216 just as xsubpp does. (If a B<boot_E<lt>pkgE<gt>> function is
217 present in the list, it is passed through unchanged.) If
218 DL_FUNCS is not specified, it defaults to the bootstrap
219 function for the extension specified in NAME.
223 This is identical to the DL_VARS attribute available via MakeMaker,
224 and, like DL_FUNCS, it is usually specified via MakeMaker. Its
225 value is a reference to an array of variable names which should
226 be exported by the extension.
230 This key can be used to specify the name of the linker option file
231 (minus the OS-specific extension), if for some reason you do not
232 want to use the default value, which is the last word of the NAME
233 attribute (I<e.g.> for Tk::Canvas, FILE defaults to 'Canvas').
237 This provides an alternate means to specify function names to be
238 exported from the extension. Its value is a reference to an
239 array of function names to be exported by the extension. These
240 names are passed through unaltered to the linker options file.
244 This item specifies the name by which the linker knows the
245 extension, which may be different from the name of the
246 extension itself (for instance, some linkers add an '_' to the
247 name of the extension). If it is not specified, it is derived
248 from the NAME attribute. It is presently used only by OS2.
252 When calling C<Mksymlists>, one should always specify the NAME
253 attribute. In most cases, this is all that's necessary. In
254 the case of unusual extensions, however, the other attributes
255 can be used to provide additional information to the linker.
259 Charles Bailey I<E<lt>bailey@genetics.upenn.eduE<gt>>
263 Last revised 14-Feb-1996, for Perl 5.002.