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