pub enum CmdResult {
Show 13 variants
ApplyOnPanel {
id: PanelId,
},
ClosePanel {
validate_purpose: bool,
panel_ref: PanelReference,
},
DisplayError(String),
ExecuteSequence {
sequence: Sequence,
},
HandleInApp(Internal),
Keep,
Launch(Box<Launchable>),
NewPanel {
state: Box<dyn PanelState>,
purpose: PanelPurpose,
direction: HDir,
},
NewState {
state: Box<dyn PanelState>,
message: Option<&'static str>,
},
PopStateAndReapply,
PopState,
Quit,
RefreshState {
clear_cache: bool,
},
}Expand description
Result of applying a command to a state
Variants§
ApplyOnPanel
ClosePanel
DisplayError(String)
ExecuteSequence
HandleInApp(Internal)
Keep
Launch(Box<Launchable>)
NewPanel
NewState
PopStateAndReapply
PopState
Quit
RefreshState
Implementations§
source§impl CmdResult
impl CmdResult
sourcepub fn verb_not_found(text: &str) -> CmdResult
pub fn verb_not_found(text: &str) -> CmdResult
Examples found in repository?
src/app/panel_state.rs (line 789)
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
self.clear_pending();
let con = &cc.app.con;
let screen = cc.app.screen;
match &cc.cmd {
Command::Click(x, y) => self.on_click(*x, *y, screen, con),
Command::DoubleClick(x, y) => self.on_double_click(*x, *y, screen, con),
Command::PatternEdit { raw, expr } => {
match InputPattern::new(raw.clone(), expr, con) {
Ok(pattern) => self.on_pattern(pattern, app_state, con),
Err(e) => Ok(CmdResult::DisplayError(format!("{}", e))),
}
}
Command::VerbTrigger {
index,
input_invocation,
} => self.execute_verb(
w,
&con.verb_store.verbs[*index],
input_invocation.as_ref(),
TriggerType::Other,
app_state,
cc,
),
Command::Internal {
internal,
input_invocation,
} => self.on_internal(
w,
&InternalExecution::from_internal(*internal),
input_invocation.as_ref(),
TriggerType::Other,
app_state,
cc,
),
Command::VerbInvocate(invocation) => {
let sel_info = self.sel_info(app_state);
match con.verb_store.search_sel_info(
&invocation.name,
sel_info,
) {
PrefixSearchResult::Match(_, verb) => {
self.execute_verb(
w,
verb,
Some(invocation),
TriggerType::Input(verb),
app_state,
cc,
)
}
_ => Ok(CmdResult::verb_not_found(&invocation.name)),
}
}
Command::None | Command::VerbEdit(_) => {
// we do nothing here, the real job is done in get_status
Ok(CmdResult::Keep)
}
}
}sourcepub fn from_optional_state(
os: Result<BrowserState, TreeBuildError>,
message: Option<&'static str>,
in_new_panel: bool
) -> CmdResult
pub fn from_optional_state(
os: Result<BrowserState, TreeBuildError>,
message: Option<&'static str>,
in_new_panel: bool
) -> CmdResult
Examples found in repository?
src/verb/internal_focus.rs (lines 46-50)
39 40 41 42 43 44 45 46 47 48 49 50 51
pub fn new_state_on_path(
path: PathBuf,
screen: Screen,
tree_options: TreeOptions,
con: &AppContext,
) -> CmdResult {
let path = path::closest_dir(&path);
CmdResult::from_optional_state(
BrowserState::new(path, tree_options, screen, con, &Dam::unlimited()),
None,
false,
)
}More examples
src/browser/browser_state.rs (lines 94-98)
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
fn modified(
&self,
screen: Screen,
root: PathBuf,
options: TreeOptions,
message: Option<&'static str>,
in_new_panel: bool,
con: &AppContext,
) -> CmdResult {
let tree = self.displayed_tree();
let mut new_state = BrowserState::new(root, options, screen, con, &Dam::unlimited());
if let Ok(bs) = &mut new_state {
if tree.selection != 0 {
bs.displayed_tree_mut().try_select_path(&tree.selected_line().path);
}
}
CmdResult::from_optional_state(
new_state,
message,
in_new_panel,
)
}
pub fn root(&self) -> &Path {
self.tree.root()
}
pub fn page_height(screen: Screen) -> usize {
screen.height as usize - 2 // br shouldn't be displayed when the screen is smaller
}
/// return a reference to the currently displayed tree, which
/// is the filtered tree if there's one, the base tree if not.
pub fn displayed_tree(&self) -> &Tree {
self.filtered_tree.as_ref().unwrap_or(&self.tree)
}
/// return a mutable reference to the currently displayed tree, which
/// is the filtered tree if there's one, the base tree if not.
pub fn displayed_tree_mut(&mut self) -> &mut Tree {
self.filtered_tree.as_mut().unwrap_or(&mut self.tree)
}
pub fn open_selection_stay_in_broot(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool,
) -> Result<CmdResult, ProgramError> {
let tree = self.displayed_tree();
let line = tree.selected_line();
let mut target = line.target().to_path_buf();
if line.is_dir() {
if tree.selection == 0 {
// opening the root would be going to where we already are.
// We go up one level instead
if let Some(parent) = target.parent() {
target = PathBuf::from(parent);
}
}
let dam = Dam::unlimited();
Ok(CmdResult::from_optional_state(
BrowserState::new(
target,
if keep_pattern {
tree.options.clone()
} else {
tree.options.without_pattern()
},
screen,
con,
&dam,
),
None,
in_new_panel,
))
} else {
match opener::open(&target) {
Ok(exit_status) => {
info!("open returned with exit_status {:?}", exit_status);
Ok(CmdResult::Keep)
}
Err(e) => Ok(CmdResult::error(format!("{:?}", e))),
}
}
}
pub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
) -> CmdResult {
match &self.displayed_tree().selected_line().path.parent() {
Some(path) => CmdResult::from_optional_state(
BrowserState::new(
path.to_path_buf(),
self.displayed_tree().options.without_pattern(),
screen,
con,
&Dam::unlimited(),
),
None,
in_new_panel,
),
None => CmdResult::error("no parent found"),
}
}src/filesystems/filesystems_state.rs (lines 518-528)
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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let screen = cc.app.screen;
let con = &cc.app.con;
use Internal::*;
Ok(match internal_exec.internal {
Internal::back => {
if let Some(f) = self.filtered.take() {
if !f.mounts.is_empty() {
self.selection_idx = self.mounts.iter()
.position(|m| m.info.id == f.mounts[f.selection_idx].info.id)
.unwrap(); // all filtered mounts come from self.mounts
}
CmdResult::Keep
} else {
CmdResult::PopState
}
}
Internal::line_down => {
self.move_line(internal_exec, input_invocation, 1, true)
}
Internal::line_up => {
self.move_line(internal_exec, input_invocation, -1, true)
}
Internal::line_down_no_cycle => {
self.move_line(internal_exec, input_invocation, 1, false)
}
Internal::line_up_no_cycle => {
self.move_line(internal_exec, input_invocation, -1, false)
}
Internal::open_stay => {
let in_new_panel = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
let dam = Dam::unlimited();
let mut tree_options = self.tree_options();
tree_options.show_root_fs = true;
CmdResult::from_optional_state(
BrowserState::new(
self.no_opt_selected_path().to_path_buf(),
tree_options,
screen,
con,
&dam,
),
None,
in_new_panel,
)
}
Internal::panel_left => {
let areas = &cc.panel.areas;
if areas.is_first() && areas.nb_pos < con.max_panels_count {
// we ask for the creation of a panel to the left
internal_focus::new_panel_on_path(
self.no_opt_selected_path().to_path_buf(),
screen,
self.tree_options(),
PanelPurpose::None,
con,
HDir::Left,
)
} else {
// we ask the app to focus the panel to the left
CmdResult::HandleInApp(Internal::panel_left_no_open)
}
}
Internal::panel_left_no_open => CmdResult::HandleInApp(Internal::panel_left_no_open),
Internal::panel_right => {
let areas = &cc.panel.areas;
if areas.is_last() && areas.nb_pos < con.max_panels_count {
// we ask for the creation of a panel to the right
internal_focus::new_panel_on_path(
self.no_opt_selected_path().to_path_buf(),
screen,
self.tree_options(),
PanelPurpose::None,
con,
HDir::Right,
)
} else {
// we ask the app to focus the panel to the right
CmdResult::HandleInApp(Internal::panel_right_no_open)
}
}
Internal::panel_right_no_open => CmdResult::HandleInApp(Internal::panel_right_no_open),
Internal::page_down => {
if !self.try_scroll(ScrollCommand::Pages(1)) {
self.selection_idx = self.count() - 1;
}
CmdResult::Keep
}
Internal::page_up => {
if !self.try_scroll(ScrollCommand::Pages(-1)) {
self.selection_idx = 0;
}
CmdResult::Keep
}
open_leave => CmdResult::PopStateAndReapply,
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
)?,
})
}sourcepub fn new_state(state: Box<dyn PanelState>) -> Self
pub fn new_state(state: Box<dyn PanelState>) -> Self
Examples found in repository?
src/app/panel_state.rs (line 156)
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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
fn on_internal_generic(
&mut self,
_w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
_trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let con = &cc.app.con;
let screen = cc.app.screen;
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
Ok(match internal_exec.internal {
Internal::back => CmdResult::PopState,
Internal::copy_line | Internal::copy_path => {
#[cfg(not(feature = "clipboard"))]
{
CmdResult::error("Clipboard feature not enabled at compilation")
}
#[cfg(feature = "clipboard")]
{
if let Some(path) = self.selected_path() {
let path = path.to_string_lossy().to_string();
match terminal_clipboard::set_string(path) {
Ok(()) => CmdResult::Keep,
Err(_) => CmdResult::error("Clipboard error while copying path"),
}
} else {
CmdResult::error("Nothing to copy")
}
}
}
Internal::close_panel_ok => CmdResult::ClosePanel {
validate_purpose: true,
panel_ref: PanelReference::Active,
},
Internal::close_panel_cancel => CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Active,
},
#[cfg(unix)]
Internal::filesystems => {
let fs_state = crate::filesystems::FilesystemState::new(
self.selected_path(),
self.tree_options(),
con,
);
match fs_state {
Ok(state) => {
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
if bang && cc.app.preview_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(state),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::new_state(Box::new(state))
}
}
Err(e) => CmdResult::DisplayError(format!("{}", e)),
}
}
Internal::help => {
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
if bang && cc.app.preview_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(HelpState::new(self.tree_options(), screen, con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::new_state(Box::new(
HelpState::new(self.tree_options(), screen, con)
))
}
}
Internal::mode_input => self.on_mode_verb(Mode::Input, con),
Internal::mode_command => self.on_mode_verb(Mode::Command, con),
Internal::open_leave => {
if let Some(selection) = self.selection() {
selection.to_opener(con)?
} else {
CmdResult::error("no selection to open")
}
}
Internal::open_preview => self.open_preview(None, false, cc),
Internal::preview_image => self.open_preview(Some(PreviewMode::Image), false, cc),
Internal::preview_text => self.open_preview(Some(PreviewMode::Text), false, cc),
Internal::preview_binary => self.open_preview(Some(PreviewMode::Hex), false, cc),
Internal::toggle_preview => self.open_preview(None, true, cc),
Internal::sort_by_count => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Count {
o.sort = Sort::None;
o.show_counts = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Count;
o.show_counts = true;
"*now sorting by file count*"
}
},
bang,
con,
),
Internal::sort_by_date => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Date {
o.sort = Sort::None;
o.show_dates = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Date;
o.show_dates = true;
"*now sorting by last modified date*"
}
},
bang,
con,
),
Internal::sort_by_size => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Size {
o.sort = Sort::None;
o.show_sizes = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Size;
o.show_sizes = true;
o.show_root_fs = true;
"*now sorting files and directories by total size*"
}
},
bang,
con,
),
Internal::sort_by_type => self.with_new_options(
screen,
&|o| {
match o.sort {
Sort::TypeDirsFirst => {
o.sort = Sort::TypeDirsLast;
"*sorting by type, directories last*"
}
Sort::TypeDirsLast => {
o.sort = Sort::None;
"*not sorting anymore*"
}
_ => {
o.sort = Sort::TypeDirsFirst;
"*sorting by type, directories first*"
}
}
},
bang,
con,
),
Internal::sort_by_type_dirs_first => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::TypeDirsFirst {
o.sort = Sort::None;
"*not sorting anymore*"
} else {
o.sort = Sort::TypeDirsFirst;
"*now sorting by type, directories first*"
}
},
bang,
con,
),
Internal::sort_by_type_dirs_last => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::TypeDirsLast {
o.sort = Sort::None;
"*not sorting anymore*"
} else {
o.sort = Sort::TypeDirsLast;
"*now sorting by type, directories last*"
}
},
bang,
con,
),
Internal::no_sort => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::None {
"*still not searching*"
} else {
o.sort = Sort::None;
"*not sorting anymore*"
}
},
bang,
con,
),
Internal::toggle_counts => {
self.with_new_options(
screen,
&|o| {
o.show_counts ^= true;
if o.show_counts {
"*displaying file counts*"
} else {
"*hiding file counts*"
}
},
bang,
con,
)
}
Internal::toggle_dates => {
self.with_new_options(
screen,
&|o| {
o.show_dates ^= true;
if o.show_dates {
"*displaying last modified dates*"
} else {
"*hiding last modified dates*"
}
},
bang,
con,
)
}
Internal::toggle_device_id => {
self.with_new_options(
screen,
&|o| {
o.show_device_id ^= true;
if o.show_device_id {
"*displaying device id*"
} else {
"*hiding device id*"
}
},
bang,
con,
)
}
Internal::toggle_files => {
self.with_new_options(
screen,
&|o| {
o.only_folders ^= true;
if o.only_folders {
"*displaying only directories*"
} else {
"*displaying both files and directories*"
}
},
bang,
con,
)
}
Internal::toggle_hidden => {
self.with_new_options(
screen,
&|o| {
o.show_hidden ^= true;
if o.show_hidden {
"h:**y** - *Hidden files displayed*"
} else {
"h:**n** - *Hidden files not displayed*"
}
},
bang,
con,
)
}
Internal::toggle_root_fs => {
self.with_new_options(
screen,
&|o| {
o.show_root_fs ^= true;
if o.show_root_fs {
"*displaying filesystem info for the tree's root directory*"
} else {
"*removing filesystem info*"
}
},
bang,
con,
)
}
Internal::toggle_git_ignore => {
self.with_new_options(
screen,
&|o| {
o.respect_git_ignore ^= true;
if o.respect_git_ignore {
"gi:**y** - *applying gitignore rules*"
} else {
"gi:**n** - *not applying gitignore rules*"
}
},
bang,
con,
)
}
Internal::toggle_git_file_info => {
self.with_new_options(
screen,
&|o| {
o.show_git_file_info ^= true;
if o.show_git_file_info {
"*displaying git info next to files*"
} else {
"*removing git file info*"
}
},
bang,
con,
)
}
Internal::toggle_git_status => {
self.with_new_options(
screen, &|o| {
if o.filter_by_git_status {
o.filter_by_git_status = false;
"*not filtering according to git status anymore*"
} else {
o.filter_by_git_status = true;
o.show_hidden = true;
"*only displaying new or modified files*"
}
}, bang, con
)
}
Internal::toggle_perm => {
self.with_new_options(
screen,
&|o| {
o.show_permissions ^= true;
if o.show_permissions {
"*displaying file permissions*"
} else {
"*removing file permissions*"
}
},
bang,
con,
)
}
Internal::toggle_sizes => self.with_new_options(
screen,
&|o| {
if o.show_sizes {
o.show_sizes = false;
o.show_root_fs = false;
"*removing sizes of files and directories*"
} else {
o.show_sizes = true;
o.show_root_fs = true;
"*now diplaying sizes of files and directories*"
}
},
bang,
con,
),
Internal::toggle_trim_root => {
self.with_new_options(
screen,
&|o| {
o.trim_root ^= true;
if o.trim_root {
"*now trimming root from excess files*"
} else {
"*not trimming root files anymore*"
}
},
bang,
con,
)
}
Internal::close_preview => {
if let Some(id) = cc.app.preview_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::Keep
}
}
Internal::panel_left | Internal::panel_left_no_open => {
CmdResult::HandleInApp(Internal::panel_left_no_open)
}
Internal::panel_right | Internal::panel_right_no_open => {
CmdResult::HandleInApp(Internal::panel_right_no_open)
}
Internal::toggle_second_tree => {
CmdResult::HandleInApp(Internal::toggle_second_tree)
}
Internal::clear_stage => {
app_state.stage.clear();
if let Some(panel_id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(panel_id),
}
} else {
CmdResult::Keep
}
}
Internal::stage => self.stage(app_state, cc, con),
Internal::unstage => self.unstage(app_state, cc, con),
Internal::toggle_stage => self.toggle_stage(app_state, cc, con),
Internal::close_staging_area => {
if let Some(id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::Keep
}
}
Internal::open_staging_area => {
if cc.app.stage_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, self.tree_options(), con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::Keep
}
}
Internal::toggle_staging_area => {
if let Some(id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, self.tree_options(), con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
}
}
Internal::set_syntax_theme => CmdResult::HandleInApp(Internal::set_syntax_theme),
Internal::print_path => print::print_paths(self.sel_info(app_state), con)?,
Internal::print_relative_path => print::print_relative_paths(self.sel_info(app_state), con)?,
Internal::refresh => CmdResult::RefreshState { clear_cache: true },
Internal::quit => CmdResult::Quit,
_ => CmdResult::Keep,
})
}sourcepub fn error<S: Into<String>>(message: S) -> Self
pub fn error<S: Into<String>>(message: S) -> Self
Examples found in repository?
src/app/panel_state.rs (line 73)
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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
fn on_mode_verb(
&mut self,
mode: Mode,
con: &AppContext,
) -> CmdResult {
if con.modal {
self.set_mode(mode);
CmdResult::Keep
} else {
CmdResult::error("modal mode not enabled in configuration")
}
}
/// execute the internal with the optional given invocation.
///
/// The invocation comes from the input and may be related
/// to a different verb (the verb may have been triggered
/// by a key shortcut)
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError>;
/// a generic implementation of on_internal which may be
/// called by states when they don't have a specific
/// behavior to execute
fn on_internal_generic(
&mut self,
_w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
_trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let con = &cc.app.con;
let screen = cc.app.screen;
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
Ok(match internal_exec.internal {
Internal::back => CmdResult::PopState,
Internal::copy_line | Internal::copy_path => {
#[cfg(not(feature = "clipboard"))]
{
CmdResult::error("Clipboard feature not enabled at compilation")
}
#[cfg(feature = "clipboard")]
{
if let Some(path) = self.selected_path() {
let path = path.to_string_lossy().to_string();
match terminal_clipboard::set_string(path) {
Ok(()) => CmdResult::Keep,
Err(_) => CmdResult::error("Clipboard error while copying path"),
}
} else {
CmdResult::error("Nothing to copy")
}
}
}
Internal::close_panel_ok => CmdResult::ClosePanel {
validate_purpose: true,
panel_ref: PanelReference::Active,
},
Internal::close_panel_cancel => CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Active,
},
#[cfg(unix)]
Internal::filesystems => {
let fs_state = crate::filesystems::FilesystemState::new(
self.selected_path(),
self.tree_options(),
con,
);
match fs_state {
Ok(state) => {
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
if bang && cc.app.preview_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(state),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::new_state(Box::new(state))
}
}
Err(e) => CmdResult::DisplayError(format!("{}", e)),
}
}
Internal::help => {
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
if bang && cc.app.preview_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(HelpState::new(self.tree_options(), screen, con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::new_state(Box::new(
HelpState::new(self.tree_options(), screen, con)
))
}
}
Internal::mode_input => self.on_mode_verb(Mode::Input, con),
Internal::mode_command => self.on_mode_verb(Mode::Command, con),
Internal::open_leave => {
if let Some(selection) = self.selection() {
selection.to_opener(con)?
} else {
CmdResult::error("no selection to open")
}
}
Internal::open_preview => self.open_preview(None, false, cc),
Internal::preview_image => self.open_preview(Some(PreviewMode::Image), false, cc),
Internal::preview_text => self.open_preview(Some(PreviewMode::Text), false, cc),
Internal::preview_binary => self.open_preview(Some(PreviewMode::Hex), false, cc),
Internal::toggle_preview => self.open_preview(None, true, cc),
Internal::sort_by_count => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Count {
o.sort = Sort::None;
o.show_counts = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Count;
o.show_counts = true;
"*now sorting by file count*"
}
},
bang,
con,
),
Internal::sort_by_date => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Date {
o.sort = Sort::None;
o.show_dates = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Date;
o.show_dates = true;
"*now sorting by last modified date*"
}
},
bang,
con,
),
Internal::sort_by_size => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::Size {
o.sort = Sort::None;
o.show_sizes = false;
"*not sorting anymore*"
} else {
o.sort = Sort::Size;
o.show_sizes = true;
o.show_root_fs = true;
"*now sorting files and directories by total size*"
}
},
bang,
con,
),
Internal::sort_by_type => self.with_new_options(
screen,
&|o| {
match o.sort {
Sort::TypeDirsFirst => {
o.sort = Sort::TypeDirsLast;
"*sorting by type, directories last*"
}
Sort::TypeDirsLast => {
o.sort = Sort::None;
"*not sorting anymore*"
}
_ => {
o.sort = Sort::TypeDirsFirst;
"*sorting by type, directories first*"
}
}
},
bang,
con,
),
Internal::sort_by_type_dirs_first => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::TypeDirsFirst {
o.sort = Sort::None;
"*not sorting anymore*"
} else {
o.sort = Sort::TypeDirsFirst;
"*now sorting by type, directories first*"
}
},
bang,
con,
),
Internal::sort_by_type_dirs_last => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::TypeDirsLast {
o.sort = Sort::None;
"*not sorting anymore*"
} else {
o.sort = Sort::TypeDirsLast;
"*now sorting by type, directories last*"
}
},
bang,
con,
),
Internal::no_sort => self.with_new_options(
screen,
&|o| {
if o.sort == Sort::None {
"*still not searching*"
} else {
o.sort = Sort::None;
"*not sorting anymore*"
}
},
bang,
con,
),
Internal::toggle_counts => {
self.with_new_options(
screen,
&|o| {
o.show_counts ^= true;
if o.show_counts {
"*displaying file counts*"
} else {
"*hiding file counts*"
}
},
bang,
con,
)
}
Internal::toggle_dates => {
self.with_new_options(
screen,
&|o| {
o.show_dates ^= true;
if o.show_dates {
"*displaying last modified dates*"
} else {
"*hiding last modified dates*"
}
},
bang,
con,
)
}
Internal::toggle_device_id => {
self.with_new_options(
screen,
&|o| {
o.show_device_id ^= true;
if o.show_device_id {
"*displaying device id*"
} else {
"*hiding device id*"
}
},
bang,
con,
)
}
Internal::toggle_files => {
self.with_new_options(
screen,
&|o| {
o.only_folders ^= true;
if o.only_folders {
"*displaying only directories*"
} else {
"*displaying both files and directories*"
}
},
bang,
con,
)
}
Internal::toggle_hidden => {
self.with_new_options(
screen,
&|o| {
o.show_hidden ^= true;
if o.show_hidden {
"h:**y** - *Hidden files displayed*"
} else {
"h:**n** - *Hidden files not displayed*"
}
},
bang,
con,
)
}
Internal::toggle_root_fs => {
self.with_new_options(
screen,
&|o| {
o.show_root_fs ^= true;
if o.show_root_fs {
"*displaying filesystem info for the tree's root directory*"
} else {
"*removing filesystem info*"
}
},
bang,
con,
)
}
Internal::toggle_git_ignore => {
self.with_new_options(
screen,
&|o| {
o.respect_git_ignore ^= true;
if o.respect_git_ignore {
"gi:**y** - *applying gitignore rules*"
} else {
"gi:**n** - *not applying gitignore rules*"
}
},
bang,
con,
)
}
Internal::toggle_git_file_info => {
self.with_new_options(
screen,
&|o| {
o.show_git_file_info ^= true;
if o.show_git_file_info {
"*displaying git info next to files*"
} else {
"*removing git file info*"
}
},
bang,
con,
)
}
Internal::toggle_git_status => {
self.with_new_options(
screen, &|o| {
if o.filter_by_git_status {
o.filter_by_git_status = false;
"*not filtering according to git status anymore*"
} else {
o.filter_by_git_status = true;
o.show_hidden = true;
"*only displaying new or modified files*"
}
}, bang, con
)
}
Internal::toggle_perm => {
self.with_new_options(
screen,
&|o| {
o.show_permissions ^= true;
if o.show_permissions {
"*displaying file permissions*"
} else {
"*removing file permissions*"
}
},
bang,
con,
)
}
Internal::toggle_sizes => self.with_new_options(
screen,
&|o| {
if o.show_sizes {
o.show_sizes = false;
o.show_root_fs = false;
"*removing sizes of files and directories*"
} else {
o.show_sizes = true;
o.show_root_fs = true;
"*now diplaying sizes of files and directories*"
}
},
bang,
con,
),
Internal::toggle_trim_root => {
self.with_new_options(
screen,
&|o| {
o.trim_root ^= true;
if o.trim_root {
"*now trimming root from excess files*"
} else {
"*not trimming root files anymore*"
}
},
bang,
con,
)
}
Internal::close_preview => {
if let Some(id) = cc.app.preview_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::Keep
}
}
Internal::panel_left | Internal::panel_left_no_open => {
CmdResult::HandleInApp(Internal::panel_left_no_open)
}
Internal::panel_right | Internal::panel_right_no_open => {
CmdResult::HandleInApp(Internal::panel_right_no_open)
}
Internal::toggle_second_tree => {
CmdResult::HandleInApp(Internal::toggle_second_tree)
}
Internal::clear_stage => {
app_state.stage.clear();
if let Some(panel_id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(panel_id),
}
} else {
CmdResult::Keep
}
}
Internal::stage => self.stage(app_state, cc, con),
Internal::unstage => self.unstage(app_state, cc, con),
Internal::toggle_stage => self.toggle_stage(app_state, cc, con),
Internal::close_staging_area => {
if let Some(id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::Keep
}
}
Internal::open_staging_area => {
if cc.app.stage_panel.is_none() {
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, self.tree_options(), con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::Keep
}
}
Internal::toggle_staging_area => {
if let Some(id) = cc.app.stage_panel {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, self.tree_options(), con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
}
}
Internal::set_syntax_theme => CmdResult::HandleInApp(Internal::set_syntax_theme),
Internal::print_path => print::print_paths(self.sel_info(app_state), con)?,
Internal::print_relative_path => print::print_relative_paths(self.sel_info(app_state), con)?,
Internal::refresh => CmdResult::RefreshState { clear_cache: true },
Internal::quit => CmdResult::Quit,
_ => CmdResult::Keep,
})
}
fn stage(
&self,
app_state: &mut AppState,
cc: &CmdContext,
con: &AppContext,
) -> CmdResult {
if let Some(path) = self.selected_path() {
let path = path.to_path_buf();
app_state.stage.add(path);
if cc.app.stage_panel.is_none() {
return CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, self.tree_options(), con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
};
}
} else {
// TODO display error ?
warn!("no path in state");
}
CmdResult::Keep
}
fn unstage(
&self,
app_state: &mut AppState,
cc: &CmdContext,
_con: &AppContext,
) -> CmdResult {
if let Some(path) = self.selected_path() {
if app_state.stage.remove(path) && app_state.stage.is_empty() {
if let Some(panel_id) = cc.app.stage_panel {
return CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(panel_id),
};
}
}
}
CmdResult::Keep
}
fn toggle_stage(
&self,
app_state: &mut AppState,
cc: &CmdContext,
con: &AppContext,
) -> CmdResult {
if let Some(path) = self.selected_path() {
if app_state.stage.contains(path) {
self.unstage(app_state, cc, con)
} else {
self.stage(app_state, cc, con)
}
} else {
CmdResult::error("no selection")
}
}
fn execute_verb(
&mut self,
w: &mut W, // needed because we may want to switch from alternate in some externals
verb: &Verb,
invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
if verb.needs_selection && !self.has_at_least_one_selection(app_state) {
return Ok(CmdResult::error("This verb needs a selection"));
}
if verb.needs_another_panel && app_state.other_panel_path.is_none() {
return Ok(CmdResult::error("This verb needs another panel"));
}
let res = match &verb.execution {
VerbExecution::Internal(internal_exec) => {
self.on_internal(
w,
internal_exec,
invocation,
trigger_type,
app_state,
cc,
)
}
VerbExecution::External(external) => {
self.execute_external(w, verb, external, invocation, app_state, cc)
}
VerbExecution::Sequence(seq_ex) => {
self.execute_sequence(w, verb, seq_ex, invocation, app_state, cc)
}
};
if res.is_ok() {
// if the stage has been emptied by the operation (eg a "rm"), we
// close it
app_state.stage.refresh();
if app_state.stage.is_empty() {
if let Some(id) = cc.app.stage_panel {
return Ok(CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
});
}
}
}
res
}
fn execute_external(
&mut self,
w: &mut W,
verb: &Verb,
external_execution: &ExternalExecution,
invocation: Option<&VerbInvocation>,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let sel_info = self.sel_info(app_state);
if let Some(invocation) = &invocation {
if let Some(error) = verb.check_args(sel_info, invocation, &app_state.other_panel_path) {
debug!("verb.check_args prevented execution: {:?}", &error);
return Ok(CmdResult::error(error));
}
}
let exec_builder = ExecutionStringBuilder::with_invocation(
&verb.invocation_parser,
sel_info,
app_state,
if let Some(inv) = invocation {
inv.args.as_ref()
} else {
None
},
);
external_execution.to_cmd_result(w, exec_builder, cc.app.con)
}
fn execute_sequence(
&mut self,
_w: &mut W,
verb: &Verb,
seq_ex: &SequenceExecution,
invocation: Option<&VerbInvocation>,
app_state: &mut AppState,
_cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let sel_info = self.sel_info(app_state);
if matches!(sel_info, SelInfo::More(_)) {
// sequences would be hard to execute as the execution on a file can change the
// state in too many ways (changing selection, focused panel, parent, unstage or
// stage files, removing the staged paths, etc.)
return Ok(CmdResult::error("sequences can't be executed on multiple selections"));
}
let exec_builder = ExecutionStringBuilder::with_invocation(
&verb.invocation_parser,
sel_info,
app_state,
if let Some(inv) = invocation {
inv.args.as_ref()
} else {
None
},
);
// TODO what follows is dangerous: if an inserted group value contains the separator,
// the parsing will cut on this separator
let sequence = Sequence {
raw: exec_builder.shell_exec_string(&ExecPattern::from_string(&seq_ex.sequence.raw)),
separator: seq_ex.sequence.separator.clone(),
};
Ok(CmdResult::ExecuteSequence { sequence })
}
/// change the state, does no rendering
fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
self.clear_pending();
let con = &cc.app.con;
let screen = cc.app.screen;
match &cc.cmd {
Command::Click(x, y) => self.on_click(*x, *y, screen, con),
Command::DoubleClick(x, y) => self.on_double_click(*x, *y, screen, con),
Command::PatternEdit { raw, expr } => {
match InputPattern::new(raw.clone(), expr, con) {
Ok(pattern) => self.on_pattern(pattern, app_state, con),
Err(e) => Ok(CmdResult::DisplayError(format!("{}", e))),
}
}
Command::VerbTrigger {
index,
input_invocation,
} => self.execute_verb(
w,
&con.verb_store.verbs[*index],
input_invocation.as_ref(),
TriggerType::Other,
app_state,
cc,
),
Command::Internal {
internal,
input_invocation,
} => self.on_internal(
w,
&InternalExecution::from_internal(*internal),
input_invocation.as_ref(),
TriggerType::Other,
app_state,
cc,
),
Command::VerbInvocate(invocation) => {
let sel_info = self.sel_info(app_state);
match con.verb_store.search_sel_info(
&invocation.name,
sel_info,
) {
PrefixSearchResult::Match(_, verb) => {
self.execute_verb(
w,
verb,
Some(invocation),
TriggerType::Input(verb),
app_state,
cc,
)
}
_ => Ok(CmdResult::verb_not_found(&invocation.name)),
}
}
Command::None | Command::VerbEdit(_) => {
// we do nothing here, the real job is done in get_status
Ok(CmdResult::Keep)
}
}
}
/// return a cmdresult asking for the opening of a preview
fn open_preview(
&mut self,
prefered_mode: Option<PreviewMode>,
close_if_open: bool,
cc: &CmdContext,
) -> CmdResult {
if let Some(id) = cc.app.preview_panel {
if close_if_open {
CmdResult::ClosePanel {
validate_purpose: false,
panel_ref: PanelReference::Id(id),
}
} else {
if prefered_mode.is_some() {
// we'll make the preview mode change be
// applied on the preview panel
CmdResult::ApplyOnPanel { id }
} else {
CmdResult::Keep
}
}
} else {
if let Some(path) = self.selected_path() {
if path.is_file() {
CmdResult::NewPanel {
state: Box::new(PreviewState::new(
path.to_path_buf(),
InputPattern::none(),
prefered_mode,
self.tree_options(),
cc.app.con,
)),
purpose: PanelPurpose::Preview,
direction: HDir::Right,
}
} else {
CmdResult::error("only regular files can be previewed")
}
} else {
CmdResult::error("no selected file")
}
}
}More examples
src/preview/preview_state.rs (line 139)
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
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if pat.is_none() {
if let Some(filtered_preview) = self.filtered_preview.take() {
let old_selection = filtered_preview.get_selected_line_number();
if let Some(number) = old_selection {
self.preview.try_select_line_number(number);
}
self.removed_pattern = filtered_preview.pattern();
}
} else {
if !self.preview.is_filterable() {
return Ok(CmdResult::error("this preview can't be searched"));
}
}
self.pending_pattern = pat;
Ok(CmdResult::Keep)
}
/// do the preview filtering if required and not yet done
fn do_pending_task(
&mut self,
_app_state: &mut AppState,
_screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
if self.pending_pattern.is_some() {
let old_selection = self
.filtered_preview
.as_ref()
.and_then(|p| p.get_selected_line_number())
.or_else(|| self.preview.get_selected_line_number());
let pattern = self.pending_pattern.take();
self.filtered_preview = time!(
Info,
"preview filtering",
self.preview.filtered(&self.path, pattern, dam, con),
); // can be None if a cancellation was required
if let Some(ref mut filtered_preview) = self.filtered_preview {
if let Some(number) = old_selection {
filtered_preview.try_select_line_number(number);
}
}
}
Ok(())
}
fn selected_path(&self) -> Option<&Path> {
Some(&self.path)
}
fn set_selected_path(&mut self, path: PathBuf, con: &AppContext) {
let selected_line_number = if self.path == path {
self.preview.get_selected_line_number()
} else {
None
};
if let Some(fp) = &self.filtered_preview {
self.pending_pattern = fp.pattern();
};
self.preview = Preview::new(&path, self.prefered_mode, con);
if let Some(number) = selected_line_number {
self.preview.try_select_line_number(number);
}
self.path = path;
}
fn selection(&self) -> Option<Selection<'_>> {
Some(self.no_opt_selection())
}
fn tree_options(&self) -> TreeOptions {
self.tree_options.clone()
}
fn with_new_options(
&mut self,
_screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
_in_new_panel: bool, // TODO open tree if true
_con: &AppContext,
) -> CmdResult {
change_options(&mut self.tree_options);
CmdResult::Keep
}
fn refresh(&mut self, _screen: Screen, con: &AppContext) -> Command {
self.dirty = true;
self.set_selected_path(self.path.clone(), con);
Command::empty()
}
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if y >= self.preview_area.top && y < self.preview_area.top + self.preview_area.height {
let y = y - self.preview_area.top;
self.mut_preview().try_select_y(y);
}
Ok(CmdResult::Keep)
}
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
let state_area = &disc.state_area;
if state_area.height < 3 {
warn!("area too small for preview");
return Ok(());
}
let mut preview_area = state_area.clone();
preview_area.height -= 1;
preview_area.top += 1;
if preview_area != self.preview_area {
self.dirty = true;
self.preview_area = preview_area;
}
if self.dirty {
disc.panel_skin.styles.default.queue_bg(w)?;
disc.screen.clear_area_to_right(w, state_area)?;
self.dirty = false;
}
let styles = &disc.panel_skin.styles;
w.queue(cursor::MoveTo(state_area.left, 0))?;
let mut cw = CropWriter::new(w, state_area.width as usize);
let file_name = self
.path
.file_name()
.map(|n| n.to_string_lossy().to_string())
.unwrap_or_else(|| "???".to_string());
cw.queue_str(&styles.preview_title, &file_name)?;
let info_area = Area::new(
state_area.left + state_area.width - cw.allowed as u16,
state_area.top,
cw.allowed as u16,
1,
);
cw.fill(&styles.preview_title, &SPACE_FILLING)?;
let preview = self.filtered_preview.as_mut().unwrap_or(&mut self.preview);
preview.display_info(w, disc.screen, disc.panel_skin, &info_area)?;
if let Err(err) = preview.display(w, disc, &self.preview_area) {
warn!("error while displaying file: {:?}", &err);
if preview.get_mode().is_some() {
// means it's not an error already
if let ProgramError::Io { source } = err {
// we mutate the preview to Preview::IOError
self.preview = Preview::IoError(source);
return self.display(w, disc);
}
}
return Err(err);
}
Ok(())
}
fn no_verb_status(
&self,
has_previous_state: bool,
con: &AppContext,
) -> Status {
let mut ssb = con.standard_status.builder(
PanelStateType::Preview,
self.no_opt_selection(),
);
ssb.has_previous_state = has_previous_state;
ssb.is_filtered = self.filtered_preview.is_some();
ssb.has_removed_pattern = self.removed_pattern.is_some();
ssb.status()
}
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let con = &cc.app.con;
match internal_exec.internal {
Internal::back => {
if self.filtered_preview.is_some() {
self.on_pattern(InputPattern::none(), app_state, con)
} else {
Ok(CmdResult::PopState)
}
}
Internal::copy_line => {
#[cfg(not(feature = "clipboard"))]
{
Ok(CmdResult::error("Clipboard feature not enabled at compilation"))
}
#[cfg(feature = "clipboard")]
{
Ok(match self.mut_preview().get_selected_line() {
Some(line) => {
match terminal_clipboard::set_string(line) {
Ok(()) => CmdResult::Keep,
Err(_) => CmdResult::error("Clipboard error while copying path"),
}
}
None => CmdResult::error("No selected line in preview"),
})
}
}
Internal::line_down => {
let count = get_arg(input_invocation, internal_exec, 1);
self.mut_preview().move_selection(count, true);
Ok(CmdResult::Keep)
}
Internal::line_up => {
let count = get_arg(input_invocation, internal_exec, 1);
self.mut_preview().move_selection(-count, true);
Ok(CmdResult::Keep)
}
Internal::line_down_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.mut_preview().move_selection(count, false);
Ok(CmdResult::Keep)
}
Internal::line_up_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.mut_preview().move_selection(-count, false);
Ok(CmdResult::Keep)
}
Internal::page_down => {
self.mut_preview().try_scroll(ScrollCommand::Pages(1));
Ok(CmdResult::Keep)
}
Internal::page_up => {
self.mut_preview().try_scroll(ScrollCommand::Pages(-1));
Ok(CmdResult::Keep)
}
//Internal::restore_pattern => {
// debug!("restore_pattern");
// self.pending_pattern = self.removed_pattern.take();
// Ok(CmdResult::Keep)
//}
Internal::panel_left if self.removed_pattern.is_some() => {
self.pending_pattern = self.removed_pattern.take();
Ok(CmdResult::Keep)
}
Internal::panel_left_no_open if self.removed_pattern.is_some() => {
self.pending_pattern = self.removed_pattern.take();
Ok(CmdResult::Keep)
}
Internal::panel_right if self.filtered_preview.is_some() => {
self.on_pattern(InputPattern::none(), app_state, con)
}
Internal::panel_right_no_open if self.filtered_preview.is_some() => {
self.on_pattern(InputPattern::none(), app_state, con)
}
Internal::select_first => {
self.mut_preview().select_first();
Ok(CmdResult::Keep)
}
Internal::select_last => {
self.mut_preview().select_last();
Ok(CmdResult::Keep)
}
Internal::preview_image => self.set_mode(PreviewMode::Image, con),
Internal::preview_text => self.set_mode(PreviewMode::Text, con),
Internal::preview_binary => self.set_mode(PreviewMode::Hex, con),
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
),
}
}src/app/cmd_result.rs (line 88)
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
pub fn from_optional_state(
os: Result<BrowserState, TreeBuildError>,
message: Option<&'static str>,
in_new_panel: bool,
) -> CmdResult {
match os {
Ok(os) => {
if in_new_panel {
CmdResult::NewPanel { // TODO keep the message ?
state: Box::new(os),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::NewState {
state: Box::new(os),
message,
}
}
}
Err(TreeBuildError::Interrupted) => CmdResult::Keep,
Err(e) => CmdResult::error(e.to_string()),
}
}src/stage/stage_state.rs (line 248)
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
fn with_new_options(
&mut self,
_screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext,
) -> CmdResult {
if in_new_panel {
CmdResult::error("stage can't be displayed in two panels")
} else {
let mut new_options= self.tree_options();
let message = change_options(&mut new_options);
let state = Box::new(StageState {
filtered_stage: self.filtered_stage.clone(),
scroll: self.scroll,
mode: initial_mode(con),
tree_options: new_options,
page_height: self.page_height,
stage_sum: self.stage_sum,
});
CmdResult::NewState { state, message: Some(message) }
}
}
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if y > 0 {
// the list starts on the second row
self.filtered_stage.try_select_idx(y as usize - 1 + self.scroll);
}
Ok(CmdResult::Keep)
}
fn on_pattern(
&mut self,
pat: InputPattern,
app_state: &AppState,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
self.filtered_stage.set_pattern(&app_state.stage, pat);
self.fix_scroll();
Ok(CmdResult::Keep)
}
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
let stage = &disc.app_state.stage;
self.stage_sum.see_stage(stage); // this may invalidate the sum
if self.filtered_stage.update(stage) {
self.fix_scroll();
}
let area = &disc.state_area;
let styles = &disc.panel_skin.styles;
let width = area.width as usize;
w.queue(cursor::MoveTo(area.left, 0))?;
let mut cw = CropWriter::new(w, width);
self.write_title_line(stage, &mut cw, styles)?;
let list_area = Area::new(area.left, area.top + 1, area.width, area.height - 1);
self.page_height = list_area.height as usize;
let pattern = &self.filtered_stage.pattern().pattern;
let pattern_object = pattern.object();
let scrollbar = list_area.scrollbar(self.scroll, self.filtered_stage.len());
for idx in 0..self.page_height {
let y = list_area.top + idx as u16;
let stage_idx = idx + self.scroll;
w.queue(cursor::MoveTo(area.left, y))?;
let mut cw = CropWriter::new(w, width - 1);
let cw = &mut cw;
if let Some((path, selected)) = self.filtered_stage.path_sel(stage, stage_idx) {
let mut style = if path.is_dir() {
&styles.directory
} else {
&styles.file
};
let mut bg_style;
if selected {
bg_style = style.clone();
if let Some(c) = styles.selected_line.get_bg() {
bg_style.set_bg(c);
}
style = &bg_style;
}
let mut bg_style_match;
let mut style_match = &styles.char_match;
if selected {
bg_style_match = style_match.clone();
if let Some(c) = styles.selected_line.get_bg() {
bg_style_match.set_bg(c);
}
style_match = &bg_style_match;
}
if disc.con.show_selection_mark && self.filtered_stage.has_selection() {
cw.queue_char(style, if selected { '▶' } else { ' ' })?;
}
if pattern_object.subpath {
let label = path.to_string_lossy();
// we must display the matching on the whole path
// (subpath is the path for the staging area)
let name_match = pattern.search_string(&label);
let matched_string = MatchedString::new(
name_match,
&label,
style,
style_match,
);
matched_string.queue_on(cw)?;
} else if let Some(file_name) = path.file_name() {
let label = file_name.to_string_lossy();
let label_cols = label.width();
if label_cols + 2 < cw.allowed {
if let Some(parent_path) = path.parent() {
let mut parent_style = &styles.parent;
let mut bg_style;
if selected {
bg_style = parent_style.clone();
if let Some(c) = styles.selected_line.get_bg() {
bg_style.set_bg(c);
}
parent_style = &bg_style;
}
let cols_max = cw.allowed - label_cols - 3;
let parent_path = parent_path.to_string_lossy();
let parent_cols = parent_path.width();
if parent_cols <= cols_max {
cw.queue_str(
parent_style,
&parent_path,
)?;
} else {
// TODO move to (crop_writer ? termimad ?)
// we'll compute the size of the tail fitting
// the width minus one (for the ellipsis)
let mut bytes_count = 0;
let mut cols_count = 0;
for c in parent_path.chars().rev() {
let char_width = UnicodeWidthChar::width(c).unwrap_or(0);
let next_str_width = cols_count + char_width;
if next_str_width > cols_max {
break;
}
cols_count = next_str_width;
bytes_count += c.len_utf8();
}
cw.queue_char(
parent_style,
ELLIPSIS,
)?;
cw.queue_str(
parent_style,
&parent_path[parent_path.len()-bytes_count..],
)?;
}
cw.queue_char(
parent_style,
'/',
)?;
}
}
let name_match = pattern.search_string(&label);
let matched_string = MatchedString::new(
name_match,
&label,
style,
style_match,
);
matched_string.queue_on(cw)?;
} else {
// this should not happen
warn!("how did we fall on a path without filename?");
}
cw.fill(style, &SPACE_FILLING)?;
}
cw.fill(&styles.default, &SPACE_FILLING)?;
let scrollbar_style = if ScrollCommand::is_thumb(y, scrollbar) {
&styles.scrollbar_thumb
} else {
&styles.scrollbar_track
};
scrollbar_style.queue_str(w, "▐")?;
}
Ok(())
}
fn refresh(&mut self, _screen: Screen, _con: &AppContext) -> Command {
Command::empty()
}
fn set_mode(&mut self, mode: Mode) {
self.mode = mode;
}
fn get_mode(&self) -> Mode {
self.mode
}
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
Ok(match internal_exec.internal {
Internal::back if self.filtered_stage.pattern().is_some() => {
self.filtered_stage = FilteredStage::unfiltered(&app_state.stage);
CmdResult::Keep
}
Internal::back if self.filtered_stage.has_selection() => {
self.filtered_stage.unselect();
CmdResult::Keep
}
Internal::line_down => {
let count = get_arg(input_invocation, internal_exec, 1);
self.move_selection(count, true)
}
Internal::line_up => {
let count = get_arg(input_invocation, internal_exec, 1);
self.move_selection(-count, true)
}
Internal::line_down_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.move_selection(count, false)
}
Internal::line_up_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.move_selection(-count, false)
}
Internal::page_down => {
self.try_scroll(ScrollCommand::Pages(1));
CmdResult::Keep
}
Internal::page_up => {
self.try_scroll(ScrollCommand::Pages(-1));
CmdResult::Keep
}
Internal::stage => {
// shall we restage what we just unstaged ?
CmdResult::error("nothing to stage here")
}
Internal::unstage | Internal::toggle_stage => {
if self.filtered_stage.unstage_selection(&mut app_state.stage) {
CmdResult::Keep
} else {
CmdResult::error("you must select a path to unstage")
}
}
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
)?,
})
}src/verb/external_execution.rs (lines 109-111)
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
fn cmd_result_exec_from_parent_shell(
&self,
builder: ExecutionStringBuilder<'_>,
con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if builder.sel_info.count_paths() > 1 {
return Ok(CmdResult::error(
"only verbs returning to broot on end can be executed on a multi-selection"
));
}
if let Some(ref export_path) = con.launch_args.outcmd {
// Broot was probably launched as br.
// the whole command is exported in the passed file
let f = OpenOptions::new().append(true).open(export_path)?;
writeln!(&f, "{}", builder.shell_exec_string(&self.exec_pattern))?;
Ok(CmdResult::Quit)
} else {
Ok(CmdResult::error(
"this verb needs broot to be launched as `br`. Try `broot --install` if necessary."
))
}
}
/// build the cmd result as an executable which will be called in a process
/// launched by broot at end of broot
fn cmd_result_exec_leave_broot(
&self,
builder: ExecutionStringBuilder<'_>,
con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if builder.sel_info.count_paths() > 1 {
return Ok(CmdResult::error(
"only verbs returning to broot on end can be executed on a multi-selection"
));
}
let launchable = Launchable::program(
builder.exec_token(&self.exec_pattern),
self.working_dir_path(&builder),
con,
)?;
Ok(CmdResult::from(launchable))
}
/// build the cmd result as an executable which will be called in a process
/// launched by broot
fn cmd_result_exec_stay_in_broot(
&self,
w: &mut W,
builder: ExecutionStringBuilder<'_>,
con: &AppContext,
) -> Result<CmdResult, ProgramError> {
let working_dir_path = self.working_dir_path(&builder);
match &builder.sel_info {
SelInfo::None | SelInfo::One(_) => {
// zero or one selection -> only one execution
let launchable = Launchable::program(
builder.exec_token(&self.exec_pattern),
working_dir_path,
con,
)?;
info!("Executing not leaving, launchable {:?}", launchable);
if let Err(e) = launchable.execute(Some(w)) {
warn!("launchable failed : {:?}", e);
return Ok(CmdResult::error(e.to_string()));
}
}
SelInfo::More(stage) => {
// multiselection -> we must execute on all paths
let sels = stage.paths().iter()
.map(|path| Selection {
path,
line: 0,
stype: SelectionType::from(path),
is_exe: false,
});
for sel in sels {
let launchable = Launchable::program(
builder.sel_exec_token(&self.exec_pattern, Some(sel)),
working_dir_path.clone(),
con,
)?;
if let Err(e) = launchable.execute(Some(w)) {
warn!("launchable failed : {:?}", e);
return Ok(CmdResult::error(e.to_string()));
}
}
}
}
Ok(CmdResult::RefreshState { clear_cache: true })
}src/browser/browser_state.rs (line 161)
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 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
pub fn open_selection_stay_in_broot(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool,
) -> Result<CmdResult, ProgramError> {
let tree = self.displayed_tree();
let line = tree.selected_line();
let mut target = line.target().to_path_buf();
if line.is_dir() {
if tree.selection == 0 {
// opening the root would be going to where we already are.
// We go up one level instead
if let Some(parent) = target.parent() {
target = PathBuf::from(parent);
}
}
let dam = Dam::unlimited();
Ok(CmdResult::from_optional_state(
BrowserState::new(
target,
if keep_pattern {
tree.options.clone()
} else {
tree.options.without_pattern()
},
screen,
con,
&dam,
),
None,
in_new_panel,
))
} else {
match opener::open(&target) {
Ok(exit_status) => {
info!("open returned with exit_status {:?}", exit_status);
Ok(CmdResult::Keep)
}
Err(e) => Ok(CmdResult::error(format!("{:?}", e))),
}
}
}
pub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
) -> CmdResult {
match &self.displayed_tree().selected_line().path.parent() {
Some(path) => CmdResult::from_optional_state(
BrowserState::new(
path.to_path_buf(),
self.displayed_tree().options.without_pattern(),
screen,
con,
&Dam::unlimited(),
),
None,
in_new_panel,
),
None => CmdResult::error("no parent found"),
}
}
}
impl PanelState for BrowserState {
fn tree_root(&self) -> Option<&Path> {
Some(self.root())
}
fn get_type(&self) -> PanelStateType {
PanelStateType::Tree
}
fn set_mode(&mut self, mode: Mode) {
self.mode = mode;
}
fn get_mode(&self) -> Mode {
self.mode
}
fn get_pending_task(&self) -> Option<&'static str> {
if self.displayed_tree().has_dir_missing_sum() {
Some("computing stats")
} else if self.displayed_tree().is_missing_git_status_computation() {
Some("computing git status")
} else {
self
.pending_task.as_ref().map(|task| match task {
BrowserTask::Search{ .. } => "searching",
BrowserTask::StageAll(_) => "staging",
})
}
}
fn selected_path(&self) -> Option<&Path> {
Some(&self.displayed_tree().selected_line().path)
}
fn selection(&self) -> Option<Selection<'_>> {
let tree = self.displayed_tree();
let mut selection = tree.selected_line().as_selection();
selection.line = tree.options.pattern.pattern
.get_match_line_count(selection.path)
.unwrap_or(0);
Some(selection)
}
fn tree_options(&self) -> TreeOptions {
self.displayed_tree().options.clone()
}
/// build a cmdResult asking for the addition of a new state
/// being a browser state similar to the current one but with
/// different options
fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext,
) -> CmdResult {
let tree = self.displayed_tree();
let mut options = tree.options.clone();
let message = change_options(&mut options);
let message = Some(message);
self.modified(
screen,
tree.root().clone(),
options,
message,
in_new_panel,
con,
)
}
fn clear_pending(&mut self) {
self.pending_task = None;
}
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
self.displayed_tree_mut().try_select_y(y as usize);
Ok(CmdResult::Keep)
}
fn on_double_click(
&mut self,
_x: u16,
y: u16,
screen: Screen,
con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if self.displayed_tree().selection == y as usize {
self.open_selection_stay_in_broot(screen, con, false, false)
} else {
// A double click always come after a simple click at
// same position. If it's not the selected line, it means
// the click wasn't on a selectable/openable tree line
Ok(CmdResult::Keep)
}
}
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if pat.is_none() {
self.filtered_tree = None;
}
if let Some(filtered_tree) = &self.filtered_tree {
if pat != filtered_tree.options.pattern {
self.search(pat, false);
}
} else {
self.search(pat, false);
}
Ok(CmdResult::Keep)
}
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let con = &cc.app.con;
let screen = cc.app.screen;
let page_height = BrowserState::page_height(cc.app.screen);
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
Ok(match internal_exec.internal {
Internal::back => {
if let Some(filtered_tree) = &self.filtered_tree {
let filtered_selection = &filtered_tree.selected_line().path;
if self.tree.try_select_path(filtered_selection) {
self.tree.make_selection_visible(page_height);
}
self.filtered_tree = None;
CmdResult::Keep
} else if self.tree.selection > 0 {
self.tree.selection = 0;
CmdResult::Keep
} else {
CmdResult::PopState
}
}
Internal::focus => internal_focus::on_internal(
internal_exec,
input_invocation,
trigger_type,
&self.displayed_tree().selected_line().path,
self.displayed_tree().options.clone(),
app_state,
cc,
),
Internal::select => internal_select::on_internal(
internal_exec,
input_invocation,
trigger_type,
self.displayed_tree_mut(),
app_state,
cc,
),
Internal::up_tree => match self.displayed_tree().root().parent() {
Some(path) => internal_focus::on_path(
path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
bang,
con,
),
None => CmdResult::error("no parent found"),
},
Internal::open_stay => self.open_selection_stay_in_broot(screen, con, bang, false)?,
Internal::open_stay_filter => self.open_selection_stay_in_broot(screen, con, bang, true)?,
Internal::line_down => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(count, page_height, true);
CmdResult::Keep
}
Internal::line_up => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(-count, page_height, true);
CmdResult::Keep
}
Internal::line_down_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(count, page_height, false);
CmdResult::Keep
}
Internal::line_up_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(-count, page_height, false);
CmdResult::Keep
}
Internal::previous_dir => {
self.displayed_tree_mut().try_select_previous_filtered(
|line| line.is_dir(),
page_height,
);
CmdResult::Keep
}
Internal::next_dir => {
self.displayed_tree_mut().try_select_next_filtered(
|line| line.is_dir(),
page_height,
);
CmdResult::Keep
}
Internal::previous_match => {
self.displayed_tree_mut().try_select_previous_filtered(
|line| line.direct_match,
page_height,
);
CmdResult::Keep
}
Internal::next_match => {
self.displayed_tree_mut().try_select_next_filtered(
|line| line.direct_match,
page_height,
);
CmdResult::Keep
}
Internal::previous_same_depth => {
self.displayed_tree_mut().try_select_previous_same_depth(page_height);
CmdResult::Keep
}
Internal::next_same_depth => {
self.displayed_tree_mut().try_select_next_same_depth(page_height);
CmdResult::Keep
}
Internal::page_down => {
let tree = self.displayed_tree_mut();
if !tree.try_scroll(page_height as i32, page_height) {
tree.try_select_last(page_height);
}
CmdResult::Keep
}
Internal::page_up => {
let tree = self.displayed_tree_mut();
if !tree.try_scroll(page_height as i32 * -1, page_height) {
tree.try_select_first();
}
CmdResult::Keep
}
Internal::panel_left => {
let areas = &cc.panel.areas;
if areas.is_first() && areas.nb_pos < con.max_panels_count {
// we ask for the creation of a panel to the left
internal_focus::new_panel_on_path(
self.displayed_tree().selected_line().path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
PanelPurpose::None,
con,
HDir::Left,
)
} else {
// we let the app handle other cases
CmdResult::HandleInApp(Internal::panel_left_no_open)
}
}
Internal::panel_left_no_open => CmdResult::HandleInApp(Internal::panel_left_no_open),
Internal::panel_right => {
let areas = &cc.panel.areas;
let selected_path = &self.displayed_tree().selected_line().path;
if areas.is_last() && areas.nb_pos < con.max_panels_count {
let purpose = if selected_path.is_file() && cc.app.preview_panel.is_none() {
PanelPurpose::Preview
} else {
PanelPurpose::None
};
// we ask for the creation of a panel to the right
internal_focus::new_panel_on_path(
selected_path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
purpose,
con,
HDir::Right,
)
} else {
// we ask the app to handle other cases :
// focus the panel to the right or close the leftest one
CmdResult::HandleInApp(Internal::panel_right_no_open)
}
}
Internal::panel_right_no_open => CmdResult::HandleInApp(Internal::panel_right_no_open),
Internal::parent => self.go_to_parent(screen, con, bang),
Internal::print_tree => {
print::print_tree(self.displayed_tree(), cc.app.screen, cc.app.panel_skin, con)?
}
Internal::root_up => {
let tree = self.displayed_tree();
let root = tree.root();
if let Some(new_root) = root.parent() {
self.modified(
screen,
new_root.to_path_buf(),
tree.options.clone(),
None,
bang,
con,
)
} else {
CmdResult::error(format!("{:?} has no parent", root))
}
}
Internal::root_down => {
let tree = self.displayed_tree();
if tree.selection > 0 {
let root_len = tree.root().components().count();
let new_root = tree.selected_line().path
.components()
.take(root_len + 1)
.collect();
self.modified(
screen,
new_root,
tree.options.clone(),
None,
bang,
con,
)
} else {
CmdResult::error("No selected line")
}
}
Internal::stage_all_files => {
let pattern = self.displayed_tree().options.pattern.clone();
self.pending_task = Some(BrowserTask::StageAll(pattern));
if cc.app.stage_panel.is_none() {
let stage_options = self.tree.options.without_pattern();
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, stage_options, con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::Keep
}
}
Internal::select_first => {
self.displayed_tree_mut().try_select_first();
CmdResult::Keep
}
Internal::select_last => {
let page_height = BrowserState::page_height(screen);
self.displayed_tree_mut().try_select_last(page_height);
CmdResult::Keep
}
Internal::start_end_panel => {
if cc.panel.purpose.is_arg_edition() {
debug!("start_end understood as end");
CmdResult::ClosePanel {
validate_purpose: true,
panel_ref: PanelReference::Active,
}
} else {
debug!("start_end understood as start");
let tree_options = self.displayed_tree().options.clone();
if let Some(input_invocation) = input_invocation {
// we'll go for input arg editing
let path = if let Some(input_arg) = &input_invocation.args {
path::path_from(self.root(), PathAnchor::Unspecified, input_arg)
} else {
self.root().to_path_buf()
};
let arg_type = SelectionType::Any; // We might do better later
let purpose = PanelPurpose::ArgEdition { arg_type };
internal_focus::new_panel_on_path(
path, screen, tree_options, purpose, con, HDir::Right,
)
} else {
// we just open a new panel on the selected path,
// without purpose
internal_focus::new_panel_on_path(
self.displayed_tree().selected_line().path.to_path_buf(),
screen,
tree_options,
PanelPurpose::None,
con,
HDir::Right,
)
}
}
}
Internal::total_search => {
match self.filtered_tree.as_ref().map(|t| t.total_search) {
None => {
CmdResult::error("this verb can be used only after a search")
}
Some(true) => {
CmdResult::error("search was already total: all possible matches have been ranked")
}
Some(false) => {
self.search(self.displayed_tree().options.pattern.clone(), true);
CmdResult::Keep
}
}
}
Internal::quit => CmdResult::Quit,
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
)?,
})
}Trait Implementations§
source§impl From<Launchable> for CmdResult
impl From<Launchable> for CmdResult
source§fn from(launchable: Launchable) -> Self
fn from(launchable: Launchable) -> Self
Converts to this type from the input type.