1fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Protocol Buffers - Google's data interchange format 2fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Copyright 2008 Google Inc. All rights reserved. 3afb4b72037e3f13db208590fc782c4bc8e27f862Jeff Davidson// https://developers.google.com/protocol-buffers/ 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> 39a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#include <memory> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 43a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#include <google/protobuf/compiler/cpp/cpp_options.h> 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class Printer; // printer.h 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace cpp { 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Helper function: set variables in the map that are the same for all 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// field code generators. 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// ['name', 'index', 'number', 'classname', 'declared_type', 'tag_size', 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 'deprecation']. 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillevoid SetCommonFieldVariables(const FieldDescriptor* descriptor, 61a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson map<string, string>* variables, 62a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const Options& options); 63a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 64a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidsonvoid SetCommonOneofFieldVariables(const FieldDescriptor* descriptor, 65a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson map<string, string>* variables); 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass FieldGenerator { 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville FieldGenerator() {} 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual ~FieldGenerator(); 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code declaring members fields of the message class 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // needed to represent this field. These are placed inside the message 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // class. 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GeneratePrivateMembers(io::Printer* printer) const = 0; 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 77a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Generate static default variable for this field. These are placed inside 78a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // the message class. Most field types don't need this, so the default 79a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // implementation is empty. 80a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateStaticMembers(io::Printer* printer) const {} 81a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 82fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate prototypes for all of the accessor functions related to this 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // field. These are placed inside the class definition. 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateAccessorDeclarations(io::Printer* printer) const = 0; 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate inline definitions of accessor functions for this field. 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // These are placed inside the header after all class definitions. 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateInlineAccessorDefinitions( 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const = 0; 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate definitions of accessors that aren't inlined. These are 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // placed somewhere in the .cc file. 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Most field types don't need this, so the default implementation is empty. 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateNonInlineAccessorDefinitions( 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const {} 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which clear the 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // field. This is used to define the clear_$name$() method as well as 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // the Clear() method for the whole message. 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateClearingCode(io::Printer* printer) const = 0; 101fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 102fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which merges the 103fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // contents of the field from the current message to the target message, 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // which is stored in the generated code variable "from". 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // This is used to fill in the MergeFrom method for the whole message. 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Details of this usage can be found in message.cc under the 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // GenerateMergeFrom method. 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateMergingCode(io::Printer* printer) const = 0; 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 110fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines of code (statements, not declarations) which swaps 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // this field and the corresponding field of another message, which 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // is stored in the generated code variable "other". This is used to 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // define the Swap method. Details of usage can be found in 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message.cc under the GenerateSwap method. 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSwappingCode(io::Printer* printer) const = 0; 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate initialization code for private members declared by 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // GeneratePrivateMembers(). These go into the message class's SharedCtor() 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // method, invoked by each of the generated constructors. 120fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateConstructorCode(io::Printer* printer) const = 0; 121fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 122fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate any code that needs to go in the class's SharedDtor() method, 123fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // invoked by the destructor. 124fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Most field types don't need this, so the default implementation is empty. 125fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateDestructorCode(io::Printer* printer) const {} 126fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 127a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Generate code that allocates the fields's default instance. 128a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateDefaultInstanceAllocator(io::Printer* printer) const {} 129a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 130a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Generate code that should be run when ShutdownProtobufLibrary() is called, 131a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // to delete all dynamically-allocated objects. 132a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateShutdownCode(io::Printer* printer) const {} 133a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 134fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to decode this field, which will be placed inside the 135fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message's MergeFromCodedStream() method. 136fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateMergeFromCodedStream(io::Printer* printer) const = 0; 137fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 138d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Generate lines to decode this field from a packed value, which will be 139d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // placed inside the message's MergeFromCodedStream() method. 140d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville virtual void GenerateMergeFromCodedStreamWithPacking(io::Printer* printer) 141d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const; 142d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 143fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to serialize this field, which are placed within the 144fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // message's SerializeWithCachedSizes() method. 145fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSerializeWithCachedSizes(io::Printer* printer) const = 0; 146fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 147fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to serialize this field directly to the array "target", 148fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // which are placed within the message's SerializeWithCachedSizesToArray() 149fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // method. This must also advance "target" past the written bytes. 150fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateSerializeWithCachedSizesToArray( 151fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer) const = 0; 152fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 153fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate lines to compute the serialized size of this field, which 154fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // are placed in the message's ByteSize() method. 155fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void GenerateByteSize(io::Printer* printer) const = 0; 156fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 157fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 158fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGenerator); 159fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 160fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 161fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Convenience class which constructs FieldGenerators for a Descriptor. 162fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass FieldGeneratorMap { 163fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 164a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson explicit FieldGeneratorMap(const Descriptor* descriptor, const Options& options); 165fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville ~FieldGeneratorMap(); 166fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 167fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldGenerator& get(const FieldDescriptor* field) const; 168fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 169fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 170fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Descriptor* descriptor_; 171fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville scoped_array<scoped_ptr<FieldGenerator> > field_generators_; 172fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 173a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson static FieldGenerator* MakeGenerator(const FieldDescriptor* field, 174a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const Options& options); 175fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 176fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldGeneratorMap); 177fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 178fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 179d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 180fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace cpp 181fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 182fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 183fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 184fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 185fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_CPP_FIELD_H__ 186