input_system.h

Go to the documentation of this file.

 
#pragma once
 
#include <memory>
#include <span>
#include <string>
#include <string_view>
 
#include <rex/hid/binding.h>
#include <rex/input_keys.h>
#include <rex/hid/pad.h>
#include <rex/module.h>
#include <rex/platform.h>
#include <rex/result.h>
#include <rex/setting.h>
#include <rex/settings_registry.h>
#include <rex/types.h>
#include <rex/utility.h>
 
namespace rex::hid {
 
class REX_HID_API InputSettings final : public SettingOwner {
 public:
  InputSettings();
 
  REX_SETTING(std::string, drivers, "sdl3", "Input drivers in priority order, comma separated",
              kStartupOnly);
  REX_SETTING(bool, shared_pads, false, "Every pad feeds user 0", kStartupOnly);
  REX_SETTING(bool, vibration, true, "Allow vibration");
  REX_SETTING(bool, guide_button, false, "Pass the guide button to the title");
  REX_SETTING(f64, left_stick_deadzone, 0.0, "Left stick deadzone", Range{0.0, 1.0});
  REX_SETTING(f64, right_stick_deadzone, 0.0, "Right stick deadzone", Range{0.0, 1.0});
  REX_SETTING(bool, mnk_mode, false, "Keyboard and mouse act as a pad");
  REX_SETTING(bool, mnk_mouse, false, "The mouse moves the right stick");
  REX_SETTING(f64, mnk_sensitivity, 1.0, "Mouse to stick sensitivity", Range{0.01, 100.0});
  REX_SETTING(bool, mnk_passthrough, false, "Keys reach the title as keystrokes");
};

REX_DECLARE_INTERFACE(IInputSystem, 2)
  static constexpr u32 kMaxUsers = 4;

  static constexpr u32 kAnyUser = 0xFF;
 
  struct PadReading {
    u32 packet = 0; 
    PadState state; 
  };
 
  virtual InputSettings& GetSettings() = 0;

  [[nodiscard]] virtual Result<PadReading> GetState(u32 user) = 0;

  [[nodiscard]] virtual Result<PadCapabilities> GetCapabilities(u32 user) = 0;

  [[nodiscard]] virtual Result<void> SetVibration(u32 user, const PadVibration& motors) = 0;

  [[nodiscard]] virtual Result<PadKeystroke> GetKeystroke(u32 user, KeystrokeSource sources) = 0;

  [[nodiscard]] virtual Result<PadInfo> GetPadInfo(u32 user) = 0;

  [[nodiscard]] virtual ScopeGuard OnConnectionChange(
      MoveOnlyFunction<void(u32 user, bool connected)> fn) = 0;

  virtual void AcquireUIBlock() = 0;
 
  virtual void ReleaseUIBlock() = 0;
 
  virtual bool IsKeyDown(VirtualKey key) const = 0;
 
  virtual bool IsAnyKeyDown() const = 0;
 
  virtual KeyModifiers GetModifiers() const = 0;

  virtual PointerState GetPointer() const = 0;
 
  virtual bool IsButtonDown(MouseButton button) const = 0;
 
  virtual bool IsAnyButtonDown() const = 0;

  virtual bool TakePointerMoved() = 0;

  virtual PointerDelta TakeMotion() = 0;

  virtual PointerDelta PeekMotion() const = 0;

  virtual i32 TakeWheel() = 0;
 
  virtual i32 GetWheel() const = 0;

  virtual void SetPointerMode(PointerMode mode) = 0;

  virtual void OnInputEvent(InputEvent& event) = 0;
 
  virtual void SetInputCaptured(bool captured) = 0;

  virtual PointerMode GetPointerModeToApply() const = 0;

  [[nodiscard]] virtual ScopeGuard SetPointerModeListener(MoveOnlyFunction<void()> listener) = 0;

  virtual hid::IBindingSet& GetKeyBindings() = 0;

  [[nodiscard]] virtual std::unique_ptr<hid::IBindingSet> CreateBindingSet(
      std::span<const hid::BindingConfig> configs, std::string_view scope) = 0;

  [[nodiscard]] virtual std::unique_ptr<hid::IKeyCapture> CreateKeyCapture(
      hid::KeyCaptureConfig config) = 0;

  [[nodiscard]] virtual Result<KeyChord> ParseKeyChord(std::string_view text) const = 0;

  [[nodiscard]] virtual std::string FormatKeyChord(KeyChord chord) const = 0;

  [[nodiscard]] virtual VirtualKey ParseVirtualKey(std::string_view name) const = 0;

  [[nodiscard]] virtual std::string VirtualKeyToString(VirtualKey key) const = 0;

  [[nodiscard]] virtual Result<InputSource> ParseInputSource(std::string_view text) const = 0;

  [[nodiscard]] virtual std::string InputSourceToString(const InputSource& source) const = 0;
};
 
}  // namespace rex::hid