1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // http://code.google.com/p/protobuf/ 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_JAVANANO_FIELD_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVANANO_FIELD_H__ 37 38 #include <map> 39 #include <string> 40 #include <google/protobuf/stubs/common.h> 41 #include <google/protobuf/descriptor.h> 42 #include <google/protobuf/compiler/javanano/javanano_params.h> 43 44 namespace google { 45 namespace protobuf { 46 namespace io { 47 class Printer; // printer.h 48 } 49 } 50 51 namespace protobuf { 52 namespace compiler { 53 namespace javanano { 54 55 class FieldGenerator { 56 public: 57 FieldGenerator(const Params& params) : params_(params) {} 58 virtual ~FieldGenerator(); 59 60 virtual bool SavedDefaultNeeded() const; 61 virtual void GenerateInitSavedDefaultCode(io::Printer* printer) const; 62 63 // Generates code for Java fields and methods supporting this field. 64 // If this field needs a saved default (SavedDefaultNeeded() is true), 65 // then @lazy_init controls how the static field for that default value 66 // and its initialization code should be generated. If @lazy_init is 67 // true, the static field is not declared final and the initialization 68 // code is generated only when GenerateInitSavedDefaultCode is called; 69 // otherwise, the static field is declared final and initialized inline. 70 // GenerateInitSavedDefaultCode will not be called in the latter case. 71 virtual void GenerateMembers( 72 io::Printer* printer, bool lazy_init) const = 0; 73 74 virtual void GenerateClearCode(io::Printer* printer) const = 0; 75 virtual void GenerateMergingCode(io::Printer* printer) const = 0; 76 77 // Generates code to merge from packed serialized form. The default 78 // implementation will fail; subclasses which can handle packed serialized 79 // forms will override this and print appropriate code to the printer. 80 virtual void GenerateMergingCodeFromPacked(io::Printer* printer) const; 81 82 virtual void GenerateSerializationCode(io::Printer* printer) const = 0; 83 virtual void GenerateSerializedSizeCode(io::Printer* printer) const = 0; 84 virtual void GenerateEqualsCode(io::Printer* printer) const = 0; 85 virtual void GenerateHashCodeCode(io::Printer* printer) const = 0; 86 virtual void GenerateFixClonedCode(io::Printer* printer) const {} 87 88 protected: 89 const Params& params_; 90 private: 91 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator); 92 }; 93 94 // Convenience class which constructs FieldGenerators for a Descriptor. 95 class FieldGeneratorMap { 96 public: 97 explicit FieldGeneratorMap(const Descriptor* descriptor, const Params ¶ms); 98 ~FieldGeneratorMap(); 99 100 const FieldGenerator& get(const FieldDescriptor* field) const; 101 int total_bits() const { return total_bits_; } 102 bool saved_defaults_needed() const { return saved_defaults_needed_; } 103 104 private: 105 const Descriptor* descriptor_; 106 scoped_array<scoped_ptr<FieldGenerator> > field_generators_; 107 int total_bits_; 108 bool saved_defaults_needed_; 109 110 static FieldGenerator* MakeGenerator(const FieldDescriptor* field, 111 const Params ¶ms, int* next_has_bit_index); 112 113 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap); 114 }; 115 116 void SetCommonOneofVariables(const FieldDescriptor* descriptor, 117 map<string, string>* variables); 118 void GenerateOneofFieldEquals(const FieldDescriptor* descriptor, 119 const map<string, string>& variables, 120 io::Printer* printer); 121 void GenerateOneofFieldHashCode(const FieldDescriptor* descriptor, 122 const map<string, string>& variables, 123 io::Printer* printer); 124 125 } // namespace javanano 126 } // namespace compiler 127 } // namespace protobuf 128 129 } // namespace google 130 #endif // GOOGLE_PROTOBUF_COMPILER_JAVANANO_FIELD_H__ 131
