Index: third_party/protobuf/src/google/protobuf/compiler/java/java_enum_field.cc |
diff --git a/third_party/protobuf/src/google/protobuf/compiler/java/java_enum_field.cc b/third_party/protobuf/src/google/protobuf/compiler/java/java_enum_field.cc |
index af6b1cd293e52e58af7e9db3caba0966127501ad..72caa10b5dce172f7efc22f383e90e3f66d7f6f6 100644 |
--- a/third_party/protobuf/src/google/protobuf/compiler/java/java_enum_field.cc |
+++ b/third_party/protobuf/src/google/protobuf/compiler/java/java_enum_field.cc |
@@ -52,17 +52,44 @@ namespace { |
// TODO(kenton): Factor out a "SetCommonFieldVariables()" to get rid of |
// repeat code between this and the other field types. |
void SetEnumVariables(const FieldDescriptor* descriptor, |
+ int messageBitIndex, |
+ int builderBitIndex, |
map<string, string>* variables) { |
(*variables)["name"] = |
UnderscoresToCamelCase(descriptor); |
(*variables)["capitalized_name"] = |
UnderscoresToCapitalizedCamelCase(descriptor); |
+ (*variables)["constant_name"] = FieldConstantName(descriptor); |
(*variables)["number"] = SimpleItoa(descriptor->number()); |
(*variables)["type"] = ClassName(descriptor->enum_type()); |
(*variables)["default"] = DefaultValue(descriptor); |
(*variables)["tag"] = SimpleItoa(internal::WireFormat::MakeTag(descriptor)); |
(*variables)["tag_size"] = SimpleItoa( |
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"] = |
+ HasDescriptorMethods(descriptor->containing_type()) ? "onChanged();" : ""; |
+ |
+ // 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); |
+ (*variables)["set_has_field_bit_builder"] = GenerateSetBit(builderBitIndex); |
+ (*variables)["clear_has_field_bit_builder"] = |
+ GenerateClearBit(builderBitIndex); |
+ |
+ // For repated 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); |
+ |
+ (*variables)["get_has_field_bit_from_local"] = |
+ GenerateGetBitFromLocal(builderBitIndex); |
+ (*variables)["set_has_field_bit_to_local"] = |
+ GenerateSetBitToLocal(messageBitIndex); |
} |
} // namespace |
@@ -70,52 +97,88 @@ void SetEnumVariables(const FieldDescriptor* descriptor, |
// =================================================================== |
EnumFieldGenerator:: |
-EnumFieldGenerator(const FieldDescriptor* descriptor) |
- : descriptor_(descriptor) { |
- SetEnumVariables(descriptor, &variables_); |
+EnumFieldGenerator(const FieldDescriptor* descriptor, |
+ int messageBitIndex, |
+ int builderBitIndex) |
+ : descriptor_(descriptor), messageBitIndex_(messageBitIndex), |
+ builderBitIndex_(builderBitIndex) { |
+ SetEnumVariables(descriptor, messageBitIndex, builderBitIndex, &variables_); |
} |
EnumFieldGenerator::~EnumFieldGenerator() {} |
+int EnumFieldGenerator::GetNumBitsForMessage() const { |
+ return 1; |
+} |
+ |
+int EnumFieldGenerator::GetNumBitsForBuilder() const { |
+ return 1; |
+} |
+ |
+void EnumFieldGenerator:: |
+GenerateInterfaceMembers(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "$deprecation$boolean has$capitalized_name$();\n" |
+ "$deprecation$$type$ get$capitalized_name$();\n"); |
+} |
+ |
void EnumFieldGenerator:: |
GenerateMembers(io::Printer* printer) const { |
printer->Print(variables_, |
- "private boolean has$capitalized_name$;\n" |
"private $type$ $name$_;\n" |
- "public boolean has$capitalized_name$() { return has$capitalized_name$; }\n" |
- "public $type$ get$capitalized_name$() { return $name$_; }\n"); |
+ "$deprecation$public boolean has$capitalized_name$() {\n" |
+ " return $get_has_field_bit_message$;\n" |
+ "}\n" |
+ "$deprecation$public $type$ get$capitalized_name$() {\n" |
+ " return $name$_;\n" |
+ "}\n"); |
} |
void EnumFieldGenerator:: |
GenerateBuilderMembers(io::Printer* printer) const { |
printer->Print(variables_, |
- "public boolean has$capitalized_name$() {\n" |
- " return result.has$capitalized_name$();\n" |
+ "private $type$ $name$_ = $default$;\n" |
+ "$deprecation$public boolean has$capitalized_name$() {\n" |
+ " return $get_has_field_bit_builder$;\n" |
"}\n" |
- "public $type$ get$capitalized_name$() {\n" |
- " return result.get$capitalized_name$();\n" |
+ "$deprecation$public $type$ get$capitalized_name$() {\n" |
+ " return $name$_;\n" |
"}\n" |
- "public Builder set$capitalized_name$($type$ value) {\n" |
+ "$deprecation$public Builder set$capitalized_name$($type$ value) {\n" |
" if (value == null) {\n" |
" throw new NullPointerException();\n" |
" }\n" |
- " result.has$capitalized_name$ = true;\n" |
- " result.$name$_ = value;\n" |
+ " $set_has_field_bit_builder$;\n" |
+ " $name$_ = value;\n" |
+ " $on_changed$\n" |
" return this;\n" |
"}\n" |
- "public Builder clear$capitalized_name$() {\n" |
- " result.has$capitalized_name$ = false;\n" |
- " result.$name$_ = $default$;\n" |
+ "$deprecation$public Builder clear$capitalized_name$() {\n" |
+ " $clear_has_field_bit_builder$;\n" |
+ " $name$_ = $default$;\n" |
+ " $on_changed$\n" |
" return this;\n" |
"}\n"); |
} |
void EnumFieldGenerator:: |
+GenerateFieldBuilderInitializationCode(io::Printer* printer) const { |
+ // noop for enums |
+} |
+ |
+void EnumFieldGenerator:: |
GenerateInitializationCode(io::Printer* printer) const { |
printer->Print(variables_, "$name$_ = $default$;\n"); |
} |
void EnumFieldGenerator:: |
+GenerateBuilderClearCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "$name$_ = $default$;\n" |
+ "$clear_has_field_bit_builder$;\n"); |
+} |
+ |
+void EnumFieldGenerator:: |
GenerateMergingCode(io::Printer* printer) const { |
printer->Print(variables_, |
"if (other.has$capitalized_name$()) {\n" |
@@ -125,7 +188,11 @@ GenerateMergingCode(io::Printer* printer) const { |
void EnumFieldGenerator:: |
GenerateBuildingCode(io::Printer* printer) const { |
- // Nothing to do here for enum types. |
+ printer->Print(variables_, |
+ "if ($get_has_field_bit_from_local$) {\n" |
+ " $set_has_field_bit_to_local$;\n" |
+ "}\n" |
+ "result.$name$_ = $name$_;\n"); |
} |
void EnumFieldGenerator:: |
@@ -143,27 +210,42 @@ GenerateParsingCode(io::Printer* printer) const { |
"if (value != null) {\n"); |
} |
printer->Print(variables_, |
- " set$capitalized_name$(value);\n" |
+ " $set_has_field_bit_builder$;\n" |
+ " $name$_ = value;\n" |
"}\n"); |
} |
void EnumFieldGenerator:: |
GenerateSerializationCode(io::Printer* printer) const { |
printer->Print(variables_, |
- "if (has$capitalized_name$()) {\n" |
- " output.writeEnum($number$, get$capitalized_name$().getNumber());\n" |
+ "if ($get_has_field_bit_message$) {\n" |
+ " output.writeEnum($number$, $name$_.getNumber());\n" |
"}\n"); |
} |
void EnumFieldGenerator:: |
GenerateSerializedSizeCode(io::Printer* printer) const { |
printer->Print(variables_, |
- "if (has$capitalized_name$()) {\n" |
+ "if ($get_has_field_bit_message$) {\n" |
" size += com.google.protobuf.CodedOutputStream\n" |
- " .computeEnumSize($number$, get$capitalized_name$().getNumber());\n" |
+ " .computeEnumSize($number$, $name$_.getNumber());\n" |
"}\n"); |
} |
+void EnumFieldGenerator:: |
+GenerateEqualsCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "result = result &&\n" |
+ " (get$capitalized_name$() == other.get$capitalized_name$());\n"); |
+} |
+ |
+void EnumFieldGenerator:: |
+GenerateHashCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "hash = (37 * hash) + $constant_name$;\n" |
+ "hash = (53 * hash) + hashEnum(get$capitalized_name$());\n"); |
+} |
+ |
string EnumFieldGenerator::GetBoxedType() const { |
return ClassName(descriptor_->enum_type()); |
} |
@@ -171,23 +253,43 @@ string EnumFieldGenerator::GetBoxedType() const { |
// =================================================================== |
RepeatedEnumFieldGenerator:: |
-RepeatedEnumFieldGenerator(const FieldDescriptor* descriptor) |
- : descriptor_(descriptor) { |
- SetEnumVariables(descriptor, &variables_); |
+RepeatedEnumFieldGenerator(const FieldDescriptor* descriptor, |
+ int messageBitIndex, |
+ int builderBitIndex) |
+ : descriptor_(descriptor), messageBitIndex_(messageBitIndex), |
+ builderBitIndex_(builderBitIndex) { |
+ SetEnumVariables(descriptor, messageBitIndex, builderBitIndex, &variables_); |
} |
RepeatedEnumFieldGenerator::~RepeatedEnumFieldGenerator() {} |
+int RepeatedEnumFieldGenerator::GetNumBitsForMessage() const { |
+ return 0; |
+} |
+ |
+int RepeatedEnumFieldGenerator::GetNumBitsForBuilder() const { |
+ return 1; |
+} |
+ |
+void RepeatedEnumFieldGenerator:: |
+GenerateInterfaceMembers(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "$deprecation$java.util.List<$type$> get$capitalized_name$List();\n" |
+ "$deprecation$int get$capitalized_name$Count();\n" |
+ "$deprecation$$type$ get$capitalized_name$(int index);\n"); |
+} |
+ |
void RepeatedEnumFieldGenerator:: |
GenerateMembers(io::Printer* printer) const { |
printer->Print(variables_, |
- "private java.util.List<$type$> $name$_ =\n" |
- " java.util.Collections.emptyList();\n" |
- "public java.util.List<$type$> get$capitalized_name$List() {\n" |
+ "private java.util.List<$type$> $name$_;\n" |
+ "$deprecation$public java.util.List<$type$> get$capitalized_name$List() {\n" |
" return $name$_;\n" // note: unmodifiable list |
"}\n" |
- "public int get$capitalized_name$Count() { return $name$_.size(); }\n" |
- "public $type$ get$capitalized_name$(int index) {\n" |
+ "$deprecation$public int get$capitalized_name$Count() {\n" |
+ " return $name$_.size();\n" |
+ "}\n" |
+ "$deprecation$public $type$ get$capitalized_name$(int index) {\n" |
" return $name$_.get(index);\n" |
"}\n"); |
@@ -201,73 +303,119 @@ GenerateMembers(io::Printer* printer) const { |
void RepeatedEnumFieldGenerator:: |
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 refererence 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<$type$> $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<$type$>($name$_);\n" |
+ " $set_mutable_bit_builder$;\n" |
+ " }\n" |
+ "}\n" |
+ |
// 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. |
- "public java.util.List<$type$> get$capitalized_name$List() {\n" |
- " return java.util.Collections.unmodifiableList(result.$name$_);\n" |
+ "$deprecation$public java.util.List<$type$> get$capitalized_name$List() {\n" |
+ " return java.util.Collections.unmodifiableList($name$_);\n" |
"}\n" |
- "public int get$capitalized_name$Count() {\n" |
- " return result.get$capitalized_name$Count();\n" |
+ "$deprecation$public int get$capitalized_name$Count() {\n" |
+ " return $name$_.size();\n" |
"}\n" |
- "public $type$ get$capitalized_name$(int index) {\n" |
- " return result.get$capitalized_name$(index);\n" |
+ "$deprecation$public $type$ get$capitalized_name$(int index) {\n" |
+ " return $name$_.get(index);\n" |
"}\n" |
- "public Builder set$capitalized_name$(int index, $type$ value) {\n" |
+ "$deprecation$public Builder set$capitalized_name$(\n" |
+ " int index, $type$ value) {\n" |
" if (value == null) {\n" |
" throw new NullPointerException();\n" |
" }\n" |
- " result.$name$_.set(index, value);\n" |
+ " ensure$capitalized_name$IsMutable();\n" |
+ " $name$_.set(index, value);\n" |
+ " $on_changed$\n" |
" return this;\n" |
"}\n" |
- "public Builder add$capitalized_name$($type$ value) {\n" |
+ "$deprecation$public Builder add$capitalized_name$($type$ value) {\n" |
" if (value == null) {\n" |
" throw new NullPointerException();\n" |
" }\n" |
- " if (result.$name$_.isEmpty()) {\n" |
- " result.$name$_ = new java.util.ArrayList<$type$>();\n" |
- " }\n" |
- " result.$name$_.add(value);\n" |
+ " ensure$capitalized_name$IsMutable();\n" |
+ " $name$_.add(value);\n" |
+ " $on_changed$\n" |
" return this;\n" |
"}\n" |
- "public Builder addAll$capitalized_name$(\n" |
+ "$deprecation$public Builder addAll$capitalized_name$(\n" |
" java.lang.Iterable<? extends $type$> values) {\n" |
- " if (result.$name$_.isEmpty()) {\n" |
- " result.$name$_ = new java.util.ArrayList<$type$>();\n" |
- " }\n" |
- " super.addAll(values, result.$name$_);\n" |
+ " ensure$capitalized_name$IsMutable();\n" |
+ " super.addAll(values, $name$_);\n" |
+ " $on_changed$\n" |
" return this;\n" |
"}\n" |
- "public Builder clear$capitalized_name$() {\n" |
- " result.$name$_ = java.util.Collections.emptyList();\n" |
+ "$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"); |
} |
void RepeatedEnumFieldGenerator:: |
+GenerateFieldBuilderInitializationCode(io::Printer* printer) const { |
+ // noop for enums |
+} |
+ |
+void RepeatedEnumFieldGenerator:: |
GenerateInitializationCode(io::Printer* printer) const { |
- // Initialized inline. |
+ printer->Print(variables_, "$name$_ = java.util.Collections.emptyList();\n"); |
+} |
+ |
+void RepeatedEnumFieldGenerator:: |
+GenerateBuilderClearCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "$name$_ = java.util.Collections.emptyList();\n" |
+ "$clear_mutable_bit_builder$;\n"); |
} |
void RepeatedEnumFieldGenerator:: |
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 (result.$name$_.isEmpty()) {\n" |
- " result.$name$_ = new java.util.ArrayList<$type$>();\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" |
- " result.$name$_.addAll(other.$name$_);\n" |
+ " $on_changed$\n" |
"}\n"); |
} |
void RepeatedEnumFieldGenerator:: |
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 (result.$name$_ != java.util.Collections.EMPTY_LIST) {\n" |
- " result.$name$_ =\n" |
- " java.util.Collections.unmodifiableList(result.$name$_);\n" |
- "}\n"); |
+ "if ($get_mutable_bit_builder$) {\n" |
+ " $name$_ = java.util.Collections.unmodifiableList($name$_);\n" |
+ " $clear_mutable_bit_builder$;\n" |
+ "}\n" |
+ "result.$name$_ = $name$_;\n"); |
} |
void RepeatedEnumFieldGenerator:: |
@@ -316,13 +464,13 @@ GenerateSerializationCode(io::Printer* printer) const { |
" output.writeRawVarint32($tag$);\n" |
" output.writeRawVarint32($name$MemoizedSerializedSize);\n" |
"}\n" |
- "for ($type$ element : get$capitalized_name$List()) {\n" |
- " output.writeEnumNoTag(element.getNumber());\n" |
+ "for (int i = 0; i < $name$_.size(); i++) {\n" |
+ " output.writeEnumNoTag($name$_.get(i).getNumber());\n" |
"}\n"); |
} else { |
printer->Print(variables_, |
- "for ($type$ element : get$capitalized_name$List()) {\n" |
- " output.writeEnum($number$, element.getNumber());\n" |
+ "for (int i = 0; i < $name$_.size(); i++) {\n" |
+ " output.writeEnum($number$, $name$_.get(i).getNumber());\n" |
"}\n"); |
} |
} |
@@ -335,9 +483,9 @@ GenerateSerializedSizeCode(io::Printer* printer) const { |
printer->Indent(); |
printer->Print(variables_, |
- "for ($type$ element : get$capitalized_name$List()) {\n" |
+ "for (int i = 0; i < $name$_.size(); i++) {\n" |
" dataSize += com.google.protobuf.CodedOutputStream\n" |
- " .computeEnumSizeNoTag(element.getNumber());\n" |
+ " .computeEnumSizeNoTag($name$_.get(i).getNumber());\n" |
"}\n"); |
printer->Print( |
"size += dataSize;\n"); |
@@ -350,7 +498,7 @@ GenerateSerializedSizeCode(io::Printer* printer) const { |
"}"); |
} else { |
printer->Print(variables_, |
- "size += $tag_size$ * get$capitalized_name$List().size();\n"); |
+ "size += $tag_size$ * $name$_.size();\n"); |
} |
// cache the data size for packed fields. |
@@ -363,6 +511,22 @@ GenerateSerializedSizeCode(io::Printer* printer) const { |
printer->Print("}\n"); |
} |
+void RepeatedEnumFieldGenerator:: |
+GenerateEqualsCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "result = result && get$capitalized_name$List()\n" |
+ " .equals(other.get$capitalized_name$List());\n"); |
+} |
+ |
+void RepeatedEnumFieldGenerator:: |
+GenerateHashCode(io::Printer* printer) const { |
+ printer->Print(variables_, |
+ "if (get$capitalized_name$Count() > 0) {\n" |
+ " hash = (37 * hash) + $constant_name$;\n" |
+ " hash = (53 * hash) + hashEnumList(get$capitalized_name$List());\n" |
+ "}\n"); |
+} |
+ |
string RepeatedEnumFieldGenerator::GetBoxedType() const { |
return ClassName(descriptor_->enum_type()); |
} |