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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/// Verbs are the engines of broot commands, and apply
/// - to the selected file (if user-defined, then must contain {file}, {parent} or {directory})
/// - to the current app state
use {
crate::{
app_context::AppContext,
app_state::AppStateCmdResult,
errors::{ConfError, ProgramError},
external, keys,
screens::Screen,
selection_type::SelectionType,
status::Status,
verb_invocation::VerbInvocation,
},
crossterm::event::{
KeyCode,
KeyEvent,
},
minimad::Composite,
regex::{self, Captures, Regex},
std::{
collections::HashMap,
fs::OpenOptions,
io::Write,
path::{Path, PathBuf},
},
};
/// what makes a verb.
///
/// There are two types of verbs executions:
/// - external programs or commands (cd, mkdir, user defined commands, etc.)
/// - built in behaviors (focusing a path, going back, showing the help, etc.)
///
#[derive(Debug, Clone)]
pub struct Verb {
pub invocation: VerbInvocation, // how the verb is supposed to be called, may be empty
pub key: Option<KeyEvent>,
pub key_desc: String, // a description of the optional keyboard key triggering that verb
pub args_parser: Option<Regex>,
pub shortcut: Option<String>, // a shortcut, eg "c"
pub execution: String, // a pattern usable for execution, eg ":quit" or "less {file}"
pub description: Option<String>, // a description for the user
pub from_shell: bool, // whether it must be launched from the parent shell (eg because it's a shell function)
pub leave_broot: bool, // only defined for external
pub confirm: bool, // not yet used...
pub selection_condition: SelectionType,
}
lazy_static! {
static ref GROUP: Regex = Regex::new(r"\{([^{}:]+)(?::([^{}:]+))?\}").unwrap();
}
pub trait VerbExecutor {
fn execute_verb(
&mut self,
verb: &Verb,
invocation: &VerbInvocation,
screen: &mut Screen,
con: &AppContext,
) -> Result<AppStateCmdResult, ProgramError>;
}
fn make_invocation_args_regex(spec: &str) -> Result<Regex, ConfError> {
let spec = GROUP.replace_all(spec, r"(?P<$1>.+)");
let spec = format!("^{}$", spec);
Regex::new(&spec.to_string())
.or_else(|_| Err(ConfError::InvalidVerbInvocation { invocation: spec }))
}
fn path_to_string(path: &Path, for_shell: bool) -> String {
if for_shell {
external::escape_for_shell(path)
} else {
path.to_string_lossy().to_string()
}
}
impl Verb {
/// build a verb using standard configurable behavior.
/// "external" means not "built-in".
pub fn create_external(
invocation_str: &str,
key: Option<KeyEvent>,
shortcut: Option<String>,
execution: String,
description: Option<String>,
from_shell: bool,
leave_broot: bool,
confirm: bool,
) -> Result<Verb, ConfError> {
let invocation = VerbInvocation::from(invocation_str);
let args_parser = invocation
.args
.as_ref()
.map(|args| make_invocation_args_regex(&args))
.transpose()?;
// we use the selection condition to prevent configured
// verb execution on enter on directories
let selection_condition = match key {
Some(KeyEvent{code:KeyCode::Enter, ..}) => SelectionType::File,
_ => SelectionType::Any,
};
Ok(Verb {
invocation,
key_desc: key.map_or("".to_string(), keys::key_event_desc),
key,
args_parser,
shortcut,
execution,
description,
from_shell,
leave_broot,
confirm,
selection_condition,
})
}
/// built-ins are verbs offering a logic other than the execution
/// based on exec_pattern. They mostly modify the appstate
pub fn create_builtin(
name: &str,
key: Option<KeyEvent>,
shortcut: Option<String>,
description: &str,
) -> Verb {
Verb {
invocation: VerbInvocation {
name: name.to_string(),
args: None,
},
key_desc: key.map_or("".to_string(), keys::key_event_desc),
key,
args_parser: None,
shortcut,
execution: format!(":{}", name),
description: Some(description.to_string()),
from_shell: false,
leave_broot: true, // ignored
confirm: false, // ignored
selection_condition: SelectionType::Any,
}
}
/// Assuming the verb has been matched, check whether the arguments
/// are OK according to the regex. Return none when there's no problem
/// and return the error to display if arguments don't match
pub fn match_error(&self, invocation: &VerbInvocation) -> Option<String> {
match (&invocation.args, &self.args_parser) {
(None, None) => None,
(None, Some(ref regex)) => {
if regex.is_match("") {
None
} else {
Some(self.invocation.to_string_for_name(&invocation.name))
}
}
(Some(ref s), Some(ref regex)) => {
if regex.is_match(&s) {
None
} else {
Some(self.invocation.to_string_for_name(&invocation.name))
}
}
(Some(_), None) => Some(format!("{} doesn't take arguments", invocation.name)),
}
}
/// build the map which will be used to replace braced parts (i.e. like {part}) in
/// the execution pattern
fn replacement_map(
&self,
file: &Path,
args: &Option<String>,
for_shell: bool,
) -> HashMap<String, String> {
let mut map = HashMap::new();
// first we add the replacements computed from the given path
let parent = file.parent().unwrap_or(file); // when there's no parent... we take file
let file_str = path_to_string(file, for_shell);
let parent_str = path_to_string(parent, for_shell);
map.insert("file".to_string(), file_str.to_string());
map.insert("parent".to_string(), parent_str.to_string());
let dir_str = if file.is_dir() { file_str } else { parent_str };
map.insert("directory".to_string(), dir_str.to_string());
// then the ones computed from the user input
if let Some(args) = args {
if let Some(r) = &self.args_parser {
if let Some(input_cap) = r.captures(&args) {
for name in r.capture_names().flatten() {
if let Some(c) = input_cap.name(name) {
map.insert(name.to_string(), c.as_str().to_string());
}
}
}
} else {
warn!("invocation args given but none expected");
// maybe tell the user?
}
}
map
}
pub fn write_status(
&self,
w: &mut impl Write,
task: Option<&'static str>,
path: PathBuf,
invocation: &VerbInvocation,
screen: &Screen,
) -> Result<(), ProgramError> {
if let Some(err) = self.match_error(invocation) {
Status::new(task, Composite::from_inline(&err), true).display(w, screen)
} else {
let verb_description;
let markdown;
let composite = if let Some(description) = &self.description {
markdown = format!(
"Hit *enter* to **{}**: {}",
&self.invocation.name,
description,
);
Composite::from_inline(&markdown)
} else {
verb_description = self.shell_exec_string(&path, &invocation.args);
mad_inline!(
"Hit *enter* to **$0**: `$1`",
&self.invocation.name,
&verb_description,
)
};
Status::new(
tas
|