XSUBPP(1) Perl Programmers Reference Guide XSUBPP(1)

XSUBPP(1) Perl Programmers Reference Guide XSUBPP(1) #

XSUBPP(1) Perl Programmers Reference Guide XSUBPP(1)

NNAAMMEE #

 xsubpp - compiler to convert Perl XS code into C code

SSYYNNOOPPSSIISS #

 xxssuubbpppp [--vv] [--eexxcceepptt] [--ss ppaatttteerrnn] [--pprroottoottyyppeess] [--nnoovveerrssiioonncchheecckk]
 [--nnoolliinneennuummbbeerrss] [--nnooooppttiimmiizzee] [--ttyyppeemmaapp ttyyppeemmaapp] [--oouuttppuutt ffiilleennaammee]...
 file.xs

DDEESSCCRRIIPPTTIIOONN #

 This compiler is typically run by the makefiles created by
 ExtUtils::MakeMaker or by Module::Build or other Perl module build tools.

 _x_s_u_b_p_p will compile XS code into C code by embedding the constructs
 necessary to let C functions manipulate Perl values and creates the glue
 necessary to let Perl access those functions.  The compiler uses typemaps
 to determine how to map C function parameters and variables to Perl
 values.

 The compiler will search for typemap files called _t_y_p_e_m_a_p.  It will use
 the following search path to find default typemaps, with the rightmost
 typemap taking precedence.

         ../../../typemap:../../typemap:../typemap:typemap

 It will also use a default typemap installed as "ExtUtils::typemap".

OOPPTTIIOONNSS #

 Note that the "XSOPT" MakeMaker option may be used to add these options
 to any makefiles generated by MakeMaker.

 --hhiieerrttyyppee
      Retains '::' in type names so that C++ hierarchical types can be
      mapped.

 --eexxcceepptt
      Adds exception handling stubs to the C code.

 --ttyyppeemmaapp ttyyppeemmaapp
      Indicates that a user-supplied typemap should take precedence over
      the default typemaps.  This option may be used multiple times, with
      the last typemap having the highest precedence.

 --oouuttppuutt ffiilleennaammee
      Specifies the name of the output file to generate.  If no file is
      specified, output will be written to standard output.

 --vv   Prints the _x_s_u_b_p_p version number to standard output, then exits.

 --pprroottoottyyppeess
      By default _x_s_u_b_p_p will not automatically generate prototype code for
      all xsubs. This flag will enable prototypes.

 --nnoovveerrssiioonncchheecckk
      Disables the run time test that determines if the object file
      (derived from the ".xs" file) and the ".pm" files have the same
      version number.

 --nnoolliinneennuummbbeerrss
      Prevents the inclusion of '#line' directives in the output.

 --nnooooppttiimmiizzee
      Disables certain optimizations.  The only optimization that is
      currently affected is the use of _t_a_r_g_e_ts by the output C code (see
      perlguts).  This may significantly slow down the generated code, but
      this is the way xxssuubbpppp of 5.005 and earlier operated.

 --nnooiinnoouutt
      Disable recognition of "IN", "OUT_LIST" and "INOUT_LIST"
      declarations.

 --nnooaarrggttyyppeess
      Disable recognition of ANSI-like descriptions of function signature.

 --CC++++ Currently doesn't do anything at all.  This flag has been a no-op
      for many versions of perl, at least as far back as perl5.003_07.
      It's allowed here for backwards compatibility.

 --ss==...... or --ssttrriipp==......
      _T_h_i_s _o_p_t_i_o_n _i_s _o_b_s_c_u_r_e _a_n_d _d_i_s_c_o_u_r_a_g_e_d_.

      If specified, the given string will be stripped off from the
      beginning of the C function name in the generated XS functions (if
      it starts with that prefix).  This only applies to XSUBs without
      "CODE" or "PPCODE" blocks.  For example, the XS:

        void foo_bar(int i);

      when "xsubpp" is invoked with "-s foo_" will install a "foo_bar"
      function in Perl, but really call bar(i) in C. Most of the time,
      this is the opposite of what you want and failure modes are somewhat
      obscure, so please avoid this option where possible.

EENNVVIIRROONNMMEENNTT #

 No environment variables are used.

AAUUTTHHOORR #

 Originally by Larry Wall.  Turned into the "ExtUtils::ParseXS" module by
 Ken Williams.

MMOODDIIFFIICCAATTIIOONN HHIISSTTOORRYY #

 See the file _C_h_a_n_g_e_s.

SSEEEE AALLSSOO #

 ppeerrll(1), ppeerrllxxss(1), ppeerrllxxssttuutt(1), ExtUtils::ParseXS

perl v5.36.3 2024-03-20 XSUBPP(1)