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