rgpui 0.3.0

GUI UI framework
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use crate::{Action, App, Platform, SharedString};

/// 应用程序菜单,可以是主菜单或子菜单
pub struct Menu {
    /// 菜单名称
    pub name: SharedString,

    /// 菜单项列表
    pub items: Vec<MenuItem>,

    /// 此菜单是否被禁用
    pub disabled: bool,
}

impl Menu {
    /// 使用给定名称创建新菜单
    pub fn new(name: impl Into<SharedString>) -> Self {
        Self {
            name: name.into(),
            items: vec![],
            disabled: false,
        }
    }

    /// 设置菜单项
    pub fn items(mut self, items: impl IntoIterator<Item = MenuItem>) -> Self {
        self.items = items.into_iter().collect();
        self
    }

    /// 设置此菜单是否被禁用
    pub fn disabled(mut self, disabled: bool) -> Self {
        self.disabled = disabled;
        self
    }

    /// 从此菜单创建 OwnedMenu
    pub fn owned(self) -> OwnedMenu {
        OwnedMenu {
            name: self.name.to_string().into(),
            items: self.items.into_iter().map(|item| item.owned()).collect(),
            disabled: self.disabled,
        }
    }
}

/// 操作系统菜单,由操作系统识别
/// 这允许操作系统为这些菜单提供专门的菜单项
pub struct OsMenu {
    /// 菜单名称
    pub name: SharedString,

    /// 菜单类型
    pub menu_type: SystemMenuType,
}

impl OsMenu {
    /// 从此 OsMenu 创建 OwnedOsMenu
    pub fn owned(self) -> OwnedOsMenu {
        OwnedOsMenu {
            name: self.name.to_string().into(),
            menu_type: self.menu_type,
        }
    }
}

/// 系统菜单类型
#[derive(Copy, Clone, Eq, PartialEq)]
pub enum SystemMenuType {
    /// macOS 应用程序菜单中的"服务"菜单
    Services,
}

/// 菜单中可以的不同类型的菜单项
pub enum MenuItem {
    /// 项目之间的分隔符
    Separator,

    /// 子菜单
    Submenu(Menu),

    /// 由系统管理的菜单(例如 macOS 上的服务菜单)
    SystemMenu(OsMenu),

    /// 可执行的操作
    Action {
        /// 此菜单项的名称
        name: SharedString,

        /// 选择此菜单项时执行的操作
        action: Box<dyn Action>,

        /// 与此操作对应的操作系统操作(如果有)
        /// 有关更多信息,请参见 [`OsAction`]
        os_action: Option<OsAction>,

        /// 此操作是否被选中
        checked: bool,

        /// 此操作是否被禁用
        disabled: bool,
    },
}

impl MenuItem {
    /// 创建分隔符菜单项
    pub fn separator() -> Self {
        Self::Separator
    }

    /// 创建子菜单菜单项
    pub fn submenu(menu: Menu) -> Self {
        Self::Submenu(menu)
    }

    /// 创建由操作系统填充的子菜单
    pub fn os_submenu(name: impl Into<SharedString>, menu_type: SystemMenuType) -> Self {
        Self::SystemMenu(OsMenu {
            name: name.into(),
            menu_type,
        })
    }

    /// 创建调用操作的菜单项
    pub fn action(name: impl Into<SharedString>, action: impl Action) -> Self {
        Self::Action {
            name: name.into(),
            action: Box::new(action),
            os_action: None,
            checked: false,
            disabled: false,
        }
    }

    /// 创建调用操作并带有操作系统操作的菜单项
    pub fn os_action(
        name: impl Into<SharedString>,
        action: impl Action,
        os_action: OsAction,
    ) -> Self {
        Self::Action {
            name: name.into(),
            action: Box::new(action),
            os_action: Some(os_action),
            checked: false,
            disabled: false,
        }
    }

    /// 从此 MenuItem 创建 OwnedMenuItem
    pub fn owned(self) -> OwnedMenuItem {
        match self {
            MenuItem::Separator => OwnedMenuItem::Separator,
            MenuItem::Submenu(submenu) => OwnedMenuItem::Submenu(submenu.owned()),
            MenuItem::Action {
                name,
                action,
                os_action,
                checked,
                disabled,
            } => OwnedMenuItem::Action {
                name: name.into(),
                action,
                os_action,
                checked,
                disabled,
            },
            MenuItem::SystemMenu(os_menu) => OwnedMenuItem::SystemMenu(os_menu.owned()),
        }
    }

    /// 设置此菜单项是否被选中
    ///
    /// 仅适用于 [`MenuItem::Action`],否则将被忽略
    pub fn checked(mut self, checked: bool) -> Self {
        match &mut self {
            MenuItem::Action { checked: old, .. } => {
                *old = checked;
            }
            _ => {}
        }
        self
    }

    /// 返回此菜单项是否被选中
    ///
    /// 仅适用于 [`MenuItem::Action`],否则返回 false
    #[inline]
    pub fn is_checked(&self) -> bool {
        match self {
            MenuItem::Action { checked, .. } => *checked,
            _ => false,
        }
    }

    /// 设置此菜单项是否被禁用
    pub fn disabled(mut self, disabled: bool) -> Self {
        match &mut self {
            MenuItem::Action { disabled: old, .. } => {
                *old = disabled;
            }
            MenuItem::Submenu(submenu) => {
                submenu.disabled = disabled;
            }
            _ => {}
        }
        self
    }

