druid-shell 0.3.2

// Copyright 2019 The xi-editor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! GTK implementation of menus.

use gdk::ModifierType;
use gtkrs::AccelGroup;
use gtkrs::GtkMenuExt;
use gtkrs::Menu as GtkMenu;
use gtkrs::MenuBar as GtkMenuBar;
use gtkrs::MenuItem as GtkMenuItem;
use gtkrs::{GtkMenuItemExt, MenuShellExt, SeparatorMenuItemBuilder, WidgetExt};

use crate::common_util::strip_access_key;
use crate::gtk::WinCtxImpl;
use crate::hotkey::{HotKey, KeyCompare, RawMods};
use crate::keyboard::KeyModifiers;
use crate::platform::WindowHandle;

#[derive(Default, Debug)]
pub struct Menu {
    items: Vec<MenuItem>,
}

#[derive(Debug)]
enum MenuItem {
    Entry(String, u32, Option<HotKey>),
    SubMenu(String, Menu),
    Separator,
}

impl Menu {
    pub fn new() -> Menu {
        Menu { items: Vec::new() }
    }

    pub fn new_for_popup() -> Menu {
        Menu { items: Vec::new() }
    }

    pub fn add_dropdown(&mut self, menu: Menu, text: &str, _enabled: bool) {
        // TODO: implement enabled dropdown
        self.items
            .push(MenuItem::SubMenu(strip_access_key(text), menu));
    }

    pub fn add_item(
        &mut self,
        id: u32,
        text: &str,
        key: Option<&HotKey>,
        _enabled: bool,
        _selected: bool,
    ) {
        // TODO: implement enabled, selected item
        self.items
            .push(MenuItem::Entry(strip_access_key(text), id, key.cloned()));
    }

    pub fn add_separator(&mut self) {
        self.items.push(MenuItem::Separator)
    }

    fn append_items_to_menu<M: gtkrs::prelude::IsA<gtkrs::MenuShell>>(
        self,
        menu: &mut M,
        handle: &WindowHandle,
        accel_group: &AccelGroup,
    ) {
        for item in self.items {
            match item {
                MenuItem::Entry(name, id, key) => {
                    let item = GtkMenuItem::new_with_label(&name);

                    if let Some(k) = key {
                        register_accelerator(&item, accel_group, k);
                    }

                    let handle = handle.clone();
                    item.connect_activate(move |_| {
                        let mut ctx = WinCtxImpl::from(&handle);

                        if let Some(state) = handle.state.upgrade() {
                            state.handler.borrow_mut().command(id, &mut ctx);
                        }
                    });

                    menu.append(&item);
                }
                MenuItem::SubMenu(name, submenu) => {
                    let item = GtkMenuItem::new_with_label(&name);
                    item.set_submenu(Some(&submenu.into_gtk_menu(handle, accel_group)));

                    menu.append(&item);
                }
                MenuItem::Separator => menu.append(&SeparatorMenuItemBuilder::new().build()),
            }
        }
    }

    pub(crate) fn into_gtk_menubar(
        self,
        handle: &WindowHandle,
        accel_group: &AccelGroup,
    ) -> GtkMenuBar {
        let mut menu = GtkMenuBar::new();

        self.append_items_to_menu(&mut menu, handle, accel_group);

        menu
    }

    pub fn into_gtk_menu(self, handle: &WindowHandle, accel_group: &AccelGroup) -> GtkMenu {
        let mut menu = GtkMenu::new();
        menu.set_accel_group(Some(accel_group));

        self.append_items_to_menu(&mut menu, handle, accel_group);

        menu
    }
}

fn register_accelerator(item: &GtkMenuItem, accel_group: &AccelGroup, menu_key: HotKey) {
    let wc = match menu_key.key {
        KeyCompare::Code(key_code) => key_code.into(),
        KeyCompare::Text(text) => text.chars().next().unwrap() as u32,
    };

    item.add_accelerator(
        "activate",
        accel_group,
        gdk::unicode_to_keyval(wc),
        modifiers_to_gdk_modifier_type(menu_key.mods),
        gtk::AccelFlags::VISIBLE,
    );
}

fn modifiers_to_gdk_modifier_type(raw_modifiers: RawMods) -> gdk::ModifierType {
    let mut result = ModifierType::empty();

    let modifiers: KeyModifiers = raw_modifiers.into();

    result.set(ModifierType::MOD1_MASK, modifiers.alt);
    result.set(ModifierType::CONTROL_MASK, modifiers.ctrl);
    result.set(ModifierType::SHIFT_MASK, modifiers.shift);
    result.set(ModifierType::META_MASK, modifiers.meta);

    result
}