From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

CXW / Build-Hopen-0.000006-TRIAL / lib / Build / Hopen / Toolchain.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
—
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
—
63
64
65
66
67
68
69
70
71
—
72
73
74
75
76
77
78
79
80
—
81
82
83
84
85
86
87
88
89
90
91
92

              
# Build::Hopen::Toolchain - SUPERSEDED base class for hopen toolchains
package Build::Hopen::Toolchain;
use Build::Hopen;
use Build::Hopen::Base;
our $VERSION = '0.000006'; # TRIAL
use Class::Tiny qw(proj_dir dest_dir), {
    architecture => '',
};
# Docs {{{1
=head1 NAME
Build::Hopen::Toolchain - SUPERSEDED base class for hopen toolchains
=head1 SYNOPSIS
TODO
    - change this to "Tool" instead of "Toolchain"
    - permit loading any number of tools
    - The Generator specifies a default list of tools rather than a
        single default toolchain.
    - add G::ToolOp to invoke tools.  A ToolOp will take a language
        and an opcode and invoke a corresponding Tool.  E.g., a GNU C
        Tool will generate command-line options for gcc-style command lines.
    - Only one Tool may be loaded for each (language, opcode) pair.
        Otherwise the build would be ambiguous.
    - In Conventions, define the formats for languages and opcodes.
Maybe TODO:
    - Each Generator must specify a list of Content-Types (media types)
        it can consume.  Each Tool must specify a specific content-type
        it produces.  Mismatches are an error unless overriden on the
        hopen command line.
The code that generates command lines to invoke specific toolchains lives under
C<Build::Hopen::Toolchain>.  Those modules must implement the interface defined
here.
=head1 ATTRIBUTES
=head2 proj_dir
A L<Path::Class::Dir> instance specifying the root directory of the project
=head2 dest_dir
A L<Path::Class::Dir> instance specifying where the generated output
should be written.
=head1 FUNCTIONS
A toolchain (C<Build::Hopen::Toolchain> subclass) is a Visitor.
TODO Figure out if the toolchain has access to L<Build::Hopen::G::Link>
instances.
=cut
# }}}1
=head2 visit_goal
Do whatever the toolchain wants to do with a L<Build::Hopen::G::Goal>.
By default, no-op.
=cut
sub visit_goal { }
=head2 visit_op
Do whatever the toolchain wants to do with a L<Build::Hopen::G::Op> that
is not a Goal (see L</visit_goal>).  By default, no-op.
=cut
sub visit_op { }
=head2 finalize
Do whatever the toolchain wants to do to finish up.
=cut
sub finalize { }
false;  # SUPERSEDED --- will be removed.
__END__
# vi: set fdm=marker: #