Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1 | // Protocol Buffers - Google's data interchange format |
| 2 | // Copyright 2008 Google Inc. All rights reserved. |
| 3 | // https://developers.google.com/protocol-buffers/ |
| 4 | // |
| 5 | // Redistribution and use in source and binary forms, with or without |
| 6 | // modification, are permitted provided that the following conditions are |
| 7 | // met: |
| 8 | // |
| 9 | // * Redistributions of source code must retain the above copyright |
| 10 | // notice, this list of conditions and the following disclaimer. |
| 11 | // * Redistributions in binary form must reproduce the above |
| 12 | // copyright notice, this list of conditions and the following disclaimer |
| 13 | // in the documentation and/or other materials provided with the |
| 14 | // distribution. |
| 15 | // * Neither the name of Google Inc. nor the names of its |
| 16 | // contributors may be used to endorse or promote products derived from |
| 17 | // this software without specific prior written permission. |
| 18 | // |
| 19 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 23 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 24 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 25 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 26 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 27 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 28 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | |
| 31 | // Author: dweis@google.com (Daniel Weis) |
| 32 | // Based on original Protocol Buffers design by |
| 33 | // Sanjay Ghemawat, Jeff Dean, and others. |
| 34 | |
| 35 | #include <google/protobuf/compiler/java/java_message_lite.h> |
| 36 | |
| 37 | #include <algorithm> |
| 38 | #include <google/protobuf/stubs/hash.h> |
| 39 | #include <map> |
| 40 | #include <memory> |
| 41 | #ifndef _SHARED_PTR_H |
| 42 | #include <google/protobuf/stubs/shared_ptr.h> |
| 43 | #endif |
| 44 | #include <vector> |
| 45 | |
| 46 | #include <google/protobuf/compiler/java/java_context.h> |
| 47 | #include <google/protobuf/compiler/java/java_doc_comment.h> |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 48 | #include <google/protobuf/compiler/java/java_enum_lite.h> |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 49 | #include <google/protobuf/compiler/java/java_extension_lite.h> |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 50 | #include <google/protobuf/compiler/java/java_generator_factory.h> |
| 51 | #include <google/protobuf/compiler/java/java_helpers.h> |
| 52 | #include <google/protobuf/compiler/java/java_message_builder.h> |
| 53 | #include <google/protobuf/compiler/java/java_message_builder_lite.h> |
| 54 | #include <google/protobuf/compiler/java/java_name_resolver.h> |
| 55 | #include <google/protobuf/io/coded_stream.h> |
| 56 | #include <google/protobuf/io/printer.h> |
| 57 | #include <google/protobuf/descriptor.pb.h> |
| 58 | #include <google/protobuf/wire_format.h> |
| 59 | #include <google/protobuf/stubs/strutil.h> |
| 60 | #include <google/protobuf/stubs/substitute.h> |
| 61 | |
| 62 | namespace google { |
| 63 | namespace protobuf { |
| 64 | namespace compiler { |
| 65 | namespace java { |
| 66 | |
| 67 | using internal::WireFormat; |
| 68 | using internal::WireFormatLite; |
| 69 | |
| 70 | namespace { |
| 71 | bool GenerateHasBits(const Descriptor* descriptor) { |
| 72 | return SupportFieldPresence(descriptor->file()) || |
| 73 | HasRepeatedFields(descriptor); |
| 74 | } |
| 75 | |
| 76 | string MapValueImmutableClassdName(const Descriptor* descriptor, |
| 77 | ClassNameResolver* name_resolver) { |
| 78 | const FieldDescriptor* value_field = descriptor->FindFieldByName("value"); |
| 79 | GOOGLE_CHECK_EQ(FieldDescriptor::TYPE_MESSAGE, value_field->type()); |
| 80 | return name_resolver->GetImmutableClassName(value_field->message_type()); |
| 81 | } |
| 82 | } // namespace |
| 83 | |
| 84 | // =================================================================== |
| 85 | ImmutableMessageLiteGenerator::ImmutableMessageLiteGenerator( |
| 86 | const Descriptor* descriptor, Context* context) |
| 87 | : MessageGenerator(descriptor), context_(context), |
| 88 | name_resolver_(context->GetNameResolver()), |
| 89 | field_generators_(descriptor, context_) { |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 90 | GOOGLE_CHECK(!HasDescriptorMethods(descriptor->file(), context->EnforceLite())) |
| 91 | << "Generator factory error: A lite message generator is used to " |
| 92 | "generate non-lite messages."; |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | ImmutableMessageLiteGenerator::~ImmutableMessageLiteGenerator() {} |
| 96 | |
| 97 | void ImmutableMessageLiteGenerator::GenerateStaticVariables( |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 98 | io::Printer* printer, int* bytecode_estimate) { |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 99 | // Generate static members for all nested types. |
| 100 | for (int i = 0; i < descriptor_->nested_type_count(); i++) { |
| 101 | // TODO(kenton): Reuse MessageGenerator objects? |
| 102 | ImmutableMessageLiteGenerator(descriptor_->nested_type(i), context_) |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 103 | .GenerateStaticVariables(printer, bytecode_estimate); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 104 | } |
| 105 | } |
| 106 | |
| 107 | int ImmutableMessageLiteGenerator::GenerateStaticVariableInitializers( |
| 108 | io::Printer* printer) { |
| 109 | int bytecode_estimate = 0; |
| 110 | // Generate static member initializers for all nested types. |
| 111 | for (int i = 0; i < descriptor_->nested_type_count(); i++) { |
| 112 | // TODO(kenton): Reuse MessageGenerator objects? |
| 113 | bytecode_estimate += |
| 114 | ImmutableMessageLiteGenerator(descriptor_->nested_type(i), context_) |
| 115 | .GenerateStaticVariableInitializers(printer); |
| 116 | } |
| 117 | return bytecode_estimate; |
| 118 | } |
| 119 | |
| 120 | // =================================================================== |
| 121 | |
| 122 | void ImmutableMessageLiteGenerator::GenerateInterface(io::Printer* printer) { |
| 123 | if (descriptor_->extension_range_count() > 0) { |
| 124 | printer->Print( |
| 125 | "public interface $classname$OrBuilder extends \n" |
| 126 | " $extra_interfaces$\n" |
| 127 | " com.google.protobuf.GeneratedMessageLite.\n" |
| 128 | " ExtendableMessageOrBuilder<\n" |
| 129 | " $classname$, $classname$.Builder> {\n", |
| 130 | "extra_interfaces", ExtraMessageOrBuilderInterfaces(descriptor_), |
| 131 | "classname", descriptor_->name()); |
| 132 | } else { |
| 133 | printer->Print( |
| 134 | "public interface $classname$OrBuilder extends\n" |
| 135 | " $extra_interfaces$\n" |
| 136 | " com.google.protobuf.MessageLiteOrBuilder {\n", |
| 137 | "extra_interfaces", ExtraMessageOrBuilderInterfaces(descriptor_), |
| 138 | "classname", descriptor_->name()); |
| 139 | } |
| 140 | |
| 141 | printer->Indent(); |
| 142 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 143 | printer->Print("\n"); |
| 144 | field_generators_.get(descriptor_->field(i)) |
| 145 | .GenerateInterfaceMembers(printer); |
| 146 | } |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 147 | for (int i = 0; i < descriptor_->oneof_decl_count(); i++) { |
| 148 | printer->Print( |
| 149 | "\n" |
| 150 | "public $classname$.$oneof_capitalized_name$Case " |
| 151 | "get$oneof_capitalized_name$Case();\n", |
| 152 | "oneof_capitalized_name", |
| 153 | context_->GetOneofGeneratorInfo( |
| 154 | descriptor_->oneof_decl(i))->capitalized_name, |
| 155 | "classname", |
| 156 | context_->GetNameResolver()->GetImmutableClassName(descriptor_)); |
| 157 | } |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 158 | printer->Outdent(); |
| 159 | |
| 160 | printer->Print("}\n"); |
| 161 | } |
| 162 | |
| 163 | // =================================================================== |
| 164 | |
| 165 | void ImmutableMessageLiteGenerator::Generate(io::Printer* printer) { |
| 166 | bool is_own_file = |
| 167 | descriptor_->containing_type() == NULL && |
| 168 | MultipleJavaFiles(descriptor_->file(), /* immutable = */ true); |
| 169 | |
| 170 | map<string, string> variables; |
| 171 | variables["static"] = is_own_file ? " " : " static "; |
| 172 | variables["classname"] = descriptor_->name(); |
| 173 | variables["extra_interfaces"] = ExtraMessageInterfaces(descriptor_); |
| 174 | |
| 175 | WriteMessageDocComment(printer, descriptor_); |
| 176 | |
| 177 | // The builder_type stores the super type name of the nested Builder class. |
| 178 | string builder_type; |
| 179 | if (descriptor_->extension_range_count() > 0) { |
| 180 | printer->Print(variables, |
| 181 | "public $static$final class $classname$ extends\n" |
| 182 | " com.google.protobuf.GeneratedMessageLite.ExtendableMessage<\n" |
| 183 | " $classname$, $classname$.Builder> implements\n" |
| 184 | " $extra_interfaces$\n" |
| 185 | " $classname$OrBuilder {\n"); |
| 186 | builder_type = strings::Substitute( |
| 187 | "com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<$0, ?>", |
| 188 | name_resolver_->GetImmutableClassName(descriptor_)); |
| 189 | } else { |
| 190 | printer->Print(variables, |
| 191 | "public $static$final class $classname$ extends\n" |
| 192 | " com.google.protobuf.GeneratedMessageLite<\n" |
| 193 | " $classname$, $classname$.Builder> implements\n" |
| 194 | " $extra_interfaces$\n" |
| 195 | " $classname$OrBuilder {\n"); |
| 196 | |
| 197 | builder_type = "com.google.protobuf.GeneratedMessageLite.Builder"; |
| 198 | } |
| 199 | printer->Indent(); |
| 200 | |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 201 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 202 | GenerateParsingConstructor(printer); |
| 203 | |
| 204 | // Nested types |
| 205 | for (int i = 0; i < descriptor_->enum_type_count(); i++) { |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 206 | EnumLiteGenerator(descriptor_->enum_type(i), true, context_) |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 207 | .Generate(printer); |
| 208 | } |
| 209 | |
| 210 | for (int i = 0; i < descriptor_->nested_type_count(); i++) { |
| 211 | // Don't generate Java classes for map entry messages. |
| 212 | if (IsMapEntry(descriptor_->nested_type(i))) continue; |
| 213 | ImmutableMessageLiteGenerator messageGenerator( |
| 214 | descriptor_->nested_type(i), context_); |
| 215 | messageGenerator.GenerateInterface(printer); |
| 216 | messageGenerator.Generate(printer); |
| 217 | } |
| 218 | |
| 219 | if (GenerateHasBits(descriptor_)) { |
| 220 | // Integers for bit fields. |
| 221 | int totalBits = 0; |
| 222 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 223 | totalBits += field_generators_.get(descriptor_->field(i)) |
| 224 | .GetNumBitsForMessage(); |
| 225 | } |
| 226 | int totalInts = (totalBits + 31) / 32; |
| 227 | for (int i = 0; i < totalInts; i++) { |
| 228 | printer->Print("private int $bit_field_name$;\n", |
| 229 | "bit_field_name", GetBitFieldName(i)); |
| 230 | } |
| 231 | } |
| 232 | |
| 233 | // oneof |
| 234 | map<string, string> vars; |
| 235 | for (int i = 0; i < descriptor_->oneof_decl_count(); i++) { |
| 236 | vars["oneof_name"] = context_->GetOneofGeneratorInfo( |
| 237 | descriptor_->oneof_decl(i))->name; |
| 238 | vars["oneof_capitalized_name"] = context_->GetOneofGeneratorInfo( |
| 239 | descriptor_->oneof_decl(i))->capitalized_name; |
| 240 | vars["oneof_index"] = SimpleItoa(descriptor_->oneof_decl(i)->index()); |
| 241 | // oneofCase_ and oneof_ |
| 242 | printer->Print(vars, |
| 243 | "private int $oneof_name$Case_ = 0;\n" |
| 244 | "private java.lang.Object $oneof_name$_;\n"); |
| 245 | // OneofCase enum |
| 246 | printer->Print(vars, |
| 247 | "public enum $oneof_capitalized_name$Case\n" |
| 248 | " implements com.google.protobuf.Internal.EnumLite {\n"); |
| 249 | printer->Indent(); |
| 250 | for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) { |
| 251 | const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j); |
| 252 | printer->Print( |
| 253 | "$field_name$($field_number$),\n", |
| 254 | "field_name", |
| 255 | ToUpper(field->name()), |
| 256 | "field_number", |
| 257 | SimpleItoa(field->number())); |
| 258 | } |
| 259 | printer->Print( |
| 260 | "$cap_oneof_name$_NOT_SET(0);\n", |
| 261 | "cap_oneof_name", |
| 262 | ToUpper(vars["oneof_name"])); |
| 263 | printer->Print(vars, |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 264 | "private final int value;\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 265 | "private $oneof_capitalized_name$Case(int value) {\n" |
| 266 | " this.value = value;\n" |
| 267 | "}\n"); |
| 268 | printer->Print(vars, |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 269 | "/**\n" |
| 270 | " * @deprecated Use {@link #forNumber(int)} instead.\n" |
| 271 | " */\n" |
| 272 | "@java.lang.Deprecated\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 273 | "public static $oneof_capitalized_name$Case valueOf(int value) {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 274 | " return forNumber(value);\n" |
| 275 | "}\n" |
| 276 | "\n" |
| 277 | "public static $oneof_capitalized_name$Case forNumber(int value) {\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 278 | " switch (value) {\n"); |
| 279 | for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) { |
| 280 | const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j); |
| 281 | printer->Print( |
| 282 | " case $field_number$: return $field_name$;\n", |
| 283 | "field_number", |
| 284 | SimpleItoa(field->number()), |
| 285 | "field_name", |
| 286 | ToUpper(field->name())); |
| 287 | } |
| 288 | printer->Print( |
| 289 | " case 0: return $cap_oneof_name$_NOT_SET;\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 290 | " default: return null;\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 291 | " }\n" |
| 292 | "}\n" |
| 293 | "public int getNumber() {\n" |
| 294 | " return this.value;\n" |
| 295 | "}\n", |
| 296 | "cap_oneof_name", ToUpper(vars["oneof_name"])); |
| 297 | printer->Outdent(); |
| 298 | printer->Print("};\n\n"); |
| 299 | // oneofCase() |
| 300 | printer->Print(vars, |
| 301 | "public $oneof_capitalized_name$Case\n" |
| 302 | "get$oneof_capitalized_name$Case() {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 303 | " return $oneof_capitalized_name$Case.forNumber(\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 304 | " $oneof_name$Case_);\n" |
| 305 | "}\n" |
| 306 | "\n" |
| 307 | "private void clear$oneof_capitalized_name$() {\n" |
| 308 | " $oneof_name$Case_ = 0;\n" |
| 309 | " $oneof_name$_ = null;\n" |
| 310 | "}\n" |
| 311 | "\n"); |
| 312 | } |
| 313 | |
| 314 | // Fields |
| 315 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 316 | printer->Print("public static final int $constant_name$ = $number$;\n", |
| 317 | "constant_name", FieldConstantName(descriptor_->field(i)), |
| 318 | "number", SimpleItoa(descriptor_->field(i)->number())); |
| 319 | field_generators_.get(descriptor_->field(i)).GenerateMembers(printer); |
| 320 | printer->Print("\n"); |
| 321 | } |
| 322 | |
| 323 | GenerateMessageSerializationMethods(printer); |
| 324 | |
| 325 | if (HasEqualsAndHashCode(descriptor_)) { |
| 326 | GenerateEqualsAndHashCode(printer); |
| 327 | } |
| 328 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 329 | GenerateParseFromMethods(printer); |
| 330 | GenerateBuilder(printer); |
| 331 | |
| 332 | if (HasRequiredFields(descriptor_)) { |
| 333 | // Memoizes whether the protocol buffer is fully initialized (has all |
| 334 | // required fields). -1 means not yet computed. 0 means false and 1 means |
| 335 | // true. |
| 336 | printer->Print( |
| 337 | "private byte memoizedIsInitialized = -1;\n"); |
| 338 | } |
| 339 | |
| 340 | printer->Print( |
| 341 | "protected final Object dynamicMethod(\n" |
| 342 | " com.google.protobuf.GeneratedMessageLite.MethodToInvoke method,\n" |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 343 | " Object arg0, Object arg1) {\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 344 | " switch (method) {\n" |
| 345 | " case PARSE_PARTIAL_FROM: {\n" |
| 346 | " return new $classname$(" |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 347 | " (com.google.protobuf.CodedInputStream) arg0,\n" |
| 348 | " (com.google.protobuf.ExtensionRegistryLite) arg1);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 349 | " }\n" |
| 350 | " case NEW_INSTANCE: {\n" |
| 351 | " return new $classname$(\n" |
| 352 | " com.google.protobuf.Internal.EMPTY_CODED_INPUT_STREAM,\n" |
| 353 | " com.google.protobuf.ExtensionRegistryLite\n" |
| 354 | " .getEmptyRegistry());\n" |
| 355 | " }\n", |
| 356 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 357 | |
| 358 | printer->Indent(); |
| 359 | printer->Indent(); |
| 360 | |
| 361 | printer->Print( |
| 362 | "case IS_INITIALIZED: {\n"); |
| 363 | printer->Indent(); |
| 364 | GenerateDynamicMethodIsInitialized(printer); |
| 365 | printer->Outdent(); |
| 366 | |
| 367 | printer->Print( |
| 368 | "}\n" |
| 369 | "case MAKE_IMMUTABLE: {\n"); |
| 370 | |
| 371 | printer->Indent(); |
| 372 | GenerateDynamicMethodMakeImmutable(printer); |
| 373 | printer->Outdent(); |
| 374 | |
| 375 | printer->Print( |
| 376 | "}\n" |
| 377 | "case NEW_BUILDER: {\n"); |
| 378 | |
| 379 | printer->Indent(); |
| 380 | GenerateDynamicMethodNewBuilder(printer); |
| 381 | printer->Outdent(); |
| 382 | |
| 383 | printer->Print( |
| 384 | "}\n" |
| 385 | "case MERGE_FROM: {\n"); |
| 386 | |
| 387 | printer->Indent(); |
| 388 | GenerateDynamicMethodMergeFrom(printer); |
| 389 | printer->Outdent(); |
| 390 | |
| 391 | printer->Print( |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 392 | "}\n" |
| 393 | "case GET_DEFAULT_INSTANCE: {\n" |
| 394 | " return DEFAULT_INSTANCE;\n" |
| 395 | "}\n" |
| 396 | "case GET_PARSER: {\n" |
| 397 | // Generally one would use the lazy initialization holder pattern for |
| 398 | // manipulating static fields but that has exceptional cost on Android as |
| 399 | // it will generate an extra class for every message. Instead, use the |
| 400 | // double-check locking pattern which works just as well. |
| 401 | " if (PARSER == null) {" |
| 402 | " synchronized ($classname$.class) {\n" |
| 403 | " if (PARSER == null) {\n" |
| 404 | " PARSER = new DefaultInstanceBasedParser(DEFAULT_INSTANCE);\n" |
| 405 | " }\n" |
| 406 | " }\n" |
| 407 | " }\n" |
| 408 | " return PARSER;\n" |
| 409 | "}\n", |
| 410 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 411 | |
| 412 | printer->Outdent(); |
| 413 | printer->Outdent(); |
| 414 | |
| 415 | printer->Print( |
| 416 | " }\n" |
| 417 | " throw new UnsupportedOperationException();\n" |
| 418 | "}\n" |
| 419 | "\n", |
| 420 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 421 | |
| 422 | printer->Print( |
| 423 | "\n" |
| 424 | "// @@protoc_insertion_point(class_scope:$full_name$)\n", |
| 425 | "full_name", descriptor_->full_name()); |
| 426 | |
| 427 | |
| 428 | // Carefully initialize the default instance in such a way that it doesn't |
| 429 | // conflict with other initialization. |
| 430 | printer->Print( |
| 431 | "private static final $classname$ DEFAULT_INSTANCE;\n", |
| 432 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 433 | |
| 434 | printer->Print( |
| 435 | "static {\n" |
| 436 | " DEFAULT_INSTANCE = new $classname$(\n" |
| 437 | " com.google.protobuf.Internal\n" |
| 438 | " .EMPTY_CODED_INPUT_STREAM,\n" |
| 439 | " com.google.protobuf.ExtensionRegistryLite\n" |
| 440 | " .getEmptyRegistry());\n" |
| 441 | "}\n" |
| 442 | "\n", |
| 443 | "classname", descriptor_->name()); |
| 444 | printer->Print( |
| 445 | "public static $classname$ getDefaultInstance() {\n" |
| 446 | " return DEFAULT_INSTANCE;\n" |
| 447 | "}\n" |
| 448 | "\n", |
| 449 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 450 | |
| 451 | GenerateParser(printer); |
| 452 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 453 | // Extensions must be declared after the DEFAULT_INSTANCE is initialized |
| 454 | // because the DEFAULT_INSTANCE is used by the extension to lazily retrieve |
| 455 | // the outer class's FileDescriptor. |
| 456 | for (int i = 0; i < descriptor_->extension_count(); i++) { |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 457 | ImmutableExtensionLiteGenerator(descriptor_->extension(i), context_) |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 458 | .Generate(printer); |
| 459 | } |
| 460 | |
| 461 | printer->Outdent(); |
| 462 | printer->Print("}\n\n"); |
| 463 | } |
| 464 | |
| 465 | // =================================================================== |
| 466 | |
| 467 | void ImmutableMessageLiteGenerator:: |
| 468 | GenerateMessageSerializationMethods(io::Printer* printer) { |
| 469 | google::protobuf::scoped_array<const FieldDescriptor * > sorted_fields( |
| 470 | SortFieldsByNumber(descriptor_)); |
| 471 | |
| 472 | vector<const Descriptor::ExtensionRange*> sorted_extensions; |
| 473 | for (int i = 0; i < descriptor_->extension_range_count(); ++i) { |
| 474 | sorted_extensions.push_back(descriptor_->extension_range(i)); |
| 475 | } |
| 476 | std::sort(sorted_extensions.begin(), sorted_extensions.end(), |
| 477 | ExtensionRangeOrdering()); |
| 478 | |
| 479 | printer->Print( |
| 480 | "public void writeTo(com.google.protobuf.CodedOutputStream output)\n" |
| 481 | " throws java.io.IOException {\n"); |
| 482 | printer->Indent(); |
| 483 | if (HasPackedFields(descriptor_)) { |
| 484 | // writeTo(CodedOutputStream output) might be invoked without |
| 485 | // getSerializedSize() ever being called, but we need the memoized |
| 486 | // sizes in case this message has packed fields. Rather than emit checks for |
| 487 | // each packed field, just call getSerializedSize() up front. |
| 488 | // In most cases, getSerializedSize() will have already been called anyway |
| 489 | // by one of the wrapper writeTo() methods, making this call cheap. |
| 490 | printer->Print( |
| 491 | "getSerializedSize();\n"); |
| 492 | } |
| 493 | |
| 494 | if (descriptor_->extension_range_count() > 0) { |
| 495 | if (descriptor_->options().message_set_wire_format()) { |
| 496 | printer->Print( |
| 497 | "com.google.protobuf.GeneratedMessageLite\n" |
| 498 | " .ExtendableMessage<$classname$, $classname$.Builder>\n" |
| 499 | " .ExtensionWriter extensionWriter =\n" |
| 500 | " newMessageSetExtensionWriter();\n", |
| 501 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 502 | } else { |
| 503 | printer->Print( |
| 504 | "com.google.protobuf.GeneratedMessageLite\n" |
| 505 | " .ExtendableMessage<$classname$, $classname$.Builder>\n" |
| 506 | " .ExtensionWriter extensionWriter =\n" |
| 507 | " newExtensionWriter();\n", |
| 508 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 509 | } |
| 510 | } |
| 511 | |
| 512 | // Merge the fields and the extension ranges, both sorted by field number. |
| 513 | for (int i = 0, j = 0; |
| 514 | i < descriptor_->field_count() || j < sorted_extensions.size(); |
| 515 | ) { |
| 516 | if (i == descriptor_->field_count()) { |
| 517 | GenerateSerializeOneExtensionRange(printer, sorted_extensions[j++]); |
| 518 | } else if (j == sorted_extensions.size()) { |
| 519 | GenerateSerializeOneField(printer, sorted_fields[i++]); |
| 520 | } else if (sorted_fields[i]->number() < sorted_extensions[j]->start) { |
| 521 | GenerateSerializeOneField(printer, sorted_fields[i++]); |
| 522 | } else { |
| 523 | GenerateSerializeOneExtensionRange(printer, sorted_extensions[j++]); |
| 524 | } |
| 525 | } |
| 526 | |
| 527 | if (PreserveUnknownFields(descriptor_)) { |
| 528 | printer->Print( |
| 529 | "unknownFields.writeTo(output);\n"); |
| 530 | } |
| 531 | |
| 532 | printer->Outdent(); |
| 533 | printer->Print( |
| 534 | "}\n" |
| 535 | "\n" |
| 536 | "public int getSerializedSize() {\n" |
| 537 | " int size = memoizedSerializedSize;\n" |
| 538 | " if (size != -1) return size;\n" |
| 539 | "\n" |
| 540 | " size = 0;\n"); |
| 541 | printer->Indent(); |
| 542 | |
| 543 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 544 | field_generators_.get(sorted_fields[i]).GenerateSerializedSizeCode(printer); |
| 545 | } |
| 546 | |
| 547 | if (descriptor_->extension_range_count() > 0) { |
| 548 | if (descriptor_->options().message_set_wire_format()) { |
| 549 | printer->Print( |
| 550 | "size += extensionsSerializedSizeAsMessageSet();\n"); |
| 551 | } else { |
| 552 | printer->Print( |
| 553 | "size += extensionsSerializedSize();\n"); |
| 554 | } |
| 555 | } |
| 556 | |
| 557 | if (PreserveUnknownFields(descriptor_)) { |
| 558 | printer->Print( |
| 559 | "size += unknownFields.getSerializedSize();\n"); |
| 560 | } |
| 561 | |
| 562 | printer->Outdent(); |
| 563 | printer->Print( |
| 564 | " memoizedSerializedSize = size;\n" |
| 565 | " return size;\n" |
| 566 | "}\n" |
| 567 | "\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 568 | } |
| 569 | |
| 570 | void ImmutableMessageLiteGenerator:: |
| 571 | GenerateParseFromMethods(io::Printer* printer) { |
| 572 | // Note: These are separate from GenerateMessageSerializationMethods() |
| 573 | // because they need to be generated even for messages that are optimized |
| 574 | // for code size. |
| 575 | printer->Print( |
| 576 | "public static $classname$ parseFrom(\n" |
| 577 | " com.google.protobuf.ByteString data)\n" |
| 578 | " throws com.google.protobuf.InvalidProtocolBufferException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 579 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 580 | " DEFAULT_INSTANCE, data);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 581 | "}\n" |
| 582 | "public static $classname$ parseFrom(\n" |
| 583 | " com.google.protobuf.ByteString data,\n" |
| 584 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n" |
| 585 | " throws com.google.protobuf.InvalidProtocolBufferException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 586 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 587 | " DEFAULT_INSTANCE, data, extensionRegistry);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 588 | "}\n" |
| 589 | "public static $classname$ parseFrom(byte[] data)\n" |
| 590 | " throws com.google.protobuf.InvalidProtocolBufferException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 591 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 592 | " DEFAULT_INSTANCE, data);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 593 | "}\n" |
| 594 | "public static $classname$ parseFrom(\n" |
| 595 | " byte[] data,\n" |
| 596 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n" |
| 597 | " throws com.google.protobuf.InvalidProtocolBufferException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 598 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 599 | " DEFAULT_INSTANCE, data, extensionRegistry);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 600 | "}\n" |
| 601 | "public static $classname$ parseFrom(java.io.InputStream input)\n" |
| 602 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 603 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 604 | " DEFAULT_INSTANCE, input);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 605 | "}\n" |
| 606 | "public static $classname$ parseFrom(\n" |
| 607 | " java.io.InputStream input,\n" |
| 608 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n" |
| 609 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 610 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 611 | " DEFAULT_INSTANCE, input, extensionRegistry);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 612 | "}\n" |
| 613 | "public static $classname$ parseDelimitedFrom(java.io.InputStream input)\n" |
| 614 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 615 | " return parseDelimitedFrom(DEFAULT_INSTANCE, input);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 616 | "}\n" |
| 617 | "public static $classname$ parseDelimitedFrom(\n" |
| 618 | " java.io.InputStream input,\n" |
| 619 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n" |
| 620 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 621 | " return parseDelimitedFrom(DEFAULT_INSTANCE, input, extensionRegistry);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 622 | "}\n" |
| 623 | "public static $classname$ parseFrom(\n" |
| 624 | " com.google.protobuf.CodedInputStream input)\n" |
| 625 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 626 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 627 | " DEFAULT_INSTANCE, input);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 628 | "}\n" |
| 629 | "public static $classname$ parseFrom(\n" |
| 630 | " com.google.protobuf.CodedInputStream input,\n" |
| 631 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n" |
| 632 | " throws java.io.IOException {\n" |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 633 | " return com.google.protobuf.GeneratedMessageLite.parseFrom(\n" |
| 634 | " DEFAULT_INSTANCE, input, extensionRegistry);\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 635 | "}\n" |
| 636 | "\n", |
| 637 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 638 | } |
| 639 | |
| 640 | void ImmutableMessageLiteGenerator::GenerateSerializeOneField( |
| 641 | io::Printer* printer, const FieldDescriptor* field) { |
| 642 | field_generators_.get(field).GenerateSerializationCode(printer); |
| 643 | } |
| 644 | |
| 645 | void ImmutableMessageLiteGenerator::GenerateSerializeOneExtensionRange( |
| 646 | io::Printer* printer, const Descriptor::ExtensionRange* range) { |
| 647 | printer->Print( |
| 648 | "extensionWriter.writeUntil($end$, output);\n", |
| 649 | "end", SimpleItoa(range->end)); |
| 650 | } |
| 651 | |
| 652 | // =================================================================== |
| 653 | |
| 654 | void ImmutableMessageLiteGenerator::GenerateBuilder(io::Printer* printer) { |
| 655 | printer->Print( |
| 656 | "public static Builder newBuilder() {\n" |
| 657 | " return DEFAULT_INSTANCE.toBuilder();\n" |
| 658 | "}\n" |
| 659 | "public static Builder newBuilder($classname$ prototype) {\n" |
| 660 | " return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);\n" |
| 661 | "}\n" |
| 662 | "\n", |
| 663 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 664 | |
| 665 | MessageBuilderLiteGenerator builderGenerator(descriptor_, context_); |
| 666 | builderGenerator.Generate(printer); |
| 667 | } |
| 668 | |
| 669 | // =================================================================== |
| 670 | |
| 671 | void ImmutableMessageLiteGenerator::GenerateDynamicMethodIsInitialized( |
| 672 | io::Printer* printer) { |
| 673 | // Returns null for false, DEFAULT_INSTANCE for true. |
| 674 | if (!HasRequiredFields(descriptor_)) { |
| 675 | printer->Print("return DEFAULT_INSTANCE;\n"); |
| 676 | return; |
| 677 | } |
| 678 | |
| 679 | // Don't directly compare to -1 to avoid an Android x86 JIT bug. |
| 680 | printer->Print( |
| 681 | "byte isInitialized = memoizedIsInitialized;\n" |
| 682 | "if (isInitialized == 1) return DEFAULT_INSTANCE;\n" |
| 683 | "if (isInitialized == 0) return null;\n" |
| 684 | "\n" |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 685 | "boolean shouldMemoize = ((Boolean) arg0).booleanValue();\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 686 | |
| 687 | // Check that all required fields in this message are set. |
| 688 | // TODO(kenton): We can optimize this when we switch to putting all the |
| 689 | // "has" fields into a single bitfield. |
| 690 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 691 | const FieldDescriptor* field = descriptor_->field(i); |
| 692 | const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field); |
| 693 | |
| 694 | if (field->is_required()) { |
| 695 | printer->Print( |
| 696 | "if (!has$name$()) {\n" |
| 697 | " if (shouldMemoize) {\n" |
| 698 | " memoizedIsInitialized = 0;\n" |
| 699 | " }\n" |
| 700 | " return null;\n" |
| 701 | "}\n", |
| 702 | "name", info->capitalized_name); |
| 703 | } |
| 704 | } |
| 705 | |
| 706 | // Now check that all embedded messages are initialized. |
| 707 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 708 | const FieldDescriptor* field = descriptor_->field(i); |
| 709 | const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field); |
| 710 | if (GetJavaType(field) == JAVATYPE_MESSAGE && |
| 711 | HasRequiredFields(field->message_type())) { |
| 712 | switch (field->label()) { |
| 713 | case FieldDescriptor::LABEL_REQUIRED: |
| 714 | printer->Print( |
| 715 | "if (!get$name$().isInitialized()) {\n" |
| 716 | " if (shouldMemoize) {\n" |
| 717 | " memoizedIsInitialized = 0;\n" |
| 718 | " }\n" |
| 719 | " return null;\n" |
| 720 | "}\n", |
| 721 | "type", name_resolver_->GetImmutableClassName( |
| 722 | field->message_type()), |
| 723 | "name", info->capitalized_name); |
| 724 | break; |
| 725 | case FieldDescriptor::LABEL_OPTIONAL: |
| 726 | if (!SupportFieldPresence(descriptor_->file()) && |
| 727 | field->containing_oneof() != NULL) { |
| 728 | const OneofDescriptor* oneof = field->containing_oneof(); |
| 729 | const OneofGeneratorInfo* oneof_info = |
| 730 | context_->GetOneofGeneratorInfo(oneof); |
| 731 | printer->Print( |
| 732 | "if ($oneof_name$Case_ == $field_number$) {\n", |
| 733 | "oneof_name", oneof_info->name, |
| 734 | "field_number", SimpleItoa(field->number())); |
| 735 | } else { |
| 736 | printer->Print( |
| 737 | "if (has$name$()) {\n", |
| 738 | "name", info->capitalized_name); |
| 739 | } |
| 740 | printer->Print( |
| 741 | " if (!get$name$().isInitialized()) {\n" |
| 742 | " if (shouldMemoize) {\n" |
| 743 | " memoizedIsInitialized = 0;\n" |
| 744 | " }\n" |
| 745 | " return null;\n" |
| 746 | " }\n" |
| 747 | "}\n", |
| 748 | "name", info->capitalized_name); |
| 749 | break; |
| 750 | case FieldDescriptor::LABEL_REPEATED: |
| 751 | if (IsMapEntry(field->message_type())) { |
| 752 | printer->Print( |
| 753 | "for ($type$ item : get$name$().values()) {\n" |
| 754 | " if (!item.isInitialized()) {\n" |
| 755 | " if (shouldMemoize) {\n" |
| 756 | " memoizedIsInitialized = 0;\n" |
| 757 | " }\n" |
| 758 | " return null;\n" |
| 759 | " }\n" |
| 760 | "}\n", |
| 761 | "type", MapValueImmutableClassdName(field->message_type(), |
| 762 | name_resolver_), |
| 763 | "name", info->capitalized_name); |
| 764 | } else { |
| 765 | printer->Print( |
| 766 | "for (int i = 0; i < get$name$Count(); i++) {\n" |
| 767 | " if (!get$name$(i).isInitialized()) {\n" |
| 768 | " if (shouldMemoize) {\n" |
| 769 | " memoizedIsInitialized = 0;\n" |
| 770 | " }\n" |
| 771 | " return null;\n" |
| 772 | " }\n" |
| 773 | "}\n", |
| 774 | "type", name_resolver_->GetImmutableClassName( |
| 775 | field->message_type()), |
| 776 | "name", info->capitalized_name); |
| 777 | } |
| 778 | break; |
| 779 | } |
| 780 | } |
| 781 | } |
| 782 | |
| 783 | if (descriptor_->extension_range_count() > 0) { |
| 784 | printer->Print( |
| 785 | "if (!extensionsAreInitialized()) {\n" |
| 786 | " if (shouldMemoize) {\n" |
| 787 | " memoizedIsInitialized = 0;\n" |
| 788 | " }\n" |
| 789 | " return null;\n" |
| 790 | "}\n"); |
| 791 | } |
| 792 | |
| 793 | printer->Print( |
| 794 | "if (shouldMemoize) memoizedIsInitialized = 1;\n"); |
| 795 | |
| 796 | printer->Print( |
| 797 | "return DEFAULT_INSTANCE;\n" |
| 798 | "\n"); |
| 799 | } |
| 800 | |
| 801 | // =================================================================== |
| 802 | |
| 803 | void ImmutableMessageLiteGenerator::GenerateDynamicMethodMakeImmutable( |
| 804 | io::Printer* printer) { |
| 805 | // Output generation code for each field. |
| 806 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 807 | field_generators_.get(descriptor_->field(i)) |
| 808 | .GenerateDynamicMethodMakeImmutableCode(printer); |
| 809 | } |
| 810 | printer->Print( |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 811 | "return null;\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 812 | } |
| 813 | |
| 814 | // =================================================================== |
| 815 | |
| 816 | void ImmutableMessageLiteGenerator::GenerateDynamicMethodNewBuilder( |
| 817 | io::Printer* printer) { |
| 818 | printer->Print( |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 819 | "return new Builder();\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 820 | } |
| 821 | |
| 822 | // =================================================================== |
| 823 | |
| 824 | void ImmutableMessageLiteGenerator::GenerateDynamicMethodMergeFrom( |
| 825 | io::Printer* printer) { |
| 826 | printer->Print( |
| 827 | // Optimization: If other is the default instance, we know none of its |
| 828 | // fields are set so we can skip the merge. |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 829 | "if (arg0 == $classname$.getDefaultInstance()) return this;\n" |
| 830 | "$classname$ other = ($classname$) arg0;\n", |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 831 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 832 | |
| 833 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 834 | if (!descriptor_->field(i)->containing_oneof()) { |
| 835 | field_generators_.get( |
| 836 | descriptor_->field(i)).GenerateMergingCode(printer); |
| 837 | } |
| 838 | } |
| 839 | |
| 840 | // Merge oneof fields. |
| 841 | for (int i = 0; i < descriptor_->oneof_decl_count(); ++i) { |
| 842 | printer->Print( |
| 843 | "switch (other.get$oneof_capitalized_name$Case()) {\n", |
| 844 | "oneof_capitalized_name", |
| 845 | context_->GetOneofGeneratorInfo( |
| 846 | descriptor_->oneof_decl(i))->capitalized_name); |
| 847 | printer->Indent(); |
| 848 | for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) { |
| 849 | const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j); |
| 850 | printer->Print( |
| 851 | "case $field_name$: {\n", |
| 852 | "field_name", |
| 853 | ToUpper(field->name())); |
| 854 | printer->Indent(); |
| 855 | field_generators_.get(field).GenerateMergingCode(printer); |
| 856 | printer->Print( |
| 857 | "break;\n"); |
| 858 | printer->Outdent(); |
| 859 | printer->Print( |
| 860 | "}\n"); |
| 861 | } |
| 862 | printer->Print( |
| 863 | "case $cap_oneof_name$_NOT_SET: {\n" |
| 864 | " break;\n" |
| 865 | "}\n", |
| 866 | "cap_oneof_name", |
| 867 | ToUpper(context_->GetOneofGeneratorInfo( |
| 868 | descriptor_->oneof_decl(i))->name)); |
| 869 | printer->Outdent(); |
| 870 | printer->Print( |
| 871 | "}\n"); |
| 872 | } |
| 873 | |
| 874 | // if message type has extensions |
| 875 | if (descriptor_->extension_range_count() > 0) { |
| 876 | printer->Print( |
| 877 | "this.mergeExtensionFields(other);\n"); |
| 878 | } |
| 879 | |
| 880 | if (PreserveUnknownFields(descriptor_)) { |
| 881 | printer->Print( |
| 882 | "this.mergeUnknownFields(other.unknownFields);\n"); |
| 883 | } |
| 884 | |
| 885 | printer->Print( |
| 886 | "return this;\n"); |
| 887 | } |
| 888 | |
| 889 | // =================================================================== |
| 890 | |
| 891 | namespace { |
| 892 | bool CheckHasBitsForEqualsAndHashCode(const FieldDescriptor* field) { |
| 893 | if (field->is_repeated()) { |
| 894 | return false; |
| 895 | } |
| 896 | if (SupportFieldPresence(field->file())) { |
| 897 | return true; |
| 898 | } |
| 899 | return GetJavaType(field) == JAVATYPE_MESSAGE && |
| 900 | field->containing_oneof() == NULL; |
| 901 | } |
| 902 | } // namespace |
| 903 | |
| 904 | void ImmutableMessageLiteGenerator:: |
| 905 | GenerateEqualsAndHashCode(io::Printer* printer) { |
| 906 | printer->Print( |
| 907 | "@java.lang.Override\n" |
| 908 | "public boolean equals(final java.lang.Object obj) {\n"); |
| 909 | printer->Indent(); |
| 910 | printer->Print( |
| 911 | "if (obj == this) {\n" |
| 912 | " return true;\n" |
| 913 | "}\n" |
| 914 | "if (!(obj instanceof $classname$)) {\n" |
| 915 | " return super.equals(obj);\n" |
| 916 | "}\n" |
| 917 | "$classname$ other = ($classname$) obj;\n" |
| 918 | "\n", |
| 919 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 920 | |
| 921 | printer->Print("boolean result = true;\n"); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 922 | // Compare non-oneofs. |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 923 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 924 | const FieldDescriptor* field = descriptor_->field(i); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 925 | if (field->containing_oneof() == NULL) { |
| 926 | const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field); |
| 927 | bool check_has_bits = CheckHasBitsForEqualsAndHashCode(field); |
| 928 | if (check_has_bits) { |
| 929 | printer->Print( |
| 930 | "result = result && (has$name$() == other.has$name$());\n" |
| 931 | "if (has$name$()) {\n", |
| 932 | "name", info->capitalized_name); |
| 933 | printer->Indent(); |
| 934 | } |
| 935 | field_generators_.get(field).GenerateEqualsCode(printer); |
| 936 | if (check_has_bits) { |
| 937 | printer->Outdent(); |
| 938 | printer->Print( |
| 939 | "}\n"); |
| 940 | } |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 941 | } |
| 942 | } |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 943 | |
| 944 | // Compare oneofs. |
| 945 | for (int i = 0; i < descriptor_->oneof_decl_count(); i++) { |
| 946 | printer->Print( |
| 947 | "result = result && get$oneof_capitalized_name$Case().equals(\n" |
| 948 | " other.get$oneof_capitalized_name$Case());\n", |
| 949 | "oneof_capitalized_name", |
| 950 | context_->GetOneofGeneratorInfo( |
| 951 | descriptor_->oneof_decl(i))->capitalized_name); |
| 952 | printer->Print( |
| 953 | "if (!result) return false;\n" |
| 954 | "switch ($oneof_name$Case_) {\n", |
| 955 | "oneof_name", |
| 956 | context_->GetOneofGeneratorInfo( |
| 957 | descriptor_->oneof_decl(i))->name); |
| 958 | printer->Indent(); |
| 959 | for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) { |
| 960 | const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j); |
| 961 | printer->Print( |
| 962 | "case $field_number$:\n", |
| 963 | "field_number", |
| 964 | SimpleItoa(field->number())); |
| 965 | printer->Indent(); |
| 966 | field_generators_.get(field).GenerateEqualsCode(printer); |
| 967 | printer->Print("break;\n"); |
| 968 | printer->Outdent(); |
| 969 | } |
| 970 | printer->Print( |
| 971 | "case 0:\n" |
| 972 | "default:\n"); |
| 973 | printer->Outdent(); |
| 974 | printer->Print("}\n"); |
| 975 | } |
| 976 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 977 | if (PreserveUnknownFields(descriptor_)) { |
| 978 | // Always consider unknown fields for equality. This will sometimes return |
| 979 | // false for non-canonical ordering when running in LITE_RUNTIME but it's |
| 980 | // the best we can do. |
| 981 | printer->Print( |
| 982 | "result = result && unknownFields.equals(other.unknownFields);\n"); |
| 983 | } |
| 984 | printer->Print( |
| 985 | "return result;\n"); |
| 986 | printer->Outdent(); |
| 987 | printer->Print( |
| 988 | "}\n" |
| 989 | "\n"); |
| 990 | |
| 991 | printer->Print( |
| 992 | "@java.lang.Override\n" |
| 993 | "public int hashCode() {\n"); |
| 994 | printer->Indent(); |
| 995 | printer->Print( |
| 996 | "if (memoizedHashCode != 0) {\n"); |
| 997 | printer->Indent(); |
| 998 | printer->Print( |
| 999 | "return memoizedHashCode;\n"); |
| 1000 | printer->Outdent(); |
| 1001 | printer->Print( |
| 1002 | "}\n" |
| 1003 | "int hash = 41;\n"); |
| 1004 | |
| 1005 | // Include the hash of the class so that two objects with different types |
| 1006 | // but the same field values will probably have different hashes. |
| 1007 | printer->Print("hash = (19 * hash) + $classname$.class.hashCode();\n", |
| 1008 | "classname", name_resolver_->GetImmutableClassName(descriptor_)); |
| 1009 | |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1010 | // hashCode non-oneofs. |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1011 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 1012 | const FieldDescriptor* field = descriptor_->field(i); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1013 | if (field->containing_oneof() == NULL) { |
| 1014 | const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field); |
| 1015 | bool check_has_bits = CheckHasBitsForEqualsAndHashCode(field); |
| 1016 | if (check_has_bits) { |
| 1017 | printer->Print( |
| 1018 | "if (has$name$()) {\n", |
| 1019 | "name", info->capitalized_name); |
| 1020 | printer->Indent(); |
| 1021 | } |
| 1022 | field_generators_.get(field).GenerateHashCode(printer); |
| 1023 | if (check_has_bits) { |
| 1024 | printer->Outdent(); |
| 1025 | printer->Print("}\n"); |
| 1026 | } |
| 1027 | } |
| 1028 | } |
| 1029 | |
| 1030 | // hashCode oneofs. |
| 1031 | for (int i = 0; i < descriptor_->oneof_decl_count(); i++) { |
| 1032 | printer->Print( |
| 1033 | "switch ($oneof_name$Case_) {\n", |
| 1034 | "oneof_name", |
| 1035 | context_->GetOneofGeneratorInfo( |
| 1036 | descriptor_->oneof_decl(i))->name); |
| 1037 | printer->Indent(); |
| 1038 | for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) { |
| 1039 | const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1040 | printer->Print( |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1041 | "case $field_number$:\n", |
| 1042 | "field_number", |
| 1043 | SimpleItoa(field->number())); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1044 | printer->Indent(); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1045 | field_generators_.get(field).GenerateHashCode(printer); |
| 1046 | printer->Print("break;\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1047 | printer->Outdent(); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1048 | } |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1049 | printer->Print( |
| 1050 | "case 0:\n" |
| 1051 | "default:\n"); |
| 1052 | printer->Outdent(); |
| 1053 | printer->Print("}\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1054 | } |
| 1055 | |
| 1056 | printer->Print( |
| 1057 | "hash = (29 * hash) + unknownFields.hashCode();\n"); |
| 1058 | printer->Print( |
| 1059 | "memoizedHashCode = hash;\n" |
| 1060 | "return hash;\n"); |
| 1061 | printer->Outdent(); |
| 1062 | printer->Print( |
| 1063 | "}\n" |
| 1064 | "\n"); |
| 1065 | } |
| 1066 | |
| 1067 | // =================================================================== |
| 1068 | |
| 1069 | void ImmutableMessageLiteGenerator:: |
| 1070 | GenerateExtensionRegistrationCode(io::Printer* printer) { |
| 1071 | for (int i = 0; i < descriptor_->extension_count(); i++) { |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 1072 | ImmutableExtensionLiteGenerator(descriptor_->extension(i), context_) |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1073 | .GenerateRegistrationCode(printer); |
| 1074 | } |
| 1075 | |
| 1076 | for (int i = 0; i < descriptor_->nested_type_count(); i++) { |
| 1077 | ImmutableMessageLiteGenerator(descriptor_->nested_type(i), context_) |
| 1078 | .GenerateExtensionRegistrationCode(printer); |
| 1079 | } |
| 1080 | } |
| 1081 | |
| 1082 | // =================================================================== |
| 1083 | void ImmutableMessageLiteGenerator:: |
| 1084 | GenerateParsingConstructor(io::Printer* printer) { |
| 1085 | google::protobuf::scoped_array<const FieldDescriptor * > sorted_fields( |
| 1086 | SortFieldsByNumber(descriptor_)); |
| 1087 | |
| 1088 | printer->Print( |
| 1089 | "private $classname$(\n" |
| 1090 | " com.google.protobuf.CodedInputStream input,\n" |
| 1091 | " com.google.protobuf.ExtensionRegistryLite extensionRegistry) {\n", |
| 1092 | "classname", descriptor_->name()); |
| 1093 | printer->Indent(); |
| 1094 | |
| 1095 | // Initialize all fields to default. |
| 1096 | GenerateInitializers(printer); |
| 1097 | |
| 1098 | // Use builder bits to track mutable repeated fields. |
| 1099 | int totalBuilderBits = 0; |
| 1100 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 1101 | const ImmutableFieldLiteGenerator& field = |
| 1102 | field_generators_.get(descriptor_->field(i)); |
| 1103 | totalBuilderBits += field.GetNumBitsForBuilder(); |
| 1104 | } |
| 1105 | int totalBuilderInts = (totalBuilderBits + 31) / 32; |
| 1106 | for (int i = 0; i < totalBuilderInts; i++) { |
| 1107 | printer->Print("int mutable_$bit_field_name$ = 0;\n", |
| 1108 | "bit_field_name", GetBitFieldName(i)); |
| 1109 | } |
| 1110 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1111 | printer->Print( |
| 1112 | "try {\n"); |
| 1113 | printer->Indent(); |
| 1114 | |
| 1115 | printer->Print( |
| 1116 | "boolean done = false;\n" |
| 1117 | "while (!done) {\n"); |
| 1118 | printer->Indent(); |
| 1119 | |
| 1120 | printer->Print( |
| 1121 | "int tag = input.readTag();\n" |
| 1122 | "switch (tag) {\n"); |
| 1123 | printer->Indent(); |
| 1124 | |
| 1125 | printer->Print( |
| 1126 | "case 0:\n" // zero signals EOF / limit reached |
| 1127 | " done = true;\n" |
| 1128 | " break;\n"); |
| 1129 | |
| 1130 | if (PreserveUnknownFields(descriptor_)) { |
| 1131 | if (descriptor_->extension_range_count() > 0) { |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1132 | printer->Print( |
| 1133 | "default: {\n" |
Jisi Liu | 46e8ff6 | 2015-10-05 11:59:43 -0700 | [diff] [blame] | 1134 | " if (!parseUnknownField(getDefaultInstanceForType(),\n" |
| 1135 | " input, extensionRegistry, tag)) {\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1136 | " done = true;\n" // it's an endgroup tag |
| 1137 | " }\n" |
| 1138 | " break;\n" |
| 1139 | "}\n"); |
| 1140 | } else { |
| 1141 | printer->Print( |
| 1142 | "default: {\n" |
Jisi Liu | 46e8ff6 | 2015-10-05 11:59:43 -0700 | [diff] [blame] | 1143 | " if (!parseUnknownField(tag, input)) {\n" |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1144 | " done = true;\n" // it's an endgroup tag |
| 1145 | " }\n" |
| 1146 | " break;\n" |
| 1147 | "}\n"); |
| 1148 | } |
| 1149 | } else { |
| 1150 | printer->Print( |
| 1151 | "default: {\n" |
| 1152 | " if (!input.skipField(tag)) {\n" |
| 1153 | " done = true;\n" // it's an endgroup tag |
| 1154 | " }\n" |
| 1155 | " break;\n" |
| 1156 | "}\n"); |
| 1157 | } |
| 1158 | |
| 1159 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 1160 | const FieldDescriptor* field = sorted_fields[i]; |
| 1161 | uint32 tag = WireFormatLite::MakeTag(field->number(), |
| 1162 | WireFormat::WireTypeForFieldType(field->type())); |
| 1163 | |
| 1164 | printer->Print( |
| 1165 | "case $tag$: {\n", |
| 1166 | "tag", SimpleItoa(tag)); |
| 1167 | printer->Indent(); |
| 1168 | |
| 1169 | field_generators_.get(field).GenerateParsingCode(printer); |
| 1170 | |
| 1171 | printer->Outdent(); |
| 1172 | printer->Print( |
| 1173 | " break;\n" |
| 1174 | "}\n"); |
| 1175 | |
| 1176 | if (field->is_packable()) { |
| 1177 | // To make packed = true wire compatible, we generate parsing code from a |
| 1178 | // packed version of this field regardless of field->options().packed(). |
| 1179 | uint32 packed_tag = WireFormatLite::MakeTag(field->number(), |
| 1180 | WireFormatLite::WIRETYPE_LENGTH_DELIMITED); |
| 1181 | printer->Print( |
| 1182 | "case $tag$: {\n", |
| 1183 | "tag", SimpleItoa(packed_tag)); |
| 1184 | printer->Indent(); |
| 1185 | |
| 1186 | field_generators_.get(field).GenerateParsingCodeFromPacked(printer); |
| 1187 | |
| 1188 | printer->Outdent(); |
| 1189 | printer->Print( |
| 1190 | " break;\n" |
| 1191 | "}\n"); |
| 1192 | } |
| 1193 | } |
| 1194 | |
| 1195 | printer->Outdent(); |
| 1196 | printer->Outdent(); |
| 1197 | printer->Print( |
| 1198 | " }\n" // switch (tag) |
| 1199 | "}\n"); // while (!done) |
| 1200 | |
| 1201 | printer->Outdent(); |
| 1202 | printer->Print( |
| 1203 | "} catch (com.google.protobuf.InvalidProtocolBufferException e) {\n" |
| 1204 | " throw new RuntimeException(e.setUnfinishedMessage(this));\n" |
| 1205 | "} catch (java.io.IOException e) {\n" |
| 1206 | " throw new RuntimeException(\n" |
| 1207 | " new com.google.protobuf.InvalidProtocolBufferException(\n" |
| 1208 | " e.getMessage()).setUnfinishedMessage(this));\n" |
| 1209 | "} finally {\n"); |
| 1210 | printer->Indent(); |
| 1211 | |
| 1212 | // Make repeated field list immutable. |
| 1213 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 1214 | const FieldDescriptor* field = sorted_fields[i]; |
| 1215 | field_generators_.get(field).GenerateParsingDoneCode(printer); |
| 1216 | } |
| 1217 | |
Jisi Liu | 46e8ff6 | 2015-10-05 11:59:43 -0700 | [diff] [blame] | 1218 | printer->Print( |
| 1219 | "doneParsing();\n"); |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1220 | |
| 1221 | printer->Outdent(); |
| 1222 | printer->Outdent(); |
| 1223 | printer->Print( |
| 1224 | " }\n" // finally |
| 1225 | "}\n"); |
| 1226 | } |
| 1227 | |
| 1228 | // =================================================================== |
| 1229 | void ImmutableMessageLiteGenerator::GenerateParser(io::Printer* printer) { |
| 1230 | printer->Print( |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 1231 | "private static volatile com.google.protobuf.Parser<$classname$> PARSER;\n" |
| 1232 | "\n" |
| 1233 | "public static com.google.protobuf.Parser<$classname$> parser() {\n" |
| 1234 | " return DEFAULT_INSTANCE.getParserForType();\n" |
| 1235 | "}\n", |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1236 | "classname", descriptor_->name()); |
| 1237 | } |
| 1238 | |
| 1239 | // =================================================================== |
| 1240 | void ImmutableMessageLiteGenerator::GenerateInitializers(io::Printer* printer) { |
| 1241 | for (int i = 0; i < descriptor_->field_count(); i++) { |
| 1242 | if (!descriptor_->field(i)->containing_oneof()) { |
| 1243 | field_generators_.get(descriptor_->field(i)) |
| 1244 | .GenerateInitializationCode(printer); |
| 1245 | } |
| 1246 | } |
| 1247 | } |
| 1248 | |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 1249 | } // namespace java |
| 1250 | } // namespace compiler |
| 1251 | } // namespace protobuf |
| 1252 | } // namespace google |