broot 1.56.2

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
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
use {
    super::*,
    crate::{
        app::*,
        display::W,
        errors::ProgramError,
        keys,
        skin::PanelSkin,
        verb::*,
    },
    crokey::{
        KeyCombination,
        crossterm::{
            cursor,
            event::{
                Event,
                KeyModifiers,
                MouseButton,
                MouseEvent,
                MouseEventKind,
            },
            queue,
        },
        key,
    },
    termimad::{
        Area,
        InputField,
        TimedEvent,
    },
};

/// Wrap the input of a panel, receive events and make commands
pub struct PanelInput {
    pub input_field: InputField,
    tab_cycle_count: Option<usize>, // last displayed completion index
    input_before_cycle: Option<String>,
}

impl PanelInput {
    pub fn new(area: Area) -> Self {
        Self {
            input_field: InputField::new(area),
            tab_cycle_count: None,
            input_before_cycle: None,
        }
    }

    pub fn set_content(
        &mut self,
        content: &str,
    ) {
        self.input_field.set_str(content);
    }

    pub fn get_content(&self) -> String {
        self.input_field.get_content()
    }

    pub fn display(
        &mut self,
        w: &mut W,
        active: bool,
        mode: Mode,
        mut area: Area,
        panel_skin: &PanelSkin,
    ) -> Result<Option<(u16, u16)>, ProgramError> {
        self.input_field
            .set_normal_style(panel_skin.styles.input.clone());
        self.input_field.set_focus(active && mode == Mode::Input);
        if mode == Mode::Command && active {
            queue!(w, cursor::MoveTo(area.left, area.top))?;
            panel_skin.styles.mode_command_mark.queue_str(w, "C")?;
            area.width -= 1;
            area.left += 1;
        }
        self.input_field.set_area(area);
        let cursor_pos = self.input_field.display_on(w)?;
        Ok(cursor_pos)
    }

    /// consume the event to
    /// - maybe change the input
    /// - build a command
    ///   then redraw the input field
    #[allow(clippy::too_many_arguments)]
    pub fn on_event(
        &mut self,
        w: &mut W,
        timed_event: &TimedEvent,
        app_panels: &AppPanels,
        app_state: &AppState,
        con: &AppContext,
    ) -> Result<Command, ProgramError> {
        let cmd = match timed_event {
            TimedEvent {
                event:
                    Event::Mouse(MouseEvent {
                        kind,
                        column,
                        row,
                        modifiers: KeyModifiers::NONE,
                    }),
                ..
            } => self.on_mouse(timed_event, *kind, *column, *row),
            TimedEvent {
                key_combination: Some(key),
                ..
            } => self.on_key(
                timed_event,
                *key,
                app_panels,
                app_state,
                con,
            ),
            _ => Command::None,
        };
        self.input_field.display_on(w)?;
        Ok(cmd)
    }

    /// check whether the verb is an action on the input (like
    /// deleting a word) and if it's the case, applies it and
    /// return true
    fn handle_input_related_verb(
        &mut self,
        verb: &Verb,
        _con: &AppContext,
    ) -> bool {
        if let VerbExecution::Internal(internal_exec) = &verb.execution {
            self.handle_input_related_internal(internal_exec.internal)
        } else {
            false
        }
    }

    /// Supporting direct calls of internals not on key events (eg from a verb
    /// having a cmd, or from a --cmd), update the input and build a command
    /// if the internal is an action on the input (like deleting a word)
    pub fn on_internal(
        &mut self,
        internal: Internal,
    ) -> Command {
        if self.handle_input_related_internal(internal) {
            Command::from_raw(self.input_field.get_content(), false)
        } else {
            Command::None
        }
    }

