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 (at) 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_FIELD_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__ 37 38 #include <map> 39 #include <memory> 40 #include <string> 41 42 #include <google/protobuf/stubs/common.h> 43 #include <google/protobuf/descriptor.h> 44 45 namespace google { 46 namespace protobuf { 47 namespace compiler { 48 namespace java { 49 class Context; // context.h 50 class ClassNameResolver; // name_resolver.h 51 } 52 } 53 namespace io { 54 class Printer; // printer.h 55 } 56 } 57 58 namespace protobuf { 59 namespace compiler { 60 namespace java { 61 62 class ImmutableFieldGenerator { 63 public: 64 ImmutableFieldGenerator() {} 65 virtual ~ImmutableFieldGenerator(); 66 67 virtual int GetNumBitsForMessage() const = 0; 68 virtual int GetNumBitsForBuilder() const = 0; 69 virtual void GenerateInterfaceMembers(io::Printer* printer) const = 0; 70 virtual void GenerateMembers(io::Printer* printer) const = 0; 71 virtual void GenerateBuilderMembers(io::Printer* printer) const = 0; 72 virtual void GenerateInitializationCode(io::Printer* printer) const = 0; 73 virtual void GenerateBuilderClearCode(io::Printer* printer) const = 0; 74 virtual void GenerateMergingCode(io::Printer* printer) const = 0; 75 virtual void GenerateBuildingCode(io::Printer* printer) const = 0; 76 virtual void GenerateParsingCode(io::Printer* printer) const = 0; 77 virtual void GenerateParsingCodeFromPacked(io::Printer* printer) const; 78 virtual void GenerateParsingDoneCode(io::Printer* printer) const = 0; 79 virtual void GenerateSerializationCode(io::Printer* printer) const = 0; 80 virtual void GenerateSerializedSizeCode(io::Printer* printer) const = 0; 81 virtual void GenerateFieldBuilderInitializationCode(io::Printer* printer) 82 const = 0; 83 84 virtual void GenerateEqualsCode(io::Printer* printer) const = 0; 85 virtual void GenerateHashCode(io::Printer* printer) const = 0; 86 87 virtual string GetBoxedType() const = 0; 88 89 private: 90 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableFieldGenerator); 91 }; 92 93 94 // Convenience class which constructs FieldGenerators for a Descriptor. 95 template<typename FieldGeneratorType> 96 class FieldGeneratorMap { 97 public: 98 explicit FieldGeneratorMap(const Descriptor* descriptor, 99 Context* context); 100 ~FieldGeneratorMap(); 101 102 const FieldGeneratorType& get(const FieldDescriptor* field) const; 103 104 private: 105 const Descriptor* descriptor_; 106 Context* context_; 107 ClassNameResolver* name_resolver_; 108 scoped_array<scoped_ptr<FieldGeneratorType> > field_generators_; 109 110 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap); 111 }; 112 113 template<typename FieldGeneratorType> 114 inline const FieldGeneratorType& 115 FieldGeneratorMap<FieldGeneratorType>::get(const FieldDescriptor* field) const { 116 GOOGLE_CHECK_EQ(field->containing_type(), descriptor_); 117 return *field_generators_[field->index()]; 118 } 119 120 // Instantiate template for mutable and immutable maps. 121 template<> 122 FieldGeneratorMap<ImmutableFieldGenerator>:: 123 FieldGeneratorMap(const Descriptor* descriptor, 124 Context* context); 125 126 template<> 127 FieldGeneratorMap<ImmutableFieldGenerator>::~FieldGeneratorMap(); 128 129 130 // Field information used in FieldGeneartors. 131 struct FieldGeneratorInfo { 132 string name; 133 string capitalized_name; 134 string disambiguated_reason; 135 }; 136 137 // Oneof information used in OneofFieldGeneartors. 138 struct OneofGeneratorInfo { 139 string name; 140 string capitalized_name; 141 }; 142 143 // Set some common variables used in variable FieldGenerators. 144 void SetCommonFieldVariables(const FieldDescriptor* descriptor, 145 const FieldGeneratorInfo* info, 146 map<string, string>* variables); 147 148 // Set some common oneof variables used in OneofFieldGenerators. 149 void SetCommonOneofVariables(const FieldDescriptor* descriptor, 150 const OneofGeneratorInfo* info, 151 map<string, string>* variables); 152 153 // Print useful comments before a field's accessors. 154 void PrintExtraFieldInfo(const map<string, string>& variables, 155 io::Printer* printer); 156 157 } // namespace java 158 } // namespace compiler 159 } // namespace protobuf 160 161 } // namespace google 162 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_FIELD_H__ 163
