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_FILE_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__ 37 38 #include <memory> 39 #include <string> 40 #include <vector> 41 42 #include <google/protobuf/stubs/common.h> 43 #include <google/protobuf/compiler/java/java_options.h> 44 45 namespace google { 46 namespace protobuf { 47 class FileDescriptor; // descriptor.h 48 namespace io { 49 class Printer; // printer.h 50 } 51 namespace compiler { 52 class GeneratorContext; // code_generator.h 53 namespace java { 54 class Context; // context.h 55 class MessageGenerator; // message.h 56 class GeneratorFactory; // generator_factory.h 57 class ExtensionGenerator; // extension.h 58 class ClassNameResolver; // name_resolver.h 59 } // namespace java 60 } // namespace compiler 61 } // namespace protobuf 62 } // namespace google 63 64 namespace google { 65 namespace protobuf { 66 namespace compiler { 67 namespace java { 68 69 class FileGenerator { 70 public: 71 FileGenerator(const FileDescriptor* file, const Options& options, 72 bool immutable_api = true); 73 ~FileGenerator(); 74 75 // Checks for problems that would otherwise lead to cryptic compile errors. 76 // Returns true if there are no problems, or writes an error description to 77 // the given string and returns false otherwise. 78 bool Validate(std::string* error); 79 80 void Generate(io::Printer* printer); 81 82 std::string GetKotlinClassname(); 83 void GenerateKotlinSiblings(const std::string& package_dir, 84 GeneratorContext* generator_context, 85 std::vector<std::string>* file_list, 86 std::vector<std::string>* annotation_list); 87 88 // If we aren't putting everything into one file, this will write all the 89 // files other than the outer file (i.e. one for each message, enum, and 90 // service type). 91 void GenerateSiblings(const std::string& package_dir, 92 GeneratorContext* generator_context, 93 std::vector<std::string>* file_list, 94 std::vector<std::string>* annotation_list); 95 java_package()96 const std::string& java_package() { return java_package_; } classname()97 const std::string& classname() { return classname_; } 98 99 private: 100 void GenerateDescriptorInitializationCodeForImmutable(io::Printer* printer); 101 void GenerateDescriptorInitializationCodeForMutable(io::Printer* printer); 102 103 bool ShouldIncludeDependency(const FileDescriptor* descriptor, 104 bool immutable_api_); 105 106 const FileDescriptor* file_; 107 std::string java_package_; 108 std::string classname_; 109 110 std::vector<std::unique_ptr<MessageGenerator>> message_generators_; 111 std::vector<std::unique_ptr<ExtensionGenerator>> extension_generators_; 112 std::unique_ptr<GeneratorFactory> generator_factory_; 113 std::unique_ptr<Context> context_; 114 ClassNameResolver* name_resolver_; 115 const Options options_; 116 bool immutable_api_; 117 118 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator); 119 }; 120 121 } // namespace java 122 } // namespace compiler 123 } // namespace protobuf 124 } // namespace google 125 126 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__ 127