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 <k.stevens@ieee.org>
9 ;;; Last Modified On: Thu Dec 8 13:17:41 EST 1994
10 ;;; Update Revision : 2.34
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.34 1994/12/08 13:17:41 stevens
133 ;;; Interaction corrected to function with all 3.1 ispell versions.
135 ;;; Revision 2.33 1994/11/24 02:31:20 stevens
136 ;;; Repaired bug introduced in 2.32 that corrupts buffers when correcting.
137 ;;; Improved buffer scrolling. Nondestructive buffer selections allowed.
139 ;;; Revision 2.32 1994/10/31 21:10:08 geoff
140 ;;; Many revisions accepted from RMS/FSF. I think (though I don't know) that
141 ;;; this represents an 'official' version.
143 ;;; Revision 2.31 1994/5/31 10:18:17 stevens
144 ;;; Repaired comments. buffer-local commands executed in `ispell-word' now.
145 ;;; German dictionary described for extended character mode. Dict messages.
147 ;;; Revision 2.30 1994/5/20 22:18:36 stevens
148 ;;; Continue ispell from ispell-word, C-z functionality fixed.
150 ;;; Revision 2.29 1994/5/12 09:44:33 stevens
151 ;;; Restored ispell-use-ptys-p, ispell-message aborts sends with interrupt.
152 ;;; defined fn ispell
154 ;;; Revision 2.28 1994/4/28 16:24:40 stevens
155 ;;; Window checking when ispell-message put on gnus-inews-article-hook jwz.
156 ;;; prefixed ispell- to highlight functions and horiz-scroll fn.
157 ;;; Try and respect case of word in ispell-complete-word.
158 ;;; Ignore non-char events. Ispell-use-ptys-p commented out. Lucid menu.
159 ;;; Better interrupt handling. ispell-message improvements from Ethan.
162 ;;; version 18 explicit C-g handling disabled as it didn't work. Added
163 ;;; ispell-extra-args for ispell customization (jwz)
165 ;;; Revision 2.26 1994/2/15 16:11:14 stevens
166 ;;; name changes for copyright assignment. Added word-frags in complete-word.
167 ;;; Horizontal scroll (John Conover). Query-replace matches words now. bugs.
170 ;;; minor mods, upgraded ispell-message
173 ;;; query-replace more robust, messages, defaults, ispell-change-dict.
175 ;;; Revision 2.23 1993/11/22 23:47:03 stevens
176 ;;; ispell-message, Fixed highlighting, added menu-bar, fixed ispell-help, ...
179 ;;; Added 'u' command. Fixed default in ispell-local-dictionary.
180 ;;; fixed affix rules display. Tib skipping more robust. Contributions by
181 ;;; Per Abraham (parser selection), Denis Howe, and Eberhard Mattes.
183 ;;; Revision 2.21 1993/06/30 14:09:04 stevens
184 ;;; minor bugs. (nroff word skipping fixed)
186 ;;; Revision 2.20 1993/06/30 14:09:04 stevens
188 ;;; Debugging and contributions by: Boris Aronov, Rik Faith, Chris Moore,
189 ;;; Kevin Rodgers, Malcolm Davis.
190 ;;; Particular thanks to Michael Lipp, Jamie Zawinski, Phil Queinnec
191 ;;; and John Heidemann for suggestions and code.
192 ;;; Major update including many tweaks.
193 ;;; Many changes were integrations of suggestions.
194 ;;; lookup-words rehacked to use call-process (Jamie).
195 ;;; ispell-complete-word rehacked to be compatible with the rest of the
196 ;;; system for word searching and to include multiple wildcards,
197 ;;; and it's own dictionary.
198 ;;; query-replace capability added. New options 'X', 'R', and 'A'.
199 ;;; buffer-local modes for dictionary, word-spelling, and formatter-parsing.
200 ;;; Many random bugs, like commented comments being skipped, fix to
201 ;;; keep-choices-win, fix for math mode, added pipe mode choice,
202 ;;; fixed 'q' command, ispell-word checks previous word and leave cursor
203 ;;; in same location. Fixed tib code which could drop spelling regions.
204 ;;; Cleaned up setq calls for efficiency. Gave more context on window overlays.
205 ;;; Assure context on ispell-command-loop. Window lossage in look cmd fixed.
206 ;;; Due to pervasive opinion, common-lisp package syntax removed. Display
207 ;;; problem when not highlighting.
209 ;;; Revision 2.19 1992/01/10 10:54:08 geoff
210 ;;; Make another attempt at fixing the "Bogus, dude" problem. This one is
211 ;;; less elegant, but has the advantage of working.
213 ;;; Revision 2.18 1992/01/07 10:04:52 geoff
214 ;;; Fix the "Bogus, Dude" problem in ispell-word.
216 ;;; Revision 2.17 1991/09/12 00:01:42 geoff
217 ;;; Add some changes to make ispell-complete-word work better, though
218 ;;; still not perfectly.
220 ;;; Revision 2.16 91/09/04 18:00:52 geoff
221 ;;; More updates from Sebastian, to make the multiple-dictionary support
224 ;;; Revision 2.15 91/09/04 17:30:02 geoff
225 ;;; Sebastian Kremer's tib support
227 ;;; Revision 2.14 91/09/04 16:19:37 geoff
228 ;;; Don't do set-window-start if the move-to-window-line moved us
229 ;;; downward, rather than upward. This prevents getting the buffer all
230 ;;; confused. Also, don't use the "not-modified" function to clear the
231 ;;; modification flag; instead use set-buffer-modified-p. This prevents
232 ;;; extra messages from flashing.
234 ;;; Revision 2.13 91/09/04 14:35:41 geoff
235 ;;; Fix a spelling error in a comment. Add code to handshake with the
236 ;;; ispell process before sending anything to it.
238 ;;; Revision 2.12 91/09/03 20:14:21 geoff
239 ;;; Add Sebastian Kremer's multiple-language support.
243 ;;; Texas Instruments - Computer Science Center
244 ;;; ARPA: Buehring%TI-CSL@CSNet-Relay
245 ;;; UUCP: {smu, texsun, im4u, rice} ! ti-csl ! buehring
247 ;;; ispell-region and associated routines added by
250 ;;; Tue Jan 13 20:18:02 CST 1987
252 ;;; extensively modified by Mark Davies and Andrew Vignaux
253 ;;; {mark,andrew}@vuwcomp
254 ;;; Sun May 10 11:45:04 NZST 1987
256 ;;; Ken Stevens ARPA: k.stevens@ieee.org
257 ;;; Tue Jan 3 16:59:07 PST 1989
258 ;;; This file has overgone a major overhaul to be compatible with ispell
259 ;;; version 2.1. Most of the functions have been totally rewritten, and
260 ;;; many user-accessible variables have been added. The syntax table has
261 ;;; been removed since it didn't work properly anyway, and a filter is
262 ;;; used rather than a buffer. Regular expressions are used based on
263 ;;; ispell's internal definition of characters (see ispell(4)).
264 ;;; Some new updates:
265 ;;; - Updated to version 3.0 to include terse processing.
266 ;;; - Added a variable for the look command.
267 ;;; - Fixed a bug in ispell-word when cursor is far away from the word
268 ;;; that is to be checked.
269 ;;; - Ispell places the incorrect word or guess in the minibuffer now.
270 ;;; - fixed a bug with 'l' option when multiple windows are on the screen.
271 ;;; - lookup-words just didn't work with the process filter. Fixed.
272 ;;; - Rewrote the process filter to make it cleaner and more robust
273 ;;; in the event of a continued line not being completed.
274 ;;; - Made ispell-init-process more robust in handling errors.
275 ;;; - Fixed bug in continuation location after a region has been modified by
276 ;;; correcting a misspelling.
279 ;;; Sebastian Kremer <sk@thp.uni-koeln.de>
280 ;;; Wed Aug 7 14:02:17 MET DST 1991
281 ;;; - Ported ispell-complete-word from Ispell 2 to Ispell 3.
282 ;;; - Added ispell-kill-ispell command.
283 ;;; - Added ispell-dictionary and ispell-dictionary-alist variables to
284 ;;; support other than default language. See their docstrings and
285 ;;; command ispell-change-dictionary.
286 ;;; - (ispelled it :-)
287 ;;; - Added ispell-skip-tib variable to support the tib bibliography
291 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
295 ;;; **********************************************************************
296 ;;; The following variables should be set according to personal preference
297 ;;; and location of binaries:
298 ;;; **********************************************************************
301 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1
304 (defvar ispell-highlight-p t
305 "*Highlight spelling errors when non-nil.")
307 (defvar ispell-highlight-face
'highlight
308 "*The face used for Ispell highlighting. For Emacses with overlays.
309 Possible values are `highlight', `modeline', `secondary-selection',
310 `region', and `underline'.
311 This variable can be set by the user to whatever face they desire.
312 It's most convenient if the cursor color and highlight color are
313 slightly different.")
315 (defvar ispell-check-comments nil
316 "*Spelling of comments checked when non-nil.")
318 (defvar ispell-query-replace-choices nil
319 "*Corrections made throughout region when non-nil.
320 Uses `query-replace' (\\[query-replace]) for corrections.")
322 (defvar ispell-skip-tib nil
323 "*Does not spell check `tib' bibliography references when non-nil.
324 Skips any text between strings matching regular expressions
325 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
327 TeX users beware: Any field starting with [. will skip until a .] -- even
328 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
329 a [.5mm] type of number....")
331 (defvar ispell-tib-ref-beginning
"[[<]\\."
332 "Regexp matching the beginning of a Tib reference.")
334 (defvar ispell-tib-ref-end
"\\.[]>]"
335 "Regexp matching the end of a Tib reference.")
337 (defvar ispell-keep-choices-win t
338 "*When not nil, the `*Choices*' window remains for spelling session.
339 This minimizes redisplay thrashing.")
341 (defvar ispell-choices-win-default-height
2
342 "*The default size of the `*Choices*' window, including status line.
343 Must be greater than 1.")
345 (defvar ispell-program-name
"ispell"
346 "Program invoked by \\[ispell-word] and \\[ispell-region] commands.")
348 (defvar ispell-alternate-dictionary
349 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
350 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
351 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
352 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
353 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
354 ((file-exists-p "/sys/dict") "/sys/dict")
355 (t "/usr/dict/words"))
356 "*Alternate dictionary for spelling help.")
358 (defvar ispell-complete-word-dict ispell-alternate-dictionary
359 "*Dictionary used for word completion.")
361 (defvar ispell-grep-command
"egrep"
362 "Name of the grep command for search processes.")
364 (defvar ispell-grep-options
"-i"
365 "String of options to use when running the program in `ispell-grep-command'.
366 Should probably be \"-i\" or \"-e\".
367 Some machines (like the NeXT) don't support \"-i\"")
369 (defvar ispell-look-command
"look"
370 "Name of the look command for search processes.
371 This must be an absolute file name.")
373 (defvar ispell-look-p
(file-exists-p ispell-look-command
)
374 "*Non-nil means use `look' rather than `grep'.
375 Default is based on whether `look' seems to be available.")
377 (defvar ispell-have-new-look nil
378 "*Non-nil means use the `-r' option (regexp) when running `look'.")
380 (defvar ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
381 "String of command options for `ispell-look-command'.")
383 (defvar ispell-use-ptys-p nil
384 "When non-nil, Emacs uses ptys to communicate with Ispell.
385 When nil, Emacs uses pipes.")
387 (defvar ispell-following-word nil
388 "*Non-nil means `ispell-word' checks the word around or after point.
389 Otherwise `ispell-word' checks the preceding word.")
391 (defvar ispell-help-in-bufferp nil
392 "*Non-nil means display interactive keymap help in a buffer.
393 Otherwise use the minibuffer.")
395 (defvar ispell-quietly nil
396 "*Non-nil means suppress messages in `ispell-word'.")
398 (defvar ispell-format-word
(function upcase
)
399 "*Formatting function for displaying word being spell checked.
400 The function must take one string argument and return a string.")
402 (defvar ispell-personal-dictionary nil
403 "*File name of your personal spelling dictionary, or nil.
404 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
405 where DICTNAME is the name of your default dictionary.")
407 (defvar ispell-silently-savep nil
408 "*When non-nil, save the personal dictionary without confirmation.")
410 ;;; This variable contains the current dictionary being used if the ispell
411 ;;; process is running. Otherwise it contains the global default.
412 (defvar ispell-dictionary nil
413 "If non-nil, a dictionary to use instead of the default one.
414 This is passed to the ispell process using the `-d' switch and is
415 used as key in `ispell-dictionary-alist' (which see).
417 You should set this variable before your first use of Emacs spell-checking
418 commands in the Emacs session, or else use the \\[ispell-change-dictionary]
419 command to change it. Otherwise, this variable only takes effect in a newly
420 started Ispell process.")
422 (defvar ispell-extra-args nil
423 "*If non-nil, a list of extra switches to pass to the Ispell program.
424 For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
425 words as correct. See also `ispell-dictionary-alist', which may be used
426 for language-specific arguments.")
429 (defvar ispell-dictionary-alist-1
; sk 9-Aug-1991 18:28
430 '((nil ; default (english.aff)
431 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil
)
432 ("english" ; make english explicitly selectable
433 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil
)
434 ("british" ; british version
435 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B" "-d" "british") nil
)
436 ("deutsch" ; deutsch.aff
437 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex")
439 "[a-zA-Z\304\326\334\344\366\337\374]"
440 "[^a-zA-Z\304\326\334\344\366\337\374]"
441 "[']" t
("-C" "-d" "deutsch") "~latin1")
442 ("nederlands" ; nederlands.aff
443 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
444 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
446 ("nederlands8" ; dutch8.aff
447 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
448 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
449 "[']" t
("-C") nil
)))
452 (defvar ispell-dictionary-alist-2
453 '(("svenska" ;7 bit swedish mode
454 "[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
455 "[']" nil
("-C") nil
)
456 ("svenska8" ;8 bit swedish mode
457 "[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
458 "[']" nil
("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
460 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil
)
461 ("francais" ; francais.aff
462 "[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]"
463 "[^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]"
464 "[---']" t nil
"~list")
465 ("francais-tex" ; francais.aff
466 "[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\\]"
467 "[^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\\]"
468 "[---'^`\"]" t nil
"~tex")
470 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
475 ;;; ispell-dictionary-alist is set up from two subvariables above
476 ;;; to avoid having very long lines in loaddefs.el.
478 (defvar ispell-dictionary-alist
479 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2
)
480 "An alist of dictionaries and their associated parameters.
482 Each element of this list is also a list:
484 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
485 ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
487 DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
488 means the default dictionary.
490 CASECHARS is a regular expression of valid characters that comprise a
493 NOT-CASECHARS is the opposite regexp of CASECHARS.
495 OTHERCHARS is a regular expression of other characters that are valid
496 in word constructs. Otherchars cannot be adjacent to each other in a
497 word, nor can they begin or end a word. This implies we can't check
498 \"Stevens'\" as a correct possessive and other correct formations.
500 Hint: regexp syntax requires the hyphen to be declared first here.
502 MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed in a
503 word instead of only one.
505 ISPELL-ARGS is a list of additional arguments passed to the ispell
508 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
509 have been configured in an Ispell affix file. (For example, umlauts
510 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
511 in English. This has the same effect as the command-line `-T' option.
512 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
513 but the dictionary can control the extended character mode.
514 Both defaults can be overruled in a buffer-local fashion. See
515 `ispell-parsing-keyword' for details on this.
517 Note that the CASECHARS and OTHERCHARS slots of the alist should
518 contain the same character set as casechars and otherchars in the
519 language.aff file \(e.g., english.aff\).")
523 (defvar ispell-menu-map nil
"Key map for ispell menu")
526 (defvar ispell-menu-lucid nil
"Spelling menu for Lucid Emacs.")
528 ;;; Break out lucid menu and split into several calls to avoid having
529 ;;; long lines in loaddefs.el. Detect need off following constant.
532 (defconst ispell-menu-map-needed
; make sure this is not Lucid Emacs
533 (and (not ispell-menu-map
)
534 ;; make sure this isn't Lucid Emacs
535 (featurep 'menu-bar
) (string-lessp "19" emacs-version
)))
540 (if ispell-menu-map-needed
541 (let ((dicts (reverse (cons (cons "default" nil
) ispell-dictionary-alist
)))
543 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
544 ;; add the dictionaries to the bottom of the list.
546 (setq name
(car (car dicts
))
549 (define-key ispell-menu-map
(vector (intern name
))
550 (cons (concat "Select " (capitalize name
))
551 (list 'lambda
() '(interactive)
552 (list 'ispell-change-dictionary name
))))))))
554 ;;; define commands in menu in opposite order you want them to appear.
556 (if ispell-menu-map-needed
558 (define-key ispell-menu-map
[ispell-change-dictionary
]
559 '("Change Dictionary" . ispell-change-dictionary
))
560 (define-key ispell-menu-map
[ispell-kill-ispell
]
561 '("Kill Process" . ispell-kill-ispell
))
562 (define-key ispell-menu-map
[ispell-pdict-save
]
563 '("Save Dictionary" .
(lambda () (interactive) (ispell-pdict-save t
))))
564 (define-key ispell-menu-map
[ispell-complete-word
]
565 '("Complete Word" . ispell-complete-word
))
566 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
567 '("Complete Word Frag" . ispell-complete-word-interior-frag
))))
570 (if ispell-menu-map-needed
572 (define-key ispell-menu-map
[ispell-continue
]
573 '("Continue Check" . ispell-continue
))
574 (define-key ispell-menu-map
[ispell-word
]
575 '("Check Word" . ispell-word
))
576 (define-key ispell-menu-map
[ispell-region
]
577 '("Check Region" . ispell-region
))
578 (define-key ispell-menu-map
[ispell-buffer
]
579 '("Check Buffer" . ispell-buffer
))))
582 (if ispell-menu-map-needed
584 (define-key ispell-menu-map
[ispell-message
]
585 '("Check Message" . ispell-message
))
586 (define-key ispell-menu-map
[ispell-help
]
587 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
588 '("Help" .
(lambda () (interactive) (describe-function 'ispell-help
))))
589 (put 'ispell-region
'menu-enable
'mark-active
)
590 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
592 ;;; Xemacs version 19
593 (if (and (string-lessp "19" emacs-version
)
594 (string-match "Lucid" emacs-version
))
595 (let ((dicts (cons (cons "default" nil
) ispell-dictionary-alist
))
596 (current-menubar (or current-menubar default-menubar
))
598 '(["Help" (describe-function 'ispell-help
) t
]
599 ;;["Help" (popup-menu ispell-help-list) t]
600 ["Check Message" ispell-message t
]
601 ["Check Buffer" ispell-buffer t
]
602 ["Check Word" ispell-word t
]
603 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
604 ["Continue Check" ispell-continue t
]
605 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
606 ["Complete Word" ispell-complete-word t
]
607 ["Kill Process" ispell-kill-ispell t
]
609 ["Save Dictionary" (ispell-pdict-save t
) t
]
610 ["Change Dictionary" ispell-change-dictionary t
]))
613 (setq name
(car (car dicts
))
616 (setq menu
(append menu
618 (vector (concat "Select " (capitalize name
))
619 (list 'ispell-change-dictionary name
)
621 (setq ispell-menu-lucid menu
)
624 (delete-menu-item '("Edit" "Spell")) ; in case already defined
625 (add-menu '("Edit") "Spell" ispell-menu-lucid
)))))
628 ;;; **********************************************************************
629 ;;; The following are used by ispell, and should not be changed.
630 ;;; **********************************************************************
633 ;;; The version must be 3.1 or greater for this version of ispell.el
634 ;;; There is an incompatibility between versin 3.1.12 and lower versions.
635 (defconst ispell-required-version
'("3.1." 12)
636 "Ispell versions with which this version of ispell.el is known to work.")
637 (defvar ispell-offset
1
638 "Offset that maps protocol differences between ispell 3.1 versions.")
640 (defun ispell-get-casechars ()
641 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist
)))
642 (defun ispell-get-not-casechars ()
643 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist
)))
644 (defun ispell-get-otherchars ()
645 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist
)))
646 (defun ispell-get-many-otherchars-p ()
647 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist
)))
648 (defun ispell-get-ispell-args ()
649 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist
)))
650 (defun ispell-get-extended-character-mode ()
651 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist
)))
653 (defvar ispell-process nil
654 "The process object for Ispell.")
656 (defvar ispell-pdict-modified-p nil
657 "Non-nil means personal dictionary has modifications to be saved.")
659 ;;; If you want to save the dictionary when quitting, must do so explicitly.
660 ;;; When non-nil, the spell session is terminated.
661 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
662 (defvar ispell-quit nil
)
664 (defvar ispell-filter nil
665 "Output filter from piped calls to Ispell.")
667 (defvar ispell-filter-continue nil
668 "Control variable for Ispell filter function.")
670 (defvar ispell-process-directory nil
671 "The directory where `ispell-process' was started.")
673 (defvar ispell-query-replace-marker
(make-marker)
674 "Marker for `query-replace' processing.")
676 (defvar ispell-checking-message nil
677 "Non-nil when we're checking a mail message")
679 (defconst ispell-choices-buffer
"*Choices*")
681 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
683 ;;; *** Buffer Local Definitions ***
685 ;;; This is the local dictionary to use. When nil the default dictionary will
686 ;;; be used. Do not redefine default value or it will override the global!
687 (defvar ispell-local-dictionary nil
688 "If non-nil, a dictionary to use for Ispell commands in this buffer.
689 The value must be a string dictionary name in `ispell-dictionary-alist'.
690 This variable becomes buffer-local when set in any fashion.
692 Setting ispell-local-dictionary to a value has the same effect as
693 calling \\[ispell-change-dictionary] with that value. This variable
694 is automatically set when defined in the file with either
695 `ispell-dictionary-keyword' or the Local Variable syntax.")
697 (make-variable-buffer-local 'ispell-local-dictionary
)
699 ;; Use default directory, unless locally set.
700 (set-default 'ispell-local-dictionary nil
)
702 (defconst ispell-words-keyword
"LocalWords: "
703 "The keyword for local oddly-spelled words to accept.
704 The keyword will be followed by any number of local word spellings.
705 There can be multiple of these keywords in the file.")
707 (defconst ispell-dictionary-keyword
"Local IspellDict: "
708 "The keyword for local dictionary definitions.
709 There should be only one dictionary keyword definition per file, and it
710 should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
712 (defconst ispell-parsing-keyword
"Local IspellParsing: "
713 "The keyword for overriding default Ispell parsing.
714 Determined by the buffer's major mode and extended-character mode as well as
715 the default dictionary.
717 The above keyword string should be followed by `latex-mode' or
718 `nroff-mode' to put the current buffer into the desired parsing mode.
720 Extended character mode can be changed for this buffer by placing
721 a `~' followed by an extended-character mode -- such as `~.tex'.")
723 (defvar ispell-local-pdict ispell-personal-dictionary
724 "A buffer local variable containing the current personal dictionary.
725 If non-nil, the value must be a string, which is a file name.
727 If you specify a personal dictionary for the current buffer which is
728 different from the current personal dictionary, the effect is similar
729 to calling \\[ispell-change-dictionary]. This variable is automatically
730 set when defined in the file with either `ispell-pdict-keyword' or the
731 local variable syntax.")
733 (make-variable-buffer-local 'ispell-local-pdict
)
735 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
736 "The keyword for defining buffer local dictionaries.")
738 (defvar ispell-buffer-local-name nil
739 "Contains the buffer name if local word definitions were used.
740 Ispell is then restarted because the local words could conflict.")
742 (defvar ispell-parser
'use-mode-name
743 "*Indicates whether ispell should parse the current buffer as TeX Code.
744 Special value `use-mode-name' tries to guess using the name of major-mode.
745 Default parser is 'nroff.
746 Currently the only other valid parser is 'tex.
748 You can set this variable in hooks in your init file -- eg:
750 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
752 (defvar ispell-region-end
(make-marker)
753 "Marker that allows spelling continuations.")
755 (defvar ispell-check-only nil
756 "If non-nil, `ispell-word' does not try to correct the word.")
759 ;;; **********************************************************************
760 ;;; **********************************************************************
763 (if (string-lessp "19" emacs-version
)
764 (defalias 'ispell
'ispell-buffer
))
766 ;;;###autoload (define-key global-map "\M-$" 'ispell-word)
769 (defun ispell-word (&optional following quietly continue
)
770 "Check spelling of word under or before the cursor.
771 If the word is not found in dictionary, display possible corrections
772 in a window allowing you to choose one.
774 With a prefix argument (or if CONTINUE is non-nil),
775 resume interrupted spell-checking of a buffer or region.
777 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
778 is non-nil when called interactively, then the following word
779 \(rather than preceding\) is checked when the cursor is not over a word.
780 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
781 when called interactively, non-corrective messages are suppressed.
783 Word syntax described by `ispell-dictionary-alist' (which see).
785 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
786 or \\[ispell-region] to update the Ispell process."
787 (interactive (list nil nil current-prefix-arg
))
791 (setq following ispell-following-word
792 quietly ispell-quietly
))
793 (ispell-accept-buffer-local-defs) ; use the correct dictionary
794 (let ((cursor-location (point)) ; retain cursor location
795 (word (ispell-get-word following
))
796 start end poss replace
)
797 ;; destructure return word info list.
798 (setq start
(car (cdr word
))
799 end
(car (cdr (cdr word
)))
802 ;; now check spelling of word.
804 (message "Checking spelling of %s..."
805 (funcall ispell-format-word word
)))
806 (process-send-string ispell-process
"%\n") ;put in verbose mode
807 (process-send-string ispell-process
(concat "^" word
"\n"))
808 ;; wait until ispell has processed word
810 (accept-process-output ispell-process
)
811 (not (string= "" (car ispell-filter
)))))
812 ;;(process-send-string ispell-process "!\n") ;back to terse mode.
813 (setq ispell-filter
(cdr ispell-filter
))
814 (if (listp ispell-filter
)
815 (setq poss
(ispell-parse-output (car ispell-filter
))))
818 (message "%s is correct" (funcall ispell-format-word word
))))
821 (message "%s is correct because of root %s"
822 (funcall ispell-format-word word
)
823 (funcall ispell-format-word poss
))))
824 ((null poss
) (message "Error in ispell process"))
825 (ispell-check-only ; called from ispell minor mode.
827 (t ; prompt for correct word.
828 (save-window-excursion
829 (setq replace
(ispell-command-loop
830 (car (cdr (cdr poss
)))
831 (car (cdr (cdr (cdr poss
))))
832 (car poss
) start end
)))
833 (cond ((equal 0 replace
)
834 (ispell-add-per-file-word-list (car poss
)))
836 (setq word
(if (atom replace
) replace
(car replace
))
837 cursor-location
(+ (- (length word
) (- end start
))
839 (if (not (equal word
(car poss
)))
841 (delete-region start end
)
843 (if (not (atom replace
)) ; recheck spelling of replacement
845 (goto-char cursor-location
)
846 (ispell-word following quietly
)))))
847 (if (get-buffer ispell-choices-buffer
)
848 (kill-buffer ispell-choices-buffer
))))
849 (goto-char cursor-location
) ; return to original location
850 (ispell-pdict-save ispell-silently-savep
)
851 (if ispell-quit
(setq ispell-quit nil
)))))
854 (defun ispell-get-word (following &optional extra-otherchars
)
855 "Return the word for spell-checking according to ispell syntax.
856 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
857 is non-nil when called interactively, then the following word
858 \(rather than preceding\) is checked when the cursor is not over a word.
859 Optional second argument contains otherchars that can be included in word
862 Word syntax described by `ispell-dictionary-alist' (which see)."
863 (let* ((ispell-casechars (ispell-get-casechars))
864 (ispell-not-casechars (ispell-get-not-casechars))
865 (ispell-otherchars (ispell-get-otherchars))
866 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
867 (word-regexp (concat ispell-casechars
872 (concat extra-otherchars
"?"))
875 (if (or ispell-many-otherchars-p
881 (if (not (looking-at ispell-casechars
))
883 (re-search-forward ispell-casechars
(point-max) t
)
884 (re-search-backward ispell-casechars
(point-min) t
)))
885 ;; move to front of word
886 (re-search-backward ispell-not-casechars
(point-min) 'start
)
887 (while (and (or (looking-at ispell-otherchars
)
888 (and extra-otherchars
(looking-at extra-otherchars
)))
890 (or (not did-it-once
)
891 ispell-many-otherchars-p
))
892 (if (and extra-otherchars
(looking-at extra-otherchars
))
895 (if (looking-at ispell-casechars
)
896 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
899 (if (looking-at ispell-casechars
)
900 (re-search-backward ispell-not-casechars
(point-min) 'move
)
901 (backward-char -
1))))
902 ;; Now mark the word and save to string.
903 (or (re-search-forward word-regexp
(point-max) t
)
904 (error "No word found to check!"))
905 (setq start
(match-beginning 0)
907 word
(buffer-substring start end
))
908 (list word start end
)))
911 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
912 ;;; tracks changes in the dictionary. The global may either be
913 ;;; a value or a list, whose value is the state of whether the
914 ;;; dictionary needs to be saved.
916 (defun ispell-pdict-save (&optional no-query force-save
)
917 "Check to see if the personal dictionary has been modified.
918 If so, ask if it needs to be saved."
919 (interactive (list ispell-silently-savep t
))
920 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
921 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
922 (if (or ispell-pdict-modified-p force-save
)
923 (if (or no-query
(y-or-n-p "Personal dictionary modified. Save? "))
924 (process-send-string ispell-process
"#\n")))
925 ;; unassert variable, even if not saved to avoid questioning.
926 (setq ispell-pdict-modified-p nil
))
929 (defun ispell-command-loop (miss guess word start end
)
930 "Display possible corrections from list MISS.
931 GUESS lists possibly valid affix construction of WORD.
932 Returns nil to keep word.
933 Returns 0 to insert locally into buffer-local dictionary.
934 Returns string for new chosen word.
935 Returns list for new replacement word (will be rechecked).
936 Highlights the word, which is assumed to run from START to END.
937 Global `ispell-pdict-modified-p' becomes a list where the only value
938 indicates whether the dictionary has been modified when option `a' or `i' is
940 (let ((textbuf (current-buffer))
943 (max-lines (- (window-height) 4)) ; assure 4 context lines.
945 (window-min-height (min window-min-height
946 ispell-choices-win-default-height
))
947 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
949 char num result textwin highlighted
)
951 ;; setup the *Choices* buffer with valid data.
953 (set-buffer (get-buffer-create ispell-choices-buffer
))
954 (setq mode-line-format
"-- %b --")
958 (insert "Affix rules generate and capitalize "
959 "this word as shown below:\n\t")
961 (if (> (+ 4 (current-column) (length (car guess
)))
965 (setq line
(1+ line
))))
966 (insert (car guess
) " ")
967 (setq guess
(cdr guess
)))
968 (insert "\nUse option `i' if this is a correct composition"
969 " from the derivative root.\n")
970 (setq line
(+ line
(if choices
3 2)))))
972 (< (if (> (+ 7 (current-column) (length (car choices
))
973 (if (> count ?~
) 3 0))
977 (setq line
(1+ line
)))
980 ;; not so good if there are over 20 or 30 options, but then, if
981 ;; there are that many you don't want to scan them all anyway...
982 (while (memq count command-characters
) ; skip command characters.
983 (setq count
(1+ count
)
984 skipped
(1+ skipped
)))
985 (insert "(" count
") " (car choices
) " ")
986 (setq choices
(cdr choices
)
988 (setq count
(- count ?
0 skipped
)))
990 ;; Assure word is visible
991 (if (not (pos-visible-in-window-p end
))
993 ;; Display choices for misspelled word.
994 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
996 (if (not (equal line
(window-height choices-window
)))
997 ;; *Choices* window changed size. Adjust the choices window
998 ;; without scrolling the spelled window when possible
999 (let ((window-line (- line
(window-height choices-window
)))
1000 (visible (progn (forward-line -
1) (point))))
1001 (move-to-window-line 0)
1002 (forward-line window-line
)
1003 (set-window-start (selected-window)
1004 (if (> (point) visible
) visible
(point)))
1006 (select-window (previous-window)) ; *Choices* window
1007 (enlarge-window window-line
))
1008 (select-window choices-window
))
1009 ;; Overlay *Choices* window when it isn't showing
1010 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
1011 (switch-to-buffer ispell-choices-buffer
)
1012 (goto-char (point-min)))
1014 (select-window (setq textwin
(next-window)))
1016 ;; highlight word, protecting current buffer status
1019 (if ispell-highlight-p
1020 (ispell-highlight-spelling-error start end t
))
1021 ;; Loop until a valid choice is made.
1029 (message (concat "C-h or ? for more options; SPC to leave "
1030 "unchanged, Character to replace word"))
1031 (let ((inhibit-quit t
))
1032 (setq char
(if (fboundp 'read-char-exclusive
)
1033 (read-char-exclusive)
1036 (if (or quit-flag
(= char ?\C-g
)) ; C-g is like typing X
1039 ;; Adjust num to array offset skipping command characters.
1040 (let ((com-chars command-characters
))
1042 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
1043 (setq skipped
(1+ skipped
)))
1044 (setq com-chars
(cdr com-chars
)))
1045 (setq num
(- char ?
0 skipped
)))
1048 ((= char ?
) nil
) ; accept word this time only
1049 ((= char ?i
) ; accept and insert word into pers dict
1050 (process-send-string ispell-process
(concat "*" word
"\n"))
1051 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
1053 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
1054 (process-send-string ispell-process
(concat "@" word
"\n"))
1055 (if (null ispell-pdict-modified-p
)
1056 (setq ispell-pdict-modified-p
1057 (list ispell-pdict-modified-p
)))
1058 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
1059 ((or (= char ?r
) (= char ?R
)) ; type in replacement
1060 (if (or (= char ?R
) ispell-query-replace-choices
)
1061 (list (read-string "Query-replacement for: " word
) t
)
1062 (cons (read-string "Replacement for: " word
) nil
)))
1063 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
1066 ;; Quit and move point back.
1068 (ispell-pdict-save ispell-silently-savep
)
1069 (message "Exited spell-checking")
1070 (setq ispell-quit t
)
1072 ;; Quit and preserve point.
1074 (ispell-pdict-save ispell-silently-savep
)
1076 (substitute-command-keys
1077 (concat "Spell-checking suspended;"
1078 " use C-u \\[ispell-word] to resume")))
1079 (setq ispell-quit
(max (point-min)
1080 (- (point) (length word
))))
1083 (if (y-or-n-p "Really kill Ispell process? ")
1085 (ispell-kill-ispell t
) ; terminate process.
1086 (setq ispell-quit
(or (not ispell-checking-message
)
1088 ispell-pdict-modified-p nil
))
1089 t
)) ; continue if they don't quit.
1091 (let ((new-word (read-string
1092 "Lookup string (`*' is wildcard): "
1098 (set-buffer (get-buffer-create
1099 ispell-choices-buffer
))
1103 mode-line-format
"-- %b --"
1104 miss
(lookup-words new-word
)
1106 (while (and choices
; adjust choices window.
1107 (< (if (> (+ 7 (current-column)
1108 (length (car choices
))
1109 (if (> count ?~
) 3 0))
1117 (while (memq count command-characters
)
1118 (setq count
(1+ count
)
1119 skipped
(1+ skipped
)))
1120 (insert "(" count
") " (car choices
) " ")
1121 (setq choices
(cdr choices
)
1123 (setq count
(- count ?
0 skipped
)))
1124 (select-window (previous-window))
1125 (if (/= new-line line
)
1127 (if (> new-line line
)
1128 (enlarge-window (- new-line line
))
1129 (shrink-window (- line new-line
)))
1130 (setq line new-line
)))
1131 (select-window (next-window)))))
1132 t
) ; reselect from new choices
1134 (process-send-string ispell-process
1135 (concat "*" (downcase word
) "\n"))
1136 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
1138 ((= char ?m
) ; type in what to insert
1139 (process-send-string
1140 ispell-process
(concat "*" (read-string "Insert: " word
)
1142 (setq ispell-pdict-modified-p
'(t))
1144 ((and (>= num
0) (< num count
))
1145 (if ispell-query-replace-choices
; Query replace flag
1146 (list (nth num miss
) 'query-replace
)
1151 (save-window-excursion (recursive-edit)) t
)
1153 (funcall (key-binding "\C-z"))
1158 (if ispell-highlight-p
; unhighlight
1159 (save-window-excursion
1160 (select-window textwin
)
1161 (ispell-highlight-spelling-error start end
))))))
1165 (defun ispell-help ()
1166 "Display a list of the options available when a misspelling is encountered.
1170 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1171 SPC: Accept word this time.
1172 `i': Accept word and insert into private dictionary.
1173 `a': Accept word for this session.
1174 `A': Accept word and place in `buffer-local dictionary'.
1175 `r': Replace word with typed-in value. Rechecked.
1176 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1177 `?': Show these commands.
1178 `x': Exit spelling buffer. Move cursor to original point.
1179 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1180 the aborted check to be completed later.
1181 `q': Quit spelling session (Kills ispell process).
1182 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1183 `u': Like `i', but the word is lower-cased first.
1184 `m': Like `i', but allows one to include dictionary completion information.
1185 `C-l': redraws screen
1186 `C-r': recursive edit
1187 `C-z': suspend emacs or iconify frame"
1189 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1190 "[i]nsert into private dictionary"))
1191 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1192 "e[x/X]it; [q]uit session"))
1193 (help-3 (concat "[u]ncapitalized insert into dictionary. "
1194 "Type 'C-h d ispell-help' for more help")))
1195 (save-window-excursion
1196 (if ispell-help-in-bufferp
1198 (ispell-overlay-window 4)
1199 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1200 (insert (concat help-1
"\n" help-2
"\n" help-3
))
1202 (kill-buffer "*Ispell Help*"))
1203 (select-window (minibuffer-window))
1204 ;;(enlarge-window 2)
1206 (cond ((string-match "Lucid" emacs-version
)
1212 (goto-char (point-min)))
1214 (if (string-lessp "19" emacs-version
)
1217 (insert (concat help-1
"\n" help-2
"\n" help-3
))))
1222 (defun lookup-words (word &optional lookup-dict
)
1223 "Look up word in word-list dictionary.
1224 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1225 Otherwise the variable `ispell-grep-command' contains the command used to
1226 search for the words (usually egrep).
1228 Optional second argument contains the dictionary to use; the default is
1229 `ispell-alternate-dictionary'."
1230 ;; We don't use the filter for this function, rather the result is written
1231 ;; into a buffer. Hence there is no need to save the filter values.
1232 (if (null lookup-dict
)
1233 (setq lookup-dict ispell-alternate-dictionary
))
1235 (let* ((process-connection-type ispell-use-ptys-p
)
1236 (wild-p (string-match "\\*" word
))
1237 (look-p (and ispell-look-p
; Only use look for an exact match.
1238 (or ispell-have-new-look
(not wild-p
))))
1239 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1240 (prog (if look-p ispell-look-command ispell-grep-command
))
1241 (args (if look-p ispell-look-options ispell-grep-options
))
1244 (save-window-excursion
1245 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
1246 (set-buffer ispell-grep-buffer
)
1250 (insert "^" word
"$")
1251 (while (search-backward "*" nil t
) (insert "."))
1252 (setq word
(buffer-string))
1254 (setq status
(call-process prog nil t nil args word lookup-dict
))
1255 ;; grep returns status 1 and no output when word not found, which
1256 ;; is a perfectly normal thing.
1257 (if (stringp status
)
1258 (setq results
(cons (format "error: %s exited with signal %s"
1259 (file-name-nondirectory prog
) status
)
1261 ;; else collect words into `results' in FIFO order
1262 (goto-char (point-max))
1263 ;; assure we've ended with \n
1264 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
1268 (setq results
(cons (buffer-substring (point) (1- loc
))
1271 (kill-buffer ispell-grep-buffer
)
1272 (if (and results
(string-match ".+: " (car results
)))
1273 (error "%s error: %s" ispell-grep-command
(car results
))))
1277 ;;; "ispell-filter" is a list of output lines from the generating function.
1278 ;;; Each full line (ending with \n) is a separate item on the list.
1279 ;;; "output" can contain multiple lines, part of a line, or both.
1280 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1282 ;;; "ispell-filter-continue" is true when we have received only part of a
1283 ;;; line as output from a generating function ("output" did not end with \n)
1284 ;;; NOTE THAT THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESNT END WITH \n!
1285 ;;; This is the case when a process dies or fails. The default behavior
1286 ;;; in this case treats the next input received as fresh input.
1288 (defun ispell-filter (process output
)
1289 "Output filter function for ispell, grep, and look."
1294 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
1295 ;; If we get out of sync and ispell-filter-continue is asserted when we
1296 ;; are not continuing, treat the next item as a separate list. When
1297 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1300 ;; Continue with same line (item)?
1301 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
1302 ;; Yes. Add it to the prev item
1303 (setcar ispell-filter
1304 (concat (car ispell-filter
) (substring output start end
)))
1305 ;; No. This is a new line and item.
1307 (cons (substring output start end
) ispell-filter
)))
1309 ;; We've completed reading the output, but didn't finish the line.
1310 (setq ispell-filter-continue t continue nil
)
1311 ;; skip over newline, this line complete.
1312 (setq ispell-filter-continue nil end
(1+ end
))
1313 (if (= end
(length output
)) ; No more lines in output
1314 (setq continue nil
) ; so we can exit the filter.
1315 (setq start end
)))))) ; else move start to next line of input
1318 ;;; This function destroys the mark location if it is in the word being
1320 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
)
1321 "Highlight the word from START to END with a kludge using `inverse-video'.
1322 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1323 otherwise it is displayed normally."
1324 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1325 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
1326 (text (buffer-substring start end
)) ; Save highlight region
1327 (inhibit-quit t
) ; inhibit interrupt processing here.
1328 (buffer-undo-list t
)) ; don't clutter the undo list.
1329 (delete-region start end
)
1330 (insert-char ?
(- end start
)) ; mimimize amount of redisplay
1331 (sit-for 0) ; update display
1332 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
1333 (delete-region start end
) ; delete whitespace
1334 (insert text
) ; insert text in inverse video.
1335 (sit-for 0) ; update display showing inverse video.
1336 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
1337 (set-buffer-modified-p modified
))) ; don't modify if flag not set.
1340 (defun ispell-highlight-spelling-error-lucid (start end
&optional highlight
)
1341 "Highlight the word from START to END using `isearch-highlight'.
1342 When the optional third arg HIGHLIGHT is set, the word is highlighted,
1343 otherwise it is displayed normally."
1345 (isearch-highlight start end
)
1346 (isearch-dehighlight t
))
1351 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
1352 "Highlight the word from START to END using overlays.
1353 When the optional third arg HIGHLIGHT is set, the word is highlighted
1354 otherwise it is displayed normally.
1356 The variable `ispell-highlight-face' selects the face to use for highlighting."
1359 (setq ispell-overlay
(make-overlay start end
))
1360 (overlay-put ispell-overlay
'face ispell-highlight-face
))
1361 (delete-overlay ispell-overlay
)))
1364 (defun ispell-highlight-spelling-error (start end
&optional highlight
)
1366 ((string-match "Lucid" emacs-version
)
1367 (ispell-highlight-spelling-error-lucid start end highlight
))
1368 ((and (string-lessp "19" emacs-version
)
1369 (featurep 'faces
) window-system
)
1370 (ispell-highlight-spelling-error-overlay start end highlight
))
1371 (t (ispell-highlight-spelling-error-generic start end highlight
))))
1374 (defun ispell-overlay-window (height)
1375 "Create a window covering the top HEIGHT lines of the current window.
1376 Ensure that the line above point is still visible but otherwise avoid
1377 scrolling the current window. Leave the new window selected."
1379 (let ((oldot (save-excursion (forward-line -
1) (point)))
1380 (top (save-excursion (move-to-window-line height
) (point))))
1381 ;; If line above old point (line starting at olddot) would be
1382 ;; hidden by new window, scroll it to just below new win
1383 ;; otherwise set top line of other win so it doesn't scroll.
1384 (if (< oldot top
) (setq top oldot
))
1385 ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
1386 ;; line) is demanded, the last line is not visible.
1387 ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
1388 ;; So we increment the height for this case.
1389 (if (string-match "19\.9.*Lucid" (emacs-version))
1390 (setq height
(1+ height
)))
1391 (split-window nil height
)
1392 (set-window-start (next-window) top
))))
1395 ;;; Should we add a compound word match return value?
1396 (defun ispell-parse-output (output)
1397 "Parse the OUTPUT string from Ispell and return:
1398 1: t for an exact match.
1399 2: A string containing the root word for a match via suffix removal.
1400 3: A list of possible correct spellings of the format:
1401 '(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
1402 ORIGINAL-WORD is a string of the possibly misspelled word.
1403 OFFSET is an integer giving the line offset of the word.
1404 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses."
1406 ((string= output
"") t
) ; for startup with pipes...
1407 ((string= output
"*") t
) ; exact match
1408 ((string= output
"-") t
) ; compound word match
1409 ((string= (substring output
0 1) "+") ; found cuz of root word
1410 (substring output
2)) ; return root word
1411 (t ; need to process &, ?, and #'s
1412 (let ((type (substring output
0 1)) ; &, ?, or #
1413 (original-word (substring output
2 (string-match " " output
2)))
1414 (cur-count 0) ; contains number of misses + guesses
1415 count miss-list guess-list offset
)
1416 (setq output
(substring output
(match-end 0))) ; skip over misspelling
1417 (if (string= type
"#")
1418 (setq count
0) ; no misses for type #
1419 (setq count
(string-to-int output
) ; get number of misses.
1420 output
(substring output
(1+ (string-match " " output
1)))))
1421 (setq offset
(string-to-int output
))
1422 (if (string= type
"#") ; No miss or guess list.
1424 (setq output
(substring output
(1+ (string-match " " output
1)))))
1426 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
1427 (setq cur-count
(1+ cur-count
))
1428 (if (> cur-count count
)
1429 (setq guess-list
(cons (substring output
0 end
) guess-list
))
1430 (setq miss-list
(cons (substring output
0 end
) miss-list
)))
1431 (if (match-end 1) ; True only when at end of line.
1432 (setq output nil
) ; no more misses or guesses
1433 (setq output
(substring output
(+ end
2))))))
1434 (list original-word offset miss-list guess-list
)))))
1437 (defun check-ispell-version ()
1438 ;; This is a little wasteful as we actually launch ispell twice: once
1439 ;; to make sure it's the right version, and once for real. But people
1440 ;; get confused by version mismatches *all* the time (and I've got the
1441 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
1442 ;; option is the only way I can think of to do this that works with
1443 ;; all versions, since versions earlier than 3.0.09 didn't identify
1444 ;; themselves on startup.
1446 (set-buffer (get-buffer-create " *ispell-tmp*"))
1448 ;; Avoid obscure bugs caused by users who change the syntax of `.' in
1449 ;; whatever default major mode the user uses, e.g. text mode.
1451 (let ((status (call-process ispell-program-name nil t nil
"-v"))
1452 (case-fold-search t
))
1453 (goto-char (point-min))
1454 (if (not (memq status
'(0 nil
)))
1455 (error "%s exited with %s %s" ispell-program-name
1456 (if (stringp status
) "signal" "code") status
))
1457 (if (not (re-search-forward
1459 (regexp-quote (car ispell-required-version
))
1460 "\\)\\([0-9]*\\)\\b")
1463 "%s version %s* is required: try renaming ispell4.el to ispell.el"
1464 ispell-program-name
(car ispell-required-version
))
1465 ;; check that it is the correct version.
1466 (if (< (car (read-from-string (buffer-substring
1467 (match-beginning 2) (match-end 2))))
1468 (car (cdr ispell-required-version
)))
1469 (setq ispell-offset
0)))
1470 (kill-buffer (current-buffer)))))
1473 (defun ispell-init-process ()
1474 "Check status of Ispell process and start if necessary."
1475 (if (and ispell-process
1476 (eq (process-status ispell-process
) 'run
)
1477 ;; If we're using a personal dictionary, assure
1478 ;; we're in the same default directory!
1479 (or (not ispell-personal-dictionary
)
1480 (equal ispell-process-directory default-directory
)))
1481 (setq ispell-filter nil ispell-filter-continue nil
)
1482 ;; may need to restart to select new personal dictionary.
1483 (ispell-kill-ispell t
)
1484 (message "Starting new Ispell process...")
1486 (check-ispell-version)
1487 (setq ispell-process
1488 (let ((process-connection-type ispell-use-ptys-p
))
1489 (apply 'start-process
1490 "ispell" nil ispell-program-name
1491 "-a" ; accept single input lines
1492 "-m" ; make root/affix combos not in dict
1494 ;; Local dictionary becomes the global dictionary in use.
1495 (if ispell-local-dictionary
1496 (setq ispell-dictionary ispell-local-dictionary
))
1497 (setq args
(ispell-get-ispell-args))
1498 (if ispell-dictionary
; use specified dictionary
1500 (append (list "-d" ispell-dictionary
) args
)))
1501 (if ispell-personal-dictionary
; use specified pers dict
1506 ispell-personal-dictionary
)))))
1507 (setq args
(append args ispell-extra-args
))
1510 ispell-filter-continue nil
1511 ispell-process-directory default-directory
)
1512 (set-process-filter ispell-process
'ispell-filter
)
1513 (accept-process-output ispell-process
) ; Get version ID line
1514 (cond ((null ispell-filter
)
1515 (error "%s did not output version line" ispell-program-name
))
1516 ((and (null (cdr ispell-filter
))
1517 (stringp (car ispell-filter
))
1518 (string-match "^@(#) " (car ispell-filter
)))
1519 ;; got the version line as expected (we already know it's the right
1520 ;; version, so don't bother checking again.)
1523 ;; Otherwise, it must be an error message. Show the user.
1524 ;; But first wait to see if some more output is going to arrive.
1525 ;; Otherwise we get cool errors like "Can't open ".
1527 (accept-process-output)
1528 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
1529 (setq ispell-filter nil
) ; Discard version ID line
1530 (let ((extended-char-mode (ispell-get-extended-character-mode)))
1531 (if extended-char-mode
1532 (process-send-string ispell-process
1533 (concat extended-char-mode
"\n"))))
1534 (process-kill-without-query ispell-process
)))
1537 (defun ispell-kill-ispell (&optional no-error
)
1538 "Kill current Ispell process (so that you may start a fresh one).
1539 With NO-ERROR, just return non-nil if there was no Ispell running."
1541 (if (not (and ispell-process
1542 (eq (process-status ispell-process
) 'run
)))
1544 (error "There is no ispell process running!"))
1545 (kill-process ispell-process
)
1546 (setq ispell-process nil
)
1547 (message "Ispell process killed")
1552 (defun ispell-change-dictionary (dict &optional arg
)
1553 "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
1554 A new one will be started as soon as necessary.
1556 By just answering RET you can find out what the current dictionary is.
1558 With prefix argument, set the default directory."
1560 (list (completing-read
1561 "Use new dictionary (RET for current, SPC to complete): "
1562 (cons (cons "default" nil
) ispell-dictionary-alist
) nil t
)
1563 current-prefix-arg
))
1564 (if (equal dict
"default") (setq dict nil
))
1565 ;; This relies on completing-read's bug of returning "" for no match
1566 (cond ((equal dict
"")
1567 (message "Using %s dictionary"
1568 (or ispell-local-dictionary ispell-dictionary
"default")))
1569 ((and (equal dict ispell-dictionary
)
1570 (equal dict ispell-local-dictionary
))
1571 ;; Specified dictionary is the default already. No-op
1572 (message "No change, using %s dictionary" (or dict
"default")))
1573 (t ; reset dictionary!
1574 (if (assoc dict ispell-dictionary-alist
)
1576 (if (or arg
(null dict
)) ; set default dictionary
1577 (setq ispell-dictionary dict
))
1578 (if (null arg
) ; set local dictionary
1579 (setq ispell-local-dictionary dict
)))
1580 (error "Illegal dictionary: %s" dict
))
1581 (ispell-kill-ispell t
)
1582 (message "(Next %sIspell command will use %s dictionary)"
1583 (cond ((equal ispell-local-dictionary ispell-dictionary
)
1587 (or (if (or (equal ispell-local-dictionary ispell-dictionary
)
1589 ispell-local-dictionary
1594 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
1597 (defun ispell-region (reg-start reg-end
)
1598 "Interactively check a region for spelling errors."
1599 (interactive "r") ; Don't flag errors on read-only bufs.
1600 (ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
1603 (message "Spell checking %s using %s dictionary..."
1604 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
1605 (buffer-name) "region")
1606 (or ispell-dictionary
"default"))
1607 ;; Returns cursor to original location.
1608 (save-window-excursion
1609 (goto-char reg-start
)
1610 (let ((transient-mark-mode nil
))
1611 (while (and (not ispell-quit
) (< (point) reg-end
))
1612 (let ((start (point))
1614 (end (save-excursion (end-of-line) (min (point) reg-end
)))
1615 (ispell-casechars (ispell-get-casechars))
1617 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
1618 ((eolp) ; END OF LINE, just go to next line.
1620 ((and (null ispell-check-comments
) ; SKIPPING COMMENTS
1621 comment-start
; skip comments that start on the line.
1622 (search-forward comment-start end t
)) ; or found here.
1623 (if (= (- (point) start
) (length comment-start
))
1624 ;; comment starts the line. Skip entire line or region
1625 (if (string= "" comment-end
) ; skip to next line
1626 (beginning-of-line 2) ; or jump to comment end.
1627 (search-forward comment-end reg-end
'limit
))
1628 ;; Comment later in line. Check spelling before comment.
1629 (let ((limit (- (point) (length comment-start
))))
1630 (goto-char (1- limit
))
1631 (if (looking-at "\\\\") ; "quoted" comment, don't skip
1632 ;; quoted comment. Skip over comment-start
1633 (if (= start
(1- limit
))
1634 (setq limit
(+ limit
(length comment-start
)))
1635 (setq limit
(1- limit
))))
1637 ;; Only check when "casechars" or math before comment
1638 (if (or (re-search-forward ispell-casechars limit t
)
1639 (re-search-forward "[][()$]" limit t
))
1641 (concat "^" (buffer-substring start limit
)
1643 offset-change
(- offset-change ispell-offset
)))
1644 (goto-char limit
))))
1645 ((and ispell-skip-tib
; SKIP TIB REFERENCES!
1646 (re-search-forward ispell-tib-ref-beginning end t
))
1647 (if (= (- (point) 2) start
) ; tib ref is 2 chars.
1648 ;; Skip to end of tib ref, not necessarily on this line.
1649 ;; Return an error if tib ref not found
1650 (if (not(re-search-forward ispell-tib-ref-end reg-end t
))
1652 (ispell-pdict-save ispell-silently-savep
)
1656 "Open tib reference--set `ispell-skip-tib'"
1657 " to nil to avoid this error"))
1658 ;; keep cursor at error location
1659 (setq ispell-quit
(- (point) 2))))
1660 ;; tib ref starts later on line. Check spelling before tib.
1661 (let ((limit (- (point) 2)))
1663 (if (or (re-search-forward ispell-casechars limit t
)
1664 (re-search-forward "[][()$]" limit t
))
1666 (concat "^" (buffer-substring start limit
)
1668 offset-change
(- offset-change ispell-offset
)))
1669 (goto-char limit
))))
1670 ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
1672 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
1673 (re-search-forward "[][()$]" end t
)) ; or MATH COMMANDS
1674 (setq string
(concat "^" (buffer-substring start end
) "\n")
1675 offset-change
(- offset-change ispell-offset
))
1677 (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
1679 (setq end
(point)) ; "end" tracks end of region to check.
1681 (if string
; there is something to spell!
1683 ;; send string to spell process and get input.
1684 (process-send-string ispell-process string
)
1686 (accept-process-output ispell-process
)
1687 ;; Last item of output contains a blank line.
1688 (not (string= "" (car ispell-filter
)))))
1689 ;; parse all inputs from the stream one word at a time.
1690 ;; Place in FIFO order and remove the blank item.
1691 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
1692 (while (and (not ispell-quit
) ispell-filter
)
1693 (setq poss
(ispell-parse-output (car ispell-filter
)))
1694 (if (listp poss
) ; spelling error occurred.
1695 (let* ((word-start (+ start offset-change
1697 (word-end (+ word-start
1698 (length (car poss
))))
1700 (goto-char word-start
)
1701 ;; Adjust the horizontal scroll & point
1702 (ispell-horiz-scroll)
1703 (goto-char word-end
)
1704 (ispell-horiz-scroll)
1705 (goto-char word-start
)
1706 (ispell-horiz-scroll)
1709 (search-forward (car poss
) word-end t
)
1711 ;; This occurs due to filter pipe problems
1713 (concat "Ispell misalignment: word "
1714 "`%s' point %d; please retry")
1715 (car poss
) word-start
))
1716 (if ispell-keep-choices-win
1718 (ispell-command-loop
1719 (car (cdr (cdr poss
)))
1720 (car (cdr (cdr (cdr poss
))))
1721 (car poss
) word-start word-end
))
1722 (save-window-excursion
1724 (ispell-command-loop
1725 (car (cdr (cdr poss
)))
1726 (car (cdr (cdr (cdr poss
))))
1727 (car poss
) word-start word-end
))))
1729 ((and replace
(listp replace
))
1730 ;; REPLACEMENT WORD entered. Recheck line
1731 ;; starting with the replacement word.
1732 (setq ispell-filter nil
1733 string
(buffer-substring word-start
1735 (let ((change (- (length (car replace
))
1736 (length (car poss
)))))
1738 (setq reg-end
(+ reg-end change
)
1739 offset-change
(+ offset-change
1741 (if (not (equal (car replace
) (car poss
)))
1743 (delete-region word-start word-end
)
1744 (insert (car replace
))))
1745 ;; I only need to recheck typed-in replacements
1746 (if (not (eq 'query-replace
1747 (car (cdr replace
))))
1748 (backward-char (length (car replace
))))
1749 (setq end
(point)) ; reposition for recheck
1750 ;; when second arg exists, query-replace, saving regions
1751 (if (car (cdr replace
))
1753 (save-window-excursion
1755 ispell-query-replace-marker reg-end
)
1756 ;; Assume case-replace &
1757 ;; case-fold-search correct?
1758 (query-replace string
(car replace
)
1762 ispell-query-replace-marker
))
1763 (set-marker ispell-query-replace-marker
1766 (equal 0 replace
)) ; ACCEPT/INSERT
1767 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
1769 (ispell-add-per-file-word-list
1770 (car poss
) reg-end
)))
1771 ;; This avoids pointing out the word that was
1772 ;; just accepted (via 'i' or 'a') if it follows
1773 ;; on the same line.
1774 ;; Redo check following the accepted word.
1775 (if (and ispell-pdict-modified-p
1776 (listp ispell-pdict-modified-p
))
1777 ;; Word accepted. Recheck line.
1778 (setq ispell-pdict-modified-p
; update flag
1779 (car ispell-pdict-modified-p
)
1780 ispell-filter nil
; discontinue check
1781 end word-start
))) ; reposition loc.
1782 (replace ; STRING REPLACEMENT for this word.
1783 (delete-region word-start word-end
)
1785 (let ((change (- (length replace
)
1786 (length (car poss
)))))
1787 (setq reg-end
(+ reg-end change
)
1788 offset-change
(+ offset-change change
)
1789 end
(+ end change
)))))
1790 (if (not ispell-quit
)
1792 (concat "Continuing spelling check using "
1793 (or ispell-dictionary
"default")
1796 ;; finished with line!
1797 (setq ispell-filter
(cdr ispell-filter
)))))
1801 (if (get-buffer ispell-choices-buffer
)
1802 (kill-buffer ispell-choices-buffer
))
1805 ;; preserve or clear the region for ispell-continue.
1806 (if (not (numberp ispell-quit
))
1807 (set-marker ispell-region-end nil
)
1808 ;; Enable ispell-continue.
1809 (set-marker ispell-region-end reg-end
)
1810 (goto-char ispell-quit
))
1811 ;; Check for aborting
1812 (if (and ispell-checking-message
(numberp ispell-quit
))
1814 (setq ispell-quit nil
)
1815 (error "Message send aborted.")))
1816 (setq ispell-quit nil
))
1817 (set-marker ispell-region-end nil
)
1818 ;; Only save if successful exit.
1819 (ispell-pdict-save ispell-silently-savep
)
1820 (message "Spell-checking done"))))
1825 (defun ispell-buffer ()
1826 "Check the current buffer for spelling errors interactively."
1828 (ispell-region (point-min) (point-max)))
1832 (defun ispell-continue ()
1834 "Continue a spelling session after making some changes."
1835 (if (not (marker-position ispell-region-end
))
1836 (message "No session to continue. Use 'X' command when checking!")
1837 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
1838 (message "Must continue ispell from buffer %s"
1839 (buffer-name (marker-buffer ispell-region-end
)))
1840 (ispell-region (point) (marker-position ispell-region-end
)))))
1843 ;;; Horizontal scrolling
1844 (defun ispell-horiz-scroll ()
1845 "Places point within the horizontal visibility of its window area."
1846 (if truncate-lines
; display truncating lines?
1847 ;; See if display needs to be scrolled.
1848 (let ((column (- (current-column) (max (window-hscroll) 1))))
1849 (if (and (< column
0) (> (window-hscroll) 0))
1850 (scroll-right (max (- column
) 10))
1851 (if (>= column
(- (window-width) 2))
1852 (scroll-left (max (- column
(window-width) -
3) 10)))))))
1855 ;;; Interactive word completion.
1856 ;;; Forces "previous-word" processing. Do we want to make this selectable?
1859 (defun ispell-complete-word (&optional interior-frag
)
1860 "Look up word before or under point in dictionary (see lookup-words command)
1861 and try to complete it. If optional INTERIOR-FRAG is non-nil then the word
1862 may be a character sequence inside of a word.
1864 Standard ispell choices are then available."
1866 (let ((cursor-location (point))
1868 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
1869 start end possibilities replacement
)
1870 (setq start
(car (cdr word
))
1871 end
(car (cdr (cdr word
)))
1874 (or (string= word
"") ; Will give you every word
1875 (lookup-words (concat (if interior-frag
"*") word
"*")
1876 ispell-complete-word-dict
)))
1877 (cond ((eq possibilities t
)
1878 (message "No word to complete"))
1879 ((null possibilities
)
1880 (message "No match for \"%s\"" word
))
1881 (t ; There is a modification...
1882 (cond ; Try and respect case of word.
1883 ((string-match "^[^A-Z]+$" word
)
1884 (setq possibilities
(mapcar 'downcase possibilities
)))
1885 ((string-match "^[^a-z]+$" word
)
1886 (setq possibilities
(mapcar 'upcase possibilities
)))
1887 ((string-match "^[A-Z]" word
)
1888 (setq possibilities
(mapcar 'capitalize possibilities
))))
1889 (save-window-excursion
1891 (ispell-command-loop possibilities nil word start end
)))
1893 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
1894 (ispell-add-per-file-word-list word
))
1895 (replacement ; REPLACEMENT WORD
1896 (delete-region start end
)
1897 (setq word
(if (atom replacement
) replacement
(car replacement
))
1898 cursor-location
(+ (- (length word
) (- end start
))
1901 (if (not (atom replacement
)) ; recheck spelling of replacement.
1903 (goto-char cursor-location
)
1904 (ispell-word nil t
)))))
1905 (if (get-buffer ispell-choices-buffer
)
1906 (kill-buffer ispell-choices-buffer
))))
1907 (ispell-pdict-save ispell-silently-savep
)
1908 (goto-char cursor-location
)))
1912 (defun ispell-complete-word-interior-frag ()
1913 "Completes word matching character sequence inside a word."
1915 (ispell-complete-word t
))
1918 ;;; **********************************************************************
1919 ;;; Ispell Minor Mode
1920 ;;; **********************************************************************
1922 (defvar ispell-minor-mode nil
1923 "Non-nil if Ispell minor mode is enabled.")
1924 ;; Variable indicating that ispell minor mode is active.
1925 (make-variable-buffer-local 'ispell-minor-mode
)
1927 (or (assq 'ispell-minor-mode minor-mode-alist
)
1928 (setq minor-mode-alist
1929 (cons '(ispell-minor-mode " Spell") minor-mode-alist
)))
1931 (defvar ispell-minor-keymap
1932 (let ((map (make-sparse-keymap)))
1933 (define-key map
" " 'ispell-minor-check
)
1934 (define-key map
"\r" 'ispell-minor-check
)
1936 "Keymap used for Ispell minor mode.")
1938 (or (not (boundp 'minor-mode-map-alist
))
1939 (assoc 'ispell-minor-mode minor-mode-map-alist
)
1940 (setq minor-mode-map-alist
1941 (cons (cons 'ispell-minor-mode ispell-minor-keymap
)
1942 minor-mode-map-alist
)))
1945 (defun ispell-minor-mode (&optional arg
)
1946 "Toggle Ispell minor mode.
1947 With prefix arg, turn Ispell minor mode on iff arg is positive.
1949 In Ispell minor mode, pressing SPC or RET
1950 warns you if the previous word is incorrectly spelled."
1952 (setq ispell-minor-mode
1953 (not (or (and (null arg
) ispell-minor-mode
)
1954 (<= (prefix-numeric-value arg
) 0))))
1955 (set-buffer-modified-p (buffer-modified-p)))
1957 (defun ispell-minor-check ()
1958 ;; Check previous word then continue with the normal binding of this key.
1960 (let ((ispell-minor-mode nil
)
1961 (ispell-check-only t
))
1963 (narrow-to-region (point-min) (point))
1964 (ispell-word nil t
))
1965 (call-interactively (key-binding (this-command-keys)))))
1968 ;;; **********************************************************************
1970 ;;; **********************************************************************
1971 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
1974 (defvar ispell-message-text-end
1975 (mapconcat (function identity
)
1977 ;; Matches postscript files.
1978 "^%!PS-Adobe-[23].0"
1979 ;; Matches uuencoded text
1980 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
1981 ;; Matches shell files (esp. auto-decoding)
1983 ;; Matches context difference listing
1984 "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
1985 ;; Matches "----------------- cut here"
1986 "^[-=_]+\\s ?cut here")
1988 "*End of text which will be checked in ispell-message.
1989 If it is a string, limit at first occurrence of that regular expression.
1990 Otherwise, it must be a function which is called to get the limit.")
1994 (defun ispell-message ()
1995 "Check the spelling of a mail message or news post.
1996 Don't check spelling of message headers except the Subject field.
1997 Don't check included messages.
1999 To abort spell checking of a message REGION and send the message anyway,
2000 use the `x' or `q' command. (Any subsequent regions will be checked.)
2001 The `X' command aborts the message send so that you can edit the buffer.
2003 To spell-check whenever a message is sent, include the appropriate lines
2004 in your .emacs file:
2005 (add-hook 'news-inews-hook 'ispell-message)
2006 (add-hook 'mail-send-hook 'ispell-message)
2007 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2009 You can bind this to the key C-c i in GNUS or mail by adding to
2010 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2011 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
2014 (goto-char (point-min))
2015 (let* ((internal-messagep (save-excursion
2018 (regexp-quote mail-header-separator
)
2023 ((not ispell-message-text-end
) (point-max))
2024 ((char-or-string-p ispell-message-text-end
)
2025 (if (re-search-forward ispell-message-text-end nil t
)
2028 (t (min (point-max) (funcall ispell-message-text-end
))))))
2029 (cite-regexp ;Prefix of inserted text
2031 ((featurep 'supercite
) ; sc 3.0
2032 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
2033 (ispell-non-empty-string sc-reference-tag-string
)))
2034 ((featurep 'sc
) ; sc 2.3
2035 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
2036 (ispell-non-empty-string sc-reference-tag-string
)))
2037 ((equal major-mode
'news-reply-mode
) ;GNUS
2038 (concat "In article <" "\\|"
2039 (if mail-yank-prefix
2040 (ispell-non-empty-string mail-yank-prefix
)
2042 ((equal major-mode
'mh-letter-mode
) ; mh mail message
2043 (ispell-non-empty-string mh-ins-buf-prefix
))
2044 ((not internal-messagep
) ; Assume n sent us this message.
2045 (concat "In [a-zA-Z.]+ you write:" "\\|"
2046 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
2048 ((boundp 'vm-included-text-prefix
) ; VM mail message
2049 (concat "[^,;&+=]+ writes:" "\\|"
2050 (ispell-non-empty-string vm-included-text-prefix
)))
2051 (mail-yank-prefix ; vanilla mail message.
2052 (ispell-non-empty-string mail-yank-prefix
))
2054 (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp
))
2055 (cite-regexp-end (concat "^\\(" cite-regexp
"\\)"))
2056 (old-case-fold-search case-fold-search
)
2057 (case-fold-search t
)
2058 (ispell-checking-message t
))
2059 (goto-char (point-min))
2060 ;; Skip header fields except Subject: without Re:'s
2061 ;;(search-forward mail-header-separator nil t)
2062 (while (if internal-messagep
2063 (< (point) internal-messagep
)
2064 (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
2066 (if (looking-at "Subject: *") ; Spell check new subject fields
2068 (goto-char (match-end 0))
2069 (if (and (not (looking-at ".*Re\\>"))
2070 (not (looking-at "\\[")))
2071 (let ((case-fold-search old-case-fold-search
))
2072 (ispell-region (point)
2075 (while (looking-at "\n[ \t]")
2079 (setq case-fold-search nil
)
2080 ;; Skip mail header, particularly for non-english languages.
2081 (if (looking-at mail-header-separator
)
2083 (while (< (point) limit
)
2084 ;; Skip across text cited from other messages.
2085 (while (and (looking-at cite-regexp-start
)
2087 (zerop (forward-line 1))))
2088 (if (< (point) limit
)
2089 ;; Check the next batch of lines that *aren't* cited.
2090 (let ((end (save-excursion
2091 (if (re-search-forward cite-regexp-end limit
'end
)
2093 (marker-position limit
)))))
2094 (ispell-region (point) end
)
2096 (set-marker limit nil
))))
2099 (defun ispell-non-empty-string (string)
2100 (if (or (not string
) (string-equal string
""))
2101 "\\'\\`" ; An unmatchable string if string is null.
2102 (regexp-quote string
)))
2105 ;;; **********************************************************************
2106 ;;; Buffer Local Functions
2107 ;;; **********************************************************************
2110 (defun ispell-accept-buffer-local-defs ()
2111 "Load all buffer-local information, restarting ispell when necessary."
2112 (ispell-buffer-local-dict) ; May kill ispell-process.
2113 (ispell-buffer-local-words) ; Will initialize ispell-process.
2114 (ispell-buffer-local-parsing))
2117 (defun ispell-buffer-local-parsing ()
2118 "Place Ispell into parsing mode for this buffer.
2119 Overrides the default parsing mode.
2120 Includes latex/nroff modes and extended character mode."
2121 ;; (ispell-init-process) must already be called.
2122 (process-send-string ispell-process
"!\n") ; Put process in terse mode.
2123 ;; We assume all major modes with "tex-mode" in them should use latex parsing
2124 (if (or (and (eq ispell-parser
'use-mode-name
)
2125 (string-match "[Tt][Ee][Xx]-mode" (symbol-name major-mode
)))
2126 (eq ispell-parser
'tex
))
2127 (process-send-string ispell-process
"+\n") ; set ispell mode to tex
2128 (process-send-string ispell-process
"-\n")) ; set mode to normal (nroff)
2129 ;; Set default extended character mode for given buffer, if any.
2130 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2131 (if extended-char-mode
2132 (process-send-string ispell-process
(concat extended-char-mode
"\n"))))
2133 ;; Set buffer-local parsing mode and extended character mode, if specified.
2135 (goto-char (point-min))
2136 ;; Uses last valid definition
2137 (while (search-forward ispell-parsing-keyword nil t
)
2138 (let ((end (save-excursion (end-of-line) (point)))
2139 (case-fold-search t
)
2141 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
2142 ;; space separated definitions.
2143 (setq string
(buffer-substring (match-beginning 1) (match-end 1)))
2144 (cond ((string-match "latex-mode" string
)
2145 (process-send-string ispell-process
"+\n~tex\n"))
2146 ((string-match "nroff-mode" string
)
2147 (process-send-string ispell-process
"-\n~nroff"))
2148 ((string-match "~" string
) ; Set extended character mode.
2149 (process-send-string ispell-process
(concat string
"\n")))
2150 (t (message "Illegal Ispell Parsing argument!")
2154 ;;; Can kill the current ispell process
2156 (defun ispell-buffer-local-dict ()
2157 "Initializes local dictionary.
2158 When a dictionary is defined in the buffer (see variable
2159 `ispell-dictionary-keyword'), it will override the local setting
2160 from \\[ispell-change-dictionary].
2161 Both should not be used to define a buffer-local dictionary."
2163 (goto-char (point-min))
2165 ;; Override the local variable definition.
2166 ;; Uses last valid definition.
2167 (while (search-forward ispell-dictionary-keyword nil t
)
2168 (setq end
(save-excursion (end-of-line) (point)))
2169 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
2170 (setq ispell-local-dictionary
2171 (buffer-substring (match-beginning 1) (match-end 1)))))
2172 (goto-char (point-min))
2173 (while (search-forward ispell-pdict-keyword nil t
)
2174 (setq end
(save-excursion (end-of-line) (point)))
2175 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
2176 (setq ispell-local-pdict
2177 (buffer-substring (match-beginning 1) (match-end 1)))))))
2178 ;; Reload if new personal dictionary defined.
2179 (if (and ispell-local-pdict
2180 (not (equal ispell-local-pdict ispell-personal-dictionary
)))
2182 (ispell-kill-ispell t
)
2183 (setq ispell-personal-dictionary ispell-local-pdict
)))
2184 ;; Reload if new dictionary defined.
2185 (if (and ispell-local-dictionary
2186 (not (equal ispell-local-dictionary ispell-dictionary
)))
2187 (ispell-change-dictionary ispell-local-dictionary
)))
2190 (defun ispell-buffer-local-words ()
2191 "Loads the buffer-local dictionary in the current buffer."
2192 (if (and ispell-buffer-local-name
2193 (not (equal ispell-buffer-local-name
(buffer-name))))
2195 (ispell-kill-ispell t
)
2196 (setq ispell-buffer-local-name nil
)))
2197 (ispell-init-process)
2199 (goto-char (point-min))
2200 (while (search-forward ispell-words-keyword nil t
)
2201 (or ispell-buffer-local-name
2202 (setq ispell-buffer-local-name
(buffer-name)))
2203 (let ((end (save-excursion (end-of-line) (point)))
2205 ;; buffer-local words separated by a space, and can contain
2206 ;; any character other than a space.
2207 (while (re-search-forward " *\\([^ ]+\\)" end t
)
2208 (setq string
(buffer-substring (match-beginning 1) (match-end 1)))
2209 (process-send-string ispell-process
(concat "@" string
"\n")))))))
2212 ;;; returns optionally adjusted region-end-point.
2214 (defun ispell-add-per-file-word-list (word &optional reg-end
)
2215 "Adds new word to the per-file word list."
2216 (or ispell-buffer-local-name
2217 (setq ispell-buffer-local-name
(buffer-name)))
2221 (goto-char (point-min))
2222 (let (case-fold-search line-okay search done string
)
2224 (setq search
(search-forward ispell-words-keyword nil
'move
)
2225 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
2226 (progn (end-of-line) (current-column)))
2228 (if (or (and search line-okay
)
2235 (setq string
(concat comment-start
" "
2236 ispell-words-keyword
))
2237 ;; in case the keyword is in the middle of the file....
2238 (if (> reg-end
(point))
2239 (setq reg-end
(+ reg-end
(length string
))))
2241 (if (and comment-end
(not (equal "" comment-end
)))
2245 (insert comment-end
)))))
2246 (if (> reg-end
(point))
2247 (setq reg-end
(+ 1 reg-end
(length word
))))
2248 (insert (concat " " word
)))))))
2252 (defconst ispell-version
"2.34 -- Thu Dec 8 13:17:41 EST 1994")
2257 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
2259 ;;; Local Variable options:
2260 ;;; mode: name(-mode)
2261 ;;; eval: expression
2262 ;;; local-variable: value
2264 ;;; The following sets the buffer local dictionary to english!
2266 ;;; Local Variables:
2267 ;;; mode: emacs-lisp
2268 ;;; comment-column: 40
2269 ;;; ispell-local-dictionary: "english"
2273 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
2275 ;;; The following places this file in nroff parsing and extended char modes.
2276 ;;; Local IspellParsing: nroff-mode ~nroff
2277 ;;; Change IspellDict to IspellDict: to enable the following line.
2278 ;;; Local IspellDict english
2279 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
2280 ;;; Local IspellPersDict ~/.ispell_lisp
2281 ;;; The following were automatically generated by ispell using the 'A' command:
2282 ; LocalWords: ispell ispell-highlight-p ispell-check-comments query-replace
2283 ; LocalWords: ispell-query-replace-choices ispell-skip-tib non-nil tib
2284 ; LocalWords: regexps ispell-tib-ref-beginning ispell-tib-ref-end
2286 ;; ispell.el ends here