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