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