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 #ifndef _SHARED_PTR_H
40 #include <google/protobuf/stubs/shared_ptr.h>
41 #endif
42 #include <string>
43 #include <vector>
44 #include <google/protobuf/stubs/common.h>
45 #include <google/protobuf/compiler/java/java_options.h>
46 
47 namespace google {
48 namespace protobuf {
49   class FileDescriptor;          // descriptor.h
50   namespace io {
51     class Printer;               // printer.h
52   }
53   namespace compiler {
54     class GeneratorContext;      // code_generator.h
55     namespace java {
56       class Context;             // context.h
57       class MessageGenerator;    // message.h
58       class GeneratorFactory;    // generator_factory.h
59       class ExtensionGenerator;  // extension.h
60       class ClassNameResolver;   // name_resolver.h
61     }
62   }
63 }
64 
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(string* error);
79 
80   void Generate(io::Printer* printer);
81 
82   // If we aren't putting everything into one file, this will write all the
83   // files other than the outer file (i.e. one for each message, enum, and
84   // service type).
85   void GenerateSiblings(const string& package_dir,
86                         GeneratorContext* generator_context,
87                         vector<string>* file_list,
88                         vector<string>* annotation_list);
89 
java_package()90   const string& java_package() { return java_package_; }
classname()91   const string& classname()    { return classname_;    }
92 
93  private:
94   void GenerateDescriptorInitializationCodeForImmutable(io::Printer* printer);
95   void GenerateDescriptorInitializationCodeForMutable(io::Printer* printer);
96 
97   bool ShouldIncludeDependency(const FileDescriptor* descriptor,
98                                bool immutable_api_);
99 
100   const FileDescriptor* file_;
101   string java_package_;
102   string classname_;
103 
104   google::protobuf::scoped_array<google::protobuf::scoped_ptr<MessageGenerator> > message_generators_;
105   google::protobuf::scoped_array<google::protobuf::scoped_ptr<ExtensionGenerator> > extension_generators_;
106   google::protobuf::scoped_ptr<GeneratorFactory> generator_factory_;
107   google::protobuf::scoped_ptr<Context> context_;
108   ClassNameResolver* name_resolver_;
109   const Options options_;
110   bool immutable_api_;
111 
112   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator);
113 };
114 
115 }  // namespace java
116 }  // namespace compiler
117 }  // namespace protobuf
118 
119 }  // namespace google
120 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__
121