src/google/protobuf/compiler/java/java_message_field.h

   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_MESSAGE_FIELD_H__
  36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__
  37
  38 #include <map>
  39 #include <string>
  40 #include <google/protobuf/compiler/java/java_field.h>
  41
  42 namespace google {
  43 namespace protobuf {
  44   namespace compiler {
  45     namespace java {
  46       class Context;           // context.h
  47       class ClassNameResolver; // name_resolver.h
  48     }
  49   }
  50 }
  51
  52 namespace protobuf {
  53 namespace compiler {
  54 namespace java {
  55
  56 class ImmutableMessageFieldGenerator : public ImmutableFieldGenerator {
  57  public:
  58   explicit ImmutableMessageFieldGenerator(
  59       const FieldDescriptor* descriptor, int messageBitIndex,
  60       int builderBitIndex, Context* context);
  61   ~ImmutableMessageFieldGenerator();
  62
  63   // implements ImmutableFieldGenerator ---------------------------------------
  64   int GetNumBitsForMessage() const;
  65   int GetNumBitsForBuilder() const;
  66   void GenerateInterfaceMembers(io::Printer* printer) const;
  67   void GenerateMembers(io::Printer* printer) const;
  68   void GenerateBuilderMembers(io::Printer* printer) const;
  69   void GenerateInitializationCode(io::Printer* printer) const;
  70   void GenerateBuilderClearCode(io::Printer* printer) const;
  71   void GenerateMergingCode(io::Printer* printer) const;
  72   void GenerateBuildingCode(io::Printer* printer) const;
  73   void GenerateParsingCode(io::Printer* printer) const;
  74   void GenerateParsingDoneCode(io::Printer* printer) const;
  75   void GenerateSerializationCode(io::Printer* printer) const;
  76   void GenerateSerializedSizeCode(io::Printer* printer) const;
  77   void GenerateFieldBuilderInitializationCode(io::Printer* printer) const;
  78   void GenerateEqualsCode(io::Printer* printer) const;
  79   void GenerateHashCode(io::Printer* printer) const;
  80
  81   string GetBoxedType() const;
  82
  83  protected:
  84   const FieldDescriptor* descriptor_;
  85   map<string, string> variables_;
  86   const int messageBitIndex_;
  87   const int builderBitIndex_;
  88   Context* context_;
  89   ClassNameResolver* name_resolver_;
  90
  91   void PrintNestedBuilderCondition(io::Printer* printer,
  92       const char* regular_case, const char* nested_builder_case) const;
  93   void PrintNestedBuilderFunction(io::Printer* printer,
  94       const char* method_prototype, const char* regular_case,
  95       const char* nested_builder_case,
  96       const char* trailing_code) const;
  97
  98  private:
  99   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageFieldGenerator);
 100 };
 101
 102 class ImmutableMessageOneofFieldGenerator
 103     : public ImmutableMessageFieldGenerator {
 104  public:
 105   ImmutableMessageOneofFieldGenerator(
 106       const FieldDescriptor* descriptor, int messageBitIndex,
 107       int builderBitIndex, Context* context);
 108   ~ImmutableMessageOneofFieldGenerator();
 109
 110   void GenerateMembers(io::Printer* printer) const;
 111   void GenerateBuilderMembers(io::Printer* printer) const;
 112   void GenerateBuildingCode(io::Printer* printer) const;
 113   void GenerateMergingCode(io::Printer* printer) const;
 114   void GenerateParsingCode(io::Printer* printer) const;
 115   void GenerateSerializationCode(io::Printer* printer) const;
 116   void GenerateSerializedSizeCode(io::Printer* printer) const;
 117
 118  private:
 119   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageOneofFieldGenerator);
 120 };
 121
 122 class RepeatedImmutableMessageFieldGenerator : public ImmutableFieldGenerator {
 123  public:
 124   explicit RepeatedImmutableMessageFieldGenerator(
 125       const FieldDescriptor* descriptor, int messageBitIndex,
 126       int builderBitIndex, Context* context);
 127   ~RepeatedImmutableMessageFieldGenerator();
 128
 129   // implements ImmutableFieldGenerator ---------------------------------------
 130   int GetNumBitsForMessage() const;
 131   int GetNumBitsForBuilder() const;
 132   void GenerateInterfaceMembers(io::Printer* printer) const;
 133   void GenerateMembers(io::Printer* printer) const;
 134   void GenerateBuilderMembers(io::Printer* printer) const;
 135   void GenerateInitializationCode(io::Printer* printer) const;
 136   void GenerateBuilderClearCode(io::Printer* printer) const;
 137   void GenerateMergingCode(io::Printer* printer) const;
 138   void GenerateBuildingCode(io::Printer* printer) const;
 139   void GenerateParsingCode(io::Printer* printer) const;
 140   void GenerateParsingDoneCode(io::Printer* printer) const;
 141   void GenerateSerializationCode(io::Printer* printer) const;
 142   void GenerateSerializedSizeCode(io::Printer* printer) const;
 143   void GenerateFieldBuilderInitializationCode(io::Printer* printer) const;
 144   void GenerateEqualsCode(io::Printer* printer) const;
 145   void GenerateHashCode(io::Printer* printer) const;
 146
 147   string GetBoxedType() const;
 148
 149  protected:
 150   const FieldDescriptor* descriptor_;
 151   map<string, string> variables_;
 152   const int messageBitIndex_;
 153   const int builderBitIndex_;
 154   Context* context_;
 155   ClassNameResolver* name_resolver_;
 156
 157   void PrintNestedBuilderCondition(io::Printer* printer,
 158       const char* regular_case, const char* nested_builder_case) const;
 159   void PrintNestedBuilderFunction(io::Printer* printer,
 160       const char* method_prototype, const char* regular_case,
 161       const char* nested_builder_case,
 162       const char* trailing_code) const;
 163
 164  private:
 165   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(RepeatedImmutableMessageFieldGenerator);
 166 };
 167
 168 }  // namespace java
 169 }  // namespace compiler
 170 }  // namespace protobuf
 171
 172 }  // namespace google
 173 #endif  // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_FIELD_H__