1 ;;;;;;;;;;;;;;;;;;;;;;;;;;; -*- Mode: emacs-lisp -*- ;;;;;;;;;;;;;;;;;;;;;;;;;;
2 ;;; GNU EMACS interface for International Ispell Version 3.1 by Geoff Kuenning.
5 ;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
8 ;;; Authors : Ken Stevens <k.stevens@ieee.org>
9 ;;; Last Modified On: Mon Feb 6 17:39:38 EST 1995
10 ;;; Update Revision : 2.36
11 ;;; Syntax : emacs-lisp
12 ;;; Status : Release with 3.1.12+ ispell.
13 ;;; Version : International Ispell Version 3.1 by Geoff Kuenning.
14 ;;; Bug Reports : ispell-el-bugs@itcorp.com
16 ;;; This file is part of GNU Emacs.
18 ;;; GNU Emacs is free software; you can redistribute it and/or modify
19 ;;; it under the terms of the GNU General Public License as published by
20 ;;; the Free Software Foundation; either version 2, or (at your option)
21 ;;; any later version.
23 ;;; GNU Emacs is distributed in the hope that it will be useful,
24 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;;; GNU General Public License for more details.
28 ;;; You should have received a copy of the GNU General Public License
29 ;;; along with GNU Emacs; see the file COPYING. If not, write to
30 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
36 ;;; This code contains a section of user-settable variables that you should
37 ;;; inspect prior to installation. Look past the end of the history list.
38 ;;; Set them up for your locale and the preferences of the majority of the
39 ;;; users. Otherwise the users may need to set a number of variables
41 ;;; You particularly may want to change the default dictionary for your
42 ;;; country and language.
45 ;;; To fully install this, add this file to your Emacs Lisp directory and
46 ;;; compile it with M-X byte-compile-file. Then add the following to the
47 ;;; appropriate init file:
49 ;;; (autoload 'ispell-word "ispell"
50 ;;; "Check the spelling of word in buffer." t)
51 ;;; (global-set-key "\e$" 'ispell-word)
52 ;;; (autoload 'ispell-region "ispell"
53 ;;; "Check the spelling of region." t)
54 ;;; (autoload 'ispell-buffer "ispell"
55 ;;; "Check the spelling of buffer." t)
56 ;;; (autoload 'ispell-complete-word "ispell"
57 ;;; "Look up current word in dictionary and try to complete it." t)
58 ;;; (autoload 'ispell-change-dictionary "ispell"
59 ;;; "Change ispell dictionary." t)
60 ;;; (autoload 'ispell-message "ispell"
61 ;;; "Check spelling of mail message or news post.")
63 ;;; Depending on the mail system you use, you may want to include these:
65 ;;; (add-hook 'news-inews-hook 'ispell-message)
66 ;;; (add-hook 'mail-send-hook 'ispell-message)
67 ;;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
70 ;;; Ispell has a TeX parser and a nroff parser (the default).
71 ;;; The parsing is controlled by the variable ispell-parser. Currently
72 ;;; it is just a "toggle" between TeX and nroff, but if more parsers are
73 ;;; added it will be updated. See the variable description for more info.
83 ;;; ispell-complete-word
84 ;;; ispell-complete-word-interior-frag
85 ;;; ispell-change-dictionary
86 ;;; ispell-kill-ispell
90 ;;; Commands in ispell-region:
91 ;;; Character replacement: Replace word with choice. May query-replace.
92 ;;; ' ': Accept word this time.
93 ;;; 'i': Accept word and insert into private dictionary.
94 ;;; 'a': Accept word for this session.
95 ;;; 'A': Accept word and place in buffer-local dictionary.
96 ;;; 'r': Replace word with typed-in value. Rechecked.
97 ;;; 'R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
98 ;;; '?': Show these commands
99 ;;; 'x': Exit spelling buffer. Move cursor to original point.
100 ;;; 'X': Exit spelling buffer. Leave cursor at the current point.
101 ;;; 'q': Quit spelling session (Kills ispell process).
102 ;;; 'l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
103 ;;; 'u': Like 'i', but the word is lower-cased first.
104 ;;; 'm': Like 'i', but allows one to include dictionary completion info.
105 ;;; 'C-l': redraws screen
106 ;;; 'C-r': recursive edit
107 ;;; 'C-z': suspend emacs or iconify frame
109 ;;; Buffer-Local features:
110 ;;; There are a number of buffer-local features that can be used to customize
111 ;;; ispell for the current buffer. This includes language dictionaries,
112 ;;; personal dictionaries, parsing, and local word spellings. Each of these
113 ;;; local customizations are done either through local variables, or by
114 ;;; including the keyword and argument(s) at the end of the buffer (usually
115 ;;; prefixed by the comment characters). See the end of this file for
116 ;;; examples. The local keywords and variables are:
118 ;;; ispell-dictionary-keyword language-dictionary
119 ;;; uses local variable ispell-local-dictionary
120 ;;; ispell-pdict-keyword personal-dictionary
121 ;;; uses local variable ispell-local-pdict
122 ;;; ispell-parsing-keyword mode-arg extended-char-arg
123 ;;; ispell-words-keyword any number of local word spellings
127 ;;; Highlighting in version 19 still doesn't work on tty's.
128 ;;; On some versions of emacs, growing the minibuffer fails.
132 ;;; Revision 2.36 1995/2/6 17:39:38 stevens
133 ;;; Properly adjust screen with different ispell-choices-win-default-height
134 ;;; settings. Skips SGML entity references.
136 ;;; Revision 2.35 1995/1/13 14:16:46 stevens
137 ;;; Skips SGML tags, ispell-change-dictionary fix for add-hook, assure personal
138 ;;; dictionary is saved when called from the menu
140 ;;; Revision 2.34 1994/12/08 13:17:41 stevens
141 ;;; Interaction corrected to function with all 3.1 ispell versions.
143 ;;; Revision 2.33 1994/11/24 02:31:20 stevens
144 ;;; Repaired bug introduced in 2.32 that corrupts buffers when correcting.
145 ;;; Improved buffer scrolling. Nondestructive buffer selections allowed.
147 ;;; Revision 2.32 1994/10/31 21:10:08 geoff
148 ;;; Many revisions accepted from RMS/FSF. I think (though I don't know) that
149 ;;; this represents an 'official' version.
151 ;;; Revision 2.31 1994/5/31 10:18:17 stevens
152 ;;; Repaired comments. buffer-local commands executed in `ispell-word' now.
153 ;;; German dictionary described for extended character mode. Dict messages.
155 ;;; Revision 2.30 1994/5/20 22:18:36 stevens
156 ;;; Continue ispell from ispell-word, C-z functionality fixed.
158 ;;; Revision 2.29 1994/5/12 09:44:33 stevens
159 ;;; Restored ispell-use-ptys-p, ispell-message aborts sends with interrupt.
160 ;;; defined fn ispell
162 ;;; Revision 2.28 1994/4/28 16:24:40 stevens
163 ;;; Window checking when ispell-message put on gnus-inews-article-hook jwz.
164 ;;; prefixed ispell- to highlight functions and horiz-scroll fn.
165 ;;; Try and respect case of word in ispell-complete-word.
166 ;;; Ignore non-char events. Ispell-use-ptys-p commented out. Lucid menu.
167 ;;; Better interrupt handling. ispell-message improvements from Ethan.
170 ;;; version 18 explicit C-g handling disabled as it didn't work. Added
171 ;;; ispell-extra-args for ispell customization (jwz)
173 ;;; Revision 2.26 1994/2/15 16:11:14 stevens
174 ;;; name changes for copyright assignment. Added word-frags in complete-word.
175 ;;; Horizontal scroll (John Conover). Query-replace matches words now. bugs.
178 ;;; minor mods, upgraded ispell-message
181 ;;; query-replace more robust, messages, defaults, ispell-change-dict.
183 ;;; Revision 2.23 1993/11/22 23:47:03 stevens
184 ;;; ispell-message, Fixed highlighting, added menu-bar, fixed ispell-help, ...
187 ;;; Added 'u' command. Fixed default in ispell-local-dictionary.
188 ;;; fixed affix rules display. Tib skipping more robust. Contributions by
189 ;;; Per Abraham (parser selection), Denis Howe, and Eberhard Mattes.
191 ;;; Revision 2.21 1993/06/30 14:09:04 stevens
192 ;;; minor bugs. (nroff word skipping fixed)
194 ;;; Revision 2.20 1993/06/30 14:09:04 stevens
196 ;;; Debugging and contributions by: Boris Aronov, Rik Faith, Chris Moore,
197 ;;; Kevin Rodgers, Malcolm Davis.
198 ;;; Particular thanks to Michael Lipp, Jamie Zawinski, Phil Queinnec
199 ;;; and John Heidemann for suggestions and code.
200 ;;; Major update including many tweaks.
201 ;;; Many changes were integrations of suggestions.
202 ;;; lookup-words rehacked to use call-process (Jamie).
203 ;;; ispell-complete-word rehacked to be compatible with the rest of the
204 ;;; system for word searching and to include multiple wildcards,
205 ;;; and it's own dictionary.
206 ;;; query-replace capability added. New options 'X', 'R', and 'A'.
207 ;;; buffer-local modes for dictionary, word-spelling, and formatter-parsing.
208 ;;; Many random bugs, like commented comments being skipped, fix to
209 ;;; keep-choices-win, fix for math mode, added pipe mode choice,
210 ;;; fixed 'q' command, ispell-word checks previous word and leave cursor
211 ;;; in same location. Fixed tib code which could drop spelling regions.
212 ;;; Cleaned up setq calls for efficiency. Gave more context on window overlays.
213 ;;; Assure context on ispell-command-loop. Window lossage in look cmd fixed.
214 ;;; Due to pervasive opinion, common-lisp package syntax removed. Display
215 ;;; problem when not highlighting.
217 ;;; Revision 2.19 1992/01/10 10:54:08 geoff
218 ;;; Make another attempt at fixing the "Bogus, dude" problem. This one is
219 ;;; less elegant, but has the advantage of working.
221 ;;; Revision 2.18 1992/01/07 10:04:52 geoff
222 ;;; Fix the "Bogus, Dude" problem in ispell-word.
224 ;;; Revision 2.17 1991/09/12 00:01:42 geoff
225 ;;; Add some changes to make ispell-complete-word work better, though
226 ;;; still not perfectly.
228 ;;; Revision 2.16 91/09/04 18:00:52 geoff
229 ;;; More updates from Sebastian, to make the multiple-dictionary support
232 ;;; Revision 2.15 91/09/04 17:30:02 geoff
233 ;;; Sebastian Kremer's tib support
235 ;;; Revision 2.14 91/09/04 16:19:37 geoff
236 ;;; Don't do set-window-start if the move-to-window-line moved us
237 ;;; downward, rather than upward. This prevents getting the buffer all
238 ;;; confused. Also, don't use the "not-modified" function to clear the
239 ;;; modification flag; instead use set-buffer-modified-p. This prevents
240 ;;; extra messages from flashing.
242 ;;; Revision 2.13 91/09/04 14:35:41 geoff
243 ;;; Fix a spelling error in a comment. Add code to handshake with the
244 ;;; ispell process before sending anything to it.
246 ;;; Revision 2.12 91/09/03 20:14:21 geoff
247 ;;; Add Sebastian Kremer's multiple-language support.
251 ;;; Texas Instruments - Computer Science Center
252 ;;; ARPA: Buehring%TI-CSL@CSNet-Relay
253 ;;; UUCP: {smu, texsun, im4u, rice} ! ti-csl ! buehring
255 ;;; ispell-region and associated routines added by
258 ;;; Tue Jan 13 20:18:02 CST 1987
260 ;;; extensively modified by Mark Davies and Andrew Vignaux
261 ;;; {mark,andrew}@vuwcomp
262 ;;; Sun May 10 11:45:04 NZST 1987
264 ;;; Ken Stevens ARPA: k.stevens@ieee.org
265 ;;; Tue Jan 3 16:59:07 PST 1989
266 ;;; This file has overgone a major overhaul to be compatible with ispell
267 ;;; version 2.1. Most of the functions have been totally rewritten, and
268 ;;; many user-accessible variables have been added. The syntax table has
269 ;;; been removed since it didn't work properly anyway, and a filter is
270 ;;; used rather than a buffer. Regular expressions are used based on
271 ;;; ispell's internal definition of characters (see ispell(4)).
272 ;;; Some new updates:
273 ;;; - Updated to version 3.0 to include terse processing.
274 ;;; - Added a variable for the look command.
275 ;;; - Fixed a bug in ispell-word when cursor is far away from the word
276 ;;; that is to be checked.
277 ;;; - Ispell places the incorrect word or guess in the minibuffer now.
278 ;;; - fixed a bug with 'l' option when multiple windows are on the screen.
279 ;;; - lookup-words just didn't work with the process filter. Fixed.
280 ;;; - Rewrote the process filter to make it cleaner and more robust
281 ;;; in the event of a continued line not being completed.
282 ;;; - Made ispell-init-process more robust in handling errors.
283 ;;; - Fixed bug in continuation location after a region has been modified by
284 ;;; correcting a misspelling.
287 ;;; Sebastian Kremer <sk@thp.uni-koeln.de>
288 ;;; Wed Aug 7 14:02:17 MET DST 1991
289 ;;; - Ported ispell-complete-word from Ispell 2 to Ispell 3.
290 ;;; - Added ispell-kill-ispell command.
291 ;;; - Added ispell-dictionary and ispell-dictionary-alist variables to
292 ;;; support other than default language. See their docstrings and
293 ;;; command ispell-change-dictionary.
294 ;;; - (ispelled it :-)
295 ;;; - Added ispell-skip-tib variable to support the tib bibliography
299 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
303 ;;; **********************************************************************
304 ;;; The following variables should be set according to personal preference
305 ;;; and location of binaries:
306 ;;; **********************************************************************
309 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1
312 (defvar ispell-highlight-p t
313 "*Highlight spelling errors when non-nil.")
315 (defvar ispell-highlight-face
'highlight
316 "*The face used for Ispell highlighting. For Emacses with overlays.
317 Possible values are `highlight', `modeline', `secondary-selection',
318 `region', and `underline'.
319 This variable can be set by the user to whatever face they desire.
320 It's most convenient if the cursor color and highlight color are
321 slightly different.")
323 (defvar ispell-check-comments nil
324 "*Spelling of comments checked when non-nil.")
326 (defvar ispell-query-replace-choices nil
327 "*Corrections made throughout region when non-nil.
328 Uses `query-replace' (\\[query-replace]) for corrections.")
330 (defvar ispell-skip-tib nil
331 "*Does not spell check `tib' bibliography references when non-nil.
332 Skips any text between strings matching regular expressions
333 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
335 TeX users beware: Any field starting with [. will skip until a .] -- even
336 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
337 a [.5mm] type of number....")
339 (defvar ispell-tib-ref-beginning
"[[<]\\."
340 "Regexp matching the beginning of a Tib reference.")
342 (defvar ispell-tib-ref-end
"\\.[]>]"
343 "Regexp matching the end of a Tib reference.")
345 (defvar ispell-keep-choices-win t
346 "*When not nil, the `*Choices*' window remains for spelling session.
347 This minimizes redisplay thrashing.")
349 (defvar ispell-choices-win-default-height
2
350 "*The default size of the `*Choices*' window, including status line.
351 Must be greater than 1.")
353 (defvar ispell-program-name
"ispell"
354 "Program invoked by \\[ispell-word] and \\[ispell-region] commands.")
356 (defvar ispell-alternate-dictionary
357 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
358 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
359 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
360 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
361 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
362 ((file-exists-p "/sys/dict") "/sys/dict")
363 (t "/usr/dict/words"))
364 "*Alternate dictionary for spelling help.")
366 (defvar ispell-complete-word-dict ispell-alternate-dictionary
367 "*Dictionary used for word completion.")
369 (defvar ispell-grep-command
"egrep"
370 "Name of the grep command for search processes.")
372 (defvar ispell-grep-options
"-i"
373 "String of options to use when running the program in `ispell-grep-command'.
374 Should probably be \"-i\" or \"-e\".
375 Some machines (like the NeXT) don't support \"-i\"")
377 (defvar ispell-look-command
"look"
378 "Name of the look command for search processes.
379 This must be an absolute file name.")
381 (defvar ispell-look-p
(file-exists-p ispell-look-command
)
382 "*Non-nil means use `look' rather than `grep'.
383 Default is based on whether `look' seems to be available.")
385 (defvar ispell-have-new-look nil
386 "*Non-nil means use the `-r' option (regexp) when running `look'.")
388 (defvar ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
389 "String of command options for `ispell-look-command'.")
391 (defvar ispell-use-ptys-p nil
392 "When non-nil, Emacs uses ptys to communicate with Ispell.
393 When nil, Emacs uses pipes.")
395 (defvar ispell-following-word nil
396 "*Non-nil means `ispell-word' checks the word around or after point.
397 Otherwise `ispell-word' checks the preceding word.")
399 (defvar ispell-help-in-bufferp nil
400 "*Non-nil means display interactive keymap help in a buffer.
401 Otherwise use the minibuffer.")
403 (defvar ispell-quietly nil
404 "*Non-nil means suppress messages in `ispell-word'.")
406 (defvar ispell-format-word
(function upcase
)
407 "*Formatting function for displaying word being spell checked.
408 The function must take one string argument and return a string.")
411 (defvar ispell-personal-dictionary nil
412 "*File name of your personal spelling dictionary, or nil.
413 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
414 where DICTNAME is the name of your default dictionary.")
416 (defvar ispell-silently-savep nil
417 "*When non-nil, save the personal dictionary without confirmation.")
419 ;;; This variable contains the current dictionary being used if the ispell
420 ;;; process is running. Otherwise it contains the global default.
421 (defvar ispell-dictionary nil
422 "If non-nil, a dictionary to use instead of the default one.
423 This is passed to the ispell process using the `-d' switch and is
424 used as key in `ispell-dictionary-alist' (which see).
426 You should set this variable before your first use of Emacs spell-checking
427 commands in the Emacs session, or else use the \\[ispell-change-dictionary]
428 command to change it. Otherwise, this variable only takes effect in a newly
429 started Ispell process.")
431 (defvar ispell-extra-args nil
432 "*If non-nil, a list of extra switches to pass to the Ispell program.
433 For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
434 words as correct. See also `ispell-dictionary-alist', which may be used
435 for language-specific arguments.")
438 (defvar ispell-dictionary-alist-1
; sk 9-Aug-1991 18:28
439 '((nil ; default (english.aff)
440 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil
)
441 ("english" ; make english explicitly selectable
442 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil
)
443 ("british" ; british version
444 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B" "-d" "british") nil
)
445 ("deutsch" ; deutsch.aff
446 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex")
448 "[a-zA-Z\304\326\334\344\366\337\374]"
449 "[^a-zA-Z\304\326\334\344\366\337\374]"
450 "[']" t
("-C" "-d" "deutsch") "~latin1")
451 ("nederlands" ; nederlands.aff
452 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
453 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
455 ("nederlands8" ; dutch8.aff
456 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
457 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
458 "[']" t
("-C") nil
)))
461 (defvar ispell-dictionary-alist-2
462 '(("svenska" ;7 bit swedish mode
463 "[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
464 "[']" nil
("-C") nil
)
465 ("svenska8" ;8 bit swedish mode
466 "[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
467 "[']" nil
("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
469 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil
)
470 ("francais" ; francais.aff
471 "[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]"
472 "[^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]"
473 "[---']" t nil
"~list")
474 ("francais-tex" ; francais.aff
475 "[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\\]"
476 "[^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\\]"
477 "[---'^`\"]" t nil
"~tex")
479 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
484 ;;; ispell-dictionary-alist is set up from two subvariables above
485 ;;; to avoid having very long lines in loaddefs.el.
487 (defvar ispell-dictionary-alist
488 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2
)
489 "An alist of dictionaries and their associated parameters.
491 Each element of this list is also a list:
493 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
494 ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
496 DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
497 means the default dictionary.
499 CASECHARS is a regular expression of valid characters that comprise a
502 NOT-CASECHARS is the opposite regexp of CASECHARS.
504 OTHERCHARS is a regular expression of other characters that are valid
505 in word constructs. Otherchars cannot be adjacent to each other in a
506 word, nor can they begin or end a word. This implies we can't check
507 \"Stevens'\" as a correct possessive and other correct formations.
509 Hint: regexp syntax requires the hyphen to be declared first here.
511 MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed in a
512 word instead of only one.
514 ISPELL-ARGS is a list of additional arguments passed to the ispell
517 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
518 have been configured in an Ispell affix file. (For example, umlauts
519 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
520 in English. This has the same effect as the command-line `-T' option.
521 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
522 but the dictionary can control the extended character mode.
523 Both defaults can be overruled in a buffer-local fashion. See
524 `ispell-parsing-keyword' for details on this.
526 Note that the CASECHARS and OTHERCHARS slots of the alist should
527 contain the same character set as casechars and otherchars in the
528 language.aff file \(e.g., english.aff\).")
532 (defvar ispell-menu-map nil
"Key map for ispell menu")
535 (defvar ispell-menu-lucid nil
"Spelling menu for Lucid Emacs.")
537 ;;; Break out lucid menu and split into several calls to avoid having
538 ;;; long lines in loaddefs.el. Detect need off following constant.
541 (defconst ispell-menu-map-needed
; make sure this is not Lucid Emacs
542 (and (not ispell-menu-map
)
543 ;;; This is commented out because it fails in Emacs.
544 ;;; due to the fact that menu-bar is loaded much later than loaddefs.
545 ;;; ;; make sure this isn't Lucid Emacs
546 ;;; (featurep 'menu-bar)
547 (string-lessp "19" emacs-version
)))
552 (if ispell-menu-map-needed
553 (let ((dicts (reverse (cons (cons "default" nil
) ispell-dictionary-alist
)))
555 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
556 ;; add the dictionaries to the bottom of the list.
558 (setq name
(car (car dicts
))
561 (define-key ispell-menu-map
(vector (intern name
))
562 (cons (concat "Select " (capitalize name
))
563 (list 'lambda
() '(interactive)
564 (list 'ispell-change-dictionary name
))))))))
566 ;;; define commands in menu in opposite order you want them to appear.
568 (if ispell-menu-map-needed
570 (define-key ispell-menu-map
[ispell-change-dictionary
]
571 '("Change Dictionary" . ispell-change-dictionary
))
572 (define-key ispell-menu-map
[ispell-kill-ispell
]
573 '("Kill Process" . ispell-kill-ispell
))
574 (define-key ispell-menu-map
[ispell-pdict-save
]
575 '("Save Dictionary" .
(lambda () (interactive) (ispell-pdict-save t t
))))
576 (define-key ispell-menu-map
[ispell-complete-word
]
577 '("Complete Word" . ispell-complete-word
))
578 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
579 '("Complete Word Frag" . ispell-complete-word-interior-frag
))))
582 (if ispell-menu-map-needed
584 (define-key ispell-menu-map
[ispell-continue
]
585 '("Continue Check" . ispell-continue
))
586 (define-key ispell-menu-map
[ispell-word
]
587 '("Check Word" . ispell-word
))
588 (define-key ispell-menu-map
[ispell-region
]
589 '("Check Region" . ispell-region
))
590 (define-key ispell-menu-map
[ispell-buffer
]
591 '("Check Buffer" . ispell-buffer
))))
594 (if ispell-menu-map-needed
596 (define-key ispell-menu-map
[ispell-message
]
597 '("Check Message" . ispell-message
))
598 (define-key ispell-menu-map
[ispell-help
]
599 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
600 '("Help" .
(lambda () (interactive) (describe-function 'ispell-help
))))
601 (put 'ispell-region
'menu-enable
'mark-active
)
602 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
604 ;;; Xemacs version 19
605 (if (and (string-lessp "19" emacs-version
)
606 (string-match "Lucid" emacs-version
))
607 (let ((dicts (cons (cons "default" nil
) ispell-dictionary-alist
))
608 (current-menubar (or current-menubar default-menubar
))
610 '(["Help" (describe-function 'ispell-help
) t
]
611 ;;["Help" (popup-menu ispell-help-list) t]
612 ["Check Message" ispell-message t
]
613 ["Check Buffer" ispell-buffer t
]
614 ["Check Word" ispell-word t
]
615 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
616 ["Continue Check" ispell-continue t
]
617 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
618 ["Complete Word" ispell-complete-word t
]
619 ["Kill Process" ispell-kill-ispell t
]
621 ["Save Dictionary" (ispell-pdict-save t t
) t
]
622 ["Change Dictionary" ispell-change-dictionary t
]))
625 (setq name
(car (car dicts
))
628 (setq menu
(append menu
630 (vector (concat "Select " (capitalize name
))
631 (list 'ispell-change-dictionary name
)
633 (setq ispell-menu-lucid menu
)
636 (delete-menu-item '("Edit" "Spell")) ; in case already defined
637 (add-menu '("Edit") "Spell" ispell-menu-lucid
)))))
640 ;;; **********************************************************************
641 ;;; The following are used by ispell, and should not be changed.
642 ;;; **********************************************************************
645 ;;; The version must be 3.1 or greater for this version of ispell.el
646 ;;; There is an incompatibility between versin 3.1.12 and lower versions.
647 (defconst ispell-required-version
'("3.1." 12)
648 "Ispell versions with which this version of ispell.el is known to work.")
649 (defvar ispell-offset
1
650 "Offset that maps protocol differences between ispell 3.1 versions.")
652 (defun ispell-get-casechars ()
653 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist
)))
654 (defun ispell-get-not-casechars ()
655 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist
)))
656 (defun ispell-get-otherchars ()
657 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist
)))
658 (defun ispell-get-many-otherchars-p ()
659 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist
)))
660 (defun ispell-get-ispell-args ()
661 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist
)))
662 (defun ispell-get-extended-character-mode ()
663 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist
)))
665 (defvar ispell-process nil
666 "The process object for Ispell.")
668 (defvar ispell-pdict-modified-p nil
669 "Non-nil means personal dictionary has modifications to be saved.")
671 ;;; If you want to save the dictionary when quitting, must do so explicitly.
672 ;;; When non-nil, the spell session is terminated.
673 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
674 (defvar ispell-quit nil
)
676 (defvar ispell-filter nil
677 "Output filter from piped calls to Ispell.")
679 (defvar ispell-filter-continue nil
680 "Control variable for Ispell filter function.")
682 (defvar ispell-process-directory nil
683 "The directory where `ispell-process' was started.")
685 (defvar ispell-query-replace-marker
(make-marker)
686 "Marker for `query-replace' processing.")
688 (defvar ispell-checking-message nil
689 "Non-nil when we're checking a mail message")
691 (defconst ispell-choices-buffer
"*Choices*")
693 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
695 ;;; *** Buffer Local Definitions ***
697 ;;; This is the local dictionary to use. When nil the default dictionary will
698 ;;; be used. Do not redefine default value or it will override the global!
699 (defvar ispell-local-dictionary nil
700 "If non-nil, a dictionary to use for Ispell commands in this buffer.
701 The value must be a string dictionary name in `ispell-dictionary-alist'.
702 This variable becomes buffer-local when set in any fashion.
704 Setting ispell-local-dictionary to a value has the same effect as
705 calling \\[ispell-change-dictionary] with that value. This variable
706 is automatically set when defined in the file with either
707 `ispell-dictionary-keyword' or the Local Variable syntax.")
709 (make-variable-buffer-local 'ispell-local-dictionary
)
711 ;; Use default directory, unless locally set.
712 (set-default 'ispell-local-dictionary nil
)
714 (defconst ispell-words-keyword
"LocalWords: "
715 "The keyword for local oddly-spelled words to accept.
716 The keyword will be followed by any number of local word spellings.
717 There can be multiple of these keywords in the file.")
719 (defconst ispell-dictionary-keyword
"Local IspellDict: "
720 "The keyword for local dictionary definitions.
721 There should be only one dictionary keyword definition per file, and it
722 should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
724 (defconst ispell-parsing-keyword
"Local IspellParsing: "
725 "The keyword for overriding default Ispell parsing.
726 Determined by the buffer's major mode and extended-character mode as well as
727 the default dictionary.
729 The above keyword string should be followed by `latex-mode' or
730 `nroff-mode' to put the current buffer into the desired parsing mode.
732 Extended character mode can be changed for this buffer by placing
733 a `~' followed by an extended-character mode -- such as `~.tex'.")
735 (defvar ispell-skip-sgml nil
736 "Skips spell checking of SGML tags and entity references when non-nil.
737 This variable is set when major-mode is sgml-mode.")
740 (defvar ispell-local-pdict ispell-personal-dictionary
741 "A buffer local variable containing the current personal dictionary.
742 If non-nil, the value must be a string, which is a file name.
744 If you specify a personal dictionary for the current buffer which is
745 different from the current personal dictionary, the effect is similar
746 to calling \\[ispell-change-dictionary]. This variable is automatically
747 set when defined in the file with either `ispell-pdict-keyword' or the
748 local variable syntax.")
750 (make-variable-buffer-local 'ispell-local-pdict
)
752 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
753 "The keyword for defining buffer local dictionaries.")
755 (defvar ispell-buffer-local-name nil
756 "Contains the buffer name if local word definitions were used.
757 Ispell is then restarted because the local words could conflict.")
759 (defvar ispell-parser
'use-mode-name
760 "*Indicates whether ispell should parse the current buffer as TeX Code.
761 Special value `use-mode-name' tries to guess using the name of major-mode.
762 Default parser is 'nroff.
763 Currently the only other valid parser is 'tex.
765 You can set this variable in hooks in your init file -- eg:
767 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
769 (defvar ispell-region-end
(make-marker)
770 "Marker that allows spelling continuations.")
772 (defvar ispell-check-only nil
773 "If non-nil, `ispell-word' does not try to correct the word.")
776 ;;; **********************************************************************
777 ;;; **********************************************************************
780 (and (string-lessp "19" emacs-version
)
781 (not (boundp 'epoch
::version
))
782 (defalias 'ispell
'ispell-buffer
))
784 ;;;###autoload (define-key global-map "\M-$" 'ispell-word)
787 (defun ispell-word (&optional following quietly continue
)
788 "Check spelling of word under or before the cursor.
789 If the word is not found in dictionary, display possible corrections
790 in a window allowing you to choose one.
792 With a prefix argument (or if CONTINUE is non-nil),
793 resume interrupted spell-checking of a buffer or region.
795 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
796 is non-nil when called interactively, then the following word
797 \(rather than preceding\) is checked when the cursor is not over a word.
798 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
799 when called interactively, non-corrective messages are suppressed.
801 Word syntax described by `ispell-dictionary-alist' (which see).
803 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
804 or \\[ispell-region] to update the Ispell process."
805 (interactive (list nil nil current-prefix-arg
))
809 (setq following ispell-following-word
810 quietly ispell-quietly
))
811 (ispell-accept-buffer-local-defs) ; use the correct dictionary
812 (let ((cursor-location (point)) ; retain cursor location
813 (word (ispell-get-word following
))
814 start end poss replace
)
815 ;; destructure return word info list.
816 (setq start
(car (cdr word
))
817 end
(car (cdr (cdr word
)))
820 ;; now check spelling of word.
822 (message "Checking spelling of %s..."
823 (funcall ispell-format-word word
)))
824 (process-send-string ispell-process
"%\n") ;put in verbose mode
825 (process-send-string ispell-process
(concat "^" word
"\n"))
826 ;; wait until ispell has processed word
828 (accept-process-output ispell-process
)
829 (not (string= "" (car ispell-filter
)))))
830 ;;(process-send-string ispell-process "!\n") ;back to terse mode.
831 (setq ispell-filter
(cdr ispell-filter
))
832 (if (listp ispell-filter
)
833 (setq poss
(ispell-parse-output (car ispell-filter
))))
836 (message "%s is correct" (funcall ispell-format-word word
))))
839 (message "%s is correct because of root %s"
840 (funcall ispell-format-word word
)
841 (funcall ispell-format-word poss
))))
842 ((null poss
) (message "Error in ispell process"))
843 (ispell-check-only ; called from ispell minor mode.
845 (t ; prompt for correct word.
846 (save-window-excursion
847 (setq replace
(ispell-command-loop
848 (car (cdr (cdr poss
)))
849 (car (cdr (cdr (cdr poss
))))
850 (car poss
) start end
)))
851 (cond ((equal 0 replace
)
852 (ispell-add-per-file-word-list (car poss
)))
854 (setq word
(if (atom replace
) replace
(car replace
))
855 cursor-location
(+ (- (length word
) (- end start
))
857 (if (not (equal word
(car poss
)))
859 (delete-region start end
)
861 (if (not (atom replace
)) ; recheck spelling of replacement
863 (goto-char cursor-location
)
864 (ispell-word following quietly
)))))
865 (if (get-buffer ispell-choices-buffer
)
866 (kill-buffer ispell-choices-buffer
))))
867 (goto-char cursor-location
) ; return to original location
868 (ispell-pdict-save ispell-silently-savep
)
869 (if ispell-quit
(setq ispell-quit nil
)))))
872 (defun ispell-get-word (following &optional extra-otherchars
)
873 "Return the word for spell-checking according to ispell syntax.
874 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
875 is non-nil when called interactively, then the following word
876 \(rather than preceding\) is checked when the cursor is not over a word.
877 Optional second argument contains otherchars that can be included in word
880 Word syntax described by `ispell-dictionary-alist' (which see)."
881 (let* ((ispell-casechars (ispell-get-casechars))
882 (ispell-not-casechars (ispell-get-not-casechars))
883 (ispell-otherchars (ispell-get-otherchars))
884 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
885 (word-regexp (concat ispell-casechars
890 (concat extra-otherchars
"?"))
893 (if (or ispell-many-otherchars-p
899 (if (not (looking-at ispell-casechars
))
901 (re-search-forward ispell-casechars
(point-max) t
)
902 (re-search-backward ispell-casechars
(point-min) t
)))
903 ;; move to front of word
904 (re-search-backward ispell-not-casechars
(point-min) 'start
)
905 (while (and (or (looking-at ispell-otherchars
)
906 (and extra-otherchars
(looking-at extra-otherchars
)))
908 (or (not did-it-once
)
909 ispell-many-otherchars-p
))
910 (if (and extra-otherchars
(looking-at extra-otherchars
))
913 (if (looking-at ispell-casechars
)
914 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
917 (if (looking-at ispell-casechars
)
918 (re-search-backward ispell-not-casechars
(point-min) 'move
)
919 (backward-char -
1))))
920 ;; Now mark the word and save to string.
921 (or (re-search-forward word-regexp
(point-max) t
)
922 (error "No word found to check!"))
923 (setq start
(match-beginning 0)
925 word
(buffer-substring start end
))
926 (list word start end
)))
929 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
930 ;;; tracks changes in the dictionary. The global may either be
931 ;;; a value or a list, whose value is the state of whether the
932 ;;; dictionary needs to be saved.
934 (defun ispell-pdict-save (&optional no-query force-save
)
935 "Check to see if the personal dictionary has been modified.
936 If so, ask if it needs to be saved."
937 (interactive (list ispell-silently-savep t
))
938 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
939 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
940 (if (or ispell-pdict-modified-p force-save
)
941 (if (or no-query
(y-or-n-p "Personal dictionary modified. Save? "))
943 (process-send-string ispell-process
"#\n")
944 (message "Personal dictionary saved."))))
945 ;; unassert variable, even if not saved to avoid questioning.
946 (setq ispell-pdict-modified-p nil
))
949 (defun ispell-command-loop (miss guess word start end
)
950 "Display possible corrections from list MISS.
951 GUESS lists possibly valid affix construction of WORD.
952 Returns nil to keep word.
953 Returns 0 to insert locally into buffer-local dictionary.
954 Returns string for new chosen word.
955 Returns list for new replacement word (will be rechecked).
956 Highlights the word, which is assumed to run from START to END.
957 Global `ispell-pdict-modified-p' becomes a list where the only value
958 indicates whether the dictionary has been modified when option `a' or `i' is
960 (let ((textbuf (current-buffer))
963 (max-lines (- (window-height) 4)) ; assure 4 context lines.
965 (window-min-height (min window-min-height
966 ispell-choices-win-default-height
))
967 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
969 char num result textwin highlighted
)
971 ;; setup the *Choices* buffer with valid data.
973 (set-buffer (get-buffer-create ispell-choices-buffer
))
974 (setq mode-line-format
"-- %b --")
978 (insert "Affix rules generate and capitalize "
979 "this word as shown below:\n\t")
981 (if (> (+ 4 (current-column) (length (car guess
)))
985 (setq line
(1+ line
))))
986 (insert (car guess
) " ")
987 (setq guess
(cdr guess
)))
988 (insert "\nUse option `i' if this is a correct composition"
989 " from the derivative root.\n")
990 (setq line
(+ line
(if choices
3 2)))))
992 (< (if (> (+ 7 (current-column) (length (car choices
))
993 (if (> count ?~
) 3 0))
997 (setq line
(1+ line
)))
1000 ;; not so good if there are over 20 or 30 options, but then, if
1001 ;; there are that many you don't want to scan them all anyway...
1002 (while (memq count command-characters
) ; skip command characters.
1003 (setq count
(1+ count
)
1004 skipped
(1+ skipped
)))
1005 (insert "(" count
") " (car choices
) " ")
1006 (setq choices
(cdr choices
)
1008 (setq count
(- count ?
0 skipped
)))
1010 ;; Assure word is visible
1011 (if (not (pos-visible-in-window-p end
))
1013 ;; Display choices for misspelled word.
1014 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
1016 (if (= line
(window-height choices-window
))
1017 (select-window choices-window
)
1018 ;; *Choices* window changed size. Adjust the choices window
1019 ;; without scrolling the spelled window when possible
1020 (let ((window-line (- line
(window-height choices-window
)))
1021 (visible (progn (forward-line -
1) (point))))
1022 (if (< line ispell-choices-win-default-height
)
1023 (setq window-line
(+ window-line
1024 (- ispell-choices-win-default-height
1026 (move-to-window-line 0)
1027 (forward-line window-line
)
1028 (set-window-start (selected-window)
1029 (if (> (point) visible
) visible
(point)))
1031 (select-window (previous-window)) ; *Choices* window
1032 (enlarge-window window-line
)))
1033 ;; Overlay *Choices* window when it isn't showing
1034 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
1035 (switch-to-buffer ispell-choices-buffer
)
1036 (goto-char (point-min)))
1038 (select-window (setq textwin
(next-window)))
1040 ;; highlight word, protecting current buffer status
1043 (if ispell-highlight-p
1044 (ispell-highlight-spelling-error start end t
))
1045 ;; Loop until a valid choice is made.
1053 (message (concat "C-h or ? for more options; SPC to leave "
1054 "unchanged, Character to replace word"))
1055 (let ((inhibit-quit t
))
1056 (setq char
(if (fboundp 'read-char-exclusive
)
1057 (read-char-exclusive)
1060 (if (or quit-flag
(= char ?\C-g
)) ; C-g is like typing X
1063 ;; Adjust num to array offset skipping command characters.
1064 (let ((com-chars command-characters
))
1066 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
1067 (setq skipped
(1+ skipped
)))
1068 (setq com-chars
(cdr com-chars
)))
1069 (setq num
(- char ?
0 skipped
)))
1072 ((= char ?
) nil
) ; accept word this time only
1073 ((= char ?i
) ; accept and insert word into pers dict
1074 (process-send-string ispell-process
(concat "*" word
"\n"))
1075 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
1077 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
1078 (process-send-string ispell-process
(concat "@" word
"\n"))
1079 (if (null ispell-pdict-modified-p
)
1080 (setq ispell-pdict-modified-p
1081 (list ispell-pdict-modified-p
)))
1082 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
1083 ((or (= char ?r
) (= char ?R
)) ; type in replacement
1084 (if (or (= char ?R
) ispell-query-replace-choices
)
1085 (list (read-string "Query-replacement for: " word
) t
)
1086 (cons (read-string "Replacement for: " word
) nil
)))
1087 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
1090 ;; Quit and move point back.
1092 (ispell-pdict-save ispell-silently-savep
)
1093 (message "Exited spell-checking")
1094 (setq ispell-quit t
)
1096 ;; Quit and preserve point.
1098 (ispell-pdict-save ispell-silently-savep
)
1100 (substitute-command-keys
1101 (concat "Spell-checking suspended;"
1102 " use C-u \\[ispell-word] to resume")))
1103 (setq ispell-quit
(max (point-min)
1104 (- (point) (length word
))))
1107 (if (y-or-n-p "Really kill Ispell process? ")
1109 (ispell-kill-ispell t
) ; terminate process.
1110 (setq ispell-quit
(or (not ispell-checking-message
)
1112 ispell-pdict-modified-p nil
))
1113 t
)) ; continue if they don't quit.
1115 (let ((new-word (read-string
1116 "Lookup string (`*' is wildcard): "
1122 (set-buffer (get-buffer-create
1123 ispell-choices-buffer
))
1127 mode-line-format
"-- %b --"
1128 miss
(lookup-words new-word
)
1130 (while (and choices
; adjust choices window.
1131 (< (if (> (+ 7 (current-column)
1132 (length (car choices
))
1133 (if (> count ?~
) 3 0))
1141 (while (memq count command-characters
)
1142 (setq count
(1+ count
)
1143 skipped
(1+ skipped
)))
1144 (insert "(" count
") " (car choices
) " ")
1145 (setq choices
(cdr choices
)
1147 (setq count
(- count ?
0 skipped
)))
1148 (select-window (previous-window))
1149 (if (and (/= new-line line
)
1150 (> (max line new-line
)
1151 ispell-choices-win-default-height
))
1152 (let* ((minh ispell-choices-win-default-height
)
1153 (gr-bl (if (< line minh
) ; blanks
1156 (shr-bl (if (< new-line minh
) ; blanks
1159 (if (> new-line line
)
1160 (enlarge-window (- new-line line gr-bl
))
1161 (shrink-window (- line new-line shr-bl
)))
1162 (setq line new-line
)))
1163 (select-window (next-window)))))
1164 t
) ; reselect from new choices
1166 (process-send-string ispell-process
1167 (concat "*" (downcase word
) "\n"))
1168 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
1170 ((= char ?m
) ; type in what to insert
1171 (process-send-string
1172 ispell-process
(concat "*" (read-string "Insert: " word
)
1174 (setq ispell-pdict-modified-p
'(t))
1176 ((and (>= num
0) (< num count
))
1177 (if ispell-query-replace-choices
; Query replace flag
1178 (list (nth num miss
) 'query-replace
)
1183 (save-window-excursion (recursive-edit)) t
)
1185 (funcall (key-binding "\C-z"))
1190 (if ispell-highlight-p
; unhighlight
1191 (save-window-excursion
1192 (select-window textwin
)
1193 (ispell-highlight-spelling-error start end
))))))
1197 (defun ispell-help ()
1198 "Display a list of the options available when a misspelling is encountered.
1202 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1203 SPC: Accept word this time.
1204 `i': Accept word and insert into private dictionary.
1205 `a': Accept word for this session.
1206 `A': Accept word and place in `buffer-local dictionary'.
1207 `r': Replace word with typed-in value. Rechecked.
1208 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1209 `?': Show these commands.
1210 `x': Exit spelling buffer. Move cursor to original point.
1211 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1212 the aborted check to be completed later.
1213 `q': Quit spelling session (Kills ispell process).
1214 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1215 `u': Like `i', but the word is lower-cased first.
1216 `m': Like `i', but allows one to include dictionary completion information.
1217 `C-l': redraws screen
1218 `C-r': recursive edit
1219 `C-z': suspend emacs or iconify frame"
1221 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1222 "[i]nsert into private dictionary"))
1223 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1224 "e[x/X]it; [q]uit session"))
1225 (help-3 (concat "[u]ncapitalized insert into dictionary. "
1226 "Type 'C-h d ispell-help' for more help")))
1227 (save-window-excursion
1228 (if ispell-help-in-bufferp
1230 (ispell-overlay-window 4)
1231 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1232 (insert (concat help-1
"\n" help-2
"\n" help-3
))
1234 (kill-buffer "*Ispell Help*"))
1235 (select-window (minibuffer-window))
1236 ;;(enlarge-window 2)
1238 (cond ((string-match "Lucid" emacs-version
)
1244 (goto-char (point-min)))
1246 (if (string-lessp "19" emacs-version
)
1249 (insert (concat help-1
"\n" help-2
"\n" help-3
))))
1254 (defun lookup-words (word &optional lookup-dict
)
1255 "Look up word in word-list dictionary.
1256 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1257 Otherwise the variable `ispell-grep-command' contains the command used to
1258 search for the words (usually egrep).
1260 Optional second argument contains the dictionary to use; the default is
1261 `ispell-alternate-dictionary'."
1262 ;; We don't use the filter for this function, rather the result is written
1263 ;; into a buffer. Hence there is no need to save the filter values.
1264 (if (null lookup-dict
)
1265 (setq lookup-dict ispell-alternate-dictionary
))
1267 (let* ((process-connection-type ispell-use-ptys-p
)
1268 (wild-p (string-match "\\*" word
))
1269 (look-p (and ispell-look-p
; Only use look for an exact match.
1270 (or ispell-have-new-look
(not wild-p
))))
1271 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1272 (prog (if look-p ispell-look-command ispell-grep-command
))
1273 (args (if look-p ispell-look-options ispell-grep-options
))
1276 (save-window-excursion
1277 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
1278 (set-buffer ispell-grep-buffer
)
1282 (insert "^" word
"$")
1283 (while (search-backward "*" nil t
) (insert "."))
1284 (setq word
(buffer-string))
1286 (setq status
(call-process prog nil t nil args word lookup-dict
))
1287 ;; grep returns status 1 and no output when word not found, which
1288 ;; is a perfectly normal thing.
1289 (if (stringp status
)
1290 (setq results
(cons (format "error: %s exited with signal %s"
1291 (file-name-nondirectory prog
) status
)
1293 ;; else collect words into `results' in FIFO order
1294 (goto-char (point-max))
1295 ;; assure we've ended with \n
1296 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
1300 (setq results
(cons (buffer-substring (point) (1- loc
))
1303 (kill-buffer ispell-grep-buffer
)
1304 (if (and results
(string-match ".+: " (car results
)))
1305 (error "%s error: %s" ispell-grep-command
(car results
))))
1309 ;;; "ispell-filter" is a list of output lines from the generating function.
1310 ;;; Each full line (ending with \n) is a separate item on the list.
1311 ;;; "output" can contain multiple lines, part of a line, or both.
1312 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1314 ;;; "ispell-filter-continue" is true when we have received only part of a
1315 ;;; line as output from a generating function ("output" did not end with \n)
1316 ;;; NOTE THAT THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESNT END WITH \n!
1317 ;;; This is the case when a process dies or fails. The default behavior
1318 ;;; in this case treats the next input received as fresh input.
1320 (defun ispell-filter (process output
)
1321 "Output filter function for ispell, grep, and look."
1326 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
1327 ;; If we get out of sync and ispell-filter-continue is asserted when we
1328 ;; are not continuing, treat the next item as a separate list. When
1329 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1332 ;; Continue with same line (item)?
1333 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
1334 ;; Yes. Add it to the prev item
1335 (setcar ispell-filter
1336 (concat (car ispell-filter
) (substring output start end
)))
1337 ;; No. This is a new line and item.
1339 (cons (substring output start end
) ispell-filter
)))
1341 ;; We've completed reading the output, but didn't finish the line.
1342 (setq ispell-filter-continue t continue nil
)
1343 ;; skip over newline, this line complete.
1344 (setq ispell-filter-continue nil end
(1+ end
))
1345 (if (= end
(length output
)) ; No more lines in output
1346 (setq continue nil
) ; so we can exit the filter.
1347 (setq start end
)))))) ; else move start to next line of input
1350 ;;; This function destroys the mark location if it is in the word being
1352 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
)
1353 "Highlight the word from START to END with a kludge using `inverse-video'.
1354 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1355 otherwise it is displayed normally."
1356 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1357 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
1358 (text (buffer-substring start end
)) ; Save highlight region
1359 (inhibit-quit t
) ; inhibit interrupt processing here.
1360 (buffer-undo-list t
)) ; don't clutter the undo list.
1361 (delete-region start end
)
1362 (insert-char ?
(- end start
)) ; mimimize amount of redisplay
1363 (sit-for 0) ; update display
1364 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
1365 (delete-region start end
) ; delete whitespace
1366 (insert text
) ; insert text in inverse video.
1367 (sit-for 0) ; update display showing inverse video.
1368 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
1369 (set-buffer-modified-p modified
))) ; don't modify if flag not set.
1372 (defun ispell-highlight-spelling-error-lucid (start end
&optional highlight
)
1373 "Highlight the word from START to END using `isearch-highlight'.
1374 When the optional third arg HIGHLIGHT is set, the word is highlighted,
1375 otherwise it is displayed normally."
1377 (isearch-highlight start end
)
1378 (isearch-dehighlight t
))
1383 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
1384 "Highlight the word from START to END using overlays.
1385 When the optional third arg HIGHLIGHT is set, the word is highlighted
1386 otherwise it is displayed normally.
1388 The variable `ispell-highlight-face' selects the face to use for highlighting."
1391 (setq ispell-overlay
(make-overlay start end
))
1392 (overlay-put ispell-overlay
'face ispell-highlight-face
))
1393 (delete-overlay ispell-overlay
)))
1396 (defun ispell-highlight-spelling-error (start end
&optional highlight
)
1398 ((string-match "Lucid" emacs-version
)
1399 (ispell-highlight-spelling-error-lucid start end highlight
))
1400 ((and (string-lessp "19" emacs-version
)
1401 (featurep 'faces
) window-system
)
1402 (ispell-highlight-spelling-error-overlay start end highlight
))
1403 (t (ispell-highlight-spelling-error-generic start end highlight
))))
1406 (defun ispell-overlay-window (height)
1407 "Create a window covering the top HEIGHT lines of the current window.
1408 Ensure that the line above point is still visible but otherwise avoid
1409 scrolling the current window. Leave the new window selected."
1411 (let ((oldot (save-excursion (forward-line -
1) (point)))
1412 (top (save-excursion (move-to-window-line height
) (point))))
1413 ;; If line above old point (line starting at olddot) would be
1414 ;; hidden by new window, scroll it to just below new win
1415 ;; otherwise set top line of other win so it doesn't scroll.
1416 (if (< oldot top
) (setq top oldot
))
1417 ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
1418 ;; line) is demanded, the last line is not visible.
1419 ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
1420 ;; So we increment the height for this case.
1421 (if (string-match "19\.9.*Lucid" (emacs-version))
1422 (setq height
(1+ height
)))
1423 (split-window nil height
)
1424 (set-window-start (next-window) top
))))
1427 ;;; Should we add a compound word match return value?
1428 (defun ispell-parse-output (output)
1429 "Parse the OUTPUT string from Ispell and return:
1430 1: t for an exact match.
1431 2: A string containing the root word for a match via suffix removal.
1432 3: A list of possible correct spellings of the format:
1433 '(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
1434 ORIGINAL-WORD is a string of the possibly misspelled word.
1435 OFFSET is an integer giving the line offset of the word.
1436 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses."
1438 ((string= output
"") t
) ; for startup with pipes...
1439 ((string= output
"*") t
) ; exact match
1440 ((string= output
"-") t
) ; compound word match
1441 ((string= (substring output
0 1) "+") ; found cuz of root word
1442 (substring output
2)) ; return root word
1443 (t ; need to process &, ?, and #'s
1444 (let ((type (substring output
0 1)) ; &, ?, or #
1445 (original-word (substring output
2 (string-match " " output
2)))
1446 (cur-count 0) ; contains number of misses + guesses
1447 count miss-list guess-list offset
)
1448 (setq output
(substring output
(match-end 0))) ; skip over misspelling
1449 (if (string= type
"#")
1450 (setq count
0) ; no misses for type #
1451 (setq count
(string-to-int output
) ; get number of misses.
1452 output
(substring output
(1+ (string-match " " output
1)))))
1453 (setq offset
(string-to-int output
))
1454 (if (string= type
"#") ; No miss or guess list.
1456 (setq output
(substring output
(1+ (string-match " " output
1)))))
1458 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
1459 (setq cur-count
(1+ cur-count
))
1460 (if (> cur-count count
)
1461 (setq guess-list
(cons (substring output
0 end
) guess-list
))
1462 (setq miss-list
(cons (substring output
0 end
) miss-list
)))
1463 (if (match-end 1) ; True only when at end of line.
1464 (setq output nil
) ; no more misses or guesses
1465 (setq output
(substring output
(+ end
2))))))
1466 (list original-word offset miss-list guess-list
)))))
1469 (defun check-ispell-version ()
1470 ;; This is a little wasteful as we actually launch ispell twice: once
1471 ;; to make sure it's the right version, and once for real. But people
1472 ;; get confused by version mismatches *all* the time (and I've got the
1473 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
1474 ;; option is the only way I can think of to do this that works with
1475 ;; all versions, since versions earlier than 3.0.09 didn't identify
1476 ;; themselves on startup.
1478 (let ((case-fold-search t
)
1479 ;; avoid bugs when syntax of `.' changes in various default modes
1480 (default-major-mode 'fundamental-mode
)
1482 (set-buffer (get-buffer-create " *ispell-tmp*"))
1484 (setq status
(call-process ispell-program-name nil t nil
"-v"))
1485 (goto-char (point-min))
1486 (if (not (memq status
'(0 nil
)))
1487 (error "%s exited with %s %s" ispell-program-name
1488 (if (stringp status
) "signal" "code") status
))
1489 (if (not (re-search-forward
1491 (regexp-quote (car ispell-required-version
))
1492 "\\)\\([0-9]*\\)\\b")
1495 "%s version %s* is required: try renaming ispell4.el to ispell.el"
1496 ispell-program-name
(car ispell-required-version
))
1497 ;; check that it is the correct version.
1498 (if (< (car (read-from-string (buffer-substring
1499 (match-beginning 2) (match-end 2))))
1500 (car (cdr ispell-required-version
)))
1501 (setq ispell-offset
0)))
1502 (kill-buffer (current-buffer)))))
1505 (defun ispell-init-process ()
1506 "Check status of Ispell process and start if necessary."
1507 (if (and ispell-process
1508 (eq (process-status ispell-process
) 'run
)
1509 ;; If we're using a personal dictionary, assure
1510 ;; we're in the same default directory!
1511 (or (not ispell-personal-dictionary
)
1512 (equal ispell-process-directory default-directory
)))
1513 (setq ispell-filter nil ispell-filter-continue nil
)
1514 ;; may need to restart to select new personal dictionary.
1515 (ispell-kill-ispell t
)
1516 (message "Starting new Ispell process...")
1518 (check-ispell-version)
1519 (setq ispell-process
1520 (let ((process-connection-type ispell-use-ptys-p
))
1521 (apply 'start-process
1522 "ispell" nil ispell-program-name
1523 "-a" ; accept single input lines
1524 "-m" ; make root/affix combos not in dict
1526 ;; Local dictionary becomes the global dictionary in use.
1527 (if ispell-local-dictionary
1528 (setq ispell-dictionary ispell-local-dictionary
))
1529 (setq args
(ispell-get-ispell-args))
1530 (if ispell-dictionary
; use specified dictionary
1532 (append (list "-d" ispell-dictionary
) args
)))
1533 (if ispell-personal-dictionary
; use specified pers dict
1538 ispell-personal-dictionary
)))))
1539 (setq args
(append args ispell-extra-args
))
1542 ispell-filter-continue nil
1543 ispell-process-directory default-directory
)
1544 (set-process-filter ispell-process
'ispell-filter
)
1545 (accept-process-output ispell-process
) ; Get version ID line
1546 (cond ((null ispell-filter
)
1547 (error "%s did not output version line" ispell-program-name
))
1548 ((and (null (cdr ispell-filter
))
1549 (stringp (car ispell-filter
))
1550 (string-match "^@(#) " (car ispell-filter
)))
1551 ;; got the version line as expected (we already know it's the right
1552 ;; version, so don't bother checking again.)
1555 ;; Otherwise, it must be an error message. Show the user.
1556 ;; But first wait to see if some more output is going to arrive.
1557 ;; Otherwise we get cool errors like "Can't open ".
1559 (accept-process-output)
1560 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
1561 (setq ispell-filter nil
) ; Discard version ID line
1562 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1563 (if extended-char-mode
1564 (process-send-string ispell-process
1565 (concat extended-char-mode
"\n"))))
1566 (process-kill-without-query ispell-process
)))
1569 (defun ispell-kill-ispell (&optional no-error
)
1570 "Kill current Ispell process (so that you may start a fresh one).
1571 With NO-ERROR, just return non-nil if there was no Ispell running."
1573 (if (not (and ispell-process
1574 (eq (process-status ispell-process
) 'run
)))
1576 (error "There is no ispell process running!"))
1577 (kill-process ispell-process
)
1578 (setq ispell-process nil
)
1579 (message "Ispell process killed")
1583 ;;; ispell-change-dictionary is set in some people's hooks. Maybe it should
1584 ;;; call ispell-init-process rather than wait for a spell checking command?
1587 (defun ispell-change-dictionary (dict &optional arg
)
1588 "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
1589 A new one will be started as soon as necessary.
1591 By just answering RET you can find out what the current dictionary is.
1593 With prefix argument, set the default directory."
1595 (list (completing-read
1596 "Use new dictionary (RET for current, SPC to complete): "
1597 (cons (cons "default" nil
) ispell-dictionary-alist
) nil t
)
1598 current-prefix-arg
))
1599 (if (equal dict
"default") (setq dict nil
))
1600 ;; This relies on completing-read's bug of returning "" for no match
1601 (cond ((equal dict
"")
1602 (message "Using %s dictionary"
1603 (or ispell-local-dictionary ispell-dictionary
"default")))
1604 ((and (equal dict ispell-dictionary
)
1605 (or (null ispell-local-dictionary
)
1606 (equal dict ispell-local-dictionary
)))
1607 ;; Specified dictionary is the default already. No-op
1608 (and (interactive-p)
1609 (message "No change, using %s dictionary" (or dict
"default"))))
1610 (t ; reset dictionary!
1611 (if (assoc dict ispell-dictionary-alist
)
1613 (if (or arg
(null dict
)) ; set default dictionary
1614 (setq ispell-dictionary dict
))
1615 (if (null arg
) ; set local dictionary
1616 (setq ispell-local-dictionary dict
)))
1617 (error "Illegal dictionary: %s" dict
))
1618 (ispell-kill-ispell t
)
1619 (message "(Next %sIspell command will use %s dictionary)"
1620 (cond ((equal ispell-local-dictionary ispell-dictionary
)
1624 (or (if (or (equal ispell-local-dictionary ispell-dictionary
)
1626 ispell-local-dictionary
1631 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
1634 (defun ispell-region (reg-start reg-end
)
1635 "Interactively check a region for spelling errors."
1636 (interactive "r") ; Don't flag errors on read-only bufs.
1637 (ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
1640 (message "Spell checking %s using %s dictionary..."
1641 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
1642 (buffer-name) "region")
1643 (or ispell-dictionary
"default"))
1644 ;; Returns cursor to original location.
1645 (save-window-excursion
1646 (goto-char reg-start
)
1647 (let ((transient-mark-mode nil
)
1649 (while (and (not ispell-quit
) (< (point) reg-end
))
1650 (let ((start (point))
1652 (end (save-excursion (end-of-line) (min (point) reg-end
)))
1653 (ispell-casechars (ispell-get-casechars))
1655 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
1656 ((eolp) ; END OF LINE, just go to next line.
1658 ((and (null ispell-check-comments
) ; SKIPPING COMMENTS
1659 comment-start
; skip comments that start on the line.
1660 (search-forward comment-start end t
)) ; or found here.
1661 (if (= (- (point) start
) (length comment-start
))
1662 ;; comment starts the line. Skip entire line or region
1663 (if (string= "" comment-end
) ; skip to next line
1664 (beginning-of-line 2) ; or jump to comment end.
1665 (search-forward comment-end reg-end
'limit
))
1666 ;; Comment later in line. Check spelling before comment.
1667 (let ((limit (- (point) (length comment-start
))))
1668 (goto-char (1- limit
))
1669 (if (looking-at "\\\\") ; "quoted" comment, don't skip
1670 ;; quoted comment. Skip over comment-start
1671 (if (= start
(1- limit
))
1672 (setq limit
(+ limit
(length comment-start
)))
1673 (setq limit
(1- limit
))))
1675 ;; Only check when "casechars" or math before comment
1676 (if (or (re-search-forward ispell-casechars limit t
)
1677 (re-search-forward "[][()$]" limit t
))
1679 (concat "^" (buffer-substring start limit
)
1681 offset-change
(- offset-change ispell-offset
)))
1682 (goto-char limit
))))
1683 ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
1685 ((or (and ispell-skip-tib
; SKIP TIB REFERENCES OR SGML MARKUP
1686 (re-search-forward ispell-tib-ref-beginning end t
)
1687 (setq ref-type
'tib
))
1688 (and ispell-skip-sgml
1689 (search-forward "[<&]" end t
)
1690 (setq ref-type
'sgml
)))
1691 (if (or (and (eq 'tib ref-type
) ; tib tag is 2 chars.
1692 (= (- (point) 2) start
))
1693 (and (eq 'sgml ref-type
) ; sgml skips 1 char.
1694 (= (- (point) 1) start
)))
1695 ;; Skip to end of reference, not necessarily on this line
1696 ;; Return an error if tib/sgml reference not found
1701 (re-search-forward ispell-tib-ref-end reg-end t
)))
1702 (and (eq 'sgml ref-type
)
1703 (not (search-forward "[>;]" reg-end t
))))
1705 (ispell-pdict-save ispell-silently-savep
)
1709 "Open tib or SGML command. Fix buffer or set "
1710 (if (eq 'tib ref-type
)
1714 ;; keep cursor at error location
1715 (setq ispell-quit
(- (point) 2))))
1716 ;; Check spelling between reference and start of the line.
1717 (let ((limit (- (point) (if (eq 'tib ref-type
) 2 1))))
1719 (if (or (re-search-forward ispell-casechars limit t
)
1720 (re-search-forward "[][()$]" limit t
))
1722 (concat "^" (buffer-substring start limit
)
1724 offset-change
(- offset-change ispell-offset
)))
1725 (goto-char limit
))))
1726 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
1727 (re-search-forward "[][()$]" end t
)) ; or MATH COMMANDS
1728 (setq string
(concat "^" (buffer-substring start end
) "\n")
1729 offset-change
(- offset-change ispell-offset
))
1731 (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
1733 (setq end
(point)) ; "end" tracks end of region to check.
1735 (if string
; there is something to spell!
1737 ;; send string to spell process and get input.
1738 (process-send-string ispell-process string
)
1740 (accept-process-output ispell-process
)
1741 ;; Last item of output contains a blank line.
1742 (not (string= "" (car ispell-filter
)))))
1743 ;; parse all inputs from the stream one word at a time.
1744 ;; Place in FIFO order and remove the blank item.
1745 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
1746 (while (and (not ispell-quit
) ispell-filter
)
1747 (setq poss
(ispell-parse-output (car ispell-filter
)))
1748 (if (listp poss
) ; spelling error occurred.
1749 (let* ((word-start (+ start offset-change
1751 (word-end (+ word-start
1752 (length (car poss
))))
1754 (goto-char word-start
)
1755 ;; Adjust the horizontal scroll & point
1756 (ispell-horiz-scroll)
1757 (goto-char word-end
)
1758 (ispell-horiz-scroll)
1759 (goto-char word-start
)
1760 (ispell-horiz-scroll)
1763 (search-forward (car poss
) word-end t
)
1765 ;; This occurs due to filter pipe problems
1767 (concat "Ispell misalignment: word "
1768 "`%s' point %d; please retry")
1769 (car poss
) word-start
))
1770 (if ispell-keep-choices-win
1772 (ispell-command-loop
1773 (car (cdr (cdr poss
)))
1774 (car (cdr (cdr (cdr poss
))))
1775 (car poss
) word-start word-end
))
1776 (save-window-excursion
1778 (ispell-command-loop
1779 (car (cdr (cdr poss
)))
1780 (car (cdr (cdr (cdr poss
))))
1781 (car poss
) word-start word-end
))))
1783 ((and replace
(listp replace
))
1784 ;; REPLACEMENT WORD entered. Recheck line
1785 ;; starting with the replacement word.
1786 (setq ispell-filter nil
1787 string
(buffer-substring word-start
1789 (let ((change (- (length (car replace
))
1790 (length (car poss
)))))
1792 (setq reg-end
(+ reg-end change
)
1793 offset-change
(+ offset-change
1795 (if (not (equal (car replace
) (car poss
)))
1797 (delete-region word-start word-end
)
1798 (insert (car replace
))))
1799 ;; I only need to recheck typed-in replacements
1800 (if (not (eq 'query-replace
1801 (car (cdr replace
))))
1802 (backward-char (length (car replace
))))
1803 (setq end
(point)) ; reposition for recheck
1804 ;; when second arg exists, query-replace, saving regions
1805 (if (car (cdr replace
))
1807 (save-window-excursion
1809 ispell-query-replace-marker reg-end
)
1810 ;; Assume case-replace &
1811 ;; case-fold-search correct?
1812 (query-replace string
(car replace
)
1816 ispell-query-replace-marker
))
1817 (set-marker ispell-query-replace-marker
1820 (equal 0 replace
)) ; ACCEPT/INSERT
1821 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
1823 (ispell-add-per-file-word-list
1824 (car poss
) reg-end
)))
1825 ;; This avoids pointing out the word that was
1826 ;; just accepted (via 'i' or 'a') if it follows
1827 ;; on the same line.
1828 ;; Redo check following the accepted word.
1829 (if (and ispell-pdict-modified-p
1830 (listp ispell-pdict-modified-p
))
1831 ;; Word accepted. Recheck line.
1832 (setq ispell-pdict-modified-p
; update flag
1833 (car ispell-pdict-modified-p
)
1834 ispell-filter nil
; discontinue check
1835 end word-start
))) ; reposition loc.
1836 (replace ; STRING REPLACEMENT for this word.
1837 (delete-region word-start word-end
)
1839 (let ((change (- (length replace
)
1840 (length (car poss
)))))
1841 (setq reg-end
(+ reg-end change
)
1842 offset-change
(+ offset-change change
)
1843 end
(+ end change
)))))
1844 (if (not ispell-quit
)
1846 (concat "Continuing spelling check using "
1847 (or ispell-dictionary
"default")
1850 ;; finished with line!
1851 (setq ispell-filter
(cdr ispell-filter
)))))
1855 (if (get-buffer ispell-choices-buffer
)
1856 (kill-buffer ispell-choices-buffer
))
1859 ;; preserve or clear the region for ispell-continue.
1860 (if (not (numberp ispell-quit
))
1861 (set-marker ispell-region-end nil
)
1862 ;; Enable ispell-continue.
1863 (set-marker ispell-region-end reg-end
)
1864 (goto-char ispell-quit
))
1865 ;; Check for aborting
1866 (if (and ispell-checking-message
(numberp ispell-quit
))
1868 (setq ispell-quit nil
)
1869 (error "Message send aborted.")))
1870 (setq ispell-quit nil
))
1871 (set-marker ispell-region-end nil
)
1872 ;; Only save if successful exit.
1873 (ispell-pdict-save ispell-silently-savep
)
1874 (message "Spell-checking done"))))
1879 (defun ispell-buffer ()
1880 "Check the current buffer for spelling errors interactively."
1882 (ispell-region (point-min) (point-max)))
1886 (defun ispell-continue ()
1888 "Continue a spelling session after making some changes."
1889 (if (not (marker-position ispell-region-end
))
1890 (message "No session to continue. Use 'X' command when checking!")
1891 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
1892 (message "Must continue ispell from buffer %s"
1893 (buffer-name (marker-buffer ispell-region-end
)))
1894 (ispell-region (point) (marker-position ispell-region-end
)))))
1897 ;;; Horizontal scrolling
1898 (defun ispell-horiz-scroll ()
1899 "Places point within the horizontal visibility of its window area."
1900 (if truncate-lines
; display truncating lines?
1901 ;; See if display needs to be scrolled.
1902 (let ((column (- (current-column) (max (window-hscroll) 1))))
1903 (if (and (< column
0) (> (window-hscroll) 0))
1904 (scroll-right (max (- column
) 10))
1905 (if (>= column
(- (window-width) 2))
1906 (scroll-left (max (- column
(window-width) -
3) 10)))))))
1909 ;;; Interactive word completion.
1910 ;;; Forces "previous-word" processing. Do we want to make this selectable?
1913 (defun ispell-complete-word (&optional interior-frag
)
1914 "Look up word before or under point in dictionary (see lookup-words command)
1915 and try to complete it. If optional INTERIOR-FRAG is non-nil then the word
1916 may be a character sequence inside of a word.
1918 Standard ispell choices are then available."
1920 (let ((cursor-location (point))
1922 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
1923 start end possibilities replacement
)
1924 (setq start
(car (cdr word
))
1925 end
(car (cdr (cdr word
)))
1928 (or (string= word
"") ; Will give you every word
1929 (lookup-words (concat (if interior-frag
"*") word
"*")
1930 ispell-complete-word-dict
)))
1931 (cond ((eq possibilities t
)
1932 (message "No word to complete"))
1933 ((null possibilities
)
1934 (message "No match for \"%s\"" word
))
1935 (t ; There is a modification...
1936 (cond ; Try and respect case of word.
1937 ((string-match "^[^A-Z]+$" word
)
1938 (setq possibilities
(mapcar 'downcase possibilities
)))
1939 ((string-match "^[^a-z]+$" word
)
1940 (setq possibilities
(mapcar 'upcase possibilities
)))
1941 ((string-match "^[A-Z]" word
)
1942 (setq possibilities
(mapcar 'capitalize possibilities
))))
1943 (save-window-excursion
1945 (ispell-command-loop possibilities nil word start end
)))
1947 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
1948 (ispell-add-per-file-word-list word
))
1949 (replacement ; REPLACEMENT WORD
1950 (delete-region start end
)
1951 (setq word
(if (atom replacement
) replacement
(car replacement
))
1952 cursor-location
(+ (- (length word
) (- end start
))
1955 (if (not (atom replacement
)) ; recheck spelling of replacement.
1957 (goto-char cursor-location
)
1958 (ispell-word nil t
)))))
1959 (if (get-buffer ispell-choices-buffer
)
1960 (kill-buffer ispell-choices-buffer
))))
1961 (ispell-pdict-save ispell-silently-savep
)
1962 (goto-char cursor-location
)))
1966 (defun ispell-complete-word-interior-frag ()
1967 "Completes word matching character sequence inside a word."
1969 (ispell-complete-word t
))
1972 ;;; **********************************************************************
1973 ;;; Ispell Minor Mode
1974 ;;; **********************************************************************
1976 (defvar ispell-minor-mode nil
1977 "Non-nil if Ispell minor mode is enabled.")
1978 ;; Variable indicating that ispell minor mode is active.
1979 (make-variable-buffer-local 'ispell-minor-mode
)
1981 (or (assq 'ispell-minor-mode minor-mode-alist
)
1982 (setq minor-mode-alist
1983 (cons '(ispell-minor-mode " Spell") minor-mode-alist
)))
1985 (defvar ispell-minor-keymap
1986 (let ((map (make-sparse-keymap)))
1987 (define-key map
" " 'ispell-minor-check
)
1988 (define-key map
"\r" 'ispell-minor-check
)
1990 "Keymap used for Ispell minor mode.")
1992 (or (not (boundp 'minor-mode-map-alist
))
1993 (assoc 'ispell-minor-mode minor-mode-map-alist
)
1994 (setq minor-mode-map-alist
1995 (cons (cons 'ispell-minor-mode ispell-minor-keymap
)
1996 minor-mode-map-alist
)))
1999 (defun ispell-minor-mode (&optional arg
)
2000 "Toggle Ispell minor mode.
2001 With prefix arg, turn Ispell minor mode on iff arg is positive.
2003 In Ispell minor mode, pressing SPC or RET
2004 warns you if the previous word is incorrectly spelled."
2006 (setq ispell-minor-mode
2007 (not (or (and (null arg
) ispell-minor-mode
)
2008 (<= (prefix-numeric-value arg
) 0))))
2009 (set-buffer-modified-p (buffer-modified-p)))
2011 (defun ispell-minor-check ()
2012 ;; Check previous word then continue with the normal binding of this key.
2014 (let ((ispell-minor-mode nil
)
2015 (ispell-check-only t
))
2017 (narrow-to-region (point-min) (point))
2018 (ispell-word nil t
))
2019 (call-interactively (key-binding (this-command-keys)))))
2022 ;;; **********************************************************************
2024 ;;; **********************************************************************
2025 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2028 (defvar ispell-message-text-end
2029 (mapconcat (function identity
)
2031 ;; Matches postscript files.
2032 "^%!PS-Adobe-[23].0"
2033 ;; Matches uuencoded text
2034 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2035 ;; Matches shell files (esp. auto-decoding)
2037 ;; Matches context difference listing
2038 "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2039 ;; Matches "----------------- cut here"
2040 "^[-=_]+\\s ?cut here")
2042 "*End of text which will be checked in ispell-message.
2043 If it is a string, limit at first occurrence of that regular expression.
2044 Otherwise, it must be a function which is called to get the limit.")
2048 (defun ispell-message ()
2049 "Check the spelling of a mail message or news post.
2050 Don't check spelling of message headers except the Subject field.
2051 Don't check included messages.
2053 To abort spell checking of a message REGION and send the message anyway,
2054 use the `x' or `q' command. (Any subsequent regions will be checked.)
2055 The `X' command aborts the message send so that you can edit the buffer.
2057 To spell-check whenever a message is sent, include the appropriate lines
2058 in your .emacs file:
2059 (add-hook 'news-inews-hook 'ispell-message)
2060 (add-hook 'mail-send-hook 'ispell-message)
2061 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2063 You can bind this to the key C-c i in GNUS or mail by adding to
2064 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2065 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
2068 (goto-char (point-min))
2069 (let* ((internal-messagep (save-excursion
2072 (regexp-quote mail-header-separator
)
2077 ((not ispell-message-text-end
) (point-max))
2078 ((char-or-string-p ispell-message-text-end
)
2079 (if (re-search-forward ispell-message-text-end nil t
)
2082 (t (min (point-max) (funcall ispell-message-text-end
))))))
2083 (cite-regexp ;Prefix of inserted text
2085 ((featurep 'supercite
) ; sc 3.0
2086 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
2087 (ispell-non-empty-string sc-reference-tag-string
)))
2088 ((featurep 'sc
) ; sc 2.3
2089 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
2090 (ispell-non-empty-string sc-reference-tag-string
)))
2091 ((equal major-mode
'news-reply-mode
) ;GNUS
2092 (concat "In article <" "\\|"
2093 (if mail-yank-prefix
2094 (ispell-non-empty-string mail-yank-prefix
)
2096 ((equal major-mode
'mh-letter-mode
) ; mh mail message
2097 (ispell-non-empty-string mh-ins-buf-prefix
))
2098 ((not internal-messagep
) ; Assume n sent us this message.
2099 (concat "In [a-zA-Z.]+ you write:" "\\|"
2100 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
2102 ((boundp 'vm-included-text-prefix
) ; VM mail message
2103 (concat "[^,;&+=]+ writes:" "\\|"
2104 (ispell-non-empty-string vm-included-text-prefix
)))
2105 (mail-yank-prefix ; vanilla mail message.
2106 (ispell-non-empty-string mail-yank-prefix
))
2108 (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp
))
2109 (cite-regexp-end (concat "^\\(" cite-regexp
"\\)"))
2110 (old-case-fold-search case-fold-search
)
2111 (case-fold-search t
)
2112 (ispell-checking-message t
))
2113 (goto-char (point-min))
2114 ;; Skip header fields except Subject: without Re:'s
2115 ;;(search-forward mail-header-separator nil t)
2116 (while (if internal-messagep
2117 (< (point) internal-messagep
)
2118 (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
2120 (if (looking-at "Subject: *") ; Spell check new subject fields
2122 (goto-char (match-end 0))
2123 (if (and (not (looking-at ".*Re\\>"))
2124 (not (looking-at "\\[")))
2125 (let ((case-fold-search old-case-fold-search
))
2126 (ispell-region (point)
2129 (while (looking-at "\n[ \t]")
2133 (setq case-fold-search nil
)
2134 ;; Skip mail header, particularly for non-english languages.
2135 (if (looking-at mail-header-separator
)
2137 (while (< (point) limit
)
2138 ;; Skip across text cited from other messages.
2139 (while (and (looking-at cite-regexp-start
)
2141 (zerop (forward-line 1))))
2143 (if (< (point) limit
)
2144 (let* ((start (point))
2145 ;; Check the next batch of lines that *aren't* cited.
2146 (end-c (and (re-search-forward cite-regexp-end limit
'end
)
2147 (match-beginning 0)))
2148 ;; skip a forwarded message
2149 (end-fwd (and (goto-char start
)
2150 (re-search-forward "---* Forwarded Message"
2152 (end (or (and end-c end-fwd
(min end-c end-fwd
))
2154 ;; defalut to limit of text.
2155 (marker-position limit
))))
2157 (ispell-region start end
)
2158 (if (and end-fwd
(= end end-fwd
))
2161 (search-forward "--- End of Forwarded Message" limit
'end
))
2163 (set-marker limit nil
))))
2166 (defun ispell-non-empty-string (string)
2167 (if (or (not string
) (string-equal string
""))
2168 "\\'\\`" ; An unmatchable string if string is null.
2169 (regexp-quote string
)))
2172 ;;; **********************************************************************
2173 ;;; Buffer Local Functions
2174 ;;; **********************************************************************
2177 (defun ispell-accept-buffer-local-defs ()
2178 "Load all buffer-local information, restarting ispell when necessary."
2179 (ispell-buffer-local-dict) ; May kill ispell-process.
2180 (ispell-buffer-local-words) ; Will initialize ispell-process.
2181 (ispell-buffer-local-parsing))
2184 (defun ispell-buffer-local-parsing ()
2185 "Place Ispell into parsing mode for this buffer.
2186 Overrides the default parsing mode.
2187 Includes latex/nroff modes and extended character mode."
2188 ;; (ispell-init-process) must already be called.
2189 (process-send-string ispell-process
"!\n") ; Put process in terse mode.
2190 ;; We assume all major modes with "tex-mode" in them should use latex parsing
2191 (if (or (and (eq ispell-parser
'use-mode-name
)
2192 (string-match "[Tt][Ee][Xx]-mode" (symbol-name major-mode
)))
2193 (eq ispell-parser
'tex
))
2194 (process-send-string ispell-process
"+\n") ; set ispell mode to tex
2195 (process-send-string ispell-process
"-\n")) ; set mode to normal (nroff)
2196 ;; Hard-wire test for SGML mode.
2197 (setq ispell-skip-sgml
(eq 'sgml-mode major-mode
))
2198 ;; Set default extended character mode for given buffer, if any.
2199 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2200 (if extended-char-mode
2201 (process-send-string ispell-process
(concat extended-char-mode
"\n"))))
2202 ;; Set buffer-local parsing mode and extended character mode, if specified.
2204 (goto-char (point-min))
2205 ;; Uses last valid definition
2206 (while (search-forward ispell-parsing-keyword nil t
)
2207 (let ((end (save-excursion (end-of-line) (point)))
2208 (case-fold-search t
)
2210 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
2211 ;; space separated definitions.
2212 (setq string
(buffer-substring (match-beginning 1) (match-end 1)))
2213 (cond ((string-match "latex-mode" string
)
2214 (process-send-string ispell-process
"+\n~tex\n"))
2215 ((string-match "nroff-mode" string
)
2216 (process-send-string ispell-process
"-\n~nroff"))
2217 ((string-match "~" string
) ; Set extended character mode.
2218 (process-send-string ispell-process
(concat string
"\n")))
2219 (t (message "Illegal Ispell Parsing argument!")
2223 ;;; Can kill the current ispell process
2225 (defun ispell-buffer-local-dict ()
2226 "Initializes local dictionary.
2227 When a dictionary is defined in the buffer (see variable
2228 `ispell-dictionary-keyword'), it will override the local setting
2229 from \\[ispell-change-dictionary].
2230 Both should not be used to define a buffer-local dictionary."
2232 (goto-char (point-min))
2234 ;; Override the local variable definition.
2235 ;; Uses last valid definition.
2236 (while (search-forward ispell-dictionary-keyword nil t
)
2237 (setq end
(save-excursion (end-of-line) (point)))
2238 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
2239 (setq ispell-local-dictionary
2240 (buffer-substring (match-beginning 1) (match-end 1)))))
2241 (goto-char (point-min))
2242 (while (search-forward ispell-pdict-keyword nil t
)
2243 (setq end
(save-excursion (end-of-line) (point)))
2244 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
2245 (setq ispell-local-pdict
2246 (buffer-substring (match-beginning 1) (match-end 1)))))))
2247 ;; Reload if new personal dictionary defined.
2248 (if (and ispell-local-pdict
2249 (not (equal ispell-local-pdict ispell-personal-dictionary
)))
2251 (ispell-kill-ispell t
)
2252 (setq ispell-personal-dictionary ispell-local-pdict
)))
2253 ;; Reload if new dictionary defined.
2254 (if (and ispell-local-dictionary
2255 (not (equal ispell-local-dictionary ispell-dictionary
)))
2256 (ispell-change-dictionary ispell-local-dictionary
)))
2259 (defun ispell-buffer-local-words ()
2260 "Loads the buffer-local dictionary in the current buffer."
2261 (if (and ispell-buffer-local-name
2262 (not (equal ispell-buffer-local-name
(buffer-name))))
2264 (ispell-kill-ispell t
)
2265 (setq ispell-buffer-local-name nil
)))
2266 (ispell-init-process)
2268 (goto-char (point-min))
2269 (while (search-forward ispell-words-keyword nil t
)
2270 (or ispell-buffer-local-name
2271 (setq ispell-buffer-local-name
(buffer-name)))
2272 (let ((end (save-excursion (end-of-line) (point)))
2274 ;; buffer-local words separated by a space, and can contain
2275 ;; any character other than a space.
2276 (while (re-search-forward " *\\([^ ]+\\)" end t
)
2277 (setq string
(buffer-substring (match-beginning 1) (match-end 1)))
2278 (process-send-string ispell-process
(concat "@" string
"\n")))))))
2281 ;;; returns optionally adjusted region-end-point.
2283 (defun ispell-add-per-file-word-list (word &optional reg-end
)
2284 "Adds new word to the per-file word list."
2285 (or ispell-buffer-local-name
2286 (setq ispell-buffer-local-name
(buffer-name)))
2290 (goto-char (point-min))
2291 (let (case-fold-search line-okay search done string
)
2293 (setq search
(search-forward ispell-words-keyword nil
'move
)
2294 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
2295 (progn (end-of-line) (current-column)))
2297 (if (or (and search line-okay
)
2304 (setq string
(concat comment-start
" "
2305 ispell-words-keyword
))
2306 ;; in case the keyword is in the middle of the file....
2307 (if (> reg-end
(point))
2308 (setq reg-end
(+ reg-end
(length string
))))
2310 (if (and comment-end
(not (equal "" comment-end
)))
2314 (insert comment-end
)))))
2315 (if (> reg-end
(point))
2316 (setq reg-end
(+ 1 reg-end
(length word
))))
2317 (insert (concat " " word
)))))))
2321 (defconst ispell-version
"2.36 -- Mon Feb 6 17:39:38 EST 1995")
2326 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
2328 ;;; Local Variable options:
2329 ;;; mode: name(-mode)
2330 ;;; eval: expression
2331 ;;; local-variable: value
2333 ;;; The following sets the buffer local dictionary to english!
2335 ;;; Local Variables:
2336 ;;; mode: emacs-lisp
2337 ;;; comment-column: 40
2338 ;;; ispell-local-dictionary: "english"
2342 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
2344 ;;; The following places this file in nroff parsing and extended char modes.
2345 ;;; Local IspellParsing: nroff-mode ~nroff
2346 ;;; Change IspellDict to IspellDict: to enable the following line.
2347 ;;; Local IspellDict english
2348 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
2349 ;;; Local IspellPersDict ~/.ispell_lisp
2350 ;;; The following were automatically generated by ispell using the 'A' command:
2351 ; LocalWords: ispell ispell-highlight-p ispell-check-comments query-replace
2352 ; LocalWords: ispell-query-replace-choices ispell-skip-tib non-nil tib
2353 ; LocalWords: regexps ispell-tib-ref-beginning ispell-tib-ref-end
2355 ;; ispell.el ends here