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