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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#include "cmBlockCommand.h"
#include <cstdint> // IWYU pragma: keep
#include <utility>
#include <cm/memory>
#include <cm/optional>
#include <cm/string_view>
#include <cmext/enum_set>
#include <cmext/string_view>
#include "cmArgumentParser.h"
#include "cmArgumentParserTypes.h"
#include "cmExecutionStatus.h"
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
#include "cmMakefile.h"
#include "cmStringAlgorithms.h"
#include "cmSystemTools.h"
namespace {
enum class ScopeType : std::uint8_t
{
VARIABLES,
POLICIES
};
using ScopeSet = cm::enum_set<ScopeType>;
class BlockScopePushPop
{
public:
BlockScopePushPop(cmMakefile* m, const ScopeSet& scopes);
~BlockScopePushPop() = default;
BlockScopePushPop(const BlockScopePushPop&) = delete;
BlockScopePushPop& operator=(const BlockScopePushPop&) = delete;
private:
std::unique_ptr<cmMakefile::PolicyPushPop> PolicyScope;
std::unique_ptr<cmMakefile::VariablePushPop> VariableScope;
};
BlockScopePushPop::BlockScopePushPop(cmMakefile* mf, const ScopeSet& scopes)
{
if (scopes.contains(ScopeType::POLICIES)) {
this->PolicyScope = cm::make_unique<cmMakefile::PolicyPushPop>(mf);
}
if (scopes.contains(ScopeType::VARIABLES)) {
this->VariableScope = cm::make_unique<cmMakefile::VariablePushPop>(mf);
}
}
class cmBlockFunctionBlocker : public cmFunctionBlocker
{
public:
cmBlockFunctionBlocker(cmMakefile* mf, const ScopeSet& scopes,
std::vector<std::string> variableNames);
~cmBlockFunctionBlocker() override;
cm::string_view StartCommandName() const override { return "block"_s; }
cm::string_view EndCommandName() const override { return "endblock"_s; }
bool EndCommandSupportsArguments() const override { return false; }
bool ArgumentsMatch(cmListFileFunction const& lff,
cmMakefile& mf) const override;
bool Replay(std::vector<cmListFileFunction> functions,
cmExecutionStatus& inStatus) override;
private:
cmMakefile* Makefile;
ScopeSet Scopes;
BlockScopePushPop BlockScope;
std::vector<std::string> VariableNames;
};
cmBlockFunctionBlocker::cmBlockFunctionBlocker(
cmMakefile* const mf, const ScopeSet& scopes,
std::vector<std::string> variableNames)
: Makefile{ mf }
, Scopes{ scopes }
, BlockScope{ mf, scopes }
, VariableNames{ std::move(variableNames) }
{
}
cmBlockFunctionBlocker::~cmBlockFunctionBlocker()
{
if (this->Scopes.contains(ScopeType::VARIABLES)) {
this->Makefile->RaiseScope(this->VariableNames);
}
}
bool cmBlockFunctionBlocker::ArgumentsMatch(cmListFileFunction const& lff,
cmMakefile&) const
{
// no arguments expected for endblock()
// but this method should not be called because EndCommandHasArguments()
// returns false.
return lff.Arguments().empty();
}
bool cmBlockFunctionBlocker::Replay(std::vector<cmListFileFunction> functions,
cmExecutionStatus& inStatus)
{
auto& mf = inStatus.GetMakefile();
// Invoke all the functions that were collected in the block.
for (cmListFileFunction const& fn : functions) {
cmExecutionStatus status(mf);
mf.ExecuteCommand(fn, status);
if (status.GetReturnInvoked()) {
mf.RaiseScope(status.GetReturnVariables());
inStatus.SetReturnInvoked(status.GetReturnVariables());
return true;
}
if (status.GetBreakInvoked()) {
inStatus.SetBreakInvoked();
return true;
}
if (status.GetContinueInvoked()) {
inStatus.SetContinueInvoked();
return true;
}
if (cmSystemTools::GetFatalErrorOccurred()) {
return true;
}
}
return true;
}
} // anonymous namespace
bool cmBlockCommand(std::vector<std::string> const& args,
cmExecutionStatus& status)
{
struct Arguments : public ArgumentParser::ParseResult
{
cm::optional<ArgumentParser::NonEmpty<std::vector<std::string>>> ScopeFor;
ArgumentParser::MaybeEmpty<std::vector<std::string>> Propagate;
};
static auto const parser = cmArgumentParser<Arguments>{}
.Bind("SCOPE_FOR"_s, &Arguments::ScopeFor)
.Bind("PROPAGATE"_s, &Arguments::Propagate);
std::vector<std::string> unrecognizedArguments;
auto parsedArgs = parser.Parse(args, &unrecognizedArguments);
if (!unrecognizedArguments.empty()) {
status.SetError(cmStrCat("called with unsupported argument \"",
unrecognizedArguments[0], '"'));
cmSystemTools::SetFatalErrorOccurred();
return false;
}
if (parsedArgs.MaybeReportError(status.GetMakefile())) {
cmSystemTools::SetFatalErrorOccurred();
return true;
}
ScopeSet scopes;
if (parsedArgs.ScopeFor) {
for (auto const& scope : *parsedArgs.ScopeFor) {
if (scope == "VARIABLES"_s) {
scopes.insert(ScopeType::VARIABLES);
continue;
}
if (scope == "POLICIES"_s) {
scopes.insert(ScopeType::POLICIES);
continue;
}
status.SetError(cmStrCat("SCOPE_FOR unsupported scope \"", scope, '"'));
cmSystemTools::SetFatalErrorOccurred();
return false;
}
} else {
scopes = { ScopeType::VARIABLES, ScopeType::POLICIES };
}
if (!scopes.contains(ScopeType::VARIABLES) &&
!parsedArgs.Propagate.empty()) {
status.SetError(
"PROPAGATE cannot be specified without a new scope for VARIABLES");
cmSystemTools::SetFatalErrorOccurred();
return false;
}
// create a function blocker
auto fb = cm::make_unique<cmBlockFunctionBlocker>(
&status.GetMakefile(), scopes, parsedArgs.Propagate);
status.GetMakefile().AddFunctionBlocker(std::move(fb));
return true;
}
|
