]> code.delx.au - gnu-emacs/blob - lisp/textmodes/ispell.el
Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-28
[gnu-emacs] / lisp / textmodes / ispell.el
1 ;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
2
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2005
4 ;; Free Software Foundation, Inc.
5
6 ;; Author: Ken Stevens <k.stevens@ieee.org>
7 ;; Maintainer: Ken Stevens <k.stevens@ieee.org>
8 ;; Stevens Mod Date: Mon Jan 7 12:32:44 PST 2003
9 ;; Stevens Revision: 3.6
10 ;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
11 ;; Bug Reports : ispell-el-bugs@itcorp.com
12 ;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
13 ;; Keywords: unix wp
14
15 ;; This file is part of GNU Emacs.
16
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
21
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
26
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
30 ;; Boston, MA 02111-1307, USA.
31
32 ;; Note: version numbers and time stamp are not updated
33 ;; when this file is edited for release with GNU emacs.
34
35 ;;; Commentary:
36
37 ;; INSTRUCTIONS
38
39 ;; This code contains a section of user-settable variables that you
40 ;; should inspect prior to installation. Look past the end of the history
41 ;; list. Set them up for your locale and the preferences of the majority
42 ;; of the users. Otherwise the users may need to set a number of variables
43 ;; themselves.
44 ;; You particularly may want to change the default dictionary for your
45 ;; country and language.
46 ;; Most dictionary changes should be made in this file so all users can
47 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
48 ;; file. Use the variable `ispell-local-dictionary-alist' to specify
49 ;; your own dictionaries.
50
51 ;; Depending on the mail system you use, you may want to include these:
52 ;; (add-hook 'news-inews-hook 'ispell-message)
53 ;; (add-hook 'mail-send-hook 'ispell-message)
54 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
55
56 ;; Ispell has a TeX parser and a nroff parser (the default).
57 ;; The parsing is controlled by the variable ispell-parser. Currently
58 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
59 ;; added it will be updated. See the variable description for more info.
60
61
62 ;; TABLE OF CONTENTS
63
64 ;; ispell-word
65 ;; ispell-region
66 ;; ispell-buffer
67 ;; ispell-message
68 ;; ispell-comments-and-strings
69 ;; ispell-continue
70 ;; ispell-complete-word
71 ;; ispell-complete-word-interior-frag
72 ;; ispell-change-dictionary
73 ;; ispell-kill-ispell
74 ;; ispell-pdict-save
75 ;; ispell-skip-region-alist
76
77 ;; Commands in ispell-region:
78 ;; Character replacement: Replace word with choice. May query-replace.
79 ;; ` ': Accept word this time.
80 ;; `i': Accept word and insert into private dictionary.
81 ;; `a': Accept word for this session.
82 ;; `A': Accept word and place in buffer-local dictionary.
83 ;; `r': Replace word with typed-in value. Rechecked.
84 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
85 ;; `?': Show these commands
86 ;; `x': Exit spelling buffer. Move cursor to original point.
87 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
88 ;; the check to be completed later.
89 ;; `q': Quit spelling session (Kills ispell process).
90 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
91 ;; `u': Like `i', but the word is lower-cased first.
92 ;; `m': Place entered value in personal dictionary, then recheck current word.
93 ;; `C-l': redraws screen
94 ;; `C-r': recursive edit
95 ;; `C-z': suspend emacs or iconify frame
96
97 ;; Buffer-Local features:
98 ;; There are a number of buffer-local features that can be used to customize
99 ;; ispell for the current buffer. This includes language dictionaries,
100 ;; personal dictionaries, parsing, and local word spellings. Each of these
101 ;; local customizations are done either through local variables, or by
102 ;; including the keyword and argument(s) at the end of the buffer (usually
103 ;; prefixed by the comment characters). See the end of this file for
104 ;; examples. The local keywords and variables are:
105
106 ;; ispell-dictionary-keyword language-dictionary
107 ;; uses local variable ispell-local-dictionary
108 ;; ispell-pdict-keyword personal-dictionary
109 ;; uses local variable ispell-local-pdict
110 ;; ispell-parsing-keyword mode-arg extended-char-arg
111 ;; ispell-words-keyword any number of local word spellings
112
113 ;; Region skipping:
114 ;; Place new regular expression definitions of regions you prefer not to
115 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
116 ;; be added to latex by modifying `ispell-tex-skip-alists'.
117 ;; `ispell-message' contains some custom skipping code for e-mail messages.
118
119 ;; BUGS:
120 ;; Need a way to select between different character mappings without separate
121 ;; dictionary entries.
122 ;; Multi-byte characters if not defined by current dictionary may result in the
123 ;; evil "misalignment error" in some versions of MULE emacs.
124 ;; On some versions of emacs, growing the minibuffer fails.
125 ;; see `ispell-help-in-bufferp'.
126 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
127 ;; can cause misalignment errors.
128
129 ;; HISTORY
130
131 ;; Modifications made in latest versions:
132
133 ;; Revision 3.6 2003/01/07 12:32:44 kss
134 ;; Removed extra -d LIB in dictionary defs. (Pavel Janik)
135 ;; Filtered process calls with duplicate dictionary entries.
136 ;; Fixed bug where message-text-end is inside a mime skipped region.
137 ;; Minor fixes to get ispell menus right in XEmacs
138 ;; Fixed skip regexp so it doesn't match stuff like `/.\w'.
139 ;; Detecting dictionary change not working. Fixed. kss
140 ;; function `ispell-change-dictionary' now only completes valid dicts.
141
142 ;; Revision 3.5 2001/7/11 18:43:57 kss
143 ;; Added fix for aspell to work in XEmacs (ispell-check-version).
144 ;; Added Portuguese dictionary definition.
145 ;; New feature: MIME mail message support, Fcc support.
146 ;; Bug fix: retain comment syntax on lines with region skipping. (TeX $ bug...)
147 ;; Improved allocation for graphic mode lines. (Miles Bader)
148 ;; Support -v flag for old versions of aspell. (Eli Zaretskii)
149 ;; Clear minibuffer on ^G from ispell-help (Tak Ota)
150
151 ;; Revision 3.4 2000/8/4 09:41:50 kss
152 ;; Support new color display functions.
153 ;; Fixed misalignment offset bug when replacing a string after a shift made.
154 ;; Set to standard Author/Maintainer heading,
155 ;; ensure localwords lists are separated from the text by newline. (Dave Love)
156 ;; Added dictionary definition for Italian (William Deakin)
157 ;; HTML region skipping greatly improved. (Chuck D. Phillips)
158 ;; improved menus. Fixed regexp matching http/email addresses.
159 ;; one arg always for xemacs sleep-for (gunnar Evermann)
160 ;; support for synchronous processes (Eli Zaretskii)
161
162 ;; Revision 3.3 1999/11/29 11:38:34 kss
163 ;; Only word replacements entered in from the keyboard are rechecked.
164 ;; This fixes a bug in tex parsing and misalignment.
165 ;; Exceptions exist for recursive edit and query-replace, with tex error
166 ;; condition tested. Recursive editing improved.
167 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
168 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
169 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
170 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
171 ;; fonts.
172
173 ;; Revision 3.2 1999/5/7 14:25:14 kss
174 ;; Accept ispell versions 3.X.Y where X>=1
175 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
176 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
177 ;; Fixed bug in TeX parsing when math commands are in the comments.
178 ;; Removed calls to `when' macro.
179
180 ;; Revision 3.1 1998/12/1 13:21:52 kss
181 ;; Improved and fixed customize support.
182 ;; Improved and fixed comments in variables and messages.
183 ;; A coding system is now required for all languages.
184 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
185 ;; Dictionary norsk7-tex removed. Dictionary polish added.
186 ;; Dictionaries redefined at load-time to support dictionary changes.
187 ;; Menu redefined at load time to support dictionary changes.
188 ;; ispell-check-version added as an alias for `check-ispell-version'.
189 ;; Spelling suggestions returned in order generated by ispell.
190 ;; Small bug fixed in matching ispell error messages.
191 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
192 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
193 ;; Multibyte character coding support added for process interactions.
194 ;; Ensure ispell process has terminated before starting new process.
195 ;; This can otherwise confuse process filters and hang ispell.
196 ;; Improved skipping support for SGML.
197 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
198 ;; Improved message reference matching in `ispell-message'.
199 ;; Fixed bug in returning to nroff mode from tex mode.
200
201
202 ;;; Code:
203
204 ;;; Custom.el macros require recompiling this when they are not present.
205 ;;; Add in backward compatible custom support.
206 (eval-when-compile
207 (if (not (fboundp 'defcustom))
208 (defmacro defcustom (symbol value doc &rest args)
209 "Empty replacement for defcustom when not supplied."
210 `(defvar ,symbol ,value ,doc))))
211
212 (eval-when-compile
213 (if (not (fboundp 'defgroup))
214 (defmacro defgroup (&rest args)
215 "Empty replacement for defgroup when not supplied.")))
216
217 (defgroup ispell nil
218 "User variables for emacs ispell interface."
219 :group 'applications)
220
221 (if (not (fboundp 'buffer-substring-no-properties))
222 (defun buffer-substring-no-properties (start end)
223 (buffer-substring start end)))
224
225 (defalias 'check-ispell-version 'ispell-check-version)
226
227 ;;; **********************************************************************
228 ;;; The following variables should be set according to personal preference
229 ;;; and location of binaries:
230 ;;; **********************************************************************
231
232
233 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
234
235 (defcustom ispell-highlight-p 'block
236 "*Highlight spelling errors when non-nil.
237 When set to `block', assumes a block cursor with TTY displays."
238 :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t))
239 :group 'ispell)
240
241 (defcustom ispell-lazy-highlight (boundp 'lazy-highlight-cleanup)
242 "*Controls the lazy-highlighting of spelling errors.
243 When non-nil, all text in the buffer matching the current spelling
244 error is highlighted lazily using isearch lazy highlighting (see
245 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
246 :type 'boolean
247 :group 'lazy-highlight
248 :group 'ispell
249 :version "22.1")
250
251 (defcustom ispell-highlight-face (if ispell-lazy-highlight 'isearch 'highlight)
252 "*The face used for Ispell highlighting. For Emacses with overlays.
253 Possible values are `highlight', `modeline', `secondary-selection',
254 `region', and `underline'.
255 This variable can be set by the user to whatever face they desire.
256 It's most convenient if the cursor color and highlight color are
257 slightly different."
258 :type 'face
259 :group 'ispell)
260
261 (defcustom ispell-check-comments t
262 "*Spelling of comments checked when non-nil.
263 When set to `exclusive', ONLY comments are checked. (For code comments).
264 Warning! Not checking comments, when a comment start is embedded in strings,
265 may produce undesired results."
266 :type '(choice (const exclusive) (const :tag "off" nil) (const :tag "on" t))
267 :group 'ispell)
268
269 (defcustom ispell-query-replace-choices nil
270 "*Corrections made throughout region when non-nil.
271 Uses `query-replace' (\\[query-replace]) for corrections."
272 :type 'boolean
273 :group 'ispell)
274
275 (defcustom ispell-skip-tib nil
276 "*Does not spell check `tib' bibliography references when non-nil.
277 Skips any text between strings matching regular expressions
278 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
279
280 TeX users beware: Any field starting with [. will skip until a .] -- even
281 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
282 a [.5mm] type of number...."
283 :type 'boolean
284 :group 'ispell)
285
286 (defvar ispell-tib-ref-beginning "[[<]\\."
287 "Regexp matching the beginning of a Tib reference.")
288
289 (defvar ispell-tib-ref-end "\\.[]>]"
290 "Regexp matching the end of a Tib reference.")
291
292 (defcustom ispell-keep-choices-win t
293 "*When not nil, the `*Choices*' window remains for spelling session.
294 This minimizes redisplay thrashing."
295 :type 'boolean
296 :group 'ispell)
297
298 (defcustom ispell-choices-win-default-height 2
299 "*The default size of the `*Choices*' window, including mode line.
300 Must be greater than 1."
301 :type 'integer
302 :group 'ispell)
303
304 (defcustom ispell-program-name "ispell"
305 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
306 :type 'string
307 :group 'ispell)
308
309 (defcustom ispell-alternate-dictionary
310 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
311 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
312 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
313 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
314 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
315 ((file-exists-p "/usr/share/lib/dict/words")
316 "/usr/share/lib/dict/words")
317 ((file-exists-p "/sys/dict") "/sys/dict")
318 (t "/usr/dict/words"))
319 "*Alternate dictionary for spelling help."
320 :type '(choice file (const :tag "None" nil))
321 :group 'ispell)
322
323 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
324 "*Dictionary used for word completion."
325 :type '(choice file (const :tag "None" nil))
326 :group 'ispell)
327
328 (defcustom ispell-message-dictionary-alist nil
329 "*List used by `ispell-message' to select a new dictionary.
330 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
331 in the message headers, `ispell-local-dictionary' will be set to
332 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
333 E.g. you may use the following value:
334 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
335 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
336 :type '(repeat (cons regexp string))
337 :group 'ispell)
338
339
340 (defcustom ispell-message-fcc-skip 50000
341 "*Query before saving Fcc message copy if attachment larger than this value.
342 Always stores Fcc copy of message when nil."
343 :type '(choice integer (const :tag "off" nil))
344 :group 'ispell)
345
346
347 (defcustom ispell-grep-command "egrep"
348 "Name of the grep command for search processes."
349 :type 'string
350 :group 'ispell)
351
352 (defcustom ispell-grep-options "-i"
353 "String of options to use when running the program in `ispell-grep-command'.
354 Should probably be \"-i\" or \"-e\".
355 Some machines (like the NeXT) don't support \"-i\""
356 :type 'string
357 :group 'ispell)
358
359 (defcustom ispell-look-command
360 (cond ((file-exists-p "/bin/look") "/bin/look")
361 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
362 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
363 (t "look"))
364 "Name of the look command for search processes.
365 This must be an absolute file name."
366 :type 'file
367 :group 'ispell)
368
369 (defcustom ispell-look-p (file-exists-p ispell-look-command)
370 "*Non-nil means use `look' rather than `grep'.
371 Default is based on whether `look' seems to be available."
372 :type 'boolean
373 :group 'ispell)
374
375 (defcustom ispell-have-new-look nil
376 "*Non-nil means use the `-r' option (regexp) when running `look'."
377 :type 'boolean
378 :group 'ispell)
379
380 (defcustom ispell-look-options (if ispell-have-new-look "-dfr" "-df")
381 "String of command options for `ispell-look-command'."
382 :type 'string
383 :group 'ispell)
384
385 (defcustom ispell-use-ptys-p nil
386 "When non-nil, Emacs uses ptys to communicate with Ispell.
387 When nil, Emacs uses pipes."
388 :type 'boolean
389 :group 'ispell)
390
391 (defcustom ispell-following-word nil
392 "*Non-nil means `ispell-word' checks the word around or after point.
393 Otherwise `ispell-word' checks the preceding word."
394 :type 'boolean
395 :group 'ispell)
396
397 (defcustom ispell-help-in-bufferp nil
398 "*Non-nil means display interactive keymap help in a buffer.
399 The following values are supported:
400 nil Expand the minibuffer and display a short help message
401 there for a couple of seconds.
402 t Pop up a new buffer and display a short help message there
403 for a couple of seconds.
404 electric Pop up a new buffer and display a long help message there.
405 User can browse and then exit the help mode."
406 :type '(choice (const electric) (const :tag "off" nil) (const :tag "on" t))
407 :group 'ispell)
408
409 (defcustom ispell-quietly nil
410 "*Non-nil means suppress messages in `ispell-word'."
411 :type 'boolean
412 :group 'ispell)
413
414 (defcustom ispell-format-word (function upcase)
415 "*Formatting function for displaying word being spell checked.
416 The function must take one string argument and return a string."
417 :type 'function
418 :group 'ispell)
419
420 (defcustom ispell-use-framepop-p nil
421 "When non-nil ispell uses framepop to display choices in a dedicated frame.
422 You can set this variable to dynamically use framepop if you are in a
423 window system by evaluating the following on startup to set this variable:
424 (and window-system (condition-case () (require 'framepop) (error nil)))"
425 :type 'boolean
426 :group 'ispell)
427
428 ;;;###autoload
429 (defcustom ispell-personal-dictionary nil
430 "*File name of your personal spelling dictionary, or nil.
431 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
432 where DICTNAME is the name of your default dictionary."
433 :type '(choice file
434 (const :tag "default" nil))
435 :group 'ispell)
436
437 (defcustom ispell-silently-savep nil
438 "*When non-nil, save the personal dictionary without confirmation."
439 :type 'boolean
440 :group 'ispell)
441
442 (defvar ispell-local-dictionary-overridden nil
443 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
444 (make-variable-buffer-local 'ispell-local-dictionary)
445
446 (defcustom ispell-local-dictionary nil
447 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
448 The value must be a string dictionary name,
449 or nil, which means use the global setting in `ispell-dictionary'.
450 Dictionary names are defined in `ispell-local-dictionary-alist'
451 and `ispell-dictionary-alist',
452
453 Setting `ispell-local-dictionary' to a value has the same effect as
454 calling \\[ispell-change-dictionary] with that value. This variable
455 is automatically set when defined in the file with either
456 `ispell-dictionary-keyword' or the Local Variable syntax."
457 :type '(choice string
458 (const :tag "default" nil))
459 :group 'ispell)
460
461 (make-variable-buffer-local 'ispell-local-dictionary)
462
463 (defcustom ispell-extra-args nil
464 "*If non-nil, a list of extra switches to pass to the Ispell program.
465 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
466 words as correct. See also `ispell-dictionary-alist', which may be used
467 for language-specific arguments."
468 :type '(repeat string)
469 :group 'ispell)
470
471
472
473 (defcustom ispell-skip-html 'use-mode-name
474 "*Indicates whether ispell should skip spell checking of SGML markup.
475 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
476 guess whether SGML markup should be skipped according to the name of the
477 buffer's major mode."
478 :type '(choice (const :tag "always" t) (const :tag "never" nil)
479 (const :tag "use-mode-name" use-mode-name))
480 :group 'ispell)
481
482 (make-variable-buffer-local 'ispell-skip-html)
483
484
485 ;;;###autoload
486 (defcustom ispell-local-dictionary-alist nil
487 "*List of local or customized dictionary definitions.
488 These can override the values in `ispell-dictionary-alist'.
489
490 To make permanent changes to your dictionary definitions, you
491 will need to make your changes in this variable, save, and then
492 re-start emacs."
493 :type '(repeat (list (choice :tag "Dictionary"
494 (string :tag "Dictionary name")
495 (const :tag "default" nil))
496 (regexp :tag "Case characters")
497 (regexp :tag "Non case characters")
498 (regexp :tag "Other characters")
499 (boolean :tag "Many other characters")
500 (repeat :tag "Ispell command line args"
501 (string :tag "Arg"))
502 (choice :tag "Extended character mode"
503 (const "~tex") (const "~plaintex")
504 (const "~nroff") (const "~list")
505 (const "~latin1") (const "~latin3")
506 (const :tag "default" nil))
507 (choice :tag "Coding system"
508 (const iso-8859-1)
509 (const iso-8859-2)
510 (const koi8-r)
511 (const windows-1251))))
512 :group 'ispell)
513
514
515 ;;; split dictionary so line length is smaller in loaddefs.el
516
517 ;;; First part of dictionary, shortened for loaddefs.el
518 ;;;###autoload
519 (setq
520 ispell-dictionary-alist-1
521 '((nil ; default (English.aff)
522 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
523 ("american" ; Yankee English
524 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
525 ("brasileiro" ; Brazilian mode
526 "[A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
527 "[^A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
528 "[']" nil nil nil iso-8859-1)
529 ("british" ; British version
530 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
531 ("castellano" ; Spanish mode
532 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
533 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
534 "[-]" nil ("-B") "~tex" iso-8859-1)
535 ("castellano8" ; 8 bit Spanish mode
536 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
537 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
538 "[-]" nil ("-B" "-d" "castellano") "~latin1" iso-8859-1)))
539
540
541 ;;; Second part of dictionary, shortened for loaddefs.el
542 ;;;###autoload
543 (setq
544 ispell-dictionary-alist-2
545 '(("czech"
546 "[A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
547 "[^A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
548 "" nil ("-B") nil iso-8859-2)
549 ("dansk" ; Dansk.aff
550 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
551 "[']" nil ("-C") nil iso-8859-1)
552 ("deutsch" ; Deutsch.aff
553 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
554 ("deutsch8"
555 "[a-zA-Z\304\326\334\344\366\337\374]"
556 "[^a-zA-Z\304\326\334\344\366\337\374]"
557 "[']" t ("-C" "-d" "deutsch") "~latin1" iso-8859-1)
558 ("english" ; make English explicitly selectable
559 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)))
560
561
562 ;;; Third part of dictionary, shortened for loaddefs.el
563 ;;;###autoload
564 (setq
565 ispell-dictionary-alist-3
566 '(("esperanto"
567 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
568 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
569 "[-']" t ("-C") "~latin3" iso-8859-1)
570 ("esperanto-tex"
571 "[A-Za-z^\\]" "[^A-Za-z^\\]"
572 "[-'`\"]" t ("-C" "-d" "esperanto") "~tex" iso-8859-1)
573 ("francais7"
574 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil iso-8859-1)
575 ("francais" ; Francais.aff
576 "[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]"
577 "[^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]"
578 "[-']" t nil "~list" iso-8859-1)
579 ("francais-tex" ; Francais.aff
580 "[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\\]"
581 "[^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\\]"
582 "[-'^`\"]" t nil "~tex" iso-8859-1)))
583
584
585 ;;; Fourth part of dictionary, shortened for loaddefs.el
586 ;;;###autoload
587 (setq
588 ispell-dictionary-alist-4
589 '(("german" ; german.aff
590 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
591 ("german8" ; german.aff
592 "[a-zA-Z\304\326\334\344\366\337\374]"
593 "[^a-zA-Z\304\326\334\344\366\337\374]"
594 "[']" t ("-C" "-d" "german") "~latin1" iso-8859-1)
595 ("italiano" ; Italian.aff
596 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
597 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
598 "[-]" nil ("-B" "-d" "italian") "~tex" iso-8859-1)
599 ("nederlands" ; Nederlands.aff
600 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
601 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
602 "[']" t ("-C") nil iso-8859-1)
603 ("nederlands8" ; Dutch8.aff
604 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
605 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
606 "[']" t ("-C") nil iso-8859-1)))
607
608
609 ;;; Fifth part of dictionary, shortened for loaddefs.el
610 ;;;###autoload
611 (setq
612 ispell-dictionary-alist-5
613 '(("norsk" ; 8 bit Norwegian mode
614 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
615 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
616 "[\"]" nil nil "~list" iso-8859-1)
617 ("norsk7-tex" ; 7 bit Norwegian TeX mode
618 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
619 "[\"]" nil ("-d" "norsk") "~plaintex" iso-8859-1)
620 ("polish" ; Polish mode
621 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
622 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
623 "" nil nil nil iso-8859-2)
624 ("portugues" ; Portuguese mode
625 "[a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
626 "[^a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
627 "[']" t ("-C") "~latin1" iso-8859-1)))
628
629
630 ;;; Sixth part of dictionary, shortened for loaddefs.el
631 ;;;###autoload
632 (setq
633 ispell-dictionary-alist-6
634 ;; include Russian iso coding system too?
635 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
636 '(("russian" ; Russian.aff (KOI8-R charset)
637 "[\341\342\367\347\344\345\263\366\372\351\352\353\354\355\356\357\360\362\363\364\365\346\350\343\376\373\375\370\371\377\374\340\361\301\302\327\307\304\305\243\326\332\311\312\313\314\315\316\317\320\322\323\324\325\306\310\303\336\333\335\330\331\337\334\300\321]"
638 "[^\341\342\367\347\344\345\263\366\372\351\352\353\354\355\356\357\360\362\363\364\365\346\350\343\376\373\375\370\371\377\374\340\361\301\302\327\307\304\305\243\326\332\311\312\313\314\315\316\317\320\322\323\324\325\306\310\303\336\333\335\330\331\337\334\300\321]"
639 "" nil nil nil koi8-r)
640 ("russianw" ; russianw.aff (CP1251 charset)
641 "[\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
642 "[^\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
643 "" nil nil nil windows-1251)
644 ("slovak" ; Slovakian
645 "[A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
646 "[^A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
647 "" nil ("-B") nil iso-8859-2)
648 ("svenska" ; Swedish mode
649 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
650 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
651 "[']" nil ("-C") "~list" iso-8859-1)))
652
653
654 ;;;###autoload
655 (defvar ispell-dictionary-alist
656 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2
657 ispell-dictionary-alist-3 ispell-dictionary-alist-4
658 ispell-dictionary-alist-5 ispell-dictionary-alist-6)
659 "An alist of dictionaries and their associated parameters.
660
661 Each element of this list is also a list:
662
663 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
664 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
665
666 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
667 nil means the default dictionary.
668
669 CASECHARS is a regular expression of valid characters that comprise a
670 word.
671
672 NOT-CASECHARS is the opposite regexp of CASECHARS.
673
674 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
675 used to construct words in some special way. If OTHERCHARS characters follow
676 and precede characters from CASECHARS, they are parsed as part of a word,
677 otherwise they become word-breaks. As an example in English, assume the
678 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
679 \"Steven's\" are parsed as single words including the \"'\" character, but
680 \"Stevens'\" does not include the quote character as part of the word.
681 If you want OTHERCHARS to be empty, use the empty string.
682 Hint: regexp syntax requires the hyphen to be declared first here.
683
684 CASECHAS, NOT-CASECHARS, and OTHERCHARS must be a unibyte string
685 containing bytes of CHARACTER-SET. In addition, if they contain
686 a non-ASCII byte, the regular expression must be a single
687 `character set' construct that doesn't specify a character range
688 for non-ASCII bytes.
689
690 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
691 Otherwise only a single OTHERCHARS character is allowed to be part of any
692 single word.
693
694 ISPELL-ARGS is a list of additional arguments passed to the ispell
695 subprocess.
696
697 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
698 have been configured in an Ispell affix file. (For example, umlauts
699 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
700 in English. This has the same effect as the command-line `-T' option.
701 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
702 but the dictionary can control the extended character mode.
703 Both defaults can be overruled in a buffer-local fashion. See
704 `ispell-parsing-keyword' for details on this.
705
706 CHARACTER-SET used for languages with multibyte characters.
707
708 Note that the CASECHARS and OTHERCHARS slots of the alist should
709 contain the same character set as casechars and otherchars in the
710 LANGUAGE.aff file \(e.g., english.aff\).")
711
712 (defvar ispell-really-aspell nil) ; Non-nil if aspell extensions should be used
713
714
715
716
717 ;;; **********************************************************************
718 ;;; The following are used by ispell, and should not be changed.
719 ;;; **********************************************************************
720
721
722
723 ;;; The version must be 3.1 or greater for this version of ispell.el
724 ;;; There is an incompatibility between version 3.1.12 and lower versions.
725 (defconst ispell-required-version '(3 1 12)
726 "Ispell versions with which this version of ispell.el is known to work.")
727 (defvar ispell-offset -1
728 "Offset that maps protocol differences between ispell 3.1 versions.")
729
730 (defconst ispell-version "ispell.el 3.6 - 7-Jan-2003")
731
732
733 (defun ispell-check-version (&optional interactivep)
734 "Ensure that `ispell-program-name' is valid and the correct version.
735 Returns version number if called interactively.
736 Otherwise returns the library directory name, if that is defined."
737 ;; This is a little wasteful as we actually launch ispell twice: once
738 ;; to make sure it's the right version, and once for real. But people
739 ;; get confused by version mismatches *all* the time (and I've got the
740 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
741 ;; option is the only way I can think of to do this that works with
742 ;; all versions, since versions earlier than 3.0.09 didn't identify
743 ;; themselves on startup.
744 (interactive "p")
745 (let ((case-fold-search-val case-fold-search)
746 ;; avoid bugs when syntax of `.' changes in various default modes
747 (default-major-mode 'fundamental-mode)
748 (default-directory (or (and (boundp 'temporary-file-directory)
749 temporary-file-directory)
750 default-directory))
751 result status)
752 (save-excursion
753 (let ((buf (get-buffer " *ispell-tmp*")))
754 (if buf (kill-buffer buf)))
755 (set-buffer (get-buffer-create " *ispell-tmp*"))
756 (erase-buffer)
757 (unless (file-exists-p default-directory)
758 (setq default-directory (expand-file-name "~/")))
759 (setq status (call-process
760 ispell-program-name nil t nil
761 ;; aspell doesn't accept the -vv switch.
762 (let ((case-fold-search
763 (memq system-type '(ms-dos windows-nt)))
764 (speller
765 (file-name-nondirectory ispell-program-name)))
766 ;; Assume anything that isn't `aspell' is Ispell.
767 (if (string-match "\\`aspell" speller) "-v" "-vv"))))
768 (goto-char (point-min))
769 (if interactivep
770 ;; report version information of ispell and ispell.el
771 (progn
772 (end-of-line)
773 (setq result (concat (buffer-substring-no-properties (point-min)
774 (point))
775 ", "
776 ispell-version))
777 (message result))
778 ;; return library directory.
779 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t)
780 (setq result (buffer-substring (match-beginning 1) (match-end 1)))))
781 (goto-char (point-min))
782 (if (not (memq status '(0 nil)))
783 (error "%s exited with %s %s" ispell-program-name
784 (if (stringp status) "signal" "code") status))
785 (setq case-fold-search t
786 status (re-search-forward
787 (concat "\\<\\("
788 (format "%d" (car ispell-required-version))
789 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
790 nil t)
791 case-fold-search case-fold-search-val)
792 (if (or (not status) ; major version mismatch
793 (< (car (read-from-string (buffer-substring-no-properties
794 (match-beginning 2) (match-end 2))))
795 (car (cdr ispell-required-version)))) ; minor version mismatch
796 (error "%s version 3 release %d.%d.%d or greater is required"
797 ispell-program-name (car ispell-required-version)
798 (car (cdr ispell-required-version))
799 (car (cdr (cdr ispell-required-version))))
800 ;; check that it is the correct version.
801 (if (and (= (car (read-from-string (buffer-substring-no-properties
802 (match-beginning 2)(match-end 2))))
803 (car (cdr ispell-required-version)))
804 (< (car (read-from-string (buffer-substring-no-properties
805 (match-beginning 3)(match-end 3))))
806 (car (cdr (cdr ispell-required-version)))))
807 (setq ispell-offset 0))
808 ;; Check to see if it's really aspell.
809 (goto-char (point-min))
810 (let (case-fold-search)
811 (setq ispell-really-aspell
812 (and (search-forward "(but really Aspell " nil t) t))))
813 (kill-buffer (current-buffer)))
814 result))
815
816
817
818 ;;; The preparation of the menu bar menu must be autoloaded
819 ;;; because otherwise this file gets autoloaded every time Emacs starts
820 ;;; so that it can set up the menus and determine keyboard equivalents.
821
822
823 ;;;###autoload
824 (defvar ispell-menu-map nil "Key map for ispell menu.")
825 ;;; redo menu when loading ispell to get dictionary modifications
826 (setq ispell-menu-map nil)
827
828 ;;;###autoload
829 (defvar ispell-menu-xemacs nil
830 "Spelling menu for XEmacs.
831 If nil when package is loaded, a standard menu will be set,
832 and added as a submenu of the \"Edit\" menu.")
833
834 ;;; Break out XEmacs menu and split into several calls to avoid having
835 ;;; long lines in loaddefs.el. Detect need off following constant.
836
837 ;;; Set up dictionary
838 ;;;###autoload
839 (defvar ispell-menu-map-needed
840 ;; only needed when not version 18 and not XEmacs.
841 (and (not ispell-menu-map)
842 (not (featurep 'xemacs))
843 'reload))
844
845 (defvar ispell-library-directory (condition-case ()
846 (ispell-check-version)
847 (error nil))
848 "Directory where ispell dictionaries reside.")
849
850 (defvar ispell-process nil
851 "The process object for Ispell.")
852
853 (defvar ispell-async-processp (and (fboundp 'kill-process)
854 (fboundp 'process-send-string)
855 (fboundp 'accept-process-output)
856 ;;(fboundp 'start-process)
857 ;;(fboundp 'set-process-filter)
858 ;;(fboundp 'process-kill-without-query)
859 )
860 "Non-nil means that the OS supports asynchronous processes.")
861
862 (defun ispell-valid-dictionary-list ()
863 "Returns a list of valid dictionaries.
864 The variable `ispell-library-directory' defines the library location."
865 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist))
866 (dict-list (cons "default" nil))
867 name load-dict)
868 (dolist (dict dicts)
869 (setq name (car dict)
870 load-dict (car (cdr (member "-d" (nth 5 dict)))))
871 ;; Include if the dictionary is in the library, or dir not defined.
872 (if (and
873 name
874 ;; include all dictionaries if lib directory not known.
875 (or (not ispell-library-directory)
876 (file-exists-p (concat ispell-library-directory
877 "/" name ".hash"))
878 (file-exists-p (concat ispell-library-directory "/" name ".has"))
879 (and load-dict
880 (or (file-exists-p (concat ispell-library-directory
881 "/" load-dict ".hash"))
882 (file-exists-p (concat ispell-library-directory
883 "/" load-dict ".has"))))))
884 (setq dict-list (cons name dict-list))))
885 dict-list))
886
887 ;;;###autoload
888 (if ispell-menu-map-needed
889 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list)
890 (ispell-valid-dictionary-list)
891 ;; This case is used in loaddefs.el
892 ;; since ispell-valid-dictionary-list isn't defined then.
893 (mapcar (lambda (x) (or (car x) "default"))
894 ispell-dictionary-alist)))
895 (dict-map (make-sparse-keymap "Dictionaries")))
896 (setq ispell-menu-map (make-sparse-keymap "Spell"))
897 ;; add the dictionaries to the bottom of the list.
898 (if (not dicts)
899 (define-key ispell-menu-map [default]
900 '("Select Default Dict"
901 "Dictionary for which Ispell was configured"
902 . (lambda () (interactive)
903 (ispell-change-dictionary "default")))))
904 (fset 'ispell-dict-map dict-map)
905 (define-key ispell-menu-map [dictionaries]
906 `(menu-item "Select Dict" ispell-dict-map))
907 (dolist (name dicts)
908 (define-key dict-map (vector (intern name))
909 (cons (concat "Select " (capitalize name) " Dict")
910 `(lambda () (interactive)
911 (ispell-change-dictionary ,name)))))))
912
913 ;;; define commands in menu in opposite order you want them to appear.
914 ;;;###autoload
915 (if ispell-menu-map-needed
916 (progn
917 (define-key ispell-menu-map [ispell-change-dictionary]
918 '(menu-item "Change Dictionary..." ispell-change-dictionary
919 :help "Supply explicit dictionary file name"))
920 (define-key ispell-menu-map [ispell-kill-ispell]
921 '(menu-item "Kill Process" ispell-kill-ispell
922 :enable (and (boundp 'ispell-process) ispell-process
923 (eq (ispell-process-status) 'run))
924 :help "Terminate Ispell subprocess"))
925 (define-key ispell-menu-map [ispell-pdict-save]
926 '(menu-item "Save Dictionary"
927 (lambda () (interactive) (ispell-pdict-save t t))
928 :help "Save personal dictionary"))
929 (define-key ispell-menu-map [ispell-customize]
930 '(menu-item "Customize..."
931 (lambda () (interactive) (customize-group 'ispell))
932 :help "Customize spell checking options"))
933 (define-key ispell-menu-map [ispell-help]
934 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
935 '(menu-item "Help"
936 (lambda () (interactive) (describe-function 'ispell-help))
937 :help "Show standard Ispell keybindings and commands"))
938 (define-key ispell-menu-map [flyspell-mode]
939 '(menu-item "Automatic spell checking (Flyspell)"
940 flyspell-mode
941 :help "Check spelling while you edit the text"
942 :button (:toggle . flyspell-mode)))
943 (define-key ispell-menu-map [ispell-complete-word]
944 '(menu-item "Complete Word" ispell-complete-word
945 :help "Complete word at cursor using dictionary"))
946 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
947 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
948 :help "Complete word fragment at cursor"))))
949
950 ;;;###autoload
951 (if ispell-menu-map-needed
952 (progn
953 (define-key ispell-menu-map [ispell-continue]
954 '(menu-item "Continue Spell-Checking" ispell-continue
955 :enable (and (boundp 'ispell-region-end)
956 (marker-position ispell-region-end)
957 (equal (marker-buffer ispell-region-end)
958 (current-buffer)))
959 :help "Continue spell checking last region"))
960 (define-key ispell-menu-map [ispell-word]
961 '(menu-item "Spell-Check Word" ispell-word
962 :help "Spell-check word at cursor"))
963 (define-key ispell-menu-map [ispell-comments-and-strings]
964 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
965 :help "Spell-check only comments and strings"))))
966
967 ;;;###autoload
968 (if ispell-menu-map-needed
969 (progn
970 (define-key ispell-menu-map [ispell-region]
971 '(menu-item "Spell-Check Region" ispell-region
972 :enable mark-active
973 :help "Spell-check text in marked region"))
974 (define-key ispell-menu-map [ispell-message]
975 '(menu-item "Spell-Check Message" ispell-message
976 :help "Skip headers and included message text"))
977 (define-key ispell-menu-map [ispell-buffer]
978 '(menu-item "Spell-Check Buffer" ispell-buffer
979 :help "Check spelling of selected buffer"))
980 ;;(put 'ispell-region 'menu-enable 'mark-active)
981 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
982
983 ;;; XEmacs versions 19 & 20
984 (if (and (featurep 'xemacs)
985 (featurep 'menubar)
986 ;;(null ispell-menu-xemacs)
987 (not (and (boundp 'infodock-version) infodock-version)))
988 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list)
989 (reverse (ispell-valid-dictionary-list))))
990 (current-menubar (or current-menubar default-menubar))
991 (menu
992 '(["Help" (describe-function 'ispell-help) t]
993 ;;["Help" (popup-menu ispell-help-list) t]
994 ["Check Message" ispell-message t]
995 ["Check Buffer" ispell-buffer t]
996 ["Check Comments" ispell-comments-and-strings t]
997 ["Check Word" ispell-word t]
998 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
999 ["Continue Check" ispell-continue t]
1000 ["Complete Word Frag"ispell-complete-word-interior-frag t]
1001 ["Complete Word" ispell-complete-word t]
1002 ["Kill Process" ispell-kill-ispell t]
1003 ["Customize..." (customize-group 'ispell) t]
1004 ;; flyspell-mode may not be bound...
1005 ;;["flyspell" flyspell-mode
1006 ;; :style toggle :selected flyspell-mode ]
1007 "-"
1008 ["Save Personal Dict"(ispell-pdict-save t t) t]
1009 ["Change Dictionary" ispell-change-dictionary t])))
1010 (if (null dicts)
1011 (setq dicts (cons "default" nil)))
1012 (dolist (name dicts)
1013 (setq menu (append menu
1014 (list
1015 (vector
1016 (concat "Select " (capitalize name))
1017 (list 'ispell-change-dictionary name)
1018 t)))))
1019 (setq ispell-menu-xemacs menu)
1020 (if current-menubar
1021 (progn
1022 (if (car (find-menu-item current-menubar '("Cmds")))
1023 (progn
1024 ;; XEmacs 21.2
1025 (delete-menu-item '("Cmds" "Spell-Check"))
1026 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs))
1027 ;; previous
1028 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1029 (add-menu '("Edit") "Spell" ispell-menu-xemacs))))))
1030
1031 ;;; Allow incrementing characters as integers in XEmacs 20
1032 (if (and (featurep 'xemacs)
1033 (fboundp 'int-char))
1034 (fset 'ispell-int-char 'int-char)
1035 ;; Emacs and XEmacs 19 or earlier
1036 (fset 'ispell-int-char 'identity))
1037
1038
1039 ;;; **********************************************************************
1040
1041
1042 ;;; This variable contains the current dictionary being used if the ispell
1043 ;;; process is running.
1044 (defvar ispell-current-dictionary nil
1045 "The name of the current dictionary, or nil for the default.
1046 This is passed to the ispell process using the `-d' switch and is
1047 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1048
1049 (defvar ispell-dictionary nil
1050 "Default dictionary to use if `ispell-local-dictionary' is nil.")
1051
1052 (defun ispell-decode-string (str)
1053 "Decodes multibyte character strings.
1054 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1055 (if (and (or (featurep 'xemacs)
1056 (and (boundp 'enable-multibyte-characters)
1057 enable-multibyte-characters))
1058 (fboundp 'decode-coding-string)
1059 (ispell-get-coding-system))
1060 (decode-coding-string str (ispell-get-coding-system))
1061 str))
1062
1063 ;; Return a string decoded from Nth element of the current dictionary.
1064 (defun ispell-get-decoded-string (n)
1065 (let* ((slot (or
1066 (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1067 (assoc ispell-current-dictionary ispell-dictionary-alist)))
1068 (str (nth n slot)))
1069 (when (and (> (length str) 0)
1070 (not (multibyte-string-p str)))
1071 (setq str (ispell-decode-string str))
1072 (or (multibyte-string-p str)
1073 (setq str (string-to-multibyte str)))
1074 (setcar (nthcdr n slot) str))
1075 str))
1076
1077 (defun ispell-get-casechars ()
1078 (ispell-get-decoded-string 1))
1079 (defun ispell-get-not-casechars ()
1080 (ispell-get-decoded-string 2))
1081 (defun ispell-get-otherchars ()
1082 (ispell-get-decoded-string 3))
1083 (defun ispell-get-many-otherchars-p ()
1084 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1085 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1086 (defun ispell-get-ispell-args ()
1087 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1088 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1089 (defun ispell-get-extended-character-mode ()
1090 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1091 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1092 (defun ispell-get-coding-system ()
1093 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1094 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1095
1096
1097 (defvar ispell-pdict-modified-p nil
1098 "Non-nil means personal dictionary has modifications to be saved.")
1099
1100 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1101 ;;; When non-nil, the spell session is terminated.
1102 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1103 (defvar ispell-quit nil)
1104
1105 (defvar ispell-process-directory nil
1106 "The directory where `ispell-process' was started.")
1107
1108 (defvar ispell-filter nil
1109 "Output filter from piped calls to Ispell.")
1110
1111 (defvar ispell-filter-continue nil
1112 "Control variable for Ispell filter function.")
1113
1114 (defvar ispell-output-buffer nil
1115 "Buffer used for reading output of a synchronous Ispell subprocess.")
1116
1117 (defvar ispell-session-buffer nil
1118 "Buffer used for passing input to a synchronous Ispell subprocess.")
1119
1120 (defvar ispell-cmd-args nil
1121 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1122
1123 (defvar ispell-query-replace-marker (make-marker)
1124 "Marker for `query-replace' processing.")
1125
1126 (defvar ispell-recursive-edit-marker (make-marker)
1127 "Marker for return point from recursive edit.")
1128
1129 (defvar ispell-checking-message nil
1130 "Non-nil when we're checking a mail message.
1131 Set to the MIME boundary locations when checking messages.")
1132
1133 (defconst ispell-choices-buffer "*Choices*")
1134
1135 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1136
1137 ;;; *** Buffer Local Definitions ***
1138
1139 (defconst ispell-words-keyword "LocalWords: "
1140 "The keyword for local oddly-spelled words to accept.
1141 The keyword will be followed by any number of local word spellings.
1142 There can be multiple of these keywords in the file.")
1143
1144 (defconst ispell-dictionary-keyword "Local IspellDict: "
1145 "The keyword for a local dictionary to use.
1146 The keyword must be followed by a valid dictionary name, defined in
1147 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1148 When multiple occurrences exist, the last keyword
1149 definition is used.")
1150
1151 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1152 "The keyword for defining buffer local dictionaries.
1153 Keyword must be followed by the filename of a personal dictionary.
1154 The last occurring definition in the buffer will be used.")
1155
1156 (defconst ispell-parsing-keyword "Local IspellParsing: "
1157 "The keyword for overriding default Ispell parsing.
1158 The above keyword string should be followed by `latex-mode' or
1159 `nroff-mode' to put the current buffer into the desired parsing mode.
1160
1161 Extended character mode can be changed for this buffer by placing
1162 a `~' followed by an extended-character mode -- such as `~.tex'.
1163 The last occurring definition in the buffer will be used.")
1164
1165 ;;;###autoload
1166 (defvar ispell-skip-region-alist
1167 '((ispell-words-keyword forward-line)
1168 (ispell-dictionary-keyword forward-line)
1169 (ispell-pdict-keyword forward-line)
1170 (ispell-parsing-keyword forward-line)
1171 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1172 ;; assume multiline uuencoded file? "\nM.*$"?
1173 ("^begin [0-9][0-9][0-9] [^ \t]+$" . "\nend\n")
1174 ("^%!PS-Adobe-[123].0" . "\n%%EOF\n")
1175 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage"
1176 . "^---* End of [Ff]orwarded [Mm]essage")
1177 ;; Matches e-mail addresses, file names, http addresses, etc. The `-+'
1178 ;; pattern necessary for performance reasons when `-' part of word syntax.
1179 ("\\(--+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1180 ;; above checks /.\w sequences
1181 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1182 ;; This is a pretty complex regexp. It can be simplified to the following:
1183 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1184 ;; but some valid text will be skipped, e.g. "his/her". This could be
1185 ;; fixed up (at the expense of a moderately more complex regexp)
1186 ;; by not allowing "/" to be the character which triggers the
1187 ;; identification of the computer name, e.g.:
1188 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1189 )
1190 "Alist expressing beginning and end of regions not to spell check.
1191 The alist key must be a regular expression.
1192 Valid forms include:
1193 (KEY) - just skip the key.
1194 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1195 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1196 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1197
1198
1199
1200 ;;;###autoload
1201 (defvar ispell-tex-skip-alists
1202 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1203 ;; All the standard LaTeX keywords from L. Lamport's guide:
1204 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1205 ;; \label, \nocite, \rule (in ispell - rest included here)
1206 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1207 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1208 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1209 ;;("\\\\author" ispell-tex-arg-end)
1210 ("\\\\bibliographystyle" ispell-tex-arg-end)
1211 ("\\\\makebox" ispell-tex-arg-end 0)
1212 ("\\\\e?psfig" ispell-tex-arg-end)
1213 ("\\\\document\\(class\\|style\\)" .
1214 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1215 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1216 ;; equation, minipage, picture, tabular, tabular* (ispell)
1217 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1218 ("list" ispell-tex-arg-end 2)
1219 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1220 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1221 "*Lists of regions to be skipped in TeX mode.
1222 First list is used raw.
1223 Second list has key placed inside \\begin{}.
1224
1225 Delete or add any regions you want to be automatically selected
1226 for skipping in latex mode.")
1227
1228
1229 ;;;###autoload
1230 (defvar ispell-html-skip-alists
1231 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1232 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1233 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1234 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1235 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1236 ("<[tT][tT]/" "/")
1237 ("<[^ \t\n>]" ">")
1238 ("&[^ \t\n;]" "[; \t\n]"))
1239 "*Lists of start and end keys to skip in HTML buffers.
1240 Same format as `ispell-skip-region-alist'
1241 Note - substrings of other matches must come last
1242 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1243
1244
1245 (defvar ispell-local-pdict ispell-personal-dictionary
1246 "A buffer local variable containing the current personal dictionary.
1247 If non-nil, the value must be a string, which is a file name.
1248
1249 If you specify a personal dictionary for the current buffer which is
1250 different from the current personal dictionary, the effect is similar
1251 to calling \\[ispell-change-dictionary]. This variable is automatically
1252 set when defined in the file with either `ispell-pdict-keyword' or the
1253 local variable syntax.")
1254
1255 (make-variable-buffer-local 'ispell-local-pdict)
1256
1257 (defvar ispell-buffer-local-name nil
1258 "Contains the buffer name if local word definitions were used.
1259 Ispell is then restarted because the local words could conflict.")
1260
1261 (defvar ispell-parser 'use-mode-name
1262 "*Indicates whether ispell should parse the current buffer as TeX Code.
1263 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1264 Default parser is `nroff'.
1265 Currently the only other valid parser is `tex'.
1266
1267 You can set this variable in hooks in your init file -- eg:
1268
1269 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1270
1271 (defvar ispell-region-end (make-marker)
1272 "Marker that allows spelling continuations.")
1273
1274 (defvar ispell-check-only nil
1275 "If non-nil, `ispell-word' does not try to correct the word.")
1276
1277
1278 ;;; **********************************************************************
1279 ;;; **********************************************************************
1280
1281
1282
1283 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1284
1285
1286 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1287 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1288 If asynchronous subprocesses are not supported, call `ispell-filter' and
1289 pass it the output of the last ispell invocation."
1290 (if ispell-async-processp
1291 (accept-process-output ispell-process timeout-secs timeout-msecs)
1292 (if (null ispell-process)
1293 (error "No Ispell process to read output from!")
1294 (let ((buf ispell-output-buffer)
1295 ispell-output)
1296 (if (not (bufferp buf))
1297 (setq ispell-filter nil)
1298 (save-excursion
1299 (set-buffer buf)
1300 (setq ispell-output (buffer-substring-no-properties
1301 (point-min) (point-max))))
1302 (ispell-filter t ispell-output)
1303 (save-excursion
1304 (set-buffer buf)
1305 (erase-buffer)))))))
1306
1307 (defun ispell-send-replacement (misspelled replacement)
1308 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1309 This allows it to improve the suggestion list based on actual mispellings."
1310 (and ispell-really-aspell
1311 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1312
1313
1314 (defun ispell-send-string (string)
1315 "Send the string STRING to the Ispell process."
1316 (if ispell-async-processp
1317 (process-send-string ispell-process string)
1318 ;; Asynchronous subprocesses aren't supported on this losing system.
1319 ;; We keep all the directives passed to Ispell during the entire
1320 ;; session in a buffer, and pass them anew each time we invoke
1321 ;; Ispell to process another chunk of text. (Yes, I know this is a
1322 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1323 (let ((cmd (aref string 0))
1324 ;; The following commands are not passed to Ispell until
1325 ;; we have a *real* reason to invoke it.
1326 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1327 (default-major-mode 'fundamental-mode)
1328 (session-buf ispell-session-buffer)
1329 (output-buf ispell-output-buffer)
1330 (ispell-args ispell-cmd-args)
1331 (defdir ispell-process-directory)
1332 prev-pos)
1333 (save-excursion
1334 (set-buffer session-buf)
1335 (setq prev-pos (point))
1336 (setq default-directory defdir)
1337 (insert string)
1338 (if (not (memq cmd cmds-to-defer))
1339 (let (coding-system-for-read coding-system-for-write status)
1340 (if (and (boundp 'enable-multibyte-characters)
1341 enable-multibyte-characters)
1342 (setq coding-system-for-read (ispell-get-coding-system)
1343 coding-system-for-write (ispell-get-coding-system)))
1344 (set-buffer output-buf)
1345 (erase-buffer)
1346 (set-buffer session-buf)
1347 (setq status
1348 (apply 'call-process-region (point-min) (point-max)
1349 ispell-program-name nil
1350 output-buf nil
1351 "-a" "-m" ispell-args))
1352 (set-buffer output-buf)
1353 (goto-char (point-min))
1354 (save-match-data
1355 (if (not (looking-at "@(#) "))
1356 (error "Ispell error: %s"
1357 (buffer-substring-no-properties
1358 (point) (progn (end-of-line) (point)))))
1359 ;; If STRING is "^Z\n", we just started Ispell and need
1360 ;; to retain its version ID line in the output buffer.
1361 ;; Otherwise, remove the ID line, as it will confuse
1362 ;; `ispell-filter'.
1363 (or (string= string "\032\n")
1364 (progn
1365 (forward-line)
1366 (delete-region (point-min) (point))))
1367 ;; If STRING begins with ^ or any normal character, we need
1368 ;; to remove the last line from the session buffer, since it
1369 ;; was just spell-checked, and we don't want to check it again.
1370 ;; The same goes for the # command, since Ispell already saved
1371 ;; the personal dictionary.
1372 (set-buffer session-buf)
1373 (delete-region prev-pos (point))
1374 ;; Ispell run synchronously saves the personal dictionary
1375 ;; after each successful command. So we can remove any
1376 ;; lines in the session buffer that insert words into the
1377 ;; dictionary.
1378 (if (memq status '(0 nil))
1379 (let ((more-lines t))
1380 (goto-char (point-min))
1381 (while more-lines
1382 (if (looking-at "^\\*")
1383 (let ((start (point)))
1384 (forward-line)
1385 (delete-region start (point)))
1386 (setq more-lines (= 0 (forward-line))))))))))))))
1387
1388
1389 ;; Insert WORD while translating Latin characters to the equivalent
1390 ;; characters that is supported by buffer-file-coding-system.
1391
1392 (defun ispell-insert-word (word)
1393 (let ((pos (point)))
1394 (insert word)
1395 (if (char-table-p translation-table-for-input)
1396 (translate-region pos (point) translation-table-for-input))))
1397
1398 ;;;###autoload
1399 (defun ispell-word (&optional following quietly continue)
1400 "Check spelling of word under or before the cursor.
1401 If the word is not found in dictionary, display possible corrections
1402 in a window allowing you to choose one.
1403
1404 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1405 is non-nil when called interactively, then the following word
1406 \(rather than preceding\) is checked when the cursor is not over a word.
1407 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1408 when called interactively, non-corrective messages are suppressed.
1409
1410 With a prefix argument (or if CONTINUE is non-nil),
1411 resume interrupted spell-checking of a buffer or region.
1412
1413 Word syntax is controlled by the definition of the chosen dictionary,
1414 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1415
1416 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1417 or \\[ispell-region] to update the Ispell process.
1418
1419 return values:
1420 nil word is correct or spelling is accepted.
1421 0 word is inserted into buffer-local definitions.
1422 \"word\" word corrected from word list.
1423 \(\"word\" arg\) word is hand entered.
1424 quit spell session exited."
1425
1426 (interactive (list ispell-following-word ispell-quietly current-prefix-arg))
1427 (if continue
1428 (ispell-continue)
1429 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1430 (let ((cursor-location (point)) ; retain cursor location
1431 (word (ispell-get-word following))
1432 start end poss new-word replace)
1433 ;; De-structure return word info list.
1434 (setq start (car (cdr word))
1435 end (car (cdr (cdr word)))
1436 word (car word))
1437
1438 ;; now check spelling of word if it has 3 or more characters.
1439 (cond
1440 ((> (length word) 2)
1441 (or quietly
1442 (message "Checking spelling of %s..."
1443 (funcall ispell-format-word word)))
1444 (ispell-send-string "%\n") ; put in verbose mode
1445 (ispell-send-string (concat "^" word "\n"))
1446 ;; wait until ispell has processed word
1447 (while (progn
1448 (ispell-accept-output)
1449 (not (string= "" (car ispell-filter)))))
1450 ;;(ispell-send-string "!\n") ;back to terse mode.
1451 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1452 (if (and ispell-filter (listp ispell-filter))
1453 (if (> (length ispell-filter) 1)
1454 (error "Ispell and its process have different character maps")
1455 (setq poss (ispell-parse-output (car ispell-filter)))))
1456 (cond ((eq poss t)
1457 (or quietly
1458 (message "%s is correct"
1459 (funcall ispell-format-word word)))
1460 (and (fboundp 'extent-at)
1461 (extent-at start)
1462 (delete-extent (extent-at start))))
1463 ((stringp poss)
1464 (or quietly
1465 (message "%s is correct because of root %s"
1466 (funcall ispell-format-word word)
1467 (funcall ispell-format-word poss)))
1468 (and (fboundp 'extent-at)
1469 (extent-at start)
1470 (delete-extent (extent-at start))))
1471 ((null poss) (message "Error in ispell process"))
1472 (ispell-check-only ; called from ispell minor mode.
1473 (if (fboundp 'make-extent)
1474 (let ((ext (make-extent start end)))
1475 (set-extent-property ext 'face ispell-highlight-face)
1476 (set-extent-property ext 'priority 2000))
1477 (beep)
1478 (message "%s is incorrect"(funcall ispell-format-word word))))
1479 (t ; prompt for correct word.
1480 (save-window-excursion
1481 (setq replace (ispell-command-loop
1482 (car (cdr (cdr poss)))
1483 (car (cdr (cdr (cdr poss))))
1484 (car poss) start end)))
1485 (cond ((equal 0 replace)
1486 (ispell-add-per-file-word-list (car poss)))
1487 (replace
1488 (setq new-word (if (atom replace) replace (car replace))
1489 cursor-location (+ (- (length word) (- end start))
1490 cursor-location))
1491 (if (not (equal new-word (car poss)))
1492 (progn
1493 (delete-region start end)
1494 (setq start (point))
1495 (ispell-insert-word new-word)
1496 (setq end (point))))
1497 (if (not (atom replace)) ;recheck spelling of replacement
1498 (progn
1499 (if (car (cdr replace)) ; query replace requested
1500 (save-window-excursion
1501 (query-replace word new-word t)))
1502 (goto-char start)
1503 ;; single word could be split into multiple words
1504 (setq ispell-quit (not (ispell-region start end)))
1505 ))))
1506 ;; keep if rechecking word and we keep choices win.
1507 (if (get-buffer ispell-choices-buffer)
1508 (kill-buffer ispell-choices-buffer))))
1509 (ispell-pdict-save ispell-silently-savep)
1510 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1511 (if ispell-quit (setq ispell-quit nil replace 'quit))))
1512 (goto-char cursor-location) ; return to original location
1513 replace)))
1514
1515
1516 (defun ispell-get-word (following &optional extra-otherchars)
1517 "Return the word for spell-checking according to ispell syntax.
1518 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1519 is non-nil when called interactively, then the following word
1520 \(rather than preceding\) is checked when the cursor is not over a word.
1521 Optional second argument contains otherchars that can be included in word
1522 many times.
1523
1524 Word syntax is controlled by the definition of the chosen dictionary,
1525 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1526 (let* ((ispell-casechars (ispell-get-casechars))
1527 (ispell-not-casechars (ispell-get-not-casechars))
1528 (ispell-otherchars (ispell-get-otherchars))
1529 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1530 (word-regexp (concat ispell-casechars
1531 "+\\("
1532 (if (not (string= "" ispell-otherchars))
1533 (concat ispell-otherchars "?"))
1534 (if extra-otherchars
1535 (concat extra-otherchars "?"))
1536 ispell-casechars
1537 "+\\)"
1538 (if (or ispell-many-otherchars-p
1539 extra-otherchars)
1540 "*" "?")))
1541 did-it-once prevpt
1542 start end word)
1543 ;; find the word
1544 (if (not (looking-at ispell-casechars))
1545 (if following
1546 (re-search-forward ispell-casechars (point-max) t)
1547 (re-search-backward ispell-casechars (point-min) t)))
1548 ;; move to front of word
1549 (re-search-backward ispell-not-casechars (point-min) 'start)
1550 (while (and (or (and (not (string= "" ispell-otherchars))
1551 (looking-at ispell-otherchars))
1552 (and extra-otherchars (looking-at extra-otherchars)))
1553 (not (bobp))
1554 (or (not did-it-once)
1555 ispell-many-otherchars-p)
1556 (not (eq prevpt (point))))
1557 (if (and extra-otherchars (looking-at extra-otherchars))
1558 (progn
1559 (backward-char 1)
1560 (if (looking-at ispell-casechars)
1561 (re-search-backward ispell-not-casechars (point-min) 'move)))
1562 (setq did-it-once t
1563 prevpt (point))
1564 (backward-char 1)
1565 (if (looking-at ispell-casechars)
1566 (re-search-backward ispell-not-casechars (point-min) 'move)
1567 (backward-char -1))))
1568 ;; Now mark the word and save to string.
1569 (if (not (re-search-forward word-regexp (point-max) t))
1570 (if ispell-check-only
1571 ;; return dummy word when just flagging misspellings
1572 (list "" (point) (point))
1573 (error "No word found to check!"))
1574 (setq start (match-beginning 0)
1575 end (point)
1576 word (buffer-substring-no-properties start end))
1577 (list word start end))))
1578
1579
1580 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1581 ;;; tracks changes in the dictionary. The global may either be
1582 ;;; a value or a list, whose value is the state of whether the
1583 ;;; dictionary needs to be saved.
1584
1585 ;;;###autoload
1586 (defun ispell-pdict-save (&optional no-query force-save)
1587 "Check to see if the personal dictionary has been modified.
1588 If so, ask if it needs to be saved."
1589 (interactive (list ispell-silently-savep t))
1590 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1591 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1592 (if (or ispell-pdict-modified-p force-save)
1593 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1594 (progn
1595 (ispell-send-string "#\n") ; save dictionary
1596 (message "Personal dictionary saved."))))
1597 ;; unassert variable, even if not saved to avoid questioning.
1598 (setq ispell-pdict-modified-p nil))
1599
1600
1601 (defun ispell-command-loop (miss guess word start end)
1602 "Display possible corrections from list MISS.
1603 GUESS lists possibly valid affix construction of WORD.
1604 Returns nil to keep word.
1605 Returns 0 to insert locally into buffer-local dictionary.
1606 Returns string for new chosen word.
1607 Returns list for new replacement word (will be rechecked).
1608 Query-replace when list length is 2.
1609 Automatic query-replace when second element is `query-replace'.
1610 Highlights the word, which is assumed to run from START to END.
1611 Global `ispell-pdict-modified-p' becomes a list where the only value
1612 indicates whether the dictionary has been modified when option `a' or `i' is
1613 used.
1614 Global `ispell-quit' set to start location to continue spell session."
1615 (let ((count ?0)
1616 (line ispell-choices-win-default-height)
1617 ;; ensure 4 context lines.
1618 (max-lines (- (ispell-adjusted-window-height) 4))
1619 (choices miss)
1620 (window-min-height (min window-min-height
1621 ispell-choices-win-default-height))
1622 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1623 (dedicated (window-dedicated-p (selected-window)))
1624 (skipped 0)
1625 char num result textwin dedicated-win)
1626
1627 ;; setup the *Choices* buffer with valid data.
1628 (save-excursion
1629 (set-buffer (get-buffer-create ispell-choices-buffer))
1630 (setq mode-line-format (concat "-- %b -- word: " word))
1631 ;; XEmacs: no need for horizontal scrollbar in choices window
1632 (with-no-warnings
1633 (and (fboundp 'set-specifier)
1634 (boundp 'horizontal-scrollbar-visible-p)
1635 (set-specifier horizontal-scrollbar-visible-p nil
1636 (cons (current-buffer) nil))))
1637 (erase-buffer)
1638 (if guess
1639 (progn
1640 (insert "Affix rules generate and capitalize "
1641 "this word as shown below:\n\t")
1642 (while guess
1643 (if (> (+ 4 (current-column) (length (car guess)))
1644 (window-width))
1645 (progn
1646 (insert "\n\t")
1647 (setq line (1+ line))))
1648 (insert (car guess) " ")
1649 (setq guess (cdr guess)))
1650 (insert "\nUse option `i' if this is a correct composition"
1651 " from the derivative root.\n")
1652 (setq line (+ line (if choices 3 2)))))
1653 (while (and choices
1654 (< (if (> (+ 7 (current-column) (length (car choices))
1655 (if (> count ?~) 3 0))
1656 (window-width))
1657 (progn
1658 (insert "\n")
1659 (setq line (1+ line)))
1660 line)
1661 max-lines))
1662 ;; not so good if there are over 20 or 30 options, but then, if
1663 ;; there are that many you don't want to scan them all anyway...
1664 (while (memq count command-characters) ; skip command characters.
1665 (setq count (ispell-int-char (1+ count))
1666 skipped (1+ skipped)))
1667 (insert "(" count ") " (car choices) " ")
1668 (setq choices (cdr choices)
1669 count (ispell-int-char (1+ count))))
1670 (setq count (ispell-int-char (- count ?0 skipped))))
1671
1672 ;; ensure word is visible
1673 (if (not (pos-visible-in-window-p end))
1674 (sit-for 0))
1675
1676 ;; allow temporary split of dedicated windows...
1677 (if dedicated
1678 (progn
1679 (setq dedicated-win (selected-window))
1680 (set-window-dedicated-p dedicated-win nil)))
1681
1682 ;; Display choices for misspelled word.
1683 (ispell-show-choices line end)
1684 (select-window (setq textwin (next-window)))
1685
1686 ;; highlight word, protecting current buffer status
1687 (unwind-protect
1688 (progn
1689 (and ispell-highlight-p
1690 (ispell-highlight-spelling-error start end t))
1691 ;; Loop until a valid choice is made.
1692 (while
1693 (eq
1694 t
1695 (setq
1696 result
1697 (progn
1698 (undo-boundary)
1699 (let (message-log-max)
1700 (message (concat "C-h or ? for more options; SPC to leave "
1701 "unchanged, Character to replace word")))
1702 (let ((inhibit-quit t))
1703 (setq char (if (fboundp 'read-char-exclusive)
1704 (read-char-exclusive)
1705 (read-char))
1706 skipped 0)
1707 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1708 (setq char ?X
1709 quit-flag nil)))
1710 ;; Adjust num to array offset skipping command characters.
1711 (let ((com-chars command-characters))
1712 (while com-chars
1713 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1714 (setq skipped (1+ skipped)))
1715 (setq com-chars (cdr com-chars)))
1716 (setq num (- char ?0 skipped)))
1717
1718 (cond
1719 ((= char ? ) nil) ; accept word this time only
1720 ((= char ?i) ; accept and insert word into pers dict
1721 (ispell-send-string (concat "*" word "\n"))
1722 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1723 nil)
1724 ((or (= char ?a) (= char ?A)) ; accept word without insert
1725 (ispell-send-string (concat "@" word "\n"))
1726 (if (null ispell-pdict-modified-p)
1727 (setq ispell-pdict-modified-p
1728 (list ispell-pdict-modified-p)))
1729 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1730 ((or (= char ?r) (= char ?R)) ; type in replacement
1731 (and (eq 'block ispell-highlight-p) ; refresh tty's
1732 (ispell-highlight-spelling-error start end nil t))
1733 (let ((result
1734 (if (or (= char ?R) ispell-query-replace-choices)
1735 (list (read-string
1736 (format "Query-replacement for %s: "word)
1737 word)
1738 t)
1739 (cons (read-string "Replacement for: " word)
1740 nil))))
1741 (and (eq 'block ispell-highlight-p)
1742 (ispell-highlight-spelling-error start end nil
1743 'block))
1744 result))
1745 ((or (= char ??) (= char help-char) (= char ?\C-h))
1746 (and (eq 'block ispell-highlight-p)
1747 (ispell-highlight-spelling-error start end nil t))
1748 (ispell-help)
1749 (and (eq 'block ispell-highlight-p)
1750 (ispell-highlight-spelling-error start end nil
1751 'block))
1752 t)
1753 ;; Quit and move point back.
1754 ((= char ?x)
1755 (ispell-pdict-save ispell-silently-savep)
1756 (message "Exited spell-checking")
1757 (setq ispell-quit t)
1758 nil)
1759 ;; Quit and preserve point.
1760 ((= char ?X)
1761 (ispell-pdict-save ispell-silently-savep)
1762 (message "%s"
1763 (substitute-command-keys
1764 (concat "Spell-checking suspended;"
1765 " use C-u \\[ispell-word] to resume")))
1766 (setq ispell-quit start)
1767 nil)
1768 ((= char ?q)
1769 (if (y-or-n-p "Really kill Ispell process? ")
1770 (progn
1771 (ispell-kill-ispell t) ; terminate process.
1772 (setq ispell-quit (or (not ispell-checking-message)
1773 (point))
1774 ispell-pdict-modified-p nil))
1775 t)) ; continue if they don't quit.
1776 ((= char ?l)
1777 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1778 (ispell-highlight-spelling-error start end nil t))
1779 (let ((new-word (read-string
1780 "Lookup string (`*' is wildcard): "
1781 word)))
1782 (if new-word
1783 (progn
1784 (save-excursion
1785 (set-buffer (get-buffer-create
1786 ispell-choices-buffer))
1787 (erase-buffer)
1788 (setq count ?0
1789 skipped 0
1790 mode-line-format (concat
1791 "-- %b -- word: "
1792 new-word)
1793 miss (lookup-words new-word)
1794 choices miss
1795 line ispell-choices-win-default-height)
1796 (while (and choices ; adjust choices window.
1797 (< (if (> (+ 7 (current-column)
1798 (length (car choices))
1799 (if (> count ?~) 3 0))
1800 (window-width))
1801 (progn
1802 (insert "\n")
1803 (setq line (1+ line)))
1804 line)
1805 max-lines))
1806 (while (memq count command-characters)
1807 (setq count (ispell-int-char (1+ count))
1808 skipped (1+ skipped)))
1809 (insert "(" count ") " (car choices) " ")
1810 (setq choices (cdr choices)
1811 count (ispell-int-char (1+ count))))
1812 (setq count (ispell-int-char
1813 (- count ?0 skipped))))
1814 (ispell-show-choices line end)
1815 (select-window (next-window)))))
1816 (and (eq 'block ispell-highlight-p)
1817 (ispell-highlight-spelling-error start end nil
1818 'block))
1819 t) ; reselect from new choices
1820 ((= char ?u) ; insert lowercase into dictionary
1821 (ispell-send-string (concat "*" (downcase word) "\n"))
1822 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1823 nil)
1824 ((= char ?m) ; type in what to insert
1825 (ispell-send-string
1826 (concat "*" (read-string "Insert: " word) "\n"))
1827 (setq ispell-pdict-modified-p '(t))
1828 (cons word nil))
1829 ((and (>= num 0) (< num count))
1830 (if ispell-query-replace-choices ; Query replace flag
1831 (list (nth num miss) 'query-replace)
1832 (nth num miss)))
1833 ((= char ?\C-l)
1834 (redraw-display) t)
1835 ((= char ?\C-r)
1836 ;; This may have alignment errors if current line is edited
1837 (if (marker-position ispell-recursive-edit-marker)
1838 (progn
1839 (message "Only one recursive edit session supported")
1840 (beep)
1841 (sit-for 2))
1842 (set-marker ispell-recursive-edit-marker start)
1843 ;;(set-marker ispell-region-end reg-end)
1844 (and ispell-highlight-p ; unhighlight
1845 (ispell-highlight-spelling-error start end))
1846 (unwind-protect
1847 (progn
1848 (message
1849 "%s"
1850 (substitute-command-keys
1851 (concat "Exit recursive edit with"
1852 " \\[exit-recursive-edit]")))
1853 (save-window-excursion (save-excursion
1854 (recursive-edit))))
1855 ;; protected
1856 (goto-char ispell-recursive-edit-marker)
1857 (if (not (equal (marker-buffer
1858 ispell-recursive-edit-marker)
1859 (current-buffer)))
1860 (progn
1861 (set-marker ispell-recursive-edit-marker nil)
1862 (error
1863 "Cannot continue ispell from this buffer.")))
1864 (set-marker ispell-recursive-edit-marker nil)))
1865 (list word nil)) ; recheck starting at this word.
1866 ((= char ?\C-z)
1867 (funcall (key-binding "\C-z"))
1868 t)
1869 (t (ding) t))))))
1870 result)
1871 ;; protected
1872 (and ispell-highlight-p ; unhighlight
1873 (save-window-excursion
1874 (select-window textwin)
1875 (ispell-highlight-spelling-error start end)))
1876 (if dedicated
1877 (set-window-dedicated-p dedicated-win t)))))
1878
1879
1880
1881 (defun ispell-show-choices (line end)
1882 "Shows the choices in another buffer or frame."
1883 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
1884 (progn
1885 (framepop-display-buffer (get-buffer ispell-choices-buffer))
1886 ;;; (get-buffer-window ispell-choices-buffer t)
1887 (select-window (previous-window))) ; *Choices* window
1888 ;; standard selection by splitting a small buffer out of this window.
1889 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1890 (if choices-window
1891 (if (= line (ispell-adjusted-window-height choices-window))
1892 (select-window choices-window)
1893 ;; *Choices* window changed size. Adjust the choices window
1894 ;; without scrolling the spelled window when possible
1895 (let ((window-line
1896 (- line (ispell-adjusted-window-height choices-window)))
1897 (visible (progn (vertical-motion -1) (point))))
1898 (if (< line ispell-choices-win-default-height)
1899 (setq window-line (+ window-line
1900 (- ispell-choices-win-default-height
1901 line))))
1902 (move-to-window-line 0)
1903 (vertical-motion window-line)
1904 (set-window-start (selected-window)
1905 (if (> (point) visible) visible (point)))
1906 (goto-char end)
1907 (select-window choices-window)
1908 (enlarge-window window-line)))
1909 ;; Overlay *Choices* window when it isn't showing
1910 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1911 (switch-to-buffer ispell-choices-buffer)
1912 (goto-char (point-min)))))
1913
1914
1915 ;;;###autoload
1916 (defun ispell-help ()
1917 "Display a list of the options available when a misspelling is encountered.
1918
1919 Selections are:
1920
1921 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1922 SPC: Accept word this time.
1923 `i': Accept word and insert into private dictionary.
1924 `a': Accept word for this session.
1925 `A': Accept word and place in `buffer-local dictionary'.
1926 `r': Replace word with typed-in value. Rechecked.
1927 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1928 `?': Show these commands.
1929 `x': Exit spelling buffer. Move cursor to original point.
1930 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1931 the aborted check to be completed later.
1932 `q': Quit spelling session (Kills ispell process).
1933 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1934 `u': Like `i', but the word is lower-cased first.
1935 `m': Place typed-in value in personal dictionary, then recheck current word.
1936 `C-l': redraws screen
1937 `C-r': recursive edit
1938 `C-z': suspend emacs or iconify frame"
1939
1940 (if (equal ispell-help-in-bufferp 'electric)
1941 (progn
1942 (require 'ehelp)
1943 (with-electric-help
1944 (function (lambda ()
1945 ;;This shouldn't be necessary: with-electric-help needs
1946 ;; an optional argument telling it about the smallest
1947 ;; acceptable window-height of the help buffer.
1948 ;;(if (< (window-height) 15)
1949 ;; (enlarge-window
1950 ;; (- 15 (ispell-adjusted-window-height))))
1951 (princ "Selections are:
1952
1953 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1954 SPC: Accept word this time.
1955 `i': Accept word and insert into private dictionary.
1956 `a': Accept word for this session.
1957 `A': Accept word and place in `buffer-local dictionary'.
1958 `r': Replace word with typed-in value. Rechecked.
1959 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1960 `?': Show these commands.
1961 `x': Exit spelling buffer. Move cursor to original point.
1962 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1963 the aborted check to be completed later.
1964 `q': Quit spelling session (Kills ispell process).
1965 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1966 `u': Like `i', but the word is lower-cased first.
1967 `m': Place typed-in value in personal dictionary, then recheck current word.
1968 `C-l': redraws screen
1969 `C-r': recursive edit
1970 `C-z': suspend emacs or iconify frame")
1971 nil ;undocumented requirement of with-electric-help
1972 ))))
1973
1974
1975 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1976 "[i]nsert into private dictionary"))
1977 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1978 "e[x/X]it; [q]uit session"))
1979 (help-3 (concat "[u]ncapitalized insert into dict. "
1980 "Type 'x C-h f ispell-help' for more help")))
1981 (save-window-excursion
1982 (if ispell-help-in-bufferp
1983 (progn
1984 (ispell-overlay-window 4)
1985 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1986 (insert (concat help-1 "\n" help-2 "\n" help-3))
1987 (sit-for 5)
1988 (kill-buffer "*Ispell Help*"))
1989 (unwind-protect
1990 (let ((resize-mini-windows 'grow-only))
1991 (select-window (minibuffer-window))
1992 (erase-buffer)
1993 (message nil)
1994 ;;(set-minibuffer-window (selected-window))
1995 (enlarge-window 2)
1996 (insert (concat help-1 "\n" help-2 "\n" help-3))
1997 (sit-for 5))
1998 (erase-buffer)))))))
1999
2000
2001 (defun lookup-words (word &optional lookup-dict)
2002 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2003 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2004 Otherwise the variable `ispell-grep-command' contains the command used to
2005 search for the words (usually egrep).
2006
2007 Optional second argument contains the dictionary to use; the default is
2008 `ispell-alternate-dictionary'."
2009 ;; We don't use the filter for this function, rather the result is written
2010 ;; into a buffer. Hence there is no need to save the filter values.
2011 (if (null lookup-dict)
2012 (setq lookup-dict ispell-alternate-dictionary))
2013
2014 (let* ((process-connection-type ispell-use-ptys-p)
2015 (wild-p (string-match "\\*" word))
2016 (look-p (and ispell-look-p ; Only use look for an exact match.
2017 (or ispell-have-new-look (not wild-p))))
2018 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2019 (prog (if look-p ispell-look-command ispell-grep-command))
2020 (args (if look-p ispell-look-options ispell-grep-options))
2021 status results loc)
2022 (unwind-protect
2023 (save-window-excursion
2024 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
2025 (set-buffer ispell-grep-buffer)
2026 (if look-p
2027 nil
2028 ;; convert * to .*
2029 (insert "^" word "$")
2030 (while (search-backward "*" nil t) (insert "."))
2031 (setq word (buffer-string))
2032 (erase-buffer))
2033 (setq status (if lookup-dict
2034 (call-process prog nil t nil args word lookup-dict)
2035 (call-process prog nil t nil args word)))
2036 ;; grep returns status 1 and no output when word not found, which
2037 ;; is a perfectly normal thing.
2038 (if (stringp status)
2039 (setq results (cons (format "error: %s exited with signal %s"
2040 (file-name-nondirectory prog) status)
2041 results))
2042 ;; else collect words into `results' in FIFO order
2043 (goto-char (point-max))
2044 ;; assure we've ended with \n
2045 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
2046 (while (not (bobp))
2047 (setq loc (point))
2048 (forward-line -1)
2049 (setq results (cons (buffer-substring-no-properties (point)
2050 (1- loc))
2051 results)))))
2052 ;; protected
2053 (kill-buffer ispell-grep-buffer)
2054 (if (and results (string-match ".+: " (car results)))
2055 (error "%s error: %s" ispell-grep-command (car results))))
2056 results))
2057
2058
2059 ;;; "ispell-filter" is a list of output lines from the generating function.
2060 ;;; Each full line (ending with \n) is a separate item on the list.
2061 ;;; "output" can contain multiple lines, part of a line, or both.
2062 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
2063 ;;; multiple lines.
2064 ;;; "ispell-filter-continue" is true when we have received only part of a
2065 ;;; line as output from a generating function ("output" did not end with \n)
2066 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2067 ;;; This is the case when a process dies or fails. The default behavior
2068 ;;; in this case treats the next input received as fresh input.
2069
2070 (defun ispell-filter (process output)
2071 "Output filter function for ispell, grep, and look."
2072 (let ((start 0)
2073 (continue t)
2074 end)
2075 (while continue
2076 (setq end (string-match "\n" output start)) ; get text up to the newline.
2077 ;; If we get out of sync and ispell-filter-continue is asserted when we
2078 ;; are not continuing, treat the next item as a separate list. When
2079 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2080 ;; list!
2081
2082 ;; Continue with same line (item)?
2083 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
2084 ;; Yes. Add it to the prev item
2085 (setcar ispell-filter
2086 (concat (car ispell-filter) (substring output start end)))
2087 ;; No. This is a new line and item.
2088 (setq ispell-filter
2089 (cons (substring output start end) ispell-filter)))
2090 (if (null end)
2091 ;; We've completed reading the output, but didn't finish the line.
2092 (setq ispell-filter-continue t continue nil)
2093 ;; skip over newline, this line complete.
2094 (setq ispell-filter-continue nil end (1+ end))
2095 (if (= end (length output)) ; No more lines in output
2096 (setq continue nil) ; so we can exit the filter.
2097 (setq start end)))))) ; else move start to next line of input
2098
2099
2100 ;;; This function destroys the mark location if it is in the word being
2101 ;;; highlighted.
2102 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
2103 refresh)
2104 "Highlight the word from START to END with a kludge using `inverse-video'.
2105 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2106 otherwise it is displayed normally.
2107 Uses block cursor to highlight one character.
2108 Optional REFRESH will unhighlighted then highlight, using block cursor
2109 highlighting when REFRESH is equal to `block'."
2110 (and (eq 'block ispell-highlight-p)
2111 (or (eq 'block refresh)
2112 (setq start (1+ start)))) ; On block non-refresh, inc start.
2113 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2114 (buffer-read-only nil) ; Allow highlighting read-only buffers.
2115 (text (buffer-substring-no-properties start end)) ; Save hilight region
2116 (inhibit-quit t) ; inhibit interrupt processing here.
2117 (buffer-undo-list t)) ; don't clutter the undo list.
2118 (goto-char end)
2119 (delete-region start end)
2120 (insert-char ? (- end start)) ; minimize amount of redisplay
2121 (sit-for 0) ; update display
2122 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2123 (delete-region start end) ; delete whitespace
2124 (insert text) ; insert text in inverse video.
2125 (sit-for 0) ; update display showing inverse video.
2126 (if (not highlight)
2127 (goto-char end)
2128 (setq inverse-video (not inverse-video)) ; toggle video
2129 (and (eq 'block ispell-highlight-p)
2130 (goto-char (1- start)))) ; use block cursor to "highlight" char
2131 (set-buffer-modified-p modified) ; don't modify if flag not set.
2132 (and refresh ; re-highlight
2133 (ispell-highlight-spelling-error-generic
2134 (if (eq 'block refresh) start (- start 2)) end t))))
2135
2136
2137 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
2138 "Highlight the word from START to END using `isearch-highlight'.
2139 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2140 otherwise it is displayed normally."
2141 (if highlight
2142 (isearch-highlight start end)
2143 (isearch-dehighlight))
2144 ;;(sit-for 0)
2145 )
2146
2147
2148 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
2149 "Highlight the word from START to END using overlays.
2150 When the optional third arg HIGHLIGHT is set, the word is highlighted
2151 otherwise it is displayed normally.
2152
2153 The variable `ispell-highlight-face' selects the face to use for highlighting."
2154 (if highlight
2155 (progn
2156 (setq ispell-overlay (make-overlay start end))
2157 (overlay-put ispell-overlay 'priority 1) ;higher than lazy overlays
2158 (overlay-put ispell-overlay 'face ispell-highlight-face))
2159 (delete-overlay ispell-overlay))
2160 (if (and ispell-lazy-highlight (boundp 'lazy-highlight-cleanup))
2161 (if highlight
2162 (let ((isearch-string
2163 (concat
2164 "\\b"
2165 (regexp-quote (buffer-substring-no-properties start end))
2166 "\\b"))
2167 (isearch-regexp t)
2168 (isearch-case-fold-search nil))
2169 (isearch-lazy-highlight-new-loop
2170 (if (boundp 'reg-start) reg-start)
2171 (if (boundp 'reg-end) reg-end)))
2172 (lazy-highlight-cleanup lazy-highlight-cleanup)
2173 (setq isearch-lazy-highlight-last-string nil))))
2174
2175
2176 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2177 (cond
2178 ((featurep 'xemacs)
2179 (ispell-highlight-spelling-error-xemacs start end highlight))
2180 ((and (featurep 'faces)
2181 (or (and (fboundp 'display-color-p) (display-color-p))
2182 window-system))
2183 (ispell-highlight-spelling-error-overlay start end highlight))
2184 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2185
2186 (defun ispell-adjusted-window-height (&optional window)
2187 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2188 The value returned is actually the nominal number of text-lines in the
2189 window plus 1. On a terminal, this is the same value returned by
2190 `window-height', but if the window has a mode-line is taller than a normal
2191 text line, the returned value may be smaller than that from
2192 `window-height'."
2193 (cond ((fboundp 'window-text-height)
2194 (1+ (window-text-height window)))
2195 ((or (and (fboundp 'display-graphic-p) (display-graphic-p))
2196 (and (featurep 'xemacs) window-system))
2197 (1- (window-height window)))
2198 (t
2199 (window-height window))))
2200
2201 (defun ispell-overlay-window (height)
2202 "Create a window covering the top HEIGHT lines of the current window.
2203 Ensure that the line above point is still visible but otherwise avoid
2204 scrolling the current window. Leave the new window selected."
2205 (save-excursion
2206 (let ((oldot (save-excursion (vertical-motion -1) (point)))
2207 (top (save-excursion (move-to-window-line height) (point))))
2208 ;; If line above old point (line starting at oldot) would be
2209 ;; hidden by new window, scroll it to just below new win
2210 ;; otherwise set top line of other win so it doesn't scroll.
2211 (if (< oldot top) (setq top oldot))
2212 ;; if frame is unsplitable, temporarily disable that...
2213 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2214 (let ((frame (selected-frame)))
2215 (modify-frame-parameters frame '((unsplittable . nil)))
2216 (split-window nil height)
2217 (modify-frame-parameters frame '((unsplittable . t))))
2218 (split-window nil height))
2219 (let ((deficit (- height (ispell-adjusted-window-height))))
2220 (when (> deficit 0)
2221 ;; Number of lines the window is still too short. We ensure that
2222 ;; there are at least (1- HEIGHT) lines visible in the window.
2223 (enlarge-window deficit)
2224 (goto-char top)
2225 (vertical-motion deficit)
2226 (setq top (min (point) oldot))))
2227 (set-window-start (next-window) top))))
2228
2229
2230 ;;; Should we add a compound word match return value?
2231 (defun ispell-parse-output (output &optional accept-list shift)
2232 "Parse the OUTPUT string from Ispell process and return:
2233 1: t for an exact match.
2234 2: A string containing the root word matched via suffix removal.
2235 3: A list of possible correct spellings of the format:
2236 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2237 ORIGINAL-WORD is a string of the possibly misspelled word.
2238 OFFSET is an integer giving the line offset of the word.
2239 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2240 4: nil when an error has occurred.
2241
2242 Optional second arg ACCEPT-LIST is list of words already accepted.
2243 Optional third arg SHIFT is an offset to apply based on previous corrections."
2244 (cond
2245 ((string= output "") t) ; for startup with pipes...
2246 ((string= output "*") t) ; exact match
2247 ((string= output "-") t) ; compound word match
2248 ((eq (aref output 0) ?+) ; found because of root word
2249 (substring output 2)) ; return root word
2250 ((equal 0 (string-match "[\ra-zA-Z]" output))
2251 (ding) ; error message from ispell!
2252 (message (concat "Ispell error: " output))
2253 (sit-for 5)
2254 nil)
2255 (t ; need to process &, ?, and #'s
2256 (let ((type (aref output 0)) ; &, ?, or #
2257 (original-word (substring output 2 (string-match " " output 2)))
2258 (cur-count 0) ; contains number of misses + guesses
2259 count miss-list guess-list offset)
2260 (setq output (substring output (match-end 0))) ; skip over misspelling
2261 (if (eq type ?#)
2262 (setq count 0) ; no misses for type #
2263 (setq count (string-to-int output) ; get number of misses.
2264 output (substring output (1+ (string-match " " output 1)))))
2265 (setq offset (string-to-int output))
2266 (if (eq type ?#) ; No miss or guess list.
2267 (setq output nil)
2268 (setq output (substring output (1+ (string-match " " output 1)))))
2269 (while output
2270 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2271 (setq cur-count (1+ cur-count))
2272 (if (> cur-count count)
2273 (setq guess-list (cons (substring output 0 end) guess-list))
2274 (setq miss-list (cons (substring output 0 end) miss-list)))
2275 (if (match-end 1) ; True only when at end of line.
2276 (setq output nil) ; no more misses or guesses
2277 (setq output (substring output (+ end 2))))))
2278 ;; return results. Accept word if it was already accepted.
2279 ;; adjust offset.
2280 (if (member original-word accept-list)
2281 t
2282 (list original-word
2283 (if (numberp shift) (+ shift offset) offset)
2284 (nreverse miss-list) (nreverse guess-list)))))))
2285
2286
2287 (defun ispell-process-status ()
2288 "Return the status of the Ispell process.
2289 When asynchronous processes are not supported, `run' is always returned."
2290 (if ispell-async-processp
2291 (process-status ispell-process)
2292 (and ispell-process 'run)))
2293
2294
2295 (defun ispell-start-process ()
2296 "Start the ispell process, with support for no asynchronous processes.
2297 Keeps argument list for future ispell invocations for no async support."
2298 (let (args)
2299 ;; Local dictionary becomes the global dictionary in use.
2300 (setq ispell-current-dictionary
2301 (or ispell-local-dictionary ispell-dictionary))
2302 (setq args (ispell-get-ispell-args))
2303 (if (and ispell-current-dictionary ; use specified dictionary
2304 (not (member "-d" args))) ; only define if not overridden
2305 (setq args
2306 (append (list "-d" ispell-current-dictionary) args)))
2307 (if ispell-personal-dictionary ; use specified pers dict
2308 (setq args
2309 (append args
2310 (list "-p"
2311 (expand-file-name ispell-personal-dictionary)))))
2312 (setq args (append args ispell-extra-args))
2313
2314 (if ispell-async-processp
2315 (let ((process-connection-type ispell-use-ptys-p))
2316 (apply 'start-process
2317 "ispell" nil ispell-program-name
2318 "-a" ; accept single input lines
2319 "-m" ; make root/affix combos not in dict
2320 args))
2321 (setq ispell-cmd-args args
2322 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2323 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2324 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2325 t)))
2326
2327
2328
2329 (defun ispell-init-process ()
2330 "Check status of Ispell process and start if necessary."
2331 (if (and ispell-process
2332 (eq (ispell-process-status) 'run)
2333 ;; If we're using a personal dictionary, ensure
2334 ;; we're in the same default directory!
2335 (or (not ispell-personal-dictionary)
2336 (equal ispell-process-directory default-directory)))
2337 (setq ispell-filter nil ispell-filter-continue nil)
2338 ;; may need to restart to select new personal dictionary.
2339 (ispell-kill-ispell t)
2340 (message "Starting new Ispell process...")
2341 (sit-for 0)
2342 (setq ispell-library-directory (ispell-check-version)
2343 ispell-process-directory default-directory
2344 ispell-process (ispell-start-process)
2345 ispell-filter nil
2346 ispell-filter-continue nil)
2347 (if ispell-async-processp
2348 (set-process-filter ispell-process 'ispell-filter))
2349 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
2350 (if (and (or (featurep 'xemacs)
2351 (and (boundp 'enable-multibyte-characters)
2352 enable-multibyte-characters))
2353 (fboundp 'set-process-coding-system))
2354 (set-process-coding-system ispell-process (ispell-get-coding-system)
2355 (ispell-get-coding-system)))
2356 ;; Get version ID line
2357 (ispell-accept-output 3)
2358 ;; get more output if filter empty?
2359 (if (null ispell-filter) (ispell-accept-output 3))
2360 (cond ((null ispell-filter)
2361 (error "%s did not output version line" ispell-program-name))
2362 ((and
2363 (stringp (car ispell-filter))
2364 (if (string-match "warning: " (car ispell-filter))
2365 (progn
2366 (ispell-accept-output 3) ; was warn msg.
2367 (stringp (car ispell-filter)))
2368 (null (cdr ispell-filter)))
2369 (string-match "^@(#) " (car ispell-filter)))
2370 ;; got the version line as expected (we already know it's the right
2371 ;; version, so don't bother checking again.)
2372 nil)
2373 (t
2374 ;; Otherwise, it must be an error message. Show the user.
2375 ;; But first wait to see if some more output is going to arrive.
2376 ;; Otherwise we get cool errors like "Can't open ".
2377 (sleep-for 1)
2378 (ispell-accept-output 3)
2379 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2380 (setq ispell-filter nil) ; Discard version ID line
2381 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2382 (if extended-char-mode ; ~ extended character mode
2383 (ispell-send-string (concat extended-char-mode "\n"))))
2384 (if ispell-async-processp
2385 (set-process-query-on-exit-flag ispell-process nil))))
2386
2387 ;;;###autoload
2388 (defun ispell-kill-ispell (&optional no-error)
2389 "Kill current Ispell process (so that you may start a fresh one).
2390 With NO-ERROR, just return non-nil if there was no Ispell running."
2391 (interactive)
2392 (if (not (and ispell-process
2393 (eq (ispell-process-status) 'run)))
2394 (or no-error
2395 (error "There is no ispell process running!"))
2396 (if ispell-async-processp
2397 (progn
2398 (process-send-eof ispell-process)
2399 (if (eq (ispell-process-status) 'run)
2400 (ispell-accept-output 1))
2401 (if (eq (ispell-process-status) 'run)
2402 (kill-process ispell-process))
2403 (while (not (or (eq (ispell-process-status) 'exit)
2404 (eq (ispell-process-status) 'signal)))
2405 (sleep-for 0.25)))
2406 ;; synchronous processes
2407 (ispell-send-string "\n") ; make sure side effects occurred.
2408 (kill-buffer ispell-output-buffer)
2409 (kill-buffer ispell-session-buffer)
2410 (setq ispell-output-buffer nil
2411 ispell-session-buffer nil))
2412 (setq ispell-process nil)
2413 (message "Ispell process killed")
2414 nil))
2415
2416
2417 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2418 ;;; call ispell-init-process rather than wait for a spell checking command?
2419
2420 ;;;###autoload
2421 (defun ispell-change-dictionary (dict &optional arg)
2422 "Change to dictionary DICT for Ispell.
2423 With a prefix arg, set it \"globally\", for all buffers.
2424 Without a prefix arg, set it \"locally\", just for this buffer.
2425
2426 By just answering RET you can find out what the current dictionary is."
2427 (interactive
2428 (list (completing-read
2429 "Use new dictionary (RET for current, SPC to complete): "
2430 (and (fboundp 'ispell-valid-dictionary-list)
2431 (mapcar 'list (ispell-valid-dictionary-list)))
2432 nil t)
2433 current-prefix-arg))
2434 (unless arg (ispell-accept-buffer-local-defs))
2435 (if (equal dict "default") (setq dict nil))
2436 ;; This relies on completing-read's bug of returning "" for no match
2437 (cond ((equal dict "")
2438 (message "Using %s dictionary"
2439 (or ispell-local-dictionary ispell-dictionary "default")))
2440 ((equal dict (or ispell-local-dictionary
2441 ispell-dictionary "default"))
2442 ;; Specified dictionary is the default already. No-op
2443 (and (interactive-p)
2444 (message "No change, using %s dictionary" dict)))
2445 (t ; reset dictionary!
2446 (if (or (assoc dict ispell-local-dictionary-alist)
2447 (assoc dict ispell-dictionary-alist))
2448 (if arg
2449 ;; set default dictionary
2450 (setq ispell-dictionary dict)
2451 ;; set local dictionary
2452 (setq ispell-local-dictionary dict)
2453 (setq ispell-local-dictionary-overridden t))
2454 (error "Undefined dictionary: %s" dict))
2455 (message "%s Ispell dictionary set to %s"
2456 (if arg "Global" "Local")
2457 dict))))
2458
2459 (defun ispell-internal-change-dictionary ()
2460 "Update the dictionary actually used by Ispell.
2461 This may kill the Ispell process; if so,
2462 a new one will be started when needed."
2463 (let ((dict (or ispell-local-dictionary ispell-dictionary)))
2464 (unless (equal ispell-current-dictionary dict)
2465 (setq ispell-current-dictionary dict)
2466 (ispell-kill-ispell t))))
2467
2468
2469 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2470
2471 ;;;###autoload
2472 (defun ispell-region (reg-start reg-end &optional recheckp shift)
2473 "Interactively check a region for spelling errors.
2474 Return nil if spell session is quit,
2475 otherwise returns shift offset amount for last line processed."
2476 (interactive "r") ; Don't flag errors on read-only bufs.
2477 (if (not recheckp)
2478 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2479 (let ((skip-region-start (make-marker))
2480 (rstart (make-marker)))
2481 (unwind-protect
2482 (save-excursion
2483 (message "Spell checking %s using %s dictionary..."
2484 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2485 (buffer-name) "region")
2486 (or ispell-current-dictionary "default"))
2487 ;; Returns cursor to original location.
2488 (save-window-excursion
2489 (goto-char reg-start)
2490 (let ((transient-mark-mode)
2491 (case-fold-search case-fold-search)
2492 (query-fcc t)
2493 in-comment key)
2494 (let (message-log-max)
2495 (message "searching for regions to skip"))
2496 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t)
2497 (progn
2498 (setq key (buffer-substring-no-properties
2499 (match-beginning 0) (match-end 0)))
2500 (set-marker skip-region-start (- (point) (length key)))
2501 (goto-char reg-start)))
2502 (let (message-log-max)
2503 (message "Continuing spelling check using %s dictionary..."
2504 (or ispell-current-dictionary "default")))
2505 (set-marker rstart reg-start)
2506 (set-marker ispell-region-end reg-end)
2507 (while (and (not ispell-quit)
2508 (< (point) ispell-region-end))
2509 ;; spell-check region with skipping
2510 (if (and (marker-position skip-region-start)
2511 (<= skip-region-start (point)))
2512 (progn
2513 ;; If region inside line comment, must keep comment start.
2514 (setq in-comment (point)
2515 in-comment
2516 (and comment-start
2517 (or (null comment-end) (string= "" comment-end))
2518 (save-excursion
2519 (beginning-of-line)
2520 (re-search-forward comment-start in-comment t))
2521 comment-start))
2522 ;; Can change skip-regexps (in ispell-message)
2523 (ispell-skip-region key) ; moves pt past region.
2524 (set-marker rstart (point))
2525 ;; check for saving large attachments...
2526 (setq query-fcc (and query-fcc
2527 (ispell-ignore-fcc skip-region-start
2528 rstart)))
2529 (if (and (< rstart ispell-region-end)
2530 (re-search-forward
2531 (ispell-begin-skip-region-regexp)
2532 ispell-region-end t))
2533 (progn
2534 (setq key (buffer-substring-no-properties
2535 (car (match-data))
2536 (car (cdr (match-data)))))
2537 (set-marker skip-region-start
2538 (- (point) (length key)))
2539 (goto-char rstart))
2540 (set-marker skip-region-start nil))))
2541 (setq reg-end (max (point)
2542 (if (marker-position skip-region-start)
2543 (min skip-region-start ispell-region-end)
2544 (marker-position ispell-region-end))))
2545 (let* ((start (point))
2546 (end (save-excursion (end-of-line) (min (point) reg-end)))
2547 (string (ispell-get-line start end in-comment)))
2548 (if in-comment ; account for comment chars added
2549 (setq start (- start (length in-comment))
2550 in-comment nil))
2551 (setq end (point)) ; "end" tracks region retrieved.
2552 (if string ; there is something to spell check!
2553 ;; (special start end)
2554 (setq shift (ispell-process-line string
2555 (and recheckp shift))))
2556 (goto-char end)))))
2557 (if ispell-quit
2558 nil
2559 (or shift 0)))
2560 ;; protected
2561 (if (and (not (and recheckp ispell-keep-choices-win))
2562 (get-buffer ispell-choices-buffer))
2563 (kill-buffer ispell-choices-buffer))
2564 (set-marker skip-region-start nil)
2565 (set-marker rstart nil)
2566 (if ispell-quit
2567 (progn
2568 ;; preserve or clear the region for ispell-continue.
2569 (if (not (numberp ispell-quit))
2570 (set-marker ispell-region-end nil)
2571 ;; Ispell-continue enabled - ispell-region-end is set.
2572 (goto-char ispell-quit))
2573 ;; Check for aborting
2574 (if (and ispell-checking-message (numberp ispell-quit))
2575 (progn
2576 (setq ispell-quit nil)
2577 (error "Message send aborted")))
2578 (if (not recheckp) (setq ispell-quit nil)))
2579 (if (not recheckp) (set-marker ispell-region-end nil))
2580 ;; Only save if successful exit.
2581 (ispell-pdict-save ispell-silently-savep)
2582 (message "Spell-checking done")))))
2583
2584
2585 (defun ispell-begin-skip-region-regexp ()
2586 "Returns a regexp of the search keys for region skipping.
2587 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2588 Must call after ispell-buffer-local-parsing due to dependence on mode."
2589 ;; start with regions generic to all buffers
2590 (let ((skip-regexp (ispell-begin-skip-region ispell-skip-region-alist)))
2591 ;; Comments
2592 (if (and (null ispell-check-comments) comment-start)
2593 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2594 skip-regexp)))
2595 (if (and (eq 'exclusive ispell-check-comments) comment-start)
2596 ;; search from end of current comment to start of next comment.
2597 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2598 (regexp-quote comment-end))
2599 "\\|" skip-regexp)))
2600 ;; tib
2601 (if ispell-skip-tib
2602 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
2603 ;; html stuff
2604 (if ispell-skip-html
2605 (setq skip-regexp (concat
2606 (ispell-begin-skip-region ispell-html-skip-alists)
2607 "\\|"
2608 skip-regexp)))
2609 ;; tex
2610 (if (eq ispell-parser 'tex)
2611 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2612 skip-regexp)))
2613 ;; messages
2614 (if (and ispell-checking-message
2615 (not (eq t ispell-checking-message)))
2616 (setq skip-regexp (concat
2617 (mapconcat (lambda (lst) (car lst))
2618 ispell-checking-message
2619 "\\|")
2620 "\\|"
2621 skip-regexp)))
2622
2623 ;; return new regexp
2624 skip-regexp))
2625
2626
2627 (defun ispell-begin-skip-region (skip-alist)
2628 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2629 Each selection should be a key of SKIP-ALIST;
2630 otherwise, the current line is skipped."
2631 (mapconcat (lambda (lst) (if (stringp (car lst)) (car lst) (eval (car lst))))
2632 skip-alist
2633 "\\|"))
2634
2635
2636 (defun ispell-begin-tex-skip-regexp ()
2637 "Regular expression of tex commands to skip.
2638 Generated from `ispell-tex-skip-alists'."
2639 (concat
2640 ;; raw tex keys
2641 (mapconcat (function (lambda (lst) (car lst)))
2642 (car ispell-tex-skip-alists)
2643 "\\|")
2644 "\\|"
2645 ;; keys wrapped in begin{}
2646 (mapconcat (function (lambda (lst)
2647 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2648 (car lst)
2649 "[ \t\n]*}")))
2650 (car (cdr ispell-tex-skip-alists))
2651 "\\|")))
2652
2653
2654 (defun ispell-skip-region-list ()
2655 "Returns a list describing key and body regions to skip for this buffer.
2656 Includes regions defined by `ispell-skip-region-alist', tex mode,
2657 `ispell-html-skip-alists', and `ispell-checking-message'.
2658 Manual checking must include comments and tib references.
2659 The list is of the form described by variable `ispell-skip-region-alist'.
2660 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2661 (let ((skip-alist ispell-skip-region-alist))
2662 ;; only additional explicit region definition is tex.
2663 (if (eq ispell-parser 'tex)
2664 (setq case-fold-search nil
2665 skip-alist (append (car ispell-tex-skip-alists)
2666 (car (cdr ispell-tex-skip-alists))
2667 skip-alist)))
2668 (if ispell-skip-html
2669 (setq skip-alist (append ispell-html-skip-alists skip-alist)))
2670 (if (and ispell-checking-message
2671 (not (eq t ispell-checking-message)))
2672 (setq skip-alist (append ispell-checking-message skip-alist)))
2673 skip-alist))
2674
2675
2676 (defun ispell-tex-arg-end (&optional arg)
2677 "Skip across ARG number of braces."
2678 (condition-case nil
2679 (progn
2680 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2681 (forward-sexp (or arg 1)))
2682 (error
2683 (message "error skipping s-expressions at point %d." (point))
2684 (beep)
2685 (sit-for 2))))
2686
2687
2688 (defun ispell-ignore-fcc (start end)
2689 "Deletes the Fcc: message header when large attachments are included.
2690 Return value `nil' if file with large attachments are saved.
2691 This can be used to avoid multiple questions for multiple large attachments.
2692 Returns point to starting location afterwards."
2693 (let ((result t))
2694 (if (and ispell-checking-message ispell-message-fcc-skip)
2695 (if (< ispell-message-fcc-skip (- end start))
2696 (let (case-fold-search head-end)
2697 (goto-char (point-min))
2698 (setq head-end
2699 (or (re-search-forward
2700 (concat "^" (regexp-quote mail-header-separator) "$")
2701 nil t)
2702 (re-search-forward "^$" nil t)
2703 (point-min)))
2704 (goto-char (point-min))
2705 (if (re-search-forward "^Fcc:" head-end t)
2706 (if (y-or-n-p
2707 "Save copy of this message with large attachments? ")
2708 (setq result nil)
2709 (beginning-of-line)
2710 (kill-line 1)))
2711 (goto-char end))))
2712 result))
2713
2714
2715 (defun ispell-skip-region (key)
2716 "Skips across KEY and then to end of region.
2717 Key lookup determines region to skip.
2718 Point is placed at end of skipped region."
2719 ;; move over key to begin checking.
2720 (forward-char (length key))
2721 (let ((start (point))
2722 ;; Regenerate each call... This function can change region definition.
2723 (alist (ispell-skip-region-list))
2724 alist-key null-skip)
2725 (cond
2726 ;; what about quoted comment, or comment inside strings?
2727 ((and (null ispell-check-comments) comment-start
2728 (string= key comment-start))
2729 (if (string= "" comment-end)
2730 (forward-line)
2731 (search-forward comment-end ispell-region-end t)))
2732 ((and (eq 'exclusive ispell-check-comments) comment-start
2733 (string= key comment-end))
2734 (search-forward comment-start ispell-region-end :end))
2735 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2736 (re-search-forward ispell-tib-ref-end ispell-region-end t))
2737 ;; markings from alist
2738 (t
2739 (while alist
2740 (setq alist-key (eval (car (car alist))))
2741 (if (string-match alist-key key)
2742 (progn
2743 (setq alist (cdr (car alist)))
2744 (cond
2745 ((null alist) (setq null-skip t)) ; done! Just skip key.
2746 ((not (consp alist))
2747 ;; Search past end of spell region to find this region end.
2748 (re-search-forward (eval alist) (point-max) t))
2749 ((and (= 1 (length alist))
2750 (stringp (car alist)))
2751 (re-search-forward (car alist) (point-max) t))
2752 (t
2753 (setq null-skip t) ; error handling in functions!
2754 (if (consp (cdr alist))
2755 (apply (car alist) (cdr alist))
2756 (funcall (car alist)))))
2757 (setq alist nil))
2758 (setq alist (cdr alist))))))
2759 (if (and (= start (point)) (null null-skip))
2760 (progn
2761 (message "Matching region end for `%s' point %d not found"
2762 key (point))
2763 (beep)
2764 (sit-for 2)))))
2765
2766
2767 ;;; Grab the next line of data.
2768 ;;; Returns a string with the line data
2769 (defun ispell-get-line (start end in-comment)
2770 (let ((ispell-casechars (ispell-get-casechars))
2771 string)
2772 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2773 ((eolp) ; END OF LINE, just go to next line.
2774 (forward-line))
2775 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
2776 ;; (forward-char 1)) ; not needed as quoted below.
2777 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2778 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
2779 (setq string (concat "^" in-comment
2780 (buffer-substring-no-properties start end)
2781 "\n"))
2782 (goto-char end))
2783 (t (goto-char end))) ; EMPTY LINE, skip it.
2784 string))
2785
2786
2787 (defun ispell-looking-at (string)
2788 (let ((coding (ispell-get-coding-system))
2789 (len (length string)))
2790 (and (<= (+ (point) len) (point-max))
2791 (equal (encode-coding-string string coding)
2792 (encode-coding-string (buffer-substring-no-properties
2793 (point) (+ (point) len))
2794 coding)))))
2795
2796 ;;; Avoid error messages when compiling for these dynamic variables.
2797 (eval-when-compile
2798 (defvar start)
2799 (defvar end))
2800
2801 (defun ispell-process-line (string shift)
2802 "Sends a LINE of text to ispell and processes the result.
2803 This will modify the buffer for spelling errors.
2804 Requires variables START and END to be defined in its lexical scope.
2805 Returns the sum shift due to changes in word replacements."
2806 ;;(declare special start end)
2807 (let (poss accept-list)
2808 (if (not (numberp shift))
2809 (setq shift 0))
2810 ;; send string to spell process and get input.
2811 (ispell-send-string string)
2812 (while (progn
2813 (ispell-accept-output)
2814 ;; Last item of output contains a blank line.
2815 (not (string= "" (car ispell-filter)))))
2816 ;; parse all inputs from the stream one word at a time.
2817 ;; Place in FIFO order and remove the blank item.
2818 (setq ispell-filter (nreverse (cdr ispell-filter)))
2819 (while (and (not ispell-quit) ispell-filter)
2820 ;; get next word, accounting for accepted words and start shifts
2821 (setq poss (ispell-parse-output (car ispell-filter)
2822 accept-list shift))
2823 (if (and poss (listp poss)) ; spelling error occurred.
2824 ;; Whenever we have misspellings, we can change
2825 ;; the buffer. Keep boundaries as markers.
2826 ;; Markers can move with highlighting! This destroys
2827 ;; end of region markers line-end and ispell-region-end
2828 (let ((word-start
2829 (copy-marker (+ start ispell-offset (car (cdr poss)))))
2830 (word-len (length (car poss)))
2831 (line-end (copy-marker end))
2832 (line-start (copy-marker start))
2833 recheck-region replace)
2834 (goto-char word-start)
2835 ;; Adjust the horizontal scroll & point
2836 (ispell-horiz-scroll)
2837 (goto-char (+ word-len word-start))
2838 (ispell-horiz-scroll)
2839 (goto-char word-start)
2840 (ispell-horiz-scroll)
2841
2842 ;; Alignment cannot be tracked and this error will occur when
2843 ;; `query-replace' makes multiple corrections on the starting line.
2844 (or (ispell-looking-at (car poss))
2845 ;; This occurs due to filter pipe problems
2846 (error (concat "Ispell misalignment: word "
2847 "`%s' point %d; probably incompatible versions")
2848 (car poss) (marker-position word-start)))
2849 ;; ispell-cmd-loop can go recursive & change buffer
2850 (if ispell-keep-choices-win
2851 (setq replace (ispell-command-loop
2852 (car (cdr (cdr poss)))
2853 (car (cdr (cdr (cdr poss))))
2854 (car poss) (marker-position word-start)
2855 (+ word-len (marker-position word-start))))
2856 (save-window-excursion
2857 (setq replace (ispell-command-loop
2858 (car (cdr (cdr poss)))
2859 (car (cdr (cdr (cdr poss))))
2860 (car poss) (marker-position word-start)
2861 (+ word-len (marker-position word-start))))))
2862
2863 (goto-char word-start)
2864 ;; Recheck when query replace edit changes misspelled word.
2865 ;; Error in tex mode when a potential math mode change exists.
2866 (if (and replace (listp replace) (= 2 (length replace)))
2867 (if (and (eq ispell-parser 'tex)
2868 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
2869 (regexp-quote string)))
2870 (error
2871 "Don't start query replace on a line with math characters"
2872 )
2873 (set-marker line-end (point))
2874 (setq ispell-filter nil
2875 recheck-region t)))
2876
2877 ;; insert correction if needed
2878 (cond
2879 ((or (null replace)
2880 (equal 0 replace)) ; ACCEPT/INSERT
2881 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
2882 (ispell-add-per-file-word-list (car poss)))
2883 ;; do not recheck accepted word on this line
2884 (setq accept-list (cons (car poss) accept-list)))
2885 (t ; replacement word selected or entered
2886 (delete-region (point) (+ word-len (point)))
2887 (if (not (listp replace))
2888 (progn
2889 (ispell-insert-word replace) ; insert dictionary word
2890 (ispell-send-replacement (car poss) replace)
2891 (setq accept-list (cons replace accept-list)))
2892 (let ((replace-word (car replace)))
2893 ;; Recheck hand entered replacement word
2894 (insert replace-word)
2895 (ispell-send-replacement (car poss) replace-word)
2896 (if (car (cdr replace))
2897 (save-window-excursion
2898 (delete-other-windows) ; to correctly show help.
2899 ;; Assume case-replace &
2900 ;; case-fold-search correct?
2901 (query-replace (car poss) (car replace) t)))
2902 (goto-char word-start)
2903 ;; do not recheck if already accepted
2904 (if (member replace-word accept-list)
2905 (setq accept-list (cons replace-word accept-list)
2906 replace replace-word)
2907 (let ((region-end (copy-marker ispell-region-end)))
2908 (setq recheck-region ispell-filter
2909 ispell-filter nil ; save filter
2910 shift 0 ; already accounted
2911 shift (ispell-region
2912 word-start
2913 (+ word-start (length replace-word))
2914 t shift))
2915 (if (null shift) ; quitting check.
2916 (setq shift 0))
2917 (set-marker ispell-region-end region-end)
2918 (set-marker region-end nil)
2919 (setq ispell-filter recheck-region
2920 recheck-region nil
2921 replace replace-word)))))
2922
2923 (setq shift (+ shift (- (length replace) word-len)))
2924
2925 ;; Move line-start across word...
2926 ;; new shift function does this now...
2927 ;;(set-marker line-start (+ line-start
2928 ;; (- (length replace)
2929 ;; (length (car poss)))))
2930 ))
2931 (if (not ispell-quit)
2932 (let (message-log-max)
2933 (message "Continuing spelling check using %s dictionary..."
2934 (or ispell-current-dictionary "default"))))
2935 (sit-for 0)
2936 (setq start (marker-position line-start)
2937 end (marker-position line-end))
2938 ;; Adjust markers when end of region lost from highlighting.
2939 (if (and (not recheck-region) (< end (+ word-start word-len)))
2940 (setq end (+ word-start word-len)))
2941 (if (= word-start ispell-region-end)
2942 (set-marker ispell-region-end (+ word-start word-len)))
2943 ;; going out of scope - unneeded
2944 (set-marker line-start nil)
2945 (set-marker word-start nil)
2946 (set-marker line-end nil)))
2947 ;; finished with misspelling!
2948 (setq ispell-filter (cdr ispell-filter)))
2949 shift))
2950
2951
2952 ;;;###autoload
2953 (defun ispell-comments-and-strings ()
2954 "Check comments and strings in the current buffer for spelling errors."
2955 (interactive)
2956 (goto-char (point-min))
2957 (let (state done)
2958 (while (not done)
2959 (setq done t)
2960 (setq state (parse-partial-sexp (point) (point-max)
2961 nil nil state 'syntax-table))
2962 (if (or (nth 3 state) (nth 4 state))
2963 (let ((start (point)))
2964 (setq state (parse-partial-sexp start (point-max)
2965 nil nil state 'syntax-table))
2966 (if (or (nth 3 state) (nth 4 state))
2967 (error "Unterminated string or comment"))
2968 (save-excursion
2969 (setq done (not (ispell-region start (point))))))))))
2970
2971
2972 ;;;###autoload
2973 (defun ispell-buffer ()
2974 "Check the current buffer for spelling errors interactively."
2975 (interactive)
2976 (ispell-region (point-min) (point-max)))
2977
2978
2979 ;;;###autoload
2980 (defun ispell-continue ()
2981 "Continue a halted spelling session beginning with the current word."
2982 (interactive)
2983 (if (not (marker-position ispell-region-end))
2984 (message "No session to continue. Use 'X' command when checking!")
2985 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
2986 (message "Must continue ispell from buffer %s"
2987 (buffer-name (marker-buffer ispell-region-end)))
2988 (ispell-region
2989 ;; find beginning of current word:
2990 (car (cdr (ispell-get-word t)))
2991 (marker-position ispell-region-end)))))
2992
2993
2994 ;;; Horizontal scrolling
2995 (defun ispell-horiz-scroll ()
2996 "Places point within the horizontal visibility of its window area."
2997 (if truncate-lines ; display truncating lines?
2998 ;; See if display needs to be scrolled.
2999 (let ((column (- (current-column) (max (window-hscroll) 1))))
3000 (if (and (< column 0) (> (window-hscroll) 0))
3001 (scroll-right (max (- column) 10))
3002 (if (>= column (- (window-width) 2))
3003 (scroll-left (max (- column (window-width) -3) 10)))))))
3004
3005
3006 ;;; Interactive word completion.
3007 ;;; Forces "previous-word" processing. Do we want to make this selectable?
3008
3009 ;;;###autoload
3010 (defun ispell-complete-word (&optional interior-frag)
3011 "Try to complete the word before or under point (see `lookup-words').
3012 If optional INTERIOR-FRAG is non-nil then the word may be a character
3013 sequence inside of a word.
3014
3015 Standard ispell choices are then available."
3016 (interactive "P")
3017 (let ((cursor-location (point))
3018 (case-fold-search-val case-fold-search)
3019 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
3020 start end possibilities replacement)
3021 (setq start (car (cdr word))
3022 end (car (cdr (cdr word)))
3023 word (car word)
3024 possibilities
3025 (or (string= word "") ; Will give you every word
3026 (lookup-words (concat (and interior-frag "*") word
3027 (if (or interior-frag (null ispell-look-p))
3028 "*"))
3029 ispell-complete-word-dict)))
3030 (cond ((eq possibilities t)
3031 (message "No word to complete"))
3032 ((null possibilities)
3033 (message "No match for \"%s\"" word))
3034 (t ; There is a modification...
3035 (setq case-fold-search nil) ; Try and respect case of word.
3036 (cond
3037 ((string-equal (upcase word) word)
3038 (setq possibilities (mapcar 'upcase possibilities)))
3039 ((eq (upcase (aref word 0)) (aref word 0))
3040 (setq possibilities (mapcar (function
3041 (lambda (pos)
3042 (if (eq (aref word 0) (aref pos 0))
3043 pos
3044 (capitalize pos))))
3045 possibilities))))
3046 (setq case-fold-search case-fold-search-val)
3047 (save-window-excursion
3048 (setq replacement
3049 (ispell-command-loop possibilities nil word start end)))
3050 (cond
3051 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
3052 (ispell-add-per-file-word-list word))
3053 (replacement ; REPLACEMENT WORD
3054 (delete-region start end)
3055 (setq word (if (atom replacement) replacement (car replacement))
3056 cursor-location (+ (- (length word) (- end start))
3057 cursor-location))
3058 (ispell-insert-word word)
3059 (if (not (atom replacement)) ; recheck spelling of replacement.
3060 (progn
3061 (goto-char cursor-location)
3062 (ispell-word nil t)))))
3063 (if (get-buffer ispell-choices-buffer)
3064 (kill-buffer ispell-choices-buffer))))
3065 (ispell-pdict-save ispell-silently-savep)
3066 (goto-char cursor-location)))
3067
3068
3069 ;;;###autoload
3070 (defun ispell-complete-word-interior-frag ()
3071 "Completes word matching character sequence inside a word."
3072 (interactive)
3073 (ispell-complete-word t))
3074
3075
3076 ;;;###autoload
3077 (defun ispell ()
3078 "Interactively check a region or buffer for spelling errors.
3079 If `transient-mark-mode' is on, and a region is active, spell-check
3080 that region. Otherwise spell-check the buffer.
3081
3082 Ispell dictionaries are not distributed with Emacs. If you are
3083 looking for a dictionary, please see the distribution of the GNU ispell
3084 program, or do an Internet search; there are various dictionaries
3085 available on the net."
3086 (interactive)
3087 (if (and (boundp 'transient-mark-mode) transient-mark-mode
3088 (boundp 'mark-active) mark-active)
3089 (ispell-region (region-beginning) (region-end))
3090 (ispell-buffer)))
3091
3092
3093 ;;; **********************************************************************
3094 ;;; Ispell Minor Mode
3095 ;;; **********************************************************************
3096
3097 (defvar ispell-minor-mode nil
3098 "Non-nil if Ispell minor mode is enabled.")
3099 ;; Variable indicating that ispell minor mode is active.
3100 (make-variable-buffer-local 'ispell-minor-mode)
3101
3102 (or (assq 'ispell-minor-mode minor-mode-alist)
3103 (setq minor-mode-alist
3104 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
3105
3106 (defvar ispell-minor-keymap
3107 (let ((map (make-sparse-keymap)))
3108 (define-key map " " 'ispell-minor-check)
3109 (define-key map "\r" 'ispell-minor-check)
3110 map)
3111 "Keymap used for Ispell minor mode.")
3112
3113 (or (not (boundp 'minor-mode-map-alist))
3114 (assoc 'ispell-minor-mode minor-mode-map-alist)
3115 (setq minor-mode-map-alist
3116 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
3117 minor-mode-map-alist)))
3118
3119 ;;;###autoload
3120 (defun ispell-minor-mode (&optional arg)
3121 "Toggle Ispell minor mode.
3122 With prefix arg, turn Ispell minor mode on iff arg is positive.
3123
3124 In Ispell minor mode, pressing SPC or RET
3125 warns you if the previous word is incorrectly spelled.
3126
3127 All the buffer-local variables and dictionaries are ignored -- to read
3128 them into the running ispell process, type \\[ispell-word] SPC."
3129 (interactive "P")
3130 (setq ispell-minor-mode
3131 (not (or (and (null arg) ispell-minor-mode)
3132 (<= (prefix-numeric-value arg) 0))))
3133 (force-mode-line-update))
3134
3135 (defun ispell-minor-check ()
3136 "Check previous word then continue with the normal binding of this key.
3137 Don't check previous word when character before point is a space or newline.
3138 Don't read buffer-local settings or word lists."
3139 (interactive "*")
3140 (let ((ispell-minor-mode nil)
3141 (ispell-check-only t)
3142 (last-char (char-after (1- (point)))))
3143 (command-execute (key-binding (this-command-keys)))
3144 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
3145 (and ispell-skip-html (eq last-char ?>))
3146 (and ispell-skip-html (eq last-char ?\;))))
3147 (ispell-word nil t))))
3148
3149
3150 ;;; **********************************************************************
3151 ;;; Ispell Message
3152 ;;; **********************************************************************
3153
3154 (defvar ispell-message-text-end
3155 (mapconcat (function identity)
3156 '(
3157 ;; Don't spell check signatures
3158 "^-- $"
3159 ;; Matches postscript files.
3160 ;;"^%!PS-Adobe-[123].0"
3161 ;; Matches uuencoded text
3162 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3163 ;; Matches shell files (especially auto-decoding)
3164 "^#! /bin/[ck]?sh"
3165 ;; Matches context difference listing
3166 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3167 ;; Matches unidiff difference listing
3168 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
3169 ;; Matches reporter.el bug report
3170 "^current state:\n==============\n"
3171 ;; Matches commonly used "cut" boundaries
3172 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3173 "\\|")
3174 "*End of text which will be checked in `ispell-message'.
3175 If it is a string, limit at first occurrence of that regular expression.
3176 Otherwise, it must be a function which is called to get the limit.")
3177
3178
3179 (defun ispell-mime-multipartp (&optional limit)
3180 "Return multipart message start boundary or nil if none."
3181 ;; caller must ensure `case-fold-search' is set to `t'
3182 (and
3183 (re-search-forward
3184 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3185 limit t)
3186 (let (boundary)
3187 (if (looking-at "\"")
3188 (let (start)
3189 (forward-char)
3190 (setq start (point))
3191 (while (not (looking-at "\""))
3192 (forward-char 1))
3193 (setq boundary (buffer-substring-no-properties start (point))))
3194 (let ((start (point)))
3195 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3196 (forward-char))
3197 (setq boundary (buffer-substring-no-properties start (point)))))
3198 (if (< (length boundary) 1)
3199 (setq boundary nil)
3200 (concat "--" boundary)))))
3201
3202
3203 (defun ispell-mime-skip-part (boundary)
3204 "Moves point across header, or entire MIME part if message is encoded.
3205 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3206 encoded and therefore skipped. See rfc 1521, 2183, ...
3207 If no boundary is given, then entire message is skipped.
3208
3209 This starts one line ABOVE the MIME content messages, on the boundary marker,
3210 for operation with the generic region-skipping code.
3211 This places new MIME boundaries into variable `ispell-checking-message'."
3212 (forward-line) ; skip over boundary to headers
3213 (let ((save-case-fold-search case-fold-search)
3214 (continuep t)
3215 textp)
3216 (setq case-fold-search t
3217 ispell-skip-html nil)
3218 (while continuep
3219 (setq continuep nil)
3220 (if (looking-at "Content-Type: *text/")
3221 (progn
3222 (goto-char (match-end 0))
3223 (if (looking-at "html")
3224 (setq ispell-skip-html t))
3225 (setq textp t
3226 continuep t)
3227 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3228 (forward-line)))
3229 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3230 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3231 (setq textp (member (upcase match)
3232 ;; only spell check the following encodings:
3233 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3234 continuep t)
3235 (goto-char (match-end 0))
3236 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3237 (forward-line)))
3238 ;; hierarchical boundary definition
3239 (if (looking-at "Content-Type: *multipart/")
3240 (let ((new-boundary (ispell-mime-multipartp)))
3241 (if (string-match new-boundary boundary)
3242 (setq continuep t)
3243 ;; first pass redefine skip function to include new boundary
3244 ;;(re-search-backward boundary nil t)
3245 (forward-line)
3246 (setq ispell-checking-message
3247 (cons
3248 (list new-boundary 'ispell-mime-skip-part new-boundary)
3249 (if (eq t ispell-checking-message) nil
3250 ispell-checking-message))
3251 textp t
3252 continuep t)))
3253 ;; Skip all MIME headers that don't affect spelling
3254 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3255 (progn
3256 (setq continuep t)
3257 (goto-char (match-end 0))
3258 (forward-line)))))
3259
3260 (setq case-fold-search save-case-fold-search)
3261 (if textp
3262 (point)
3263 ;; encoded message. Skip to boundary, or entire message.
3264 (if (not boundary)
3265 (goto-char (point-max))
3266 (re-search-forward boundary nil t)
3267 (beginning-of-line)
3268 (point)))))
3269
3270
3271 ;;;###autoload
3272 (defun ispell-message ()
3273 "Check the spelling of a mail message or news post.
3274 Don't check spelling of message headers except the Subject field.
3275 Don't check included messages.
3276
3277 To abort spell checking of a message region and send the message anyway,
3278 use the `x' command. (Any subsequent regions will be checked.)
3279 The `X' command aborts the message send so that you can edit the buffer.
3280
3281 To spell-check whenever a message is sent, include the appropriate lines
3282 in your .emacs file:
3283 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3284 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3285 (add-hook 'mail-send-hook 'ispell-message)
3286 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3287
3288 You can bind this to the key C-c i in GNUS or mail by adding to
3289 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3290 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3291 (interactive)
3292 (save-excursion
3293 (goto-char (point-min))
3294 (let* (boundary mimep
3295 (ispell-skip-region-alist-save ispell-skip-region-alist)
3296 ;; Nil when message came from outside (eg calling emacs as editor)
3297 ;; Non-nil marker of end of headers.
3298 (internal-messagep
3299 (re-search-forward
3300 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3301 (end-of-headers ; Start of body.
3302 (copy-marker
3303 (or internal-messagep
3304 (re-search-forward "^$" nil t)
3305 (point-min))))
3306 (limit (copy-marker ; End of region we will spell check.
3307 (cond
3308 ((not ispell-message-text-end) (point-max))
3309 ((char-or-string-p ispell-message-text-end)
3310 (if (re-search-forward ispell-message-text-end nil t)
3311 (match-beginning 0)
3312 (point-max)))
3313 (t (min (point-max) (funcall ispell-message-text-end))))))
3314 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3315 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3316 (ispell-non-empty-string mail-yank-prefix)
3317 " \\|\t"))
3318 (cite-regexp ;Prefix of quoted text
3319 (cond
3320 ((functionp 'sc-cite-regexp) ; sc 3.0
3321 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3322 (with-no-warnings
3323 (ispell-non-empty-string sc-reference-tag-string))))
3324 ((boundp 'sc-cite-regexp) ; sc 2.3
3325 (concat "\\(" sc-cite-regexp "\\)" "\\|"
3326 (with-no-warnings
3327 (ispell-non-empty-string sc-reference-tag-string))))
3328 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3329 (equal major-mode 'message-mode)) ;GNUS 5
3330 (concat "In article <" "\\|"
3331 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3332 (with-no-warnings message-cite-prefix-regexp)
3333 "\\|"
3334 default-prefix))
3335 ((equal major-mode 'mh-letter-mode) ; mh mail message
3336 (concat "[^,;&+=\n]+ writes:" "\\|"
3337 (with-no-warnings
3338 (ispell-non-empty-string mh-ins-buf-prefix))))
3339 ((not internal-messagep) ; Assume nn sent us this message.
3340 (concat "In [a-zA-Z.]+ you write:" "\\|"
3341 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3342 " *> *"))
3343 ((boundp 'vm-included-text-prefix) ; VM mail message
3344 (concat "[^,;&+=\n]+ writes:" "\\|"
3345 (ispell-non-empty-string vm-included-text-prefix)))
3346 (t default-prefix)))
3347 (ispell-skip-region-alist
3348 (cons (list (concat "^\\(" cite-regexp "\\)")
3349 (function forward-line))
3350 ispell-skip-region-alist))
3351 (old-case-fold-search case-fold-search)
3352 (dictionary-alist ispell-message-dictionary-alist)
3353 (ispell-checking-message t))
3354
3355 ;; Select dictionary for message
3356 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3357 (while dictionary-alist
3358 (goto-char (point-min))
3359 (if (re-search-forward (car (car dictionary-alist))
3360 end-of-headers t)
3361 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3362 dictionary-alist nil)
3363 (setq dictionary-alist (cdr dictionary-alist)))))
3364
3365 (unwind-protect
3366 (progn
3367 ;; Spell check any original Subject:
3368 (goto-char (point-min))
3369 (setq case-fold-search t
3370 mimep (re-search-forward "MIME-Version:" end-of-headers t))
3371 (goto-char (point-min))
3372 (if (re-search-forward "^Subject: *" end-of-headers t)
3373 (progn
3374 (goto-char (match-end 0))
3375 (if (and (not (looking-at ".*Re\\>"))
3376 (not (looking-at "\\[")))
3377 (progn
3378 (setq case-fold-search old-case-fold-search)
3379 (ispell-region (point)
3380 (progn ;Tab-initiated continuation lns.
3381 (end-of-line)
3382 (while (looking-at "\n[ \t]")
3383 (end-of-line 2))
3384 (point)))))))
3385 (if mimep
3386 (progn
3387 (goto-char (point-min))
3388 (setq boundary (ispell-mime-multipartp end-of-headers))))
3389 ;; Adjust message limit to MIME message if necessary.
3390 (and boundary
3391 (re-search-forward (concat boundary "--") nil t)
3392 (re-search-backward boundary nil t)
3393 (< (point) (marker-position limit))
3394 (set-marker limit (point)))
3395 (goto-char (point-min))
3396 ;; Select type or skip checking if this is a non-multipart message
3397 ;; Point moved to end of buffer if region is encoded.
3398 (if (and mimep (not boundary))
3399 (let (skip-regexp) ; protect from `ispell-mime-skip-part'
3400 (goto-char (point-min))
3401 (re-search-forward "Content-[^ \t]*:" end-of-headers t)
3402 (forward-line -1) ; following fn starts one line above
3403 (ispell-mime-skip-part nil)
3404 ;; if message-text-end region, limit may be less than point.
3405 (if (> (point) limit)
3406 (set-marker limit (point)))))
3407 (goto-char (max end-of-headers (point)))
3408 (forward-line 1)
3409 (setq case-fold-search old-case-fold-search)
3410 ;; Define MIME regions to skip.
3411 (if boundary
3412 (setq ispell-checking-message
3413 (list (list boundary 'ispell-mime-skip-part boundary))))
3414 (ispell-region (point) limit))
3415 (set-marker end-of-headers nil)
3416 (set-marker limit nil)
3417 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3418 ispell-skip-html nil
3419 case-fold-search old-case-fold-search)))))
3420
3421
3422 (defun ispell-non-empty-string (string)
3423 (if (or (not string) (string-equal string ""))
3424 "\\'\\`" ; An unmatchable string if string is null.
3425 (regexp-quote string)))
3426
3427
3428 ;;; **********************************************************************
3429 ;;; Buffer Local Functions
3430 ;;; **********************************************************************
3431
3432
3433 (defun ispell-accept-buffer-local-defs ()
3434 "Load all buffer-local information, restarting Ispell when necessary."
3435 (ispell-buffer-local-dict) ; May kill ispell-process.
3436 (ispell-buffer-local-words) ; Will initialize ispell-process.
3437 (ispell-buffer-local-parsing))
3438
3439
3440 (defun ispell-buffer-local-parsing ()
3441 "Place Ispell into parsing mode for this buffer.
3442 Overrides the default parsing mode.
3443 Includes Latex/Nroff modes and extended character mode."
3444 ;; (ispell-init-process) must already be called.
3445 (ispell-send-string "!\n") ; Put process in terse mode.
3446 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3447 ;; When exclusively checking comments, set to raw text mode (nroff).
3448 (if (and (not (eq 'exclusive ispell-check-comments))
3449 (or (and (eq ispell-parser 'use-mode-name)
3450 (string-match "[Tt][Ee][Xx]-mode"
3451 (symbol-name major-mode)))
3452 (eq ispell-parser 'tex)))
3453 (progn
3454 (ispell-send-string "+\n") ; set ispell mode to tex
3455 (if (not (eq ispell-parser 'tex))
3456 (set (make-local-variable 'ispell-parser) 'tex)))
3457 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3458 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3459 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
3460 (setq ispell-skip-html
3461 (not (null (string-match "sgml\\|html\\|xml"
3462 (downcase (symbol-name major-mode)))))))
3463 ;; Set default extended character mode for given buffer, if any.
3464 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3465 (if extended-char-mode
3466 (ispell-send-string (concat extended-char-mode "\n"))))
3467 ;; Set buffer-local parsing mode and extended character mode, if specified.
3468 (save-excursion
3469 (goto-char (point-max))
3470 ;; Uses last occurrence of ispell-parsing-keyword
3471 (if (search-backward ispell-parsing-keyword nil t)
3472 (let ((end (save-excursion (end-of-line) (point)))
3473 string)
3474 (search-forward ispell-parsing-keyword)
3475 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3476 ;; space separated definitions.
3477 (setq string (downcase (buffer-substring-no-properties
3478 (match-beginning 1) (match-end 1))))
3479 (cond ((and (string-match "latex-mode" string)
3480 (not (eq 'exclusive ispell-check-comments)))
3481 (ispell-send-string "+\n~tex\n"))
3482 ((string-match "nroff-mode" string)
3483 (ispell-send-string "-\n~nroff\n"))
3484 ((string-match "~" string) ; Set extended character mode.
3485 (ispell-send-string (concat string "\n")))
3486 (t (message "Invalid Ispell Parsing argument!")
3487 (sit-for 2))))))))
3488
3489
3490 ;;; Can kill the current ispell process
3491
3492 (defun ispell-buffer-local-dict ()
3493 "Initializes local dictionary and local personal dictionary.
3494 When a dictionary is defined in the buffer (see variable
3495 `ispell-dictionary-keyword'), it will override the local setting
3496 from \\[ispell-change-dictionary].
3497 Both should not be used to define a buffer-local dictionary."
3498 (save-excursion
3499 (goto-char (point-min))
3500 (let (end)
3501 ;; Override the local variable definition.
3502 ;; Uses last occurrence of ispell-dictionary-keyword.
3503 (goto-char (point-max))
3504 (unless ispell-local-dictionary-overridden
3505 (if (search-backward ispell-dictionary-keyword nil t)
3506 (progn
3507 (search-forward ispell-dictionary-keyword)
3508 (setq end (save-excursion (end-of-line) (point)))
3509 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3510 (setq ispell-local-dictionary
3511 (buffer-substring-no-properties (match-beginning 1)
3512 (match-end 1)))))))
3513 (goto-char (point-max))
3514 (if (search-backward ispell-pdict-keyword nil t)
3515 (progn
3516 (search-forward ispell-pdict-keyword)
3517 (setq end (save-excursion (end-of-line) (point)))
3518 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3519 (setq ispell-local-pdict
3520 (buffer-substring-no-properties (match-beginning 1)
3521 (match-end 1))))))))
3522 ;; Reload if new personal dictionary defined.
3523 (if (and ispell-local-pdict
3524 (not (equal ispell-local-pdict ispell-personal-dictionary)))
3525 (progn
3526 (ispell-kill-ispell t)
3527 (setq ispell-personal-dictionary ispell-local-pdict)))
3528 ;; Reload if new dictionary defined.
3529 (ispell-internal-change-dictionary))
3530
3531
3532 (defun ispell-buffer-local-words ()
3533 "Loads the buffer-local dictionary in the current buffer."
3534 (if (and ispell-buffer-local-name
3535 (not (equal ispell-buffer-local-name (buffer-name))))
3536 (progn
3537 (ispell-kill-ispell t)
3538 (setq ispell-buffer-local-name nil)))
3539 (ispell-init-process)
3540 (save-excursion
3541 (goto-char (point-min))
3542 (while (search-forward ispell-words-keyword nil t)
3543 (or ispell-buffer-local-name
3544 (setq ispell-buffer-local-name (buffer-name)))
3545 (let ((end (save-excursion (end-of-line) (point)))
3546 (ispell-casechars (ispell-get-casechars))
3547 string)
3548 ;; buffer-local words separated by a space, and can contain
3549 ;; any character other than a space. Not rigorous enough.
3550 (while (re-search-forward " *\\([^ ]+\\)" end t)
3551 (setq string (buffer-substring-no-properties (match-beginning 1)
3552 (match-end 1)))
3553 ;; This can fail when string contains a word with illegal chars.
3554 ;; Error handling needs to be added between ispell and emacs.
3555 (if (and (< 1 (length string))
3556 (equal 0 (string-match ispell-casechars string)))
3557 (ispell-send-string (concat "@" string "\n"))))))))
3558
3559
3560 ;;; returns optionally adjusted region-end-point.
3561
3562 (defun ispell-add-per-file-word-list (word)
3563 "Add WORD to the per-file word list."
3564 (or ispell-buffer-local-name
3565 (setq ispell-buffer-local-name (buffer-name)))
3566 (save-excursion
3567 (goto-char (point-min))
3568 (let ((old-case-fold-search case-fold-search)
3569 line-okay search done found)
3570 (while (not done)
3571 (setq case-fold-search nil
3572 search (search-forward ispell-words-keyword nil 'move)
3573 found (or found search)
3574 line-okay (< (+ (length word) 1 ; 1 for space after word..
3575 (progn (end-of-line) (current-column)))
3576 80)
3577 case-fold-search old-case-fold-search)
3578 (if (or (and search line-okay)
3579 (null search))
3580 (progn
3581 (setq done t)
3582 (if (null search)
3583 (progn
3584 (open-line 1)
3585 (unless found (newline))
3586 (insert (concat comment-start " " ispell-words-keyword))
3587 (if (> (length comment-end) 0)
3588 (save-excursion
3589 (newline)
3590 (insert comment-end)))))
3591 (insert (concat " " word))))))))
3592
3593 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3594
3595 (provide 'ispell)
3596
3597 \f
3598 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3599
3600 ;;; Local Variable options:
3601 ;;; mode: name(-mode)
3602 ;;; eval: expression
3603 ;;; local-variable: value
3604
3605 ;;; The following sets the buffer local dictionary to `american' English
3606 ;;; and spell checks only comments.
3607
3608 ;;; Local Variables:
3609 ;;; mode: emacs-lisp
3610 ;;; comment-column: 40
3611 ;;; ispell-check-comments: exclusive
3612 ;;; ispell-local-dictionary: "american"
3613 ;;; End:
3614
3615
3616 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3617
3618 ;;; The following places this file in nroff parsing and extended char modes.
3619 ;;; Local IspellParsing: nroff-mode ~nroff
3620 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3621 ;;; Local IspellPersDict ~/.ispell_lisp
3622 ;;; The following were automatically generated by ispell using the 'A' command:
3623 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3624 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3625 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3626 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3627 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3628 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3629 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3630 ; LocalWords: lns XEmacs HTML casechars Multibyte
3631
3632 ;;; arch-tag: 4941b9f9-3b7c-4a76-a4ed-5fa8b6010ef5
3633 ;;; ispell.el ends here