broot 1.56.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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use {
    super::*,
    crate::{
        app::AppContext,
        errors::PatternError,
        pattern::{
            Pattern,
            PatternParts,
        },
    },
    bet::BeTree,
    lazy_regex::*,
};

/// wraps both
/// - the "pattern" (which may be used to filter and rank file entries)
/// - the source raw string which was used to build it and which may
///   be put back in the input.
#[derive(Debug, Clone)]
pub struct InputPattern {
    pub raw: String,
    pub pattern: Pattern,
}

impl PartialEq for InputPattern {
    fn eq(
        &self,
        other: &Self,
    ) -> bool {
        self.raw == other.raw
    }
}

impl InputPattern {
    pub fn none() -> Self {
        Self {
            raw: String::new(),
            pattern: Pattern::None,
        }
    }
    pub fn new(
        raw: String,
        parts_expr: &BeTree<PatternOperator, PatternParts>,
        con: &AppContext,
    ) -> Result<Self, PatternError> {
        let pattern = Pattern::new(
            parts_expr,
            &con.search_modes,
            con.content_search_max_file_size,
        )?;
        Ok(Self { raw, pattern })
    }
    pub fn is_none(&self) -> bool {
        self.pattern.is_empty()
    }
    pub fn is_some(&self) -> bool {
        self.pattern.is_some()
    }
    /// empties the pattern and return it
    /// Similar to Option::take
    pub fn take(&mut self) -> Self {
        std::mem::replace(self, Self::none())
    }
    pub fn as_option(self) -> Option<Self> {
        if self.is_some() { Some(self) } else { None }
    }
    /// from a pattern used to filter a tree, build a pattern
    /// which would make sense to filter a previewed file
    pub fn tree_to_preview(&self) -> Self {
        let regex_parts: Option<(String, String)> = match &self.pattern {
            Pattern::ContentExact(cp) => Some(cp.to_regex_parts()),
            Pattern::ContentRegex(rp) => Some(rp.to_regex_parts()),
            Pattern::Composite(cp) => {
                cp.expr.paths_to_atoms()
                    .into_iter()
                    .filter(|(path, _p)| {
                        !(path.contains(&PatternOperator::Or) || path.contains(&PatternOperator::Not))
                    })
                    .find_map(|(_path, p)| match p {
                        Pattern::ContentExact(ce) => Some(ce.to_regex_parts()),
                        Pattern::ContentRegex(cp) => Some(cp.to_regex_parts()),
                        _ => None,
                    })
            }
            _ => None,
        };
        regex_parts
            .map(|(core, modifiers)|
                // The regex part is missing the escaping which prevents it from
                // ending the pattern in the input. We need to restore it
                // See https://github.com/Canop/broot/issues/778
                (regex_replace_all!("[ :]", &core, "\\$0").to_string(), modifiers))
            .and_then(|(core, modifiers)| RegexPattern::from(&core, &modifiers).ok())
            .map(|rp| InputPattern {
                raw: rp.to_string(), // this adds the initial /
                pattern: Pattern::NameRegex(rp),
            })
            .unwrap_or_else(InputPattern::none)
    }
}

#[test]
fn test_tree_to_preview() {
    fn make_pat(s: &str) -> InputPattern {
        let cp = crate::command::CommandParts::from(s);
        let search_modes = SearchModeMap::default();
        InputPattern {
            raw: s.to_string(),
            pattern: Pattern::new(
                &cp.pattern,
                &search_modes,
                0, // we don't do content search here
            )
            .unwrap(),
        }
    }

    assert_eq!(make_pat("c/test").tree_to_preview(), make_pat("/test"));
    assert_eq!(
        make_pat("/java$/&c/test").tree_to_preview(),
        make_pat("/test")
    );
    assert_eq!(
        make_pat("!c/test").tree_to_preview(),
        make_pat("")
    );
    assert_eq!(
        make_pat(".java&!c/test").tree_to_preview(),
        make_pat("")
    );
    assert_eq!(
        make_pat(".java|c/test").tree_to_preview(),
        make_pat("")
    );
    assert_eq!(
        make_pat("!.java&c/test").tree_to_preview(),
        make_pat("/test")
    );
    assert_eq!(
        make_pat("(.java|.rs)&c/test").tree_to_preview(),
        make_pat("/test")
    );
    assert_eq!(
        make_pat(".java&(c/foo/|c/bar/)").tree_to_preview(),
        make_pat("")
    );

    // not ideal handling: we'd like "c/foo&c/bar" to give "/foo/|/bar/"
}