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: kenton@google.com (Kenton Varda)
32 // Based on original Protocol Buffers design by
33 // Sanjay Ghemawat, Jeff Dean, and others.
34
35 #include <map>
36 #include <string>
37
38 #include <google/protobuf/stubs/common.h>
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_field.h>
42 #include <google/protobuf/compiler/java/java_helpers.h>
43 #include <google/protobuf/compiler/java/java_name_resolver.h>
44 #include <google/protobuf/io/printer.h>
45 #include <google/protobuf/wire_format.h>
46 #include <google/protobuf/stubs/strutil.h>
47
48 namespace google {
49 namespace protobuf {
50 namespace compiler {
51 namespace java {
52
53 namespace {
54
SetEnumVariables(const FieldDescriptor * descriptor,int messageBitIndex,int builderBitIndex,const FieldGeneratorInfo * info,ClassNameResolver * name_resolver,map<string,string> * variables)55 void SetEnumVariables(const FieldDescriptor* descriptor,
56 int messageBitIndex,
57 int builderBitIndex,
58 const FieldGeneratorInfo* info,
59 ClassNameResolver* name_resolver,
60 map<string, string>* variables) {
61 SetCommonFieldVariables(descriptor, info, variables);
62
63 (*variables)["type"] =
64 name_resolver->GetImmutableClassName(descriptor->enum_type());
65 (*variables)["mutable_type"] =
66 name_resolver->GetMutableClassName(descriptor->enum_type());
67 (*variables)["default"] = ImmutableDefaultValue(descriptor, name_resolver);
68 (*variables)["tag"] = SimpleItoa(internal::WireFormat::MakeTag(descriptor));
69 (*variables)["tag_size"] = SimpleItoa(
70 internal::WireFormat::TagSize(descriptor->number(), GetType(descriptor)));
71 // TODO(birdo): Add @deprecated javadoc when generating javadoc is supported
72 // by the proto compiler
73 (*variables)["deprecation"] = descriptor->options().deprecated()
74 ? "@java.lang.Deprecated " : "";
75 (*variables)["on_changed"] =
76 HasDescriptorMethods(descriptor->containing_type()) ? "onChanged();" : "";
77
78 if (SupportFieldPresence(descriptor->file())) {
79 // For singular messages and builders, one bit is used for the hasField bit.
80 (*variables)["get_has_field_bit_message"] = GenerateGetBit(messageBitIndex);
81 (*variables)["get_has_field_bit_builder"] = GenerateGetBit(builderBitIndex);
82
83 // Note that these have a trailing ";".
84 (*variables)["set_has_field_bit_message"] =
85 GenerateSetBit(messageBitIndex) + ";";
86 (*variables)["set_has_field_bit_builder"] =
87 GenerateSetBit(builderBitIndex) + ";";
88 (*variables)["clear_has_field_bit_builder"] =
89 GenerateClearBit(builderBitIndex) + ";";
90
91 (*variables)["is_field_present_message"] = GenerateGetBit(messageBitIndex);
92 } else {
93 (*variables)["set_has_field_bit_message"] = "";
94 (*variables)["set_has_field_bit_builder"] = "";
95 (*variables)["clear_has_field_bit_builder"] = "";
96
97 (*variables)["is_field_present_message"] =
98 (*variables)["name"] + "_ != " + (*variables)["default"];
99 }
100
101 // For repated builders, one bit is used for whether the array is immutable.
102 (*variables)["get_mutable_bit_builder"] = GenerateGetBit(builderBitIndex);
103 (*variables)["set_mutable_bit_builder"] = GenerateSetBit(builderBitIndex);
104 (*variables)["clear_mutable_bit_builder"] = GenerateClearBit(builderBitIndex);
105
106 // For repeated fields, one bit is used for whether the array is immutable
107 // in the parsing constructor.
108 (*variables)["get_mutable_bit_parser"] =
109 GenerateGetBitMutableLocal(builderBitIndex);
110 (*variables)["set_mutable_bit_parser"] =
111 GenerateSetBitMutableLocal(builderBitIndex);
112
113 (*variables)["get_has_field_bit_from_local"] =
114 GenerateGetBitFromLocal(builderBitIndex);
115 (*variables)["set_has_field_bit_to_local"] =
116 GenerateSetBitToLocal(messageBitIndex);
117 }
118
119 } // namespace
120
121 // ===================================================================
122
123 ImmutableEnumFieldGenerator::
ImmutableEnumFieldGenerator(const FieldDescriptor * descriptor,int messageBitIndex,int builderBitIndex,Context * context)124 ImmutableEnumFieldGenerator(const FieldDescriptor* descriptor,
125 int messageBitIndex,
126 int builderBitIndex,
127 Context* context)
128 : descriptor_(descriptor), messageBitIndex_(messageBitIndex),
129 builderBitIndex_(builderBitIndex),
130 name_resolver_(context->GetNameResolver()) {
131 SetEnumVariables(descriptor, messageBitIndex, builderBitIndex,
132 context->GetFieldGeneratorInfo(descriptor),
133 name_resolver_, &variables_);
134 }
135
~ImmutableEnumFieldGenerator()136 ImmutableEnumFieldGenerator::~ImmutableEnumFieldGenerator() {}
137
GetNumBitsForMessage() const138 int ImmutableEnumFieldGenerator::GetNumBitsForMessage() const {
139 return 1;
140 }
141
GetNumBitsForBuilder() const142 int ImmutableEnumFieldGenerator::GetNumBitsForBuilder() const {
143 return 1;
144 }
145
146 void ImmutableEnumFieldGenerator::
GenerateInterfaceMembers(io::Printer * printer) const147 GenerateInterfaceMembers(io::Printer* printer) const {
148 if (SupportFieldPresence(descriptor_->file())) {
149 WriteFieldDocComment(printer, descriptor_);
150 printer->Print(variables_,
151 "$deprecation$boolean has$capitalized_name$();\n");
152 }
153 WriteFieldDocComment(printer, descriptor_);
154 printer->Print(variables_,
155 "$deprecation$$type$ get$capitalized_name$();\n");
156 }
157
158 void ImmutableEnumFieldGenerator::
GenerateMembers(io::Printer * printer) const159 GenerateMembers(io::Printer* printer) const {
160 printer->Print(variables_,
161 "private $type$ $name$_;\n");
162 PrintExtraFieldInfo(variables_, printer);
163 if (SupportFieldPresence(descriptor_->file())) {
164 WriteFieldDocComment(printer, descriptor_);
165 printer->Print(variables_,
166 "$deprecation$public boolean has$capitalized_name$() {\n"
167 " return $get_has_field_bit_message$;\n"
168 "}\n");
169 }
170 WriteFieldDocComment(printer, descriptor_);
171 printer->Print(variables_,
172 "$deprecation$public $type$ get$capitalized_name$() {\n"
173 " return $name$_;\n"
174 "}\n");
175 }
176
177 void ImmutableEnumFieldGenerator::
GenerateBuilderMembers(io::Printer * printer) const178 GenerateBuilderMembers(io::Printer* printer) const {
179 printer->Print(variables_,
180 "private $type$ $name$_ = $default$;\n");
181 if (SupportFieldPresence(descriptor_->file())) {
182 WriteFieldDocComment(printer, descriptor_);
183 printer->Print(variables_,
184 "$deprecation$public boolean has$capitalized_name$() {\n"
185 " return $get_has_field_bit_builder$;\n"
186 "}\n");
187 }
188 WriteFieldDocComment(printer, descriptor_);
189 printer->Print(variables_,
190 "$deprecation$public $type$ get$capitalized_name$() {\n"
191 " return $name$_;\n"
192 "}\n");
193 WriteFieldDocComment(printer, descriptor_);
194 printer->Print(variables_,
195 "$deprecation$public Builder set$capitalized_name$($type$ value) {\n"
196 " if (value == null) {\n"
197 " throw new NullPointerException();\n"
198 " }\n"
199 " $set_has_field_bit_builder$\n"
200 " $name$_ = value;\n"
201 " $on_changed$\n"
202 " return this;\n"
203 "}\n");
204 WriteFieldDocComment(printer, descriptor_);
205 printer->Print(variables_,
206 "$deprecation$public Builder clear$capitalized_name$() {\n"
207 " $clear_has_field_bit_builder$\n"
208 " $name$_ = $default$;\n"
209 " $on_changed$\n"
210 " return this;\n"
211 "}\n");
212 }
213
214 void ImmutableEnumFieldGenerator::
GenerateFieldBuilderInitializationCode(io::Printer * printer) const215 GenerateFieldBuilderInitializationCode(io::Printer* printer) const {
216 // noop for enums
217 }
218
219 void ImmutableEnumFieldGenerator::
GenerateInitializationCode(io::Printer * printer) const220 GenerateInitializationCode(io::Printer* printer) const {
221 printer->Print(variables_, "$name$_ = $default$;\n");
222 }
223
224 void ImmutableEnumFieldGenerator::
GenerateBuilderClearCode(io::Printer * printer) const225 GenerateBuilderClearCode(io::Printer* printer) const {
226 printer->Print(variables_,
227 "$name$_ = $default$;\n"
228 "$clear_has_field_bit_builder$\n");
229 }
230
231 void ImmutableEnumFieldGenerator::
GenerateMergingCode(io::Printer * printer) const232 GenerateMergingCode(io::Printer* printer) const {
233 if (SupportFieldPresence(descriptor_->file())) {
234 printer->Print(variables_,
235 "if (other.has$capitalized_name$()) {\n"
236 " set$capitalized_name$(other.get$capitalized_name$());\n"
237 "}\n");
238 } else {
239 printer->Print(variables_,
240 "if (other.get$capitalized_name$() != $default$) {\n"
241 " set$capitalized_name$(other.get$capitalized_name$());\n"
242 "}\n");
243 }
244 }
245
246 void ImmutableEnumFieldGenerator::
GenerateBuildingCode(io::Printer * printer) const247 GenerateBuildingCode(io::Printer* printer) const {
248 if (SupportFieldPresence(descriptor_->file())) {
249 printer->Print(variables_,
250 "if ($get_has_field_bit_from_local$) {\n"
251 " $set_has_field_bit_to_local$;\n"
252 "}\n");
253 }
254 printer->Print(variables_,
255 "result.$name$_ = $name$_;\n");
256 }
257
258 void ImmutableEnumFieldGenerator::
GenerateParsingCode(io::Printer * printer) const259 GenerateParsingCode(io::Printer* printer) const {
260 printer->Print(variables_,
261 "int rawValue = input.readEnum();\n"
262 "$type$ value = $type$.valueOf(rawValue);\n"
263 "if (value == null) {\n");
264 if (UseUnknownFieldSet(descriptor_->containing_type())) {
265 printer->Print(variables_,
266 " unknownFields.mergeVarintField($number$, rawValue);\n");
267 } else {
268 printer->Print(variables_,
269 " unknownFieldsCodedOutput.writeRawVarint32(tag);\n"
270 " unknownFieldsCodedOutput.writeRawVarint32(rawValue);\n");
271 }
272 printer->Print(variables_,
273 "} else {\n"
274 " $set_has_field_bit_message$\n"
275 " $name$_ = value;\n"
276 "}\n");
277 }
278
279 void ImmutableEnumFieldGenerator::
GenerateParsingDoneCode(io::Printer * printer) const280 GenerateParsingDoneCode(io::Printer* printer) const {
281 // noop for enums
282 }
283
284 void ImmutableEnumFieldGenerator::
GenerateSerializationCode(io::Printer * printer) const285 GenerateSerializationCode(io::Printer* printer) const {
286 printer->Print(variables_,
287 "if ($is_field_present_message$) {\n"
288 " output.writeEnum($number$, $name$_.getNumber());\n"
289 "}\n");
290 }
291
292 void ImmutableEnumFieldGenerator::
GenerateSerializedSizeCode(io::Printer * printer) const293 GenerateSerializedSizeCode(io::Printer* printer) const {
294 printer->Print(variables_,
295 "if ($is_field_present_message$) {\n"
296 " size += com.google.protobuf.CodedOutputStream\n"
297 " .computeEnumSize($number$, $name$_.getNumber());\n"
298 "}\n");
299 }
300
301 void ImmutableEnumFieldGenerator::
GenerateEqualsCode(io::Printer * printer) const302 GenerateEqualsCode(io::Printer* printer) const {
303 printer->Print(variables_,
304 "result = result &&\n"
305 " (get$capitalized_name$() == other.get$capitalized_name$());\n");
306 }
307
308 void ImmutableEnumFieldGenerator::
GenerateHashCode(io::Printer * printer) const309 GenerateHashCode(io::Printer* printer) const {
310 printer->Print(variables_,
311 "hash = (37 * hash) + $constant_name$;\n"
312 "hash = (53 * hash) + com.google.protobuf.Internal.hashEnum(\n"
313 " get$capitalized_name$());\n");
314 }
315
GetBoxedType() const316 string ImmutableEnumFieldGenerator::GetBoxedType() const {
317 return name_resolver_->GetImmutableClassName(descriptor_->enum_type());
318 }
319
320 // ===================================================================
321
322 ImmutableEnumOneofFieldGenerator::
ImmutableEnumOneofFieldGenerator(const FieldDescriptor * descriptor,int messageBitIndex,int builderBitIndex,Context * context)323 ImmutableEnumOneofFieldGenerator(const FieldDescriptor* descriptor,
324 int messageBitIndex,
325 int builderBitIndex,
326 Context* context)
327 : ImmutableEnumFieldGenerator(
328 descriptor, messageBitIndex, builderBitIndex, context) {
329 const OneofGeneratorInfo* info =
330 context->GetOneofGeneratorInfo(descriptor->containing_oneof());
331 SetCommonOneofVariables(descriptor, info, &variables_);
332 }
333
334 ImmutableEnumOneofFieldGenerator::
~ImmutableEnumOneofFieldGenerator()335 ~ImmutableEnumOneofFieldGenerator() {}
336
337 void ImmutableEnumOneofFieldGenerator::
GenerateMembers(io::Printer * printer) const338 GenerateMembers(io::Printer* printer) const {
339 PrintExtraFieldInfo(variables_, printer);
340 if (SupportFieldPresence(descriptor_->file())) {
341 WriteFieldDocComment(printer, descriptor_);
342 printer->Print(variables_,
343 "$deprecation$public boolean has$capitalized_name$() {\n"
344 " return $has_oneof_case_message$;\n"
345 "}\n");
346 }
347 WriteFieldDocComment(printer, descriptor_);
348 printer->Print(variables_,
349 "$deprecation$public $type$ get$capitalized_name$() {\n"
350 " if ($has_oneof_case_message$) {\n"
351 " return ($type$) $oneof_name$_;\n"
352 " }\n"
353 " return $default$;\n"
354 "}\n");
355 }
356
357 void ImmutableEnumOneofFieldGenerator::
GenerateBuilderMembers(io::Printer * printer) const358 GenerateBuilderMembers(io::Printer* printer) const {
359 if (SupportFieldPresence(descriptor_->file())) {
360 WriteFieldDocComment(printer, descriptor_);
361 printer->Print(variables_,
362 "$deprecation$public boolean has$capitalized_name$() {\n"
363 " return $has_oneof_case_message$;\n"
364 "}\n");
365 }
366 WriteFieldDocComment(printer, descriptor_);
367 printer->Print(variables_,
368 "$deprecation$public $type$ get$capitalized_name$() {\n"
369 " if ($has_oneof_case_message$) {\n"
370 " return ($type$) $oneof_name$_;\n"
371 " }\n"
372 " return $default$;\n"
373 "}\n");
374 WriteFieldDocComment(printer, descriptor_);
375 printer->Print(variables_,
376 "$deprecation$public Builder set$capitalized_name$($type$ value) {\n"
377 " if (value == null) {\n"
378 " throw new NullPointerException();\n"
379 " }\n"
380 " $set_oneof_case_message$;\n"
381 " $oneof_name$_ = value;\n"
382 " $on_changed$\n"
383 " return this;\n"
384 "}\n");
385 WriteFieldDocComment(printer, descriptor_);
386 printer->Print(variables_,
387 "$deprecation$public Builder clear$capitalized_name$() {\n"
388 " if ($has_oneof_case_message$) {\n"
389 " $clear_oneof_case_message$;\n"
390 " $oneof_name$_ = null;\n"
391 " $on_changed$\n"
392 " }\n"
393 " return this;\n"
394 "}\n");
395 }
396
397 void ImmutableEnumOneofFieldGenerator::
GenerateBuildingCode(io::Printer * printer) const398 GenerateBuildingCode(io::Printer* printer) const {
399 printer->Print(variables_,
400 "if ($has_oneof_case_message$) {\n"
401 " result.$oneof_name$_ = $oneof_name$_;\n"
402 "}\n");
403 }
404
405 void ImmutableEnumOneofFieldGenerator::
GenerateMergingCode(io::Printer * printer) const406 GenerateMergingCode(io::Printer* printer) const {
407 printer->Print(variables_,
408 "set$capitalized_name$(other.get$capitalized_name$());\n");
409 }
410
411 void ImmutableEnumOneofFieldGenerator::
GenerateParsingCode(io::Printer * printer) const412 GenerateParsingCode(io::Printer* printer) const {
413 printer->Print(variables_,
414 "int rawValue = input.readEnum();\n"
415 "$type$ value = $type$.valueOf(rawValue);\n"
416 "if (value == null) {\n");
417 if (UseUnknownFieldSet(descriptor_->containing_type())) {
418 printer->Print(variables_,
419 " unknownFields.mergeVarintField($number$, rawValue);\n");
420 } else {
421 printer->Print(variables_,
422 " unknownFieldsCodedOutput.writeRawVarint32(tag);\n"
423 " unknownFieldsCodedOutput.writeRawVarint32(rawValue);\n");
424 }
425 printer->Print(variables_,
426 "} else {\n"
427 " $set_oneof_case_message$;\n"
428 " $oneof_name$_ = value;\n"
429 "}\n");
430 }
431
432 void ImmutableEnumOneofFieldGenerator::
GenerateSerializationCode(io::Printer * printer) const433 GenerateSerializationCode(io::Printer* printer) const {
434 printer->Print(variables_,
435 "if ($has_oneof_case_message$) {\n"
436 " output.writeEnum($number$, (($type$) $oneof_name$_).getNumber());\n"
437 "}\n");
438 }
439
440 void ImmutableEnumOneofFieldGenerator::
GenerateSerializedSizeCode(io::Printer * printer) const441 GenerateSerializedSizeCode(io::Printer* printer) const {
442 printer->Print(variables_,
443 "if ($has_oneof_case_message$) {\n"
444 " size += com.google.protobuf.CodedOutputStream\n"
445 " .computeEnumSize($number$, (($type$) $oneof_name$_).getNumber());\n"
446 "}\n");
447 }
448
449 // ===================================================================
450
451 RepeatedImmutableEnumFieldGenerator::
RepeatedImmutableEnumFieldGenerator(const FieldDescriptor * descriptor,int messageBitIndex,int builderBitIndex,Context * context)452 RepeatedImmutableEnumFieldGenerator(const FieldDescriptor* descriptor,
453 int messageBitIndex,
454 int builderBitIndex,
455 Context* context)
456 : descriptor_(descriptor), messageBitIndex_(messageBitIndex),
457 builderBitIndex_(builderBitIndex), context_(context),
458 name_resolver_(context->GetNameResolver()) {
459 SetEnumVariables(descriptor, messageBitIndex, builderBitIndex,
460 context->GetFieldGeneratorInfo(descriptor),
461 name_resolver_, &variables_);
462 }
463
~RepeatedImmutableEnumFieldGenerator()464 RepeatedImmutableEnumFieldGenerator::~RepeatedImmutableEnumFieldGenerator() {}
465
GetNumBitsForMessage() const466 int RepeatedImmutableEnumFieldGenerator::GetNumBitsForMessage() const {
467 return 0;
468 }
469
GetNumBitsForBuilder() const470 int RepeatedImmutableEnumFieldGenerator::GetNumBitsForBuilder() const {
471 return 1;
472 }
473
474 void RepeatedImmutableEnumFieldGenerator::
GenerateInterfaceMembers(io::Printer * printer) const475 GenerateInterfaceMembers(io::Printer* printer) const {
476 WriteFieldDocComment(printer, descriptor_);
477 printer->Print(variables_,
478 "$deprecation$java.util.List<$type$> get$capitalized_name$List();\n");
479 WriteFieldDocComment(printer, descriptor_);
480 printer->Print(variables_,
481 "$deprecation$int get$capitalized_name$Count();\n");
482 WriteFieldDocComment(printer, descriptor_);
483 printer->Print(variables_,
484 "$deprecation$$type$ get$capitalized_name$(int index);\n");
485 }
486
487 void RepeatedImmutableEnumFieldGenerator::
GenerateMembers(io::Printer * printer) const488 GenerateMembers(io::Printer* printer) const {
489 printer->Print(variables_,
490 "private java.util.List<$type$> $name$_;\n");
491 PrintExtraFieldInfo(variables_, printer);
492 WriteFieldDocComment(printer, descriptor_);
493 printer->Print(variables_,
494 "$deprecation$public java.util.List<$type$> get$capitalized_name$List() {\n"
495 " return $name$_;\n" // note: unmodifiable list
496 "}\n");
497 WriteFieldDocComment(printer, descriptor_);
498 printer->Print(variables_,
499 "$deprecation$public int get$capitalized_name$Count() {\n"
500 " return $name$_.size();\n"
501 "}\n");
502 WriteFieldDocComment(printer, descriptor_);
503 printer->Print(variables_,
504 "$deprecation$public $type$ get$capitalized_name$(int index) {\n"
505 " return $name$_.get(index);\n"
506 "}\n");
507
508 if (descriptor_->options().packed() &&
509 HasGeneratedMethods(descriptor_->containing_type())) {
510 printer->Print(variables_,
511 "private int $name$MemoizedSerializedSize;\n");
512 }
513 }
514
515 void RepeatedImmutableEnumFieldGenerator::
GenerateBuilderMembers(io::Printer * printer) const516 GenerateBuilderMembers(io::Printer* printer) const {
517 printer->Print(variables_,
518 // One field is the list and the other field keeps track of whether the
519 // list is immutable. If it's immutable, the invariant is that it must
520 // either an instance of Collections.emptyList() or it's an ArrayList
521 // wrapped in a Collections.unmodifiableList() wrapper and nobody else has
522 // a refererence to the underlying ArrayList. This invariant allows us to
523 // share instances of lists between protocol buffers avoiding expensive
524 // memory allocations. Note, immutable is a strong guarantee here -- not
525 // just that the list cannot be modified via the reference but that the
526 // list can never be modified.
527 "private java.util.List<$type$> $name$_ =\n"
528 " java.util.Collections.emptyList();\n"
529
530 "private void ensure$capitalized_name$IsMutable() {\n"
531 " if (!$get_mutable_bit_builder$) {\n"
532 " $name$_ = new java.util.ArrayList<$type$>($name$_);\n"
533 " $set_mutable_bit_builder$;\n"
534 " }\n"
535 "}\n");
536
537 WriteFieldDocComment(printer, descriptor_);
538 printer->Print(variables_,
539 // Note: We return an unmodifiable list because otherwise the caller
540 // could hold on to the returned list and modify it after the message
541 // has been built, thus mutating the message which is supposed to be
542 // immutable.
543 "$deprecation$public java.util.List<$type$> get$capitalized_name$List() {\n"
544 " return java.util.Collections.unmodifiableList($name$_);\n"
545 "}\n");
546 WriteFieldDocComment(printer, descriptor_);
547 printer->Print(variables_,
548 "$deprecation$public int get$capitalized_name$Count() {\n"
549 " return $name$_.size();\n"
550 "}\n");
551 WriteFieldDocComment(printer, descriptor_);
552 printer->Print(variables_,
553 "$deprecation$public $type$ get$capitalized_name$(int index) {\n"
554 " return $name$_.get(index);\n"
555 "}\n");
556 WriteFieldDocComment(printer, descriptor_);
557 printer->Print(variables_,
558 "$deprecation$public Builder set$capitalized_name$(\n"
559 " int index, $type$ value) {\n"
560 " if (value == null) {\n"
561 " throw new NullPointerException();\n"
562 " }\n"
563 " ensure$capitalized_name$IsMutable();\n"
564 " $name$_.set(index, value);\n"
565 " $on_changed$\n"
566 " return this;\n"
567 "}\n");
568 WriteFieldDocComment(printer, descriptor_);
569 printer->Print(variables_,
570 "$deprecation$public Builder add$capitalized_name$($type$ value) {\n"
571 " if (value == null) {\n"
572 " throw new NullPointerException();\n"
573 " }\n"
574 " ensure$capitalized_name$IsMutable();\n"
575 " $name$_.add(value);\n"
576 " $on_changed$\n"
577 " return this;\n"
578 "}\n");
579 WriteFieldDocComment(printer, descriptor_);
580 printer->Print(variables_,
581 "$deprecation$public Builder addAll$capitalized_name$(\n"
582 " java.lang.Iterable<? extends $type$> values) {\n"
583 " ensure$capitalized_name$IsMutable();\n"
584 " com.google.protobuf.AbstractMessageLite.Builder.addAll(\n"
585 " values, $name$_);\n"
586 " $on_changed$\n"
587 " return this;\n"
588 "}\n");
589 WriteFieldDocComment(printer, descriptor_);
590 printer->Print(variables_,
591 "$deprecation$public Builder clear$capitalized_name$() {\n"
592 " $name$_ = java.util.Collections.emptyList();\n"
593 " $clear_mutable_bit_builder$;\n"
594 " $on_changed$\n"
595 " return this;\n"
596 "}\n");
597 }
598
599 void RepeatedImmutableEnumFieldGenerator::
GenerateFieldBuilderInitializationCode(io::Printer * printer) const600 GenerateFieldBuilderInitializationCode(io::Printer* printer) const {
601 // noop for enums
602 }
603
604 void RepeatedImmutableEnumFieldGenerator::
GenerateInitializationCode(io::Printer * printer) const605 GenerateInitializationCode(io::Printer* printer) const {
606 printer->Print(variables_, "$name$_ = java.util.Collections.emptyList();\n");
607 }
608
609 void RepeatedImmutableEnumFieldGenerator::
GenerateBuilderClearCode(io::Printer * printer) const610 GenerateBuilderClearCode(io::Printer* printer) const {
611 printer->Print(variables_,
612 "$name$_ = java.util.Collections.emptyList();\n"
613 "$clear_mutable_bit_builder$;\n");
614 }
615
616 void RepeatedImmutableEnumFieldGenerator::
GenerateMergingCode(io::Printer * printer) const617 GenerateMergingCode(io::Printer* printer) const {
618 // The code below does two optimizations:
619 // 1. If the other list is empty, there's nothing to do. This ensures we
620 // don't allocate a new array if we already have an immutable one.
621 // 2. If the other list is non-empty and our current list is empty, we can
622 // reuse the other list which is guaranteed to be immutable.
623 printer->Print(variables_,
624 "if (!other.$name$_.isEmpty()) {\n"
625 " if ($name$_.isEmpty()) {\n"
626 " $name$_ = other.$name$_;\n"
627 " $clear_mutable_bit_builder$;\n"
628 " } else {\n"
629 " ensure$capitalized_name$IsMutable();\n"
630 " $name$_.addAll(other.$name$_);\n"
631 " }\n"
632 " $on_changed$\n"
633 "}\n");
634 }
635
636 void RepeatedImmutableEnumFieldGenerator::
GenerateBuildingCode(io::Printer * printer) const637 GenerateBuildingCode(io::Printer* printer) const {
638 // The code below ensures that the result has an immutable list. If our
639 // list is immutable, we can just reuse it. If not, we make it immutable.
640 printer->Print(variables_,
641 "if ($get_mutable_bit_builder$) {\n"
642 " $name$_ = java.util.Collections.unmodifiableList($name$_);\n"
643 " $clear_mutable_bit_builder$;\n"
644 "}\n"
645 "result.$name$_ = $name$_;\n");
646 }
647
648 void RepeatedImmutableEnumFieldGenerator::
GenerateParsingCode(io::Printer * printer) const649 GenerateParsingCode(io::Printer* printer) const {
650 // Read and store the enum
651 printer->Print(variables_,
652 "int rawValue = input.readEnum();\n"
653 "$type$ value = $type$.valueOf(rawValue);\n"
654 "if (value == null) {\n");
655 if (UseUnknownFieldSet(descriptor_->containing_type())) {
656 printer->Print(variables_,
657 " unknownFields.mergeVarintField($number$, rawValue);\n");
658 } else {
659 printer->Print(variables_,
660 " unknownFieldsCodedOutput.writeRawVarint32(tag);\n"
661 " unknownFieldsCodedOutput.writeRawVarint32(rawValue);\n");
662 }
663 printer->Print(variables_,
664 " } else {\n"
665 " if (!$get_mutable_bit_parser$) {\n"
666 " $name$_ = new java.util.ArrayList<$type$>();\n"
667 " $set_mutable_bit_parser$;\n"
668 " }\n"
669 " $name$_.add(value);\n"
670 "}\n");
671 }
672
673 void RepeatedImmutableEnumFieldGenerator::
GenerateParsingCodeFromPacked(io::Printer * printer) const674 GenerateParsingCodeFromPacked(io::Printer* printer) const {
675 // Wrap GenerateParsingCode's contents with a while loop.
676
677 printer->Print(variables_,
678 "int length = input.readRawVarint32();\n"
679 "int oldLimit = input.pushLimit(length);\n"
680 "while(input.getBytesUntilLimit() > 0) {\n");
681 printer->Indent();
682
683 GenerateParsingCode(printer);
684
685 printer->Outdent();
686 printer->Print(variables_,
687 "}\n"
688 "input.popLimit(oldLimit);\n");
689 }
690
691 void RepeatedImmutableEnumFieldGenerator::
GenerateParsingDoneCode(io::Printer * printer) const692 GenerateParsingDoneCode(io::Printer* printer) const {
693 printer->Print(variables_,
694 "if ($get_mutable_bit_parser$) {\n"
695 " $name$_ = java.util.Collections.unmodifiableList($name$_);\n"
696 "}\n");
697 }
698
699 void RepeatedImmutableEnumFieldGenerator::
GenerateSerializationCode(io::Printer * printer) const700 GenerateSerializationCode(io::Printer* printer) const {
701 if (descriptor_->options().packed()) {
702 printer->Print(variables_,
703 "if (get$capitalized_name$List().size() > 0) {\n"
704 " output.writeRawVarint32($tag$);\n"
705 " output.writeRawVarint32($name$MemoizedSerializedSize);\n"
706 "}\n"
707 "for (int i = 0; i < $name$_.size(); i++) {\n"
708 " output.writeEnumNoTag($name$_.get(i).getNumber());\n"
709 "}\n");
710 } else {
711 printer->Print(variables_,
712 "for (int i = 0; i < $name$_.size(); i++) {\n"
713 " output.writeEnum($number$, $name$_.get(i).getNumber());\n"
714 "}\n");
715 }
716 }
717
718 void RepeatedImmutableEnumFieldGenerator::
GenerateSerializedSizeCode(io::Printer * printer) const719 GenerateSerializedSizeCode(io::Printer* printer) const {
720 printer->Print(variables_,
721 "{\n"
722 " int dataSize = 0;\n");
723 printer->Indent();
724
725 printer->Print(variables_,
726 "for (int i = 0; i < $name$_.size(); i++) {\n"
727 " dataSize += com.google.protobuf.CodedOutputStream\n"
728 " .computeEnumSizeNoTag($name$_.get(i).getNumber());\n"
729 "}\n");
730 printer->Print(
731 "size += dataSize;\n");
732 if (descriptor_->options().packed()) {
733 printer->Print(variables_,
734 "if (!get$capitalized_name$List().isEmpty()) {"
735 " size += $tag_size$;\n"
736 " size += com.google.protobuf.CodedOutputStream\n"
737 " .computeRawVarint32Size(dataSize);\n"
738 "}");
739 } else {
740 printer->Print(variables_,
741 "size += $tag_size$ * $name$_.size();\n");
742 }
743
744 // cache the data size for packed fields.
745 if (descriptor_->options().packed()) {
746 printer->Print(variables_,
747 "$name$MemoizedSerializedSize = dataSize;\n");
748 }
749
750 printer->Outdent();
751 printer->Print("}\n");
752 }
753
754 void RepeatedImmutableEnumFieldGenerator::
GenerateEqualsCode(io::Printer * printer) const755 GenerateEqualsCode(io::Printer* printer) const {
756 printer->Print(variables_,
757 "result = result && get$capitalized_name$List()\n"
758 " .equals(other.get$capitalized_name$List());\n");
759 }
760
761 void RepeatedImmutableEnumFieldGenerator::
GenerateHashCode(io::Printer * printer) const762 GenerateHashCode(io::Printer* printer) const {
763 printer->Print(variables_,
764 "if (get$capitalized_name$Count() > 0) {\n"
765 " hash = (37 * hash) + $constant_name$;\n"
766 " hash = (53 * hash) + com.google.protobuf.Internal.hashEnumList(\n"
767 " get$capitalized_name$List());\n"
768 "}\n");
769 }
770
GetBoxedType() const771 string RepeatedImmutableEnumFieldGenerator::GetBoxedType() const {
772 return name_resolver_->GetImmutableClassName(descriptor_->enum_type());
773 }
774
775 } // namespace java
776 } // namespace compiler
777 } // namespace protobuf
778 } // namespace google
779