1 ;;; ispell.el --- spell checking using Ispell
3 ;; Copyright (C) 1994, 1995, 1997 Free Software Foundation, Inc.
5 ;; Authors : Ken Stevens <k.stevens@ieee.org>
6 ;; Last Modified On: Tue Jun 13 12:05:28 EDT 1995
7 ;; Update Revision : 2.37
9 ;; Status : Release with 3.1.12+ ispell.
10 ;; Version : International Ispell Version 3.1 by Geoff Kuenning.
11 ;; Bug Reports : ispell-el-bugs@itcorp.com
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
30 ;; Note: version numbers and time stamp are not updated
31 ;; when this file is edited for release with GNU Emacs.
37 ;; This code contains a section of user-settable variables that you should
38 ;; inspect prior to installation. Look past the end of the history list.
39 ;; Set them up for your locale and the preferences of the majority of the
40 ;; users. Otherwise the users may need to set a number of variables
42 ;; You particularly may want to change the default dictionary for your
43 ;; country and language.
46 ;; To fully install this, add this file to your Emacs Lisp directory and
47 ;; compile it with M-X byte-compile-file. Then add the following to the
48 ;; appropriate init file:
50 ;; (autoload 'ispell-word "ispell"
51 ;; "Check the spelling of word in buffer." t)
52 ;; (global-set-key "\e$" 'ispell-word)
53 ;; (autoload 'ispell-region "ispell"
54 ;; "Check the spelling of region." t)
55 ;; (autoload 'ispell-buffer "ispell"
56 ;; "Check the spelling of buffer." t)
57 ;; (autoload 'ispell-complete-word "ispell"
58 ;; "Look up current word in dictionary and try to complete it." t)
59 ;; (autoload 'ispell-change-dictionary "ispell"
60 ;; "Change ispell dictionary." t)
61 ;; (autoload 'ispell-message "ispell"
62 ;; "Check spelling of mail message or news post.")
64 ;; Depending on the mail system you use, you may want to include these:
66 ;; (add-hook 'news-inews-hook 'ispell-message)
67 ;; (add-hook 'mail-send-hook 'ispell-message)
68 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
71 ;; Ispell has a TeX parser and a nroff parser (the default).
72 ;; The parsing is controlled by the variable ispell-parser. Currently
73 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
74 ;; added it will be updated. See the variable description for more info.
84 ;; ispell-complete-word
85 ;; ispell-complete-word-interior-frag
86 ;; ispell-change-dictionary
91 ;; Commands in ispell-region:
92 ;; Character replacement: Replace word with choice. May query-replace.
93 ;; ' ': Accept word this time.
94 ;; 'i': Accept word and insert into private dictionary.
95 ;; 'a': Accept word for this session.
96 ;; 'A': Accept word and place in buffer-local dictionary.
97 ;; 'r': Replace word with typed-in value. Rechecked.
98 ;; 'R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
99 ;; '?': Show these commands
100 ;; 'x': Exit spelling buffer. Move cursor to original point.
101 ;; 'X': Exit spelling buffer. Leave cursor at the current point.
102 ;; 'q': Quit spelling session (Kills ispell process).
103 ;; 'l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
104 ;; 'u': Like 'i', but the word is lower-cased first.
105 ;; 'm': Like 'i', but allows one to include dictionary completion info.
106 ;; 'C-l': redraws screen
107 ;; 'C-r': recursive edit
108 ;; 'C-z': suspend emacs or iconify frame
110 ;; Buffer-Local features:
111 ;; There are a number of buffer-local features that can be used to customize
112 ;; ispell for the current buffer. This includes language dictionaries,
113 ;; personal dictionaries, parsing, and local word spellings. Each of these
114 ;; local customizations are done either through local variables, or by
115 ;; including the keyword and argument(s) at the end of the buffer (usually
116 ;; prefixed by the comment characters). See the end of this file for
117 ;; examples. The local keywords and variables are:
119 ;; ispell-dictionary-keyword language-dictionary
120 ;; uses local variable ispell-local-dictionary
121 ;; ispell-pdict-keyword personal-dictionary
122 ;; uses local variable ispell-local-pdict
123 ;; ispell-parsing-keyword mode-arg extended-char-arg
124 ;; ispell-words-keyword any number of local word spellings
128 ;; Highlighting in version 19 still doesn't work on tty's.
129 ;; On some versions of emacs, growing the minibuffer fails.
133 ;; Revision 2.38 1996/5/30 ethanb@phys.washington.edu
134 ;; Update ispell-message for gnus 5 (news-inews-hook => message-send-hook;
135 ;; different header for quoted message).
137 ;; Revision 2.37 1995/6/13 12:05:28 stevens
138 ;; Removed autoload from ispell-dictionary-alist. *choices* mode-line shows
139 ;; misspelled word. Block skip for pgp & forwarded messages added.
140 ;; RMS: the autoload changes had problems and I removed them.
142 ;; Revision 2.36 1995/2/6 17:39:38 stevens
143 ;; Properly adjust screen with different ispell-choices-win-default-height
144 ;; settings. Skips SGML entity references.
146 ;; Revision 2.35 1995/1/13 14:16:46 stevens
147 ;; Skips SGML tags, ispell-change-dictionary fix for add-hook, assure personal
148 ;; dictionary is saved when called from the menu
150 ;; Revision 2.34 1994/12/08 13:17:41 stevens
151 ;; Interaction corrected to function with all 3.1 ispell versions.
153 ;; Revision 2.33 1994/11/24 02:31:20 stevens
154 ;; Repaired bug introduced in 2.32 that corrupts buffers when correcting.
155 ;; Improved buffer scrolling. Nondestructive buffer selections allowed.
157 ;; Revision 2.32 1994/10/31 21:10:08 geoff
158 ;; Many revisions accepted from RMS/FSF. I think (though I don't know) that
159 ;; this represents an 'official' version.
161 ;; Revision 2.31 1994/5/31 10:18:17 stevens
162 ;; Repaired comments. buffer-local commands executed in `ispell-word' now.
163 ;; German dictionary described for extended character mode. Dict messages.
165 ;; Revision 2.30 1994/5/20 22:18:36 stevens
166 ;; Continue ispell from ispell-word, C-z functionality fixed.
168 ;; Revision 2.29 1994/5/12 09:44:33 stevens
169 ;; Restored ispell-use-ptys-p, ispell-message aborts sends with interrupt.
172 ;; Revision 2.28 1994/4/28 16:24:40 stevens
173 ;; Window checking when ispell-message put on gnus-inews-article-hook jwz.
174 ;; prefixed ispell- to highlight functions and horiz-scroll fn.
175 ;; Try and respect case of word in ispell-complete-word.
176 ;; Ignore non-char events. Ispell-use-ptys-p commented out. Lucid menu.
177 ;; Better interrupt handling. ispell-message improvements from Ethan.
180 ;; version 18 explicit C-g handling disabled as it didn't work. Added
181 ;; ispell-extra-args for ispell customization (jwz)
183 ;; Revision 2.26 1994/2/15 16:11:14 stevens
184 ;; name changes for copyright assignment. Added word-frags in complete-word.
185 ;; Horizontal scroll (John Conover). Query-replace matches words now. bugs.
188 ;; minor mods, upgraded ispell-message
191 ;; query-replace more robust, messages, defaults, ispell-change-dict.
193 ;; Revision 2.23 1993/11/22 23:47:03 stevens
194 ;; ispell-message, Fixed highlighting, added menu-bar, fixed ispell-help, ...
197 ;; Added 'u' command. Fixed default in ispell-local-dictionary.
198 ;; fixed affix rules display. Tib skipping more robust. Contributions by
199 ;; Per Abraham (parser selection), Denis Howe, and Eberhard Mattes.
201 ;; Revision 2.21 1993/06/30 14:09:04 stevens
202 ;; minor bugs. (nroff word skipping fixed)
204 ;; Revision 2.20 1993/06/30 14:09:04 stevens
206 ;; Debugging and contributions by: Boris Aronov, Rik Faith, Chris Moore,
207 ;; Kevin Rodgers, Malcolm Davis.
208 ;; Particular thanks to Michael Lipp, Jamie Zawinski, Phil Queinnec
209 ;; and John Heidemann for suggestions and code.
210 ;; Major update including many tweaks.
211 ;; Many changes were integrations of suggestions.
212 ;; lookup-words rehacked to use call-process (Jamie).
213 ;; ispell-complete-word rehacked to be compatible with the rest of the
214 ;; system for word searching and to include multiple wildcards,
215 ;; and its own dictionary.
216 ;; query-replace capability added. New options 'X', 'R', and 'A'.
217 ;; buffer-local modes for dictionary, word-spelling, and formatter-parsing.
218 ;; Many random bugs, like commented comments being skipped, fix to
219 ;; keep-choices-win, fix for math mode, added pipe mode choice,
220 ;; fixed 'q' command, ispell-word checks previous word and leave cursor
221 ;; in same location. Fixed tib code which could drop spelling regions.
222 ;; Cleaned up setq calls for efficiency. Gave more context on window overlays.
223 ;; Assure context on ispell-command-loop. Window lossage in look cmd fixed.
224 ;; Due to pervasive opinion, common-lisp package syntax removed. Display
225 ;; problem when not highlighting.
227 ;; Revision 2.19 1992/01/10 10:54:08 geoff
228 ;; Make another attempt at fixing the "Bogus, dude" problem. This one is
229 ;; less elegant, but has the advantage of working.
231 ;; Revision 2.18 1992/01/07 10:04:52 geoff
232 ;; Fix the "Bogus, Dude" problem in ispell-word.
234 ;; Revision 2.17 1991/09/12 00:01:42 geoff
235 ;; Add some changes to make ispell-complete-word work better, though
236 ;; still not perfectly.
238 ;; Revision 2.16 91/09/04 18:00:52 geoff
239 ;; More updates from Sebastian, to make the multiple-dictionary support
242 ;; Revision 2.15 91/09/04 17:30:02 geoff
243 ;; Sebastian Kremer's tib support
245 ;; Revision 2.14 91/09/04 16:19:37 geoff
246 ;; Don't do set-window-start if the move-to-window-line moved us
247 ;; downward, rather than upward. This prevents getting the buffer all
248 ;; confused. Also, don't use the "not-modified" function to clear the
249 ;; modification flag; instead use set-buffer-modified-p. This prevents
250 ;; extra messages from flashing.
252 ;; Revision 2.13 91/09/04 14:35:41 geoff
253 ;; Fix a spelling error in a comment. Add code to handshake with the
254 ;; ispell process before sending anything to it.
256 ;; Revision 2.12 91/09/03 20:14:21 geoff
257 ;; Add Sebastian Kremer's multiple-language support.
261 ;; Texas Instruments - Computer Science Center
262 ;; ARPA: Buehring%TI-CSL@CSNet-Relay
263 ;; UUCP: {smu, texsun, im4u, rice} ! ti-csl ! buehring
265 ;; ispell-region and associated routines added by
268 ;; Tue Jan 13 20:18:02 CST 1987
270 ;; extensively modified by Mark Davies and Andrew Vignaux
271 ;; {mark,andrew}@vuwcomp
272 ;; Sun May 10 11:45:04 NZST 1987
274 ;; Ken Stevens ARPA: k.stevens@ieee.org
275 ;; Tue Jan 3 16:59:07 PST 1989
276 ;; This file has overgone a major overhaul to be compatible with ispell
277 ;; version 2.1. Most of the functions have been totally rewritten, and
278 ;; many user-accessible variables have been added. The syntax table has
279 ;; been removed since it didn't work properly anyway, and a filter is
280 ;; used rather than a buffer. Regular expressions are used based on
281 ;; ispell's internal definition of characters (see ispell(4)).
283 ;; - Updated to version 3.0 to include terse processing.
284 ;; - Added a variable for the look command.
285 ;; - Fixed a bug in ispell-word when cursor is far away from the word
286 ;; that is to be checked.
287 ;; - Ispell places the incorrect word or guess in the minibuffer now.
288 ;; - fixed a bug with 'l' option when multiple windows are on the screen.
289 ;; - lookup-words just didn't work with the process filter. Fixed.
290 ;; - Rewrote the process filter to make it cleaner and more robust
291 ;; in the event of a continued line not being completed.
292 ;; - Made ispell-init-process more robust in handling errors.
293 ;; - Fixed bug in continuation location after a region has been modified by
294 ;; correcting a misspelling.
297 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
298 ;; Wed Aug 7 14:02:17 MET DST 1991
299 ;; - Ported ispell-complete-word from Ispell 2 to Ispell 3.
300 ;; - Added ispell-kill-ispell command.
301 ;; - Added ispell-dictionary and ispell-dictionary-alist variables to
302 ;; support other than default language. See their docstrings and
303 ;; command ispell-change-dictionary.
304 ;; - (ispelled it :-)
305 ;; - Added ispell-skip-tib variable to support the tib bibliography
309 ;; **********************************************************************
310 ;; The following variables should be set according to personal preference
311 ;; and location of binaries:
312 ;; **********************************************************************
314 ;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1
319 "Spell checking using ispell"
323 (defcustom ispell-highlight-p t
324 "*Highlight spelling errors when non-nil."
328 (defcustom ispell-highlight-face 'highlight
329 "*The face used for Ispell highlighting. For Emacses with overlays.
330 Possible values are `highlight', `modeline', `secondary-selection',
331 `region', and `underline'.
332 This variable can be set by the user to whatever face they desire.
333 It's most convenient if the cursor color and highlight color are
338 (defcustom ispell-check-comments t
339 "*If nil, don't check spelling of comments."
343 (defcustom ispell-query-replace-choices nil
344 "*Corrections made throughout region when non-nil.
345 Uses `query-replace' (\\[query-replace]) for corrections."
349 (defcustom ispell-skip-tib nil
350 "*Does not spell check `tib' bibliography references when non-nil.
351 Skips any text between strings matching regular expressions
352 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
354 TeX users beware: Any field starting with [. will skip until a .] -- even
355 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
356 a [.5mm] type of number...."
360 (defvar ispell-tib-ref-beginning "[[<]\\."
361 "Regexp matching the beginning of a Tib reference.")
363 (defvar ispell-tib-ref-end "\\.[]>]"
364 "Regexp matching the end of a Tib reference.")
366 (defcustom ispell-keep-choices-win t
367 "*When not nil, the `*Choices*' window remains for spelling session.
368 This minimizes redisplay thrashing."
372 (defcustom ispell-choices-win-default-height 2
373 "*The default size of the `*Choices*' window, including status line.
374 Must be greater than 1."
378 (defcustom ispell-program-name "ispell"
379 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
383 (defcustom ispell-alternate-dictionary
384 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
385 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
386 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
387 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
388 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
389 ((file-exists-p "/sys/dict") "/sys/dict")
390 (t "/usr/dict/words"))
391 "*Alternate dictionary for spelling help."
395 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
396 "*Dictionary used for word completion."
400 (defvar ispell-grep-command "egrep"
401 "Name of the grep command for search processes.")
403 (defvar ispell-grep-options "-i"
404 "String of options to use when running the program in `ispell-grep-command'.
405 Should probably be \"-i\" or \"-e\".
406 Some machines (like the NeXT) don't support \"-i\"")
408 (defvar ispell-look-command "look"
409 "Name of the look command for search processes.
410 This must be an absolute file name.")
412 (defcustom ispell-look-p (file-exists-p ispell-look-command)
413 "*Non-nil means use `look' rather than `grep'.
414 Default is based on whether `look' seems to be available."
418 (defcustom ispell-have-new-look nil
419 "*Non-nil means use the `-r' option (regexp) when running `look'."
423 (defvar ispell-look-options (if ispell-have-new-look "-dfr" "-df")
424 "String of command options for `ispell-look-command'.")
426 (defvar ispell-use-ptys-p nil
427 "When non-nil, Emacs uses ptys to communicate with Ispell.
428 When nil, Emacs uses pipes.")
430 (defcustom ispell-following-word nil
431 "*Non-nil means `ispell-word' checks the word around or after point.
432 Otherwise `ispell-word' checks the preceding word."
436 (defcustom ispell-help-in-bufferp nil
437 "*Non-nil means display interactive keymap help in a buffer.
438 Otherwise use the minibuffer."
442 (defcustom ispell-quietly nil
443 "*Non-nil means suppress messages in `ispell-word'."
447 (defcustom ispell-format-word (function upcase)
448 "*Formatting function for displaying word being spell checked.
449 The function must take one string argument and return a string."
454 (defcustom ispell-personal-dictionary nil
455 "*File name of your personal spelling dictionary, or nil.
456 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
457 where DICTNAME is the name of your default dictionary."
459 (const :tag "default" nil))
462 (defcustom ispell-silently-savep nil
463 "*When non-nil, save the personal dictionary without confirmation."
467 ;;; This variable contains the current dictionary being used if the ispell
468 ;;; process is running. Otherwise it contains the global default.
469 (defvar ispell-dictionary nil
470 "If non-nil, a dictionary to use instead of the default one.
471 This is passed to the ispell process using the `-d' switch and is
472 used as key in `ispell-dictionary-alist' (which see).
474 You should set this variable before your first use of Emacs spell-checking
475 commands in the Emacs session, or else use the \\[ispell-change-dictionary]
476 command to change it. Otherwise, this variable only takes effect in a newly
477 started Ispell process.")
479 (defcustom ispell-extra-args nil
480 "*If non-nil, a list of extra switches to pass to the Ispell program.
481 For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
482 words as correct. See also `ispell-dictionary-alist', which may be used
483 for language-specific arguments."
484 :type '(repeat string)
487 ;;; The preparation of the menu bar menu must be autoloaded
488 ;;; because otherwise this file gets autoloaded every time Emacs starts
489 ;;; so that it can set up the menus and determine keyboard equivalents.
492 (defvar ispell-dictionary-alist-1 ; sk 9-Aug-1991 18:28
493 '((nil ; default (english.aff)
494 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
495 ("english" ; make English explicitly selectable
496 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
497 ("british" ; British version
498 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "british") nil)
499 ("american" ; American version
500 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "american") nil)
501 ("deutsch" ; deutsch.aff
502 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex")
504 "[a-zA-Z\304\326\334\344\366\337\374]"
505 "[^a-zA-Z\304\326\334\344\366\337\374]"
506 "[']" t ("-C" "-d" "deutsch") "~latin1" iso-latin-1)
507 ("nederlands" ; nederlands.aff
508 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
509 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
510 "[']" t ("-C") nil iso-latin-1)
511 ("nederlands8" ; dutch8.aff
512 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
513 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
514 "[']" t ("-C") nil iso-latin-1)))
517 (defvar ispell-dictionary-alist-2
518 '(("svenska" ;7 bit swedish mode
519 "[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
520 "[']" nil ("-C") nil)
521 ("svenska8" ;8 bit swedish mode
522 "[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
523 "[']" nil ("-C" "-d" "svenska") "~list" ; Add `"-T" "list"' instead?
526 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil)
527 ("francais" ; francais.aff
528 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
529 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
530 "[---']" t nil "~list" iso-latin-1)
531 ("francais-tex" ; francais.aff
532 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
533 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
534 "[---'^`\"]" t nil "~tex" iso-latin-1)
536 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
537 "[']" nil ("-C") nil iso-latin-1)
541 ;;; ispell-dictionary-alist is set up from two subvariables above
542 ;;; to avoid having very long lines in loaddefs.el.
544 (defvar ispell-dictionary-alist
545 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2)
546 "An alist of dictionaries and their associated parameters.
548 Each element of this list is also a list:
550 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
551 ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
553 DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
554 means the default dictionary.
556 CASECHARS is a regular expression of valid characters that comprise a
559 NOT-CASECHARS is the opposite regexp of CASECHARS.
561 OTHERCHARS are characters in the NOT-CASECHARS set but which can be used to
562 construct words in some special way. If OTHERCHARS characters follow and
563 precede characters from CASECHARS, they are parsed as part of a word,
564 otherwise they become word-breaks. As an example in English, assume the
565 set ['] (as a regular expression) for OTHERCHARS. Then \"they're\" and
566 \"Steven's\" are parsed as single words including the \"'\" character, but
567 \"Stevens'\" does not include the quote character as part of the word.
568 If you want OTHERCHARS to be empty, use nil.
569 Hint: regexp syntax requires the hyphen to be declared first here.
571 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
572 Otherwise only a single OTHERCHARS character is allowed to be part of any
575 ISPELL-ARGS is a list of additional arguments passed to the ispell
578 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
579 have been configured in an Ispell affix file. (For example, umlauts
580 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
581 in English. This has the same effect as the command-line `-T' option.
582 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
583 but the dictionary can control the extended character mode.
584 Both defaults can be overruled in a buffer-local fashion. See
585 `ispell-parsing-keyword' for details on this.
587 Note that the CASECHARS and OTHERCHARS slots of the alist should
588 contain the same character set as casechars and otherchars in the
589 language.aff file \(e.g., english.aff\).")
592 (defvar ispell-menu-map nil "Key map for ispell menu")
595 (defvar ispell-menu-lucid nil "Spelling menu for Lucid Emacs.")
597 ;;; Break out lucid menu and split into several calls to avoid having
598 ;;; long lines in loaddefs.el. Detect need off following constant.
601 (defconst ispell-menu-map-needed ; make sure this is not Lucid Emacs
602 (and (not ispell-menu-map)
603 ;;; This is commented out because it fails in Emacs.
604 ;;; due to the fact that menu-bar is loaded much later than loaddefs.
605 ;;; ;; make sure this isn't Lucid Emacs
606 ;;; (featurep 'menu-bar)
607 (not (string-match "Lucid" emacs-version))))
609 ;;; Set up dictionary
611 (if ispell-menu-map-needed
612 (let ((dicts (reverse (cons (cons "default" nil) ispell-dictionary-alist)))
614 (setq ispell-menu-map (make-sparse-keymap "Spell"))
615 ;; add the dictionaries to the bottom of the list.
617 (setq name (car (car dicts))
620 (define-key ispell-menu-map (vector (intern name))
621 (cons (concat "Select " (capitalize name))
622 (list 'lambda () '(interactive)
623 (list 'ispell-change-dictionary name))))))))
625 ;;; define commands in menu in opposite order you want them to appear.
627 (if ispell-menu-map-needed
629 (define-key ispell-menu-map [ispell-change-dictionary]
630 '("Change Dictionary" . ispell-change-dictionary))
631 (define-key ispell-menu-map [ispell-kill-ispell]
632 '("Kill Process" . ispell-kill-ispell))
633 (define-key ispell-menu-map [ispell-pdict-save]
634 '("Save Dictionary" . (lambda () (interactive) (ispell-pdict-save t t))))
635 (define-key ispell-menu-map [ispell-complete-word]
636 '("Complete Word" . ispell-complete-word))
637 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
638 '("Complete Word Frag" . ispell-complete-word-interior-frag))))
641 (if ispell-menu-map-needed
643 (define-key ispell-menu-map [ispell-continue]
644 '("Continue Check" . ispell-continue))
645 (define-key ispell-menu-map [ispell-word]
646 '("Check Word" . ispell-word))
647 (define-key ispell-menu-map [ispell-region]
648 '("Check Region" . ispell-region))
649 (define-key ispell-menu-map [ispell-buffer]
650 '("Check Buffer" . ispell-buffer))))
653 (if ispell-menu-map-needed
655 (define-key ispell-menu-map [ispell-message]
656 '("Check Message" . ispell-message))
657 (define-key ispell-menu-map [ispell-help]
658 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
659 '("Help" . (lambda () (interactive) (describe-function 'ispell-help))))
660 (put 'ispell-region 'menu-enable 'mark-active)
661 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
663 ;;; Xemacs version 19
664 (if (and (string-lessp "19" emacs-version)
665 (string-match "Lucid" emacs-version))
666 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
667 (current-menubar (or current-menubar default-menubar))
669 '(["Help" (describe-function 'ispell-help) t]
670 ;;["Help" (popup-menu ispell-help-list) t]
671 ["Check Message" ispell-message t]
672 ["Check Buffer" ispell-buffer t]
673 ["Check Word" ispell-word t]
674 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
675 ["Continue Check" ispell-continue t]
676 ["Complete Word Frag"ispell-complete-word-interior-frag t]
677 ["Complete Word" ispell-complete-word t]
678 ["Kill Process" ispell-kill-ispell t]
680 ["Save Dictionary" (ispell-pdict-save t t) t]
681 ["Change Dictionary" ispell-change-dictionary t]))
684 (setq name (car (car dicts))
687 (setq menu (append menu
689 (vector (concat "Select " (capitalize name))
690 (list 'ispell-change-dictionary name)
692 (setq ispell-menu-lucid menu)
695 (delete-menu-item '("Edit" "Spell")) ; in case already defined
696 (add-menu '("Edit") "Spell" ispell-menu-lucid)))))
699 ;;; **********************************************************************
700 ;;; The following are used by ispell, and should not be changed.
701 ;;; **********************************************************************
704 ;;; The version must be 3.1 or greater for this version of ispell.el
705 ;;; There is an incompatibility between version 3.1.12 and lower versions.
706 (defconst ispell-required-version '("3.1." 12)
707 "Ispell versions with which this version of ispell.el is known to work.")
708 (defvar ispell-offset 1
709 "Offset that maps protocol differences between ispell 3.1 versions.")
711 (defun ispell-decode-string (str)
713 (if (and enable-multibyte-characters
714 (setq coding-system (ispell-get-coding-system)))
715 (decode-coding-string str coding-system)
718 (defun ispell-get-casechars ()
719 (ispell-decode-string
720 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist))))
721 (defun ispell-get-not-casechars ()
722 (ispell-decode-string
723 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist))))
724 (defun ispell-get-otherchars ()
725 (ispell-decode-string
726 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist))))
727 (defun ispell-get-many-otherchars-p ()
728 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
729 (defun ispell-get-ispell-args ()
730 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
731 (defun ispell-get-extended-character-mode ()
732 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
733 (defun ispell-get-coding-system ()
734 (nth 7 (assoc ispell-dictionary ispell-dictionary-alist)))
736 (defvar ispell-process nil
737 "The process object for Ispell.")
739 (defvar ispell-pdict-modified-p nil
740 "Non-nil means personal dictionary has modifications to be saved.")
742 ;;; If you want to save the dictionary when quitting, must do so explicitly.
743 ;;; When non-nil, the spell session is terminated.
744 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
745 (defvar ispell-quit nil)
747 (defvar ispell-filter nil
748 "Output filter from piped calls to Ispell.")
750 (defvar ispell-filter-continue nil
751 "Control variable for Ispell filter function.")
753 (defvar ispell-process-directory nil
754 "The directory where `ispell-process' was started.")
756 (defvar ispell-query-replace-marker (make-marker)
757 "Marker for `query-replace' processing.")
759 (defvar ispell-checking-message nil
760 "Non-nil when we're checking a mail message")
762 (defconst ispell-choices-buffer "*Choices*")
764 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
766 ;;; *** Buffer Local Definitions ***
768 ;;; This is the local dictionary to use. When nil the default dictionary will
769 ;;; be used. Do not redefine default value or it will override the global!
770 (defvar ispell-local-dictionary nil
771 "If non-nil, a dictionary to use for Ispell commands in this buffer.
772 The value must be a string dictionary name in `ispell-dictionary-alist'.
773 This variable becomes buffer-local when set in any fashion.
775 Setting ispell-local-dictionary to a value has the same effect as
776 calling \\[ispell-change-dictionary] with that value. This variable
777 is automatically set when defined in the file with either
778 `ispell-dictionary-keyword' or the Local Variable syntax.")
780 (make-variable-buffer-local 'ispell-local-dictionary)
782 ;; Use default directory, unless locally set.
783 (set-default 'ispell-local-dictionary nil)
785 (defconst ispell-words-keyword "LocalWords: "
786 "The keyword for local oddly-spelled words to accept.
787 The keyword will be followed by any number of local word spellings.
788 There can be multiple of these keywords in the file.")
790 (defconst ispell-dictionary-keyword "Local IspellDict: "
791 "The keyword for local dictionary definitions.
792 There should be only one dictionary keyword definition per file, and it
793 should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
795 (defconst ispell-parsing-keyword "Local IspellParsing: "
796 "The keyword for overriding default Ispell parsing.
797 Determined by the buffer's major mode and extended-character mode as well as
798 the default dictionary.
800 The above keyword string should be followed by `latex-mode' or
801 `nroff-mode' to put the current buffer into the desired parsing mode.
803 Extended character mode can be changed for this buffer by placing
804 a `~' followed by an extended-character mode -- such as `~.tex'.")
806 (defvar ispell-skip-sgml nil
807 "Skips spell checking of SGML tags and entity references when non-nil.
808 This variable is set when major-mode is sgml-mode or html-mode.")
810 (defvar ispell-local-pdict ispell-personal-dictionary
811 "A buffer local variable containing the current personal dictionary.
812 If non-nil, the value must be a string, which is a file name.
814 If you specify a personal dictionary for the current buffer which is
815 different from the current personal dictionary, the effect is similar
816 to calling \\[ispell-change-dictionary]. This variable is automatically
817 set when defined in the file with either `ispell-pdict-keyword' or the
818 local variable syntax.")
820 (make-variable-buffer-local 'ispell-local-pdict)
822 (defconst ispell-pdict-keyword "Local IspellPersDict: "
823 "The keyword for defining buffer local dictionaries.")
825 (defvar ispell-buffer-local-name nil
826 "Contains the buffer name if local word definitions were used.
827 Ispell is then restarted because the local words could conflict.")
829 (defvar ispell-parser 'use-mode-name
830 "*Indicates whether ispell should parse the current buffer as TeX Code.
831 Special value `use-mode-name' tries to guess using the name of major-mode.
832 Default parser is 'nroff.
833 Currently the only other valid parser is 'tex.
835 You can set this variable in hooks in your init file -- eg:
837 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
839 (defvar ispell-region-end (make-marker)
840 "Marker that allows spelling continuations.")
842 (defvar ispell-check-only nil
843 "If non-nil, `ispell-word' does not try to correct the word.")
846 ;;; **********************************************************************
847 ;;; **********************************************************************
850 (and (string-lessp "19" emacs-version)
851 (not (boundp 'epoch::version))
852 (defalias 'ispell 'ispell-buffer))
855 (define-key global-map "\M-$" 'ispell-word)
858 (defun ispell-word (&optional following quietly continue)
859 "Check spelling of word under or before the cursor.
860 If the word is not found in dictionary, display possible corrections
861 in a window allowing you to choose one.
863 With a prefix argument (or if CONTINUE is non-nil),
864 resume interrupted spell-checking of a buffer or region.
866 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
867 is non-nil when called interactively, then the following word
868 \(rather than preceding\) is checked when the cursor is not over a word.
869 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
870 when called interactively, non-corrective messages are suppressed.
872 Word syntax described by `ispell-dictionary-alist' (which see).
874 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
875 or \\[ispell-region] to update the Ispell process."
876 (interactive (list nil nil current-prefix-arg))
880 (setq following ispell-following-word
881 quietly ispell-quietly))
882 (ispell-accept-buffer-local-defs) ; use the correct dictionary
883 (let ((cursor-location (point)) ; retain cursor location
884 (word (ispell-get-word following))
885 start end poss replace)
886 ;; destructure return word info list.
887 (setq start (car (cdr word))
888 end (car (cdr (cdr word)))
891 ;; now check spelling of word.
893 (message "Checking spelling of %s..."
894 (funcall ispell-format-word word)))
895 (process-send-string ispell-process "%\n") ;put in verbose mode
896 (process-send-string ispell-process (concat "^" word "\n"))
897 ;; wait until ispell has processed word
899 (accept-process-output ispell-process)
900 (not (string= "" (car ispell-filter)))))
901 ;;(process-send-string ispell-process "!\n") ;back to terse mode.
902 (setq ispell-filter (cdr ispell-filter))
903 (if (listp ispell-filter)
904 (setq poss (ispell-parse-output (car ispell-filter))))
907 (message "%s is correct" (funcall ispell-format-word word))))
910 (message "%s is correct because of root %s"
911 (funcall ispell-format-word word)
912 (funcall ispell-format-word poss))))
913 ((null poss) (message "Error in ispell process"))
914 (ispell-check-only ; called from ispell minor mode.
916 (t ; prompt for correct word.
917 (save-window-excursion
918 (setq replace (ispell-command-loop
919 (car (cdr (cdr poss)))
920 (car (cdr (cdr (cdr poss))))
921 (car poss) start end)))
922 (cond ((equal 0 replace)
923 (ispell-add-per-file-word-list (car poss)))
925 (setq word (if (atom replace) replace (car replace))
926 cursor-location (+ (- (length word) (- end start))
928 (if (not (equal word (car poss)))
930 (delete-region start end)
932 (if (not (atom replace)) ; recheck spelling of replacement
934 (goto-char cursor-location)
935 (ispell-word following quietly)))))
936 (if (get-buffer ispell-choices-buffer)
937 (kill-buffer ispell-choices-buffer))))
938 (goto-char cursor-location) ; return to original location
939 (ispell-pdict-save ispell-silently-savep)
940 (if ispell-quit (setq ispell-quit nil)))))
943 (defun ispell-get-word (following &optional extra-otherchars)
944 "Return the word for spell-checking according to ispell syntax.
945 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
946 is non-nil when called interactively, then the following word
947 \(rather than preceding\) is checked when the cursor is not over a word.
948 Optional second argument contains otherchars that can be included in word
951 Word syntax described by `ispell-dictionary-alist' (which see)."
952 (let* ((ispell-casechars (ispell-get-casechars))
953 (ispell-not-casechars (ispell-get-not-casechars))
954 (ispell-otherchars (ispell-get-otherchars))
955 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
956 (word-regexp (concat ispell-casechars
961 (concat extra-otherchars "?"))
964 (if (or ispell-many-otherchars-p
970 (if (not (looking-at ispell-casechars))
972 (re-search-forward ispell-casechars (point-max) t)
973 (re-search-backward ispell-casechars (point-min) t)))
974 ;; move to front of word
975 (re-search-backward ispell-not-casechars (point-min) 'start)
976 (while (and (or (looking-at ispell-otherchars)
977 (and extra-otherchars (looking-at extra-otherchars)))
979 (or (not did-it-once)
980 ispell-many-otherchars-p))
981 (if (and extra-otherchars (looking-at extra-otherchars))
984 (if (looking-at ispell-casechars)
985 (re-search-backward ispell-not-casechars (point-min) 'move)))
988 (if (looking-at ispell-casechars)
989 (re-search-backward ispell-not-casechars (point-min) 'move)
990 (backward-char -1))))
991 ;; Now mark the word and save to string.
992 (or (re-search-forward word-regexp (point-max) t)
993 (error "No word found to check!"))
994 (setq start (match-beginning 0)
996 word (buffer-substring start end))
997 (list word start end)))
1000 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1001 ;;; tracks changes in the dictionary. The global may either be
1002 ;;; a value or a list, whose value is the state of whether the
1003 ;;; dictionary needs to be saved.
1005 (defun ispell-pdict-save (&optional no-query force-save)
1006 "Check to see if the personal dictionary has been modified.
1007 If so, ask if it needs to be saved."
1008 (interactive (list ispell-silently-savep t))
1009 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1010 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1011 (if (or ispell-pdict-modified-p force-save)
1012 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1014 (process-send-string ispell-process "#\n")
1015 (message "Personal dictionary saved."))))
1016 ;; unassert variable, even if not saved to avoid questioning.
1017 (setq ispell-pdict-modified-p nil))
1020 (defun ispell-command-loop (miss guess word start end)
1021 "Display possible corrections from list MISS.
1022 GUESS lists possibly valid affix construction of WORD.
1023 Returns nil to keep word.
1024 Returns 0 to insert locally into buffer-local dictionary.
1025 Returns string for new chosen word.
1026 Returns list for new replacement word (will be rechecked).
1027 Highlights the word, which is assumed to run from START to END.
1028 Global `ispell-pdict-modified-p' becomes a list where the only value
1029 indicates whether the dictionary has been modified when option `a' or `i' is
1031 (let ((textbuf (current-buffer))
1034 (max-lines (- (window-height) 4)) ; assure 4 context lines.
1036 (window-min-height (min window-min-height
1037 ispell-choices-win-default-height))
1038 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1040 (window (selected-window))
1041 (dedicated (window-dedicated-p (selected-window)))
1042 char num result textwin highlighted)
1044 ;; setup the *Choices* buffer with valid data.
1046 (set-buffer (get-buffer-create ispell-choices-buffer))
1047 (setq mode-line-format (concat "-- %b -- word: " word))
1051 (insert "Affix rules generate and capitalize "
1052 "this word as shown below:\n\t")
1054 (if (> (+ 4 (current-column) (length (car guess)))
1058 (setq line (1+ line))))
1059 (insert (car guess) " ")
1060 (setq guess (cdr guess)))
1061 (insert "\nUse option `i' if this is a correct composition"
1062 " from the derivative root.\n")
1063 (setq line (+ line (if choices 3 2)))))
1065 (< (if (> (+ 7 (current-column) (length (car choices))
1066 (if (> count ?~) 3 0))
1070 (setq line (1+ line)))
1073 ;; not so good if there are over 20 or 30 options, but then, if
1074 ;; there are that many you don't want to scan them all anyway...
1075 (while (memq count command-characters) ; skip command characters.
1076 (setq count (1+ count)
1077 skipped (1+ skipped)))
1078 (insert "(" count ") " (car choices) " ")
1079 (setq choices (cdr choices)
1081 (setq count (- count ?0 skipped)))
1083 ;; Assure word is visible
1084 (if (not (pos-visible-in-window-p end))
1086 ;; Display choices for misspelled word.
1087 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1089 (if (= line (window-height choices-window))
1090 (select-window choices-window)
1091 ;; *Choices* window changed size. Adjust the choices window
1092 ;; without scrolling the spelled window when possible
1093 (let ((window-line (- line (window-height choices-window)))
1094 (visible (progn (forward-line -1) (point))))
1095 (if (< line ispell-choices-win-default-height)
1096 (setq window-line (+ window-line
1097 (- ispell-choices-win-default-height
1099 (move-to-window-line 0)
1100 (forward-line window-line)
1101 (set-window-start (selected-window)
1102 (if (> (point) visible) visible (point)))
1104 (select-window (previous-window)) ; *Choices* window
1105 (enlarge-window window-line)))
1106 ;; Overlay *Choices* window when it isn't showing
1107 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1108 (switch-to-buffer ispell-choices-buffer)
1109 (goto-char (point-min)))
1111 (select-window (setq textwin (next-window)))
1113 ;; highlight word, protecting current buffer status
1116 (if ispell-highlight-p
1117 (ispell-highlight-spelling-error start end t))
1118 ;; Loop until a valid choice is made.
1126 (let (message-log-max)
1127 (message (concat "C-h or ? for more options; SPC to leave "
1128 "unchanged, Character to replace word")))
1129 (let ((inhibit-quit t))
1130 (setq char (if (fboundp 'read-char-exclusive)
1131 (read-char-exclusive)
1134 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1137 ;; Adjust num to array offset skipping command characters.
1138 (let ((com-chars command-characters))
1140 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1141 (setq skipped (1+ skipped)))
1142 (setq com-chars (cdr com-chars)))
1143 (setq num (- char ?0 skipped)))
1146 ((= char ? ) nil) ; accept word this time only
1147 ((= char ?i) ; accept and insert word into pers dict
1148 (process-send-string ispell-process (concat "*" word "\n"))
1149 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1151 ((or (= char ?a) (= char ?A)) ; accept word without insert
1152 (process-send-string ispell-process (concat "@" word "\n"))
1153 (if (null ispell-pdict-modified-p)
1154 (setq ispell-pdict-modified-p
1155 (list ispell-pdict-modified-p)))
1156 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1157 ((or (= char ?r) (= char ?R)) ; type in replacement
1158 (if (or (= char ?R) ispell-query-replace-choices)
1159 (list (read-string "Query-replacement for: " word) t)
1160 (cons (read-string "Replacement for: " word) nil)))
1161 ((or (= char ??) (= char help-char) (= char ?\C-h))
1164 ;; Quit and move point back.
1166 (ispell-pdict-save ispell-silently-savep)
1167 (message "Exited spell-checking")
1168 (setq ispell-quit t)
1170 ;; Quit and preserve point.
1172 (ispell-pdict-save ispell-silently-savep)
1174 (substitute-command-keys
1175 (concat "Spell-checking suspended;"
1176 " use C-u \\[ispell-word] to resume")))
1177 (setq ispell-quit (max (point-min)
1178 (- (point) (length word))))
1181 (if (y-or-n-p "Really kill Ispell process? ")
1183 (ispell-kill-ispell t) ; terminate process.
1184 (setq ispell-quit (or (not ispell-checking-message)
1186 ispell-pdict-modified-p nil))
1187 t)) ; continue if they don't quit.
1189 (let ((new-word (read-string
1190 "Lookup string (`*' is wildcard): "
1196 (set-buffer (get-buffer-create
1197 ispell-choices-buffer))
1201 mode-line-format (concat
1204 miss (lookup-words new-word)
1206 (while (and choices ; adjust choices window.
1207 (< (if (> (+ 7 (current-column)
1208 (length (car choices))
1209 (if (> count ?~) 3 0))
1217 (while (memq count command-characters)
1218 (setq count (1+ count)
1219 skipped (1+ skipped)))
1220 (insert "(" count ") " (car choices) " ")
1221 (setq choices (cdr choices)
1223 (setq count (- count ?0 skipped)))
1224 (select-window (previous-window))
1225 (if (and (/= new-line line)
1226 (> (max line new-line)
1227 ispell-choices-win-default-height))
1228 (let* ((minh ispell-choices-win-default-height)
1229 (gr-bl (if (< line minh) ; blanks
1232 (shr-bl (if (< new-line minh) ; blanks
1235 (if (> new-line line)
1236 (enlarge-window (- new-line line gr-bl))
1237 (shrink-window (- line new-line shr-bl)))
1238 (setq line new-line)))
1239 (select-window (next-window)))))
1240 t) ; reselect from new choices
1242 (process-send-string ispell-process
1243 (concat "*" (downcase word) "\n"))
1244 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1246 ((= char ?m) ; type in what to insert
1247 (process-send-string
1248 ispell-process (concat "*" (read-string "Insert: " word)
1250 (setq ispell-pdict-modified-p '(t))
1252 ((and (>= num 0) (< num count))
1253 (if ispell-query-replace-choices ; Query replace flag
1254 (list (nth num miss) 'query-replace)
1259 (save-window-excursion (recursive-edit)) t)
1261 (funcall (key-binding "\C-z"))
1266 (if ispell-highlight-p ; unhighlight
1267 (save-window-excursion
1268 (select-window textwin)
1269 (ispell-highlight-spelling-error start end)))
1270 (set-window-dedicated-p window dedicated))))
1274 (defun ispell-help ()
1275 "Display a list of the options available when a misspelling is encountered.
1279 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1280 SPC: Accept word this time.
1281 `i': Accept word and insert into private dictionary.
1282 `a': Accept word for this session.
1283 `A': Accept word and place in `buffer-local dictionary'.
1284 `r': Replace word with typed-in value. Rechecked.
1285 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1286 `?': Show these commands.
1287 `x': Exit spelling buffer. Move cursor to original point.
1288 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1289 the aborted check to be completed later.
1290 `q': Quit spelling session (Kills ispell process).
1291 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1292 `u': Like `i', but the word is lower-cased first.
1293 `m': Like `i', but allows one to include dictionary completion information.
1294 `C-l': redraws screen
1295 `C-r': recursive edit
1296 `C-z': suspend emacs or iconify frame"
1298 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1299 "[i]nsert into private dictionary"))
1300 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1301 "e[x/X]it; [q]uit session"))
1302 (help-3 (concat "[u]ncapitalized insert into dictionary. "
1303 "Type 'C-h d ispell-help' for more help")))
1304 (save-window-excursion
1305 (if ispell-help-in-bufferp
1307 (ispell-overlay-window 4)
1308 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1309 (insert (concat help-1 "\n" help-2 "\n" help-3))
1311 (kill-buffer "*Ispell Help*"))
1312 (select-window (minibuffer-window))
1313 ;;(enlarge-window 2)
1315 (cond ((string-match "Lucid" emacs-version)
1321 (goto-char (point-min)))
1323 (if (string-lessp "19" emacs-version)
1326 ;; Make sure we display the minibuffer
1327 ;; in this window, not some other.
1328 (set-minibuffer-window (selected-window))
1329 (insert (concat help-1 "\n" help-2 "\n" help-3))))
1334 (defun lookup-words (word &optional lookup-dict)
1335 "Look up word in word-list dictionary.
1336 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1337 Otherwise the variable `ispell-grep-command' contains the command used to
1338 search for the words (usually egrep).
1340 Optional second argument contains the dictionary to use; the default is
1341 `ispell-alternate-dictionary'."
1342 ;; We don't use the filter for this function, rather the result is written
1343 ;; into a buffer. Hence there is no need to save the filter values.
1344 (if (null lookup-dict)
1345 (setq lookup-dict ispell-alternate-dictionary))
1347 (let* ((process-connection-type ispell-use-ptys-p)
1348 (wild-p (string-match "\\*" word))
1349 (look-p (and ispell-look-p ; Only use look for an exact match.
1350 (or ispell-have-new-look (not wild-p))))
1351 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1352 (prog (if look-p ispell-look-command ispell-grep-command))
1353 (args (if look-p ispell-look-options ispell-grep-options))
1356 (save-window-excursion
1357 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1358 (set-buffer ispell-grep-buffer)
1362 (insert "^" word "$")
1363 (while (search-backward "*" nil t) (insert "."))
1364 (setq word (buffer-string))
1366 (setq status (call-process prog nil t nil args word lookup-dict))
1367 ;; grep returns status 1 and no output when word not found, which
1368 ;; is a perfectly normal thing.
1369 (if (stringp status)
1370 (setq results (cons (format "error: %s exited with signal %s"
1371 (file-name-nondirectory prog) status)
1373 ;; else collect words into `results' in FIFO order
1374 (goto-char (point-max))
1375 ;; assure we've ended with \n
1376 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1380 (setq results (cons (buffer-substring (point) (1- loc))
1383 (kill-buffer ispell-grep-buffer)
1384 (if (and results (string-match ".+: " (car results)))
1385 (error "%s error: %s" ispell-grep-command (car results))))
1389 ;;; "ispell-filter" is a list of output lines from the generating function.
1390 ;;; Each full line (ending with \n) is a separate item on the list.
1391 ;;; "output" can contain multiple lines, part of a line, or both.
1392 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1394 ;;; "ispell-filter-continue" is true when we have received only part of a
1395 ;;; line as output from a generating function ("output" did not end with \n)
1396 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
1397 ;;; This is the case when a process dies or fails. The default behavior
1398 ;;; in this case treats the next input received as fresh input.
1400 (defun ispell-filter (process output)
1401 "Output filter function for ispell, grep, and look."
1406 (setq end (string-match "\n" output start)) ; get text up to the newline.
1407 ;; If we get out of sync and ispell-filter-continue is asserted when we
1408 ;; are not continuing, treat the next item as a separate list. When
1409 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1412 ;; Continue with same line (item)?
1413 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1414 ;; Yes. Add it to the prev item
1415 (setcar ispell-filter
1416 (concat (car ispell-filter) (substring output start end)))
1417 ;; No. This is a new line and item.
1419 (cons (substring output start end) ispell-filter)))
1421 ;; We've completed reading the output, but didn't finish the line.
1422 (setq ispell-filter-continue t continue nil)
1423 ;; skip over newline, this line complete.
1424 (setq ispell-filter-continue nil end (1+ end))
1425 (if (= end (length output)) ; No more lines in output
1426 (setq continue nil) ; so we can exit the filter.
1427 (setq start end)))))) ; else move start to next line of input
1430 ;;; This function destroys the mark location if it is in the word being
1432 (defun ispell-highlight-spelling-error-generic (start end &optional highlight)
1433 "Highlight the word from START to END with a kludge using `inverse-video'.
1434 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1435 otherwise it is displayed normally."
1436 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1437 (buffer-read-only nil) ; Allow highlighting read-only buffers.
1438 (text (buffer-substring start end)) ; Save highlight region
1439 (inhibit-quit t) ; inhibit interrupt processing here.
1440 (buffer-undo-list t)) ; don't clutter the undo list.
1441 (delete-region start end)
1442 (insert-char ? (- end start)) ; minimize amount of redisplay
1443 (sit-for 0) ; update display
1444 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1445 (delete-region start end) ; delete whitespace
1446 (insert text) ; insert text in inverse video.
1447 (sit-for 0) ; update display showing inverse video.
1448 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1449 (set-buffer-modified-p modified))) ; don't modify if flag not set.
1452 (defun ispell-highlight-spelling-error-lucid (start end &optional highlight)
1453 "Highlight the word from START to END using `isearch-highlight'.
1454 When the optional third arg HIGHLIGHT is set, the word is highlighted,
1455 otherwise it is displayed normally."
1457 (isearch-highlight start end)
1458 (isearch-dehighlight t))
1463 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
1464 "Highlight the word from START to END using overlays.
1465 When the optional third arg HIGHLIGHT is set, the word is highlighted
1466 otherwise it is displayed normally.
1468 The variable `ispell-highlight-face' selects the face to use for highlighting."
1471 (setq ispell-overlay (make-overlay start end))
1472 (overlay-put ispell-overlay 'face ispell-highlight-face))
1473 (delete-overlay ispell-overlay)))
1476 (defun ispell-highlight-spelling-error (start end &optional highlight)
1478 ((string-match "Lucid" emacs-version)
1479 (ispell-highlight-spelling-error-lucid start end highlight))
1480 ((and (string-lessp "19" emacs-version)
1481 (featurep 'faces) window-system)
1482 (ispell-highlight-spelling-error-overlay start end highlight))
1483 (t (ispell-highlight-spelling-error-generic start end highlight))))
1486 (defun ispell-overlay-window (height)
1487 "Create a window covering the top HEIGHT lines of the current window.
1488 Ensure that the line above point is still visible but otherwise avoid
1489 scrolling the current window. Leave the new window selected."
1491 (let ((oldot (save-excursion (forward-line -1) (point)))
1492 (top (save-excursion (move-to-window-line height) (point))))
1493 ;; If line above old point (line starting at olddot) would be
1494 ;; hidden by new window, scroll it to just below new win
1495 ;; otherwise set top line of other win so it doesn't scroll.
1496 (if (< oldot top) (setq top oldot))
1497 ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
1498 ;; line) is demanded, the last line is not visible.
1499 ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
1500 ;; So we increment the height for this case.
1501 (if (string-match "19\.9.*Lucid" (emacs-version))
1502 (setq height (1+ height)))
1503 (split-window nil height)
1504 ;; The lower of the two windows is the logical successor
1505 ;; of the original window, so move the dedicated flag to there.
1506 ;; The new upper window should not be dedicated.
1507 (set-window-dedicated-p (next-window)
1508 (window-dedicated-p (selected-window)))
1509 (set-window-dedicated-p (selected-window) nil)
1510 (set-window-start (next-window) top))))
1513 ;;; Should we add a compound word match return value?
1514 (defun ispell-parse-output (output)
1515 "Parse the OUTPUT string from Ispell and return:
1516 1: t for an exact match.
1517 2: A string containing the root word for a match via suffix removal.
1518 3: A list of possible correct spellings of the format:
1519 '(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
1520 ORIGINAL-WORD is a string of the possibly misspelled word.
1521 OFFSET is an integer giving the line offset of the word.
1522 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses."
1524 ((string= output "") t) ; for startup with pipes...
1525 ((string= output "*") t) ; exact match
1526 ((string= output "-") t) ; compound word match
1527 ((string= (substring output 0 1) "+") ; found cuz of root word
1528 (substring output 2)) ; return root word
1529 (t ; need to process &, ?, and #'s
1530 (let ((type (substring output 0 1)) ; &, ?, or #
1531 (original-word (substring output 2 (string-match " " output 2)))
1532 (cur-count 0) ; contains number of misses + guesses
1533 count miss-list guess-list offset)
1534 (setq output (substring output (match-end 0))) ; skip over misspelling
1535 (if (string= type "#")
1536 (setq count 0) ; no misses for type #
1537 (setq count (string-to-int output) ; get number of misses.
1538 output (substring output (1+ (string-match " " output 1)))))
1539 (setq offset (string-to-int output))
1540 (if (string= type "#") ; No miss or guess list.
1542 (setq output (substring output (1+ (string-match " " output 1)))))
1544 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
1545 (setq cur-count (1+ cur-count))
1546 (if (> cur-count count)
1547 (setq guess-list (cons (substring output 0 end) guess-list))
1548 (setq miss-list (cons (substring output 0 end) miss-list)))
1549 (if (match-end 1) ; True only when at end of line.
1550 (setq output nil) ; no more misses or guesses
1551 (setq output (substring output (+ end 2))))))
1552 (list original-word offset miss-list guess-list)))))
1555 (defun check-ispell-version ()
1556 ;; This is a little wasteful as we actually launch ispell twice: once
1557 ;; to make sure it's the right version, and once for real. But people
1558 ;; get confused by version mismatches *all* the time (and I've got the
1559 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
1560 ;; option is the only way I can think of to do this that works with
1561 ;; all versions, since versions earlier than 3.0.09 didn't identify
1562 ;; themselves on startup.
1564 (let ((case-fold-search t)
1565 ;; avoid bugs when syntax of `.' changes in various default modes
1566 (default-major-mode 'fundamental-mode)
1568 (set-buffer (get-buffer-create " *ispell-tmp*"))
1570 (setq status (call-process ispell-program-name nil t nil "-v"))
1571 (goto-char (point-min))
1572 (if (not (memq status '(0 nil)))
1573 (error "%s exited with %s %s" ispell-program-name
1574 (if (stringp status) "signal" "code") status))
1575 (if (not (re-search-forward
1577 (regexp-quote (car ispell-required-version))
1578 "\\)\\([0-9]*\\)\\b")
1581 "%s version %s* is required: try renaming ispell4.el to ispell.el"
1582 ispell-program-name (car ispell-required-version))
1583 ;; check that it is the correct version.
1584 (if (< (car (read-from-string (buffer-substring
1585 (match-beginning 2) (match-end 2))))
1586 (car (cdr ispell-required-version)))
1587 (setq ispell-offset 0)))
1588 (kill-buffer (current-buffer)))))
1591 (defun ispell-init-process ()
1592 "Check status of Ispell process and start if necessary."
1593 (if (and ispell-process
1594 (eq (process-status ispell-process) 'run)
1595 ;; If we're using a personal dictionary, assure
1596 ;; we're in the same default directory!
1597 (or (not ispell-personal-dictionary)
1598 (equal ispell-process-directory default-directory)))
1599 (setq ispell-filter nil ispell-filter-continue nil)
1600 ;; may need to restart to select new personal dictionary.
1601 (ispell-kill-ispell t)
1602 (message "Starting new Ispell process...")
1604 (check-ispell-version)
1605 (setq ispell-process
1606 (let ((process-connection-type ispell-use-ptys-p))
1607 (apply 'start-process
1608 "ispell" nil ispell-program-name
1609 "-a" ; accept single input lines
1610 "-m" ; make root/affix combos not in dict
1612 ;; Local dictionary becomes the global dictionary in use.
1613 (if ispell-local-dictionary
1614 (setq ispell-dictionary ispell-local-dictionary))
1615 (setq args (ispell-get-ispell-args))
1616 (if ispell-dictionary ; use specified dictionary
1618 (append (list "-d" ispell-dictionary) args)))
1619 (if ispell-personal-dictionary ; use specified pers dict
1624 ispell-personal-dictionary)))))
1625 (setq args (append args ispell-extra-args))
1628 ispell-filter-continue nil
1629 ispell-process-directory default-directory)
1630 (set-process-filter ispell-process 'ispell-filter)
1631 (if (and enable-multibyte-characters
1633 (set-process-coding-system ispell-process (ispell-get-coding-system)))
1634 (accept-process-output ispell-process) ; Get version ID line
1635 (cond ((null ispell-filter)
1636 (error "%s did not output version line" ispell-program-name))
1638 (stringp (car ispell-filter))
1639 (if (string-match "warning: " (car ispell-filter))
1641 (accept-process-output ispell-process 5) ; 1st was warn msg.
1642 (stringp (car ispell-filter)))
1643 (null (cdr ispell-filter)))
1644 (string-match "^@(#) " (car ispell-filter)))
1645 ;; got the version line as expected (we already know it's the right
1646 ;; version, so don't bother checking again.)
1649 ;; Otherwise, it must be an error message. Show the user.
1650 ;; But first wait to see if some more output is going to arrive.
1651 ;; Otherwise we get cool errors like "Can't open ".
1653 (accept-process-output)
1654 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
1655 (setq ispell-filter nil) ; Discard version ID line
1656 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1657 (if extended-char-mode
1658 (process-send-string ispell-process
1659 (concat extended-char-mode "\n"))))
1660 (process-kill-without-query ispell-process)))
1663 (defun ispell-kill-ispell (&optional no-error)
1664 "Kill current Ispell process (so that you may start a fresh one).
1665 With NO-ERROR, just return non-nil if there was no Ispell running."
1667 (if (not (and ispell-process
1668 (eq (process-status ispell-process) 'run)))
1670 (error "There is no ispell process running!"))
1671 (kill-process ispell-process)
1672 (setq ispell-process nil)
1673 (message "Ispell process killed")
1677 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
1678 ;;; call ispell-init-process rather than wait for a spell checking command?
1681 (defun ispell-change-dictionary (dict &optional arg)
1682 "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
1683 A new one will be started as soon as necessary.
1685 By just answering RET you can find out what the current dictionary is.
1687 With prefix argument, set the default directory."
1689 (list (completing-read
1690 "Use new dictionary (RET for current, SPC to complete): "
1691 (cons (cons "default" nil) ispell-dictionary-alist) nil t)
1692 current-prefix-arg))
1693 (if (equal dict "default") (setq dict nil))
1694 ;; This relies on completing-read's bug of returning "" for no match
1695 (cond ((equal dict "")
1696 (message "Using %s dictionary"
1697 (or ispell-local-dictionary ispell-dictionary "default")))
1698 ((and (equal dict ispell-dictionary)
1699 (or (null ispell-local-dictionary)
1700 (equal dict ispell-local-dictionary)))
1701 ;; Specified dictionary is the default already. No-op
1702 (and (interactive-p)
1703 (message "No change, using %s dictionary" (or dict "default"))))
1704 (t ; reset dictionary!
1705 (if (assoc dict ispell-dictionary-alist)
1707 (if (or arg (null dict)) ; set default dictionary
1708 (setq ispell-dictionary dict))
1709 (if (null arg) ; set local dictionary
1710 (setq ispell-local-dictionary dict)))
1711 (error "Illegal dictionary: %s" dict))
1712 (ispell-kill-ispell t)
1713 (message "(Next %sIspell command will use %s dictionary)"
1714 (cond ((equal ispell-local-dictionary ispell-dictionary)
1718 (or (if (or (equal ispell-local-dictionary ispell-dictionary)
1720 ispell-local-dictionary
1725 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
1728 (defun ispell-region (reg-start reg-end)
1729 "Interactively check a region for spelling errors."
1730 (interactive "r") ; Don't flag errors on read-only bufs.
1731 (ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
1734 (message "Spell checking %s using %s dictionary..."
1735 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
1736 (buffer-name) "region")
1737 (or ispell-dictionary "default"))
1738 ;; Returns cursor to original location.
1739 (save-window-excursion
1740 (goto-char reg-start)
1741 (let ((transient-mark-mode nil)
1743 (while (and (not ispell-quit) (< (point) reg-end))
1744 (let ((start (point))
1746 (end (save-excursion (end-of-line) (min (point) reg-end)))
1747 (ispell-casechars (ispell-get-casechars))
1749 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
1750 ((eolp) ; END OF LINE, just go to next line.
1752 ((and (null ispell-check-comments) ; SKIPPING COMMENTS
1753 comment-start ; skip comments that start on the line.
1754 (search-forward comment-start end t)) ; or found here.
1755 (if (= (- (point) start) (length comment-start))
1756 ;; comment starts the line. Skip entire line or region
1757 (if (string= "" comment-end) ; skip to next line
1758 (beginning-of-line 2) ; or jump to comment end.
1759 (search-forward comment-end reg-end 'limit))
1760 ;; Comment later in line. Check spelling before comment.
1761 (let ((limit (- (point) (length comment-start))))
1762 (goto-char (1- limit))
1763 (if (looking-at "\\\\") ; "quoted" comment, don't skip
1764 ;; quoted comment. Skip over comment-start
1765 (if (= start (1- limit))
1766 (setq limit (+ limit (length comment-start)))
1767 (setq limit (1- limit))))
1769 ;; Only check when "casechars" or math before comment
1770 (if (or (re-search-forward ispell-casechars limit t)
1771 (re-search-forward "[][()$]" limit t))
1773 (concat "^" (buffer-substring start limit)
1775 offset-change (- offset-change ispell-offset)))
1776 (goto-char limit))))
1777 ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
1779 ((or (and ispell-skip-tib ; SKIP TIB REFERENCES OR SGML MARKUP
1780 (re-search-forward ispell-tib-ref-beginning end t)
1781 (setq ref-type 'tib))
1782 (and ispell-skip-sgml
1783 (re-search-forward "[<&]" end t)
1784 (setq ref-type 'sgml)))
1785 (if (or (and (eq 'tib ref-type) ; tib tag is 2 chars.
1786 (= (- (point) 2) start))
1787 (and (eq 'sgml ref-type) ; sgml skips 1 char.
1788 (= (- (point) 1) start)))
1789 ;; Skip to end of reference, not necessarily on this line
1790 ;; Return an error if tib/sgml reference not found
1795 (re-search-forward ispell-tib-ref-end reg-end t)))
1796 (and (eq 'sgml ref-type)
1797 (not (re-search-forward "[>;]" reg-end t))))
1799 (ispell-pdict-save ispell-silently-savep)
1803 "Open tib or SGML command. Fix buffer or set "
1804 (if (eq 'tib ref-type)
1808 ;; keep cursor at error location
1809 (setq ispell-quit (- (point) 2))))
1810 ;; Check spelling between reference and start of the line.
1811 (let ((limit (- (point) (if (eq 'tib ref-type) 2 1))))
1813 (if (or (re-search-forward ispell-casechars limit t)
1814 (re-search-forward "[][()$]" limit t))
1816 (concat "^" (buffer-substring start limit)
1818 offset-change (- offset-change ispell-offset)))
1819 (goto-char limit))))
1820 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
1821 (re-search-forward "[][()$]" end t)) ; or MATH COMMANDS
1822 (setq string (concat "^" (buffer-substring start end) "\n")
1823 offset-change (- offset-change ispell-offset))
1825 (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
1827 (setq end (point)) ; "end" tracks end of region to check.
1829 (if string ; there is something to spell!
1831 ;; send string to spell process and get input.
1832 (process-send-string ispell-process string)
1834 (accept-process-output ispell-process)
1835 ;; Last item of output contains a blank line.
1836 (not (string= "" (car ispell-filter)))))
1837 ;; parse all inputs from the stream one word at a time.
1838 ;; Place in FIFO order and remove the blank item.
1839 (setq ispell-filter (nreverse (cdr ispell-filter)))
1840 (while (and (not ispell-quit) ispell-filter)
1841 (setq poss (ispell-parse-output (car ispell-filter)))
1842 (if (listp poss) ; spelling error occurred.
1844 (if (and enable-multibyte-characters
1845 (ispell-get-coding-system))
1846 ;; OFFSET returned by ispell
1847 ;; counts non-ASCII chars as
1848 ;; one, so just adding OFFSET
1849 ;; to START will cause an
1852 (goto-char (+ start offset-change))
1853 (forward-char (car (cdr poss)))
1855 (+ start offset-change
1857 (word-end (+ word-start
1858 (length (car poss))))
1860 (goto-char word-start)
1861 ;; Adjust the horizontal scroll & point
1862 (ispell-horiz-scroll)
1863 (goto-char word-end)
1864 (ispell-horiz-scroll)
1865 (goto-char word-start)
1866 (ispell-horiz-scroll)
1869 (search-forward (car poss) word-end t)
1871 ;; This occurs due to filter pipe problems
1873 (concat "Ispell misalignment: word "
1874 "`%s' point %d; please retry")
1875 (car poss) word-start))
1876 (if (not (pos-visible-in-window-p))
1878 (if ispell-keep-choices-win
1880 (ispell-command-loop
1881 (car (cdr (cdr poss)))
1882 (car (cdr (cdr (cdr poss))))
1883 (car poss) word-start word-end))
1884 (save-window-excursion
1886 (ispell-command-loop
1887 (car (cdr (cdr poss)))
1888 (car (cdr (cdr (cdr poss))))
1889 (car poss) word-start word-end))))
1891 ((and replace (listp replace))
1892 ;; REPLACEMENT WORD entered. Recheck line
1893 ;; starting with the replacement word.
1894 (setq ispell-filter nil
1895 string (buffer-substring word-start
1897 (let ((change (- (length (car replace))
1898 (length (car poss)))))
1900 (setq reg-end (+ reg-end change)
1901 offset-change (+ offset-change
1903 (if (not (equal (car replace) (car poss)))
1905 (delete-region word-start word-end)
1906 (insert (car replace))))
1907 ;; I only need to recheck typed-in replacements
1908 (if (not (eq 'query-replace
1909 (car (cdr replace))))
1910 (backward-char (length (car replace))))
1911 (setq end (point)) ; reposition for recheck
1912 ;; when second arg exists, query-replace, saving regions
1913 (if (car (cdr replace))
1915 (save-window-excursion
1917 ispell-query-replace-marker reg-end)
1918 ;; Assume case-replace &
1919 ;; case-fold-search correct?
1920 (query-replace string (car replace)
1924 ispell-query-replace-marker))
1925 (set-marker ispell-query-replace-marker
1928 (equal 0 replace)) ; ACCEPT/INSERT
1929 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
1931 (ispell-add-per-file-word-list
1932 (car poss) reg-end)))
1933 ;; This avoids pointing out the word that was
1934 ;; just accepted (via 'i' or 'a') if it follows
1935 ;; on the same line.
1936 ;; Redo check following the accepted word.
1937 (if (and ispell-pdict-modified-p
1938 (listp ispell-pdict-modified-p))
1939 ;; Word accepted. Recheck line.
1940 (setq ispell-pdict-modified-p ; update flag
1941 (car ispell-pdict-modified-p)
1942 ispell-filter nil ; discontinue check
1943 end word-start))) ; reposition loc.
1944 (replace ; STRING REPLACEMENT for this word.
1945 (delete-region word-start word-end)
1947 (let ((change (- (length replace)
1948 (length (car poss)))))
1949 (setq reg-end (+ reg-end change)
1950 offset-change (+ offset-change change)
1951 end (+ end change)))))
1952 (if (not ispell-quit)
1953 (let (message-log-max)
1954 (message "Continuing spelling check using %s dictionary..."
1955 (or ispell-dictionary "default"))))
1957 ;; finished with line!
1958 (setq ispell-filter (cdr ispell-filter)))))
1962 (if (get-buffer ispell-choices-buffer)
1963 (kill-buffer ispell-choices-buffer))
1966 ;; preserve or clear the region for ispell-continue.
1967 (if (not (numberp ispell-quit))
1968 (set-marker ispell-region-end nil)
1969 ;; Enable ispell-continue.
1970 (set-marker ispell-region-end reg-end)
1971 (goto-char ispell-quit))
1972 ;; Check for aborting
1973 (if (and ispell-checking-message (numberp ispell-quit))
1975 (setq ispell-quit nil)
1976 (error "Message send aborted.")))
1977 (setq ispell-quit nil))
1978 (set-marker ispell-region-end nil)
1979 ;; Only save if successful exit.
1980 (ispell-pdict-save ispell-silently-savep)
1981 (message "Spell-checking done"))))
1986 (defun ispell-buffer ()
1987 "Check the current buffer for spelling errors interactively."
1989 (ispell-region (point-min) (point-max)))
1993 (defun ispell-continue ()
1995 "Continue a spelling session after making some changes."
1996 (if (not (marker-position ispell-region-end))
1997 (message "No session to continue. Use 'X' command when checking!")
1998 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
1999 (message "Must continue ispell from buffer %s"
2000 (buffer-name (marker-buffer ispell-region-end)))
2001 (ispell-region (point) (marker-position ispell-region-end)))))
2004 ;;; Horizontal scrolling
2005 (defun ispell-horiz-scroll ()
2006 "Places point within the horizontal visibility of its window area."
2007 (if truncate-lines ; display truncating lines?
2008 ;; See if display needs to be scrolled.
2009 (let ((column (- (current-column) (max (window-hscroll) 1))))
2010 (if (and (< column 0) (> (window-hscroll) 0))
2011 (scroll-right (max (- column) 10))
2012 (if (>= column (- (window-width) 2))
2013 (scroll-left (max (- column (window-width) -3) 10)))))))
2016 ;;; Interactive word completion.
2017 ;;; Forces "previous-word" processing. Do we want to make this selectable?
2020 (defun ispell-complete-word (&optional interior-frag)
2021 "Look up word before or under point in dictionary (see lookup-words command)
2022 and try to complete it. If optional INTERIOR-FRAG is non-nil then the word
2023 may be a character sequence inside of a word.
2025 Standard ispell choices are then available."
2027 (let ((cursor-location (point))
2029 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
2030 start end possibilities replacement)
2031 (setq start (car (cdr word))
2032 end (car (cdr (cdr word)))
2035 (or (string= word "") ; Will give you every word
2036 (lookup-words (concat (if interior-frag "*") word "*")
2037 ispell-complete-word-dict)))
2038 (cond ((eq possibilities t)
2039 (message "No word to complete"))
2040 ((null possibilities)
2041 (message "No match for \"%s\"" word))
2042 (t ; There is a modification...
2043 (cond ; Try and respect case of word.
2044 ((string-match "^[^A-Z]+$" word)
2045 (setq possibilities (mapcar 'downcase possibilities)))
2046 ((string-match "^[^a-z]+$" word)
2047 (setq possibilities (mapcar 'upcase possibilities)))
2048 ((string-match "^[A-Z]" word)
2049 (setq possibilities (mapcar 'capitalize possibilities))))
2050 (save-window-excursion
2052 (ispell-command-loop possibilities nil word start end)))
2054 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
2055 (ispell-add-per-file-word-list word))
2056 (replacement ; REPLACEMENT WORD
2057 (delete-region start end)
2058 (setq word (if (atom replacement) replacement (car replacement))
2059 cursor-location (+ (- (length word) (- end start))
2062 (if (not (atom replacement)) ; recheck spelling of replacement.
2064 (goto-char cursor-location)
2065 (ispell-word nil t)))))
2066 (if (get-buffer ispell-choices-buffer)
2067 (kill-buffer ispell-choices-buffer))))
2068 (ispell-pdict-save ispell-silently-savep)
2069 (goto-char cursor-location)))
2073 (defun ispell-complete-word-interior-frag ()
2074 "Completes word matching character sequence inside a word."
2076 (ispell-complete-word t))
2079 ;;; **********************************************************************
2080 ;;; Ispell Minor Mode
2081 ;;; **********************************************************************
2083 (defvar ispell-minor-mode nil
2084 "Non-nil if Ispell minor mode is enabled.")
2085 ;; Variable indicating that ispell minor mode is active.
2086 (make-variable-buffer-local 'ispell-minor-mode)
2088 (or (assq 'ispell-minor-mode minor-mode-alist)
2089 (setq minor-mode-alist
2090 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
2092 (defvar ispell-minor-keymap
2093 (let ((map (make-sparse-keymap)))
2094 (define-key map " " 'ispell-minor-check)
2095 (define-key map "\r" 'ispell-minor-check)
2097 "Keymap used for Ispell minor mode.")
2099 (or (not (boundp 'minor-mode-map-alist))
2100 (assoc 'ispell-minor-mode minor-mode-map-alist)
2101 (setq minor-mode-map-alist
2102 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
2103 minor-mode-map-alist)))
2106 (defun ispell-minor-mode (&optional arg)
2107 "Toggle Ispell minor mode.
2108 With prefix arg, turn Ispell minor mode on iff arg is positive.
2110 In Ispell minor mode, pressing SPC or RET
2111 warns you if the previous word is incorrectly spelled."
2113 (setq ispell-minor-mode
2114 (not (or (and (null arg) ispell-minor-mode)
2115 (<= (prefix-numeric-value arg) 0))))
2116 (force-mode-line-update))
2118 (defun ispell-minor-check ()
2119 ;; Check previous word then continue with the normal binding of this key.
2121 (let ((ispell-minor-mode nil)
2122 (ispell-check-only t))
2124 (narrow-to-region (point-min) (point))
2125 (ispell-word nil t))
2126 (call-interactively (key-binding (this-command-keys)))))
2129 ;;; **********************************************************************
2131 ;;; **********************************************************************
2132 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2135 (defvar ispell-message-text-end
2136 (mapconcat (function identity)
2138 ;; Matches postscript files.
2139 "^%!PS-Adobe-[123].0"
2140 ;; Matches uuencoded text
2141 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2142 ;; Matches shell files (esp. auto-decoding)
2144 ;; Matches context difference listing
2145 "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2146 ;; Matches reporter.el bug report
2147 "^current state:\n==============\n"
2148 ;; Matches "----------------- cut here"
2149 ;; and "------- Start of forwarded message",
2150 ;; or either one with "- " in front.
2151 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|\\(Start of \\)?forwarded message\\)")
2153 "*End of text which will be checked in ispell-message.
2154 If it is a string, limit at first occurrence of that regular expression.
2155 Otherwise, it must be a function which is called to get the limit.")
2158 (defvar ispell-message-start-skip
2159 (mapconcat (function identity)
2161 ;; Matches forwarded messages
2162 "^---* Forwarded Message"
2163 ;; Matches PGP Public Key block
2164 "^---*BEGIN PGP [A-Z ]*--*"
2167 "Spelling is skipped inside these start/end groups by ispell-message.
2168 Assumed that blocks are not mutually inclusive.")
2171 (defvar ispell-message-end-skip
2172 (mapconcat (function identity)
2174 ;; Matches forwarded messages
2175 "^--- End of Forwarded Message"
2176 ;; Matches PGP Public Key block
2177 "^---*END PGP [A-Z ]*--*"
2180 "Spelling is skipped inside these start/end groups by ispell-message.
2181 Assumed that blocks are not mutually inclusive.")
2185 (defun ispell-message ()
2186 "Check the spelling of a mail message or news post.
2187 Don't check spelling of message headers except the Subject field.
2188 Don't check included messages.
2190 To abort spell checking of a message region and send the message anyway,
2191 use the `x' command. (Any subsequent regions will be checked.)
2192 The `X' command aborts the message send so that you can edit the buffer.
2194 To spell-check whenever a message is sent, include the appropriate lines
2195 in your .emacs file:
2196 (add-hook 'message-send-hook 'ispell-message)
2197 (add-hook 'mail-send-hook 'ispell-message)
2198 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2200 You can bind this to the key C-c i in GNUS or mail by adding to
2201 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2202 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
2205 (goto-char (point-min))
2206 (let* ((internal-messagep (save-excursion
2209 (regexp-quote mail-header-separator)
2214 ((not ispell-message-text-end) (point-max))
2215 ((char-or-string-p ispell-message-text-end)
2216 (if (re-search-forward ispell-message-text-end nil t)
2219 (t (min (point-max) (funcall ispell-message-text-end))))))
2220 (cite-regexp ;Prefix of inserted text
2222 ((featurep 'supercite) ; sc 3.0
2223 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
2224 (ispell-non-empty-string sc-reference-tag-string)))
2225 ((featurep 'sc) ; sc 2.3
2226 (concat "\\(" sc-cite-regexp "\\)" "\\|"
2227 (ispell-non-empty-string sc-reference-tag-string)))
2228 ((equal major-mode 'news-reply-mode) ;GNUS 4 & below
2229 (concat "In article <" "\\|"
2230 (if mail-yank-prefix
2231 (ispell-non-empty-string mail-yank-prefix)
2233 ((equal major-mode 'message-mode) ;GNUS 5
2234 (concat ".*@.* writes:$" "\\|"
2235 (if mail-yank-prefix
2236 (ispell-non-empty-string mail-yank-prefix)
2238 ((equal major-mode 'mh-letter-mode) ; mh mail message
2239 (ispell-non-empty-string mh-ins-buf-prefix))
2240 ((not internal-messagep) ; Assume n sent us this message.
2241 (concat "In [a-zA-Z.]+ you write:" "\\|"
2242 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
2244 ((boundp 'vm-included-text-prefix) ; VM mail message
2245 (concat "[^,;&+=]+ writes:" "\\|"
2246 (ispell-non-empty-string vm-included-text-prefix)))
2247 (mail-yank-prefix ; vanilla mail message.
2248 (ispell-non-empty-string mail-yank-prefix))
2250 (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp))
2251 (cite-regexp-end (concat "^\\(" cite-regexp "\\)"))
2252 (old-case-fold-search case-fold-search)
2253 (case-fold-search t)
2254 (ispell-checking-message t))
2255 (goto-char (point-min))
2256 ;; Skip header fields except Subject: without Re:'s
2257 ;;(search-forward mail-header-separator nil t)
2258 (while (if internal-messagep
2259 (< (point) internal-messagep)
2260 (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
2262 (if (looking-at "Subject: *") ; Spell check new subject fields
2264 (goto-char (match-end 0))
2265 (if (and (not (looking-at ".*Re\\>"))
2266 (not (looking-at "\\[")))
2267 (let ((case-fold-search old-case-fold-search))
2268 (ispell-region (point)
2271 (while (looking-at "\n[ \t]")
2275 (setq case-fold-search nil)
2276 ;; Skip mail header, particularly for non-english languages.
2277 (if (looking-at (concat (regexp-quote mail-header-separator) "$"))
2279 (while (< (point) limit)
2280 ;; Skip across text cited from other messages.
2281 (while (and (looking-at cite-regexp-start)
2283 (zerop (forward-line 1))))
2285 (if (< (point) limit)
2286 (let* ((start (point))
2287 ;; Check the next batch of lines that *aren't* cited.
2288 (end-c (and (re-search-forward cite-regexp-end limit 'end)
2289 (match-beginning 0)))
2290 ;; Skip a block of included text.
2291 (end-fwd (and (goto-char start)
2292 (re-search-forward ispell-message-start-skip
2294 (progn (beginning-of-line)
2296 (end (or (and end-c end-fwd (min end-c end-fwd))
2298 ;; default to limit of text.
2299 (marker-position limit))))
2301 (ispell-region start end)
2302 (if (and end-fwd (= end end-fwd))
2305 (re-search-forward ispell-message-end-skip limit 'end))
2307 (set-marker limit nil))))
2310 (defun ispell-non-empty-string (string)
2311 (if (or (not string) (string-equal string ""))
2312 "\\'\\`" ; An unmatchable string if string is null.
2313 (regexp-quote string)))
2316 ;;; **********************************************************************
2317 ;;; Buffer Local Functions
2318 ;;; **********************************************************************
2321 (defun ispell-accept-buffer-local-defs ()
2322 "Load all buffer-local information, restarting ispell when necessary."
2323 (ispell-buffer-local-dict) ; May kill ispell-process.
2324 (ispell-buffer-local-words) ; Will initialize ispell-process.
2325 (ispell-buffer-local-parsing))
2328 (defun ispell-buffer-local-parsing ()
2329 "Place Ispell into parsing mode for this buffer.
2330 Overrides the default parsing mode.
2331 Includes latex/nroff modes and extended character mode."
2332 ;; (ispell-init-process) must already be called.
2333 (process-send-string ispell-process "!\n") ; Put process in terse mode.
2334 ;; We assume all major modes with "tex-mode" in them should use latex parsing
2335 (if (or (and (eq ispell-parser 'use-mode-name)
2336 (string-match "[Tt][Ee][Xx]-mode" (symbol-name major-mode)))
2337 (eq ispell-parser 'tex))
2338 (process-send-string ispell-process "+\n") ; set ispell mode to tex
2339 (process-send-string ispell-process "-\n")) ; set mode to normal (nroff)
2340 ;; Hard-wire test for SGML & HTML mode.
2341 (setq ispell-skip-sgml (memq major-mode '(sgml-mode html-mode)))
2342 ;; Set default extended character mode for given buffer, if any.
2343 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2344 (if extended-char-mode
2345 (process-send-string ispell-process (concat extended-char-mode "\n"))))
2346 ;; Set buffer-local parsing mode and extended character mode, if specified.
2348 (goto-char (point-min))
2349 ;; Uses last valid definition
2350 (while (search-forward ispell-parsing-keyword nil t)
2351 (let ((end (save-excursion (end-of-line) (point)))
2352 (case-fold-search t)
2354 (while (re-search-forward " *\\([^ \"]+\\)" end t)
2355 ;; space separated definitions.
2356 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2357 (cond ((string-match "latex-mode" string)
2358 (process-send-string ispell-process "+\n~tex\n"))
2359 ((string-match "nroff-mode" string)
2360 (process-send-string ispell-process "-\n~nroff"))
2361 ((string-match "~" string) ; Set extended character mode.
2362 (process-send-string ispell-process (concat string "\n")))
2363 (t (message "Illegal Ispell Parsing argument!")
2367 ;;; Can kill the current ispell process
2369 (defun ispell-buffer-local-dict ()
2370 "Initializes local dictionary.
2371 When a dictionary is defined in the buffer (see variable
2372 `ispell-dictionary-keyword'), it will override the local setting
2373 from \\[ispell-change-dictionary].
2374 Both should not be used to define a buffer-local dictionary."
2376 (goto-char (point-min))
2378 ;; Override the local variable definition.
2379 ;; Uses last valid definition.
2380 (while (search-forward ispell-dictionary-keyword nil t)
2381 (setq end (save-excursion (end-of-line) (point)))
2382 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2383 (setq ispell-local-dictionary
2384 (buffer-substring (match-beginning 1) (match-end 1)))))
2385 (goto-char (point-min))
2386 (while (search-forward ispell-pdict-keyword nil t)
2387 (setq end (save-excursion (end-of-line) (point)))
2388 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2389 (setq ispell-local-pdict
2390 (buffer-substring (match-beginning 1) (match-end 1)))))))
2391 ;; Reload if new personal dictionary defined.
2392 (if (and ispell-local-pdict
2393 (not (equal ispell-local-pdict ispell-personal-dictionary)))
2395 (ispell-kill-ispell t)
2396 (setq ispell-personal-dictionary ispell-local-pdict)))
2397 ;; Reload if new dictionary defined.
2398 (if (and ispell-local-dictionary
2399 (not (equal ispell-local-dictionary ispell-dictionary)))
2400 (ispell-change-dictionary ispell-local-dictionary)))
2403 (defun ispell-buffer-local-words ()
2404 "Loads the buffer-local dictionary in the current buffer."
2405 (if (and ispell-buffer-local-name
2406 (not (equal ispell-buffer-local-name (buffer-name))))
2408 (ispell-kill-ispell t)
2409 (setq ispell-buffer-local-name nil)))
2410 (ispell-init-process)
2412 (goto-char (point-min))
2413 (while (search-forward ispell-words-keyword nil t)
2414 (or ispell-buffer-local-name
2415 (setq ispell-buffer-local-name (buffer-name)))
2416 (let ((end (save-excursion (end-of-line) (point)))
2418 ;; buffer-local words separated by a space, and can contain
2419 ;; any character other than a space.
2420 (while (re-search-forward " *\\([^ ]+\\)" end t)
2421 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2422 (process-send-string ispell-process (concat "@" string "\n")))))))
2425 ;;; returns optionally adjusted region-end-point.
2427 (defun ispell-add-per-file-word-list (word &optional reg-end)
2428 "Adds new word to the per-file word list."
2429 (or ispell-buffer-local-name
2430 (setq ispell-buffer-local-name (buffer-name)))
2434 (goto-char (point-min))
2435 (let (case-fold-search line-okay search done string)
2437 (setq search (search-forward ispell-words-keyword nil 'move)
2438 line-okay (< (+ (length word) 1 ; 1 for space after word..
2439 (progn (end-of-line) (current-column)))
2441 (if (or (and search line-okay)
2448 (setq string (concat comment-start " "
2449 ispell-words-keyword))
2450 ;; in case the keyword is in the middle of the file....
2451 (if (> reg-end (point))
2452 (setq reg-end (+ reg-end (length string))))
2454 (if (and comment-end (not (equal "" comment-end)))
2458 (insert comment-end)))))
2459 (if (> reg-end (point))
2460 (setq reg-end (+ 1 reg-end (length word))))
2461 (insert (concat " " word)))))))
2465 (defconst ispell-version "2.37 -- Tue Jun 13 12:05:28 EDT 1995")
2470 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
2472 ;;; Local Variable options:
2473 ;;; mode: name(-mode)
2474 ;;; eval: expression
2475 ;;; local-variable: value
2477 ;;; The following sets the buffer local dictionary to english!
2479 ;;; Local Variables:
2480 ;;; mode: emacs-lisp
2481 ;;; comment-column: 40
2482 ;;; ispell-local-dictionary: "american"
2486 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
2488 ;;; The following places this file in nroff parsing and extended char modes.
2489 ;;; Local IspellParsing: nroff-mode ~nroff
2490 ;;; Change IspellDict to IspellDict: to enable the following line.
2491 ;;; Local IspellDict english
2492 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
2493 ;;; Local IspellPersDict ~/.ispell_lisp
2494 ;;; The following were automatically generated by ispell using the 'A' command:
2495 ; LocalWords: ispell ispell-highlight-p ispell-check-comments query-replace
2496 ; LocalWords: ispell-query-replace-choices ispell-skip-tib non-nil tib
2497 ; LocalWords: regexps ispell-tib-ref-beginning ispell-tib-ref-end
2499 ;; ispell.el ends here