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: xiaofeng@google.com (Feng Xiao)
32//
33// Generators that generate shared code between immutable API and mutable API.
34
35#ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_SHARED_CODE_GENERATOR_H__
36#define GOOGLE_PROTOBUF_COMPILER_JAVA_SHARED_CODE_GENERATOR_H__
37
38#include <memory>
39#include <string>
40#include <vector>
41
42#include <google/protobuf/stubs/common.h>
43
44namespace google {
45namespace protobuf {
46  class FileDescriptor;        // descriptor.h
47  namespace compiler {
48    class GeneratorContext;    // code_generator.h
49    namespace java {
50      class ClassNameResolver;       // name_resolver.h
51    }
52  }
53  namespace io {
54    class Printer;             // printer.h
55  }
56}
57
58namespace protobuf {
59namespace compiler {
60namespace java {
61
62// A generator that generates code that are shared between immutable API
63// and mutable API. Currently only descriptors are shared.
64class SharedCodeGenerator {
65 public:
66  explicit SharedCodeGenerator(const FileDescriptor* file);
67  ~SharedCodeGenerator();
68
69  void Generate(GeneratorContext* generator_context,
70                vector<string>* file_list);
71  void GenerateDescriptors(io::Printer* printer);
72
73 private:
74  // Returns whether the dependency should be included in the output file.
75  // Always returns true for opensource, but used internally at Google to help
76  // improve compatibility with version 1 of protocol buffers.
77  bool ShouldIncludeDependency(const FileDescriptor* descriptor);
78
79  scoped_ptr<ClassNameResolver> name_resolver_;
80  const FileDescriptor* file_;
81  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(SharedCodeGenerator);
82};
83
84
85}  // namespace java
86}  // namespace compiler
87}  // namespace protobuf
88
89}  // namespace google
90#endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_SHARED_CODE_GENERATOR_H__
91