FunctionExtras.hpp File Reference

This file provides a collection of function (or more generally, callable) type erasure utilities supplementing those provided by the standard library in <function>. More...

#include "wpi/util/PointerIntPair.hpp"
#include "wpi/util/PointerUnion.hpp"
#include "wpi/util/STLForwardCompat.hpp"
#include "wpi/util/Compiler.hpp"
#include "wpi/util/MemAlloc.hpp"
#include "wpi/util/type_traits.hpp"
#include <cstring>
#include <memory>
#include <type_traits>

Go to the source code of this file.

Classes
class	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::IsSizeLessThanThresholdT< T, class >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::enable_if_t< sizeof(T)<=2 *sizeof(void *)> >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::AdjustedParamTBase< T >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::AdjustedParamTBase< T & >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::AdjustedParamTBase< T && >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::TrivialCallback
	A struct to hold a single trivial callback with sufficient alignment for our bitpacking. More...
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::NonTrivialCallbacks
	A struct we use to aggregate three callbacks when we need full set of operations. More...
union	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::StorageUnionT
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::StorageUnionT::OutOfLineStorageT
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::CallbacksHolder< CallableT, CalledAs, Enable >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::CallbacksHolder< CallableT, CalledAs, EnableIfTrivial< CallableT > >
struct	wpi::util::detail::UniqueFunctionBase< ReturnT, ParamTs >::CalledAs< T >
class	wpi::util::unique_function< R(P...)>
class	wpi::util::unique_function< R(P...) const >

Namespaces
namespace	wpi
namespace	wpi::util
namespace	wpi::util::detail
	These are wrappers over isa* function that allow them to be used in generic algorithms such as wpi::util:all_of, wpi::util::none_of, etc.

Typedefs
template<typename T>
using	wpi::util::detail::EnableIfTrivial
template<typename CallableT, typename ThisT>
using	wpi::util::detail::EnableUnlessSameType
template<typename CallableT, typename Ret, typename... Params>
using	wpi::util::detail::EnableIfCallable

Variables
template<typename CallableT, typename CalledAsT, typename Enable>
UniqueFunctionBase< R, P... >::NonTrivialCallbacks	wpi::util::detail::UniqueFunctionBase< R, P... >::CallbacksHolder< CallableT, CalledAsT, Enable >::Callbacks
template<typename CallableT, typename CalledAsT>
UniqueFunctionBase< R, P... >::TrivialCallback	wpi::util::detail::UniqueFunctionBase< R, P... >::CallbacksHolder< CallableT, CalledAsT, EnableIfTrivial< CallableT > >::Callbacks

Detailed Description

This file provides a collection of function (or more generally, callable) type erasure utilities supplementing those provided by the standard library in <function>.

It provides unique_function, which works like std::function but supports move-only callable objects and const-qualification.

Future plans:

• Add a function that provides ref-qualified support, which doesn't work with std::function.
• Provide support for specifying multiple signatures to type erase callable objects with an overload set, such as those produced by generic lambdas.
• Expand to include a copyable utility that directly replaces std::function but brings the above improvements.

Note that LLVM's utilities are greatly simplified by not supporting allocators.

If the standard library ever begins to provide comparable facilities we can consider switching to those.