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