    /// check whether the internal is an action on the input (like
    /// deleting a word) and if it's the case, applies it and
    /// return true
    fn handle_input_related_internal(
        &mut self,
        internal: Internal,
    ) -> bool {
        match internal {
            Internal::input_clear => {
                if self.input_field.get_content().is_empty() {
                    false
                } else {
                    self.input_field.clear();
                    true
                }
            }
            Internal::input_del_char_left => self.input_field.del_char_left(),
            Internal::input_del_char_below => self.input_field.del_char_below(),
            Internal::input_del_word_left => self.input_field.del_word_left(),
            Internal::input_del_word_right => self.input_field.del_word_right(),
            Internal::input_go_left => self.input_field.move_left(),
            Internal::input_go_right => self.input_field.move_right(),
            Internal::input_go_word_left => self.input_field.move_word_left(),
            Internal::input_go_word_right => self.input_field.move_word_right(),
            Internal::input_go_to_start => self.input_field.move_to_start(),
            Internal::input_go_to_end => self.input_field.move_to_end(),
            #[cfg(feature = "clipboard")]
            Internal::input_selection_cut => {
                let s = self.input_field.cut_selection();
                if let Err(err) = terminal_clipboard::set_string(s) {
                    warn!("error in writing into clipboard: {}", err);
                }
                true
            }
            #[cfg(feature = "clipboard")]
            Internal::input_selection_copy => {
                let s = self.input_field.copy_selection();
                if let Err(err) = terminal_clipboard::set_string(s) {
                    warn!("error in writing into clipboard: {}", err);
                }
                true
            }
            #[cfg(feature = "clipboard")]
            Internal::input_paste => {
                match terminal_clipboard::get_string() {
                    Ok(pasted) => {
                        for c in pasted
                            .chars()
                            .filter(|c| c.is_alphanumeric() || c.is_ascii_punctuation())
                        {
                            self.input_field.put_char(c);
                        }
                    }
                    Err(e) => {
                        warn!("Error in reading clipboard: {:?}", e);
                    }
                }
                true
            }
            _ => false,
        }
    }

    /// when a key is used to enter input mode, we don't always
    /// consume it. Sometimes it should be consumed, sometimes it
    /// should be added to the input
    fn enter_input_mode_with_key(
        &mut self,
        key: KeyCombination,
        parts: &CommandParts,
    ) {
        if let Some(c) = key.as_letter() {
            let add = match c {
                // '/' if !parts.raw_pattern.is_empty() => true,
                ' ' if parts.verb_invocation.is_none() => true,
                ':' if parts.verb_invocation.is_none() => true,
                _ => false,
            };
            if add {
                self.input_field.put_char(c);
            }
        }
    }

    /// escape (bound to the 'esc' key)
    ///
    /// This function is better called from the `on_key` method of
    /// panel input, when a key triggers it, because then it
    /// can also properly deal with completion sequence.
    /// When ':escape' is called from a verb's cmd sequence, then
    /// it's not called on `on_key` but by the app.
    pub fn escape(
        &mut self,
        mode: Mode,
        con: &AppContext,
    ) -> Command {
        self.tab_cycle_count = None;
        if let Some(raw) = self.input_before_cycle.take() {
            // we cancel the tab cycling
            self.input_field.set_str(&raw);
            self.input_before_cycle = None;
            Command::from_raw(raw, false)
        } else if con.modal && mode == Mode::Input {
            // leave insertion mode
            Command::Internal {
                internal: Internal::mode_command,
                input_invocation: None,
            }
        } else {
            // general back command
            let raw = self.input_field.get_content();
            let parts = CommandParts::from(raw.clone());
            self.input_field.clear();
            let internal = Internal::back;
            Command::Internal {
                internal,
                input_invocation: parts.verb_invocation,
            }
        }
    }

