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