home *** CD-ROM | disk | FTP | other *** search
/ CLIX - Fazer Clix Custa Nix / CLIX-CD.cdr / mac / lib / ExtUtils / Mksymlists.pm < prev    next >
Text File  |  1997-05-19  |  9KB  |  265 lines
  1. package ExtUtils::Mksymlists;
  2. use strict qw[ subs refs ];
  3. # no strict 'vars';  # until filehandles are exempted
  4.  
  5. use Carp;
  6. use Exporter;
  7. use vars qw( @ISA @EXPORT $VERSION );
  8. @ISA = 'Exporter';
  9. @EXPORT = '&Mksymlists';
  10. $VERSION = substr q$Revision: 1.3 $, 10;
  11.  
  12. sub Mksymlists {
  13.     my(%spec) = @_;
  14.     my($osname) = $^O;
  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};
  22.     $spec{DL_FUNCS} = { $spec{NAME} => [] }
  23.         unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
  24.                  $spec{FUNCLIST});
  25.     $spec{FUNCLIST} = [] unless $spec{FUNCLIST};
  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
  43. #    not as pseudo-builtin.
  44. #    require DynaLoader;
  45.     if (defined &DynaLoader::mod2fname and not $spec{DLBASE}) {
  46.         $spec{DLBASE} = DynaLoader::mod2fname([ split(/::/,$spec{NAME}) ]);
  47.     }
  48.  
  49.     if    ($osname eq 'aix') { _write_aix(\%spec); }
  50.     elsif ($osname eq 'MacOS'){ _write_aix(\%spec) }
  51.     elsif ($osname eq 'VMS') { _write_vms(\%spec) }
  52.     elsif ($osname eq 'os2') { _write_os2(\%spec) }
  53.     elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
  54.     else { croak("Don't know how to create linker option file for $osname\n"); }
  55. }
  56.  
  57.  
  58. sub _write_aix {
  59.     my($data) = @_;
  60.  
  61.     rename "$data->{FILE}.exp", "$data->{FILE}.exp_old";
  62.  
  63.     open(EXP,">$data->{FILE}.exp")
  64.         or croak("Can't create $data->{FILE}.exp: $!\n");
  65.     print EXP join("\n",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
  66.     print EXP join("\n",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
  67.     close EXP;
  68. }
  69.  
  70.  
  71. sub _write_os2 {
  72.     my($data) = @_;
  73.  
  74.     if (not $data->{DLBASE}) {
  75.         ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
  76.         $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
  77.     }
  78.     rename "$data->{FILE}.def", "$data->{FILE}_def.old";
  79.  
  80.     open(DEF,">$data->{FILE}.def")
  81.         or croak("Can't create $data->{FILE}.def: $!\n");
  82.     print DEF "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
  83.     print DEF "CODE LOADONCALL\n";
  84.     print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
  85.     print DEF "EXPORTS\n  ";
  86.     print DEF join("\n  ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
  87.     print DEF join("\n  ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
  88.     if (%{$data->{IMPORTS}}) {
  89.         print DEF "IMPORTS\n";
  90. my ($name, $exp);
  91. while (($name, $exp)= each %{$data->{IMPORTS}}) {
  92.   print DEF "  $name=$exp\n";
  93. }
  94.     }
  95.     close DEF;
  96. }
  97.  
  98. sub _write_win32 {
  99.     my($data) = @_;
  100.  
  101.     if (not $data->{DLBASE}) {
  102.         ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
  103.         $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
  104.     }
  105.     rename "$data->{FILE}.def", "$data->{FILE}_def.old";
  106.  
  107.     open(DEF,">$data->{FILE}.def")
  108.         or croak("Can't create $data->{FILE}.def: $!\n");
  109.     print DEF "LIBRARY $data->{DLBASE}\n";
  110.     print DEF "CODE LOADONCALL\n";
  111.     print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
  112.     print DEF "EXPORTS\n  ";
  113.     print DEF join("\n  ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
  114.     print DEF join("\n  ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
  115.     if (%{$data->{IMPORTS}}) {
  116.         print DEF "IMPORTS\n";
  117.         my ($name, $exp);
  118.         while (($name, $exp)= each %{$data->{IMPORTS}}) {
  119.             print DEF "  $name=$exp\n";
  120.         }
  121.     }
  122.     close DEF;
  123. }
  124.  
  125.  
  126. sub _write_vms {
  127.     my($data) = @_;
  128.  
  129.     require Config; # a reminder for once we do $^O
  130.     require ExtUtils::XSSymSet;
  131.  
  132.     my($isvax) = $Config::Config{'arch'} =~ /VAX/i;
  133.     my($set) = new ExtUtils::XSSymSet;
  134.     my($sym);
  135.  
  136.     rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
  137.  
  138.     open(OPT,">$data->{FILE}.opt")
  139.         or croak("Can't create $data->{FILE}.opt: $!\n");
  140.  
  141.     # Options file declaring universal symbols
  142.     # Used when linking shareable image for dynamic extension,
  143.     # or when linking PerlShr into which we've added this package
  144.     # as a static extension
  145.     # We don't do anything to preserve order, so we won't relax
  146.     # the GSMATCH criteria for a dynamic extension
  147.  
  148.     foreach $sym (@{$data->{FUNCLIST}}) {
  149.         my $safe = $set->addsym($sym);
  150.         if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
  151.         else        { print OPT "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
  152.     }
  153.     foreach $sym (@{$data->{DL_VARS}}) {
  154.         my $safe = $set->addsym($sym);
  155.         print OPT "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
  156.         if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
  157.         else        { print OPT "SYMBOL_VECTOR=($safe=DATA)\n"; }
  158.     }
  159.     close OPT;
  160.  
  161.     # Options file specifying RTLs to which this extension must be linked.
  162.     # Eventually, the list of libraries will be supplied by a working
  163.     # extliblist routine.
  164.     open OPT,'>rtls.opt';
  165.     print OPT "PerlShr/Share\n";
  166.     foreach $rtl (split(/\s+/,$Config::Config{'libs'})) { print OPT "$rtl\n"; }
  167.     close OPT;
  168. }
  169.  
  170. 1;
  171.  
  172. __END__
  173.  
  174. =head1 NAME
  175.  
  176. ExtUtils::Mksymlists - write linker options files for dynamic extension
  177.  
  178. =head1 SYNOPSIS
  179.  
  180.     use ExtUtils::Mksymlists;
  181.     Mksymlists({ NAME     => $name ,
  182.                  DL_VARS  => [ $var1, $var2, $var3 ],
  183.                  DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
  184.                                $pkg2 => [ $func3 ] });
  185.  
  186. =head1 DESCRIPTION
  187.  
  188. C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
  189. during the creation of shared libraries for dynamic extensions.  It is
  190. normally called from a MakeMaker-generated Makefile when the extension
  191. is built.  The linker option file is generated by calling the function
  192. C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
  193. It takes one argument, a list of key-value pairs, in which the following
  194. keys are recognized:
  195.  
  196. =over
  197.  
  198. =item NAME
  199.  
  200. This gives the name of the extension (I<e.g.> Tk::Canvas) for which
  201. the linker option file will be produced.
  202.  
  203. =item DL_FUNCS
  204.  
  205. This is identical to the DL_FUNCS attribute available via MakeMaker,
  206. from which it is usually taken.  Its value is a reference to an
  207. associative array, in which each key is the name of a package, and
  208. each value is an a reference to an array of function names which
  209. should be exported by the extension.  For instance, one might say
  210. C<DL_FUNCS =E<gt> { Homer::Iliad   =E<gt> [ qw(trojans greeks) ],
  211. Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>.  The
  212. function names should be identical to those in the XSUB code;
  213. C<Mksymlists> will alter the names written to the linker option
  214. file to match the changes made by F<xsubpp>.  In addition, if
  215. none of the functions in a list begin with the string B<boot_>,
  216. C<Mksymlists> will add a bootstrap function for that package,
  217. just as xsubpp does.  (If a B<boot_E<lt>pkgE<gt>> function is
  218. present in the list, it is passed through unchanged.)  If
  219. DL_FUNCS is not specified, it defaults to the bootstrap
  220. function for the extension specified in NAME.
  221.  
  222. =item DL_VARS
  223.  
  224. This is identical to the DL_VARS attribute available via MakeMaker,
  225. and, like DL_FUNCS, it is usually specified via MakeMaker.  Its
  226. value is a reference to an array of variable names which should
  227. be exported by the extension.
  228.  
  229. =item FILE
  230.  
  231. This key can be used to specify the name of the linker option file
  232. (minus the OS-specific extension), if for some reason you do not
  233. want to use the default value, which is the last word of the NAME
  234. attribute (I<e.g.> for Tk::Canvas, FILE defaults to 'Canvas').
  235.  
  236. =item FUNCLIST
  237.  
  238. This provides an alternate means to specify function names to be
  239. exported from the extension.  Its value is a reference to an
  240. array of function names to be exported by the extension.  These
  241. names are passed through unaltered to the linker options file.
  242.  
  243. =item DLBASE
  244.  
  245. This item specifies the name by which the linker knows the
  246. extension, which may be different from the name of the
  247. extension itself (for instance, some linkers add an '_' to the
  248. name of the extension).  If it is not specified, it is derived
  249. from the NAME attribute.  It is presently used only by OS2.
  250.  
  251. =back
  252.  
  253. When calling C<Mksymlists>, one should always specify the NAME
  254. attribute.  In most cases, this is all that's necessary.  In
  255. the case of unusual extensions, however, the other attributes
  256. can be used to provide additional information to the linker.
  257.  
  258. =head1 AUTHOR
  259.  
  260. Charles Bailey I<E<lt>bailey@genetics.upenn.eduE<gt>>
  261.  
  262. =head1 REVISION
  263.  
  264. Last revised 14-Feb-1996, for Perl 5.002.
  265.