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

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

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

NNAAMMEE #

 ExtUtils::ParseXS - converts Perl XS code into C code

SSYYNNOOPPSSIISS #

   use ExtUtils::ParseXS;

   my $pxs = ExtUtils::ParseXS->new;
   $pxs->process_file( filename => 'foo.xs' );

   $pxs->process_file( filename => 'foo.xs',
                       output => 'bar.c',

‘C++’ => 1, #

                       typemap => 'path/to/typemap',
                       hiertype => 1,
                       except => 1,
                       versioncheck => 1,
                       linenumbers => 1,
                       optimize => 1,
                       prototypes => 1,
                     );

   # Legacy non-OO interface using a singleton:
   use ExtUtils::ParseXS qw(process_file);
   process_file( filename => 'foo.xs' );

DDEESSCCRRIIPPTTIIOONN #

 "ExtUtils::ParseXS" 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

EEXXPPOORRTT #

 None by default.  "process_file()" and/or "report_error_count()" may be
 exported upon request. Using the functional interface is discouraged.

MMEETTHHOODDSS #

 $pxs->nneeww(())
     Returns a new, empty XS parser/compiler object.

 $pxs->pprroocceessss__ffiillee(())
     This method processes an XS file and sends output to a C file.  The
     method may be called as a function (this is the legacy interface) and
     will then use a singleton as invocant.

     Named parameters control how the processing is done.  The following
     parameters are accepted:

     CC++++ Adds "extern "C"" to the C code.  Default is false.

     hhiieerrttyyppee
         Retains "::" in type names so that C++ hierarchical types can be
         mapped.  Default is false.

     eexxcceepptt
         Adds exception handling stubs to the C code.  Default is false.

     ttyyppeemmaapp
         Indicates that a user-supplied typemap should take precedence
         over the default typemaps.  A single typemap may be specified as
         a string, or multiple typemaps can be specified in an array
         reference, with the last typemap having the highest precedence.

     pprroottoottyyppeess
         Generates prototype code for all xsubs.  Default is false.

     vveerrssiioonncchheecckk
         Makes sure at run time that the object file (derived from the
         ".xs" file) and the ".pm" files have the same version number.
         Default is true.

     lliinneennuummbbeerrss
         Adds "#line" directives to the C output so error messages will
         look like they came from the original XS file.  Default is true.

     ooppttiimmiizzee
         Enables 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).  Not optimizing may significantly slow down the
         generated code, but this is the way xxssuubbpppp of 5.005 and earlier
         operated.  Default is to optimize.

     iinnoouutt
         Enable recognition of "IN", "OUT_LIST" and "INOUT_LIST"
         declarations.  Default is true.

     aarrggttyyppeess
         Enable recognition of ANSI-like descriptions of function
         signature.  Default is true.

     ss   _M_a_i_n_t_a_i_n_e_r _n_o_t_e_: I have no clue what this does.  Strips function
         prefixes?

 $pxs->rreeppoorrtt__eerrrroorr__ccoouunntt(())
     This method returns the number of [a certain kind of] errors
     encountered during processing of the XS file.

     The method may be called as a function (this is the legacy interface)
     and will then use a singleton as invocant.

AAUUTTHHOORR #

 Based on xsubpp code, written by Larry Wall.

 Maintained by:

 •   Ken Williams, <ken@mathforum.org>

 •   David Golden, <dagolden@cpan.org>

 •   James Keenan, <jkeenan@cpan.org>

 •   Steffen Mueller, <smueller@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2002-2014 by Ken Williams, David Golden and other contributors.
 All rights reserved.

 This library is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 Based on the "ExtUtils::xsubpp" code by Larry Wall and the Perl 5
 Porters, which was released under the same license terms.

SSEEEE AALLSSOO #

 perl, ExtUtils::xsubpp, ExtUtils::MakeMaker, perlxs, perlxstut.

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