.\" -*- 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 "Module::Build::Pluggable::Base 3pm"
.TH Module::Build::Pluggable::Base 3pm 2024-03-07 "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
Module::Build::Pluggable::Base \- Base object for plugins
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    package My::Module::Build::Plugin;
\&    use parent qw/Module::Build::Pluggable::Base/;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a abstract base class for Module::Build::Pluggable.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "$self\->\fBbuilder_class()\fR : Str" 4
.el .IP "\f(CW$self\fR\->\fBbuilder_class()\fR : Str" 4
.IX Item "$self->builder_class() : Str"
Get a class name for Module::Build's subclass.
.Sp
You cannot call this method in \f(CW\*(C`HOOK_prepare\*(C'\fR and \fBHOOK_configure\fR phase.
.ie n .IP "$self\->add_before_action_modifier($action_name: Str, $callback: Code)" 4
.el .IP "\f(CW$self\fR\->add_before_action_modifier($action_name: Str, \f(CW$callback:\fR Code)" 4
.IX Item "$self->add_before_action_modifier($action_name: Str, $callback: Code)"
.Vb 1
\&    $self\->add_before_action_modifier(\*(Aqbuild\*(Aq => \e&code);
.Ve
.Sp
Add a 'before' action method modifier.
.Sp
You need to call this method in \f(CW\*(C`HOOK_build\*(C'\fR phase.
.ie n .IP "$self\->add_around_action_modifier($action_name: Str, $callback: Code)" 4
.el .IP "\f(CW$self\fR\->add_around_action_modifier($action_name: Str, \f(CW$callback:\fR Code)" 4
.IX Item "$self->add_around_action_modifier($action_name: Str, $callback: Code)"
.Vb 1
\&    $self\->add_around_action_modifier(\*(Aqbuild\*(Aq => \e&code);
.Ve
.Sp
Add a 'around' action method modifier.
.Sp
You need to call this method in \f(CW\*(C`HOOK_build\*(C'\fR phase.
.ie n .IP "$self\->add_action($action_name: Str, $callback: Code)" 4
.el .IP "\f(CW$self\fR\->add_action($action_name: Str, \f(CW$callback:\fR Code)" 4
.IX Item "$self->add_action($action_name: Str, $callback: Code)"
Add a new action for Module::Build.
.Sp
You need to call this method in \f(CW\*(C`HOOK_build\*(C'\fR phase.
.ie n .IP "$self\->build_requires($module_name:Str[, $version:Str])" 4
.el .IP "\f(CW$self\fR\->build_requires($module_name:Str[, \f(CW$version:Str\fR])" 4
.IX Item "$self->build_requires($module_name:Str[, $version:Str])"
Add a build dependencies.
.Sp
You need to call this method in \f(CW\*(C`HOOK_configure\*(C'\fR phase.
.ie n .IP "$self\->configure_requires($module_name:Str[, $version:Str])" 4
.el .IP "\f(CW$self\fR\->configure_requires($module_name:Str[, \f(CW$version:Str\fR])" 4
.IX Item "$self->configure_requires($module_name:Str[, $version:Str])"
Add a configure dependencies.
.Sp
You need to call this method in \f(CW\*(C`HOOK_configure\*(C'\fR phase.
.ie n .IP """$self\->log_info($msg: Str)""" 4
.el .IP "\f(CW$self\->log_info($msg: Str)\fR" 4
.IX Item "$self->log_info($msg: Str)"
Output log in INFO level.
.ie n .IP """$self\->log_warn($msg: Str)""" 4
.el .IP "\f(CW$self\->log_warn($msg: Str)\fR" 4
.IX Item "$self->log_warn($msg: Str)"
Output log in WARN level.