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 // Author: kenton (at) google.com (Kenton Varda)
     32 //  Based on original Protocol Buffers design by
     33 //  Sanjay Ghemawat, Jeff Dean, and others.
     34 
     35 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_EXTENSION_H__
     36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_EXTENSION_H__
     37 
     38 #include <map>
     39 #include <string>
     40 
     41 #include <google/protobuf/stubs/common.h>
     42 
     43 namespace google {
     44 namespace protobuf {
     45   class FieldDescriptor;       // descriptor.h
     46   namespace compiler {
     47     namespace java {
     48       class Context;           // context.h
     49       class ClassNameResolver; // name_resolver.h
     50     }
     51   }
     52   namespace io {
     53     class Printer;             // printer.h
     54   }
     55 }
     56 
     57 namespace protobuf {
     58 namespace compiler {
     59 namespace java {
     60 
     61 // Generates code for an extension, which may be within the scope of some
     62 // message or may be at file scope.  This is much simpler than FieldGenerator
     63 // since extensions are just simple identifiers with interesting types.
     64 class ExtensionGenerator {
     65  public:
     66   explicit ExtensionGenerator() {}
     67   virtual ~ExtensionGenerator() {}
     68 
     69   virtual void Generate(io::Printer* printer) = 0;
     70   virtual void GenerateNonNestedInitializationCode(io::Printer* printer) = 0;
     71   virtual void GenerateRegistrationCode(io::Printer* printer) = 0;
     72 
     73  protected:
     74   static void InitTemplateVars(const FieldDescriptor* descriptor,
     75                                const string& scope,
     76                                bool immutable,
     77                                ClassNameResolver* name_resolver,
     78                                map<string, string>* vars_pointer);
     79 
     80  private:
     81   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ExtensionGenerator);
     82 };
     83 
     84 class ImmutableExtensionGenerator : public ExtensionGenerator {
     85  public:
     86   explicit ImmutableExtensionGenerator(const FieldDescriptor* descriptor,
     87                                        Context* context);
     88   virtual ~ImmutableExtensionGenerator();
     89 
     90   virtual void Generate(io::Printer* printer);
     91   virtual void GenerateNonNestedInitializationCode(io::Printer* printer);
     92   virtual void GenerateRegistrationCode(io::Printer* printer);
     93 
     94  protected:
     95   const FieldDescriptor* descriptor_;
     96   Context* context_;
     97   ClassNameResolver* name_resolver_;
     98   string scope_;
     99 
    100  private:
    101   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableExtensionGenerator);
    102 };
    103 
    104 }  // namespace java
    105 }  // namespace compiler
    106 }  // namespace protobuf
    107 
    108 }  // namespace google
    109 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_EXTENSION_H__
    110