[wpilib] Add BooleanEvent/Trigger factories on HID classes (#4247)

wpilibc/src/main/native/include/frc/GenericHID.h

@@ -10,7 +10,8 @@
 
 namespace frc {
 
-class DriverStation;
+class BooleanEvent;
+class EventLoop;
 
 /**
  * Handle input from standard HID devices connected to the Driver Station.
@@ -91,6 +92,16 @@ class GenericHID {
    */
   bool GetRawButtonReleased(int button);
 
+  /**
+   * Constructs an event instance around this button's digital signal.
+   *
+   * @param button the button index
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the button's digital signal attached
+   * to the given loop.
+   */
+  BooleanEvent Button(int button, EventLoop* loop) const;
+
   /**
    * Get the value of the axis.
    *

wpilibc/src/main/native/include/frc/Joystick.h

@@ -172,6 +172,15 @@ class Joystick : public GenericHID {
    */
   bool GetTriggerReleased();
 
+  /**
+   * Constructs an event instance around the trigger button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the trigger button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Trigger(EventLoop* loop) const;
+
   /**
    * Read the state of the top button on the joystick.
    *
@@ -195,6 +204,15 @@ class Joystick : public GenericHID {
    */
   bool GetTopReleased();
 
+  /**
+   * Constructs an event instance around the top button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the top button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Top(EventLoop* loop) const;
+
   /**
    * Get the magnitude of the direction vector formed by the joystick's
    * current position relative to its origin.

wpilibc/src/main/native/include/frc/PS4Controller.h

@@ -98,6 +98,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetSquareButtonReleased();
 
+  /**
+   * Constructs an event instance around the square button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the square button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Square(EventLoop* loop) const;
+
   /**
    * Read the value of the Cross button on the controller.
    *
@@ -119,6 +128,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetCrossButtonReleased();
 
+  /**
+   * Constructs an event instance around the cross button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the cross button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Cross(EventLoop* loop) const;
+
   /**
    * Read the value of the Circle button on the controller.
    *
@@ -140,6 +158,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetCircleButtonReleased();
 
+  /**
+   * Constructs an event instance around the circle button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the circle button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Circle(EventLoop* loop) const;
+
   /**
    * Read the value of the Triangle button on the controller.
    *
@@ -161,6 +188,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetTriangleButtonReleased();
 
+  /**
+   * Constructs an event instance around the triangle button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the triangle button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Triangle(EventLoop* loop) const;
+
   /**
    * Read the value of the L1 button on the controller.
    *
@@ -182,6 +218,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetL1ButtonReleased();
 
+  /**
+   * Constructs an event instance around the L1 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the L1 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent L1(EventLoop* loop) const;
+
   /**
    * Read the value of the R1 button on the controller.
    *
@@ -203,6 +248,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetR1ButtonReleased();
 
+  /**
+   * Constructs an event instance around the R1 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the R1 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent R1(EventLoop* loop) const;
+
   /**
    * Read the value of the L2 button on the controller.
    *
@@ -224,6 +278,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetL2ButtonReleased();
 
+  /**
+   * Constructs an event instance around the L2 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the L2 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent L2(EventLoop* loop) const;
+
   /**
    * Read the value of the R2 button on the controller.
    *
@@ -245,6 +308,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetR2ButtonReleased();
 
+  /**
+   * Constructs an event instance around the R2 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the R2 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent R2(EventLoop* loop) const;
+
   /**
    * Read the value of the Share button on the controller.
    *
@@ -266,6 +338,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetShareButtonReleased();
 
+  /**
+   * Constructs an event instance around the share button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the share button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Share(EventLoop* loop) const;
+
   /**
    * Read the value of the Options button on the controller.
    *
@@ -287,6 +368,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetOptionsButtonReleased();
 
+  /**
+   * Constructs an event instance around the options button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the options button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Options(EventLoop* loop) const;
+
   /**
    * Read the value of the L3 button (pressing the left analog stick) on the
    * controller.
@@ -309,6 +399,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetL3ButtonReleased();
 
+  /**
+   * Constructs an event instance around the L3 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the L3 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent L3(EventLoop* loop) const;
+
   /**
    * Read the value of the R3 button (pressing the right analog stick) on the
    * controller.
@@ -331,6 +430,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetR3ButtonReleased();
 
+  /**
+   * Constructs an event instance around the R3 button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the R3 button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent R3(EventLoop* loop) const;
+
   /**
    * Read the value of the PS button on the controller.
    *
@@ -352,6 +460,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetPSButtonReleased();
 
+  /**
+   * Constructs an event instance around the PS button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the PS button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent PS(EventLoop* loop) const;
+
   /**
    * Read the value of the touchpad button on the controller.
    *
@@ -373,6 +490,15 @@ class PS4Controller : public GenericHID {
    */
   bool GetTouchpadReleased();
 
+  /**
+   * Constructs an event instance around the touchpad's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the touchpad's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Touchpad(EventLoop* loop) const;
+
   struct Button {
     static constexpr int kSquare = 1;
     static constexpr int kCross = 2;

wpilibc/src/main/native/include/frc/XboxController.h

@@ -96,6 +96,24 @@ class XboxController : public GenericHID {
    */
   bool GetRightBumperReleased();
 
+  /**
+   * Constructs an event instance around the left bumper's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the left bumper's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent LeftBumper(EventLoop* loop) const;
+
+  /**
+   * Constructs an event instance around the right bumper's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the right bumper's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent RightBumper(EventLoop* loop) const;
+
   /**
    * Read the value of the left stick button (LSB) on the controller.
    */
@@ -126,6 +144,24 @@ class XboxController : public GenericHID {
    */
   bool GetRightStickButtonReleased();
 
+  /**
+   * Constructs an event instance around the left stick's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the left stick's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent LeftStick(EventLoop* loop) const;
+
+  /**
+   * Constructs an event instance around the right stick's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the right stick's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent RightStick(EventLoop* loop) const;
+
   /**
    * Read the value of the A button on the controller.
    *
@@ -147,6 +183,15 @@ class XboxController : public GenericHID {
    */
   bool GetAButtonReleased();
 
+  /**
+   * Constructs an event instance around the A button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the A button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent A(EventLoop* loop) const;
+
   /**
    * Read the value of the B button on the controller.
    *
@@ -168,6 +213,15 @@ class XboxController : public GenericHID {
    */
   bool GetBButtonReleased();
 
+  /**
+   * Constructs an event instance around the B button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the B button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent B(EventLoop* loop) const;
+
   /**
    * Read the value of the X button on the controller.
    *
@@ -189,6 +243,15 @@ class XboxController : public GenericHID {
    */
   bool GetXButtonReleased();
 
+  /**
+   * Constructs an event instance around the X button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the X button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent X(EventLoop* loop) const;
+
   /**
    * Read the value of the Y button on the controller.
    *
@@ -210,6 +273,15 @@ class XboxController : public GenericHID {
    */
   bool GetYButtonReleased();
 
+  /**
+   * Constructs an event instance around the Y button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the Y button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Y(EventLoop* loop) const;
+
   /**
    * Whether the Y button was released since the last check.
    *
@@ -231,6 +303,15 @@ class XboxController : public GenericHID {
    */
   bool GetBackButtonReleased();
 
+  /**
+   * Constructs an event instance around the back button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the back button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Back(EventLoop* loop) const;
+
   /**
    * Read the value of the start button on the controller.
    *
@@ -252,6 +333,15 @@ class XboxController : public GenericHID {
    */
   bool GetStartButtonReleased();
 
+  /**
+   * Constructs an event instance around the start button's digital signal.
+   *
+   * @param loop the event loop instance to attach the event to.
+   * @return an event instance representing the start button's digital signal
+   * attached to the given loop.
+   */
+  BooleanEvent Start(EventLoop* loop) const;
+
   struct Button {
     static constexpr int kLeftBumper = 5;
     static constexpr int kRightBumper = 6;