home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 10 / AU_CD10.iso / Updates / Perl / RPC / !Perl / lib / zip / ExtUtils / Mksymlists.pm < prev    next >
Encoding:
Perl POD Document  |  1999-04-02  |  10.4 KB  |  320 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.17 $, 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{FUNCLIST} = [] unless $spec{FUNCLIST};
  23.     $spec{DL_FUNCS} = { $spec{NAME} => [] }
  24.         unless ( ($spec{DL_FUNCS} and keys %{$spec{DL_FUNCS}}) or
  25.                  @{$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 'VMS') { _write_vms(\%spec) }
  51.     elsif ($osname eq 'os2') { _write_os2(\%spec) }
  52.     elsif ($osname eq 'MSWin32') { _write_win32(\%spec) }
  53.     elsif ($osname eq 'riscos') { _write_riscos(\%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.     require Config;
  74.     my $threaded = ($Config::Config{archname} =~ /-thread/ ? " threaded" : "");
  75.  
  76.     if (not $data->{DLBASE}) {
  77.         ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
  78.         $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
  79.     }
  80.     rename "$data->{FILE}.def", "$data->{FILE}_def.old";
  81.  
  82.     open(DEF,">$data->{FILE}.def")
  83.         or croak("Can't create $data->{FILE}.def: $!\n");
  84.     print DEF "LIBRARY '$data->{DLBASE}' INITINSTANCE TERMINSTANCE\n";
  85.     print DEF "DESCRIPTION 'Perl (v$]$threaded) module $data->{NAME} v$data->{VERSION}'\n";
  86.     print DEF "CODE LOADONCALL\n";
  87.     print DEF "DATA LOADONCALL NONSHARED MULTIPLE\n";
  88.     print DEF "EXPORTS\n  ";
  89.     print DEF join("\n  ",@{$data->{DL_VARS}}, "\n") if @{$data->{DL_VARS}};
  90.     print DEF join("\n  ",@{$data->{FUNCLIST}}, "\n") if @{$data->{FUNCLIST}};
  91.     if (%{$data->{IMPORTS}}) {
  92.         print DEF "IMPORTS\n";
  93.     my ($name, $exp);
  94.     while (($name, $exp)= each %{$data->{IMPORTS}}) {
  95.         print DEF "  $name=$exp\n";
  96.     }
  97.     }
  98.     close DEF;
  99. }
  100.  
  101. sub _write_win32 {
  102.     my($data) = @_;
  103.  
  104.     require Config;
  105.     if (not $data->{DLBASE}) {
  106.         ($data->{DLBASE} = $data->{NAME}) =~ s/.*:://;
  107.         $data->{DLBASE} = substr($data->{DLBASE},0,7) . '_';
  108.     }
  109.     rename "$data->{FILE}.def", "$data->{FILE}_def.old";
  110.  
  111.     open(DEF,">$data->{FILE}.def")
  112.         or croak("Can't create $data->{FILE}.def: $!\n");
  113.     # put library name in quotes (it could be a keyword, like 'Alias')
  114.     if ($Config::Config{'cc'} !~ /^gcc/i) {
  115.       print DEF "LIBRARY \"$data->{DLBASE}\"\n";
  116.     }
  117.     print DEF "EXPORTS\n  ";
  118.     my @syms;
  119.     # Export public symbols both with and without underscores to
  120.     # ensure compatibility between DLLs from different compilers
  121.     # NOTE: DynaLoader itself only uses the names without underscores,
  122.     # so this is only to cover the case when the extension DLL may be
  123.     # linked to directly from C. GSAR 97-07-10
  124.     if ($Config::Config{'cc'} =~ /^bcc/i) {
  125.     for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
  126.         push @syms, "_$_", "$_ = _$_";
  127.     }
  128.     }
  129.     else {
  130.     for (@{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
  131.         push @syms, "$_", "_$_ = $_";
  132.     }
  133.     }
  134.     print DEF join("\n  ",@syms, "\n") if @syms;
  135.     if (%{$data->{IMPORTS}}) {
  136.         print DEF "IMPORTS\n";
  137.         my ($name, $exp);
  138.         while (($name, $exp)= each %{$data->{IMPORTS}}) {
  139.             print DEF "  $name=$exp\n";
  140.         }
  141.     }
  142.     close DEF;
  143. }
  144.  
  145.  
  146. sub _write_riscos {
  147.     my($data) = @_;
  148.  
  149.     require Config;
  150.  
  151. #    open(MAP, '<<PerlDev$Dir>/ptrblkmap')
  152. #    or croak ("Can't open '<PerlDev\$Dir>/ptrblkmap'");
  153.     rename "$data->{FILE}.map", "$data->{FILE}.map_old";
  154.  
  155.     open(OPT,">$data->{FILE}.map")
  156.     or croak("Can't create $data->{FILE}.map: $!\n");
  157.  
  158. #    while (<MAP>) {
  159. #    s/^# *//;    # Comments at top of ptrblkmap give segment ID
  160. #    last unless $_;
  161. #    print OPT;
  162. #    }
  163.  
  164.     print OPT "entries:\n//\n";
  165.     print OPT "named_entries:\n";
  166.  
  167.     for (sort @{$data->{DL_VARS}}, @{$data->{FUNCLIST}}) {
  168.     print OPT "$_\n";
  169.     }
  170.     print OPT "//\n";
  171.     close OPT;
  172. }
  173.  
  174. sub _write_vms {
  175.     my($data) = @_;
  176.  
  177.     require Config; # a reminder for once we do $^O
  178.     require ExtUtils::XSSymSet;
  179.  
  180.     my($isvax) = $Config::Config{'arch'} =~ /VAX/i;
  181.     my($set) = new ExtUtils::XSSymSet;
  182.     my($sym);
  183.  
  184.     rename "$data->{FILE}.opt", "$data->{FILE}.opt_old";
  185.  
  186.     open(OPT,">$data->{FILE}.opt")
  187.         or croak("Can't create $data->{FILE}.opt: $!\n");
  188.  
  189.     # Options file declaring universal symbols
  190.     # Used when linking shareable image for dynamic extension,
  191.     # or when linking PerlShr into which we've added this package
  192.     # as a static extension
  193.     # We don't do anything to preserve order, so we won't relax
  194.     # the GSMATCH criteria for a dynamic extension
  195.  
  196.     foreach $sym (@{$data->{FUNCLIST}}) {
  197.         my $safe = $set->addsym($sym);
  198.         if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
  199.         else        { print OPT "SYMBOL_VECTOR=($safe=PROCEDURE)\n"; }
  200.     }
  201.     foreach $sym (@{$data->{DL_VARS}}) {
  202.         my $safe = $set->addsym($sym);
  203.         print OPT "PSECT_ATTR=${sym},PIC,OVR,RD,NOEXE,WRT,NOSHR\n";
  204.         if ($isvax) { print OPT "UNIVERSAL=$safe\n" }
  205.         else        { print OPT "SYMBOL_VECTOR=($safe=DATA)\n"; }
  206.     }
  207.     close OPT;
  208.  
  209. }
  210.  
  211. 1;
  212.  
  213. __END__
  214.  
  215. =head1 NAME
  216.  
  217. ExtUtils::Mksymlists - write linker options files for dynamic extension
  218.  
  219. =head1 SYNOPSIS
  220.  
  221.     use ExtUtils::Mksymlists;
  222.     Mksymlists({ NAME     => $name ,
  223.                  DL_VARS  => [ $var1, $var2, $var3 ],
  224.                  DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
  225.                                $pkg2 => [ $func3 ] });
  226.  
  227. =head1 DESCRIPTION
  228.  
  229. C<ExtUtils::Mksymlists> produces files used by the linker under some OSs
  230. during the creation of shared libraries for dynamic extensions.  It is
  231. normally called from a MakeMaker-generated Makefile when the extension
  232. is built.  The linker option file is generated by calling the function
  233. C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
  234. It takes one argument, a list of key-value pairs, in which the following
  235. keys are recognized:
  236.  
  237. =over
  238.  
  239. =item DLBASE
  240.  
  241. This item specifies the name by which the linker knows the
  242. extension, which may be different from the name of the
  243. extension itself (for instance, some linkers add an '_' to the
  244. name of the extension).  If it is not specified, it is derived
  245. from the NAME attribute.  It is presently used only by OS2 and Win32.
  246.  
  247. =item DL_FUNCS
  248.  
  249. This is identical to the DL_FUNCS attribute available via MakeMaker,
  250. from which it is usually taken.  Its value is a reference to an
  251. associative array, in which each key is the name of a package, and
  252. each value is an a reference to an array of function names which
  253. should be exported by the extension.  For instance, one might say
  254. C<DL_FUNCS =E<gt> { Homer::Iliad =E<gt> [ qw(trojans greeks) ],
  255. Homer::Odyssey =E<gt> [ qw(travellers family suitors) ] }>.  The
  256. function names should be identical to those in the XSUB code;
  257. C<Mksymlists> will alter the names written to the linker option
  258. file to match the changes made by F<xsubpp>.  In addition, if
  259. none of the functions in a list begin with the string B<boot_>,
  260. C<Mksymlists> will add a bootstrap function for that package,
  261. just as xsubpp does.  (If a B<boot_E<lt>pkgE<gt>> function is
  262. present in the list, it is passed through unchanged.)  If
  263. DL_FUNCS is not specified, it defaults to the bootstrap
  264. function for the extension specified in NAME.
  265.  
  266. =item DL_VARS
  267.  
  268. This is identical to the DL_VARS attribute available via MakeMaker,
  269. and, like DL_FUNCS, it is usually specified via MakeMaker.  Its
  270. value is a reference to an array of variable names which should
  271. be exported by the extension.
  272.  
  273. =item FILE
  274.  
  275. This key can be used to specify the name of the linker option file
  276. (minus the OS-specific extension), if for some reason you do not
  277. want to use the default value, which is the last word of the NAME
  278. attribute (I<e.g.> for C<Tk::Canvas>, FILE defaults to C<Canvas>).
  279.  
  280. =item FUNCLIST
  281.  
  282. This provides an alternate means to specify function names to be
  283. exported from the extension.  Its value is a reference to an
  284. array of function names to be exported by the extension.  These
  285. names are passed through unaltered to the linker options file.
  286. Specifying a value for the FUNCLIST attribute suppresses automatic
  287. generation of the bootstrap function for the package. To still create
  288. the bootstrap name you have to specify the package name in the
  289. DL_FUNCS hash:
  290.  
  291.     Mksymlists({ NAME     => $name ,
  292.          FUNCLIST => [ $func1, $func2 ],
  293.                  DL_FUNCS => { $pkg => [] } });
  294.  
  295.  
  296. =item IMPORTS
  297.  
  298. This attribute is used to specify names to be imported into the
  299. extension. It is currently only used by OS/2 and Win32.
  300.  
  301. =item NAME
  302.  
  303. This gives the name of the extension (I<e.g.> C<Tk::Canvas>) for which
  304. the linker option file will be produced.
  305.  
  306. =back
  307.  
  308. When calling C<Mksymlists>, one should always specify the NAME
  309. attribute.  In most cases, this is all that's necessary.  In
  310. the case of unusual extensions, however, the other attributes
  311. can be used to provide additional information to the linker.
  312.  
  313. =head1 AUTHOR
  314.  
  315. Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>>
  316.  
  317. =head1 REVISION
  318.  
  319. Last revised 14-Feb-1996, for Perl 5.002.
  320.