1fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Protocol Buffers - Google's data interchange format 2fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Copyright 2008 Google Inc. All rights reserved. 3fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// http://code.google.com/p/protobuf/ 4fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 5fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Redistribution and use in source and binary forms, with or without 6fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// modification, are permitted provided that the following conditions are 7fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// met: 8fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 9fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions of source code must retain the above copyright 10fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// notice, this list of conditions and the following disclaimer. 11fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions in binary form must reproduce the above 12fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// copyright notice, this list of conditions and the following disclaimer 13fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// in the documentation and/or other materials provided with the 14fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// distribution. 15fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Neither the name of Google Inc. nor the names of its 16fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// contributors may be used to endorse or promote products derived from 17fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// this software without specific prior written permission. 18fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 19fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 31fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Author: kenton@google.com (Kenton Varda) 32fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Based on original Protocol Buffers design by 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Sanjay Ghemawat, Jeff Dean, and others. 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_FIELD_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_CPP_FIELD_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <map> 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/stubs/common.h> 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class Printer; // printer.h 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace cpp { 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Helper function: set variables in the map that are the same for all 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// field code generators. 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// ['name', 'index', 'number', 'classname', 'declared_type', 'tag_size', 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 'deprecation']. 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillevoid SetCommonFieldVariables(const FieldDescriptor* descriptor, 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville map<string, string>* variables); 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass FieldGenerator { 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville FieldGenerator() {} 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual ~FieldGenerator(); 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code declaring members fields of the message class 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // needed to represent this field. These are placed inside the message 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // class. 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GeneratePrivateMembers(io::Printer* printer) const = 0; 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate prototypes for all of the accessor functions related to this 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // field. These are placed inside the class definition. 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateAccessorDeclarations(io::Printer* printer) const = 0; 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate inline definitions of accessor functions for this field. 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // These are placed inside the header after all class definitions. 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateInlineAccessorDefinitions( 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const = 0; 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate definitions of accessors that aren't inlined. These are 82fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // placed somewhere in the .cc file. 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Most field types don't need this, so the default implementation is empty. 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateNonInlineAccessorDefinitions( 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const {} 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which clear the 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // field. This is used to define the clear_$name$() method as well as 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // the Clear() method for the whole message. 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateClearingCode(io::Printer* printer) const = 0; 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which merges the 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // contents of the field from the current message to the target message, 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // which is stored in the generated code variable "from". 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // This is used to fill in the MergeFrom method for the whole message. 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Details of this usage can be found in message.cc under the 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // GenerateMergeFrom method. 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateMergingCode(io::Printer* printer) const = 0; 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which swaps 101fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // this field and the corresponding field of another message, which 102fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // is stored in the generated code variable "other". This is used to 103fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // define the Swap method. Details of usage can be found in 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message.cc under the GenerateSwap method. 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSwappingCode(io::Printer* printer) const = 0; 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate initialization code for private members declared by 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // GeneratePrivateMembers(). These go into the message class's SharedCtor() 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // method, invoked by each of the generated constructors. 110fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateConstructorCode(io::Printer* printer) const = 0; 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate any code that needs to go in the class's SharedDtor() method, 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // invoked by the destructor. 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Most field types don't need this, so the default implementation is empty. 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateDestructorCode(io::Printer* printer) const {} 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to decode this field, which will be placed inside the 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message's MergeFromCodedStream() method. 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateMergeFromCodedStream(io::Printer* printer) const = 0; 120fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 121d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Generate lines to decode this field from a packed value, which will be 122d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // placed inside the message's MergeFromCodedStream() method. 123d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void GenerateMergeFromCodedStreamWithPacking(io::Printer* printer) 124d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const; 125d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 126fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to serialize this field, which are placed within the 127fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message's SerializeWithCachedSizes() method. 128fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSerializeWithCachedSizes(io::Printer* printer) const = 0; 129fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 130fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to serialize this field directly to the array "target", 131fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // which are placed within the message's SerializeWithCachedSizesToArray() 132fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // method. This must also advance "target" past the written bytes. 133fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSerializeWithCachedSizesToArray( 134fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const = 0; 135fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 136fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to compute the serialized size of this field, which 137fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // are placed in the message's ByteSize() method. 138fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateByteSize(io::Printer* printer) const = 0; 139fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 140fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 141fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator); 142fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 143fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 144fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Convenience class which constructs FieldGenerators for a Descriptor. 145fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass FieldGeneratorMap { 146fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 147fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville explicit FieldGeneratorMap(const Descriptor* descriptor); 148fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville ~FieldGeneratorMap(); 149fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 150fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldGenerator& get(const FieldDescriptor* field) const; 151fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 152fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 153fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Descriptor* descriptor_; 154fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville scoped_array<scoped_ptr<FieldGenerator> > field_generators_; 155fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 156fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static FieldGenerator* MakeGenerator(const FieldDescriptor* field); 157fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 158fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap); 159fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 160fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 161d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 162fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace cpp 163fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 164fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 165fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 166fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 167fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_CPP_FIELD_H__ 168