Struct broot::browser::BrowserState
source · Expand description
An application state dedicated to displaying a tree. It’s the first and main screen of broot.
Fields§
§tree: Tree§filtered_tree: Option<Tree>Implementations§
source§impl BrowserState
impl BrowserState
sourcepub fn new(
path: PathBuf,
options: TreeOptions,
screen: Screen,
con: &AppContext,
dam: &Dam
) -> Result<BrowserState, TreeBuildError>
pub fn new(
path: PathBuf,
options: TreeOptions,
screen: Screen,
con: &AppContext,
dam: &Dam
) -> Result<BrowserState, TreeBuildError>
build a new tree state if there’s no error and there’s no cancellation.
Examples found in repository?
src/verb/internal_focus.rs (line 47)
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
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,
)
}
pub fn new_panel_on_path(
path: PathBuf,
screen: Screen,
tree_options: TreeOptions,
purpose: PanelPurpose,
con: &AppContext,
direction: HDir,
) -> CmdResult {
if purpose.is_preview() {
let pattern = tree_options.pattern.tree_to_preview();
CmdResult::NewPanel {
state: Box::new(PreviewState::new(path, pattern, None, tree_options, con)),
purpose,
direction,
}
} else {
let path = path::closest_dir(&path);
match BrowserState::new(path, tree_options, screen, con, &Dam::unlimited()) {
Ok(os) => CmdResult::NewPanel {
state: Box::new(os),
purpose,
direction,
},
Err(e) => CmdResult::DisplayError(e.to_string()),
}
}
}More examples
src/browser/browser_state.rs (line 88)
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/app/app.rs (lines 85-91)
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
pub fn new(
con: &AppContext,
) -> Result<App, ProgramError> {
let screen = Screen::new(con)?;
let panel = Panel::new(
PanelId::from(0),
Box::new(
BrowserState::new(
con.initial_root.clone(),
con.initial_tree_options.clone(),
screen,
con,
&Dam::unlimited(),
)?
),
Areas::create(&mut Vec::new(), 0, screen, false),
con,
);
let (tx_seqs, rx_seqs) = unbounded::<Sequence>();
Ok(App {
screen,
active_panel_idx: 0,
panels: panel.into(),
quitting: false,
launch_at_end: None,
created_panels_count: 1,
preview_panel: None,
stage_panel: None,
shared_root: None,
tx_seqs,
rx_seqs,
drawing_count: 0,
})
}
fn panel_ref_to_idx(&self, panel_ref: PanelReference) -> Option<usize> {
match panel_ref {
PanelReference::Active => Some(self.active_panel_idx),
PanelReference::Leftest => Some(0),
PanelReference::Rightest => Some(self.panels.len().get() - 1),
PanelReference::Id(id) => self.panel_id_to_idx(id),
PanelReference::Preview => self.preview_panel.and_then(|id| self.panel_id_to_idx(id)),
}
}
/// return the current index of the panel with given id
fn panel_id_to_idx(&self, id: PanelId) -> Option<usize> {
self.panels.iter().position(|panel| panel.id == id)
}
fn state(&self) -> &dyn PanelState {
self.panels[self.active_panel_idx].state()
}
fn mut_state(&mut self) -> &mut dyn PanelState {
self.panels[self.active_panel_idx].mut_state()
}
fn panel(&self) -> &Panel {
&self.panels[self.active_panel_idx]
}
fn mut_panel(&mut self) -> &mut Panel {
unsafe {
self.panels
.as_mut_slice()
.get_unchecked_mut(self.active_panel_idx)
}
}
/// close the panel if it's not the last one
///
/// Return true when the panel has been removed (ie it wasn't the last one)
fn close_panel(&mut self, panel_idx: usize) -> bool {
let active_panel_id = self.panels[self.active_panel_idx].id;
if let Some(preview_id) = self.preview_panel {
if self.panels.has_len(2) && self.panels[panel_idx].id != preview_id {
// we don't want to stay with just the preview
return false;
}
}
if let Some(stage_id) = self.stage_panel {
if self.panels.has_len(2) && self.panels[panel_idx].id != stage_id {
// we don't want to stay with just the stage
return false;
}
}
if let Ok(removed_panel) = self.panels.remove(panel_idx) {
if self.preview_panel == Some(removed_panel.id) {
self.preview_panel = None;
}
if self.stage_panel == Some(removed_panel.id) {
self.stage_panel = None;
}
Areas::resize_all(
self.panels.as_mut_slice(),
self.screen,
self.preview_panel.is_some(),
);
self.active_panel_idx = self
.panels
.iter()
.position(|p| p.id == active_panel_id)
.unwrap_or(self.panels.len().get() - 1);
true
} else {
false // there's no other panel to go to
}
}
/// remove the top state of the current panel
///
/// Close the panel too if that was its only state.
/// Close nothing and return false if there's not
/// at least two states in the app.
fn remove_state(&mut self) -> bool {
self.panels[self.active_panel_idx].remove_state()
|| self.close_panel(self.active_panel_idx)
}
/// redraw the whole screen. All drawing
/// are supposed to happen here, and only here.
fn display_panels(
&mut self,
w: &mut W,
skin: &AppSkin,
app_state: &AppState,
con: &AppContext,
) -> Result<(), ProgramError> {
self.drawing_count += 1;
for (idx, panel) in self.panels.as_mut_slice().iter_mut().enumerate() {
let active = idx == self.active_panel_idx;
let panel_skin = if active { &skin.focused } else { &skin.unfocused };
let disc = DisplayContext {
count: self.drawing_count,
active,
screen: self.screen,
panel_skin,
state_area: panel.areas.state.clone(),
app_state,
con,
};
time!(
"display panel",
panel.display(w, &disc)?,
);
}
kitty::manager().lock().unwrap().erase_images_before(w, self.drawing_count)?;
w.flush()?;
Ok(())
}
/// if there are exactly two non preview panels, return the selection
/// in the non focused panel
fn get_other_panel_path(&self) -> Option<PathBuf> {
let len = self.panels.len().get();
if len == 3 {
if let Some(preview_id) = self.preview_panel {
for (idx, panel) in self.panels.iter().enumerate() {
if self.active_panel_idx != idx && panel.id != preview_id {
return panel.state().selected_path()
.map(|p| p.to_path_buf());
}
}
}
None
} else if self.panels.len().get() == 2 && self.preview_panel.is_none() {
let non_focused_panel_idx = if self.active_panel_idx == 0 { 1 } else { 0 };
self.panels[non_focused_panel_idx].state().selected_path()
.map(|p| p.to_path_buf())
} else {
None
}
}
/// apply a command. Change the states but don't redraw on screen.
fn apply_command(
&mut self,
w: &mut W,
cmd: Command,
panel_skin: &PanelSkin,
app_state: &mut AppState,
con: &mut AppContext,
) -> Result<(), ProgramError> {
use CmdResult::*;
let mut error: Option<String> = None;
let is_input_invocation = cmd.is_verb_invocated_from_input();
let app_cmd_context = AppCmdContext {
panel_skin,
preview_panel: self.preview_panel,
stage_panel: self.stage_panel,
screen: self.screen, // it can't change in this function
con,
};
let cmd_result = self.mut_panel().apply_command(w, &cmd, app_state, &app_cmd_context)?;
debug!("cmd_result: {:?}", &cmd_result);
match cmd_result {
ApplyOnPanel { id } => {
if let Some(idx) = self.panel_id_to_idx(id) {
if let DisplayError(txt) = self.panels[idx].apply_command(
w, &cmd, app_state, &app_cmd_context
)? {
// we should probably handle other results
// which implies the possibility of a recursion
error = Some(txt);
} else if is_input_invocation {
self.mut_panel().clear_input();
}
} else {
warn!("no panel found for ApplyOnPanel");
}
}
ClosePanel { validate_purpose, panel_ref } => {
if is_input_invocation {
self.mut_panel().clear_input_invocation(con);
}
let close_idx = self.panel_ref_to_idx(panel_ref)
.unwrap_or_else(||
// when there's a preview panel, we close it rather than the app
if self.panels.len().get()==2 && self.preview_panel.is_some() {
1
} else {
self.active_panel_idx
}
);
let mut new_arg = None;
if validate_purpose {
let purpose = &self.panels[close_idx].purpose;
if let PanelPurpose::ArgEdition { .. } = purpose {
new_arg = self.panels[close_idx]
.state()
.selected_path()
.map(|p| p.to_string_lossy().to_string());
}
}
if self.close_panel(close_idx) {
let screen = self.screen;
self.mut_state().refresh(screen, con);
if let Some(new_arg) = new_arg {
self.mut_panel().set_input_arg(new_arg);
let new_input = self.panel().get_input_content();
let cmd = Command::from_raw(new_input, false);
let app_cmd_context = AppCmdContext {
panel_skin,
preview_panel: self.preview_panel,
stage_panel: self.stage_panel,
screen,
con,
};
self.mut_panel().apply_command(w, &cmd, app_state, &app_cmd_context)?;
}
} else {
self.quitting = true;
}
}
DisplayError(txt) => {
error = Some(txt);
}
ExecuteSequence { sequence } => {
self.tx_seqs.send(sequence).unwrap();
}
HandleInApp(internal) => {
debug!("handling internal {internal:?} at app level");
match internal {
Internal::panel_left_no_open | Internal::panel_right_no_open => {
let new_active_panel_idx = if internal == Internal::panel_left_no_open {
// we're here because the state wants us to either move to the panel
// to the left, or close the rightest one
if self.active_panel_idx == 0 {
self.close_panel(self.panels.len().get()-1);
None
} else {
Some(self.active_panel_idx - 1)
}
} else { // panel_right
// we either move to the right or close the leftest panel
if self.active_panel_idx + 1 == self.panels.len().get() {
self.close_panel(0);
None
} else {
Some(self.active_panel_idx + 1)
}
};
if let Some(idx) = new_active_panel_idx {
if is_input_invocation {
self.mut_panel().clear_input();
}
self.active_panel_idx = idx;
let app_cmd_context = AppCmdContext {
panel_skin,
preview_panel: self.preview_panel,
stage_panel: self.stage_panel,
screen: self.screen,
con,
};
self.mut_panel().refresh_input_status(app_state, &app_cmd_context);
}
}
Internal::toggle_second_tree => {
let panels_count = self.panels.len().get();
let trees_count = self.panels.iter()
.filter(|p| p.state().get_type() == PanelStateType::Tree)
.count();
if trees_count < 2 {
// we open a tree, closing a (non tree) panel if necessary
if panels_count >= con.max_panels_count {
for i in (0..panels_count).rev() {
if self.panels[i].state().get_type() != PanelStateType::Tree {
self.close_panel(i);
break;
}
}
}
if let Some(selected_path) = self.state().selected_path() {
let dir = closest_dir(selected_path);
if let Ok(new_state) = BrowserState::new(
dir,
self.state().tree_options().without_pattern(),
self.screen,
con,
&Dam::unlimited(),
) {
if let Err(s) = self.new_panel(
Box::new(new_state),
PanelPurpose::None,
HDir::Right,
is_input_invocation,
con,
) {
error = Some(s);
}
}
}
} else {
// we close the rightest inactive tree
for i in (0..panels_count).rev() {
if self.panels[i].state().get_type() == PanelStateType::Tree {
if i == self.active_panel_idx {
continue;
}
self.close_panel(i);
break;
}
}
}
}
Internal::set_syntax_theme => {
let arg = cmd
.as_verb_invocation()
.and_then(|vi| vi.args.as_ref());
match arg {
Some(arg) => {
match SyntaxTheme::from_str(arg) {
Ok(theme) => {
con.syntax_theme = Some(theme);
self.update_preview(con, true);
}
Err(e) => {
error = Some(e.to_string());
}
}
}
None => {
error = Some("no theme provided".to_string());
}
}
}
_ => {
info!("unhandled propagated internal. cmd={:?}", &cmd);
}
}
}
Keep => {
if is_input_invocation {
self.mut_panel().clear_input_invocation(con);
}
}
Launch(launchable) => {
self.launch_at_end = Some(*launchable);
self.quitting = true;
}
NewPanel {
state,
purpose,
direction,
} => {
if let Err(s) = self.new_panel(state, purpose, direction, is_input_invocation, con) {
error = Some(s);
}
}
NewState { state, message } => {
self.mut_panel().clear_input();
self.mut_panel().push_state(state);
if let Some(md) = message {
self.mut_panel().set_message(md);
} else {
self.mut_panel().refresh_input_status(app_state, &app_cmd_context);
}
}
PopState => {
if is_input_invocation {
self.mut_panel().clear_input();
}
if self.remove_state() {
self.mut_state().refresh(app_cmd_context.screen, con);
self.mut_panel().refresh_input_status(app_state, &app_cmd_context);
} else if con.quit_on_last_cancel {
self.quitting = true;
}
}
PopStateAndReapply => {
if is_input_invocation {
self.mut_panel().clear_input();
}
if self.remove_state() {
let app_cmd_context = AppCmdContext {
panel_skin,
preview_panel: self.preview_panel,
stage_panel: self.stage_panel,
screen: self.screen,
con,
};
self.mut_panel().apply_command(w, &cmd, app_state, &app_cmd_context)?;
} else if con.quit_on_last_cancel {
self.quitting = true;
}
}
Quit => {
self.quitting = true;
}
RefreshState { clear_cache } => {
if is_input_invocation {
self.mut_panel().clear_input_invocation(con);
}
if clear_cache {
clear_caches();
}
app_state.stage.refresh();
for i in 0..self.panels.len().get() {
self.panels[i].mut_state().refresh(self.screen, con);
}
}
}
if let Some(text) = error {
self.mut_panel().set_error(text);
}
app_state.other_panel_path = self.get_other_panel_path();
if let Some(path) = self.state().tree_root() {
app_state.root = path.to_path_buf();
}
if let Some(shared_root) = &mut self.shared_root {
if let Ok(mut root) = shared_root.lock() {
*root = app_state.root.clone();
}
}
self.update_preview(con, false);
Ok(())
}src/filesystems/filesystems_state.rs (lines 519-525)
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 root(&self) -> &Path
pub fn root(&self) -> &Path
Examples found in repository?
src/browser/browser_state.rs (line 193)
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
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,
)?,
})
}sourcepub fn page_height(screen: Screen) -> usize
pub fn page_height(screen: Screen) -> usize
Examples found in repository?
src/verb/internal_select.rs (line 142)
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn on_path(
path: PathBuf,
tree: &mut Tree,
screen: Screen,
in_new_panel: bool,
) -> CmdResult {
info!("executing :select on path {:?}", &path);
if in_new_panel {
warn!("bang in :select isn't supported yet");
}
if tree.try_select_path(&path) {
tree.make_selection_visible(BrowserState::page_height(screen) as usize);
}
CmdResult::Keep
}More examples
src/browser/browser_state.rs (line 59)
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 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
pub fn new(
path: PathBuf,
mut options: TreeOptions,
screen: Screen,
con: &AppContext,
dam: &Dam,
) -> Result<BrowserState, TreeBuildError> {
let pending_task = options.pattern
.take()
.as_option()
.map(|pattern| BrowserTask::Search { pattern, total: false });
let builder = TreeBuilder::from(
path,
options,
BrowserState::page_height(screen) as usize,
con,
)?;
let tree = builder.build_tree(false, dam)?;
Ok(BrowserState {
tree,
filtered_tree: None,
mode: initial_mode(con),
pending_task,
})
}
fn search(&mut self, pattern: InputPattern, total: bool) {
self.pending_task = Some(BrowserTask::Search { pattern, total });
}
/// build a cmdResult asking for the addition of a new state
/// being a browser state similar to the current one but with
/// different options or a different root, or both
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"),
}
}
}
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,
)?,
})
}
fn no_verb_status(
&self,
has_previous_state: bool,
con: &AppContext,
) -> Status {
let tree = self.displayed_tree();
if tree.is_empty() {
if tree.build_report.hidden_count > 0 {
let mut parts = Vec::new();
if let Some(md) = con.standard_status.all_files_hidden.clone() {
parts.push(md);
}
if let Some(md) = con.standard_status.all_files_git_ignored.clone() {
parts.push(md);
}
if !parts.is_empty() {
return Status::from_error(parts.join(". "));
}
}
}
let mut ssb = con.standard_status.builder(
PanelStateType::Tree,
tree.selected_line().as_selection(),
);
ssb.has_previous_state = has_previous_state;
ssb.is_filtered = self.filtered_tree.is_some();
ssb.has_removed_pattern = false;
ssb.on_tree_root = tree.selection == 0;
ssb.status()
}
/// do some work, totally or partially, if there's some to do.
/// Stop as soon as the dam asks for interruption
fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
if let Some(pending_task) = self.pending_task.take() {
match pending_task {
BrowserTask::Search { pattern, total } => {
let pattern_str = pattern.raw.clone();
let mut options = self.tree.options.clone();
options.pattern = pattern;
let root = self.tree.root().clone();
let page_height = BrowserState::page_height(screen) as usize;
let builder = TreeBuilder::from(root, options, page_height, con)?;
let filtered_tree = time!(
Info,
"tree filtering",
&pattern_str,
builder.build_tree(total, dam),
);
if let Ok(mut ft) = filtered_tree {
ft.try_select_best_match();
ft.make_selection_visible(BrowserState::page_height(screen));
self.filtered_tree = Some(ft);
}
}
BrowserTask::StageAll(pattern) => {
let tree = self.displayed_tree();
let root = tree.root().clone();
let mut options = tree.options.clone();
let total_search = true;
options.pattern = pattern; // should be the same
let builder = TreeBuilder::from(root, options, con.max_staged_count, con);
let mut paths = builder
.and_then(|mut builder| {
builder.matches_max = Some(con.max_staged_count);
time!(builder.build_paths(
total_search,
dam,
|line| line.file_type.is_file(),
))
})?;
for path in paths.drain(..) {
app_state.stage.add(path);
}
}
}
} else if self.displayed_tree().is_missing_git_status_computation() {
let root_path = self.displayed_tree().root();
let git_status = git::get_tree_status(root_path, dam);
self.displayed_tree_mut().git_status = git_status;
} else {
self.displayed_tree_mut().fetch_some_missing_dir_sum(dam, con);
}
Ok(())
}
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
let dp = DisplayableTree {
app_state: Some(disc.app_state),
tree: self.displayed_tree(),
skin: &disc.panel_skin.styles,
ext_colors: &disc.con.ext_colors,
area: disc.state_area.clone(),
in_app: true,
};
dp.write_on(w)
}
fn refresh(&mut self, screen: Screen, con: &AppContext) -> Command {
let page_height = BrowserState::page_height(screen) as usize;
// refresh the base tree
if let Err(e) = self.tree.refresh(page_height, con) {
warn!("refreshing base tree failed : {:?}", e);
}
// refresh the filtered tree, if any
Command::from_pattern(match self.filtered_tree {
Some(ref mut tree) => {
if let Err(e) = tree.refresh(page_height, con) {
warn!("refreshing filtered tree failed : {:?}", e);
}
&tree.options.pattern
}
None => &self.tree.options.pattern,
})
}sourcepub fn displayed_tree(&self) -> &Tree
pub fn displayed_tree(&self) -> &Tree
return a reference to the currently displayed tree, which is the filtered tree if there’s one, the base tree if not.
Examples found in repository?
src/browser/browser_state.rs (line 87)
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
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"),
}
}
}
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,
)?,
})
}
fn no_verb_status(
&self,
has_previous_state: bool,
con: &AppContext,
) -> Status {
let tree = self.displayed_tree();
if tree.is_empty() {
if tree.build_report.hidden_count > 0 {
let mut parts = Vec::new();
if let Some(md) = con.standard_status.all_files_hidden.clone() {
parts.push(md);
}
if let Some(md) = con.standard_status.all_files_git_ignored.clone() {
parts.push(md);
}
if !parts.is_empty() {
return Status::from_error(parts.join(". "));
}
}
}
let mut ssb = con.standard_status.builder(
PanelStateType::Tree,
tree.selected_line().as_selection(),
);
ssb.has_previous_state = has_previous_state;
ssb.is_filtered = self.filtered_tree.is_some();
ssb.has_removed_pattern = false;
ssb.on_tree_root = tree.selection == 0;
ssb.status()
}
/// do some work, totally or partially, if there's some to do.
/// Stop as soon as the dam asks for interruption
fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
if let Some(pending_task) = self.pending_task.take() {
match pending_task {
BrowserTask::Search { pattern, total } => {
let pattern_str = pattern.raw.clone();
let mut options = self.tree.options.clone();
options.pattern = pattern;
let root = self.tree.root().clone();
let page_height = BrowserState::page_height(screen) as usize;
let builder = TreeBuilder::from(root, options, page_height, con)?;
let filtered_tree = time!(
Info,
"tree filtering",
&pattern_str,
builder.build_tree(total, dam),
);
if let Ok(mut ft) = filtered_tree {
ft.try_select_best_match();
ft.make_selection_visible(BrowserState::page_height(screen));
self.filtered_tree = Some(ft);
}
}
BrowserTask::StageAll(pattern) => {
let tree = self.displayed_tree();
let root = tree.root().clone();
let mut options = tree.options.clone();
let total_search = true;
options.pattern = pattern; // should be the same
let builder = TreeBuilder::from(root, options, con.max_staged_count, con);
let mut paths = builder
.and_then(|mut builder| {
builder.matches_max = Some(con.max_staged_count);
time!(builder.build_paths(
total_search,
dam,
|line| line.file_type.is_file(),
))
})?;
for path in paths.drain(..) {
app_state.stage.add(path);
}
}
}
} else if self.displayed_tree().is_missing_git_status_computation() {
let root_path = self.displayed_tree().root();
let git_status = git::get_tree_status(root_path, dam);
self.displayed_tree_mut().git_status = git_status;
} else {
self.displayed_tree_mut().fetch_some_missing_dir_sum(dam, con);
}
Ok(())
}
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
let dp = DisplayableTree {
app_state: Some(disc.app_state),
tree: self.displayed_tree(),
skin: &disc.panel_skin.styles,
ext_colors: &disc.con.ext_colors,
area: disc.state_area.clone(),
in_app: true,
};
dp.write_on(w)
}
fn refresh(&mut self, screen: Screen, con: &AppContext) -> Command {
let page_height = BrowserState::page_height(screen) as usize;
// refresh the base tree
if let Err(e) = self.tree.refresh(page_height, con) {
warn!("refreshing base tree failed : {:?}", e);
}
// refresh the filtered tree, if any
Command::from_pattern(match self.filtered_tree {
Some(ref mut tree) => {
if let Err(e) = tree.refresh(page_height, con) {
warn!("refreshing filtered tree failed : {:?}", e);
}
&tree.options.pattern
}
None => &self.tree.options.pattern,
})
}
fn get_flags(&self) -> Vec<Flag> {
let options = &self.displayed_tree().options;
vec![
Flag {
name: "h",
value: if options.show_hidden { "y" } else { "n" },
},
Flag {
name: "gi",
value: if options.respect_git_ignore { "y" } else { "n" },
},
]
}
fn get_starting_input(&self) -> String {
if let Some(BrowserTask::Search { pattern, .. }) = self.pending_task.as_ref() {
pattern.raw.clone()
} else {
self.displayed_tree().options.pattern.raw.clone()
}
}sourcepub fn displayed_tree_mut(&mut self) -> &mut Tree
pub fn displayed_tree_mut(&mut self) -> &mut Tree
return a mutable reference to the currently displayed tree, which is the filtered tree if there’s one, the base tree if not.
Examples found in repository?
src/browser/browser_state.rs (line 91)
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
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"),
}
}
}
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,
)?,
})
}
fn no_verb_status(
&self,
has_previous_state: bool,
con: &AppContext,
) -> Status {
let tree = self.displayed_tree();
if tree.is_empty() {
if tree.build_report.hidden_count > 0 {
let mut parts = Vec::new();
if let Some(md) = con.standard_status.all_files_hidden.clone() {
parts.push(md);
}
if let Some(md) = con.standard_status.all_files_git_ignored.clone() {
parts.push(md);
}
if !parts.is_empty() {
return Status::from_error(parts.join(". "));
}
}
}
let mut ssb = con.standard_status.builder(
PanelStateType::Tree,
tree.selected_line().as_selection(),
);
ssb.has_previous_state = has_previous_state;
ssb.is_filtered = self.filtered_tree.is_some();
ssb.has_removed_pattern = false;
ssb.on_tree_root = tree.selection == 0;
ssb.status()
}
/// do some work, totally or partially, if there's some to do.
/// Stop as soon as the dam asks for interruption
fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
if let Some(pending_task) = self.pending_task.take() {
match pending_task {
BrowserTask::Search { pattern, total } => {
let pattern_str = pattern.raw.clone();
let mut options = self.tree.options.clone();
options.pattern = pattern;
let root = self.tree.root().clone();
let page_height = BrowserState::page_height(screen) as usize;
let builder = TreeBuilder::from(root, options, page_height, con)?;
let filtered_tree = time!(
Info,
"tree filtering",
&pattern_str,
builder.build_tree(total, dam),
);
if let Ok(mut ft) = filtered_tree {
ft.try_select_best_match();
ft.make_selection_visible(BrowserState::page_height(screen));
self.filtered_tree = Some(ft);
}
}
BrowserTask::StageAll(pattern) => {
let tree = self.displayed_tree();
let root = tree.root().clone();
let mut options = tree.options.clone();
let total_search = true;
options.pattern = pattern; // should be the same
let builder = TreeBuilder::from(root, options, con.max_staged_count, con);
let mut paths = builder
.and_then(|mut builder| {
builder.matches_max = Some(con.max_staged_count);
time!(builder.build_paths(
total_search,
dam,
|line| line.file_type.is_file(),
))
})?;
for path in paths.drain(..) {
app_state.stage.add(path);
}
}
}
} else if self.displayed_tree().is_missing_git_status_computation() {
let root_path = self.displayed_tree().root();
let git_status = git::get_tree_status(root_path, dam);
self.displayed_tree_mut().git_status = git_status;
} else {
self.displayed_tree_mut().fetch_some_missing_dir_sum(dam, con);
}
Ok(())
}sourcepub fn open_selection_stay_in_broot(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool
) -> Result<CmdResult, ProgramError>
pub fn open_selection_stay_in_broot(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool
) -> Result<CmdResult, ProgramError>
Examples found in repository?
src/browser/browser_state.rs (line 286)
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
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,
)?,
})
}sourcepub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool
) -> CmdResult
pub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool
) -> CmdResult
Examples found in repository?
src/browser/browser_state.rs (line 487)
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
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 PanelState for BrowserState
impl PanelState for BrowserState
source§fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext
) -> CmdResult
fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext
) -> CmdResult
build a cmdResult asking for the addition of a new state being a browser state similar to the current one but with different options
source§fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam
) -> Result<(), ProgramError>
fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam
) -> Result<(), ProgramError>
do some work, totally or partially, if there’s some to do. Stop as soon as the dam asks for interruption
source§fn tree_root(&self) -> Option<&Path>
fn tree_root(&self) -> Option<&Path>
must return None if the state doesn’t display a file tree
fn get_type(&self) -> PanelStateType
fn set_mode(&mut self, mode: Mode)
fn get_mode(&self) -> Mode
fn get_pending_task(&self) -> Option<&'static str>
fn selected_path(&self) -> Option<&Path>
fn selection(&self) -> Option<Selection<'_>>
fn tree_options(&self) -> TreeOptions
source§fn clear_pending(&mut self)
fn clear_pending(&mut self)
called on start of on_command
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext
) -> Result<CmdResult, ProgramError>
fn on_double_click(
&mut self,
_x: u16,
y: u16,
screen: Screen,
con: &AppContext
) -> Result<CmdResult, ProgramError>
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext
) -> Result<CmdResult, ProgramError>
source§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>
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>
execute the internal with the optional given invocation. Read more
source§fn no_verb_status(&self, has_previous_state: bool, con: &AppContext) -> Status
fn no_verb_status(&self, has_previous_state: bool, con: &AppContext) -> Status
return the status which should be used when there’s no verb edited
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext<'_>
) -> Result<(), ProgramError>
fn refresh(&mut self, screen: Screen, con: &AppContext) -> Command
fn get_starting_input(&self) -> String
fn on_mode_verb(&mut self, mode: Mode, con: &AppContext) -> CmdResult
source§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>
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>
a generic implementation of on_internal which may be
called by states when they don’t have a specific
behavior to execute
fn stage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
con: &AppContext
) -> CmdResult
fn unstage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
_con: &AppContext
) -> CmdResult
fn toggle_stage(
&self,
app_state: &mut AppState,
cc: &CmdContext<'_>,
con: &AppContext
) -> CmdResult
fn execute_verb(
&mut self,
w: &mut W,
verb: &Verb,
invocation: Option<&VerbInvocation>,
trigger_type: TriggerType<'_>,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
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>
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>
source§fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
fn on_command(
&mut self,
w: &mut W,
app_state: &mut AppState,
cc: &CmdContext<'_>
) -> Result<CmdResult, ProgramError>
change the state, does no rendering
source§fn open_preview(
&mut self,
prefered_mode: Option<PreviewMode>,
close_if_open: bool,
cc: &CmdContext<'_>
) -> CmdResult
fn open_preview(
&mut self,
prefered_mode: Option<PreviewMode>,
close_if_open: bool,
cc: &CmdContext<'_>
) -> CmdResult
return a cmdresult asking for the opening of a preview