1 ;;; ispell.el --- spell checking using Ispell
3 ;; Copyright (C) 1994, 1995 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."
461 (defcustom ispell-silently-savep nil
462 "*When non-nil, save the personal dictionary without confirmation."
466 ;;; This variable contains the current dictionary being used if the ispell
467 ;;; process is running. Otherwise it contains the global default.
468 (defvar ispell-dictionary nil
469 "If non-nil, a dictionary to use instead of the default one.
470 This is passed to the ispell process using the `-d' switch and is
471 used as key in `ispell-dictionary-alist' (which see).
473 You should set this variable before your first use of Emacs spell-checking
474 commands in the Emacs session, or else use the \\[ispell-change-dictionary]
475 command to change it. Otherwise, this variable only takes effect in a newly
476 started Ispell process.")
478 (defcustom ispell-extra-args nil
479 "*If non-nil, a list of extra switches to pass to the Ispell program.
480 For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
481 words as correct. See also `ispell-dictionary-alist', which may be used
482 for language-specific arguments."
483 :type '(repeat string)
486 ;;; The preparation of the menu bar menu must be autoloaded
487 ;;; because otherwise this file gets autoloaded every time Emacs starts
488 ;;; so that it can set up the menus and determine keyboard equivalents.
491 (defvar ispell-dictionary-alist-1 ; sk 9-Aug-1991 18:28
492 '((nil ; default (english.aff)
493 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
494 ("english" ; make English explicitly selectable
495 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
496 ("british" ; British version
497 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "british") nil)
498 ("american" ; American version
499 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "american") nil)
500 ("deutsch" ; deutsch.aff
501 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex")
503 "[a-zA-Z\304\326\334\344\366\337\374]"
504 "[^a-zA-Z\304\326\334\344\366\337\374]"
505 "[']" t ("-C" "-d" "deutsch") "~latin1")
506 ("nederlands" ; nederlands.aff
507 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
508 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
510 ("nederlands8" ; dutch8.aff
511 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
512 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
513 "[']" t ("-C") nil)))
516 (defvar ispell-dictionary-alist-2
517 '(("svenska" ;7 bit swedish mode
518 "[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
519 "[']" nil ("-C") nil)
520 ("svenska8" ;8 bit swedish mode
521 "[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
522 "[']" nil ("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
524 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil)
525 ("francais" ; francais.aff
526 "[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]"
527 "[^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]"
528 "[---']" t nil "~list")
529 ("francais-tex" ; francais.aff
530 "[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\\]"
531 "[^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\\]"
532 "[---'^`\"]" t nil "~tex")
534 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
539 ;;; ispell-dictionary-alist is set up from two subvariables above
540 ;;; to avoid having very long lines in loaddefs.el.
542 (defvar ispell-dictionary-alist
543 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2)
544 "An alist of dictionaries and their associated parameters.
546 Each element of this list is also a list:
548 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
549 ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
551 DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
552 means the default dictionary.
554 CASECHARS is a regular expression of valid characters that comprise a
557 NOT-CASECHARS is the opposite regexp of CASECHARS.
559 OTHERCHARS is a regular expression of other characters that are valid
560 in word constructs. Otherchars cannot be adjacent to each other in a
561 word, nor can they begin or end a word. This implies we can't check
562 \"Stevens'\" as a correct possessive and other correct formations.
564 Hint: regexp syntax requires the hyphen to be declared first here.
566 MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed in a
567 word instead of only one.
569 ISPELL-ARGS is a list of additional arguments passed to the ispell
572 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
573 have been configured in an Ispell affix file. (For example, umlauts
574 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
575 in English. This has the same effect as the command-line `-T' option.
576 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
577 but the dictionary can control the extended character mode.
578 Both defaults can be overruled in a buffer-local fashion. See
579 `ispell-parsing-keyword' for details on this.
581 Note that the CASECHARS and OTHERCHARS slots of the alist should
582 contain the same character set as casechars and otherchars in the
583 language.aff file \(e.g., english.aff\).")
586 (defvar ispell-menu-map nil "Key map for ispell menu")
589 (defvar ispell-menu-lucid nil "Spelling menu for Lucid Emacs.")
591 ;;; Break out lucid menu and split into several calls to avoid having
592 ;;; long lines in loaddefs.el. Detect need off following constant.
595 (defconst ispell-menu-map-needed ; make sure this is not Lucid Emacs
596 (and (not ispell-menu-map)
597 ;;; This is commented out because it fails in Emacs.
598 ;;; due to the fact that menu-bar is loaded much later than loaddefs.
599 ;;; ;; make sure this isn't Lucid Emacs
600 ;;; (featurep 'menu-bar)
601 (not (string-match "Lucid" emacs-version))))
603 ;;; Set up dictionary
605 (if ispell-menu-map-needed
606 (let ((dicts (reverse (cons (cons "default" nil) ispell-dictionary-alist)))
608 (setq ispell-menu-map (make-sparse-keymap "Spell"))
609 ;; add the dictionaries to the bottom of the list.
611 (setq name (car (car dicts))
614 (define-key ispell-menu-map (vector (intern name))
615 (cons (concat "Select " (capitalize name))
616 (list 'lambda () '(interactive)
617 (list 'ispell-change-dictionary name))))))))
619 ;;; define commands in menu in opposite order you want them to appear.
621 (if ispell-menu-map-needed
623 (define-key ispell-menu-map [ispell-change-dictionary]
624 '("Change Dictionary" . ispell-change-dictionary))
625 (define-key ispell-menu-map [ispell-kill-ispell]
626 '("Kill Process" . ispell-kill-ispell))
627 (define-key ispell-menu-map [ispell-pdict-save]
628 '("Save Dictionary" . (lambda () (interactive) (ispell-pdict-save t t))))
629 (define-key ispell-menu-map [ispell-complete-word]
630 '("Complete Word" . ispell-complete-word))
631 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
632 '("Complete Word Frag" . ispell-complete-word-interior-frag))))
635 (if ispell-menu-map-needed
637 (define-key ispell-menu-map [ispell-continue]
638 '("Continue Check" . ispell-continue))
639 (define-key ispell-menu-map [ispell-word]
640 '("Check Word" . ispell-word))
641 (define-key ispell-menu-map [ispell-region]
642 '("Check Region" . ispell-region))
643 (define-key ispell-menu-map [ispell-buffer]
644 '("Check Buffer" . ispell-buffer))))
647 (if ispell-menu-map-needed
649 (define-key ispell-menu-map [ispell-message]
650 '("Check Message" . ispell-message))
651 (define-key ispell-menu-map [ispell-help]
652 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
653 '("Help" . (lambda () (interactive) (describe-function 'ispell-help))))
654 (put 'ispell-region 'menu-enable 'mark-active)
655 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
657 ;;; Xemacs version 19
658 (if (and (string-lessp "19" emacs-version)
659 (string-match "Lucid" emacs-version))
660 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
661 (current-menubar (or current-menubar default-menubar))
663 '(["Help" (describe-function 'ispell-help) t]
664 ;;["Help" (popup-menu ispell-help-list) t]
665 ["Check Message" ispell-message t]
666 ["Check Buffer" ispell-buffer t]
667 ["Check Word" ispell-word t]
668 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
669 ["Continue Check" ispell-continue t]
670 ["Complete Word Frag"ispell-complete-word-interior-frag t]
671 ["Complete Word" ispell-complete-word t]
672 ["Kill Process" ispell-kill-ispell t]
674 ["Save Dictionary" (ispell-pdict-save t t) t]
675 ["Change Dictionary" ispell-change-dictionary t]))
678 (setq name (car (car dicts))
681 (setq menu (append menu
683 (vector (concat "Select " (capitalize name))
684 (list 'ispell-change-dictionary name)
686 (setq ispell-menu-lucid menu)
689 (delete-menu-item '("Edit" "Spell")) ; in case already defined
690 (add-menu '("Edit") "Spell" ispell-menu-lucid)))))
693 ;;; **********************************************************************
694 ;;; The following are used by ispell, and should not be changed.
695 ;;; **********************************************************************
698 ;;; The version must be 3.1 or greater for this version of ispell.el
699 ;;; There is an incompatibility between version 3.1.12 and lower versions.
700 (defconst ispell-required-version '("3.1." 12)
701 "Ispell versions with which this version of ispell.el is known to work.")
702 (defvar ispell-offset 1
703 "Offset that maps protocol differences between ispell 3.1 versions.")
705 (defun ispell-get-casechars ()
706 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist)))
707 (defun ispell-get-not-casechars ()
708 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist)))
709 (defun ispell-get-otherchars ()
710 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist)))
711 (defun ispell-get-many-otherchars-p ()
712 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
713 (defun ispell-get-ispell-args ()
714 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
715 (defun ispell-get-extended-character-mode ()
716 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
718 (defvar ispell-process nil
719 "The process object for Ispell.")
721 (defvar ispell-pdict-modified-p nil
722 "Non-nil means personal dictionary has modifications to be saved.")
724 ;;; If you want to save the dictionary when quitting, must do so explicitly.
725 ;;; When non-nil, the spell session is terminated.
726 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
727 (defvar ispell-quit nil)
729 (defvar ispell-filter nil
730 "Output filter from piped calls to Ispell.")
732 (defvar ispell-filter-continue nil
733 "Control variable for Ispell filter function.")
735 (defvar ispell-process-directory nil
736 "The directory where `ispell-process' was started.")
738 (defvar ispell-query-replace-marker (make-marker)
739 "Marker for `query-replace' processing.")
741 (defvar ispell-checking-message nil
742 "Non-nil when we're checking a mail message")
744 (defconst ispell-choices-buffer "*Choices*")
746 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
748 ;;; *** Buffer Local Definitions ***
750 ;;; This is the local dictionary to use. When nil the default dictionary will
751 ;;; be used. Do not redefine default value or it will override the global!
752 (defvar ispell-local-dictionary nil
753 "If non-nil, a dictionary to use for Ispell commands in this buffer.
754 The value must be a string dictionary name in `ispell-dictionary-alist'.
755 This variable becomes buffer-local when set in any fashion.
757 Setting ispell-local-dictionary to a value has the same effect as
758 calling \\[ispell-change-dictionary] with that value. This variable
759 is automatically set when defined in the file with either
760 `ispell-dictionary-keyword' or the Local Variable syntax.")
762 (make-variable-buffer-local 'ispell-local-dictionary)
764 ;; Use default directory, unless locally set.
765 (set-default 'ispell-local-dictionary nil)
767 (defconst ispell-words-keyword "LocalWords: "
768 "The keyword for local oddly-spelled words to accept.
769 The keyword will be followed by any number of local word spellings.
770 There can be multiple of these keywords in the file.")
772 (defconst ispell-dictionary-keyword "Local IspellDict: "
773 "The keyword for local dictionary definitions.
774 There should be only one dictionary keyword definition per file, and it
775 should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
777 (defconst ispell-parsing-keyword "Local IspellParsing: "
778 "The keyword for overriding default Ispell parsing.
779 Determined by the buffer's major mode and extended-character mode as well as
780 the default dictionary.
782 The above keyword string should be followed by `latex-mode' or
783 `nroff-mode' to put the current buffer into the desired parsing mode.
785 Extended character mode can be changed for this buffer by placing
786 a `~' followed by an extended-character mode -- such as `~.tex'.")
788 (defvar ispell-skip-sgml nil
789 "Skips spell checking of SGML tags and entity references when non-nil.
790 This variable is set when major-mode is sgml-mode or html-mode.")
792 (defvar ispell-local-pdict ispell-personal-dictionary
793 "A buffer local variable containing the current personal dictionary.
794 If non-nil, the value must be a string, which is a file name.
796 If you specify a personal dictionary for the current buffer which is
797 different from the current personal dictionary, the effect is similar
798 to calling \\[ispell-change-dictionary]. This variable is automatically
799 set when defined in the file with either `ispell-pdict-keyword' or the
800 local variable syntax.")
802 (make-variable-buffer-local 'ispell-local-pdict)
804 (defconst ispell-pdict-keyword "Local IspellPersDict: "
805 "The keyword for defining buffer local dictionaries.")
807 (defvar ispell-buffer-local-name nil
808 "Contains the buffer name if local word definitions were used.
809 Ispell is then restarted because the local words could conflict.")
811 (defvar ispell-parser 'use-mode-name
812 "*Indicates whether ispell should parse the current buffer as TeX Code.
813 Special value `use-mode-name' tries to guess using the name of major-mode.
814 Default parser is 'nroff.
815 Currently the only other valid parser is 'tex.
817 You can set this variable in hooks in your init file -- eg:
819 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
821 (defvar ispell-region-end (make-marker)
822 "Marker that allows spelling continuations.")
824 (defvar ispell-check-only nil
825 "If non-nil, `ispell-word' does not try to correct the word.")
828 ;;; **********************************************************************
829 ;;; **********************************************************************
832 (and (string-lessp "19" emacs-version)
833 (not (boundp 'epoch::version))
834 (defalias 'ispell 'ispell-buffer))
837 (define-key global-map "\M-$" 'ispell-word)
840 (defun ispell-word (&optional following quietly continue)
841 "Check spelling of word under or before the cursor.
842 If the word is not found in dictionary, display possible corrections
843 in a window allowing you to choose one.
845 With a prefix argument (or if CONTINUE is non-nil),
846 resume interrupted spell-checking of a buffer or region.
848 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
849 is non-nil when called interactively, then the following word
850 \(rather than preceding\) is checked when the cursor is not over a word.
851 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
852 when called interactively, non-corrective messages are suppressed.
854 Word syntax described by `ispell-dictionary-alist' (which see).
856 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
857 or \\[ispell-region] to update the Ispell process."
858 (interactive (list nil nil current-prefix-arg))
862 (setq following ispell-following-word
863 quietly ispell-quietly))
864 (ispell-accept-buffer-local-defs) ; use the correct dictionary
865 (let ((cursor-location (point)) ; retain cursor location
866 (word (ispell-get-word following))
867 start end poss replace)
868 ;; destructure return word info list.
869 (setq start (car (cdr word))
870 end (car (cdr (cdr word)))
873 ;; now check spelling of word.
875 (message "Checking spelling of %s..."
876 (funcall ispell-format-word word)))
877 (process-send-string ispell-process "%\n") ;put in verbose mode
878 (process-send-string ispell-process (concat "^" word "\n"))
879 ;; wait until ispell has processed word
881 (accept-process-output ispell-process)
882 (not (string= "" (car ispell-filter)))))
883 ;;(process-send-string ispell-process "!\n") ;back to terse mode.
884 (setq ispell-filter (cdr ispell-filter))
885 (if (listp ispell-filter)
886 (setq poss (ispell-parse-output (car ispell-filter))))
889 (message "%s is correct" (funcall ispell-format-word word))))
892 (message "%s is correct because of root %s"
893 (funcall ispell-format-word word)
894 (funcall ispell-format-word poss))))
895 ((null poss) (message "Error in ispell process"))
896 (ispell-check-only ; called from ispell minor mode.
898 (t ; prompt for correct word.
899 (save-window-excursion
900 (setq replace (ispell-command-loop
901 (car (cdr (cdr poss)))
902 (car (cdr (cdr (cdr poss))))
903 (car poss) start end)))
904 (cond ((equal 0 replace)
905 (ispell-add-per-file-word-list (car poss)))
907 (setq word (if (atom replace) replace (car replace))
908 cursor-location (+ (- (length word) (- end start))
910 (if (not (equal word (car poss)))
912 (delete-region start end)
914 (if (not (atom replace)) ; recheck spelling of replacement
916 (goto-char cursor-location)
917 (ispell-word following quietly)))))
918 (if (get-buffer ispell-choices-buffer)
919 (kill-buffer ispell-choices-buffer))))
920 (goto-char cursor-location) ; return to original location
921 (ispell-pdict-save ispell-silently-savep)
922 (if ispell-quit (setq ispell-quit nil)))))
925 (defun ispell-get-word (following &optional extra-otherchars)
926 "Return the word for spell-checking according to ispell syntax.
927 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
928 is non-nil when called interactively, then the following word
929 \(rather than preceding\) is checked when the cursor is not over a word.
930 Optional second argument contains otherchars that can be included in word
933 Word syntax described by `ispell-dictionary-alist' (which see)."
934 (let* ((ispell-casechars (ispell-get-casechars))
935 (ispell-not-casechars (ispell-get-not-casechars))
936 (ispell-otherchars (ispell-get-otherchars))
937 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
938 (word-regexp (concat ispell-casechars
943 (concat extra-otherchars "?"))
946 (if (or ispell-many-otherchars-p
952 (if (not (looking-at ispell-casechars))
954 (re-search-forward ispell-casechars (point-max) t)
955 (re-search-backward ispell-casechars (point-min) t)))
956 ;; move to front of word
957 (re-search-backward ispell-not-casechars (point-min) 'start)
958 (while (and (or (looking-at ispell-otherchars)
959 (and extra-otherchars (looking-at extra-otherchars)))
961 (or (not did-it-once)
962 ispell-many-otherchars-p))
963 (if (and extra-otherchars (looking-at extra-otherchars))
966 (if (looking-at ispell-casechars)
967 (re-search-backward ispell-not-casechars (point-min) 'move)))
970 (if (looking-at ispell-casechars)
971 (re-search-backward ispell-not-casechars (point-min) 'move)
972 (backward-char -1))))
973 ;; Now mark the word and save to string.
974 (or (re-search-forward word-regexp (point-max) t)
975 (error "No word found to check!"))
976 (setq start (match-beginning 0)
978 word (buffer-substring start end))
979 (list word start end)))
982 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
983 ;;; tracks changes in the dictionary. The global may either be
984 ;;; a value or a list, whose value is the state of whether the
985 ;;; dictionary needs to be saved.
987 (defun ispell-pdict-save (&optional no-query force-save)
988 "Check to see if the personal dictionary has been modified.
989 If so, ask if it needs to be saved."
990 (interactive (list ispell-silently-savep t))
991 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
992 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
993 (if (or ispell-pdict-modified-p force-save)
994 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
996 (process-send-string ispell-process "#\n")
997 (message "Personal dictionary saved."))))
998 ;; unassert variable, even if not saved to avoid questioning.
999 (setq ispell-pdict-modified-p nil))
1002 (defun ispell-command-loop (miss guess word start end)
1003 "Display possible corrections from list MISS.
1004 GUESS lists possibly valid affix construction of WORD.
1005 Returns nil to keep word.
1006 Returns 0 to insert locally into buffer-local dictionary.
1007 Returns string for new chosen word.
1008 Returns list for new replacement word (will be rechecked).
1009 Highlights the word, which is assumed to run from START to END.
1010 Global `ispell-pdict-modified-p' becomes a list where the only value
1011 indicates whether the dictionary has been modified when option `a' or `i' is
1013 (let ((textbuf (current-buffer))
1016 (max-lines (- (window-height) 4)) ; assure 4 context lines.
1018 (window-min-height (min window-min-height
1019 ispell-choices-win-default-height))
1020 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1022 char num result textwin highlighted)
1024 ;; setup the *Choices* buffer with valid data.
1026 (set-buffer (get-buffer-create ispell-choices-buffer))
1027 (setq mode-line-format (concat "-- %b -- word: " word))
1031 (insert "Affix rules generate and capitalize "
1032 "this word as shown below:\n\t")
1034 (if (> (+ 4 (current-column) (length (car guess)))
1038 (setq line (1+ line))))
1039 (insert (car guess) " ")
1040 (setq guess (cdr guess)))
1041 (insert "\nUse option `i' if this is a correct composition"
1042 " from the derivative root.\n")
1043 (setq line (+ line (if choices 3 2)))))
1045 (< (if (> (+ 7 (current-column) (length (car choices))
1046 (if (> count ?~) 3 0))
1050 (setq line (1+ line)))
1053 ;; not so good if there are over 20 or 30 options, but then, if
1054 ;; there are that many you don't want to scan them all anyway...
1055 (while (memq count command-characters) ; skip command characters.
1056 (setq count (1+ count)
1057 skipped (1+ skipped)))
1058 (insert "(" count ") " (car choices) " ")
1059 (setq choices (cdr choices)
1061 (setq count (- count ?0 skipped)))
1063 ;; Assure word is visible
1064 (if (not (pos-visible-in-window-p end))
1066 ;; Display choices for misspelled word.
1067 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1069 (if (= line (window-height choices-window))
1070 (select-window choices-window)
1071 ;; *Choices* window changed size. Adjust the choices window
1072 ;; without scrolling the spelled window when possible
1073 (let ((window-line (- line (window-height choices-window)))
1074 (visible (progn (forward-line -1) (point))))
1075 (if (< line ispell-choices-win-default-height)
1076 (setq window-line (+ window-line
1077 (- ispell-choices-win-default-height
1079 (move-to-window-line 0)
1080 (forward-line window-line)
1081 (set-window-start (selected-window)
1082 (if (> (point) visible) visible (point)))
1084 (select-window (previous-window)) ; *Choices* window
1085 (enlarge-window window-line)))
1086 ;; Overlay *Choices* window when it isn't showing
1087 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1088 (switch-to-buffer ispell-choices-buffer)
1089 (goto-char (point-min)))
1091 (select-window (setq textwin (next-window)))
1093 ;; highlight word, protecting current buffer status
1096 (if ispell-highlight-p
1097 (ispell-highlight-spelling-error start end t))
1098 ;; Loop until a valid choice is made.
1106 (let (message-log-max)
1107 (message (concat "C-h or ? for more options; SPC to leave "
1108 "unchanged, Character to replace word")))
1109 (let ((inhibit-quit t))
1110 (setq char (if (fboundp 'read-char-exclusive)
1111 (read-char-exclusive)
1114 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1117 ;; Adjust num to array offset skipping command characters.
1118 (let ((com-chars command-characters))
1120 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1121 (setq skipped (1+ skipped)))
1122 (setq com-chars (cdr com-chars)))
1123 (setq num (- char ?0 skipped)))
1126 ((= char ? ) nil) ; accept word this time only
1127 ((= char ?i) ; accept and insert word into pers dict
1128 (process-send-string ispell-process (concat "*" word "\n"))
1129 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1131 ((or (= char ?a) (= char ?A)) ; accept word without insert
1132 (process-send-string ispell-process (concat "@" word "\n"))
1133 (if (null ispell-pdict-modified-p)
1134 (setq ispell-pdict-modified-p
1135 (list ispell-pdict-modified-p)))
1136 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1137 ((or (= char ?r) (= char ?R)) ; type in replacement
1138 (if (or (= char ?R) ispell-query-replace-choices)
1139 (list (read-string "Query-replacement for: " word) t)
1140 (cons (read-string "Replacement for: " word) nil)))
1141 ((or (= char ??) (= char help-char) (= char ?\C-h))
1144 ;; Quit and move point back.
1146 (ispell-pdict-save ispell-silently-savep)
1147 (message "Exited spell-checking")
1148 (setq ispell-quit t)
1150 ;; Quit and preserve point.
1152 (ispell-pdict-save ispell-silently-savep)
1154 (substitute-command-keys
1155 (concat "Spell-checking suspended;"
1156 " use C-u \\[ispell-word] to resume")))
1157 (setq ispell-quit (max (point-min)
1158 (- (point) (length word))))
1161 (if (y-or-n-p "Really kill Ispell process? ")
1163 (ispell-kill-ispell t) ; terminate process.
1164 (setq ispell-quit (or (not ispell-checking-message)
1166 ispell-pdict-modified-p nil))
1167 t)) ; continue if they don't quit.
1169 (let ((new-word (read-string
1170 "Lookup string (`*' is wildcard): "
1176 (set-buffer (get-buffer-create
1177 ispell-choices-buffer))
1181 mode-line-format (concat
1184 miss (lookup-words new-word)
1186 (while (and choices ; adjust choices window.
1187 (< (if (> (+ 7 (current-column)
1188 (length (car choices))
1189 (if (> count ?~) 3 0))
1197 (while (memq count command-characters)
1198 (setq count (1+ count)
1199 skipped (1+ skipped)))
1200 (insert "(" count ") " (car choices) " ")
1201 (setq choices (cdr choices)
1203 (setq count (- count ?0 skipped)))
1204 (select-window (previous-window))
1205 (if (and (/= new-line line)
1206 (> (max line new-line)
1207 ispell-choices-win-default-height))
1208 (let* ((minh ispell-choices-win-default-height)
1209 (gr-bl (if (< line minh) ; blanks
1212 (shr-bl (if (< new-line minh) ; blanks
1215 (if (> new-line line)
1216 (enlarge-window (- new-line line gr-bl))
1217 (shrink-window (- line new-line shr-bl)))
1218 (setq line new-line)))
1219 (select-window (next-window)))))
1220 t) ; reselect from new choices
1222 (process-send-string ispell-process
1223 (concat "*" (downcase word) "\n"))
1224 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1226 ((= char ?m) ; type in what to insert
1227 (process-send-string
1228 ispell-process (concat "*" (read-string "Insert: " word)
1230 (setq ispell-pdict-modified-p '(t))
1232 ((and (>= num 0) (< num count))
1233 (if ispell-query-replace-choices ; Query replace flag
1234 (list (nth num miss) 'query-replace)
1239 (save-window-excursion (recursive-edit)) t)
1241 (funcall (key-binding "\C-z"))
1246 (if ispell-highlight-p ; unhighlight
1247 (save-window-excursion
1248 (select-window textwin)
1249 (ispell-highlight-spelling-error start end))))))
1253 (defun ispell-help ()
1254 "Display a list of the options available when a misspelling is encountered.
1258 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1259 SPC: Accept word this time.
1260 `i': Accept word and insert into private dictionary.
1261 `a': Accept word for this session.
1262 `A': Accept word and place in `buffer-local dictionary'.
1263 `r': Replace word with typed-in value. Rechecked.
1264 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1265 `?': Show these commands.
1266 `x': Exit spelling buffer. Move cursor to original point.
1267 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1268 the aborted check to be completed later.
1269 `q': Quit spelling session (Kills ispell process).
1270 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1271 `u': Like `i', but the word is lower-cased first.
1272 `m': Like `i', but allows one to include dictionary completion information.
1273 `C-l': redraws screen
1274 `C-r': recursive edit
1275 `C-z': suspend emacs or iconify frame"
1277 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1278 "[i]nsert into private dictionary"))
1279 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1280 "e[x/X]it; [q]uit session"))
1281 (help-3 (concat "[u]ncapitalized insert into dictionary. "
1282 "Type 'C-h d ispell-help' for more help")))
1283 (save-window-excursion
1284 (if ispell-help-in-bufferp
1286 (ispell-overlay-window 4)
1287 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1288 (insert (concat help-1 "\n" help-2 "\n" help-3))
1290 (kill-buffer "*Ispell Help*"))
1291 (select-window (minibuffer-window))
1292 ;;(enlarge-window 2)
1294 (cond ((string-match "Lucid" emacs-version)
1300 (goto-char (point-min)))
1302 (if (string-lessp "19" emacs-version)
1305 ;; Make sure we display the minibuffer
1306 ;; in this window, not some other.
1307 (set-minibuffer-window (selected-window))
1308 (insert (concat help-1 "\n" help-2 "\n" help-3))))
1313 (defun lookup-words (word &optional lookup-dict)
1314 "Look up word in word-list dictionary.
1315 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1316 Otherwise the variable `ispell-grep-command' contains the command used to
1317 search for the words (usually egrep).
1319 Optional second argument contains the dictionary to use; the default is
1320 `ispell-alternate-dictionary'."
1321 ;; We don't use the filter for this function, rather the result is written
1322 ;; into a buffer. Hence there is no need to save the filter values.
1323 (if (null lookup-dict)
1324 (setq lookup-dict ispell-alternate-dictionary))
1326 (let* ((process-connection-type ispell-use-ptys-p)
1327 (wild-p (string-match "\\*" word))
1328 (look-p (and ispell-look-p ; Only use look for an exact match.
1329 (or ispell-have-new-look (not wild-p))))
1330 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1331 (prog (if look-p ispell-look-command ispell-grep-command))
1332 (args (if look-p ispell-look-options ispell-grep-options))
1335 (save-window-excursion
1336 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1337 (set-buffer ispell-grep-buffer)
1341 (insert "^" word "$")
1342 (while (search-backward "*" nil t) (insert "."))
1343 (setq word (buffer-string))
1345 (setq status (call-process prog nil t nil args word lookup-dict))
1346 ;; grep returns status 1 and no output when word not found, which
1347 ;; is a perfectly normal thing.
1348 (if (stringp status)
1349 (setq results (cons (format "error: %s exited with signal %s"
1350 (file-name-nondirectory prog) status)
1352 ;; else collect words into `results' in FIFO order
1353 (goto-char (point-max))
1354 ;; assure we've ended with \n
1355 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1359 (setq results (cons (buffer-substring (point) (1- loc))
1362 (kill-buffer ispell-grep-buffer)
1363 (if (and results (string-match ".+: " (car results)))
1364 (error "%s error: %s" ispell-grep-command (car results))))
1368 ;;; "ispell-filter" is a list of output lines from the generating function.
1369 ;;; Each full line (ending with \n) is a separate item on the list.
1370 ;;; "output" can contain multiple lines, part of a line, or both.
1371 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1373 ;;; "ispell-filter-continue" is true when we have received only part of a
1374 ;;; line as output from a generating function ("output" did not end with \n)
1375 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
1376 ;;; This is the case when a process dies or fails. The default behavior
1377 ;;; in this case treats the next input received as fresh input.
1379 (defun ispell-filter (process output)
1380 "Output filter function for ispell, grep, and look."
1385 (setq end (string-match "\n" output start)) ; get text up to the newline.
1386 ;; If we get out of sync and ispell-filter-continue is asserted when we
1387 ;; are not continuing, treat the next item as a separate list. When
1388 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1391 ;; Continue with same line (item)?
1392 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1393 ;; Yes. Add it to the prev item
1394 (setcar ispell-filter
1395 (concat (car ispell-filter) (substring output start end)))
1396 ;; No. This is a new line and item.
1398 (cons (substring output start end) ispell-filter)))
1400 ;; We've completed reading the output, but didn't finish the line.
1401 (setq ispell-filter-continue t continue nil)
1402 ;; skip over newline, this line complete.
1403 (setq ispell-filter-continue nil end (1+ end))
1404 (if (= end (length output)) ; No more lines in output
1405 (setq continue nil) ; so we can exit the filter.
1406 (setq start end)))))) ; else move start to next line of input
1409 ;;; This function destroys the mark location if it is in the word being
1411 (defun ispell-highlight-spelling-error-generic (start end &optional highlight)
1412 "Highlight the word from START to END with a kludge using `inverse-video'.
1413 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1414 otherwise it is displayed normally."
1415 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1416 (buffer-read-only nil) ; Allow highlighting read-only buffers.
1417 (text (buffer-substring start end)) ; Save highlight region
1418 (inhibit-quit t) ; inhibit interrupt processing here.
1419 (buffer-undo-list t)) ; don't clutter the undo list.
1420 (delete-region start end)
1421 (insert-char ? (- end start)) ; minimize amount of redisplay
1422 (sit-for 0) ; update display
1423 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1424 (delete-region start end) ; delete whitespace
1425 (insert text) ; insert text in inverse video.
1426 (sit-for 0) ; update display showing inverse video.
1427 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1428 (set-buffer-modified-p modified))) ; don't modify if flag not set.
1431 (defun ispell-highlight-spelling-error-lucid (start end &optional highlight)
1432 "Highlight the word from START to END using `isearch-highlight'.
1433 When the optional third arg HIGHLIGHT is set, the word is highlighted,
1434 otherwise it is displayed normally."
1436 (isearch-highlight start end)
1437 (isearch-dehighlight t))
1442 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
1443 "Highlight the word from START to END using overlays.
1444 When the optional third arg HIGHLIGHT is set, the word is highlighted
1445 otherwise it is displayed normally.
1447 The variable `ispell-highlight-face' selects the face to use for highlighting."
1450 (setq ispell-overlay (make-overlay start end))
1451 (overlay-put ispell-overlay 'face ispell-highlight-face))
1452 (delete-overlay ispell-overlay)))
1455 (defun ispell-highlight-spelling-error (start end &optional highlight)
1457 ((string-match "Lucid" emacs-version)
1458 (ispell-highlight-spelling-error-lucid start end highlight))
1459 ((and (string-lessp "19" emacs-version)
1460 (featurep 'faces) window-system)
1461 (ispell-highlight-spelling-error-overlay start end highlight))
1462 (t (ispell-highlight-spelling-error-generic start end highlight))))
1465 (defun ispell-overlay-window (height)
1466 "Create a window covering the top HEIGHT lines of the current window.
1467 Ensure that the line above point is still visible but otherwise avoid
1468 scrolling the current window. Leave the new window selected."
1470 (let ((oldot (save-excursion (forward-line -1) (point)))
1471 (top (save-excursion (move-to-window-line height) (point))))
1472 ;; If line above old point (line starting at olddot) would be
1473 ;; hidden by new window, scroll it to just below new win
1474 ;; otherwise set top line of other win so it doesn't scroll.
1475 (if (< oldot top) (setq top oldot))
1476 ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
1477 ;; line) is demanded, the last line is not visible.
1478 ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
1479 ;; So we increment the height for this case.
1480 (if (string-match "19\.9.*Lucid" (emacs-version))
1481 (setq height (1+ height)))
1482 (split-window nil height)
1483 (set-window-start (next-window) top))))
1486 ;;; Should we add a compound word match return value?
1487 (defun ispell-parse-output (output)
1488 "Parse the OUTPUT string from Ispell and return:
1489 1: t for an exact match.
1490 2: A string containing the root word for a match via suffix removal.
1491 3: A list of possible correct spellings of the format:
1492 '(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
1493 ORIGINAL-WORD is a string of the possibly misspelled word.
1494 OFFSET is an integer giving the line offset of the word.
1495 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses."
1497 ((string= output "") t) ; for startup with pipes...
1498 ((string= output "*") t) ; exact match
1499 ((string= output "-") t) ; compound word match
1500 ((string= (substring output 0 1) "+") ; found cuz of root word
1501 (substring output 2)) ; return root word
1502 (t ; need to process &, ?, and #'s
1503 (let ((type (substring output 0 1)) ; &, ?, or #
1504 (original-word (substring output 2 (string-match " " output 2)))
1505 (cur-count 0) ; contains number of misses + guesses
1506 count miss-list guess-list offset)
1507 (setq output (substring output (match-end 0))) ; skip over misspelling
1508 (if (string= type "#")
1509 (setq count 0) ; no misses for type #
1510 (setq count (string-to-int output) ; get number of misses.
1511 output (substring output (1+ (string-match " " output 1)))))
1512 (setq offset (string-to-int output))
1513 (if (string= type "#") ; No miss or guess list.
1515 (setq output (substring output (1+ (string-match " " output 1)))))
1517 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
1518 (setq cur-count (1+ cur-count))
1519 (if (> cur-count count)
1520 (setq guess-list (cons (substring output 0 end) guess-list))
1521 (setq miss-list (cons (substring output 0 end) miss-list)))
1522 (if (match-end 1) ; True only when at end of line.
1523 (setq output nil) ; no more misses or guesses
1524 (setq output (substring output (+ end 2))))))
1525 (list original-word offset miss-list guess-list)))))
1528 (defun check-ispell-version ()
1529 ;; This is a little wasteful as we actually launch ispell twice: once
1530 ;; to make sure it's the right version, and once for real. But people
1531 ;; get confused by version mismatches *all* the time (and I've got the
1532 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
1533 ;; option is the only way I can think of to do this that works with
1534 ;; all versions, since versions earlier than 3.0.09 didn't identify
1535 ;; themselves on startup.
1537 (let ((case-fold-search t)
1538 ;; avoid bugs when syntax of `.' changes in various default modes
1539 (default-major-mode 'fundamental-mode)
1541 (set-buffer (get-buffer-create " *ispell-tmp*"))
1543 (setq status (call-process ispell-program-name nil t nil "-v"))
1544 (goto-char (point-min))
1545 (if (not (memq status '(0 nil)))
1546 (error "%s exited with %s %s" ispell-program-name
1547 (if (stringp status) "signal" "code") status))
1548 (if (not (re-search-forward
1550 (regexp-quote (car ispell-required-version))
1551 "\\)\\([0-9]*\\)\\b")
1554 "%s version %s* is required: try renaming ispell4.el to ispell.el"
1555 ispell-program-name (car ispell-required-version))
1556 ;; check that it is the correct version.
1557 (if (< (car (read-from-string (buffer-substring
1558 (match-beginning 2) (match-end 2))))
1559 (car (cdr ispell-required-version)))
1560 (setq ispell-offset 0)))
1561 (kill-buffer (current-buffer)))))
1564 (defun ispell-init-process ()
1565 "Check status of Ispell process and start if necessary."
1566 (if (and ispell-process
1567 (eq (process-status ispell-process) 'run)
1568 ;; If we're using a personal dictionary, assure
1569 ;; we're in the same default directory!
1570 (or (not ispell-personal-dictionary)
1571 (equal ispell-process-directory default-directory)))
1572 (setq ispell-filter nil ispell-filter-continue nil)
1573 ;; may need to restart to select new personal dictionary.
1574 (ispell-kill-ispell t)
1575 (message "Starting new Ispell process...")
1577 (check-ispell-version)
1578 (setq ispell-process
1579 (let ((process-connection-type ispell-use-ptys-p))
1580 (apply 'start-process
1581 "ispell" nil ispell-program-name
1582 "-a" ; accept single input lines
1583 "-m" ; make root/affix combos not in dict
1585 ;; Local dictionary becomes the global dictionary in use.
1586 (if ispell-local-dictionary
1587 (setq ispell-dictionary ispell-local-dictionary))
1588 (setq args (ispell-get-ispell-args))
1589 (if ispell-dictionary ; use specified dictionary
1591 (append (list "-d" ispell-dictionary) args)))
1592 (if ispell-personal-dictionary ; use specified pers dict
1597 ispell-personal-dictionary)))))
1598 (setq args (append args ispell-extra-args))
1601 ispell-filter-continue nil
1602 ispell-process-directory default-directory)
1603 (set-process-filter ispell-process 'ispell-filter)
1604 (accept-process-output ispell-process) ; Get version ID line
1605 (cond ((null ispell-filter)
1606 (error "%s did not output version line" ispell-program-name))
1608 (stringp (car ispell-filter))
1609 (if (string-match "warning: " (car ispell-filter))
1611 (accept-process-output ispell-process 5) ; 1st was warn msg.
1612 (stringp (car ispell-filter)))
1613 (null (cdr ispell-filter)))
1614 (string-match "^@(#) " (car ispell-filter)))
1615 ;; got the version line as expected (we already know it's the right
1616 ;; version, so don't bother checking again.)
1619 ;; Otherwise, it must be an error message. Show the user.
1620 ;; But first wait to see if some more output is going to arrive.
1621 ;; Otherwise we get cool errors like "Can't open ".
1623 (accept-process-output)
1624 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
1625 (setq ispell-filter nil) ; Discard version ID line
1626 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1627 (if extended-char-mode
1628 (process-send-string ispell-process
1629 (concat extended-char-mode "\n"))))
1630 (process-kill-without-query ispell-process)))
1633 (defun ispell-kill-ispell (&optional no-error)
1634 "Kill current Ispell process (so that you may start a fresh one).
1635 With NO-ERROR, just return non-nil if there was no Ispell running."
1637 (if (not (and ispell-process
1638 (eq (process-status ispell-process) 'run)))
1640 (error "There is no ispell process running!"))
1641 (kill-process ispell-process)
1642 (setq ispell-process nil)
1643 (message "Ispell process killed")
1647 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
1648 ;;; call ispell-init-process rather than wait for a spell checking command?
1651 (defun ispell-change-dictionary (dict &optional arg)
1652 "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
1653 A new one will be started as soon as necessary.
1655 By just answering RET you can find out what the current dictionary is.
1657 With prefix argument, set the default directory."
1659 (list (completing-read
1660 "Use new dictionary (RET for current, SPC to complete): "
1661 (cons (cons "default" nil) ispell-dictionary-alist) nil t)
1662 current-prefix-arg))
1663 (if (equal dict "default") (setq dict nil))
1664 ;; This relies on completing-read's bug of returning "" for no match
1665 (cond ((equal dict "")
1666 (message "Using %s dictionary"
1667 (or ispell-local-dictionary ispell-dictionary "default")))
1668 ((and (equal dict ispell-dictionary)
1669 (or (null ispell-local-dictionary)
1670 (equal dict ispell-local-dictionary)))
1671 ;; Specified dictionary is the default already. No-op
1672 (and (interactive-p)
1673 (message "No change, using %s dictionary" (or dict "default"))))
1674 (t ; reset dictionary!
1675 (if (assoc dict ispell-dictionary-alist)
1677 (if (or arg (null dict)) ; set default dictionary
1678 (setq ispell-dictionary dict))
1679 (if (null arg) ; set local dictionary
1680 (setq ispell-local-dictionary dict)))
1681 (error "Illegal dictionary: %s" dict))
1682 (ispell-kill-ispell t)
1683 (message "(Next %sIspell command will use %s dictionary)"
1684 (cond ((equal ispell-local-dictionary ispell-dictionary)
1688 (or (if (or (equal ispell-local-dictionary ispell-dictionary)
1690 ispell-local-dictionary
1695 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
1698 (defun ispell-region (reg-start reg-end)
1699 "Interactively check a region for spelling errors."
1700 (interactive "r") ; Don't flag errors on read-only bufs.
1701 (ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
1704 (message "Spell checking %s using %s dictionary..."
1705 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
1706 (buffer-name) "region")
1707 (or ispell-dictionary "default"))
1708 ;; Returns cursor to original location.
1709 (save-window-excursion
1710 (goto-char reg-start)
1711 (let ((transient-mark-mode nil)
1713 (while (and (not ispell-quit) (< (point) reg-end))
1714 (let ((start (point))
1716 (end (save-excursion (end-of-line) (min (point) reg-end)))
1717 (ispell-casechars (ispell-get-casechars))
1719 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
1720 ((eolp) ; END OF LINE, just go to next line.
1722 ((and (null ispell-check-comments) ; SKIPPING COMMENTS
1723 comment-start ; skip comments that start on the line.
1724 (search-forward comment-start end t)) ; or found here.
1725 (if (= (- (point) start) (length comment-start))
1726 ;; comment starts the line. Skip entire line or region
1727 (if (string= "" comment-end) ; skip to next line
1728 (beginning-of-line 2) ; or jump to comment end.
1729 (search-forward comment-end reg-end 'limit))
1730 ;; Comment later in line. Check spelling before comment.
1731 (let ((limit (- (point) (length comment-start))))
1732 (goto-char (1- limit))
1733 (if (looking-at "\\\\") ; "quoted" comment, don't skip
1734 ;; quoted comment. Skip over comment-start
1735 (if (= start (1- limit))
1736 (setq limit (+ limit (length comment-start)))
1737 (setq limit (1- limit))))
1739 ;; Only check when "casechars" or math before comment
1740 (if (or (re-search-forward ispell-casechars limit t)
1741 (re-search-forward "[][()$]" limit t))
1743 (concat "^" (buffer-substring start limit)
1745 offset-change (- offset-change ispell-offset)))
1746 (goto-char limit))))
1747 ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
1749 ((or (and ispell-skip-tib ; SKIP TIB REFERENCES OR SGML MARKUP
1750 (re-search-forward ispell-tib-ref-beginning end t)
1751 (setq ref-type 'tib))
1752 (and ispell-skip-sgml
1753 (re-search-forward "[<&]" end t)
1754 (setq ref-type 'sgml)))
1755 (if (or (and (eq 'tib ref-type) ; tib tag is 2 chars.
1756 (= (- (point) 2) start))
1757 (and (eq 'sgml ref-type) ; sgml skips 1 char.
1758 (= (- (point) 1) start)))
1759 ;; Skip to end of reference, not necessarily on this line
1760 ;; Return an error if tib/sgml reference not found
1765 (re-search-forward ispell-tib-ref-end reg-end t)))
1766 (and (eq 'sgml ref-type)
1767 (not (re-search-forward "[>;]" reg-end t))))
1769 (ispell-pdict-save ispell-silently-savep)
1773 "Open tib or SGML command. Fix buffer or set "
1774 (if (eq 'tib ref-type)
1778 ;; keep cursor at error location
1779 (setq ispell-quit (- (point) 2))))
1780 ;; Check spelling between reference and start of the line.
1781 (let ((limit (- (point) (if (eq 'tib ref-type) 2 1))))
1783 (if (or (re-search-forward ispell-casechars limit t)
1784 (re-search-forward "[][()$]" limit t))
1786 (concat "^" (buffer-substring start limit)
1788 offset-change (- offset-change ispell-offset)))
1789 (goto-char limit))))
1790 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
1791 (re-search-forward "[][()$]" end t)) ; or MATH COMMANDS
1792 (setq string (concat "^" (buffer-substring start end) "\n")
1793 offset-change (- offset-change ispell-offset))
1795 (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
1797 (setq end (point)) ; "end" tracks end of region to check.
1799 (if string ; there is something to spell!
1801 ;; send string to spell process and get input.
1802 (process-send-string ispell-process string)
1804 (accept-process-output ispell-process)
1805 ;; Last item of output contains a blank line.
1806 (not (string= "" (car ispell-filter)))))
1807 ;; parse all inputs from the stream one word at a time.
1808 ;; Place in FIFO order and remove the blank item.
1809 (setq ispell-filter (nreverse (cdr ispell-filter)))
1810 (while (and (not ispell-quit) ispell-filter)
1811 (setq poss (ispell-parse-output (car ispell-filter)))
1812 (if (listp poss) ; spelling error occurred.
1813 (let* ((word-start (+ start offset-change
1815 (word-end (+ word-start
1816 (length (car poss))))
1818 (goto-char word-start)
1819 ;; Adjust the horizontal scroll & point
1820 (ispell-horiz-scroll)
1821 (goto-char word-end)
1822 (ispell-horiz-scroll)
1823 (goto-char word-start)
1824 (ispell-horiz-scroll)
1827 (search-forward (car poss) word-end t)
1829 ;; This occurs due to filter pipe problems
1831 (concat "Ispell misalignment: word "
1832 "`%s' point %d; please retry")
1833 (car poss) word-start))
1834 (if (not (pos-visible-in-window-p))
1836 (if ispell-keep-choices-win
1838 (ispell-command-loop
1839 (car (cdr (cdr poss)))
1840 (car (cdr (cdr (cdr poss))))
1841 (car poss) word-start word-end))
1842 (save-window-excursion
1844 (ispell-command-loop
1845 (car (cdr (cdr poss)))
1846 (car (cdr (cdr (cdr poss))))
1847 (car poss) word-start word-end))))
1849 ((and replace (listp replace))
1850 ;; REPLACEMENT WORD entered. Recheck line
1851 ;; starting with the replacement word.
1852 (setq ispell-filter nil
1853 string (buffer-substring word-start
1855 (let ((change (- (length (car replace))
1856 (length (car poss)))))
1858 (setq reg-end (+ reg-end change)
1859 offset-change (+ offset-change
1861 (if (not (equal (car replace) (car poss)))
1863 (delete-region word-start word-end)
1864 (insert (car replace))))
1865 ;; I only need to recheck typed-in replacements
1866 (if (not (eq 'query-replace
1867 (car (cdr replace))))
1868 (backward-char (length (car replace))))
1869 (setq end (point)) ; reposition for recheck
1870 ;; when second arg exists, query-replace, saving regions
1871 (if (car (cdr replace))
1873 (save-window-excursion
1875 ispell-query-replace-marker reg-end)
1876 ;; Assume case-replace &
1877 ;; case-fold-search correct?
1878 (query-replace string (car replace)
1882 ispell-query-replace-marker))
1883 (set-marker ispell-query-replace-marker
1886 (equal 0 replace)) ; ACCEPT/INSERT
1887 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
1889 (ispell-add-per-file-word-list
1890 (car poss) reg-end)))
1891 ;; This avoids pointing out the word that was
1892 ;; just accepted (via 'i' or 'a') if it follows
1893 ;; on the same line.
1894 ;; Redo check following the accepted word.
1895 (if (and ispell-pdict-modified-p
1896 (listp ispell-pdict-modified-p))
1897 ;; Word accepted. Recheck line.
1898 (setq ispell-pdict-modified-p ; update flag
1899 (car ispell-pdict-modified-p)
1900 ispell-filter nil ; discontinue check
1901 end word-start))) ; reposition loc.
1902 (replace ; STRING REPLACEMENT for this word.
1903 (delete-region word-start word-end)
1905 (let ((change (- (length replace)
1906 (length (car poss)))))
1907 (setq reg-end (+ reg-end change)
1908 offset-change (+ offset-change change)
1909 end (+ end change)))))
1910 (if (not ispell-quit)
1911 (let (message-log-max)
1912 (message "Continuing spelling check using %s dictionary..."
1913 (or ispell-dictionary "default"))))
1915 ;; finished with line!
1916 (setq ispell-filter (cdr ispell-filter)))))
1920 (if (get-buffer ispell-choices-buffer)
1921 (kill-buffer ispell-choices-buffer))
1924 ;; preserve or clear the region for ispell-continue.
1925 (if (not (numberp ispell-quit))
1926 (set-marker ispell-region-end nil)
1927 ;; Enable ispell-continue.
1928 (set-marker ispell-region-end reg-end)
1929 (goto-char ispell-quit))
1930 ;; Check for aborting
1931 (if (and ispell-checking-message (numberp ispell-quit))
1933 (setq ispell-quit nil)
1934 (error "Message send aborted.")))
1935 (setq ispell-quit nil))
1936 (set-marker ispell-region-end nil)
1937 ;; Only save if successful exit.
1938 (ispell-pdict-save ispell-silently-savep)
1939 (message "Spell-checking done"))))
1944 (defun ispell-buffer ()
1945 "Check the current buffer for spelling errors interactively."
1947 (ispell-region (point-min) (point-max)))
1951 (defun ispell-continue ()
1953 "Continue a spelling session after making some changes."
1954 (if (not (marker-position ispell-region-end))
1955 (message "No session to continue. Use 'X' command when checking!")
1956 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
1957 (message "Must continue ispell from buffer %s"
1958 (buffer-name (marker-buffer ispell-region-end)))
1959 (ispell-region (point) (marker-position ispell-region-end)))))
1962 ;;; Horizontal scrolling
1963 (defun ispell-horiz-scroll ()
1964 "Places point within the horizontal visibility of its window area."
1965 (if truncate-lines ; display truncating lines?
1966 ;; See if display needs to be scrolled.
1967 (let ((column (- (current-column) (max (window-hscroll) 1))))
1968 (if (and (< column 0) (> (window-hscroll) 0))
1969 (scroll-right (max (- column) 10))
1970 (if (>= column (- (window-width) 2))
1971 (scroll-left (max (- column (window-width) -3) 10)))))))
1974 ;;; Interactive word completion.
1975 ;;; Forces "previous-word" processing. Do we want to make this selectable?
1978 (defun ispell-complete-word (&optional interior-frag)
1979 "Look up word before or under point in dictionary (see lookup-words command)
1980 and try to complete it. If optional INTERIOR-FRAG is non-nil then the word
1981 may be a character sequence inside of a word.
1983 Standard ispell choices are then available."
1985 (let ((cursor-location (point))
1987 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
1988 start end possibilities replacement)
1989 (setq start (car (cdr word))
1990 end (car (cdr (cdr word)))
1993 (or (string= word "") ; Will give you every word
1994 (lookup-words (concat (if interior-frag "*") word "*")
1995 ispell-complete-word-dict)))
1996 (cond ((eq possibilities t)
1997 (message "No word to complete"))
1998 ((null possibilities)
1999 (message "No match for \"%s\"" word))
2000 (t ; There is a modification...
2001 (cond ; Try and respect case of word.
2002 ((string-match "^[^A-Z]+$" word)
2003 (setq possibilities (mapcar 'downcase possibilities)))
2004 ((string-match "^[^a-z]+$" word)
2005 (setq possibilities (mapcar 'upcase possibilities)))
2006 ((string-match "^[A-Z]" word)
2007 (setq possibilities (mapcar 'capitalize possibilities))))
2008 (save-window-excursion
2010 (ispell-command-loop possibilities nil word start end)))
2012 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
2013 (ispell-add-per-file-word-list word))
2014 (replacement ; REPLACEMENT WORD
2015 (delete-region start end)
2016 (setq word (if (atom replacement) replacement (car replacement))
2017 cursor-location (+ (- (length word) (- end start))
2020 (if (not (atom replacement)) ; recheck spelling of replacement.
2022 (goto-char cursor-location)
2023 (ispell-word nil t)))))
2024 (if (get-buffer ispell-choices-buffer)
2025 (kill-buffer ispell-choices-buffer))))
2026 (ispell-pdict-save ispell-silently-savep)
2027 (goto-char cursor-location)))
2031 (defun ispell-complete-word-interior-frag ()
2032 "Completes word matching character sequence inside a word."
2034 (ispell-complete-word t))
2037 ;;; **********************************************************************
2038 ;;; Ispell Minor Mode
2039 ;;; **********************************************************************
2041 (defvar ispell-minor-mode nil
2042 "Non-nil if Ispell minor mode is enabled.")
2043 ;; Variable indicating that ispell minor mode is active.
2044 (make-variable-buffer-local 'ispell-minor-mode)
2046 (or (assq 'ispell-minor-mode minor-mode-alist)
2047 (setq minor-mode-alist
2048 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
2050 (defvar ispell-minor-keymap
2051 (let ((map (make-sparse-keymap)))
2052 (define-key map " " 'ispell-minor-check)
2053 (define-key map "\r" 'ispell-minor-check)
2055 "Keymap used for Ispell minor mode.")
2057 (or (not (boundp 'minor-mode-map-alist))
2058 (assoc 'ispell-minor-mode minor-mode-map-alist)
2059 (setq minor-mode-map-alist
2060 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
2061 minor-mode-map-alist)))
2064 (defun ispell-minor-mode (&optional arg)
2065 "Toggle Ispell minor mode.
2066 With prefix arg, turn Ispell minor mode on iff arg is positive.
2068 In Ispell minor mode, pressing SPC or RET
2069 warns you if the previous word is incorrectly spelled."
2071 (setq ispell-minor-mode
2072 (not (or (and (null arg) ispell-minor-mode)
2073 (<= (prefix-numeric-value arg) 0))))
2074 (force-mode-line-update))
2076 (defun ispell-minor-check ()
2077 ;; Check previous word then continue with the normal binding of this key.
2079 (let ((ispell-minor-mode nil)
2080 (ispell-check-only t))
2082 (narrow-to-region (point-min) (point))
2083 (ispell-word nil t))
2084 (call-interactively (key-binding (this-command-keys)))))
2087 ;;; **********************************************************************
2089 ;;; **********************************************************************
2090 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2093 (defvar ispell-message-text-end
2094 (mapconcat (function identity)
2096 ;; Matches postscript files.
2097 "^%!PS-Adobe-[123].0"
2098 ;; Matches uuencoded text
2099 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2100 ;; Matches shell files (esp. auto-decoding)
2102 ;; Matches context difference listing
2103 "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2104 ;; Matches reporter.el bug report
2105 "^current state:\n==============\n"
2106 ;; Matches "----------------- cut here"
2107 ;; and "------- Start of forwarded message",
2108 ;; or either one with "- " in front.
2109 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|\\(Start of \\)?forwarded message\\)")
2111 "*End of text which will be checked in ispell-message.
2112 If it is a string, limit at first occurrence of that regular expression.
2113 Otherwise, it must be a function which is called to get the limit.")
2116 (defvar ispell-message-start-skip
2117 (mapconcat (function identity)
2119 ;; Matches forwarded messages
2120 "^---* Forwarded Message"
2121 ;; Matches PGP Public Key block
2122 "^---*BEGIN PGP [A-Z ]*--*"
2125 "Spelling is skipped inside these start/end groups by ispell-message.
2126 Assumed that blocks are not mutually inclusive.")
2129 (defvar ispell-message-end-skip
2130 (mapconcat (function identity)
2132 ;; Matches forwarded messages
2133 "^--- End of Forwarded Message"
2134 ;; Matches PGP Public Key block
2135 "^---*END PGP [A-Z ]*--*"
2138 "Spelling is skipped inside these start/end groups by ispell-message.
2139 Assumed that blocks are not mutually inclusive.")
2143 (defun ispell-message ()
2144 "Check the spelling of a mail message or news post.
2145 Don't check spelling of message headers except the Subject field.
2146 Don't check included messages.
2148 To abort spell checking of a message region and send the message anyway,
2149 use the `x' command. (Any subsequent regions will be checked.)
2150 The `X' command aborts the message send so that you can edit the buffer.
2152 To spell-check whenever a message is sent, include the appropriate lines
2153 in your .emacs file:
2154 (add-hook 'message-send-hook 'ispell-message)
2155 (add-hook 'mail-send-hook 'ispell-message)
2156 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2158 You can bind this to the key C-c i in GNUS or mail by adding to
2159 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2160 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
2163 (goto-char (point-min))
2164 (let* ((internal-messagep (save-excursion
2167 (regexp-quote mail-header-separator)
2172 ((not ispell-message-text-end) (point-max))
2173 ((char-or-string-p ispell-message-text-end)
2174 (if (re-search-forward ispell-message-text-end nil t)
2177 (t (min (point-max) (funcall ispell-message-text-end))))))
2178 (cite-regexp ;Prefix of inserted text
2180 ((featurep 'supercite) ; sc 3.0
2181 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
2182 (ispell-non-empty-string sc-reference-tag-string)))
2183 ((featurep 'sc) ; sc 2.3
2184 (concat "\\(" sc-cite-regexp "\\)" "\\|"
2185 (ispell-non-empty-string sc-reference-tag-string)))
2186 ((equal major-mode 'news-reply-mode) ;GNUS 4 & below
2187 (concat "In article <" "\\|"
2188 (if mail-yank-prefix
2189 (ispell-non-empty-string mail-yank-prefix)
2191 ((equal major-mode 'message-mode) ;GNUS 5
2192 (concat ".*@.* writes:$" "\\|"
2193 (if mail-yank-prefix
2194 (ispell-non-empty-string mail-yank-prefix)
2196 ((equal major-mode 'mh-letter-mode) ; mh mail message
2197 (ispell-non-empty-string mh-ins-buf-prefix))
2198 ((not internal-messagep) ; Assume n sent us this message.
2199 (concat "In [a-zA-Z.]+ you write:" "\\|"
2200 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
2202 ((boundp 'vm-included-text-prefix) ; VM mail message
2203 (concat "[^,;&+=]+ writes:" "\\|"
2204 (ispell-non-empty-string vm-included-text-prefix)))
2205 (mail-yank-prefix ; vanilla mail message.
2206 (ispell-non-empty-string mail-yank-prefix))
2208 (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp))
2209 (cite-regexp-end (concat "^\\(" cite-regexp "\\)"))
2210 (old-case-fold-search case-fold-search)
2211 (case-fold-search t)
2212 (ispell-checking-message t))
2213 (goto-char (point-min))
2214 ;; Skip header fields except Subject: without Re:'s
2215 ;;(search-forward mail-header-separator nil t)
2216 (while (if internal-messagep
2217 (< (point) internal-messagep)
2218 (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
2220 (if (looking-at "Subject: *") ; Spell check new subject fields
2222 (goto-char (match-end 0))
2223 (if (and (not (looking-at ".*Re\\>"))
2224 (not (looking-at "\\[")))
2225 (let ((case-fold-search old-case-fold-search))
2226 (ispell-region (point)
2229 (while (looking-at "\n[ \t]")
2233 (setq case-fold-search nil)
2234 ;; Skip mail header, particularly for non-english languages.
2235 (if (looking-at (concat (regexp-quote mail-header-separator) "$"))
2237 (while (< (point) limit)
2238 ;; Skip across text cited from other messages.
2239 (while (and (looking-at cite-regexp-start)
2241 (zerop (forward-line 1))))
2243 (if (< (point) limit)
2244 (let* ((start (point))
2245 ;; Check the next batch of lines that *aren't* cited.
2246 (end-c (and (re-search-forward cite-regexp-end limit 'end)
2247 (match-beginning 0)))
2248 ;; Skip a block of included text.
2249 (end-fwd (and (goto-char start)
2250 (re-search-forward ispell-message-start-skip
2252 (progn (beginning-of-line)
2254 (end (or (and end-c end-fwd (min end-c end-fwd))
2256 ;; default to limit of text.
2257 (marker-position limit))))
2259 (ispell-region start end)
2260 (if (and end-fwd (= end end-fwd))
2263 (re-search-forward ispell-message-end-skip limit 'end))
2265 (set-marker limit nil))))
2268 (defun ispell-non-empty-string (string)
2269 (if (or (not string) (string-equal string ""))
2270 "\\'\\`" ; An unmatchable string if string is null.
2271 (regexp-quote string)))
2274 ;;; **********************************************************************
2275 ;;; Buffer Local Functions
2276 ;;; **********************************************************************
2279 (defun ispell-accept-buffer-local-defs ()
2280 "Load all buffer-local information, restarting ispell when necessary."
2281 (ispell-buffer-local-dict) ; May kill ispell-process.
2282 (ispell-buffer-local-words) ; Will initialize ispell-process.
2283 (ispell-buffer-local-parsing))
2286 (defun ispell-buffer-local-parsing ()
2287 "Place Ispell into parsing mode for this buffer.
2288 Overrides the default parsing mode.
2289 Includes latex/nroff modes and extended character mode."
2290 ;; (ispell-init-process) must already be called.
2291 (process-send-string ispell-process "!\n") ; Put process in terse mode.
2292 ;; We assume all major modes with "tex-mode" in them should use latex parsing
2293 (if (or (and (eq ispell-parser 'use-mode-name)
2294 (string-match "[Tt][Ee][Xx]-mode" (symbol-name major-mode)))
2295 (eq ispell-parser 'tex))
2296 (process-send-string ispell-process "+\n") ; set ispell mode to tex
2297 (process-send-string ispell-process "-\n")) ; set mode to normal (nroff)
2298 ;; Hard-wire test for SGML & HTML mode.
2299 (setq ispell-skip-sgml (memq major-mode '(sgml-mode html-mode)))
2300 ;; Set default extended character mode for given buffer, if any.
2301 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2302 (if extended-char-mode
2303 (process-send-string ispell-process (concat extended-char-mode "\n"))))
2304 ;; Set buffer-local parsing mode and extended character mode, if specified.
2306 (goto-char (point-min))
2307 ;; Uses last valid definition
2308 (while (search-forward ispell-parsing-keyword nil t)
2309 (let ((end (save-excursion (end-of-line) (point)))
2310 (case-fold-search t)
2312 (while (re-search-forward " *\\([^ \"]+\\)" end t)
2313 ;; space separated definitions.
2314 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2315 (cond ((string-match "latex-mode" string)
2316 (process-send-string ispell-process "+\n~tex\n"))
2317 ((string-match "nroff-mode" string)
2318 (process-send-string ispell-process "-\n~nroff"))
2319 ((string-match "~" string) ; Set extended character mode.
2320 (process-send-string ispell-process (concat string "\n")))
2321 (t (message "Illegal Ispell Parsing argument!")
2325 ;;; Can kill the current ispell process
2327 (defun ispell-buffer-local-dict ()
2328 "Initializes local dictionary.
2329 When a dictionary is defined in the buffer (see variable
2330 `ispell-dictionary-keyword'), it will override the local setting
2331 from \\[ispell-change-dictionary].
2332 Both should not be used to define a buffer-local dictionary."
2334 (goto-char (point-min))
2336 ;; Override the local variable definition.
2337 ;; Uses last valid definition.
2338 (while (search-forward ispell-dictionary-keyword nil t)
2339 (setq end (save-excursion (end-of-line) (point)))
2340 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2341 (setq ispell-local-dictionary
2342 (buffer-substring (match-beginning 1) (match-end 1)))))
2343 (goto-char (point-min))
2344 (while (search-forward ispell-pdict-keyword nil t)
2345 (setq end (save-excursion (end-of-line) (point)))
2346 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2347 (setq ispell-local-pdict
2348 (buffer-substring (match-beginning 1) (match-end 1)))))))
2349 ;; Reload if new personal dictionary defined.
2350 (if (and ispell-local-pdict
2351 (not (equal ispell-local-pdict ispell-personal-dictionary)))
2353 (ispell-kill-ispell t)
2354 (setq ispell-personal-dictionary ispell-local-pdict)))
2355 ;; Reload if new dictionary defined.
2356 (if (and ispell-local-dictionary
2357 (not (equal ispell-local-dictionary ispell-dictionary)))
2358 (ispell-change-dictionary ispell-local-dictionary)))
2361 (defun ispell-buffer-local-words ()
2362 "Loads the buffer-local dictionary in the current buffer."
2363 (if (and ispell-buffer-local-name
2364 (not (equal ispell-buffer-local-name (buffer-name))))
2366 (ispell-kill-ispell t)
2367 (setq ispell-buffer-local-name nil)))
2368 (ispell-init-process)
2370 (goto-char (point-min))
2371 (while (search-forward ispell-words-keyword nil t)
2372 (or ispell-buffer-local-name
2373 (setq ispell-buffer-local-name (buffer-name)))
2374 (let ((end (save-excursion (end-of-line) (point)))
2376 ;; buffer-local words separated by a space, and can contain
2377 ;; any character other than a space.
2378 (while (re-search-forward " *\\([^ ]+\\)" end t)
2379 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2380 (process-send-string ispell-process (concat "@" string "\n")))))))
2383 ;;; returns optionally adjusted region-end-point.
2385 (defun ispell-add-per-file-word-list (word &optional reg-end)
2386 "Adds new word to the per-file word list."
2387 (or ispell-buffer-local-name
2388 (setq ispell-buffer-local-name (buffer-name)))
2392 (goto-char (point-min))
2393 (let (case-fold-search line-okay search done string)
2395 (setq search (search-forward ispell-words-keyword nil 'move)
2396 line-okay (< (+ (length word) 1 ; 1 for space after word..
2397 (progn (end-of-line) (current-column)))
2399 (if (or (and search line-okay)
2406 (setq string (concat comment-start " "
2407 ispell-words-keyword))
2408 ;; in case the keyword is in the middle of the file....
2409 (if (> reg-end (point))
2410 (setq reg-end (+ reg-end (length string))))
2412 (if (and comment-end (not (equal "" comment-end)))
2416 (insert comment-end)))))
2417 (if (> reg-end (point))
2418 (setq reg-end (+ 1 reg-end (length word))))
2419 (insert (concat " " word)))))))
2423 (defconst ispell-version "2.37 -- Tue Jun 13 12:05:28 EDT 1995")
2428 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
2430 ;;; Local Variable options:
2431 ;;; mode: name(-mode)
2432 ;;; eval: expression
2433 ;;; local-variable: value
2435 ;;; The following sets the buffer local dictionary to english!
2437 ;;; Local Variables:
2438 ;;; mode: emacs-lisp
2439 ;;; comment-column: 40
2440 ;;; ispell-local-dictionary: "american"
2444 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
2446 ;;; The following places this file in nroff parsing and extended char modes.
2447 ;;; Local IspellParsing: nroff-mode ~nroff
2448 ;;; Change IspellDict to IspellDict: to enable the following line.
2449 ;;; Local IspellDict english
2450 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
2451 ;;; Local IspellPersDict ~/.ispell_lisp
2452 ;;; The following were automatically generated by ispell using the 'A' command:
2453 ; LocalWords: ispell ispell-highlight-p ispell-check-comments query-replace
2454 ; LocalWords: ispell-query-replace-choices ispell-skip-tib non-nil tib
2455 ; LocalWords: regexps ispell-tib-ref-beginning ispell-tib-ref-end
2457 ;; ispell.el ends here