1 ;;;;;;;;;;;;;;;;;;;;;;;;;;; -*- Mode: emacs-lisp -*- ;;;;;;;;;;;;;;;;;;;;;;;;;;
2 ;;; GNU EMACS interface for International Ispell Version 3.1 by Geoff Kuenning.
5 ;;; Copyright (C) 1994 Free Software Foundation, Inc.
8 ;;; Authors : Ken Stevens et. al.
9 ;;; Syntax : emacs-lisp
10 ;;; Status : Release with 3.1.05 ispell.
11 ;;; Version : International Ispell Version 3.1 by Geoff Kuenning.
12 ;;; Bug Reports : ispell-el-bugs@itcorp.com
14 ;;; This file is part of GNU Emacs.
16 ;;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;;; it under the terms of the GNU General Public License as published by
18 ;;; the Free Software Foundation; either version 2, or (at your option)
19 ;;; any later version.
21 ;;; GNU Emacs is distributed in the hope that it will be useful,
22 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;;; GNU General Public License for more details.
26 ;;; You should have received a copy of the GNU General Public License
27 ;;; along with GNU Emacs; see the file COPYING. If not, write to
28 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
34 ;;; This code contains a section of user-settable variables that you should
35 ;;; inspect prior to installation. Look past the end of the history list.
36 ;;; Set them up for your locale and the preferences of the majority of the
37 ;;; users. Otherwise the users may need to set a number of variables
39 ;;; You particularly may want to change the default dictionary for your
40 ;;; country and language.
43 ;;; To fully install this, add this file to your Emacs Lisp directory and
44 ;;; compile it with M-X byte-compile-file. Then add the following to the
45 ;;; appropriate init file:
47 ;;; (autoload 'ispell-word "ispell"
48 ;;; "Check the spelling of word in buffer." t)
49 ;;; (global-set-key "\e$" 'ispell-word)
50 ;;; (autoload 'ispell-region "ispell"
51 ;;; "Check the spelling of region." t)
52 ;;; (autoload 'ispell-buffer "ispell"
53 ;;; "Check the spelling of buffer." t)
54 ;;; (autoload 'ispell-complete-word "ispell"
55 ;;; "Look up current word in dictionary and try to complete it." t)
56 ;;; (autoload 'ispell-change-dictionary "ispell"
57 ;;; "Change ispell dictionary." t)
58 ;;; (autoload 'ispell-message "ispell"
59 ;;; "Check spelling of mail message or news post.")
61 ;;; Depending on the mail system you use, you may want to include these:
63 ;;; (add-hook 'news-inews-hook 'ispell-message)
64 ;;; (add-hook 'mail-send-hook 'ispell-message)
65 ;;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
68 ;;; Ispell has a TeX parser and a nroff parser (the default).
69 ;;; The parsing is controlled by the variable ispell-parser. Currently
70 ;;; it is just a "toggle" between TeX and nroff, but if more parsers are
71 ;;; added it will be updated. See the variable description for more info.
81 ;;; ispell-complete-word
82 ;;; ispell-complete-word-interior-frag
83 ;;; ispell-change-dictionary
84 ;;; ispell-kill-ispell
88 ;;; Commands in ispell-region:
89 ;;; Character replacement: Replace word with choice. May query-replace.
90 ;;; ' ': Accept word this time.
91 ;;; 'i': Accept word and insert into private dictionary.
92 ;;; 'a': Accept word for this session.
93 ;;; 'A': Accept word and place in buffer-local dictionary.
94 ;;; 'r': Replace word with typed-in value. Rechecked.
95 ;;; 'R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
96 ;;; '?': Show these commands
97 ;;; 'x': Exit spelling buffer. Move cursor to original point.
98 ;;; 'X': Exit spelling buffer. Leave cursor at the current point.
99 ;;; 'q': Quit spelling session (Kills ispell process).
100 ;;; 'l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
101 ;;; 'u': Like 'i', but the word is lower-cased first.
102 ;;; 'm': Like 'i', but allows one to include dictionary completion info.
103 ;;; 'C-l': redraws screen
104 ;;; 'C-r': recursive edit
105 ;;; 'C-z': suspend emacs or iconify frame
107 ;;; Buffer-Local features:
108 ;;; There are a number of buffer-local features that can be used to customize
109 ;;; ispell for the current buffer. This includes language dictionaries,
110 ;;; personal dictionaries, parsing, and local word spellings. Each of these
111 ;;; local customizations are done either through local variables, or by
112 ;;; including the keyword and argument(s) at the end of the buffer (usually
113 ;;; prefixed by the comment characters). See the end of this file for
114 ;;; examples. The local keywords and variables are:
116 ;;; ispell-dictionary-keyword language-dictionary
117 ;;; uses local variable ispell-local-dictionary
118 ;;; ispell-pdict-keyword personal-dictionary
119 ;;; uses local variable ispell-local-pdict
120 ;;; ispell-parsing-keyword mode-arg extended-char-arg
121 ;;; ispell-words-keyword any number of local word spellings
125 ;;; Highlighting in version 19 still doesn't work on tty's.
126 ;;; On some versions of emacs, growing the minibuffer fails.
130 ;;; Revision 2.30 1994/5/20 15:58:52 stevens
131 ;;; Continue ispell from ispell-word, C-z functionality fixed.
133 ;;; Revision 2.29 1994/5/12 09:44:33 stevens
134 ;;; Restored ispell-use-ptys-p, ispell-message aborts sends with interrupt.
135 ;;; defined fn ispell
137 ;;; Revision 2.28 1994/4/28 16:24:40 stevens
138 ;;; Window checking when ispell-message put on gnus-inews-article-hook jwz.
139 ;;; prefixed ispell- to highlight functions and horiz-scroll fn.
140 ;;; Try and respect case of word in ispell-complete-word.
141 ;;; Ignore non-char events. Ispell-use-ptys-p commented out. Lucid menu.
142 ;;; Better interrupt handling. ispell-message improvements from Ethan.
145 ;;; version 18 explicit C-g handling disabled as it didn't work. Added
146 ;;; ispell-extra-args for ispell customization (jwz)
148 ;;; Revision 2.26 1994/2/15 16:11:14 stevens
149 ;;; name changes for copyright assignment. Added word-frags in complete-word.
150 ;;; Horizontal scroll (John Conover). Query-replace matches words now. bugs.
153 ;;; minor mods, upgraded ispell-message
156 ;;; query-replace more robust, messages, defaults, ispell-change-dict.
158 ;;; Revision 2.23 1993/11/22 23:47:03 stevens
159 ;;; ispell-message, Fixed highlighting, added menu-bar, fixed ispell-help, ...
162 ;;; Added 'u' command. Fixed default in ispell-local-dictionary.
163 ;;; fixed affix rules display. Tib skipping more robust. Contributions by
164 ;;; Per Abraham (parser selection), Denis Howe, and Eberhard Mattes.
166 ;;; Revision 2.21 1993/06/30 14:09:04 stevens
167 ;;; minor bugs. (nroff word skipping fixed)
169 ;;; Revision 2.20 1993/06/30 14:09:04 stevens
171 ;;; Debugging and contributions by: Boris Aronov, Rik Faith, Chris Moore,
172 ;;; Kevin Rodgers, Malcolm Davis.
173 ;;; Particular thanks to Michael Lipp, Jamie Zawinski, Phil Queinnec
174 ;;; and John Heidemann for suggestions and code.
175 ;;; Major update including many tweaks.
176 ;;; Many changes were integrations of suggestions.
177 ;;; lookup-words rehacked to use call-process (Jamie).
178 ;;; ispell-complete-word rehacked to be compatible with the rest of the
179 ;;; system for word searching and to include multiple wildcards,
180 ;;; and it's own dictionary.
181 ;;; query-replace capability added. New options 'X', 'R', and 'A'.
182 ;;; buffer-local modes for dictionary, word-spelling, and formatter-parsing.
183 ;;; Many random bugs, like commented comments being skipped, fix to
184 ;;; keep-choices-win, fix for math mode, added pipe mode choice,
185 ;;; fixed 'q' command, ispell-word checks previous word and leave cursor
186 ;;; in same location. Fixed tib code which could drop spelling regions.
187 ;;; Cleaned up setq calls for efficiency. Gave more context on window overlays.
188 ;;; Assure context on ispell-command-loop. Window lossage in look cmd fixed.
189 ;;; Due to pervasive opinion, common-lisp package syntax removed. Display
190 ;;; problem when not highlighting.
192 ;;; Revision 2.19 1992/01/10 10:54:08 geoff
193 ;;; Make another attempt at fixing the "Bogus, dude" problem. This one is
194 ;;; less elegant, but has the advantage of working.
196 ;;; Revision 2.18 1992/01/07 10:04:52 geoff
197 ;;; Fix the "Bogus, Dude" problem in ispell-word.
199 ;;; Revision 2.17 1991/09/12 00:01:42 geoff
200 ;;; Add some changes to make ispell-complete-word work better, though
201 ;;; still not perfectly.
203 ;;; Revision 2.16 91/09/04 18:00:52 geoff
204 ;;; More updates from Sebastian, to make the multiple-dictionary support
207 ;;; Revision 2.15 91/09/04 17:30:02 geoff
208 ;;; Sebastian Kremer's tib support
210 ;;; Revision 2.14 91/09/04 16:19:37 geoff
211 ;;; Don't do set-window-start if the move-to-window-line moved us
212 ;;; downward, rather than upward. This prevents getting the buffer all
213 ;;; confused. Also, don't use the "not-modified" function to clear the
214 ;;; modification flag; instead use set-buffer-modified-p. This prevents
215 ;;; extra messages from flashing.
217 ;;; Revision 2.13 91/09/04 14:35:41 geoff
218 ;;; Fix a spelling error in a comment. Add code to handshake with the
219 ;;; ispell process before sending anything to it.
221 ;;; Revision 2.12 91/09/03 20:14:21 geoff
222 ;;; Add Sebastian Kremer's multiple-language support.
226 ;;; Texas Instruments - Computer Science Center
227 ;;; ARPA: Buehring%TI-CSL@CSNet-Relay
228 ;;; UUCP: {smu, texsun, im4u, rice} ! ti-csl ! buehring
230 ;;; ispell-region and associated routines added by
233 ;;; Tue Jan 13 20:18:02 CST 1987
235 ;;; extensively modified by Mark Davies and Andrew Vignaux
236 ;;; {mark,andrew}@vuwcomp
237 ;;; Sun May 10 11:45:04 NZST 1987
239 ;;; Ken Stevens ARPA: k.stevens@ieee.org
240 ;;; Tue Jan 3 16:59:07 PST 1989
241 ;;; This file has overgone a major overhaul to be compatible with ispell
242 ;;; version 2.1. Most of the functions have been totally rewritten, and
243 ;;; many user-accessible variables have been added. The syntax table has
244 ;;; been removed since it didn't work properly anyway, and a filter is
245 ;;; used rather than a buffer. Regular expressions are used based on
246 ;;; ispell's internal definition of characters (see ispell(4)).
247 ;;; Some new updates:
248 ;;; - Updated to version 3.0 to include terse processing.
249 ;;; - Added a variable for the look command.
250 ;;; - Fixed a bug in ispell-word when cursor is far away from the word
251 ;;; that is to be checked.
252 ;;; - Ispell places the incorrect word or guess in the minibuffer now.
253 ;;; - fixed a bug with 'l' option when multiple windows are on the screen.
254 ;;; - lookup-words just didn't work with the process filter. Fixed.
255 ;;; - Rewrote the process filter to make it cleaner and more robust
256 ;;; in the event of a continued line not being completed.
257 ;;; - Made ispell-init-process more robust in handling errors.
258 ;;; - Fixed bug in continuation location after a region has been modified by
259 ;;; correcting a misspelling.
262 ;;; Sebastian Kremer <sk@thp.uni-koeln.de>
263 ;;; Wed Aug 7 14:02:17 MET DST 1991
264 ;;; - Ported ispell-complete-word from Ispell 2 to Ispell 3.
265 ;;; - Added ispell-kill-ispell command.
266 ;;; - Added ispell-dictionary and ispell-dictionary-alist variables to
267 ;;; support other than default language. See their docstrings and
268 ;;; command ispell-change-dictionary.
269 ;;; - (ispelled it :-)
270 ;;; - Added ispell-skip-tib variable to support the tib bibliography
274 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
278 ;;; **********************************************************************
279 ;;; The following variables should be set according to personal preference
280 ;;; and location of binaries:
281 ;;; **********************************************************************
284 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1
287 (defvar ispell-highlight-p t
288 "*Highlight spelling errors when non-nil.")
290 (defvar ispell-highlight-face 'highlight
291 "*The face used for Ispell highlighting. For Emacses with overlays.
292 Possible values are `highlight', `modeline', `secondary-selection',
293 `region', and `underline'.
294 This variable can be set by the user to whatever face they desire.
295 It's most convenient if the cursor color and highlight color are
296 slightly different.")
298 (defvar ispell-check-comments nil
299 "*Spelling of comments checked when non-nil.")
301 (defvar ispell-query-replace-choices nil
302 "*Corrections made throughout region when non-nil.
303 Uses `query-replace' (\\[query-replace]) for corrections.")
305 (defvar ispell-skip-tib nil
306 "*Does not spell check `tib' bibliography references when non-nil.
307 Skips any text between strings matching regular expressions
308 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
310 TeX users beware: Any field starting with [. will skip until a .] -- even
311 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
312 a [.5mm] type of number....")
314 (defvar ispell-tib-ref-beginning "[[<]\\."
315 "Regexp matching the beginning of a Tib reference.")
317 (defvar ispell-tib-ref-end "\\.[]>]"
318 "Regexp matching the end of a Tib reference.")
320 (defvar ispell-keep-choices-win t
321 "*When not nil, the `*Choices*' window remains for spelling session.
322 This minimizes redisplay thrashing.")
324 (defvar ispell-choices-win-default-height 2
325 "*The default size of the `*Choices*' window, including status line.
326 Must be greater than 1.")
328 (defvar ispell-program-name "ispell"
329 "Program invoked by \\[ispell-word] and \\[ispell-region] commands.")
331 (defvar ispell-alternate-dictionary
332 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
333 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
334 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
335 ((file-exists-p "/sys/dict") "/sys/dict")
336 (t "/usr/dict/words"))
337 "*Alternate dictionary for spelling help.")
339 (defvar ispell-complete-word-dict ispell-alternate-dictionary
340 "*Dictionary used for word completion.")
342 (defvar ispell-grep-command "/usr/bin/egrep"
343 "Name of the grep command for search processes.")
345 (defvar ispell-grep-options "-i"
346 "String of options to use when running the program in `ispell-grep-command'.
347 Should probably be \"-i\" or \"-e\".
348 Some machines (like the NeXT) don't support \"-i\"")
350 (defvar ispell-look-command "/usr/bin/look"
351 "Name of the look command for search processes.
352 This must be an absolute file name.")
354 (defvar ispell-look-p (file-exists-p ispell-look-command)
355 "*Non-nil means use `look; rather than `grep'.
356 Default is based on whether `look' seems to be available.")
358 (defvar ispell-have-new-look nil
359 "*Non-nil means use the `-r' option (regexp) when running `look'.")
361 (defvar ispell-look-options (if ispell-have-new-look "-dfr" "-df")
362 "String of command options for `ispell-look-command'.")
364 (defvar ispell-use-ptys-p nil
365 "When non-nil, Emacs uses ptys to communicate with Ispell.
366 When nil, Emacs uses pipes.")
368 (defvar ispell-following-word nil
369 "*Non-nil means `ispell-word' checks the word around or after point.
370 Otherwise `ispell-word' checks the preceding word.")
372 (defvar ispell-help-in-bufferp nil
373 "*Non-nil means display interactive keymap help in a buffer.
374 Otherwise use the minibuffer.")
376 (defvar ispell-quietly nil
377 "*Non-nil means suppress messages in `ispell-word'.")
379 (defvar ispell-format-word (function upcase)
380 "*Formatting function for displaying word being spell checked.
381 The function must take one string argument and return a string.")
383 (defvar ispell-personal-dictionary nil
384 "*File name of your personal spelling dictionary.
385 If nil, default dictionary `~/.ispell_words' is used.")
387 (defvar ispell-silently-savep nil
388 "*When non-nil, save the personal dictionary without confirmation.")
390 ;;; This variable contains the current dictionary being used if the ispell
391 ;;; process is running. Otherwise it contains the global default.
392 (defvar ispell-dictionary nil
393 "If non-nil, a dictionary to use instead of the default one.
394 This is passed to the ispell process using the `-d' switch and is
395 used as key in `ispell-dictionary-alist' (which see).
397 You should set this variable before your first use of Emacs spell-checking
398 commands in the Emacs session, or else use the \\[ispell-change-dictionary] command to
399 change it. Otherwise, this variable only takes effect in a newly
400 started Ispell process.")
402 (defvar ispell-extra-args nil
403 "*If non-nil, a list of extra switches to pass to the Ispell program.
404 For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
405 words as correct. See also `ispell-dictionary-alist', which may be used
406 for language-specific arguments.")
409 (defvar ispell-dictionary-alist-1 ; sk 9-Aug-1991 18:28
410 '((nil ; default (english.aff)
411 "[A-Za-z]" "[^A-Za-z]" "[---']" nil ("-B") nil)
412 ("english" ; make english explicitly selectable
413 "[A-Za-z]" "[^A-Za-z]" "[---']" nil ("-B") nil)
414 ("deutsch" ; deutsch.aff
415 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[---']" t ("-C") nil)
417 "[a-zA-Z\304\326\334\344\366\337\374]"
418 "[^a-zA-Z\304\326\334\344\366\337\374]"
419 "[---']" t ("-C" "-d" "deutsch") "~latin1")
420 ("nederlands8" ; dutch8.aff
421 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
422 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
423 "[---']" t ("-C") nil)))
426 (defvar ispell-dictionary-alist-2
427 '(("svenska" ;7 bit swedish mode
428 "[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
429 "[---']" nil ("-C") nil)
430 ("svenska8" ;8 bit swedish mode
431 "[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
432 "[---']" nil ("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
434 "[A-Za-z]" "[^A-Za-z]" "[`'^-]" t nil nil)
435 ("francais8" "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\346\347\350\351\352\353\356\357\364\371\373\374]"
436 "[^A-Za-z\300\302\304\306\307\310\311\312\313\316\317\324\326\331\333\334\340\342\344\346\347\350\351\352\353\356\357\364\366\371\373\374]" "[---']"
439 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
440 "[---]" nil ("-C") nil)
443 ;; ispell-dictionary-alist is set up from two subvariables above
444 ;; to avoid having very long lines in loaddefs.el.
446 (defvar ispell-dictionary-alist
447 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2)
448 "An alist of dictionaries and their associated parameters.
450 Each element of this list is also a list:
452 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
453 ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
455 DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
456 means the default dictionary.
458 CASECHARS is a regular expression of valid characters that comprise a
461 NOT-CASECHARS is the opposite regexp of CASECHARS.
463 OTHERCHARS is a regular expression of other characters that are valid
464 in word constructs. Otherchars cannot be adjacent to each other in a
465 word, nor can they begin or end a word. This implies we can't check
466 \"Stevens'\" as a correct possessive and other correct formations.
468 Hint: regexp syntax requires the hyphen to be declared first here.
470 MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed in a
471 word instead of only one.
473 ISPELL-ARGS is a list of additional arguments passed to the ispell
476 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
477 have been configured in Ispell's parse.y. (For example, umlauts
478 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
479 in English. This has the same effect as the command-line `-T' option.
480 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
481 but the dictionary can control the extended character mode.
482 Both defaults can be overruled in a buffer-local fashion. See
483 `ispell-parsing-keyword' for details on this.
485 Note that the CASECHARS and OTHERCHARS slots of the alist should
486 contain the same character set as casechars and otherchars in the
487 language.aff file \(e.g., english.aff\).")
490 (defvar ispell-menu-map nil)
494 (defconst ispell-menu-map-needed
495 ;; Verify this is not Lucid Emacs.
496 (and (not ispell-menu-map) (boundp 'system-key-alist)))
499 (if ispell-menu-map-needed
500 (let ((dicts (reverse (cons (cons "default" nil) ispell-dictionary-alist)))
502 ;; Can put in defvar when external defines are removed.
503 (setq ispell-menu-map (make-sparse-keymap "Spell"))
505 (setq name (car (car dicts))
508 (define-key ispell-menu-map (vector (intern name))
509 (cons (concat "Select " (capitalize name))
510 (list 'lambda () '(interactive)
511 (list 'ispell-change-dictionary name))))))))
514 (if ispell-menu-map-needed
516 ;; Define commands in opposite order you want them to appear in menu.
517 (define-key ispell-menu-map [ispell-change-dictionary]
518 '("Change Dictionary" . ispell-change-dictionary))
519 (define-key ispell-menu-map [ispell-kill-ispell]
520 '("Kill Process" . ispell-kill-ispell))
521 (define-key ispell-menu-map [ispell-pdict-save]
522 '("Save Dictionary" . (lambda () (interactive) (ispell-pdict-save t))))
523 (define-key ispell-menu-map [ispell-complete-word]
524 '("Complete Word" . ispell-complete-word))
525 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
526 '("Complete Word Frag" . ispell-complete-word-interior-frag))))
529 (if ispell-menu-map-needed
531 (define-key ispell-menu-map [ispell-continue]
532 '("Continue Check" . ispell-continue))
533 (define-key ispell-menu-map [ispell-region]
534 '("Check Region" . ispell-region))
535 (define-key ispell-menu-map [ispell-word]
536 '("Check Word" . ispell-word))
537 (define-key ispell-menu-map [ispell-buffer]
538 '("Check Buffer" . ispell-buffer))
539 (define-key ispell-menu-map [ispell-message]
540 '("Check Message" . ispell-message))
541 (define-key ispell-menu-map [ispell-help]
542 '("Help" . (lambda () (interactive) (describe-function 'ispell-help))))
543 (put 'ispell-region 'menu-enable 'mark-active)))
546 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))
549 ((and (string-lessp "19" emacs-version)
550 (string-match "Lucid" emacs-version))
551 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
552 (current-menubar (or current-menubar default-menubar))
554 '(["Help" (describe-function 'ispell-help) t]
555 ;;["Help" (popup-menu ispell-help-list) t]
556 ["Check Message" ispell-message t]
557 ["Check Buffer" ispell-buffer t]
558 ["Check Word" ispell-word t]
559 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
560 ["Continue Check" ispell-continue t]
561 ["Complete Word Frag"ispell-complete-word-interior-frag t]
562 ["Complete Word" ispell-complete-word t]
563 ["Kill Process" ispell-kill-ispell t]
565 ["Save Dictionary" (ispell-pdict-save t) t]
566 ["Change Dictionary" ispell-change-dictionary t]))
569 (setq name (car (car dicts))
572 (setq menu (append menu
574 (vector (concat "Select " (capitalize name))
575 (list 'ispell-change-dictionary name)
577 (defvar ispell-menu-lucid menu "Lucid's spelling menu.")
580 (delete-menu-item '("Edit" "Spell")) ; in case already defined
581 (add-menu '("Edit") "Spell" ispell-menu-lucid))))))
584 ;;; **********************************************************************
585 ;;; The following are used by ispell, and should not be changed.
586 ;;; **********************************************************************
589 ;;; This doesn't match the LAST patch number -- this is for 3.1 or 3.0.09
590 (defconst ispell-required-versions '("3.1." "3.0.09")
591 "Ispell versions with which this version of ispell.el is known to work.")
593 (defun ispell-get-casechars ()
594 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist)))
595 (defun ispell-get-not-casechars ()
596 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist)))
597 (defun ispell-get-otherchars ()
598 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist)))
599 (defun ispell-get-many-otherchars-p ()
600 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
601 (defun ispell-get-ispell-args ()
602 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
603 (defun ispell-get-extended-character-mode ()
604 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
606 (defvar ispell-process nil
607 "The process object for Ispell.")
609 (defvar ispell-pdict-modified-p nil
610 "Non-nil means personal dictionary has modifications to be saved.")
612 ;;; If you want to save the dictionary when quitting, must do so explicitly.
613 ;; When non-nil, the spell session is terminated.
614 ;; When numeric, contains cursor location in buffer, and cursor remains there.
615 (defvar ispell-quit nil)
617 (defvar ispell-filter nil
618 "Output filter from piped calls to Ispell.")
620 (defvar ispell-filter-continue nil
621 "Control variable for Ispell filter function.")
623 (defvar ispell-process-directory nil
624 "The directory where `ispell-process' was started.")
626 (defvar ispell-query-replace-marker (make-marker)
627 "Marker for `query-replace' processing.")
629 (defvar ispell-checking-message nil
630 "Non-nil when we're checking a mail message")
632 (defconst ispell-choices-buffer "*Choices*")
634 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
636 ;;; *** Buffer Local Definitions ***
638 ;;; This is the local dictionary to use. When nil the default dictionary will
639 ;;; be used. Do not redefine default value or it will override the global!
640 (defvar ispell-local-dictionary nil
641 "If non-nil, a dictionary to use for Ispell commands in this buffer.
642 The value should be a string, which is a file name.
643 This variable becomes buffer-local when set in any fashion.
645 Setting ispell-local-dictionary to a value has the same effect as
646 calling \\[ispell-change-dictionary] with that value. This variable
647 is automatically set when defined in the file with either
648 `ispell-dictionary-keyword' or the Local Variable syntax.")
650 (make-variable-buffer-local 'ispell-local-dictionary)
652 ;; Use default directory, unless locally set.
653 (set-default 'ispell-local-dictionary nil)
655 (defconst ispell-words-keyword "LocalWords: "
656 "The keyword for local oddly-spelled words to accept.
657 The keyword will be followed by any number of local word spellings.
658 There can be multiple of these keywords in the file.")
660 (defconst ispell-dictionary-keyword "Local IspellDict: "
661 "The keyword for local dictionary definitions.
662 There should be only one dictionary keyword definition per file, and it
663 should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
665 (defconst ispell-parsing-keyword "Local IspellParsing: "
666 "The keyword for overriding default Ispell parsing.
667 Determined by the buffer's major mode and extended-character mode as well as
668 the default dictionary.
670 The above keyword string should be followed by `latex-mode' or
671 `nroff-mode' to put the current buffer into the desired parsing mode.
673 Extended character mode can be changed for this buffer by placing
674 a `~' followed by an extended-character mode -- such as `~.tex'.")
676 (defvar ispell-local-pdict ispell-personal-dictionary
677 "A buffer local variable containing the current personal dictionary.
678 If non-nil, the value must be a string, which is a file name.
680 If you specify a personal dictionary for the current buffer which is
681 different from the current personal dictionary, the effect is similar
682 to calling \\[ispell-change-dictionary]. This variable is automatically
683 set when defined in the file with either `ispell-pdict-keyword' or the
684 local variable syntax.")
686 (make-variable-buffer-local 'ispell-local-pdict)
688 (defconst ispell-pdict-keyword "Local IspellPersDict: "
689 "The keyword for defining buffer local dictionaries.")
691 (defvar ispell-buffer-local-name nil
692 "Contains the buffer name if local word definitions were used.
693 Ispell is then restarted because the local words could conflict.")
695 (defvar ispell-parser 'use-mode-name
696 "*Indicates whether ispell should parse the current buffer as TeX Code.
697 Special value `use-mode-name' tries to guess using the name of major-mode.
698 Default parser is 'nroff.
699 Currently the only other valid parser is 'tex.
701 You can set this variable in hooks in your init file -- eg:
703 \(add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
705 (defvar ispell-region-end (make-marker)
706 "Marker that allows spelling continuations.")
709 ;;; **********************************************************************
710 ;;; **********************************************************************
713 (defalias 'ispell 'ispell-buffer)
715 ;;;###autoload (define-key global-map "\M-$" 'ispell-word)
718 (defun ispell-word (&optional following quietly continue)
719 "Check spelling of word under or before the cursor.
720 If the word is not found in dictionary, display possible corrections
721 in a window and so you can choose one.
723 With a prefix argument (or if CONTINUE is non-nil),
724 resume interrupted spell-checking of a buffer or region.
726 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
727 is non-nil when called interactively, then the following word
728 \(rather than preceding\) is checked when the cursor is not over a word.
729 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
730 when called interactively, non-corrective messages are suppressed.
732 Word syntax described by `ispell-dictionary-alist' (which see).
734 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
735 or \\[ispell-region] to update the Ispell process."
736 (interactive (list nil nil current-prefix-arg))
740 (setq following ispell-following-word
741 quietly ispell-quietly))
742 (ispell-buffer-local-dict) ; use the correct dictionary
743 (let ((cursor-location (point)) ; retain cursor location
744 (word (ispell-get-word following))
745 start end poss replace)
746 ;; destructure return word info list.
747 (setq start (car (cdr word))
748 end (car (cdr (cdr word)))
751 ;; now check spelling of word.
753 (message "Checking spelling of %s..."
754 (funcall ispell-format-word word)))
755 (ispell-init-process) ; erases ispell output buffer
756 (process-send-string ispell-process "%\n") ;put in verbose mode
757 (process-send-string ispell-process (concat "^" word "\n"))
758 ;; wait until ispell has processed word
760 (accept-process-output ispell-process)
761 (not (string= "" (car ispell-filter)))))
762 ;;(process-send-string ispell-process "!\n") ;back to terse mode.
763 (setq ispell-filter (cdr ispell-filter))
764 (if (listp ispell-filter)
765 (setq poss (ispell-parse-output (car ispell-filter))))
768 (message "%s is correct" (funcall ispell-format-word word))))
771 (message "%s is correct because of root %s"
772 (funcall ispell-format-word word)
773 (funcall ispell-format-word poss))))
774 ((null poss) (message "Error in ispell process"))
775 (t ; prompt for correct word.
778 (if ispell-highlight-p ;highlight word
779 (ispell-highlight-spelling-error start end t))
780 (save-window-excursion
781 (setq replace (ispell-command-loop
782 (car (cdr (cdr poss)))
783 (car (cdr (cdr (cdr poss))))
786 (if ispell-highlight-p ; clear highlight
787 (ispell-highlight-spelling-error start end)))
788 (cond ((equal 0 replace)
789 (ispell-add-per-file-word-list (car poss)))
791 (delete-region start end)
792 (setq word (if (atom replace) replace (car replace))
793 cursor-location (+ (- (length word) (- end start))
796 (if (not (atom replace)) ; recheck spelling of replacement
798 (goto-char cursor-location)
799 (ispell-word following quietly)))))
800 (if (get-buffer ispell-choices-buffer)
801 (kill-buffer ispell-choices-buffer))))
802 (goto-char cursor-location) ; return to original location
803 (ispell-pdict-save ispell-silently-savep)
804 (if ispell-quit (setq ispell-quit nil)))))
807 (defun ispell-get-word (following &optional extra-otherchars)
808 "Return the word for spell-checking according to ispell syntax.
809 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
810 is non-nil when called interactively, then the following word
811 \(rather than preceeding\) is checked when the cursor is not over a word.
812 Optional second argument contains otherchars that can be included in word
815 Word syntax described by `ispell-dictionary-alist' (which see)."
816 (let* ((ispell-casechars (ispell-get-casechars))
817 (ispell-not-casechars (ispell-get-not-casechars))
818 (ispell-otherchars (ispell-get-otherchars))
819 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
820 (word-regexp (concat ispell-casechars
825 (concat extra-otherchars "?"))
828 (if (or ispell-many-otherchars-p
834 (if (not (looking-at ispell-casechars))
836 (re-search-forward ispell-casechars (point-max) t)
837 (re-search-backward ispell-casechars (point-min) t)))
838 ;; move to front of word
839 (re-search-backward ispell-not-casechars (point-min) 'start)
840 (while (and (or (looking-at ispell-otherchars)
841 (and extra-otherchars (looking-at extra-otherchars)))
843 (or (not did-it-once)
844 ispell-many-otherchars-p))
845 (if (and extra-otherchars (looking-at extra-otherchars))
848 (if (looking-at ispell-casechars)
849 (re-search-backward ispell-not-casechars (point-min) 'move)))
852 (if (looking-at ispell-casechars)
853 (re-search-backward ispell-not-casechars (point-min) 'move)
854 (backward-char -1))))
855 ;; Now mark the word and save to string.
856 (or (re-search-forward word-regexp (point-max) t)
857 (error "No word found to check!"))
858 (setq start (match-beginning 0)
860 word (buffer-substring start end))
861 (list word start end)))
864 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
865 ;;; tracks changes in the dictionary. The global may either be
866 ;;; a value or a list, whose value is the state of whether the
867 ;;; dictionary needs to be saved.
869 (defun ispell-pdict-save (&optional no-query force-save)
870 "Check to see if the personal dictionary has been modified.
871 If so, ask if it needs to be saved."
872 (interactive (list ispell-silently-savep t))
873 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
874 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
875 (if (or ispell-pdict-modified-p force-save)
876 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
877 (process-send-string ispell-process "#\n")))
878 ;; unassert variable, even if not saved to avoid questioning.
879 (setq ispell-pdict-modified-p nil))
882 (defun ispell-command-loop (miss guess word)
883 "Display possible corrections from list MISS.
884 GUESS lists possibly valid affix construction of WORD.
885 Returns nil to keep word.
886 Returns 0 to insert locally into buffer-local dictionary.
887 Returns string for new chosen word.
888 Returns list for new replacement word (will be rechecked).
889 Global `ispell-pdict-modified-p' becomes a list where the only value
890 indicates whether the dictionary has been modified when option `a' or `i' is
894 (max-lines (- (window-height) 4)) ; assure 4 context lines.
896 (window-min-height (min window-min-height
897 ispell-choices-win-default-height))
898 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
902 (set-buffer (get-buffer-create ispell-choices-buffer))
903 (setq mode-line-format "-- %b --")
907 (insert "Affix rules generate and capitalize "
908 "this word as shown below:\n\t")
910 (if (> (+ 4 (current-column) (length (car guess)))
914 (setq line (1+ line))))
915 (insert (car guess) " ")
916 (setq guess (cdr guess)))
917 (insert "\nUse option `i' if this is a correct composition"
918 " from the derivative root.\n")
919 (setq line (+ line (if choices 3 2)))))
921 (< (if (> (+ 7 (current-column) (length (car choices))
922 (if (> count ?~) 3 0))
926 (setq line (1+ line)))
929 ;; not so good if there are over 20 or 30 options, but then, if
930 ;; there are that many you don't want to scan them all anyway...
931 (while (memq count command-characters) ; skip command characters.
932 (setq count (1+ count)
933 skipped (1+ skipped)))
934 (insert "(" count ") " (car choices) " ")
935 (setq choices (cdr choices)
937 (setq count (- count ?0 skipped)))
939 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
941 (if (not (equal line (window-height choices-window)))
944 (let ((cur-point (point)))
945 (move-to-window-line (- line (window-height choices-window)))
946 (if (<= (point) cur-point)
947 (set-window-start (selected-window) (point)))))
948 (select-window (previous-window))
949 (enlarge-window (- line (window-height choices-window))))
950 (select-window choices-window))
951 (ispell-overlay-window (max line
952 ispell-choices-win-default-height))
953 (switch-to-buffer ispell-choices-buffer)))
954 (goto-char (point-min))
955 (select-window (next-window))
963 (message (concat "C-h or ? for more options; SPC to leave "
964 "unchanged, Character to replace word"))
965 (let ((inhibit-quit t))
966 (setq char (if (fboundp 'read-char-exclusive)
967 (read-char-exclusive)
970 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
973 ;; Adjust num to array offset skipping command characters.
974 (let ((com-chars command-characters))
976 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
977 (setq skipped (1+ skipped)))
978 (setq com-chars (cdr com-chars)))
979 (setq num (- char ?0 skipped)))
982 ((= char ? ) nil) ; accept word this time only
983 ((= char ?i) ; accept and insert word into pers dict
984 (process-send-string ispell-process (concat "*" word "\n"))
985 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
987 ((or (= char ?a) (= char ?A)) ; accept word without insert
988 (process-send-string ispell-process (concat "@" word "\n"))
989 (if (null ispell-pdict-modified-p)
990 (setq ispell-pdict-modified-p
991 (list ispell-pdict-modified-p)))
992 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
993 ((or (= char ?r) (= char ?R)) ; type in replacement
994 (if (or (= char ?R) ispell-query-replace-choices)
995 (list (read-string "Query-replacement for: " word) t)
996 (cons (read-string "Replacement for: " word) nil)))
997 ((or (= char ??) (= char help-char) (= char ?\C-h))
1000 ;; Quit and move point back.
1002 (ispell-pdict-save ispell-silently-savep)
1003 (message "Exited spell-checking")
1004 (setq ispell-quit t)
1006 ;; Quit and preserve point.
1008 (ispell-pdict-save ispell-silently-savep)
1010 (substitute-command-keys
1011 (concat "Spell-checking suspended;"
1012 " use C-u \\[ispell-word] to resume")))
1013 (setq ispell-quit (max (point-min)
1014 (- (point) (length word))))
1017 (if (y-or-n-p "Really kill Ispell process? ")
1019 (ispell-kill-ispell t) ; terminate process.
1020 (setq ispell-quit (or (not ispell-checking-message)
1022 ispell-pdict-modified-p nil))
1023 t)) ; continue if they don't quit.
1025 (let ((new-word (read-string
1026 "Lookup string (`*' is wildcard): "
1032 (set-buffer (get-buffer-create
1033 ispell-choices-buffer))
1037 mode-line-format "-- %b --"
1038 miss (lookup-words new-word)
1040 (while (and choices ; adjust choices window.
1041 (< (if (> (+ 7 (current-column)
1042 (length (car choices))
1043 (if (> count ?~) 3 0))
1051 (while (memq count command-characters)
1052 (setq count (1+ count)
1053 skipped (1+ skipped)))
1054 (insert "(" count ") " (car choices) " ")
1055 (setq choices (cdr choices)
1057 (setq count (- count ?0 skipped)))
1058 (select-window (previous-window))
1059 (if (/= new-line line)
1061 (if (> new-line line)
1062 (enlarge-window (- new-line line))
1063 (shrink-window (- line new-line)))
1064 (setq line new-line)))
1065 (select-window (next-window)))))
1066 t) ; reselect from new choices
1068 (process-send-string ispell-process
1069 (concat "*" (downcase word) "\n"))
1070 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1072 ((= char ?m) ; type in what to insert
1073 (process-send-string
1074 ispell-process (concat "*" (read-string "Insert: " word)
1076 (setq ispell-pdict-modified-p '(t))
1078 ((and (>= num 0) (< num count))
1079 (if ispell-query-replace-choices ; Query replace flag
1080 (list (nth num miss) 'query-replace)
1085 (save-window-excursion (recursive-edit)) t)
1087 (funcall (key-binding "\C-z"))
1095 (defun ispell-help ()
1096 "Display a list of the options available when a misspelling is encountered.
1100 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1101 SPC: Accept word this time.
1102 `i': Accept word and insert into private dictionary.
1103 `a': Accept word for this session.
1104 `A': Accept word and place in `buffer-local dictionary'.
1105 `r': Replace word with typed-in value. Rechecked.
1106 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1107 `?': Show these commands.
1108 `x': Exit spelling buffer. Move cursor to original point.
1109 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1110 the aborted check to be completed later.
1111 `q': Quit spelling session (Kills ispell process).
1112 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1113 `u': Like `i', but the word is lower-cased first.
1114 `m': Like `i', but allows one to include dictionary completion information.
1115 `C-l': redraws screen
1116 `C-r': recursive edit
1117 `C-z': suspend emacs or iconify frame"
1119 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1120 "[i]nsert into private dictionary"))
1121 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1122 "e[x/X]it; [q]uit session"))
1123 (help-3 (concat "[u]ncapitalized insert into dictionary. "
1124 "Type 'C-h d ispell-help' for more help")))
1125 (save-window-excursion
1126 (if ispell-help-in-bufferp
1128 (ispell-overlay-window 4)
1129 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1130 (insert (concat help-1 "\n" help-2 "\n" help-3))
1132 (kill-buffer "*Ispell Help*"))
1133 (select-window (minibuffer-window))
1134 ;;(enlarge-window 2)
1136 (cond ((string-match "Lucid" emacs-version)
1142 (goto-char (point-min)))
1144 (if (string-lessp "19" emacs-version)
1147 (insert (concat help-1 "\n" help-2 "\n" help-3))))
1152 (defun lookup-words (word &optional lookup-dict)
1153 "Look up word in word-list dictionary.
1154 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1155 Otherwise the variable `ispell-grep-command' contains the command used to
1156 search for the words (usually egrep).
1158 Optional second argument contains the dictionary to use; the default is
1159 `ispell-alternate-dictionary'."
1160 ;; We don't use the filter for this function, rather the result is written
1161 ;; into a buffer. Hence there is no need to save the filter values.
1162 (if (null lookup-dict)
1163 (setq lookup-dict ispell-alternate-dictionary))
1165 (let* ((process-connection-type ispell-use-ptys-p)
1166 (wild-p (string-match "\\*" word))
1167 (look-p (and ispell-look-p ; Only use look for an exact match.
1168 (or ispell-have-new-look (not wild-p))))
1169 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1170 (prog (if look-p ispell-look-command ispell-grep-command))
1171 (args (if look-p ispell-look-options ispell-grep-options))
1174 (save-window-excursion
1175 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1176 (set-buffer ispell-grep-buffer)
1180 (insert "^" word "$")
1181 (while (search-backward "*" nil t) (insert "."))
1182 (setq word (buffer-string))
1184 (setq status (call-process prog nil t nil args word lookup-dict))
1185 ;; grep returns status 1 and no output when word not found, which
1186 ;; is a perfectly normal thing.
1187 (if (stringp status)
1188 (setq results (cons (format "error: %s exited with signal %s"
1189 (file-name-nondirectory prog) status)
1191 ;; else collect words into `results' in FIFO order
1192 (goto-char (point-max))
1193 ;; assure we've ended with \n
1194 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1198 (setq results (cons (buffer-substring (point) (1- loc))
1201 (kill-buffer ispell-grep-buffer)
1202 (if (and results (string-match ".+: " (car results)))
1203 (error "%s error: %s" ispell-grep-command (car results))))
1207 ;;; "ispell-filter" is a list of output lines from the generating function.
1208 ;;; Each full line (ending with \n) is a separate item on the list.
1209 ;;; "output" can contain multiple lines, part of a line, or both.
1210 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1212 ;;; "ispell-filter-continue" is true when we have received only part of a
1213 ;;; line as output from a generating function ("output" did not end with \n)
1214 ;;; NOTE THAT THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESNT END WITH \n!
1215 ;;; This is the case when a process dies or fails. The default behavior
1216 ;;; in this case treats the next input received as fresh input.
1218 (defun ispell-filter (process output)
1219 "Output filter function for ispell, grep, and look."
1224 (setq end (string-match "\n" output start)) ; get text up to the newline.
1225 ;; If we get out of sync and ispell-filter-continue is asserted when we
1226 ;; are not continuing, treat the next item as a separate list. When
1227 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1230 ;; Continue with same line (item)?
1231 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1232 ;; Yes. Add it to the prev item
1233 (setcar ispell-filter
1234 (concat (car ispell-filter) (substring output start end)))
1235 ;; No. This is a new line and item.
1237 (cons (substring output start end) ispell-filter)))
1239 ;; We've completed reading the output, but didn't finish the line.
1240 (setq ispell-filter-continue t continue nil)
1241 ;; skip over newline, this line complete.
1242 (setq ispell-filter-continue nil end (1+ end))
1243 (if (= end (length output)) ; No more lines in output
1244 (setq continue nil) ; so we can exit the filter.
1245 (setq start end)))))) ; else move start to next line of input
1248 ;;; This function destroys the mark location if it is in the word being
1250 (defun ispell-highlight-spelling-error-generic (start end &optional highlight)
1251 "Highlight the word from START to END with a kludge using `inverse-video'.
1252 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1253 otherwise it is displayed normally."
1254 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1255 (buffer-read-only nil) ; Allow highlighting read-only buffers.
1256 (text (buffer-substring start end)) ; Save highlight region
1257 (inhibit-quit t) ; inhibit interrupt processing here.
1258 (buffer-undo-list nil)) ; don't clutter the undo list.
1259 (delete-region start end)
1260 (insert-char ? (- end start)) ; mimimize amount of redisplay
1261 (sit-for 0) ; update display
1262 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1263 (delete-region start end) ; delete whitespace
1264 (insert text) ; insert text in inverse video.
1265 (sit-for 0) ; update display showing inverse video.
1266 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1267 (set-buffer-modified-p modified))) ; don't modify if flag not set.
1270 (defun ispell-highlight-spelling-error-lucid (start end &optional highlight)
1271 "Highlight the word from START to END using `isearch-highlight'.
1272 When the optional third arg HIGHLIGHT is set, the word is highlighted
1273 otherwise it is displayed normally."
1275 (isearch-highlight start end)
1276 (isearch-dehighlight t))
1281 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
1282 "Highlight the word from START to END using overlays.
1283 When the optional third arg HIGHLIGHT is set, the word is highlighted
1284 otherwise it is displayed normally.
1286 The variable `ispell-highlight-face' selects the face to use for highlighting."
1289 (setq ispell-overlay (make-overlay start end))
1290 (overlay-put ispell-overlay 'face ispell-highlight-face))
1291 (delete-overlay ispell-overlay)))
1294 ;;; Choose a highlight function at load time.
1295 (fset 'ispell-highlight-spelling-error
1298 ((string-match "Lucid" emacs-version)
1299 'ispell-highlight-spelling-error-lucid)
1300 ((and (string-lessp "19" emacs-version) (featurep 'faces))
1301 'ispell-highlight-spelling-error-overlay)
1302 (t 'ispell-highlight-spelling-error-generic))))
1305 (defun ispell-overlay-window (height)
1306 "Create a window covering the top HEIGHT lines of the current window.
1307 Ensure that the line above point is still visible but otherwise avoid
1308 scrolling the current window. Leave the new window selected."
1310 (let ((oldot (save-excursion (forward-line -1) (point)))
1311 (top (save-excursion (move-to-window-line height) (point))))
1312 ;; If line above old point (line starting at olddot) would be
1313 ;; hidden by new window, scroll it to just below new win
1314 ;; otherwise set top line of other win so it doesn't scroll.
1315 (if (< oldot top) (setq top oldot))
1316 ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
1317 ;; line) is demanded, the last line is not visible.
1318 ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
1319 ;; So we increment the height for this case.
1320 (if (string-match "19\.9.*Lucid" (emacs-version))
1321 (setq height (1+ height)))
1322 (split-window nil height)
1323 (set-window-start (next-window) top))))
1326 ;;; Should we add a compound word match return value?
1327 (defun ispell-parse-output (output)
1328 "Parse the OUTPUT string from Ispell and return:
1329 1: t for an exact match.
1330 2: A string containing the root word for a match via suffix removal.
1331 3: A list of possible correct spellings of the format:
1332 '(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
1333 ORIGINAL-WORD is a string of the possibly misspelled word.
1334 OFFSET is an integer giving the line offset of the word.
1335 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses."
1337 ((string= output "") t) ; for startup with pipes...
1338 ((string= output "*") t) ; exact match
1339 ((string= output "-") t) ; compound word match
1340 ((string= (substring output 0 1) "+") ; found cuz of root word
1341 (substring output 2)) ; return root word
1342 (t ; need to process &, ?, and #'s
1343 (let ((type (substring output 0 1)) ; &, ?, or #
1344 (original-word (substring output 2 (string-match " " output 2)))
1345 (cur-count 0) ; contains number of misses + guesses
1346 count miss-list guess-list offset)
1347 (setq output (substring output (match-end 0))) ; skip over misspelling
1348 (if (string= type "#")
1349 (setq count 0) ; no misses for type #
1350 (setq count (string-to-int output) ; get number of misses.
1351 output (substring output (1+ (string-match " " output 1)))))
1352 (setq offset (string-to-int output))
1353 (if (string= type "#") ; No miss or guess list.
1355 (setq output (substring output (1+ (string-match " " output 1)))))
1357 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
1358 (setq cur-count (1+ cur-count))
1359 (if (> cur-count count)
1360 (setq guess-list (cons (substring output 0 end) guess-list))
1361 (setq miss-list (cons (substring output 0 end) miss-list)))
1362 (if (match-end 1) ; True only when at end of line.
1363 (setq output nil) ; no more misses or guesses
1364 (setq output (substring output (+ end 2))))))
1365 (list original-word offset miss-list guess-list)))))
1368 (defun check-ispell-version ()
1369 ;; This is a little wasteful as we actually launch ispell twice: once
1370 ;; to make sure it's the right version, and once for real. But people
1371 ;; get confused by version mismatches *all* the time (and I've got the
1372 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
1373 ;; option is the only way I can think of to do this that works with
1374 ;; all versions, since versions earlier than 3.0.09 didn't identify
1375 ;; themselves on startup.
1378 (set-buffer (get-buffer-create " *ispell-tmp*"))
1380 (let ((status (call-process ispell-program-name nil t nil "-v"))
1381 (case-fold-search t))
1382 (goto-char (point-min))
1383 (cond ((not (memq status '(0 nil)))
1384 (error "%s exited with %s %s" ispell-program-name
1385 (if (stringp status) "signal" "code") status))
1386 ((not (re-search-forward
1388 (mapconcat 'regexp-quote
1389 ispell-required-versions
1393 (error "version mismatch: ispell.el is for %s, %s is %s"
1394 (car ispell-required-versions)
1396 (if (re-search-forward "version \\([0-9][0-9.]+\\)\\b"
1398 (buffer-substring (match-beginning 1) (match-end 1))
1399 "an unknown version"))))
1400 (kill-buffer (current-buffer)))))
1403 (defun ispell-init-process ()
1404 "Check status of Ispell process and start if necessary."
1405 (if (and ispell-process
1406 (eq (process-status ispell-process) 'run)
1407 ;; If we're using a personal dictionary, assure
1408 ;; we're in the same default directory!
1409 (or (not ispell-personal-dictionary)
1410 (equal ispell-process-directory default-directory)))
1411 (setq ispell-filter nil ispell-filter-continue nil)
1412 ;; may need to restart to select new personal dictionary.
1413 (ispell-kill-ispell t)
1414 (message "Starting new Ispell process...")
1416 (check-ispell-version)
1417 (setq ispell-process
1418 (let ((process-connection-type ispell-use-ptys-p))
1419 (apply 'start-process
1420 "ispell" nil ispell-program-name
1421 "-a" ; accept single input lines
1422 "-m" ; make root/affix combos not in dict
1424 ;; Local dictionary becomes the global dictionary in use.
1425 (if ispell-local-dictionary
1426 (setq ispell-dictionary ispell-local-dictionary))
1427 (setq args (ispell-get-ispell-args))
1428 (if ispell-dictionary ; use specified dictionary
1430 (append (list "-d" ispell-dictionary) args)))
1431 (if ispell-personal-dictionary ; use specified pers dict
1436 ispell-personal-dictionary)))))
1437 (setq args (append args ispell-extra-args))
1440 ispell-filter-continue nil
1441 ispell-process-directory default-directory)
1442 (set-process-filter ispell-process 'ispell-filter)
1443 (accept-process-output ispell-process) ; Get version ID line
1444 (cond ((null ispell-filter)
1445 (error "%s did not output version line"))
1446 ((and (null (cdr ispell-filter))
1447 (stringp (car ispell-filter))
1448 (string-match "^@(#) " (car ispell-filter)))
1449 ;; got the version line as expected (we already know it's the right
1450 ;; version, so don't bother checking again.)
1453 ;; Otherwise, it must be an error message. Show the user.
1454 ;; But first wait to see if some more output is going to arrive.
1455 ;; Otherwise we get cool errors like "Can't open ".
1457 (accept-process-output)
1458 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
1459 (setq ispell-filter nil) ; Discard version ID line
1460 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1461 (if extended-char-mode
1462 (process-send-string ispell-process
1463 (concat extended-char-mode "\n"))))
1464 (process-kill-without-query ispell-process)))
1467 (defun ispell-kill-ispell (&optional no-error)
1468 "Kill current Ispell process (so that you may start a fresh one).
1469 With NO-ERROR, just return non-nil if there was no Ispell running."
1471 (if (not (and ispell-process
1472 (eq (process-status ispell-process) 'run)))
1474 (error "There is no ispell process running!"))
1475 (kill-process ispell-process)
1476 (setq ispell-process nil)
1477 (message "Ispell process killed")
1482 (defun ispell-change-dictionary (dict &optional arg)
1483 "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
1484 A new one will be started as soon as necessary.
1486 By just answering RET you can find out what the current dictionary is.
1488 With prefix argument, set the default directory."
1490 (list (completing-read
1491 "Use new dictionary (RET for current, SPC to complete): "
1492 (cons (cons "default" nil) ispell-dictionary-alist) nil t)
1493 current-prefix-arg))
1494 (if (equal dict "default") (setq dict nil))
1495 ;; This relies on completing-read's bug of returning "" for no match
1496 (cond ((equal dict "")
1497 (message "Using %s dictionary"
1498 (or ispell-local-dictionary ispell-dictionary "default")))
1499 ((and (equal dict ispell-dictionary)
1500 (equal dict ispell-local-dictionary))
1501 ;; Specified dictionary is the default already. No-op
1502 (message "No change, using %s dictionary" (or dict "default")))
1503 (t ; reset dictionary!
1504 (if (assoc dict ispell-dictionary-alist)
1506 (if (or arg (null dict)) ; set default dictionary
1507 (setq ispell-dictionary dict))
1508 (if (null arg) ; set local dictionary
1509 (setq ispell-local-dictionary dict)))
1510 (error "Illegal dictionary: %s" dict))
1511 (ispell-kill-ispell t)
1512 (message "(Next %sIspell command will use %s dictionary)"
1513 (cond ((equal ispell-local-dictionary ispell-dictionary)
1517 (or (if (or (equal ispell-local-dictionary ispell-dictionary)
1519 ispell-local-dictionary
1524 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
1527 (defun ispell-region (reg-start reg-end)
1528 "Interactively check a region for spelling errors."
1529 (interactive "r") ; Don't flag errors on read-only bufs.
1530 (ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
1533 (message "Spell checking %s..."
1534 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
1535 (buffer-name) "region"))
1536 ;Eliminated to keep ispell-message displaying each piece: (sit-for 0)
1537 ;; must be top level, not in ispell-command-loop for keeping window.
1538 (save-window-excursion
1539 (goto-char reg-start)
1540 (let ((transient-mark-mode nil))
1541 (while (and (not ispell-quit) (< (point) reg-end))
1542 (let ((start (point))
1544 (end (save-excursion (end-of-line) (min (point) reg-end)))
1545 (ispell-casechars (ispell-get-casechars))
1547 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
1548 ((eolp) ; END OF LINE, just go to next line.
1550 ((and (null ispell-check-comments) ; SKIPING COMMENTS
1551 comment-start ; skip comments that start on the line.
1552 (search-forward comment-start end t)) ; or found here.
1553 (if (= (- (point) start) (length comment-start))
1554 ;; comment starts the line. Skip entire line or region
1555 (if (string= "" comment-end) ; skip to next line
1556 (beginning-of-line 2) ; or jump to comment end.
1557 (search-forward comment-end reg-end 'limit))
1558 ;; Comment later in line. Check spelling before comment.
1559 (let ((limit (- (point) (length comment-start))))
1560 (goto-char (1- limit))
1561 (if (looking-at "\\\\") ; "quoted" comment, don't skip
1562 ;; quoted comment. Skip over comment-start
1563 (if (= start (1- limit))
1564 (setq limit (+ limit (length comment-start)))
1565 (setq limit (1- limit))))
1567 ;; Only check when "casechars" or math before comment
1568 (if (or (re-search-forward ispell-casechars limit t)
1569 (re-search-forward "[][()$]" limit t))
1571 (concat "^" (buffer-substring start limit)
1573 (goto-char limit))))
1574 ((and ispell-skip-tib ; SKIP TIB REFERENCES!
1575 (re-search-forward ispell-tib-ref-beginning end t))
1576 (if (= (- (point) 2) start) ; tib ref is 2 chars.
1577 ;; Skip to end of tib ref, not necessarily on this line.
1578 ;; Return an error if tib ref not found
1579 (if (not(re-search-forward ispell-tib-ref-end reg-end t))
1581 (ispell-pdict-save ispell-silently-savep)
1585 "Open tib reference--set `ispell-skip-tib'"
1586 " to nil to avoid this error"))
1587 ;; keep cursor at error location
1588 (setq ispell-quit (- (point) 2))))
1589 ;; tib ref starts later on line. Check spelling before tib.
1590 (let ((limit (- (point) 2)))
1592 (if (or (re-search-forward ispell-casechars limit t)
1593 (re-search-forward "[][()$]" limit t))
1595 (concat "^" (buffer-substring start limit)
1597 (goto-char limit))))
1598 ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
1600 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
1601 (re-search-forward "[][()$]" end t)) ; or MATH COMMANDS
1602 (setq string (concat "^" (buffer-substring start end) "\n"))
1604 (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
1606 (setq end (point)) ; "end" tracks end of region to check.
1608 (if string ; there is something to spell!
1610 ;; send string to spell process and get input.
1611 (process-send-string ispell-process string)
1613 (accept-process-output ispell-process)
1614 ;; Last item of output contains a blank line.
1615 (not (string= "" (car ispell-filter)))))
1616 ;; parse all inputs from the stream one word at a time.
1617 ;; Place in FIFO order and remove the blank item.
1618 (setq ispell-filter (nreverse (cdr ispell-filter)))
1619 (while (and (not ispell-quit) ispell-filter)
1620 (setq poss (ispell-parse-output (car ispell-filter)))
1621 (if (listp poss) ; spelling error occurred.
1622 (let* ((word-start (+ start offset-change
1624 (word-end (+ word-start
1625 (length (car poss))))
1627 (goto-char word-start)
1628 ;; Adjust the horizontal scroll & point
1629 (ispell-horiz-scroll)
1630 (goto-char word-end)
1631 (ispell-horiz-scroll)
1632 (goto-char word-start)
1633 (ispell-horiz-scroll)
1636 (search-forward (car poss) word-end t)
1638 ;; This occurs due to filter pipe problems
1640 (concat "Ispell misalignment: word "
1641 "`%s' point %d; please retry")
1642 (car poss) word-start))
1645 (if ispell-highlight-p
1646 (ispell-highlight-spelling-error
1647 word-start word-end t))
1648 (sit-for 0) ; update screen display
1649 (if ispell-keep-choices-win
1651 (ispell-command-loop
1652 (car (cdr (cdr poss)))
1653 (car (cdr (cdr (cdr poss))))
1655 (save-window-excursion
1657 (ispell-command-loop
1658 (car (cdr (cdr poss)))
1659 (car (cdr (cdr (cdr poss))))
1662 (if ispell-highlight-p
1663 (ispell-highlight-spelling-error
1664 word-start word-end)))
1666 ((and replace (listp replace))
1667 ;; REPLACEMENT WORD entered. Recheck line
1668 ;; starting with the replacement word.
1669 (setq ispell-filter nil
1670 string (buffer-substring word-start
1672 (let ((change (- (length (car replace))
1673 (length (car poss)))))
1675 (setq reg-end (+ reg-end change)
1676 offset-change (+ offset-change
1678 (delete-region word-start word-end)
1679 (insert (car replace))
1680 ;; I only need to recheck typed-in replacements
1681 (if (not (eq 'query-replace
1682 (car (cdr replace))))
1683 (backward-char (length (car replace))))
1684 (setq end (point)) ; reposition for recheck
1685 ;; when second arg exists, query-replace, saving regions
1686 (if (car (cdr replace))
1688 (save-window-excursion
1690 ispell-query-replace-marker reg-end)
1691 ;; Assume case-replace &
1692 ;; case-fold-search correct?
1693 (query-replace string (car replace)
1697 ispell-query-replace-marker))
1698 (set-marker ispell-query-replace-marker
1701 (equal 0 replace)) ; ACCEPT/INSERT
1702 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
1704 (ispell-add-per-file-word-list
1705 (car poss) reg-end)))
1706 ;; This avoids pointing out the word that was
1707 ;; just accepted (via 'i' or 'a') if it follows
1708 ;; on the same line.
1709 ;; Redo check following the accepted word.
1710 (if (and ispell-pdict-modified-p
1711 (listp ispell-pdict-modified-p))
1712 ;; Word accepted. Recheck line.
1713 (setq ispell-pdict-modified-p ; update flag
1714 (car ispell-pdict-modified-p)
1715 ispell-filter nil ; discontinue check
1716 end word-start))) ; reposition loc.
1717 (replace ; STRING REPLACEMENT for this word.
1718 (delete-region word-start word-end)
1720 (let ((change (- (length replace)
1721 (length (car poss)))))
1722 (setq reg-end (+ reg-end change)
1723 offset-change (+ offset-change change)
1724 end (+ end change)))))
1725 (if (not ispell-quit)
1726 (message "Continuing spelling check..."))
1728 ;; finished with line!
1729 (setq ispell-filter (cdr ispell-filter)))))
1733 (if (get-buffer ispell-choices-buffer)
1734 (kill-buffer ispell-choices-buffer))
1737 ;; preserve or clear the region for ispell-continue.
1738 (if (not (numberp ispell-quit))
1739 (set-marker ispell-region-end nil)
1740 ;; Enable ispell-continue.
1741 (set-marker ispell-region-end reg-end)
1742 (goto-char ispell-quit))
1743 ;; Check for aborting
1744 (if (and ispell-checking-message (numberp ispell-quit))
1746 (setq ispell-quit nil)
1747 (error "Message send aborted.")))
1748 (setq ispell-quit nil))
1749 (set-marker ispell-region-end nil)
1750 ;; Only save if successful exit.
1751 (ispell-pdict-save ispell-silently-savep)
1752 (message "Spell-checking done"))))
1757 (defun ispell-buffer ()
1758 "Check the current buffer for spelling errors interactively."
1760 (ispell-region (point-min) (point-max)))
1764 (defun ispell-continue ()
1766 "Continue a spelling session after making some changes."
1767 (if (not (marker-position ispell-region-end))
1768 (message "No session to continue. Use 'X' command when checking!")
1769 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
1770 (message "Must continue ispell from buffer %s"
1771 (buffer-name (marker-buffer ispell-region-end)))
1772 (ispell-region (point) (marker-position ispell-region-end)))))
1775 ;;; Horizontal scrolling
1776 (defun ispell-horiz-scroll ()
1777 "Places point within the horizontal visibility of its window area."
1778 (if truncate-lines ; display truncating lines?
1779 ;; See if display needs to be scrolled.
1780 (let ((column (- (current-column) (max (window-hscroll) 1))))
1781 (if (and (< column 0) (> (window-hscroll) 0))
1782 (scroll-right (max (- column) 10))
1783 (if (>= column (- (window-width) 2))
1784 (scroll-left (max (- column (window-width) -3) 10)))))))
1787 ;;; Interactive word completion.
1788 ;;; Forces "previous-word" processing. Do we want to make this selectable?
1791 (defun ispell-complete-word (&optional interior-frag)
1792 "Look up word before or under point in dictionary (see lookup-words command)
1793 and try to complete it. If optional INTERIOR-FRAG is non-nil then the word
1794 may be a character sequence inside of a word.
1796 Standard ispell choices are then available."
1798 (let ((cursor-location (point))
1800 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
1801 start end possibilities replacement)
1802 (setq start (car (cdr word))
1803 end (car (cdr (cdr word)))
1806 (or (string= word "") ; Will give you every word
1807 (lookup-words (concat (if interior-frag "*") word "*")
1808 ispell-complete-word-dict)))
1809 (cond ((eq possibilities t)
1810 (message "No word to complete"))
1811 ((null possibilities)
1812 (message "No match for \"%s\"" word))
1813 (t ; There is a modification...
1814 (cond ; Try and respect case of word.
1815 ((string-match "^[^A-Z]+$" word)
1816 (setq possibilities (mapcar 'downcase possibilities)))
1817 ((string-match "^[^a-z]+$" word)
1818 (setq possibilities (mapcar 'upcase possibilities)))
1819 ((string-match "^[A-Z]" word)
1820 (setq possibilities (mapcar 'capitalize possibilities))))
1823 (if ispell-highlight-p ; highlight word
1824 (ispell-highlight-spelling-error start end t))
1825 (save-window-excursion
1827 (ispell-command-loop possibilities nil word))))
1829 (if ispell-highlight-p
1830 (ispell-highlight-spelling-error start end))) ; un-highlight
1832 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
1833 (ispell-add-per-file-word-list word))
1834 (replacement ; REPLACEMENT WORD
1835 (delete-region start end)
1836 (setq word (if (atom replacement) replacement (car replacement))
1837 cursor-location (+ (- (length word) (- end start))
1840 (if (not (atom replacement)) ; recheck spelling of replacement.
1842 (goto-char cursor-location)
1843 (ispell-word nil t)))))
1844 (if (get-buffer ispell-choices-buffer)
1845 (kill-buffer ispell-choices-buffer))))
1846 (ispell-pdict-save ispell-silently-savep)
1847 (goto-char cursor-location)))
1851 (defun ispell-complete-word-interior-frag ()
1852 "Completes word matching character sequence inside a word."
1854 (ispell-complete-word t))
1857 ;;; **********************************************************************
1859 ;;; **********************************************************************
1860 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
1863 (defvar ispell-message-text-end
1864 (mapconcat (function identity)
1866 ;; Matches postscript files.
1868 ;; Matches uuencoded text
1869 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
1870 ;; Matches shell files (esp. auto-decoding)
1872 ;; Matches context difference listing
1873 "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
1874 ;; Matches "----------------- cut here"
1875 "^[-=_]+\\s ?cut here")
1877 "*End of text which will be checked in ispell-message.
1878 If it is a string, limit at first occurence of that regular expression.
1879 Otherwise, it must be a function which is called to get the limit.")
1883 (defun ispell-message ()
1884 "Check the spelling of a mail message or news post.
1885 Don't check spelling of message headers except the Subject field.
1886 Don't check included messages.
1888 To abort spell checking of a message REGION and send the message anyway,
1889 use the `x' or `q' command. (Any subsequent regions will be checked.)
1890 The `X' command aborts the message send so that you can edit the buffer.
1892 To spell-check whenever a message is sent, include the appropriate lines
1893 in your .emacs file:
1894 (add-hook 'news-inews-hook 'ispell-message)
1895 (add-hook 'mail-send-hook 'ispell-message)
1896 (add-hook 'mh-before-send-letter-hook 'ispell-message)
1898 you can bind this to the key C-c i in GNUS or mail by adding to
1899 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
1900 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
1903 (goto-char (point-min))
1904 (let* ((internal-messagep (save-excursion
1907 (regexp-quote mail-header-separator)
1912 ((not ispell-message-text-end) (point-max))
1913 ((char-or-string-p ispell-message-text-end)
1914 (if (re-search-forward ispell-message-text-end nil t)
1917 (t (min (point-max) (funcall ispell-message-text-end))))))
1918 (cite-regexp ;Prefix of inserted text
1920 ((featurep 'supercite) ; sc 3.0
1921 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
1922 (ispell-non-empty-string sc-reference-tag-string)))
1923 ((featurep 'sc) ; sc 2.3
1924 (concat "\\(" sc-cite-regexp "\\)" "\\|"
1925 (ispell-non-empty-string sc-reference-tag-string)))
1926 ((equal major-mode 'news-reply-mode) ;GNUS
1927 (concat "In article <" "\\|"
1928 (if mail-yank-prefix
1929 (ispell-non-empty-string mail-yank-prefix)
1931 ((equal major-mode 'mh-letter-mode) ; mh mail message
1932 (ispell-non-empty-string mh-ins-buf-prefix))
1933 ((not internal-messagep) ; Assume n sent us this message.
1934 (concat "In [a-zA-Z.]+ you write:" "\\|"
1935 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
1937 ((boundp 'vm-included-text-prefix) ; VM mail message
1938 (concat "[^,;&+=]+ writes:" "\\|"
1939 (ispell-non-empty-string vm-included-text-prefix)))
1940 (mail-yank-prefix ; vanilla mail message.
1941 (ispell-non-empty-string mail-yank-prefix))
1943 (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp))
1944 (cite-regexp-end (concat "^\\(" cite-regexp "\\)"))
1945 (old-case-fold-search case-fold-search)
1946 (case-fold-search t)
1947 (ispell-checking-message t))
1948 (goto-char (point-min))
1949 ;; Skip header fields except Subject: without Re:'s
1950 ;;(search-forward mail-header-separator nil t)
1951 (while (if internal-messagep
1952 (< (point) internal-messagep)
1953 (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
1955 (if (looking-at "Subject: *") ; Spell check new subject fields
1957 (goto-char (match-end 0))
1958 (if (and (not (looking-at ".*Re\\>"))
1959 (not (looking-at "\\[")))
1960 (let ((case-fold-search old-case-fold-search))
1961 (ispell-region (point)
1964 (while (looking-at "\n[ \t]")
1968 (setq case-fold-search nil)
1969 ;; Skip mail header, particularly for non-english languages.
1970 (if (looking-at mail-header-separator)
1972 (while (< (point) limit)
1973 ;; Skip across text cited from other messages.
1974 (while (and (looking-at cite-regexp-start)
1976 (let ((point1 (point)))
1978 ;; If there's no next line, go to the end of this one
1979 ;; so that the loop stops looping.
1980 (if (eq point1 (point))
1982 (if (< (point) limit)
1983 ;; Check the next batch of lines that *aren't* cited.
1984 (let ((end (save-excursion
1985 (if (re-search-forward cite-regexp-end limit 'end)
1987 (marker-position limit)))))
1988 (ispell-region (point) end)
1990 (set-marker limit nil))))
1993 (defun ispell-non-empty-string (string)
1994 (if (or (not string) (string-equal string ""))
1995 "\\'\\`" ; An unmatchable string if string is null.
1996 (regexp-quote string)))
1999 ;;; **********************************************************************
2000 ;;; Buffer Local Functions
2001 ;;; **********************************************************************
2004 (defun ispell-accept-buffer-local-defs ()
2005 "Load all buffer-local information, restarting ispell when necessary."
2006 (ispell-buffer-local-dict) ; May kill ispell-process.
2007 (ispell-buffer-local-words) ; Will initialize ispell-process.
2008 (ispell-buffer-local-parsing))
2011 (defun ispell-buffer-local-parsing ()
2012 "Place Ispell into parsing mode for this buffer.
2013 Overrides the default parsing mode.
2014 Includes latex/nroff modes and extended character mode."
2015 ;; (ispell-init-process) must already be called.
2016 (process-send-string ispell-process "!\n") ; Put process in terse mode.
2017 ;; We assume all major modes with "tex-mode" in them should use latex parsing
2018 (if (or (and (eq ispell-parser 'use-mode-name)
2019 (string-match "[Tt][Ee][Xx]-mode" (symbol-name major-mode)))
2020 (eq ispell-parser 'tex))
2021 (process-send-string ispell-process "+\n") ; set ispell mode to tex
2022 (process-send-string ispell-process "-\n")) ; set mode to normal (nroff)
2023 ;; Set default extended character mode for given buffer, if any.
2024 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2025 (if extended-char-mode
2026 (process-send-string ispell-process (concat extended-char-mode "\n"))))
2027 ;; Set buffer-local parsing mode and extended charater mode, if specified.
2029 (goto-char (point-min))
2030 ;; Uses last valid definition
2031 (while (search-forward ispell-parsing-keyword nil t)
2032 (let ((end (save-excursion (end-of-line) (point)))
2033 (case-fold-search t)
2035 (while (re-search-forward " *\\([^ \"]+\\)" end t)
2036 ;; space separated definitions.
2037 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2038 (cond ((string-match "latex-mode" string)
2039 (process-send-string ispell-process "+\n"))
2040 ((string-match "nroff-mode" string)
2041 (process-send-string ispell-process "-\n"))
2042 ((string-match "~" string) ; Set extended character mode.
2043 (process-send-string ispell-process (concat string "\n")))
2044 (t (message "Illegal Ispell Parsing argument!")
2048 ;;; Can kill the current ispell process
2050 (defun ispell-buffer-local-dict ()
2051 "Initializes local dictionary.
2052 When a dictionary is defined in the buffer (see variable
2053 `ispell-dictionary-keyword'), it will override the local setting
2054 from \\[ispell-change-dictionary].
2055 Both should not be used to define a buffer-local dictionary."
2057 (goto-char (point-min))
2059 ;; Override the local variable definition.
2060 ;; Uses last valid definition.
2061 (while (search-forward ispell-dictionary-keyword nil t)
2062 (setq end (save-excursion (end-of-line) (point)))
2063 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2064 (setq ispell-local-dictionary
2065 (buffer-substring (match-beginning 1) (match-end 1)))))
2066 (goto-char (point-min))
2067 (while (search-forward ispell-pdict-keyword nil t)
2068 (setq end (save-excursion (end-of-line) (point)))
2069 (if (re-search-forward " *\\([^ \"]+\\)" end t)
2070 (setq ispell-local-pdict
2071 (buffer-substring (match-beginning 1) (match-end 1)))))))
2072 ;; Reload if new personal dictionary defined.
2073 (if (and ispell-local-pdict
2074 (not (equal ispell-local-pdict ispell-personal-dictionary)))
2076 (ispell-kill-ispell t)
2077 (setq ispell-personal-dictionary ispell-local-pdict)))
2078 ;; Reload if new dictionary defined.
2079 (if (and ispell-local-dictionary
2080 (not (equal ispell-local-dictionary ispell-dictionary)))
2081 (ispell-change-dictionary ispell-local-dictionary)))
2084 (defun ispell-buffer-local-words ()
2085 "Loads the buffer-local dictionary in the current buffer."
2086 (if (and ispell-buffer-local-name
2087 (not (equal ispell-buffer-local-name (buffer-name))))
2089 (ispell-kill-ispell t)
2090 (setq ispell-buffer-local-name nil)))
2091 (ispell-init-process)
2093 (goto-char (point-min))
2094 (while (search-forward ispell-words-keyword nil t)
2095 (or ispell-buffer-local-name
2096 (setq ispell-buffer-local-name (buffer-name)))
2097 (let ((end (save-excursion (end-of-line) (point)))
2099 ;; This used to treat " specially, but that loses for some
2100 ;; people using them to fake accented letters.
2101 (while (re-search-forward " *\\([^ ]+\\)" end t)
2102 (setq string (buffer-substring (match-beginning 1) (match-end 1)))
2103 (process-send-string ispell-process (concat "@" string "\n")))))))
2106 ;;; returns optionally adjusted region-end-point.
2108 (defun ispell-add-per-file-word-list (word &optional reg-end)
2109 "Adds new word to the per-file word list."
2110 (or ispell-buffer-local-name
2111 (setq ispell-buffer-local-name (buffer-name)))
2115 (goto-char (point-min))
2116 (let (case-fold-search line-okay search done string)
2118 (setq search (search-forward ispell-words-keyword nil 'move)
2119 line-okay (< (+ (length word) 1 ; 1 for space after word..
2120 (progn (end-of-line) (current-column)))
2122 (if (or (and search line-okay)
2129 (setq string (concat comment-start " "
2130 ispell-words-keyword))
2131 ;; in case the keyword is in the middle of the file....
2132 (if (> reg-end (point))
2133 (setq reg-end (+ reg-end (length string))))
2135 (if (and comment-end (not (equal "" comment-end)))
2139 (insert comment-end)))))
2140 (if (> reg-end (point))
2141 (setq reg-end (+ 1 reg-end (length word))))
2142 (insert (concat " " word)))))))
2146 (defconst ispell-version "2.30 -- Fri May 20 15:58:52 MDT 1994")
2151 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
2153 ;;; Local Variable options:
2154 ;;; mode: name(-mode)
2155 ;;; eval: expression
2156 ;;; local-variable: value
2158 ;;; The following sets the buffer local dictionary to english!
2160 ;;; Local Variables:
2161 ;;; mode: emacs-lisp
2162 ;;; comment-column: 40
2163 ;;; ispell-local-dictionary: "english"
2167 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
2169 ;;; The following places this file in nroff parsing and extended char modes.
2170 ;;; Local IspellParsing: nroff-mode ~nroff
2171 ;;; Change IspellDict to IspellDict: to enable the following line.
2172 ;;; Local IspellDict english
2173 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
2174 ;;; Local IspellPersDict ~/.ispell_lisp
2175 ;;; The following were automatically generated by ispell using the 'A' command:
2176 ; LocalWords: ispell ispell-highlight-p ispell-check-comments query-replace
2177 ; LocalWords: ispell-query-replace-choices ispell-skip-tib non-nil tib
2178 ; LocalWords: regexps ispell-tib-ref-beginning ispell-tib-ref-end
2180 ;; ispell.el ends here