    /// autocomplete a verb (bound to 'tab')
    fn auto_complete_verb(
        &mut self,
        con: &AppContext,
        sel_info: SelInfo<'_>,
        raw: String,
        parts: &CommandParts,
        panel_state_type: Option<PanelStateType>,
        backwards: bool, // backtab
    ) -> Command {
        let parts_before_cycle;
        let completable_parts = if let Some(s) = &self.input_before_cycle {
            parts_before_cycle = CommandParts::from(s.clone());
            &parts_before_cycle
        } else {
            parts
        };
        let completions = Completions::for_input(
            completable_parts,
            con,
            sel_info,
            panel_state_type,
        );
        let added = match completions {
            Completions::None => {
                debug!("nothing to complete!");
                self.tab_cycle_count = None;
                self.input_before_cycle = None;
                None
            }
            Completions::Common(completion) => {
                self.tab_cycle_count = None;
                Some(completion)
            }
            Completions::List(mut completions) => { // completions has a len > 1
                let len = completions.len();
                // self.tab_cycle_count is the next index to use, when going forward
                if self.tab_cycle_count.is_none() {
                    self.input_before_cycle = Some(raw.clone());
                }
                let idx = if backwards {
                    match self.tab_cycle_count {
                        Some(before) => (before + len - 1) % len,
                        None => completions.len() - 1,
                    }
                } else {
                    match self.tab_cycle_count {
                        Some(before) => (before + 1) % len,
                        None => 0,
                    }
                };
                self.tab_cycle_count = Some(idx);
                Some(completions.swap_remove(idx))
            }
        };
        if let Some(added) = added {
            let mut raw = self
                .input_before_cycle
                .as_ref()
                .map_or(raw, ToString::to_string);
            raw.push_str(&added);
            self.input_field.set_str(&raw);
            Command::from_raw(raw, false)
        } else {
            Command::None
        }
    }

