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