devela 0.28.0

A development substrate of coherence.
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

// devela::ui::event::kind
//
//! Defines [`EventTag`], [`EventTagSet`], [`EventKindTimed`], [`EventKind`].
//

use crate::{AppControl, ConstInit, MaybeTimed};
use crate::{EventKey, EventMouse, EventPointer, EventTimestamp, EventWheel, EventWindow};

crate::enumset! {
    #[doc = crate::_tags!(event uid member)]
    /// A lightweight, data-less identifier for [`EventKind`].
    #[doc = crate::_doc_meta!{
        location("ui/event"),
        test_size_of(EventTag = 1|8; niche Option),
    }]
    ///
    /// Used when only the *category* of the event is relevant and the
    /// payload of the variant is not needed.
    ///
    /// This avoids carrying the full `EventKind` and is suitable for
    /// quick routing, filtering, or statistics.
    #[repr(u8)]
    #[non_exhaustive]
    #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
    pub enum EventTag(
        #[doc = crate::_tags!(event data_structure)]
        /// A compact set of [`EventTag`]s.
        #[doc = crate::_doc_meta!{
            location("ui/event"),
            test_size_of(EventTagSet = 1|8),
        }]
        ///
        /// Used to declare, filter, and query coarse event categories.
        pub EventTagSet: u8
    ) {
        /// No event or an empty placeholder. (Default)
        None,
        /// A keyboard event.
        Key,
        /// A mouse button or motion event.
        Mouse,
        /// A pointing-device event (mouse, pen, stylus, touch).
        Pointer,
        /// A wheel event.
        Wheel,
        /// An event related to a window, viewport, or presentation surface.
        Window,
        /// Application-level control notice.
        Control,
    }
    impl set #[doc = "Common event category groups."] {
        /// Events caused by direct user input.
        pub const INPUT: Self = Self::Key
            .with(Self::Mouse)
            .with(Self::Pointer)
            .with(Self::Wheel);
        /// Events related to pointing devices.
        pub const POINTING: Self = Self::Mouse
            .with(Self::Pointer)
            .with(Self::Wheel);
    }
}
impl Default for EventTag {
    /// Returns [`EventTag::None`].
    fn default() -> Self {
        Self::None
    }
}

#[doc = crate::_tags!(event time maybe)]
/// A convenience helper for optionally timed event kinds.
#[doc = crate::_doc_meta!{
    location("ui/event"),
    #[cfg(not(feature = "alloc"))]
    test_size_of(EventKindTimed = 40|320; niche Option),
    #[cfg(feature = "alloc")]
    test_size_of(EventKindTimed = 48|384; niche Option),
}]
pub type EventKindTimed = MaybeTimed<EventKind, EventTimestamp>;

#[doc = crate::_tags!(event)]
/// An enumeration of concrete event variants.
#[doc = crate::_doc_meta!{
    location("ui/event"),
    #[cfg(not(feature = "alloc"))]
    test_size_of(EventKind = 36|288; niche Option),
    #[cfg(feature = "alloc")]
    test_size_of(EventKind = 40|320; niche Option),
}]
///
/// High-level, typed grouping of input and window interactions.
/// Backends normalize their raw events into these variants.
//
// - https://docs.rs/crossterm/latest/crossterm/event/enum.Event.html
//   - https://github.com/crossterm-rs/crossterm/blob/master/src/event/sys/unix/parse.rs
// - https://docs.rs/notcurses/latest/notcurses/struct.Input.html
//   - https://docs.rs/notcurses/latest/notcurses/enum.Received.html
// - https://docs.rs/sdl2/latest/sdl2/event/enum.Event.html
#[non_exhaustive]
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub enum EventKind {
    /// An unknown, empty or absent event.
    #[default]
    None,

    /// A keyboard event.
    Key(EventKey),

    /// A mouse event.
    Mouse(EventMouse),

    /// A pointing-device event (mouse, pen, stylus, or multi-touch).
    Pointer(EventPointer),

    /// A wheel event.
    Wheel(EventWheel),

    /// A window event.
    Window(EventWindow),

    /// External control notice directed at the application.
    Control(AppControl),
    /* */
    // /// A gamepad event.
    // Gamepad(GamepadEvent),

    // /// A midi event.
    // Midi(MidiEvent),
}
impl ConstInit for EventKind {
    const INIT: Self = Self::None;
}
impl EventKind {
    /// Returns whether this event kind has `tag`.
    #[must_use]
    #[inline(always)]
    pub const fn has_tag(&self, tag: EventTag) -> bool {
        self.tag().to_set().contains(tag.to_set())
    }
    /// Returns whether this event kind belongs to `set`.
    #[must_use]
    #[inline(always)]
    pub const fn is_in(&self, set: EventTagSet) -> bool {
        self.tag().is_in(set)
    }

