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
46namespace google {
47namespace protobuf {
48  class FileDescriptor;          // descriptor.h
49  namespace io {
50    class Printer;               // printer.h
51  }
52  namespace compiler {
53    class GeneratorContext;      // code_generator.h
54    namespace java {
55      class Context;             // context.h
56      class MessageGenerator;    // message.h
57      class GeneratorFactory;    // generator_factory.h
58      class ExtensionGenerator;  // extension.h
59      class ClassNameResolver;   // name_resolver.h
60    }
61  }
62}
63
64namespace protobuf {
65namespace compiler {
66namespace java {
67
68class FileGenerator {
69 public:
70  FileGenerator(const FileDescriptor* file, bool immutable_api = true,
71                bool enforce_lite = false);
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(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 string& package_dir,
85                        GeneratorContext* generator_context,
86                        vector<string>* file_list);
87
88  const string& java_package() { return java_package_; }
89  const string& classname()    { return classname_;    }
90
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  string java_package_;
101  string classname_;
102
103  google::protobuf::scoped_array<google::protobuf::scoped_ptr<MessageGenerator> > message_generators_;
104  google::protobuf::scoped_array<google::protobuf::scoped_ptr<ExtensionGenerator> > extension_generators_;
105  google::protobuf::scoped_ptr<GeneratorFactory> generator_factory_;
106  google::protobuf::scoped_ptr<Context> context_;
107  ClassNameResolver* name_resolver_;
108  bool immutable_api_;
109
110
111  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator);
112};
113
114}  // namespace java
115}  // namespace compiler
116}  // namespace protobuf
117
118}  // namespace google
119#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__
120