temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 1 | // Protocol Buffers - Google's data interchange format |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 2 | // Copyright 2008 Google Inc. All rights reserved. |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 3 | // http://code.google.com/p/protobuf/ |
| 4 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 5 | // Redistribution and use in source and binary forms, with or without |
| 6 | // modification, are permitted provided that the following conditions are |
| 7 | // met: |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 8 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 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. |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 18 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 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. |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 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 <string> |
| 39 | #include <vector> |
| 40 | #include <google/protobuf/stubs/common.h> |
| 41 | |
| 42 | namespace google { |
| 43 | namespace protobuf { |
| 44 | class FileDescriptor; // descriptor.h |
| 45 | namespace io { |
| 46 | class Printer; // printer.h |
| 47 | } |
| 48 | namespace compiler { |
liujisi@google.com | 33165fe | 2010-11-02 13:14:58 +0000 | [diff] [blame^] | 49 | class GeneratorContext; // code_generator.h |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 50 | } |
| 51 | } |
| 52 | |
| 53 | namespace protobuf { |
| 54 | namespace compiler { |
| 55 | namespace java { |
| 56 | |
| 57 | class FileGenerator { |
| 58 | public: |
| 59 | explicit FileGenerator(const FileDescriptor* file); |
| 60 | ~FileGenerator(); |
| 61 | |
| 62 | // Checks for problems that would otherwise lead to cryptic compile errors. |
| 63 | // Returns true if there are no problems, or writes an error description to |
| 64 | // the given string and returns false otherwise. |
| 65 | bool Validate(string* error); |
| 66 | |
| 67 | void Generate(io::Printer* printer); |
| 68 | |
| 69 | // If we aren't putting everything into one file, this will write all the |
| 70 | // files other than the outer file (i.e. one for each message, enum, and |
| 71 | // service type). |
| 72 | void GenerateSiblings(const string& package_dir, |
liujisi@google.com | 33165fe | 2010-11-02 13:14:58 +0000 | [diff] [blame^] | 73 | GeneratorContext* generator_context, |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 74 | vector<string>* file_list); |
| 75 | |
| 76 | const string& java_package() { return java_package_; } |
| 77 | const string& classname() { return classname_; } |
| 78 | |
liujisi@google.com | 33165fe | 2010-11-02 13:14:58 +0000 | [diff] [blame^] | 79 | |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 80 | private: |
kenton@google.com | fccb146 | 2009-12-18 02:11:36 +0000 | [diff] [blame] | 81 | // Returns whether the dependency should be included in the output file. |
| 82 | // Always returns true for opensource, but used internally at Google to help |
| 83 | // improve compatibility with version 1 of protocol buffers. |
| 84 | bool ShouldIncludeDependency(const FileDescriptor* descriptor); |
| 85 | |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 86 | const FileDescriptor* file_; |
| 87 | string java_package_; |
| 88 | string classname_; |
| 89 | |
liujisi@google.com | 33165fe | 2010-11-02 13:14:58 +0000 | [diff] [blame^] | 90 | |
kenton@google.com | 80b1d62 | 2009-07-29 01:13:20 +0000 | [diff] [blame] | 91 | void GenerateEmbeddedDescriptor(io::Printer* printer); |
| 92 | |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 93 | GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator); |
| 94 | }; |
| 95 | |
| 96 | } // namespace java |
| 97 | } // namespace compiler |
| 98 | } // namespace protobuf |
| 99 | |
| 100 | } // namespace google |
| 101 | #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__ |