Line data Source code
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/logging.h>
39 : #include <google/protobuf/stubs/common.h>
40 : #include <google/protobuf/compiler/java/java_context.h>
41 : #include <google/protobuf/compiler/java/java_doc_comment.h>
42 : #include <google/protobuf/compiler/java/java_helpers.h>
43 : #include <google/protobuf/compiler/java/java_name_resolver.h>
44 : #include <google/protobuf/compiler/java/java_primitive_field.h>
45 : #include <google/protobuf/io/printer.h>
46 : #include <google/protobuf/wire_format.h>
47 : #include <google/protobuf/stubs/strutil.h>
48 :
49 : namespace google {
50 : namespace protobuf {
51 : namespace compiler {
52 : namespace java {
53 :
54 : using internal::WireFormat;
55 : using internal::WireFormatLite;
56 :
57 : namespace {
58 :
59 0 : void SetPrimitiveVariables(const FieldDescriptor* descriptor,
60 : int messageBitIndex,
61 : int builderBitIndex,
62 : const FieldGeneratorInfo* info,
63 : ClassNameResolver* name_resolver,
64 : map<string, string>* variables) {
65 0 : SetCommonFieldVariables(descriptor, info, variables);
66 :
67 0 : (*variables)["type"] = PrimitiveTypeName(GetJavaType(descriptor));
68 0 : (*variables)["boxed_type"] = BoxedPrimitiveTypeName(GetJavaType(descriptor));
69 0 : (*variables)["field_type"] = (*variables)["type"];
70 0 : (*variables)["field_list_type"] = "java.util.List<" +
71 0 : (*variables)["boxed_type"] + ">";
72 0 : (*variables)["empty_list"] = "java.util.Collections.emptyList()";
73 0 : (*variables)["default"] = ImmutableDefaultValue(descriptor, name_resolver);
74 0 : (*variables)["default_init"] = IsDefaultValueJavaDefault(descriptor) ?
75 0 : "" : ("= " + ImmutableDefaultValue(descriptor, name_resolver));
76 0 : (*variables)["capitalized_type"] =
77 : GetCapitalizedType(descriptor, /* immutable = */ true);
78 0 : if (descriptor->is_packed()) {
79 0 : (*variables)["tag"] = SimpleItoa(WireFormatLite::MakeTag(
80 : descriptor->number(), WireFormatLite::WIRETYPE_LENGTH_DELIMITED));
81 : } else {
82 0 : (*variables)["tag"] = SimpleItoa(WireFormat::MakeTag(descriptor));
83 : }
84 0 : (*variables)["tag_size"] = SimpleItoa(
85 : WireFormat::TagSize(descriptor->number(), GetType(descriptor)));
86 0 : if (IsReferenceType(GetJavaType(descriptor))) {
87 0 : (*variables)["null_check"] =
88 : " if (value == null) {\n"
89 : " throw new NullPointerException();\n"
90 : " }\n";
91 : } else {
92 0 : (*variables)["null_check"] = "";
93 : }
94 : // TODO(birdo): Add @deprecated javadoc when generating javadoc is supported
95 : // by the proto compiler
96 0 : (*variables)["deprecation"] = descriptor->options().deprecated()
97 : ? "@java.lang.Deprecated " : "";
98 0 : int fixed_size = FixedSize(GetType(descriptor));
99 0 : if (fixed_size != -1) {
100 0 : (*variables)["fixed_size"] = SimpleItoa(fixed_size);
101 : }
102 0 : (*variables)["on_changed"] =
103 0 : HasDescriptorMethods(descriptor->containing_type()) ? "onChanged();" : "";
104 :
105 0 : if (SupportFieldPresence(descriptor->file())) {
106 : // For singular messages and builders, one bit is used for the hasField bit.
107 0 : (*variables)["get_has_field_bit_message"] = GenerateGetBit(messageBitIndex);
108 0 : (*variables)["get_has_field_bit_builder"] = GenerateGetBit(builderBitIndex);
109 :
110 : // Note that these have a trailing ";".
111 0 : (*variables)["set_has_field_bit_message"] =
112 0 : GenerateSetBit(messageBitIndex) + ";";
113 0 : (*variables)["set_has_field_bit_builder"] =
114 0 : GenerateSetBit(builderBitIndex) + ";";
115 0 : (*variables)["clear_has_field_bit_builder"] =
116 0 : GenerateClearBit(builderBitIndex) + ";";
117 :
118 0 : (*variables)["is_field_present_message"] = GenerateGetBit(messageBitIndex);
119 : } else {
120 0 : (*variables)["set_has_field_bit_message"] = "";
121 0 : (*variables)["set_has_field_bit_builder"] = "";
122 0 : (*variables)["clear_has_field_bit_builder"] = "";
123 :
124 0 : if (descriptor->type() == FieldDescriptor::TYPE_BYTES) {
125 0 : (*variables)["is_field_present_message"] =
126 0 : "!" + (*variables)["name"] + "_.isEmpty()";
127 : } else {
128 0 : (*variables)["is_field_present_message"] =
129 0 : (*variables)["name"] + "_ != " + (*variables)["default"];
130 : }
131 : }
132 :
133 : // For repated builders, one bit is used for whether the array is immutable.
134 0 : (*variables)["get_mutable_bit_builder"] = GenerateGetBit(builderBitIndex);
135 0 : (*variables)["set_mutable_bit_builder"] = GenerateSetBit(builderBitIndex);
136 0 : (*variables)["clear_mutable_bit_builder"] = GenerateClearBit(builderBitIndex);
137 :
138 : // For repeated fields, one bit is used for whether the array is immutable
139 : // in the parsing constructor.
140 0 : (*variables)["get_mutable_bit_parser"] =
141 : GenerateGetBitMutableLocal(builderBitIndex);
142 0 : (*variables)["set_mutable_bit_parser"] =
143 : GenerateSetBitMutableLocal(builderBitIndex);
144 :
145 0 : (*variables)["get_has_field_bit_from_local"] =
146 : GenerateGetBitFromLocal(builderBitIndex);
147 0 : (*variables)["set_has_field_bit_to_local"] =
148 : GenerateSetBitToLocal(messageBitIndex);
149 0 : }
150 :
151 : } // namespace
152 :
153 : // ===================================================================
154 :
155 0 : ImmutablePrimitiveFieldGenerator::
156 : ImmutablePrimitiveFieldGenerator(const FieldDescriptor* descriptor,
157 : int messageBitIndex,
158 : int builderBitIndex,
159 : Context* context)
160 : : descriptor_(descriptor), messageBitIndex_(messageBitIndex),
161 : builderBitIndex_(builderBitIndex), context_(context),
162 0 : name_resolver_(context->GetNameResolver()) {
163 : SetPrimitiveVariables(descriptor, messageBitIndex, builderBitIndex,
164 : context->GetFieldGeneratorInfo(descriptor),
165 0 : name_resolver_, &variables_);
166 0 : }
167 :
168 0 : ImmutablePrimitiveFieldGenerator::~ImmutablePrimitiveFieldGenerator() {}
169 :
170 0 : int ImmutablePrimitiveFieldGenerator::GetNumBitsForMessage() const {
171 0 : return 1;
172 : }
173 :
174 0 : int ImmutablePrimitiveFieldGenerator::GetNumBitsForBuilder() const {
175 0 : return 1;
176 : }
177 :
178 0 : void ImmutablePrimitiveFieldGenerator::
179 : GenerateInterfaceMembers(io::Printer* printer) const {
180 0 : if (SupportFieldPresence(descriptor_->file())) {
181 0 : WriteFieldDocComment(printer, descriptor_);
182 : printer->Print(variables_,
183 0 : "$deprecation$boolean has$capitalized_name$();\n");
184 : }
185 0 : WriteFieldDocComment(printer, descriptor_);
186 : printer->Print(variables_,
187 0 : "$deprecation$$type$ get$capitalized_name$();\n");
188 0 : }
189 :
190 0 : void ImmutablePrimitiveFieldGenerator::
191 : GenerateMembers(io::Printer* printer) const {
192 : printer->Print(variables_,
193 0 : "private $field_type$ $name$_;\n");
194 0 : PrintExtraFieldInfo(variables_, printer);
195 0 : if (SupportFieldPresence(descriptor_->file())) {
196 0 : WriteFieldDocComment(printer, descriptor_);
197 : printer->Print(variables_,
198 : "$deprecation$public boolean has$capitalized_name$() {\n"
199 : " return $get_has_field_bit_message$;\n"
200 0 : "}\n");
201 : }
202 :
203 0 : WriteFieldDocComment(printer, descriptor_);
204 : printer->Print(variables_,
205 : "$deprecation$public $type$ get$capitalized_name$() {\n"
206 : " return $name$_;\n"
207 0 : "}\n");
208 0 : }
209 :
210 0 : void ImmutablePrimitiveFieldGenerator::
211 : GenerateBuilderMembers(io::Printer* printer) const {
212 : printer->Print(variables_,
213 0 : "private $field_type$ $name$_ $default_init$;\n");
214 :
215 0 : if (SupportFieldPresence(descriptor_->file())) {
216 0 : WriteFieldDocComment(printer, descriptor_);
217 : printer->Print(variables_,
218 : "$deprecation$public boolean has$capitalized_name$() {\n"
219 : " return $get_has_field_bit_builder$;\n"
220 0 : "}\n");
221 : }
222 :
223 0 : WriteFieldDocComment(printer, descriptor_);
224 : printer->Print(variables_,
225 : "$deprecation$public $type$ get$capitalized_name$() {\n"
226 : " return $name$_;\n"
227 0 : "}\n");
228 :
229 0 : WriteFieldDocComment(printer, descriptor_);
230 : printer->Print(variables_,
231 : "$deprecation$public Builder set$capitalized_name$($type$ value) {\n"
232 : "$null_check$"
233 : " $set_has_field_bit_builder$\n"
234 : " $name$_ = value;\n"
235 : " $on_changed$\n"
236 : " return this;\n"
237 0 : "}\n");
238 :
239 0 : WriteFieldDocComment(printer, descriptor_);
240 : printer->Print(variables_,
241 : "$deprecation$public Builder clear$capitalized_name$() {\n"
242 0 : " $clear_has_field_bit_builder$\n");
243 0 : JavaType type = GetJavaType(descriptor_);
244 0 : if (type == JAVATYPE_STRING || type == JAVATYPE_BYTES) {
245 : // The default value is not a simple literal so we want to avoid executing
246 : // it multiple times. Instead, get the default out of the default instance.
247 : printer->Print(variables_,
248 0 : " $name$_ = getDefaultInstance().get$capitalized_name$();\n");
249 : } else {
250 : printer->Print(variables_,
251 0 : " $name$_ = $default$;\n");
252 : }
253 : printer->Print(variables_,
254 : " $on_changed$\n"
255 : " return this;\n"
256 0 : "}\n");
257 0 : }
258 :
259 0 : void ImmutablePrimitiveFieldGenerator::
260 : GenerateFieldBuilderInitializationCode(io::Printer* printer) const {
261 : // noop for primitives
262 0 : }
263 :
264 0 : void ImmutablePrimitiveFieldGenerator::
265 : GenerateInitializationCode(io::Printer* printer) const {
266 0 : printer->Print(variables_, "$name$_ = $default$;\n");
267 0 : }
268 :
269 0 : void ImmutablePrimitiveFieldGenerator::
270 : GenerateBuilderClearCode(io::Printer* printer) const {
271 : printer->Print(variables_,
272 : "$name$_ = $default$;\n"
273 0 : "$clear_has_field_bit_builder$\n");
274 0 : }
275 :
276 0 : void ImmutablePrimitiveFieldGenerator::
277 : GenerateMergingCode(io::Printer* printer) const {
278 0 : if (SupportFieldPresence(descriptor_->file())) {
279 : printer->Print(variables_,
280 : "if (other.has$capitalized_name$()) {\n"
281 : " set$capitalized_name$(other.get$capitalized_name$());\n"
282 0 : "}\n");
283 : } else {
284 : printer->Print(variables_,
285 : "if (other.get$capitalized_name$() != $default$) {\n"
286 : " set$capitalized_name$(other.get$capitalized_name$());\n"
287 0 : "}\n");
288 : }
289 0 : }
290 :
291 0 : void ImmutablePrimitiveFieldGenerator::
292 : GenerateBuildingCode(io::Printer* printer) const {
293 0 : if (SupportFieldPresence(descriptor_->file())) {
294 : printer->Print(variables_,
295 : "if ($get_has_field_bit_from_local$) {\n"
296 : " $set_has_field_bit_to_local$;\n"
297 0 : "}\n");
298 : }
299 : printer->Print(variables_,
300 0 : "result.$name$_ = $name$_;\n");
301 0 : }
302 :
303 0 : void ImmutablePrimitiveFieldGenerator::
304 : GenerateParsingCode(io::Printer* printer) const {
305 : printer->Print(variables_,
306 : "$set_has_field_bit_message$\n"
307 0 : "$name$_ = input.read$capitalized_type$();\n");
308 0 : }
309 :
310 0 : void ImmutablePrimitiveFieldGenerator::
311 : GenerateParsingDoneCode(io::Printer* printer) const {
312 : // noop for primitives.
313 0 : }
314 :
315 0 : void ImmutablePrimitiveFieldGenerator::
316 : GenerateSerializationCode(io::Printer* printer) const {
317 : printer->Print(variables_,
318 : "if ($is_field_present_message$) {\n"
319 : " output.write$capitalized_type$($number$, $name$_);\n"
320 0 : "}\n");
321 0 : }
322 :
323 0 : void ImmutablePrimitiveFieldGenerator::
324 : GenerateSerializedSizeCode(io::Printer* printer) const {
325 : printer->Print(variables_,
326 : "if ($is_field_present_message$) {\n"
327 : " size += com.google.protobuf.CodedOutputStream\n"
328 : " .compute$capitalized_type$Size($number$, $name$_);\n"
329 0 : "}\n");
330 0 : }
331 :
332 0 : void ImmutablePrimitiveFieldGenerator::
333 : GenerateEqualsCode(io::Printer* printer) const {
334 0 : switch (GetJavaType(descriptor_)) {
335 : case JAVATYPE_INT:
336 : case JAVATYPE_LONG:
337 : case JAVATYPE_BOOLEAN:
338 : printer->Print(variables_,
339 : "result = result && (get$capitalized_name$()\n"
340 0 : " == other.get$capitalized_name$());\n");
341 0 : break;
342 :
343 : case JAVATYPE_FLOAT:
344 : printer->Print(variables_,
345 : "result = result && (\n"
346 : " java.lang.Float.floatToIntBits(get$capitalized_name$())\n"
347 : " == java.lang.Float.floatToIntBits(\n"
348 0 : " other.get$capitalized_name$()));\n");
349 0 : break;
350 :
351 : case JAVATYPE_DOUBLE:
352 : printer->Print(variables_,
353 : "result = result && (\n"
354 : " java.lang.Double.doubleToLongBits(get$capitalized_name$())\n"
355 : " == java.lang.Double.doubleToLongBits(\n"
356 0 : " other.get$capitalized_name$()));\n");
357 0 : break;
358 :
359 : case JAVATYPE_STRING:
360 : case JAVATYPE_BYTES:
361 : printer->Print(variables_,
362 : "result = result && get$capitalized_name$()\n"
363 0 : " .equals(other.get$capitalized_name$());\n");
364 0 : break;
365 :
366 : case JAVATYPE_ENUM:
367 : case JAVATYPE_MESSAGE:
368 : default:
369 0 : GOOGLE_LOG(FATAL) << "Can't get here.";
370 0 : break;
371 : }
372 0 : }
373 :
374 0 : void ImmutablePrimitiveFieldGenerator::
375 : GenerateHashCode(io::Printer* printer) const {
376 : printer->Print(variables_,
377 0 : "hash = (37 * hash) + $constant_name$;\n");
378 0 : switch (GetJavaType(descriptor_)) {
379 : case JAVATYPE_INT:
380 : printer->Print(variables_,
381 0 : "hash = (53 * hash) + get$capitalized_name$();\n");
382 0 : break;
383 :
384 : case JAVATYPE_LONG:
385 : printer->Print(variables_,
386 : "hash = (53 * hash) + com.google.protobuf.Internal.hashLong(\n"
387 0 : " get$capitalized_name$());\n");
388 0 : break;
389 :
390 : case JAVATYPE_BOOLEAN:
391 : printer->Print(variables_,
392 : "hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(\n"
393 0 : " get$capitalized_name$());\n");
394 0 : break;
395 :
396 : case JAVATYPE_FLOAT:
397 : printer->Print(variables_,
398 : "hash = (53 * hash) + java.lang.Float.floatToIntBits(\n"
399 0 : " get$capitalized_name$());\n");
400 0 : break;
401 :
402 : case JAVATYPE_DOUBLE:
403 : printer->Print(variables_,
404 : "hash = (53 * hash) + com.google.protobuf.Internal.hashLong(\n"
405 0 : " java.lang.Double.doubleToLongBits(get$capitalized_name$()));\n");
406 0 : break;
407 :
408 : case JAVATYPE_STRING:
409 : case JAVATYPE_BYTES:
410 : printer->Print(variables_,
411 0 : "hash = (53 * hash) + get$capitalized_name$().hashCode();\n");
412 0 : break;
413 :
414 : case JAVATYPE_ENUM:
415 : case JAVATYPE_MESSAGE:
416 : default:
417 0 : GOOGLE_LOG(FATAL) << "Can't get here.";
418 0 : break;
419 : }
420 0 : }
421 :
422 0 : string ImmutablePrimitiveFieldGenerator::GetBoxedType() const {
423 0 : return BoxedPrimitiveTypeName(GetJavaType(descriptor_));
424 : }
425 :
426 : // ===================================================================
427 :
428 0 : ImmutablePrimitiveOneofFieldGenerator::
429 0 : ImmutablePrimitiveOneofFieldGenerator(const FieldDescriptor* descriptor,
430 : int messageBitIndex,
431 : int builderBitIndex,
432 : Context* context)
433 : : ImmutablePrimitiveFieldGenerator(
434 0 : descriptor, messageBitIndex, builderBitIndex, context) {
435 : const OneofGeneratorInfo* info =
436 0 : context->GetOneofGeneratorInfo(descriptor->containing_oneof());
437 0 : SetCommonOneofVariables(descriptor, info, &variables_);
438 0 : }
439 :
440 0 : ImmutablePrimitiveOneofFieldGenerator::
441 0 : ~ImmutablePrimitiveOneofFieldGenerator() {}
442 :
443 0 : void ImmutablePrimitiveOneofFieldGenerator::
444 : GenerateMembers(io::Printer* printer) const {
445 0 : PrintExtraFieldInfo(variables_, printer);
446 0 : if (SupportFieldPresence(descriptor_->file())) {
447 0 : WriteFieldDocComment(printer, descriptor_);
448 : printer->Print(variables_,
449 : "$deprecation$public boolean has$capitalized_name$() {\n"
450 : " return $has_oneof_case_message$;\n"
451 0 : "}\n");
452 : }
453 :
454 0 : WriteFieldDocComment(printer, descriptor_);
455 : printer->Print(variables_,
456 : "$deprecation$public $type$ get$capitalized_name$() {\n"
457 : " if ($has_oneof_case_message$) {\n"
458 : " return ($boxed_type$) $oneof_name$_;\n"
459 : " }\n"
460 : " return $default$;\n"
461 0 : "}\n");
462 0 : }
463 :
464 :
465 0 : void ImmutablePrimitiveOneofFieldGenerator::
466 : GenerateBuilderMembers(io::Printer* printer) const {
467 0 : if (SupportFieldPresence(descriptor_->file())) {
468 0 : WriteFieldDocComment(printer, descriptor_);
469 : printer->Print(variables_,
470 : "$deprecation$public boolean has$capitalized_name$() {\n"
471 : " return $has_oneof_case_message$;\n"
472 0 : "}\n");
473 : }
474 :
475 0 : WriteFieldDocComment(printer, descriptor_);
476 : printer->Print(variables_,
477 : "$deprecation$public $type$ get$capitalized_name$() {\n"
478 : " if ($has_oneof_case_message$) {\n"
479 : " return ($boxed_type$) $oneof_name$_;\n"
480 : " }\n"
481 : " return $default$;\n"
482 0 : "}\n");
483 :
484 0 : WriteFieldDocComment(printer, descriptor_);
485 : printer->Print(variables_,
486 : "$deprecation$public Builder set$capitalized_name$($type$ value) {\n"
487 : "$null_check$"
488 : " $set_oneof_case_message$;\n"
489 : " $oneof_name$_ = value;\n"
490 : " $on_changed$\n"
491 : " return this;\n"
492 0 : "}\n");
493 :
494 0 : WriteFieldDocComment(printer, descriptor_);
495 : printer->Print(variables_,
496 : "$deprecation$public Builder clear$capitalized_name$() {\n"
497 : " if ($has_oneof_case_message$) {\n"
498 : " $clear_oneof_case_message$;\n"
499 : " $oneof_name$_ = null;\n"
500 : " $on_changed$\n"
501 : " }\n"
502 : " return this;\n"
503 0 : "}\n");
504 0 : }
505 :
506 0 : void ImmutablePrimitiveOneofFieldGenerator::
507 : GenerateBuildingCode(io::Printer* printer) const {
508 : printer->Print(variables_,
509 : "if ($has_oneof_case_message$) {\n"
510 : " result.$oneof_name$_ = $oneof_name$_;\n"
511 0 : "}\n");
512 0 : }
513 :
514 0 : void ImmutablePrimitiveOneofFieldGenerator::
515 : GenerateMergingCode(io::Printer* printer) const {
516 : printer->Print(variables_,
517 0 : "set$capitalized_name$(other.get$capitalized_name$());\n");
518 0 : }
519 :
520 0 : void ImmutablePrimitiveOneofFieldGenerator::
521 : GenerateParsingCode(io::Printer* printer) const {
522 : printer->Print(variables_,
523 : "$set_oneof_case_message$;\n"
524 0 : "$oneof_name$_ = input.read$capitalized_type$();\n");
525 0 : }
526 :
527 0 : void ImmutablePrimitiveOneofFieldGenerator::
528 : GenerateSerializationCode(io::Printer* printer) const {
529 : printer->Print(variables_,
530 : "if ($has_oneof_case_message$) {\n"
531 : " output.write$capitalized_type$(\n"
532 : " $number$, ($type$)(($boxed_type$) $oneof_name$_));\n"
533 0 : "}\n");
534 0 : }
535 :
536 0 : void ImmutablePrimitiveOneofFieldGenerator::
537 : GenerateSerializedSizeCode(io::Printer* printer) const {
538 : printer->Print(variables_,
539 : "if ($has_oneof_case_message$) {\n"
540 : " size += com.google.protobuf.CodedOutputStream\n"
541 : " .compute$capitalized_type$Size(\n"
542 : " $number$, ($type$)(($boxed_type$) $oneof_name$_));\n"
543 0 : "}\n");
544 0 : }
545 :
546 : // ===================================================================
547 :
548 0 : RepeatedImmutablePrimitiveFieldGenerator::
549 : RepeatedImmutablePrimitiveFieldGenerator(const FieldDescriptor* descriptor,
550 : int messageBitIndex,
551 : int builderBitIndex,
552 : Context* context)
553 : : descriptor_(descriptor), messageBitIndex_(messageBitIndex),
554 : builderBitIndex_(builderBitIndex), context_(context),
555 0 : name_resolver_(context->GetNameResolver()) {
556 : SetPrimitiveVariables(descriptor, messageBitIndex, builderBitIndex,
557 : context->GetFieldGeneratorInfo(descriptor),
558 0 : name_resolver_, &variables_);
559 0 : }
560 :
561 0 : RepeatedImmutablePrimitiveFieldGenerator::
562 0 : ~RepeatedImmutablePrimitiveFieldGenerator() {}
563 :
564 0 : int RepeatedImmutablePrimitiveFieldGenerator::GetNumBitsForMessage() const {
565 0 : return 0;
566 : }
567 :
568 0 : int RepeatedImmutablePrimitiveFieldGenerator::GetNumBitsForBuilder() const {
569 0 : return 1;
570 : }
571 :
572 0 : void RepeatedImmutablePrimitiveFieldGenerator::
573 : GenerateInterfaceMembers(io::Printer* printer) const {
574 0 : WriteFieldDocComment(printer, descriptor_);
575 : printer->Print(variables_,
576 0 : "$deprecation$java.util.List<$boxed_type$> get$capitalized_name$List();\n");
577 0 : WriteFieldDocComment(printer, descriptor_);
578 : printer->Print(variables_,
579 0 : "$deprecation$int get$capitalized_name$Count();\n");
580 0 : WriteFieldDocComment(printer, descriptor_);
581 : printer->Print(variables_,
582 0 : "$deprecation$$type$ get$capitalized_name$(int index);\n");
583 0 : }
584 :
585 :
586 0 : void RepeatedImmutablePrimitiveFieldGenerator::
587 : GenerateMembers(io::Printer* printer) const {
588 : printer->Print(variables_,
589 0 : "private $field_list_type$ $name$_;\n");
590 0 : PrintExtraFieldInfo(variables_, printer);
591 0 : WriteFieldDocComment(printer, descriptor_);
592 : printer->Print(variables_,
593 : "$deprecation$public java.util.List<$boxed_type$>\n"
594 : " get$capitalized_name$List() {\n"
595 : " return $name$_;\n" // note: unmodifiable list
596 0 : "}\n");
597 0 : WriteFieldDocComment(printer, descriptor_);
598 : printer->Print(variables_,
599 : "$deprecation$public int get$capitalized_name$Count() {\n"
600 : " return $name$_.size();\n"
601 0 : "}\n");
602 0 : WriteFieldDocComment(printer, descriptor_);
603 : printer->Print(variables_,
604 : "$deprecation$public $type$ get$capitalized_name$(int index) {\n"
605 : " return $name$_.get(index);\n"
606 0 : "}\n");
607 :
608 0 : if (descriptor_->is_packed() &&
609 0 : HasGeneratedMethods(descriptor_->containing_type())) {
610 : printer->Print(variables_,
611 0 : "private int $name$MemoizedSerializedSize = -1;\n");
612 : }
613 0 : }
614 :
615 0 : void RepeatedImmutablePrimitiveFieldGenerator::
616 : GenerateBuilderMembers(io::Printer* printer) const {
617 : // One field is the list and the bit field keeps track of whether the
618 : // list is immutable. If it's immutable, the invariant is that it must
619 : // either an instance of Collections.emptyList() or it's an ArrayList
620 : // wrapped in a Collections.unmodifiableList() wrapper and nobody else has
621 : // a refererence to the underlying ArrayList. This invariant allows us to
622 : // share instances of lists between protocol buffers avoiding expensive
623 : // memory allocations. Note, immutable is a strong guarantee here -- not
624 : // just that the list cannot be modified via the reference but that the
625 : // list can never be modified.
626 : printer->Print(variables_,
627 0 : "private $field_list_type$ $name$_ = $empty_list$;\n");
628 :
629 : printer->Print(variables_,
630 : "private void ensure$capitalized_name$IsMutable() {\n"
631 : " if (!$get_mutable_bit_builder$) {\n"
632 : " $name$_ = new java.util.ArrayList<$boxed_type$>($name$_);\n"
633 : " $set_mutable_bit_builder$;\n"
634 : " }\n"
635 0 : "}\n");
636 :
637 : // Note: We return an unmodifiable list because otherwise the caller
638 : // could hold on to the returned list and modify it after the message
639 : // has been built, thus mutating the message which is supposed to be
640 : // immutable.
641 0 : WriteFieldDocComment(printer, descriptor_);
642 : printer->Print(variables_,
643 : "$deprecation$public java.util.List<$boxed_type$>\n"
644 : " get$capitalized_name$List() {\n"
645 : " return java.util.Collections.unmodifiableList($name$_);\n"
646 0 : "}\n");
647 0 : WriteFieldDocComment(printer, descriptor_);
648 : printer->Print(variables_,
649 : "$deprecation$public int get$capitalized_name$Count() {\n"
650 : " return $name$_.size();\n"
651 0 : "}\n");
652 0 : WriteFieldDocComment(printer, descriptor_);
653 : printer->Print(variables_,
654 : "$deprecation$public $type$ get$capitalized_name$(int index) {\n"
655 : " return $name$_.get(index);\n"
656 0 : "}\n");
657 0 : WriteFieldDocComment(printer, descriptor_);
658 : printer->Print(variables_,
659 : "$deprecation$public Builder set$capitalized_name$(\n"
660 : " int index, $type$ value) {\n"
661 : "$null_check$"
662 : " ensure$capitalized_name$IsMutable();\n"
663 : " $name$_.set(index, value);\n"
664 : " $on_changed$\n"
665 : " return this;\n"
666 0 : "}\n");
667 0 : WriteFieldDocComment(printer, descriptor_);
668 : printer->Print(variables_,
669 : "$deprecation$public Builder add$capitalized_name$($type$ value) {\n"
670 : "$null_check$"
671 : " ensure$capitalized_name$IsMutable();\n"
672 : " $name$_.add(value);\n"
673 : " $on_changed$\n"
674 : " return this;\n"
675 0 : "}\n");
676 0 : WriteFieldDocComment(printer, descriptor_);
677 : printer->Print(variables_,
678 : "$deprecation$public Builder addAll$capitalized_name$(\n"
679 : " java.lang.Iterable<? extends $boxed_type$> values) {\n"
680 : " ensure$capitalized_name$IsMutable();\n"
681 : " com.google.protobuf.AbstractMessageLite.Builder.addAll(\n"
682 : " values, $name$_);\n"
683 : " $on_changed$\n"
684 : " return this;\n"
685 0 : "}\n");
686 0 : WriteFieldDocComment(printer, descriptor_);
687 : printer->Print(variables_,
688 : "$deprecation$public Builder clear$capitalized_name$() {\n"
689 : " $name$_ = $empty_list$;\n"
690 : " $clear_mutable_bit_builder$;\n"
691 : " $on_changed$\n"
692 : " return this;\n"
693 0 : "}\n");
694 0 : }
695 :
696 0 : void RepeatedImmutablePrimitiveFieldGenerator::
697 : GenerateFieldBuilderInitializationCode(io::Printer* printer) const {
698 : // noop for primitives
699 0 : }
700 :
701 0 : void RepeatedImmutablePrimitiveFieldGenerator::
702 : GenerateInitializationCode(io::Printer* printer) const {
703 0 : printer->Print(variables_, "$name$_ = $empty_list$;\n");
704 0 : }
705 :
706 0 : void RepeatedImmutablePrimitiveFieldGenerator::
707 : GenerateBuilderClearCode(io::Printer* printer) const {
708 : printer->Print(variables_,
709 : "$name$_ = $empty_list$;\n"
710 0 : "$clear_mutable_bit_builder$;\n");
711 0 : }
712 :
713 0 : void RepeatedImmutablePrimitiveFieldGenerator::
714 : GenerateMergingCode(io::Printer* printer) const {
715 : // The code below does two optimizations:
716 : // 1. If the other list is empty, there's nothing to do. This ensures we
717 : // don't allocate a new array if we already have an immutable one.
718 : // 2. If the other list is non-empty and our current list is empty, we can
719 : // reuse the other list which is guaranteed to be immutable.
720 : printer->Print(variables_,
721 : "if (!other.$name$_.isEmpty()) {\n"
722 : " if ($name$_.isEmpty()) {\n"
723 : " $name$_ = other.$name$_;\n"
724 : " $clear_mutable_bit_builder$;\n"
725 : " } else {\n"
726 : " ensure$capitalized_name$IsMutable();\n"
727 : " $name$_.addAll(other.$name$_);\n"
728 : " }\n"
729 : " $on_changed$\n"
730 0 : "}\n");
731 0 : }
732 :
733 0 : void RepeatedImmutablePrimitiveFieldGenerator::
734 : GenerateBuildingCode(io::Printer* printer) const {
735 : // The code below ensures that the result has an immutable list. If our
736 : // list is immutable, we can just reuse it. If not, we make it immutable.
737 : printer->Print(variables_,
738 : "if ($get_mutable_bit_builder$) {\n"
739 : " $name$_ = java.util.Collections.unmodifiableList($name$_);\n"
740 : " $clear_mutable_bit_builder$;\n"
741 : "}\n"
742 0 : "result.$name$_ = $name$_;\n");
743 0 : }
744 :
745 0 : void RepeatedImmutablePrimitiveFieldGenerator::
746 : GenerateParsingCode(io::Printer* printer) const {
747 : printer->Print(variables_,
748 : "if (!$get_mutable_bit_parser$) {\n"
749 : " $name$_ = new java.util.ArrayList<$boxed_type$>();\n"
750 : " $set_mutable_bit_parser$;\n"
751 : "}\n"
752 0 : "$name$_.add(input.read$capitalized_type$());\n");
753 0 : }
754 :
755 0 : void RepeatedImmutablePrimitiveFieldGenerator::
756 : GenerateParsingCodeFromPacked(io::Printer* printer) const {
757 : printer->Print(variables_,
758 : "int length = input.readRawVarint32();\n"
759 : "int limit = input.pushLimit(length);\n"
760 : "if (!$get_mutable_bit_parser$ && input.getBytesUntilLimit() > 0) {\n"
761 : " $name$_ = new java.util.ArrayList<$boxed_type$>();\n"
762 : " $set_mutable_bit_parser$;\n"
763 : "}\n"
764 : "while (input.getBytesUntilLimit() > 0) {\n"
765 : " $name$_.add(input.read$capitalized_type$());\n"
766 : "}\n"
767 0 : "input.popLimit(limit);\n");
768 0 : }
769 :
770 0 : void RepeatedImmutablePrimitiveFieldGenerator::
771 : GenerateParsingDoneCode(io::Printer* printer) const {
772 : printer->Print(variables_,
773 : "if ($get_mutable_bit_parser$) {\n"
774 : " $name$_ = java.util.Collections.unmodifiableList($name$_);\n"
775 0 : "}\n");
776 0 : }
777 :
778 0 : void RepeatedImmutablePrimitiveFieldGenerator::
779 : GenerateSerializationCode(io::Printer* printer) const {
780 0 : if (descriptor_->is_packed()) {
781 : // We invoke getSerializedSize in writeTo for messages that have packed
782 : // fields in ImmutableMessageGenerator::GenerateMessageSerializationMethods.
783 : // That makes it safe to rely on the memoized size here.
784 : printer->Print(variables_,
785 : "if (get$capitalized_name$List().size() > 0) {\n"
786 : " output.writeRawVarint32($tag$);\n"
787 : " output.writeRawVarint32($name$MemoizedSerializedSize);\n"
788 : "}\n"
789 : "for (int i = 0; i < $name$_.size(); i++) {\n"
790 : " output.write$capitalized_type$NoTag($name$_.get(i));\n"
791 0 : "}\n");
792 : } else {
793 : printer->Print(variables_,
794 : "for (int i = 0; i < $name$_.size(); i++) {\n"
795 : " output.write$capitalized_type$($number$, $name$_.get(i));\n"
796 0 : "}\n");
797 : }
798 0 : }
799 :
800 0 : void RepeatedImmutablePrimitiveFieldGenerator::
801 : GenerateSerializedSizeCode(io::Printer* printer) const {
802 : printer->Print(variables_,
803 : "{\n"
804 0 : " int dataSize = 0;\n");
805 0 : printer->Indent();
806 :
807 0 : if (FixedSize(GetType(descriptor_)) == -1) {
808 : printer->Print(variables_,
809 : "for (int i = 0; i < $name$_.size(); i++) {\n"
810 : " dataSize += com.google.protobuf.CodedOutputStream\n"
811 : " .compute$capitalized_type$SizeNoTag($name$_.get(i));\n"
812 0 : "}\n");
813 : } else {
814 : printer->Print(variables_,
815 0 : "dataSize = $fixed_size$ * get$capitalized_name$List().size();\n");
816 : }
817 :
818 : printer->Print(
819 0 : "size += dataSize;\n");
820 :
821 0 : if (descriptor_->is_packed()) {
822 : printer->Print(variables_,
823 : "if (!get$capitalized_name$List().isEmpty()) {\n"
824 : " size += $tag_size$;\n"
825 : " size += com.google.protobuf.CodedOutputStream\n"
826 : " .computeInt32SizeNoTag(dataSize);\n"
827 0 : "}\n");
828 : } else {
829 : printer->Print(variables_,
830 0 : "size += $tag_size$ * get$capitalized_name$List().size();\n");
831 : }
832 :
833 : // cache the data size for packed fields.
834 0 : if (descriptor_->is_packed()) {
835 : printer->Print(variables_,
836 0 : "$name$MemoizedSerializedSize = dataSize;\n");
837 : }
838 :
839 0 : printer->Outdent();
840 0 : printer->Print("}\n");
841 0 : }
842 :
843 0 : void RepeatedImmutablePrimitiveFieldGenerator::
844 : GenerateEqualsCode(io::Printer* printer) const {
845 : printer->Print(variables_,
846 : "result = result && get$capitalized_name$List()\n"
847 0 : " .equals(other.get$capitalized_name$List());\n");
848 0 : }
849 :
850 0 : void RepeatedImmutablePrimitiveFieldGenerator::
851 : GenerateHashCode(io::Printer* printer) const {
852 : printer->Print(variables_,
853 : "if (get$capitalized_name$Count() > 0) {\n"
854 : " hash = (37 * hash) + $constant_name$;\n"
855 : " hash = (53 * hash) + get$capitalized_name$List().hashCode();\n"
856 0 : "}\n");
857 0 : }
858 :
859 0 : string RepeatedImmutablePrimitiveFieldGenerator::GetBoxedType() const {
860 0 : return BoxedPrimitiveTypeName(GetJavaType(descriptor_));
861 : }
862 :
863 : } // namespace java
864 : } // namespace compiler
865 : } // namespace protobuf
866 : } // namespace google
|
