1 ;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002 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 (fboundp 'defgroup
)
196 "User variables for emacs ispell interface."
197 :group
'applications
)))
199 (if (not (fboundp 'buffer-substring-no-properties
))
200 (defun buffer-substring-no-properties (start end
)
201 (buffer-substring start end
)))
204 (defconst xemacsp
(string-match "Lucid\\|XEmacs" emacs-version
)
205 "Non nil if using XEmacs.")
207 (defconst ispell-graphic-p
208 (if (fboundp 'display-graphic-p
)
211 "True if running on a `graphics capable' display.")
213 (defalias 'ispell-check-version
'check-ispell-version
)
215 ;;; **********************************************************************
216 ;;; The following variables should be set according to personal preference
217 ;;; and location of binaries:
218 ;;; **********************************************************************
221 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
223 (defcustom ispell-highlight-p
'block
224 "*Highlight spelling errors when non-nil.
225 When set to `block', assumes a block cursor with TTY displays."
226 :type
'(choice (const block
) (const :tag
"off" nil
) (const :tag
"on" t
))
229 (defcustom ispell-highlight-face
'highlight
230 "*The face used for Ispell highlighting. For Emacses with overlays.
231 Possible values are `highlight', `modeline', `secondary-selection',
232 `region', and `underline'.
233 This variable can be set by the user to whatever face they desire.
234 It's most convenient if the cursor color and highlight color are
239 (defcustom ispell-check-comments t
240 "*Spelling of comments checked when non-nil.
241 When set to `exclusive', ONLY comments are checked. (For code comments).
242 Warning! Not checking comments, when a comment start is embedded in strings,
243 may produce undesired results."
244 :type
'(choice (const exclusive
) (const :tag
"off" nil
) (const :tag
"on" t
))
247 (defcustom ispell-query-replace-choices nil
248 "*Corrections made throughout region when non-nil.
249 Uses `query-replace' (\\[query-replace]) for corrections."
253 (defcustom ispell-skip-tib nil
254 "*Does not spell check `tib' bibliography references when non-nil.
255 Skips any text between strings matching regular expressions
256 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
258 TeX users beware: Any field starting with [. will skip until a .] -- even
259 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
260 a [.5mm] type of number...."
264 (defvar ispell-tib-ref-beginning
"[[<]\\."
265 "Regexp matching the beginning of a Tib reference.")
267 (defvar ispell-tib-ref-end
"\\.[]>]"
268 "Regexp matching the end of a Tib reference.")
270 (defcustom ispell-keep-choices-win t
271 "*When not nil, the `*Choices*' window remains for spelling session.
272 This minimizes redisplay thrashing."
276 (defcustom ispell-choices-win-default-height
2
277 "*The default size of the `*Choices*' window, including mode line.
278 Must be greater than 1."
282 (defcustom ispell-program-name
"ispell"
283 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
287 (defcustom ispell-alternate-dictionary
288 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
289 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
290 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
291 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
292 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
293 ((file-exists-p "/usr/share/lib/dict/words")
294 "/usr/share/lib/dict/words")
295 ((file-exists-p "/sys/dict") "/sys/dict")
296 (t "/usr/dict/words"))
297 "*Alternate dictionary for spelling help."
298 :type
'(choice file
(const :tag
"None" nil
))
301 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
302 "*Dictionary used for word completion."
303 :type
'(choice file
(const :tag
"None" nil
))
306 (defcustom ispell-message-dictionary-alist nil
307 "*List used by `ispell-message' to select a new dictionary.
308 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
309 in the message headers, `ispell-local-dictionary' will be set to
310 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
311 E.g. you may use the following value:
312 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
313 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
314 :type
'(repeat (cons regexp string
))
318 (defcustom ispell-grep-command
"egrep"
319 "Name of the grep command for search processes."
323 (defcustom ispell-grep-options
"-i"
324 "String of options to use when running the program in `ispell-grep-command'.
325 Should probably be \"-i\" or \"-e\".
326 Some machines (like the NeXT) don't support \"-i\""
330 (defcustom ispell-look-command
331 (cond ((file-exists-p "/bin/look") "/bin/look")
332 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
333 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
335 "Name of the look command for search processes.
336 This must be an absolute file name."
340 (defcustom ispell-look-p
(file-exists-p ispell-look-command
)
341 "*Non-nil means use `look' rather than `grep'.
342 Default is based on whether `look' seems to be available."
346 (defcustom ispell-have-new-look nil
347 "*Non-nil means use the `-r' option (regexp) when running `look'."
351 (defcustom ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
352 "String of command options for `ispell-look-command'."
356 (defcustom ispell-use-ptys-p nil
357 "When non-nil, Emacs uses ptys to communicate with Ispell.
358 When nil, Emacs uses pipes."
362 (defcustom ispell-following-word nil
363 "*Non-nil means `ispell-word' checks the word around or after point.
364 Otherwise `ispell-word' checks the preceding word."
368 (defcustom ispell-help-in-bufferp nil
369 "*Non-nil means display interactive keymap help in a buffer.
370 The following values are supported:
371 nil Expand the minibuffer and display a short help message
372 there for a couple of seconds.
373 t Pop up a new buffer and display a short help message there
374 for a couple of seconds.
375 electric Pop up a new buffer and display a long help message there.
376 User can browse and then exit the help mode."
377 :type
'(choice (const electric
) (const :tag
"off" nil
) (const :tag
"on" t
))
380 (defcustom ispell-quietly nil
381 "*Non-nil means suppress messages in `ispell-word'."
385 (defcustom ispell-format-word
(function upcase
)
386 "*Formatting function for displaying word being spell checked.
387 The function must take one string argument and return a string."
391 (defcustom ispell-use-framepop-p nil
392 "When non-nil ispell uses framepop to display choices in a dedicated frame.
393 You can set this variable to dynamically use framepop if you are in a
394 window system by evaluating the following on startup to set this variable:
395 (and window-system (condition-case () (require 'framepop) (error nil)))"
400 (defcustom ispell-personal-dictionary nil
401 "*File name of your personal spelling dictionary, or nil.
402 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
403 where DICTNAME is the name of your default dictionary."
405 (const :tag
"default" nil
))
408 (defcustom ispell-silently-savep nil
409 "*When non-nil, save the personal dictionary without confirmation."
413 ;;; This is the local dictionary to use. When nil the default dictionary will
414 ;;; be used. Change set-default call to use a new default dictionary.
415 (defcustom ispell-local-dictionary nil
416 "If non-nil, the dictionary to be used for Ispell commands.
417 The value must be a string dictionary name in `ispell-dictionary-alist'.
419 Setting `ispell-local-dictionary' to a value has the same effect as
420 calling \\[ispell-change-dictionary] with that value. This variable
421 is automatically set when defined in the file with either
422 `ispell-dictionary-keyword' or the Local Variable syntax.
424 To create a non-standard default dictionary (not from `ispell-dictionary-alist')
425 call function `set-default' with the new dictionary name."
426 :type
'(choice string
427 (const :tag
"default" nil
))
430 (make-variable-buffer-local 'ispell-local-dictionary
)
432 ;; Call this function set up the default dictionary if not English.
433 ;;(set-default 'ispell-local-dictionary nil)
436 (defcustom ispell-extra-args nil
437 "*If non-nil, a list of extra switches to pass to the Ispell program.
438 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
439 words as correct. See also `ispell-dictionary-alist', which may be used
440 for language-specific arguments."
441 :type
'(repeat string
)
446 (defcustom ispell-skip-html
'use-mode-name
447 "*Indicates whether ispell should skip spell checking of SGML markup.
448 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
449 guess whether SGML markup should be skipped according to the name of the
450 buffer's major mode."
451 :type
'(choice (const :tag
"always" t
) (const :tag
"never" nil
)
452 (const :tag
"use-mode-name" use-mode-name
))
456 ;;; Define definitions here only for personal dictionaries.
458 (defcustom ispell-local-dictionary-alist nil
459 "*Contains local or customized dictionary definitions.
460 See `ispell-dictionary-alist'."
461 :type
'(repeat (list (choice :tag
"Dictionary"
462 (string :tag
"Dictionary name")
463 (const :tag
"default" nil
))
464 (regexp :tag
"Case characters")
465 (regexp :tag
"Non case characters")
466 (regexp :tag
"Other characters")
467 (boolean :tag
"Many other characters")
468 (repeat :tag
"Ispell command line args"
470 (choice :tag
"Extended character mode"
471 (const "~tex") (const "~plaintex")
472 (const "~nroff") (const "~list")
473 (const "~latin1") (const "~latin3")
474 (const :tag
"default" nil
))
475 (choice :tag
"Character set"
482 ;;; split dictionary so line length is smaller in loaddefs.el
484 ;;; First part of dictionary, shortened for loaddefs.el
487 ispell-dictionary-alist-1
488 '((nil ; default (English.aff)
489 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
490 ("american" ; Yankee English
491 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
492 ("brasileiro" ; Brazilian mode
493 "[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]"
494 "[^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]"
495 "[']" nil
("-d" "brasileiro") nil iso-8859-1
)
496 ("british" ; British version
497 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B" "-d" "british") nil iso-8859-1
)
498 ("castellano" ; Spanish mode
499 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
500 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
501 "[-]" nil
("-B" "-d" "castellano") "~tex" iso-8859-1
)
502 ("castellano8" ; 8 bit Spanish mode
503 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
504 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
505 "[-]" nil
("-B" "-d" "castellano") "~latin1" iso-8859-1
)))
508 ;;; Second part of dictionary, shortened for loaddefs.el
511 ispell-dictionary-alist-2
513 "[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]"
514 "[^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]"
515 "" nil
("-B" "-d" "czech") nil iso-8859-2
)
517 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
518 "[']" nil
("-C") nil iso-8859-1
)
519 ("deutsch" ; Deutsch.aff
520 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
522 "[a-zA-Z\304\326\334\344\366\337\374]"
523 "[^a-zA-Z\304\326\334\344\366\337\374]"
524 "[']" t
("-C" "-d" "deutsch") "~latin1" iso-8859-1
)
525 ("english" ; make English explicitly selectable
526 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)))
529 ;;; Third part of dictionary, shortened for loaddefs.el
532 ispell-dictionary-alist-3
534 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
535 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
536 "[-']" t
("-C") "~latin3" iso-8859-1
)
538 "[A-Za-z^\\]" "[^A-Za-z^\\]"
539 "[-'`\"]" t
("-C" "-d" "esperanto") "~tex" iso-8859-1
)
541 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil iso-8859-1
)
542 ("francais" ; Francais.aff
543 "[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]"
544 "[^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]"
545 "[-']" t nil
"~list" iso-8859-1
)))
548 ;;; Fourth part of dictionary, shortened for loaddefs.el
551 ispell-dictionary-alist-4
552 '(("francais-tex" ; Francais.aff
553 "[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\\]"
554 "[^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\\]"
555 "[-'^`\"]" t nil
"~tex" iso-8859-1
)
556 ("german" ; german.aff
557 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
559 "[a-zA-Z\304\326\334\344\366\337\374]"
560 "[^a-zA-Z\304\326\334\344\366\337\374]"
561 "[']" t
("-C" "-d" "german") "~latin1" iso-8859-1
)
562 ("italiano" ; Italian.aff
563 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
564 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
565 "[-]" nil
("-B" "-d" "italian") "~tex" iso-8859-1
)))
568 ;;; Fifth part of dictionary, shortened for loaddefs.el
571 ispell-dictionary-alist-5
572 '(("nederlands" ; Nederlands.aff
573 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
574 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
575 "[']" t
("-C") nil iso-8859-1
)
576 ("nederlands8" ; Dutch8.aff
577 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
578 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
579 "[']" t
("-C") nil iso-8859-1
)
580 ("norsk" ; 8 bit Norwegian mode
581 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
582 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
583 "[\"]" nil
("-d" "norsk") "~list" iso-8859-1
)
584 ("norsk7-tex" ; 7 bit Norwegian TeX mode
585 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
586 "[\"]" nil
("-d" "norsk") "~plaintex" iso-8859-1
)))
589 ;;; Sixth part of dictionary, shortened for loaddefs.el
592 ispell-dictionary-alist-6
593 ;; include Russian iso character set too?
594 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
595 '(("polish" ; polish mode
596 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
597 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
598 "" nil
( "-d" "polish") nil iso-8859-2
)
599 ("russian" ; Russian.aff (KOI8-R charset)
600 "[\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]"
601 "[^\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]"
602 "" nil
("-d" "russian") nil koi8-r
)
603 ("svenska" ; Swedish mode
604 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
605 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
606 "[']" nil
("-C") "~list" iso-8859-1
)
608 "[a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
609 "[^a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
610 "[']" t
("-C" "-d" "portugues") "~latin1" iso-8859-1
)
612 "[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]"
613 "[^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]"
614 "" nil
("-B" "-d" "slovak") nil iso-8859-2
)))
617 (defcustom ispell-dictionary-alist
618 (append ispell-local-dictionary-alist
; dictionary customizations
619 ispell-dictionary-alist-1 ispell-dictionary-alist-2
620 ispell-dictionary-alist-3 ispell-dictionary-alist-4
621 ispell-dictionary-alist-5 ispell-dictionary-alist-6
)
622 "An alist of dictionaries and their associated parameters.
624 Each element of this list is also a list:
626 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
627 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
629 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
630 nil means the default dictionary.
632 CASECHARS is a regular expression of valid characters that comprise a
635 NOT-CASECHARS is the opposite regexp of CASECHARS.
637 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
638 used to construct words in some special way. If OTHERCHARS characters follow
639 and precede characters from CASECHARS, they are parsed as part of a word,
640 otherwise they become word-breaks. As an example in English, assume the
641 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
642 \"Steven's\" are parsed as single words including the \"'\" character, but
643 \"Stevens'\" does not include the quote character as part of the word.
644 If you want OTHERCHARS to be empty, use the empty string.
645 Hint: regexp syntax requires the hyphen to be declared first here.
647 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
648 Otherwise only a single OTHERCHARS character is allowed to be part of any
651 ISPELL-ARGS is a list of additional arguments passed to the ispell
654 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
655 have been configured in an Ispell affix file. (For example, umlauts
656 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
657 in English. This has the same effect as the command-line `-T' option.
658 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
659 but the dictionary can control the extended character mode.
660 Both defaults can be overruled in a buffer-local fashion. See
661 `ispell-parsing-keyword' for details on this.
663 CHARACTER-SET used for languages with multibyte characters.
665 Note that the CASECHARS and OTHERCHARS slots of the alist should
666 contain the same character set as casechars and otherchars in the
667 LANGUAGE.aff file \(e.g., english.aff\)."
668 :type
'(repeat (list (choice :tag
"Dictionary"
669 (string :tag
"Dictionary name")
670 (const :tag
"default" nil
))
671 (regexp :tag
"Case characters")
672 (regexp :tag
"Non case characters")
673 (regexp :tag
"Other characters")
674 (boolean :tag
"Many other characters")
675 (repeat :tag
"Ispell command line args"
677 (choice :tag
"Extended character mode"
678 (const "~tex") (const "~plaintex")
679 (const "~nroff") (const "~list")
680 (const "~latin1") (const "~latin3")
681 (const :tag
"default" nil
))
682 (choice :tag
"Character set"
688 ;;; update the dictionaries at load time
689 (setq ispell-dictionary-alist
690 (append ispell-local-dictionary-alist
; dictionary customizations
691 ispell-dictionary-alist-1 ispell-dictionary-alist-2
692 ispell-dictionary-alist-3 ispell-dictionary-alist-4
693 ispell-dictionary-alist-5 ispell-dictionary-alist-6
))
698 ;;; **********************************************************************
699 ;;; The following are used by ispell, and should not be changed.
700 ;;; **********************************************************************
704 ;;; The version must be 3.1 or greater for this version of ispell.el
705 ;;; There is an incompatibility between version 3.1.12 and lower versions.
706 (defconst ispell-required-version
'(3 1 12)
707 "Ispell versions with which this version of ispell.el is known to work.")
708 (defvar ispell-offset -
1
709 "Offset that maps protocol differences between ispell 3.1 versions.")
711 (defconst ispell-version
"ispell.el 3.4 -- Fri Aug 4 09:41:50 PDT 2000")
714 (defun check-ispell-version (&optional interactivep
)
715 "Ensure that `ispell-program-name' is valid and the correct version.
716 Returns version number if called interactively.
717 Otherwise returns the library directory name, if that is defined."
718 ;; This is a little wasteful as we actually launch ispell twice: once
719 ;; to make sure it's the right version, and once for real. But people
720 ;; get confused by version mismatches *all* the time (and I've got the
721 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
722 ;; option is the only way I can think of to do this that works with
723 ;; all versions, since versions earlier than 3.0.09 didn't identify
724 ;; themselves on startup.
726 (let ((case-fold-search-val case-fold-search
)
727 ;; avoid bugs when syntax of `.' changes in various default modes
728 (default-major-mode 'fundamental-mode
)
729 (default-directory temporary-file-directory
)
732 (let ((buf (get-buffer " *ispell-tmp*")))
733 (if buf
(kill-buffer buf
)))
734 (set-buffer (get-buffer-create " *ispell-tmp*"))
736 (setq status
(call-process
737 ispell-program-name nil t nil
738 ;; aspell doesn't accept the -vv switch.
739 (let ((case-fold-search
740 (memq system-type
'(ms-dos windows-nt
)))
742 (file-name-nondirectory ispell-program-name
)))
743 ;; Assume anything that isn't `aspell' is Ispell.
744 (if (string-match "\\`aspell" speller
) "-v" "-vv"))))
745 (goto-char (point-min))
749 (setq result
(concat (buffer-substring-no-properties (point-min)
754 ;; return library directory.
755 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t
)
756 (setq result
(buffer-substring (match-beginning 1) (match-end 1)))))
757 (goto-char (point-min))
758 (if (not (memq status
'(0 nil
)))
759 (error "%s exited with %s %s" ispell-program-name
760 (if (stringp status
) "signal" "code") status
))
761 (setq case-fold-search t
762 status
(re-search-forward
764 (format "%d" (car ispell-required-version
))
765 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
767 case-fold-search case-fold-search-val
)
768 (if (or (not status
) ; major version mismatch
769 (< (car (read-from-string (buffer-substring-no-properties
770 (match-beginning 2) (match-end 2))))
771 (car (cdr ispell-required-version
)))) ; minor version mismatch
772 (error "%s version 3 release %d.%d.%d or greater is required"
773 ispell-program-name
(car ispell-required-version
)
774 (car (cdr ispell-required-version
))
775 (car (cdr (cdr ispell-required-version
))))
776 ;; check that it is the correct version.
777 (if (and (= (car (read-from-string (buffer-substring-no-properties
778 (match-beginning 2)(match-end 2))))
779 (car (cdr ispell-required-version
)))
780 (< (car (read-from-string (buffer-substring-no-properties
781 (match-beginning 3)(match-end 3))))
782 (car (cdr (cdr ispell-required-version
)))))
783 (setq ispell-offset
0)))
784 (kill-buffer (current-buffer)))
789 ;;; The preparation of the menu bar menu must be autoloaded
790 ;;; because otherwise this file gets autoloaded every time Emacs starts
791 ;;; so that it can set up the menus and determine keyboard equivalents.
795 (defvar ispell-menu-map nil
"Key map for ispell menu.")
796 ;;; redo menu when loading ispell to get dictionary modifications
797 (setq ispell-menu-map nil
)
800 (defvar ispell-menu-xemacs nil
801 "Spelling menu for XEmacs.
802 If nil when package is loaded, a standard menu will be set,
803 and added as a submenu of the \"Edit\" menu.")
805 ;;; Break out XEmacs menu and split into several calls to avoid having
806 ;;; long lines in loaddefs.el. Detect need off following constant.
808 ;;; Set up dictionary
810 (defvar ispell-menu-map-needed
811 ;; only needed when not version 18 and not XEmacs.
812 (and (not ispell-menu-map
)
816 (defvar ispell-library-directory
(condition-case ()
817 (check-ispell-version)
819 "Directory where ispell dictionaries reside.")
821 (defvar ispell-process nil
822 "The process object for Ispell.")
824 (defvar ispell-async-processp
(and (fboundp 'kill-process
)
825 (fboundp 'process-send-string
)
826 (fboundp 'accept-process-output
)
827 ;;(fboundp 'start-process)
828 ;;(fboundp 'set-process-filter)
829 ;;(fboundp 'process-kill-without-query)
831 "Non-nil means that the OS supports asynchronous processes.")
834 (if ispell-menu-map-needed
835 (let ((dicts (reverse (cons (cons "default" nil
) ispell-dictionary-alist
)))
836 (dir (if (boundp 'ispell-library-directory
) ispell-library-directory
))
838 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
839 ;; add the dictionaries to the bottom of the list.
841 (setq name
(car (car dicts
))
842 load-dict
(car (cdr (member "-d" (nth 5 (car dicts
)))))
844 (cond ((not (stringp name
))
845 (define-key ispell-menu-map
[default]
846 '("Select Default Dict"
847 "Dictionary for which Ispell was configured"
848 . (lambda () (interactive)
849 (ispell-change-dictionary "default")))))
850 ((or (not dir) ; load all if library dir not defined
851 (file-exists-p (concat dir "/" name ".hash"))
852 (file-exists-p (concat dir "/" name ".has"))
854 (or (file-exists-p (concat dir "/" load-dict ".hash"))
855 (file-exists-p (concat dir "/" load-dict ".has")))))
856 (define-key ispell-menu-map (vector (intern name))
857 (cons (concat "Select " (capitalize name) " Dict")
858 `(lambda () (interactive)
859 (ispell-change-dictionary ,name)))))))))
862 ;;; define commands in menu in opposite order you want them to appear.
864 (if ispell-menu-map-needed
866 (define-key ispell-menu-map [ispell-change-dictionary]
867 '(menu-item "Change Dictionary..." ispell-change-dictionary
868 :help "Supply explicit dictionary file name"))
869 (define-key ispell-menu-map [ispell-kill-ispell]
870 '(menu-item "Kill Process" ispell-kill-ispell
871 :enable (and (boundp 'ispell-process) ispell-process
872 (eq (ispell-process-status) 'run))
873 :help "Terminate Ispell subprocess"))
874 (define-key ispell-menu-map [ispell-pdict-save]
875 '(menu-item "Save Dictionary"
876 (lambda () (interactive) (ispell-pdict-save t t))
877 :help "Save personal dictionary"))
878 (define-key ispell-menu-map [ispell-customize]
879 '(menu-item "Customize..."
880 (lambda () (interactive) (customize-group 'ispell))
881 :help "Customize spell checking options"))
882 (define-key ispell-menu-map [ispell-help]
883 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
885 (lambda () (interactive) (describe-function 'ispell-help))
886 :help "Show standard Ispell keybindings and commands"))
887 (define-key ispell-menu-map [flyspell-mode]
888 '(menu-item "Automatic spell checking (Flyspell)"
890 :help "Check spelling while you edit the text"
891 :button (:toggle . flyspell-mode)))
892 (define-key ispell-menu-map [ispell-complete-word]
893 '(menu-item "Complete Word" ispell-complete-word
894 :help "Complete word at cursor using dictionary"))
895 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
896 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
897 :help "Complete word fragment at cursor"))))
900 (if ispell-menu-map-needed
902 (define-key ispell-menu-map [ispell-continue]
903 '(menu-item "Continue Spell-Checking" ispell-continue
904 :enable (and (boundp 'ispell-region-end)
905 (marker-position ispell-region-end)
906 (equal (marker-buffer ispell-region-end)
908 :help "Continue spell checking last region"))
909 (define-key ispell-menu-map [ispell-word]
910 '(menu-item "Spell-Check Word" ispell-word
911 :help "Spell-check word at cursor"))
912 (define-key ispell-menu-map [ispell-comments-and-strings]
913 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
914 :help "Spell-check only comments and strings"))))
917 (if ispell-menu-map-needed
919 (define-key ispell-menu-map [ispell-region]
920 '(menu-item "Spell-Check Region" ispell-region
922 :help "Spell-check text in marked region"))
923 (define-key ispell-menu-map [ispell-message]
924 '(menu-item "Spell-Check Message" ispell-message
925 :help "Skip headers and included message text"))
926 (define-key ispell-menu-map [ispell-buffer]
927 '(menu-item "Spell-Check Buffer" ispell-buffer
928 :help "Check spelling of selected buffer"))
929 ;;(put 'ispell-region 'menu-enable 'mark-active)
930 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
932 ;;; XEmacs versions 19 & 20
935 (null ispell-menu-xemacs)
936 (not (and (boundp 'infodock-version) infodock-version)))
937 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
938 (current-menubar (or current-menubar default-menubar))
940 '(["Help" (describe-function 'ispell-help) t]
941 ;;["Help" (popup-menu ispell-help-list) t]
942 ["Check Message" ispell-message t]
943 ["Check Buffer" ispell-buffer t]
944 ["Check Comments" ispell-comments-and-strings t]
945 ["Check Word" ispell-word t]
946 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
947 ["Continue Check" ispell-continue t]
948 ["Complete Word Frag"ispell-complete-word-interior-frag t]
949 ["Complete Word" ispell-complete-word t]
950 ["Kill Process" ispell-kill-ispell t]
952 ["Save Personal Dict"(ispell-pdict-save t t) t]
953 ["Change Dictionary" ispell-change-dictionary t]
954 ["Select Default" (ispell-change-dictionary "default") t]))
957 (setq name (car (car dicts))
958 load-dict (car (cdr (member "-d" (nth 5 (car dicts)))))
960 ;; Include if the dictionary is in the library, or dir not defined.
961 (if (and (stringp name)
962 (or (not ispell-library-directory)
963 (file-exists-p (concat ispell-library-directory "/"
965 (file-exists-p (concat ispell-library-directory "/"
968 (or (file-exists-p (concat ispell-library-directory "/"
970 (file-exists-p (concat ispell-library-directory "/"
971 load-dict ".has"))))))
972 (setq menu (append menu
974 (vector (concat "Select " (capitalize name))
975 (list 'ispell-change-dictionary name)
977 (setq ispell-menu-xemacs menu)
980 (delete-menu-item '("Edit" "Spell")) ; in case already defined
981 (add-menu '("Edit") "Spell" ispell-menu-xemacs)))))
983 ;;; Allow incrementing characters as integers in XEmacs 20
986 (fset 'ispell-int-char 'int-char)
987 ;; Emacs and XEmacs 19 or earlier
988 (fset 'ispell-int-char 'identity))
991 ;;; **********************************************************************
994 ;;; This variable contains the current dictionary being used if the ispell
995 ;;; process is running. Otherwise it contains the global default.
996 (defvar ispell-dictionary nil
997 "The name of the current dictionary, or nil for the default.
998 When `ispell-local-dictionary' is nil, `ispell-dictionary' is used to select
999 the dictionary for new buffers.
1001 This is passed to the ispell process using the `-d' switch and is
1002 used as key in `ispell-dictionary-alist' (which see).")
1004 (defun ispell-decode-string (str)
1005 "Decodes multibyte character strings.
1006 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1007 (if (and (or xemacsp
1008 (and (boundp 'enable-multibyte-characters)
1009 enable-multibyte-characters))
1010 (fboundp 'decode-coding-string)
1011 (ispell-get-coding-system))
1012 (decode-coding-string str (ispell-get-coding-system))
1015 (defun ispell-get-casechars ()
1016 (ispell-decode-string
1017 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist))))
1018 (defun ispell-get-not-casechars ()
1019 (ispell-decode-string
1020 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist))))
1021 (defun ispell-get-otherchars ()
1022 (ispell-decode-string
1023 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist))))
1024 (defun ispell-get-many-otherchars-p ()
1025 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
1026 (defun ispell-get-ispell-args ()
1027 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
1028 (defun ispell-get-extended-character-mode ()
1029 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
1030 (defun ispell-get-coding-system ()
1031 (nth 7 (assoc ispell-dictionary ispell-dictionary-alist)))
1034 (defvar ispell-pdict-modified-p nil
1035 "Non-nil means personal dictionary has modifications to be saved.")
1037 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1038 ;;; When non-nil, the spell session is terminated.
1039 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1040 (defvar ispell-quit nil)
1042 (defvar ispell-process-directory nil
1043 "The directory where `ispell-process' was started.")
1045 (defvar ispell-filter nil
1046 "Output filter from piped calls to Ispell.")
1048 (defvar ispell-filter-continue nil
1049 "Control variable for Ispell filter function.")
1051 (defvar ispell-output-buffer nil
1052 "Buffer used for reading output of a synchronous Ispell subprocess.")
1054 (defvar ispell-session-buffer nil
1055 "Buffer used for passing input to a synchronous Ispell subprocess.")
1057 (defvar ispell-cmd-args nil
1058 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1060 (defvar ispell-query-replace-marker (make-marker)
1061 "Marker for `query-replace' processing.")
1063 (defvar ispell-recursive-edit-marker (make-marker)
1064 "Marker for return point from recursive edit.")
1066 (defvar ispell-checking-message nil
1067 "Non-nil when we're checking a mail message.")
1069 (defconst ispell-choices-buffer "*Choices*")
1071 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1073 ;;; *** Buffer Local Definitions ***
1075 (defconst ispell-words-keyword "LocalWords: "
1076 "The keyword for local oddly-spelled words to accept.
1077 The keyword will be followed by any number of local word spellings.
1078 There can be multiple of these keywords in the file.")
1080 (defconst ispell-dictionary-keyword "Local IspellDict: "
1081 "The keyword for a local dictionary to use.
1082 The keyword must be followed by a correct dictionary name in
1083 `ispell-dictionary-alist'. When multiple occurrences exist, the last keyword
1084 definition is used.")
1086 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1087 "The keyword for defining buffer local dictionaries.
1088 Keyword must be followed by the filename of a personal dictionary.
1089 The last occurring definition in the buffer will be used.")
1091 (defconst ispell-parsing-keyword "Local IspellParsing: "
1092 "The keyword for overriding default Ispell parsing.
1093 The above keyword string should be followed by `latex-mode' or
1094 `nroff-mode' to put the current buffer into the desired parsing mode.
1096 Extended character mode can be changed for this buffer by placing
1097 a `~' followed by an extended-character mode -- such as `~.tex'.
1098 The last occurring definition in the buffer will be used.")
1101 (defvar ispell-skip-region-alist
1102 '((ispell-words-keyword forward-line)
1103 (ispell-dictionary-keyword forward-line)
1104 (ispell-pdict-keyword forward-line)
1105 (ispell-parsing-keyword forward-line)
1106 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1107 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage" . "^---* End of [Ff]orwarded [Mm]essage")
1108 ;; Matches e-mail addresses, file names, http addresses, etc. The `-+'
1109 ;; pattern necessary for performance reasons when `-' part of word syntax.
1110 ("\\(-+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+\\)")
1111 ;; This is a pretty complex regexp. It can be simplified to the following:
1112 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1113 ;; but some valid text will be skipped, e.g. "his/her". This could be
1114 ;; fixed up (at the expense of a moderately more complex regexp)
1115 ;; by not allowing "/" to be the character which triggers the
1116 ;; identification of the computer name, e.g.:
1117 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1119 "Alist expressing beginning and end of regions not to spell check.
1120 The alist key must be a regular expression.
1121 Valid forms include:
1122 (KEY) - just skip the key.
1123 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1124 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1125 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1130 (defvar ispell-tex-skip-alists
1131 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1132 ;; All the standard LaTeX keywords from L. Lamport's guide:
1133 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1134 ;; \label, \nocite, \rule (in ispell - rest included here)
1135 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1136 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1137 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1138 ;;("\\\\author" ispell-tex-arg-end)
1139 ("\\\\bibliographystyle" ispell-tex-arg-end)
1140 ("\\\\makebox" ispell-tex-arg-end 0)
1141 ("\\\\e?psfig" ispell-tex-arg-end)
1142 ("\\\\document\\(class\\|style\\)" .
1143 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1144 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1145 ;; equation, minipage, picture, tabular, tabular* (ispell)
1146 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1147 ("list" ispell-tex-arg-end 2)
1148 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1149 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1150 "*Lists of regions to be skipped in TeX mode.
1151 First list is used raw.
1152 Second list has key placed inside \\begin{}.
1154 Delete or add any regions you want to be automatically selected
1155 for skipping in latex mode.")
1158 (defvar ispell-local-pdict ispell-personal-dictionary
1159 "A buffer local variable containing the current personal dictionary.
1160 If non-nil, the value must be a string, which is a file name.
1162 If you specify a personal dictionary for the current buffer which is
1163 different from the current personal dictionary, the effect is similar
1164 to calling \\[ispell-change-dictionary]. This variable is automatically
1165 set when defined in the file with either `ispell-pdict-keyword' or the
1166 local variable syntax.")
1168 (make-variable-buffer-local 'ispell-local-pdict)
1170 (defvar ispell-buffer-local-name nil
1171 "Contains the buffer name if local word definitions were used.
1172 Ispell is then restarted because the local words could conflict.")
1174 (defvar ispell-parser 'use-mode-name
1175 "*Indicates whether ispell should parse the current buffer as TeX Code.
1176 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1177 Default parser is `nroff'.
1178 Currently the only other valid parser is `tex'.
1180 You can set this variable in hooks in your init file -- eg:
1182 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
1184 (defvar ispell-region-end (make-marker)
1185 "Marker that allows spelling continuations.")
1187 (defvar ispell-check-only nil
1188 "If non-nil, `ispell-word' does not try to correct the word.")
1191 ;;; **********************************************************************
1192 ;;; **********************************************************************
1197 (define-key esc-map "$" 'ispell-word)
1200 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1201 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1202 If asynchronous subprocesses are not supported, call `ispell-filter' and
1203 pass it the output of the last ispell invocation."
1204 (if ispell-async-processp
1205 (accept-process-output ispell-process timeout-secs timeout-msecs)
1206 (if (null ispell-process)
1207 (error "No Ispell process to read output from!")
1208 (let ((buf ispell-output-buffer)
1210 (if (not (bufferp buf))
1211 (setq ispell-filter nil)
1214 (setq ispell-output (buffer-substring-no-properties
1215 (point-min) (point-max))))
1216 (ispell-filter t ispell-output)
1219 (erase-buffer)))))))
1222 (defun ispell-send-string (string)
1223 "Send the string STRING to the Ispell process."
1224 (if ispell-async-processp
1225 (process-send-string ispell-process string)
1226 ;; Asynchronous subprocesses aren't supported on this losing system.
1227 ;; We keep all the directives passed to Ispell during the entire
1228 ;; session in a buffer, and pass them anew each time we invoke
1229 ;; Ispell to process another chunk of text. (Yes, I know this is a
1230 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1231 (let ((cmd (aref string 0))
1232 ;; The following commands are not passed to Ispell until
1233 ;; we have a *reall* reason to invoke it.
1234 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1235 (default-major-mode 'fundamental-mode)
1236 (session-buf ispell-session-buffer)
1237 (output-buf ispell-output-buffer)
1238 (ispell-args ispell-cmd-args)
1239 (defdir ispell-process-directory)
1242 (set-buffer session-buf)
1243 (setq prev-pos (point))
1244 (setq default-directory defdir)
1246 (if (not (memq cmd cmds-to-defer))
1247 (let (coding-system-for-read coding-system-for-write status)
1249 (and (boundp 'enable-multibyte-characters)
1250 enable-multibyte-characters))
1251 (setq coding-system-for-read (ispell-get-coding-system)
1252 coding-system-for-write (ispell-get-coding-system)))
1253 (set-buffer output-buf)
1255 (set-buffer session-buf)
1257 (apply 'call-process-region (point-min) (point-max)
1258 ispell-program-name nil
1260 "-a" "-m" ispell-args))
1261 (set-buffer output-buf)
1262 (goto-char (point-min))
1264 (if (not (looking-at "@(#) "))
1265 (error "Ispell error: %s"
1266 (buffer-substring-no-properties
1267 (point) (progn (end-of-line) (point)))))
1268 ;; If STRING is "^Z\n", we just started Ispell and need
1269 ;; to retain its version ID line in the output buffer.
1270 ;; Otherwise, remove the ID line, as it will confuse
1272 (or (string= string "\032\n")
1275 (delete-region (point-min) (point))))
1276 ;; If STRING begins with ^ or any normal character, we need
1277 ;; to remove the last line from the session buffer, since it
1278 ;; was just spell-checked, and we don't want to check it again.
1279 ;; The same goes for the # command, since Ispell already saved
1280 ;; the personal dictionary.
1281 (set-buffer session-buf)
1282 (delete-region prev-pos (point))
1283 ;; Ispell run synchronously saves the personal dictionary
1284 ;; after each successful command. So we can remove any
1285 ;; lines in the session buffer that insert words into the
1287 (if (memq status '(0 nil))
1288 (let ((more-lines t))
1289 (goto-char (point-min))
1291 (if (looking-at "^\\*")
1292 (let ((start (point)))
1294 (delete-region start (point)))
1295 (setq more-lines (= 0 (forward-line))))))))))))))
1300 (defun ispell-word (&optional following quietly continue)
1301 "Check spelling of word under or before the cursor.
1302 If the word is not found in dictionary, display possible corrections
1303 in a window allowing you to choose one.
1305 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1306 is non-nil when called interactively, then the following word
1307 \(rather than preceding\) is checked when the cursor is not over a word.
1308 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1309 when called interactively, non-corrective messages are suppressed.
1311 With a prefix argument (or if CONTINUE is non-nil),
1312 resume interrupted spell-checking of a buffer or region.
1314 Word syntax described by `ispell-dictionary-alist' (which see).
1316 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1317 or \\[ispell-region] to update the Ispell process.
1320 nil word is correct or spelling is accpeted.
1321 0 word is inserted into buffer-local definitions.
1322 \"word\" word corrected from word list.
1323 \(\"word\" arg\) word is hand entered.
1324 quit spell session exited."
1326 (interactive (list nil nil current-prefix-arg))
1330 (setq following ispell-following-word
1331 quietly ispell-quietly))
1332 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1333 (let ((cursor-location (point)) ; retain cursor location
1334 (word (ispell-get-word following))
1335 start end poss new-word replace)
1336 ;; De-structure return word info list.
1337 (setq start (car (cdr word))
1338 end (car (cdr (cdr word)))
1341 ;; now check spelling of word if it has 3 or more characters.
1343 ((> (length word) 2)
1345 (message "Checking spelling of %s..."
1346 (funcall ispell-format-word word)))
1347 (ispell-send-string "%\n") ; put in verbose mode
1348 (ispell-send-string (concat "^" word "\n"))
1349 ;; wait until ispell has processed word
1351 (ispell-accept-output)
1352 (not (string= "" (car ispell-filter)))))
1353 ;;(ispell-send-string "!\n") ;back to terse mode.
1354 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1355 (if (and ispell-filter (listp ispell-filter))
1356 (if (> (length ispell-filter) 1)
1357 (error "Ispell and its process have different character maps")
1358 (setq poss (ispell-parse-output (car ispell-filter)))))
1361 (message "%s is correct"
1362 (funcall ispell-format-word word))))
1365 (message "%s is correct because of root %s"
1366 (funcall ispell-format-word word)
1367 (funcall ispell-format-word poss))))
1368 ((null poss) (message "Error in ispell process"))
1369 (ispell-check-only ; called from ispell minor mode.
1371 (message "%s is incorrect" (funcall ispell-format-word word)))
1372 (t ; prompt for correct word.
1373 (save-window-excursion
1374 (setq replace (ispell-command-loop
1375 (car (cdr (cdr poss)))
1376 (car (cdr (cdr (cdr poss))))
1377 (car poss) start end)))
1378 (cond ((equal 0 replace)
1379 (ispell-add-per-file-word-list (car poss)))
1381 (setq new-word (if (atom replace) replace (car replace))
1382 cursor-location (+ (- (length word) (- end start))
1384 (if (not (equal new-word (car poss)))
1386 (delete-region start end)
1387 (setq start (point))
1389 (setq end (point))))
1390 (if (not (atom replace)) ;recheck spelling of replacement
1392 (if (car (cdr replace)) ; query replace requested
1393 (save-window-excursion
1394 (query-replace word new-word t)))
1396 ;; single word could be split into multiple words
1397 (setq ispell-quit (not (ispell-region start end)))
1399 ;; keep if rechecking word and we keep choices win.
1400 (if (get-buffer ispell-choices-buffer)
1401 (kill-buffer ispell-choices-buffer))))
1402 (ispell-pdict-save ispell-silently-savep)
1403 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1404 (if ispell-quit (setq ispell-quit nil replace 'quit))))
1405 (goto-char cursor-location) ; return to original location
1409 (defun ispell-get-word (following &optional extra-otherchars)
1410 "Return the word for spell-checking according to ispell syntax.
1411 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1412 is non-nil when called interactively, then the following word
1413 \(rather than preceding\) is checked when the cursor is not over a word.
1414 Optional second argument contains otherchars that can be included in word
1417 Word syntax described by `ispell-dictionary-alist' (which see)."
1418 (let* ((ispell-casechars (ispell-get-casechars))
1419 (ispell-not-casechars (ispell-get-not-casechars))
1420 (ispell-otherchars (ispell-get-otherchars))
1421 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1422 (word-regexp (concat ispell-casechars
1424 (if (not (string= "" ispell-otherchars))
1425 (concat ispell-otherchars "?"))
1426 (if extra-otherchars
1427 (concat extra-otherchars "?"))
1430 (if (or ispell-many-otherchars-p
1436 (if (not (looking-at ispell-casechars))
1438 (re-search-forward ispell-casechars (point-max) t)
1439 (re-search-backward ispell-casechars (point-min) t)))
1440 ;; move to front of word
1441 (re-search-backward ispell-not-casechars (point-min) 'start)
1442 (while (and (or (and (not (string= "" ispell-otherchars))
1443 (looking-at ispell-otherchars))
1444 (and extra-otherchars (looking-at extra-otherchars)))
1446 (or (not did-it-once)
1447 ispell-many-otherchars-p)
1448 (not (eq prevpt (point))))
1449 (if (and extra-otherchars (looking-at extra-otherchars))
1452 (if (looking-at ispell-casechars)
1453 (re-search-backward ispell-not-casechars (point-min) 'move)))
1457 (if (looking-at ispell-casechars)
1458 (re-search-backward ispell-not-casechars (point-min) 'move)
1459 (backward-char -1))))
1460 ;; Now mark the word and save to string.
1461 (if (not (re-search-forward word-regexp (point-max) t))
1462 (if ispell-check-only
1463 ;; return dummy word when just flagging misspellings
1464 (list "" (point) (point))
1465 (error "No word found to check!"))
1466 (setq start (match-beginning 0)
1468 word (buffer-substring-no-properties start end))
1469 (list word start end))))
1472 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1473 ;;; tracks changes in the dictionary. The global may either be
1474 ;;; a value or a list, whose value is the state of whether the
1475 ;;; dictionary needs to be saved.
1478 (defun ispell-pdict-save (&optional no-query force-save)
1479 "Check to see if the personal dictionary has been modified.
1480 If so, ask if it needs to be saved."
1481 (interactive (list ispell-silently-savep t))
1482 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1483 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1484 (if (or ispell-pdict-modified-p force-save)
1485 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1487 (ispell-send-string "#\n") ; save dictionary
1488 (message "Personal dictionary saved."))))
1489 ;; unassert variable, even if not saved to avoid questioning.
1490 (setq ispell-pdict-modified-p nil))
1493 (defun ispell-command-loop (miss guess word start end)
1494 "Display possible corrections from list MISS.
1495 GUESS lists possibly valid affix construction of WORD.
1496 Returns nil to keep word.
1497 Returns 0 to insert locally into buffer-local dictionary.
1498 Returns string for new chosen word.
1499 Returns list for new replacement word (will be rechecked).
1500 Query-replace when list length is 2.
1501 Automatic query-replace when second element is `query-replace'.
1502 Highlights the word, which is assumed to run from START to END.
1503 Global `ispell-pdict-modified-p' becomes a list where the only value
1504 indicates whether the dictionary has been modified when option `a' or `i' is
1506 Global `ispell-quit' set to start location to continue spell session."
1508 (line ispell-choices-win-default-height)
1509 ;; ensure 4 context lines.
1510 (max-lines (- (ispell-adjusted-window-height) 4))
1512 (window-min-height (min window-min-height
1513 ispell-choices-win-default-height))
1514 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1515 (dedicated (window-dedicated-p (selected-window)))
1517 char num result textwin dedicated-win)
1519 ;; setup the *Choices* buffer with valid data.
1521 (set-buffer (get-buffer-create ispell-choices-buffer))
1522 (setq mode-line-format (concat "-- %b -- word: " word))
1523 ;; XEmacs: prevent thick modeline vs increasing height in overlay-window
1524 ;;(and (fboundp 'set-specifier)
1525 ;; (set-specifier has-modeline-p (cons (current-buffer) nil)))
1529 (insert "Affix rules generate and capitalize "
1530 "this word as shown below:\n\t")
1532 (if (> (+ 4 (current-column) (length (car guess)))
1536 (setq line (1+ line))))
1537 (insert (car guess) " ")
1538 (setq guess (cdr guess)))
1539 (insert "\nUse option `i' if this is a correct composition"
1540 " from the derivative root.\n")
1541 (setq line (+ line (if choices 3 2)))))
1543 (< (if (> (+ 7 (current-column) (length (car choices))
1544 (if (> count ?~) 3 0))
1548 (setq line (1+ line)))
1551 ;; not so good if there are over 20 or 30 options, but then, if
1552 ;; there are that many you don't want to scan them all anyway...
1553 (while (memq count command-characters) ; skip command characters.
1554 (setq count (ispell-int-char (1+ count))
1555 skipped (1+ skipped)))
1556 (insert "(" count ") " (car choices) " ")
1557 (setq choices (cdr choices)
1558 count (ispell-int-char (1+ count))))
1559 (setq count (ispell-int-char (- count ?0 skipped))))
1561 ;; ensure word is visible
1562 (if (not (pos-visible-in-window-p end))
1565 ;; allow temporary split of dedicated windows...
1568 (setq dedicated-win (selected-window))
1569 (set-window-dedicated-p dedicated-win nil)))
1571 ;; Display choices for misspelled word.
1572 (ispell-show-choices line end)
1573 (select-window (setq textwin (next-window)))
1575 ;; highlight word, protecting current buffer status
1578 (and ispell-highlight-p
1579 (ispell-highlight-spelling-error start end t))
1580 ;; Loop until a valid choice is made.
1588 (let (message-log-max)
1589 (message (concat "C-h or ? for more options; SPC to leave "
1590 "unchanged, Character to replace word")))
1591 (let ((inhibit-quit t))
1592 (setq char (if (fboundp 'read-char-exclusive)
1593 (read-char-exclusive)
1596 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1599 ;; Adjust num to array offset skipping command characters.
1600 (let ((com-chars command-characters))
1602 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1603 (setq skipped (1+ skipped)))
1604 (setq com-chars (cdr com-chars)))
1605 (setq num (- char ?0 skipped)))
1608 ((= char ? ) nil) ; accept word this time only
1609 ((= char ?i) ; accept and insert word into pers dict
1610 (ispell-send-string (concat "*" word "\n"))
1611 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1613 ((or (= char ?a) (= char ?A)) ; accept word without insert
1614 (ispell-send-string (concat "@" word "\n"))
1615 (if (null ispell-pdict-modified-p)
1616 (setq ispell-pdict-modified-p
1617 (list ispell-pdict-modified-p)))
1618 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1619 ((or (= char ?r) (= char ?R)) ; type in replacement
1620 (and (eq 'block ispell-highlight-p) ; refresh tty's
1621 (ispell-highlight-spelling-error start end nil t))
1623 (if (or (= char ?R) ispell-query-replace-choices)
1625 (format "Query-replacement for %s: "word)
1628 (cons (read-string "Replacement for: " word)
1630 (and (eq 'block ispell-highlight-p)
1631 (ispell-highlight-spelling-error start end nil
1634 ((or (= char ??) (= char help-char) (= char ?\C-h))
1635 (and (eq 'block ispell-highlight-p)
1636 (ispell-highlight-spelling-error start end nil t))
1638 (and (eq 'block ispell-highlight-p)
1639 (ispell-highlight-spelling-error start end nil
1642 ;; Quit and move point back.
1644 (ispell-pdict-save ispell-silently-savep)
1645 (message "Exited spell-checking")
1646 (setq ispell-quit t)
1648 ;; Quit and preserve point.
1650 (ispell-pdict-save ispell-silently-savep)
1652 (substitute-command-keys
1653 (concat "Spell-checking suspended;"
1654 " use C-u \\[ispell-word] to resume")))
1655 (setq ispell-quit start)
1658 (if (y-or-n-p "Really kill Ispell process? ")
1660 (ispell-kill-ispell t) ; terminate process.
1661 (setq ispell-quit (or (not ispell-checking-message)
1663 ispell-pdict-modified-p nil))
1664 t)) ; continue if they don't quit.
1666 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1667 (ispell-highlight-spelling-error start end nil t))
1668 (let ((new-word (read-string
1669 "Lookup string (`*' is wildcard): "
1674 (set-buffer (get-buffer-create
1675 ispell-choices-buffer))
1679 mode-line-format (concat
1682 miss (lookup-words new-word)
1684 line ispell-choices-win-default-height)
1685 (while (and choices ; adjust choices window.
1686 (< (if (> (+ 7 (current-column)
1687 (length (car choices))
1688 (if (> count ?~) 3 0))
1692 (setq line (1+ line)))
1695 (while (memq count command-characters)
1696 (setq count (ispell-int-char (1+ count))
1697 skipped (1+ skipped)))
1698 (insert "(" count ") " (car choices) " ")
1699 (setq choices (cdr choices)
1700 count (ispell-int-char (1+ count))))
1701 (setq count (ispell-int-char
1702 (- count ?0 skipped))))
1703 (ispell-show-choices line end)
1704 (select-window (next-window)))))
1705 (and (eq 'block ispell-highlight-p)
1706 (ispell-highlight-spelling-error start end nil
1708 t) ; reselect from new choices
1709 ((= char ?u) ; insert lowercase into dictionary
1710 (ispell-send-string (concat "*" (downcase word) "\n"))
1711 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1713 ((= char ?m) ; type in what to insert
1715 (concat "*" (read-string "Insert: " word) "\n"))
1716 (setq ispell-pdict-modified-p '(t))
1718 ((and (>= num 0) (< num count))
1719 (if ispell-query-replace-choices ; Query replace flag
1720 (list (nth num miss) 'query-replace)
1725 ;; This may have alignment errors if current line is edited
1726 (if (marker-position ispell-recursive-edit-marker)
1728 (message "Only one recursive edit session supported")
1731 (set-marker ispell-recursive-edit-marker start)
1732 ;;(set-marker ispell-region-end reg-end)
1733 (and ispell-highlight-p ; unhighlight
1734 (ispell-highlight-spelling-error start end))
1739 (substitute-command-keys
1740 (concat "Exit recursive edit with"
1741 " \\[exit-recursive-edit]")))
1742 (save-window-excursion (save-excursion
1745 (goto-char ispell-recursive-edit-marker)
1746 (if (not (equal (marker-buffer
1747 ispell-recursive-edit-marker)
1750 (set-marker ispell-recursive-edit-marker nil)
1752 "Cannot continue ispell from this buffer.")))
1753 (set-marker ispell-recursive-edit-marker nil)))
1754 (list word nil)) ; recheck starting at this word.
1756 (funcall (key-binding "\C-z"))
1761 (and ispell-highlight-p ; unhighlight
1762 (save-window-excursion
1763 (select-window textwin)
1764 (ispell-highlight-spelling-error start end)))
1766 (set-window-dedicated-p dedicated-win t)))))
1770 (defun ispell-show-choices (line end)
1771 "Shows the choices in another buffer or frame."
1772 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
1774 (framepop-display-buffer (get-buffer ispell-choices-buffer))
1775 (get-buffer-window ispell-choices-buffer t)
1776 (select-window (previous-window))) ; *Choices* window
1777 ;; standard selection by splitting a small buffer out of this window.
1778 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1780 (if (= line (ispell-adjusted-window-height choices-window))
1781 (select-window choices-window)
1782 ;; *Choices* window changed size. Adjust the choices window
1783 ;; without scrolling the spelled window when possible
1785 (- line (ispell-adjusted-window-height choices-window)))
1786 (visible (progn (vertical-motion -1) (point))))
1787 (if (< line ispell-choices-win-default-height)
1788 (setq window-line (+ window-line
1789 (- ispell-choices-win-default-height
1791 (move-to-window-line 0)
1792 (vertical-motion window-line)
1793 (set-window-start (selected-window)
1794 (if (> (point) visible) visible (point)))
1796 (select-window (previous-window)) ; *Choices* window
1797 (enlarge-window window-line)))
1798 ;; Overlay *Choices* window when it isn't showing
1799 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1800 (switch-to-buffer ispell-choices-buffer)
1801 (goto-char (point-min)))))
1805 (defun ispell-help ()
1806 "Display a list of the options available when a misspelling is encountered.
1810 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1811 SPC: Accept word this time.
1812 `i': Accept word and insert into private dictionary.
1813 `a': Accept word for this session.
1814 `A': Accept word and place in `buffer-local dictionary'.
1815 `r': Replace word with typed-in value. Rechecked.
1816 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1817 `?': Show these commands.
1818 `x': Exit spelling buffer. Move cursor to original point.
1819 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1820 the aborted check to be completed later.
1821 `q': Quit spelling session (Kills ispell process).
1822 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1823 `u': Like `i', but the word is lower-cased first.
1824 `m': Place typed-in value in personal dictionary, then recheck current word.
1825 `C-l': redraws screen
1826 `C-r': recursive edit
1827 `C-z': suspend emacs or iconify frame"
1829 (if (equal ispell-help-in-bufferp 'electric)
1833 (function (lambda ()
1834 ;;This shouldn't be necessary: with-electric-help needs
1835 ;; an optional argument telling it about the smallest
1836 ;; acceptable window-height of the help buffer.
1837 (if (< (window-height) 15)
1839 (- 15 (ispell-adjusted-window-height))))
1840 (princ "Selections are:
1842 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1843 SPC: Accept word this time.
1844 `i': Accept word and insert into private dictionary.
1845 `a': Accept word for this session.
1846 `A': Accept word and place in `buffer-local dictionary'.
1847 `r': Replace word with typed-in value. Rechecked.
1848 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1849 `?': Show these commands.
1850 `x': Exit spelling buffer. Move cursor to original point.
1851 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1852 the aborted check to be completed later.
1853 `q': Quit spelling session (Kills ispell process).
1854 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1855 `u': Like `i', but the word is lower-cased first.
1856 `m': Place typed-in value in personal dictionary, then recheck current word.
1857 `C-l': redraws screen
1858 `C-r': recursive edit
1859 `C-z': suspend emacs or iconify frame")
1860 nil ;undocumented requirement of with-electric-help
1864 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1865 "[i]nsert into private dictionary"))
1866 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1867 "e[x/X]it; [q]uit session"))
1868 (help-3 (concat "[u]ncapitalized insert into dict. "
1869 "Type 'x C-h d ispell-help' for more help")))
1870 (save-window-excursion
1871 (if ispell-help-in-bufferp
1873 (ispell-overlay-window 4)
1874 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1875 (insert (concat help-1 "\n" help-2 "\n" help-3))
1877 (kill-buffer "*Ispell Help*"))
1880 (select-window (minibuffer-window))
1883 ;;(set-minibuffer-window (selected-window))
1885 (insert (concat help-1 "\n" help-2 "\n" help-3))
1887 (erase-buffer)))))))
1890 (defun lookup-words (word &optional lookup-dict)
1891 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
1892 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1893 Otherwise the variable `ispell-grep-command' contains the command used to
1894 search for the words (usually egrep).
1896 Optional second argument contains the dictionary to use; the default is
1897 `ispell-alternate-dictionary'."
1898 ;; We don't use the filter for this function, rather the result is written
1899 ;; into a buffer. Hence there is no need to save the filter values.
1900 (if (null lookup-dict)
1901 (setq lookup-dict ispell-alternate-dictionary))
1903 (let* ((process-connection-type ispell-use-ptys-p)
1904 (wild-p (string-match "\\*" word))
1905 (look-p (and ispell-look-p ; Only use look for an exact match.
1906 (or ispell-have-new-look (not wild-p))))
1907 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1908 (prog (if look-p ispell-look-command ispell-grep-command))
1909 (args (if look-p ispell-look-options ispell-grep-options))
1912 (save-window-excursion
1913 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1914 (set-buffer ispell-grep-buffer)
1918 (insert "^" word "$")
1919 (while (search-backward "*" nil t) (insert "."))
1920 (setq word (buffer-string))
1922 (setq status (call-process prog nil t nil args word lookup-dict))
1923 ;; grep returns status 1 and no output when word not found, which
1924 ;; is a perfectly normal thing.
1925 (if (stringp status)
1926 (setq results (cons (format "error: %s exited with signal %s"
1927 (file-name-nondirectory prog) status)
1929 ;; else collect words into `results' in FIFO order
1930 (goto-char (point-max))
1931 ;; assure we've ended with \n
1932 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1936 (setq results (cons (buffer-substring-no-properties (point)
1940 (kill-buffer ispell-grep-buffer)
1941 (if (and results (string-match ".+: " (car results)))
1942 (error "%s error: %s" ispell-grep-command (car results))))
1946 ;;; "ispell-filter" is a list of output lines from the generating function.
1947 ;;; Each full line (ending with \n) is a separate item on the list.
1948 ;;; "output" can contain multiple lines, part of a line, or both.
1949 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1951 ;;; "ispell-filter-continue" is true when we have received only part of a
1952 ;;; line as output from a generating function ("output" did not end with \n)
1953 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
1954 ;;; This is the case when a process dies or fails. The default behavior
1955 ;;; in this case treats the next input received as fresh input.
1957 (defun ispell-filter (process output)
1958 "Output filter function for ispell, grep, and look."
1963 (setq end (string-match "\n" output start)) ; get text up to the newline.
1964 ;; If we get out of sync and ispell-filter-continue is asserted when we
1965 ;; are not continuing, treat the next item as a separate list. When
1966 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1969 ;; Continue with same line (item)?
1970 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1971 ;; Yes. Add it to the prev item
1972 (setcar ispell-filter
1973 (concat (car ispell-filter) (substring output start end)))
1974 ;; No. This is a new line and item.
1976 (cons (substring output start end) ispell-filter)))
1978 ;; We've completed reading the output, but didn't finish the line.
1979 (setq ispell-filter-continue t continue nil)
1980 ;; skip over newline, this line complete.
1981 (setq ispell-filter-continue nil end (1+ end))
1982 (if (= end (length output)) ; No more lines in output
1983 (setq continue nil) ; so we can exit the filter.
1984 (setq start end)))))) ; else move start to next line of input
1987 ;;; This function destroys the mark location if it is in the word being
1989 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
1991 "Highlight the word from START to END with a kludge using `inverse-video'.
1992 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1993 otherwise it is displayed normally.
1994 Uses block cursor to highlight one character.
1995 Optional REFRESH will unhighlighted then highlight, using block cursor
1996 highlighting when REFRESH is equal to `block'."
1997 (and (eq 'block ispell-highlight-p)
1998 (or (eq 'block refresh)
1999 (setq start (1+ start)))) ; On block non-refresh, inc start.
2000 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2001 (buffer-read-only nil) ; Allow highlighting read-only buffers.
2002 (text (buffer-substring-no-properties start end)) ; Save hilight region
2003 (inhibit-quit t) ; inhibit interrupt processing here.
2004 (buffer-undo-list t)) ; don't clutter the undo list.
2006 (delete-region start end)
2007 (insert-char ? (- end start)) ; minimize amount of redisplay
2008 (sit-for 0) ; update display
2009 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2010 (delete-region start end) ; delete whitespace
2011 (insert text) ; insert text in inverse video.
2012 (sit-for 0) ; update display showing inverse video.
2015 (setq inverse-video (not inverse-video)) ; toggle video
2016 (and (eq 'block ispell-highlight-p)
2017 (goto-char (1- start)))) ; use block cursor to "highlight" char
2018 (set-buffer-modified-p modified) ; don't modify if flag not set.
2019 (and refresh ; re-highlight
2020 (ispell-highlight-spelling-error-generic
2021 (if (eq 'block refresh) start (- start 2)) end t))))
2024 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
2025 "Highlight the word from START to END using `isearch-highlight'.
2026 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2027 otherwise it is displayed normally."
2029 (isearch-highlight start end)
2030 (isearch-dehighlight t))
2035 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
2036 "Highlight the word from START to END using overlays.
2037 When the optional third arg HIGHLIGHT is set, the word is highlighted
2038 otherwise it is displayed normally.
2040 The variable `ispell-highlight-face' selects the face to use for highlighting."
2043 (setq ispell-overlay (make-overlay start end))
2044 (overlay-put ispell-overlay 'face ispell-highlight-face))
2045 (delete-overlay ispell-overlay)))
2048 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2051 (ispell-highlight-spelling-error-xemacs start end highlight))
2052 ((and (featurep 'faces)
2053 (or (and (fboundp 'display-color-p) (display-color-p))
2055 (ispell-highlight-spelling-error-overlay start end highlight))
2056 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2058 (defun ispell-adjusted-window-height (&optional window)
2059 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2060 The value returned is actually the nominal number of text-lines in the
2061 window plus 1. On a terminal, this is the same value returned by
2062 `window-height', but if the window has a mode-line is taller than a normal
2063 text line, the returned value may be smaller than that from
2065 (cond ((fboundp 'window-text-height)
2066 (1+ (window-text-height window)))
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 ((string= (substring output 0 1) "+") ; 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 (substring output 0 1)) ; &, ?, 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
2132 (if (string= type "#")
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 (string= 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 xemacsp
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 reg-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 reg-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 ((string-equal (upcase (substring word 0 1)) (substring word 0 1))
2837 (setq possibilities (mapcar (function
2840 (substring word 0 1)
2841 (substring pos 0 1))
2845 (setq case-fold-search case-fold-search-val)
2846 (save-window-excursion
2848 (ispell-command-loop possibilities nil word start end)))
2850 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
2851 (ispell-add-per-file-word-list word))
2852 (replacement ; REPLACEMENT WORD
2853 (delete-region start end)
2854 (setq word (if (atom replacement) replacement (car replacement))
2855 cursor-location (+ (- (length word) (- end start))
2858 (if (not (atom replacement)) ; recheck spelling of replacement.
2860 (goto-char cursor-location)
2861 (ispell-word nil t)))))
2862 (if (get-buffer ispell-choices-buffer)
2863 (kill-buffer ispell-choices-buffer))))
2864 (ispell-pdict-save ispell-silently-savep)
2865 (goto-char cursor-location)))
2869 (defun ispell-complete-word-interior-frag ()
2870 "Completes word matching character sequence inside a word."
2872 (ispell-complete-word t))
2877 "Interactively check a region or buffer for spelling errors.
2878 If `transient-mark-mode' is on, and a region is active, spell-check
2879 that region. Otherwise spell-check the buffer.
2881 Ispell dictionaries are not distributed with Emacs. If you are
2882 looking for a dictionary, please see the distribution of the GNU ispell
2883 program, or do an Internet search; there are various dictionaries
2884 available on the net."
2886 (if (and transient-mark-mode mark-active)
2887 (ispell-region (region-beginning) (region-end))
2891 ;;; **********************************************************************
2892 ;;; Ispell Minor Mode
2893 ;;; **********************************************************************
2895 (defvar ispell-minor-mode nil
2896 "Non-nil if Ispell minor mode is enabled.")
2897 ;; Variable indicating that ispell minor mode is active.
2898 (make-variable-buffer-local 'ispell-minor-mode)
2900 (or (assq 'ispell-minor-mode minor-mode-alist)
2901 (setq minor-mode-alist
2902 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
2904 (defvar ispell-minor-keymap
2905 (let ((map (make-sparse-keymap)))
2906 (define-key map " " 'ispell-minor-check)
2907 (define-key map "\r" 'ispell-minor-check)
2909 "Keymap used for Ispell minor mode.")
2911 (or (not (boundp 'minor-mode-map-alist))
2912 (assoc 'ispell-minor-mode minor-mode-map-alist)
2913 (setq minor-mode-map-alist
2914 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
2915 minor-mode-map-alist)))
2918 (defun ispell-minor-mode (&optional arg)
2919 "Toggle Ispell minor mode.
2920 With prefix arg, turn Ispell minor mode on iff arg is positive.
2922 In Ispell minor mode, pressing SPC or RET
2923 warns you if the previous word is incorrectly spelled.
2925 All the buffer-local variables and dictionaries are ignored -- to read
2926 them into the running ispell process, type \\[ispell-word] SPC."
2928 (setq ispell-minor-mode
2929 (not (or (and (null arg) ispell-minor-mode)
2930 (<= (prefix-numeric-value arg) 0))))
2931 (force-mode-line-update))
2933 (defun ispell-minor-check ()
2934 "Check previous word then continue with the normal binding of this key.
2935 Don't check previous word when character before point is a space or newline.
2936 Don't read buffer-local settings or word lists."
2938 (let ((ispell-minor-mode nil)
2939 (ispell-check-only t)
2940 (last-char (char-after (1- (point)))))
2941 (command-execute (key-binding (this-command-keys)))
2942 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
2943 (and ispell-skip-html (eq last-char ?>))
2944 (and ispell-skip-html (eq last-char ?\;))))
2945 (ispell-word nil t))))
2948 ;;; **********************************************************************
2950 ;;; **********************************************************************
2951 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2954 (defvar ispell-message-text-end
2955 (mapconcat (function identity)
2957 ;; Don't spell check signatures
2959 ;; Matches postscript files.
2960 "^%!PS-Adobe-[123].0"
2961 ;; Matches uuencoded text
2962 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2963 ;; Matches shell files (especially auto-decoding)
2965 ;; Matches context difference listing
2966 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2967 ;; Matches unidiff difference listing
2968 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
2969 ;; Matches reporter.el bug report
2970 "^current state:\n==============\n"
2971 ;; Matches commonly used "cut" boundaries
2972 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
2974 "*End of text which will be checked in `ispell-message'.
2975 If it is a string, limit at first occurrence of that regular expression.
2976 Otherwise, it must be a function which is called to get the limit.")
2981 (defun ispell-message ()
2982 "Check the spelling of a mail message or news post.
2983 Don't check spelling of message headers except the Subject field.
2984 Don't check included messages.
2986 To abort spell checking of a message region and send the message anyway,
2987 use the `x' command. (Any subsequent regions will be checked.)
2988 The `X' command aborts the message send so that you can edit the buffer.
2990 To spell-check whenever a message is sent, include the appropriate lines
2991 in your .emacs file:
2992 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
2993 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
2994 (add-hook 'mail-send-hook 'ispell-message)
2995 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2997 You can bind this to the key C-c i in GNUS or mail by adding to
2998 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2999 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3002 (goto-char (point-min))
3004 ;; Nil when message came from outside (eg calling emacs as editor)
3005 ;; Non-nil marker of end of headers.
3008 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3009 (end-of-headers ; Start of body.
3011 (or internal-messagep
3012 (re-search-forward "^$" nil t)
3014 (limit (copy-marker ; End of region we will spell check.
3016 ((not ispell-message-text-end) (point-max))
3017 ((char-or-string-p ispell-message-text-end)
3018 (if (re-search-forward ispell-message-text-end nil t)
3021 (t (min (point-max) (funcall ispell-message-text-end))))))
3022 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3023 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3024 (ispell-non-empty-string mail-yank-prefix)
3026 (cite-regexp ;Prefix of quoted text
3028 ((functionp 'sc-cite-regexp) ; sc 3.0
3029 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3030 (ispell-non-empty-string sc-reference-tag-string)))
3031 ((boundp 'sc-cite-regexp) ; sc 2.3
3032 (concat "\\(" sc-cite-regexp "\\)" "\\|"
3033 (ispell-non-empty-string sc-reference-tag-string)))
3034 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3035 (equal major-mode 'message-mode)) ;GNUS 5
3036 (concat "In article <" "\\|"
3037 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3038 message-yank-prefix "\\|"
3040 ((equal major-mode 'mh-letter-mode) ; mh mail message
3041 (concat "[^,;&+=\n]+ writes:" "\\|"
3042 (ispell-non-empty-string mh-ins-buf-prefix)))
3043 ((not internal-messagep) ; Assume nn sent us this message.
3044 (concat "In [a-zA-Z.]+ you write:" "\\|"
3045 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3047 ((boundp 'vm-included-text-prefix) ; VM mail message
3048 (concat "[^,;&+=\n]+ writes:" "\\|"
3049 (ispell-non-empty-string vm-included-text-prefix)))
3050 (t default-prefix)))
3051 (ispell-skip-region-alist
3052 (cons (list (concat "^\\(" cite-regexp "\\)")
3053 (function forward-line))
3054 ispell-skip-region-alist))
3055 (old-case-fold-search case-fold-search)
3056 (dictionary-alist ispell-message-dictionary-alist)
3057 (ispell-checking-message t))
3059 ;; Select dictionary for message
3060 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3061 (while dictionary-alist
3062 (goto-char (point-min))
3063 (if (re-search-forward (car (car dictionary-alist))
3065 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3066 dictionary-alist nil)
3067 (setq dictionary-alist (cdr dictionary-alist)))))
3071 ;; Spell check any original Subject:
3072 (goto-char (point-min))
3073 (setq case-fold-search t)
3074 (if (re-search-forward "^Subject: *" end-of-headers t)
3076 (goto-char (match-end 0))
3077 (if (and (not (looking-at ".*Re\\>"))
3078 (not (looking-at "\\[")))
3080 (setq case-fold-search old-case-fold-search)
3081 (ispell-region (point)
3082 (progn ;Tab-initiated continuation lns.
3084 (while (looking-at "\n[ \t]")
3087 (setq case-fold-search old-case-fold-search)
3088 (goto-char end-of-headers)
3090 (ispell-region (point) limit))
3091 (set-marker end-of-headers nil)
3092 (set-marker limit nil)))))
3095 (defun ispell-non-empty-string (string)
3096 (if (or (not string) (string-equal string ""))
3097 "\\'\\`" ; An unmatchable string if string is null.
3098 (regexp-quote string)))
3101 ;;; **********************************************************************
3102 ;;; Buffer Local Functions
3103 ;;; **********************************************************************
3106 (defun ispell-accept-buffer-local-defs ()
3107 "Load all buffer-local information, restarting Ispell when necessary."
3108 (ispell-buffer-local-dict) ; May kill ispell-process.
3109 (ispell-buffer-local-words) ; Will initialize ispell-process.
3110 (ispell-buffer-local-parsing))
3113 (defun ispell-buffer-local-parsing ()
3114 "Place Ispell into parsing mode for this buffer.
3115 Overrides the default parsing mode.
3116 Includes Latex/Nroff modes and extended character mode."
3117 ;; (ispell-init-process) must already be called.
3118 (ispell-send-string "!\n") ; Put process in terse mode.
3119 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3120 ;; When exclusively checking comments, set to raw text mode (nroff).
3121 (if (and (not (eq 'exclusive ispell-check-comments))
3122 (or (and (eq ispell-parser 'use-mode-name)
3123 (string-match "[Tt][Ee][Xx]-mode"
3124 (symbol-name major-mode)))
3125 (eq ispell-parser 'tex)))
3127 (ispell-send-string "+\n") ; set ispell mode to tex
3128 (if (not (eq ispell-parser 'tex))
3129 (set (make-local-variable 'ispell-parser) 'tex)))
3130 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3131 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3132 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
3133 (set (make-local-variable 'ispell-skip-html)
3134 (not (null (string-match "sgml\\|html\\|xml"
3135 (downcase (symbol-name major-mode)))))))
3136 ;; Set default extended character mode for given buffer, if any.
3137 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3138 (if extended-char-mode
3139 (ispell-send-string (concat extended-char-mode "\n"))))
3140 ;; Set buffer-local parsing mode and extended character mode, if specified.
3142 (goto-char (point-max))
3143 ;; Uses last occurrence of ispell-parsing-keyword
3144 (if (search-backward ispell-parsing-keyword nil t)
3145 (let ((end (save-excursion (end-of-line) (point)))
3147 (search-forward ispell-parsing-keyword)
3148 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3149 ;; space separated definitions.
3150 (setq string (downcase (buffer-substring-no-properties
3151 (match-beginning 1) (match-end 1))))
3152 (cond ((and (string-match "latex-mode" string)
3153 (not (eq 'exclusive ispell-check-comments)))
3154 (ispell-send-string "+\n~tex\n"))
3155 ((string-match "nroff-mode" string)
3156 (ispell-send-string "-\n~nroff\n"))
3157 ((string-match "~" string) ; Set extended character mode.
3158 (ispell-send-string (concat string "\n")))
3159 (t (message "Invalid Ispell Parsing argument!")
3163 ;;; Can kill the current ispell process
3165 (defun ispell-buffer-local-dict ()
3166 "Initializes local dictionary and local personal dictionary.
3167 When a dictionary is defined in the buffer (see variable
3168 `ispell-dictionary-keyword'), it will override the local setting
3169 from \\[ispell-change-dictionary].
3170 Both should not be used to define a buffer-local dictionary."
3172 (goto-char (point-min))
3174 ;; Override the local variable definition.
3175 ;; Uses last occurrence of ispell-dictionary-keyword.
3176 (goto-char (point-max))
3177 (if (search-backward ispell-dictionary-keyword nil t)
3179 (search-forward ispell-dictionary-keyword)
3180 (setq end (save-excursion (end-of-line) (point)))
3181 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3182 (setq ispell-local-dictionary
3183 (buffer-substring-no-properties (match-beginning 1)
3185 (goto-char (point-max))
3186 (if (search-backward ispell-pdict-keyword nil t)
3188 (search-forward ispell-pdict-keyword)
3189 (setq end (save-excursion (end-of-line) (point)))
3190 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3191 (setq ispell-local-pdict
3192 (buffer-substring-no-properties (match-beginning 1)
3193 (match-end 1))))))))
3194 ;; Reload if new personal dictionary defined.
3195 (if (and ispell-local-pdict
3196 (not (equal ispell-local-pdict ispell-personal-dictionary)))
3198 (ispell-kill-ispell t)
3199 (setq ispell-personal-dictionary ispell-local-pdict)))
3200 ;; Reload if new dictionary defined.
3201 (if (and ispell-local-dictionary
3202 (not (equal ispell-local-dictionary ispell-dictionary)))
3203 (ispell-change-dictionary ispell-local-dictionary)))
3206 (defun ispell-buffer-local-words ()
3207 "Loads the buffer-local dictionary in the current buffer."
3208 (if (and ispell-buffer-local-name
3209 (not (equal ispell-buffer-local-name (buffer-name))))
3211 (ispell-kill-ispell t)
3212 (setq ispell-buffer-local-name nil)))
3213 (ispell-init-process)
3215 (goto-char (point-min))
3216 (while (search-forward ispell-words-keyword nil t)
3217 (or ispell-buffer-local-name
3218 (setq ispell-buffer-local-name (buffer-name)))
3219 (let ((end (save-excursion (end-of-line) (point)))
3220 (ispell-casechars (ispell-get-casechars))
3222 ;; buffer-local words separated by a space, and can contain
3223 ;; any character other than a space. Not rigorous enough.
3224 (while (re-search-forward " *\\([^ ]+\\)" end t)
3225 (setq string (buffer-substring-no-properties (match-beginning 1)
3227 ;; This can fail when string contains a word with illegal chars.
3228 ;; Error handling needs to be added between ispell and emacs.
3229 (if (and (< 1 (length string))
3230 (equal 0 (string-match ispell-casechars string)))
3231 (ispell-send-string (concat "@" string "\n"))))))))
3234 ;;; returns optionally adjusted region-end-point.
3236 (defun ispell-add-per-file-word-list (word)
3237 "Add WORD to the per-file word list."
3238 (or ispell-buffer-local-name
3239 (setq ispell-buffer-local-name (buffer-name)))
3241 (goto-char (point-min))
3242 (let ((old-case-fold-search case-fold-search)
3243 line-okay search done found)
3245 (setq case-fold-search nil
3246 search (search-forward ispell-words-keyword nil 'move)
3247 found (or found search)
3248 line-okay (< (+ (length word) 1 ; 1 for space after word..
3249 (progn (end-of-line) (current-column)))
3251 case-fold-search old-case-fold-search)
3252 (if (or (and search line-okay)
3259 (unless found (newline))
3260 (insert (concat comment-start " " ispell-words-keyword))
3261 (if (> (length comment-end) 0)
3264 (insert comment-end)))))
3265 (insert (concat " " word))))))))
3267 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3272 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3274 ;;; Local Variable options:
3275 ;;; mode: name(-mode)
3276 ;;; eval: expression
3277 ;;; local-variable: value
3279 ;;; The following sets the buffer local dictionary to `american' English
3280 ;;; and spell checks only comments.
3282 ;;; Local Variables:
3283 ;;; mode: emacs-lisp
3284 ;;; comment-column: 40
3285 ;;; ispell-check-comments: exclusive
3286 ;;; ispell-local-dictionary: "american"
3290 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3292 ;;; The following places this file in nroff parsing and extended char modes.
3293 ;;; Local IspellParsing: nroff-mode ~nroff
3294 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3295 ;;; Local IspellPersDict ~/.ispell_lisp
3296 ;;; The following were automatically generated by ispell using the 'A' command:
3297 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3298 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3299 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3300 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3301 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3302 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3303 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3304 ; LocalWords: lns XEmacs HTML casechars Multibyte
3306 ;;; ispell.el ends here