binding.h

Go to the documentation of this file.

 
#pragma once
 
#include <chrono>
#include <memory>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
#include <rex/input_keys.h>
#include <rex/platform.h>
#include <rex/result.h>
#include <rex/settings_registry.h>
#include <rex/types.h>
 
namespace rex::hid {
 
inline constexpr u8 kAxisDirections = 4;
 
inline constexpr u8 kAxisKeysPerDirection = 2;
 
inline constexpr u8 kMaxAxisKeyHalves = kAxisDirections * kAxisKeysPerDirection;

constexpr u8 GetAxisSlot(u8 direction, u8 alternate) {
  return static_cast<u8>(alternate * kAxisDirections + direction + 1);
}

constexpr u8 GetAxisDirection(u8 axis_slot) {
  return static_cast<u8>((axis_slot - 1) % kAxisDirections);
}
 
struct BindingConfig {
  std::string_view name;
  std::string_view defaults;
  std::string_view description;
  u32 group = 0;
  PadAxes axes = PadAxes::kNone;
};

class IBindingSet {
 public:
  virtual ~IBindingSet() = default;

  [[nodiscard]] virtual Result<void> Register(ISettingsRegistry& settings) = 0;

  virtual void Unregister() = 0;
 
  [[nodiscard]] virtual size_t GetCount() const = 0;

  [[nodiscard]] virtual std::span<const InputSource> GetSources(size_t binding) const = 0;

  virtual bool SetSource(size_t binding, size_t slot, const InputSource& source) = 0;

  virtual bool SetSources(size_t binding, std::span<const InputSource> sources) = 0;

  virtual bool Clear(size_t binding) = 0;

  virtual bool Reset(size_t binding) = 0;

  virtual bool ResetGroup(u32 group) = 0;

  [[nodiscard]] virtual std::optional<size_t> FindConflict(size_t binding,
                                                           const InputSource& source) const = 0;

  [[nodiscard]] virtual std::optional<size_t> FindBySetting(
      std::string_view setting_name) const = 0;

  [[nodiscard]] virtual u32 GetGeneration() const = 0;

  [[nodiscard]] virtual std::vector<std::string> TakeParseErrors() = 0;
};

REX_HID_API std::span<const VirtualKey> GetBindableKeys();

struct KeyCaptureConfig {
  std::chrono::milliseconds cancel_hold{800};
  u32 pad_cancel_mask = (1u << static_cast<u32>(PadInput::kLeftTrigger)) |
                        (1u << static_cast<u32>(PadInput::kRightTrigger));
};

class IKeyCapture {
 public:
  virtual ~IKeyCapture() = default;

  virtual void SetPadButtons(u32 buttons) = 0;

  virtual void Begin() = 0;

  [[nodiscard]] virtual std::optional<InputSource> Poll(
      std::chrono::steady_clock::time_point now = std::chrono::steady_clock::now()) = 0;

  [[nodiscard]] virtual bool IsPending() const = 0;

  [[nodiscard]] virtual bool WasCanceled() const = 0;
};
 
}  // namespace rex::hid