File Coverage

blib/lib/App/hopen/BuildSystemGlobals.pm
Criterion Covered Total %
statement 10 10 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 14 14 100.0


line stmt bran cond sub pod time code
1             # App::hopen::BuildSystemGlobals - global data for build-system use cases.
2             package App::hopen::BuildSystemGlobals;
3 2     2   391 use Data::Hopen;
  2         14316  
  2         133  
4 2     2   27 use Data::Hopen::Base;
  2         2  
  2         14  
5              
6             our $VERSION = '0.000010';
7              
8 2     2   2858 use parent 'Exporter';
  2         5  
  2         11  
9             our @EXPORT;
10 2     2   282 BEGIN { @EXPORT = qw(*Generator *Toolset *Build *Phase *ProjDir *DestDir); }
11             # export with `*` => `local` will work.
12              
13             =head1 NAME
14              
15             App::hopen::BuildSystemGlobals - global data for hopen build-system use cases
16              
17             =head1 SYNOPSIS
18              
19             This module exports variables used when employing hopen(1) as a build system.
20             They are in a separate module so that it's easy to tell which parts of
21             L<Data::Hopen> I<don't> need them.
22              
23             =head1 VARIABLES
24              
25             =head2 $Generator
26              
27             The current L<Data::Hopen::Gen> instance.
28              
29             =head2 $Toolset
30              
31             The name of the current toolset. Support for language C<Foo> is in
32             package C<${Toolset}::Foo>.
33              
34             =head2 $Build
35              
36             The L<Data::Hopen::G::DAG> instance representing the current build.
37             Goals in C<$Build> will become, e.g., top-level targets of a
38             generated C<Makefile>.
39              
40             =head2 $Phase
41              
42             Which phase we're in (string).
43              
44             =head2 $ProjDir
45              
46             A L<Path::Class::Dir> instance representing the project directory.
47              
48             =head2 $DestDir
49              
50             A L<Path::Class::Dir> instance representing the destination directory.
51              
52             =cut
53              
54             our ($Generator, $Toolset, $Build, $Phase, $ProjDir, $DestDir);
55              
56             1;
57             __END__
58             # vi: set fdm=marker: #