1 ;;; flyspell.el --- on-the-fly spell checker
3 ;; Copyright (C) 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
5 ;; Author: Manuel Serrano <Manuel.Serrano@unice.fr>
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Flyspell is a minor Emacs mode performing on-the-fly spelling
30 ;; To enable Flyspell minor mode, type M-x flyspell-mode.
31 ;; This applies only to the current buffer.
33 ;; To enable Flyspell in text representing computer programs, type
34 ;; M-x flyspell-prog-mode.
35 ;; In that mode only text inside comments is checked.
37 ;; Note: consider setting the variable ispell-parser to `tex' to
38 ;; avoid TeX command checking; use `(setq ispell-parser 'tex)'.
40 ;; Some user variables control the behavior of flyspell. They are
41 ;; those defined under the `User variables' comment.
47 ;*---------------------------------------------------------------------*/
49 ;*---------------------------------------------------------------------*/
50 (defgroup flyspell nil
51 "Spell checking on the fly."
57 ;*---------------------------------------------------------------------*/
58 ;* User configuration ... */
59 ;*---------------------------------------------------------------------*/
60 (defcustom flyspell-highlight-flag t
61 "*How Flyspell should indicate misspelled words.
62 Non-nil means use highlight, nil means use minibuffer messages."
66 (defcustom flyspell-mark-duplications-flag t
67 "*Non-nil means Flyspell reports a repeated word as an error."
71 (defcustom flyspell-sort-corrections nil
72 "*Non-nil means, sort the corrections alphabetically before popping them."
77 (defcustom flyspell-duplicate-distance -
1
78 "*The maximum distance for finding duplicates of unrecognized words.
79 This applies to the feature that when a word is not found in the dictionary,
80 if the same spelling occurs elsewhere in the buffer,
81 Flyspell uses a different face (`flyspell-duplicate-face') to highlight it.
82 This variable specifies how far to search to find such a duplicate.
83 -1 means no limit (search the whole buffer).
84 0 means do not search for duplicate unrecognized spellings."
89 (defcustom flyspell-delay
3
90 "*The number of seconds to wait before checking, after a \"delayed\" command."
94 (defcustom flyspell-persistent-highlight t
95 "*Non-nil means misspelled words remain highlighted until corrected.
96 If this variable is nil, only the most recently detected misspelled word
101 (defcustom flyspell-highlight-properties t
102 "*Non-nil means highlight incorrect words even if a property exists for this word."
106 (defcustom flyspell-default-delayed-commands
107 '(self-insert-command
109 backward-or-forward-delete-char
111 scrollbar-vertical-drag
)
112 "The standard list of delayed commands for Flyspell.
113 See `flyspell-delayed-commands'."
116 :type
'(repeat (symbol)))
118 (defcustom flyspell-delayed-commands nil
119 "List of commands that are \"delayed\" for Flyspell mode.
120 After these commands, Flyspell checking is delayed for a short time,
121 whose length is specified by `flyspell-delay'."
123 :type
'(repeat (symbol)))
125 (defcustom flyspell-default-deplacement-commands
130 "The standard list of deplacement commands for Flyspell.
131 See `flyspell-deplacement-commands'."
134 :type
'(repeat (symbol)))
136 (defcustom flyspell-deplacement-commands nil
137 "List of commands that are \"deplacement\" for Flyspell mode.
138 After these commands, Flyspell checking is performed only if the previous
139 command was not the very same command."
142 :type
'(repeat (symbol)))
144 (defcustom flyspell-issue-welcome-flag t
145 "*Non-nil means that Flyspell should display a welcome message when started."
149 (defcustom flyspell-issue-message-flag t
150 "*Non-nil means that Flyspell emits messages when checking words."
154 (defcustom flyspell-incorrect-hook nil
155 "*List of functions to be called when incorrect words are encountered.
156 Each function is given three arguments: the beginning and the end
157 of the incorrect region. The third is either the symbol 'doublon' or the list
158 of possible corrections as returned by 'ispell-parse-output'.
160 If any of the functions return non-Nil, the word is not highlighted as
166 (defcustom flyspell-default-dictionary nil
167 "A string that is the name of the default dictionary.
168 This is passed to the `ispell-change-dictionary' when flyspell is started.
169 If the variable `ispell-local-dictionary' or `ispell-dictionary' is non-nil
170 when flyspell is started, the value of that variable is used instead
171 of `flyspell-default-dictionary' to select the default dictionary.
172 Otherwise, if `flyspell-default-dictionary' is nil, it means to use
173 Ispell's ultimate default dictionary."
176 :type
'(choice string
(const :tag
"Default" nil
)))
178 (defcustom flyspell-tex-command-regexp
179 "\\(\\(begin\\|end\\)[ \t]*{\\|\\(cite[a-z*]*\\|label\\|ref\\|eqref\\|usepackage\\|documentclass\\)[ \t]*\\(\\[[^]]*\\]\\)?{[^{}]*\\)"
180 "A string that is the regular expression that matches TeX commands."
185 (defcustom flyspell-check-tex-math-command nil
186 "*Non nil means check even inside TeX math environment.
187 TeX math environments are discovered by the TEXMATHP that implemented
188 inside the texmathp.el Emacs package. That package may be found at:
189 http://strw.leidenuniv.nl/~dominik/Tools"
193 (defcustom flyspell-dictionaries-that-consider-dash-as-word-delimiter
194 '("francais" "deutsch8" "norsk")
195 "List of dictionary names that consider `-' as word delimiter."
198 :type
'(repeat (string)))
200 (defcustom flyspell-abbrev-p
202 "*If true, add correction to abbreviation table."
207 (defcustom flyspell-use-global-abbrev-table-p
209 "*If true, prefer global abbrev table to local abbrev table."
215 (defcustom flyspell-mode-line-string
" Fly"
216 "*String displayed on the modeline when flyspell is active.
217 Set this to nil if you don't want a modeline indicator."
219 :type
'(choice string
(const :tag
"None" nil
)))
221 (defcustom flyspell-large-region
1000
222 "*The threshold that determines if a region is small.
223 The `flyspell-region' function is invoked if the region is small, the
224 word are checked one after the other using regular flyspell check
225 means. If the region is large, a new Ispell process is spawned to get
231 (defcustom flyspell-insert-function
(function insert
)
232 "*Function for inserting word by flyspell upon correction."
236 (defcustom flyspell-before-incorrect-word-string nil
237 "String used to indicate an incorrect word starting."
239 :type
'(choice string
(const nil
)))
241 (defcustom flyspell-after-incorrect-word-string nil
242 "String used to indicate an incorrect word ending."
244 :type
'(choice string
(const nil
)))
246 ;*---------------------------------------------------------------------*/
247 ;* Mode specific options */
248 ;* ------------------------------------------------------------- */
249 ;* Mode specific options enable users to disable flyspell on */
250 ;* certain word depending of the emacs mode. For instance, when */
251 ;* using flyspell with mail-mode add the following expression */
252 ;* in your .emacs file: */
253 ;* (add-hook 'mail-mode */
254 ;* '(lambda () (setq flyspell-generic-check-word-p */
255 ;* 'mail-mode-flyspell-verify))) */
256 ;*---------------------------------------------------------------------*/
257 (defvar flyspell-generic-check-word-p nil
258 "Function providing per-mode customization over which words are flyspelled.
259 Returns t to continue checking, nil otherwise.
260 Flyspell mode sets this variable to whatever is the `flyspell-mode-predicate'
261 property of the major mode name.")
262 (make-variable-buffer-local 'flyspell-generic-check-word-p
)
264 ;*--- mail mode -------------------------------------------------------*/
265 (put 'mail-mode
'flyspell-mode-predicate
'mail-mode-flyspell-verify
)
266 (put 'message-mode
'flyspell-mode-predicate
'mail-mode-flyspell-verify
)
267 (defun mail-mode-flyspell-verify ()
268 "This function is used for `flyspell-generic-check-word-p' in Mail mode."
269 (let ((in-headers (save-excursion
270 ;; When mail-header-separator is "",
271 ;; it is likely to be found in both directions.
272 (not (re-search-backward (concat "^" (regexp-quote mail-header-separator
) "$") nil t
))))
273 (in-signature (save-excursion
274 (re-search-backward message-signature-separator nil t
))))
276 (and (save-excursion (beginning-of-line)
277 (looking-at "^Subject:"))
278 (> (point) (match-end 0))))
284 (not (looking-at "[>}|]\\To:")))))))
286 ;*--- texinfo mode ----------------------------------------------------*/
287 (put 'texinfo-mode
'flyspell-mode-predicate
'texinfo-mode-flyspell-verify
)
288 (defun texinfo-mode-flyspell-verify ()
289 "This function is used for `flyspell-generic-check-word-p' in Texinfo mode."
292 (not (looking-at "@"))))
294 ;*--- tex mode --------------------------------------------------------*/
295 (put 'tex-mode
'flyspell-mode-predicate
'tex-mode-flyspell-verify
)
296 (defun tex-mode-flyspell-verify ()
297 "This function is used for `flyspell-generic-check-word-p' in LaTeX mode."
300 (re-search-backward "^[ \t]*%%%[ \t]+Local" (point-min) t
)))
302 (let ((this (point-marker))
303 (e (progn (end-of-line) (point-marker))))
305 (if (re-search-forward "\\\\\\(cite\\|label\\|ref\\){[^}]*}" e t
)
306 (and (>= this
(match-beginning 0))
307 (<= this
(match-end 0)) )))))))
309 ;*--- sgml mode -------------------------------------------------------*/
310 (put 'sgml-mode
'flyspell-mode-predicate
'sgml-mode-flyspell-verify
)
311 (put 'html-mode
'flyspell-mode-predicate
'sgml-mode-flyspell-verify
)
313 (defun sgml-mode-flyspell-verify ()
314 "This function is used for `flyspell-generic-check-word-p' in SGML mode."
316 (let ((this (point-marker))
317 (s (progn (beginning-of-line) (point-marker)))
318 (e (progn (end-of-line) (point-marker))))
321 (and (re-search-forward "[^<]*>" e t
)
322 (= (match-beginning 0) this
)))
325 (and (re-search-backward "<[^>]*" s t
)
326 (= (match-end 0) this
)))
329 (and (re-search-forward "[^&]*;" e t
)
330 (= (match-beginning 0) this
)))
333 (and (re-search-backward "&[^;]*" s t
)
334 (= (match-end 0) this
)))))))))
336 ;*---------------------------------------------------------------------*/
337 ;* Programming mode */
338 ;*---------------------------------------------------------------------*/
339 (defvar flyspell-prog-text-faces
340 '(font-lock-string-face font-lock-comment-face font-lock-doc-face
)
341 "Faces corresponding to text in programming-mode buffers.")
343 (defun flyspell-generic-progmode-verify ()
344 "Used for `flyspell-generic-check-word-p' in programming modes."
345 (let ((f (get-text-property (point) 'face
)))
346 (memq f flyspell-prog-text-faces
)))
349 (defun flyspell-prog-mode ()
350 "Turn on `flyspell-mode' for comments and strings."
352 (setq flyspell-generic-check-word-p
'flyspell-generic-progmode-verify
)
355 ;*---------------------------------------------------------------------*/
356 ;* Overlay compatibility */
357 ;*---------------------------------------------------------------------*/
358 (autoload 'make-overlay
"overlay" "Overlay compatibility kit." t
)
359 (autoload 'overlayp
"overlay" "Overlay compatibility kit." t
)
360 (autoload 'overlays-in
"overlay" "Overlay compatibility kit." t
)
361 (autoload 'delete-overlay
"overlay" "Overlay compatibility kit." t
)
362 (autoload 'overlays-at
"overlay" "Overlay compatibility kit." t
)
363 (autoload 'overlay-put
"overlay" "Overlay compatibility kit." t
)
364 (autoload 'overlay-get
"overlay" "Overlay compatibility kit." t
)
365 (autoload 'previous-overlay-change
"overlay" "Overlay compatibility kit." t
)
367 ;*---------------------------------------------------------------------*/
368 ;* Which emacs are we currently running */
369 ;*---------------------------------------------------------------------*/
370 (defvar flyspell-emacs
372 ((string-match "XEmacs" emacs-version
)
376 "The type of Emacs we are currently running.")
378 (defvar flyspell-use-local-map
379 (or (eq flyspell-emacs
'xemacs
)
380 (not (string< emacs-version
"20"))))
382 ;*---------------------------------------------------------------------*/
383 ;* The minor mode declaration. */
384 ;*---------------------------------------------------------------------*/
385 (eval-when-compile (defvar flyspell-local-mouse-map
))
388 (defvar flyspell-mode nil
)
389 (make-variable-buffer-local 'flyspell-mode
)
391 (defvar flyspell-mouse-map
392 (let ((map (make-sparse-keymap)))
394 ((eq flyspell-emacs
'xemacs
)
395 (define-key map
[(button2)] #'flyspell-correct-word
)
396 (define-key map
"\M-\t" #'flyspell-auto-correct-word
))
397 (flyspell-use-local-map
398 (define-key map
[(mouse-2)] #'flyspell-correct-word
)
399 (define-key map
"\M-\t" #'flyspell-auto-correct-word
)))
403 (defvar flyspell-mode-map
(make-sparse-keymap))
405 ;; mouse, keyboard bindings and misc definition
406 (when (or (assoc 'flyspell-mode minor-mode-map-alist
)
407 (setq minor-mode-map-alist
408 (cons (cons 'flyspell-mode flyspell-mode-map
)
409 minor-mode-map-alist
)))
410 (define-key flyspell-mode-map
"\M-\t" 'flyspell-auto-correct-word
))
412 ;; the name of the overlay property that defines the keymap
413 (defvar flyspell-overlay-keymap-property-name
'keymap
)
415 ;; dash character machinery
416 (defvar flyspell-consider-dash-as-word-delimiter-flag nil
417 "*Non-nil means that the `-' char is considered as a word delimiter.")
418 (make-variable-buffer-local 'flyspell-consider-dash-as-word-delimiter-flag
)
419 (defvar flyspell-dash-dictionary nil
)
420 (make-variable-buffer-local 'flyspell-dash-dictionary
)
421 (defvar flyspell-dash-local-dictionary nil
)
422 (make-variable-buffer-local 'flyspell-dash-local-dictionary
)
424 ;*---------------------------------------------------------------------*/
426 ;*---------------------------------------------------------------------*/
427 (defface flyspell-incorrect-face
428 (if (eq flyspell-emacs
'xemacs
)
429 '((((class color
)) (:foreground
"OrangeRed" :bold t
:underline t
))
431 '((((class color
)) (:foreground
"OrangeRed" :weight bold
:underline t
))
433 "Face used for marking a misspelled word in Flyspell."
436 (defface flyspell-duplicate-face
437 (if (eq flyspell-emacs
'xemacs
)
438 '((((class color
)) (:foreground
"Gold3" :bold t
:underline t
))
440 '((((class color
)) (:foreground
"Gold3" :weight bold
:underline t
))
442 "Face used for marking a misspelled word that appears twice in the buffer.
443 See also `flyspell-duplicate-distance'."
446 (defvar flyspell-overlay nil
)
448 ;*---------------------------------------------------------------------*/
449 ;* flyspell-mode ... */
450 ;*---------------------------------------------------------------------*/
452 (defun flyspell-mode (&optional arg
)
453 "Minor mode performing on-the-fly spelling checking.
454 Ispell is automatically spawned on background for each entered words.
455 The default flyspell behavior is to highlight incorrect words.
456 With no argument, this command toggles Flyspell mode.
457 With a prefix argument ARG, turn Flyspell minor mode on iff ARG is positive.
460 \\[ispell-word]: correct words (using Ispell).
461 \\[flyspell-auto-correct-word]: automatically correct word.
462 \\[flyspell-correct-word] (or mouse-2): popup correct words.
465 This runs `flyspell-mode-hook' after flyspell is entered.
468 `flyspell-mode' uses `ispell-mode'. Thus all Ispell options are
469 valid. For instance, a personal dictionary can be used by
470 invoking `ispell-change-dictionary'.
472 Consider using the `ispell-parser' to check your text. For instance
474 \(add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))
477 \\[flyspell-region] checks all words inside a region.
478 \\[flyspell-buffer] checks the whole buffer."
480 (let ((old-flyspell-mode flyspell-mode
))
481 ;; Mark the mode as on or off.
482 (setq flyspell-mode
(not (or (and (null arg
) flyspell-mode
)
483 (<= (prefix-numeric-value arg
) 0))))
485 (unless (eq flyspell-mode old-flyspell-mode
)
489 ;; Force modeline redisplay.
490 (set-buffer-modified-p (buffer-modified-p)))))
492 ;*---------------------------------------------------------------------*/
494 ;*---------------------------------------------------------------------*/
496 (add-minor-mode 'flyspell-mode
497 'flyspell-mode-line-string
502 ;*---------------------------------------------------------------------*/
503 ;* flyspell-buffers ... */
504 ;* ------------------------------------------------------------- */
505 ;* For remembering buffers running flyspell */
506 ;*---------------------------------------------------------------------*/
507 (defvar flyspell-buffers nil
)
509 ;*---------------------------------------------------------------------*/
510 ;* flyspell-minibuffer-p ... */
511 ;*---------------------------------------------------------------------*/
512 (defun flyspell-minibuffer-p (buffer)
513 "Is BUFFER a minibuffer?"
514 (let ((ws (get-buffer-window-list buffer t
)))
515 (and (consp ws
) (window-minibuffer-p (car ws
)))))
517 ;*---------------------------------------------------------------------*/
518 ;* flyspell-version ... */
519 ;*---------------------------------------------------------------------*/
521 (defun flyspell-version ()
522 "The flyspell version"
526 ;*---------------------------------------------------------------------*/
527 ;* flyspell-accept-buffer-local-defs ... */
528 ;*---------------------------------------------------------------------*/
529 (defun flyspell-accept-buffer-local-defs ()
530 (ispell-accept-buffer-local-defs)
531 (if (not (and (eq flyspell-dash-dictionary ispell-dictionary
)
532 (eq flyspell-dash-local-dictionary ispell-local-dictionary
)))
533 ;; the dictionary has changed
535 (setq flyspell-dash-dictionary ispell-dictionary
)
536 (setq flyspell-dash-local-dictionary ispell-local-dictionary
)
537 (if (member (or ispell-local-dictionary ispell-dictionary
)
538 flyspell-dictionaries-that-consider-dash-as-word-delimiter
)
539 (setq flyspell-consider-dash-as-word-delimiter-flag t
)
540 (setq flyspell-consider-dash-as-word-delimiter-flag nil
)))))
542 ;*---------------------------------------------------------------------*/
543 ;* flyspell-mode-on ... */
544 ;*---------------------------------------------------------------------*/
545 (defun flyspell-mode-on ()
546 "Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead."
547 (setq ispell-highlight-face
'flyspell-incorrect-face
)
548 ;; local dictionaries setup
549 (ispell-change-dictionary
550 (or ispell-local-dictionary ispell-dictionary flyspell-default-dictionary
))
551 ;; we have to force ispell to accept the local definition or
552 ;; otherwise it could be too late, the local dictionary may
554 (flyspell-accept-buffer-local-defs)
555 ;; we put the `flyspell-delayed' property on some commands
556 (flyspell-delay-commands)
557 ;; we put the `flyspell-deplacement' property on some commands
558 (flyspell-deplacement-commands)
559 ;; we bound flyspell action to post-command hook
560 (add-hook 'post-command-hook
(function flyspell-post-command-hook
) t t
)
561 ;; we bound flyspell action to pre-command hook
562 (add-hook 'pre-command-hook
(function flyspell-pre-command-hook
) t t
)
563 ;; we bound flyspell action to after-change hook
564 (make-local-variable 'after-change-functions
)
565 (setq after-change-functions
566 (cons 'flyspell-after-change-function after-change-functions
))
567 ;; set flyspell-generic-check-word-p based on the major mode
568 (let ((mode-predicate (get major-mode
'flyspell-mode-predicate
)))
570 (setq flyspell-generic-check-word-p mode-predicate
)))
571 ;; the welcome message
572 (if (and flyspell-issue-message-flag
573 flyspell-issue-welcome-flag
575 (let ((binding (where-is-internal 'flyspell-auto-correct-word
579 (format "Welcome to flyspell. Use %s or Mouse-2 to correct words."
580 (key-description binding
))
581 "Welcome to flyspell. Use Mouse-2 to correct words."))))
582 ;; we end with the flyspell hooks
583 (run-hooks 'flyspell-mode-hook
))
585 ;*---------------------------------------------------------------------*/
586 ;* flyspell-delay-commands ... */
587 ;*---------------------------------------------------------------------*/
588 (defun flyspell-delay-commands ()
589 "Install the standard set of Flyspell delayed commands."
590 (mapcar 'flyspell-delay-command flyspell-default-delayed-commands
)
591 (mapcar 'flyspell-delay-command flyspell-delayed-commands
))
593 ;*---------------------------------------------------------------------*/
594 ;* flyspell-delay-command ... */
595 ;*---------------------------------------------------------------------*/
596 (defun flyspell-delay-command (command)
597 "Set COMMAND to be delayed, for Flyspell.
598 When flyspell `post-command-hook' is invoked because a delayed command
599 as been used the current word is not immediately checked.
600 It will be checked only after `flyspell-delay' seconds."
601 (interactive "SDelay Flyspell after Command: ")
602 (put command
'flyspell-delayed t
))
604 ;*---------------------------------------------------------------------*/
605 ;* flyspell-deplacement-commands ... */
606 ;*---------------------------------------------------------------------*/
607 (defun flyspell-deplacement-commands ()
608 "Install the standard set of Flyspell deplacement commands."
609 (mapcar 'flyspell-deplacement-command flyspell-default-deplacement-commands
)
610 (mapcar 'flyspell-deplacement-command flyspell-deplacement-commands
))
612 ;*---------------------------------------------------------------------*/
613 ;* flyspell-deplacement-command ... */
614 ;*---------------------------------------------------------------------*/
615 (defun flyspell-deplacement-command (command)
616 "Set COMMAND that implement cursor movements, for Flyspell.
617 When flyspell `post-command-hook' is invoked because of a deplacement command
618 as been used the current word is checked only if the previous command was
619 not the very same deplacement command."
620 (interactive "SDeplacement Flyspell after Command: ")
621 (put command
'flyspell-deplacement t
))
623 ;*---------------------------------------------------------------------*/
624 ;* flyspell-word-cache ... */
625 ;*---------------------------------------------------------------------*/
626 (defvar flyspell-word-cache-start nil
)
627 (defvar flyspell-word-cache-end nil
)
628 (defvar flyspell-word-cache-word nil
)
629 (make-variable-buffer-local 'flyspell-word-cache-start
)
630 (make-variable-buffer-local 'flyspell-word-cache-end
)
631 (make-variable-buffer-local 'flyspell-word-cache-word
)
633 ;*---------------------------------------------------------------------*/
634 ;* The flyspell pre-hook, store the current position. In the */
635 ;* post command hook, we will check, if the word at this position */
636 ;* has to be spell checked. */
637 ;*---------------------------------------------------------------------*/
638 (defvar flyspell-pre-buffer nil
)
639 (defvar flyspell-pre-point nil
)
640 (defvar flyspell-pre-column nil
)
641 (defvar flyspell-pre-pre-buffer nil
)
642 (defvar flyspell-pre-pre-point nil
)
644 ;*---------------------------------------------------------------------*/
645 ;* flyspell-previous-command ... */
646 ;*---------------------------------------------------------------------*/
647 (defvar flyspell-previous-command nil
648 "The last interactive command checked by Flyspell.")
650 ;*---------------------------------------------------------------------*/
651 ;* flyspell-pre-command-hook ... */
652 ;*---------------------------------------------------------------------*/
653 (defun flyspell-pre-command-hook ()
654 "Save the current buffer and point for Flyspell's post-command hook."
656 (setq flyspell-pre-buffer
(current-buffer))
657 (setq flyspell-pre-point
(point))
658 (setq flyspell-pre-column
(current-column)))
660 ;*---------------------------------------------------------------------*/
661 ;* flyspell-mode-off ... */
662 ;*---------------------------------------------------------------------*/
664 (defun flyspell-mode-off ()
665 "Turn Flyspell mode off."
666 ;; we remove the hooks
667 (remove-hook 'post-command-hook
(function flyspell-post-command-hook
) t
)
668 (remove-hook 'pre-command-hook
(function flyspell-pre-command-hook
) t
)
669 (setq after-change-functions
(delq 'flyspell-after-change-function
670 after-change-functions
))
671 ;; we remove all the flyspell hilightings
672 (flyspell-delete-all-overlays)
673 ;; we have to erase pre cache variables
674 (setq flyspell-pre-buffer nil
)
675 (setq flyspell-pre-point nil
)
676 ;; we mark the mode as killed
677 (setq flyspell-mode nil
))
679 ;*---------------------------------------------------------------------*/
680 ;* flyspell-check-pre-word-p ... */
681 ;*---------------------------------------------------------------------*/
682 (defun flyspell-check-pre-word-p ()
683 "Return non-nil if we should to check the word before point.
684 More precisely, it applies to the word that was before point
685 before the current command."
687 ((or (not (numberp flyspell-pre-point
))
688 (not (bufferp flyspell-pre-buffer
))
689 (not (buffer-live-p flyspell-pre-buffer
)))
691 ((and (eq flyspell-pre-pre-point flyspell-pre-point
)
692 (eq flyspell-pre-pre-buffer flyspell-pre-buffer
))
694 ((or (and (= flyspell-pre-point
(- (point) 1))
695 (eq (char-syntax (char-after flyspell-pre-point
)) ?w
))
696 (= flyspell-pre-point
(point))
697 (= flyspell-pre-point
(+ (point) 1)))
699 ((and (symbolp this-command
)
700 (not executing-kbd-macro
)
701 (or (get this-command
'flyspell-delayed
)
702 (and (get this-command
'flyspell-deplacement
)
703 (eq flyspell-previous-command this-command
)))
704 (or (= (current-column) 0)
705 (= (current-column) flyspell-pre-column
)
706 (eq (char-syntax (char-after flyspell-pre-point
)) ?w
)))
708 ((not (eq (current-buffer) flyspell-pre-buffer
))
710 ((not (and (numberp flyspell-word-cache-start
)
711 (numberp flyspell-word-cache-end
)))
714 (or (< flyspell-pre-point flyspell-word-cache-start
)
715 (> flyspell-pre-point flyspell-word-cache-end
)))))
717 ;*---------------------------------------------------------------------*/
718 ;* The flyspell after-change-hook, store the change position. In */
719 ;* the post command hook, we will check, if the word at this */
720 ;* position has to be spell checked. */
721 ;*---------------------------------------------------------------------*/
722 (defvar flyspell-changes nil
)
724 ;*---------------------------------------------------------------------*/
725 ;* flyspell-after-change-function ... */
726 ;*---------------------------------------------------------------------*/
727 (defun flyspell-after-change-function (start stop len
)
728 "Save the current buffer and point for Flyspell's post-command hook."
730 (setq flyspell-changes
(cons (cons start stop
) flyspell-changes
)))
732 ;*---------------------------------------------------------------------*/
733 ;* flyspell-check-changed-word-p ... */
734 ;*---------------------------------------------------------------------*/
735 (defun flyspell-check-changed-word-p (start stop
)
736 "Return t when the changed word has to be checked.
737 The answer depends of several criteria.
738 Mostly we check word delimiters."
740 ((and (eq (char-after start
) ?
\n) (> stop start
))
742 ((not (numberp flyspell-pre-point
))
744 ((and (>= flyspell-pre-point start
) (<= flyspell-pre-point stop
))
746 ((let ((pos (point)))
747 (or (>= pos start
) (<= pos stop
) (= pos
(1+ stop
))))
752 ;*---------------------------------------------------------------------*/
753 ;* flyspell-check-word-p ... */
754 ;*---------------------------------------------------------------------*/
755 (defun flyspell-check-word-p ()
756 "Return t when the word at `point' has to be checked.
757 The answer depends of several criteria.
758 Mostly we check word delimiters."
760 ((<= (- (point-max) 1) (point-min))
761 ;; the buffer is not filled enough
763 ((and (and (> (current-column) 0)
764 (not (eq (current-column) flyspell-pre-column
)))
767 (and (looking-at (flyspell-get-not-casechars))
768 (or flyspell-consider-dash-as-word-delimiter-flag
769 (not (looking-at "\\-"))))))
770 ;; yes because we have reached or typed a word delimiter.
772 ((symbolp this-command
)
774 ((get this-command
'flyspell-deplacement
)
775 (not (eq flyspell-previous-command this-command
)))
776 ((get this-command
'flyspell-delayed
)
777 ;; the current command is not delayed, that
778 ;; is that we must check the word now
779 (if (fboundp 'about-xemacs
)
780 (sit-for flyspell-delay nil
)
781 (sit-for flyspell-delay
0 nil
)))
785 ;*---------------------------------------------------------------------*/
786 ;* flyspell-debug-signal-no-check ... */
787 ;*---------------------------------------------------------------------*/
788 (defun flyspell-debug-signal-no-check (msg obj
)
789 (setq debug-on-error t
)
791 (let ((buffer (get-buffer-create "*flyspell-debug*")))
794 (insert "NO-CHECK:\n")
795 (insert (format " %S : %S\n" msg obj
)))))
797 ;*---------------------------------------------------------------------*/
798 ;* flyspell-debug-signal-pre-word-checked ... */
799 ;*---------------------------------------------------------------------*/
800 (defun flyspell-debug-signal-pre-word-checked ()
801 (setq debug-on-error t
)
803 (let ((buffer (get-buffer-create "*flyspell-debug*")))
805 (insert "PRE-WORD:\n")
806 (insert (format " pre-point : %S\n" flyspell-pre-point
))
807 (insert (format " pre-buffer : %S\n" flyspell-pre-buffer
))
808 (insert (format " cache-start: %S\n" flyspell-word-cache-start
))
809 (insert (format " cache-end : %S\n" flyspell-word-cache-end
))
810 (goto-char (point-max)))))
812 ;*---------------------------------------------------------------------*/
813 ;* flyspell-debug-signal-word-checked ... */
814 ;*---------------------------------------------------------------------*/
815 (defun flyspell-debug-signal-word-checked ()
816 (setq debug-on-error t
)
818 (let ((oldbuf (current-buffer))
819 (buffer (get-buffer-create "*flyspell-debug*"))
823 (insert (format " this-cmd : %S\n" this-command
))
824 (insert (format " delayed : %S\n" (and (symbolp this-command
)
825 (get this-command
'flyspell-delayed
))))
826 (insert (format " point : %S\n" point
))
827 (insert (format " prev-char : [%c] %S\n"
830 (let ((c (if (> (point) (point-min))
833 (char-after (point)))
839 (let ((c (if (> (point) (point-min))
842 (and (and (looking-at (flyspell-get-not-casechars)) 1)
843 (and (or flyspell-consider-dash-as-word-delimiter-flag
844 (not (looking-at "\\-"))) 2))))))
847 (insert (format " because : %S\n"
849 ((not (and (symbolp this-command
)
850 (get this-command
'flyspell-delayed
)))
851 ;; the current command is not delayed, that
852 ;; is that we must check the word now
856 (let ((c (if (> (point) (point-min))
859 (and (looking-at (flyspell-get-not-casechars))
860 (or flyspell-consider-dash-as-word-delimiter-flag
861 (not (looking-at "\\-"))))))))
864 ;; yes because we have reached or typed a word delimiter.
866 ((not (integerp flyspell-delay
))
867 ;; yes because the user had set up a no-delay configuration.
871 (goto-char (point-max)))))
873 ;*---------------------------------------------------------------------*/
874 ;* flyspell-debug-signal-changed-checked ... */
875 ;*---------------------------------------------------------------------*/
876 (defun flyspell-debug-signal-changed-checked ()
877 (setq debug-on-error t
)
879 (let ((buffer (get-buffer-create "*flyspell-debug*"))
882 (insert "CHANGED WORD:\n")
883 (insert (format " point : %S\n" point
))
884 (goto-char (point-max)))))
886 ;*---------------------------------------------------------------------*/
887 ;* flyspell-post-command-hook ... */
888 ;* ------------------------------------------------------------- */
889 ;* It is possible that we check several words: */
890 ;* 1- the current word is checked if the predicate */
891 ;* FLYSPELL-CHECK-WORD-P is true */
892 ;* 2- the word that used to be the current word before the */
893 ;* THIS-COMMAND is checked if: */
894 ;* a- the previous word is different from the current word */
895 ;* b- the previous word as not just been checked by the */
896 ;* previous FLYSPELL-POST-COMMAND-HOOK */
897 ;* 3- the words changed by the THIS-COMMAND that are neither the */
898 ;* previous word nor the current word */
899 ;*---------------------------------------------------------------------*/
900 (defun flyspell-post-command-hook ()
901 "The `post-command-hook' used by flyspell to check a word in-the-fly."
903 (let ((command this-command
))
904 (if (flyspell-check-pre-word-p)
906 '(flyspell-debug-signal-pre-word-checked)
907 (set-buffer flyspell-pre-buffer
)
909 (goto-char flyspell-pre-point
)
911 (if (flyspell-check-word-p)
913 '(flyspell-debug-signal-word-checked)
915 ;; we remember which word we have just checked.
916 ;; this will be used next time we will check a word
917 ;; to compare the next current word with the word
918 ;; that as been registered in the pre-command-hook
919 ;; that is these variables are used within the predicate
920 ;; FLYSPELL-CHECK-PRE-WORD-P
921 (setq flyspell-pre-pre-buffer
(current-buffer))
922 (setq flyspell-pre-pre-point
(point)))
924 (setq flyspell-pre-pre-buffer nil
)
925 (setq flyspell-pre-pre-point nil
)
926 ;; when a word is not checked because of a delayed command
927 ;; we do not disable the ispell cache.
928 (if (and (symbolp this-command
) (get this-command
'flyspell-delayed
))
929 (setq flyspell-word-cache-end -
1))))
930 (while (consp flyspell-changes
)
931 (let ((start (car (car flyspell-changes
)))
932 (stop (cdr (car flyspell-changes
))))
933 (if (flyspell-check-changed-word-p start stop
)
935 '(flyspell-debug-signal-changed-checked)
938 (setq flyspell-changes
(cdr flyspell-changes
))))
939 (setq flyspell-previous-command command
)))
941 ;*---------------------------------------------------------------------*/
942 ;* flyspell-notify-misspell ... */
943 ;*---------------------------------------------------------------------*/
944 (defun flyspell-notify-misspell (start end word poss
)
945 (let ((replacements (if (stringp poss
)
947 (if flyspell-sort-corrections
948 (sort (car (cdr (cdr poss
))) 'string
<)
949 (car (cdr (cdr poss
)))))))
950 (if flyspell-issue-message-flag
951 (message (format "mispelling `%s' %S" word replacements
)))))
953 ;*---------------------------------------------------------------------*/
954 ;* flyspell-word ... */
955 ;*---------------------------------------------------------------------*/
956 (defun flyspell-word (&optional following
)
957 "Spell check a word."
958 (interactive (list current-prefix-arg
))
960 (setq following ispell-following-word
))
962 ;; use the correct dictionary
963 (flyspell-accept-buffer-local-defs)
964 (let* ((cursor-location (point))
965 (flyspell-word (flyspell-get-word following
))
967 (if (or (eq flyspell-word nil
)
968 (and (fboundp flyspell-generic-check-word-p
)
969 (not (funcall flyspell-generic-check-word-p
))))
972 ;; destructure return flyspell-word info list.
973 (setq start
(car (cdr flyspell-word
))
974 end
(car (cdr (cdr flyspell-word
)))
975 word
(car flyspell-word
))
976 ;; before checking in the directory, we check for doublons.
978 ((and (or (not (eq ispell-parser
'tex
))
979 (not (eq (char-after start
) ?
\\)))
980 flyspell-mark-duplications-flag
983 (word-search-backward word
987 ;; yes, this is a doublon
988 (flyspell-highlight-incorrect-region start end
'doublon
))
989 ((and (eq flyspell-word-cache-start start
)
990 (eq flyspell-word-cache-end end
)
991 (string-equal flyspell-word-cache-word word
))
992 ;; this word had been already checked, we skip
994 ((and (eq ispell-parser
'tex
)
995 (flyspell-tex-command-p flyspell-word
))
996 ;; this is a correct word (because a tex command)
997 (flyspell-unhighlight-at start
)
999 (flyspell-unhighlight-at (- end
1)))
1002 ;; we setup the cache
1003 (setq flyspell-word-cache-start start
)
1004 (setq flyspell-word-cache-end end
)
1005 (setq flyspell-word-cache-word word
)
1006 ;; now check spelling of word.
1007 (process-send-string ispell-process
"%\n")
1008 ;; put in verbose mode
1009 (process-send-string ispell-process
1010 (concat "^" word
"\n"))
1011 ;; we mark the ispell process so it can be killed
1012 ;; when emacs is exited without query
1013 (if (fboundp 'process-kill-without-query
)
1014 (process-kill-without-query ispell-process
))
1015 ;; wait until ispell has processed word
1017 (accept-process-output ispell-process
)
1018 (not (string= "" (car ispell-filter
)))))
1019 ;; (process-send-string ispell-process "!\n")
1020 ;; back to terse mode.
1021 (setq ispell-filter
(cdr ispell-filter
))
1022 (if (consp ispell-filter
)
1023 (setq poss
(ispell-parse-output (car ispell-filter
))))
1026 (flyspell-unhighlight-at start
)
1028 (flyspell-unhighlight-at (- end
1)))
1030 ((and (stringp poss
) flyspell-highlight-flag
)
1032 (flyspell-unhighlight-at start
)
1034 (flyspell-unhighlight-at (- end
1)))
1037 (flyspell-unhighlight-at start
)
1039 (flyspell-unhighlight-at (- end
1))))
1040 ((or (and (< flyspell-duplicate-distance
0)
1043 (word-search-backward word
1048 (word-search-forward word
1051 (and (> flyspell-duplicate-distance
0)
1054 (word-search-backward
1057 flyspell-duplicate-distance
)
1061 (word-search-forward
1064 flyspell-duplicate-distance
)
1066 (if flyspell-highlight-flag
1067 (flyspell-highlight-duplicate-region start end
)
1068 (message (format "duplicate `%s'" word
))))
1070 ;; incorrect highlight the location
1071 (if flyspell-highlight-flag
1072 (flyspell-highlight-incorrect-region start end poss
)
1073 (flyspell-notify-misspell start end word poss
))))
1074 ;; return to original location
1075 (goto-char cursor-location
)
1076 (if ispell-quit
(setq ispell-quit nil
)))))))))
1078 ;*---------------------------------------------------------------------*/
1079 ;* flyspell-tex-math-initialized ... */
1080 ;*---------------------------------------------------------------------*/
1081 (defvar flyspell-tex-math-initialized nil
)
1083 ;*---------------------------------------------------------------------*/
1084 ;* flyspell-math-tex-command-p ... */
1085 ;* ------------------------------------------------------------- */
1086 ;* This function uses the texmathp package to check if (point) */
1087 ;* is within a tex command. In order to avoid using */
1088 ;* condition-case each time we use the variable */
1089 ;* flyspell-tex-math-initialized to make a special case the first */
1090 ;* time that function is called. */
1091 ;*---------------------------------------------------------------------*/
1092 (defun flyspell-math-tex-command-p ()
1094 (flyspell-check-tex-math-command
1096 ((eq flyspell-tex-math-initialized t
)
1098 ((eq flyspell-tex-math-initialized
'error
)
1101 (setq flyspell-tex-math-initialized t
)
1105 (setq flyspell-tex-math-initialized
'error
)
1108 ;*---------------------------------------------------------------------*/
1109 ;* flyspell-tex-command-p ... */
1110 ;*---------------------------------------------------------------------*/
1111 (defun flyspell-tex-command-p (word)
1112 "Return t if WORD is a TeX command."
1114 (let ((b (car (cdr word
))))
1115 (and (re-search-backward "\\\\" (- (point) 100) t
)
1116 (or (= (match-end 0) b
)
1117 (and (goto-char (match-end 0))
1118 (looking-at flyspell-tex-command-regexp
)
1119 (>= (match-end 0) b
))))))
1120 (flyspell-math-tex-command-p)))
1122 ;*---------------------------------------------------------------------*/
1123 ;* flyspell-casechars-cache ... */
1124 ;*---------------------------------------------------------------------*/
1125 (defvar flyspell-casechars-cache nil
)
1126 (defvar flyspell-ispell-casechars-cache nil
)
1127 (make-variable-buffer-local 'flyspell-casechars-cache
)
1128 (make-variable-buffer-local 'flyspell-ispell-casechars-cache
)
1130 ;*---------------------------------------------------------------------*/
1131 ;* flyspell-get-casechars ... */
1132 ;*---------------------------------------------------------------------*/
1133 (defun flyspell-get-casechars ()
1134 "This function builds a string that is the regexp of word chars.
1135 In order to avoid one useless string construction,
1136 this function changes the last char of the `ispell-casechars' string."
1137 (let ((ispell-casechars (ispell-get-casechars)))
1139 ((eq ispell-parser
'tex
)
1140 (setq flyspell-ispell-casechars-cache ispell-casechars
)
1141 (setq flyspell-casechars-cache
1142 (concat (substring ispell-casechars
1144 (- (length ispell-casechars
) 1))
1146 flyspell-casechars-cache
)
1148 (setq flyspell-ispell-casechars-cache ispell-casechars
)
1149 (setq flyspell-casechars-cache ispell-casechars
)
1150 flyspell-casechars-cache
))))
1152 ;*---------------------------------------------------------------------*/
1153 ;* flyspell-get-not-casechars-cache ... */
1154 ;*---------------------------------------------------------------------*/
1155 (defvar flyspell-not-casechars-cache nil
)
1156 (defvar flyspell-ispell-not-casechars-cache nil
)
1157 (make-variable-buffer-local 'flyspell-not-casechars-cache
)
1158 (make-variable-buffer-local 'flyspell-ispell-not-casechars-cache
)
1160 ;*---------------------------------------------------------------------*/
1161 ;* flyspell-get-not-casechars ... */
1162 ;*---------------------------------------------------------------------*/
1163 (defun flyspell-get-not-casechars ()
1164 "This function builds a string that is the regexp of non-word chars."
1165 (let ((ispell-not-casechars (ispell-get-not-casechars)))
1167 ((eq ispell-parser
'tex
)
1168 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars
)
1169 (setq flyspell-not-casechars-cache
1170 (concat (substring ispell-not-casechars
1172 (- (length ispell-not-casechars
) 1))
1174 flyspell-not-casechars-cache
)
1176 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars
)
1177 (setq flyspell-not-casechars-cache ispell-not-casechars
)
1178 flyspell-not-casechars-cache
))))
1180 ;*---------------------------------------------------------------------*/
1181 ;* flyspell-get-word ... */
1182 ;*---------------------------------------------------------------------*/
1183 (defun flyspell-get-word (following)
1184 "Return the word for spell-checking according to Ispell syntax.
1185 If argument FOLLOWING is non-nil or if `ispell-following-word'
1186 is non-nil when called interactively, then the following word
1187 \(rather than preceding\) is checked when the cursor is not over a word.
1188 Optional second argument contains other chars that can be included in word
1191 Word syntax described by `ispell-dictionary-alist' (which see)."
1192 (let* ((flyspell-casechars (flyspell-get-casechars))
1193 (flyspell-not-casechars (flyspell-get-not-casechars))
1194 (ispell-otherchars (ispell-get-otherchars))
1195 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1196 (word-regexp (if (string< "" ispell-otherchars
)
1197 (concat flyspell-casechars
1203 (if ispell-many-otherchars-p
1205 (concat flyspell-casechars
"+")))
1209 (if (not (looking-at flyspell-casechars
))
1211 (re-search-forward flyspell-casechars
(point-max) t
)
1212 (re-search-backward flyspell-casechars
(point-min) t
)))
1213 ;; move to front of word
1214 (re-search-backward flyspell-not-casechars
(point-min) 'start
)
1216 (if (string< "" ispell-otherchars
)
1217 (while (and (looking-at ispell-otherchars
)
1219 (or (not did-it-once
)
1220 ispell-many-otherchars-p
)
1221 (not (eq pos
(point))))
1223 (setq did-it-once t
)
1225 (if (looking-at flyspell-casechars
)
1226 (re-search-backward flyspell-not-casechars
(point-min) 'move
)
1227 (backward-char -
1)))))
1228 ;; Now mark the word and save to string.
1229 (if (eq (re-search-forward word-regexp
(point-max) t
) nil
)
1232 (setq start
(match-beginning 0)
1234 word
(buffer-substring-no-properties start end
))
1235 (list word start end
)))))
1237 ;*---------------------------------------------------------------------*/
1238 ;* flyspell-small-region ... */
1239 ;*---------------------------------------------------------------------*/
1240 (defun flyspell-small-region (beg end
)
1241 "Flyspell text between BEG and END."
1249 (while (< (point) end
)
1250 (if (and flyspell-issue-message-flag
(= count
100))
1252 (message "Spell Checking...%d%%"
1253 (* 100 (/ (float (- (point) beg
)) (- end beg
))))
1255 (setq count
(+ 1 count
)))
1258 (let ((cur (point)))
1260 (if (and (< (point) end
) (> (point) (+ cur
1)))
1261 (backward-char 1)))))
1263 (if flyspell-issue-message-flag
(message "Spell Checking completed."))
1266 ;*---------------------------------------------------------------------*/
1267 ;* flyspell-external-ispell-process ... */
1268 ;*---------------------------------------------------------------------*/
1269 (defvar flyspell-external-ispell-process
'()
1270 "The external Flyspell Ispell process.")
1272 ;*---------------------------------------------------------------------*/
1273 ;* flyspell-external-ispell-buffer ... */
1274 ;*---------------------------------------------------------------------*/
1275 (defvar flyspell-external-ispell-buffer
'())
1276 (defvar flyspell-large-region-buffer
'())
1277 (defvar flyspell-large-region-beg
(point-min))
1278 (defvar flyspell-large-region-end
(point-max))
1280 ;*---------------------------------------------------------------------*/
1281 ;* flyspell-external-point-words ... */
1282 ;*---------------------------------------------------------------------*/
1283 (defun flyspell-external-point-words ()
1284 (let ((buffer flyspell-external-ispell-buffer
))
1286 (beginning-of-buffer)
1287 (let ((size (- flyspell-large-region-end flyspell-large-region-beg
))
1288 (start flyspell-large-region-beg
))
1289 ;; now we are done with ispell, we have to find the word in
1290 ;; the initial buffer
1291 (while (< (point) (- (point-max) 1))
1292 ;; we have to fetch the incorrect word
1293 (if (re-search-forward "\\([^\n]+\\)\n" (point-max) t
)
1294 (let ((word (match-string 1)))
1295 (goto-char (match-end 0))
1296 (set-buffer flyspell-large-region-buffer
)
1297 (goto-char flyspell-large-region-beg
)
1298 (if flyspell-issue-message-flag
1299 (message "Spell Checking...%d%% [%s]"
1300 (* 100 (/ (float (- (point) start
)) size
))
1302 (if (search-forward word flyspell-large-region-end t
)
1304 (setq flyspell-large-region-beg
(point))
1305 (goto-char (- (point) 1))
1307 (set-buffer buffer
))
1308 (goto-char (point-max)))))
1310 (if flyspell-issue-message-flag
(message "Spell Checking completed."))
1311 ;; ok, we are done with pointing out incorrect words, we just
1312 ;; have to kill the temporary buffer
1313 (kill-buffer flyspell-external-ispell-buffer
)
1314 (setq flyspell-external-ispell-buffer nil
)))
1316 ;*---------------------------------------------------------------------*/
1317 ;* flyspell-large-region ... */
1318 ;*---------------------------------------------------------------------*/
1319 (defun flyspell-large-region (beg end
)
1320 (let* ((curbuf (current-buffer))
1321 (buffer (get-buffer-create "*flyspell-region*")))
1322 (setq flyspell-external-ispell-buffer buffer
)
1323 (setq flyspell-large-region-buffer curbuf
)
1324 (setq flyspell-large-region-beg beg
)
1325 (setq flyspell-large-region-end end
)
1328 ;; this is done, we can start checking...
1329 (if flyspell-issue-message-flag
(message "Checking region..."))
1331 (let ((c (apply 'call-process-region beg
1339 ;; Local dictionary becomes the global dictionary in use.
1340 (if ispell-local-dictionary
1341 (setq ispell-dictionary ispell-local-dictionary
))
1342 (setq args
(ispell-get-ispell-args))
1343 (if ispell-dictionary
; use specified dictionary
1345 (append (list "-d" ispell-dictionary
) args
)))
1346 (if ispell-personal-dictionary
; use specified pers dict
1351 ispell-personal-dictionary
)))))
1352 (setq args
(append args ispell-extra-args
))
1355 (flyspell-external-point-words)
1356 (error "Can't check region...")))))
1358 ;*---------------------------------------------------------------------*/
1359 ;* flyspell-region ... */
1360 ;* ------------------------------------------------------------- */
1361 ;* Because `ispell -a' is too slow, it is not possible to use */
1362 ;* it on large region. Then, when ispell is invoked on a large */
1363 ;* text region, a new `ispell -l' process is spawned. The */
1364 ;* pointed out words are then searched in the region a checked with */
1365 ;* regular flyspell means. */
1366 ;*---------------------------------------------------------------------*/
1368 (defun flyspell-region (beg end
)
1369 "Flyspell text between BEG and END."
1378 (if (> (- end beg
) flyspell-large-region
)
1379 (flyspell-large-region beg end
)
1380 (flyspell-small-region beg end
)))))
1382 ;*---------------------------------------------------------------------*/
1383 ;* flyspell-buffer ... */
1384 ;*---------------------------------------------------------------------*/
1386 (defun flyspell-buffer ()
1387 "Flyspell whole buffer."
1389 (flyspell-region (point-min) (point-max)))
1391 ;*---------------------------------------------------------------------*/
1392 ;* old next error position ... */
1393 ;*---------------------------------------------------------------------*/
1394 (defvar flyspell-old-buffer-error nil
)
1395 (defvar flyspell-old-pos-error nil
)
1397 ;*---------------------------------------------------------------------*/
1398 ;* flyspell-goto-next-error ... */
1399 ;*---------------------------------------------------------------------*/
1400 (defun flyspell-goto-next-error ()
1401 "Go to the next previously detected error.
1402 In general FLYSPELL-GOTO-NEXT-ERROR must be used after
1407 (if (and (eq (current-buffer) flyspell-old-buffer-error
)
1408 (eq pos flyspell-old-pos-error
))
1410 (if (= flyspell-old-pos-error max
)
1411 ;; goto beginning of buffer
1413 (message "Restarting from beginning of buffer")
1414 (goto-char (point-min)))
1416 (setq pos
(point))))
1417 ;; seek the next error
1418 (while (and (< pos max
)
1419 (let ((ovs (overlays-at pos
))
1421 (while (and (not r
) (consp ovs
))
1422 (if (flyspell-overlay-p (car ovs
))
1424 (setq ovs
(cdr ovs
))))
1426 (setq pos
(1+ pos
)))
1427 ;; save the current location for next invocation
1428 (setq flyspell-old-pos-error pos
)
1429 (setq flyspell-old-buffer-error
(current-buffer))
1432 (message "No more miss-spelled word!"))))
1434 ;*---------------------------------------------------------------------*/
1435 ;* flyspell-overlay-p ... */
1436 ;*---------------------------------------------------------------------*/
1437 (defun flyspell-overlay-p (o)
1438 "A predicate that return true iff O is an overlay used by flyspell."
1439 (and (overlayp o
) (overlay-get o
'flyspell-overlay
)))
1441 ;*---------------------------------------------------------------------*/
1442 ;* flyspell-delete-all-overlays ... */
1443 ;* ------------------------------------------------------------- */
1444 ;* Remove all the overlays introduced by flyspell. */
1445 ;*---------------------------------------------------------------------*/
1446 (defun flyspell-delete-all-overlays ()
1447 "Delete all the overlays used by flyspell."
1448 (let ((l (overlays-in (point-min) (point-max))))
1451 (if (flyspell-overlay-p (car l
))
1452 (delete-overlay (car l
)))
1453 (setq l
(cdr l
))))))
1455 ;*---------------------------------------------------------------------*/
1456 ;* flyspell-unhighlight-at ... */
1457 ;*---------------------------------------------------------------------*/
1458 (defun flyspell-unhighlight-at (pos)
1459 "Remove the flyspell overlay that are located at POS."
1460 (if flyspell-persistent-highlight
1461 (let ((overlays (overlays-at pos
)))
1462 (while (consp overlays
)
1463 (if (flyspell-overlay-p (car overlays
))
1464 (delete-overlay (car overlays
)))
1465 (setq overlays
(cdr overlays
))))
1466 (if (flyspell-overlay-p flyspell-overlay
)
1467 (delete-overlay flyspell-overlay
))))
1469 ;*---------------------------------------------------------------------*/
1470 ;* flyspell-properties-at-p ... */
1471 ;* ------------------------------------------------------------- */
1472 ;* Is there an highlight properties at position pos? */
1473 ;*---------------------------------------------------------------------*/
1474 (defun flyspell-properties-at-p (pos)
1475 "Return t if there is a text property at POS, not counting `local-map'.
1476 If variable `flyspell-highlight-properties' is set to nil,
1477 text with properties are not checked. This function is used to discover
1478 if the character at POS has any other property."
1479 (let ((prop (text-properties-at pos
))
1481 (while (and keep
(consp prop
))
1482 (if (and (eq (car prop
) 'local-map
) (consp (cdr prop
)))
1483 (setq prop
(cdr (cdr prop
)))
1487 ;*---------------------------------------------------------------------*/
1488 ;* make-flyspell-overlay ... */
1489 ;*---------------------------------------------------------------------*/
1490 (defun make-flyspell-overlay (beg end face mouse-face
)
1491 "Allocate an overlay to highlight an incorrect word.
1492 BEG and END specify the range in the buffer of that word.
1493 FACE and MOUSE-FACE specify the `face' and `mouse-face' properties
1495 (let ((flyspell-overlay (make-overlay beg end nil t nil
)))
1496 (overlay-put flyspell-overlay
'face face
)
1497 (overlay-put flyspell-overlay
'mouse-face mouse-face
)
1498 (overlay-put flyspell-overlay
'flyspell-overlay t
)
1499 (overlay-put flyspell-overlay
'evaporate t
)
1500 (overlay-put flyspell-overlay
'help-echo
"mouse-2: correct word at point")
1501 (if flyspell-use-local-map
1502 (overlay-put flyspell-overlay
1503 flyspell-overlay-keymap-property-name
1504 flyspell-mouse-map
))
1505 (when (eq face
'flyspell-incorrect-face
)
1506 (and (stringp flyspell-before-incorrect-word-string
)
1507 (overlay-put flyspell-overlay
'before-string
1508 flyspell-before-incorrect-word-string
))
1509 (and (stringp flyspell-after-incorrect-word-string
)
1510 (overlay-put flyspell-overlay
'after-string
1511 flyspell-after-incorrect-word-string
)))
1514 ;*---------------------------------------------------------------------*/
1515 ;* flyspell-highlight-incorrect-region ... */
1516 ;*---------------------------------------------------------------------*/
1517 (defun flyspell-highlight-incorrect-region (beg end poss
)
1518 "Set up an overlay on a misspelled word, in the buffer from BEG to END."
1519 (unless (run-hook-with-args-until-success
1520 'flyspell-incorrect-hook beg end poss
)
1521 (if (or flyspell-highlight-properties
(not (flyspell-properties-at-p beg
)))
1523 ;; we cleanup current overlay at the same position
1524 (if (and (not flyspell-persistent-highlight
)
1525 (overlayp flyspell-overlay
))
1526 (delete-overlay flyspell-overlay
)
1527 (let ((overlays (overlays-at beg
)))
1528 (while (consp overlays
)
1529 (if (flyspell-overlay-p (car overlays
))
1530 (delete-overlay (car overlays
)))
1531 (setq overlays
(cdr overlays
)))))
1532 ;; now we can use a new overlay
1533 (setq flyspell-overlay
1534 (make-flyspell-overlay beg end
1535 'flyspell-incorrect-face
1538 ;*---------------------------------------------------------------------*/
1539 ;* flyspell-highlight-duplicate-region ... */
1540 ;*---------------------------------------------------------------------*/
1541 (defun flyspell-highlight-duplicate-region (beg end
)
1542 "Set up an overlay on a duplicated word, in the buffer from BEG to END."
1543 (if (or flyspell-highlight-properties
(not (flyspell-properties-at-p beg
)))
1545 ;; we cleanup current overlay at the same position
1546 (if (and (not flyspell-persistent-highlight
)
1547 (overlayp flyspell-overlay
))
1548 (delete-overlay flyspell-overlay
)
1549 (let ((overlays (overlays-at beg
)))
1550 (while (consp overlays
)
1551 (if (flyspell-overlay-p (car overlays
))
1552 (delete-overlay (car overlays
)))
1553 (setq overlays
(cdr overlays
)))))
1554 ;; now we can use a new overlay
1555 (setq flyspell-overlay
1556 (make-flyspell-overlay beg end
1557 'flyspell-duplicate-face
1560 ;*---------------------------------------------------------------------*/
1561 ;* flyspell-auto-correct-cache ... */
1562 ;*---------------------------------------------------------------------*/
1563 (defvar flyspell-auto-correct-pos nil
)
1564 (defvar flyspell-auto-correct-region nil
)
1565 (defvar flyspell-auto-correct-ring nil
)
1566 (defvar flyspell-auto-correct-word nil
)
1567 (make-variable-buffer-local 'flyspell-auto-correct-pos
)
1568 (make-variable-buffer-local 'flyspell-auto-correct-region
)
1569 (make-variable-buffer-local 'flyspell-auto-correct-ring
)
1570 (make-variable-buffer-local 'flyspell-auto-correct-word
)
1572 ;*---------------------------------------------------------------------*/
1573 ;* flyspell-check-previous-highlighted-word ... */
1574 ;*---------------------------------------------------------------------*/
1575 (defun flyspell-check-previous-highlighted-word (&optional arg
)
1576 "Correct the closer misspelled word.
1577 This function scans a mis-spelled word before the cursor. If it finds one
1578 it proposes replacement for that word. With prefix arg, count that many
1579 misspelled words backwards."
1581 (let ((pos1 (point))
1583 (arg (if (or (not (numberp arg
)) (< arg
1)) 1 arg
))
1586 (while (and (setq pos
(previous-overlay-change pos
))
1589 (if (> pos
(point-min))
1591 (setq ovs
(overlays-at (1- pos
)))
1594 (setq ovs
(cdr ovs
))
1595 (if (and (overlay-get ov
'flyspell-overlay
)
1596 (= 0 (setq arg
(1- arg
))))
1597 (throw 'exit t
)))))))
1601 (error "No word to correct before point"))))
1603 ;*---------------------------------------------------------------------*/
1604 ;* flyspell-display-next-corrections ... */
1605 ;*---------------------------------------------------------------------*/
1606 (defun flyspell-display-next-corrections (corrections)
1607 (let ((string "Corrections:")
1610 (while (< (length string
) 80)
1611 (if (equal (car l
) flyspell-auto-correct-word
)
1612 (setq pos
(cons (+ 1 (length string
)) pos
)))
1613 (setq string
(concat string
" " (car l
)))
1616 (let ((num (car pos
)))
1617 (put-text-property num
1618 (+ num
(length flyspell-auto-correct-word
))
1620 'flyspell-incorrect-face
1622 (setq pos
(cdr pos
)))
1623 (if (fboundp 'display-message
)
1624 (display-message 'no-log string
)
1627 ;*---------------------------------------------------------------------*/
1628 ;* flyspell-abbrev-table ... */
1629 ;*---------------------------------------------------------------------*/
1630 (defun flyspell-abbrev-table ()
1631 (if flyspell-use-global-abbrev-table-p
1633 (or local-abbrev-table global-abbrev-table
)))
1635 ;*---------------------------------------------------------------------*/
1636 ;* flyspell-define-abbrev ... */
1637 ;*---------------------------------------------------------------------*/
1638 (defun flyspell-define-abbrev (name expansion
)
1639 (let ((table (flyspell-abbrev-table)))
1641 (define-abbrev table name expansion
))))
1643 ;*---------------------------------------------------------------------*/
1644 ;* flyspell-auto-correct-word ... */
1645 ;*---------------------------------------------------------------------*/
1646 (defun flyspell-auto-correct-word ()
1647 "Correct the current word.
1648 This command proposes various successive corrections for the current word."
1651 (old-max (point-max)))
1652 ;; use the correct dictionary
1653 (flyspell-accept-buffer-local-defs)
1654 (if (and (eq flyspell-auto-correct-pos pos
)
1655 (consp flyspell-auto-correct-region
))
1656 ;; we have already been using the function at the same location
1657 (let* ((start (car flyspell-auto-correct-region
))
1658 (len (cdr flyspell-auto-correct-region
)))
1659 (flyspell-unhighlight-at start
)
1660 (delete-region start
(+ start len
))
1661 (setq flyspell-auto-correct-ring
(cdr flyspell-auto-correct-ring
))
1662 (let* ((word (car flyspell-auto-correct-ring
))
1663 (len (length word
)))
1664 (rplacd flyspell-auto-correct-region len
)
1666 (if flyspell-abbrev-p
1667 (if (flyspell-already-abbrevp (flyspell-abbrev-table)
1668 flyspell-auto-correct-word
)
1669 (flyspell-change-abbrev (flyspell-abbrev-table)
1670 flyspell-auto-correct-word
1672 (flyspell-define-abbrev flyspell-auto-correct-word word
)))
1673 (funcall flyspell-insert-function word
)
1675 (flyspell-display-next-corrections flyspell-auto-correct-ring
))
1676 (flyspell-ajust-cursor-point pos
(point) old-max
)
1677 (setq flyspell-auto-correct-pos
(point)))
1678 ;; fetch the word to be checked
1679 (let ((word (flyspell-get-word nil
))
1681 ;; destructure return word info list.
1682 (setq start
(car (cdr word
))
1683 end
(car (cdr (cdr word
)))
1685 (setq flyspell-auto-correct-word word
)
1686 ;; now check spelling of word.
1687 (process-send-string ispell-process
"%\n") ;put in verbose mode
1688 (process-send-string ispell-process
(concat "^" word
"\n"))
1689 ;; wait until ispell has processed word
1691 (accept-process-output ispell-process
)
1692 (not (string= "" (car ispell-filter
)))))
1693 (setq ispell-filter
(cdr ispell-filter
))
1694 (if (consp ispell-filter
)
1695 (setq poss
(ispell-parse-output (car ispell-filter
))))
1696 (cond ((or (eq poss t
) (stringp poss
))
1697 ;; don't correct word
1701 (error "Ispell: error in Ispell process"))
1703 ;; the word is incorrect, we have to propose a replacement
1704 (let ((replacements (if flyspell-sort-corrections
1705 (sort (car (cdr (cdr poss
))) 'string
<)
1706 (car (cdr (cdr poss
))))))
1707 (setq flyspell-auto-correct-region nil
)
1708 (if (consp replacements
)
1710 (let ((replace (car replacements
)))
1711 (let ((new-word replace
))
1712 (if (not (equal new-word
(car poss
)))
1714 ;; the save the current replacements
1715 (setq flyspell-auto-correct-region
1716 (cons start
(length new-word
)))
1717 (let ((l replacements
))
1718 (while (consp (cdr l
))
1720 (rplacd l
(cons (car poss
) replacements
)))
1721 (setq flyspell-auto-correct-ring
1723 (flyspell-unhighlight-at start
)
1724 (delete-region start end
)
1725 (funcall flyspell-insert-function new-word
)
1726 (if flyspell-abbrev-p
1727 (if (flyspell-already-abbrevp
1728 (flyspell-abbrev-table) word
)
1729 (flyspell-change-abbrev
1730 (flyspell-abbrev-table)
1733 (flyspell-define-abbrev word new-word
)))
1735 (flyspell-display-next-corrections
1736 (cons new-word flyspell-auto-correct-ring
))
1737 (flyspell-ajust-cursor-point pos
1740 (setq flyspell-auto-correct-pos
(point))
1741 (ispell-pdict-save t
)))))
1743 ;*---------------------------------------------------------------------*/
1744 ;* flyspell-auto-correct-previous-pos ... */
1745 ;*---------------------------------------------------------------------*/
1746 (defvar flyspell-auto-correct-previous-pos nil
1747 "Holds the start of the first incorrect word before point.")
1749 ;*---------------------------------------------------------------------*/
1750 ;* flyspell-auto-correct-previous-hook ... */
1751 ;*---------------------------------------------------------------------*/
1752 (defun flyspell-auto-correct-previous-hook ()
1753 "Hook to track successive calls to `flyspell-auto-correct-previous-word'.
1754 Sets flyspell-auto-correct-previous-pos to nil"
1756 (remove-hook 'pre-command-hook
(function flyspell-auto-correct-previous-hook
) t
)
1757 (unless (eq this-command
(function flyspell-auto-correct-previous-word
))
1758 (setq flyspell-auto-correct-previous-pos nil
)))
1760 ;*---------------------------------------------------------------------*/
1761 ;* flyspell-auto-correct-previous-word ... */
1762 ;*---------------------------------------------------------------------*/
1763 (defun flyspell-auto-correct-previous-word (position)
1764 "*Auto correct the first mispelled word that occurs before point."
1767 (add-hook 'pre-command-hook
1768 (function flyspell-auto-correct-previous-hook
) t t
)
1771 (unless flyspell-auto-correct-previous-pos
1772 ;; only reset if a new overlay exists
1773 (setq flyspell-auto-correct-previous-pos nil
)
1775 (let ((overlay-list (overlays-in (point-min) position
))
1776 (new-overlay 'dummy-value
))
1778 ;; search for previous (new) flyspell overlay
1779 (while (and new-overlay
1780 (or (not (flyspell-overlay-p new-overlay
))
1781 ;; check if its face has changed
1782 (not (eq (get-char-property
1783 (overlay-start new-overlay
) 'face
)
1784 'flyspell-incorrect-face
))))
1785 (setq new-overlay
(car-safe overlay-list
))
1786 (setq overlay-list
(cdr-safe overlay-list
)))
1788 ;; if nothing new exits new-overlay should be nil
1789 (if new-overlay
;; the length of the word may change so go to the start
1790 (setq flyspell-auto-correct-previous-pos
1791 (overlay-start new-overlay
)))))
1793 (when flyspell-auto-correct-previous-pos
1795 (goto-char flyspell-auto-correct-previous-pos
)
1796 (let ((ispell-following-word t
));; point is at start
1797 (if (numberp flyspell-auto-correct-previous-pos
)
1798 (goto-char flyspell-auto-correct-previous-pos
))
1799 (flyspell-auto-correct-word))
1800 ;; the point may have moved so reset this
1801 (setq flyspell-auto-correct-previous-pos
(point))))))
1803 ;*---------------------------------------------------------------------*/
1804 ;* flyspell-correct-word ... */
1805 ;*---------------------------------------------------------------------*/
1806 (defun flyspell-correct-word (event)
1807 "Pop up a menu of possible corrections for a misspelled word.
1808 The word checked is the word at the mouse position."
1810 ;; use the correct dictionary
1811 (flyspell-accept-buffer-local-defs)
1812 ;; retain cursor location (I don't know why but save-excursion here fails).
1813 (let ((save (point)))
1814 (mouse-set-point event
)
1815 (let ((cursor-location (point))
1816 (word (flyspell-get-word nil
))
1817 start end poss replace
)
1818 ;; destructure return word info list.
1819 (setq start
(car (cdr word
))
1820 end
(car (cdr (cdr word
)))
1822 ;; now check spelling of word.
1823 (process-send-string ispell-process
"%\n") ;put in verbose mode
1824 (process-send-string ispell-process
(concat "^" word
"\n"))
1825 ;; wait until ispell has processed word
1827 (accept-process-output ispell-process
)
1828 (not (string= "" (car ispell-filter
)))))
1829 (setq ispell-filter
(cdr ispell-filter
))
1830 (if (consp ispell-filter
)
1831 (setq poss
(ispell-parse-output (car ispell-filter
))))
1832 (cond ((or (eq poss t
) (stringp poss
))
1833 ;; don't correct word
1837 (error "Ispell: error in Ispell process"))
1838 ((string-match "GNU" (emacs-version))
1839 ;; the word is incorrect, we have to propose a replacement
1840 (setq replace
(flyspell-emacs-popup event poss word
))
1841 (cond ((eq replace
'ignore
)
1846 (process-send-string ispell-process
(concat "*" word
"\n"))
1847 (flyspell-unhighlight-at cursor-location
)
1848 (setq ispell-pdict-modified-p
'(t)))
1849 ((or (eq replace
'buffer
) (eq replace
'session
))
1850 (process-send-string ispell-process
(concat "@" word
"\n"))
1851 (if (null ispell-pdict-modified-p
)
1852 (setq ispell-pdict-modified-p
1853 (list ispell-pdict-modified-p
)))
1854 (flyspell-unhighlight-at cursor-location
)
1856 (if (eq replace
'buffer
)
1857 (ispell-add-per-file-word-list word
)))
1859 (flyspell-unhighlight-at cursor-location
)
1860 (let ((new-word (if (atom replace
)
1863 (cursor-location (+ (- (length word
) (- end start
))
1865 (if (not (equal new-word
(car poss
)))
1866 (let ((old-max (point-max)))
1867 (delete-region start end
)
1868 (funcall flyspell-insert-function new-word
)
1869 (if flyspell-abbrev-p
1870 (flyspell-define-abbrev word new-word
))
1871 (flyspell-ajust-cursor-point save
1877 ((eq flyspell-emacs
'xemacs
)
1878 (flyspell-xemacs-popup
1879 event poss word cursor-location start end save
)
1881 (ispell-pdict-save t
))))
1883 ;*---------------------------------------------------------------------*/
1884 ;* flyspell-xemacs-correct ... */
1885 ;*---------------------------------------------------------------------*/
1886 (defun flyspell-xemacs-correct (replace poss word cursor-location start end save
)
1887 "The xemacs popup menu callback."
1888 (cond ((eq replace
'ignore
)
1891 (process-send-string ispell-process
(concat "*" word
"\n"))
1892 (process-send-string ispell-process
"#\n")
1893 (flyspell-unhighlight-at cursor-location
)
1894 (setq ispell-pdict-modified-p
'(t)))
1895 ((or (eq replace
'buffer
) (eq replace
'session
))
1896 (process-send-string ispell-process
(concat "@" word
"\n"))
1897 (flyspell-unhighlight-at cursor-location
)
1898 (if (null ispell-pdict-modified-p
)
1899 (setq ispell-pdict-modified-p
1900 (list ispell-pdict-modified-p
)))
1901 (if (eq replace
'buffer
)
1902 (ispell-add-per-file-word-list word
)))
1904 (let ((old-max (point-max))
1905 (new-word (if (atom replace
)
1908 (cursor-location (+ (- (length word
) (- end start
))
1910 (if (not (equal new-word
(car poss
)))
1912 (delete-region start end
)
1914 (funcall flyspell-insert-function new-word
)
1915 (if flyspell-abbrev-p
1916 (flyspell-define-abbrev word new-word
))))
1917 (flyspell-ajust-cursor-point save cursor-location old-max
)))))
1919 ;*---------------------------------------------------------------------*/
1920 ;* flyspell-ajust-cursor-point ... */
1921 ;*---------------------------------------------------------------------*/
1922 (defun flyspell-ajust-cursor-point (save cursor-location old-max
)
1923 (if (>= save cursor-location
)
1924 (let ((new-pos (+ save
(- (point-max) old-max
))))
1926 ((< new-pos
(point-min))
1928 ((> new-pos
(point-max))
1933 ;*---------------------------------------------------------------------*/
1934 ;* flyspell-emacs-popup ... */
1935 ;*---------------------------------------------------------------------*/
1936 (defun flyspell-emacs-popup (event poss word
)
1937 "The Emacs popup menu."
1939 (let* ((mouse-pos (mouse-position))
1940 (mouse-pos (if (nth 1 mouse-pos
)
1942 (set-mouse-position (car mouse-pos
)
1943 (/ (frame-width) 2) 2)
1946 (setq event
(list (list (car (cdr mouse-pos
))
1947 (1+ (cdr (cdr mouse-pos
))))
1949 (let* ((corrects (if flyspell-sort-corrections
1950 (sort (car (cdr (cdr poss
))) 'string
<)
1951 (car (cdr (cdr poss
)))))
1952 (cor-menu (if (consp corrects
)
1953 (mapcar (lambda (correct)
1954 (list correct correct
))
1957 (affix (car (cdr (cdr (cdr poss
)))))
1958 (base-menu (let ((save (if (consp affix
)
1960 (list (concat "Save affix: " (car affix
))
1962 '("Accept (session)" session
)
1963 '("Accept (buffer)" buffer
))
1964 '(("Save word" save
)
1965 ("Accept (session)" session
)
1966 ("Accept (buffer)" buffer
)))))
1967 (if (consp cor-menu
)
1968 (append cor-menu
(cons "" save
))
1970 (menu (cons "flyspell correction menu" base-menu
)))
1971 (car (x-popup-menu event
1972 (list (format "%s [%s]" word
(or ispell-local-dictionary
1976 ;*---------------------------------------------------------------------*/
1977 ;* flyspell-xemacs-popup ... */
1978 ;*---------------------------------------------------------------------*/
1979 (defun flyspell-xemacs-popup (event poss word cursor-location start end save
)
1980 "The XEmacs popup menu."
1981 (let* ((corrects (if flyspell-sort-corrections
1982 (sort (car (cdr (cdr poss
))) 'string
<)
1983 (car (cdr (cdr poss
)))))
1984 (cor-menu (if (consp corrects
)
1985 (mapcar (lambda (correct)
1987 (list 'flyspell-xemacs-correct
1998 (affix (car (cdr (cdr (cdr poss
)))))
1999 (menu (let ((save (if (consp affix
)
2001 (concat "Save affix: " (car affix
))
2002 (list 'flyspell-xemacs-correct
2013 (list 'flyspell-xemacs-correct
2022 (session (vector "Accept (session)"
2023 (list 'flyspell-xemacs-correct
2032 (buffer (vector "Accept (buffer)"
2033 (list 'flyspell-xemacs-correct
2042 (if (consp cor-menu
)
2043 (append cor-menu
(list "-" save session buffer
))
2044 (list save session buffer
)))))
2045 (popup-menu (cons (format "%s [%s]" word
(or ispell-local-dictionary
2049 ;*---------------------------------------------------------------------*/
2050 ;* Some example functions for real autocorrecting */
2051 ;*---------------------------------------------------------------------*/
2052 (defun flyspell-maybe-correct-transposition (beg end poss
)
2053 "Check replacements for transposed characters.
2055 If the text between BEG and END is equal to a correction suggested by
2056 Ispell, after transposing two adjacent characters, correct the text,
2059 The third arg POSS is either the symbol 'doublon' or a list of
2060 possible corrections as returned by 'ispell-parse-output'.
2062 This function is meant to be added to 'flyspell-incorrect-hook'."
2064 (let ((temp-buffer (get-buffer-create " *flyspell-temp*"))
2067 (copy-to-buffer temp-buffer beg end
)
2068 (set-buffer temp-buffer
)
2069 (goto-char (1+ (point-min)))
2070 (while (and (not (eobp)) (not found
))
2072 (if (member (buffer-string) (nth 2 poss
))
2073 (setq found
(point))
2074 (transpose-chars -
1)
2078 (goto-char (+ beg found -
1))
2079 (transpose-chars -
1)
2082 (defun flyspell-maybe-correct-doubling (beg end poss
)
2083 "Check replacements for doubled characters.
2085 If the text between BEG and END is equal to a correction suggested by
2086 Ispell, after removing a pair of doubled characters, correct the text,
2089 The third arg POSS is either the symbol 'doublon' or a list of
2090 possible corrections as returned by 'ispell-parse-output'.
2092 This function is meant to be added to 'flyspell-incorrect-hook'."
2094 (let ((temp-buffer (get-buffer-create " *flyspell-temp*"))
2097 (copy-to-buffer temp-buffer beg end
)
2098 (set-buffer temp-buffer
)
2099 (goto-char (1+ (point-min)))
2100 (while (and (not (eobp)) (not found
))
2101 (when (char-equal (char-after) (char-before))
2103 (if (member (buffer-string) (nth 2 poss
))
2104 (setq found
(point))
2105 (insert-char (char-before) 1)))
2109 (goto-char (+ beg found -
1))
2113 ;*---------------------------------------------------------------------*/
2114 ;* flyspell-already-abbrevp ... */
2115 ;*---------------------------------------------------------------------*/
2116 (defun flyspell-already-abbrevp (table word
)
2117 (let ((sym (abbrev-symbol word table
)))
2118 (and sym
(symbolp sym
))))
2120 ;*---------------------------------------------------------------------*/
2121 ;* flyspell-change-abbrev ... */
2122 ;*---------------------------------------------------------------------*/
2123 (defun flyspell-change-abbrev (table old new
)
2124 (set (abbrev-symbol old table
) new
))
2128 ;;; arch-tag: 05d915b9-e9cf-44fb-9137-fc28f5eaab2a
2129 ;;; flyspell.el ends here