1 ;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 ;; Author: Ken Stevens <k.stevens@ieee.org>
6 ;; Maintainer: Ken Stevens <k.stevens@ieee.org>
7 ;; Stevens Mod Date: Fri Aug 4 09:41:50 PDT 2000
8 ;; Stevens Revision: 3.4
9 ;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
10 ;; Bug Reports : ispell-el-bugs@itcorp.com
11 ;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 2, or (at your option)
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING. If not, write to the
28 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 ;; Boston, MA 02111-1307, USA.
31 ;; Note: version numbers and time stamp are not updated
32 ;; when this file is edited for release with GNU emacs.
38 ;; This code contains a section of user-settable variables that you
39 ;; should inspect prior to installation. Look past the end of the history
40 ;; list. Set them up for your locale and the preferences of the majority
41 ;; of the users. Otherwise the users may need to set a number of variables
43 ;; You particularly may want to change the default dictionary for your
44 ;; country and language.
45 ;; Most dictionary changes should be made in this file so all users can
46 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
47 ;; file. Modify the variable `ispell-local-dictionary-alist' to include
48 ;; these dictionaries, and they will be installed when ispell.el is loaded.
50 ;; Depending on the mail system you use, you may want to include these:
51 ;; (add-hook 'news-inews-hook 'ispell-message)
52 ;; (add-hook 'mail-send-hook 'ispell-message)
53 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
55 ;; Ispell has a TeX parser and a nroff parser (the default).
56 ;; The parsing is controlled by the variable ispell-parser. Currently
57 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
58 ;; added it will be updated. See the variable description for more info.
67 ;; ispell-comments-and-strings
69 ;; ispell-complete-word
70 ;; ispell-complete-word-interior-frag
71 ;; ispell-change-dictionary
74 ;; ispell-skip-region-alist
76 ;; Commands in ispell-region:
77 ;; Character replacement: Replace word with choice. May query-replace.
78 ;; ` ': Accept word this time.
79 ;; `i': Accept word and insert into private dictionary.
80 ;; `a': Accept word for this session.
81 ;; `A': Accept word and place in buffer-local dictionary.
82 ;; `r': Replace word with typed-in value. Rechecked.
83 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
84 ;; `?': Show these commands
85 ;; `x': Exit spelling buffer. Move cursor to original point.
86 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
87 ;; the check to be completed later.
88 ;; `q': Quit spelling session (Kills ispell process).
89 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
90 ;; `u': Like `i', but the word is lower-cased first.
91 ;; `m': Place entered value in personal dictionary, then recheck current word.
92 ;; `C-l': redraws screen
93 ;; `C-r': recursive edit
94 ;; `C-z': suspend emacs or iconify frame
96 ;; Buffer-Local features:
97 ;; There are a number of buffer-local features that can be used to customize
98 ;; ispell for the current buffer. This includes language dictionaries,
99 ;; personal dictionaries, parsing, and local word spellings. Each of these
100 ;; local customizations are done either through local variables, or by
101 ;; including the keyword and argument(s) at the end of the buffer (usually
102 ;; prefixed by the comment characters). See the end of this file for
103 ;; examples. The local keywords and variables are:
105 ;; ispell-dictionary-keyword language-dictionary
106 ;; uses local variable ispell-local-dictionary
107 ;; ispell-pdict-keyword personal-dictionary
108 ;; uses local variable ispell-local-pdict
109 ;; ispell-parsing-keyword mode-arg extended-char-arg
110 ;; ispell-words-keyword any number of local word spellings
113 ;; Place new regular expression definitions of regions you prefer not to
114 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
115 ;; be added to latex by modifying `ispell-tex-skip-alists'.
116 ;; `ispell-message' contains some custom skipping code for e-mail messages.
119 ;; Need a way to select between different character mappings without separate
120 ;; dictionary entries.
121 ;; Multi-byte characters if not defined by current dictionary may result in the
122 ;; evil "misalignment error" in some versions of MULE emacs.
123 ;; On some versions of emacs, growing the minibuffer fails.
124 ;; see `ispell-help-in-bufferp'.
125 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
126 ;; can cause misalignment errors.
130 ;; Modifications made in latest versions:
132 ;; Revision 3.4 2000/8/4 09:41:50 kss
133 ;; Support new color display functions.
134 ;; Fixed misalignment offset bug when replacing a string after a shift made.
135 ;; Set to standard Author/Maintainer heading,
136 ;; ensure localwords lists are separated from the text by newline. (Dave Love)
137 ;; Added dictionary definition for Italian (William Deakin)
138 ;; HTML region skipping greatly improved. (Chuck D. Phillips)
139 ;; improved menus. Fixed regexp matching http/email addresses.
140 ;; one arg always for xemacs sleep-for (gunnar Evermann)
141 ;; support for synchronous processes (Eli Zaretskii)
143 ;; Revision 3.3 1999/11/29 11:38:34 kss
144 ;; Only word replacements entered in from the keyboard are rechecked.
145 ;; This fixes a bug in tex parsing and misalignment.
146 ;; Exceptions exist for recursive edit and query-replace, with tex error
147 ;; condition tested. Recursive editing improved.
148 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
149 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
150 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
151 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
154 ;; Revision 3.2 1999/5/7 14:25:14 kss
155 ;; Accept ispell versions 3.X.Y where X>=1
156 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
157 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
158 ;; Fixed bug in TeX parsing when math commands are in the comments.
159 ;; Removed calls to `when' macro.
161 ;; Revision 3.1 1998/12/1 13:21:52 kss
162 ;; Improved and fixed customize support.
163 ;; Improved and fixed comments in variables and messages.
164 ;; A coding system is now required for all languages.
165 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
166 ;; Dictionary norsk7-tex removed. Dictionary polish added.
167 ;; Dictionaries redefined at load-time to support dictionary changes.
168 ;; Menu redefined at load time to support dictionary changes.
169 ;; ispell-check-version added as an alias for `check-ispell-version'.
170 ;; Spelling suggestions returned in order generated by ispell.
171 ;; Small bug fixed in matching ispell error messages.
172 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
173 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
174 ;; Multibyte character coding support added for process interactions.
175 ;; Ensure ispell process has terminated before starting new process.
176 ;; This can otherwise confuse process filters and hang ispell.
177 ;; Improved skipping support for SGML.
178 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
179 ;; Improved message reference matching in `ispell-message'.
180 ;; Fixed bug in returning to nroff mode from tex mode.
185 ;;; Custom.el macros require recompiling this when they are not present.
186 ;;; Add in backward compatible custom support.
188 (if (not (fboundp 'defcustom
))
189 (defmacro defcustom
(symbol value doc
&rest args
)
190 "Empty replacement for defcustom when not supplied."
191 `(defvar ,symbol
,value
,doc
))))
194 (if (not (fboundp 'defgroup
))
195 (defmacro defgroup
(&rest args
)
196 "Empty replacement for defgroup when not supplied.")))
199 "User variables for emacs ispell interface."
200 :group
'applications
)
202 (if (not (fboundp 'buffer-substring-no-properties
))
203 (defun buffer-substring-no-properties (start end
)
204 (buffer-substring start end
)))
206 (defalias 'ispell-check-version
'check-ispell-version
)
208 ;;; **********************************************************************
209 ;;; The following variables should be set according to personal preference
210 ;;; and location of binaries:
211 ;;; **********************************************************************
214 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
216 (defcustom ispell-highlight-p
'block
217 "*Highlight spelling errors when non-nil.
218 When set to `block', assumes a block cursor with TTY displays."
219 :type
'(choice (const block
) (const :tag
"off" nil
) (const :tag
"on" t
))
222 (defcustom ispell-highlight-face
'highlight
223 "*The face used for Ispell highlighting. For Emacses with overlays.
224 Possible values are `highlight', `modeline', `secondary-selection',
225 `region', and `underline'.
226 This variable can be set by the user to whatever face they desire.
227 It's most convenient if the cursor color and highlight color are
232 (defcustom ispell-check-comments t
233 "*Spelling of comments checked when non-nil.
234 When set to `exclusive', ONLY comments are checked. (For code comments).
235 Warning! Not checking comments, when a comment start is embedded in strings,
236 may produce undesired results."
237 :type
'(choice (const exclusive
) (const :tag
"off" nil
) (const :tag
"on" t
))
240 (defcustom ispell-query-replace-choices nil
241 "*Corrections made throughout region when non-nil.
242 Uses `query-replace' (\\[query-replace]) for corrections."
246 (defcustom ispell-skip-tib nil
247 "*Does not spell check `tib' bibliography references when non-nil.
248 Skips any text between strings matching regular expressions
249 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
251 TeX users beware: Any field starting with [. will skip until a .] -- even
252 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
253 a [.5mm] type of number...."
257 (defvar ispell-tib-ref-beginning
"[[<]\\."
258 "Regexp matching the beginning of a Tib reference.")
260 (defvar ispell-tib-ref-end
"\\.[]>]"
261 "Regexp matching the end of a Tib reference.")
263 (defcustom ispell-keep-choices-win t
264 "*When not nil, the `*Choices*' window remains for spelling session.
265 This minimizes redisplay thrashing."
269 (defcustom ispell-choices-win-default-height
2
270 "*The default size of the `*Choices*' window, including mode line.
271 Must be greater than 1."
275 (defcustom ispell-program-name
"ispell"
276 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
280 (defcustom ispell-alternate-dictionary
281 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
282 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
283 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
284 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
285 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
286 ((file-exists-p "/usr/share/lib/dict/words")
287 "/usr/share/lib/dict/words")
288 ((file-exists-p "/sys/dict") "/sys/dict")
289 (t "/usr/dict/words"))
290 "*Alternate dictionary for spelling help."
291 :type
'(choice file
(const :tag
"None" nil
))
294 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
295 "*Dictionary used for word completion."
296 :type
'(choice file
(const :tag
"None" nil
))
299 (defcustom ispell-message-dictionary-alist nil
300 "*List used by `ispell-message' to select a new dictionary.
301 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
302 in the message headers, `ispell-local-dictionary' will be set to
303 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
304 E.g. you may use the following value:
305 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
306 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
307 :type
'(repeat (cons regexp string
))
311 (defcustom ispell-grep-command
"egrep"
312 "Name of the grep command for search processes."
316 (defcustom ispell-grep-options
"-i"
317 "String of options to use when running the program in `ispell-grep-command'.
318 Should probably be \"-i\" or \"-e\".
319 Some machines (like the NeXT) don't support \"-i\""
323 (defcustom ispell-look-command
324 (cond ((file-exists-p "/bin/look") "/bin/look")
325 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
326 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
328 "Name of the look command for search processes.
329 This must be an absolute file name."
333 (defcustom ispell-look-p
(file-exists-p ispell-look-command
)
334 "*Non-nil means use `look' rather than `grep'.
335 Default is based on whether `look' seems to be available."
339 (defcustom ispell-have-new-look nil
340 "*Non-nil means use the `-r' option (regexp) when running `look'."
344 (defcustom ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
345 "String of command options for `ispell-look-command'."
349 (defcustom ispell-use-ptys-p nil
350 "When non-nil, Emacs uses ptys to communicate with Ispell.
351 When nil, Emacs uses pipes."
355 (defcustom ispell-following-word nil
356 "*Non-nil means `ispell-word' checks the word around or after point.
357 Otherwise `ispell-word' checks the preceding word."
361 (defcustom ispell-help-in-bufferp nil
362 "*Non-nil means display interactive keymap help in a buffer.
363 The following values are supported:
364 nil Expand the minibuffer and display a short help message
365 there for a couple of seconds.
366 t Pop up a new buffer and display a short help message there
367 for a couple of seconds.
368 electric Pop up a new buffer and display a long help message there.
369 User can browse and then exit the help mode."
370 :type
'(choice (const electric
) (const :tag
"off" nil
) (const :tag
"on" t
))
373 (defcustom ispell-quietly nil
374 "*Non-nil means suppress messages in `ispell-word'."
378 (defcustom ispell-format-word
(function upcase
)
379 "*Formatting function for displaying word being spell checked.
380 The function must take one string argument and return a string."
384 (defcustom ispell-use-framepop-p nil
385 "When non-nil ispell uses framepop to display choices in a dedicated frame.
386 You can set this variable to dynamically use framepop if you are in a
387 window system by evaluating the following on startup to set this variable:
388 (and window-system (condition-case () (require 'framepop) (error nil)))"
393 (defcustom ispell-personal-dictionary nil
394 "*File name of your personal spelling dictionary, or nil.
395 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
396 where DICTNAME is the name of your default dictionary."
398 (const :tag
"default" nil
))
401 (defcustom ispell-silently-savep nil
402 "*When non-nil, save the personal dictionary without confirmation."
406 ;;; This is the local dictionary to use. When nil the default dictionary will
407 ;;; be used. Change set-default call to use a new default dictionary.
408 (defcustom ispell-local-dictionary nil
409 "If non-nil, the dictionary to be used for Ispell commands.
410 The value must be a string dictionary name in `ispell-dictionary-alist'.
412 Setting `ispell-local-dictionary' to a value has the same effect as
413 calling \\[ispell-change-dictionary] with that value. This variable
414 is automatically set when defined in the file with either
415 `ispell-dictionary-keyword' or the Local Variable syntax.
417 To create a non-standard default dictionary (not from `ispell-dictionary-alist')
418 call function `set-default' with the new dictionary name."
419 :type
'(choice string
420 (const :tag
"default" nil
))
423 (make-variable-buffer-local 'ispell-local-dictionary
)
425 ;; Call this function set up the default dictionary if not English.
426 ;;(set-default 'ispell-local-dictionary nil)
429 (defcustom ispell-extra-args nil
430 "*If non-nil, a list of extra switches to pass to the Ispell program.
431 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
432 words as correct. See also `ispell-dictionary-alist', which may be used
433 for language-specific arguments."
434 :type
'(repeat string
)
439 (defcustom ispell-skip-html
'use-mode-name
440 "*Indicates whether ispell should skip spell checking of SGML markup.
441 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
442 guess whether SGML markup should be skipped according to the name of the
443 buffer's major mode."
444 :type
'(choice (const :tag
"always" t
) (const :tag
"never" nil
)
445 (const :tag
"use-mode-name" use-mode-name
))
449 ;;; Define definitions here only for personal dictionaries.
451 (defcustom ispell-local-dictionary-alist nil
452 "*Contains local or customized dictionary definitions.
453 See `ispell-dictionary-alist'."
454 :type
'(repeat (list (choice :tag
"Dictionary"
455 (string :tag
"Dictionary name")
456 (const :tag
"default" nil
))
457 (regexp :tag
"Case characters")
458 (regexp :tag
"Non case characters")
459 (regexp :tag
"Other characters")
460 (boolean :tag
"Many other characters")
461 (repeat :tag
"Ispell command line args"
463 (choice :tag
"Extended character mode"
464 (const "~tex") (const "~plaintex")
465 (const "~nroff") (const "~list")
466 (const "~latin1") (const "~latin3")
467 (const :tag
"default" nil
))
468 (choice :tag
"Character set"
475 ;;; split dictionary so line length is smaller in loaddefs.el
477 ;;; First part of dictionary, shortened for loaddefs.el
480 ispell-dictionary-alist-1
481 '((nil ; default (English.aff)
482 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
483 ("american" ; Yankee English
484 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
485 ("brasileiro" ; Brazilian mode
486 "[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]"
487 "[^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]"
488 "[']" nil
("-d" "brasileiro") nil iso-8859-1
)
489 ("british" ; British version
490 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B" "-d" "british") nil iso-8859-1
)
491 ("castellano" ; Spanish mode
492 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
493 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
494 "[-]" nil
("-B" "-d" "castellano") "~tex" iso-8859-1
)
495 ("castellano8" ; 8 bit Spanish mode
496 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
497 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
498 "[-]" nil
("-B" "-d" "castellano") "~latin1" iso-8859-1
)))
501 ;;; Second part of dictionary, shortened for loaddefs.el
504 ispell-dictionary-alist-2
506 "[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]"
507 "[^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]"
508 "" nil
("-B" "-d" "czech") nil iso-8859-2
)
510 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
511 "[']" nil
("-C") nil iso-8859-1
)
512 ("deutsch" ; Deutsch.aff
513 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
515 "[a-zA-Z\304\326\334\344\366\337\374]"
516 "[^a-zA-Z\304\326\334\344\366\337\374]"
517 "[']" t
("-C" "-d" "deutsch") "~latin1" iso-8859-1
)
518 ("english" ; make English explicitly selectable
519 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)))
522 ;;; Third part of dictionary, shortened for loaddefs.el
525 ispell-dictionary-alist-3
527 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
528 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
529 "[-']" t
("-C") "~latin3" iso-8859-1
)
531 "[A-Za-z^\\]" "[^A-Za-z^\\]"
532 "[-'`\"]" t
("-C" "-d" "esperanto") "~tex" iso-8859-1
)
534 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil iso-8859-1
)
535 ("francais" ; Francais.aff
536 "[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]"
537 "[^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]"
538 "[-']" t nil
"~list" iso-8859-1
)))
541 ;;; Fourth part of dictionary, shortened for loaddefs.el
544 ispell-dictionary-alist-4
545 '(("francais-tex" ; Francais.aff
546 "[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\\]"
547 "[^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\\]"
548 "[-'^`\"]" t nil
"~tex" iso-8859-1
)
549 ("german" ; german.aff
550 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
552 "[a-zA-Z\304\326\334\344\366\337\374]"
553 "[^a-zA-Z\304\326\334\344\366\337\374]"
554 "[']" t
("-C" "-d" "german") "~latin1" iso-8859-1
)
555 ("italiano" ; Italian.aff
556 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
557 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
558 "[-]" nil
("-B" "-d" "italian") "~tex" iso-8859-1
)))
561 ;;; Fifth part of dictionary, shortened for loaddefs.el
564 ispell-dictionary-alist-5
565 '(("nederlands" ; Nederlands.aff
566 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
567 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
568 "[']" t
("-C") nil iso-8859-1
)
569 ("nederlands8" ; Dutch8.aff
570 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
571 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
572 "[']" t
("-C") nil iso-8859-1
)
573 ("norsk" ; 8 bit Norwegian mode
574 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
575 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
576 "[\"]" nil
("-d" "norsk") "~list" iso-8859-1
)
577 ("norsk7-tex" ; 7 bit Norwegian TeX mode
578 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
579 "[\"]" nil
("-d" "norsk") "~plaintex" iso-8859-1
)))
582 ;;; Sixth part of dictionary, shortened for loaddefs.el
585 ispell-dictionary-alist-6
586 ;; include Russian iso character set too?
587 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
588 '(("polish" ; polish mode
589 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
590 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
591 "" nil
( "-d" "polish") nil iso-8859-2
)
592 ("russian" ; Russian.aff (KOI8-R charset)
593 "[\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]"
594 "[^\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]"
595 "" nil
("-d" "russian") nil koi8-r
)
596 ("svenska" ; Swedish mode
597 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
598 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
599 "[']" nil
("-C") "~list" iso-8859-1
)
601 "[a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
602 "[^a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
603 "[']" t
("-C" "-d" "portugues") "~latin1" iso-8859-1
)
605 "[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]"
606 "[^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]"
607 "" nil
("-B" "-d" "slovak") nil iso-8859-2
)))
610 (defcustom ispell-dictionary-alist
611 (append ispell-local-dictionary-alist
; dictionary customizations
612 ispell-dictionary-alist-1 ispell-dictionary-alist-2
613 ispell-dictionary-alist-3 ispell-dictionary-alist-4
614 ispell-dictionary-alist-5 ispell-dictionary-alist-6
)
615 "An alist of dictionaries and their associated parameters.
617 Each element of this list is also a list:
619 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
620 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
622 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
623 nil means the default dictionary.
625 CASECHARS is a regular expression of valid characters that comprise a
628 NOT-CASECHARS is the opposite regexp of CASECHARS.
630 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
631 used to construct words in some special way. If OTHERCHARS characters follow
632 and precede characters from CASECHARS, they are parsed as part of a word,
633 otherwise they become word-breaks. As an example in English, assume the
634 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
635 \"Steven's\" are parsed as single words including the \"'\" character, but
636 \"Stevens'\" does not include the quote character as part of the word.
637 If you want OTHERCHARS to be empty, use the empty string.
638 Hint: regexp syntax requires the hyphen to be declared first here.
640 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
641 Otherwise only a single OTHERCHARS character is allowed to be part of any
644 ISPELL-ARGS is a list of additional arguments passed to the ispell
647 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
648 have been configured in an Ispell affix file. (For example, umlauts
649 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
650 in English. This has the same effect as the command-line `-T' option.
651 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
652 but the dictionary can control the extended character mode.
653 Both defaults can be overruled in a buffer-local fashion. See
654 `ispell-parsing-keyword' for details on this.
656 CHARACTER-SET used for languages with multibyte characters.
658 Note that the CASECHARS and OTHERCHARS slots of the alist should
659 contain the same character set as casechars and otherchars in the
660 LANGUAGE.aff file \(e.g., english.aff\)."
661 :type
'(repeat (list (choice :tag
"Dictionary"
662 (string :tag
"Dictionary name")
663 (const :tag
"default" nil
))
664 (regexp :tag
"Case characters")
665 (regexp :tag
"Non case characters")
666 (regexp :tag
"Other characters")
667 (boolean :tag
"Many other characters")
668 (repeat :tag
"Ispell command line args"
670 (choice :tag
"Extended character mode"
671 (const "~tex") (const "~plaintex")
672 (const "~nroff") (const "~list")
673 (const "~latin1") (const "~latin3")
674 (const :tag
"default" nil
))
675 (choice :tag
"Character set"
681 ;;; update the dictionaries at load time
682 (setq ispell-dictionary-alist
683 (append ispell-local-dictionary-alist
; dictionary customizations
684 ispell-dictionary-alist-1 ispell-dictionary-alist-2
685 ispell-dictionary-alist-3 ispell-dictionary-alist-4
686 ispell-dictionary-alist-5 ispell-dictionary-alist-6
))
691 ;;; **********************************************************************
692 ;;; The following are used by ispell, and should not be changed.
693 ;;; **********************************************************************
697 ;;; The version must be 3.1 or greater for this version of ispell.el
698 ;;; There is an incompatibility between version 3.1.12 and lower versions.
699 (defconst ispell-required-version
'(3 1 12)
700 "Ispell versions with which this version of ispell.el is known to work.")
701 (defvar ispell-offset -
1
702 "Offset that maps protocol differences between ispell 3.1 versions.")
704 (defconst ispell-version
"ispell.el 3.4 -- Fri Aug 4 09:41:50 PDT 2000")
707 (defun check-ispell-version (&optional interactivep
)
708 "Ensure that `ispell-program-name' is valid and the correct version.
709 Returns version number if called interactively.
710 Otherwise returns the library directory name, if that is defined."
711 ;; This is a little wasteful as we actually launch ispell twice: once
712 ;; to make sure it's the right version, and once for real. But people
713 ;; get confused by version mismatches *all* the time (and I've got the
714 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
715 ;; option is the only way I can think of to do this that works with
716 ;; all versions, since versions earlier than 3.0.09 didn't identify
717 ;; themselves on startup.
719 (let ((case-fold-search-val case-fold-search
)
720 ;; avoid bugs when syntax of `.' changes in various default modes
721 (default-major-mode 'fundamental-mode
)
722 (default-directory temporary-file-directory
)
725 (let ((buf (get-buffer " *ispell-tmp*")))
726 (if buf
(kill-buffer buf
)))
727 (set-buffer (get-buffer-create " *ispell-tmp*"))
729 (setq status
(call-process
730 ispell-program-name nil t nil
731 ;; aspell doesn't accept the -vv switch.
732 (let ((case-fold-search
733 (memq system-type
'(ms-dos windows-nt
)))
735 (file-name-nondirectory ispell-program-name
)))
736 ;; Assume anything that isn't `aspell' is Ispell.
737 (if (string-match "\\`aspell" speller
) "-v" "-vv"))))
738 (goto-char (point-min))
742 (setq result
(concat (buffer-substring-no-properties (point-min)
747 ;; return library directory.
748 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t
)
749 (setq result
(buffer-substring (match-beginning 1) (match-end 1)))))
750 (goto-char (point-min))
751 (if (not (memq status
'(0 nil
)))
752 (error "%s exited with %s %s" ispell-program-name
753 (if (stringp status
) "signal" "code") status
))
754 (setq case-fold-search t
755 status
(re-search-forward
757 (format "%d" (car ispell-required-version
))
758 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
760 case-fold-search case-fold-search-val
)
761 (if (or (not status
) ; major version mismatch
762 (< (car (read-from-string (buffer-substring-no-properties
763 (match-beginning 2) (match-end 2))))
764 (car (cdr ispell-required-version
)))) ; minor version mismatch
765 (error "%s version 3 release %d.%d.%d or greater is required"
766 ispell-program-name
(car ispell-required-version
)
767 (car (cdr ispell-required-version
))
768 (car (cdr (cdr ispell-required-version
))))
769 ;; check that it is the correct version.
770 (if (and (= (car (read-from-string (buffer-substring-no-properties
771 (match-beginning 2)(match-end 2))))
772 (car (cdr ispell-required-version
)))
773 (< (car (read-from-string (buffer-substring-no-properties
774 (match-beginning 3)(match-end 3))))
775 (car (cdr (cdr ispell-required-version
)))))
776 (setq ispell-offset
0)))
777 (kill-buffer (current-buffer)))
782 ;;; The preparation of the menu bar menu must be autoloaded
783 ;;; because otherwise this file gets autoloaded every time Emacs starts
784 ;;; so that it can set up the menus and determine keyboard equivalents.
788 (defvar ispell-menu-map nil
"Key map for ispell menu.")
789 ;;; redo menu when loading ispell to get dictionary modifications
790 (setq ispell-menu-map nil
)
793 (defvar ispell-menu-xemacs nil
794 "Spelling menu for XEmacs.
795 If nil when package is loaded, a standard menu will be set,
796 and added as a submenu of the \"Edit\" menu.")
798 ;;; Break out XEmacs menu and split into several calls to avoid having
799 ;;; long lines in loaddefs.el. Detect need off following constant.
801 ;;; Set up dictionary
803 (defvar ispell-menu-map-needed
804 ;; only needed when not version 18 and not XEmacs.
805 (and (not ispell-menu-map
)
806 (not (featurep 'xemacs
))
809 (defvar ispell-library-directory
(condition-case ()
810 (check-ispell-version)
812 "Directory where ispell dictionaries reside.")
814 (defvar ispell-process nil
815 "The process object for Ispell.")
817 (defvar ispell-async-processp
(and (fboundp 'kill-process
)
818 (fboundp 'process-send-string
)
819 (fboundp 'accept-process-output
)
820 ;;(fboundp 'start-process)
821 ;;(fboundp 'set-process-filter)
822 ;;(fboundp 'process-kill-without-query)
824 "Non-nil means that the OS supports asynchronous processes.")
827 (if ispell-menu-map-needed
828 (let ((dicts (reverse (cons (cons "default" nil
) ispell-dictionary-alist
)))
829 (dir (if (boundp 'ispell-library-directory
) ispell-library-directory
))
830 (dict-map (make-sparse-keymap "Dictionaries"))
832 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
833 ;; add the dictionaries to the bottom of the list.
834 (define-key ispell-menu-map
[default]
835 '("Select Default Dict"
836 "Dictionary for which Ispell was configured"
837 . (lambda () (interactive)
838 (ispell-change-dictionary "default"))))
839 (fset 'ispell-dict-map dict-map)
840 (define-key ispell-menu-map [dictionaries]
841 `(menu-item "Select Dict" ispell-dict-map))
843 (setq name (car dict)
844 load-dict (car (cdr (member "-d" (nth 5 dict)))))
845 (cond ((not (stringp name)))
846 ((or (not dir) ; load all if library dir not defined
847 (file-exists-p (concat dir "/" name ".hash"))
848 (file-exists-p (concat dir "/" name ".has"))
850 (or (file-exists-p (concat dir "/" load-dict ".hash"))
851 (file-exists-p (concat dir "/" load-dict ".has")))))
852 (define-key dict-map (vector (intern name))
853 (cons (concat "Select " (capitalize name) " Dict")
854 `(lambda () (interactive)
855 (ispell-change-dictionary ,name)))))))))
858 ;;; define commands in menu in opposite order you want them to appear.
860 (if ispell-menu-map-needed
862 (define-key ispell-menu-map [ispell-change-dictionary]
863 '(menu-item "Change Dictionary..." ispell-change-dictionary
864 :help "Supply explicit dictionary file name"))
865 (define-key ispell-menu-map [ispell-kill-ispell]
866 '(menu-item "Kill Process" ispell-kill-ispell
867 :enable (and (boundp 'ispell-process) ispell-process
868 (eq (ispell-process-status) 'run))
869 :help "Terminate Ispell subprocess"))
870 (define-key ispell-menu-map [ispell-pdict-save]
871 '(menu-item "Save Dictionary"
872 (lambda () (interactive) (ispell-pdict-save t t))
873 :help "Save personal dictionary"))
874 (define-key ispell-menu-map [ispell-customize]
875 '(menu-item "Customize..."
876 (lambda () (interactive) (customize-group 'ispell))
877 :help "Customize spell checking options"))
878 (define-key ispell-menu-map [ispell-help]
879 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
881 (lambda () (interactive) (describe-function 'ispell-help))
882 :help "Show standard Ispell keybindings and commands"))
883 (define-key ispell-menu-map [flyspell-mode]
884 '(menu-item "Automatic spell checking (Flyspell)"
886 :help "Check spelling while you edit the text"
887 :button (:toggle . flyspell-mode)))
888 (define-key ispell-menu-map [ispell-complete-word]
889 '(menu-item "Complete Word" ispell-complete-word
890 :help "Complete word at cursor using dictionary"))
891 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
892 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
893 :help "Complete word fragment at cursor"))))
896 (if ispell-menu-map-needed
898 (define-key ispell-menu-map [ispell-continue]
899 '(menu-item "Continue Spell-Checking" ispell-continue
900 :enable (and (boundp 'ispell-region-end)
901 (marker-position ispell-region-end)
902 (equal (marker-buffer ispell-region-end)
904 :help "Continue spell checking last region"))
905 (define-key ispell-menu-map [ispell-word]
906 '(menu-item "Spell-Check Word" ispell-word
907 :help "Spell-check word at cursor"))
908 (define-key ispell-menu-map [ispell-comments-and-strings]
909 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
910 :help "Spell-check only comments and strings"))))
913 (if ispell-menu-map-needed
915 (define-key ispell-menu-map [ispell-region]
916 '(menu-item "Spell-Check Region" ispell-region
918 :help "Spell-check text in marked region"))
919 (define-key ispell-menu-map [ispell-message]
920 '(menu-item "Spell-Check Message" ispell-message
921 :help "Skip headers and included message text"))
922 (define-key ispell-menu-map [ispell-buffer]
923 '(menu-item "Spell-Check Buffer" ispell-buffer
924 :help "Check spelling of selected buffer"))
925 ;;(put 'ispell-region 'menu-enable 'mark-active)
926 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
928 ;;; XEmacs versions 19 & 20
929 (if (and (featurep 'xemacs)
931 (null ispell-menu-xemacs)
932 (not (and (boundp 'infodock-version) infodock-version)))
933 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
934 (current-menubar (or current-menubar default-menubar))
936 '(["Help" (describe-function 'ispell-help) t]
937 ;;["Help" (popup-menu ispell-help-list) t]
938 ["Check Message" ispell-message t]
939 ["Check Buffer" ispell-buffer t]
940 ["Check Comments" ispell-comments-and-strings t]
941 ["Check Word" ispell-word t]
942 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
943 ["Continue Check" ispell-continue t]
944 ["Complete Word Frag"ispell-complete-word-interior-frag t]
945 ["Complete Word" ispell-complete-word t]
946 ["Kill Process" ispell-kill-ispell t]
948 ["Save Personal Dict"(ispell-pdict-save t t) t]
949 ["Change Dictionary" ispell-change-dictionary t]
950 ["Select Default" (ispell-change-dictionary "default") t]))
953 (setq name (car (car dicts))
954 load-dict (car (cdr (member "-d" (nth 5 (car dicts)))))
956 ;; Include if the dictionary is in the library, or dir not defined.
957 (if (and (stringp name)
958 (or (not ispell-library-directory)
959 (file-exists-p (concat ispell-library-directory "/"
961 (file-exists-p (concat ispell-library-directory "/"
964 (or (file-exists-p (concat ispell-library-directory "/"
966 (file-exists-p (concat ispell-library-directory "/"
967 load-dict ".has"))))))
968 (setq menu (append menu
970 (vector (concat "Select " (capitalize name))
971 (list 'ispell-change-dictionary name)
973 (setq ispell-menu-xemacs menu)
976 (delete-menu-item '("Edit" "Spell")) ; in case already defined
977 (add-menu '("Edit") "Spell" ispell-menu-xemacs)))))
979 ;;; Allow incrementing characters as integers in XEmacs 20
980 (if (and (featurep 'xemacs)
982 (fset 'ispell-int-char 'int-char)
983 ;; Emacs and XEmacs 19 or earlier
984 (fset 'ispell-int-char 'identity))
987 ;;; **********************************************************************
990 ;;; This variable contains the current dictionary being used if the ispell
991 ;;; process is running. Otherwise it contains the global default.
992 (defvar ispell-dictionary nil
993 "The name of the current dictionary, or nil for the default.
994 When `ispell-local-dictionary' is nil, `ispell-dictionary' is used to select
995 the dictionary for new buffers.
997 This is passed to the ispell process using the `-d' switch and is
998 used as key in `ispell-dictionary-alist' (which see).")
1000 (defun ispell-decode-string (str)
1001 "Decodes multibyte character strings.
1002 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1003 (if (and (or (featurep 'xemacs)
1004 (and (boundp 'enable-multibyte-characters)
1005 enable-multibyte-characters))
1006 (fboundp 'decode-coding-string)
1007 (ispell-get-coding-system))
1008 (decode-coding-string str (ispell-get-coding-system))
1011 (defun ispell-get-casechars ()
1012 (ispell-decode-string
1013 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist))))
1014 (defun ispell-get-not-casechars ()
1015 (ispell-decode-string
1016 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist))))
1017 (defun ispell-get-otherchars ()
1018 (ispell-decode-string
1019 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist))))
1020 (defun ispell-get-many-otherchars-p ()
1021 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
1022 (defun ispell-get-ispell-args ()
1023 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
1024 (defun ispell-get-extended-character-mode ()
1025 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
1026 (defun ispell-get-coding-system ()
1027 (nth 7 (assoc ispell-dictionary ispell-dictionary-alist)))
1030 (defvar ispell-pdict-modified-p nil
1031 "Non-nil means personal dictionary has modifications to be saved.")
1033 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1034 ;;; When non-nil, the spell session is terminated.
1035 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1036 (defvar ispell-quit nil)
1038 (defvar ispell-process-directory nil
1039 "The directory where `ispell-process' was started.")
1041 (defvar ispell-filter nil
1042 "Output filter from piped calls to Ispell.")
1044 (defvar ispell-filter-continue nil
1045 "Control variable for Ispell filter function.")
1047 (defvar ispell-output-buffer nil
1048 "Buffer used for reading output of a synchronous Ispell subprocess.")
1050 (defvar ispell-session-buffer nil
1051 "Buffer used for passing input to a synchronous Ispell subprocess.")
1053 (defvar ispell-cmd-args nil
1054 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1056 (defvar ispell-query-replace-marker (make-marker)
1057 "Marker for `query-replace' processing.")
1059 (defvar ispell-recursive-edit-marker (make-marker)
1060 "Marker for return point from recursive edit.")
1062 (defvar ispell-checking-message nil
1063 "Non-nil when we're checking a mail message.")
1065 (defconst ispell-choices-buffer "*Choices*")
1067 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1069 ;;; *** Buffer Local Definitions ***
1071 (defconst ispell-words-keyword "LocalWords: "
1072 "The keyword for local oddly-spelled words to accept.
1073 The keyword will be followed by any number of local word spellings.
1074 There can be multiple of these keywords in the file.")
1076 (defconst ispell-dictionary-keyword "Local IspellDict: "
1077 "The keyword for a local dictionary to use.
1078 The keyword must be followed by a correct dictionary name in
1079 `ispell-dictionary-alist'. When multiple occurrences exist, the last keyword
1080 definition is used.")
1082 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1083 "The keyword for defining buffer local dictionaries.
1084 Keyword must be followed by the filename of a personal dictionary.
1085 The last occurring definition in the buffer will be used.")
1087 (defconst ispell-parsing-keyword "Local IspellParsing: "
1088 "The keyword for overriding default Ispell parsing.
1089 The above keyword string should be followed by `latex-mode' or
1090 `nroff-mode' to put the current buffer into the desired parsing mode.
1092 Extended character mode can be changed for this buffer by placing
1093 a `~' followed by an extended-character mode -- such as `~.tex'.
1094 The last occurring definition in the buffer will be used.")
1097 (defvar ispell-skip-region-alist
1098 '((ispell-words-keyword forward-line)
1099 (ispell-dictionary-keyword forward-line)
1100 (ispell-pdict-keyword forward-line)
1101 (ispell-parsing-keyword forward-line)
1102 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1103 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage" . "^---* End of [Ff]orwarded [Mm]essage")
1104 ;; Matches e-mail addresses, file names, http addresses, etc. The `-+'
1105 ;; pattern necessary for performance reasons when `-' part of word syntax.
1106 ("\\(-+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+\\)")
1107 ;; This is a pretty complex regexp. It can be simplified to the following:
1108 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1109 ;; but some valid text will be skipped, e.g. "his/her". This could be
1110 ;; fixed up (at the expense of a moderately more complex regexp)
1111 ;; by not allowing "/" to be the character which triggers the
1112 ;; identification of the computer name, e.g.:
1113 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1115 "Alist expressing beginning and end of regions not to spell check.
1116 The alist key must be a regular expression.
1117 Valid forms include:
1118 (KEY) - just skip the key.
1119 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1120 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1121 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1126 (defvar ispell-tex-skip-alists
1127 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1128 ;; All the standard LaTeX keywords from L. Lamport's guide:
1129 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1130 ;; \label, \nocite, \rule (in ispell - rest included here)
1131 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1132 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1133 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1134 ;;("\\\\author" ispell-tex-arg-end)
1135 ("\\\\bibliographystyle" ispell-tex-arg-end)
1136 ("\\\\makebox" ispell-tex-arg-end 0)
1137 ("\\\\e?psfig" ispell-tex-arg-end)
1138 ("\\\\document\\(class\\|style\\)" .
1139 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1140 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1141 ;; equation, minipage, picture, tabular, tabular* (ispell)
1142 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1143 ("list" ispell-tex-arg-end 2)
1144 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1145 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1146 "*Lists of regions to be skipped in TeX mode.
1147 First list is used raw.
1148 Second list has key placed inside \\begin{}.
1150 Delete or add any regions you want to be automatically selected
1151 for skipping in latex mode.")
1154 (defvar ispell-local-pdict ispell-personal-dictionary
1155 "A buffer local variable containing the current personal dictionary.
1156 If non-nil, the value must be a string, which is a file name.
1158 If you specify a personal dictionary for the current buffer which is
1159 different from the current personal dictionary, the effect is similar
1160 to calling \\[ispell-change-dictionary]. This variable is automatically
1161 set when defined in the file with either `ispell-pdict-keyword' or the
1162 local variable syntax.")
1164 (make-variable-buffer-local 'ispell-local-pdict)
1166 (defvar ispell-buffer-local-name nil
1167 "Contains the buffer name if local word definitions were used.
1168 Ispell is then restarted because the local words could conflict.")
1170 (defvar ispell-parser 'use-mode-name
1171 "*Indicates whether ispell should parse the current buffer as TeX Code.
1172 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1173 Default parser is `nroff'.
1174 Currently the only other valid parser is `tex'.
1176 You can set this variable in hooks in your init file -- eg:
1178 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1180 (defvar ispell-region-end (make-marker)
1181 "Marker that allows spelling continuations.")
1183 (defvar ispell-check-only nil
1184 "If non-nil, `ispell-word' does not try to correct the word.")
1187 ;;; **********************************************************************
1188 ;;; **********************************************************************
1193 (define-key esc-map "$" 'ispell-word)
1196 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1197 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1198 If asynchronous subprocesses are not supported, call `ispell-filter' and
1199 pass it the output of the last ispell invocation."
1200 (if ispell-async-processp
1201 (accept-process-output ispell-process timeout-secs timeout-msecs)
1202 (if (null ispell-process)
1203 (error "No Ispell process to read output from!")
1204 (let ((buf ispell-output-buffer)
1206 (if (not (bufferp buf))
1207 (setq ispell-filter nil)
1210 (setq ispell-output (buffer-substring-no-properties
1211 (point-min) (point-max))))
1212 (ispell-filter t ispell-output)
1215 (erase-buffer)))))))
1218 (defun ispell-send-string (string)
1219 "Send the string STRING to the Ispell process."
1220 (if ispell-async-processp
1221 (process-send-string ispell-process string)
1222 ;; Asynchronous subprocesses aren't supported on this losing system.
1223 ;; We keep all the directives passed to Ispell during the entire
1224 ;; session in a buffer, and pass them anew each time we invoke
1225 ;; Ispell to process another chunk of text. (Yes, I know this is a
1226 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1227 (let ((cmd (aref string 0))
1228 ;; The following commands are not passed to Ispell until
1229 ;; we have a *real* reason to invoke it.
1230 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1231 (default-major-mode 'fundamental-mode)
1232 (session-buf ispell-session-buffer)
1233 (output-buf ispell-output-buffer)
1234 (ispell-args ispell-cmd-args)
1235 (defdir ispell-process-directory)
1238 (set-buffer session-buf)
1239 (setq prev-pos (point))
1240 (setq default-directory defdir)
1242 (if (not (memq cmd cmds-to-defer))
1243 (let (coding-system-for-read coding-system-for-write status)
1244 (if (or (featurep 'xemacs)
1245 (and (boundp 'enable-multibyte-characters)
1246 enable-multibyte-characters))
1247 (setq coding-system-for-read (ispell-get-coding-system)
1248 coding-system-for-write (ispell-get-coding-system)))
1249 (set-buffer output-buf)
1251 (set-buffer session-buf)
1253 (apply 'call-process-region (point-min) (point-max)
1254 ispell-program-name nil
1256 "-a" "-m" ispell-args))
1257 (set-buffer output-buf)
1258 (goto-char (point-min))
1260 (if (not (looking-at "@(#) "))
1261 (error "Ispell error: %s"
1262 (buffer-substring-no-properties
1263 (point) (progn (end-of-line) (point)))))
1264 ;; If STRING is "^Z\n", we just started Ispell and need
1265 ;; to retain its version ID line in the output buffer.
1266 ;; Otherwise, remove the ID line, as it will confuse
1268 (or (string= string "\032\n")
1271 (delete-region (point-min) (point))))
1272 ;; If STRING begins with ^ or any normal character, we need
1273 ;; to remove the last line from the session buffer, since it
1274 ;; was just spell-checked, and we don't want to check it again.
1275 ;; The same goes for the # command, since Ispell already saved
1276 ;; the personal dictionary.
1277 (set-buffer session-buf)
1278 (delete-region prev-pos (point))
1279 ;; Ispell run synchronously saves the personal dictionary
1280 ;; after each successful command. So we can remove any
1281 ;; lines in the session buffer that insert words into the
1283 (if (memq status '(0 nil))
1284 (let ((more-lines t))
1285 (goto-char (point-min))
1287 (if (looking-at "^\\*")
1288 (let ((start (point)))
1290 (delete-region start (point)))
1291 (setq more-lines (= 0 (forward-line))))))))))))))
1296 (defun ispell-word (&optional following quietly continue)
1297 "Check spelling of word under or before the cursor.
1298 If the word is not found in dictionary, display possible corrections
1299 in a window allowing you to choose one.
1301 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1302 is non-nil when called interactively, then the following word
1303 \(rather than preceding\) is checked when the cursor is not over a word.
1304 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1305 when called interactively, non-corrective messages are suppressed.
1307 With a prefix argument (or if CONTINUE is non-nil),
1308 resume interrupted spell-checking of a buffer or region.
1310 Word syntax described by `ispell-dictionary-alist' (which see).
1312 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1313 or \\[ispell-region] to update the Ispell process.
1316 nil word is correct or spelling is accpeted.
1317 0 word is inserted into buffer-local definitions.
1318 \"word\" word corrected from word list.
1319 \(\"word\" arg\) word is hand entered.
1320 quit spell session exited."
1322 (interactive (list nil nil current-prefix-arg))
1326 (setq following ispell-following-word
1327 quietly ispell-quietly))
1328 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1329 (let ((cursor-location (point)) ; retain cursor location
1330 (word (ispell-get-word following))
1331 start end poss new-word replace)
1332 ;; De-structure return word info list.
1333 (setq start (car (cdr word))
1334 end (car (cdr (cdr word)))
1337 ;; now check spelling of word if it has 3 or more characters.
1339 ((> (length word) 2)
1341 (message "Checking spelling of %s..."
1342 (funcall ispell-format-word word)))
1343 (ispell-send-string "%\n") ; put in verbose mode
1344 (ispell-send-string (concat "^" word "\n"))
1345 ;; wait until ispell has processed word
1347 (ispell-accept-output)
1348 (not (string= "" (car ispell-filter)))))
1349 ;;(ispell-send-string "!\n") ;back to terse mode.
1350 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1351 (if (and ispell-filter (listp ispell-filter))
1352 (if (> (length ispell-filter) 1)
1353 (error "Ispell and its process have different character maps")
1354 (setq poss (ispell-parse-output (car ispell-filter)))))
1357 (message "%s is correct"
1358 (funcall ispell-format-word word))))
1361 (message "%s is correct because of root %s"
1362 (funcall ispell-format-word word)
1363 (funcall ispell-format-word poss))))
1364 ((null poss) (message "Error in ispell process"))
1365 (ispell-check-only ; called from ispell minor mode.
1367 (message "%s is incorrect" (funcall ispell-format-word word)))
1368 (t ; prompt for correct word.
1369 (save-window-excursion
1370 (setq replace (ispell-command-loop
1371 (car (cdr (cdr poss)))
1372 (car (cdr (cdr (cdr poss))))
1373 (car poss) start end)))
1374 (cond ((equal 0 replace)
1375 (ispell-add-per-file-word-list (car poss)))
1377 (setq new-word (if (atom replace) replace (car replace))
1378 cursor-location (+ (- (length word) (- end start))
1380 (if (not (equal new-word (car poss)))
1382 (delete-region start end)
1383 (setq start (point))
1385 (setq end (point))))
1386 (if (not (atom replace)) ;recheck spelling of replacement
1388 (if (car (cdr replace)) ; query replace requested
1389 (save-window-excursion
1390 (query-replace word new-word t)))
1392 ;; single word could be split into multiple words
1393 (setq ispell-quit (not (ispell-region start end)))
1395 ;; keep if rechecking word and we keep choices win.
1396 (if (get-buffer ispell-choices-buffer)
1397 (kill-buffer ispell-choices-buffer))))
1398 (ispell-pdict-save ispell-silently-savep)
1399 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1400 (if ispell-quit (setq ispell-quit nil replace 'quit))))
1401 (goto-char cursor-location) ; return to original location
1405 (defun ispell-get-word (following &optional extra-otherchars)
1406 "Return the word for spell-checking according to ispell syntax.
1407 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1408 is non-nil when called interactively, then the following word
1409 \(rather than preceding\) is checked when the cursor is not over a word.
1410 Optional second argument contains otherchars that can be included in word
1413 Word syntax described by `ispell-dictionary-alist' (which see)."
1414 (let* ((ispell-casechars (ispell-get-casechars))
1415 (ispell-not-casechars (ispell-get-not-casechars))
1416 (ispell-otherchars (ispell-get-otherchars))
1417 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1418 (word-regexp (concat ispell-casechars
1420 (if (not (string= "" ispell-otherchars))
1421 (concat ispell-otherchars "?"))
1422 (if extra-otherchars
1423 (concat extra-otherchars "?"))
1426 (if (or ispell-many-otherchars-p
1432 (if (not (looking-at ispell-casechars))
1434 (re-search-forward ispell-casechars (point-max) t)
1435 (re-search-backward ispell-casechars (point-min) t)))
1436 ;; move to front of word
1437 (re-search-backward ispell-not-casechars (point-min) 'start)
1438 (while (and (or (and (not (string= "" ispell-otherchars))
1439 (looking-at ispell-otherchars))
1440 (and extra-otherchars (looking-at extra-otherchars)))
1442 (or (not did-it-once)
1443 ispell-many-otherchars-p)
1444 (not (eq prevpt (point))))
1445 (if (and extra-otherchars (looking-at extra-otherchars))
1448 (if (looking-at ispell-casechars)
1449 (re-search-backward ispell-not-casechars (point-min) 'move)))
1453 (if (looking-at ispell-casechars)
1454 (re-search-backward ispell-not-casechars (point-min) 'move)
1455 (backward-char -1))))
1456 ;; Now mark the word and save to string.
1457 (if (not (re-search-forward word-regexp (point-max) t))
1458 (if ispell-check-only
1459 ;; return dummy word when just flagging misspellings
1460 (list "" (point) (point))
1461 (error "No word found to check!"))
1462 (setq start (match-beginning 0)
1464 word (buffer-substring-no-properties start end))
1465 (list word start end))))
1468 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1469 ;;; tracks changes in the dictionary. The global may either be
1470 ;;; a value or a list, whose value is the state of whether the
1471 ;;; dictionary needs to be saved.
1474 (defun ispell-pdict-save (&optional no-query force-save)
1475 "Check to see if the personal dictionary has been modified.
1476 If so, ask if it needs to be saved."
1477 (interactive (list ispell-silently-savep t))
1478 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1479 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1480 (if (or ispell-pdict-modified-p force-save)
1481 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1483 (ispell-send-string "#\n") ; save dictionary
1484 (message "Personal dictionary saved."))))
1485 ;; unassert variable, even if not saved to avoid questioning.
1486 (setq ispell-pdict-modified-p nil))
1489 (defun ispell-command-loop (miss guess word start end)
1490 "Display possible corrections from list MISS.
1491 GUESS lists possibly valid affix construction of WORD.
1492 Returns nil to keep word.
1493 Returns 0 to insert locally into buffer-local dictionary.
1494 Returns string for new chosen word.
1495 Returns list for new replacement word (will be rechecked).
1496 Query-replace when list length is 2.
1497 Automatic query-replace when second element is `query-replace'.
1498 Highlights the word, which is assumed to run from START to END.
1499 Global `ispell-pdict-modified-p' becomes a list where the only value
1500 indicates whether the dictionary has been modified when option `a' or `i' is
1502 Global `ispell-quit' set to start location to continue spell session."
1504 (line ispell-choices-win-default-height)
1505 ;; ensure 4 context lines.
1506 (max-lines (- (ispell-adjusted-window-height) 4))
1508 (window-min-height (min window-min-height
1509 ispell-choices-win-default-height))
1510 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1511 (dedicated (window-dedicated-p (selected-window)))
1513 char num result textwin dedicated-win)
1515 ;; setup the *Choices* buffer with valid data.
1517 (set-buffer (get-buffer-create ispell-choices-buffer))
1518 (setq mode-line-format (concat "-- %b -- word: " word))
1519 ;; XEmacs: prevent thick modeline vs increasing height in overlay-window
1520 ;;(and (fboundp 'set-specifier)
1521 ;; (set-specifier has-modeline-p (cons (current-buffer) nil)))
1525 (insert "Affix rules generate and capitalize "
1526 "this word as shown below:\n\t")
1528 (if (> (+ 4 (current-column) (length (car guess)))
1532 (setq line (1+ line))))
1533 (insert (car guess) " ")
1534 (setq guess (cdr guess)))
1535 (insert "\nUse option `i' if this is a correct composition"
1536 " from the derivative root.\n")
1537 (setq line (+ line (if choices 3 2)))))
1539 (< (if (> (+ 7 (current-column) (length (car choices))
1540 (if (> count ?~) 3 0))
1544 (setq line (1+ line)))
1547 ;; not so good if there are over 20 or 30 options, but then, if
1548 ;; there are that many you don't want to scan them all anyway...
1549 (while (memq count command-characters) ; skip command characters.
1550 (setq count (ispell-int-char (1+ count))
1551 skipped (1+ skipped)))
1552 (insert "(" count ") " (car choices) " ")
1553 (setq choices (cdr choices)
1554 count (ispell-int-char (1+ count))))
1555 (setq count (ispell-int-char (- count ?0 skipped))))
1557 ;; ensure word is visible
1558 (if (not (pos-visible-in-window-p end))
1561 ;; allow temporary split of dedicated windows...
1564 (setq dedicated-win (selected-window))
1565 (set-window-dedicated-p dedicated-win nil)))
1567 ;; Display choices for misspelled word.
1568 (ispell-show-choices line end)
1569 (select-window (setq textwin (next-window)))
1571 ;; highlight word, protecting current buffer status
1574 (and ispell-highlight-p
1575 (ispell-highlight-spelling-error start end t))
1576 ;; Loop until a valid choice is made.
1584 (let (message-log-max)
1585 (message (concat "C-h or ? for more options; SPC to leave "
1586 "unchanged, Character to replace word")))
1587 (let ((inhibit-quit t))
1588 (setq char (if (fboundp 'read-char-exclusive)
1589 (read-char-exclusive)
1592 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1595 ;; Adjust num to array offset skipping command characters.
1596 (let ((com-chars command-characters))
1598 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1599 (setq skipped (1+ skipped)))
1600 (setq com-chars (cdr com-chars)))
1601 (setq num (- char ?0 skipped)))
1604 ((= char ? ) nil) ; accept word this time only
1605 ((= char ?i) ; accept and insert word into pers dict
1606 (ispell-send-string (concat "*" word "\n"))
1607 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1609 ((or (= char ?a) (= char ?A)) ; accept word without insert
1610 (ispell-send-string (concat "@" word "\n"))
1611 (if (null ispell-pdict-modified-p)
1612 (setq ispell-pdict-modified-p
1613 (list ispell-pdict-modified-p)))
1614 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1615 ((or (= char ?r) (= char ?R)) ; type in replacement
1616 (and (eq 'block ispell-highlight-p) ; refresh tty's
1617 (ispell-highlight-spelling-error start end nil t))
1619 (if (or (= char ?R) ispell-query-replace-choices)
1621 (format "Query-replacement for %s: "word)
1624 (cons (read-string "Replacement for: " word)
1626 (and (eq 'block ispell-highlight-p)
1627 (ispell-highlight-spelling-error start end nil
1630 ((or (= char ??) (= char help-char) (= char ?\C-h))
1631 (and (eq 'block ispell-highlight-p)
1632 (ispell-highlight-spelling-error start end nil t))
1634 (and (eq 'block ispell-highlight-p)
1635 (ispell-highlight-spelling-error start end nil
1638 ;; Quit and move point back.
1640 (ispell-pdict-save ispell-silently-savep)
1641 (message "Exited spell-checking")
1642 (setq ispell-quit t)
1644 ;; Quit and preserve point.
1646 (ispell-pdict-save ispell-silently-savep)
1648 (substitute-command-keys
1649 (concat "Spell-checking suspended;"
1650 " use C-u \\[ispell-word] to resume")))
1651 (setq ispell-quit start)
1654 (if (y-or-n-p "Really kill Ispell process? ")
1656 (ispell-kill-ispell t) ; terminate process.
1657 (setq ispell-quit (or (not ispell-checking-message)
1659 ispell-pdict-modified-p nil))
1660 t)) ; continue if they don't quit.
1662 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1663 (ispell-highlight-spelling-error start end nil t))
1664 (let ((new-word (read-string
1665 "Lookup string (`*' is wildcard): "
1670 (set-buffer (get-buffer-create
1671 ispell-choices-buffer))
1675 mode-line-format (concat
1678 miss (lookup-words new-word)
1680 line ispell-choices-win-default-height)
1681 (while (and choices ; adjust choices window.
1682 (< (if (> (+ 7 (current-column)
1683 (length (car choices))
1684 (if (> count ?~) 3 0))
1688 (setq line (1+ line)))
1691 (while (memq count command-characters)
1692 (setq count (ispell-int-char (1+ count))
1693 skipped (1+ skipped)))
1694 (insert "(" count ") " (car choices) " ")
1695 (setq choices (cdr choices)
1696 count (ispell-int-char (1+ count))))
1697 (setq count (ispell-int-char
1698 (- count ?0 skipped))))
1699 (ispell-show-choices line end)
1700 (select-window (next-window)))))
1701 (and (eq 'block ispell-highlight-p)
1702 (ispell-highlight-spelling-error start end nil
1704 t) ; reselect from new choices
1705 ((= char ?u) ; insert lowercase into dictionary
1706 (ispell-send-string (concat "*" (downcase word) "\n"))
1707 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1709 ((= char ?m) ; type in what to insert
1711 (concat "*" (read-string "Insert: " word) "\n"))
1712 (setq ispell-pdict-modified-p '(t))
1714 ((and (>= num 0) (< num count))
1715 (if ispell-query-replace-choices ; Query replace flag
1716 (list (nth num miss) 'query-replace)
1721 ;; This may have alignment errors if current line is edited
1722 (if (marker-position ispell-recursive-edit-marker)
1724 (message "Only one recursive edit session supported")
1727 (set-marker ispell-recursive-edit-marker start)
1728 ;;(set-marker ispell-region-end reg-end)
1729 (and ispell-highlight-p ; unhighlight
1730 (ispell-highlight-spelling-error start end))
1735 (substitute-command-keys
1736 (concat "Exit recursive edit with"
1737 " \\[exit-recursive-edit]")))
1738 (save-window-excursion (save-excursion
1741 (goto-char ispell-recursive-edit-marker)
1742 (if (not (equal (marker-buffer
1743 ispell-recursive-edit-marker)
1746 (set-marker ispell-recursive-edit-marker nil)
1748 "Cannot continue ispell from this buffer.")))
1749 (set-marker ispell-recursive-edit-marker nil)))
1750 (list word nil)) ; recheck starting at this word.
1752 (funcall (key-binding "\C-z"))
1757 (and ispell-highlight-p ; unhighlight
1758 (save-window-excursion
1759 (select-window textwin)
1760 (ispell-highlight-spelling-error start end)))
1762 (set-window-dedicated-p dedicated-win t)))))
1766 (defun ispell-show-choices (line end)
1767 "Shows the choices in another buffer or frame."
1768 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
1770 (framepop-display-buffer (get-buffer ispell-choices-buffer))
1771 (get-buffer-window ispell-choices-buffer t)
1772 (select-window (previous-window))) ; *Choices* window
1773 ;; standard selection by splitting a small buffer out of this window.
1774 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1776 (if (= line (ispell-adjusted-window-height choices-window))
1777 (select-window choices-window)
1778 ;; *Choices* window changed size. Adjust the choices window
1779 ;; without scrolling the spelled window when possible
1781 (- line (ispell-adjusted-window-height choices-window)))
1782 (visible (progn (vertical-motion -1) (point))))
1783 (if (< line ispell-choices-win-default-height)
1784 (setq window-line (+ window-line
1785 (- ispell-choices-win-default-height
1787 (move-to-window-line 0)
1788 (vertical-motion window-line)
1789 (set-window-start (selected-window)
1790 (if (> (point) visible) visible (point)))
1792 (select-window (previous-window)) ; *Choices* window
1793 (enlarge-window window-line)))
1794 ;; Overlay *Choices* window when it isn't showing
1795 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1796 (switch-to-buffer ispell-choices-buffer)
1797 (goto-char (point-min)))))
1801 (defun ispell-help ()
1802 "Display a list of the options available when a misspelling is encountered.
1806 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1807 SPC: Accept word this time.
1808 `i': Accept word and insert into private dictionary.
1809 `a': Accept word for this session.
1810 `A': Accept word and place in `buffer-local dictionary'.
1811 `r': Replace word with typed-in value. Rechecked.
1812 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1813 `?': Show these commands.
1814 `x': Exit spelling buffer. Move cursor to original point.
1815 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1816 the aborted check to be completed later.
1817 `q': Quit spelling session (Kills ispell process).
1818 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1819 `u': Like `i', but the word is lower-cased first.
1820 `m': Place typed-in value in personal dictionary, then recheck current word.
1821 `C-l': redraws screen
1822 `C-r': recursive edit
1823 `C-z': suspend emacs or iconify frame"
1825 (if (equal ispell-help-in-bufferp 'electric)
1829 (function (lambda ()
1830 ;;This shouldn't be necessary: with-electric-help needs
1831 ;; an optional argument telling it about the smallest
1832 ;; acceptable window-height of the help buffer.
1833 (if (< (window-height) 15)
1835 (- 15 (ispell-adjusted-window-height))))
1836 (princ "Selections are:
1838 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1839 SPC: Accept word this time.
1840 `i': Accept word and insert into private dictionary.
1841 `a': Accept word for this session.
1842 `A': Accept word and place in `buffer-local dictionary'.
1843 `r': Replace word with typed-in value. Rechecked.
1844 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1845 `?': Show these commands.
1846 `x': Exit spelling buffer. Move cursor to original point.
1847 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1848 the aborted check to be completed later.
1849 `q': Quit spelling session (Kills ispell process).
1850 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1851 `u': Like `i', but the word is lower-cased first.
1852 `m': Place typed-in value in personal dictionary, then recheck current word.
1853 `C-l': redraws screen
1854 `C-r': recursive edit
1855 `C-z': suspend emacs or iconify frame")
1856 nil ;undocumented requirement of with-electric-help
1860 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1861 "[i]nsert into private dictionary"))
1862 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1863 "e[x/X]it; [q]uit session"))
1864 (help-3 (concat "[u]ncapitalized insert into dict. "
1865 "Type 'x C-h d ispell-help' for more help")))
1866 (save-window-excursion
1867 (if ispell-help-in-bufferp
1869 (ispell-overlay-window 4)
1870 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1871 (insert (concat help-1 "\n" help-2 "\n" help-3))
1873 (kill-buffer "*Ispell Help*"))
1876 (select-window (minibuffer-window))
1879 ;;(set-minibuffer-window (selected-window))
1881 (insert (concat help-1 "\n" help-2 "\n" help-3))
1883 (erase-buffer)))))))
1886 (defun lookup-words (word &optional lookup-dict)
1887 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
1888 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1889 Otherwise the variable `ispell-grep-command' contains the command used to
1890 search for the words (usually egrep).
1892 Optional second argument contains the dictionary to use; the default is
1893 `ispell-alternate-dictionary'."
1894 ;; We don't use the filter for this function, rather the result is written
1895 ;; into a buffer. Hence there is no need to save the filter values.
1896 (if (null lookup-dict)
1897 (setq lookup-dict ispell-alternate-dictionary))
1899 (let* ((process-connection-type ispell-use-ptys-p)
1900 (wild-p (string-match "\\*" word))
1901 (look-p (and ispell-look-p ; Only use look for an exact match.
1902 (or ispell-have-new-look (not wild-p))))
1903 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1904 (prog (if look-p ispell-look-command ispell-grep-command))
1905 (args (if look-p ispell-look-options ispell-grep-options))
1908 (save-window-excursion
1909 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1910 (set-buffer ispell-grep-buffer)
1914 (insert "^" word "$")
1915 (while (search-backward "*" nil t) (insert "."))
1916 (setq word (buffer-string))
1918 (setq status (if lookup-dict
1919 (call-process prog nil t nil args word lookup-dict)
1920 (call-process prog nil t nil args word)))
1921 ;; grep returns status 1 and no output when word not found, which
1922 ;; is a perfectly normal thing.
1923 (if (stringp status)
1924 (setq results (cons (format "error: %s exited with signal %s"
1925 (file-name-nondirectory prog) status)
1927 ;; else collect words into `results' in FIFO order
1928 (goto-char (point-max))
1929 ;; assure we've ended with \n
1930 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1934 (setq results (cons (buffer-substring-no-properties (point)
1938 (kill-buffer ispell-grep-buffer)
1939 (if (and results (string-match ".+: " (car results)))
1940 (error "%s error: %s" ispell-grep-command (car results))))
1944 ;;; "ispell-filter" is a list of output lines from the generating function.
1945 ;;; Each full line (ending with \n) is a separate item on the list.
1946 ;;; "output" can contain multiple lines, part of a line, or both.
1947 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1949 ;;; "ispell-filter-continue" is true when we have received only part of a
1950 ;;; line as output from a generating function ("output" did not end with \n)
1951 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
1952 ;;; This is the case when a process dies or fails. The default behavior
1953 ;;; in this case treats the next input received as fresh input.
1955 (defun ispell-filter (process output)
1956 "Output filter function for ispell, grep, and look."
1961 (setq end (string-match "\n" output start)) ; get text up to the newline.
1962 ;; If we get out of sync and ispell-filter-continue is asserted when we
1963 ;; are not continuing, treat the next item as a separate list. When
1964 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1967 ;; Continue with same line (item)?
1968 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1969 ;; Yes. Add it to the prev item
1970 (setcar ispell-filter
1971 (concat (car ispell-filter) (substring output start end)))
1972 ;; No. This is a new line and item.
1974 (cons (substring output start end) ispell-filter)))
1976 ;; We've completed reading the output, but didn't finish the line.
1977 (setq ispell-filter-continue t continue nil)
1978 ;; skip over newline, this line complete.
1979 (setq ispell-filter-continue nil end (1+ end))
1980 (if (= end (length output)) ; No more lines in output
1981 (setq continue nil) ; so we can exit the filter.
1982 (setq start end)))))) ; else move start to next line of input
1985 ;;; This function destroys the mark location if it is in the word being
1987 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
1989 "Highlight the word from START to END with a kludge using `inverse-video'.
1990 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1991 otherwise it is displayed normally.
1992 Uses block cursor to highlight one character.
1993 Optional REFRESH will unhighlighted then highlight, using block cursor
1994 highlighting when REFRESH is equal to `block'."
1995 (and (eq 'block ispell-highlight-p)
1996 (or (eq 'block refresh)
1997 (setq start (1+ start)))) ; On block non-refresh, inc start.
1998 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1999 (buffer-read-only nil) ; Allow highlighting read-only buffers.
2000 (text (buffer-substring-no-properties start end)) ; Save hilight region
2001 (inhibit-quit t) ; inhibit interrupt processing here.
2002 (buffer-undo-list t)) ; don't clutter the undo list.
2004 (delete-region start end)
2005 (insert-char ? (- end start)) ; minimize amount of redisplay
2006 (sit-for 0) ; update display
2007 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2008 (delete-region start end) ; delete whitespace
2009 (insert text) ; insert text in inverse video.
2010 (sit-for 0) ; update display showing inverse video.
2013 (setq inverse-video (not inverse-video)) ; toggle video
2014 (and (eq 'block ispell-highlight-p)
2015 (goto-char (1- start)))) ; use block cursor to "highlight" char
2016 (set-buffer-modified-p modified) ; don't modify if flag not set.
2017 (and refresh ; re-highlight
2018 (ispell-highlight-spelling-error-generic
2019 (if (eq 'block refresh) start (- start 2)) end t))))
2022 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
2023 "Highlight the word from START to END using `isearch-highlight'.
2024 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2025 otherwise it is displayed normally."
2027 (isearch-highlight start end)
2028 (isearch-dehighlight t))
2033 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
2034 "Highlight the word from START to END using overlays.
2035 When the optional third arg HIGHLIGHT is set, the word is highlighted
2036 otherwise it is displayed normally.
2038 The variable `ispell-highlight-face' selects the face to use for highlighting."
2041 (setq ispell-overlay (make-overlay start end))
2042 (overlay-put ispell-overlay 'face ispell-highlight-face))
2043 (delete-overlay ispell-overlay)))
2046 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2049 (ispell-highlight-spelling-error-xemacs start end highlight))
2050 ((and (featurep 'faces)
2051 (or (and (fboundp 'display-color-p) (display-color-p))
2053 (ispell-highlight-spelling-error-overlay start end highlight))
2054 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2056 (defun ispell-adjusted-window-height (&optional window)
2057 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2058 The value returned is actually the nominal number of text-lines in the
2059 window plus 1. On a terminal, this is the same value returned by
2060 `window-height', but if the window has a mode-line is taller than a normal
2061 text line, the returned value may be smaller than that from
2063 (cond ((fboundp 'window-text-height)
2064 (1+ (window-text-height window)))
2065 ((if (fboundp 'display-graphic-p)
2068 (1- (window-height window)))
2070 (window-height window))))
2072 (defun ispell-overlay-window (height)
2073 "Create a window covering the top HEIGHT lines of the current window.
2074 Ensure that the line above point is still visible but otherwise avoid
2075 scrolling the current window. Leave the new window selected."
2077 (let ((oldot (save-excursion (vertical-motion -1) (point)))
2078 (top (save-excursion (move-to-window-line height) (point))))
2079 ;; If line above old point (line starting at oldot) would be
2080 ;; hidden by new window, scroll it to just below new win
2081 ;; otherwise set top line of other win so it doesn't scroll.
2082 (if (< oldot top) (setq top oldot))
2083 ;; if frame is unsplitable, temporarily disable that...
2084 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2085 (let ((frame (selected-frame)))
2086 (modify-frame-parameters frame '((unsplittable . nil)))
2087 (split-window nil height)
2088 (modify-frame-parameters frame '((unsplittable . t))))
2089 (split-window nil height))
2090 (let ((deficit (- height (ispell-adjusted-window-height))))
2092 ;; Number of lines the window is still too short. We ensure that
2093 ;; there are at least (1- HEIGHT) lines visible in the window.
2094 (enlarge-window deficit)
2096 (vertical-motion deficit)
2097 (setq top (min (point) oldot))))
2098 (set-window-start (next-window) top))))
2101 ;;; Should we add a compound word match return value?
2102 (defun ispell-parse-output (output &optional accept-list shift)
2103 "Parse the OUTPUT string from Ispell process and return:
2104 1: t for an exact match.
2105 2: A string containing the root word matched via suffix removal.
2106 3: A list of possible correct spellings of the format:
2107 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2108 ORIGINAL-WORD is a string of the possibly misspelled word.
2109 OFFSET is an integer giving the line offset of the word.
2110 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2111 4: nil when an error has occurred.
2113 Optional second arg ACCEPT-LIST is list of words already accepted.
2114 Optional third arg SHIFT is an offset to apply based on previous corrections."
2116 ((string= output "") t) ; for startup with pipes...
2117 ((string= output "*") t) ; exact match
2118 ((string= output "-") t) ; compound word match
2119 ((eq (aref output 0) ?+) ; found because of root word
2120 (substring output 2)) ; return root word
2121 ((equal 0 (string-match "[\ra-zA-Z]" output))
2122 (ding) ; error message from ispell!
2123 (message (concat "Ispell error: " output))
2126 (t ; need to process &, ?, and #'s
2127 (let ((type (aref output 0)) ; &, ?, or #
2128 (original-word (substring output 2 (string-match " " output 2)))
2129 (cur-count 0) ; contains number of misses + guesses
2130 count miss-list guess-list offset)
2131 (setq output (substring output (match-end 0))) ; skip over misspelling
2133 (setq count 0) ; no misses for type #
2134 (setq count (string-to-int output) ; get number of misses.
2135 output (substring output (1+ (string-match " " output 1)))))
2136 (setq offset (string-to-int output))
2137 (if (eq type ?#) ; No miss or guess list.
2139 (setq output (substring output (1+ (string-match " " output 1)))))
2141 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2142 (setq cur-count (1+ cur-count))
2143 (if (> cur-count count)
2144 (setq guess-list (cons (substring output 0 end) guess-list))
2145 (setq miss-list (cons (substring output 0 end) miss-list)))
2146 (if (match-end 1) ; True only when at end of line.
2147 (setq output nil) ; no more misses or guesses
2148 (setq output (substring output (+ end 2))))))
2149 ;; return results. Accept word if it was already accepted.
2151 (if (member original-word accept-list)
2154 (if (numberp shift) (+ shift offset) offset)
2155 (nreverse miss-list) (nreverse guess-list)))))))
2158 (defun ispell-process-status ()
2159 "Return the status of the Ispell process.
2160 When asynchronous processes are not supported, `run' is always returned."
2161 (if ispell-async-processp
2162 (process-status ispell-process)
2163 (and ispell-process 'run)))
2166 (defun ispell-start-process ()
2167 "Start the ispell process, with support for no asynchronous processes.
2168 Keeps argument list for future ispell invocations for no async support."
2170 ;; Local dictionary becomes the global dictionary in use.
2171 (if ispell-local-dictionary
2172 (setq ispell-dictionary ispell-local-dictionary))
2173 (setq args (ispell-get-ispell-args))
2174 (if ispell-dictionary ; use specified dictionary
2176 (append (list "-d" ispell-dictionary) args)))
2177 (if ispell-personal-dictionary ; use specified pers dict
2181 (expand-file-name ispell-personal-dictionary)))))
2182 (setq args (append args ispell-extra-args))
2184 (if ispell-async-processp
2185 (let ((process-connection-type ispell-use-ptys-p))
2186 (apply 'start-process
2187 "ispell" nil ispell-program-name
2188 "-a" ; accept single input lines
2189 "-m" ; make root/affix combos not in dict
2191 (setq ispell-cmd-args args
2192 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2193 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2194 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2199 (defun ispell-init-process ()
2200 "Check status of Ispell process and start if necessary."
2201 (if (and ispell-process
2202 (eq (ispell-process-status) 'run)
2203 ;; If we're using a personal dictionary, ensure
2204 ;; we're in the same default directory!
2205 (or (not ispell-personal-dictionary)
2206 (equal ispell-process-directory default-directory)))
2207 (setq ispell-filter nil ispell-filter-continue nil)
2208 ;; may need to restart to select new personal dictionary.
2209 (ispell-kill-ispell t)
2210 (message "Starting new Ispell process...")
2212 (check-ispell-version)
2213 (setq ispell-process-directory default-directory
2214 ispell-process (ispell-start-process)
2216 ispell-filter-continue nil)
2217 (if ispell-async-processp
2218 (set-process-filter ispell-process 'ispell-filter))
2219 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
2220 (if (and (or (featurep 'xemacs)
2221 (and (boundp 'enable-multibyte-characters)
2222 enable-multibyte-characters))
2223 (fboundp 'set-process-coding-system))
2224 (set-process-coding-system ispell-process (ispell-get-coding-system)
2225 (ispell-get-coding-system)))
2226 ;; Get version ID line
2227 (ispell-accept-output 3)
2228 ;; get more output if filter empty?
2229 (if (null ispell-filter) (ispell-accept-output 3))
2230 (cond ((null ispell-filter)
2231 (error "%s did not output version line" ispell-program-name))
2233 (stringp (car ispell-filter))
2234 (if (string-match "warning: " (car ispell-filter))
2236 (ispell-accept-output 3) ; was warn msg.
2237 (stringp (car ispell-filter)))
2238 (null (cdr ispell-filter)))
2239 (string-match "^@(#) " (car ispell-filter)))
2240 ;; got the version line as expected (we already know it's the right
2241 ;; version, so don't bother checking again.)
2244 ;; Otherwise, it must be an error message. Show the user.
2245 ;; But first wait to see if some more output is going to arrive.
2246 ;; Otherwise we get cool errors like "Can't open ".
2248 (ispell-accept-output 3)
2249 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2250 (setq ispell-filter nil) ; Discard version ID line
2251 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2252 (if extended-char-mode ; ~ extended character mode
2253 (ispell-send-string (concat extended-char-mode "\n"))))
2254 (if ispell-async-processp
2255 (process-kill-without-query ispell-process))))
2258 (defun ispell-kill-ispell (&optional no-error)
2259 "Kill current Ispell process (so that you may start a fresh one).
2260 With NO-ERROR, just return non-nil if there was no Ispell running."
2262 (if (not (and ispell-process
2263 (eq (ispell-process-status) 'run)))
2265 (error "There is no ispell process running!"))
2266 (if ispell-async-processp
2268 (process-send-eof ispell-process)
2269 (if (eq (ispell-process-status) 'run)
2270 (ispell-accept-output 1))
2271 (if (eq (ispell-process-status) 'run)
2272 (kill-process ispell-process))
2273 (while (not (or (eq (ispell-process-status) 'exit)
2274 (eq (ispell-process-status) 'signal)))
2276 ;; synchronous processes
2277 (ispell-send-string "\n") ; make sure side effects occurred.
2278 (kill-buffer ispell-output-buffer)
2279 (kill-buffer ispell-session-buffer)
2280 (setq ispell-output-buffer nil
2281 ispell-session-buffer nil))
2282 (setq ispell-process nil)
2283 (message "Ispell process killed")
2287 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2288 ;;; call ispell-init-process rather than wait for a spell checking command?
2291 (defun ispell-change-dictionary (dict &optional arg)
2292 "Change `ispell-dictionary' (q.v.) to DICT and kill old Ispell process.
2293 A new one will be started as soon as necessary.
2295 By just answering RET you can find out what the current dictionary is.
2297 With prefix argument, set the default dictionary."
2299 (list (completing-read
2300 "Use new dictionary (RET for current, SPC to complete): "
2301 (cons (cons "default" nil) ispell-dictionary-alist) nil t)
2302 current-prefix-arg))
2303 (if (equal dict "default") (setq dict nil))
2304 ;; This relies on completing-read's bug of returning "" for no match
2305 (cond ((equal dict "")
2306 (message "Using %s dictionary"
2307 (or ispell-local-dictionary ispell-dictionary "default")))
2308 ((and (equal dict ispell-dictionary)
2309 (or (null ispell-local-dictionary)
2310 (equal dict ispell-local-dictionary)))
2311 ;; Specified dictionary is the default already. No-op
2312 (and (interactive-p)
2313 (message "No change, using %s dictionary" (or dict "default"))))
2314 (t ; reset dictionary!
2315 (if (assoc dict ispell-dictionary-alist)
2317 (if (or arg (null dict)) ; set default dictionary
2318 (setq ispell-dictionary dict))
2319 (if (null arg) ; set local dictionary
2320 (setq ispell-local-dictionary dict)))
2321 (error "Undefined dictionary: %s" dict))
2322 (ispell-kill-ispell t)
2323 (message "(Next %sIspell command will use %s dictionary)"
2324 (cond ((equal ispell-local-dictionary ispell-dictionary)
2328 (or (if (or (equal ispell-local-dictionary ispell-dictionary)
2330 ispell-local-dictionary
2335 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2338 (defun ispell-region (reg-start reg-end &optional recheckp shift)
2339 "Interactively check a region for spelling errors.
2340 Return nil if spell session is quit,
2341 otherwise returns shift offset amount for last line processed."
2342 (interactive "r") ; Don't flag errors on read-only bufs.
2344 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2347 (message "Spell checking %s using %s dictionary..."
2348 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2349 (buffer-name) "region")
2350 (or ispell-dictionary "default"))
2351 ;; Returns cursor to original location.
2352 (save-window-excursion
2353 (goto-char reg-start)
2354 (let ((transient-mark-mode)
2355 (case-fold-search case-fold-search)
2356 (skip-region-start (make-marker))
2357 (skip-regexp (ispell-begin-skip-region-regexp))
2358 (skip-alist ispell-skip-region-alist)
2360 (if (eq ispell-parser 'tex)
2361 (setq case-fold-search nil
2363 (append (car ispell-tex-skip-alists)
2364 (car (cdr ispell-tex-skip-alists))
2366 (let (message-log-max)
2367 (message "searching for regions to skip"))
2368 (if (re-search-forward skip-regexp reg-end t)
2370 (setq key (buffer-substring-no-properties
2371 (match-beginning 0) (match-end 0)))
2372 (set-marker skip-region-start (- (point) (length key)))
2373 (goto-char reg-start)))
2374 (let (message-log-max)
2375 (message "Continuing spelling check using %s dictionary..."
2376 (or ispell-dictionary "default")))
2377 (set-marker ispell-region-end reg-end)
2378 (while (and (not ispell-quit)
2379 (< (point) ispell-region-end))
2380 ;; spell-check region with skipping
2381 (if (and (marker-position skip-region-start)
2382 (<= skip-region-start (point)))
2384 (ispell-skip-region key skip-alist) ; moves pt past region.
2385 (setq reg-start (point))
2386 (if (and (< reg-start ispell-region-end)
2387 (re-search-forward skip-regexp
2388 ispell-region-end t))
2390 (setq key (buffer-substring-no-properties
2392 (car (cdr (match-data)))))
2393 (set-marker skip-region-start
2394 (- (point) (length key)))
2395 (goto-char reg-start))
2396 (set-marker skip-region-start nil))))
2397 (setq reg-end (if (marker-position skip-region-start)
2398 (min skip-region-start ispell-region-end)
2399 (marker-position ispell-region-end)))
2400 (let* ((start (point))
2401 (end (save-excursion (end-of-line) (min (point) reg-end)))
2402 (string (ispell-get-line start end)))
2403 (setq end (point)) ; "end" tracks region retrieved.
2404 (if string ; there is something to spell check!
2405 ;; (special start end)
2406 (setq shift (ispell-process-line string
2407 (and recheckp shift))))
2413 (if (and (not (and recheckp ispell-keep-choices-win))
2414 (get-buffer ispell-choices-buffer))
2415 (kill-buffer ispell-choices-buffer))
2418 ;; preserve or clear the region for ispell-continue.
2419 (if (not (numberp ispell-quit))
2420 (set-marker ispell-region-end nil)
2421 ;; Ispell-continue enabled - ispell-region-end is set.
2422 (goto-char ispell-quit))
2423 ;; Check for aborting
2424 (if (and ispell-checking-message (numberp ispell-quit))
2426 (setq ispell-quit nil)
2427 (error "Message send aborted")))
2428 (if (not recheckp) (setq ispell-quit nil)))
2429 (if (not recheckp) (set-marker ispell-region-end nil))
2430 ;; Only save if successful exit.
2431 (ispell-pdict-save ispell-silently-savep)
2432 (message "Spell-checking done"))))
2435 ;;; Creates the regexp for skipping a region.
2436 ;;; Makes the skip-regexp local for tex buffers adding in the
2437 ;;; tex expressions to skip as well.
2438 ;;; Call AFTER ispell-buffer-local-parsing.
2439 (defun ispell-begin-skip-region-regexp ()
2440 (let ((skip-regexp (ispell-begin-skip-region)))
2441 (if (and (null ispell-check-comments) comment-start)
2442 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2444 (if (and (eq 'exclusive ispell-check-comments) comment-start)
2445 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2446 (regexp-quote comment-end))
2447 "\\|" skip-regexp)))
2449 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
2450 (if ispell-skip-html
2451 (setq skip-regexp (concat "<[cC][oO][dD][eE]\\>[^>]*>" "\\|"
2452 "<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "\\|"
2453 "<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "\\|"
2454 "<[vV][eE][rR][bB]\\>[^>]*>" "\\|"
2455 ;; "<[tT][tT]\\>[^>]*>" "\\|"
2460 (if (eq ispell-parser 'tex)
2461 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2466 (defun ispell-begin-tex-skip-regexp ()
2467 "Regular expression of tex commands to skip.
2468 Generated from `ispell-tex-skip-alists'."
2470 (mapconcat (function (lambda (lst) (car lst)))
2471 (car ispell-tex-skip-alists)
2474 (mapconcat (function (lambda (lst)
2475 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2478 (car (cdr ispell-tex-skip-alists))
2482 (defun ispell-begin-skip-region ()
2483 "Regular expression of regions to skip for all buffers.
2484 Each selection should be a key of `ispell-skip-region-alist';
2485 otherwise, the current line is skipped."
2486 (mapconcat (function (lambda (lst) (if (stringp (car lst)) (car lst)
2488 ispell-skip-region-alist
2492 (defun ispell-tex-arg-end (&optional arg)
2495 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2496 (forward-sexp (or arg 1)))
2498 (message "error skipping s-expressions at point %d." (point))
2503 ;;; Skips to region-end from point, or a single line.
2504 ;;; Places point at end of region skipped.
2505 (defun ispell-skip-region (key alist)
2506 ;; move over key to begin checking.
2507 (forward-char (length key))
2508 (let ((start (point))
2509 alist-key null-skip)
2511 ;; what about quoted comment, or comment inside strings?
2512 ((and (null ispell-check-comments) comment-start
2513 (string= key comment-start))
2514 (if (string= "" comment-end)
2516 (search-forward comment-end ispell-region-end t)))
2517 ((and (eq 'exclusive ispell-check-comments) comment-start
2518 (string= key comment-end))
2519 (search-forward comment-start ispell-region-end :end))
2520 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2521 (re-search-forward ispell-tib-ref-end ispell-region-end t))
2522 ((and ispell-skip-html (string-match "</" key))
2523 (search-forward ">" ispell-region-end t))
2524 ((and ispell-skip-html (string-match "<[cC][oO][dD][eE]\\>[^>]*>" key))
2525 (search-forward-regexp "</[cC][oO][dD][eE]>" ispell-region-end t))
2526 ((and ispell-skip-html
2527 (string-match "<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" key))
2528 (search-forward-regexp "</[sS][cC][rR][iI][pP][tT]>" ispell-region-end t))
2529 ((and ispell-skip-html
2530 (string-match "<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" key))
2531 (search-forward-regexp "</[aA][pP][pP][lL][eE][tT]>" ispell-region-end t))
2532 ((and ispell-skip-html (string-match "<[vV][eE][rR][bB]\\>[^>]*>" key))
2533 (search-forward-regexp "</[vV][eE][rR][bB]>" ispell-region-end t))
2534 ;;((and ispell-skip-html (string-match "<[tT][tT]\\>[^>]*>" key))
2535 ;; (search-forward-regexp "</[tT][tT]>" ispell-region-end t))
2536 ((and ispell-skip-html (string-match "<[tT][tT]/" key))
2537 (search-forward "/" ispell-region-end t))
2538 ((and ispell-skip-html (string-match "<" key))
2539 (search-forward ">" ispell-region-end t))
2540 ((and ispell-skip-html (string-match "&" key))
2541 (search-forward-regexp "[; \t\n]" ispell-region-end t))
2542 ;; markings from alist
2545 (setq alist-key (eval (car (car alist))))
2546 (if (string-match alist-key key)
2548 (setq alist (cdr (car alist)))
2550 ((null alist) (setq null-skip t)) ; done! Just skip key.
2551 ((not (consp alist))
2552 ;; Search past end of spell region to find this region end.
2553 (re-search-forward (eval alist) (point-max) t))
2556 (re-search-forward alist (point-max) t)
2557 (setq null-skip t) ; error handling in functions!
2558 (if (consp (cdr alist))
2559 (apply (car alist) (cdr alist))
2560 (funcall (car alist))))))
2562 (setq alist (cdr alist))))))
2563 (if (and (= start (point)) (null null-skip))
2565 (message "Matching region end for `%s' point %d not found"
2571 ;;; Grab the next line of data.
2572 ;;; Returns a string with the line data
2573 (defun ispell-get-line (start end)
2574 (let ((ispell-casechars (ispell-get-casechars))
2576 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2577 ((eolp) ; END OF LINE, just go to next line.
2579 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
2580 ;; (forward-char 1)) ; not needed as quoted below.
2581 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2582 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
2583 (setq string (concat "^" (buffer-substring-no-properties start end)
2586 (t (goto-char end))) ; EMPTY LINE, skip it.
2590 ;;; Avoid error messages when compiling for these dynamic variables.
2595 (defun ispell-process-line (string shift)
2596 "Sends a LINE of text to ispell and processes the result.
2597 This will modify the buffer for spelling errors.
2598 Requires variables START and END to be defined in its lexical scope.
2599 Returns the sum shift due to changes in word replacements."
2600 ;;(declare special start end)
2601 (let (poss accept-list)
2602 (if (not (numberp shift))
2604 ;; send string to spell process and get input.
2605 (ispell-send-string string)
2607 (ispell-accept-output)
2608 ;; Last item of output contains a blank line.
2609 (not (string= "" (car ispell-filter)))))
2610 ;; parse all inputs from the stream one word at a time.
2611 ;; Place in FIFO order and remove the blank item.
2612 (setq ispell-filter (nreverse (cdr ispell-filter)))
2613 (while (and (not ispell-quit) ispell-filter)
2614 ;; get next word, accounting for accepted words and start shifts
2615 (setq poss (ispell-parse-output (car ispell-filter)
2617 (if (and poss (listp poss)) ; spelling error occurred.
2618 ;; Whenever we have misspellings, we can change
2619 ;; the buffer. Keep boundaries as markers.
2620 ;; Markers can move with highlighting! This destroys
2621 ;; end of region markers line-end and ispell-region-end
2623 (copy-marker (+ start ispell-offset (car (cdr poss)))))
2624 (word-len (length (car poss)))
2625 (line-end (copy-marker end))
2626 (line-start (copy-marker start))
2627 recheck-region replace)
2628 (goto-char word-start)
2629 ;; Adjust the horizontal scroll & point
2630 (ispell-horiz-scroll)
2631 (goto-char (+ word-len word-start))
2632 (ispell-horiz-scroll)
2633 (goto-char word-start)
2634 (ispell-horiz-scroll)
2636 ;; Alignment cannot be tracked and this error will occur when
2637 ;; `query-replace' makes multiple corrections on the starting line.
2638 (if (/= (+ word-len (point))
2640 ;; NB: Search can fail with Mule character sets that don't
2641 ;; display properly. Ignore the error in this case?
2642 (search-forward (car poss) (+ word-len (point)) t)
2644 ;; This occurs due to filter pipe problems
2645 (error (concat "Ispell misalignment: word "
2646 "`%s' point %d; probably incompatible versions")
2647 (car poss) (marker-position word-start)))
2648 ;; ispell-cmd-loop can go recursive & change buffer
2649 (if ispell-keep-choices-win
2650 (setq replace (ispell-command-loop
2651 (car (cdr (cdr poss)))
2652 (car (cdr (cdr (cdr poss))))
2653 (car poss) (marker-position word-start)
2654 (+ word-len (marker-position word-start))))
2655 (save-window-excursion
2656 (setq replace (ispell-command-loop
2657 (car (cdr (cdr poss)))
2658 (car (cdr (cdr (cdr poss))))
2659 (car poss) (marker-position word-start)
2660 (+ word-len (marker-position word-start))))))
2662 (goto-char word-start)
2663 ;; Recheck when query replace edit changes misspelled word.
2664 ;; Error in tex mode when a potential math mode change exists.
2665 (if (and replace (listp replace) (= 2 (length replace)))
2666 (if (and (eq ispell-parser 'tex)
2667 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
2668 (regexp-quote string)))
2670 "Don't start query replace on a line with math characters"
2672 (set-marker line-end (point))
2673 (setq ispell-filter nil
2676 ;; insert correction if needed
2679 (equal 0 replace)) ; ACCEPT/INSERT
2680 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
2681 (ispell-add-per-file-word-list (car poss)))
2682 ;; do not recheck accepted word on this line
2683 (setq accept-list (cons (car poss) accept-list)))
2684 (t ; replacement word selected or entered
2685 (delete-region (point) (+ word-len (point)))
2686 (if (not (listp replace))
2688 (insert replace) ; insert dictionary word
2689 (setq accept-list (cons replace accept-list)))
2690 (let ((replace-word (car replace)))
2691 ;; Recheck hand entered replacement word
2692 (insert replace-word)
2693 (if (car (cdr replace))
2694 (save-window-excursion
2695 (delete-other-windows) ; to correctly show help.
2696 ;; Assume case-replace &
2697 ;; case-fold-search correct?
2698 (query-replace (car poss) (car replace) t)))
2699 (goto-char word-start)
2700 ;; do not recheck if already accepted
2701 (if (member replace-word accept-list)
2702 (setq accept-list (cons replace-word accept-list)
2703 replace replace-word)
2704 (let ((region-end (copy-marker ispell-region-end)))
2705 (setq recheck-region ispell-filter
2706 ispell-filter nil ; save filter
2707 shift 0 ; already accounted
2708 shift (ispell-region
2710 (+ word-start (length replace-word))
2712 (if (null shift) ; quitting check.
2714 (set-marker ispell-region-end region-end)
2715 (set-marker region-end nil)
2716 (setq ispell-filter recheck-region
2718 replace replace-word)))))
2720 (setq shift (+ shift (- (length replace) word-len)))
2722 ;; Move line-start across word...
2723 ;; new shift function does this now...
2724 ;;(set-marker line-start (+ line-start
2725 ;; (- (length replace)
2726 ;; (length (car poss)))))
2728 (if (not ispell-quit)
2729 (let (message-log-max)
2730 (message "Continuing spelling check using %s dictionary..."
2731 (or ispell-dictionary "default"))))
2733 (setq start (marker-position line-start)
2734 end (marker-position line-end))
2735 ;; Adjust markers when end of region lost from highlighting.
2736 (if (and (not recheck-region) (< end (+ word-start word-len)))
2737 (setq end (+ word-start word-len)))
2738 (if (= word-start ispell-region-end)
2739 (set-marker ispell-region-end (+ word-start word-len)))
2740 ;; going out of scope - unneeded
2741 (set-marker line-start nil)
2742 (set-marker word-start nil)
2743 (set-marker line-end nil)))
2744 ;; finished with misspelling!
2745 (setq ispell-filter (cdr ispell-filter)))
2750 (defun ispell-comments-and-strings ()
2751 "Check comments and strings in the current buffer for spelling errors."
2753 (goto-char (point-min))
2757 (setq state (parse-partial-sexp (point) (point-max)
2758 nil nil state 'syntax-table))
2759 (if (or (nth 3 state) (nth 4 state))
2760 (let ((start (point)))
2761 (setq state (parse-partial-sexp start (point-max)
2762 nil nil state 'syntax-table))
2763 (if (or (nth 3 state) (nth 4 state))
2764 (error "Unterminated string or comment"))
2766 (setq done (not (ispell-region start (point))))))))))
2770 (defun ispell-buffer ()
2771 "Check the current buffer for spelling errors interactively."
2773 (ispell-region (point-min) (point-max)))
2777 (defun ispell-continue ()
2778 "Continue a halted spelling session beginning with the current word."
2780 (if (not (marker-position ispell-region-end))
2781 (message "No session to continue. Use 'X' command when checking!")
2782 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
2783 (message "Must continue ispell from buffer %s"
2784 (buffer-name (marker-buffer ispell-region-end)))
2786 ;; find beginning of current word:
2787 (car (cdr (ispell-get-word t)))
2788 (marker-position ispell-region-end)))))
2791 ;;; Horizontal scrolling
2792 (defun ispell-horiz-scroll ()
2793 "Places point within the horizontal visibility of its window area."
2794 (if truncate-lines ; display truncating lines?
2795 ;; See if display needs to be scrolled.
2796 (let ((column (- (current-column) (max (window-hscroll) 1))))
2797 (if (and (< column 0) (> (window-hscroll) 0))
2798 (scroll-right (max (- column) 10))
2799 (if (>= column (- (window-width) 2))
2800 (scroll-left (max (- column (window-width) -3) 10)))))))
2803 ;;; Interactive word completion.
2804 ;;; Forces "previous-word" processing. Do we want to make this selectable?
2807 (defun ispell-complete-word (&optional interior-frag)
2808 "Try to complete the word before or under point (see `lookup-words').
2809 If optional INTERIOR-FRAG is non-nil then the word may be a character
2810 sequence inside of a word.
2812 Standard ispell choices are then available."
2814 (let ((cursor-location (point))
2815 (case-fold-search-val case-fold-search)
2816 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
2817 start end possibilities replacement)
2818 (setq start (car (cdr word))
2819 end (car (cdr (cdr word)))
2822 (or (string= word "") ; Will give you every word
2823 (lookup-words (concat (and interior-frag "*") word
2824 (if (or interior-frag (null ispell-look-p))
2826 ispell-complete-word-dict)))
2827 (cond ((eq possibilities t)
2828 (message "No word to complete"))
2829 ((null possibilities)
2830 (message "No match for \"%s\"" word))
2831 (t ; There is a modification...
2832 (setq case-fold-search nil) ; Try and respect case of word.
2834 ((string-equal (upcase word) word)
2835 (setq possibilities (mapcar 'upcase possibilities)))
2836 ((eq (upcase (aref word 0)) (aref word 0))
2837 (setq possibilities (mapcar (function
2839 (if (eq (aref word 0) (aref pos 0))
2843 (setq case-fold-search case-fold-search-val)
2844 (save-window-excursion
2846 (ispell-command-loop possibilities nil word start end)))
2848 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
2849 (ispell-add-per-file-word-list word))
2850 (replacement ; REPLACEMENT WORD
2851 (delete-region start end)
2852 (setq word (if (atom replacement) replacement (car replacement))
2853 cursor-location (+ (- (length word) (- end start))
2856 (if (not (atom replacement)) ; recheck spelling of replacement.
2858 (goto-char cursor-location)
2859 (ispell-word nil t)))))
2860 (if (get-buffer ispell-choices-buffer)
2861 (kill-buffer ispell-choices-buffer))))
2862 (ispell-pdict-save ispell-silently-savep)
2863 (goto-char cursor-location)))
2867 (defun ispell-complete-word-interior-frag ()
2868 "Completes word matching character sequence inside a word."
2870 (ispell-complete-word t))
2875 "Interactively check a region or buffer for spelling errors.
2876 If `transient-mark-mode' is on, and a region is active, spell-check
2877 that region. Otherwise spell-check the buffer.
2879 Ispell dictionaries are not distributed with Emacs. If you are
2880 looking for a dictionary, please see the distribution of the GNU ispell
2881 program, or do an Internet search; there are various dictionaries
2882 available on the net."
2884 (if (and transient-mark-mode mark-active)
2885 (ispell-region (region-beginning) (region-end))
2889 ;;; **********************************************************************
2890 ;;; Ispell Minor Mode
2891 ;;; **********************************************************************
2893 (defvar ispell-minor-mode nil
2894 "Non-nil if Ispell minor mode is enabled.")
2895 ;; Variable indicating that ispell minor mode is active.
2896 (make-variable-buffer-local 'ispell-minor-mode)
2898 (or (assq 'ispell-minor-mode minor-mode-alist)
2899 (setq minor-mode-alist
2900 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
2902 (defvar ispell-minor-keymap
2903 (let ((map (make-sparse-keymap)))
2904 (define-key map " " 'ispell-minor-check)
2905 (define-key map "\r" 'ispell-minor-check)
2907 "Keymap used for Ispell minor mode.")
2909 (or (not (boundp 'minor-mode-map-alist))
2910 (assoc 'ispell-minor-mode minor-mode-map-alist)
2911 (setq minor-mode-map-alist
2912 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
2913 minor-mode-map-alist)))
2916 (defun ispell-minor-mode (&optional arg)
2917 "Toggle Ispell minor mode.
2918 With prefix arg, turn Ispell minor mode on iff arg is positive.
2920 In Ispell minor mode, pressing SPC or RET
2921 warns you if the previous word is incorrectly spelled.
2923 All the buffer-local variables and dictionaries are ignored -- to read
2924 them into the running ispell process, type \\[ispell-word] SPC."
2926 (setq ispell-minor-mode
2927 (not (or (and (null arg) ispell-minor-mode)
2928 (<= (prefix-numeric-value arg) 0))))
2929 (force-mode-line-update))
2931 (defun ispell-minor-check ()
2932 "Check previous word then continue with the normal binding of this key.
2933 Don't check previous word when character before point is a space or newline.
2934 Don't read buffer-local settings or word lists."
2936 (let ((ispell-minor-mode nil)
2937 (ispell-check-only t)
2938 (last-char (char-after (1- (point)))))
2939 (command-execute (key-binding (this-command-keys)))
2940 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
2941 (and ispell-skip-html (eq last-char ?>))
2942 (and ispell-skip-html (eq last-char ?\;))))
2943 (ispell-word nil t))))
2946 ;;; **********************************************************************
2948 ;;; **********************************************************************
2949 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2952 (defvar ispell-message-text-end
2953 (mapconcat (function identity)
2955 ;; Don't spell check signatures
2957 ;; Matches postscript files.
2958 "^%!PS-Adobe-[123].0"
2959 ;; Matches uuencoded text
2960 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2961 ;; Matches shell files (especially auto-decoding)
2963 ;; Matches context difference listing
2964 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2965 ;; Matches unidiff difference listing
2966 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
2967 ;; Matches reporter.el bug report
2968 "^current state:\n==============\n"
2969 ;; Matches commonly used "cut" boundaries
2970 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
2972 "*End of text which will be checked in `ispell-message'.
2973 If it is a string, limit at first occurrence of that regular expression.
2974 Otherwise, it must be a function which is called to get the limit.")
2979 (defun ispell-message ()
2980 "Check the spelling of a mail message or news post.
2981 Don't check spelling of message headers except the Subject field.
2982 Don't check included messages.
2984 To abort spell checking of a message region and send the message anyway,
2985 use the `x' command. (Any subsequent regions will be checked.)
2986 The `X' command aborts the message send so that you can edit the buffer.
2988 To spell-check whenever a message is sent, include the appropriate lines
2989 in your .emacs file:
2990 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
2991 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
2992 (add-hook 'mail-send-hook 'ispell-message)
2993 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2995 You can bind this to the key C-c i in GNUS or mail by adding to
2996 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2997 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3000 (goto-char (point-min))
3002 ;; Nil when message came from outside (eg calling emacs as editor)
3003 ;; Non-nil marker of end of headers.
3006 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3007 (end-of-headers ; Start of body.
3009 (or internal-messagep
3010 (re-search-forward "^$" nil t)
3012 (limit (copy-marker ; End of region we will spell check.
3014 ((not ispell-message-text-end) (point-max))
3015 ((char-or-string-p ispell-message-text-end)
3016 (if (re-search-forward ispell-message-text-end nil t)
3019 (t (min (point-max) (funcall ispell-message-text-end))))))
3020 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3021 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3022 (ispell-non-empty-string mail-yank-prefix)
3024 (cite-regexp ;Prefix of quoted text
3026 ((functionp 'sc-cite-regexp) ; sc 3.0
3027 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3028 (ispell-non-empty-string sc-reference-tag-string)))
3029 ((boundp 'sc-cite-regexp) ; sc 2.3
3030 (concat "\\(" sc-cite-regexp "\\)" "\\|"
3031 (ispell-non-empty-string sc-reference-tag-string)))
3032 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3033 (equal major-mode 'message-mode)) ;GNUS 5
3034 (concat "In article <" "\\|"
3035 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3036 message-yank-prefix "\\|"
3038 ((equal major-mode 'mh-letter-mode) ; mh mail message
3039 (concat "[^,;&+=\n]+ writes:" "\\|"
3040 (ispell-non-empty-string mh-ins-buf-prefix)))
3041 ((not internal-messagep) ; Assume nn sent us this message.
3042 (concat "In [a-zA-Z.]+ you write:" "\\|"
3043 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3045 ((boundp 'vm-included-text-prefix) ; VM mail message
3046 (concat "[^,;&+=\n]+ writes:" "\\|"
3047 (ispell-non-empty-string vm-included-text-prefix)))
3048 (t default-prefix)))
3049 (ispell-skip-region-alist
3050 (cons (list (concat "^\\(" cite-regexp "\\)")
3051 (function forward-line))
3052 ispell-skip-region-alist))
3053 (old-case-fold-search case-fold-search)
3054 (dictionary-alist ispell-message-dictionary-alist)
3055 (ispell-checking-message t))
3057 ;; Select dictionary for message
3058 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3059 (while dictionary-alist
3060 (goto-char (point-min))
3061 (if (re-search-forward (car (car dictionary-alist))
3063 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3064 dictionary-alist nil)
3065 (setq dictionary-alist (cdr dictionary-alist)))))
3069 ;; Spell check any original Subject:
3070 (goto-char (point-min))
3071 (setq case-fold-search t)
3072 (if (re-search-forward "^Subject: *" end-of-headers t)
3074 (goto-char (match-end 0))
3075 (if (and (not (looking-at ".*Re\\>"))
3076 (not (looking-at "\\[")))
3078 (setq case-fold-search old-case-fold-search)
3079 (ispell-region (point)
3080 (progn ;Tab-initiated continuation lns.
3082 (while (looking-at "\n[ \t]")
3085 (setq case-fold-search old-case-fold-search)
3086 (goto-char end-of-headers)
3088 (ispell-region (point) limit))
3089 (set-marker end-of-headers nil)
3090 (set-marker limit nil)))))
3093 (defun ispell-non-empty-string (string)
3094 (if (or (not string) (string-equal string ""))
3095 "\\'\\`" ; An unmatchable string if string is null.
3096 (regexp-quote string)))
3099 ;;; **********************************************************************
3100 ;;; Buffer Local Functions
3101 ;;; **********************************************************************
3104 (defun ispell-accept-buffer-local-defs ()
3105 "Load all buffer-local information, restarting Ispell when necessary."
3106 (ispell-buffer-local-dict) ; May kill ispell-process.
3107 (ispell-buffer-local-words) ; Will initialize ispell-process.
3108 (ispell-buffer-local-parsing))
3111 (defun ispell-buffer-local-parsing ()
3112 "Place Ispell into parsing mode for this buffer.
3113 Overrides the default parsing mode.
3114 Includes Latex/Nroff modes and extended character mode."
3115 ;; (ispell-init-process) must already be called.
3116 (ispell-send-string "!\n") ; Put process in terse mode.
3117 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3118 ;; When exclusively checking comments, set to raw text mode (nroff).
3119 (if (and (not (eq 'exclusive ispell-check-comments))
3120 (or (and (eq ispell-parser 'use-mode-name)
3121 (string-match "[Tt][Ee][Xx]-mode"
3122 (symbol-name major-mode)))
3123 (eq ispell-parser 'tex)))
3125 (ispell-send-string "+\n") ; set ispell mode to tex
3126 (if (not (eq ispell-parser 'tex))
3127 (set (make-local-variable 'ispell-parser) 'tex)))
3128 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3129 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3130 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
3131 (set (make-local-variable 'ispell-skip-html)
3132 (not (null (string-match "sgml\\|html\\|xml"
3133 (downcase (symbol-name major-mode)))))))
3134 ;; Set default extended character mode for given buffer, if any.
3135 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3136 (if extended-char-mode
3137 (ispell-send-string (concat extended-char-mode "\n"))))
3138 ;; Set buffer-local parsing mode and extended character mode, if specified.
3140 (goto-char (point-max))
3141 ;; Uses last occurrence of ispell-parsing-keyword
3142 (if (search-backward ispell-parsing-keyword nil t)
3143 (let ((end (save-excursion (end-of-line) (point)))
3145 (search-forward ispell-parsing-keyword)
3146 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3147 ;; space separated definitions.
3148 (setq string (downcase (buffer-substring-no-properties
3149 (match-beginning 1) (match-end 1))))
3150 (cond ((and (string-match "latex-mode" string)
3151 (not (eq 'exclusive ispell-check-comments)))
3152 (ispell-send-string "+\n~tex\n"))
3153 ((string-match "nroff-mode" string)
3154 (ispell-send-string "-\n~nroff\n"))
3155 ((string-match "~" string) ; Set extended character mode.
3156 (ispell-send-string (concat string "\n")))
3157 (t (message "Invalid Ispell Parsing argument!")
3161 ;;; Can kill the current ispell process
3163 (defun ispell-buffer-local-dict ()
3164 "Initializes local dictionary and local personal dictionary.
3165 When a dictionary is defined in the buffer (see variable
3166 `ispell-dictionary-keyword'), it will override the local setting
3167 from \\[ispell-change-dictionary].
3168 Both should not be used to define a buffer-local dictionary."
3170 (goto-char (point-min))
3172 ;; Override the local variable definition.
3173 ;; Uses last occurrence of ispell-dictionary-keyword.
3174 (goto-char (point-max))
3175 (if (search-backward ispell-dictionary-keyword nil t)
3177 (search-forward ispell-dictionary-keyword)
3178 (setq end (save-excursion (end-of-line) (point)))
3179 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3180 (setq ispell-local-dictionary
3181 (buffer-substring-no-properties (match-beginning 1)
3183 (goto-char (point-max))
3184 (if (search-backward ispell-pdict-keyword nil t)
3186 (search-forward ispell-pdict-keyword)
3187 (setq end (save-excursion (end-of-line) (point)))
3188 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3189 (setq ispell-local-pdict
3190 (buffer-substring-no-properties (match-beginning 1)
3191 (match-end 1))))))))
3192 ;; Reload if new personal dictionary defined.
3193 (if (and ispell-local-pdict
3194 (not (equal ispell-local-pdict ispell-personal-dictionary)))
3196 (ispell-kill-ispell t)
3197 (setq ispell-personal-dictionary ispell-local-pdict)))
3198 ;; Reload if new dictionary defined.
3199 (if (and ispell-local-dictionary
3200 (not (equal ispell-local-dictionary ispell-dictionary)))
3201 (ispell-change-dictionary ispell-local-dictionary)))
3204 (defun ispell-buffer-local-words ()
3205 "Loads the buffer-local dictionary in the current buffer."
3206 (if (and ispell-buffer-local-name
3207 (not (equal ispell-buffer-local-name (buffer-name))))
3209 (ispell-kill-ispell t)
3210 (setq ispell-buffer-local-name nil)))
3211 (ispell-init-process)
3213 (goto-char (point-min))
3214 (while (search-forward ispell-words-keyword nil t)
3215 (or ispell-buffer-local-name
3216 (setq ispell-buffer-local-name (buffer-name)))
3217 (let ((end (save-excursion (end-of-line) (point)))
3218 (ispell-casechars (ispell-get-casechars))
3220 ;; buffer-local words separated by a space, and can contain
3221 ;; any character other than a space. Not rigorous enough.
3222 (while (re-search-forward " *\\([^ ]+\\)" end t)
3223 (setq string (buffer-substring-no-properties (match-beginning 1)
3225 ;; This can fail when string contains a word with illegal chars.
3226 ;; Error handling needs to be added between ispell and emacs.
3227 (if (and (< 1 (length string))
3228 (equal 0 (string-match ispell-casechars string)))
3229 (ispell-send-string (concat "@" string "\n"))))))))
3232 ;;; returns optionally adjusted region-end-point.
3234 (defun ispell-add-per-file-word-list (word)
3235 "Add WORD to the per-file word list."
3236 (or ispell-buffer-local-name
3237 (setq ispell-buffer-local-name (buffer-name)))
3239 (goto-char (point-min))
3240 (let ((old-case-fold-search case-fold-search)
3241 line-okay search done found)
3243 (setq case-fold-search nil
3244 search (search-forward ispell-words-keyword nil 'move)
3245 found (or found search)
3246 line-okay (< (+ (length word) 1 ; 1 for space after word..
3247 (progn (end-of-line) (current-column)))
3249 case-fold-search old-case-fold-search)
3250 (if (or (and search line-okay)
3257 (unless found (newline))
3258 (insert (concat comment-start " " ispell-words-keyword))
3259 (if (> (length comment-end) 0)
3262 (insert comment-end)))))
3263 (insert (concat " " word))))))))
3265 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3270 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3272 ;;; Local Variable options:
3273 ;;; mode: name(-mode)
3274 ;;; eval: expression
3275 ;;; local-variable: value
3277 ;;; The following sets the buffer local dictionary to `american' English
3278 ;;; and spell checks only comments.
3280 ;;; Local Variables:
3281 ;;; mode: emacs-lisp
3282 ;;; comment-column: 40
3283 ;;; ispell-check-comments: exclusive
3284 ;;; ispell-local-dictionary: "american"
3288 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3290 ;;; The following places this file in nroff parsing and extended char modes.
3291 ;;; Local IspellParsing: nroff-mode ~nroff
3292 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3293 ;;; Local IspellPersDict ~/.ispell_lisp
3294 ;;; The following were automatically generated by ispell using the 'A' command:
3295 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3296 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3297 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3298 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3299 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3300 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3301 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3302 ; LocalWords: lns XEmacs HTML casechars Multibyte
3304 ;;; ispell.el ends here