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