workflow-nw 0.18.0

//!
//!  Builder for application menus.
//!
//! ```rust
//! use workflow_nw::prelude::*;
//! use workflow_nw::result::Result;
//! use workflow_dom::utils::window;
//! use wasm_bindgen::JsValue;
//!
//! # fn test()->Result<()>{
//!
//! // create Application instance
//! let app = Application::new()?;
//!
//! // create context menu
//! let item_1 = MenuItemBuilder::new()
//!     .label("Sub Menu 1")
//!     .callback(move |_|->std::result::Result<(), JsValue>{
//!         window().alert_with_message("Context menu 1 clicked")?;
//!         Ok(())
//!     }).build()?;
//!     
//! let item_2 = MenuItemBuilder::new()
//!     .label("Sub Menu 2")
//!     .callback(move |_|->std::result::Result<(), JsValue>{
//!         window().alert_with_message("Context menu 2 clicked")?;
//!         Ok(())
//!     }).build()?;
//!     
//!     
//! app.create_context_menu(vec![item_1, item_2])?;
//!
//! // create menubar
//! let submenu_1 = MenuItemBuilder::new()
//!     .label("Menu A")
//!     .key("8")
//!     .modifiers("ctrl")
//!     .callback(move |_|->std::result::Result<(), JsValue>{
//!         //log_trace!("Create window : menu clicked");
//!         window().alert_with_message("Menu A clicked")?;
//!         Ok(())
//!     }).build()?;
//!     
//! let submenu_2 = MenuItemBuilder::new()
//!     .label("Say hello")
//!     .key("9")
//!     .modifiers("ctrl")
//!     .callback(move |_|->std::result::Result<(), JsValue>{
//!         window().alert_with_message("Hello")?;
//!         Ok(())
//!     }).build()?;
//!     
//! let item = MenuItemBuilder::new()
//!     .label("Top Menu")
//!     .submenus(vec![submenu_1, menu_separator(), submenu_2])
//!     .build()?;
//!     
//!     
//! MenubarBuilder::new("Example App", false)
//!     //.mac_hide_edit(true)
//!     .mac_hide_window(true)
//!     .append(item)
//!     .build(true)?;
//!
//! # Ok(())
//! # }
//! ```
//!

use crate::application::app;
use crate::result::Result;
use js_sys::Function;
use nw_sys::prelude::*;
use wasm_bindgen::prelude::*;
use workflow_wasm::prelude::*;

/// create a Separator [`MenuItem`](nw_sys::MenuItem)
pub fn menu_separator() -> nw_sys::MenuItem {
    nw_sys::MenuItem::new(&nw_sys::menu_item::Type::Separator.into())
}

/// Provides a builder pattern for building application menus.
///
/// For usage example please refer to [Examples](self)
pub struct MenubarBuilder {
    pub mac_options: nw_sys::menu::MacOptions,
    pub app_name: String,
    pub menubar: nw_sys::Menu,
    pub menu_items: Vec<nw_sys::MenuItem>,
    pub is_macos: bool,
}

impl MenubarBuilder {
    pub fn new(app_name: &str, is_macos: bool) -> Self {
        Self {
            mac_options: nw_sys::menu::MacOptions::new(),
            app_name: app_name.to_string(),
            menubar: nw_sys::Menu::new_with_options(&nw_sys::menu::Type::Menubar.into()),
            menu_items: vec![],
            is_macos,
        }
    }
    /// (Mac) do not populate the Edit menu
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Menu/#menucreatemacbuiltinappname-options-mac)
    pub fn mac_hide_edit(mut self, hide: bool) -> Self {
        if self.is_macos {
            self.mac_options = self.mac_options.hide_edit(hide);
        }
        self
    }
    /// (Mac) do not populate the Window menu
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/Menu/#menucreatemacbuiltinappname-options-mac)
    pub fn mac_hide_window(mut self, hide: bool) -> Self {
        if self.is_macos {
            self.mac_options = self.mac_options.hide_window(hide);
        }
        self
    }

