This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Refactor xsinit generation code in ExtUtils::Embed.
[perl5.git] / lib / ExtUtils / Embed.pm
index e0ea068..71c3876 100644 (file)
@@ -1,15 +1,7 @@
-# $Id: Embed.pm,v 1.2501 $
-require 5.002;
-
 package ExtUtils::Embed;
 require Exporter;
-require FileHandle;
 use Config;
-use Getopt::Std;
-
-#Only when we need them
-#require ExtUtils::MakeMaker;
-#require ExtUtils::Liblist;
+require File::Spec;
 
 use vars qw(@ISA @EXPORT $VERSION
            @Extensions $Verbose $lib_ext
@@ -17,17 +9,14 @@ use vars qw(@ISA @EXPORT $VERSION
            );
 use strict;
 
-$VERSION = sprintf("%d.%02d", q$Revision: 1.2505 $ =~ /(\d+)\.(\d+)/);
+# This is not a dual-life module, so no need for development version numbers
+$VERSION = '1.31';
 
 @ISA = qw(Exporter);
 @EXPORT = qw(&xsinit &ldopts 
             &ccopts &ccflags &ccdlflags &perl_inc
             &xsi_header &xsi_protos &xsi_body);
 
-#let's have Miniperl borrow from us instead
-#require ExtUtils::Miniperl;
-#*canon = \&ExtUtils::Miniperl::canon;
-
 $Verbose = 0;
 $lib_ext = $Config{lib_ext} || '.a';
 
@@ -43,21 +32,18 @@ sub my_return {
     }
 }
 
