This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c7b8cbf83b0948ad881be786994874f691a919b5
[perl5.git] / lib / Module / Build / API.pod
1 =head1 NAME
2
3 Module::Build::API - API Reference for Module Authors
4
5
6 =head1 DESCRIPTION
7
8 I list here some of the most important methods in C<Module::Build>.
9 Normally you won't need to deal with these methods unless you want to
10 subclass C<Module::Build>.  But since one of the reasons I created
11 this module in the first place was so that subclassing is possible
12 (and easy), I will certainly write more docs as the interface
13 stabilizes.
14
15
16 =head2 CONSTRUCTORS
17
18 =over 4
19
20 =item current()
21
22 [version 0.20]
23
24 This method returns a reasonable facsimile of the currently-executing
25 C<Module::Build> object representing the current build.  You can use
26 this object to query its C<notes()> method, inquire about installed
27 modules, and so on.  This is a great way to share information between
28 different parts of your build process.  For instance, you can ask
29 the user a question during C<perl Build.PL>, then use their answer
30 during a regression test:
31
32   # In Build.PL:
33   my $color = $build->prompt("What is your favorite color?");
34   $build->notes(color => $color);
35
36   # In t/colortest.t:
37   use Module::Build;
38   my $build = Module::Build->current;
39   my $color = $build->notes('color');
40   ...
41
42 The way the C<current()> method is currently implemented, there may be
43 slight differences between the C<$build> object in Build.PL and the
44 one in C<t/colortest.t>.  It is our goal to minimize these differences
45 in future releases of Module::Build, so please report any anomalies
46 you find.
47
48 One important caveat: in its current implementation, C<current()> will
49 B<NOT> work correctly if you have changed out of the directory that
50 C<Module::Build> was invoked from.
51
52 =item new()
53
54 [version 0.03]
55
56 Creates a new Module::Build object.  Arguments to the new() method are
57 listed below.  Most arguments are optional, but you must provide
58 either the C<module_name> argument, or C<dist_name> and one of
59 C<dist_version> or C<dist_version_from>.  In other words, you must
60 provide enough information to determine both a distribution name and
61 version.
62
63
64 =over 4
65
66 =item add_to_cleanup
67
68 [version 0.19]
69
70 An array reference of files to be cleaned up when the C<clean> action
71 is performed.  See also the add_to_cleanup() method.
72
73 =item auto_features
74
75 [version 0.26]
76
77 This parameter supports the setting of features (see
78 L<feature($name)>) automatically based on a set of prerequisites.  For
79 instance, for a module that could optionally use either MySQL or
80 PostgreSQL databases, you might use C<auto_features> like this:
81
82   my $build = Module::Build->new
83     (
84      ...other stuff here...
85      auto_features => {
86        pg_support    => {
87                          description => "Interface with Postgres databases",
88                          requires    => { 'DBD::Pg' => 23.3,
89                                           'DateTime::Format::Pg' => 0 },
90                         },
91        mysql_support => {
92                          description => "Interface with MySQL databases",
93                          requires    => { 'DBD::mysql' => 17.9,
94                                           'DateTime::Format::MySQL' => 0 },
95                         },
96      }
97     );
98
99 For each feature named, the required prerequisites will be checked, and
100 if there are no failures, the feature will be enabled (set to C<1>).
101 Otherwise the failures will be displayed to the user and the feature
102 will be disabled (set to C<0>).
103
104 See the documentation for L<requires> for the details of how
105 requirements can be specified.
106
107 =item autosplit
108
109 [version 0.04]
110
111 An optional C<autosplit> argument specifies a file which should be run
112 through the C<Autosplit::autosplit()> function.  If multiple files
113 should be split, the argument may be given as an array of the files to
114 split.
115
116 In general I don't consider autosplitting a great idea, because it's
117 not always clear that autosplitting achieves its intended performance
118 benefits.  It may even harm performance in environments like mod_perl,
119 where as much as possible of a module's code should be loaded during
120 startup.
121
122 =item build_class
123
124 [version 0.28]
125
126 The Module::Build class or subclass to use in the build
127 script.  Defaults to "Module::Build" or the class name passed to or
128 created by a call to C<subclass()>.  This property is useful if you're
129 writing a custom Module::Build subclass and have a bootstrapping
130 problem--that is, your subclass requires modules that may not be
131 installed when C<perl Build.PL> is executed, but you've listed in
132 C<build_requires> so that they should be available when C<./Build> is
133 executed.
134
135 =item build_requires
136
137 [version 0.07]
138
139 Modules listed in this section are necessary to build and install the
140 given module, but are not necessary for regular usage of it.  This is
141 actually an important distinction - it allows for tighter control over
142 the body of installed modules, and facilitates correct dependency
143 checking on binary/packaged distributions of the module.
144
145 See the documentation for L<Module::Build::Authoring/"PREREQUISITES">
146 for the details of how requirements can be specified.
147
148 =item create_packlist
149
150 [version 0.28]
151
152 If true, this parameter tells Module::Build to create a F<.packlist>
153 file during the C<install> action, just like ExtUtils::MakeMaker does.
154 The file is created in a subdirectory of the C<arch> installation
155 location.  It is used by some other tools (CPAN, CPANPLUS, etc.) for
156 determining what files are part of an install.
157
158 The default value is true.  This parameter was introduced in
159 Module::Build version 0.2609; previously no packlists were ever
160 created by Module::Build.
161
162 =item c_source
163
164 [version 0.04]
165
166 An optional C<c_source> argument specifies a directory which contains
167 C source files that the rest of the build may depend on.  Any C<.c>
168 files in the directory will be compiled to object files.  The
169 directory will be added to the search path during the compilation and
170 linking phases of any C or XS files.
171
172 =item conflicts
173
174 [version 0.07]
175
176 Modules listed in this section conflict in some serious way with the
177 given module.  C<Module::Build> (or some higher-level tool) will
178 refuse to install the given module if the given module/version is also
179 installed.
180
181 See the documentation for L<Module::Build::Authoring/"PREREQUISITES">
182 for the details of how requirements can be specified.
183
184 =item create_makefile_pl
185
186 [version 0.19]
187
188 This parameter lets you use Module::Build::Compat during the
189 C<distdir> (or C<dist>) action to automatically create a Makefile.PL
190 for compatibility with ExtUtils::MakeMaker.  The parameter's value
191 should be one of the styles named in the Module::Build::Compat
192 documentation.
193
194 =item create_readme
195
196 [version 0.22]
197
198 This parameter tells Module::Build to automatically create a F<README>
199 file at the top level of your distribution.  Currently it will simply
200 use C<Pod::Text> (or C<Pod::Readme> if it's installed) on the file
201 indicated by C<dist_version_from> and put the result in the F<README>
202 file.  This is by no means the only recommended style for writing a
203 README, but it seems to be one common one used on the CPAN.
204
205 If you generate a F<README> in this way, it's probably a good idea to
206 create a separate F<INSTALL> file if that information isn't in the
207 generated F<README>.
208
209 =item dist_abstract
210
211 [version 0.20]
212
213 This should be a short description of the distribution.  This is used
214 when generating metadata for F<META.yml> and PPD files.  If it is not
215 given then C<Module::Build> looks in the POD of the module from which
216 it gets the distribution's version.  It looks for the first line
217 matching C<$package\s-\s(.+)>, and uses the captured text as the
218 abstract.
219
220 =item dist_author
221
222 [version 0.20]
223
224 This should be something like "John Doe <jdoe@example.com>", or if
225 there are multiple authors, an anonymous array of strings may be
226 specified.  This is used when generating metadata for F<META.yml> and
227 PPD files.  If this is not specified, then C<Module::Build> looks at
228 the module from which it gets the distribution's version.  If it finds
229 a POD section marked "=head1 AUTHOR", then it uses the contents of
230 this section.
231
232 =item dist_name
233
234 [version 0.11]
235
236 Specifies the name for this distribution.  Most authors won't need to
237 set this directly, they can use C<module_name> to set C<dist_name> to
238 a reasonable default.  However, some agglomerative distributions like
239 C<libwww-perl> or C<bioperl> have names that don't correspond directly
240 to a module name, so C<dist_name> can be set independently.
241
242 =item dist_version
243
244 [version 0.11]
245
246 Specifies a version number for the distribution.  See C<module_name>
247 or C<dist_version_from> for ways to have this set automatically from a
248 C<$VERSION> variable in a module.  One way or another, a version
249 number needs to be set.
250
251 =item dist_version_from
252
253 [version 0.11]
254
255 Specifies a file to look for the distribution version in.  Most
256 authors won't need to set this directly, they can use C<module_name>
257 to set it to a reasonable default.
258
259 The version is extracted from the specified file according to the same
260 rules as C<ExtUtils::MakeMaker> and C<CPAN.pm>.  It involves finding
261 the first line that matches the regular expression
262
263    /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
264
265 eval()-ing that line, then checking the value of the C<$VERSION>
266 variable.  Quite ugly, really, but all the modules on CPAN depend on
267 this process, so there's no real opportunity to change to something
268 better.
269
270 =item dynamic_config
271
272 [version 0.07]
273
274 A boolean flag indicating whether the F<Build.PL> file must be
275 executed, or whether this module can be built, tested and installed
276 solely from consulting its metadata file.  The main reason to set this
277 to a true value is that your module performs some dynamic
278 configuration as part of its build/install process.  If the flag is
279 omitted, the F<META.yml> spec says that installation tools should
280 treat it as 1 (true), because this is a safer way to behave.
281
282 Currently C<Module::Build> doesn't actually do anything with this flag
283 - it's up to higher-level tools like C<CPAN.pm> to do
284 something useful with it.  It can potentially bring lots of security,
285 packaging, and convenience improvements.
286
287 =item extra_compiler_flags
288
289 =item extra_linker_flags
290
291 [version 0.19]
292
293 These parameters can contain array references (or strings, in which
294 case they will be split into arrays) to pass through to the compiler
295 and linker phases when compiling/linking C code.  For example, to tell
296 the compiler that your code is C++, you might do:
297
298   my $build = Module::Build->new
299     (
300      module_name          => 'Foo::Bar',
301      extra_compiler_flags => ['-x', 'c++'],
302     );
303
304 To link your XS code against glib you might write something like:
305
306   my $build = Module::Build->new
307     (
308      module_name          => 'Foo::Bar',
309      dynamic_config       => 1,
310      extra_compiler_flags => scalar `glib-config --cflags`,
311      extra_linker_flags   => scalar `glib-config --libs`,
312     );
313
314 =item get_options
315
316 [version 0.26]
317
318 You can pass arbitrary command line options to F<Build.PL> or
319 F<Build>, and they will be stored in the Module::Build object and can
320 be accessed via the C<args()> method.  However, sometimes you want
321 more flexibility out of your argument processing than this allows.  In
322 such cases, use the C<get_options> parameter to pass in a hash
323 reference of argument specifications, and the list of arguments to
324 F<Build.PL> or F<Build> will be processed according to those
325 specifications before they're passed on to C<Module::Build>'s own
326 argument processing.
327
328 The supported option specification hash keys are:
329
330
331 =over 4
332
333 =item type
334
335 The type of option.  The types are those supported by Getopt::Long; consult
336 its documentation for a complete list.  Typical types are C<=s> for strings,
337 C<+> for additive options, and C<!> for negatable options.  If the
338 type is not specified, it will be considered a boolean, i.e. no
339 argument is taken and a value of 1 will be assigned when the option is
340 encountered.
341
342 =item store
343
344 A reference to a scalar in which to store the value passed to the option.
345 If not specified, the value will be stored under the option name in the
346 hash returned by the C<args()> method.
347
348 =item default
349
350 A default value for the option.  If no default value is specified and no option
351 is passed, then the option key will not exist in the hash returned by
352 C<args()>.
353
354 =back
355
356
357 You can combine references to your own variables or subroutines with
358 unreferenced specifications, for which the result will also be stored in the
359 hash returned by C<args()>.  For example:
360
361   my $loud = 0;
362   my $build = Module::Build->new
363     (
364      module_name => 'Foo::Bar',
365      get_options => {
366                      loud =>     { store => \$loud },
367                      dbd  =>     { type  => '=s'   },
368                      quantity => { type  => '+'    },
369                     }
370     );
371
372   print STDERR "HEY, ARE YOU LISTENING??\n" if $loud;
373   print "We'll use the ", $build->args('dbd'), " DBI driver\n";
374   print "Are you sure you want that many?\n"
375     if $build->args('quantity') > 2;
376
377 The arguments for such a specification can be called like so:
378
379   perl Build.PL --loud --dbd=DBD::pg --quantity --quantity --quantity
380
381 B<WARNING:> Any option specifications that conflict with Module::Build's own
382 options (defined by its properties) will throw an exception.
383
384 Consult the Getopt::Long documentation for details on its usage.
385
386 =item include_dirs
387
388 [version 0.24]
389
390 Specifies any additional directories in which to search for C header
391 files.  May be given as a string indicating a single directory, or as
392 a list reference indicating multiple directories.
393
394 =item install_path
395
396 [version 0.19]
397
398 You can set paths for individual installable elements by using the
399 C<install_path> parameter:
400
401   my $build = Module::Build->new
402     (
403      ...other stuff here...
404      install_path => {
405                       lib  => '/foo/lib',
406                       arch => '/foo/lib/arch',
407                      }
408     );
409
410 =item installdirs
411
412 [version 0.19]
413
414 Determines where files are installed within the normal perl hierarchy
415 as determined by F<Config.pm>.  Valid values are: C<core>, C<site>,
416 C<vendor>.  The default is C<site>.  See
417 L<Module::Build/"INSTALL PATHS">
418
419 =item license
420
421 [version 0.07]
422
423 Specifies the licensing terms of your distribution.  Valid options include:
424
425
426 =over 4
427
428 =item apache
429
430 The distribution is licensed under the Apache Software License
431 (http://opensource.org/licenses/apachepl.php).
432
433 =item artistic
434
435 The distribution is licensed under the Artistic License, as specified
436 by the F<Artistic> file in the standard perl distribution.
437
438 =item bsd
439
440 The distribution is licensed under the BSD License
441 (http://www.opensource.org/licenses/bsd-license.php).
442
443 =item gpl
444
445 The distribution is licensed under the terms of the Gnu General
446 Public License (http://www.opensource.org/licenses/gpl-license.php).
447
448 =item lgpl
449
450 The distribution is licensed under the terms of the Gnu Lesser
451 General Public License
452 (http://www.opensource.org/licenses/lgpl-license.php).
453
454 =item mit
455
456 The distribution is licensed under the MIT License
457 (http://opensource.org/licenses/mit-license.php).
458
459 =item mozilla
460
461 The distribution is licensed under the Mozilla Public
462 License.  (http://opensource.org/licenses/mozilla1.0.php or
463 http://opensource.org/licenses/mozilla1.1.php)
464
465 =item open_source
466
467 The distribution is licensed under some other Open Source
468 Initiative-approved license listed at
469 http://www.opensource.org/licenses/ .
470
471 =item perl
472
473 The distribution may be copied and redistributed under the same terms
474 as perl itself (this is by far the most common licensing option for
475 modules on CPAN).  This is a dual license, in which the user may
476 choose between either the GPL or the Artistic license.
477
478 =item restrictive
479
480 The distribution may not be redistributed without special permission
481 from the author and/or copyright holder.
482
483 =item unrestricted
484
485 The distribution is licensed under a license that is B<not> approved
486 by www.opensource.org but that allows distribution without
487 restrictions.
488
489 =back
490
491
492 Note that you must still include the terms of your license in your
493 documentation - this field only lets automated tools figure out your
494 licensing restrictions.  Humans still need something to read.  If you
495 choose to provide this field, you should make sure that you keep it in
496 sync with your written documentation if you ever change your licensing
497 terms.
498
499 It is a fatal error to use a license other than the ones mentioned
500 above.  This is not because I wish to impose licensing terms on you -
501 please let me know if you would like another license option to be
502 added to the list.  You may also use a license type of C<unknown> if
503 you don't wish to specify your terms (but this is usually not a good
504 idea for you to do!).
505
506 I just started out with a small set of licenses to keep things simple,
507 figuring I'd let people with actual working knowledge in this area
508 tell me what to do.  So if that's you, drop me a line.
509
510 =item meta_add
511
512 [version 0.28]
513
514 A hash of key/value pairs that should be added to the F<META.yml> file
515 during the C<distmeta> action.  Any existing entries with the same
516 names will be overridden.
517
518 =item meta_merge
519
520 [version 0.28]
521
522 A hash of key/value pairs that should be merged into the F<META.yml>
523 file during the C<distmeta> action.  Any existing entries with the
524 same names will be overridden.
525
526 The only difference between C<meta_add> and C<meta_merge> is their
527 behavior on hash-valued and array-valued entries: C<meta_add> will
528 completely blow away the existing hash or array value, but
529 C<meta_merge> will merge the supplied data into the existing hash or
530 array value.
531
532 =item module_name
533
534 [version 0.03]
535
536 The C<module_name> is a shortcut for setting default values of
537 C<dist_name> and C<dist_version_from>, reflecting the fact that the
538 majority of CPAN distributions are centered around one "main" module.
539 For instance, if you set C<module_name> to C<Foo::Bar>, then
540 C<dist_name> will default to C<Foo-Bar> and C<dist_version_from> will
541 default to C<lib/Foo/Bar.pm>.  C<dist_version_from> will in turn be
542 used to set C<dist_version>.
543
544 Setting C<module_name> won't override a C<dist_*> parameter you
545 specify explicitly.
546
547 =item PL_files
548
549 [version 0.06]
550
551 An optional parameter specifying a set of C<.PL> files in your
552 distribution.  These will be run as Perl scripts prior to processing
553 the rest of the files in your distribution.  They are usually used as
554 templates for creating other files dynamically, so that a file like
555 C<lib/Foo/Bar.pm.PL> might create the file C<lib/Foo/Bar.pm>.
556
557 The files are specified with the C<.PL> files as hash keys, and the
558 file(s) they generate as hash values, like so:
559
560   my $build = Module::Build->new
561     (
562      module_name => 'Foo::Bar',
563      ...
564      PL_files => { 'lib/Foo/Bar.pm.PL' => 'lib/Foo/Bar.pm' },
565     );
566
567 Note that the path specifications are I<always> given in Unix-like
568 format, not in the style of the local system.
569
570 If your C<.PL> scripts don't create any files, or if they create files
571 with unexpected names, or even if they create multiple files, you can
572 indicate that so that Module::Build can properly handle these created
573 files:
574
575   PL_files => {
576                'lib/Foo/Bar.pm.PL' => 'lib/Foo/Bar.pm',
577                'lib/something.PL'  => ['/lib/something', '/lib/else'],
578                'lib/funny.PL'      => [],
579               }
580
581 =item pm_files
582
583 [version 0.19]
584
585 An optional parameter specifying the set of C<.pm> files in this
586 distribution, specified as a hash reference whose keys are the files'
587 locations in the distributions, and whose values are their logical
588 locations based on their package name, i.e. where they would be found
589 in a "normal" Module::Build-style distribution.  This parameter is
590 mainly intended to support alternative layouts of files.
591
592 For instance, if you have an old-style MakeMaker distribution for a
593 module called C<Foo::Bar> and a F<Bar.pm> file at the top level of the
594 distribution, you could specify your layout in your C<Build.PL> like
595 this:
596
597   my $build = Module::Build->new
598     (
599      module_name => 'Foo::Bar',
600      ...
601      pm_files => { 'Bar.pm' => 'lib/Foo/Bar.pm' },
602     );
603
604 Note that the values should include C<lib/>, because this is where
605 they would be found in a "normal" Module::Build-style distribution.
606
607 Note also that the path specifications are I<always> given in
608 Unix-like format, not in the style of the local system.
609
610 =item pod_files
611
612 [version 0.19]
613
614 Just like C<pm_files>, but used for specifying the set of C<.pod>
615 files in your distribution.
616
617 =item recommends
618
619 [version 0.08]
620
621 This is just like the C<requires> argument, except that modules listed
622 in this section aren't essential, just a good idea.  We'll just print
623 a friendly warning if one of these modules aren't found, but we'll
624 continue running.
625
626 If a module is recommended but not required, all tests should still
627 pass if the module isn't installed.  This may mean that some tests
628 may be skipped if recommended dependencies aren't present.
629
630 Automated tools like CPAN.pm should inform the user when recommended
631 modules aren't installed, and it should offer to install them if it
632 wants to be helpful.
633
634 See the documentation for L<Module::Build::Authoring/"PREREQUISITES">
635 for the details of how requirements can be specified.
636
637 =item recursive_test_files
638
639 [version 0.28]
640
641 Normally, C<Module::Build> does not search subdirectories when looking
642 for tests to run. When this options is set it will search recursively
643 in all subdirectories of the standard 't' test directory.
644
645 =item requires
646
647 [version 0.07]
648
649 An optional C<requires> argument specifies any module prerequisites
650 that the current module depends on.
651
652 One note: currently C<Module::Build> doesn't actually I<require> the
653 user to have dependencies installed, it just strongly urges.  In the
654 future we may require it.  There's also a C<recommends> section for
655 things that aren't absolutely required.
656
657 Automated tools like CPAN.pm should refuse to install a module if one
658 of its dependencies isn't satisfied, unless a "force" command is given
659 by the user.  If the tools are helpful, they should also offer to
660 install the dependencies.
661
662 A synonym for C<requires> is C<prereq>, to help succour people
663 transitioning from C<ExtUtils::MakeMaker>.  The C<requires> term is
664 preferred, but the C<prereq> term will remain valid in future
665 distributions.
666
667 See the documentation for L<Module::Build::Authoring/"PREREQUISITES">
668 for the details of how requirements can be specified.
669
670 =item script_files
671
672 [version 0.18]
673
674 An optional parameter specifying a set of files that should be
675 installed as executable perl scripts when the module is installed.
676 May be given as an array reference of the files, or as a hash
677 reference whose keys are the files (and whose values will currently be
678 ignored).
679
680 The default is to install no script files - in other words, there is
681 no default location where Module::Build will look for script files to
682 install.
683
684 For backward compatibility, you may use the parameter C<scripts>
685 instead of C<script_files>.  Please consider this usage deprecated,
686 though it will continue to exist for several version releases.
687
688 =item sign
689
690 [version 0.16]
691
692 If a true value is specified for this parameter, C<Module::Signature>
693 will be used (via the 'distsign' action) to create a SIGNATURE file
694 for your distribution during the 'distdir' action, and to add the
695 SIGNATURE file to the MANIFEST (therefore, don't add it yourself).
696
697 The default value is false.  In the future, the default may change to
698 true if you have C<Module::Signature> installed on your system.
699
700 =item test_files
701
702 [version 0.23]
703
704 An optional parameter specifying a set of files that should be used as
705 C<Test::Harness>-style regression tests to be run during the C<test>
706 action.  May be given as an array reference of the files, or as a hash
707 reference whose keys are the files (and whose values will currently be
708 ignored).  If the argument is given as a single string (not in an
709 array reference), that string will be treated as a C<glob()> pattern
710 specifying the files to use.
711
712 The default is to look for a F<test.pl> script in the top-level
713 directory of the distribution, and any files matching the glob pattern
714 C<*.t> in the F<t/> subdirectory.  If the C<recursive_test_files>
715 property is true, then the C<t/> directory will be scanned recursively
716 for C<*.t> files.
717
718
719 =item xs_files
720
721 [version 0.19]
722
723 Just like C<pm_files>, but used for specifying the set of C<.xs>
724 files in your distribution.
725
726 =back
727
728
729 =item new_from_context(%args)
730
731 [version 0.28]
732
733 When called from a directory containing a F<Build.PL> script and a
734 F<META.yml> file (in other words, the base directory of a
735 distribution), this method will run the F<Build.PL> and return the
736 resulting C<Module::Build> object to the caller.  Any key-value
737 arguments given to C<new_from_context()> are essentially like
738 command line arguments given to the F<Build.PL> script, so for example
739 you could pass C<< verbose => 1 >> to this method to turn on
740 verbosity.
741
742 =item resume()
743
744 [version 0.03]
745
746 You'll probably never call this method directly, it's only called from
747 the auto-generated C<Build> script.  The C<new()> method is only
748 called once, when the user runs C<perl Build.PL>.  Thereafter, when
749 the user runs C<Build test> or another action, the C<Module::Build>
750 object is created using the C<resume()> method to re-instantiate with
751 the settings given earlier to C<new()>.
752
753 =item subclass()
754
755 [version 0.06]
756
757 This creates a new C<Module::Build> subclass on the fly, as described
758 in the L<Module::Build::Authoring/"SUBCLASSING"> section.  The caller
759 must provide either a C<class> or C<code> parameter, or both.  The
760 C<class> parameter indicates the name to use for the new subclass, and
761 defaults to C<MyModuleBuilder>.  The C<code> parameter specifies Perl
762 code to use as the body of the subclass.
763
764 =back
765
766
767 =head2 METHODS
768
769 =over 4
770
771 =item add_build_element($type)
772
773 [version 0.26]
774
775 Adds a new type of entry to the build process.  Accepts a single
776 string specifying its type-name.  There must also be a method defined
777 to process things of that type, e.g. if you add a build element called
778 C<'foo'>, then you must also define a method called
779 C<process_foo_files()>.
780
781 See also
782 L<Module::Build::Cookbook/"Adding new file types to the build process">.
783
784 =item add_to_cleanup(@files)
785
786 [version 0.03]
787
788 You may call C<< $self->add_to_cleanup(@patterns) >> to tell
789 C<Module::Build> that certain files should be removed when the user
790 performs the C<Build clean> action.  The arguments to the method are
791 patterns suitable for passing to Perl's C<glob()> function, specified
792 in either Unix format or the current machine's native format.  It's
793 usually convenient to use Unix format when you hard-code the filenames
794 (e.g. in F<Build.PL>) and the native format when the names are
795 programmatically generated (e.g. in a testing script).
796
797 I decided to provide a dynamic method of the C<$build> object, rather
798 than just use a static list of files named in the F<Build.PL>, because
799 these static lists can get difficult to manage.  I usually prefer to
800 keep the responsibility for registering temporary files close to the
801 code that creates them.
802
803 =item args()
804
805 [version 0.26]
806
807   my $args_href = $build->args;
808   my %args = $build->args;
809   my $arg_value = $build->args($key);
810   $build->args($key, $value);
811
812 This method is the preferred interface for retrieving the arguments passed via
813 command line options to F<Build.PL> or F<Build>, minus the Module-Build
814 specific options.
815
816 When called in in a scalar context with no arguments, this method returns a
817 reference to the hash storing all of the arguments; in an array context, it
818 returns the hash itself.  When passed a single argument, it returns the value
819 stored in the args hash for that option key.  When called with two arguments,
820 the second argument is assigned to the args hash under the key passed as the
821 first argument.
822
823 =item autosplit_file($from, $to)
824
825 [version 0.28]
826
827 Invokes the C<AutoSplit> module on the C<$from> file, sending the
828 output to the C<lib/auto> directory inside C<$to>.  C<$to> is
829 typically the C<blib/> directory.
830
831 =item base_dir()
832
833 [version 0.14]
834
835 Returns a string containing the root-level directory of this build,
836 i.e. where the C<Build.PL> script and the C<lib> directory can be
837 found.  This is usually the same as the current working directory,
838 because the C<Build> script will C<chdir()> into this directory as
839 soon as it begins execution.
840
841 =item build_requires()
842
843 [version 0.21]
844
845 Returns a hash reference indicating the C<build_requires>
846 prerequisites that were passed to the C<new()> method.
847
848 =item check_installed_status($module, $version)
849
850 [version 0.11]
851
852 This method returns a hash reference indicating whether a version
853 dependency on a certain module is satisfied.  The C<$module> argument
854 is given as a string like C<"Data::Dumper"> or C<"perl">, and the
855 C<$version> argument can take any of the forms described in L<requires>
856 above.  This allows very fine-grained version checking.
857
858 The returned hash reference has the following structure:
859
860   {
861    ok => $whether_the_dependency_is_satisfied,
862    have => $version_already_installed,
863    need => $version_requested, # Same as incoming $version argument
864    message => $informative_error_message,
865   }
866
867 If no version of C<$module> is currently installed, the C<have> value
868 will be the string C<< "<none>" >>.  Otherwise the C<have> value will
869 simply be the version of the installed module.  Note that this means
870 that if C<$module> is installed but doesn't define a version number,
871 the C<have> value will be C<undef> - this is why we don't use C<undef>
872 for the case when C<$module> isn't installed at all.
873
874 This method may be called either as an object method
875 (C<< $build->check_installed_status($module, $version) >>)
876 or as a class method 
877 (C<< Module::Build->check_installed_status($module, $version) >>).
878
879 =item check_installed_version($module, $version)
880
881 [version 0.05]
882
883 Like C<check_installed_status()>, but simply returns true or false
884 depending on whether module C<$module> satisfies the dependency
885 C<$version>.
886
887 If the check succeeds, the return value is the actual version of
888 C<$module> installed on the system.  This allows you to do the
889 following:
890
891   my $installed = $build->check_installed_version('DBI', '1.15');
892   if ($installed) {
893     print "Congratulations, version $installed of DBI is installed.\n";
894   } else {
895     die "Sorry, you must install DBI.\n";
896   }
897
898 If the check fails, we return false and set C<$@> to an informative
899 error message.
900
901 If C<$version> is any non-true value (notably zero) and any version of
902 C<$module> is installed, we return true.  In this case, if C<$module>
903 doesn't define a version, or if its version is zero, we return the
904 special value "0 but true", which is numerically zero, but logically
905 true.
906
907 In general you might prefer to use C<check_installed_status> if you
908 need detailed information, or this method if you just need a yes/no
909 answer.
910
911 =item compare_versions($v1, $op, $v2)
912
913 [version 0.28]
914
915 Compares two module versions C<$v1> and C<$v2> using the operator
916 C<$op>, which should be one of Perl's numeric operators like C<!=> or
917 C<< >= >> or the like.  We do at least a halfway-decent job of
918 handling versions that aren't strictly numeric, like C<0.27_02>, but
919 exotic stuff will likely cause problems.
920
921 In the future, the guts of this method might be replaced with a call
922 out to C<version.pm>.
923
924 =item config($key)
925
926 =item config($key, $value)
927
928 =item config() [deprecated]
929
930 [version 0.22]
931
932 With a single argument C<$key>, returns the value associated with that
933 key in the C<Config.pm> hash, including any changes the author or user
934 has specified.  
935
936 With C<$key> and C<$value> arguments, sets the value for future
937 callers of C<config($key)>.
938
939 With no arguments, returns a hash reference containing all such
940 key-value pairs.  This usage is deprecated, though, because it's a
941 resource hog and violates encapsulation.
942
943 =item config_data($name)
944
945 =item config_data($name => $value)
946
947 [version 0.26]
948
949 With a single argument, returns the value of the configuration
950 variable C<$name>.  With two arguments, sets the given configuration
951 variable to the given value.  The value may be any perl scalar that's
952 serializable with C<Data::Dumper>.  For instance, if you write a
953 module that can use a MySQL or PostgreSQL back-end, you might create
954 configuration variables called C<mysql_connect> and
955 C<postgres_connect>, and set each to an array of connection parameters
956 for C<< DBI->connect() >>.
957
958 Configuration values set in this way using the Module::Build object
959 will be available for querying during the build/test process and after
960 installation via the generated C<...::ConfigData> module, as
961 C<< ...::ConfigData->config($name) >>.
962
963 The C<feature()> and C<config_data()> methods represent
964 Module::Build's main support for configuration of installed modules.
965 See also L<Module::Build::Authoring/"SAVING CONFIGURATION INFORMATION">.
966
967 =item conflicts()
968
969 [version 0.21]
970
971 Returns a hash reference indicating the C<conflicts> prerequisites
972 that were passed to the C<new()> method.
973
974 =item contains_pod($file)
975
976 [version 0.20]
977
978 [Deprecated] Please see L<Module::Build::ModuleInfo> instead.
979
980 Returns true if the given file appears to contain POD documentation.
981 Currently this checks whether the file has a line beginning with
982 '=pod', '=head', or '=item', but the exact semantics may change in the
983 future.
984
985 =item copy_if_modified(%parameters)
986
987 [version 0.19]
988
989 Takes the file in the C<from> parameter and copies it to the file in
990 the C<to> parameter, or the directory in the C<to_dir> parameter, if
991 the file has changed since it was last copied (or if it doesn't exist
992 in the new location).  By default the entire directory structure of
993 C<from> will be copied into C<to_dir>; an optional C<flatten>
994 parameter will copy into C<to_dir> without doing so.
995
996 Returns the path to the destination file, or C<undef> if nothing
997 needed to be copied.
998
999 Any directories that need to be created in order to perform the
1000 copying will be automatically created.
1001
1002 The destination file is set to read-only. If the source file has the
1003 executable bit set, then the destination file will be made executable.
1004
1005 =item create_build_script()
1006
1007 [version 0.05]
1008
1009 Creates an executable script called C<Build> in the current directory
1010 that will be used to execute further user actions.  This script is
1011 roughly analogous (in function, not in form) to the Makefile created
1012 by C<ExtUtils::MakeMaker>.  This method also creates some temporary
1013 data in a directory called C<_build/>.  Both of these will be removed
1014 when the C<realclean> action is performed.
1015
1016 Among the files created in C<_build/> is a F<_build/prereqs> file
1017 containing the set of prerequisites for this distribution, as a hash
1018 of hashes.  This file may be C<eval()>-ed to obtain the authoritative
1019 set of prereqs, which might be different from the contents of META.yml
1020 (because F<Build.PL> might have set them dynamically).  But fancy
1021 developers take heed: do not put any fancy custom runtime code in the
1022 F<_build/prereqs> file, leave it as a static declaration containing
1023 only strings and numbers.  Similarly, do not alter the structure of
1024 the internal C<< $self->{properties}{requires} >> (etc.) data members,
1025 because that's where this data comes from.
1026
1027 =item current_action()
1028
1029 [version 0.28]
1030
1031 Returns the name of the currently-running action, such as "build" or
1032 "test".  This action is not necessarily the action that was originally
1033 invoked by the user.  For example, if the user invoked the "test"
1034 action, current_action() would initially return "test".  However,
1035 action "test" depends on action "code", so current_action() will
1036 return "code" while that dependency is being executed.  Once that
1037 action has completed, current_action() will again return "test".
1038
1039 If you need to know the name of the original action invoked by the
1040 user, see L<invoked_action()> below.
1041
1042 =item depends_on(@actions)
1043
1044 [version 0.28]
1045
1046 Invokes the named action or list of actions in sequence.  Using this
1047 method is preferred to calling the action explicitly because it
1048 performs some internal record-keeping, and it ensures that the same
1049 action is not invoked multiple times (note: in future versions of
1050 Module::Build it's conceivable that this run-only-once mechanism will
1051 be changed to something more intelligent).
1052
1053 Note that the name of this method is something of a misnomer; it
1054 should really be called something like
1055 C<invoke_actions_unless_already_invoked()> or something, but for
1056 better or worse (perhaps better!) we were still thinking in
1057 C<make>-like dependency terms when we created this method.
1058
1059 See also C<dispatch()>.  The main distinction between the two is that
1060 C<depends_on()> is meant to call an action from inside another action,
1061 whereas C<dispatch()> is meant to set the very top action in motion.
1062
1063 =item dir_contains($first_dir, $second_dir)
1064
1065 [version 0.28]
1066
1067 Returns true if the first directory logically contains the second
1068 directory.  This is just a convenience function because C<File::Spec>
1069 doesn't really provide an easy way to figure this out (but
1070 C<Path::Class> does...).
1071
1072 =item dispatch($action, %args)
1073
1074 [version 0.03]
1075
1076 Invokes the build action C<$action>.  Optionally, a list of options
1077 and their values can be passed in.  This is equivalent to invoking an
1078 action at the command line, passing in a list of options.
1079
1080 Custom options that have not been registered must be passed in as a
1081 hash reference in a key named "args":
1082
1083   $build->dispatch('foo', verbose => 1, args => { my_option => 'value' });
1084
1085 This method is intended to be used to programmatically invoke build
1086 actions, e.g. by applications controlling Module::Build-based builds
1087 rather than by subclasses.
1088
1089 See also C<depends_on()>.  The main distinction between the two is that
1090 C<depends_on()> is meant to call an action from inside another action,
1091 whereas C<dispatch()> is meant to set the very top action in motion.
1092
1093 =item dist_dir()
1094
1095 [version 0.28]
1096
1097 Returns the name of the directory that will be created during the
1098 C<dist> action.  The name is derived from the C<dist_name> and
1099 C<dist_version> properties.
1100
1101 =item dist_name()
1102
1103 [version 0.21]
1104
1105 Returns the name of the current distribution, as passed to the
1106 C<new()> method in a C<dist_name> or modified C<module_name>
1107 parameter.
1108
1109 =item dist_version()
1110
1111 [version 0.21]
1112
1113 Returns the version of the current distribution, as determined by the
1114 C<new()> method from a C<dist_version>, C<dist_version_from>, or
1115 C<module_name> parameter.
1116
1117 =item do_system($cmd, @args)
1118
1119 [version 0.21]
1120
1121 This is a fairly simple wrapper around Perl's C<system()> built-in
1122 command.  Given a command and an array of optional arguments, this
1123 method will print the command to C<STDOUT>, and then execute it using
1124 Perl's C<system()>.  It returns true or false to indicate success or
1125 failure (the opposite of how C<system()> works, but more intuitive).
1126
1127 Note that if you supply a single argument to C<do_system()>, it
1128 will/may be processed by the systems's shell, and any special
1129 characters will do their special things.  If you supply multiple
1130 arguments, no shell will get involved and the command will be executed
1131 directly.
1132
1133 =item feature($name)
1134
1135 =item feature($name => $value)
1136
1137 [version 0.26]
1138
1139 With a single argument, returns true if the given feature is set.
1140 With two arguments, sets the given feature to the given boolean value.
1141 In this context, a "feature" is any optional functionality of an
1142 installed module.  For instance, if you write a module that could
1143 optionally support a MySQL or PostgreSQL backend, you might create
1144 features called C<mysql_support> and C<postgres_support>, and set them
1145 to true/false depending on whether the user has the proper databases
1146 installed and configured.
1147
1148 Features set in this way using the Module::Build object will be
1149 available for querying during the build/test process and after
1150 installation via the generated C<...::ConfigData> module, as 
1151 C<< ...::ConfigData->feature($name) >>.
1152
1153 The C<feature()> and C<config_data()> methods represent
1154 Module::Build's main support for configuration of installed modules.
1155 See also L<Module::Build::Authoring/"SAVING CONFIGURATION INFORMATION">.
1156
1157 =item have_c_compiler()
1158
1159 [version 0.21]
1160
1161 Returns true if the current system seems to have a working C compiler.
1162 We currently determine this by attempting to compile a simple C source
1163 file and reporting whether the attempt was successful.
1164
1165 =item install_base_relpaths()
1166
1167 =item install_base_relpaths($type)
1168
1169 =item install_base_relpaths($type => $path)
1170
1171 [version 0.28]
1172
1173 Set or retrieve the relative paths that are appended to
1174 C<install_base> for any installable element. This is useful if you
1175 want to set the relative install path for custom build elements.
1176
1177 With no argument, it returns a reference to a hash containing all
1178 elements and their respective values. This hash should not be modified
1179 directly; use the multi-argument below form to change values.
1180
1181 The single argument form returns the value associated with the
1182 element C<$type>.
1183
1184 The multi-argument form allows you to set the paths for element types.
1185 C<$value> must be a relative path using unix-like paths.  (A series of
1186 directories seperated by slashes.  Eg 'foo/bar'.)  The return value is a
1187 localized path based on C<$value>.
1188
1189 Assigning the value C<undef> to an element causes it to be removed.
1190
1191 =item install_destination($type)
1192
1193 [version 0.28]
1194
1195 Returns the directory in which items of type C<$type> (e.g. C<lib>,
1196 C<arch>, C<bin>, or anything else returned by the C<install_types()>
1197 method) will be installed during the C<install> action.  Any settings
1198 for C<install_path>, C<install_base>, and C<prefix> are taken into
1199 account when determining the return value.
1200
1201 =item install_path()
1202
1203 =item install_path($type)
1204
1205 =item install_path($type => $path)
1206
1207 [version 0.28]
1208
1209 Set or retrieve paths for specific installable elements. This is
1210 useful when you want to examine any explicit install paths specified
1211 by the user on the command line, or if you want to set the install
1212 path for a specific installable element based on another attribute
1213 like C<install_base()>.
1214
1215 With no argument, it returns a reference to a hash containing all
1216 elements and their respective values. This hash should not be modified
1217 directly; use the multi-argument below form to change values.
1218
1219 The single argument form returns the value associated with the
1220 element C<$type>.
1221
1222 The multi-argument form allows you to set the paths for element types.
1223 The supplied C<$path> should be an absolute path to install elements
1224 of C<$type>.  The return value is C<$path>.
1225
1226 Assigning the value C<undef> to an element causes it to be removed.
1227
1228 =item install_types()
1229
1230 [version 0.28]
1231
1232 Returns a list of installable types that this build knows about.
1233 These types each correspond to the name of a directory in F<blib/>,
1234 and the list usually includes items such as C<lib>, C<arch>, C<bin>,
1235 C<script>, C<libdoc>, C<bindoc>, and if HTML documentation is to be
1236 built, C<libhtml> and C<binhtml>.  Other user-defined types may also
1237 exist.
1238
1239 =item invoked_action()
1240
1241 [version 0.28]
1242
1243 This is the name of the original action invoked by the user.  This
1244 value is set when the user invokes F<Build.PL>, the F<Build> script,
1245 or programatically through the L<dispatch()> method.  It does not
1246 change as sub-actions are executed as dependencies are evaluated.
1247
1248 To get the name of the currently executing dependency, see
1249 L<current_action()> above.
1250
1251 =item notes()
1252
1253 =item notes($key)
1254
1255 =item notes($key => $value)
1256
1257 [version 0.20]
1258
1259 The C<notes()> value allows you to store your own persistent
1260 information about the build, and to share that information among
1261 different entities involved in the build.  See the example in the
1262 C<current()> method.
1263
1264 The C<notes()> method is essentally a glorified hash access.  With no
1265 arguments, C<notes()> returns the entire hash of notes.  With one argument,
1266 C<notes($key)> returns the value associated with the given key.  With two
1267 arguments, C<notes($key, $value)> sets the value associated with the given key
1268 to C<$value> and returns the new value.
1269
1270 The lifetime of the C<notes> data is for "a build" - that is, the
1271 C<notes> hash is created when C<perl Build.PL> is run (or when the
1272 C<new()> method is run, if the Module::Build Perl API is being used
1273 instead of called from a shell), and lasts until C<perl Build.PL> is
1274 run again or the C<clean> action is run.
1275
1276 =item orig_dir()
1277
1278 [version 0.28]
1279
1280 Returns a string containing the working directory that was in effect
1281 before the F<Build> script chdir()-ed into the C<base_dir>.  This
1282 might be useful for writing wrapper tools that might need to chdir()
1283 back out.
1284
1285 =item os_type()
1286
1287 [version 0.04]
1288
1289 If you're subclassing Module::Build and some code needs to alter its
1290 behavior based on the current platform, you may only need to know
1291 whether you're running on Windows, Unix, MacOS, VMS, etc., and not the
1292 fine-grained value of Perl's C<$^O> variable.  The C<os_type()> method
1293 will return a string like C<Windows>, C<Unix>, C<MacOS>, C<VMS>, or
1294 whatever is appropriate.  If you're running on an unknown platform, it
1295 will return C<undef> - there shouldn't be many unknown platforms
1296 though.
1297
1298 =item is_vmsish()
1299
1300 =item is_windowsish()
1301
1302 =item is_unixish()
1303
1304 Convenience functions that return a boolean value indicating whether
1305 this platform behaves respectively like VMS, Windows, or Unix.  For
1306 arbitrary reasons other platforms don't get their own such functions,
1307 at least not yet.
1308
1309
1310 =item prefix_relpaths()
1311
1312 =item prefix_relpaths($installdirs)
1313
1314 =item prefix_relpaths($installdirs, $type)
1315
1316 =item prefix_relpaths($installdirs, $type => $path)
1317
1318 [version 0.28]
1319
1320 Set or retrieve the relative paths that are appended to C<prefix> for
1321 any installable element.  This is useful if you want to set the
1322 relative install path for custom build elements.
1323
1324 With no argument, it returns a reference to a hash containing all
1325 elements and their respective values as defined by the current
1326 C<installdirs> setting.
1327
1328 With a single argument, it returns a reference to a hash containing
1329 all elements and their respective values as defined by
1330 C<$installdirs>.
1331
1332 The hash returned by the above calls should not be modified directly;
1333 use the three-argument below form to change values.
1334
1335 The two argument form returns the value associated with the
1336 element C<$type>.
1337
1338 The multi-argument form allows you to set the paths for element types.
1339 C<$value> must be a relative path using unix-like paths.  (A series of
1340 directories seperated by slashes.  Eg 'foo/bar'.)  The return value is a
1341 localized path based on C<$value>.
1342
1343 Assigning the value C<undef> to an element causes it to be removed.
1344
1345 =item prepare_metadata()
1346
1347 [version 0.28]
1348
1349 This method is provided for authors to override to customize the
1350 fields of F<META.yml>.  It is passed a YAML::Node node object which can
1351 be modified as desired and then returned.  E.g.
1352
1353   package My::Builder;
1354   use base 'Module::Build';
1355
1356   sub prepare_metadata {
1357     my $self = shift;
1358     my $node = $self->SUPER::prepare_metadata( shift );
1359     $node->{custom_field} = 'foo';
1360     return $node;
1361   }
1362
1363 =item prereq_failures()
1364
1365 [version 0.11]
1366
1367 Returns a data structure containing information about any failed
1368 prerequisites (of any of the types described above), or C<undef> if
1369 all prerequisites are met.
1370
1371 The data structure returned is a hash reference.  The top level keys
1372 are the type of prerequisite failed, one of "requires",
1373 "build_requires", "conflicts", or "recommends".  The associated values
1374 are hash references whose keys are the names of required (or
1375 conflicting) modules.  The associated values of those are hash
1376 references indicating some information about the failure.  For example:
1377
1378   {
1379    have => '0.42',
1380    need => '0.59',
1381    message => 'Version 0.42 is installed, but we need version 0.59',
1382   }
1383
1384 or
1385
1386   {
1387    have => '<none>',
1388    need => '0.59',
1389    message => 'Prerequisite Foo isn't installed',
1390   }
1391
1392 This hash has the same structure as the hash returned by the
1393 C<check_installed_status()> method, except that in the case of
1394 "conflicts" dependencies we change the "need" key to "conflicts" and
1395 construct a proper message.
1396
1397 Examples:
1398
1399   # Check a required dependency on Foo::Bar
1400   if ( $build->prereq_failures->{requires}{Foo::Bar} ) { ...
1401
1402   # Check whether there were any failures
1403   if ( $build->prereq_failures ) { ...
1404
1405   # Show messages for all failures
1406   my $failures = $build->prereq_failures;
1407   while (my ($type, $list) = each %$failures) {
1408     while (my ($name, $hash) = each %$list) {
1409       print "Failure for $name: $hash->{message}\n";
1410     }
1411   }
1412
1413 =item prereq_report()
1414
1415 [version 0.28]
1416
1417 Returns a human-readable (table-form) string showing all
1418 prerequisites, the versions required, and the versions actually
1419 installed.  This can be useful for reviewing the configuration of your
1420 system prior to a build, or when compiling data to send for a bug
1421 report.  The C<prereq_report> action is just a thin wrapper around the
1422 C<prereq_report()> method.
1423
1424 =item prompt($message, $default)
1425
1426 [version 0.12]
1427
1428 Asks the user a question and returns their response as a string.  The
1429 first argument specifies the message to display to the user (for
1430 example, C<"Where do you keep your money?">).  The second argument,
1431 which is optional, specifies a default answer (for example,
1432 C<"wallet">).  The user will be asked the question once.
1433
1434 If C<prompt()> detects that it is not running interactively and there
1435 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
1436 is set to true, the $default will be used without prompting.
1437
1438 To prevent automated processes from blocking, the user must either set
1439 PERL_MM_USE_DEFAULT or attach something to STDIN (this can be a
1440 pipe/file containing a scripted set of answers or /dev/null.)
1441
1442 If no $default is provided an empty string will be used instead.  In
1443 non-interactive mode, the absence of $default is an error (though
1444 explicitly passing C<undef()> as the default is valid as of 0.27.)
1445
1446 This method may be called as a class or object method.
1447
1448 =item recommends()
1449
1450 [version 0.21]
1451
1452 Returns a hash reference indicating the C<recommends> prerequisites
1453 that were passed to the C<new()> method.
1454
1455 =item requires()
1456
1457 [version 0.21]
1458
1459 Returns a hash reference indicating the C<requires> prerequisites that
1460 were passed to the C<new()> method.
1461
1462 =item rscan_dir($dir, $pattern)
1463
1464 [version 0.28]
1465
1466 Uses C<File::Find> to traverse the directory C<$dir>, returning a
1467 reference to an array of entries matching C<$pattern>.  C<$pattern>
1468 may either be a regular expression (using C<qr//> or just a plain
1469 string), or a reference to a subroutine that will return true for
1470 wanted entries.  If C<$pattern> is not given, all entries will be
1471 returned.
1472
1473 Examples:
1474
1475  # All the *.pm files in lib/
1476  $m->rscan_dir('lib', qr/\.pm$/)
1477  
1478  # All the files in blib/ that aren't *.html files
1479  $m->rscan_dir('blib', sub {-f $_ and not /\.html$/});
1480
1481  # All the files in t/
1482  $m->rscan_dir('t');
1483
1484 =item runtime_params()
1485
1486 =item runtime_params($key)
1487
1488 [version 0.28]
1489
1490 The C<runtime_params()> method stores the values passed on the command line
1491 for valid properties (that is, any command line options for which
1492 C<valid_property()> returns a true value).  The value on the command line may
1493 override the default value for a property, as well as any value specified in a
1494 call to C<new()>.  This allows you to programmatically tell if C<perl Build.PL>
1495 or any execution of C<./Build> had command line options specified that
1496 override valid properties.
1497
1498 The C<runtime_params()> method is essentally a glorified read-only hash.  With
1499 no arguments, C<runtime_params()> returns the entire hash of properties
1500 specified on the command line.  With one argument, C<runtime_params($key)>
1501 returns the value associated with the given key.
1502
1503 The lifetime of the C<runtime_params> data is for "a build" - that is, the
1504 C<runtime_params> hash is created when C<perl Build.PL> is run (or when the
1505 C<new()> method is called, if the Module::Build Perl API is being used instead
1506 of called from a shell), and lasts until C<perl Build.PL> is run again or the
1507 C<clean> action is run.
1508
1509 =item script_files()
1510
1511 [version 0.18]
1512
1513 Returns a hash reference whose keys are the perl script files to be
1514 installed, if any.  This corresponds to the C<script_files> parameter to the
1515 C<new()> method.  With an optional argument, this parameter may be set
1516 dynamically.
1517
1518 For backward compatibility, the C<scripts()> method does exactly the
1519 same thing as C<script_files()>.  C<scripts()> is deprecated, but it
1520 will stay around for several versions to give people time to
1521 transition.
1522
1523 =item up_to_date($source_file, $derived_file)
1524
1525 =item up_to_date(\@source_files, \@derived_files)
1526
1527 [version 0.20]
1528
1529 This method can be used to compare a set of source files to a set of
1530 derived files.  If any of the source files are newer than any of the
1531 derived files, it returns false.  Additionally, if any of the derived
1532 files do not exist, it returns false.  Otherwise it returns true.
1533
1534 The arguments may be either a scalar or an array reference of file
1535 names.
1536
1537 =item y_n($message, $default)
1538
1539 [version 0.12]
1540
1541 Asks the user a yes/no question using C<prompt()> and returns true or
1542 false accordingly.  The user will be asked the question repeatedly
1543 until they give an answer that looks like "yes" or "no".
1544
1545 The first argument specifies the message to display to the user (for
1546 example, C<"Shall I invest your money for you?">), and the second
1547 argument specifies the default answer (for example, C<"y">).
1548
1549 Note that the default is specified as a string like C<"y"> or C<"n">,
1550 and the return value is a Perl boolean value like 1 or 0.  I thought
1551 about this for a while and this seemed like the most useful way to do
1552 it.
1553
1554 This method may be called as a class or object method.
1555
1556 =back
1557
1558
1559 =head2 Autogenerated Accessors
1560
1561 In addition to the aforementioned methods, there are also some get/set
1562 accessor methods for the following properties:
1563
1564 =over 4
1565
1566 =item PL_files()
1567
1568 =item allow_mb_mismatch()
1569
1570 =item autosplit()
1571
1572 =item base_dir()
1573
1574 =item bindoc_dirs()
1575
1576 =item blib()
1577
1578 =item build_bat()
1579
1580 =item build_class()
1581
1582 =item build_elements()
1583
1584 =item build_requires()
1585
1586 =item build_script()
1587
1588 =item c_source()
1589
1590 =item config_dir()
1591
1592 =item conflicts()
1593
1594 =item create_makefile_pl()
1595
1596 =item create_packlist()
1597
1598 =item create_readme()
1599
1600 =item debugger()
1601
1602 =item destdir()
1603
1604 =item get_options()
1605
1606 =item html_css()
1607
1608 =item include_dirs()
1609
1610 =item install_base()
1611
1612 =item install_sets()
1613
1614 =item installdirs()
1615
1616 =item libdoc_dirs()
1617
1618 =item license()
1619
1620 =item magic_number()
1621
1622 =item mb_version()
1623
1624 =item meta_add()
1625
1626 =item meta_merge()
1627
1628 =item metafile()
1629
1630 =item module_name()
1631
1632 =item orig_dir()
1633
1634 =item original_prefix()
1635
1636 =item perl()
1637
1638 =item pm_files()
1639
1640 =item pod_files()
1641
1642 =item pollute()
1643
1644 =item prefix()
1645
1646 =item prereq_action_types()
1647
1648 =item quiet()
1649
1650 =item recommends()
1651
1652 =item recurse_into()
1653
1654 =item recursive_test_files()
1655
1656 =item requires()
1657
1658 =item scripts()
1659
1660 =item use_rcfile()
1661
1662 =item verbose()
1663
1664 =item xs_files()
1665
1666 =back
1667
1668
1669 =head1 AUTHOR
1670
1671 Ken Williams <kwilliams@cpan.org>
1672
1673
1674 =head1 COPYRIGHT
1675
1676 Copyright (c) 2001-2006 Ken Williams.  All rights reserved.
1677
1678 This library is free software; you can redistribute it and/or
1679 modify it under the same terms as Perl itself.
1680
1681
1682 =head1 SEE ALSO
1683
1684 perl(1), L<Module::Build>(3), L<Module::Build::Authoring>(3),
1685 L<Module::Build::Cookbook>(3), L<ExtUtils::MakeMaker>(3), L<YAML>(3)
1686
1687 F<META.yml> Specification:
1688 L<http://module-build.sourceforge.net/META-spec-current.html>
1689
1690 =cut