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, 2008, 2009, 2010, 2011 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 3 of the License, or
20 ;; (at your option) any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 ;; Note: version numbers and time stamp are not updated
31 ;; when this file is edited for release with GNU Emacs.
37 ;; This code contains a section of user-settable variables that you
38 ;; should inspect prior to installation. Look past the end of the history
39 ;; list. Set them up for your locale and the preferences of the majority
40 ;; of the users. Otherwise the users may need to set a number of variables
42 ;; You particularly may want to change the default dictionary for your
43 ;; country and language.
44 ;; Most dictionary changes should be made in this file so all users can
45 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
46 ;; file. Use the variable `ispell-local-dictionary-alist' to specify
47 ;; your own dictionaries.
49 ;; Depending on the mail system you use, you may want to include these:
50 ;; (add-hook 'news-inews-hook 'ispell-message)
51 ;; (add-hook 'mail-send-hook 'ispell-message)
52 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
54 ;; Ispell has a TeX parser and a nroff parser (the default).
55 ;; The parsing is controlled by the variable ispell-parser. Currently
56 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
57 ;; added it will be updated. See the variable description for more info.
66 ;; ispell-comments-and-strings
68 ;; ispell-complete-word
69 ;; ispell-complete-word-interior-frag
70 ;; ispell-change-dictionary
73 ;; ispell-skip-region-alist
75 ;; Commands in ispell-region:
76 ;; Character replacement: Replace word with choice. May query-replace.
77 ;; ` ': Accept word this time.
78 ;; `i': Accept word and insert into private dictionary.
79 ;; `a': Accept word for this session.
80 ;; `A': Accept word and place in buffer-local dictionary.
81 ;; `r': Replace word with typed-in value. Rechecked.
82 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
83 ;; `?': Show these commands
84 ;; `x': Exit spelling buffer. Move cursor to original point.
85 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
86 ;; the check to be completed later.
87 ;; `q': Quit spelling session (Kills ispell process).
88 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
89 ;; `u': Like `i', but the word is lower-cased first.
90 ;; `m': Place entered value in personal dictionary, then recheck current word.
91 ;; `C-l': redraws screen
92 ;; `C-r': recursive edit
93 ;; `C-z': suspend Emacs or iconify frame
95 ;; Buffer-Local features:
96 ;; There are a number of buffer-local features that can be used to customize
97 ;; ispell for the current buffer. This includes language dictionaries,
98 ;; personal dictionaries, parsing, and local word spellings. Each of these
99 ;; local customizations are done either through local variables, or by
100 ;; including the keyword and argument(s) at the end of the buffer (usually
101 ;; prefixed by the comment characters). See the end of this file for
102 ;; examples. The local keywords and variables are:
104 ;; ispell-dictionary-keyword language-dictionary
105 ;; uses local variable ispell-local-dictionary
106 ;; ispell-pdict-keyword personal-dictionary
107 ;; uses local variable ispell-local-pdict
108 ;; ispell-parsing-keyword mode-arg extended-char-arg
109 ;; ispell-words-keyword any number of local word spellings
112 ;; Place new regular expression definitions of regions you prefer not to
113 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
114 ;; be added to latex by modifying `ispell-tex-skip-alists'.
115 ;; `ispell-message' contains some custom skipping code for e-mail messages.
118 ;; Need a way to select between different character mappings without separate
119 ;; dictionary entries.
120 ;; Multi-byte characters if not defined by current dictionary may result in the
121 ;; evil "misalignment error" in some versions of MULE Emacs.
122 ;; On some versions of Emacs, growing the minibuffer fails.
123 ;; see `ispell-help-in-bufferp'.
124 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
125 ;; can cause misalignment errors.
129 ;; Modifications made in latest versions:
131 ;; Revision 3.6 2003/01/07 12:32:44 kss
132 ;; Removed extra -d LIB in dictionary defs. (Pavel Janik)
133 ;; Filtered process calls with duplicate dictionary entries.
134 ;; Fixed bug where message-text-end is inside a mime skipped region.
135 ;; Minor fixes to get ispell menus right in XEmacs
136 ;; Fixed skip regexp so it doesn't match stuff like `/.\w'.
137 ;; Detecting dictionary change not working. Fixed. kss
138 ;; function `ispell-change-dictionary' now only completes valid dicts.
140 ;; Revision 3.5 2001/7/11 18:43:57 kss
141 ;; Added fix for aspell to work in XEmacs (ispell-check-version).
142 ;; Added Portuguese dictionary definition.
143 ;; New feature: MIME mail message support, Fcc support.
144 ;; Bug fix: retain comment syntax on lines with region skipping. (TeX $ bug...)
145 ;; Improved allocation for graphic mode lines. (Miles Bader)
146 ;; Support -v flag for old versions of aspell. (Eli Zaretskii)
147 ;; Clear minibuffer on ^G from ispell-help (Tak Ota)
149 ;; Revision 3.4 2000/8/4 09:41:50 kss
150 ;; Support new color display functions.
151 ;; Fixed misalignment offset bug when replacing a string after a shift made.
152 ;; Set to standard Author/Maintainer heading,
153 ;; ensure localwords lists are separated from the text by newline. (Dave Love)
154 ;; Added dictionary definition for Italian (William Deakin)
155 ;; HTML region skipping greatly improved. (Chuck D. Phillips)
156 ;; improved menus. Fixed regexp matching http/email addresses.
157 ;; one arg always for XEmacs sleep-for (gunnar Evermann)
158 ;; support for synchronous processes (Eli Zaretskii)
160 ;; Revision 3.3 1999/11/29 11:38:34 kss
161 ;; Only word replacements entered in from the keyboard are rechecked.
162 ;; This fixes a bug in tex parsing and misalignment.
163 ;; Exceptions exist for recursive edit and query-replace, with tex error
164 ;; condition tested. Recursive editing improved.
165 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
166 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
167 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
168 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
171 ;; Revision 3.2 1999/5/7 14:25:14 kss
172 ;; Accept ispell versions 3.X.Y where X>=1
173 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
174 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
175 ;; Fixed bug in TeX parsing when math commands are in the comments.
176 ;; Removed calls to `when' macro.
178 ;; Revision 3.1 1998/12/1 13:21:52 kss
179 ;; Improved and fixed customize support.
180 ;; Improved and fixed comments in variables and messages.
181 ;; A coding system is now required for all languages.
182 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
183 ;; Dictionary norsk7-tex removed. Dictionary polish added.
184 ;; Dictionaries redefined at load-time to support dictionary changes.
185 ;; Menu redefined at load time to support dictionary changes.
186 ;; ispell-check-version added as an alias for `check-ispell-version'.
187 ;; Spelling suggestions returned in order generated by ispell.
188 ;; Small bug fixed in matching ispell error messages.
189 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
190 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
191 ;; Multibyte character coding support added for process interactions.
192 ;; Ensure ispell process has terminated before starting new process.
193 ;; This can otherwise confuse process filters and hang ispell.
194 ;; Improved skipping support for SGML.
195 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
196 ;; Improved message reference matching in `ispell-message'.
197 ;; Fixed bug in returning to nroff mode from tex mode.
199 ;;; Compatibility code for XEmacs and (not too) older emacsen:
201 (eval-and-compile ;; Protect against declare-function undefined in XEmacs
202 (unless (fboundp 'declare-function
) (defmacro declare-function
(&rest r
))))
204 (declare-function ispell-check-minver
"ispell" (v1 v2
))
205 (declare-function ispell-looking-back
"ispell"
206 (regexp &optional limit
&rest ignored
))
208 (if (fboundp 'version
<=)
209 (defalias 'ispell-check-minver
'version
<=)
210 (defun ispell-check-minver (minver version
)
211 "Check if string VERSION is at least string MINVER.
212 Both must be in [0-9]+.[0-9]+... format. This is a fallback
213 compatibility function in case `version<=' is not available."
216 start-ver start-mver
)
217 ;; Loop until an absolute greater or smaller condition is reached
218 ;; or until no elements are left in any of version and minver. In
219 ;; this case version is exactly the minimal, so return OK.
222 (if (string-match "[0-9]+" version start-ver
)
223 (setq start-ver
(match-end 0)
224 ver
(string-to-number (match-string 0 version
))))
225 (if (string-match "[0-9]+" minver start-mver
)
226 (setq start-mver
(match-end 0)
227 mver
(string-to-number (match-string 0 minver
))))
231 (or ver
(setq ver
0))
232 (or mver
(setq mver
0))
233 ;; If none of below conditions match, this element is the
234 ;; same. Go checking next element.
240 (setq pending nil
))))
243 ;; XEmacs does not have looking-back
244 (if (fboundp 'looking-back
)
245 (defalias 'ispell-looking-back
'looking-back
)
246 (defun ispell-looking-back (regexp &optional limit
&rest ignored
)
247 "Return non-nil if text before point matches regular expression REGEXP.
248 Like `looking-at' except matches before point, and is slower.
249 LIMIT if non-nil speeds up the search by specifying a minimum
250 starting position, to avoid checking matches that would start
253 This is a stripped down compatibility function for use when
254 full featured `looking-back' function is missing."
256 (re-search-backward (concat "\\(?:" regexp
"\\)\\=") limit t
))))
260 (defvar mail-yank-prefix
)
263 "User variables for Emacs ispell interface."
264 :group
'applications
)
266 (if (not (fboundp 'buffer-substring-no-properties
))
267 (defun buffer-substring-no-properties (start end
)
268 (buffer-substring start end
)))
270 (defalias 'check-ispell-version
'ispell-check-version
)
272 ;;; **********************************************************************
273 ;;; The following variables should be set according to personal preference
274 ;;; and location of binaries:
275 ;;; **********************************************************************
278 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
280 (defcustom ispell-highlight-p
'block
281 "*Highlight spelling errors when non-nil.
282 When set to `block', assumes a block cursor with TTY displays."
283 :type
'(choice (const block
) (const :tag
"off" nil
) (const :tag
"on" t
))
286 (defcustom ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
)
287 "*Controls the lazy-highlighting of spelling errors.
288 When non-nil, all text in the buffer matching the current spelling
289 error is highlighted lazily using isearch lazy highlighting (see
290 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
292 :group
'lazy-highlight
296 (defcustom ispell-highlight-face
(if ispell-lazy-highlight
'isearch
'highlight
)
297 "*The face used for Ispell highlighting. For Emacsen with overlays.
298 Possible values are `highlight', `modeline', `secondary-selection',
299 `region', and `underline'.
300 This variable can be set by the user to whatever face they desire.
301 It's most convenient if the cursor color and highlight color are
306 (defcustom ispell-check-comments t
307 "*Spelling of comments checked when non-nil.
308 When set to `exclusive', ONLY comments are checked. (For code comments).
309 Warning! Not checking comments, when a comment start is embedded in strings,
310 may produce undesired results."
311 :type
'(choice (const exclusive
) (const :tag
"off" nil
) (const :tag
"on" t
))
314 (put 'ispell-check-comments
'safe-local-variable
315 (lambda (a) (memq a
'(nil t exclusive
))))
317 (defcustom ispell-query-replace-choices nil
318 "*Corrections made throughout region when non-nil.
319 Uses `query-replace' (\\[query-replace]) for corrections."
323 (defcustom ispell-skip-tib nil
324 "*Does not spell check `tib' bibliography references when non-nil.
325 Skips any text between strings matching regular expressions
326 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
328 TeX users beware: Any field starting with [. will skip until a .] -- even
329 your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
330 a [.5mm] type of number...."
334 (defvar ispell-tib-ref-beginning
"[[<]\\."
335 "Regexp matching the beginning of a Tib reference.")
337 (defvar ispell-tib-ref-end
"\\.[]>]"
338 "Regexp matching the end of a Tib reference.")
340 (defcustom ispell-keep-choices-win t
341 "*When non-nil, the `*Choices*' window remains for spelling session.
342 This minimizes redisplay thrashing."
346 (defcustom ispell-choices-win-default-height
2
347 "*The default size of the `*Choices*' window, including mode line.
348 Must be greater than 1."
352 (defcustom ispell-program-name
353 (or (locate-file "aspell" exec-path exec-suffixes
'file-executable-p
)
354 (locate-file "ispell" exec-path exec-suffixes
'file-executable-p
)
355 (locate-file "hunspell" exec-path exec-suffixes
'file-executable-p
)
357 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
361 (defcustom ispell-alternate-dictionary
362 (cond ((file-readable-p "/usr/dict/web2") "/usr/dict/web2")
363 ((file-readable-p "/usr/share/dict/web2") "/usr/share/dict/web2")
364 ((file-readable-p "/usr/dict/words") "/usr/dict/words")
365 ((file-readable-p "/usr/lib/dict/words") "/usr/lib/dict/words")
366 ((file-readable-p "/usr/share/dict/words") "/usr/share/dict/words")
367 ((file-readable-p "/usr/share/lib/dict/words")
368 "/usr/share/lib/dict/words")
369 ((file-readable-p "/sys/dict") "/sys/dict"))
370 "*Alternate plain word-list dictionary for spelling help."
371 :type
'(choice file
(const :tag
"None" nil
))
374 (defcustom ispell-complete-word-dict nil
375 "*Plain word-list dictionary used for word completion if
376 different from `ispell-alternate-dictionary'."
377 :type
'(choice file
(const :tag
"None" nil
))
380 (defcustom ispell-message-dictionary-alist nil
381 "*List used by `ispell-message' to select a new dictionary.
382 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
383 in the message headers, `ispell-local-dictionary' will be set to
384 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
385 E.g. you may use the following value:
386 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
387 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
388 :type
'(repeat (cons regexp string
))
392 (defcustom ispell-message-fcc-skip
50000
393 "*Query before saving Fcc message copy if attachment larger than this value.
394 Always stores Fcc copy of message when nil."
395 :type
'(choice integer
(const :tag
"off" nil
))
399 (defcustom ispell-grep-command
400 ;; MS-Windows/MS-DOS have `egrep' as a Unix shell script, so they
401 ;; cannot invoke it. Use "grep -E" instead (see ispell-grep-options
403 (if (memq system-type
'(windows-nt ms-dos
)) "grep" "egrep")
404 "Name of the grep command for search processes."
408 (defcustom ispell-grep-options
409 (if (memq system-type
'(windows-nt ms-dos
)) "-Ei" "-i")
410 "String of options to use when running the program in `ispell-grep-command'.
411 Should probably be \"-i\" or \"-e\".
412 Some machines (like the NeXT) don't support \"-i\"."
416 (defcustom ispell-look-command
417 (cond ((file-exists-p "/bin/look") "/bin/look")
418 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
419 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
421 "Name of the look command for search processes.
422 This must be an absolute file name."
426 (defcustom ispell-look-p
(file-exists-p ispell-look-command
)
427 "*Non-nil means use `look' rather than `grep'.
428 Default is based on whether `look' seems to be available."
432 (defcustom ispell-have-new-look nil
433 "*Non-nil means use the `-r' option (regexp) when running `look'."
437 (defcustom ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
438 "String of command options for `ispell-look-command'."
442 (defcustom ispell-use-ptys-p nil
443 "When non-nil, Emacs uses ptys to communicate with Ispell.
444 When nil, Emacs uses pipes."
448 (defcustom ispell-following-word nil
449 "*Non-nil means `ispell-word' checks the word around or after point.
450 Otherwise `ispell-word' checks the preceding word."
454 (defcustom ispell-help-in-bufferp nil
455 "*Non-nil means display interactive keymap help in a buffer.
456 The following values are supported:
457 nil Expand the minibuffer and display a short help message
458 there for a couple of seconds.
459 t Pop up a new buffer and display a short help message there
460 for a couple of seconds.
461 electric Pop up a new buffer and display a long help message there.
462 User can browse and then exit the help mode."
463 :type
'(choice (const electric
) (const :tag
"off" nil
) (const :tag
"on" t
))
466 (defcustom ispell-quietly nil
467 "*Non-nil means suppress messages in `ispell-word'."
471 (defcustom ispell-format-word-function
(function upcase
)
472 "*Formatting function for displaying word being spell checked.
473 The function must take one string argument and return a string."
476 (defvaralias 'ispell-format-word
'ispell-format-word-function
)
478 (defcustom ispell-use-framepop-p nil
479 "When non-nil ispell uses framepop to display choices in a dedicated frame.
480 You can set this variable to dynamically use framepop if you are in a
481 window system by evaluating the following on startup to set this variable:
482 (and window-system (condition-case () (require 'framepop) (error nil)))"
487 (defcustom ispell-personal-dictionary nil
488 "*File name of your personal spelling dictionary, or nil.
489 If nil, the default personal dictionary, (\"~/.ispell_DICTNAME\" for ispell or
490 \"~/.aspell.LANG.pws\" for aspell) is used, where DICTNAME is the name of your
491 default dictionary and LANG the two letter language code."
493 (const :tag
"default" nil
))
496 (defcustom ispell-silently-savep nil
497 "*When non-nil, save the personal dictionary without confirmation."
501 (defvar ispell-local-dictionary-overridden nil
502 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
503 (make-variable-buffer-local 'ispell-local-dictionary-overridden
)
505 (defcustom ispell-local-dictionary nil
506 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
507 The value must be a string dictionary name,
508 or nil, which means use the global setting in `ispell-dictionary'.
509 Dictionary names are defined in `ispell-local-dictionary-alist'
510 and `ispell-dictionary-alist'.
512 Setting `ispell-local-dictionary' to a value has the same effect as
513 calling \\[ispell-change-dictionary] with that value. This variable
514 is automatically set when defined in the file with either
515 `ispell-dictionary-keyword' or the Local Variable syntax."
516 :type
'(choice string
517 (const :tag
"default" nil
))
520 (put 'ispell-local-dictionary
'safe-local-variable
'string-or-null-p
)
522 (make-variable-buffer-local 'ispell-local-dictionary
)
524 (defcustom ispell-dictionary nil
525 "Default dictionary to use if `ispell-local-dictionary' is nil."
526 :type
'(choice string
527 (const :tag
"default" nil
))
530 (defcustom ispell-extra-args nil
531 "*If non-nil, a list of extra switches to pass to the Ispell program.
532 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
533 words as correct. See also `ispell-dictionary-alist', which may be used
534 for language-specific arguments."
535 :type
'(repeat string
)
540 (defcustom ispell-skip-html
'use-mode-name
541 "*Indicates whether ispell should skip spell checking of SGML markup.
542 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
543 guess whether SGML markup should be skipped according to the name of the
544 buffer's major mode."
545 :type
'(choice (const :tag
"always" t
) (const :tag
"never" nil
)
546 (const :tag
"use-mode-name" use-mode-name
))
549 (make-variable-buffer-local 'ispell-skip-html
)
552 (defcustom ispell-local-dictionary-alist nil
553 "*List of local or customized dictionary definitions.
554 These can override the values in `ispell-dictionary-alist'.
556 To make permanent changes to your dictionary definitions, you
557 will need to make your changes in this variable, save, and then
559 :type
'(repeat (list (choice :tag
"Dictionary"
560 (string :tag
"Dictionary name")
561 (const :tag
"default" nil
))
562 (regexp :tag
"Case characters")
563 (regexp :tag
"Non case characters")
564 (regexp :tag
"Other characters")
565 (boolean :tag
"Many other characters")
566 (repeat :tag
"Ispell command line args"
568 (choice :tag
"Extended character mode"
569 (const "~tex") (const "~plaintex")
570 (const "~nroff") (const "~list")
571 (const "~latin1") (const "~latin3")
572 (const :tag
"default" nil
))
573 (coding-system :tag
"Coding System")))
577 (defvar ispell-dictionary-base-alist
579 ;; The default dictionary. It may be English.aff, or any other
580 ;; dictionary depending on locale and such things. We should probably
581 ;; ask ispell what dictionary it's using, but until we do that, let's
582 ;; just use an approximate regexp.
583 "[[:alpha:]]" "[^[:alpha:]]" "[']" nil
("-B") nil iso-8859-1
)
584 ("american" ; Yankee English
585 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
586 ("brasileiro" ; Brazilian mode
587 "[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]"
588 "[^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]"
589 "[']" nil nil nil iso-8859-1
)
590 ("british" ; British version
591 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
592 ("castellano" ; Spanish mode
593 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
594 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
595 "[-]" nil
("-B") "~tex" iso-8859-1
)
596 ("castellano8" ; 8 bit Spanish mode
597 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
598 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
599 "[-]" nil
("-B" "-d" "castellano") "~latin1" iso-8859-1
)
601 "[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]"
602 "[^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]"
603 "" nil
("-B") nil iso-8859-2
)
605 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
606 "[']" nil
("-C") nil iso-8859-1
)
607 ("deutsch" ; Deutsch.aff
608 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
610 "[a-zA-Z\304\326\334\344\366\337\374]"
611 "[^a-zA-Z\304\326\334\344\366\337\374]"
612 "[']" t
("-C" "-d" "deutsch") "~latin1" iso-8859-1
)
613 ("english" ; make English explicitly selectable
614 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
616 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
617 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
618 "[-']" t
("-C") "~latin3" iso-8859-3
)
620 "[A-Za-z^\\]" "[^A-Za-z^\\]"
621 "[-'`\"]" t
("-C" "-d" "esperanto") "~tex" iso-8859-3
)
623 "[A-Za-z\345\344\366\305\304\326]"
624 "[^A-Za-z\345\344\366\305\304\326]"
625 "[:]" nil
("-C") "~list" iso-8859-1
)
627 "[A-Za-z]" "[^A-Za-z]" "[`'^-]" t nil nil iso-8859-1
)
628 ("francais" ; Francais.aff
629 "[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]"
630 "[^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]"
631 "[-'.@]" t nil
"~list" iso-8859-1
)
632 ("francais-tex" ; Francais.aff
633 "[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\\]"
634 "[^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\\]"
635 "[-'^`\".@]" t nil
"~tex" iso-8859-1
)
636 ("german" ; german.aff
637 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
638 ("german8" ; german.aff
639 "[a-zA-Z\304\326\334\344\366\337\374]"
640 "[^a-zA-Z\304\326\334\344\366\337\374]"
641 "[']" t
("-C" "-d" "german") "~latin1" iso-8859-1
)
642 ("italiano" ; Italian.aff
643 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
644 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
645 "[-.]" nil
("-B" "-d" "italian") "~tex" iso-8859-1
)
646 ("nederlands" ; Nederlands.aff
647 "[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]"
648 "[^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]"
649 "[']" t
("-C") nil iso-8859-1
)
650 ("nederlands8" ; Dutch8.aff
651 "[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]"
652 "[^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]"
653 "[']" t
("-C") nil iso-8859-1
)
654 ("norsk" ; 8 bit Norwegian mode
655 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
656 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
657 "[\"]" nil nil
"~list" iso-8859-1
)
658 ("norsk7-tex" ; 7 bit Norwegian TeX mode
659 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
660 "[\"]" nil
("-d" "norsk") "~plaintex" iso-8859-1
)
661 ("polish" ; Polish mode
662 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
663 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
664 "[.]" nil nil nil iso-8859-2
)
665 ("portugues" ; Portuguese mode
666 "[a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
667 "[^a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
668 "[']" t
("-C") "~latin1" iso-8859-1
)
669 ("russian" ; Russian.aff (KOI8-R charset)
670 "[\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]"
671 "[^\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]"
672 "" nil nil nil koi8-r
)
673 ("russianw" ; russianw.aff (CP1251 charset)
674 "[\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]"
675 "[^\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]"
676 "" nil nil nil windows-1251
)
677 ("slovak" ; Slovakian
678 "[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]"
679 "[^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]"
680 "" nil
("-B") nil iso-8859-2
)
681 ("slovenian" ; Slovenian
682 "[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]"
683 "[^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]"
684 "" nil
("-B" "-d" "slovenian") nil iso-8859-2
)
685 ("svenska" ; Swedish mode
686 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
687 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
688 "[']" nil
("-C") "~list" iso-8859-1
))
689 "Base value for `ispell-dictionary-alist'.")
691 (defvar ispell-dictionary-alist nil
692 "An alist of dictionaries and their associated parameters.
694 Each element of this list is also a list:
696 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
697 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
699 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
700 nil means the default dictionary.
702 CASECHARS is a regular expression of valid characters that comprise a word.
704 NOT-CASECHARS is the opposite regexp of CASECHARS.
706 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
707 used to construct words in some special way. If OTHERCHARS characters follow
708 and precede characters from CASECHARS, they are parsed as part of a word,
709 otherwise they become word-breaks. As an example in English, assume the
710 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
711 \"Steven's\" are parsed as single words including the \"'\" character, but
712 \"Stevens'\" does not include the quote character as part of the word.
713 If you want OTHERCHARS to be empty, use the empty string.
714 Hint: regexp syntax requires the hyphen to be declared first here.
716 CASECHARS, NOT-CASECHARS, and OTHERCHARS must be unibyte strings
717 containing bytes of CHARACTER-SET. In addition, if they contain
718 a non-ASCII byte, the regular expression must be a single
719 `character set' construct that doesn't specify a character range
722 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
723 Otherwise only a single OTHERCHARS character is allowed to be part of any
726 ISPELL-ARGS is a list of additional arguments passed to the ispell
729 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
730 have been configured in an Ispell affix file. (For example, umlauts
731 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
732 in English. This has the same effect as the command-line `-T' option.
733 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
734 but the dictionary can control the extended character mode.
735 Both defaults can be overruled in a buffer-local fashion. See
736 `ispell-parsing-keyword' for details on this.
738 CHARACTER-SET used for languages with multibyte characters.
740 Note that the CASECHARS and OTHERCHARS slots of the alist should
741 contain the same character set as casechars and otherchars in the
742 LANGUAGE.aff file \(e.g., english.aff\).")
744 (defvar ispell-really-aspell nil
) ; Non-nil if we can use aspell extensions.
745 (defvar ispell-really-hunspell nil
) ; Non-nil if we can use hunspell extensions.
746 (defvar ispell-encoding8-command nil
747 "Command line option prefix to select UTF-8 if supported, nil otherwise.
748 If UTF-8 if supported by spellchecker and is selectable from the command line
749 this variable will contain \"--encoding=\" for aspell and \"-i \" for hunspell,
750 so UTF-8 or other mime charsets can be selected. That will be set for hunspell
751 >=1.1.6 or aspell >= 0.60 in `ispell-check-version'.
753 For aspell non-nil means to try to automatically find aspell dictionaries.
754 Earlier aspell versions do not consistently support UTF-8. Handling
755 this would require some extra guessing in `ispell-aspell-find-dictionary'.")
757 (defvar ispell-aspell-supports-utf8 nil
758 "Non nil if aspell has consistent command line UTF-8 support. Obsolete.
759 ispell.el and flyspell.el will use for this purpose the more generic
760 variable `ispell-encoding8-command' for both aspell and hunspell. Is left
761 here just for backwards compatibility.")
763 (make-obsolete-variable 'ispell-aspell-supports-utf8
764 'ispell-encoding8-command
"23.1")
767 ;;; **********************************************************************
768 ;;; The following are used by ispell, and should not be changed.
769 ;;; **********************************************************************
773 ;; The version must be 3.1 or greater for this version of ispell.el
774 ;; There is an incompatibility between version 3.1.12 and lower versions.
775 (defconst ispell-required-version
'(3 1 12)
776 "Ispell versions with which this version of ispell.el is known to work.")
777 (defvar ispell-offset -
1
778 "Offset that maps protocol differences between ispell 3.1 versions.")
780 (defconst ispell-version
"ispell.el 3.6 - 7-Jan-2003")
783 (defun ispell-check-version (&optional interactivep
)
784 "Ensure that `ispell-program-name' is valid and the correct version.
785 Returns version number if called interactively.
786 Otherwise returns the library directory name, if that is defined."
787 ;; This is a little wasteful as we actually launch ispell twice: once
788 ;; to make sure it's the right version, and once for real. But people
789 ;; get confused by version mismatches *all* the time (and I've got the
790 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
791 ;; option is the only way I can think of to do this that works with
792 ;; all versions, since versions earlier than 3.0.09 didn't identify
793 ;; themselves on startup.
795 (let ((default-directory (or (and (boundp 'temporary-file-directory
)
796 temporary-file-directory
)
798 result status ispell-program-version
)
801 (setq status
(ispell-call-process
802 ispell-program-name nil t nil
803 ;; aspell doesn't accept the -vv switch.
804 (let ((case-fold-search
805 (memq system-type
'(ms-dos windows-nt
)))
807 (file-name-nondirectory ispell-program-name
)))
808 ;; Assume anything that isn't `aspell' is Ispell.
809 (if (string-match "\\`aspell" speller
) "-v" "-vv"))))
810 (goto-char (point-min))
812 ;; report version information of ispell and ispell.el
815 (setq result
(concat (buffer-substring-no-properties (point-min)
819 (message "%s" result
))
820 ;; return library directory.
821 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t
)
822 (setq result
(match-string 1))))
823 (goto-char (point-min))
824 (if (not (memq status
'(0 nil
)))
825 (error "%s exited with %s %s" ispell-program-name
826 (if (stringp status
) "signal" "code") status
))
828 ;; Get relevant version strings. Only xx.yy.... format works well
829 (let (case-fold-search)
830 (setq ispell-program-version
831 (and (search-forward-regexp "\\([0-9]+\\.[0-9\\.]+\\)" nil t
)
834 ;; Make sure these variables are (re-)initialized to the default value
835 (setq ispell-really-aspell nil
836 ispell-aspell-supports-utf8 nil
837 ispell-really-hunspell nil
838 ispell-encoding8-command nil
)
840 (goto-char (point-min))
841 (or (setq ispell-really-aspell
842 (and (search-forward-regexp
843 "(but really Aspell \\([0-9]+\\.[0-9\\.-]+\\)?)" nil t
)
845 (setq ispell-really-hunspell
846 (and (search-forward-regexp
847 "(but really Hunspell \\([0-9]+\\.[0-9\\.-]+\\)?)"
851 (let ((aspell-minver "0.50")
852 (aspell8-minver "0.60")
853 (ispell0-minver "3.1.0")
854 (ispell-minver "3.1.12")
855 (hunspell8-minver "1.1.6"))
857 (if (ispell-check-minver ispell0-minver ispell-program-version
)
858 (or (ispell-check-minver ispell-minver ispell-program-version
)
859 (setq ispell-offset
0))
860 (error "%s release %s or greater is required"
865 (ispell-really-aspell
866 (if (ispell-check-minver aspell-minver ispell-really-aspell
)
867 (if (ispell-check-minver aspell8-minver ispell-really-aspell
)
869 (setq ispell-aspell-supports-utf8 t
)
870 (setq ispell-encoding8-command
"--encoding=")))
871 (setq ispell-really-aspell nil
)))
872 (ispell-really-hunspell
873 (if (ispell-check-minver hunspell8-minver ispell-really-hunspell
)
874 (setq ispell-encoding8-command
"-i ")
875 (setq ispell-really-hunspell nil
))))))
878 (defun ispell-call-process (&rest args
)
879 "Like `call-process' but defend against bad `default-directory'."
880 (let ((default-directory default-directory
))
881 (unless (and (file-directory-p default-directory
)
882 (file-readable-p default-directory
))
883 (setq default-directory
(expand-file-name "~/")))
884 (apply 'call-process args
)))
886 (defun ispell-call-process-region (&rest args
)
887 "Like `call-process-region' but defend against bad `default-directory'."
888 (let ((default-directory default-directory
))
889 (unless (and (file-directory-p default-directory
)
890 (file-readable-p default-directory
))
891 (setq default-directory
(expand-file-name "~/")))
892 (apply 'call-process-region args
)))
896 ;; The preparation of the menu bar menu must be autoloaded
897 ;; because otherwise this file gets autoloaded every time Emacs starts
898 ;; so that it can set up the menus and determine keyboard equivalents.
901 (defvar ispell-menu-map nil
"Key map for ispell menu.")
902 ;;; redo menu when loading ispell to get dictionary modifications
903 (setq ispell-menu-map nil
)
906 (defvar ispell-menu-xemacs nil
907 "Spelling menu for XEmacs.
908 If nil when package is loaded, a standard menu will be set,
909 and added as a submenu of the \"Edit\" menu.")
911 ;; Break out XEmacs menu and split into several calls to avoid having
912 ;; long lines in loaddefs.el. Detect need off following constant.
914 ;;; Set up dictionary
916 (defvar ispell-menu-map-needed
917 ;; only needed when not version 18 and not XEmacs.
918 (and (not ispell-menu-map
)
919 (not (featurep 'xemacs
))
922 (defvar ispell-library-directory
(condition-case ()
923 (ispell-check-version)
925 "Directory where ispell dictionaries reside.")
927 (defvar ispell-process nil
928 "The process object for Ispell.")
930 (defvar ispell-async-processp
(and (fboundp 'delete-process
)
931 (fboundp 'process-send-string
)
932 (fboundp 'accept-process-output
)
933 ;;(fboundp 'start-process)
934 ;;(fboundp 'set-process-filter)
935 ;;(fboundp 'process-kill-without-query)
937 "Non-nil means that the OS supports asynchronous processes.")
939 ;; Make ispell.el work better with aspell.
941 (defvar ispell-aspell-dictionary-alist nil
942 "An alist of parsed aspell dicts and associated parameters.
945 (defun ispell-find-aspell-dictionaries ()
946 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
947 (unless (and ispell-really-aspell ispell-encoding8-command
)
948 (error "This function only works with aspell >= 0.60"))
952 (ispell-call-process ispell-program-name nil t nil
"dicts")
954 ;; Search for the named dictionaries.
957 (mapcar #'ispell-aspell-find-dictionary dictionaries
))))
958 ;; Ensure aspell's alias dictionary will override standard
960 (setq found
(ispell-aspell-add-aliases found
))
961 ;; Merge into FOUND any elements from the standard ispell-dictionary-alist
962 ;; which have no element in FOUND at all.
963 (dolist (dict ispell-dictionary-alist
)
964 (unless (assoc (car dict
) found
)
965 (setq found
(nconc found
(list dict
)))))
966 (setq ispell-aspell-dictionary-alist found
)
967 ;; Add a default entry
969 '(nil "[[:alpha:]]" "[^[:alpha:]]" "[']" nil
("-B") nil utf-8
)))
970 (push default-dict ispell-aspell-dictionary-alist
))))
972 (defvar ispell-aspell-data-dir nil
973 "Data directory of Aspell.")
975 (defvar ispell-aspell-dict-dir nil
976 "Dictionary directory of Aspell.")
978 (defun ispell-get-aspell-config-value (key)
979 "Return value of Aspell configuration option KEY.
980 Assumes that value contains no whitespace."
982 (ispell-call-process ispell-program-name nil t nil
"config" key
)
983 (car (split-string (buffer-string)))))
985 (defun ispell-aspell-find-dictionary (dict-name)
986 "For aspell dictionary DICT-NAME, return a list of parameters if an
987 associated data file is found or nil otherwise. List format is
988 that of `ispell-dictionary-base-alist' elements."
989 ;; Make sure `ispell-aspell-data-dir' is defined
990 (or ispell-aspell-data-dir
991 (setq ispell-aspell-data-dir
992 (ispell-get-aspell-config-value "data-dir")))
993 ;; Try finding associated datafile
995 (concat ispell-aspell-data-dir
"/"
996 ;; Strip out variant, country code, etc.
997 (and (string-match "^[[:alpha:]]+" dict-name
)
998 (match-string 0 dict-name
)) ".dat"))
1000 (concat ispell-aspell-data-dir
"/"
1001 ;; Strip out anything but xx_YY.
1002 (and (string-match "^[[:alpha:]_]+" dict-name
)
1003 (match-string 0 dict-name
)) ".dat"))
1005 (if (file-readable-p datafile1
)
1007 (if (file-readable-p datafile2
)
1013 (insert-file-contents data-file
)
1014 ;; There is zero or one line with special characters declarations.
1015 (when (search-forward-regexp "^special" nil t
)
1016 (let ((specials (split-string
1017 (buffer-substring (point)
1018 (progn (end-of-line) (point))))))
1019 ;; The line looks like: special ' -** - -** . -** : -*-
1020 ;; -** means that this character
1021 ;; - doesn't appear at word start
1022 ;; * may appear in the middle of a word
1023 ;; * may appear at word end
1024 ;; `otherchars' is about the middle case.
1026 (when (eq (aref (cadr specials
) 1) ?
*)
1027 (push (car specials
) otherchars
))
1028 (setq specials
(cddr specials
)))))
1032 (regexp-opt otherchars
)
1033 t
; We can't tell, so set this to t
1034 (list "-d" dict-name
)
1035 nil
; aspell doesn't support this
1036 ;; Here we specify the encoding to use while communicating with
1037 ;; aspell. This doesn't apply to command line arguments, so
1038 ;; just don't pass words to spellcheck as arguments...
1041 (defun ispell-aspell-add-aliases (alist)
1042 "Find aspell's dictionary aliases and add them to dictionary ALIST.
1043 Return the new dictionary alist."
1045 (file-expand-wildcards
1046 (concat (or ispell-aspell-dict-dir
1047 (setq ispell-aspell-dict-dir
1048 (ispell-get-aspell-config-value "dict-dir")))
1050 (dolist (alias-file aliases
)
1052 (insert-file-contents alias-file
)
1053 ;; Look for a line "add FOO.multi", extract FOO
1054 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t
)
1055 (let* ((aliasname (file-name-sans-extension
1056 (file-name-nondirectory alias-file
)))
1057 (already-exists-p (assoc aliasname alist
))
1058 (realname (match-string 1))
1059 (realdict (assoc realname alist
)))
1060 (when (and realdict
(not already-exists-p
))
1061 (push (cons aliasname
(cdr realdict
)) alist
))))))
1064 ;; Set params according to the selected spellchecker
1066 (defvar ispell-last-program-name nil
1067 "Last value of `ispell-program-name'. Internal use.")
1069 (defvar ispell-initialize-spellchecker-hook nil
1070 "Normal hook run on spellchecker initialization.
1071 This hook is run when a spellchecker is used for the first
1072 time, before `ispell-dictionary-alist' is set. It is intended for
1073 sysadmins to override entries in `ispell-dictionary-base-alist'
1074 by putting those overrides in `ispell-base-dicts-override-alist', which is
1075 a dynamically scoped var with same format as `ispell-dictionary-alist'.
1076 This alist will not override the auto-detected values (e.g. if a recent
1077 aspell is used along with Emacs).")
1079 (defun ispell-set-spellchecker-params ()
1080 "Initialize some spellchecker parameters when changed or first used."
1081 (unless (eq ispell-last-program-name ispell-program-name
)
1082 (setq ispell-last-program-name ispell-program-name
)
1083 (ispell-kill-ispell t
)
1084 (if (and (condition-case ()
1086 (setq ispell-library-directory
(ispell-check-version))
1089 ispell-really-aspell
1090 ispell-encoding8-command
1091 ;; XEmacs does not like [:alpha:] regexps.
1092 (string-match "^[[:alpha:]]+$" "abcde"))
1093 (unless ispell-aspell-dictionary-alist
1094 (ispell-find-aspell-dictionaries)))
1096 ;; Substitute ispell-dictionary-alist with the list of dictionaries
1097 ;; corresponding to the given spellchecker. If a recent aspell, use
1098 ;; the list of really installed dictionaries and add to it elements
1099 ;; of the original list that are not present there. Allow distro info.
1100 (let ((found-dicts-alist
1101 (if (and ispell-really-aspell
1102 ispell-encoding8-command
)
1103 ispell-aspell-dictionary-alist
1105 ispell-base-dicts-override-alist
; Override only base-dicts-alist
1108 (run-hooks 'ispell-initialize-spellchecker-hook
)
1110 ;; Add dicts to ``ispell-dictionary-alist'' unless already present.
1111 (dolist (dict (append found-dicts-alist
1112 ispell-base-dicts-override-alist
1113 ispell-dictionary-base-alist
))
1114 (unless (assoc (car dict
) all-dicts-alist
)
1115 (add-to-list 'all-dicts-alist dict
)))
1116 (setq ispell-dictionary-alist all-dicts-alist
))))
1119 (defun ispell-valid-dictionary-list ()
1120 "Return a list of valid dictionaries.
1121 The variable `ispell-library-directory' defines the library location."
1122 ;; Initialize variables and dictionaries alists for desired spellchecker.
1123 ;; Make sure ispell.el is loaded to avoid some autoload loops in XEmacs
1124 ;; (and may be others)
1125 (if (featurep 'ispell
)
1126 (ispell-set-spellchecker-params))
1128 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist
))
1129 (dict-list (cons "default" nil
))
1131 (dolist (dict dicts
)
1132 (setq name
(car dict
)
1133 dict-bname
(or (car (cdr (member "-d" (nth 5 dict
))))
1135 ;; Include if the dictionary is in the library, or dir not defined.
1138 ;; For Aspell, we already know which dictionaries exist.
1139 (or ispell-really-aspell
1140 ;; Include all dictionaries if lib directory not known.
1141 ;; Same for Hunspell, where ispell-library-directory is nil.
1142 (not ispell-library-directory
)
1143 (file-exists-p (concat ispell-library-directory
1144 "/" dict-bname
".hash"))
1145 (file-exists-p (concat ispell-library-directory
1146 "/" dict-bname
".has"))))
1147 (push name dict-list
)))
1150 ;;; define commands in menu in opposite order you want them to appear.
1152 (if ispell-menu-map-needed
1154 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
1155 (define-key ispell-menu-map
[ispell-change-dictionary
]
1156 `(menu-item ,(purecopy "Change Dictionary...") ispell-change-dictionary
1157 :help
,(purecopy "Supply explicit dictionary file name")))
1158 (define-key ispell-menu-map
[ispell-kill-ispell
]
1159 `(menu-item ,(purecopy "Kill Process") ispell-kill-ispell
1160 :enable
(and (boundp 'ispell-process
) ispell-process
1161 (eq (ispell-process-status) 'run
))
1162 :help
,(purecopy "Terminate Ispell subprocess")))
1163 (define-key ispell-menu-map
[ispell-pdict-save
]
1164 `(menu-item ,(purecopy "Save Dictionary")
1165 (lambda () (interactive) (ispell-pdict-save t t
))
1166 :help
,(purecopy "Save personal dictionary")))
1167 (define-key ispell-menu-map
[ispell-customize
]
1168 `(menu-item ,(purecopy "Customize...")
1169 (lambda () (interactive) (customize-group 'ispell
))
1170 :help
,(purecopy "Customize spell checking options")))
1171 (define-key ispell-menu-map
[ispell-help
]
1172 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1173 `(menu-item ,(purecopy "Help")
1174 (lambda () (interactive) (describe-function 'ispell-help
))
1175 :help
,(purecopy "Show standard Ispell keybindings and commands")))
1176 (define-key ispell-menu-map
[flyspell-mode
]
1177 `(menu-item ,(purecopy "Automatic spell checking (Flyspell)")
1179 :help
,(purecopy "Check spelling while you edit the text")
1180 :button
(:toggle .
(bound-and-true-p flyspell-mode
))))
1181 (define-key ispell-menu-map
[ispell-complete-word
]
1182 `(menu-item ,(purecopy "Complete Word") ispell-complete-word
1183 :help
,(purecopy "Complete word at cursor using dictionary")))
1184 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
1185 `(menu-item ,(purecopy "Complete Word Fragment")
1186 ispell-complete-word-interior-frag
1187 :help
,(purecopy "Complete word fragment at cursor")))))
1190 (if ispell-menu-map-needed
1192 (define-key ispell-menu-map
[ispell-continue
]
1193 `(menu-item ,(purecopy "Continue Spell-Checking") ispell-continue
1194 :enable
(and (boundp 'ispell-region-end
)
1195 (marker-position ispell-region-end
)
1196 (equal (marker-buffer ispell-region-end
)
1198 :help
,(purecopy "Continue spell checking last region")))
1199 (define-key ispell-menu-map
[ispell-word
]
1200 `(menu-item ,(purecopy "Spell-Check Word") ispell-word
1201 :help
,(purecopy "Spell-check word at cursor")))
1202 (define-key ispell-menu-map
[ispell-comments-and-strings
]
1203 `(menu-item ,(purecopy "Spell-Check Comments")
1204 ispell-comments-and-strings
1205 :help
,(purecopy "Spell-check only comments and strings")))))
1208 (if ispell-menu-map-needed
1210 (define-key ispell-menu-map
[ispell-region
]
1211 `(menu-item ,(purecopy "Spell-Check Region") ispell-region
1213 :help
,(purecopy "Spell-check text in marked region")))
1214 (define-key ispell-menu-map
[ispell-message
]
1215 `(menu-item ,(purecopy "Spell-Check Message") ispell-message
1216 :visible
(eq major-mode
'mail-mode
)
1217 :help
,(purecopy "Skip headers and included message text")))
1218 (define-key ispell-menu-map
[ispell-buffer
]
1219 `(menu-item ,(purecopy "Spell-Check Buffer") ispell-buffer
1220 :help
,(purecopy "Check spelling of selected buffer")))
1221 ;;(put 'ispell-region 'menu-enable 'mark-active)
1222 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
1224 ;;; XEmacs versions 19 & 20
1225 (if (and (featurep 'xemacs
)
1227 ;;(null ispell-menu-xemacs)
1228 (not (and (boundp 'infodock-version
) infodock-version
)))
1229 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list
)
1230 (reverse (ispell-valid-dictionary-list))))
1231 (current-menubar (or current-menubar default-menubar
))
1233 '(["Help" (describe-function 'ispell-help
) t
]
1234 ;;["Help" (popup-menu ispell-help-list) t]
1235 ["Check Message" ispell-message t
]
1236 ["Check Buffer" ispell-buffer t
]
1237 ["Check Comments" ispell-comments-and-strings t
]
1238 ["Check Word" ispell-word t
]
1239 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
1240 ["Continue Check" ispell-continue t
]
1241 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
1242 ["Complete Word" ispell-complete-word t
]
1243 ["Kill Process" ispell-kill-ispell t
]
1244 ["Customize..." (customize-group 'ispell
) t
]
1245 ;; flyspell-mode may not be bound...
1246 ;;["flyspell" flyspell-mode
1247 ;; :style toggle :selected flyspell-mode ]
1249 ["Save Personal Dict"(ispell-pdict-save t t
) t
]
1250 ["Change Dictionary" ispell-change-dictionary t
])))
1252 (setq dicts
(cons "default" nil
)))
1253 (dolist (name dicts
)
1254 (setq menu
(append menu
1257 (concat "Select " (capitalize name
))
1258 (list 'ispell-change-dictionary name
)
1260 (setq ispell-menu-xemacs menu
)
1263 (if (car (find-menu-item current-menubar
'("Cmds")))
1266 (delete-menu-item '("Cmds" "Spell-Check"))
1267 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs
))
1269 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1270 (add-menu '("Edit") "Spell" ispell-menu-xemacs
))))))
1272 (defalias 'ispell-int-char
1273 ;; Allow incrementing characters as integers in XEmacs 20
1274 (if (and (featurep 'xemacs
)
1275 (fboundp 'int-char
))
1277 ;; Emacs and XEmacs 19 or earlier
1281 ;;; **********************************************************************
1283 (defvar ispell-current-dictionary nil
1284 "The name of the current dictionary, or nil for the default.
1285 This is passed to the ispell process using the `-d' switch and is
1286 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1288 (defvar ispell-current-personal-dictionary nil
1289 "The name of the current personal dictionary, or nil for the default.
1290 This is passed to the ispell process using the `-p' switch.")
1292 (defun ispell-decode-string (str)
1293 "Decodes multibyte character strings.
1294 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1295 ;; FIXME: enable-multibyte-characters is read-only, so bogus bindings are
1296 ;; really nasty (they signal an error in Emacs): Who does that? --Stef
1297 (if (and (or (featurep 'xemacs
)
1298 (and (boundp 'enable-multibyte-characters
)
1299 enable-multibyte-characters
))
1300 (fboundp 'decode-coding-string
)
1301 (ispell-get-coding-system))
1302 (decode-coding-string str
(ispell-get-coding-system))
1305 ;; Return a string decoded from Nth element of the current dictionary.
1306 (defun ispell-get-decoded-string (n)
1307 "Get the decoded string in slot N of the descriptor of the current dict."
1309 (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1310 (assoc ispell-current-dictionary ispell-dictionary-alist
)
1311 (error "No match for the current dictionary")))
1313 (when (and (> (length str
) 0)
1314 (not (multibyte-string-p str
)))
1315 (setq str
(ispell-decode-string str
))
1316 (or (multibyte-string-p str
)
1317 (setq str
(string-to-multibyte str
))))
1320 (defun ispell-get-casechars ()
1321 (ispell-get-decoded-string 1))
1322 (defun ispell-get-not-casechars ()
1323 (ispell-get-decoded-string 2))
1324 (defun ispell-get-otherchars ()
1325 (ispell-get-decoded-string 3))
1326 (defun ispell-get-many-otherchars-p ()
1327 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1328 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1329 (defun ispell-get-ispell-args ()
1330 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1331 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1332 (defun ispell-get-extended-character-mode ()
1333 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1334 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1335 (defun ispell-get-coding-system ()
1336 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1337 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1340 (defvar ispell-pdict-modified-p nil
1341 "Non-nil means personal dictionary has modifications to be saved.")
1343 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1344 ;;; When non-nil, the spell session is terminated.
1345 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1346 (defvar ispell-quit nil
)
1348 (defvar ispell-process-directory nil
1349 "The directory where `ispell-process' was started.")
1351 (defvar ispell-filter nil
1352 "Output filter from piped calls to Ispell.")
1354 (defvar ispell-filter-continue nil
1355 "Control variable for Ispell filter function.")
1357 (defvar ispell-output-buffer nil
1358 "Buffer used for reading output of a synchronous Ispell subprocess.")
1360 (defvar ispell-session-buffer nil
1361 "Buffer used for passing input to a synchronous Ispell subprocess.")
1363 (defvar ispell-cmd-args nil
1364 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1366 (defvar ispell-query-replace-marker
(make-marker)
1367 "Marker for `query-replace' processing.")
1369 (defvar ispell-recursive-edit-marker
(make-marker)
1370 "Marker for return point from recursive edit.")
1372 (defvar ispell-checking-message nil
1373 "Non-nil when we're checking a mail message.
1374 Set to the MIME boundary locations when checking messages.")
1376 (defconst ispell-choices-buffer
"*Choices*")
1378 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
1380 ;;; *** Buffer Local Definitions ***
1382 (defconst ispell-words-keyword
"LocalWords: "
1383 "The keyword for local oddly-spelled words to accept.
1384 The keyword will be followed by any number of local word spellings.
1385 There can be multiple of these keywords in the file.")
1387 (defconst ispell-dictionary-keyword
"Local IspellDict: "
1388 "The keyword for a local dictionary to use.
1389 The keyword must be followed by a valid dictionary name, defined in
1390 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1391 When multiple occurrences exist, the last keyword
1392 definition is used.")
1394 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
1395 "The keyword for defining buffer local dictionaries.
1396 Keyword must be followed by the filename of a personal dictionary.
1397 The last occurring definition in the buffer will be used.")
1399 (defconst ispell-parsing-keyword
"Local IspellParsing: "
1400 "The keyword for overriding default Ispell parsing.
1401 The above keyword string should be followed by `latex-mode' or
1402 `nroff-mode' to put the current buffer into the desired parsing mode.
1404 Extended character mode can be changed for this buffer by placing
1405 a `~' followed by an extended-character mode -- such as `~.tex'.
1406 The last occurring definition in the buffer will be used.")
1409 (defvar ispell-skip-region-alist
1410 `((ispell-words-keyword forward-line
)
1411 (ispell-dictionary-keyword forward-line
)
1412 (ispell-pdict-keyword forward-line
)
1413 (ispell-parsing-keyword forward-line
)
1414 (,(purecopy "^---*BEGIN PGP [A-Z ]*--*")
1415 .
,(purecopy "^---*END PGP [A-Z ]*--*"))
1416 ;; assume multiline uuencoded file? "\nM.*$"?
1417 (,(purecopy "^begin [0-9][0-9][0-9] [^ \t]+$") .
,(purecopy "\nend\n"))
1418 (,(purecopy "^%!PS-Adobe-[123].0") .
,(purecopy "\n%%EOF\n"))
1419 (,(purecopy "^---* \\(Start of \\)?[Ff]orwarded [Mm]essage")
1420 .
,(purecopy "^---* End of [Ff]orwarded [Mm]essage"))
1421 ;; Matches e-mail addresses, file names, http addresses, etc. The
1422 ;; `-+' `_+' patterns are necessary for performance reasons when
1423 ;; `-' or `_' part of word syntax.
1424 (,(purecopy "\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)"))
1425 ;; above checks /.\w sequences
1426 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1427 ;; This is a pretty complex regexp. It can be simplified to the following:
1428 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1429 ;; but some valid text will be skipped, e.g. "his/her". This could be
1430 ;; fixed up (at the expense of a moderately more complex regexp)
1431 ;; by not allowing "/" to be the character which triggers the
1432 ;; identification of the computer name, e.g.:
1433 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1435 "Alist expressing beginning and end of regions not to spell check.
1436 The alist key must be a regular expression.
1437 Valid forms include:
1438 (KEY) - just skip the key.
1439 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1440 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1441 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1442 (put 'ispell-skip-region-alist
'risky-local-variable t
)
1446 (defvar ispell-tex-skip-alists
1448 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1449 ;; All the standard LaTeX keywords from L. Lamport's guide:
1450 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1451 ;; \label, \nocite, \rule (in ispell - rest included here)
1452 ("\\\\addcontentsline" ispell-tex-arg-end
2)
1453 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end
)
1454 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end
)
1455 ;;("\\\\author" ispell-tex-arg-end)
1456 ("\\\\bibliographystyle" ispell-tex-arg-end
)
1457 ("\\\\makebox" ispell-tex-arg-end
0)
1458 ("\\\\e?psfig" ispell-tex-arg-end
)
1459 ("\\\\document\\(class\\|style\\)" .
1460 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1461 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1462 ;; equation, minipage, picture, tabular, tabular* (ispell)
1463 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end
0)
1464 ("list" ispell-tex-arg-end
2)
1465 ("program" .
"\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1466 ("verbatim\\*?" .
"\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}"))))
1467 "*Lists of regions to be skipped in TeX mode.
1468 First list is used raw.
1469 Second list has key placed inside \\begin{}.
1471 Delete or add any regions you want to be automatically selected
1472 for skipping in latex mode.")
1473 (put 'ispell-tex-skip-alist
'risky-local-variable t
)
1477 (defconst ispell-html-skip-alists
1478 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1479 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1480 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1481 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1482 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1485 ("&[^ \t\n;]" "[; \t\n]"))
1486 "*Lists of start and end keys to skip in HTML buffers.
1487 Same format as `ispell-skip-region-alist'.
1488 Note - substrings of other matches must come last
1489 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1490 (put 'ispell-html-skip-alists
'risky-local-variable t
)
1492 (defvar ispell-local-pdict ispell-personal-dictionary
1493 "A buffer local variable containing the current personal dictionary.
1494 If non-nil, the value must be a string, which is a file name.
1496 If you specify a personal dictionary for the current buffer which is
1497 different from the current personal dictionary, the effect is similar
1498 to calling \\[ispell-change-dictionary]. This variable is automatically
1499 set when defined in the file with either `ispell-pdict-keyword' or the
1500 local variable syntax.")
1502 (make-variable-buffer-local 'ispell-local-pdict
)
1503 ;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
1505 (defvar ispell-buffer-local-name nil
1506 "Contains the buffer name if local word definitions were used.
1507 Ispell is then restarted because the local words could conflict.")
1509 (defvar ispell-parser
'use-mode-name
1510 "*Indicates whether ispell should parse the current buffer as TeX Code.
1511 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1512 Default parser is `nroff'.
1513 Currently the only other valid parser is `tex'.
1515 You can set this variable in hooks in your init file -- eg:
1517 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1519 (defvar ispell-region-end
(make-marker)
1520 "Marker that allows spelling continuations.")
1522 (defvar ispell-check-only nil
1523 "If non-nil, `ispell-word' does not try to correct the word.")
1526 ;;; **********************************************************************
1527 ;;; **********************************************************************
1531 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1534 (defun ispell-accept-output (&optional timeout-secs timeout-msecs
)
1535 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1536 If asynchronous subprocesses are not supported, call `ispell-filter' and
1537 pass it the output of the last ispell invocation."
1538 (if ispell-async-processp
1539 (accept-process-output ispell-process timeout-secs timeout-msecs
)
1540 (if (null ispell-process
)
1541 (error "No Ispell process to read output from!")
1542 (let ((buf ispell-output-buffer
)
1544 (if (not (bufferp buf
))
1545 (setq ispell-filter nil
)
1546 (with-current-buffer buf
1547 (setq ispell-output
(buffer-substring-no-properties
1548 (point-min) (point-max))))
1549 (ispell-filter t ispell-output
)
1550 (with-current-buffer buf
1551 (erase-buffer)))))))
1553 (defun ispell-send-replacement (misspelled replacement
)
1554 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1555 This allows it to improve the suggestion list based on actual misspellings."
1556 (and ispell-really-aspell
1557 (ispell-send-string (concat "$$ra " misspelled
"," replacement
"\n"))))
1560 (defun ispell-send-string (string)
1561 "Send the string STRING to the Ispell process."
1562 (if ispell-async-processp
1563 (process-send-string ispell-process string
)
1564 ;; Asynchronous subprocesses aren't supported on this losing system.
1565 ;; We keep all the directives passed to Ispell during the entire
1566 ;; session in a buffer, and pass them anew each time we invoke
1567 ;; Ispell to process another chunk of text. (Yes, I know this is a
1568 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1569 (let ((cmd (aref string
0))
1570 ;; The following commands are not passed to Ispell until
1571 ;; we have a *real* reason to invoke it.
1572 (cmds-to-defer '(?
* ?
@ ?~ ?
+ ?- ?
! ?%
))
1573 (session-buf ispell-session-buffer
)
1574 (output-buf ispell-output-buffer
)
1575 (ispell-args ispell-cmd-args
)
1576 (defdir ispell-process-directory
)
1578 (with-current-buffer session-buf
1579 (setq prev-pos
(point))
1580 (setq default-directory defdir
)
1582 (if (not (memq cmd cmds-to-defer
))
1583 (let (coding-system-for-read coding-system-for-write status
)
1584 (if (and (boundp 'enable-multibyte-characters
)
1585 enable-multibyte-characters
)
1586 (setq coding-system-for-read
(ispell-get-coding-system)
1587 coding-system-for-write
(ispell-get-coding-system)))
1588 (set-buffer output-buf
)
1590 (set-buffer session-buf
)
1592 (apply 'ispell-call-process-region
1593 (point-min) (point-max)
1594 ispell-program-name nil
1597 ;; hunspell -m option means something different
1598 (if ispell-really-hunspell
"" "-m")
1600 (set-buffer output-buf
)
1601 (goto-char (point-min))
1603 (if (not (looking-at "@(#) "))
1604 (error "Ispell error: %s"
1605 (buffer-substring-no-properties
1606 (point) (progn (end-of-line) (point)))))
1607 ;; If STRING is "^Z\n", we just started Ispell and need
1608 ;; to retain its version ID line in the output buffer.
1609 ;; Otherwise, remove the ID line, as it will confuse
1611 (or (string= string
"\032\n")
1614 (delete-region (point-min) (point))))
1615 ;; If STRING begins with ^ or any normal character, we need
1616 ;; to remove the last line from the session buffer, since it
1617 ;; was just spell-checked, and we don't want to check it again.
1618 ;; The same goes for the # command, since Ispell already saved
1619 ;; the personal dictionary.
1620 (set-buffer session-buf
)
1621 (delete-region prev-pos
(point))
1622 ;; Ispell run synchronously saves the personal dictionary
1623 ;; after each successful command. So we can remove any
1624 ;; lines in the session buffer that insert words into the
1626 (if (memq status
'(0 nil
))
1627 (let ((more-lines t
))
1628 (goto-char (point-min))
1630 (if (looking-at "^\\*")
1631 (let ((start (point)))
1633 (delete-region start
(point)))
1634 (setq more-lines
(= 0 (forward-line))))))))))))))
1637 ;; Insert WORD while possibly translating characters by
1638 ;; translation-table-for-input.
1639 (defun ispell-insert-word (word)
1640 (let ((pos (point)))
1642 ;; Avoid "obsolete" warnings for translation-table-for-input.
1644 (if (char-table-p translation-table-for-input
)
1645 (translate-region pos
(point) translation-table-for-input
)))))
1648 (defun ispell-word (&optional following quietly continue region
)
1649 "Check spelling of word under or before the cursor.
1650 If the word is not found in dictionary, display possible corrections
1651 in a window allowing you to choose one.
1653 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1654 is non-nil when called interactively, then the following word
1655 \(rather than preceding\) is checked when the cursor is not over a word.
1656 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1657 when called interactively, non-corrective messages are suppressed.
1659 With a prefix argument (or if CONTINUE is non-nil),
1660 resume interrupted spell-checking of a buffer or region.
1662 Interactively, in Transient Mark mode when the mark is active, call
1663 `ispell-region' to check the active region for spelling errors.
1665 Word syntax is controlled by the definition of the chosen dictionary,
1666 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1668 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1669 or \\[ispell-region] to update the Ispell process.
1672 nil word is correct or spelling is accepted.
1673 0 word is inserted into buffer-local definitions.
1674 \"word\" word corrected from word list.
1675 \(\"word\" arg\) word is hand entered.
1676 quit spell session exited."
1677 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t
))
1679 ((and region
(use-region-p))
1680 (ispell-region (region-beginning) (region-end)))
1681 (continue (ispell-continue))
1683 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1684 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1685 (let ((cursor-location (point)) ; retain cursor location
1686 (word (ispell-get-word following
))
1687 start end poss new-word replace
)
1688 ;; De-structure return word info list.
1689 (setq start
(car (cdr word
))
1690 end
(car (cdr (cdr word
)))
1693 ;; At this point it used to ignore 2-letter words.
1694 ;; But that is silly; if the user asks for it, we should do it. - rms.
1696 (message "Checking spelling of %s..."
1697 (funcall ispell-format-word-function word
)))
1698 (ispell-send-string "%\n") ; put in verbose mode
1699 (ispell-send-string (concat "^" word
"\n"))
1700 ;; wait until ispell has processed word
1702 (ispell-accept-output)
1703 (not (string= "" (car ispell-filter
)))))
1704 ;;(ispell-send-string "!\n") ;back to terse mode.
1705 (setq ispell-filter
(cdr ispell-filter
)) ; remove extra \n
1706 (if (and ispell-filter
(listp ispell-filter
))
1707 (if (> (length ispell-filter
) 1)
1708 (error "Ispell and its process have different character maps")
1709 (setq poss
(ispell-parse-output (car ispell-filter
)))))
1712 (message "%s is correct"
1713 (funcall ispell-format-word-function word
)))
1714 (and (featurep 'xemacs
)
1716 (and (fboundp 'delete-extent
)
1717 (delete-extent (extent-at start
)))))
1720 (message "%s is correct because of root %s"
1721 (funcall ispell-format-word-function word
)
1722 (funcall ispell-format-word-function poss
)))
1723 (and (featurep 'xemacs
)
1725 (and (fboundp 'delete-extent
)
1726 (delete-extent (extent-at start
)))))
1727 ((null poss
) (message "Error in ispell process"))
1728 (ispell-check-only ; called from ispell minor mode.
1729 (if (fboundp 'make-extent
)
1730 (if (fboundp 'set-extent-property
)
1731 (let ((ext (make-extent start end
)))
1732 (set-extent-property ext
'face ispell-highlight-face
)
1733 (set-extent-property ext
'priority
2000)))
1735 (message "%s is incorrect"
1736 (funcall ispell-format-word-function word
))))
1737 (t ; prompt for correct word.
1738 (save-window-excursion
1739 (setq replace
(ispell-command-loop
1740 (car (cdr (cdr poss
)))
1741 (car (cdr (cdr (cdr poss
))))
1742 (car poss
) start end
)))
1743 (cond ((equal 0 replace
)
1744 (ispell-add-per-file-word-list (car poss
)))
1746 (setq new-word
(if (atom replace
) replace
(car replace
))
1747 cursor-location
(+ (- (length word
) (- end start
))
1749 (if (not (equal new-word
(car poss
)))
1752 ;; Insert first and then delete,
1753 ;; to avoid collapsing markers before and after
1754 ;; into a single place.
1755 (ispell-insert-word new-word
)
1756 (delete-region (point) end
)
1757 ;; It is meaningless to preserve the cursor position
1758 ;; inside a word that has changed.
1759 (setq cursor-location
(point))
1760 (setq end
(point))))
1761 (if (not (atom replace
)) ;recheck spelling of replacement
1763 (if (car (cdr replace
)) ; query replace requested
1764 (save-window-excursion
1765 (query-replace word new-word t
)))
1767 ;; single word could be split into multiple words
1768 (setq ispell-quit
(not (ispell-region start end
)))
1770 ;; keep if rechecking word and we keep choices win.
1771 (if (get-buffer ispell-choices-buffer
)
1772 (kill-buffer ispell-choices-buffer
))))
1773 (ispell-pdict-save ispell-silently-savep
)
1774 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1775 (if ispell-quit
(setq ispell-quit nil replace
'quit
))
1776 (goto-char cursor-location
) ; return to original location
1780 (defun ispell-get-word (following &optional extra-otherchars
)
1781 "Return the word for spell-checking according to ispell syntax.
1782 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1783 is non-nil when called interactively, then the following word
1784 \(rather than preceding\) is checked when the cursor is not over a word.
1785 Optional second argument contains otherchars that can be included in word
1788 Word syntax is controlled by the definition of the chosen dictionary,
1789 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1790 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1791 (let* ((ispell-casechars (ispell-get-casechars))
1792 (ispell-not-casechars (ispell-get-not-casechars))
1793 (ispell-otherchars (ispell-get-otherchars))
1794 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1795 (word-regexp (concat ispell-casechars
1797 (if (not (string= "" ispell-otherchars
))
1798 (concat ispell-otherchars
"?"))
1799 (if extra-otherchars
1800 (concat extra-otherchars
"?"))
1803 (if (or ispell-many-otherchars-p
1809 (if (not (looking-at ispell-casechars
))
1811 (re-search-forward ispell-casechars
(point-max) t
)
1812 (re-search-backward ispell-casechars
(point-min) t
)))
1813 ;; move to front of word
1814 (re-search-backward ispell-not-casechars
(point-min) 'start
)
1815 (while (and (or (and (not (string= "" ispell-otherchars
))
1816 (looking-at ispell-otherchars
))
1817 (and extra-otherchars
(looking-at extra-otherchars
)))
1819 (or (not did-it-once
)
1820 ispell-many-otherchars-p
)
1821 (not (eq prevpt
(point))))
1822 (if (and extra-otherchars
(looking-at extra-otherchars
))
1825 (if (looking-at ispell-casechars
)
1826 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
1830 (if (looking-at ispell-casechars
)
1831 (re-search-backward ispell-not-casechars
(point-min) 'move
)
1832 (backward-char -
1))))
1833 ;; Now mark the word and save to string.
1834 (if (not (re-search-forward word-regexp
(point-max) t
))
1835 (if ispell-check-only
1836 ;; return dummy word when just flagging misspellings
1837 (list "" (point) (point))
1838 (error "No word found to check!"))
1839 (setq start
(copy-marker (match-beginning 0))
1841 word
(buffer-substring-no-properties start end
))
1842 (list word start end
))))
1845 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1846 ;;; tracks changes in the dictionary. The global may either be
1847 ;;; a value or a list, whose value is the state of whether the
1848 ;;; dictionary needs to be saved.
1851 (defun ispell-pdict-save (&optional no-query force-save
)
1852 "Check to see if the personal dictionary has been modified.
1853 If so, ask if it needs to be saved."
1854 (interactive (list ispell-silently-savep t
))
1855 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
1856 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
1857 (if (or ispell-pdict-modified-p force-save
)
1858 (if (or no-query
(y-or-n-p "Personal dictionary modified. Save? "))
1860 (ispell-send-string "#\n") ; save dictionary
1861 (message "Personal dictionary saved."))))
1862 ;; unassert variable, even if not saved to avoid questioning.
1863 (setq ispell-pdict-modified-p nil
))
1866 (defun ispell-command-loop (miss guess word start end
)
1867 "Display possible corrections from list MISS.
1868 GUESS lists possibly valid affix construction of WORD.
1869 Returns nil to keep word.
1870 Returns 0 to insert locally into buffer-local dictionary.
1871 Returns string for new chosen word.
1872 Returns list for new replacement word (will be rechecked).
1873 Query-replace when list length is 2.
1874 Automatic query-replace when second element is `query-replace'.
1875 Highlights the word, which is assumed to run from START to END.
1876 Global `ispell-pdict-modified-p' becomes a list where the only value
1877 indicates whether the dictionary has been modified when option `a'
1879 Global `ispell-quit' set to start location to continue spell session."
1881 (line ispell-choices-win-default-height
)
1882 ;; ensure 4 context lines.
1883 (max-lines (- (ispell-adjusted-window-height) 4))
1885 (window-min-height (min window-min-height
1886 ispell-choices-win-default-height
))
1887 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
1888 (dedicated (window-dedicated-p (selected-window)))
1890 char num result textwin dedicated-win
)
1892 ;; setup the *Choices* buffer with valid data.
1893 (with-current-buffer (get-buffer-create ispell-choices-buffer
)
1894 (setq mode-line-format
1896 "-- %b -- word: " word
1897 " -- dict: " (or ispell-current-dictionary
"default")
1898 " -- prog: " (file-name-nondirectory ispell-program-name
)))
1899 ;; XEmacs: no need for horizontal scrollbar in choices window
1901 (and (fboundp 'set-specifier
)
1902 (boundp 'horizontal-scrollbar-visible-p
)
1903 (set-specifier horizontal-scrollbar-visible-p nil
1904 (cons (current-buffer) nil
))))
1908 (insert "Affix rules generate and capitalize "
1909 "this word as shown below:\n\t")
1911 (if (> (+ 4 (current-column) (length (car guess
)))
1915 (setq line
(1+ line
))))
1916 (insert (car guess
) " ")
1917 (setq guess
(cdr guess
)))
1918 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.")
1919 (setq line
(+ line
(if choices
3 2)))))
1921 (< (if (> (+ 7 (current-column) (length (car choices
))
1922 (if (> count ?~
) 3 0))
1926 (setq line
(1+ line
)))
1929 ;; not so good if there are over 20 or 30 options, but then, if
1930 ;; there are that many you don't want to scan them all anyway...
1931 (while (memq count command-characters
) ; skip command characters.
1932 (setq count
(ispell-int-char (1+ count
))
1933 skipped
(1+ skipped
)))
1934 (insert "(" count
") " (car choices
) " ")
1935 (setq choices
(cdr choices
)
1936 count
(ispell-int-char (1+ count
))))
1937 (setq count
(ispell-int-char (- count ?
0 skipped
))))
1939 ;; ensure word is visible
1940 (if (not (pos-visible-in-window-p end
))
1943 ;; allow temporary split of dedicated windows...
1946 (setq dedicated-win
(selected-window))
1947 (set-window-dedicated-p dedicated-win nil
)))
1949 ;; Display choices for misspelled word.
1950 (ispell-show-choices line end
)
1951 (select-window (setq textwin
(next-window)))
1953 ;; highlight word, protecting current buffer status
1956 (and ispell-highlight-p
1957 (ispell-highlight-spelling-error start end t
))
1958 ;; Loop until a valid choice is made.
1966 (let (message-log-max)
1967 (message (concat "C-h or ? for more options; SPC to leave "
1968 "unchanged, Character to replace word")))
1969 (let ((inhibit-quit t
)
1971 (setq char nil skipped
0)
1972 ;; If the user types C-g, or generates some other
1973 ;; non-character event (such as a frame switch
1974 ;; event), stop ispell. As a special exception,
1975 ;; ignore mouse events occurring in the same frame.
1976 (while (and input-valid
(not (characterp char
)))
1977 (setq char
(read-key))
1979 (or (characterp char
)
1980 (and (mouse-event-p char
)
1981 (eq (selected-frame)
1983 (posn-window (event-start char
))))))))
1984 (when (or quit-flag
(not input-valid
) (= char ?\C-g
))
1985 (setq char ?X quit-flag nil
)))
1986 ;; Adjust num to array offset skipping command characters.
1987 (let ((com-chars command-characters
))
1989 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
1990 (setq skipped
(1+ skipped
)))
1991 (setq com-chars
(cdr com-chars
)))
1992 (setq num
(- char ?
0 skipped
)))
1995 ((= char ?
) nil
) ; accept word this time only
1996 ((= char ?i
) ; accept and insert word into pers dict
1997 (ispell-send-string (concat "*" word
"\n"))
1998 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2000 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
2001 (ispell-send-string (concat "@" word
"\n"))
2002 (if (null ispell-pdict-modified-p
)
2003 (setq ispell-pdict-modified-p
2004 (list ispell-pdict-modified-p
)))
2005 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
2006 ((or (= char ?r
) (= char ?R
)) ; type in replacement
2007 (and (eq 'block ispell-highlight-p
) ; refresh tty's
2008 (ispell-highlight-spelling-error start end nil t
))
2010 (if (or (= char ?R
) ispell-query-replace-choices
)
2012 (format "Query-replacement for %s: "word
)
2015 (cons (read-string "Replacement for: " word
)
2017 (and (eq 'block ispell-highlight-p
)
2018 (ispell-highlight-spelling-error start end nil
2021 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
2022 (and (eq 'block ispell-highlight-p
)
2023 (ispell-highlight-spelling-error start end nil t
))
2025 (and (eq 'block ispell-highlight-p
)
2026 (ispell-highlight-spelling-error start end nil
2029 ;; Quit and move point back.
2031 (ispell-pdict-save ispell-silently-savep
)
2032 (message "Exited spell-checking")
2033 (setq ispell-quit t
)
2035 ;; Quit and preserve point.
2037 (ispell-pdict-save ispell-silently-savep
)
2039 (substitute-command-keys
2040 (concat "Spell-checking suspended;"
2041 " use C-u \\[ispell-word] to resume")))
2042 (setq ispell-quit start
)
2045 (if (y-or-n-p "Really kill Ispell process? ")
2047 (ispell-kill-ispell t
) ; terminate process.
2048 (setq ispell-quit
(or (not ispell-checking-message
)
2050 ispell-pdict-modified-p nil
))
2051 t
)) ; continue if they don't quit.
2053 (and (eq 'block ispell-highlight-p
) ; refresh tty displays
2054 (ispell-highlight-spelling-error start end nil t
))
2055 (let ((new-word (read-string
2056 "Lookup string (`*' is wildcard): "
2060 (with-current-buffer (get-buffer-create
2061 ispell-choices-buffer
)
2065 mode-line-format
;; setup the *Choices* buffer with valid data.
2066 (concat "-- %b -- word: " new-word
2068 (or ispell-complete-word-dict
2069 ispell-alternate-dictionary
))
2070 miss
(lookup-words new-word
)
2072 line ispell-choices-win-default-height
)
2073 (while (and choices
; adjust choices window.
2074 (< (if (> (+ 7 (current-column)
2075 (length (car choices
))
2076 (if (> count ?~
) 3 0))
2080 (setq line
(1+ line
)))
2083 (while (memq count command-characters
)
2084 (setq count
(ispell-int-char (1+ count
))
2085 skipped
(1+ skipped
)))
2086 (insert "(" count
") " (car choices
) " ")
2087 (setq choices
(cdr choices
)
2088 count
(ispell-int-char (1+ count
))))
2089 (setq count
(ispell-int-char
2090 (- count ?
0 skipped
))))
2091 (ispell-show-choices line end
)
2092 (select-window (next-window)))))
2093 (and (eq 'block ispell-highlight-p
)
2094 (ispell-highlight-spelling-error start end nil
2096 t
) ; reselect from new choices
2097 ((= char ?u
) ; insert lowercase into dictionary
2098 (ispell-send-string (concat "*" (downcase word
) "\n"))
2099 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2101 ((= char ?m
) ; type in what to insert
2103 (concat "*" (read-string "Insert: " word
) "\n"))
2104 (setq ispell-pdict-modified-p
'(t))
2106 ((and (>= num
0) (< num count
))
2107 (if ispell-query-replace-choices
; Query replace flag
2108 (list (nth num miss
) 'query-replace
)
2113 ;; This may have alignment errors if current line is edited
2114 (if (marker-position ispell-recursive-edit-marker
)
2116 (message "Only one recursive edit session supported")
2119 (set-marker ispell-recursive-edit-marker start
)
2120 ;;(set-marker ispell-region-end reg-end)
2121 (and ispell-highlight-p
; unhighlight
2122 (ispell-highlight-spelling-error start end
))
2127 (substitute-command-keys
2128 (concat "Exit recursive edit with"
2129 " \\[exit-recursive-edit]")))
2130 (save-window-excursion (save-excursion
2133 (goto-char ispell-recursive-edit-marker
)
2134 (if (not (equal (marker-buffer
2135 ispell-recursive-edit-marker
)
2138 (set-marker ispell-recursive-edit-marker nil
)
2140 "Cannot continue ispell from this buffer.")))
2141 (set-marker ispell-recursive-edit-marker nil
)))
2142 (list word nil
)) ; recheck starting at this word.
2144 (funcall (key-binding "\C-z"))
2149 (and ispell-highlight-p
; unhighlight
2150 (save-window-excursion
2151 (select-window textwin
)
2152 (ispell-highlight-spelling-error start end
)))
2154 (set-window-dedicated-p dedicated-win t
)))))
2158 (defun ispell-show-choices (line end
)
2159 "Show the choices in another buffer or frame."
2160 (if (and ispell-use-framepop-p
(fboundp 'framepop-display-buffer
))
2162 (framepop-display-buffer (get-buffer ispell-choices-buffer
))
2163 ;; (get-buffer-window ispell-choices-buffer t)
2164 (select-window (previous-window))) ; *Choices* window
2165 ;; standard selection by splitting a small buffer out of this window.
2166 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
2168 (if (= line
(ispell-adjusted-window-height choices-window
))
2169 (select-window choices-window
)
2170 ;; *Choices* window changed size. Adjust the choices window
2171 ;; without scrolling the spelled window when possible
2173 (- line
(ispell-adjusted-window-height choices-window
)))
2174 (visible (progn (vertical-motion -
1) (point))))
2175 (if (< line ispell-choices-win-default-height
)
2176 (setq window-line
(+ window-line
2177 (- ispell-choices-win-default-height
2179 (move-to-window-line 0)
2180 (vertical-motion window-line
)
2181 (set-window-start (selected-window)
2182 (if (> (point) visible
) visible
(point)))
2184 (select-window choices-window
)
2185 (enlarge-window window-line
)))
2186 ;; Overlay *Choices* window when it isn't showing
2187 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
2188 (switch-to-buffer ispell-choices-buffer
)
2189 (goto-char (point-min)))))
2193 (defun ispell-help ()
2194 "Display a list of the options available when a misspelling is encountered.
2198 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2199 SPC: Accept word this time.
2200 `i': Accept word and insert into private dictionary.
2201 `a': Accept word for this session.
2202 `A': Accept word and place in `buffer-local dictionary'.
2203 `r': Replace word with typed-in value. Rechecked.
2204 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2205 `?': Show these commands.
2206 `x': Exit spelling buffer. Move cursor to original point.
2207 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2208 the aborted check to be completed later.
2209 `q': Quit spelling session (Kills ispell process).
2210 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2211 `u': Like `i', but the word is lower-cased first.
2212 `m': Place typed-in value in personal dictionary, then recheck current word.
2213 `C-l': Redraw screen.
2214 `C-r': Recursive edit.
2215 `C-z': Suspend Emacs or iconify frame."
2217 (if (equal ispell-help-in-bufferp
'electric
)
2221 (function (lambda ()
2222 ;;This shouldn't be necessary: with-electric-help needs
2223 ;; an optional argument telling it about the smallest
2224 ;; acceptable window-height of the help buffer.
2225 ;;(if (< (window-height) 15)
2227 ;; (- 15 (ispell-adjusted-window-height))))
2228 (princ "Selections are:
2230 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2231 SPC: Accept word this time.
2232 `i': Accept word and insert into private dictionary.
2233 `a': Accept word for this session.
2234 `A': Accept word and place in `buffer-local dictionary'.
2235 `r': Replace word with typed-in value. Rechecked.
2236 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2237 `?': Show these commands.
2238 `x': Exit spelling buffer. Move cursor to original point.
2239 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2240 the aborted check to be completed later.
2241 `q': Quit spelling session (Kills ispell process).
2242 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2243 `u': Like `i', but the word is lower-cased first.
2244 `m': Place typed-in value in personal dictionary, then recheck current word.
2245 `C-l': Redraw screen.
2246 `C-r': Recursive edit.
2247 `C-z': Suspend Emacs or iconify frame.")
2251 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2252 "[i]nsert into private dictionary"))
2253 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2254 "e[x/X]it; [q]uit session"))
2255 (help-3 (concat "[u]ncapitalized insert into dict. "
2256 "Type 'x C-h f ispell-help' for more help")))
2257 (save-window-excursion
2258 (if ispell-help-in-bufferp
2260 (ispell-overlay-window 4)
2261 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2262 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2264 (kill-buffer "*Ispell Help*"))
2266 (let ((resize-mini-windows 'grow-only
))
2267 (select-window (minibuffer-window))
2270 ;;(set-minibuffer-window (selected-window))
2272 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2274 (erase-buffer)))))))
2277 (defun lookup-words (word &optional lookup-dict
)
2278 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2279 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2280 Otherwise the variable `ispell-grep-command' contains the command used to
2281 search for the words (usually egrep).
2283 Optional second argument contains the dictionary to use; the default is
2284 `ispell-alternate-dictionary', overriden by `ispell-complete-word-dict'
2286 ;; We don't use the filter for this function, rather the result is written
2287 ;; into a buffer. Hence there is no need to save the filter values.
2288 (if (null lookup-dict
)
2289 (setq lookup-dict
(or ispell-complete-word-dict
2290 ispell-alternate-dictionary
)))
2293 (unless (file-readable-p lookup-dict
)
2294 (error "lookup-words error: Unreadable or missing plain word-list %s."
2296 (error (concat "lookup-words error: No plain word-list found at system"
2297 "default locations. "
2298 "Customize `ispell-alternate-dictionary' to set yours.")))
2300 (let* ((process-connection-type ispell-use-ptys-p
)
2301 (wild-p (string-match "\\*" word
))
2302 (look-p (and ispell-look-p
; Only use look for an exact match.
2303 (or ispell-have-new-look
(not wild-p
))))
2304 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2305 (prog (if look-p ispell-look-command ispell-grep-command
))
2306 (args (if look-p ispell-look-options ispell-grep-options
))
2309 (save-window-excursion
2310 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
2311 (set-buffer ispell-grep-buffer
)
2315 (insert "^" word
"$")
2316 (while (search-backward "*" nil t
) (insert "."))
2317 (setq word
(buffer-string))
2319 (setq status
(apply 'ispell-call-process prog nil t nil
2320 (nconc (if (and args
(> (length args
) 0))
2325 (if lookup-dict
(list lookup-dict
)))))
2326 ;; grep returns status 1 and no output when word not found, which
2327 ;; is a perfectly normal thing.
2328 (if (stringp status
)
2329 (setq results
(cons (format "error: %s exited with signal %s"
2330 (file-name-nondirectory prog
) status
)
2332 ;; else collect words into `results' in FIFO order
2333 (goto-char (point-max))
2334 ;; assure we've ended with \n
2335 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
2339 (setq results
(cons (buffer-substring-no-properties (point)
2343 (kill-buffer ispell-grep-buffer
)
2344 (if (and results
(string-match ".+: " (car results
)))
2345 (error "%s error: %s" ispell-grep-command
(car results
))))
2349 ;; "ispell-filter" is a list of output lines from the generating function.
2350 ;; Each full line (ending with \n) is a separate item on the list.
2351 ;; "output" can contain multiple lines, part of a line, or both.
2352 ;; "start" and "end" are used to keep bounds on lines when "output" contains
2354 ;; "ispell-filter-continue" is true when we have received only part of a
2355 ;; line as output from a generating function ("output" did not end with \n)
2356 ;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2357 ;; This is the case when a process dies or fails. The default behavior
2358 ;; in this case treats the next input received as fresh input.
2360 (defun ispell-filter (process output
)
2361 "Output filter function for ispell, grep, and look."
2366 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
2367 ;; If we get out of sync and ispell-filter-continue is asserted when we
2368 ;; are not continuing, treat the next item as a separate list. When
2369 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2372 ;; Continue with same line (item)?
2373 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
2374 ;; Yes. Add it to the prev item
2375 (setcar ispell-filter
2376 (concat (car ispell-filter
) (substring output start end
)))
2377 ;; No. This is a new line and item.
2379 (cons (substring output start end
) ispell-filter
)))
2381 ;; We've completed reading the output, but didn't finish the line.
2382 (setq ispell-filter-continue t continue nil
)
2383 ;; skip over newline, this line complete.
2384 (setq ispell-filter-continue nil end
(1+ end
))
2385 (if (= end
(length output
)) ; No more lines in output
2386 (setq continue nil
) ; so we can exit the filter.
2387 (setq start end
)))))) ; else move start to next line of input
2390 ;;; This function destroys the mark location if it is in the word being
2392 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
2394 "Highlight the word from START to END with a kludge using `inverse-video'.
2395 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2396 otherwise it is displayed normally.
2397 Uses block cursor to highlight one character.
2398 Optional REFRESH will unhighlighted then highlight, using block cursor
2399 highlighting when REFRESH is equal to `block'."
2400 (and (eq 'block ispell-highlight-p
)
2401 (or (eq 'block refresh
)
2402 (setq start
(1+ start
)))) ; On block non-refresh, inc start.
2403 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2404 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
2405 (text (buffer-substring-no-properties start end
)) ; Save hilight region
2406 (inhibit-quit t
) ; inhibit interrupt processing here.
2407 (buffer-undo-list t
)) ; don't clutter the undo list.
2409 (delete-region start end
)
2410 (insert-char ?
(- end start
)) ; minimize amount of redisplay
2411 (sit-for 0) ; update display
2412 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
2413 (delete-region start end
) ; delete whitespace
2414 (insert text
) ; insert text in inverse video.
2415 (sit-for 0) ; update display showing inverse video.
2418 (setq inverse-video
(not inverse-video
)) ; toggle video
2419 (and (eq 'block ispell-highlight-p
)
2420 (goto-char (1- start
)))) ; use block cursor to "highlight" char
2421 (set-buffer-modified-p modified
) ; don't modify if flag not set.
2422 (and refresh
; re-highlight
2423 (ispell-highlight-spelling-error-generic
2424 (if (eq 'block refresh
) start
(- start
2)) end t
))))
2427 (defun ispell-highlight-spelling-error-xemacs (start end
&optional highlight
)
2428 "Highlight the word from START to END using `isearch-highlight'.
2429 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2430 otherwise it is displayed normally."
2432 (isearch-highlight start end
)
2433 (isearch-dehighlight))
2438 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
2439 "Highlight the word from START to END using overlays.
2440 When the optional third arg HIGHLIGHT is set, the word is highlighted
2441 otherwise it is displayed normally.
2443 The variable `ispell-highlight-face' selects the face to use for highlighting."
2446 (move-overlay ispell-overlay start end
(current-buffer))
2447 (setq ispell-overlay
(make-overlay start end
))
2448 (overlay-put ispell-overlay
'priority
1001) ;higher than lazy overlays
2449 (overlay-put ispell-overlay
'face ispell-highlight-face
))
2451 (delete-overlay ispell-overlay
)))
2452 (if (and ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
))
2454 (let ((isearch-string
2457 (regexp-quote (buffer-substring-no-properties start end
))
2460 (isearch-case-fold-search nil
))
2461 (isearch-lazy-highlight-new-loop
2462 (if (boundp 'reg-start
) reg-start
)
2463 (if (boundp 'reg-end
) reg-end
)))
2464 (lazy-highlight-cleanup lazy-highlight-cleanup
)
2465 (setq isearch-lazy-highlight-last-string nil
))))
2468 (defun ispell-highlight-spelling-error (start end
&optional highlight refresh
)
2471 (ispell-highlight-spelling-error-xemacs start end highlight
))
2472 ((and (featurep 'faces
)
2473 (or (and (fboundp 'display-color-p
) (display-color-p))
2475 (ispell-highlight-spelling-error-overlay start end highlight
))
2476 (t (ispell-highlight-spelling-error-generic start end highlight refresh
))))
2478 (defun ispell-adjusted-window-height (&optional window
)
2479 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2480 The value returned is actually the nominal number of text-lines in the
2481 window plus 1. On a terminal, this is the same value returned by
2482 `window-height', but if the window has a mode-line is taller than a normal
2483 text line, the returned value may be smaller than that from
2485 (cond ((fboundp 'window-text-height
)
2486 (1+ (window-text-height window
)))
2487 ((or (and (fboundp 'display-graphic-p
) (display-graphic-p))
2488 (and (featurep 'xemacs
) window-system
))
2489 (1- (window-height window
)))
2491 (window-height window
))))
2493 (defun ispell-overlay-window (height)
2494 "Create a window covering the top HEIGHT lines of the current window.
2495 Ensure that the line above point is still visible but otherwise avoid
2496 scrolling the current window. Leave the new window selected."
2498 (let ((oldot (save-excursion (vertical-motion -
1) (point)))
2499 (top (save-excursion (move-to-window-line height
) (point))))
2500 ;; If line above old point (line starting at oldot) would be
2501 ;; hidden by new window, scroll it to just below new win
2502 ;; otherwise set top line of other win so it doesn't scroll.
2503 (if (< oldot top
) (setq top oldot
))
2504 ;; if frame is unsplitable, temporarily disable that...
2505 (if (cdr (assq 'unsplittable
(frame-parameters (selected-frame))))
2506 (let ((frame (selected-frame)))
2507 (modify-frame-parameters frame
'((unsplittable . nil
)))
2508 (split-window nil height
)
2509 (modify-frame-parameters frame
'((unsplittable . t
))))
2510 (split-window nil height
))
2511 (let ((deficit (- height
(ispell-adjusted-window-height))))
2513 ;; Number of lines the window is still too short. We ensure that
2514 ;; there are at least (1- HEIGHT) lines visible in the window.
2515 (enlarge-window deficit
)
2517 (vertical-motion deficit
)
2518 (setq top
(min (point) oldot
))))
2519 (set-window-start (next-window) top
))))
2522 ;;; Should we add a compound word match return value?
2523 (defun ispell-parse-output (output &optional accept-list shift
)
2524 "Parse the OUTPUT string from Ispell process and return:
2525 1: t for an exact match.
2526 2: A string containing the root word matched via suffix removal.
2527 3: A list of possible correct spellings of the format:
2528 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2529 ORIGINAL-WORD is a string of the possibly misspelled word.
2530 OFFSET is an integer giving the line offset of the word.
2531 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2532 4: nil when an error has occurred.
2534 Optional second arg ACCEPT-LIST is list of words already accepted.
2535 Optional third arg SHIFT is an offset to apply based on previous corrections."
2537 ((string= output
"") t
) ; for startup with pipes...
2538 ((string= output
"*") t
) ; exact match
2539 ((string= output
"-") t
) ; compound word match
2540 ((eq (aref output
0) ?
+) ; found because of root word
2541 (substring output
2)) ; return root word
2542 ((equal 0 (string-match "[\ra-zA-Z]" output
))
2543 (ding) ; error message from ispell!
2544 (message "Ispell error: %s" output
)
2547 (t ; need to process &, ?, and #'s
2548 (let ((type (aref output
0)) ; &, ?, or #
2549 (original-word (substring output
2 (string-match " " output
2)))
2550 (cur-count 0) ; contains number of misses + guesses
2551 count miss-list guess-list offset
)
2552 (setq output
(substring output
(match-end 0))) ; skip over misspelling
2554 (setq count
0) ; no misses for type #
2555 (setq count
(string-to-number output
) ; get number of misses.
2556 output
(substring output
(1+ (string-match " " output
1)))))
2557 (setq offset
(string-to-number output
))
2558 (setq output
(if (eq type ?
#) ; No miss or guess list.
2560 (substring output
(1+ (string-match " " output
1)))))
2562 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
2563 (setq cur-count
(1+ cur-count
))
2564 (if (> cur-count count
)
2565 (push (substring output
0 end
) guess-list
)
2566 (push (substring output
0 end
) miss-list
))
2567 (setq output
(if (match-end 1) ; True only when at end of line.
2568 nil
; No more misses or guesses.
2569 (substring output
(+ end
2))))))
2570 ;; return results. Accept word if it was already accepted.
2572 (if (member original-word accept-list
)
2575 (if (numberp shift
) (+ shift offset
) offset
)
2576 (nreverse miss-list
) (nreverse guess-list
)))))))
2579 (defun ispell-process-status ()
2580 "Return the status of the Ispell process.
2581 When asynchronous processes are not supported, `run' is always returned."
2582 (if ispell-async-processp
2583 (process-status ispell-process
)
2584 (and ispell-process
'run
)))
2587 (defun ispell-start-process ()
2588 "Start the ispell process, with support for no asynchronous processes.
2589 Keeps argument list for future ispell invocations for no async support."
2590 ;; Local dictionary becomes the global dictionary in use.
2591 (setq ispell-current-dictionary
2592 (or ispell-local-dictionary ispell-dictionary
))
2593 (setq ispell-current-personal-dictionary
2594 (or ispell-local-pdict ispell-personal-dictionary
))
2595 (let* ((default-directory
2596 (if (and (file-directory-p default-directory
)
2597 (file-readable-p default-directory
))
2599 ;; Defend against bad `default-directory'.
2600 (expand-file-name "~/")))
2601 (orig-args (ispell-get-ispell-args))
2604 (if (and ispell-current-dictionary
; Not for default dict (nil)
2605 (not (member "-d" orig-args
))) ; Only define if not overridden.
2606 (list "-d" ispell-current-dictionary
))
2608 (if ispell-current-personal-dictionary
; Use specified pers dict.
2610 (expand-file-name ispell-current-personal-dictionary
)))
2611 ;; If we are using recent aspell or hunspell, make sure we use the
2612 ;; right encoding for communication. ispell or older aspell/hunspell
2613 ;; does not support this.
2614 (if ispell-encoding8-command
2616 (concat ispell-encoding8-command
2617 (symbol-name (ispell-get-coding-system)))))
2618 ispell-extra-args
)))
2620 ;; Initially we don't know any buffer's local words.
2621 (setq ispell-buffer-local-name nil
)
2623 (if ispell-async-processp
2624 (let ((process-connection-type ispell-use-ptys-p
))
2625 (apply 'start-process
2626 "ispell" nil ispell-program-name
2627 "-a" ; Accept single input lines.
2628 ;; Make root/affix combos not in dict.
2629 ;; hunspell -m option means different.
2630 (if ispell-really-hunspell
"" "-m")
2632 (setq ispell-cmd-args args
2633 ispell-output-buffer
(generate-new-buffer " *ispell-output*")
2634 ispell-session-buffer
(generate-new-buffer " *ispell-session*"))
2635 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2639 (defun ispell-init-process ()
2640 "Check status of Ispell process and start if necessary."
2641 (let* (;; Basename of dictionary used by the spell-checker
2642 (dict-bname (or (car (cdr (member "-d" (ispell-get-ispell-args))))
2643 ispell-current-dictionary
))
2644 ;; Use "~/" as default-directory unless using Ispell with per-dir
2645 ;; personal dictionaries and not in a minibuffer under XEmacs
2647 (if (or ispell-really-aspell
2648 ispell-really-hunspell
2649 ;; Protect against bad default-directory
2650 (not (and (file-directory-p default-directory
)
2651 (file-readable-p default-directory
)))
2652 ;; Ispell and per-dir personal dicts available
2653 (not (or (file-readable-p (concat default-directory
2655 (file-readable-p (concat default-directory
2659 ;; Ispell, in a minibuffer, and XEmacs
2660 (and (window-minibuffer-p)
2661 (not (fboundp 'minibuffer-selected-window
))))
2662 (expand-file-name "~/")
2663 (expand-file-name default-directory
))))
2664 ;; Check if process needs restart
2665 (if (and ispell-process
2666 (eq (ispell-process-status) 'run
)
2667 ;; Unless we are using an explicit personal dictionary, ensure
2668 ;; we're in the same default directory! Restart check for
2669 ;; personal dictionary is done in
2670 ;; `ispell-internal-change-dictionary', called from
2671 ;; `ispell-buffer-local-dict'
2672 (or (or ispell-local-pdict ispell-personal-dictionary
)
2673 (equal ispell-process-directory default-directory
)))
2674 (setq ispell-filter nil ispell-filter-continue nil
)
2675 ;; may need to restart to select new personal dictionary.
2676 (ispell-kill-ispell t
)
2677 (message "Starting new Ispell process [%s] ..."
2678 (or ispell-local-dictionary ispell-dictionary
"default"))
2680 (setq ispell-library-directory
(ispell-check-version)
2681 ispell-process
(ispell-start-process)
2683 ispell-filter-continue nil
2684 ispell-process-directory default-directory
)
2686 (unless (equal ispell-process-directory
(expand-file-name "~/"))
2687 ;; At this point, `ispell-process-directory' will be "~/" unless using
2688 ;; Ispell with directory-specific dicts and not in XEmacs minibuffer.
2689 ;; If not, kill ispell process when killing buffer. It may be in a
2690 ;; removable device that would otherwise become un-mountable.
2691 (with-current-buffer
2692 (if (and (window-minibuffer-p) ;; In minibuffer
2693 (fboundp 'minibuffer-selected-window
)) ;; Not XEmacs.
2694 ;; In this case kill ispell only when parent buffer is killed
2695 ;; to avoid over and over ispell kill.
2696 (window-buffer (minibuffer-selected-window))
2698 ;; 'local does not automatically make hook buffer-local in XEmacs.
2699 (if (featurep 'xemacs
)
2700 (make-local-hook 'kill-buffer-hook
))
2701 (add-hook 'kill-buffer-hook
2702 (lambda () (ispell-kill-ispell t
)) nil
'local
)))
2704 (if ispell-async-processp
2705 (set-process-filter ispell-process
'ispell-filter
))
2706 ;; Protect against XEmacs bogus binding of `enable-multibyte-characters'.
2707 (if (and (or (featurep 'xemacs
)
2708 (and (boundp 'enable-multibyte-characters
)
2709 enable-multibyte-characters
))
2710 (fboundp 'set-process-coding-system
))
2711 (set-process-coding-system ispell-process
(ispell-get-coding-system)
2712 (ispell-get-coding-system)))
2713 ;; Get version ID line
2714 (ispell-accept-output 3)
2715 ;; get more output if filter empty?
2716 (if (null ispell-filter
) (ispell-accept-output 3))
2717 (cond ((null ispell-filter
)
2718 (error "%s did not output version line" ispell-program-name
))
2720 (stringp (car ispell-filter
))
2721 (if (string-match "warning: " (car ispell-filter
))
2723 (ispell-accept-output 3) ; was warn msg.
2724 (stringp (car ispell-filter
)))
2725 (null (cdr ispell-filter
)))
2726 (string-match "^@(#) " (car ispell-filter
)))
2727 ;; got the version line as expected (we already know it's the right
2728 ;; version, so don't bother checking again.)
2731 ;; Otherwise, it must be an error message. Show the user.
2732 ;; But first wait to see if some more output is going to arrive.
2733 ;; Otherwise we get cool errors like "Can't open ".
2735 (ispell-accept-output 3)
2736 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
2737 (setq ispell-filter nil
) ; Discard version ID line
2738 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2739 (if extended-char-mode
; ~ extended character mode
2740 (ispell-send-string (concat extended-char-mode
"\n"))))
2741 (if ispell-async-processp
2742 (if (featurep 'emacs
)
2743 (set-process-query-on-exit-flag ispell-process nil
)
2744 (if (fboundp 'set-process-query-on-exit-flag
)
2745 (set-process-query-on-exit-flag ispell-process nil
)
2746 (process-kill-without-query ispell-process
)))))))
2749 (defun ispell-kill-ispell (&optional no-error
)
2750 "Kill current Ispell process (so that you may start a fresh one).
2751 With NO-ERROR, just return non-nil if there was no Ispell running."
2753 ;; This hook is typically used by flyspell to flush some variables used
2754 ;; to optimize the common cases.
2755 (run-hooks 'ispell-kill-ispell-hook
)
2756 (if (not (and ispell-process
2757 (eq (ispell-process-status) 'run
)))
2759 (error "There is no ispell process running!"))
2760 (if ispell-async-processp
2761 (delete-process ispell-process
)
2762 ;; synchronous processes
2763 (ispell-send-string "\n") ; make sure side effects occurred.
2764 (kill-buffer ispell-output-buffer
)
2765 (kill-buffer ispell-session-buffer
)
2766 (setq ispell-output-buffer nil
2767 ispell-session-buffer nil
))
2768 (setq ispell-process nil
)
2769 (message "Ispell process killed")
2772 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2773 ;;; call ispell-init-process rather than wait for a spell checking command?
2776 (defun ispell-change-dictionary (dict &optional arg
)
2777 "Change to dictionary DICT for Ispell.
2778 With a prefix arg, set it \"globally\", for all buffers.
2779 Without a prefix arg, set it \"locally\", just for this buffer.
2781 By just answering RET you can find out what the current dictionary is."
2783 (list (completing-read
2784 "Use new dictionary (RET for current, SPC to complete): "
2785 (and (fboundp 'ispell-valid-dictionary-list
)
2786 (mapcar 'list
(ispell-valid-dictionary-list)))
2788 current-prefix-arg
))
2789 (ispell-set-spellchecker-params) ; Initilize variables and dicts alists
2790 (unless arg
(ispell-buffer-local-dict 'no-reload
))
2791 (if (equal dict
"default") (setq dict nil
))
2792 ;; This relies on completing-read's bug of returning "" for no match
2793 (cond ((equal dict
"")
2794 (ispell-internal-change-dictionary)
2795 (message "Using %s dictionary"
2796 (or (and (not arg
) ispell-local-dictionary
)
2797 ispell-dictionary
"default")))
2798 ((equal dict
(or (and (not arg
) ispell-local-dictionary
)
2799 ispell-dictionary
"default"))
2800 ;; Specified dictionary is the default already. Could reload
2801 ;; the dictionaries if needed.
2802 (ispell-internal-change-dictionary)
2803 (and (interactive-p)
2804 (message "No change, using %s dictionary" dict
)))
2805 (t ; reset dictionary!
2806 (if (or (assoc dict ispell-local-dictionary-alist
)
2807 (assoc dict ispell-dictionary-alist
))
2809 ;; set default dictionary
2810 (setq ispell-dictionary dict
)
2811 ;; set local dictionary
2812 (setq ispell-local-dictionary dict
)
2813 (setq ispell-local-dictionary-overridden t
))
2814 (error "Undefined dictionary: %s" dict
))
2815 (ispell-internal-change-dictionary)
2816 (message "%s Ispell dictionary set to %s"
2817 (if arg
"Global" "Local")
2820 (defun ispell-internal-change-dictionary ()
2821 "Update the dictionary and the personal dictionary used by Ispell.
2822 This may kill the Ispell process; if so,
2823 a new one will be started when needed."
2824 (let ((dict (or ispell-local-dictionary ispell-dictionary
))
2825 (pdict (or ispell-local-pdict ispell-personal-dictionary
)))
2826 (unless (and (equal ispell-current-dictionary dict
)
2827 (equal ispell-current-personal-dictionary pdict
))
2828 (ispell-kill-ispell t
)
2829 (setq ispell-current-dictionary dict
2830 ispell-current-personal-dictionary pdict
))))
2832 ;; Avoid error messages when compiling for these dynamic variables.
2833 (defvar ispell-start
)
2836 ;; Spelling of comments are checked when ispell-check-comments is non-nil.
2839 (defun ispell-region (reg-start reg-end
&optional recheckp shift
)
2840 "Interactively check a region for spelling errors.
2841 Return nil if spell session is quit,
2842 otherwise returns shift offset amount for last line processed."
2843 (interactive "r") ; Don't flag errors on read-only bufs.
2844 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
2846 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2847 (let ((skip-region-start (make-marker))
2848 (rstart (make-marker)))
2851 (message "Spell-checking %s using %s with %s dictionary..."
2852 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
2853 (buffer-name) "region")
2854 (file-name-nondirectory ispell-program-name
)
2855 (or ispell-current-dictionary
"default"))
2856 ;; Returns cursor to original location.
2857 (save-window-excursion
2858 (goto-char reg-start
)
2859 (let ((transient-mark-mode)
2860 (case-fold-search case-fold-search
)
2863 (let (message-log-max)
2864 (message "searching for regions to skip"))
2865 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t
)
2867 (setq key
(match-string-no-properties 0))
2868 (set-marker skip-region-start
(- (point) (length key
)))
2869 (goto-char reg-start
)))
2870 (let (message-log-max)
2872 "Continuing spelling check using %s with %s dictionary..."
2873 (file-name-nondirectory ispell-program-name
)
2874 (or ispell-current-dictionary
"default")))
2875 (set-marker rstart reg-start
)
2876 (set-marker ispell-region-end reg-end
)
2877 (while (and (not ispell-quit
)
2878 (< (point) ispell-region-end
))
2879 ;; spell-check region with skipping
2880 (if (and (marker-position skip-region-start
)
2881 (<= skip-region-start
(point)))
2883 ;; If region inside line comment, must keep comment start.
2884 (setq in-comment
(point)
2887 (or (null comment-end
) (string= "" comment-end
))
2890 (re-search-forward comment-start in-comment t
))
2892 ;; Can change skip-regexps (in ispell-message)
2893 (ispell-skip-region key
) ; moves pt past region.
2894 (set-marker rstart
(point))
2895 ;; check for saving large attachments...
2896 (setq query-fcc
(and query-fcc
2897 (ispell-ignore-fcc skip-region-start
2899 (if (and (< rstart ispell-region-end
)
2901 (ispell-begin-skip-region-regexp)
2902 ispell-region-end t
))
2904 (setq key
(match-string-no-properties 0))
2905 (set-marker skip-region-start
2906 (- (point) (length key
)))
2908 (set-marker skip-region-start nil
))))
2909 (setq reg-end
(max (point)
2910 (if (marker-position skip-region-start
)
2911 (min skip-region-start ispell-region-end
)
2912 (marker-position ispell-region-end
))))
2913 (let* ((ispell-start (point))
2914 (ispell-end (min (point-at-eol) reg-end
))
2915 (string (ispell-get-line
2916 ispell-start ispell-end in-comment
)))
2917 (if in-comment
; account for comment chars added
2918 (setq ispell-start
(- ispell-start
(length in-comment
))
2920 (setq ispell-end
(point)) ; "end" tracks region retrieved.
2921 (if string
; there is something to spell check!
2922 ;; (special start end)
2923 (setq shift
(ispell-process-line string
2924 (and recheckp shift
))))
2925 (goto-char ispell-end
)))))
2930 (if (and (not (and recheckp ispell-keep-choices-win
))
2931 (get-buffer ispell-choices-buffer
))
2932 (kill-buffer ispell-choices-buffer
))
2933 (set-marker skip-region-start nil
)
2934 (set-marker rstart nil
)
2937 ;; preserve or clear the region for ispell-continue.
2938 (if (not (numberp ispell-quit
))
2939 (set-marker ispell-region-end nil
)
2940 ;; Ispell-continue enabled - ispell-region-end is set.
2941 (goto-char ispell-quit
))
2942 ;; Check for aborting
2943 (if (and ispell-checking-message
(numberp ispell-quit
))
2945 (setq ispell-quit nil
)
2946 (error "Message send aborted")))
2947 (if (not recheckp
) (setq ispell-quit nil
)))
2948 (if (not recheckp
) (set-marker ispell-region-end nil
))
2949 ;; Only save if successful exit.
2950 (ispell-pdict-save ispell-silently-savep
)
2951 (message "Spell-checking %s using %s with %s dictionary...done"
2952 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
2953 (buffer-name) "region")
2954 (file-name-nondirectory ispell-program-name
)
2955 (or ispell-current-dictionary
"default"))))))
2958 (defun ispell-begin-skip-region-regexp ()
2959 "Return a regexp of the search keys for region skipping.
2960 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2961 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2967 (if (and ispell-checking-message
2968 (not (eq t ispell-checking-message
)))
2969 (mapconcat #'car ispell-checking-message
"\\|"))
2971 (if (eq ispell-parser
'tex
)
2972 (ispell-begin-tex-skip-regexp))
2974 (if ispell-skip-html
2975 (ispell-begin-skip-region ispell-html-skip-alists
))
2977 (if ispell-skip-tib ispell-tib-ref-beginning
)
2979 (if (and (eq 'exclusive ispell-check-comments
) comment-start
)
2980 ;; search from end of current comment to start of next comment.
2981 (if (string= "" comment-end
) "^" (regexp-quote comment-end
)))
2982 (if (and (null ispell-check-comments
) comment-start
)
2983 (regexp-quote comment-start
))
2984 (ispell-begin-skip-region ispell-skip-region-alist
)))
2988 (defun ispell-begin-skip-region (skip-alist)
2989 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2990 Each selection should be a key of SKIP-ALIST;
2991 otherwise, the current line is skipped."
2992 (mapconcat (lambda (lst) (if (stringp (car lst
)) (car lst
) (eval (car lst
))))
2997 (defun ispell-begin-tex-skip-regexp ()
2998 "Regular expression of tex commands to skip.
2999 Generated from `ispell-tex-skip-alists'."
3002 (mapconcat (function (lambda (lst) (car lst
)))
3003 (car ispell-tex-skip-alists
)
3006 ;; keys wrapped in begin{}
3007 (mapconcat (function (lambda (lst)
3008 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
3011 (car (cdr ispell-tex-skip-alists
))
3015 (defun ispell-skip-region-list ()
3016 "Return a list describing key and body regions to skip for this buffer.
3017 Includes regions defined by `ispell-skip-region-alist', tex mode,
3018 `ispell-html-skip-alists', and `ispell-checking-message'.
3019 Manual checking must include comments and tib references.
3020 The list is of the form described by variable `ispell-skip-region-alist'.
3021 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
3022 (let ((skip-alist ispell-skip-region-alist
))
3023 ;; only additional explicit region definition is tex.
3024 (if (eq ispell-parser
'tex
)
3025 (setq case-fold-search nil
3026 skip-alist
(append (car ispell-tex-skip-alists
)
3027 (car (cdr ispell-tex-skip-alists
))
3029 (if ispell-skip-html
3030 (setq skip-alist
(append ispell-html-skip-alists skip-alist
)))
3031 (if (and ispell-checking-message
3032 (not (eq t ispell-checking-message
)))
3033 (setq skip-alist
(append ispell-checking-message skip-alist
)))
3037 (defun ispell-tex-arg-end (&optional arg
)
3038 "Skip across ARG number of braces."
3041 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
3042 (forward-sexp (or arg
1)))
3044 (message "error skipping s-expressions at point %d." (point))
3049 (defun ispell-ignore-fcc (start end
)
3050 "Delete the Fcc: message header when large attachments are included.
3051 Return value `nil' if file with large attachments are saved.
3052 This can be used to avoid multiple questions for multiple large attachments.
3053 Returns point to starting location afterwards."
3055 (if (and ispell-checking-message ispell-message-fcc-skip
)
3056 (if (< ispell-message-fcc-skip
(- end start
))
3057 (let (case-fold-search head-end
)
3058 (goto-char (point-min))
3060 (or (re-search-forward
3061 (concat "^" (regexp-quote mail-header-separator
) "$")
3063 (re-search-forward "^$" nil t
)
3065 (goto-char (point-min))
3066 (if (re-search-forward "^Fcc:" head-end t
)
3068 "Save copy of this message with large attachments? ")
3076 (defun ispell-skip-region (key)
3077 "Skip across KEY and then to end of region.
3078 Key lookup determines region to skip.
3079 Point is placed at end of skipped region."
3080 ;; move over key to begin checking.
3081 (forward-char (length key
))
3082 (let ((start (point))
3083 ;; Regenerate each call... This function can change region definition.
3084 (alist (ispell-skip-region-list))
3085 alist-key null-skip
)
3087 ;; what about quoted comment, or comment inside strings?
3088 ((and (null ispell-check-comments
) comment-start
3089 (string= key comment-start
))
3090 (if (string= "" comment-end
)
3092 (search-forward comment-end ispell-region-end t
)))
3093 ((and (eq 'exclusive ispell-check-comments
) comment-start
3094 (string= key comment-end
))
3095 (search-forward comment-start ispell-region-end
:end
))
3096 ((and ispell-skip-tib
(string-match ispell-tib-ref-beginning key
))
3097 (re-search-forward ispell-tib-ref-end ispell-region-end t
))
3098 ;; markings from alist
3101 (setq alist-key
(eval (car (car alist
))))
3102 (if (string-match alist-key key
)
3104 (setq alist
(cdr (car alist
)))
3106 ((null alist
) (setq null-skip t
)) ; done! Just skip key.
3107 ((not (consp alist
))
3108 ;; Search past end of spell region to find this region end.
3109 (re-search-forward (eval alist
) (point-max) t
))
3110 ((and (= 1 (length alist
))
3111 (stringp (car alist
)))
3112 (re-search-forward (car alist
) (point-max) t
))
3114 (setq null-skip t
) ; error handling in functions!
3115 (if (consp (cdr alist
))
3116 (apply (car alist
) (cdr alist
))
3117 (funcall (car alist
)))))
3119 (setq alist
(cdr alist
))))))
3120 (if (and (= start
(point)) (null null-skip
))
3122 (message "Matching region end for `%s' point %d not found"
3128 (defun ispell-get-line (start end in-comment
)
3129 "Grab the next line of data.
3130 Returns a string with the line data."
3131 (let ((ispell-casechars (ispell-get-casechars))
3133 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
3134 ((eolp) ; END OF LINE, just go to next line.
3136 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
3137 ;; (forward-char 1)) ; not needed as quoted below.
3138 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
3139 (re-search-forward "[][()${}]" end t
)) ; or MATH COMMANDS
3140 (setq string
(concat "^" in-comment
3141 (buffer-substring-no-properties start end
)
3144 (t (goto-char end
))) ; EMPTY LINE, skip it.
3148 (defun ispell-looking-at (string)
3149 (let ((coding (ispell-get-coding-system))
3150 (len (length string
)))
3151 (and (<= (+ (point) len
) (point-max))
3152 (equal (encode-coding-string string coding
)
3153 (encode-coding-string (buffer-substring-no-properties
3154 (point) (+ (point) len
))
3157 (defun ispell-process-line (string shift
)
3158 "Send STRING, a line of text, to ispell and processes the result.
3159 This will modify the buffer for spelling errors.
3160 Requires variables ISPELL-START and ISPELL-END to be defined in its
3162 Returns the sum SHIFT due to changes in word replacements."
3163 ;;(declare special ispell-start ispell-end)
3164 (let (poss accept-list
)
3165 (if (not (numberp shift
))
3167 ;; send string to spell process and get input.
3168 (ispell-send-string string
)
3170 (ispell-accept-output)
3171 ;; Last item of output contains a blank line.
3172 (not (string= "" (car ispell-filter
)))))
3173 ;; parse all inputs from the stream one word at a time.
3174 ;; Place in FIFO order and remove the blank item.
3175 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
3176 (while (and (not ispell-quit
) ispell-filter
)
3177 ;; get next word, accounting for accepted words and start shifts
3178 (setq poss
(ispell-parse-output (car ispell-filter
)
3180 (if (and poss
(listp poss
)) ; spelling error occurred.
3181 ;; Whenever we have misspellings, we can change
3182 ;; the buffer. Keep boundaries as markers.
3183 ;; Markers can move with highlighting! This destroys
3184 ;; end of region markers line-end and ispell-region-end
3186 (copy-marker (+ ispell-start ispell-offset
(car (cdr poss
)))))
3187 (word-len (length (car poss
)))
3188 (line-end (copy-marker ispell-end
))
3189 (line-start (copy-marker ispell-start
))
3190 recheck-region replace
)
3191 (goto-char word-start
)
3192 ;; Adjust the horizontal scroll & point
3193 (ispell-horiz-scroll)
3194 (goto-char (+ word-len word-start
))
3195 (ispell-horiz-scroll)
3196 (goto-char word-start
)
3197 (ispell-horiz-scroll)
3199 ;; Alignment cannot be tracked and this error will occur when
3200 ;; `query-replace' makes multiple corrections on the starting line.
3201 (or (ispell-looking-at (car poss
))
3202 ;; This occurs due to filter pipe problems
3203 (error (concat "Ispell misalignment: word "
3204 "`%s' point %d; probably incompatible versions")
3205 (car poss
) (marker-position word-start
)))
3206 ;; ispell-cmd-loop can go recursive & change buffer
3207 (if ispell-keep-choices-win
3208 (setq replace
(ispell-command-loop
3209 (car (cdr (cdr poss
)))
3210 (car (cdr (cdr (cdr poss
))))
3211 (car poss
) (marker-position word-start
)
3212 (+ word-len
(marker-position word-start
))))
3213 (save-window-excursion
3214 (setq replace
(ispell-command-loop
3215 (car (cdr (cdr poss
)))
3216 (car (cdr (cdr (cdr poss
))))
3217 (car poss
) (marker-position word-start
)
3218 (+ word-len
(marker-position word-start
))))))
3220 (goto-char word-start
)
3221 ;; Recheck when query replace edit changes misspelled word.
3222 ;; Error in tex mode when a potential math mode change exists.
3223 (if (and replace
(listp replace
) (= 2 (length replace
)))
3224 (if (and (eq ispell-parser
'tex
)
3225 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3226 (regexp-quote string
)))
3228 "Don't start query replace on a line with math characters"
3230 (set-marker line-end
(point))
3231 (setq ispell-filter nil
3234 ;; insert correction if needed
3237 (equal 0 replace
)) ; ACCEPT/INSERT
3238 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
3239 (ispell-add-per-file-word-list (car poss
)))
3240 ;; do not recheck accepted word on this line
3241 (setq accept-list
(cons (car poss
) accept-list
)))
3242 (t ; replacement word selected or entered
3243 (delete-region (point) (+ word-len
(point)))
3244 (if (not (listp replace
))
3246 (ispell-insert-word replace
) ; insert dictionary word
3247 (ispell-send-replacement (car poss
) replace
)
3248 (setq accept-list
(cons replace accept-list
)))
3249 (let ((replace-word (car replace
)))
3250 ;; Recheck hand entered replacement word
3251 (insert replace-word
)
3252 (ispell-send-replacement (car poss
) replace-word
)
3253 (if (car (cdr replace
))
3254 (save-window-excursion
3255 (delete-other-windows) ; to correctly show help.
3256 ;; Assume case-replace &
3257 ;; case-fold-search correct?
3258 (query-replace (car poss
) (car replace
) t
)))
3259 (goto-char word-start
)
3260 ;; do not recheck if already accepted
3261 (if (member replace-word accept-list
)
3262 (setq accept-list
(cons replace-word accept-list
)
3263 replace replace-word
)
3264 (let ((region-end (copy-marker ispell-region-end
)))
3265 (setq recheck-region ispell-filter
3266 ispell-filter nil
; save filter
3267 shift
0 ; already accounted
3268 shift
(ispell-region
3270 (+ word-start
(length replace-word
))
3272 (if (null shift
) ; quitting check.
3274 (set-marker ispell-region-end region-end
)
3275 (set-marker region-end nil
)
3276 (setq ispell-filter recheck-region
3278 replace replace-word
)))))
3280 (setq shift
(+ shift
(- (length replace
) word-len
)))
3282 ;; Move line-start across word...
3283 ;; new shift function does this now...
3284 ;;(set-marker line-start (+ line-start
3285 ;; (- (length replace)
3286 ;; (length (car poss)))))
3288 (if (not ispell-quit
)
3289 ;; FIXME: remove redundancy with identical code above.
3290 (let (message-log-max)
3292 "Continuing spelling check using %s with %s dictionary..."
3293 (file-name-nondirectory ispell-program-name
)
3294 (or ispell-current-dictionary
"default"))))
3296 (setq ispell-start
(marker-position line-start
)
3297 ispell-end
(marker-position line-end
))
3298 ;; Adjust markers when end of region lost from highlighting.
3299 (if (and (not recheck-region
)
3300 (< ispell-end
(+ word-start word-len
)))
3301 (setq ispell-end
(+ word-start word-len
)))
3302 (if (= word-start ispell-region-end
)
3303 (set-marker ispell-region-end
(+ word-start word-len
)))
3304 ;; going out of scope - unneeded
3305 (set-marker line-start nil
)
3306 (set-marker word-start nil
)
3307 (set-marker line-end nil
)))
3308 ;; finished with misspelling!
3309 (setq ispell-filter
(cdr ispell-filter
)))
3314 (defun ispell-comments-and-strings ()
3315 "Check comments and strings in the current buffer for spelling errors."
3317 (goto-char (point-min))
3321 (setq state
(parse-partial-sexp (point) (point-max)
3322 nil nil state
'syntax-table
))
3323 (if (or (nth 3 state
) (nth 4 state
))
3324 (let ((start (point)))
3325 (setq state
(parse-partial-sexp start
(point-max)
3326 nil nil state
'syntax-table
))
3327 (if (or (nth 3 state
) (nth 4 state
))
3328 (error "Unterminated string or comment"))
3330 (setq done
(not (ispell-region start
(point))))))))))
3334 (defun ispell-buffer ()
3335 "Check the current buffer for spelling errors interactively."
3337 (ispell-region (point-min) (point-max)))
3341 (defun ispell-continue ()
3342 "Continue a halted spelling session beginning with the current word."
3344 (if (not (marker-position ispell-region-end
))
3345 (message "No session to continue. Use 'X' command when checking!")
3346 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
3347 (message "Must continue ispell from buffer %s"
3348 (buffer-name (marker-buffer ispell-region-end
)))
3350 ;; find beginning of current word:
3351 (car (cdr (ispell-get-word t
)))
3352 (marker-position ispell-region-end
)))))
3355 ;;; Horizontal scrolling
3356 (defun ispell-horiz-scroll ()
3357 "Place point within the horizontal visibility of its window area."
3358 (if truncate-lines
; display truncating lines?
3359 ;; See if display needs to be scrolled.
3360 (let ((column (- (current-column) (max (window-hscroll) 1))))
3361 (if (and (< column
0) (> (window-hscroll) 0))
3362 (scroll-right (max (- column
) 10))
3363 (if (>= column
(- (window-width) 2))
3364 (scroll-left (max (- column
(window-width) -
3) 10)))))))
3367 ;;; Interactive word completion.
3368 ;; Forces "previous-word" processing. Do we want to make this selectable?
3371 (defun ispell-complete-word (&optional interior-frag
)
3372 "Try to complete the word before or under point (see `lookup-words').
3373 If optional INTERIOR-FRAG is non-nil then the word may be a character
3374 sequence inside of a word.
3376 Standard ispell choices are then available."
3378 (let ((cursor-location (point))
3379 (case-fold-search-val case-fold-search
)
3380 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
3381 start end possibilities replacement
)
3382 (setq start
(car (cdr word
))
3383 end
(car (cdr (cdr word
)))
3386 (or (string= word
"") ; Will give you every word
3387 (lookup-words (concat (and interior-frag
"*") word
3388 (if (or interior-frag
(null ispell-look-p
))
3390 (or ispell-complete-word-dict
3391 ispell-alternate-dictionary
))))
3392 (cond ((eq possibilities t
)
3393 (message "No word to complete"))
3394 ((null possibilities
)
3395 (message "No match for \"%s\"" word
))
3396 (t ; There is a modification...
3397 (setq case-fold-search nil
) ; Try and respect case of word.
3399 ((string-equal (upcase word
) word
)
3400 (setq possibilities
(mapcar 'upcase possibilities
)))
3401 ((eq (upcase (aref word
0)) (aref word
0))
3402 (setq possibilities
(mapcar (function
3404 (if (eq (aref word
0) (aref pos
0))
3408 (setq case-fold-search case-fold-search-val
)
3409 (save-window-excursion
3411 (ispell-command-loop possibilities nil word start end
)))
3413 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
3414 (ispell-add-per-file-word-list word
))
3415 (replacement ; REPLACEMENT WORD
3416 (delete-region start end
)
3417 (setq word
(if (atom replacement
) replacement
(car replacement
))
3418 cursor-location
(+ (- (length word
) (- end start
))
3420 (ispell-insert-word word
)
3421 (if (not (atom replacement
)) ; recheck spelling of replacement.
3423 (goto-char cursor-location
)
3424 (ispell-word nil t
)))))
3425 (if (get-buffer ispell-choices-buffer
)
3426 (kill-buffer ispell-choices-buffer
))))
3427 (ispell-pdict-save ispell-silently-savep
)
3428 (goto-char cursor-location
)))
3432 (defun ispell-complete-word-interior-frag ()
3433 "Completes word matching character sequence inside a word."
3435 (ispell-complete-word t
))
3440 "Interactively check a region or buffer for spelling errors.
3441 If `transient-mark-mode' is on, and a region is active, spell-check
3442 that region. Otherwise spell-check the buffer.
3444 Ispell dictionaries are not distributed with Emacs. If you are
3445 looking for a dictionary, please see the distribution of the GNU ispell
3446 program, or do an Internet search; there are various dictionaries
3447 available on the net."
3449 (if (and (boundp 'transient-mark-mode
) transient-mark-mode
3450 (boundp 'mark-active
) mark-active
)
3451 (ispell-region (region-beginning) (region-end))
3455 ;;; **********************************************************************
3456 ;;; Ispell Minor Mode
3457 ;;; **********************************************************************
3459 (defvar ispell-minor-keymap
3460 (let ((map (make-sparse-keymap)))
3461 (define-key map
" " 'ispell-minor-check
)
3462 (define-key map
"\r" 'ispell-minor-check
)
3464 "Keymap used for Ispell minor mode.")
3467 (define-minor-mode ispell-minor-mode
3468 "Toggle Ispell minor mode.
3469 With prefix argument ARG, turn Ispell minor mode on if ARG is positive,
3470 otherwise turn it off.
3472 In Ispell minor mode, pressing SPC or RET
3473 warns you if the previous word is incorrectly spelled.
3475 All the buffer-local variables and dictionaries are ignored -- to read
3476 them into the running ispell process, type \\[ispell-word] SPC."
3477 nil
" Spell" ispell-minor-keymap
)
3479 (defun ispell-minor-check ()
3480 "Check previous word then continue with the normal binding of this key.
3481 Don't check previous word when character before point is a space or newline.
3482 Don't read buffer-local settings or word lists."
3484 (let ((ispell-minor-mode nil
)
3485 (ispell-check-only t
)
3486 (last-char (char-after (1- (point)))))
3487 (command-execute (key-binding (this-command-keys)))
3488 (if (not (or (eq last-char ?\
) (eq last-char ?
\n)
3489 (and ispell-skip-html
(eq last-char ?
>))
3490 (and ispell-skip-html
(eq last-char ?\
;))))
3491 (ispell-word nil t
))))
3494 ;;; **********************************************************************
3496 ;;; **********************************************************************
3498 (defvar ispell-message-text-end
3499 (mapconcat (function identity
)
3501 ;; Don't spell check signatures
3503 ;; Matches postscript files.
3504 ;;"^%!PS-Adobe-[123].0"
3505 ;; Matches uuencoded text
3506 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3507 ;; Matches shell files (especially auto-decoding)
3509 ;; Matches context difference listing
3510 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3511 ;; Matches unidiff difference listing
3512 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@"
3513 ;; Matches reporter.el bug report
3514 "^current state:\n==============\n"
3515 ;; Matches commonly used "cut" boundaries
3516 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3518 "*End of text which will be checked in `ispell-message'.
3519 If it is a string, limit at first occurrence of that regular expression.
3520 Otherwise, it must be a function which is called to get the limit.")
3521 (put 'ispell-message-text-end
'risky-local-variable t
)
3524 (defun ispell-mime-multipartp (&optional limit
)
3525 "Return multipart message start boundary or nil if none."
3526 ;; caller must ensure `case-fold-search' is set to `t'
3529 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3532 (if (looking-at "\"")
3535 (setq start
(point))
3536 (while (not (looking-at "\""))
3538 (setq boundary
(buffer-substring-no-properties start
(point))))
3539 (let ((start (point)))
3540 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3542 (setq boundary
(buffer-substring-no-properties start
(point)))))
3543 (if (< (length boundary
) 1)
3545 (concat "--" boundary
)))))
3548 (defun ispell-mime-skip-part (boundary)
3549 "Move point across header, or entire MIME part if message is encoded.
3550 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3551 encoded and therefore skipped. See rfc 1521, 2183, ...
3552 If no boundary is given, then entire message is skipped.
3554 This starts one line ABOVE the MIME content messages, on the boundary marker,
3555 for operation with the generic region-skipping code.
3556 This places new MIME boundaries into variable `ispell-checking-message'."
3557 (forward-line) ; skip over boundary to headers
3558 (let ((save-case-fold-search case-fold-search
)
3561 (setq case-fold-search t
3562 ispell-skip-html nil
)
3564 (setq continuep nil
)
3565 (if (looking-at "Content-Type: *text/")
3567 (goto-char (match-end 0))
3568 (if (looking-at "html")
3569 (setq ispell-skip-html t
))
3572 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3574 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3575 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3576 (setq textp
(member (upcase match
)
3577 ;; only spell check the following encodings:
3578 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3580 (goto-char (match-end 0))
3581 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3583 ;; hierarchical boundary definition
3584 (if (looking-at "Content-Type: *multipart/")
3585 (let ((new-boundary (ispell-mime-multipartp)))
3586 (if (string-match new-boundary boundary
)
3588 ;; first pass redefine skip function to include new boundary
3589 ;;(re-search-backward boundary nil t)
3591 (setq ispell-checking-message
3593 (list new-boundary
'ispell-mime-skip-part new-boundary
)
3594 (if (eq t ispell-checking-message
) nil
3595 ispell-checking-message
))
3598 ;; Skip all MIME headers that don't affect spelling
3599 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3602 (goto-char (match-end 0))
3605 (setq case-fold-search save-case-fold-search
)
3608 ;; encoded message. Skip to boundary, or entire message.
3610 (goto-char (point-max))
3611 (re-search-forward boundary nil t
)
3617 (defun ispell-message ()
3618 "Check the spelling of a mail message or news post.
3619 Don't check spelling of message headers except the Subject field.
3620 Don't check included messages.
3622 To abort spell checking of a message region and send the message anyway,
3623 use the `x' command. (Any subsequent regions will be checked.)
3624 The `X' command aborts the message send so that you can edit the buffer.
3626 To spell-check whenever a message is sent, include the appropriate lines
3627 in your .emacs file:
3628 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3629 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3630 (add-hook 'mail-send-hook 'ispell-message)
3631 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3633 You can bind this to the key C-c i in GNUS or mail by adding to
3634 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3635 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3638 (goto-char (point-min))
3639 (let* (boundary mimep
3640 (ispell-skip-region-alist-save ispell-skip-region-alist
)
3641 ;; Nil when message came from outside (eg calling Emacs as editor)
3642 ;; Non-nil marker of end of headers.
3645 (concat "^" (regexp-quote mail-header-separator
) "$") nil t
))
3646 (end-of-headers ; Start of body.
3648 (or internal-messagep
3649 (re-search-forward "^$" nil t
)
3651 (limit (copy-marker ; End of region we will spell check.
3653 ((not ispell-message-text-end
) (point-max))
3654 ((char-or-string-p ispell-message-text-end
)
3655 (if (re-search-forward ispell-message-text-end nil t
)
3658 (t (min (point-max) (funcall ispell-message-text-end
))))))
3659 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3660 (if (and (boundp 'mail-yank-prefix
) mail-yank-prefix
)
3661 (ispell-non-empty-string mail-yank-prefix
)
3663 (cite-regexp ;Prefix of quoted text
3665 ((functionp 'sc-cite-regexp
) ; sc 3.0
3667 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3668 (ispell-non-empty-string sc-reference-tag-string
))))
3669 ((boundp 'sc-cite-regexp
) ; sc 2.3
3670 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
3672 (ispell-non-empty-string sc-reference-tag-string
))))
3673 ((or (equal major-mode
'news-reply-mode
) ;GNUS 4 & below
3674 (equal major-mode
'message-mode
)) ;GNUS 5
3675 (concat "In article <" "\\|"
3676 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3677 (with-no-warnings message-cite-prefix-regexp
)
3680 ((equal major-mode
'mh-letter-mode
) ; mh mail message
3681 (concat "[^,;&+=\n]+ writes:" "\\|"
3683 (ispell-non-empty-string mh-ins-buf-prefix
))))
3684 ((not internal-messagep
) ; Assume nn sent us this message.
3685 (concat "In [a-zA-Z.]+ you write:" "\\|"
3686 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3688 ((boundp 'vm-included-text-prefix
) ; VM mail message
3689 (concat "[^,;&+=\n]+ writes:" "\\|"
3690 (ispell-non-empty-string vm-included-text-prefix
)))
3691 (t default-prefix
)))
3692 (ispell-skip-region-alist
3693 (cons (list (concat "^\\(" cite-regexp
"\\)")
3694 (function forward-line
))
3695 ispell-skip-region-alist
))
3696 (old-case-fold-search case-fold-search
)
3697 (dictionary-alist ispell-message-dictionary-alist
)
3698 (ispell-checking-message t
))
3700 ;; Select dictionary for message
3701 (or (local-variable-p 'ispell-local-dictionary
(current-buffer))
3702 (while dictionary-alist
3703 (goto-char (point-min))
3704 (if (re-search-forward (car (car dictionary-alist
))
3706 (setq ispell-local-dictionary
(cdr (car dictionary-alist
))
3707 dictionary-alist nil
)
3708 (setq dictionary-alist
(cdr dictionary-alist
)))))
3712 ;; Spell check any original Subject:
3713 (goto-char (point-min))
3714 (setq case-fold-search t
3715 mimep
(re-search-forward "MIME-Version:" end-of-headers t
))
3716 (goto-char (point-min))
3717 (if (re-search-forward "^Subject: *" end-of-headers t
)
3719 (goto-char (match-end 0))
3720 (if (and (not (looking-at ".*Re\\>"))
3721 (not (looking-at "\\[")))
3723 (setq case-fold-search old-case-fold-search
)
3724 (ispell-region (point)
3725 (progn ;Tab-initiated continuation lns.
3727 (while (looking-at "\n[ \t]")
3732 (goto-char (point-min))
3733 (setq boundary
(ispell-mime-multipartp end-of-headers
))))
3734 ;; Adjust message limit to MIME message if necessary.
3736 (re-search-forward (concat boundary
"--") nil t
)
3737 (re-search-backward boundary nil t
)
3738 (< (point) (marker-position limit
))
3739 (set-marker limit
(point)))
3740 (goto-char (point-min))
3741 ;; Select type or skip checking if this is a non-multipart message
3742 ;; Point moved to end of buffer if region is encoded.
3743 (when (and mimep
(not boundary
))
3744 (goto-char (point-min))
3745 (re-search-forward "Content-[^ \t]*:" end-of-headers t
)
3746 (forward-line -
1) ; following fn starts one line above
3747 (ispell-mime-skip-part nil
)
3748 ;; if message-text-end region, limit may be less than point.
3749 (if (> (point) limit
)
3750 (set-marker limit
(point))))
3751 (goto-char (max end-of-headers
(point)))
3753 (setq case-fold-search old-case-fold-search
)
3754 ;; Define MIME regions to skip.
3756 (setq ispell-checking-message
3757 (list (list boundary
'ispell-mime-skip-part boundary
))))
3758 (ispell-region (point) limit
))
3759 (set-marker end-of-headers nil
)
3760 (set-marker limit nil
)
3761 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3762 ispell-skip-html nil
3763 case-fold-search old-case-fold-search
)))))
3766 (defun ispell-non-empty-string (string)
3767 (if (or (not string
) (string-equal string
""))
3768 "\\'\\`" ; An unmatchable string if string is null.
3769 (regexp-quote string
)))
3772 ;;; **********************************************************************
3773 ;;; Buffer Local Functions
3774 ;;; **********************************************************************
3777 (defun ispell-accept-buffer-local-defs ()
3778 "Load all buffer-local information, restarting Ispell when necessary."
3779 (ispell-buffer-local-dict) ; May kill ispell-process.
3780 (ispell-buffer-local-words) ; Will initialize ispell-process.
3781 (ispell-buffer-local-parsing))
3784 (defun ispell-buffer-local-parsing ()
3785 "Place Ispell into parsing mode for this buffer.
3786 Overrides the default parsing mode.
3787 Includes Latex/Nroff modes and extended character mode."
3788 ;; (ispell-init-process) must already be called.
3789 (ispell-send-string "!\n") ; Put process in terse mode.
3790 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3791 ;; When exclusively checking comments, set to raw text mode (nroff).
3792 (if (and (not (eq 'exclusive ispell-check-comments
))
3793 (or (and (eq ispell-parser
'use-mode-name
)
3794 (string-match "[Tt][Ee][Xx]-mode"
3795 (symbol-name major-mode
)))
3796 (eq ispell-parser
'tex
)))
3798 (ispell-send-string "+\n") ; set ispell mode to tex
3799 (if (not (eq ispell-parser
'tex
))
3800 (set (make-local-variable 'ispell-parser
) 'tex
)))
3801 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3802 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3803 (if (and ispell-skip-html
(not (eq ispell-skip-html t
)))
3804 (setq ispell-skip-html
3805 (not (null (string-match "sgml\\|html\\|xml"
3806 (downcase (symbol-name major-mode
)))))))
3807 ;; Set default extended character mode for given buffer, if any.
3808 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3809 (if extended-char-mode
3810 (ispell-send-string (concat extended-char-mode
"\n"))))
3811 ;; Set buffer-local parsing mode and extended character mode, if specified.
3813 (goto-char (point-max))
3814 ;; Uses last occurrence of ispell-parsing-keyword
3815 (if (search-backward ispell-parsing-keyword nil t
)
3816 (let ((end (point-at-eol))
3818 (search-forward ispell-parsing-keyword
)
3819 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
3820 ;; space separated definitions.
3821 (setq string
(downcase (match-string-no-properties 1)))
3822 (cond ((and (string-match "latex-mode" string
)
3823 (not (eq 'exclusive ispell-check-comments
)))
3824 (ispell-send-string "+\n~tex\n"))
3825 ((string-match "nroff-mode" string
)
3826 (ispell-send-string "-\n~nroff\n"))
3827 ((string-match "~" string
) ; Set extended character mode.
3828 (ispell-send-string (concat string
"\n")))
3829 (t (message "Invalid Ispell Parsing argument!")
3833 ;; Can kill the current ispell process
3835 (defun ispell-buffer-local-dict (&optional no-reload
)
3836 "Initializes local dictionary and local personal dictionary.
3837 If optional NO-RELOAD is non-nil, do not make any dictionary reloading.
3838 When a dictionary is defined in the buffer (see variable
3839 `ispell-dictionary-keyword'), it will override the local setting
3840 from \\[ispell-change-dictionary].
3841 Both should not be used to define a buffer-local dictionary."
3843 (goto-char (point-min))
3845 ;; Override the local variable definition.
3846 ;; Uses last occurrence of ispell-dictionary-keyword.
3847 (goto-char (point-max))
3848 (unless ispell-local-dictionary-overridden
3849 (if (search-backward ispell-dictionary-keyword nil t
)
3851 (search-forward ispell-dictionary-keyword
)
3852 (setq end
(point-at-eol))
3853 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3854 (setq ispell-local-dictionary
3855 (match-string-no-properties 1))))))
3856 (goto-char (point-max))
3857 (if (search-backward ispell-pdict-keyword nil t
)
3859 (search-forward ispell-pdict-keyword
)
3860 (setq end
(point-at-eol))
3861 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3862 (setq ispell-local-pdict
3863 (match-string-no-properties 1)))))))
3865 ;; Reload if new dictionary (maybe the personal one) defined.
3866 (ispell-internal-change-dictionary)))
3869 (defun ispell-buffer-local-words ()
3870 "Load the buffer-local dictionary in the current buffer."
3871 ;; If there's an existing ispell process that's wrong for this use,
3873 (if (and ispell-buffer-local-name
3874 (not (equal ispell-buffer-local-name
(buffer-name))))
3875 (ispell-kill-ispell t
))
3876 ;; Actually start a new ispell process, because we need
3877 ;; to send commands now to specify the local words to it.
3878 (ispell-init-process)
3880 (goto-char (point-min))
3881 (while (search-forward ispell-words-keyword nil t
)
3882 (or ispell-buffer-local-name
3883 (setq ispell-buffer-local-name
(buffer-name)))
3884 (let ((end (point-at-eol))
3885 (ispell-casechars (ispell-get-casechars))
3887 ;; buffer-local words separated by a space, and can contain
3888 ;; any character other than a space. Not rigorous enough.
3889 (while (re-search-forward " *\\([^ ]+\\)" end t
)
3890 (setq string
(match-string-no-properties 1))
3891 ;; This can fail when string contains a word with invalid chars.
3892 ;; Error handling needs to be added between ispell and Emacs.
3893 (if (and (< 1 (length string
))
3894 (equal 0 (string-match ispell-casechars string
)))
3895 (ispell-send-string (concat "@" string
"\n"))))))))
3898 ;;; returns optionally adjusted region-end-point.
3900 ;; If comment-padright is defined, newcomment must be loaded.
3901 (declare-function comment-add
"newcomment" (arg))
3903 (defun ispell-add-per-file-word-list (word)
3904 "Add WORD to the per-file word list."
3905 (or ispell-buffer-local-name
3906 (setq ispell-buffer-local-name
(buffer-name)))
3908 (goto-char (point-min))
3909 (let (line-okay search done found
)
3911 (let ((case-fold-search nil
))
3912 (setq search
(search-forward ispell-words-keyword nil
'move
)
3913 found
(or found search
)
3914 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
3915 (progn (end-of-line) (current-column)))
3917 (if (or (and search line-okay
)
3924 (unless found
(newline))
3925 (insert (if (fboundp 'comment-padright
)
3926 ;; Try and use the proper comment marker,
3927 ;; e.g. ";;" rather than ";".
3928 (comment-padright comment-start
3931 " " ispell-words-keyword
)
3932 (if (> (length comment-end
) 0)
3935 (insert comment-end
)))))
3936 (insert (concat " " word
))))))))
3938 (add-to-list 'debug-ignored-errors
"^No word found to check!$")
3943 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3945 ;; Local Variable options:
3946 ;; mode: name(-mode)
3948 ;; local-variable: value
3950 ;; The following sets the buffer local dictionary to `american' English
3951 ;; and spell checks only comments.
3955 ;; comment-column: 40
3956 ;; ispell-check-comments: exclusive
3957 ;; ispell-local-dictionary: "american"
3961 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3963 ;; The following places this file in nroff parsing and extended char modes.
3964 ;; Local IspellParsing: nroff-mode ~nroff
3965 ;; Change IspellPersDict to IspellPersDict: to enable the following line.
3966 ;; Local IspellPersDict ~/.ispell_lisp
3967 ;; The following were automatically generated by ispell using the 'A' command:
3968 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3969 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3970 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3971 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3972 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3973 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3974 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3975 ; LocalWords: lns XEmacs HTML casechars Multibyte
3977 ;;; ispell.el ends here