function_ref.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. // Copyright 2019 The Abseil Authors.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // https://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #ifndef ABSL_FUNCTIONAL_INTERNAL_FUNCTION_REF_H_
  15. #define ABSL_FUNCTIONAL_INTERNAL_FUNCTION_REF_H_
  16. #include <cassert>
  17. #include <functional>
  18. #include <type_traits>
  19. #include "absl/base/internal/invoke.h"
  20. #include "absl/functional/any_invocable.h"
  21. #include "absl/meta/type_traits.h"
  22. namespace absl {
  23. ABSL_NAMESPACE_BEGIN
  24. namespace functional_internal {
  25. // Like a void* that can handle function pointers as well. The standard does not
  26. // allow function pointers to round-trip through void*, but void(*)() is fine.
  27. //
  28. // Note: It's important that this class remains trivial and is the same size as
  29. // a pointer, since this allows the compiler to perform tail-call optimizations
  30. // when the underlying function is a callable object with a matching signature.
  31. union VoidPtr {
  32. const void* obj;
  33. void (*fun)();
  34. };
  35. // Chooses the best type for passing T as an argument.
  36. // Attempt to be close to SystemV AMD64 ABI. Objects with trivial copy ctor are
  37. // passed by value.
  38. template <typename T,
  39. bool IsLValueReference = std::is_lvalue_reference<T>::value>
  40. struct PassByValue : std::false_type {};
  41. template <typename T>
  42. struct PassByValue<T, /*IsLValueReference=*/false>
  43. : std::integral_constant<bool,
  44. absl::is_trivially_copy_constructible<T>::value &&
  45. absl::is_trivially_copy_assignable<
  46. typename std::remove_cv<T>::type>::value &&
  47. std::is_trivially_destructible<T>::value &&
  48. sizeof(T) <= 2 * sizeof(void*)> {};
  49. template <typename T>
  50. struct ForwardT : std::conditional<PassByValue<T>::value, T, T&&> {};
  51. // An Invoker takes a pointer to the type-erased invokable object, followed by
  52. // the arguments that the invokable object expects.
  53. //
  54. // Note: The order of arguments here is an optimization, since member functions
  55. // have an implicit "this" pointer as their first argument, putting VoidPtr
  56. // first allows the compiler to perform tail-call optimization in many cases.
  57. template <typename R, typename... Args>
  58. using Invoker = R (*)(VoidPtr, typename ForwardT<Args>::type...);
  59. //
  60. // InvokeObject and InvokeFunction provide static "Invoke" functions that can be
  61. // used as Invokers for objects or functions respectively.
  62. //
  63. // static_cast<R> handles the case the return type is void.
  64. template <typename Obj, typename R, typename... Args>
  65. R InvokeObject(VoidPtr ptr, typename ForwardT<Args>::type... args) {
  66. auto o = static_cast<const Obj*>(ptr.obj);
  67. return static_cast<R>(
  68. absl::base_internal::invoke(*o, std::forward<Args>(args)...));
  69. }
  70. template <typename Fun, typename R, typename... Args>
  71. R InvokeFunction(VoidPtr ptr, typename ForwardT<Args>::type... args) {
  72. auto f = reinterpret_cast<Fun>(ptr.fun);
  73. return static_cast<R>(
  74. absl::base_internal::invoke(f, std::forward<Args>(args)...));
  75. }
  76. template <typename Sig>
  77. void AssertNonNull(const std::function<Sig>& f) {
  78. assert(f != nullptr);
  79. (void)f;
  80. }
  81. template <typename Sig>
  82. void AssertNonNull(const AnyInvocable<Sig>& f) {
  83. assert(f != nullptr);
  84. (void)f;
  85. }
  86. template <typename F>
  87. void AssertNonNull(const F&) {}
  88. template <typename F, typename C>
  89. void AssertNonNull(F C::*f) {
  90. assert(f != nullptr);
  91. (void)f;
  92. }
  93. template <bool C>
  94. using EnableIf = typename ::std::enable_if<C, int>::type;
  95. } // namespace functional_internal
  96. ABSL_NAMESPACE_END
  97. } // namespace absl
  98. #endif // ABSL_FUNCTIONAL_INTERNAL_FUNCTION_REF_H_