| // Protocol Buffers - Google's data interchange format |
| // Copyright 2008 Google Inc. All rights reserved. |
| // https://developers.google.com/protocol-buffers/ |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| // Author: kenton@google.com (Kenton Varda) |
| // Based on original Protocol Buffers design by |
| // Sanjay Ghemawat, Jeff Dean, and others. |
| |
| #include <google/protobuf/compiler/java/java_enum_field.h> |
| |
| #include <cstdint> |
| #include <map> |
| #include <string> |
| |
| #include <google/protobuf/stubs/logging.h> |
| #include <google/protobuf/stubs/common.h> |
| #include <google/protobuf/compiler/java/java_context.h> |
| #include <google/protobuf/compiler/java/java_doc_comment.h> |
| #include <google/protobuf/compiler/java/java_helpers.h> |
| #include <google/protobuf/compiler/java/java_name_resolver.h> |
| #include <google/protobuf/io/printer.h> |
| #include <google/protobuf/wire_format.h> |
| #include <google/protobuf/stubs/strutil.h> |
| |
| namespace google { |
| namespace protobuf { |
| namespace compiler { |
| namespace java { |
| |
| namespace { |
| |
| void SetEnumVariables(const FieldDescriptor* descriptor, int messageBitIndex, |
| int builderBitIndex, const FieldGeneratorInfo* info, |
| ClassNameResolver* name_resolver, |
| std::map<std::string, std::string>* variables) { |
| SetCommonFieldVariables(descriptor, info, variables); |
| |
| (*variables)["type"] = |
| name_resolver->GetImmutableClassName(descriptor->enum_type()); |
| (*variables)["mutable_type"] = |
| name_resolver->GetMutableClassName(descriptor->enum_type()); |
| (*variables)["default"] = ImmutableDefaultValue(descriptor, name_resolver); |
| (*variables)["default_number"] = |
| StrCat(descriptor->default_value_enum()->number()); |
| (*variables)["tag"] = StrCat( |
| static_cast<int32_t>(internal::WireFormat::MakeTag(descriptor))); |
| (*variables)["tag_size"] = StrCat( |
| internal::WireFormat::TagSize(descriptor->number(), GetType(descriptor))); |
| // TODO(birdo): Add @deprecated javadoc when generating javadoc is supported |
| // by the proto compiler |
| (*variables)["deprecation"] = |
| descriptor->options().deprecated() ? "@java.lang.Deprecated " : ""; |
| (*variables)["on_changed"] = "onChanged();"; |
| // Use deprecated valueOf() method to be compatible with old generated code |
| // for v2.5.0/v2.6.1. |
| // TODO(xiaofeng): Use "forNumber" when we no longer support compatibility |
| // with v2.5.0/v2.6.1, and remove the @SuppressWarnings annotations. |
| (*variables)["for_number"] = "valueOf"; |
| |
| if (HasHasbit(descriptor)) { |
| // For singular messages and builders, one bit is used for the hasField bit. |
| (*variables)["get_has_field_bit_message"] = GenerateGetBit(messageBitIndex); |
| (*variables)["get_has_field_bit_builder"] = GenerateGetBit(builderBitIndex); |
| |
| // Note that these have a trailing ";". |
| (*variables)["set_has_field_bit_message"] = |
| GenerateSetBit(messageBitIndex) + ";"; |
| (*variables)["set_has_field_bit_builder"] = |
| GenerateSetBit(builderBitIndex) + ";"; |
| (*variables)["clear_has_field_bit_builder"] = |
| GenerateClearBit(builderBitIndex) + ";"; |
| |
| (*variables)["is_field_present_message"] = GenerateGetBit(messageBitIndex); |
| } else { |
| (*variables)["set_has_field_bit_message"] = ""; |
| (*variables)["set_has_field_bit_builder"] = ""; |
| (*variables)["clear_has_field_bit_builder"] = ""; |
| |
| (*variables)["is_field_present_message"] = |
| (*variables)["name"] + "_ != " + (*variables)["default"] + |
| ".getNumber()"; |
| } |
| |
| // For repeated builders, one bit is used for whether the array is immutable. |
| (*variables)["get_mutable_bit_builder"] = GenerateGetBit(builderBitIndex); |
| (*variables)["set_mutable_bit_builder"] = GenerateSetBit(builderBitIndex); |
| (*variables)["clear_mutable_bit_builder"] = GenerateClearBit(builderBitIndex); |
| |
| // For repeated fields, one bit is used for whether the array is immutable |
| // in the parsing constructor. |
| (*variables)["get_mutable_bit_parser"] = |
| GenerateGetBitMutableLocal(builderBitIndex); |
| (*variables)["set_mutable_bit_parser"] = |
| GenerateSetBitMutableLocal(builderBitIndex); |
| |
| (*variables)["get_has_field_bit_from_local"] = |
| GenerateGetBitFromLocal(builderBitIndex); |
| (*variables)["set_has_field_bit_to_local"] = |
| GenerateSetBitToLocal(messageBitIndex); |
| |
| if (SupportUnknownEnumValue(descriptor->file())) { |
| (*variables)["unknown"] = (*variables)["type"] + ".UNRECOGNIZED"; |
| } else { |
| (*variables)["unknown"] = (*variables)["default"]; |
| } |
| } |
| |
| } // namespace |
| |
| // =================================================================== |
| |
| ImmutableEnumFieldGenerator::ImmutableEnumFieldGenerator( |
| const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex, |
| Context* context) |
| : descriptor_(descriptor), name_resolver_(context->GetNameResolver()) { |
| SetEnumVariables(descriptor, messageBitIndex, builderBitIndex, |
| context->GetFieldGeneratorInfo(descriptor), name_resolver_, |
| &variables_); |
| } |
| |
| ImmutableEnumFieldGenerator::~ImmutableEnumFieldGenerator() {} |
| |
| int ImmutableEnumFieldGenerator::GetNumBitsForMessage() const { |
| return HasHasbit(descriptor_) ? 1 : 0; |
| } |
| |
| int ImmutableEnumFieldGenerator::GetNumBitsForBuilder() const { |
| return GetNumBitsForMessage(); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateInterfaceMembers( |
| io::Printer* printer) const { |
| if (HasHazzer(descriptor_)) { |
| WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); |
| printer->Print(variables_, |
| "$deprecation$boolean has$capitalized_name$();\n"); |
| } |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "$deprecation$int get$capitalized_name$Value();\n"); |
| } |
| WriteFieldAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateMembers(io::Printer* printer) const { |
| printer->Print(variables_, "private int $name$_;\n"); |
| PrintExtraFieldInfo(variables_, printer); |
| if (HasHazzer(descriptor_)) { |
| WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); |
| printer->Print(variables_, |
| "@java.lang.Override $deprecation$public boolean " |
| "${$has$capitalized_name$$}$() {\n" |
| " return $get_has_field_bit_message$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override $deprecation$public int " |
| "${$get$capitalized_name$Value$}$() {\n" |
| " return $name$_;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| WriteFieldAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override $deprecation$public $type$ " |
| "${$get$capitalized_name$$}$() {\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| " $type$ result = $type$.$for_number$($name$_);\n" |
| " return result == null ? $unknown$ : result;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateBuilderMembers( |
| io::Printer* printer) const { |
| printer->Print(variables_, "private int $name$_ = $default_number$;\n"); |
| if (HasHazzer(descriptor_)) { |
| WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); |
| printer->Print(variables_, |
| "@java.lang.Override $deprecation$public boolean " |
| "${$has$capitalized_name$$}$() {\n" |
| " return $get_has_field_bit_builder$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override $deprecation$public int " |
| "${$get$capitalized_name$Value$}$() {\n" |
| " return $name$_;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$set$capitalized_name$Value$}$(int value) {\n" |
| " $set_has_field_bit_builder$\n" |
| " $name$_ = value;\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| WriteFieldAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| " $type$ result = $type$.$for_number$($name$_);\n" |
| " return result == null ? $unknown$ : result;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, SETTER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$set$capitalized_name$$}$($type$ value) {\n" |
| " if (value == null) {\n" |
| " throw new NullPointerException();\n" |
| " }\n" |
| " $set_has_field_bit_builder$\n" |
| " $name$_ = value.getNumber();\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, |
| /* builder */ true); |
| printer->Print( |
| variables_, |
| "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" |
| " $clear_has_field_bit_builder$\n" |
| " $name$_ = $default_number$;\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateFieldBuilderInitializationCode( |
| io::Printer* printer) const { |
| // noop for enums |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateInitializationCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, "$name$_ = $default_number$;\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateBuilderClearCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "$name$_ = $default_number$;\n" |
| "$clear_has_field_bit_builder$\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateMergingCode( |
| io::Printer* printer) const { |
| if (HasHazzer(descriptor_)) { |
| printer->Print(variables_, |
| "if (other.has$capitalized_name$()) {\n" |
| " set$capitalized_name$(other.get$capitalized_name$());\n" |
| "}\n"); |
| } else if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print( |
| variables_, |
| "if (other.$name$_ != $default_number$) {\n" |
| " set$capitalized_name$Value(other.get$capitalized_name$Value());\n" |
| "}\n"); |
| } else { |
| GOOGLE_LOG(FATAL) << "Can't reach here."; |
| } |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateBuildingCode( |
| io::Printer* printer) const { |
| if (HasHazzer(descriptor_)) { |
| printer->Print(variables_, |
| "if ($get_has_field_bit_from_local$) {\n" |
| " $set_has_field_bit_to_local$;\n" |
| "}\n"); |
| } |
| printer->Print(variables_, "result.$name$_ = $name$_;\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateParsingCode( |
| io::Printer* printer) const { |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print(variables_, |
| "int rawValue = input.readEnum();\n" |
| "$set_has_field_bit_message$\n" |
| "$name$_ = rawValue;\n"); |
| } else { |
| printer->Print(variables_, |
| "int rawValue = input.readEnum();\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| "$type$ value = $type$.$for_number$(rawValue);\n" |
| "if (value == null) {\n" |
| " unknownFields.mergeVarintField($number$, rawValue);\n" |
| "} else {\n" |
| " $set_has_field_bit_message$\n" |
| " $name$_ = rawValue;\n" |
| "}\n"); |
| } |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateParsingDoneCode( |
| io::Printer* printer) const { |
| // noop for enums |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateSerializationCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "if ($is_field_present_message$) {\n" |
| " output.writeEnum($number$, $name$_);\n" |
| "}\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateSerializedSizeCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "if ($is_field_present_message$) {\n" |
| " size += com.google.protobuf.CodedOutputStream\n" |
| " .computeEnumSize($number$, $name$_);\n" |
| "}\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateEqualsCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, "if ($name$_ != other.$name$_) return false;\n"); |
| } |
| |
| void ImmutableEnumFieldGenerator::GenerateHashCode(io::Printer* printer) const { |
| printer->Print(variables_, |
| "hash = (37 * hash) + $constant_name$;\n" |
| "hash = (53 * hash) + $name$_;\n"); |
| } |
| |
| std::string ImmutableEnumFieldGenerator::GetBoxedType() const { |
| return name_resolver_->GetImmutableClassName(descriptor_->enum_type()); |
| } |
| |
| // =================================================================== |
| |
| ImmutableEnumOneofFieldGenerator::ImmutableEnumOneofFieldGenerator( |
| const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex, |
| Context* context) |
| : ImmutableEnumFieldGenerator(descriptor, messageBitIndex, builderBitIndex, |
| context) { |
| const OneofGeneratorInfo* info = |
| context->GetOneofGeneratorInfo(descriptor->containing_oneof()); |
| SetCommonOneofVariables(descriptor, info, &variables_); |
| } |
| |
| ImmutableEnumOneofFieldGenerator::~ImmutableEnumOneofFieldGenerator() {} |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateMembers( |
| io::Printer* printer) const { |
| PrintExtraFieldInfo(variables_, printer); |
| GOOGLE_DCHECK(HasHazzer(descriptor_)); |
| WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); |
| printer->Print(variables_, |
| "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" |
| " return $has_oneof_case_message$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print( |
| variables_, |
| "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" |
| " if ($has_oneof_case_message$) {\n" |
| " return (java.lang.Integer) $oneof_name$_;\n" |
| " }\n" |
| " return $default_number$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| WriteFieldAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" |
| " if ($has_oneof_case_message$) {\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| " $type$ result = $type$.$for_number$(\n" |
| " (java.lang.Integer) $oneof_name$_);\n" |
| " return result == null ? $unknown$ : result;\n" |
| " }\n" |
| " return $default$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( |
| io::Printer* printer) const { |
| GOOGLE_DCHECK(HasHazzer(descriptor_)); |
| WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); |
| printer->Print(variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" |
| " return $has_oneof_case_message$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print( |
| variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" |
| " if ($has_oneof_case_message$) {\n" |
| " return ((java.lang.Integer) $oneof_name$_).intValue();\n" |
| " }\n" |
| " return $default_number$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$set$capitalized_name$Value$}$(int value) {\n" |
| " $set_oneof_case_message$;\n" |
| " $oneof_name$_ = value;\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| WriteFieldAccessorDocComment(printer, descriptor_, GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" |
| " if ($has_oneof_case_message$) {\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| " $type$ result = $type$.$for_number$(\n" |
| " (java.lang.Integer) $oneof_name$_);\n" |
| " return result == null ? $unknown$ : result;\n" |
| " }\n" |
| " return $default$;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, SETTER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$set$capitalized_name$$}$($type$ value) {\n" |
| " if (value == null) {\n" |
| " throw new NullPointerException();\n" |
| " }\n" |
| " $set_oneof_case_message$;\n" |
| " $oneof_name$_ = value.getNumber();\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, |
| /* builder */ true); |
| printer->Print( |
| variables_, |
| "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" |
| " if ($has_oneof_case_message$) {\n" |
| " $clear_oneof_case_message$;\n" |
| " $oneof_name$_ = null;\n" |
| " $on_changed$\n" |
| " }\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateBuildingCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "if ($has_oneof_case_message$) {\n" |
| " result.$oneof_name$_ = $oneof_name$_;\n" |
| "}\n"); |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateMergingCode( |
| io::Printer* printer) const { |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print( |
| variables_, |
| "set$capitalized_name$Value(other.get$capitalized_name$Value());\n"); |
| } else { |
| printer->Print(variables_, |
| "set$capitalized_name$(other.get$capitalized_name$());\n"); |
| } |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateParsingCode( |
| io::Printer* printer) const { |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print(variables_, |
| "int rawValue = input.readEnum();\n" |
| "$set_oneof_case_message$;\n" |
| "$oneof_name$_ = rawValue;\n"); |
| } else { |
| printer->Print(variables_, |
| "int rawValue = input.readEnum();\n" |
| "@SuppressWarnings(\"deprecation\")\n" |
| "$type$ value = $type$.$for_number$(rawValue);\n" |
| "if (value == null) {\n" |
| " unknownFields.mergeVarintField($number$, rawValue);\n" |
| "} else {\n" |
| " $set_oneof_case_message$;\n" |
| " $oneof_name$_ = rawValue;\n" |
| "}\n"); |
| } |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateSerializationCode( |
| io::Printer* printer) const { |
| printer->Print( |
| variables_, |
| "if ($has_oneof_case_message$) {\n" |
| " output.writeEnum($number$, ((java.lang.Integer) $oneof_name$_));\n" |
| "}\n"); |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateSerializedSizeCode( |
| io::Printer* printer) const { |
| printer->Print( |
| variables_, |
| "if ($has_oneof_case_message$) {\n" |
| " size += com.google.protobuf.CodedOutputStream\n" |
| " .computeEnumSize($number$, ((java.lang.Integer) $oneof_name$_));\n" |
| "}\n"); |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateEqualsCode( |
| io::Printer* printer) const { |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print( |
| variables_, |
| "if (get$capitalized_name$Value()\n" |
| " != other.get$capitalized_name$Value()) return false;\n"); |
| } else { |
| printer->Print( |
| variables_, |
| "if (!get$capitalized_name$()\n" |
| " .equals(other.get$capitalized_name$())) return false;\n"); |
| } |
| } |
| |
| void ImmutableEnumOneofFieldGenerator::GenerateHashCode( |
| io::Printer* printer) const { |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print(variables_, |
| "hash = (37 * hash) + $constant_name$;\n" |
| "hash = (53 * hash) + get$capitalized_name$Value();\n"); |
| } else { |
| printer->Print( |
| variables_, |
| "hash = (37 * hash) + $constant_name$;\n" |
| "hash = (53 * hash) + get$capitalized_name$().getNumber();\n"); |
| } |
| } |
| |
| // =================================================================== |
| |
| RepeatedImmutableEnumFieldGenerator::RepeatedImmutableEnumFieldGenerator( |
| const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex, |
| Context* context) |
| : descriptor_(descriptor), name_resolver_(context->GetNameResolver()) { |
| SetEnumVariables(descriptor, messageBitIndex, builderBitIndex, |
| context->GetFieldGeneratorInfo(descriptor), name_resolver_, |
| &variables_); |
| } |
| |
| RepeatedImmutableEnumFieldGenerator::~RepeatedImmutableEnumFieldGenerator() {} |
| |
| int RepeatedImmutableEnumFieldGenerator::GetNumBitsForMessage() const { |
| return 0; |
| } |
| |
| int RepeatedImmutableEnumFieldGenerator::GetNumBitsForBuilder() const { |
| return 1; |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateInterfaceMembers( |
| io::Printer* printer) const { |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print( |
| variables_, |
| "$deprecation$java.util.List<$type$> get$capitalized_name$List();\n"); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); |
| printer->Print(variables_, |
| "$deprecation$int get$capitalized_name$Count();\n"); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); |
| printer->Print(variables_, |
| "$deprecation$$type$ get$capitalized_name$(int index);\n"); |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print(variables_, |
| "$deprecation$java.util.List<java.lang.Integer>\n" |
| "get$capitalized_name$ValueList();\n"); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, |
| LIST_INDEXED_GETTER); |
| printer->Print(variables_, |
| "$deprecation$int get$capitalized_name$Value(int index);\n"); |
| } |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateMembers( |
| io::Printer* printer) const { |
| printer->Print( |
| variables_, |
| "private java.util.List<java.lang.Integer> $name$_;\n" |
| "private static final " |
| "com.google.protobuf.Internal.ListAdapter.Converter<\n" |
| " java.lang.Integer, $type$> $name$_converter_ =\n" |
| " new com.google.protobuf.Internal.ListAdapter.Converter<\n" |
| " java.lang.Integer, $type$>() {\n" |
| " public $type$ convert(java.lang.Integer from) {\n" |
| " @SuppressWarnings(\"deprecation\")\n" |
| " $type$ result = $type$.$for_number$(from);\n" |
| " return result == null ? $unknown$ : result;\n" |
| " }\n" |
| " };\n"); |
| PrintExtraFieldInfo(variables_, printer); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print( |
| variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public java.util.List<$type$> " |
| "${$get$capitalized_name$List$}$() {\n" |
| " return new com.google.protobuf.Internal.ListAdapter<\n" |
| " java.lang.Integer, $type$>($name$_, $name$_converter_);\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); |
| printer->Print( |
| variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" |
| " return $name$_.size();\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); |
| printer->Print( |
| variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" |
| " return $name$_converter_.convert($name$_.get(index));\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public java.util.List<java.lang.Integer>\n" |
| "${$get$capitalized_name$ValueList$}$() {\n" |
| " return $name$_;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, |
| LIST_INDEXED_GETTER); |
| printer->Print(variables_, |
| "@java.lang.Override\n" |
| "$deprecation$public int " |
| "${$get$capitalized_name$Value$}$(int index) {\n" |
| " return $name$_.get(index);\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| |
| if (descriptor_->is_packed()) { |
| printer->Print(variables_, "private int $name$MemoizedSerializedSize;\n"); |
| } |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( |
| io::Printer* printer) const { |
| printer->Print( |
| variables_, |
| // One field is the list and the other field keeps track of whether the |
| // list is immutable. If it's immutable, the invariant is that it must |
| // either an instance of Collections.emptyList() or it's an ArrayList |
| // wrapped in a Collections.unmodifiableList() wrapper and nobody else has |
| // a reference to the underlying ArrayList. This invariant allows us to |
| // share instances of lists between protocol buffers avoiding expensive |
| // memory allocations. Note, immutable is a strong guarantee here -- not |
| // just that the list cannot be modified via the reference but that the |
| // list can never be modified. |
| "private java.util.List<java.lang.Integer> $name$_ =\n" |
| " java.util.Collections.emptyList();\n" |
| |
| "private void ensure$capitalized_name$IsMutable() {\n" |
| " if (!$get_mutable_bit_builder$) {\n" |
| " $name$_ = new java.util.ArrayList<java.lang.Integer>($name$_);\n" |
| " $set_mutable_bit_builder$;\n" |
| " }\n" |
| "}\n"); |
| |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print( |
| variables_, |
| // Note: We return an unmodifiable list because otherwise the caller |
| // could hold on to the returned list and modify it after the message |
| // has been built, thus mutating the message which is supposed to be |
| // immutable. |
| "$deprecation$public java.util.List<$type$> " |
| "${$get$capitalized_name$List$}$() {\n" |
| " return new com.google.protobuf.Internal.ListAdapter<\n" |
| " java.lang.Integer, $type$>($name$_, $name$_converter_);\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); |
| printer->Print( |
| variables_, |
| "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" |
| " return $name$_.size();\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); |
| printer->Print( |
| variables_, |
| "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" |
| " return $name$_converter_.convert($name$_.get(index));\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" |
| " int index, $type$ value) {\n" |
| " if (value == null) {\n" |
| " throw new NullPointerException();\n" |
| " }\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " $name$_.set(index, value.getNumber());\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$add$capitalized_name$$}$($type$ value) {\n" |
| " if (value == null) {\n" |
| " throw new NullPointerException();\n" |
| " }\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " $name$_.add(value.getNumber());\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" |
| " java.lang.Iterable<? extends $type$> values) {\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " for ($type$ value : values) {\n" |
| " $name$_.add(value.getNumber());\n" |
| " }\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, |
| /* builder */ true); |
| printer->Print( |
| variables_, |
| "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" |
| " $name$_ = java.util.Collections.emptyList();\n" |
| " $clear_mutable_bit_builder$;\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); |
| printer->Print(variables_, |
| "$deprecation$public java.util.List<java.lang.Integer>\n" |
| "${$get$capitalized_name$ValueList$}$() {\n" |
| " return java.util.Collections.unmodifiableList($name$_);\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, |
| LIST_INDEXED_GETTER); |
| printer->Print(variables_, |
| "$deprecation$public int " |
| "${$get$capitalized_name$Value$}$(int index) {\n" |
| " return $name$_.get(index);\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, |
| LIST_INDEXED_GETTER, |
| /* builder */ true); |
| printer->Print( |
| variables_, |
| "$deprecation$public Builder ${$set$capitalized_name$Value$}$(\n" |
| " int index, int value) {\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " $name$_.set(index, value);\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, |
| /* builder */ true); |
| printer->Print(variables_, |
| "$deprecation$public Builder " |
| "${$add$capitalized_name$Value$}$(int value) {\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " $name$_.add(value);\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| WriteFieldEnumValueAccessorDocComment(printer, descriptor_, |
| LIST_MULTI_ADDER, /* builder */ true); |
| printer->Print( |
| variables_, |
| "$deprecation$public Builder ${$addAll$capitalized_name$Value$}$(\n" |
| " java.lang.Iterable<java.lang.Integer> values) {\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " for (int value : values) {\n" |
| " $name$_.add(value);\n" |
| " }\n" |
| " $on_changed$\n" |
| " return this;\n" |
| "}\n"); |
| printer->Annotate("{", "}", descriptor_); |
| } |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator:: |
| GenerateFieldBuilderInitializationCode(io::Printer* printer) const { |
| // noop for enums |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateInitializationCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, "$name$_ = java.util.Collections.emptyList();\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateBuilderClearCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "$name$_ = java.util.Collections.emptyList();\n" |
| "$clear_mutable_bit_builder$;\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateMergingCode( |
| io::Printer* printer) const { |
| // The code below does two optimizations: |
| // 1. If the other list is empty, there's nothing to do. This ensures we |
| // don't allocate a new array if we already have an immutable one. |
| // 2. If the other list is non-empty and our current list is empty, we can |
| // reuse the other list which is guaranteed to be immutable. |
| printer->Print(variables_, |
| "if (!other.$name$_.isEmpty()) {\n" |
| " if ($name$_.isEmpty()) {\n" |
| " $name$_ = other.$name$_;\n" |
| " $clear_mutable_bit_builder$;\n" |
| " } else {\n" |
| " ensure$capitalized_name$IsMutable();\n" |
| " $name$_.addAll(other.$name$_);\n" |
| " }\n" |
| " $on_changed$\n" |
| "}\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateBuildingCode( |
| io::Printer* printer) const { |
| // The code below ensures that the result has an immutable list. If our |
| // list is immutable, we can just reuse it. If not, we make it immutable. |
| printer->Print( |
| variables_, |
| "if ($get_mutable_bit_builder$) {\n" |
| " $name$_ = java.util.Collections.unmodifiableList($name$_);\n" |
| " $clear_mutable_bit_builder$;\n" |
| "}\n" |
| "result.$name$_ = $name$_;\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateParsingCode( |
| io::Printer* printer) const { |
| // Read and store the enum |
| if (SupportUnknownEnumValue(descriptor_->file())) { |
| printer->Print(variables_, |
| "int rawValue = input.readEnum();\n" |
| "if (!$get_mutable_bit_parser$) {\n" |
| " $name$_ = new java.util.ArrayList<java.lang.Integer>();\n" |
| " $set_mutable_bit_parser$;\n" |
| "}\n" |
| "$name$_.add(rawValue);\n"); |
| } else { |
| printer->Print( |
| variables_, |
| "int rawValue = input.readEnum();\n" |
| "@SuppressWarnings(\"deprecation\")\n" |
| "$type$ value = $type$.$for_number$(rawValue);\n" |
| "if (value == null) {\n" |
| " unknownFields.mergeVarintField($number$, rawValue);\n" |
| "} else {\n" |
| " if (!$get_mutable_bit_parser$) {\n" |
| " $name$_ = new java.util.ArrayList<java.lang.Integer>();\n" |
| " $set_mutable_bit_parser$;\n" |
| " }\n" |
| " $name$_.add(rawValue);\n" |
| "}\n"); |
| } |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateParsingCodeFromPacked( |
| io::Printer* printer) const { |
| // Wrap GenerateParsingCode's contents with a while loop. |
| |
| printer->Print(variables_, |
| "int length = input.readRawVarint32();\n" |
| "int oldLimit = input.pushLimit(length);\n" |
| "while(input.getBytesUntilLimit() > 0) {\n"); |
| printer->Indent(); |
| |
| GenerateParsingCode(printer); |
| |
| printer->Outdent(); |
| printer->Print(variables_, |
| "}\n" |
| "input.popLimit(oldLimit);\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateParsingDoneCode( |
| io::Printer* printer) const { |
| printer->Print( |
| variables_, |
| "if ($get_mutable_bit_parser$) {\n" |
| " $name$_ = java.util.Collections.unmodifiableList($name$_);\n" |
| "}\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateSerializationCode( |
| io::Printer* printer) const { |
| if (descriptor_->is_packed()) { |
| printer->Print(variables_, |
| "if (get$capitalized_name$List().size() > 0) {\n" |
| " output.writeUInt32NoTag($tag$);\n" |
| " output.writeUInt32NoTag($name$MemoizedSerializedSize);\n" |
| "}\n" |
| "for (int i = 0; i < $name$_.size(); i++) {\n" |
| " output.writeEnumNoTag($name$_.get(i));\n" |
| "}\n"); |
| } else { |
| printer->Print(variables_, |
| "for (int i = 0; i < $name$_.size(); i++) {\n" |
| " output.writeEnum($number$, $name$_.get(i));\n" |
| "}\n"); |
| } |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateSerializedSizeCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "{\n" |
| " int dataSize = 0;\n"); |
| printer->Indent(); |
| |
| printer->Print(variables_, |
| "for (int i = 0; i < $name$_.size(); i++) {\n" |
| " dataSize += com.google.protobuf.CodedOutputStream\n" |
| " .computeEnumSizeNoTag($name$_.get(i));\n" |
| "}\n"); |
| printer->Print("size += dataSize;\n"); |
| if (descriptor_->is_packed()) { |
| printer->Print(variables_, |
| "if (!get$capitalized_name$List().isEmpty()) {" |
| " size += $tag_size$;\n" |
| " size += com.google.protobuf.CodedOutputStream\n" |
| " .computeUInt32SizeNoTag(dataSize);\n" |
| "}"); |
| } else { |
| printer->Print(variables_, "size += $tag_size$ * $name$_.size();\n"); |
| } |
| |
| // cache the data size for packed fields. |
| if (descriptor_->is_packed()) { |
| printer->Print(variables_, "$name$MemoizedSerializedSize = dataSize;\n"); |
| } |
| |
| printer->Outdent(); |
| printer->Print("}\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateEqualsCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "if (!$name$_.equals(other.$name$_)) return false;\n"); |
| } |
| |
| void RepeatedImmutableEnumFieldGenerator::GenerateHashCode( |
| io::Printer* printer) const { |
| printer->Print(variables_, |
| "if (get$capitalized_name$Count() > 0) {\n" |
| " hash = (37 * hash) + $constant_name$;\n" |
| " hash = (53 * hash) + $name$_.hashCode();\n" |
| "}\n"); |
| } |
| |
| std::string RepeatedImmutableEnumFieldGenerator::GetBoxedType() const { |
| return name_resolver_->GetImmutableClassName(descriptor_->enum_type()); |
| } |
| |
| } // namespace java |
| } // namespace compiler |
| } // namespace protobuf |
| } // namespace google |
