ExtUtils::Embed(3pm) Perl Programmers Reference Guide ExtUtils::Embed(3pm)
NAME
ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications
SYNOPSIS
perl -MExtUtils::Embed -e xsinit
perl -MExtUtils::Embed -e ccopts
perl -MExtUtils::Embed -e ldopts
DESCRIPTION
ExtUtils::Embed provides utility functions for embedding a Perl inter-
preter and extensions in your C/C++ applications. Typically, an appli-
cation MMaakkeeffiillee will invoke ExtUtils::Embed functions while building
your application.
@@EEXXPPOORRTT
ExtUtils::Embed exports the following functions:
xsinit(), ldopts(), ccopts(), perlinc(), ccflags(), ccdlflags(),
xsiheader(), xsiprotos(), xsibody()
FFUUNNCCTTIIOONNSS
xsinit()
Generate C/C++ code for the XS initializer function.
When invoked as `perl -MExtUtils::Embed -e xsinit -` the following
options are recognized:
-oo
-oo SSTTDDOOUUTT will print to STDOUT.
-ssttdd (Write code for extensions that are linked with the current
Perl.)
Any additional arguments are expected to be names of modules to
generate code for.
When invoked with parameters the following are accepted and
optional:
"xsinit($filename,$std,[@modules])"
Where,
$$ffiilleennaammee is equivalent to the -oo option.
$$ssttdd is boolean, equivalent to the -ssttdd option.
[[@@mmoodduulleess]] is an array ref, same as additional arguments mentioned
above.
Examples
perl -MExtUtils::Embed -e xsinit - -o xsinit.c Socket
This will generate code with an xxssiinniitt function that glues the
perl SSoocckkeett::::bboooottssttrraapp function to the C bboooottSSoocckkeett function and
writes it to a file named xsinit.c.
Note that DDyynnaaLLooaaddeerr is a special case where it must call
bboooottDDyynnaaLLooaaddeerr directly.
perl -MExtUtils::Embed -e xsinit
This will generate code for linking with DDyynnaaLLooaaddeerr and each static
extension found in $$CCoonnffiigg{{ssttaattiicceexxtt}}. The code is written to the
default file name ppeerrllxxssii..cc.
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 DDBBII and DDBBDD::::OOrraaccllee.
If you have a working DDyynnaaLLooaaddeerr then there is rarely any need to
statically link in any other extensions.
ldopts()
Output arguments for linking the Perl library and extensions to
your application.
When invoked as `perl -MExtUtils::Embed -e ldopts -` the following
options are recognized:
-ssttdd
Output arguments for linking the Perl library and any extensions
linked with the current Perl.
-II
Search path for ModuleName.a archives. Default path is @@IINNCC.
Library archives are expected to be found as //ssoommee//ppaatthh//aauuttoo//MMoodduu-
lleeNNaammee//MMoodduulleeNNaammee..aa For example, when looking for SSoocckkeett..aa relative
to a search path, we should find aauuttoo//SSoocckkeett//SSoocckkeett..aa
When looking for DDBBDD::::OOrraaccllee relative to a search path, we should
find aauuttoo//DDBBDD//OOrraaccllee//OOrraaccllee..aa
Keep in mind that you can always supply //mmyy//oowwnn//ppaatthh//MMoodduulleeNNaammee..aa
as an additional linker argument.
--
Additional linker arguments to be considered.
Any additional arguments found before the -- token are expected to
be names of modules to generate code for.
When invoked with parameters the following are accepted and
optional:
"ldopts($std,[@modules],[@linkargs],$path)"
Where:
$$ssttdd is boolean, equivalent to the -ssttdd option.
[[@@mmoodduulleess]] is equivalent to additional arguments found before the
-- token.
[[@@lliinnkkaarrggss]] is equivalent to arguments found after the -- token.
$$ppaatthh is equivalent to the -II option.
In addition, when ldopts is called with parameters, it will return
the argument string rather than print it to STDOUT.
Examples
perl -MExtUtils::Embed -e ldopts
This will print arguments for linking with lliibbppeerrll..aa, DDyynnaaLLooaaddeerr
and extensions found in $$CCoonnffiigg{{ssttaattiicceexxtt}}. This includes
libraries found in $$CCoonnffiigg{{lliibbss}} and the first ModuleName.a library
for each extension that is found by searching @@IINNCC or the path
specified by the -II option. In addition, when ModuleName.a is
found, additional linker arguments are picked up from the eexxttrraall-
iibbss..lldd 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 SSoocckkeett extension.
perl -MExtUtils::Embed -e ldopts - DynaLoader
This will print arguments for linking with just the DDyynnaaLLooaaddeerr
extension and lliibbppeerrll..aa.
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 out-
put.
perlinc()
For including perl header files this function simply prints:
-I$Config{archlibexp}/CORE
So, rather than having to say:
perl -MConfig -e 'print "-I$Config{archlibexp}/CORE"'
Just say:
perl -MExtUtils::Embed -e perlinc
ccflags(), ccdlflags()
These functions simply print $Config{ccflags} and $Con-
fig{ccdlflags}
ccopts()
This function combines perlinc(), ccflags() and ccdlflags() into
one.
xsiheader()
This function simply returns a string defining the same EEXXTTEERRNNCC
macro as ppeerrllmmaaiinn..cc along with #including ppeerrll..hh and EEXXTTEERRNN..hh.
xsiprotos(@modules)
This function returns a string of bboooott$$MMoodduulleeNNaammee prototypes for
each @modules.
xsibody(@modules)
This function returns a string of calls to nneewwXXSS(()) that glue the
module bboooottssttrraapp function to bboooottMMoodduulleeNNaammee for each @modules.
xxssiinniitt(()) uses the xsi* functions to generate most of its code.
EEXXAAMMPPLLEESS
For examples on how to use EExxttUUttiillss::::EEmmbbeedd for building C/C++ applica-
tions with embedded perl, see perlembed.
SEE ALSO
perlembed
AUTHOR Doug MacEachern
Based on ideas from Tim Bunce and mmiinniimmoodd..ppll by
Andreas Koenig and Tim Bunce.
perl v5.8.8 2001-09-21 ExtUtils::Embed(3pm)