SimCallbackRegistry.hpp File Reference

#include <memory>
#include <utility>
#include "wpi/hal/simulation/NotifyListener.hpp"
#include "wpi/util/Compiler.hpp"
#include "wpi/util/UidVector.hpp"
#include "wpi/util/spinlock.hpp"

Go to the source code of this file.

Classes
class	wpi::hal::impl::SimCallbackRegistryBase
class	wpi::hal::SimCallbackRegistry< CallbackFunction, GetName >
	Simulation callback registry. More...

Namespaces
namespace	wpi
namespace	wpi::hal
	WPILib Hardware Abstraction Layer (HAL) namespace.
namespace	wpi::hal::impl

Macros
#define	HAL_SIMCALLBACKREGISTRY_DEFINE_NAME(NAME)
	Define a name functor for use with SimCallbackRegistry.
#define	HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI(TYPE, NS, CAPINAME, DATA, LOWERNAME)
	Define a standard C API for SimCallbackRegistry.
#define	HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI_NOINDEX(TYPE, NS, CAPINAME, DATA, LOWERNAME)
	Define a standard C API for SimCallbackRegistry (no index variant).
#define	HAL_SIMCALLBACKREGISTRY_STUB_CAPI(TYPE, NS, CAPINAME)
	Define a stub standard C API for SimCallbackRegistry.
#define	HAL_SIMCALLBACKREGISTRY_STUB_CAPI_NOINDEX(TYPE, NS, CAPINAME)
	Define a stub standard C API for SimCallbackRegistry (no index variant).

Macro Definition Documentation

HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI

#define HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI	(		TYPE,
			NS,
			CAPINAME,
			DATA,
			LOWERNAME )

Value:

  int32_t NS##_Register##CAPINAME##Callback(int32_t index, TYPE callback, \
                                            void* param) {                \
    return DATA[index].LOWERNAME.Register(callback, param);               \
  }                                                                       \
                                                                          \
  void NS##_Cancel##CAPINAME##Callback(int32_t index, int32_t uid) {      \
    DATA[index].LOWERNAME.Cancel(uid);                                    \
  }

Define a standard C API for SimCallbackRegistry.

Functions defined:

• int32 NS_RegisterCAPINAMECallback( int32_t index, TYPE callback, void* param)
• void NS_CancelCAPINAMECallback(int32_t index, int32_t uid)

Parameters

TYPE	the underlying callback type (e.g. HAL_BufferCallback)
NS	the "namespace" (e.g. HALSIM)
CAPINAME	the C API name (usually first letter capitalized)
DATA	the backing data array
LOWERNAME	the lowercase name of the backing data registry

HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI_NOINDEX

#define HAL_SIMCALLBACKREGISTRY_DEFINE_CAPI_NOINDEX	(		TYPE,
			NS,
			CAPINAME,
			DATA,
			LOWERNAME )

Value:

  int32_t NS##_Register##CAPINAME##Callback(TYPE callback, void* param) {     \
    return DATA->LOWERNAME.Register(callback, param);                         \
  }                                                                           \
                                                                              \
  void NS##_Cancel##CAPINAME##Callback(int32_t uid) {                         \
    DATA->LOWERNAME.Cancel(uid);                                              \
  }

Define a standard C API for SimCallbackRegistry (no index variant).

Functions defined:

• int32 NS_RegisterCAPINAMECallback(TYPE callback, void* param)
• void NS_CancelCAPINAMECallback(int32_t uid)

Parameters

TYPE	the underlying callback type (e.g. HAL_BufferCallback)
NS	the "namespace" (e.g. HALSIM)
CAPINAME	the C API name (usually first letter capitalized)
DATA	the backing data pointer
LOWERNAME	the lowercase name of the backing data registry

HAL_SIMCALLBACKREGISTRY_DEFINE_NAME

#define HAL_SIMCALLBACKREGISTRY_DEFINE_NAME

(

NAME

)

Value:

  static LLVM_ATTRIBUTE_ALWAYS_INLINE constexpr const char* \
  Get##NAME##Name() {                                       \
    return #NAME;                                           \
  }

Define a name functor for use with SimCallbackRegistry.

This creates a function named GetNAMEName() that returns "NAME".

Parameters

NAME	the name to return

HAL_SIMCALLBACKREGISTRY_STUB_CAPI

#define HAL_SIMCALLBACKREGISTRY_STUB_CAPI	(		TYPE,
			NS,
			CAPINAME )

Value:

  int32_t NS##_Register##CAPINAME##Callback(int32_t index, TYPE callback, \
                                            void* param) {                \
    return 0;                                                             \
  }                                                                       \
                                                                          \
  void NS##_Cancel##CAPINAME##Callback(int32_t index, int32_t uid) {}

Define a stub standard C API for SimCallbackRegistry.

Functions defined:

• int32 NS_RegisterCAPINAMECallback( int32_t index, TYPE callback, void* param)
• void NS_CancelCAPINAMECallback(int32_t index, int32_t uid)

Parameters

TYPE	the underlying callback type (e.g. HAL_BufferCallback)
NS	the "namespace" (e.g. HALSIM)
CAPINAME	the C API name (usually first letter capitalized)

HAL_SIMCALLBACKREGISTRY_STUB_CAPI_NOINDEX

#define HAL_SIMCALLBACKREGISTRY_STUB_CAPI_NOINDEX	(		TYPE,
			NS,
			CAPINAME )

Value:

  int32_t NS##_Register##CAPINAME##Callback(TYPE callback, void* param) { \
    return 0;                                                             \
  }                                                                       \
                                                                          \
  void NS##_Cancel##CAPINAME##Callback(int32_t uid) {}

Define a stub standard C API for SimCallbackRegistry (no index variant).

Functions defined:

• int32 NS_RegisterCAPINAMECallback(TYPE callback, void* param)
• void NS_CancelCAPINAMECallback(int32_t uid)

Parameters

TYPE	the underlying callback type (e.g. HAL_BufferCallback)
NS	the "namespace" (e.g. HALSIM)
CAPINAME	the C API name (usually first letter capitalized)