CONTENTS

• NAME
• SYNOPSIS
• DESCRIPTION
• @EXPORT
• FUNCTIONS
• EXAMPLES
• SEE ALSO
• AUTHOR

#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 interpreter and extensions in your C/C++ applications. Typically, an applicationMakefile will invokeExtUtils::Embed functions while building your application.

#@EXPORT

ExtUtils::Embed exports the following functions:

xsinit(), ldopts(), ccopts(), perl_inc(), ccflags(), ccdlflags(), xsi_header(), xsi_protos(), xsi_body()

#FUNCTIONS

#xsinit()

Generate C/C++ code for the XS initializer function.

When invoked as`perl -MExtUtils::Embed -e xsinit --` the following options are recognized:

-o <output filename> (Defaults toperlxsi.c)

-o STDOUT will print to STDOUT.

-std (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,

$filename is equivalent to the-o option.

$std is boolean, equivalent to the-std option.

[@modules] 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 anxs_init function that glues the perlSocket::bootstrap function to the Cboot_Socket function and writes it to a file namedxsinit.c.

Note thatDynaLoader is a special case where it must callboot_DynaLoader directly.

perl -MExtUtils::Embed -e xsinit

This will generate code for linking withDynaLoader and each static extension found in$Config{static_ext}. The code is written to the default file nameperlxsi.c.

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 forDBI andDBD::Oracle.

If you have a workingDynaLoader 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:

-std

Output arguments for linking the Perl library and any extensions linked with the current Perl.

-I <path1:path2>

Search path for ModuleName.a archives. Default path is@INC. Library archives are expected to be found as/some/path/auto/ModuleName/ModuleName.a For example, when looking forSocket.a relative to a search path, we should findauto/Socket/Socket.a

When looking forDBD::Oracle relative to a search path, we should findauto/DBD/Oracle/Oracle.a

Keep in mind that you can always supply/my/own/path/ModuleName.a as an additional linker argument.

-- <list of linker args>

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],[@link_args],$path)

Where:

$std is boolean, equivalent to the-std option.

[@modules] is equivalent to additional arguments found before the-- token.

[@link_args] is equivalent to arguments found after the-- token.

$path is equivalent to the-I 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 withlibperl and extensions found in$Config{static_ext}. This includes libraries found in$Config{libs} and the first ModuleName.a library for each extension that is found by searching@INC or the path specified by the-I option. In addition, when ModuleName.a is found, additional linker arguments are picked up from theextralibs.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 theSocket extension.

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.

#perl_inc()

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 perl_inc

#ccflags(), ccdlflags()

These functions simply print $Config{ccflags} and $Config{ccdlflags}

#ccopts()

This function combinesperl_inc(),ccflags() andccdlflags() into one.

#xsi_header()

This function simply returns a string defining the sameEXTERN_C macro asperlmain.c along with #includingperl.h andEXTERN.h.

#xsi_protos(@modules)

This function returns a string ofboot_$ModuleName prototypes for each @modules.

#xsi_body(@modules)

This function returns a string of calls tonewXS() that glue the modulebootstrap function toboot_ModuleName for each @modules.

xsinit() uses the xsi_* functions to generate most of its code.

#EXAMPLES

For examples on how to useExtUtils::Embed for building C/C++ applications with embedded perl, seeperlembed.

#SEE ALSO

perlembed

#AUTHOR

Doug MacEachern <dougm@osf.org>

Based on ideas from Tim Bunce <Tim.Bunce@ig.co.uk> andminimod.pl by Andreas Koenig <k@anna.in-berlin.de> and Tim Bunce.

Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.

The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.