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

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

SYNOPSIS
       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,
			   die_on_error => 0,
			 );

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

DESCRIPTION
     "ExtUtils::ParseXS" will compile XS code into C code by embedding the con-
     structs 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 typemap.	 It will use the
     following search path to find default typemaps, with the rightmost typemap
     taking precedence.

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

EXPORT
     None by default.  process_file() and/or report_error_count() may be ex-
     ported upon request. Using the functional interface is discouraged.

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

     $pxs->process_file()
	 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 pa-
	 rameters are accepted:

	 filename
	     This is the full pathname of the XS file to open and process.
	     process_file() will normally chdir() to the basename of the file.

	     The filename may be a reference to a string, in which case the
	     lines of the string form the contents of the "input" file, using
	     the standard "open $fh, '<', \$string" mechanism.

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

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

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

	 typemap
	     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 refer-
	     ence, with the last typemap having the highest precedence.

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

	 versioncheck
	     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.

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

	 optimize
	     Enables certain optimizations.  The only optimization that is cur-
	     rently affected is the use of targets by the output C code (see
	     perlguts).	 Not optimizing may significantly slow down the gener-
	     ated code, but this is the way xsubpp of 5.005 and earlier oper-
	     ated.  Default is to optimize.

	 inout
	     Enable recognition of "IN", "OUT_LIST" and "INOUT_LIST" declara-
	     tions.  Default is true.

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

	 s   Maintainer note: I have no clue what this does.  Strips function
	     prefixes?

	 die_on_error
	     Normally ExtUtils::ParseXS will terminate the program with an
	     exit(1) after printing the details of the exception to STDERR via
	     (warn). This can be awkward when it is used programmatically and
	     not via xsubpp, so this option can be used to cause it to die in-
	     stead by providing a true value. When not provided this defaults to
	     the value of $ExtUtils::ParseXS::DIE_ON_ERROR which in turn de-
	     faults to false.

     $pxs->report_error_count()
	 This method returns the number of [a certain kind of] errors encoun-
	 tered 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.

AUTHOR
     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>

COPYRIGHT
     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 un-
     der 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.

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

perl v5.44.0			   2026-05-14		    ExtUtils::ParseXS(3)