ExtUtils::Embed(3p) Perl Programmers Reference Guide ExtUtils::Embed(3p)

ExtUtils::Embed(3p) Perl Programmers Reference Guide ExtUtils::Embed(3p) #

ExtUtils::Embed(3p) Perl Programmers Reference Guide ExtUtils::Embed(3p)

NNAAMMEE #

 ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications

SSYYNNOOPPSSIISS #

  perl -MExtUtils::Embed -e xsinit
  perl -MExtUtils::Embed -e ccopts
  perl -MExtUtils::Embed -e ldopts

DDEESSCCRRIIPPTTIIOONN #

 "ExtUtils::Embed" provides utility functions for embedding a Perl
 interpreter and extensions in your C/C++ applications.  Typically, an
 application _M_a_k_e_f_i_l_e will invoke "ExtUtils::Embed" functions while
 building your application.

@@EEXXPPOORRTT #

 "ExtUtils::Embed" exports the following functions:

 xxssiinniitt(()), llddooppttss(()), ccccooppttss(()), ppeerrll__iinncc(()), ccccffllaaggss(()), ccccddllffllaaggss(()),
 xxssii__hheeaaddeerr(()), xxssii__pprroottooss(()), xxssii__bbooddyy(())

FFUUNNCCTTIIOONNSS #

 xxssiinniitt(())
     Generate C/C++ code for the XS initializer function.

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

     --oo <output filename> (Defaults to ppeerrllxxssii..cc)

     --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 "xs_init" function that glues the
     perl "Socket::bootstrap" function to the C "boot_Socket" function and
     writes it to a file named _x_s_i_n_i_t_._c.

     Note that DynaLoader is a special case where it must call
     "boot_DynaLoader" directly.

      perl -MExtUtils::Embed -e xsinit

     This will generate code for linking with "DynaLoader" and each static
     extension found in $Config{static_ext}.  The code is written to the
     default file name _p_e_r_l_x_s_i_._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 for "DBI" and "DBD::Oracle".

     If you have a working "DynaLoader" then there is rarely any need to
     statically link in any other extensions.

 llddooppttss(())
     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 <path1:path2>

     Search path for ModuleName.a archives.  Default path is @INC.
     Library archives are expected to be found as
     _/_s_o_m_e_/_p_a_t_h_/_a_u_t_o_/_M_o_d_u_l_e_N_a_m_e_/_M_o_d_u_l_e_N_a_m_e_._a For example, when looking for
     _S_o_c_k_e_t_._a relative to a search path, we should find
     _a_u_t_o_/_S_o_c_k_e_t_/_S_o_c_k_e_t_._a

     When looking for "DBD::Oracle" relative to a search path, we should
     find _a_u_t_o_/_D_B_D_/_O_r_a_c_l_e_/_O_r_a_c_l_e_._a

     Keep in mind that you can always supply _/_m_y_/_o_w_n_/_p_a_t_h_/_M_o_d_u_l_e_N_a_m_e_._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:

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

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

     [[@@lliinnkk__aarrggss]] 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 "libperl" 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 --II
     option.  In addition, when ModuleName.a is found, additional linker
     arguments are picked up from the _e_x_t_r_a_l_i_b_s_._l_d 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 "Socket" 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.

 ppeerrll__iinncc(())
     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

 ccccffllaaggss(()), ccccddllffllaaggss(())
     These functions simply print $Config{ccflags} and $Config{ccdlflags}

 ccccooppttss(())
     This function combines "perl_inc()", "ccflags()" and "ccdlflags()"
     into one.

 xxssii__hheeaaddeerr(())
     This function simply returns a string defining the same "EXTERN_C"
     macro as _p_e_r_l_m_a_i_n_._c along with #including _p_e_r_l_._h and _E_X_T_E_R_N_._h.

 xsi_protos(@modules)
     This function returns a string of "boot_$ModuleName" prototypes for
     each @modules.

 xsi_body(@modules)
     This function returns a string of calls to "newXS()" that glue the
     module _b_o_o_t_s_t_r_a_p function to _b_o_o_t___M_o_d_u_l_e_N_a_m_e for each @modules.

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

EEXXAAMMPPLLEESS #

 For examples on how to use "ExtUtils::Embed" for building C/C++
 applications with embedded perl, see perlembed.

SSEEEE AALLSSOO #

 perlembed

AAUUTTHHOORR #

 Doug MacEachern <"dougm@osf.org">

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

perl v5.36.3 2019-02-13 ExtUtils::Embed(3p)