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
93
94
|
// file : libbuild2/in/rule.hxx -*- C++ -*-
// license : MIT; see accompanying LICENSE file
#ifndef LIBBUILD2_IN_RULE_HXX
#define LIBBUILD2_IN_RULE_HXX
#include <libbuild2/types.hxx>
#include <libbuild2/utility.hxx>
#include <libbuild2/rule.hxx>
#include <libbuild2/in/export.hxx>
namespace build2
{
namespace in
{
// Preprocess an .in file.
//
// Note that a derived rule can use the target data pad to cache data
// (e.g., in match()) to be used in substitute/lookup() calls.
//
// Note also that currently this rule ignores the dry-run mode (see
// perform_update() for the rationale).
//
class LIBBUILD2_IN_SYMEXPORT rule: public simple_rule
{
public:
// The rule id is used to form the rule name/version entry in depdb. The
// program argument is the pseudo-program name to use in the command
// line diagnostics.
//
rule (string rule_id,
string program,
char symbol = '$',
bool strict = true,
optional<string> null = nullopt)
: rule_id_ (move (rule_id)),
program_ (move (program)),
symbol_ (symbol),
strict_ (strict),
null_ (move (null)) {}
virtual bool
match (action, target&, const string&) const override;
virtual recipe
apply (action, target&) const override;
virtual target_state
perform_update (action, const target&) const;
// Customization hooks.
//
// Perform prerequisite search.
//
virtual prerequisite_target
search (action,
const target&,
const prerequisite_member&,
include_type) const;
// Perform variable lookup.
//
virtual string
lookup (const location&,
action,
const target&,
const string& name,
const optional<string>& null) const;
// Perform variable substitution. Return nullopt if it should be
// ignored.
//
virtual optional<string>
substitute (const location&,
action,
const target&,
const string& name,
bool strict,
const optional<string>& null) const;
protected:
const string rule_id_;
const string program_;
char symbol_;
bool strict_;
optional<string> null_;
};
}
}
#endif // LIBBUILD2_IN_RULE_HXX
|