• 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_CPP_MESSAGE_FIELD_H__
36 #define GOOGLE_PROTOBUF_COMPILER_CPP_MESSAGE_FIELD_H__
37 
38 #include <map>
39 #include <string>
40 #include <google/protobuf/compiler/cpp/cpp_field.h>
41 
42 namespace google {
43 namespace protobuf {
44 namespace compiler {
45 namespace cpp {
46 
47 class MessageFieldGenerator : public FieldGenerator {
48  public:
49   MessageFieldGenerator(const FieldDescriptor* descriptor,
50                         const Options& options);
51   ~MessageFieldGenerator();
52 
53   // implements FieldGenerator ---------------------------------------
54   void GeneratePrivateMembers(io::Printer* printer) const;
55   void GenerateDependentAccessorDeclarations(io::Printer* printer) const;
56   void GenerateAccessorDeclarations(io::Printer* printer) const;
57   void GenerateDependentInlineAccessorDefinitions(io::Printer* printer) const;
58   void GenerateInlineAccessorDefinitions(io::Printer* printer,
59                                          bool is_inline) const;
60   void GenerateNonInlineAccessorDefinitions(io::Printer* printer) const;
61   void GenerateClearingCode(io::Printer* printer) const;
62   void GenerateMergingCode(io::Printer* printer) const;
63   void GenerateSwappingCode(io::Printer* printer) const;
64   void GenerateConstructorCode(io::Printer* printer) const;
65   void GenerateMergeFromCodedStream(io::Printer* printer) const;
66   void GenerateSerializeWithCachedSizes(io::Printer* printer) const;
67   void GenerateSerializeWithCachedSizesToArray(io::Printer* printer) const;
68   void GenerateByteSize(io::Printer* printer) const;
69 
70  protected:
71   void GenerateArenaManipulationCode(const map<string, string>& variables,
72                                      io::Printer* printer) const;
73 
74   virtual void GenerateGetterDeclaration(io::Printer* printer) const;
75 
76   const FieldDescriptor* descriptor_;
77   const bool dependent_field_;
78   map<string, string> variables_;
79 
80  private:
81   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MessageFieldGenerator);
82 };
83 
84 class MessageOneofFieldGenerator : public MessageFieldGenerator {
85  public:
86   MessageOneofFieldGenerator(const FieldDescriptor* descriptor,
87                              const Options& options);
88   ~MessageOneofFieldGenerator();
89 
90   // implements FieldGenerator ---------------------------------------
91   void GenerateDependentAccessorDeclarations(io::Printer* printer) const;
92   void GenerateDependentInlineAccessorDefinitions(io::Printer* printer) const;
93   void GenerateInlineAccessorDefinitions(io::Printer* printer,
94                                          bool is_inline) const;
95   void GenerateNonInlineAccessorDefinitions(io::Printer* printer) const;
96   void GenerateClearingCode(io::Printer* printer) const;
97   void GenerateSwappingCode(io::Printer* printer) const;
98   void GenerateConstructorCode(io::Printer* printer) const;
99 
100  protected:
101   void GenerateGetterDeclaration(io::Printer* printer) const;
102 
103  private:
104   void InternalGenerateInlineAccessorDefinitions(
105       const map<string, string>& variables, io::Printer* printer) const;
106 
107   const bool dependent_base_;
108   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MessageOneofFieldGenerator);
109 };
110 
111 class RepeatedMessageFieldGenerator : public FieldGenerator {
112  public:
113   RepeatedMessageFieldGenerator(const FieldDescriptor* descriptor,
114                                 const Options& options);
115   ~RepeatedMessageFieldGenerator();
116 
117   // implements FieldGenerator ---------------------------------------
118   void GeneratePrivateMembers(io::Printer* printer) const;
119   void GenerateDependentAccessorDeclarations(io::Printer* printer) const;
120   void GenerateAccessorDeclarations(io::Printer* printer) const;
121   void GenerateDependentInlineAccessorDefinitions(io::Printer* printer) const;
122   void GenerateInlineAccessorDefinitions(io::Printer* printer,
123                                          bool is_inline) const;
124   void GenerateClearingCode(io::Printer* printer) const;
125   void GenerateMergingCode(io::Printer* printer) const;
126   void GenerateSwappingCode(io::Printer* printer) const;
127   void GenerateConstructorCode(io::Printer* printer) const;
128   void GenerateMergeFromCodedStream(io::Printer* printer) const;
129   void GenerateSerializeWithCachedSizes(io::Printer* printer) const;
130   void GenerateSerializeWithCachedSizesToArray(io::Printer* printer) const;
131   void GenerateByteSize(io::Printer* printer) const;
132 
133  private:
134   void InternalGenerateTypeDependentAccessorDeclarations(
135       io::Printer* printer) const;
136 
137   const FieldDescriptor* descriptor_;
138   const bool dependent_field_;
139   const bool dependent_getter_;
140   map<string, string> variables_;
141 
142   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(RepeatedMessageFieldGenerator);
143 };
144 
145 }  // namespace cpp
146 }  // namespace compiler
147 }  // namespace protobuf
148 
149 }  // namespace google
150 #endif  // GOOGLE_PROTOBUF_COMPILER_CPP_MESSAGE_FIELD_H__
151