File Coverage

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