    fn find_key_verb<'c>(
        key: KeyCombination,
        panels: &AppPanels,
        app_state: &AppState,
        con: &'c AppContext,
    ) -> Option<&'c Verb> {
        let active_sel_info = panels.state().sel_info(app_state);
        for verb in con.verb_store.verbs() {
            // note that there can be several verbs with the same key and
            // not all of them can apply
            if !verb.keys.contains(&key) {
                continue;
            }
            let Some(panel_state) = panels.state_by_ref(verb.impacted_panel) else {
                continue;
            };
            if !verb.can_be_called_in_panel(panel_state.get_type()) {
                continue;
            }

            let nasi;
            let sel_info = if verb.impacted_panel.is_default() {
                &active_sel_info
            } else {
                nasi = panel_state.sel_info(app_state);
                &nasi
            };

            if !sel_info.is_accepted_by(verb.selection_condition) {
                continue;
            }
            if !verb.file_extensions.is_empty() {
                let extension = sel_info.extension();
                if !extension.is_some_and(|ext| verb.file_extensions.iter().any(|ve| ve == ext)) {
                    continue;
                }
            }
            return Some(verb);
        }
        None
    }

    /// Consume the event, maybe change the input, return a command
    fn on_mouse(
        &mut self,
        timed_event: &TimedEvent,
        kind: MouseEventKind,
        column: u16,
        row: u16,
    ) -> Command {
        if self.input_field.apply_timed_event(timed_event) {
            Command::empty()
        } else {
            match kind {
                MouseEventKind::Up(MouseButton::Left) => {
                    if timed_event.double_click {
                        Command::DoubleClick(column, row)
                    } else {
                        Command::Click(column, row)
                    }
                }
                MouseEventKind::ScrollDown => Command::Internal {
                    internal: Internal::line_down,
                    input_invocation: None,
                },
                MouseEventKind::ScrollUp => Command::Internal {
                    internal: Internal::line_up,
                    input_invocation: None,
                },
                _ => Command::None,
            }
        }
    }

    fn is_key_allowed_for_verb(
        &self,
        key: KeyCombination,
        mode: Mode,
    ) -> bool {
        match mode {
            Mode::Input => match key {
                key!(left) => !self.input_field.can_move_left(),
                key!(right) => !self.input_field.can_move_right(),
                _ => !keys::is_key_only_modal(key),
            },
            Mode::Command => true,
        }
    }

    /// Consume the event, maybe change the input, return a command
    #[allow(clippy::too_many_arguments)]
    fn on_key(
        &mut self,
        timed_event: &TimedEvent,
        key: KeyCombination,
        panels: &AppPanels,
        app_state: &AppState,
        con: &AppContext,
    ) -> Command {
        // value of raw and parts before any key related change
        let raw = self.input_field.get_content();
        let parts = CommandParts::from(raw.clone());

        // The mode we check is the one of the panel holding
        // the input, thus the active panel
        let mode = panels.state().get_mode();
        let verb = if self.is_key_allowed_for_verb(key, mode) {
            Self::find_key_verb(key, panels, app_state, con)
        } else {
            None
        };

        // WARNINGS:
        // - beware the execution order below: we must execute
        // escape before the else clause of next_match, and we must
        // be sure this else clause (which ends cycling) is always
        // executed when neither next_match or escape is triggered
        // - some behaviors can't really be handled as normally
        // triggered internals because of the interactions with
        // the input

        // usually 'esc' key
        if Verb::is_some_internal(verb, Internal::escape) {
            return self.escape(mode, con);
        }

        let mut panel_state = panels.state();
        if let Some(verb) = verb {
            if let Some(ps) = panels.state_by_ref(verb.impacted_panel)
            {
                panel_state = ps;
            }
        }

        let sel_info = panel_state.sel_info(app_state);
        let panel_state_type = panel_state.get_type();

        // 'tab' completion of a verb or one of its arguments
        if Verb::is_some_internal(verb, Internal::next_match) {
            if parts.verb_invocation.is_some() {
                return self.auto_complete_verb(con, sel_info, raw, &parts, Some(panel_state_type), false);
            }
            // if no verb is being edited, the state may handle this internal
            // in a specific way
        } else if Verb::is_some_internal(verb, Internal::previous_match) {
            if parts.verb_invocation.is_some() {
                return self.auto_complete_verb(con, sel_info, raw, &parts, Some(panel_state_type), true);
            }
        } else {
            self.tab_cycle_count = None;
            self.input_before_cycle = None;
        }

        // 'enter': trigger the verb if any on the input. If none, then may be
        // used as trigger of another verb
        if key == key!(enter) && parts.has_not_empty_verb_invocation() {
            return Command::from_parts(parts, true);
        }

        // a '?' opens the help when it's the first char or when it's part
        // of the verb invocation. It may be used as a verb name in other cases
        if (key == key!('?') || key == key!(shift - '?'))
            && (raw.is_empty() || parts.verb_invocation.is_some())
        {
            return Command::Internal {
                internal: Internal::help,
                input_invocation: parts.verb_invocation,
            };
        }

        if let Some(verb) = verb {
            if self.handle_input_related_verb(verb, con) {
                return Command::from_raw(self.input_field.get_content(), false);
            }
            if mode != Mode::Input && verb.is_internal(Internal::mode_input) {
                self.enter_input_mode_with_key(key, &parts);
            }
            if verb.auto_exec {
                return Command::VerbTrigger {
                    verb_id: verb.id,
                    input_invocation: parts.verb_invocation,
                };
            }
            if let Some(invocation_parser) = &verb.invocation_parser {
                let exec_builder = ExecutionBuilder::without_invocation(sel_info, app_state);
                let verb_invocation = exec_builder
                    .invocation_with_default(&invocation_parser.invocation_pattern, con);
                let mut parts = parts;
                parts.verb_invocation = Some(verb_invocation);
                self.set_content(&parts.to_string());
                return Command::VerbEdit(parts.verb_invocation.unwrap());
            }
        }

        // input field management
        if mode == Mode::Input && self.input_field.apply_timed_event(timed_event) {
            return Command::from_raw(self.input_field.get_content(), false);
        }
        Command::None
    }
}