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
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#include "cmWhileCommand.h"
#include <string>
#include <utility>
#include <cm/memory>
#include <cm/string_view>
#include <cmext/string_view>
#include "cmConditionEvaluator.h"
#include "cmExecutionStatus.h"
#include "cmExpandedCommandArgument.h"
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
#include "cmMakefile.h"
#include "cmMessageType.h"
#include "cmOutputConverter.h"
#include "cmPolicies.h"
#include "cmStringAlgorithms.h"
#include "cmSystemTools.h"
#include "cmake.h"
class cmWhileFunctionBlocker : public cmFunctionBlocker
{
public:
cmWhileFunctionBlocker(cmMakefile* mf, std::vector<cmListFileArgument> args);
~cmWhileFunctionBlocker() override;
cm::string_view StartCommandName() const override { return "while"_s; }
cm::string_view EndCommandName() const override { return "endwhile"_s; }
bool ArgumentsMatch(cmListFileFunction const& lff,
cmMakefile& mf) const override;
bool Replay(std::vector<cmListFileFunction> functions,
cmExecutionStatus& inStatus) override;
private:
cmMakefile* Makefile;
std::vector<cmListFileArgument> Args;
};
cmWhileFunctionBlocker::cmWhileFunctionBlocker(
cmMakefile* const mf, std::vector<cmListFileArgument> args)
: Makefile{ mf }
, Args{ std::move(args) }
{
this->Makefile->PushLoopBlock();
}
cmWhileFunctionBlocker::~cmWhileFunctionBlocker()
{
this->Makefile->PopLoopBlock();
}
bool cmWhileFunctionBlocker::ArgumentsMatch(cmListFileFunction const& lff,
cmMakefile&) const
{
return lff.Arguments().empty() || lff.Arguments() == this->Args;
}
bool cmWhileFunctionBlocker::Replay(std::vector<cmListFileFunction> functions,
cmExecutionStatus& inStatus)
{
auto& mf = inStatus.GetMakefile();
cmListFileBacktrace whileBT =
mf.GetBacktrace().Push(this->GetStartingContext());
std::vector<cmExpandedCommandArgument> expandedArguments;
// At least same size expected for `expandedArguments` as `Args`
expandedArguments.reserve(this->Args.size());
auto expandArgs = [&mf](std::vector<cmListFileArgument> const& args,
std::vector<cmExpandedCommandArgument>& out)
-> std::vector<cmExpandedCommandArgument>& {
out.clear();
mf.ExpandArguments(args, out);
return out;
};
// For compatibility with projects that do not set CMP0130 to NEW,
// we tolerate condition errors that evaluate to false.
bool enforceError = true;
std::string errorString;
MessageType messageType;
for (cmConditionEvaluator conditionEvaluator(mf, whileBT);
(enforceError = /* enforce condition errors that evaluate to true */
conditionEvaluator.IsTrue(expandArgs(this->Args, expandedArguments),
errorString, messageType));) {
// 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()) {
inStatus.SetReturnInvoked(status.GetReturnVariables());
return true;
}
if (status.GetBreakInvoked()) {
return true;
}
if (status.GetContinueInvoked()) {
break;
}
if (status.HasExitCode()) {
inStatus.SetExitCode(status.GetExitCode());
return true;
}
if (cmSystemTools::GetFatalErrorOccurred()) {
return true;
}
}
}
if (!errorString.empty() && !enforceError) {
// This error should only be enforced if CMP0130 is NEW.
switch (mf.GetPolicyStatus(cmPolicies::CMP0130)) {
case cmPolicies::WARN:
// Convert the error to a warning and enforce it.
messageType = MessageType::AUTHOR_WARNING;
enforceError = true;
break;
case cmPolicies::OLD:
// OLD behavior is to silently ignore the error.
break;
case cmPolicies::REQUIRED_ALWAYS:
case cmPolicies::REQUIRED_IF_USED:
case cmPolicies::NEW:
// NEW behavior is to enforce the error.
enforceError = true;
break;
}
}
if (!errorString.empty() && enforceError) {
std::string err = "while() given incorrect arguments:\n ";
for (auto const& i : expandedArguments) {
err += " ";
err += cmOutputConverter::EscapeForCMake(i.GetValue());
}
err += "\n";
err += errorString;
if (mf.GetPolicyStatus(cmPolicies::CMP0130) == cmPolicies::WARN) {
err =
cmStrCat(cmPolicies::GetPolicyWarning(cmPolicies::CMP0130), '\n', err);
}
mf.GetCMakeInstance()->IssueMessage(messageType, err, whileBT);
if (messageType == MessageType::FATAL_ERROR) {
cmSystemTools::SetFatalErrorOccurred();
}
}
return true;
}
bool cmWhileCommand(std::vector<cmListFileArgument> const& args,
cmExecutionStatus& status)
{
if (args.empty()) {
status.SetError("called with incorrect number of arguments");
return false;
}
// create a function blocker
auto& makefile = status.GetMakefile();
makefile.AddFunctionBlocker(
cm::make_unique<cmWhileFunctionBlocker>(&makefile, args));
return true;
}
|
