Add Go to line feature for the blame view

Add new stackable popup to get a line number to go to from the user

Add a new internal event to change the selection in the most recent
blame view as a result of using the go to line popup

Add new keybinding for the go to line functionality (Shift-L)

Add boolean to BlameFilePopup to check whether the view is currently
shadowed by the go to line popup and, if so, let the key events bubble
up to the go to line popup

Add new command definition for the go to line functionality in BlameFilePopup

Add clamping of the selected row in set_open_selection

Author: andrea-berling

src/app.rs

@@ -10,14 +10,15 @@ use crate::{
 	options::{Options, SharedOptions},
 	popup_stack::PopupStack,
 	popups::{
-		AppOption, BlameFilePopup, BranchListPopup, CommitPopup,
-		CompareCommitsPopup, ConfirmPopup, CreateBranchPopup,
-		ExternalEditorPopup, FetchPopup, FileRevlogPopup,
-		FuzzyFindPopup, HelpPopup, InspectCommitPopup,
-		LogSearchPopupPopup, MsgPopup, OptionsPopup, PullPopup,
-		PushPopup, PushTagsPopup, RenameBranchPopup, ResetPopup,
-		RevisionFilesPopup, StashMsgPopup, SubmodulesListPopup,
-		TagCommitPopup, TagListPopup,
+		AppOption, BlameFileOpen, BlameFilePopup, BranchListPopup,
+		CommitPopup, CompareCommitsPopup, ConfirmPopup,
+		CreateBranchPopup, ExternalEditorPopup, FetchPopup,
+		FileRevlogPopup, FuzzyFindPopup, GotoLinePopup, HelpPopup,
+		InspectCommitPopup, LogSearchPopupPopup, MsgPopup,
+		OptionsPopup, PullPopup, PushPopup, PushTagsPopup,
+		RenameBranchPopup, ResetPopup, RevisionFilesPopup,
+		StashMsgPopup, SubmodulesListPopup, TagCommitPopup,
+		TagListPopup,
 	},
 	queue::{
 		Action, AppTabs, InternalEvent, NeedsUpdate, Queue,
@@ -106,6 +107,7 @@ pub struct App {
 	popup_stack: PopupStack,
 	options: SharedOptions,
 	repo_path_text: String,
+	goto_line_popup: GotoLinePopup,
 
 	// "Flags"
 	requires_redraw: Cell<bool>,
@@ -208,6 +210,7 @@ impl App {
 			stashing_tab: Stashing::new(&env),
 			stashlist_tab: StashList::new(&env),
 			files_tab: FilesTab::new(&env),
+			goto_line_popup: GotoLinePopup::new(&env),
 			tab: 0,
 			queue: env.queue,
 			theme: env.theme,
@@ -495,7 +498,8 @@ impl App {
 			status_tab,
 			files_tab,
 			stashing_tab,
-			stashlist_tab
+			stashlist_tab,
+			goto_line_popup
 		]
 	);
 
@@ -526,7 +530,8 @@ impl App {
 			fetch_popup,
 			options_popup,
 			confirm_popup,
-			msg_popup
+			msg_popup,
+			goto_line_popup
 		]
 	);
 
@@ -670,6 +675,9 @@ impl App {
 			StackablePopupOpen::CompareCommits(param) => {
 				self.compare_commits_popup.open(param)?;
 			}
+			StackablePopupOpen::GotoLine => {
+				self.goto_line_popup.open()?;
+			}
 		}
 
 		Ok(())
@@ -872,6 +880,25 @@ impl App {
 			InternalEvent::CommitSearch(options) => {
 				self.revlog.search(options);
 			}
+			InternalEvent::GotoLine(line) => {
+				if let Some(popup) = self.popup_stack.pop() {
+					if let StackablePopupOpen::BlameFile(params) =
+						popup
+					{
+						self.popup_stack.push(
+							StackablePopupOpen::BlameFile(
+								BlameFileOpen {
+									selection: Some(line),
+									..params
+								},
+							),
+						)
+					}
+					flags.insert(
+						NeedsUpdate::ALL | NeedsUpdate::COMMANDS,
+					);
+				}
+			}
 		};
 
 		Ok(flags)

src/keys/key_list.rs

@@ -123,6 +123,7 @@ pub struct KeysList {
 	pub commit_history_next: GituiKeyEvent,
 	pub commit: GituiKeyEvent,
 	pub newline: GituiKeyEvent,
+	pub goto_line: GituiKeyEvent,
 }
 
 #[rustfmt::skip]
@@ -215,6 +216,7 @@ impl Default for KeysList {
 			commit_history_next: GituiKeyEvent::new(KeyCode::Char('n'),  KeyModifiers::CONTROL),
 			commit: GituiKeyEvent::new(KeyCode::Char('d'),  KeyModifiers::CONTROL),
 			newline: GituiKeyEvent::new(KeyCode::Enter,  KeyModifiers::empty()),
+			goto_line: GituiKeyEvent::new(KeyCode::Char('L'),  KeyModifiers::SHIFT),
 		}
 	}
 }

