1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "tools/gn/target_generator.h"
7 #include "tools/gn/action_target_generator.h"
8 #include "tools/gn/binary_target_generator.h"
9 #include "tools/gn/build_settings.h"
10 #include "tools/gn/config.h"
11 #include "tools/gn/copy_target_generator.h"
12 #include "tools/gn/err.h"
13 #include "tools/gn/filesystem_utils.h"
14 #include "tools/gn/functions.h"
15 #include "tools/gn/group_target_generator.h"
16 #include "tools/gn/parse_tree.h"
17 #include "tools/gn/scheduler.h"
18 #include "tools/gn/scope.h"
19 #include "tools/gn/token.h"
20 #include "tools/gn/value.h"
21 #include "tools/gn/value_extractors.h"
22 #include "tools/gn/variables.h"
24 TargetGenerator::TargetGenerator(Target* target,
26 const FunctionCallNode* function_call,
30 function_call_(function_call),
34 TargetGenerator::~TargetGenerator() {
37 void TargetGenerator::Run() {
38 // All target types use these.
39 if (!FillDependentConfigs())
45 if (!FillDependencies())
51 if (!Visibility::FillItemVisibility(target_, scope_, err_))
54 // Do type-specific generation.
59 void TargetGenerator::GenerateTarget(Scope* scope,
60 const FunctionCallNode* function_call,
61 const std::vector<Value>& args,
62 const std::string& output_type,
64 // Name is the argument to the function.
65 if (args.size() != 1u || args[0].type() != Value::STRING) {
66 *err = Err(function_call,
67 "Target generator requires one string argument.",
68 "Otherwise I'm not sure what to call this target.");
72 // The location of the target is the directory name with no slash at the end.
73 // FIXME(brettw) validate name.
74 const Label& toolchain_label = ToolchainLabelForScope(scope);
75 Label label(scope->GetSourceDir(), args[0].string_value(),
76 toolchain_label.dir(), toolchain_label.name());
78 if (g_scheduler->verbose_logging())
79 g_scheduler->Log("Defining target", label.GetUserVisibleName(true));
81 scoped_ptr<Target> target(new Target(scope->settings(), label));
82 target->set_defined_from(function_call);
84 // Create and call out to the proper generator.
85 if (output_type == functions::kCopy) {
86 CopyTargetGenerator generator(target.get(), scope, function_call, err);
88 } else if (output_type == functions::kAction) {
89 ActionTargetGenerator generator(target.get(), scope, function_call,
92 } else if (output_type == functions::kActionForEach) {
93 ActionTargetGenerator generator(target.get(), scope, function_call,
94 Target::ACTION_FOREACH, err);
96 } else if (output_type == functions::kExecutable) {
97 BinaryTargetGenerator generator(target.get(), scope, function_call,
98 Target::EXECUTABLE, err);
100 } else if (output_type == functions::kGroup) {
101 GroupTargetGenerator generator(target.get(), scope, function_call, err);
103 } else if (output_type == functions::kSharedLibrary) {
104 BinaryTargetGenerator generator(target.get(), scope, function_call,
105 Target::SHARED_LIBRARY, err);
107 } else if (output_type == functions::kSourceSet) {
108 BinaryTargetGenerator generator(target.get(), scope, function_call,
109 Target::SOURCE_SET, err);
111 } else if (output_type == functions::kStaticLibrary) {
112 BinaryTargetGenerator generator(target.get(), scope, function_call,
113 Target::STATIC_LIBRARY, err);
116 *err = Err(function_call, "Not a known output type",
117 "I am very confused.");
120 if (err->has_error())
123 // Save this target for the file.
124 Scope::ItemVector* collector = scope->GetItemCollector();
126 *err = Err(function_call, "Can't define a target in this context.");
129 collector->push_back(target.release());
132 const BuildSettings* TargetGenerator::GetBuildSettings() const {
133 return scope_->settings()->build_settings();
136 bool TargetGenerator::FillSources() {
137 const Value* value = scope_->GetValue(variables::kSources, true);
141 Target::FileList dest_sources;
142 if (!ExtractListOfRelativeFiles(scope_->settings()->build_settings(), *value,
143 scope_->GetSourceDir(), &dest_sources, err_))
145 target_->sources().swap(dest_sources);
149 bool TargetGenerator::FillPublic() {
150 const Value* value = scope_->GetValue(variables::kPublic, true);
154 // If the public headers are defined, don't default to public.
155 target_->set_all_headers_public(false);
157 Target::FileList dest_public;
158 if (!ExtractListOfRelativeFiles(scope_->settings()->build_settings(), *value,
159 scope_->GetSourceDir(), &dest_public, err_))
161 target_->public_headers().swap(dest_public);
165 bool TargetGenerator::FillInputs() {
166 const Value* value = scope_->GetValue(variables::kInputs, true);
168 // Older versions used "source_prereqs". Allow use of this variable until
169 // all callers are updated.
170 // TODO(brettw) remove this eventually.
171 value = scope_->GetValue("source_prereqs", true);
176 Target::FileList dest_inputs;
177 if (!ExtractListOfRelativeFiles(scope_->settings()->build_settings(), *value,
178 scope_->GetSourceDir(), &dest_inputs, err_))
180 target_->inputs().swap(dest_inputs);
184 bool TargetGenerator::FillConfigs() {
185 return FillGenericConfigs(variables::kConfigs, &target_->configs());
188 bool TargetGenerator::FillDependentConfigs() {
189 if (!FillGenericConfigs(variables::kAllDependentConfigs,
190 &target_->all_dependent_configs()))
192 if (!FillGenericConfigs(variables::kPublicConfigs,
193 &target_->public_configs()))
196 // "public_configs" was previously named "direct_dependent_configs", fall
197 // back to that if public_configs was undefined.
198 if (!scope_->GetValue(variables::kPublicConfigs, false)) {
199 if (!FillGenericConfigs("direct_dependent_configs",
200 &target_->public_configs()))
206 bool TargetGenerator::FillData() {
207 const Value* value = scope_->GetValue(variables::kData, true);
211 Target::FileList dest_data;
212 if (!ExtractListOfRelativeFiles(scope_->settings()->build_settings(), *value,
213 scope_->GetSourceDir(), &dest_data, err_))
215 target_->data().swap(dest_data);
219 bool TargetGenerator::FillDependencies() {
220 if (!FillGenericDeps(variables::kDeps, &target_->private_deps()))
222 if (!FillGenericDeps(variables::kPublicDeps, &target_->public_deps()))
224 if (!FillGenericDeps(variables::kDataDeps, &target_->data_deps()))
227 // "data_deps" was previously named "datadeps". For backwards-compat, read
228 // the old one if no "data_deps" were specified.
229 if (!scope_->GetValue(variables::kDataDeps, false)) {
230 if (!FillGenericDeps("datadeps", &target_->data_deps()))
234 // This is a list of dependent targets to have their configs fowarded, so
235 // it goes here rather than in FillConfigs.
236 if (!FillForwardDependentConfigs())
241 bool TargetGenerator::FillTestonly() {
242 const Value* value = scope_->GetValue(variables::kTestonly, true);
244 if (!value->VerifyTypeIs(Value::BOOLEAN, err_))
246 target_->set_testonly(value->boolean_value());
251 bool TargetGenerator::FillOutputs(bool allow_substitutions) {
252 const Value* value = scope_->GetValue(variables::kOutputs, true);
256 SubstitutionList& outputs = target_->action_values().outputs();
257 if (!outputs.Parse(*value, err_))
260 if (!allow_substitutions) {
261 // Verify no substitutions were actually used.
262 if (!outputs.required_types().empty()) {
263 *err_ = Err(*value, "Source expansions not allowed here.",
264 "The outputs of this target used source {{expansions}} but this "
265 "targe type\ndoesn't support them. Just express the outputs "
271 // Check the substitutions used are valid for this purpose.
272 if (!EnsureValidSourcesSubstitutions(outputs.required_types(),
273 value->origin(), err_))
276 // Validate that outputs are in the output dir.
277 CHECK(outputs.list().size() == value->list_value().size());
278 for (size_t i = 0; i < outputs.list().size(); i++) {
279 if (!EnsureSubstitutionIsInOutputDir(outputs.list()[i],
280 value->list_value()[i]))
286 bool TargetGenerator::EnsureSubstitutionIsInOutputDir(
287 const SubstitutionPattern& pattern,
288 const Value& original_value) {
289 if (pattern.ranges().empty()) {
290 // Pattern is empty, error out (this prevents weirdness below).
291 *err_ = Err(original_value, "This has an empty value in it.");
295 if (pattern.ranges()[0].type == SUBSTITUTION_LITERAL) {
296 // If the first thing is a literal, it must start with the output dir.
297 if (!EnsureStringIsInOutputDir(
298 GetBuildSettings()->build_dir(),
299 pattern.ranges()[0].literal, original_value.origin(), err_))
302 // Otherwise, the first subrange must be a pattern that expands to
303 // something in the output directory.
304 if (!SubstitutionIsInOutputDir(pattern.ranges()[0].type)) {
305 *err_ = Err(original_value,
306 "File is not inside output directory.",
307 "The given file should be in the output directory. Normally you\n"
308 "would specify\n\"$target_out_dir/foo\" or "
309 "\"{{source_gen_dir}}/foo\".");
317 bool TargetGenerator::FillGenericConfigs(const char* var_name,
318 UniqueVector<LabelConfigPair>* dest) {
319 const Value* value = scope_->GetValue(var_name, true);
321 ExtractListOfUniqueLabels(*value, scope_->GetSourceDir(),
322 ToolchainLabelForScope(scope_), dest, err_);
324 return !err_->has_error();
327 bool TargetGenerator::FillGenericDeps(const char* var_name,
328 LabelTargetVector* dest) {
329 const Value* value = scope_->GetValue(var_name, true);
331 ExtractListOfLabels(*value, scope_->GetSourceDir(),
332 ToolchainLabelForScope(scope_), dest, err_);
334 return !err_->has_error();
337 bool TargetGenerator::FillForwardDependentConfigs() {
338 const Value* value = scope_->GetValue(
339 variables::kForwardDependentConfigsFrom, true);
341 ExtractListOfUniqueLabels(*value, scope_->GetSourceDir(),
342 ToolchainLabelForScope(scope_),
343 &target_->forward_dependent_configs(), err_);
345 return !err_->has_error();