extutils::xsbuilder::wrapxs(3pm) [debian man page]
XSBuilder::WrapXS(3pm) User Contributed Perl Documentation XSBuilder::WrapXS(3pm) NAME
ExtUtils::XSBuilder::WrapXS - create perl XS wrappers for C functions DESCRIPTION For more information, see ExtUtils::XSBuilder new_parsesource (o) Returns an array ref of new ParseSource objects for all source files that should be used to generate XS files new_typemap (o) Returns a new typemap object new_podtemplate (o) Returns a new podtemplate object xs_includes (o) Returns a list of XS include files. Default: use all include files that "ParseSource::find_includes" returns, but strip path info xs_glue_dirs (o) Returns a list of additional XS glue directories to seach for maps in. xs_base_dir (o) Returns a directory which serves as a base for other directories. Default: '.' xs_map_dir (o) Returns the directory to search for map files in Default: "<xs_base_dir"/xsbuilder/maps> xs_incsrc_dir (o) Returns the directory to search for files to include into the source. For example, "<xs_incsrc_dir"/Apache/DAV/Resource/Resource_pm> will be included into the "Apache::DAV::Resource" module. Default: "<xs_base_dir"/xsbuilder> xs_include_dir (o) Returns a directory to search for include files for pm and XS Default: "<xs_base_dir"/xsinclude> xs_target_dir (o) Returns the directory to write generated XS and header files in Default: "<xs_base_dir"/xs> makefilepl_text (o) Returns text for Makefile.PL h_filename_prefix (o) Defines a prefix for generated header files Default: 'xs_' my_xs_prefix (o) Defines a prefix used for all XS functions Default: 'xs_' my_cnv_prefix (o) Defines a prefix used for all conversion functions/macros. Default: "my_xs_prefix" needs_prefix (o, name) Returns true if the passed name should be prefixed pm_text (o, module, isa, code) Returns the text of a ".pm" file, or undef if no ".pm" file should be written. Default: Create a ".pm" file which bootstraps the XS code mapline_elem (o, elem) Called for each structure element that is written to the map file by checkmaps. Allows the user to change the element name, for example adding a different perl name. Default: returns the element unmodified mapline_func (o) Called for each function that is written to the map file by checkmaps. Allows the user to change the function name, for example adding a different perl name. Default: returns the element unmodified perl v5.10.1 2010-02-09 XSBuilder::WrapXS(3pm)
Check Out this Related Man Page
ExtUtils::ParseXS(3pm) Perl Programmers Reference Guide ExtUtils::ParseXS(3pm) NAME
ExtUtils::ParseXS - converts Perl XS code into C code SYNOPSIS
use ExtUtils::ParseXS qw(process_file); process_file( filename => 'foo.xs' ); process_file( filename => 'foo.xs', output => 'bar.c', 'C++' => 1, typemap => 'path/to/typemap', hiertype => 1, except => 1, prototypes => 1, versioncheck => 1, linenumbers => 1, optimize => 1, prototypes => 1, ); =head1 DESCRIPTION "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 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()" may be exported upon request. FUNCTIONS
process_xs() This function processes an XS file and sends output to a C file. Named parameters control how the processing is done. The following parameters are accepted: C++ Adds "extern "C"" to the C code. Default is false. hiertype Retains "::" in type names so that C++ hierachical 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 reference, 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 currently affected is the use of targets by the output C code (see perlguts). Not optimizing may significantly slow down the generated code, but this is the way xsubpp of 5.005 and earlier operated. Default is to optimize. inout Enable recognition of "IN", "OUT_LIST" and "INOUT_LIST" declarations. Default is true. argtypes Enable recognition of ANSI-like descriptions of function signature. Default is true. s I have no clue what this does. Strips function prefixes? errors() This function returns the number of [a certain kind of] errors encountered during processing of the XS file. AUTHOR
Based on xsubpp code, written by Larry Wall. Maintained by: o Ken Williams, <ken@mathforum.org> o David Golden, <dagolden@cpan.org> COPYRIGHT
Copyright 2002-2009 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. SEE ALSO
perl, ExtUtils::xsubpp, ExtUtils::MakeMaker, perlxs, perlxstut. perl v5.12.1 2010-05-13 ExtUtils::ParseXS(3pm)