generated_message_util.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. //
  34. // This file contains miscellaneous helper code used by generated code --
  35. // including lite types -- but which should not be used directly by users.
  36. #ifndef GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__
  37. #define GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__
  38. #include <assert.h>
  39. #include <string>
  40. #include <google/protobuf/stubs/once.h>
  41. #include <google/protobuf/stubs/common.h>
  42. namespace google {
  43. namespace protobuf {
  44. namespace internal {
  45. // Annotation for the compiler to emit a deprecation message if a field marked
  46. // with option 'deprecated=true' is used in the code, or for other things in
  47. // generated code which are deprecated.
  48. //
  49. // For internal use in the pb.cc files, deprecation warnings are suppressed
  50. // there.
  51. #undef DEPRECATED_PROTOBUF_FIELD
  52. #define PROTOBUF_DEPRECATED
  53. // Constants for special floating point values.
  54. LIBPROTOBUF_EXPORT double Infinity();
  55. LIBPROTOBUF_EXPORT double NaN();
  56. // TODO(jieluo): Change to template. We have tried to use template,
  57. // but it causes net/rpc/python:rpcutil_test fail (the empty string will
  58. // init twice). It may related to swig. Change to template after we
  59. // found the solution.
  60. // Default empty string object. Don't use the pointer directly. Instead, call
  61. // GetEmptyString() to get the reference.
  62. LIBPROTOBUF_EXPORT extern const ::std::string* empty_string_;
  63. LIBPROTOBUF_EXPORT extern ProtobufOnceType empty_string_once_init_;
  64. LIBPROTOBUF_EXPORT void InitEmptyString();
  65. LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyStringAlreadyInited() {
  66. assert(empty_string_ != NULL);
  67. return *empty_string_;
  68. }
  69. LIBPROTOBUF_EXPORT inline const ::std::string& GetEmptyString() {
  70. ::google::protobuf::GoogleOnceInit(&empty_string_once_init_, &InitEmptyString);
  71. return GetEmptyStringAlreadyInited();
  72. }
  73. // Defined in generated_message_reflection.cc -- not actually part of the lite
  74. // library.
  75. //
  76. // TODO(jasonh): The various callers get this declaration from a variety of
  77. // places: probably in most cases repeated_field.h. Clean these up so they all
  78. // get the declaration from this file.
  79. LIBPROTOBUF_EXPORT int StringSpaceUsedExcludingSelf(const string& str);
  80. // True if IsInitialized() is true for all elements of t. Type is expected
  81. // to be a RepeatedPtrField<some message type>. It's useful to have this
  82. // helper here to keep the protobuf compiler from ever having to emit loops in
  83. // IsInitialized() methods. We want the C++ compiler to inline this or not
  84. // as it sees fit.
  85. template <class Type> bool AllAreInitialized(const Type& t) {
  86. for (int i = t.size(); --i >= 0; ) {
  87. if (!t.Get(i).IsInitialized()) return false;
  88. }
  89. return true;
  90. }
  91. } // namespace internal
  92. } // namespace protobuf
  93. } // namespace google
  94. #endif // GOOGLE_PROTOBUF_GENERATED_MESSAGE_UTIL_H__