pix-engine 0.7.0

//! Keyboard state management.

use crate::prelude::*;
use std::collections::HashSet;

/// Keep track of key states between frames
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub(crate) struct KeyState {
    pub(crate) entered: Option<Key>,
    pub(crate) typed: Option<String>,
    pub(crate) pressed: HashSet<Key>,
    pub(crate) keymod: KeyMod,
}

impl KeyState {
    /// Returns if any [Key] is currently being held.
    #[inline]
    pub(crate) fn is_pressed(&self) -> bool {
        !self.pressed.is_empty()
    }

    /// Returns a list of the current keys pressed this frame.
    #[inline]
    pub(crate) const fn pressed(&self) -> &HashSet<Key> {
        &self.pressed
    }

    /// Returns if a specific [Key] is currently being held.
    #[inline]
    pub(crate) fn is_down(&self, key: Key) -> bool {
        self.pressed.contains(&key)
    }

    /// Returns if a [Key] was entered last frame.
    #[inline]
    pub(crate) fn was_entered(&self, key: Key) -> bool {
        matches!(self.entered, Some(k) if k == key)
    }

    /// Returns if a specific [`KeyMod`] is currently being held.
    #[inline]
    pub(crate) const fn mod_down(&self, keymod: KeyMod) -> bool {
        self.keymod.intersects(keymod)
    }

    /// Returns a list of the current key modifiers pressed this frame.
    #[inline]
    pub(crate) const fn keymod(&self) -> &KeyMod {
        &self.keymod
    }

    /// Store a pressed [Key].
    #[inline]
    pub(crate) fn press(&mut self, key: Key, keymod: KeyMod) {
        self.entered = Some(key);
        self.pressed.insert(key);
        self.keymod = keymod;
    }

    /// Remove a pressed [Key].
    #[inline]
    pub(crate) fn release(&mut self, key: Key, keymod: KeyMod) {
        self.pressed.remove(&key);
        self.keymod = keymod;
    }

    /// Store a pressed [Key].
    #[inline]
    pub(crate) fn typed(&mut self, text: String) {
        self.typed = Some(text);
    }
}