.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XSBuilder::WrapXS 3"
.TH XSBuilder::WrapXS 3 2024-07-13 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
ExtUtils::XSBuilder::WrapXS \- create perl XS wrappers for C functions
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
For more information, see ExtUtils::XSBuilder
.SS "new_parsesource (o)"
.IX Subsection "new_parsesource (o)"
Returns an array ref of new ParseSource objects for all source files that 
should be used to generate XS files
.SS "new_typemap (o)"
.IX Subsection "new_typemap (o)"
Returns a new typemap object
.SS "new_podtemplate (o)"
.IX Subsection "new_podtemplate (o)"
Returns a new podtemplate object
.SS "xs_includes (o)"
.IX Subsection "xs_includes (o)"
Returns a list of XS include files.
.PP
Default: use all include files that \f(CW\*(C`ParseSource::find_includes\*(C'\fR returns, but
strip path info
.SS "xs_glue_dirs (o)"
.IX Subsection "xs_glue_dirs (o)"
Returns a list of additional XS glue directories to seach for maps in.
.SS "xs_base_dir (o)"
.IX Subsection "xs_base_dir (o)"
Returns a directory which serves as a base for other directories.
.PP
Default: \f(CW\*(Aq.\*(Aq\fR
.SS "xs_map_dir (o)"
.IX Subsection "xs_map_dir (o)"
Returns the directory to search for map files in
.PP
Default: \f(CW\*(C`<xs_base_dir\*(C'\fR/xsbuilder/maps>
.SS "xs_incsrc_dir (o)"
.IX Subsection "xs_incsrc_dir (o)"
Returns the directory to search for files to include into the source. For
example, \f(CW\*(C`<xs_incsrc_dir\*(C'\fR/Apache/DAV/Resource/Resource_pm> will be included into
the \f(CW\*(C`Apache::DAV::Resource\*(C'\fR module.
.PP
Default: \f(CW\*(C`<xs_base_dir\*(C'\fR/xsbuilder>
.SS "xs_include_dir (o)"
.IX Subsection "xs_include_dir (o)"
Returns a directory to search for include files for pm and XS
.PP
Default: \f(CW\*(C`<xs_base_dir\*(C'\fR/xsinclude>
.SS "xs_target_dir (o)"
.IX Subsection "xs_target_dir (o)"
Returns the directory to write generated XS and header files in
.PP
Default: \f(CW\*(C`<xs_base_dir\*(C'\fR/xs>
.SS "makefilepl_text (o)"
.IX Subsection "makefilepl_text (o)"
Returns text for Makefile.PL
.SS "h_filename_prefix (o)"
.IX Subsection "h_filename_prefix (o)"
Defines a prefix for generated header files
.PP
Default: \f(CW\*(Aqxs_\*(Aq\fR
.SS "my_xs_prefix (o)"
.IX Subsection "my_xs_prefix (o)"
Defines a prefix used for all XS functions
.PP
Default: \f(CW\*(Aqxs_\*(Aq\fR
.SS "my_cnv_prefix (o)"
.IX Subsection "my_cnv_prefix (o)"
Defines a prefix used for all conversion functions/macros.
.PP
Default: \f(CW\*(C`my_xs_prefix\*(C'\fR
.SS "needs_prefix (o, name)"
.IX Subsection "needs_prefix (o, name)"
Returns true if the passed name should be prefixed
.SS "pm_text (o, module, isa, code)"
.IX Subsection "pm_text (o, module, isa, code)"
Returns the text of a \f(CW\*(C`.pm\*(C'\fR file, or undef if no \f(CW\*(C`.pm\*(C'\fR file should be
written.
.PP
Default: Create a \f(CW\*(C`.pm\*(C'\fR file which bootstraps the XS code
.SS "mapline_elem  (o, elem)"
.IX Subsection "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.
.PP
Default: returns the element unmodified
.SS "mapline_func  (o)"
.IX Subsection "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.
.PP
Default: returns the element unmodified