menu_genie 0.1.0

Multi-level terminal menu library.
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

use crate::menu::Menu;
use crate::menu_item::MenuItem;
use crate::MenuAction;
use crate::MenuGenie;

/// MenuBuilder provides simple API for creating nested menus.
///
/// We start by creating a menu and give it an id. After that we add menu items to it.
/// Menu items are added to the last added menu so menu must exist before we add any menu
/// items.
/// Menu items have auto-incremented ids starting from 1.
///
/// Special menu items are Back and Quit buttons which have id 0.
///
/// If you need both Back and Quit button add one with "shortcut" method and other with `with_menu_item` method

#[derive(Default)]
pub struct MenuBuilder<'a> {
    menus: Vec<Menu<'a>>,
    start_menu_id: Option<usize>,
}

impl<'a> MenuBuilder<'a> {
    /// Creates a new MenuBuilder
    pub fn new() -> Self {
        Self::default()
    }

    /// Inserts another menu with the provided id.
    /// Firts time we add a menu its id is set to be starting id.
    pub fn with_menu(mut self, id: usize) -> Self {
        assert!(
            !self.menus.iter().any(|menu| menu.id == id),
            "Menu with id {id} already added"
        );

        self.menus.push(Menu::new(id));

        if self.start_menu_id.is_none() {
            self.start_menu_id = Some(self.menus.len())
        }

        self
    }

    /// Adds a generic menu item with the provided message and action.
    pub fn with_menu_item(mut self, prompt: &'a str, action: MenuAction) -> Self {
        let last_added_menu = self
            .menus
            .last_mut()
            .expect("Menu must be added first before adding menu items");
        last_added_menu.menu_items.push(MenuItem {
            prompt,
            action,
            key: last_added_menu.menu_items.len() + 1,
        });
        self
    }

    /// Adds a menu item with text "Back", action Back and id 0
    pub fn with_back_button(mut self) -> Self {
        let last_added_menu = self
            .menus
            .last_mut()
            .expect("Menu must be added first before adding menu items");
        last_added_menu.menu_items.push(MenuItem {
            prompt: "Back",
            action: MenuAction::Back,
            key: 0,
        });
        self
    }

    /// Adds a menu item with text "Quit", action Quit and id 0
    pub fn with_quit_button(mut self) -> Self {
        let last_added_menu = self
            .menus
            .last_mut()
            .expect("Menu must be added first before adding menu items");
        last_added_menu.menu_items.push(MenuItem {
            prompt: "Quit",
            action: MenuAction::Quit,
            key: 0,
        });
        self
    }

    /// Changes the starting id so when we build MenuGenie it will start with different menu.
    pub fn with_starting_menu(mut self, starting_menu_id: usize) -> Self {
        self.start_menu_id = Some(starting_menu_id);
        self
    }

    /// Consumes the MenuBulider and creates MenuGenie setting its starting menu to be starting
    /// menu provided in the builder.
    pub fn build(self) -> MenuGenie<'a> {
        assert_ne!(self.menus.len(), 0, "No menus added");
        MenuGenie {
            menus: self.menus,
            // UNWRAP its safe to unwrap here bacause if no menu is added we have assert
            // and if there are menus added starting_menu_id will be Some
            start_menu_id: self.start_menu_id.unwrap(),
            callstack: vec![self.start_menu_id.unwrap()],
        }
    }
}