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             : namespace internal {
      51             : 
      52             : 
      53             : // Annotation for the compiler to emit a deprecation message if a field marked
      54             : // with option 'deprecated=true' is used in the code, or for other things in
      55             : // generated code which are deprecated.
      56             : //
      57             : // For internal use in the pb.cc files, deprecation warnings are suppressed
      58             : // there.
      59             : #undef DEPRECATED_PROTOBUF_FIELD
      60             : #define PROTOBUF_DEPRECATED
      61             : 
      62             : 
      63             : // Constants for special floating point values.
      64             : LIBPROTOBUF_EXPORT double Infinity();
      65             : LIBPROTOBUF_EXPORT double NaN();
      66             : 
      67             : // TODO(jieluo): Change to template. We have tried to use template,
      68             : // but it causes net/rpc/python:rpcutil_test fail (the empty string will
      69             : // init twice). It may related to swig. Change to template after we
      70             : // found the solution.
      71             : 
      72             : // Default empty string object. Don't use the pointer directly. Instead, call
      73             : // GetEmptyString() to get the reference.
      74             : LIBPROTOBUF_EXPORT extern const ::std::string* empty_string_;
      75             : LIBPROTOBUF_EXPORT extern ProtobufOnceType empty_string_once_init_;
      76             : LIBPROTOBUF_EXPORT void InitEmptyString();
      77             : 
      78             : 
      79        4797 : LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyStringAlreadyInited() {
      80        4797 :   assert(empty_string_ != NULL);
      81        4797 :   return *empty_string_;
      82             : }
      83         648 : LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyString() {
      84         648 :   ::google::protobuf::GoogleOnceInit(&empty_string_once_init_, &InitEmptyString);
      85         648 :   return GetEmptyStringAlreadyInited();
      86             : }
      87             : 
      88             : // Defined in generated_message_reflection.cc -- not actually part of the lite
      89             : // library.
      90             : //
      91             : // TODO(jasonh): The various callers get this declaration from a variety of
      92             : // places: probably in most cases repeated_field.h. Clean these up so they all
      93             : // get the declaration from this file.
      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         357 : template <class Type> bool AllAreInitialized(const Type& t) {
     103         882 :   for (int i = t.size(); --i >= 0; ) {
     104         525 :     if (!t.Get(i).IsInitialized()) return false;
     105             :   }
     106         357 :   return true;
     107             : }
     108             : 
     109             : }  // namespace internal
     110             : }  // namespace protobuf
     111             : 
     112             : }  // namespace google
     113             : #endif  // GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__