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