git-gui: Switch internal blame structure to Tcl lists
[gitweb.git] / lib / blame.tcl
index 85e9e0dc32e08361a755bea65811274cff984d39..d8d27c9cbf31fda84024bd4060a795c7d720ba6e 100644 (file)
@@ -5,52 +5,59 @@ class blame {
 
 image create photo ::blame::img_back_arrow -data {R0lGODlhGAAYAIUAAPwCBEzKXFTSZIz+nGzmhGzqfGTidIT+nEzGXHTqhGzmfGzifFzadETCVES+VARWDFzWbHzyjAReDGTadFTOZDSyRDyyTCymPARaFGTedFzSbDy2TCyqRCyqPARaDAyCHES6VDy6VCyiPAR6HCSeNByWLARyFARiDARqFGTifARiFAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAAAALAAAAAAYABgAAAajQIBwSCwaj8ikcsk0BppJwRPqHEypQwHBis0WDAdEFyBIKBaMAKLBdjQeSkFBYTBAIvgEoS6JmhUTEwIUDQ4VFhcMGEhyCgoZExoUaxsWHB0THkgfAXUGAhoBDSAVFR0XBnCbDRmgog0hpSIiDJpJIyEQhBUcJCIlwA22SSYVogknEg8eD82qSigdDSknY0IqJQXPYxIl1dZCGNvWw+Dm510GQQAh/mhDcmVhdGVkIGJ5IEJNUFRvR0lGIFBybyB2ZXJzaW9uIDIuNQ0KqSBEZXZlbENvciAxOTk3LDE5OTguIEFsbCByaWdodHMgcmVzZXJ2ZWQuDQpodHRwOi8vd3d3LmRldmVsY29yLmNvbQA7}
 
-field commit    ; # input commit to blame
-field path      ; # input filename to view in $commit
+# Persistant data (survives loads)
+#
 field history {}; # viewer history: {commit path}
+field header    ; # array commit,key -> header field
 
+# Tk UI control paths
+#
 field w          ; # top window in this viewer
 field w_back     ; # our back button
 field w_path     ; # label showing the current file path
+field w_columns  ; # list of all column widgets in the viewer
 field w_line     ; # text column: all line numbers
 field w_cgrp     ; # text column: abbreviated commit SHA-1s
-field w_load     ; # text column: loaded indicator
 field w_file     ; # text column: actual file data
 field w_cmit     ; # pane showing commit message
 field status     ; # text variable bound to status bar
 field old_height ; # last known height of $w.file_pane
 
-field current_fd       {} ; # background process running
-field highlight_line   -1 ; # current line selected
-field highlight_commit {} ; # sha1 of commit selected
+# Tk UI colors
+#
+field active_color #c0edc5
+field group_colors {
+       #d6d6d6
+       #e1e1e1
+       #ececec
+}
+
+# Current blame data; cleared/reset on each load
+#
+field commit               ; # input commit to blame
+field path                 ; # input filename to view in $commit
+
+field current_fd        {} ; # background process running
+field highlight_line    -1 ; # current line selected
+field highlight_commit  {} ; # sha1 of commit selected
+field old_bgcolor       {} ; # background of current selection
 
 field total_lines       0  ; # total length of file
 field blame_lines       0  ; # number of lines computed
-field commit_count      0  ; # number of commits in $commit_list
-field commit_list      {}  ; # list of commit sha1 in receipt order
-field order                ; # array commit -> receipt order
-field header               ; # array commit,key -> header field
-field line_commit          ; # array line -> sha1 commit
-field line_file            ; # array line -> file name
-
-field r_commit      ; # commit currently being parsed
-field r_orig_line   ; # original line number
-field r_final_line  ; # final line number
-field r_line_count  ; # lines in this region
-
-field tooltip_wm     {} ; # Current tooltip toplevel, if open
-field tooltip_timer  {} ; # Current timer event for our tooltip
-field tooltip_commit {} ; # Commit in tooltip
-field tooltip_text   {} ; # Text in current tooltip
-
-variable active_color #98e1a0
-variable group_colors {
-       #cbcbcb
-       #e1e1e1
-}
+field have_commit          ; # array commit -> 1
+field line_data            ; # list of {commit origfile origline}
+
+field r_commit             ; # commit currently being parsed
+field r_orig_line          ; # original line number
+field r_final_line         ; # final line number
+field r_line_count         ; # lines in this region
+
+field tooltip_wm        {} ; # Current tooltip toplevel, if open
+field tooltip_timer     {} ; # Current timer event for our tooltip
+field tooltip_commit    {} ; # Commit in tooltip
+field tooltip_text      {} ; # Text in current tooltip
 
 constructor new {i_commit i_path} {
-       variable active_color
        global cursor_ptr
 
        set commit $i_commit
@@ -113,28 +120,24 @@ constructor new {i_commit i_path} {
                -height 25 \
                -width 100
 
-       set w_load $w.file_pane.out.loaded_t
-       text $w_load \
-               -background white -borderwidth 0 \
-               -state disabled \
-               -wrap none \
-               -height 40 \
-               -width 1 \
-               -font font_diff
-       $w_load tag conf annotated -background grey
-
        set w_line $w.file_pane.out.linenumber_t
        text $w_line \
+               -takefocus 0 \
+               -highlightthickness 0 \
+               -padx 0 -pady 0 \
                -background white -borderwidth 0 \
                -state disabled \
                -wrap none \
                -height 40 \
-               -width 5 \
+               -width 6 \
                -font font_diff
-       $w_line tag conf linenumber -justify right
+       $w_line tag conf linenumber -justify right -rmargin 5
 
        set w_cgrp $w.file_pane.out.commit_t
        text $w_cgrp \
+               -takefocus 0 \
+               -highlightthickness 0 \
+               -padx 0 -pady 0 \
                -background white -borderwidth 0 \
                -state disabled \
                -wrap none \
@@ -151,6 +154,9 @@ constructor new {i_commit i_path} {
 
        set w_file $w.file_pane.out.file_t
        text $w_file \
+               -takefocus 0 \
+               -highlightthickness 0 \
+               -padx 0 -pady 0 \
                -background white -borderwidth 0 \
                -state disabled \
                -wrap none \
@@ -159,26 +165,23 @@ constructor new {i_commit i_path} {
                -xscrollcommand [list $w.file_pane.out.sbx set] \
                -font font_diff
 
+       set w_columns [list $w_cgrp $w_line $w_file]
+
        scrollbar $w.file_pane.out.sbx \
                -orient h \
                -command [list $w_file xview]
        scrollbar $w.file_pane.out.sby \
                -orient v \
-               -command [list scrollbar2many [list \
-               $w_load \
-               $w_line \
-               $w_cgrp \
-               $w_file \
-               ] yview]
-       grid \
-               $w_cgrp \
-               $w_line \
-               $w_load \
-               $w_file \
-               $w.file_pane.out.sby \
-               -sticky nsew
-       grid conf $w.file_pane.out.sbx -column 3 -sticky we
-       grid columnconfigure $w.file_pane.out 3 -weight 1
+               -command [list scrollbar2many $w_columns yview]
+       eval grid $w_columns $w.file_pane.out.sby -sticky nsew
+       grid conf \
+               $w.file_pane.out.sbx \
+               -column [expr {[llength $w_columns] - 1}] \
+               -sticky we
+       grid columnconfigure \
+               $w.file_pane.out \
+               [expr {[llength $w_columns] - 1}] \
+               -weight 1
        grid rowconfigure $w.file_pane.out 0 -weight 1
 
        set w_cmit $w.file_pane.cm.t
@@ -223,19 +226,10 @@ constructor new {i_commit i_path} {
                -label "Copy Commit" \
                -command [cb _copycommit]
 
-       foreach i [list \
-               $w_cgrp \
-               $w_load \
-               $w_line \
-               $w_file] {
+       foreach i $w_columns {
                $i conf -cursor $cursor_ptr
-               $i conf -yscrollcommand \
-                       [list many2scrollbar [list \
-                       $w_cgrp \
-                       $w_load \
-                       $w_line \
-                       $w_file \
-                       ] yview $w.file_pane.out.sby]
+               $i conf -yscrollcommand [list many2scrollbar \
+                       $w_columns yview $w.file_pane.out.sby]
                bind $i <Button-1> "
                        [cb _hide_tooltip]
                        [cb _click $i @%x,%y]
@@ -253,12 +247,7 @@ constructor new {i_commit i_path} {
                "
        }
 
-       foreach i [list \
-               $w_cgrp \
-               $w_load \
-               $w_line \
-               $w_file \
-               $w_cmit] {
+       foreach i [concat $w_columns $w_cmit] {
                bind $i <Key-Up>        {catch {%W yview scroll -1 units};break}
                bind $i <Key-Down>      {catch {%W yview scroll  1 units};break}
                bind $i <Key-Left>      {catch {%W xview scroll -1 units};break}
@@ -310,30 +299,20 @@ method _load {} {
                        set current_fd {}
                }
 
+               foreach i $w_columns {
+                       $i conf -state normal
+                       $i delete 0.0 end
+                       foreach cmit [array names have_commit] {
+                               $i tag delete g$cmit
+                       }
+                       $i conf -state disabled
+               }
+
                set highlight_line -1
                set highlight_commit {}
                set total_lines 0
                set blame_lines 0
-               set commit_count 0
-               set commit_list {}
-               array unset order
-               array unset line_commit
-               array unset line_file
-
-               $w_load conf -state normal
-               $w_cgrp conf -state normal
-               $w_line conf -state normal
-               $w_file conf -state normal
-
-               $w_load delete 0.0 end
-               $w_cgrp delete 0.0 end
-               $w_line delete 0.0 end
-               $w_file delete 0.0 end
-
-               $w_load conf -state disabled
-               $w_cgrp conf -state disabled
-               $w_line conf -state disabled
-               $w_file conf -state disabled
+               array unset have_commit
        }
 
        if {[winfo exists $w.status.c]} {
@@ -356,6 +335,12 @@ method _load {} {
        }
        lappend history [list $commit $path]
 
+       # Index 0 is always empty.  There is never line 0 as
+       # we use only 1 based lines, as that matches both with
+       # git-blame output and with Tk's text widget.
+       #
+       set line_data [list [list]]
+
        set status "Loading $commit:[escape_path $path]..."
        $w_path conf -text [escape_path $path]
        if {$commit eq {}} {
@@ -415,31 +400,30 @@ method _read_file {fd} {
                return
        }
 
-       $w_load conf -state normal
-       $w_cgrp conf -state normal
-       $w_line conf -state normal
-       $w_file conf -state normal
+       foreach i $w_columns {$i conf -state normal}
        while {[gets $fd line] >= 0} {
                regsub "\r\$" $line {} line
                incr total_lines
+               lappend line_data {}
 
                if {$total_lines > 1} {
-                       $w_load insert end "\n"
-                       $w_cgrp insert end "\n"
-                       $w_line insert end "\n"
-                       $w_file insert end "\n"
+                       foreach i $w_columns {$i insert end "\n"}
                }
 
                $w_line insert end "$total_lines" linenumber
                $w_file insert end "$line"
        }
-       $w_load conf -state disabled
-       $w_cgrp conf -state disabled
-       $w_line conf -state disabled
-       $w_file conf -state disabled
+
+       set ln_wc [expr {[string length $total_lines] + 2}]
+       if {[$w_line cget -width] < $ln_wc} {
+               $w_line conf -width $ln_wc
+       }
+
+       foreach i $w_columns {$i conf -state disabled}
 
        if {[eof $fd]} {
                close $fd
+
                _status $this
                set cmd {nice git blame -M -C --incremental}
                if {$commit eq {}} {
@@ -456,8 +440,6 @@ method _read_file {fd} {
 } ifdeleted { catch {close $fd} }
 
 method _read_blame {fd} {
-       variable group_colors
-
        if {$fd ne $current_fd} {
                catch {close $fd}
                return
@@ -472,18 +454,14 @@ method _read_blame {fd} {
                        set r_final_line $final_line
                        set r_line_count $line_count
 
-                       if {[catch {set g $order($cmit)}]} {
+                       if {[catch {set g $have_commit($cmit)}]} {
                                set bg [lindex $group_colors 0]
                                set group_colors [lrange $group_colors 1 end]
                                lappend group_colors $bg
-
-                               $w_cgrp tag conf g$cmit -background $bg
-                               $w_line tag conf g$cmit -background $bg
-                               $w_file tag conf g$cmit -background $bg
-
-                               set order($cmit) $commit_count
-                               incr commit_count
-                               lappend commit_list $cmit
+                               foreach i $w_columns {
+                                       $i tag conf g$cmit -background $bg
+                               }
+                               set have_commit($cmit) 1
                        }
                } elseif {[string match {filename *} $line]} {
                        set file [string range $line 9 end]
@@ -525,30 +503,22 @@ method _read_blame {fd} {
 
                        set first_lno $lno
                        while {
-                          ![catch {set ncmit $line_commit([expr {$first_lno - 1}])}]
-                       && ![catch {set nfile $line_file([expr {$first_lno - 1}])}]
-                       && $ncmit eq $cmit
-                       && $nfile eq $file
+                          $first_lno > 1
+                       && $cmit eq [lindex $line_data [expr {$first_lno - 1}] 0]
+                       && $file eq [lindex $line_data [expr {$first_lno - 1}] 1]
                        } {
                                incr first_lno -1
                        }
 
                        while {$n > 0} {
                                set lno_e "$lno.0 lineend + 1c"
-                               if {[catch {set g g$line_commit($lno)}]} {
-                                       $w_load tag add annotated $lno.0 $lno_e
-                               } else {
-                                       $w_cgrp tag remove g$g $lno.0 $lno_e
-                                       $w_line tag remove g$g $lno.0 $lno_e
-                                       $w_file tag remove g$g $lno.0 $lno_e
-
-                                       $w_cgrp tag remove a$g $lno.0 $lno_e
-                                       $w_line tag remove a$g $lno.0 $lno_e
-                                       $w_file tag remove a$g $lno.0 $lno_e
+                               if {[lindex $line_data $lno] ne {}} {
+                                       set g [lindex $line_data $lno 0]
+                                       foreach i $w_columns {
+                                               $i tag remove g$g $lno.0 $lno_e
+                                       }
                                }
-
-                               set line_commit($lno) $cmit
-                               set line_file($lno)   $file
+                               lset line_data $lno [list $cmit $file]
 
                                $w_cgrp delete $lno.0 "$lno.0 lineend"
                                if {$lno == $first_lno} {
@@ -559,13 +529,9 @@ method _read_blame {fd} {
                                        $w_cgrp insert $lno.0 { |}
                                }
 
-                               $w_cgrp tag add g$cmit $lno.0 $lno_e
-                               $w_line tag add g$cmit $lno.0 $lno_e
-                               $w_file tag add g$cmit $lno.0 $lno_e
-
-                               $w_cgrp tag add a$cmit $lno.0 $lno_e
-                               $w_line tag add a$cmit $lno.0 $lno_e
-                               $w_file tag add a$cmit $lno.0 $lno_e
+                               foreach i $w_columns {
+                                       $i tag add g$cmit $lno.0 $lno_e
+                               }
 
                                if {$highlight_line == -1} {
                                        if {[lindex [$w_file yview] 0] == 0} {
@@ -582,10 +548,8 @@ method _read_blame {fd} {
                        }
 
                        while {
-                          ![catch {set ncmit $line_commit($lno)}]
-                       && ![catch {set nfile $line_file($lno)}]
-                       && $ncmit eq $cmit
-                       && $nfile eq $file
+                          $cmit eq [lindex $line_data $lno 0]
+                       && $file eq [lindex $line_data $lno 1]
                        } {
                                $w_cgrp delete $lno.0 "$lno.0 lineend"
 
@@ -635,34 +599,38 @@ method _click {cur_w pos} {
 
 method _load_commit {pos} {
        set lno [lindex [split [$w_cgrp index $pos] .] 0]
-       if {[catch {set cmit $line_commit($lno)}]} return
-       if {[catch {set file $line_file($lno)  }]} return
-
-       set commit $cmit
-       set path $file
-       _load $this
+       set dat [lindex $line_data $lno]
+       if {$dat ne {}} {
+               set commit [lindex $dat 0]
+               set path   [lindex $dat 1]
+               _load $this
+       }
 }
 
 method _showcommit {lno} {
        global repo_config
-       variable active_color
 
        if {$highlight_commit ne {}} {
-               set cmit $highlight_commit
-               $w_cgrp tag conf a$cmit -background {}
-               $w_line tag conf a$cmit -background {}
-               $w_file tag conf a$cmit -background {}
+               foreach i $w_columns {
+                       $i tag conf g$highlight_commit -background $old_bgcolor
+               }
        }
 
        $w_cmit conf -state normal
        $w_cmit delete 0.0 end
-       if {[catch {set cmit $line_commit($lno)}]} {
+
+       set dat [lindex $line_data $lno]
+       if {$dat eq {}} {
                set cmit {}
                $w_cmit insert end "Loading annotation..."
        } else {
-               $w_cgrp tag conf a$cmit -background $active_color
-               $w_line tag conf a$cmit -background $active_color
-               $w_file tag conf a$cmit -background $active_color
+               set cmit [lindex $dat 0]
+               set file [lindex $dat 1]
+
+               set old_bgcolor [$w_file tag cget g$cmit -background]
+               foreach i $w_columns {
+                       $i tag conf g$cmit -background $active_color
+               }
 
                set author_name {}
                set author_email {}
@@ -719,9 +687,9 @@ method _showcommit {lno} {
                $w_cmit insert end "$committer_name $committer_email" header_val
                $w_cmit insert end "$committer_time\n" header_val
 
-               if {$line_file($lno) ne $path} {
+               if {$file ne $path} {
                        $w_cmit insert end "Original File:\t" header_key
-                       $w_cmit insert end "[escape_path $line_file($lno)]\n" header_val
+                       $w_cmit insert end "[escape_path $file]\n" header_val
                }
 
                $w_cmit insert end "\n$msg"
@@ -739,21 +707,24 @@ method _showcommit {lno} {
 method _copycommit {} {
        set pos @$::cursorX,$::cursorY
        set lno [lindex [split [$::cursorW index $pos] .] 0]
-       if {![catch {set commit $line_commit($lno)}]} {
+       set dat [lindex $line_data $lno]
+       if {$dat ne {}} {
                clipboard clear
                clipboard append \
                        -format STRING \
                        -type STRING \
-                       -- $commit
+                       -- [lindex $dat 0]
        }
 }
 
 method _show_tooltip {cur_w pos} {
        set lno [lindex [split [$cur_w index $pos] .] 0]
-       if {[catch {set cmit $line_commit($lno)}]} {
+       set dat [lindex $line_data $lno]
+       if {$dat eq {}} {
                _hide_tooltip $this
                return
        }
+       set cmit [lindex $dat 0]
 
        if {$cmit eq $highlight_commit} {
                _hide_tooltip $this
@@ -782,7 +753,9 @@ method _open_tooltip {cur_w} {
                [expr {$pos_x - [winfo rootx $cur_w]}] \
                [expr {$pos_y - [winfo rooty $cur_w]}]] ,]
        set lno [lindex [split [$cur_w index $pos] .] 0]
-       set cmit $line_commit($lno)
+       set dat [lindex $line_data $lno]
+       set cmit [lindex $dat 0]
+       set file [lindex $dat 1]
 
        set author_name {}
        set author_email {}
@@ -812,7 +785,6 @@ method _open_tooltip {cur_w} {
 $author_name $author_email  $author_time
 $summary"
 
-       set file $line_file($lno)
        if {$file ne $path} {
                append tooltip_text "