    /// Append new child menu item
    pub fn append(mut self, menu_item: nw_sys::MenuItem) -> Self {
        self.menu_items.push(menu_item);
        self
    }

    /// Build menubar
    ///
    /// optionally attach menubar to app/window
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/For%20Users/Advanced/Customize%20Menubar/#create-and-set-menubar)
    pub fn build(self, attach: bool) -> Result<nw_sys::Menu> {
        if self.is_macos {
            self.menubar
                .create_mac_builtin_with_options(&self.app_name, &self.mac_options);
        }

        for item in self.menu_items {
            self.menubar.append(&item);
        }
        if attach {
            nw_sys::window::get().set_menu(&self.menubar);
        }
        Ok(self.menubar)
    }
}

/// MenuItem Builder
///
/// For usage example please refer to [Examples](self)
pub struct MenuItemBuilder {
    pub options: nw_sys::menu_item::Options,
    pub callback: Option<Callback<CallbackClosure<JsValue>>>,
}

impl Default for MenuItemBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl MenuItemBuilder {
    pub fn new() -> Self {
        Self {
            options: nw_sys::menu_item::Options::new(),
            callback: None,
        }
    }

    fn set(mut self, key: &str, value: JsValue) -> Self {
        self.options = self.options.set(key, value);
        self
    }

    /// Type of MenuItem
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn set_type(self, t: MenuItemType) -> Self {
        self.set("type", t.into())
    }

    /// Label for normal item or checkbox
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn label(self, label: &str) -> Self {
        self.set("label", JsValue::from(label))
    }

    /// Icon for normal item or checkbox
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn icon(self, icon: &str) -> Self {
        self.set("icon", JsValue::from(icon))
    }

    /// Tooltip for normal item or checkbox
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn tooltip(self, tooltip: &str) -> Self {
        self.set("tooltip", JsValue::from(tooltip))
    }

    /// The callback function when item is triggered by mouse click or keyboard shortcut
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn callback<F>(mut self, callback: F) -> Self
    where
        F: FnMut(JsValue) -> std::result::Result<(), JsValue> + 'static,
    {
        let callback = Callback::new(callback);
        let cb: &Function = callback.as_ref(); //.into_js();
        self = self.set("click", JsValue::from(cb));
        self.callback = Some(callback);

        self
    }

    /// Whether the item is enabled or disabled. It’s set to true by default.
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn enabled(self, enabled: bool) -> Self {
        self.set("enabled", JsValue::from(enabled))
    }

    /// Whether the checkbox is checked or not. It’s set to false by default.
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn checked(self, checked: bool) -> Self {
        self.set("checked", JsValue::from(checked))
    }

    /// A submenu
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn submenu(self, submenu: &Menu) -> Self {
        self.set("submenu", JsValue::from(submenu))
    }

    /// Create submenu from menu items
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn submenus(self, items: Vec<MenuItem>) -> Self {
        let submenu = nw_sys::Menu::new();
        for menu_item in items {
            submenu.append(&menu_item);
        }
        self.set("submenu", JsValue::from(submenu))
    }

    /// The key of the shortcut
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn key(self, key: &str) -> Self {
        self.set("key", JsValue::from(key))
    }

    /// The modifiers of the shortcut
    ///
    /// ⧉ [NWJS Documentation](https://docs.nwjs.io/en/latest/References/MenuItem/#new-menuitemoption)
    pub fn modifiers(self, modifiers: &str) -> Self {
        self.set("modifiers", JsValue::from(modifiers))
    }

    pub fn build(self) -> Result<nw_sys::MenuItem> {
        if let Some(callback) = self.callback {
            let app = match app() {
                Some(app) => app,
                None => return Err("app is not initialized".to_string().into()),
            };
            app.callbacks.retain(callback)?;
        }

        let menu_item = nw_sys::MenuItem::new(&self.options);
        Ok(menu_item)
    }

    pub fn finalize(
        self,
    ) -> Result<(nw_sys::MenuItem, Option<Callback<CallbackClosure<JsValue>>>)> {
        let menu_item = nw_sys::MenuItem::new(&self.options);
        Ok((menu_item, self.callback))
    }
}