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