-sub is_perl_object {
-    $Config{ccflags} =~ /-DPERL_OBJECT/;  
-}
-
 sub xsinit { 
     my($file, $std, $mods) = @_;
     my($fh,@mods,%seen);
     $file ||= "perlxsi.c";
-    my $xsinit_proto = "pTHXo";
+    my $xsinit_proto = "pTHX";
 
     if (@_) {
        @mods = @$mods if $mods;
     }
     else {
-       getopts('o:s:');
+       require Getopt::Std;
+       Getopt::Std::getopts('o:s:');
        $file = $opt_o if defined $opt_o;
        $std  = $opt_s  if defined $opt_s;
        @mods = @ARGV;
@@ -68,14 +54,15 @@ sub xsinit {
        $fh = \*STDOUT;
     }
     else {
-       $fh = new FileHandle "> $file";
+        open $fh, '>', $file
+            or die "Can't open '$file': $!";
     }
 
     push(@mods, static_ext()) if defined $std;
     @mods = grep(!$seen{$_}++, @mods);
 
     print $fh &xsi_header();
-    print $fh "EXTERN_C void xs_init ($xsinit_proto);\n\n";     
+    print $fh "\nEXTERN_C void xs_init ($xsinit_proto);\n\n";
     print $fh &xsi_protos(@mods);
 
     print $fh "\nEXTERN_C void\nxs_init($xsinit_proto)\n{\n";
@@ -86,47 +73,17 @@ sub xsinit {
 
 sub xsi_header {
     return <<EOF;
-#if defined(__cplusplus) && !defined(PERL_OBJECT)
-#define is_cplusplus
-#endif
-
-#ifdef is_cplusplus
-extern "C" {
-#endif
-
-#include <EXTERN.h>
-#include <perl.h>
-#ifdef PERL_OBJECT
-#define NO_XSLOCKS
-#include <XSUB.h>
-#include "win32iop.h"
-#include <fcntl.h>
-#include <perlhost.h>
-#endif
-#ifdef is_cplusplus
-}
-#  ifndef EXTERN_C
-#    define EXTERN_C extern "C"
-#  endif
-#else
-#  ifndef EXTERN_C
-#    define EXTERN_C extern
-#  endif
-#endif
-
+#include "EXTERN.h"
+#include "perl.h"
+#include "XSUB.h"
 EOF
 }    
 
 sub xsi_protos {
     my(@exts) = @_;
     my(@retval,%seen);
-    my $boot_proto = "pTHXo_ CV* cv";
-    foreach $_ (@exts){
-        my($pname) = canon('/', $_);
-        my($mname, $cname);
-        ($mname = $pname) =~ s!/!::!g;
-        ($cname = $pname) =~ s!/!__!g;
-       my($ccode) = "EXTERN_C void boot_${cname} ($boot_proto);\n";
+    foreach my $cname (canon('__', @exts)) {
+        my($ccode) = "EXTERN_C void boot_${cname} (pTHX_ CV* cv);\n";
        next if $seen{$ccode}++;
         push(@retval, $ccode);
     }
@@ -135,24 +92,25 @@ sub xsi_protos {
 
 sub xsi_body {
     my(@exts) = @_;
-    my($pname,@retval,%seen);
-    my($dl) = canon('/','DynaLoader');
-    push(@retval, "\tchar *file = __FILE__;\n");
-    push(@retval, "\tdXSUB_SYS;\n") if $] > 5.002;
-    push(@retval, "\n");
-
-    foreach $_ (@exts){
-        my($pname) = canon('/', $_);
-        my($mname, $cname, $ccode);
+    my(@retval,%seen);
+    push(@retval, "    static const char file[] = __FILE__;\n")
+        if @exts;
+    push(@retval, "    dXSUB_SYS;\n");
+    push(@retval, "    PERL_UNUSED_CONTEXT;\n");
+    push(@retval, "\n")
+        if @exts;
+
+    foreach my $pname (canon('/', @exts)) {
+        my($cname, $mname, $ccode);
         ($mname = $pname) =~ s!/!::!g;
         ($cname = $pname) =~ s!/!__!g;
-        if ($pname eq $dl){
+        if ($pname eq 'DynaLoader'){
             # Must NOT install 'DynaLoader::boot_DynaLoader' as 'bootstrap'!
             # boot_DynaLoader is called directly in DynaLoader.pm
-            $ccode = "\t/* DynaLoader is a special case */\n\tnewXS(\"${mname}::boot_${cname}\", boot_${cname}, file);\n";
+            $ccode = "    /* DynaLoader is a special case */\n    newXS(\"${mname}::boot_${cname}\", boot_${cname}, file);\n";
             push(@retval, $ccode) unless $seen{$ccode}++;
         } else {
-            $ccode = "\tnewXS(\"${mname}::bootstrap\", boot_${cname}, file);\n";
+            $ccode = "    newXS(\"${mname}::bootstrap\", boot_${cname}, file);\n";
             push(@retval, $ccode) unless $seen{$ccode}++;
         }
     }
@@ -160,13 +118,35 @@ sub xsi_body {
 }
 
 sub static_ext {
-    unless (scalar @Extensions) {
-       @Extensions = sort split /\s+/, $Config{static_ext};
-       unshift @Extensions, qw(DynaLoader);
-    }
+    @Extensions = ('DynaLoader', sort $Config{static_ext} =~ /(\S+)/g)
+        unless @Extensions;
     @Extensions;
 }
 
+sub _escape {
+    my $arg = shift;
+    return $$arg if $^O eq 'VMS'; # parens legal in qualifier lists
+    $$arg =~ s/([\(\)])/\\$1/g;
+}
+
+sub _ldflags {
+    my $ldflags = $Config{ldflags};
+    _escape(\$ldflags);
+    return $ldflags;
+}
+
+sub _ccflags {
+    my $ccflags = $Config{ccflags};
+    _escape(\$ccflags);
+    return $ccflags;
+}
+
+sub _ccdlflags {
+    my $ccdlflags = $Config{ccdlflags};
+    _escape(\$ccdlflags);
+    return $ccdlflags;
+}
+
 sub ldopts {
     require ExtUtils::MakeMaker;
     require ExtUtils::Liblist;
@@ -174,7 +154,6 @@ sub ldopts {
     my(@mods,@link_args,@argv);
     my($dllib,$config_libs,@potential_libs,@path);
     local($") = ' ' unless $" eq ' ';
-    my $MM = bless {} => 'MY';
     if (scalar @_) {
        @link_args = @$link_args if $link_args;
        @mods = @$mods if $mods;
@@ -190,10 +169,14 @@ sub ldopts {
        }
     }
     $std = 1 unless scalar @link_args;
-    @path = $path ? split(/:/, $path) : @INC;
+    my $sep = $Config{path_sep} || ':';
+    @path = $path ? split(/\Q$sep/, $path) : @INC;
 
     push(@potential_libs, @link_args)    if scalar @link_args;
-    push(@potential_libs, $Config{libs}) if defined $std;
+    # makemaker includes std libs on windows by default
+    if ($^O ne 'MSWin32' and defined($std)) {
+       push(@potential_libs, $Config{perllibs});
+    }
 
     push(@mods, static_ext()) if $std;
 
@@ -202,13 +185,13 @@ sub ldopts {
     foreach $mod (@mods) {
        @ns = split(/::|\/|\\/, $mod);
        $sub = $ns[-1];
-       $root = $MM->catdir(@ns);
+       $root = File::Spec->catdir(@ns);
        
        print STDERR "searching for '$sub${lib_ext}'\n" if $Verbose;
        foreach (@path) {
-           next unless -e ($archive = $MM->catdir($_,"auto",$root,"$sub$lib_ext"));
+           next unless -e ($archive = File::Spec->catdir($_,"auto",$root,"$sub$lib_ext"));
            push @archives, $archive;
-           if(-e ($extra = $MM->catdir($_,"auto",$root,"extralibs.ld"))) {
+           if(-e ($extra = File::Spec->catdir($_,"auto",$root,"extralibs.ld"))) {
                local(*FH); 
                if(open(FH, $extra)) {
                    my($libs) = <FH>; chomp $libs;
@@ -223,16 +206,29 @@ sub ldopts {
     }
     #print STDERR "\@potential_libs = @potential_libs\n";
 
-    my $libperl = (grep(/^-l\w*perl\w*$/, @link_args))[0] || "-lperl";
+    my $libperl;
+    if ($^O eq 'MSWin32') {
+       $libperl = $Config{libperl};
+    }
+    elsif ($^O eq 'os390' && $Config{usedl}) {
+       # Nothing for OS/390 (z/OS) dynamic.
+    } else {
+       $libperl = (grep(/^-l\w*perl\w*$/, @link_args))[0]
+           || ($Config{libperl} =~ /^lib(\w+)(\Q$lib_ext\E|\.\Q$Config{dlext}\E)$/
+               ? "-l$1" : '')
+               || "-lperl";
+    }
 
+    my $lpath = File::Spec->catdir($Config{archlibexp}, 'CORE');
+    $lpath = qq["$lpath"] if $^O eq 'MSWin32';
     my($extralibs, $bsloadlibs, $ldloadlibs, $ld_run_path) =
-       $MM->ext(join ' ', 
-                $MM->catdir("-L$Config{archlibexp}", "CORE"), " $libperl", 
-                @potential_libs);
+       MM->ext(join ' ', "-L$lpath", $libperl, @potential_libs);
 
     my $ld_or_bs = $bsloadlibs || $ldloadlibs;
     print STDERR "bs: $bsloadlibs ** ld: $ldloadlibs" if $Verbose;
-    my $linkage = "$Config{ccdlflags} $Config{ldflags} @archives $ld_or_bs";
+    my $ccdlflags = _ccdlflags();
+    my $ldflags   = _ldflags();
+    my $linkage = "$ccdlflags $ldflags @archives $ld_or_bs";
     print STDERR "ldopts: '$linkage'\n" if $Verbose;
 
     return $linkage if scalar @_;
@@ -240,15 +236,19 @@ sub ldopts {
 }
 
 sub ccflags {
-    my_return(" $Config{ccflags} ");
+    my $ccflags = _ccflags();
+    my_return(" $ccflags ");
 }
 
 sub ccdlflags {
-    my_return(" $Config{ccdlflags} ");
+    my $ccdlflags = _ccdlflags();
+    my_return(" $ccdlflags ");
 }
 
 sub perl_inc {
-    my_return(" -I$Config{archlibexp}/CORE ");
+    my $dir = File::Spec->catdir($Config{archlibexp}, 'CORE');
+    $dir = qq["$dir"] if $^O eq 'MSWin32';
+    my_return(" -I$dir ");
 }
 
 sub ccopts {
@@ -258,12 +258,16 @@ sub ccopts {
 sub canon {
     my($as, @ext) = @_;
     foreach(@ext) {
-       # might be X::Y or lib/auto/X/Y/Y.a
-       next if s!::!/!g;
-       s:^(lib|ext)/(auto/)?::;
-       s:/\w+\.\w+$::;
+        # might be X::Y or lib/auto/X/Y/Y.a
+        next
+            if s!::!/!g;
+        s!^(?:lib|ext|dist|cpan)/(?:auto/)?!!;
+        s!/\w+\.\w+$!!;
+    }
+    if ($as ne '/') {
+        s!/!$as!
+            foreach @ext;
     }
-    grep(s:/:$as:, @ext) if ($as ne '/');
     @ext;
 }
 
@@ -277,6 +281,7 @@ ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications
 
 
  perl -MExtUtils::Embed -e xsinit 
+ perl -MExtUtils::Embed -e ccopts 
  perl -MExtUtils::Embed -e ldopts 
 
 =head1 DESCRIPTION
@@ -295,7 +300,7 @@ ccdlflags(), xsi_header(), xsi_protos(), xsi_body()
 
 =head1 FUNCTIONS
 
-=over
+=over 4
 
 =item xsinit()
 
@@ -332,7 +337,7 @@ B<[@modules]> is an array ref, same as additional arguments mentioned above.
 
 
 This will generate code with an B<xs_init> function that glues the perl B<Socket::bootstrap> function 
-to the C B<boot_Socket> function and writes it to a file named "xsinit.c".
+to the C B<boot_Socket> function and writes it to a file named F<xsinit.c>.
 
 Note that B<DynaLoader> is a special case where it must call B<boot_DynaLoader> directly.
 
@@ -378,7 +383,7 @@ we should find B<auto/Socket/Socket.a>
 When looking for B<DBD::Oracle> relative to a search path,
 we should find B<auto/DBD/Oracle/Oracle.a>
 
-Keep in mind, you can always supply B</my/own/path/ModuleName.a>
+Keep in mind that you can always supply B</my/own/path/ModuleName.a>
 as an additional linker argument.
 
 B<-->  E<lt>list of linker argsE<gt>
@@ -392,7 +397,7 @@ When invoked with parameters the following are accepted and optional:
 
 C<ldopts($std,[@modules],[@link_args],$path)>
 
-Where,
+Where:
 
 B<$std> is boolean, equivalent to the B<-std> option.  
 
@@ -411,7 +416,7 @@ rather than print it to STDOUT.
  perl -MExtUtils::Embed -e ldopts
 
 
-This will print arguments for linking with B<libperl.a>, B<DynaLoader> and 
+This will print arguments for linking with B<libperl> and
 extensions found in B<$Config{static_ext}>.  This includes libraries
 found in B<$Config{libs}> and the first ModuleName.a library
 for each extension that is found by searching B<@INC> or the path 
@@ -425,17 +430,8 @@ are picked up from the B<extralibs.ld> file in the same directory.
 
 This will do the same as the above example, along with printing additional arguments for linking with the B<Socket> extension.
 
-
- perl -MExtUtils::Embed -e ldopts -- DynaLoader
-
-
-This will print arguments for linking with just the B<DynaLoader> extension
-and B<libperl.a>.
-
-
  perl -MExtUtils::Embed -e ldopts -- -std Msql -- -L/usr/msql/lib -lmsql
 
-
 Any arguments after the second '--' token are additional linker
 arguments that will be examined for potential conflict.  If there is no
 conflict, the additional arguments will be part of the output.  
@@ -477,14 +473,14 @@ This function returns a string of B<boot_$ModuleName> prototypes for each @modul
 This function returns a string of calls to B<newXS()> that glue the module B<bootstrap>
 function to B<boot_ModuleName> for each @modules.
 
-B<xsinit()> uses the xsi_* functions to generate most of it's code.
+B<xsinit()> uses the xsi_* functions to generate most of its code.
 
 =back
 
 =head1 EXAMPLES
 
 For examples on how to use B<ExtUtils::Embed> for building C/C++ applications
-with embedded perl, see the eg/ directory and L<perlembed>.
+with embedded perl, see L<perlembed>.
 
 =head1 SEE ALSO