xref: /aosp_15_r20/frameworks/base/tools/aapt2/java/ClassDefinition.cpp (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1*d57664e9SAndroid Build Coastguard Worker /*
2*d57664e9SAndroid Build Coastguard Worker  * Copyright (C) 2016 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 "java/ClassDefinition.h"
18*d57664e9SAndroid Build Coastguard Worker 
19*d57664e9SAndroid Build Coastguard Worker #include "androidfw/StringPiece.h"
20*d57664e9SAndroid Build Coastguard Worker 
21*d57664e9SAndroid Build Coastguard Worker using ::aapt::text::Printer;
22*d57664e9SAndroid Build Coastguard Worker using ::android::StringPiece;
23*d57664e9SAndroid Build Coastguard Worker 
24*d57664e9SAndroid Build Coastguard Worker namespace aapt {
25*d57664e9SAndroid Build Coastguard Worker 
Print(bool,Printer * printer,bool strip_api_annotations) const26*d57664e9SAndroid Build Coastguard Worker void ClassMember::Print(bool /*final*/, Printer* printer, bool strip_api_annotations) const {
27*d57664e9SAndroid Build Coastguard Worker   processor_.Print(printer, strip_api_annotations);
28*d57664e9SAndroid Build Coastguard Worker }
29*d57664e9SAndroid Build Coastguard Worker 
AppendStatement(StringPiece statement)30*d57664e9SAndroid Build Coastguard Worker void MethodDefinition::AppendStatement(StringPiece statement) {
31*d57664e9SAndroid Build Coastguard Worker   statements_.emplace_back(statement);
32*d57664e9SAndroid Build Coastguard Worker }
33*d57664e9SAndroid Build Coastguard Worker 
Print(bool final,Printer * printer,bool) const34*d57664e9SAndroid Build Coastguard Worker void MethodDefinition::Print(bool final, Printer* printer, bool) const {
35*d57664e9SAndroid Build Coastguard Worker   printer->Print(signature_).Println(" {");
36*d57664e9SAndroid Build Coastguard Worker   printer->Indent();
37*d57664e9SAndroid Build Coastguard Worker   for (const auto& statement : statements_) {
38*d57664e9SAndroid Build Coastguard Worker     printer->Println(statement);
39*d57664e9SAndroid Build Coastguard Worker   }
40*d57664e9SAndroid Build Coastguard Worker   printer->Undent();
41*d57664e9SAndroid Build Coastguard Worker   printer->Print("}");
42*d57664e9SAndroid Build Coastguard Worker }
43*d57664e9SAndroid Build Coastguard Worker 
AddMember(std::unique_ptr<ClassMember> member)44*d57664e9SAndroid Build Coastguard Worker ClassDefinition::Result ClassDefinition::AddMember(std::unique_ptr<ClassMember> member) {
45*d57664e9SAndroid Build Coastguard Worker   Result result = Result::kAdded;
46*d57664e9SAndroid Build Coastguard Worker   auto iter = indexed_members_.find(member->GetName());
47*d57664e9SAndroid Build Coastguard Worker   if (iter != indexed_members_.end()) {
48*d57664e9SAndroid Build Coastguard Worker     // Overwrite the entry. Be careful, as the key in indexed_members_ is actually memory owned
49*d57664e9SAndroid Build Coastguard Worker     // by the value at ordered_members_[index]. Since overwriting a value for a key doesn't replace
50*d57664e9SAndroid Build Coastguard Worker     // the key (the initial key inserted into the unordered_map is kept), we must erase and then
51*d57664e9SAndroid Build Coastguard Worker     // insert a new key, whose memory is being kept around. We do all this to avoid using more
52*d57664e9SAndroid Build Coastguard Worker     // memory for each key.
53*d57664e9SAndroid Build Coastguard Worker     size_t index = iter->second;
54*d57664e9SAndroid Build Coastguard Worker 
55*d57664e9SAndroid Build Coastguard Worker     // Erase the key + value from the map.
56*d57664e9SAndroid Build Coastguard Worker     indexed_members_.erase(iter);
57*d57664e9SAndroid Build Coastguard Worker 
58*d57664e9SAndroid Build Coastguard Worker     // Now clear the memory that was backing the key (now erased).
59*d57664e9SAndroid Build Coastguard Worker     ordered_members_[index].reset();
60*d57664e9SAndroid Build Coastguard Worker     result = Result::kOverridden;
61*d57664e9SAndroid Build Coastguard Worker   }
62*d57664e9SAndroid Build Coastguard Worker 
63*d57664e9SAndroid Build Coastguard Worker   indexed_members_[member->GetName()] = ordered_members_.size();
64*d57664e9SAndroid Build Coastguard Worker   ordered_members_.push_back(std::move(member));
65*d57664e9SAndroid Build Coastguard Worker   return result;
66*d57664e9SAndroid Build Coastguard Worker }
67*d57664e9SAndroid Build Coastguard Worker 
empty() const68*d57664e9SAndroid Build Coastguard Worker bool ClassDefinition::empty() const {
69*d57664e9SAndroid Build Coastguard Worker   for (const std::unique_ptr<ClassMember>& member : ordered_members_) {
70*d57664e9SAndroid Build Coastguard Worker     if (member != nullptr && !member->empty()) {
71*d57664e9SAndroid Build Coastguard Worker       return false;
72*d57664e9SAndroid Build Coastguard Worker     }
73*d57664e9SAndroid Build Coastguard Worker   }
74*d57664e9SAndroid Build Coastguard Worker   return true;
75*d57664e9SAndroid Build Coastguard Worker }
76*d57664e9SAndroid Build Coastguard Worker 
Print(bool final,Printer * printer,bool strip_api_annotations) const77*d57664e9SAndroid Build Coastguard Worker void ClassDefinition::Print(bool final, Printer* printer, bool strip_api_annotations) const {
78*d57664e9SAndroid Build Coastguard Worker   if (empty() && !create_if_empty_) {
79*d57664e9SAndroid Build Coastguard Worker     return;
80*d57664e9SAndroid Build Coastguard Worker   }
81*d57664e9SAndroid Build Coastguard Worker 
82*d57664e9SAndroid Build Coastguard Worker   ClassMember::Print(final,  printer, strip_api_annotations);
83*d57664e9SAndroid Build Coastguard Worker 
84*d57664e9SAndroid Build Coastguard Worker   printer->Print("public ");
85*d57664e9SAndroid Build Coastguard Worker   if (qualifier_ == ClassQualifier::kStatic) {
86*d57664e9SAndroid Build Coastguard Worker     printer->Print("static ");
87*d57664e9SAndroid Build Coastguard Worker   }
88*d57664e9SAndroid Build Coastguard Worker   printer->Print("final class ").Print(name_).Println(" {");
89*d57664e9SAndroid Build Coastguard Worker   printer->Indent();
90*d57664e9SAndroid Build Coastguard Worker 
91*d57664e9SAndroid Build Coastguard Worker   for (const std::unique_ptr<ClassMember>& member : ordered_members_) {
92*d57664e9SAndroid Build Coastguard Worker     // There can be nullptr members when a member is added to the ClassDefinition
93*d57664e9SAndroid Build Coastguard Worker     // and takes precedence over a previous member with the same name. The overridden member is
94*d57664e9SAndroid Build Coastguard Worker     // set to nullptr.
95*d57664e9SAndroid Build Coastguard Worker     if (member != nullptr) {
96*d57664e9SAndroid Build Coastguard Worker       member->Print(final, printer, strip_api_annotations);
97*d57664e9SAndroid Build Coastguard Worker       printer->Println();
98*d57664e9SAndroid Build Coastguard Worker     }
99*d57664e9SAndroid Build Coastguard Worker   }
100*d57664e9SAndroid Build Coastguard Worker 
101*d57664e9SAndroid Build Coastguard Worker   printer->Undent();
102*d57664e9SAndroid Build Coastguard Worker   printer->Print("}");
103*d57664e9SAndroid Build Coastguard Worker }
104*d57664e9SAndroid Build Coastguard Worker 
105*d57664e9SAndroid Build Coastguard Worker constexpr static const char* sWarningHeader =
106*d57664e9SAndroid Build Coastguard Worker     "/* AUTO-GENERATED FILE. DO NOT MODIFY.\n"
107*d57664e9SAndroid Build Coastguard Worker     " *\n"
108*d57664e9SAndroid Build Coastguard Worker     " * This class was automatically generated by the\n"
109*d57664e9SAndroid Build Coastguard Worker     " * aapt tool from the resource data it found. It\n"
110*d57664e9SAndroid Build Coastguard Worker     " * should not be modified by hand.\n"
111*d57664e9SAndroid Build Coastguard Worker     " */\n\n";
112*d57664e9SAndroid Build Coastguard Worker 
WriteJavaFile(const ClassDefinition * def,StringPiece package,bool final,bool strip_api_annotations,android::OutputStream * out)113*d57664e9SAndroid Build Coastguard Worker void ClassDefinition::WriteJavaFile(const ClassDefinition* def, StringPiece package, bool final,
114*d57664e9SAndroid Build Coastguard Worker                                     bool strip_api_annotations, android::OutputStream* out) {
115*d57664e9SAndroid Build Coastguard Worker   Printer printer(out);
116*d57664e9SAndroid Build Coastguard Worker   printer.Print(sWarningHeader).Print("package ").Print(package).Println(";");
117*d57664e9SAndroid Build Coastguard Worker   printer.Println();
118*d57664e9SAndroid Build Coastguard Worker   def->Print(final, &printer, strip_api_annotations);
119*d57664e9SAndroid Build Coastguard Worker }
120*d57664e9SAndroid Build Coastguard Worker 
121*d57664e9SAndroid Build Coastguard Worker }  // namespace aapt
122