wcpopup 0.9.3

Context menu for Windows and Linux
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
use gtk::{
    gdk::{self, ffi::GdkEvent, Gravity, Rectangle},
    glib::{monotonic_time, translate::ToGlibPtr, Cast, ObjectExt},
    prelude::{ContainerExt, CssProviderExt, GtkMenuExt, GtkMenuItemExt, GtkSettingsExt, MenuShellExt, SeatExt, StyleContextExt, WidgetExt},
    CssProvider, Widget, STYLE_PROVIDER_PRIORITY_APPLICATION,
};
use serde::{Deserialize, Serialize};
use std::time::Duration;
mod accelerator;
mod builder;
mod menu_item;
mod style;
mod util;
use crate::{config::*, InnerMenuEvent, MenuEvent, MenuItemType, MenuType, ThemeChangeFactor};
use accelerator::*;
pub use builder::*;
pub use menu_item::*;
use style::*;
use util::*;

pub(crate) enum Container<'a> {
    Window(&'a gtk::Window),
    Menu(&'a Menu),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Menu {
    pub gtk_menu_handle: isize,
    pub menu_type: MenuType,
    parent_gtk_menu_handle: isize,
    gtk_window_handle: isize,
}

impl Default for Menu {
    fn default() -> Self {
        Self {
            gtk_menu_handle: 0,
            parent_gtk_menu_handle: 0,
            gtk_window_handle: 0,
            menu_type: MenuType::Main,
        }
    }
}

impl Menu {
    pub(crate) fn new(parent: Container, config: &Config) -> (Self, gtk::Menu) {
        let widget_name = get_widget_name(config.theme);
        let gtk_menu = gtk::Menu::new();

        if let Some(menu_conainer_widget) = gtk_menu.parent() {
            /* Set window border radius and background color */
            if let Ok(gtk_window) = menu_conainer_widget.dynamic_cast::<gtk::Window>() {
                gtk_window.set_widget_name(widget_name);
                let provider = CssProvider::new();
                let css = get_window_css(config);
                provider.load_from_data(css.as_bytes()).unwrap();
                gtk_window.style_context().add_provider(&provider, STYLE_PROVIDER_PRIORITY_APPLICATION);
            }
        }

        let (parent_gtk_menu_handle, gtk_window_handle, menu_type) = match parent {
            Container::Window(gtk_window) => {
                gtk_menu.set_attach_widget(Some(gtk_window));
                let gtk_window_handle = from_gtk_window(gtk_window);
                let gtk_menu_handle = from_gtk_menu(&gtk_menu);

                if let Some(settings) = gtk_window.settings() {
                    settings.connect_gtk_application_prefer_dark_theme_notify(move |changed_settings| {
                        let theme = if changed_settings.is_gtk_application_prefer_dark_theme() {
                            Theme::Dark
                        } else {
                            Theme::Light
                        };
                        on_theme_change(MenuType::Main, gtk_menu_handle, Some(theme), ThemeChangeFactor::App);
                    });
                    settings.connect_gtk_theme_name_notify(move |_| {
                        on_theme_change(MenuType::Main, gtk_menu_handle, None, ThemeChangeFactor::App);
                    });
                }
                (0, gtk_window_handle, MenuType::Main)
            }
            Container::Menu(menu) => (menu.gtk_menu_handle, menu.gtk_window_handle, MenuType::Submenu),
        };

        gtk_menu.set_border_width(config.size.border_size as u32);

        gtk_menu.set_widget_name(widget_name);
        gtk_menu.set_reserve_toggle_size(false);

        let css = get_menu_css(config);
        let provider = CssProvider::new();
        provider.load_from_data(css.as_bytes()).unwrap();
        gtk_menu.style_context().add_provider(&provider, STYLE_PROVIDER_PRIORITY_APPLICATION);

        gtk_menu.show();

        let menu = Self {
            gtk_menu_handle: from_gtk_menu(&gtk_menu),
            parent_gtk_menu_handle,
            gtk_window_handle,
            menu_type,
        };

        (menu, gtk_menu)
    }

    pub fn config(&self) -> Config {
        get_menu_data(self.gtk_menu_handle).config.clone()
    }

    pub fn theme(&self) -> Theme {
        let data = get_menu_data(self.gtk_menu_handle);
        data.config.theme
    }

    /// Sets the theme for Menu.
    pub fn set_theme(&self, theme: Theme) {
        on_theme_change(self.menu_type, self.gtk_menu_handle, Some(theme), ThemeChangeFactor::User);
    }

    /// Gets all MenuItems of Menu.
    pub fn items(&self) -> Vec<MenuItem> {
        collect_menu_items(self.gtk_menu_handle)
    }

    /// Gets the MenuItem with the specified id.
    pub fn get_menu_item_by_id(&self, id: &str) -> Option<MenuItem> {
        let gtk_menu = to_gtk_menu(self.gtk_menu_handle);
        find_by_id(&gtk_menu.children(), id)
    }

    /// Adds a MenuItem to the end of MenuItems.
    pub fn append(&mut self, item: MenuItem) {
        self.add_item(item, None);
    }

    /// Adds a MenuItem at the specified index.
    pub fn insert(&mut self, item: MenuItem, index: u32) {
        self.add_item(item, Some(index as i32));
    }

    fn add_item(&mut self, mut item: MenuItem, index: Option<i32>) {
        let gtk_menu = to_gtk_menu(self.gtk_menu_handle);
        let data = get_menu_data(self.gtk_menu_handle);

        let gtk_menu_item = self.new_gtk_menu_item(&mut item, &data.config);

        if let Some(index) = index {
            gtk_menu.insert(&gtk_menu_item, index);
        } else {
            gtk_menu.append(&gtk_menu_item);
        }

        self.reset_haccel(&item);

        if !gtk_menu.children().is_empty() {
            gtk_menu.set_sensitive(true);
        }

        self.after_change_items();
    }

    fn new_gtk_menu_item(&mut self, item: &mut MenuItem, config: &Config) -> gtk::MenuItem {
        match item.menu_item_type {
            MenuItemType::Submenu => MenuBuilder::new_submenu_with_items(self, item, config),
            MenuItemType::Radio => {
                if let Some(radio) = self.items().iter().find(|existing_item| existing_item.name == item.name) {
                    let mut radio_groups = radio_group_from_item(radio);
                    create_gtk_menu_item(self.gtk_menu_handle, item, None, Some(&mut radio_groups), config)
                } else {
                    create_gtk_menu_item(self.gtk_menu_handle, item, None, None, config)
                }
            }
            _ => create_gtk_menu_item(self.gtk_menu_handle, item, None, None, config),
        }
    }

    /// Removes the MenuItem at the specified index.
    pub fn remove_at(&mut self, index: u32) {
        let gtk_menu = to_gtk_menu(self.gtk_menu_handle);
        if let Some(remove_gtk_menu_item) = gtk_menu.children().get(index as usize) {
            gtk_menu.remove(remove_gtk_menu_item);

            if gtk_menu.children().is_empty() {
                gtk_menu.set_sensitive(false);
            }

            self.after_change_items();
        }
    }

    /// Removes the MenuItem.
    pub fn remove(&mut self, item: &MenuItem) {
        let gtk_menu = to_gtk_menu(self.gtk_menu_handle);
        let maybe_index = index_of_item(&gtk_menu.children(), item.uuid);

        if let Some(index) = maybe_index {
            self.remove_at(index as u32);
        }
    }

    fn after_change_items(&self) {
        toggle_menu_item_icons(self.gtk_menu_handle);
    }

    fn reset_haccel(&self, item: &MenuItem) {
        let gtk_menu_handle = if self.menu_type == MenuType::Main {
            self.gtk_menu_handle
        } else {
            self.parent_gtk_menu_handle
        };

        add_accelerators_from_menu_item(gtk_menu_handle, item);
    }

    /// Shows Menu at the specified point.
    pub fn popup_at(&self, x: i32, y: i32) {
        let gtk_window = to_gtk_window(self.gtk_window_handle);
        let gtk_menu = to_gtk_menu(self.gtk_menu_handle);

        let mut event = gdk::Event::new(gdk::EventType::ButtonPress);
        event.set_device(gtk_window.display().default_seat().and_then(|d| d.pointer()).as_ref());

        let window = gtk_window.window().unwrap();

        let event_ffi: *mut GdkEvent = event.to_glib_none().0;
        if !event_ffi.is_null() {
            let time = monotonic_time() / 1000;
            unsafe {
                (*event_ffi).button.time = time as u32;
            }
        }

        #[cfg(feature = "accelerator")]
        connect_accelerator(&gtk_menu, self.gtk_menu_handle, self.gtk_window_handle);
        toggle_visible(&gtk_window, self.gtk_menu_handle);
        gtk_menu.popup_at_rect(&window, &Rectangle::new(x, y, 0, 0), Gravity::NorthWest, Gravity::NorthWest, Some(&event));
        toggle_visible(&gtk_window, self.gtk_menu_handle);
    }

    /// Shows Menu asynchronously at the specified point and returns the selected MenuItem if any.
    pub async fn popup_at_async(&self, x: i32, y: i32) -> Option<MenuItem> {
        let (tx, rx) = smol::channel::bounded(1);
        let (gtk_window_handle, gtk_menu_handle) = (self.gtk_window_handle, self.gtk_menu_handle);

        gtk::glib::MainContext::default().invoke(move || {
            gtk::glib::spawn_future_local(async move {
                let gtk_window = to_gtk_window(gtk_window_handle);
                let gtk_menu = to_gtk_menu(gtk_menu_handle);

                let mut event = gdk::Event::new(gdk::EventType::ButtonPress);
                event.set_device(gtk_window.display().default_seat().and_then(|d| d.pointer()).as_ref());

                let window = gtk_window.window().unwrap();

                let event_ffi: *mut GdkEvent = event.to_glib_none().0;
                if !event_ffi.is_null() {
                    let time = monotonic_time() / 1000;
                    unsafe {
                        (*event_ffi).button.time = time as u32;
                    }
                }

                #[cfg(feature = "accelerator")]
                connect_accelerator(&gtk_menu, gtk_menu_handle, gtk_window_handle);

                toggle_visible(&gtk_window, gtk_menu_handle);

                gtk_menu.popup_at_rect(&window, &Rectangle::new(x, y, 0, 0), Gravity::NorthWest, Gravity::NorthWest, Some(&event));

                let mut item = None;

                let signal = gtk_menu.connect_hide(move |_| {
                    MenuEvent::send_inner(InnerMenuEvent {
                        item: None,
                    });
                });

                if let Ok(event) = MenuEvent::innner_receiver().recv().await {
                    item = event.item;
                }

                gtk_menu.disconnect(signal);

                toggle_visible(&gtk_window, gtk_menu_handle);

                /*
                    Wait 50 ms for "activate" event.
                    "activate" by click occurs after automatic menu "hide", so event can have menu item.
                    "activate" by keypress occurs before menu "hide", so event is none that should be dismissed.
                */
                smol::Timer::after(Duration::from_millis(50)).await;
                if let Ok(event) = MenuEvent::innner_receiver().try_recv() {
                    if event.item.is_some() {
                        item = event.item;
                    }
                }

                let _ = tx.try_send(item);
            });
        });

        rx.recv().await.unwrap_or_default()
    }
}

fn toggle_visible(gtk_window: &gtk::Window, gtk_menu_handle: isize) {
    let menu_data = get_menu_data_mut(gtk_menu_handle);
    menu_data.visible = !menu_data.visible;
    if menu_data.visible {
        add_accel_group(gtk_window, gtk_menu_handle);
    } else {
        remove_accel_group(gtk_window, gtk_menu_handle);
    }
}

pub(crate) fn collect_menu_items(gtk_menu_handle: isize) -> Vec<MenuItem> {
    let gtk_menu = to_gtk_menu(gtk_menu_handle);
    gtk_menu.children().iter().map(|item| get_menu_item_data(item).clone()).collect()
}

fn find_by_id(gtk_menu_items: &Vec<Widget>, id: &str) -> Option<MenuItem> {
    let item_id = id.to_string();
    for gtk_menu_item in gtk_menu_items {
        let menu_item = get_menu_item_data(gtk_menu_item);
        if menu_item.id == item_id {
            return Some(menu_item.clone());
        }

        if menu_item.menu_item_type == MenuItemType::Submenu {
            let gtk_submenu = to_gtk_menu(menu_item.submenu.as_ref().unwrap().gtk_menu_handle);
            if let Some(menu_item) = find_by_id(&gtk_submenu.children(), id) {
                return Some(menu_item);
            }
        }
    }
    None
}

fn index_of_item(gtk_menu_items: &[Widget], uuid: u16) -> Option<usize> {
    for (index, gtk_menu_item) in gtk_menu_items.iter().enumerate() {
        let menu_item = get_menu_item_data(gtk_menu_item);
        if menu_item.uuid == uuid {
            return Some(index);
        }

        if menu_item.menu_item_type == MenuItemType::Submenu {
            let gtk_submenu = to_gtk_menu(menu_item.submenu.as_ref().unwrap().gtk_menu_handle);
            if let Some(index) = index_of_item(&gtk_submenu.children(), uuid) {
                return Some(index);
            }
        }
    }
    None
}

fn on_theme_change(menu_type: MenuType, gtk_menu_handle: isize, maybe_preferred_theme: Option<Theme>, factor: ThemeChangeFactor) {
    let data = get_menu_data_mut(gtk_menu_handle);

    if menu_type == MenuType::Submenu {
        return;
    }

    let current_them = data.config.theme;

    /* Don't respont to setting change event unless theme is System */
    if current_them != Theme::System && factor == ThemeChangeFactor::SystemSetting {
        return;
    }

    let should_be_dark = match factor {
        ThemeChangeFactor::User => {
            let preferred_theme = maybe_preferred_theme.unwrap();
            if preferred_theme == Theme::System {
                is_sys_dark()
            } else {
                preferred_theme == Theme::Dark
            }
        }
        ThemeChangeFactor::App => {
            if let Some(preferred_theme) = maybe_preferred_theme {
                preferred_theme == Theme::Dark
            } else {
                is_sys_dark()
            }
        }
        ThemeChangeFactor::SystemSetting => false,
    };

    let new_theme = match maybe_preferred_theme {
        Some(preferred_theme) => preferred_theme,
        None => {
            if current_them == Theme::System {
                current_them
            } else if should_be_dark {
                Theme::Dark
            } else {
                Theme::Light
            }
        }
    };

    data.config.theme = new_theme;

    let widget_name = get_widget_name(new_theme);

    let gtk_menu = to_gtk_menu(gtk_menu_handle);
    if let Some(menu_conainer_widget) = gtk_menu.parent() {
        if let Ok(gtk_window) = menu_conainer_widget.dynamic_cast::<gtk::Window>() {
            gtk_window.set_widget_name(widget_name);
        }
    }
    gtk_menu.set_widget_name(widget_name);

    change_style(&gtk_menu.children(), new_theme, widget_name, data);
}

fn change_style(gtk_menu_items: &Vec<Widget>, new_theme: Theme, widget_name: &str, data: &MenuData) {
    for gtk_menu_item in gtk_menu_items {
        gtk_menu_item.set_widget_name(widget_name);
        apply_theme_to_svg_data(gtk_menu_item, data);

        if let Some(submenu) = gtk_menu_item.downcast_ref::<gtk::MenuItem>().unwrap().submenu() {
            let gtk_submenu = submenu.downcast::<gtk::Menu>().unwrap();
            let submenu_handle = from_gtk_menu(&gtk_submenu);
            let submenu_data = get_menu_data_mut(submenu_handle);
            submenu_data.config.theme = new_theme;
            if let Some(menu_conainer_widget) = gtk_submenu.parent() {
                if let Ok(gtk_window) = menu_conainer_widget.dynamic_cast::<gtk::Window>() {
                    gtk_window.set_widget_name(widget_name);
                }
            }
            gtk_submenu.set_widget_name(widget_name);
            change_style(&gtk_submenu.children(), new_theme, widget_name, data);
        }
    }
}