• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/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() override;
66 
67   // implements ImmutableFieldGenerator
68   // ---------------------------------------
69   int GetNumBitsForMessage() const override;
70   int GetNumBitsForBuilder() const override;
71   void GenerateInterfaceMembers(io::Printer* printer) const override;
72   void GenerateMembers(io::Printer* printer) const override;
73   void GenerateBuilderMembers(io::Printer* printer) const override;
74   void GenerateInitializationCode(io::Printer* printer) const override;
75   void GenerateBuilderClearCode(io::Printer* printer) const override;
76   void GenerateMergingCode(io::Printer* printer) const override;
77   void GenerateBuildingCode(io::Printer* printer) const override;
78   void GenerateBuilderParsingCode(io::Printer* printer) const override;
79   void GenerateSerializationCode(io::Printer* printer) const override;
80   void GenerateSerializedSizeCode(io::Printer* printer) const override;
81   void GenerateFieldBuilderInitializationCode(
82       io::Printer* printer) const override;
83   void GenerateEqualsCode(io::Printer* printer) const override;
84   void GenerateHashCode(io::Printer* printer) const override;
85   void GenerateKotlinDslMembers(io::Printer* printer) const override;
86 
87   std::string GetBoxedType() const override;
88 
89  protected:
90   const FieldDescriptor* descriptor_;
91   std::map<std::string, std::string> variables_;
92   ClassNameResolver* name_resolver_;
93 
94   void PrintNestedBuilderCondition(io::Printer* printer,
95                                    const char* regular_case,
96                                    const char* nested_builder_case) const;
97   void PrintNestedBuilderFunction(io::Printer* printer,
98                                   const char* method_prototype,
99                                   const char* regular_case,
100                                   const char* nested_builder_case,
101                                   const char* trailing_code) const;
102 
103  private:
104   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageFieldGenerator);
105   void GenerateKotlinOrNull(io::Printer* printer) const;
106 };
107 
108 class ImmutableMessageOneofFieldGenerator
109     : public ImmutableMessageFieldGenerator {
110  public:
111   ImmutableMessageOneofFieldGenerator(const FieldDescriptor* descriptor,
112                                       int messageBitIndex, int builderBitIndex,
113                                       Context* context);
114   ~ImmutableMessageOneofFieldGenerator() override;
115 
116   void GenerateMembers(io::Printer* printer) const override;
117   void GenerateBuilderMembers(io::Printer* printer) const override;
118   void GenerateBuilderClearCode(io::Printer* printer) const override;
119   void GenerateBuildingCode(io::Printer* printer) const override;
120   void GenerateMergingCode(io::Printer* printer) const override;
121   void GenerateBuilderParsingCode(io::Printer* printer) const override;
122   void GenerateSerializationCode(io::Printer* printer) const override;
123   void GenerateSerializedSizeCode(io::Printer* printer) const override;
124 
125  private:
126   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageOneofFieldGenerator);
127 };
128 
129 class RepeatedImmutableMessageFieldGenerator : public ImmutableFieldGenerator {
130  public:
131   explicit RepeatedImmutableMessageFieldGenerator(
132       const FieldDescriptor* descriptor, int messageBitIndex,
133       int builderBitIndex, Context* context);
134   ~RepeatedImmutableMessageFieldGenerator() override;
135 
136   // implements ImmutableFieldGenerator ---------------------------------------
137   int GetNumBitsForMessage() const override;
138   int GetNumBitsForBuilder() const override;
139   void GenerateInterfaceMembers(io::Printer* printer) const override;
140   void GenerateMembers(io::Printer* printer) const override;
141   void GenerateBuilderMembers(io::Printer* printer) const override;
142   void GenerateInitializationCode(io::Printer* printer) const override;
143   void GenerateBuilderClearCode(io::Printer* printer) const override;
144   void GenerateMergingCode(io::Printer* printer) const override;
145   void GenerateBuildingCode(io::Printer* printer) const override;
146   void GenerateBuilderParsingCode(io::Printer* printer) const override;
147   void GenerateSerializationCode(io::Printer* printer) const override;
148   void GenerateSerializedSizeCode(io::Printer* printer) const override;
149   void GenerateFieldBuilderInitializationCode(
150       io::Printer* printer) const override;
151   void GenerateEqualsCode(io::Printer* printer) const override;
152   void GenerateHashCode(io::Printer* printer) const override;
153   void GenerateKotlinDslMembers(io::Printer* printer) const override;
154 
155   std::string GetBoxedType() const override;
156 
157  protected:
158   const FieldDescriptor* descriptor_;
159   std::map<std::string, std::string> variables_;
160   ClassNameResolver* name_resolver_;
161 
162   void PrintNestedBuilderCondition(io::Printer* printer,
163                                    const char* regular_case,
164                                    const char* nested_builder_case) const;
165   void PrintNestedBuilderFunction(io::Printer* printer,
166                                   const char* method_prototype,
167                                   const char* regular_case,
168                                   const char* nested_builder_case,
169                                   const char* trailing_code) const;
170 
171  private:
172   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(RepeatedImmutableMessageFieldGenerator);
173 };
174 
175 }  // namespace java
176 }  // namespace compiler
177 }  // namespace protobuf
178 }  // namespace google
179 
180 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__
181