src/third_party/protobuf/src/google/protobuf/generated_message_util.h

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // http://code.google.com/p/protobuf/
   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 <string>
  42
  43 #include <google/protobuf/stubs/common.h>
  44 #include <google/protobuf/stubs/once.h>
  45 namespace google {
  46 namespace protobuf {
  47 namespace internal {
  48
  49 // Annotation for the compiler to emit a deprecation message if a field marked
  50 // with option 'deprecated=true' is used in the code, or for other things in
  51 // generated code which are deprecated.
  52 //
  53 // For internal use in the pb.cc files, deprecation warnings are suppressed
  54 // there.
  55 #undef DEPRECATED_PROTOBUF_FIELD
  56 #define PROTOBUF_DEPRECATED
  57
  58
  59 // Constants for special floating point values.
  60 LIBPROTOBUF_EXPORT double Infinity();
  61 LIBPROTOBUF_EXPORT double NaN();
  62
  63 // Default empty string object. Don't use the pointer directly. Instead, call
  64 // GetEmptyString() to get the reference.
  65 LIBPROTOBUF_EXPORT extern const ::std::string* empty_string_;
  66 LIBPROTOBUF_EXPORT extern ProtobufOnceType empty_string_once_init_;
  67
  68 LIBPROTOBUF_EXPORT void InitEmptyString();
  69
  70 LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyString() {
  71   GoogleOnceInit(&empty_string_once_init_, &InitEmptyString);
  72   return *empty_string_;
  73 }
  74
  75 // Defined in generated_message_reflection.cc -- not actually part of the lite
  76 // library.
  77 //
  78 // TODO(jasonh): The various callers get this declaration from a variety of
  79 // places: probably in most cases repeated_field.h. Clean these up so they all
  80 // get the declaration from this file.
  81 LIBPROTOBUF_EXPORT int StringSpaceUsedExcludingSelf(const string& str);
  82
  83 }  // namespace internal
  84 }  // namespace protobuf
  85
  86 }  // namespace google
  87 #endif  // GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__