wire_format.h revision afb4b72037e3f13db208590fc782c4bc8e27f862
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// atenasio@google.com (Chris Atenasio) (ZigZag transform) 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Based on original Protocol Buffers design by 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Sanjay Ghemawat, Jeff Dean, and others. 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// This header is logically internal, but is made public because it is used 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// from protocol-compiler-generated code, which may reside in other components. 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef GOOGLE_PROTOBUF_WIRE_FORMAT_H__ 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_WIRE_FORMAT_H__ 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 43a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#include <google/protobuf/stubs/common.h> 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.pb.h> 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/message.h> 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/wire_format_lite.h> 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Do UTF-8 validation on string type in Debug build only 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef NDEBUG 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_UTF8_VALIDATION_ENABLED 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class CodedInputStream; // coded_stream.h 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class CodedOutputStream; // coded_stream.h 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class UnknownFieldSet; // unknown_field_set.h 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace internal { 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// This class is for internal use by the protocol buffer library and by 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// protocol-complier-generated message classes. It must not be called 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// directly by clients. 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// This class contains code for implementing the binary protocol buffer 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// wire format via reflection. The WireFormatLite class implements the 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// non-reflection based routines. 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// This class is really a namespace that contains only static methods 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass LIBPROTOBUF_EXPORT WireFormat { 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Given a field return its WireType 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static inline WireFormatLite::WireType WireTypeForField( 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field); 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 82a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Given a FieldDescriptor::Type return its WireType 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static inline WireFormatLite::WireType WireTypeForFieldType( 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville FieldDescriptor::Type type); 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Compute the byte size of a tag. For groups, this includes both the start 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // and end tags. 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static inline int TagSize(int field_number, FieldDescriptor::Type type); 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // These procedures can be used to implement the methods of Message which 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // handle parsing and serialization of the protocol buffer wire format 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // using only the Reflection interface. When you ask the protocol 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // compiler to optimize for code size rather than speed, it will implement 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // those methods in terms of these procedures. Of course, these are much 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // slower than the specialized implementations which the protocol compiler 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // generates when told to optimize for speed. 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Read a message in protocol buffer wire format. 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // This procedure reads either to the end of the input stream or through 101fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // a WIRETYPE_END_GROUP tag ending the message, whichever comes first. 102fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // It returns false if the input is invalid. 103fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Required fields are NOT checked by this method. You must call 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // IsInitialized() on the resulting message yourself. 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static bool ParseAndMergePartial(io::CodedInputStream* input, 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Message* message); 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Serialize a message in protocol buffer wire format. 110fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Any embedded messages within the message must have their correct sizes 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // cached. However, the top-level message need not; its size is passed as 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // a parameter to this procedure. 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // These return false iff the underlying stream returns a write error. 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void SerializeWithCachedSizes( 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message, 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville int size, io::CodedOutputStream* output); 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 120fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Implements Message::ByteSize() via reflection. WARNING: The result 121fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // of this method is *not* cached anywhere. However, all embedded messages 122fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // will have their ByteSize() methods called, so their sizes will be cached. 123fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Therefore, calling this method is sufficient to allow you to call 124fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // WireFormat::SerializeWithCachedSizes() on the same object. 125fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int ByteSize(const Message& message); 126fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 127fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // ----------------------------------------------------------------- 128fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Helpers for dealing with unknown fields 129fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 130fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Skips a field value of the given WireType. The input should start 131fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // positioned immediately after the tag. If unknown_fields is non-NULL, 132fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // the contents of the field will be added to it. 133fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static bool SkipField(io::CodedInputStream* input, uint32 tag, 134fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville UnknownFieldSet* unknown_fields); 135fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 136fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Reads and ignores a message from the input. If unknown_fields is non-NULL, 137fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // the contents will be added to it. 138fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static bool SkipMessage(io::CodedInputStream* input, 139fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville UnknownFieldSet* unknown_fields); 140fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 141fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Write the contents of an UnknownFieldSet to the output. 142fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void SerializeUnknownFields(const UnknownFieldSet& unknown_fields, 143fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedOutputStream* output); 144fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Same as above, except writing directly to the provided buffer. 145fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Requires that the buffer have sufficient capacity for 146fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // ComputeUnknownFieldsSize(unknown_fields). 147fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 148fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Returns a pointer past the last written byte. 149fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static uint8* SerializeUnknownFieldsToArray( 150fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const UnknownFieldSet& unknown_fields, 151fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville uint8* target); 152fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 153fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Same thing except for messages that have the message_set_wire_format 154fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // option. 155fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void SerializeUnknownMessageSetItems( 156fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const UnknownFieldSet& unknown_fields, 157fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedOutputStream* output); 158fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Same as above, except writing directly to the provided buffer. 159fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Requires that the buffer have sufficient capacity for 160fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // ComputeUnknownMessageSetItemsSize(unknown_fields). 161fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 162fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Returns a pointer past the last written byte. 163fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static uint8* SerializeUnknownMessageSetItemsToArray( 164fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const UnknownFieldSet& unknown_fields, 165fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville uint8* target); 166fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 167fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Compute the size of the UnknownFieldSet on the wire. 168fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int ComputeUnknownFieldsSize(const UnknownFieldSet& unknown_fields); 169fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 170fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Same thing except for messages that have the message_set_wire_format 171fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // option. 172fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int ComputeUnknownMessageSetItemsSize( 173fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const UnknownFieldSet& unknown_fields); 174fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 175fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 176fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Helper functions for encoding and decoding tags. (Inlined below and in 177fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // _inl.h) 178fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // 179fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // This is different from MakeTag(field->number(), field->type()) in the case 180fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // of packed repeated fields. 181fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static uint32 MakeTag(const FieldDescriptor* field); 182fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 183a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Parse a single field. The input should start out positioned immediately 184fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // after the tag. 185fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static bool ParseAndMergeField( 186fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville uint32 tag, 187fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, // May be NULL for unknown 188fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Message* message, 189fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedInputStream* input); 190fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 191fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Serialize a single field. 192fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void SerializeFieldWithCachedSizes( 193fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, // Cannot be NULL 194fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message, 195fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedOutputStream* output); 196fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 197fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Compute size of a single field. If the field is a message type, this 198fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // will call ByteSize() for the embedded message, insuring that it caches 199fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // its size. 200fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int FieldByteSize( 201fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, // Cannot be NULL 202fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message); 203fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 204fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Parse/serialize a MessageSet::Item group. Used with messages that use 205fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // opion message_set_wire_format = true. 206fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static bool ParseAndMergeMessageSetItem( 207fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedInputStream* input, 208fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Message* message); 209fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void SerializeMessageSetItemWithCachedSizes( 210fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, 211fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message, 212fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::CodedOutputStream* output); 213fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int MessageSetItemByteSize( 214fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, 215fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message); 216fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 217fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Computes the byte size of a field, excluding tags. For packed fields, it 218fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // only includes the size of the raw data, and not the size of the total 219fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // length, but for other length-delimited types, the size of the length is 220fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // included. 221fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static int FieldDataOnlyByteSize( 222fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field, // Cannot be NULL 223fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Message& message); 224fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 225fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville enum Operation { 226fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville PARSE, 227fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville SERIALIZE, 228fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville }; 229fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 230fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Verifies that a string field is valid UTF8, logging an error if not. 231a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // This function will not be called by newly generated protobuf code 232a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // but remains present to support existing code. 233fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void VerifyUTF8String(const char* data, int size, Operation op); 234a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // The NamedField variant takes a field name in order to produce an 235a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // informative error message if verification fails. 236a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson static void VerifyUTF8StringNamedField(const char* data, 237a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson int size, 238a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson Operation op, 239a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const char* field_name); 240fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 241fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 242fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Verifies that a string field is valid UTF8, logging an error if not. 243fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static void VerifyUTF8StringFallback( 244fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const char* data, 245fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville int size, 246a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson Operation op, 247a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const char* field_name); 248a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 249a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Skip a MessageSet field. 250a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson static bool SkipMessageSetField(io::CodedInputStream* input, 251a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson uint32 field_number, 252a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson UnknownFieldSet* unknown_fields); 253a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 254a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Parse a MessageSet field. 255a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson static bool ParseAndMergeMessageSetField(uint32 field_number, 256a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const FieldDescriptor* field, 257a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson Message* message, 258a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson io::CodedInputStream* input); 259fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 260fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 261fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 262fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(WireFormat); 263fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 264fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 265fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Subclass of FieldSkipper which saves skipped fields to an UnknownFieldSet. 266fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass LIBPROTOBUF_EXPORT UnknownFieldSetFieldSkipper : public FieldSkipper { 267fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 268fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville UnknownFieldSetFieldSkipper(UnknownFieldSet* unknown_fields) 269fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville : unknown_fields_(unknown_fields) {} 270fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual ~UnknownFieldSetFieldSkipper() {} 271fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 272fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // implements FieldSkipper ----------------------------------------- 273fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual bool SkipField(io::CodedInputStream* input, uint32 tag); 274fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual bool SkipMessage(io::CodedInputStream* input); 275fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual void SkipUnknownEnum(int field_number, int value); 276fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 277a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson protected: 278fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville UnknownFieldSet* unknown_fields_; 279fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 280fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 281fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// inline methods ==================================================== 282fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 283fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline WireFormatLite::WireType WireFormat::WireTypeForField( 284fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field) { 285fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville if (field->options().packed()) { 286fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return WireFormatLite::WIRETYPE_LENGTH_DELIMITED; 287fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } else { 288fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return WireTypeForFieldType(field->type()); 289fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 290fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 291fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 292fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline WireFormatLite::WireType WireFormat::WireTypeForFieldType( 293fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville FieldDescriptor::Type type) { 294fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Some compilers don't like enum -> enum casts, so we implicit_cast to 295fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // int first. 296fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return WireFormatLite::WireTypeForFieldType( 297fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static_cast<WireFormatLite::FieldType>( 298fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville implicit_cast<int>(type))); 299fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 300fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 301fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline uint32 WireFormat::MakeTag(const FieldDescriptor* field) { 302fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return WireFormatLite::MakeTag(field->number(), WireTypeForField(field)); 303fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 304fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 305fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline int WireFormat::TagSize(int field_number, FieldDescriptor::Type type) { 306fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Some compilers don't like enum -> enum casts, so we implicit_cast to 307fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // int first. 308fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return WireFormatLite::TagSize(field_number, 309fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville static_cast<WireFormatLite::FieldType>( 310fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville implicit_cast<int>(type))); 311fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 312fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 313fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline void WireFormat::VerifyUTF8String(const char* data, int size, 314fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville WireFormat::Operation op) { 315fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifdef GOOGLE_PROTOBUF_UTF8_VALIDATION_ENABLED 316a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson WireFormat::VerifyUTF8StringFallback(data, size, op, NULL); 317a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#else 318a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Avoid the compiler warning about unsued variables. 319a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson (void)data; (void)size; (void)op; 320a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#endif 321a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson} 322a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 323a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidsoninline void WireFormat::VerifyUTF8StringNamedField( 324a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const char* data, int size, WireFormat::Operation op, 325a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const char* field_name) { 326a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#ifdef GOOGLE_PROTOBUF_UTF8_VALIDATION_ENABLED 327a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson WireFormat::VerifyUTF8StringFallback(data, size, op, field_name); 328fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif 329fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 330fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 331fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 332fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace internal 333fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 334fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 335fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 336fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_WIRE_FORMAT_H__ 337