Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 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 | |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 17 | #include "java/JavaClassGenerator.h" |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 18 | |
Adam Lesinski | ca2fc35 | 2015-04-03 12:08:26 -0700 | [diff] [blame] | 19 | #include <algorithm> |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 20 | #include <ostream> |
| 21 | #include <set> |
| 22 | #include <sstream> |
| 23 | #include <tuple> |
| 24 | |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 25 | #include "android-base/errors.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 26 | #include "android-base/logging.h" |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 27 | #include "android-base/stringprintf.h" |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 28 | #include "androidfw/StringPiece.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 29 | |
| 30 | #include "NameMangler.h" |
| 31 | #include "Resource.h" |
| 32 | #include "ResourceTable.h" |
| 33 | #include "ResourceValues.h" |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame] | 34 | #include "SdkConstants.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 35 | #include "ValueVisitor.h" |
| 36 | #include "java/AnnotationProcessor.h" |
| 37 | #include "java/ClassDefinition.h" |
| 38 | #include "process/SymbolTable.h" |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 39 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 40 | using ::aapt::io::OutputStream; |
| 41 | using ::aapt::text::Printer; |
| 42 | using ::android::StringPiece; |
| 43 | using ::android::base::StringPrintf; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 44 | |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 45 | namespace aapt { |
| 46 | |
Adam Lesinski | d0f116b | 2016-07-08 15:00:32 -0700 | [diff] [blame] | 47 | static const std::set<StringPiece> sJavaIdentifiers = { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 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"}; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 59 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 60 | static bool IsValidSymbol(const StringPiece& symbol) { |
| 61 | return sJavaIdentifiers.find(symbol) == sJavaIdentifiers.end(); |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 62 | } |
| 63 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 64 | // Java symbols can not contain . or -, but those are valid in a resource name. |
| 65 | // Replace those with '_'. |
Adam Koski | dc21dea | 2017-07-21 10:55:27 -0700 | [diff] [blame] | 66 | std::string JavaClassGenerator::TransformToFieldName(const StringPiece& symbol) { |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 67 | std::string output = symbol.to_string(); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 68 | for (char& c : output) { |
| 69 | if (c == '.' || c == '-') { |
| 70 | c = '_'; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 71 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 72 | } |
| 73 | return output; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 74 | } |
| 75 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 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) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 88 | std::string output = styleable_class_name; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 89 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 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) { |
Adam Koski | dc21dea | 2017-07-21 10:55:27 -0700 | [diff] [blame] | 94 | output += "_" + JavaClassGenerator::TransformToFieldName(attr_name.package); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 95 | } |
Adam Koski | dc21dea | 2017-07-21 10:55:27 -0700 | [diff] [blame] | 96 | output += "_" + JavaClassGenerator::TransformToFieldName(attr_name.entry); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 97 | return output; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 98 | } |
| 99 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 100 | static void AddAttributeFormatDoc(AnnotationProcessor* processor, Attribute* attr) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 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" |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 132 | "\"<code>#<i>argb</i></code>\", \"<code>#<i>rrggbb</i></code>\", or \n" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 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>"); |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 170 | } |
| 171 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 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()); |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 184 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 185 | processor->AppendComment("</table>"); |
| 186 | } |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 187 | } |
| 188 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 189 | JavaClassGenerator::JavaClassGenerator(IAaptContext* context, |
| 190 | ResourceTable* table, |
| 191 | const JavaClassGeneratorOptions& options) |
| 192 | : context_(context), table_(table), options_(options) {} |
| 193 | |
Adam Lesinski | 71be705 | 2017-12-12 16:48:07 -0800 | [diff] [blame] | 194 | bool JavaClassGenerator::SkipSymbol(Visibility::Level level) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 195 | switch (options_.types) { |
Adam Lesinski | 9e10ac7 | 2015-10-16 14:37:48 -0700 | [diff] [blame] | 196 | case JavaClassGeneratorOptions::SymbolTypes::kAll: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 197 | return false; |
Adam Lesinski | 9e10ac7 | 2015-10-16 14:37:48 -0700 | [diff] [blame] | 198 | case JavaClassGeneratorOptions::SymbolTypes::kPublicPrivate: |
Adam Lesinski | 71be705 | 2017-12-12 16:48:07 -0800 | [diff] [blame] | 199 | return level == Visibility::Level::kUndefined; |
Adam Lesinski | 9e10ac7 | 2015-10-16 14:37:48 -0700 | [diff] [blame] | 200 | case JavaClassGeneratorOptions::SymbolTypes::kPublic: |
Adam Lesinski | 71be705 | 2017-12-12 16:48:07 -0800 | [diff] [blame] | 201 | return level != Visibility::Level::kPublic; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 202 | } |
| 203 | return true; |
Adam Lesinski | 9e10ac7 | 2015-10-16 14:37:48 -0700 | [diff] [blame] | 204 | } |
| 205 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 206 | // Whether or not to skip writing this symbol. |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 207 | bool JavaClassGenerator::SkipSymbol(const std::optional<SymbolTable::Symbol>& symbol) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 208 | return !symbol || (options_.types == JavaClassGeneratorOptions::SymbolTypes::kPublic && |
| 209 | !symbol.value().is_public); |
| 210 | } |
| 211 | |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 212 | struct StyleableAttr { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 213 | const Reference* attr_ref = nullptr; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 214 | std::string field_name; |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 215 | std::optional<SymbolTable::Symbol> symbol; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 216 | }; |
| 217 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 218 | static bool operator<(const StyleableAttr& lhs, const StyleableAttr& rhs) { |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 219 | const ResourceId lhs_id = lhs.attr_ref->id.value_or(ResourceId(0)); |
| 220 | const ResourceId rhs_id = rhs.attr_ref->id.value_or(ResourceId(0)); |
Clark DuVall | 8f51d6b | 2020-04-22 13:19:28 -0700 | [diff] [blame] | 221 | if (lhs_id == rhs_id) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 222 | return lhs.attr_ref->name.value() < rhs.attr_ref->name.value(); |
| 223 | } |
Clark DuVall | 8f51d6b | 2020-04-22 13:19:28 -0700 | [diff] [blame] | 224 | return cmp_ids_dynamic_after_framework(lhs_id, rhs_id); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 225 | } |
| 226 | |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 227 | static FieldReference GetRFieldReference(const ResourceName& name, |
| 228 | StringPiece fallback_package_name) { |
| 229 | const std::string package_name = |
| 230 | name.package.empty() ? fallback_package_name.to_string() : name.package; |
| 231 | const std::string entry = JavaClassGenerator::TransformToFieldName(name.entry); |
Iurii Makhno | cff10ce | 2022-02-15 19:33:50 +0000 | [diff] [blame] | 232 | return FieldReference(StringPrintf("%s.R.%s.%s", package_name.c_str(), |
| 233 | name.type.to_string().data(), entry.c_str())); |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 234 | } |
| 235 | |
| 236 | bool JavaClassGenerator::ProcessStyleable(const ResourceNameRef& name, const ResourceId& id, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 237 | const Styleable& styleable, |
| 238 | const StringPiece& package_name_to_generate, |
| 239 | ClassDefinition* out_class_def, |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 240 | MethodDefinition* out_rewrite_method, |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 241 | Printer* r_txt_printer) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 242 | const std::string array_field_name = TransformToFieldName(name.entry); |
| 243 | std::unique_ptr<ResourceArrayMember> array_def = |
| 244 | util::make_unique<ResourceArrayMember>(array_field_name); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 245 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 246 | // The array must be sorted by resource ID. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 247 | std::vector<StyleableAttr> sorted_attributes; |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 248 | sorted_attributes.reserve(styleable.entries.size()); |
| 249 | for (const auto& attr : styleable.entries) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 250 | // If we are not encoding final attributes, the styleable entry may have no |
| 251 | // ID if we are building a static library. |
| 252 | CHECK(!options_.use_final || attr.id) << "no ID set for Styleable entry"; |
| 253 | CHECK(bool(attr.name)) << "no name set for Styleable entry"; |
| 254 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 255 | // We will need the unmangled, transformed name in the comments and the field, |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 256 | // so create it once and cache it in this StyleableAttr data structure. |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 257 | StyleableAttr styleable_attr; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 258 | styleable_attr.attr_ref = &attr; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 259 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 260 | // The field name for this attribute is prefixed by the name of this styleable and |
| 261 | // the package it comes from. |
| 262 | styleable_attr.field_name = |
| 263 | TransformNestedAttr(attr.name.value(), array_field_name, package_name_to_generate); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 264 | |
Ryan Mitchell | 23cc5d5 | 2018-07-12 17:16:40 -0700 | [diff] [blame] | 265 | Reference ref = attr; |
| 266 | if (attr.name.value().package.empty()) { |
| 267 | |
| 268 | // If the resource does not have a package name, set the package to the unmangled package name |
| 269 | // of the styleable declaration because attributes without package names would have been |
| 270 | // declared in the same package as the styleable. |
| 271 | ref.name = ResourceName(package_name_to_generate, ref.name.value().type, |
| 272 | ref.name.value().entry); |
| 273 | } |
| 274 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 275 | // Look up the symbol so that we can write out in the comments what are possible legal values |
| 276 | // for this attribute. |
Ryan Mitchell | 23cc5d5 | 2018-07-12 17:16:40 -0700 | [diff] [blame] | 277 | const SymbolTable::Symbol* symbol = context_->GetExternalSymbols()->FindByReference(ref); |
| 278 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 279 | if (symbol && symbol->attribute) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 280 | // Copy the symbol data structure because the returned instance can be destroyed. |
| 281 | styleable_attr.symbol = *symbol; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 282 | } |
| 283 | sorted_attributes.push_back(std::move(styleable_attr)); |
| 284 | } |
| 285 | |
| 286 | // Sort the attributes by ID. |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 287 | std::sort(sorted_attributes.begin(), sorted_attributes.end()); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 288 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 289 | // Build the JavaDoc comment for the Styleable array. This has references to child attributes |
| 290 | // and what possible values can be used for them. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 291 | const size_t attr_count = sorted_attributes.size(); |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 292 | if (out_class_def != nullptr && attr_count > 0) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 293 | std::stringstream styleable_comment; |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 294 | if (!styleable.GetComment().empty()) { |
| 295 | styleable_comment << styleable.GetComment() << "\n"; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 296 | } else { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 297 | // Apply a default intro comment if the styleable has no comments of its own. |
| 298 | styleable_comment << "Attributes that can be used with a " << array_field_name << ".\n"; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 299 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 300 | |
| 301 | styleable_comment << "<p>Includes the following attributes:</p>\n" |
| 302 | "<table>\n" |
| 303 | "<colgroup align=\"left\" />\n" |
| 304 | "<colgroup align=\"left\" />\n" |
| 305 | "<tr><th>Attribute</th><th>Description</th></tr>\n"; |
| 306 | |
Ryan Mitchell | be8607d | 2018-12-03 11:28:42 -0800 | [diff] [blame] | 307 | // Removed and hidden attributes are public but hidden from the documentation, so don't emit |
| 308 | // them as part of the class documentation. |
| 309 | std::vector<StyleableAttr> documentation_attrs = sorted_attributes; |
| 310 | auto documentation_remove_iter = std::remove_if(documentation_attrs.begin(), |
| 311 | documentation_attrs.end(), |
| 312 | [&](StyleableAttr entry) -> bool { |
Ryan Mitchell | 4e19c48 | 2019-12-06 12:20:21 -0800 | [diff] [blame] | 313 | if (SkipSymbol(entry.symbol)) { |
| 314 | return true; |
| 315 | } |
| 316 | const StringPiece attr_comment_line = entry.symbol.value().attribute->GetComment(); |
| 317 | return attr_comment_line.contains("@removed") || attr_comment_line.contains("@hide"); |
Ryan Mitchell | be8607d | 2018-12-03 11:28:42 -0800 | [diff] [blame] | 318 | }); |
| 319 | documentation_attrs.erase(documentation_remove_iter, documentation_attrs.end()); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 320 | |
Ryan Mitchell | be8607d | 2018-12-03 11:28:42 -0800 | [diff] [blame] | 321 | // Build the table of attributes with their links and names. |
| 322 | for (const StyleableAttr& entry : documentation_attrs) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 323 | const ResourceName& attr_name = entry.attr_ref->name.value(); |
Adam Lesinski | e967d3f | 2017-07-24 18:19:36 -0700 | [diff] [blame] | 324 | styleable_comment << "<tr><td><code>{@link #" << entry.field_name << " " |
| 325 | << (!attr_name.package.empty() ? attr_name.package |
Ryan Mitchell | 23cc5d5 | 2018-07-12 17:16:40 -0700 | [diff] [blame] | 326 | : package_name_to_generate) |
Adam Lesinski | e967d3f | 2017-07-24 18:19:36 -0700 | [diff] [blame] | 327 | << ":" << attr_name.entry << "}</code></td>"; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 328 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 329 | // Only use the comment up until the first '.'. This is to stay compatible with |
| 330 | // the way old AAPT did it (presumably to keep it short and to avoid including |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 331 | // annotations like @hide which would affect this Styleable). |
Ryan Mitchell | be8607d | 2018-12-03 11:28:42 -0800 | [diff] [blame] | 332 | StringPiece attr_comment_line = entry.symbol.value().attribute->GetComment(); |
Adam Lesinski | e967d3f | 2017-07-24 18:19:36 -0700 | [diff] [blame] | 333 | styleable_comment << "<td>" << AnnotationProcessor::ExtractFirstSentence(attr_comment_line) |
| 334 | << "</td></tr>\n"; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 335 | } |
| 336 | styleable_comment << "</table>\n"; |
| 337 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 338 | // Generate the @see lines for each attribute. |
Ryan Mitchell | be8607d | 2018-12-03 11:28:42 -0800 | [diff] [blame] | 339 | for (const StyleableAttr& entry : documentation_attrs) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 340 | styleable_comment << "@see #" << entry.field_name << "\n"; |
| 341 | } |
| 342 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 343 | array_def->GetCommentBuilder()->AppendComment(styleable_comment.str()); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 344 | } |
| 345 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 346 | if (r_txt_printer != nullptr) { |
| 347 | r_txt_printer->Print("int[] styleable ").Print(array_field_name).Print(" {"); |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 348 | } |
| 349 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 350 | // Add the ResourceIds to the array member. |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 351 | for (size_t i = 0; i < attr_count; i++) { |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 352 | const StyleableAttr& attr = sorted_attributes[i]; |
| 353 | std::string r_txt_contents; |
| 354 | if (attr.symbol && attr.symbol.value().is_dynamic) { |
| 355 | if (!attr.attr_ref->name) { |
| 356 | error_ = "unable to determine R.java field name of dynamic resource"; |
| 357 | return false; |
| 358 | } |
| 359 | |
| 360 | const FieldReference field_name = |
| 361 | GetRFieldReference(attr.attr_ref->name.value(), package_name_to_generate); |
| 362 | array_def->AddElement(field_name); |
| 363 | r_txt_contents = field_name.ref; |
| 364 | } else { |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 365 | const ResourceId attr_id = attr.attr_ref->id.value_or(ResourceId(0)); |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 366 | array_def->AddElement(attr_id); |
| 367 | r_txt_contents = to_string(attr_id); |
| 368 | } |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 369 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 370 | if (r_txt_printer != nullptr) { |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 371 | if (i != 0) { |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 372 | r_txt_printer->Print(","); |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 373 | } |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 374 | r_txt_printer->Print(" ").Print(r_txt_contents); |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 375 | } |
| 376 | } |
| 377 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 378 | if (r_txt_printer != nullptr) { |
| 379 | r_txt_printer->Println(" }"); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 380 | } |
| 381 | |
| 382 | // Add the Styleable array to the Styleable class. |
Todd Kennedy | 949b6253 | 2018-03-02 14:19:45 -0800 | [diff] [blame] | 383 | if (out_class_def != nullptr) { |
| 384 | out_class_def->AddMember(std::move(array_def)); |
| 385 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 386 | |
| 387 | // Now we emit the indices into the array. |
| 388 | for (size_t i = 0; i < attr_count; i++) { |
| 389 | const StyleableAttr& styleable_attr = sorted_attributes[i]; |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 390 | if (SkipSymbol(styleable_attr.symbol)) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 391 | continue; |
| 392 | } |
| 393 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 394 | if (out_class_def != nullptr) { |
| 395 | StringPiece comment = styleable_attr.attr_ref->GetComment(); |
| 396 | if (styleable_attr.symbol.value().attribute && comment.empty()) { |
| 397 | comment = styleable_attr.symbol.value().attribute->GetComment(); |
| 398 | } |
| 399 | |
| 400 | if (comment.contains("@removed")) { |
| 401 | // Removed attributes are public but hidden from the documentation, so |
| 402 | // don't emit them as part of the class documentation. |
| 403 | continue; |
| 404 | } |
| 405 | |
| 406 | const ResourceName& attr_name = styleable_attr.attr_ref->name.value(); |
| 407 | |
| 408 | StringPiece package_name = attr_name.package; |
| 409 | if (package_name.empty()) { |
Ryan Mitchell | 23cc5d5 | 2018-07-12 17:16:40 -0700 | [diff] [blame] | 410 | package_name = package_name_to_generate; |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 411 | } |
| 412 | |
| 413 | std::unique_ptr<IntMember> index_member = |
| 414 | util::make_unique<IntMember>(sorted_attributes[i].field_name, static_cast<uint32_t>(i)); |
| 415 | |
| 416 | AnnotationProcessor* attr_processor = index_member->GetCommentBuilder(); |
| 417 | |
| 418 | if (!comment.empty()) { |
| 419 | attr_processor->AppendComment("<p>\n@attr description"); |
| 420 | attr_processor->AppendComment(comment); |
| 421 | } else { |
| 422 | std::stringstream default_comment; |
| 423 | default_comment << "<p>This symbol is the offset where the " |
| 424 | << "{@link " << package_name << ".R.attr#" |
| 425 | << TransformToFieldName(attr_name.entry) << "}\n" |
| 426 | << "attribute's value can be found in the " |
| 427 | << "{@link #" << array_field_name << "} array."; |
| 428 | attr_processor->AppendComment(default_comment.str()); |
| 429 | } |
| 430 | |
| 431 | attr_processor->AppendNewLine(); |
| 432 | AddAttributeFormatDoc(attr_processor, styleable_attr.symbol.value().attribute.get()); |
| 433 | attr_processor->AppendNewLine(); |
| 434 | attr_processor->AppendComment( |
| 435 | StringPrintf("@attr name %s:%s", package_name.data(), attr_name.entry.data())); |
| 436 | |
| 437 | out_class_def->AddMember(std::move(index_member)); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 438 | } |
| 439 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 440 | if (r_txt_printer != nullptr) { |
| 441 | r_txt_printer->Println( |
| 442 | StringPrintf("int styleable %s %zd", sorted_attributes[i].field_name.c_str(), i)); |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 443 | } |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 444 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 445 | |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 446 | return true; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 447 | } |
| 448 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 449 | void JavaClassGenerator::ProcessResource(const ResourceNameRef& name, const ResourceId& id, |
| 450 | const ResourceEntry& entry, ClassDefinition* out_class_def, |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 451 | MethodDefinition* out_rewrite_method, |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 452 | text::Printer* r_txt_printer) { |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame] | 453 | ResourceId real_id = id; |
Iurii Makhno | cff10ce | 2022-02-15 19:33:50 +0000 | [diff] [blame] | 454 | if (context_->GetMinSdkVersion() < SDK_O && name.type.type == ResourceType::kId && |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame] | 455 | id.package_id() > kAppPackageId) { |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 456 | // Workaround for feature splits using package IDs > 0x7F. |
| 457 | // See b/37498913. |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame] | 458 | real_id = ResourceId(kAppPackageId, id.package_id(), id.entry_id()); |
| 459 | } |
| 460 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 461 | const std::string field_name = TransformToFieldName(name.entry); |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 462 | if (out_class_def != nullptr) { |
Ryan Mitchell | 2e9bec1 | 2021-03-22 09:31:00 -0700 | [diff] [blame] | 463 | auto resource_member = |
| 464 | util::make_unique<ResourceMember>(field_name, real_id, entry.visibility.staged_api); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 465 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 466 | // Build the comments and annotations for this entry. |
| 467 | AnnotationProcessor* processor = resource_member->GetCommentBuilder(); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 468 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 469 | // Add the comments from any <public> tags. |
Adam Lesinski | 71be705 | 2017-12-12 16:48:07 -0800 | [diff] [blame] | 470 | if (entry.visibility.level != Visibility::Level::kUndefined) { |
| 471 | processor->AppendComment(entry.visibility.comment); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 472 | } |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 473 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 474 | // Add the comments from all configurations of this entry. |
| 475 | for (const auto& config_value : entry.values) { |
| 476 | processor->AppendComment(config_value->value->GetComment()); |
| 477 | } |
| 478 | |
| 479 | // If this is an Attribute, append the format Javadoc. |
| 480 | if (!entry.values.empty()) { |
| 481 | if (Attribute* attr = ValueCast<Attribute>(entry.values.front()->value.get())) { |
| 482 | // We list out the available values for the given attribute. |
| 483 | AddAttributeFormatDoc(processor, attr); |
| 484 | } |
| 485 | } |
| 486 | |
| 487 | out_class_def->AddMember(std::move(resource_member)); |
| 488 | } |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 489 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 490 | if (r_txt_printer != nullptr) { |
| 491 | r_txt_printer->Print("int ") |
Iurii Makhno | cff10ce | 2022-02-15 19:33:50 +0000 | [diff] [blame] | 492 | .Print(name.type.to_string()) |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 493 | .Print(" ") |
| 494 | .Print(field_name) |
| 495 | .Print(" ") |
| 496 | .Println(real_id.to_string()); |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 497 | } |
| 498 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 499 | if (out_rewrite_method != nullptr) { |
Iurii Makhno | cff10ce | 2022-02-15 19:33:50 +0000 | [diff] [blame] | 500 | const std::string type_str = name.type.to_string(); |
Donald Chai | d520db5 | 2019-11-25 23:05:51 -0800 | [diff] [blame] | 501 | out_rewrite_method->AppendStatement( |
| 502 | StringPrintf("%s.%s = (%s.%s & 0x00ffffff) | packageIdBits;", type_str.data(), |
| 503 | field_name.data(), type_str.data(), field_name.data())); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 504 | } |
| 505 | } |
| 506 | |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 507 | std::optional<std::string> JavaClassGenerator::UnmangleResource( |
| 508 | const StringPiece& package_name, const StringPiece& package_name_to_generate, |
| 509 | const ResourceEntry& entry) { |
Adam Lesinski | 71be705 | 2017-12-12 16:48:07 -0800 | [diff] [blame] | 510 | if (SkipSymbol(entry.visibility.level)) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 511 | return {}; |
| 512 | } |
| 513 | |
| 514 | std::string unmangled_package; |
| 515 | std::string unmangled_name = entry.name; |
| 516 | if (NameMangler::Unmangle(&unmangled_name, &unmangled_package)) { |
| 517 | // The entry name was mangled, and we successfully unmangled it. |
| 518 | // Check that we want to emit this symbol. |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 519 | if (package_name_to_generate != unmangled_package) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 520 | // Skip the entry if it doesn't belong to the package we're writing. |
| 521 | return {}; |
| 522 | } |
| 523 | } else if (package_name_to_generate != package_name) { |
| 524 | // We are processing a mangled package name, |
| 525 | // but this is a non-mangled resource. |
| 526 | return {}; |
| 527 | } |
| 528 | return {std::move(unmangled_name)}; |
| 529 | } |
| 530 | |
| 531 | bool JavaClassGenerator::ProcessType(const StringPiece& package_name_to_generate, |
| 532 | const ResourceTablePackage& package, |
| 533 | const ResourceTableType& type, |
| 534 | ClassDefinition* out_type_class_def, |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 535 | MethodDefinition* out_rewrite_method_def, |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 536 | Printer* r_txt_printer) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 537 | for (const auto& entry : type.entries) { |
Ryan Mitchell | 4382e44 | 2021-07-14 12:53:01 -0700 | [diff] [blame] | 538 | const std::optional<std::string> unmangled_name = |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 539 | UnmangleResource(package.name, package_name_to_generate, *entry); |
| 540 | if (!unmangled_name) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 541 | continue; |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 542 | } |
Adam Lesinski | 6cbfb1d | 2016-03-31 13:33:02 -0700 | [diff] [blame] | 543 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 544 | // Create an ID if there is one (static libraries don't need one). |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 545 | ResourceId id; |
Ryan Mitchell | 9634efb | 2021-03-19 14:53:17 -0700 | [diff] [blame] | 546 | if (entry->id) { |
| 547 | id = entry->id.value(); |
Adam Lesinski | 74605cd | 2016-03-03 15:39:50 -0800 | [diff] [blame] | 548 | } |
| 549 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 550 | // We need to make sure we hide the fact that we are generating kAttrPrivate attributes. |
| 551 | const ResourceNameRef resource_name( |
| 552 | package_name_to_generate, |
| 553 | type.type == ResourceType::kAttrPrivate ? ResourceType::kAttr : type.type, |
| 554 | unmangled_name.value()); |
Adam Lesinski | b274e35 | 2015-11-06 15:14:35 -0800 | [diff] [blame] | 555 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 556 | // Check to see if the unmangled name is a valid Java name (not a keyword). |
| 557 | if (!IsValidSymbol(unmangled_name.value())) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 558 | std::stringstream err; |
| 559 | err << "invalid symbol name '" << resource_name << "'"; |
| 560 | error_ = err.str(); |
| 561 | return false; |
Adam Lesinski | 3b4cd94 | 2015-10-30 16:31:42 -0700 | [diff] [blame] | 562 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 563 | |
Iurii Makhno | cff10ce | 2022-02-15 19:33:50 +0000 | [diff] [blame] | 564 | if (resource_name.type.type == ResourceType::kStyleable) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 565 | CHECK(!entry->values.empty()); |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 566 | const auto styleable = reinterpret_cast<const Styleable*>(entry->values.front()->value.get()); |
| 567 | if (!ProcessStyleable(resource_name, id, *styleable, package_name_to_generate, |
| 568 | out_type_class_def, out_rewrite_method_def, r_txt_printer)) { |
| 569 | return false; |
| 570 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 571 | } else { |
Adam Lesinski | 418763f | 2017-04-11 17:36:53 -0700 | [diff] [blame] | 572 | ProcessResource(resource_name, id, *entry, out_type_class_def, out_rewrite_method_def, |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 573 | r_txt_printer); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 574 | } |
| 575 | } |
| 576 | return true; |
Adam Lesinski | 3b4cd94 | 2015-10-30 16:31:42 -0700 | [diff] [blame] | 577 | } |
| 578 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 579 | bool JavaClassGenerator::Generate(const StringPiece& package_name_to_generate, OutputStream* out, |
| 580 | OutputStream* out_r_txt) { |
| 581 | return Generate(package_name_to_generate, package_name_to_generate, out, out_r_txt); |
Adam Lesinski | 769de98 | 2015-04-10 19:43:55 -0700 | [diff] [blame] | 582 | } |
| 583 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 584 | static void AppendJavaDocAnnotations(const std::vector<std::string>& annotations, |
| 585 | AnnotationProcessor* processor) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 586 | for (const std::string& annotation : annotations) { |
| 587 | std::string proper_annotation = "@"; |
| 588 | proper_annotation += annotation; |
| 589 | processor->AppendComment(proper_annotation); |
| 590 | } |
Adam Lesinski | 9e10ac7 | 2015-10-16 14:37:48 -0700 | [diff] [blame] | 591 | } |
| 592 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 593 | bool JavaClassGenerator::Generate(const StringPiece& package_name_to_generate, |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 594 | const StringPiece& out_package_name, OutputStream* out, |
| 595 | OutputStream* out_r_txt) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 596 | ClassDefinition r_class("R", ClassQualifier::kNone, true); |
| 597 | std::unique_ptr<MethodDefinition> rewrite_method; |
| 598 | |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 599 | std::unique_ptr<Printer> r_txt_printer; |
| 600 | if (out_r_txt != nullptr) { |
| 601 | r_txt_printer = util::make_unique<Printer>(out_r_txt); |
| 602 | } |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 603 | // Generate an onResourcesLoaded() callback if requested. |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 604 | if (out != nullptr && options_.rewrite_callback_options) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 605 | rewrite_method = |
| 606 | util::make_unique<MethodDefinition>("public static void onResourcesLoaded(int p)"); |
Adam Lesinski | b5dc4bd | 2017-02-22 19:29:29 -0800 | [diff] [blame] | 607 | for (const std::string& package_to_callback : |
| 608 | options_.rewrite_callback_options.value().packages_to_callback) { |
| 609 | rewrite_method->AppendStatement( |
| 610 | StringPrintf("%s.R.onResourcesLoaded(p);", package_to_callback.data())); |
| 611 | } |
Donald Chai | d520db5 | 2019-11-25 23:05:51 -0800 | [diff] [blame] | 612 | rewrite_method->AppendStatement("final int packageIdBits = p << 24;"); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 613 | } |
Adam Lesinski | 3524a23 | 2016-04-01 19:19:24 -0700 | [diff] [blame] | 614 | |
Makoto Onuki | de6e6f2 | 2020-06-22 10:17:02 -0700 | [diff] [blame] | 615 | const bool is_public = (options_.types == JavaClassGeneratorOptions::SymbolTypes::kPublic); |
| 616 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 617 | for (const auto& package : table_->packages) { |
| 618 | for (const auto& type : package->types) { |
Ryan Mitchell | 326e35ff | 2021-04-12 07:50:42 -0700 | [diff] [blame] | 619 | if (type->type == ResourceType::kAttrPrivate || type->type == ResourceType::kMacro) { |
| 620 | // We generate kAttrPrivate as part of the kAttr type, so skip them here. |
| 621 | // Macros are not actual resources, so skip them as well. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 622 | continue; |
| 623 | } |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 624 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 625 | // Stay consistent with AAPT and generate an empty type class if the R class is public. |
Makoto Onuki | de6e6f2 | 2020-06-22 10:17:02 -0700 | [diff] [blame] | 626 | const bool force_creation_if_empty = is_public; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 627 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 628 | std::unique_ptr<ClassDefinition> class_def; |
| 629 | if (out != nullptr) { |
| 630 | class_def = util::make_unique<ClassDefinition>( |
| 631 | to_string(type->type), ClassQualifier::kStatic, force_creation_if_empty); |
| 632 | } |
| 633 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 634 | if (!ProcessType(package_name_to_generate, *package, *type, class_def.get(), |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 635 | rewrite_method.get(), r_txt_printer.get())) { |
Adam Lesinski | 6cbfb1d | 2016-03-31 13:33:02 -0700 | [diff] [blame] | 636 | return false; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 637 | } |
Adam Lesinski | 6cbfb1d | 2016-03-31 13:33:02 -0700 | [diff] [blame] | 638 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 639 | if (type->type == ResourceType::kAttr) { |
| 640 | // Also include private attributes in this same class. |
Ryan Mitchell | 5855de7 | 2021-02-24 14:39:13 -0800 | [diff] [blame] | 641 | if (const ResourceTableType* priv_type = package->FindType(ResourceType::kAttrPrivate)) { |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 642 | if (!ProcessType(package_name_to_generate, *package, *priv_type, class_def.get(), |
Adam Lesinski | a693c4a | 2017-11-09 11:29:39 -0800 | [diff] [blame] | 643 | rewrite_method.get(), r_txt_printer.get())) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 644 | return false; |
| 645 | } |
| 646 | } |
| 647 | } |
| 648 | |
Makoto Onuki | de6e6f2 | 2020-06-22 10:17:02 -0700 | [diff] [blame] | 649 | if (out != nullptr && type->type == ResourceType::kStyleable && is_public) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 650 | // When generating a public R class, we don't want Styleable to be part |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 651 | // of the API. It is only emitted for documentation purposes. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 652 | class_def->GetCommentBuilder()->AppendComment("@doconly"); |
| 653 | } |
| 654 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 655 | if (out != nullptr) { |
| 656 | AppendJavaDocAnnotations(options_.javadoc_annotations, class_def->GetCommentBuilder()); |
| 657 | r_class.AddMember(std::move(class_def)); |
| 658 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 659 | } |
| 660 | } |
| 661 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 662 | if (rewrite_method != nullptr) { |
| 663 | r_class.AddMember(std::move(rewrite_method)); |
| 664 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 665 | |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 666 | if (out != nullptr) { |
| 667 | AppendJavaDocAnnotations(options_.javadoc_annotations, r_class.GetCommentBuilder()); |
Makoto Onuki | de6e6f2 | 2020-06-22 10:17:02 -0700 | [diff] [blame] | 668 | ClassDefinition::WriteJavaFile(&r_class, out_package_name, options_.use_final, !is_public, out); |
Izabela Orlowska | 23a6e1e | 2017-12-05 14:52:07 +0000 | [diff] [blame] | 669 | } |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 670 | return true; |
Adam Lesinski | 6f6ceb7 | 2014-11-14 14:48:12 -0800 | [diff] [blame] | 671 | } |
| 672 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 673 | } // namespace aapt |