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