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 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 ;; This returns nil if the data file does not exist.
987 ;; Can someone please explain the return value format when the
988 ;; file does exist -- rms?
989 (let* ((lang ;; Strip out variant, etc.
990 (and (string-match "^[[:alpha:]_]+" dict-name
)
991 (match-string 0 dict-name
)))
993 (concat (or ispell-aspell-data-dir
994 (setq ispell-aspell-data-dir
995 (ispell-get-aspell-config-value "data-dir")))
1000 (insert-file-contents data-file
)
1001 ;; There is zero or one line with special characters declarations.
1002 (when (search-forward-regexp "^special" nil t
)
1003 (let ((specials (split-string
1004 (buffer-substring (point)
1005 (progn (end-of-line) (point))))))
1006 ;; The line looks like: special ' -** - -** . -** : -*-
1007 ;; -** means that this character
1008 ;; - doesn't appear at word start
1009 ;; * may appear in the middle of a word
1010 ;; * may appear at word end
1011 ;; `otherchars' is about the middle case.
1013 (when (eq (aref (cadr specials
) 1) ?
*)
1014 (push (car specials
) otherchars
))
1015 (setq specials
(cddr specials
)))))
1019 (regexp-opt otherchars
)
1020 t
; We can't tell, so set this to t
1021 (list "-d" dict-name
)
1022 nil
; aspell doesn't support this
1023 ;; Here we specify the encoding to use while communicating with
1024 ;; aspell. This doesn't apply to command line arguments, so
1025 ;; just don't pass words to spellcheck as arguments...
1030 (defun ispell-aspell-add-aliases (alist)
1031 "Find aspell's dictionary aliases and add them to dictionary ALIST.
1032 Return the new dictionary alist."
1034 (file-expand-wildcards
1035 (concat (or ispell-aspell-dict-dir
1036 (setq ispell-aspell-dict-dir
1037 (ispell-get-aspell-config-value "dict-dir")))
1039 (dolist (alias-file aliases
)
1041 (insert-file-contents alias-file
)
1042 ;; Look for a line "add FOO.multi", extract FOO
1043 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t
)
1044 (let* ((aliasname (file-name-sans-extension
1045 (file-name-nondirectory alias-file
)))
1046 (already-exists-p (assoc aliasname alist
))
1047 (realname (match-string 1))
1048 (realdict (assoc realname alist
)))
1049 (when (and realdict
(not already-exists-p
))
1050 (push (cons aliasname
(cdr realdict
)) alist
))))))
1053 ;; Set params according to the selected spellchecker
1055 (defvar ispell-last-program-name nil
1056 "Last value of `ispell-program-name'. Internal use.")
1058 (defvar ispell-initialize-spellchecker-hook nil
1059 "Normal hook run on spellchecker initialization.
1060 This hook is run when a spellchecker is used for the first
1061 time, before `ispell-dictionary-alist' is set. It is intended for
1062 sysadmins to override entries in `ispell-dictionary-base-alist'
1063 by putting those overrides in `ispell-base-dicts-override-alist', which is
1064 a dynamically scoped var with same format as `ispell-dictionary-alist'.
1065 This alist will not override the auto-detected values (e.g. if a recent
1066 aspell is used along with Emacs).")
1068 (defun ispell-set-spellchecker-params ()
1069 "Initialize some spellchecker parameters when changed or first used."
1070 (unless (eq ispell-last-program-name ispell-program-name
)
1071 (setq ispell-last-program-name ispell-program-name
)
1072 (ispell-kill-ispell t
)
1073 (if (and (condition-case ()
1075 (setq ispell-library-directory
(ispell-check-version))
1078 ispell-really-aspell
1079 ispell-encoding8-command
1080 ;; XEmacs does not like [:alpha:] regexps.
1081 (string-match "^[[:alpha:]]+$" "abcde"))
1082 (unless ispell-aspell-dictionary-alist
1083 (ispell-find-aspell-dictionaries)))
1085 ;; Substitute ispell-dictionary-alist with the list of dictionaries
1086 ;; corresponding to the given spellchecker. If a recent aspell, use
1087 ;; the list of really installed dictionaries and add to it elements
1088 ;; of the original list that are not present there. Allow distro info.
1089 (let ((found-dicts-alist
1090 (if (and ispell-really-aspell
1091 ispell-encoding8-command
)
1092 ispell-aspell-dictionary-alist
1094 ispell-base-dicts-override-alist
; Override only base-dicts-alist
1097 (run-hooks 'ispell-initialize-spellchecker-hook
)
1099 ;; Add dicts to ``ispell-dictionary-alist'' unless already present.
1100 (dolist (dict (append found-dicts-alist
1101 ispell-base-dicts-override-alist
1102 ispell-dictionary-base-alist
))
1103 (unless (assoc (car dict
) all-dicts-alist
)
1104 (add-to-list 'all-dicts-alist dict
)))
1105 (setq ispell-dictionary-alist all-dicts-alist
))))
1108 (defun ispell-valid-dictionary-list ()
1109 "Returns a list of valid dictionaries.
1110 The variable `ispell-library-directory' defines the library location."
1111 ;; Initialize variables and dictionaries alists for desired spellchecker.
1112 ;; Make sure ispell.el is loaded to avoid some autoload loops in XEmacs
1113 ;; (and may be others)
1114 (if (featurep 'ispell
)
1115 (ispell-set-spellchecker-params))
1117 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist
))
1118 (dict-list (cons "default" nil
))
1120 (dolist (dict dicts
)
1121 (setq name
(car dict
)
1122 load-dict
(car (cdr (member "-d" (nth 5 dict
)))))
1123 ;; Include if the dictionary is in the library, or dir not defined.
1126 ;; include all dictionaries if lib directory not known.
1127 ;; For Aspell, we already know which dictionaries exist.
1128 (or ispell-really-aspell
1129 (not ispell-library-directory
)
1130 (file-exists-p (concat ispell-library-directory
1132 (file-exists-p (concat ispell-library-directory
"/" name
".has"))
1134 (or (file-exists-p (concat ispell-library-directory
1135 "/" load-dict
".hash"))
1136 (file-exists-p (concat ispell-library-directory
1137 "/" load-dict
".has"))))))
1138 (setq dict-list
(cons name dict-list
))))
1141 ;;; define commands in menu in opposite order you want them to appear.
1143 (if ispell-menu-map-needed
1145 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
1146 (define-key ispell-menu-map
[ispell-change-dictionary
]
1147 `(menu-item ,(purecopy "Change Dictionary...") ispell-change-dictionary
1148 :help
,(purecopy "Supply explicit dictionary file name")))
1149 (define-key ispell-menu-map
[ispell-kill-ispell
]
1150 `(menu-item ,(purecopy "Kill Process") ispell-kill-ispell
1151 :enable
(and (boundp 'ispell-process
) ispell-process
1152 (eq (ispell-process-status) 'run
))
1153 :help
,(purecopy "Terminate Ispell subprocess")))
1154 (define-key ispell-menu-map
[ispell-pdict-save
]
1155 `(menu-item ,(purecopy "Save Dictionary")
1156 (lambda () (interactive) (ispell-pdict-save t t
))
1157 :help
,(purecopy "Save personal dictionary")))
1158 (define-key ispell-menu-map
[ispell-customize
]
1159 `(menu-item ,(purecopy "Customize...")
1160 (lambda () (interactive) (customize-group 'ispell
))
1161 :help
,(purecopy "Customize spell checking options")))
1162 (define-key ispell-menu-map
[ispell-help
]
1163 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1164 `(menu-item ,(purecopy "Help")
1165 (lambda () (interactive) (describe-function 'ispell-help
))
1166 :help
,(purecopy "Show standard Ispell keybindings and commands")))
1167 (define-key ispell-menu-map
[flyspell-mode
]
1168 `(menu-item ,(purecopy "Automatic spell checking (Flyspell)")
1170 :help
,(purecopy "Check spelling while you edit the text")
1171 :button
(:toggle .
(bound-and-true-p flyspell-mode
))))
1172 (define-key ispell-menu-map
[ispell-complete-word
]
1173 `(menu-item ,(purecopy "Complete Word") ispell-complete-word
1174 :help
,(purecopy "Complete word at cursor using dictionary")))
1175 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
1176 `(menu-item ,(purecopy "Complete Word Fragment")
1177 ispell-complete-word-interior-frag
1178 :help
,(purecopy "Complete word fragment at cursor")))))
1181 (if ispell-menu-map-needed
1183 (define-key ispell-menu-map
[ispell-continue
]
1184 `(menu-item ,(purecopy "Continue Spell-Checking") ispell-continue
1185 :enable
(and (boundp 'ispell-region-end
)
1186 (marker-position ispell-region-end
)
1187 (equal (marker-buffer ispell-region-end
)
1189 :help
,(purecopy "Continue spell checking last region")))
1190 (define-key ispell-menu-map
[ispell-word
]
1191 `(menu-item ,(purecopy "Spell-Check Word") ispell-word
1192 :help
,(purecopy "Spell-check word at cursor")))
1193 (define-key ispell-menu-map
[ispell-comments-and-strings
]
1194 `(menu-item ,(purecopy "Spell-Check Comments")
1195 ispell-comments-and-strings
1196 :help
,(purecopy "Spell-check only comments and strings")))))
1199 (if ispell-menu-map-needed
1201 (define-key ispell-menu-map
[ispell-region
]
1202 `(menu-item ,(purecopy "Spell-Check Region") ispell-region
1204 :help
,(purecopy "Spell-check text in marked region")))
1205 (define-key ispell-menu-map
[ispell-message
]
1206 `(menu-item ,(purecopy "Spell-Check Message") ispell-message
1207 :visible
(eq major-mode
'mail-mode
)
1208 :help
,(purecopy "Skip headers and included message text")))
1209 (define-key ispell-menu-map
[ispell-buffer
]
1210 `(menu-item ,(purecopy "Spell-Check Buffer") ispell-buffer
1211 :help
,(purecopy "Check spelling of selected buffer")))
1212 ;;(put 'ispell-region 'menu-enable 'mark-active)
1213 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
1215 ;;; XEmacs versions 19 & 20
1216 (if (and (featurep 'xemacs
)
1218 ;;(null ispell-menu-xemacs)
1219 (not (and (boundp 'infodock-version
) infodock-version
)))
1220 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list
)
1221 (reverse (ispell-valid-dictionary-list))))
1222 (current-menubar (or current-menubar default-menubar
))
1224 '(["Help" (describe-function 'ispell-help
) t
]
1225 ;;["Help" (popup-menu ispell-help-list) t]
1226 ["Check Message" ispell-message t
]
1227 ["Check Buffer" ispell-buffer t
]
1228 ["Check Comments" ispell-comments-and-strings t
]
1229 ["Check Word" ispell-word t
]
1230 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
1231 ["Continue Check" ispell-continue t
]
1232 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
1233 ["Complete Word" ispell-complete-word t
]
1234 ["Kill Process" ispell-kill-ispell t
]
1235 ["Customize..." (customize-group 'ispell
) t
]
1236 ;; flyspell-mode may not be bound...
1237 ;;["flyspell" flyspell-mode
1238 ;; :style toggle :selected flyspell-mode ]
1240 ["Save Personal Dict"(ispell-pdict-save t t
) t
]
1241 ["Change Dictionary" ispell-change-dictionary t
])))
1243 (setq dicts
(cons "default" nil
)))
1244 (dolist (name dicts
)
1245 (setq menu
(append menu
1248 (concat "Select " (capitalize name
))
1249 (list 'ispell-change-dictionary name
)
1251 (setq ispell-menu-xemacs menu
)
1254 (if (car (find-menu-item current-menubar
'("Cmds")))
1257 (delete-menu-item '("Cmds" "Spell-Check"))
1258 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs
))
1260 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1261 (add-menu '("Edit") "Spell" ispell-menu-xemacs
))))))
1263 (defalias 'ispell-int-char
1264 ;; Allow incrementing characters as integers in XEmacs 20
1265 (if (and (featurep 'xemacs
)
1266 (fboundp 'int-char
))
1268 ;; Emacs and XEmacs 19 or earlier
1272 ;;; **********************************************************************
1275 ;;; This variable contains the current dictionary being used if the ispell
1276 ;;; process is running.
1277 (defvar ispell-current-dictionary nil
1278 "The name of the current dictionary, or nil for the default.
1279 This is passed to the ispell process using the `-d' switch and is
1280 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1282 (defvar ispell-current-personal-dictionary nil
1283 "The name of the current personal dictionary, or nil for the default.
1284 This is passed to the ispell process using the `-p' switch.")
1286 (defun ispell-decode-string (str)
1287 "Decodes multibyte character strings.
1288 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1289 ;; FIXME: enable-multibyte-characters is read-only, so bogus bindings are
1290 ;; really nasty (they signal an error in Emacs): Who does that? --Stef
1291 (if (and (or (featurep 'xemacs
)
1292 (and (boundp 'enable-multibyte-characters
)
1293 enable-multibyte-characters
))
1294 (fboundp 'decode-coding-string
)
1295 (ispell-get-coding-system))
1296 (decode-coding-string str
(ispell-get-coding-system))
1299 ;; Return a string decoded from Nth element of the current dictionary.
1300 (defun ispell-get-decoded-string (n)
1302 (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1303 (assoc ispell-current-dictionary ispell-dictionary-alist
)
1304 (error "No match for the current dictionary")))
1306 (when (and (> (length str
) 0)
1307 (not (multibyte-string-p str
)))
1308 (setq str
(ispell-decode-string str
))
1309 (or (multibyte-string-p str
)
1310 (setq str
(string-to-multibyte str
))))
1313 (defun ispell-get-casechars ()
1314 (ispell-get-decoded-string 1))
1315 (defun ispell-get-not-casechars ()
1316 (ispell-get-decoded-string 2))
1317 (defun ispell-get-otherchars ()
1318 (ispell-get-decoded-string 3))
1319 (defun ispell-get-many-otherchars-p ()
1320 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1321 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1322 (defun ispell-get-ispell-args ()
1323 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1324 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1325 (defun ispell-get-extended-character-mode ()
1326 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1327 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1328 (defun ispell-get-coding-system ()
1329 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1330 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1333 (defvar ispell-pdict-modified-p nil
1334 "Non-nil means personal dictionary has modifications to be saved.")
1336 ;;; If you want to save the dictionary when quitting, must do so explicitly.
1337 ;;; When non-nil, the spell session is terminated.
1338 ;;; When numeric, contains cursor location in buffer, and cursor remains there.
1339 (defvar ispell-quit nil
)
1341 (defvar ispell-process-directory nil
1342 "The directory where `ispell-process' was started.")
1344 (defvar ispell-filter nil
1345 "Output filter from piped calls to Ispell.")
1347 (defvar ispell-filter-continue nil
1348 "Control variable for Ispell filter function.")
1350 (defvar ispell-output-buffer nil
1351 "Buffer used for reading output of a synchronous Ispell subprocess.")
1353 (defvar ispell-session-buffer nil
1354 "Buffer used for passing input to a synchronous Ispell subprocess.")
1356 (defvar ispell-cmd-args nil
1357 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1359 (defvar ispell-query-replace-marker
(make-marker)
1360 "Marker for `query-replace' processing.")
1362 (defvar ispell-recursive-edit-marker
(make-marker)
1363 "Marker for return point from recursive edit.")
1365 (defvar ispell-checking-message nil
1366 "Non-nil when we're checking a mail message.
1367 Set to the MIME boundary locations when checking messages.")
1369 (defconst ispell-choices-buffer
"*Choices*")
1371 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
1373 ;;; *** Buffer Local Definitions ***
1375 (defconst ispell-words-keyword
"LocalWords: "
1376 "The keyword for local oddly-spelled words to accept.
1377 The keyword will be followed by any number of local word spellings.
1378 There can be multiple of these keywords in the file.")
1380 (defconst ispell-dictionary-keyword
"Local IspellDict: "
1381 "The keyword for a local dictionary to use.
1382 The keyword must be followed by a valid dictionary name, defined in
1383 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1384 When multiple occurrences exist, the last keyword
1385 definition is used.")
1387 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
1388 "The keyword for defining buffer local dictionaries.
1389 Keyword must be followed by the filename of a personal dictionary.
1390 The last occurring definition in the buffer will be used.")
1392 (defconst ispell-parsing-keyword
"Local IspellParsing: "
1393 "The keyword for overriding default Ispell parsing.
1394 The above keyword string should be followed by `latex-mode' or
1395 `nroff-mode' to put the current buffer into the desired parsing mode.
1397 Extended character mode can be changed for this buffer by placing
1398 a `~' followed by an extended-character mode -- such as `~.tex'.
1399 The last occurring definition in the buffer will be used.")
1402 (defvar ispell-skip-region-alist
1403 `((ispell-words-keyword forward-line
)
1404 (ispell-dictionary-keyword forward-line
)
1405 (ispell-pdict-keyword forward-line
)
1406 (ispell-parsing-keyword forward-line
)
1407 (,(purecopy "^---*BEGIN PGP [A-Z ]*--*")
1408 .
,(purecopy "^---*END PGP [A-Z ]*--*"))
1409 ;; assume multiline uuencoded file? "\nM.*$"?
1410 (,(purecopy "^begin [0-9][0-9][0-9] [^ \t]+$") .
,(purecopy "\nend\n"))
1411 (,(purecopy "^%!PS-Adobe-[123].0") .
,(purecopy "\n%%EOF\n"))
1412 (,(purecopy "^---* \\(Start of \\)?[Ff]orwarded [Mm]essage")
1413 .
,(purecopy "^---* End of [Ff]orwarded [Mm]essage"))
1414 ;; Matches e-mail addresses, file names, http addresses, etc. The
1415 ;; `-+' `_+' patterns are necessary for performance reasons when
1416 ;; `-' or `_' part of word syntax.
1417 (,(purecopy "\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)"))
1418 ;; above checks /.\w sequences
1419 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1420 ;; This is a pretty complex regexp. It can be simplified to the following:
1421 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1422 ;; but some valid text will be skipped, e.g. "his/her". This could be
1423 ;; fixed up (at the expense of a moderately more complex regexp)
1424 ;; by not allowing "/" to be the character which triggers the
1425 ;; identification of the computer name, e.g.:
1426 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1428 "Alist expressing beginning and end of regions not to spell check.
1429 The alist key must be a regular expression.
1430 Valid forms include:
1431 (KEY) - just skip the key.
1432 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1433 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1434 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1435 (put 'ispell-skip-region-alist
'risky-local-variable t
)
1439 (defvar ispell-tex-skip-alists
1441 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1442 ;; All the standard LaTeX keywords from L. Lamport's guide:
1443 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1444 ;; \label, \nocite, \rule (in ispell - rest included here)
1445 ("\\\\addcontentsline" ispell-tex-arg-end
2)
1446 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end
)
1447 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end
)
1448 ;;("\\\\author" ispell-tex-arg-end)
1449 ("\\\\bibliographystyle" ispell-tex-arg-end
)
1450 ("\\\\makebox" ispell-tex-arg-end
0)
1451 ("\\\\e?psfig" ispell-tex-arg-end
)
1452 ("\\\\document\\(class\\|style\\)" .
1453 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1454 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1455 ;; equation, minipage, picture, tabular, tabular* (ispell)
1456 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end
0)
1457 ("list" ispell-tex-arg-end
2)
1458 ("program" .
"\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1459 ("verbatim\\*?" .
"\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}"))))
1460 "*Lists of regions to be skipped in TeX mode.
1461 First list is used raw.
1462 Second list has key placed inside \\begin{}.
1464 Delete or add any regions you want to be automatically selected
1465 for skipping in latex mode.")
1466 (put 'ispell-tex-skip-alist
'risky-local-variable t
)
1470 (defconst ispell-html-skip-alists
1471 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1472 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1473 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1474 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1475 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1478 ("&[^ \t\n;]" "[; \t\n]"))
1479 "*Lists of start and end keys to skip in HTML buffers.
1480 Same format as `ispell-skip-region-alist'.
1481 Note - substrings of other matches must come last
1482 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1483 (put 'ispell-html-skip-alists
'risky-local-variable t
)
1485 (defvar ispell-local-pdict ispell-personal-dictionary
1486 "A buffer local variable containing the current personal dictionary.
1487 If non-nil, the value must be a string, which is a file name.
1489 If you specify a personal dictionary for the current buffer which is
1490 different from the current personal dictionary, the effect is similar
1491 to calling \\[ispell-change-dictionary]. This variable is automatically
1492 set when defined in the file with either `ispell-pdict-keyword' or the
1493 local variable syntax.")
1495 (make-variable-buffer-local 'ispell-local-pdict
)
1496 ;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
1498 (defvar ispell-buffer-local-name nil
1499 "Contains the buffer name if local word definitions were used.
1500 Ispell is then restarted because the local words could conflict.")
1502 (defvar ispell-parser
'use-mode-name
1503 "*Indicates whether ispell should parse the current buffer as TeX Code.
1504 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1505 Default parser is `nroff'.
1506 Currently the only other valid parser is `tex'.
1508 You can set this variable in hooks in your init file -- eg:
1510 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1512 (defvar ispell-region-end
(make-marker)
1513 "Marker that allows spelling continuations.")
1515 (defvar ispell-check-only nil
1516 "If non-nil, `ispell-word' does not try to correct the word.")
1519 ;;; **********************************************************************
1520 ;;; **********************************************************************
1524 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1527 (defun ispell-accept-output (&optional timeout-secs timeout-msecs
)
1528 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1529 If asynchronous subprocesses are not supported, call `ispell-filter' and
1530 pass it the output of the last ispell invocation."
1531 (if ispell-async-processp
1532 (accept-process-output ispell-process timeout-secs timeout-msecs
)
1533 (if (null ispell-process
)
1534 (error "No Ispell process to read output from!")
1535 (let ((buf ispell-output-buffer
)
1537 (if (not (bufferp buf
))
1538 (setq ispell-filter nil
)
1539 (with-current-buffer buf
1540 (setq ispell-output
(buffer-substring-no-properties
1541 (point-min) (point-max))))
1542 (ispell-filter t ispell-output
)
1543 (with-current-buffer buf
1544 (erase-buffer)))))))
1546 (defun ispell-send-replacement (misspelled replacement
)
1547 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1548 This allows it to improve the suggestion list based on actual misspellings."
1549 (and ispell-really-aspell
1550 (ispell-send-string (concat "$$ra " misspelled
"," replacement
"\n"))))
1553 (defun ispell-send-string (string)
1554 "Send the string STRING to the Ispell process."
1555 (if ispell-async-processp
1556 (process-send-string ispell-process string
)
1557 ;; Asynchronous subprocesses aren't supported on this losing system.
1558 ;; We keep all the directives passed to Ispell during the entire
1559 ;; session in a buffer, and pass them anew each time we invoke
1560 ;; Ispell to process another chunk of text. (Yes, I know this is a
1561 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1562 (let ((cmd (aref string
0))
1563 ;; The following commands are not passed to Ispell until
1564 ;; we have a *real* reason to invoke it.
1565 (cmds-to-defer '(?
* ?
@ ?~ ?
+ ?- ?
! ?%
))
1566 (session-buf ispell-session-buffer
)
1567 (output-buf ispell-output-buffer
)
1568 (ispell-args ispell-cmd-args
)
1569 (defdir ispell-process-directory
)
1571 (with-current-buffer session-buf
1572 (setq prev-pos
(point))
1573 (setq default-directory defdir
)
1575 (if (not (memq cmd cmds-to-defer
))
1576 (let (coding-system-for-read coding-system-for-write status
)
1577 (if (and (boundp 'enable-multibyte-characters
)
1578 enable-multibyte-characters
)
1579 (setq coding-system-for-read
(ispell-get-coding-system)
1580 coding-system-for-write
(ispell-get-coding-system)))
1581 (set-buffer output-buf
)
1583 (set-buffer session-buf
)
1585 (apply 'ispell-call-process-region
1586 (point-min) (point-max)
1587 ispell-program-name nil
1590 ;; hunspell -m option means something different
1591 (if ispell-really-hunspell
"" "-m")
1593 (set-buffer output-buf
)
1594 (goto-char (point-min))
1596 (if (not (looking-at "@(#) "))
1597 (error "Ispell error: %s"
1598 (buffer-substring-no-properties
1599 (point) (progn (end-of-line) (point)))))
1600 ;; If STRING is "^Z\n", we just started Ispell and need
1601 ;; to retain its version ID line in the output buffer.
1602 ;; Otherwise, remove the ID line, as it will confuse
1604 (or (string= string
"\032\n")
1607 (delete-region (point-min) (point))))
1608 ;; If STRING begins with ^ or any normal character, we need
1609 ;; to remove the last line from the session buffer, since it
1610 ;; was just spell-checked, and we don't want to check it again.
1611 ;; The same goes for the # command, since Ispell already saved
1612 ;; the personal dictionary.
1613 (set-buffer session-buf
)
1614 (delete-region prev-pos
(point))
1615 ;; Ispell run synchronously saves the personal dictionary
1616 ;; after each successful command. So we can remove any
1617 ;; lines in the session buffer that insert words into the
1619 (if (memq status
'(0 nil
))
1620 (let ((more-lines t
))
1621 (goto-char (point-min))
1623 (if (looking-at "^\\*")
1624 (let ((start (point)))
1626 (delete-region start
(point)))
1627 (setq more-lines
(= 0 (forward-line))))))))))))))
1630 ;; Insert WORD while possibly translating characters by
1631 ;; translation-table-for-input.
1632 (defun ispell-insert-word (word)
1633 (let ((pos (point)))
1635 ;; Avoid "obsolete" warnings for translation-table-for-input.
1637 (if (char-table-p translation-table-for-input
)
1638 (translate-region pos
(point) translation-table-for-input
)))))
1641 (defun ispell-word (&optional following quietly continue region
)
1642 "Check spelling of word under or before the cursor.
1643 If the word is not found in dictionary, display possible corrections
1644 in a window allowing you to choose one.
1646 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1647 is non-nil when called interactively, then the following word
1648 \(rather than preceding\) is checked when the cursor is not over a word.
1649 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1650 when called interactively, non-corrective messages are suppressed.
1652 With a prefix argument (or if CONTINUE is non-nil),
1653 resume interrupted spell-checking of a buffer or region.
1655 Interactively, in Transient Mark mode when the mark is active, call
1656 `ispell-region' to check the active region for spelling errors.
1658 Word syntax is controlled by the definition of the chosen dictionary,
1659 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1661 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1662 or \\[ispell-region] to update the Ispell process.
1665 nil word is correct or spelling is accepted.
1666 0 word is inserted into buffer-local definitions.
1667 \"word\" word corrected from word list.
1668 \(\"word\" arg\) word is hand entered.
1669 quit spell session exited."
1670 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t
))
1672 ((and region
(use-region-p))
1673 (ispell-region (region-beginning) (region-end)))
1674 (continue (ispell-continue))
1676 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1677 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1678 (let ((cursor-location (point)) ; retain cursor location
1679 (word (ispell-get-word following
))
1680 start end poss new-word replace
)
1681 ;; De-structure return word info list.
1682 (setq start
(car (cdr word
))
1683 end
(car (cdr (cdr word
)))
1686 ;; At this point it used to ignore 2-letter words.
1687 ;; But that is silly; if the user asks for it, we should do it. - rms.
1689 (message "Checking spelling of %s..."
1690 (funcall ispell-format-word-function word
)))
1691 (ispell-send-string "%\n") ; put in verbose mode
1692 (ispell-send-string (concat "^" word
"\n"))
1693 ;; wait until ispell has processed word
1695 (ispell-accept-output)
1696 (not (string= "" (car ispell-filter
)))))
1697 ;;(ispell-send-string "!\n") ;back to terse mode.
1698 (setq ispell-filter
(cdr ispell-filter
)) ; remove extra \n
1699 (if (and ispell-filter
(listp ispell-filter
))
1700 (if (> (length ispell-filter
) 1)
1701 (error "Ispell and its process have different character maps")
1702 (setq poss
(ispell-parse-output (car ispell-filter
)))))
1705 (message "%s is correct"
1706 (funcall ispell-format-word-function word
)))
1707 (and (featurep 'xemacs
)
1709 (and (fboundp 'delete-extent
)
1710 (delete-extent (extent-at start
)))))
1713 (message "%s is correct because of root %s"
1714 (funcall ispell-format-word-function word
)
1715 (funcall ispell-format-word-function poss
)))
1716 (and (featurep 'xemacs
)
1718 (and (fboundp 'delete-extent
)
1719 (delete-extent (extent-at start
)))))
1720 ((null poss
) (message "Error in ispell process"))
1721 (ispell-check-only ; called from ispell minor mode.
1722 (if (fboundp 'make-extent
)
1723 (if (fboundp 'set-extent-property
)
1724 (let ((ext (make-extent start end
)))
1725 (set-extent-property ext
'face ispell-highlight-face
)
1726 (set-extent-property ext
'priority
2000)))
1728 (message "%s is incorrect"
1729 (funcall ispell-format-word-function word
))))
1730 (t ; prompt for correct word.
1731 (save-window-excursion
1732 (setq replace
(ispell-command-loop
1733 (car (cdr (cdr poss
)))
1734 (car (cdr (cdr (cdr poss
))))
1735 (car poss
) start end
)))
1736 (cond ((equal 0 replace
)
1737 (ispell-add-per-file-word-list (car poss
)))
1739 (setq new-word
(if (atom replace
) replace
(car replace
))
1740 cursor-location
(+ (- (length word
) (- end start
))
1742 (if (not (equal new-word
(car poss
)))
1745 ;; Insert first and then delete,
1746 ;; to avoid collapsing markers before and after
1747 ;; into a single place.
1748 (ispell-insert-word new-word
)
1749 (delete-region (point) end
)
1750 ;; It is meaningless to preserve the cursor position
1751 ;; inside a word that has changed.
1752 (setq cursor-location
(point))
1753 (setq end
(point))))
1754 (if (not (atom replace
)) ;recheck spelling of replacement
1756 (if (car (cdr replace
)) ; query replace requested
1757 (save-window-excursion
1758 (query-replace word new-word t
)))
1760 ;; single word could be split into multiple words
1761 (setq ispell-quit
(not (ispell-region start end
)))
1763 ;; keep if rechecking word and we keep choices win.
1764 (if (get-buffer ispell-choices-buffer
)
1765 (kill-buffer ispell-choices-buffer
))))
1766 (ispell-pdict-save ispell-silently-savep
)
1767 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1768 (if ispell-quit
(setq ispell-quit nil replace
'quit
))
1769 (goto-char cursor-location
) ; return to original location
1773 (defun ispell-get-word (following &optional extra-otherchars
)
1774 "Return the word for spell-checking according to ispell syntax.
1775 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1776 is non-nil when called interactively, then the following word
1777 \(rather than preceding\) is checked when the cursor is not over a word.
1778 Optional second argument contains otherchars that can be included in word
1781 Word syntax is controlled by the definition of the chosen dictionary,
1782 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1783 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1784 (let* ((ispell-casechars (ispell-get-casechars))
1785 (ispell-not-casechars (ispell-get-not-casechars))
1786 (ispell-otherchars (ispell-get-otherchars))
1787 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1788 (word-regexp (concat ispell-casechars
1790 (if (not (string= "" ispell-otherchars
))
1791 (concat ispell-otherchars
"?"))
1792 (if extra-otherchars
1793 (concat extra-otherchars
"?"))
1796 (if (or ispell-many-otherchars-p
1802 (if (not (looking-at ispell-casechars
))
1804 (re-search-forward ispell-casechars
(point-max) t
)
1805 (re-search-backward ispell-casechars
(point-min) t
)))
1806 ;; move to front of word
1807 (re-search-backward ispell-not-casechars
(point-min) 'start
)
1808 (while (and (or (and (not (string= "" ispell-otherchars
))
1809 (looking-at ispell-otherchars
))
1810 (and extra-otherchars
(looking-at extra-otherchars
)))
1812 (or (not did-it-once
)
1813 ispell-many-otherchars-p
)
1814 (not (eq prevpt
(point))))
1815 (if (and extra-otherchars
(looking-at extra-otherchars
))
1818 (if (looking-at ispell-casechars
)
1819 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
1823 (if (looking-at ispell-casechars
)
1824 (re-search-backward ispell-not-casechars
(point-min) 'move
)
1825 (backward-char -
1))))
1826 ;; Now mark the word and save to string.
1827 (if (not (re-search-forward word-regexp
(point-max) t
))
1828 (if ispell-check-only
1829 ;; return dummy word when just flagging misspellings
1830 (list "" (point) (point))
1831 (error "No word found to check!"))
1832 (setq start
(copy-marker (match-beginning 0))
1834 word
(buffer-substring-no-properties start end
))
1835 (list word start end
))))
1838 ;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1839 ;;; tracks changes in the dictionary. The global may either be
1840 ;;; a value or a list, whose value is the state of whether the
1841 ;;; dictionary needs to be saved.
1844 (defun ispell-pdict-save (&optional no-query force-save
)
1845 "Check to see if the personal dictionary has been modified.
1846 If so, ask if it needs to be saved."
1847 (interactive (list ispell-silently-savep t
))
1848 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
1849 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
1850 (if (or ispell-pdict-modified-p force-save
)
1851 (if (or no-query
(y-or-n-p "Personal dictionary modified. Save? "))
1853 (ispell-send-string "#\n") ; save dictionary
1854 (message "Personal dictionary saved."))))
1855 ;; unassert variable, even if not saved to avoid questioning.
1856 (setq ispell-pdict-modified-p nil
))
1859 (defun ispell-command-loop (miss guess word start end
)
1860 "Display possible corrections from list MISS.
1861 GUESS lists possibly valid affix construction of WORD.
1862 Returns nil to keep word.
1863 Returns 0 to insert locally into buffer-local dictionary.
1864 Returns string for new chosen word.
1865 Returns list for new replacement word (will be rechecked).
1866 Query-replace when list length is 2.
1867 Automatic query-replace when second element is `query-replace'.
1868 Highlights the word, which is assumed to run from START to END.
1869 Global `ispell-pdict-modified-p' becomes a list where the only value
1870 indicates whether the dictionary has been modified when option `a'
1872 Global `ispell-quit' set to start location to continue spell session."
1874 (line ispell-choices-win-default-height
)
1875 ;; ensure 4 context lines.
1876 (max-lines (- (ispell-adjusted-window-height) 4))
1878 (window-min-height (min window-min-height
1879 ispell-choices-win-default-height
))
1880 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
1881 (dedicated (window-dedicated-p (selected-window)))
1883 char num result textwin dedicated-win
)
1885 ;; setup the *Choices* buffer with valid data.
1886 (with-current-buffer (get-buffer-create ispell-choices-buffer
)
1887 (setq mode-line-format
1889 "-- %b -- word: " word
1890 " -- dict: " (or ispell-current-dictionary
"default")
1891 " -- prog: " (file-name-nondirectory ispell-program-name
)))
1892 ;; XEmacs: no need for horizontal scrollbar in choices window
1894 (and (fboundp 'set-specifier
)
1895 (boundp 'horizontal-scrollbar-visible-p
)
1896 (set-specifier horizontal-scrollbar-visible-p nil
1897 (cons (current-buffer) nil
))))
1901 (insert "Affix rules generate and capitalize "
1902 "this word as shown below:\n\t")
1904 (if (> (+ 4 (current-column) (length (car guess
)))
1908 (setq line
(1+ line
))))
1909 (insert (car guess
) " ")
1910 (setq guess
(cdr guess
)))
1911 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.")
1912 (setq line
(+ line
(if choices
3 2)))))
1914 (< (if (> (+ 7 (current-column) (length (car choices
))
1915 (if (> count ?~
) 3 0))
1919 (setq line
(1+ line
)))
1922 ;; not so good if there are over 20 or 30 options, but then, if
1923 ;; there are that many you don't want to scan them all anyway...
1924 (while (memq count command-characters
) ; skip command characters.
1925 (setq count
(ispell-int-char (1+ count
))
1926 skipped
(1+ skipped
)))
1927 (insert "(" count
") " (car choices
) " ")
1928 (setq choices
(cdr choices
)
1929 count
(ispell-int-char (1+ count
))))
1930 (setq count
(ispell-int-char (- count ?
0 skipped
))))
1932 ;; ensure word is visible
1933 (if (not (pos-visible-in-window-p end
))
1936 ;; allow temporary split of dedicated windows...
1939 (setq dedicated-win
(selected-window))
1940 (set-window-dedicated-p dedicated-win nil
)))
1942 ;; Display choices for misspelled word.
1943 (ispell-show-choices line end
)
1944 (select-window (setq textwin
(next-window)))
1946 ;; highlight word, protecting current buffer status
1949 (and ispell-highlight-p
1950 (ispell-highlight-spelling-error start end t
))
1951 ;; Loop until a valid choice is made.
1959 (let (message-log-max)
1960 (message (concat "C-h or ? for more options; SPC to leave "
1961 "unchanged, Character to replace word")))
1962 (let ((inhibit-quit t
)
1964 (setq char nil skipped
0)
1965 ;; If the user types C-g, or generates some other
1966 ;; non-character event (such as a frame switch
1967 ;; event), stop ispell. As a special exception,
1968 ;; ignore mouse events occurring in the same frame.
1969 (while (and input-valid
(not (characterp char
)))
1970 (setq char
(read-key))
1972 (or (characterp char
)
1973 (and (mouse-event-p char
)
1974 (eq (selected-frame)
1976 (posn-window (event-start char
))))))))
1977 (when (or quit-flag
(not input-valid
) (= char ?\C-g
))
1978 (setq char ?X quit-flag nil
)))
1979 ;; Adjust num to array offset skipping command characters.
1980 (let ((com-chars command-characters
))
1982 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
1983 (setq skipped
(1+ skipped
)))
1984 (setq com-chars
(cdr com-chars
)))
1985 (setq num
(- char ?
0 skipped
)))
1988 ((= char ?
) nil
) ; accept word this time only
1989 ((= char ?i
) ; accept and insert word into pers dict
1990 (ispell-send-string (concat "*" word
"\n"))
1991 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
1993 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
1994 (ispell-send-string (concat "@" word
"\n"))
1995 (if (null ispell-pdict-modified-p
)
1996 (setq ispell-pdict-modified-p
1997 (list ispell-pdict-modified-p
)))
1998 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
1999 ((or (= char ?r
) (= char ?R
)) ; type in replacement
2000 (and (eq 'block ispell-highlight-p
) ; refresh tty's
2001 (ispell-highlight-spelling-error start end nil t
))
2003 (if (or (= char ?R
) ispell-query-replace-choices
)
2005 (format "Query-replacement for %s: "word
)
2008 (cons (read-string "Replacement for: " word
)
2010 (and (eq 'block ispell-highlight-p
)
2011 (ispell-highlight-spelling-error start end nil
2014 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
2015 (and (eq 'block ispell-highlight-p
)
2016 (ispell-highlight-spelling-error start end nil t
))
2018 (and (eq 'block ispell-highlight-p
)
2019 (ispell-highlight-spelling-error start end nil
2022 ;; Quit and move point back.
2024 (ispell-pdict-save ispell-silently-savep
)
2025 (message "Exited spell-checking")
2026 (setq ispell-quit t
)
2028 ;; Quit and preserve point.
2030 (ispell-pdict-save ispell-silently-savep
)
2032 (substitute-command-keys
2033 (concat "Spell-checking suspended;"
2034 " use C-u \\[ispell-word] to resume")))
2035 (setq ispell-quit start
)
2038 (if (y-or-n-p "Really kill Ispell process? ")
2040 (ispell-kill-ispell t
) ; terminate process.
2041 (setq ispell-quit
(or (not ispell-checking-message
)
2043 ispell-pdict-modified-p nil
))
2044 t
)) ; continue if they don't quit.
2046 (and (eq 'block ispell-highlight-p
) ; refresh tty displays
2047 (ispell-highlight-spelling-error start end nil t
))
2048 (let ((new-word (read-string
2049 "Lookup string (`*' is wildcard): "
2053 (with-current-buffer (get-buffer-create
2054 ispell-choices-buffer
)
2058 mode-line-format
;; setup the *Choices* buffer with valid data.
2059 (concat "-- %b -- word: " new-word
2061 (or ispell-complete-word-dict
2062 ispell-alternate-dictionary
))
2063 miss
(lookup-words new-word
)
2065 line ispell-choices-win-default-height
)
2066 (while (and choices
; adjust choices window.
2067 (< (if (> (+ 7 (current-column)
2068 (length (car choices
))
2069 (if (> count ?~
) 3 0))
2073 (setq line
(1+ line
)))
2076 (while (memq count command-characters
)
2077 (setq count
(ispell-int-char (1+ count
))
2078 skipped
(1+ skipped
)))
2079 (insert "(" count
") " (car choices
) " ")
2080 (setq choices
(cdr choices
)
2081 count
(ispell-int-char (1+ count
))))
2082 (setq count
(ispell-int-char
2083 (- count ?
0 skipped
))))
2084 (ispell-show-choices line end
)
2085 (select-window (next-window)))))
2086 (and (eq 'block ispell-highlight-p
)
2087 (ispell-highlight-spelling-error start end nil
2089 t
) ; reselect from new choices
2090 ((= char ?u
) ; insert lowercase into dictionary
2091 (ispell-send-string (concat "*" (downcase word
) "\n"))
2092 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2094 ((= char ?m
) ; type in what to insert
2096 (concat "*" (read-string "Insert: " word
) "\n"))
2097 (setq ispell-pdict-modified-p
'(t))
2099 ((and (>= num
0) (< num count
))
2100 (if ispell-query-replace-choices
; Query replace flag
2101 (list (nth num miss
) 'query-replace
)
2106 ;; This may have alignment errors if current line is edited
2107 (if (marker-position ispell-recursive-edit-marker
)
2109 (message "Only one recursive edit session supported")
2112 (set-marker ispell-recursive-edit-marker start
)
2113 ;;(set-marker ispell-region-end reg-end)
2114 (and ispell-highlight-p
; unhighlight
2115 (ispell-highlight-spelling-error start end
))
2120 (substitute-command-keys
2121 (concat "Exit recursive edit with"
2122 " \\[exit-recursive-edit]")))
2123 (save-window-excursion (save-excursion
2126 (goto-char ispell-recursive-edit-marker
)
2127 (if (not (equal (marker-buffer
2128 ispell-recursive-edit-marker
)
2131 (set-marker ispell-recursive-edit-marker nil
)
2133 "Cannot continue ispell from this buffer.")))
2134 (set-marker ispell-recursive-edit-marker nil
)))
2135 (list word nil
)) ; recheck starting at this word.
2137 (funcall (key-binding "\C-z"))
2142 (and ispell-highlight-p
; unhighlight
2143 (save-window-excursion
2144 (select-window textwin
)
2145 (ispell-highlight-spelling-error start end
)))
2147 (set-window-dedicated-p dedicated-win t
)))))
2151 (defun ispell-show-choices (line end
)
2152 "Show the choices in another buffer or frame."
2153 (if (and ispell-use-framepop-p
(fboundp 'framepop-display-buffer
))
2155 (framepop-display-buffer (get-buffer ispell-choices-buffer
))
2156 ;;; (get-buffer-window ispell-choices-buffer t)
2157 (select-window (previous-window))) ; *Choices* window
2158 ;; standard selection by splitting a small buffer out of this window.
2159 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
2161 (if (= line
(ispell-adjusted-window-height choices-window
))
2162 (select-window choices-window
)
2163 ;; *Choices* window changed size. Adjust the choices window
2164 ;; without scrolling the spelled window when possible
2166 (- line
(ispell-adjusted-window-height choices-window
)))
2167 (visible (progn (vertical-motion -
1) (point))))
2168 (if (< line ispell-choices-win-default-height
)
2169 (setq window-line
(+ window-line
2170 (- ispell-choices-win-default-height
2172 (move-to-window-line 0)
2173 (vertical-motion window-line
)
2174 (set-window-start (selected-window)
2175 (if (> (point) visible
) visible
(point)))
2177 (select-window choices-window
)
2178 (enlarge-window window-line
)))
2179 ;; Overlay *Choices* window when it isn't showing
2180 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
2181 (switch-to-buffer ispell-choices-buffer
)
2182 (goto-char (point-min)))))
2186 (defun ispell-help ()
2187 "Display a list of the options available when a misspelling is encountered.
2191 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2192 SPC: Accept word this time.
2193 `i': Accept word and insert into private dictionary.
2194 `a': Accept word for this session.
2195 `A': Accept word and place in `buffer-local dictionary'.
2196 `r': Replace word with typed-in value. Rechecked.
2197 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2198 `?': Show these commands.
2199 `x': Exit spelling buffer. Move cursor to original point.
2200 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2201 the aborted check to be completed later.
2202 `q': Quit spelling session (Kills ispell process).
2203 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2204 `u': Like `i', but the word is lower-cased first.
2205 `m': Place typed-in value in personal dictionary, then recheck current word.
2206 `C-l': Redraw screen.
2207 `C-r': Recursive edit.
2208 `C-z': Suspend Emacs or iconify frame."
2210 (if (equal ispell-help-in-bufferp
'electric
)
2214 (function (lambda ()
2215 ;;This shouldn't be necessary: with-electric-help needs
2216 ;; an optional argument telling it about the smallest
2217 ;; acceptable window-height of the help buffer.
2218 ;;(if (< (window-height) 15)
2220 ;; (- 15 (ispell-adjusted-window-height))))
2221 (princ "Selections are:
2223 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2224 SPC: Accept word this time.
2225 `i': Accept word and insert into private dictionary.
2226 `a': Accept word for this session.
2227 `A': Accept word and place in `buffer-local dictionary'.
2228 `r': Replace word with typed-in value. Rechecked.
2229 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2230 `?': Show these commands.
2231 `x': Exit spelling buffer. Move cursor to original point.
2232 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2233 the aborted check to be completed later.
2234 `q': Quit spelling session (Kills ispell process).
2235 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2236 `u': Like `i', but the word is lower-cased first.
2237 `m': Place typed-in value in personal dictionary, then recheck current word.
2238 `C-l': Redraw screen.
2239 `C-r': Recursive edit.
2240 `C-z': Suspend Emacs or iconify frame.")
2244 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2245 "[i]nsert into private dictionary"))
2246 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2247 "e[x/X]it; [q]uit session"))
2248 (help-3 (concat "[u]ncapitalized insert into dict. "
2249 "Type 'x C-h f ispell-help' for more help")))
2250 (save-window-excursion
2251 (if ispell-help-in-bufferp
2253 (ispell-overlay-window 4)
2254 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2255 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2257 (kill-buffer "*Ispell Help*"))
2259 (let ((resize-mini-windows 'grow-only
))
2260 (select-window (minibuffer-window))
2263 ;;(set-minibuffer-window (selected-window))
2265 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2267 (erase-buffer)))))))
2270 (defun lookup-words (word &optional lookup-dict
)
2271 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2272 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2273 Otherwise the variable `ispell-grep-command' contains the command used to
2274 search for the words (usually egrep).
2276 Optional second argument contains the dictionary to use; the default is
2277 `ispell-alternate-dictionary', overriden by `ispell-complete-word-dict'
2279 ;; We don't use the filter for this function, rather the result is written
2280 ;; into a buffer. Hence there is no need to save the filter values.
2281 (if (null lookup-dict
)
2282 (setq lookup-dict
(or ispell-complete-word-dict
2283 ispell-alternate-dictionary
)))
2286 (unless (file-readable-p lookup-dict
)
2287 (error "lookup-words error: Unreadable or missing plain word-list %s."
2289 (error (concat "lookup-words error: No plain word-list found at system"
2290 "default locations. "
2291 "Customize `ispell-alternate-dictionary' to set yours.")))
2293 (let* ((process-connection-type ispell-use-ptys-p
)
2294 (wild-p (string-match "\\*" word
))
2295 (look-p (and ispell-look-p
; Only use look for an exact match.
2296 (or ispell-have-new-look
(not wild-p
))))
2297 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2298 (prog (if look-p ispell-look-command ispell-grep-command
))
2299 (args (if look-p ispell-look-options ispell-grep-options
))
2302 (save-window-excursion
2303 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
2304 (set-buffer ispell-grep-buffer
)
2308 (insert "^" word
"$")
2309 (while (search-backward "*" nil t
) (insert "."))
2310 (setq word
(buffer-string))
2312 (setq status
(apply 'ispell-call-process prog nil t nil
2313 (nconc (if (and args
(> (length args
) 0))
2318 (if lookup-dict
(list lookup-dict
)))))
2319 ;; grep returns status 1 and no output when word not found, which
2320 ;; is a perfectly normal thing.
2321 (if (stringp status
)
2322 (setq results
(cons (format "error: %s exited with signal %s"
2323 (file-name-nondirectory prog
) status
)
2325 ;; else collect words into `results' in FIFO order
2326 (goto-char (point-max))
2327 ;; assure we've ended with \n
2328 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
2332 (setq results
(cons (buffer-substring-no-properties (point)
2336 (kill-buffer ispell-grep-buffer
)
2337 (if (and results
(string-match ".+: " (car results
)))
2338 (error "%s error: %s" ispell-grep-command
(car results
))))
2342 ;; "ispell-filter" is a list of output lines from the generating function.
2343 ;; Each full line (ending with \n) is a separate item on the list.
2344 ;; "output" can contain multiple lines, part of a line, or both.
2345 ;; "start" and "end" are used to keep bounds on lines when "output" contains
2347 ;; "ispell-filter-continue" is true when we have received only part of a
2348 ;; line as output from a generating function ("output" did not end with \n)
2349 ;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2350 ;; This is the case when a process dies or fails. The default behavior
2351 ;; in this case treats the next input received as fresh input.
2353 (defun ispell-filter (process output
)
2354 "Output filter function for ispell, grep, and look."
2359 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
2360 ;; If we get out of sync and ispell-filter-continue is asserted when we
2361 ;; are not continuing, treat the next item as a separate list. When
2362 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2365 ;; Continue with same line (item)?
2366 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
2367 ;; Yes. Add it to the prev item
2368 (setcar ispell-filter
2369 (concat (car ispell-filter
) (substring output start end
)))
2370 ;; No. This is a new line and item.
2372 (cons (substring output start end
) ispell-filter
)))
2374 ;; We've completed reading the output, but didn't finish the line.
2375 (setq ispell-filter-continue t continue nil
)
2376 ;; skip over newline, this line complete.
2377 (setq ispell-filter-continue nil end
(1+ end
))
2378 (if (= end
(length output
)) ; No more lines in output
2379 (setq continue nil
) ; so we can exit the filter.
2380 (setq start end
)))))) ; else move start to next line of input
2383 ;;; This function destroys the mark location if it is in the word being
2385 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
2387 "Highlight the word from START to END with a kludge using `inverse-video'.
2388 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2389 otherwise it is displayed normally.
2390 Uses block cursor to highlight one character.
2391 Optional REFRESH will unhighlighted then highlight, using block cursor
2392 highlighting when REFRESH is equal to `block'."
2393 (and (eq 'block ispell-highlight-p
)
2394 (or (eq 'block refresh
)
2395 (setq start
(1+ start
)))) ; On block non-refresh, inc start.
2396 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2397 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
2398 (text (buffer-substring-no-properties start end
)) ; Save hilight region
2399 (inhibit-quit t
) ; inhibit interrupt processing here.
2400 (buffer-undo-list t
)) ; don't clutter the undo list.
2402 (delete-region start end
)
2403 (insert-char ?
(- end start
)) ; minimize amount of redisplay
2404 (sit-for 0) ; update display
2405 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
2406 (delete-region start end
) ; delete whitespace
2407 (insert text
) ; insert text in inverse video.
2408 (sit-for 0) ; update display showing inverse video.
2411 (setq inverse-video
(not inverse-video
)) ; toggle video
2412 (and (eq 'block ispell-highlight-p
)
2413 (goto-char (1- start
)))) ; use block cursor to "highlight" char
2414 (set-buffer-modified-p modified
) ; don't modify if flag not set.
2415 (and refresh
; re-highlight
2416 (ispell-highlight-spelling-error-generic
2417 (if (eq 'block refresh
) start
(- start
2)) end t
))))
2420 (defun ispell-highlight-spelling-error-xemacs (start end
&optional highlight
)
2421 "Highlight the word from START to END using `isearch-highlight'.
2422 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2423 otherwise it is displayed normally."
2425 (isearch-highlight start end
)
2426 (isearch-dehighlight))
2431 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
2432 "Highlight the word from START to END using overlays.
2433 When the optional third arg HIGHLIGHT is set, the word is highlighted
2434 otherwise it is displayed normally.
2436 The variable `ispell-highlight-face' selects the face to use for highlighting."
2439 (move-overlay ispell-overlay start end
(current-buffer))
2440 (setq ispell-overlay
(make-overlay start end
))
2441 (overlay-put ispell-overlay
'priority
1001) ;higher than lazy overlays
2442 (overlay-put ispell-overlay
'face ispell-highlight-face
))
2444 (delete-overlay ispell-overlay
)))
2445 (if (and ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
))
2447 (let ((isearch-string
2450 (regexp-quote (buffer-substring-no-properties start end
))
2453 (isearch-case-fold-search nil
))
2454 (isearch-lazy-highlight-new-loop
2455 (if (boundp 'reg-start
) reg-start
)
2456 (if (boundp 'reg-end
) reg-end
)))
2457 (lazy-highlight-cleanup lazy-highlight-cleanup
)
2458 (setq isearch-lazy-highlight-last-string nil
))))
2461 (defun ispell-highlight-spelling-error (start end
&optional highlight refresh
)
2464 (ispell-highlight-spelling-error-xemacs start end highlight
))
2465 ((and (featurep 'faces
)
2466 (or (and (fboundp 'display-color-p
) (display-color-p))
2468 (ispell-highlight-spelling-error-overlay start end highlight
))
2469 (t (ispell-highlight-spelling-error-generic start end highlight refresh
))))
2471 (defun ispell-adjusted-window-height (&optional window
)
2472 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2473 The value returned is actually the nominal number of text-lines in the
2474 window plus 1. On a terminal, this is the same value returned by
2475 `window-height', but if the window has a mode-line is taller than a normal
2476 text line, the returned value may be smaller than that from
2478 (cond ((fboundp 'window-text-height
)
2479 (1+ (window-text-height window
)))
2480 ((or (and (fboundp 'display-graphic-p
) (display-graphic-p))
2481 (and (featurep 'xemacs
) window-system
))
2482 (1- (window-height window
)))
2484 (window-height window
))))
2486 (defun ispell-overlay-window (height)
2487 "Create a window covering the top HEIGHT lines of the current window.
2488 Ensure that the line above point is still visible but otherwise avoid
2489 scrolling the current window. Leave the new window selected."
2491 (let ((oldot (save-excursion (vertical-motion -
1) (point)))
2492 (top (save-excursion (move-to-window-line height
) (point))))
2493 ;; If line above old point (line starting at oldot) would be
2494 ;; hidden by new window, scroll it to just below new win
2495 ;; otherwise set top line of other win so it doesn't scroll.
2496 (if (< oldot top
) (setq top oldot
))
2497 ;; if frame is unsplitable, temporarily disable that...
2498 (if (cdr (assq 'unsplittable
(frame-parameters (selected-frame))))
2499 (let ((frame (selected-frame)))
2500 (modify-frame-parameters frame
'((unsplittable . nil
)))
2501 (split-window nil height
)
2502 (modify-frame-parameters frame
'((unsplittable . t
))))
2503 (split-window nil height
))
2504 (let ((deficit (- height
(ispell-adjusted-window-height))))
2506 ;; Number of lines the window is still too short. We ensure that
2507 ;; there are at least (1- HEIGHT) lines visible in the window.
2508 (enlarge-window deficit
)
2510 (vertical-motion deficit
)
2511 (setq top
(min (point) oldot
))))
2512 (set-window-start (next-window) top
))))
2515 ;;; Should we add a compound word match return value?
2516 (defun ispell-parse-output (output &optional accept-list shift
)
2517 "Parse the OUTPUT string from Ispell process and return:
2518 1: t for an exact match.
2519 2: A string containing the root word matched via suffix removal.
2520 3: A list of possible correct spellings of the format:
2521 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2522 ORIGINAL-WORD is a string of the possibly misspelled word.
2523 OFFSET is an integer giving the line offset of the word.
2524 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2525 4: nil when an error has occurred.
2527 Optional second arg ACCEPT-LIST is list of words already accepted.
2528 Optional third arg SHIFT is an offset to apply based on previous corrections."
2530 ((string= output
"") t
) ; for startup with pipes...
2531 ((string= output
"*") t
) ; exact match
2532 ((string= output
"-") t
) ; compound word match
2533 ((eq (aref output
0) ?
+) ; found because of root word
2534 (substring output
2)) ; return root word
2535 ((equal 0 (string-match "[\ra-zA-Z]" output
))
2536 (ding) ; error message from ispell!
2537 (message "Ispell error: %s" output
)
2540 (t ; need to process &, ?, and #'s
2541 (let ((type (aref output
0)) ; &, ?, or #
2542 (original-word (substring output
2 (string-match " " output
2)))
2543 (cur-count 0) ; contains number of misses + guesses
2544 count miss-list guess-list offset
)
2545 (setq output
(substring output
(match-end 0))) ; skip over misspelling
2547 (setq count
0) ; no misses for type #
2548 (setq count
(string-to-number output
) ; get number of misses.
2549 output
(substring output
(1+ (string-match " " output
1)))))
2550 (setq offset
(string-to-number output
))
2551 (if (eq type ?
#) ; No miss or guess list.
2553 (setq output
(substring output
(1+ (string-match " " output
1)))))
2555 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
2556 (setq cur-count
(1+ cur-count
))
2557 (if (> cur-count count
)
2558 (setq guess-list
(cons (substring output
0 end
) guess-list
))
2559 (setq miss-list
(cons (substring output
0 end
) miss-list
)))
2560 (if (match-end 1) ; True only when at end of line.
2561 (setq output nil
) ; no more misses or guesses
2562 (setq output
(substring output
(+ end
2))))))
2563 ;; return results. Accept word if it was already accepted.
2565 (if (member original-word accept-list
)
2568 (if (numberp shift
) (+ shift offset
) offset
)
2569 (nreverse miss-list
) (nreverse guess-list
)))))))
2572 (defun ispell-process-status ()
2573 "Return the status of the Ispell process.
2574 When asynchronous processes are not supported, `run' is always returned."
2575 (if ispell-async-processp
2576 (process-status ispell-process
)
2577 (and ispell-process
'run
)))
2580 (defun ispell-start-process ()
2581 "Start the ispell process, with support for no asynchronous processes.
2582 Keeps argument list for future ispell invocations for no async support."
2583 ;; Local dictionary becomes the global dictionary in use.
2584 (setq ispell-current-dictionary
2585 (or ispell-local-dictionary ispell-dictionary
))
2586 (setq ispell-current-personal-dictionary
2587 (or ispell-local-pdict ispell-personal-dictionary
))
2588 (let* ((default-directory
2589 (if (and (file-directory-p default-directory
)
2590 (file-readable-p default-directory
))
2592 ;; Defend against bad `default-directory'.
2593 (expand-file-name "~/")))
2596 (if (and ispell-current-dictionary
; Use specified dictionary.
2597 (not (member "-d" args
))) ; Only define if not overridden.
2598 (list "-d" ispell-current-dictionary
))
2599 (ispell-get-ispell-args)
2600 (if ispell-current-personal-dictionary
; Use specified pers dict.
2602 (expand-file-name ispell-current-personal-dictionary
)))
2603 ;; If we are using recent aspell or hunspell, make sure we use the
2604 ;; right encoding for communication. ispell or older aspell/hunspell
2605 ;; does not support this.
2606 (if ispell-encoding8-command
2608 (concat ispell-encoding8-command
2609 (symbol-name (ispell-get-coding-system)))))
2610 ispell-extra-args
)))
2612 ;; Initially we don't know any buffer's local words.
2613 (setq ispell-buffer-local-name nil
)
2615 (if ispell-async-processp
2616 (let ((process-connection-type ispell-use-ptys-p
))
2617 (apply 'start-process
2618 "ispell" nil ispell-program-name
2619 "-a" ; Accept single input lines.
2620 ;; Make root/affix combos not in dict.
2621 ;; hunspell -m option means different.
2622 (if ispell-really-hunspell
"" "-m")
2624 (setq ispell-cmd-args args
2625 ispell-output-buffer
(generate-new-buffer " *ispell-output*")
2626 ispell-session-buffer
(generate-new-buffer " *ispell-session*"))
2627 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2631 (defun ispell-init-process ()
2632 "Check status of Ispell process and start if necessary."
2633 (let* (;; Basename of dictionary used by the spell-checker
2634 (dict-bname (or (car (cdr (member "-d" (ispell-get-ispell-args))))
2635 ispell-current-dictionary
))
2636 ;; Use "~/" as default-directory unless using Ispell with per-dir
2637 ;; personal dictionaries and not in a minibuffer under XEmacs
2639 (if (or ispell-really-aspell
2640 ispell-really-hunspell
2641 ;; Protect against bad default-directory
2642 (not (and (file-directory-p default-directory
)
2643 (file-readable-p default-directory
)))
2644 ;; Ispell and per-dir personal dicts available
2645 (not (or (file-readable-p (concat default-directory
2647 (file-readable-p (concat default-directory
2651 ;; Ispell, in a minibuffer, and XEmacs
2652 (and (window-minibuffer-p)
2653 (not (fboundp 'minibuffer-selected-window
))))
2654 (expand-file-name "~/")
2655 (expand-file-name default-directory
))))
2656 ;; Check if process needs restart
2657 (if (and ispell-process
2658 (eq (ispell-process-status) 'run
)
2659 ;; Unless we are using an explicit personal dictionary, ensure
2660 ;; we're in the same default directory! Restart check for
2661 ;; personal dictionary is done in
2662 ;; `ispell-internal-change-dictionary', called from
2663 ;; `ispell-buffer-local-dict'
2664 (or (or ispell-local-pdict ispell-personal-dictionary
)
2665 (equal ispell-process-directory default-directory
)))
2666 (setq ispell-filter nil ispell-filter-continue nil
)
2667 ;; may need to restart to select new personal dictionary.
2668 (ispell-kill-ispell t
)
2669 (message "Starting new Ispell process [%s] ..."
2670 (or ispell-local-dictionary ispell-dictionary
"default"))
2672 (setq ispell-library-directory
(ispell-check-version)
2673 ispell-process
(ispell-start-process)
2675 ispell-filter-continue nil
2676 ispell-process-directory default-directory
)
2678 ;; Kill ispell process when killing its associated buffer if using Ispell
2679 ;; per-directory personal dictionaries.
2680 (unless (equal ispell-process-directory
(expand-file-name "~/"))
2681 (with-current-buffer
2682 (if (and (window-minibuffer-p)
2683 (fboundp 'minibuffer-selected-window
)) ;; E.g. XEmacs.
2684 ;; When spellchecking minibuffer contents, assign ispell
2685 ;; process to parent buffer if known (not known for XEmacs).
2686 ;; Use (buffer-name) otherwise.
2687 (window-buffer (minibuffer-selected-window))
2689 (add-hook 'kill-buffer-hook
(lambda () (ispell-kill-ispell t
))
2692 (if ispell-async-processp
2693 (set-process-filter ispell-process
'ispell-filter
))
2694 ;; protect against bogus binding of `enable-multibyte-characters' in
2696 (if (and (or (featurep 'xemacs
)
2697 (and (boundp 'enable-multibyte-characters
)
2698 enable-multibyte-characters
))
2699 (fboundp 'set-process-coding-system
))
2700 (set-process-coding-system ispell-process
(ispell-get-coding-system)
2701 (ispell-get-coding-system)))
2702 ;; Get version ID line
2703 (ispell-accept-output 3)
2704 ;; get more output if filter empty?
2705 (if (null ispell-filter
) (ispell-accept-output 3))
2706 (cond ((null ispell-filter
)
2707 (error "%s did not output version line" ispell-program-name
))
2709 (stringp (car ispell-filter
))
2710 (if (string-match "warning: " (car ispell-filter
))
2712 (ispell-accept-output 3) ; was warn msg.
2713 (stringp (car ispell-filter
)))
2714 (null (cdr ispell-filter
)))
2715 (string-match "^@(#) " (car ispell-filter
)))
2716 ;; got the version line as expected (we already know it's the right
2717 ;; version, so don't bother checking again.)
2720 ;; Otherwise, it must be an error message. Show the user.
2721 ;; But first wait to see if some more output is going to arrive.
2722 ;; Otherwise we get cool errors like "Can't open ".
2724 (ispell-accept-output 3)
2725 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
2726 (setq ispell-filter nil
) ; Discard version ID line
2727 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2728 (if extended-char-mode
; ~ extended character mode
2729 (ispell-send-string (concat extended-char-mode
"\n"))))
2730 (if ispell-async-processp
2731 (set-process-query-on-exit-flag ispell-process nil
)))))
2734 (defun ispell-kill-ispell (&optional no-error
)
2735 "Kill current Ispell process (so that you may start a fresh one).
2736 With NO-ERROR, just return non-nil if there was no Ispell running."
2738 ;; This hook is typically used by flyspell to flush some variables used
2739 ;; to optimize the common cases.
2740 (run-hooks 'ispell-kill-ispell-hook
)
2741 (if (not (and ispell-process
2742 (eq (ispell-process-status) 'run
)))
2744 (error "There is no ispell process running!"))
2745 (if ispell-async-processp
2746 (delete-process ispell-process
)
2747 ;; synchronous processes
2748 (ispell-send-string "\n") ; make sure side effects occurred.
2749 (kill-buffer ispell-output-buffer
)
2750 (kill-buffer ispell-session-buffer
)
2751 (setq ispell-output-buffer nil
2752 ispell-session-buffer nil
))
2753 (setq ispell-process nil
)
2754 (message "Ispell process killed")
2757 ;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2758 ;;; call ispell-init-process rather than wait for a spell checking command?
2761 (defun ispell-change-dictionary (dict &optional arg
)
2762 "Change to dictionary DICT for Ispell.
2763 With a prefix arg, set it \"globally\", for all buffers.
2764 Without a prefix arg, set it \"locally\", just for this buffer.
2766 By just answering RET you can find out what the current dictionary is."
2768 (list (completing-read
2769 "Use new dictionary (RET for current, SPC to complete): "
2770 (and (fboundp 'ispell-valid-dictionary-list
)
2771 (mapcar 'list
(ispell-valid-dictionary-list)))
2773 current-prefix-arg
))
2774 (ispell-set-spellchecker-params) ; Initilize variables and dicts alists
2775 (unless arg
(ispell-buffer-local-dict 'no-reload
))
2776 (if (equal dict
"default") (setq dict nil
))
2777 ;; This relies on completing-read's bug of returning "" for no match
2778 (cond ((equal dict
"")
2779 (ispell-internal-change-dictionary)
2780 (message "Using %s dictionary"
2781 (or (and (not arg
) ispell-local-dictionary
)
2782 ispell-dictionary
"default")))
2783 ((equal dict
(or (and (not arg
) ispell-local-dictionary
)
2784 ispell-dictionary
"default"))
2785 ;; Specified dictionary is the default already. Could reload
2786 ;; the dictionaries if needed.
2787 (ispell-internal-change-dictionary)
2788 (and (interactive-p)
2789 (message "No change, using %s dictionary" dict
)))
2790 (t ; reset dictionary!
2791 (if (or (assoc dict ispell-local-dictionary-alist
)
2792 (assoc dict ispell-dictionary-alist
))
2794 ;; set default dictionary
2795 (setq ispell-dictionary dict
)
2796 ;; set local dictionary
2797 (setq ispell-local-dictionary dict
)
2798 (setq ispell-local-dictionary-overridden t
))
2799 (error "Undefined dictionary: %s" dict
))
2800 (ispell-internal-change-dictionary)
2801 (message "%s Ispell dictionary set to %s"
2802 (if arg
"Global" "Local")
2805 (defun ispell-internal-change-dictionary ()
2806 "Update the dictionary and the personal dictionary used by Ispell.
2807 This may kill the Ispell process; if so,
2808 a new one will be started when needed."
2809 (let ((dict (or ispell-local-dictionary ispell-dictionary
))
2810 (pdict (or ispell-local-pdict ispell-personal-dictionary
)))
2811 (unless (and (equal ispell-current-dictionary dict
)
2812 (equal ispell-current-personal-dictionary pdict
))
2813 (ispell-kill-ispell t
)
2814 (setq ispell-current-dictionary dict
2815 ispell-current-personal-dictionary pdict
))))
2817 ;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2820 (defun ispell-region (reg-start reg-end
&optional recheckp shift
)
2821 "Interactively check a region for spelling errors.
2822 Return nil if spell session is quit,
2823 otherwise returns shift offset amount for last line processed."
2824 (interactive "r") ; Don't flag errors on read-only bufs.
2825 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
2827 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2828 (let ((skip-region-start (make-marker))
2829 (rstart (make-marker)))
2832 (message "Spell-checking %s using %s with %s dictionary..."
2833 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
2834 (buffer-name) "region")
2835 (file-name-nondirectory ispell-program-name
)
2836 (or ispell-current-dictionary
"default"))
2837 ;; Returns cursor to original location.
2838 (save-window-excursion
2839 (goto-char reg-start
)
2840 (let ((transient-mark-mode)
2841 (case-fold-search case-fold-search
)
2844 (let (message-log-max)
2845 (message "searching for regions to skip"))
2846 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t
)
2848 (setq key
(buffer-substring-no-properties
2849 (match-beginning 0) (match-end 0)))
2850 (set-marker skip-region-start
(- (point) (length key
)))
2851 (goto-char reg-start
)))
2852 (let (message-log-max)
2854 "Continuing spelling check using %s with %s dictionary..."
2855 (file-name-nondirectory ispell-program-name
)
2856 (or ispell-current-dictionary
"default")))
2857 (set-marker rstart reg-start
)
2858 (set-marker ispell-region-end reg-end
)
2859 (while (and (not ispell-quit
)
2860 (< (point) ispell-region-end
))
2861 ;; spell-check region with skipping
2862 (if (and (marker-position skip-region-start
)
2863 (<= skip-region-start
(point)))
2865 ;; If region inside line comment, must keep comment start.
2866 (setq in-comment
(point)
2869 (or (null comment-end
) (string= "" comment-end
))
2872 (re-search-forward comment-start in-comment t
))
2874 ;; Can change skip-regexps (in ispell-message)
2875 (ispell-skip-region key
) ; moves pt past region.
2876 (set-marker rstart
(point))
2877 ;; check for saving large attachments...
2878 (setq query-fcc
(and query-fcc
2879 (ispell-ignore-fcc skip-region-start
2881 (if (and (< rstart ispell-region-end
)
2883 (ispell-begin-skip-region-regexp)
2884 ispell-region-end t
))
2886 (setq key
(match-string-no-properties 0))
2887 (set-marker skip-region-start
2888 (- (point) (length key
)))
2890 (set-marker skip-region-start nil
))))
2891 (setq reg-end
(max (point)
2892 (if (marker-position skip-region-start
)
2893 (min skip-region-start ispell-region-end
)
2894 (marker-position ispell-region-end
))))
2895 (let* ((start (point))
2896 (end (save-excursion (end-of-line) (min (point) reg-end
)))
2897 (string (ispell-get-line start end in-comment
)))
2898 (if in-comment
; account for comment chars added
2899 (setq start
(- start
(length in-comment
))
2901 (setq end
(point)) ; "end" tracks region retrieved.
2902 (if string
; there is something to spell check!
2903 ;; (special start end)
2904 (setq shift
(ispell-process-line string
2905 (and recheckp shift
))))
2911 (if (and (not (and recheckp ispell-keep-choices-win
))
2912 (get-buffer ispell-choices-buffer
))
2913 (kill-buffer ispell-choices-buffer
))
2914 (set-marker skip-region-start nil
)
2915 (set-marker rstart nil
)
2918 ;; preserve or clear the region for ispell-continue.
2919 (if (not (numberp ispell-quit
))
2920 (set-marker ispell-region-end nil
)
2921 ;; Ispell-continue enabled - ispell-region-end is set.
2922 (goto-char ispell-quit
))
2923 ;; Check for aborting
2924 (if (and ispell-checking-message
(numberp ispell-quit
))
2926 (setq ispell-quit nil
)
2927 (error "Message send aborted")))
2928 (if (not recheckp
) (setq ispell-quit nil
)))
2929 (if (not recheckp
) (set-marker ispell-region-end nil
))
2930 ;; Only save if successful exit.
2931 (ispell-pdict-save ispell-silently-savep
)
2932 (message "Spell-checking %s using %s with %s dictionary...done"
2933 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
2934 (buffer-name) "region")
2935 (file-name-nondirectory ispell-program-name
)
2936 (or ispell-current-dictionary
"default"))))))
2939 (defun ispell-begin-skip-region-regexp ()
2940 "Return a regexp of the search keys for region skipping.
2941 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2942 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2943 ;; start with regions generic to all buffers
2944 (let ((skip-regexp (ispell-begin-skip-region ispell-skip-region-alist
)))
2946 (if (and (null ispell-check-comments
) comment-start
)
2947 (setq skip-regexp
(concat (regexp-quote comment-start
) "\\|"
2949 (if (and (eq 'exclusive ispell-check-comments
) comment-start
)
2950 ;; search from end of current comment to start of next comment.
2951 (setq skip-regexp
(concat (if (string= "" comment-end
) "^"
2952 (regexp-quote comment-end
))
2953 "\\|" skip-regexp
)))
2956 (setq skip-regexp
(concat ispell-tib-ref-beginning
"\\|" skip-regexp
)))
2958 (if ispell-skip-html
2959 (setq skip-regexp
(concat
2960 (ispell-begin-skip-region ispell-html-skip-alists
)
2964 (if (eq ispell-parser
'tex
)
2965 (setq skip-regexp
(concat (ispell-begin-tex-skip-regexp) "\\|"
2968 (if (and ispell-checking-message
2969 (not (eq t ispell-checking-message
)))
2970 (setq skip-regexp
(concat
2971 (mapconcat (lambda (lst) (car lst
))
2972 ispell-checking-message
2977 ;; return new regexp
2981 (defun ispell-begin-skip-region (skip-alist)
2982 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2983 Each selection should be a key of SKIP-ALIST;
2984 otherwise, the current line is skipped."
2985 (mapconcat (lambda (lst) (if (stringp (car lst
)) (car lst
) (eval (car lst
))))
2990 (defun ispell-begin-tex-skip-regexp ()
2991 "Regular expression of tex commands to skip.
2992 Generated from `ispell-tex-skip-alists'."
2995 (mapconcat (function (lambda (lst) (car lst
)))
2996 (car ispell-tex-skip-alists
)
2999 ;; keys wrapped in begin{}
3000 (mapconcat (function (lambda (lst)
3001 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
3004 (car (cdr ispell-tex-skip-alists
))
3008 (defun ispell-skip-region-list ()
3009 "Return a list describing key and body regions to skip for this buffer.
3010 Includes regions defined by `ispell-skip-region-alist', tex mode,
3011 `ispell-html-skip-alists', and `ispell-checking-message'.
3012 Manual checking must include comments and tib references.
3013 The list is of the form described by variable `ispell-skip-region-alist'.
3014 Must call after `ispell-buffer-local-parsing' due to dependence on mode."
3015 (let ((skip-alist ispell-skip-region-alist
))
3016 ;; only additional explicit region definition is tex.
3017 (if (eq ispell-parser
'tex
)
3018 (setq case-fold-search nil
3019 skip-alist
(append (car ispell-tex-skip-alists
)
3020 (car (cdr ispell-tex-skip-alists
))
3022 (if ispell-skip-html
3023 (setq skip-alist
(append ispell-html-skip-alists skip-alist
)))
3024 (if (and ispell-checking-message
3025 (not (eq t ispell-checking-message
)))
3026 (setq skip-alist
(append ispell-checking-message skip-alist
)))
3030 (defun ispell-tex-arg-end (&optional arg
)
3031 "Skip across ARG number of braces."
3034 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
3035 (forward-sexp (or arg
1)))
3037 (message "error skipping s-expressions at point %d." (point))
3042 (defun ispell-ignore-fcc (start end
)
3043 "Delete the Fcc: message header when large attachments are included.
3044 Return value `nil' if file with large attachments are saved.
3045 This can be used to avoid multiple questions for multiple large attachments.
3046 Returns point to starting location afterwards."
3048 (if (and ispell-checking-message ispell-message-fcc-skip
)
3049 (if (< ispell-message-fcc-skip
(- end start
))
3050 (let (case-fold-search head-end
)
3051 (goto-char (point-min))
3053 (or (re-search-forward
3054 (concat "^" (regexp-quote mail-header-separator
) "$")
3056 (re-search-forward "^$" nil t
)
3058 (goto-char (point-min))
3059 (if (re-search-forward "^Fcc:" head-end t
)
3061 "Save copy of this message with large attachments? ")
3069 (defun ispell-skip-region (key)
3070 "Skip across KEY and then to end of region.
3071 Key lookup determines region to skip.
3072 Point is placed at end of skipped region."
3073 ;; move over key to begin checking.
3074 (forward-char (length key
))
3075 (let ((start (point))
3076 ;; Regenerate each call... This function can change region definition.
3077 (alist (ispell-skip-region-list))
3078 alist-key null-skip
)
3080 ;; what about quoted comment, or comment inside strings?
3081 ((and (null ispell-check-comments
) comment-start
3082 (string= key comment-start
))
3083 (if (string= "" comment-end
)
3085 (search-forward comment-end ispell-region-end t
)))
3086 ((and (eq 'exclusive ispell-check-comments
) comment-start
3087 (string= key comment-end
))
3088 (search-forward comment-start ispell-region-end
:end
))
3089 ((and ispell-skip-tib
(string-match ispell-tib-ref-beginning key
))
3090 (re-search-forward ispell-tib-ref-end ispell-region-end t
))
3091 ;; markings from alist
3094 (setq alist-key
(eval (car (car alist
))))
3095 (if (string-match alist-key key
)
3097 (setq alist
(cdr (car alist
)))
3099 ((null alist
) (setq null-skip t
)) ; done! Just skip key.
3100 ((not (consp alist
))
3101 ;; Search past end of spell region to find this region end.
3102 (re-search-forward (eval alist
) (point-max) t
))
3103 ((and (= 1 (length alist
))
3104 (stringp (car alist
)))
3105 (re-search-forward (car alist
) (point-max) t
))
3107 (setq null-skip t
) ; error handling in functions!
3108 (if (consp (cdr alist
))
3109 (apply (car alist
) (cdr alist
))
3110 (funcall (car alist
)))))
3112 (setq alist
(cdr alist
))))))
3113 (if (and (= start
(point)) (null null-skip
))
3115 (message "Matching region end for `%s' point %d not found"
3121 (defun ispell-get-line (start end in-comment
)
3122 "Grab the next line of data.
3123 Returns a string with the line data."
3124 (let ((ispell-casechars (ispell-get-casechars))
3126 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
3127 ((eolp) ; END OF LINE, just go to next line.
3129 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
3130 ;; (forward-char 1)) ; not needed as quoted below.
3131 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
3132 (re-search-forward "[][()${}]" end t
)) ; or MATH COMMANDS
3133 (setq string
(concat "^" in-comment
3134 (buffer-substring-no-properties start end
)
3137 (t (goto-char end
))) ; EMPTY LINE, skip it.
3141 (defun ispell-looking-at (string)
3142 (let ((coding (ispell-get-coding-system))
3143 (len (length string
)))
3144 (and (<= (+ (point) len
) (point-max))
3145 (equal (encode-coding-string string coding
)
3146 (encode-coding-string (buffer-substring-no-properties
3147 (point) (+ (point) len
))
3150 ;; Avoid error messages when compiling for these dynamic variables.
3151 ;; FIXME: dynamically scoped vars should have an "ispell-" prefix.
3155 (defun ispell-process-line (string shift
)
3156 "Send STRING, a line of text, to ispell and processes the result.
3157 This will modify the buffer for spelling errors.
3158 Requires variables START and END to be defined in its lexical scope.
3159 Returns the sum SHIFT due to changes in word replacements."
3160 ;;(declare special start end)
3161 (let (poss accept-list
)
3162 (if (not (numberp shift
))
3164 ;; send string to spell process and get input.
3165 (ispell-send-string string
)
3167 (ispell-accept-output)
3168 ;; Last item of output contains a blank line.
3169 (not (string= "" (car ispell-filter
)))))
3170 ;; parse all inputs from the stream one word at a time.
3171 ;; Place in FIFO order and remove the blank item.
3172 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
3173 (while (and (not ispell-quit
) ispell-filter
)
3174 ;; get next word, accounting for accepted words and start shifts
3175 (setq poss
(ispell-parse-output (car ispell-filter
)
3177 (if (and poss
(listp poss
)) ; spelling error occurred.
3178 ;; Whenever we have misspellings, we can change
3179 ;; the buffer. Keep boundaries as markers.
3180 ;; Markers can move with highlighting! This destroys
3181 ;; end of region markers line-end and ispell-region-end
3183 (copy-marker (+ start ispell-offset
(car (cdr poss
)))))
3184 (word-len (length (car poss
)))
3185 (line-end (copy-marker end
))
3186 (line-start (copy-marker start
))
3187 recheck-region replace
)
3188 (goto-char word-start
)
3189 ;; Adjust the horizontal scroll & point
3190 (ispell-horiz-scroll)
3191 (goto-char (+ word-len word-start
))
3192 (ispell-horiz-scroll)
3193 (goto-char word-start
)
3194 (ispell-horiz-scroll)
3196 ;; Alignment cannot be tracked and this error will occur when
3197 ;; `query-replace' makes multiple corrections on the starting line.
3198 (or (ispell-looking-at (car poss
))
3199 ;; This occurs due to filter pipe problems
3200 (error (concat "Ispell misalignment: word "
3201 "`%s' point %d; probably incompatible versions")
3202 (car poss
) (marker-position word-start
)))
3203 ;; ispell-cmd-loop can go recursive & change buffer
3204 (if ispell-keep-choices-win
3205 (setq replace
(ispell-command-loop
3206 (car (cdr (cdr poss
)))
3207 (car (cdr (cdr (cdr poss
))))
3208 (car poss
) (marker-position word-start
)
3209 (+ word-len
(marker-position word-start
))))
3210 (save-window-excursion
3211 (setq replace
(ispell-command-loop
3212 (car (cdr (cdr poss
)))
3213 (car (cdr (cdr (cdr poss
))))
3214 (car poss
) (marker-position word-start
)
3215 (+ word-len
(marker-position word-start
))))))
3217 (goto-char word-start
)
3218 ;; Recheck when query replace edit changes misspelled word.
3219 ;; Error in tex mode when a potential math mode change exists.
3220 (if (and replace
(listp replace
) (= 2 (length replace
)))
3221 (if (and (eq ispell-parser
'tex
)
3222 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3223 (regexp-quote string
)))
3225 "Don't start query replace on a line with math characters"
3227 (set-marker line-end
(point))
3228 (setq ispell-filter nil
3231 ;; insert correction if needed
3234 (equal 0 replace
)) ; ACCEPT/INSERT
3235 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
3236 (ispell-add-per-file-word-list (car poss
)))
3237 ;; do not recheck accepted word on this line
3238 (setq accept-list
(cons (car poss
) accept-list
)))
3239 (t ; replacement word selected or entered
3240 (delete-region (point) (+ word-len
(point)))
3241 (if (not (listp replace
))
3243 (ispell-insert-word replace
) ; insert dictionary word
3244 (ispell-send-replacement (car poss
) replace
)
3245 (setq accept-list
(cons replace accept-list
)))
3246 (let ((replace-word (car replace
)))
3247 ;; Recheck hand entered replacement word
3248 (insert replace-word
)
3249 (ispell-send-replacement (car poss
) replace-word
)
3250 (if (car (cdr replace
))
3251 (save-window-excursion
3252 (delete-other-windows) ; to correctly show help.
3253 ;; Assume case-replace &
3254 ;; case-fold-search correct?
3255 (query-replace (car poss
) (car replace
) t
)))
3256 (goto-char word-start
)
3257 ;; do not recheck if already accepted
3258 (if (member replace-word accept-list
)
3259 (setq accept-list
(cons replace-word accept-list
)
3260 replace replace-word
)
3261 (let ((region-end (copy-marker ispell-region-end
)))
3262 (setq recheck-region ispell-filter
3263 ispell-filter nil
; save filter
3264 shift
0 ; already accounted
3265 shift
(ispell-region
3267 (+ word-start
(length replace-word
))
3269 (if (null shift
) ; quitting check.
3271 (set-marker ispell-region-end region-end
)
3272 (set-marker region-end nil
)
3273 (setq ispell-filter recheck-region
3275 replace replace-word
)))))
3277 (setq shift
(+ shift
(- (length replace
) word-len
)))
3279 ;; Move line-start across word...
3280 ;; new shift function does this now...
3281 ;;(set-marker line-start (+ line-start
3282 ;; (- (length replace)
3283 ;; (length (car poss)))))
3285 (if (not ispell-quit
)
3286 ;; FIXME: remove redundancy with identical code above.
3287 (let (message-log-max)
3289 "Continuing spelling check using %s with %s dictionary..."
3290 (file-name-nondirectory ispell-program-name
)
3291 (or ispell-current-dictionary
"default"))))
3293 (setq start
(marker-position line-start
)
3294 end
(marker-position line-end
))
3295 ;; Adjust markers when end of region lost from highlighting.
3296 (if (and (not recheck-region
) (< end
(+ word-start word-len
)))
3297 (setq end
(+ word-start word-len
)))
3298 (if (= word-start ispell-region-end
)
3299 (set-marker ispell-region-end
(+ word-start word-len
)))
3300 ;; going out of scope - unneeded
3301 (set-marker line-start nil
)
3302 (set-marker word-start nil
)
3303 (set-marker line-end nil
)))
3304 ;; finished with misspelling!
3305 (setq ispell-filter
(cdr ispell-filter
)))
3310 (defun ispell-comments-and-strings ()
3311 "Check comments and strings in the current buffer for spelling errors."
3313 (goto-char (point-min))
3317 (setq state
(parse-partial-sexp (point) (point-max)
3318 nil nil state
'syntax-table
))
3319 (if (or (nth 3 state
) (nth 4 state
))
3320 (let ((start (point)))
3321 (setq state
(parse-partial-sexp start
(point-max)
3322 nil nil state
'syntax-table
))
3323 (if (or (nth 3 state
) (nth 4 state
))
3324 (error "Unterminated string or comment"))
3326 (setq done
(not (ispell-region start
(point))))))))))
3330 (defun ispell-buffer ()
3331 "Check the current buffer for spelling errors interactively."
3333 (ispell-region (point-min) (point-max)))
3337 (defun ispell-continue ()
3338 "Continue a halted spelling session beginning with the current word."
3340 (if (not (marker-position ispell-region-end
))
3341 (message "No session to continue. Use 'X' command when checking!")
3342 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
3343 (message "Must continue ispell from buffer %s"
3344 (buffer-name (marker-buffer ispell-region-end
)))
3346 ;; find beginning of current word:
3347 (car (cdr (ispell-get-word t
)))
3348 (marker-position ispell-region-end
)))))
3351 ;;; Horizontal scrolling
3352 (defun ispell-horiz-scroll ()
3353 "Place point within the horizontal visibility of its window area."
3354 (if truncate-lines
; display truncating lines?
3355 ;; See if display needs to be scrolled.
3356 (let ((column (- (current-column) (max (window-hscroll) 1))))
3357 (if (and (< column
0) (> (window-hscroll) 0))
3358 (scroll-right (max (- column
) 10))
3359 (if (>= column
(- (window-width) 2))
3360 (scroll-left (max (- column
(window-width) -
3) 10)))))))
3363 ;;; Interactive word completion.
3364 ;; Forces "previous-word" processing. Do we want to make this selectable?
3367 (defun ispell-complete-word (&optional interior-frag
)
3368 "Try to complete the word before or under point (see `lookup-words').
3369 If optional INTERIOR-FRAG is non-nil then the word may be a character
3370 sequence inside of a word.
3372 Standard ispell choices are then available."
3374 (let ((cursor-location (point))
3375 (case-fold-search-val case-fold-search
)
3376 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
3377 start end possibilities replacement
)
3378 (setq start
(car (cdr word
))
3379 end
(car (cdr (cdr word
)))
3382 (or (string= word
"") ; Will give you every word
3383 (lookup-words (concat (and interior-frag
"*") word
3384 (if (or interior-frag
(null ispell-look-p
))
3386 (or ispell-complete-word-dict
3387 ispell-alternate-dictionary
))))
3388 (cond ((eq possibilities t
)
3389 (message "No word to complete"))
3390 ((null possibilities
)
3391 (message "No match for \"%s\"" word
))
3392 (t ; There is a modification...
3393 (setq case-fold-search nil
) ; Try and respect case of word.
3395 ((string-equal (upcase word
) word
)
3396 (setq possibilities
(mapcar 'upcase possibilities
)))
3397 ((eq (upcase (aref word
0)) (aref word
0))
3398 (setq possibilities
(mapcar (function
3400 (if (eq (aref word
0) (aref pos
0))
3404 (setq case-fold-search case-fold-search-val
)
3405 (save-window-excursion
3407 (ispell-command-loop possibilities nil word start end
)))
3409 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
3410 (ispell-add-per-file-word-list word
))
3411 (replacement ; REPLACEMENT WORD
3412 (delete-region start end
)
3413 (setq word
(if (atom replacement
) replacement
(car replacement
))
3414 cursor-location
(+ (- (length word
) (- end start
))
3416 (ispell-insert-word word
)
3417 (if (not (atom replacement
)) ; recheck spelling of replacement.
3419 (goto-char cursor-location
)
3420 (ispell-word nil t
)))))
3421 (if (get-buffer ispell-choices-buffer
)
3422 (kill-buffer ispell-choices-buffer
))))
3423 (ispell-pdict-save ispell-silently-savep
)
3424 (goto-char cursor-location
)))
3428 (defun ispell-complete-word-interior-frag ()
3429 "Completes word matching character sequence inside a word."
3431 (ispell-complete-word t
))
3436 "Interactively check a region or buffer for spelling errors.
3437 If `transient-mark-mode' is on, and a region is active, spell-check
3438 that region. Otherwise spell-check the buffer.
3440 Ispell dictionaries are not distributed with Emacs. If you are
3441 looking for a dictionary, please see the distribution of the GNU ispell
3442 program, or do an Internet search; there are various dictionaries
3443 available on the net."
3445 (if (and (boundp 'transient-mark-mode
) transient-mark-mode
3446 (boundp 'mark-active
) mark-active
)
3447 (ispell-region (region-beginning) (region-end))
3451 ;;; **********************************************************************
3452 ;;; Ispell Minor Mode
3453 ;;; **********************************************************************
3455 (defvar ispell-minor-mode nil
3456 "Non-nil if Ispell minor mode is enabled.")
3457 ;; Variable indicating that ispell minor mode is active.
3458 (make-variable-buffer-local 'ispell-minor-mode
)
3460 (or (assq 'ispell-minor-mode minor-mode-alist
)
3461 (setq minor-mode-alist
3462 (cons '(ispell-minor-mode " Spell") minor-mode-alist
)))
3464 (defvar ispell-minor-keymap
3465 (let ((map (make-sparse-keymap)))
3466 (define-key map
" " 'ispell-minor-check
)
3467 (define-key map
"\r" 'ispell-minor-check
)
3469 "Keymap used for Ispell minor mode.")
3471 (or (not (boundp 'minor-mode-map-alist
))
3472 (assoc 'ispell-minor-mode minor-mode-map-alist
)
3473 (setq minor-mode-map-alist
3474 (cons (cons 'ispell-minor-mode ispell-minor-keymap
)
3475 minor-mode-map-alist
)))
3478 (defun ispell-minor-mode (&optional arg
)
3479 "Toggle Ispell minor mode.
3480 With prefix argument ARG, turn Ispell minor mode on if ARG is positive,
3481 otherwise turn it off.
3483 In Ispell minor mode, pressing SPC or RET
3484 warns you if the previous word is incorrectly spelled.
3486 All the buffer-local variables and dictionaries are ignored -- to read
3487 them into the running ispell process, type \\[ispell-word] SPC."
3489 (setq ispell-minor-mode
3490 (not (or (and (null arg
) ispell-minor-mode
)
3491 (<= (prefix-numeric-value arg
) 0))))
3492 (force-mode-line-update))
3494 (defun ispell-minor-check ()
3495 "Check previous word then continue with the normal binding of this key.
3496 Don't check previous word when character before point is a space or newline.
3497 Don't read buffer-local settings or word lists."
3499 (let ((ispell-minor-mode nil
)
3500 (ispell-check-only t
)
3501 (last-char (char-after (1- (point)))))
3502 (command-execute (key-binding (this-command-keys)))
3503 (if (not (or (eq last-char ?\
) (eq last-char ?
\n)
3504 (and ispell-skip-html
(eq last-char ?
>))
3505 (and ispell-skip-html
(eq last-char ?\
;))))
3506 (ispell-word nil t
))))
3509 ;;; **********************************************************************
3511 ;;; **********************************************************************
3513 (defvar ispell-message-text-end
3514 (mapconcat (function identity
)
3516 ;; Don't spell check signatures
3518 ;; Matches postscript files.
3519 ;;"^%!PS-Adobe-[123].0"
3520 ;; Matches uuencoded text
3521 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3522 ;; Matches shell files (especially auto-decoding)
3524 ;; Matches context difference listing
3525 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3526 ;; Matches unidiff difference listing
3527 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@"
3528 ;; Matches reporter.el bug report
3529 "^current state:\n==============\n"
3530 ;; Matches commonly used "cut" boundaries
3531 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3533 "*End of text which will be checked in `ispell-message'.
3534 If it is a string, limit at first occurrence of that regular expression.
3535 Otherwise, it must be a function which is called to get the limit.")
3536 (put 'ispell-message-text-end
'risky-local-variable t
)
3539 (defun ispell-mime-multipartp (&optional limit
)
3540 "Return multipart message start boundary or nil if none."
3541 ;; caller must ensure `case-fold-search' is set to `t'
3544 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3547 (if (looking-at "\"")
3550 (setq start
(point))
3551 (while (not (looking-at "\""))
3553 (setq boundary
(buffer-substring-no-properties start
(point))))
3554 (let ((start (point)))
3555 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3557 (setq boundary
(buffer-substring-no-properties start
(point)))))
3558 (if (< (length boundary
) 1)
3560 (concat "--" boundary
)))))
3563 (defun ispell-mime-skip-part (boundary)
3564 "Move point across header, or entire MIME part if message is encoded.
3565 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3566 encoded and therefore skipped. See rfc 1521, 2183, ...
3567 If no boundary is given, then entire message is skipped.
3569 This starts one line ABOVE the MIME content messages, on the boundary marker,
3570 for operation with the generic region-skipping code.
3571 This places new MIME boundaries into variable `ispell-checking-message'."
3572 (forward-line) ; skip over boundary to headers
3573 (let ((save-case-fold-search case-fold-search
)
3576 (setq case-fold-search t
3577 ispell-skip-html nil
)
3579 (setq continuep nil
)
3580 (if (looking-at "Content-Type: *text/")
3582 (goto-char (match-end 0))
3583 (if (looking-at "html")
3584 (setq ispell-skip-html t
))
3587 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3589 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3590 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3591 (setq textp
(member (upcase match
)
3592 ;; only spell check the following encodings:
3593 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3595 (goto-char (match-end 0))
3596 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3598 ;; hierarchical boundary definition
3599 (if (looking-at "Content-Type: *multipart/")
3600 (let ((new-boundary (ispell-mime-multipartp)))
3601 (if (string-match new-boundary boundary
)
3603 ;; first pass redefine skip function to include new boundary
3604 ;;(re-search-backward boundary nil t)
3606 (setq ispell-checking-message
3608 (list new-boundary
'ispell-mime-skip-part new-boundary
)
3609 (if (eq t ispell-checking-message
) nil
3610 ispell-checking-message
))
3613 ;; Skip all MIME headers that don't affect spelling
3614 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3617 (goto-char (match-end 0))
3620 (setq case-fold-search save-case-fold-search
)
3623 ;; encoded message. Skip to boundary, or entire message.
3625 (goto-char (point-max))
3626 (re-search-forward boundary nil t
)
3632 (defun ispell-message ()
3633 "Check the spelling of a mail message or news post.
3634 Don't check spelling of message headers except the Subject field.
3635 Don't check included messages.
3637 To abort spell checking of a message region and send the message anyway,
3638 use the `x' command. (Any subsequent regions will be checked.)
3639 The `X' command aborts the message send so that you can edit the buffer.
3641 To spell-check whenever a message is sent, include the appropriate lines
3642 in your .emacs file:
3643 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3644 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3645 (add-hook 'mail-send-hook 'ispell-message)
3646 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3648 You can bind this to the key C-c i in GNUS or mail by adding to
3649 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3650 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3653 (goto-char (point-min))
3654 (let* (boundary mimep
3655 (ispell-skip-region-alist-save ispell-skip-region-alist
)
3656 ;; Nil when message came from outside (eg calling Emacs as editor)
3657 ;; Non-nil marker of end of headers.
3660 (concat "^" (regexp-quote mail-header-separator
) "$") nil t
))
3661 (end-of-headers ; Start of body.
3663 (or internal-messagep
3664 (re-search-forward "^$" nil t
)
3666 (limit (copy-marker ; End of region we will spell check.
3668 ((not ispell-message-text-end
) (point-max))
3669 ((char-or-string-p ispell-message-text-end
)
3670 (if (re-search-forward ispell-message-text-end nil t
)
3673 (t (min (point-max) (funcall ispell-message-text-end
))))))
3674 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3675 (if (and (boundp 'mail-yank-prefix
) mail-yank-prefix
)
3676 (ispell-non-empty-string mail-yank-prefix
)
3678 (cite-regexp ;Prefix of quoted text
3680 ((functionp 'sc-cite-regexp
) ; sc 3.0
3682 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3683 (ispell-non-empty-string sc-reference-tag-string
))))
3684 ((boundp 'sc-cite-regexp
) ; sc 2.3
3685 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
3687 (ispell-non-empty-string sc-reference-tag-string
))))
3688 ((or (equal major-mode
'news-reply-mode
) ;GNUS 4 & below
3689 (equal major-mode
'message-mode
)) ;GNUS 5
3690 (concat "In article <" "\\|"
3691 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3692 (with-no-warnings message-cite-prefix-regexp
)
3695 ((equal major-mode
'mh-letter-mode
) ; mh mail message
3696 (concat "[^,;&+=\n]+ writes:" "\\|"
3698 (ispell-non-empty-string mh-ins-buf-prefix
))))
3699 ((not internal-messagep
) ; Assume nn sent us this message.
3700 (concat "In [a-zA-Z.]+ you write:" "\\|"
3701 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3703 ((boundp 'vm-included-text-prefix
) ; VM mail message
3704 (concat "[^,;&+=\n]+ writes:" "\\|"
3705 (ispell-non-empty-string vm-included-text-prefix
)))
3706 (t default-prefix
)))
3707 (ispell-skip-region-alist
3708 (cons (list (concat "^\\(" cite-regexp
"\\)")
3709 (function forward-line
))
3710 ispell-skip-region-alist
))
3711 (old-case-fold-search case-fold-search
)
3712 (dictionary-alist ispell-message-dictionary-alist
)
3713 (ispell-checking-message t
))
3715 ;; Select dictionary for message
3716 (or (local-variable-p 'ispell-local-dictionary
(current-buffer))
3717 (while dictionary-alist
3718 (goto-char (point-min))
3719 (if (re-search-forward (car (car dictionary-alist
))
3721 (setq ispell-local-dictionary
(cdr (car dictionary-alist
))
3722 dictionary-alist nil
)
3723 (setq dictionary-alist
(cdr dictionary-alist
)))))
3727 ;; Spell check any original Subject:
3728 (goto-char (point-min))
3729 (setq case-fold-search t
3730 mimep
(re-search-forward "MIME-Version:" end-of-headers t
))
3731 (goto-char (point-min))
3732 (if (re-search-forward "^Subject: *" end-of-headers t
)
3734 (goto-char (match-end 0))
3735 (if (and (not (looking-at ".*Re\\>"))
3736 (not (looking-at "\\[")))
3738 (setq case-fold-search old-case-fold-search
)
3739 (ispell-region (point)
3740 (progn ;Tab-initiated continuation lns.
3742 (while (looking-at "\n[ \t]")
3747 (goto-char (point-min))
3748 (setq boundary
(ispell-mime-multipartp end-of-headers
))))
3749 ;; Adjust message limit to MIME message if necessary.
3751 (re-search-forward (concat boundary
"--") nil t
)
3752 (re-search-backward boundary nil t
)
3753 (< (point) (marker-position limit
))
3754 (set-marker limit
(point)))
3755 (goto-char (point-min))
3756 ;; Select type or skip checking if this is a non-multipart message
3757 ;; Point moved to end of buffer if region is encoded.
3758 (if (and mimep
(not boundary
))
3759 (let (skip-regexp) ; protect from `ispell-mime-skip-part'
3760 (goto-char (point-min))
3761 (re-search-forward "Content-[^ \t]*:" end-of-headers t
)
3762 (forward-line -
1) ; following fn starts one line above
3763 (ispell-mime-skip-part nil
)
3764 ;; if message-text-end region, limit may be less than point.
3765 (if (> (point) limit
)
3766 (set-marker limit
(point)))))
3767 (goto-char (max end-of-headers
(point)))
3769 (setq case-fold-search old-case-fold-search
)
3770 ;; Define MIME regions to skip.
3772 (setq ispell-checking-message
3773 (list (list boundary
'ispell-mime-skip-part boundary
))))
3774 (ispell-region (point) limit
))
3775 (set-marker end-of-headers nil
)
3776 (set-marker limit nil
)
3777 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3778 ispell-skip-html nil
3779 case-fold-search old-case-fold-search
)))))
3782 (defun ispell-non-empty-string (string)
3783 (if (or (not string
) (string-equal string
""))
3784 "\\'\\`" ; An unmatchable string if string is null.
3785 (regexp-quote string
)))
3788 ;;; **********************************************************************
3789 ;;; Buffer Local Functions
3790 ;;; **********************************************************************
3793 (defun ispell-accept-buffer-local-defs ()
3794 "Load all buffer-local information, restarting Ispell when necessary."
3795 (ispell-buffer-local-dict) ; May kill ispell-process.
3796 (ispell-buffer-local-words) ; Will initialize ispell-process.
3797 (ispell-buffer-local-parsing))
3800 (defun ispell-buffer-local-parsing ()
3801 "Place Ispell into parsing mode for this buffer.
3802 Overrides the default parsing mode.
3803 Includes Latex/Nroff modes and extended character mode."
3804 ;; (ispell-init-process) must already be called.
3805 (ispell-send-string "!\n") ; Put process in terse mode.
3806 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3807 ;; When exclusively checking comments, set to raw text mode (nroff).
3808 (if (and (not (eq 'exclusive ispell-check-comments
))
3809 (or (and (eq ispell-parser
'use-mode-name
)
3810 (string-match "[Tt][Ee][Xx]-mode"
3811 (symbol-name major-mode
)))
3812 (eq ispell-parser
'tex
)))
3814 (ispell-send-string "+\n") ; set ispell mode to tex
3815 (if (not (eq ispell-parser
'tex
))
3816 (set (make-local-variable 'ispell-parser
) 'tex
)))
3817 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3818 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3819 (if (and ispell-skip-html
(not (eq ispell-skip-html t
)))
3820 (setq ispell-skip-html
3821 (not (null (string-match "sgml\\|html\\|xml"
3822 (downcase (symbol-name major-mode
)))))))
3823 ;; Set default extended character mode for given buffer, if any.
3824 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3825 (if extended-char-mode
3826 (ispell-send-string (concat extended-char-mode
"\n"))))
3827 ;; Set buffer-local parsing mode and extended character mode, if specified.
3829 (goto-char (point-max))
3830 ;; Uses last occurrence of ispell-parsing-keyword
3831 (if (search-backward ispell-parsing-keyword nil t
)
3832 (let ((end (save-excursion (end-of-line) (point)))
3834 (search-forward ispell-parsing-keyword
)
3835 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
3836 ;; space separated definitions.
3837 (setq string
(downcase (match-string-no-properties 1)))
3838 (cond ((and (string-match "latex-mode" string
)
3839 (not (eq 'exclusive ispell-check-comments
)))
3840 (ispell-send-string "+\n~tex\n"))
3841 ((string-match "nroff-mode" string
)
3842 (ispell-send-string "-\n~nroff\n"))
3843 ((string-match "~" string
) ; Set extended character mode.
3844 (ispell-send-string (concat string
"\n")))
3845 (t (message "Invalid Ispell Parsing argument!")
3849 ;;; Can kill the current ispell process
3851 (defun ispell-buffer-local-dict (&optional no-reload
)
3852 "Initializes local dictionary and local personal dictionary.
3853 If optional NO-RELOAD is non-nil, do not make any dictionary reloading.
3854 When a dictionary is defined in the buffer (see variable
3855 `ispell-dictionary-keyword'), it will override the local setting
3856 from \\[ispell-change-dictionary].
3857 Both should not be used to define a buffer-local dictionary."
3859 (goto-char (point-min))
3861 ;; Override the local variable definition.
3862 ;; Uses last occurrence of ispell-dictionary-keyword.
3863 (goto-char (point-max))
3864 (unless ispell-local-dictionary-overridden
3865 (if (search-backward ispell-dictionary-keyword nil t
)
3867 (search-forward ispell-dictionary-keyword
)
3868 (setq end
(save-excursion (end-of-line) (point)))
3869 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3870 (setq ispell-local-dictionary
3871 (match-string-no-properties 1))))))
3872 (goto-char (point-max))
3873 (if (search-backward ispell-pdict-keyword nil t
)
3875 (search-forward ispell-pdict-keyword
)
3876 (setq end
(save-excursion (end-of-line) (point)))
3877 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3878 (setq ispell-local-pdict
3879 (match-string-no-properties 1)))))))
3881 ;; Reload if new dictionary (maybe the personal one) defined.
3882 (ispell-internal-change-dictionary)))
3885 (defun ispell-buffer-local-words ()
3886 "Load the buffer-local dictionary in the current buffer."
3887 ;; If there's an existing ispell process that's wrong for this use,
3889 (if (and ispell-buffer-local-name
3890 (not (equal ispell-buffer-local-name
(buffer-name))))
3891 (ispell-kill-ispell t
))
3892 ;; Actually start a new ispell process, because we need
3893 ;; to send commands now to specify the local words to it.
3894 (ispell-init-process)
3896 (goto-char (point-min))
3897 (while (search-forward ispell-words-keyword nil t
)
3898 (or ispell-buffer-local-name
3899 (setq ispell-buffer-local-name
(buffer-name)))
3900 (let ((end (save-excursion (end-of-line) (point)))
3901 (ispell-casechars (ispell-get-casechars))
3903 ;; buffer-local words separated by a space, and can contain
3904 ;; any character other than a space. Not rigorous enough.
3905 (while (re-search-forward " *\\([^ ]+\\)" end t
)
3906 (setq string
(match-string-no-properties 1))
3907 ;; This can fail when string contains a word with invalid chars.
3908 ;; Error handling needs to be added between ispell and Emacs.
3909 (if (and (< 1 (length string
))
3910 (equal 0 (string-match ispell-casechars string
)))
3911 (ispell-send-string (concat "@" string
"\n"))))))))
3914 ;;; returns optionally adjusted region-end-point.
3916 (defun ispell-add-per-file-word-list (word)
3917 "Add WORD to the per-file word list."
3918 (or ispell-buffer-local-name
3919 (setq ispell-buffer-local-name
(buffer-name)))
3921 (goto-char (point-min))
3922 (let ((old-case-fold-search case-fold-search
)
3923 line-okay search done found
)
3925 (setq case-fold-search nil
3926 search
(search-forward ispell-words-keyword nil
'move
)
3927 found
(or found search
)
3928 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
3929 (progn (end-of-line) (current-column)))
3931 case-fold-search old-case-fold-search
)
3932 (if (or (and search line-okay
)
3939 (unless found
(newline))
3940 (insert (concat comment-start
" " ispell-words-keyword
))
3941 (if (> (length comment-end
) 0)
3944 (insert comment-end
)))))
3945 (insert (concat " " word
))))))))
3947 (add-to-list 'debug-ignored-errors
"^No word found to check!$")
3952 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3954 ;; Local Variable options:
3955 ;; mode: name(-mode)
3957 ;; local-variable: value
3959 ;; The following sets the buffer local dictionary to `american' English
3960 ;; and spell checks only comments.
3964 ;; comment-column: 40
3965 ;; ispell-check-comments: exclusive
3966 ;; ispell-local-dictionary: "american"
3970 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3972 ;; The following places this file in nroff parsing and extended char modes.
3973 ;; Local IspellParsing: nroff-mode ~nroff
3974 ;; Change IspellPersDict to IspellPersDict: to enable the following line.
3975 ;; Local IspellPersDict ~/.ispell_lisp
3976 ;; The following were automatically generated by ispell using the 'A' command:
3977 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3978 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3979 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3980 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3981 ; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3982 ; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3983 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
3984 ; LocalWords: lns XEmacs HTML casechars Multibyte
3986 ;; arch-tag: 4941b9f9-3b7c-4a76-a4ed-5fa8b6010ef5
3987 ;;; ispell.el ends here