src/popups/blame_file.rs

@@ -97,6 +97,7 @@ pub struct BlameFilePopup {
 	app_sender: Sender<AsyncAppNotification>,
 	git_sender: Sender<AsyncGitNotification>,
 	repo: RepoPathRef,
+	goto_line_popup_is_open: bool,
 }
 
 impl DrawableComponent for BlameFilePopup {
@@ -234,6 +235,16 @@ impl Component for BlameFilePopup {
 				)
 				.order(1),
 			);
+			out.push(
+				CommandInfo::new(
+					strings::commands::open_line_number_popup(
+						&self.key_config,
+					),
+					true,
+					has_result,
+				)
+				.order(1),
+			);
 		}
 
 		visibility_blocking(self)
@@ -243,7 +254,7 @@ impl Component for BlameFilePopup {
 		&mut self,
 		event: &crossterm::event::Event,
 	) -> Result<EventState> {
-		if self.is_visible() {
+		if self.is_visible() && !self.goto_line_popup_is_open {
 			if let Event::Key(key) = event {
 				if key_match(key, self.key_config.keys.exit_popup) {
 					self.hide_stacked(false);
@@ -307,6 +318,16 @@ impl Component for BlameFilePopup {
 							),
 						));
 					}
+				} else if key_match(
+					key,
+					self.key_config.keys.goto_line,
+				) {
+					self.goto_line_popup_is_open = true;
+					self.hide_stacked(true);
+					self.visible = true;
+					self.queue.push(InternalEvent::OpenPopup(
+						StackablePopupOpen::GotoLine,
+					));
 				}
 
 				return Ok(EventState::Consumed);
@@ -344,6 +365,7 @@ impl BlameFilePopup {
 			git_sender: env.sender_git.clone(),
 			blame: None,
 			repo: env.repo.clone(),
+			goto_line_popup_is_open: false,
 		}
 	}
 
@@ -378,6 +400,7 @@ impl BlameFilePopup {
 			)));
 		self.table_state.get_mut().select(Some(0));
 		self.visible = true;
+		self.goto_line_popup_is_open = false;
 		self.update()?;
 
 		Ok(())
@@ -721,7 +744,8 @@ impl BlameFilePopup {
 			self.open_request.as_ref().and_then(|req| req.selection)
 		{
 			let mut table_state = self.table_state.take();
-			table_state.select(Some(selection));
+			let max_line_number = self.get_max_line_number();
+			table_state.select(Some(selection.min(max_line_number)));
 			self.table_state.set(table_state);
 		}
 	}

src/popups/goto_line.rs

