[PATCH v8] gitk: add external diff file rename detection

["ToBoMi via GitGitGadget" <gitgitgadget@gmail.com>]

From: Tobias Boesch <tobias.boesch@miele.com>

If a file is renamed between commits and an external diff is started
through gitk on the original or the renamed file name,
gitk is unable to open the renamed file in the external diff editor.
It fails to fetch the renamed file from git, because it fetches it
using its original path in contrast to using the renamed path of the
file.
Detect the rename and open the external diff with the original and
the renamed file instead of no file (fetch the renamed file path and
name from git) no matter if the original or the renamed file is
selected in gitk.

Signed-off-by: Tobias Boesch <tobias.boesch@miele.com>
---
    gitk: add external diff file rename detection
    
    Changes since v1:
    
     * Commit message ident
     * Commit message line length
    
    Changes since v2:
    
     * Removed option for rename detection (Adding GUI options seems to be
       not desired - which is understandable)
     * Rebased on current master of git-for-windows
     * Renamed variables for a better understanding
     * Made rename detection also work when the renamed file is selected in
       gitk
    
    Changes since v3:
    
     * Changed message to use present tense, removed bullet points and
       described changes in imperative mood
    
    Changes sine v4:
    
     * Use a git command to gather the changed file paths rather than
       parsing the text from the diff window panel for efficiency and to
       avoid regex containing the filename as a variable.
     * Change != to ne in string comparison
     * removed extra set of parentheses around &&
     * shorter variable names
    
    Changes sine v5:
    
     * Include filename in rename check. Find only the file and its renamed
       version that is selected in the GUI.
     * Escape special characters in the filename to prevent that they are
       intepreted as part of a regular expression
    
    Changes since v6:
    
     * Don't extra mention moved files in commit message
     * Create empty list properly (avoid creting a list containing an empty
       string)
     * Avoid snake case in variable names
     * Change logic that checks the renames and gathers the file paths to
       use the difffilestart variable for efficient file path extraction
     * Removed underscores in file names
    
    Changes since v7:
    
     * Find renames by checking the file names extracted from the "renamed
       from" and "renamed to" diff lines instead of the separator line (make
       rename detection also work when the original file was selected) (I
       checked this, but only in a repo where a file move occurred - that
       worked since the filename didn't change)
     * Change "string match" and wildcard to "string equal" with length
       parameter
     * Change empty list detection to use "ne" instead of "!=" and reduce
       parenthesis

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1774%2FToBoMi%2Fdetect_renamed_files_when_opening_diff-v8
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1774/ToBoMi/detect_renamed_files_when_opening_diff-v8
Pull-Request: https://github.com/gitgitgadget/git/pull/1774

Range-diff vs v7:

 1:  7c09a28951 ! 1:  6fe99eb5a3 gitk: add external diff file rename detection
     @@ gitk-git/gitk: proc external_diff_get_one_file {diffid filename diffdir} {
      +    
      +    foreach loc $difffilestart {
      +        set loclineend [string map {.0 .end} $loc]
     -+        set ctextline [$ctext get $loc $loclineend]
     -+        if {[string first $filename $ctextline] != -1} {
     -+            set fromlineloc "$loc + 2 lines"
     -+            set tolineloc "$loc + 3 lines"
     -+            set renfromline [$ctext get $fromlineloc [string map {.0 .end} $fromlineloc]]
     -+            set rentoline [$ctext get $tolineloc [string map {.0 .end} $tolineloc]]
     -+            if {[string match "rename from *" $renfromline]
     -+                && [string match "rename to *" $rentoline]} {
     -+                set renfrom [string range $renfromline 12 end]
     -+                set rento [string range $rentoline 10 end]
     -+                lappend renames $renfrom
     -+                lappend renames $rento
     ++        set fromlineloc "$loc + 2 lines"
     ++        set tolineloc "$loc + 3 lines"
     ++        set renfromline [$ctext get $fromlineloc [string map {.0 .end} $fromlineloc]]
     ++        set rentoline [$ctext get $tolineloc [string map {.0 .end} $tolineloc]]
     ++        if {[string equal -length 12 "rename from " $renfromline]
     ++            && [string equal -length 10 "rename to " $rentoline]} {
     ++            set renfrom [string range $renfromline 12 end]
     ++            set rento [string range $rentoline 10 end]
     ++                if {[string first $filename $renfrom] != -1
     ++                    || [string first $filename $rento] != -1} {
     ++                    lappend renames $renfrom
     ++                    lappend renames $rento
      +                break
      +            }
      +        }
     @@ gitk-git/gitk: proc external_diff {} {
      +    set renames [check_for_renames_in_diff $flist_menu_file]
      +    set renamefrom [lindex $renames 0]
      +    set renameto [lindex $renames 1]
     -+    if { ($renamefrom != {}) && ($renameto != {}) } {
     ++    if {$renamefrom ne {} && $renameto ne {}} {
      +        set difffromfile [external_diff_get_one_file $diffidfrom $renamefrom $diffdir]
      +        set difftofile [external_diff_get_one_file $diffidto $renameto $diffdir]
      +    } else {


 gitk-git/gitk | 40 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/gitk-git/gitk b/gitk-git/gitk
index c02db0194d..90cbfd4ec1 100755
--- a/gitk-git/gitk
+++ b/gitk-git/gitk
@@ -3788,6 +3788,34 @@ proc external_diff_get_one_file {diffid filename diffdir} {
                "revision $diffid"]
 }
 
+proc check_for_renames_in_diff {filepath} { # renames
+    global difffilestart ctext
+
+    set filename [file tail $filepath]
+    set renames {}
+    
+    foreach loc $difffilestart {
+        set loclineend [string map {.0 .end} $loc]
+        set fromlineloc "$loc + 2 lines"
+        set tolineloc "$loc + 3 lines"
+        set renfromline [$ctext get $fromlineloc [string map {.0 .end} $fromlineloc]]
+        set rentoline [$ctext get $tolineloc [string map {.0 .end} $tolineloc]]
+        if {[string equal -length 12 "rename from " $renfromline]
+            && [string equal -length 10 "rename to " $rentoline]} {
+            set renfrom [string range $renfromline 12 end]
+            set rento [string range $rentoline 10 end]
+                if {[string first $filename $renfrom] != -1
+                    || [string first $filename $rento] != -1} {
+                    lappend renames $renfrom
+                    lappend renames $rento
+                break
+            }
+        }
+    }
+    
+    return $renames
+}
+
 proc external_diff {} {
     global nullid nullid2
     global flist_menu_file
@@ -3818,8 +3846,16 @@ proc external_diff {} {
     if {$diffdir eq {}} return
 
     # gather files to diff
-    set difffromfile [external_diff_get_one_file $diffidfrom $flist_menu_file $diffdir]
-    set difftofile [external_diff_get_one_file $diffidto $flist_menu_file $diffdir]
+    set renames [check_for_renames_in_diff $flist_menu_file]
+    set renamefrom [lindex $renames 0]
+    set renameto [lindex $renames 1]
+    if {$renamefrom ne {} && $renameto ne {}} {
+        set difffromfile [external_diff_get_one_file $diffidfrom $renamefrom $diffdir]
+        set difftofile [external_diff_get_one_file $diffidto $renameto $diffdir]
+    } else {
+        set difffromfile [external_diff_get_one_file $diffidfrom $flist_menu_file $diffdir]
+        set difftofile [external_diff_get_one_file $diffidto $flist_menu_file $diffdir]
+    }
 
     if {$difffromfile ne {} && $difftofile ne {}} {
         set cmd [list [shellsplit $extdifftool] $difffromfile $difftofile]

base-commit: 57da342c786f59eaeb436c18635cc1c7597733d9
-- 
gitgitgadget