broot 1.2.8

A new file manager
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

//! declare the internal functions which may be used in verbs.
//! They don't take any user argument other than the selection
//! (this may change if the needs arise).
//! They can be called as ":some_name" from builtin verbs and
//! from configured verbs.

use {
    crate::errors::ConfError,
};

macro_rules! Internals {
    (
        $($name:ident: $description:expr,)*
    ) => {
        #[derive(Debug, Clone, Copy, PartialEq)]
        #[allow(non_camel_case_types)]
        pub enum Internal {
            $($name,)*
        }
        impl Internal {
            pub fn try_from(verb: &str) -> Result<Internal, ConfError> {
                use Internal::*;
                match verb {
                    $(stringify!($name) => Ok($name),)*
                    _ => Err(ConfError::UnknownInternal{ verb: verb.to_string() }),
                }
            }
        }
        impl Internal {
            pub fn name(self) -> &'static str {
                use Internal::*;
                match self {
                    $($name => stringify!($name),)*
                }
            }
            pub fn description(self) -> &'static str {
                use Internal::*;
                match self {
                    $($name => $description,)*
                }
            }
        }
    }
}


Internals! {
    back: "revert to the previous state (mapped to *esc*)",
    close_panel_ok: "close the panel, validating the selected path",
    close_panel_cancel: "close the panel, not using the selected path",
    copy_line: "copy selected line (in tree or preview)",
    copy_path: "copy path to system clipboard",
    filesystems: "list mounted filesystems",
    focus: "display the directory (mapped to *enter*)",
    help: "display broot's help",
    input_del_char_left: "delete the char left of the cursor",
    input_del_char_below: "delete the char left at the cursor's position",
    input_del_word_left: "delete the word left of the cursor",
    input_del_word_right: "delete the word right of the cursor",
    input_go_to_end: "move the cursor to the end of input",
    input_go_left: "move the cursor to the left",
    input_go_right: "move the cursor to the right",
    input_go_to_start: "move the cursor to the start of input",
    input_go_word_left: "move the cursor one word to the left",
    input_go_word_right: "move the cursor one word to the right",
    input_paste: "paste the clipboard content into the input",
    line_down: "move one line down",
    line_up: "move one line up",
    line_down_no_cycle: "move one line down",
    line_up_no_cycle: "move one line up",
    open_stay: "open file or directory according to OS (stay in broot)",
    open_stay_filter: "display the directory, keeping the current pattern",
    open_leave: "open file or directory according to OS (quit broot)",
    mode_input: "enter the input mode",
    mode_command: "enter the command mode",
    next_match: "select the next match",
    next_same_depth: "select the next file at the same depth",
    no_sort: "don't sort",
    page_down: "scroll one page down",
    page_up: "scroll one page up",
    parent: "move to the parent directory",
    panel_left: "focus panel on left",
    panel_right: "focus panel on right",
    previous_match: "select the previous match",
    previous_same_depth: "select the previous file at the same depth",
    open_preview: "open the preview panel",
    close_preview: "close the preview panel",
    toggle_preview: "open/close the preview panel",
    preview_image: "preview the selection as image",
    preview_text: "preview the selection as text",
    preview_binary: "preview the selection as binary",
    print_path: "print path and leaves broot",
    print_relative_path: "print relative path and leaves broot",
    print_tree: "print tree and leaves broot",
    start_end_panel: "either open or close an additional panel",
    quit: "quit Broot",
    refresh: "refresh tree and clear size cache",
    //restore_pattern: "restore a pattern which was just removed",
    select_first: "select the first file",
    select_last: "select the last file",
    sort_by_count: "sort by count",
    sort_by_date: "sort by date",
    sort_by_size: "sort by size",
    toggle_counts: "toggle showing number of files in directories",
    toggle_dates: "toggle showing last modified dates",
    toggle_files: "toggle showing files (or just folders)",
    toggle_git_ignore: "toggle use of .gitignore",
    toggle_git_file_info: "toggle display of git file information",
    toggle_git_status: "toggle showing only files relevant for git status",
    toggle_root_fs: "toggle showing filesystem info on top",
    toggle_hidden: "toggle showing hidden files",
    toggle_perm: "toggle showing file permissions",
    toggle_sizes: "toggle showing sizes",
    toggle_trim_root: "toggle removing nodes at first level too",
    total_search: "search again but on all children",
    up_tree: "focus the parent of the current root",
}

impl Internal {
    pub fn invocation_pattern(self) -> &'static str {
        match self {
            Internal::focus => r"focus (?P<path>.*)?",
            Internal::line_down => r"line_down (?P<count>\d*)?",
            Internal::line_up => r"line_up (?P<count>\d*)?",
            Internal::line_down_no_cycle => r"line_down_no_cycle (?P<count>\d*)?",
            Internal::line_up_no_cycle => r"line_up_no_cycle (?P<count>\d*)?",
            _ => self.name(),
        }
    }
    pub fn exec_pattern(self) -> &'static str {
        match self {
            Internal::focus => r"focus {path}",
            Internal::line_down_no_cycle => r"line_down_no_cycle {count}",
            Internal::line_up_no_cycle => r"line_up_no_cycle {count}",
            _ => self.name(),
        }
    }
}