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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use serde::Deserialize;

use super::{MenuBar, MenuItem, MenuRole};

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum MenuBarConfig {
    Replace(MenuBar),
    Patch(MenuBarPatch),
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MenuBarPatch {
    pub ops: Vec<MenuBarPatchOp>,
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(untagged)]
pub enum MenuTarget {
    /// Top-level menu title (back-compat with v1).
    Title(String),
    /// Menu path: `["File", "Recent"]` resolves to the `Recent` submenu under the `File` menu.
    Path(Vec<String>),
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(untagged)]
pub enum ItemAnchor {
    /// Anchor by command id (back-compat with v1).
    Command(String),
    /// Anchor by zero-based item index (useful for separators and submenus).
    Index(usize),
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(untagged)]
pub enum ItemSelector {
    /// Back-compat: a command id string or a numeric index.
    Anchor(ItemAnchor),
    /// Explicit selector for non-command items (e.g. submenus).
    Typed(ItemSelectorTyped),
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum ItemSelectorTyped {
    /// Select the first submenu item with the given title.
    ///
    /// Note: if multiple submenus share the same title, prefer using an index anchor instead.
    Submenu { title: String },
    /// Select the first label item with the given title.
    ///
    /// Note: if multiple labels share the same title, prefer using an index anchor instead.
    Label { title: String },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum MenuBarPatchOp {
    AppendMenu {
        title: String,
        role: Option<MenuRole>,
        mnemonic: Option<char>,
        items: Vec<MenuItem>,
    },
    InsertMenuBefore {
        title: String,
        role: Option<MenuRole>,
        mnemonic: Option<char>,
        before: String,
        items: Vec<MenuItem>,
    },
    InsertMenuAfter {
        title: String,
        role: Option<MenuRole>,
        mnemonic: Option<char>,
        after: String,
        items: Vec<MenuItem>,
    },
    RemoveMenu {
        title: String,
    },
    RenameMenu {
        from: String,
        to: String,
    },
    MoveMenuBefore {
        title: String,
        before: String,
    },
    MoveMenuAfter {
        title: String,
        after: String,
    },

    RemoveAt {
        menu: MenuTarget,
        at: ItemSelector,
    },
    MoveAtBefore {
        menu: MenuTarget,
        at: ItemSelector,
        before: ItemSelector,
    },
    MoveAtAfter {
        menu: MenuTarget,
        at: ItemSelector,
        after: ItemSelector,
    },

    RemoveItem {
        menu: MenuTarget,
        command: String,
    },
    InsertItemBefore {
        menu: MenuTarget,
        before: ItemAnchor,
        item: MenuItem,
    },
    InsertItemAfter {
        menu: MenuTarget,
        after: ItemAnchor,
        item: MenuItem,
    },
    PrependItem {
        menu: MenuTarget,
        item: MenuItem,
    },
    AppendItem {
        menu: MenuTarget,
        item: MenuItem,
    },
    MoveItemBefore {
        menu: MenuTarget,
        command: String,
        before: ItemAnchor,
    },
    MoveItemAfter {
        menu: MenuTarget,
        command: String,
        after: ItemAnchor,
    },
}