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@sophia.inria.fr>
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 2, or (at your option)
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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; Flyspell is a minor Emacs mode performing on-the-fly spelling
31 ;; To enable Flyspell minor mode, type M-x flyspell-mode.
32 ;; This applies only to the current buffer.
34 ;; To enable Flyspell in text representing computer programs, type
35 ;; M-x flyspell-prog-mode.
36 ;; In that mode only text inside comments is checked.
38 ;; Note: consider setting the variable ispell-parser to `tex' to
39 ;; avoid TeX command checking; use `(setq ispell-parser 'tex)'.
41 ;; Some user variables control the behavior of flyspell. They are
42 ;; those defined under the `User variables' comment.
48 ;*---------------------------------------------------------------------*/
50 ;*---------------------------------------------------------------------*/
51 (defgroup flyspell nil
52 "Spell checking on the fly."
58 ;*---------------------------------------------------------------------*/
59 ;* User configuration ... */
60 ;*---------------------------------------------------------------------*/
61 (defcustom flyspell-highlight-flag t
62 "*How Flyspell should indicate misspelled words.
63 Non-nil means use highlight, nil means use minibuffer messages."
67 (defcustom flyspell-mark-duplications-flag t
68 "*Non-nil means Flyspell reports a repeated word as an error."
72 (defcustom flyspell-sort-corrections nil
73 "*Non-nil means, sort the corrections alphabetically before popping them."
78 (defcustom flyspell-duplicate-distance -1
79 "*The maximum distance for finding duplicates of unrecognized words.
80 This applies to the feature that when a word is not found in the dictionary,
81 if the same spelling occurs elsewhere in the buffer,
82 Flyspell uses a different face (`flyspell-duplicate-face') to highlight it.
83 This variable specifies how far to search to find such a duplicate.
84 -1 means no limit (search the whole buffer).
85 0 means do not search for duplicate unrecognized spellings."
90 (defcustom flyspell-delay 3
91 "*The number of seconds to wait before checking, after a \"delayed\" command."
95 (defcustom flyspell-persistent-highlight t
96 "*Non-nil means misspelled words remain highlighted until corrected.
97 If this variable is nil, only the most recently detected misspelled word
102 (defcustom flyspell-highlight-properties t
103 "*Non-nil means highlight incorrect words even if a property exists for this word."
107 (defcustom flyspell-default-delayed-commands
108 '(self-insert-command
110 backward-or-forward-delete-char
112 scrollbar-vertical-drag)
113 "The standard list of delayed commands for Flyspell.
114 See `flyspell-delayed-commands'."
117 :type '(repeat (symbol)))
119 (defcustom flyspell-delayed-commands nil
120 "List of commands that are \"delayed\" for Flyspell mode.
121 After these commands, Flyspell checking is delayed for a short time,
122 whose length is specified by `flyspell-delay'."
124 :type '(repeat (symbol)))
126 (defcustom flyspell-default-deplacement-commands
131 "The standard list of deplacement commands for Flyspell.
132 See `flyspell-deplacement-commands'."
135 :type '(repeat (symbol)))
137 (defcustom flyspell-deplacement-commands nil
138 "List of commands that are \"deplacement\" for Flyspell mode.
139 After these commands, Flyspell checking is performed only if the previous
140 command was not the very same command."
143 :type '(repeat (symbol)))
145 (defcustom flyspell-issue-welcome-flag t
146 "*Non-nil means that Flyspell should display a welcome message when started."
150 (defcustom flyspell-issue-message-flag t
151 "*Non-nil means that Flyspell emits messages when checking words."
155 (defcustom flyspell-incorrect-hook nil
156 "*List of functions to be called when incorrect words are encountered.
157 Each function is given three arguments: the beginning and the end
158 of the incorrect region. The third is either the symbol 'doublon' or the list
159 of possible corrections as returned by 'ispell-parse-output'.
161 If any of the functions return non-Nil, the word is not highlighted as
167 (defcustom flyspell-default-dictionary nil
168 "A string that is the name of the default dictionary.
169 This is passed to the `ispell-change-dictionary' when flyspell is started.
170 If the variable `ispell-local-dictionary' or `ispell-dictionary' is non-nil
171 when flyspell is started, the value of that variable is used instead
172 of `flyspell-default-dictionary' to select the default dictionary.
173 Otherwise, if `flyspell-default-dictionary' is nil, it means to use
174 Ispell's ultimate default dictionary."
177 :type '(choice string (const :tag "Default" nil)))
179 (defcustom flyspell-tex-command-regexp
180 "\\(\\(begin\\|end\\)[ \t]*{\\|\\(cite[a-z*]*\\|label\\|ref\\|eqref\\|usepackage\\|documentclass\\)[ \t]*\\(\\[[^]]*\\]\\)?{[^{}]*\\)"
181 "A string that is the regular expression that matches TeX commands."
186 (defcustom flyspell-check-tex-math-command nil
187 "*Non nil means check even inside TeX math environment.
188 TeX math environments are discovered by the TEXMATHP that implemented
189 inside the texmathp.el Emacs package. That package may be found at:
190 http://strw.leidenuniv.nl/~dominik/Tools"
194 (defcustom flyspell-dictionaries-that-consider-dash-as-word-delimiter
195 '("francais" "deutsch8" "norsk")
196 "List of dictionary names that consider `-' as word delimiter."
199 :type '(repeat (string)))
201 (defcustom flyspell-abbrev-p
203 "*If true, add correction to abbreviation table."
208 (defcustom flyspell-use-global-abbrev-table-p
210 "*If true, prefer global abbrev table to local abbrev table."
216 (defcustom flyspell-mode-line-string " Fly"
217 "*String displayed on the modeline when flyspell is active.
218 Set this to nil if you don't want a modeline indicator."
220 :type '(choice string (const :tag "None" nil)))
222 (defcustom flyspell-large-region 1000
223 "*The threshold that determines if a region is small.
224 The `flyspell-region' function is invoked if the region is small, the
225 word are checked one after the other using regular flyspell check
226 means. If the region is large, a new Ispell process is spawned to get
232 (defcustom flyspell-insert-function (function insert)
233 "*Function for inserting word by flyspell upon correction."
237 (defcustom flyspell-before-incorrect-word-string nil
238 "String used to indicate an incorrect word starting."
240 :type '(choice string (const nil)))
242 (defcustom flyspell-after-incorrect-word-string nil
243 "String used to indicate an incorrect word ending."
245 :type '(choice string (const nil)))
247 ;*---------------------------------------------------------------------*/
248 ;* Mode specific options */
249 ;* ------------------------------------------------------------- */
250 ;* Mode specific options enable users to disable flyspell on */
251 ;* certain word depending of the emacs mode. For instance, when */
252 ;* using flyspell with mail-mode add the following expression */
253 ;* in your .emacs file: */
254 ;* (add-hook 'mail-mode */
255 ;* '(lambda () (setq flyspell-generic-check-word-p */
256 ;* 'mail-mode-flyspell-verify))) */
257 ;*---------------------------------------------------------------------*/
258 (defvar flyspell-generic-check-word-p nil
259 "Function providing per-mode customization over which words are flyspelled.
260 Returns t to continue checking, nil otherwise.
261 Flyspell mode sets this variable to whatever is the `flyspell-mode-predicate'
262 property of the major mode name.")
263 (make-variable-buffer-local 'flyspell-generic-check-word-p)
265 ;*--- mail mode -------------------------------------------------------*/
266 (put 'mail-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
267 (put 'message-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
268 (defun mail-mode-flyspell-verify ()
269 "This function is used for `flyspell-generic-check-word-p' in Mail mode."
270 (let ((in-headers (save-excursion
271 ;; When mail-header-separator is "",
272 ;; it is likely to be found in both directions.
273 (not (re-search-backward (concat "^" (regexp-quote mail-header-separator) "$") nil t))))
274 (in-signature (save-excursion
275 (re-search-backward message-signature-separator nil t))))
277 (and (save-excursion (beginning-of-line)
278 (looking-at "^Subject:"))
279 (> (point) (match-end 0))))
285 (not (looking-at "[>}|]\\To:")))))))
287 ;*--- texinfo mode ----------------------------------------------------*/
288 (put 'texinfo-mode 'flyspell-mode-predicate 'texinfo-mode-flyspell-verify)
289 (defun texinfo-mode-flyspell-verify ()
290 "This function is used for `flyspell-generic-check-word-p' in Texinfo mode."
293 (not (looking-at "@"))))
295 ;*--- tex mode --------------------------------------------------------*/
296 (put 'tex-mode 'flyspell-mode-predicate 'tex-mode-flyspell-verify)
297 (defun tex-mode-flyspell-verify ()
298 "This function is used for `flyspell-generic-check-word-p' in LaTeX mode."
301 (re-search-backward "^[ \t]*%%%[ \t]+Local" (point-min) t)))
303 (let ((this (point-marker))
304 (e (progn (end-of-line) (point-marker))))
306 (if (re-search-forward "\\\\\\(cite\\|label\\|ref\\){[^}]*}" e t)
307 (and (>= this (match-beginning 0))
308 (<= this (match-end 0)) )))))))
310 ;*--- sgml mode -------------------------------------------------------*/
311 (put 'sgml-mode 'flyspell-mode-predicate 'sgml-mode-flyspell-verify)
312 (put 'html-mode 'flyspell-mode-predicate 'sgml-mode-flyspell-verify)
314 (defun sgml-mode-flyspell-verify ()
315 "This function is used for `flyspell-generic-check-word-p' in SGML mode."
317 (let ((this (point-marker))
318 (s (progn (beginning-of-line) (point-marker)))
319 (e (progn (end-of-line) (point-marker))))
322 (and (re-search-forward "[^<]*>" e t)
323 (= (match-beginning 0) this)))
326 (and (re-search-backward "<[^>]*" s t)
327 (= (match-end 0) this)))
330 (and (re-search-forward "[^&]*;" e t)
331 (= (match-beginning 0) this)))
334 (and (re-search-backward "&[^;]*" s t)
335 (= (match-end 0) this)))))))))
337 ;*---------------------------------------------------------------------*/
338 ;* Programming mode */
339 ;*---------------------------------------------------------------------*/
340 (defvar flyspell-prog-text-faces
341 '(font-lock-string-face font-lock-comment-face font-lock-doc-face)
342 "Faces corresponding to text in programming-mode buffers.")
344 (defun flyspell-generic-progmode-verify ()
345 "Used for `flyspell-generic-check-word-p' in programming modes."
346 (let ((f (get-text-property (point) 'face)))
347 (memq f flyspell-prog-text-faces)))
350 (defun flyspell-prog-mode ()
351 "Turn on `flyspell-mode' for comments and strings."
353 (setq flyspell-generic-check-word-p 'flyspell-generic-progmode-verify)
356 ;*---------------------------------------------------------------------*/
357 ;* Overlay compatibility */
358 ;*---------------------------------------------------------------------*/
359 (autoload 'make-overlay "overlay" "Overlay compatibility kit." t)
360 (autoload 'overlayp "overlay" "Overlay compatibility kit." t)
361 (autoload 'overlays-in "overlay" "Overlay compatibility kit." t)
362 (autoload 'delete-overlay "overlay" "Overlay compatibility kit." t)
363 (autoload 'overlays-at "overlay" "Overlay compatibility kit." t)
364 (autoload 'overlay-put "overlay" "Overlay compatibility kit." t)
365 (autoload 'overlay-get "overlay" "Overlay compatibility kit." t)
366 (autoload 'previous-overlay-change "overlay" "Overlay compatibility kit." t)
368 ;*---------------------------------------------------------------------*/
369 ;* Which emacs are we currently running */
370 ;*---------------------------------------------------------------------*/
371 (defvar flyspell-emacs
373 ((string-match "XEmacs" emacs-version)
377 "The type of Emacs we are currently running.")
379 (defvar flyspell-use-local-map
380 (or (eq flyspell-emacs 'xemacs)
381 (not (string< emacs-version "20"))))
383 ;*---------------------------------------------------------------------*/
384 ;* The minor mode declaration. */
385 ;*---------------------------------------------------------------------*/
386 (eval-when-compile (defvar flyspell-local-mouse-map))
389 (defvar flyspell-mode nil)
390 (make-variable-buffer-local 'flyspell-mode)
392 (defvar flyspell-mouse-map
393 (let ((map (make-sparse-keymap)))
395 ((eq flyspell-emacs 'xemacs)
396 (define-key map [(button2)] #'flyspell-correct-word)
397 (define-key map "\M-\t" #'flyspell-auto-correct-word))
398 (flyspell-use-local-map
399 (define-key map [(mouse-2)] #'flyspell-correct-word)
400 (define-key map "\M-\t" #'flyspell-auto-correct-word)))
404 (defvar flyspell-mode-map (make-sparse-keymap))
406 ;; mouse, keyboard bindings and misc definition
407 (when (or (assoc 'flyspell-mode minor-mode-map-alist)
408 (setq minor-mode-map-alist
409 (cons (cons 'flyspell-mode flyspell-mode-map)
410 minor-mode-map-alist)))
411 (define-key flyspell-mode-map "\M-\t" 'flyspell-auto-correct-word))
413 ;; the name of the overlay property that defines the keymap
414 (defvar flyspell-overlay-keymap-property-name 'keymap)
416 ;; dash character machinery
417 (defvar flyspell-consider-dash-as-word-delimiter-flag nil
418 "*Non-nil means that the `-' char is considered as a word delimiter.")
419 (make-variable-buffer-local 'flyspell-consider-dash-as-word-delimiter-flag)
420 (defvar flyspell-dash-dictionary nil)
421 (make-variable-buffer-local 'flyspell-dash-dictionary)
422 (defvar flyspell-dash-local-dictionary nil)
423 (make-variable-buffer-local 'flyspell-dash-local-dictionary)
425 ;*---------------------------------------------------------------------*/
427 ;*---------------------------------------------------------------------*/
428 (defface flyspell-incorrect-face
429 (if (eq flyspell-emacs 'xemacs)
430 '((((class color)) (:foreground "OrangeRed" :bold t :underline t))
432 '((((class color)) (:foreground "OrangeRed" :weight bold :underline t))
434 "Face used for marking a misspelled word in Flyspell."
437 (defface flyspell-duplicate-face
438 (if (eq flyspell-emacs 'xemacs)
439 '((((class color)) (:foreground "Gold3" :bold t :underline t))
441 '((((class color)) (:foreground "Gold3" :weight bold :underline t))
443 "Face used for marking a misspelled word that appears twice in the buffer.
444 See also `flyspell-duplicate-distance'."
447 (defvar flyspell-overlay nil)
449 ;*---------------------------------------------------------------------*/
450 ;* flyspell-mode ... */
451 ;*---------------------------------------------------------------------*/
453 (defun flyspell-mode (&optional arg)
454 "Minor mode performing on-the-fly spelling checking.
455 This spawns a single Ispell process and checks each word.
456 The default flyspell behavior is to highlight incorrect words.
457 With no argument, this command toggles Flyspell mode.
458 With a prefix argument ARG, turn Flyspell minor mode on iff ARG is positive.
461 \\[ispell-word]: correct words (using Ispell).
462 \\[flyspell-auto-correct-word]: automatically correct word.
463 \\[flyspell-correct-word] (or mouse-2): popup correct words.
466 This runs `flyspell-mode-hook' after flyspell is entered.
469 `flyspell-mode' uses `ispell-mode'. Thus all Ispell options are
470 valid. For instance, a personal dictionary can be used by
471 invoking `ispell-change-dictionary'.
473 Consider using the `ispell-parser' to check your text. For instance
475 \(add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))
478 \\[flyspell-region] checks all words inside a region.
479 \\[flyspell-buffer] checks the whole buffer."
481 (let ((old-flyspell-mode flyspell-mode))
482 ;; Mark the mode as on or off.
483 (setq flyspell-mode (not (or (and (null arg) flyspell-mode)
484 (<= (prefix-numeric-value arg) 0))))
486 (unless (eq flyspell-mode old-flyspell-mode)
490 ;; Force modeline redisplay.
491 (set-buffer-modified-p (buffer-modified-p)))))
493 ;*---------------------------------------------------------------------*/
495 ;*---------------------------------------------------------------------*/
497 (add-minor-mode 'flyspell-mode
498 'flyspell-mode-line-string
503 ;*---------------------------------------------------------------------*/
504 ;* flyspell-buffers ... */
505 ;* ------------------------------------------------------------- */
506 ;* For remembering buffers running flyspell */
507 ;*---------------------------------------------------------------------*/
508 (defvar flyspell-buffers nil)
510 ;*---------------------------------------------------------------------*/
511 ;* flyspell-minibuffer-p ... */
512 ;*---------------------------------------------------------------------*/
513 (defun flyspell-minibuffer-p (buffer)
514 "Is BUFFER a minibuffer?"
515 (let ((ws (get-buffer-window-list buffer t)))
516 (and (consp ws) (window-minibuffer-p (car ws)))))
518 ;*---------------------------------------------------------------------*/
519 ;* flyspell-version ... */
520 ;*---------------------------------------------------------------------*/
522 (defun flyspell-version ()
523 "The flyspell version"
527 ;*---------------------------------------------------------------------*/
528 ;* flyspell-accept-buffer-local-defs ... */
529 ;*---------------------------------------------------------------------*/
530 (defun flyspell-accept-buffer-local-defs ()
531 (ispell-accept-buffer-local-defs)
532 (if (not (and (eq flyspell-dash-dictionary ispell-dictionary)
533 (eq flyspell-dash-local-dictionary ispell-local-dictionary)))
534 ;; the dictionary has changed
536 (setq flyspell-dash-dictionary ispell-dictionary)
537 (setq flyspell-dash-local-dictionary ispell-local-dictionary)
538 (if (member (or ispell-local-dictionary ispell-dictionary)
539 flyspell-dictionaries-that-consider-dash-as-word-delimiter)
540 (setq flyspell-consider-dash-as-word-delimiter-flag t)
541 (setq flyspell-consider-dash-as-word-delimiter-flag nil)))))
543 ;*---------------------------------------------------------------------*/
544 ;* flyspell-mode-on ... */
545 ;*---------------------------------------------------------------------*/
546 (defun flyspell-mode-on ()
547 "Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead."
548 (setq ispell-highlight-face 'flyspell-incorrect-face)
549 ;; local dictionaries setup
550 (ispell-change-dictionary
551 (or ispell-local-dictionary ispell-dictionary flyspell-default-dictionary))
552 ;; we have to force ispell to accept the local definition or
553 ;; otherwise it could be too late, the local dictionary may
555 (flyspell-accept-buffer-local-defs)
556 ;; we put the `flyspell-delayed' property on some commands
557 (flyspell-delay-commands)
558 ;; we put the `flyspell-deplacement' property on some commands
559 (flyspell-deplacement-commands)
560 ;; we bound flyspell action to post-command hook
561 (add-hook 'post-command-hook (function flyspell-post-command-hook) t t)
562 ;; we bound flyspell action to pre-command hook
563 (add-hook 'pre-command-hook (function flyspell-pre-command-hook) t t)
564 ;; we bound flyspell action to after-change hook
565 (make-local-variable 'after-change-functions)
566 (setq after-change-functions
567 (cons 'flyspell-after-change-function after-change-functions))
568 ;; set flyspell-generic-check-word-p based on the major mode
569 (let ((mode-predicate (get major-mode 'flyspell-mode-predicate)))
571 (setq flyspell-generic-check-word-p mode-predicate)))
572 ;; the welcome message
573 (if (and flyspell-issue-message-flag
574 flyspell-issue-welcome-flag
576 (let ((binding (where-is-internal 'flyspell-auto-correct-word
580 (format "Welcome to flyspell. Use %s or Mouse-2 to correct words."
581 (key-description binding))
582 "Welcome to flyspell. Use Mouse-2 to correct words."))))
583 ;; we end with the flyspell hooks
584 (run-hooks 'flyspell-mode-hook))
586 ;*---------------------------------------------------------------------*/
587 ;* flyspell-delay-commands ... */
588 ;*---------------------------------------------------------------------*/
589 (defun flyspell-delay-commands ()
590 "Install the standard set of Flyspell delayed commands."
591 (mapcar 'flyspell-delay-command flyspell-default-delayed-commands)
592 (mapcar 'flyspell-delay-command flyspell-delayed-commands))
594 ;*---------------------------------------------------------------------*/
595 ;* flyspell-delay-command ... */
596 ;*---------------------------------------------------------------------*/
597 (defun flyspell-delay-command (command)
598 "Set COMMAND to be delayed, for Flyspell.
599 When flyspell `post-command-hook' is invoked because a delayed command
600 as been used the current word is not immediately checked.
601 It will be checked only after `flyspell-delay' seconds."
602 (interactive "SDelay Flyspell after Command: ")
603 (put command 'flyspell-delayed t))
605 ;*---------------------------------------------------------------------*/
606 ;* flyspell-deplacement-commands ... */
607 ;*---------------------------------------------------------------------*/
608 (defun flyspell-deplacement-commands ()
609 "Install the standard set of Flyspell deplacement commands."
610 (mapcar 'flyspell-deplacement-command flyspell-default-deplacement-commands)
611 (mapcar 'flyspell-deplacement-command flyspell-deplacement-commands))
613 ;*---------------------------------------------------------------------*/
614 ;* flyspell-deplacement-command ... */
615 ;*---------------------------------------------------------------------*/
616 (defun flyspell-deplacement-command (command)
617 "Set COMMAND that implement cursor movements, for Flyspell.
618 When flyspell `post-command-hook' is invoked because of a deplacement command
619 as been used the current word is checked only if the previous command was
620 not the very same deplacement command."
621 (interactive "SDeplacement Flyspell after Command: ")
622 (put command 'flyspell-deplacement t))
624 ;*---------------------------------------------------------------------*/
625 ;* flyspell-word-cache ... */
626 ;*---------------------------------------------------------------------*/
627 (defvar flyspell-word-cache-start nil)
628 (defvar flyspell-word-cache-end nil)
629 (defvar flyspell-word-cache-word nil)
630 (make-variable-buffer-local 'flyspell-word-cache-start)
631 (make-variable-buffer-local 'flyspell-word-cache-end)
632 (make-variable-buffer-local 'flyspell-word-cache-word)
634 ;*---------------------------------------------------------------------*/
635 ;* The flyspell pre-hook, store the current position. In the */
636 ;* post command hook, we will check, if the word at this position */
637 ;* has to be spell checked. */
638 ;*---------------------------------------------------------------------*/
639 (defvar flyspell-pre-buffer nil)
640 (defvar flyspell-pre-point nil)
641 (defvar flyspell-pre-column nil)
642 (defvar flyspell-pre-pre-buffer nil)
643 (defvar flyspell-pre-pre-point nil)
645 ;*---------------------------------------------------------------------*/
646 ;* flyspell-previous-command ... */
647 ;*---------------------------------------------------------------------*/
648 (defvar flyspell-previous-command nil
649 "The last interactive command checked by Flyspell.")
651 ;*---------------------------------------------------------------------*/
652 ;* flyspell-pre-command-hook ... */
653 ;*---------------------------------------------------------------------*/
654 (defun flyspell-pre-command-hook ()
655 "Save the current buffer and point for Flyspell's post-command hook."
657 (setq flyspell-pre-buffer (current-buffer))
658 (setq flyspell-pre-point (point))
659 (setq flyspell-pre-column (current-column)))
661 ;*---------------------------------------------------------------------*/
662 ;* flyspell-mode-off ... */
663 ;*---------------------------------------------------------------------*/
665 (defun flyspell-mode-off ()
666 "Turn Flyspell mode off."
667 ;; we remove the hooks
668 (remove-hook 'post-command-hook (function flyspell-post-command-hook) t)
669 (remove-hook 'pre-command-hook (function flyspell-pre-command-hook) t)
670 (setq after-change-functions (delq 'flyspell-after-change-function
671 after-change-functions))
672 ;; we remove all the flyspell hilightings
673 (flyspell-delete-all-overlays)
674 ;; we have to erase pre cache variables
675 (setq flyspell-pre-buffer nil)
676 (setq flyspell-pre-point nil)
677 ;; we mark the mode as killed
678 (setq flyspell-mode nil))
680 ;*---------------------------------------------------------------------*/
681 ;* flyspell-check-pre-word-p ... */
682 ;*---------------------------------------------------------------------*/
683 (defun flyspell-check-pre-word-p ()
684 "Return non-nil if we should to check the word before point.
685 More precisely, it applies to the word that was before point
686 before the current command."
688 ((or (not (numberp flyspell-pre-point))
689 (not (bufferp flyspell-pre-buffer))
690 (not (buffer-live-p flyspell-pre-buffer)))
692 ((and (eq flyspell-pre-pre-point flyspell-pre-point)
693 (eq flyspell-pre-pre-buffer flyspell-pre-buffer))
695 ((or (and (= flyspell-pre-point (- (point) 1))
696 (eq (char-syntax (char-after flyspell-pre-point)) ?w))
697 (= flyspell-pre-point (point))
698 (= flyspell-pre-point (+ (point) 1)))
700 ((and (symbolp this-command)
701 (not executing-kbd-macro)
702 (or (get this-command 'flyspell-delayed)
703 (and (get this-command 'flyspell-deplacement)
704 (eq flyspell-previous-command this-command)))
705 (or (= (current-column) 0)
706 (= (current-column) flyspell-pre-column)
707 (eq (char-syntax (char-after flyspell-pre-point)) ?w)))
709 ((not (eq (current-buffer) flyspell-pre-buffer))
711 ((not (and (numberp flyspell-word-cache-start)
712 (numberp flyspell-word-cache-end)))
715 (or (< flyspell-pre-point flyspell-word-cache-start)
716 (> flyspell-pre-point flyspell-word-cache-end)))))
718 ;*---------------------------------------------------------------------*/
719 ;* The flyspell after-change-hook, store the change position. In */
720 ;* the post command hook, we will check, if the word at this */
721 ;* position has to be spell checked. */
722 ;*---------------------------------------------------------------------*/
723 (defvar flyspell-changes nil)
725 ;*---------------------------------------------------------------------*/
726 ;* flyspell-after-change-function ... */
727 ;*---------------------------------------------------------------------*/
728 (defun flyspell-after-change-function (start stop len)
729 "Save the current buffer and point for Flyspell's post-command hook."
731 (setq flyspell-changes (cons (cons start stop) flyspell-changes)))
733 ;*---------------------------------------------------------------------*/
734 ;* flyspell-check-changed-word-p ... */
735 ;*---------------------------------------------------------------------*/
736 (defun flyspell-check-changed-word-p (start stop)
737 "Return t when the changed word has to be checked.
738 The answer depends of several criteria.
739 Mostly we check word delimiters."
741 ((and (eq (char-after start) ?\n) (> stop start))
743 ((not (numberp flyspell-pre-point))
745 ((and (>= flyspell-pre-point start) (<= flyspell-pre-point stop))
747 ((let ((pos (point)))
748 (or (>= pos start) (<= pos stop) (= pos (1+ stop))))
753 ;*---------------------------------------------------------------------*/
754 ;* flyspell-check-word-p ... */
755 ;*---------------------------------------------------------------------*/
756 (defun flyspell-check-word-p ()
757 "Return t when the word at `point' has to be checked.
758 The answer depends of several criteria.
759 Mostly we check word delimiters."
761 ((<= (- (point-max) 1) (point-min))
762 ;; the buffer is not filled enough
764 ((and (and (> (current-column) 0)
765 (not (eq (current-column) flyspell-pre-column)))
768 (and (looking-at (flyspell-get-not-casechars))
769 (or flyspell-consider-dash-as-word-delimiter-flag
770 (not (looking-at "\\-"))))))
771 ;; yes because we have reached or typed a word delimiter.
773 ((symbolp this-command)
775 ((get this-command 'flyspell-deplacement)
776 (not (eq flyspell-previous-command this-command)))
777 ((get this-command 'flyspell-delayed)
778 ;; the current command is not delayed, that
779 ;; is that we must check the word now
780 (if (fboundp 'about-xemacs)
781 (sit-for flyspell-delay nil)
782 (sit-for flyspell-delay 0 nil)))
786 ;*---------------------------------------------------------------------*/
787 ;* flyspell-debug-signal-no-check ... */
788 ;*---------------------------------------------------------------------*/
789 (defun flyspell-debug-signal-no-check (msg obj)
790 (setq debug-on-error t)
792 (let ((buffer (get-buffer-create "*flyspell-debug*")))
795 (insert "NO-CHECK:\n")
796 (insert (format " %S : %S\n" msg obj)))))
798 ;*---------------------------------------------------------------------*/
799 ;* flyspell-debug-signal-pre-word-checked ... */
800 ;*---------------------------------------------------------------------*/
801 (defun flyspell-debug-signal-pre-word-checked ()
802 (setq debug-on-error t)
804 (let ((buffer (get-buffer-create "*flyspell-debug*")))
806 (insert "PRE-WORD:\n")
807 (insert (format " pre-point : %S\n" flyspell-pre-point))
808 (insert (format " pre-buffer : %S\n" flyspell-pre-buffer))
809 (insert (format " cache-start: %S\n" flyspell-word-cache-start))
810 (insert (format " cache-end : %S\n" flyspell-word-cache-end))
811 (goto-char (point-max)))))
813 ;*---------------------------------------------------------------------*/
814 ;* flyspell-debug-signal-word-checked ... */
815 ;*---------------------------------------------------------------------*/
816 (defun flyspell-debug-signal-word-checked ()
817 (setq debug-on-error t)
819 (let ((oldbuf (current-buffer))
820 (buffer (get-buffer-create "*flyspell-debug*"))
824 (insert (format " this-cmd : %S\n" this-command))
825 (insert (format " delayed : %S\n" (and (symbolp this-command)
826 (get this-command 'flyspell-delayed))))
827 (insert (format " point : %S\n" point))
828 (insert (format " prev-char : [%c] %S\n"
831 (let ((c (if (> (point) (point-min))
834 (char-after (point)))
840 (let ((c (if (> (point) (point-min))
843 (and (and (looking-at (flyspell-get-not-casechars)) 1)
844 (and (or flyspell-consider-dash-as-word-delimiter-flag
845 (not (looking-at "\\-"))) 2))))))
848 (insert (format " because : %S\n"
850 ((not (and (symbolp this-command)
851 (get this-command 'flyspell-delayed)))
852 ;; the current command is not delayed, that
853 ;; is that we must check the word now
857 (let ((c (if (> (point) (point-min))
860 (and (looking-at (flyspell-get-not-casechars))
861 (or flyspell-consider-dash-as-word-delimiter-flag
862 (not (looking-at "\\-"))))))))
865 ;; yes because we have reached or typed a word delimiter.
867 ((not (integerp flyspell-delay))
868 ;; yes because the user had set up a no-delay configuration.
872 (goto-char (point-max)))))
874 ;*---------------------------------------------------------------------*/
875 ;* flyspell-debug-signal-changed-checked ... */
876 ;*---------------------------------------------------------------------*/
877 (defun flyspell-debug-signal-changed-checked ()
878 (setq debug-on-error t)
880 (let ((buffer (get-buffer-create "*flyspell-debug*"))
883 (insert "CHANGED WORD:\n")
884 (insert (format " point : %S\n" point))
885 (goto-char (point-max)))))
887 ;*---------------------------------------------------------------------*/
888 ;* flyspell-post-command-hook ... */
889 ;* ------------------------------------------------------------- */
890 ;* It is possible that we check several words: */
891 ;* 1- the current word is checked if the predicate */
892 ;* FLYSPELL-CHECK-WORD-P is true */
893 ;* 2- the word that used to be the current word before the */
894 ;* THIS-COMMAND is checked if: */
895 ;* a- the previous word is different from the current word */
896 ;* b- the previous word as not just been checked by the */
897 ;* previous FLYSPELL-POST-COMMAND-HOOK */
898 ;* 3- the words changed by the THIS-COMMAND that are neither the */
899 ;* previous word nor the current word */
900 ;*---------------------------------------------------------------------*/
901 (defun flyspell-post-command-hook ()
902 "The `post-command-hook' used by flyspell to check a word in-the-fly."
904 (let ((command this-command))
905 (if (flyspell-check-pre-word-p)
907 '(flyspell-debug-signal-pre-word-checked)
908 (set-buffer flyspell-pre-buffer)
910 (goto-char flyspell-pre-point)
912 (if (flyspell-check-word-p)
914 '(flyspell-debug-signal-word-checked)
916 ;; we remember which word we have just checked.
917 ;; this will be used next time we will check a word
918 ;; to compare the next current word with the word
919 ;; that as been registered in the pre-command-hook
920 ;; that is these variables are used within the predicate
921 ;; FLYSPELL-CHECK-PRE-WORD-P
922 (setq flyspell-pre-pre-buffer (current-buffer))
923 (setq flyspell-pre-pre-point (point)))
925 (setq flyspell-pre-pre-buffer nil)
926 (setq flyspell-pre-pre-point nil)
927 ;; when a word is not checked because of a delayed command
928 ;; we do not disable the ispell cache.
929 (if (and (symbolp this-command) (get this-command 'flyspell-delayed))
930 (setq flyspell-word-cache-end -1))))
931 (while (consp flyspell-changes)
932 (let ((start (car (car flyspell-changes)))
933 (stop (cdr (car flyspell-changes))))
934 (if (flyspell-check-changed-word-p start stop)
936 '(flyspell-debug-signal-changed-checked)
939 (setq flyspell-changes (cdr flyspell-changes))))
940 (setq flyspell-previous-command command)))
942 ;*---------------------------------------------------------------------*/
943 ;* flyspell-notify-misspell ... */
944 ;*---------------------------------------------------------------------*/
945 (defun flyspell-notify-misspell (start end word poss)
946 (let ((replacements (if (stringp poss)
948 (if flyspell-sort-corrections
949 (sort (car (cdr (cdr poss))) 'string<)
950 (car (cdr (cdr poss)))))))
951 (if flyspell-issue-message-flag
952 (message (format "mispelling `%s' %S" word replacements)))))
954 ;*---------------------------------------------------------------------*/
955 ;* flyspell-word ... */
956 ;*---------------------------------------------------------------------*/
957 (defun flyspell-word (&optional following)
958 "Spell check a word."
959 (interactive (list ispell-following-word))
961 ;; use the correct dictionary
962 (flyspell-accept-buffer-local-defs)
963 (let* ((cursor-location (point))
964 (flyspell-word (flyspell-get-word following))
966 (if (or (eq flyspell-word nil)
967 (and (fboundp flyspell-generic-check-word-p)
968 (not (funcall flyspell-generic-check-word-p))))
971 ;; destructure return flyspell-word info list.
972 (setq start (car (cdr flyspell-word))
973 end (car (cdr (cdr flyspell-word)))
974 word (car flyspell-word))
975 ;; before checking in the directory, we check for doublons.
977 ((and (or (not (eq ispell-parser 'tex))
978 (not (eq (char-after start) ?\\)))
979 flyspell-mark-duplications-flag
982 (word-search-backward word
986 ;; yes, this is a doublon
987 (flyspell-highlight-incorrect-region start end 'doublon))
988 ((and (eq flyspell-word-cache-start start)
989 (eq flyspell-word-cache-end end)
990 (string-equal flyspell-word-cache-word word))
991 ;; this word had been already checked, we skip
993 ((and (eq ispell-parser 'tex)
994 (flyspell-tex-command-p flyspell-word))
995 ;; this is a correct word (because a tex command)
996 (flyspell-unhighlight-at start)
998 (flyspell-unhighlight-at (- end 1)))
1001 ;; we setup the cache
1002 (setq flyspell-word-cache-start start)
1003 (setq flyspell-word-cache-end end)
1004 (setq flyspell-word-cache-word word)
1005 ;; now check spelling of word.
1006 (process-send-string ispell-process "%\n")
1007 ;; put in verbose mode
1008 (process-send-string ispell-process
1009 (concat "^" word "\n"))
1010 ;; we mark the ispell process so it can be killed
1011 ;; when emacs is exited without query
1012 (set-process-query-on-exit-flag ispell-process nil)
1013 ;; wait until ispell has processed word
1015 (accept-process-output ispell-process)
1016 (not (string= "" (car ispell-filter)))))
1017 ;; (process-send-string ispell-process "!\n")
1018 ;; back to terse mode.
1019 (setq ispell-filter (cdr ispell-filter))
1020 (if (consp ispell-filter)
1021 (setq poss (ispell-parse-output (car ispell-filter))))
1024 (flyspell-unhighlight-at start)
1026 (flyspell-unhighlight-at (- end 1)))
1028 ((and (stringp poss) flyspell-highlight-flag)
1030 (flyspell-unhighlight-at start)
1032 (flyspell-unhighlight-at (- end 1)))
1035 (flyspell-unhighlight-at start)
1037 (flyspell-unhighlight-at (- end 1))))
1038 ((or (and (< flyspell-duplicate-distance 0)
1041 (word-search-backward word
1046 (word-search-forward word
1049 (and (> flyspell-duplicate-distance 0)
1052 (word-search-backward
1055 flyspell-duplicate-distance)
1059 (word-search-forward
1062 flyspell-duplicate-distance)
1064 (if flyspell-highlight-flag
1065 (flyspell-highlight-duplicate-region start end poss)
1066 (message (format "duplicate `%s'" word))))
1068 ;; incorrect highlight the location
1069 (if flyspell-highlight-flag
1070 (flyspell-highlight-incorrect-region start end poss)
1071 (flyspell-notify-misspell start end word poss))))
1072 ;; return to original location
1073 (goto-char cursor-location)
1074 (if ispell-quit (setq ispell-quit nil)))))))))
1076 ;*---------------------------------------------------------------------*/
1077 ;* flyspell-tex-math-initialized ... */
1078 ;*---------------------------------------------------------------------*/
1079 (defvar flyspell-tex-math-initialized nil)
1081 ;*---------------------------------------------------------------------*/
1082 ;* flyspell-math-tex-command-p ... */
1083 ;* ------------------------------------------------------------- */
1084 ;* This function uses the texmathp package to check if (point) */
1085 ;* is within a tex command. In order to avoid using */
1086 ;* condition-case each time we use the variable */
1087 ;* flyspell-tex-math-initialized to make a special case the first */
1088 ;* time that function is called. */
1089 ;*---------------------------------------------------------------------*/
1090 (defun flyspell-math-tex-command-p ()
1092 (flyspell-check-tex-math-command
1094 ((eq flyspell-tex-math-initialized t)
1096 ((eq flyspell-tex-math-initialized 'error)
1099 (setq flyspell-tex-math-initialized t)
1103 (setq flyspell-tex-math-initialized 'error)
1106 ;*---------------------------------------------------------------------*/
1107 ;* flyspell-tex-command-p ... */
1108 ;*---------------------------------------------------------------------*/
1109 (defun flyspell-tex-command-p (word)
1110 "Return t if WORD is a TeX command."
1112 (let ((b (car (cdr word))))
1113 (and (re-search-backward "\\\\" (- (point) 100) t)
1114 (or (= (match-end 0) b)
1115 (and (goto-char (match-end 0))
1116 (looking-at flyspell-tex-command-regexp)
1117 (>= (match-end 0) b))))))
1118 (flyspell-math-tex-command-p)))
1120 ;*---------------------------------------------------------------------*/
1121 ;* flyspell-casechars-cache ... */
1122 ;*---------------------------------------------------------------------*/
1123 (defvar flyspell-casechars-cache nil)
1124 (defvar flyspell-ispell-casechars-cache nil)
1125 (make-variable-buffer-local 'flyspell-casechars-cache)
1126 (make-variable-buffer-local 'flyspell-ispell-casechars-cache)
1128 ;*---------------------------------------------------------------------*/
1129 ;* flyspell-get-casechars ... */
1130 ;*---------------------------------------------------------------------*/
1131 (defun flyspell-get-casechars ()
1132 "This function builds a string that is the regexp of word chars.
1133 In order to avoid one useless string construction,
1134 this function changes the last char of the `ispell-casechars' string."
1135 (let ((ispell-casechars (ispell-get-casechars)))
1137 ((eq ispell-parser 'tex)
1138 (setq flyspell-ispell-casechars-cache ispell-casechars)
1139 (setq flyspell-casechars-cache
1140 (concat (substring ispell-casechars
1142 (- (length ispell-casechars) 1))
1144 flyspell-casechars-cache)
1146 (setq flyspell-ispell-casechars-cache ispell-casechars)
1147 (setq flyspell-casechars-cache ispell-casechars)
1148 flyspell-casechars-cache))))
1150 ;*---------------------------------------------------------------------*/
1151 ;* flyspell-get-not-casechars-cache ... */
1152 ;*---------------------------------------------------------------------*/
1153 (defvar flyspell-not-casechars-cache nil)
1154 (defvar flyspell-ispell-not-casechars-cache nil)
1155 (make-variable-buffer-local 'flyspell-not-casechars-cache)
1156 (make-variable-buffer-local 'flyspell-ispell-not-casechars-cache)
1158 ;*---------------------------------------------------------------------*/
1159 ;* flyspell-get-not-casechars ... */
1160 ;*---------------------------------------------------------------------*/
1161 (defun flyspell-get-not-casechars ()
1162 "This function builds a string that is the regexp of non-word chars."
1163 (let ((ispell-not-casechars (ispell-get-not-casechars)))
1165 ((eq ispell-parser 'tex)
1166 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
1167 (setq flyspell-not-casechars-cache
1168 (concat (substring ispell-not-casechars
1170 (- (length ispell-not-casechars) 1))
1172 flyspell-not-casechars-cache)
1174 (setq flyspell-ispell-not-casechars-cache ispell-not-casechars)
1175 (setq flyspell-not-casechars-cache ispell-not-casechars)
1176 flyspell-not-casechars-cache))))
1178 ;*---------------------------------------------------------------------*/
1179 ;* flyspell-get-word ... */
1180 ;*---------------------------------------------------------------------*/
1181 (defun flyspell-get-word (following)
1182 "Return the word for spell-checking according to Ispell syntax.
1183 If argument FOLLOWING is non-nil or if `ispell-following-word'
1184 is non-nil when called interactively, then the following word
1185 \(rather than preceding\) is checked when the cursor is not over a word.
1186 Optional second argument contains other chars that can be included in word
1189 Word syntax described by `ispell-dictionary-alist' (which see)."
1190 (let* ((flyspell-casechars (flyspell-get-casechars))
1191 (flyspell-not-casechars (flyspell-get-not-casechars))
1192 (ispell-otherchars (ispell-get-otherchars))
1193 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1194 (word-regexp (if (string< "" ispell-otherchars)
1195 (concat flyspell-casechars
1201 (if ispell-many-otherchars-p
1203 (concat flyspell-casechars "+")))
1207 (if (not (looking-at flyspell-casechars))
1209 (re-search-forward flyspell-casechars (point-max) t)
1210 (re-search-backward flyspell-casechars (point-min) t)))
1211 ;; move to front of word
1212 (re-search-backward flyspell-not-casechars (point-min) 'start)
1214 (if (string< "" ispell-otherchars)
1215 (while (and (looking-at ispell-otherchars)
1217 (or (not did-it-once)
1218 ispell-many-otherchars-p)
1219 (not (eq pos (point))))
1221 (setq did-it-once t)
1223 (if (looking-at flyspell-casechars)
1224 (re-search-backward flyspell-not-casechars (point-min) 'move)
1225 (backward-char -1)))))
1226 ;; Now mark the word and save to string.
1227 (if (eq (re-search-forward word-regexp (point-max) t) nil)
1230 (setq start (match-beginning 0)
1232 word (buffer-substring-no-properties start end))
1233 (list word start end)))))
1235 ;*---------------------------------------------------------------------*/
1236 ;* flyspell-small-region ... */
1237 ;*---------------------------------------------------------------------*/
1238 (defun flyspell-small-region (beg end)
1239 "Flyspell text between BEG and END."
1247 (while (< (point) end)
1248 (if (and flyspell-issue-message-flag (= count 100))
1250 (message "Spell Checking...%d%%"
1251 (* 100 (/ (float (- (point) beg)) (- end beg))))
1253 (setq count (+ 1 count)))
1256 (let ((cur (point)))
1258 (if (and (< (point) end) (> (point) (+ cur 1)))
1259 (backward-char 1)))))
1261 (if flyspell-issue-message-flag (message "Spell Checking completed."))
1264 ;*---------------------------------------------------------------------*/
1265 ;* flyspell-external-ispell-process ... */
1266 ;*---------------------------------------------------------------------*/
1267 (defvar flyspell-external-ispell-process '()
1268 "The external Flyspell Ispell process.")
1270 ;*---------------------------------------------------------------------*/
1271 ;* flyspell-external-ispell-buffer ... */
1272 ;*---------------------------------------------------------------------*/
1273 (defvar flyspell-external-ispell-buffer '())
1274 (defvar flyspell-large-region-buffer '())
1275 (defvar flyspell-large-region-beg (point-min))
1276 (defvar flyspell-large-region-end (point-max))
1278 ;*---------------------------------------------------------------------*/
1279 ;* flyspell-external-point-words ... */
1280 ;*---------------------------------------------------------------------*/
1281 (defun flyspell-external-point-words ()
1282 (let ((buffer flyspell-external-ispell-buffer))
1284 (goto-char (point-min))
1285 (let ((size (- flyspell-large-region-end flyspell-large-region-beg))
1286 (start flyspell-large-region-beg))
1287 ;; now we are done with ispell, we have to find the word in
1288 ;; the initial buffer
1289 (while (< (point) (- (point-max) 1))
1290 ;; we have to fetch the incorrect word
1291 (if (re-search-forward "\\([^\n]+\\)\n" (point-max) t)
1292 (let ((word (match-string 1)))
1293 (goto-char (match-end 0))
1294 (set-buffer flyspell-large-region-buffer)
1295 (goto-char flyspell-large-region-beg)
1296 (if flyspell-issue-message-flag
1297 (message "Spell Checking...%d%% [%s]"
1298 (* 100 (/ (float (- (point) start)) size))
1300 (if (search-forward word flyspell-large-region-end t)
1302 (setq flyspell-large-region-beg (point))
1303 (goto-char (- (point) 1))
1305 (set-buffer buffer))
1306 (goto-char (point-max)))))
1308 (if flyspell-issue-message-flag (message "Spell Checking completed."))
1309 ;; ok, we are done with pointing out incorrect words, we just
1310 ;; have to kill the temporary buffer
1311 (kill-buffer flyspell-external-ispell-buffer)
1312 (setq flyspell-external-ispell-buffer nil)))
1314 ;*---------------------------------------------------------------------*/
1315 ;* flyspell-large-region ... */
1316 ;*---------------------------------------------------------------------*/
1317 (defun flyspell-large-region (beg end)
1318 (let* ((curbuf (current-buffer))
1319 (buffer (get-buffer-create "*flyspell-region*")))
1320 (setq flyspell-external-ispell-buffer buffer)
1321 (setq flyspell-large-region-buffer curbuf)
1322 (setq flyspell-large-region-beg beg)
1323 (setq flyspell-large-region-end end)
1326 ;; this is done, we can start checking...
1327 (if flyspell-issue-message-flag (message "Checking region..."))
1329 (let ((c (apply 'call-process-region beg
1337 ;; Local dictionary becomes the global dictionary in use.
1338 (if ispell-local-dictionary
1339 (setq ispell-dictionary ispell-local-dictionary))
1340 (setq args (ispell-get-ispell-args))
1341 (if ispell-dictionary ; use specified dictionary
1343 (append (list "-d" ispell-dictionary) args)))
1344 (if ispell-personal-dictionary ; use specified pers dict
1349 ispell-personal-dictionary)))))
1350 (setq args (append args ispell-extra-args))
1353 (flyspell-external-point-words)
1354 (error "Can't check region...")))))
1356 ;*---------------------------------------------------------------------*/
1357 ;* flyspell-region ... */
1358 ;* ------------------------------------------------------------- */
1359 ;* Because `ispell -a' is too slow, it is not possible to use */
1360 ;* it on large region. Then, when ispell is invoked on a large */
1361 ;* text region, a new `ispell -l' process is spawned. The */
1362 ;* pointed out words are then searched in the region a checked with */
1363 ;* regular flyspell means. */
1364 ;*---------------------------------------------------------------------*/
1366 (defun flyspell-region (beg end)
1367 "Flyspell text between BEG and END."
1376 (if (> (- end beg) flyspell-large-region)
1377 (flyspell-large-region beg end)
1378 (flyspell-small-region beg end)))))
1380 ;*---------------------------------------------------------------------*/
1381 ;* flyspell-buffer ... */
1382 ;*---------------------------------------------------------------------*/
1384 (defun flyspell-buffer ()
1385 "Flyspell whole buffer."
1387 (flyspell-region (point-min) (point-max)))
1389 ;*---------------------------------------------------------------------*/
1390 ;* old next error position ... */
1391 ;*---------------------------------------------------------------------*/
1392 (defvar flyspell-old-buffer-error nil)
1393 (defvar flyspell-old-pos-error nil)
1395 ;*---------------------------------------------------------------------*/
1396 ;* flyspell-goto-next-error ... */
1397 ;*---------------------------------------------------------------------*/
1398 (defun flyspell-goto-next-error ()
1399 "Go to the next previously detected error.
1400 In general FLYSPELL-GOTO-NEXT-ERROR must be used after
1405 (if (and (eq (current-buffer) flyspell-old-buffer-error)
1406 (eq pos flyspell-old-pos-error))
1408 (if (= flyspell-old-pos-error max)
1409 ;; goto beginning of buffer
1411 (message "Restarting from beginning of buffer")
1412 (goto-char (point-min)))
1414 (setq pos (point))))
1415 ;; seek the next error
1416 (while (and (< pos max)
1417 (let ((ovs (overlays-at pos))
1419 (while (and (not r) (consp ovs))
1420 (if (flyspell-overlay-p (car ovs))
1422 (setq ovs (cdr ovs))))
1424 (setq pos (1+ pos)))
1425 ;; save the current location for next invocation
1426 (setq flyspell-old-pos-error pos)
1427 (setq flyspell-old-buffer-error (current-buffer))
1430 (message "No more miss-spelled word!"))))
1432 ;*---------------------------------------------------------------------*/
1433 ;* flyspell-overlay-p ... */
1434 ;*---------------------------------------------------------------------*/
1435 (defun flyspell-overlay-p (o)
1436 "A predicate that return true iff O is an overlay used by flyspell."
1437 (and (overlayp o) (overlay-get o 'flyspell-overlay)))
1439 ;*---------------------------------------------------------------------*/
1440 ;* flyspell-delete-all-overlays ... */
1441 ;* ------------------------------------------------------------- */
1442 ;* Remove all the overlays introduced by flyspell. */
1443 ;*---------------------------------------------------------------------*/
1444 (defun flyspell-delete-all-overlays ()
1445 "Delete all the overlays used by flyspell."
1446 (let ((l (overlays-in (point-min) (point-max))))
1449 (if (flyspell-overlay-p (car l))
1450 (delete-overlay (car l)))
1451 (setq l (cdr l))))))
1453 ;*---------------------------------------------------------------------*/
1454 ;* flyspell-unhighlight-at ... */
1455 ;*---------------------------------------------------------------------*/
1456 (defun flyspell-unhighlight-at (pos)
1457 "Remove the flyspell overlay that are located at POS."
1458 (if flyspell-persistent-highlight
1459 (let ((overlays (overlays-at pos)))
1460 (while (consp overlays)
1461 (if (flyspell-overlay-p (car overlays))
1462 (delete-overlay (car overlays)))
1463 (setq overlays (cdr overlays))))
1464 (if (flyspell-overlay-p flyspell-overlay)
1465 (delete-overlay flyspell-overlay))))
1467 ;*---------------------------------------------------------------------*/
1468 ;* flyspell-properties-at-p ... */
1469 ;* ------------------------------------------------------------- */
1470 ;* Is there an highlight properties at position pos? */
1471 ;*---------------------------------------------------------------------*/
1472 (defun flyspell-properties-at-p (pos)
1473 "Return t if there is a text property at POS, not counting `local-map'.
1474 If variable `flyspell-highlight-properties' is set to nil,
1475 text with properties are not checked. This function is used to discover
1476 if the character at POS has any other property."
1477 (let ((prop (text-properties-at pos))
1479 (while (and keep (consp prop))
1480 (if (and (eq (car prop) 'local-map) (consp (cdr prop)))
1481 (setq prop (cdr (cdr prop)))
1485 ;*---------------------------------------------------------------------*/
1486 ;* make-flyspell-overlay ... */
1487 ;*---------------------------------------------------------------------*/
1488 (defun make-flyspell-overlay (beg end face mouse-face)
1489 "Allocate an overlay to highlight an incorrect word.
1490 BEG and END specify the range in the buffer of that word.
1491 FACE and MOUSE-FACE specify the `face' and `mouse-face' properties
1493 (let ((flyspell-overlay (make-overlay beg end nil t nil)))
1494 (overlay-put flyspell-overlay 'face face)
1495 (overlay-put flyspell-overlay 'mouse-face mouse-face)
1496 (overlay-put flyspell-overlay 'flyspell-overlay t)
1497 (overlay-put flyspell-overlay 'evaporate t)
1498 (overlay-put flyspell-overlay 'help-echo "mouse-2: correct word at point")
1499 (if flyspell-use-local-map
1500 (overlay-put flyspell-overlay
1501 flyspell-overlay-keymap-property-name
1502 flyspell-mouse-map))
1503 (when (eq face 'flyspell-incorrect-face)
1504 (and (stringp flyspell-before-incorrect-word-string)
1505 (overlay-put flyspell-overlay 'before-string
1506 flyspell-before-incorrect-word-string))
1507 (and (stringp flyspell-after-incorrect-word-string)
1508 (overlay-put flyspell-overlay 'after-string
1509 flyspell-after-incorrect-word-string)))
1512 ;*---------------------------------------------------------------------*/
1513 ;* flyspell-highlight-incorrect-region ... */
1514 ;*---------------------------------------------------------------------*/
1515 (defun flyspell-highlight-incorrect-region (beg end poss)
1516 "Set up an overlay on a misspelled word, in the buffer from BEG to END."
1517 (let ((inhibit-read-only t))
1518 (unless (run-hook-with-args-until-success
1519 'flyspell-incorrect-hook beg end poss)
1520 (if (or flyspell-highlight-properties
1521 (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
1535 beg end 'flyspell-incorrect-face 'highlight)))))))
1537 ;*---------------------------------------------------------------------*/
1538 ;* flyspell-highlight-duplicate-region ... */
1539 ;*---------------------------------------------------------------------*/
1540 (defun flyspell-highlight-duplicate-region (beg end poss)
1541 "Set up an overlay on a duplicated word, in the buffer from BEG to END.
1542 ??? What does POSS mean?"
1543 (let ((inhibit-read-only t))
1544 (unless (run-hook-with-args-until-success
1545 'flyspell-incorrect-hook beg end poss)
1546 (if (or flyspell-highlight-properties
1547 (not (flyspell-properties-at-p beg)))
1549 ;; we cleanup current overlay at the same position
1550 (if (and (not flyspell-persistent-highlight)
1551 (overlayp flyspell-overlay))
1552 (delete-overlay flyspell-overlay)
1553 (let ((overlays (overlays-at beg)))
1554 (while (consp overlays)
1555 (if (flyspell-overlay-p (car overlays))
1556 (delete-overlay (car overlays)))
1557 (setq overlays (cdr overlays)))))
1558 ;; now we can use a new overlay
1559 (setq flyspell-overlay
1560 (make-flyspell-overlay beg end
1561 'flyspell-duplicate-face
1564 ;*---------------------------------------------------------------------*/
1565 ;* flyspell-auto-correct-cache ... */
1566 ;*---------------------------------------------------------------------*/
1567 (defvar flyspell-auto-correct-pos nil)
1568 (defvar flyspell-auto-correct-region nil)
1569 (defvar flyspell-auto-correct-ring nil)
1570 (defvar flyspell-auto-correct-word nil)
1571 (make-variable-buffer-local 'flyspell-auto-correct-pos)
1572 (make-variable-buffer-local 'flyspell-auto-correct-region)
1573 (make-variable-buffer-local 'flyspell-auto-correct-ring)
1574 (make-variable-buffer-local 'flyspell-auto-correct-word)
1576 ;*---------------------------------------------------------------------*/
1577 ;* flyspell-check-previous-highlighted-word ... */
1578 ;*---------------------------------------------------------------------*/
1579 (defun flyspell-check-previous-highlighted-word (&optional arg)
1580 "Correct the closer misspelled word.
1581 This function scans a mis-spelled word before the cursor. If it finds one
1582 it proposes replacement for that word. With prefix arg, count that many
1583 misspelled words backwards."
1585 (let ((pos1 (point))
1587 (arg (if (or (not (numberp arg)) (< arg 1)) 1 arg))
1590 (while (and (setq pos (previous-overlay-change pos))
1593 (if (> pos (point-min))
1595 (setq ovs (overlays-at (1- pos)))
1598 (setq ovs (cdr ovs))
1599 (if (and (overlay-get ov 'flyspell-overlay)
1600 (= 0 (setq arg (1- arg))))
1601 (throw 'exit t)))))))
1605 (error "No word to correct before point"))))
1607 ;*---------------------------------------------------------------------*/
1608 ;* flyspell-display-next-corrections ... */
1609 ;*---------------------------------------------------------------------*/
1610 (defun flyspell-display-next-corrections (corrections)
1611 (let ((string "Corrections:")
1614 (while (< (length string) 80)
1615 (if (equal (car l) flyspell-auto-correct-word)
1616 (setq pos (cons (+ 1 (length string)) pos)))
1617 (setq string (concat string " " (car l)))
1620 (let ((num (car pos)))
1621 (put-text-property num
1622 (+ num (length flyspell-auto-correct-word))
1624 'flyspell-incorrect-face
1626 (setq pos (cdr pos)))
1627 (if (fboundp 'display-message)
1628 (display-message 'no-log string)
1631 ;*---------------------------------------------------------------------*/
1632 ;* flyspell-abbrev-table ... */
1633 ;*---------------------------------------------------------------------*/
1634 (defun flyspell-abbrev-table ()
1635 (if flyspell-use-global-abbrev-table-p
1637 (or local-abbrev-table global-abbrev-table)))
1639 ;*---------------------------------------------------------------------*/
1640 ;* flyspell-define-abbrev ... */
1641 ;*---------------------------------------------------------------------*/
1642 (defun flyspell-define-abbrev (name expansion)
1643 (let ((table (flyspell-abbrev-table)))
1645 (define-abbrev table name expansion))))
1647 ;*---------------------------------------------------------------------*/
1648 ;* flyspell-auto-correct-word ... */
1649 ;*---------------------------------------------------------------------*/
1650 (defun flyspell-auto-correct-word ()
1651 "Correct the current word.
1652 This command proposes various successive corrections for the current word."
1655 (old-max (point-max)))
1656 ;; use the correct dictionary
1657 (flyspell-accept-buffer-local-defs)
1658 (if (and (eq flyspell-auto-correct-pos pos)
1659 (consp flyspell-auto-correct-region))
1660 ;; we have already been using the function at the same location
1661 (let* ((start (car flyspell-auto-correct-region))
1662 (len (cdr flyspell-auto-correct-region)))
1663 (flyspell-unhighlight-at start)
1664 (delete-region start (+ start len))
1665 (setq flyspell-auto-correct-ring (cdr flyspell-auto-correct-ring))
1666 (let* ((word (car flyspell-auto-correct-ring))
1667 (len (length word)))
1668 (rplacd flyspell-auto-correct-region len)
1670 (if flyspell-abbrev-p
1671 (if (flyspell-already-abbrevp (flyspell-abbrev-table)
1672 flyspell-auto-correct-word)
1673 (flyspell-change-abbrev (flyspell-abbrev-table)
1674 flyspell-auto-correct-word
1676 (flyspell-define-abbrev flyspell-auto-correct-word word)))
1677 (funcall flyspell-insert-function word)
1679 (flyspell-display-next-corrections flyspell-auto-correct-ring))
1680 (flyspell-ajust-cursor-point pos (point) old-max)
1681 (setq flyspell-auto-correct-pos (point)))
1682 ;; fetch the word to be checked
1683 (let ((word (flyspell-get-word nil))
1685 ;; destructure return word info list.
1686 (setq start (car (cdr word))
1687 end (car (cdr (cdr word)))
1689 (setq flyspell-auto-correct-word word)
1690 ;; now check spelling of word.
1691 (process-send-string ispell-process "%\n") ;put in verbose mode
1692 (process-send-string ispell-process (concat "^" word "\n"))
1693 ;; wait until ispell has processed word
1695 (accept-process-output ispell-process)
1696 (not (string= "" (car ispell-filter)))))
1697 (setq ispell-filter (cdr ispell-filter))
1698 (if (consp ispell-filter)
1699 (setq poss (ispell-parse-output (car ispell-filter))))
1700 (cond ((or (eq poss t) (stringp poss))
1701 ;; don't correct word
1705 (error "Ispell: error in Ispell process"))
1707 ;; the word is incorrect, we have to propose a replacement
1708 (let ((replacements (if flyspell-sort-corrections
1709 (sort (car (cdr (cdr poss))) 'string<)
1710 (car (cdr (cdr poss))))))
1711 (setq flyspell-auto-correct-region nil)
1712 (if (consp replacements)
1714 (let ((replace (car replacements)))
1715 (let ((new-word replace))
1716 (if (not (equal new-word (car poss)))
1718 ;; the save the current replacements
1719 (setq flyspell-auto-correct-region
1720 (cons start (length new-word)))
1721 (let ((l replacements))
1722 (while (consp (cdr l))
1724 (rplacd l (cons (car poss) replacements)))
1725 (setq flyspell-auto-correct-ring
1727 (flyspell-unhighlight-at start)
1728 (delete-region start end)
1729 (funcall flyspell-insert-function new-word)
1730 (if flyspell-abbrev-p
1731 (if (flyspell-already-abbrevp
1732 (flyspell-abbrev-table) word)
1733 (flyspell-change-abbrev
1734 (flyspell-abbrev-table)
1737 (flyspell-define-abbrev word new-word)))
1739 (flyspell-display-next-corrections
1740 (cons new-word flyspell-auto-correct-ring))
1741 (flyspell-ajust-cursor-point pos
1744 (setq flyspell-auto-correct-pos (point))
1745 (ispell-pdict-save t)))))
1747 ;*---------------------------------------------------------------------*/
1748 ;* flyspell-auto-correct-previous-pos ... */
1749 ;*---------------------------------------------------------------------*/
1750 (defvar flyspell-auto-correct-previous-pos nil
1751 "Holds the start of the first incorrect word before point.")
1753 ;*---------------------------------------------------------------------*/
1754 ;* flyspell-auto-correct-previous-hook ... */
1755 ;*---------------------------------------------------------------------*/
1756 (defun flyspell-auto-correct-previous-hook ()
1757 "Hook to track successive calls to `flyspell-auto-correct-previous-word'.
1758 Sets flyspell-auto-correct-previous-pos to nil"
1760 (remove-hook 'pre-command-hook (function flyspell-auto-correct-previous-hook) t)
1761 (unless (eq this-command (function flyspell-auto-correct-previous-word))
1762 (setq flyspell-auto-correct-previous-pos nil)))
1764 ;*---------------------------------------------------------------------*/
1765 ;* flyspell-auto-correct-previous-word ... */
1766 ;*---------------------------------------------------------------------*/
1767 (defun flyspell-auto-correct-previous-word (position)
1768 "*Auto correct the first mispelled word that occurs before point."
1771 (add-hook 'pre-command-hook
1772 (function flyspell-auto-correct-previous-hook) t t)
1775 (unless flyspell-auto-correct-previous-pos
1776 ;; only reset if a new overlay exists
1777 (setq flyspell-auto-correct-previous-pos nil)
1779 (let ((overlay-list (overlays-in (point-min) position))
1780 (new-overlay 'dummy-value))
1782 ;; search for previous (new) flyspell overlay
1783 (while (and new-overlay
1784 (or (not (flyspell-overlay-p new-overlay))
1785 ;; check if its face has changed
1786 (not (eq (get-char-property
1787 (overlay-start new-overlay) 'face)
1788 'flyspell-incorrect-face))))
1789 (setq new-overlay (car-safe overlay-list))
1790 (setq overlay-list (cdr-safe overlay-list)))
1792 ;; if nothing new exits new-overlay should be nil
1793 (if new-overlay;; the length of the word may change so go to the start
1794 (setq flyspell-auto-correct-previous-pos
1795 (overlay-start new-overlay)))))
1797 (when flyspell-auto-correct-previous-pos
1799 (goto-char flyspell-auto-correct-previous-pos)
1800 (let ((ispell-following-word t));; point is at start
1801 (if (numberp flyspell-auto-correct-previous-pos)
1802 (goto-char flyspell-auto-correct-previous-pos))
1803 (flyspell-auto-correct-word))
1804 ;; the point may have moved so reset this
1805 (setq flyspell-auto-correct-previous-pos (point))))))
1807 ;*---------------------------------------------------------------------*/
1808 ;* flyspell-correct-word ... */
1809 ;*---------------------------------------------------------------------*/
1810 (defun flyspell-correct-word (event)
1811 "Pop up a menu of possible corrections for a misspelled word.
1812 The word checked is the word at the mouse position."
1814 ;; use the correct dictionary
1815 (flyspell-accept-buffer-local-defs)
1816 ;; retain cursor location (I don't know why but save-excursion here fails).
1817 (let ((save (point)))
1818 (mouse-set-point event)
1819 (let ((cursor-location (point))
1820 (word (flyspell-get-word nil))
1821 start end poss replace)
1822 ;; destructure return word info list.
1823 (setq start (car (cdr word))
1824 end (car (cdr (cdr word)))
1826 ;; now check spelling of word.
1827 (process-send-string ispell-process "%\n") ;put in verbose mode
1828 (process-send-string ispell-process (concat "^" word "\n"))
1829 ;; wait until ispell has processed word
1831 (accept-process-output ispell-process)
1832 (not (string= "" (car ispell-filter)))))
1833 (setq ispell-filter (cdr ispell-filter))
1834 (if (consp ispell-filter)
1835 (setq poss (ispell-parse-output (car ispell-filter))))
1836 (cond ((or (eq poss t) (stringp poss))
1837 ;; don't correct word
1841 (error "Ispell: error in Ispell process"))
1842 ((string-match "GNU" (emacs-version))
1843 ;; the word is incorrect, we have to propose a replacement
1844 (setq replace (flyspell-emacs-popup event poss word))
1845 (cond ((eq replace 'ignore)
1850 (process-send-string ispell-process (concat "*" word "\n"))
1851 (flyspell-unhighlight-at cursor-location)
1852 (setq ispell-pdict-modified-p '(t)))
1853 ((or (eq replace 'buffer) (eq replace 'session))
1854 (process-send-string ispell-process (concat "@" word "\n"))
1855 (if (null ispell-pdict-modified-p)
1856 (setq ispell-pdict-modified-p
1857 (list ispell-pdict-modified-p)))
1858 (flyspell-unhighlight-at cursor-location)
1860 (if (eq replace 'buffer)
1861 (ispell-add-per-file-word-list word)))
1863 (flyspell-unhighlight-at cursor-location)
1864 (let ((new-word (if (atom replace)
1867 (cursor-location (+ (- (length word) (- end start))
1869 (if (not (equal new-word (car poss)))
1870 (let ((old-max (point-max)))
1871 (delete-region start end)
1872 (funcall flyspell-insert-function new-word)
1873 (if flyspell-abbrev-p
1874 (flyspell-define-abbrev word new-word))
1875 (flyspell-ajust-cursor-point save
1881 ((eq flyspell-emacs 'xemacs)
1882 (flyspell-xemacs-popup
1883 event poss word cursor-location start end save)
1885 (ispell-pdict-save t))))
1887 ;*---------------------------------------------------------------------*/
1888 ;* flyspell-xemacs-correct ... */
1889 ;*---------------------------------------------------------------------*/
1890 (defun flyspell-xemacs-correct (replace poss word cursor-location start end save)
1891 "The xemacs popup menu callback."
1892 (cond ((eq replace 'ignore)
1895 (process-send-string ispell-process (concat "*" word "\n"))
1896 (process-send-string ispell-process "#\n")
1897 (flyspell-unhighlight-at cursor-location)
1898 (setq ispell-pdict-modified-p '(t)))
1899 ((or (eq replace 'buffer) (eq replace 'session))
1900 (process-send-string ispell-process (concat "@" word "\n"))
1901 (flyspell-unhighlight-at cursor-location)
1902 (if (null ispell-pdict-modified-p)
1903 (setq ispell-pdict-modified-p
1904 (list ispell-pdict-modified-p)))
1905 (if (eq replace 'buffer)
1906 (ispell-add-per-file-word-list word)))
1908 (let ((old-max (point-max))
1909 (new-word (if (atom replace)
1912 (cursor-location (+ (- (length word) (- end start))
1914 (if (not (equal new-word (car poss)))
1916 (delete-region start end)
1918 (funcall flyspell-insert-function new-word)
1919 (if flyspell-abbrev-p
1920 (flyspell-define-abbrev word new-word))))
1921 (flyspell-ajust-cursor-point save cursor-location old-max)))))
1923 ;*---------------------------------------------------------------------*/
1924 ;* flyspell-ajust-cursor-point ... */
1925 ;*---------------------------------------------------------------------*/
1926 (defun flyspell-ajust-cursor-point (save cursor-location old-max)
1927 (if (>= save cursor-location)
1928 (let ((new-pos (+ save (- (point-max) old-max))))
1930 ((< new-pos (point-min))
1932 ((> new-pos (point-max))
1937 ;*---------------------------------------------------------------------*/
1938 ;* flyspell-emacs-popup ... */
1939 ;*---------------------------------------------------------------------*/
1940 (defun flyspell-emacs-popup (event poss word)
1941 "The Emacs popup menu."
1943 (let* ((mouse-pos (mouse-position))
1944 (mouse-pos (if (nth 1 mouse-pos)
1946 (set-mouse-position (car mouse-pos)
1947 (/ (frame-width) 2) 2)
1949 (setq event (list (list (car (cdr mouse-pos))
1950 (1+ (cdr (cdr mouse-pos))))
1952 (let* ((corrects (if flyspell-sort-corrections
1953 (sort (car (cdr (cdr poss))) 'string<)
1954 (car (cdr (cdr poss)))))
1955 (cor-menu (if (consp corrects)
1956 (mapcar (lambda (correct)
1957 (list correct correct))
1960 (affix (car (cdr (cdr (cdr poss)))))
1961 (base-menu (let ((save (if (consp affix)
1963 (list (concat "Save affix: " (car affix))
1965 '("Accept (session)" session)
1966 '("Accept (buffer)" buffer))
1967 '(("Save word" save)
1968 ("Accept (session)" session)
1969 ("Accept (buffer)" buffer)))))
1970 (if (consp cor-menu)
1971 (append cor-menu (cons "" save))
1973 (menu (cons "flyspell correction menu" base-menu)))
1974 (car (x-popup-menu event
1975 (list (format "%s [%s]" word (or ispell-local-dictionary
1979 ;*---------------------------------------------------------------------*/
1980 ;* flyspell-xemacs-popup ... */
1981 ;*---------------------------------------------------------------------*/
1982 (defun flyspell-xemacs-popup (event poss word cursor-location start end save)
1983 "The XEmacs popup menu."
1984 (let* ((corrects (if flyspell-sort-corrections
1985 (sort (car (cdr (cdr poss))) 'string<)
1986 (car (cdr (cdr poss)))))
1987 (cor-menu (if (consp corrects)
1988 (mapcar (lambda (correct)
1990 (list 'flyspell-xemacs-correct
2001 (affix (car (cdr (cdr (cdr poss)))))
2002 (menu (let ((save (if (consp affix)
2004 (concat "Save affix: " (car affix))
2005 (list 'flyspell-xemacs-correct
2016 (list 'flyspell-xemacs-correct
2025 (session (vector "Accept (session)"
2026 (list 'flyspell-xemacs-correct
2035 (buffer (vector "Accept (buffer)"
2036 (list 'flyspell-xemacs-correct
2045 (if (consp cor-menu)
2046 (append cor-menu (list "-" save session buffer))
2047 (list save session buffer)))))
2048 (popup-menu (cons (format "%s [%s]" word (or ispell-local-dictionary
2052 ;*---------------------------------------------------------------------*/
2053 ;* Some example functions for real autocorrecting */
2054 ;*---------------------------------------------------------------------*/
2055 (defun flyspell-maybe-correct-transposition (beg end poss)
2056 "Check replacements for transposed characters.
2058 If the text between BEG and END is equal to a correction suggested by
2059 Ispell, after transposing two adjacent characters, correct the text,
2062 The third arg POSS is either the symbol 'doublon' or a list of
2063 possible corrections as returned by 'ispell-parse-output'.
2065 This function is meant to be added to 'flyspell-incorrect-hook'."
2068 (let ((str (buffer-substring beg end))
2069 (i 0) (len (- end beg)) tmp)
2070 (while (< (1+ i) len)
2071 (setq tmp (aref str i))
2072 (aset str i (aref str (1+ i)))
2073 (aset str (1+ i) tmp)
2074 (when (member str (nth 2 poss))
2076 (goto-char (+ beg i 1))
2077 (transpose-chars 1))
2079 (setq tmp (aref str i))
2080 (aset str i (aref str (1+ i)))
2081 (aset str (1+ i) tmp)
2085 (defun flyspell-maybe-correct-doubling (beg end poss)
2086 "Check replacements for doubled characters.
2088 If the text between BEG and END is equal to a correction suggested by
2089 Ispell, after removing a pair of doubled characters, correct the text,
2092 The third arg POSS is either the symbol 'doublon' or a list of
2093 possible corrections as returned by 'ispell-parse-output'.
2095 This function is meant to be added to 'flyspell-incorrect-hook'."
2098 (let ((str (buffer-substring beg end))
2099 (i 0) (len (- end beg)))
2100 (while (< (1+ i) len)
2101 (when (and (= (aref str i) (aref str (1+ i)))
2102 (member (concat (substring str 0 (1+ i))
2103 (substring str (+ i 2)))
2105 (goto-char (+ beg i))
2111 ;*---------------------------------------------------------------------*/
2112 ;* flyspell-already-abbrevp ... */
2113 ;*---------------------------------------------------------------------*/
2114 (defun flyspell-already-abbrevp (table word)
2115 (let ((sym (abbrev-symbol word table)))
2116 (and sym (symbolp sym))))
2118 ;*---------------------------------------------------------------------*/
2119 ;* flyspell-change-abbrev ... */
2120 ;*---------------------------------------------------------------------*/
2121 (defun flyspell-change-abbrev (table old new)
2122 (set (abbrev-symbol old table) new))
2126 ;;; arch-tag: 05d915b9-e9cf-44fb-9137-fc28f5eaab2a
2127 ;;; flyspell.el ends here