module::build::api.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

.IP "\fIinstall_base_relpaths()\fR" 4
.IX Item "install_base_relpaths()"
.PD 0
.IP "install_base_relpaths($type)" 4
.IX Item "install_base_relpaths($type)"
.ie n .IP "install_base_relpaths($type => $path)" 4
.el .IP "install_base_relpaths($type => \f(CW$path\fR)" 4
.IX Item "install_base_relpaths($type => $path)"
.PD
[version 0.28]
.Sp
Set or retrieve the relative paths that are appended to
\&\f(CW\*(C`install_base\*(C'\fR for any installable element. This is useful if you
want to set the relative install path for custom build elements.
.Sp
With no argument, it returns a reference to a hash containing all
elements and their respective values. This hash should not be modified
directly; use the multi-argument below form to change values.
.Sp
The single argument form returns the value associated with the
element \f(CW$type\fR.
.Sp
The multi-argument form allows you to set the paths for element types.
\&\f(CW$value\fR must be a relative path using unix-like paths.  (A series of
directories seperated by slashes.  Eg 'foo/bar'.)  The return value is a
localized path based on \f(CW$value\fR.
.Sp
Assigning the value \f(CW\*(C`undef\*(C'\fR to an element causes it to be removed.
.IP "install_destination($type)" 4
.IX Item "install_destination($type)"
[version 0.28]
.Sp
Returns the directory in which items of type \f(CW$type\fR (e.g. \f(CW\*(C`lib\*(C'\fR,
\&\f(CW\*(C`arch\*(C'\fR, \f(CW\*(C`bin\*(C'\fR, or anything else returned by the \*(L"\fIinstall_types()\fR\*(R"
method) will be installed during the \f(CW\*(C`install\*(C'\fR action.  Any settings
for \f(CW\*(C`install_path\*(C'\fR, \f(CW\*(C`install_base\*(C'\fR, and \f(CW\*(C`prefix\*(C'\fR are taken into
account when determining the return value.
.IP "\fIinstall_path()\fR" 4
.IX Item "install_path()"
.PD 0
.IP "install_path($type)" 4
.IX Item "install_path($type)"
.ie n .IP "install_path($type => $path)" 4
.el .IP "install_path($type => \f(CW$path\fR)" 4
.IX Item "install_path($type => $path)"
.PD
[version 0.28]
.Sp
Set or retrieve paths for specific installable elements. This is
useful when you want to examine any explicit install paths specified
by the user on the command line, or if you want to set the install
path for a specific installable element based on another attribute
like \f(CW\*(C`install_base()\*(C'\fR.
.Sp
With no argument, it returns a reference to a hash containing all
elements and their respective values. This hash should not be modified
directly; use the multi-argument below form to change values.
.Sp
The single argument form returns the value associated with the
element \f(CW$type\fR.
.Sp
The multi-argument form allows you to set the paths for element types.
The supplied \f(CW$path\fR should be an absolute path to install elements
of \f(CW$type\fR.  The return value is \f(CW$path\fR.
.Sp
Assigning the value \f(CW\*(C`undef\*(C'\fR to an element causes it to be removed.
.IP "\fIinstall_types()\fR" 4
.IX Item "install_types()"
[version 0.28]
.Sp
Returns a list of installable types that this build knows about.
These types each correspond to the name of a directory in \fIblib/\fR,
and the list usually includes items such as \f(CW\*(C`lib\*(C'\fR, \f(CW\*(C`arch\*(C'\fR, \f(CW\*(C`bin\*(C'\fR,
\&\f(CW\*(C`script\*(C'\fR, \f(CW\*(C`libdoc\*(C'\fR, \f(CW\*(C`bindoc\*(C'\fR, and if \s-1HTML\s0 documentation is to be
built, \f(CW\*(C`libhtml\*(C'\fR and \f(CW\*(C`binhtml\*(C'\fR.  Other user-defined types may also
exist.
.IP "\fIinvoked_action()\fR" 4
.IX Item "invoked_action()"
[version 0.28]
.Sp
This is the name of the original action invoked by the user.  This
value is set when the user invokes \fIBuild.PL\fR, the \fIBuild\fR script,
or programatically through the \fIdispatch()\fR
method.  It does not change as sub-actions are executed as
dependencies are evaluated.
.Sp
To get the name of the currently executing dependency, see
\&\*(L"\fIcurrent_action()\fR\*(R" above.
.IP "\fInotes()\fR" 4
.IX Item "notes()"
.PD 0
.IP "notes($key)" 4
.IX Item "notes($key)"
.ie n .IP "notes($key => $value)" 4
.el .IP "notes($key => \f(CW$value\fR)" 4
.IX Item "notes($key => $value)"
.PD
[version 0.20]
.Sp
The \f(CW\*(C`notes()\*(C'\fR value allows you to store your own persistent
information about the build, and to share that information among
different entities involved in the build.  See the example in the
\&\f(CW\*(C`current()\*(C'\fR method.
.Sp
The \f(CW\*(C`notes()\*(C'\fR method is essentally a glorified hash access.  With no
arguments, \f(CW\*(C`notes()\*(C'\fR returns the entire hash of notes.  With one argument,
\&\f(CW\*(C`notes($key)\*(C'\fR returns the value associated with the given key.  With two
arguments, \f(CW\*(C`notes($key, $value)\*(C'\fR sets the value associated with the given key
to \f(CW$value\fR and returns the new value.
.Sp
The lifetime of the \f(CW\*(C`notes\*(C'\fR data is for \*(L"a build\*(R" \- that is, the
\&\f(CW\*(C`notes\*(C'\fR hash is created when \f(CW\*(C`perl Build.PL\*(C'\fR is run (or when the
\&\f(CW\*(C`new()\*(C'\fR method is run, if the Module::Build Perl \s-1API\s0 is being used
instead of called from a shell), and lasts until \f(CW\*(C`perl Build.PL\*(C'\fR is
run again or the \f(CW\*(C`clean\*(C'\fR action is run.
.IP "\fIorig_dir()\fR" 4
.IX Item "orig_dir()"
[version 0.28]
.Sp
Returns a string containing the working directory that was in effect
before the \fIBuild\fR script \fIchdir()\fR\-ed into the \f(CW\*(C`base_dir\*(C'\fR.  This
might be useful for writing wrapper tools that might need to \fIchdir()\fR
back out.
.IP "\fIos_type()\fR" 4
.IX Item "os_type()"
[version 0.04]
.Sp
If you're subclassing Module::Build and some code needs to alter its
behavior based on the current platform, you may only need to know
whether you're running on Windows, Unix, MacOS, \s-1VMS\s0, etc., and not the
fine-grained value of Perl's \f(CW$^O\fR variable.  The \f(CW\*(C`os_type()\*(C'\fR method
will return a string like \f(CW\*(C`Windows\*(C'\fR, \f(CW\*(C`Unix\*(C'\fR, \f(CW\*(C`MacOS\*(C'\fR, \f(CW\*(C`VMS\*(C'\fR, or
whatever is appropriate.  If you're running on an unknown platform, it
will return \f(CW\*(C`undef\*(C'\fR \- there shouldn't be many unknown platforms
though.
.IP "\fIis_vmsish()\fR" 4
.IX Item "is_vmsish()"
.PD 0
.IP "\fIis_windowsish()\fR" 4
.IX Item "is_windowsish()"
.IP "\fIis_unixish()\fR" 4
.IX Item "is_unixish()"
.PD
Convenience functions that return a boolean value indicating whether
this platform behaves respectively like \s-1VMS\s0, Windows, or Unix.  For
arbitrary reasons other platforms don't get their own such functions,
at least not yet.
.IP "\fIprefix_relpaths()\fR" 4
.IX Item "prefix_relpaths()"
.PD 0
.IP "prefix_relpaths($installdirs)" 4
.IX Item "prefix_relpaths($installdirs)"
.ie n .IP "prefix_relpaths($installdirs, $type)" 4
.el .IP "prefix_relpaths($installdirs, \f(CW$type\fR)" 4
.IX Item "prefix_relpaths($installdirs, $type)"
.ie n .IP "prefix_relpaths($installdirs, $type\fR => \f(CW$path)" 4
.el .IP "prefix_relpaths($installdirs, \f(CW$type\fR => \f(CW$path\fR)" 4
.IX Item "prefix_relpaths($installdirs, $type => $path)"
.PD
[version 0.28]
.Sp
Set or retrieve the relative paths that are appended to \f(CW\*(C`prefix\*(C'\fR for
any installable element.  This is useful if you want to set the
relative install path for custom build elements.
.Sp
With no argument, it returns a reference to a hash containing all
elements and their respective values as defined by the current
\&\f(CW\*(C`installdirs\*(C'\fR setting.
.Sp
With a single argument, it returns a reference to a hash containing
all elements and their respective values as defined by
\&\f(CW$installdirs\fR.
.Sp
The hash returned by the above calls should not be modified directly;
use the three-argument below form to change values.
.Sp
The two argument form returns the value associated with the
element \f(CW$type\fR.
.Sp
The multi-argument form allows you to set the paths for element types.
\&\f(CW$value\fR must be a relative path using unix-like paths.  (A series of
directories seperated by slashes.  Eg 'foo/bar'.)  The return value is a
localized path based on \f(CW$value\fR.
.Sp
Assigning the value \f(CW\*(C`undef\*(C'\fR to an element causes it to be removed.
.IP "\fIprepare_metadata()\fR" 4
.IX Item "prepare_metadata()"
[version 0.28]
.Sp
This method is provided for authors to override to customize the
fields of \fI\s-1META\s0.yml\fR.  It is passed a YAML::Node node object which can
be modified as desired and then returned.  E.g.
.Sp
.Vb 2
\&  package My::Builder;
\&  use base \*(AqModule::Build\*(Aq;
\&
\&  sub prepare_metadata {
\&    my $self = shift;
\&    my $node = $self\->SUPER::prepare_metadata( shift );
\&    $node\->{custom_field} = \*(Aqfoo\*(Aq;
\&    return $node;
\&  }
.Ve
.IP "\fIprereq_failures()\fR" 4
.IX Item "prereq_failures()"
[version 0.11]
.Sp
Returns a data structure containing information about any failed
prerequisites (of any of the types described above), or \f(CW\*(C`undef\*(C'\fR if
all prerequisites are met.
.Sp
The data structure returned is a hash reference.  The top level keys
are the type of prerequisite failed, one of \*(L"requires\*(R",
\&\*(L"build_requires\*(R", \*(L"conflicts\*(R", or \*(L"recommends\*(R".  The associated values
are hash references whose keys are the names of required (or
conflicting) modules.  The associated values of those are hash
references indicating some information about the failure.  For example:
.Sp
.Vb 5
\&  {
\&   have => \*(Aq0.42\*(Aq,
\&   need => \*(Aq0.59\*(Aq,
\&   message => \*(AqVersion 0.42 is installed, but we need version 0.59\*(Aq,
\&  }
.Ve
.Sp
or
.Sp
.Vb 5
\&  {
\&   have => \*(Aq<none>\*(Aq,
\&   need => \*(Aq0.59\*(Aq,
\&   message => \*(AqPrerequisite Foo isn\*(Aqt installed\*(Aq,
\&  }
.Ve
.Sp
This hash has the same structure as the hash returned by the
\&\f(CW\*(C`check_installed_status()\*(C'\fR method, except that in the case of
\&\*(L"conflicts\*(R" dependencies we change the \*(L"need\*(R" key to \*(L"conflicts\*(R" and
construct a proper message.
.Sp
Examples:
.Sp
.Vb 2
\&  # Check a required dependency on Foo::Bar
\&  if ( $build\->prereq_failures\->{requires}{Foo::Bar} ) { ...
\&
\&  # Check whether there were any failures
\&  if ( $build\->prereq_failures ) { ...
\&
\&  # Show messages for all failures
\&  my $failures = $build\->prereq_failures;
\&  while (my ($type, $list) = each %$failures) {
\&    while (my ($name, $hash) = each %$list) {
\&      print "Failure for $name: $hash\->{message}\en";
\&    }
\&  }
.Ve
.IP "\fIprereq_report()\fR" 4
.IX Item "prereq_report()"
[version 0.28]
.Sp
Returns a human-readable (table-form) string showing all
prerequisites, the versions required, and the versions actually
installed.  This can be useful for reviewing the configuration of your
system prior to a build, or when compiling data to send for a bug
report.  The \f(CW\*(C`prereq_report\*(C'\fR action is just a thin wrapper around the
\&\f(CW\*(C`prereq_report()\*(C'\fR method.
.ie n .IP "prompt($message, $default)" 4
.el .IP "prompt($message, \f(CW$default\fR)" 4
.IX Item "prompt($message, $default)"
[version 0.12]
.Sp
Asks the user a question and returns their response as a string.  The
first argument specifies the message to display to the user (for
example, \f(CW"Where do you keep your money?"\fR).  The second argument,
which is optional, specifies a default answer (for example,
\&\f(CW"wallet"\fR).  The user will be asked the question once.
.Sp
If \f(CW\*(C`prompt()\*(C'\fR detects that it is not running interactively and there
is nothing on \s-1STDIN\s0 or if the \s-1PERL_MM_USE_DEFAULT\s0 environment variable
is set to true, the \f(CW$default\fR will be used without prompting.
.Sp
To prevent automated processes from blocking, the user must either set
\&\s-1PERL_MM_USE_DEFAULT\s0 or attach something to \s-1STDIN\s0 (this can be a
pipe/file containing a scripted set of answers or /dev/null.)
.Sp
If no \f(CW$default\fR is provided an empty string will be used instead.  In
non-interactive mode, the absence of \f(CW$default\fR is an error (though
explicitly passing \f(CW\*(C`undef()\*(C'\fR as the default is valid as of 0.27.)
.Sp
This method may be called as a class or object method.
.IP "\fIrecommends()\fR" 4
.IX Item "recommends()"
[version 0.21]
.Sp
Returns a hash reference indicating the \f(CW\*(C`recommends\*(C'\fR prerequisites
that were passed to the \f(CW\*(C`new()\*(C'\fR method.
.IP "\fIrequires()\fR" 4
.IX Item "requires()"
[version 0.21]
.Sp
Returns a hash reference indicating the \f(CW\*(C`requires\*(C'\fR prerequisites that
were passed to the \f(CW\*(C`new()\*(C'\fR method.
.ie n .IP "rscan_dir($dir, $pattern)" 4
.el .IP "rscan_dir($dir, \f(CW$pattern\fR)" 4
.IX Item "rscan_dir($dir, $pattern)"
[version 0.28]
.Sp
Uses \f(CW\*(C`File::Find\*(C'\fR to traverse the directory \f(CW$dir\fR, returning a
reference to an array of entries matching \f(CW$pattern\fR.  \f(CW$pattern\fR
may either be a regular expression (using \f(CW\*(C`qr//\*(C'\fR or just a plain
string), or a reference to a subroutine that will return true for
wanted entries.  If \f(CW$pattern\fR is not giv