lib / search.tclon commit git-gui: add search history to searchbar (1159971)
   1# incremental search panel
   2# based on code from gitk, Copyright (C) Paul Mackerras
   3
   4class searchbar {
   5
   6field w
   7field ctext
   8
   9field searchstring   {}
  10field regexpsearch
  11field default_regexpsearch
  12field casesensitive
  13field default_casesensitive
  14field searchdirn     -forwards
  15
  16field history
  17field history_index
  18
  19field smarktop
  20field smarkbot
  21
  22constructor new {i_w i_text args} {
  23        global use_ttk NS
  24        set w      $i_w
  25        set ctext  $i_text
  26
  27        set default_regexpsearch [is_config_true gui.search.regexp]
  28        if {[is_config_true gui.search.smartcase]} {
  29                set default_casesensitive 0
  30        } else {
  31                set default_casesensitive 1
  32        }
  33
  34        set history [list]
  35
  36        ${NS}::frame  $w
  37        ${NS}::label  $w.l       -text [mc Find:]
  38        entry  $w.ent -textvariable ${__this}::searchstring -background lightgreen
  39        ${NS}::button $w.bn      -text [mc Next] -command [cb find_next]
  40        ${NS}::button $w.bp      -text [mc Prev] -command [cb find_prev]
  41        ${NS}::checkbutton $w.re -text [mc RegExp] \
  42                -variable ${__this}::regexpsearch -command [cb _incrsearch]
  43        ${NS}::checkbutton $w.cs -text [mc Case] \
  44                -variable ${__this}::casesensitive -command [cb _incrsearch]
  45        pack   $w.l   -side left
  46        pack   $w.cs  -side right
  47        pack   $w.re  -side right
  48        pack   $w.bp  -side right
  49        pack   $w.bn  -side right
  50        pack   $w.ent -side left -expand 1 -fill x
  51
  52        eval grid conf $w -sticky we $args
  53        grid remove $w
  54
  55        trace add variable searchstring write [cb _incrsearch_cb]
  56        bind $w.ent <Return> [cb find_next]
  57        bind $w.ent <Shift-Return> [cb find_prev]
  58        bind $w.ent <Key-Up>   [cb _prev_search]
  59        bind $w.ent <Key-Down> [cb _next_search]
  60        
  61        bind $w <Destroy> [list delete_this $this]
  62        return $this
  63}
  64
  65method show {} {
  66        if {![visible $this]} {
  67                grid $w
  68                $w.ent delete 0 end
  69                set regexpsearch  $default_regexpsearch
  70                set casesensitive $default_casesensitive
  71                set history_index [llength $history]
  72        }
  73        focus -force $w.ent
  74}
  75
  76method hide {} {
  77        if {[visible $this]} {
  78                focus $ctext
  79                grid remove $w
  80                _save_search $this
  81        }
  82}
  83
  84method visible {} {
  85        return [winfo ismapped $w]
  86}
  87
  88method editor {} {
  89        return $w.ent
  90}
  91
  92method _get_new_anchor {} {
  93        # use start of selection if it is visible,
  94        # or the bounds of the visible area
  95        set top    [$ctext index @0,0]
  96        set bottom [$ctext index @0,[winfo height $ctext]]
  97        set sel    [$ctext tag ranges sel]
  98        if {$sel ne {}} {
  99                set spos [lindex $sel 0]
 100                if {[lindex $spos 0] >= [lindex $top 0] &&
 101                    [lindex $spos 0] <= [lindex $bottom 0]} {
 102                        return $spos
 103                }
 104        }
 105        if {$searchdirn eq "-forwards"} {
 106                return $top
 107        } else {
 108                return $bottom
 109        }
 110}
 111
 112method _get_wrap_anchor {dir} {
 113        if {$dir eq "-forwards"} {
 114                return 1.0
 115        } else {
 116                return end
 117        }
 118}
 119
 120method _do_search {start {mlenvar {}} {dir {}} {endbound {}}} {
 121        set cmd [list $ctext search]
 122        if {$mlenvar ne {}} {
 123                upvar $mlenvar mlen
 124                lappend cmd -count mlen
 125        }
 126        if {$regexpsearch} {
 127                lappend cmd -regexp
 128        }
 129        if {!$casesensitive} {
 130                lappend cmd -nocase
 131        }
 132        if {$dir eq {}} {
 133                set dir $searchdirn
 134        }
 135        lappend cmd $dir -- $searchstring
 136        if {$endbound ne {}} {
 137                set here [eval $cmd [list $start] [list $endbound]]
 138        } else {
 139                set here [eval $cmd [list $start]]
 140                if {$here eq {}} {
 141                        set here [eval $cmd [_get_wrap_anchor $this $dir]]
 142                }
 143        }
 144        return $here
 145}
 146
 147method _incrsearch_cb {name ix op} {
 148        after idle [cb _incrsearch]
 149}
 150
 151method _incrsearch {} {
 152        $ctext tag remove found 1.0 end
 153        if {[catch {$ctext index anchor}]} {
 154                $ctext mark set anchor [_get_new_anchor $this]
 155        }
 156        if {[regexp {[[:upper:]]} $searchstring]} {
 157                set casesensitive 1
 158        }
 159        if {$searchstring ne {}} {
 160                set here [_do_search $this anchor mlen]
 161                if {$here ne {}} {
 162                        $ctext see $here
 163                        $ctext tag remove sel 1.0 end
 164                        $ctext tag add sel $here "$here + $mlen c"
 165                        $w.ent configure -background lightgreen
 166                        _set_marks $this 1
 167                } else {
 168                        $w.ent configure -background lightpink
 169                }
 170        }
 171}
 172
 173method _save_search {} {
 174        if {$searchstring eq {}} {
 175                return
 176        }
 177        if {[llength $history] > 0} {
 178                foreach {s_regexp s_case s_expr} [lindex $history end] break
 179        } else {
 180                set s_regexp $regexpsearch
 181                set s_case   $casesensitive
 182                set s_expr   ""
 183        }
 184        if {$searchstring eq $s_expr} {
 185                # update modes
 186                set history [lreplace $history end end \
 187                                [list $regexpsearch $casesensitive $searchstring]]
 188        } else {
 189                lappend history [list $regexpsearch $casesensitive $searchstring]
 190        }
 191        set history_index [llength $history]
 192}
 193
 194method _prev_search {} {
 195        if {$history_index > 0} {
 196                incr history_index -1
 197                foreach {s_regexp s_case s_expr} [lindex $history $history_index] break
 198                $w.ent delete 0 end
 199                $w.ent insert 0 $s_expr
 200                set regexpsearch $s_regexp
 201                set casesensitive $s_case
 202        }
 203}
 204
 205method _next_search {} {
 206        if {$history_index < [llength $history]} {
 207                incr history_index
 208        }
 209        if {$history_index < [llength $history]} {
 210                foreach {s_regexp s_case s_expr} [lindex $history $history_index] break
 211        } else {
 212                set s_regexp $default_regexpsearch
 213                set s_case   $default_casesensitive
 214                set s_expr   ""
 215        }
 216        $w.ent delete 0 end
 217        $w.ent insert 0 $s_expr
 218        set regexpsearch $s_regexp
 219        set casesensitive $s_case
 220}
 221
 222method find_prev {} {
 223        find_next $this -backwards
 224}
 225
 226method find_next {{dir -forwards}} {
 227        focus $w.ent
 228        $w.ent icursor end
 229        set searchdirn $dir
 230        $ctext mark unset anchor
 231        if {$searchstring ne {}} {
 232                _save_search $this
 233                set start [_get_new_anchor $this]
 234                if {$dir eq "-forwards"} {
 235                        set start "$start + 1c"
 236                }
 237                set match [_do_search $this $start mlen]
 238                $ctext tag remove sel 1.0 end
 239                if {$match ne {}} {
 240                        $ctext see $match
 241                        $ctext tag add sel $match "$match + $mlen c"
 242                }
 243        }
 244}
 245
 246method _mark_range {first last} {
 247        set mend $first.0
 248        while {1} {
 249                set match [_do_search $this $mend mlen -forwards $last.end]
 250                if {$match eq {}} break
 251                set mend "$match + $mlen c"
 252                $ctext tag add found $match $mend
 253        }
 254}
 255
 256method _set_marks {doall} {
 257        set topline [lindex [split [$ctext index @0,0] .] 0]
 258        set botline [lindex [split [$ctext index @0,[winfo height $ctext]] .] 0]
 259        if {$doall || $botline < $smarktop || $topline > $smarkbot} {
 260                # no overlap with previous
 261                _mark_range $this $topline $botline
 262                set smarktop $topline
 263                set smarkbot $botline
 264        } else {
 265                if {$topline < $smarktop} {
 266                        _mark_range $this $topline [expr {$smarktop-1}]
 267                        set smarktop $topline
 268                }
 269                if {$botline > $smarkbot} {
 270                        _mark_range $this [expr {$smarkbot+1}] $botline
 271                        set smarkbot $botline
 272                }
 273        }
 274}
 275
 276method scrolled {} {
 277        if {$searchstring ne {}} {
 278                after idle [cb _set_marks 0]
 279        }
 280}
 281
 282}