blob: 6fe86107d6c0da53165c4aace3dd829b5c325114 [file] [log] [blame]
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Adam Lesinskice5e56e2016-10-21 17:56:45 -070017#include <dirent.h>
18
Adam Lesinskice5e56e2016-10-21 17:56:45 -070019#include <string>
20
Adam Lesinskid5083f62017-01-16 15:07:21 -080021#include "android-base/errors.h"
22#include "android-base/file.h"
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070023#include "android-base/utf8.h"
Adam Lesinskid5083f62017-01-16 15:07:21 -080024#include "androidfw/StringPiece.h"
25#include "google/protobuf/io/coded_stream.h"
26#include "google/protobuf/io/zero_copy_stream_impl_lite.h"
27
Adam Lesinski1ab598f2015-08-14 14:26:04 -070028#include "ConfigDescription.h"
29#include "Diagnostics.h"
30#include "Flags.h"
31#include "ResourceParser.h"
32#include "ResourceTable.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070033#include "compile/IdAssigner.h"
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070034#include "compile/InlineXmlFormatParser.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070035#include "compile/Png.h"
Adam Lesinski393b5f02015-12-17 13:03:11 -080036#include "compile/PseudolocaleGenerator.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070037#include "compile/XmlIdCollector.h"
Adam Lesinski46708052017-09-29 14:49:15 -070038#include "format/Archive.h"
Adam Lesinski00451162017-10-03 07:44:08 -070039#include "format/Container.h"
Adam Lesinski46708052017-09-29 14:49:15 -070040#include "format/proto/ProtoSerialize.h"
Adam Lesinski00451162017-10-03 07:44:08 -070041#include "io/BigBufferStream.h"
42#include "io/FileStream.h"
43#include "io/StringStream.h"
Adam Lesinskid0f492d2017-04-03 18:12:45 -070044#include "io/Util.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070045#include "util/Files.h"
46#include "util/Maybe.h"
47#include "util/Util.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080048#include "xml/XmlDom.h"
49#include "xml/XmlPullParser.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070050
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070051using ::aapt::io::FileInputStream;
Izabela Orlowskac81d9f32017-12-05 12:07:28 +000052using ::aapt::text::Printer;
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070053using ::android::StringPiece;
Adam Lesinski00451162017-10-03 07:44:08 -070054using ::android::base::SystemErrorCodeToString;
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070055using ::google::protobuf::io::CopyingOutputStreamAdaptor;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -070056
Adam Lesinski1ab598f2015-08-14 14:26:04 -070057namespace aapt {
58
59struct ResourcePathData {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070060 Source source;
Adam Lesinskice5e56e2016-10-21 17:56:45 -070061 std::string resource_dir;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070062 std::string name;
63 std::string extension;
Adam Lesinski1ab598f2015-08-14 14:26:04 -070064
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070065 // Original config str. We keep this because when we parse the config, we may add on
66 // version qualifiers. We want to preserve the original input so the output is easily
Adam Lesinskicacb28f2016-10-19 12:18:14 -070067 // computed before hand.
Adam Lesinskice5e56e2016-10-21 17:56:45 -070068 std::string config_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070069 ConfigDescription config;
Adam Lesinski1ab598f2015-08-14 14:26:04 -070070};
71
Adam Lesinskiefeb7af2017-08-02 14:57:43 -070072// Resource file paths are expected to look like: [--/res/]type[-config]/name
Adam Lesinskice5e56e2016-10-21 17:56:45 -070073static Maybe<ResourcePathData> ExtractResourcePathData(const std::string& path,
74 std::string* out_error) {
75 std::vector<std::string> parts = util::Split(path, file::sDirSep);
Adam Lesinskicacb28f2016-10-19 12:18:14 -070076 if (parts.size() < 2) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -070077 if (out_error) *out_error = "bad resource path";
Adam Lesinskicacb28f2016-10-19 12:18:14 -070078 return {};
79 }
80
81 std::string& dir = parts[parts.size() - 2];
Adam Lesinskice5e56e2016-10-21 17:56:45 -070082 StringPiece dir_str = dir;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070083
Adam Lesinskice5e56e2016-10-21 17:56:45 -070084 StringPiece config_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -070085 ConfigDescription config;
Adam Lesinskice5e56e2016-10-21 17:56:45 -070086 size_t dash_pos = dir.find('-');
87 if (dash_pos != std::string::npos) {
88 config_str = dir_str.substr(dash_pos + 1, dir.size() - (dash_pos + 1));
89 if (!ConfigDescription::Parse(config_str, &config)) {
90 if (out_error) {
91 std::stringstream err_str;
92 err_str << "invalid configuration '" << config_str << "'";
93 *out_error = err_str.str();
Adam Lesinskicacb28f2016-10-19 12:18:14 -070094 }
95 return {};
Adam Lesinski1ab598f2015-08-14 14:26:04 -070096 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -070097 dir_str = dir_str.substr(0, dash_pos);
Adam Lesinskicacb28f2016-10-19 12:18:14 -070098 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -070099
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700100 std::string& filename = parts[parts.size() - 1];
101 StringPiece name = filename;
102 StringPiece extension;
yd6b83292018-04-11 09:54:56 -0700103
104 const std::string kNinePng = ".9.png";
105 if (filename.size() > kNinePng.size()
106 && std::equal(kNinePng.rbegin(), kNinePng.rend(), filename.rbegin())) {
107 // Split on .9.png if this extension is present at the end of the file path
108 name = name.substr(0, filename.size() - kNinePng.size());
109 extension = "9.png";
110 } else {
111 // Split on the last period occurrence
112 size_t dot_pos = filename.rfind('.');
113 if (dot_pos != std::string::npos) {
114 extension = name.substr(dot_pos + 1, filename.size() - (dot_pos + 1));
115 name = name.substr(0, dot_pos);
116 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700117 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700118
Adam Lesinskid5083f62017-01-16 15:07:21 -0800119 return ResourcePathData{Source(path), dir_str.to_string(), name.to_string(),
120 extension.to_string(), config_str.to_string(), config};
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700121}
122
123struct CompileOptions {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700124 std::string output_path;
125 Maybe<std::string> res_dir;
Izabela Orlowskac81d9f32017-12-05 12:07:28 +0000126 Maybe<std::string> generate_text_symbols_path;
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100127 Maybe<Visibility::Level> visibility;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700128 bool pseudolocalize = false;
Adam Lesinski28e6c0b2017-05-10 14:56:36 -0700129 bool no_png_crunch = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700130 bool legacy_mode = false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700131 bool verbose = false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700132};
133
Adam Lesinski00451162017-10-03 07:44:08 -0700134static std::string BuildIntermediateContainerFilename(const ResourcePathData& data) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700135 std::stringstream name;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700136 name << data.resource_dir;
137 if (!data.config_str.empty()) {
138 name << "-" << data.config_str;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700139 }
140 name << "_" << data.name;
141 if (!data.extension.empty()) {
142 name << "." << data.extension;
143 }
144 name << ".flat";
145 return name.str();
Adam Lesinskia40e9722015-11-24 19:11:46 -0800146}
147
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700148static bool IsHidden(const StringPiece& filename) {
149 return util::StartsWith(filename, ".");
Adam Lesinskia40e9722015-11-24 19:11:46 -0800150}
151
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700152// Walks the res directory structure, looking for resource files.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700153static bool LoadInputFilesFromDir(IAaptContext* context, const CompileOptions& options,
154 std::vector<ResourcePathData>* out_path_data) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700155 const std::string& root_dir = options.res_dir.value();
Adam Lesinski06460ef2017-03-14 18:52:13 -0700156 std::unique_ptr<DIR, decltype(closedir)*> d(opendir(root_dir.data()), closedir);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700157 if (!d) {
Adam Lesinski60d9c2f2017-05-17 16:07:45 -0700158 context->GetDiagnostics()->Error(DiagMessage(root_dir) << "failed to open directory: "
Adam Lesinski00451162017-10-03 07:44:08 -0700159 << SystemErrorCodeToString(errno));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700160 return false;
161 }
162
163 while (struct dirent* entry = readdir(d.get())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700164 if (IsHidden(entry->d_name)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700165 continue;
166 }
167
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700168 std::string prefix_path = root_dir;
169 file::AppendPath(&prefix_path, entry->d_name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700170
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700171 if (file::GetFileType(prefix_path) != file::FileType::kDirectory) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700172 continue;
173 }
174
Adam Lesinski06460ef2017-03-14 18:52:13 -0700175 std::unique_ptr<DIR, decltype(closedir)*> subdir(opendir(prefix_path.data()), closedir);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700176 if (!subdir) {
Adam Lesinski60d9c2f2017-05-17 16:07:45 -0700177 context->GetDiagnostics()->Error(DiagMessage(prefix_path) << "failed to open directory: "
Adam Lesinski00451162017-10-03 07:44:08 -0700178 << SystemErrorCodeToString(errno));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700179 return false;
180 }
181
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700182 while (struct dirent* leaf_entry = readdir(subdir.get())) {
183 if (IsHidden(leaf_entry->d_name)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700184 continue;
185 }
186
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700187 std::string full_path = prefix_path;
188 file::AppendPath(&full_path, leaf_entry->d_name);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700189
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700190 std::string err_str;
Adam Lesinski06460ef2017-03-14 18:52:13 -0700191 Maybe<ResourcePathData> path_data = ExtractResourcePathData(full_path, &err_str);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700192 if (!path_data) {
Adam Lesinski60d9c2f2017-05-17 16:07:45 -0700193 context->GetDiagnostics()->Error(DiagMessage(full_path) << err_str);
Adam Lesinskia40e9722015-11-24 19:11:46 -0800194 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700195 }
196
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700197 out_path_data->push_back(std::move(path_data.value()));
Adam Lesinskia40e9722015-11-24 19:11:46 -0800198 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700199 }
Adam Lesinskie6aa6d12017-12-20 14:01:14 -0800200
201 // File-system directory enumeration order is platform-dependent. Sort the result to remove any
202 // inconsistencies between platforms.
203 std::sort(
204 out_path_data->begin(), out_path_data->end(),
205 [](const ResourcePathData& a, const ResourcePathData& b) { return a.source < b.source; });
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700206 return true;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700207}
208
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700209static bool CompileTable(IAaptContext* context, const CompileOptions& options,
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700210 const ResourcePathData& path_data, IArchiveWriter* writer,
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700211 const std::string& output_path) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700212 ResourceTable table;
213 {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700214 FileInputStream fin(path_data.source.path);
215 if (fin.HadError()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700216 context->GetDiagnostics()->Error(DiagMessage(path_data.source)
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700217 << "failed to open file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700218 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700219 }
220
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700221 // Parse the values file from XML.
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700222 xml::XmlPullParser xml_parser(&fin);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700223
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700224 ResourceParserOptions parser_options;
225 parser_options.error_on_positional_arguments = !options.legacy_mode;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700226
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700227 // If the filename includes donottranslate, then the default translatable is false.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700228 parser_options.translatable = path_data.name.find("donottranslate") == std::string::npos;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700229
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100230 // If visibility was forced, we need to use it when creating a new resource and also error if
231 // we try to parse the <public>, <public-group>, <java-symbol> or <symbol> tags.
232 parser_options.visibility = options.visibility;
233
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700234 ResourceParser res_parser(context->GetDiagnostics(), &table, path_data.source, path_data.config,
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700235 parser_options);
236 if (!res_parser.Parse(&xml_parser)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700237 return false;
Adam Lesinski393b5f02015-12-17 13:03:11 -0800238 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700239 }
Adam Lesinski83f22552015-11-07 11:51:23 -0800240
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700241 if (options.pseudolocalize) {
242 // Generate pseudo-localized strings (en-XA and ar-XB).
243 // These are created as weak symbols, and are only generated from default
244 // configuration
245 // strings and plurals.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700246 PseudolocaleGenerator pseudolocale_generator;
247 if (!pseudolocale_generator.Consume(context, &table)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700248 return false;
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700249 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700250 }
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700251
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700252 // Ensure we have the compilation package at least.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700253 table.CreatePackage(context->GetCompilationPackage());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700254
255 // Assign an ID to any package that has resources.
256 for (auto& pkg : table.packages) {
257 if (!pkg->id) {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700258 // If no package ID was set while parsing (public identifiers), auto assign an ID.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700259 pkg->id = context->GetPackageId();
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700260 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700261 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700262
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700263 // Create the file/zip entry.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700264 if (!writer->StartEntry(output_path, 0)) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700265 context->GetDiagnostics()->Error(DiagMessage(output_path) << "failed to open");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700266 return false;
267 }
Adam Lesinski59e04c62016-02-04 15:59:23 -0800268
Adam Lesinski00451162017-10-03 07:44:08 -0700269 // Make sure CopyingOutputStreamAdaptor is deleted before we call writer->FinishEntry().
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700270 {
Adam Lesinski00451162017-10-03 07:44:08 -0700271 // Wrap our IArchiveWriter with an adaptor that implements the ZeroCopyOutputStream interface.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700272 CopyingOutputStreamAdaptor copying_adaptor(writer);
Adam Lesinski00451162017-10-03 07:44:08 -0700273 ContainerWriter container_writer(&copying_adaptor, 1u);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700274
Adam Lesinski8cdca1b2017-09-28 15:50:03 -0700275 pb::ResourceTable pb_table;
Ryan Mitchella15c2a82018-03-26 11:05:31 -0700276 SerializeTableToPb(table, &pb_table, context->GetDiagnostics());
Adam Lesinski00451162017-10-03 07:44:08 -0700277 if (!container_writer.AddResTableEntry(pb_table)) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700278 context->GetDiagnostics()->Error(DiagMessage(output_path) << "failed to write");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700279 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700280 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700281 }
Adam Lesinskia40e9722015-11-24 19:11:46 -0800282
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700283 if (!writer->FinishEntry()) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700284 context->GetDiagnostics()->Error(DiagMessage(output_path) << "failed to finish entry");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700285 return false;
286 }
Izabela Orlowskac81d9f32017-12-05 12:07:28 +0000287
288 if (options.generate_text_symbols_path) {
289 io::FileOutputStream fout_text(options.generate_text_symbols_path.value());
290
291 if (fout_text.HadError()) {
292 context->GetDiagnostics()->Error(DiagMessage()
293 << "failed writing to'"
294 << options.generate_text_symbols_path.value()
295 << "': " << fout_text.GetError());
296 return false;
297 }
298
299 Printer r_txt_printer(&fout_text);
300 for (const auto& package : table.packages) {
301 for (const auto& type : package->types) {
302 for (const auto& entry : type->entries) {
303 // Check access modifiers.
304 switch(entry->visibility.level) {
305 case Visibility::Level::kUndefined :
306 r_txt_printer.Print("default ");
307 break;
308 case Visibility::Level::kPublic :
309 r_txt_printer.Print("public ");
310 break;
311 case Visibility::Level::kPrivate :
312 r_txt_printer.Print("private ");
313 }
314
315 if (type->type != ResourceType::kStyleable) {
316 r_txt_printer.Print("int ");
317 r_txt_printer.Print(to_string(type->type));
318 r_txt_printer.Print(" ");
319 r_txt_printer.Println(entry->name);
320 } else {
321 r_txt_printer.Print("int[] styleable ");
322 r_txt_printer.Println(entry->name);
323
324 if (!entry->values.empty()) {
325 auto styleable = static_cast<const Styleable*>(entry->values.front()->value.get());
326 for (const auto& attr : styleable->entries) {
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100327 // The visibility of the children under the styleable does not matter as they are
328 // nested under their parent and use its visibility.
Izabela Orlowskac81d9f32017-12-05 12:07:28 +0000329 r_txt_printer.Print("default int styleable ");
330 r_txt_printer.Print(entry->name);
331 r_txt_printer.Print("_");
332 r_txt_printer.Println(attr.name.value().entry);
333 }
334 }
335 }
336 }
337 }
338 }
339 }
340
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700341 return true;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800342}
343
Adam Lesinski00451162017-10-03 07:44:08 -0700344static bool WriteHeaderAndDataToWriter(const StringPiece& output_path, const ResourceFile& file,
345 io::KnownSizeInputStream* in, IArchiveWriter* writer,
Adam Lesinski59e04c62016-02-04 15:59:23 -0800346 IDiagnostics* diag) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700347 // Start the entry so we can write the header.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700348 if (!writer->StartEntry(output_path, 0)) {
349 diag->Error(DiagMessage(output_path) << "failed to open file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700350 return false;
351 }
352
Adam Lesinski00451162017-10-03 07:44:08 -0700353 // Make sure CopyingOutputStreamAdaptor is deleted before we call writer->FinishEntry().
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700354 {
Adam Lesinski00451162017-10-03 07:44:08 -0700355 // Wrap our IArchiveWriter with an adaptor that implements the ZeroCopyOutputStream interface.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700356 CopyingOutputStreamAdaptor copying_adaptor(writer);
Adam Lesinski00451162017-10-03 07:44:08 -0700357 ContainerWriter container_writer(&copying_adaptor, 1u);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700358
Adam Lesinski8cdca1b2017-09-28 15:50:03 -0700359 pb::internal::CompiledFile pb_compiled_file;
360 SerializeCompiledFileToPb(file, &pb_compiled_file);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700361
Adam Lesinski00451162017-10-03 07:44:08 -0700362 if (!container_writer.AddResFileEntry(pb_compiled_file, in)) {
363 diag->Error(DiagMessage(output_path) << "failed to write entry data");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700364 return false;
Adam Lesinski59e04c62016-02-04 15:59:23 -0800365 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700366 }
Adam Lesinski59e04c62016-02-04 15:59:23 -0800367
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700368 if (!writer->FinishEntry()) {
369 diag->Error(DiagMessage(output_path) << "failed to finish writing data");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700370 return false;
371 }
372 return true;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700373}
374
Adam Lesinski00451162017-10-03 07:44:08 -0700375static bool FlattenXmlToOutStream(const StringPiece& output_path, const xml::XmlResource& xmlres,
376 ContainerWriter* container_writer, IDiagnostics* diag) {
Adam Lesinski8cdca1b2017-09-28 15:50:03 -0700377 pb::internal::CompiledFile pb_compiled_file;
Adam Lesinski00451162017-10-03 07:44:08 -0700378 SerializeCompiledFileToPb(xmlres.file, &pb_compiled_file);
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700379
Adam Lesinski00451162017-10-03 07:44:08 -0700380 pb::XmlNode pb_xml_node;
381 SerializeXmlToPb(*xmlres.root, &pb_xml_node);
382
383 std::string serialized_xml = pb_xml_node.SerializeAsString();
384 io::StringInputStream serialized_in(serialized_xml);
385
386 if (!container_writer->AddResFileEntry(pb_compiled_file, &serialized_in)) {
387 diag->Error(DiagMessage(output_path) << "failed to write entry data");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700388 return false;
389 }
390 return true;
Adam Lesinski5eeaadd2016-08-25 12:26:56 -0700391}
392
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700393static bool IsValidFile(IAaptContext* context, const std::string& input_path) {
Adam Lesinski776aa952017-04-24 15:09:32 -0700394 const file::FileType file_type = file::GetFileType(input_path);
395 if (file_type != file::FileType::kRegular && file_type != file::FileType::kSymlink) {
396 if (file_type == file::FileType::kDirectory) {
397 context->GetDiagnostics()->Error(DiagMessage(input_path)
398 << "resource file cannot be a directory");
Adam Lesinskicc73e992017-05-12 18:16:44 -0700399 } else if (file_type == file::FileType::kNonexistant) {
400 context->GetDiagnostics()->Error(DiagMessage(input_path) << "file not found");
Adam Lesinski776aa952017-04-24 15:09:32 -0700401 } else {
402 context->GetDiagnostics()->Error(DiagMessage(input_path)
403 << "not a valid resource file");
404 }
405 return false;
406 }
407 return true;
408}
409
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700410static bool CompileXml(IAaptContext* context, const CompileOptions& options,
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700411 const ResourcePathData& path_data, IArchiveWriter* writer,
412 const std::string& output_path) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700413 if (context->IsVerbose()) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700414 context->GetDiagnostics()->Note(DiagMessage(path_data.source) << "compiling XML");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700415 }
416
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700417 std::unique_ptr<xml::XmlResource> xmlres;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700418 {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700419 FileInputStream fin(path_data.source.path);
420 if (fin.HadError()) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700421 context->GetDiagnostics()->Error(DiagMessage(path_data.source)
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700422 << "failed to open file: " << fin.GetError());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700423 return false;
Adam Lesinski21efb682016-09-14 17:35:43 -0700424 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700425
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700426 xmlres = xml::Inflate(&fin, context->GetDiagnostics(), path_data.source);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700427 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700428
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700429 if (!xmlres) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700430 return false;
431 }
432
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700433 xmlres->file.name = ResourceName({}, *ParseResourceType(path_data.resource_dir), path_data.name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700434 xmlres->file.config = path_data.config;
435 xmlres->file.source = path_data.source;
Adam Lesinski00451162017-10-03 07:44:08 -0700436 xmlres->file.type = ResourceFile::Type::kProtoXml;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700437
438 // Collect IDs that are defined here.
439 XmlIdCollector collector;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700440 if (!collector.Consume(context, xmlres.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700441 return false;
442 }
443
444 // Look for and process any <aapt:attr> tags and create sub-documents.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700445 InlineXmlFormatParser inline_xml_format_parser;
446 if (!inline_xml_format_parser.Consume(context, xmlres.get())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700447 return false;
448 }
449
450 // Start the entry so we can write the header.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700451 if (!writer->StartEntry(output_path, 0)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700452 context->GetDiagnostics()->Error(DiagMessage(output_path) << "failed to open file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700453 return false;
454 }
455
Adam Lesinski00451162017-10-03 07:44:08 -0700456 std::vector<std::unique_ptr<xml::XmlResource>>& inline_documents =
457 inline_xml_format_parser.GetExtractedInlineXmlDocuments();
458
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700459 // Make sure CopyingOutputStreamAdaptor is deleted before we call writer->FinishEntry().
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700460 {
Adam Lesinskiefeb7af2017-08-02 14:57:43 -0700461 // Wrap our IArchiveWriter with an adaptor that implements the ZeroCopyOutputStream interface.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700462 CopyingOutputStreamAdaptor copying_adaptor(writer);
Adam Lesinski00451162017-10-03 07:44:08 -0700463 ContainerWriter container_writer(&copying_adaptor, 1u + inline_documents.size());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700464
Adam Lesinski00451162017-10-03 07:44:08 -0700465 if (!FlattenXmlToOutStream(output_path, *xmlres, &container_writer,
466 context->GetDiagnostics())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700467 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700468 }
469
Adam Lesinski00451162017-10-03 07:44:08 -0700470 for (const std::unique_ptr<xml::XmlResource>& inline_xml_doc : inline_documents) {
471 if (!FlattenXmlToOutStream(output_path, *inline_xml_doc, &container_writer,
472 context->GetDiagnostics())) {
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700473 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700474 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700475 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700476 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700477
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700478 if (!writer->FinishEntry()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700479 context->GetDiagnostics()->Error(DiagMessage(output_path) << "failed to finish writing data");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700480 return false;
481 }
Izabela Orlowskac81d9f32017-12-05 12:07:28 +0000482
483 if (options.generate_text_symbols_path) {
484 io::FileOutputStream fout_text(options.generate_text_symbols_path.value());
485
486 if (fout_text.HadError()) {
487 context->GetDiagnostics()->Error(DiagMessage()
488 << "failed writing to'"
489 << options.generate_text_symbols_path.value()
490 << "': " << fout_text.GetError());
491 return false;
492 }
493
494 Printer r_txt_printer(&fout_text);
495 for (const auto res : xmlres->file.exported_symbols) {
496 r_txt_printer.Print("default int id ");
497 r_txt_printer.Println(res.name.entry);
498 }
499
500 // And print ourselves.
501 r_txt_printer.Print("default int ");
502 r_txt_printer.Print(path_data.resource_dir);
503 r_txt_printer.Print(" ");
504 r_txt_printer.Println(path_data.name);
505 }
506
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700507 return true;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700508}
509
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700510static bool CompilePng(IAaptContext* context, const CompileOptions& options,
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700511 const ResourcePathData& path_data, IArchiveWriter* writer,
512 const std::string& output_path) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700513 if (context->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700514 context->GetDiagnostics()->Note(DiagMessage(path_data.source) << "compiling PNG");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700515 }
516
517 BigBuffer buffer(4096);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700518 ResourceFile res_file;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700519 res_file.name = ResourceName({}, *ParseResourceType(path_data.resource_dir), path_data.name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700520 res_file.config = path_data.config;
521 res_file.source = path_data.source;
Adam Lesinski00451162017-10-03 07:44:08 -0700522 res_file.type = ResourceFile::Type::kPng;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700523
524 {
525 std::string content;
Adam Lesinski2354b562017-05-26 16:31:38 -0700526 if (!android::base::ReadFileToString(path_data.source.path, &content,
527 true /*follow_symlinks*/)) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700528 context->GetDiagnostics()->Error(DiagMessage(path_data.source)
Adam Lesinski60d9c2f2017-05-17 16:07:45 -0700529 << "failed to open file: "
Adam Lesinski00451162017-10-03 07:44:08 -0700530 << SystemErrorCodeToString(errno));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700531 return false;
Adam Lesinski21efb682016-09-14 17:35:43 -0700532 }
533
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700534 BigBuffer crunched_png_buffer(4096);
Adam Lesinski06460ef2017-03-14 18:52:13 -0700535 io::BigBufferOutputStream crunched_png_buffer_out(&crunched_png_buffer);
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700536
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700537 // Ensure that we only keep the chunks we care about if we end up
538 // using the original PNG instead of the crunched one.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700539 PngChunkFilter png_chunk_filter(content);
Adam Lesinskicc73e992017-05-12 18:16:44 -0700540 std::unique_ptr<Image> image = ReadPng(context, path_data.source, &png_chunk_filter);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700541 if (!image) {
542 return false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700543 }
544
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700545 std::unique_ptr<NinePatch> nine_patch;
546 if (path_data.extension == "9.png") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700547 std::string err;
Adam Lesinski06460ef2017-03-14 18:52:13 -0700548 nine_patch = NinePatch::Create(image->rows.get(), image->width, image->height, &err);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700549 if (!nine_patch) {
550 context->GetDiagnostics()->Error(DiagMessage() << err);
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700551 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700552 }
553
554 // Remove the 1px border around the NinePatch.
555 // Basically the row array is shifted up by 1, and the length is treated
556 // as height - 2.
557 // For each row, shift the array to the left by 1, and treat the length as
558 // width - 2.
559 image->width -= 2;
560 image->height -= 2;
Adam Lesinski06460ef2017-03-14 18:52:13 -0700561 memmove(image->rows.get(), image->rows.get() + 1, image->height * sizeof(uint8_t**));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700562 for (int32_t h = 0; h < image->height; h++) {
563 memmove(image->rows[h], image->rows[h] + 4, image->width * 4);
564 }
565
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700566 if (context->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700567 context->GetDiagnostics()->Note(DiagMessage(path_data.source) << "9-patch: "
568 << *nine_patch);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700569 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700570 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700571
572 // Write the crunched PNG.
Adam Lesinski06460ef2017-03-14 18:52:13 -0700573 if (!WritePng(context, image.get(), nine_patch.get(), &crunched_png_buffer_out, {})) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700574 return false;
575 }
576
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700577 if (nine_patch != nullptr ||
578 crunched_png_buffer_out.ByteCount() <= png_chunk_filter.ByteCount()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700579 // No matter what, we must use the re-encoded PNG, even if it is larger.
580 // 9-patch images must be re-encoded since their borders are stripped.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700581 buffer.AppendBuffer(std::move(crunched_png_buffer));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700582 } else {
583 // The re-encoded PNG is larger than the original, and there is
584 // no mandatory transformation. Use the original.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700585 if (context->IsVerbose()) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700586 context->GetDiagnostics()->Note(DiagMessage(path_data.source)
587 << "original PNG is smaller than crunched PNG"
588 << ", using original");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700589 }
590
Adam Lesinski06460ef2017-03-14 18:52:13 -0700591 png_chunk_filter.Rewind();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700592 BigBuffer filtered_png_buffer(4096);
Adam Lesinski06460ef2017-03-14 18:52:13 -0700593 io::BigBufferOutputStream filtered_png_buffer_out(&filtered_png_buffer);
594 io::Copy(&filtered_png_buffer_out, &png_chunk_filter);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700595 buffer.AppendBuffer(std::move(filtered_png_buffer));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700596 }
597
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700598 if (context->IsVerbose()) {
Adam Lesinski06460ef2017-03-14 18:52:13 -0700599 // For debugging only, use the legacy PNG cruncher and compare the resulting file sizes.
600 // This will help catch exotic cases where the new code may generate larger PNGs.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700601 std::stringstream legacy_stream(content);
602 BigBuffer legacy_buffer(4096);
603 Png png(context->GetDiagnostics());
604 if (!png.process(path_data.source, &legacy_stream, &legacy_buffer, {})) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700605 return false;
606 }
607
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700608 context->GetDiagnostics()->Note(DiagMessage(path_data.source)
609 << "legacy=" << legacy_buffer.size()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700610 << " new=" << buffer.size());
611 }
612 }
613
Adam Lesinski00451162017-10-03 07:44:08 -0700614 io::BigBufferInputStream buffer_in(&buffer);
615 if (!WriteHeaderAndDataToWriter(output_path, res_file, &buffer_in, writer,
616 context->GetDiagnostics())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700617 return false;
618 }
619 return true;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700620}
621
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700622static bool CompileFile(IAaptContext* context, const CompileOptions& options,
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700623 const ResourcePathData& path_data, IArchiveWriter* writer,
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700624 const std::string& output_path) {
625 if (context->IsVerbose()) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700626 context->GetDiagnostics()->Note(DiagMessage(path_data.source) << "compiling file");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700627 }
Adam Lesinski21efb682016-09-14 17:35:43 -0700628
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700629 BigBuffer buffer(256);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700630 ResourceFile res_file;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700631 res_file.name = ResourceName({}, *ParseResourceType(path_data.resource_dir), path_data.name);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700632 res_file.config = path_data.config;
633 res_file.source = path_data.source;
Adam Lesinski00451162017-10-03 07:44:08 -0700634 res_file.type = ResourceFile::Type::kUnknown;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700635
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700636 std::string error_str;
637 Maybe<android::FileMap> f = file::MmapPath(path_data.source.path, &error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700638 if (!f) {
Adam Lesinski776aa952017-04-24 15:09:32 -0700639 context->GetDiagnostics()->Error(DiagMessage(path_data.source) << "failed to mmap file: "
640 << error_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700641 return false;
642 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700643
Adam Lesinski00451162017-10-03 07:44:08 -0700644 io::MmappedData mmapped_in(std::move(f.value()));
645 if (!WriteHeaderAndDataToWriter(output_path, res_file, &mmapped_in, writer,
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700646 context->GetDiagnostics())) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700647 return false;
648 }
649 return true;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700650}
651
652class CompileContext : public IAaptContext {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700653 public:
Chris Warrington820d72a2017-04-27 15:27:01 +0100654 CompileContext(IDiagnostics* diagnostics) : diagnostics_(diagnostics) {
655 }
656
Adam Lesinskib522f042017-04-21 16:57:59 -0700657 PackageType GetPackageType() override {
658 // Every compilation unit starts as an app and then gets linked as potentially something else.
659 return PackageType::kApp;
660 }
661
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700662 void SetVerbose(bool val) {
663 verbose_ = val;
664 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800665
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700666 bool IsVerbose() override {
667 return verbose_;
668 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800669
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700670 IDiagnostics* GetDiagnostics() override {
Chris Warrington820d72a2017-04-27 15:27:01 +0100671 return diagnostics_;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700672 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700673
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700674 NameMangler* GetNameMangler() override {
Adam Lesinski00451162017-10-03 07:44:08 -0700675 UNIMPLEMENTED(FATAL) << "No name mangling should be needed in compile phase";
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700676 return nullptr;
677 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700678
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700679 const std::string& GetCompilationPackage() override {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700680 static std::string empty;
681 return empty;
682 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700683
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700684 uint8_t GetPackageId() override {
685 return 0x0;
686 }
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700687
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700688 SymbolTable* GetExternalSymbols() override {
Adam Lesinski00451162017-10-03 07:44:08 -0700689 UNIMPLEMENTED(FATAL) << "No symbols should be needed in compile phase";
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700690 return nullptr;
691 }
Adam Lesinski64587af2016-02-18 18:33:06 -0800692
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700693 int GetMinSdkVersion() override {
694 return 0;
695 }
Adam Lesinskifb6312f2016-06-28 14:40:32 -0700696
Chris Warrington481f0272018-02-06 14:03:39 +0000697 bool IsAutoNamespace() override {
698 return false;
699 }
700
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700701 private:
Adam Lesinski00451162017-10-03 07:44:08 -0700702 DISALLOW_COPY_AND_ASSIGN(CompileContext);
703
Chris Warrington820d72a2017-04-27 15:27:01 +0100704 IDiagnostics* diagnostics_;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700705 bool verbose_ = false;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700706};
707
Adam Lesinski00451162017-10-03 07:44:08 -0700708// Entry point for compilation phase. Parses arguments and dispatches to the correct steps.
Chris Warrington820d72a2017-04-27 15:27:01 +0100709int Compile(const std::vector<StringPiece>& args, IDiagnostics* diagnostics) {
710 CompileContext context(diagnostics);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700711 CompileOptions options;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700712
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700713 bool verbose = false;
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100714 Maybe<std::string> visibility;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700715 Flags flags =
716 Flags()
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700717 .RequiredFlag("-o", "Output path", &options.output_path)
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700718 .OptionalFlag("--dir", "Directory to scan for resources", &options.res_dir)
Izabela Orlowskac81d9f32017-12-05 12:07:28 +0000719 .OptionalFlag("--output-text-symbols",
720 "Generates a text file containing the resource symbols in the\n"
721 "specified file",
722 &options.generate_text_symbols_path)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700723 .OptionalSwitch("--pseudo-localize",
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700724 "Generate resources for pseudo-locales "
725 "(en-XA and ar-XB)",
726 &options.pseudolocalize)
Adam Lesinski28e6c0b2017-05-10 14:56:36 -0700727 .OptionalSwitch("--no-crunch", "Disables PNG processing", &options.no_png_crunch)
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700728 .OptionalSwitch("--legacy", "Treat errors that used to be valid in AAPT as warnings",
729 &options.legacy_mode)
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100730 .OptionalSwitch("-v", "Enables verbose logging", &verbose)
731 .OptionalFlag("--visibility",
732 "Sets the visibility of the compiled resources to the specified\n"
733 "level. Accepted levels: public, private, default",
734 &visibility);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700735 if (!flags.Parse("aapt2 compile", args, &std::cerr)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700736 return 1;
737 }
738
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700739 context.SetVerbose(verbose);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700740
Izabela Orlowskac7ac3a12018-03-27 14:46:52 +0100741 if (visibility) {
742 if (visibility.value() == "public") {
743 options.visibility = Visibility::Level::kPublic;
744 } else if (visibility.value() == "private") {
745 options.visibility = Visibility::Level::kPrivate;
746 } else if (visibility.value() == "default") {
747 options.visibility = Visibility::Level::kUndefined;
748 } else {
749 context.GetDiagnostics()->Error(
750 DiagMessage() << "Unrecognized visibility level passes to --visibility: '"
751 << visibility.value() << "'. Accepted levels: public, private, default");
752 return 1;
753 }
754 }
755
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700756 std::unique_ptr<IArchiveWriter> archive_writer;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700757
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700758 std::vector<ResourcePathData> input_data;
759 if (options.res_dir) {
760 if (!flags.GetArgs().empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700761 // Can't have both files and a resource directory.
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700762 context.GetDiagnostics()->Error(DiagMessage() << "files given but --dir specified");
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700763 flags.Usage("aapt2 compile", &std::cerr);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700764 return 1;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700765 }
766
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700767 if (!LoadInputFilesFromDir(&context, options, &input_data)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700768 return 1;
769 }
Adam Lesinski355f2852016-02-13 20:26:45 -0800770
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700771 archive_writer = CreateZipFileArchiveWriter(context.GetDiagnostics(), options.output_path);
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700772
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700773 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700774 input_data.reserve(flags.GetArgs().size());
Adam Lesinskia40e9722015-11-24 19:11:46 -0800775
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700776 // Collect data from the path for each input file.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700777 for (const std::string& arg : flags.GetArgs()) {
778 std::string error_str;
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700779 if (Maybe<ResourcePathData> path_data = ExtractResourcePathData(arg, &error_str)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700780 input_data.push_back(std::move(path_data.value()));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700781 } else {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700782 context.GetDiagnostics()->Error(DiagMessage() << error_str << " (" << arg << ")");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700783 return 1;
784 }
785 }
Adam Lesinskia40e9722015-11-24 19:11:46 -0800786
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700787 archive_writer = CreateDirectoryArchiveWriter(context.GetDiagnostics(), options.output_path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700788 }
789
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700790 if (!archive_writer) {
Adam Lesinskidfaecaf2016-10-20 17:08:51 -0700791 return 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700792 }
793
794 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700795 for (ResourcePathData& path_data : input_data) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700796 if (options.verbose) {
Adam Lesinskid0f492d2017-04-03 18:12:45 -0700797 context.GetDiagnostics()->Note(DiagMessage(path_data.source) << "processing");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700798 }
799
Adam Lesinski776aa952017-04-24 15:09:32 -0700800 if (!IsValidFile(&context, path_data.source.path)) {
801 error = true;
802 continue;
803 }
804
Adam Lesinski00451162017-10-03 07:44:08 -0700805 // Determine how to compile the file based on its type.
806 auto compile_func = &CompileFile;
Adam Lesinski3a725dc2017-11-02 16:14:59 -0700807 if (path_data.resource_dir == "values" && path_data.extension == "xml") {
Adam Lesinski00451162017-10-03 07:44:08 -0700808 compile_func = &CompileTable;
809 // We use a different extension (not necessary anymore, but avoids altering the existing
810 // build system logic).
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700811 path_data.extension = "arsc";
yd6b83292018-04-11 09:54:56 -0700812
Adam Lesinski00451162017-10-03 07:44:08 -0700813 } else if (const ResourceType* type = ParseResourceType(path_data.resource_dir)) {
814 if (*type != ResourceType::kRaw) {
815 if (path_data.extension == "xml") {
816 compile_func = &CompileXml;
yd6b83292018-04-11 09:54:56 -0700817 } else if ((!options.no_png_crunch && path_data.extension == "png")
818 || path_data.extension == "9.png") {
Adam Lesinski00451162017-10-03 07:44:08 -0700819 compile_func = &CompilePng;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700820 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700821 }
Adam Lesinski00451162017-10-03 07:44:08 -0700822 } else {
823 context.GetDiagnostics()->Error(DiagMessage()
824 << "invalid file path '" << path_data.source << "'");
825 error = true;
826 continue;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700827 }
828
yd6b83292018-04-11 09:54:56 -0700829 // Treat periods as a reserved character that should not be present in a file name
830 // Legacy support for AAPT which did not reserve periods
831 if (compile_func != &CompileFile && !options.legacy_mode
832 && std::count(path_data.name.begin(), path_data.name.end(), '.') != 0) {
833 error = true;
834 context.GetDiagnostics()->Error(DiagMessage() << "resource file '" << path_data.source.path
835 << "' name cannot contain '.' other than for"
836 << "specifying the extension");
837 continue;
838 }
839
Adam Lesinski00451162017-10-03 07:44:08 -0700840 // Compile the file.
841 const std::string out_path = BuildIntermediateContainerFilename(path_data);
842 error |= !compile_func(&context, options, path_data, archive_writer.get(), out_path);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700843 }
Adam Lesinski00451162017-10-03 07:44:08 -0700844 return error ? 1 : 0;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700845}
846
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700847} // namespace aapt