xref: /aosp_15_r20/frameworks/base/tools/aapt2/xml/XmlUtil.cpp (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1*d57664e9SAndroid Build Coastguard Worker /*
2*d57664e9SAndroid Build Coastguard Worker  * Copyright (C) 2015 The Android Open Source Project
3*d57664e9SAndroid Build Coastguard Worker  *
4*d57664e9SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*d57664e9SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*d57664e9SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*d57664e9SAndroid Build Coastguard Worker  *
8*d57664e9SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*d57664e9SAndroid Build Coastguard Worker  *
10*d57664e9SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*d57664e9SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*d57664e9SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*d57664e9SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*d57664e9SAndroid Build Coastguard Worker  * limitations under the License.
15*d57664e9SAndroid Build Coastguard Worker  */
16*d57664e9SAndroid Build Coastguard Worker 
17*d57664e9SAndroid Build Coastguard Worker #include "xml/XmlUtil.h"
18*d57664e9SAndroid Build Coastguard Worker 
19*d57664e9SAndroid Build Coastguard Worker #include <algorithm>
20*d57664e9SAndroid Build Coastguard Worker #include <string>
21*d57664e9SAndroid Build Coastguard Worker 
22*d57664e9SAndroid Build Coastguard Worker #include "util/Util.h"
23*d57664e9SAndroid Build Coastguard Worker #include "xml/XmlDom.h"
24*d57664e9SAndroid Build Coastguard Worker 
25*d57664e9SAndroid Build Coastguard Worker using ::android::StringPiece;
26*d57664e9SAndroid Build Coastguard Worker 
27*d57664e9SAndroid Build Coastguard Worker namespace aapt {
28*d57664e9SAndroid Build Coastguard Worker namespace xml {
29*d57664e9SAndroid Build Coastguard Worker 
BuildPackageNamespace(StringPiece package,bool private_reference)30*d57664e9SAndroid Build Coastguard Worker std::string BuildPackageNamespace(StringPiece package, bool private_reference) {
31*d57664e9SAndroid Build Coastguard Worker   std::string result = private_reference ? kSchemaPrivatePrefix : kSchemaPublicPrefix;
32*d57664e9SAndroid Build Coastguard Worker   result.append(package.data(), package.size());
33*d57664e9SAndroid Build Coastguard Worker   return result;
34*d57664e9SAndroid Build Coastguard Worker }
35*d57664e9SAndroid Build Coastguard Worker 
ExtractPackageFromNamespace(const std::string & namespace_uri)36*d57664e9SAndroid Build Coastguard Worker std::optional<ExtractedPackage> ExtractPackageFromNamespace(const std::string& namespace_uri) {
37*d57664e9SAndroid Build Coastguard Worker   if (util::StartsWith(namespace_uri, kSchemaPublicPrefix)) {
38*d57664e9SAndroid Build Coastguard Worker     StringPiece schema_prefix = kSchemaPublicPrefix;
39*d57664e9SAndroid Build Coastguard Worker     StringPiece package = namespace_uri;
40*d57664e9SAndroid Build Coastguard Worker     package = package.substr(schema_prefix.size(), package.size() - schema_prefix.size());
41*d57664e9SAndroid Build Coastguard Worker     if (package.empty()) {
42*d57664e9SAndroid Build Coastguard Worker       return {};
43*d57664e9SAndroid Build Coastguard Worker     }
44*d57664e9SAndroid Build Coastguard Worker     return ExtractedPackage{std::string(package), false /* is_private */};
45*d57664e9SAndroid Build Coastguard Worker 
46*d57664e9SAndroid Build Coastguard Worker   } else if (util::StartsWith(namespace_uri, kSchemaPrivatePrefix)) {
47*d57664e9SAndroid Build Coastguard Worker     StringPiece schema_prefix = kSchemaPrivatePrefix;
48*d57664e9SAndroid Build Coastguard Worker     StringPiece package = namespace_uri;
49*d57664e9SAndroid Build Coastguard Worker     package = package.substr(schema_prefix.size(), package.size() - schema_prefix.size());
50*d57664e9SAndroid Build Coastguard Worker     if (package.empty()) {
51*d57664e9SAndroid Build Coastguard Worker       return {};
52*d57664e9SAndroid Build Coastguard Worker     }
53*d57664e9SAndroid Build Coastguard Worker     return ExtractedPackage{std::string(package), true /* is_private */};
54*d57664e9SAndroid Build Coastguard Worker 
55*d57664e9SAndroid Build Coastguard Worker   } else if (namespace_uri == kSchemaAuto) {
56*d57664e9SAndroid Build Coastguard Worker     return ExtractedPackage{std::string(), true /* is_private */};
57*d57664e9SAndroid Build Coastguard Worker   }
58*d57664e9SAndroid Build Coastguard Worker   return {};
59*d57664e9SAndroid Build Coastguard Worker }
60*d57664e9SAndroid Build Coastguard Worker 
ResolvePackage(const IPackageDeclStack * decl_stack,Reference * in_ref)61*d57664e9SAndroid Build Coastguard Worker void ResolvePackage(const IPackageDeclStack* decl_stack, Reference* in_ref) {
62*d57664e9SAndroid Build Coastguard Worker   if (in_ref->name) {
63*d57664e9SAndroid Build Coastguard Worker     if (std::optional<ExtractedPackage> transformed_package =
64*d57664e9SAndroid Build Coastguard Worker             decl_stack->TransformPackageAlias(in_ref->name.value().package)) {
65*d57664e9SAndroid Build Coastguard Worker       ExtractedPackage& extracted_package = transformed_package.value();
66*d57664e9SAndroid Build Coastguard Worker       in_ref->name.value().package = std::move(extracted_package.package);
67*d57664e9SAndroid Build Coastguard Worker 
68*d57664e9SAndroid Build Coastguard Worker       // If the reference was already private (with a * prefix) and the
69*d57664e9SAndroid Build Coastguard Worker       // namespace is public, we keep the reference private.
70*d57664e9SAndroid Build Coastguard Worker       in_ref->private_reference |= extracted_package.private_namespace;
71*d57664e9SAndroid Build Coastguard Worker     }
72*d57664e9SAndroid Build Coastguard Worker   }
73*d57664e9SAndroid Build Coastguard Worker }
74*d57664e9SAndroid Build Coastguard Worker 
75*d57664e9SAndroid Build Coastguard Worker namespace {
76*d57664e9SAndroid Build Coastguard Worker 
77*d57664e9SAndroid Build Coastguard Worker class ToolsNamespaceRemover : public Visitor {
78*d57664e9SAndroid Build Coastguard Worker  public:
79*d57664e9SAndroid Build Coastguard Worker   using Visitor::Visit;
80*d57664e9SAndroid Build Coastguard Worker 
Visit(Element * el)81*d57664e9SAndroid Build Coastguard Worker   void Visit(Element* el) override {
82*d57664e9SAndroid Build Coastguard Worker     auto new_end =
83*d57664e9SAndroid Build Coastguard Worker         std::remove_if(el->namespace_decls.begin(), el->namespace_decls.end(),
84*d57664e9SAndroid Build Coastguard Worker                        [](const NamespaceDecl& decl) -> bool { return decl.uri == kSchemaTools; });
85*d57664e9SAndroid Build Coastguard Worker     el->namespace_decls.erase(new_end, el->namespace_decls.end());
86*d57664e9SAndroid Build Coastguard Worker 
87*d57664e9SAndroid Build Coastguard Worker     auto new_attr_end = std::remove_if(
88*d57664e9SAndroid Build Coastguard Worker         el->attributes.begin(), el->attributes.end(),
89*d57664e9SAndroid Build Coastguard Worker         [](const Attribute& attr) -> bool { return attr.namespace_uri == kSchemaTools; });
90*d57664e9SAndroid Build Coastguard Worker     el->attributes.erase(new_attr_end, el->attributes.end());
91*d57664e9SAndroid Build Coastguard Worker 
92*d57664e9SAndroid Build Coastguard Worker     Visitor::Visit(el);
93*d57664e9SAndroid Build Coastguard Worker   }
94*d57664e9SAndroid Build Coastguard Worker };
95*d57664e9SAndroid Build Coastguard Worker 
96*d57664e9SAndroid Build Coastguard Worker }  // namespace
97*d57664e9SAndroid Build Coastguard Worker 
StripAndroidStudioAttributes(Element * el)98*d57664e9SAndroid Build Coastguard Worker void StripAndroidStudioAttributes(Element* el) {
99*d57664e9SAndroid Build Coastguard Worker   ToolsNamespaceRemover remover;
100*d57664e9SAndroid Build Coastguard Worker   el->Accept(&remover);
101*d57664e9SAndroid Build Coastguard Worker }
102*d57664e9SAndroid Build Coastguard Worker 
103*d57664e9SAndroid Build Coastguard Worker }  // namespace xml
104*d57664e9SAndroid Build Coastguard Worker }  // namespace aapt
105