| blob | d87cb5e72ed467040beef3b07e696baffe12623e |
1 ;;; flyspell.el --- On-the-fly spell checker -*- lexical-binding:t -*-
3 ;; Copyright (C) 1998, 2000-2018 Free Software Foundation, Inc.
5 ;; Author: Manuel Serrano <Manuel.Serrano@sophia.inria.fr>
6 ;; Maintainer: emacs-devel@gnu.org
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 <https://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:
44 ;;*---------------------------------------------------------------------*/
45 ;;* Group ... */
46 ;;*---------------------------------------------------------------------*/
48 "Spell checking on the fly."
54 ;;*---------------------------------------------------------------------*/
55 ;;* User configuration ... */
56 ;;*---------------------------------------------------------------------*/
58 "How Flyspell should indicate misspelled words.
59 Non-nil means use highlight, nil means use minibuffer messages."
64 "Non-nil means Flyspell reports a repeated word as an error.
65 See `flyspell-mark-duplications-exceptions' to add exceptions to this rule.
66 Detection of repeated words is not implemented in
74 "A list of exceptions for duplicated words.
75 It should be a list of (LANGUAGE . EXCEPTION-LIST).
77 LANGUAGE is nil, which means the exceptions apply regardless of
78 the current dictionary, or a regular expression matching the
79 dictionary name (`ispell-local-dictionary' or
80 `ispell-dictionary') for which the exceptions should apply.
82 EXCEPTION-LIST is a list of strings. The checked word is
83 downcased before comparing with these exceptions."
86 string)
91 "If non-nil, sort the corrections before popping them.
92 The sorting is controlled by the `flyspell-sort-corrections-function'
93 variable, and defaults to sorting alphabetically."
99 'flyspell-sort-corrections-alphabetically
100 "The function used to sort corrections.
101 This only happens if `flyspell-sort-corrections' is non-nil. The
102 function takes three parameters -- the two correction candidates
103 to be sorted, and the third parameter is the word that's being
104 corrected."
117 corrs))
120 "The maximum distance for finding duplicates of unrecognized words.
121 This applies to the feature that when a word is not found in the dictionary,
122 if the same spelling occurs elsewhere in the buffer,
123 Flyspell uses a different face (`flyspell-duplicate') to highlight it.
124 This variable specifies how far to search to find such a duplicate.
125 -1 means no limit (search the whole buffer).
126 0 means do not search for duplicate unrecognized spellings."
130 number))
138 "Non-nil means misspelled words remain highlighted until corrected.
139 If this variable is nil, only the most recently detected misspelled word
140 is highlighted."
145 "Non-nil means highlight incorrect words even if a property exists for this word."
151 delete-backward-char
152 backward-or-forward-delete-char
153 delete-char
154 scrollbar-vertical-drag
155 backward-delete-char-untabify)
156 "The standard list of delayed commands for Flyspell.
157 See `flyspell-delayed-commands'."
164 After these commands, Flyspell checking is delayed for a short time,
165 whose length is specified by `flyspell-delay'."
171 handle-switch-frame handle-select-window
172 scroll-up
173 scroll-down)
174 "The standard list of deplacement commands for Flyspell.
175 See variable `flyspell-deplacement-commands'."
182 After these commands, Flyspell checking is performed only if the previous
183 command was not the very same command."
189 "Non-nil means that Flyspell should display a welcome message when started."
194 "Non-nil means that Flyspell emits messages when checking words."
199 "List of functions to be called when incorrect words are encountered.
200 Each function is given three arguments. The first two
201 arguments are the beginning and the end of the incorrect region.
202 The third is either the symbol `doublon' or the list
203 of possible corrections as returned by `ispell-parse-output'.
205 If any of the functions return non-nil, the word is not highlighted as
206 incorrect."
212 "A string that is the name of the default dictionary.
213 This is passed to the `ispell-change-dictionary' when flyspell is started.
214 If the variable `ispell-local-dictionary' or `ispell-dictionary' is non-nil
215 when flyspell is started, the value of that variable is used instead
216 of `flyspell-default-dictionary' to select the default dictionary.
217 Otherwise, if `flyspell-default-dictionary' is nil, it means to use
218 Ispell's ultimate default dictionary."
224 "\\(\\(begin\\|end\\)[ \t]*{\\|\\(cite[a-z*]*\\|label\\|ref\\|eqref\\|usepackage\\|documentclass\\)[ \t]*\\(\\[[^]]*\\]\\)?{[^{}]*\\)"
225 "A string that is the regular expression that matches TeX commands."
231 "Non-nil means check even inside TeX math environment.
232 TeX math environments are discovered by `texmathp', implemented
233 inside AUCTeX package. That package may be found at
234 URL `https://www.gnu.org/software/auctex/'"
240 "List of dictionary names that consider `-' as word delimiter."
246 nil
247 "If non-nil, add correction to abbreviation table."
253 nil
254 "If non-nil, prefer global abbrev table to local abbrev table."
260 "String displayed on the mode line when flyspell is active.
261 Set this to nil if you don't want a mode line indicator."
266 "The threshold that determines if a region is small.
267 If the region is smaller than this number of characters,
268 `flyspell-region' checks the words sequentially using regular
269 flyspell methods. Else, if the region is large, a new Ispell process is
270 spawned for speed.
272 Doubled words are not detected in a large region, because Ispell
273 does not check for them.
275 If this variable is nil, all regions are treated as small."
281 "Function for inserting word by flyspell upon correction."
286 "String used to indicate an incorrect word starting."
291 "String used to indicate an incorrect word ending."
298 "Non-nil means that flyspell uses M-TAB to correct word."
309 "The key binding for flyspell auto correction."
313 ;;*---------------------------------------------------------------------*/
314 ;;* Mode specific options */
315 ;;* ------------------------------------------------------------- */
316 ;;* Mode specific options enable users to disable flyspell on */
317 ;;* certain word depending of the emacs mode. For instance, when */
318 ;;* using flyspell with mail-mode add the following expression */
319 ;;* in your init file: */
320 ;;* (add-hook 'mail-mode */
321 ;;* (lambda () (setq flyspell-generic-check-word-predicate */
322 ;;* 'mail-mode-flyspell-verify))) */
323 ;;*---------------------------------------------------------------------*/
325 "Function providing per-mode customization over which words are flyspelled.
326 Returns t to continue checking, nil otherwise.
327 Flyspell mode sets this variable to whatever is the `flyspell-mode-predicate'
333 ;;*--- mail mode -------------------------------------------------------*/
338 "Function used for `flyspell-generic-check-word-predicate' in Mail mode."
345 nil t)
360 nil)
366 ;;*--- texinfo mode ----------------------------------------------------*/
369 "Function used for `flyspell-generic-check-word-predicate' in Texinfo mode."
374 ;;*--- tex mode --------------------------------------------------------*/
377 "Function used for `flyspell-generic-check-word-predicate' in LaTeX mode."
389 ;;*--- sgml mode -------------------------------------------------------*/
397 "Function used for `flyspell-generic-check-word-predicate' in SGML mode.
398 Tag and attribute names are not spell checked, everything else is.
400 String values of attributes are checked because they can be text
406 ;;*---------------------------------------------------------------------*/
407 ;;* Programming mode */
408 ;;*---------------------------------------------------------------------*/
414 "Used for `flyspell-generic-check-word-predicate' in programming modes."
415 ;; (point) is next char after the word. Must check one char before.
419 ;; Records the binding of M-TAB in effect before flyspell was activated.
422 ;;;###autoload
424 "Turn on `flyspell-mode' for comments and strings."
434 ;;*---------------------------------------------------------------------*/
435 ;;* Overlay compatibility */
436 ;;*---------------------------------------------------------------------*/
446 ;;*---------------------------------------------------------------------*/
447 ;;* The minor mode declaration. */
448 ;;*---------------------------------------------------------------------*/
452 map)
463 map)
466 ;; dash character machinery
475 ;;*---------------------------------------------------------------------*/
476 ;;* Highlighting */
477 ;;*---------------------------------------------------------------------*/
483 "Flyspell face for misspelled words."
492 "Flyspell face for words that appear twice in a row.
493 See also `flyspell-duplicate-distance'."
499 ;;*---------------------------------------------------------------------*/
500 ;;* flyspell-mode ... */
501 ;;*---------------------------------------------------------------------*/
502 ;;;###autoload(defvar flyspell-mode nil "Non-nil if Flyspell mode is enabled.")
503 ;;;###autoload
505 "Toggle on-the-fly spell checking (Flyspell mode).
506 With a prefix argument ARG, enable Flyspell mode if ARG is
507 positive, and disable it otherwise. If called from Lisp, enable
508 the mode if ARG is omitted or nil.
510 Flyspell mode is a buffer-local minor mode. When enabled, it
511 spawns a single Ispell process and checks each word. The default
512 flyspell behavior is to highlight incorrect words.
514 Bindings:
520 Hooks:
521 This runs `flyspell-mode-hook' after flyspell mode is entered or exit.
523 Remark:
524 `flyspell-mode' uses `ispell-mode'. Thus all Ispell options are
525 valid. For instance, a different dictionary can be used by
526 invoking `ispell-change-dictionary'.
528 Consider using the `ispell-parser' to check your text. For instance
529 consider adding:
531 in your init file.
535 :lighter flyspell-mode-line-string
536 :keymap flyspell-mode-map
545 ;;;###autoload
547 "Unconditionally turn on Flyspell mode."
550 ;;;###autoload
552 "Unconditionally turn off Flyspell mode."
557 ;;*---------------------------------------------------------------------*/
558 ;;* flyspell-buffers ... */
559 ;;* ------------------------------------------------------------- */
560 ;;* For remembering buffers running flyspell */
561 ;;*---------------------------------------------------------------------*/
564 ;;*---------------------------------------------------------------------*/
565 ;;* flyspell-minibuffer-p ... */
566 ;;*---------------------------------------------------------------------*/
568 "Is BUFFER a minibuffer?"
572 ;;*---------------------------------------------------------------------*/
573 ;;* flyspell-accept-buffer-local-defs ... */
574 ;;*---------------------------------------------------------------------*/
579 ;; When flyspell-word is used inside a loop (e.g. when processing
580 ;; flyspell-changes), the calls to `ispell-accept-buffer-local-defs' end
581 ;; up dwarfing everything else, so only do it when the buffer has changed.
584 ;; Strange problem: If buffer in current window has font-lock turned on,
585 ;; but SET-BUFFER was called to point to an invisible buffer, this ispell
586 ;; call will reset the buffer to the buffer in the current window.
587 ;; However, it only happens at startup (fix by Albert L. Ting).
592 ;; The dictionary has changed
597 flyspell-dictionaries-that-consider-dash-as-word-delimiter)))))
600 ;; When local variables are loaded, see if the dictionary context
601 ;; has changed.
610 ;; Make sure we flush our caches when needed. Do it here rather than in
611 ;; flyspell-mode-on, since flyspell-region may be used without ever turning
612 ;; on flyspell-mode.
615 ;;*---------------------------------------------------------------------*/
616 ;;* flyspell-mode-on ... */
617 ;;*---------------------------------------------------------------------*/
619 "Turn Flyspell mode on. Do not use this; use `flyspell-mode' instead."
622 ;; local dictionaries setup
626 ;; we have to force ispell to accept the local definition or
627 ;; otherwise it could be too late, the local dictionary may
628 ;; be forgotten!
629 ;; Pass the `force' argument for the case where flyspell was active already
630 ;; but the buffer's local-defs have been edited.
632 ;; we put the `flyspell-delayed' property on some commands
634 ;; we put the `flyspell-deplacement' property on some commands
636 ;; we bound flyspell action to post-command hook
638 ;; we bound flyspell action to pre-command hook
640 ;; we bound flyspell action to after-change hook
642 ;; we bound flyspell action to hack-local-variables-hook
645 ;; set flyspell-generic-check-word-predicate based on the major mode
649 ;; the welcome message
651 flyspell-issue-welcome-flag
661 ;;*---------------------------------------------------------------------*/
662 ;;* flyspell-delay-commands ... */
663 ;;*---------------------------------------------------------------------*/
665 "Install the standard set of Flyspell delayed commands."
669 ;;*---------------------------------------------------------------------*/
670 ;;* flyspell-delay-command ... */
671 ;;*---------------------------------------------------------------------*/
673 "Set COMMAND to be delayed, for Flyspell.
674 When flyspell `post-command-hook' is invoked because a delayed command
675 has been used, the current word is not immediately checked.
676 It will be checked only after `flyspell-delay' seconds."
680 ;;*---------------------------------------------------------------------*/
681 ;;* flyspell-deplacement-commands ... */
682 ;;*---------------------------------------------------------------------*/
684 "Install the standard set of Flyspell deplacement commands."
688 ;;*---------------------------------------------------------------------*/
689 ;;* flyspell-deplacement-command ... */
690 ;;*---------------------------------------------------------------------*/
692 "Set COMMAND that implement cursor movements, for Flyspell.
693 When flyspell `post-command-hook' is invoked because a deplacement command
694 has been used, the current word is not checked."
698 ;;*---------------------------------------------------------------------*/
699 ;;* flyspell-word-cache ... */
700 ;;*---------------------------------------------------------------------*/
710 ;;*---------------------------------------------------------------------*/
711 ;;* The flyspell pre-hook, store the current position. In the */
712 ;;* post command hook, we will check, if the word at this position */
713 ;;* has to be spell checked. */
714 ;;*---------------------------------------------------------------------*/
722 ;;*---------------------------------------------------------------------*/
723 ;;* flyspell-previous-command ... */
724 ;;*---------------------------------------------------------------------*/
728 ;;*---------------------------------------------------------------------*/
729 ;;* flyspell-pre-command-hook ... */
730 ;;*---------------------------------------------------------------------*/
732 "Save the current buffer and point for Flyspell's post-command hook."
738 ;;*---------------------------------------------------------------------*/
739 ;;* flyspell-mode-off ... */
740 ;;*---------------------------------------------------------------------*/
741 ;;;###autoload
743 "Turn Flyspell mode off."
744 ;; We remove the hooks.
750 ;; We remove all the flyspell highlightings.
752 ;; We have to erase pre cache variables.
755 ;; We mark the mode as killed.
758 ;;*---------------------------------------------------------------------*/
759 ;;* flyspell-check-pre-word-p ... */
760 ;;*---------------------------------------------------------------------*/
762 "Return non-nil if we should check the word before point.
763 More precisely, it applies to the word that was before point
764 before the current command."
769 nil)
772 nil)
777 ispell-otherchars
782 nil)
790 ;; If other post-command-hooks change the buffer,
791 ;; flyspell-pre-point can lie past eob (bug#468).
796 ispell-otherchars
799 nil)
801 t)
804 t)
809 ;;*---------------------------------------------------------------------*/
810 ;;* The flyspell after-change-hook, store the change position. In */
811 ;;* the post command hook, we will check, if the word at this */
812 ;;* position has to be spell checked. */
813 ;;*---------------------------------------------------------------------*/
817 ;;*---------------------------------------------------------------------*/
818 ;;* flyspell-after-change-function ... */
819 ;;*---------------------------------------------------------------------*/
821 "Save the current buffer and point for Flyspell's post-command hook."
824 ;;*---------------------------------------------------------------------*/
825 ;;* flyspell-check-changed-word-p ... */
826 ;;*---------------------------------------------------------------------*/
828 "Return non-nil when the changed word has to be checked.
829 The answer depends of several criteria.
830 Mostly we check word delimiters."
838 ;;*---------------------------------------------------------------------*/
839 ;;* flyspell-check-word-p ... */
840 ;;*---------------------------------------------------------------------*/
842 "Return t when the word at `point' has to be checked.
843 The answer depends of several criteria.
844 Mostly we check word delimiters."
848 ;; The buffer is not filled enough.
849 nil)
859 ;; Yes because we have reached or typed a word delimiter.
860 t)
866 ;; The current command is not delayed, that
867 ;; is that we must check the word now.
873 ;;*---------------------------------------------------------------------*/
874 ;;* flyspell-debug-signal-no-check ... */
875 ;;*---------------------------------------------------------------------*/
883 ;;*---------------------------------------------------------------------*/
884 ;;* flyspell-debug-signal-pre-word-checked ... */
885 ;;*---------------------------------------------------------------------*/
896 ;;*---------------------------------------------------------------------*/
897 ;;* flyspell-debug-signal-word-checked ... */
898 ;;*---------------------------------------------------------------------*/
917 nil
930 ;; The current command is not delayed, that
931 ;; is that we must check the word now.
935 nil
943 ;; Yes because we have reached or typed a word delimiter.
946 ;; Yes because the user set up a no-delay configuration.
952 ;;*---------------------------------------------------------------------*/
953 ;;* flyspell-debug-signal-changed-checked ... */
954 ;;*---------------------------------------------------------------------*/
963 ;;*---------------------------------------------------------------------*/
964 ;;* flyspell-post-command-hook ... */
965 ;;* ------------------------------------------------------------- */
966 ;;* It is possible that we check several words: */
967 ;;* 1- the current word is checked if the predicate */
968 ;;* FLYSPELL-CHECK-WORD-P is true */
969 ;;* 2- the word that used to be the current word before the */
970 ;;* THIS-COMMAND is checked if: */
971 ;;* a- the previous word is different from the current word */
972 ;;* b- the previous word has not just been checked by the */
973 ;;* previous FLYSPELL-POST-COMMAND-HOOK */
974 ;;* 3- the words changed by the THIS-COMMAND that are neither the */
975 ;;* previous word nor the current word */
976 ;;*---------------------------------------------------------------------*/
978 "The `post-command-hook' used by flyspell to check a word on-the-fly."
983 ;; Prevent anything we do from affecting the mark.
984 deactivate-mark)
993 ;; FIXME: This should be asynchronous!
995 ;; we remember which word we have just checked.
996 ;; this will be used next time we will check a word
997 ;; to compare the next current word with the word
998 ;; that has been registered in the pre-command-hook
999 ;; that is these variables are used within the predicate
1000 ;; FLYSPELL-CHECK-PRE-WORD-P
1005 ;; when a word is not checked because of a delayed command
1006 ;; we do not disable the ispell cache.
1022 ;;*---------------------------------------------------------------------*/
1023 ;;* flyspell-notify-misspell ... */
1024 ;;*---------------------------------------------------------------------*/
1027 poss
1032 ;;*---------------------------------------------------------------------*/
1033 ;;* flyspell-word-search-backward ... */
1034 ;;*---------------------------------------------------------------------*/
1046 flyspell-not-casechars))
1047 p)
1064 r)))
1066 ;;*---------------------------------------------------------------------*/
1067 ;;* flyspell-word-search-forward ... */
1068 ;;*---------------------------------------------------------------------*/
1080 p)
1093 r)))
1097 ;;*---------------------------------------------------------------------*/
1098 ;;* flyspell-word ... */
1099 ;;*---------------------------------------------------------------------*/
1101 "Spell check a word.
1102 If the optional argument FOLLOWING, or, when called interactively
1103 `ispell-following-word', is non-nil, checks the following (rather
1104 than preceding) word when the cursor is not over a word. If
1105 optional argument KNOWN-MISSPELLING is non nil considers word a
1106 misspelling and skips redundant spell-checking step.
1108 See `flyspell-get-word' for details of how this finds the word to
1109 spell-check."
1113 ;; use the correct dictionary
1117 start end poss word ispell-filter)
1121 t
1123 ;; destructure return flyspell-word info list.
1127 ;; before checking in the directory, we check for doublons.
1132 flyspell-mark-duplications-flag
1135 ispell-dictionary)))
1152 ;; yes, this is a doublon
1154 nil)
1158 ;; this word had been already checked, we skip
1159 flyspell-word-cache-result)
1162 ;; this is a correct word (because a tex command)
1166 t)
1168 ;; we setup the cache
1172 ;; now check spelling of word.
1176 ;; put in verbose mode
1178 ;; we mark the ispell process so it can be killed
1179 ;; when emacs is exited without query
1181 ;; Wait until ispell has processed word.
1185 ;; (ispell-send-string "!\n")
1186 ;; back to terse mode.
1187 ;; Remove leading empty element
1189 ;; ispell process should return something after word is sent.
1190 ;; Tag word as valid (i.e., skip) otherwise
1195 ;; Else, this was a known misspelling to begin with, and
1196 ;; we should forge an ispell return value.
1199 ;; correct
1204 t)
1206 ;; correct
1211 t)
1217 t)
1222 word
1227 word
1233 word
1235 flyspell-duplicate-distance)))
1239 word
1240 (+ end
1241 flyspell-duplicate-distance))))))
1242 ;; This is a misspelled word which occurs
1243 ;; twice within flyspell-duplicate-distance.
1247 start end poss)
1249 nil)
1252 ;; Highlight the location as incorrect,
1253 ;; including offset specified in POSS.
1259 start)
1260 end poss)
1262 nil))))
1263 ;; return to original location
1266 res))))))))
1268 ;;*---------------------------------------------------------------------*/
1269 ;;* flyspell-math-tex-command-p ... */
1270 ;;* ------------------------------------------------------------- */
1271 ;;* This function uses the texmathp package to check if point */
1272 ;;* is within a TeX math environment. `texmathp' can yield errors */
1273 ;;* if the document is currently not valid TeX syntax. */
1274 ;;*---------------------------------------------------------------------*/
1278 nil
1283 ;;*---------------------------------------------------------------------*/
1284 ;;* flyspell-tex-command-p ... */
1285 ;;*---------------------------------------------------------------------*/
1287 "Return t if WORD is a TeX command."
1300 ;;*---------------------------------------------------------------------*/
1301 ;;* flyspell-get-word ... */
1302 ;;*---------------------------------------------------------------------*/
1304 "Return the word for spell-checking according to Ispell syntax.
1305 Optional argument FOLLOWING non-nil means to get the following
1306 \(rather than preceding) word when the cursor is not over a word.
1307 Optional second argument EXTRA-OTHERCHARS is a regexp of characters
1308 that may be included as part of a word (see `ispell-dictionary-alist').
1310 This finds the word to spell-check by searching for CASECHARS defined
1311 in `ispell-dictionary-alist' for the current dictionary. Thus, the
1312 word could be far away from point if point is inside whitespace or
1313 punctuation characters, or in text that belongs to a different
1314 language."
1325 flyspell-casechars
1328 extra-otherchars)
1330 did-it-once prevpt
1331 start end word)
1332 ;; find the word
1337 ;; move to front of word
1344 ispell-many-otherchars-p)
1357 ;; Now mark the word and save to string.
1359 nil
1366 ;;*---------------------------------------------------------------------*/
1367 ;;* flyspell-small-region ... */
1368 ;;*---------------------------------------------------------------------*/
1370 "Flyspell text between BEG and END."
1395 ;;*---------------------------------------------------------------------*/
1396 ;;* flyspell-external-ispell-process ... */
1397 ;;*---------------------------------------------------------------------*/
1401 ;;*---------------------------------------------------------------------*/
1402 ;;* flyspell-external-ispell-buffer ... */
1403 ;;*---------------------------------------------------------------------*/
1409 ;;*---------------------------------------------------------------------*/
1410 ;;* flyspell-external-point-words ... */
1411 ;;*---------------------------------------------------------------------*/
1413 "Mark words from a buffer listing incorrect words in order of appearance.
1414 The list of incorrect words should be in `flyspell-external-ispell-buffer'.
1415 \(We finish by killing that buffer and setting the variable to nil.)
1416 The buffer to mark them in is `flyspell-large-region-buffer'."
1420 case-fold-search)
1423 ;; Loop over incorrect words, in the order they were reported,
1424 ;; which is also the order they appear in the buffer being checked.
1426 ;; Bind WORD to the next one.
1428 ;; Here there used to be code to see if WORD is the same
1429 ;; as the previous iteration, and count the number of consecutive
1430 ;; identical words, and the loop below would search for that many.
1431 ;; That code seemed to be incorrect, and on principle, should
1432 ;; be unnecessary too. -- rms.
1436 word))
1440 ;; Iterate on string search until string is found as word,
1441 ;; not as substring.
1444 flyspell-large-region-end t)
1447 ;; Move back into the match
1448 ;; so flyspell-get-word will find it.
1455 ;; Size matches, we really found it.
1457 ;; Matches as part of a boundary-char separated
1458 ;; word.
1461 ;; Misspelling has higher length than
1462 ;; what flyspell considers the word.
1463 ;; Caused by boundary-chars mismatch.
1464 ;; Validating seems safe.
1466 ;; ispell treats beginning of some TeX
1467 ;; commands as nroff control sequences
1468 ;; and strips them in the list of
1469 ;; misspelled words thus giving a
1470 ;; non-existent word. Skip if ispell
1471 ;; is used, string is a TeX command
1472 ;; (char before beginning of word is
1473 ;; backslash) and none of the previous
1474 ;; conditions match.
1479 t
1480 nil))))
1483 ;; Search for next misspelled word will begin from
1484 ;; end of last validated match.
1486 ;; Record if misspelling is not found and try new one
1491 ;; we are done
1493 ;; Warn about not found misspellings
1496 ;; Kill and forget the buffer with the list of incorrect words.
1500 ;;*---------------------------------------------------------------------*/
1501 ;;* flyspell-process-localwords ... */
1502 ;;* ------------------------------------------------------------- */
1503 ;;* This function is used to prevent marking of words explicitly */
1504 ;;* declared correct. */
1505 ;;*---------------------------------------------------------------------*/
1508 case-fold-search
1510 ;; Get localwords from the original buffer
1513 ;; Localwords parsing copied from ispell.el.
1516 string)
1517 ;; buffer-local words separated by a space, and can contain
1518 ;; any character other than a space. Not rigorous enough.
1522 ;; This can fail when string contains a word with invalid chars.
1523 ;; Error handling needs to be added between Ispell and Emacs.
1527 ;; Remove localwords matches from misspellings-buffer.
1528 ;; The usual mechanism of communicating the local words to ispell
1529 ;; does not affect the special ispell process used by
1530 ;; flyspell-large-region.
1539 ;;* ---------------------------------------------------------------
1540 ;;* flyspell-check-region-doublons
1541 ;;* ---------------------------------------------------------------
1543 "Check for adjacent duplicated words (doublons) in the given region."
1555 ;;*---------------------------------------------------------------------*/
1556 ;;* flyspell-large-region ... */
1557 ;;*---------------------------------------------------------------------*/
1568 ;; this is done, we can start checking...
1572 ;; Local dictionary becomes the global dictionary in use.
1579 c)
1589 ispell-current-personal-dictionary)))))
1591 ;; Check for extended character mode
1598 ;; Add ispell-extra-args
1601 ;; If we are using recent aspell or hunspell, make sure we use the right encoding
1602 ;; for communication. ispell or older aspell/hunspell does not support this
1614 end
1615 ispell-program-name
1616 nil
1617 buffer
1618 nil
1620 args)))
1630 ;;*---------------------------------------------------------------------*/
1631 ;;* flyspell-region ... */
1632 ;;* ------------------------------------------------------------- */
1633 ;;* Because `ispell -a' is too slow, it is not possible to use */
1634 ;;* it on large region. Then, when ispell is invoked on a large */
1635 ;;* text region, a new `ispell -l' process is spawned. The */
1636 ;;* pointed out words are then searched in the region a checked with */
1637 ;;* regular flyspell means. */
1638 ;;*---------------------------------------------------------------------*/
1639 ;;;###autoload
1641 "Flyspell text between BEG and END."
1645 ()
1655 ;;*---------------------------------------------------------------------*/
1656 ;;* flyspell-buffer ... */
1657 ;;*---------------------------------------------------------------------*/
1658 ;;;###autoload
1660 "Flyspell whole buffer."
1664 ;;*---------------------------------------------------------------------*/
1665 ;;* old next error position ... */
1666 ;;*---------------------------------------------------------------------*/
1670 ;;*---------------------------------------------------------------------*/
1671 ;;* flyspell-goto-next-error ... */
1672 ;;*---------------------------------------------------------------------*/
1674 "Go to the next previously detected error.
1675 In general FLYSPELL-GOTO-NEXT-ERROR must be used after
1676 FLYSPELL-BUFFER."
1684 ;; goto beginning of buffer
1690 ;; seek the next error
1700 ;; save the current location for next invocation
1707 ;;*---------------------------------------------------------------------*/
1708 ;;* flyspell-overlay-p ... */
1709 ;;*---------------------------------------------------------------------*/
1711 "Return true if O is an overlay used by flyspell."
1714 ;;*---------------------------------------------------------------------*/
1715 ;;* flyspell-delete-region-overlays, flyspell-delete-all-overlays */
1716 ;;* ------------------------------------------------------------- */
1717 ;;* Remove overlays introduced by flyspell. */
1718 ;;*---------------------------------------------------------------------*/
1720 "Delete overlays used by flyspell in a given region."
1724 "Delete all the overlays used by flyspell."
1727 ;;*---------------------------------------------------------------------*/
1728 ;;* flyspell-unhighlight-at ... */
1729 ;;*---------------------------------------------------------------------*/
1731 "Remove the flyspell overlay that are located at POS."
1741 ;;*---------------------------------------------------------------------*/
1742 ;;* flyspell-properties-at-p ... */
1743 ;;* ------------------------------------------------------------- */
1744 ;;* Is there a highlight property at position pos? */
1745 ;;*---------------------------------------------------------------------*/
1747 "Return t if there is a text property at POS, not counting `local-map'.
1748 If variable `flyspell-highlight-properties' is set to nil,
1749 text with properties are not checked. This function is used to discover
1750 if the character at POS has any other property."
1759 ;;*---------------------------------------------------------------------*/
1760 ;;* make-flyspell-overlay ... */
1761 ;;*---------------------------------------------------------------------*/
1763 "Allocate an overlay to highlight an incorrect word.
1764 BEG and END specify the range in the buffer of that word.
1765 FACE and MOUSE-FACE specify the `face' and `mouse-face' properties
1766 for the overlay."
1773 ;; If misspelled text has a 'keymap' property, let that remain in
1774 ;; effect for the bindings that flyspell-mouse-map doesn't override.
1780 flyspell-before-incorrect-word-string))
1783 flyspell-after-incorrect-word-string)))
1784 overlay))
1786 ;;*---------------------------------------------------------------------*/
1787 ;;* flyspell-highlight-incorrect-region ... */
1788 ;;*---------------------------------------------------------------------*/
1790 "Set up an overlay on a misspelled word, in the buffer from BEG to END.
1791 POSS is usually a list of possible spelling/correction lists,
1792 as returned by `ispell-parse-output'.
1793 It can also be the symbol `doublon', in the case where the word
1794 is itself incorrect, but suspiciously repeated."
1801 ;; we cleanup all the overlay that are in the region, not
1802 ;; beginning at the word start position
1809 ;; we cleanup current overlay at the same position
1811 ;; now we can use a new overlay
1814 beg end
1818 ;;*---------------------------------------------------------------------*/
1819 ;;* flyspell-highlight-duplicate-region ... */
1820 ;;*---------------------------------------------------------------------*/
1822 "Set up an overlay on a duplicate misspelled word, in the buffer from BEG to END.
1823 POSS is a list of possible spelling/correction lists,
1824 as returned by `ispell-parse-output'."
1831 ;; we cleanup current overlay at the same position
1833 ;; now we can use a new overlay
1836 'flyspell-duplicate
1839 ;;*---------------------------------------------------------------------*/
1840 ;;* flyspell-auto-correct-cache ... */
1841 ;;*---------------------------------------------------------------------*/
1851 ;;*---------------------------------------------------------------------*/
1852 ;;* flyspell-check-previous-highlighted-word ... */
1853 ;;*---------------------------------------------------------------------*/
1855 "Correct the closest previous word that is highlighted as misspelled.
1856 This function scans for a word which starts before point that has been
1857 highlighted by Flyspell as misspelled. If it finds one, it proposes
1858 a replacement for that word. With prefix arg N, check the Nth word
1859 before point that's highlighted as misspelled."
1864 ov ovs)
1885 ;;*---------------------------------------------------------------------*/
1886 ;;* flyspell-display-next-corrections ... */
1887 ;;*---------------------------------------------------------------------*/
1902 string))
1908 ;;*---------------------------------------------------------------------*/
1909 ;;* flyspell-abbrev-table ... */
1910 ;;*---------------------------------------------------------------------*/
1913 global-abbrev-table
1916 ;;*---------------------------------------------------------------------*/
1917 ;;* flyspell-define-abbrev ... */
1918 ;;*---------------------------------------------------------------------*/
1924 ;;*---------------------------------------------------------------------*/
1925 ;;* flyspell-auto-correct-word ... */
1926 ;;*---------------------------------------------------------------------*/
1928 "Correct the current word.
1929 This command proposes various successive corrections for the
1930 current word. If invoked repeatedly on the same position, it
1931 cycles through the possible corrections of the current word.
1933 See `flyspell-get-word' for details of how this finds the word to
1934 spell-check."
1936 ;; If we are not in the construct where flyspell should be active,
1937 ;; invoke the original binding of M-TAB, if that was recorded.
1947 ;; Use the correct dictionary.
1951 ;; We have already been using the function at the same location.
1963 flyspell-auto-correct-word)
1965 flyspell-auto-correct-word
1966 word)
1973 ;; Fetch the word to be checked.
1979 poss ispell-filter)
1981 ;; Now check spelling of word..
1984 ;; Wait until ispell has processed word.
1988 ;; Remove leading empty element.
1990 ;; Ispell process should return something after word is sent.
1991 ;; Tag word as valid (i.e., skip) otherwise.
1998 ;; Don't correct word.
1999 t)
2001 ;; Ispell error.
2004 ;; The word is incorrect, we have to propose a replacement.
2006 word)))
2014 ;; then save the current replacements
2022 replacements)
2031 word
2032 new-word)
2034 new-word)))
2040 old-max))))))))))
2044 ;;*---------------------------------------------------------------------*/
2045 ;;* flyspell-auto-correct-previous-pos ... */
2046 ;;*---------------------------------------------------------------------*/
2050 ;;*---------------------------------------------------------------------*/
2051 ;;* flyspell-auto-correct-previous-hook ... */
2052 ;;*---------------------------------------------------------------------*/
2054 "Hook to track successive calls to `flyspell-auto-correct-previous-word'.
2055 Sets `flyspell-auto-correct-previous-pos' to nil"
2061 ;;*---------------------------------------------------------------------*/
2062 ;;* flyspell-auto-correct-previous-word ... */
2063 ;;*---------------------------------------------------------------------*/
2065 "Auto correct the first misspelled word that occurs before point.
2066 But don't look beyond what's visible on the screen."
2080 ;; only reset if a new overlay exists
2086 ;; search for previous (new) flyspell overlay
2089 ;; check if its face has changed
2096 ;; if nothing new exits new-overlay should be nil
2108 ;; the point may have moved so reset this
2111 ;;*---------------------------------------------------------------------*/
2112 ;;* flyspell-correct-word ... */
2113 ;;*---------------------------------------------------------------------*/
2116 "Pop up a menu of possible corrections for a misspelled word.
2117 The word checked is the word at the mouse position."
2124 "Pop up a menu of possible corrections for misspelled word before point.
2125 If EVENT is non-nil, it is the mouse event that invoked this operation;
2126 that controls where to put the menu.
2127 If OPOINT is non-nil, restore point there after adjusting it for replacement."
2129 ;; use the correct dictionary
2138 poss ispell-filter)
2139 ;; now check spelling of word.
2142 ;; wait until ispell has processed word
2146 ;; Remove leading empty element
2148 ;; ispell process should return something after word is sent.
2149 ;; Tag word as valid (i.e., skip) otherwise
2156 ;; don't correct word
2157 t)
2159 ;; ispell error
2162 ;; The word is incorrect, we have to propose a replacement.
2164 poss word cursor-location start end opoint)))
2167 ;;*---------------------------------------------------------------------*/
2168 ;;* flyspell-do-correct ... */
2169 ;;*---------------------------------------------------------------------*/
2171 "The popup menu callback."
2174 nil)
2197 replace
2200 cursor-location)))
2210 nil)))
2212 ;;*---------------------------------------------------------------------*/
2213 ;;* flyspell-adjust-cursor-point ... */
2214 ;;*---------------------------------------------------------------------*/
2226 ;;*---------------------------------------------------------------------*/
2227 ;;* flyspell-emacs-popup ... */
2228 ;;*---------------------------------------------------------------------*/
2230 "The Emacs popup menu."
2235 mouse-pos
2246 corrects)
2247 '()))
2249 show-affix-info
2261 save)))
2265 ispell-dictionary))
2266 menu)))))
2268 ;;*---------------------------------------------------------------------*/
2269 ;;* Some example functions for real autocorrecting */
2270 ;;*---------------------------------------------------------------------*/
2272 "Check replacements for transposed characters.
2274 If the text between BEG and END is equal to a correction suggested by
2275 Ispell, after transposing two adjacent characters, correct the text,
2276 and return t.
2278 The third arg POSS is either the symbol `doublon' or a list of
2279 possible corrections as returned by `ispell-parse-output'.
2281 This function is meant to be added to `flyspell-incorrect-hook'."
2299 nil)))
2302 "Check replacements for doubled characters.
2304 If the text between BEG and END is equal to a correction suggested by
2305 Ispell, after removing a pair of doubled characters, correct the text,
2306 and return t.
2308 The third arg POSS is either the symbol `doublon' or a list of
2309 possible corrections as returned by `ispell-parse-output'.
2311 This function is meant to be added to `flyspell-incorrect-hook'."
2325 nil)))
2327 ;;*---------------------------------------------------------------------*/
2328 ;;* flyspell-already-abbrevp ... */
2329 ;;*---------------------------------------------------------------------*/
2334 ;;*---------------------------------------------------------------------*/
2335 ;;* flyspell-change-abbrev ... */
2336 ;;*---------------------------------------------------------------------*/
2342 ;;; flyspell.el ends here