1 ;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
3 ;; Copyright (C) 1994-1995, 1997-2013 Free Software Foundation, Inc.
5 ;; Author: Ken Stevens <k.stevens@ieee.org>
6 ;; Maintainer: Ken Stevens <k.stevens@ieee.org>
7 ;; Stevens Mod Date: Mon Jan 7 12:32:44 PST 2003
8 ;; Stevens Revision: 3.6
9 ;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
10 ;; Bug Reports : ispell-el-bugs@itcorp.com
11 ;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Note: version numbers and time stamp are not updated
30 ;; when this file is edited for release with GNU Emacs.
36 ;; This code contains a section of user-settable variables that you
37 ;; should inspect prior to installation. Look past the end of the history
38 ;; list. Set them up for your locale and the preferences of the majority
39 ;; of the users. Otherwise the users may need to set a number of variables
41 ;; You particularly may want to change the default dictionary for your
42 ;; country and language.
43 ;; Most dictionary changes should be made in this file so all users can
44 ;; enjoy them. Local or modified dictionaries are supported in your .emacs
45 ;; file. Use the variable `ispell-local-dictionary-alist' to specify
46 ;; your own dictionaries.
48 ;; Depending on the mail system you use, you may want to include these:
49 ;; (add-hook 'news-inews-hook 'ispell-message)
50 ;; (add-hook 'mail-send-hook 'ispell-message)
51 ;; (add-hook 'mh-before-send-letter-hook 'ispell-message)
53 ;; Ispell has a TeX parser and a nroff parser (the default).
54 ;; The parsing is controlled by the variable ispell-parser. Currently
55 ;; it is just a "toggle" between TeX and nroff, but if more parsers are
56 ;; added it will be updated. See the variable description for more info.
65 ;; ispell-comments-and-strings
67 ;; ispell-complete-word
68 ;; ispell-complete-word-interior-frag
69 ;; ispell-change-dictionary
72 ;; ispell-skip-region-alist
74 ;; Commands in ispell-region:
75 ;; Character replacement: Replace word with choice. May query-replace.
76 ;; ` ': Accept word this time.
77 ;; `i': Accept word and insert into private dictionary.
78 ;; `a': Accept word for this session.
79 ;; `A': Accept word and place in buffer-local dictionary.
80 ;; `r': Replace word with typed-in value. Rechecked.
81 ;; `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
82 ;; `?': Show these commands
83 ;; `x': Exit spelling buffer. Move cursor to original point.
84 ;; `X': Exit spelling buffer. Leaves cursor at the current point, and permits
85 ;; the check to be completed later.
86 ;; `q': Quit spelling session (Kills ispell process).
87 ;; `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
88 ;; `u': Like `i', but the word is lower-cased first.
89 ;; `m': Place entered value in personal dictionary, then recheck current word.
90 ;; `C-l': redraws screen
91 ;; `C-r': recursive edit
92 ;; `C-z': suspend Emacs or iconify frame
94 ;; Buffer-Local features:
95 ;; There are a number of buffer-local features that can be used to customize
96 ;; ispell for the current buffer. This includes language dictionaries,
97 ;; personal dictionaries, parsing, and local word spellings. Each of these
98 ;; local customizations are done either through local variables, or by
99 ;; including the keyword and argument(s) at the end of the buffer (usually
100 ;; prefixed by the comment characters). See the end of this file for
101 ;; examples. The local keywords and variables are:
103 ;; ispell-dictionary-keyword language-dictionary
104 ;; uses local variable ispell-local-dictionary
105 ;; ispell-pdict-keyword personal-dictionary
106 ;; uses local variable ispell-local-pdict
107 ;; ispell-parsing-keyword mode-arg extended-char-arg
108 ;; ispell-words-keyword any number of local word spellings
111 ;; Place new regular expression definitions of regions you prefer not to
112 ;; spell check in `ispell-skip-region-alist'. Mode-dependent features can
113 ;; be added to latex by modifying `ispell-tex-skip-alists'.
114 ;; `ispell-message' contains some custom skipping code for e-mail messages.
117 ;; Need a way to select between different character mappings without separate
118 ;; dictionary entries.
119 ;; Multi-byte characters if not defined by current dictionary may result in the
120 ;; evil "misalignment error" in some versions of MULE Emacs.
121 ;; On some versions of Emacs, growing the minibuffer fails.
122 ;; see `ispell-help-in-bufferp'.
123 ;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
124 ;; can cause misalignment errors.
128 ;; Modifications made in latest versions:
130 ;; Revision 3.6 2003/01/07 12:32:44 kss
131 ;; Removed extra -d LIB in dictionary defs. (Pavel Janik)
132 ;; Filtered process calls with duplicate dictionary entries.
133 ;; Fixed bug where message-text-end is inside a mime skipped region.
134 ;; Minor fixes to get ispell menus right in XEmacs
135 ;; Fixed skip regexp so it doesn't match stuff like `/.\w'.
136 ;; Detecting dictionary change not working. Fixed. kss
137 ;; function `ispell-change-dictionary' now only completes valid dicts.
139 ;; Revision 3.5 2001/7/11 18:43:57 kss
140 ;; Added fix for aspell to work in XEmacs (ispell-check-version).
141 ;; Added Portuguese dictionary definition.
142 ;; New feature: MIME mail message support, Fcc support.
143 ;; Bug fix: retain comment syntax on lines with region skipping. (TeX $ bug...)
144 ;; Improved allocation for graphic mode lines. (Miles Bader)
145 ;; Support -v flag for old versions of aspell. (Eli Zaretskii)
146 ;; Clear minibuffer on ^G from ispell-help (Tak Ota)
148 ;; Revision 3.4 2000/8/4 09:41:50 kss
149 ;; Support new color display functions.
150 ;; Fixed misalignment offset bug when replacing a string after a shift made.
151 ;; Set to standard Author/Maintainer heading,
152 ;; ensure localwords lists are separated from the text by newline. (Dave Love)
153 ;; Added dictionary definition for Italian (William Deakin)
154 ;; HTML region skipping greatly improved. (Chuck D. Phillips)
155 ;; improved menus. Fixed regexp matching http/email addresses.
156 ;; one arg always for XEmacs sleep-for (gunnar Evermann)
157 ;; support for synchronous processes (Eli Zaretskii)
159 ;; Revision 3.3 1999/11/29 11:38:34 kss
160 ;; Only word replacements entered in from the keyboard are rechecked.
161 ;; This fixes a bug in tex parsing and misalignment.
162 ;; Exceptions exist for recursive edit and query-replace, with tex error
163 ;; condition tested. Recursive editing improved.
164 ;; XEmacs repair for when `enable-multibyte-characters' defined - Didier Verna.
165 ;; ispell-help fixed for XEmacs. Choices minibuffer now displayed in XEmacs.
166 ;; Only list valid dictionaries in Spell menu. Russian dictionary doesn't allow
167 ;; run-together words, and uses koi8-r font. Don't skip text in html <TT>
170 ;; Revision 3.2 1999/5/7 14:25:14 kss
171 ;; Accept ispell versions 3.X.Y where X>=1
172 ;; fine tuned latex region skipping. Fixed bug in ispell-word that did not
173 ;; point in right place on words < 2 chars. Simplified ispell-minor-mode.
174 ;; Fixed bug in TeX parsing when math commands are in the comments.
175 ;; Removed calls to `when' macro.
177 ;; Revision 3.1 1998/12/1 13:21:52 kss
178 ;; Improved and fixed customize support.
179 ;; Improved and fixed comments in variables and messages.
180 ;; A coding system is now required for all languages.
181 ;; casechars improved for castellano, castellano8, and norsk dictionaries.
182 ;; Dictionary norsk7-tex removed. Dictionary polish added.
183 ;; Dictionaries redefined at load-time to support dictionary changes.
184 ;; Menu redefined at load time to support dictionary changes.
185 ;; ispell-check-version added as an alias for `check-ispell-version'.
186 ;; Spelling suggestions returned in order generated by ispell.
187 ;; Small bug fixed in matching ispell error messages.
188 ;; Robustness added to ensure `case-fold-search' doesn't get redefined.
189 ;; Fixed bug that didn't respect case of word in `ispell-complete-word'.
190 ;; Multibyte character coding support added for process interactions.
191 ;; Ensure ispell process has terminated before starting new process.
192 ;; This can otherwise confuse process filters and hang ispell.
193 ;; Improved skipping support for SGML.
194 ;; Fixed bug using ^M rather than \r in `ispell-minor-check'.
195 ;; Improved message reference matching in `ispell-message'.
196 ;; Fixed bug in returning to nroff mode from tex mode.
198 ;;; Compatibility code for XEmacs and (not too) older emacsen:
200 (eval-and-compile ;; Protect against declare-function undefined in XEmacs
201 (unless (fboundp 'declare-function
) (defmacro declare-function
(&rest r
))))
203 (declare-function ispell-check-minver
"ispell" (v1 v2
))
204 (declare-function ispell-looking-back
"ispell"
205 (regexp &optional limit
&rest ignored
))
207 (if (fboundp 'version
<=)
208 (defalias 'ispell-check-minver
'version
<=)
209 (defun ispell-check-minver (minver version
)
210 "Check if string VERSION is at least string MINVER.
211 Both must be in [0-9]+.[0-9]+... format. This is a fallback
212 compatibility function in case `version<=' is not available."
215 start-ver start-mver
)
216 ;; Loop until an absolute greater or smaller condition is reached
217 ;; or until no elements are left in any of version and minver. In
218 ;; this case version is exactly the minimal, so return OK.
221 (if (string-match "[0-9]+" version start-ver
)
222 (setq start-ver
(match-end 0)
223 ver
(string-to-number (match-string 0 version
))))
224 (if (string-match "[0-9]+" minver start-mver
)
225 (setq start-mver
(match-end 0)
226 mver
(string-to-number (match-string 0 minver
))))
230 (or ver
(setq ver
0))
231 (or mver
(setq mver
0))
232 ;; If none of below conditions match, this element is the
233 ;; same. Go checking next element.
239 (setq pending nil
))))
242 ;; XEmacs does not have looking-back
243 (if (fboundp 'looking-back
)
244 (defalias 'ispell-looking-back
'looking-back
)
245 (defun ispell-looking-back (regexp &optional limit
&rest ignored
)
246 "Return non-nil if text before point matches regular expression REGEXP.
247 Like `looking-at' except matches before point, and is slower.
248 LIMIT if non-nil speeds up the search by specifying a minimum
249 starting position, to avoid checking matches that would start
252 This is a stripped down compatibility function for use when
253 full featured `looking-back' function is missing."
255 (re-search-backward (concat "\\(?:" regexp
"\\)\\=") limit t
))))
257 ;;; XEmacs21 does not have `with-no-warnings'. Taken from org mode.
258 (defmacro ispell-with-no-warnings
(&rest body
)
259 (cons (if (fboundp 'with-no-warnings
) 'with-no-warnings
'progn
) body
))
263 (defvar mail-yank-prefix
)
266 "User variables for Emacs ispell interface."
267 :group
'applications
)
269 (if (not (fboundp 'buffer-substring-no-properties
))
270 (defun buffer-substring-no-properties (start end
)
271 (buffer-substring start end
)))
273 (defalias 'check-ispell-version
'ispell-check-version
)
275 ;;; **********************************************************************
276 ;;; The following variables should be set according to personal preference
277 ;;; and location of binaries:
278 ;;; **********************************************************************
281 ;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
283 (defcustom ispell-highlight-p
'block
284 "Highlight spelling errors when non-nil.
285 When set to `block', assumes a block cursor with TTY displays."
286 :type
'(choice (const block
) (const :tag
"off" nil
) (const :tag
"on" t
))
289 (defcustom ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
)
290 "Controls the lazy-highlighting of spelling errors.
291 When non-nil, all text in the buffer matching the current spelling
292 error is highlighted lazily using isearch lazy highlighting (see
293 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
295 :group
'lazy-highlight
299 (defcustom ispell-highlight-face
(if ispell-lazy-highlight
'isearch
'highlight
)
300 "Face used for Ispell highlighting.
301 This variable can be set by the user to whatever face they desire.
302 It's most convenient if the cursor color and highlight color are
307 (defcustom ispell-check-comments t
308 "Spelling of comments checked when non-nil.
309 When set to `exclusive', ONLY comments are checked. (For code comments).
310 Warning! Not checking comments, when a comment start is embedded in strings,
311 may produce undesired results."
312 :type
'(choice (const exclusive
) (const :tag
"off" nil
) (const :tag
"on" t
))
315 (put 'ispell-check-comments
'safe-local-variable
316 (lambda (a) (memq a
'(nil t exclusive
))))
318 (defcustom ispell-query-replace-choices nil
319 "Corrections made throughout region when non-nil.
320 Uses `query-replace' (\\[query-replace]) for corrections."
324 (defcustom ispell-skip-tib nil
325 "Does not spell check `tib' bibliography references when non-nil.
326 Skips any text between strings matching regular expressions
327 `ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
329 TeX users beware: Any text between [. and .] will be skipped -- even if
330 that's your whole buffer -- unless you set `ispell-skip-tib' to nil.
331 That includes the [.5mm] type of number..."
335 (defvar ispell-tib-ref-beginning
"[[<]\\."
336 "Regexp matching the beginning of a Tib reference.")
338 (defvar ispell-tib-ref-end
"\\.[]>]"
339 "Regexp matching the end of a Tib reference.")
341 (defcustom ispell-keep-choices-win t
342 "If non-nil, keep the `*Choices*' window for the entire spelling session.
343 This minimizes redisplay thrashing."
347 (defcustom ispell-choices-win-default-height
2
348 "The default size of the `*Choices*' window, including the mode line.
349 Must be greater than 1."
353 (defcustom ispell-program-name
354 (or (executable-find "aspell")
355 (executable-find "ispell")
356 (executable-find "hunspell")
358 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
362 (defcustom ispell-alternate-dictionary
363 (cond ((file-readable-p "/usr/dict/web2") "/usr/dict/web2")
364 ((file-readable-p "/usr/share/dict/web2") "/usr/share/dict/web2")
365 ((file-readable-p "/usr/dict/words") "/usr/dict/words")
366 ((file-readable-p "/usr/lib/dict/words") "/usr/lib/dict/words")
367 ((file-readable-p "/usr/share/dict/words") "/usr/share/dict/words")
368 ((file-readable-p "/usr/share/lib/dict/words")
369 "/usr/share/lib/dict/words")
370 ((file-readable-p "/sys/dict") "/sys/dict"))
371 "Alternate plain word-list dictionary for spelling help."
372 :type
'(choice file
(const :tag
"None" nil
))
375 (defcustom ispell-complete-word-dict nil
376 "Plain word-list dictionary used for word completion if
377 different from `ispell-alternate-dictionary'."
378 :type
'(choice file
(const :tag
"None" nil
))
381 (defcustom ispell-message-dictionary-alist nil
382 "List used by `ispell-message' to select a new dictionary.
383 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
384 in the message headers, `ispell-local-dictionary' will be set to
385 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
386 E.g. you may use the following value:
387 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
388 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
389 :type
'(repeat (cons regexp string
))
393 (defcustom ispell-message-fcc-skip
50000
394 "Query before saving Fcc message copy if attachment larger than this value.
395 Always stores Fcc copy of message when nil."
396 :type
'(choice integer
(const :tag
"off" nil
))
400 (defcustom ispell-grep-command
401 ;; MS-Windows/MS-DOS have `egrep' as a Unix shell script, so they
402 ;; cannot invoke it. Use "grep -E" instead (see ispell-grep-options
404 (if (memq system-type
'(windows-nt ms-dos
)) "grep" "egrep")
405 "Name of the grep command for search processes."
409 (defcustom ispell-grep-options
410 (if (memq system-type
'(windows-nt ms-dos
)) "-Ei" "-i")
411 "String of options to use when running the program in `ispell-grep-command'.
412 Should probably be \"-i\" or \"-e\".
413 Some machines (like the NeXT) don't support \"-i\"."
417 (defcustom ispell-look-command
418 (cond ((file-exists-p "/bin/look") "/bin/look")
419 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
420 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
422 "Name of the look command for search processes.
423 This must be an absolute file name."
427 (defcustom ispell-look-p
(file-exists-p ispell-look-command
)
428 "Non-nil means use `look' rather than `grep'.
429 Default is based on whether `look' seems to be available."
433 (defcustom ispell-have-new-look nil
434 "Non-nil means use the `-r' option (regexp) when running `look'."
438 (defcustom ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
439 "String of command options for `ispell-look-command'."
443 (defcustom ispell-use-ptys-p nil
444 "When non-nil, Emacs uses ptys to communicate with Ispell.
445 When nil, Emacs uses pipes."
449 (defcustom ispell-following-word nil
450 "Non-nil means `ispell-word' checks the word around or after point.
451 Otherwise `ispell-word' checks the preceding word."
455 (defcustom ispell-help-in-bufferp nil
456 "Non-nil means display interactive keymap help in a buffer.
457 The following values are supported:
458 nil Expand the minibuffer and display a short help message
459 there for a couple of seconds.
460 t Pop up a new buffer and display a short help message there
461 for a couple of seconds.
462 electric Pop up a new buffer and display a long help message there.
463 User can browse and then exit the help mode."
464 :type
'(choice (const electric
) (const :tag
"off" nil
) (const :tag
"on" t
))
467 (defcustom ispell-quietly nil
468 "Non-nil means suppress messages in `ispell-word'."
472 (defcustom ispell-format-word-function
(function upcase
)
473 "Formatting function for displaying word being spell checked.
474 The function must take one string argument and return a string."
477 (defvaralias 'ispell-format-word
'ispell-format-word-function
)
479 (defcustom ispell-use-framepop-p nil
480 "When non-nil ispell uses framepop to display choices in a dedicated frame.
481 You can set this variable to dynamically use framepop if you are in a
482 window system by evaluating the following on startup to set this variable:
483 (and window-system (condition-case () (require 'framepop) (error nil)))"
488 (defcustom ispell-personal-dictionary nil
489 "File name of your personal spelling dictionary, or nil.
490 If nil, the default personal dictionary, (\"~/.ispell_DICTNAME\" for ispell or
491 \"~/.aspell.LANG.pws\" for aspell) is used, where DICTNAME is the name of your
492 default dictionary and LANG the two letter language code."
494 (const :tag
"default" nil
))
497 (defcustom ispell-silently-savep nil
498 "When non-nil, save personal dictionary without asking for confirmation."
502 (defvar ispell-local-dictionary-overridden nil
503 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
504 (make-variable-buffer-local 'ispell-local-dictionary-overridden
)
506 (defcustom ispell-local-dictionary nil
507 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
508 The value must be a string dictionary name,
509 or nil, which means use the global setting in `ispell-dictionary'.
510 Dictionary names are defined in `ispell-local-dictionary-alist'
511 and `ispell-dictionary-alist'.
513 Setting `ispell-local-dictionary' to a value has the same effect as
514 calling \\[ispell-change-dictionary] with that value. This variable
515 is automatically set when defined in the file with either
516 `ispell-dictionary-keyword' or the Local Variable syntax."
517 :type
'(choice string
518 (const :tag
"default" nil
))
521 (put 'ispell-local-dictionary
'safe-local-variable
'string-or-null-p
)
523 (make-variable-buffer-local 'ispell-local-dictionary
)
525 (defcustom ispell-dictionary nil
526 "Default dictionary to use if `ispell-local-dictionary' is nil."
527 :type
'(choice string
528 (const :tag
"default" nil
))
531 (defcustom ispell-extra-args nil
532 "If non-nil, a list of extra switches to pass to the Ispell program.
533 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
534 words as correct. See also `ispell-dictionary-alist', which may be used
535 for language-specific arguments."
536 :type
'(repeat string
)
541 (defcustom ispell-skip-html
'use-mode-name
542 "Indicates whether ispell should skip spell checking of SGML markup.
543 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
544 guess whether SGML markup should be skipped according to the name of the
545 buffer's major mode."
546 :type
'(choice (const :tag
"always" t
) (const :tag
"never" nil
)
547 (const :tag
"use-mode-name" use-mode-name
))
550 (make-variable-buffer-local 'ispell-skip-html
)
553 (defcustom ispell-local-dictionary-alist nil
554 "List of local or customized dictionary definitions.
555 These can override the values in `ispell-dictionary-alist'.
557 To make permanent changes to your dictionary definitions, you
558 will need to make your changes in this variable, save, and then
560 :type
'(repeat (list (choice :tag
"Dictionary"
561 (string :tag
"Dictionary name")
562 (const :tag
"default" nil
))
563 (regexp :tag
"Case characters")
564 (regexp :tag
"Non case characters")
565 (regexp :tag
"Other characters")
566 (boolean :tag
"Many other characters")
567 (repeat :tag
"Ispell command line args"
569 (choice :tag
"Extended character mode"
570 (const "~tex") (const "~plaintex")
571 (const "~nroff") (const "~list")
572 (const "~latin1") (const "~latin3")
573 (const :tag
"default" nil
))
574 (coding-system :tag
"Coding System")))
578 (defvar ispell-dictionary-base-alist
580 ;; The default dictionary. It may be English.aff, or any other
581 ;; dictionary depending on locale and such things. We should probably
582 ;; ask ispell what dictionary it's using, but until we do that, let's
583 ;; just use a minimal regexp. [:alpha:] will later be set if possible.
584 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
585 ("american" ; Yankee English
586 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
587 ("brasileiro" ; Brazilian mode
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 "[^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]"
590 "[']" nil nil nil iso-8859-1
)
591 ("british" ; British version
592 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
593 ("castellano" ; Spanish mode
594 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
595 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
596 "[-]" nil
("-B") "~tex" iso-8859-1
)
597 ("castellano8" ; 8 bit Spanish mode
598 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
599 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
600 "[-]" nil
("-B" "-d" "castellano") "~latin1" iso-8859-1
)
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 "[^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]"
604 "" nil
("-B") nil iso-8859-2
)
606 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
607 "[']" nil
("-C") nil iso-8859-1
)
608 ("deutsch" ; Deutsch.aff
609 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
611 "[a-zA-Z\304\326\334\344\366\337\374]"
612 "[^a-zA-Z\304\326\334\344\366\337\374]"
613 "[']" t
("-C" "-d" "deutsch") "~latin1" iso-8859-1
)
614 ("english" ; make English explicitly selectable
615 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
617 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
618 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
619 "[-']" t
("-C") "~latin3" iso-8859-3
)
621 "[A-Za-z^\\]" "[^A-Za-z^\\]"
622 "[-'`\"]" t
("-C" "-d" "esperanto") "~tex" iso-8859-3
)
624 "[A-Za-z\345\344\366\305\304\326]"
625 "[^A-Za-z\345\344\366\305\304\326]"
626 "[:]" nil
("-C") "~list" iso-8859-1
)
628 "[A-Za-z]" "[^A-Za-z]" "[`'^-]" t nil nil iso-8859-1
)
629 ("francais" ; Francais.aff
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 "[^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]"
632 "[-'.@]" t nil
"~list" iso-8859-1
)
633 ("francais-tex" ; Francais.aff
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 "[^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\\]"
636 "[-'^`\".@]" t nil
"~tex" iso-8859-1
)
637 ("german" ; german.aff
638 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
639 ("german8" ; german.aff
640 "[a-zA-Z\304\326\334\344\366\337\374]"
641 "[^a-zA-Z\304\326\334\344\366\337\374]"
642 "[']" t
("-C" "-d" "german") "~latin1" iso-8859-1
)
643 ("italiano" ; Italian.aff
644 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
645 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
646 "[-.]" nil
("-B" "-d" "italian") "~tex" iso-8859-1
)
647 ("nederlands" ; Nederlands.aff
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 "[^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]"
650 "[']" t
("-C") nil iso-8859-1
)
651 ("nederlands8" ; Dutch8.aff
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 "[^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]"
654 "[']" t
("-C") nil iso-8859-1
)
655 ("norsk" ; 8 bit Norwegian mode
656 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
657 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
658 "[\"]" nil nil
"~list" iso-8859-1
)
659 ("norsk7-tex" ; 7 bit Norwegian TeX mode
660 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
661 "[\"]" nil
("-d" "norsk") "~plaintex" iso-8859-1
)
662 ("polish" ; Polish mode
663 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
664 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
665 "[.]" nil nil nil iso-8859-2
)
666 ("portugues" ; Portuguese mode
667 "[a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
668 "[^a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
669 "[']" t
("-C") "~latin1" iso-8859-1
)
670 ("russian" ; Russian.aff (KOI8-R charset)
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 "[^\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]"
673 "" nil nil nil koi8-r
)
674 ("russianw" ; russianw.aff (CP1251 charset)
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 "[^\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]"
677 "" nil nil nil windows-1251
)
678 ("slovak" ; Slovakian
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 "[^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]"
681 "" nil
("-B") nil iso-8859-2
)
682 ("slovenian" ; Slovenian
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 "[^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]"
685 "" nil
("-B" "-d" "slovenian") nil iso-8859-2
)
686 ("svenska" ; Swedish mode
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 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
689 "[']" nil
("-C") "~list" iso-8859-1
)
690 ("hebrew" "[\340\341\342\343\344\345\346\347\350\351\353\352\354\356\355\360\357\361\362\364\363\367\366\365\370\371\372]" "[^\340\341\342\343\344\345\346\347\350\351\353\352\354\356\355\360\357\361\362\364\363\367\366\365\370\371\372]" "" nil
("-B") nil cp1255
))
691 "Base value for `ispell-dictionary-alist'.")
693 (defvar ispell-dictionary-alist nil
694 "An alist of dictionaries and their associated parameters.
696 Each element of this list is also a list:
698 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
699 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
701 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
702 nil means the default dictionary.
704 CASECHARS is a regular expression of valid characters that comprise a word.
706 NOT-CASECHARS is the opposite regexp of CASECHARS.
708 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
709 used to construct words in some special way. If OTHERCHARS characters follow
710 and precede characters from CASECHARS, they are parsed as part of a word,
711 otherwise they become word-breaks. As an example in English, assume the
712 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
713 \"Steven's\" are parsed as single words including the \"'\" character, but
714 \"Stevens'\" does not include the quote character as part of the word.
715 If you want OTHERCHARS to be empty, use the empty string.
716 Hint: regexp syntax requires the hyphen to be declared first here.
718 CASECHARS, NOT-CASECHARS, and OTHERCHARS must be unibyte strings
719 containing bytes of CHARACTER-SET. In addition, if they contain
720 non-ASCII bytes, the regular expression must be a single
721 `character set' construct that doesn't specify a character range
724 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
725 Otherwise only a single OTHERCHARS character is allowed to be part of any
728 ISPELL-ARGS is a list of additional arguments passed to the ispell
731 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
732 have been configured in an Ispell affix file. (For example, umlauts
733 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
734 in English. This has the same effect as the command-line `-T' option.
735 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
736 but the dictionary can control the extended character mode.
737 Both defaults can be overruled in a buffer-local fashion. See
738 `ispell-parsing-keyword' for details on this.
740 CHARACTER-SET used to encode text sent to the ispell subprocess
741 when the language uses non-ASCII characters.
743 Note that with \"ispell\" as the speller, the CASECHARS and
744 OTHERCHARS slots of the alist should contain the same character
745 set as casechars and otherchars in the LANGUAGE.aff file \(e.g.,
746 english.aff\). aspell and hunspell don't have this limitation.")
748 (defvar ispell-really-aspell nil
) ; Non-nil if we can use aspell extensions.
749 (defvar ispell-really-hunspell nil
) ; Non-nil if we can use hunspell extensions.
750 (defvar ispell-encoding8-command nil
751 "Command line option prefix to select encoding if supported, nil otherwise.
752 If setting the encoding is supported by spellchecker and is selectable from
753 the command line, this variable will contain \"--encoding=\" for aspell
754 and \"-i \" for hunspell, so the appropriate mime charset can be selected.
755 That will be set in `ispell-check-version' for hunspell >= 1.1.6 and
758 For aspell, non-nil also means to try to automatically find its dictionaries.
760 Earlier aspell versions do not consistently support charset encoding. Handling
761 this would require some extra guessing in `ispell-aspell-find-dictionary'.")
763 (defvar ispell-aspell-supports-utf8 nil
764 "Non-nil if aspell has consistent command line UTF-8 support. Obsolete.
765 ispell.el and flyspell.el will use for this purpose the more generic
766 variable `ispell-encoding8-command' for both aspell and hunspell. Is left
767 here just for backwards compatibility.")
769 (make-obsolete-variable 'ispell-aspell-supports-utf8
770 'ispell-encoding8-command
"23.1")
772 (defvar ispell-emacs-alpha-regexp
773 (if (string-match "^[[:alpha:]]+$" "abcde")
776 "[[:alpha:]] if Emacs supports [:alpha:] regexp, nil
777 otherwise (current XEmacs does not support it).")
779 ;;; **********************************************************************
780 ;;; The following are used by ispell, and should not be changed.
781 ;;; **********************************************************************
785 ;; The version must be 3.1 or greater for this version of ispell.el
786 ;; There is an incompatibility between version 3.1.12 and lower versions.
787 (defconst ispell-required-version
'(3 1 12)
788 "Ispell versions with which this version of ispell.el is known to work.")
789 (defvar ispell-offset -
1
790 "Offset that maps protocol differences between ispell 3.1 versions.")
792 (defconst ispell-version
"ispell.el 3.6 - 7-Jan-2003")
795 (defun ispell-check-version (&optional interactivep
)
796 "Ensure that `ispell-program-name' is valid and has the correct version.
797 Returns version number if called interactively.
798 Otherwise returns the library directory name, if that is defined."
799 ;; This is a little wasteful as we actually launch ispell twice: once
800 ;; to make sure it's the right version, and once for real. But people
801 ;; get confused by version mismatches *all* the time (and I've got the
802 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
803 ;; option is the only way I can think of to do this that works with
804 ;; all versions, since versions earlier than 3.0.09 didn't identify
805 ;; themselves on startup.
807 (let ((default-directory (or (and (boundp 'temporary-file-directory
)
808 temporary-file-directory
)
810 result status ispell-program-version
)
813 (setq status
(ispell-call-process
814 ispell-program-name nil t nil
815 ;; aspell doesn't accept the -vv switch.
816 (let ((case-fold-search
817 (memq system-type
'(ms-dos windows-nt
)))
819 (file-name-nondirectory ispell-program-name
)))
820 ;; Assume anything that isn't `aspell' is Ispell.
821 (if (string-match "\\`aspell" speller
) "-v" "-vv"))))
822 (goto-char (point-min))
824 ;; report version information of ispell and ispell.el
827 (setq result
(concat (buffer-substring-no-properties (point-min)
831 (message "%s" result
))
832 ;; return library directory.
833 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t
)
834 (setq result
(match-string 1))))
835 (goto-char (point-min))
836 (if (not (memq status
'(0 nil
)))
837 (error "%s exited with %s %s" ispell-program-name
838 (if (stringp status
) "signal" "code") status
))
840 ;; Get relevant version strings. Only xx.yy.... format works well
841 (let (case-fold-search)
842 (setq ispell-program-version
843 (and (search-forward-regexp "\\([0-9]+\\.[0-9\\.]+\\)" nil t
)
846 ;; Make sure these variables are (re-)initialized to the default value
847 (setq ispell-really-aspell nil
848 ispell-aspell-supports-utf8 nil
849 ispell-really-hunspell nil
850 ispell-encoding8-command nil
)
852 (goto-char (point-min))
853 (or (setq ispell-really-aspell
854 (and (search-forward-regexp
855 "(but really Aspell \\([0-9]+\\.[0-9\\.-]+\\)?)" nil t
)
857 (setq ispell-really-hunspell
858 (and (search-forward-regexp
859 "(but really Hunspell \\([0-9]+\\.[0-9\\.-]+\\)?)"
863 (let ((aspell-minver "0.50")
864 (aspell8-minver "0.60")
865 (ispell0-minver "3.1.0")
866 (ispell-minver "3.1.12")
867 (hunspell8-minver "1.1.6"))
869 (if (ispell-check-minver ispell0-minver ispell-program-version
)
870 (or (ispell-check-minver ispell-minver ispell-program-version
)
871 (setq ispell-offset
0))
872 (error "%s release %s or greater is required"
877 (ispell-really-aspell
878 (if (ispell-check-minver aspell-minver ispell-really-aspell
)
879 (if (ispell-check-minver aspell8-minver ispell-really-aspell
)
881 (setq ispell-aspell-supports-utf8 t
)
882 (setq ispell-encoding8-command
"--encoding=")))
883 (setq ispell-really-aspell nil
)))
884 (ispell-really-hunspell
885 (if (ispell-check-minver hunspell8-minver ispell-really-hunspell
)
886 (setq ispell-encoding8-command
"-i")
887 (setq ispell-really-hunspell nil
))))))
890 (defun ispell-call-process (&rest args
)
891 "Like `call-process' but defend against bad `default-directory'."
892 (let ((default-directory default-directory
))
893 (unless (and (file-directory-p default-directory
)
894 (file-readable-p default-directory
))
895 (setq default-directory
(expand-file-name "~/")))
896 (apply 'call-process args
)))
898 (defun ispell-call-process-region (&rest args
)
899 "Like `call-process-region' but defend against bad `default-directory'."
900 (let ((default-directory default-directory
))
901 (unless (and (file-directory-p default-directory
)
902 (file-readable-p default-directory
))
903 (setq default-directory
(expand-file-name "~/")))
904 (apply 'call-process-region args
)))
908 ;; The preparation of the menu bar menu must be autoloaded
909 ;; because otherwise this file gets autoloaded every time Emacs starts
910 ;; so that it can set up the menus and determine keyboard equivalents.
913 (defvar ispell-menu-map nil
"Key map for ispell menu.")
914 ;; Redo menu when loading ispell to get dictionary modifications
915 (setq ispell-menu-map nil
)
918 (defvar ispell-menu-xemacs nil
919 "Spelling menu for XEmacs.
920 If nil when package is loaded, a standard menu will be set,
921 and added as a submenu of the \"Edit\" menu.")
923 ;; Break out XEmacs menu and split into several calls to avoid having
924 ;; long lines in loaddefs.el. Detect need off following constant.
926 ;;; Set up dictionary
928 (defvar ispell-menu-map-needed
929 ;; only needed when not version 18 and not XEmacs.
930 (and (not ispell-menu-map
)
931 (not (featurep 'xemacs
))
934 (defvar ispell-library-directory
(condition-case ()
935 (ispell-check-version)
937 "Directory where ispell dictionaries reside.")
939 (defvar ispell-process nil
940 "The process object for Ispell.")
942 (defvar ispell-async-processp
(and (fboundp 'delete-process
)
943 (fboundp 'process-send-string
)
944 (fboundp 'accept-process-output
)
945 ;;(fboundp 'start-process)
946 ;;(fboundp 'set-process-filter)
947 ;;(fboundp 'process-kill-without-query)
949 "Non-nil means that the OS supports asynchronous processes.")
951 ;; Make ispell.el work better with aspell.
953 (defvar ispell-aspell-dictionary-alist nil
954 "An alist of parsed aspell dicts and associated parameters.
957 (defun ispell-find-aspell-dictionaries ()
958 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
959 (unless (and ispell-really-aspell ispell-encoding8-command
)
960 (error "This function only works with aspell >= 0.60"))
964 (ispell-call-process ispell-program-name nil t nil
"dicts")
966 ;; Search for the named dictionaries.
969 (mapcar #'ispell-aspell-find-dictionary dictionaries
))))
970 ;; Ensure aspell's alias dictionary will override standard
972 (setq found
(ispell-aspell-add-aliases found
))
973 ;; Merge into FOUND any elements from the standard ispell-dictionary-base-alist
974 ;; which have no element in FOUND at all.
975 (dolist (dict ispell-dictionary-base-alist
)
976 (unless (assoc (car dict
) found
)
977 (setq found
(nconc found
(list dict
)))))
978 (setq ispell-aspell-dictionary-alist found
)
979 ;; Add a default entry
981 '(nil "[[:alpha:]]" "[^[:alpha:]]" "[']" nil
("-B") nil utf-8
)))
982 (push default-dict ispell-aspell-dictionary-alist
))))
984 (defvar ispell-aspell-data-dir nil
985 "Data directory of Aspell.")
987 (defvar ispell-aspell-dict-dir nil
988 "Dictionary directory of Aspell.")
990 (defun ispell-get-aspell-config-value (key)
991 "Return value of Aspell configuration option KEY.
992 Assumes that value contains no whitespace."
994 (ispell-call-process ispell-program-name nil t nil
"config" key
)
995 (car (split-string (buffer-string)))))
997 (defun ispell-aspell-find-dictionary (dict-name)
998 "For aspell dictionary DICT-NAME, return a list of parameters if an
999 associated data file is found or nil otherwise. List format is that
1000 of `ispell-dictionary-base-alist' elements."
1001 ;; Make sure `ispell-aspell-data-dir' is defined
1002 (or ispell-aspell-data-dir
1003 (setq ispell-aspell-data-dir
1004 (ispell-get-aspell-config-value "data-dir")))
1005 ;; Try finding associated datafile
1007 (concat ispell-aspell-data-dir
"/"
1008 ;; Strip out variant, country code, etc.
1009 (and (string-match "^[[:alpha:]]+" dict-name
)
1010 (match-string 0 dict-name
)) ".dat"))
1012 (concat ispell-aspell-data-dir
"/"
1013 ;; Strip out anything but xx_YY.
1014 (and (string-match "^[[:alpha:]_]+" dict-name
)
1015 (match-string 0 dict-name
)) ".dat"))
1017 (if (file-readable-p datafile1
)
1019 (if (file-readable-p datafile2
)
1025 (insert-file-contents data-file
)
1026 ;; There is zero or one line with special characters declarations.
1027 (when (search-forward-regexp "^special" nil t
)
1028 (let ((specials (split-string
1029 (buffer-substring (point)
1030 (progn (end-of-line) (point))))))
1031 ;; The line looks like: special ' -** - -** . -** : -*-
1032 ;; -** means that this character
1033 ;; - doesn't appear at word start
1034 ;; * may appear in the middle of a word
1035 ;; * may appear at word end
1036 ;; `otherchars' is about the middle case.
1038 (when (eq (aref (cadr specials
) 1) ?
*)
1039 (push (car specials
) otherchars
))
1040 (setq specials
(cddr specials
)))))
1044 (regexp-opt otherchars
)
1045 t
; We can't tell, so set this to t
1046 (list "-d" dict-name
)
1047 nil
; aspell doesn't support this
1048 ;; Here we specify the encoding to use while communicating with
1049 ;; aspell. This doesn't apply to command line arguments, so
1050 ;; just don't pass words to spellcheck as arguments...
1053 (defun ispell-aspell-add-aliases (alist)
1054 "Find aspell's dictionary aliases and add them to dictionary ALIST.
1055 Return the new dictionary alist."
1057 (file-expand-wildcards
1058 (concat (or ispell-aspell-dict-dir
1059 (setq ispell-aspell-dict-dir
1060 (ispell-get-aspell-config-value "dict-dir")))
1062 (dolist (alias-file aliases
)
1064 (insert-file-contents alias-file
)
1065 ;; Look for a line "add FOO.multi", extract FOO
1066 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t
)
1067 (let* ((aliasname (file-name-base alias-file
))
1068 (already-exists-p (assoc aliasname alist
))
1069 (realname (match-string 1))
1070 (realdict (assoc realname alist
)))
1071 (when (and realdict
(not already-exists-p
))
1072 (push (cons aliasname
(cdr realdict
)) alist
))))))
1075 ;; Set params according to the selected spellchecker
1077 (defvar ispell-last-program-name nil
1078 "Last value of `ispell-program-name'. Internal use.")
1080 (defvar ispell-initialize-spellchecker-hook nil
1081 "Normal hook run on spellchecker initialization.
1082 This hook is run when a spellchecker is used for the first
1083 time, before `ispell-dictionary-alist' is set. It is intended for
1084 sysadmins to override entries in `ispell-dictionary-base-alist'
1085 by putting those overrides in `ispell-base-dicts-override-alist', which is
1086 a dynamically scoped var with same format as `ispell-dictionary-alist'.
1087 This alist will not override the auto-detected values (e.g. if a recent
1088 aspell is used along with Emacs).")
1090 (defun ispell-set-spellchecker-params ()
1091 "Initialize some spellchecker parameters when changed or first used."
1092 (unless (eq ispell-last-program-name ispell-program-name
)
1093 (setq ispell-last-program-name ispell-program-name
)
1094 (ispell-kill-ispell t
)
1095 (if (and (condition-case ()
1097 (setq ispell-library-directory
(ispell-check-version))
1100 ispell-really-aspell
1101 ispell-encoding8-command
1102 ispell-emacs-alpha-regexp
)
1103 (unless ispell-aspell-dictionary-alist
1104 (ispell-find-aspell-dictionaries)))
1106 ;; Substitute ispell-dictionary-alist with the list of dictionaries
1107 ;; corresponding to the given spellchecker. If a recent aspell, use
1108 ;; the list of really installed dictionaries and add to it elements
1109 ;; of the original list that are not present there. Allow distro info.
1110 (let ((found-dicts-alist
1111 (if (and ispell-really-aspell
1112 ispell-encoding8-command
)
1113 ispell-aspell-dictionary-alist
1115 ispell-base-dicts-override-alist
; Override only base-dicts-alist
1118 (run-hooks 'ispell-initialize-spellchecker-hook
)
1120 ;; Add dicts to ``ispell-dictionary-alist'' unless already present.
1121 (dolist (dict (append found-dicts-alist
1122 ispell-base-dicts-override-alist
1123 ispell-dictionary-base-alist
))
1124 (unless (assoc (car dict
) all-dicts-alist
)
1125 (add-to-list 'all-dicts-alist dict
)))
1126 (setq ispell-dictionary-alist all-dicts-alist
))
1128 ;; If Emacs flavor supports [:alpha:] use it for global dicts. If
1129 ;; spellchecker also supports UTF-8 via command-line option use it
1130 ;; in communication. This does not affect definitions in your
1132 (if ispell-emacs-alpha-regexp
1133 (let (tmp-dicts-alist)
1134 (dolist (adict ispell-dictionary-alist
)
1135 (add-to-list 'tmp-dicts-alist
1137 (nth 0 adict
) ; dict name
1138 "[[:alpha:]]" ; casechars
1139 "[^[:alpha:]]" ; not-casechars
1140 (nth 3 adict
) ; otherchars
1141 (nth 4 adict
) ; many-otherchars-p
1142 (nth 5 adict
) ; ispell-args
1143 (nth 6 adict
) ; extended-character-mode
1144 (if ispell-encoding8-command
1147 (setq ispell-dictionary-alist tmp-dicts-alist
)))))
1149 (defun ispell-valid-dictionary-list ()
1150 "Return a list of valid dictionaries.
1151 The variable `ispell-library-directory' defines their location."
1152 ;; Initialize variables and dictionaries alists for desired spellchecker.
1153 ;; Make sure ispell.el is loaded to avoid some autoload loops in XEmacs
1154 ;; (and may be others)
1155 (if (featurep 'ispell
)
1156 (ispell-set-spellchecker-params))
1158 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist
))
1159 (dict-list (cons "default" nil
))
1161 (dolist (dict dicts
)
1162 (setq name
(car dict
)
1163 dict-bname
(or (car (cdr (member "-d" (nth 5 dict
))))
1165 ;; Include if the dictionary is in the library, or dir not defined.
1168 ;; For Aspell, we already know which dictionaries exist.
1169 (or ispell-really-aspell
1170 ;; Include all dictionaries if lib directory not known.
1171 ;; Same for Hunspell, where ispell-library-directory is nil.
1172 (not ispell-library-directory
)
1173 (file-exists-p (concat ispell-library-directory
1174 "/" dict-bname
".hash"))
1175 (file-exists-p (concat ispell-library-directory
1176 "/" dict-bname
".has"))))
1177 (push name dict-list
)))
1180 ;; Define commands in menu in opposite order you want them to appear.
1182 (if ispell-menu-map-needed
1184 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
1185 (define-key ispell-menu-map
[ispell-change-dictionary
]
1186 `(menu-item ,(purecopy "Change Dictionary...") ispell-change-dictionary
1187 :help
,(purecopy "Supply explicit dictionary file name")))
1188 (define-key ispell-menu-map
[ispell-kill-ispell
]
1189 `(menu-item ,(purecopy "Kill Process")
1190 (lambda () (interactive) (ispell-kill-ispell nil
'clear
))
1191 :enable
(and (boundp 'ispell-process
) ispell-process
1192 (eq (ispell-process-status) 'run
))
1193 :help
,(purecopy "Terminate Ispell subprocess")))
1194 (define-key ispell-menu-map
[ispell-pdict-save
]
1195 `(menu-item ,(purecopy "Save Dictionary")
1196 (lambda () (interactive) (ispell-pdict-save t t
))
1197 :help
,(purecopy "Save personal dictionary")))
1198 (define-key ispell-menu-map
[ispell-customize
]
1199 `(menu-item ,(purecopy "Customize...")
1200 (lambda () (interactive) (customize-group 'ispell
))
1201 :help
,(purecopy "Customize spell checking options")))
1202 (define-key ispell-menu-map
[ispell-help
]
1203 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1204 `(menu-item ,(purecopy "Help")
1205 (lambda () (interactive) (describe-function 'ispell-help
))
1206 :help
,(purecopy "Show standard Ispell keybindings and commands")))
1207 (define-key ispell-menu-map
[flyspell-mode
]
1208 `(menu-item ,(purecopy "Automatic spell checking (Flyspell)")
1210 :help
,(purecopy "Check spelling while you edit the text")
1211 :button
(:toggle .
(bound-and-true-p flyspell-mode
))))
1212 (define-key ispell-menu-map
[ispell-complete-word
]
1213 `(menu-item ,(purecopy "Complete Word") ispell-complete-word
1214 :help
,(purecopy "Complete word at cursor using dictionary")))
1215 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
1216 `(menu-item ,(purecopy "Complete Word Fragment")
1217 ispell-complete-word-interior-frag
1218 :help
,(purecopy "Complete word fragment at cursor")))))
1221 (if ispell-menu-map-needed
1223 (define-key ispell-menu-map
[ispell-continue
]
1224 `(menu-item ,(purecopy "Continue Spell-Checking") ispell-continue
1225 :enable
(and (boundp 'ispell-region-end
)
1226 (marker-position ispell-region-end
)
1227 (equal (marker-buffer ispell-region-end
)
1229 :help
,(purecopy "Continue spell checking last region")))
1230 (define-key ispell-menu-map
[ispell-word
]
1231 `(menu-item ,(purecopy "Spell-Check Word") ispell-word
1232 :help
,(purecopy "Spell-check word at cursor")))
1233 (define-key ispell-menu-map
[ispell-comments-and-strings
]
1234 `(menu-item ,(purecopy "Spell-Check Comments")
1235 ispell-comments-and-strings
1236 :help
,(purecopy "Spell-check only comments and strings")))))
1239 (if ispell-menu-map-needed
1241 (define-key ispell-menu-map
[ispell-region
]
1242 `(menu-item ,(purecopy "Spell-Check Region") ispell-region
1244 :help
,(purecopy "Spell-check text in marked region")))
1245 (define-key ispell-menu-map
[ispell-message
]
1246 `(menu-item ,(purecopy "Spell-Check Message") ispell-message
1247 :visible
(eq major-mode
'mail-mode
)
1248 :help
,(purecopy "Skip headers and included message text")))
1249 (define-key ispell-menu-map
[ispell-buffer
]
1250 `(menu-item ,(purecopy "Spell-Check Buffer") ispell-buffer
1251 :help
,(purecopy "Check spelling of selected buffer")))
1252 ;;(put 'ispell-region 'menu-enable 'mark-active)
1253 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
1255 ;;; XEmacs versions 19 & 20
1256 (if (and (featurep 'xemacs
)
1258 ;;(null ispell-menu-xemacs)
1259 (not (and (boundp 'infodock-version
) infodock-version
)))
1260 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list
)
1261 (reverse (ispell-valid-dictionary-list))))
1262 (current-menubar (or current-menubar default-menubar
))
1264 '(["Help" (describe-function 'ispell-help
) t
]
1265 ;;["Help" (popup-menu ispell-help-list) t]
1266 ["Check Message" ispell-message t
]
1267 ["Check Buffer" ispell-buffer t
]
1268 ["Check Comments" ispell-comments-and-strings t
]
1269 ["Check Word" ispell-word t
]
1270 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
1271 ["Continue Check" ispell-continue t
]
1272 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
1273 ["Complete Word" ispell-complete-word t
]
1274 ["Kill Process" (ispell-kill-ispell nil
'clear
) t
]
1275 ["Customize..." (customize-group 'ispell
) t
]
1276 ;; flyspell-mode may not be bound...
1277 ;;["flyspell" flyspell-mode
1278 ;; :style toggle :selected flyspell-mode ]
1280 ["Save Personal Dict"(ispell-pdict-save t t
) t
]
1281 ["Change Dictionary" ispell-change-dictionary t
])))
1283 (setq dicts
(cons "default" nil
)))
1284 (dolist (name dicts
)
1285 (setq menu
(append menu
1288 (concat "Select " (capitalize name
))
1289 (list 'ispell-change-dictionary name
)
1291 (setq ispell-menu-xemacs menu
)
1294 (if (car (find-menu-item current-menubar
'("Cmds")))
1297 (delete-menu-item '("Cmds" "Spell-Check"))
1298 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs
))
1300 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1301 (add-menu '("Edit") "Spell" ispell-menu-xemacs
))))))
1303 (defalias 'ispell-int-char
1304 ;; Allow incrementing characters as integers in XEmacs 20
1305 (if (and (featurep 'xemacs
)
1306 (fboundp 'int-char
))
1308 ;; Emacs and XEmacs 19 or earlier
1312 ;;; **********************************************************************
1314 (defvar ispell-current-dictionary nil
1315 "The name of the current dictionary, or nil for the default.
1316 This is passed to the ispell process using the `-d' switch and is
1317 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1319 (defvar ispell-current-personal-dictionary nil
1320 "The name of the current personal dictionary, or nil for the default.
1321 This is passed to the ispell process using the `-p' switch.")
1323 (defun ispell-decode-string (str)
1324 "Decodes multibyte character strings.
1325 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1326 ;; FIXME: enable-multibyte-characters is read-only, so bogus bindings are
1327 ;; really nasty (they signal an error in Emacs): Who does that? --Stef
1328 (if (and (or (featurep 'xemacs
)
1329 (and (boundp 'enable-multibyte-characters
)
1330 enable-multibyte-characters
))
1331 (fboundp 'decode-coding-string
)
1332 (ispell-get-coding-system))
1333 (decode-coding-string str
(ispell-get-coding-system))
1336 ;; Return a string decoded from Nth element of the current dictionary.
1337 (defun ispell-get-decoded-string (n)
1338 "Get the decoded string in slot N of the descriptor of the current dict."
1340 (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1341 (assoc ispell-current-dictionary ispell-dictionary-alist
)
1342 (error "No data for dictionary \"%s\", neither in `ispell-local-dictionary-alist' nor in `ispell-dictionary-alist'"
1343 ispell-current-dictionary
)))
1345 (when (and (> (length str
) 0)
1346 (not (multibyte-string-p str
)))
1347 (setq str
(ispell-decode-string str
))
1348 (or (multibyte-string-p str
)
1349 (setq str
(string-to-multibyte str
))))
1352 (defun ispell-get-casechars ()
1353 (ispell-get-decoded-string 1))
1354 (defun ispell-get-not-casechars ()
1355 (ispell-get-decoded-string 2))
1356 (defun ispell-get-otherchars ()
1357 (ispell-get-decoded-string 3))
1358 (defun ispell-get-many-otherchars-p ()
1359 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1360 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1361 (defun ispell-get-ispell-args ()
1362 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1363 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1364 (defun ispell-get-extended-character-mode ()
1365 (if ispell-really-hunspell
;; hunspell treats ~word as ordinary words
1366 nil
;; in pipe mode. Disable extended-char-mode
1367 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1368 (assoc ispell-current-dictionary ispell-dictionary-alist
)))))
1369 (defun ispell-get-coding-system ()
1370 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1371 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1374 (defvar ispell-pdict-modified-p nil
1375 "Non-nil means personal dictionary has modifications to be saved.")
1377 ;; If you want to save the dictionary when quitting, must do so explicitly.
1378 ;; When non-nil, the spell session is terminated.
1379 ;; When numeric, contains cursor location in buffer, and cursor remains there.
1380 (defvar ispell-quit nil
)
1382 (defvar ispell-process-directory nil
1383 "The directory where `ispell-process' was started.")
1385 (defvar ispell-filter nil
1386 "Output filter from piped calls to Ispell.")
1388 (defvar ispell-filter-continue nil
1389 "Control variable for Ispell filter function.")
1391 (defvar ispell-output-buffer nil
1392 "Buffer used for reading output of a synchronous Ispell subprocess.")
1394 (defvar ispell-session-buffer nil
1395 "Buffer used for passing input to a synchronous Ispell subprocess.")
1397 (defvar ispell-cmd-args nil
1398 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1400 (defvar ispell-query-replace-marker
(make-marker)
1401 "Marker for `query-replace' processing.")
1403 (defvar ispell-recursive-edit-marker
(make-marker)
1404 "Marker for return point from recursive edit.")
1406 (defvar ispell-checking-message nil
1407 "Non-nil when we're checking a mail message.
1408 Set to the MIME boundary locations when checking messages.")
1410 (defconst ispell-choices-buffer
"*Choices*")
1412 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
1414 ;;; *** Buffer Local Definitions ***
1416 (defconst ispell-words-keyword
"LocalWords: "
1417 "The keyword for local oddly-spelled words to accept.
1418 The keyword will be followed by any number of local word spellings.
1419 There can be multiple instances of this keyword in the file.")
1421 (defconst ispell-dictionary-keyword
"Local IspellDict: "
1422 "The keyword for a local dictionary to use.
1423 The keyword must be followed by a valid dictionary name, defined in
1424 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1425 When multiple occurrences exist, the last keyword
1426 definition is used.")
1428 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
1429 "The keyword for defining buffer local dictionaries.
1430 Keyword must be followed by the filename of a personal dictionary.
1431 The last occurring definition in the buffer will be used.")
1433 (defconst ispell-parsing-keyword
"Local IspellParsing: "
1434 "The keyword for overriding default Ispell parsing.
1435 The above keyword string should be followed by `latex-mode' or
1436 `nroff-mode' to put the current buffer into the desired parsing mode.
1438 Extended character mode can be changed for this buffer by placing
1439 a `~' followed by an extended-character mode -- such as `~.tex'.
1440 The last occurring definition in the buffer will be used.")
1443 (defvar ispell-skip-region-alist
1444 `((ispell-words-keyword forward-line
)
1445 (ispell-dictionary-keyword forward-line
)
1446 (ispell-pdict-keyword forward-line
)
1447 (ispell-parsing-keyword forward-line
)
1448 (,(purecopy "^---*BEGIN PGP [A-Z ]*--*")
1449 .
,(purecopy "^---*END PGP [A-Z ]*--*"))
1450 ;; assume multiline uuencoded file? "\nM.*$"?
1451 (,(purecopy "^begin [0-9][0-9][0-9] [^ \t]+$") .
,(purecopy "\nend\n"))
1452 (,(purecopy "^%!PS-Adobe-[123].0") .
,(purecopy "\n%%EOF\n"))
1453 (,(purecopy "^---* \\(Start of \\)?[Ff]orwarded [Mm]essage")
1454 .
,(purecopy "^---* End of [Ff]orwarded [Mm]essage"))
1455 ;; Matches e-mail addresses, file names, http addresses, etc. The
1456 ;; `-+' `_+' patterns are necessary for performance reasons when
1457 ;; `-' or `_' part of word syntax.
1458 (,(purecopy "\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)"))
1459 ;; above checks /.\w sequences
1460 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1461 ;; This is a pretty complex regexp. It can be simplified to the following:
1462 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1463 ;; but some valid text will be skipped, e.g. "his/her". This could be
1464 ;; fixed up (at the expense of a moderately more complex regexp)
1465 ;; by not allowing "/" to be the character which triggers the
1466 ;; identification of the computer name, e.g.:
1467 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1469 "Alist expressing beginning and end of regions not to spell check.
1470 The alist key must be a regular expression.
1471 Valid forms include:
1472 (KEY) - just skip the key.
1473 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1474 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1475 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1476 (put 'ispell-skip-region-alist
'risky-local-variable t
)
1480 (defvar ispell-tex-skip-alists
1482 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1483 ;; All the standard LaTeX keywords from L. Lamport's guide:
1484 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1485 ;; \label, \nocite, \rule (in ispell - rest included here)
1486 ("\\\\addcontentsline" ispell-tex-arg-end
2)
1487 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end
)
1488 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end
)
1489 ;;("\\\\author" ispell-tex-arg-end)
1490 ("\\\\bibliographystyle" ispell-tex-arg-end
)
1491 ("\\\\makebox" ispell-tex-arg-end
0)
1492 ("\\\\e?psfig" ispell-tex-arg-end
)
1493 ("\\\\document\\(class\\|style\\)" .
1494 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1495 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1496 ;; equation, minipage, picture, tabular, tabular* (ispell)
1497 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end
0)
1498 ("list" ispell-tex-arg-end
2)
1499 ("program" .
"\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1500 ("verbatim\\*?" .
"\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}"))))
1501 "Lists of regions to be skipped in TeX mode.
1502 First list is used raw.
1503 Second list has key placed inside \\begin{}.
1505 Delete or add any regions you want to be automatically selected
1506 for skipping in latex mode.")
1507 (put 'ispell-tex-skip-alist
'risky-local-variable t
)
1511 (defconst ispell-html-skip-alists
1512 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1513 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1514 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1515 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1516 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1519 ("&[^ \t\n;]" "[; \t\n]"))
1520 "Lists of start and end keys to skip in HTML buffers.
1521 Same format as `ispell-skip-region-alist'.
1522 Note - substrings of other matches must come last
1523 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1524 (put 'ispell-html-skip-alists
'risky-local-variable t
)
1526 (defvar ispell-local-pdict ispell-personal-dictionary
1527 "A buffer local variable containing the current personal dictionary.
1528 If non-nil, the value must be a string, which is a file name.
1530 If you specify a personal dictionary for the current buffer which is
1531 different from the current personal dictionary, the effect is similar
1532 to calling \\[ispell-change-dictionary]. This variable is automatically
1533 set when defined in the file with either `ispell-pdict-keyword' or the
1534 local variable syntax.")
1536 (make-variable-buffer-local 'ispell-local-pdict
)
1537 ;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
1539 (defvar ispell-buffer-local-name nil
1540 "Contains the buffer name if local word definitions were used.
1541 Ispell is then restarted because the local words could conflict.")
1543 (defvar ispell-buffer-session-localwords nil
1544 "List of words accepted for session in this buffer.")
1546 (make-variable-buffer-local 'ispell-buffer-session-localwords
)
1548 (defvar ispell-parser
'use-mode-name
1549 "Indicates whether ispell should parse the current buffer as TeX Code.
1550 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1551 Default parser is `nroff'.
1552 Currently the only other valid parser is `tex'.
1554 You can set this variable in hooks in your init file -- eg:
1556 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1558 (defvar ispell-region-end
(make-marker)
1559 "Marker that allows spelling continuations.")
1561 (defvar ispell-check-only nil
1562 "If non-nil, `ispell-word' does not try to correct the word.")
1565 ;;; **********************************************************************
1566 ;;; **********************************************************************
1570 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1573 (defun ispell-accept-output (&optional timeout-secs timeout-msecs
)
1574 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1575 If asynchronous subprocesses are not supported, call `ispell-filter' and
1576 pass it the output of the last ispell invocation."
1577 (if ispell-async-processp
1578 (accept-process-output ispell-process timeout-secs timeout-msecs
)
1579 (if (null ispell-process
)
1580 (error "No Ispell process to read output from!")
1581 (let ((buf ispell-output-buffer
)
1583 (if (not (bufferp buf
))
1584 (setq ispell-filter nil
)
1585 (with-current-buffer buf
1586 (setq ispell-output
(buffer-substring-no-properties
1587 (point-min) (point-max))))
1588 (ispell-filter t ispell-output
)
1589 (with-current-buffer buf
1590 (erase-buffer)))))))
1592 (defun ispell-send-replacement (misspelled replacement
)
1593 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1594 This allows it to improve the suggestion list based on actual misspellings."
1595 (and ispell-really-aspell
1596 (ispell-send-string (concat "$$ra " misspelled
"," replacement
"\n"))))
1599 (defun ispell-send-string (string)
1600 "Send the string STRING to the Ispell process."
1601 (if ispell-async-processp
1602 (process-send-string ispell-process string
)
1603 ;; Asynchronous subprocesses aren't supported on this losing system.
1604 ;; We keep all the directives passed to Ispell during the entire
1605 ;; session in a buffer, and pass them anew each time we invoke
1606 ;; Ispell to process another chunk of text. (Yes, I know this is a
1607 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1608 (let ((cmd (aref string
0))
1609 ;; The following commands are not passed to Ispell until
1610 ;; we have a *real* reason to invoke it.
1611 (cmds-to-defer '(?
* ?
@ ?~ ?
+ ?- ?
! ?%
))
1612 (session-buf ispell-session-buffer
)
1613 (output-buf ispell-output-buffer
)
1614 (ispell-args ispell-cmd-args
)
1615 (defdir ispell-process-directory
)
1617 (with-current-buffer session-buf
1618 (setq prev-pos
(point))
1619 (setq default-directory defdir
)
1621 (if (not (memq cmd cmds-to-defer
))
1622 (let (coding-system-for-read coding-system-for-write status
)
1623 (if (and (boundp 'enable-multibyte-characters
)
1624 enable-multibyte-characters
)
1625 (setq coding-system-for-read
(ispell-get-coding-system)
1626 coding-system-for-write
(ispell-get-coding-system)))
1627 (set-buffer output-buf
)
1629 (set-buffer session-buf
)
1631 (apply 'ispell-call-process-region
1632 (point-min) (point-max)
1633 ispell-program-name nil
1636 ;; hunspell -m option means something different
1637 (if ispell-really-hunspell
"" "-m")
1639 (set-buffer output-buf
)
1640 (goto-char (point-min))
1642 (if (not (looking-at "@(#) "))
1643 (error "Ispell error: %s"
1644 (buffer-substring-no-properties
1645 (point) (progn (end-of-line) (point)))))
1646 ;; If STRING is "^Z\n", we just started Ispell and need
1647 ;; to retain its version ID line in the output buffer.
1648 ;; Otherwise, remove the ID line, as it will confuse
1650 (or (string= string
"\032\n")
1653 (delete-region (point-min) (point))))
1654 ;; If STRING begins with ^ or any normal character, we need
1655 ;; to remove the last line from the session buffer, since it
1656 ;; was just spell-checked, and we don't want to check it again.
1657 ;; The same goes for the # command, since Ispell already saved
1658 ;; the personal dictionary.
1659 (set-buffer session-buf
)
1660 (delete-region prev-pos
(point))
1661 ;; Ispell run synchronously saves the personal dictionary
1662 ;; after each successful command. So we can remove any
1663 ;; lines in the session buffer that insert words into the
1665 (if (memq status
'(0 nil
))
1666 (let ((more-lines t
))
1667 (goto-char (point-min))
1669 (if (looking-at "^\\*")
1670 (let ((start (point)))
1672 (delete-region start
(point)))
1673 (setq more-lines
(= 0 (forward-line))))))))))))))
1677 (defun ispell-word (&optional following quietly continue region
)
1678 "Check spelling of word under or before the cursor.
1679 If the word is not found in dictionary, display possible corrections
1680 in a window allowing you to choose one.
1682 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1683 is non-nil when called interactively, then the following word
1684 \(rather than preceding\) is checked when the cursor is not over a word.
1685 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1686 when called interactively, non-corrective messages are suppressed.
1688 With a prefix argument (or if CONTINUE is non-nil),
1689 resume interrupted spell-checking of a buffer or region.
1691 Interactively, in Transient Mark mode when the mark is active, call
1692 `ispell-region' to check the active region for spelling errors.
1694 Word syntax is controlled by the definition of the chosen dictionary,
1695 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1697 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1698 or \\[ispell-region] to update the Ispell process.
1701 nil word is correct or spelling is accepted.
1702 0 word is inserted into buffer-local definitions.
1703 \"word\" word corrected from word list.
1704 \(\"word\" arg\) word is hand entered.
1705 quit spell session exited."
1706 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t
))
1709 (if (featurep 'emacs
)
1711 (and (boundp 'transient-mark-mode
) transient-mark-mode
1712 (boundp 'mark-active
) mark-active
1713 (not (eq (region-beginning) (region-end))))))
1714 (ispell-region (region-beginning) (region-end)))
1715 (continue (ispell-continue))
1717 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1718 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1719 (let ((cursor-location (point)) ; retain cursor location
1720 (word (ispell-get-word following
))
1721 start end poss new-word replace
)
1722 ;; De-structure return word info list.
1723 (setq start
(car (cdr word
))
1724 end
(car (cdr (cdr word
)))
1727 ;; At this point it used to ignore 2-letter words.
1728 ;; But that is silly; if the user asks for it, we should do it. - rms.
1730 (message "Checking spelling of %s..."
1731 (funcall ispell-format-word-function word
)))
1732 (ispell-send-string "%\n") ; put in verbose mode
1733 (ispell-send-string (concat "^" word
"\n"))
1734 ;; wait until ispell has processed word
1736 (ispell-accept-output)
1737 (not (string= "" (car ispell-filter
)))))
1738 ;;(ispell-send-string "!\n") ;back to terse mode.
1739 (setq ispell-filter
(cdr ispell-filter
)) ; remove extra \n
1740 (if (and ispell-filter
(listp ispell-filter
))
1741 (if (> (length ispell-filter
) 1)
1742 (error "Ispell and its process have different character maps")
1743 (setq poss
(ispell-parse-output (car ispell-filter
)))))
1746 (message "%s is correct"
1747 (funcall ispell-format-word-function word
)))
1748 (and (featurep 'xemacs
)
1750 (and (fboundp 'delete-extent
)
1751 (delete-extent (extent-at start
)))))
1754 (message "%s is correct because of root %s"
1755 (funcall ispell-format-word-function word
)
1756 (funcall ispell-format-word-function poss
)))
1757 (and (featurep 'xemacs
)
1759 (and (fboundp 'delete-extent
)
1760 (delete-extent (extent-at start
)))))
1762 (message "Error checking word %s using %s with %s dictionary"
1763 (funcall ispell-format-word-function word
)
1764 (file-name-nondirectory ispell-program-name
)
1765 (or ispell-current-dictionary
"default")))
1766 (ispell-check-only ; called from ispell minor mode.
1767 (if (fboundp 'make-extent
)
1768 (if (fboundp 'set-extent-property
)
1769 (let ((ext (make-extent start end
)))
1770 (set-extent-property ext
'face ispell-highlight-face
)
1771 (set-extent-property ext
'priority
2000)))
1773 (message "%s is incorrect"
1774 (funcall ispell-format-word-function word
))))
1775 (t ; prompt for correct word.
1776 (save-window-excursion
1777 (setq replace
(ispell-command-loop
1778 (car (cdr (cdr poss
)))
1779 (car (cdr (cdr (cdr poss
))))
1780 (car poss
) start end
)))
1781 (cond ((equal 0 replace
)
1782 (ispell-add-per-file-word-list (car poss
)))
1784 (setq new-word
(if (atom replace
) replace
(car replace
))
1785 cursor-location
(+ (- (length word
) (- end start
))
1787 (if (not (equal new-word
(car poss
)))
1790 ;; Insert first and then delete,
1791 ;; to avoid collapsing markers before and after
1792 ;; into a single place.
1794 (delete-region (point) end
)
1795 ;; It is meaningless to preserve the cursor position
1796 ;; inside a word that has changed.
1797 (setq cursor-location
(point))
1798 (setq end
(point))))
1799 (if (not (atom replace
)) ;recheck spelling of replacement
1801 (if (car (cdr replace
)) ; query replace requested
1802 (save-window-excursion
1803 (query-replace word new-word t
)))
1805 ;; single word could be split into multiple words
1806 (setq ispell-quit
(not (ispell-region start end
)))
1808 ;; keep if rechecking word and we keep choices win.
1809 (if (get-buffer ispell-choices-buffer
)
1810 (kill-buffer ispell-choices-buffer
))))
1811 (ispell-pdict-save ispell-silently-savep
)
1812 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1813 (if ispell-quit
(setq ispell-quit nil replace
'quit
))
1814 (goto-char cursor-location
) ; return to original location
1818 (defun ispell-get-word (following &optional extra-otherchars
)
1819 "Return the word for spell-checking according to ispell syntax.
1820 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1821 is non-nil when called interactively, then the following word
1822 \(rather than preceding\) is checked when the cursor is not over a word.
1823 Optional second argument contains otherchars that can be included in word
1824 many times (see the doc string of `ispell-dictionary-alist' for details
1827 Word syntax is controlled by the definition of the chosen dictionary,
1828 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1829 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1830 (let* ((ispell-casechars (ispell-get-casechars))
1831 (ispell-not-casechars (ispell-get-not-casechars))
1832 (ispell-otherchars (ispell-get-otherchars))
1833 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1834 (word-regexp (concat ispell-casechars
1836 (if (not (string= "" ispell-otherchars
))
1837 (concat ispell-otherchars
"?"))
1838 (if extra-otherchars
1839 (concat extra-otherchars
"?"))
1842 (if (or ispell-many-otherchars-p
1848 (if (not (looking-at ispell-casechars
))
1850 (re-search-forward ispell-casechars
(point-max) t
)
1851 (re-search-backward ispell-casechars
(point-min) t
)))
1852 ;; move to front of word
1853 (re-search-backward ispell-not-casechars
(point-min) 'start
)
1854 (while (and (or (and (not (string= "" ispell-otherchars
))
1855 (looking-at ispell-otherchars
))
1856 (and extra-otherchars
(looking-at extra-otherchars
)))
1858 (or (not did-it-once
)
1859 ispell-many-otherchars-p
)
1860 (not (eq prevpt
(point))))
1861 (if (and extra-otherchars
(looking-at extra-otherchars
))
1864 (if (looking-at ispell-casechars
)
1865 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
1869 (if (looking-at ispell-casechars
)
1870 (re-search-backward ispell-not-casechars
(point-min) 'move
)
1871 (backward-char -
1))))
1872 ;; Now mark the word and save to string.
1873 (if (not (re-search-forward word-regexp
(point-max) t
))
1874 (if ispell-check-only
1875 ;; return dummy word when just flagging misspellings
1876 (list "" (point) (point))
1877 (error "No word found to check!"))
1878 (setq start
(copy-marker (match-beginning 0))
1880 word
(buffer-substring-no-properties start end
))
1881 (list word start end
))))
1884 ;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1885 ;; tracks changes in the dictionary. The global may either be
1886 ;; a value or a list, whose value is the state of whether the
1887 ;; dictionary needs to be saved.
1890 (defun ispell-pdict-save (&optional no-query force-save
)
1891 "Check to see if the personal dictionary has been modified.
1892 If so, ask if it needs to be saved."
1893 (interactive (list ispell-silently-savep t
))
1894 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
1895 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
1896 (when (and (or ispell-pdict-modified-p force-save
)
1898 (y-or-n-p "Personal dictionary modified. Save? ")))
1899 (ispell-send-string "#\n") ; save dictionary
1900 (message "Personal dictionary saved.")
1904 ;; unassert variable, even if not saved to avoid questioning.
1905 (setq ispell-pdict-modified-p nil
))
1908 (defun ispell-command-loop (miss guess word start end
)
1909 "Display possible corrections from list MISS.
1910 GUESS lists possibly valid affix construction of WORD.
1911 Returns nil to keep word.
1912 Returns 0 to insert locally into buffer-local dictionary.
1913 Returns string for new chosen word.
1914 Returns list for new replacement word (will be rechecked).
1915 Query-replace when list length is 2.
1916 Automatic query-replace when second element is `query-replace'.
1917 Highlights the word, which is assumed to run from START to END.
1918 Global `ispell-pdict-modified-p' becomes a list where the only value
1919 indicates whether the dictionary has been modified when option `a'
1921 Global `ispell-quit' set to start location to continue spell session."
1923 (line ispell-choices-win-default-height
)
1924 ;; ensure 4 context lines.
1925 (max-lines (- (ispell-adjusted-window-height) 4))
1927 (window-min-height (min window-min-height
1928 ispell-choices-win-default-height
))
1929 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
1930 (dedicated (window-dedicated-p (selected-window)))
1932 char num result textwin dedicated-win
)
1934 ;; setup the *Choices* buffer with valid data.
1935 (with-current-buffer (get-buffer-create ispell-choices-buffer
)
1936 (setq mode-line-format
1938 "-- %b -- word: " word
1939 " -- dict: " (or ispell-current-dictionary
"default")
1940 " -- prog: " (file-name-nondirectory ispell-program-name
)))
1941 ;; XEmacs: no need for horizontal scrollbar in choices window
1942 (ispell-with-no-warnings
1943 (and (fboundp 'set-specifier
)
1944 (boundp 'horizontal-scrollbar-visible-p
)
1945 (set-specifier horizontal-scrollbar-visible-p nil
1946 (cons (current-buffer) nil
))))
1950 (insert "Affix rules generate and capitalize "
1951 "this word as shown below:\n\t")
1953 (if (> (+ 4 (current-column) (length (car guess
)))
1957 (setq line
(1+ line
))))
1958 (insert (car guess
) " ")
1959 (setq guess
(cdr guess
)))
1960 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.\n")
1961 (setq line
(+ line
(if choices
3 2)))))
1963 (< (if (> (+ 7 (current-column) (length (car choices
))
1964 (if (> count ?~
) 3 0))
1968 (setq line
(1+ line
)))
1971 ;; not so good if there are over 20 or 30 options, but then, if
1972 ;; there are that many you don't want to scan them all anyway...
1973 (while (memq count command-characters
) ; skip command characters.
1974 (setq count
(ispell-int-char (1+ count
))
1975 skipped
(1+ skipped
)))
1976 (insert "(" count
") " (car choices
) " ")
1977 (setq choices
(cdr choices
)
1978 count
(ispell-int-char (1+ count
))))
1979 (setq count
(ispell-int-char (- count ?
0 skipped
))))
1981 ;; ensure word is visible
1982 (if (not (pos-visible-in-window-p end
))
1985 ;; allow temporary split of dedicated windows...
1988 (setq dedicated-win
(selected-window))
1989 (set-window-dedicated-p dedicated-win nil
)))
1991 ;; Display choices for misspelled word.
1992 (ispell-show-choices line end
)
1993 (select-window (setq textwin
(next-window)))
1995 ;; highlight word, protecting current buffer status
1998 (and ispell-highlight-p
1999 (ispell-highlight-spelling-error start end t
))
2000 ;; Loop until a valid choice is made.
2008 (let (message-log-max)
2009 (message (concat "C-h or ? for more options; SPC to leave "
2010 "unchanged, Character to replace word")))
2011 (let ((inhibit-quit t
)
2013 (setq char nil skipped
0)
2014 ;; If the user types C-g, or generates some other
2015 ;; non-character event (such as a frame switch
2016 ;; event), stop ispell. As a special exception,
2017 ;; ignore mouse events occurring in the same frame.
2018 (while (and input-valid
(not (characterp char
)))
2019 (setq char
(read-key))
2021 (or (characterp char
)
2022 (and (mouse-event-p char
)
2023 (eq (selected-frame)
2025 (posn-window (event-start char
))))))))
2026 (when (or quit-flag
(not input-valid
) (= char ?\C-g
))
2027 (setq char ?X quit-flag nil
)))
2028 ;; Adjust num to array offset skipping command characters.
2029 (let ((com-chars command-characters
))
2031 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
2032 (setq skipped
(1+ skipped
)))
2033 (setq com-chars
(cdr com-chars
)))
2034 (setq num
(- char ?
0 skipped
)))
2037 ((= char ?
) nil
) ; accept word this time only
2038 ((= char ?i
) ; accept and insert word into pers dict
2039 (ispell-send-string (concat "*" word
"\n"))
2040 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2042 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
2043 (ispell-send-string (concat "@" word
"\n"))
2044 (add-to-list 'ispell-buffer-session-localwords word
)
2045 (or ispell-buffer-local-name
; session localwords might conflict
2046 (setq ispell-buffer-local-name
(buffer-name)))
2047 (if (null ispell-pdict-modified-p
)
2048 (setq ispell-pdict-modified-p
2049 (list ispell-pdict-modified-p
)))
2050 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
2051 ((or (= char ?r
) (= char ?R
)) ; type in replacement
2052 (and (eq 'block ispell-highlight-p
) ; refresh tty's
2053 (ispell-highlight-spelling-error start end nil t
))
2055 (if (or (= char ?R
) ispell-query-replace-choices
)
2057 (format "Query-replacement for %s: "word
)
2060 (cons (read-string "Replacement for: " word
)
2062 (and (eq 'block ispell-highlight-p
)
2063 (ispell-highlight-spelling-error start end nil
2066 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
2067 (and (eq 'block ispell-highlight-p
)
2068 (ispell-highlight-spelling-error start end nil t
))
2070 (and (eq 'block ispell-highlight-p
)
2071 (ispell-highlight-spelling-error start end nil
2074 ;; Quit and move point back.
2076 (ispell-pdict-save ispell-silently-savep
)
2077 (message "Exited spell-checking")
2078 (setq ispell-quit t
)
2080 ;; Quit and preserve point.
2082 (ispell-pdict-save ispell-silently-savep
)
2084 (substitute-command-keys
2085 (concat "Spell-checking suspended;"
2086 " use C-u \\[ispell-word] to resume")))
2087 (setq ispell-quit start
)
2090 (if (y-or-n-p "Really kill Ispell process? ")
2092 (ispell-kill-ispell t
) ; terminate process.
2093 (setq ispell-quit
(or (not ispell-checking-message
)
2095 ispell-pdict-modified-p nil
))
2096 t
)) ; continue if they don't quit.
2098 (and (eq 'block ispell-highlight-p
) ; refresh tty displays
2099 (ispell-highlight-spelling-error start end nil t
))
2100 (let ((new-word (read-string
2101 "Lookup string (`*' is wildcard): "
2105 (with-current-buffer (get-buffer-create
2106 ispell-choices-buffer
)
2110 mode-line-format
;; setup the *Choices* buffer with valid data.
2111 (concat "-- %b -- word: " new-word
2113 (or ispell-complete-word-dict
2114 ispell-alternate-dictionary
))
2115 miss
(lookup-words new-word
)
2117 line ispell-choices-win-default-height
)
2118 (while (and choices
; adjust choices window.
2119 (< (if (> (+ 7 (current-column)
2120 (length (car choices
))
2121 (if (> count ?~
) 3 0))
2125 (setq line
(1+ line
)))
2128 (while (memq count command-characters
)
2129 (setq count
(ispell-int-char (1+ count
))
2130 skipped
(1+ skipped
)))
2131 (insert "(" count
") " (car choices
) " ")
2132 (setq choices
(cdr choices
)
2133 count
(ispell-int-char (1+ count
))))
2134 (setq count
(ispell-int-char
2135 (- count ?
0 skipped
))))
2136 (ispell-show-choices line end
)
2137 (select-window (next-window)))))
2138 (and (eq 'block ispell-highlight-p
)
2139 (ispell-highlight-spelling-error start end nil
2141 t
) ; reselect from new choices
2142 ((= char ?u
) ; insert lowercase into dictionary
2143 (ispell-send-string (concat "*" (downcase word
) "\n"))
2144 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2146 ((= char ?m
) ; type in what to insert
2148 (concat "*" (read-string "Insert: " word
) "\n"))
2149 (setq ispell-pdict-modified-p
'(t))
2151 ((and (>= num
0) (< num count
))
2152 (if ispell-query-replace-choices
; Query replace flag
2153 (list (nth num miss
) 'query-replace
)
2158 ;; This may have alignment errors if current line is edited
2159 (if (marker-position ispell-recursive-edit-marker
)
2161 (message "Only one recursive edit session supported")
2164 (set-marker ispell-recursive-edit-marker start
)
2165 ;;(set-marker ispell-region-end reg-end)
2166 (and ispell-highlight-p
; unhighlight
2167 (ispell-highlight-spelling-error start end
))
2172 (substitute-command-keys
2173 (concat "Exit recursive edit with"
2174 " \\[exit-recursive-edit]")))
2175 (save-window-excursion (save-excursion
2178 (goto-char ispell-recursive-edit-marker
)
2179 (if (not (equal (marker-buffer
2180 ispell-recursive-edit-marker
)
2183 (set-marker ispell-recursive-edit-marker nil
)
2185 "Cannot continue ispell from this buffer.")))
2186 (set-marker ispell-recursive-edit-marker nil
)))
2187 (list word nil
)) ; recheck starting at this word.
2189 (funcall (key-binding "\C-z"))
2194 (and ispell-highlight-p
; unhighlight
2195 (save-window-excursion
2196 (select-window textwin
)
2197 (ispell-highlight-spelling-error start end
)))
2199 (set-window-dedicated-p dedicated-win t
)))))
2203 (defun ispell-show-choices (line end
)
2204 "Show the choices in another buffer or frame."
2205 (if (and ispell-use-framepop-p
(fboundp 'framepop-display-buffer
))
2207 (framepop-display-buffer (get-buffer ispell-choices-buffer
))
2208 ;; (get-buffer-window ispell-choices-buffer t)
2209 (select-window (previous-window))) ; *Choices* window
2210 ;; standard selection by splitting a small buffer out of this window.
2211 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
2213 (if (= line
(ispell-adjusted-window-height choices-window
))
2214 (select-window choices-window
)
2215 ;; *Choices* window changed size. Adjust the choices window
2216 ;; without scrolling the spelled window when possible
2218 (- line
(ispell-adjusted-window-height choices-window
)))
2219 (visible (progn (vertical-motion -
1) (point))))
2220 (if (< line ispell-choices-win-default-height
)
2221 (setq window-line
(+ window-line
2222 (- ispell-choices-win-default-height
2224 (move-to-window-line 0)
2225 (vertical-motion window-line
)
2226 (set-window-start (selected-window)
2227 (if (> (point) visible
) visible
(point)))
2229 (select-window choices-window
)
2230 (enlarge-window window-line
)))
2231 ;; Overlay *Choices* window when it isn't showing
2232 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
2233 (switch-to-buffer ispell-choices-buffer
)
2234 (goto-char (point-min)))))
2238 (defun ispell-help ()
2239 "Display a list of the options available when a misspelling is encountered.
2243 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2244 SPC: Accept word this time.
2245 `i': Accept word and insert into private dictionary.
2246 `a': Accept word for this session.
2247 `A': Accept word and place in `buffer-local dictionary'.
2248 `r': Replace word with typed-in value. Rechecked.
2249 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2250 `?': Show these commands.
2251 `x': Exit spelling buffer. Move cursor to original point.
2252 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2253 the aborted check to be completed later.
2254 `q': Quit spelling session (Kills ispell process).
2255 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2256 `u': Like `i', but the word is lower-cased first.
2257 `m': Place typed-in value in personal dictionary, then recheck current word.
2258 `C-l': Redraw screen.
2259 `C-r': Recursive edit.
2260 `C-z': Suspend Emacs or iconify frame."
2262 (if (equal ispell-help-in-bufferp
'electric
)
2266 (function (lambda ()
2267 ;;This shouldn't be necessary: with-electric-help needs
2268 ;; an optional argument telling it about the smallest
2269 ;; acceptable window-height of the help buffer.
2270 ;;(if (< (window-height) 15)
2272 ;; (- 15 (ispell-adjusted-window-height))))
2273 (princ "Selections are:
2275 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2276 SPC: Accept word this time.
2277 `i': Accept word and insert into private dictionary.
2278 `a': Accept word for this session.
2279 `A': Accept word and place in `buffer-local dictionary'.
2280 `r': Replace word with typed-in value. Rechecked.
2281 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2282 `?': Show these commands.
2283 `x': Exit spelling buffer. Move cursor to original point.
2284 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2285 the aborted check to be completed later.
2286 `q': Quit spelling session (Kills ispell process).
2287 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2288 `u': Like `i', but the word is lower-cased first.
2289 `m': Place typed-in value in personal dictionary, then recheck current word.
2290 `C-l': Redraw screen.
2291 `C-r': Recursive edit.
2292 `C-z': Suspend Emacs or iconify frame.")
2296 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2297 "[i]nsert into private dictionary"))
2298 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2299 "e[x/X]it; [q]uit session"))
2300 (help-3 (concat "[u]ncapitalized insert into dict. "
2301 "Type 'x C-h f ispell-help' for more help")))
2302 (save-window-excursion
2303 (if ispell-help-in-bufferp
2305 (ispell-overlay-window 4)
2306 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2307 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2309 (kill-buffer "*Ispell Help*"))
2311 (let ((resize-mini-windows 'grow-only
))
2312 (select-window (minibuffer-window))
2315 ;;(set-minibuffer-window (selected-window))
2317 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2319 (erase-buffer)))))))
2322 (defun lookup-words (word &optional lookup-dict
)
2323 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2324 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2325 Otherwise the variable `ispell-grep-command' contains the command used to
2326 search for the words (usually egrep).
2328 Optional second argument contains the dictionary to use; the default is
2329 `ispell-alternate-dictionary', overridden by `ispell-complete-word-dict'
2331 ;; We don't use the filter for this function, rather the result is written
2332 ;; into a buffer. Hence there is no need to save the filter values.
2333 (if (null lookup-dict
)
2334 (setq lookup-dict
(or ispell-complete-word-dict
2335 ispell-alternate-dictionary
)))
2338 (unless (file-readable-p lookup-dict
)
2339 (error "lookup-words error: Unreadable or missing plain word-list %s."
2341 (error (concat "lookup-words error: No plain word-list found at system"
2342 "default locations. "
2343 "Customize `ispell-alternate-dictionary' to set yours.")))
2345 (let* ((process-connection-type ispell-use-ptys-p
)
2346 (wild-p (string-match "\\*" word
))
2347 (look-p (and ispell-look-p
; Only use look for an exact match.
2348 (or ispell-have-new-look
(not wild-p
))))
2349 (prog (if look-p ispell-look-command ispell-grep-command
))
2350 (args (if look-p ispell-look-options ispell-grep-options
))
2353 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
2357 (insert "^" word
"$")
2358 (while (search-backward "*" nil t
) (insert "."))
2359 (setq word
(buffer-string))
2361 (setq status
(apply 'ispell-call-process prog nil t nil
2362 (nconc (if (and args
(> (length args
) 0))
2367 (if lookup-dict
(list lookup-dict
)))))
2368 ;; `grep' returns status 1 and no output when word not found, which
2369 ;; is a perfectly normal thing.
2370 (if (stringp status
)
2371 (error "error: %s exited with signal %s"
2372 (file-name-nondirectory prog
) status
)
2373 ;; Else collect words into `results' in FIFO order.
2374 (goto-char (point-max))
2375 ;; Assure we've ended with \n.
2376 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
2380 (push (buffer-substring-no-properties (point)
2383 (if (and results
(string-match ".+: " (car results
)))
2384 (error "%s error: %s" ispell-grep-command
(car results
)))
2388 ;; "ispell-filter" is a list of output lines from the generating function.
2389 ;; Each full line (ending with \n) is a separate item on the list.
2390 ;; "output" can contain multiple lines, part of a line, or both.
2391 ;; "start" and "end" are used to keep bounds on lines when "output" contains
2393 ;; "ispell-filter-continue" is true when we have received only part of a
2394 ;; line as output from a generating function ("output" did not end with \n)
2395 ;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2396 ;; This is the case when a process dies or fails. The default behavior
2397 ;; in this case treats the next input received as fresh input.
2399 (defun ispell-filter (process output
)
2400 "Output filter function for ispell, grep, and look."
2405 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
2406 ;; If we get out of sync and ispell-filter-continue is asserted when we
2407 ;; are not continuing, treat the next item as a separate list. When
2408 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2411 ;; Continue with same line (item)?
2412 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
2413 ;; Yes. Add it to the prev item
2414 (setcar ispell-filter
2415 (concat (car ispell-filter
) (substring output start end
)))
2416 ;; No. This is a new line and item.
2418 (cons (substring output start end
) ispell-filter
)))
2420 ;; We've completed reading the output, but didn't finish the line.
2421 (setq ispell-filter-continue t continue nil
)
2422 ;; skip over newline, this line complete.
2423 (setq ispell-filter-continue nil end
(1+ end
))
2424 (if (= end
(length output
)) ; No more lines in output
2425 (setq continue nil
) ; so we can exit the filter.
2426 (setq start end
)))))) ; else move start to next line of input
2429 ;; This function destroys the mark location if it is in the word being
2431 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
2433 "Highlight the word from START to END with a kludge using `inverse-video'.
2434 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2435 otherwise it is displayed normally.
2436 Uses block cursor to highlight one character.
2437 Optional REFRESH will unhighlighted then highlight, using block cursor
2438 highlighting when REFRESH is equal to `block'."
2439 (and (eq 'block ispell-highlight-p
)
2440 (or (eq 'block refresh
)
2441 (setq start
(1+ start
)))) ; On block non-refresh, inc start.
2442 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2443 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
2444 (text (buffer-substring-no-properties start end
))
2445 ; Save highlight region.
2446 (inhibit-quit t
) ; inhibit interrupt processing here.
2447 (buffer-undo-list t
)) ; don't clutter the undo list.
2449 (delete-region start end
)
2450 (insert-char ?
(- end start
)) ; minimize amount of redisplay
2451 (sit-for 0) ; update display
2452 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
2453 (delete-region start end
) ; delete whitespace
2454 (insert text
) ; insert text in inverse video.
2455 (sit-for 0) ; update display showing inverse video.
2458 (setq inverse-video
(not inverse-video
)) ; toggle video
2459 (and (eq 'block ispell-highlight-p
)
2460 (goto-char (1- start
)))) ; use block cursor to "highlight" char
2461 (set-buffer-modified-p modified
) ; don't modify if flag not set.
2462 (and refresh
; re-highlight
2463 (ispell-highlight-spelling-error-generic
2464 (if (eq 'block refresh
) start
(- start
2)) end t
))))
2467 (defun ispell-highlight-spelling-error-xemacs (start end
&optional highlight
)
2468 "Highlight the word from START to END using `isearch-highlight'.
2469 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2470 otherwise it is displayed normally."
2472 (isearch-highlight start end
)
2473 (isearch-dehighlight))
2478 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
2479 "Highlight the word from START to END using overlays.
2480 When the optional third arg HIGHLIGHT is set, the word is highlighted
2481 otherwise it is displayed normally.
2483 The variable `ispell-highlight-face' selects the face to use for highlighting."
2486 (move-overlay ispell-overlay start end
(current-buffer))
2487 (setq ispell-overlay
(make-overlay start end
))
2488 (overlay-put ispell-overlay
'priority
1001) ;higher than lazy overlays
2489 (overlay-put ispell-overlay
'face ispell-highlight-face
))
2491 (delete-overlay ispell-overlay
)))
2492 (if (and ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
))
2494 (let ((isearch-string
2497 (regexp-quote (buffer-substring-no-properties start end
))
2500 (isearch-case-fold-search nil
)
2502 (isearch-other-end start
)
2503 (isearch-error nil
))
2504 (isearch-lazy-highlight-new-loop
2505 (if (boundp 'reg-start
) reg-start
)
2506 (if (boundp 'reg-end
) reg-end
)))
2507 (lazy-highlight-cleanup lazy-highlight-cleanup
)
2508 (setq isearch-lazy-highlight-last-string nil
))))
2511 (defun ispell-highlight-spelling-error (start end
&optional highlight refresh
)
2514 (ispell-highlight-spelling-error-xemacs start end highlight
))
2515 ((and (featurep 'faces
)
2516 (or (and (fboundp 'display-color-p
) (display-color-p))
2518 (ispell-highlight-spelling-error-overlay start end highlight
))
2519 (t (ispell-highlight-spelling-error-generic start end highlight refresh
))))
2521 (defun ispell-adjusted-window-height (&optional window
)
2522 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2523 The value returned is actually the nominal number of text-lines in the
2524 window plus 1. On a terminal, this is the same value returned by
2525 `window-height', but if the window has a mode-line is taller than a normal
2526 text line, the returned value may be smaller than that from
2528 (cond ((fboundp 'window-text-height
)
2529 (1+ (window-text-height window
)))
2530 ((or (and (fboundp 'display-graphic-p
) (display-graphic-p))
2531 (and (featurep 'xemacs
) window-system
))
2532 (1- (window-height window
)))
2534 (window-height window
))))
2536 (defun ispell-overlay-window (height)
2537 "Create a window covering the top HEIGHT lines of the current window.
2538 Ensure that the line above point is still visible but otherwise avoid
2539 scrolling the current window. Leave the new window selected."
2541 (let ((oldot (save-excursion (vertical-motion -
1) (point)))
2542 (top (save-excursion (move-to-window-line height
) (point))))
2543 ;; If line above old point (line starting at oldot) would be
2544 ;; hidden by new window, scroll it to just below new win
2545 ;; otherwise set top line of other win so it doesn't scroll.
2546 (if (< oldot top
) (setq top oldot
))
2547 ;; if frame is unsplittable, temporarily disable that...
2548 (if (cdr (assq 'unsplittable
(frame-parameters (selected-frame))))
2549 (let ((frame (selected-frame)))
2550 (modify-frame-parameters frame
'((unsplittable . nil
)))
2551 (split-window nil height
)
2552 (modify-frame-parameters frame
'((unsplittable . t
))))
2553 (split-window nil height
))
2554 (let ((deficit (- height
(ispell-adjusted-window-height))))
2556 ;; Number of lines the window is still too short. We ensure that
2557 ;; there are at least (1- HEIGHT) lines visible in the window.
2558 (enlarge-window deficit
)
2560 (vertical-motion deficit
)
2561 (setq top
(min (point) oldot
))))
2562 (set-window-start (next-window) top
))))
2565 ;; Should we add a compound word match return value?
2566 (defun ispell-parse-output (output &optional accept-list shift
)
2567 "Parse the OUTPUT string from Ispell process and return:
2568 1: t for an exact match.
2569 2: A string containing the root word matched via suffix removal.
2570 3: A list of possible correct spellings of the format:
2571 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2572 ORIGINAL-WORD is a string of the possibly misspelled word.
2573 OFFSET is an integer giving the line offset of the word.
2574 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2575 4: nil when an error has occurred.
2577 Optional second arg ACCEPT-LIST is list of words already accepted.
2578 Optional third arg SHIFT is an offset to apply based on previous corrections."
2580 ((string= output
"") t
) ; for startup with pipes...
2581 ((string= output
"*") t
) ; exact match
2582 ((string= output
"-") t
) ; compound word match
2583 ((eq (aref output
0) ?
+) ; found because of root word
2584 (substring output
2)) ; return root word
2585 ((equal 0 (string-match "[\ra-zA-Z]" output
))
2586 (ding) ; error message from ispell!
2587 (message "Ispell error: %s" output
)
2590 (t ; need to process &, ?, and #'s
2591 (let ((type (aref output
0)) ; &, ?, or #
2592 (original-word (substring output
2 (string-match " " output
2)))
2593 (cur-count 0) ; contains number of misses + guesses
2594 count miss-list guess-list offset
)
2595 (setq output
(substring output
(match-end 0))) ; skip over misspelling
2597 (setq count
0) ; no misses for type #
2598 (setq count
(string-to-number output
) ; get number of misses.
2599 output
(substring output
(1+ (string-match " " output
1)))))
2600 (setq offset
(string-to-number output
))
2601 (setq output
(if (eq type ?
#) ; No miss or guess list.
2603 (substring output
(1+ (string-match " " output
1)))))
2605 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
2606 (setq cur-count
(1+ cur-count
))
2607 (if (> cur-count count
)
2608 (push (substring output
0 end
) guess-list
)
2609 (push (substring output
0 end
) miss-list
))
2610 (setq output
(if (match-end 1) ; True only when at end of line.
2611 nil
; No more misses or guesses.
2612 (substring output
(+ end
2))))))
2613 ;; return results. Accept word if it was already accepted.
2615 (if (member original-word accept-list
)
2618 (if (numberp shift
) (+ shift offset
) offset
)
2619 (nreverse miss-list
) (nreverse guess-list
)))))))
2622 (defun ispell-process-status ()
2623 "Return the status of the Ispell process.
2624 When asynchronous processes are not supported, `run' is always returned."
2625 (if ispell-async-processp
2626 (process-status ispell-process
)
2627 (and ispell-process
'run
)))
2630 (defun ispell-start-process ()
2631 "Start the Ispell process, with support for no asynchronous processes.
2632 Keeps argument list for future Ispell invocations for no async support."
2633 ;; Local dictionary becomes the global dictionary in use.
2634 (setq ispell-current-dictionary
2635 (or ispell-local-dictionary ispell-dictionary
))
2636 (setq ispell-current-personal-dictionary
2637 (or ispell-local-pdict ispell-personal-dictionary
))
2638 (let* ((default-directory
2639 (if (and (file-directory-p default-directory
)
2640 (file-readable-p default-directory
))
2642 ;; Defend against bad `default-directory'.
2643 (expand-file-name "~/")))
2644 (orig-args (ispell-get-ispell-args))
2647 (if (and ispell-current-dictionary
; Not for default dict (nil)
2648 (not (member "-d" orig-args
))) ; Only define if not overridden.
2649 (list "-d" ispell-current-dictionary
))
2651 (if ispell-current-personal-dictionary
; Use specified pers dict.
2653 (expand-file-name ispell-current-personal-dictionary
)))
2654 ;; If we are using recent aspell or hunspell, make sure we use the
2655 ;; right encoding for communication. ispell or older aspell/hunspell
2656 ;; does not support this.
2657 (if ispell-encoding8-command
2658 (if ispell-really-hunspell
2659 (list ispell-encoding8-command
2660 (upcase (symbol-name (ispell-get-coding-system))))
2662 (concat ispell-encoding8-command
2663 (symbol-name (ispell-get-coding-system))))))
2664 ispell-extra-args
)))
2666 ;; Initially we don't know any buffer's local words.
2667 (setq ispell-buffer-local-name nil
)
2669 (if ispell-async-processp
2670 (let ((process-connection-type ispell-use-ptys-p
))
2671 (apply 'start-process
2672 "ispell" nil ispell-program-name
2673 "-a" ; Accept single input lines.
2674 ;; Make root/affix combos not in dict.
2675 ;; hunspell -m option means different.
2676 (if ispell-really-hunspell
"" "-m")
2678 (setq ispell-cmd-args args
2679 ispell-output-buffer
(generate-new-buffer " *ispell-output*")
2680 ispell-session-buffer
(generate-new-buffer " *ispell-session*"))
2681 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2685 (defun ispell-init-process ()
2686 "Check status of Ispell process and start if necessary."
2687 (let* (;; Basename of dictionary used by the spell-checker
2688 (dict-bname (or (car (cdr (member "-d" (ispell-get-ispell-args))))
2689 ispell-current-dictionary
))
2690 ;; Use "~/" as default-directory unless using Ispell with per-dir
2691 ;; personal dictionaries and not in a minibuffer under XEmacs
2693 (if (or ispell-really-aspell
2694 ispell-really-hunspell
2695 ;; Protect against bad default-directory
2696 (not (and (file-directory-p default-directory
)
2697 (file-readable-p default-directory
)))
2698 ;; Ispell and per-dir personal dicts available
2699 (not (or (file-readable-p (concat default-directory
2701 (file-readable-p (concat default-directory
2705 ;; Ispell, in a minibuffer, and XEmacs
2706 (and (window-minibuffer-p)
2707 (not (fboundp 'minibuffer-selected-window
))))
2708 (expand-file-name "~/")
2709 (expand-file-name default-directory
))))
2710 ;; Check if process needs restart
2711 (if (and ispell-process
2712 (eq (ispell-process-status) 'run
)
2713 ;; Unless we are using an explicit personal dictionary, ensure
2714 ;; we're in the same default directory! Restart check for
2715 ;; personal dictionary is done in
2716 ;; `ispell-internal-change-dictionary', called from
2717 ;; `ispell-buffer-local-dict'
2718 (or (or ispell-local-pdict ispell-personal-dictionary
)
2719 (equal ispell-process-directory default-directory
)))
2720 (setq ispell-filter nil ispell-filter-continue nil
)
2721 ;; may need to restart to select new personal dictionary.
2722 (ispell-kill-ispell t
)
2723 (message "Starting new Ispell process [%s::%s] ..."
2725 (or ispell-local-dictionary ispell-dictionary
"default"))
2727 (setq ispell-library-directory
(ispell-check-version)
2728 ispell-process
(ispell-start-process)
2730 ispell-filter-continue nil
2731 ispell-process-directory default-directory
)
2733 (unless (equal ispell-process-directory
(expand-file-name "~/"))
2734 ;; At this point, `ispell-process-directory' will be "~/" unless using
2735 ;; Ispell with directory-specific dicts and not in XEmacs minibuffer.
2736 ;; If not, kill ispell process when killing buffer. It may be in a
2737 ;; removable device that would otherwise become un-mountable.
2738 (with-current-buffer
2739 (if (and (window-minibuffer-p) ;; In minibuffer
2740 (fboundp 'minibuffer-selected-window
)) ;; Not XEmacs.
2741 ;; In this case kill ispell only when parent buffer is killed
2742 ;; to avoid over and over ispell kill.
2743 (window-buffer (minibuffer-selected-window))
2745 ;; 'local does not automatically make hook buffer-local in XEmacs.
2746 (if (featurep 'xemacs
)
2747 (make-local-hook 'kill-buffer-hook
))
2748 (add-hook 'kill-buffer-hook
2749 (lambda () (ispell-kill-ispell t
)) nil
'local
)))
2751 (if ispell-async-processp
2752 (set-process-filter ispell-process
'ispell-filter
))
2753 ;; Protect against XEmacs bogus binding of `enable-multibyte-characters'.
2754 (if (and (or (featurep 'xemacs
)
2755 (and (boundp 'enable-multibyte-characters
)
2756 enable-multibyte-characters
))
2757 (fboundp 'set-process-coding-system
))
2758 (set-process-coding-system ispell-process
(ispell-get-coding-system)
2759 (ispell-get-coding-system)))
2760 ;; Get version ID line
2761 (ispell-accept-output 3)
2762 ;; get more output if filter empty?
2763 (if (null ispell-filter
) (ispell-accept-output 3))
2764 (cond ((null ispell-filter
)
2765 (error "%s did not output version line" ispell-program-name
))
2767 (stringp (car ispell-filter
))
2768 (if (string-match "warning: " (car ispell-filter
))
2770 (ispell-accept-output 3) ; was warn msg.
2771 (stringp (car ispell-filter
)))
2772 (null (cdr ispell-filter
)))
2773 (string-match "^@(#) " (car ispell-filter
)))
2774 ;; got the version line as expected (we already know it's the right
2775 ;; version, so don't bother checking again.)
2778 ;; Otherwise, it must be an error message. Show the user.
2779 ;; But first wait to see if some more output is going to arrive.
2780 ;; Otherwise we get cool errors like "Can't open ".
2782 (ispell-accept-output 3)
2783 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
2784 (setq ispell-filter nil
) ; Discard version ID line
2785 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2786 (if extended-char-mode
; ~ extended character mode
2787 (ispell-send-string (concat extended-char-mode
"\n"))))
2788 (if ispell-async-processp
2789 (if (featurep 'emacs
)
2790 (set-process-query-on-exit-flag ispell-process nil
)
2791 (if (fboundp 'set-process-query-on-exit-flag
)
2792 (set-process-query-on-exit-flag ispell-process nil
)
2793 (process-kill-without-query ispell-process
)))))))
2796 (defun ispell-kill-ispell (&optional no-error clear
)
2797 "Kill current Ispell process (so that you may start a fresh one).
2798 With NO-ERROR, just return non-nil if there was no Ispell running.
2799 With CLEAR, buffer session localwords are cleaned."
2801 ;; This hook is typically used by flyspell to flush some variables used
2802 ;; to optimize the common cases.
2803 (run-hooks 'ispell-kill-ispell-hook
)
2805 (if (featurep 'xemacs
)
2807 (called-interactively-p 'interactive
)))
2808 (setq ispell-buffer-session-localwords nil
))
2809 (if (not (and ispell-process
2810 (eq (ispell-process-status) 'run
)))
2812 (error "There is no Ispell process running!"))
2813 (if ispell-async-processp
2814 (delete-process ispell-process
)
2815 ;; Synchronous processes.
2816 (ispell-send-string "\n") ; Make sure side effects occurred.
2817 (kill-buffer ispell-output-buffer
)
2818 (kill-buffer ispell-session-buffer
)
2819 (setq ispell-output-buffer nil
2820 ispell-session-buffer nil
))
2821 (setq ispell-process nil
)
2822 (message "Ispell process killed")
2825 ;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2826 ;; call ispell-init-process rather than wait for a spell checking command?
2829 (defun ispell-change-dictionary (dict &optional arg
)
2830 "Change to dictionary DICT for Ispell.
2831 With a prefix arg, set it \"globally\", for all buffers.
2832 Without a prefix arg, set it \"locally\", just for this buffer.
2834 By just answering RET you can find out what the current dictionary is."
2836 (list (completing-read
2837 "Use new dictionary (RET for current, SPC to complete): "
2838 (and (fboundp 'ispell-valid-dictionary-list
)
2839 (mapcar 'list
(ispell-valid-dictionary-list)))
2841 current-prefix-arg
))
2842 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
2843 (unless arg
(ispell-buffer-local-dict 'no-reload
))
2844 (if (equal dict
"default") (setq dict nil
))
2845 ;; This relies on completing-read's bug of returning "" for no match
2846 (cond ((equal dict
"")
2847 (ispell-internal-change-dictionary)
2848 (message "Using %s dictionary"
2849 (or (and (not arg
) ispell-local-dictionary
)
2850 ispell-dictionary
"default")))
2851 ((equal dict
(or (and (not arg
) ispell-local-dictionary
)
2852 ispell-dictionary
"default"))
2853 ;; Specified dictionary is the default already. Could reload
2854 ;; the dictionaries if needed.
2855 (ispell-internal-change-dictionary)
2856 (and (if (featurep 'xemacs
)
2858 (called-interactively-p 'interactive
))
2859 (message "No change, using %s dictionary" dict
)))
2860 (t ; reset dictionary!
2861 (if (or (assoc dict ispell-local-dictionary-alist
)
2862 (assoc dict ispell-dictionary-alist
))
2864 ;; set default dictionary
2865 (setq ispell-dictionary dict
)
2866 ;; set local dictionary
2867 (setq ispell-local-dictionary dict
)
2868 (setq ispell-local-dictionary-overridden t
))
2869 (error "Undefined dictionary: %s" dict
))
2870 (ispell-internal-change-dictionary)
2871 (setq ispell-buffer-session-localwords nil
)
2872 (message "%s Ispell dictionary set to %s"
2873 (if arg
"Global" "Local")
2876 (defun ispell-internal-change-dictionary ()
2877 "Update the dictionary and the personal dictionary used by Ispell.
2878 This may kill the Ispell process; if so, a new one will be started
2880 (let ((dict (or ispell-local-dictionary ispell-dictionary
))
2881 (pdict (or ispell-local-pdict ispell-personal-dictionary
)))
2882 (unless (and (equal ispell-current-dictionary dict
)
2883 (equal ispell-current-personal-dictionary pdict
))
2884 (ispell-kill-ispell t
)
2885 (setq ispell-current-dictionary dict
2886 ispell-current-personal-dictionary pdict
))))
2888 ;; Avoid error messages when compiling for these dynamic variables.
2889 (defvar ispell-start
)
2892 ;; Spelling of comments are checked when ispell-check-comments is non-nil.
2895 (defun ispell-region (reg-start reg-end
&optional recheckp shift
)
2896 "Interactively check a region for spelling errors.
2897 Return nil if spell session was terminated, otherwise returns shift offset
2898 amount for last line processed."
2899 (interactive "r") ; Don't flag errors on read-only bufs.
2900 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
2902 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
2903 (let ((skip-region-start (make-marker))
2904 (rstart (make-marker)))
2907 (message "Spell-checking %s using %s with %s dictionary..."
2908 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
2909 (buffer-name) "region")
2910 (file-name-nondirectory ispell-program-name
)
2911 (or ispell-current-dictionary
"default"))
2912 ;; Returns cursor to original location.
2913 (save-window-excursion
2914 (goto-char reg-start
)
2915 (let ((transient-mark-mode)
2916 (case-fold-search case-fold-search
)
2919 (let (message-log-max)
2920 (message "searching for regions to skip"))
2921 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t
)
2923 (setq key
(match-string-no-properties 0))
2924 (set-marker skip-region-start
(- (point) (length key
)))
2925 (goto-char reg-start
)))
2926 (let (message-log-max)
2928 "Continuing spelling check using %s with %s dictionary..."
2929 (file-name-nondirectory ispell-program-name
)
2930 (or ispell-current-dictionary
"default")))
2931 (set-marker rstart reg-start
)
2932 (set-marker ispell-region-end reg-end
)
2933 (while (and (not ispell-quit
)
2934 (< (point) ispell-region-end
))
2935 ;; spell-check region with skipping
2936 (if (and (marker-position skip-region-start
)
2937 (<= skip-region-start
(point)))
2939 ;; If region inside line comment, must keep comment start.
2940 (setq in-comment
(point)
2943 (or (null comment-end
) (string= "" comment-end
))
2946 (re-search-forward comment-start in-comment t
))
2948 ;; Can change skip-regexps (in ispell-message)
2949 (ispell-skip-region key
) ; moves pt past region.
2950 (set-marker rstart
(point))
2951 ;; check for saving large attachments...
2952 (setq query-fcc
(and query-fcc
2953 (ispell-ignore-fcc skip-region-start
2955 (if (and (< rstart ispell-region-end
)
2957 (ispell-begin-skip-region-regexp)
2958 ispell-region-end t
))
2960 (setq key
(match-string-no-properties 0))
2961 (set-marker skip-region-start
2962 (- (point) (length key
)))
2964 (set-marker skip-region-start nil
))))
2965 (setq reg-end
(max (point)
2966 (if (marker-position skip-region-start
)
2967 (min skip-region-start ispell-region-end
)
2968 (marker-position ispell-region-end
))))
2969 (let* ((ispell-start (point))
2970 (ispell-end (min (point-at-eol) reg-end
))
2971 (string (ispell-get-line
2972 ispell-start ispell-end in-comment
)))
2973 (if in-comment
; account for comment chars added
2974 (setq ispell-start
(- ispell-start
(length in-comment
))
2976 (setq ispell-end
(point)) ; "end" tracks region retrieved.
2977 (if string
; there is something to spell check!
2978 ;; (special start end)
2979 (setq shift
(ispell-process-line string
2980 (and recheckp shift
))))
2981 (goto-char ispell-end
)))))
2986 (if (and (not (and recheckp ispell-keep-choices-win
))
2987 (get-buffer ispell-choices-buffer
))
2988 (kill-buffer ispell-choices-buffer
))
2989 (set-marker skip-region-start nil
)
2990 (set-marker rstart nil
)
2993 ;; preserve or clear the region for ispell-continue.
2994 (if (not (numberp ispell-quit
))
2995 (set-marker ispell-region-end nil
)
2996 ;; Ispell-continue enabled - ispell-region-end is set.
2997 (goto-char ispell-quit
))
2998 ;; Check for aborting
2999 (if (and ispell-checking-message
(numberp ispell-quit
))
3001 (setq ispell-quit nil
)
3002 (error "Message send aborted")))
3003 (if (not recheckp
) (setq ispell-quit nil
)))
3004 (if (not recheckp
) (set-marker ispell-region-end nil
))
3005 ;; Only save if successful exit.
3006 (ispell-pdict-save ispell-silently-savep
)
3007 (message "Spell-checking %s using %s with %s dictionary...done"
3008 (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
3009 (buffer-name) "region")
3010 (file-name-nondirectory ispell-program-name
)
3011 (or ispell-current-dictionary
"default"))))))
3014 (defun ispell-begin-skip-region-regexp ()
3015 "Return a regexp of the search keys for region skipping.
3016 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
3017 Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
3023 (if (and ispell-checking-message
3024 (not (eq t ispell-checking-message
)))
3025 (mapconcat #'car ispell-checking-message
"\\|"))
3027 (if (eq ispell-parser
'tex
)
3028 (ispell-begin-tex-skip-regexp))
3030 (if ispell-skip-html
3031 (ispell-begin-skip-region ispell-html-skip-alists
))
3033 (if ispell-skip-tib ispell-tib-ref-beginning
)
3035 (if (and (eq 'exclusive ispell-check-comments
) comment-start
)
3036 ;; search from end of current comment to start of next comment.
3037 (if (string= "" comment-end
) "^" (regexp-quote comment-end
)))
3038 (if (and (null ispell-check-comments
) comment-start
)
3039 (regexp-quote comment-start
))
3040 (ispell-begin-skip-region ispell-skip-region-alist
)))
3044 (defun ispell-begin-skip-region (skip-alist)
3045 "Regular expression for start of regions to skip generated from SKIP-ALIST.
3046 Each selection should be a key of SKIP-ALIST;
3047 otherwise, the current line is skipped."
3048 (mapconcat (lambda (lst) (if (stringp (car lst
)) (car lst
) (eval (car lst
))))
3053 (defun ispell-begin-tex-skip-regexp ()
3054 "Regular expression of tex commands to skip.
3055 Generated from `ispell-tex-skip-alists'."
3058 (mapconcat (function (lambda (lst) (car lst
)))
3059 (car ispell-tex-skip-alists
)
3062 ;; keys wrapped in begin{}
3063 (mapconcat (function (lambda (lst)
3064 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
3067 (car (cdr ispell-tex-skip-alists
))
3071 (defun ispell-skip-region-list ()
3072 "Return a list describing key and body regions to skip for this buffer.
3073 Includes regions defined by `ispell-skip-region-alist', tex mode,
3074 `ispell-html-skip-alists', and `ispell-checking-message'.
3075 Manual checking must include comments and tib references.
3076 The list is of the form described by variable `ispell-skip-region-alist'.
3077 Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
3078 (let ((skip-alist ispell-skip-region-alist
))
3079 ;; only additional explicit region definition is tex.
3080 (if (eq ispell-parser
'tex
)
3081 (setq case-fold-search nil
3082 skip-alist
(append (car ispell-tex-skip-alists
)
3083 (car (cdr ispell-tex-skip-alists
))
3085 (if ispell-skip-html
3086 (setq skip-alist
(append ispell-html-skip-alists skip-alist
)))
3087 (if (and ispell-checking-message
3088 (not (eq t ispell-checking-message
)))
3089 (setq skip-alist
(append ispell-checking-message skip-alist
)))
3093 (defun ispell-tex-arg-end (&optional arg
)
3094 "Skip across ARG number of braces."
3097 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
3098 (forward-sexp (or arg
1)))
3100 (message "Error skipping s-expressions at point %d." (point))
3105 (defun ispell-ignore-fcc (start end
)
3106 "Delete the Fcc: message header when large attachments are included.
3107 Return value `nil' if file with large attachments is saved.
3108 This can be used to avoid multiple questions for multiple large attachments.
3109 Returns point to starting location afterwards."
3111 (if (and ispell-checking-message ispell-message-fcc-skip
)
3112 (if (< ispell-message-fcc-skip
(- end start
))
3113 (let (case-fold-search head-end
)
3114 (goto-char (point-min))
3116 (or (re-search-forward
3117 (concat "^" (regexp-quote mail-header-separator
) "$")
3119 (re-search-forward "^$" nil t
)
3121 (goto-char (point-min))
3122 (if (re-search-forward "^Fcc:" head-end t
)
3124 "Save copy of this message with large attachments? ")
3132 (defun ispell-skip-region (key)
3133 "Skip across KEY and then to end of region.
3134 Key lookup determines region to skip.
3135 Point is placed at end of skipped region."
3136 ;; move over key to begin checking.
3137 (forward-char (length key
))
3138 (let ((start (point))
3139 ;; Regenerate each call... This function can change region definition.
3140 (alist (ispell-skip-region-list))
3141 alist-key null-skip
)
3143 ;; what about quoted comment, or comment inside strings?
3144 ((and (null ispell-check-comments
) comment-start
3145 (string= key comment-start
))
3146 (if (string= "" comment-end
)
3148 (search-forward comment-end ispell-region-end t
)))
3149 ((and (eq 'exclusive ispell-check-comments
) comment-start
3150 (string= key comment-end
))
3151 (search-forward comment-start ispell-region-end
:end
))
3152 ((and ispell-skip-tib
(string-match ispell-tib-ref-beginning key
))
3153 (re-search-forward ispell-tib-ref-end ispell-region-end t
))
3154 ;; markings from alist
3157 (setq alist-key
(eval (car (car alist
))))
3158 (if (string-match alist-key key
)
3160 (setq alist
(cdr (car alist
)))
3162 ((null alist
) (setq null-skip t
)) ; done! Just skip key.
3163 ((not (consp alist
))
3164 ;; Search past end of spell region to find this region end.
3165 (re-search-forward (eval alist
) (point-max) t
))
3166 ((and (= 1 (length alist
))
3167 (stringp (car alist
)))
3168 (re-search-forward (car alist
) (point-max) t
))
3170 (setq null-skip t
) ; error handling in functions!
3171 (if (consp (cdr alist
))
3172 (apply (car alist
) (cdr alist
))
3173 (funcall (car alist
)))))
3175 (setq alist
(cdr alist
))))))
3176 (if (and (= start
(point)) (null null-skip
))
3178 (message "Matching region end for `%s' point %d not found"
3184 (defun ispell-get-line (start end in-comment
)
3185 "Grab the next line of data.
3186 Returns a string with the line data."
3187 (let ((ispell-casechars (ispell-get-casechars))
3189 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
3190 ((eolp) ; END OF LINE, just go to next line.
3192 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
3193 ;; (forward-char 1)) ; not needed as quoted below.
3194 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
3195 (re-search-forward "[][()${}]" end t
)) ; or MATH COMMANDS
3196 (setq string
(concat "^" in-comment
3197 (buffer-substring-no-properties start end
)
3200 (t (goto-char end
))) ; EMPTY LINE, skip it.
3204 (defun ispell-looking-at (string)
3205 (let ((coding (ispell-get-coding-system))
3206 (len (length string
)))
3207 (and (<= (+ (point) len
) (point-max))
3208 (equal (encode-coding-string string coding
)
3209 (encode-coding-string (buffer-substring-no-properties
3210 (point) (+ (point) len
))
3213 (defun ispell-process-line (string shift
)
3214 "Send STRING, a line of text, to ispell and process the result.
3215 This will modify the buffer for spelling errors.
3216 Requires variables ISPELL-START and ISPELL-END to be defined in its
3218 Returns the sum SHIFT due to changes in word replacements."
3219 ;;(declare special ispell-start ispell-end)
3220 (let (poss accept-list
)
3221 (if (not (numberp shift
))
3223 ;; send string to spell process and get input.
3224 (ispell-send-string string
)
3226 (ispell-accept-output)
3227 ;; Last item of output contains a blank line.
3228 (not (string= "" (car ispell-filter
)))))
3229 ;; parse all inputs from the stream one word at a time.
3230 ;; Place in FIFO order and remove the blank item.
3231 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
3232 (while (and (not ispell-quit
) ispell-filter
)
3233 ;; get next word, accounting for accepted words and start shifts
3234 (setq poss
(ispell-parse-output (car ispell-filter
)
3236 (if (and poss
(listp poss
)) ; spelling error occurred.
3237 ;; Whenever we have misspellings, we can change
3238 ;; the buffer. Keep boundaries as markers.
3239 ;; Markers can move with highlighting! This destroys
3240 ;; end of region markers line-end and ispell-region-end
3242 (copy-marker (+ ispell-start ispell-offset
(car (cdr poss
)))))
3243 (word-len (length (car poss
)))
3244 (line-end (copy-marker ispell-end
))
3245 (line-start (copy-marker ispell-start
))
3246 recheck-region replace
)
3247 (goto-char word-start
)
3248 ;; Adjust the horizontal scroll & point
3249 (ispell-horiz-scroll)
3250 (goto-char (+ word-len word-start
))
3251 (ispell-horiz-scroll)
3252 (goto-char word-start
)
3253 (ispell-horiz-scroll)
3255 ;; Alignment cannot be tracked and this error will occur when
3256 ;; `query-replace' makes multiple corrections on the starting line.
3257 (or (ispell-looking-at (car poss
))
3258 ;; This occurs due to filter pipe problems
3259 (error (concat "Ispell misalignment: word "
3260 "`%s' point %d; probably incompatible versions")
3261 (car poss
) (marker-position word-start
)))
3262 ;; ispell-cmd-loop can go recursive & change buffer
3263 (if ispell-keep-choices-win
3264 (setq replace
(ispell-command-loop
3265 (car (cdr (cdr poss
)))
3266 (car (cdr (cdr (cdr poss
))))
3267 (car poss
) (marker-position word-start
)
3268 (+ word-len
(marker-position word-start
))))
3269 (save-window-excursion
3270 (setq replace
(ispell-command-loop
3271 (car (cdr (cdr poss
)))
3272 (car (cdr (cdr (cdr poss
))))
3273 (car poss
) (marker-position word-start
)
3274 (+ word-len
(marker-position word-start
))))))
3276 (goto-char word-start
)
3277 ;; Recheck when query replace edit changes misspelled word.
3278 ;; Error in tex mode when a potential math mode change exists.
3279 (if (and replace
(listp replace
) (= 2 (length replace
)))
3280 (if (and (eq ispell-parser
'tex
)
3281 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3282 (regexp-quote string
)))
3284 "Don't start query replace on a line with math characters"
3286 (set-marker line-end
(point))
3287 (setq ispell-filter nil
3290 ;; insert correction if needed
3293 (equal 0 replace
)) ; ACCEPT/INSERT
3294 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
3295 (ispell-add-per-file-word-list (car poss
)))
3296 ;; do not recheck accepted word on this line
3297 (setq accept-list
(cons (car poss
) accept-list
)))
3298 (t ; replacement word selected or entered
3299 (delete-region (point) (+ word-len
(point)))
3300 (if (not (listp replace
))
3302 (insert replace
) ; insert dictionary word
3303 (ispell-send-replacement (car poss
) replace
)
3304 (setq accept-list
(cons replace accept-list
)))
3305 (let ((replace-word (car replace
)))
3306 ;; Recheck hand entered replacement word
3307 (insert replace-word
)
3308 (ispell-send-replacement (car poss
) replace-word
)
3309 (if (car (cdr replace
))
3310 (save-window-excursion
3311 (delete-other-windows) ; to correctly show help.
3312 ;; Assume case-replace &
3313 ;; case-fold-search correct?
3314 (query-replace (car poss
) (car replace
) t
)))
3315 (goto-char word-start
)
3316 ;; do not recheck if already accepted
3317 (if (member replace-word accept-list
)
3318 (setq accept-list
(cons replace-word accept-list
)
3319 replace replace-word
)
3320 (let ((region-end (copy-marker ispell-region-end
)))
3321 (setq recheck-region ispell-filter
3322 ispell-filter nil
; save filter
3323 shift
0 ; already accounted
3324 shift
(ispell-region
3326 (+ word-start
(length replace-word
))
3328 (if (null shift
) ; quitting check.
3330 (set-marker ispell-region-end region-end
)
3331 (set-marker region-end nil
)
3332 (setq ispell-filter recheck-region
3334 replace replace-word
)))))
3336 (setq shift
(+ shift
(- (length replace
) word-len
)))
3338 ;; Move line-start across word...
3339 ;; new shift function does this now...
3340 ;;(set-marker line-start (+ line-start
3341 ;; (- (length replace)
3342 ;; (length (car poss)))))
3344 (if (not ispell-quit
)
3345 ;; FIXME: remove redundancy with identical code above.
3346 (let (message-log-max)
3348 "Continuing spelling check using %s with %s dictionary..."
3349 (file-name-nondirectory ispell-program-name
)
3350 (or ispell-current-dictionary
"default"))))
3352 (setq ispell-start
(marker-position line-start
)
3353 ispell-end
(marker-position line-end
))
3354 ;; Adjust markers when end of region lost from highlighting.
3355 (if (and (not recheck-region
)
3356 (< ispell-end
(+ word-start word-len
)))
3357 (setq ispell-end
(+ word-start word-len
)))
3358 (if (= word-start ispell-region-end
)
3359 (set-marker ispell-region-end
(+ word-start word-len
)))
3360 ;; going out of scope - unneeded
3361 (set-marker line-start nil
)
3362 (set-marker word-start nil
)
3363 (set-marker line-end nil
)))
3364 ;; finished with misspelling!
3365 (setq ispell-filter
(cdr ispell-filter
)))
3370 (defun ispell-comments-and-strings ()
3371 "Check comments and strings in the current buffer for spelling errors."
3373 (goto-char (point-min))
3377 (setq state
(parse-partial-sexp (point) (point-max)
3378 nil nil state
'syntax-table
))
3379 (if (or (nth 3 state
) (nth 4 state
))
3380 (let ((start (point)))
3381 (setq state
(parse-partial-sexp start
(point-max)
3382 nil nil state
'syntax-table
))
3383 (if (or (nth 3 state
) (nth 4 state
))
3384 (error "Unterminated string or comment"))
3386 (setq done
(not (ispell-region start
(point))))))))))
3390 (defun ispell-buffer ()
3391 "Check the current buffer for spelling errors interactively."
3393 (ispell-region (point-min) (point-max)))
3397 (defun ispell-continue ()
3398 "Continue a halted spelling session beginning with the current word."
3400 (if (not (marker-position ispell-region-end
))
3401 (message "No session to continue. Use 'X' command when checking!")
3402 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
3403 (message "Must continue ispell from buffer %s"
3404 (buffer-name (marker-buffer ispell-region-end
)))
3406 ;; find beginning of current word:
3407 (car (cdr (ispell-get-word t
)))
3408 (marker-position ispell-region-end
)))))
3411 ;;; Horizontal scrolling
3412 (defun ispell-horiz-scroll ()
3413 "Place point within the horizontal visibility of its window area."
3414 (if truncate-lines
; display truncating lines?
3415 ;; See if display needs to be scrolled.
3416 (let ((column (- (current-column) (max (window-hscroll) 1))))
3417 (if (and (< column
0) (> (window-hscroll) 0))
3418 (scroll-right (max (- column
) 10))
3419 (if (>= column
(- (window-width) 2))
3420 (scroll-left (max (- column
(window-width) -
3) 10)))))))
3423 ;;; Interactive word completion.
3424 ;; Forces "previous-word" processing. Do we want to make this selectable?
3427 (defun ispell-complete-word (&optional interior-frag
)
3428 "Try to complete the word before or under point (see `lookup-words').
3429 If optional INTERIOR-FRAG is non-nil then the word may be a character
3430 sequence inside of a word.
3432 Standard ispell choices are then available."
3433 ;; FIXME: completion-at-point-function.
3435 (let ((cursor-location (point))
3436 (case-fold-search-val case-fold-search
)
3437 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
3438 start end possibilities replacement
)
3439 (setq start
(car (cdr word
))
3440 end
(car (cdr (cdr word
)))
3443 (or (string= word
"") ; Will give you every word
3444 (lookup-words (concat (and interior-frag
"*") word
3445 (if (or interior-frag
(null ispell-look-p
))
3447 (or ispell-complete-word-dict
3448 ispell-alternate-dictionary
))))
3449 (cond ((eq possibilities t
)
3450 (message "No word to complete"))
3451 ((null possibilities
)
3452 (message "No match for \"%s\"" word
))
3453 (t ; There is a modification...
3454 (setq case-fold-search nil
) ; Try and respect case of word.
3456 ((string-equal (upcase word
) word
)
3457 (setq possibilities
(mapcar 'upcase possibilities
)))
3458 ((eq (upcase (aref word
0)) (aref word
0))
3459 (setq possibilities
(mapcar (function
3461 (if (eq (aref word
0) (aref pos
0))
3465 (setq case-fold-search case-fold-search-val
)
3466 (save-window-excursion
3468 (ispell-command-loop possibilities nil word start end
)))
3470 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
3471 (ispell-add-per-file-word-list word
))
3472 (replacement ; REPLACEMENT WORD
3473 (delete-region start end
)
3474 (setq word
(if (atom replacement
) replacement
(car replacement
))
3475 cursor-location
(+ (- (length word
) (- end start
))
3478 (if (not (atom replacement
)) ; recheck spelling of replacement.
3480 (goto-char cursor-location
)
3481 (ispell-word nil t
)))))
3482 (if (get-buffer ispell-choices-buffer
)
3483 (kill-buffer ispell-choices-buffer
))))
3484 (ispell-pdict-save ispell-silently-savep
)
3485 (goto-char cursor-location
)))
3489 (defun ispell-complete-word-interior-frag ()
3490 "Completes word matching character sequence inside a word."
3492 (ispell-complete-word t
))
3497 "Interactively check a region or buffer for spelling errors.
3498 If `transient-mark-mode' is on, and a region is active, spell-check
3499 that region. Otherwise spell-check the buffer.
3501 Ispell dictionaries are not distributed with Emacs. If you are
3502 looking for a dictionary, please see the distribution of the GNU ispell
3503 program, or do an Internet search; there are various dictionaries
3504 available on the net."
3506 (if (and (boundp 'transient-mark-mode
) transient-mark-mode
3507 (boundp 'mark-active
) mark-active
)
3508 (ispell-region (region-beginning) (region-end))
3512 ;;; **********************************************************************
3513 ;;; Ispell Minor Mode
3514 ;;; **********************************************************************
3516 (defvar ispell-minor-keymap
3517 (let ((map (make-sparse-keymap)))
3518 (define-key map
" " 'ispell-minor-check
)
3519 (define-key map
"\r" 'ispell-minor-check
)
3521 "Keymap used for Ispell minor mode.")
3524 (define-minor-mode ispell-minor-mode
3525 "Toggle last-word spell checking (Ispell minor mode).
3526 With a prefix argument ARG, enable Ispell minor mode if ARG is
3527 positive, and disable it otherwise. If called from Lisp, enable
3528 the mode if ARG is omitted or nil.
3530 Ispell minor mode is a buffer-local minor mode. When enabled,
3531 typing SPC or RET warns you if the previous word is incorrectly
3534 All the buffer-local variables and dictionaries are ignored. To
3535 read them into the running ispell process, type \\[ispell-word]
3538 For spell-checking \"on the fly\", not just after typing SPC or
3539 RET, use `flyspell-mode'."
3540 nil
" Spell" ispell-minor-keymap
)
3542 (defun ispell-minor-check ()
3543 "Check previous word, then continue with the normal binding of this key.
3544 Don't check previous word when character before point is a space or newline.
3545 Don't read buffer-local settings or word lists."
3547 (let ((ispell-minor-mode nil
)
3548 (ispell-check-only t
)
3549 (last-char (char-after (1- (point)))))
3550 (command-execute (key-binding (this-command-keys)))
3551 (if (not (or (eq last-char ?\
) (eq last-char ?
\n)
3552 (and ispell-skip-html
(eq last-char ?
>))
3553 (and ispell-skip-html
(eq last-char ?\
;))))
3554 (ispell-word nil t
))))
3557 ;;; **********************************************************************
3559 ;;; **********************************************************************
3561 (defvar ispell-message-text-end
3562 (mapconcat (function identity
)
3564 ;; Don't spell check signatures
3566 ;; Matches PostScript files.
3567 ;;"^%!PS-Adobe-[123].0"
3568 ;; Matches uuencoded text
3569 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3570 ;; Matches shell files (especially auto-decoding)
3572 ;; Matches context difference listing
3573 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3574 ;; Matches unidiff difference listing
3575 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@"
3576 ;; Matches reporter.el bug report
3577 "^current state:\n==============\n"
3578 ;; Matches commonly used "cut" boundaries
3579 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3581 "Text beyond which `ispell-message' will not spell-check.
3582 If it is a string, limit is the first occurrence of that regular expression.
3583 Otherwise, it must be a function which is called to get the limit.")
3584 (put 'ispell-message-text-end
'risky-local-variable t
)
3587 (defun ispell-mime-multipartp (&optional limit
)
3588 "Return multipart message start boundary or nil if none."
3589 ;; caller must ensure `case-fold-search' is set to `t'
3592 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3595 (if (looking-at "\"")
3598 (setq start
(point))
3599 (while (not (looking-at "\""))
3601 (setq boundary
(buffer-substring-no-properties start
(point))))
3602 (let ((start (point)))
3603 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3605 (setq boundary
(buffer-substring-no-properties start
(point)))))
3606 (if (< (length boundary
) 1)
3608 (concat "--" boundary
)))))
3611 (defun ispell-mime-skip-part (boundary)
3612 "Move point across header, or entire MIME part if message is encoded.
3613 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3614 encoded and therefore skipped. See rfc 1521, 2183, ...
3615 If no boundary is given, then entire message is skipped.
3617 This starts one line ABOVE the MIME content messages, on the boundary marker,
3618 for operation with the generic region-skipping code.
3619 This places new MIME boundaries into variable `ispell-checking-message'."
3620 (forward-line) ; skip over boundary to headers
3621 (let ((save-case-fold-search case-fold-search
)
3624 (setq case-fold-search t
3625 ispell-skip-html nil
)
3627 (setq continuep nil
)
3628 (if (looking-at "Content-Type: *text/")
3630 (goto-char (match-end 0))
3631 (if (looking-at "html")
3632 (setq ispell-skip-html t
))
3635 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3637 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3638 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3639 (setq textp
(member (upcase match
)
3640 ;; only spell check the following encodings:
3641 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3643 (goto-char (match-end 0))
3644 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3646 ;; hierarchical boundary definition
3647 (if (looking-at "Content-Type: *multipart/")
3648 (let ((new-boundary (ispell-mime-multipartp)))
3649 (if (string-match new-boundary boundary
)
3651 ;; first pass redefine skip function to include new boundary
3652 ;;(re-search-backward boundary nil t)
3654 (setq ispell-checking-message
3656 (list new-boundary
'ispell-mime-skip-part new-boundary
)
3657 (if (eq t ispell-checking-message
) nil
3658 ispell-checking-message
))
3661 ;; Skip all MIME headers that don't affect spelling
3662 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3665 (goto-char (match-end 0))
3668 (setq case-fold-search save-case-fold-search
)
3671 ;; encoded message. Skip to boundary, or entire message.
3673 (goto-char (point-max))
3674 (re-search-forward boundary nil t
)
3680 (defun ispell-message ()
3681 "Check the spelling of a mail message or news post.
3682 Don't check spelling of message headers except the Subject field.
3683 Don't check included messages.
3685 To abort spell checking of a message region and send the message anyway,
3686 use the `x' command. (Any subsequent regions will be checked.)
3687 The `X' command aborts sending the message so that you can edit the buffer.
3689 To spell-check whenever a message is sent, include the appropriate lines
3691 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3692 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3693 (add-hook 'mail-send-hook 'ispell-message)
3694 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3696 You can bind this to the key C-c i in GNUS or mail by adding to
3697 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3698 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3701 (goto-char (point-min))
3702 (let* (boundary mimep
3703 (ispell-skip-region-alist-save ispell-skip-region-alist
)
3704 ;; Nil when message came from outside (eg calling Emacs as editor)
3705 ;; Non-nil marker of end of headers.
3708 (concat "^" (regexp-quote mail-header-separator
) "$") nil t
))
3709 (end-of-headers ; Start of body.
3711 (or internal-messagep
3712 (re-search-forward "^$" nil t
)
3714 (limit (copy-marker ; End of region we will spell check.
3716 ((not ispell-message-text-end
) (point-max))
3717 ((char-or-string-p ispell-message-text-end
)
3718 (if (re-search-forward ispell-message-text-end nil t
)
3721 (t (min (point-max) (funcall ispell-message-text-end
))))))
3722 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3723 (if (and (boundp 'mail-yank-prefix
) mail-yank-prefix
)
3724 (ispell-non-empty-string mail-yank-prefix
)
3726 (cite-regexp ;Prefix of quoted text
3728 ((functionp 'sc-cite-regexp
) ; sc 3.0
3729 (ispell-with-no-warnings
3730 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3731 (ispell-non-empty-string sc-reference-tag-string
))))
3732 ((boundp 'sc-cite-regexp
) ; sc 2.3
3733 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
3734 (ispell-with-no-warnings
3735 (ispell-non-empty-string sc-reference-tag-string
))))
3736 ((or (equal major-mode
'news-reply-mode
) ;GNUS 4 & below
3737 (equal major-mode
'message-mode
)) ;GNUS 5
3738 (concat "In article <" "\\|"
3739 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3740 (ispell-with-no-warnings message-cite-prefix-regexp
)
3743 ((equal major-mode
'mh-letter-mode
) ; mh mail message
3744 (concat "[^,;&+=\n]+ writes:" "\\|"
3745 (ispell-with-no-warnings
3746 (ispell-non-empty-string mh-ins-buf-prefix
))))
3747 ((not internal-messagep
) ; Assume nn sent us this message.
3748 (concat "In [a-zA-Z.]+ you write:" "\\|"
3749 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3751 ((boundp 'vm-included-text-prefix
) ; VM mail message
3752 (concat "[^,;&+=\n]+ writes:" "\\|"
3753 (ispell-non-empty-string vm-included-text-prefix
)))
3754 (t default-prefix
)))
3755 (ispell-skip-region-alist
3756 (cons (list (concat "^\\(" cite-regexp
"\\)")
3757 (function forward-line
))
3758 ispell-skip-region-alist
))
3759 (old-case-fold-search case-fold-search
)
3760 (dictionary-alist ispell-message-dictionary-alist
)
3761 (ispell-checking-message t
))
3763 ;; Select dictionary for message
3764 (or (local-variable-p 'ispell-local-dictionary
(current-buffer))
3765 (while dictionary-alist
3766 (goto-char (point-min))
3767 (if (re-search-forward (car (car dictionary-alist
))
3769 (setq ispell-local-dictionary
(cdr (car dictionary-alist
))
3770 dictionary-alist nil
)
3771 (setq dictionary-alist
(cdr dictionary-alist
)))))
3775 ;; Spell check any original Subject:
3776 (goto-char (point-min))
3777 (setq case-fold-search t
3778 mimep
(re-search-forward "MIME-Version:" end-of-headers t
))
3779 (goto-char (point-min))
3780 (if (re-search-forward "^Subject: *" end-of-headers t
)
3782 (goto-char (match-end 0))
3783 (if (and (not (looking-at ".*Re\\>"))
3784 (not (looking-at "\\[")))
3786 (setq case-fold-search old-case-fold-search
)
3787 (ispell-region (point)
3788 (progn ;Tab-initiated continuation lns.
3790 (while (looking-at "\n[ \t]")
3795 (goto-char (point-min))
3796 (setq boundary
(ispell-mime-multipartp end-of-headers
))))
3797 ;; Adjust message limit to MIME message if necessary.
3799 (re-search-forward (concat boundary
"--") nil t
)
3800 (re-search-backward boundary nil t
)
3801 (< (point) (marker-position limit
))
3802 (set-marker limit
(point)))
3803 (goto-char (point-min))
3804 ;; Select type or skip checking if this is a non-multipart message
3805 ;; Point moved to end of buffer if region is encoded.
3806 (when (and mimep
(not boundary
))
3807 (goto-char (point-min))
3808 (re-search-forward "Content-[^ \t]*:" end-of-headers t
)
3809 (forward-line -
1) ; following fn starts one line above
3810 (ispell-mime-skip-part nil
)
3811 ;; if message-text-end region, limit may be less than point.
3812 (if (> (point) limit
)
3813 (set-marker limit
(point))))
3814 (goto-char (max end-of-headers
(point)))
3816 (setq case-fold-search old-case-fold-search
)
3817 ;; Define MIME regions to skip.
3819 (setq ispell-checking-message
3820 (list (list boundary
'ispell-mime-skip-part boundary
))))
3821 (ispell-region (point) limit
))
3822 (set-marker end-of-headers nil
)
3823 (set-marker limit nil
)
3824 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3825 ispell-skip-html nil
3826 case-fold-search old-case-fold-search
)))))
3829 (defun ispell-non-empty-string (string)
3830 (if (or (not string
) (string-equal string
""))
3831 "\\'\\`" ; An unmatchable string if string is null.
3832 (regexp-quote string
)))
3835 ;;; **********************************************************************
3836 ;;; Buffer Local Functions
3837 ;;; **********************************************************************
3840 (defun ispell-accept-buffer-local-defs ()
3841 "Load all buffer-local information, restarting Ispell when necessary."
3842 (ispell-buffer-local-dict) ; May kill ispell-process.
3843 (ispell-buffer-local-words) ; Will initialize ispell-process.
3844 (ispell-buffer-local-parsing))
3847 (defun ispell-buffer-local-parsing ()
3848 "Place Ispell into parsing mode for this buffer.
3849 Overrides the default parsing mode.
3850 Includes LaTeX/Nroff modes and extended character mode."
3851 ;; (ispell-init-process) must already be called.
3852 (ispell-send-string "!\n") ; Put process in terse mode.
3853 ;; We assume all major modes with "tex-mode" in them should use latex parsing
3854 ;; When exclusively checking comments, set to raw text mode (nroff).
3855 (if (and (not (eq 'exclusive ispell-check-comments
))
3856 (or (and (eq ispell-parser
'use-mode-name
)
3857 (string-match "[Tt][Ee][Xx]-mode"
3858 (symbol-name major-mode
)))
3859 (eq ispell-parser
'tex
)))
3861 (ispell-send-string "+\n") ; set ispell mode to tex
3862 (if (not (eq ispell-parser
'tex
))
3863 (set (make-local-variable 'ispell-parser
) 'tex
)))
3864 (ispell-send-string "-\n")) ; set mode to normal (nroff)
3865 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
3866 (if (and ispell-skip-html
(not (eq ispell-skip-html t
)))
3867 (setq ispell-skip-html
3868 (not (null (string-match "sgml\\|html\\|xml"
3869 (downcase (symbol-name major-mode
)))))))
3870 ;; Set default extended character mode for given buffer, if any.
3871 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3872 (if extended-char-mode
3873 (ispell-send-string (concat extended-char-mode
"\n"))))
3874 ;; Set buffer-local parsing mode and extended character mode, if specified.
3876 (goto-char (point-max))
3877 ;; Uses last occurrence of ispell-parsing-keyword
3878 (if (search-backward ispell-parsing-keyword nil t
)
3879 (let ((end (point-at-eol))
3881 (search-forward ispell-parsing-keyword
)
3882 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
3883 ;; space separated definitions.
3884 (setq string
(downcase (match-string-no-properties 1)))
3885 (cond ((and (string-match "latex-mode" string
)
3886 (not (eq 'exclusive ispell-check-comments
)))
3887 (ispell-send-string "+\n~tex\n"))
3888 ((string-match "nroff-mode" string
)
3889 (ispell-send-string "-\n~nroff\n"))
3890 ((string-match "~" string
) ; Set extended character mode.
3891 (ispell-send-string (concat string
"\n")))
3892 (t (message "Invalid Ispell Parsing argument!")
3896 ;; Can kill the current ispell process
3898 (defun ispell-buffer-local-dict (&optional no-reload
)
3899 "Initializes local dictionary and local personal dictionary.
3900 If optional NO-RELOAD is non-nil, do not reload any dictionary.
3901 When a dictionary is defined in the buffer (see variable
3902 `ispell-dictionary-keyword'), it will override the local setting
3903 from \\[ispell-change-dictionary].
3904 Both should not be used to define a buffer-local dictionary."
3906 (goto-char (point-min))
3908 ;; Override the local variable definition.
3909 ;; Uses last occurrence of ispell-dictionary-keyword.
3910 (goto-char (point-max))
3911 (unless ispell-local-dictionary-overridden
3912 (if (search-backward ispell-dictionary-keyword nil t
)
3914 (search-forward ispell-dictionary-keyword
)
3915 (setq end
(point-at-eol))
3916 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3917 (setq ispell-local-dictionary
3918 (match-string-no-properties 1))))))
3919 (goto-char (point-max))
3920 (if (search-backward ispell-pdict-keyword nil t
)
3922 (search-forward ispell-pdict-keyword
)
3923 (setq end
(point-at-eol))
3924 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
3925 (setq ispell-local-pdict
3926 (match-string-no-properties 1)))))))
3928 ;; Reload if new dictionary (maybe the personal one) defined.
3929 (ispell-internal-change-dictionary)))
3932 (defun ispell-buffer-local-words ()
3933 "Load the buffer-local dictionary in the current buffer."
3934 ;; If there's an existing ispell process that's wrong for this use,
3936 (if (and ispell-buffer-local-name
3937 (not (equal ispell-buffer-local-name
(buffer-name))))
3938 (ispell-kill-ispell t
))
3939 ;; Actually start a new ispell process, because we need
3940 ;; to send commands now to specify the local words to it.
3941 (ispell-init-process)
3942 (dolist (session-localword ispell-buffer-session-localwords
)
3943 (ispell-send-string (concat "@" session-localword
"\n")))
3944 (or ispell-buffer-local-name
3945 (if ispell-buffer-session-localwords
3946 (setq ispell-buffer-local-name
(buffer-name))))
3948 (goto-char (point-min))
3949 (while (search-forward ispell-words-keyword nil t
)
3950 (or ispell-buffer-local-name
3951 (setq ispell-buffer-local-name
(buffer-name)))
3952 (let ((end (point-at-eol))
3953 (ispell-casechars (ispell-get-casechars))
3955 ;; buffer-local words separated by a space, and can contain
3956 ;; any character other than a space. Not rigorous enough.
3957 (while (re-search-forward " *\\([^ ]+\\)" end t
)
3958 (setq string
(match-string-no-properties 1))
3959 ;; This can fail when string contains a word with invalid chars.
3960 ;; Error handling needs to be added between ispell and Emacs.
3961 (if (and (< 1 (length string
))
3962 (equal 0 (string-match ispell-casechars string
)))
3963 (ispell-send-string (concat "@" string
"\n"))))))))
3966 ;; Returns optionally adjusted region-end-point.
3968 ;; If comment-padright is defined, newcomment must be loaded.
3969 (declare-function comment-add
"newcomment" (arg))
3971 (defun ispell-add-per-file-word-list (word)
3972 "Add WORD to the per-file word list."
3973 (or ispell-buffer-local-name
3974 (setq ispell-buffer-local-name
(buffer-name)))
3976 (goto-char (point-min))
3977 (let (line-okay search done found
)
3979 (let ((case-fold-search nil
))
3980 (setq search
(search-forward ispell-words-keyword nil
'move
)
3981 found
(or found search
)
3982 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
3983 (progn (end-of-line) (current-column)))
3985 (if (or (and search line-okay
)
3992 (unless found
(newline))
3993 (insert (if comment-start
3995 (if (fboundp 'comment-padright
)
3996 ;; Try and use the proper comment marker,
3997 ;; e.g. ";;" rather than ";".
3998 (comment-padright comment-start
4003 ispell-words-keyword
)
4004 (if (and comment-end
(> (length comment-end
) 0))
4007 (insert comment-end
)))))
4008 (insert (concat " " word
))))))))
4010 (add-to-list 'debug-ignored-errors
"^No word found to check!$")
4015 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
4017 ;; Local Variable options:
4018 ;; mode: name(-mode)
4020 ;; local-variable: value
4022 ;; The following sets the buffer local dictionary to `american' English
4023 ;; and spell checks only comments.
4027 ;; comment-column: 40
4028 ;; ispell-check-comments: exclusive
4029 ;; ispell-local-dictionary: "american"
4033 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
4035 ;; The following places this file in nroff parsing and extended char modes.
4036 ;; Local IspellParsing: nroff-mode ~nroff
4037 ;; Change IspellPersDict to IspellPersDict: to enable the following line.
4038 ;; Local IspellPersDict ~/.ispell_lisp
4039 ;; The following were automatically generated by ispell using the 'A' command:
4040 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
4041 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
4042 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
4043 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
4044 ; LocalWords: minipage pers dict unhighlight buf grep sync prev inc
4045 ; LocalWords: fn oldot NB AIX msg init read's bufs pt cmd Quinlan eg
4046 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict
4047 ; LocalWords: lns XEmacs HTML casechars Multibyte
4049 ;;; ispell.el ends here