broot 1.57.0

File browser and launcher
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

use crate::{
    app::AppContext,
    keys,
    pattern::*,
    verb::*,
};

/// what should be shown for a verb in the help screen, after
/// filtering
pub struct MatchingVerbRow<'v> {
    /// the name in markdown (with matching chars between stars if a pattern is active)
    name: Option<String>,
    /// the shortcut in markdown (with matching chars between stars if a pattern is active)
    shortcut: Option<String>,
    /// the description in markdown, with matching chars between stars if a pattern is active, and
    /// with backticks if the description is code
    pub description_md: String,
    /// the keys description in markdown (with matching chars between stars if a pattern is active)
    pub keys_desc: String,
    pub verb: &'v Verb,
}

impl MatchingVerbRow<'_> {
    /// the name in markdown (with matching chars in bold if
    /// some filtering occurred)
    pub fn name(&self) -> &str {
        // there should be a better way to write this
        self.name
            .as_deref()
            .unwrap_or_else(|| match self.verb.names.first() {
                Some(s) => s.as_str(),
                _ => " ",
            })
    }
    pub fn shortcut(&self) -> &str {
        // there should be a better way to write this
        self.shortcut
            .as_deref()
            .unwrap_or_else(|| match self.verb.names.get(1) {
                Some(s) => s.as_str(),
                _ => " ",
            })
    }
}

/// return the rows of the verbs table in help, taking the current filter
/// into account
pub fn matching_verb_rows<'v>(
    pat: &Pattern,
    con: &'v AppContext,
) -> Vec<MatchingVerbRow<'v>> {
    let mut rows = Vec::new();
    for verb in con.verb_store.verbs() {
        if !verb.show_in_doc {
            continue;
        }
        let mut name = None;
        let mut shortcut = None;
        let mut keys_desc = String::from(" ");
        let keys = verb
            .keys
            .iter()
            .filter(|&&k| con.modal || !keys::is_key_only_modal(k));
        for (i, key) in keys.enumerate() {
            if i > 0 {
                keys_desc.push_str(", ");
            }
            keys_desc.push_str(keys::KEY_FORMAT.to_string(*key).as_str());
        }
        let mut desc_match = None;
        let desc = &verb.description.content;
        if pat.is_some() {
            let mut ok = false;
            name = verb.names.first().and_then(|s| {
                pat.search_string(s).map(|nm| {
                    ok = true;
                    nm.wrap(s, "**", "**")
                })
            });
            shortcut = verb.names.get(1).and_then(|s| {
                pat.search_string(s).map(|nm| {
                    ok = true;
                    nm.wrap(s, "**", "**")
                })
            });
            if let Some(nm) = pat.search_string(keys_desc.as_str()) {
                keys_desc = nm.wrap(keys_desc.as_str(), "**", "**");
                ok = true;
            }
            desc_match = pat.search_string(desc);
            if desc_match.is_some() {
                ok = true;
            }
            if !ok {
                continue;
            }
        }
        let description_md = match (desc_match, verb.description.code) {
            (Some(m), false) => {
                format!("`{}`", m.wrap(desc, "`**", "**`"))
            }
            (Some(m), true) => m.wrap(desc, "**", "**"),
            (None, true) => {
                format!("`{}`", desc)
            }
            (None, false) => desc.to_string(),
        };
        rows.push(MatchingVerbRow {
            name,
            shortcut,
            keys_desc,
            description_md,
            verb,
        });
    }
    rows
}