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 (at) google.com (Kenton Varda) 32 // Based on original Protocol Buffers design by 33 // Sanjay Ghemawat, Jeff Dean, and others. 34 // 35 // This file contains miscellaneous helper code used by generated code -- 36 // including lite types -- but which should not be used directly by users. 37 38 #ifndef GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__ 39 #define GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__ 40 41 #include <assert.h> 42 #include <string> 43 44 #include <google/protobuf/stubs/once.h> 45 #include <google/protobuf/stubs/common.h> 46 47 namespace google { 48 49 namespace protobuf { 50 51 class Arena; 52 namespace io { class CodedInputStream; } 53 54 namespace internal { 55 56 57 // Annotation for the compiler to emit a deprecation message if a field marked 58 // with option 'deprecated=true' is used in the code, or for other things in 59 // generated code which are deprecated. 60 // 61 // For internal use in the pb.cc files, deprecation warnings are suppressed 62 // there. 63 #undef DEPRECATED_PROTOBUF_FIELD 64 #define PROTOBUF_DEPRECATED 65 66 #define GOOGLE_PROTOBUF_DEPRECATED_ATTR 67 68 69 // Constants for special floating point values. 70 LIBPROTOBUF_EXPORT double Infinity(); 71 LIBPROTOBUF_EXPORT double NaN(); 72 73 // TODO(jieluo): Change to template. We have tried to use template, 74 // but it causes net/rpc/python:rpcutil_test fail (the empty string will 75 // init twice). It may related to swig. Change to template after we 76 // found the solution. 77 78 // Default empty string object. Don't use the pointer directly. Instead, call 79 // GetEmptyString() to get the reference. 80 LIBPROTOBUF_EXPORT extern const ::std::string* empty_string_; 81 LIBPROTOBUF_EXPORT extern ProtobufOnceType empty_string_once_init_; 82 LIBPROTOBUF_EXPORT void InitEmptyString(); 83 84 85 LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyStringAlreadyInited() { 86 assert(empty_string_ != NULL); 87 return *empty_string_; 88 } 89 LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyString() { 90 ::google::protobuf::GoogleOnceInit(&empty_string_once_init_, &InitEmptyString); 91 return GetEmptyStringAlreadyInited(); 92 } 93 94 LIBPROTOBUF_EXPORT int StringSpaceUsedExcludingSelf(const string& str); 95 96 97 // True if IsInitialized() is true for all elements of t. Type is expected 98 // to be a RepeatedPtrField<some message type>. It's useful to have this 99 // helper here to keep the protobuf compiler from ever having to emit loops in 100 // IsInitialized() methods. We want the C++ compiler to inline this or not 101 // as it sees fit. 102 template <class Type> bool AllAreInitialized(const Type& t) { 103 for (int i = t.size(); --i >= 0; ) { 104 if (!t.Get(i).IsInitialized()) return false; 105 } 106 return true; 107 } 108 109 class ArenaString; 110 111 // Read a length (varint32), followed by a string, from *input. Return a 112 // pointer to a copy of the string that resides in *arena. Requires both 113 // args to be non-NULL. If something goes wrong while reading the data 114 // then NULL is returned (e.g., input does not start with a valid varint). 115 ArenaString* ReadArenaString(::google::protobuf::io::CodedInputStream* input, 116 ::google::protobuf::Arena* arena); 117 118 } // namespace internal 119 } // namespace protobuf 120 121 } // namespace google 122 #endif // GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__ 123
