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_ENUM_FIELD_H__
36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_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     }
49   }
50 }
51 
52 namespace protobuf {
53 namespace compiler {
54 namespace java {
55 
56 class ImmutableEnumFieldGenerator : public ImmutableFieldGenerator {
57  public:
58   explicit ImmutableEnumFieldGenerator(
59       const FieldDescriptor* descriptor, int messageBitIndex,
60       int builderBitIndex, Context* context);
61   ~ImmutableEnumFieldGenerator();
62 
63   // implements ImmutableFieldGenerator ---------------------------------------
64   int GetNumBitsForMessage() const;
65   int GetNumBitsForBuilder() const;
66   void GenerateInterfaceMembers(io::Printer* printer) const;
67   void GenerateMembers(io::Printer* printer) const;
68   void GenerateBuilderMembers(io::Printer* printer) const;
69   void GenerateInitializationCode(io::Printer* printer) const;
70   void GenerateBuilderClearCode(io::Printer* printer) const;
71   void GenerateMergingCode(io::Printer* printer) const;
72   void GenerateBuildingCode(io::Printer* printer) const;
73   void GenerateParsingCode(io::Printer* printer) const;
74   void GenerateParsingDoneCode(io::Printer* printer) const;
75   void GenerateSerializationCode(io::Printer* printer) const;
76   void GenerateSerializedSizeCode(io::Printer* printer) const;
77   void GenerateFieldBuilderInitializationCode(io::Printer* printer) const;
78   void GenerateEqualsCode(io::Printer* printer) const;
79   void GenerateHashCode(io::Printer* printer) const;
80 
81   string GetBoxedType() const;
82 
83  protected:
84   const FieldDescriptor* descriptor_;
85   map<string, string> variables_;
86   const int messageBitIndex_;
87   const int builderBitIndex_;
88   Context* context_;
89   ClassNameResolver* name_resolver_;
90 
91  private:
92   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableEnumFieldGenerator);
93 };
94 
95 class ImmutableEnumOneofFieldGenerator : public ImmutableEnumFieldGenerator {
96  public:
97   ImmutableEnumOneofFieldGenerator(
98       const FieldDescriptor* descriptor, int messageBitIndex,
99       int builderBitIndex, Context* context);
100   ~ImmutableEnumOneofFieldGenerator();
101 
102   void GenerateMembers(io::Printer* printer) const;
103   void GenerateBuilderMembers(io::Printer* printer) const;
104   void GenerateMergingCode(io::Printer* printer) const;
105   void GenerateBuildingCode(io::Printer* printer) const;
106   void GenerateParsingCode(io::Printer* printer) const;
107   void GenerateSerializationCode(io::Printer* printer) const;
108   void GenerateSerializedSizeCode(io::Printer* printer) const;
109 
110  private:
111   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableEnumOneofFieldGenerator);
112 };
113 
114 class RepeatedImmutableEnumFieldGenerator : public ImmutableFieldGenerator {
115  public:
116   explicit RepeatedImmutableEnumFieldGenerator(
117       const FieldDescriptor* descriptor, int messageBitIndex,
118       int builderBitIndex, Context* context);
119   ~RepeatedImmutableEnumFieldGenerator();
120 
121   // implements ImmutableFieldGenerator ---------------------------------------
122   int GetNumBitsForMessage() const;
123   int GetNumBitsForBuilder() const;
124   void GenerateInterfaceMembers(io::Printer* printer) const;
125   void GenerateMembers(io::Printer* printer) const;
126   void GenerateBuilderMembers(io::Printer* printer) const;
127   void GenerateInitializationCode(io::Printer* printer) const;
128   void GenerateBuilderClearCode(io::Printer* printer) const;
129   void GenerateMergingCode(io::Printer* printer) const;
130   void GenerateBuildingCode(io::Printer* printer) const;
131   void GenerateParsingCode(io::Printer* printer) const;
132   void GenerateParsingCodeFromPacked(io::Printer* printer) const;
133   void GenerateParsingDoneCode(io::Printer* printer) const;
134   void GenerateSerializationCode(io::Printer* printer) const;
135   void GenerateSerializedSizeCode(io::Printer* printer) const;
136   void GenerateFieldBuilderInitializationCode(io::Printer* printer) const;
137   void GenerateEqualsCode(io::Printer* printer) const;
138   void GenerateHashCode(io::Printer* printer) const;
139 
140   string GetBoxedType() const;
141 
142  private:
143   const FieldDescriptor* descriptor_;
144   map<string, string> variables_;
145   const int messageBitIndex_;
146   const int builderBitIndex_;
147   Context* context_;
148   ClassNameResolver* name_resolver_;
149 
150   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(RepeatedImmutableEnumFieldGenerator);
151 };
152 
153 }  // namespace java
154 }  // namespace compiler
155 }  // namespace protobuf
156 
157 }  // namespace google
158 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_ENUM_FIELD_H__
159