Adjust line number for working copy when editing a line

There are two ways to jump to the editor on a specific line: pressing `e` in the
staging or patch building panels, or clicking on a hyperlink in a delta diff. In
both cases, this works perfectly in the unstaged changes view, but in other
views (either staged changes, or an older commit) it can often jump to the wrong
line; this happens when there are further changes to the file being viewed in
later commits or in unstaged changes.

This commit fixes this so that you end up on the right line in these cases.

Author: stefanhaller

pkg/commands/patch/patch.go

@@ -154,3 +154,24 @@ func (self *Patch) LineCount() int {
 func (self *Patch) HunkCount() int {
 	return len(self.hunks)
 }
+
+// Adjust the given line number (one-based) according to the current patch. The
+// patch is supposed to be a diff of an old file state against the working
+// directory; the line number is a line number in that old file, and the
+// function returns the corresponding line number in the working directory file.
+func (self *Patch) AdjustLineNumber(lineNumber int) int {
+	adjustedLineNumber := lineNumber
+	for _, hunk := range self.hunks {
+		if hunk.oldStart >= lineNumber {
+			break
+		}
+
+		if hunk.oldStart+hunk.oldLength() > lineNumber {
+			return hunk.newStart
+		}
+
+		adjustedLineNumber += hunk.newLength() - hunk.oldLength()
+	}
+
+	return adjustedLineNumber
+}

pkg/commands/patch/patch_test.go

@@ -639,3 +639,59 @@ func TestGetNextStageableLineIndex(t *testing.T) {
 		})
 	}
 }
+
+func TestAdjustLineNumber(t *testing.T) {
+	type scenario struct {
+		oldLineNumbers  []int
+		expectedResults []int
+	}
+	scenarios := []scenario{
+		{
+			oldLineNumbers:  []int{1, 2, 3, 4, 5, 6, 7},
+			expectedResults: []int{1, 2, 2, 3, 4, 7, 8},
+		},
+	}
+
+	// The following diff was generated from old.txt:
+	//   1
+	//   2a
+	//   2b
+	//   3
+	//   4
+	//   7
+	//   8
+	// against new.txt:
+	//   1
+	//   2
+	//   3
+	//   4
+	//   5
+	//   6
+	//   7
+	//   8
+
+	// This test setup makes the test easy to understand, because the resulting
+	// adjusted line numbers are the same as the content of the lines in new.txt.
+
+	diff := `--- old.txt	2024-12-16 18:04:29
++++ new.txt	2024-12-16 18:04:27
+@@ -2,2 +2 @@
+-2a
+-2b
++2
+@@ -5,0 +5,2 @@
++5
++6
+`
+
+	patch := Parse(diff)
+
+	for _, s := range scenarios {
+		t.Run("TestAdjustLineNumber", func(t *testing.T) {
+			for idx, oldLineNumber := range s.oldLineNumbers {
+				result := patch.AdjustLineNumber(oldLineNumber)
+				assert.Equal(t, s.expectedResults[idx], result)
+			}
+		})
+	}
+}

pkg/gui/context/branches_context.go

@@ -80,6 +80,14 @@ func (self *BranchesContext) GetDiffTerminals() []string {
 	return nil
 }
 
+func (self *BranchesContext) RefForAdjustingLineNumberInDiff() string {
+	branch := self.GetSelected()
+	if branch != nil {
+		return branch.ID()
+	}
+	return ""
+}
+
 func (self *BranchesContext) ShowBranchHeadsInSubCommits() bool {
 	return true
 }

pkg/gui/context/commit_files_context.go

@@ -77,6 +77,13 @@ func (self *CommitFilesContext) GetDiffTerminals() []string {
 	return []string{self.GetRef().RefName()}
 }
 
+func (self *CommitFilesContext) RefForAdjustingLineNumberInDiff() string {
+	if refs := self.GetRefRange(); refs != nil {
+		return refs.To.RefName()
+	}
+	return self.GetRef().RefName()
+}
+
 func (self *CommitFilesContext) GetFromAndToForDiff() (string, string) {
 	if refs := self.GetRefRange(); refs != nil {
 		return refs.From.ParentRefName(), refs.To.RefName()

pkg/gui/context/local_commits_context.go

@@ -170,6 +170,14 @@ func (self *LocalCommitsContext) GetDiffTerminals() []string {
 	return []string{itemId}
 }
 
+func (self *LocalCommitsContext) RefForAdjustingLineNumberInDiff() string {
+	commits, _, _ := self.GetSelectedItems()
+	if commits == nil {
+		return ""
+	}
+	return commits[0].Hash
+}
+
 func (self *LocalCommitsContext) ModelSearchResults(searchStr string, caseSensitive bool) []gocui.SearchPosition {
 	return searchModelCommits(caseSensitive, self.GetCommits(), self.ColumnPositions(), searchStr)
 }

pkg/gui/context/reflog_commits_context.go

@@ -86,6 +86,10 @@ func (self *ReflogCommitsContext) GetDiffTerminals() []string {
 	return []string{itemId}
 }
 
+func (self *ReflogCommitsContext) RefForAdjustingLineNumberInDiff() string {
+	return self.GetSelectedItemId()
+}
+
 func (self *ReflogCommitsContext) ShowBranchHeadsInSubCommits() bool {
 	return false
 }

pkg/gui/context/remote_branches_context.go

@@ -78,6 +78,10 @@ func (self *RemoteBranchesContext) GetDiffTerminals() []string {
 	return []string{itemId}
 }
 
+func (self *RemoteBranchesContext) RefForAdjustingLineNumberInDiff() string {
+	return self.GetSelectedItemId()
+}
+
 func (self *RemoteBranchesContext) ShowBranchHeadsInSubCommits() bool {
 	return true
 }

pkg/gui/context/remotes_context.go

@@ -53,3 +53,7 @@ func (self *RemotesContext) GetDiffTerminals() []string {
 
 	return []string{itemId}
 }
+
+func (self *RemotesContext) RefForAdjustingLineNumberInDiff() string {
+	return ""
+}

pkg/gui/context/stash_context.go

@@ -71,3 +71,7 @@ func (self *StashContext) GetDiffTerminals() []string {
 
 	return []string{itemId}
 }
+
+func (self *StashContext) RefForAdjustingLineNumberInDiff() string {
+	return self.GetSelectedItemId()
+}

pkg/gui/context/sub_commits_context.go

@@ -217,6 +217,14 @@ func (self *SubCommitsContext) GetDiffTerminals() []string {
 	return []string{itemId}
 }
 
+func (self *SubCommitsContext) RefForAdjustingLineNumberInDiff() string {
+	commits, _, _ := self.GetSelectedItems()
+	if commits == nil {
+		return ""
+	}
+	return commits[0].Hash
+}
+
 func (self *SubCommitsContext) ModelSearchResults(searchStr string, caseSensitive bool) []gocui.SearchPosition {
 	return searchModelCommits(caseSensitive, self.GetCommits(), self.ColumnPositions(), searchStr)
 }