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,
4 ;; 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, 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 (defvar mail-yank-prefix)
206 ;;; Custom.el macros require recompiling this when they are not present.
207 ;;; Add in backward compatible custom support.
209 (if (not (fboundp 'defcustom))
210 (defmacro defcustom (symbol value doc &rest args)
211 "Empty replacement for defcustom when not supplied."
212 `(defvar ,symbol ,value ,doc))))
215 (if (not (fboundp 'defgroup))
216 (defmacro defgroup (&rest args)
217 "Empty replacement for defgroup when not supplied.")))
220 "User variables for emacs ispell interface."
221 :group 'applications)
223 (if (not (fboundp 'buffer-substring-no-properties))
224 (defun buffer-substring-no-properties (start end)
225 (buffer-substring start end)))
227 (defalias 'check-ispell-version 'ispell-check-version)
229 ;;; **********************************************************************
230 ;;; The following variables should be set according to personal preference
231 ;;; and location of binaries:
232 ;;; **********************************************************************
235 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
237 (defcustom ispell-highlight-p 'block
238 "*Highlight spelling errors when non-nil.
239 When set to `block', assumes a block cursor with TTY displays."
240 :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t))
243 (defcustom ispell-lazy-highlight (boundp 'lazy-highlight-cleanup)
244 "*Controls the lazy-highlighting of spelling errors.
245 When non-nil, all text in the buffer matching the current spelling
246 error is highlighted lazily using isearch lazy highlighting (see
247 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
249 :group 'lazy-highlight
253 (defcustom ispell-highlight-face (if ispell-lazy-highlight 'isearch 'highlight)
254 "*The face used for Ispell highlighting. For Emacses with overlays.
255 Possible values are `highlight', `modeline', `secondary-selection',
256 `region', and `underline'.
257 This variable can be set by the user to whatever face they desire.
258 It's most convenient if the cursor color and highlight color are
263 (defcustom ispell-check-comments t
264 "*Spelling of comments checked when non-nil.
265 When set to `exclusive', ONLY comments are checked. (For code comments).
266 Warning! Not checking comments, when a comment start is embedded in strings,
267 may produce undesired results."
268 :type '(choice (const exclusive) (const :tag "off" nil) (const :tag "on" t))
270 ;;;###autoload(put 'ispell-check-comments 'safe-local-variable (lambda (a) (memq a '(nil t exclusive))))
272 (defcustom ispell-query-replace-choices nil
273 "*Corrections made throughout region when non-nil.
274 Uses `query-replace' (\\[query-replace]) for corrections."
278 (defcustom ispell-skip-tib nil
279 "*Does not spell check `tib' bibliography references when non-nil.
280 Skips any text between strings matching regular expressions
281 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
283 TeX users beware: Any field starting with [. will skip until a .] -- even
284 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
285 a [.5mm] type of number...."
289 (defvar ispell-tib-ref-beginning "[[<]\\."
290 "Regexp matching the beginning of a Tib reference.")
292 (defvar ispell-tib-ref-end "\\.[]>]"
293 "Regexp matching the end of a Tib reference.")
295 (defcustom ispell-keep-choices-win t
296 "*When not nil, the `*Choices*' window remains for spelling session.
297 This minimizes redisplay thrashing."
301 (defcustom ispell-choices-win-default-height 2
302 "*The default size of the `*Choices*' window, including mode line.
303 Must be greater than 1."
307 (defcustom ispell-program-name
308 (or (locate-file "aspell" exec-path exec-suffixes 'file-executable-p)
310 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
314 (defcustom ispell-alternate-dictionary
315 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
316 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
317 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
318 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
319 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
320 ((file-exists-p "/usr/share/lib/dict/words")
321 "/usr/share/lib/dict/words")
322 ((file-exists-p "/sys/dict") "/sys/dict")
323 (t "/usr/dict/words"))
324 "*Alternate dictionary for spelling help."
325 :type '(choice file (const :tag "None" nil))
328 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
329 "*Dictionary used for word completion."
330 :type '(choice file (const :tag "None" nil))
333 (defcustom ispell-message-dictionary-alist nil
334 "*List used by `ispell-message' to select a new dictionary.
335 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
336 in the message headers, `ispell-local-dictionary' will be set to
337 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
338 E.g. you may use the following value:
339 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
340 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
341 :type '(repeat (cons regexp string))
345 (defcustom ispell-message-fcc-skip 50000
346 "*Query before saving Fcc message copy if attachment larger than this value.
347 Always stores Fcc copy of message when nil."
348 :type '(choice integer (const :tag "off" nil))
352 (defcustom ispell-grep-command "egrep"
353 "Name of the grep command for search processes."
357 (defcustom ispell-grep-options "-i"
358 "String of options to use when running the program in `ispell-grep-command'.
359 Should probably be \"-i\" or \"-e\".
360 Some machines (like the NeXT) don't support \"-i\""
364 (defcustom ispell-look-command
365 (cond ((file-exists-p "/bin/look") "/bin/look")
366 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
367 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
369 "Name of the look command for search processes.
370 This must be an absolute file name."
374 (defcustom ispell-look-p (file-exists-p ispell-look-command)
375 "*Non-nil means use `look' rather than `grep'.
376 Default is based on whether `look' seems to be available."
380 (defcustom ispell-have-new-look nil
381 "*Non-nil means use the `-r' option (regexp) when running `look'."
385 (defcustom ispell-look-options (if ispell-have-new-look "-dfr" "-df")
386 "String of command options for `ispell-look-command'."
390 (defcustom ispell-use-ptys-p nil
391 "When non-nil, Emacs uses ptys to communicate with Ispell.
392 When nil, Emacs uses pipes."
396 (defcustom ispell-following-word nil
397 "*Non-nil means `ispell-word' checks the word around or after point.
398 Otherwise `ispell-word' checks the preceding word."
402 (defcustom ispell-help-in-bufferp nil
403 "*Non-nil means display interactive keymap help in a buffer.
404 The following values are supported:
405 nil Expand the minibuffer and display a short help message
406 there for a couple of seconds.
407 t Pop up a new buffer and display a short help message there
408 for a couple of seconds.
409 electric Pop up a new buffer and display a long help message there.
410 User can browse and then exit the help mode."
411 :type '(choice (const electric) (const :tag "off" nil) (const :tag "on" t))
414 (defcustom ispell-quietly nil
415 "*Non-nil means suppress messages in `ispell-word'."
419 (defcustom ispell-format-word (function upcase)
420 "*Formatting function for displaying word being spell checked.
421 The function must take one string argument and return a string."
425 (defcustom ispell-use-framepop-p nil
426 "When non-nil ispell uses framepop to display choices in a dedicated frame.
427 You can set this variable to dynamically use framepop if you are in a
428 window system by evaluating the following on startup to set this variable:
429 (and window-system (condition-case () (require 'framepop) (error nil)))"
434 (defcustom ispell-personal-dictionary nil
435 "*File name of your personal spelling dictionary, or nil.
436 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
437 where DICTNAME is the name of your default dictionary."
439 (const :tag "default" nil))
442 (defcustom ispell-silently-savep nil
443 "*When non-nil, save the personal dictionary without confirmation."
447 (defvar ispell-local-dictionary-overridden nil
448 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
449 (make-variable-buffer-local 'ispell-local-dictionary-overridden)
451 (defcustom ispell-local-dictionary nil
452 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
453 The value must be a string dictionary name,
454 or nil, which means use the global setting in `ispell-dictionary'.
455 Dictionary names are defined in `ispell-local-dictionary-alist'
456 and `ispell-dictionary-alist',
458 Setting `ispell-local-dictionary' to a value has the same effect as
459 calling \\[ispell-change-dictionary] with that value. This variable
460 is automatically set when defined in the file with either
461 `ispell-dictionary-keyword' or the Local Variable syntax."
462 :type '(choice string
463 (const :tag "default" nil))
465 ;;;###autoload(put 'ispell-local-dictionary 'safe-local-variable 'string-or-null-p)
467 (make-variable-buffer-local 'ispell-local-dictionary)
469 (defcustom ispell-extra-args nil
470 "*If non-nil, a list of extra switches to pass to the Ispell program.
471 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
472 words as correct. See also `ispell-dictionary-alist', which may be used
473 for language-specific arguments."
474 :type '(repeat string)
479 (defcustom ispell-skip-html 'use-mode-name
480 "*Indicates whether ispell should skip spell checking of SGML markup.
481 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
482 guess whether SGML markup should be skipped according to the name of the
483 buffer's major mode."
484 :type '(choice (const :tag "always" t) (const :tag "never" nil)
485 (const :tag "use-mode-name" use-mode-name))
488 (make-variable-buffer-local 'ispell-skip-html)
492 (defcustom ispell-local-dictionary-alist nil
493 "*List of local or customized dictionary definitions.
494 These can override the values in `ispell-dictionary-alist'.
496 To make permanent changes to your dictionary definitions, you
497 will need to make your changes in this variable, save, and then
499 :type '(repeat (list (choice :tag "Dictionary"
500 (string :tag "Dictionary name")
501 (const :tag "default" nil))
502 (regexp :tag "Case characters")
503 (regexp :tag "Non case characters")
504 (regexp :tag "Other characters")
505 (boolean :tag "Many other characters")
506 (repeat :tag "Ispell command line args"
508 (choice :tag "Extended character mode"
509 (const "~tex") (const "~plaintex")
510 (const "~nroff") (const "~list")
511 (const "~latin1") (const "~latin3")
512 (const :tag "default" nil))
513 (coding-system :tag "Coding System")))
517 ;;; split dictionary so line length is smaller in loaddefs.el
519 ;;; First part of dictionary, shortened for loaddefs.el
522 ispell-dictionary-alist-1
523 '((nil ; default (English.aff)
524 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
525 ("american" ; Yankee English
526 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
527 ("brasileiro" ; Brazilian mode
528 "[A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
529 "[^A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
530 "[']" nil nil nil iso-8859-1)
531 ("british" ; British version
532 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
533 ("castellano" ; Spanish mode
534 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
535 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
536 "[-]" nil ("-B") "~tex" iso-8859-1)
537 ("castellano8" ; 8 bit Spanish mode
538 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
539 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
540 "[-]" nil ("-B" "-d" "castellano") "~latin1" iso-8859-1)))
543 ;;; Second part of dictionary, shortened for loaddefs.el
546 ispell-dictionary-alist-2
548 "[A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
549 "[^A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
550 "" nil ("-B") nil iso-8859-2)
552 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
553 "[']" nil ("-C") nil iso-8859-1)
554 ("deutsch" ; Deutsch.aff
555 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
557 "[a-zA-Z\304\326\334\344\366\337\374]"
558 "[^a-zA-Z\304\326\334\344\366\337\374]"
559 "[']" t ("-C" "-d" "deutsch") "~latin1" iso-8859-1)
560 ("english" ; make English explicitly selectable
561 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)))
564 ;;; Third part of dictionary, shortened for loaddefs.el
567 ispell-dictionary-alist-3
569 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
570 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
571 "[-']" t ("-C") "~latin3" iso-8859-3)
573 "[A-Za-z^\\]" "[^A-Za-z^\\]"
574 "[-'`\"]" t ("-C" "-d" "esperanto") "~tex" iso-8859-3)
576 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil iso-8859-1)
577 ("francais" ; Francais.aff
578 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
579 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
580 "[-'.@]" t nil "~list" iso-8859-1)
581 ("francais-tex" ; Francais.aff
582 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
583 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
584 "[-'^`\".@]" t nil "~tex" iso-8859-1)))
587 ;;; Fourth part of dictionary, shortened for loaddefs.el
590 ispell-dictionary-alist-4
591 '(("german" ; german.aff
592 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
593 ("german8" ; german.aff
594 "[a-zA-Z\304\326\334\344\366\337\374]"
595 "[^a-zA-Z\304\326\334\344\366\337\374]"
596 "[']" t ("-C" "-d" "german") "~latin1" iso-8859-1)
597 ("italiano" ; Italian.aff
598 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
599 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
600 "[-.]" nil ("-B" "-d" "italian") "~tex" iso-8859-1)
601 ("nederlands" ; Nederlands.aff
602 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
603 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
604 "[']" t ("-C") nil iso-8859-1)
605 ("nederlands8" ; Dutch8.aff
606 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
607 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
608 "[']" t ("-C") nil iso-8859-1)))
611 ;;; Fifth part of dictionary, shortened for loaddefs.el
614 ispell-dictionary-alist-5
615 '(("norsk" ; 8 bit Norwegian mode
616 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
617 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
618 "[\"]" nil nil "~list" iso-8859-1)
619 ("norsk7-tex" ; 7 bit Norwegian TeX mode
620 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
621 "[\"]" nil ("-d" "norsk") "~plaintex" iso-8859-1)
622 ("polish" ; Polish mode
623 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
624 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
625 "." nil nil nil iso-8859-2)
626 ("portugues" ; Portuguese mode
627 "[a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
628 "[^a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
629 "[']" t ("-C") "~latin1" iso-8859-1)))
632 ;;; Sixth part of dictionary, shortened for loaddefs.el
635 ispell-dictionary-alist-6
636 ;; include Russian iso coding system too?
637 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
638 '(("russian" ; Russian.aff (KOI8-R charset)
639 "[\341\342\367\347\344\345\263\366\372\351\352\353\354\355\356\357\360\362\363\364\365\346\350\343\376\373\375\370\371\377\374\340\361\301\302\327\307\304\305\243\326\332\311\312\313\314\315\316\317\320\322\323\324\325\306\310\303\336\333\335\330\331\337\334\300\321]"
640 "[^\341\342\367\347\344\345\263\366\372\351\352\353\354\355\356\357\360\362\363\364\365\346\350\343\376\373\375\370\371\377\374\340\361\301\302\327\307\304\305\243\326\332\311\312\313\314\315\316\317\320\322\323\324\325\306\310\303\336\333\335\330\331\337\334\300\321]"
641 "" nil nil nil koi8-r)
642 ("russianw" ; russianw.aff (CP1251 charset)
643 "[\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
644 "[^\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
645 "" nil nil nil windows-1251)
646 ("slovak" ; Slovakian
647 "[A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
648 "[^A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
649 "" nil ("-B") nil iso-8859-2)
650 ("slovenian" ; Slovenian
651 "[A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
652 "[^A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
653 "" nil ("-B" "-d" "slovenian") nil iso-8859-2)
654 ("svenska" ; Swedish mode
655 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
656 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
657 "[']" nil ("-C") "~list" iso-8859-1)))
661 (defvar ispell-dictionary-alist
662 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2
663 ispell-dictionary-alist-3 ispell-dictionary-alist-4
664 ispell-dictionary-alist-5 ispell-dictionary-alist-6)
665 "An alist of dictionaries and their associated parameters.
667 Each element of this list is also a list:
669 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
670 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
672 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
673 nil means the default dictionary.
675 CASECHARS is a regular expression of valid characters that comprise a
678 NOT-CASECHARS is the opposite regexp of CASECHARS.
680 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
681 used to construct words in some special way. If OTHERCHARS characters follow
682 and precede characters from CASECHARS, they are parsed as part of a word,
683 otherwise they become word-breaks. As an example in English, assume the
684 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
685 \"Steven's\" are parsed as single words including the \"'\" character, but
686 \"Stevens'\" does not include the quote character as part of the word.
687 If you want OTHERCHARS to be empty, use the empty string.
688 Hint: regexp syntax requires the hyphen to be declared first here.
690 CASECHAS, NOT-CASECHARS, and OTHERCHARS must be a unibyte string
691 containing bytes of CHARACTER-SET. In addition, if they contain
692 a non-ASCII byte, the regular expression must be a single
693 `character set' construct that doesn't specify a character range
696 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
697 Otherwise only a single OTHERCHARS character is allowed to be part of any
700 ISPELL-ARGS is a list of additional arguments passed to the ispell
703 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
704 have been configured in an Ispell affix file. (For example, umlauts
705 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
706 in English. This has the same effect as the command-line `-T' option.
707 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
708 but the dictionary can control the extended character mode.
709 Both defaults can be overruled in a buffer-local fashion. See
710 `ispell-parsing-keyword' for details on this.
712 CHARACTER-SET used for languages with multibyte characters.
714 Note that the CASECHARS and OTHERCHARS slots of the alist should
715 contain the same character set as casechars and otherchars in the
716 LANGUAGE.aff file \(e.g., english.aff\).")
718 (defvar ispell-really-aspell nil) ; Non-nil if aspell extensions should be used
720 (defvar ispell-aspell-supports-utf8 nil
721 "Non-nil means to try to automatically find aspell dictionaries.
722 This is set to t in `ispell-check-version' for aspell >= 0.60.
724 Earlier aspell versions do not consistently support UTF-8. Handling
725 this would require some extra guessing in `ispell-aspell-find-dictionary'.")
729 ;;; **********************************************************************
730 ;;; The following are used by ispell, and should not be changed.
731 ;;; **********************************************************************
735 ;;; The version must be 3.1 or greater for this version of ispell.el
736 ;;; There is an incompatibility between version 3.1.12 and lower versions.
737 (defconst ispell-required-version '(3 1 12)
738 "Ispell versions with which this version of ispell.el is known to work.")
739 (defvar ispell-offset -1
740 "Offset that maps protocol differences between ispell 3.1 versions.")
742 (defconst ispell-version "ispell.el 3.6 - 7-Jan-2003")
745 (defun ispell-check-version (&optional interactivep)
746 "Ensure that `ispell-program-name' is valid and the correct version.
747 Returns version number if called interactively.
748 Otherwise returns the library directory name, if that is defined."
749 ;; This is a little wasteful as we actually launch ispell twice: once
750 ;; to make sure it's the right version, and once for real. But people
751 ;; get confused by version mismatches *all* the time (and I've got the
752 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
753 ;; option is the only way I can think of to do this that works with
754 ;; all versions, since versions earlier than 3.0.09 didn't identify
755 ;; themselves on startup.
757 (let ((case-fold-search-val case-fold-search)
758 ;; avoid bugs when syntax of `.' changes in various default modes
759 (default-major-mode 'fundamental-mode)
760 (default-directory (or (and (boundp 'temporary-file-directory)
761 temporary-file-directory)
765 (let ((buf (get-buffer " *ispell-tmp*")))
766 (if buf (kill-buffer buf)))
767 (set-buffer (get-buffer-create " *ispell-tmp*"))
769 (unless (file-exists-p default-directory)
770 (setq default-directory (expand-file-name "~/")))
771 (setq status (call-process
772 ispell-program-name nil t nil
773 ;; aspell doesn't accept the -vv switch.
774 (let ((case-fold-search
775 (memq system-type '(ms-dos windows-nt)))
777 (file-name-nondirectory ispell-program-name)))
778 ;; Assume anything that isn't `aspell' is Ispell.
779 (if (string-match "\\`aspell" speller) "-v" "-vv"))))
780 (goto-char (point-min))
782 ;; report version information of ispell and ispell.el
785 (setq result (concat (buffer-substring-no-properties (point-min)
789 (message "%s" result))
790 ;; return library directory.
791 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t)
792 (setq result (buffer-substring (match-beginning 1) (match-end 1)))))
793 (goto-char (point-min))
794 (if (not (memq status '(0 nil)))
795 (error "%s exited with %s %s" ispell-program-name
796 (if (stringp status) "signal" "code") status))
797 (setq case-fold-search t
798 status (re-search-forward
800 (format "%d" (car ispell-required-version))
801 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
803 case-fold-search case-fold-search-val)
804 (if (or (not status) ; major version mismatch
805 (< (car (read-from-string (match-string-no-properties 2)))
806 (car (cdr ispell-required-version)))) ; minor version mismatch
807 (error "%s version 3 release %d.%d.%d or greater is required"
808 ispell-program-name (car ispell-required-version)
809 (car (cdr ispell-required-version))
810 (car (cdr (cdr ispell-required-version))))
811 ;; check that it is the correct version.
812 (if (and (= (car (read-from-string (match-string-no-properties 2)))
813 (car (cdr ispell-required-version)))
814 (< (car (read-from-string (match-string-no-properties 3)))
815 (car (cdr (cdr ispell-required-version)))))
816 (setq ispell-offset 0))
817 ;; Check to see if it's really aspell.
818 (goto-char (point-min))
819 (let (case-fold-search)
820 (setq ispell-really-aspell
821 (and (search-forward-regexp
822 "(but really Aspell \\(.*?\\)\\(-[0-9]+\\)?)" nil t)
824 (setq ispell-aspell-supports-utf8
825 (not (version< (match-string 1) "0.60")))
827 (kill-buffer (current-buffer)))
832 ;;; The preparation of the menu bar menu must be autoloaded
833 ;;; because otherwise this file gets autoloaded every time Emacs starts
834 ;;; so that it can set up the menus and determine keyboard equivalents.
838 (defvar ispell-menu-map nil "Key map for ispell menu.")
839 ;;; redo menu when loading ispell to get dictionary modifications
840 (setq ispell-menu-map nil)
843 (defvar ispell-menu-xemacs nil
844 "Spelling menu for XEmacs.
845 If nil when package is loaded, a standard menu will be set,
846 and added as a submenu of the \"Edit\" menu.")
848 ;;; Break out XEmacs menu and split into several calls to avoid having
849 ;;; long lines in loaddefs.el. Detect need off following constant.
851 ;;; Set up dictionary
853 (defvar ispell-menu-map-needed
854 ;; only needed when not version 18 and not XEmacs.
855 (and (not ispell-menu-map)
856 (not (featurep 'xemacs))
859 (defvar ispell-library-directory (condition-case ()
860 (ispell-check-version)
862 "Directory where ispell dictionaries reside.")
864 (defvar ispell-process nil
865 "The process object for Ispell.")
867 (defvar ispell-async-processp (and (fboundp 'kill-process)
868 (fboundp 'process-send-string)
869 (fboundp 'accept-process-output)
870 ;;(fboundp 'start-process)
871 ;;(fboundp 'set-process-filter)
872 ;;(fboundp 'process-kill-without-query)
874 "Non-nil means that the OS supports asynchronous processes.")
876 ;; Make ispell.el work better with aspell.
878 (defvar ispell-have-aspell-dictionaries nil
879 "Non-nil if we have queried Aspell for dictionaries at least once.")
881 (defun ispell-maybe-find-aspell-dictionaries ()
882 "Find Aspell's dictionaries, unless already done."
883 (when (and (not ispell-have-aspell-dictionaries)
885 (progn (ispell-check-version) t)
888 ispell-aspell-supports-utf8)
889 (ispell-find-aspell-dictionaries)))
891 (defun ispell-find-aspell-dictionaries ()
892 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
893 (unless ispell-really-aspell
894 (error "This function only works with aspell"))
898 (call-process ispell-program-name nil t nil "dicts")
900 ;; Search for the named dictionaries.
903 (mapcar #'ispell-aspell-find-dictionary dictionaries))))
904 ;; Ensure aspell's alias dictionary will override standard
906 (setq found (ispell-aspell-add-aliases found))
907 ;; Merge into FOUND any elements from the standard ispell-dictionary-alist
908 ;; which have no element in FOUND at all.
909 (dolist (dict ispell-dictionary-alist)
910 (unless (assoc (car dict) found)
911 (setq found (nconc found (list dict)))))
912 (setq ispell-dictionary-alist found)
913 ;; Add a default entry
914 (let* ((english-dict (assoc "en" ispell-dictionary-alist))
916 (cons nil (or (cdr english-dict)
917 (cdr (car ispell-dictionary-alist-1))))))
918 (push default-dict ispell-dictionary-alist))
919 (setq ispell-have-aspell-dictionaries t)))
921 (defvar ispell-aspell-data-dir nil
922 "Data directory of Aspell.")
924 (defvar ispell-aspell-dict-dir nil
925 "Dictionary directory of Aspell.")
927 (defun ispell-get-aspell-config-value (key)
928 "Return value of Aspell configuration option KEY.
929 Assumes that value contains no whitespace."
931 (call-process ispell-program-name nil t nil "config" key)
932 (car (split-string (buffer-string)))))
934 (defun ispell-aspell-find-dictionary (dict-name)
935 ;; This returns nil if the data file does not exist.
936 ;; Can someone please explain the return value format when the
937 ;; file does exist -- rms?
938 (let* ((lang ;; Strip out region, variant, etc.
939 (and (string-match "^[[:alpha:]]+" dict-name)
940 (match-string 0 dict-name)))
942 (concat (or ispell-aspell-data-dir
943 (setq ispell-aspell-data-dir
944 (ispell-get-aspell-config-value "data-dir")))
949 (insert-file-contents data-file)
950 ;; There is zero or one line with special characters declarations.
951 (when (search-forward-regexp "^special" nil t)
952 (let ((specials (split-string
953 (buffer-substring (point)
954 (progn (end-of-line) (point))))))
955 ;; The line looks like: special ' -** - -** . -** : -*-
956 ;; -** means that this character
957 ;; - doesn't appear at word start
958 ;; * may appear in the middle of a word
959 ;; * may appear at word end
960 ;; `otherchars' is about the middle case.
962 (when (eq (aref (cadr specials) 1) ?*)
963 (push (car specials) otherchars))
964 (setq specials (cddr specials)))))
968 (regexp-opt otherchars)
969 t ; We can't tell, so set this to t
970 (list "-d" dict-name "--encoding=utf-8")
971 nil ; aspell doesn't support this
972 ;; Here we specify the encoding to use while communicating with
973 ;; aspell. This doesn't apply to command line arguments, so
974 ;; just don't pass words to spellcheck as arguments...
979 (defun ispell-aspell-add-aliases (alist)
980 "Find aspell's dictionary aliases and add them to dictionary ALIST.
981 Return the new dictionary alist."
982 (let ((aliases (file-expand-wildcards
983 (concat (or ispell-aspell-dict-dir
984 (setq ispell-aspell-dict-dir
985 (ispell-get-aspell-config-value "dict-dir")))
987 (dolist (alias-file aliases)
989 (insert-file-contents alias-file)
990 ;; Look for a line "add FOO.multi", extract FOO
991 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t)
992 (let* ((aliasname (file-name-sans-extension
993 (file-name-nondirectory alias-file)))
994 (already-exists-p (assoc aliasname alist))
995 (realname (match-string 1))
996 (realdict (assoc realname alist)))
997 (when (and realdict (not already-exists-p))
998 (push (cons aliasname (cdr realdict)) alist))))))
1001 (defun ispell-valid-dictionary-list ()
1002 "Returns a list of valid dictionaries.
1003 The variable `ispell-library-directory' defines the library location."
1004 ;; If Ispell is really Aspell, query it for the dictionary list.
1005 (ispell-maybe-find-aspell-dictionaries)
1006 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist))
1007 (dict-list (cons "default" nil))
1009 (dolist (dict dicts)
1010 (setq name (car dict)
1011 load-dict (car (cdr (member "-d" (nth 5 dict)))))
1012 ;; Include if the dictionary is in the library, or dir not defined.
1015 ;; include all dictionaries if lib directory not known.
1016 ;; For Aspell, we already know which dictionaries exist.
1017 (or ispell-really-aspell
1018 (not ispell-library-directory)
1019 (file-exists-p (concat ispell-library-directory
1021 (file-exists-p (concat ispell-library-directory "/" name ".has"))
1023 (or (file-exists-p (concat ispell-library-directory
1024 "/" load-dict ".hash"))
1025 (file-exists-p (concat ispell-library-directory
1026 "/" load-dict ".has"))))))
1027 (setq dict-list (cons name dict-list))))
1030 ;;; define commands in menu in opposite order you want them to appear.
1032 (if ispell-menu-map-needed
1034 (setq ispell-menu-map (make-sparse-keymap "Spell"))
1035 (define-key ispell-menu-map [ispell-change-dictionary]
1036 '(menu-item "Change Dictionary..." ispell-change-dictionary
1037 :help "Supply explicit dictionary file name"))
1038 (define-key ispell-menu-map [ispell-kill-ispell]
1039 '(menu-item "Kill Process" ispell-kill-ispell
1040 :enable (and (boundp 'ispell-process) ispell-process
1041 (eq (ispell-process-status) 'run))
1042 :help "Terminate Ispell subprocess"))
1043 (define-key ispell-menu-map [ispell-pdict-save]
1044 '(menu-item "Save Dictionary"
1045 (lambda () (interactive) (ispell-pdict-save t t))
1046 :help "Save personal dictionary"))
1047 (define-key ispell-menu-map [ispell-customize]
1048 '(menu-item "Customize..."
1049 (lambda () (interactive) (customize-group 'ispell))
1050 :help "Customize spell checking options"))
1051 (define-key ispell-menu-map [ispell-help]
1052 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1054 (lambda () (interactive) (describe-function 'ispell-help))
1055 :help "Show standard Ispell keybindings and commands"))
1056 (define-key ispell-menu-map [flyspell-mode]
1057 '(menu-item "Automatic spell checking (Flyspell)"
1059 :help "Check spelling while you edit the text"
1060 :button (:toggle . (bound-and-true-p flyspell-mode))))
1061 (define-key ispell-menu-map [ispell-complete-word]
1062 '(menu-item "Complete Word" ispell-complete-word
1063 :help "Complete word at cursor using dictionary"))
1064 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
1065 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
1066 :help "Complete word fragment at cursor"))))
1069 (if ispell-menu-map-needed
1071 (define-key ispell-menu-map [ispell-continue]
1072 '(menu-item "Continue Spell-Checking" ispell-continue
1073 :enable (and (boundp 'ispell-region-end)
1074 (marker-position ispell-region-end)
1075 (equal (marker-buffer ispell-region-end)
1077 :help "Continue spell checking last region"))
1078 (define-key ispell-menu-map [ispell-word]
1079 '(menu-item "Spell-Check Word" ispell-word
1080 :help "Spell-check word at cursor"))
1081 (define-key ispell-menu-map [ispell-comments-and-strings]
1082 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
1083 :help "Spell-check only comments and strings"))))
1086 (if ispell-menu-map-needed
1088 (define-key ispell-menu-map [ispell-region]
1089 '(menu-item "Spell-Check Region" ispell-region
1091 :help "Spell-check text in marked region"))
1092 (define-key ispell-menu-map [ispell-message]
1093 '(menu-item "Spell-Check Message" ispell-message
1094 :visible (eq major-mode 'mail-mode)
1095 :help "Skip headers and included message text"))
1096 (define-key ispell-menu-map [ispell-buffer]
1097 '(menu-item "Spell-Check Buffer" ispell-buffer
1098 :help "Check spelling of selected buffer"))
1099 ;;(put 'ispell-region 'menu-enable 'mark-active)
1100 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
1102 ;;; XEmacs versions 19 & 20
1103 (if (and (featurep 'xemacs)
1105 ;;(null ispell-menu-xemacs)
1106 (not (and (boundp 'infodock-version) infodock-version)))
1107 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list)
1108 (reverse (ispell-valid-dictionary-list))))
1109 (current-menubar (or current-menubar default-menubar))
1111 '(["Help" (describe-function 'ispell-help) t]
1112 ;;["Help" (popup-menu ispell-help-list) t]
1113 ["Check Message" ispell-message t]
1114 ["Check Buffer" ispell-buffer t]
1115 ["Check Comments" ispell-comments-and-strings t]
1116 ["Check Word" ispell-word t]
1117 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
1118 ["Continue Check" ispell-continue t]
1119 ["Complete Word Frag"ispell-complete-word-interior-frag t]
1120 ["Complete Word" ispell-complete-word t]
1121 ["Kill Process" ispell-kill-ispell t]
1122 ["Customize..." (customize-group 'ispell) t]
1123 ;; flyspell-mode may not be bound...
1124 ;;["flyspell" flyspell-mode
1125 ;; :style toggle :selected flyspell-mode ]
1127 ["Save Personal Dict"(ispell-pdict-save t t) t]
1128 ["Change Dictionary" ispell-change-dictionary t])))
1130 (setq dicts (cons "default" nil)))
1131 (dolist (name dicts)
1132 (setq menu (append menu
1135 (concat "Select " (capitalize name))
1136 (list 'ispell-change-dictionary name)
1138 (setq ispell-menu-xemacs menu)
1141 (if (car (find-menu-item current-menubar '("Cmds")))
1144 (delete-menu-item '("Cmds" "Spell-Check"))
1145 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs))
1147 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1148 (add-menu '("Edit") "Spell" ispell-menu-xemacs))))))
1150 ;;; Allow incrementing characters as integers in XEmacs 20
1151 (if (and (featurep 'xemacs)
1152 (fboundp 'int-char))
1153 (fset 'ispell-int-char 'int-char)
1154 ;; Emacs and XEmacs 19 or earlier
1155 (fset 'ispell-int-char 'identity))
1158 ;;; **********************************************************************
1161 ;;; This variable contains the current dictionary being used if the ispell
1162 ;;; process is running.
1163 (defvar ispell-current-dictionary nil
1164 "The name of the current dictionary, or nil for the default.
1165 This is passed to the ispell process using the `-d' switch and is
1166 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1168 (defvar ispell-current-personal-dictionary nil
1169 "The name of the current personal dictionary, or nil for the default.
1170 This is passed to the ispell process using the `-p' switch.")
1172 (defvar ispell-dictionary nil
1173 "Default dictionary to use if `ispell-local-dictionary' is nil.")
1175 (defun ispell-decode-string (str)
1176 "Decodes multibyte character strings.
1177 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1178 (if (and (or (featurep 'xemacs)
1179 (and (boundp 'enable-multibyte-characters)
1180 enable-multibyte-characters))
1181 (fboundp 'decode-coding-string)
1182 (ispell-get-coding-system))
1183 (decode-coding-string str (ispell-get-coding-system))
1186 (put 'ispell-unified-chars-table 'char-table-extra-slots 0)
1188 ;; Char-table that maps an Unicode character (charset:
1189 ;; latin-iso8859-1, mule-unicode-0100-24ff, mule-unicode-2500-34ff) to
1190 ;; a string in which all equivalent characters are listed.
1192 (defconst ispell-unified-chars-table
1193 (let ((table (make-char-table 'ispell-unified-chars-table)))
1196 (if (and v (/= c v))
1197 (let ((unified (or (aref table v) (string v))))
1198 (aset table v (concat unified (string c))))))
1199 ucs-mule-8859-to-mule-unicode)
1202 ;; Return a string decoded from Nth element of the current dictionary
1203 ;; while splicing equivalent characters into the string. This splicing
1204 ;; is done only if the string is a regular expression of the form
1205 ;; "[...]" because, otherwise, splicing will result in incorrect
1206 ;; regular expression matching.
1208 (defun ispell-get-decoded-string (n)
1210 (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1211 (assoc ispell-current-dictionary ispell-dictionary-alist)))
1213 (when (and (> (length str) 0)
1214 (not (multibyte-string-p str)))
1215 (setq str (ispell-decode-string str))
1216 (if (and (= (aref str 0) ?\[)
1217 (eq (string-match "\\]" str) (1- (length str))))
1219 (string-as-multibyte
1222 (let ((unichar (aref ucs-mule-8859-to-mule-unicode c)))
1224 (aref ispell-unified-chars-table unichar)
1227 (setcar (nthcdr n slot) str))
1230 (defun ispell-get-casechars ()
1231 (ispell-get-decoded-string 1))
1232 (defun ispell-get-not-casechars ()
1233 (ispell-get-decoded-string 2))
1234 (defun ispell-get-otherchars ()
1235 (ispell-get-decoded-string 3))
1236 (defun ispell-get-many-otherchars-p ()
1237 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1238 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1239 (defun ispell-get-ispell-args ()
1240 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1241 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1242 (defun ispell-get-extended-character-mode ()
1243 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1244 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1245 (defun ispell-get-coding-system ()
1246 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1247 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1250 (defvar ispell-pdict-modified-p nil
1251 "Non-nil means personal dictionary has modifications to be saved.")
1253 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1254 ;;; When non-nil, the spell session is terminated.
1255 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1256 (defvar ispell-quit nil)
1258 (defvar ispell-process-directory nil
1259 "The directory where `ispell-process' was started.")
1261 (defvar ispell-filter nil
1262 "Output filter from piped calls to Ispell.")
1264 (defvar ispell-filter-continue nil
1265 "Control variable for Ispell filter function.")
1267 (defvar ispell-output-buffer nil
1268 "Buffer used for reading output of a synchronous Ispell subprocess.")
1270 (defvar ispell-session-buffer nil
1271 "Buffer used for passing input to a synchronous Ispell subprocess.")
1273 (defvar ispell-cmd-args nil
1274 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1276 (defvar ispell-query-replace-marker (make-marker)
1277 "Marker for `query-replace' processing.")
1279 (defvar ispell-recursive-edit-marker (make-marker)
1280 "Marker for return point from recursive edit.")
1282 (defvar ispell-checking-message nil
1283 "Non-nil when we're checking a mail message.
1284 Set to the MIME boundary locations when checking messages.")
1286 (defconst ispell-choices-buffer "*Choices*")
1288 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1290 ;;; *** Buffer Local Definitions ***
1292 (defconst ispell-words-keyword "LocalWords: "
1293 "The keyword for local oddly-spelled words to accept.
1294 The keyword will be followed by any number of local word spellings.
1295 There can be multiple of these keywords in the file.")
1297 (defconst ispell-dictionary-keyword "Local IspellDict: "
1298 "The keyword for a local dictionary to use.
1299 The keyword must be followed by a valid dictionary name, defined in
1300 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1301 When multiple occurrences exist, the last keyword
1302 definition is used.")
1304 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1305 "The keyword for defining buffer local dictionaries.
1306 Keyword must be followed by the filename of a personal dictionary.
1307 The last occurring definition in the buffer will be used.")
1309 (defconst ispell-parsing-keyword "Local IspellParsing: "
1310 "The keyword for overriding default Ispell parsing.
1311 The above keyword string should be followed by `latex-mode' or
1312 `nroff-mode' to put the current buffer into the desired parsing mode.
1314 Extended character mode can be changed for this buffer by placing
1315 a `~' followed by an extended-character mode -- such as `~.tex'.
1316 The last occurring definition in the buffer will be used.")
1319 (defvar ispell-skip-region-alist
1320 '((ispell-words-keyword forward-line)
1321 (ispell-dictionary-keyword forward-line)
1322 (ispell-pdict-keyword forward-line)
1323 (ispell-parsing-keyword forward-line)
1324 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1325 ;; assume multiline uuencoded file? "\nM.*$"?
1326 ("^begin [0-9][0-9][0-9] [^ \t]+$" . "\nend\n")
1327 ("^%!PS-Adobe-[123].0" . "\n%%EOF\n")
1328 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage"
1329 . "^---* End of [Ff]orwarded [Mm]essage")
1330 ;; Matches e-mail addresses, file names, http addresses, etc. The
1331 ;; `-+' `_+' patterns are necessary for performance reasons when
1332 ;; `-' or `_' part of word syntax.
1333 ("\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1334 ;; above checks /.\w sequences
1335 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1336 ;; This is a pretty complex regexp. It can be simplified to the following:
1337 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1338 ;; but some valid text will be skipped, e.g. "his/her". This could be
1339 ;; fixed up (at the expense of a moderately more complex regexp)
1340 ;; by not allowing "/" to be the character which triggers the
1341 ;; identification of the computer name, e.g.:
1342 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1344 "Alist expressing beginning and end of regions not to spell check.
1345 The alist key must be a regular expression.
1346 Valid forms include:
1347 (KEY) - just skip the key.
1348 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1349 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1350 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1351 (put 'ispell-skip-region-alist 'risky-local-variable t)
1355 (defvar ispell-tex-skip-alists
1356 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1357 ;; All the standard LaTeX keywords from L. Lamport's guide:
1358 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1359 ;; \label, \nocite, \rule (in ispell - rest included here)
1360 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1361 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1362 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1363 ;;("\\\\author" ispell-tex-arg-end)
1364 ("\\\\bibliographystyle" ispell-tex-arg-end)
1365 ("\\\\makebox" ispell-tex-arg-end 0)
1366 ("\\\\e?psfig" ispell-tex-arg-end)
1367 ("\\\\document\\(class\\|style\\)" .
1368 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1369 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1370 ;; equation, minipage, picture, tabular, tabular* (ispell)
1371 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1372 ("list" ispell-tex-arg-end 2)
1373 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1374 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1375 "*Lists of regions to be skipped in TeX mode.
1376 First list is used raw.
1377 Second list has key placed inside \\begin{}.
1379 Delete or add any regions you want to be automatically selected
1380 for skipping in latex mode.")
1381 (put 'ispell-tex-skip-alist 'risky-local-variable t)
1385 (defvar ispell-html-skip-alists
1386 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1387 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1388 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1389 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1390 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1393 ("&[^ \t\n;]" "[; \t\n]"))
1394 "*Lists of start and end keys to skip in HTML buffers.
1395 Same format as `ispell-skip-region-alist'
1396 Note - substrings of other matches must come last
1397 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1398 (put 'ispell-html-skip-alists 'risky-local-variable t)
1400 (defvar ispell-local-pdict ispell-personal-dictionary
1401 "A buffer local variable containing the current personal dictionary.
1402 If non-nil, the value must be a string, which is a file name.
1404 If you specify a personal dictionary for the current buffer which is
1405 different from the current personal dictionary, the effect is similar
1406 to calling \\[ispell-change-dictionary]. This variable is automatically
1407 set when defined in the file with either `ispell-pdict-keyword' or the
1408 local variable syntax.")
1410 (make-variable-buffer-local 'ispell-local-pdict)
1412 (defvar ispell-buffer-local-name nil
1413 "Contains the buffer name if local word definitions were used.
1414 Ispell is then restarted because the local words could conflict.")
1416 (defvar ispell-parser 'use-mode-name
1417 "*Indicates whether ispell should parse the current buffer as TeX Code.
1418 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1419 Default parser is `nroff'.
1420 Currently the only other valid parser is `tex'.
1422 You can set this variable in hooks in your init file -- eg:
1424 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1426 (defvar ispell-region-end (make-marker)
1427 "Marker that allows spelling continuations.")
1429 (defvar ispell-check-only nil
1430 "If non-nil, `ispell-word' does not try to correct the word.")
1433 ;;; **********************************************************************
1434 ;;; **********************************************************************
1438 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1441 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1442 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1443 If asynchronous subprocesses are not supported, call `ispell-filter' and
1444 pass it the output of the last ispell invocation."
1445 (if ispell-async-processp
1446 (accept-process-output ispell-process timeout-secs timeout-msecs)
1447 (if (null ispell-process)
1448 (error "No Ispell process to read output from!")
1449 (let ((buf ispell-output-buffer)
1451 (if (not (bufferp buf))
1452 (setq ispell-filter nil)
1455 (setq ispell-output (buffer-substring-no-properties
1456 (point-min) (point-max))))
1457 (ispell-filter t ispell-output)
1460 (erase-buffer)))))))
1462 (defun ispell-send-replacement (misspelled replacement)
1463 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1464 This allows it to improve the suggestion list based on actual mispellings."
1465 (and ispell-really-aspell
1466 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1469 (defun ispell-send-string (string)
1470 "Send the string STRING to the Ispell process."
1471 (if ispell-async-processp
1472 (process-send-string ispell-process string)
1473 ;; Asynchronous subprocesses aren't supported on this losing system.
1474 ;; We keep all the directives passed to Ispell during the entire
1475 ;; session in a buffer, and pass them anew each time we invoke
1476 ;; Ispell to process another chunk of text. (Yes, I know this is a
1477 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1478 (let ((cmd (aref string 0))
1479 ;; The following commands are not passed to Ispell until
1480 ;; we have a *real* reason to invoke it.
1481 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1482 (default-major-mode 'fundamental-mode)
1483 (session-buf ispell-session-buffer)
1484 (output-buf ispell-output-buffer)
1485 (ispell-args ispell-cmd-args)
1486 (defdir ispell-process-directory)
1489 (set-buffer session-buf)
1490 (setq prev-pos (point))
1491 (setq default-directory defdir)
1493 (if (not (memq cmd cmds-to-defer))
1494 (let (coding-system-for-read coding-system-for-write status)
1495 (if (and (boundp 'enable-multibyte-characters)
1496 enable-multibyte-characters)
1497 (setq coding-system-for-read (ispell-get-coding-system)
1498 coding-system-for-write (ispell-get-coding-system)))
1499 (set-buffer output-buf)
1501 (set-buffer session-buf)
1503 (apply 'call-process-region (point-min) (point-max)
1504 ispell-program-name nil
1506 "-a" "-m" ispell-args))
1507 (set-buffer output-buf)
1508 (goto-char (point-min))
1510 (if (not (looking-at "@(#) "))
1511 (error "Ispell error: %s"
1512 (buffer-substring-no-properties
1513 (point) (progn (end-of-line) (point)))))
1514 ;; If STRING is "^Z\n", we just started Ispell and need
1515 ;; to retain its version ID line in the output buffer.
1516 ;; Otherwise, remove the ID line, as it will confuse
1518 (or (string= string "\032\n")
1521 (delete-region (point-min) (point))))
1522 ;; If STRING begins with ^ or any normal character, we need
1523 ;; to remove the last line from the session buffer, since it
1524 ;; was just spell-checked, and we don't want to check it again.
1525 ;; The same goes for the # command, since Ispell already saved
1526 ;; the personal dictionary.
1527 (set-buffer session-buf)
1528 (delete-region prev-pos (point))
1529 ;; Ispell run synchronously saves the personal dictionary
1530 ;; after each successful command. So we can remove any
1531 ;; lines in the session buffer that insert words into the
1533 (if (memq status '(0 nil))
1534 (let ((more-lines t))
1535 (goto-char (point-min))
1537 (if (looking-at "^\\*")
1538 (let ((start (point)))
1540 (delete-region start (point)))
1541 (setq more-lines (= 0 (forward-line))))))))))))))
1544 ;; Insert WORD while translating Latin characters to the equivalent
1545 ;; characters that is supported by buffer-file-coding-system.
1547 (defun ispell-insert-word (word)
1548 (let ((pos (point)))
1550 (if (char-table-p translation-table-for-input)
1551 (translate-region pos (point) translation-table-for-input))))
1554 (defun ispell-word (&optional following quietly continue)
1555 "Check spelling of word under or before the cursor.
1556 If the word is not found in dictionary, display possible corrections
1557 in a window allowing you to choose one.
1559 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1560 is non-nil when called interactively, then the following word
1561 \(rather than preceding\) is checked when the cursor is not over a word.
1562 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1563 when called interactively, non-corrective messages are suppressed.
1565 With a prefix argument (or if CONTINUE is non-nil),
1566 resume interrupted spell-checking of a buffer or region.
1568 Word syntax is controlled by the definition of the chosen dictionary,
1569 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1571 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1572 or \\[ispell-region] to update the Ispell process.
1575 nil word is correct or spelling is accepted.
1576 0 word is inserted into buffer-local definitions.
1577 \"word\" word corrected from word list.
1578 \(\"word\" arg\) word is hand entered.
1579 quit spell session exited."
1581 (interactive (list ispell-following-word ispell-quietly current-prefix-arg))
1584 (ispell-maybe-find-aspell-dictionaries)
1585 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1586 (let ((cursor-location (point)) ; retain cursor location
1587 (word (ispell-get-word following))
1588 start end poss new-word replace)
1589 ;; De-structure return word info list.
1590 (setq start (car (cdr word))
1591 end (car (cdr (cdr word)))
1594 ;; At this point it used to ignore 2-letter words.
1595 ;; But that is silly; if the user asks for it, we should do it. - rms.
1597 (message "Checking spelling of %s..."
1598 (funcall ispell-format-word word)))
1599 (ispell-send-string "%\n") ; put in verbose mode
1600 (ispell-send-string (concat "^" word "\n"))
1601 ;; wait until ispell has processed word
1603 (ispell-accept-output)
1604 (not (string= "" (car ispell-filter)))))
1605 ;;(ispell-send-string "!\n") ;back to terse mode.
1606 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1607 (if (and ispell-filter (listp ispell-filter))
1608 (if (> (length ispell-filter) 1)
1609 (error "Ispell and its process have different character maps")
1610 (setq poss (ispell-parse-output (car ispell-filter)))))
1613 (message "%s is correct"
1614 (funcall ispell-format-word word)))
1615 (and (fboundp 'extent-at)
1617 (and (fboundp 'delete-extent)
1618 (delete-extent (extent-at start)))))
1621 (message "%s is correct because of root %s"
1622 (funcall ispell-format-word word)
1623 (funcall ispell-format-word poss)))
1624 (and (fboundp 'extent-at)
1626 (and (fboundp 'delete-extent)
1627 (delete-extent (extent-at start)))))
1628 ((null poss) (message "Error in ispell process"))
1629 (ispell-check-only ; called from ispell minor mode.
1630 (if (fboundp 'make-extent)
1631 (if (fboundp 'set-extent-property)
1632 (let ((ext (make-extent start end)))
1633 (set-extent-property ext 'face ispell-highlight-face)
1634 (set-extent-property ext 'priority 2000)))
1636 (message "%s is incorrect"(funcall ispell-format-word word))))
1637 (t ; prompt for correct word.
1638 (save-window-excursion
1639 (setq replace (ispell-command-loop
1640 (car (cdr (cdr poss)))
1641 (car (cdr (cdr (cdr poss))))
1642 (car poss) start end)))
1643 (cond ((equal 0 replace)
1644 (ispell-add-per-file-word-list (car poss)))
1646 (setq new-word (if (atom replace) replace (car replace))
1647 cursor-location (+ (- (length word) (- end start))
1649 (if (not (equal new-word (car poss)))
1651 (delete-region start end)
1652 (setq start (point))
1653 (ispell-insert-word new-word)
1654 (setq end (point))))
1655 (if (not (atom replace)) ;recheck spelling of replacement
1657 (if (car (cdr replace)) ; query replace requested
1658 (save-window-excursion
1659 (query-replace word new-word t)))
1661 ;; single word could be split into multiple words
1662 (setq ispell-quit (not (ispell-region start end)))
1664 ;; keep if rechecking word and we keep choices win.
1665 (if (get-buffer ispell-choices-buffer)
1666 (kill-buffer ispell-choices-buffer))))
1667 (ispell-pdict-save ispell-silently-savep)
1668 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1669 (if ispell-quit (setq ispell-quit nil replace 'quit))
1670 (goto-char cursor-location) ; return to original location
1674 (defun ispell-get-word (following &optional extra-otherchars)
1675 "Return the word for spell-checking according to ispell syntax.
1676 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1677 is non-nil when called interactively, then the following word
1678 \(rather than preceding\) is checked when the cursor is not over a word.
1679 Optional second argument contains otherchars that can be included in word
1682 Word syntax is controlled by the definition of the chosen dictionary,
1683 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1684 (let* ((ispell-casechars (ispell-get-casechars))
1685 (ispell-not-casechars (ispell-get-not-casechars))
1686 (ispell-otherchars (ispell-get-otherchars))
1687 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1688 (word-regexp (concat ispell-casechars
1690 (if (not (string= "" ispell-otherchars))
1691 (concat ispell-otherchars "?"))
1692 (if extra-otherchars
1693 (concat extra-otherchars "?"))
1696 (if (or ispell-many-otherchars-p
1702 (if (not (looking-at ispell-casechars))
1704 (re-search-forward ispell-casechars (point-max) t)
1705 (re-search-backward ispell-casechars (point-min) t)))
1706 ;; move to front of word
1707 (re-search-backward ispell-not-casechars (point-min) 'start)
1708 (while (and (or (and (not (string= "" ispell-otherchars))
1709 (looking-at ispell-otherchars))
1710 (and extra-otherchars (looking-at extra-otherchars)))
1712 (or (not did-it-once)
1713 ispell-many-otherchars-p)
1714 (not (eq prevpt (point))))
1715 (if (and extra-otherchars (looking-at extra-otherchars))
1718 (if (looking-at ispell-casechars)
1719 (re-search-backward ispell-not-casechars (point-min) 'move)))
1723 (if (looking-at ispell-casechars)
1724 (re-search-backward ispell-not-casechars (point-min) 'move)
1725 (backward-char -1))))
1726 ;; Now mark the word and save to string.
1727 (if (not (re-search-forward word-regexp (point-max) t))
1728 (if ispell-check-only
1729 ;; return dummy word when just flagging misspellings
1730 (list "" (point) (point))
1731 (error "No word found to check!"))
1732 (setq start (match-beginning 0)
1734 word (buffer-substring-no-properties start end))
1735 (list word start end))))
1738 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1739 ;;; tracks changes in the dictionary. The global may either be
1740 ;;; a value or a list, whose value is the state of whether the
1741 ;;; dictionary needs to be saved.
1744 (defun ispell-pdict-save (&optional no-query force-save)
1745 "Check to see if the personal dictionary has been modified.
1746 If so, ask if it needs to be saved."
1747 (interactive (list ispell-silently-savep t))
1748 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1749 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1750 (if (or ispell-pdict-modified-p force-save)
1751 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1753 (ispell-send-string "#\n") ; save dictionary
1754 (message "Personal dictionary saved."))))
1755 ;; unassert variable, even if not saved to avoid questioning.
1756 (setq ispell-pdict-modified-p nil))
1759 (defun ispell-command-loop (miss guess word start end)
1760 "Display possible corrections from list MISS.
1761 GUESS lists possibly valid affix construction of WORD.
1762 Returns nil to keep word.
1763 Returns 0 to insert locally into buffer-local dictionary.
1764 Returns string for new chosen word.
1765 Returns list for new replacement word (will be rechecked).
1766 Query-replace when list length is 2.
1767 Automatic query-replace when second element is `query-replace'.
1768 Highlights the word, which is assumed to run from START to END.
1769 Global `ispell-pdict-modified-p' becomes a list where the only value
1770 indicates whether the dictionary has been modified when option `a' or `i' is
1772 Global `ispell-quit' set to start location to continue spell session."
1774 (line ispell-choices-win-default-height)
1775 ;; ensure 4 context lines.
1776 (max-lines (- (ispell-adjusted-window-height) 4))
1778 (window-min-height (min window-min-height
1779 ispell-choices-win-default-height))
1780 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1781 (dedicated (window-dedicated-p (selected-window)))
1783 char num result textwin dedicated-win)
1785 ;; setup the *Choices* buffer with valid data.
1787 (set-buffer (get-buffer-create ispell-choices-buffer))
1788 (setq mode-line-format
1789 (concat "-- %b -- word: " word
1790 " -- dict: " (or ispell-current-dictionary "default")
1791 " -- prog: " (file-name-nondirectory ispell-program-name)))
1792 ;; XEmacs: no need for horizontal scrollbar in choices window
1794 (and (fboundp 'set-specifier)
1795 (boundp 'horizontal-scrollbar-visible-p)
1796 (set-specifier horizontal-scrollbar-visible-p nil
1797 (cons (current-buffer) nil))))
1801 (insert "Affix rules generate and capitalize "
1802 "this word as shown below:\n\t")
1804 (if (> (+ 4 (current-column) (length (car guess)))
1808 (setq line (1+ line))))
1809 (insert (car guess) " ")
1810 (setq guess (cdr guess)))
1811 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.")
1812 (setq line (+ line (if choices 3 2)))))
1814 (< (if (> (+ 7 (current-column) (length (car choices))
1815 (if (> count ?~) 3 0))
1819 (setq line (1+ line)))
1822 ;; not so good if there are over 20 or 30 options, but then, if
1823 ;; there are that many you don't want to scan them all anyway...
1824 (while (memq count command-characters) ; skip command characters.
1825 (setq count (ispell-int-char (1+ count))
1826 skipped (1+ skipped)))
1827 (insert "(" count ") " (car choices) " ")
1828 (setq choices (cdr choices)
1829 count (ispell-int-char (1+ count))))
1830 (setq count (ispell-int-char (- count ?0 skipped))))
1832 ;; ensure word is visible
1833 (if (not (pos-visible-in-window-p end))
1836 ;; allow temporary split of dedicated windows...
1839 (setq dedicated-win (selected-window))
1840 (set-window-dedicated-p dedicated-win nil)))
1842 ;; Display choices for misspelled word.
1843 (ispell-show-choices line end)
1844 (select-window (setq textwin (next-window)))
1846 ;; highlight word, protecting current buffer status
1849 (and ispell-highlight-p
1850 (ispell-highlight-spelling-error start end t))
1851 ;; Loop until a valid choice is made.
1859 (let (message-log-max)
1860 (message (concat "C-h or ? for more options; SPC to leave "
1861 "unchanged, Character to replace word")))
1862 (let ((inhibit-quit t))
1863 (setq char (if (fboundp 'read-char-exclusive)
1864 (read-char-exclusive)
1867 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1870 ;; Adjust num to array offset skipping command characters.
1871 (let ((com-chars command-characters))
1873 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1874 (setq skipped (1+ skipped)))
1875 (setq com-chars (cdr com-chars)))
1876 (setq num (- char ?0 skipped)))
1879 ((= char ? ) nil) ; accept word this time only
1880 ((= char ?i) ; accept and insert word into pers dict
1881 (ispell-send-string (concat "*" word "\n"))
1882 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1884 ((or (= char ?a) (= char ?A)) ; accept word without insert
1885 (ispell-send-string (concat "@" word "\n"))
1886 (if (null ispell-pdict-modified-p)
1887 (setq ispell-pdict-modified-p
1888 (list ispell-pdict-modified-p)))
1889 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1890 ((or (= char ?r) (= char ?R)) ; type in replacement
1891 (and (eq 'block ispell-highlight-p) ; refresh tty's
1892 (ispell-highlight-spelling-error start end nil t))
1894 (if (or (= char ?R) ispell-query-replace-choices)
1896 (format "Query-replacement for %s: "word)
1899 (cons (read-string "Replacement for: " word)
1901 (and (eq 'block ispell-highlight-p)
1902 (ispell-highlight-spelling-error start end nil
1905 ((or (= char ??) (= char help-char) (= char ?\C-h))
1906 (and (eq 'block ispell-highlight-p)
1907 (ispell-highlight-spelling-error start end nil t))
1909 (and (eq 'block ispell-highlight-p)
1910 (ispell-highlight-spelling-error start end nil
1913 ;; Quit and move point back.
1915 (ispell-pdict-save ispell-silently-savep)
1916 (message "Exited spell-checking")
1917 (setq ispell-quit t)
1919 ;; Quit and preserve point.
1921 (ispell-pdict-save ispell-silently-savep)
1923 (substitute-command-keys
1924 (concat "Spell-checking suspended;"
1925 " use C-u \\[ispell-word] to resume")))
1926 (setq ispell-quit start)
1929 (if (y-or-n-p "Really kill Ispell process? ")
1931 (ispell-kill-ispell t) ; terminate process.
1932 (setq ispell-quit (or (not ispell-checking-message)
1934 ispell-pdict-modified-p nil))
1935 t)) ; continue if they don't quit.
1937 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1938 (ispell-highlight-spelling-error start end nil t))
1939 (let ((new-word (read-string
1940 "Lookup string (`*' is wildcard): "
1945 (set-buffer (get-buffer-create
1946 ispell-choices-buffer))
1951 (concat "-- %b -- word: " new-word
1953 ispell-alternate-dictionary)
1954 miss (lookup-words new-word)
1956 line ispell-choices-win-default-height)
1957 (while (and choices ; adjust choices window.
1958 (< (if (> (+ 7 (current-column)
1959 (length (car choices))
1960 (if (> count ?~) 3 0))
1964 (setq line (1+ line)))
1967 (while (memq count command-characters)
1968 (setq count (ispell-int-char (1+ count))
1969 skipped (1+ skipped)))
1970 (insert "(" count ") " (car choices) " ")
1971 (setq choices (cdr choices)
1972 count (ispell-int-char (1+ count))))
1973 (setq count (ispell-int-char
1974 (- count ?0 skipped))))
1975 (ispell-show-choices line end)
1976 (select-window (next-window)))))
1977 (and (eq 'block ispell-highlight-p)
1978 (ispell-highlight-spelling-error start end nil
1980 t) ; reselect from new choices
1981 ((= char ?u) ; insert lowercase into dictionary
1982 (ispell-send-string (concat "*" (downcase word) "\n"))
1983 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1985 ((= char ?m) ; type in what to insert
1987 (concat "*" (read-string "Insert: " word) "\n"))
1988 (setq ispell-pdict-modified-p '(t))
1990 ((and (>= num 0) (< num count))
1991 (if ispell-query-replace-choices ; Query replace flag
1992 (list (nth num miss) 'query-replace)
1997 ;; This may have alignment errors if current line is edited
1998 (if (marker-position ispell-recursive-edit-marker)
2000 (message "Only one recursive edit session supported")
2003 (set-marker ispell-recursive-edit-marker start)
2004 ;;(set-marker ispell-region-end reg-end)
2005 (and ispell-highlight-p ; unhighlight
2006 (ispell-highlight-spelling-error start end))
2011 (substitute-command-keys
2012 (concat "Exit recursive edit with"
2013 " \\[exit-recursive-edit]")))
2014 (save-window-excursion (save-excursion
2017 (goto-char ispell-recursive-edit-marker)
2018 (if (not (equal (marker-buffer
2019 ispell-recursive-edit-marker)
2022 (set-marker ispell-recursive-edit-marker nil)
2024 "Cannot continue ispell from this buffer.")))
2025 (set-marker ispell-recursive-edit-marker nil)))
2026 (list word nil)) ; recheck starting at this word.
2028 (funcall (key-binding "\C-z"))
2033 (and ispell-highlight-p ; unhighlight
2034 (save-window-excursion
2035 (select-window textwin)
2036 (ispell-highlight-spelling-error start end)))
2038 (set-window-dedicated-p dedicated-win t)))))
2042 (defun ispell-show-choices (line end)
2043 "Shows the choices in another buffer or frame."
2044 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
2046 (framepop-display-buffer (get-buffer ispell-choices-buffer))
2047 ;;; (get-buffer-window ispell-choices-buffer t)
2048 (select-window (previous-window))) ; *Choices* window
2049 ;; standard selection by splitting a small buffer out of this window.
2050 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
2052 (if (= line (ispell-adjusted-window-height choices-window))
2053 (select-window choices-window)
2054 ;; *Choices* window changed size. Adjust the choices window
2055 ;; without scrolling the spelled window when possible
2057 (- line (ispell-adjusted-window-height choices-window)))
2058 (visible (progn (vertical-motion -1) (point))))
2059 (if (< line ispell-choices-win-default-height)
2060 (setq window-line (+ window-line
2061 (- ispell-choices-win-default-height
2063 (move-to-window-line 0)
2064 (vertical-motion window-line)
2065 (set-window-start (selected-window)
2066 (if (> (point) visible) visible (point)))
2068 (select-window choices-window)
2069 (enlarge-window window-line)))
2070 ;; Overlay *Choices* window when it isn't showing
2071 (ispell-overlay-window (max line ispell-choices-win-default-height)))
2072 (switch-to-buffer ispell-choices-buffer)
2073 (goto-char (point-min)))))
2077 (defun ispell-help ()
2078 "Display a list of the options available when a misspelling is encountered.
2082 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2083 SPC: Accept word this time.
2084 `i': Accept word and insert into private dictionary.
2085 `a': Accept word for this session.
2086 `A': Accept word and place in `buffer-local dictionary'.
2087 `r': Replace word with typed-in value. Rechecked.
2088 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2089 `?': Show these commands.
2090 `x': Exit spelling buffer. Move cursor to original point.
2091 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2092 the aborted check to be completed later.
2093 `q': Quit spelling session (Kills ispell process).
2094 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2095 `u': Like `i', but the word is lower-cased first.
2096 `m': Place typed-in value in personal dictionary, then recheck current word.
2097 `C-l': redraws screen
2098 `C-r': recursive edit
2099 `C-z': suspend emacs or iconify frame"
2101 (if (equal ispell-help-in-bufferp 'electric)
2105 (function (lambda ()
2106 ;;This shouldn't be necessary: with-electric-help needs
2107 ;; an optional argument telling it about the smallest
2108 ;; acceptable window-height of the help buffer.
2109 ;;(if (< (window-height) 15)
2111 ;; (- 15 (ispell-adjusted-window-height))))
2112 (princ "Selections are:
2114 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2115 SPC: Accept word this time.
2116 `i': Accept word and insert into private dictionary.
2117 `a': Accept word for this session.
2118 `A': Accept word and place in `buffer-local dictionary'.
2119 `r': Replace word with typed-in value. Rechecked.
2120 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2121 `?': Show these commands.
2122 `x': Exit spelling buffer. Move cursor to original point.
2123 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2124 the aborted check to be completed later.
2125 `q': Quit spelling session (Kills ispell process).
2126 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2127 `u': Like `i', but the word is lower-cased first.
2128 `m': Place typed-in value in personal dictionary, then recheck current word.
2129 `C-l': redraws screen
2130 `C-r': recursive edit
2131 `C-z': suspend emacs or iconify frame")
2132 nil ;undocumented requirement of with-electric-help
2136 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2137 "[i]nsert into private dictionary"))
2138 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2139 "e[x/X]it; [q]uit session"))
2140 (help-3 (concat "[u]ncapitalized insert into dict. "
2141 "Type 'x C-h f ispell-help' for more help")))
2142 (save-window-excursion
2143 (if ispell-help-in-bufferp
2145 (ispell-overlay-window 4)
2146 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2147 (insert (concat help-1 "\n" help-2 "\n" help-3))
2149 (kill-buffer "*Ispell Help*"))
2151 (let ((resize-mini-windows 'grow-only))
2152 (select-window (minibuffer-window))
2155 ;;(set-minibuffer-window (selected-window))
2157 (insert (concat help-1 "\n" help-2 "\n" help-3))
2159 (erase-buffer)))))))
2162 (defun lookup-words (word &optional lookup-dict)
2163 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2164 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2165 Otherwise the variable `ispell-grep-command' contains the command used to
2166 search for the words (usually egrep).
2168 Optional second argument contains the dictionary to use; the default is
2169 `ispell-alternate-dictionary'."
2170 ;; We don't use the filter for this function, rather the result is written
2171 ;; into a buffer. Hence there is no need to save the filter values.
2172 (if (null lookup-dict)
2173 (setq lookup-dict ispell-alternate-dictionary))
2175 (let* ((process-connection-type ispell-use-ptys-p)
2176 (wild-p (string-match "\\*" word))
2177 (look-p (and ispell-look-p ; Only use look for an exact match.
2178 (or ispell-have-new-look (not wild-p))))
2179 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2180 (prog (if look-p ispell-look-command ispell-grep-command))
2181 (args (if look-p ispell-look-options ispell-grep-options))
2184 (save-window-excursion
2185 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
2186 (set-buffer ispell-grep-buffer)
2190 (insert "^" word "$")
2191 (while (search-backward "*" nil t) (insert "."))
2192 (setq word (buffer-string))
2194 (setq status (apply 'call-process prog nil t nil
2195 (nconc (if (and args (> (length args) 0))
2200 (if lookup-dict (list lookup-dict)))))
2201 ;; grep returns status 1 and no output when word not found, which
2202 ;; is a perfectly normal thing.
2203 (if (stringp status)
2204 (setq results (cons (format "error: %s exited with signal %s"
2205 (file-name-nondirectory prog) status)
2207 ;; else collect words into `results' in FIFO order
2208 (goto-char (point-max))
2209 ;; assure we've ended with \n
2210 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
2214 (setq results (cons (buffer-substring-no-properties (point)
2218 (kill-buffer ispell-grep-buffer)
2219 (if (and results (string-match ".+: " (car results)))
2220 (error "%s error: %s" ispell-grep-command (car results))))
2224 ;;; "ispell-filter" is a list of output lines from the generating function.
2225 ;;; Each full line (ending with \n) is a separate item on the list.
2226 ;;; "output" can contain multiple lines, part of a line, or both.
2227 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
2229 ;;; "ispell-filter-continue" is true when we have received only part of a
2230 ;;; line as output from a generating function ("output" did not end with \n)
2231 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2232 ;;; This is the case when a process dies or fails. The default behavior
2233 ;;; in this case treats the next input received as fresh input.
2235 (defun ispell-filter (process output)
2236 "Output filter function for ispell, grep, and look."
2241 (setq end (string-match "\n" output start)) ; get text up to the newline.
2242 ;; If we get out of sync and ispell-filter-continue is asserted when we
2243 ;; are not continuing, treat the next item as a separate list. When
2244 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2247 ;; Continue with same line (item)?
2248 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
2249 ;; Yes. Add it to the prev item
2250 (setcar ispell-filter
2251 (concat (car ispell-filter) (substring output start end)))
2252 ;; No. This is a new line and item.
2254 (cons (substring output start end) ispell-filter)))
2256 ;; We've completed reading the output, but didn't finish the line.
2257 (setq ispell-filter-continue t continue nil)
2258 ;; skip over newline, this line complete.
2259 (setq ispell-filter-continue nil end (1+ end))
2260 (if (= end (length output)) ; No more lines in output
2261 (setq continue nil) ; so we can exit the filter.
2262 (setq start end)))))) ; else move start to next line of input
2265 ;;; This function destroys the mark location if it is in the word being
2267 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
2269 "Highlight the word from START to END with a kludge using `inverse-video'.
2270 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2271 otherwise it is displayed normally.
2272 Uses block cursor to highlight one character.
2273 Optional REFRESH will unhighlighted then highlight, using block cursor
2274 highlighting when REFRESH is equal to `block'."
2275 (and (eq 'block ispell-highlight-p)
2276 (or (eq 'block refresh)
2277 (setq start (1+ start)))) ; On block non-refresh, inc start.
2278 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2279 (buffer-read-only nil) ; Allow highlighting read-only buffers.
2280 (text (buffer-substring-no-properties start end)) ; Save hilight region
2281 (inhibit-quit t) ; inhibit interrupt processing here.
2282 (buffer-undo-list t)) ; don't clutter the undo list.
2284 (delete-region start end)
2285 (insert-char ? (- end start)) ; minimize amount of redisplay
2286 (sit-for 0) ; update display
2287 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2288 (delete-region start end) ; delete whitespace
2289 (insert text) ; insert text in inverse video.
2290 (sit-for 0) ; update display showing inverse video.
2293 (setq inverse-video (not inverse-video)) ; toggle video
2294 (and (eq 'block ispell-highlight-p)
2295 (goto-char (1- start)))) ; use block cursor to "highlight" char
2296 (set-buffer-modified-p modified) ; don't modify if flag not set.
2297 (and refresh ; re-highlight
2298 (ispell-highlight-spelling-error-generic
2299 (if (eq 'block refresh) start (- start 2)) end t))))
2302 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
2303 "Highlight the word from START to END using `isearch-highlight'.
2304 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2305 otherwise it is displayed normally."
2307 (isearch-highlight start end)
2308 (isearch-dehighlight))
2313 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
2314 "Highlight the word from START to END using overlays.
2315 When the optional third arg HIGHLIGHT is set, the word is highlighted
2316 otherwise it is displayed normally.
2318 The variable `ispell-highlight-face' selects the face to use for highlighting."
2321 (move-overlay ispell-overlay start end (current-buffer))
2322 (setq ispell-overlay (make-overlay start end))
2323 (overlay-put ispell-overlay 'priority 1001) ;higher than lazy overlays
2324 (overlay-put ispell-overlay 'face ispell-highlight-face))
2326 (delete-overlay ispell-overlay)))
2327 (if (and ispell-lazy-highlight (boundp 'lazy-highlight-cleanup))
2329 (let ((isearch-string
2332 (regexp-quote (buffer-substring-no-properties start end))
2335 (isearch-case-fold-search nil))
2336 (isearch-lazy-highlight-new-loop
2337 (if (boundp 'reg-start) reg-start)
2338 (if (boundp 'reg-end) reg-end)))
2339 (lazy-highlight-cleanup lazy-highlight-cleanup)
2340 (setq isearch-lazy-highlight-last-string nil))))
2343 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2346 (ispell-highlight-spelling-error-xemacs start end highlight))
2347 ((and (featurep 'faces)
2348 (or (and (fboundp 'display-color-p) (display-color-p))
2350 (ispell-highlight-spelling-error-overlay start end highlight))
2351 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2353 (defun ispell-adjusted-window-height (&optional window)
2354 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2355 The value returned is actually the nominal number of text-lines in the
2356 window plus 1. On a terminal, this is the same value returned by
2357 `window-height', but if the window has a mode-line is taller than a normal
2358 text line, the returned value may be smaller than that from
2360 (cond ((fboundp 'window-text-height)
2361 (1+ (window-text-height window)))
2362 ((or (and (fboundp 'display-graphic-p) (display-graphic-p))
2363 (and (featurep 'xemacs) window-system))
2364 (1- (window-height window)))
2366 (window-height window))))
2368 (defun ispell-overlay-window (height)
2369 "Create a window covering the top HEIGHT lines of the current window.
2370 Ensure that the line above point is still visible but otherwise avoid
2371 scrolling the current window. Leave the new window selected."
2373 (let ((oldot (save-excursion (vertical-motion -1) (point)))
2374 (top (save-excursion (move-to-window-line height) (point))))
2375 ;; If line above old point (line starting at oldot) would be
2376 ;; hidden by new window, scroll it to just below new win
2377 ;; otherwise set top line of other win so it doesn't scroll.
2378 (if (< oldot top) (setq top oldot))
2379 ;; if frame is unsplitable, temporarily disable that...
2380 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2381 (let ((frame (selected-frame)))
2382 (modify-frame-parameters frame '((unsplittable . nil)))
2383 (split-window nil height)
2384 (modify-frame-parameters frame '((unsplittable . t))))
2385 (split-window nil height))
2386 (let ((deficit (- height (ispell-adjusted-window-height))))
2388 ;; Number of lines the window is still too short. We ensure that
2389 ;; there are at least (1- HEIGHT) lines visible in the window.
2390 (enlarge-window deficit)
2392 (vertical-motion deficit)
2393 (setq top (min (point) oldot))))
2394 (set-window-start (next-window) top))))
2397 ;;; Should we add a compound word match return value?
2398 (defun ispell-parse-output (output &optional accept-list shift)
2399 "Parse the OUTPUT string from Ispell process and return:
2400 1: t for an exact match.
2401 2: A string containing the root word matched via suffix removal.
2402 3: A list of possible correct spellings of the format:
2403 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2404 ORIGINAL-WORD is a string of the possibly misspelled word.
2405 OFFSET is an integer giving the line offset of the word.
2406 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2407 4: nil when an error has occurred.
2409 Optional second arg ACCEPT-LIST is list of words already accepted.
2410 Optional third arg SHIFT is an offset to apply based on previous corrections."
2412 ((string= output "") t) ; for startup with pipes...
2413 ((string= output "*") t) ; exact match
2414 ((string= output "-") t) ; compound word match
2415 ((eq (aref output 0) ?+) ; found because of root word
2416 (substring output 2)) ; return root word
2417 ((equal 0 (string-match "[\ra-zA-Z]" output))
2418 (ding) ; error message from ispell!
2419 (message "Ispell error: %s" output)
2422 (t ; need to process &, ?, and #'s
2423 (let ((type (aref output 0)) ; &, ?, or #
2424 (original-word (substring output 2 (string-match " " output 2)))
2425 (cur-count 0) ; contains number of misses + guesses
2426 count miss-list guess-list offset)
2427 (setq output (substring output (match-end 0))) ; skip over misspelling
2429 (setq count 0) ; no misses for type #
2430 (setq count (string-to-number output) ; get number of misses.
2431 output (substring output (1+ (string-match " " output 1)))))
2432 (setq offset (string-to-number output))
2433 (if (eq type ?#) ; No miss or guess list.
2435 (setq output (substring output (1+ (string-match " " output 1)))))
2437 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2438 (setq cur-count (1+ cur-count))
2439 (if (> cur-count count)
2440 (setq guess-list (cons (substring output 0 end) guess-list))
2441 (setq miss-list (cons (substring output 0 end) miss-list)))
2442 (if (match-end 1) ; True only when at end of line.
2443 (setq output nil) ; no more misses or guesses
2444 (setq output (substring output (+ end 2))))))
2445 ;; return results. Accept word if it was already accepted.
2447 (if (member original-word accept-list)
2450 (if (numberp shift) (+ shift offset) offset)
2451 (nreverse miss-list) (nreverse guess-list)))))))
2454 (defun ispell-process-status ()
2455 "Return the status of the Ispell process.
2456 When asynchronous processes are not supported, `run' is always returned."
2457 (if ispell-async-processp
2458 (process-status ispell-process)
2459 (and ispell-process 'run)))
2462 (defun ispell-start-process ()
2463 "Start the ispell process, with support for no asynchronous processes.
2464 Keeps argument list for future ispell invocations for no async support."
2466 ;; Local dictionary becomes the global dictionary in use.
2467 (setq ispell-current-dictionary
2468 (or ispell-local-dictionary ispell-dictionary))
2469 (setq ispell-current-personal-dictionary
2470 (or ispell-local-pdict ispell-personal-dictionary))
2471 (setq args (ispell-get-ispell-args))
2472 (if (and ispell-current-dictionary ; use specified dictionary
2473 (not (member "-d" args))) ; only define if not overridden
2475 (append (list "-d" ispell-current-dictionary) args)))
2476 (if ispell-current-personal-dictionary ; use specified pers dict
2480 (expand-file-name ispell-current-personal-dictionary)))))
2481 (setq args (append args ispell-extra-args))
2483 ;; Initially we don't know any buffer's local words.
2484 (setq ispell-buffer-local-name nil)
2486 (if ispell-async-processp
2487 (let ((process-connection-type ispell-use-ptys-p))
2488 (apply 'start-process
2489 "ispell" nil ispell-program-name
2490 "-a" ; accept single input lines
2491 "-m" ; make root/affix combos not in dict
2493 (setq ispell-cmd-args args
2494 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2495 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2496 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2501 (defun ispell-init-process ()
2502 "Check status of Ispell process and start if necessary."
2503 (if (and ispell-process
2504 (eq (ispell-process-status) 'run)
2505 ;; If we're using a personal dictionary, ensure
2506 ;; we're in the same default directory!
2507 (or (not ispell-personal-dictionary)
2508 (equal ispell-process-directory default-directory)))
2509 (setq ispell-filter nil ispell-filter-continue nil)
2510 ;; may need to restart to select new personal dictionary.
2511 (ispell-kill-ispell t)
2512 (message "Starting new Ispell process [%s] ..."
2513 (or ispell-local-dictionary ispell-dictionary "default"))
2515 (setq ispell-library-directory (ispell-check-version)
2516 ispell-process-directory default-directory
2517 ispell-process (ispell-start-process)
2519 ispell-filter-continue nil)
2520 (if ispell-async-processp
2521 (set-process-filter ispell-process 'ispell-filter))
2522 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
2523 (if (and (or (featurep 'xemacs)
2524 (and (boundp 'enable-multibyte-characters)
2525 enable-multibyte-characters))
2526 (fboundp 'set-process-coding-system))
2527 (set-process-coding-system ispell-process (ispell-get-coding-system)
2528 (ispell-get-coding-system)))
2529 ;; Get version ID line
2530 (ispell-accept-output 3)
2531 ;; get more output if filter empty?
2532 (if (null ispell-filter) (ispell-accept-output 3))
2533 (cond ((null ispell-filter)
2534 (error "%s did not output version line" ispell-program-name))
2536 (stringp (car ispell-filter))
2537 (if (string-match "warning: " (car ispell-filter))
2539 (ispell-accept-output 3) ; was warn msg.
2540 (stringp (car ispell-filter)))
2541 (null (cdr ispell-filter)))
2542 (string-match "^@(#) " (car ispell-filter)))
2543 ;; got the version line as expected (we already know it's the right
2544 ;; version, so don't bother checking again.)
2547 ;; Otherwise, it must be an error message. Show the user.
2548 ;; But first wait to see if some more output is going to arrive.
2549 ;; Otherwise we get cool errors like "Can't open ".
2551 (ispell-accept-output 3)
2552 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2553 (setq ispell-filter nil) ; Discard version ID line
2554 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2555 (if extended-char-mode ; ~ extended character mode
2556 (ispell-send-string (concat extended-char-mode "\n"))))
2557 (if ispell-async-processp
2558 (set-process-query-on-exit-flag ispell-process nil))))
2561 (defun ispell-kill-ispell (&optional no-error)
2562 "Kill current Ispell process (so that you may start a fresh one).
2563 With NO-ERROR, just return non-nil if there was no Ispell running."
2565 ;; This hook is typically used by flyspell to flush some variables used
2566 ;; to optimize the common cases.
2567 (run-hooks 'ispell-kill-ispell-hook)
2568 (if (not (and ispell-process
2569 (eq (ispell-process-status) 'run)))
2571 (error "There is no ispell process running!"))
2572 (if ispell-async-processp
2574 (process-send-eof ispell-process)
2575 (if (eq (ispell-process-status) 'run)
2576 (ispell-accept-output 1))
2577 (if (eq (ispell-process-status) 'run)
2578 (kill-process ispell-process))
2579 (while (not (or (eq (ispell-process-status) 'exit)
2580 (eq (ispell-process-status) 'signal)))
2582 ;; synchronous processes
2583 (ispell-send-string "\n") ; make sure side effects occurred.
2584 (kill-buffer ispell-output-buffer)
2585 (kill-buffer ispell-session-buffer)
2586 (setq ispell-output-buffer nil
2587 ispell-session-buffer nil))
2588 (setq ispell-process nil)
2589 (message "Ispell process killed")
2593 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2594 ;;; call ispell-init-process rather than wait for a spell checking command?
2597 (defun ispell-change-dictionary (dict &optional arg)
2598 "Change to dictionary DICT for Ispell.
2599 With a prefix arg, set it \"globally\", for all buffers.
2600 Without a prefix arg, set it \"locally\", just for this buffer.
2602 By just answering RET you can find out what the current dictionary is."
2604 (list (completing-read
2605 "Use new dictionary (RET for current, SPC to complete): "
2606 (and (fboundp 'ispell-valid-dictionary-list)
2607 (mapcar 'list (ispell-valid-dictionary-list)))
2609 current-prefix-arg))
2610 (unless arg (ispell-buffer-local-dict 'no-reload))
2611 (if (equal dict "default") (setq dict nil))
2612 ;; This relies on completing-read's bug of returning "" for no match
2613 (cond ((equal dict "")
2614 (ispell-internal-change-dictionary)
2615 (message "Using %s dictionary"
2616 (or ispell-local-dictionary ispell-dictionary "default")))
2617 ((equal dict (or ispell-local-dictionary
2618 ispell-dictionary "default"))
2619 ;; Specified dictionary is the default already. Could reload
2620 ;; the dictionaries if needed.
2621 (ispell-internal-change-dictionary)
2622 (and (interactive-p)
2623 (message "No change, using %s dictionary" dict)))
2624 (t ; reset dictionary!
2625 (if (or (assoc dict ispell-local-dictionary-alist)
2626 (assoc dict ispell-dictionary-alist))
2628 ;; set default dictionary
2629 (setq ispell-dictionary dict)
2630 ;; set local dictionary
2631 (setq ispell-local-dictionary dict)
2632 (setq ispell-local-dictionary-overridden t))
2633 (error "Undefined dictionary: %s" dict))
2634 (ispell-internal-change-dictionary)
2635 (message "%s Ispell dictionary set to %s"
2636 (if arg "Global" "Local")
2639 (defun ispell-internal-change-dictionary ()
2640 "Update the dictionary and the personal dictionary used by Ispell.
2641 This may kill the Ispell process; if so,
2642 a new one will be started when needed."
2643 (let ((dict (or ispell-local-dictionary ispell-dictionary))
2644 (pdict (or ispell-local-pdict ispell-personal-dictionary)))
2645 (unless (and (equal ispell-current-dictionary dict)
2646 (equal ispell-current-personal-dictionary pdict))
2647 (ispell-kill-ispell t)
2648 (setq ispell-current-dictionary dict
2649 ispell-current-personal-dictionary pdict))))
2651 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2654 (defun ispell-region (reg-start reg-end &optional recheckp shift)
2655 "Interactively check a region for spelling errors.
2656 Return nil if spell session is quit,
2657 otherwise returns shift offset amount for last line processed."
2658 (interactive "r") ; Don't flag errors on read-only bufs.
2659 (ispell-maybe-find-aspell-dictionaries)
2661 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2662 (let ((skip-region-start (make-marker))
2663 (rstart (make-marker)))
2666 (message "Spell checking %s using %s with %s dictionary..."
2667 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2668 (buffer-name) "region")
2669 (file-name-nondirectory ispell-program-name)
2670 (or ispell-current-dictionary "default"))
2671 ;; Returns cursor to original location.
2672 (save-window-excursion
2673 (goto-char reg-start)
2674 (let ((transient-mark-mode)
2675 (case-fold-search case-fold-search)
2678 (let (message-log-max)
2679 (message "searching for regions to skip"))
2680 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t)
2682 (setq key (buffer-substring-no-properties
2683 (match-beginning 0) (match-end 0)))
2684 (set-marker skip-region-start (- (point) (length key)))
2685 (goto-char reg-start)))
2686 (let (message-log-max)
2687 (message "Continuing spelling check using %s with %s dictionary..."
2688 (file-name-nondirectory ispell-program-name)
2689 (or ispell-current-dictionary "default")))
2690 (set-marker rstart reg-start)
2691 (set-marker ispell-region-end reg-end)
2692 (while (and (not ispell-quit)
2693 (< (point) ispell-region-end))
2694 ;; spell-check region with skipping
2695 (if (and (marker-position skip-region-start)
2696 (<= skip-region-start (point)))
2698 ;; If region inside line comment, must keep comment start.
2699 (setq in-comment (point)
2702 (or (null comment-end) (string= "" comment-end))
2705 (re-search-forward comment-start in-comment t))
2707 ;; Can change skip-regexps (in ispell-message)
2708 (ispell-skip-region key) ; moves pt past region.
2709 (set-marker rstart (point))
2710 ;; check for saving large attachments...
2711 (setq query-fcc (and query-fcc
2712 (ispell-ignore-fcc skip-region-start
2714 (if (and (< rstart ispell-region-end)
2716 (ispell-begin-skip-region-regexp)
2717 ispell-region-end t))
2719 (setq key (match-string-no-properties 0))
2720 (set-marker skip-region-start
2721 (- (point) (length key)))
2723 (set-marker skip-region-start nil))))
2724 (setq reg-end (max (point)
2725 (if (marker-position skip-region-start)
2726 (min skip-region-start ispell-region-end)
2727 (marker-position ispell-region-end))))
2728 (let* ((start (point))
2729 (end (save-excursion (end-of-line) (min (point) reg-end)))
2730 (string (ispell-get-line start end in-comment)))
2731 (if in-comment ; account for comment chars added
2732 (setq start (- start (length in-comment))
2734 (setq end (point)) ; "end" tracks region retrieved.
2735 (if string ; there is something to spell check!
2736 ;; (special start end)
2737 (setq shift (ispell-process-line string
2738 (and recheckp shift))))
2744 (if (and (not (and recheckp ispell-keep-choices-win))
2745 (get-buffer ispell-choices-buffer))
2746 (kill-buffer ispell-choices-buffer))
2747 (set-marker skip-region-start nil)
2748 (set-marker rstart nil)
2751 ;; preserve or clear the region for ispell-continue.
2752 (if (not (numberp ispell-quit))
2753 (set-marker ispell-region-end nil)
2754 ;; Ispell-continue enabled - ispell-region-end is set.
2755 (goto-char ispell-quit))
2756 ;; Check for aborting
2757 (if (and ispell-checking-message (numberp ispell-quit))
2759 (setq ispell-quit nil)
2760 (error "Message send aborted")))
2761 (if (not recheckp) (setq ispell-quit nil)))
2762 (if (not recheckp) (set-marker ispell-region-end nil))
2763 ;; Only save if successful exit.
2764 (ispell-pdict-save ispell-silently-savep)
2765 (message "Spell-checking using %s with %s dictionary done"
2766 (file-name-nondirectory ispell-program-name)
2767 (or ispell-current-dictionary "default"))))))
2770 (defun ispell-begin-skip-region-regexp ()
2771 "Returns a regexp of the search keys for region skipping.
2772 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2773 Must call after ispell-buffer-local-parsing due to dependence on mode."
2774 ;; start with regions generic to all buffers
2775 (let ((skip-regexp (ispell-begin-skip-region ispell-skip-region-alist)))
2777 (if (and (null ispell-check-comments) comment-start)
2778 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2780 (if (and (eq 'exclusive ispell-check-comments) comment-start)
2781 ;; search from end of current comment to start of next comment.
2782 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2783 (regexp-quote comment-end))
2784 "\\|" skip-regexp)))
2787 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
2789 (if ispell-skip-html
2790 (setq skip-regexp (concat
2791 (ispell-begin-skip-region ispell-html-skip-alists)
2795 (if (eq ispell-parser 'tex)
2796 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2799 (if (and ispell-checking-message
2800 (not (eq t ispell-checking-message)))
2801 (setq skip-regexp (concat
2802 (mapconcat (lambda (lst) (car lst))
2803 ispell-checking-message
2808 ;; return new regexp
2812 (defun ispell-begin-skip-region (skip-alist)
2813 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2814 Each selection should be a key of SKIP-ALIST;
2815 otherwise, the current line is skipped."
2816 (mapconcat (lambda (lst) (if (stringp (car lst)) (car lst) (eval (car lst))))
2821 (defun ispell-begin-tex-skip-regexp ()
2822 "Regular expression of tex commands to skip.
2823 Generated from `ispell-tex-skip-alists'."
2826 (mapconcat (function (lambda (lst) (car lst)))
2827 (car ispell-tex-skip-alists)
2830 ;; keys wrapped in begin{}
2831 (mapconcat (function (lambda (lst)
2832 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2835 (car (cdr ispell-tex-skip-alists))
2839 (defun ispell-skip-region-list ()
2840 "Returns a list describing key and body regions to skip for this buffer.
2841 Includes regions defined by `ispell-skip-region-alist', tex mode,
2842 `ispell-html-skip-alists', and `ispell-checking-message'.
2843 Manual checking must include comments and tib references.
2844 The list is of the form described by variable `ispell-skip-region-alist'.
2845 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2846 (let ((skip-alist ispell-skip-region-alist))
2847 ;; only additional explicit region definition is tex.
2848 (if (eq ispell-parser 'tex)
2849 (setq case-fold-search nil
2850 skip-alist (append (car ispell-tex-skip-alists)
2851 (car (cdr ispell-tex-skip-alists))
2853 (if ispell-skip-html
2854 (setq skip-alist (append ispell-html-skip-alists skip-alist)))
2855 (if (and ispell-checking-message
2856 (not (eq t ispell-checking-message)))
2857 (setq skip-alist (append ispell-checking-message skip-alist)))
2861 (defun ispell-tex-arg-end (&optional arg)
2862 "Skip across ARG number of braces."
2865 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2866 (forward-sexp (or arg 1)))
2868 (message "error skipping s-expressions at point %d." (point))
2873 (defun ispell-ignore-fcc (start end)
2874 "Deletes the Fcc: message header when large attachments are included.
2875 Return value `nil' if file with large attachments are saved.
2876 This can be used to avoid multiple questions for multiple large attachments.
2877 Returns point to starting location afterwards."
2879 (if (and ispell-checking-message ispell-message-fcc-skip)
2880 (if (< ispell-message-fcc-skip (- end start))
2881 (let (case-fold-search head-end)
2882 (goto-char (point-min))
2884 (or (re-search-forward
2885 (concat "^" (regexp-quote mail-header-separator) "$")
2887 (re-search-forward "^$" nil t)
2889 (goto-char (point-min))
2890 (if (re-search-forward "^Fcc:" head-end t)
2892 "Save copy of this message with large attachments? ")
2900 (defun ispell-skip-region (key)
2901 "Skips across KEY and then to end of region.
2902 Key lookup determines region to skip.
2903 Point is placed at end of skipped region."
2904 ;; move over key to begin checking.
2905 (forward-char (length key))
2906 (let ((start (point))
2907 ;; Regenerate each call... This function can change region definition.
2908 (alist (ispell-skip-region-list))
2909 alist-key null-skip)
2911 ;; what about quoted comment, or comment inside strings?
2912 ((and (null ispell-check-comments) comment-start
2913 (string= key comment-start))
2914 (if (string= "" comment-end)
2916 (search-forward comment-end ispell-region-end t)))
2917 ((and (eq 'exclusive ispell-check-comments) comment-start
2918 (string= key comment-end))
2919 (search-forward comment-start ispell-region-end :end))
2920 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2921 (re-search-forward ispell-tib-ref-end ispell-region-end t))
2922 ;; markings from alist
2925 (setq alist-key (eval (car (car alist))))
2926 (if (string-match alist-key key)
2928 (setq alist (cdr (car alist)))
2930 ((null alist) (setq null-skip t)) ; done! Just skip key.
2931 ((not (consp alist))
2932 ;; Search past end of spell region to find this region end.
2933 (re-search-forward (eval alist) (point-max) t))
2934 ((and (= 1 (length alist))
2935 (stringp (car alist)))
2936 (re-search-forward (car alist) (point-max) t))
2938 (setq null-skip t) ; error handling in functions!
2939 (if (consp (cdr alist))
2940 (apply (car alist) (cdr alist))
2941 (funcall (car alist)))))
2943 (setq alist (cdr alist))))))
2944 (if (and (= start (point)) (null null-skip))
2946 (message "Matching region end for `%s' point %d not found"
2952 ;;; Grab the next line of data.
2953 ;;; Returns a string with the line data
2954 (defun ispell-get-line (start end in-comment)
2955 (let ((ispell-casechars (ispell-get-casechars))
2957 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2958 ((eolp) ; END OF LINE, just go to next line.
2960 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
2961 ;; (forward-char 1)) ; not needed as quoted below.
2962 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2963 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
2964 (setq string (concat "^" in-comment
2965 (buffer-substring-no-properties start end)
2968 (t (goto-char end))) ; EMPTY LINE, skip it.
2972 (defun ispell-looking-at (string)
2973 (let ((coding (ispell-get-coding-system))
2974 (len (length string)))
2975 (and (<= (+ (point) len) (point-max))
2976 (equal (encode-coding-string string coding)
2977 (encode-coding-string (buffer-substring-no-properties
2978 (point) (+ (point) len))
2981 ;;; Avoid error messages when compiling for these dynamic variables.
2985 (defun ispell-process-line (string shift)
2986 "Sends a LINE of text to ispell and processes the result.
2987 This will modify the buffer for spelling errors.
2988 Requires variables START and END to be defined in its lexical scope.
2989 Returns the sum shift due to changes in word replacements."
2990 ;;(declare special start end)
2991 (let (poss accept-list)
2992 (if (not (numberp shift))
2994 ;; send string to spell process and get input.
2995 (ispell-send-string string)
2997 (ispell-accept-output)
2998 ;; Last item of output contains a blank line.
2999 (not (string= "" (car ispell-filter)))))
3000 ;; parse all inputs from the stream one word at a time.
3001 ;; Place in FIFO order and remove the blank item.
3002 (setq ispell-filter (nreverse (cdr ispell-filter)))
3003 (while (and (not ispell-quit) ispell-filter)
3004 ;; get next word, accounting for accepted words and start shifts
3005 (setq poss (ispell-parse-output (car ispell-filter)
3007 (if (and poss (listp poss)) ; spelling error occurred.
3008 ;; Whenever we have misspellings, we can change
3009 ;; the buffer. Keep boundaries as markers.
3010 ;; Markers can move with highlighting! This destroys
3011 ;; end of region markers line-end and ispell-region-end
3013 (copy-marker (+ start ispell-offset (car (cdr poss)))))
3014 (word-len (length (car poss)))
3015 (line-end (copy-marker end))
3016 (line-start (copy-marker start))
3017 recheck-region replace)
3018 (goto-char word-start)
3019 ;; Adjust the horizontal scroll & point
3020 (ispell-horiz-scroll)
3021 (goto-char (+ word-len word-start))
3022 (ispell-horiz-scroll)
3023 (goto-char word-start)
3024 (ispell-horiz-scroll)
3026 ;; Alignment cannot be tracked and this error will occur when
3027 ;; `query-replace' makes multiple corrections on the starting line.
3028 (or (ispell-looking-at (car poss))
3029 ;; This occurs due to filter pipe problems
3030 (error (concat "Ispell misalignment: word "
3031 "`%s' point %d; probably incompatible versions")
3032 (car poss) (marker-position word-start)))
3033 ;; ispell-cmd-loop can go recursive & change buffer
3034 (if ispell-keep-choices-win
3035 (setq replace (ispell-command-loop
3036 (car (cdr (cdr poss)))
3037 (car (cdr (cdr (cdr poss))))
3038 (car poss) (marker-position word-start)
3039 (+ word-len (marker-position word-start))))
3040 (save-window-excursion
3041 (setq replace (ispell-command-loop
3042 (car (cdr (cdr poss)))
3043 (car (cdr (cdr (cdr poss))))
3044 (car poss) (marker-position word-start)
3045 (+ word-len (marker-position word-start))))))
3047 (goto-char word-start)
3048 ;; Recheck when query replace edit changes misspelled word.
3049 ;; Error in tex mode when a potential math mode change exists.
3050 (if (and replace (listp replace) (= 2 (length replace)))
3051 (if (and (eq ispell-parser 'tex)
3052 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3053 (regexp-quote string)))
3055 "Don't start query replace on a line with math characters"
3057 (set-marker line-end (point))
3058 (setq ispell-filter nil
3061 ;; insert correction if needed
3064 (equal 0 replace)) ; ACCEPT/INSERT
3065 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
3066 (ispell-add-per-file-word-list (car poss)))
3067 ;; do not recheck accepted word on this line
3068 (setq accept-list (cons (car poss) accept-list)))
3069 (t ; replacement word selected or entered
3070 (delete-region (point) (+ word-len (point)))
3071 (if (not (listp replace))
3073 (ispell-insert-word replace) ; insert dictionary word
3074 (ispell-send-replacement (car poss) replace)
3075 (setq accept-list (cons replace accept-list)))
3076 (let ((replace-word (car replace)))
3077 ;; Recheck hand entered replacement word
3078 (insert replace-word)
3079 (ispell-send-replacement (car poss) replace-word)
3080 (if (car (cdr replace))
3081 (save-window-excursion
3082 (delete-other-windows) ; to correctly show help.
3083 ;; Assume case-replace &
3084 ;; case-fold-search correct?
3085 (query-replace (car poss) (car replace) t)))
3086 (goto-char word-start)
3087 ;; do not recheck if already accepted
3088 (if (member replace-word accept-list)
3089 (setq accept-list (cons replace-word accept-list)
3090 replace replace-word)
3091 (let ((region-end (copy-marker ispell-region-end)))
3092 (setq recheck-region ispell-filter
3093 ispell-filter nil ; save filter
3094 shift 0 ; already accounted
3095 shift (ispell-region
3097 (+ word-start (length replace-word))
3099 (if (null shift) ; quitting check.
3101 (set-marker ispell-region-end region-end)
3102 (set-marker region-end nil)
3103 (setq ispell-filter recheck-region
3105 replace replace-word)))))
3107 (setq shift (+ shift (- (length replace) word-len)))
3109 ;; Move line-start across word...
3110 ;; new shift function does this now...
3111 ;;(set-marker line-start (+ line-start
3112 ;; (- (length replace)
3113 ;; (length (car poss)))))
3115 (if (not ispell-quit)
3116 (let (message-log-max)
3117 (message "Continuing spelling check using %s with %s dictionary..."
3118 (file-name-nondirectory ispell-program-name)
3119 (or ispell-current-dictionary "default"))))
3121 (setq start (marker-position line-start)
3122 end (marker-position line-end))
3123 ;; Adjust markers when end of region lost from highlighting.
3124 (if (and (not recheck-region) (< end (+ word-start word-len)))
3125 (setq end (+ word-start word-len)))
3126 (if (= word-start ispell-region-end)
3127 (set-marker ispell-region-end (+ word-start word-len)))
3128 ;; going out of scope - unneeded
3129 (set-marker line-start nil)
3130 (set-marker word-start nil)
3131 (set-marker line-end nil)))
3132 ;; finished with misspelling!
3133 (setq ispell-filter (cdr ispell-filter)))
3138 (defun ispell-comments-and-strings ()
3139 "Check comments and strings in the current buffer for spelling errors."
3141 (goto-char (point-min))
3145 (setq state (parse-partial-sexp (point) (point-max)
3146 nil nil state 'syntax-table))
3147 (if (or (nth 3 state) (nth 4 state))
3148 (let ((start (point)))
3149 (setq state (parse-partial-sexp start (point-max)
3150 nil nil state 'syntax-table))
3151 (if (or (nth 3 state) (nth 4 state))
3152 (error "Unterminated string or comment"))
3154 (setq done (not (ispell-region start (point))))))))))
3158 (defun ispell-buffer ()
3159 "Check the current buffer for spelling errors interactively."
3161 (ispell-region (point-min) (point-max)))
3165 (defun ispell-continue ()
3166 "Continue a halted spelling session beginning with the current word."
3168 (if (not (marker-position ispell-region-end))
3169 (message "No session to continue. Use 'X' command when checking!")
3170 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
3171 (message "Must continue ispell from buffer %s"
3172 (buffer-name (marker-buffer ispell-region-end)))
3174 ;; find beginning of current word:
3175 (car (cdr (ispell-get-word t)))
3176 (marker-position ispell-region-end)))))
3179 ;;; Horizontal scrolling
3180 (defun ispell-horiz-scroll ()
3181 "Places point within the horizontal visibility of its window area."
3182 (if truncate-lines ; display truncating lines?
3183 ;; See if display needs to be scrolled.
3184 (let ((column (- (current-column) (max (window-hscroll) 1))))
3185 (if (and (< column 0) (> (window-hscroll) 0))
3186 (scroll-right (max (- column) 10))
3187 (if (>= column (- (window-width) 2))
3188 (scroll-left (max (- column (window-width) -3) 10)))))))
3191 ;;; Interactive word completion.
3192 ;;; Forces "previous-word" processing. Do we want to make this selectable?
3195 (defun ispell-complete-word (&optional interior-frag)
3196 "Try to complete the word before or under point (see `lookup-words').
3197 If optional INTERIOR-FRAG is non-nil then the word may be a character
3198 sequence inside of a word.
3200 Standard ispell choices are then available."
3202 (let ((cursor-location (point))
3203 (case-fold-search-val case-fold-search)
3204 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
3205 start end possibilities replacement)
3206 (setq start (car (cdr word))
3207 end (car (cdr (cdr word)))
3210 (or (string= word "") ; Will give you every word
3211 (lookup-words (concat (and interior-frag "*") word
3212 (if (or interior-frag (null ispell-look-p))
3214 ispell-complete-word-dict)))
3215 (cond ((eq possibilities t)
3216 (message "No word to complete"))
3217 ((null possibilities)
3218 (message "No match for \"%s\"" word))
3219 (t ; There is a modification...
3220 (setq case-fold-search nil) ; Try and respect case of word.
3222 ((string-equal (upcase word) word)
3223 (setq possibilities (mapcar 'upcase possibilities)))
3224 ((eq (upcase (aref word 0)) (aref word 0))
3225 (setq possibilities (mapcar (function
3227 (if (eq (aref word 0) (aref pos 0))
3231 (setq case-fold-search case-fold-search-val)
3232 (save-window-excursion
3234 (ispell-command-loop possibilities nil word start end)))
3236 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
3237 (ispell-add-per-file-word-list word))
3238 (replacement ; REPLACEMENT WORD
3239 (delete-region start end)
3240 (setq word (if (atom replacement) replacement (car replacement))
3241 cursor-location (+ (- (length word) (- end start))
3243 (ispell-insert-word word)
3244 (if (not (atom replacement)) ; recheck spelling of replacement.
3246 (goto-char cursor-location)
3247 (ispell-word nil t)))))
3248 (if (get-buffer ispell-choices-buffer)
3249 (kill-buffer ispell-choices-buffer))))
3250 (ispell-pdict-save ispell-silently-savep)
3251 (goto-char cursor-location)))
3255 (defun ispell-complete-word-interior-frag ()
3256 "Completes word matching character sequence inside a word."
3258 (ispell-complete-word t))
3263 "Interactively check a region or buffer for spelling errors.
3264 If `transient-mark-mode' is on, and a region is active, spell-check
3265 that region. Otherwise spell-check the buffer.
3267 Ispell dictionaries are not distributed with Emacs. If you are
3268 looking for a dictionary, please see the distribution of the GNU ispell
3269 program, or do an Internet search; there are various dictionaries
3270 available on the net."
3272 (if (and (boundp 'transient-mark-mode) transient-mark-mode
3273 (boundp 'mark-active) mark-active)
3274 (ispell-region (region-beginning) (region-end))
3278 ;;; **********************************************************************
3279 ;;; Ispell Minor Mode
3280 ;;; **********************************************************************
3282 (defvar ispell-minor-mode nil
3283 "Non-nil if Ispell minor mode is enabled.")
3284 ;; Variable indicating that ispell minor mode is active.
3285 (make-variable-buffer-local 'ispell-minor-mode)
3287 (or (assq 'ispell-minor-mode minor-mode-alist)
3288 (setq minor-mode-alist
3289 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
3291 (defvar ispell-minor-keymap
3292 (let ((map (make-sparse-keymap)))
3293 (define-key map " " 'ispell-minor-check)
3294 (define-key map "\r" 'ispell-minor-check)
3296 "Keymap used for Ispell minor mode.")
3298 (or (not (boundp 'minor-mode-map-alist))
3299 (assoc 'ispell-minor-mode minor-mode-map-alist)
3300 (setq minor-mode-map-alist
3301 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
3302 minor-mode-map-alist)))
3305 (defun ispell-minor-mode (&optional arg)
3306 "Toggle Ispell minor mode.
3307 With prefix arg, turn Ispell minor mode on iff arg is positive.
3309 In Ispell minor mode, pressing SPC or RET
3310 warns you if the previous word is incorrectly spelled.
3312 All the buffer-local variables and dictionaries are ignored -- to read
3313 them into the running ispell process, type \\[ispell-word] SPC."
3315 (setq ispell-minor-mode
3316 (not (or (and (null arg) ispell-minor-mode)
3317 (<= (prefix-numeric-value arg) 0))))
3318 (force-mode-line-update))
3320 (defun ispell-minor-check ()
3321 "Check previous word then continue with the normal binding of this key.
3322 Don't check previous word when character before point is a space or newline.
3323 Don't read buffer-local settings or word lists."
3325 (let ((ispell-minor-mode nil)
3326 (ispell-check-only t)
3327 (last-char (char-after (1- (point)))))
3328 (command-execute (key-binding (this-command-keys)))
3329 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
3330 (and ispell-skip-html (eq last-char ?>))
3331 (and ispell-skip-html (eq last-char ?\;))))
3332 (ispell-word nil t))))
3335 ;;; **********************************************************************
3337 ;;; **********************************************************************
3339 (defvar ispell-message-text-end
3340 (mapconcat (function identity)
3342 ;; Don't spell check signatures
3344 ;; Matches postscript files.
3345 ;;"^%!PS-Adobe-[123].0"
3346 ;; Matches uuencoded text
3347 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3348 ;; Matches shell files (especially auto-decoding)
3350 ;; Matches context difference listing
3351 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3352 ;; Matches unidiff difference listing
3353 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
3354 ;; Matches reporter.el bug report
3355 "^current state:\n==============\n"
3356 ;; Matches commonly used "cut" boundaries
3357 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3359 "*End of text which will be checked in `ispell-message'.
3360 If it is a string, limit at first occurrence of that regular expression.
3361 Otherwise, it must be a function which is called to get the limit.")
3364 (defun ispell-mime-multipartp (&optional limit)
3365 "Return multipart message start boundary or nil if none."
3366 ;; caller must ensure `case-fold-search' is set to `t'
3369 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3372 (if (looking-at "\"")
3375 (setq start (point))
3376 (while (not (looking-at "\""))
3378 (setq boundary (buffer-substring-no-properties start (point))))
3379 (let ((start (point)))
3380 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3382 (setq boundary (buffer-substring-no-properties start (point)))))
3383 (if (< (length boundary) 1)
3385 (concat "--" boundary)))))
3388 (defun ispell-mime-skip-part (boundary)
3389 "Moves point across header, or entire MIME part if message is encoded.
3390 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3391 encoded and therefore skipped. See rfc 1521, 2183, ...
3392 If no boundary is given, then entire message is skipped.
3394 This starts one line ABOVE the MIME content messages, on the boundary marker,
3395 for operation with the generic region-skipping code.
3396 This places new MIME boundaries into variable `ispell-checking-message'."
3397 (forward-line) ; skip over boundary to headers
3398 (let ((save-case-fold-search case-fold-search)
3401 (setq case-fold-search t
3402 ispell-skip-html nil)
3404 (setq continuep nil)
3405 (if (looking-at "Content-Type: *text/")
3407 (goto-char (match-end 0))
3408 (if (looking-at "html")
3409 (setq ispell-skip-html t))
3412 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3414 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3415 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3416 (setq textp (member (upcase match)
3417 ;; only spell check the following encodings:
3418 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3420 (goto-char (match-end 0))
3421 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3423 ;; hierarchical boundary definition
3424 (if (looking-at "Content-Type: *multipart/")
3425 (let ((new-boundary (ispell-mime-multipartp)))
3426 (if (string-match new-boundary boundary)
3428 ;; first pass redefine skip function to include new boundary
3429 ;;(re-search-backward boundary nil t)
3431 (setq ispell-checking-message
3433 (list new-boundary 'ispell-mime-skip-part new-boundary)
3434 (if (eq t ispell-checking-message) nil
3435 ispell-checking-message))
3438 ;; Skip all MIME headers that don't affect spelling
3439 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3442 (goto-char (match-end 0))
3445 (setq case-fold-search save-case-fold-search)
3448 ;; encoded message. Skip to boundary, or entire message.
3450 (goto-char (point-max))
3451 (re-search-forward boundary nil t)
3457 (defun ispell-message ()
3458 "Check the spelling of a mail message or news post.
3459 Don't check spelling of message headers except the Subject field.
3460 Don't check included messages.
3462 To abort spell checking of a message region and send the message anyway,
3463 use the `x' command. (Any subsequent regions will be checked.)
3464 The `X' command aborts the message send so that you can edit the buffer.
3466 To spell-check whenever a message is sent, include the appropriate lines
3467 in your .emacs file:
3468 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3469 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3470 (add-hook 'mail-send-hook 'ispell-message)
3471 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3473 You can bind this to the key C-c i in GNUS or mail by adding to
3474 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3475 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3478 (goto-char (point-min))
3479 (let* (boundary mimep
3480 (ispell-skip-region-alist-save ispell-skip-region-alist)
3481 ;; Nil when message came from outside (eg calling emacs as editor)
3482 ;; Non-nil marker of end of headers.
3485 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3486 (end-of-headers ; Start of body.
3488 (or internal-messagep
3489 (re-search-forward "^$" nil t)
3491 (limit (copy-marker ; End of region we will spell check.
3493 ((not ispell-message-text-end) (point-max))
3494 ((char-or-string-p ispell-message-text-end)
3495 (if (re-search-forward ispell-message-text-end nil t)
3498 (t (min (point-max) (funcall ispell-message-text-end))))))
3499 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3500 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3501 (ispell-non-empty-string mail-yank-prefix)
3503 (cite-regexp ;Prefix of quoted text
3505 ((functionp 'sc-cite-regexp) ; sc 3.0
3506 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3508 (ispell-non-empty-string sc-reference-tag-string))))
3509 ((boundp 'sc-cite-regexp) ; sc 2.3
3510 (concat "\\(" sc-cite-regexp "\\)" "\\|"
3512 (ispell-non-empty-string sc-reference-tag-string))))
3513 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3514 (equal major-mode 'message-mode)) ;GNUS 5
3515 (concat "In article <" "\\|"
3516 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3517 (with-no-warnings message-cite-prefix-regexp)
3520 ((equal major-mode 'mh-letter-mode) ; mh mail message
3521 (concat "[^,;&+=\n]+ writes:" "\\|"
3523 (ispell-non-empty-string mh-ins-buf-prefix))))
3524 ((not internal-messagep) ; Assume nn sent us this message.
3525 (concat "In [a-zA-Z.]+ you write:" "\\|"
3526 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3528 ((boundp 'vm-included-text-prefix) ; VM mail message
3529 (concat "[^,;&+=\n]+ writes:" "\\|"
3530 (ispell-non-empty-string vm-included-text-prefix)))
3531 (t default-prefix)))
3532 (ispell-skip-region-alist
3533 (cons (list (concat "^\\(" cite-regexp "\\)")
3534 (function forward-line))
3535 ispell-skip-region-alist))
3536 (old-case-fold-search case-fold-search)
3537 (dictionary-alist ispell-message-dictionary-alist)
3538 (ispell-checking-message t))
3540 ;; Select dictionary for message
3541 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3542 (while dictionary-alist
3543 (goto-char (point-min))
3544 (if (re-search-forward (car (car dictionary-alist))
3546 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3547 dictionary-alist nil)
3548 (setq dictionary-alist (cdr dictionary-alist)))))
3552 ;; Spell check any original Subject:
3553 (goto-char (point-min))
3554 (setq case-fold-search t
3555 mimep (re-search-forward "MIME-Version:" end-of-headers t))
3556 (goto-char (point-min))
3557 (if (re-search-forward "^Subject: *" end-of-headers t)
3559 (goto-char (match-end 0))
3560 (if (and (not (looking-at ".*Re\\>"))
3561 (not (looking-at "\\[")))
3563 (setq case-fold-search old-case-fold-search)
3564 (ispell-region (point)
3565 (progn ;Tab-initiated continuation lns.
3567 (while (looking-at "\n[ \t]")
3572 (goto-char (point-min))
3573 (setq boundary (ispell-mime-multipartp end-of-headers))))
3574 ;; Adjust message limit to MIME message if necessary.
3576 (re-search-forward (concat boundary "--") nil t)
3577 (re-search-backward boundary nil t)
3578 (< (point) (marker-position limit))
3579 (set-marker limit (point)))
3580 (goto-char (point-min))
3581 ;; Select type or skip checking if this is a non-multipart message
3582 ;; Point moved to end of buffer if region is encoded.
3583 (if (and mimep (not boundary))
3584 (let (skip-regexp) ; protect from `ispell-mime-skip-part'
3585 (goto-char (point-min))
3586 (re-search-forward "Content-[^ \t]*:" end-of-headers t)
3587 (forward-line -1) ; following fn starts one line above
3588 (ispell-mime-skip-part nil)
3589 ;; if message-text-end region, limit may be less than point.
3590 (if (> (point) limit)
3591 (set-marker limit (point)))))
3592 (goto-char (max end-of-headers (point)))
3594 (setq case-fold-search old-case-fold-search)
3595 ;; Define MIME regions to skip.
3597 (setq ispell-checking-message
3598 (list (list boundary 'ispell-mime-skip-part boundary))))
3599 (ispell-region (point) limit))
3600 (set-marker end-of-headers nil)
3601 (set-marker limit nil)
3602 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3603 ispell-skip-html nil
3604 case-fold-search old-case-fold-search)))))
3607 (defun ispell-non-empty-string (string)
3608 (if (or (not string) (string-equal string ""))
3609 "\\'\\`" ; An unmatchable string if string is null.
3610 (regexp-quote string)))
3613 ;;; **********************************************************************
3614 ;;; Buffer Local Functions
3615 ;;; **********************************************************************
3618 (defun ispell-accept-buffer-local-defs ()
3619 "Load all buffer-local information, restarting Ispell when necessary."
3620 (ispell-buffer-local-dict) ; May kill ispell-process.
3621 (ispell-buffer-local-words) ; Will initialize ispell-process.
3622 (ispell-buffer-local-parsing))
3625 (defun ispell-buffer-local-parsing ()
3626 "Place Ispell into parsing mode for this buffer.
3627 Overrides the default parsing mode.
3628 Includes Latex/Nroff modes and extended character mode."
3629 ;; (ispell-init-process) must already be called.
3630 (ispell-send-string "!\n") ; Put process in terse mode.
3631 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3632 ;; When exclusively checking comments, set to raw text mode (nroff).
3633 (if (and (not (eq 'exclusive ispell-check-comments))
3634 (or (and (eq ispell-parser 'use-mode-name)
3635 (string-match "[Tt][Ee][Xx]-mode"
3636 (symbol-name major-mode)))
3637 (eq ispell-parser 'tex)))
3639 (ispell-send-string "+\n") ; set ispell mode to tex
3640 (if (not (eq ispell-parser 'tex))
3641 (set (make-local-variable 'ispell-parser) 'tex)))
3642 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3643 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3644 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
3645 (setq ispell-skip-html
3646 (not (null (string-match "sgml\\|html\\|xml"
3647 (downcase (symbol-name major-mode)))))))
3648 ;; Set default extended character mode for given buffer, if any.
3649 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3650 (if extended-char-mode
3651 (ispell-send-string (concat extended-char-mode "\n"))))
3652 ;; Set buffer-local parsing mode and extended character mode, if specified.
3654 (goto-char (point-max))
3655 ;; Uses last occurrence of ispell-parsing-keyword
3656 (if (search-backward ispell-parsing-keyword nil t)
3657 (let ((end (save-excursion (end-of-line) (point)))
3659 (search-forward ispell-parsing-keyword)
3660 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3661 ;; space separated definitions.
3662 (setq string (downcase (match-string-no-properties 1)))
3663 (cond ((and (string-match "latex-mode" string)
3664 (not (eq 'exclusive ispell-check-comments)))
3665 (ispell-send-string "+\n~tex\n"))
3666 ((string-match "nroff-mode" string)
3667 (ispell-send-string "-\n~nroff\n"))
3668 ((string-match "~" string) ; Set extended character mode.
3669 (ispell-send-string (concat string "\n")))
3670 (t (message "Invalid Ispell Parsing argument!")
3674 ;;; Can kill the current ispell process
3676 (defun ispell-buffer-local-dict (&optional no-reload)
3677 "Initializes local dictionary and local personal dictionary.
3678 If optional NO-RELOAD is non-nil, do not make any dictionary reloading.
3679 When a dictionary is defined in the buffer (see variable
3680 `ispell-dictionary-keyword'), it will override the local setting
3681 from \\[ispell-change-dictionary].
3682 Both should not be used to define a buffer-local dictionary."
3684 (goto-char (point-min))
3686 ;; Override the local variable definition.
3687 ;; Uses last occurrence of ispell-dictionary-keyword.
3688 (goto-char (point-max))
3689 (unless ispell-local-dictionary-overridden
3690 (if (search-backward ispell-dictionary-keyword nil t)
3692 (search-forward ispell-dictionary-keyword)
3693 (setq end (save-excursion (end-of-line) (point)))
3694 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3695 (setq ispell-local-dictionary
3696 (match-string-no-properties 1))))))
3697 (goto-char (point-max))
3698 (if (search-backward ispell-pdict-keyword nil t)
3700 (search-forward ispell-pdict-keyword)
3701 (setq end (save-excursion (end-of-line) (point)))
3702 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3703 (setq ispell-local-pdict
3704 (match-string-no-properties 1)))))))
3706 ;; Reload if new dictionary (maybe the personal one) defined.
3707 (ispell-internal-change-dictionary)))
3710 (defun ispell-buffer-local-words ()
3711 "Loads the buffer-local dictionary in the current buffer."
3712 ;; If there's an existing ispell process that's wrong for this use,
3714 (if (and ispell-buffer-local-name
3715 (not (equal ispell-buffer-local-name (buffer-name))))
3716 (ispell-kill-ispell t))
3717 ;; Actually start a new ispell process, because we need
3718 ;; to send commands now to specify the local words to it.
3719 (ispell-init-process)
3721 (goto-char (point-min))
3722 (while (search-forward ispell-words-keyword nil t)
3723 (or ispell-buffer-local-name
3724 (setq ispell-buffer-local-name (buffer-name)))
3725 (let ((end (save-excursion (end-of-line) (point)))
3726 (ispell-casechars (ispell-get-casechars))
3728 ;; buffer-local words separated by a space, and can contain
3729 ;; any character other than a space. Not rigorous enough.
3730 (while (re-search-forward " *\\([^ ]+\\)" end t)
3731 (setq string (match-string-no-properties 1))
3732 ;; This can fail when string contains a word with illegal chars.
3733 ;; Error handling needs to be added between ispell and emacs.
3734 (if (and (< 1 (length string))
3735 (equal 0 (string-match ispell-casechars string)))
3736 (ispell-send-string (concat "@" string "\n"))))))))
3739 ;;; returns optionally adjusted region-end-point.
3741 (defun ispell-add-per-file-word-list (word)
3742 "Add WORD to the per-file word list."
3743 (or ispell-buffer-local-name
3744 (setq ispell-buffer-local-name (buffer-name)))
3746 (goto-char (point-min))
3747 (let ((old-case-fold-search case-fold-search)
3748 line-okay search done found)
3750 (setq case-fold-search nil
3751 search (search-forward ispell-words-keyword nil 'move)
3752 found (or found search)
3753 line-okay (< (+ (length word) 1 ; 1 for space after word..
3754 (progn (end-of-line) (current-column)))
3756 case-fold-search old-case-fold-search)
3757 (if (or (and search line-okay)
3764 (unless found (newline))
3765 (insert (concat comment-start " " ispell-words-keyword))
3766 (if (> (length comment-end) 0)
3769 (insert comment-end)))))
3770 (insert (concat " " word))))))))
3772 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3777 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3779 ;;; Local Variable options:
3780 ;;; mode: name(-mode)
3781 ;;; eval: expression
3782 ;;; local-variable: value
3784 ;;; The following sets the buffer local dictionary to `american' English
3785 ;;; and spell checks only comments.
3787 ;;; Local Variables:
3788 ;;; mode: emacs-lisp
3789 ;;; comment-column: 40
3790 ;;; ispell-check-comments: exclusive
3791 ;;; ispell-local-dictionary: "american"
3795 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3797 ;;; The following places this file in nroff parsing and extended char modes.
3798 ;;; Local IspellParsing: nroff-mode ~nroff
3799 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3800 ;;; Local IspellPersDict ~/.ispell_lisp
3801 ;;; The following were automatically generated by ispell using the 'A' command:
3802 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3803 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3804 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3805 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3806 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3807 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3808 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3809 ; LocalWords: lns XEmacs HTML casechars Multibyte
3811 ;;; arch-tag: 4941b9f9-3b7c-4a76-a4ed-5fa8b6010ef5
3812 ;;; ispell.el ends here