hookmap 0.5.1

Registers hotkeys and simulates keyboard and mouse input.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

use hookmap_core::button::Button;
use hookmap_core::event::NativeEventOperation;

use super::hook::Condition;
use crate::hook::ButtonState;
use crate::macros::button_arg::ButtonArg;

use std::sync::Arc;

/// Represents hotkey information.
///
/// # Examples
///
/// ```
/// use hookmap::prelude::*;
/// Context::new()
///     .modifiers(buttons!(A, B, C))
///     .native_event_operation(NativeEventOperation::Block);
/// ```
///
#[derive(Debug, Default, Clone)]
pub struct Context {
    modifiers: Option<Arc<Modifiers>>,
    pub(crate) native_event_operation: NativeEventOperation,
}

impl Context {
    /// Creates a new instance of [`Context`].
    ///
    /// # Examples
    ///
    /// ```
    /// use hookmap::prelude::*;
    /// let context = Context::new();
    /// ```
    ///
    pub fn new() -> Self {
        Self::default()
    }

    /// Merges other [`Context`] into self.
    /// `other` will not be changed.
    ///
    /// # Examples
    ///
    /// ```
    /// use hookmap::prelude::*;
    /// let context = Context::new().modifiers(buttons!(A, B));
    /// Context::new()
    ///     .modifiers(buttons!(C, D))
    ///     .merge(&context);
    /// ```
    ///
    pub fn merge(mut self, other: &Self) -> Self {
        self.modifiers = match (self.modifiers.as_ref(), other.modifiers.as_ref()) {
            (Some(s), Some(o)) => Some(Arc::new(s.merge(o))),
            (Some(m), None) | (None, Some(m)) => Some(Arc::clone(m)),
            (None, None) => None,
        };

        use NativeEventOperation::{Block, Dispatch};
        self.native_event_operation =
            match (self.native_event_operation, other.native_event_operation) {
                (Dispatch, Dispatch) => Dispatch,
                _ => Block,
            };

        self
    }

    /// Adds modifier keys to the hotkey to be registered.
    ///
    /// # Examples
    ///
    /// ```
    /// use hookmap::prelude::*;
    /// Context::new()
    ///     .modifiers(buttons!(A, B));
    /// ```
    ///
    pub fn modifiers(mut self, modifiers: impl Into<ButtonArg>) -> Self {
        self.modifiers = Some(Arc::new(Modifiers::from(modifiers.into())));
        self
    }

    /// Indicates whether to block the native event when the hotkey is active.
    ///
    /// # Examples
    ///
    /// ```
    /// use hookmap::prelude::*;
    /// Context::new()
    ///     .native_event_operation(NativeEventOperation::Block);
    /// ```
    ///
    pub fn native_event_operation(mut self, native_event_operation: NativeEventOperation) -> Self {
        self.native_event_operation = native_event_operation;
        self
    }

    pub(super) fn has_no_modifiers(&self) -> bool {
        self.modifiers.is_none()
    }

    pub(super) fn to_condition(&self) -> Condition {
        self.modifiers
            .clone()
            .map_or(Condition::Any, Condition::Modifier)
    }

    pub(super) fn iter_pressed(&self) -> impl Iterator<Item = &Button> {
        self.modifiers.iter().flat_map(|m| m.iter_pressed())
    }

    pub(super) fn iter_released(&self) -> impl Iterator<Item = &Button> {
        self.modifiers.iter().flat_map(|m| m.iter_released())
    }
}

#[derive(Clone, Debug, Default)]
pub(crate) struct Modifiers {
    pressed: Vec<Button>,
    released: Vec<Button>,
}

impl Modifiers {
    pub fn merge(&self, other: &Self) -> Self {
        Modifiers {
            pressed: self
                .pressed
                .iter()
                .chain(other.pressed.iter())
                .cloned()
                .collect(),
            released: self
                .released
                .iter()
                .chain(other.released.iter())
                .cloned()
                .collect(),
        }
    }
    pub(super) fn is_matched(&self, state: &impl ButtonState) -> bool {
        self.iter_pressed().all(|&b| state.is_pressed(b))
            && self.iter_released().all(|&b| state.is_released(b))
    }

    pub(super) fn iter_pressed(&self) -> std::slice::Iter<Button> {
        self.pressed.iter()
    }

    pub(super) fn iter_released(&self) -> std::slice::Iter<Button> {
        self.released.iter()
    }
}

impl From<ButtonArg> for Modifiers {
    fn from(args: ButtonArg) -> Self {
        Self {
            pressed: args.iter_plain().collect(),
            released: args.iter_not().collect(),
        }
    }
}