Line data Source code
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@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 :
46 : #include <google/protobuf/stubs/common.h>
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 :
67 : // Constants for special floating point values.
68 : LIBPROTOBUF_EXPORT double Infinity();
69 : LIBPROTOBUF_EXPORT double NaN();
70 :
71 : // TODO(jieluo): Change to template. We have tried to use template,
72 : // but it causes net/rpc/python:rpcutil_test fail (the empty string will
73 : // init twice). It may related to swig. Change to template after we
74 : // found the solution.
75 :
76 : // Default empty string object. Don't use the pointer directly. Instead, call
77 : // GetEmptyString() to get the reference.
78 : LIBPROTOBUF_EXPORT extern const ::std::string* empty_string_;
79 : LIBPROTOBUF_EXPORT extern ProtobufOnceType empty_string_once_init_;
80 : LIBPROTOBUF_EXPORT void InitEmptyString();
81 :
82 :
83 18702865 : LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyStringAlreadyInited() {
84 18702865 : assert(empty_string_ != NULL);
85 19060751 : return *empty_string_;
86 : }
87 2766298 : LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyString() {
88 2838308 : ::google::protobuf::GoogleOnceInit(&empty_string_once_init_, &InitEmptyString);
89 2766963 : return GetEmptyStringAlreadyInited();
90 : }
91 :
92 : // Defined in generated_message_reflection.cc -- not actually part of the lite
93 : // library.
94 : //
95 : // TODO(jasonh): The various callers get this declaration from a variety of
96 : // places: probably in most cases repeated_field.h. Clean these up so they all
97 : // get the declaration from this file.
98 : LIBPROTOBUF_EXPORT int StringSpaceUsedExcludingSelf(const string& str);
99 :
100 :
101 : // True if IsInitialized() is true for all elements of t. Type is expected
102 : // to be a RepeatedPtrField<some message type>. It's useful to have this
103 : // helper here to keep the protobuf compiler from ever having to emit loops in
104 : // IsInitialized() methods. We want the C++ compiler to inline this or not
105 : // as it sees fit.
106 : template <class Type> bool AllAreInitialized(const Type& t) {
107 27065 : for (int i = t.size(); --i >= 0; ) {
108 10853 : if (!t.Get(i).IsInitialized()) return false;
109 : }
110 : return true;
111 : }
112 :
113 : class ArenaString;
114 :
115 : // Read a length (varint32), followed by a string, from *input. Return a
116 : // pointer to a copy of the string that resides in *arena. Requires both
117 : // args to be non-NULL. If something goes wrong while reading the data
118 : // then NULL is returned (e.g., input does not start with a valid varint).
119 : ArenaString* ReadArenaString(::google::protobuf::io::CodedInputStream* input,
120 : ::google::protobuf::Arena* arena);
121 :
122 : } // namespace internal
123 : } // namespace protobuf
124 :
125 : } // namespace google
126 : #endif // GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__
|