ncursesw-win 0.6.3

/*
    examples/menu-test.rs

    Copyright (c) 2019-2022 Stephen Whittle  All rights reserved.

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom
    the Software is furnished to do so, subject to the following conditions:
    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    IN THE SOFTWARE.
*/

/*
    When you run this make sure you redirect stderr to say a file as when a
    menu item is initialised and/or terminated output is sent to stderr
    indicating that the action has been performed.
*/

extern crate gettextrs;
extern crate ncurseswwin;

use std::process::exit;
use anyhow::Result;
use gettextrs::{setlocale, LocaleCategory};
use ncurseswwin::{*, menu::*};

const CHOICES: [&str; 5] = ["Choice 1", "Choice 2", "Choice 3", "Choice 4", "Exit"];

fn main() {
    if let Err(source) = main_routine() {
        if let Some(err) = source.downcast_ref::<NCurseswWinError>() {
            match err {
                NCurseswWinError::Panic { message } => eprintln!("panic: {}", message),
                _                                   => eprintln!("error: {}", err)
            }
        } else {
            eprintln!("error: {}", source);
        }

        source.chain().skip(1).for_each(|cause| eprintln!("cause: {}", cause));

        exit(1);
    }

    exit(0);
}

fn main_routine() -> Result<()> {
    setlocale(LocaleCategory::LcAll, "");

    // initialize ncurses in a safe way.
    ncursesw_entry(|stdscr| {
        set_input_mode(InputMode::Character)?;
        set_echo(false)?;
        set_newline(false)?;
        intrflush(false)?;

        cursor_set(CursorType::Invisible)?;

        menu_test(stdscr)
    })
}

fn menu_test(stdscr: &Window) -> Result<()> {
    stdscr.keypad(true)?;

    let my_item0 = &MenuItem::new(CHOICES[0], &format!("{} description", CHOICES[0]))?;
    let my_item1 = &MenuItem::new(CHOICES[1], &format!("{} description", CHOICES[1]))?;
    let my_item2 = &MenuItem::new(CHOICES[2], &format!("{} description", CHOICES[2]))?;
    let my_item3 = &MenuItem::new(CHOICES[3], &format!("{} description", CHOICES[3]))?;
    let my_item4 = &MenuItem::new(CHOICES[4], &format!("{} description", CHOICES[4]))?;

    // Create items.
    let my_items = vec![my_item0, my_item1, my_item2, my_item3, my_item4];

    // Crate menu.
    let my_menu = &Menu::new(&my_items)?;

    my_menu.menu_opts_off(MenuOptions::default().set_show_description(true))?;

    // set our callbacks for menu item initialisation and termination.
    my_menu.set_item_init(test_item_init)?;
    my_menu.set_item_term(test_item_term)?;

    let my_menu_win = &Window::new(Size { lines: 9, columns: 18 }, Origin { y: 4, x: 4 })?;
    my_menu_win.keypad(true)?;

    // Set main window and sub window.
    my_menu.set_menu_win(Some(my_menu_win))?;
    let my_menu_win_derwin = &my_menu_win.derwin(Size { lines: 5, columns: 0 }, Origin { y: 2, x: 2 })?;
    my_menu.set_menu_sub(Some(my_menu_win_derwin))?;

    // Set menu mark to the string " * ".
    my_menu.set_menu_mark(" * ")?;

    // Print a border around the main window.
    my_menu_win.r#box(ChtypeChar::from(0), ChtypeChar::from(0))?;

    let mut origin = Origin { y: LINES()? - 3, x: 0 };
    stdscr.mvaddstr(origin, "Press <Enter> to see the option selected")?;
    origin.y += 1;
    stdscr.mvaddstr(origin, "F1 to exit")?;
    stdscr.refresh()?;

    origin = Origin { y: 20, x: 0 };

    // Post the menu and refresh the menu's window.
    let posted_menu = &my_menu.post_menu(true)?;

    loop {
        match stdscr.getch()? {
            CharacterResult::Key(key_binding)     => match key_binding {
                KeyBinding::FunctionKey(1) => break,
                KeyBinding::DownArrow      => menu_driver(posted_menu, MenuRequest::DownItem)?,
                KeyBinding::UpArrow        => menu_driver(posted_menu, MenuRequest::UpItem)?,
                _                          => continue
            },
            CharacterResult::Character(character) => if character == '\n' {
                stdscr.set_cursor(origin)?;
                stdscr.clrtoeol()?;
                stdscr.mvaddstr(origin, &format!("Item selected is : {}", my_menu.current_item()?.item_name()?))?;
                stdscr.refresh()?;
                posted_menu.pos_menu_cursor()?;
            }
        }

        posted_menu.refresh()?;
    }

    Ok(())
}

fn menu_driver(posted_menu: &PostedMenu, menu_request: MenuRequest) -> Result<(), NCurseswWinError> {
    if let Err(source) = posted_menu.menu_driver(menu_request) {
        if source != request_denied_error() {
            return Err(source)
        }
    }

    Ok(())
}

fn request_denied_error() -> NCurseswWinError {
    NCurseswWinError::from(NCurseswMenuError::RequestDenied { func: "menu_driver".to_string() })
}

fn test_item_init(menu: &Menu) {
    let current_item = menu.current_item().unwrap_or_else(|source| panic!("test_item_init() : {}", source));
    let item_description = current_item.item_description().unwrap_or_else(|source| panic!("test_item_init() : {}", source));

    eprintln!("item_init {:?} : {}", current_item, item_description)
}

fn test_item_term(menu: &Menu) {
    let current_item = menu.current_item().unwrap_or_else(|source| panic!("test_item_term() : {}", source));
    let item_description = current_item.item_description().unwrap_or_else(|source| panic!("test_item_term() : {}", source));

    eprintln!("item_term {:?} : {}", current_item, item_description)
}