• 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: kenton@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 }  // namespace java
51 }  // namespace compiler
52 namespace io {
53 class Printer;  // printer.h
54 }
55 }  // namespace protobuf
56 }  // namespace google
57 
58 namespace google {
59 namespace protobuf {
60 namespace compiler {
61 namespace java {
62 
63 // Generates code for an extension, which may be within the scope of some
64 // message or may be at file scope.  This is much simpler than FieldGenerator
65 // since extensions are just simple identifiers with interesting types.
66 class ExtensionGenerator {
67  public:
ExtensionGenerator()68   explicit ExtensionGenerator() {}
~ExtensionGenerator()69   virtual ~ExtensionGenerator() {}
70 
71   virtual void Generate(io::Printer* printer) = 0;
72 
73   // Returns an estimate of the number of bytes the printed code will compile
74   // to
75   virtual int GenerateNonNestedInitializationCode(io::Printer* printer) = 0;
76 
77   // Returns an estimate of the number of bytes the printed code will compile
78   // to
79   virtual int GenerateRegistrationCode(io::Printer* printer) = 0;
80 
81  protected:
82   static void InitTemplateVars(
83       const FieldDescriptor* descriptor, const std::string& scope,
84       bool immutable, ClassNameResolver* name_resolver,
85       std::map<std::string, std::string>* vars_pointer);
86 
87  private:
88   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ExtensionGenerator);
89 };
90 
91 class ImmutableExtensionGenerator : public ExtensionGenerator {
92  public:
93   explicit ImmutableExtensionGenerator(const FieldDescriptor* descriptor,
94                                        Context* context);
95   ~ImmutableExtensionGenerator() override;
96 
97   void Generate(io::Printer* printer) override;
98   int GenerateNonNestedInitializationCode(io::Printer* printer) override;
99   int GenerateRegistrationCode(io::Printer* printer) override;
100 
101  protected:
102   const FieldDescriptor* descriptor_;
103   ClassNameResolver* name_resolver_;
104   std::string scope_;
105 
106  private:
107   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableExtensionGenerator);
108 };
109 
110 }  // namespace java
111 }  // namespace compiler
112 }  // namespace protobuf
113 }  // namespace google
114 
115 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_EXTENSION_H__
116