Struct broot::tree::TreeOptions
source · pub struct TreeOptions {Show 18 fields
pub show_selection_mark: bool,
pub show_hidden: bool,
pub only_folders: bool,
pub show_counts: bool,
pub show_dates: bool,
pub show_sizes: bool,
pub show_git_file_info: bool,
pub show_device_id: bool,
pub show_root_fs: bool,
pub trim_root: bool,
pub show_permissions: bool,
pub respect_git_ignore: bool,
pub filter_by_git_status: bool,
pub pattern: InputPattern,
pub date_time_format: &'static str,
pub sort: Sort,
pub cols_order: Cols,
pub show_matching_characters_on_path_searches: bool,
}
Expand description
Options defining how the tree should be build and|or displayed
Fields§
§show_selection_mark: bool
§only_folders: bool
§show_counts: bool
§show_dates: bool
§show_sizes: bool
§show_git_file_info: bool
§show_device_id: bool
§show_root_fs: bool
§trim_root: bool
§show_permissions: bool
§respect_git_ignore: bool
§filter_by_git_status: bool
§pattern: InputPattern
§date_time_format: &'static str
§sort: Sort
§cols_order: Cols
§show_matching_characters_on_path_searches: bool
Implementations§
source§impl TreeOptions
impl TreeOptions
sourcepub fn without_pattern(&self) -> Self
pub fn without_pattern(&self) -> Self
clone self but without the pattern (if any)
Examples found in repository?
src/browser/browser_state.rs (line 146)
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
pub fn open_selection_stay_in_broot(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
keep_pattern: bool,
) -> Result<CmdResult, ProgramError> {
let tree = self.displayed_tree();
let line = tree.selected_line();
let mut target = line.target().to_path_buf();
if line.is_dir() {
if tree.selection == 0 {
// opening the root would be going to where we already are.
// We go up one level instead
if let Some(parent) = target.parent() {
target = PathBuf::from(parent);
}
}
let dam = Dam::unlimited();
Ok(CmdResult::from_optional_state(
BrowserState::new(
target,
if keep_pattern {
tree.options.clone()
} else {
tree.options.without_pattern()
},
screen,
con,
&dam,
),
None,
in_new_panel,
))
} else {
match opener::open(&target) {
Ok(exit_status) => {
info!("open returned with exit_status {:?}", exit_status);
Ok(CmdResult::Keep)
}
Err(e) => Ok(CmdResult::error(format!("{:?}", e))),
}
}
}
pub fn go_to_parent(
&mut self,
screen: Screen,
con: &AppContext,
in_new_panel: bool,
) -> CmdResult {
match &self.displayed_tree().selected_line().path.parent() {
Some(path) => CmdResult::from_optional_state(
BrowserState::new(
path.to_path_buf(),
self.displayed_tree().options.without_pattern(),
screen,
con,
&Dam::unlimited(),
),
None,
in_new_panel,
),
None => CmdResult::error("no parent found"),
}
}
}
impl PanelState for BrowserState {
fn tree_root(&self) -> Option<&Path> {
Some(self.root())
}
fn get_type(&self) -> PanelStateType {
PanelStateType::Tree
}
fn set_mode(&mut self, mode: Mode) {
self.mode = mode;
}
fn get_mode(&self) -> Mode {
self.mode
}
fn get_pending_task(&self) -> Option<&'static str> {
if self.displayed_tree().has_dir_missing_sum() {
Some("computing stats")
} else if self.displayed_tree().is_missing_git_status_computation() {
Some("computing git status")
} else {
self
.pending_task.as_ref().map(|task| match task {
BrowserTask::Search{ .. } => "searching",
BrowserTask::StageAll(_) => "staging",
})
}
}
fn selected_path(&self) -> Option<&Path> {
Some(&self.displayed_tree().selected_line().path)
}
fn selection(&self) -> Option<Selection<'_>> {
let tree = self.displayed_tree();
let mut selection = tree.selected_line().as_selection();
selection.line = tree.options.pattern.pattern
.get_match_line_count(selection.path)
.unwrap_or(0);
Some(selection)
}
fn tree_options(&self) -> TreeOptions {
self.displayed_tree().options.clone()
}
/// build a cmdResult asking for the addition of a new state
/// being a browser state similar to the current one but with
/// different options
fn with_new_options(
&mut self,
screen: Screen,
change_options: &dyn Fn(&mut TreeOptions) -> &'static str,
in_new_panel: bool,
con: &AppContext,
) -> CmdResult {
let tree = self.displayed_tree();
let mut options = tree.options.clone();
let message = change_options(&mut options);
let message = Some(message);
self.modified(
screen,
tree.root().clone(),
options,
message,
in_new_panel,
con,
)
}
fn clear_pending(&mut self) {
self.pending_task = None;
}
fn on_click(
&mut self,
_x: u16,
y: u16,
_screen: Screen,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
self.displayed_tree_mut().try_select_y(y as usize);
Ok(CmdResult::Keep)
}
fn on_double_click(
&mut self,
_x: u16,
y: u16,
screen: Screen,
con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if self.displayed_tree().selection == y as usize {
self.open_selection_stay_in_broot(screen, con, false, false)
} else {
// A double click always come after a simple click at
// same position. If it's not the selected line, it means
// the click wasn't on a selectable/openable tree line
Ok(CmdResult::Keep)
}
}
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
if pat.is_none() {
self.filtered_tree = None;
}
if let Some(filtered_tree) = &self.filtered_tree {
if pat != filtered_tree.options.pattern {
self.search(pat, false);
}
} else {
self.search(pat, false);
}
Ok(CmdResult::Keep)
}
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
let con = &cc.app.con;
let screen = cc.app.screen;
let page_height = BrowserState::page_height(cc.app.screen);
let bang = input_invocation
.map(|inv| inv.bang)
.unwrap_or(internal_exec.bang);
Ok(match internal_exec.internal {
Internal::back => {
if let Some(filtered_tree) = &self.filtered_tree {
let filtered_selection = &filtered_tree.selected_line().path;
if self.tree.try_select_path(filtered_selection) {
self.tree.make_selection_visible(page_height);
}
self.filtered_tree = None;
CmdResult::Keep
} else if self.tree.selection > 0 {
self.tree.selection = 0;
CmdResult::Keep
} else {
CmdResult::PopState
}
}
Internal::focus => internal_focus::on_internal(
internal_exec,
input_invocation,
trigger_type,
&self.displayed_tree().selected_line().path,
self.displayed_tree().options.clone(),
app_state,
cc,
),
Internal::select => internal_select::on_internal(
internal_exec,
input_invocation,
trigger_type,
self.displayed_tree_mut(),
app_state,
cc,
),
Internal::up_tree => match self.displayed_tree().root().parent() {
Some(path) => internal_focus::on_path(
path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
bang,
con,
),
None => CmdResult::error("no parent found"),
},
Internal::open_stay => self.open_selection_stay_in_broot(screen, con, bang, false)?,
Internal::open_stay_filter => self.open_selection_stay_in_broot(screen, con, bang, true)?,
Internal::line_down => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(count, page_height, true);
CmdResult::Keep
}
Internal::line_up => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(-count, page_height, true);
CmdResult::Keep
}
Internal::line_down_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(count, page_height, false);
CmdResult::Keep
}
Internal::line_up_no_cycle => {
let count = get_arg(input_invocation, internal_exec, 1);
self.displayed_tree_mut().move_selection(-count, page_height, false);
CmdResult::Keep
}
Internal::previous_dir => {
self.displayed_tree_mut().try_select_previous_filtered(
|line| line.is_dir(),
page_height,
);
CmdResult::Keep
}
Internal::next_dir => {
self.displayed_tree_mut().try_select_next_filtered(
|line| line.is_dir(),
page_height,
);
CmdResult::Keep
}
Internal::previous_match => {
self.displayed_tree_mut().try_select_previous_filtered(
|line| line.direct_match,
page_height,
);
CmdResult::Keep
}
Internal::next_match => {
self.displayed_tree_mut().try_select_next_filtered(
|line| line.direct_match,
page_height,
);
CmdResult::Keep
}
Internal::previous_same_depth => {
self.displayed_tree_mut().try_select_previous_same_depth(page_height);
CmdResult::Keep
}
Internal::next_same_depth => {
self.displayed_tree_mut().try_select_next_same_depth(page_height);
CmdResult::Keep
}
Internal::page_down => {
let tree = self.displayed_tree_mut();
if !tree.try_scroll(page_height as i32, page_height) {
tree.try_select_last(page_height);
}
CmdResult::Keep
}
Internal::page_up => {
let tree = self.displayed_tree_mut();
if !tree.try_scroll(page_height as i32 * -1, page_height) {
tree.try_select_first();
}
CmdResult::Keep
}
Internal::panel_left => {
let areas = &cc.panel.areas;
if areas.is_first() && areas.nb_pos < con.max_panels_count {
// we ask for the creation of a panel to the left
internal_focus::new_panel_on_path(
self.displayed_tree().selected_line().path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
PanelPurpose::None,
con,
HDir::Left,
)
} else {
// we let the app handle other cases
CmdResult::HandleInApp(Internal::panel_left_no_open)
}
}
Internal::panel_left_no_open => CmdResult::HandleInApp(Internal::panel_left_no_open),
Internal::panel_right => {
let areas = &cc.panel.areas;
let selected_path = &self.displayed_tree().selected_line().path;
if areas.is_last() && areas.nb_pos < con.max_panels_count {
let purpose = if selected_path.is_file() && cc.app.preview_panel.is_none() {
PanelPurpose::Preview
} else {
PanelPurpose::None
};
// we ask for the creation of a panel to the right
internal_focus::new_panel_on_path(
selected_path.to_path_buf(),
screen,
self.displayed_tree().options.clone(),
purpose,
con,
HDir::Right,
)
} else {
// we ask the app to handle other cases :
// focus the panel to the right or close the leftest one
CmdResult::HandleInApp(Internal::panel_right_no_open)
}
}
Internal::panel_right_no_open => CmdResult::HandleInApp(Internal::panel_right_no_open),
Internal::parent => self.go_to_parent(screen, con, bang),
Internal::print_tree => {
print::print_tree(self.displayed_tree(), cc.app.screen, cc.app.panel_skin, con)?
}
Internal::root_up => {
let tree = self.displayed_tree();
let root = tree.root();
if let Some(new_root) = root.parent() {
self.modified(
screen,
new_root.to_path_buf(),
tree.options.clone(),
None,
bang,
con,
)
} else {
CmdResult::error(format!("{:?} has no parent", root))
}
}
Internal::root_down => {
let tree = self.displayed_tree();
if tree.selection > 0 {
let root_len = tree.root().components().count();
let new_root = tree.selected_line().path
.components()
.take(root_len + 1)
.collect();
self.modified(
screen,
new_root,
tree.options.clone(),
None,
bang,
con,
)
} else {
CmdResult::error("No selected line")
}
}
Internal::stage_all_files => {
let pattern = self.displayed_tree().options.pattern.clone();
self.pending_task = Some(BrowserTask::StageAll(pattern));
if cc.app.stage_panel.is_none() {
let stage_options = self.tree.options.without_pattern();
CmdResult::NewPanel {
state: Box::new(StageState::new(app_state, stage_options, con)),
purpose: PanelPurpose::None,
direction: HDir::Right,
}
} else {
CmdResult::Keep
}
}
Internal::select_first => {
self.displayed_tree_mut().try_select_first();
CmdResult::Keep
}
Internal::select_last => {
let page_height = BrowserState::page_height(screen);
self.displayed_tree_mut().try_select_last(page_height);
CmdResult::Keep
}
Internal::start_end_panel => {
if cc.panel.purpose.is_arg_edition() {
debug!("start_end understood as end");
CmdResult::ClosePanel {
validate_purpose: true,
panel_ref: PanelReference::Active,
}
} else {
debug!("start_end understood as start");
let tree_options = self.displayed_tree().options.clone();
if let Some(input_invocation) = input_invocation {
// we'll go for input arg editing
let path = if let Some(input_arg) = &input_invocation.args {
path::path_from(self.root(), PathAnchor::Unspecified, input_arg)
} else {
self.root().to_path_buf()
};
let arg_type = SelectionType::Any; // We might do better later
let purpose = PanelPurpose::ArgEdition { arg_type };
internal_focus::new_panel_on_path(
path, screen, tree_options, purpose, con, HDir::Right,
)
} else {
// we just open a new panel on the selected path,
// without purpose
internal_focus::new_panel_on_path(
self.displayed_tree().selected_line().path.to_path_buf(),
screen,
tree_options,
PanelPurpose::None,
con,
HDir::Right,
)
}
}
}
Internal::total_search => {
match self.filtered_tree.as_ref().map(|t| t.total_search) {
None => {
CmdResult::error("this verb can be used only after a search")
}
Some(true) => {
CmdResult::error("search was already total: all possible matches have been ranked")
}
Some(false) => {
self.search(self.displayed_tree().options.pattern.clone(), true);
CmdResult::Keep
}
}
}
Internal::quit => CmdResult::Quit,
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
)?,
})
}
More examples
src/app/app.rs (line 392)
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
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(())
}
sourcepub fn needs_counts(&self) -> bool
pub fn needs_counts(&self) -> bool
counts must be computed, either for sorting or just for display
sourcepub fn needs_dates(&self) -> bool
pub fn needs_dates(&self) -> bool
dates must be computed, either for sorting or just for display
sourcepub fn needs_sizes(&self) -> bool
pub fn needs_sizes(&self) -> bool
sizes must be computed, either for sorting or just for display
sourcepub fn needs_sum(&self) -> bool
pub fn needs_sum(&self) -> bool
Examples found in repository?
src/tree/tree.rs (line 182)
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
pub fn after_lines_changed(&mut self) {
// we need to order the lines to build the tree.
// It's a little complicated because
// - we want a case insensitive sort
// - we still don't want to confuse the children of AA and Aa
// - a node can come from a not parent node, when we followed a link
let mut bid_parents: FnvHashMap<BId, BId> = FnvHashMap::default();
let mut bid_lines: FnvHashMap<BId, &TreeLine> = FnvHashMap::default();
for line in self.lines[..].iter() {
if let Some(parent_bid) = line.parent_bid {
bid_parents.insert(line.bid, parent_bid);
}
bid_lines.insert(line.bid, line);
}
let mut sort_paths: FnvHashMap<BId, String> = FnvHashMap::default();
for line in self.lines[1..].iter() {
let mut sort_path = String::new();
let mut bid = line.bid;
while let Some(l) = bid_lines.get(&bid) {
let lower_name = l.path.file_name().map_or(
"".to_string(),
|name| name.to_string_lossy().to_lowercase(),
);
let sort_prefix = match self.options.sort {
Sort::TypeDirsFirst => {
if l.is_dir() {
" "
} else {
l.path.extension().and_then(|s| s.to_str()).unwrap_or("")
}
}
Sort::TypeDirsLast => {
if l.is_dir() {
"~~~~~~~~~~~~~~"
} else {
l.path.extension().and_then(|s| s.to_str()).unwrap_or("")
}
}
_ => { "" }
};
sort_path = format!(
"{}{}-{}/{}",
sort_prefix,
lower_name,
bid.index(), // to be sure to separate paths having the same lowercase
sort_path,
);
if let Some(&parent_bid) = bid_parents.get(&bid) {
bid = parent_bid;
} else {
break;
}
}
sort_paths.insert(line.bid, sort_path);
}
self.lines[1..].sort_by_key(|line| sort_paths.get(&line.bid).unwrap());
let mut best_index = 0; // index of the line with the best score
for i in 1..self.lines.len() {
if self.lines[i].score > self.lines[best_index].score {
best_index = i;
}
for d in 0..self.lines[i].left_branchs.len() {
self.lines[i].left_branchs[d] = false;
}
}
// then we discover the branches (for the drawing)
// and we mark the last children as pruning, if they have unlisted brothers
let mut last_parent_index: usize = self.lines.len() + 1;
for end_index in (1..self.lines.len()).rev() {
let depth = (self.lines[end_index].depth - 1) as usize;
let start_index = {
let parent_index = match self.lines[end_index].parent_bid {
Some(parent_bid) => {
let mut index = end_index;
loop {
index -= 1;
if self.lines[index].bid == parent_bid {
break;
}
if index == 0 {
break;
}
}
index
}
None => end_index, // Should not happen
};
if parent_index != last_parent_index {
// the line at end_index is the last listed child of the line at parent_index
let unlisted = self.lines[parent_index].unlisted;
if unlisted > 0 && self.lines[end_index].nb_kept_children == 0 {
if best_index == end_index {
//debug!("Avoiding to prune the line with best score");
} else {
//debug!("turning {:?} into Pruning", self.lines[end_index].path);
self.lines[end_index].line_type = TreeLineType::Pruning;
self.lines[end_index].unlisted = unlisted + 1;
self.lines[end_index].name = format!("{} unlisted", unlisted + 1);
self.lines[parent_index].unlisted = 0;
}
}
last_parent_index = parent_index;
}
parent_index + 1
};
for i in start_index..=end_index {
self.lines[i].left_branchs[depth] = true;
}
}
if self.options.needs_sum() {
time!("fetch_file_sum", self.fetch_regular_file_sums()); // not the dirs, only simple files
self.sort_siblings(); // does nothing when sort mode is None
}
}
pub fn is_empty(&self) -> bool {
self.lines.len() == 1
}
pub fn has_branch(&self, line_index: usize, depth: usize) -> bool {
if line_index >= self.lines.len() {
return false;
}
let line = &self.lines[line_index];
depth < usize::from(line.depth) && line.left_branchs[depth]
}
/// select another line
///
/// For example the following one if dy is 1.
pub fn move_selection(&mut self, dy: i32, page_height: usize, cycle: bool) {
let l = self.lines.len();
// we find the new line to select
loop {
if dy < 0 {
let ady = (-dy) as usize;
if !cycle && self.selection < ady {
break;
}
self.selection = (self.selection + l - ady) % l;
} else {
let dy = dy as usize;
if !cycle && self.selection + dy >= l {
break;
}
self.selection = (self.selection + dy) % l;
}
if self.lines[self.selection].is_selectable() {
break;
}
}
// we adjust the scroll
if l > page_height {
if self.selection < 3 {
self.scroll = 0;
} else if self.selection < self.scroll + 3 {
self.scroll = self.selection - 3;
} else if self.selection + 3 > l {
self.scroll = l - page_height;
} else if self.selection + 3 > self.scroll + page_height {
self.scroll = self.selection + 3 - page_height;
}
}
}
/// Scroll the desired amount and return true, or return false if it's
/// already at end or the tree fits the page
pub fn try_scroll(&mut self, dy: i32, page_height: usize) -> bool {
if self.lines.len() <= page_height {
return false;
}
if dy < 0 { // scroll up
if self.scroll == 0 {
return false;
} else {
let ady = -dy as usize;
if ady < self.scroll {
self.scroll -= ady;
} else {
self.scroll = 0;
}
}
} else { // scroll down
let max = self.lines.len() - page_height;
if self.scroll >= max {
return false;
}
self.scroll = (self.scroll + dy as usize).min(max);
}
self.select_visible_line(page_height);
true
}
/// try to select a line by index of visible line
/// (works if y+scroll falls on a selectable line)
pub fn try_select_y(&mut self, y: usize) -> bool {
let y = y + self.scroll;
if y < self.lines.len() {
if self.lines[y].is_selectable() {
self.selection = y;
return true;
}
}
false
}
/// fix the selection so that it's a selectable visible line
fn select_visible_line(&mut self, page_height: usize) {
if self.selection < self.scroll || self.selection >= self.scroll + page_height {
self.selection = self.scroll;
let l = self.lines.len();
loop {
self.selection = (self.selection + l + 1) % l;
if self.lines[self.selection].is_selectable() {
break;
}
}
}
}
pub fn make_selection_visible(&mut self, page_height: usize) {
if page_height >= self.lines.len() || self.selection < 3 {
self.scroll = 0;
} else if self.selection <= self.scroll {
self.scroll = self.selection - 2;
} else if self.selection > self.lines.len() - 2 {
self.scroll = self.lines.len() - page_height;
} else if self.selection >= self.scroll + page_height {
self.scroll = self.selection + 2 - page_height;
}
}
pub fn selected_line(&self) -> &TreeLine {
&self.lines[self.selection]
}
pub fn root(&self) -> &PathBuf {
&self.lines[0].path
}
/// select the line with the best matching score
pub fn try_select_best_match(&mut self) {
let mut best_score = 0;
for (idx, line) in self.lines.iter().enumerate() {
if !line.is_selectable() {
continue;
}
if best_score > line.score {
continue;
}
if line.score == best_score {
// in case of equal scores, we prefer the shortest path
if self.lines[idx].depth >= self.lines[self.selection].depth {
continue;
}
}
best_score = line.score;
self.selection = idx;
}
}
/// return true when we could select the given path
pub fn try_select_path(&mut self, path: &Path) -> bool {
for (idx, line) in self.lines.iter().enumerate() {
if !line.is_selectable() {
continue;
}
if path == line.path {
self.selection = idx;
return true;
}
}
false
}
pub fn try_select_first(&mut self) -> bool {
for idx in 0..self.lines.len() {
let line = &self.lines[idx];
if line.is_selectable() {
self.selection = idx;
self.scroll = 0;
return true;
}
}
false
}
pub fn try_select_last(&mut self, page_height: usize) -> bool {
for idx in (0..self.lines.len()).rev() {
let line = &self.lines[idx];
if line.is_selectable() {
self.selection = idx;
self.make_selection_visible(page_height);
return true;
}
}
false
}
pub fn try_select_previous_same_depth(&mut self, page_height: usize) -> bool {
let depth = self.lines[self.selection].depth;
for di in (0..self.lines.len()).rev() {
let idx = (self.selection + di) % self.lines.len();
let line = &self.lines[idx];
if !line.is_selectable() || line.depth != depth {
continue;
}
self.selection = idx;
self.make_selection_visible(page_height);
return true;
}
false
}
pub fn try_select_next_same_depth(&mut self, page_height: usize) -> bool {
let depth = self.lines[self.selection].depth;
for di in 0..self.lines.len() {
let idx = (self.selection + di + 1) % self.lines.len();
let line = &self.lines[idx];
if !line.is_selectable() || line.depth != depth {
continue;
}
self.selection = idx;
self.make_selection_visible(page_height);
return true;
}
false
}
pub fn try_select_previous_filtered<F>(
&mut self,
filter: F,
page_height: usize,
) -> bool where
F: Fn(&TreeLine) -> bool,
{
for di in (0..self.lines.len()).rev() {
let idx = (self.selection + di) % self.lines.len();
let line = &self.lines[idx];
if !line.is_selectable() {
continue;
}
if !filter(line) {
continue;
}
if line.score > 0 {
self.selection = idx;
self.make_selection_visible(page_height);
return true;
}
}
false
}
pub fn try_select_next_filtered<F>(
&mut self,
filter: F,
page_height: usize,
) -> bool where
F: Fn(&TreeLine) -> bool,
{
for di in 0..self.lines.len() {
let idx = (self.selection + di + 1) % self.lines.len();
let line = &self.lines[idx];
if !line.is_selectable() {
continue;
}
if !filter(line) {
continue;
}
if line.score > 0 {
self.selection = idx;
self.make_selection_visible(page_height);
return true;
}
}
false
}
pub fn has_dir_missing_sum(&self) -> bool {
self.options.needs_sum()
&& self
.lines
.iter()
.any(|line| line.line_type == TreeLineType::Dir && line.sum.is_none())
}
sourcepub fn set_date_time_format(&mut self, format: String)
pub fn set_date_time_format(&mut self, format: String)
this method does not exist, you saw nothing (at least don’t call it other than with the config, once)
Examples found in repository?
src/tree/tree_options.rs (line 95)
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
pub fn apply_config(&mut self, config: &Conf) -> Result<(), ConfError> {
if let Some(default_flags) = &config.default_flags {
let flags_args = format!("-{}", default_flags);
let conf_matches = Args::try_parse_from(vec!["broot", &flags_args])
.map_err(|_| ConfError::InvalidDefaultFlags {
flags: default_flags.to_string()
})?;
self.apply_launch_args(&conf_matches);
}
if let Some(b) = config.show_selection_mark {
self.show_selection_mark = b;
}
if let Some(format) = &config.date_time_format {
self.set_date_time_format(format.clone());
}
if let Some(b) = config.show_matching_characters_on_path_searches {
self.show_matching_characters_on_path_searches = b;
}
self.cols_order = config
.cols_order
.as_ref()
.map(Cols::try_from)
.transpose()?
.unwrap_or(DEFAULT_COLS);
Ok(())
}
sourcepub fn apply_config(&mut self, config: &Conf) -> Result<(), ConfError>
pub fn apply_config(&mut self, config: &Conf) -> Result<(), ConfError>
change tree options according to configuration
Examples found in repository?
src/app/app_context.rs (line 144)
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
pub fn from(
launch_args: Args,
verb_store: VerbStore,
config: &Conf,
) -> Result<Self, ProgramError> {
let config_paths = config.files.clone();
let standard_status = StandardStatus::new(&verb_store);
let true_colors = if let Some(value) = config.true_colors {
value
} else {
are_true_colors_available()
};
let icons = config.icon_theme.as_ref()
.and_then(|itn| icon_plugin(itn));
let special_paths = config.special_paths
.iter()
.map(|(k, v)| SpecialPath::new(k.clone(), *v))
.collect();
let search_modes = config
.search_modes
.as_ref()
.map(|map| map.try_into())
.transpose()?
.unwrap_or_default();
let ext_colors = ExtColorMap::try_from(&config.ext_colors)
.map_err(ConfError::from)?;
let file_sum_threads_count = config.file_sum_threads_count
.unwrap_or(file_sum::DEFAULT_THREAD_COUNT);
if file_sum_threads_count < 1 || file_sum_threads_count > 50 {
return Err(ConfError::InvalidThreadsCount{ count: file_sum_threads_count }.into());
}
let max_panels_count = config.max_panels_count
.unwrap_or(2)
.clamp(2, 100);
let capture_mouse = match (config.capture_mouse, config.disable_mouse_capture) {
(Some(b), _) => b, // the new "capture_mouse" argument takes precedence
(_, Some(b)) => !b,
_ => true,
};
let max_staged_count = config.max_staged_count
.unwrap_or(10_000)
.clamp(10, 100_000);
let initial_root = get_root_path(&launch_args)?;
// tree options are built from the default_flags
// found in the config file(s) (if any) then overridden
// by the cli args
let mut initial_tree_options = TreeOptions::default();
initial_tree_options.apply_config(config)?;
initial_tree_options.apply_launch_args(&launch_args);
if launch_args.color == TriBool::No {
initial_tree_options.show_selection_mark = true;
}
let content_search_max_file_size = config.content_search_max_file_size
.map(|u64value| usize::try_from(u64value).unwrap_or(usize::MAX))
.unwrap_or(content_search::DEFAULT_MAX_FILE_SIZE);
Ok(Self {
initial_root,
initial_tree_options,
config_paths,
launch_args,
verb_store,
special_paths,
search_modes,
show_selection_mark: config.show_selection_mark.unwrap_or(false),
ext_colors,
syntax_theme: config.syntax_theme,
standard_status,
true_colors,
icons,
modal: config.modal.unwrap_or(false),
capture_mouse,
max_panels_count,
quit_on_last_cancel: config.quit_on_last_cancel.unwrap_or(false),
file_sum_threads_count,
max_staged_count,
content_search_max_file_size,
})
}
sourcepub fn apply_launch_args(&mut self, cli_args: &Args)
pub fn apply_launch_args(&mut self, cli_args: &Args)
change tree options according to broot launch arguments
Examples found in repository?
src/tree/tree_options.rs (line 89)
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
pub fn apply_config(&mut self, config: &Conf) -> Result<(), ConfError> {
if let Some(default_flags) = &config.default_flags {
let flags_args = format!("-{}", default_flags);
let conf_matches = Args::try_parse_from(vec!["broot", &flags_args])
.map_err(|_| ConfError::InvalidDefaultFlags {
flags: default_flags.to_string()
})?;
self.apply_launch_args(&conf_matches);
}
if let Some(b) = config.show_selection_mark {
self.show_selection_mark = b;
}
if let Some(format) = &config.date_time_format {
self.set_date_time_format(format.clone());
}
if let Some(b) = config.show_matching_characters_on_path_searches {
self.show_matching_characters_on_path_searches = b;
}
self.cols_order = config
.cols_order
.as_ref()
.map(Cols::try_from)
.transpose()?
.unwrap_or(DEFAULT_COLS);
Ok(())
}
More examples
src/app/app_context.rs (line 145)
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
pub fn from(
launch_args: Args,
verb_store: VerbStore,
config: &Conf,
) -> Result<Self, ProgramError> {
let config_paths = config.files.clone();
let standard_status = StandardStatus::new(&verb_store);
let true_colors = if let Some(value) = config.true_colors {
value
} else {
are_true_colors_available()
};
let icons = config.icon_theme.as_ref()
.and_then(|itn| icon_plugin(itn));
let special_paths = config.special_paths
.iter()
.map(|(k, v)| SpecialPath::new(k.clone(), *v))
.collect();
let search_modes = config
.search_modes
.as_ref()
.map(|map| map.try_into())
.transpose()?
.unwrap_or_default();
let ext_colors = ExtColorMap::try_from(&config.ext_colors)
.map_err(ConfError::from)?;
let file_sum_threads_count = config.file_sum_threads_count
.unwrap_or(file_sum::DEFAULT_THREAD_COUNT);
if file_sum_threads_count < 1 || file_sum_threads_count > 50 {
return Err(ConfError::InvalidThreadsCount{ count: file_sum_threads_count }.into());
}
let max_panels_count = config.max_panels_count
.unwrap_or(2)
.clamp(2, 100);
let capture_mouse = match (config.capture_mouse, config.disable_mouse_capture) {
(Some(b), _) => b, // the new "capture_mouse" argument takes precedence
(_, Some(b)) => !b,
_ => true,
};
let max_staged_count = config.max_staged_count
.unwrap_or(10_000)
.clamp(10, 100_000);
let initial_root = get_root_path(&launch_args)?;
// tree options are built from the default_flags
// found in the config file(s) (if any) then overridden
// by the cli args
let mut initial_tree_options = TreeOptions::default();
initial_tree_options.apply_config(config)?;
initial_tree_options.apply_launch_args(&launch_args);
if launch_args.color == TriBool::No {
initial_tree_options.show_selection_mark = true;
}
let content_search_max_file_size = config.content_search_max_file_size
.map(|u64value| usize::try_from(u64value).unwrap_or(usize::MAX))
.unwrap_or(content_search::DEFAULT_MAX_FILE_SIZE);
Ok(Self {
initial_root,
initial_tree_options,
config_paths,
launch_args,
verb_store,
special_paths,
search_modes,
show_selection_mark: config.show_selection_mark.unwrap_or(false),
ext_colors,
syntax_theme: config.syntax_theme,
standard_status,
true_colors,
icons,
modal: config.modal.unwrap_or(false),
capture_mouse,
max_panels_count,
quit_on_last_cancel: config.quit_on_last_cancel.unwrap_or(false),
file_sum_threads_count,
max_staged_count,
content_search_max_file_size,
})
}
Trait Implementations§
source§impl Clone for TreeOptions
impl Clone for TreeOptions
source§fn clone(&self) -> TreeOptions
fn clone(&self) -> TreeOptions
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TreeOptions
impl Debug for TreeOptions
Auto Trait Implementations§
impl RefUnwindSafe for TreeOptions
impl Send for TreeOptions
impl Sync for TreeOptions
impl Unpin for TreeOptions
impl UnwindSafe for TreeOptions
Blanket Implementations§
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for Pwhere
R: Read + ReadEndian<P>,
P: Default,
impl<R, P> ReadPrimitive<R> for Pwhere
R: Read + ReadEndian<P>,
P: Default,
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian()
.