| blob | db536c100f3f1322aab3e70c9b7a581c7e095a64 |
1 ;;; flyspell.el --- on-the-fly spell checker
3 ;; Copyright (C) 1998, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Manuel Serrano <Manuel.Serrano@sophia.inria.fr>
6 ;; Maintainer: FSF
7 ;; Keywords: convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
25 ;;
26 ;; Flyspell is a minor Emacs mode performing on-the-fly spelling
27 ;; checking.
28 ;;
29 ;; To enable Flyspell minor mode, type M-x flyspell-mode.
30 ;; This applies only to the current buffer.
31 ;;
32 ;; To enable Flyspell in text representing computer programs, type
33 ;; M-x flyspell-prog-mode.
34 ;; In that mode only text inside comments is checked.
35 ;;
36 ;; Some user variables control the behavior of flyspell. They are
37 ;; those defined under the `User variables' comment.
39 ;;; Code:
43 ;;*---------------------------------------------------------------------*/
44 ;;* Group ... */
45 ;;*---------------------------------------------------------------------*/
47 "Spell checking on the fly."
53 ;;*---------------------------------------------------------------------*/
54 ;;* User configuration ... */
55 ;;*---------------------------------------------------------------------*/
57 "How Flyspell should indicate misspelled words.
58 Non-nil means use highlight, nil means use minibuffer messages."
63 "Non-nil means Flyspell reports a repeated word as an error.
64 See `flyspell-mark-duplications-exceptions' to add exceptions to this rule.
65 Detection of repeated words is not implemented in
73 "A list of exceptions for duplicated words.
74 It should be a list of (LANGUAGE . EXCEPTION-LIST).
76 LANGUAGE is nil, which means the exceptions apply regardless of
77 the current dictionary, or a regular expression matching the
78 dictionary name (`ispell-local-dictionary' or
79 `ispell-dictionary') for which the exceptions should apply.
81 EXCEPTION-LIST is a list of strings. The checked word is
82 downcased before comparing with these exceptions."
85 string)
90 "Non-nil means, sort the corrections alphabetically before popping them."
96 "The maximum distance for finding duplicates of unrecognized words.
97 This applies to the feature that when a word is not found in the dictionary,
98 if the same spelling occurs elsewhere in the buffer,
99 Flyspell uses a different face (`flyspell-duplicate') to highlight it.
100 This variable specifies how far to search to find such a duplicate.
101 -1 means no limit (search the whole buffer).
102 0 means do not search for duplicate unrecognized spellings."
106 number))
114 "Non-nil means misspelled words remain highlighted until corrected.
115 If this variable is nil, only the most recently detected misspelled word
116 is highlighted."
121 "Non-nil means highlight incorrect words even if a property exists for this word."
127 delete-backward-char
128 backward-or-forward-delete-char
129 delete-char
130 scrollbar-vertical-drag
131 backward-delete-char-untabify)
132 "The standard list of delayed commands for Flyspell.
133 See `flyspell-delayed-commands'."
140 After these commands, Flyspell checking is delayed for a short time,
141 whose length is specified by `flyspell-delay'."
147 previous-line
148 scroll-up
149 scroll-down)
150 "The standard list of deplacement commands for Flyspell.
151 See `flyspell-deplacement-commands'."
158 After these commands, Flyspell checking is performed only if the previous
159 command was not the very same command."
165 "Non-nil means that Flyspell should display a welcome message when started."
170 "Non-nil means that Flyspell emits messages when checking words."
175 "List of functions to be called when incorrect words are encountered.
176 Each function is given three arguments. The first two
177 arguments are the beginning and the end of the incorrect region.
178 The third is either the symbol `doublon' or the list
179 of possible corrections as returned by `ispell-parse-output'.
181 If any of the functions return non-nil, the word is not highlighted as
182 incorrect."
188 "A string that is the name of the default dictionary.
189 This is passed to the `ispell-change-dictionary' when flyspell is started.
190 If the variable `ispell-local-dictionary' or `ispell-dictionary' is non-nil
191 when flyspell is started, the value of that variable is used instead
192 of `flyspell-default-dictionary' to select the default dictionary.
193 Otherwise, if `flyspell-default-dictionary' is nil, it means to use
194 Ispell's ultimate default dictionary."
200 "\\(\\(begin\\|end\\)[ \t]*{\\|\\(cite[a-z*]*\\|label\\|ref\\|eqref\\|usepackage\\|documentclass\\)[ \t]*\\(\\[[^]]*\\]\\)?{[^{}]*\\)"
201 "A string that is the regular expression that matches TeX commands."
207 "Non-nil means check even inside TeX math environment.
208 TeX math environments are discovered by `texmathp', implemented
209 inside AUCTeX package. That package may be found at
210 URL `http://www.gnu.org/software/auctex/'"
216 "List of dictionary names that consider `-' as word delimiter."
222 nil
223 "If non-nil, add correction to abbreviation table."
229 nil
230 "If non-nil, prefer global abbrev table to local abbrev table."
236 "String displayed on the modeline when flyspell is active.
237 Set this to nil if you don't want a modeline indicator."
242 "The threshold that determines if a region is small.
243 If the region is smaller than this number of characters,
244 `flyspell-region' checks the words sequentially using regular
245 flyspell methods. Else, if the region is large, a new Ispell process is
246 spawned for speed.
248 Doubled words are not detected in a large region, because Ispell
249 does not check for them.
251 If this variable is nil, all regions are treated as small."
257 "Function for inserting word by flyspell upon correction."
262 "String used to indicate an incorrect word starting."
267 "String used to indicate an incorrect word ending."
274 "Non-nil means that flyspell uses M-TAB to correct word."
285 "The key binding for flyspell auto correction."
288 ;;*---------------------------------------------------------------------*/
289 ;;* Mode specific options */
290 ;;* ------------------------------------------------------------- */
291 ;;* Mode specific options enable users to disable flyspell on */
292 ;;* certain word depending of the emacs mode. For instance, when */
293 ;;* using flyspell with mail-mode add the following expression */
294 ;;* in your .emacs file: */
295 ;;* (add-hook 'mail-mode */
296 ;;* (lambda () (setq flyspell-generic-check-word-predicate */
297 ;;* 'mail-mode-flyspell-verify))) */
298 ;;*---------------------------------------------------------------------*/
300 "Function providing per-mode customization over which words are flyspelled.
301 Returns t to continue checking, nil otherwise.
302 Flyspell mode sets this variable to whatever is the `flyspell-mode-predicate'
308 ;;*--- mail mode -------------------------------------------------------*/
313 "Function used for `flyspell-generic-check-word-predicate' in Mail mode."
320 nil t)
334 nil)
340 ;;*--- texinfo mode ----------------------------------------------------*/
343 "Function used for `flyspell-generic-check-word-predicate' in Texinfo mode."
348 ;;*--- tex mode --------------------------------------------------------*/
351 "Function used for `flyspell-generic-check-word-predicate' in LaTeX mode."
363 ;;*--- sgml mode -------------------------------------------------------*/
371 "Function used for `flyspell-generic-check-word-predicate' in SGML mode.
372 Tag and attribute names are not spell checked, everything else is.
374 String values of attributes are checked because they can be text
380 ;;*---------------------------------------------------------------------*/
381 ;;* Programming mode */
382 ;;*---------------------------------------------------------------------*/
388 "Used for `flyspell-generic-check-word-predicate' in programming modes."
389 ;; (point) is next char after the word. Must check one char before.
393 ;;;###autoload
395 "Turn on `flyspell-mode' for comments and strings."
402 ;;*---------------------------------------------------------------------*/
403 ;;* Overlay compatibility */
404 ;;*---------------------------------------------------------------------*/
414 ;;*---------------------------------------------------------------------*/
415 ;;* The minor mode declaration. */
416 ;;*---------------------------------------------------------------------*/
421 (define-key map [down-mouse-2] #'flyspell-correct-word)
422 (define-key map [mouse-2] 'undefined))
423 map)
424 "Keymap for Flyspell to put on erroneous words.")
426 (defvar flyspell-mode-map
427 (let ((map (make-sparse-keymap)))
428 (if flyspell-use-meta-tab
430 (define-key map flyspell-auto-correct-binding 'flyspell-auto-correct-previous-word)
431 (define-key map [(control ?\,)] 'flyspell-goto-next-error)
432 (define-key map [(control ?\.)] 'flyspell-auto-correct-word)
433 (define-key map [?\C-c ?$] 'flyspell-correct-word-before-point)
434 map)
435 "Minor mode keymap for Flyspell mode--for the whole buffer.")
437 ;; dash character machinery
438 (defvar flyspell-consider-dash-as-word-delimiter-flag nil
439 "*Non-nil means that the `-' char is considered as a word delimiter.")
440 (make-variable-buffer-local 'flyspell-consider-dash-as-word-delimiter-flag)
441 (defvar flyspell-dash-dictionary nil)
442 (make-variable-buffer-local 'flyspell-dash-dictionary)
443 (defvar flyspell-dash-local-dictionary nil)
444 (make-variable-buffer-local 'flyspell-dash-local-dictionary)
446 ;;*---------------------------------------------------------------------*/
447 ;;* Highlighting */
448 ;;*---------------------------------------------------------------------*/
449 (defface flyspell-incorrect
450 '((((class color)) (:foreground "OrangeRed" :bold t :underline t))
451 (t (:bold t)))
452 "Face used for marking a misspelled word in Flyspell."
453 :group 'flyspell)
454 (define-obsolete-face-alias 'flyspell-incorrect-face 'flyspell-incorrect "22.1")
456 (defface flyspell-duplicate
457 '((((class color)) (:foreground "Gold3" :bold t :underline t))
458 (t (:bold t)))
459 "Face used for marking a misspelled word that appears twice in the buffer.
460 See also `flyspell-duplicate-distance'."
461 :group 'flyspell)
462 (define-obsolete-face-alias 'flyspell-duplicate-face 'flyspell-duplicate "22.1")
464 (defvar flyspell-overlay nil)
466 ;;*---------------------------------------------------------------------*/
467 ;;* flyspell-mode ... */
468 ;;*---------------------------------------------------------------------*/
469 ;;;###autoload(defvar flyspell-mode nil)
470 ;;;###autoload
471 (define-minor-mode flyspell-mode
472 "Toggle on-the-fly spell checking (Flyspell mode).
473 With a prefix argument ARG, enable Flyspell mode if ARG is
474 positive, and disable it otherwise. If called from Lisp, enable
475 the mode if ARG is omitted or nil.
477 Flyspell mode is a buffer-local minor mode. When enabled, it
478 spawns a single Ispell process and checks each word. The default
479 flyspell behavior is to highlight incorrect words.
481 Bindings:
487 Hooks:
488 This runs `flyspell-mode-hook' after flyspell mode is entered or exit.
490 Remark:
491 `flyspell-mode' uses `ispell-mode'. Thus all Ispell options are
492 valid. For instance, a different dictionary can be used by
493 invoking `ispell-change-dictionary'.
495 Consider using the `ispell-parser' to check your text. For instance
496 consider adding:
497 \(add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))
498 in your .emacs file.
502 :lighter flyspell-mode-line-string
503 :keymap flyspell-mode-map
504 :group 'flyspell
505 (if flyspell-mode
506 (condition-case err
507 (flyspell-mode-on)
509 (flyspell-mode -1)))
510 (flyspell-mode-off)))
512 ;;;###autoload
513 (defun turn-on-flyspell ()
514 "Unconditionally turn on Flyspell mode."
515 (flyspell-mode 1))
517 ;;;###autoload
518 (defun turn-off-flyspell ()
519 "Unconditionally turn off Flyspell mode."
520 (flyspell-mode -1))
522 (custom-add-option 'text-mode-hook 'turn-on-flyspell)
524 ;;*---------------------------------------------------------------------*/
525 ;;* flyspell-buffers ... */
526 ;;* ------------------------------------------------------------- */
527 ;;* For remembering buffers running flyspell */
528 ;;*---------------------------------------------------------------------*/
529 (defvar flyspell-buffers nil)
531 ;;*---------------------------------------------------------------------*/
532 ;;* flyspell-minibuffer-p ... */
533 ;;*---------------------------------------------------------------------*/
534 (defun flyspell-minibuffer-p (buffer)
535 "Is BUFFER a minibuffer?"
536 (let ((ws (get-buffer-window-list buffer t)))
537 (and (consp ws) (window-minibuffer-p (car ws)))))
539 ;;*---------------------------------------------------------------------*/
540 ;;* flyspell-accept-buffer-local-defs ... */
541 ;;*---------------------------------------------------------------------*/
542 (defvar flyspell-last-buffer nil
543 "The buffer in which the last flyspell operation took place.")
545 (defun flyspell-accept-buffer-local-defs (&optional force)
546 ;; When flyspell-word is used inside a loop (e.g. when processing
547 ;; flyspell-changes), the calls to `ispell-accept-buffer-local-defs' end
548 ;; up dwarfing everything else, so only do it when the buffer has changed.
549 (when (or force (not (eq flyspell-last-buffer (current-buffer))))
550 (setq flyspell-last-buffer (current-buffer))
551 ;; Strange problem: If buffer in current window has font-lock turned on,
552 ;; but SET-BUFFER was called to point to an invisible buffer, this ispell
553 ;; call will reset the buffer to the buffer in the current window.
554 ;; However, it only happens at startup (fix by Albert L. Ting).
555 (save-current-buffer
556 (ispell-accept-buffer-local-defs))
557 (unless (and (eq flyspell-dash-dictionary ispell-dictionary)
558 (eq flyspell-dash-local-dictionary ispell-local-dictionary))
559 ;; The dictionary has changed
560 (setq flyspell-dash-dictionary ispell-dictionary)
561 (setq flyspell-dash-local-dictionary ispell-local-dictionary)
562 (setq flyspell-consider-dash-as-word-delimiter-flag
563 (member (or ispell-local-dictionary ispell-dictionary)
564 flyspell-dictionaries-that-consider-dash-as-word-delimiter)))))
566 (defun flyspell-hack-local-variables-hook ()
567 ;; When local variables are loaded, see if the dictionary context
568 ;; has changed.
569 (flyspell-accept-buffer-local-defs 'force))
571 (defun flyspell-kill-ispell-hook ()
572 (setq flyspell-last-buffer nil)
573 (dolist (buf (buffer-list))
574 (with-current-buffer buf
575 (kill-local-variable 'flyspell-word-cache-word))))
577 ;; Make sure we flush our caches when needed. Do it here rather than in
578 ;; flyspell-mode-on, since flyspell-region may be used without ever turning
579 ;; on flyspell-mode.
580 (add-hook 'ispell-kill-ispell-hook 'flyspell-kill-ispell-hook)
582 ;;*---------------------------------------------------------------------*/
583 ;;* flyspell-mode-on ... */
584 ;;*---------------------------------------------------------------------*/
585 (defun flyspell-mode-on ()
586 "Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead."
587 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
588 (setq ispell-highlight-face 'flyspell-incorrect)
589 ;; local dictionaries setup
590 (or ispell-local-dictionary ispell-dictionary
591 (if flyspell-default-dictionary
592 (ispell-change-dictionary flyspell-default-dictionary)))
593 ;; we have to force ispell to accept the local definition or
594 ;; otherwise it could be too late, the local dictionary may
595 ;; be forgotten!
596 ;; Pass the `force' argument for the case where flyspell was active already
597 ;; but the buffer's local-defs have been edited.
598 (flyspell-accept-buffer-local-defs 'force)
599 ;; we put the `flyspell-delayed' property on some commands
600 (flyspell-delay-commands)
601 ;; we put the `flyspell-deplacement' property on some commands
602 (flyspell-deplacement-commands)
603 ;; we bound flyspell action to post-command hook
604 (add-hook 'post-command-hook (function flyspell-post-command-hook) t t)
605 ;; we bound flyspell action to pre-command hook
606 (add-hook 'pre-command-hook (function flyspell-pre-command-hook) t t)
607 ;; we bound flyspell action to after-change hook
608 (add-hook 'after-change-functions 'flyspell-after-change-function nil t)
609 ;; we bound flyspell action to hack-local-variables-hook
610 (add-hook 'hack-local-variables-hook
611 (function flyspell-hack-local-variables-hook) t t)
612 ;; set flyspell-generic-check-word-predicate based on the major mode
613 (let ((mode-predicate (get major-mode 'flyspell-mode-predicate)))
614 (if mode-predicate
615 (setq flyspell-generic-check-word-predicate mode-predicate)))
616 ;; the welcome message
617 (if (and flyspell-issue-message-flag
618 flyspell-issue-welcome-flag
619 (called-interactively-p 'interactive))
620 (let ((binding (where-is-internal 'flyspell-auto-correct-word
621 nil 'non-ascii)))
622 (message "%s"
623 (if binding
624 (format "Welcome to flyspell. Use %s or Mouse-2 to correct words."
625 (key-description binding))
626 "Welcome to flyspell. Use Mouse-2 to correct words.")))))
628 ;;*---------------------------------------------------------------------*/
629 ;;* flyspell-delay-commands ... */
630 ;;*---------------------------------------------------------------------*/
631 (defun flyspell-delay-commands ()
632 "Install the standard set of Flyspell delayed commands."
633 (mapc 'flyspell-delay-command flyspell-default-delayed-commands)
634 (mapcar 'flyspell-delay-command flyspell-delayed-commands))
636 ;;*---------------------------------------------------------------------*/
637 ;;* flyspell-delay-command ... */
638 ;;*---------------------------------------------------------------------*/
639 (defun flyspell-delay-command (command)
640 "Set COMMAND to be delayed, for Flyspell.
641 When flyspell `post-command-hook' is invoked because a delayed command
642 as been used the current word is not immediately checked.
643 It will be checked only after `flyspell-delay' seconds."
644 (interactive "SDelay Flyspell after Command: ")
645 (put command 'flyspell-delayed t))
647 ;;*---------------------------------------------------------------------*/
648 ;;* flyspell-deplacement-commands ... */
649 ;;*---------------------------------------------------------------------*/
650 (defun flyspell-deplacement-commands ()
651 "Install the standard set of Flyspell deplacement commands."
652 (mapc 'flyspell-deplacement-command flyspell-default-deplacement-commands)
653 (mapcar 'flyspell-deplacement-command flyspell-deplacement-commands))
655 ;;*---------------------------------------------------------------------*/
656 ;;* flyspell-deplacement-command ... */
657 ;;*---------------------------------------------------------------------*/
658 (defun flyspell-deplacement-command (command)
659 "Set COMMAND that implement cursor movements, for Flyspell.
660 When flyspell `post-command-hook' is invoked because of a deplacement command
661 as been used the current word is checked only if the previous command was
662 not the very same deplacement command."
663 (interactive "SDeplacement Flyspell after Command: ")
664 (put command 'flyspell-deplacement t))
666 ;;*---------------------------------------------------------------------*/
667 ;;* flyspell-word-cache ... */
668 ;;*---------------------------------------------------------------------*/
669 (defvar flyspell-word-cache-start nil)
670 (defvar flyspell-word-cache-end nil)
671 (defvar flyspell-word-cache-word nil)
672 (defvar flyspell-word-cache-result '_)
673 (make-variable-buffer-local 'flyspell-word-cache-start)
674 (make-variable-buffer-local 'flyspell-word-cache-end)
675 (make-variable-buffer-local 'flyspell-word-cache-word)
676 (make-variable-buffer-local 'flyspell-word-cache-result)
678 ;;*---------------------------------------------------------------------*/
679 ;;* The flyspell pre-hook, store the current position. In the */
680 ;;* post command hook, we will check, if the word at this position */
681 ;;* has to be spell checked. */
682 ;;*---------------------------------------------------------------------*/
683 (defvar flyspell-pre-buffer nil)
684 (defvar flyspell-pre-point nil)
685 (defvar flyspell-pre-column nil)
686 (defvar flyspell-pre-pre-buffer nil)
687 (defvar flyspell-pre-pre-point nil)
688 (make-variable-buffer-local 'flyspell-pre-point)
690 ;;*---------------------------------------------------------------------*/
691 ;;* flyspell-previous-command ... */
692 ;;*---------------------------------------------------------------------*/
693 (defvar flyspell-previous-command nil
694 "The last interactive command checked by Flyspell.")
696 ;;*---------------------------------------------------------------------*/
697 ;;* flyspell-pre-command-hook ... */
698 ;;*---------------------------------------------------------------------*/
699 (defun flyspell-pre-command-hook ()
700 "Save the current buffer and point for Flyspell's post-command hook."
701 (interactive)
702 (setq flyspell-pre-buffer (current-buffer))
703 (setq flyspell-pre-point (point))
704 (setq flyspell-pre-column (current-column)))
706 ;;*---------------------------------------------------------------------*/
707 ;;* flyspell-mode-off ... */
708 ;;*---------------------------------------------------------------------*/
709 ;;;###autoload
710 (defun flyspell-mode-off ()
711 "Turn Flyspell mode off."
712 ;; we remove the hooks
713 (remove-hook 'post-command-hook (function flyspell-post-command-hook) t)
714 (remove-hook 'pre-command-hook (function flyspell-pre-command-hook) t)
715 (remove-hook 'after-change-functions 'flyspell-after-change-function t)
716 (remove-hook 'hack-local-variables-hook
717 (function flyspell-hack-local-variables-hook) t)
718 ;; we remove all the flyspell hilightings
719 (flyspell-delete-all-overlays)
720 ;; we have to erase pre cache variables
721 (setq flyspell-pre-buffer nil)
722 (setq flyspell-pre-point nil)
723 ;; we mark the mode as killed
724 (setq flyspell-mode nil))
726 ;;*---------------------------------------------------------------------*/
727 ;;* flyspell-check-pre-word-p ... */
728 ;;*---------------------------------------------------------------------*/
729 (defun flyspell-check-pre-word-p ()
730 "Return non-nil if we should check the word before point.
731 More precisely, it applies to the word that was before point
732 before the current command."
733 (cond
734 ((or (not (numberp flyspell-pre-point))
735 (not (bufferp flyspell-pre-buffer))
736 (not (buffer-live-p flyspell-pre-buffer)))
737 nil)
738 ((and (eq flyspell-pre-pre-point flyspell-pre-point)
739 (eq flyspell-pre-pre-buffer flyspell-pre-buffer))
740 nil)
741 ((or (and (= flyspell-pre-point (- (point) 1))
742 (eq (char-syntax (char-after flyspell-pre-point)) ?w))
743 (= flyspell-pre-point (point))
744 (= flyspell-pre-point (+ (point) 1)))
745 nil)
746 ((and (symbolp this-command)
747 (not executing-kbd-macro)
748 (or (get this-command 'flyspell-delayed)
749 (and (get this-command 'flyspell-deplacement)
750 (eq flyspell-previous-command this-command)))
751 (or (= (current-column) 0)
752 (= (current-column) flyspell-pre-column)
753 ;; If other post-command-hooks change the buffer,
754 ;; flyspell-pre-point can lie past eob (bug#468).
755 (null (char-after flyspell-pre-point))
756 (eq (char-syntax (char-after flyspell-pre-point)) ?w)))
757 nil)
758 ((not (eq (current-buffer) flyspell-pre-buffer))
759 t)
760 ((not (and (numberp flyspell-word-cache-start)
761 (numberp flyspell-word-cache-end)))
762 t)
763 (t
764 (or (< flyspell-pre-point flyspell-word-cache-start)
765 (> flyspell-pre-point flyspell-word-cache-end)))))
767 ;;*---------------------------------------------------------------------*/
768 ;;* The flyspell after-change-hook, store the change position. In */
769 ;;* the post command hook, we will check, if the word at this */
770 ;;* position has to be spell checked. */
771 ;;*---------------------------------------------------------------------*/
772 (defvar flyspell-changes nil)
773 (make-variable-buffer-local 'flyspell-changes)
775 ;;*---------------------------------------------------------------------*/
776 ;;* flyspell-after-change-function ... */
777 ;;*---------------------------------------------------------------------*/
778 (defun flyspell-after-change-function (start stop len)
779 "Save the current buffer and point for Flyspell's post-command hook."
780 (push (cons start stop) flyspell-changes))
782 ;;*---------------------------------------------------------------------*/
783 ;;* flyspell-check-changed-word-p ... */
784 ;;*---------------------------------------------------------------------*/
785 (defun flyspell-check-changed-word-p (start stop)
786 "Return t when the changed word has to be checked.
787 The answer depends of several criteria.
788 Mostly we check word delimiters."
789 (cond
791 t)
792 ((not (numberp flyspell-pre-point))
793 t)
794 ((and (>= flyspell-pre-point start) (<= flyspell-pre-point stop))
795 nil)
796 ((let ((pos (point)))
797 (or (>= pos start) (<= pos stop) (= pos (1+ stop))))
798 nil)
799 (t
800 t)))
802 ;;*---------------------------------------------------------------------*/
803 ;;* flyspell-check-word-p ... */
804 ;;*---------------------------------------------------------------------*/
805 (defun flyspell-check-word-p ()
806 "Return t when the word at `point' has to be checked.
807 The answer depends of several criteria.
808 Mostly we check word delimiters."
809 (cond
810 ((<= (- (point-max) 1) (point-min))
811 ;; the buffer is not filled enough
812 nil)
813 ((and (and (> (current-column) 0)
814 (not (eq (current-column) flyspell-pre-column)))
815 (save-excursion
816 (backward-char 1)
817 (and (looking-at (flyspell-get-not-casechars))
818 (or flyspell-consider-dash-as-word-delimiter-flag
819 (not (looking-at "-"))))))
820 ;; yes because we have reached or typed a word delimiter.
821 t)
822 ((symbolp this-command)
823 (cond
824 ((get this-command 'flyspell-deplacement)
825 (not (eq flyspell-previous-command this-command)))
826 ((get this-command 'flyspell-delayed)
827 ;; the current command is not delayed, that
828 ;; is that we must check the word now
829 (and (not unread-command-events)
830 (sit-for flyspell-delay)))
831 (t t)))
832 (t t)))
834 ;;*---------------------------------------------------------------------*/
835 ;;* flyspell-debug-signal-no-check ... */
836 ;;*---------------------------------------------------------------------*/
837 (defun flyspell-debug-signal-no-check (msg obj)
838 (setq debug-on-error t)
839 (with-current-buffer (get-buffer-create "*flyspell-debug*")
840 (erase-buffer)
844 ;;*---------------------------------------------------------------------*/
845 ;;* flyspell-debug-signal-pre-word-checked ... */
846 ;;*---------------------------------------------------------------------*/
847 (defun flyspell-debug-signal-pre-word-checked ()
848 (setq debug-on-error t)
849 (with-current-buffer (get-buffer-create "*flyspell-debug*")
855 (goto-char (point-max))))
857 ;;*---------------------------------------------------------------------*/
858 ;;* flyspell-debug-signal-word-checked ... */
859 ;;*---------------------------------------------------------------------*/
860 (defun flyspell-debug-signal-word-checked ()
861 (setq debug-on-error t)
862 (let ((oldbuf (current-buffer))
863 (point (point)))
864 (with-current-buffer (get-buffer-create "*flyspell-debug*")
868 (get this-command 'flyspell-delayed))))
871 (with-current-buffer oldbuf
872 (let ((c (if (> (point) (point-min))
873 (save-excursion
874 (backward-char 1)
875 (char-after (point)))
876 ? )))
877 c))
878 (with-current-buffer oldbuf
879 (let ((c (if (> (point) (point-min))
880 (save-excursion
881 (backward-char 1)
882 (and (and (looking-at (flyspell-get-not-casechars)) 1)
883 (and (or flyspell-consider-dash-as-word-delimiter-flag
885 c))))
887 (cond
888 ((not (and (symbolp this-command)
889 (get this-command 'flyspell-delayed)))
890 ;; the current command is not delayed, that
891 ;; is that we must check the word now
892 'not-delayed)
893 ((with-current-buffer oldbuf
894 (let ((c (if (> (point) (point-min))
895 (save-excursion
896 (backward-char 1)
897 (and (looking-at (flyspell-get-not-casechars))
898 (or flyspell-consider-dash-as-word-delimiter-flag
900 c))
901 ;; yes because we have reached or typed a word delimiter.
902 'separator)
903 ((not (integerp flyspell-delay))
904 ;; yes because the user had set up a no-delay configuration.
905 'no-delay)
906 (t
907 'sit-for))))
908 (goto-char (point-max)))))
910 ;;*---------------------------------------------------------------------*/
911 ;;* flyspell-debug-signal-changed-checked ... */
912 ;;*---------------------------------------------------------------------*/
913 (defun flyspell-debug-signal-changed-checked ()
914 (setq debug-on-error t)
915 (let ((point (point)))
916 (with-current-buffer (get-buffer-create "*flyspell-debug*")
919 (goto-char (point-max)))))
921 ;;*---------------------------------------------------------------------*/
922 ;;* flyspell-post-command-hook ... */
923 ;;* ------------------------------------------------------------- */
924 ;;* It is possible that we check several words: */
925 ;;* 1- the current word is checked if the predicate */
926 ;;* FLYSPELL-CHECK-WORD-P is true */
927 ;;* 2- the word that used to be the current word before the */
928 ;;* THIS-COMMAND is checked if: */
929 ;;* a- the previous word is different from the current word */
930 ;;* b- the previous word as not just been checked by the */
931 ;;* previous FLYSPELL-POST-COMMAND-HOOK */
932 ;;* 3- the words changed by the THIS-COMMAND that are neither the */
933 ;;* previous word nor the current word */
934 ;;*---------------------------------------------------------------------*/
935 (defun flyspell-post-command-hook ()
936 "The `post-command-hook' used by flyspell to check a word on-the-fly."
937 (interactive)
938 (when flyspell-mode
939 (with-local-quit
940 (let ((command this-command)
941 ;; Prevent anything we do from affecting the mark.
942 deactivate-mark)
943 (if (flyspell-check-pre-word-p)
944 (with-current-buffer flyspell-pre-buffer
945 '(flyspell-debug-signal-pre-word-checked)
946 (save-excursion
947 (goto-char flyspell-pre-point)
948 (flyspell-word))))
949 (if (flyspell-check-word-p)
950 (progn
951 '(flyspell-debug-signal-word-checked)
952 ;; FIXME: This should be asynchronous!
953 (flyspell-word)
954 ;; we remember which word we have just checked.
955 ;; this will be used next time we will check a word
956 ;; to compare the next current word with the word
957 ;; that as been registered in the pre-command-hook
958 ;; that is these variables are used within the predicate
959 ;; FLYSPELL-CHECK-PRE-WORD-P
960 (setq flyspell-pre-pre-buffer (current-buffer))
961 (setq flyspell-pre-pre-point (point)))
962 (progn
963 (setq flyspell-pre-pre-buffer nil)
964 (setq flyspell-pre-pre-point nil)
965 ;; when a word is not checked because of a delayed command
966 ;; we do not disable the ispell cache.
967 (if (and (symbolp this-command)
968 (get this-command 'flyspell-delayed))
969 (progn
970 (setq flyspell-word-cache-end -1)
971 (setq flyspell-word-cache-result '_)))))
972 (while (and (not (input-pending-p)) (consp flyspell-changes))
973 (let ((start (car (car flyspell-changes)))
974 (stop (cdr (car flyspell-changes))))
975 (if (flyspell-check-changed-word-p start stop)
976 (save-excursion
977 '(flyspell-debug-signal-changed-checked)
978 (goto-char start)
979 (flyspell-word)))
980 (setq flyspell-changes (cdr flyspell-changes))))
981 (setq flyspell-previous-command command)))))
983 ;;*---------------------------------------------------------------------*/
984 ;;* flyspell-notify-misspell ... */
985 ;;*---------------------------------------------------------------------*/
986 (defun flyspell-notify-misspell (word poss)
987 (let ((replacements (if (stringp poss)
988 poss
989 (if flyspell-sort-corrections
990 (sort (car (cdr (cdr poss))) 'string<)
991 (car (cdr (cdr poss)))))))
992 (if flyspell-issue-message-flag
993 (message "misspelling `%s' %S" word replacements))))
995 ;;*---------------------------------------------------------------------*/
996 ;;* flyspell-word-search-backward ... */
997 ;;*---------------------------------------------------------------------*/
998 (defun flyspell-word-search-backward (word bound &optional ignore-case)
999 (save-excursion
1000 (let ((r '())
1001 (inhibit-point-motion-hooks t)
1002 p)
1003 (while (and (not r) (setq p (search-backward word bound t)))
1004 (let ((lw (flyspell-get-word)))
1005 (if (and (consp lw)
1006 (if ignore-case
1007 (string-equal (downcase (car lw)) (downcase word))
1008 (string-equal (car lw) word)))
1009 (setq r p)
1010 (goto-char p))))
1011 r)))
1013 ;;*---------------------------------------------------------------------*/
1014 ;;* flyspell-word-search-forward ... */
1015 ;;*---------------------------------------------------------------------*/
1016 (defun flyspell-word-search-forward (word bound)
1017 (save-excursion
1018 (let ((r '())
1019 (inhibit-point-motion-hooks t)
1020 p)
1021 (while (and (not r) (setq p (search-forward word bound t)))
1022 (let ((lw (flyspell-get-word)))
1023 (if (and (consp lw) (string-equal (car lw) word))
1024 (setq r p)
1025 (goto-char (1+ p)))))
1026 r)))
1028 ;;*---------------------------------------------------------------------*/
1029 ;;* flyspell-word ... */
1030 ;;*---------------------------------------------------------------------*/
1031 (defun flyspell-word (&optional following known-misspelling)
1032 "Spell check a word.
1033 If the optional argument FOLLOWING, or, when called interactively
1034 `ispell-following-word', is non-nil, checks the following (rather
1035 than preceding) word when the cursor is not over a word. If
1036 optional argument KNOWN-MISSPELLING is non nil considers word a
1037 misspelling and skips redundant spell-checking step."
1038 (interactive (list ispell-following-word))
1039 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1040 (save-excursion
1041 ;; use the correct dictionary
1042 (flyspell-accept-buffer-local-defs)
1043 (let* ((cursor-location (point))
1044 (flyspell-word (flyspell-get-word following))
1045 start end poss word ispell-filter)
1046 (if (or (eq flyspell-word nil)
1047 (and (fboundp flyspell-generic-check-word-predicate)
1048 (not (funcall flyspell-generic-check-word-predicate))))
1049 t
1050 (progn
1051 ;; destructure return flyspell-word info list.
1052 (setq start (car (cdr flyspell-word))
1053 end (car (cdr (cdr flyspell-word)))
1054 word (car flyspell-word))
1055 ;; before checking in the directory, we check for doublons.
1056 (cond
1057 ((and (or (not (eq ispell-parser 'tex))
1058 (and (> start (point-min))
1060 flyspell-mark-duplications-flag
1061 (not (catch 'exception
1062 (let ((dict (or ispell-local-dictionary
1063 ispell-dictionary)))
1064 (dolist (except flyspell-mark-duplications-exceptions)
1065 (and (or (null (car except))
1066 (and (stringp dict)
1067 (string-match (car except) dict)))
1068 (member (downcase word) (cdr except))
1069 (throw 'exception t))))))
1070 (save-excursion
1071 (goto-char start)
1072 (let* ((bound
1073 (- start
1074 (- end start)
1076 (p (when (>= bound (point-min))
1077 (flyspell-word-search-backward word bound t))))
1078 (and p (/= p start)))))
1079 ;; yes, this is a doublon
1080 (flyspell-highlight-incorrect-region start end 'doublon)
1081 nil)
1082 ((and (eq flyspell-word-cache-start start)
1083 (eq flyspell-word-cache-end end)
1084 (string-equal flyspell-word-cache-word word))
1085 ;; this word had been already checked, we skip
1086 flyspell-word-cache-result)
1087 ((and (eq ispell-parser 'tex)
1088 (flyspell-tex-command-p flyspell-word))
1089 ;; this is a correct word (because a tex command)
1090 (flyspell-unhighlight-at start)
1091 (if (> end start)
1092 (flyspell-unhighlight-at (- end 1)))
1093 t)
1094 (t
1095 ;; we setup the cache
1096 (setq flyspell-word-cache-start start)
1097 (setq flyspell-word-cache-end end)
1098 (setq flyspell-word-cache-word word)
1099 ;; now check spelling of word.
1100 (if (not known-misspelling)
1101 (progn
1103 ;; put in verbose mode
1105 ;; we mark the ispell process so it can be killed
1106 ;; when emacs is exited without query
1107 (set-process-query-on-exit-flag ispell-process nil)
1108 ;; Wait until ispell has processed word.
1109 (while (progn
1110 (accept-process-output ispell-process)
1111 (not (string= "" (car ispell-filter)))))
1113 ;; back to terse mode.
1114 ;; Remove leading empty element
1115 (setq ispell-filter (cdr ispell-filter))
1116 ;; ispell process should return something after word is sent.
1117 ;; Tag word as valid (i.e., skip) otherwise
1118 (or ispell-filter
1119 (setq ispell-filter '(*)))
1120 (if (consp ispell-filter)
1121 (setq poss (ispell-parse-output (car ispell-filter)))))
1122 ;; Else, this was a known misspelling to begin with, and
1123 ;; we should forge an ispell return value.
1124 (setq poss (list word 1 nil nil)))
1125 (let ((res (cond ((eq poss t)
1126 ;; correct
1127 (setq flyspell-word-cache-result t)
1128 (flyspell-unhighlight-at start)
1129 (if (> end start)
1130 (flyspell-unhighlight-at (- end 1)))
1131 t)
1132 ((and (stringp poss) flyspell-highlight-flag)
1133 ;; correct
1134 (setq flyspell-word-cache-result t)
1135 (flyspell-unhighlight-at start)
1136 (if (> end start)
1137 (flyspell-unhighlight-at (- end 1)))
1138 t)
1139 ((null poss)
1140 (setq flyspell-word-cache-result t)
1141 (flyspell-unhighlight-at start)
1142 (if (> end start)
1143 (flyspell-unhighlight-at (- end 1)))
1144 t)
1145 ((or (and (< flyspell-duplicate-distance 0)
1146 (or (save-excursion
1147 (goto-char start)
1148 (flyspell-word-search-backward
1149 word
1150 (point-min)))
1151 (save-excursion
1152 (goto-char end)
1153 (flyspell-word-search-forward
1154 word
1155 (point-max)))))
1156 (and (> flyspell-duplicate-distance 0)
1157 (or (save-excursion
1158 (goto-char start)
1159 (flyspell-word-search-backward
1160 word
1161 (- start
1162 flyspell-duplicate-distance)))
1163 (save-excursion
1164 (goto-char end)
1165 (flyspell-word-search-forward
1166 word
1167 (+ end
1168 flyspell-duplicate-distance))))))
1169 ;; This is a misspelled word which occurs
1170 ;; twice within flyspell-duplicate-distance.
1171 (setq flyspell-word-cache-result nil)
1172 (if flyspell-highlight-flag
1173 (flyspell-highlight-duplicate-region
1174 start end poss)
1175 (message "duplicate `%s'" word))
1176 nil)
1177 (t
1178 (setq flyspell-word-cache-result nil)
1179 ;; Highlight the location as incorrect,
1180 ;; including offset specified in POSS.
1181 (if flyspell-highlight-flag
1182 (flyspell-highlight-incorrect-region
1183 (if (and (consp poss)
1184 (integerp (nth 1 poss)))
1185 (+ start (nth 1 poss) -1)
1186 start)
1187 end poss)
1188 (flyspell-notify-misspell word poss))
1189 nil))))
1190 ;; return to original location
1191 (goto-char cursor-location)
1192 (if ispell-quit (setq ispell-quit nil))
1193 res))))))))
1195 ;;*---------------------------------------------------------------------*/
1196 ;;* flyspell-math-tex-command-p ... */
1197 ;;* ------------------------------------------------------------- */
1198 ;;* This function uses the texmathp package to check if point */
1199 ;;* is within a TeX math environment. `texmathp' can yield errors */
1200 ;;* if the document is currently not valid TeX syntax. */
1201 ;;*---------------------------------------------------------------------*/
1202 (defun flyspell-math-tex-command-p ()
1203 (when (fboundp 'texmathp)
1204 (if flyspell-check-tex-math-command
1205 nil
1206 (condition-case nil
1207 (texmathp)
1208 (error nil)))))
1210 ;;*---------------------------------------------------------------------*/
1211 ;;* flyspell-tex-command-p ... */
1212 ;;*---------------------------------------------------------------------*/
1213 (defun flyspell-tex-command-p (word)
1214 "Return t if WORD is a TeX command."
1215 (or (save-excursion
1216 (let ((b (car (cdr word))))
1218 (or (= (match-end 0) b)
1219 (and (goto-char (match-end 0))
1220 (looking-at flyspell-tex-command-regexp)
1221 (>= (match-end 0) b))))))
1222 (flyspell-math-tex-command-p)))
1224 ;;*---------------------------------------------------------------------*/
1225 ;;* flyspell-casechars-cache ... */
1226 ;;*---------------------------------------------------------------------*/
1227 (defvar flyspell-casechars-cache nil)
1228 (defvar flyspell-ispell-casechars-cache nil)
1229 (make-variable-buffer-local 'flyspell-casechars-cache)
1230 (make-variable-buffer-local 'flyspell-ispell-casechars-cache)
1232 ;;*---------------------------------------------------------------------*/
1233 ;;* flyspell-get-casechars ... */
1234 ;;*---------------------------------------------------------------------*/
1235 (defun flyspell-get-casechars ()
1236 "This function builds a string that is the regexp of word chars.
1237 In order to avoid one useless string construction,
1238 this function changes the last char of the `ispell-casechars' string."
1239 (let ((ispell-casechars (ispell-get-casechars)))
1240 (cond
1241 ((eq ispell-parser 'tex)
1242 (setq flyspell-ispell-casechars-cache ispell-casechars)
1243 (setq flyspell-casechars-cache
1244 (concat (substring ispell-casechars
1245 0
1246 (- (length ispell-casechars) 1))
1247 "]"))
1248 flyspell-casechars-cache)
1249 (t
1250 (setq flyspell-ispell-casechars-cache ispell-casechars)
1251 (setq flyspell-casechars-cache ispell-casechars)
1252 flyspell-casechars-cache))))
1254 ;;*---------------------------------------------------------------------*/
1255 ;;* flyspell-get-not-casechars-cache ... */
1256 ;;*---------------------------------------------------------------------*/
1257 (defvar flyspell-not-casechars-cache nil)
1258 (defvar flyspell-ispell-not-casechars-cache nil)
1259 (make-variable-buffer-local 'flyspell-not-casechars-cache)
1260 (make-variable-buffer-local 'flyspell-ispell-not-casechars-cache)
1262 ;;*---------------------------------------------------------------------*/
1263 ;;* flyspell-get-not-casechars ... */
1264 ;;*---------------------------------------------------------------------*/
1265 (defun flyspell-get-not-casechars ()
1266 "This function builds a string that is the regexp of non-word chars."
1267 (let ((ispell-not-casechars (ispell-get-not-casechars)))
1268 (cond
1269 ((eq ispell-parser 'tex)
1270 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
1271 (setq flyspell-not-casechars-cache
1272 (concat (substring ispell-not-casechars
1273 0
1274 (- (length ispell-not-casechars) 1))
1275 "]"))
1276 flyspell-not-casechars-cache)
1277 (t
1278 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
1279 (setq flyspell-not-casechars-cache ispell-not-casechars)
1280 flyspell-not-casechars-cache))))
1282 ;;*---------------------------------------------------------------------*/
1283 ;;* flyspell-get-word ... */
1284 ;;*---------------------------------------------------------------------*/
1285 (defun flyspell-get-word (&optional following extra-otherchars)
1286 "Return the word for spell-checking according to Ispell syntax.
1287 Optional argument FOLLOWING non-nil means to get the following
1288 \(rather than preceding) word when the cursor is not over a word.
1289 Optional second argument EXTRA-OTHERCHARS is a regexp of characters
1290 that may be included as part of a word (see `ispell-dictionary-alist')."
1291 (let* ((flyspell-casechars (flyspell-get-casechars))
1292 (flyspell-not-casechars (flyspell-get-not-casechars))
1293 (ispell-otherchars (ispell-get-otherchars))
1294 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1295 (word-regexp (concat flyspell-casechars
1297 (if (not (string= "" ispell-otherchars))
1298 (concat ispell-otherchars "?"))
1299 (if extra-otherchars
1300 (concat extra-otherchars "?"))
1301 flyspell-casechars
1303 (if (or ispell-many-otherchars-p
1304 extra-otherchars)
1305 "*" "?")))
1306 did-it-once prevpt
1307 start end word)
1308 ;; find the word
1309 (if (not (looking-at flyspell-casechars))
1310 (if following
1311 (re-search-forward flyspell-casechars nil t)
1312 (re-search-backward flyspell-casechars nil t)))
1313 ;; move to front of word
1314 (re-search-backward flyspell-not-casechars nil 'start)
1315 (while (and (or (and (not (string= "" ispell-otherchars))
1316 (looking-at ispell-otherchars))
1317 (and extra-otherchars (looking-at extra-otherchars)))
1318 (not (bobp))
1319 (or (not did-it-once)
1320 ispell-many-otherchars-p)
1321 (not (eq prevpt (point))))
1322 (if (and extra-otherchars (looking-at extra-otherchars))
1323 (progn
1324 (backward-char 1)
1325 (if (looking-at flyspell-casechars)
1326 (re-search-backward flyspell-not-casechars nil 'move)))
1327 (setq did-it-once t
1328 prevpt (point))
1329 (backward-char 1)
1330 (if (looking-at flyspell-casechars)
1331 (re-search-backward flyspell-not-casechars nil 'move)
1332 (backward-char -1))))
1333 ;; Now mark the word and save to string.
1334 (if (not (re-search-forward word-regexp nil t))
1335 nil
1336 (progn
1337 (setq start (match-beginning 0)
1338 end (point)
1339 word (buffer-substring-no-properties start end))
1340 (list word start end)))))
1342 ;;*---------------------------------------------------------------------*/
1343 ;;* flyspell-small-region ... */
1344 ;;*---------------------------------------------------------------------*/
1345 (defun flyspell-small-region (beg end)
1346 "Flyspell text between BEG and END."
1347 (save-excursion
1348 (if (> beg end)
1349 (let ((old beg))
1350 (setq beg end)
1351 (setq end old)))
1352 (goto-char beg)
1353 (let ((count 0))
1354 (while (< (point) end)
1355 (if (and flyspell-issue-message-flag (= count 100))
1356 (progn
1357 (message "Spell Checking...%d%%"
1358 (* 100 (/ (float (- (point) beg)) (- end beg))))
1359 (setq count 0))
1360 (setq count (+ 1 count)))
1361 (flyspell-word)
1362 (sit-for 0)
1363 (let ((cur (point)))
1364 (forward-word 1)
1365 (if (and (< (point) end) (> (point) (+ cur 1)))
1366 (backward-char 1)))))
1367 (backward-char 1)
1368 (if flyspell-issue-message-flag (message "Spell Checking completed."))
1369 (flyspell-word)))
1371 ;;*---------------------------------------------------------------------*/
1372 ;;* flyspell-external-ispell-process ... */
1373 ;;*---------------------------------------------------------------------*/
1374 (defvar flyspell-external-ispell-process '()
1375 "The external Flyspell Ispell process.")
1377 ;;*---------------------------------------------------------------------*/
1378 ;;* flyspell-external-ispell-buffer ... */
1379 ;;*---------------------------------------------------------------------*/
1380 (defvar flyspell-external-ispell-buffer '())
1381 (defvar flyspell-large-region-buffer '())
1382 (defvar flyspell-large-region-beg (point-min))
1383 (defvar flyspell-large-region-end (point-max))
1385 ;;*---------------------------------------------------------------------*/
1386 ;;* flyspell-external-point-words ... */
1387 ;;*---------------------------------------------------------------------*/
1388 (defun flyspell-external-point-words ()
1389 "Mark words from a buffer listing incorrect words in order of appearance.
1390 The list of incorrect words should be in `flyspell-external-ispell-buffer'.
1391 \(We finish by killing that buffer and setting the variable to nil.)
1392 The buffer to mark them in is `flyspell-large-region-buffer'."
1393 (let (words-not-found
1394 (ispell-otherchars (ispell-get-otherchars))
1395 (buffer-scan-pos flyspell-large-region-beg)
1396 case-fold-search)
1397 (with-current-buffer flyspell-external-ispell-buffer
1398 (goto-char (point-min))
1399 ;; Loop over incorrect words, in the order they were reported,
1400 ;; which is also the order they appear in the buffer being checked.
1402 ;; Bind WORD to the next one.
1403 (let ((word (match-string 1)) (wordpos (point)))
1404 ;; Here there used to be code to see if WORD is the same
1405 ;; as the previous iteration, and count the number of consecutive
1406 ;; identical words, and the loop below would search for that many.
1407 ;; That code seemed to be incorrect, and on principle, should
1408 ;; be unnecessary too. -- rms.
1409 (if flyspell-issue-message-flag
1410 (message "Spell Checking...%d%% [%s]"
1411 (* 100 (/ (float (point)) (point-max)))
1412 word))
1413 (with-current-buffer flyspell-large-region-buffer
1414 (goto-char buffer-scan-pos)
1415 (let ((keep t))
1416 ;; Iterate on string search until string is found as word,
1417 ;; not as substring
1418 (while keep
1419 (if (search-forward word
1420 flyspell-large-region-end t)
1421 (let* ((found-list
1422 (save-excursion
1423 ;; Move back into the match
1424 ;; so flyspell-get-word will find it.
1425 (forward-char -1)
1426 (flyspell-get-word)))
1427 (found (car found-list))
1428 (found-length (length found))
1429 (misspell-length (length word)))
1430 (when (or
1431 ;; Size matches, we really found it.
1432 (= found-length misspell-length)
1433 ;; Matches as part of a boundary-char separated word
1434 (member word
1435 (split-string found ispell-otherchars))
1436 ;; Misspelling has higher length than
1437 ;; what flyspell considers the
1438 ;; word. Caused by boundary-chars
1439 ;; mismatch. Validating seems safe.
1440 (< found-length misspell-length)
1441 ;; ispell treats beginning of some TeX
1442 ;; commands as nroff control sequences
1443 ;; and strips them in the list of
1444 ;; misspelled words thus giving a
1445 ;; non-existent word. Skip if ispell
1446 ;; is used, string is a TeX command
1447 ;; (char before beginning of word is
1448 ;; backslash) and none of the previous
1449 ;; conditions match.
1450 (and (not ispell-really-aspell)
1451 (save-excursion
1452 (goto-char (- (nth 1 found-list) 1))
1454 t
1455 nil))))
1456 (setq keep nil)
1457 (flyspell-word nil t)
1458 ;; Search for next misspelled word will begin from
1459 ;; end of last validated match.
1460 (setq buffer-scan-pos (point))))
1461 ;; Record if misspelling is not found and try new one
1462 (add-to-list 'words-not-found
1463 (concat " -> " word " - "
1464 (int-to-string wordpos)))
1465 (setq keep nil)))))))
1466 ;; we are done
1467 (if flyspell-issue-message-flag (message "Spell Checking completed.")))
1468 ;; Warn about not found misspellings
1469 (dolist (word words-not-found)
1470 (message "%s: word not found" word))
1471 ;; Kill and forget the buffer with the list of incorrect words.
1472 (kill-buffer flyspell-external-ispell-buffer)
1473 (setq flyspell-external-ispell-buffer nil)))
1475 ;;*---------------------------------------------------------------------*/
1476 ;;* flyspell-process-localwords ... */
1477 ;;* ------------------------------------------------------------- */
1478 ;;* This function is used to prevent marking of words explicitly */
1479 ;;* declared correct. */
1480 ;;*---------------------------------------------------------------------*/
1481 (defun flyspell-process-localwords (misspellings-buffer)
1482 (let (localwords case-fold-search
1483 (ispell-casechars (ispell-get-casechars)))
1484 ;; Get localwords from the original buffer
1485 (save-excursion
1486 (goto-char (point-min))
1487 ;; Localwords parsing copied from ispell.el.
1488 (while (search-forward ispell-words-keyword nil t)
1489 (let ((end (point-at-eol))
1490 string)
1491 ;; buffer-local words separated by a space, and can contain
1492 ;; any character other than a space. Not rigorous enough.
1494 (setq string (buffer-substring-no-properties (match-beginning 1)
1495 (match-end 1)))
1496 ;; This can fail when string contains a word with invalid chars.
1497 ;; Error handling needs to be added between Ispell and Emacs.
1498 (if (and (< 1 (length string))
1499 (equal 0 (string-match ispell-casechars string)))
1500 (push string localwords))))))
1501 ;; Remove localwords matches from misspellings-buffer.
1502 ;; The usual mechanism of communicating the local words to ispell
1503 ;; does not affect the special ispell process used by
1504 ;; flyspell-large-region.
1505 (with-current-buffer misspellings-buffer
1506 (save-excursion
1507 (dolist (word localwords)
1508 (goto-char (point-min))
1510 (while (re-search-forward regexp nil t)
1511 (delete-region (match-beginning 0) (match-end 0)))))))))
1513 ;;* ---------------------------------------------------------------
1514 ;;* flyspell-check-region-doublons
1515 ;;* ---------------------------------------------------------------
1516 (defun flyspell-check-region-doublons (beg end)
1517 "Check for adjacent duplicated words (doublons) in the given region."
1518 (save-excursion
1519 (goto-char beg)
1520 (flyspell-word) ; Make sure current word is checked
1521 (backward-word 1)
1522 (while (and (< (point) end)
1524 end 'move))
1525 (flyspell-word)
1526 (backward-word 1))
1527 (flyspell-word)))
1529 ;;*---------------------------------------------------------------------*/
1530 ;;* flyspell-large-region ... */
1531 ;;*---------------------------------------------------------------------*/
1532 (defun flyspell-large-region (beg end)
1533 (let* ((curbuf (current-buffer))
1534 (buffer (get-buffer-create "*flyspell-region*")))
1535 (setq flyspell-external-ispell-buffer buffer)
1536 (setq flyspell-large-region-buffer curbuf)
1537 (setq flyspell-large-region-beg beg)
1538 (setq flyspell-large-region-end end)
1539 (flyspell-accept-buffer-local-defs)
1540 (set-buffer buffer)
1541 (erase-buffer)
1542 ;; this is done, we can start checking...
1543 (if flyspell-issue-message-flag (message "Checking region..."))
1544 (set-buffer curbuf)
1545 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1546 ;; Local dictionary becomes the global dictionary in use.
1547 (setq ispell-current-dictionary
1548 (or ispell-local-dictionary ispell-dictionary))
1549 (setq ispell-current-personal-dictionary
1550 (or ispell-local-pdict ispell-personal-dictionary))
1551 (let ((args (ispell-get-ispell-args))
1552 (encoding (ispell-get-coding-system))
1553 c)
1554 (if (and ispell-current-dictionary ; use specified dictionary
1555 (not (member "-d" args))) ; only define if not overridden
1556 (setq args
1557 (append (list "-d" ispell-current-dictionary) args)))
1558 (if ispell-current-personal-dictionary ; use specified pers dict
1559 (setq args
1560 (append args
1561 (list "-p"
1562 (expand-file-name
1563 ispell-current-personal-dictionary)))))
1565 ;; Check for extended character mode
1566 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1567 (and extended-char-mode ; ~ extended character mode
1568 (string-match "[^~]+$" extended-char-mode)
1569 (add-to-list 'args (concat "-T" (match-string 0 extended-char-mode)))))
1571 ;; Add ispell-extra-args
1572 (setq args (append args ispell-extra-args))
1574 ;; If we are using recent aspell or hunspell, make sure we use the right encoding
1575 ;; for communication. ispell or older aspell/hunspell does not support this
1576 (if ispell-encoding8-command
1577 (setq args
1578 (append args
1579 (list
1580 (concat ispell-encoding8-command
1581 (symbol-name
1582 encoding))))))
1585 (setq c (apply 'ispell-call-process-region beg
1586 end
1587 ispell-program-name
1588 nil
1589 buffer
1590 nil
1591 (if ispell-really-aspell "list" "-l")
1592 args)))
1593 (if (eq c 0)
1594 (progn
1595 (flyspell-process-localwords buffer)
1596 (with-current-buffer curbuf
1597 (flyspell-delete-region-overlays beg end)
1598 (flyspell-check-region-doublons beg end))
1599 (flyspell-external-point-words))
1600 (error "Can't check region")))))
1602 ;;*---------------------------------------------------------------------*/
1603 ;;* flyspell-region ... */
1604 ;;* ------------------------------------------------------------- */
1605 ;;* Because `ispell -a' is too slow, it is not possible to use */
1606 ;;* it on large region. Then, when ispell is invoked on a large */
1607 ;;* text region, a new `ispell -l' process is spawned. The */
1608 ;;* pointed out words are then searched in the region a checked with */
1609 ;;* regular flyspell means. */
1610 ;;*---------------------------------------------------------------------*/
1611 ;;;###autoload
1612 (defun flyspell-region (beg end)
1613 "Flyspell text between BEG and END."
1614 (interactive "r")
1615 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1616 (if (= beg end)
1617 ()
1618 (save-excursion
1619 (if (> beg end)
1620 (let ((old beg))
1621 (setq beg end)
1622 (setq end old)))
1623 (if (and flyspell-large-region (> (- end beg) flyspell-large-region))
1624 (flyspell-large-region beg end)
1625 (flyspell-small-region beg end)))))
1627 ;;*---------------------------------------------------------------------*/
1628 ;;* flyspell-buffer ... */
1629 ;;*---------------------------------------------------------------------*/
1630 ;;;###autoload
1631 (defun flyspell-buffer ()
1632 "Flyspell whole buffer."
1633 (interactive)
1634 (flyspell-region (point-min) (point-max)))
1636 ;;*---------------------------------------------------------------------*/
1637 ;;* old next error position ... */
1638 ;;*---------------------------------------------------------------------*/
1639 (defvar flyspell-old-buffer-error nil)
1640 (defvar flyspell-old-pos-error nil)
1642 ;;*---------------------------------------------------------------------*/
1643 ;;* flyspell-goto-next-error ... */
1644 ;;*---------------------------------------------------------------------*/
1645 (defun flyspell-goto-next-error ()
1646 "Go to the next previously detected error.
1647 In general FLYSPELL-GOTO-NEXT-ERROR must be used after
1648 FLYSPELL-BUFFER."
1649 (interactive)
1650 (let ((pos (point))
1651 (max (point-max)))
1652 (if (and (eq (current-buffer) flyspell-old-buffer-error)
1653 (eq pos flyspell-old-pos-error))
1654 (progn
1655 (if (= flyspell-old-pos-error max)
1656 ;; goto beginning of buffer
1657 (progn
1658 (message "Restarting from beginning of buffer")
1659 (goto-char (point-min)))
1660 (forward-word 1))
1661 (setq pos (point))))
1662 ;; seek the next error
1663 (while (and (< pos max)
1664 (let ((ovs (overlays-at pos))
1665 (r '()))
1666 (while (and (not r) (consp ovs))
1667 (if (flyspell-overlay-p (car ovs))
1668 (setq r t)
1669 (setq ovs (cdr ovs))))
1670 (not r)))
1671 (setq pos (1+ pos)))
1672 ;; save the current location for next invocation
1673 (setq flyspell-old-pos-error pos)
1674 (setq flyspell-old-buffer-error (current-buffer))
1675 (goto-char pos)
1676 (if (= pos max)
1677 (message "No more miss-spelled word!"))))
1679 ;;*---------------------------------------------------------------------*/
1680 ;;* flyspell-overlay-p ... */
1681 ;;*---------------------------------------------------------------------*/
1682 (defun flyspell-overlay-p (o)
1683 "Return true if O is an overlay used by flyspell."
1684 (and (overlayp o) (overlay-get o 'flyspell-overlay)))
1686 ;;*---------------------------------------------------------------------*/
1687 ;;* flyspell-delete-region-overlays, flyspell-delete-all-overlays */
1688 ;;* ------------------------------------------------------------- */
1689 ;;* Remove overlays introduced by flyspell. */
1690 ;;*---------------------------------------------------------------------*/
1691 (defun flyspell-delete-region-overlays (beg end)
1692 "Delete overlays used by flyspell in a given region."
1693 (remove-overlays beg end 'flyspell-overlay t))
1696 (defun flyspell-delete-all-overlays ()
1697 "Delete all the overlays used by flyspell."
1698 (remove-overlays (point-min) (point-max) 'flyspell-overlay t))
1700 ;;*---------------------------------------------------------------------*/
1701 ;;* flyspell-unhighlight-at ... */
1702 ;;*---------------------------------------------------------------------*/
1703 (defun flyspell-unhighlight-at (pos)
1704 "Remove the flyspell overlay that are located at POS."
1705 (if flyspell-persistent-highlight
1706 (let ((overlays (overlays-at pos)))
1707 (while (consp overlays)
1708 (if (flyspell-overlay-p (car overlays))
1709 (delete-overlay (car overlays)))
1710 (setq overlays (cdr overlays))))
1711 (if (flyspell-overlay-p flyspell-overlay)
1712 (delete-overlay flyspell-overlay))))
1714 ;;*---------------------------------------------------------------------*/
1715 ;;* flyspell-properties-at-p ... */
1716 ;;* ------------------------------------------------------------- */
1717 ;;* Is there an highlight properties at position pos? */
1718 ;;*---------------------------------------------------------------------*/
1719 (defun flyspell-properties-at-p (pos)
1720 "Return t if there is a text property at POS, not counting `local-map'.
1721 If variable `flyspell-highlight-properties' is set to nil,
1722 text with properties are not checked. This function is used to discover
1723 if the character at POS has any other property."
1724 (let ((prop (text-properties-at pos))
1725 (keep t))
1726 (while (and keep (consp prop))
1727 (if (and (eq (car prop) 'local-map) (consp (cdr prop)))
1728 (setq prop (cdr (cdr prop)))
1729 (setq keep nil)))
1730 (consp prop)))
1732 ;;*---------------------------------------------------------------------*/
1733 ;;* make-flyspell-overlay ... */
1734 ;;*---------------------------------------------------------------------*/
1735 (defun make-flyspell-overlay (beg end face mouse-face)
1736 "Allocate an overlay to highlight an incorrect word.
1737 BEG and END specify the range in the buffer of that word.
1738 FACE and MOUSE-FACE specify the `face' and `mouse-face' properties
1739 for the overlay."
1740 (let ((overlay (make-overlay beg end nil t nil)))
1741 (overlay-put overlay 'face face)
1742 (overlay-put overlay 'mouse-face mouse-face)
1743 (overlay-put overlay 'flyspell-overlay t)
1744 (overlay-put overlay 'evaporate t)
1745 (overlay-put overlay 'help-echo "mouse-2: correct word at point")
1746 (overlay-put overlay 'keymap flyspell-mouse-map)
1747 (when (eq face 'flyspell-incorrect)
1748 (and (stringp flyspell-before-incorrect-word-string)
1749 (overlay-put overlay 'before-string
1750 flyspell-before-incorrect-word-string))
1751 (and (stringp flyspell-after-incorrect-word-string)
1752 (overlay-put overlay 'after-string
1753 flyspell-after-incorrect-word-string)))
1754 overlay))
1756 ;;*---------------------------------------------------------------------*/
1757 ;;* flyspell-highlight-incorrect-region ... */
1758 ;;*---------------------------------------------------------------------*/
1759 (defun flyspell-highlight-incorrect-region (beg end poss)
1760 "Set up an overlay on a misspelled word, in the buffer from BEG to END.
1761 POSS is usually a list of possible spelling/correction lists,
1762 as returned by `ispell-parse-output'.
1763 It can also be the symbol `doublon', in the case where the word
1764 is itself incorrect, but suspiciously repeated."
1765 (let ((inhibit-read-only t))
1766 (unless (run-hook-with-args-until-success
1767 'flyspell-incorrect-hook beg end poss)
1768 (if (or flyspell-highlight-properties
1769 (not (flyspell-properties-at-p beg)))
1770 (progn
1771 ;; we cleanup all the overlay that are in the region, not
1772 ;; beginning at the word start position
1773 (if (< (1+ beg) end)
1774 (let ((os (overlays-in (1+ beg) end)))
1775 (while (consp os)
1776 (if (flyspell-overlay-p (car os))
1777 (delete-overlay (car os)))
1778 (setq os (cdr os)))))
1779 ;; we cleanup current overlay at the same position
1780 (flyspell-unhighlight-at beg)
1781 ;; now we can use a new overlay
1782 (setq flyspell-overlay
1783 (make-flyspell-overlay
1784 beg end
1785 (if (eq poss 'doublon) 'flyspell-duplicate 'flyspell-incorrect)
1786 'highlight)))))))
1788 ;;*---------------------------------------------------------------------*/
1789 ;;* flyspell-highlight-duplicate-region ... */
1790 ;;*---------------------------------------------------------------------*/
1791 (defun flyspell-highlight-duplicate-region (beg end poss)
1792 "Set up an overlay on a duplicate misspelled word, in the buffer from BEG to END.
1793 POSS is a list of possible spelling/correction lists,
1794 as returned by `ispell-parse-output'."
1795 (let ((inhibit-read-only t))
1796 (unless (run-hook-with-args-until-success
1797 'flyspell-incorrect-hook beg end poss)
1798 (if (or flyspell-highlight-properties
1799 (not (flyspell-properties-at-p beg)))
1800 (progn
1801 ;; we cleanup current overlay at the same position
1802 (flyspell-unhighlight-at beg)
1803 ;; now we can use a new overlay
1804 (setq flyspell-overlay
1805 (make-flyspell-overlay beg end
1806 'flyspell-duplicate
1807 'highlight)))))))
1809 ;;*---------------------------------------------------------------------*/
1810 ;;* flyspell-auto-correct-cache ... */
1811 ;;*---------------------------------------------------------------------*/
1812 (defvar flyspell-auto-correct-pos nil)
1813 (defvar flyspell-auto-correct-region nil)
1814 (defvar flyspell-auto-correct-ring nil)
1815 (defvar flyspell-auto-correct-word nil)
1816 (make-variable-buffer-local 'flyspell-auto-correct-pos)
1817 (make-variable-buffer-local 'flyspell-auto-correct-region)
1818 (make-variable-buffer-local 'flyspell-auto-correct-ring)
1819 (make-variable-buffer-local 'flyspell-auto-correct-word)
1821 ;;*---------------------------------------------------------------------*/
1822 ;;* flyspell-check-previous-highlighted-word ... */
1823 ;;*---------------------------------------------------------------------*/
1824 (defun flyspell-check-previous-highlighted-word (&optional arg)
1825 "Correct the closer misspelled word.
1826 This function scans a mis-spelled word before the cursor. If it finds one
1827 it proposes replacement for that word. With prefix arg, count that many
1828 misspelled words backwards."
1829 (interactive)
1830 (let ((pos1 (point))
1831 (pos (point))
1832 (arg (if (or (not (numberp arg)) (< arg 1)) 1 arg))
1833 ov ovs)
1834 (if (catch 'exit
1835 (while (and (setq pos (previous-overlay-change pos))
1836 (not (= pos pos1)))
1837 (setq pos1 pos)
1838 (if (> pos (point-min))
1839 (progn
1840 (setq ovs (overlays-at (1- pos)))
1841 (while (consp ovs)
1842 (setq ov (car ovs))
1843 (setq ovs (cdr ovs))
1844 (if (and (flyspell-overlay-p ov)
1845 (= 0 (setq arg (1- arg))))
1846 (throw 'exit t)))))))
1847 (save-excursion
1848 (goto-char pos)
1849 (ispell-word)
1850 (setq flyspell-word-cache-word nil) ;; Force flyspell-word re-check
1851 (flyspell-word))
1852 (error "No word to correct before point"))))
1854 ;;*---------------------------------------------------------------------*/
1855 ;;* flyspell-display-next-corrections ... */
1856 ;;*---------------------------------------------------------------------*/
1857 (defun flyspell-display-next-corrections (corrections)
1858 (let ((string "Corrections:")
1859 (l corrections)
1860 (pos '()))
1861 (while (< (length string) 80)
1862 (if (equal (car l) flyspell-auto-correct-word)
1863 (setq pos (cons (+ 1 (length string)) pos)))
1864 (setq string (concat string " " (car l)))
1865 (setq l (cdr l)))
1866 (while (consp pos)
1867 (let ((num (car pos)))
1868 (put-text-property num
1869 (+ num (length flyspell-auto-correct-word))
1870 'face 'flyspell-incorrect
1871 string))
1872 (setq pos (cdr pos)))
1873 (if (fboundp 'display-message)
1874 (display-message 'no-log string)
1875 (message "%s" string))))
1877 ;;*---------------------------------------------------------------------*/
1878 ;;* flyspell-abbrev-table ... */
1879 ;;*---------------------------------------------------------------------*/
1880 (defun flyspell-abbrev-table ()
1881 (if flyspell-use-global-abbrev-table-p
1882 global-abbrev-table
1883 (or local-abbrev-table global-abbrev-table)))
1885 ;;*---------------------------------------------------------------------*/
1886 ;;* flyspell-define-abbrev ... */
1887 ;;*---------------------------------------------------------------------*/
1888 (defun flyspell-define-abbrev (name expansion)
1889 (let ((table (flyspell-abbrev-table)))
1890 (when table
1891 (define-abbrev table (downcase name) expansion))))
1893 ;;*---------------------------------------------------------------------*/
1894 ;;* flyspell-auto-correct-word ... */
1895 ;;*---------------------------------------------------------------------*/
1896 (defun flyspell-auto-correct-word ()
1897 "Correct the current word.
1898 This command proposes various successive corrections for the current word."
1899 (interactive)
1900 (let ((pos (point))
1901 (old-max (point-max)))
1902 ;; use the correct dictionary
1903 (flyspell-accept-buffer-local-defs)
1904 (if (and (eq flyspell-auto-correct-pos pos)
1905 (consp flyspell-auto-correct-region))
1906 ;; we have already been using the function at the same location
1907 (let* ((start (car flyspell-auto-correct-region))
1908 (len (cdr flyspell-auto-correct-region)))
1909 (flyspell-unhighlight-at start)
1910 (delete-region start (+ start len))
1911 (setq flyspell-auto-correct-ring (cdr flyspell-auto-correct-ring))
1912 (let* ((word (car flyspell-auto-correct-ring))
1913 (len (length word)))
1914 (rplacd flyspell-auto-correct-region len)
1915 (goto-char start)
1916 (if flyspell-abbrev-p
1917 (if (flyspell-already-abbrevp (flyspell-abbrev-table)
1918 flyspell-auto-correct-word)
1919 (flyspell-change-abbrev (flyspell-abbrev-table)
1920 flyspell-auto-correct-word
1921 word)
1922 (flyspell-define-abbrev flyspell-auto-correct-word word)))
1923 (funcall flyspell-insert-function word)
1924 (flyspell-word)
1925 (flyspell-display-next-corrections flyspell-auto-correct-ring))
1926 (flyspell-ajust-cursor-point pos (point) old-max)
1927 (setq flyspell-auto-correct-pos (point)))
1928 ;; fetch the word to be checked
1929 (let ((word (flyspell-get-word)))
1930 (if (consp word)
1931 (let ((start (car (cdr word)))
1932 (end (car (cdr (cdr word))))
1933 (word (car word))
1934 poss ispell-filter)
1935 (setq flyspell-auto-correct-word word)
1936 ;; now check spelling of word.
1939 ;; wait until ispell has processed word.
1940 (while (progn
1941 (accept-process-output ispell-process)
1942 (not (string= "" (car ispell-filter)))))
1943 ;; Remove leading empty element
1944 (setq ispell-filter (cdr ispell-filter))
1945 ;; ispell process should return something after word is sent.
1946 ;; Tag word as valid (i.e., skip) otherwise
1947 (or ispell-filter
1948 (setq ispell-filter '(*)))
1949 (if (consp ispell-filter)
1950 (setq poss (ispell-parse-output (car ispell-filter))))
1951 (cond
1952 ((or (eq poss t) (stringp poss))
1953 ;; don't correct word
1954 t)
1955 ((null poss)
1956 ;; ispell error
1957 (error "Ispell: error in Ispell process"))
1958 (t
1959 ;; the word is incorrect, we have to propose a replacement
1960 (let ((replacements (if flyspell-sort-corrections
1961 (sort (car (cdr (cdr poss))) 'string<)
1962 (car (cdr (cdr poss))))))
1963 (setq flyspell-auto-correct-region nil)
1964 (if (consp replacements)
1965 (progn
1966 (let ((replace (car replacements)))
1967 (let ((new-word replace))
1968 (if (not (equal new-word (car poss)))
1969 (progn
1970 ;; the save the current replacements
1971 (setq flyspell-auto-correct-region
1972 (cons start (length new-word)))
1973 (let ((l replacements))
1974 (while (consp (cdr l))
1975 (setq l (cdr l)))
1976 (rplacd l (cons (car poss) replacements)))
1977 (setq flyspell-auto-correct-ring
1978 replacements)
1979 (flyspell-unhighlight-at start)
1980 (delete-region start end)
1981 (funcall flyspell-insert-function new-word)
1982 (if flyspell-abbrev-p
1983 (if (flyspell-already-abbrevp
1984 (flyspell-abbrev-table) word)
1985 (flyspell-change-abbrev
1986 (flyspell-abbrev-table)
1987 word
1988 new-word)
1989 (flyspell-define-abbrev word
1990 new-word)))
1991 (flyspell-word)
1992 (flyspell-display-next-corrections
1993 (cons new-word flyspell-auto-correct-ring))
1994 (flyspell-ajust-cursor-point pos
1995 (point)
1996 old-max))))))))))
1997 (setq flyspell-auto-correct-pos (point))
1998 (ispell-pdict-save t)))))))
2000 ;;*---------------------------------------------------------------------*/
2001 ;;* flyspell-auto-correct-previous-pos ... */
2002 ;;*---------------------------------------------------------------------*/
2003 (defvar flyspell-auto-correct-previous-pos nil
2004 "Holds the start of the first incorrect word before point.")
2006 ;;*---------------------------------------------------------------------*/
2007 ;;* flyspell-auto-correct-previous-hook ... */
2008 ;;*---------------------------------------------------------------------*/
2009 (defun flyspell-auto-correct-previous-hook ()
2010 "Hook to track successive calls to `flyspell-auto-correct-previous-word'.
2011 Sets `flyspell-auto-correct-previous-pos' to nil"
2012 (interactive)
2013 (remove-hook 'pre-command-hook (function flyspell-auto-correct-previous-hook) t)
2014 (unless (eq this-command (function flyspell-auto-correct-previous-word))
2015 (setq flyspell-auto-correct-previous-pos nil)))
2017 ;;*---------------------------------------------------------------------*/
2018 ;;* flyspell-auto-correct-previous-word ... */
2019 ;;*---------------------------------------------------------------------*/
2020 (defun flyspell-auto-correct-previous-word (position)
2021 "Auto correct the first misspelled word that occurs before point.
2022 But don't look beyond what's visible on the screen."
2023 (interactive "d")
2025 (let ((top (window-start))
2026 (bot (window-end)))
2027 (save-excursion
2028 (save-restriction
2029 (narrow-to-region top bot)
2030 (overlay-recenter (point))
2032 (add-hook 'pre-command-hook
2033 (function flyspell-auto-correct-previous-hook) t t)
2035 (unless flyspell-auto-correct-previous-pos
2036 ;; only reset if a new overlay exists
2037 (setq flyspell-auto-correct-previous-pos nil)
2039 (let ((overlay-list (overlays-in (point-min) position))
2040 (new-overlay 'dummy-value))
2042 ;; search for previous (new) flyspell overlay
2043 (while (and new-overlay
2044 (or (not (flyspell-overlay-p new-overlay))
2045 ;; check if its face has changed
2046 (not (eq (get-char-property
2047 (overlay-start new-overlay) 'face)
2048 'flyspell-incorrect))))
2049 (setq new-overlay (car-safe overlay-list))
2050 (setq overlay-list (cdr-safe overlay-list)))
2052 ;; if nothing new exits new-overlay should be nil
2053 (if new-overlay ;; the length of the word may change so go to the start
2054 (setq flyspell-auto-correct-previous-pos
2055 (overlay-start new-overlay)))))
2057 (when flyspell-auto-correct-previous-pos
2058 (save-excursion
2059 (goto-char flyspell-auto-correct-previous-pos)
2060 (let ((ispell-following-word t)) ;; point is at start
2061 (if (numberp flyspell-auto-correct-previous-pos)
2062 (goto-char flyspell-auto-correct-previous-pos))
2063 (flyspell-auto-correct-word))
2064 ;; the point may have moved so reset this
2065 (setq flyspell-auto-correct-previous-pos (point))))))))
2067 ;;*---------------------------------------------------------------------*/
2068 ;;* flyspell-correct-word ... */
2069 ;;*---------------------------------------------------------------------*/
2071 (defun flyspell-correct-word (event)
2072 "Pop up a menu of possible corrections for a misspelled word.
2073 The word checked is the word at the mouse position."
2074 (interactive "e")
2075 (let ((save (point)))
2076 (mouse-set-point event)
2077 (flyspell-correct-word-before-point event save)))
2079 (defun flyspell-correct-word-before-point (&optional event opoint)
2080 "Pop up a menu of possible corrections for misspelled word before point.
2081 If EVENT is non-nil, it is the mouse event that invoked this operation;
2082 that controls where to put the menu.
2083 If OPOINT is non-nil, restore point there after adjusting it for replacement."
2084 (interactive)
2085 (unless (mouse-position)
2086 (error "Pop-up menus do not work on this terminal"))
2087 ;; use the correct dictionary
2088 (flyspell-accept-buffer-local-defs)
2089 (or opoint (setq opoint (point)))
2090 (let ((cursor-location (point))
2091 (word (flyspell-get-word)))
2092 (if (consp word)
2093 (let ((start (car (cdr word)))
2094 (end (car (cdr (cdr word))))
2095 (word (car word))
2096 poss ispell-filter)
2097 ;; now check spelling of word.
2100 ;; wait until ispell has processed word
2101 (while (progn
2102 (accept-process-output ispell-process)
2103 (not (string= "" (car ispell-filter)))))
2104 ;; Remove leading empty element
2105 (setq ispell-filter (cdr ispell-filter))
2106 ;; ispell process should return something after word is sent.
2107 ;; Tag word as valid (i.e., skip) otherwise
2108 (or ispell-filter
2109 (setq ispell-filter '(*)))
2110 (if (consp ispell-filter)
2111 (setq poss (ispell-parse-output (car ispell-filter))))
2112 (cond
2113 ((or (eq poss t) (stringp poss))
2114 ;; don't correct word
2115 t)
2116 ((null poss)
2117 ;; ispell error
2118 (error "Ispell: error in Ispell process"))
2119 ((featurep 'xemacs)
2120 (flyspell-xemacs-popup
2121 poss word cursor-location start end opoint))
2122 (t
2123 ;; The word is incorrect, we have to propose a replacement.
2124 (flyspell-do-correct (flyspell-emacs-popup event poss word)
2125 poss word cursor-location start end opoint)))
2126 (ispell-pdict-save t)))))
2128 ;;*---------------------------------------------------------------------*/
2129 ;;* flyspell-do-correct ... */
2130 ;;*---------------------------------------------------------------------*/
2131 (defun flyspell-do-correct (replace poss word cursor-location start end save)
2132 "The popup menu callback."
2133 ;; Originally, the XEmacs code didn't do the (goto-char save) here and did
2134 ;; it instead right after calling the function.
2135 (cond ((eq replace 'ignore)
2136 (goto-char save)
2137 nil)
2138 ((eq replace 'save)
2139 (goto-char save)
2141 ;; This was added only to the XEmacs side in revision 1.18 of
2142 ;; flyspell. I assume its absence on the Emacs side was an
2143 ;; oversight. --Stef
2145 (flyspell-unhighlight-at cursor-location)
2146 (setq ispell-pdict-modified-p '(t)))
2147 ((or (eq replace 'buffer) (eq replace 'session))
2149 (flyspell-unhighlight-at cursor-location)
2150 (if (null ispell-pdict-modified-p)
2151 (setq ispell-pdict-modified-p
2152 (list ispell-pdict-modified-p)))
2153 (goto-char save)
2154 (if (eq replace 'buffer)
2155 (ispell-add-per-file-word-list word)))
2156 (replace
2157 ;; This was added only to the Emacs side. I assume its absence on
2158 ;; the XEmacs side was an oversight. --Stef
2159 (flyspell-unhighlight-at cursor-location)
2160 (let ((old-max (point-max))
2161 (new-word (if (atom replace)
2162 replace
2163 (car replace)))
2164 (cursor-location (+ (- (length word) (- end start))
2165 cursor-location)))
2166 (unless (equal new-word (car poss))
2167 (delete-region start end)
2168 (goto-char start)
2169 (funcall flyspell-insert-function new-word)
2170 (if flyspell-abbrev-p
2171 (flyspell-define-abbrev word new-word)))
2172 ;; In the original Emacs code, this was only called in the body
2173 ;; of the if. I arbitrarily kept the XEmacs behavior instead.
2174 (flyspell-ajust-cursor-point save cursor-location old-max)))
2175 (t
2176 (goto-char save)
2177 nil)))
2179 ;;*---------------------------------------------------------------------*/
2180 ;;* flyspell-ajust-cursor-point ... */
2181 ;;*---------------------------------------------------------------------*/
2182 (defun flyspell-ajust-cursor-point (save cursor-location old-max)
2183 (if (>= save cursor-location)
2184 (let ((new-pos (+ save (- (point-max) old-max))))
2185 (goto-char (cond
2186 ((< new-pos (point-min))
2187 (point-min))
2188 ((> new-pos (point-max))
2189 (point-max))
2190 (t new-pos))))
2191 (goto-char save)))
2193 ;;*---------------------------------------------------------------------*/
2194 ;;* flyspell-emacs-popup ... */
2195 ;;*---------------------------------------------------------------------*/
2196 (defun flyspell-emacs-popup (event poss word)
2197 "The Emacs popup menu."
2198 (unless window-system
2199 (error "This command requires pop-up dialogs"))
2200 (if (not event)
2201 (let* ((mouse-pos (mouse-position))
2202 (mouse-pos (if (nth 1 mouse-pos)
2203 mouse-pos
2204 (set-mouse-position (car mouse-pos)
2205 (/ (frame-width) 2) 2)
2206 (mouse-position))))
2207 (setq event (list (list (car (cdr mouse-pos))
2208 (1+ (cdr (cdr mouse-pos))))
2209 (car mouse-pos)))))
2210 (let* ((corrects (if flyspell-sort-corrections
2211 (sort (car (cdr (cdr poss))) 'string<)
2212 (car (cdr (cdr poss)))))
2213 (cor-menu (if (consp corrects)
2214 (mapcar (lambda (correct)
2215 (list correct correct))
2216 corrects)
2217 '()))
2218 (affix (car (cdr (cdr (cdr poss)))))
2219 show-affix-info
2220 (base-menu (let ((save (if (and (consp affix) show-affix-info)
2221 (list
2222 (list (concat "Save affix: " (car affix))
2223 'save)
2224 '("Accept (session)" session)
2225 '("Accept (buffer)" buffer))
2226 '(("Save word" save)
2227 ("Accept (session)" session)
2228 ("Accept (buffer)" buffer)))))
2229 (if (consp cor-menu)
2230 (append cor-menu (cons "" save))
2231 save)))
2232 (menu (cons "flyspell correction menu" base-menu)))
2233 (car (x-popup-menu event
2234 (list (format "%s [%s]" word (or ispell-local-dictionary
2235 ispell-dictionary))
2236 menu)))))
2238 ;;*---------------------------------------------------------------------*/
2239 ;;* flyspell-xemacs-popup ... */
2240 ;;*---------------------------------------------------------------------*/
2241 (defun flyspell-xemacs-popup (poss word cursor-location start end save)
2242 "The XEmacs popup menu."
2243 (let* ((corrects (if flyspell-sort-corrections
2244 (sort (car (cdr (cdr poss))) 'string<)
2245 (car (cdr (cdr poss)))))
2246 (cor-menu (if (consp corrects)
2247 (mapcar (lambda (correct)
2248 (vector correct
2249 (list 'flyspell-do-correct
2250 correct
2251 (list 'quote poss)
2252 word
2253 cursor-location
2254 start
2255 end
2256 save)
2257 t))
2258 corrects)
2259 '()))
2260 (affix (car (cdr (cdr (cdr poss)))))
2261 show-affix-info
2262 (menu (let ((save (if (and (consp affix) show-affix-info)
2263 (vector
2264 (concat "Save affix: " (car affix))
2265 (list 'flyspell-do-correct
2266 ''save
2267 (list 'quote poss)
2268 word
2269 cursor-location
2270 start
2271 end
2272 save)
2273 t)
2274 (vector
2275 "Save word"
2276 (list 'flyspell-do-correct
2277 ''save
2278 (list 'quote poss)
2279 word
2280 cursor-location
2281 start
2282 end
2283 save)
2284 t)))
2285 (session (vector "Accept (session)"
2286 (list 'flyspell-do-correct
2287 ''session
2288 (list 'quote poss)
2289 word
2290 cursor-location
2291 start
2292 end
2293 save)
2294 t))
2295 (buffer (vector "Accept (buffer)"
2296 (list 'flyspell-do-correct
2297 ''buffer
2298 (list 'quote poss)
2299 word
2300 cursor-location
2301 start
2302 end
2303 save)
2304 t)))
2305 (if (consp cor-menu)
2306 (append cor-menu (list "-" save session buffer))
2307 (list save session buffer)))))
2308 (popup-menu (cons (format "%s [%s]" word (or ispell-local-dictionary
2309 ispell-dictionary))
2310 menu))))
2312 ;;*---------------------------------------------------------------------*/
2313 ;;* Some example functions for real autocorrecting */
2314 ;;*---------------------------------------------------------------------*/
2315 (defun flyspell-maybe-correct-transposition (beg end poss)
2316 "Check replacements for transposed characters.
2318 If the text between BEG and END is equal to a correction suggested by
2319 Ispell, after transposing two adjacent characters, correct the text,
2320 and return t.
2322 The third arg POSS is either the symbol 'doublon' or a list of
2323 possible corrections as returned by `ispell-parse-output'.
2325 This function is meant to be added to `flyspell-incorrect-hook'."
2326 (when (consp poss)
2327 (catch 'done
2328 (let ((str (buffer-substring beg end))
2329 (i 0) (len (- end beg)) tmp)
2330 (while (< (1+ i) len)
2331 (setq tmp (aref str i))
2332 (aset str i (aref str (1+ i)))
2333 (aset str (1+ i) tmp)
2334 (when (member str (nth 2 poss))
2335 (save-excursion
2336 (goto-char (+ beg i 1))
2337 (transpose-chars 1))
2338 (throw 'done t))
2339 (setq tmp (aref str i))
2340 (aset str i (aref str (1+ i)))
2341 (aset str (1+ i) tmp)
2342 (setq i (1+ i))))
2343 nil)))
2345 (defun flyspell-maybe-correct-doubling (beg end poss)
2346 "Check replacements for doubled characters.
2348 If the text between BEG and END is equal to a correction suggested by
2349 Ispell, after removing a pair of doubled characters, correct the text,
2350 and return t.
2352 The third arg POSS is either the symbol 'doublon' or a list of
2353 possible corrections as returned by `ispell-parse-output'.
2355 This function is meant to be added to `flyspell-incorrect-hook'."
2356 (when (consp poss)
2357 (catch 'done
2358 (let ((str (buffer-substring beg end))
2359 (i 0) (len (- end beg)))
2360 (while (< (1+ i) len)
2361 (when (and (= (aref str i) (aref str (1+ i)))
2362 (member (concat (substring str 0 (1+ i))
2363 (substring str (+ i 2)))
2364 (nth 2 poss)))
2365 (goto-char (+ beg i))
2366 (delete-char 1)
2367 (throw 'done t))
2368 (setq i (1+ i))))
2369 nil)))
2371 ;;*---------------------------------------------------------------------*/
2372 ;;* flyspell-already-abbrevp ... */
2373 ;;*---------------------------------------------------------------------*/
2374 (defun flyspell-already-abbrevp (table word)
2375 (let ((sym (abbrev-symbol word table)))
2376 (and sym (symbolp sym))))
2378 ;;*---------------------------------------------------------------------*/
2379 ;;* flyspell-change-abbrev ... */
2380 ;;*---------------------------------------------------------------------*/
2381 (defun flyspell-change-abbrev (table old new)
2382 (set (abbrev-symbol old table) new))
2384 (provide 'flyspell)
2386 ;;; flyspell.el ends here