    /// Returns the coarse category of this event without its associated data.
    ///
    /// Useful for fast dispatch or matching on *type* rather than *content*.
    pub const fn tag(&self) -> EventTag {
        match self {
            Self::None => EventTag::None,
            Self::Key(_) => EventTag::Key,
            Self::Mouse(_) => EventTag::Mouse,
            Self::Pointer(_) => EventTag::Pointer,
            Self::Wheel(_) => EventTag::Wheel,
            Self::Window(_) => EventTag::Window,
            Self::Control(_) => EventTag::Control,
        }
    }
}

#[rustfmt::skip]
impl EventKind {
    /// Whether there's no event.
    #[must_use] #[inline(always)]
    pub const fn is_none(&self) -> bool { matches![self, EventKind::None] }

    /// Whether there's some event.
    #[must_use] #[inline(always)]
    pub const fn is_some(&self) -> bool { !matches![self, EventKind::None] }

    /// Whether it's a keyboard event.
    #[must_use] #[inline(always)]
    pub const fn is_key(&self) -> bool { matches![self, EventKind::Key(_)] }

    /// Whether it's a mouse event.
    #[must_use] #[inline(always)]
    pub const fn is_mouse(&self) -> bool { matches![self, EventKind::Mouse(_)] }

    /// Whether it's a pointer event.
    #[must_use] #[inline(always)]
    pub const fn is_pointer(&self) -> bool { matches![self, EventKind::Pointer(_)] }

    /// Whether it's a wheel event.
    #[must_use] #[inline(always)]
    pub const fn is_wheel(&self) -> bool { matches![self, EventKind::Wheel(_)] }

    /// Whether it's a window event.
    #[must_use] #[inline(always)]
    pub const fn is_window(&self) -> bool { matches![self, EventKind::Window(_)] }

    /// Whether it's a control event.
    #[must_use] #[inline(always)]
    pub const fn is_control(&self) -> bool { matches![self, EventKind::Control(_)] }

    // /// Returns `true` if it's a keyboard event.
    // pub const fn is_midi(&self) -> bool { matches![self, EventKind::Midi(_)] }

    // /// Returns `true` if it's a mouse event.
    // pub const fn is_gamepad(&self) -> bool { matches![self, EventKind::Gamepad(_)] }

    /// Returns some keyboard event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_key(&self) -> Option<&EventKey> {
        if let EventKind::Key(e) = &self { Some(e) } else { None }
    }
    /// Returns some mouse event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_mouse(&self) -> Option<&EventMouse> {
        if let EventKind::Mouse(e) = &self { Some(e) } else { None }
    }
    /// Returns some pointer event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_pointer(&self) -> Option<&EventPointer> {
        if let EventKind::Pointer(e) = &self { Some(e) } else { None }
    }
    /// Returns some wheel event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_wheel(&self) -> Option<&EventWheel> {
        if let EventKind::Wheel(e) = &self { Some(e) } else { None }
    }
    /// Returns some window event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_window(&self) -> Option<&EventWindow> {
        if let EventKind::Window(e) = &self { Some(e) } else { None }
    }
    /// Returns some control event, if that's the kind.
    #[must_use] #[inline(always)]
    pub const fn some_control(&self) -> Option<&AppControl> {
        if let EventKind::Control(e) = &self { Some(e) } else { None }
    }
    // /// Returns some gamepad event, if that's the kind.
    // pub const fn some_gamepad(&self) -> Option<&GamepadEvent> {
    //     if let EventKind::Gamepad(e) = &self { Some(e) } else { None }
    // }
    // /// Returns some midi event, if that's the kind.
    // pub const fn some_midi(&self) -> Option<&MidiEvent> {
    //     if let EventKind::Midi(e) = &self { Some(e) } else { None }
    // }
}