1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
use super::{Menu, MenuBuilder, MenuEvent, MenuSettings};
use crate::{
core_editor::Editor,
menu_functions::{can_partially_complete, completer_input, replace_in_buffer},
painting::Painter,
Completer, Suggestion,
};
use nu_ansi_term::ansi::RESET;
use unicode_width::UnicodeWidthStr;
/// Default values used as reference for the menu. These values are set during
/// the initial declaration of the menu and are always kept as reference for the
/// changeable [`ColumnDetails`]
struct DefaultColumnDetails {
/// Number of columns that the menu will have
pub columns: u16,
/// Column width
pub col_width: Option<usize>,
/// Column padding
pub col_padding: usize,
}
impl Default for DefaultColumnDetails {
fn default() -> Self {
Self {
columns: 4,
col_width: None,
col_padding: 2,
}
}
}
/// Represents the actual column conditions of the menu. These conditions change
/// since they need to accommodate possible different line sizes for the column values
#[derive(Default)]
struct ColumnDetails {
/// Number of columns that the menu will have
pub columns: u16,
/// Column width
pub col_width: usize,
/// The shortest of the strings, which the suggestions are based on
pub shortest_base_string: String,
}
/// Menu to present suggestions in a columnar fashion
/// It presents a description of the suggestion if available
pub struct ColumnarMenu {
/// Menu settings
settings: MenuSettings,
/// Columnar menu active status
active: bool,
/// Default column details that are set when creating the menu
/// These values are the reference for the working details
default_details: DefaultColumnDetails,
/// Number of minimum rows that are displayed when
/// the required lines is larger than the available lines
min_rows: u16,
/// Working column details keep changing based on the collected values
working_details: ColumnDetails,
/// Menu cached values
values: Vec<Suggestion>,
/// column position of the cursor. Starts from 0
col_pos: u16,
/// row position in the menu. Starts from 0
row_pos: u16,
/// Event sent to the menu
event: Option<MenuEvent>,
/// Longest suggestion found in the values
longest_suggestion: usize,
/// String collected after the menu is activated
input: Option<String>,
}
impl Default for ColumnarMenu {
fn default() -> Self {
Self {
settings: MenuSettings::default().with_name("columnar_menu"),
active: false,
default_details: DefaultColumnDetails::default(),
min_rows: 3,
working_details: ColumnDetails::default(),
values: Vec::new(),
col_pos: 0,
row_pos: 0,
event: None,
longest_suggestion: 0,
input: None,
}
}
}
// Menu configuration functions
impl MenuBuilder for ColumnarMenu {
fn settings_mut(&mut self) -> &mut MenuSettings {
&mut self.settings
}
}
// Menu specific configuration functions
impl ColumnarMenu {
/// Menu builder with new columns value
#[must_use]
pub fn with_columns(mut self, columns: u16) -> Self {
self.default_details.columns = columns;
self
}
/// Menu builder with new column width value
#[must_use]
pub fn with_column_width(mut self, col_width: Option<usize>) -> Self {
self.default_details.col_width = col_width;
self
}
/// Menu builder with new column width value
#[must_use]
pub fn with_column_padding(mut self, col_padding: usize) -> Self {
self.default_details.col_padding = col_padding;
self
}
}
// Menu functionality
impl ColumnarMenu {
/// Move menu cursor to the next element
fn move_next(&mut self) {
let mut new_col = self.col_pos + 1;
let mut new_row = self.row_pos;
if new_col >= self.get_cols() {
new_row += 1;
new_col = 0;
}
if new_row >= self.get_rows() {
new_row = 0;
new_col = 0;
}
let position = new_row * self.get_cols() + new_col;
if position >= self.get_values().len() as u16 {
self.reset_position();
} else {
self.col_pos = new_col;
self.row_pos = new_row;
}
}
/// Move menu cursor to the previous element
fn move_previous(&mut self) {
let new_col = self.col_pos.checked_sub(1);
let (new_col, new_row) = match new_col {
Some(col) => (col, self.row_pos),
None => match self.row_pos.checked_sub(1) {
Some(row) => (self.get_cols().saturating_sub(1), row),
None => (
self.get_cols().saturating_sub(1),
self.get_rows().saturating_sub(1),
),
},
};
let position = new_row * self.get_cols() + new_col;
if position >= self.get_values().len() as u16 {
self.col_pos = (self.get_values().len() as u16 % self.get_cols()).saturating_sub(1);
self.row_pos = self.get_rows().saturating_sub(1);
} else {
self.col_pos = new_col;
self.row_pos = new_row;
}
}
/// Move menu cursor up
fn move_up(&mut self) {
self.row_pos = if let Some(new_row) = self.row_pos.checked_sub(1) {
new_row
} else {
let new_row = self.get_rows().saturating_sub(1);
let index = new_row * self.get_cols() + self.col_pos;
if index >= self.values.len() as u16 {
new_row.saturating_sub(1)
} else {
new_row
}
}
}
/// Move menu cursor left
fn move_down(&mut self) {
let new_row = self.row_pos + 1;
self.row_pos = if new_row >= self.get_rows() {
0
} else {
let index = new_row * self.get_cols() + self.col_pos;
if index >= self.values.len() as u16 {
0
} else {
new_row
}
}
}
/// Move menu cursor left
fn move_left(&mut self) {
self.col_pos = if let Some(row) = self.col_pos.checked_sub(1) {
row
} else if self.index() + 1 == self.values.len() {
0
} else {
self.get_cols().saturating_sub(1)
}
}
/// Move menu cursor element
fn move_right(&mut self) {
let new_col = self.col_pos + 1;
self.col_pos = if new_col >= self.get_cols() || self.index() + 2 > self.values.len() {
0
} else {
new_col
}
}
/// Menu index based on column and row position
fn index(&self) -> usize {
let index = self.row_pos * self.get_cols() + self.col_pos;
index as usize
}
/// Get selected value from the menu
fn get_value(&self) -> Option<Suggestion> {
self.get_values().get(self.index()).cloned()
}
/// Calculates how many rows the Menu will use
fn get_rows(&self) -> u16 {
let values = self.get_values().len() as u16;
if values == 0 {
// When the values are empty the no_records_msg is shown, taking 1 line
return 1;
}
let rows = values / self.get_cols();
if values % self.get_cols() != 0 {
rows + 1
} else {
rows
}
}
/// Returns working details col width
fn get_width(&self) -> usize {
self.working_details.col_width
}
/// Reset menu position
fn reset_position(&mut self) {
self.col_pos = 0;
self.row_pos = 0;
}
fn no_records_msg(&self, use_ansi_coloring: bool) -> String {
let msg = "NO RECORDS FOUND";
if use_ansi_coloring {
format!(
"{}{}{}",
self.settings.color.selected_text_style.prefix(),
msg,
RESET
)
} else {
msg.to_string()
}
}
/// Returns working details columns
fn get_cols(&self) -> u16 {
self.working_details.columns.max(1)
}
/// End of line for menu
fn end_of_line(&self, column: u16) -> &str {
if column == self.get_cols().saturating_sub(1) {
"\r\n"
} else {
""
}
}
/// Creates default string that represents one suggestion from the menu
fn create_string(
&self,
suggestion: &Suggestion,
index: usize,
column: u16,
empty_space: usize,
use_ansi_coloring: bool,
) -> String {
if use_ansi_coloring {
let match_len = self.working_details.shortest_base_string.len();
// Split string so the match text can be styled
let (match_str, remaining_str) = suggestion.value.split_at(match_len);
let suggestion_style_prefix = suggestion
.style
.unwrap_or(self.settings.color.text_style)
.prefix();
let left_text_size = self.longest_suggestion + self.default_details.col_padding;
let right_text_size = self.get_width().saturating_sub(left_text_size);
let max_remaining = left_text_size.saturating_sub(match_str.width());
let max_match = max_remaining.saturating_sub(remaining_str.width());
if index == self.index() {
if let Some(description) = &suggestion.description {
format!(
"{}{}{}{}{}{:max_match$}{:max_remaining$}{}{}{}{}{}{}",
suggestion_style_prefix,
self.settings.color.selected_match_style.prefix(),
match_str,
RESET,
suggestion_style_prefix,
self.settings.color.selected_text_style.prefix(),
&remaining_str,
RESET,
self.settings.color.description_style.prefix(),
self.settings.color.selected_text_style.prefix(),
description
.chars()
.take(right_text_size)
.collect::<String>()
.replace('\n', " "),
RESET,
self.end_of_line(column),
)
} else {
format!(
"{}{}{}{}{}{}{}{}{:>empty$}{}",
suggestion_style_prefix,
self.settings.color.selected_match_style.prefix(),
match_str,
RESET,
suggestion_style_prefix,
self.settings.color.selected_text_style.prefix(),
remaining_str,
RESET,
"",
self.end_of_line(column),
empty = empty_space,
)
}
} else if let Some(description) = &suggestion.description {
format!(
"{}{}{}{}{:max_match$}{:max_remaining$}{}{}{}{}{}",
suggestion_style_prefix,
self.settings.color.match_style.prefix(),
match_str,
RESET,
suggestion_style_prefix,
remaining_str,
RESET,
self.settings.color.description_style.prefix(),
description
.chars()
.take(right_text_size)
.collect::<String>()
.replace('\n', " "),
RESET,
self.end_of_line(column),
)
} else {
format!(
"{}{}{}{}{}{}{}{}{:>empty$}{}{}",
suggestion_style_prefix,
self.settings.color.match_style.prefix(),
match_str,
RESET,
suggestion_style_prefix,
remaining_str,
RESET,
self.settings.color.description_style.prefix(),
"",
RESET,
self.end_of_line(column),
empty = empty_space,
)
}
} else {
// If no ansi coloring is found, then the selection word is the line in uppercase
let marker = if index == self.index() { ">" } else { "" };
let line = if let Some(description) = &suggestion.description {
format!(
"{}{:max$}{}{}",
marker,
&suggestion.value,
description
.chars()
.take(empty_space)
.collect::<String>()
.replace('\n', " "),
self.end_of_line(column),
max = self.longest_suggestion
+ self
.default_details
.col_padding
.saturating_sub(marker.len()),
)
} else {
format!(
"{}{}{:>empty$}{}",
marker,
&suggestion.value,
"",
self.end_of_line(column),
empty = empty_space.saturating_sub(marker.len()),
)
};
if index == self.index() {
line.to_uppercase()
} else {
line
}
}
}
}
impl Menu for ColumnarMenu {
/// Menu settings
fn settings(&self) -> &MenuSettings {
&self.settings
}
/// Deactivates context menu
fn is_active(&self) -> bool {
self.active
}
/// The columnar menu can to quick complete if there is only one element
fn can_quick_complete(&self) -> bool {
true
}
/// The columnar menu can try to find the common string and replace it
/// in the given line buffer
fn can_partially_complete(
&mut self,
values_updated: bool,
editor: &mut Editor,
completer: &mut dyn Completer,
) -> bool {
// If the values were already updated (e.g. quick completions are true)
// there is no need to update the values from the menu
if !values_updated {
self.update_values(editor, completer);
}
if can_partially_complete(self.get_values(), editor) {
// The values need to be updated because the spans need to be
// recalculated for accurate replacement in the string
self.update_values(editor, completer);
true
} else {
false
}
}
/// Selects what type of event happened with the menu
fn menu_event(&mut self, event: MenuEvent) {
match &event {
MenuEvent::Activate(_) => self.active = true,
MenuEvent::Deactivate => {
self.active = false;
self.input = None;
}
_ => {}
}
self.event = Some(event);
}
/// Updates menu values
fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer) {
let (input, pos) = completer_input(
editor.get_buffer(),
editor.insertion_point(),
self.input.as_deref(),
self.settings.only_buffer_difference,
);
let (values, base_ranges) = completer.complete_with_base_ranges(&input, pos);
self.values = values;
self.working_details.shortest_base_string = base_ranges
.iter()
.map(|range| editor.get_buffer()[range.clone()].to_string())
.min_by_key(|s| s.len())
.unwrap_or_default();
self.reset_position();
}
/// The working details for the menu changes based on the size of the lines
/// collected from the completer
fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
painter: &Painter,
) {
if let Some(event) = self.event.take() {
// The working value for the menu are updated first before executing any of the
// menu events
//
// If there is at least one suggestion that contains a description, then the layout
// is changed to one column to fit the description
let exist_description = self
.get_values()
.iter()
.any(|suggestion| suggestion.description.is_some());
if exist_description {
self.working_details.columns = 1;
self.working_details.col_width = painter.screen_width() as usize;
self.longest_suggestion = self.get_values().iter().fold(0, |prev, suggestion| {
if prev >= suggestion.value.len() {
prev
} else {
suggestion.value.len()
}
});
} else {
let max_width = self.get_values().iter().fold(0, |acc, suggestion| {
let str_len = suggestion.value.len() + self.default_details.col_padding;
if str_len > acc {
str_len
} else {
acc
}
});
// If no default width is found, then the total screen width is used to estimate
// the column width based on the default number of columns
let default_width = if let Some(col_width) = self.default_details.col_width {
col_width
} else {
let col_width = painter.screen_width() / self.default_details.columns;
col_width as usize
};
// Adjusting the working width of the column based the max line width found
// in the menu values
if max_width > default_width {
self.working_details.col_width = max_width;
} else {
self.working_details.col_width = default_width;
};
// The working columns is adjusted based on possible number of columns
// that could be fitted in the screen with the calculated column width
let possible_cols = painter.screen_width() / self.working_details.col_width as u16;
if possible_cols > self.default_details.columns {
self.working_details.columns = self.default_details.columns.max(1);
} else {
self.working_details.columns = possible_cols;
}
}
match event {
MenuEvent::Activate(updated) => {
self.active = true;
self.reset_position();
self.input = if self.settings.only_buffer_difference {
Some(editor.get_buffer().to_string())
} else {
None
};
if !updated {
self.update_values(editor, completer);
}
}
MenuEvent::Deactivate => self.active = false,
MenuEvent::Edit(updated) => {
self.reset_position();
if !updated {
self.update_values(editor, completer);
}
}
MenuEvent::NextElement => self.move_next(),
MenuEvent::PreviousElement => self.move_previous(),
MenuEvent::MoveUp => self.move_up(),
MenuEvent::MoveDown => self.move_down(),
MenuEvent::MoveLeft => self.move_left(),
MenuEvent::MoveRight => self.move_right(),
MenuEvent::PreviousPage | MenuEvent::NextPage => {
// The columnar menu doest have the concept of pages, yet
}
}
}
}
/// The buffer gets replaced in the Span location
fn replace_in_buffer(&self, editor: &mut Editor) {
replace_in_buffer(self.get_value(), editor);
}
/// Minimum rows that should be displayed by the menu
fn min_rows(&self) -> u16 {
self.get_rows().min(self.min_rows)
}
/// Gets values from filler that will be displayed in the menu
fn get_values(&self) -> &[Suggestion] {
&self.values
}
fn menu_required_lines(&self, _terminal_columns: u16) -> u16 {
self.get_rows()
}
fn menu_string(&self, available_lines: u16, use_ansi_coloring: bool) -> String {
if self.get_values().is_empty() {
self.no_records_msg(use_ansi_coloring)
} else {
// The skip values represent the number of lines that should be skipped
// while printing the menu
let skip_values = if self.row_pos >= available_lines {
let skip_lines = self.row_pos.saturating_sub(available_lines) + 1;
(skip_lines * self.get_cols()) as usize
} else {
0
};
// It seems that crossterm prefers to have a complete string ready to be printed
// rather than looping through the values and printing multiple things
// This reduces the flickering when printing the menu
let available_values = (available_lines * self.get_cols()) as usize;
self.get_values()
.iter()
.skip(skip_values)
.take(available_values)
.enumerate()
.map(|(index, suggestion)| {
// Correcting the enumerate index based on the number of skipped values
let index = index + skip_values;
let column = index as u16 % self.get_cols();
let empty_space = self.get_width().saturating_sub(suggestion.value.len());
self.create_string(suggestion, index, column, empty_space, use_ansi_coloring)
})
.collect()
}
}
}
#[cfg(test)]
mod tests {
use crate::{Span, UndoBehavior};
use super::*;
macro_rules! partial_completion_tests {
(name: $test_group_name:ident, completions: $completions:expr, test_cases: $($name:ident: $value:expr,)*) => {
mod $test_group_name {
use crate::{menu::Menu, ColumnarMenu, core_editor::Editor, enums::UndoBehavior};
use super::FakeCompleter;
$(
#[test]
fn $name() {
let (input, expected) = $value;
let mut menu = ColumnarMenu::default();
let mut editor = Editor::default();
editor.set_buffer(input.to_string(), UndoBehavior::CreateUndoPoint);
let mut completer = FakeCompleter::new(&$completions);
menu.can_partially_complete(false, &mut editor, &mut completer);
assert_eq!(editor.get_buffer(), expected);
}
)*
}
}
}
partial_completion_tests! {
name: partial_completion_prefix_matches,
completions: ["build.rs", "build-all.sh"],
test_cases:
empty_completes_prefix: ("", "build"),
partial_completes_shared_prefix: ("bui", "build"),
full_prefix_completes_nothing: ("build", "build"),
}
partial_completion_tests! {
name: partial_completion_fuzzy_matches,
completions: ["build.rs", "build-all.sh", "prepare-build.sh"],
test_cases:
no_shared_prefix_completes_nothing: ("", ""),
shared_prefix_completes_nothing: ("bui", "bui"),
}
partial_completion_tests! {
name: partial_completion_fuzzy_same_prefix_matches,
completions: ["build.rs", "build-all.sh", "build-all-tests.sh"],
test_cases:
// assure "all" does not get replaced with shared prefix "build"
completes_no_shared_prefix: ("all", "all"),
}
struct FakeCompleter {
completions: Vec<String>,
}
impl FakeCompleter {
fn new(completions: &[&str]) -> Self {
Self {
completions: completions.iter().map(|c| c.to_string()).collect(),
}
}
}
impl Completer for FakeCompleter {
fn complete(&mut self, _line: &str, pos: usize) -> Vec<Suggestion> {
self.completions
.iter()
.map(|c| fake_suggestion(c, pos))
.collect()
}
}
fn fake_suggestion(name: &str, pos: usize) -> Suggestion {
Suggestion {
value: name.to_string(),
description: None,
style: None,
extra: None,
span: Span { start: 0, end: pos },
append_whitespace: false,
}
}
#[test]
fn test_menu_replace_backtick() {
// https://github.com/nushell/nushell/issues/7885
let mut completer = FakeCompleter::new(&["file1.txt", "file2.txt"]);
let mut menu = ColumnarMenu::default().with_name("testmenu");
let mut editor = Editor::default();
// backtick at the end of the line
editor.set_buffer("file1.txt`".to_string(), UndoBehavior::CreateUndoPoint);
menu.update_values(&mut editor, &mut completer);
menu.replace_in_buffer(&mut editor);
// After replacing the editor, make sure insertion_point is at the right spot
assert!(
editor.is_cursor_at_buffer_end(),
"cursor should be at the end after completion"
);
}
}