1 ;;; ispell.el --- Interface to International Ispell Versions 3.1 and 3.2
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
5 ;; Authors : Ken Stevens <k.stevens@ieee.org>
6 ;; Stevens Mod Date: Fri Jan 28 17:16:58 PST 2000
7 ;; Stevens Revision: 3.4 beta
8 ;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
9 ;; Bug Reports : ispell-el-bugs@itcorp.com
10 ;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
30 ;; Note: version numbers and time stamp are not updated
31 ;; when this file is edited for release with GNU emacs.
37 ;; This code contains a section of user-settable variables that you
38 ;; should inspect prior to installation. Look past the end of the history
39 ;; list. Set them up for your locale and the preferences of the majority
40 ;; of the users. Otherwise the users may need to set a number of variables
42 ;; You particularly may want to change the default dictionary for your
43 ;; country and language.
44 ;; Most dictionary changes should be made in this file so all users can
45 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
46 ;; file. Modify the variable `ispell-local-dictionary-alist' to include
47 ;; these dictionaries, and they will be installed when ispell.el is loaded.
49 ;; Depending on the mail system you use, you may want to include these:
50 ;; (add-hook 'news-inews-hook 'ispell-message)
51 ;; (add-hook 'mail-send-hook 'ispell-message)
52 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
54 ;; Ispell has a TeX parser and a nroff parser (the default).
55 ;; The parsing is controlled by the variable ispell-parser. Currently
56 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
57 ;; added it will be updated. See the variable description for more info.
66 ;; ispell-comments-and-strings
68 ;; ispell-complete-word
69 ;; ispell-complete-word-interior-frag
70 ;; ispell-change-dictionary
73 ;; ispell-skip-region-alist
75 ;; Commands in ispell-region:
76 ;; Character replacement: Replace word with choice. May query-replace.
77 ;; ` ': Accept word this time.
78 ;; `i': Accept word and insert into private dictionary.
79 ;; `a': Accept word for this session.
80 ;; `A': Accept word and place in buffer-local dictionary.
81 ;; `r': Replace word with typed-in value. Rechecked.
82 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
83 ;; `?': Show these commands
84 ;; `x': Exit spelling buffer. Move cursor to original point.
85 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
86 ;; the check to be completed later.
87 ;; `q': Quit spelling session (Kills ispell process).
88 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
89 ;; `u': Like `i', but the word is lower-cased first.
90 ;; `m': Place entered value in personal dictionary, then recheck current word.
91 ;; `C-l': redraws screen
92 ;; `C-r': recursive edit
93 ;; `C-z': suspend emacs or iconify frame
95 ;; Buffer-Local features:
96 ;; There are a number of buffer-local features that can be used to customize
97 ;; ispell for the current buffer. This includes language dictionaries,
98 ;; personal dictionaries, parsing, and local word spellings. Each of these
99 ;; local customizations are done either through local variables, or by
100 ;; including the keyword and argument(s) at the end of the buffer (usually
101 ;; prefixed by the comment characters). See the end of this file for
102 ;; examples. The local keywords and variables are:
104 ;; ispell-dictionary-keyword language-dictionary
105 ;; uses local variable ispell-local-dictionary
106 ;; ispell-pdict-keyword personal-dictionary
107 ;; uses local variable ispell-local-pdict
108 ;; ispell-parsing-keyword mode-arg extended-char-arg
109 ;; ispell-words-keyword any number of local word spellings
112 ;; Place new regular expression definitions of regions you prefer not to
113 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
114 ;; be added to latex by modifying `ispell-tex-skip-alists'.
115 ;; `ispell-message' contains some custom skipping code for e-mail messages.
118 ;; Need a way to select between different character mappings without separate
119 ;; dictionary entries.
120 ;; Multi-byte characters if not defined by current dictionary may result in the
121 ;; evil "misalignment error" in some versions of MULE emacs.
122 ;; On some versions of emacs, growing the minibuffer fails.
123 ;; see `ispell-help-in-bufferp'.
124 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
125 ;; can cause misalignment errors.
129 ;; Modifications made in latest versions:
131 ;; Revision 3.4 beta 2000/1/28 17:16:58 kss
132 ;; one arg always for xemacs sleep-for (gunnar Evermann)
133 ;; support for synchronous processes (Eli Zaretskii)
135 ;; Revision 3.3 1999/11/29 11:38:34 kss
136 ;; Only word replacements entered in from the keyboard are rechecked.
137 ;; This fixes a bug in tex parsing and misalignment.
138 ;; Exceptions exist for recursive edit and query-replace, with tex error
139 ;; condition tested. Recursive editing improved.
140 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
141 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
142 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
143 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
146 ;; Revision 3.2 1999/5/7 14:25:14 kss
147 ;; Accept ispell versions 3.X.Y where X>=1
148 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
149 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
150 ;; Fixed bug in TeX parsing when math commands are in the comments.
151 ;; Removed calls to `when' macro.
153 ;; Revision 3.1 1998/12/1 13:21:52 kss
154 ;; Improved and fixed customize support.
155 ;; Improved and fixed comments in variables and messages.
156 ;; A coding system is now required for all languages.
157 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
158 ;; Dictionary norsk7-tex removed. Dictionary polish added.
159 ;; Dictionaries redefined at load-time to support dictionary changes.
160 ;; Menu redefined at load time to support dictionary changes.
161 ;; ispell-check-version added as an alias for `check-ispell-version'.
162 ;; Spelling suggestions returned in order generated by ispell.
163 ;; Small bug fixed in matching ispell error messages.
164 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
165 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
166 ;; Multibyte character coding support added for process interactions.
167 ;; Ensure ispell process has terminated before starting new process.
168 ;; This can otherwise confuse process filters and hang ispell.
169 ;; Improved skipping support for SGML.
170 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
171 ;; Improved message reference matching in `ispell-message'.
172 ;; Fixed bug in returning to nroff mode from tex mode.
177 ;;; Custom.el macros require recompiling this when they are not present.
178 ;;; Add in backward compatible custom support.
180 (if (not (fboundp 'defcustom))
181 (defmacro defcustom (symbol value doc &rest args)
182 "Empty replacement for defcustom when not supplied."
183 `(defvar ,symbol ,value ,doc))))
186 (if (fboundp 'defgroup)
188 "User variables for emacs ispell interface."
189 :group 'applications)))
191 (if (not (fboundp 'buffer-substring-no-properties))
192 (defun buffer-substring-no-properties (start end)
193 (buffer-substring start end)))
196 (defconst xemacsp (string-match "Lucid\\|XEmacs" emacs-version)
197 "Non nil if using XEmacs.")
200 (defconst version18p (string-match "18\\.[0-9]+\\.[0-9]+" emacs-version)
201 "Non nil if using emacs version 18.")
204 (defconst version20p (string-match "20\\.[0-9]+\\.[0-9]+" emacs-version)
205 "Non nil if using emacs version 20.")
207 (and (not version18p)
208 (not (boundp 'epoch::version))
209 (defalias 'ispell-check-version 'check-ispell-version))
212 ;;; **********************************************************************
213 ;;; The following variables should be set according to personal preference
214 ;;; and location of binaries:
215 ;;; **********************************************************************
218 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
220 (defcustom ispell-highlight-p 'block
221 "*Highlight spelling errors when non-nil.
222 When set to `block', assumes a block cursor with TTY displays."
223 :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t))
226 (defcustom ispell-highlight-face 'highlight
227 "*The face used for Ispell highlighting. For Emacses with overlays.
228 Possible values are `highlight', `modeline', `secondary-selection',
229 `region', and `underline'.
230 This variable can be set by the user to whatever face they desire.
231 It's most convenient if the cursor color and highlight color are
236 (defcustom ispell-check-comments t
237 "*Spelling of comments checked when non-nil.
238 When set to `exclusive', ONLY comments are checked. (For code comments).
239 Warning! Not checking comments, when a comment start is embedded in strings,
240 may produce undesired results."
241 :type '(choice (const exclusive) (const :tag "off" nil) (const :tag "on" t))
244 (defcustom ispell-query-replace-choices nil
245 "*Corrections made throughout region when non-nil.
246 Uses `query-replace' (\\[query-replace]) for corrections."
250 (defcustom ispell-skip-tib nil
251 "*Does not spell check `tib' bibliography references when non-nil.
252 Skips any text between strings matching regular expressions
253 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
255 TeX users beware: Any field starting with [. will skip until a .] -- even
256 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
257 a [.5mm] type of number...."
261 (defvar ispell-tib-ref-beginning "[[<]\\."
262 "Regexp matching the beginning of a Tib reference.")
264 (defvar ispell-tib-ref-end "\\.[]>]"
265 "Regexp matching the end of a Tib reference.")
267 (defcustom ispell-keep-choices-win t
268 "*When not nil, the `*Choices*' window remains for spelling session.
269 This minimizes redisplay thrashing."
273 (defcustom ispell-choices-win-default-height (if xemacsp 3 2)
274 "*The default size of the `*Choices*' window, including mode line.
275 Must be greater than 1.
276 XEmacs modeline is thicker than a line of text, so it partially covers the
277 last line of text in the buffer. Include an extra line in XEmacs to see
278 all of the choices clearly."
282 (defcustom ispell-program-name "ispell"
283 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
287 (defcustom ispell-alternate-dictionary
288 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
289 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
290 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
291 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
292 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
293 ((file-exists-p "/sys/dict") "/sys/dict")
294 (t "/usr/dict/words"))
295 "*Alternate dictionary for spelling help."
296 :type '(choice file (const :tag "None" nil))
299 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
300 "*Dictionary used for word completion."
301 :type '(choice file (const :tag "None" nil))
304 (defcustom ispell-message-dictionary-alist nil
305 "*List used by `ispell-message' to select a new dictionary.
306 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
307 in the message headers, `ispell-local-dictionary' will be set to
308 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
309 E.g. you may use the following value:
310 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
311 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
312 :type '(repeat (cons regexp string))
316 (defcustom ispell-grep-command "egrep"
317 "Name of the grep command for search processes."
321 (defcustom ispell-grep-options "-i"
322 "String of options to use when running the program in `ispell-grep-command'.
323 Should probably be \"-i\" or \"-e\".
324 Some machines (like the NeXT) don't support \"-i\""
328 (defcustom ispell-look-command
329 (cond ((file-exists-p "/bin/look") "/bin/look")
330 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
331 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
333 "Name of the look command for search processes.
334 This must be an absolute file name."
338 (defcustom ispell-look-p (file-exists-p ispell-look-command)
339 "*Non-nil means use `look' rather than `grep'.
340 Default is based on whether `look' seems to be available."
344 (defcustom ispell-have-new-look nil
345 "*Non-nil means use the `-r' option (regexp) when running `look'."
349 (defcustom ispell-look-options (if ispell-have-new-look "-dfr" "-df")
350 "String of command options for `ispell-look-command'."
354 (defcustom ispell-use-ptys-p nil
355 "When non-nil, Emacs uses ptys to communicate with Ispell.
356 When nil, Emacs uses pipes."
360 (defcustom ispell-following-word nil
361 "*Non-nil means `ispell-word' checks the word around or after point.
362 Otherwise `ispell-word' checks the preceding word."
366 (defcustom ispell-help-in-bufferp nil
367 "*Non-nil means display interactive keymap help in a buffer.
368 The following values are supported:
369 nil Expand the minibuffer and display a short help message
370 there for a couple of seconds.
371 t Pop up a new buffer and display a short help message there
372 for a couple of seconds.
373 electric Pop up a new buffer and display a long help message there.
374 User can browse and then exit the help mode."
375 :type '(choice (const electric) (const :tag "off" nil) (const :tag "on" t))
378 (defcustom ispell-quietly nil
379 "*Non-nil means suppress messages in `ispell-word'."
383 (defcustom ispell-format-word (function upcase)
384 "*Formatting function for displaying word being spell checked.
385 The function must take one string argument and return a string."
389 (defcustom ispell-use-framepop-p nil
390 "When non-nil ispell uses framepop to display choices in a dedicated frame.
391 You can set this variable to dynamically use framepop if you are in a
392 window system by evaluating the following on startup to set this variable:
393 (and window-system (condition-case () (require 'framepop) (error nil)))"
398 (defcustom ispell-personal-dictionary nil
399 "*File name of your personal spelling dictionary, or nil.
400 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
401 where DICTNAME is the name of your default dictionary."
403 (const :tag "default" nil))
406 (defcustom ispell-silently-savep nil
407 "*When non-nil, save the personal dictionary without confirmation."
411 ;;; This is the local dictionary to use. When nil the default dictionary will
412 ;;; be used. Change set-default call to use a new default dictionary.
413 (defcustom ispell-local-dictionary nil
414 "If non-nil, the dictionary to be used for Ispell commands.
415 The value must be a string dictionary name in `ispell-dictionary-alist'.
416 This variable becomes buffer-local when set in any fashion.
418 Setting `ispell-local-dictionary' to a value has the same effect as
419 calling \\[ispell-change-dictionary] with that value. This variable
420 is automatically set when defined in the file with either
421 `ispell-dictionary-keyword' or the Local Variable syntax.
423 To create a non-standard default dictionary (not from `ispell-dictionary-alist')
424 call function `set-default' with the new dictionary name."
425 :type '(choice string
426 (const :tag "default" nil))
429 (make-variable-buffer-local 'ispell-local-dictionary)
431 ;; Call this function set up the default dictionary if not English.
432 ;;(set-default 'ispell-local-dictionary nil)
435 (defcustom ispell-extra-args nil
436 "*If non-nil, a list of extra switches to pass to the Ispell program.
437 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
438 words as correct. See also `ispell-dictionary-alist', which may be used
439 for language-specific arguments."
440 :type '(repeat string)
445 (defcustom ispell-skip-sgml 'use-mode-name
446 "*Indicates whether ispell should skip spell checking of SGML markup.
447 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
448 guess whether SGML markup should be skipped according to the name of the
449 buffer's major mode."
450 :type '(choice (const :tag "always" t) (const :tag "never" nil)
451 (const :tag "use-mode-name" use-mode-name))
455 ;;; Define definitions here only for personal dictionaries.
457 (defcustom ispell-local-dictionary-alist nil
458 "*Contains local or customized dictionary definitions.
459 See `ispell-dictionary-alist'."
460 :type '(repeat (list (choice :tag "Dictionary"
461 (string :tag "Dictionary name")
462 (const :tag "default" nil))
463 (regexp :tag "Case characters")
464 (regexp :tag "Non case characters")
465 (regexp :tag "Other characters")
466 (boolean :tag "Many other characters")
467 (repeat :tag "Ispell command line args"
469 (choice :tag "Extended character mode"
470 (const "~tex") (const "~plaintex")
471 (const "~nroff") (const "~list")
472 (const "~latin1") (const "~latin3")
473 (const :tag "default" nil))
474 (choice :tag "Character set"
481 ;;; split dictionary so line length is smaller in loaddefs.el
483 ;;; First part of dictionary, shortened for loaddefs.el
486 ispell-dictionary-alist-1
487 '((nil ; default (English.aff)
488 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
489 ("american" ; Yankee English
490 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
491 ("brasileiro" ; Brazilian mode
492 "[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]"
493 "[^A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
494 "[']" nil ("-d" "brasileiro") nil iso-8859-1)
495 ("british" ; British version
496 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "british") nil iso-8859-1)
497 ("castellano" ; Spanish mode
498 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
499 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
500 "[---]" nil ("-B" "-d" "castellano") "~tex" iso-8859-1)
501 ("castellano8" ; 8 bit Spanish mode
502 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
503 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
504 "[---]" nil ("-B" "-d" "castellano") "~latin1" iso-8859-1)))
507 ;;; Second part of dictionary, shortened for loaddefs.el
510 ispell-dictionary-alist-2
512 "[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]"
513 "[^A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
514 "" nil ("-B" "-d" "czech") nil iso-8859-2)
516 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
517 "[']" nil ("-C") nil iso-8859-1)
518 ("deutsch" ; Deutsch.aff
519 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
521 "[a-zA-Z\304\326\334\344\366\337\374]"
522 "[^a-zA-Z\304\326\334\344\366\337\374]"
523 "[']" t ("-C" "-d" "deutsch") "~latin1" iso-8859-1)
524 ("english" ; make English explicitly selectable
525 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)))
528 ;;; Third part of dictionary, shortened for loaddefs.el
531 ispell-dictionary-alist-3
533 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
534 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
535 "[-']" t ("-C") "~latin3" iso-8859-1)
537 "[A-Za-z^\\]" "[^A-Za-z^\\]"
538 "[-'`\"]" t ("-C" "-d" "esperanto") "~tex" iso-8859-1)
540 "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil iso-8859-1)
541 ("francais" ; Francais.aff
542 "[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]"
543 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
544 "[---']" t nil "~list" iso-8859-1)))
547 ;;; Fourth part of dictionary, shortened for loaddefs.el
550 ispell-dictionary-alist-4
551 '(("francais-tex" ; Francais.aff
552 "[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\\]"
553 "[^A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
554 "[---'^`\"]" t nil "~tex" iso-8859-1)
555 ("nederlands" ; Nederlands.aff
556 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
557 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
558 "[']" t ("-C") nil iso-8859-1)
559 ("nederlands8" ; Dutch8.aff
560 "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
561 "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
562 "[']" t ("-C") nil iso-8859-1)))
565 ;;; Fifth part of dictionary, shortened for loaddefs.el
568 ispell-dictionary-alist-5
569 '(("norsk" ; 8 bit Norwegian mode
570 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
571 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
572 "[\"]" nil ("-d" "norsk") "~list" iso-8859-1)
573 ("norsk7-tex" ; 7 bit Norwegian TeX mode
574 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
575 "[\"]" nil ("-d" "norsk") "~plaintex" iso-8859-1)
576 ("polish" ; polish mode
577 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
578 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
579 "" nil ( "-d" "polish") nil iso-8859-2)))
582 ;;; Sixth part of dictionary, shortened for loaddefs.el
585 ispell-dictionary-alist-6
586 ;; include Russian iso character set too?
587 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
588 '(("russian" ; Russian.aff (KOI8-R charset)
589 "[\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]"
590 "[^\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]"
591 "" nil ("-d" "russian") nil koi8-r)
592 ("svenska" ; Swedish mode
593 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
594 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
595 "[']" nil ("-C") "~list" iso-8859-1)))
600 (defcustom ispell-dictionary-alist
601 (append ispell-local-dictionary-alist ; dictionary customizations
602 ispell-dictionary-alist-1 ispell-dictionary-alist-2
603 ispell-dictionary-alist-3 ispell-dictionary-alist-4
604 ispell-dictionary-alist-5 ispell-dictionary-alist-6)
605 "An alist of dictionaries and their associated parameters.
607 Each element of this list is also a list:
609 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
610 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
612 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
613 nil means the default dictionary.
615 CASECHARS is a regular expression of valid characters that comprise a
618 NOT-CASECHARS is the opposite regexp of CASECHARS.
620 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
621 used to construct words in some special way. If OTHERCHARS characters follow
622 and precede characters from CASECHARS, they are parsed as part of a word,
623 otherwise they become word-breaks. As an example in English, assume the
624 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
625 \"Steven's\" are parsed as single words including the \"'\" character, but
626 \"Stevens'\" does not include the quote character as part of the word.
627 If you want OTHERCHARS to be empty, use the empty string.
628 Hint: regexp syntax requires the hyphen to be declared first here.
630 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
631 Otherwise only a single OTHERCHARS character is allowed to be part of any
634 ISPELL-ARGS is a list of additional arguments passed to the ispell
637 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
638 have been configured in an Ispell affix file. (For example, umlauts
639 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
640 in English. This has the same effect as the command-line `-T' option.
641 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
642 but the dictionary can control the extended character mode.
643 Both defaults can be overruled in a buffer-local fashion. See
644 `ispell-parsing-keyword' for details on this.
646 CHARACTER-SET used for languages with multibyte characters.
648 Note that the CASECHARS and OTHERCHARS slots of the alist should
649 contain the same character set as casechars and otherchars in the
650 LANGUAGE.aff file \(e.g., english.aff\)."
651 :type '(repeat (list (choice :tag "Dictionary"
652 (string :tag "Dictionary name")
653 (const :tag "default" nil))
654 (regexp :tag "Case characters")
655 (regexp :tag "Non case characters")
656 (regexp :tag "Other characters")
657 (boolean :tag "Many other characters")
658 (repeat :tag "Ispell command line args"
660 (choice :tag "Extended character mode"
661 (const "~tex") (const "~plaintex")
662 (const "~nroff") (const "~list")
663 (const "~latin1") (const "~latin3")
664 (const :tag "default" nil))
665 (choice :tag "Character set"
671 ;;; update the dictionaries at load time
672 (setq ispell-dictionary-alist
673 (append ispell-local-dictionary-alist ; dictionary customizations
674 ispell-dictionary-alist-1 ispell-dictionary-alist-2
675 ispell-dictionary-alist-3 ispell-dictionary-alist-4
676 ispell-dictionary-alist-5 ispell-dictionary-alist-6))
681 ;;; **********************************************************************
682 ;;; The following are used by ispell, and should not be changed.
683 ;;; **********************************************************************
687 ;;; The version must be 3.1 or greater for this version of ispell.el
688 ;;; There is an incompatibility between version 3.1.12 and lower versions.
689 (defconst ispell-required-version '(3 1 12)
690 "Ispell versions with which this version of ispell.el is known to work.")
691 (defvar ispell-offset -1
692 "Offset that maps protocol differences between ispell 3.1 versions.")
694 (defconst ispell-version "ispell.el 3.4 beta -- Fri Jan 28 17:16:58 PST 2000")
697 (defun check-ispell-version (&optional interactivep)
698 "Ensure that `ispell-program-name' is valid and the correct version.
699 Returns version number if called interactively.
700 Otherwise returns the library path if defined."
701 ;; This is a little wasteful as we actually launch ispell twice: once
702 ;; to make sure it's the right version, and once for real. But people
703 ;; get confused by version mismatches *all* the time (and I've got the
704 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
705 ;; option is the only way I can think of to do this that works with
706 ;; all versions, since versions earlier than 3.0.09 didn't identify
707 ;; themselves on startup.
709 (let ((case-fold-search-val case-fold-search)
710 ;; avoid bugs when syntax of `.' changes in various default modes
711 (default-major-mode 'fundamental-mode)
714 (set-buffer (get-buffer-create " *ispell-tmp*"))
716 (setq status (call-process ispell-program-name nil t nil "-vv"))
717 (goto-char (point-min))
721 (setq result (concat (buffer-substring-no-properties (point-min)
726 ;; return library path.
727 (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t)
728 (if (match-beginning 0)
729 (setq result (buffer-substring (match-beginning 1) (match-end 1)))))
730 (goto-char (point-min))
731 (if (not (memq status '(0 nil)))
732 (error "%s exited with %s %s" ispell-program-name
733 (if (stringp status) "signal" "code") status))
734 (setq case-fold-search t
735 status (re-search-forward
737 (format "%d" (car ispell-required-version))
738 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
740 case-fold-search case-fold-search-val)
741 (if (or (not status) ; major version mismatch
742 (< (car (read-from-string (buffer-substring-no-properties
743 (match-beginning 2) (match-end 2))))
744 (car (cdr ispell-required-version)))) ; minor version mismatch
745 (error "%s version 3 release %d.%d.%d or greater is required"
746 ispell-program-name (car ispell-required-version)
747 (car (cdr ispell-required-version))
748 (car (cdr (cdr ispell-required-version))))
749 ;; check that it is the correct version.
750 (if (and (= (car (read-from-string (buffer-substring-no-properties
751 (match-beginning 2)(match-end 2))))
752 (car (cdr ispell-required-version)))
753 (< (car (read-from-string (buffer-substring-no-properties
754 (match-beginning 3)(match-end 3))))
755 (car (cdr (cdr ispell-required-version)))))
756 (setq ispell-offset 0)))
757 (kill-buffer (current-buffer)))
762 ;;; The preparation of the menu bar menu must be autoloaded
763 ;;; because otherwise this file gets autoloaded every time Emacs starts
764 ;;; so that it can set up the menus and determine keyboard equivalents.
768 (defvar ispell-menu-map nil "Key map for ispell menu.")
769 ;;; redo menu when loading ispell to get dictionary modifications
770 (setq ispell-menu-map nil)
773 (defvar ispell-menu-xemacs nil
774 "Spelling menu for XEmacs.
775 If nil when package is loaded, a standard menu will be set,
776 and added as a submenu of the \"Edit\" menu.")
778 ;;; Break out XEmacs menu and split into several calls to avoid having
779 ;;; long lines in loaddefs.el. Detect need off following constant.
781 ;;; Set up dictionary
783 (defvar ispell-menu-map-needed
784 ;; only needed when not version 18 and not XEmacs.
785 (and (not ispell-menu-map)
790 (defvar ispell-library-path (check-ispell-version)
791 "The directory where ispell dictionaries reside.")
795 (if ispell-menu-map-needed
796 (let ((dicts (reverse (cons (cons "default" nil) ispell-dictionary-alist)))
797 ;; `ispell-library-path' intentionally not defined in autoload
798 (path (and (boundp 'ispell-library-path) ispell-library-path))
800 (setq ispell-menu-map (make-sparse-keymap "Spell"))
801 ;; add the dictionaries to the bottom of the list.
803 (setq name (car (car dicts))
804 load-dict (car (cdr (member "-d" (nth 5 (car dicts)))))
806 (cond ((not (stringp name))
807 (define-key ispell-menu-map (vector 'default)
808 (cons "Select Default Dict"
809 (cons "Dictionary for which Ispell was configured"
810 (list 'lambda () '(interactive)
812 'ispell-change-dictionary "default"))))))
813 ((or (not path) ; load all if library dir not defined
814 (file-exists-p (concat path "/" name ".hash"))
815 (file-exists-p (concat path "/" name ".has"))
817 (or (file-exists-p(concat path "/" load-dict ".hash"))
818 (file-exists-p(concat path "/" load-dict ".has")))))
819 (define-key ispell-menu-map (vector (intern name))
820 (cons (concat "Select " (capitalize name) " Dict")
821 (list 'lambda () '(interactive)
822 (list 'ispell-change-dictionary name)))))))))
825 ;;; define commands in menu in opposite order you want them to appear.
827 (if ispell-menu-map-needed
829 (define-key ispell-menu-map [ispell-change-dictionary]
830 '(menu-item "Change Dictionary..." ispell-change-dictionary
831 :help "Supply explicit path to dictionary"))
832 (define-key ispell-menu-map [ispell-kill-ispell]
833 '(menu-item "Kill Process" ispell-kill-ispell
834 :enable (and (boundp 'ispell-process) ispell-process
835 (eq (ispell-process-status) 'run))
836 :help "Terminate Ispell subprocess"))
837 (define-key ispell-menu-map [ispell-pdict-save]
838 '(menu-item "Save Dictionary"
839 (lambda ()(interactive) (ispell-pdict-save t t))
840 :help "Save personal dictionary"))
841 (define-key ispell-menu-map [ispell-help]
842 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
845 (lambda () (interactive) (describe-function 'ispell-help))
846 :help "Show standard Ispell keybindings and commands"))
847 (define-key ispell-menu-map [ispell-complete-word]
848 '(menu-item "Complete Word" ispell-complete-word
849 :help "Complete word at cursor using dictionary"))
850 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
851 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
852 :help "Complete word fragment at cursor"))))
855 (if ispell-menu-map-needed
857 (define-key ispell-menu-map [ispell-continue]
858 '(menu-item "Continue Spell-Checking" ispell-continue
859 :enable (and (boundp 'ispell-region-end)
860 (marker-position ispell-region-end)
861 (equal (marker-buffer ispell-region-end)
863 (define-key ispell-menu-map [ispell-word]
864 '(menu-item "Spell-Check Word" ispell-word
865 :help "Spell-check word at cursor"))
866 (define-key ispell-menu-map [ispell-comments-and-strings]
867 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
868 :help "Spell-check only comments and strings"))))
871 (if ispell-menu-map-needed
873 (define-key ispell-menu-map [ispell-region]
874 '(menu-item "Spell-Check Region" ispell-region
876 :help "Spell-check text in marked region"))
877 (define-key ispell-menu-map [ispell-message]
878 '(menu-item "Spell-Check Message" ispell-message
879 :help "Skip headers and included message text"))
880 (define-key ispell-menu-map [ispell-buffer]
881 '(menu-item "Spell-Check Buffer" ispell-buffer))
882 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
884 ;;; XEmacs versions 19 & 20
888 (null ispell-menu-xemacs)
889 (not (and (boundp 'infodock-version) infodock-version)))
890 (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
891 (current-menubar (or current-menubar default-menubar))
893 '(["Help" (describe-function 'ispell-help) t]
894 ;;["Help" (popup-menu ispell-help-list) t]
895 ["Check Message" ispell-message t]
896 ["Check Buffer" ispell-buffer t]
897 ["Check Comments" ispell-comments-and-strings t]
898 ["Check Word" ispell-word t]
899 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
900 ["Continue Check" ispell-continue t]
901 ["Complete Word Frag"ispell-complete-word-interior-frag t]
902 ["Complete Word" ispell-complete-word t]
903 ["Kill Process" ispell-kill-ispell t]
905 ["Save Personal Dict"(ispell-pdict-save t t) t]
906 ["Change Dictionary" ispell-change-dictionary t]
907 ["Select Default" (ispell-change-dictionary "default") t]))
910 (setq name (car (car dicts))
911 load-dict (car (cdr (member "-d" (nth 5 (car dicts)))))
913 ;; Include if the dictionary is in the library, or path not defined.
914 (if (and (stringp name)
915 (or (not ispell-library-path)
916 (file-exists-p (concat ispell-library-path "/"
918 (file-exists-p (concat ispell-library-path "/"
921 (or (file-exists-p (concat ispell-library-path "/"
923 (file-exists-p (concat ispell-library-path "/"
924 load-dict ".has"))))))
925 (setq menu (append menu
927 (vector (concat "Select " (capitalize name))
928 (list 'ispell-change-dictionary name)
930 (setq ispell-menu-xemacs menu)
933 (delete-menu-item '("Edit" "Spell")) ; in case already defined
934 (add-menu '("Edit") "Spell" ispell-menu-xemacs)))))
936 ;;; Allow incrementing characters as integers in XEmacs 20
939 (fset 'ispell-int-char 'int-char)
940 ;; Emacs and XEmacs 19 or earlier
941 (fset 'ispell-int-char 'identity))
944 ;;; **********************************************************************
947 ;;; This variable contains the current dictionary being used if the ispell
948 ;;; process is running. Otherwise it contains the global default.
949 (defvar ispell-dictionary nil
950 "The name of the current dictionary, or nil for the default.
951 When `ispell-local-dictionary' is nil, `ispell-dictionary' is used to select
952 the dictionary for new buffers.
954 This is passed to the ispell process using the `-d' switch and is
955 used as key in `ispell-dictionary-alist' (which see).")
957 (defun ispell-decode-string (str)
958 "Decodes multibyte character strings.
959 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
961 (and (boundp 'enable-multibyte-characters)
962 enable-multibyte-characters))
963 (fboundp 'decode-coding-string)
964 (ispell-get-coding-system))
965 (decode-coding-string str (ispell-get-coding-system))
968 (defun ispell-get-casechars ()
969 (ispell-decode-string
970 (nth 1 (assoc ispell-dictionary ispell-dictionary-alist))))
971 (defun ispell-get-not-casechars ()
972 (ispell-decode-string
973 (nth 2 (assoc ispell-dictionary ispell-dictionary-alist))))
974 (defun ispell-get-otherchars ()
975 (ispell-decode-string
976 (nth 3 (assoc ispell-dictionary ispell-dictionary-alist))))
977 (defun ispell-get-many-otherchars-p ()
978 (nth 4 (assoc ispell-dictionary ispell-dictionary-alist)))
979 (defun ispell-get-ispell-args ()
980 (nth 5 (assoc ispell-dictionary ispell-dictionary-alist)))
981 (defun ispell-get-extended-character-mode ()
982 (nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
983 (defun ispell-get-coding-system ()
984 (nth 7 (assoc ispell-dictionary ispell-dictionary-alist)))
986 (defvar ispell-process nil
987 "The process object for Ispell.")
989 (defvar ispell-async-processp (and (fboundp 'kill-process)
990 (fboundp 'process-send-string)
991 (fboundp 'accept-process-output)
992 ;;(fboundp 'start-process)
993 ;;(fboundp 'set-process-filter)
994 ;;(fboundp 'process-kill-without-query)
996 "Non-nil means that the OS supports asynchronous processes.")
998 (defvar ispell-pdict-modified-p nil
999 "Non-nil means personal dictionary has modifications to be saved.")
1001 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1002 ;;; When non-nil, the spell session is terminated.
1003 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1004 (defvar ispell-quit nil)
1006 (defvar ispell-process-directory nil
1007 "The directory where `ispell-process' was started.")
1009 (defvar ispell-filter nil
1010 "Output filter from piped calls to Ispell.")
1012 (defvar ispell-filter-continue nil
1013 "Control variable for Ispell filter function.")
1015 (defvar ispell-output-buffer nil
1016 "Buffer used for reading output of a synchronous Ispell subprocess.")
1018 (defvar ispell-session-buffer nil
1019 "Buffer used for passing input to a synchronous Ispell subprocess.")
1021 (defvar ispell-cmd-args nil
1022 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1024 (defvar ispell-query-replace-marker (make-marker)
1025 "Marker for `query-replace' processing.")
1027 (defvar ispell-recursive-edit-marker (make-marker)
1028 "Marker for return point from recursive edit.")
1030 (defvar ispell-checking-message nil
1031 "Non-nil when we're checking a mail message.")
1033 (defconst ispell-choices-buffer "*Choices*")
1035 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1037 ;;; *** Buffer Local Definitions ***
1039 (defconst ispell-words-keyword "LocalWords: "
1040 "The keyword for local oddly-spelled words to accept.
1041 The keyword will be followed by any number of local word spellings.
1042 There can be multiple of these keywords in the file.")
1044 (defconst ispell-dictionary-keyword "Local IspellDict: "
1045 "The keyword for a local dictionary to use.
1046 The keyword must be followed by a correct dictionary name in
1047 `ispell-dictionary-alist'. When multiple occurrences exist, the last keyword
1048 definition is used.")
1050 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1051 "The keyword for defining buffer local dictionaries.
1052 Keyword must be followed by the filename of a personal dictionary.
1053 The last occurring definition in the buffer will be used.")
1055 (defconst ispell-parsing-keyword "Local IspellParsing: "
1056 "The keyword for overriding default Ispell parsing.
1057 The above keyword string should be followed by `latex-mode' or
1058 `nroff-mode' to put the current buffer into the desired parsing mode.
1060 Extended character mode can be changed for this buffer by placing
1061 a `~' followed by an extended-character mode -- such as `~.tex'.
1062 The last occurring definition in the buffer will be used.")
1065 (defvar ispell-skip-region-alist
1066 '((ispell-words-keyword forward-line)
1067 (ispell-dictionary-keyword forward-line)
1068 (ispell-pdict-keyword forward-line)
1069 (ispell-parsing-keyword forward-line)
1070 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1071 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage" . "^---* End of [Ff]orwarded [Mm]essage")
1072 ;; matches e-mail addresses, file names, http addresses, etc.
1073 ("\\(/\\|\\(\\(\\w\\|-\\)+[.:@]\\)\\)\\(\\w\\|-\\)*\\([.:/@]+\\(\\w\\|-\\|~\\)+\\)+")
1074 ;; This is a pretty complex regexp. It can be simplified to the following:
1075 ;; "\\(\\w\\|-\\)*\\([.:/@]+\\(\\w\\|-\\|~\\)+\\)+"
1076 ;; but some valid text will be skipped, e.g. "his/her". This could be
1077 ;; fixed up (at the expense of a moderately more complex regexp)
1078 ;; by not allowing "/" to be the character which triggers the
1079 ;; identification of the computer name, e.g.:
1080 ;; "\\(\\w\\|-\\)+[.:@]\\(\\w\\|-\\)*\\([.:/@]+\\(\\w\\|-\\|~\\)+\\)+"
1082 "Alist expressing beginning and end of regions not to spell check.
1083 The alist key must be a regular expression.
1084 Valid forms include:
1085 (KEY) - just skip the key.
1086 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1087 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1088 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1093 (defvar ispell-tex-skip-alists
1094 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1095 ;; All the standard LaTeX keywords from L. Lamport's guide:
1096 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1097 ;; \label, \nocite, \rule (in ispell - rest included here)
1098 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1099 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1100 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1101 ;;("\\\\author" ispell-tex-arg-end)
1102 ("\\\\bibliographystyle" ispell-tex-arg-end)
1103 ("\\\\makebox" ispell-tex-arg-end 0)
1104 ;;("\\\\epsfig" ispell-tex-arg-end)
1105 ("\\\\document\\(class\\|style\\)" .
1106 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1107 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1108 ;; equation, minipage, picture, tabular, tabular* (ispell)
1109 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1110 ("list" ispell-tex-arg-end 2)
1111 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1112 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1113 "*Lists of regions to be skipped in TeX mode.
1114 First list is used raw.
1115 Second list has key placed inside \\begin{}.
1117 Delete or add any regions you want to be automatically selected
1118 for skipping in latex mode.")
1121 (defvar ispell-local-pdict ispell-personal-dictionary
1122 "A buffer local variable containing the current personal dictionary.
1123 If non-nil, the value must be a string, which is a file name.
1125 If you specify a personal dictionary for the current buffer which is
1126 different from the current personal dictionary, the effect is similar
1127 to calling \\[ispell-change-dictionary]. This variable is automatically
1128 set when defined in the file with either `ispell-pdict-keyword' or the
1129 local variable syntax.")
1131 (make-variable-buffer-local 'ispell-local-pdict)
1133 (defvar ispell-buffer-local-name nil
1134 "Contains the buffer name if local word definitions were used.
1135 Ispell is then restarted because the local words could conflict.")
1137 (defvar ispell-parser 'use-mode-name
1138 "*Indicates whether ispell should parse the current buffer as TeX Code.
1139 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1140 Default parser is `nroff'.
1141 Currently the only other valid parser is `tex'.
1143 You can set this variable in hooks in your init file -- eg:
1145 (add-hook 'tex-mode-hook (function (lambda () (setq ispell-parser 'tex))))")
1147 (defvar ispell-region-end (make-marker)
1148 "Marker that allows spelling continuations.")
1150 (defvar ispell-check-only nil
1151 "If non-nil, `ispell-word' does not try to correct the word.")
1154 ;;; **********************************************************************
1155 ;;; **********************************************************************
1160 (define-key esc-map "$" 'ispell-word)
1163 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1164 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1165 If asynchronous subprocesses are not supported, call `ispell-filter' and
1166 pass it the output of the last ispell invocation."
1167 (if ispell-async-processp
1168 (accept-process-output ispell-process timeout-secs timeout-msecs)
1169 (if (null ispell-process)
1170 (error "No Ispell process to read output from!")
1171 (let ((buf ispell-output-buffer)
1173 (if (not (bufferp buf))
1174 (setq ispell-filter nil)
1177 (setq ispell-output (buffer-substring-no-properties
1178 (point-min) (point-max))))
1179 (ispell-filter t ispell-output)
1182 (erase-buffer)))))))
1185 (defun ispell-send-string (string)
1186 "Send the string STRING to the Ispell process."
1187 (if ispell-async-processp
1188 (process-send-string ispell-process string)
1189 ;; Asynchronous subprocesses aren't supported on this losing system.
1190 ;; We keep all the directives passed to Ispell during the entire
1191 ;; session in a buffer, and pass them anew each time we invoke
1192 ;; Ispell to process another chunk of text. (Yes, I know this is a
1193 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1194 (let ((cmd (aref string 0))
1195 ;; The following commands are not passed to Ispell until
1196 ;; we have a *reall* reason to invoke it.
1197 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1198 (default-major-mode 'fundamental-mode)
1199 (session-buf ispell-session-buffer)
1200 (output-buf ispell-output-buffer)
1201 (ispell-args ispell-cmd-args)
1202 (defdir ispell-process-directory)
1205 (set-buffer session-buf)
1206 (setq prev-pos (point))
1207 (setq default-directory defdir)
1209 (if (not (memq cmd cmds-to-defer))
1210 (let (coding-system-for-read coding-system-for-write status)
1212 (and (boundp 'enable-multibyte-characters)
1213 enable-multibyte-characters))
1214 (setq coding-system-for-read (ispell-get-coding-system)
1215 coding-system-for-write (ispell-get-coding-system)))
1216 (set-buffer output-buf)
1218 (set-buffer session-buf)
1220 (apply 'call-process-region (point-min) (point-max)
1221 ispell-program-name nil
1223 "-a" "-m" ispell-args))
1224 (set-buffer output-buf)
1225 (goto-char (point-min))
1227 (if (not (looking-at "@(#) "))
1228 (error "Ispell error: %s"
1229 (buffer-substring-no-properties
1230 (point) (progn (end-of-line) (point)))))
1231 ;; If STRING is "^Z\n", we just started Ispell and need
1232 ;; to retain its version ID line in the output buffer.
1233 ;; Otherwise, remove the ID line, as it will confuse
1235 (or (string= string "\032\n")
1238 (delete-region (point-min) (point))))
1239 ;; If STRING begins with ^ or any normal character, we need
1240 ;; to remove the last line from the session buffer, since it
1241 ;; was just spell-checked, and we don't want to check it again.
1242 ;; The same goes for the # command, since Ispell already saved
1243 ;; the personal dictionary.
1244 (set-buffer session-buf)
1245 (delete-region prev-pos (point))
1246 ;; Ispell run synchronously saves the personal dictionary
1247 ;; after each successful command. So we can remove any
1248 ;; lines in the session buffer that insert words into the
1250 (if (memq status '(0 nil))
1251 (let ((more-lines t))
1252 (goto-char (point-min))
1254 (if (looking-at "^\\*")
1255 (let ((start (point)))
1257 (delete-region start (point)))
1258 (setq more-lines (= 0 (forward-line))))))))))))))
1263 (defun ispell-word (&optional following quietly continue)
1264 "Check spelling of word under or before the cursor.
1265 If the word is not found in dictionary, display possible corrections
1266 in a window allowing you to choose one.
1268 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1269 is non-nil when called interactively, then the following word
1270 \(rather than preceding\) is checked when the cursor is not over a word.
1271 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1272 when called interactively, non-corrective messages are suppressed.
1274 With a prefix argument (or if CONTINUE is non-nil),
1275 resume interrupted spell-checking of a buffer or region.
1277 Word syntax described by `ispell-dictionary-alist' (which see).
1279 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1280 or \\[ispell-region] to update the Ispell process.
1283 nil word is correct or spelling is accpeted.
1284 0 word is inserted into buffer-local definitions.
1285 \"word\" word corrected from word list.
1286 \(\"word\" arg\) word is hand entered.
1287 quit spell session exited."
1289 (interactive (list nil nil current-prefix-arg))
1293 (setq following ispell-following-word
1294 quietly ispell-quietly))
1295 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1296 (let ((cursor-location (point)) ; retain cursor location
1297 (word (ispell-get-word following))
1298 start end poss new-word replace)
1299 ;; De-structure return word info list.
1300 (setq start (car (cdr word))
1301 end (car (cdr (cdr word)))
1304 ;; now check spelling of word if it has 3 or more characters.
1306 ((> (length word) 2)
1308 (message "Checking spelling of %s..."
1309 (funcall ispell-format-word word)))
1310 (ispell-send-string "%\n") ; put in verbose mode
1311 (ispell-send-string (concat "^" word "\n"))
1312 ;; wait until ispell has processed word
1314 (ispell-accept-output)
1315 (not (string= "" (car ispell-filter)))))
1316 ;;(ispell-send-string "!\n") ;back to terse mode.
1317 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1318 (if (and ispell-filter (listp ispell-filter))
1319 (if (> (length ispell-filter) 1)
1320 (error "Ispell and its process have different character maps.")
1321 (setq poss (ispell-parse-output (car ispell-filter)))))
1324 (message "%s is correct"
1325 (funcall ispell-format-word word))))
1328 (message "%s is correct because of root %s"
1329 (funcall ispell-format-word word)
1330 (funcall ispell-format-word poss))))
1331 ((null poss) (message "Error in ispell process"))
1332 (ispell-check-only ; called from ispell minor mode.
1334 (message "%s is incorrect" (funcall ispell-format-word word)))
1335 (t ; prompt for correct word.
1336 (save-window-excursion
1337 (setq replace (ispell-command-loop
1338 (car (cdr (cdr poss)))
1339 (car (cdr (cdr (cdr poss))))
1340 (car poss) start end)))
1341 (cond ((equal 0 replace)
1342 (ispell-add-per-file-word-list (car poss)))
1344 (setq new-word (if (atom replace) replace (car replace))
1345 cursor-location (+ (- (length word) (- end start))
1347 (if (not (equal new-word (car poss)))
1349 (delete-region start end)
1350 (setq start (point))
1352 (setq end (point))))
1353 (if (not (atom replace)) ;recheck spelling of replacement
1355 (if (car (cdr replace)) ; query replace requested
1356 (save-window-excursion
1357 (query-replace word new-word t)))
1359 ;; single word could be split into multiple words
1360 (setq ispell-quit (not (ispell-region start end)))
1362 ;; keep if rechecking word and we keep choices win.
1363 (if (get-buffer ispell-choices-buffer)
1364 (kill-buffer ispell-choices-buffer))))
1365 (ispell-pdict-save ispell-silently-savep)
1366 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1367 (if ispell-quit (setq ispell-quit nil replace 'quit))))
1368 (goto-char cursor-location) ; return to original location
1372 (defun ispell-get-word (following &optional extra-otherchars)
1373 "Return the word for spell-checking according to ispell syntax.
1374 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1375 is non-nil when called interactively, then the following word
1376 \(rather than preceding\) is checked when the cursor is not over a word.
1377 Optional second argument contains otherchars that can be included in word
1380 Word syntax described by `ispell-dictionary-alist' (which see)."
1381 (let* ((ispell-casechars (ispell-get-casechars))
1382 (ispell-not-casechars (ispell-get-not-casechars))
1383 (ispell-otherchars (ispell-get-otherchars))
1384 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1385 (word-regexp (concat ispell-casechars
1387 (if (not (string= "" ispell-otherchars))
1388 (concat ispell-otherchars "?"))
1389 (if extra-otherchars
1390 (concat extra-otherchars "?"))
1393 (if (or ispell-many-otherchars-p
1399 (if (not (looking-at ispell-casechars))
1401 (re-search-forward ispell-casechars (point-max) t)
1402 (re-search-backward ispell-casechars (point-min) t)))
1403 ;; move to front of word
1404 (re-search-backward ispell-not-casechars (point-min) 'start)
1405 (while (and (or (and (not (string= "" ispell-otherchars))
1406 (looking-at ispell-otherchars))
1407 (and extra-otherchars (looking-at extra-otherchars)))
1409 (or (not did-it-once)
1410 ispell-many-otherchars-p)
1411 (not (eq prevpt (point))))
1412 (if (and extra-otherchars (looking-at extra-otherchars))
1415 (if (looking-at ispell-casechars)
1416 (re-search-backward ispell-not-casechars (point-min) 'move)))
1420 (if (looking-at ispell-casechars)
1421 (re-search-backward ispell-not-casechars (point-min) 'move)
1422 (backward-char -1))))
1423 ;; Now mark the word and save to string.
1424 (if (not (re-search-forward word-regexp (point-max) t))
1425 (if ispell-check-only
1426 ;; return dummy word when just flagging misspellings
1427 (list "" (point) (point))
1428 (error "No word found to check!"))
1429 (setq start (match-beginning 0)
1431 word (buffer-substring-no-properties start end))
1432 (list word start end))))
1435 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1436 ;;; tracks changes in the dictionary. The global may either be
1437 ;;; a value or a list, whose value is the state of whether the
1438 ;;; dictionary needs to be saved.
1441 (defun ispell-pdict-save (&optional no-query force-save)
1442 "Check to see if the personal dictionary has been modified.
1443 If so, ask if it needs to be saved."
1444 (interactive (list ispell-silently-savep t))
1445 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1446 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1447 (if (or ispell-pdict-modified-p force-save)
1448 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1450 (ispell-send-string "#\n") ; save dictionary
1451 (message "Personal dictionary saved."))))
1452 ;; unassert variable, even if not saved to avoid questioning.
1453 (setq ispell-pdict-modified-p nil))
1456 (defun ispell-command-loop (miss guess word start end)
1457 "Display possible corrections from list MISS.
1458 GUESS lists possibly valid affix construction of WORD.
1459 Returns nil to keep word.
1460 Returns 0 to insert locally into buffer-local dictionary.
1461 Returns string for new chosen word.
1462 Returns list for new replacement word (will be rechecked).
1463 Query-replace when list length is 2.
1464 Automatic query-replace when second element is `query-replace'.
1465 Highlights the word, which is assumed to run from START to END.
1466 Global `ispell-pdict-modified-p' becomes a list where the only value
1467 indicates whether the dictionary has been modified when option `a' or `i' is
1469 Global `ispell-quit' set to start location to continue spell session."
1471 (line ispell-choices-win-default-height)
1472 (max-lines (- (window-height) 4)) ; ensure 4 context lines.
1474 (window-min-height (min window-min-height
1475 ispell-choices-win-default-height))
1476 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1477 (dedicated (window-dedicated-p (selected-window)))
1479 char num result textwin dedicated-win)
1481 ;; setup the *Choices* buffer with valid data.
1483 (set-buffer (get-buffer-create ispell-choices-buffer))
1484 (setq mode-line-format (concat "-- %b -- word: " word))
1485 ;; XEmacs: prevent thick modeline vs increasing height in overlay-window
1486 ;;(and (fboundp 'set-specifier)
1487 ;; (set-specifier has-modeline-p (cons (current-buffer) nil)))
1491 (insert "Affix rules generate and capitalize "
1492 "this word as shown below:\n\t")
1494 (if (> (+ 4 (current-column) (length (car guess)))
1498 (setq line (1+ line))))
1499 (insert (car guess) " ")
1500 (setq guess (cdr guess)))
1501 (insert "\nUse option `i' if this is a correct composition"
1502 " from the derivative root.\n")
1503 (setq line (+ line (if choices 3 2)))))
1505 (< (if (> (+ 7 (current-column) (length (car choices))
1506 (if (> count ?~) 3 0))
1510 (setq line (1+ line)))
1513 ;; not so good if there are over 20 or 30 options, but then, if
1514 ;; there are that many you don't want to scan them all anyway...
1515 (while (memq count command-characters) ; skip command characters.
1516 (setq count (ispell-int-char (1+ count))
1517 skipped (1+ skipped)))
1518 (insert "(" count ") " (car choices) " ")
1519 (setq choices (cdr choices)
1520 count (ispell-int-char (1+ count))))
1521 (setq count (ispell-int-char (- count ?0 skipped))))
1523 ;; ensure word is visible
1524 (if (not (pos-visible-in-window-p end))
1527 ;; allow temporary split of dedicated windows...
1530 (setq dedicated-win (selected-window))
1531 (set-window-dedicated-p dedicated-win nil)))
1533 ;; Display choices for misspelled word.
1534 (ispell-show-choices line end)
1535 (select-window (setq textwin (next-window)))
1537 ;; highlight word, protecting current buffer status
1540 (and ispell-highlight-p
1541 (ispell-highlight-spelling-error start end t))
1542 ;; Loop until a valid choice is made.
1550 (let (message-log-max)
1551 (message (concat "C-h or ? for more options; SPC to leave "
1552 "unchanged, Character to replace word")))
1553 (let ((inhibit-quit t))
1554 (setq char (if (fboundp 'read-char-exclusive)
1555 (read-char-exclusive)
1558 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1561 ;; Adjust num to array offset skipping command characters.
1562 (let ((com-chars command-characters))
1564 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1565 (setq skipped (1+ skipped)))
1566 (setq com-chars (cdr com-chars)))
1567 (setq num (- char ?0 skipped)))
1570 ((= char ? ) nil) ; accept word this time only
1571 ((= char ?i) ; accept and insert word into pers dict
1572 (ispell-send-string (concat "*" word "\n"))
1573 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1575 ((or (= char ?a) (= char ?A)) ; accept word without insert
1576 (ispell-send-string (concat "@" word "\n"))
1577 (if (null ispell-pdict-modified-p)
1578 (setq ispell-pdict-modified-p
1579 (list ispell-pdict-modified-p)))
1580 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1581 ((or (= char ?r) (= char ?R)) ; type in replacement
1582 (and (eq 'block ispell-highlight-p) ; refresh tty's
1583 (ispell-highlight-spelling-error start end nil t))
1585 (if (or (= char ?R) ispell-query-replace-choices)
1587 (format "Query-replacement for %s: "word)
1590 (cons (read-string "Replacement for: " word)
1592 (and (eq 'block ispell-highlight-p)
1593 (ispell-highlight-spelling-error start end nil
1596 ((or (= char ??) (= char help-char) (= char ?\C-h))
1597 (and (eq 'block ispell-highlight-p)
1598 (ispell-highlight-spelling-error start end nil t))
1600 (and (eq 'block ispell-highlight-p)
1601 (ispell-highlight-spelling-error start end nil
1604 ;; Quit and move point back.
1606 (ispell-pdict-save ispell-silently-savep)
1607 (message "Exited spell-checking")
1608 (setq ispell-quit t)
1610 ;; Quit and preserve point.
1612 (ispell-pdict-save ispell-silently-savep)
1614 (substitute-command-keys
1615 (concat "Spell-checking suspended;"
1616 " use C-u \\[ispell-word] to resume")))
1617 (setq ispell-quit start)
1620 (if (y-or-n-p "Really kill Ispell process? ")
1622 (ispell-kill-ispell t) ; terminate process.
1623 (setq ispell-quit (or (not ispell-checking-message)
1625 ispell-pdict-modified-p nil))
1626 t)) ; continue if they don't quit.
1628 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1629 (ispell-highlight-spelling-error start end nil t))
1630 (let ((new-word (read-string
1631 "Lookup string (`*' is wildcard): "
1636 (set-buffer (get-buffer-create
1637 ispell-choices-buffer))
1641 mode-line-format (concat
1644 miss (lookup-words new-word)
1646 line ispell-choices-win-default-height)
1647 (while (and choices ; adjust choices window.
1648 (< (if (> (+ 7 (current-column)
1649 (length (car choices))
1650 (if (> count ?~) 3 0))
1654 (setq line (1+ line)))
1657 (while (memq count command-characters)
1658 (setq count (ispell-int-char (1+ count))
1659 skipped (1+ skipped)))
1660 (insert "(" count ") " (car choices) " ")
1661 (setq choices (cdr choices)
1662 count (ispell-int-char (1+ count))))
1663 (setq count (ispell-int-char
1664 (- count ?0 skipped))))
1665 (ispell-show-choices line end)
1666 (select-window (next-window)))))
1667 (and (eq 'block ispell-highlight-p)
1668 (ispell-highlight-spelling-error start end nil
1670 t) ; reselect from new choices
1671 ((= char ?u) ; insert lowercase into dictionary
1672 (ispell-send-string (concat "*" (downcase word) "\n"))
1673 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1675 ((= char ?m) ; type in what to insert
1677 (concat "*" (read-string "Insert: " word) "\n"))
1678 (setq ispell-pdict-modified-p '(t))
1680 ((and (>= num 0) (< num count))
1681 (if ispell-query-replace-choices ; Query replace flag
1682 (list (nth num miss) 'query-replace)
1687 ;; This may have alignment errors if current line is edited
1688 (if (marker-position ispell-recursive-edit-marker)
1690 (message "Only one recursive edit session supported")
1693 (set-marker ispell-recursive-edit-marker start)
1694 ;;(set-marker ispell-region-end reg-end)
1695 (and ispell-highlight-p ; unhighlight
1696 (ispell-highlight-spelling-error start end))
1701 (substitute-command-keys
1702 (concat "Exit recursive edit with"
1703 " \\[exit-recursive-edit]")))
1704 (save-window-excursion (save-excursion
1707 (goto-char ispell-recursive-edit-marker)
1708 (if (not (equal (marker-buffer
1709 ispell-recursive-edit-marker)
1712 (set-marker ispell-recursive-edit-marker nil)
1714 "Cannot continue ispell from this buffer.")))
1715 (set-marker ispell-recursive-edit-marker nil)))
1716 (list word nil)) ; recheck starting at this word.
1718 (funcall (key-binding "\C-z"))
1723 (and ispell-highlight-p ; unhighlight
1724 (save-window-excursion
1725 (select-window textwin)
1726 (ispell-highlight-spelling-error start end)))
1728 (set-window-dedicated-p dedicated-win t)))))
1732 (defun ispell-show-choices (line end)
1733 "Shows the choices in another buffer or frame."
1734 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
1736 (framepop-display-buffer (get-buffer ispell-choices-buffer))
1737 (get-buffer-window ispell-choices-buffer t)
1738 (select-window (previous-window))) ; *Choices* window
1739 ;; standard selection by splitting a small buffer out of this window.
1740 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
1742 (if (= line (window-height choices-window))
1743 (select-window choices-window)
1744 ;; *Choices* window changed size. Adjust the choices window
1745 ;; without scrolling the spelled window when possible
1746 (let ((window-line (- line (window-height choices-window)))
1747 (visible (progn (vertical-motion -1) (point))))
1748 (if (< line ispell-choices-win-default-height)
1749 (setq window-line (+ window-line
1750 (- ispell-choices-win-default-height
1752 (move-to-window-line 0)
1753 (vertical-motion window-line)
1754 (set-window-start (selected-window)
1755 (if (> (point) visible) visible (point)))
1757 (select-window (previous-window)) ; *Choices* window
1758 (enlarge-window window-line)))
1759 ;; Overlay *Choices* window when it isn't showing
1760 (ispell-overlay-window (max line ispell-choices-win-default-height)))
1761 (switch-to-buffer ispell-choices-buffer)
1762 (goto-char (point-min)))))
1766 (defun ispell-help ()
1767 "Display a list of the options available when a misspelling is encountered.
1771 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1772 SPC: Accept word this time.
1773 `i': Accept word and insert into private dictionary.
1774 `a': Accept word for this session.
1775 `A': Accept word and place in `buffer-local dictionary'.
1776 `r': Replace word with typed-in value. Rechecked.
1777 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1778 `?': Show these commands.
1779 `x': Exit spelling buffer. Move cursor to original point.
1780 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1781 the aborted check to be completed later.
1782 `q': Quit spelling session (Kills ispell process).
1783 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1784 `u': Like `i', but the word is lower-cased first.
1785 `m': Place typed-in value in personal dictionary, then recheck current word.
1786 `C-l': redraws screen
1787 `C-r': recursive edit
1788 `C-z': suspend emacs or iconify frame"
1790 (if (equal ispell-help-in-bufferp 'electric)
1794 (function (lambda ()
1795 ;;This shouldn't be necessary: with-electric-help needs
1796 ;; an optional argument telling it about the smallest
1797 ;; acceptable window-height of the help buffer.
1798 (if (< (window-height) 15)
1799 (enlarge-window (- 15 (window-height))))
1800 (princ "Selections are:
1802 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
1803 SPC: Accept word this time.
1804 `i': Accept word and insert into private dictionary.
1805 `a': Accept word for this session.
1806 `A': Accept word and place in `buffer-local dictionary'.
1807 `r': Replace word with typed-in value. Rechecked.
1808 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
1809 `?': Show these commands.
1810 `x': Exit spelling buffer. Move cursor to original point.
1811 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
1812 the aborted check to be completed later.
1813 `q': Quit spelling session (Kills ispell process).
1814 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
1815 `u': Like `i', but the word is lower-cased first.
1816 `m': Place typed-in value in personal dictionary, then recheck current word.
1817 `C-l': redraws screen
1818 `C-r': recursive edit
1819 `C-z': suspend emacs or iconify frame")
1820 nil ;undocumented requirement of with-electric-help
1824 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
1825 "[i]nsert into private dictionary"))
1826 (help-2 (concat "[l]ook a word up in alternate dictionary; "
1827 "e[x/X]it; [q]uit session"))
1828 (help-3 (concat "[u]ncapitalized insert into dict. "
1829 "Type 'x C-h d ispell-help' for more help")))
1830 (save-window-excursion
1831 (if ispell-help-in-bufferp
1833 (ispell-overlay-window (if xemacsp 5 4))
1834 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
1835 (insert (concat help-1 "\n" help-2 "\n" help-3))
1837 (kill-buffer "*Ispell Help*"))
1838 (select-window (minibuffer-window))
1840 (if (not version18p) (message nil))
1841 ;;(set-minibuffer-window (selected-window))
1843 (insert (concat help-1 "\n" help-2 "\n" help-3))
1848 (defun lookup-words (word &optional lookup-dict)
1849 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
1850 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
1851 Otherwise the variable `ispell-grep-command' contains the command used to
1852 search for the words (usually egrep).
1854 Optional second argument contains the dictionary to use; the default is
1855 `ispell-alternate-dictionary'."
1856 ;; We don't use the filter for this function, rather the result is written
1857 ;; into a buffer. Hence there is no need to save the filter values.
1858 (if (null lookup-dict)
1859 (setq lookup-dict ispell-alternate-dictionary))
1861 (let* ((process-connection-type ispell-use-ptys-p)
1862 (wild-p (string-match "\\*" word))
1863 (look-p (and ispell-look-p ; Only use look for an exact match.
1864 (or ispell-have-new-look (not wild-p))))
1865 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
1866 (prog (if look-p ispell-look-command ispell-grep-command))
1867 (args (if look-p ispell-look-options ispell-grep-options))
1870 (save-window-excursion
1871 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
1872 (set-buffer ispell-grep-buffer)
1876 (insert "^" word "$")
1877 (while (search-backward "*" nil t) (insert "."))
1878 (setq word (buffer-string))
1880 (setq status (call-process prog nil t nil args word lookup-dict))
1881 ;; grep returns status 1 and no output when word not found, which
1882 ;; is a perfectly normal thing.
1883 (if (stringp status)
1884 (setq results (cons (format "error: %s exited with signal %s"
1885 (file-name-nondirectory prog) status)
1887 ;; else collect words into `results' in FIFO order
1888 (goto-char (point-max))
1889 ;; assure we've ended with \n
1890 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
1894 (setq results (cons (buffer-substring-no-properties (point)
1898 (kill-buffer ispell-grep-buffer)
1899 (if (and results (string-match ".+: " (car results)))
1900 (error "%s error: %s" ispell-grep-command (car results))))
1904 ;;; "ispell-filter" is a list of output lines from the generating function.
1905 ;;; Each full line (ending with \n) is a separate item on the list.
1906 ;;; "output" can contain multiple lines, part of a line, or both.
1907 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
1909 ;;; "ispell-filter-continue" is true when we have received only part of a
1910 ;;; line as output from a generating function ("output" did not end with \n)
1911 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
1912 ;;; This is the case when a process dies or fails. The default behavior
1913 ;;; in this case treats the next input received as fresh input.
1915 (defun ispell-filter (process output)
1916 "Output filter function for ispell, grep, and look."
1921 (setq end (string-match "\n" output start)) ; get text up to the newline.
1922 ;; If we get out of sync and ispell-filter-continue is asserted when we
1923 ;; are not continuing, treat the next item as a separate list. When
1924 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
1927 ;; Continue with same line (item)?
1928 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
1929 ;; Yes. Add it to the prev item
1930 (setcar ispell-filter
1931 (concat (car ispell-filter) (substring output start end)))
1932 ;; No. This is a new line and item.
1934 (cons (substring output start end) ispell-filter)))
1936 ;; We've completed reading the output, but didn't finish the line.
1937 (setq ispell-filter-continue t continue nil)
1938 ;; skip over newline, this line complete.
1939 (setq ispell-filter-continue nil end (1+ end))
1940 (if (= end (length output)) ; No more lines in output
1941 (setq continue nil) ; so we can exit the filter.
1942 (setq start end)))))) ; else move start to next line of input
1945 ;;; This function destroys the mark location if it is in the word being
1947 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
1949 "Highlight the word from START to END with a kludge using `inverse-video'.
1950 When the optional third arg HIGHLIGHT is set, the word is highlighted;
1951 otherwise it is displayed normally.
1952 Uses block cursor to highlight one character.
1953 Optional REFRESH will unhighlighted then highlight, using block cursor
1954 highlighting when REFRESH is equal to `block'."
1955 (and (eq 'block ispell-highlight-p)
1956 (or (eq 'block refresh)
1957 (setq start (1+ start)))) ; On block non-refresh, inc start.
1958 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
1959 (buffer-read-only nil) ; Allow highlighting read-only buffers.
1960 (text (buffer-substring-no-properties start end)) ; Save hilight region
1961 (inhibit-quit t) ; inhibit interrupt processing here.
1962 (buffer-undo-list t)) ; don't clutter the undo list.
1964 (delete-region start end)
1965 (insert-char ? (- end start)) ; minimize amount of redisplay
1966 (sit-for 0) ; update display
1967 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
1968 (delete-region start end) ; delete whitespace
1969 (insert text) ; insert text in inverse video.
1970 (sit-for 0) ; update display showing inverse video.
1973 (setq inverse-video (not inverse-video)) ; toggle video
1974 (and (eq 'block ispell-highlight-p)
1975 (goto-char (1- start)))) ; use block cursor to "highlight" char
1976 (set-buffer-modified-p modified) ; don't modify if flag not set.
1977 (and refresh ; re-highlight
1978 (ispell-highlight-spelling-error-generic
1979 (if (eq 'block refresh) start (- start 2)) end t))))
1982 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
1983 "Highlight the word from START to END using `isearch-highlight'.
1984 When the optional third arg HIGHLIGHT is set, the word is highlighted,
1985 otherwise it is displayed normally."
1987 (isearch-highlight start end)
1988 (isearch-dehighlight t))
1993 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
1994 "Highlight the word from START to END using overlays.
1995 When the optional third arg HIGHLIGHT is set, the word is highlighted
1996 otherwise it is displayed normally.
1998 The variable `ispell-highlight-face' selects the face to use for highlighting."
2001 (setq ispell-overlay (make-overlay start end))
2002 (overlay-put ispell-overlay 'face ispell-highlight-face))
2003 (delete-overlay ispell-overlay)))
2006 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2009 (ispell-highlight-spelling-error-xemacs start end highlight))
2010 ((and (not version18p)
2012 (or (and (fboundp 'display-color-p) (display-color-p))
2014 (ispell-highlight-spelling-error-overlay start end highlight))
2015 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2018 (defun ispell-overlay-window (height)
2019 "Create a window covering the top HEIGHT lines of the current window.
2020 Ensure that the line above point is still visible but otherwise avoid
2021 scrolling the current window. Leave the new window selected."
2023 (let ((oldot (save-excursion (forward-line -1) (point)))
2024 (top (save-excursion (move-to-window-line height) (point))))
2025 ;; If line above old point (line starting at oldot) would be
2026 ;; hidden by new window, scroll it to just below new win
2027 ;; otherwise set top line of other win so it doesn't scroll.
2028 (if (< oldot top) (setq top oldot))
2029 ;; if frame is unsplitable, temporarily disable that...
2030 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2031 (let ((frame (selected-frame)))
2032 (modify-frame-parameters frame '((unsplittable . nil)))
2033 (split-window nil height)
2034 (modify-frame-parameters frame '((unsplittable . t))))
2035 (split-window nil height))
2036 (set-window-start (next-window) top))))
2039 ;;; Should we add a compound word match return value?
2040 (defun ispell-parse-output (output &optional accept-list shift)
2041 "Parse the OUTPUT string from Ispell process and return:
2042 1: t for an exact match.
2043 2: A string containing the root word matched via suffix removal.
2044 3: A list of possible correct spellings of the format:
2045 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2046 ORIGINAL-WORD is a string of the possibly misspelled word.
2047 OFFSET is an integer giving the line offset of the word.
2048 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2049 4: Nil when an error has occurred.
2051 Optinal second arg ACCEPT-LIST is list of words already accepted.
2052 Optional third arg SHIFT is an offset to apply based on previous corrections."
2054 ((string= output "") t) ; for startup with pipes...
2055 ((string= output "*") t) ; exact match
2056 ((string= output "-") t) ; compound word match
2057 ((string= (substring output 0 1) "+") ; found because of root word
2058 (substring output 2)) ; return root word
2059 ((equal 0 (string-match "[\ra-zA-Z]" output))
2060 (ding) ; error message from ispell!
2061 (message (concat "Ispell error: " output))
2064 (t ; need to process &, ?, and #'s
2065 (let ((type (substring output 0 1)) ; &, ?, or #
2066 (original-word (substring output 2 (string-match " " output 2)))
2067 (cur-count 0) ; contains number of misses + guesses
2068 count miss-list guess-list offset)
2069 (setq output (substring output (match-end 0))) ; skip over misspelling
2070 (if (string= type "#")
2071 (setq count 0) ; no misses for type #
2072 (setq count (string-to-int output) ; get number of misses.
2073 output (substring output (1+ (string-match " " output 1)))))
2074 (setq offset (string-to-int output))
2075 (if (string= type "#") ; No miss or guess list.
2077 (setq output (substring output (1+ (string-match " " output 1)))))
2079 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2080 (setq cur-count (1+ cur-count))
2081 (if (> cur-count count)
2082 (setq guess-list (cons (substring output 0 end) guess-list))
2083 (setq miss-list (cons (substring output 0 end) miss-list)))
2084 (if (match-end 1) ; True only when at end of line.
2085 (setq output nil) ; no more misses or guesses
2086 (setq output (substring output (+ end 2))))))
2087 ;; return results. Accept word if it was already accepted.
2089 (if (member original-word accept-list)
2092 (if (numberp shift) (+ shift offset) offset)
2093 (nreverse miss-list) (nreverse guess-list)))))))
2096 (defun ispell-process-status ()
2097 "Return the status of the Ispell process.
2098 When asynchronous processes are not supported, `run' is always returned."
2099 (if ispell-async-processp
2100 (process-status ispell-process)
2101 (and ispell-process 'run)))
2104 (defun ispell-start-process ()
2105 "Start the ispell process, with support for no asynchronous processes.
2106 Keeps argument list for future ispell invocations for no async support."
2108 ;; Local dictionary becomes the global dictionary in use.
2109 (if ispell-local-dictionary
2110 (setq ispell-dictionary ispell-local-dictionary))
2111 (setq args (ispell-get-ispell-args))
2112 (if ispell-dictionary ; use specified dictionary
2114 (append (list "-d" ispell-dictionary) args)))
2115 (if ispell-personal-dictionary ; use specified pers dict
2119 (expand-file-name ispell-personal-dictionary)))))
2120 (setq args (append args ispell-extra-args))
2122 (if ispell-async-processp
2123 (let ((process-connection-type ispell-use-ptys-p))
2124 (apply 'start-process
2125 "ispell" nil ispell-program-name
2126 "-a" ; accept single input lines
2127 "-m" ; make root/affix combos not in dict
2129 (setq ispell-cmd-args args
2130 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2131 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2132 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2137 (defun ispell-init-process ()
2138 "Check status of Ispell process and start if necessary."
2139 (if (and ispell-process
2140 (eq (ispell-process-status) 'run)
2141 ;; If we're using a personal dictionary, assure
2142 ;; we're in the same default directory!
2143 (or (not ispell-personal-dictionary)
2144 (equal ispell-process-directory default-directory)))
2145 (setq ispell-filter nil ispell-filter-continue nil)
2146 ;; may need to restart to select new personal dictionary.
2147 (ispell-kill-ispell t)
2148 (message "Starting new Ispell process...")
2150 (check-ispell-version)
2151 (setq ispell-process-directory default-directory
2152 ispell-process (ispell-start-process)
2154 ispell-filter-continue nil)
2155 (if ispell-async-processp
2156 (set-process-filter ispell-process 'ispell-filter))
2157 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
2158 (if (and (or xemacsp
2159 (and (boundp 'enable-multibyte-characters)
2160 enable-multibyte-characters))
2161 (fboundp 'set-process-coding-system))
2162 (set-process-coding-system ispell-process (ispell-get-coding-system)
2163 (ispell-get-coding-system)))
2164 ;; Get version ID line
2165 (if (not version18p)
2166 (ispell-accept-output 3)
2167 (ispell-accept-output))
2168 ;; get more output if filter empty?
2169 (if (null ispell-filter) (ispell-accept-output 3))
2170 (cond ((null ispell-filter)
2171 (error "%s did not output version line" ispell-program-name))
2173 (stringp (car ispell-filter))
2174 (if (string-match "warning: " (car ispell-filter))
2176 (if (not version18p)
2177 (ispell-accept-output 3) ; was warn msg.
2178 (ispell-accept-output))
2179 (stringp (car ispell-filter)))
2180 (null (cdr ispell-filter)))
2181 (string-match "^@(#) " (car ispell-filter)))
2182 ;; got the version line as expected (we already know it's the right
2183 ;; version, so don't bother checking again.)
2186 ;; Otherwise, it must be an error message. Show the user.
2187 ;; But first wait to see if some more output is going to arrive.
2188 ;; Otherwise we get cool errors like "Can't open ".
2190 (ispell-accept-output 3)
2191 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2192 (setq ispell-filter nil) ; Discard version ID line
2193 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2194 (if extended-char-mode ; ~ extended character mode
2195 (ispell-send-string (concat extended-char-mode "\n"))))
2196 (if ispell-async-processp
2197 (process-kill-without-query ispell-process))))
2200 (defun ispell-kill-ispell (&optional no-error)
2201 "Kill current Ispell process (so that you may start a fresh one).
2202 With NO-ERROR, just return non-nil if there was no Ispell running."
2204 (if (not (and ispell-process
2205 (eq (ispell-process-status) 'run)))
2207 (error "There is no ispell process running!"))
2208 (if ispell-async-processp
2210 (process-send-eof ispell-process)
2211 (if (eq (ispell-process-status) 'run)
2212 (ispell-accept-output 1))
2213 (if (eq (ispell-process-status) 'run)
2214 (kill-process ispell-process))
2215 (while (not (or (eq (ispell-process-status) 'exit)
2216 (eq (ispell-process-status) 'signal)))
2217 (if (or xemacsp version20p) (sleep-for 0.25)
2218 (sleep-for 0 250))))
2219 ;; synchronous processes
2220 (ispell-send-string "\n") ; make sure side effects occurred.
2221 (kill-buffer ispell-output-buffer)
2222 (kill-buffer ispell-session-buffer)
2223 (setq ispell-output-buffer nil
2224 ispell-session-buffer nil))
2225 (setq ispell-process nil)
2226 (message "Ispell process killed")
2230 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2231 ;;; call ispell-init-process rather than wait for a spell checking command?
2234 (defun ispell-change-dictionary (dict &optional arg)
2235 "Change `ispell-dictionary' (q.v.) to DICT and kill old Ispell process.
2236 A new one will be started as soon as necessary.
2238 By just answering RET you can find out what the current dictionary is.
2240 With prefix argument, set the default directory."
2242 (list (completing-read
2243 "Use new dictionary (RET for current, SPC to complete): "
2244 (cons (cons "default" nil) ispell-dictionary-alist) nil t)
2245 current-prefix-arg))
2246 (if (equal dict "default") (setq dict nil))
2247 ;; This relies on completing-read's bug of returning "" for no match
2248 (cond ((equal dict "")
2249 (message "Using %s dictionary"
2250 (or ispell-local-dictionary ispell-dictionary "default")))
2251 ((and (equal dict ispell-dictionary)
2252 (or (null ispell-local-dictionary)
2253 (equal dict ispell-local-dictionary)))
2254 ;; Specified dictionary is the default already. No-op
2255 (and (interactive-p)
2256 (message "No change, using %s dictionary" (or dict "default"))))
2257 (t ; reset dictionary!
2258 (if (assoc dict ispell-dictionary-alist)
2260 (if (or arg (null dict)) ; set default dictionary
2261 (setq ispell-dictionary dict))
2262 (if (null arg) ; set local dictionary
2263 (setq ispell-local-dictionary dict)))
2264 (error "Undefined dictionary: %s" dict))
2265 (ispell-kill-ispell t)
2266 (message "(Next %sIspell command will use %s dictionary)"
2267 (cond ((equal ispell-local-dictionary ispell-dictionary)
2271 (or (if (or (equal ispell-local-dictionary ispell-dictionary)
2273 ispell-local-dictionary
2278 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2281 (defun ispell-region (reg-start reg-end &optional recheckp shift)
2282 "Interactively check a region for spelling errors.
2283 Return nil if spell session is quit,
2284 otherwise returns shift offset amount for last line processed."
2285 (interactive "r") ; Don't flag errors on read-only bufs.
2287 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2290 (message "Spell checking %s using %s dictionary..."
2291 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2292 (buffer-name) "region")
2293 (or ispell-dictionary "default"))
2294 ;; Returns cursor to original location.
2295 (save-window-excursion
2296 (goto-char reg-start)
2297 (let ((transient-mark-mode)
2298 (case-fold-search case-fold-search)
2299 (skip-region-start (make-marker))
2300 (skip-regexp (ispell-begin-skip-region-regexp))
2301 (skip-alist ispell-skip-region-alist)
2303 (if (eq ispell-parser 'tex)
2304 (setq case-fold-search nil
2306 (append (car ispell-tex-skip-alists)
2307 (car (cdr ispell-tex-skip-alists))
2309 (let (message-log-max)
2310 (message "searching for regions to skip"))
2311 (if (re-search-forward skip-regexp reg-end t)
2313 (setq key (buffer-substring-no-properties
2314 (match-beginning 0) (match-end 0)))
2315 (set-marker skip-region-start (- (point) (length key)))
2316 (goto-char reg-start)))
2317 (let (message-log-max)
2318 (message "Continuing spelling check using %s dictionary..."
2319 (or ispell-dictionary "default")))
2320 (set-marker ispell-region-end reg-end)
2321 (while (and (not ispell-quit)
2322 (< (point) ispell-region-end))
2323 ;; spell-check region with skipping
2324 (if (and (marker-position skip-region-start)
2325 (<= skip-region-start (point)))
2327 (ispell-skip-region key skip-alist) ; moves pt past region.
2328 (setq reg-start (point))
2329 (if (and (< reg-start ispell-region-end)
2330 (re-search-forward skip-regexp
2331 ispell-region-end t))
2333 (setq key (buffer-substring-no-properties
2335 (car (cdr (match-data)))))
2336 (set-marker skip-region-start
2337 (- (point) (length key)))
2338 (goto-char reg-start))
2339 (set-marker skip-region-start nil))))
2340 (setq reg-end (if (marker-position skip-region-start)
2341 (min skip-region-start ispell-region-end)
2342 (marker-position ispell-region-end)))
2343 (let* ((start (point))
2344 (end (save-excursion (end-of-line) (min (point) reg-end)))
2345 (string (ispell-get-line start end reg-end)))
2346 (setq end (point)) ; "end" tracks region retrieved.
2347 (if string ; there is something to spell check!
2348 ;; (special start end)
2349 (setq shift (ispell-process-line string
2350 (and recheckp shift))))
2356 (if (and (not (and recheckp ispell-keep-choices-win))
2357 (get-buffer ispell-choices-buffer))
2358 (kill-buffer ispell-choices-buffer))
2361 ;; preserve or clear the region for ispell-continue.
2362 (if (not (numberp ispell-quit))
2363 (set-marker ispell-region-end nil)
2364 ;; Ispell-continue enabled - ispell-region-end is set.
2365 (goto-char ispell-quit))
2366 ;; Check for aborting
2367 (if (and ispell-checking-message (numberp ispell-quit))
2369 (setq ispell-quit nil)
2370 (error "Message send aborted")))
2371 (if (not recheckp) (setq ispell-quit nil)))
2372 (if (not recheckp) (set-marker ispell-region-end nil))
2373 ;; Only save if successful exit.
2374 (ispell-pdict-save ispell-silently-savep)
2375 (message "Spell-checking done"))))
2378 ;;; Creates the regexp for skipping a region.
2379 ;;; Makes the skip-regexp local for tex buffers adding in the
2380 ;;; tex expressions to skip as well.
2381 ;;; Call AFTER ispell-buffer-local-parsing.
2382 (defun ispell-begin-skip-region-regexp ()
2383 (let ((skip-regexp (ispell-begin-skip-region)))
2384 (if (and (null ispell-check-comments) comment-start)
2385 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2387 (if (and (eq 'exclusive ispell-check-comments) comment-start)
2388 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2389 (regexp-quote comment-end))
2390 "\\|" skip-regexp)))
2392 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
2393 (if ispell-skip-sgml
2394 (setq skip-regexp (concat "<author>" "\\|"
2395 "<[cC][oO][dD][eE]>" "\\|"
2396 "<[vV][eE][rR][bB]>" "\\|"
2397 ;; "<[tT][tT]>" "\\|"
2403 (if (eq ispell-parser 'tex)
2404 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2409 (defun ispell-begin-tex-skip-regexp ()
2410 "Regular expression of tex commands to skip.
2411 Generated from `ispell-tex-skip-alists'."
2413 (mapconcat (function (lambda (lst) (car lst)))
2414 (car ispell-tex-skip-alists)
2417 (mapconcat (function (lambda (lst)
2418 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2421 (car (cdr ispell-tex-skip-alists))
2425 (defun ispell-begin-skip-region ()
2426 "Regular expression of regions to skip for all buffers.
2427 Each selection should be a key of `ispell-skip-region-alist';
2428 otherwise, the current line is skipped."
2429 (mapconcat (function (lambda (lst) (if (stringp (car lst)) (car lst)
2431 ispell-skip-region-alist
2435 (defun ispell-tex-arg-end (&optional arg)
2438 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2439 (forward-sexp (or arg 1)))
2441 (message "error skipping s-expressions at point %d." (point))
2446 ;;; Skips to region-end from point, or a single line.
2447 ;;; Places point at end of region skipped.
2448 (defun ispell-skip-region (key alist)
2449 ;; move over key to begin checking.
2450 (forward-char (length key))
2451 (let ((start (point))
2452 alist-key null-skip)
2454 ;; what about quoted comment, or comment inside strings?
2455 ((and (null ispell-check-comments) comment-start
2456 (string= key comment-start))
2457 (if (string= "" comment-end)
2459 (search-forward comment-end ispell-region-end t)))
2460 ((and (eq 'exclusive ispell-check-comments) comment-start
2461 (string= key comment-end))
2462 (search-forward comment-start ispell-region-end :end))
2463 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2464 (re-search-forward ispell-tib-ref-end ispell-region-end t))
2465 ((and ispell-skip-sgml (string-match "<author>" key))
2466 (search-forward-regexp ".$" ispell-region-end t))
2467 ((and ispell-skip-sgml (string-match "</" key))
2468 (search-forward ">" ispell-region-end t))
2469 ((and ispell-skip-sgml (string-match "<[cC][oO][dD][eE]>" key))
2470 (search-forward-regexp "</[cC][oO][dD][eE]>" ispell-region-end t))
2471 ((and ispell-skip-sgml (string-match "<[vV][eE][rR][bB]>" key))
2472 (search-forward-regexp "</[vV][eE][rR][bB]>" ispell-region-end t))
2473 ;;((and ispell-skip-sgml (string-match "<[tT][tT]>" key))
2474 ;; (search-forward-regexp "</[tT][tT]>" ispell-region-end t))
2475 ((and ispell-skip-sgml (string-match "<[tT][tT]/" key))
2476 (search-forward "/" ispell-region-end t))
2477 ((and ispell-skip-sgml (string-match "<" key))
2478 (search-forward-regexp "[/>]" ispell-region-end t))
2479 ((and ispell-skip-sgml (string-match "&" key))
2480 (search-forward ";" ispell-region-end t))
2481 ;; markings from alist
2484 (setq alist-key (eval (car (car alist))))
2485 (if (string-match alist-key key)
2487 (setq alist (cdr (car alist)))
2489 ((null alist) (setq null-skip t)) ; done! Just skip key.
2490 ((not (consp alist))
2491 ;; Search past end of spell region to find this region end.
2492 (re-search-forward (eval alist) (point-max) t))
2495 (re-search-forward alist (point-max) t)
2496 (setq null-skip t) ; error handling in functions!
2497 (if (consp (cdr alist))
2498 (apply (car alist) (cdr alist))
2499 (funcall (car alist))))))
2501 (setq alist (cdr alist))))))
2502 (if (and (= start (point)) (null null-skip))
2504 (message "Matching region end for `%s' point %d not found"
2510 ;;; Grab the next line of data.
2511 ;;; Returns a string with the line data
2512 (defun ispell-get-line (start end reg-end)
2513 (let ((ispell-casechars (ispell-get-casechars))
2515 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2516 ((eolp) ; END OF LINE, just go to next line.
2518 ;;((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
2519 ;; (forward-char 1)) ; not needed as quoted below.
2520 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2521 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
2522 (setq string (concat "^" (buffer-substring-no-properties start end)
2525 (t (goto-char end))) ; EMPTY LINE, skip it.
2529 (defun ispell-process-line (string shift)
2530 "Sends a LINE of text to ispell and processes the result.
2531 This will modify the buffer for spelling errors.
2532 Requires variables START and END to be defined in its lexical scope.
2533 Returns the sum shift due to changes in word replacements."
2534 ;;(declare special start end)
2535 (let (poss accept-list)
2536 (if (not (numberp shift))
2538 ;; send string to spell process and get input.
2539 (ispell-send-string string)
2541 (ispell-accept-output)
2542 ;; Last item of output contains a blank line.
2543 (not (string= "" (car ispell-filter)))))
2544 ;; parse all inputs from the stream one word at a time.
2545 ;; Place in FIFO order and remove the blank item.
2546 (setq ispell-filter (nreverse (cdr ispell-filter)))
2547 (while (and (not ispell-quit) ispell-filter)
2548 ;; get next word, accounting for accepted words and start shifts
2549 (setq poss (ispell-parse-output (car ispell-filter)
2551 (if (and poss (listp poss)) ; spelling error occurred.
2552 ;; Whenever we have misspellings, we can change
2553 ;; the buffer. Keep boundaries as markers.
2554 ;; Markers can move with highlighting! This destroys
2555 ;; end of region markers line-end and ispell-region-end
2557 (copy-marker (+ start ispell-offset (car (cdr poss)))))
2558 (word-len (length (car poss)))
2559 (line-end (copy-marker end))
2560 (line-start (copy-marker start))
2561 recheck-region replace)
2562 (goto-char word-start)
2563 ;; Adjust the horizontal scroll & point
2564 (ispell-horiz-scroll)
2565 (goto-char (+ word-len word-start))
2566 (ispell-horiz-scroll)
2567 (goto-char word-start)
2568 (ispell-horiz-scroll)
2570 ;; Alignment cannot be tracked and this error will occur when
2571 ;; `query-replace' makes multiple corrections on the starting line.
2572 (if (/= (+ word-len (point))
2574 ;; NB: Search can fail with Mule character sets that don't
2575 ;; display properly. Ignore the error in this case?
2576 (search-forward (car poss) (+ word-len (point)) t)
2578 ;; This occurs due to filter pipe problems
2579 (error (concat "Ispell misalignment: word "
2580 "`%s' point %d; probably incompatible versions")
2581 (car poss) (marker-position word-start)))
2582 ;; ispell-cmd-loop can go recursive & change buffer
2583 (if ispell-keep-choices-win
2584 (setq replace (ispell-command-loop
2585 (car (cdr (cdr poss)))
2586 (car (cdr (cdr (cdr poss))))
2587 (car poss) (marker-position word-start)
2588 (+ word-len (marker-position word-start))))
2589 (save-window-excursion
2590 (setq replace (ispell-command-loop
2591 (car (cdr (cdr poss)))
2592 (car (cdr (cdr (cdr poss))))
2593 (car poss) (marker-position word-start)
2594 (+ word-len (marker-position word-start))))))
2596 (goto-char word-start)
2597 ;; Recheck when query replace edit changes misspelled word.
2598 ;; Error in tex mode when a potential math mode change exists.
2599 (if (and replace (listp replace) (= 2 (length replace)))
2600 (if (and (eq ispell-parser 'tex)
2601 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
2602 (regexp-quote string)))
2604 "Don't start query replace on a line with math characters"
2606 (set-marker line-end (point))
2607 (setq ispell-filter nil
2610 ;; insert correction if needed
2613 (equal 0 replace)) ; ACCEPT/INSERT
2614 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
2615 (ispell-add-per-file-word-list (car poss)))
2616 ;; do not recheck accepted word on this line
2617 (setq accept-list (cons (car poss) accept-list)))
2618 (t ; replacement word selected or entered
2619 (delete-region (point) (+ word-len (point)))
2620 (if (not (listp replace))
2622 (insert replace) ; insert dictionary word
2623 (setq accept-list (cons replace accept-list)))
2624 (let ((replace-word (car replace)))
2625 ;; Recheck hand entered replacement word
2626 (insert replace-word)
2627 (if (car (cdr replace))
2628 (save-window-excursion
2629 (delete-other-windows) ; to correctly show help.
2630 ;; Assume case-replace &
2631 ;; case-fold-search correct?
2632 (query-replace (car poss) (car replace) t)))
2633 (goto-char word-start)
2634 ;; do not recheck if already accepted
2635 (if (member replace-word accept-list)
2636 (setq accept-list (cons replace-word accept-list)
2637 replace replace-word)
2638 (let ((region-end (copy-marker ispell-region-end)))
2639 (setq recheck-region ispell-filter
2640 ispell-filter nil ; save filter
2641 shift (ispell-region
2643 (+ word-start (length replace-word))
2645 (if (null shift) ; quitting check.
2647 (set-marker ispell-region-end region-end)
2648 (set-marker region-end nil)
2649 (setq ispell-filter recheck-region
2651 replace replace-word)))))
2653 (setq shift (+ shift (- (length replace) word-len)))
2655 ;; Move line-start across word...
2656 ;; new shift function does this now...
2657 ;;(set-marker line-start (+ line-start
2658 ;; (- (length replace)
2659 ;; (length (car poss)))))
2661 (if (not ispell-quit)
2662 (let (message-log-max)
2663 (message "Continuing spelling check using %s dictionary..."
2664 (or ispell-dictionary "default"))))
2666 (setq start (marker-position line-start)
2667 end (marker-position line-end))
2668 ;; Adjust markers when end of region lost from highlighting.
2669 (if (and (not recheck-region) (< end (+ word-start word-len)))
2670 (setq end (+ word-start word-len)))
2671 (if (= word-start ispell-region-end)
2672 (set-marker ispell-region-end (+ word-start word-len)))
2673 ;; going out of scope - unneeded
2674 (set-marker line-start nil)
2675 (set-marker word-start nil)
2676 (set-marker line-end nil)))
2677 ;; finished with misspelling!
2678 (setq ispell-filter (cdr ispell-filter)))
2683 (defun ispell-comments-and-strings ()
2684 "Check comments and strings in the current buffer for spelling errors."
2686 (goto-char (point-min))
2690 (setq state (parse-partial-sexp (point) (point-max)
2691 nil nil state 'syntax-table))
2692 (if (or (nth 3 state) (nth 4 state))
2693 (let ((start (point)))
2694 (setq state (parse-partial-sexp start (point-max)
2695 nil nil state 'syntax-table))
2696 (if (or (nth 3 state) (nth 4 state))
2697 (error "Unterminated string or comment"))
2699 (setq done (not (ispell-region start (point))))))))))
2703 (defun ispell-buffer ()
2704 "Check the current buffer for spelling errors interactively."
2706 (ispell-region (point-min) (point-max)))
2710 (defun ispell-continue ()
2711 "Continue a halted spelling session beginning with the current word."
2713 (if (not (marker-position ispell-region-end))
2714 (message "No session to continue. Use 'X' command when checking!")
2715 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
2716 (message "Must continue ispell from buffer %s"
2717 (buffer-name (marker-buffer ispell-region-end)))
2719 ;; find beginning of current word:
2720 (car (cdr (ispell-get-word t)))
2721 (marker-position ispell-region-end)))))
2724 ;;; Horizontal scrolling
2725 (defun ispell-horiz-scroll ()
2726 "Places point within the horizontal visibility of its window area."
2727 (if truncate-lines ; display truncating lines?
2728 ;; See if display needs to be scrolled.
2729 (let ((column (- (current-column) (max (window-hscroll) 1))))
2730 (if (and (< column 0) (> (window-hscroll) 0))
2731 (scroll-right (max (- column) 10))
2732 (if (>= column (- (window-width) 2))
2733 (scroll-left (max (- column (window-width) -3) 10)))))))
2736 ;;; Interactive word completion.
2737 ;;; Forces "previous-word" processing. Do we want to make this selectable?
2740 (defun ispell-complete-word (&optional interior-frag)
2741 "Try to complete the word before or under point (see `lookup-words')
2742 If optional INTERIOR-FRAG is non-nil then the word may be a character
2743 sequence inside of a word.
2745 Standard ispell choices are then available."
2747 (let ((cursor-location (point))
2748 (case-fold-search-val case-fold-search)
2749 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
2750 start end possibilities replacement)
2751 (setq start (car (cdr word))
2752 end (car (cdr (cdr word)))
2755 (or (string= word "") ; Will give you every word
2756 (lookup-words (concat (and interior-frag "*") word
2757 (if (or interior-frag (null ispell-look-p))
2759 ispell-complete-word-dict)))
2760 (cond ((eq possibilities t)
2761 (message "No word to complete"))
2762 ((null possibilities)
2763 (message "No match for \"%s\"" word))
2764 (t ; There is a modification...
2765 (setq case-fold-search nil) ; Try and respect case of word.
2767 ((string-equal (upcase word) word)
2768 (setq possibilities (mapcar 'upcase possibilities)))
2769 ((string-equal (upcase (substring word 0 1)) (substring word 0 1))
2770 (setq possibilities (mapcar (function
2773 (substring word 0 1)
2774 (substring pos 0 1))
2778 (setq case-fold-search case-fold-search-val)
2779 (save-window-excursion
2781 (ispell-command-loop possibilities nil word start end)))
2783 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
2784 (ispell-add-per-file-word-list word))
2785 (replacement ; REPLACEMENT WORD
2786 (delete-region start end)
2787 (setq word (if (atom replacement) replacement (car replacement))
2788 cursor-location (+ (- (length word) (- end start))
2791 (if (not (atom replacement)) ; recheck spelling of replacement.
2793 (goto-char cursor-location)
2794 (ispell-word nil t)))))
2795 (if (get-buffer ispell-choices-buffer)
2796 (kill-buffer ispell-choices-buffer))))
2797 (ispell-pdict-save ispell-silently-savep)
2798 (goto-char cursor-location)))
2802 (defun ispell-complete-word-interior-frag ()
2803 "Completes word matching character sequence inside a word."
2805 (ispell-complete-word t))
2810 "Interactively check a region or buffer for spelling errors.
2811 If `transient-mark-mode' is on, an a region is active, spell-check
2812 that region. Otherwise spell-check the buffer."
2814 (if (and transient-mark-mode mark-active)
2815 (ispell-region (region-beginning) (region-end))
2819 ;;; **********************************************************************
2820 ;;; Ispell Minor Mode
2821 ;;; **********************************************************************
2823 (defvar ispell-minor-mode nil
2824 "Non-nil if Ispell minor mode is enabled.")
2825 ;; Variable indicating that ispell minor mode is active.
2826 (make-variable-buffer-local 'ispell-minor-mode)
2828 (or (assq 'ispell-minor-mode minor-mode-alist)
2829 (setq minor-mode-alist
2830 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
2832 (defvar ispell-minor-keymap
2833 (let ((map (make-sparse-keymap)))
2834 (define-key map " " 'ispell-minor-check)
2835 (define-key map "\r" 'ispell-minor-check)
2837 "Keymap used for Ispell minor mode.")
2839 (or (not (boundp 'minor-mode-map-alist))
2840 (assoc 'ispell-minor-mode minor-mode-map-alist)
2841 (setq minor-mode-map-alist
2842 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
2843 minor-mode-map-alist)))
2846 (defun ispell-minor-mode (&optional arg)
2847 "Toggle Ispell minor mode.
2848 With prefix arg, turn Ispell minor mode on iff arg is positive.
2850 In Ispell minor mode, pressing SPC or RET
2851 warns you if the previous word is incorrectly spelled.
2853 All the buffer-local variables and dictionaries are ignored -- to read
2854 them into the running ispell process, type \\[ispell-word] SPC."
2856 (setq ispell-minor-mode
2857 (not (or (and (null arg) ispell-minor-mode)
2858 (<= (prefix-numeric-value arg) 0))))
2859 (force-mode-line-update))
2861 (defun ispell-minor-check ()
2862 "Check previous word then continue with the normal binding of this key.
2863 Don't check previous word when character before point is a space or newline.
2864 Don't read buffer-local settings or word lists."
2866 (let ((ispell-minor-mode nil)
2867 (ispell-check-only t)
2868 (last-char (char-after (1- (point)))))
2869 (command-execute (key-binding (this-command-keys)))
2870 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
2871 (and ispell-skip-sgml (eq last-char ?>))
2872 (and ispell-skip-sgml (eq last-char ?\;))))
2873 (ispell-word nil t))))
2876 ;;; **********************************************************************
2878 ;;; **********************************************************************
2879 ;;; Original from D. Quinlan, E. Bradford, A. Albert, and M. Ernst
2882 (defvar ispell-message-text-end
2883 (mapconcat (function identity)
2885 ;; Don't spell check signatures
2887 ;; Matches postscript files.
2888 "^%!PS-Adobe-[123].0"
2889 ;; Matches uuencoded text
2890 "^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
2891 ;; Matches shell files (especially auto-decoding)
2893 ;; Matches context difference listing
2894 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
2895 ;; Matches unidiff difference listing
2896 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
2897 ;; Matches reporter.el bug report
2898 "^current state:\n==============\n"
2899 ;; Matches commonly used "cut" boundaries
2900 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
2902 "*End of text which will be checked in `ispell-message'.
2903 If it is a string, limit at first occurrence of that regular expression.
2904 Otherwise, it must be a function which is called to get the limit.")
2909 (defun ispell-message ()
2910 "Check the spelling of a mail message or news post.
2911 Don't check spelling of message headers except the Subject field.
2912 Don't check included messages.
2914 To abort spell checking of a message region and send the message anyway,
2915 use the `x' command. (Any subsequent regions will be checked.)
2916 The `X' command aborts the message send so that you can edit the buffer.
2918 To spell-check whenever a message is sent, include the appropriate lines
2919 in your .emacs file:
2920 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
2921 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
2922 (add-hook 'mail-send-hook 'ispell-message)
2923 (add-hook 'mh-before-send-letter-hook 'ispell-message)
2925 You can bind this to the key C-c i in GNUS or mail by adding to
2926 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
2927 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
2930 (goto-char (point-min))
2932 ;; Nil when message came from outside (eg calling emacs as editor)
2933 ;; Non-nil marker of end of headers.
2936 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
2937 (end-of-headers ; Start of body.
2939 (or internal-messagep
2940 (re-search-forward "^$" nil t)
2942 (limit (copy-marker ; End of region we will spell check.
2944 ((not ispell-message-text-end) (point-max))
2945 ((char-or-string-p ispell-message-text-end)
2946 (if (re-search-forward ispell-message-text-end nil t)
2949 (t (min (point-max) (funcall ispell-message-text-end))))))
2950 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
2951 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
2952 (ispell-non-empty-string mail-yank-prefix)
2954 (cite-regexp ;Prefix of quoted text
2956 ((functionp 'sc-cite-regexp) ; sc 3.0
2957 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
2958 (ispell-non-empty-string sc-reference-tag-string)))
2959 ((boundp 'sc-cite-regexp) ; sc 2.3
2960 (concat "\\(" sc-cite-regexp "\\)" "\\|"
2961 (ispell-non-empty-string sc-reference-tag-string)))
2962 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
2963 (equal major-mode 'message-mode)) ;GNUS 5
2964 (concat "In article <" "\\|"
2965 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
2966 message-yank-prefix "\\|"
2968 ((equal major-mode 'mh-letter-mode) ; mh mail message
2969 (concat "[^,;&+=\n]+ writes:" "\\|"
2970 (ispell-non-empty-string mh-ins-buf-prefix)))
2971 ((not internal-messagep) ; Assume nn sent us this message.
2972 (concat "In [a-zA-Z.]+ you write:" "\\|"
2973 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
2975 ((boundp 'vm-included-text-prefix) ; VM mail message
2976 (concat "[^,;&+=\n]+ writes:" "\\|"
2977 (ispell-non-empty-string vm-included-text-prefix)))
2978 (t default-prefix)))
2979 (ispell-skip-region-alist
2980 (cons (list (concat "^\\(" cite-regexp "\\)")
2981 (function forward-line))
2982 ispell-skip-region-alist))
2983 (old-case-fold-search case-fold-search)
2984 (dictionary-alist ispell-message-dictionary-alist)
2985 (ispell-checking-message t))
2987 ;; Select dictionary for message
2988 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
2989 (while dictionary-alist
2990 (goto-char (point-min))
2991 (if (re-search-forward (car (car dictionary-alist))
2993 (setq ispell-local-dictionary (cdr (car dictionary-alist))
2994 dictionary-alist nil)
2995 (setq dictionary-alist (cdr dictionary-alist)))))
2999 ;; Spell check any original Subject:
3000 (goto-char (point-min))
3001 (setq case-fold-search t)
3002 (if (re-search-forward "^Subject: *" end-of-headers t)
3004 (goto-char (match-end 0))
3005 (if (and (not (looking-at ".*Re\\>"))
3006 (not (looking-at "\\[")))
3008 (setq case-fold-search old-case-fold-search)
3009 (ispell-region (point)
3010 (progn ;Tab-initiated continuation lns.
3012 (while (looking-at "\n[ \t]")
3015 (setq case-fold-search old-case-fold-search)
3016 (goto-char end-of-headers)
3018 (ispell-region (point) limit))
3019 (set-marker end-of-headers nil)
3020 (set-marker limit nil)))))
3023 (defun ispell-non-empty-string (string)
3024 (if (or (not string) (string-equal string ""))
3025 "\\'\\`" ; An unmatchable string if string is null.
3026 (regexp-quote string)))
3029 ;;; **********************************************************************
3030 ;;; Buffer Local Functions
3031 ;;; **********************************************************************
3034 (defun ispell-accept-buffer-local-defs ()
3035 "Load all buffer-local information, restarting Ispell when necessary."
3036 (ispell-buffer-local-dict) ; May kill ispell-process.
3037 (ispell-buffer-local-words) ; Will initialize ispell-process.
3038 (ispell-buffer-local-parsing))
3041 (defun ispell-buffer-local-parsing ()
3042 "Place Ispell into parsing mode for this buffer.
3043 Overrides the default parsing mode.
3044 Includes Latex/Nroff modes and extended character mode."
3045 ;; (ispell-init-process) must already be called.
3046 (ispell-send-string "!\n") ; Put process in terse mode.
3047 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3048 ;; When exclusively checking comments, set to raw text mode (nroff).
3049 (if (and (not (eq 'exclusive ispell-check-comments))
3050 (or (and (eq ispell-parser 'use-mode-name)
3051 (string-match "[Tt][Ee][Xx]-mode"
3052 (symbol-name major-mode)))
3053 (eq ispell-parser 'tex)))
3055 (ispell-send-string "+\n") ; set ispell mode to tex
3056 (if (not (eq ispell-parser 'tex))
3057 (set (make-local-variable 'ispell-parser) 'tex)))
3058 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3059 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3060 (if (and ispell-skip-sgml (not (eq ispell-skip-sgml t)))
3061 (set (make-local-variable 'ispell-skip-sgml)
3062 (not (null (string-match "sgml\\|html"
3063 (downcase (symbol-name major-mode)))))))
3064 ;; Set default extended character mode for given buffer, if any.
3065 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3066 (if extended-char-mode
3067 (ispell-send-string (concat extended-char-mode "\n"))))
3068 ;; Set buffer-local parsing mode and extended character mode, if specified.
3070 (goto-char (point-max))
3071 ;; Uses last occurrence of ispell-parsing-keyword
3072 (if (search-backward ispell-parsing-keyword nil t)
3073 (let ((end (save-excursion (end-of-line) (point)))
3075 (search-forward ispell-parsing-keyword)
3076 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3077 ;; space separated definitions.
3078 (setq string (downcase (buffer-substring-no-properties
3079 (match-beginning 1) (match-end 1))))
3080 (cond ((and (string-match "latex-mode" string)
3081 (not (eq 'exclusive ispell-check-comments)))
3082 (ispell-send-string "+\n~tex\n"))
3083 ((string-match "nroff-mode" string)
3084 (ispell-send-string "-\n~nroff\n"))
3085 ((string-match "~" string) ; Set extended character mode.
3086 (ispell-send-string (concat string "\n")))
3087 (t (message "Invalid Ispell Parsing argument!")
3091 ;;; Can kill the current ispell process
3093 (defun ispell-buffer-local-dict ()
3094 "Initializes local dictionary and local personal dictionary.
3095 When a dictionary is defined in the buffer (see variable
3096 `ispell-dictionary-keyword'), it will override the local setting
3097 from \\[ispell-change-dictionary].
3098 Both should not be used to define a buffer-local dictionary."
3100 (goto-char (point-min))
3102 ;; Override the local variable definition.
3103 ;; Uses last occurrence of ispell-dictionary-keyword.
3104 (goto-char (point-max))
3105 (if (search-backward ispell-dictionary-keyword nil t)
3107 (search-forward ispell-dictionary-keyword)
3108 (setq end (save-excursion (end-of-line) (point)))
3109 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3110 (setq ispell-local-dictionary
3111 (buffer-substring-no-properties (match-beginning 1)
3113 (goto-char (point-max))
3114 (if (search-backward ispell-pdict-keyword nil t)
3116 (search-forward ispell-pdict-keyword)
3117 (setq end (save-excursion (end-of-line) (point)))
3118 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3119 (setq ispell-local-pdict
3120 (buffer-substring-no-properties (match-beginning 1)
3121 (match-end 1))))))))
3122 ;; Reload if new personal dictionary defined.
3123 (if (and ispell-local-pdict
3124 (not (equal ispell-local-pdict ispell-personal-dictionary)))
3126 (ispell-kill-ispell t)
3127 (setq ispell-personal-dictionary ispell-local-pdict)))
3128 ;; Reload if new dictionary defined.
3129 (if (and ispell-local-dictionary
3130 (not (equal ispell-local-dictionary ispell-dictionary)))
3131 (ispell-change-dictionary ispell-local-dictionary)))
3134 (defun ispell-buffer-local-words ()
3135 "Loads the buffer-local dictionary in the current buffer."
3136 (if (and ispell-buffer-local-name
3137 (not (equal ispell-buffer-local-name (buffer-name))))
3139 (ispell-kill-ispell t)
3140 (setq ispell-buffer-local-name nil)))
3141 (ispell-init-process)
3143 (goto-char (point-min))
3144 (while (search-forward ispell-words-keyword nil t)
3145 (or ispell-buffer-local-name
3146 (setq ispell-buffer-local-name (buffer-name)))
3147 (let ((end (save-excursion (end-of-line) (point)))
3148 (ispell-casechars (ispell-get-casechars))
3150 ;; buffer-local words separated by a space, and can contain
3151 ;; any character other than a space. Not rigorous enough.
3152 (while (re-search-forward " *\\([^ ]+\\)" end t)
3153 (setq string (buffer-substring-no-properties (match-beginning 1)
3155 ;; This can fail when string contains a word with illegal chars.
3156 ;; Error handling needs to be added between ispell and emacs.
3157 (if (and (< 1 (length string))
3158 (equal 0 (string-match ispell-casechars string)))
3159 (ispell-send-string (concat "@" string "\n"))))))))
3162 ;;; returns optionally adjusted region-end-point.
3164 (defun ispell-add-per-file-word-list (word)
3165 "Add WORD to the per-file word list."
3166 (or ispell-buffer-local-name
3167 (setq ispell-buffer-local-name (buffer-name)))
3169 (goto-char (point-min))
3170 (let ((old-case-fold-search case-fold-search)
3171 line-okay search done string)
3173 (setq case-fold-search nil
3174 search (search-forward ispell-words-keyword nil 'move)
3175 line-okay (< (+ (length word) 1 ; 1 for space after word..
3176 (progn (end-of-line) (current-column)))
3178 case-fold-search old-case-fold-search)
3179 (if (or (and search line-okay)
3186 (setq string (concat comment-start " "
3187 ispell-words-keyword))
3189 (if (and comment-end (not (equal "" comment-end)))
3193 (insert comment-end)))))
3194 (insert (concat " " word))))))))
3196 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3201 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3203 ;;; Local Variable options:
3204 ;;; mode: name(-mode)
3205 ;;; eval: expression
3206 ;;; local-variable: value
3208 ;;; The following sets the buffer local dictionary to `american' English
3209 ;;; and spell checks only comments.
3211 ;;; Local Variables:
3212 ;;; mode: emacs-lisp
3213 ;;; comment-column: 40
3214 ;;; ispell-check-comments: exclusive
3215 ;;; ispell-local-dictionary: "american"
3219 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3221 ;;; The following places this file in nroff parsing and extended char modes.
3222 ;;; Local IspellParsing: nroff-mode ~nroff
3223 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3224 ;;; Local IspellPersDict ~/.ispell_lisp
3225 ;;; The following were automatically generated by ispell using the 'A' command:
3226 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3227 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3228 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3229 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3230 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3231 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3232 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3233 ; LocalWords: lns XEmacs HTML casechars Multibyte
3235 ;;; ispell.el ends here