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 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_CONTEXT_H__
32 #define GOOGLE_PROTOBUF_COMPILER_JAVA_CONTEXT_H__
33 
34 #include <map>
35 #include <memory>
36 #ifndef _SHARED_PTR_H
37 #include <google/protobuf/stubs/shared_ptr.h>
38 #endif
39 #include <vector>
40 
41 #include <google/protobuf/stubs/common.h>
42 #include <google/protobuf/compiler/java/java_options.h>
43 
44 namespace google {
45 namespace protobuf {
46   class FileDescriptor;
47   class FieldDescriptor;
48   class OneofDescriptor;
49   class Descriptor;
50   class EnumDescriptor;
51   namespace compiler {
52     namespace java {
53       class ClassNameResolver;  // name_resolver.h
54     }
55   }
56 }  // namespace protobuf
57 
58 namespace protobuf {
59 namespace compiler {
60 namespace java {
61 
62 struct FieldGeneratorInfo;
63 struct OneofGeneratorInfo;
64 // A context object holds the information that is shared among all code
65 // generators.
66 class Context {
67  public:
68   Context(const FileDescriptor* file, const Options& options);
69   ~Context();
70 
71   // Get the name resolver associated with this context. The resolver
72   // can be used to map descriptors to Java class names.
73   ClassNameResolver* GetNameResolver();
74 
75   // Get the FieldGeneratorInfo for a given field.
76   const FieldGeneratorInfo* GetFieldGeneratorInfo(
77       const FieldDescriptor* field) const;
78 
79   // Get the OneofGeneratorInfo for a given oneof.
80   const OneofGeneratorInfo* GetOneofGeneratorInfo(
81       const OneofDescriptor* oneof) const;
82 
options()83   const Options& options() const { return options_; }
84 
85   // Enforces all the files (including transitive dependencies) to use
86   // LiteRuntime.
87 
EnforceLite()88   bool EnforceLite() const { return options_.enforce_lite; }
89 
90   // Does this message class have generated parsing, serialization, and other
91   // standard methods for which reflection-based fallback implementations exist?
92   bool HasGeneratedMethods(const Descriptor* descriptor) const;
93 
94  private:
95   void InitializeFieldGeneratorInfo(const FileDescriptor* file);
96   void InitializeFieldGeneratorInfoForMessage(const Descriptor* message);
97   void InitializeFieldGeneratorInfoForFields(
98       const vector<const FieldDescriptor*>& fields);
99 
100   google::protobuf::scoped_ptr<ClassNameResolver> name_resolver_;
101   map<const FieldDescriptor*, FieldGeneratorInfo> field_generator_info_map_;
102   map<const OneofDescriptor*, OneofGeneratorInfo> oneof_generator_info_map_;
103   Options options_;
104   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(Context);
105 };
106 
107 }  // namespace java
108 }  // namespace compiler
109 }  // namespace protobuf
110 
111 }  // namespace google
112 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_CONTEXT_H__
113