-# $Id: Embed.pm,v 1.1.1.1 2002/01/16 19:27:19 schwern Exp $
-require 5.002;
-
package ExtUtils::Embed;
require Exporter;
-require FileHandle;
use Config;
-use Getopt::Std;
-use File::Spec;
-
-#Only when we need them
-#require ExtUtils::MakeMaker;
-#require ExtUtils::Liblist;
+require File::Spec;
use vars qw(@ISA @EXPORT $VERSION
@Extensions $Verbose $lib_ext
use strict;
# This is not a dual-life module, so no need for development version numbers
-$VERSION = '1.28';
+$VERSION = '1.34';
@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';
@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;
$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";
sub xsi_header {
return <<EOF;
-#include <EXTERN.h>
-#include <perl.h>
-
+#include "EXTERN.h"
+#include "perl.h"
+#include "XSUB.h"
EOF
}
sub xsi_protos {
- my(@exts) = @_;
- my(@retval,%seen);
- my $boot_proto = "pTHX_ 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";
- next if $seen{$ccode}++;
- push(@retval, $ccode);
+ my @exts = @_;
+ my %seen;
+ my $retval = '';
+ foreach my $cname (canon('__', @exts)) {
+ my $ccode = "EXTERN_C void boot_${cname} (pTHX_ CV* cv);\n";
+ $retval .= $ccode
+ unless $seen{$ccode}++;
}
- return join '', @retval;
+ return $retval;
}
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);
- ($mname = $pname) =~ s!/!::!g;
- ($cname = $pname) =~ s!/!__!g;
- if ($pname eq $dl){
+ my @exts = @_;
+ my %seen;
+ my $retval;
+ $retval .= " static const char file[] = __FILE__;\n"
+ if @exts;
+ $retval .= <<'EOT';
+ dXSUB_SYS;
+ PERL_UNUSED_CONTEXT;
+EOT
+ $retval .= "\n"
+ if @exts;
+
+ foreach my $pname (canon('/', @exts)) {
+ next
+ if $seen{$pname}++;
+ (my $mname = $pname) =~ s!/!::!g;
+ (my $cname = $pname) =~ s!/!__!g;
+ my $fname;
+ 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";
- push(@retval, $ccode) unless $seen{$ccode}++;
+ $retval .= " /* DynaLoader is a special case */\n";
+ $fname = "${mname}::boot_DynaLoader";
} else {
- $ccode = "\tnewXS(\"${mname}::bootstrap\", boot_${cname}, file);\n";
- push(@retval, $ccode) unless $seen{$ccode}++;
+ $fname = "${mname}::bootstrap";
}
+ $retval .= " newXS(\"$fname\", boot_${cname}, file);\n"
}
- return join '', @retval;
+ return $retval;
}
sub static_ext {
- unless (scalar @Extensions) {
- my $static_ext = $Config{static_ext};
- $static_ext =~ s/^\s+//;
- @Extensions = sort split /\s+/, $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;
}
push @archives, $archive;
if(-e ($extra = File::Spec->catdir($_,"auto",$root,"extralibs.ld"))) {
local(*FH);
- if(open(FH, $extra)) {
+ if(open(FH, '<', $extra)) {
my($libs) = <FH>; chomp $libs;
push @potential_libs, split /\s+/, $libs;
}
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!g
+ foreach @ext;
}
- map(s:/:$as:, @ext) if ($as ne '/');
@ext;
}
=head1 SYNOPSIS
-
perl -MExtUtils::Embed -e xsinit
perl -MExtUtils::Embed -e ccopts
perl -MExtUtils::Embed -e ldopts
=head1 DESCRIPTION
-ExtUtils::Embed provides utility functions for embedding a Perl interpreter
+C<ExtUtils::Embed> provides utility functions for embedding a Perl interpreter
and extensions in your C/C++ applications.
-Typically, an application B<Makefile> will invoke ExtUtils::Embed
+Typically, an application F<Makefile> will invoke C<ExtUtils::Embed>
functions while building your application.
=head1 @EXPORT
-ExtUtils::Embed exports the following functions:
+C<ExtUtils::Embed> exports the following functions:
xsinit(), ldopts(), ccopts(), perl_inc(), ccflags(),
ccdlflags(), xsi_header(), xsi_protos(), xsi_body()
=item Examples
-
perl -MExtUtils::Embed -e xsinit -- -o xsinit.c Socket
+This will generate code with an C<xs_init> function that glues the perl C<Socket::bootstrap> function
+to the C C<boot_Socket> function and writes it to a file named F<xsinit.c>.
-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 F<xsinit.c>.
-
-Note that B<DynaLoader> is a special case where it must call B<boot_DynaLoader> directly.
+Note that L<DynaLoader> is a special case where it must call C<boot_DynaLoader> directly.
perl -MExtUtils::Embed -e xsinit
+This will generate code for linking with C<DynaLoader> and
+each static extension found in C<$Config{static_ext}>.
+The code is written to the default file name F<perlxsi.c>.
-This will generate code for linking with B<DynaLoader> and
-each static extension found in B<$Config{static_ext}>.
-The code is written to the default file name B<perlxsi.c>.
-
-
- perl -MExtUtils::Embed -e xsinit -- -o xsinit.c -std DBI DBD::Oracle
-
+ perl -MExtUtils::Embed -e xsinit -- -o xsinit.c \
+ -std DBI DBD::Oracle
Here, code is written for all the currently linked extensions along with code
-for B<DBI> and B<DBD::Oracle>.
+for C<DBI> and C<DBD::Oracle>.
-If you have a working B<DynaLoader> then there is rarely any need to statically link in any
+If you have a working C<DynaLoader> then there is rarely any need to statically link in any
other extensions.
=item ldopts()
B<-I> E<lt>path1:path2E<gt>
Search path for ModuleName.a archives.
-Default path is B<@INC>.
+Default path is C<@INC>.
Library archives are expected to be found as
-B</some/path/auto/ModuleName/ModuleName.a>
-For example, when looking for B<Socket.a> relative to a search path,
-we should find B<auto/Socket/Socket.a>
+F</some/path/auto/ModuleName/ModuleName.a>
+For example, when looking for F<Socket.a> relative to a search path,
+we should find F<auto/Socket/Socket.a>
-When looking for B<DBD::Oracle> relative to a search path,
-we should find
B<auto/DBD/Oracle/Oracle.a>
+When looking for C<DBD::Oracle> relative to a search path,
+we should find
F<auto/DBD/Oracle/Oracle.a>
-Keep in mind that you can always supply B</my/own/path/ModuleName.a>
+Keep in mind that you can always supply F</my/own/path/ModuleName.a>
as an additional linker argument.
B<--> E<lt>list of linker argsE<gt>
=item Examples
-
perl -MExtUtils::Embed -e ldopts
-
-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
-specified by the B<-I> option.
+This will print arguments for linking with C<libperl> and
+extensions found in C<$Config{static_ext}>. This includes libraries
+found in C<$Config{libs}> and the first ModuleName.a library
+for each extension that is found by searching C<@INC> or the path
+specified by the B<-I> option.
In addition, when ModuleName.a is found, additional linker arguments
-are picked up from the B<extralibs.ld> file in the same directory.
-
+are picked up from the F<extralibs.ld> file in the same directory.
perl -MExtUtils::Embed -e ldopts -- -std Socket
+This will do the same as the above example, along with printing additional
+arguments for linking with the C<Socket> extension.
-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 -- -std Msql -- -L/usr/msql/lib -lmsql
+ 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.
-
=item perl_inc()
For including perl header files this function simply prints:
=item ccopts()
-This function combines perl_inc(), ccflags() and ccdlflags() into one.
+This function combines C<perl_inc()>, C<ccflags()> and C<ccdlflags()> into one.
=item xsi_header()
-This function simply returns a string defining the same B<EXTERN_C> macro as
-B<perlmain.c> along with #including B<perl.h> and B<EXTERN.h>.
+This function simply returns a string defining the same C<EXTERN_C> macro as
+F<perlmain.c> along with #including F<perl.h> and F<EXTERN.h>.
=item xsi_protos(@modules)
-This function returns a string of B<boot_$ModuleName> prototypes for each @modules.
+This function returns a string of C<boot_$ModuleName> prototypes for each @modules.
=item xsi_body(@modules)
-This function returns a string of calls to B<newXS()> that glue the module B<bootstrap>
-function to B<boot_ModuleName> for each @modules.
+This function returns a string of calls to C<newXS()> that glue the module I<bootstrap>
+function to I<boot_ModuleName> for each @modules.
-B<xsinit()> uses the xsi_* functions to generate most of its code.
+C<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
+For examples on how to use C<ExtUtils::Embed> for building C/C++ applications
with embedded perl, see L<perlembed>.
=head1 SEE ALSO
=head1 AUTHOR
-Doug MacEachern E<lt>F<dougm@osf.org>E<gt>
+Doug MacEachern E<lt>C<dougm@osf.org>E<gt>
-Based on ideas from Tim Bunce E<lt>F<Tim.Bunce@ig.co.uk>E<gt> and
-B<minimod.pl> by Andreas Koenig E<lt>F<k@anna.in-berlin.de>E<gt> and Tim Bunce.
+Based on ideas from Tim Bunce E<lt>C<Tim.Bunce@ig.co.uk>E<gt> and
+F<minimod.pl> by Andreas Koenig E<lt>C<k@anna.in-berlin.de>E<gt> and Tim Bunce.
=cut
-
https://perl5.git.perl.org / perl5.git / blobdiff