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
mod columnar_menu;
mod description_menu;
mod ide_menu;
mod list_menu;
pub mod menu_functions;
use crate::core_editor::Editor;
use crate::History;
use crate::{completion::history::HistoryCompleter, painting::Painter, Completer, Suggestion};
pub use columnar_menu::ColumnarMenu;
pub use description_menu::DescriptionMenu;
pub use ide_menu::DescriptionMode;
pub use ide_menu::IdeMenu;
pub use list_menu::ListMenu;
use nu_ansi_term::{Color, Style};
/// Struct to store the menu style
pub struct MenuTextStyle {
/// Text style for selected text in a menu
pub selected_text_style: Style,
/// Text style for not selected text in the menu
pub text_style: Style,
/// Text style for the item description
pub description_style: Style,
/// Text style of the parts of the suggestions that match the
/// typed text when the suggestion is selected
pub selected_match_style: Style,
/// Text style of the parts of the suggestions that match the
/// typed text
pub match_style: Style,
}
impl Default for MenuTextStyle {
fn default() -> Self {
Self {
selected_text_style: Color::Green.bold().reverse(),
text_style: Color::DarkGray.normal(),
description_style: Color::Yellow.normal(),
selected_match_style: Color::Green.bold().reverse().underline(),
match_style: Style::default().underline(),
}
}
}
/// Defines all possible events that could happen with a menu.
#[derive(Clone)]
pub enum MenuEvent {
/// Activation event for the menu. When the bool is true it means that the values
/// have already being updated. This is true when the option `quick_completions` is true
Activate(bool),
/// Deactivation event
Deactivate,
/// Line buffer edit event. When the bool is true it means that the values
/// have already being updated. This is true when the option `quick_completions` is true
Edit(bool),
/// Selecting next element in the menu
NextElement,
/// Selecting previous element in the menu
PreviousElement,
/// Moving up in the menu
MoveUp,
/// Moving down in the menu
MoveDown,
/// Moving left in the menu
MoveLeft,
/// Moving right in the menu
MoveRight,
/// Move to next page
NextPage,
/// Move to previous page
PreviousPage,
}
/// Trait that defines how a menu will be printed by the painter
pub trait Menu: Send {
/// Get MenuSettings
fn settings(&self) -> &MenuSettings {
// We panic here, so this function has base implementation
// so existing menus will not break.
// if a breaking change is ok, this can be removed
panic!("`settings` requires a manual implementation per menu. It has a base implementation to not break existing menus")
}
/// Menu name
fn name(&self) -> &str {
&self.settings().name
}
/// Menu indicator
fn indicator(&self) -> &str {
&self.settings().marker
}
/// Checks if the menu is active
fn is_active(&self) -> bool;
/// Selects what type of event happened with the menu
fn menu_event(&mut self, event: MenuEvent);
/// A menu may not be allowed to quick complete because it needs to stay
/// active even with one element
fn can_quick_complete(&self) -> bool;
/// The completion 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;
/// Updates the values presented in the menu
/// This function needs to be defined in the trait because when the menu is
/// activated or the `quick_completion` option is true, the len of the values
/// is calculated to know if there is only one value so it can be selected
/// immediately
fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer);
/// The working details of a menu are values that could change based on
/// the menu conditions before it being printed, such as the number or size
/// of columns, etc.
/// In this function should be defined how the menu event is treated since
/// it is called just before painting the menu
fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
painter: &Painter,
);
/// Indicates how to replace in the line buffer the selected value from the menu
fn replace_in_buffer(&self, editor: &mut Editor);
/// Calculates the real required lines for the menu considering how many lines
/// wrap the terminal or if entries have multiple lines
fn menu_required_lines(&self, terminal_columns: u16) -> u16;
/// Creates the menu representation as a string which will be painted by the painter
fn menu_string(&self, available_lines: u16, use_ansi_coloring: bool) -> String;
/// Minimum rows that should be displayed by the menu
fn min_rows(&self) -> u16;
/// Gets cached values from menu that will be displayed
fn get_values(&self) -> &[Suggestion];
/// Sets the position of the cursor (currently only required by the IDE menu)
fn set_cursor_pos(&mut self, _pos: (u16, u16)) {
// empty implementation to make it optional
}
}
pub struct MenuSettings {
/// Menu name
name: String,
/// Menu coloring
color: MenuTextStyle,
/// Menu marker when active
marker: String,
/// Calls the completer using only the line buffer difference difference
/// after the menu was activated
only_buffer_difference: bool,
}
impl Default for MenuSettings {
fn default() -> Self {
Self {
name: "menu".to_string(),
color: MenuTextStyle::default(),
marker: "| ".to_string(),
only_buffer_difference: false,
}
}
}
impl MenuSettings {
/// MenuSettings builder with name
#[must_use]
pub fn with_name(mut self, name: &str) -> Self {
self.name = name.to_string();
self
}
/// MenuSettings builder with color
#[must_use]
pub fn with_color(mut self, color: MenuTextStyle) -> Self {
self.color = color;
self
}
/// MenuSettings builder with marker
#[must_use]
pub fn with_marker(mut self, marker: &str) -> Self {
self.marker = marker.to_string();
self
}
/// MenuSettings builder with only_buffer_difference
#[must_use]
pub fn with_only_buffer_difference(mut self, only_buffer_difference: bool) -> Self {
self.only_buffer_difference = only_buffer_difference;
self
}
}
/// Common builder for all menus
pub trait MenuBuilder: Menu + Sized {
/// Get mutable MenuSettings
/// required for the builder functions
fn settings_mut(&mut self) -> &mut MenuSettings;
/// Menu builder with new name
#[must_use]
fn with_name(mut self, name: &str) -> Self {
self.settings_mut().name = name.to_string();
self
}
/// Menu builder with new value for text style
#[must_use]
fn with_text_style(mut self, color: Style) -> Self {
self.settings_mut().color.text_style = color;
self
}
/// Menu builder with new value for selected text style
#[must_use]
fn with_selected_text_style(mut self, color: Style) -> Self {
self.settings_mut().color.selected_text_style = color;
self
}
/// Menu builder with new value for description style
#[must_use]
fn with_description_text_style(mut self, color: Style) -> Self {
self.settings_mut().color.description_style = color;
self
}
/// Menu builder with new value for match style
/// This is the style of the part of the input text, the suggestions
/// are based on
#[must_use]
fn with_match_text_style(mut self, color: Style) -> Self {
self.settings_mut().color.match_style = color;
self
}
/// Menu builder with new value for selected match style
/// This is the style of the part of the input text, the suggestions
/// are based on
#[must_use]
fn with_selected_match_text_style(mut self, color: Style) -> Self {
self.settings_mut().color.selected_match_style = color;
self
}
/// Menu builder with new value for marker
#[must_use]
fn with_marker(mut self, marker: &str) -> Self {
self.settings_mut().marker = marker.to_string();
self
}
/// Menu builder with new value for only_buffer_difference
#[must_use]
fn with_only_buffer_difference(mut self, only_buffer_difference: bool) -> Self {
self.settings_mut().only_buffer_difference = only_buffer_difference;
self
}
}
/// Allowed menus in Reedline
pub enum ReedlineMenu {
/// Menu that uses Reedline's completer to update its values
EngineCompleter(Box<dyn Menu>),
/// Menu that uses the history as its completer
HistoryMenu(Box<dyn Menu>),
/// Menu that has its own Completer
WithCompleter {
/// Base menu
menu: Box<dyn Menu>,
/// External completer defined outside Reedline
completer: Box<dyn Completer>,
},
}
impl ReedlineMenu {
fn as_ref(&self) -> &dyn Menu {
match self {
Self::EngineCompleter(menu)
| Self::HistoryMenu(menu)
| Self::WithCompleter { menu, .. } => menu.as_ref(),
}
}
fn as_mut(&mut self) -> &mut dyn Menu {
match self {
Self::EngineCompleter(menu)
| Self::HistoryMenu(menu)
| Self::WithCompleter { menu, .. } => menu.as_mut(),
}
}
pub(crate) fn can_partially_complete(
&mut self,
values_updated: bool,
editor: &mut Editor,
completer: &mut dyn Completer,
history: &dyn History,
) -> bool {
match self {
Self::EngineCompleter(menu) => {
menu.can_partially_complete(values_updated, editor, completer)
}
Self::HistoryMenu(menu) => {
let mut history_completer = HistoryCompleter::new(history);
menu.can_partially_complete(values_updated, editor, &mut history_completer)
}
Self::WithCompleter {
menu,
completer: own_completer,
} => menu.can_partially_complete(values_updated, editor, own_completer.as_mut()),
}
}
pub(crate) fn update_values(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
history: &dyn History,
) {
match self {
Self::EngineCompleter(menu) => menu.update_values(editor, completer),
Self::HistoryMenu(menu) => {
let mut history_completer = HistoryCompleter::new(history);
menu.update_values(editor, &mut history_completer);
}
Self::WithCompleter {
menu,
completer: own_completer,
} => {
menu.update_values(editor, own_completer.as_mut());
}
}
}
pub(crate) fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
history: &dyn History,
painter: &Painter,
) {
match self {
Self::EngineCompleter(menu) => {
menu.update_working_details(editor, completer, painter);
}
Self::HistoryMenu(menu) => {
let mut history_completer = HistoryCompleter::new(history);
menu.update_working_details(editor, &mut history_completer, painter);
}
Self::WithCompleter {
menu,
completer: own_completer,
} => {
menu.update_working_details(editor, own_completer.as_mut(), painter);
}
}
}
}
impl Menu for ReedlineMenu {
fn settings(&self) -> &MenuSettings {
self.as_ref().settings()
}
fn name(&self) -> &str {
self.as_ref().name()
}
fn indicator(&self) -> &str {
self.as_ref().indicator()
}
fn is_active(&self) -> bool {
self.as_ref().is_active()
}
fn menu_event(&mut self, event: MenuEvent) {
self.as_mut().menu_event(event);
}
fn can_quick_complete(&self) -> bool {
self.as_ref().can_quick_complete()
}
fn can_partially_complete(
&mut self,
values_updated: bool,
editor: &mut Editor,
completer: &mut dyn Completer,
) -> bool {
match self {
Self::EngineCompleter(menu) | Self::HistoryMenu(menu) => {
menu.can_partially_complete(values_updated, editor, completer)
}
Self::WithCompleter {
menu,
completer: own_completer,
} => menu.can_partially_complete(values_updated, editor, own_completer.as_mut()),
}
}
fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer) {
match self {
Self::EngineCompleter(menu) | Self::HistoryMenu(menu) => {
menu.update_values(editor, completer);
}
Self::WithCompleter {
menu,
completer: own_completer,
} => {
menu.update_values(editor, own_completer.as_mut());
}
}
}
fn update_working_details(
&mut self,
editor: &mut Editor,
completer: &mut dyn Completer,
painter: &Painter,
) {
match self {
Self::EngineCompleter(menu) | Self::HistoryMenu(menu) => {
menu.update_working_details(editor, completer, painter);
}
Self::WithCompleter {
menu,
completer: own_completer,
} => {
menu.update_working_details(editor, own_completer.as_mut(), painter);
}
}
}
fn replace_in_buffer(&self, editor: &mut Editor) {
self.as_ref().replace_in_buffer(editor);
}
fn menu_required_lines(&self, terminal_columns: u16) -> u16 {
self.as_ref().menu_required_lines(terminal_columns)
}
fn menu_string(&self, available_lines: u16, use_ansi_coloring: bool) -> String {
self.as_ref()
.menu_string(available_lines, use_ansi_coloring)
}
fn min_rows(&self) -> u16 {
self.as_ref().min_rows()
}
fn get_values(&self) -> &[Suggestion] {
self.as_ref().get_values()
}
fn set_cursor_pos(&mut self, pos: (u16, u16)) {
self.as_mut().set_cursor_pos(pos);
}
}