common.h 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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) and others
  31. //
  32. // Contains basic types and utilities used by the rest of the library.
  33. #ifndef GOOGLE_PROTOBUF_COMMON_H__
  34. #define GOOGLE_PROTOBUF_COMMON_H__
  35. #include <algorithm>
  36. #include <iostream>
  37. #include <map>
  38. #include <memory>
  39. #include <set>
  40. #include <string>
  41. #include <vector>
  42. #include <google/protobuf/stubs/macros.h>
  43. #include <google/protobuf/stubs/platform_macros.h>
  44. #include <google/protobuf/stubs/port.h>
  45. #include <google/protobuf/stubs/stringpiece.h>
  46. #ifndef PROTOBUF_USE_EXCEPTIONS
  47. #if defined(_MSC_VER) && defined(_CPPUNWIND)
  48. #define PROTOBUF_USE_EXCEPTIONS 1
  49. #elif defined(__EXCEPTIONS)
  50. #define PROTOBUF_USE_EXCEPTIONS 1
  51. #else
  52. #define PROTOBUF_USE_EXCEPTIONS 0
  53. #endif
  54. #endif
  55. #if PROTOBUF_USE_EXCEPTIONS
  56. #include <exception>
  57. #endif
  58. #if defined(__APPLE__)
  59. #include <TargetConditionals.h> // for TARGET_OS_IPHONE
  60. #endif
  61. #if defined(__ANDROID__) || defined(GOOGLE_PROTOBUF_OS_ANDROID) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(GOOGLE_PROTOBUF_OS_IPHONE)
  62. #include <pthread.h>
  63. #endif
  64. #include <google/protobuf/port_def.inc>
  65. namespace std {}
  66. namespace google {
  67. namespace protobuf {
  68. namespace internal {
  69. // Some of these constants are macros rather than const ints so that they can
  70. // be used in #if directives.
  71. // The current version, represented as a single integer to make comparison
  72. // easier: major * 10^6 + minor * 10^3 + micro
  73. #define GOOGLE_PROTOBUF_VERSION 3017003
  74. // A suffix string for alpha, beta or rc releases. Empty for stable releases.
  75. #define GOOGLE_PROTOBUF_VERSION_SUFFIX ""
  76. // The minimum header version which works with the current version of
  77. // the library. This constant should only be used by protoc's C++ code
  78. // generator.
  79. static const int kMinHeaderVersionForLibrary = 3017000;
  80. // The minimum protoc version which works with the current version of the
  81. // headers.
  82. #define GOOGLE_PROTOBUF_MIN_PROTOC_VERSION 3017000
  83. // The minimum header version which works with the current version of
  84. // protoc. This constant should only be used in VerifyVersion().
  85. static const int kMinHeaderVersionForProtoc = 3017000;
  86. // Verifies that the headers and libraries are compatible. Use the macro
  87. // below to call this.
  88. void PROTOBUF_EXPORT VerifyVersion(int headerVersion, int minLibraryVersion,
  89. const char* filename);
  90. // Converts a numeric version number to a string.
  91. std::string PROTOBUF_EXPORT VersionString(int version);
  92. } // namespace internal
  93. // Place this macro in your main() function (or somewhere before you attempt
  94. // to use the protobuf library) to verify that the version you link against
  95. // matches the headers you compiled against. If a version mismatch is
  96. // detected, the process will abort.
  97. #define GOOGLE_PROTOBUF_VERIFY_VERSION \
  98. ::google::protobuf::internal::VerifyVersion( \
  99. GOOGLE_PROTOBUF_VERSION, GOOGLE_PROTOBUF_MIN_LIBRARY_VERSION, \
  100. __FILE__)
  101. // ===================================================================
  102. // from google3/util/utf8/public/unilib.h
  103. namespace internal {
  104. // Checks if the buffer contains structurally-valid UTF-8. Implemented in
  105. // structurally_valid.cc.
  106. PROTOBUF_EXPORT bool IsStructurallyValidUTF8(const char* buf, int len);
  107. inline bool IsStructurallyValidUTF8(StringPiece str) {
  108. return IsStructurallyValidUTF8(str.data(), static_cast<int>(str.length()));
  109. }
  110. // Returns initial number of bytes of structurally valid UTF-8.
  111. PROTOBUF_EXPORT int UTF8SpnStructurallyValid(StringPiece str);
  112. // Coerce UTF-8 byte string in src_str to be
  113. // a structurally-valid equal-length string by selectively
  114. // overwriting illegal bytes with replace_char (typically ' ' or '?').
  115. // replace_char must be legal printable 7-bit Ascii 0x20..0x7e.
  116. // src_str is read-only.
  117. //
  118. // Returns pointer to output buffer, src_str.data() if no changes were made,
  119. // or idst if some bytes were changed. idst is allocated by the caller
  120. // and must be at least as big as src_str
  121. //
  122. // Optimized for: all structurally valid and no byte copying is done.
  123. //
  124. PROTOBUF_EXPORT char* UTF8CoerceToStructurallyValid(StringPiece str, char* dst,
  125. char replace_char);
  126. } // namespace internal
  127. // This lives in message_lite.h now, but we leave this here for any users that
  128. // #include common.h and not message_lite.h.
  129. PROTOBUF_EXPORT void ShutdownProtobufLibrary();
  130. namespace internal {
  131. // Strongly references the given variable such that the linker will be forced
  132. // to pull in this variable's translation unit.
  133. template <typename T>
  134. void StrongReference(const T& var) {
  135. auto volatile unused = &var;
  136. (void)&unused; // Use address to avoid an extra load of "unused".
  137. }
  138. } // namespace internal
  139. #if PROTOBUF_USE_EXCEPTIONS
  140. class FatalException : public std::exception {
  141. public:
  142. FatalException(const char* filename, int line, const std::string& message)
  143. : filename_(filename), line_(line), message_(message) {}
  144. virtual ~FatalException() throw();
  145. virtual const char* what() const throw();
  146. const char* filename() const { return filename_; }
  147. int line() const { return line_; }
  148. const std::string& message() const { return message_; }
  149. private:
  150. const char* filename_;
  151. const int line_;
  152. const std::string message_;
  153. };
  154. #endif
  155. // This is at the end of the file instead of the beginning to work around a bug
  156. // in some versions of MSVC.
  157. using std::string;
  158. } // namespace protobuf
  159. } // namespace google
  160. #include <google/protobuf/port_undef.inc>
  161. #endif // GOOGLE_PROTOBUF_COMMON_H__