Home | History | Annotate | Download | only in java
      1 /*
      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 
     17 #include "java/JavaClassGenerator.h"
     18 
     19 #include <algorithm>
     20 #include <ostream>
     21 #include <set>
     22 #include <sstream>
     23 #include <tuple>
     24 
     25 #include "android-base/errors.h"
     26 #include "android-base/logging.h"
     27 #include "android-base/stringprintf.h"
     28 #include "androidfw/StringPiece.h"
     29 
     30 #include "NameMangler.h"
     31 #include "Resource.h"
     32 #include "ResourceTable.h"
     33 #include "ResourceValues.h"
     34 #include "SdkConstants.h"
     35 #include "ValueVisitor.h"
     36 #include "java/AnnotationProcessor.h"
     37 #include "java/ClassDefinition.h"
     38 #include "process/SymbolTable.h"
     39 
     40 using ::aapt::io::OutputStream;
     41 using ::aapt::text::Printer;
     42 using ::android::StringPiece;
     43 using ::android::base::StringPrintf;
     44 
     45 namespace aapt {
     46 
     47 static const std::set<StringPiece> sJavaIdentifiers = {
     48     "abstract",   "assert",       "boolean",   "break",      "byte",
     49     "case",       "catch",        "char",      "class",      "const",
     50     "continue",   "default",      "do",        "double",     "else",
     51     "enum",       "extends",      "final",     "finally",    "float",
     52     "for",        "goto",         "if",        "implements", "import",
     53     "instanceof", "int",          "interface", "long",       "native",
     54     "new",        "package",      "private",   "protected",  "public",
     55     "return",     "short",        "static",    "strictfp",   "super",
     56     "switch",     "synchronized", "this",      "throw",      "throws",
     57     "transient",  "try",          "void",      "volatile",   "while",
     58     "true",       "false",        "null"};
     59 
     60 static bool IsValidSymbol(const StringPiece& symbol) {
     61   return sJavaIdentifiers.find(symbol) == sJavaIdentifiers.end();
     62 }
     63 
     64 // Java symbols can not contain . or -, but those are valid in a resource name.
     65 // Replace those with '_'.
     66 std::string JavaClassGenerator::TransformToFieldName(const StringPiece& symbol) {
     67   std::string output = symbol.to_string();
     68   for (char& c : output) {
     69     if (c == '.' || c == '-') {
     70       c = '_';
     71     }
     72   }
     73   return output;
     74 }
     75 
     76 // Transforms an attribute in a styleable to the Java field name:
     77 //
     78 // <declare-styleable name="Foo">
     79 //   <attr name="android:bar" />
     80 //   <attr name="bar" />
     81 // </declare-styleable>
     82 //
     83 // Foo_android_bar
     84 // Foo_bar
     85 static std::string TransformNestedAttr(const ResourceNameRef& attr_name,
     86                                        const std::string& styleable_class_name,
     87                                        const StringPiece& package_name_to_generate) {
     88   std::string output = styleable_class_name;
     89 
     90   // We may reference IDs from other packages, so prefix the entry name with
     91   // the package.
     92   if (!attr_name.package.empty() &&
     93       package_name_to_generate != attr_name.package) {
     94     output += "_" + JavaClassGenerator::TransformToFieldName(attr_name.package);
     95   }
     96   output += "_" + JavaClassGenerator::TransformToFieldName(attr_name.entry);
     97   return output;
     98 }
     99 
    100 static void AddAttributeFormatDoc(AnnotationProcessor* processor, Attribute* attr) {
    101   const uint32_t type_mask = attr->type_mask;
    102   if (type_mask & android::ResTable_map::TYPE_REFERENCE) {
    103     processor->AppendComment(
    104         "<p>May be a reference to another resource, in the form\n"
    105         "\"<code>@[+][<i>package</i>:]<i>type</i>/<i>name</i></code>\" or a "
    106         "theme\n"
    107         "attribute in the form\n"
    108         "\"<code>?[<i>package</i>:]<i>type</i>/<i>name</i></code>\".");
    109   }
    110 
    111   if (type_mask & android::ResTable_map::TYPE_STRING) {
    112     processor->AppendComment(
    113         "<p>May be a string value, using '\\\\;' to escape characters such as\n"
    114         "'\\\\n' or '\\\\uxxxx' for a unicode character;");
    115   }
    116 
    117   if (type_mask & android::ResTable_map::TYPE_INTEGER) {
    118     processor->AppendComment(
    119         "<p>May be an integer value, such as \"<code>100</code>\".");
    120   }
    121 
    122   if (type_mask & android::ResTable_map::TYPE_BOOLEAN) {
    123     processor->AppendComment(
    124         "<p>May be a boolean value, such as \"<code>true</code>\" or\n"
    125         "\"<code>false</code>\".");
    126   }
    127 
    128   if (type_mask & android::ResTable_map::TYPE_COLOR) {
    129     processor->AppendComment(
    130         "<p>May be a color value, in the form of "
    131         "\"<code>#<i>rgb</i></code>\",\n"
    132         "\"<code>#<i>argb</i></code>\", \"<code>#<i>rrggbb</i></code>\", or \n"
    133         "\"<code>#<i>aarrggbb</i></code>\".");
    134   }
    135 
    136   if (type_mask & android::ResTable_map::TYPE_FLOAT) {
    137     processor->AppendComment(
    138         "<p>May be a floating point value, such as \"<code>1.2</code>\".");
    139   }
    140 
    141   if (type_mask & android::ResTable_map::TYPE_DIMENSION) {
    142     processor->AppendComment(
    143         "<p>May be a dimension value, which is a floating point number "
    144         "appended with a\n"
    145         "unit such as \"<code>14.5sp</code>\".\n"
    146         "Available units are: px (pixels), dp (density-independent pixels),\n"
    147         "sp (scaled pixels based on preferred font size), in (inches), and\n"
    148         "mm (millimeters).");
    149   }
    150 
    151   if (type_mask & android::ResTable_map::TYPE_FRACTION) {
    152     processor->AppendComment(
    153         "<p>May be a fractional value, which is a floating point number "
    154         "appended with\n"
    155         "either % or %p, such as \"<code>14.5%</code>\".\n"
    156         "The % suffix always means a percentage of the base size;\n"
    157         "the optional %p suffix provides a size relative to some parent "
    158         "container.");
    159   }
    160 
    161   if (type_mask &
    162       (android::ResTable_map::TYPE_FLAGS | android::ResTable_map::TYPE_ENUM)) {
    163     if (type_mask & android::ResTable_map::TYPE_FLAGS) {
    164       processor->AppendComment(
    165           "<p>Must be one or more (separated by '|') of the following "
    166           "constant values.</p>");
    167     } else {
    168       processor->AppendComment(
    169           "<p>Must be one of the following constant values.</p>");
    170     }
    171 
    172     processor->AppendComment(
    173         "<table>\n<colgroup align=\"left\" />\n"
    174         "<colgroup align=\"left\" />\n"
    175         "<colgroup align=\"left\" />\n"
    176         "<tr><th>Constant</th><th>Value</th><th>Description</th></tr>\n");
    177     for (const Attribute::Symbol& symbol : attr->symbols) {
    178       std::stringstream line;
    179       line << "<tr><td>" << symbol.symbol.name.value().entry << "</td>"
    180            << "<td>" << std::hex << symbol.value << std::dec << "</td>"
    181            << "<td>" << util::TrimWhitespace(symbol.symbol.GetComment())
    182            << "</td></tr>";
    183       processor->AppendComment(line.str());
    184     }
    185     processor->AppendComment("</table>");
    186   }
    187 }
    188 
    189 JavaClassGenerator::JavaClassGenerator(IAaptContext* context,
    190                                        ResourceTable* table,
    191                                        const JavaClassGeneratorOptions& options)
    192     : context_(context), table_(table), options_(options) {}
    193 
    194 bool JavaClassGenerator::SkipSymbol(Visibility::Level level) {
    195   switch (options_.types) {
    196     case JavaClassGeneratorOptions::SymbolTypes::kAll:
    197       return false;
    198     case JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate:
    199       return level == Visibility::Level::kUndefined;
    200     case JavaClassGeneratorOptions::SymbolTypes::kPublic:
    201       return level != Visibility::Level::kPublic;
    202   }
    203   return true;
    204 }
    205 
    206 // Whether or not to skip writing this symbol.
    207 bool JavaClassGenerator::SkipSymbol(const Maybe<SymbolTable::Symbol>& symbol) {
    208   return !symbol || (options_.types == JavaClassGeneratorOptions::SymbolTypes::kPublic &&
    209                      !symbol.value().is_public);
    210 }
    211 
    212 struct StyleableAttr {
    213   const Reference* attr_ref = nullptr;
    214   std::string field_name;
    215   Maybe<SymbolTable::Symbol> symbol;
    216 };
    217 
    218 static bool operator<(const StyleableAttr& lhs, const StyleableAttr& rhs) {
    219   const ResourceId lhs_id = lhs.attr_ref->id.value_or_default(ResourceId(0));
    220   const ResourceId rhs_id = rhs.attr_ref->id.value_or_default(ResourceId(0));
    221   if (lhs_id < rhs_id) {
    222     return true;
    223   } else if (lhs_id > rhs_id) {
    224     return false;
    225   } else {
    226     return lhs.attr_ref->name.value() < rhs.attr_ref->name.value();
    227   }
    228 }
    229 
    230 void JavaClassGenerator::ProcessStyleable(const ResourceNameRef& name, const ResourceId& id,
    231                                           const Styleable& styleable,
    232                                           const StringPiece& package_name_to_generate,
    233                                           ClassDefinition* out_class_def,
    234                                           MethodDefinition* out_rewrite_method,
    235                                           Printer* r_txt_printer) {
    236   const std::string array_field_name = TransformToFieldName(name.entry);
    237   std::unique_ptr<ResourceArrayMember> array_def =
    238       util::make_unique<ResourceArrayMember>(array_field_name);
    239 
    240   // The array must be sorted by resource ID.
    241   std::vector<StyleableAttr> sorted_attributes;
    242   sorted_attributes.reserve(styleable.entries.size());
    243   for (const auto& attr : styleable.entries) {
    244     // If we are not encoding final attributes, the styleable entry may have no
    245     // ID if we are building a static library.
    246     CHECK(!options_.use_final || attr.id) << "no ID set for Styleable entry";
    247     CHECK(bool(attr.name)) << "no name set for Styleable entry";
    248 
    249     // We will need the unmangled, transformed name in the comments and the field,
    250     // so create it once and cache it in this StyleableAttr data structure.
    251     StyleableAttr styleable_attr;
    252     styleable_attr.attr_ref = &attr;
    253 
    254     // The field name for this attribute is prefixed by the name of this styleable and
    255     // the package it comes from.
    256     styleable_attr.field_name =
    257         TransformNestedAttr(attr.name.value(), array_field_name, package_name_to_generate);
    258 
    259     Reference ref = attr;
    260     if (attr.name.value().package.empty()) {
    261 
    262       // If the resource does not have a package name, set the package to the unmangled package name
    263       // of the styleable declaration because attributes without package names would have been
    264       // declared in the same package as the styleable.
    265       ref.name = ResourceName(package_name_to_generate, ref.name.value().type,
    266                               ref.name.value().entry);
    267     }
    268 
    269     // Look up the symbol so that we can write out in the comments what are possible legal values
    270     // for this attribute.
    271     const SymbolTable::Symbol* symbol = context_->GetExternalSymbols()->FindByReference(ref);
    272 
    273     if (symbol && symbol->attribute) {
    274       // Copy the symbol data structure because the returned instance can be destroyed.
    275       styleable_attr.symbol = *symbol;
    276     }
    277     sorted_attributes.push_back(std::move(styleable_attr));
    278   }
    279 
    280   // Sort the attributes by ID.
    281   std::sort(sorted_attributes.begin(), sorted_attributes.end());
    282 
    283   // Build the JavaDoc comment for the Styleable array. This has references to child attributes
    284   // and what possible values can be used for them.
    285   const size_t attr_count = sorted_attributes.size();
    286   if (out_class_def != nullptr && attr_count > 0) {
    287     std::stringstream styleable_comment;
    288     if (!styleable.GetComment().empty()) {
    289       styleable_comment << styleable.GetComment() << "\n";
    290     } else {
    291       // Apply a default intro comment if the styleable has no comments of its own.
    292       styleable_comment << "Attributes that can be used with a " << array_field_name << ".\n";
    293     }
    294 
    295     styleable_comment << "<p>Includes the following attributes:</p>\n"
    296                          "<table>\n"
    297                          "<colgroup align=\"left\" />\n"
    298                          "<colgroup align=\"left\" />\n"
    299                          "<tr><th>Attribute</th><th>Description</th></tr>\n";
    300 
    301     // Removed and hidden attributes are public but hidden from the documentation, so don't emit
    302     // them as part of the class documentation.
    303     std::vector<StyleableAttr> documentation_attrs = sorted_attributes;
    304     auto documentation_remove_iter = std::remove_if(documentation_attrs.begin(),
    305                                                     documentation_attrs.end(),
    306                                                     [&](StyleableAttr entry) -> bool {
    307       StringPiece attr_comment_line = entry.symbol.value().attribute->GetComment();
    308       return SkipSymbol(entry.symbol) || attr_comment_line.contains("@removed")
    309                                       || attr_comment_line.contains("@hide");
    310     });
    311     documentation_attrs.erase(documentation_remove_iter, documentation_attrs.end());
    312 
    313     // Build the table of attributes with their links and names.
    314     for (const StyleableAttr& entry : documentation_attrs) {
    315       const ResourceName& attr_name = entry.attr_ref->name.value();
    316       styleable_comment << "<tr><td><code>{@link #" << entry.field_name << " "
    317                         << (!attr_name.package.empty() ? attr_name.package
    318                                                        : package_name_to_generate)
    319                         << ":" << attr_name.entry << "}</code></td>";
    320 
    321       // Only use the comment up until the first '.'. This is to stay compatible with
    322       // the way old AAPT did it (presumably to keep it short and to avoid including
    323       // annotations like @hide which would affect this Styleable).
    324       StringPiece attr_comment_line = entry.symbol.value().attribute->GetComment();
    325       styleable_comment << "<td>" << AnnotationProcessor::ExtractFirstSentence(attr_comment_line)
    326                         << "</td></tr>\n";
    327     }
    328     styleable_comment << "</table>\n";
    329 
    330     // Generate the @see lines for each attribute.
    331     for (const StyleableAttr& entry : documentation_attrs) {
    332       styleable_comment << "@see #" << entry.field_name << "\n";
    333     }
    334 
    335     array_def->GetCommentBuilder()->AppendComment(styleable_comment.str());
    336   }
    337 
    338   if (r_txt_printer != nullptr) {
    339     r_txt_printer->Print("int[] styleable ").Print(array_field_name).Print(" {");
    340   }
    341 
    342   // Add the ResourceIds to the array member.
    343   for (size_t i = 0; i < attr_count; i++) {
    344     const ResourceId id = sorted_attributes[i].attr_ref->id.value_or_default(ResourceId(0));
    345     array_def->AddElement(id);
    346 
    347     if (r_txt_printer != nullptr) {
    348       if (i != 0) {
    349         r_txt_printer->Print(",");
    350       }
    351       r_txt_printer->Print(" ").Print(id.to_string());
    352     }
    353   }
    354 
    355   if (r_txt_printer != nullptr) {
    356     r_txt_printer->Println(" }");
    357   }
    358 
    359   // Add the Styleable array to the Styleable class.
    360   if (out_class_def != nullptr) {
    361     out_class_def->AddMember(std::move(array_def));
    362   }
    363 
    364   // Now we emit the indices into the array.
    365   for (size_t i = 0; i < attr_count; i++) {
    366     const StyleableAttr& styleable_attr = sorted_attributes[i];
    367     if (SkipSymbol(styleable_attr.symbol)) {
    368       continue;
    369     }
    370 
    371     if (out_class_def != nullptr) {
    372       StringPiece comment = styleable_attr.attr_ref->GetComment();
    373       if (styleable_attr.symbol.value().attribute && comment.empty()) {
    374         comment = styleable_attr.symbol.value().attribute->GetComment();
    375       }
    376 
    377       if (comment.contains("@removed")) {
    378         // Removed attributes are public but hidden from the documentation, so
    379         // don't emit them as part of the class documentation.
    380         continue;
    381       }
    382 
    383       const ResourceName& attr_name = styleable_attr.attr_ref->name.value();
    384 
    385       StringPiece package_name = attr_name.package;
    386       if (package_name.empty()) {
    387         package_name = package_name_to_generate;
    388       }
    389 
    390       std::unique_ptr<IntMember> index_member =
    391           util::make_unique<IntMember>(sorted_attributes[i].field_name, static_cast<uint32_t>(i));
    392 
    393       AnnotationProcessor* attr_processor = index_member->GetCommentBuilder();
    394 
    395       if (!comment.empty()) {
    396         attr_processor->AppendComment("<p>\n@attr description");
    397         attr_processor->AppendComment(comment);
    398       } else {
    399         std::stringstream default_comment;
    400         default_comment << "<p>This symbol is the offset where the "
    401                         << "{@link " << package_name << ".R.attr#"
    402                         << TransformToFieldName(attr_name.entry) << "}\n"
    403                         << "attribute's value can be found in the "
    404                         << "{@link #" << array_field_name << "} array.";
    405         attr_processor->AppendComment(default_comment.str());
    406       }
    407 
    408       attr_processor->AppendNewLine();
    409       AddAttributeFormatDoc(attr_processor, styleable_attr.symbol.value().attribute.get());
    410       attr_processor->AppendNewLine();
    411       attr_processor->AppendComment(
    412           StringPrintf("@attr name %s:%s", package_name.data(), attr_name.entry.data()));
    413 
    414       out_class_def->AddMember(std::move(index_member));
    415     }
    416 
    417     if (r_txt_printer != nullptr) {
    418       r_txt_printer->Println(
    419           StringPrintf("int styleable %s %zd", sorted_attributes[i].field_name.c_str(), i));
    420     }
    421   }
    422 
    423   // If there is a rewrite method to generate, add the statements that rewrite package IDs
    424   // for this styleable.
    425   if (out_rewrite_method != nullptr) {
    426     out_rewrite_method->AppendStatement(
    427         StringPrintf("for (int i = 0; i < styleable.%s.length; i++) {", array_field_name.data()));
    428     out_rewrite_method->AppendStatement(
    429         StringPrintf("  if ((styleable.%s[i] & 0xff000000) == 0) {", array_field_name.data()));
    430     out_rewrite_method->AppendStatement(
    431         StringPrintf("    styleable.%s[i] = (styleable.%s[i] & 0x00ffffff) | (p << 24);",
    432                      array_field_name.data(), array_field_name.data()));
    433     out_rewrite_method->AppendStatement("  }");
    434     out_rewrite_method->AppendStatement("}");
    435   }
    436 }
    437 
    438 void JavaClassGenerator::ProcessResource(const ResourceNameRef& name, const ResourceId& id,
    439                                          const ResourceEntry& entry, ClassDefinition* out_class_def,
    440                                          MethodDefinition* out_rewrite_method,
    441                                          text::Printer* r_txt_printer) {
    442   ResourceId real_id = id;
    443   if (context_->GetMinSdkVersion() < SDK_O && name.type == ResourceType::kId &&
    444       id.package_id() > kAppPackageId) {
    445     // Workaround for feature splits using package IDs > 0x7F.
    446     // See b/37498913.
    447     real_id = ResourceId(kAppPackageId, id.package_id(), id.entry_id());
    448   }
    449 
    450   const std::string field_name = TransformToFieldName(name.entry);
    451   if (out_class_def != nullptr) {
    452     std::unique_ptr<ResourceMember> resource_member =
    453         util::make_unique<ResourceMember>(field_name, real_id);
    454 
    455     // Build the comments and annotations for this entry.
    456     AnnotationProcessor* processor = resource_member->GetCommentBuilder();
    457 
    458     // Add the comments from any <public> tags.
    459     if (entry.visibility.level != Visibility::Level::kUndefined) {
    460       processor->AppendComment(entry.visibility.comment);
    461     }
    462 
    463     // Add the comments from all configurations of this entry.
    464     for (const auto& config_value : entry.values) {
    465       processor->AppendComment(config_value->value->GetComment());
    466     }
    467 
    468     // If this is an Attribute, append the format Javadoc.
    469     if (!entry.values.empty()) {
    470       if (Attribute* attr = ValueCast<Attribute>(entry.values.front()->value.get())) {
    471         // We list out the available values for the given attribute.
    472         AddAttributeFormatDoc(processor, attr);
    473       }
    474     }
    475 
    476     out_class_def->AddMember(std::move(resource_member));
    477   }
    478 
    479   if (r_txt_printer != nullptr) {
    480     r_txt_printer->Print("int ")
    481         .Print(to_string(name.type))
    482         .Print(" ")
    483         .Print(field_name)
    484         .Print(" ")
    485         .Println(real_id.to_string());
    486   }
    487 
    488   if (out_rewrite_method != nullptr) {
    489     const StringPiece& type_str = to_string(name.type);
    490     out_rewrite_method->AppendStatement(StringPrintf("%s.%s = (%s.%s & 0x00ffffff) | (p << 24);",
    491                                                      type_str.data(), field_name.data(),
    492                                                      type_str.data(), field_name.data()));
    493   }
    494 }
    495 
    496 Maybe<std::string> JavaClassGenerator::UnmangleResource(const StringPiece& package_name,
    497                                                         const StringPiece& package_name_to_generate,
    498                                                         const ResourceEntry& entry) {
    499   if (SkipSymbol(entry.visibility.level)) {
    500     return {};
    501   }
    502 
    503   std::string unmangled_package;
    504   std::string unmangled_name = entry.name;
    505   if (NameMangler::Unmangle(&unmangled_name, &unmangled_package)) {
    506     // The entry name was mangled, and we successfully unmangled it.
    507     // Check that we want to emit this symbol.
    508     if (package_name_to_generate != unmangled_package) {
    509       // Skip the entry if it doesn't belong to the package we're writing.
    510       return {};
    511     }
    512   } else if (package_name_to_generate != package_name) {
    513     // We are processing a mangled package name,
    514     // but this is a non-mangled resource.
    515     return {};
    516   }
    517   return {std::move(unmangled_name)};
    518 }
    519 
    520 bool JavaClassGenerator::ProcessType(const StringPiece& package_name_to_generate,
    521                                      const ResourceTablePackage& package,
    522                                      const ResourceTableType& type,
    523                                      ClassDefinition* out_type_class_def,
    524                                      MethodDefinition* out_rewrite_method_def,
    525                                      Printer* r_txt_printer) {
    526   for (const auto& entry : type.entries) {
    527     const Maybe<std::string> unmangled_name =
    528         UnmangleResource(package.name, package_name_to_generate, *entry);
    529     if (!unmangled_name) {
    530       continue;
    531     }
    532 
    533     // Create an ID if there is one (static libraries don't need one).
    534     ResourceId id;
    535     if (package.id && type.id && entry->id) {
    536       id = ResourceId(package.id.value(), type.id.value(), entry->id.value());
    537     }
    538 
    539     // We need to make sure we hide the fact that we are generating kAttrPrivate attributes.
    540     const ResourceNameRef resource_name(
    541         package_name_to_generate,
    542         type.type == ResourceType::kAttrPrivate ? ResourceType::kAttr : type.type,
    543         unmangled_name.value());
    544 
    545     // Check to see if the unmangled name is a valid Java name (not a keyword).
    546     if (!IsValidSymbol(unmangled_name.value())) {
    547       std::stringstream err;
    548       err << "invalid symbol name '" << resource_name << "'";
    549       error_ = err.str();
    550       return false;
    551     }
    552 
    553     if (resource_name.type == ResourceType::kStyleable) {
    554       CHECK(!entry->values.empty());
    555 
    556       const Styleable* styleable =
    557           static_cast<const Styleable*>(entry->values.front()->value.get());
    558 
    559       ProcessStyleable(resource_name, id, *styleable, package_name_to_generate, out_type_class_def,
    560                        out_rewrite_method_def, r_txt_printer);
    561     } else {
    562       ProcessResource(resource_name, id, *entry, out_type_class_def, out_rewrite_method_def,
    563                       r_txt_printer);
    564     }
    565   }
    566   return true;
    567 }
    568 
    569 bool JavaClassGenerator::Generate(const StringPiece& package_name_to_generate, OutputStream* out,
    570                                   OutputStream* out_r_txt) {
    571   return Generate(package_name_to_generate, package_name_to_generate, out, out_r_txt);
    572 }
    573 
    574 static void AppendJavaDocAnnotations(const std::vector<std::string>& annotations,
    575                                      AnnotationProcessor* processor) {
    576   for (const std::string& annotation : annotations) {
    577     std::string proper_annotation = "@";
    578     proper_annotation += annotation;
    579     processor->AppendComment(proper_annotation);
    580   }
    581 }
    582 
    583 bool JavaClassGenerator::Generate(const StringPiece& package_name_to_generate,
    584                                   const StringPiece& out_package_name, OutputStream* out,
    585                                   OutputStream* out_r_txt) {
    586   ClassDefinition r_class("R", ClassQualifier::kNone, true);
    587   std::unique_ptr<MethodDefinition> rewrite_method;
    588 
    589   std::unique_ptr<Printer> r_txt_printer;
    590   if (out_r_txt != nullptr) {
    591     r_txt_printer = util::make_unique<Printer>(out_r_txt);
    592   }
    593   // Generate an onResourcesLoaded() callback if requested.
    594   if (out != nullptr && options_.rewrite_callback_options) {
    595     rewrite_method =
    596         util::make_unique<MethodDefinition>("public static void onResourcesLoaded(int p)");
    597     for (const std::string& package_to_callback :
    598          options_.rewrite_callback_options.value().packages_to_callback) {
    599       rewrite_method->AppendStatement(
    600           StringPrintf("%s.R.onResourcesLoaded(p);", package_to_callback.data()));
    601     }
    602   }
    603 
    604   for (const auto& package : table_->packages) {
    605     for (const auto& type : package->types) {
    606       if (type->type == ResourceType::kAttrPrivate) {
    607         // We generate these as part of the kAttr type, so skip them here.
    608         continue;
    609       }
    610 
    611       // Stay consistent with AAPT and generate an empty type class if the R class is public.
    612       const bool force_creation_if_empty =
    613           (options_.types == JavaClassGeneratorOptions::SymbolTypes::kPublic);
    614 
    615       std::unique_ptr<ClassDefinition> class_def;
    616       if (out != nullptr) {
    617         class_def = util::make_unique<ClassDefinition>(
    618             to_string(type->type), ClassQualifier::kStatic, force_creation_if_empty);
    619       }
    620 
    621       if (!ProcessType(package_name_to_generate, *package, *type, class_def.get(),
    622                        rewrite_method.get(), r_txt_printer.get())) {
    623         return false;
    624       }
    625 
    626       if (type->type == ResourceType::kAttr) {
    627         // Also include private attributes in this same class.
    628         const ResourceTableType* priv_type = package->FindType(ResourceType::kAttrPrivate);
    629         if (priv_type) {
    630           if (!ProcessType(package_name_to_generate, *package, *priv_type, class_def.get(),
    631                            rewrite_method.get(), r_txt_printer.get())) {
    632             return false;
    633           }
    634         }
    635       }
    636 
    637       if (out != nullptr && type->type == ResourceType::kStyleable &&
    638           options_.types == JavaClassGeneratorOptions::SymbolTypes::kPublic) {
    639         // When generating a public R class, we don't want Styleable to be part
    640         // of the API. It is only emitted for documentation purposes.
    641         class_def->GetCommentBuilder()->AppendComment("@doconly");
    642       }
    643 
    644       if (out != nullptr) {
    645         AppendJavaDocAnnotations(options_.javadoc_annotations, class_def->GetCommentBuilder());
    646         r_class.AddMember(std::move(class_def));
    647       }
    648     }
    649   }
    650 
    651   if (rewrite_method != nullptr) {
    652     r_class.AddMember(std::move(rewrite_method));
    653   }
    654 
    655   if (out != nullptr) {
    656     AppendJavaDocAnnotations(options_.javadoc_annotations, r_class.GetCommentBuilder());
    657     ClassDefinition::WriteJavaFile(&r_class, out_package_name, options_.use_final, out);
    658   }
    659   return true;
    660 }
    661 
    662 }  // namespace aapt
    663