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.
4
5 #include "gn/ninja_toolchain_writer.h"
6
7 #include <fstream>
8
9 #include "base/files/file_util.h"
10 #include "base/strings/stringize_macros.h"
11 #include "gn/build_settings.h"
12 #include "gn/builtin_tool.h"
13 #include "gn/c_tool.h"
14 #include "gn/filesystem_utils.h"
15 #include "gn/general_tool.h"
16 #include "gn/ninja_utils.h"
17 #include "gn/pool.h"
18 #include "gn/settings.h"
19 #include "gn/substitution_writer.h"
20 #include "gn/target.h"
21 #include "gn/toolchain.h"
22 #include "gn/trace.h"
23
24 namespace {
25
26 const char kIndent[] = " ";
27
28 } // namespace
29
NinjaToolchainWriter(const Settings * settings,const Toolchain * toolchain,std::ostream & out)30 NinjaToolchainWriter::NinjaToolchainWriter(const Settings* settings,
31 const Toolchain* toolchain,
32 std::ostream& out)
33 : settings_(settings),
34 toolchain_(toolchain),
35 out_(out),
36 path_output_(settings_->build_settings()->build_dir(),
37 settings_->build_settings()->root_path_utf8(),
38 ESCAPE_NINJA) {}
39
40 NinjaToolchainWriter::~NinjaToolchainWriter() = default;
41
Run(const std::vector<NinjaWriter::TargetRulePair> & rules)42 void NinjaToolchainWriter::Run(
43 const std::vector<NinjaWriter::TargetRulePair>& rules) {
44 std::string rule_prefix = GetNinjaRulePrefixForToolchain(settings_);
45
46 for (const auto& tool : toolchain_->tools()) {
47 if (tool.second->name() == GeneralTool::kGeneralToolAction ||
48 tool.second->AsBuiltin()) {
49 continue;
50 }
51 WriteToolRule(tool.second.get(), rule_prefix);
52 }
53 out_ << std::endl;
54
55 for (const auto& pair : rules)
56 out_ << pair.second;
57 }
58
59 // static
RunAndWriteFile(const Settings * settings,const Toolchain * toolchain,const std::vector<NinjaWriter::TargetRulePair> & rules)60 bool NinjaToolchainWriter::RunAndWriteFile(
61 const Settings* settings,
62 const Toolchain* toolchain,
63 const std::vector<NinjaWriter::TargetRulePair>& rules) {
64 base::FilePath ninja_file(settings->build_settings()->GetFullPath(
65 GetNinjaFileForToolchain(settings)));
66 ScopedTrace trace(TraceItem::TRACE_FILE_WRITE, FilePathToUTF8(ninja_file));
67
68 base::CreateDirectory(ninja_file.DirName());
69
70 std::ofstream file;
71 file.open(FilePathToUTF8(ninja_file).c_str(),
72 std::ios_base::out | std::ios_base::binary);
73 if (file.fail())
74 return false;
75
76 NinjaToolchainWriter gen(settings, toolchain, file);
77 gen.Run(rules);
78 return true;
79 }
80
WriteToolRule(Tool * tool,const std::string & rule_prefix)81 void NinjaToolchainWriter::WriteToolRule(Tool* tool,
82 const std::string& rule_prefix) {
83 out_ << "rule " << rule_prefix << tool->name() << std::endl;
84
85 // Rules explicitly include shell commands, so don't try to escape.
86 EscapeOptions options;
87 options.mode = ESCAPE_NINJA_PREFORMATTED_COMMAND;
88
89 WriteCommandRulePattern("command", tool->command_launcher(), tool->command(),
90 options);
91
92 WriteRulePattern("description", tool->description(), options);
93 WriteRulePattern("rspfile", tool->rspfile(), options);
94 WriteRulePattern("rspfile_content", tool->rspfile_content(), options);
95
96 if (CTool* c_tool = tool->AsC()) {
97 if (c_tool->depsformat() == CTool::DEPS_GCC) {
98 // GCC-style deps require a depfile.
99 if (!c_tool->depfile().empty()) {
100 WriteRulePattern("depfile", tool->depfile(), options);
101 out_ << kIndent << "deps = gcc" << std::endl;
102 }
103 } else if (c_tool->depsformat() == CTool::DEPS_MSVC) {
104 // MSVC deps don't have a depfile.
105 out_ << kIndent << "deps = msvc" << std::endl;
106 }
107 } else if (!tool->depfile().empty()) {
108 WriteRulePattern("depfile", tool->depfile(), options);
109 out_ << kIndent << "deps = gcc" << std::endl;
110 }
111
112 // Use pool is specified.
113 if (tool->pool().ptr) {
114 std::string pool_name =
115 tool->pool().ptr->GetNinjaName(settings_->default_toolchain_label());
116 out_ << kIndent << "pool = " << pool_name << std::endl;
117 }
118
119 if (tool->restat())
120 out_ << kIndent << "restat = 1" << std::endl;
121 }
122
WriteRulePattern(const char * name,const SubstitutionPattern & pattern,const EscapeOptions & options)123 void NinjaToolchainWriter::WriteRulePattern(const char* name,
124 const SubstitutionPattern& pattern,
125 const EscapeOptions& options) {
126 if (pattern.empty())
127 return;
128 out_ << kIndent << name << " = ";
129 SubstitutionWriter::WriteWithNinjaVariables(pattern, options, out_);
130 out_ << std::endl;
131 }
132
WriteCommandRulePattern(const char * name,const std::string & launcher,const SubstitutionPattern & command,const EscapeOptions & options)133 void NinjaToolchainWriter::WriteCommandRulePattern(
134 const char* name,
135 const std::string& launcher,
136 const SubstitutionPattern& command,
137 const EscapeOptions& options) {
138 CHECK(!command.empty()) << "Command should not be empty";
139 out_ << kIndent << name << " = " ;
140 if (!launcher.empty())
141 out_ << launcher << " ";
142 SubstitutionWriter::WriteWithNinjaVariables(command, options, out_);
143 out_ << std::endl;
144 }
145