fret-runtime 0.1.0

Runtime abstractions and scheduling surfaces for host integration in Fret.
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

use crate::{CommandId, KeyChord, Platform, WhenExpr};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PlatformFilter {
    All,
    Macos,
    Windows,
    Linux,
    Web,
}

impl PlatformFilter {
    pub fn matches(self, platform: Platform) -> bool {
        match self {
            Self::All => true,
            Self::Macos => platform == Platform::Macos,
            Self::Windows => platform == Platform::Windows,
            Self::Linux => platform == Platform::Linux,
            Self::Web => platform == Platform::Web,
        }
    }
}

#[derive(Debug, Clone)]
pub struct Binding {
    pub platform: PlatformFilter,
    pub sequence: Vec<KeyChord>,
    pub when: Option<WhenExpr>,
    pub command: Option<CommandId>,
}

#[derive(Debug, Clone)]
pub struct DefaultKeybinding {
    pub platform: PlatformFilter,
    pub sequence: Vec<KeyChord>,
    pub when: Option<WhenExpr>,
}

impl DefaultKeybinding {
    pub fn single(platform: PlatformFilter, chord: KeyChord) -> Self {
        Self {
            platform,
            sequence: vec![chord],
            when: None,
        }
    }
}

#[derive(Debug, Default, Clone)]
pub struct Keymap {
    pub(super) bindings: Vec<Binding>,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct KeymapBindingSignature {
    pub platform: PlatformFilter,
    pub sequence: Vec<KeyChord>,
    pub when: Option<WhenExpr>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeymapConflictKind {
    /// Multiple bindings exist, but they all resolve to the same command payload.
    Redundant,
    /// Later bindings override earlier ones (last-wins) with a different command payload.
    Override,
    /// At least one binding explicitly unbinds (`command: null`), shadowing earlier bindings.
    Unbind,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct KeymapConflictEntry {
    pub index: usize,
    pub command: Option<CommandId>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct KeymapConflict {
    pub signature: KeymapBindingSignature,
    pub kind: KeymapConflictKind,
    /// Oldest -> newest (so the effective winner is `entries.last()`).
    pub entries: Vec<KeymapConflictEntry>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WhenValidationMode {
    Strict,
    Lenient,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct KeymapLoadOptions {
    pub when_validation: WhenValidationMode,
}

impl Default for KeymapLoadOptions {
    fn default() -> Self {
        Self {
            when_validation: WhenValidationMode::Strict,
        }
    }
}

#[derive(Debug, Clone)]
pub struct SequenceMatch {
    /// `Some(Some(cmd))` if an exact binding exists and is bound, `Some(None)` if explicitly unbound,
    /// and `None` if no exact binding exists under the provided context.
    pub exact: Option<Option<CommandId>>,
    /// True if any longer binding exists that starts with the provided sequence under the same context.
    pub has_continuation: bool,
}

#[derive(Debug, Clone)]
pub struct KeymapContinuation {
    pub next: KeyChord,
    pub matched: SequenceMatch,
}