java_message_builder.cc 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  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. // Author: dweis@google.com (Daniel Weis)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #include <google/protobuf/compiler/java/java_message_builder.h>
  34. #include <algorithm>
  35. #include <google/protobuf/stubs/hash.h>
  36. #include <map>
  37. #include <memory>
  38. #include <vector>
  39. #include <google/protobuf/compiler/java/java_context.h>
  40. #include <google/protobuf/compiler/java/java_doc_comment.h>
  41. #include <google/protobuf/compiler/java/java_enum.h>
  42. #include <google/protobuf/compiler/java/java_extension.h>
  43. #include <google/protobuf/compiler/java/java_generator_factory.h>
  44. #include <google/protobuf/compiler/java/java_helpers.h>
  45. #include <google/protobuf/compiler/java/java_name_resolver.h>
  46. #include <google/protobuf/descriptor.pb.h>
  47. #include <google/protobuf/io/coded_stream.h>
  48. #include <google/protobuf/io/printer.h>
  49. #include <google/protobuf/wire_format.h>
  50. #include <google/protobuf/stubs/substitute.h>
  51. #include <google/protobuf/stubs/strutil.h>
  52. namespace google {
  53. namespace protobuf {
  54. namespace compiler {
  55. namespace java {
  56. namespace {
  57. bool GenerateHasBits(const Descriptor* descriptor) {
  58. return SupportFieldPresence(descriptor->file()) ||
  59. HasRepeatedFields(descriptor);
  60. }
  61. string MapValueImmutableClassdName(const Descriptor* descriptor,
  62. ClassNameResolver* name_resolver) {
  63. const FieldDescriptor* value_field = descriptor->FindFieldByName("value");
  64. GOOGLE_CHECK_EQ(FieldDescriptor::TYPE_MESSAGE, value_field->type());
  65. return name_resolver->GetImmutableClassName(value_field->message_type());
  66. }
  67. } // namespace
  68. MessageBuilderGenerator::MessageBuilderGenerator(
  69. const Descriptor* descriptor, Context* context)
  70. : descriptor_(descriptor), context_(context),
  71. name_resolver_(context->GetNameResolver()),
  72. field_generators_(descriptor, context_) {
  73. GOOGLE_CHECK(HasDescriptorMethods(descriptor->file(), context->EnforceLite()))
  74. << "Generator factory error: A non-lite message generator is used to "
  75. "generate lite messages.";
  76. }
  77. MessageBuilderGenerator::~MessageBuilderGenerator() {}
  78. void MessageBuilderGenerator::
  79. Generate(io::Printer* printer) {
  80. WriteMessageDocComment(printer, descriptor_);
  81. if (descriptor_->extension_range_count() > 0) {
  82. printer->Print(
  83. "public static final class Builder extends\n"
  84. " com.google.protobuf.GeneratedMessage$ver$.ExtendableBuilder<\n"
  85. " $classname$, Builder> implements\n"
  86. " $extra_interfaces$\n"
  87. " $classname$OrBuilder {\n",
  88. "classname", name_resolver_->GetImmutableClassName(descriptor_),
  89. "extra_interfaces", ExtraBuilderInterfaces(descriptor_),
  90. "ver", GeneratedCodeVersionSuffix());
  91. } else {
  92. printer->Print(
  93. "public static final class Builder extends\n"
  94. " com.google.protobuf.GeneratedMessage$ver$.Builder<Builder> implements\n"
  95. " $extra_interfaces$\n"
  96. " $classname$OrBuilder {\n",
  97. "classname", name_resolver_->GetImmutableClassName(descriptor_),
  98. "extra_interfaces", ExtraBuilderInterfaces(descriptor_),
  99. "ver", GeneratedCodeVersionSuffix());
  100. }
  101. printer->Indent();
  102. GenerateDescriptorMethods(printer);
  103. GenerateCommonBuilderMethods(printer);
  104. if (context_->HasGeneratedMethods(descriptor_)) {
  105. GenerateIsInitialized(printer);
  106. GenerateBuilderParsingMethods(printer);
  107. }
  108. // oneof
  109. std::map<string, string> vars;
  110. for (int i = 0; i < descriptor_->oneof_decl_count(); i++) {
  111. vars["oneof_name"] = context_->GetOneofGeneratorInfo(
  112. descriptor_->oneof_decl(i))->name;
  113. vars["oneof_capitalized_name"] = context_->GetOneofGeneratorInfo(
  114. descriptor_->oneof_decl(i))->capitalized_name;
  115. vars["oneof_index"] = SimpleItoa(descriptor_->oneof_decl(i)->index());
  116. // oneofCase_ and oneof_
  117. printer->Print(vars,
  118. "private int $oneof_name$Case_ = 0;\n"
  119. "private java.lang.Object $oneof_name$_;\n");
  120. // oneofCase() and clearOneof()
  121. printer->Print(vars,
  122. "public $oneof_capitalized_name$Case\n"
  123. " get$oneof_capitalized_name$Case() {\n"
  124. " return $oneof_capitalized_name$Case.forNumber(\n"
  125. " $oneof_name$Case_);\n"
  126. "}\n"
  127. "\n"
  128. "public Builder clear$oneof_capitalized_name$() {\n"
  129. " $oneof_name$Case_ = 0;\n"
  130. " $oneof_name$_ = null;\n");
  131. printer->Print(" onChanged();\n");
  132. printer->Print(
  133. " return this;\n"
  134. "}\n"
  135. "\n");
  136. }
  137. if (GenerateHasBits(descriptor_)) {
  138. // Integers for bit fields.
  139. int totalBits = 0;
  140. for (int i = 0; i < descriptor_->field_count(); i++) {
  141. totalBits += field_generators_.get(descriptor_->field(i))
  142. .GetNumBitsForBuilder();
  143. }
  144. int totalInts = (totalBits + 31) / 32;
  145. for (int i = 0; i < totalInts; i++) {
  146. printer->Print("private int $bit_field_name$;\n",
  147. "bit_field_name", GetBitFieldName(i));
  148. }
  149. }
  150. for (int i = 0; i < descriptor_->field_count(); i++) {
  151. printer->Print("\n");
  152. field_generators_.get(descriptor_->field(i))
  153. .GenerateBuilderMembers(printer);
  154. }
  155. bool is_proto3 =
  156. descriptor_->file()->syntax() == FileDescriptor::SYNTAX_PROTO3;
  157. // Override methods declared in GeneratedMessage to return the concrete
  158. // generated type so callsites won't depend on GeneratedMessage. This
  159. // is needed to keep binary compatibility when we change generated code
  160. // to subclass a different GeneratedMessage class (e.g., in v3.0.0 release
  161. // we changed all generated code to subclass GeneratedMessageV3).
  162. printer->Print(
  163. "@java.lang.Override\n"
  164. "public final Builder setUnknownFields(\n"
  165. " final com.google.protobuf.UnknownFieldSet unknownFields) {\n"
  166. " return super.setUnknownFields$suffix$(unknownFields);\n"
  167. "}\n"
  168. "\n"
  169. "@java.lang.Override\n"
  170. "public final Builder mergeUnknownFields(\n"
  171. " final com.google.protobuf.UnknownFieldSet unknownFields) {\n"
  172. " return super.mergeUnknownFields(unknownFields);\n"
  173. "}\n"
  174. "\n",
  175. "suffix", is_proto3 ? "Proto3" : "");
  176. printer->Print(
  177. "\n"
  178. "// @@protoc_insertion_point(builder_scope:$full_name$)\n",
  179. "full_name", descriptor_->full_name());
  180. printer->Outdent();
  181. printer->Print("}\n");
  182. }
  183. // ===================================================================
  184. void MessageBuilderGenerator::
  185. GenerateDescriptorMethods(io::Printer* printer) {
  186. if (!descriptor_->options().no_standard_descriptor_accessor()) {
  187. printer->Print(
  188. "public static final com.google.protobuf.Descriptors.Descriptor\n"
  189. " getDescriptor() {\n"
  190. " return $fileclass$.internal_$identifier$_descriptor;\n"
  191. "}\n"
  192. "\n",
  193. "fileclass", name_resolver_->GetImmutableClassName(descriptor_->file()),
  194. "identifier", UniqueFileScopeIdentifier(descriptor_));
  195. }
  196. std::vector<const FieldDescriptor*> map_fields;
  197. for (int i = 0; i < descriptor_->field_count(); i++) {
  198. const FieldDescriptor* field = descriptor_->field(i);
  199. if (GetJavaType(field) == JAVATYPE_MESSAGE &&
  200. IsMapEntry(field->message_type())) {
  201. map_fields.push_back(field);
  202. }
  203. }
  204. if (!map_fields.empty()) {
  205. printer->Print(
  206. "@SuppressWarnings({\"rawtypes\"})\n"
  207. "protected com.google.protobuf.MapField internalGetMapField(\n"
  208. " int number) {\n"
  209. " switch (number) {\n");
  210. printer->Indent();
  211. printer->Indent();
  212. for (int i = 0; i < map_fields.size(); ++i) {
  213. const FieldDescriptor* field = map_fields[i];
  214. const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field);
  215. printer->Print(
  216. "case $number$:\n"
  217. " return internalGet$capitalized_name$();\n",
  218. "number", SimpleItoa(field->number()),
  219. "capitalized_name", info->capitalized_name);
  220. }
  221. printer->Print(
  222. "default:\n"
  223. " throw new RuntimeException(\n"
  224. " \"Invalid map field number: \" + number);\n");
  225. printer->Outdent();
  226. printer->Outdent();
  227. printer->Print(
  228. " }\n"
  229. "}\n");
  230. printer->Print(
  231. "@SuppressWarnings({\"rawtypes\"})\n"
  232. "protected com.google.protobuf.MapField internalGetMutableMapField(\n"
  233. " int number) {\n"
  234. " switch (number) {\n");
  235. printer->Indent();
  236. printer->Indent();
  237. for (int i = 0; i < map_fields.size(); ++i) {
  238. const FieldDescriptor* field = map_fields[i];
  239. const FieldGeneratorInfo* info =
  240. context_->GetFieldGeneratorInfo(field);
  241. printer->Print(
  242. "case $number$:\n"
  243. " return internalGetMutable$capitalized_name$();\n",
  244. "number", SimpleItoa(field->number()),
  245. "capitalized_name", info->capitalized_name);
  246. }
  247. printer->Print(
  248. "default:\n"
  249. " throw new RuntimeException(\n"
  250. " \"Invalid map field number: \" + number);\n");
  251. printer->Outdent();
  252. printer->Outdent();
  253. printer->Print(
  254. " }\n"
  255. "}\n");
  256. }
  257. printer->Print(
  258. "@java.lang.Override\n"
  259. "protected com.google.protobuf.GeneratedMessage$ver$.FieldAccessorTable\n"
  260. " internalGetFieldAccessorTable() {\n"
  261. " return $fileclass$.internal_$identifier$_fieldAccessorTable\n"
  262. " .ensureFieldAccessorsInitialized(\n"
  263. " $classname$.class, $classname$.Builder.class);\n"
  264. "}\n"
  265. "\n",
  266. "classname", name_resolver_->GetImmutableClassName(descriptor_),
  267. "fileclass", name_resolver_->GetImmutableClassName(descriptor_->file()),
  268. "identifier", UniqueFileScopeIdentifier(descriptor_),
  269. "ver", GeneratedCodeVersionSuffix());
  270. }
  271. // ===================================================================
  272. void MessageBuilderGenerator::
  273. GenerateCommonBuilderMethods(io::Printer* printer) {
  274. printer->Print(
  275. "// Construct using $classname$.newBuilder()\n"
  276. "private Builder() {\n"
  277. " maybeForceBuilderInitialization();\n"
  278. "}\n"
  279. "\n",
  280. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  281. printer->Print(
  282. "private Builder(\n"
  283. " com.google.protobuf.GeneratedMessage$ver$.BuilderParent parent) {\n"
  284. " super(parent);\n"
  285. " maybeForceBuilderInitialization();\n"
  286. "}\n",
  287. "classname", name_resolver_->GetImmutableClassName(descriptor_),
  288. "ver", GeneratedCodeVersionSuffix());
  289. printer->Print(
  290. "private void maybeForceBuilderInitialization() {\n"
  291. " if (com.google.protobuf.GeneratedMessage$ver$\n"
  292. " .alwaysUseFieldBuilders) {\n",
  293. "ver", GeneratedCodeVersionSuffix());
  294. printer->Indent();
  295. printer->Indent();
  296. for (int i = 0; i < descriptor_->field_count(); i++) {
  297. if (!descriptor_->field(i)->containing_oneof()) {
  298. field_generators_.get(descriptor_->field(i))
  299. .GenerateFieldBuilderInitializationCode(printer);
  300. }
  301. }
  302. printer->Outdent();
  303. printer->Outdent();
  304. printer->Print(
  305. " }\n"
  306. "}\n");
  307. printer->Print(
  308. "@java.lang.Override\n"
  309. "public Builder clear() {\n"
  310. " super.clear();\n");
  311. printer->Indent();
  312. for (int i = 0; i < descriptor_->field_count(); i++) {
  313. if (!descriptor_->field(i)->containing_oneof()) {
  314. field_generators_.get(descriptor_->field(i))
  315. .GenerateBuilderClearCode(printer);
  316. }
  317. }
  318. for (int i = 0; i < descriptor_->oneof_decl_count(); i++) {
  319. printer->Print(
  320. "$oneof_name$Case_ = 0;\n"
  321. "$oneof_name$_ = null;\n",
  322. "oneof_name", context_->GetOneofGeneratorInfo(
  323. descriptor_->oneof_decl(i))->name);
  324. }
  325. printer->Outdent();
  326. printer->Print(
  327. " return this;\n"
  328. "}\n"
  329. "\n");
  330. printer->Print(
  331. "@java.lang.Override\n"
  332. "public com.google.protobuf.Descriptors.Descriptor\n"
  333. " getDescriptorForType() {\n"
  334. " return $fileclass$.internal_$identifier$_descriptor;\n"
  335. "}\n"
  336. "\n",
  337. "fileclass", name_resolver_->GetImmutableClassName(descriptor_->file()),
  338. "identifier", UniqueFileScopeIdentifier(descriptor_));
  339. // LITE runtime implements this in GeneratedMessageLite.
  340. printer->Print(
  341. "@java.lang.Override\n"
  342. "public $classname$ getDefaultInstanceForType() {\n"
  343. " return $classname$.getDefaultInstance();\n"
  344. "}\n"
  345. "\n",
  346. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  347. printer->Print(
  348. "@java.lang.Override\n"
  349. "public $classname$ build() {\n"
  350. " $classname$ result = buildPartial();\n"
  351. " if (!result.isInitialized()) {\n"
  352. " throw newUninitializedMessageException(result);\n"
  353. " }\n"
  354. " return result;\n"
  355. "}\n"
  356. "\n",
  357. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  358. printer->Print(
  359. "@java.lang.Override\n"
  360. "public $classname$ buildPartial() {\n"
  361. " $classname$ result = new $classname$(this);\n",
  362. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  363. printer->Indent();
  364. int totalBuilderBits = 0;
  365. int totalMessageBits = 0;
  366. for (int i = 0; i < descriptor_->field_count(); i++) {
  367. const ImmutableFieldGenerator& field =
  368. field_generators_.get(descriptor_->field(i));
  369. totalBuilderBits += field.GetNumBitsForBuilder();
  370. totalMessageBits += field.GetNumBitsForMessage();
  371. }
  372. int totalBuilderInts = (totalBuilderBits + 31) / 32;
  373. int totalMessageInts = (totalMessageBits + 31) / 32;
  374. if (GenerateHasBits(descriptor_)) {
  375. // Local vars for from and to bit fields to avoid accessing the builder and
  376. // message over and over for these fields. Seems to provide a slight
  377. // perforamance improvement in micro benchmark and this is also what proto1
  378. // code does.
  379. for (int i = 0; i < totalBuilderInts; i++) {
  380. printer->Print("int from_$bit_field_name$ = $bit_field_name$;\n",
  381. "bit_field_name", GetBitFieldName(i));
  382. }
  383. for (int i = 0; i < totalMessageInts; i++) {
  384. printer->Print("int to_$bit_field_name$ = 0;\n",
  385. "bit_field_name", GetBitFieldName(i));
  386. }
  387. }
  388. // Output generation code for each field.
  389. for (int i = 0; i < descriptor_->field_count(); i++) {
  390. field_generators_.get(descriptor_->field(i)).GenerateBuildingCode(printer);
  391. }
  392. if (GenerateHasBits(descriptor_)) {
  393. // Copy the bit field results to the generated message
  394. for (int i = 0; i < totalMessageInts; i++) {
  395. printer->Print("result.$bit_field_name$ = to_$bit_field_name$;\n",
  396. "bit_field_name", GetBitFieldName(i));
  397. }
  398. }
  399. for (int i = 0; i < descriptor_->oneof_decl_count(); i++) {
  400. printer->Print("result.$oneof_name$Case_ = $oneof_name$Case_;\n",
  401. "oneof_name", context_->GetOneofGeneratorInfo(
  402. descriptor_->oneof_decl(i))->name);
  403. }
  404. printer->Outdent();
  405. printer->Print(
  406. " onBuilt();\n");
  407. printer->Print(
  408. " return result;\n"
  409. "}\n"
  410. "\n",
  411. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  412. // Override methods declared in GeneratedMessage to return the concrete
  413. // generated type so callsites won't depend on GeneratedMessage. This
  414. // is needed to keep binary compatibility when we change generated code
  415. // to subclass a different GeneratedMessage class (e.g., in v3.0.0 release
  416. // we changed all generated code to subclass GeneratedMessageV3).
  417. printer->Print(
  418. "@java.lang.Override\n"
  419. "public Builder clone() {\n"
  420. " return (Builder) super.clone();\n"
  421. "}\n"
  422. "@java.lang.Override\n"
  423. "public Builder setField(\n"
  424. " com.google.protobuf.Descriptors.FieldDescriptor field,\n"
  425. " java.lang.Object value) {\n"
  426. " return (Builder) super.setField(field, value);\n"
  427. "}\n"
  428. "@java.lang.Override\n"
  429. "public Builder clearField(\n"
  430. " com.google.protobuf.Descriptors.FieldDescriptor field) {\n"
  431. " return (Builder) super.clearField(field);\n"
  432. "}\n"
  433. "@java.lang.Override\n"
  434. "public Builder clearOneof(\n"
  435. " com.google.protobuf.Descriptors.OneofDescriptor oneof) {\n"
  436. " return (Builder) super.clearOneof(oneof);\n"
  437. "}\n"
  438. "@java.lang.Override\n"
  439. "public Builder setRepeatedField(\n"
  440. " com.google.protobuf.Descriptors.FieldDescriptor field,\n"
  441. " int index, java.lang.Object value) {\n"
  442. " return (Builder) super.setRepeatedField(field, index, value);\n"
  443. "}\n"
  444. "@java.lang.Override\n"
  445. "public Builder addRepeatedField(\n"
  446. " com.google.protobuf.Descriptors.FieldDescriptor field,\n"
  447. " java.lang.Object value) {\n"
  448. " return (Builder) super.addRepeatedField(field, value);\n"
  449. "}\n");
  450. if (descriptor_->extension_range_count() > 0) {
  451. printer->Print(
  452. "@java.lang.Override\n"
  453. "public <Type> Builder setExtension(\n"
  454. " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
  455. " $classname$, Type> extension,\n"
  456. " Type value) {\n"
  457. " return (Builder) super.setExtension(extension, value);\n"
  458. "}\n"
  459. "@java.lang.Override\n"
  460. "public <Type> Builder setExtension(\n"
  461. " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
  462. " $classname$, java.util.List<Type>> extension,\n"
  463. " int index, Type value) {\n"
  464. " return (Builder) super.setExtension(extension, index, value);\n"
  465. "}\n"
  466. "@java.lang.Override\n"
  467. "public <Type> Builder addExtension(\n"
  468. " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
  469. " $classname$, java.util.List<Type>> extension,\n"
  470. " Type value) {\n"
  471. " return (Builder) super.addExtension(extension, value);\n"
  472. "}\n"
  473. "@java.lang.Override\n"
  474. "public <Type> Builder clearExtension(\n"
  475. " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
  476. " $classname$, ?> extension) {\n"
  477. " return (Builder) super.clearExtension(extension);\n"
  478. "}\n",
  479. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  480. }
  481. // -----------------------------------------------------------------
  482. if (context_->HasGeneratedMethods(descriptor_)) {
  483. printer->Print(
  484. "@java.lang.Override\n"
  485. "public Builder mergeFrom(com.google.protobuf.Message other) {\n"
  486. " if (other instanceof $classname$) {\n"
  487. " return mergeFrom(($classname$)other);\n"
  488. " } else {\n"
  489. " super.mergeFrom(other);\n"
  490. " return this;\n"
  491. " }\n"
  492. "}\n"
  493. "\n",
  494. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  495. printer->Print(
  496. "public Builder mergeFrom($classname$ other) {\n"
  497. // Optimization: If other is the default instance, we know none of its
  498. // fields are set so we can skip the merge.
  499. " if (other == $classname$.getDefaultInstance()) return this;\n",
  500. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  501. printer->Indent();
  502. for (int i = 0; i < descriptor_->field_count(); i++) {
  503. if (!descriptor_->field(i)->containing_oneof()) {
  504. field_generators_.get(
  505. descriptor_->field(i)).GenerateMergingCode(printer);
  506. }
  507. }
  508. // Merge oneof fields.
  509. for (int i = 0; i < descriptor_->oneof_decl_count(); ++i) {
  510. printer->Print(
  511. "switch (other.get$oneof_capitalized_name$Case()) {\n",
  512. "oneof_capitalized_name",
  513. context_->GetOneofGeneratorInfo(
  514. descriptor_->oneof_decl(i))->capitalized_name);
  515. printer->Indent();
  516. for (int j = 0; j < descriptor_->oneof_decl(i)->field_count(); j++) {
  517. const FieldDescriptor* field = descriptor_->oneof_decl(i)->field(j);
  518. printer->Print(
  519. "case $field_name$: {\n",
  520. "field_name",
  521. ToUpper(field->name()));
  522. printer->Indent();
  523. field_generators_.get(field).GenerateMergingCode(printer);
  524. printer->Print(
  525. "break;\n");
  526. printer->Outdent();
  527. printer->Print(
  528. "}\n");
  529. }
  530. printer->Print(
  531. "case $cap_oneof_name$_NOT_SET: {\n"
  532. " break;\n"
  533. "}\n",
  534. "cap_oneof_name",
  535. ToUpper(context_->GetOneofGeneratorInfo(
  536. descriptor_->oneof_decl(i))->name));
  537. printer->Outdent();
  538. printer->Print(
  539. "}\n");
  540. }
  541. printer->Outdent();
  542. // if message type has extensions
  543. if (descriptor_->extension_range_count() > 0) {
  544. printer->Print(
  545. " this.mergeExtensionFields(other);\n");
  546. }
  547. printer->Print(
  548. " this.mergeUnknownFields(other.unknownFields);\n");
  549. printer->Print(
  550. " onChanged();\n");
  551. printer->Print(
  552. " return this;\n"
  553. "}\n"
  554. "\n");
  555. }
  556. }
  557. // ===================================================================
  558. void MessageBuilderGenerator::
  559. GenerateBuilderParsingMethods(io::Printer* printer) {
  560. printer->Print(
  561. "@java.lang.Override\n"
  562. "public Builder mergeFrom(\n"
  563. " com.google.protobuf.CodedInputStream input,\n"
  564. " com.google.protobuf.ExtensionRegistryLite extensionRegistry)\n"
  565. " throws java.io.IOException {\n"
  566. " $classname$ parsedMessage = null;\n"
  567. " try {\n"
  568. " parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);\n"
  569. " } catch (com.google.protobuf.InvalidProtocolBufferException e) {\n"
  570. " parsedMessage = ($classname$) e.getUnfinishedMessage();\n"
  571. " throw e.unwrapIOException();\n"
  572. " } finally {\n"
  573. " if (parsedMessage != null) {\n"
  574. " mergeFrom(parsedMessage);\n"
  575. " }\n"
  576. " }\n"
  577. " return this;\n"
  578. "}\n",
  579. "classname", name_resolver_->GetImmutableClassName(descriptor_));
  580. }
  581. // ===================================================================
  582. void MessageBuilderGenerator::GenerateIsInitialized(
  583. io::Printer* printer) {
  584. printer->Print(
  585. "@java.lang.Override\n"
  586. "public final boolean isInitialized() {\n");
  587. printer->Indent();
  588. // Check that all required fields in this message are set.
  589. // TODO(kenton): We can optimize this when we switch to putting all the
  590. // "has" fields into a single bitfield.
  591. for (int i = 0; i < descriptor_->field_count(); i++) {
  592. const FieldDescriptor* field = descriptor_->field(i);
  593. const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field);
  594. if (field->is_required()) {
  595. printer->Print(
  596. "if (!has$name$()) {\n"
  597. " return false;\n"
  598. "}\n",
  599. "name", info->capitalized_name);
  600. }
  601. }
  602. // Now check that all embedded messages are initialized.
  603. for (int i = 0; i < descriptor_->field_count(); i++) {
  604. const FieldDescriptor* field = descriptor_->field(i);
  605. const FieldGeneratorInfo* info = context_->GetFieldGeneratorInfo(field);
  606. if (GetJavaType(field) == JAVATYPE_MESSAGE &&
  607. HasRequiredFields(field->message_type())) {
  608. switch (field->label()) {
  609. case FieldDescriptor::LABEL_REQUIRED:
  610. printer->Print(
  611. "if (!get$name$().isInitialized()) {\n"
  612. " return false;\n"
  613. "}\n",
  614. "type", name_resolver_->GetImmutableClassName(
  615. field->message_type()),
  616. "name", info->capitalized_name);
  617. break;
  618. case FieldDescriptor::LABEL_OPTIONAL:
  619. if (!SupportFieldPresence(descriptor_->file()) &&
  620. field->containing_oneof() != NULL) {
  621. const OneofDescriptor* oneof = field->containing_oneof();
  622. const OneofGeneratorInfo* oneof_info =
  623. context_->GetOneofGeneratorInfo(oneof);
  624. printer->Print(
  625. "if ($oneof_name$Case_ == $field_number$) {\n",
  626. "oneof_name", oneof_info->name,
  627. "field_number", SimpleItoa(field->number()));
  628. } else {
  629. printer->Print(
  630. "if (has$name$()) {\n",
  631. "name", info->capitalized_name);
  632. }
  633. printer->Print(
  634. " if (!get$name$().isInitialized()) {\n"
  635. " return false;\n"
  636. " }\n"
  637. "}\n",
  638. "name", info->capitalized_name);
  639. break;
  640. case FieldDescriptor::LABEL_REPEATED:
  641. if (IsMapEntry(field->message_type())) {
  642. printer->Print(
  643. "for ($type$ item : get$name$Map().values()) {\n"
  644. " if (!item.isInitialized()) {\n"
  645. " return false;\n"
  646. " }\n"
  647. "}\n",
  648. "type", MapValueImmutableClassdName(field->message_type(),
  649. name_resolver_),
  650. "name", info->capitalized_name);
  651. } else {
  652. printer->Print(
  653. "for (int i = 0; i < get$name$Count(); i++) {\n"
  654. " if (!get$name$(i).isInitialized()) {\n"
  655. " return false;\n"
  656. " }\n"
  657. "}\n",
  658. "type", name_resolver_->GetImmutableClassName(
  659. field->message_type()),
  660. "name", info->capitalized_name);
  661. }
  662. break;
  663. }
  664. }
  665. }
  666. if (descriptor_->extension_range_count() > 0) {
  667. printer->Print(
  668. "if (!extensionsAreInitialized()) {\n"
  669. " return false;\n"
  670. "}\n");
  671. }
  672. printer->Outdent();
  673. printer->Print(
  674. " return true;\n"
  675. "}\n"
  676. "\n");
  677. }
  678. // ===================================================================
  679. } // namespace java
  680. } // namespace compiler
  681. } // namespace protobuf
  682. } // namespace google