1 ;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Ken Stevens <k.stevens@ieee.org>
7 ;; Maintainer: Ken Stevens <k.stevens@ieee.org>
8 ;; Stevens Mod Date: Mon Jan 7 12:32:44 PST 2003
9 ;; Stevens Revision: 3.6
10 ;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
11 ;; Bug Reports : ispell-el-bugs@itcorp.com
12 ;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, USA.
32 ;; Note: version numbers and time stamp are not updated
33 ;; when this file is edited for release with GNU emacs.
39 ;; This code contains a section of user-settable variables that you
40 ;; should inspect prior to installation. Look past the end of the history
41 ;; list. Set them up for your locale and the preferences of the majority
42 ;; of the users. Otherwise the users may need to set a number of variables
44 ;; You particularly may want to change the default dictionary for your
45 ;; country and language.
46 ;; Most dictionary changes should be made in this file so all users can
47 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
48 ;; file. Use the variable `ispell-local-dictionary-alist' to specify
49 ;; your own dictionaries.
51 ;; Depending on the mail system you use, you may want to include these:
52 ;; (add-hook 'news-inews-hook 'ispell-message)
53 ;; (add-hook 'mail-send-hook 'ispell-message)
54 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
56 ;; Ispell has a TeX parser and a nroff parser (the default).
57 ;; The parsing is controlled by the variable ispell-parser. Currently
58 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
59 ;; added it will be updated. See the variable description for more info.
68 ;; ispell-comments-and-strings
70 ;; ispell-complete-word
71 ;; ispell-complete-word-interior-frag
72 ;; ispell-change-dictionary
75 ;; ispell-skip-region-alist
77 ;; Commands in ispell-region:
78 ;; Character replacement: Replace word with choice. May query-replace.
79 ;; ` ': Accept word this time.
80 ;; `i': Accept word and insert into private dictionary.
81 ;; `a': Accept word for this session.
82 ;; `A': Accept word and place in buffer-local dictionary.
83 ;; `r': Replace word with typed-in value. Rechecked.
84 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
85 ;; `?': Show these commands
86 ;; `x': Exit spelling buffer. Move cursor to original point.
87 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
88 ;; the check to be completed later.
89 ;; `q': Quit spelling session (Kills ispell process).
90 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
91 ;; `u': Like `i', but the word is lower-cased first.
92 ;; `m': Place entered value in personal dictionary, then recheck current word.
93 ;; `C-l': redraws screen
94 ;; `C-r': recursive edit
95 ;; `C-z': suspend emacs or iconify frame
97 ;; Buffer-Local features:
98 ;; There are a number of buffer-local features that can be used to customize
99 ;; ispell for the current buffer. This includes language dictionaries,
100 ;; personal dictionaries, parsing, and local word spellings. Each of these
101 ;; local customizations are done either through local variables, or by
102 ;; including the keyword and argument(s) at the end of the buffer (usually
103 ;; prefixed by the comment characters). See the end of this file for
104 ;; examples. The local keywords and variables are:
106 ;; ispell-dictionary-keyword language-dictionary
107 ;; uses local variable ispell-local-dictionary
108 ;; ispell-pdict-keyword personal-dictionary
109 ;; uses local variable ispell-local-pdict
110 ;; ispell-parsing-keyword mode-arg extended-char-arg
111 ;; ispell-words-keyword any number of local word spellings
114 ;; Place new regular expression definitions of regions you prefer not to
115 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
116 ;; be added to latex by modifying `ispell-tex-skip-alists'.
117 ;; `ispell-message' contains some custom skipping code for e-mail messages.
120 ;; Need a way to select between different character mappings without separate
121 ;; dictionary entries.
122 ;; Multi-byte characters if not defined by current dictionary may result in the
123 ;; evil "misalignment error" in some versions of MULE emacs.
124 ;; On some versions of emacs, growing the minibuffer fails.
125 ;; see `ispell-help-in-bufferp'.
126 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
127 ;; can cause misalignment errors.
131 ;; Modifications made in latest versions:
133 ;; Revision 3.6 2003/01/07 12:32:44 kss
134 ;; Removed extra -d LIB in dictionary defs. (Pavel Janik)
135 ;; Filtered process calls with duplicate dictionary entries.
136 ;; Fixed bug where message-text-end is inside a mime skipped region.
137 ;; Minor fixes to get ispell menus right in XEmacs
138 ;; Fixed skip regexp so it doesn't match stuff like `/.\w'.
139 ;; Detecting dictionary change not working. Fixed. kss
140 ;; function `ispell-change-dictionary' now only completes valid dicts.
142 ;; Revision 3.5 2001/7/11 18:43:57 kss
143 ;; Added fix for aspell to work in XEmacs (ispell-check-version).
144 ;; Added Portuguese dictionary definition.
145 ;; New feature: MIME mail message support, Fcc support.
146 ;; Bug fix: retain comment syntax on lines with region skipping. (TeX $ bug...)
147 ;; Improved allocation for graphic mode lines. (Miles Bader)
148 ;; Support -v flag for old versions of aspell. (Eli Zaretskii)
149 ;; Clear minibuffer on ^G from ispell-help (Tak Ota)
151 ;; Revision 3.4 2000/8/4 09:41:50 kss
152 ;; Support new color display functions.
153 ;; Fixed misalignment offset bug when replacing a string after a shift made.
154 ;; Set to standard Author/Maintainer heading,
155 ;; ensure localwords lists are separated from the text by newline. (Dave Love)
156 ;; Added dictionary definition for Italian (William Deakin)
157 ;; HTML region skipping greatly improved. (Chuck D. Phillips)
158 ;; improved menus. Fixed regexp matching http/email addresses.
159 ;; one arg always for xemacs sleep-for (gunnar Evermann)
160 ;; support for synchronous processes (Eli Zaretskii)
162 ;; Revision 3.3 1999/11/29 11:38:34 kss
163 ;; Only word replacements entered in from the keyboard are rechecked.
164 ;; This fixes a bug in tex parsing and misalignment.
165 ;; Exceptions exist for recursive edit and query-replace, with tex error
166 ;; condition tested. Recursive editing improved.
167 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
168 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
169 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
170 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
173 ;; Revision 3.2 1999/5/7 14:25:14 kss
174 ;; Accept ispell versions 3.X.Y where X>=1
175 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
176 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
177 ;; Fixed bug in TeX parsing when math commands are in the comments.
178 ;; Removed calls to `when' macro.
180 ;; Revision 3.1 1998/12/1 13:21:52 kss
181 ;; Improved and fixed customize support.
182 ;; Improved and fixed comments in variables and messages.
183 ;; A coding system is now required for all languages.
184 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
185 ;; Dictionary norsk7-tex removed. Dictionary polish added.
186 ;; Dictionaries redefined at load-time to support dictionary changes.
187 ;; Menu redefined at load time to support dictionary changes.
188 ;; ispell-check-version added as an alias for `check-ispell-version'.
189 ;; Spelling suggestions returned in order generated by ispell.
190 ;; Small bug fixed in matching ispell error messages.
191 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
192 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
193 ;; Multibyte character coding support added for process interactions.
194 ;; Ensure ispell process has terminated before starting new process.
195 ;; This can otherwise confuse process filters and hang ispell.
196 ;; Improved skipping support for SGML.
197 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
198 ;; Improved message reference matching in `ispell-message'.
199 ;; Fixed bug in returning to nroff mode from tex mode.
204 (defvar mail-yank-prefix)
206 ;;; Custom.el macros require recompiling this when they are not present.
207 ;;; Add in backward compatible custom support.
209 (if (not (fboundp 'defcustom))
210 (defmacro defcustom (symbol value doc &rest args)
211 "Empty replacement for defcustom when not supplied."
212 `(defvar ,symbol ,value ,doc))))
215 (if (not (fboundp 'defgroup))
216 (defmacro defgroup (&rest args)
217 "Empty replacement for defgroup when not supplied.")))
220 "User variables for Emacs ispell interface."
221 :group 'applications)
223 (if (not (fboundp 'buffer-substring-no-properties))
224 (defun buffer-substring-no-properties (start end)
225 (buffer-substring start end)))
227 (defalias 'check-ispell-version 'ispell-check-version)
229 ;;; **********************************************************************
230 ;;; The following variables should be set according to personal preference
231 ;;; and location of binaries:
232 ;;; **********************************************************************
235 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
237 (defcustom ispell-highlight-p 'block
238 "*Highlight spelling errors when non-nil.
239 When set to `block', assumes a block cursor with TTY displays."
240 :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t))
243 (defcustom ispell-lazy-highlight (boundp 'lazy-highlight-cleanup)
244 "*Controls the lazy-highlighting of spelling errors.
245 When non-nil, all text in the buffer matching the current spelling
246 error is highlighted lazily using isearch lazy highlighting (see
247 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
249 :group 'lazy-highlight
253 (defcustom ispell-highlight-face (if ispell-lazy-highlight 'isearch 'highlight)
254 "*The face used for Ispell highlighting. For Emacses with overlays.
255 Possible values are `highlight', `modeline', `secondary-selection',
256 `region', and `underline'.
257 This variable can be set by the user to whatever face they desire.
258 It's most convenient if the cursor color and highlight color are
263 (defcustom ispell-check-comments t
264 "*Spelling of comments checked when non-nil.
265 When set to `exclusive', ONLY comments are checked. (For code comments).
266 Warning! Not checking comments, when a comment start is embedded in strings,
267 may produce undesired results."
268 :type '(choice (const exclusive) (const :tag "off" nil) (const :tag "on" t))
270 ;;;###autoload(put 'ispell-check-comments 'safe-local-variable (lambda (a) (memq a '(nil t exclusive))))
272 (defcustom ispell-query-replace-choices nil
273 "*Corrections made throughout region when non-nil.
274 Uses `query-replace' (\\[query-replace]) for corrections."
278 (defcustom ispell-skip-tib nil
279 "*Does not spell check `tib' bibliography references when non-nil.
280 Skips any text between strings matching regular expressions
281 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
283 TeX users beware: Any field starting with [. will skip until a .] -- even
284 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
285 a [.5mm] type of number...."
289 (defvar ispell-tib-ref-beginning "[[<]\\."
290 "Regexp matching the beginning of a Tib reference.")
292 (defvar ispell-tib-ref-end "\\.[]>]"
293 "Regexp matching the end of a Tib reference.")
295 (defcustom ispell-keep-choices-win t
296 "*When not nil, the `*Choices*' window remains for spelling session.
297 This minimizes redisplay thrashing."
301 (defcustom ispell-choices-win-default-height 2
302 "*The default size of the `*Choices*' window, including mode line.
303 Must be greater than 1."
307 (defcustom ispell-program-name
308 (or (locate-file "aspell" exec-path exec-suffixes 'file-executable-p)
310 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
314 (defcustom ispell-alternate-dictionary
315 (cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
316 ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
317 ((file-exists-p "/usr/dict/words") "/usr/dict/words")
318 ((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
319 ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
320 ((file-exists-p "/usr/share/lib/dict/words")
321 "/usr/share/lib/dict/words")
322 ((file-exists-p "/sys/dict") "/sys/dict")
323 (t "/usr/dict/words"))
324 "*Alternate dictionary for spelling help."
325 :type '(choice file (const :tag "None" nil))
328 (defcustom ispell-complete-word-dict ispell-alternate-dictionary
329 "*Dictionary used for word completion."
330 :type '(choice file (const :tag "None" nil))
333 (defcustom ispell-message-dictionary-alist nil
334 "*List used by `ispell-message' to select a new dictionary.
335 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
336 in the message headers, `ispell-local-dictionary' will be set to
337 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
338 E.g. you may use the following value:
339 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
340 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
341 :type '(repeat (cons regexp string))
345 (defcustom ispell-message-fcc-skip 50000
346 "*Query before saving Fcc message copy if attachment larger than this value.
347 Always stores Fcc copy of message when nil."
348 :type '(choice integer (const :tag "off" nil))
352 (defcustom ispell-grep-command "egrep"
353 "Name of the grep command for search processes."
357 (defcustom ispell-grep-options "-i"
358 "String of options to use when running the program in `ispell-grep-command'.
359 Should probably be \"-i\" or \"-e\".
360 Some machines (like the NeXT) don't support \"-i\""
364 (defcustom ispell-look-command
365 (cond ((file-exists-p "/bin/look") "/bin/look")
366 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
367 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
369 "Name of the look command for search processes.
370 This must be an absolute file name."
374 (defcustom ispell-look-p (file-exists-p ispell-look-command)
375 "*Non-nil means use `look' rather than `grep'.
376 Default is based on whether `look' seems to be available."
380 (defcustom ispell-have-new-look nil
381 "*Non-nil means use the `-r' option (regexp) when running `look'."
385 (defcustom ispell-look-options (if ispell-have-new-look "-dfr" "-df")
386 "String of command options for `ispell-look-command'."
390 (defcustom ispell-use-ptys-p nil
391 "When non-nil, Emacs uses ptys to communicate with Ispell.
392 When nil, Emacs uses pipes."
396 (defcustom ispell-following-word nil
397 "*Non-nil means `ispell-word' checks the word around or after point.
398 Otherwise `ispell-word' checks the preceding word."
402 (defcustom ispell-help-in-bufferp nil
403 "*Non-nil means display interactive keymap help in a buffer.
404 The following values are supported:
405 nil Expand the minibuffer and display a short help message
406 there for a couple of seconds.
407 t Pop up a new buffer and display a short help message there
408 for a couple of seconds.
409 electric Pop up a new buffer and display a long help message there.
410 User can browse and then exit the help mode."
411 :type '(choice (const electric) (const :tag "off" nil) (const :tag "on" t))
414 (defcustom ispell-quietly nil
415 "*Non-nil means suppress messages in `ispell-word'."
419 (defcustom ispell-format-word-function (function upcase)
420 "*Formatting function for displaying word being spell checked.
421 The function must take one string argument and return a string."
424 (defvaralias 'ispell-format-word 'ispell-format-word-function)
426 (defcustom ispell-use-framepop-p nil
427 "When non-nil ispell uses framepop to display choices in a dedicated frame.
428 You can set this variable to dynamically use framepop if you are in a
429 window system by evaluating the following on startup to set this variable:
430 (and window-system (condition-case () (require 'framepop) (error nil)))"
435 (defcustom ispell-personal-dictionary nil
436 "*File name of your personal spelling dictionary, or nil.
437 If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
438 where DICTNAME is the name of your default dictionary."
440 (const :tag "default" nil))
443 (defcustom ispell-silently-savep nil
444 "*When non-nil, save the personal dictionary without confirmation."
448 (defvar ispell-local-dictionary-overridden nil
449 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
450 (make-variable-buffer-local 'ispell-local-dictionary-overridden)
452 (defcustom ispell-local-dictionary nil
453 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
454 The value must be a string dictionary name,
455 or nil, which means use the global setting in `ispell-dictionary'.
456 Dictionary names are defined in `ispell-local-dictionary-alist'
457 and `ispell-dictionary-alist',
459 Setting `ispell-local-dictionary' to a value has the same effect as
460 calling \\[ispell-change-dictionary] with that value. This variable
461 is automatically set when defined in the file with either
462 `ispell-dictionary-keyword' or the Local Variable syntax."
463 :type '(choice string
464 (const :tag "default" nil))
466 ;;;###autoload(put 'ispell-local-dictionary 'safe-local-variable 'string-or-null-p)
468 (make-variable-buffer-local 'ispell-local-dictionary)
470 (defcustom ispell-extra-args nil
471 "*If non-nil, a list of extra switches to pass to the Ispell program.
472 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
473 words as correct. See also `ispell-dictionary-alist', which may be used
474 for language-specific arguments."
475 :type '(repeat string)
480 (defcustom ispell-skip-html 'use-mode-name
481 "*Indicates whether ispell should skip spell checking of SGML markup.
482 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
483 guess whether SGML markup should be skipped according to the name of the
484 buffer's major mode."
485 :type '(choice (const :tag "always" t) (const :tag "never" nil)
486 (const :tag "use-mode-name" use-mode-name))
489 (make-variable-buffer-local 'ispell-skip-html)
493 (defcustom ispell-local-dictionary-alist nil
494 "*List of local or customized dictionary definitions.
495 These can override the values in `ispell-dictionary-alist'.
497 To make permanent changes to your dictionary definitions, you
498 will need to make your changes in this variable, save, and then
500 :type '(repeat (list (choice :tag "Dictionary"
501 (string :tag "Dictionary name")
502 (const :tag "default" nil))
503 (regexp :tag "Case characters")
504 (regexp :tag "Non case characters")
505 (regexp :tag "Other characters")
506 (boolean :tag "Many other characters")
507 (repeat :tag "Ispell command line args"
509 (choice :tag "Extended character mode"
510 (const "~tex") (const "~plaintex")
511 (const "~nroff") (const "~list")
512 (const "~latin1") (const "~latin3")
513 (const :tag "default" nil))
514 (coding-system :tag "Coding System")))
518 ;;; split dictionary so line length is smaller in loaddefs.el
520 ;;; First part of dictionary, shortened for loaddefs.el
523 ispell-dictionary-alist-1
524 '((nil ; default (English.aff)
525 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
526 ("american" ; Yankee English
527 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
528 ("brasileiro" ; Brazilian mode
529 "[A-Z\301\311\315\323\332\300\310\314\322\331\303\325\307\334\302\312\324a-z\341\351\355\363\372\340\350\354\362\371\343\365\347\374\342\352\364]"
530 "[^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]"
531 "[']" nil nil nil iso-8859-1)
532 ("british" ; British version
533 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)
534 ("castellano" ; Spanish mode
535 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
536 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
537 "[-]" nil ("-B") "~tex" iso-8859-1)
538 ("castellano8" ; 8 bit Spanish mode
539 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
540 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
541 "[-]" nil ("-B" "-d" "castellano") "~latin1" iso-8859-1)))
544 ;;; Second part of dictionary, shortened for loaddefs.el
547 ispell-dictionary-alist-2
549 "[A-Za-z\301\311\314\315\323\332\331\335\256\251\310\330\317\253\322\341\351\354\355\363\372\371\375\276\271\350\370\357\273\362]"
550 "[^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]"
551 "" nil ("-B") nil iso-8859-2)
553 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
554 "[']" nil ("-C") nil iso-8859-1)
555 ("deutsch" ; Deutsch.aff
556 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
558 "[a-zA-Z\304\326\334\344\366\337\374]"
559 "[^a-zA-Z\304\326\334\344\366\337\374]"
560 "[']" t ("-C" "-d" "deutsch") "~latin1" iso-8859-1)
561 ("english" ; make English explicitly selectable
562 "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil iso-8859-1)))
565 ;;; Third part of dictionary, shortened for loaddefs.el
568 ispell-dictionary-alist-3
570 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
571 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
572 "[-']" t ("-C") "~latin3" iso-8859-3)
574 "[A-Za-z^\\]" "[^A-Za-z^\\]"
575 "[-'`\"]" t ("-C" "-d" "esperanto") "~tex" iso-8859-3)
577 "[A-Za-z]" "[^A-Za-z]" "[`'^-]" t nil nil iso-8859-1)
578 ("francais" ; Francais.aff
579 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374]"
580 "[^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]"
581 "[-'.@]" t nil "~list" iso-8859-1)
582 ("francais-tex" ; Francais.aff
583 "[A-Za-z\300\302\306\307\310\311\312\313\316\317\324\331\333\334\340\342\347\350\351\352\353\356\357\364\371\373\374\\]"
584 "[^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\\]"
585 "[-'^`\".@]" t nil "~tex" iso-8859-1)))
588 ;;; Fourth part of dictionary, shortened for loaddefs.el
591 ispell-dictionary-alist-4
592 '(("german" ; german.aff
593 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex" iso-8859-1)
594 ("german8" ; german.aff
595 "[a-zA-Z\304\326\334\344\366\337\374]"
596 "[^a-zA-Z\304\326\334\344\366\337\374]"
597 "[']" t ("-C" "-d" "german") "~latin1" iso-8859-1)
598 ("italiano" ; Italian.aff
599 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
600 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
601 "[-.]" nil ("-B" "-d" "italian") "~tex" iso-8859-1)
602 ("nederlands" ; Nederlands.aff
603 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
604 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
605 "[']" t ("-C") nil iso-8859-1)
606 ("nederlands8" ; Dutch8.aff
607 "[A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
608 "[^A-Za-z\300\301\302\303\304\305\307\310\311\312\313\314\315\316\317\322\323\324\325\326\331\332\333\334\340\341\342\343\344\345\347\350\351\352\353\354\355\356\357\361\362\363\364\365\366\371\372\373\374]"
609 "[']" t ("-C") nil iso-8859-1)))
612 ;;; Fifth part of dictionary, shortened for loaddefs.el
615 ispell-dictionary-alist-5
616 '(("norsk" ; 8 bit Norwegian mode
617 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
618 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
619 "[\"]" nil nil "~list" iso-8859-1)
620 ("norsk7-tex" ; 7 bit Norwegian TeX mode
621 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
622 "[\"]" nil ("-d" "norsk") "~plaintex" iso-8859-1)
623 ("polish" ; Polish mode
624 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
625 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
626 "[.]" nil nil nil iso-8859-2)
627 ("portugues" ; Portuguese mode
628 "[a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
629 "[^a-zA-Z\301\302\311\323\340\341\342\351\352\355\363\343\372]"
630 "[']" t ("-C") "~latin1" iso-8859-1)))
633 ;;; Sixth part of dictionary, shortened for loaddefs.el
636 ispell-dictionary-alist-6
637 ;; include Russian iso coding system too?
638 ;; "[']" t ("-d" "russian") "~latin1" iso-8859-1
639 '(("russian" ; Russian.aff (KOI8-R charset)
640 "[\341\342\367\347\344\345\263\366\372\351\352\353\354\355\356\357\360\362\363\364\365\346\350\343\376\373\375\370\371\377\374\340\361\301\302\327\307\304\305\243\326\332\311\312\313\314\315\316\317\320\322\323\324\325\306\310\303\336\333\335\330\331\337\334\300\321]"
641 "[^\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]"
642 "" nil nil nil koi8-r)
643 ("russianw" ; russianw.aff (CP1251 charset)
644 "[\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
645 "[^\300\301\302\303\304\305\250\306\307\310\311\312\313\314\315\316\317\320\321\322\323\324\325\326\327\330\331\334\333\332\335\336\337\340\341\342\343\344\345\270\346\347\350\351\352\353\354\355\356\357\360\361\362\363\364\365\366\367\370\371\374\373\372\375\376\377]"
646 "" nil nil nil windows-1251)
647 ("slovak" ; Slovakian
648 "[A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
649 "[^A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
650 "" nil ("-B") nil iso-8859-2)
651 ("slovenian" ; Slovenian
652 "[A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
653 "[^A-Za-z\301\304\311\315\323\332\324\300\305\245\335\256\251\310\317\253\322\341\344\351\355\363\372\364\340\345\265\375\276\271\350\357\273\362]"
654 "" nil ("-B" "-d" "slovenian") nil iso-8859-2)
655 ("svenska" ; Swedish mode
656 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
657 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
658 "[']" nil ("-C") "~list" iso-8859-1)))
662 (defvar ispell-dictionary-alist
663 (append ispell-dictionary-alist-1 ispell-dictionary-alist-2
664 ispell-dictionary-alist-3 ispell-dictionary-alist-4
665 ispell-dictionary-alist-5 ispell-dictionary-alist-6)
666 "An alist of dictionaries and their associated parameters.
668 Each element of this list is also a list:
670 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
671 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
673 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
674 nil means the default dictionary.
676 CASECHARS is a regular expression of valid characters that comprise a
679 NOT-CASECHARS is the opposite regexp of CASECHARS.
681 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
682 used to construct words in some special way. If OTHERCHARS characters follow
683 and precede characters from CASECHARS, they are parsed as part of a word,
684 otherwise they become word-breaks. As an example in English, assume the
685 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
686 \"Steven's\" are parsed as single words including the \"'\" character, but
687 \"Stevens'\" does not include the quote character as part of the word.
688 If you want OTHERCHARS to be empty, use the empty string.
689 Hint: regexp syntax requires the hyphen to be declared first here.
691 CASECHAS, NOT-CASECHARS, and OTHERCHARS must be a unibyte string
692 containing bytes of CHARACTER-SET. In addition, if they contain
693 a non-ASCII byte, the regular expression must be a single
694 `character set' construct that doesn't specify a character range
697 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
698 Otherwise only a single OTHERCHARS character is allowed to be part of any
701 ISPELL-ARGS is a list of additional arguments passed to the ispell
704 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
705 have been configured in an Ispell affix file. (For example, umlauts
706 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
707 in English. This has the same effect as the command-line `-T' option.
708 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
709 but the dictionary can control the extended character mode.
710 Both defaults can be overruled in a buffer-local fashion. See
711 `ispell-parsing-keyword' for details on this.
713 CHARACTER-SET used for languages with multibyte characters.
715 Note that the CASECHARS and OTHERCHARS slots of the alist should
716 contain the same character set as casechars and otherchars in the
717 LANGUAGE.aff file \(e.g., english.aff\).")
719 (defvar ispell-really-aspell nil) ; Non-nil if aspell extensions should be used
721 (defvar ispell-aspell-supports-utf8 nil
722 "Non-nil means to try to automatically find aspell dictionaries.
723 This is set to t in `ispell-check-version' for aspell >= 0.60.
725 Earlier aspell versions do not consistently support UTF-8. Handling
726 this would require some extra guessing in `ispell-aspell-find-dictionary'.")
730 ;;; **********************************************************************
731 ;;; The following are used by ispell, and should not be changed.
732 ;;; **********************************************************************
736 ;;; The version must be 3.1 or greater for this version of ispell.el
737 ;;; There is an incompatibility between version 3.1.12 and lower versions.
738 (defconst ispell-required-version '(3 1 12)
739 "Ispell versions with which this version of ispell.el is known to work.")
740 (defvar ispell-offset -1
741 "Offset that maps protocol differences between ispell 3.1 versions.")
743 (defconst ispell-version "ispell.el 3.6 - 7-Jan-2003")
746 (defun ispell-check-version (&optional interactivep)
747 "Ensure that `ispell-program-name' is valid and the correct version.
748 Returns version number if called interactively.
749 Otherwise returns the library directory name, if that is defined."
750 ;; This is a little wasteful as we actually launch ispell twice: once
751 ;; to make sure it's the right version, and once for real. But people
752 ;; get confused by version mismatches *all* the time (and I've got the
753 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
754 ;; option is the only way I can think of to do this that works with
755 ;; all versions, since versions earlier than 3.0.09 didn't identify
756 ;; themselves on startup.
758 (let ((case-fold-search-val case-fold-search)
759 ;; avoid bugs when syntax of `.' changes in various default modes
760 (default-major-mode 'fundamental-mode)
761 (default-directory (or (and (boundp 'temporary-file-directory)
762 temporary-file-directory)
766 (let ((buf (get-buffer " *ispell-tmp*")))
767 (if buf (kill-buffer buf)))
768 (set-buffer (get-buffer-create " *ispell-tmp*"))
770 (unless (file-exists-p default-directory)
771 (setq default-directory (expand-file-name "~/")))
772 (setq status (call-process
773 ispell-program-name nil t nil
774 ;; aspell doesn't accept the -vv switch.
775 (let ((case-fold-search
776 (memq system-type '(ms-dos windows-nt)))
778 (file-name-nondirectory ispell-program-name)))
779 ;; Assume anything that isn't `aspell' is Ispell.
780 (if (string-match "\\`aspell" speller) "-v" "-vv"))))
781 (goto-char (point-min))
783 ;; report version information of ispell and ispell.el
786 (setq result (concat (buffer-substring-no-properties (point-min)
790 (message "%s" result))
791 ;; return library directory.
792 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t)
793 (setq result (buffer-substring (match-beginning 1) (match-end 1)))))
794 (goto-char (point-min))
795 (if (not (memq status '(0 nil)))
796 (error "%s exited with %s %s" ispell-program-name
797 (if (stringp status) "signal" "code") status))
798 (setq case-fold-search t
799 status (re-search-forward
801 (format "%d" (car ispell-required-version))
802 "\\)\\.\\([0-9]*\\)\\.\\([0-9]*\\)\\>")
804 case-fold-search case-fold-search-val)
805 (if (or (not status) ; major version mismatch
806 (< (car (read-from-string (match-string-no-properties 2)))
807 (car (cdr ispell-required-version)))) ; minor version mismatch
808 (error "%s version 3 release %d.%d.%d or greater is required"
809 ispell-program-name (car ispell-required-version)
810 (car (cdr ispell-required-version))
811 (car (cdr (cdr ispell-required-version))))
812 ;; check that it is the correct version.
813 (if (and (= (car (read-from-string (match-string-no-properties 2)))
814 (car (cdr ispell-required-version)))
815 (< (car (read-from-string (match-string-no-properties 3)))
816 (car (cdr (cdr ispell-required-version)))))
817 (setq ispell-offset 0))
818 ;; Check to see if it's really aspell.
819 (goto-char (point-min))
820 (let (case-fold-search)
821 (setq ispell-really-aspell
822 (and (search-forward-regexp
823 "(but really Aspell \\(.*?\\)\\(-[0-9]+\\)?)" nil t)
825 (setq ispell-aspell-supports-utf8
826 (not (version< (match-string 1) "0.60")))
828 (kill-buffer (current-buffer)))
833 ;;; The preparation of the menu bar menu must be autoloaded
834 ;;; because otherwise this file gets autoloaded every time Emacs starts
835 ;;; so that it can set up the menus and determine keyboard equivalents.
839 (defvar ispell-menu-map nil "Key map for ispell menu.")
840 ;;; redo menu when loading ispell to get dictionary modifications
841 (setq ispell-menu-map nil)
844 (defvar ispell-menu-xemacs nil
845 "Spelling menu for XEmacs.
846 If nil when package is loaded, a standard menu will be set,
847 and added as a submenu of the \"Edit\" menu.")
849 ;;; Break out XEmacs menu and split into several calls to avoid having
850 ;;; long lines in loaddefs.el. Detect need off following constant.
852 ;;; Set up dictionary
854 (defvar ispell-menu-map-needed
855 ;; only needed when not version 18 and not XEmacs.
856 (and (not ispell-menu-map)
857 (not (featurep 'xemacs))
860 (defvar ispell-library-directory (condition-case ()
861 (ispell-check-version)
863 "Directory where ispell dictionaries reside.")
865 (defvar ispell-process nil
866 "The process object for Ispell.")
868 (defvar ispell-async-processp (and (fboundp 'delete-process)
869 (fboundp 'process-send-string)
870 (fboundp 'accept-process-output)
871 ;;(fboundp 'start-process)
872 ;;(fboundp 'set-process-filter)
873 ;;(fboundp 'process-kill-without-query)
875 "Non-nil means that the OS supports asynchronous processes.")
877 ;; Make ispell.el work better with aspell.
879 (defvar ispell-have-aspell-dictionaries nil
880 "Non-nil if we have queried Aspell for dictionaries at least once.")
882 (defun ispell-maybe-find-aspell-dictionaries ()
883 "Find Aspell's dictionaries, unless already done."
884 (when (and (not ispell-have-aspell-dictionaries)
886 (progn (ispell-check-version) t)
889 ispell-aspell-supports-utf8)
890 (ispell-find-aspell-dictionaries)))
892 (defun ispell-find-aspell-dictionaries ()
893 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
894 (unless ispell-really-aspell
895 (error "This function only works with aspell"))
899 (call-process ispell-program-name nil t nil "dicts")
901 ;; Search for the named dictionaries.
904 (mapcar #'ispell-aspell-find-dictionary dictionaries))))
905 ;; Ensure aspell's alias dictionary will override standard
907 (setq found (ispell-aspell-add-aliases found))
908 ;; Merge into FOUND any elements from the standard ispell-dictionary-alist
909 ;; which have no element in FOUND at all.
910 (dolist (dict ispell-dictionary-alist)
911 (unless (assoc (car dict) found)
912 (setq found (nconc found (list dict)))))
913 (setq ispell-dictionary-alist found)
914 ;; Add a default entry
915 (let* ((english-dict (assoc "en" ispell-dictionary-alist))
917 (cons nil (or (cdr english-dict)
918 (cdr (car ispell-dictionary-alist-1))))))
919 (push default-dict ispell-dictionary-alist))
920 (setq ispell-have-aspell-dictionaries t)))
922 (defvar ispell-aspell-data-dir nil
923 "Data directory of Aspell.")
925 (defvar ispell-aspell-dict-dir nil
926 "Dictionary directory of Aspell.")
928 (defun ispell-get-aspell-config-value (key)
929 "Return value of Aspell configuration option KEY.
930 Assumes that value contains no whitespace."
932 (call-process ispell-program-name nil t nil "config" key)
933 (car (split-string (buffer-string)))))
935 (defun ispell-aspell-find-dictionary (dict-name)
936 ;; This returns nil if the data file does not exist.
937 ;; Can someone please explain the return value format when the
938 ;; file does exist -- rms?
939 (let* ((lang ;; Strip out region, variant, etc.
940 (and (string-match "^[[:alpha:]]+" dict-name)
941 (match-string 0 dict-name)))
943 (concat (or ispell-aspell-data-dir
944 (setq ispell-aspell-data-dir
945 (ispell-get-aspell-config-value "data-dir")))
950 (insert-file-contents data-file)
951 ;; There is zero or one line with special characters declarations.
952 (when (search-forward-regexp "^special" nil t)
953 (let ((specials (split-string
954 (buffer-substring (point)
955 (progn (end-of-line) (point))))))
956 ;; The line looks like: special ' -** - -** . -** : -*-
957 ;; -** means that this character
958 ;; - doesn't appear at word start
959 ;; * may appear in the middle of a word
960 ;; * may appear at word end
961 ;; `otherchars' is about the middle case.
963 (when (eq (aref (cadr specials) 1) ?*)
964 (push (car specials) otherchars))
965 (setq specials (cddr specials)))))
969 (regexp-opt otherchars)
970 t ; We can't tell, so set this to t
971 (list "-d" dict-name "--encoding=utf-8")
972 nil ; aspell doesn't support this
973 ;; Here we specify the encoding to use while communicating with
974 ;; aspell. This doesn't apply to command line arguments, so
975 ;; just don't pass words to spellcheck as arguments...
980 (defun ispell-aspell-add-aliases (alist)
981 "Find aspell's dictionary aliases and add them to dictionary ALIST.
982 Return the new dictionary alist."
983 (let ((aliases (file-expand-wildcards
984 (concat (or ispell-aspell-dict-dir
985 (setq ispell-aspell-dict-dir
986 (ispell-get-aspell-config-value "dict-dir")))
988 (dolist (alias-file aliases)
990 (insert-file-contents alias-file)
991 ;; Look for a line "add FOO.multi", extract FOO
992 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t)
993 (let* ((aliasname (file-name-sans-extension
994 (file-name-nondirectory alias-file)))
995 (already-exists-p (assoc aliasname alist))
996 (realname (match-string 1))
997 (realdict (assoc realname alist)))
998 (when (and realdict (not already-exists-p))
999 (push (cons aliasname (cdr realdict)) alist))))))
1002 (defun ispell-valid-dictionary-list ()
1003 "Returns a list of valid dictionaries.
1004 The variable `ispell-library-directory' defines the library location."
1005 ;; If Ispell is really Aspell, query it for the dictionary list.
1006 (ispell-maybe-find-aspell-dictionaries)
1007 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist))
1008 (dict-list (cons "default" nil))
1010 (dolist (dict dicts)
1011 (setq name (car dict)
1012 load-dict (car (cdr (member "-d" (nth 5 dict)))))
1013 ;; Include if the dictionary is in the library, or dir not defined.
1016 ;; include all dictionaries if lib directory not known.
1017 ;; For Aspell, we already know which dictionaries exist.
1018 (or ispell-really-aspell
1019 (not ispell-library-directory)
1020 (file-exists-p (concat ispell-library-directory
1022 (file-exists-p (concat ispell-library-directory "/" name ".has"))
1024 (or (file-exists-p (concat ispell-library-directory
1025 "/" load-dict ".hash"))
1026 (file-exists-p (concat ispell-library-directory
1027 "/" load-dict ".has"))))))
1028 (setq dict-list (cons name dict-list))))
1031 ;;; define commands in menu in opposite order you want them to appear.
1033 (if ispell-menu-map-needed
1035 (setq ispell-menu-map (make-sparse-keymap "Spell"))
1036 (define-key ispell-menu-map [ispell-change-dictionary]
1037 '(menu-item "Change Dictionary..." ispell-change-dictionary
1038 :help "Supply explicit dictionary file name"))
1039 (define-key ispell-menu-map [ispell-kill-ispell]
1040 '(menu-item "Kill Process" ispell-kill-ispell
1041 :enable (and (boundp 'ispell-process) ispell-process
1042 (eq (ispell-process-status) 'run))
1043 :help "Terminate Ispell subprocess"))
1044 (define-key ispell-menu-map [ispell-pdict-save]
1045 '(menu-item "Save Dictionary"
1046 (lambda () (interactive) (ispell-pdict-save t t))
1047 :help "Save personal dictionary"))
1048 (define-key ispell-menu-map [ispell-customize]
1049 '(menu-item "Customize..."
1050 (lambda () (interactive) (customize-group 'ispell))
1051 :help "Customize spell checking options"))
1052 (define-key ispell-menu-map [ispell-help]
1053 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1055 (lambda () (interactive) (describe-function 'ispell-help))
1056 :help "Show standard Ispell keybindings and commands"))
1057 (define-key ispell-menu-map [flyspell-mode]
1058 '(menu-item "Automatic spell checking (Flyspell)"
1060 :help "Check spelling while you edit the text"
1061 :button (:toggle . (bound-and-true-p flyspell-mode))))
1062 (define-key ispell-menu-map [ispell-complete-word]
1063 '(menu-item "Complete Word" ispell-complete-word
1064 :help "Complete word at cursor using dictionary"))
1065 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
1066 '(menu-item "Complete Word Fragment" ispell-complete-word-interior-frag
1067 :help "Complete word fragment at cursor"))))
1070 (if ispell-menu-map-needed
1072 (define-key ispell-menu-map [ispell-continue]
1073 '(menu-item "Continue Spell-Checking" ispell-continue
1074 :enable (and (boundp 'ispell-region-end)
1075 (marker-position ispell-region-end)
1076 (equal (marker-buffer ispell-region-end)
1078 :help "Continue spell checking last region"))
1079 (define-key ispell-menu-map [ispell-word]
1080 '(menu-item "Spell-Check Word" ispell-word
1081 :help "Spell-check word at cursor"))
1082 (define-key ispell-menu-map [ispell-comments-and-strings]
1083 '(menu-item "Spell-Check Comments" ispell-comments-and-strings
1084 :help "Spell-check only comments and strings"))))
1087 (if ispell-menu-map-needed
1089 (define-key ispell-menu-map [ispell-region]
1090 '(menu-item "Spell-Check Region" ispell-region
1092 :help "Spell-check text in marked region"))
1093 (define-key ispell-menu-map [ispell-message]
1094 '(menu-item "Spell-Check Message" ispell-message
1095 :visible (eq major-mode 'mail-mode)
1096 :help "Skip headers and included message text"))
1097 (define-key ispell-menu-map [ispell-buffer]
1098 '(menu-item "Spell-Check Buffer" ispell-buffer
1099 :help "Check spelling of selected buffer"))
1100 ;;(put 'ispell-region 'menu-enable 'mark-active)
1101 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
1103 ;;; XEmacs versions 19 & 20
1104 (if (and (featurep 'xemacs)
1106 ;;(null ispell-menu-xemacs)
1107 (not (and (boundp 'infodock-version) infodock-version)))
1108 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list)
1109 (reverse (ispell-valid-dictionary-list))))
1110 (current-menubar (or current-menubar default-menubar))
1112 '(["Help" (describe-function 'ispell-help) t]
1113 ;;["Help" (popup-menu ispell-help-list) t]
1114 ["Check Message" ispell-message t]
1115 ["Check Buffer" ispell-buffer t]
1116 ["Check Comments" ispell-comments-and-strings t]
1117 ["Check Word" ispell-word t]
1118 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
1119 ["Continue Check" ispell-continue t]
1120 ["Complete Word Frag"ispell-complete-word-interior-frag t]
1121 ["Complete Word" ispell-complete-word t]
1122 ["Kill Process" ispell-kill-ispell t]
1123 ["Customize..." (customize-group 'ispell) t]
1124 ;; flyspell-mode may not be bound...
1125 ;;["flyspell" flyspell-mode
1126 ;; :style toggle :selected flyspell-mode ]
1128 ["Save Personal Dict"(ispell-pdict-save t t) t]
1129 ["Change Dictionary" ispell-change-dictionary t])))
1131 (setq dicts (cons "default" nil)))
1132 (dolist (name dicts)
1133 (setq menu (append menu
1136 (concat "Select " (capitalize name))
1137 (list 'ispell-change-dictionary name)
1139 (setq ispell-menu-xemacs menu)
1142 (if (car (find-menu-item current-menubar '("Cmds")))
1145 (delete-menu-item '("Cmds" "Spell-Check"))
1146 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs))
1148 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1149 (add-menu '("Edit") "Spell" ispell-menu-xemacs))))))
1151 ;;; Allow incrementing characters as integers in XEmacs 20
1152 (if (and (featurep 'xemacs)
1153 (fboundp 'int-char))
1154 (fset 'ispell-int-char 'int-char)
1155 ;; Emacs and XEmacs 19 or earlier
1156 (fset 'ispell-int-char 'identity))
1159 ;;; **********************************************************************
1162 ;;; This variable contains the current dictionary being used if the ispell
1163 ;;; process is running.
1164 (defvar ispell-current-dictionary nil
1165 "The name of the current dictionary, or nil for the default.
1166 This is passed to the ispell process using the `-d' switch and is
1167 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1169 (defvar ispell-current-personal-dictionary nil
1170 "The name of the current personal dictionary, or nil for the default.
1171 This is passed to the ispell process using the `-p' switch.")
1173 (defvar ispell-dictionary nil
1174 "Default dictionary to use if `ispell-local-dictionary' is nil.")
1176 (defun ispell-decode-string (str)
1177 "Decodes multibyte character strings.
1178 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1179 (if (and (or (featurep 'xemacs)
1180 (and (boundp 'enable-multibyte-characters)
1181 enable-multibyte-characters))
1182 (fboundp 'decode-coding-string)
1183 (ispell-get-coding-system))
1184 (decode-coding-string str (ispell-get-coding-system))
1187 ;; Return a string decoded from Nth element of the current dictionary.
1188 (defun ispell-get-decoded-string (n)
1190 (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1191 (assoc ispell-current-dictionary ispell-dictionary-alist)))
1193 (when (and (> (length str) 0)
1194 (not (multibyte-string-p str)))
1195 (setq str (ispell-decode-string str))
1196 (or (multibyte-string-p str)
1197 (setq str (string-to-multibyte str)))
1198 (setcar (nthcdr n slot) str))
1201 (defun ispell-get-casechars ()
1202 (ispell-get-decoded-string 1))
1203 (defun ispell-get-not-casechars ()
1204 (ispell-get-decoded-string 2))
1205 (defun ispell-get-otherchars ()
1206 (ispell-get-decoded-string 3))
1207 (defun ispell-get-many-otherchars-p ()
1208 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1209 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1210 (defun ispell-get-ispell-args ()
1211 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1212 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1213 (defun ispell-get-extended-character-mode ()
1214 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1215 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1216 (defun ispell-get-coding-system ()
1217 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1218 (assoc ispell-current-dictionary ispell-dictionary-alist))))
1221 (defvar ispell-pdict-modified-p nil
1222 "Non-nil means personal dictionary has modifications to be saved.")
1224 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1225 ;;; When non-nil, the spell session is terminated.
1226 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1227 (defvar ispell-quit nil)
1229 (defvar ispell-process-directory nil
1230 "The directory where `ispell-process' was started.")
1232 (defvar ispell-filter nil
1233 "Output filter from piped calls to Ispell.")
1235 (defvar ispell-filter-continue nil
1236 "Control variable for Ispell filter function.")
1238 (defvar ispell-output-buffer nil
1239 "Buffer used for reading output of a synchronous Ispell subprocess.")
1241 (defvar ispell-session-buffer nil
1242 "Buffer used for passing input to a synchronous Ispell subprocess.")
1244 (defvar ispell-cmd-args nil
1245 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1247 (defvar ispell-query-replace-marker (make-marker)
1248 "Marker for `query-replace' processing.")
1250 (defvar ispell-recursive-edit-marker (make-marker)
1251 "Marker for return point from recursive edit.")
1253 (defvar ispell-checking-message nil
1254 "Non-nil when we're checking a mail message.
1255 Set to the MIME boundary locations when checking messages.")
1257 (defconst ispell-choices-buffer "*Choices*")
1259 (defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
1261 ;;; *** Buffer Local Definitions ***
1263 (defconst ispell-words-keyword "LocalWords: "
1264 "The keyword for local oddly-spelled words to accept.
1265 The keyword will be followed by any number of local word spellings.
1266 There can be multiple of these keywords in the file.")
1268 (defconst ispell-dictionary-keyword "Local IspellDict: "
1269 "The keyword for a local dictionary to use.
1270 The keyword must be followed by a valid dictionary name, defined in
1271 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1272 When multiple occurrences exist, the last keyword
1273 definition is used.")
1275 (defconst ispell-pdict-keyword "Local IspellPersDict: "
1276 "The keyword for defining buffer local dictionaries.
1277 Keyword must be followed by the filename of a personal dictionary.
1278 The last occurring definition in the buffer will be used.")
1280 (defconst ispell-parsing-keyword "Local IspellParsing: "
1281 "The keyword for overriding default Ispell parsing.
1282 The above keyword string should be followed by `latex-mode' or
1283 `nroff-mode' to put the current buffer into the desired parsing mode.
1285 Extended character mode can be changed for this buffer by placing
1286 a `~' followed by an extended-character mode -- such as `~.tex'.
1287 The last occurring definition in the buffer will be used.")
1290 (defvar ispell-skip-region-alist
1291 '((ispell-words-keyword forward-line)
1292 (ispell-dictionary-keyword forward-line)
1293 (ispell-pdict-keyword forward-line)
1294 (ispell-parsing-keyword forward-line)
1295 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
1296 ;; assume multiline uuencoded file? "\nM.*$"?
1297 ("^begin [0-9][0-9][0-9] [^ \t]+$" . "\nend\n")
1298 ("^%!PS-Adobe-[123].0" . "\n%%EOF\n")
1299 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage"
1300 . "^---* End of [Ff]orwarded [Mm]essage")
1301 ;; Matches e-mail addresses, file names, http addresses, etc. The
1302 ;; `-+' `_+' patterns are necessary for performance reasons when
1303 ;; `-' or `_' part of word syntax.
1304 ("\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1305 ;; above checks /.\w sequences
1306 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1307 ;; This is a pretty complex regexp. It can be simplified to the following:
1308 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1309 ;; but some valid text will be skipped, e.g. "his/her". This could be
1310 ;; fixed up (at the expense of a moderately more complex regexp)
1311 ;; by not allowing "/" to be the character which triggers the
1312 ;; identification of the computer name, e.g.:
1313 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1315 "Alist expressing beginning and end of regions not to spell check.
1316 The alist key must be a regular expression.
1317 Valid forms include:
1318 (KEY) - just skip the key.
1319 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1320 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1321 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1322 (put 'ispell-skip-region-alist 'risky-local-variable t)
1326 (defvar ispell-tex-skip-alists
1327 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1328 ;; All the standard LaTeX keywords from L. Lamport's guide:
1329 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1330 ;; \label, \nocite, \rule (in ispell - rest included here)
1331 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1332 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1333 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
1334 ;;("\\\\author" ispell-tex-arg-end)
1335 ("\\\\bibliographystyle" ispell-tex-arg-end)
1336 ("\\\\makebox" ispell-tex-arg-end 0)
1337 ("\\\\e?psfig" ispell-tex-arg-end)
1338 ("\\\\document\\(class\\|style\\)" .
1339 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1340 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1341 ;; equation, minipage, picture, tabular, tabular* (ispell)
1342 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1343 ("list" ispell-tex-arg-end 2)
1344 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1345 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1346 "*Lists of regions to be skipped in TeX mode.
1347 First list is used raw.
1348 Second list has key placed inside \\begin{}.
1350 Delete or add any regions you want to be automatically selected
1351 for skipping in latex mode.")
1352 (put 'ispell-tex-skip-alist 'risky-local-variable t)
1356 (defvar ispell-html-skip-alists
1357 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1358 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1359 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1360 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1361 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1364 ("&[^ \t\n;]" "[; \t\n]"))
1365 "*Lists of start and end keys to skip in HTML buffers.
1366 Same format as `ispell-skip-region-alist'
1367 Note - substrings of other matches must come last
1368 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1369 (put 'ispell-html-skip-alists 'risky-local-variable t)
1371 (defvar ispell-local-pdict ispell-personal-dictionary
1372 "A buffer local variable containing the current personal dictionary.
1373 If non-nil, the value must be a string, which is a file name.
1375 If you specify a personal dictionary for the current buffer which is
1376 different from the current personal dictionary, the effect is similar
1377 to calling \\[ispell-change-dictionary]. This variable is automatically
1378 set when defined in the file with either `ispell-pdict-keyword' or the
1379 local variable syntax.")
1381 (make-variable-buffer-local 'ispell-local-pdict)
1383 (defvar ispell-buffer-local-name nil
1384 "Contains the buffer name if local word definitions were used.
1385 Ispell is then restarted because the local words could conflict.")
1387 (defvar ispell-parser 'use-mode-name
1388 "*Indicates whether ispell should parse the current buffer as TeX Code.
1389 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1390 Default parser is `nroff'.
1391 Currently the only other valid parser is `tex'.
1393 You can set this variable in hooks in your init file -- eg:
1395 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1397 (defvar ispell-region-end (make-marker)
1398 "Marker that allows spelling continuations.")
1400 (defvar ispell-check-only nil
1401 "If non-nil, `ispell-word' does not try to correct the word.")
1404 ;;; **********************************************************************
1405 ;;; **********************************************************************
1409 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1412 (defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1413 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1414 If asynchronous subprocesses are not supported, call `ispell-filter' and
1415 pass it the output of the last ispell invocation."
1416 (if ispell-async-processp
1417 (accept-process-output ispell-process timeout-secs timeout-msecs)
1418 (if (null ispell-process)
1419 (error "No Ispell process to read output from!")
1420 (let ((buf ispell-output-buffer)
1422 (if (not (bufferp buf))
1423 (setq ispell-filter nil)
1426 (setq ispell-output (buffer-substring-no-properties
1427 (point-min) (point-max))))
1428 (ispell-filter t ispell-output)
1431 (erase-buffer)))))))
1433 (defun ispell-send-replacement (misspelled replacement)
1434 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1435 This allows it to improve the suggestion list based on actual mispellings."
1436 (and ispell-really-aspell
1437 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1440 (defun ispell-send-string (string)
1441 "Send the string STRING to the Ispell process."
1442 (if ispell-async-processp
1443 (process-send-string ispell-process string)
1444 ;; Asynchronous subprocesses aren't supported on this losing system.
1445 ;; We keep all the directives passed to Ispell during the entire
1446 ;; session in a buffer, and pass them anew each time we invoke
1447 ;; Ispell to process another chunk of text. (Yes, I know this is a
1448 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1449 (let ((cmd (aref string 0))
1450 ;; The following commands are not passed to Ispell until
1451 ;; we have a *real* reason to invoke it.
1452 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1453 (default-major-mode 'fundamental-mode)
1454 (session-buf ispell-session-buffer)
1455 (output-buf ispell-output-buffer)
1456 (ispell-args ispell-cmd-args)
1457 (defdir ispell-process-directory)
1460 (set-buffer session-buf)
1461 (setq prev-pos (point))
1462 (setq default-directory defdir)
1464 (if (not (memq cmd cmds-to-defer))
1465 (let (coding-system-for-read coding-system-for-write status)
1466 (if (and (boundp 'enable-multibyte-characters)
1467 enable-multibyte-characters)
1468 (setq coding-system-for-read (ispell-get-coding-system)
1469 coding-system-for-write (ispell-get-coding-system)))
1470 (set-buffer output-buf)
1472 (set-buffer session-buf)
1474 (apply 'call-process-region (point-min) (point-max)
1475 ispell-program-name nil
1477 "-a" "-m" ispell-args))
1478 (set-buffer output-buf)
1479 (goto-char (point-min))
1481 (if (not (looking-at "@(#) "))
1482 (error "Ispell error: %s"
1483 (buffer-substring-no-properties
1484 (point) (progn (end-of-line) (point)))))
1485 ;; If STRING is "^Z\n", we just started Ispell and need
1486 ;; to retain its version ID line in the output buffer.
1487 ;; Otherwise, remove the ID line, as it will confuse
1489 (or (string= string "\032\n")
1492 (delete-region (point-min) (point))))
1493 ;; If STRING begins with ^ or any normal character, we need
1494 ;; to remove the last line from the session buffer, since it
1495 ;; was just spell-checked, and we don't want to check it again.
1496 ;; The same goes for the # command, since Ispell already saved
1497 ;; the personal dictionary.
1498 (set-buffer session-buf)
1499 (delete-region prev-pos (point))
1500 ;; Ispell run synchronously saves the personal dictionary
1501 ;; after each successful command. So we can remove any
1502 ;; lines in the session buffer that insert words into the
1504 (if (memq status '(0 nil))
1505 (let ((more-lines t))
1506 (goto-char (point-min))
1508 (if (looking-at "^\\*")
1509 (let ((start (point)))
1511 (delete-region start (point)))
1512 (setq more-lines (= 0 (forward-line))))))))))))))
1515 ;; Insert WORD while translating Latin characters to the equivalent
1516 ;; characters that is supported by buffer-file-coding-system.
1518 (defun ispell-insert-word (word)
1519 (let ((pos (point)))
1521 (if (char-table-p translation-table-for-input)
1522 (translate-region pos (point) translation-table-for-input))))
1525 (defun ispell-word (&optional following quietly continue)
1526 "Check spelling of word under or before the cursor.
1527 If the word is not found in dictionary, display possible corrections
1528 in a window allowing you to choose one.
1530 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1531 is non-nil when called interactively, then the following word
1532 \(rather than preceding\) is checked when the cursor is not over a word.
1533 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1534 when called interactively, non-corrective messages are suppressed.
1536 With a prefix argument (or if CONTINUE is non-nil),
1537 resume interrupted spell-checking of a buffer or region.
1539 Word syntax is controlled by the definition of the chosen dictionary,
1540 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1542 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1543 or \\[ispell-region] to update the Ispell process.
1546 nil word is correct or spelling is accepted.
1547 0 word is inserted into buffer-local definitions.
1548 \"word\" word corrected from word list.
1549 \(\"word\" arg\) word is hand entered.
1550 quit spell session exited."
1552 (interactive (list ispell-following-word ispell-quietly current-prefix-arg))
1555 (ispell-maybe-find-aspell-dictionaries)
1556 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1557 (let ((cursor-location (point)) ; retain cursor location
1558 (word (ispell-get-word following))
1559 start end poss new-word replace)
1560 ;; De-structure return word info list.
1561 (setq start (car (cdr word))
1562 end (car (cdr (cdr word)))
1565 ;; At this point it used to ignore 2-letter words.
1566 ;; But that is silly; if the user asks for it, we should do it. - rms.
1568 (message "Checking spelling of %s..."
1569 (funcall ispell-format-word-function word)))
1570 (ispell-send-string "%\n") ; put in verbose mode
1571 (ispell-send-string (concat "^" word "\n"))
1572 ;; wait until ispell has processed word
1574 (ispell-accept-output)
1575 (not (string= "" (car ispell-filter)))))
1576 ;;(ispell-send-string "!\n") ;back to terse mode.
1577 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1578 (if (and ispell-filter (listp ispell-filter))
1579 (if (> (length ispell-filter) 1)
1580 (error "Ispell and its process have different character maps")
1581 (setq poss (ispell-parse-output (car ispell-filter)))))
1584 (message "%s is correct"
1585 (funcall ispell-format-word-function word)))
1586 (and (fboundp 'extent-at)
1588 (and (fboundp 'delete-extent)
1589 (delete-extent (extent-at start)))))
1592 (message "%s is correct because of root %s"
1593 (funcall ispell-format-word-function word)
1594 (funcall ispell-format-word-function poss)))
1595 (and (fboundp 'extent-at)
1597 (and (fboundp 'delete-extent)
1598 (delete-extent (extent-at start)))))
1599 ((null poss) (message "Error in ispell process"))
1600 (ispell-check-only ; called from ispell minor mode.
1601 (if (fboundp 'make-extent)
1602 (if (fboundp 'set-extent-property)
1603 (let ((ext (make-extent start end)))
1604 (set-extent-property ext 'face ispell-highlight-face)
1605 (set-extent-property ext 'priority 2000)))
1607 (message "%s is incorrect"
1608 (funcall ispell-format-word-function word))))
1609 (t ; prompt for correct word.
1610 (save-window-excursion
1611 (setq replace (ispell-command-loop
1612 (car (cdr (cdr poss)))
1613 (car (cdr (cdr (cdr poss))))
1614 (car poss) start end)))
1615 (cond ((equal 0 replace)
1616 (ispell-add-per-file-word-list (car poss)))
1618 (setq new-word (if (atom replace) replace (car replace))
1619 cursor-location (+ (- (length word) (- end start))
1621 (if (not (equal new-word (car poss)))
1624 ;; Insert first and then delete,
1625 ;; to avoid collapsing markers before and after
1626 ;; into a single place.
1627 (ispell-insert-word new-word)
1628 (delete-region (point) (+ (point) (- end start)))
1629 ;; It is meaningless to preserve the cursor position
1630 ;; inside a word that has changed.
1631 (setq cursor-location (point))
1632 (setq end (point))))
1633 (if (not (atom replace)) ;recheck spelling of replacement
1635 (if (car (cdr replace)) ; query replace requested
1636 (save-window-excursion
1637 (query-replace word new-word t)))
1639 ;; single word could be split into multiple words
1640 (setq ispell-quit (not (ispell-region start end)))
1642 ;; keep if rechecking word and we keep choices win.
1643 (if (get-buffer ispell-choices-buffer)
1644 (kill-buffer ispell-choices-buffer))))
1645 (ispell-pdict-save ispell-silently-savep)
1646 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1647 (if ispell-quit (setq ispell-quit nil replace 'quit))
1648 (goto-char cursor-location) ; return to original location
1652 (defun ispell-get-word (following &optional extra-otherchars)
1653 "Return the word for spell-checking according to ispell syntax.
1654 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1655 is non-nil when called interactively, then the following word
1656 \(rather than preceding\) is checked when the cursor is not over a word.
1657 Optional second argument contains otherchars that can be included in word
1660 Word syntax is controlled by the definition of the chosen dictionary,
1661 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1662 (let* ((ispell-casechars (ispell-get-casechars))
1663 (ispell-not-casechars (ispell-get-not-casechars))
1664 (ispell-otherchars (ispell-get-otherchars))
1665 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1666 (word-regexp (concat ispell-casechars
1668 (if (not (string= "" ispell-otherchars))
1669 (concat ispell-otherchars "?"))
1670 (if extra-otherchars
1671 (concat extra-otherchars "?"))
1674 (if (or ispell-many-otherchars-p
1680 (if (not (looking-at ispell-casechars))
1682 (re-search-forward ispell-casechars (point-max) t)
1683 (re-search-backward ispell-casechars (point-min) t)))
1684 ;; move to front of word
1685 (re-search-backward ispell-not-casechars (point-min) 'start)
1686 (while (and (or (and (not (string= "" ispell-otherchars))
1687 (looking-at ispell-otherchars))
1688 (and extra-otherchars (looking-at extra-otherchars)))
1690 (or (not did-it-once)
1691 ispell-many-otherchars-p)
1692 (not (eq prevpt (point))))
1693 (if (and extra-otherchars (looking-at extra-otherchars))
1696 (if (looking-at ispell-casechars)
1697 (re-search-backward ispell-not-casechars (point-min) 'move)))
1701 (if (looking-at ispell-casechars)
1702 (re-search-backward ispell-not-casechars (point-min) 'move)
1703 (backward-char -1))))
1704 ;; Now mark the word and save to string.
1705 (if (not (re-search-forward word-regexp (point-max) t))
1706 (if ispell-check-only
1707 ;; return dummy word when just flagging misspellings
1708 (list "" (point) (point))
1709 (error "No word found to check!"))
1710 (setq start (match-beginning 0)
1712 word (buffer-substring-no-properties start end))
1713 (list word start end))))
1716 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1717 ;;; tracks changes in the dictionary. The global may either be
1718 ;;; a value or a list, whose value is the state of whether the
1719 ;;; dictionary needs to be saved.
1722 (defun ispell-pdict-save (&optional no-query force-save)
1723 "Check to see if the personal dictionary has been modified.
1724 If so, ask if it needs to be saved."
1725 (interactive (list ispell-silently-savep t))
1726 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1727 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1728 (if (or ispell-pdict-modified-p force-save)
1729 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1731 (ispell-send-string "#\n") ; save dictionary
1732 (message "Personal dictionary saved."))))
1733 ;; unassert variable, even if not saved to avoid questioning.
1734 (setq ispell-pdict-modified-p nil))
1737 (defun ispell-command-loop (miss guess word start end)
1738 "Display possible corrections from list MISS.
1739 GUESS lists possibly valid affix construction of WORD.
1740 Returns nil to keep word.
1741 Returns 0 to insert locally into buffer-local dictionary.
1742 Returns string for new chosen word.
1743 Returns list for new replacement word (will be rechecked).
1744 Query-replace when list length is 2.
1745 Automatic query-replace when second element is `query-replace'.
1746 Highlights the word, which is assumed to run from START to END.
1747 Global `ispell-pdict-modified-p' becomes a list where the only value
1748 indicates whether the dictionary has been modified when option `a' or `i' is
1750 Global `ispell-quit' set to start location to continue spell session."
1752 (line ispell-choices-win-default-height)
1753 ;; ensure 4 context lines.
1754 (max-lines (- (ispell-adjusted-window-height) 4))
1756 (window-min-height (min window-min-height
1757 ispell-choices-win-default-height))
1758 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
1759 (dedicated (window-dedicated-p (selected-window)))
1761 char num result textwin dedicated-win)
1763 ;; setup the *Choices* buffer with valid data.
1765 (set-buffer (get-buffer-create ispell-choices-buffer))
1766 (setq mode-line-format
1767 (concat "-- %b -- word: " word
1768 " -- dict: " (or ispell-current-dictionary "default")
1769 " -- prog: " (file-name-nondirectory ispell-program-name)))
1770 ;; XEmacs: no need for horizontal scrollbar in choices window
1772 (and (fboundp 'set-specifier)
1773 (boundp 'horizontal-scrollbar-visible-p)
1774 (set-specifier horizontal-scrollbar-visible-p nil
1775 (cons (current-buffer) nil))))
1779 (insert "Affix rules generate and capitalize "
1780 "this word as shown below:\n\t")
1782 (if (> (+ 4 (current-column) (length (car guess)))
1786 (setq line (1+ line))))
1787 (insert (car guess) " ")
1788 (setq guess (cdr guess)))
1789 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.")
1790 (setq line (+ line (if choices 3 2)))))
1792 (< (if (> (+ 7 (current-column) (length (car choices))
1793 (if (> count ?~) 3 0))
1797 (setq line (1+ line)))
1800 ;; not so good if there are over 20 or 30 options, but then, if
1801 ;; there are that many you don't want to scan them all anyway...
1802 (while (memq count command-characters) ; skip command characters.
1803 (setq count (ispell-int-char (1+ count))
1804 skipped (1+ skipped)))
1805 (insert "(" count ") " (car choices) " ")
1806 (setq choices (cdr choices)
1807 count (ispell-int-char (1+ count))))
1808 (setq count (ispell-int-char (- count ?0 skipped))))
1810 ;; ensure word is visible
1811 (if (not (pos-visible-in-window-p end))
1814 ;; allow temporary split of dedicated windows...
1817 (setq dedicated-win (selected-window))
1818 (set-window-dedicated-p dedicated-win nil)))
1820 ;; Display choices for misspelled word.
1821 (ispell-show-choices line end)
1822 (select-window (setq textwin (next-window)))
1824 ;; highlight word, protecting current buffer status
1827 (and ispell-highlight-p
1828 (ispell-highlight-spelling-error start end t))
1829 ;; Loop until a valid choice is made.
1837 (let (message-log-max)
1838 (message (concat "C-h or ? for more options; SPC to leave "
1839 "unchanged, Character to replace word")))
1840 (let ((inhibit-quit t))
1841 (setq char (if (fboundp 'read-char-exclusive)
1842 (read-char-exclusive)
1845 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1848 ;; Adjust num to array offset skipping command characters.
1849 (let ((com-chars command-characters))
1851 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1852 (setq skipped (1+ skipped)))
1853 (setq com-chars (cdr com-chars)))
1854 (setq num (- char ?0 skipped)))
1857 ((= char ? ) nil) ; accept word this time only
1858 ((= char ?i) ; accept and insert word into pers dict
1859 (ispell-send-string (concat "*" word "\n"))
1860 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1862 ((or (= char ?a) (= char ?A)) ; accept word without insert
1863 (ispell-send-string (concat "@" word "\n"))
1864 (if (null ispell-pdict-modified-p)
1865 (setq ispell-pdict-modified-p
1866 (list ispell-pdict-modified-p)))
1867 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1868 ((or (= char ?r) (= char ?R)) ; type in replacement
1869 (and (eq 'block ispell-highlight-p) ; refresh tty's
1870 (ispell-highlight-spelling-error start end nil t))
1872 (if (or (= char ?R) ispell-query-replace-choices)
1874 (format "Query-replacement for %s: "word)
1877 (cons (read-string "Replacement for: " word)
1879 (and (eq 'block ispell-highlight-p)
1880 (ispell-highlight-spelling-error start end nil
1883 ((or (= char ??) (= char help-char) (= char ?\C-h))
1884 (and (eq 'block ispell-highlight-p)
1885 (ispell-highlight-spelling-error start end nil t))
1887 (and (eq 'block ispell-highlight-p)
1888 (ispell-highlight-spelling-error start end nil
1891 ;; Quit and move point back.
1893 (ispell-pdict-save ispell-silently-savep)
1894 (message "Exited spell-checking")
1895 (setq ispell-quit t)
1897 ;; Quit and preserve point.
1899 (ispell-pdict-save ispell-silently-savep)
1901 (substitute-command-keys
1902 (concat "Spell-checking suspended;"
1903 " use C-u \\[ispell-word] to resume")))
1904 (setq ispell-quit start)
1907 (if (y-or-n-p "Really kill Ispell process? ")
1909 (ispell-kill-ispell t) ; terminate process.
1910 (setq ispell-quit (or (not ispell-checking-message)
1912 ispell-pdict-modified-p nil))
1913 t)) ; continue if they don't quit.
1915 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1916 (ispell-highlight-spelling-error start end nil t))
1917 (let ((new-word (read-string
1918 "Lookup string (`*' is wildcard): "
1923 (set-buffer (get-buffer-create
1924 ispell-choices-buffer))
1929 (concat "-- %b -- word: " new-word
1931 ispell-alternate-dictionary)
1932 miss (lookup-words new-word)
1934 line ispell-choices-win-default-height)
1935 (while (and choices ; adjust choices window.
1936 (< (if (> (+ 7 (current-column)
1937 (length (car choices))
1938 (if (> count ?~) 3 0))
1942 (setq line (1+ line)))
1945 (while (memq count command-characters)
1946 (setq count (ispell-int-char (1+ count))
1947 skipped (1+ skipped)))
1948 (insert "(" count ") " (car choices) " ")
1949 (setq choices (cdr choices)
1950 count (ispell-int-char (1+ count))))
1951 (setq count (ispell-int-char
1952 (- count ?0 skipped))))
1953 (ispell-show-choices line end)
1954 (select-window (next-window)))))
1955 (and (eq 'block ispell-highlight-p)
1956 (ispell-highlight-spelling-error start end nil
1958 t) ; reselect from new choices
1959 ((= char ?u) ; insert lowercase into dictionary
1960 (ispell-send-string (concat "*" (downcase word) "\n"))
1961 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1963 ((= char ?m) ; type in what to insert
1965 (concat "*" (read-string "Insert: " word) "\n"))
1966 (setq ispell-pdict-modified-p '(t))
1968 ((and (>= num 0) (< num count))
1969 (if ispell-query-replace-choices ; Query replace flag
1970 (list (nth num miss) 'query-replace)
1975 ;; This may have alignment errors if current line is edited
1976 (if (marker-position ispell-recursive-edit-marker)
1978 (message "Only one recursive edit session supported")
1981 (set-marker ispell-recursive-edit-marker start)
1982 ;;(set-marker ispell-region-end reg-end)
1983 (and ispell-highlight-p ; unhighlight
1984 (ispell-highlight-spelling-error start end))
1989 (substitute-command-keys
1990 (concat "Exit recursive edit with"
1991 " \\[exit-recursive-edit]")))
1992 (save-window-excursion (save-excursion
1995 (goto-char ispell-recursive-edit-marker)
1996 (if (not (equal (marker-buffer
1997 ispell-recursive-edit-marker)
2000 (set-marker ispell-recursive-edit-marker nil)
2002 "Cannot continue ispell from this buffer.")))
2003 (set-marker ispell-recursive-edit-marker nil)))
2004 (list word nil)) ; recheck starting at this word.
2006 (funcall (key-binding "\C-z"))
2011 (and ispell-highlight-p ; unhighlight
2012 (save-window-excursion
2013 (select-window textwin)
2014 (ispell-highlight-spelling-error start end)))
2016 (set-window-dedicated-p dedicated-win t)))))
2020 (defun ispell-show-choices (line end)
2021 "Shows the choices in another buffer or frame."
2022 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
2024 (framepop-display-buffer (get-buffer ispell-choices-buffer))
2025 ;;; (get-buffer-window ispell-choices-buffer t)
2026 (select-window (previous-window))) ; *Choices* window
2027 ;; standard selection by splitting a small buffer out of this window.
2028 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
2030 (if (= line (ispell-adjusted-window-height choices-window))
2031 (select-window choices-window)
2032 ;; *Choices* window changed size. Adjust the choices window
2033 ;; without scrolling the spelled window when possible
2035 (- line (ispell-adjusted-window-height choices-window)))
2036 (visible (progn (vertical-motion -1) (point))))
2037 (if (< line ispell-choices-win-default-height)
2038 (setq window-line (+ window-line
2039 (- ispell-choices-win-default-height
2041 (move-to-window-line 0)
2042 (vertical-motion window-line)
2043 (set-window-start (selected-window)
2044 (if (> (point) visible) visible (point)))
2046 (select-window choices-window)
2047 (enlarge-window window-line)))
2048 ;; Overlay *Choices* window when it isn't showing
2049 (ispell-overlay-window (max line ispell-choices-win-default-height)))
2050 (switch-to-buffer ispell-choices-buffer)
2051 (goto-char (point-min)))))
2055 (defun ispell-help ()
2056 "Display a list of the options available when a misspelling is encountered.
2060 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2061 SPC: Accept word this time.
2062 `i': Accept word and insert into private dictionary.
2063 `a': Accept word for this session.
2064 `A': Accept word and place in `buffer-local dictionary'.
2065 `r': Replace word with typed-in value. Rechecked.
2066 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2067 `?': Show these commands.
2068 `x': Exit spelling buffer. Move cursor to original point.
2069 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2070 the aborted check to be completed later.
2071 `q': Quit spelling session (Kills ispell process).
2072 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2073 `u': Like `i', but the word is lower-cased first.
2074 `m': Place typed-in value in personal dictionary, then recheck current word.
2075 `C-l': redraws screen
2076 `C-r': recursive edit
2077 `C-z': suspend Emacs or iconify frame"
2079 (if (equal ispell-help-in-bufferp 'electric)
2083 (function (lambda ()
2084 ;;This shouldn't be necessary: with-electric-help needs
2085 ;; an optional argument telling it about the smallest
2086 ;; acceptable window-height of the help buffer.
2087 ;;(if (< (window-height) 15)
2089 ;; (- 15 (ispell-adjusted-window-height))))
2090 (princ "Selections are:
2092 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2093 SPC: Accept word this time.
2094 `i': Accept word and insert into private dictionary.
2095 `a': Accept word for this session.
2096 `A': Accept word and place in `buffer-local dictionary'.
2097 `r': Replace word with typed-in value. Rechecked.
2098 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2099 `?': Show these commands.
2100 `x': Exit spelling buffer. Move cursor to original point.
2101 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2102 the aborted check to be completed later.
2103 `q': Quit spelling session (Kills ispell process).
2104 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2105 `u': Like `i', but the word is lower-cased first.
2106 `m': Place typed-in value in personal dictionary, then recheck current word.
2107 `C-l': redraws screen
2108 `C-r': recursive edit
2109 `C-z': suspend Emacs or iconify frame")
2110 nil ;undocumented requirement of with-electric-help
2114 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2115 "[i]nsert into private dictionary"))
2116 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2117 "e[x/X]it; [q]uit session"))
2118 (help-3 (concat "[u]ncapitalized insert into dict. "
2119 "Type 'x C-h f ispell-help' for more help")))
2120 (save-window-excursion
2121 (if ispell-help-in-bufferp
2123 (ispell-overlay-window 4)
2124 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2125 (insert (concat help-1 "\n" help-2 "\n" help-3))
2127 (kill-buffer "*Ispell Help*"))
2129 (let ((resize-mini-windows 'grow-only))
2130 (select-window (minibuffer-window))
2133 ;;(set-minibuffer-window (selected-window))
2135 (insert (concat help-1 "\n" help-2 "\n" help-3))
2137 (erase-buffer)))))))
2140 (defun lookup-words (word &optional lookup-dict)
2141 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2142 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2143 Otherwise the variable `ispell-grep-command' contains the command used to
2144 search for the words (usually egrep).
2146 Optional second argument contains the dictionary to use; the default is
2147 `ispell-alternate-dictionary'."
2148 ;; We don't use the filter for this function, rather the result is written
2149 ;; into a buffer. Hence there is no need to save the filter values.
2150 (if (null lookup-dict)
2151 (setq lookup-dict ispell-alternate-dictionary))
2153 (let* ((process-connection-type ispell-use-ptys-p)
2154 (wild-p (string-match "\\*" word))
2155 (look-p (and ispell-look-p ; Only use look for an exact match.
2156 (or ispell-have-new-look (not wild-p))))
2157 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2158 (prog (if look-p ispell-look-command ispell-grep-command))
2159 (args (if look-p ispell-look-options ispell-grep-options))
2162 (save-window-excursion
2163 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
2164 (set-buffer ispell-grep-buffer)
2168 (insert "^" word "$")
2169 (while (search-backward "*" nil t) (insert "."))
2170 (setq word (buffer-string))
2172 (setq status (apply 'call-process prog nil t nil
2173 (nconc (if (and args (> (length args) 0))
2178 (if lookup-dict (list lookup-dict)))))
2179 ;; grep returns status 1 and no output when word not found, which
2180 ;; is a perfectly normal thing.
2181 (if (stringp status)
2182 (setq results (cons (format "error: %s exited with signal %s"
2183 (file-name-nondirectory prog) status)
2185 ;; else collect words into `results' in FIFO order
2186 (goto-char (point-max))
2187 ;; assure we've ended with \n
2188 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
2192 (setq results (cons (buffer-substring-no-properties (point)
2196 (kill-buffer ispell-grep-buffer)
2197 (if (and results (string-match ".+: " (car results)))
2198 (error "%s error: %s" ispell-grep-command (car results))))
2202 ;;; "ispell-filter" is a list of output lines from the generating function.
2203 ;;; Each full line (ending with \n) is a separate item on the list.
2204 ;;; "output" can contain multiple lines, part of a line, or both.
2205 ;;; "start" and "end" are used to keep bounds on lines when "output" contains
2207 ;;; "ispell-filter-continue" is true when we have received only part of a
2208 ;;; line as output from a generating function ("output" did not end with \n)
2209 ;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2210 ;;; This is the case when a process dies or fails. The default behavior
2211 ;;; in this case treats the next input received as fresh input.
2213 (defun ispell-filter (process output)
2214 "Output filter function for ispell, grep, and look."
2219 (setq end (string-match "\n" output start)) ; get text up to the newline.
2220 ;; If we get out of sync and ispell-filter-continue is asserted when we
2221 ;; are not continuing, treat the next item as a separate list. When
2222 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2225 ;; Continue with same line (item)?
2226 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
2227 ;; Yes. Add it to the prev item
2228 (setcar ispell-filter
2229 (concat (car ispell-filter) (substring output start end)))
2230 ;; No. This is a new line and item.
2232 (cons (substring output start end) ispell-filter)))
2234 ;; We've completed reading the output, but didn't finish the line.
2235 (setq ispell-filter-continue t continue nil)
2236 ;; skip over newline, this line complete.
2237 (setq ispell-filter-continue nil end (1+ end))
2238 (if (= end (length output)) ; No more lines in output
2239 (setq continue nil) ; so we can exit the filter.
2240 (setq start end)))))) ; else move start to next line of input
2243 ;;; This function destroys the mark location if it is in the word being
2245 (defun ispell-highlight-spelling-error-generic (start end &optional highlight
2247 "Highlight the word from START to END with a kludge using `inverse-video'.
2248 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2249 otherwise it is displayed normally.
2250 Uses block cursor to highlight one character.
2251 Optional REFRESH will unhighlighted then highlight, using block cursor
2252 highlighting when REFRESH is equal to `block'."
2253 (and (eq 'block ispell-highlight-p)
2254 (or (eq 'block refresh)
2255 (setq start (1+ start)))) ; On block non-refresh, inc start.
2256 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2257 (buffer-read-only nil) ; Allow highlighting read-only buffers.
2258 (text (buffer-substring-no-properties start end)) ; Save hilight region
2259 (inhibit-quit t) ; inhibit interrupt processing here.
2260 (buffer-undo-list t)) ; don't clutter the undo list.
2262 (delete-region start end)
2263 (insert-char ? (- end start)) ; minimize amount of redisplay
2264 (sit-for 0) ; update display
2265 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2266 (delete-region start end) ; delete whitespace
2267 (insert text) ; insert text in inverse video.
2268 (sit-for 0) ; update display showing inverse video.
2271 (setq inverse-video (not inverse-video)) ; toggle video
2272 (and (eq 'block ispell-highlight-p)
2273 (goto-char (1- start)))) ; use block cursor to "highlight" char
2274 (set-buffer-modified-p modified) ; don't modify if flag not set.
2275 (and refresh ; re-highlight
2276 (ispell-highlight-spelling-error-generic
2277 (if (eq 'block refresh) start (- start 2)) end t))))
2280 (defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
2281 "Highlight the word from START to END using `isearch-highlight'.
2282 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2283 otherwise it is displayed normally."
2285 (isearch-highlight start end)
2286 (isearch-dehighlight))
2291 (defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
2292 "Highlight the word from START to END using overlays.
2293 When the optional third arg HIGHLIGHT is set, the word is highlighted
2294 otherwise it is displayed normally.
2296 The variable `ispell-highlight-face' selects the face to use for highlighting."
2299 (move-overlay ispell-overlay start end (current-buffer))
2300 (setq ispell-overlay (make-overlay start end))
2301 (overlay-put ispell-overlay 'priority 1001) ;higher than lazy overlays
2302 (overlay-put ispell-overlay 'face ispell-highlight-face))
2304 (delete-overlay ispell-overlay)))
2305 (if (and ispell-lazy-highlight (boundp 'lazy-highlight-cleanup))
2307 (let ((isearch-string
2310 (regexp-quote (buffer-substring-no-properties start end))
2313 (isearch-case-fold-search nil))
2314 (isearch-lazy-highlight-new-loop
2315 (if (boundp 'reg-start) reg-start)
2316 (if (boundp 'reg-end) reg-end)))
2317 (lazy-highlight-cleanup lazy-highlight-cleanup)
2318 (setq isearch-lazy-highlight-last-string nil))))
2321 (defun ispell-highlight-spelling-error (start end &optional highlight refresh)
2324 (ispell-highlight-spelling-error-xemacs start end highlight))
2325 ((and (featurep 'faces)
2326 (or (and (fboundp 'display-color-p) (display-color-p))
2328 (ispell-highlight-spelling-error-overlay start end highlight))
2329 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
2331 (defun ispell-adjusted-window-height (&optional window)
2332 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2333 The value returned is actually the nominal number of text-lines in the
2334 window plus 1. On a terminal, this is the same value returned by
2335 `window-height', but if the window has a mode-line is taller than a normal
2336 text line, the returned value may be smaller than that from
2338 (cond ((fboundp 'window-text-height)
2339 (1+ (window-text-height window)))
2340 ((or (and (fboundp 'display-graphic-p) (display-graphic-p))
2341 (and (featurep 'xemacs) window-system))
2342 (1- (window-height window)))
2344 (window-height window))))
2346 (defun ispell-overlay-window (height)
2347 "Create a window covering the top HEIGHT lines of the current window.
2348 Ensure that the line above point is still visible but otherwise avoid
2349 scrolling the current window. Leave the new window selected."
2351 (let ((oldot (save-excursion (vertical-motion -1) (point)))
2352 (top (save-excursion (move-to-window-line height) (point))))
2353 ;; If line above old point (line starting at oldot) would be
2354 ;; hidden by new window, scroll it to just below new win
2355 ;; otherwise set top line of other win so it doesn't scroll.
2356 (if (< oldot top) (setq top oldot))
2357 ;; if frame is unsplitable, temporarily disable that...
2358 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2359 (let ((frame (selected-frame)))
2360 (modify-frame-parameters frame '((unsplittable . nil)))
2361 (split-window nil height)
2362 (modify-frame-parameters frame '((unsplittable . t))))
2363 (split-window nil height))
2364 (let ((deficit (- height (ispell-adjusted-window-height))))
2366 ;; Number of lines the window is still too short. We ensure that
2367 ;; there are at least (1- HEIGHT) lines visible in the window.
2368 (enlarge-window deficit)
2370 (vertical-motion deficit)
2371 (setq top (min (point) oldot))))
2372 (set-window-start (next-window) top))))
2375 ;;; Should we add a compound word match return value?
2376 (defun ispell-parse-output (output &optional accept-list shift)
2377 "Parse the OUTPUT string from Ispell process and return:
2378 1: t for an exact match.
2379 2: A string containing the root word matched via suffix removal.
2380 3: A list of possible correct spellings of the format:
2381 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2382 ORIGINAL-WORD is a string of the possibly misspelled word.
2383 OFFSET is an integer giving the line offset of the word.
2384 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2385 4: nil when an error has occurred.
2387 Optional second arg ACCEPT-LIST is list of words already accepted.
2388 Optional third arg SHIFT is an offset to apply based on previous corrections."
2390 ((string= output "") t) ; for startup with pipes...
2391 ((string= output "*") t) ; exact match
2392 ((string= output "-") t) ; compound word match
2393 ((eq (aref output 0) ?+) ; found because of root word
2394 (substring output 2)) ; return root word
2395 ((equal 0 (string-match "[\ra-zA-Z]" output))
2396 (ding) ; error message from ispell!
2397 (message "Ispell error: %s" output)
2400 (t ; need to process &, ?, and #'s
2401 (let ((type (aref output 0)) ; &, ?, or #
2402 (original-word (substring output 2 (string-match " " output 2)))
2403 (cur-count 0) ; contains number of misses + guesses
2404 count miss-list guess-list offset)
2405 (setq output (substring output (match-end 0))) ; skip over misspelling
2407 (setq count 0) ; no misses for type #
2408 (setq count (string-to-number output) ; get number of misses.
2409 output (substring output (1+ (string-match " " output 1)))))
2410 (setq offset (string-to-number output))
2411 (if (eq type ?#) ; No miss or guess list.
2413 (setq output (substring output (1+ (string-match " " output 1)))))
2415 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2416 (setq cur-count (1+ cur-count))
2417 (if (> cur-count count)
2418 (setq guess-list (cons (substring output 0 end) guess-list))
2419 (setq miss-list (cons (substring output 0 end) miss-list)))
2420 (if (match-end 1) ; True only when at end of line.
2421 (setq output nil) ; no more misses or guesses
2422 (setq output (substring output (+ end 2))))))
2423 ;; return results. Accept word if it was already accepted.
2425 (if (member original-word accept-list)
2428 (if (numberp shift) (+ shift offset) offset)
2429 (nreverse miss-list) (nreverse guess-list)))))))
2432 (defun ispell-process-status ()
2433 "Return the status of the Ispell process.
2434 When asynchronous processes are not supported, `run' is always returned."
2435 (if ispell-async-processp
2436 (process-status ispell-process)
2437 (and ispell-process 'run)))
2440 (defun ispell-start-process ()
2441 "Start the ispell process, with support for no asynchronous processes.
2442 Keeps argument list for future ispell invocations for no async support."
2444 ;; Local dictionary becomes the global dictionary in use.
2445 (setq ispell-current-dictionary
2446 (or ispell-local-dictionary ispell-dictionary))
2447 (setq ispell-current-personal-dictionary
2448 (or ispell-local-pdict ispell-personal-dictionary))
2449 (setq args (ispell-get-ispell-args))
2450 (if (and ispell-current-dictionary ; use specified dictionary
2451 (not (member "-d" args))) ; only define if not overridden
2453 (append (list "-d" ispell-current-dictionary) args)))
2454 (if ispell-current-personal-dictionary ; use specified pers dict
2458 (expand-file-name ispell-current-personal-dictionary)))))
2459 (setq args (append args ispell-extra-args))
2461 ;; Initially we don't know any buffer's local words.
2462 (setq ispell-buffer-local-name nil)
2464 (if ispell-async-processp
2465 (let ((process-connection-type ispell-use-ptys-p))
2466 (apply 'start-process
2467 "ispell" nil ispell-program-name
2468 "-a" ; accept single input lines
2469 "-m" ; make root/affix combos not in dict
2471 (setq ispell-cmd-args args
2472 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2473 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2474 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2479 (defun ispell-init-process ()
2480 "Check status of Ispell process and start if necessary."
2481 (if (and ispell-process
2482 (eq (ispell-process-status) 'run)
2483 ;; If we're using a personal dictionary, ensure
2484 ;; we're in the same default directory!
2485 (or (not ispell-personal-dictionary)
2486 (equal ispell-process-directory default-directory)))
2487 (setq ispell-filter nil ispell-filter-continue nil)
2488 ;; may need to restart to select new personal dictionary.
2489 (ispell-kill-ispell t)
2490 (message "Starting new Ispell process [%s] ..."
2491 (or ispell-local-dictionary ispell-dictionary "default"))
2493 (setq ispell-library-directory (ispell-check-version)
2494 ispell-process-directory default-directory
2495 ispell-process (ispell-start-process)
2497 ispell-filter-continue nil)
2498 (if ispell-async-processp
2499 (set-process-filter ispell-process 'ispell-filter))
2500 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
2501 (if (and (or (featurep 'xemacs)
2502 (and (boundp 'enable-multibyte-characters)
2503 enable-multibyte-characters))
2504 (fboundp 'set-process-coding-system))
2505 (set-process-coding-system ispell-process (ispell-get-coding-system)
2506 (ispell-get-coding-system)))
2507 ;; Get version ID line
2508 (ispell-accept-output 3)
2509 ;; get more output if filter empty?
2510 (if (null ispell-filter) (ispell-accept-output 3))
2511 (cond ((null ispell-filter)
2512 (error "%s did not output version line" ispell-program-name))
2514 (stringp (car ispell-filter))
2515 (if (string-match "warning: " (car ispell-filter))
2517 (ispell-accept-output 3) ; was warn msg.
2518 (stringp (car ispell-filter)))
2519 (null (cdr ispell-filter)))
2520 (string-match "^@(#) " (car ispell-filter)))
2521 ;; got the version line as expected (we already know it's the right
2522 ;; version, so don't bother checking again.)
2525 ;; Otherwise, it must be an error message. Show the user.
2526 ;; But first wait to see if some more output is going to arrive.
2527 ;; Otherwise we get cool errors like "Can't open ".
2529 (ispell-accept-output 3)
2530 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2531 (setq ispell-filter nil) ; Discard version ID line
2532 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2533 (if extended-char-mode ; ~ extended character mode
2534 (ispell-send-string (concat extended-char-mode "\n"))))
2535 (if ispell-async-processp
2536 (set-process-query-on-exit-flag ispell-process nil))))
2539 (defun ispell-kill-ispell (&optional no-error)
2540 "Kill current Ispell process (so that you may start a fresh one).
2541 With NO-ERROR, just return non-nil if there was no Ispell running."
2543 ;; This hook is typically used by flyspell to flush some variables used
2544 ;; to optimize the common cases.
2545 (run-hooks 'ispell-kill-ispell-hook)
2546 (if (not (and ispell-process
2547 (eq (ispell-process-status) 'run)))
2549 (error "There is no ispell process running!"))
2550 (if ispell-async-processp
2551 (delete-process ispell-process)
2552 ;; synchronous processes
2553 (ispell-send-string "\n") ; make sure side effects occurred.
2554 (kill-buffer ispell-output-buffer)
2555 (kill-buffer ispell-session-buffer)
2556 (setq ispell-output-buffer nil
2557 ispell-session-buffer nil))
2558 (setq ispell-process nil)
2559 (message "Ispell process killed")
2563 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2564 ;;; call ispell-init-process rather than wait for a spell checking command?
2567 (defun ispell-change-dictionary (dict &optional arg)
2568 "Change to dictionary DICT for Ispell.
2569 With a prefix arg, set it \"globally\", for all buffers.
2570 Without a prefix arg, set it \"locally\", just for this buffer.
2572 By just answering RET you can find out what the current dictionary is."
2574 (list (completing-read
2575 "Use new dictionary (RET for current, SPC to complete): "
2576 (and (fboundp 'ispell-valid-dictionary-list)
2577 (mapcar 'list (ispell-valid-dictionary-list)))
2579 current-prefix-arg))
2580 (ispell-maybe-find-aspell-dictionaries)
2581 (unless arg (ispell-buffer-local-dict 'no-reload))
2582 (if (equal dict "default") (setq dict nil))
2583 ;; This relies on completing-read's bug of returning "" for no match
2584 (cond ((equal dict "")
2585 (ispell-internal-change-dictionary)
2586 (message "Using %s dictionary"
2587 (or (and (not arg) ispell-local-dictionary)
2588 ispell-dictionary "default")))
2589 ((equal dict (or (and (not arg) ispell-local-dictionary)
2590 ispell-dictionary "default"))
2591 ;; Specified dictionary is the default already. Could reload
2592 ;; the dictionaries if needed.
2593 (ispell-internal-change-dictionary)
2594 (and (interactive-p)
2595 (message "No change, using %s dictionary" dict)))
2596 (t ; reset dictionary!
2597 (if (or (assoc dict ispell-local-dictionary-alist)
2598 (assoc dict ispell-dictionary-alist))
2600 ;; set default dictionary
2601 (setq ispell-dictionary dict)
2602 ;; set local dictionary
2603 (setq ispell-local-dictionary dict)
2604 (setq ispell-local-dictionary-overridden t))
2605 (error "Undefined dictionary: %s" dict))
2606 (ispell-internal-change-dictionary)
2607 (message "%s Ispell dictionary set to %s"
2608 (if arg "Global" "Local")
2611 (defun ispell-internal-change-dictionary ()
2612 "Update the dictionary and the personal dictionary used by Ispell.
2613 This may kill the Ispell process; if so,
2614 a new one will be started when needed."
2615 (let ((dict (or ispell-local-dictionary ispell-dictionary))
2616 (pdict (or ispell-local-pdict ispell-personal-dictionary)))
2617 (unless (and (equal ispell-current-dictionary dict)
2618 (equal ispell-current-personal-dictionary pdict))
2619 (ispell-kill-ispell t)
2620 (setq ispell-current-dictionary dict
2621 ispell-current-personal-dictionary pdict))))
2623 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2626 (defun ispell-region (reg-start reg-end &optional recheckp shift)
2627 "Interactively check a region for spelling errors.
2628 Return nil if spell session is quit,
2629 otherwise returns shift offset amount for last line processed."
2630 (interactive "r") ; Don't flag errors on read-only bufs.
2631 (ispell-maybe-find-aspell-dictionaries)
2633 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2634 (let ((skip-region-start (make-marker))
2635 (rstart (make-marker)))
2638 (message "Spell checking %s using %s with %s dictionary..."
2639 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2640 (buffer-name) "region")
2641 (file-name-nondirectory ispell-program-name)
2642 (or ispell-current-dictionary "default"))
2643 ;; Returns cursor to original location.
2644 (save-window-excursion
2645 (goto-char reg-start)
2646 (let ((transient-mark-mode)
2647 (case-fold-search case-fold-search)
2650 (let (message-log-max)
2651 (message "searching for regions to skip"))
2652 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t)
2654 (setq key (buffer-substring-no-properties
2655 (match-beginning 0) (match-end 0)))
2656 (set-marker skip-region-start (- (point) (length key)))
2657 (goto-char reg-start)))
2658 (let (message-log-max)
2659 (message "Continuing spelling check using %s with %s dictionary..."
2660 (file-name-nondirectory ispell-program-name)
2661 (or ispell-current-dictionary "default")))
2662 (set-marker rstart reg-start)
2663 (set-marker ispell-region-end reg-end)
2664 (while (and (not ispell-quit)
2665 (< (point) ispell-region-end))
2666 ;; spell-check region with skipping
2667 (if (and (marker-position skip-region-start)
2668 (<= skip-region-start (point)))
2670 ;; If region inside line comment, must keep comment start.
2671 (setq in-comment (point)
2674 (or (null comment-end) (string= "" comment-end))
2677 (re-search-forward comment-start in-comment t))
2679 ;; Can change skip-regexps (in ispell-message)
2680 (ispell-skip-region key) ; moves pt past region.
2681 (set-marker rstart (point))
2682 ;; check for saving large attachments...
2683 (setq query-fcc (and query-fcc
2684 (ispell-ignore-fcc skip-region-start
2686 (if (and (< rstart ispell-region-end)
2688 (ispell-begin-skip-region-regexp)
2689 ispell-region-end t))
2691 (setq key (match-string-no-properties 0))
2692 (set-marker skip-region-start
2693 (- (point) (length key)))
2695 (set-marker skip-region-start nil))))
2696 (setq reg-end (max (point)
2697 (if (marker-position skip-region-start)
2698 (min skip-region-start ispell-region-end)
2699 (marker-position ispell-region-end))))
2700 (let* ((start (point))
2701 (end (save-excursion (end-of-line) (min (point) reg-end)))
2702 (string (ispell-get-line start end in-comment)))
2703 (if in-comment ; account for comment chars added
2704 (setq start (- start (length in-comment))
2706 (setq end (point)) ; "end" tracks region retrieved.
2707 (if string ; there is something to spell check!
2708 ;; (special start end)
2709 (setq shift (ispell-process-line string
2710 (and recheckp shift))))
2716 (if (and (not (and recheckp ispell-keep-choices-win))
2717 (get-buffer ispell-choices-buffer))
2718 (kill-buffer ispell-choices-buffer))
2719 (set-marker skip-region-start nil)
2720 (set-marker rstart nil)
2723 ;; preserve or clear the region for ispell-continue.
2724 (if (not (numberp ispell-quit))
2725 (set-marker ispell-region-end nil)
2726 ;; Ispell-continue enabled - ispell-region-end is set.
2727 (goto-char ispell-quit))
2728 ;; Check for aborting
2729 (if (and ispell-checking-message (numberp ispell-quit))
2731 (setq ispell-quit nil)
2732 (error "Message send aborted")))
2733 (if (not recheckp) (setq ispell-quit nil)))
2734 (if (not recheckp) (set-marker ispell-region-end nil))
2735 ;; Only save if successful exit.
2736 (ispell-pdict-save ispell-silently-savep)
2737 (message "Spell-checking using %s with %s dictionary done"
2738 (file-name-nondirectory ispell-program-name)
2739 (or ispell-current-dictionary "default"))))))
2742 (defun ispell-begin-skip-region-regexp ()
2743 "Returns a regexp of the search keys for region skipping.
2744 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2745 Must call after ispell-buffer-local-parsing due to dependence on mode."
2746 ;; start with regions generic to all buffers
2747 (let ((skip-regexp (ispell-begin-skip-region ispell-skip-region-alist)))
2749 (if (and (null ispell-check-comments) comment-start)
2750 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2752 (if (and (eq 'exclusive ispell-check-comments) comment-start)
2753 ;; search from end of current comment to start of next comment.
2754 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2755 (regexp-quote comment-end))
2756 "\\|" skip-regexp)))
2759 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
2761 (if ispell-skip-html
2762 (setq skip-regexp (concat
2763 (ispell-begin-skip-region ispell-html-skip-alists)
2767 (if (eq ispell-parser 'tex)
2768 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2771 (if (and ispell-checking-message
2772 (not (eq t ispell-checking-message)))
2773 (setq skip-regexp (concat
2774 (mapconcat (lambda (lst) (car lst))
2775 ispell-checking-message
2780 ;; return new regexp
2784 (defun ispell-begin-skip-region (skip-alist)
2785 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2786 Each selection should be a key of SKIP-ALIST;
2787 otherwise, the current line is skipped."
2788 (mapconcat (lambda (lst) (if (stringp (car lst)) (car lst) (eval (car lst))))
2793 (defun ispell-begin-tex-skip-regexp ()
2794 "Regular expression of tex commands to skip.
2795 Generated from `ispell-tex-skip-alists'."
2798 (mapconcat (function (lambda (lst) (car lst)))
2799 (car ispell-tex-skip-alists)
2802 ;; keys wrapped in begin{}
2803 (mapconcat (function (lambda (lst)
2804 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2807 (car (cdr ispell-tex-skip-alists))
2811 (defun ispell-skip-region-list ()
2812 "Returns a list describing key and body regions to skip for this buffer.
2813 Includes regions defined by `ispell-skip-region-alist', tex mode,
2814 `ispell-html-skip-alists', and `ispell-checking-message'.
2815 Manual checking must include comments and tib references.
2816 The list is of the form described by variable `ispell-skip-region-alist'.
2817 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2818 (let ((skip-alist ispell-skip-region-alist))
2819 ;; only additional explicit region definition is tex.
2820 (if (eq ispell-parser 'tex)
2821 (setq case-fold-search nil
2822 skip-alist (append (car ispell-tex-skip-alists)
2823 (car (cdr ispell-tex-skip-alists))
2825 (if ispell-skip-html
2826 (setq skip-alist (append ispell-html-skip-alists skip-alist)))
2827 (if (and ispell-checking-message
2828 (not (eq t ispell-checking-message)))
2829 (setq skip-alist (append ispell-checking-message skip-alist)))
2833 (defun ispell-tex-arg-end (&optional arg)
2834 "Skip across ARG number of braces."
2837 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2838 (forward-sexp (or arg 1)))
2840 (message "error skipping s-expressions at point %d." (point))
2845 (defun ispell-ignore-fcc (start end)
2846 "Deletes the Fcc: message header when large attachments are included.
2847 Return value `nil' if file with large attachments are saved.
2848 This can be used to avoid multiple questions for multiple large attachments.
2849 Returns point to starting location afterwards."
2851 (if (and ispell-checking-message ispell-message-fcc-skip)
2852 (if (< ispell-message-fcc-skip (- end start))
2853 (let (case-fold-search head-end)
2854 (goto-char (point-min))
2856 (or (re-search-forward
2857 (concat "^" (regexp-quote mail-header-separator) "$")
2859 (re-search-forward "^$" nil t)
2861 (goto-char (point-min))
2862 (if (re-search-forward "^Fcc:" head-end t)
2864 "Save copy of this message with large attachments? ")
2872 (defun ispell-skip-region (key)
2873 "Skips across KEY and then to end of region.
2874 Key lookup determines region to skip.
2875 Point is placed at end of skipped region."
2876 ;; move over key to begin checking.
2877 (forward-char (length key))
2878 (let ((start (point))
2879 ;; Regenerate each call... This function can change region definition.
2880 (alist (ispell-skip-region-list))
2881 alist-key null-skip)
2883 ;; what about quoted comment, or comment inside strings?
2884 ((and (null ispell-check-comments) comment-start
2885 (string= key comment-start))
2886 (if (string= "" comment-end)
2888 (search-forward comment-end ispell-region-end t)))
2889 ((and (eq 'exclusive ispell-check-comments) comment-start
2890 (string= key comment-end))
2891 (search-forward comment-start ispell-region-end :end))
2892 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2893 (re-search-forward ispell-tib-ref-end ispell-region-end t))
2894 ;; markings from alist
2897 (setq alist-key (eval (car (car alist))))
2898 (if (string-match alist-key key)
2900 (setq alist (cdr (car alist)))
2902 ((null alist) (setq null-skip t)) ; done! Just skip key.
2903 ((not (consp alist))
2904 ;; Search past end of spell region to find this region end.
2905 (re-search-forward (eval alist) (point-max) t))
2906 ((and (= 1 (length alist))
2907 (stringp (car alist)))
2908 (re-search-forward (car alist) (point-max) t))
2910 (setq null-skip t) ; error handling in functions!
2911 (if (consp (cdr alist))
2912 (apply (car alist) (cdr alist))
2913 (funcall (car alist)))))
2915 (setq alist (cdr alist))))))
2916 (if (and (= start (point)) (null null-skip))
2918 (message "Matching region end for `%s' point %d not found"
2924 ;;; Grab the next line of data.
2925 ;;; Returns a string with the line data
2926 (defun ispell-get-line (start end in-comment)
2927 (let ((ispell-casechars (ispell-get-casechars))
2929 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2930 ((eolp) ; END OF LINE, just go to next line.
2932 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
2933 ;; (forward-char 1)) ; not needed as quoted below.
2934 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2935 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
2936 (setq string (concat "^" in-comment
2937 (buffer-substring-no-properties start end)
2940 (t (goto-char end))) ; EMPTY LINE, skip it.
2944 (defun ispell-looking-at (string)
2945 (let ((coding (ispell-get-coding-system))
2946 (len (length string)))
2947 (and (<= (+ (point) len) (point-max))
2948 (equal (encode-coding-string string coding)
2949 (encode-coding-string (buffer-substring-no-properties
2950 (point) (+ (point) len))
2953 ;;; Avoid error messages when compiling for these dynamic variables.
2957 (defun ispell-process-line (string shift)
2958 "Sends a LINE of text to ispell and processes the result.
2959 This will modify the buffer for spelling errors.
2960 Requires variables START and END to be defined in its lexical scope.
2961 Returns the sum shift due to changes in word replacements."
2962 ;;(declare special start end)
2963 (let (poss accept-list)
2964 (if (not (numberp shift))
2966 ;; send string to spell process and get input.
2967 (ispell-send-string string)
2969 (ispell-accept-output)
2970 ;; Last item of output contains a blank line.
2971 (not (string= "" (car ispell-filter)))))
2972 ;; parse all inputs from the stream one word at a time.
2973 ;; Place in FIFO order and remove the blank item.
2974 (setq ispell-filter (nreverse (cdr ispell-filter)))
2975 (while (and (not ispell-quit) ispell-filter)
2976 ;; get next word, accounting for accepted words and start shifts
2977 (setq poss (ispell-parse-output (car ispell-filter)
2979 (if (and poss (listp poss)) ; spelling error occurred.
2980 ;; Whenever we have misspellings, we can change
2981 ;; the buffer. Keep boundaries as markers.
2982 ;; Markers can move with highlighting! This destroys
2983 ;; end of region markers line-end and ispell-region-end
2985 (copy-marker (+ start ispell-offset (car (cdr poss)))))
2986 (word-len (length (car poss)))
2987 (line-end (copy-marker end))
2988 (line-start (copy-marker start))
2989 recheck-region replace)
2990 (goto-char word-start)
2991 ;; Adjust the horizontal scroll & point
2992 (ispell-horiz-scroll)
2993 (goto-char (+ word-len word-start))
2994 (ispell-horiz-scroll)
2995 (goto-char word-start)
2996 (ispell-horiz-scroll)
2998 ;; Alignment cannot be tracked and this error will occur when
2999 ;; `query-replace' makes multiple corrections on the starting line.
3000 (or (ispell-looking-at (car poss))
3001 ;; This occurs due to filter pipe problems
3002 (error (concat "Ispell misalignment: word "
3003 "`%s' point %d; probably incompatible versions")
3004 (car poss) (marker-position word-start)))
3005 ;; ispell-cmd-loop can go recursive & change buffer
3006 (if ispell-keep-choices-win
3007 (setq replace (ispell-command-loop
3008 (car (cdr (cdr poss)))
3009 (car (cdr (cdr (cdr poss))))
3010 (car poss) (marker-position word-start)
3011 (+ word-len (marker-position word-start))))
3012 (save-window-excursion
3013 (setq replace (ispell-command-loop
3014 (car (cdr (cdr poss)))
3015 (car (cdr (cdr (cdr poss))))
3016 (car poss) (marker-position word-start)
3017 (+ word-len (marker-position word-start))))))
3019 (goto-char word-start)
3020 ;; Recheck when query replace edit changes misspelled word.
3021 ;; Error in tex mode when a potential math mode change exists.
3022 (if (and replace (listp replace) (= 2 (length replace)))
3023 (if (and (eq ispell-parser 'tex)
3024 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3025 (regexp-quote string)))
3027 "Don't start query replace on a line with math characters"
3029 (set-marker line-end (point))
3030 (setq ispell-filter nil
3033 ;; insert correction if needed
3036 (equal 0 replace)) ; ACCEPT/INSERT
3037 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
3038 (ispell-add-per-file-word-list (car poss)))
3039 ;; do not recheck accepted word on this line
3040 (setq accept-list (cons (car poss) accept-list)))
3041 (t ; replacement word selected or entered
3042 (delete-region (point) (+ word-len (point)))
3043 (if (not (listp replace))
3045 (ispell-insert-word replace) ; insert dictionary word
3046 (ispell-send-replacement (car poss) replace)
3047 (setq accept-list (cons replace accept-list)))
3048 (let ((replace-word (car replace)))
3049 ;; Recheck hand entered replacement word
3050 (insert replace-word)
3051 (ispell-send-replacement (car poss) replace-word)
3052 (if (car (cdr replace))
3053 (save-window-excursion
3054 (delete-other-windows) ; to correctly show help.
3055 ;; Assume case-replace &
3056 ;; case-fold-search correct?
3057 (query-replace (car poss) (car replace) t)))
3058 (goto-char word-start)
3059 ;; do not recheck if already accepted
3060 (if (member replace-word accept-list)
3061 (setq accept-list (cons replace-word accept-list)
3062 replace replace-word)
3063 (let ((region-end (copy-marker ispell-region-end)))
3064 (setq recheck-region ispell-filter
3065 ispell-filter nil ; save filter
3066 shift 0 ; already accounted
3067 shift (ispell-region
3069 (+ word-start (length replace-word))
3071 (if (null shift) ; quitting check.
3073 (set-marker ispell-region-end region-end)
3074 (set-marker region-end nil)
3075 (setq ispell-filter recheck-region
3077 replace replace-word)))))
3079 (setq shift (+ shift (- (length replace) word-len)))
3081 ;; Move line-start across word...
3082 ;; new shift function does this now...
3083 ;;(set-marker line-start (+ line-start
3084 ;; (- (length replace)
3085 ;; (length (car poss)))))
3087 (if (not ispell-quit)
3088 (let (message-log-max)
3089 (message "Continuing spelling check using %s with %s dictionary..."
3090 (file-name-nondirectory ispell-program-name)
3091 (or ispell-current-dictionary "default"))))
3093 (setq start (marker-position line-start)
3094 end (marker-position line-end))
3095 ;; Adjust markers when end of region lost from highlighting.
3096 (if (and (not recheck-region) (< end (+ word-start word-len)))
3097 (setq end (+ word-start word-len)))
3098 (if (= word-start ispell-region-end)
3099 (set-marker ispell-region-end (+ word-start word-len)))
3100 ;; going out of scope - unneeded
3101 (set-marker line-start nil)
3102 (set-marker word-start nil)
3103 (set-marker line-end nil)))
3104 ;; finished with misspelling!
3105 (setq ispell-filter (cdr ispell-filter)))
3110 (defun ispell-comments-and-strings ()
3111 "Check comments and strings in the current buffer for spelling errors."
3113 (goto-char (point-min))
3117 (setq state (parse-partial-sexp (point) (point-max)
3118 nil nil state 'syntax-table))
3119 (if (or (nth 3 state) (nth 4 state))
3120 (let ((start (point)))
3121 (setq state (parse-partial-sexp start (point-max)
3122 nil nil state 'syntax-table))
3123 (if (or (nth 3 state) (nth 4 state))
3124 (error "Unterminated string or comment"))
3126 (setq done (not (ispell-region start (point))))))))))
3130 (defun ispell-buffer ()
3131 "Check the current buffer for spelling errors interactively."
3133 (ispell-region (point-min) (point-max)))
3137 (defun ispell-continue ()
3138 "Continue a halted spelling session beginning with the current word."
3140 (if (not (marker-position ispell-region-end))
3141 (message "No session to continue. Use 'X' command when checking!")
3142 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
3143 (message "Must continue ispell from buffer %s"
3144 (buffer-name (marker-buffer ispell-region-end)))
3146 ;; find beginning of current word:
3147 (car (cdr (ispell-get-word t)))
3148 (marker-position ispell-region-end)))))
3151 ;;; Horizontal scrolling
3152 (defun ispell-horiz-scroll ()
3153 "Places point within the horizontal visibility of its window area."
3154 (if truncate-lines ; display truncating lines?
3155 ;; See if display needs to be scrolled.
3156 (let ((column (- (current-column) (max (window-hscroll) 1))))
3157 (if (and (< column 0) (> (window-hscroll) 0))
3158 (scroll-right (max (- column) 10))
3159 (if (>= column (- (window-width) 2))
3160 (scroll-left (max (- column (window-width) -3) 10)))))))
3163 ;;; Interactive word completion.
3164 ;;; Forces "previous-word" processing. Do we want to make this selectable?
3167 (defun ispell-complete-word (&optional interior-frag)
3168 "Try to complete the word before or under point (see `lookup-words').
3169 If optional INTERIOR-FRAG is non-nil then the word may be a character
3170 sequence inside of a word.
3172 Standard ispell choices are then available."
3174 (let ((cursor-location (point))
3175 (case-fold-search-val case-fold-search)
3176 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
3177 start end possibilities replacement)
3178 (setq start (car (cdr word))
3179 end (car (cdr (cdr word)))
3182 (or (string= word "") ; Will give you every word
3183 (lookup-words (concat (and interior-frag "*") word
3184 (if (or interior-frag (null ispell-look-p))
3186 ispell-complete-word-dict)))
3187 (cond ((eq possibilities t)
3188 (message "No word to complete"))
3189 ((null possibilities)
3190 (message "No match for \"%s\"" word))
3191 (t ; There is a modification...
3192 (setq case-fold-search nil) ; Try and respect case of word.
3194 ((string-equal (upcase word) word)
3195 (setq possibilities (mapcar 'upcase possibilities)))
3196 ((eq (upcase (aref word 0)) (aref word 0))
3197 (setq possibilities (mapcar (function
3199 (if (eq (aref word 0) (aref pos 0))
3203 (setq case-fold-search case-fold-search-val)
3204 (save-window-excursion
3206 (ispell-command-loop possibilities nil word start end)))
3208 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
3209 (ispell-add-per-file-word-list word))
3210 (replacement ; REPLACEMENT WORD
3211 (delete-region start end)
3212 (setq word (if (atom replacement) replacement (car replacement))
3213 cursor-location (+ (- (length word) (- end start))
3215 (ispell-insert-word word)
3216 (if (not (atom replacement)) ; recheck spelling of replacement.
3218 (goto-char cursor-location)
3219 (ispell-word nil t)))))
3220 (if (get-buffer ispell-choices-buffer)
3221 (kill-buffer ispell-choices-buffer))))
3222 (ispell-pdict-save ispell-silently-savep)
3223 (goto-char cursor-location)))
3227 (defun ispell-complete-word-interior-frag ()
3228 "Completes word matching character sequence inside a word."
3230 (ispell-complete-word t))
3235 "Interactively check a region or buffer for spelling errors.
3236 If `transient-mark-mode' is on, and a region is active, spell-check
3237 that region. Otherwise spell-check the buffer.
3239 Ispell dictionaries are not distributed with Emacs. If you are
3240 looking for a dictionary, please see the distribution of the GNU ispell
3241 program, or do an Internet search; there are various dictionaries
3242 available on the net."
3244 (if (and (boundp 'transient-mark-mode) transient-mark-mode
3245 (boundp 'mark-active) mark-active)
3246 (ispell-region (region-beginning) (region-end))
3250 ;;; **********************************************************************
3251 ;;; Ispell Minor Mode
3252 ;;; **********************************************************************
3254 (defvar ispell-minor-mode nil
3255 "Non-nil if Ispell minor mode is enabled.")
3256 ;; Variable indicating that ispell minor mode is active.
3257 (make-variable-buffer-local 'ispell-minor-mode)
3259 (or (assq 'ispell-minor-mode minor-mode-alist)
3260 (setq minor-mode-alist
3261 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
3263 (defvar ispell-minor-keymap
3264 (let ((map (make-sparse-keymap)))
3265 (define-key map " " 'ispell-minor-check)
3266 (define-key map "\r" 'ispell-minor-check)
3268 "Keymap used for Ispell minor mode.")
3270 (or (not (boundp 'minor-mode-map-alist))
3271 (assoc 'ispell-minor-mode minor-mode-map-alist)
3272 (setq minor-mode-map-alist
3273 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
3274 minor-mode-map-alist)))
3277 (defun ispell-minor-mode (&optional arg)
3278 "Toggle Ispell minor mode.
3279 With prefix arg, turn Ispell minor mode on iff arg is positive.
3281 In Ispell minor mode, pressing SPC or RET
3282 warns you if the previous word is incorrectly spelled.
3284 All the buffer-local variables and dictionaries are ignored -- to read
3285 them into the running ispell process, type \\[ispell-word] SPC."
3287 (setq ispell-minor-mode
3288 (not (or (and (null arg) ispell-minor-mode)
3289 (<= (prefix-numeric-value arg) 0))))
3290 (force-mode-line-update))
3292 (defun ispell-minor-check ()
3293 "Check previous word then continue with the normal binding of this key.
3294 Don't check previous word when character before point is a space or newline.
3295 Don't read buffer-local settings or word lists."
3297 (let ((ispell-minor-mode nil)
3298 (ispell-check-only t)
3299 (last-char (char-after (1- (point)))))
3300 (command-execute (key-binding (this-command-keys)))
3301 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
3302 (and ispell-skip-html (eq last-char ?>))
3303 (and ispell-skip-html (eq last-char ?\;))))
3304 (ispell-word nil t))))
3307 ;;; **********************************************************************
3309 ;;; **********************************************************************
3311 (defvar ispell-message-text-end
3312 (mapconcat (function identity)
3314 ;; Don't spell check signatures
3316 ;; Matches postscript files.
3317 ;;"^%!PS-Adobe-[123].0"
3318 ;; Matches uuencoded text
3319 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3320 ;; Matches shell files (especially auto-decoding)
3322 ;; Matches context difference listing
3323 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3324 ;; Matches unidiff difference listing
3325 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
3326 ;; Matches reporter.el bug report
3327 "^current state:\n==============\n"
3328 ;; Matches commonly used "cut" boundaries
3329 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3331 "*End of text which will be checked in `ispell-message'.
3332 If it is a string, limit at first occurrence of that regular expression.
3333 Otherwise, it must be a function which is called to get the limit.")
3334 (put 'ispell-message-text-end 'risky-local-variable t)
3337 (defun ispell-mime-multipartp (&optional limit)
3338 "Return multipart message start boundary or nil if none."
3339 ;; caller must ensure `case-fold-search' is set to `t'
3342 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3345 (if (looking-at "\"")
3348 (setq start (point))
3349 (while (not (looking-at "\""))
3351 (setq boundary (buffer-substring-no-properties start (point))))
3352 (let ((start (point)))
3353 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3355 (setq boundary (buffer-substring-no-properties start (point)))))
3356 (if (< (length boundary) 1)
3358 (concat "--" boundary)))))
3361 (defun ispell-mime-skip-part (boundary)
3362 "Moves point across header, or entire MIME part if message is encoded.
3363 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3364 encoded and therefore skipped. See rfc 1521, 2183, ...
3365 If no boundary is given, then entire message is skipped.
3367 This starts one line ABOVE the MIME content messages, on the boundary marker,
3368 for operation with the generic region-skipping code.
3369 This places new MIME boundaries into variable `ispell-checking-message'."
3370 (forward-line) ; skip over boundary to headers
3371 (let ((save-case-fold-search case-fold-search)
3374 (setq case-fold-search t
3375 ispell-skip-html nil)
3377 (setq continuep nil)
3378 (if (looking-at "Content-Type: *text/")
3380 (goto-char (match-end 0))
3381 (if (looking-at "html")
3382 (setq ispell-skip-html t))
3385 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3387 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3388 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3389 (setq textp (member (upcase match)
3390 ;; only spell check the following encodings:
3391 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3393 (goto-char (match-end 0))
3394 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3396 ;; hierarchical boundary definition
3397 (if (looking-at "Content-Type: *multipart/")
3398 (let ((new-boundary (ispell-mime-multipartp)))
3399 (if (string-match new-boundary boundary)
3401 ;; first pass redefine skip function to include new boundary
3402 ;;(re-search-backward boundary nil t)
3404 (setq ispell-checking-message
3406 (list new-boundary 'ispell-mime-skip-part new-boundary)
3407 (if (eq t ispell-checking-message) nil
3408 ispell-checking-message))
3411 ;; Skip all MIME headers that don't affect spelling
3412 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3415 (goto-char (match-end 0))
3418 (setq case-fold-search save-case-fold-search)
3421 ;; encoded message. Skip to boundary, or entire message.
3423 (goto-char (point-max))
3424 (re-search-forward boundary nil t)
3430 (defun ispell-message ()
3431 "Check the spelling of a mail message or news post.
3432 Don't check spelling of message headers except the Subject field.
3433 Don't check included messages.
3435 To abort spell checking of a message region and send the message anyway,
3436 use the `x' command. (Any subsequent regions will be checked.)
3437 The `X' command aborts the message send so that you can edit the buffer.
3439 To spell-check whenever a message is sent, include the appropriate lines
3440 in your .emacs file:
3441 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3442 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3443 (add-hook 'mail-send-hook 'ispell-message)
3444 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3446 You can bind this to the key C-c i in GNUS or mail by adding to
3447 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3448 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3451 (goto-char (point-min))
3452 (let* (boundary mimep
3453 (ispell-skip-region-alist-save ispell-skip-region-alist)
3454 ;; Nil when message came from outside (eg calling emacs as editor)
3455 ;; Non-nil marker of end of headers.
3458 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3459 (end-of-headers ; Start of body.
3461 (or internal-messagep
3462 (re-search-forward "^$" nil t)
3464 (limit (copy-marker ; End of region we will spell check.
3466 ((not ispell-message-text-end) (point-max))
3467 ((char-or-string-p ispell-message-text-end)
3468 (if (re-search-forward ispell-message-text-end nil t)
3471 (t (min (point-max) (funcall ispell-message-text-end))))))
3472 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3473 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3474 (ispell-non-empty-string mail-yank-prefix)
3476 (cite-regexp ;Prefix of quoted text
3478 ((functionp 'sc-cite-regexp) ; sc 3.0
3479 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3481 (ispell-non-empty-string sc-reference-tag-string))))
3482 ((boundp 'sc-cite-regexp) ; sc 2.3
3483 (concat "\\(" sc-cite-regexp "\\)" "\\|"
3485 (ispell-non-empty-string sc-reference-tag-string))))
3486 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3487 (equal major-mode 'message-mode)) ;GNUS 5
3488 (concat "In article <" "\\|"
3489 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3490 (with-no-warnings message-cite-prefix-regexp)
3493 ((equal major-mode 'mh-letter-mode) ; mh mail message
3494 (concat "[^,;&+=\n]+ writes:" "\\|"
3496 (ispell-non-empty-string mh-ins-buf-prefix))))
3497 ((not internal-messagep) ; Assume nn sent us this message.
3498 (concat "In [a-zA-Z.]+ you write:" "\\|"
3499 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3501 ((boundp 'vm-included-text-prefix) ; VM mail message
3502 (concat "[^,;&+=\n]+ writes:" "\\|"
3503 (ispell-non-empty-string vm-included-text-prefix)))
3504 (t default-prefix)))
3505 (ispell-skip-region-alist
3506 (cons (list (concat "^\\(" cite-regexp "\\)")
3507 (function forward-line))
3508 ispell-skip-region-alist))
3509 (old-case-fold-search case-fold-search)
3510 (dictionary-alist ispell-message-dictionary-alist)
3511 (ispell-checking-message t))
3513 ;; Select dictionary for message
3514 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3515 (while dictionary-alist
3516 (goto-char (point-min))
3517 (if (re-search-forward (car (car dictionary-alist))
3519 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3520 dictionary-alist nil)
3521 (setq dictionary-alist (cdr dictionary-alist)))))
3525 ;; Spell check any original Subject:
3526 (goto-char (point-min))
3527 (setq case-fold-search t
3528 mimep (re-search-forward "MIME-Version:" end-of-headers t))
3529 (goto-char (point-min))
3530 (if (re-search-forward "^Subject: *" end-of-headers t)
3532 (goto-char (match-end 0))
3533 (if (and (not (looking-at ".*Re\\>"))
3534 (not (looking-at "\\[")))
3536 (setq case-fold-search old-case-fold-search)
3537 (ispell-region (point)
3538 (progn ;Tab-initiated continuation lns.
3540 (while (looking-at "\n[ \t]")
3545 (goto-char (point-min))
3546 (setq boundary (ispell-mime-multipartp end-of-headers))))
3547 ;; Adjust message limit to MIME message if necessary.
3549 (re-search-forward (concat boundary "--") nil t)
3550 (re-search-backward boundary nil t)
3551 (< (point) (marker-position limit))
3552 (set-marker limit (point)))
3553 (goto-char (point-min))
3554 ;; Select type or skip checking if this is a non-multipart message
3555 ;; Point moved to end of buffer if region is encoded.
3556 (if (and mimep (not boundary))
3557 (let (skip-regexp) ; protect from `ispell-mime-skip-part'
3558 (goto-char (point-min))
3559 (re-search-forward "Content-[^ \t]*:" end-of-headers t)
3560 (forward-line -1) ; following fn starts one line above
3561 (ispell-mime-skip-part nil)
3562 ;; if message-text-end region, limit may be less than point.
3563 (if (> (point) limit)
3564 (set-marker limit (point)))))
3565 (goto-char (max end-of-headers (point)))
3567 (setq case-fold-search old-case-fold-search)
3568 ;; Define MIME regions to skip.
3570 (setq ispell-checking-message
3571 (list (list boundary 'ispell-mime-skip-part boundary))))
3572 (ispell-region (point) limit))
3573 (set-marker end-of-headers nil)
3574 (set-marker limit nil)
3575 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3576 ispell-skip-html nil
3577 case-fold-search old-case-fold-search)))))
3580 (defun ispell-non-empty-string (string)
3581 (if (or (not string) (string-equal string ""))
3582 "\\'\\`" ; An unmatchable string if string is null.
3583 (regexp-quote string)))
3586 ;;; **********************************************************************
3587 ;;; Buffer Local Functions
3588 ;;; **********************************************************************
3591 (defun ispell-accept-buffer-local-defs ()
3592 "Load all buffer-local information, restarting Ispell when necessary."
3593 (ispell-buffer-local-dict) ; May kill ispell-process.
3594 (ispell-buffer-local-words) ; Will initialize ispell-process.
3595 (ispell-buffer-local-parsing))
3598 (defun ispell-buffer-local-parsing ()
3599 "Place Ispell into parsing mode for this buffer.
3600 Overrides the default parsing mode.
3601 Includes Latex/Nroff modes and extended character mode."
3602 ;; (ispell-init-process) must already be called.
3603 (ispell-send-string "!\n") ; Put process in terse mode.
3604 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3605 ;; When exclusively checking comments, set to raw text mode (nroff).
3606 (if (and (not (eq 'exclusive ispell-check-comments))
3607 (or (and (eq ispell-parser 'use-mode-name)
3608 (string-match "[Tt][Ee][Xx]-mode"
3609 (symbol-name major-mode)))
3610 (eq ispell-parser 'tex)))
3612 (ispell-send-string "+\n") ; set ispell mode to tex
3613 (if (not (eq ispell-parser 'tex))
3614 (set (make-local-variable 'ispell-parser) 'tex)))
3615 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3616 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3617 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
3618 (setq ispell-skip-html
3619 (not (null (string-match "sgml\\|html\\|xml"
3620 (downcase (symbol-name major-mode)))))))
3621 ;; Set default extended character mode for given buffer, if any.
3622 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3623 (if extended-char-mode
3624 (ispell-send-string (concat extended-char-mode "\n"))))
3625 ;; Set buffer-local parsing mode and extended character mode, if specified.
3627 (goto-char (point-max))
3628 ;; Uses last occurrence of ispell-parsing-keyword
3629 (if (search-backward ispell-parsing-keyword nil t)
3630 (let ((end (save-excursion (end-of-line) (point)))
3632 (search-forward ispell-parsing-keyword)
3633 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3634 ;; space separated definitions.
3635 (setq string (downcase (match-string-no-properties 1)))
3636 (cond ((and (string-match "latex-mode" string)
3637 (not (eq 'exclusive ispell-check-comments)))
3638 (ispell-send-string "+\n~tex\n"))
3639 ((string-match "nroff-mode" string)
3640 (ispell-send-string "-\n~nroff\n"))
3641 ((string-match "~" string) ; Set extended character mode.
3642 (ispell-send-string (concat string "\n")))
3643 (t (message "Invalid Ispell Parsing argument!")
3647 ;;; Can kill the current ispell process
3649 (defun ispell-buffer-local-dict (&optional no-reload)
3650 "Initializes local dictionary and local personal dictionary.
3651 If optional NO-RELOAD is non-nil, do not make any dictionary reloading.
3652 When a dictionary is defined in the buffer (see variable
3653 `ispell-dictionary-keyword'), it will override the local setting
3654 from \\[ispell-change-dictionary].
3655 Both should not be used to define a buffer-local dictionary."
3657 (goto-char (point-min))
3659 ;; Override the local variable definition.
3660 ;; Uses last occurrence of ispell-dictionary-keyword.
3661 (goto-char (point-max))
3662 (unless ispell-local-dictionary-overridden
3663 (if (search-backward ispell-dictionary-keyword nil t)
3665 (search-forward ispell-dictionary-keyword)
3666 (setq end (save-excursion (end-of-line) (point)))
3667 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3668 (setq ispell-local-dictionary
3669 (match-string-no-properties 1))))))
3670 (goto-char (point-max))
3671 (if (search-backward ispell-pdict-keyword nil t)
3673 (search-forward ispell-pdict-keyword)
3674 (setq end (save-excursion (end-of-line) (point)))
3675 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3676 (setq ispell-local-pdict
3677 (match-string-no-properties 1)))))))
3679 ;; Reload if new dictionary (maybe the personal one) defined.
3680 (ispell-internal-change-dictionary)))
3683 (defun ispell-buffer-local-words ()
3684 "Loads the buffer-local dictionary in the current buffer."
3685 ;; If there's an existing ispell process that's wrong for this use,
3687 (if (and ispell-buffer-local-name
3688 (not (equal ispell-buffer-local-name (buffer-name))))
3689 (ispell-kill-ispell t))
3690 ;; Actually start a new ispell process, because we need
3691 ;; to send commands now to specify the local words to it.
3692 (ispell-init-process)
3694 (goto-char (point-min))
3695 (while (search-forward ispell-words-keyword nil t)
3696 (or ispell-buffer-local-name
3697 (setq ispell-buffer-local-name (buffer-name)))
3698 (let ((end (save-excursion (end-of-line) (point)))
3699 (ispell-casechars (ispell-get-casechars))
3701 ;; buffer-local words separated by a space, and can contain
3702 ;; any character other than a space. Not rigorous enough.
3703 (while (re-search-forward " *\\([^ ]+\\)" end t)
3704 (setq string (match-string-no-properties 1))
3705 ;; This can fail when string contains a word with illegal chars.
3706 ;; Error handling needs to be added between ispell and emacs.
3707 (if (and (< 1 (length string))
3708 (equal 0 (string-match ispell-casechars string)))
3709 (ispell-send-string (concat "@" string "\n"))))))))
3712 ;;; returns optionally adjusted region-end-point.
3714 (defun ispell-add-per-file-word-list (word)
3715 "Add WORD to the per-file word list."
3716 (or ispell-buffer-local-name
3717 (setq ispell-buffer-local-name (buffer-name)))
3719 (goto-char (point-min))
3720 (let ((old-case-fold-search case-fold-search)
3721 line-okay search done found)
3723 (setq case-fold-search nil
3724 search (search-forward ispell-words-keyword nil 'move)
3725 found (or found search)
3726 line-okay (< (+ (length word) 1 ; 1 for space after word..
3727 (progn (end-of-line) (current-column)))
3729 case-fold-search old-case-fold-search)
3730 (if (or (and search line-okay)
3737 (unless found (newline))
3738 (insert (concat comment-start " " ispell-words-keyword))
3739 (if (> (length comment-end) 0)
3742 (insert comment-end)))))
3743 (insert (concat " " word))))))))
3745 (add-to-list 'debug-ignored-errors "^No word found to check!$")
3750 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3752 ;;; Local Variable options:
3753 ;;; mode: name(-mode)
3754 ;;; eval: expression
3755 ;;; local-variable: value
3757 ;;; The following sets the buffer local dictionary to `american' English
3758 ;;; and spell checks only comments.
3760 ;;; Local Variables:
3761 ;;; mode: emacs-lisp
3762 ;;; comment-column: 40
3763 ;;; ispell-check-comments: exclusive
3764 ;;; ispell-local-dictionary: "american"
3768 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3770 ;;; The following places this file in nroff parsing and extended char modes.
3771 ;;; Local IspellParsing: nroff-mode ~nroff
3772 ;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3773 ;;; Local IspellPersDict ~/.ispell_lisp
3774 ;;; The following were automatically generated by ispell using the 'A' command:
3775 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3776 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3777 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3778 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3779 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3780 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3781 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3782 ; LocalWords: lns XEmacs HTML casechars Multibyte
3784 ;;; arch-tag: 4941b9f9-3b7c-4a76-a4ed-5fa8b6010ef5
3785 ;;; ispell.el ends here