explicitly_constructed.h 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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. #ifndef GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__
  31. #define GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__
  32. #include <stdint.h>
  33. #include <utility>
  34. #include <google/protobuf/stubs/logging.h>
  35. #include <google/protobuf/stubs/common.h>
  36. // clang-format off
  37. #include <google/protobuf/port_def.inc>
  38. // clang-format on
  39. namespace google {
  40. namespace protobuf {
  41. namespace internal {
  42. // Wraps a variable whose constructor and destructor are explicitly
  43. // called. It is particularly useful for a global variable, without its
  44. // constructor and destructor run on start and end of the program lifetime.
  45. // This circumvents the initial construction order fiasco, while keeping
  46. // the address of the empty string a compile time constant.
  47. //
  48. // Pay special attention to the initialization state of the object.
  49. // 1. The object is "uninitialized" to begin with.
  50. // 2. Call Construct() or DefaultConstruct() only if the object is
  51. // uninitialized. After the call, the object becomes "initialized".
  52. // 3. Call get() and get_mutable() only if the object is initialized.
  53. // 4. Call Destruct() only if the object is initialized.
  54. // After the call, the object becomes uninitialized.
  55. template <typename T>
  56. class ExplicitlyConstructed {
  57. public:
  58. void DefaultConstruct() { new (&union_) T(); }
  59. template <typename... Args>
  60. void Construct(Args&&... args) {
  61. new (&union_) T(std::forward<Args>(args)...);
  62. }
  63. void Destruct() { get_mutable()->~T(); }
  64. constexpr const T& get() const { return reinterpret_cast<const T&>(union_); }
  65. T* get_mutable() { return reinterpret_cast<T*>(&union_); }
  66. private:
  67. union AlignedUnion {
  68. alignas(T) char space[sizeof(T)];
  69. int64_t align_to_int64;
  70. void* align_to_ptr;
  71. } union_;
  72. };
  73. } // namespace internal
  74. } // namespace protobuf
  75. } // namespace google
  76. #include <google/protobuf/port_undef.inc>
  77. #endif // GOOGLE_PROTOBUF_EXPLICITLY_CONSTRUCTED_H__