.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "Module::Build::XSUtil 3pm"
.TH Module::Build::XSUtil 3pm 2024-09-01 "perl v5.40.0" "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
Module::Build::XSUtil \- A Module::Build class for building XS modules
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Use in your Build.PL
.PP
.Vb 3
\&    use strict;
\&    use warnings;
\&    use Module::Build::XSUtil;
\&    
\&    my $builder = Module::Build::XSUtil\->new(
\&        dist_name            => \*(AqYour\-XS\-Module\*(Aq,
\&        license              => \*(Aqperl\*(Aq,
\&        dist_author          => \*(AqYour Name <yourname@example.com>\*(Aq,
\&        dist_version_from    => \*(Aqlib/Your/XS/Module\*(Aq,
\&        generate_ppport_h    => \*(Aqlib/Your/XS/ppport.h\*(Aq,
\&        generate_xshelper_h  => \*(Aqlib/Your/XS/xshelper.h\*(Aq,
\&        needs_compiler_c99   => 1,
\&    );
\&    
\&    $builder\->create_build_script();
.Ve
.PP
Use in custom builder module.
.PP
.Vb 4
\&    package builder::MyBuilder;
\&    use strict;
\&    use warnings;
\&    use base \*(AqModule::Build::XSUtil\*(Aq;
\&    
\&    sub new {
\&        my ($class, %args) = @_;
\&        my $self = $class\->SUPER::new(
\&            %args,
\&            generate_ppport_h    => \*(Aqlib/Your/XS/ppport.h\*(Aq,
\&            generate_xshelper_h  => \*(Aqlib/Your/XS/xshelper.h\*(Aq,
\&            needs_compiler_c99   => 1,
\&        );
\&        return $self;
\&    }
\&    
\&    1;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Module::Build::XSUtil is subclass of Module::Build for support building XS modules.
.PP
This is a list of a new parameters in the Module::Build::new method:
.IP needs_compiler_c99 4
.IX Item "needs_compiler_c99"
This option checks C99 compiler's availability. If it's not available, Build.PL exits by 0.
.IP needs_compiler_cpp 4
.IX Item "needs_compiler_cpp"
This option checks C++ compiler's availability. If it's not available, Build.PL exits by 0.
.Sp
In addition, append 'extra_compiler_flags' and 'extra_linker_flags' for C++.
.IP generate_ppport_h 4
.IX Item "generate_ppport_h"
Genereate ppport.h by Devel::PPPort.
.IP generate_xshelper_h 4
.IX Item "generate_xshelper_h"
Genereate xshelper.h which is a helper header file to include EXTERN.h, perl.h, XSUB.h and ppport.h, 
and defines some portability stuff which are not supported by ppport.h.
.Sp
It is porting from Module::Install::XSUtil.
.IP cc_warnings 4
.IX Item "cc_warnings"
Enable compiler warnings flag. It is enable by default.
.IP "\-g options" 4
.IX Item "-g options"
If invoke Build.PL with '\-g' option, It will build with debug options.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Module::Install::XSUtil
.SH LICENSE
.IX Header "LICENSE"
Copyright (C) Hideaki Ohno.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH AUTHOR
.IX Header "AUTHOR"
Hideaki Ohno <hide.o.j55 {at} gmail.com>