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