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 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__ 37 38 #include <map> 39 #include <string> 40 41 #include "google/protobuf/compiler/java/field.h" 42 43 namespace google { 44 namespace protobuf { 45 namespace compiler { 46 namespace java { 47 class Context; // context.h 48 class ClassNameResolver; // name_resolver.h 49 } // namespace java 50 } // namespace compiler 51 } // namespace protobuf 52 } // namespace google 53 54 namespace google { 55 namespace protobuf { 56 namespace compiler { 57 namespace java { 58 59 class ImmutableMessageFieldGenerator : public ImmutableFieldGenerator { 60 public: 61 explicit ImmutableMessageFieldGenerator(const FieldDescriptor* descriptor, 62 int messageBitIndex, 63 int builderBitIndex, 64 Context* context); 65 ImmutableMessageFieldGenerator(const ImmutableMessageFieldGenerator&) = 66 delete; 67 ImmutableMessageFieldGenerator& operator=( 68 const ImmutableMessageFieldGenerator&) = delete; 69 ~ImmutableMessageFieldGenerator() override; 70 71 // implements ImmutableFieldGenerator 72 // --------------------------------------- 73 int GetMessageBitIndex() const override; 74 int GetBuilderBitIndex() const override; 75 int GetNumBitsForMessage() const override; 76 int GetNumBitsForBuilder() const override; 77 void GenerateInterfaceMembers(io::Printer* printer) const override; 78 void GenerateMembers(io::Printer* printer) const override; 79 void GenerateBuilderMembers(io::Printer* printer) const override; 80 void GenerateInitializationCode(io::Printer* printer) const override; 81 void GenerateBuilderClearCode(io::Printer* printer) const override; 82 void GenerateMergingCode(io::Printer* printer) const override; 83 void GenerateBuildingCode(io::Printer* printer) const override; 84 void GenerateBuilderParsingCode(io::Printer* printer) const override; 85 void GenerateSerializationCode(io::Printer* printer) const override; 86 void GenerateSerializedSizeCode(io::Printer* printer) const override; 87 void GenerateFieldBuilderInitializationCode( 88 io::Printer* printer) const override; 89 void GenerateEqualsCode(io::Printer* printer) const override; 90 void GenerateHashCode(io::Printer* printer) const override; 91 void GenerateKotlinDslMembers(io::Printer* printer) const override; 92 93 std::string GetBoxedType() const override; 94 95 protected: 96 const FieldDescriptor* descriptor_; 97 int message_bit_index_; 98 int builder_bit_index_; 99 std::map<std::string, std::string> variables_; 100 ClassNameResolver* name_resolver_; 101 Context* context_; 102 103 virtual void PrintNestedBuilderCondition( 104 io::Printer* printer, const char* regular_case, 105 const char* nested_builder_case) const; 106 virtual void PrintNestedBuilderFunction(io::Printer* printer, 107 const char* method_prototype, 108 const char* regular_case, 109 const char* nested_builder_case, 110 const char* trailing_code) const; 111 112 private: 113 void GenerateKotlinOrNull(io::Printer* printer) const; 114 }; 115 116 class ImmutableMessageOneofFieldGenerator 117 : public ImmutableMessageFieldGenerator { 118 public: 119 ImmutableMessageOneofFieldGenerator(const FieldDescriptor* descriptor, 120 int messageBitIndex, int builderBitIndex, 121 Context* context); 122 ImmutableMessageOneofFieldGenerator( 123 const ImmutableMessageOneofFieldGenerator&) = delete; 124 ImmutableMessageOneofFieldGenerator& operator=( 125 const ImmutableMessageOneofFieldGenerator&) = delete; 126 ~ImmutableMessageOneofFieldGenerator() override; 127 128 void GenerateMembers(io::Printer* printer) const override; 129 void GenerateBuilderMembers(io::Printer* printer) const override; 130 void GenerateBuilderClearCode(io::Printer* printer) const override; 131 void GenerateBuildingCode(io::Printer* printer) const override; 132 void GenerateMergingCode(io::Printer* printer) const override; 133 void GenerateBuilderParsingCode(io::Printer* printer) const override; 134 void GenerateSerializationCode(io::Printer* printer) const override; 135 void GenerateSerializedSizeCode(io::Printer* printer) const override; 136 }; 137 138 class RepeatedImmutableMessageFieldGenerator 139 : public ImmutableMessageFieldGenerator { 140 public: 141 explicit RepeatedImmutableMessageFieldGenerator( 142 const FieldDescriptor* descriptor, int messageBitIndex, 143 int builderBitIndex, Context* context); 144 RepeatedImmutableMessageFieldGenerator( 145 const RepeatedImmutableMessageFieldGenerator&) = delete; 146 RepeatedImmutableMessageFieldGenerator& operator=( 147 const RepeatedImmutableMessageFieldGenerator&) = delete; 148 ~RepeatedImmutableMessageFieldGenerator() override; 149 150 // implements ImmutableFieldGenerator --------------------------------------- 151 int GetNumBitsForMessage() const override; 152 int GetNumBitsForBuilder() const override; 153 void GenerateInterfaceMembers(io::Printer* printer) const override; 154 void GenerateMembers(io::Printer* printer) const override; 155 void GenerateBuilderMembers(io::Printer* printer) const override; 156 void GenerateInitializationCode(io::Printer* printer) const override; 157 void GenerateBuilderClearCode(io::Printer* printer) const override; 158 void GenerateMergingCode(io::Printer* printer) const override; 159 void GenerateBuildingCode(io::Printer* printer) const override; 160 void GenerateBuilderParsingCode(io::Printer* printer) const override; 161 void GenerateSerializationCode(io::Printer* printer) const override; 162 void GenerateSerializedSizeCode(io::Printer* printer) const override; 163 void GenerateFieldBuilderInitializationCode( 164 io::Printer* printer) const override; 165 void GenerateEqualsCode(io::Printer* printer) const override; 166 void GenerateHashCode(io::Printer* printer) const override; 167 void GenerateKotlinDslMembers(io::Printer* printer) const override; 168 169 std::string GetBoxedType() const override; 170 171 protected: 172 void PrintNestedBuilderCondition( 173 io::Printer* printer, const char* regular_case, 174 const char* nested_builder_case) const override; 175 void PrintNestedBuilderFunction(io::Printer* printer, 176 const char* method_prototype, 177 const char* regular_case, 178 const char* nested_builder_case, 179 const char* trailing_code) const override; 180 }; 181 182 } // namespace java 183 } // namespace compiler 184 } // namespace protobuf 185 } // namespace google 186 187 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__ 188