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