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
|
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "tools/gn/action_target_generator.h"
#include "tools/gn/build_settings.h"
#include "tools/gn/err.h"
#include "tools/gn/filesystem_utils.h"
#include "tools/gn/parse_tree.h"
#include "tools/gn/scope.h"
#include "tools/gn/value.h"
#include "tools/gn/value_extractors.h"
#include "tools/gn/variables.h"
ActionTargetGenerator::ActionTargetGenerator(
Target* target,
Scope* scope,
const FunctionCallNode* function_call,
Target::OutputType type,
Err* err)
: TargetGenerator(target, scope, function_call, err),
output_type_(type) {
}
ActionTargetGenerator::~ActionTargetGenerator() {
}
void ActionTargetGenerator::DoRun() {
target_->set_output_type(output_type_);
if (!FillSources())
return;
if (output_type_ == Target::ACTION_FOREACH && target_->sources().empty()) {
// Foreach rules must always have some sources to have an effect.
*err_ = Err(function_call_, "action_foreach target has no sources.",
"If you don't specify any sources, there is nothing to run your\n"
"script over.");
return;
}
if (!FillInputs())
return;
if (!FillScript())
return;
if (!FillScriptArgs())
return;
if (!FillResponseFileContents())
return;
if (!FillOutputs(output_type_ == Target::ACTION_FOREACH))
return;
if (!FillDepfile())
return;
if (!FillConsole())
return;
if (!FillCheckIncludes())
return;
if (!CheckOutputs())
return;
// Action outputs don't depend on the current toolchain so we can skip adding
// that dependency.
// response_file_contents and {{response_file_name}} in the args must go
// together.
const auto& required_args_substitutions =
target_->action_values().args().required_types();
bool has_rsp_file_name = std::find(required_args_substitutions.begin(),
required_args_substitutions.end(),
SUBSTITUTION_RSP_FILE_NAME) !=
required_args_substitutions.end();
if (target_->action_values().uses_rsp_file() && !has_rsp_file_name) {
*err_ = Err(function_call_, "Missing {{response_file_name}} in args.",
"This target defines response_file_contents but doesn't use\n"
"{{response_file_name}} in the args, which means the response file\n"
"will be unused.");
return;
}
if (!target_->action_values().uses_rsp_file() && has_rsp_file_name) {
*err_ = Err(function_call_, "Missing response_file_contents definition.",
"This target uses {{response_file_name}} in the args, but does not\n"
"define response_file_contents which means the response file\n"
"will be empty.");
return;
}
}
bool ActionTargetGenerator::FillScript() {
// If this gets called, the target type requires a script, so error out
// if it doesn't have one.
const Value* value = scope_->GetValue(variables::kScript, true);
if (!value) {
*err_ = Err(function_call_, "This target type requires a \"script\".");
return false;
}
if (!value->VerifyTypeIs(Value::STRING, err_))
return false;
SourceFile script_file =
scope_->GetSourceDir().ResolveRelativeFile(
*value, err_,
scope_->settings()->build_settings()->root_path_utf8());
if (err_->has_error())
return false;
target_->action_values().set_script(script_file);
return true;
}
bool ActionTargetGenerator::FillScriptArgs() {
const Value* value = scope_->GetValue(variables::kArgs, true);
if (!value)
return true;
return target_->action_values().args().Parse(*value, err_);
}
bool ActionTargetGenerator::FillResponseFileContents() {
const Value* value = scope_->GetValue(variables::kResponseFileContents, true);
if (!value)
return true;
return target_->action_values().rsp_file_contents().Parse(*value, err_);
}
bool ActionTargetGenerator::FillDepfile() {
const Value* value = scope_->GetValue(variables::kDepfile, true);
if (!value)
return true;
SubstitutionPattern depfile;
if (!depfile.Parse(*value, err_))
return false;
if (!EnsureSubstitutionIsInOutputDir(depfile, *value))
return false;
target_->action_values().set_depfile(depfile);
return true;
}
bool ActionTargetGenerator::FillConsole() {
const Value* value = scope_->GetValue(variables::kConsole, true);
if (!value)
return true;
if (!value->VerifyTypeIs(Value::BOOLEAN, err_))
return false;
target_->action_values().set_console(value->boolean_value());
return true;
}
bool ActionTargetGenerator::CheckOutputs() {
const SubstitutionList& outputs = target_->action_values().outputs();
if (outputs.list().empty()) {
*err_ = Err(function_call_, "Action has no outputs.",
"If you have no outputs, the build system can not tell when your\n"
"script needs to be run.");
return false;
}
if (output_type_ == Target::ACTION) {
if (!outputs.required_types().empty()) {
*err_ = Err(function_call_, "Action has patterns in the output.",
"An action target should have the outputs completely specified. If\n"
"you want to provide a mapping from source to output, use an\n"
"\"action_foreach\" target.");
return false;
}
} else if (output_type_ == Target::ACTION_FOREACH) {
// A foreach target should always have a pattern in the outputs.
if (outputs.required_types().empty()) {
*err_ = Err(function_call_,
"action_foreach should have a pattern in the output.",
"An action_foreach target should have a source expansion pattern in\n"
"it to map source file to unique output file name. Otherwise, the\n"
"build system can't determine when your script needs to be run.");
return false;
}
}
return true;
}
|