    /// 返回此菜单项是否被禁用
    ///
    /// 仅适用于 [`MenuItem::Action`] 和 [`MenuItem::Submenu`],否则返回 false
    #[inline]
    pub fn is_disabled(&self) -> bool {
        match self {
            MenuItem::Action { disabled, .. } => *disabled,
            MenuItem::Submenu(submenu) => submenu.disabled,
            _ => false,
        }
    }
}

/// 操作系统菜单,由操作系统识别
/// 这允许操作系统为这些菜单提供专门的行为
#[derive(Clone)]
pub struct OwnedOsMenu {
    /// 菜单名称
    pub name: SharedString,

    /// 菜单类型
    pub menu_type: SystemMenuType,
}

/// 应用程序菜单,可以是主菜单或子菜单
#[derive(Clone)]
pub struct OwnedMenu {
    /// 菜单名称
    pub name: SharedString,

    /// 菜单项列表
    pub items: Vec<OwnedMenuItem>,

    /// 此菜单是否被禁用
    pub disabled: bool,
}

/// 菜单中可以的不同类型的菜单项
pub enum OwnedMenuItem {
    /// 项目之间的分隔符
    Separator,

    /// 子菜单
    Submenu(OwnedMenu),

    /// 由系统管理的菜单(例如 macOS 上的服务菜单)
    SystemMenu(OwnedOsMenu),

    /// 可执行的操作
    Action {
        /// 此菜单项的名称
        name: String,

        /// 选择此菜单项时执行的操作
        action: Box<dyn Action>,

        /// 与此操作对应的操作系统操作(如果有)
        /// 有关更多信息,请参见 [`OsAction`]
        os_action: Option<OsAction>,

        /// 此操作是否被选中
        checked: bool,

        /// 此操作是否被禁用
        disabled: bool,
    },
}

impl Clone for OwnedMenuItem {
    fn clone(&self) -> Self {
        match self {
            OwnedMenuItem::Separator => OwnedMenuItem::Separator,
            OwnedMenuItem::Submenu(submenu) => OwnedMenuItem::Submenu(submenu.clone()),
            OwnedMenuItem::Action {
                name,
                action,
                os_action,
                checked,
                disabled,
            } => OwnedMenuItem::Action {
                name: name.clone(),
                action: action.boxed_clone(),
                os_action: *os_action,
                checked: *checked,
                disabled: *disabled,
            },
            OwnedMenuItem::SystemMenu(os_menu) => OwnedMenuItem::SystemMenu(os_menu.clone()),
        }
    }
}

// TODO: 作为全局选择重构的一部分,这些应该
// 移动到 GPUI 提供的操作中,在不向 GPUI 用户泄露平台细节的情况下建立此关联

/// 操作系统操作,由操作系统识别
/// 这允许操作系统为这些操作提供专门的行为
#[derive(Copy, Clone, Eq, PartialEq)]
pub enum OsAction {
    /// "剪切"操作
    Cut,

    /// "复制"操作
    Copy,

    /// "粘贴"操作
    Paste,

    /// "全选"操作
    SelectAll,

    /// "撤销"操作
    Undo,

    /// "重做"操作
    Redo,
}

pub(crate) fn init_app_menus(platform: &dyn Platform, cx: &App) {
    platform.on_will_open_app_menu(Box::new({
        let cx = cx.to_async();
        move || {
            if let Some(app) = cx.app.upgrade() {
                app.borrow_mut().update(|cx| cx.clear_pending_keystrokes());
            }
        }
    }));

    platform.on_validate_app_menu_command(Box::new({
        let cx = cx.to_async();
        move |action| {
            cx.app
                .upgrade()
                .map(|app| app.borrow_mut().update(|cx| cx.is_action_available(action)))
                .unwrap_or(false)
        }
    }));

    platform.on_app_menu_action(Box::new({
        let cx = cx.to_async();
        move |action| {
            if let Some(app) = cx.app.upgrade() {
                app.borrow_mut().update(|cx| cx.dispatch_action(action));
            }
        }
    }));
}

#[cfg(test)]
mod tests {
    use crate::Menu;

    #[test]
    fn test_menu() {
        let menu = Menu::new("App")
            .items(vec![
                crate::MenuItem::action("Action 1", rgpui::NoAction),
                crate::MenuItem::separator(),
            ])
            .disabled(true);

        assert_eq!(menu.name.as_ref(), "App");
        assert_eq!(menu.items.len(), 2);
        assert!(menu.disabled);
    }

    #[test]
    fn test_menu_item_builder() {
        use super::MenuItem;

        let item = MenuItem::action("Test Action", rgpui::NoAction);
        assert_eq!(
            match &item {
                MenuItem::Action { name, .. } => name.as_ref(),
                _ => unreachable!(),
            },
            "Test Action"
        );
        assert!(matches!(
            item,
            MenuItem::Action {
                checked: false,
                disabled: false,
                ..
            }
        ));

        assert!(
            MenuItem::action("Test Action", rgpui::NoAction)
                .checked(true)
                .is_checked()
        );
        assert!(
            MenuItem::action("Test Action", rgpui::NoAction)
                .disabled(true)
                .is_disabled()
        );

        let submenu = MenuItem::submenu(super::Menu {
            name: "Submenu".into(),
            items: vec![],
            disabled: true,
        });
        assert_eq!(
            match &submenu {
                MenuItem::Submenu(menu) => menu.name.as_ref(),
                _ => unreachable!(),
            },
            "Submenu"
        );
        assert!(!submenu.is_checked());
        assert!(submenu.is_disabled());
    }
}