Newer
Older
;;; flyspell.el --- On-the-fly spell checker
;; Copyright (C) 1998 Free Software Foundation, Inc.
;; Author: Manuel Serrano <Manuel.Serrano@unice.fr>
;; Keywords: convenience
;;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; commentary:
;;
;; Flyspell is a minor Emacs mode performing on-the-fly spelling
;; checking.
;;
;; To install flyspell, add this to your ~/.emacs file:
;;
;; (autoload 'flyspell-mode "flyspell" "On-the-fly spelling checking" t)
;; (autoload 'global-flyspell-mode "flyspell" "On-the-fly spelling" t)
;;
;; To enable Flyspell minor mode, type Meta-x flyspell-mode.
;; This applies only to the current buffer.
;;
;; Or if you want to turn Flyspell mode on in many buffers, add this to
;; you ~/.emacs file:
;;
;; (global-flyspell-mode t)
;;
;; Note: consider setting the variable ispell-parser to `tex' to
;; avoid TeX command checking; use `(setq ispell-parser 'tex)'
;; _before_ entering flyspell.
;;
;; Some user variables control the behavior of flyspell. They are
;; those defined under the `User variables' comment.
;;; Code:
(require 'ispell)
;*---------------------------------------------------------------------*/
;* Group ... */
;*---------------------------------------------------------------------*/
(defgroup flyspell nil
"Spellchecking on the fly."
:tag "FlySpell"
:prefix "flyspell-"
;*---------------------------------------------------------------------*/
;*---------------------------------------------------------------------*/
(defcustom flyspell-highlight-flag t
"*How Flyspell should indicate misspelled words.
Non-nil means use highlight, nil means use minibuffer messages."
:group 'flyspell
:type 'boolean)
(defcustom flyspell-mark-duplications-flag t
"*Non-nil means Flyspell reports a repeated word as an error."
:group 'flyspell
:type 'boolean)
(defcustom flyspell-sort-corrections t
"*Non-nil means, sort the corrections alphabetically before popping them."
:group 'flyspell
:type 'boolean)
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
"*The maximum distance for finding duplicates of unrecognized words.
This applies to the feature that when a word is not found in the dictionary,
if the same spelling occurs elsewhere in the buffer,
Flyspell uses a different face (`flyspell-duplicate-face') to highlight it.
This variable specifies how far to search to find such a duplicate.
-1 means no limit (search the whole buffer).
0 means do not search for duplicate unrecognized spellings."
:group 'flyspell
:type 'number)
(defcustom flyspell-delay 3
"*The number of seconds to wait before checking, after a \"delayed\" command."
:group 'flyspell
:type 'number)
(defcustom flyspell-persistent-highlight t
"*Non-nil means misspelled words remain highlighted until corrected.
If this variable is nil, only the most recently detected misspelled word
is highlighted."
:group 'flyspell
:type 'boolean)
(defcustom flyspell-highlight-properties t
"*Non-nil means highlight incorrect words even if a property exists for this word."
:group 'flyspell
:type 'boolean)
(defcustom flyspell-default-delayed-commands
'(self-insert-command
delete-backward-char
delete-char)
"The standard list of delayed commands for Flyspell.
See `flyspell-delayed-commands'."
:group 'flyspell
:type '(repeat (symbol)))
(defcustom flyspell-delayed-commands nil
"List of commands that are \"delayed\" for Flyspell mode.
After these commands, Flyspell checking is delayed for a short time,
whose length is specified by `flyspell-delay'."
:group 'flyspell
:type '(repeat (symbol)))
(defcustom flyspell-issue-welcome-flag t
"*Non-nil means that Flyspell should display a welcome message when started."
:group 'flyspell
:type 'boolean)
(defcustom flyspell-incorrect-hook nil
"*List of functions to be called when incorrect words are encountered.
Each function is given two arguments: the beginning and the end
of the incorrect region."
:group 'flyspell)
(defcustom flyspell-default-dictionary "american"
"A string that is the name of the default dictionary.
This is passed to the ispell-change-dictionary when flyspell is started.
If the variables ispell-local-dictionary or ispell-dictionary are non nil
when flyspell is started, the value of that variables is used instead
of flyspell-default-dictionary to select the default dictionary."
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
:type 'string)
(defcustom flyspell-global-modes t
"*Modes for which Flyspell mode is automagically turned on.
Global Flyspell mode is controlled by the `global-flyspell-mode' command.
If nil, means no modes have Flyspell mode automatically turned on.
If t, all modes have it automatically turned on.
If a list, it should be a list of `major-mode' symbol names for which Flyspell
mode should be automatically turned on. The sense of the list is negated if it
begins with `not'. For example:
(tex-mode mail-mode)
means that Flyspell mode is turned on for buffers in tex and mail-mode
modes only."
:type '(choice (const :tag "none" nil)
(const :tag "all" t)
(set :menu-tag "mode specific" :tag "modes"
:value (not)
(const :tag "Except" not)
(repeat :inline t (symbol :tag "mode"))))
:group 'flyspell)
(defcustom flyspell-dictionaries-that-consider-dash-as-word-delimiter
'("francais" "deutsch8")
"List of dictionary names that consider `-' as word delimiter."
:group 'flyspell
:type '(repeat (string)))
;;;###autoload
(defcustom flyspell-mode-line-string " Fly"
"*String displayed on the modeline when flyspell is active.
Set this to nil if you don't want a modeline indicator."
:group 'flyspell
:type 'string)
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
;*---------------------------------------------------------------------*/
;* Mode specific options */
;* ------------------------------------------------------------- */
;* Mode specific options enable users to disable flyspell on */
;* certain word depending of the emacs mode. For instance, when */
;* using flyspell with mail-mode add the following expression */
;* in your .emacs file: */
;* (add-hook 'mail-mode */
;* '(lambda () (setq flyspell-generic-check-word-p */
;* 'mail-mode-flyspell-verify))) */
;*---------------------------------------------------------------------*/
(defvar flyspell-generic-check-word-p nil
"Function providing per-mode customization over which words are flyspelled.
Returns t to continue checking, nil otherwise.
Flyspell mode sets this variable to whatever is the `flyspell-mode-predicate'
property of the major mode name.")
(make-variable-buffer-local 'flyspell-generic-check-word-p)
(put 'mail-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
(put 'message-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
(defun mail-mode-flyspell-verify ()
"This function is used for `flyspell-generic-check-word-p' in Mail mode."
(save-excursion
(or (progn
(beginning-of-line)
(looking-at "Subject:"))
(not (or (re-search-forward mail-header-separator nil t)
(re-search-backward message-signature-separator nil t)
(progn
(beginning-of-line)
(looking-at "[>}|]")))))))
(put 'texinfo-mode 'flyspell-mode-predicate 'texinfo-mode-flyspell-verify)
(defun texinfo-mode-flyspell-verify ()
"This function is used for `flyspell-generic-check-word-p' in Texinfo mode."
(save-excursion
(forward-word -1)
(not (looking-at "@"))))
;*---------------------------------------------------------------------*/
;* Overlay compatibility */
;*---------------------------------------------------------------------*/
(autoload 'make-overlay "overlay" "" t)
(autoload 'move-overlay "overlay" "" t)
(autoload 'overlayp "overlay" "" t)
(autoload 'overlay-properties "overlay" "" t)
(autoload 'overlays-in "overlay" "" t)
(autoload 'delete-overlay "overlay" "" t)
(autoload 'overlays-at "overlay" "" t)
(autoload 'overlay-put "overlay" "" t)
(autoload 'overlay-get "overlay" "" t)
;*---------------------------------------------------------------------*/
;* Which emacs are we currently running */
;*---------------------------------------------------------------------*/
(defvar flyspell-emacs
(cond
((string-match "XEmacs" emacs-version)
'xemacs)
(t
'emacs))
"The type of Emacs we are currently running.")
;*---------------------------------------------------------------------*/
;* The minor mode declaration. */
;*---------------------------------------------------------------------*/
(make-variable-buffer-local 'flyspell-mode)
;;; XEmacs change: add autoload for flyspell-mode-map
;;;###autoload
(defvar flyspell-mode-map (make-sparse-keymap))
(defvar flyspell-mouse-map (make-sparse-keymap))
(define-key flyspell-mode-map "\M-\t" 'flyspell-auto-correct-word)
;; mouse bindings
(cond
((eq flyspell-emacs 'xemacs)
(define-key flyspell-mouse-map [(button2)]
(function flyspell-correct-word/mouse-keymap)))
(t
(define-key flyspell-mode-map [(mouse-2)]
(function flyspell-correct-word/local-keymap))))
;; the name of the overlay property that defines the keymap
(defvar flyspell-overlay-keymap-property-name
(if (string-match "19.*XEmacs" emacs-version)
'keymap
'local-map))
;; dash character machinery
(defvar flyspell-consider-dash-as-word-delimiter-flag nil
"*Non-nil means that the `-' char is considered as a word delimiter.")
(make-variable-buffer-local 'flyspell-consider-dash-as-word-delimiter-flag)
(defvar flyspell-dash-dictionary nil)
(make-variable-buffer-local 'flyspell-dash-dictionary)
(defvar flyspell-dash-local-dictionary nil)
(make-variable-buffer-local 'flyspell-dash-local-dictionary)
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
;*---------------------------------------------------------------------*/
;* Highlighting */
;*---------------------------------------------------------------------*/
(defface flyspell-incorrect-face
'((((class color)) (:foreground "OrangeRed" :bold t :underline t))
(t (:bold t)))
"Face used for marking a misspelled word in Flyspell."
:group 'flyspell)
(defface flyspell-duplicate-face
'((((class color)) (:foreground "Gold3" :bold t :underline t))
(t (:bold t)))
"Face used for marking a misspelled word that appears twice in the buffer.
See also `flyspell-duplicate-distance'."
:group 'flyspell)
(defvar flyspell-overlay nil)
;*---------------------------------------------------------------------*/
;* flyspell-mode ... */
;*---------------------------------------------------------------------*/
;;;###autoload
(defun flyspell-mode (&optional arg)
"Minor mode performing on-the-fly spelling checking.
Ispell is automatically spawned on background for each entered words.
The default flyspell behavior is to highlight incorrect words.
With no argument, this command toggles Flyspell mode.
With a prefix argument ARG, turn Flyspell minor mode on iff ARG is positive.
Alternatively, you can use Global Flyspell mode to automagically turn on
Flyspell in buffers whose major mode supports it and whose major mode is one
of `flyspell-global-modes'. For example, put in your ~/.emacs:
(global-flyspell-mode t)
Bindings:
\\[ispell-word]: correct words (using Ispell).
\\[flyspell-auto-correct-word]: automatically correct word.
\\[flyspell-correct-word] (or mouse-2): popup correct words.
Hooks:
Remark:
`flyspell-mode' uses `ispell-mode'. Thus all Ispell options are
valid. For instance, a personal dictionary can be used by
invoking `ispell-change-dictionary'.
Consider using the `ispell-parser' to check your text. For instance
consider adding:
\(add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))
in your .emacs file.
flyspell-region checks all words inside a region.
flyspell-buffer checks the whole buffer."
(interactive "P")
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
(let ((old-flyspell-mode flyspell-mode))
;; Mark the mode as on or off.
(setq flyspell-mode (not (or (and (null arg) flyspell-mode)
(<= (prefix-numeric-value arg) 0))))
;; Do the real work.
(unless (eq flyspell-mode old-flyspell-mode)
(if flyspell-mode
(flyspell-mode-on)
(flyspell-mode-off))
;; Force modeline redisplay.
(set-buffer-modified-p (buffer-modified-p)))))
;*---------------------------------------------------------------------*/
;* flyspell-buffers ... */
;* ------------------------------------------------------------- */
;* For remembering buffers running flyspell */
;*---------------------------------------------------------------------*/
(defvar flyspell-buffers nil)
;*---------------------------------------------------------------------*/
;* global-flyspell-mode ... */
;* ------------------------------------------------------------- */
;* I have stolen this implementation from Global Font Lock mode. */
;* I use the exact same trick. */
;*---------------------------------------------------------------------*/
;;;###autoload
(defun global-flyspell-mode (&optional arg message)
"Toggle Global Flyspell mode.
With prefix ARG, turn Global Flyspell mode on if and only if ARG is positive.
Displays a message saying whether the mode is on or off if MESSAGE is non-nil.
Returns the new status of Global Flyspell mode (non-nil means on).
When Global Flyspell mode is enabled, Flyspell mode is automagically
turned on in a buffer if its major mode is one of `flyspell-global-modes'."
(interactive "P\np")
(let ((on-p (if arg
(> (prefix-numeric-value arg) 0)
(not global-flyspell-mode))))
(cond (on-p
(add-hook 'find-file-hooks 'turn-on-flyspell-if-enabled)
(add-hook 'first-change-hook 'turn-on-flyspell-if-enabled)
(mapcar '(lambda (buffer)
(with-current-buffer buffer
(turn-on-flyspell-if-enabled)))
(buffer-list)))
(t
(remove-hook 'find-file-hooks 'turn-on-flyspell-if-enabled)
(remove-hook 'first-change-hook 'turn-on-flyspell-if-enabled)
(mapcar '(lambda (buffer)
(with-current-buffer buffer
(when flyspell-mode
(flyspell-mode))))
(buffer-list))))
(when message
(message "Global Flyspell mode %s." (if on-p "enabled" "disabled")))
(setq global-flyspell-mode on-p)))
;*---------------------------------------------------------------------*/
;* global-flyspell-mode ... */
;*---------------------------------------------------------------------*/
(defcustom global-flyspell-mode nil
"Toggle Global Flyspell mode.
When Global Flyspell mode is enabled, Flyspell mode is automagically
turned on in a buffer if its major mode is one of `flyspell-global-modes'.
You must modify via \\[customize] for this variable to have an effect."
:set (lambda (symbol value)
(global-flyspell-mode (or value 0)))
:type 'boolean
:group 'flyspell
:require 'flyspell)
;*---------------------------------------------------------------------*/
;* turn-on-flyspell-if-enabled ... */
;*---------------------------------------------------------------------*/
(defun turn-on-flyspell-if-enabled ()
;; Gross hack warning: Delicate readers should avert eyes now.
;; Turn on Flyspell mode if it's supported by the major mode and enabled by
;; the user.
(if (flyspell-global-mode-enabled-p (current-buffer))
(flyspell-mode t)))
;*---------------------------------------------------------------------*/
;* flyspell-global-mode-enabled-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-global-mode-enabled-p (buffer)
"Does BUFFER need to activate Flyspell?"
(and global-flyspell-mode
(not (flyspell-minibuffer-p buffer))
(or (eq flyspell-global-modes t)
(if (eq (car-safe flyspell-global-modes) 'not)
(not (memq major-mode (cdr flyspell-global-modes)))
(memq major-mode flyspell-global-modes)))))
;*---------------------------------------------------------------------*/
;* flyspell-minibuffer-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-minibuffer-p (buffer)
"Is BUFFER a minibuffer?"
(let ((ws (get-buffer-window-list buffer t)))
(and (consp ws) (window-minibuffer-p (car ws)))))
;*---------------------------------------------------------------------*/
;* flyspell-accept-buffer-local-defs ... */
;*---------------------------------------------------------------------*/
(defun flyspell-accept-buffer-local-defs ()
(ispell-accept-buffer-local-defs)
(if (not (and (eq flyspell-dash-dictionary ispell-dictionary)
(eq flyspell-dash-local-dictionary ispell-local-dictionary)))
;; the dictionary as changed
(progn
(setq flyspell-dash-dictionary ispell-dictionary)
(setq flyspell-dash-local-dictionary ispell-local-dictionary)
(if (member (or ispell-local-dictionary ispell-dictionary)
flyspell-dictionaries-that-consider-dash-as-word-delimiter)
(setq flyspell-consider-dash-as-word-delimiter-flag t)
(setq flyspell-consider-dash-as-word-delimiter-flag nil)))))
;*---------------------------------------------------------------------*/
;* flyspell-mode-on ... */
;*---------------------------------------------------------------------*/
(defun flyspell-mode-on ()
"Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead."
(setq ispell-highlight-face 'flyspell-incorrect-face)
;; local dictionaries setup
(ispell-change-dictionary
(or ispell-local-dictionary flyspell-default-dictionary))
;; we have to force ispell to accept the local definition or
;; otherwise it could be too late, the local dictionary may
;; be forgotten!
(flyspell-accept-buffer-local-defs)
;; we put the `flyspel-delayed' property on some commands
(flyspell-delay-commands)
;; we bound flyspell action to post-command hook
(make-local-hook 'post-command-hook)
(add-hook 'post-command-hook (function flyspell-post-command-hook) t t)
;; we bound flyspell action to pre-command hook
(make-local-hook 'pre-command-hook)
(add-hook 'pre-command-hook (function flyspell-pre-command-hook) t t)
;; we bound flyspell action to after-change hook
(make-local-variable 'after-change-functions)
(setq after-change-functions
(cons 'flyspell-after-change-function after-change-functions))
;; set flyspell-generic-check-word-p based on the major mode
(let ((mode-predicate (get major-mode 'flyspell-mode-predicate)))
(if mode-predicate
(setq flyspell-generic-check-word-p mode-predicate)))
;; the welcome message
(if flyspell-issue-welcome-flag
(let ((binding (where-is-internal 'flyspell-auto-correct-word
nil 'non-ascii)))
(message
(if binding
(format "Welcome to flyspell. Use %s or Mouse-2 to correct words."
;; we end with the flyspell hooks
(run-hooks 'flyspell-mode-hook))
;*---------------------------------------------------------------------*/
;* flyspell-delay-commands ... */
;*---------------------------------------------------------------------*/
(defun flyspell-delay-commands ()
(mapcar 'flyspell-delay-command flyspell-default-delayed-commands)
(mapcar 'flyspell-delay-command flyspell-delayed-commands))
;*---------------------------------------------------------------------*/
;* flyspell-delay-command ... */
;*---------------------------------------------------------------------*/
(defun flyspell-delay-command (command)
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
When flyspell `post-command-hook' is invoked because a delayed command
as been used the current word is not immediatly checked.
It will be checked only after `flyspell-delay' seconds."
(interactive "SDelay Flyspell after Command: ")
(put command 'flyspell-delayed t))
;*---------------------------------------------------------------------*/
;* flyspell-ignore-commands ... */
;*---------------------------------------------------------------------*/
(defun flyspell-ignore-commands ()
"This is an obsolete function, use `flyspell-delay-commands' instead."
(flyspell-delay-commands))
;*---------------------------------------------------------------------*/
;* flyspell-ignore-command ... */
;*---------------------------------------------------------------------*/
(defun flyspell-ignore-command (command)
"This is an obsolete function, use `flyspell-delay-command' instead.
COMMAND is the name of the command to be delayed."
(flyspell-delay-command command))
(make-obsolete 'flyspell-ignore-commands 'flyspell-delay-commands)
(make-obsolete 'flyspell-ignore-command 'flyspell-delay-command)
;*---------------------------------------------------------------------*/
;* flyspell-word-cache ... */
;*---------------------------------------------------------------------*/
(defvar flyspell-word-cache-start nil)
(defvar flyspell-word-cache-end nil)
(defvar flyspell-word-cache-word nil)
(make-variable-buffer-local 'flyspell-word-cache-start)
(make-variable-buffer-local 'flyspell-word-cache-end)
(make-variable-buffer-local 'flyspell-word-cache-word)
;*---------------------------------------------------------------------*/
;* The flyspell pre-hook, store the current position. In the */
;* post command hook, we will check, if the word at this position */
;* has to be spell checked. */
;*---------------------------------------------------------------------*/
(defvar flyspell-pre-buffer nil)
(defvar flyspell-pre-point nil)
(defvar flyspell-pre-pre-buffer nil)
(defvar flyspell-pre-pre-point nil)
;*---------------------------------------------------------------------*/
;* flyspell-pre-command-hook ... */
;*---------------------------------------------------------------------*/
(defun flyspell-pre-command-hook ()
"Save the current buffer and point for Flyspell's post-command hook."
(interactive)
(setq flyspell-pre-buffer (current-buffer))
(setq flyspell-pre-point (point)))
;*---------------------------------------------------------------------*/
;* flyspell-mode-off ... */
;*---------------------------------------------------------------------*/
;; we remove the hooks
(remove-hook 'post-command-hook (function flyspell-post-command-hook) t)
(remove-hook 'pre-command-hook (function flyspell-pre-command-hook) t)
(setq after-change-functions (delq 'flyspell-after-change-function
after-change-functions))
;; we remove all the flyspell hilightings
(flyspell-delete-all-overlays)
;; we have to erase pre cache variables
(setq flyspell-pre-buffer nil)
(setq flyspell-pre-point nil)
;; we mark the mode as killed
(setq flyspell-mode nil))
;*---------------------------------------------------------------------*/
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
;* flyspell-check-pre-word-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-check-pre-word-p ()
"Return non-nil if we should to check the word before point.
More precisely, it applies to the word that was before point
before the current command."
(cond
((or (not (numberp flyspell-pre-point))
(not (bufferp flyspell-pre-buffer))
(not (buffer-live-p flyspell-pre-buffer)))
nil)
((and (eq flyspell-pre-pre-point flyspell-pre-point)
(eq flyspell-pre-pre-buffer flyspell-pre-buffer))
nil)
((or (and (= flyspell-pre-point (- (point) 1))
(eq (char-syntax (char-after flyspell-pre-point)) ?w))
(= flyspell-pre-point (point))
(= flyspell-pre-point (+ (point) 1)))
nil)
((not (eq (current-buffer) flyspell-pre-buffer))
t)
((not (and (numberp flyspell-word-cache-start)
(numberp flyspell-word-cache-end)))
t)
(t
(or (< flyspell-pre-point flyspell-word-cache-start)
(> flyspell-pre-point flyspell-word-cache-end)))))
;*---------------------------------------------------------------------*/
;* The flyspell after-change-hook, store the change position. In */
;* the post command hook, we will check, if the word at this */
;* position has to be spell checked. */
;*---------------------------------------------------------------------*/
(defvar flyspell-changes nil)
;*---------------------------------------------------------------------*/
;* flyspell-after-change-function ... */
;*---------------------------------------------------------------------*/
(defun flyspell-after-change-function (start stop len)
"Save the current buffer and point for Flyspell's post-command hook."
(interactive)
(setq flyspell-changes (cons (cons start stop) flyspell-changes)))
;*---------------------------------------------------------------------*/
;* flyspell-check-changed-word-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-check-changed-word-p (start stop)
"Return t when the changed word has to be checked.
The answer depends of several criteria.
Mostly we check word delimiters."
(cond
((and (>= flyspell-pre-point start) (<= flyspell-pre-point stop))
nil)
((let ((pos (point)))
(or (>= pos start) (<= pos stop) (= pos (1+ stop))))
nil)
(t
t)))
;*---------------------------------------------------------------------*/
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
;* flyspell-check-word-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-check-word-p ()
"Return t when the word at `point' has to be checked.
The answer depends of several criteria.
Mostly we check word delimiters."
(cond
((<= (- (point-max) 1) (point-min))
;; the buffer is not filled enough
nil)
((not (and (symbolp this-command) (get this-command 'flyspell-delayed)))
;; the current command is not delayed, that
;; is that we must check the word now
t)
((and (> (point) (point-min))
(save-excursion
(backward-char 1)
(and (looking-at (flyspell-get-not-casechars))
(or flyspell-consider-dash-as-word-delimiter-flag
(not (looking-at "\\-"))))))
;; yes because we have reached or typed a word delimiter.
t)
((not (integerp flyspell-delay))
;; yes because the user had set up a no-delay configuration.
t)
(t
(if (fboundp 'about-xemacs)
(sit-for flyspell-delay nil)
(sit-for flyspell-delay 0 nil)))))
;*---------------------------------------------------------------------*/
;* flyspell-post-command-hook ... */
;* ------------------------------------------------------------- */
;* It is possible that we check several words: */
;* 1- the current word is checked if the predicate */
;* FLYSPELL-CHECK-WORD-P is true */
;* 2- the word that used to be the current word before the */
;* THIS-COMMAND is checked if: */
;* a- the previous word is different from the current word */
;* b- the previous word as not just been checked by the */
;* previous FLYSPELL-POST-COMMAND-HOOK */
;* 3- the words changed by the THIS-COMMAND that are neither the */
;* previous word nor the current word */
;*---------------------------------------------------------------------*/
(defun flyspell-post-command-hook ()
"The `post-command-hook' used by flyspell to check a word in-the-fly."
(interactive)
(if (flyspell-check-pre-word-p)
(save-excursion
(set-buffer flyspell-pre-buffer)
(save-excursion
(goto-char flyspell-pre-point)
(flyspell-word))))
(if (flyspell-check-word-p)
(progn
(flyspell-word)
;; we remember which word we have just checked.
;; this will be use next time we will check a word
;; to compare the next current word with the word
;; that as been registered in the pre-command-hook
;; that is these variables are used within the predicate
;; FLYSPELL-CHECK-PRE-WORD-P
(setq flyspell-pre-pre-buffer (current-buffer))
(setq flyspell-pre-pre-point (point)))
(progn
(setq flyspell-pre-pre-buffer nil)
(setq flyspell-pre-pre-point nil)
;; when a word is not checked because of a delayed command
;; we do not disable the ispell cache.
(if (and (symbolp this-command) (get this-command 'flyspell-delayed))
(setq flyspell-word-cache-end -1))))
(while (consp flyspell-changes)
(let ((start (car (car flyspell-changes)))
(stop (cdr (car flyspell-changes))))
(if (flyspell-check-changed-word-p start stop)
(save-excursion
(goto-char start)
(flyspell-word)))
(setq flyspell-changes (cdr flyspell-changes)))))
;*---------------------------------------------------------------------*/
;* flyspell-word ... */
;*---------------------------------------------------------------------*/
(defun flyspell-word (&optional following)
"Spell check a word."
(interactive (list current-prefix-arg))
(if (interactive-p)
(setq following ispell-following-word))
(save-excursion
;; use the correct dictionary
(flyspell-accept-buffer-local-defs)
(let ((cursor-location (point))
start end poss)
(if (or (eq word nil)
(and (fboundp flyspell-generic-check-word-p)
(not (funcall flyspell-generic-check-word-p))))
t
(progn
;; destructure return word info list.
(setq start (car (cdr word))
end (car (cdr (cdr word)))
word (car word))
;; before checking in the directory, we check for doublons.
(cond
((and (or (not (eq ispell-parser 'tex))
(not (eq (char-after start) ?\\)))
flyspell-mark-duplications-flag
(save-excursion
(goto-char start)
(word-search-backward word
(- start
(+ 1 (- end start)))
t)))
;; yes, this is a doublon
(flyspell-highlight-incorrect-region start end))
((and (eq flyspell-word-cache-start start)
(eq flyspell-word-cache-end end)
(string-equal flyspell-word-cache-word word))
;; this word had been already checked, we skip
nil)
((and (eq ispell-parser 'tex)
(flyspell-tex-command-p word))
;; this is a correct word (because a tex command)
(flyspell-unhighlight-at start)
(if (> end start)
(flyspell-unhighlight-at (- end 1)))
t)
(t
;; we setup the cache
(setq flyspell-word-cache-start start)
(setq flyspell-word-cache-end end)
(setq flyspell-word-cache-word word)
;; now check spelling of word.
(process-send-string ispell-process "%\n")
;; put in verbose mode
(process-send-string ispell-process
(concat "^" word "\n"))
;; we mark the ispell process so it can be killed
;; when emacs is exited without query
(if (fboundp 'process-kill-without-query)
(process-kill-without-query ispell-process))
;; wait until ispell has processed word
(while (progn
(accept-process-output ispell-process)
(not (string= "" (car ispell-filter)))))
;; (process-send-string ispell-process "!\n")
;; back to terse mode.
(setq ispell-filter (cdr ispell-filter))
(setq poss (ispell-parse-output (car ispell-filter))))
(cond ((eq poss t)
;; correct
(flyspell-unhighlight-at start)
(if (> end start)
(flyspell-unhighlight-at (- end 1)))
t)
((and (stringp poss) flyspell-highlight-flag)
;; correct
(flyspell-unhighlight-at start)
(if (> end start)
(flyspell-unhighlight-at (- end 1)))
t)
((null poss)
(flyspell-unhighlight-at start)
(if (> end start)
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
((or (and (< flyspell-duplicate-distance 0)
(or (save-excursion
(goto-char start)
(word-search-backward word
(point-min)
t))
(save-excursion
(goto-char end)
(word-search-forward word
(point-max)
t))))
(and (> flyspell-duplicate-distance 0)
(or (save-excursion
(goto-char start)
(word-search-backward
word
(- start
flyspell-duplicate-distance)
t))
(save-excursion
(goto-char end)
(word-search-forward
word
(+ end
flyspell-duplicate-distance)
t)))))
(if flyspell-highlight-flag
(flyspell-highlight-duplicate-region start end)
(message (format "duplicate `%s'" word))))
(t
;; incorrect highlight the location
(if flyspell-highlight-flag
(flyspell-highlight-incorrect-region start end)
(message (format "mispelling `%s'" word)))))
(if ispell-quit (setq ispell-quit nil)))))))))
;*---------------------------------------------------------------------*/
;* flyspell-tex-command-p ... */
;*---------------------------------------------------------------------*/
(defun flyspell-tex-command-p (word)
"Return t if WORD is a TeX command."
(eq (aref word 0) ?\\))
;*---------------------------------------------------------------------*/
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
;* flyspell-casechars-cache ... */
;*---------------------------------------------------------------------*/
(defvar flyspell-casechars-cache nil)
(defvar flyspell-ispell-casechars-cache nil)
(make-variable-buffer-local 'flyspell-casechars-cache)
(make-variable-buffer-local 'flyspell-ispell-casechars-cache)
;*---------------------------------------------------------------------*/
;* flyspell-get-casechars ... */
;*---------------------------------------------------------------------*/
(defun flyspell-get-casechars ()
"This function builds a string that is the regexp of word chars.
In order to avoid one useless string construction,
this function changes the last char of the `ispell-casechars' string."
(let ((ispell-casechars (ispell-get-casechars)))
(cond
((eq ispell-casechars flyspell-ispell-casechars-cache)
flyspell-casechars-cache)
((not (eq ispell-parser 'tex))
(setq flyspell-ispell-casechars-cache ispell-casechars)
(setq flyspell-casechars-cache
(concat (substring ispell-casechars
0
(- (length ispell-casechars) 1))
"{}]"))
flyspell-casechars-cache)
(t
(setq flyspell-ispell-casechars-cache ispell-casechars)
(setq flyspell-casechars-cache ispell-casechars)
flyspell-casechars-cache))))
;*---------------------------------------------------------------------*/
;* flyspell-get-not-casechars-cache ... */
;*---------------------------------------------------------------------*/
(defvar flyspell-not-casechars-cache nil)
(defvar flyspell-ispell-not-casechars-cache nil)
(make-variable-buffer-local 'flyspell-not-casechars-cache)
(make-variable-buffer-local 'flyspell-ispell-not-casechars-cache)
;*---------------------------------------------------------------------*/
;* flyspell-get-not-casechars ... */
;*---------------------------------------------------------------------*/
(defun flyspell-get-not-casechars ()
"This function builds a string that is the regexp of non-word chars."
(let ((ispell-not-casechars (ispell-get-not-casechars)))
(cond
((eq ispell-not-casechars flyspell-ispell-not-casechars-cache)
flyspell-not-casechars-cache)
((not (eq ispell-parser 'tex))
(setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
(setq flyspell-not-casechars-cache
(concat (substring ispell-not-casechars
0
(- (length ispell-not-casechars) 1))
"{}]"))
flyspell-not-casechars-cache)
(t
(setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
(setq flyspell-not-casechars-cache ispell-not-casechars)
flyspell-not-casechars-cache))))
;*---------------------------------------------------------------------*/
;* flyspell-get-word ... */
;*---------------------------------------------------------------------*/
"Return the word for spell-checking according to Ispell syntax.
If argument FOLLOWING is non-nil or if `ispell-following-word'
is non-nil when called interactively, then the following word
\(rather than preceding\) is checked when the cursor is not over a word.
Optional second argument contains otherchars that can be included in word
many times. The argument FULL-TEX is true if we are fetching a full
TeX command and nil otherwise.
Word syntax described by `ispell-dictionary-alist' (which see)."
(let* ((flyspell-casechars (flyspell-get-casechars))
(flyspell-not-casechars (flyspell-get-not-casechars))
(ispell-otherchars (ispell-get-otherchars))
(ispell-many-otherchars-p (ispell-get-many-otherchars-p))
(word-regexp (concat flyspell-casechars
"+\\("
ispell-otherchars
"?"
flyspell-casechars
"+\\)"
(if ispell-many-otherchars-p
"*" "?")))
(tex-prelude (if full-tex
"\\([a-zA-Z*0-9\\]*[\\\\{]\\)"
"[\\\\{]"))
(tex-regexp (if (and full-tex (eq ispell-parser 'tex))
(concat tex-prelude "?" word-regexp "}?")
word-regexp))
did-it-once
start end word)
;; find the word
(if (not (or (looking-at flyspell-casechars)
(and (eq ispell-parser 'tex)
(looking-at tex-prelude))))
(if following
(re-search-forward flyspell-casechars (point-max) t)
(re-search-backward flyspell-casechars (point-min) t)))
;; move to front of word
(re-search-backward flyspell-not-casechars (point-min) 'start)
(let ((pos nil))
(while (and (looking-at ispell-otherchars)
(not (bobp))
(or (not did-it-once)
ispell-many-otherchars-p)
(not (eq pos (point))))
(setq pos (point))
(setq did-it-once t)
(backward-char 1)
(if (looking-at flyspell-casechars)
(re-search-backward flyspell-not-casechars (point-min) 'move)
(backward-char -1))))
;; when in tex mode, we skip backward until we find a tex prelude
(if (and full-tex (eq ispell-parser 'tex))
(while (and (> (point) (point-min)) (looking-at tex-prelude))
(backward-char 1)))
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;; Now mark the word and save to string.
(if (eq (re-search-forward tex-regexp (point-max) t) nil)
nil
(progn
(setq start (match-beginning 0)
end (point)
word (buffer-substring start end))
(list word start end)))))
;*---------------------------------------------------------------------*/
;* flyspell-region ... */
;*---------------------------------------------------------------------*/
(defun flyspell-region (beg end)
"Flyspell text between BEG and END."
(interactive "r")
(save-excursion
(if (> beg end)
(let ((old beg))
(setq beg end)
(setq end old)))
(goto-char beg)
(let ((count 0))
(while (< (point) end)
(if (= count 100)
(progn