WPILibC++ 2025.2.1
Loading...
Searching...
No Matches
FunctionExtras.h 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/PointerIntPair.h"
#include "wpi/PointerUnion.h"
#include "wpi/STLForwardCompat.h"
#include "wpi/Compiler.h"
#include "wpi/MemAlloc.h"
#include "wpi/type_traits.h"
#include <cstring>
#include <memory>
#include <type_traits>

Go to the source code of this file.

Classes

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

Namespaces

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

Typedefs

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

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.