1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // http://code.google.com/p/protobuf/ 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 (at) 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 <google/protobuf/stubs/common.h> 40 #include <google/protobuf/compiler/java/java_field.h> 41 42 namespace google { 43 namespace protobuf { 44 namespace io { 45 class Printer; // printer.h 46 } 47 } 48 49 namespace protobuf { 50 namespace compiler { 51 namespace java { 52 53 class MessageGenerator { 54 public: 55 explicit MessageGenerator(const Descriptor* descriptor); 56 ~MessageGenerator(); 57 58 // All static variables have to be declared at the top-level of the file 59 // so that we can control initialization order, which is important for 60 // DescriptorProto bootstrapping to work. 61 void GenerateStaticVariables(io::Printer* printer); 62 63 // Output code which initializes the static variables generated by 64 // GenerateStaticVariables(). 65 void GenerateStaticVariableInitializers(io::Printer* printer); 66 67 // Generate the class itself. 68 void Generate(io::Printer* printer); 69 70 // Generates the base interface that both the class and its builder implement 71 void GenerateInterface(io::Printer* printer); 72 73 // Generate code to register all contained extensions with an 74 // ExtensionRegistry. 75 void GenerateExtensionRegistrationCode(io::Printer* printer); 76 77 private: 78 enum UseMemoization { 79 MEMOIZE, 80 DONT_MEMOIZE 81 }; 82 83 void GenerateMessageSerializationMethods(io::Printer* printer); 84 void GenerateParseFromMethods(io::Printer* printer); 85 void GenerateSerializeOneField(io::Printer* printer, 86 const FieldDescriptor* field); 87 void GenerateSerializeOneExtensionRange( 88 io::Printer* printer, const Descriptor::ExtensionRange* range); 89 90 void GenerateBuilder(io::Printer* printer); 91 void GenerateCommonBuilderMethods(io::Printer* printer); 92 void GenerateDescriptorMethods(io::Printer* printer); 93 void GenerateBuilderParsingMethods(io::Printer* printer); 94 void GenerateIsInitialized(io::Printer* printer, 95 UseMemoization useMemoization); 96 void GenerateEqualsAndHashCode(io::Printer* printer); 97 98 void GenerateParser(io::Printer* printer); 99 void GenerateParsingConstructor(io::Printer* printer); 100 101 const Descriptor* descriptor_; 102 FieldGeneratorMap field_generators_; 103 104 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MessageGenerator); 105 }; 106 107 } // namespace java 108 } // namespace compiler 109 } // namespace protobuf 110 111 } // namespace google 112 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_H__ 113