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