compiler to convert Perl XS code into C code
Header "SYNOPSIS" xsubpp [ -v ][ -except ][ -s pattern ][ -prototypes ][ -noversioncheck ][ -nolinenumbers ][ -nooptimize ][ -typemap typemap ][ -output filename ]...file.xs
Header "DESCRIPTION" This compiler is typically run by the makefiles created by ExtUtils::MakeMaker or by Module::Build or other Perl module build tools.
xsubpp will compile XScode 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 typemap .It will use the following search path to find default typemaps, with the rightmost typemap taking precedence.
It will also use a default typemap installed as CW(C`ExtUtils::typemap (C' .
Header "OPTIONS" Note that the CW(C`XSOPT (C' MakeMaker option may be used to add these options to any makefiles generated by MakeMaker.
" -hiertype "5 Item "-hiertype" Retains '::' in type names so that (C+ hierarchical types can be mapped.
" -except "5 Item "-except" Adds exception handling stubs to the C code.
" -typemap typemap "5 Item "-typemap typemap" 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.
" -output filename "5 Item "-output filename" Specifies the name of the output file to generate. If no file is specified, output will be written to standard output.
" -v "5 Item "-v" Prints the xsubpp version number to standard output, then exits.
" -prototypes "5 Item "-prototypes" By default xsubpp will not automatically generate prototype code for all xsubs. This flag will enable prototypes.
" -noversioncheck "5 Item "-noversioncheck" Disables the run time test that determines if the object file (derived from the CW(C`.xs (C' file) and the CW(C`.pm (C' files have the same version number.
" -nolinenumbers "5 Item "-nolinenumbers" Prevents the inclusion of '#line' directives in the output.
" -nooptimize "5 Item "-nooptimize" Disables certain optimizations. The only optimization that is currently affected is the use of target sby the output C code (see perlguts). This may significantly slow down the generated code, but this is the way xsubpp of 5.005 and earlier operated.
" -noinout "5 Item "-noinout" Disable recognition of CW(C`IN (C' , CW(C`OUT_LIST (C' and CW(C`INOUT_LIST (C' declarations.
" -noargtypes "5 Item "-noargtypes" Disable recognition of ANSI-like descriptions of function signature.
" -(C+ "5 Item "-" 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.
" -s=... or -strip=... "5 Item "-s=... or -strip=..." Thisoption is obscure and discouraged. If specified, the given string will be stripped off from the beginning of the C function name in the generated XSfunctions (if it starts with that prefix). This only applies to XSUBs without CW(C`CODE (C' or CW(C`PPCODE (C' blocks. For example, the XS: 1 void foo_bar(int i); when CW(C`xsubpp (C' is invoked with CW(C` -s foo_ (C' will install a CW(C`foo_bar (C' function in Perl, but really call CWbar(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.
Header "ENVIRONMENT" No environment variables are used.
Header "MODIFICATION HISTORY" See the file Changes .
Header "SEE ALSO" perl(1), perlxs(1), perlxstut(1), ExtUtils::ParseXS
Header "AUTHOR" Originally by Larry Wall. Turned into the CW(C`ExtUtils::ParseXS (C' module by Ken Williams.