@@ -0,0 +1,111 @@
+use crate::{
+	app::Environment,
+	components::{
+		visibility_blocking, CommandBlocking, CommandInfo, Component,
+		DrawableComponent, EventState,
+	},
+	keys::{key_match, SharedKeyConfig},
+	queue::{InternalEvent, Queue},
+	ui::{self, style::SharedTheme},
+};
+
+use ratatui::{
+	layout::Rect,
+	widgets::{Block, Clear, Paragraph},
+	Frame,
+};
+
+use anyhow::Result;
+
+use crossterm::event::{Event, KeyCode};
+
+pub struct GotoLinePopup {
+	visible: bool,
+	line: String,
+	key_config: SharedKeyConfig,
+	queue: Queue,
+	theme: SharedTheme,
+}
+
+impl GotoLinePopup {
+	pub fn new(env: &Environment) -> Self {
+		Self {
+			visible: false,
+			line: String::new(),
+			key_config: env.key_config.clone(),
+			queue: env.queue.clone(),
+			theme: env.theme.clone(),
+		}
+	}
+
+	pub fn open(&mut self) -> Result<()> {
+		self.visible = true;
+		Ok(())
+	}
+}
+
+impl Component for GotoLinePopup {
+	///
+	fn commands(
+		&self,
+		_out: &mut Vec<CommandInfo>,
+		_force_all: bool,
+	) -> CommandBlocking {
+		visibility_blocking(self)
+	}
+
+	fn is_visible(&self) -> bool {
+		self.visible
+	}
+
+	///
+	fn event(&mut self, event: &Event) -> Result<EventState> {
+		if self.is_visible() {
+			if let Event::Key(key) = event {
+				if key_match(key, self.key_config.keys.exit_popup) {
+					self.visible = false;
+					self.line.clear();
+					self.queue.push(InternalEvent::PopupStackPop)
+				} else if let KeyCode::Char(c) = key.code {
+					if c.is_digit(10) {
+						// I'd assume it's unusual for people to blame
+						// files with milions of lines
+						if self.line.len() < 6 {
+							self.line.push(c)
+						}
+					}
+				} else if let KeyCode::Backspace = key.code {
+					self.line.pop();
+				} else if key_match(key, self.key_config.keys.enter) {
+					self.visible = false;
+					if self.line.len() > 0 {
+						self.queue.push(InternalEvent::GotoLine(
+							self.line.parse::<usize>().unwrap(),
+						));
+					}
+					self.queue.push(InternalEvent::PopupStackPop);
+					self.line.clear();
+				}
+				return Ok(EventState::Consumed);
+			}
+		}
+
+		Ok(EventState::NotConsumed)
+	}
+}
+
+impl DrawableComponent for GotoLinePopup {
+	fn draw(&self, f: &mut Frame, area: Rect) -> Result<()> {
+		if self.is_visible() {
+			let input = Paragraph::new(self.line.as_str())
+				.style(self.theme.text(true, false))
+				.block(Block::bordered().title("Go to Line"));
+
+			let input_area = ui::centered_rect_absolute(15, 3, area);
+			f.render_widget(Clear, input_area);
+			f.render_widget(input, input_area);
+		}
+
+		Ok(())
+	}
+}

src/popups/mod.rs

@@ -8,6 +8,7 @@ mod externaleditor;
 mod fetch;
 mod file_revlog;
 mod fuzzy_find;
+mod goto_line;
 mod help;
 mod inspect_commit;
 mod log_search;
@@ -34,6 +35,7 @@ pub use externaleditor::ExternalEditorPopup;
 pub use fetch::FetchPopup;
 pub use file_revlog::{FileRevOpen, FileRevlogPopup};
 pub use fuzzy_find::FuzzyFindPopup;
+pub use goto_line::GotoLinePopup;
 pub use help::HelpPopup;
 pub use inspect_commit::{InspectCommitOpen, InspectCommitPopup};
 pub use log_search::LogSearchPopupPopup;

src/queue.rs

@@ -68,6 +68,8 @@ pub enum StackablePopupOpen {
 	InspectCommit(InspectCommitOpen),
 	///
 	CompareCommits(InspectCommitOpen),
+	///
+	GotoLine,
 }
 
 pub enum AppTabs {
@@ -146,6 +148,8 @@ pub enum InternalEvent {
 	RewordCommit(CommitId),
 	///
 	CommitSearch(LogFilterSearchOptions),
+	///
+	GotoLine(usize),
 }
 
 /// single threaded simple queue for components to communicate with each other

src/strings.rs

@@ -1300,6 +1300,18 @@ pub mod commands {
 			CMD_GROUP_LOG,
 		)
 	}
+	pub fn open_line_number_popup(
+		key_config: &SharedKeyConfig,
+	) -> CommandText {
+		CommandText::new(
+			format!(
+				"Go to Line [{}]",
+				key_config.get_hint(key_config.keys.goto_line),
+			),
+			"go to a given line number in the blame view",
+			CMD_GROUP_GENERAL,
+		)
+	}
 	pub fn log_tag_commit(
 		key_config: &SharedKeyConfig,
 	) -> CommandText {