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_H__
36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_H__
37 
38 #include <string>
39 #include <map>
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   namespace io {
51     class Printer;             // printer.h
52   }
53 }
54 
55 namespace protobuf {
56 namespace compiler {
57 namespace java {
58 
59 class MessageGenerator {
60  public:
61   explicit MessageGenerator(const Descriptor* descriptor);
62   virtual ~MessageGenerator();
63 
64   // All static variables have to be declared at the top-level of the file
65   // so that we can control initialization order, which is important for
66   // DescriptorProto bootstrapping to work.
67   virtual void GenerateStaticVariables(io::Printer* printer) = 0;
68 
69   // Output code which initializes the static variables generated by
70   // GenerateStaticVariables().
71   virtual void GenerateStaticVariableInitializers(io::Printer* printer) = 0;
72 
73   // Generate the class itself.
74   virtual void Generate(io::Printer* printer) = 0;
75 
76   // Generates the base interface that both the class and its builder implement
77   virtual void GenerateInterface(io::Printer* printer) = 0;
78 
79   // Generate code to register all contained extensions with an
80   // ExtensionRegistry.
81   virtual void GenerateExtensionRegistrationCode(io::Printer* printer) = 0;
82 
83  protected:
84   const Descriptor* descriptor_;
85 
86  private:
87   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MessageGenerator);
88 };
89 
90 class ImmutableMessageGenerator : public MessageGenerator {
91  public:
92   explicit ImmutableMessageGenerator(const Descriptor* descriptor,
93                                      Context* context);
94   virtual ~ImmutableMessageGenerator();
95 
96   virtual void Generate(io::Printer* printer);
97   virtual void GenerateInterface(io::Printer* printer);
98   virtual void GenerateExtensionRegistrationCode(io::Printer* printer);
99   virtual void GenerateStaticVariables(io::Printer* printer);
100   virtual void GenerateStaticVariableInitializers(io::Printer* printer);
101 
102  private:
103   enum UseMemoization {
104     MEMOIZE,
105     DONT_MEMOIZE
106   };
107 
108   void GenerateFieldAccessorTable(io::Printer* printer);
109   void GenerateFieldAccessorTableInitializer(io::Printer* printer);
110 
111   void GenerateMessageSerializationMethods(io::Printer* printer);
112   void GenerateParseFromMethods(io::Printer* printer);
113   void GenerateSerializeOneField(io::Printer* printer,
114                                  const FieldDescriptor* field);
115   void GenerateSerializeOneExtensionRange(
116       io::Printer* printer, const Descriptor::ExtensionRange* range);
117 
118   void GenerateBuilder(io::Printer* printer);
119   void GenerateCommonBuilderMethods(io::Printer* printer);
120   void GenerateDescriptorMethods(io::Printer* printer);
121   void GenerateBuilderParsingMethods(io::Printer* printer);
122   void GenerateIsInitialized(io::Printer* printer,
123       UseMemoization useMemoization);
124   void GenerateEqualsAndHashCode(io::Printer* printer);
125   void GenerateParser(io::Printer* printer);
126   void GenerateParsingConstructor(io::Printer* printer);
127 
128   Context* context_;
129   ClassNameResolver* name_resolver_;
130   FieldGeneratorMap<ImmutableFieldGenerator> field_generators_;
131 
132   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageGenerator);
133 };
134 
135 }  // namespace java
136 }  // namespace compiler
137 }  // namespace protobuf
138 
139 }  // namespace google
140 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_H__
141