blob: 19c6c3107e7c7d876f050593da8fc640cbcf1044 [file] [log] [blame]
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001/*
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 Lesinski6f6ceb72014-11-14 14:48:12 -080017#include "ResourceParser.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070018
19#include <functional>
Adam Lesinski73bff1e2017-12-08 16:06:10 -080020#include <limits>
Adam Lesinskice5e56e2016-10-21 17:56:45 -070021#include <sstream>
22
23#include "android-base/logging.h"
24
Adam Lesinski1ab598f2015-08-14 14:26:04 -070025#include "ResourceTable.h"
26#include "ResourceUtils.h"
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080027#include "ResourceValues.h"
Adam Lesinski1ab598f2015-08-14 14:26:04 -070028#include "ValueVisitor.h"
Adam Lesinski2eed52e2018-02-21 15:55:58 -080029#include "text/Utf8Iterator.h"
Adam Lesinski7ff3ee12015-12-14 16:08:50 -080030#include "util/ImmutableMap.h"
Adam Lesinski75421622017-01-06 15:20:04 -080031#include "util/Maybe.h"
Adam Lesinski9e10ac72015-10-16 14:37:48 -070032#include "util/Util.h"
Adam Lesinski467f1712015-11-16 17:35:44 -080033#include "xml/XmlPullParser.h"
Adam Lesinski9e10ac72015-10-16 14:37:48 -070034
Adam Lesinski2eed52e2018-02-21 15:55:58 -080035using ::aapt::ResourceUtils::StringBuilder;
36using ::aapt::text::Utf8Iterator;
Adam Lesinski71be7052017-12-12 16:48:07 -080037using ::android::StringPiece;
Adam Lesinskid5083f62017-01-16 15:07:21 -080038
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080039namespace aapt {
40
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070041constexpr const char* sXliffNamespaceUri = "urn:oasis:names:tc:xliff:document:1.2";
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080042
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070043// Returns true if the element is <skip> or <eat-comment> and can be safely ignored.
44static bool ShouldIgnoreElement(const StringPiece& ns, const StringPiece& name) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070045 return ns.empty() && (name == "skip" || name == "eat-comment");
Adam Lesinski27afb9e2015-11-06 18:25:04 -080046}
47
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070048static uint32_t ParseFormatTypeNoEnumsOrFlags(const StringPiece& piece) {
49 if (piece == "reference") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070050 return android::ResTable_map::TYPE_REFERENCE;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070051 } else if (piece == "string") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070052 return android::ResTable_map::TYPE_STRING;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070053 } else if (piece == "integer") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070054 return android::ResTable_map::TYPE_INTEGER;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070055 } else if (piece == "boolean") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070056 return android::ResTable_map::TYPE_BOOLEAN;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070057 } else if (piece == "color") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070058 return android::ResTable_map::TYPE_COLOR;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070059 } else if (piece == "float") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070060 return android::ResTable_map::TYPE_FLOAT;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070061 } else if (piece == "dimension") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070062 return android::ResTable_map::TYPE_DIMENSION;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070063 } else if (piece == "fraction") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070064 return android::ResTable_map::TYPE_FRACTION;
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070065 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -070066 return 0;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -080067}
68
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070069static uint32_t ParseFormatType(const StringPiece& piece) {
70 if (piece == "enum") {
71 return android::ResTable_map::TYPE_ENUM;
72 } else if (piece == "flags") {
73 return android::ResTable_map::TYPE_FLAGS;
74 }
75 return ParseFormatTypeNoEnumsOrFlags(piece);
76}
77
Adam Lesinskice5e56e2016-10-21 17:56:45 -070078static uint32_t ParseFormatAttribute(const StringPiece& str) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070079 uint32_t mask = 0;
Adam Lesinskice5e56e2016-10-21 17:56:45 -070080 for (StringPiece part : util::Tokenize(str, '|')) {
81 StringPiece trimmed_part = util::TrimWhitespace(part);
82 uint32_t type = ParseFormatType(trimmed_part);
Adam Lesinskicacb28f2016-10-19 12:18:14 -070083 if (type == 0) {
84 return 0;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -080085 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -070086 mask |= type;
87 }
88 return mask;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -080089}
90
Adam Lesinskid5fd76a2017-05-16 12:18:08 -070091// A parsed resource ready to be added to the ResourceTable.
Adam Lesinski7ff3ee12015-12-14 16:08:50 -080092struct ParsedResource {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070093 ResourceName name;
94 ConfigDescription config;
95 std::string product;
96 Source source;
Adam Lesinski71be7052017-12-12 16:48:07 -080097
Adam Lesinskicacb28f2016-10-19 12:18:14 -070098 ResourceId id;
Adam Lesinski71be7052017-12-12 16:48:07 -080099 Visibility::Level visibility_level = Visibility::Level::kUndefined;
Adam Lesinski4488f1c2017-05-26 17:33:38 -0700100 bool allow_new = false;
Adam Lesinski71be7052017-12-12 16:48:07 -0800101 bool overlayable = false;
102
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700103 std::string comment;
104 std::unique_ptr<Value> value;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700105 std::list<ParsedResource> child_resources;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800106};
107
108// Recursively adds resources to the ResourceTable.
Adam Lesinski4488f1c2017-05-26 17:33:38 -0700109static bool AddResourcesToTable(ResourceTable* table, IDiagnostics* diag, ParsedResource* res) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700110 StringPiece trimmed_comment = util::TrimWhitespace(res->comment);
111 if (trimmed_comment.size() != res->comment.size()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700112 // Only if there was a change do we re-assign.
Adam Lesinskid5083f62017-01-16 15:07:21 -0800113 res->comment = trimmed_comment.to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700114 }
Adam Lesinski76565542016-03-10 21:55:04 -0800115
Adam Lesinski71be7052017-12-12 16:48:07 -0800116 if (res->visibility_level != Visibility::Level::kUndefined) {
117 Visibility visibility;
118 visibility.level = res->visibility_level;
119 visibility.source = res->source;
120 visibility.comment = res->comment;
121 if (!table->SetVisibilityWithId(res->name, visibility, res->id, diag)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700122 return false;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800123 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700124 }
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800125
Adam Lesinski71be7052017-12-12 16:48:07 -0800126 if (res->allow_new) {
127 AllowNew allow_new;
128 allow_new.source = res->source;
129 allow_new.comment = res->comment;
130 if (!table->SetAllowNew(res->name, allow_new, diag)) {
131 return false;
132 }
133 }
134
135 if (res->overlayable) {
136 Overlayable overlayable;
137 overlayable.source = res->source;
138 overlayable.comment = res->comment;
139 if (!table->SetOverlayable(res->name, overlayable, diag)) {
140 return false;
141 }
142 }
143
144 if (res->value != nullptr) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700145 // Attach the comment, source and config to the value.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700146 res->value->SetComment(std::move(res->comment));
147 res->value->SetSource(std::move(res->source));
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800148
Adam Lesinski71be7052017-12-12 16:48:07 -0800149 if (!table->AddResourceWithId(res->name, res->id, res->config, res->product,
150 std::move(res->value), diag)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700151 return false;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800152 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700153 }
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800154
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700155 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700156 for (ParsedResource& child : res->child_resources) {
157 error |= !AddResourcesToTable(table, diag, &child);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700158 }
159 return !error;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800160}
161
162// Convenient aliases for more readable function calls.
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700163enum { kAllowRawString = true, kNoRawString = false };
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800164
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700165ResourceParser::ResourceParser(IDiagnostics* diag, ResourceTable* table,
166 const Source& source,
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700167 const ConfigDescription& config,
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700168 const ResourceParserOptions& options)
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700169 : diag_(diag),
170 table_(table),
171 source_(source),
172 config_(config),
173 options_(options) {}
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800174
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800175// Base class Node for representing the various Spans and UntranslatableSections of an XML string.
176// This will be used to traverse and flatten the XML string into a single std::string, with all
177// Span and Untranslatable data maintained in parallel, as indices into the string.
178class Node {
179 public:
180 virtual ~Node() = default;
181
182 // Adds the given child node to this parent node's set of child nodes, moving ownership to the
183 // parent node as well.
184 // Returns a pointer to the child node that was added as a convenience.
185 template <typename T>
186 T* AddChild(std::unique_ptr<T> node) {
187 T* raw_ptr = node.get();
188 children.push_back(std::move(node));
189 return raw_ptr;
190 }
191
192 virtual void Build(StringBuilder* builder) const {
193 for (const auto& child : children) {
194 child->Build(builder);
195 }
196 }
197
198 std::vector<std::unique_ptr<Node>> children;
199};
200
201// A chunk of text in the XML string. This lives between other tags, such as XLIFF tags and Spans.
202class SegmentNode : public Node {
203 public:
204 std::string data;
205
206 void Build(StringBuilder* builder) const override {
207 builder->AppendText(data);
208 }
209};
210
211// A tag that will be encoded into the final flattened string. Tags like <b> or <i>.
212class SpanNode : public Node {
213 public:
214 std::string name;
215
216 void Build(StringBuilder* builder) const override {
217 StringBuilder::SpanHandle span_handle = builder->StartSpan(name);
218 Node::Build(builder);
219 builder->EndSpan(span_handle);
220 }
221};
222
223// An XLIFF 'g' tag, which marks a section of the string as untranslatable.
224class UntranslatableNode : public Node {
225 public:
226 void Build(StringBuilder* builder) const override {
227 StringBuilder::UntranslatableHandle handle = builder->StartUntranslatable();
228 Node::Build(builder);
229 builder->EndUntranslatable(handle);
230 }
231};
232
233// Build a string from XML that converts nested elements into Span objects.
Adam Lesinski75421622017-01-06 15:20:04 -0800234bool ResourceParser::FlattenXmlSubtree(
235 xml::XmlPullParser* parser, std::string* out_raw_string, StyleString* out_style_string,
236 std::vector<UntranslatableSection>* out_untranslatable_sections) {
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800237 std::string raw_string;
238 std::string current_text;
Adam Lesinski75421622017-01-06 15:20:04 -0800239
240 // The first occurrence of a <xliff:g> tag. Nested <xliff:g> tags are illegal.
241 Maybe<size_t> untranslatable_start_depth;
242
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800243 Node root;
244 std::vector<Node*> node_stack;
245 node_stack.push_back(&root);
246
247 bool saw_span_node = false;
248 SegmentNode* first_segment = nullptr;
249 SegmentNode* last_segment = nullptr;
250
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700251 size_t depth = 1;
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800252 while (depth > 0 && xml::XmlPullParser::IsGoodEvent(parser->Next())) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700253 const xml::XmlPullParser::Event event = parser->event();
Adam Lesinski75421622017-01-06 15:20:04 -0800254
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800255 // First take care of any SegmentNodes that should be created.
256 if (event == xml::XmlPullParser::Event::kStartElement ||
257 event == xml::XmlPullParser::Event::kEndElement) {
258 if (!current_text.empty()) {
259 std::unique_ptr<SegmentNode> segment_node = util::make_unique<SegmentNode>();
260 segment_node->data = std::move(current_text);
261 last_segment = node_stack.back()->AddChild(std::move(segment_node));
262 if (first_segment == nullptr) {
263 first_segment = last_segment;
Adam Lesinski75421622017-01-06 15:20:04 -0800264 }
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800265 current_text = {};
266 }
267 }
Adam Lesinski75421622017-01-06 15:20:04 -0800268
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800269 switch (event) {
270 case xml::XmlPullParser::Event::kText: {
271 current_text += parser->text();
272 raw_string += parser->text();
273 } break;
Adam Lesinski75421622017-01-06 15:20:04 -0800274
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800275 case xml::XmlPullParser::Event::kStartElement: {
276 if (parser->element_namespace().empty()) {
277 // This is an HTML tag which we encode as a span. Add it to the span stack.
278 std::unique_ptr<SpanNode> span_node = util::make_unique<SpanNode>();
279 span_node->name = parser->element_name();
280 const auto end_attr_iter = parser->end_attributes();
281 for (auto attr_iter = parser->begin_attributes(); attr_iter != end_attr_iter;
282 ++attr_iter) {
283 span_node->name += ";";
284 span_node->name += attr_iter->name;
285 span_node->name += "=";
286 span_node->name += attr_iter->value;
Adam Lesinski75421622017-01-06 15:20:04 -0800287 }
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800288
289 node_stack.push_back(node_stack.back()->AddChild(std::move(span_node)));
290 saw_span_node = true;
291 } else if (parser->element_namespace() == sXliffNamespaceUri) {
292 // This is an XLIFF tag, which is not encoded as a span.
293 if (parser->element_name() == "g") {
294 // Check that an 'untranslatable' tag is not already being processed. Nested
295 // <xliff:g> tags are illegal.
296 if (untranslatable_start_depth) {
297 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
298 << "illegal nested XLIFF 'g' tag");
299 return false;
300 } else {
301 // Mark the beginning of an 'untranslatable' section.
302 untranslatable_start_depth = depth;
303 node_stack.push_back(
304 node_stack.back()->AddChild(util::make_unique<UntranslatableNode>()));
305 }
306 } else {
307 // Ignore unknown XLIFF tags, but don't warn.
308 node_stack.push_back(node_stack.back()->AddChild(util::make_unique<Node>()));
309 }
310 } else {
311 // Besides XLIFF, any other namespaced tag is unsupported and ignored.
312 diag_->Warn(DiagMessage(source_.WithLine(parser->line_number()))
313 << "ignoring element '" << parser->element_name()
314 << "' with unknown namespace '" << parser->element_namespace() << "'");
315 node_stack.push_back(node_stack.back()->AddChild(util::make_unique<Node>()));
Adam Lesinski75421622017-01-06 15:20:04 -0800316 }
Adam Lesinski75421622017-01-06 15:20:04 -0800317
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800318 // Enter one level inside the element.
319 depth++;
320 } break;
Adam Lesinski1ab598f2015-08-14 14:26:04 -0700321
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800322 case xml::XmlPullParser::Event::kEndElement: {
323 // Return one level from within the element.
324 depth--;
325 if (depth == 0) {
326 break;
327 }
328
329 node_stack.pop_back();
330 if (untranslatable_start_depth == make_value(depth)) {
331 // This is the end of an untranslatable section.
332 untranslatable_start_depth = {};
333 }
334 } break;
335
336 default:
337 // ignore.
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700338 break;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700339 }
340 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700341
Adam Lesinski2eed52e2018-02-21 15:55:58 -0800342 // Sanity check to make sure we processed all the nodes.
343 CHECK(node_stack.size() == 1u);
344 CHECK(node_stack.back() == &root);
345
346 if (!saw_span_node) {
347 // If there were no spans, we must treat this string a little differently (according to AAPT).
348 // Find and strip the leading whitespace from the first segment, and the trailing whitespace
349 // from the last segment.
350 if (first_segment != nullptr) {
351 // Trim leading whitespace.
352 StringPiece trimmed = util::TrimLeadingWhitespace(first_segment->data);
353 if (trimmed.size() != first_segment->data.size()) {
354 first_segment->data = trimmed.to_string();
355 }
356 }
357
358 if (last_segment != nullptr) {
359 // Trim trailing whitespace.
360 StringPiece trimmed = util::TrimTrailingWhitespace(last_segment->data);
361 if (trimmed.size() != last_segment->data.size()) {
362 last_segment->data = trimmed.to_string();
363 }
364 }
365 }
366
367 // Have the XML structure flatten itself into the StringBuilder. The StringBuilder will take
368 // care of recording the correctly adjusted Spans and UntranslatableSections.
369 StringBuilder builder;
370 root.Build(&builder);
371 if (!builder) {
372 diag_->Error(DiagMessage(source_.WithLine(parser->line_number())) << builder.GetError());
373 return false;
374 }
375
376 ResourceUtils::FlattenedXmlString flattened_string = builder.GetFlattenedString();
377 *out_raw_string = std::move(raw_string);
378 *out_untranslatable_sections = std::move(flattened_string.untranslatable_sections);
379 out_style_string->str = std::move(flattened_string.text);
380 out_style_string->spans = std::move(flattened_string.spans);
Adam Lesinski75421622017-01-06 15:20:04 -0800381 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800382}
383
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700384bool ResourceParser::Parse(xml::XmlPullParser* parser) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700385 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700386 const size_t depth = parser->depth();
387 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
388 if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700389 // Skip comments and text.
390 continue;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800391 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700392
Adam Lesinski060b53d2017-07-28 17:10:35 -0700393 if (!parser->element_namespace().empty() || parser->element_name() != "resources") {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700394 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700395 << "root element must be <resources>");
396 return false;
397 }
398
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700399 error |= !ParseResources(parser);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700400 break;
401 };
402
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700403 if (parser->event() == xml::XmlPullParser::Event::kBadDocument) {
404 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
405 << "xml parser error: " << parser->error());
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700406 return false;
407 }
408 return !error;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800409}
410
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700411bool ResourceParser::ParseResources(xml::XmlPullParser* parser) {
412 std::set<ResourceName> stripped_resources;
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700413
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700414 bool error = false;
415 std::string comment;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700416 const size_t depth = parser->depth();
417 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
418 const xml::XmlPullParser::Event event = parser->event();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700419 if (event == xml::XmlPullParser::Event::kComment) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700420 comment = parser->comment();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700421 continue;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800422 }
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700423
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700424 if (event == xml::XmlPullParser::Event::kText) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700425 if (!util::TrimWhitespace(parser->text()).empty()) {
426 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700427 << "plain text not allowed here");
428 error = true;
429 }
430 continue;
Adam Lesinski9ba47d82015-10-13 11:37:10 -0700431 }
432
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700433 CHECK(event == xml::XmlPullParser::Event::kStartElement);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700434
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700435 if (!parser->element_namespace().empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700436 // Skip unknown namespace.
437 continue;
438 }
439
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700440 std::string element_name = parser->element_name();
441 if (element_name == "skip" || element_name == "eat-comment") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700442 comment = "";
443 continue;
444 }
445
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700446 ParsedResource parsed_resource;
447 parsed_resource.config = config_;
448 parsed_resource.source = source_.WithLine(parser->line_number());
449 parsed_resource.comment = std::move(comment);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700450
451 // Extract the product name if it exists.
Adam Lesinski060b53d2017-07-28 17:10:35 -0700452 if (Maybe<StringPiece> maybe_product = xml::FindNonEmptyAttribute(parser, "product")) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800453 parsed_resource.product = maybe_product.value().to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700454 }
455
456 // Parse the resource regardless of product.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700457 if (!ParseResource(parser, &parsed_resource)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700458 error = true;
459 continue;
460 }
461
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700462 if (!AddResourcesToTable(table_, diag_, &parsed_resource)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700463 error = true;
464 }
465 }
466
467 // Check that we included at least one variant of each stripped resource.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700468 for (const ResourceName& stripped_resource : stripped_resources) {
469 if (!table_->FindResource(stripped_resource)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700470 // Failed to find the resource.
Adam Lesinski060b53d2017-07-28 17:10:35 -0700471 diag_->Error(DiagMessage(source_) << "resource '" << stripped_resource
472 << "' was filtered out but no product variant remains");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700473 error = true;
474 }
475 }
476
477 return !error;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800478}
479
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700480bool ResourceParser::ParseResource(xml::XmlPullParser* parser,
481 ParsedResource* out_resource) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700482 struct ItemTypeFormat {
483 ResourceType type;
484 uint32_t format;
485 };
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800486
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700487 using BagParseFunc = std::function<bool(ResourceParser*, xml::XmlPullParser*,
488 ParsedResource*)>;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800489
Adam Lesinski86d67df2017-01-31 13:47:27 -0800490 static const auto elToItemMap = ImmutableMap<std::string, ItemTypeFormat>::CreatePreSorted({
491 {"bool", {ResourceType::kBool, android::ResTable_map::TYPE_BOOLEAN}},
492 {"color", {ResourceType::kColor, android::ResTable_map::TYPE_COLOR}},
493 {"configVarying", {ResourceType::kConfigVarying, android::ResTable_map::TYPE_ANY}},
494 {"dimen",
495 {ResourceType::kDimen,
496 android::ResTable_map::TYPE_FLOAT | android::ResTable_map::TYPE_FRACTION |
497 android::ResTable_map::TYPE_DIMENSION}},
498 {"drawable", {ResourceType::kDrawable, android::ResTable_map::TYPE_COLOR}},
499 {"fraction",
500 {ResourceType::kFraction,
501 android::ResTable_map::TYPE_FLOAT | android::ResTable_map::TYPE_FRACTION |
502 android::ResTable_map::TYPE_DIMENSION}},
503 {"integer", {ResourceType::kInteger, android::ResTable_map::TYPE_INTEGER}},
504 {"string", {ResourceType::kString, android::ResTable_map::TYPE_STRING}},
505 });
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800506
Adam Lesinski86d67df2017-01-31 13:47:27 -0800507 static const auto elToBagMap = ImmutableMap<std::string, BagParseFunc>::CreatePreSorted({
508 {"add-resource", std::mem_fn(&ResourceParser::ParseAddResource)},
509 {"array", std::mem_fn(&ResourceParser::ParseArray)},
510 {"attr", std::mem_fn(&ResourceParser::ParseAttr)},
511 {"configVarying",
512 std::bind(&ResourceParser::ParseStyle, std::placeholders::_1, ResourceType::kConfigVarying,
513 std::placeholders::_2, std::placeholders::_3)},
514 {"declare-styleable", std::mem_fn(&ResourceParser::ParseDeclareStyleable)},
515 {"integer-array", std::mem_fn(&ResourceParser::ParseIntegerArray)},
516 {"java-symbol", std::mem_fn(&ResourceParser::ParseSymbol)},
Adam Lesinski46c4d722017-08-23 13:03:56 -0700517 {"overlayable", std::mem_fn(&ResourceParser::ParseOverlayable)},
Adam Lesinski86d67df2017-01-31 13:47:27 -0800518 {"plurals", std::mem_fn(&ResourceParser::ParsePlural)},
519 {"public", std::mem_fn(&ResourceParser::ParsePublic)},
520 {"public-group", std::mem_fn(&ResourceParser::ParsePublicGroup)},
521 {"string-array", std::mem_fn(&ResourceParser::ParseStringArray)},
522 {"style", std::bind(&ResourceParser::ParseStyle, std::placeholders::_1, ResourceType::kStyle,
523 std::placeholders::_2, std::placeholders::_3)},
524 {"symbol", std::mem_fn(&ResourceParser::ParseSymbol)},
525 });
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800526
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700527 std::string resource_type = parser->element_name();
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800528
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700529 // The value format accepted for this resource.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700530 uint32_t resource_format = 0u;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800531
Adam Lesinski86d67df2017-01-31 13:47:27 -0800532 bool can_be_item = true;
533 bool can_be_bag = true;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700534 if (resource_type == "item") {
Adam Lesinski86d67df2017-01-31 13:47:27 -0800535 can_be_bag = false;
536
Adam Lesinskie597d682017-06-01 17:16:44 -0700537 // The default format for <item> is any. If a format attribute is present, that one will
538 // override the default.
539 resource_format = android::ResTable_map::TYPE_ANY;
540
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700541 // Items have their type encoded in the type attribute.
Adam Lesinskid5fd76a2017-05-16 12:18:08 -0700542 if (Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type")) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800543 resource_type = maybe_type.value().to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700544 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700545 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700546 << "<item> must have a 'type' attribute");
547 return false;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800548 }
549
Adam Lesinskid5fd76a2017-05-16 12:18:08 -0700550 if (Maybe<StringPiece> maybe_format = xml::FindNonEmptyAttribute(parser, "format")) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700551 // An explicit format for this resource was specified. The resource will
Adam Lesinskid5fd76a2017-05-16 12:18:08 -0700552 // retain its type in its name, but the accepted value for this type is
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700553 // overridden.
Adam Lesinskid5fd76a2017-05-16 12:18:08 -0700554 resource_format = ParseFormatTypeNoEnumsOrFlags(maybe_format.value());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700555 if (!resource_format) {
556 diag_->Error(DiagMessage(out_resource->source)
557 << "'" << maybe_format.value()
558 << "' is an invalid format");
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800559 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700560 }
561 }
Adam Lesinski86d67df2017-01-31 13:47:27 -0800562 } else if (resource_type == "bag") {
563 can_be_item = false;
564
565 // Bags have their type encoded in the type attribute.
566 if (Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type")) {
567 resource_type = maybe_type.value().to_string();
568 } else {
569 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
570 << "<bag> must have a 'type' attribute");
571 return false;
572 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700573 }
574
575 // Get the name of the resource. This will be checked later, because not all
576 // XML elements require a name.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700577 Maybe<StringPiece> maybe_name = xml::FindNonEmptyAttribute(parser, "name");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700578
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700579 if (resource_type == "id") {
580 if (!maybe_name) {
581 diag_->Error(DiagMessage(out_resource->source)
582 << "<" << parser->element_name()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700583 << "> missing 'name' attribute");
584 return false;
585 }
586
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700587 out_resource->name.type = ResourceType::kId;
Adam Lesinskid5083f62017-01-16 15:07:21 -0800588 out_resource->name.entry = maybe_name.value().to_string();
y9efbbef2018-04-18 11:29:09 -0700589
590 // Ids either represent a unique resource id or reference another resource id
591 auto item = ParseItem(parser, out_resource, resource_format);
592 if (!item) {
593 return false;
594 }
595
596 String* empty = ValueCast<String>(out_resource->value.get());
597 if (empty && *empty->value == "") {
598 // If no inner element exists, represent a unique identifier
599 out_resource->value = util::make_unique<Id>();
600 } else {
601 // If an inner element exists, the inner element must be a reference to
602 // another resource id
603 Reference* ref = ValueCast<Reference>(out_resource->value.get());
604 if (!ref || ref->name.value().type != ResourceType::kId) {
605 diag_->Error(DiagMessage(out_resource->source)
606 << "<" << parser->element_name()
607 << "> inner element must either be a resource reference or empty");
608 return false;
609 }
610 }
611
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700612 return true;
613 }
614
Adam Lesinski86d67df2017-01-31 13:47:27 -0800615 if (can_be_item) {
616 const auto item_iter = elToItemMap.find(resource_type);
617 if (item_iter != elToItemMap.end()) {
618 // This is an item, record its type and format and start parsing.
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700619
Adam Lesinski86d67df2017-01-31 13:47:27 -0800620 if (!maybe_name) {
621 diag_->Error(DiagMessage(out_resource->source)
622 << "<" << parser->element_name() << "> missing 'name' attribute");
623 return false;
624 }
625
626 out_resource->name.type = item_iter->second.type;
627 out_resource->name.entry = maybe_name.value().to_string();
628
Adam Lesinskie597d682017-06-01 17:16:44 -0700629 // Only use the implied format of the type when there is no explicit format.
630 if (resource_format == 0u) {
Adam Lesinski86d67df2017-01-31 13:47:27 -0800631 resource_format = item_iter->second.format;
632 }
633
634 if (!ParseItem(parser, out_resource, resource_format)) {
635 return false;
636 }
637 return true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700638 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700639 }
640
641 // This might be a bag or something.
Adam Lesinski86d67df2017-01-31 13:47:27 -0800642 if (can_be_bag) {
643 const auto bag_iter = elToBagMap.find(resource_type);
644 if (bag_iter != elToBagMap.end()) {
645 // Ensure we have a name (unless this is a <public-group>).
Adam Lesinski46c4d722017-08-23 13:03:56 -0700646 if (resource_type != "public-group" && resource_type != "overlayable") {
Adam Lesinski86d67df2017-01-31 13:47:27 -0800647 if (!maybe_name) {
648 diag_->Error(DiagMessage(out_resource->source)
649 << "<" << parser->element_name() << "> missing 'name' attribute");
650 return false;
651 }
652
653 out_resource->name.entry = maybe_name.value().to_string();
654 }
655
656 // Call the associated parse method. The type will be filled in by the
657 // parse func.
658 if (!bag_iter->second(this, parser, out_resource)) {
659 return false;
660 }
661 return true;
662 }
663 }
664
665 if (can_be_item) {
666 // Try parsing the elementName (or type) as a resource. These shall only be
667 // resources like 'layout' or 'xml' and they can only be references.
668 const ResourceType* parsed_type = ParseResourceType(resource_type);
669 if (parsed_type) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700670 if (!maybe_name) {
671 diag_->Error(DiagMessage(out_resource->source)
672 << "<" << parser->element_name()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700673 << "> missing 'name' attribute");
674 return false;
675 }
676
Adam Lesinski86d67df2017-01-31 13:47:27 -0800677 out_resource->name.type = *parsed_type;
Adam Lesinskid5083f62017-01-16 15:07:21 -0800678 out_resource->name.entry = maybe_name.value().to_string();
Adam Lesinski86d67df2017-01-31 13:47:27 -0800679 out_resource->value = ParseXml(parser, android::ResTable_map::TYPE_REFERENCE, kNoRawString);
680 if (!out_resource->value) {
681 diag_->Error(DiagMessage(out_resource->source)
682 << "invalid value for type '" << *parsed_type << "'. Expected a reference");
683 return false;
684 }
685 return true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700686 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700687 }
688
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700689 diag_->Warn(DiagMessage(out_resource->source)
690 << "unknown resource type '" << parser->element_name() << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700691 return false;
692}
693
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700694bool ResourceParser::ParseItem(xml::XmlPullParser* parser,
695 ParsedResource* out_resource,
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700696 const uint32_t format) {
697 if (format == android::ResTable_map::TYPE_STRING) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700698 return ParseString(parser, out_resource);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700699 }
700
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700701 out_resource->value = ParseXml(parser, format, kNoRawString);
702 if (!out_resource->value) {
703 diag_->Error(DiagMessage(out_resource->source) << "invalid "
704 << out_resource->name.type);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700705 return false;
706 }
707 return true;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -0800708}
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800709
710/**
711 * Reads the entire XML subtree and attempts to parse it as some Item,
712 * with typeMask denoting which items it can be. If allowRawValue is
713 * true, a RawString is returned if the XML couldn't be parsed as
714 * an Item. If allowRawValue is false, nullptr is returned in this
715 * case.
716 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700717std::unique_ptr<Item> ResourceParser::ParseXml(xml::XmlPullParser* parser,
718 const uint32_t type_mask,
719 const bool allow_raw_value) {
720 const size_t begin_xml_line = parser->line_number();
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800721
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700722 std::string raw_value;
723 StyleString style_string;
Adam Lesinski75421622017-01-06 15:20:04 -0800724 std::vector<UntranslatableSection> untranslatable_sections;
725 if (!FlattenXmlSubtree(parser, &raw_value, &style_string, &untranslatable_sections)) {
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800726 return {};
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700727 }
728
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700729 if (!style_string.spans.empty()) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700730 // This can only be a StyledString.
Adam Lesinski75421622017-01-06 15:20:04 -0800731 std::unique_ptr<StyledString> styled_string =
732 util::make_unique<StyledString>(table_->string_pool.MakeRef(
Adam Lesinski060b53d2017-07-28 17:10:35 -0700733 style_string, StringPool::Context(StringPool::Context::kNormalPriority, config_)));
Adam Lesinski75421622017-01-06 15:20:04 -0800734 styled_string->untranslatable_sections = std::move(untranslatable_sections);
735 return std::move(styled_string);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700736 }
737
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700738 auto on_create_reference = [&](const ResourceName& name) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700739 // name.package can be empty here, as it will assume the package name of the
740 // table.
741 std::unique_ptr<Id> id = util::make_unique<Id>();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700742 id->SetSource(source_.WithLine(begin_xml_line));
743 table_->AddResource(name, {}, {}, std::move(id), diag_);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700744 };
745
746 // Process the raw value.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700747 std::unique_ptr<Item> processed_item =
Adam Lesinski71be7052017-12-12 16:48:07 -0800748 ResourceUtils::TryParseItemForAttribute(raw_value, type_mask, on_create_reference);
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700749 if (processed_item) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700750 // Fix up the reference.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700751 if (Reference* ref = ValueCast<Reference>(processed_item.get())) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -0700752 ResolvePackage(parser, ref);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700753 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700754 return processed_item;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700755 }
756
757 // Try making a regular string.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700758 if (type_mask & android::ResTable_map::TYPE_STRING) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700759 // Use the trimmed, escaped string.
Adam Lesinski75421622017-01-06 15:20:04 -0800760 std::unique_ptr<String> string = util::make_unique<String>(
761 table_->string_pool.MakeRef(style_string.str, StringPool::Context(config_)));
762 string->untranslatable_sections = std::move(untranslatable_sections);
763 return std::move(string);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700764 }
765
Adam Lesinskibab4ef52017-06-01 15:22:57 -0700766 // If the text is empty, and the value is not allowed to be a string, encode it as a @null.
767 if (util::TrimWhitespace(raw_value).empty()) {
768 return ResourceUtils::MakeNull();
769 }
770
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700771 if (allow_raw_value) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700772 // We can't parse this so return a RawString if we are allowed.
773 return util::make_unique<RawString>(
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700774 table_->string_pool.MakeRef(raw_value, StringPool::Context(config_)));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700775 }
776 return {};
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800777}
778
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700779bool ResourceParser::ParseString(xml::XmlPullParser* parser,
780 ParsedResource* out_resource) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700781 bool formatted = true;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700782 if (Maybe<StringPiece> formatted_attr =
783 xml::FindAttribute(parser, "formatted")) {
784 Maybe<bool> maybe_formatted =
785 ResourceUtils::ParseBool(formatted_attr.value());
786 if (!maybe_formatted) {
787 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700788 << "invalid value for 'formatted'. Must be a boolean");
789 return false;
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800790 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700791 formatted = maybe_formatted.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700792 }
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800793
Adam Lesinski75421622017-01-06 15:20:04 -0800794 bool translatable = options_.translatable;
795 if (Maybe<StringPiece> translatable_attr = xml::FindAttribute(parser, "translatable")) {
796 Maybe<bool> maybe_translatable = ResourceUtils::ParseBool(translatable_attr.value());
797 if (!maybe_translatable) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700798 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700799 << "invalid value for 'translatable'. Must be a boolean");
800 return false;
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800801 }
Adam Lesinski75421622017-01-06 15:20:04 -0800802 translatable = maybe_translatable.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700803 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800804
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700805 out_resource->value =
806 ParseXml(parser, android::ResTable_map::TYPE_STRING, kNoRawString);
807 if (!out_resource->value) {
808 diag_->Error(DiagMessage(out_resource->source) << "not a valid string");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700809 return false;
810 }
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800811
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700812 if (String* string_value = ValueCast<String>(out_resource->value.get())) {
Adam Lesinski75421622017-01-06 15:20:04 -0800813 string_value->SetTranslatable(translatable);
Adam Lesinski393b5f02015-12-17 13:03:11 -0800814
Adam Lesinski75421622017-01-06 15:20:04 -0800815 if (formatted && translatable) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700816 if (!util::VerifyJavaStringFormat(*string_value->value)) {
817 DiagMessage msg(out_resource->source);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700818 msg << "multiple substitutions specified in non-positional format; "
819 "did you mean to add the formatted=\"false\" attribute?";
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700820 if (options_.error_on_positional_arguments) {
821 diag_->Error(msg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700822 return false;
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800823 }
Adam Lesinski393b5f02015-12-17 13:03:11 -0800824
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700825 diag_->Warn(msg);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700826 }
Adam Lesinskib23f1e02015-11-03 12:24:17 -0800827 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700828
Adam Lesinski75421622017-01-06 15:20:04 -0800829 } else if (StyledString* string_value = ValueCast<StyledString>(out_resource->value.get())) {
830 string_value->SetTranslatable(translatable);
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700831 }
832 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800833}
834
Adam Lesinski71be7052017-12-12 16:48:07 -0800835bool ResourceParser::ParsePublic(xml::XmlPullParser* parser, ParsedResource* out_resource) {
Adam Lesinski46c4d722017-08-23 13:03:56 -0700836 if (out_resource->config != ConfigDescription::DefaultConfig()) {
837 diag_->Warn(DiagMessage(out_resource->source)
838 << "ignoring configuration '" << out_resource->config << "' for <public> tag");
839 }
840
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700841 Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type");
842 if (!maybe_type) {
843 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700844 << "<public> must have a 'type' attribute");
845 return false;
846 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800847
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700848 const ResourceType* parsed_type = ParseResourceType(maybe_type.value());
849 if (!parsed_type) {
850 diag_->Error(DiagMessage(out_resource->source) << "invalid resource type '"
851 << maybe_type.value()
852 << "' in <public>");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700853 return false;
854 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800855
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700856 out_resource->name.type = *parsed_type;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800857
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800858 if (Maybe<StringPiece> maybe_id_str = xml::FindNonEmptyAttribute(parser, "id")) {
859 Maybe<ResourceId> maybe_id = ResourceUtils::ParseResourceId(maybe_id_str.value());
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700860 if (!maybe_id) {
Adam Lesinskiceb9b2f2017-02-16 12:05:42 -0800861 diag_->Error(DiagMessage(out_resource->source)
862 << "invalid resource ID '" << maybe_id_str.value() << "' in <public>");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700863 return false;
Adam Lesinski27afb9e2015-11-06 18:25:04 -0800864 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700865 out_resource->id = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700866 }
Adam Lesinski27afb9e2015-11-06 18:25:04 -0800867
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700868 if (*parsed_type == ResourceType::kId) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700869 // An ID marked as public is also the definition of an ID.
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700870 out_resource->value = util::make_unique<Id>();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700871 }
Adam Lesinskibf0bd0f2016-06-01 15:31:50 -0700872
Adam Lesinski71be7052017-12-12 16:48:07 -0800873 out_resource->visibility_level = Visibility::Level::kPublic;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700874 return true;
Adam Lesinski27afb9e2015-11-06 18:25:04 -0800875}
876
Adam Lesinski46c4d722017-08-23 13:03:56 -0700877bool ResourceParser::ParsePublicGroup(xml::XmlPullParser* parser, ParsedResource* out_resource) {
878 if (out_resource->config != ConfigDescription::DefaultConfig()) {
879 diag_->Warn(DiagMessage(out_resource->source)
880 << "ignoring configuration '" << out_resource->config
881 << "' for <public-group> tag");
882 }
883
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700884 Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type");
885 if (!maybe_type) {
886 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700887 << "<public-group> must have a 'type' attribute");
Adam Lesinskia6fe3452015-12-09 15:20:52 -0800888 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700889 }
Adam Lesinskia6fe3452015-12-09 15:20:52 -0800890
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700891 const ResourceType* parsed_type = ParseResourceType(maybe_type.value());
892 if (!parsed_type) {
893 diag_->Error(DiagMessage(out_resource->source) << "invalid resource type '"
894 << maybe_type.value()
895 << "' in <public-group>");
Adam Lesinskia6fe3452015-12-09 15:20:52 -0800896 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700897 }
898
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700899 Maybe<StringPiece> maybe_id_str =
900 xml::FindNonEmptyAttribute(parser, "first-id");
901 if (!maybe_id_str) {
902 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700903 << "<public-group> must have a 'first-id' attribute");
904 return false;
905 }
906
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700907 Maybe<ResourceId> maybe_id =
908 ResourceUtils::ParseResourceId(maybe_id_str.value());
909 if (!maybe_id) {
910 diag_->Error(DiagMessage(out_resource->source) << "invalid resource ID '"
911 << maybe_id_str.value()
912 << "' in <public-group>");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700913 return false;
914 }
915
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700916 ResourceId next_id = maybe_id.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700917
918 std::string comment;
919 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700920 const size_t depth = parser->depth();
921 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
922 if (parser->event() == xml::XmlPullParser::Event::kComment) {
Adam Lesinskid5083f62017-01-16 15:07:21 -0800923 comment = util::TrimWhitespace(parser->comment()).to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700924 continue;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700925 } else if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700926 // Skip text.
927 continue;
928 }
929
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700930 const Source item_source = source_.WithLine(parser->line_number());
931 const std::string& element_namespace = parser->element_namespace();
932 const std::string& element_name = parser->element_name();
933 if (element_namespace.empty() && element_name == "public") {
934 Maybe<StringPiece> maybe_name =
935 xml::FindNonEmptyAttribute(parser, "name");
936 if (!maybe_name) {
937 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700938 << "<public> must have a 'name' attribute");
939 error = true;
940 continue;
941 }
942
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700943 if (xml::FindNonEmptyAttribute(parser, "id")) {
944 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700945 << "'id' is ignored within <public-group>");
946 error = true;
947 continue;
948 }
949
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700950 if (xml::FindNonEmptyAttribute(parser, "type")) {
951 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700952 << "'type' is ignored within <public-group>");
953 error = true;
954 continue;
955 }
956
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700957 ParsedResource child_resource;
958 child_resource.name.type = *parsed_type;
Adam Lesinskid5083f62017-01-16 15:07:21 -0800959 child_resource.name.entry = maybe_name.value().to_string();
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700960 child_resource.id = next_id;
961 child_resource.comment = std::move(comment);
962 child_resource.source = item_source;
Adam Lesinski71be7052017-12-12 16:48:07 -0800963 child_resource.visibility_level = Visibility::Level::kPublic;
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700964 out_resource->child_resources.push_back(std::move(child_resource));
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700965
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700966 next_id.id += 1;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700967
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700968 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
969 diag_->Error(DiagMessage(item_source) << ":" << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700970 error = true;
971 }
972 }
973 return !error;
Adam Lesinskia6fe3452015-12-09 15:20:52 -0800974}
975
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700976bool ResourceParser::ParseSymbolImpl(xml::XmlPullParser* parser,
977 ParsedResource* out_resource) {
978 Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type");
979 if (!maybe_type) {
980 diag_->Error(DiagMessage(out_resource->source)
981 << "<" << parser->element_name()
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700982 << "> must have a 'type' attribute");
983 return false;
984 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800985
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700986 const ResourceType* parsed_type = ParseResourceType(maybe_type.value());
987 if (!parsed_type) {
988 diag_->Error(DiagMessage(out_resource->source)
989 << "invalid resource type '" << maybe_type.value() << "' in <"
990 << parser->element_name() << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700991 return false;
992 }
993
Adam Lesinskice5e56e2016-10-21 17:56:45 -0700994 out_resource->name.type = *parsed_type;
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700995 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800996}
997
Adam Lesinski46c4d722017-08-23 13:03:56 -0700998bool ResourceParser::ParseSymbol(xml::XmlPullParser* parser, ParsedResource* out_resource) {
999 if (out_resource->config != ConfigDescription::DefaultConfig()) {
1000 diag_->Warn(DiagMessage(out_resource->source)
1001 << "ignoring configuration '" << out_resource->config << "' for <"
1002 << parser->element_name() << "> tag");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001003 }
Adam Lesinski46c4d722017-08-23 13:03:56 -07001004
1005 if (!ParseSymbolImpl(parser, out_resource)) {
1006 return false;
1007 }
1008
Adam Lesinski71be7052017-12-12 16:48:07 -08001009 out_resource->visibility_level = Visibility::Level::kPrivate;
Adam Lesinski46c4d722017-08-23 13:03:56 -07001010 return true;
1011}
1012
1013bool ResourceParser::ParseOverlayable(xml::XmlPullParser* parser, ParsedResource* out_resource) {
1014 if (out_resource->config != ConfigDescription::DefaultConfig()) {
1015 diag_->Warn(DiagMessage(out_resource->source)
1016 << "ignoring configuration '" << out_resource->config << "' for <overlayable> tag");
1017 }
1018
1019 if (Maybe<StringPiece> maybe_policy = xml::FindNonEmptyAttribute(parser, "policy")) {
1020 const StringPiece& policy = maybe_policy.value();
1021 if (policy != "system") {
1022 diag_->Error(DiagMessage(out_resource->source)
1023 << "<overlayable> has invalid policy '" << policy << "'");
1024 return false;
1025 }
1026 }
1027
1028 bool error = false;
1029 const size_t depth = parser->depth();
1030 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1031 if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
1032 // Skip text/comments.
1033 continue;
1034 }
1035
1036 const Source item_source = source_.WithLine(parser->line_number());
1037 const std::string& element_namespace = parser->element_namespace();
1038 const std::string& element_name = parser->element_name();
1039 if (element_namespace.empty() && element_name == "item") {
1040 Maybe<StringPiece> maybe_name = xml::FindNonEmptyAttribute(parser, "name");
1041 if (!maybe_name) {
1042 diag_->Error(DiagMessage(item_source)
1043 << "<item> within an <overlayable> tag must have a 'name' attribute");
1044 error = true;
1045 continue;
1046 }
1047
1048 Maybe<StringPiece> maybe_type = xml::FindNonEmptyAttribute(parser, "type");
1049 if (!maybe_type) {
1050 diag_->Error(DiagMessage(item_source)
1051 << "<item> within an <overlayable> tag must have a 'type' attribute");
1052 error = true;
1053 continue;
1054 }
1055
1056 const ResourceType* type = ParseResourceType(maybe_type.value());
1057 if (type == nullptr) {
1058 diag_->Error(DiagMessage(out_resource->source)
1059 << "invalid resource type '" << maybe_type.value()
1060 << "' in <item> within an <overlayable>");
1061 error = true;
1062 continue;
1063 }
1064
Adam Lesinski71be7052017-12-12 16:48:07 -08001065 ParsedResource child_resource;
1066 child_resource.name.type = *type;
1067 child_resource.name.entry = maybe_name.value().to_string();
1068 child_resource.source = item_source;
1069 child_resource.overlayable = true;
1070 out_resource->child_resources.push_back(std::move(child_resource));
Adam Lesinski46c4d722017-08-23 13:03:56 -07001071
1072 xml::XmlPullParser::SkipCurrentElement(parser);
1073 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1074 diag_->Error(DiagMessage(item_source) << ":" << element_name << ">");
1075 error = true;
1076 }
1077 }
1078 return !error;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001079}
1080
Adam Lesinski71be7052017-12-12 16:48:07 -08001081bool ResourceParser::ParseAddResource(xml::XmlPullParser* parser, ParsedResource* out_resource) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001082 if (ParseSymbolImpl(parser, out_resource)) {
Adam Lesinski71be7052017-12-12 16:48:07 -08001083 out_resource->visibility_level = Visibility::Level::kUndefined;
Adam Lesinski4488f1c2017-05-26 17:33:38 -07001084 out_resource->allow_new = true;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001085 return true;
1086 }
1087 return false;
1088}
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001089
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001090bool ResourceParser::ParseAttr(xml::XmlPullParser* parser,
1091 ParsedResource* out_resource) {
1092 return ParseAttrImpl(parser, out_resource, false);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001093}
1094
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001095bool ResourceParser::ParseAttrImpl(xml::XmlPullParser* parser,
1096 ParsedResource* out_resource, bool weak) {
1097 out_resource->name.type = ResourceType::kAttr;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001098
1099 // Attributes only end up in default configuration.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001100 if (out_resource->config != ConfigDescription::DefaultConfig()) {
1101 diag_->Warn(DiagMessage(out_resource->source)
1102 << "ignoring configuration '" << out_resource->config
1103 << "' for attribute " << out_resource->name);
1104 out_resource->config = ConfigDescription::DefaultConfig();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001105 }
1106
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001107 uint32_t type_mask = 0;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001108
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001109 Maybe<StringPiece> maybe_format = xml::FindAttribute(parser, "format");
1110 if (maybe_format) {
1111 type_mask = ParseFormatAttribute(maybe_format.value());
1112 if (type_mask == 0) {
1113 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001114 << "invalid attribute format '" << maybe_format.value() << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001115 return false;
1116 }
1117 }
1118
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001119 Maybe<int32_t> maybe_min, maybe_max;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001120
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001121 if (Maybe<StringPiece> maybe_min_str = xml::FindAttribute(parser, "min")) {
1122 StringPiece min_str = util::TrimWhitespace(maybe_min_str.value());
1123 if (!min_str.empty()) {
1124 std::u16string min_str16 = util::Utf8ToUtf16(min_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001125 android::Res_value value;
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001126 if (android::ResTable::stringToInt(min_str16.data(), min_str16.size(), &value)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001127 maybe_min = static_cast<int32_t>(value.data);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001128 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001129 }
1130
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001131 if (!maybe_min) {
1132 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
1133 << "invalid 'min' value '" << min_str << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001134 return false;
1135 }
1136 }
1137
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001138 if (Maybe<StringPiece> maybe_max_str = xml::FindAttribute(parser, "max")) {
1139 StringPiece max_str = util::TrimWhitespace(maybe_max_str.value());
1140 if (!max_str.empty()) {
1141 std::u16string max_str16 = util::Utf8ToUtf16(max_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001142 android::Res_value value;
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001143 if (android::ResTable::stringToInt(max_str16.data(), max_str16.size(), &value)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001144 maybe_max = static_cast<int32_t>(value.data);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001145 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001146 }
1147
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001148 if (!maybe_max) {
1149 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
1150 << "invalid 'max' value '" << max_str << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001151 return false;
1152 }
1153 }
1154
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001155 if ((maybe_min || maybe_max) &&
1156 (type_mask & android::ResTable_map::TYPE_INTEGER) == 0) {
1157 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001158 << "'min' and 'max' can only be used when format='integer'");
1159 return false;
1160 }
1161
1162 struct SymbolComparator {
Yi Kong087e2d42017-05-02 12:49:25 -07001163 bool operator()(const Attribute::Symbol& a, const Attribute::Symbol& b) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001164 return a.symbol.name.value() < b.symbol.name.value();
1165 }
1166 };
1167
1168 std::set<Attribute::Symbol, SymbolComparator> items;
1169
1170 std::string comment;
1171 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001172 const size_t depth = parser->depth();
1173 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1174 if (parser->event() == xml::XmlPullParser::Event::kComment) {
Adam Lesinskid5083f62017-01-16 15:07:21 -08001175 comment = util::TrimWhitespace(parser->comment()).to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001176 continue;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001177 } else if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001178 // Skip text.
1179 continue;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001180 }
1181
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001182 const Source item_source = source_.WithLine(parser->line_number());
1183 const std::string& element_namespace = parser->element_namespace();
1184 const std::string& element_name = parser->element_name();
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001185 if (element_namespace.empty() && (element_name == "flag" || element_name == "enum")) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001186 if (element_name == "enum") {
1187 if (type_mask & android::ResTable_map::TYPE_FLAGS) {
1188 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001189 << "can not define an <enum>; already defined a <flag>");
1190 error = true;
1191 continue;
1192 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001193 type_mask |= android::ResTable_map::TYPE_ENUM;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001194
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001195 } else if (element_name == "flag") {
1196 if (type_mask & android::ResTable_map::TYPE_ENUM) {
1197 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001198 << "can not define a <flag>; already defined an <enum>");
1199 error = true;
1200 continue;
1201 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001202 type_mask |= android::ResTable_map::TYPE_FLAGS;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001203 }
1204
1205 if (Maybe<Attribute::Symbol> s =
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001206 ParseEnumOrFlagItem(parser, element_name)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001207 Attribute::Symbol& symbol = s.value();
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001208 ParsedResource child_resource;
1209 child_resource.name = symbol.symbol.name.value();
1210 child_resource.source = item_source;
1211 child_resource.value = util::make_unique<Id>();
1212 out_resource->child_resources.push_back(std::move(child_resource));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001213
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001214 symbol.symbol.SetComment(std::move(comment));
1215 symbol.symbol.SetSource(item_source);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001216
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001217 auto insert_result = items.insert(std::move(symbol));
1218 if (!insert_result.second) {
1219 const Attribute::Symbol& existing_symbol = *insert_result.first;
1220 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001221 << "duplicate symbol '"
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001222 << existing_symbol.symbol.name.value().entry << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001223
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001224 diag_->Note(DiagMessage(existing_symbol.symbol.GetSource())
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001225 << "first defined here");
1226 error = true;
1227 }
1228 } else {
1229 error = true;
1230 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001231 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1232 diag_->Error(DiagMessage(item_source) << ":" << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001233 error = true;
1234 }
1235
1236 comment = {};
1237 }
1238
1239 if (error) {
1240 return false;
1241 }
1242
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001243 std::unique_ptr<Attribute> attr = util::make_unique<Attribute>(
1244 type_mask ? type_mask : uint32_t{android::ResTable_map::TYPE_ANY});
1245 attr->SetWeak(weak);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001246 attr->symbols = std::vector<Attribute::Symbol>(items.begin(), items.end());
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001247 attr->min_int = maybe_min.value_or_default(std::numeric_limits<int32_t>::min());
1248 attr->max_int = maybe_max.value_or_default(std::numeric_limits<int32_t>::max());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001249 out_resource->value = std::move(attr);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001250 return true;
1251}
1252
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001253Maybe<Attribute::Symbol> ResourceParser::ParseEnumOrFlagItem(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001254 xml::XmlPullParser* parser, const StringPiece& tag) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001255 const Source source = source_.WithLine(parser->line_number());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001256
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001257 Maybe<StringPiece> maybe_name = xml::FindNonEmptyAttribute(parser, "name");
1258 if (!maybe_name) {
1259 diag_->Error(DiagMessage(source) << "no attribute 'name' found for tag <"
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001260 << tag << ">");
1261 return {};
1262 }
1263
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001264 Maybe<StringPiece> maybe_value = xml::FindNonEmptyAttribute(parser, "value");
1265 if (!maybe_value) {
1266 diag_->Error(DiagMessage(source) << "no attribute 'value' found for tag <"
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001267 << tag << ">");
1268 return {};
1269 }
1270
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001271 std::u16string value16 = util::Utf8ToUtf16(maybe_value.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001272 android::Res_value val;
1273 if (!android::ResTable::stringToInt(value16.data(), value16.size(), &val)) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001274 diag_->Error(DiagMessage(source) << "invalid value '" << maybe_value.value()
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001275 << "' for <" << tag
1276 << ">; must be an integer");
1277 return {};
1278 }
1279
1280 return Attribute::Symbol{
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001281 Reference(ResourceNameRef({}, ResourceType::kId, maybe_name.value())),
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001282 val.data};
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001283}
1284
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001285bool ResourceParser::ParseStyleItem(xml::XmlPullParser* parser, Style* style) {
1286 const Source source = source_.WithLine(parser->line_number());
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001287
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001288 Maybe<StringPiece> maybe_name = xml::FindNonEmptyAttribute(parser, "name");
1289 if (!maybe_name) {
1290 diag_->Error(DiagMessage(source) << "<item> must have a 'name' attribute");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001291 return false;
1292 }
1293
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001294 Maybe<Reference> maybe_key = ResourceUtils::ParseXmlAttributeName(maybe_name.value());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001295 if (!maybe_key) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001296 diag_->Error(DiagMessage(source) << "invalid attribute name '" << maybe_name.value() << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001297 return false;
1298 }
1299
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001300 ResolvePackage(parser, &maybe_key.value());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001301 maybe_key.value().SetSource(source);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001302
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001303 std::unique_ptr<Item> value = ParseXml(parser, 0, kAllowRawString);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001304 if (!value) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001305 diag_->Error(DiagMessage(source) << "could not parse style item");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001306 return false;
1307 }
1308
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001309 style->entries.push_back(Style::Entry{std::move(maybe_key.value()), std::move(value)});
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001310 return true;
1311}
1312
Adam Lesinski86d67df2017-01-31 13:47:27 -08001313bool ResourceParser::ParseStyle(const ResourceType type, xml::XmlPullParser* parser,
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001314 ParsedResource* out_resource) {
Adam Lesinski86d67df2017-01-31 13:47:27 -08001315 out_resource->name.type = type;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001316
1317 std::unique_ptr<Style> style = util::make_unique<Style>();
1318
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001319 Maybe<StringPiece> maybe_parent = xml::FindAttribute(parser, "parent");
1320 if (maybe_parent) {
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001321 // If the parent is empty, we don't have a parent, but we also don't infer either.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001322 if (!maybe_parent.value().empty()) {
1323 std::string err_str;
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001324 style->parent = ResourceUtils::ParseStyleParentReference(maybe_parent.value(), &err_str);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001325 if (!style->parent) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001326 diag_->Error(DiagMessage(out_resource->source) << err_str);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001327 return false;
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001328 }
1329
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001330 // Transform the namespace prefix to the actual package name, and mark the reference as
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001331 // private if appropriate.
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001332 ResolvePackage(parser, &style->parent.value());
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001333 }
1334
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001335 } else {
1336 // No parent was specified, so try inferring it from the style name.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001337 std::string style_name = out_resource->name.entry;
1338 size_t pos = style_name.find_last_of(u'.');
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001339 if (pos != std::string::npos) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001340 style->parent_inferred = true;
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001341 style->parent = Reference(ResourceName({}, ResourceType::kStyle, style_name.substr(0, pos)));
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001342 }
1343 }
1344
1345 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001346 const size_t depth = parser->depth();
1347 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1348 if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001349 // Skip text and comments.
1350 continue;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001351 }
1352
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001353 const std::string& element_namespace = parser->element_namespace();
1354 const std::string& element_name = parser->element_name();
1355 if (element_namespace == "" && element_name == "item") {
1356 error |= !ParseStyleItem(parser, style.get());
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001357
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001358 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1359 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
1360 << ":" << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001361 error = true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001362 }
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001363 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001364
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001365 if (error) {
1366 return false;
1367 }
1368
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001369 out_resource->value = std::move(style);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001370 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001371}
1372
Adam Lesinskid5fd76a2017-05-16 12:18:08 -07001373bool ResourceParser::ParseArray(xml::XmlPullParser* parser, ParsedResource* out_resource) {
1374 uint32_t resource_format = android::ResTable_map::TYPE_ANY;
1375 if (Maybe<StringPiece> format_attr = xml::FindNonEmptyAttribute(parser, "format")) {
1376 resource_format = ParseFormatTypeNoEnumsOrFlags(format_attr.value());
1377 if (resource_format == 0u) {
1378 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
1379 << "'" << format_attr.value() << "' is an invalid format");
1380 return false;
1381 }
1382 }
1383 return ParseArrayImpl(parser, out_resource, resource_format);
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001384}
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001385
Adam Lesinskid5fd76a2017-05-16 12:18:08 -07001386bool ResourceParser::ParseIntegerArray(xml::XmlPullParser* parser, ParsedResource* out_resource) {
1387 return ParseArrayImpl(parser, out_resource, android::ResTable_map::TYPE_INTEGER);
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001388}
1389
Adam Lesinskid5fd76a2017-05-16 12:18:08 -07001390bool ResourceParser::ParseStringArray(xml::XmlPullParser* parser, ParsedResource* out_resource) {
1391 return ParseArrayImpl(parser, out_resource, android::ResTable_map::TYPE_STRING);
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001392}
1393
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001394bool ResourceParser::ParseArrayImpl(xml::XmlPullParser* parser,
1395 ParsedResource* out_resource,
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001396 const uint32_t typeMask) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001397 out_resource->name.type = ResourceType::kArray;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001398
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001399 std::unique_ptr<Array> array = util::make_unique<Array>();
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001400
Adam Lesinski75421622017-01-06 15:20:04 -08001401 bool translatable = options_.translatable;
1402 if (Maybe<StringPiece> translatable_attr = xml::FindAttribute(parser, "translatable")) {
1403 Maybe<bool> maybe_translatable = ResourceUtils::ParseBool(translatable_attr.value());
1404 if (!maybe_translatable) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001405 diag_->Error(DiagMessage(out_resource->source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001406 << "invalid value for 'translatable'. Must be a boolean");
1407 return false;
Adam Lesinski458b8772016-04-25 14:20:21 -07001408 }
Adam Lesinski75421622017-01-06 15:20:04 -08001409 translatable = maybe_translatable.value();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001410 }
Adam Lesinski75421622017-01-06 15:20:04 -08001411 array->SetTranslatable(translatable);
Adam Lesinski458b8772016-04-25 14:20:21 -07001412
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001413 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001414 const size_t depth = parser->depth();
1415 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1416 if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001417 // Skip text and comments.
1418 continue;
Adam Lesinski1ab598f2015-08-14 14:26:04 -07001419 }
1420
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001421 const Source item_source = source_.WithLine(parser->line_number());
1422 const std::string& element_namespace = parser->element_namespace();
1423 const std::string& element_name = parser->element_name();
1424 if (element_namespace.empty() && element_name == "item") {
1425 std::unique_ptr<Item> item = ParseXml(parser, typeMask, kNoRawString);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001426 if (!item) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001427 diag_->Error(DiagMessage(item_source) << "could not parse array item");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001428 error = true;
1429 continue;
1430 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001431 item->SetSource(item_source);
Adam Lesinski4ffea042017-08-10 15:37:28 -07001432 array->elements.emplace_back(std::move(item));
Adam Lesinski9ba47d82015-10-13 11:37:10 -07001433
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001434 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1435 diag_->Error(DiagMessage(source_.WithLine(parser->line_number()))
1436 << "unknown tag <" << element_namespace << ":"
1437 << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001438 error = true;
1439 }
1440 }
1441
1442 if (error) {
1443 return false;
1444 }
1445
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001446 out_resource->value = std::move(array);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001447 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001448}
1449
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001450bool ResourceParser::ParsePlural(xml::XmlPullParser* parser,
1451 ParsedResource* out_resource) {
1452 out_resource->name.type = ResourceType::kPlurals;
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001453
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001454 std::unique_ptr<Plural> plural = util::make_unique<Plural>();
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001455
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001456 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001457 const size_t depth = parser->depth();
1458 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1459 if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001460 // Skip text and comments.
1461 continue;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001462 }
1463
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001464 const Source item_source = source_.WithLine(parser->line_number());
1465 const std::string& element_namespace = parser->element_namespace();
1466 const std::string& element_name = parser->element_name();
1467 if (element_namespace.empty() && element_name == "item") {
1468 Maybe<StringPiece> maybe_quantity =
1469 xml::FindNonEmptyAttribute(parser, "quantity");
1470 if (!maybe_quantity) {
1471 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001472 << "<item> in <plurals> requires attribute "
1473 << "'quantity'");
1474 error = true;
1475 continue;
1476 }
Adam Lesinski9ba47d82015-10-13 11:37:10 -07001477
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001478 StringPiece trimmed_quantity =
1479 util::TrimWhitespace(maybe_quantity.value());
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001480 size_t index = 0;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001481 if (trimmed_quantity == "zero") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001482 index = Plural::Zero;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001483 } else if (trimmed_quantity == "one") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001484 index = Plural::One;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001485 } else if (trimmed_quantity == "two") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001486 index = Plural::Two;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001487 } else if (trimmed_quantity == "few") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001488 index = Plural::Few;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001489 } else if (trimmed_quantity == "many") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001490 index = Plural::Many;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001491 } else if (trimmed_quantity == "other") {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001492 index = Plural::Other;
1493 } else {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001494 diag_->Error(DiagMessage(item_source)
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001495 << "<item> in <plural> has invalid value '"
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001496 << trimmed_quantity << "' for attribute 'quantity'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001497 error = true;
1498 continue;
1499 }
1500
1501 if (plural->values[index]) {
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001502 diag_->Error(DiagMessage(item_source) << "duplicate quantity '"
1503 << trimmed_quantity << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001504 error = true;
1505 continue;
1506 }
1507
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001508 if (!(plural->values[index] = ParseXml(
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001509 parser, android::ResTable_map::TYPE_STRING, kNoRawString))) {
1510 error = true;
1511 }
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001512 plural->values[index]->SetSource(item_source);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001513
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001514 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1515 diag_->Error(DiagMessage(item_source) << "unknown tag <"
1516 << element_namespace << ":"
1517 << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001518 error = true;
1519 }
1520 }
1521
1522 if (error) {
1523 return false;
1524 }
1525
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001526 out_resource->value = std::move(plural);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001527 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001528}
1529
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001530bool ResourceParser::ParseDeclareStyleable(xml::XmlPullParser* parser,
1531 ParsedResource* out_resource) {
1532 out_resource->name.type = ResourceType::kStyleable;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001533
Adam Lesinski71be7052017-12-12 16:48:07 -08001534 // Declare-styleable is kPrivate by default, because it technically only exists in R.java.
1535 out_resource->visibility_level = Visibility::Level::kPublic;
Adam Lesinski9f222042015-11-04 13:51:45 -08001536
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001537 // Declare-styleable only ends up in default config;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001538 if (out_resource->config != ConfigDescription::DefaultConfig()) {
1539 diag_->Warn(DiagMessage(out_resource->source)
1540 << "ignoring configuration '" << out_resource->config
1541 << "' for styleable " << out_resource->name.entry);
1542 out_resource->config = ConfigDescription::DefaultConfig();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001543 }
1544
1545 std::unique_ptr<Styleable> styleable = util::make_unique<Styleable>();
1546
1547 std::string comment;
1548 bool error = false;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001549 const size_t depth = parser->depth();
1550 while (xml::XmlPullParser::NextChildNode(parser, depth)) {
1551 if (parser->event() == xml::XmlPullParser::Event::kComment) {
Adam Lesinskid5083f62017-01-16 15:07:21 -08001552 comment = util::TrimWhitespace(parser->comment()).to_string();
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001553 continue;
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001554 } else if (parser->event() != xml::XmlPullParser::Event::kStartElement) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001555 // Ignore text.
1556 continue;
Adam Lesinski52364f72016-01-11 13:10:24 -08001557 }
1558
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001559 const Source item_source = source_.WithLine(parser->line_number());
1560 const std::string& element_namespace = parser->element_namespace();
1561 const std::string& element_name = parser->element_name();
1562 if (element_namespace.empty() && element_name == "attr") {
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001563 Maybe<StringPiece> maybe_name = xml::FindNonEmptyAttribute(parser, "name");
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001564 if (!maybe_name) {
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001565 diag_->Error(DiagMessage(item_source) << "<attr> tag must have a 'name' attribute");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001566 error = true;
1567 continue;
1568 }
Adam Lesinski7ff3ee12015-12-14 16:08:50 -08001569
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001570 // If this is a declaration, the package name may be in the name. Separate
1571 // these out.
1572 // Eg. <attr name="android:text" />
Adam Lesinski73bff1e2017-12-08 16:06:10 -08001573 Maybe<Reference> maybe_ref = ResourceUtils::ParseXmlAttributeName(maybe_name.value());
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001574 if (!maybe_ref) {
1575 diag_->Error(DiagMessage(item_source) << "<attr> tag has invalid name '"
1576 << maybe_name.value() << "'");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001577 error = true;
1578 continue;
1579 }
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001580
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001581 Reference& child_ref = maybe_ref.value();
Adam Lesinski1ef0fa92017-08-15 21:32:49 -07001582 xml::ResolvePackage(parser, &child_ref);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001583
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001584 // Create the ParsedResource that will add the attribute to the table.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001585 ParsedResource child_resource;
1586 child_resource.name = child_ref.name.value();
1587 child_resource.source = item_source;
1588 child_resource.comment = std::move(comment);
Adam Lesinski467f1712015-11-16 17:35:44 -08001589
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001590 if (!ParseAttrImpl(parser, &child_resource, true)) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001591 error = true;
1592 continue;
1593 }
Adam Lesinski467f1712015-11-16 17:35:44 -08001594
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001595 // Create the reference to this attribute.
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001596 child_ref.SetComment(child_resource.comment);
1597 child_ref.SetSource(item_source);
1598 styleable->entries.push_back(std::move(child_ref));
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001599
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001600 out_resource->child_resources.push_back(std::move(child_resource));
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001601
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001602 } else if (!ShouldIgnoreElement(element_namespace, element_name)) {
1603 diag_->Error(DiagMessage(item_source) << "unknown tag <"
1604 << element_namespace << ":"
1605 << element_name << ">");
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001606 error = true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001607 }
1608
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001609 comment = {};
1610 }
Adam Lesinski9ba47d82015-10-13 11:37:10 -07001611
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001612 if (error) {
1613 return false;
1614 }
1615
Adam Lesinskice5e56e2016-10-21 17:56:45 -07001616 out_resource->value = std::move(styleable);
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001617 return true;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001618}
1619
Adam Lesinskicacb28f2016-10-19 12:18:14 -07001620} // namespace aapt