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