05a1ceb85b355fe77efd644ff2da79d91c46d3b2
   1# git-gui spellchecking support through ispell/aspell
   2# Copyright (C) 2008 Shawn Pearce
   3
   4class spellcheck {
   5
   6field s_fd      {} ; # pipe to ispell/aspell
   7field s_version {} ; # ispell/aspell version string
   8field s_lang    {} ; # current language code
   9field s_prog aspell; # are we actually old ispell?
  10field s_failed   0 ; # is $s_prog bogus and not working?
  11
  12field w_text      ; # text widget we are spelling
  13field w_menu      ; # context menu for the widget
  14field s_menuidx 0 ; # last index of insertion into $w_menu
  15
  16field s_i           {} ; # timer registration for _run callbacks
  17field s_clear        0 ; # did we erase mispelled tags yet?
  18field s_seen    [list] ; # lines last seen from $w_text in _run
  19field s_checked [list] ; # lines already checked
  20field s_pending [list] ; # [$line $data] sent to ispell/aspell
  21field s_suggest        ; # array, list of suggestions, keyed by misspelling
  22
  23constructor init {pipe_fd ui_text ui_menu} {
  24        set w_text $ui_text
  25        set w_menu $ui_menu
  26        array unset s_suggest
  27
  28        bind_button3 $w_text [cb _popup_suggest %X %Y @%x,%y]
  29        _connect $this $pipe_fd
  30        return $this
  31}
  32
  33method _connect {pipe_fd} {
  34        fconfigure $pipe_fd \
  35                -encoding utf-8 \
  36                -eofchar {} \
  37                -translation lf
  38
  39        if {[gets $pipe_fd s_version] <= 0} {
  40                if {[catch {close $pipe_fd} err]} {
  41
  42                        # Eh?  Is this actually ispell choking on aspell options?
  43                        #
  44                        if {$s_prog eq {aspell}
  45                                && [regexp -nocase {^Usage: } $err]
  46                                && ![catch {
  47                                                set pipe_fd [open [list | $s_prog -v] r]
  48                                                gets $pipe_fd s_version
  49                                                close $pipe_fd
  50                                }]
  51                                && $s_version ne {}} {
  52                                if {{@(#) } eq [string range $s_version 0 4]} {
  53                                        set s_version [string range $s_version 5 end]
  54                                }
  55                                set s_failed 1
  56                                error_popup [strcat \
  57                                        [mc "Unsupported spell checker"] \
  58                                        ":\n\n$s_version"]
  59                                set s_version {}
  60                                return
  61                        }
  62
  63                        regsub -nocase {^Error: } $err {} err
  64                        if {$s_fd eq {}} {
  65                                error_popup [strcat [mc "Spell checking is unavailable"] ":\n\n$err"]
  66                        } else {
  67                                error_popup [strcat \
  68                                        [mc "Invalid spell checking configuration"] \
  69                                        ":\n\n$err\n\n" \
  70                                        [mc "Reverting dictionary to %s." $s_lang]]
  71                        }
  72                } else {
  73                        error_popup [mc "Spell checker sliently failed on startup"]
  74                }
  75                return
  76        }
  77        if {{@(#) } ne [string range $s_version 0 4]} {
  78                catch {close $pipe_fd}
  79                error_popup [strcat [mc "Unrecognized spell checker"] ":\n\n$s_version"]
  80                return
  81        }
  82        set s_version [string range $s_version 5 end]
  83
  84        puts $pipe_fd !             ; # enable terse mode
  85        puts $pipe_fd {$$cr master} ; # fetch the language
  86        flush $pipe_fd
  87
  88        gets $pipe_fd s_lang
  89        regexp {[/\\]([^/\\]+)\.[^\.]+$} $s_lang _ s_lang
  90
  91        if {$::default_config(gui.spellingdictionary) eq {}
  92         && [get_config gui.spellingdictionary] eq {}} {
  93                set ::default_config(gui.spellingdictionary) $s_lang
  94        }
  95
  96        if {$s_fd ne {}} {
  97                catch {close $s_fd}
  98        }
  99        set s_fd $pipe_fd
 100
 101        fconfigure $s_fd -blocking 0
 102        fileevent $s_fd readable [cb _read]
 103
 104        $w_text tag conf misspelled \
 105                -foreground red \
 106                -underline 1
 107
 108        array unset s_suggest
 109        set s_seen    [list]
 110        set s_checked [list]
 111        set s_pending [list]
 112        _run $this
 113}
 114
 115method lang {{n {}}} {
 116        if {$n ne {} && $s_lang ne $n && !$s_failed} {
 117                set spell_cmd [list |]
 118                lappend spell_cmd aspell
 119                lappend spell_cmd --master=$n
 120                lappend spell_cmd --mode=none
 121                lappend spell_cmd --encoding=UTF-8
 122                lappend spell_cmd pipe
 123                _connect $this [open $spell_cmd r+]
 124        }
 125        return $s_lang
 126}
 127
 128method version {} {
 129        if {$s_version ne {}} {
 130                return "$s_version, $s_lang"
 131        }
 132        return {}
 133}
 134
 135method stop {} {
 136        while {$s_menuidx > 0} {
 137                $w_menu delete 0
 138                incr s_menuidx -1
 139        }
 140        $w_text tag delete misspelled
 141
 142        catch {close $s_fd}
 143        catch {after cancel $s_i}
 144        set s_fd {}
 145        set s_i {}
 146        set s_lang {}
 147}
 148
 149method _popup_suggest {X Y pos} {
 150        while {$s_menuidx > 0} {
 151                $w_menu delete 0
 152                incr s_menuidx -1
 153        }
 154
 155        set b_loc [$w_text index "$pos wordstart"]
 156        set e_loc [_wordend $this $b_loc]
 157        set orig  [$w_text get $b_loc $e_loc]
 158        set tags  [$w_text tag names $b_loc]
 159
 160        if {[lsearch -exact $tags misspelled] >= 0} {
 161                if {[info exists s_suggest($orig)]} {
 162                        set cnt 0
 163                        foreach s $s_suggest($orig) {
 164                                if {$cnt < 5} {
 165                                        $w_menu insert $s_menuidx command \
 166                                                -label $s \
 167                                                -command [cb _replace $b_loc $e_loc $s]
 168                                        incr s_menuidx
 169                                        incr cnt
 170                                } else {
 171                                        break
 172                                }
 173                        }
 174                } else {
 175                        $w_menu insert $s_menuidx command \
 176                                -label [mc "No Suggestions"] \
 177                                -state disabled
 178                        incr s_menuidx
 179                }
 180                $w_menu insert $s_menuidx separator
 181                incr s_menuidx
 182        }
 183
 184        $w_text mark set saved-insert insert
 185        tk_popup $w_menu $X $Y
 186}
 187
 188method _replace {b_loc e_loc word} {
 189        $w_text configure -autoseparators 0
 190        $w_text edit separator
 191
 192        $w_text delete $b_loc $e_loc
 193        $w_text insert $b_loc $word
 194
 195        $w_text edit separator
 196        $w_text configure -autoseparators 1
 197        $w_text mark set insert saved-insert
 198}
 199
 200method _restart_timer {} {
 201        set s_i [after 300 [cb _run]]
 202}
 203
 204proc _match_length {max_line arr_name} {
 205        upvar $arr_name a
 206
 207        if {[llength $a] > $max_line} {
 208                set a [lrange $a 0 $max_line]
 209        }
 210        while {[llength $a] <= $max_line} {
 211                lappend a {}
 212        }
 213}
 214
 215method _wordend {pos} {
 216        set pos  [$w_text index "$pos wordend"]
 217        set tags [$w_text tag names $pos]
 218        while {[lsearch -exact $tags misspelled] >= 0} {
 219                set pos  [$w_text index "$pos +1c"]
 220                set tags [$w_text tag names $pos]
 221        }
 222        return $pos
 223}
 224
 225method _run {} {
 226        set cur_pos  [$w_text index {insert -1c}]
 227        set cur_line [lindex [split $cur_pos .] 0]
 228        set max_line [lindex [split [$w_text index end] .] 0]
 229        _match_length $max_line s_seen
 230        _match_length $max_line s_checked
 231
 232        # Nothing in the message buffer?  Nothing to spellcheck.
 233        #
 234        if {$cur_line == 1
 235         && $max_line == 2
 236         && [$w_text get 1.0 end] eq "\n"} {
 237                array unset s_suggest
 238                _restart_timer $this
 239                return
 240        }
 241
 242        set active 0
 243        for {set n 1} {$n <= $max_line} {incr n} {
 244                set s [$w_text get "$n.0" "$n.end"]
 245
 246                # Don't spellcheck the current line unless we are at
 247                # a word boundary.  The user might be typing on it.
 248                #
 249                if {$n == $cur_line
 250                 && ![regexp {^\W$} [$w_text get $cur_pos insert]]} {
 251
 252                        # If the current word is mispelled remove the tag
 253                        # but force a spellcheck later.
 254                        #
 255                        set tags [$w_text tag names $cur_pos]
 256                        if {[lsearch -exact $tags misspelled] >= 0} {
 257                                $w_text tag remove misspelled \
 258                                        "$cur_pos wordstart" \
 259                                        [_wordend $this $cur_pos]
 260                                lset s_seen    $n $s
 261                                lset s_checked $n {}
 262                        }
 263
 264                        continue
 265                }
 266
 267                if {[lindex $s_seen    $n] eq $s
 268                 && [lindex $s_checked $n] ne $s} {
 269                        # Don't send empty lines to Aspell it doesn't check them.
 270                        #
 271                        if {$s eq {}} {
 272                                lset s_checked $n $s
 273                                continue
 274                        }
 275
 276                        # Don't send typical s-b-o lines as the emails are
 277                        # almost always misspelled according to Aspell.
 278                        #
 279                        if {[regexp -nocase {^[a-z-]+-by:.*<.*@.*>$} $s]} {
 280                                $w_text tag remove misspelled "$n.0" "$n.end"
 281                                lset s_checked $n $s
 282                                continue
 283                        }
 284
 285                        puts $s_fd ^$s
 286                        lappend s_pending [list $n $s]
 287                        set active 1
 288                } else {
 289                        # Delay until another idle loop to make sure we don't
 290                        # spellcheck lines the user is actively changing.
 291                        #
 292                        lset s_seen $n $s
 293                }
 294        }
 295
 296        if {$active} {
 297                set s_clear 1
 298                flush $s_fd
 299        } else {
 300                _restart_timer $this
 301        }
 302}
 303
 304method _read {} {
 305        while {[gets $s_fd line] >= 0} {
 306                set lineno [lindex $s_pending 0 0]
 307
 308                if {$s_clear} {
 309                        $w_text tag remove misspelled "$lineno.0" "$lineno.end"
 310                        set s_clear 0
 311                }
 312
 313                if {$line eq {}} {
 314                        lset s_checked $lineno [lindex $s_pending 0 1]
 315                        set s_pending [lrange $s_pending 1 end]
 316                        set s_clear 1
 317                        continue
 318                }
 319
 320                set sugg [list]
 321                switch -- [string range $line 0 1] {
 322                {& } {
 323                        set line [split [string range $line 2 end] :]
 324                        set info [split [lindex $line 0] { }]
 325                        set orig [lindex $info 0]
 326                        set offs [lindex $info 2]
 327                        foreach s [split [lindex $line 1] ,] {
 328                                lappend sugg [string range $s 1 end]
 329                        }
 330                }
 331                {# } {
 332                        set info [split [string range $line 2 end] { }]
 333                        set orig [lindex $info 0]
 334                        set offs [lindex $info 1]
 335                }
 336                default {
 337                        puts stderr "<spell> $line"
 338                        continue
 339                }
 340                }
 341
 342                incr offs -1
 343                set b_loc "$lineno.$offs"
 344                set e_loc [$w_text index "$lineno.$offs wordend"]
 345                set curr [$w_text get $b_loc $e_loc]
 346
 347                # At least for English curr = "bob", orig = "bob's"
 348                # so Tk didn't include the 's but Aspell did.  We
 349                # try to round out the word.
 350                #
 351                while {$curr ne $orig
 352                 && [string equal -length [string length $curr] $curr $orig]} {
 353                        set n_loc  [$w_text index "$e_loc +1c"]
 354                        set n_curr [$w_text get $b_loc $n_loc]
 355                        if {$n_curr eq $curr} {
 356                                break
 357                        }
 358                        set curr  $n_curr
 359                        set e_loc $n_loc
 360                }
 361
 362                if {$curr eq $orig} {
 363                        $w_text tag add misspelled $b_loc $e_loc
 364                        if {[llength $sugg] > 0} {
 365                                set s_suggest($orig) $sugg
 366                        } else {
 367                                unset -nocomplain s_suggest($orig)
 368                        }
 369                } else {
 370                        unset -nocomplain s_suggest($orig)
 371                }
 372        }
 373
 374        fconfigure $s_fd -block 1
 375        if {[eof $s_fd]} {
 376                if {![catch {close $s_fd} err]} {
 377                        set err [mc "Unexpected EOF from spell checker"]
 378                }
 379                catch {after cancel $s_i}
 380                $w_text tag remove misspelled 1.0 end
 381                error_popup [strcat [mc "Spell Checker Failed"] "\n\n" $err]
 382                return
 383        }
 384        fconfigure $s_fd -block 0
 385
 386        if {[llength $s_pending] == 0} {
 387                _restart_timer $this
 388        }
 389}
 390
 391proc available_langs {} {
 392        set langs [list]
 393        catch {
 394                set fd [open [list | aspell dump dicts] r]
 395                while {[gets $fd line] >= 0} {
 396                        if {$line eq {}} continue
 397                        lappend langs $line
 398                }
 399                close $fd
 400        }
 401        return $langs
 402}
 403
 404}