diff options
Diffstat (limited to 'src/components/help.rs')
| -rw-r--r-- | src/components/help.rs | 446 |
1 files changed, 223 insertions, 223 deletions
diff --git a/src/components/help.rs b/src/components/help.rs index 6715f8d8..3a4ea6ea 100644 --- a/src/components/help.rs +++ b/src/components/help.rs @@ -1,6 +1,6 @@ use super::{ - visibility_blocking, CommandBlocking, CommandInfo, Component, - DrawableComponent, EventState, + visibility_blocking, CommandBlocking, CommandInfo, Component, + DrawableComponent, EventState, }; use crate::{keys::SharedKeyConfig, strings, ui, version::Version}; use anyhow::Result; @@ -9,239 +9,239 @@ use crossterm::event::Event; use itertools::Itertools; use std::{borrow::Cow, cmp, convert::TryFrom}; use tui::{ - backend::Backend, - layout::{Alignment, Constraint, Direction, Layout, Rect}, - style::{Modifier, Style}, - text::{Span, Spans}, - widgets::{Block, BorderType, Borders, Clear, Paragraph}, - Frame, + backend::Backend, + layout::{Alignment, Constraint, Direction, Layout, Rect}, + style::{Modifier, Style}, + text::{Span, Spans}, + widgets::{Block, BorderType, Borders, Clear, Paragraph}, + Frame, }; use ui::style::SharedTheme; /// pub struct HelpComponent { - cmds: Vec<CommandInfo>, - visible: bool, - selection: u16, - theme: SharedTheme, - key_config: SharedKeyConfig, + cmds: Vec<CommandInfo>, + visible: bool, + selection: u16, + theme: SharedTheme, + key_config: SharedKeyConfig, } impl DrawableComponent for HelpComponent { - fn draw<B: Backend>( - &self, - f: &mut Frame<B>, - _rect: Rect, - ) -> Result<()> { - if self.visible { - const SIZE: (u16, u16) = (65, 24); - let scroll_threshold = SIZE.1 / 3; - let scroll = - self.selection.saturating_sub(scroll_threshold); - - let area = - ui::centered_rect_absolute(SIZE.0, SIZE.1, f.size()); - - f.render_widget(Clear, area); - f.render_widget( - Block::default() - .title(strings::help_title(&self.key_config)) - .borders(Borders::ALL) - .border_type(BorderType::Thick), - area, - ); - - let chunks = Layout::default() - .vertical_margin(1) - .horizontal_margin(1) - .direction(Direction::Vertical) - .constraints( - [Constraint::Min(1), Constraint::Length(1)] - .as_ref(), - ) - .split(area); - - f.render_widget( - Paragraph::new(self.get_text()) - .scroll((scroll, 0)) - .alignment(Alignment::Left), - chunks[0], - ); - - f.render_widget( - Paragraph::new(Spans::from(vec![Span::styled( - Cow::from(format!("gitui {}", Version::new(),)), - Style::default(), - )])) - .alignment(Alignment::Right), - chunks[1], - ); - } - - Ok(()) - } + fn draw<B: Backend>( + &self, + f: &mut Frame<B>, + _rect: Rect, + ) -> Result<()> { + if self.visible { + const SIZE: (u16, u16) = (65, 24); + let scroll_threshold = SIZE.1 / 3; + let scroll = + self.selection.saturating_sub(scroll_threshold); + + let area = + ui::centered_rect_absolute(SIZE.0, SIZE.1, f.size()); + + f.render_widget(Clear, area); + f.render_widget( + Block::default() + .title(strings::help_title(&self.key_config)) + .borders(Borders::ALL) + .border_type(BorderType::Thick), + area, + ); + + let chunks = Layout::default() + .vertical_margin(1) + .horizontal_margin(1) + .direction(Direction::Vertical) + .constraints( + [Constraint::Min(1), Constraint::Length(1)] + .as_ref(), + ) + .split(area); + + f.render_widget( + Paragraph::new(self.get_text()) + .scroll((scroll, 0)) + .alignment(Alignment::Left), + chunks[0], + ); + + f.render_widget( + Paragraph::new(Spans::from(vec![Span::styled( + Cow::from(format!("gitui {}", Version::new(),)), + Style::default(), + )])) + .alignment(Alignment::Right), + chunks[1], + ); + } + + Ok(()) + } } impl Component for HelpComponent { - fn commands( - &self, - out: &mut Vec<CommandInfo>, - force_all: bool, - ) -> CommandBlocking { - // only if help is open we have no other commands available - if self.visible && !force_all { - out.clear(); - } - - if self.visible { - out.push(CommandInfo::new( - strings::commands::scroll(&self.key_config), - true, - true, - )); - - out.push(CommandInfo::new( - strings::commands::close_popup(&self.key_config), - true, - true, - )); - } - - if !self.visible || force_all { - out.push( - CommandInfo::new( - strings::commands::help_open(&self.key_config), - true, - true, - ) - .order(99), - ); - } - - visibility_blocking(self) - } - - fn event(&mut self, ev: Event) -> Result<EventState> { - if self.visible { - if let Event::Key(e) = ev { - if e == self.key_config.exit_popup { - self.hide(); - } else if e == self.key_config.move_down { - self.move_selection(true); - } else if e == self.key_config.move_up { - self.move_selection(false); - } else { - } - } - - Ok(EventState::Consumed) - } else if let Event::Key(k) = ev { - if k == self.key_config.open_help { - self.show()?; - Ok(EventState::Consumed) - } else { - Ok(EventState::NotConsumed) - } - } else { - Ok(EventState::NotConsumed) - } - } - - fn is_visible(&self) -> bool { - self.visible - } - - fn hide(&mut self) { - self.visible = false; - } - - fn show(&mut self) -> Result<()> { - self.visible = true; - - Ok(()) - } + fn commands( + &self, + out: &mut Vec<CommandInfo>, + force_all: bool, + ) -> CommandBlocking { + // only if help is open we have no other commands available + if self.visible && !force_all { + out.clear(); + } + + if self.visible { + out.push(CommandInfo::new( + strings::commands::scroll(&self.key_config), + true, + true, + )); + + out.push(CommandInfo::new( + strings::commands::close_popup(&self.key_config), + true, + true, + )); + } + + if !self.visible || force_all { + out.push( + CommandInfo::new( + strings::commands::help_open(&self.key_config), + true, + true, + ) + .order(99), + ); + } + + visibility_blocking(self) + } + + fn event(&mut self, ev: Event) -> Result<EventState> { + if self.visible { + if let Event::Key(e) = ev { + if e == self.key_config.exit_popup { + self.hide(); + } else if e == self.key_config.move_down { + self.move_selection(true); + } else if e == self.key_config.move_up { + self.move_selection(false); + } else { + } + } + + Ok(EventState::Consumed) + } else if let Event::Key(k) = ev { + if k == self.key_config.open_help { + self.show()?; + Ok(EventState::Consumed) + } else { + Ok(EventState::NotConsumed) + } + } else { + Ok(EventState::NotConsumed) + } + } + + fn is_visible(&self) -> bool { + self.visible + } + + fn hide(&mut self) { + self.visible = false; + } + + fn show(&mut self) -> Result<()> { + self.visible = true; + + Ok(()) + } } impl HelpComponent { - pub const fn new( - theme: SharedTheme, - key_config: SharedKeyConfig, - ) -> Self { - Self { - cmds: vec![], - visible: false, - selection: 0, - theme, - key_config, - } - } - /// - pub fn set_cmds(&mut self, cmds: Vec<CommandInfo>) { - self.cmds = cmds - .into_iter() - .filter(|e| !e.text.hide_help) - .collect::<Vec<_>>(); - self.cmds.sort_by_key(|e| e.text.clone()); - self.cmds.dedup_by_key(|e| e.text.clone()); - self.cmds.sort_by_key(|e| hash(&e.text.group)); - } - - fn move_selection(&mut self, inc: bool) { - let mut new_selection = self.selection; - - new_selection = if inc { - new_selection.saturating_add(1) - } else { - new_selection.saturating_sub(1) - }; - new_selection = cmp::max(new_selection, 0); - - if let Ok(max) = - u16::try_from(self.cmds.len().saturating_sub(1)) - { - self.selection = cmp::min(new_selection, max); - } - } - - fn get_text(&self) -> Vec<Spans> { - let mut txt: Vec<Spans> = Vec::new(); - - let mut processed = 0_u16; - - for (key, group) in - &self.cmds.iter().group_by(|e| e.text.group) - { - txt.push(Spans::from(Span::styled( - Cow::from(key.to_string()), - Style::default().add_modifier(Modifier::REVERSED), - ))); - - for command_info in group { - let is_selected = self.selection == processed; - - processed += 1; - - txt.push(Spans::from(Span::styled( - Cow::from(if is_selected { - format!(">{}", command_info.text.name) - } else { - format!(" {}", command_info.text.name) - }), - self.theme.text(true, is_selected), - ))); - - if is_selected { - txt.push(Spans::from(Span::styled( - Cow::from(format!( - " {}\n", - command_info.text.desc - )), - self.theme.text(true, is_selected), - ))); - } - } - } - - txt - } + pub const fn new( + theme: SharedTheme, + key_config: SharedKeyConfig, + ) -> Self { + Self { + cmds: vec![], + visible: false, + selection: 0, + theme, + key_config, + } + } + /// + pub fn set_cmds(&mut self, cmds: Vec<CommandInfo>) { + self.cmds = cmds + .into_iter() + .filter(|e| !e.text.hide_help) + .collect::<Vec<_>>(); + self.cmds.sort_by_key(|e| e.text.clone()); + self.cmds.dedup_by_key(|e| e.text.clone()); + self.cmds.sort_by_key(|e| hash(&e.text.group)); + } + + fn move_selection(&mut self, inc: bool) { + let mut new_selection = self.selection; + + new_selection = if inc { + new_selection.saturating_add(1) + } else { + new_selection.saturating_sub(1) + }; + new_selection = cmp::max(new_selection, 0); + + if let Ok(max) = + u16::try_from(self.cmds.len().saturating_sub(1)) + { + self.selection = cmp::min(new_selection, max); + } + } + + fn get_text(&self) -> Vec<Spans> { + let mut txt: Vec<Spans> = Vec::new(); + + let mut processed = 0_u16; + + for (key, group) in + &self.cmds.iter().group_by(|e| e.text.group) + { + txt.push(Spans::from(Span::styled( + Cow::from(key.to_string()), + Style::default().add_modifier(Modifier::REVERSED), + ))); + + for command_info in group { + let is_selected = self.selection == processed; + + processed += 1; + + txt.push(Spans::from(Span::styled( + Cow::from(if is_selected { + format!(">{}", command_info.text.name) + } else { + format!(" {}", command_info.text.name) + }), + self.theme.text(true, is_selected), + ))); + + if is_selected { + txt.push(Spans::from(Span::styled( + Cow::from(format!( + " {}\n", + command_info.text.desc + )), + self.theme.text(true, is_selected), + ))); + } + } + } + + txt + } } |