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."
360 :set
(lambda (symbol value
)
361 (set-default symbol value
)
362 (if (featurep 'ispell
)
363 (ispell-set-spellchecker-params)))
366 (defcustom ispell-alternate-dictionary
367 (cond ((file-readable-p "/usr/dict/web2") "/usr/dict/web2")
368 ((file-readable-p "/usr/share/dict/web2") "/usr/share/dict/web2")
369 ((file-readable-p "/usr/dict/words") "/usr/dict/words")
370 ((file-readable-p "/usr/lib/dict/words") "/usr/lib/dict/words")
371 ((file-readable-p "/usr/share/dict/words") "/usr/share/dict/words")
372 ((file-readable-p "/usr/share/lib/dict/words")
373 "/usr/share/lib/dict/words")
374 ((file-readable-p "/sys/dict") "/sys/dict"))
375 "Alternate plain word-list dictionary for spelling help."
376 :type
'(choice file
(const :tag
"None" nil
))
379 (defcustom ispell-complete-word-dict nil
380 "Plain word-list dictionary used for word completion if
381 different from `ispell-alternate-dictionary'."
382 :type
'(choice file
(const :tag
"None" nil
))
385 (defcustom ispell-message-dictionary-alist nil
386 "List used by `ispell-message' to select a new dictionary.
387 It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
388 in the message headers, `ispell-local-dictionary' will be set to
389 DICTIONARY if `ispell-local-dictionary' is not buffer-local.
390 E.g. you may use the following value:
391 '((\"^Newsgroups:[ \\t]*de\\\\.\" . \"deutsch8\")
392 (\"^To:[^\\n,]+\\\\.de[ \\t\\n,>]\" . \"deutsch8\"))"
393 :type
'(repeat (cons regexp string
))
397 (defcustom ispell-message-fcc-skip
50000
398 "Query before saving Fcc message copy if attachment larger than this value.
399 Always stores Fcc copy of message when nil."
400 :type
'(choice integer
(const :tag
"off" nil
))
404 (defcustom ispell-grep-command
405 ;; MS-Windows/MS-DOS have `egrep' as a Unix shell script, so they
406 ;; cannot invoke it. Use "grep -E" instead (see ispell-grep-options
408 (if (memq system-type
'(windows-nt ms-dos
)) "grep" "egrep")
409 "Name of the grep command for search processes."
413 (defcustom ispell-grep-options
414 (if (memq system-type
'(windows-nt ms-dos
)) "-Ei" "-i")
415 "String of options to use when running the program in `ispell-grep-command'.
416 Should probably be \"-i\" or \"-e\".
417 Some machines (like the NeXT) don't support \"-i\"."
421 (defcustom ispell-look-command
422 (cond ((file-exists-p "/bin/look") "/bin/look")
423 ((file-exists-p "/usr/local/bin/look") "/usr/local/bin/look")
424 ((file-exists-p "/usr/bin/look") "/usr/bin/look")
426 "Name of the look command for search processes.
427 This must be an absolute file name."
431 (defcustom ispell-look-p
(file-exists-p ispell-look-command
)
432 "Non-nil means use `look' rather than `grep'.
433 Default is based on whether `look' seems to be available."
437 (defcustom ispell-have-new-look nil
438 "Non-nil means use the `-r' option (regexp) when running `look'."
442 (defcustom ispell-look-options
(if ispell-have-new-look
"-dfr" "-df")
443 "String of command options for `ispell-look-command'."
447 (defcustom ispell-use-ptys-p nil
448 "When non-nil, Emacs uses ptys to communicate with Ispell.
449 When nil, Emacs uses pipes."
453 (defcustom ispell-following-word nil
454 "Non-nil means `ispell-word' checks the word around or after point.
455 Otherwise `ispell-word' checks the preceding word."
459 (defcustom ispell-help-in-bufferp nil
460 "Non-nil means display interactive keymap help in a buffer.
461 The following values are supported:
462 nil Expand the minibuffer and display a short help message
463 there for a couple of seconds.
464 t Pop up a new buffer and display a short help message there
465 for a couple of seconds.
466 electric Pop up a new buffer and display a long help message there.
467 User can browse and then exit the help mode."
468 :type
'(choice (const electric
) (const :tag
"off" nil
) (const :tag
"on" t
))
471 (defcustom ispell-quietly nil
472 "Non-nil means suppress messages in `ispell-word'."
476 (defcustom ispell-format-word-function
(function upcase
)
477 "Formatting function for displaying word being spell checked.
478 The function must take one string argument and return a string."
481 (defvaralias 'ispell-format-word
'ispell-format-word-function
)
483 (defcustom ispell-use-framepop-p nil
484 "When non-nil ispell uses framepop to display choices in a dedicated frame.
485 You can set this variable to dynamically use framepop if you are in a
486 window system by evaluating the following on startup to set this variable:
487 (and window-system (condition-case () (require 'framepop) (error nil)))"
492 (defcustom ispell-personal-dictionary nil
493 "File name of your personal spelling dictionary, or nil.
494 If nil, the default personal dictionary, (\"~/.ispell_DICTNAME\" for ispell or
495 \"~/.aspell.LANG.pws\" for aspell) is used, where DICTNAME is the name of your
496 default dictionary and LANG the two letter language code."
498 (const :tag
"default" nil
))
501 (defcustom ispell-silently-savep nil
502 "When non-nil, save personal dictionary without asking for confirmation."
506 (defvar ispell-local-dictionary-overridden nil
507 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
508 (make-variable-buffer-local 'ispell-local-dictionary-overridden
)
510 (defcustom ispell-local-dictionary nil
511 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
512 The value must be a string dictionary name,
513 or nil, which means use the global setting in `ispell-dictionary'.
514 Dictionary names are defined in `ispell-local-dictionary-alist'
515 and `ispell-dictionary-alist'.
517 Setting `ispell-local-dictionary' to a value has the same effect as
518 calling \\[ispell-change-dictionary] with that value. This variable
519 is automatically set when defined in the file with either
520 `ispell-dictionary-keyword' or the Local Variable syntax."
521 :type
'(choice string
522 (const :tag
"default" nil
))
525 (put 'ispell-local-dictionary
'safe-local-variable
'string-or-null-p
)
527 (make-variable-buffer-local 'ispell-local-dictionary
)
529 (defcustom ispell-dictionary nil
530 "Default dictionary to use if `ispell-local-dictionary' is nil."
531 :type
'(choice string
532 (const :tag
"default" nil
))
535 (defcustom ispell-extra-args nil
536 "If non-nil, a list of extra switches to pass to the Ispell program.
537 For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
538 words as correct. See also `ispell-dictionary-alist', which may be used
539 for language-specific arguments."
540 :type
'(repeat string
)
545 (defcustom ispell-skip-html
'use-mode-name
546 "Indicates whether ispell should skip spell checking of SGML markup.
547 If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
548 guess whether SGML markup should be skipped according to the name of the
549 buffer's major mode."
550 :type
'(choice (const :tag
"always" t
) (const :tag
"never" nil
)
551 (const :tag
"use-mode-name" use-mode-name
))
554 (make-variable-buffer-local 'ispell-skip-html
)
557 (defcustom ispell-local-dictionary-alist nil
558 "List of local or customized dictionary definitions.
559 These can override the values in `ispell-dictionary-alist'.
561 To make permanent changes to your dictionary definitions, you
562 will need to make your changes in this variable, save, and then
564 :type
'(repeat (list (choice :tag
"Dictionary"
565 (string :tag
"Dictionary name")
566 (const :tag
"default" nil
))
567 (regexp :tag
"Case characters")
568 (regexp :tag
"Non case characters")
569 (regexp :tag
"Other characters")
570 (boolean :tag
"Many other characters")
571 (repeat :tag
"Ispell command line args"
573 (choice :tag
"Extended character mode"
574 (const "~tex") (const "~plaintex")
575 (const "~nroff") (const "~list")
576 (const "~latin1") (const "~latin3")
577 (const :tag
"default" nil
))
578 (coding-system :tag
"Coding System")))
582 (defvar ispell-dictionary-base-alist
584 ;; The default dictionary. It may be English.aff, or any other
585 ;; dictionary depending on locale and such things. We should probably
586 ;; ask ispell what dictionary it's using, but until we do that, let's
587 ;; just use a minimal regexp. [:alpha:] will later be set if possible.
588 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
589 ("american" ; Yankee English
590 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
591 ("brasileiro" ; Brazilian mode
592 "[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]"
593 "[^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]"
594 "[']" nil nil nil iso-8859-1
)
595 ("british" ; British version
596 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
597 ("castellano" ; 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") "~tex" iso-8859-1
)
601 ("castellano8" ; 8 bit Spanish mode
602 "[A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
603 "[^A-Z\301\311\315\321\323\332\334a-z\341\351\355\361\363\372\374]"
604 "[-]" nil
("-B" "-d" "castellano") "~latin1" iso-8859-1
)
606 "[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]"
607 "[^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]"
608 "" nil
("-B") nil iso-8859-2
)
610 "[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
611 "[']" nil
("-C") nil iso-8859-1
)
612 ("deutsch" ; Deutsch.aff
613 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
615 "[a-zA-Z\304\326\334\344\366\337\374]"
616 "[^a-zA-Z\304\326\334\344\366\337\374]"
617 "[']" t
("-C" "-d" "deutsch") "~latin1" iso-8859-1
)
618 ("english" ; make English explicitly selectable
619 "[A-Za-z]" "[^A-Za-z]" "[']" nil
("-B") nil iso-8859-1
)
621 "[A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
622 "[^A-Za-z\246\254\266\274\306\330\335\336\346\370\375\376]"
623 "[-']" t
("-C") "~latin3" iso-8859-3
)
625 "[A-Za-z^\\]" "[^A-Za-z^\\]"
626 "[-'`\"]" t
("-C" "-d" "esperanto") "~tex" iso-8859-3
)
628 "[A-Za-z\345\344\366\305\304\326]"
629 "[^A-Za-z\345\344\366\305\304\326]"
630 "[:]" nil
("-C") "~list" iso-8859-1
)
632 "[A-Za-z]" "[^A-Za-z]" "[`'^-]" t nil nil iso-8859-1
)
633 ("francais" ; 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
"~list" iso-8859-1
)
637 ("francais-tex" ; Francais.aff
638 "[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\\]"
639 "[^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\\]"
640 "[-'^`\".@]" t nil
"~tex" iso-8859-1
)
641 ("german" ; german.aff
642 "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t
("-C") "~tex" iso-8859-1
)
643 ("german8" ; german.aff
644 "[a-zA-Z\304\326\334\344\366\337\374]"
645 "[^a-zA-Z\304\326\334\344\366\337\374]"
646 "[']" t
("-C" "-d" "german") "~latin1" iso-8859-1
)
647 ("italiano" ; Italian.aff
648 "[A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
649 "[^A-Z\300\301\310\311\314\315\322\323\331\332a-z\340\341\350\351\354\355\363\371\372]"
650 "[-.]" nil
("-B" "-d" "italian") "~tex" iso-8859-1
)
651 ("nederlands" ; Nederlands.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 ("nederlands8" ; Dutch8.aff
656 "[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]"
657 "[^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]"
658 "[']" t
("-C") nil iso-8859-1
)
659 ("norsk" ; 8 bit Norwegian mode
660 "[A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
661 "[^A-Za-z\305\306\307\310\311\322\324\330\345\346\347\350\351\362\364\370]"
662 "[\"]" nil nil
"~list" iso-8859-1
)
663 ("norsk7-tex" ; 7 bit Norwegian TeX mode
664 "[A-Za-z{}\\'^`]" "[^A-Za-z{}\\'^`]"
665 "[\"]" nil
("-d" "norsk") "~plaintex" iso-8859-1
)
666 ("polish" ; Polish mode
667 "[A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
668 "[^A-Za-z\241\243\246\254\257\261\263\266\274\277\306\312\321\323\346\352\361\363]"
669 "[.]" nil nil nil iso-8859-2
)
670 ("portugues" ; Portuguese mode
671 "[a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
672 "[^a-zA-Z\301\302\307\311\323\340\341\342\351\352\355\363\343\347\372]"
673 "[']" t
("-C") "~latin1" iso-8859-1
)
674 ("russian" ; Russian.aff (KOI8-R charset)
675 "[\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]"
676 "[^\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]"
677 "" nil nil nil koi8-r
)
678 ("russianw" ; russianw.aff (CP1251 charset)
679 "[\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]"
680 "[^\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]"
681 "" nil nil nil windows-1251
)
682 ("slovak" ; Slovakian
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") nil iso-8859-2
)
686 ("slovenian" ; Slovenian
687 "[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]"
688 "[^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]"
689 "" nil
("-B" "-d" "slovenian") nil iso-8859-2
)
690 ("svenska" ; Swedish mode
691 "[A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
692 "[^A-Za-z\345\344\366\351\340\374\350\346\370\347\305\304\326\311\300\334\310\306\330\307]"
693 "[']" nil
("-C") "~list" iso-8859-1
)
694 ("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
))
695 "Base value for `ispell-dictionary-alist'.")
697 (defvar ispell-dictionary-alist nil
698 "An alist of dictionaries and their associated parameters.
700 Each element of this list is also a list:
702 \(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
703 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
705 DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
706 nil means the default dictionary.
708 CASECHARS is a regular expression of valid characters that comprise a word.
710 NOT-CASECHARS is the opposite regexp of CASECHARS.
712 OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
713 used to construct words in some special way. If OTHERCHARS characters follow
714 and precede characters from CASECHARS, they are parsed as part of a word,
715 otherwise they become word-breaks. As an example in English, assume the
716 regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
717 \"Steven's\" are parsed as single words including the \"'\" character, but
718 \"Stevens'\" does not include the quote character as part of the word.
719 If you want OTHERCHARS to be empty, use the empty string.
720 Hint: regexp syntax requires the hyphen to be declared first here.
722 CASECHARS, NOT-CASECHARS, and OTHERCHARS must be unibyte strings
723 containing bytes of CHARACTER-SET. In addition, if they contain
724 non-ASCII bytes, the regular expression must be a single
725 `character set' construct that doesn't specify a character range
728 MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
729 Otherwise only a single OTHERCHARS character is allowed to be part of any
732 ISPELL-ARGS is a list of additional arguments passed to the ispell
735 EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
736 have been configured in an Ispell affix file. (For example, umlauts
737 can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
738 in English. This has the same effect as the command-line `-T' option.
739 The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
740 but the dictionary can control the extended character mode.
741 Both defaults can be overruled in a buffer-local fashion. See
742 `ispell-parsing-keyword' for details on this.
744 CHARACTER-SET used to encode text sent to the ispell subprocess
745 when the language uses non-ASCII characters.
747 Note that with \"ispell\" as the speller, the CASECHARS and
748 OTHERCHARS slots of the alist should contain the same character
749 set as casechars and otherchars in the LANGUAGE.aff file \(e.g.,
750 english.aff\). aspell and hunspell don't have this limitation.")
752 (defvar ispell-really-aspell nil
) ; Non-nil if we can use aspell extensions.
753 (defvar ispell-really-hunspell nil
) ; Non-nil if we can use hunspell extensions.
754 (defvar ispell-encoding8-command nil
755 "Command line option prefix to select encoding if supported, nil otherwise.
756 If setting the encoding is supported by spellchecker and is selectable from
757 the command line, this variable will contain \"--encoding=\" for aspell
758 and \"-i \" for hunspell, so the appropriate mime charset can be selected.
759 That will be set in `ispell-check-version' for hunspell >= 1.1.6 and
762 For aspell, non-nil also means to try to automatically find its dictionaries.
764 Earlier aspell versions do not consistently support charset encoding. Handling
765 this would require some extra guessing in `ispell-aspell-find-dictionary'.")
767 (defvar ispell-aspell-supports-utf8 nil
768 "Non-nil if aspell has consistent command line UTF-8 support. Obsolete.
769 ispell.el and flyspell.el will use for this purpose the more generic
770 variable `ispell-encoding8-command' for both aspell and hunspell. Is left
771 here just for backwards compatibility.")
773 (make-obsolete-variable 'ispell-aspell-supports-utf8
774 'ispell-encoding8-command
"23.1")
776 (defvar ispell-hunspell-dictionary-equivs-alist
777 '(("american" "en_US")
778 ("brasileiro" "pt_BR")
780 ("castellano" "es_ES")
781 ("castellano8" "es_ES")
788 ("esperanto-tex" "eo")
790 ("francais7" "fr_FR")
792 ("francais-tex" "fr_FR")
796 ("nederlands" "nl_NL")
797 ("nederlands8" "nl_NL")
799 ("norsk7-tex" "nn_NO")
801 ("portugues" "pt_PT")
805 ("slovenian" "sl_SI")
808 "Alist with matching hunspell dict names for standard dict names in
809 `ispell-dictionary-base-alist'.")
811 (defvar ispell-emacs-alpha-regexp
812 (if (string-match "^[[:alpha:]]+$" "abcde")
815 "[[:alpha:]] if Emacs supports [:alpha:] regexp, nil
816 otherwise (current XEmacs does not support it).")
818 ;;; **********************************************************************
819 ;;; The following are used by ispell, and should not be changed.
820 ;;; **********************************************************************
824 ;; The version must be 3.1 or greater for this version of ispell.el
825 ;; There is an incompatibility between version 3.1.12 and lower versions.
826 (defconst ispell-required-version
'(3 1 12)
827 "Ispell versions with which this version of ispell.el is known to work.")
828 (defvar ispell-offset -
1
829 "Offset that maps protocol differences between ispell 3.1 versions.")
831 (defconst ispell-version
"ispell.el 3.6 - 7-Jan-2003")
834 (defun ispell-check-version (&optional interactivep
)
835 "Ensure that `ispell-program-name' is valid and has the correct version.
836 Returns version number if called interactively.
837 Otherwise returns the library directory name, if that is defined."
838 ;; This is a little wasteful as we actually launch ispell twice: once
839 ;; to make sure it's the right version, and once for real. But people
840 ;; get confused by version mismatches *all* the time (and I've got the
841 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
842 ;; option is the only way I can think of to do this that works with
843 ;; all versions, since versions earlier than 3.0.09 didn't identify
844 ;; themselves on startup.
846 (let ((default-directory (or (and (boundp 'temporary-file-directory
)
847 temporary-file-directory
)
849 result status ispell-program-version
)
852 (setq status
(ispell-call-process
853 ispell-program-name nil t nil
854 ;; aspell doesn't accept the -vv switch.
855 (let ((case-fold-search
856 (memq system-type
'(ms-dos windows-nt
)))
858 (file-name-nondirectory ispell-program-name
)))
859 ;; Assume anything that isn't `aspell' is Ispell.
860 (if (string-match "\\`aspell" speller
) "-v" "-vv"))))
861 (goto-char (point-min))
863 ;; report version information of ispell and ispell.el
866 (setq result
(concat (buffer-substring-no-properties (point-min)
870 (message "%s" result
))
871 ;; return library directory.
872 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t
)
873 (setq result
(match-string 1))))
874 (goto-char (point-min))
875 (if (not (memq status
'(0 nil
)))
876 (error "%s exited with %s %s" ispell-program-name
877 (if (stringp status
) "signal" "code") status
))
879 ;; Get relevant version strings. Only xx.yy.... format works well
880 (let (case-fold-search)
881 (setq ispell-program-version
882 (and (search-forward-regexp "\\([0-9]+\\.[0-9\\.]+\\)" nil t
)
885 ;; Make sure these variables are (re-)initialized to the default value
886 (setq ispell-really-aspell nil
887 ispell-aspell-supports-utf8 nil
888 ispell-really-hunspell nil
889 ispell-encoding8-command nil
)
891 (goto-char (point-min))
892 (or (setq ispell-really-aspell
893 (and (search-forward-regexp
894 "(but really Aspell \\([0-9]+\\.[0-9\\.-]+\\)?)" nil t
)
896 (setq ispell-really-hunspell
897 (and (search-forward-regexp
898 "(but really Hunspell \\([0-9]+\\.[0-9\\.-]+\\)?)"
902 (let ((aspell-minver "0.50")
903 (aspell8-minver "0.60")
904 (ispell0-minver "3.1.0")
905 (ispell-minver "3.1.12")
906 (hunspell8-minver "1.1.6"))
908 (if (ispell-check-minver ispell0-minver ispell-program-version
)
909 (or (ispell-check-minver ispell-minver ispell-program-version
)
910 (setq ispell-offset
0))
911 (error "%s release %s or greater is required"
916 (ispell-really-aspell
917 (if (ispell-check-minver aspell-minver ispell-really-aspell
)
918 (if (ispell-check-minver aspell8-minver ispell-really-aspell
)
920 (setq ispell-aspell-supports-utf8 t
)
921 (setq ispell-encoding8-command
"--encoding=")))
922 (setq ispell-really-aspell nil
)))
923 (ispell-really-hunspell
924 (if (ispell-check-minver hunspell8-minver ispell-really-hunspell
)
925 (setq ispell-encoding8-command
"-i")
926 (setq ispell-really-hunspell nil
))))))
929 (defun ispell-call-process (&rest args
)
930 "Like `call-process' but defend against bad `default-directory'."
931 (let ((default-directory default-directory
))
932 (unless (and (file-directory-p default-directory
)
933 (file-readable-p default-directory
))
934 (setq default-directory
(expand-file-name "~/")))
935 (apply 'call-process args
)))
937 (defun ispell-call-process-region (&rest args
)
938 "Like `call-process-region' but defend against bad `default-directory'."
939 (let ((default-directory default-directory
))
940 (unless (and (file-directory-p default-directory
)
941 (file-readable-p default-directory
))
942 (setq default-directory
(expand-file-name "~/")))
943 (apply 'call-process-region args
)))
945 (defun ispell-create-debug-buffer (&optional append
)
946 "Create an ispell debug buffer for debugging output.
947 Use APPEND to append the info to previous buffer if exists,
948 otherwise is reset. Returns name of ispell debug buffer.
949 See `ispell-buffer-with-debug' for an example of use."
950 (let ((ispell-debug-buffer (get-buffer-create "*ispell-debug*")))
951 (with-current-buffer ispell-debug-buffer
954 (format "-----------------------------------------------\n"))
956 ispell-debug-buffer
))
958 (defsubst ispell-print-if-debug
(string)
959 "Print STRING to `ispell-debug-buffer' buffer if enabled."
960 (if (boundp 'ispell-debug-buffer
)
961 (with-current-buffer ispell-debug-buffer
965 ;; The preparation of the menu bar menu must be autoloaded
966 ;; because otherwise this file gets autoloaded every time Emacs starts
967 ;; so that it can set up the menus and determine keyboard equivalents.
970 (defvar ispell-menu-map nil
"Key map for ispell menu.")
971 ;; Redo menu when loading ispell to get dictionary modifications
972 (setq ispell-menu-map nil
)
975 (defvar ispell-menu-xemacs nil
976 "Spelling menu for XEmacs.
977 If nil when package is loaded, a standard menu will be set,
978 and added as a submenu of the \"Edit\" menu.")
980 ;; Break out XEmacs menu and split into several calls to avoid having
981 ;; long lines in loaddefs.el. Detect need off following constant.
983 ;;; Set up dictionary
985 (defvar ispell-menu-map-needed
986 ;; only needed when not version 18 and not XEmacs.
987 (and (not ispell-menu-map
)
988 (not (featurep 'xemacs
))
991 (defvar ispell-library-directory
(condition-case ()
992 (ispell-check-version)
994 "Directory where ispell dictionaries reside.")
996 (defvar ispell-process nil
997 "The process object for Ispell.")
999 (defvar ispell-async-processp
(and (fboundp 'delete-process
)
1000 (fboundp 'process-send-string
)
1001 (fboundp 'accept-process-output
)
1002 ;;(fboundp 'start-process)
1003 ;;(fboundp 'set-process-filter)
1004 ;;(fboundp 'process-kill-without-query)
1006 "Non-nil means that the OS supports asynchronous processes.")
1008 ;; Make ispell.el work better with aspell.
1010 (defvar ispell-aspell-dictionary-alist nil
1011 "An alist of parsed aspell dicts and associated parameters.
1014 (defun ispell-find-aspell-dictionaries ()
1015 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
1016 (unless (and ispell-really-aspell ispell-encoding8-command
)
1017 (error "This function only works with aspell >= 0.60"))
1018 (let* ((dictionaries
1021 (ispell-call-process ispell-program-name nil t nil
"dicts")
1023 ;; Search for the named dictionaries.
1026 (mapcar #'ispell-aspell-find-dictionary dictionaries
))))
1027 ;; Ensure aspell's alias dictionary will override standard
1029 (setq found
(ispell-aspell-add-aliases found
))
1030 ;; Merge into FOUND any elements from the standard ispell-dictionary-base-alist
1031 ;; which have no element in FOUND at all.
1032 (dolist (dict ispell-dictionary-base-alist
)
1033 (unless (assoc (car dict
) found
)
1034 (setq found
(nconc found
(list dict
)))))
1035 (setq ispell-aspell-dictionary-alist found
)
1036 ;; Add a default entry
1038 '(nil "[[:alpha:]]" "[^[:alpha:]]" "[']" nil
("-B") nil utf-8
)))
1039 (push default-dict ispell-aspell-dictionary-alist
))))
1041 (defvar ispell-aspell-data-dir nil
1042 "Data directory of Aspell.")
1044 (defvar ispell-aspell-dict-dir nil
1045 "Dictionary directory of Aspell.")
1047 (defun ispell-get-aspell-config-value (key)
1048 "Return value of Aspell configuration option KEY.
1049 Assumes that value contains no whitespace."
1051 (ispell-call-process ispell-program-name nil t nil
"config" key
)
1052 (car (split-string (buffer-string)))))
1054 (defun ispell-aspell-find-dictionary (dict-name)
1055 "For aspell dictionary DICT-NAME, return a list of parameters if an
1056 associated data file is found or nil otherwise. List format is that
1057 of `ispell-dictionary-base-alist' elements."
1058 ;; Make sure `ispell-aspell-data-dir' is defined
1059 (or ispell-aspell-data-dir
1060 (setq ispell-aspell-data-dir
1061 (ispell-get-aspell-config-value "data-dir")))
1062 ;; Try finding associated datafile
1064 (concat ispell-aspell-data-dir
"/"
1065 ;; Strip out variant, country code, etc.
1066 (and (string-match "^[[:alpha:]]+" dict-name
)
1067 (match-string 0 dict-name
)) ".dat"))
1069 (concat ispell-aspell-data-dir
"/"
1070 ;; Strip out anything but xx_YY.
1071 (and (string-match "^[[:alpha:]_]+" dict-name
)
1072 (match-string 0 dict-name
)) ".dat"))
1074 (if (file-readable-p datafile1
)
1076 (if (file-readable-p datafile2
)
1082 (insert-file-contents data-file
)
1083 ;; There is zero or one line with special characters declarations.
1084 (when (search-forward-regexp "^special" nil t
)
1085 (let ((specials (split-string
1086 (buffer-substring (point)
1087 (progn (end-of-line) (point))))))
1088 ;; The line looks like: special ' -** - -** . -** : -*-
1089 ;; -** means that this character
1090 ;; - doesn't appear at word start
1091 ;; * may appear in the middle of a word
1092 ;; * may appear at word end
1093 ;; `otherchars' is about the middle case.
1095 (when (eq (aref (cadr specials
) 1) ?
*)
1096 (push (car specials
) otherchars
))
1097 (setq specials
(cddr specials
)))))
1101 (regexp-opt otherchars
)
1102 t
; We can't tell, so set this to t
1103 (list "-d" dict-name
)
1104 nil
; aspell doesn't support this
1105 ;; Here we specify the encoding to use while communicating with
1106 ;; aspell. This doesn't apply to command line arguments, so
1107 ;; just don't pass words to spellcheck as arguments...
1110 (defun ispell-aspell-add-aliases (alist)
1111 "Find aspell's dictionary aliases and add them to dictionary ALIST.
1112 Return the new dictionary alist."
1114 (file-expand-wildcards
1115 (concat (or ispell-aspell-dict-dir
1116 (setq ispell-aspell-dict-dir
1117 (ispell-get-aspell-config-value "dict-dir")))
1119 (dolist (alias-file aliases
)
1121 (insert-file-contents alias-file
)
1122 ;; Look for a line "add FOO.multi", extract FOO
1123 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t
)
1124 (let* ((aliasname (file-name-base alias-file
))
1125 (already-exists-p (assoc aliasname alist
))
1126 (realname (match-string 1))
1127 (realdict (assoc realname alist
)))
1128 (when (and realdict
(not already-exists-p
))
1129 (push (cons aliasname
(cdr realdict
)) alist
))))))
1132 ;; Set params according to the selected spellchecker
1134 (defvar ispell-last-program-name nil
1135 "Last value of `ispell-program-name'. Internal use.")
1137 (defvar ispell-initialize-spellchecker-hook nil
1138 "Normal hook run on spellchecker initialization.
1139 This hook is run when a spellchecker is used for the first
1140 time, before `ispell-dictionary-alist' is set. It is intended for
1141 sysadmins to override entries in `ispell-dictionary-base-alist'
1142 by putting those overrides in `ispell-base-dicts-override-alist', which is
1143 a dynamically scoped var with same format as `ispell-dictionary-alist'.
1144 This alist will not override the auto-detected values (e.g. if a recent
1145 aspell is used along with Emacs).")
1147 (defun ispell-set-spellchecker-params ()
1148 "Initialize some spellchecker parameters when changed or first used."
1149 (unless (eq ispell-last-program-name ispell-program-name
)
1150 (setq ispell-last-program-name ispell-program-name
)
1151 (ispell-kill-ispell t
)
1152 (if (and (condition-case ()
1154 (setq ispell-library-directory
(ispell-check-version))
1157 ispell-really-aspell
1158 ispell-encoding8-command
1159 ispell-emacs-alpha-regexp
)
1160 (unless ispell-aspell-dictionary-alist
1161 (ispell-find-aspell-dictionaries)))
1163 ;; Substitute ispell-dictionary-alist with the list of dictionaries
1164 ;; corresponding to the given spellchecker. If a recent aspell, use
1165 ;; the list of really installed dictionaries and add to it elements
1166 ;; of the original list that are not present there. Allow distro info.
1167 (let ((found-dicts-alist
1168 (if (and ispell-really-aspell
1169 ispell-encoding8-command
)
1170 ispell-aspell-dictionary-alist
1172 (ispell-dictionary-base-alist ispell-dictionary-base-alist
)
1173 ispell-base-dicts-override-alist
; Override only base-dicts-alist
1176 ;; While ispell and aspell (through aliases) use the traditional
1177 ;; dict naming originally expected by ispell.el, hunspell
1178 ;; uses locale based names with no alias. We need to map
1179 ;; standard names to locale based names to make default dict
1180 ;; definitions available for hunspell.
1181 (if ispell-really-hunspell
1182 (let (tmp-dicts-alist)
1183 (dolist (adict ispell-dictionary-base-alist
)
1184 (let* ((dict-name (nth 0 adict
))
1186 (cadr (assoc dict-name
1187 ispell-hunspell-dictionary-equivs-alist
)))
1188 (ispell-args (nth 5 adict
))
1189 (ispell-args-has-d (member "-d" ispell-args
))
1191 ;; Remove "-d" option from `ispell-args' if present
1192 (if ispell-args-has-d
1193 (let ((ispell-args-after-d
1194 (cdr (cdr ispell-args-has-d
)))
1195 (ispell-args-before-d
1196 (butlast ispell-args
(length ispell-args-has-d
))))
1198 (nconc ispell-args-before-d
1199 ispell-args-after-d
))))
1200 ;; Unless default dict, re-add "-d" option with the mapped value
1203 (nconc ispell-args
(list "-d" dict-equiv
))
1205 "ispell-set-spellchecker-params: Missing hunspell equiv for \"%s\". Skipping."
1207 (setq skip-dict t
)))
1210 (add-to-list 'tmp-dicts-alist
1212 dict-name
; dict name
1213 (nth 1 adict
) ; casechars
1214 (nth 2 adict
) ; not-casechars
1215 (nth 3 adict
) ; otherchars
1216 (nth 4 adict
) ; many-otherchars-p
1217 ispell-args
; ispell-args
1218 (nth 6 adict
) ; extended-character-mode
1219 (nth 7 adict
) ; dict encoding
1221 (setq ispell-dictionary-base-alist tmp-dicts-alist
))))
1223 (run-hooks 'ispell-initialize-spellchecker-hook
)
1225 ;; Add dicts to ``ispell-dictionary-alist'' unless already present.
1226 (dolist (dict (append found-dicts-alist
1227 ispell-base-dicts-override-alist
1228 ispell-dictionary-base-alist
))
1229 (unless (assoc (car dict
) all-dicts-alist
)
1230 (add-to-list 'all-dicts-alist dict
)))
1231 (setq ispell-dictionary-alist all-dicts-alist
))
1233 ;; If Emacs flavor supports [:alpha:] use it for global dicts. If
1234 ;; spellchecker also supports UTF-8 via command-line option use it
1235 ;; in communication. This does not affect definitions in your
1237 (if ispell-emacs-alpha-regexp
1238 (let (tmp-dicts-alist)
1239 (dolist (adict ispell-dictionary-alist
)
1240 (add-to-list 'tmp-dicts-alist
1242 (nth 0 adict
) ; dict name
1243 "[[:alpha:]]" ; casechars
1244 "[^[:alpha:]]" ; not-casechars
1245 (nth 3 adict
) ; otherchars
1246 (nth 4 adict
) ; many-otherchars-p
1247 (nth 5 adict
) ; ispell-args
1248 (nth 6 adict
) ; extended-character-mode
1249 (if ispell-encoding8-command
1252 (setq ispell-dictionary-alist tmp-dicts-alist
)))))
1254 (defun ispell-valid-dictionary-list ()
1255 "Return a list of valid dictionaries.
1256 The variable `ispell-library-directory' defines their location."
1257 ;; Initialize variables and dictionaries alists for desired spellchecker.
1258 ;; Make sure ispell.el is loaded to avoid some autoload loops in XEmacs
1259 ;; (and may be others)
1260 (if (featurep 'ispell
)
1261 (ispell-set-spellchecker-params))
1263 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist
))
1264 (dict-list (cons "default" nil
))
1266 (dolist (dict dicts
)
1267 (setq name
(car dict
)
1268 dict-bname
(or (car (cdr (member "-d" (nth 5 dict
))))
1270 ;; Include if the dictionary is in the library, or dir not defined.
1273 ;; For Aspell, we already know which dictionaries exist.
1274 (or ispell-really-aspell
1275 ;; Include all dictionaries if lib directory not known.
1276 ;; Same for Hunspell, where ispell-library-directory is nil.
1277 (not ispell-library-directory
)
1278 (file-exists-p (concat ispell-library-directory
1279 "/" dict-bname
".hash"))
1280 (file-exists-p (concat ispell-library-directory
1281 "/" dict-bname
".has"))))
1282 (push name dict-list
)))
1285 ;; Define commands in menu in opposite order you want them to appear.
1287 (if ispell-menu-map-needed
1289 (setq ispell-menu-map
(make-sparse-keymap "Spell"))
1290 (define-key ispell-menu-map
[ispell-change-dictionary
]
1291 `(menu-item ,(purecopy "Change Dictionary...") ispell-change-dictionary
1292 :help
,(purecopy "Supply explicit dictionary file name")))
1293 (define-key ispell-menu-map
[ispell-kill-ispell
]
1294 `(menu-item ,(purecopy "Kill Process")
1295 (lambda () (interactive) (ispell-kill-ispell nil
'clear
))
1296 :enable
(and (boundp 'ispell-process
) ispell-process
1297 (eq (ispell-process-status) 'run
))
1298 :help
,(purecopy "Terminate Ispell subprocess")))
1299 (define-key ispell-menu-map
[ispell-pdict-save
]
1300 `(menu-item ,(purecopy "Save Dictionary")
1301 (lambda () (interactive) (ispell-pdict-save t t
))
1302 :help
,(purecopy "Save personal dictionary")))
1303 (define-key ispell-menu-map
[ispell-customize
]
1304 `(menu-item ,(purecopy "Customize...")
1305 (lambda () (interactive) (customize-group 'ispell
))
1306 :help
,(purecopy "Customize spell checking options")))
1307 (define-key ispell-menu-map
[ispell-help
]
1308 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
1309 `(menu-item ,(purecopy "Help")
1310 (lambda () (interactive) (describe-function 'ispell-help
))
1311 :help
,(purecopy "Show standard Ispell keybindings and commands")))
1312 (define-key ispell-menu-map
[flyspell-mode
]
1313 `(menu-item ,(purecopy "Automatic spell checking (Flyspell)")
1315 :help
,(purecopy "Check spelling while you edit the text")
1316 :button
(:toggle .
(bound-and-true-p flyspell-mode
))))
1317 (define-key ispell-menu-map
[ispell-complete-word
]
1318 `(menu-item ,(purecopy "Complete Word") ispell-complete-word
1319 :help
,(purecopy "Complete word at cursor using dictionary")))
1320 (define-key ispell-menu-map
[ispell-complete-word-interior-frag
]
1321 `(menu-item ,(purecopy "Complete Word Fragment")
1322 ispell-complete-word-interior-frag
1323 :help
,(purecopy "Complete word fragment at cursor")))))
1326 (if ispell-menu-map-needed
1328 (define-key ispell-menu-map
[ispell-continue
]
1329 `(menu-item ,(purecopy "Continue Spell-Checking") ispell-continue
1330 :enable
(and (boundp 'ispell-region-end
)
1331 (marker-position ispell-region-end
)
1332 (equal (marker-buffer ispell-region-end
)
1334 :help
,(purecopy "Continue spell checking last region")))
1335 (define-key ispell-menu-map
[ispell-word
]
1336 `(menu-item ,(purecopy "Spell-Check Word") ispell-word
1337 :help
,(purecopy "Spell-check word at cursor")))
1338 (define-key ispell-menu-map
[ispell-comments-and-strings
]
1339 `(menu-item ,(purecopy "Spell-Check Comments")
1340 ispell-comments-and-strings
1341 :help
,(purecopy "Spell-check only comments and strings")))))
1344 (if ispell-menu-map-needed
1346 (define-key ispell-menu-map
[ispell-region
]
1347 `(menu-item ,(purecopy "Spell-Check Region") ispell-region
1349 :help
,(purecopy "Spell-check text in marked region")))
1350 (define-key ispell-menu-map
[ispell-message
]
1351 `(menu-item ,(purecopy "Spell-Check Message") ispell-message
1352 :visible
(eq major-mode
'mail-mode
)
1353 :help
,(purecopy "Skip headers and included message text")))
1354 (define-key ispell-menu-map
[ispell-buffer
]
1355 `(menu-item ,(purecopy "Spell-Check Buffer") ispell-buffer
1356 :help
,(purecopy "Check spelling of selected buffer")))
1357 ;;(put 'ispell-region 'menu-enable 'mark-active)
1358 (fset 'ispell-menu-map
(symbol-value 'ispell-menu-map
))))
1360 ;;; XEmacs versions 19 & 20
1361 (if (and (featurep 'xemacs
)
1363 ;;(null ispell-menu-xemacs)
1364 (not (and (boundp 'infodock-version
) infodock-version
)))
1365 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list
)
1366 (reverse (ispell-valid-dictionary-list))))
1367 (current-menubar (or current-menubar default-menubar
))
1369 '(["Help" (describe-function 'ispell-help
) t
]
1370 ;;["Help" (popup-menu ispell-help-list) t]
1371 ["Check Message" ispell-message t
]
1372 ["Check Buffer" ispell-buffer t
]
1373 ["Check Comments" ispell-comments-and-strings t
]
1374 ["Check Word" ispell-word t
]
1375 ["Check Region" ispell-region
(or (not zmacs-regions
) (mark))]
1376 ["Continue Check" ispell-continue t
]
1377 ["Complete Word Frag"ispell-complete-word-interior-frag t
]
1378 ["Complete Word" ispell-complete-word t
]
1379 ["Kill Process" (ispell-kill-ispell nil
'clear
) t
]
1380 ["Customize..." (customize-group 'ispell
) t
]
1381 ;; flyspell-mode may not be bound...
1382 ;;["flyspell" flyspell-mode
1383 ;; :style toggle :selected flyspell-mode ]
1385 ["Save Personal Dict"(ispell-pdict-save t t
) t
]
1386 ["Change Dictionary" ispell-change-dictionary t
])))
1388 (setq dicts
(cons "default" nil
)))
1389 (dolist (name dicts
)
1390 (setq menu
(append menu
1393 (concat "Select " (capitalize name
))
1394 (list 'ispell-change-dictionary name
)
1396 (setq ispell-menu-xemacs menu
)
1399 (if (car (find-menu-item current-menubar
'("Cmds")))
1402 (delete-menu-item '("Cmds" "Spell-Check"))
1403 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs
))
1405 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1406 (add-menu '("Edit") "Spell" ispell-menu-xemacs
))))))
1408 (defalias 'ispell-int-char
1409 ;; Allow incrementing characters as integers in XEmacs 20
1410 (if (and (featurep 'xemacs
)
1411 (fboundp 'int-char
))
1413 ;; Emacs and XEmacs 19 or earlier
1417 ;;; **********************************************************************
1419 (defvar ispell-current-dictionary nil
1420 "The name of the current dictionary, or nil for the default.
1421 This is passed to the ispell process using the `-d' switch and is
1422 used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1424 (defvar ispell-current-personal-dictionary nil
1425 "The name of the current personal dictionary, or nil for the default.
1426 This is passed to the ispell process using the `-p' switch.")
1428 (defun ispell-decode-string (str)
1429 "Decodes multibyte character strings.
1430 Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
1431 ;; FIXME: enable-multibyte-characters is read-only, so bogus bindings are
1432 ;; really nasty (they signal an error in Emacs): Who does that? --Stef
1433 (if (and (or (featurep 'xemacs
)
1434 (and (boundp 'enable-multibyte-characters
)
1435 enable-multibyte-characters
))
1436 (fboundp 'decode-coding-string
)
1437 (ispell-get-coding-system))
1438 (decode-coding-string str
(ispell-get-coding-system))
1441 ;; Return a string decoded from Nth element of the current dictionary.
1442 (defun ispell-get-decoded-string (n)
1443 "Get the decoded string in slot N of the descriptor of the current dict."
1445 (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1446 (assoc ispell-current-dictionary ispell-dictionary-alist
)
1447 (error "No data for dictionary \"%s\", neither in `ispell-local-dictionary-alist' nor in `ispell-dictionary-alist'"
1448 ispell-current-dictionary
)))
1450 (when (and (> (length str
) 0)
1451 (not (multibyte-string-p str
)))
1452 (setq str
(ispell-decode-string str
))
1453 (or (multibyte-string-p str
)
1454 (setq str
(string-to-multibyte str
))))
1457 (defun ispell-get-casechars ()
1458 (ispell-get-decoded-string 1))
1459 (defun ispell-get-not-casechars ()
1460 (ispell-get-decoded-string 2))
1461 (defun ispell-get-otherchars ()
1462 (ispell-get-decoded-string 3))
1463 (defun ispell-get-many-otherchars-p ()
1464 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1465 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1466 (defun ispell-get-ispell-args ()
1467 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1468 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1469 (defun ispell-get-extended-character-mode ()
1470 (if ispell-really-hunspell
;; hunspell treats ~word as ordinary words
1471 nil
;; in pipe mode. Disable extended-char-mode
1472 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1473 (assoc ispell-current-dictionary ispell-dictionary-alist
)))))
1474 (defun ispell-get-coding-system ()
1475 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist
)
1476 (assoc ispell-current-dictionary ispell-dictionary-alist
))))
1479 (defvar ispell-pdict-modified-p nil
1480 "Non-nil means personal dictionary has modifications to be saved.")
1482 ;; If you want to save the dictionary when quitting, must do so explicitly.
1483 ;; When non-nil, the spell session is terminated.
1484 ;; When numeric, contains cursor location in buffer, and cursor remains there.
1485 (defvar ispell-quit nil
)
1487 (defvar ispell-process-directory nil
1488 "The directory where `ispell-process' was started.")
1490 (defvar ispell-filter nil
1491 "Output filter from piped calls to Ispell.")
1493 (defvar ispell-filter-continue nil
1494 "Control variable for Ispell filter function.")
1496 (defvar ispell-output-buffer nil
1497 "Buffer used for reading output of a synchronous Ispell subprocess.")
1499 (defvar ispell-session-buffer nil
1500 "Buffer used for passing input to a synchronous Ispell subprocess.")
1502 (defvar ispell-cmd-args nil
1503 "Command-line arguments to pass to a synchronous Ispell subprocess.")
1505 (defvar ispell-query-replace-marker
(make-marker)
1506 "Marker for `query-replace' processing.")
1508 (defvar ispell-recursive-edit-marker
(make-marker)
1509 "Marker for return point from recursive edit.")
1511 (defvar ispell-checking-message nil
1512 "Non-nil when we're checking a mail message.
1513 Set to the MIME boundary locations when checking messages.")
1515 (defconst ispell-choices-buffer
"*Choices*")
1517 (defvar ispell-overlay nil
"Overlay variable for Ispell highlighting.")
1519 ;;; *** Buffer Local Definitions ***
1521 (defconst ispell-words-keyword
"LocalWords: "
1522 "The keyword for local oddly-spelled words to accept.
1523 The keyword will be followed by any number of local word spellings.
1524 There can be multiple instances of this keyword in the file.")
1526 (defconst ispell-dictionary-keyword
"Local IspellDict: "
1527 "The keyword for a local dictionary to use.
1528 The keyword must be followed by a valid dictionary name, defined in
1529 `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1530 When multiple occurrences exist, the last keyword
1531 definition is used.")
1533 (defconst ispell-pdict-keyword
"Local IspellPersDict: "
1534 "The keyword for defining buffer local dictionaries.
1535 Keyword must be followed by the filename of a personal dictionary.
1536 The last occurring definition in the buffer will be used.")
1538 (defconst ispell-parsing-keyword
"Local IspellParsing: "
1539 "The keyword for overriding default Ispell parsing.
1540 The above keyword string should be followed by `latex-mode' or
1541 `nroff-mode' to put the current buffer into the desired parsing mode.
1543 Extended character mode can be changed for this buffer by placing
1544 a `~' followed by an extended-character mode -- such as `~.tex'.
1545 The last occurring definition in the buffer will be used.")
1548 (defvar ispell-skip-region-alist
1549 `((ispell-words-keyword forward-line
)
1550 (ispell-dictionary-keyword forward-line
)
1551 (ispell-pdict-keyword forward-line
)
1552 (ispell-parsing-keyword forward-line
)
1553 (,(purecopy "^---*BEGIN PGP [A-Z ]*--*")
1554 .
,(purecopy "^---*END PGP [A-Z ]*--*"))
1555 ;; assume multiline uuencoded file? "\nM.*$"?
1556 (,(purecopy "^begin [0-9][0-9][0-9] [^ \t]+$") .
,(purecopy "\nend\n"))
1557 (,(purecopy "^%!PS-Adobe-[123].0") .
,(purecopy "\n%%EOF\n"))
1558 (,(purecopy "^---* \\(Start of \\)?[Ff]orwarded [Mm]essage")
1559 .
,(purecopy "^---* End of [Ff]orwarded [Mm]essage"))
1560 ;; Matches e-mail addresses, file names, http addresses, etc. The
1561 ;; `-+' `_+' patterns are necessary for performance reasons when
1562 ;; `-' or `_' part of word syntax.
1563 (,(purecopy "\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)"))
1564 ;; above checks /.\w sequences
1565 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
1566 ;; This is a pretty complex regexp. It can be simplified to the following:
1567 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1568 ;; but some valid text will be skipped, e.g. "his/her". This could be
1569 ;; fixed up (at the expense of a moderately more complex regexp)
1570 ;; by not allowing "/" to be the character which triggers the
1571 ;; identification of the computer name, e.g.:
1572 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
1574 "Alist expressing beginning and end of regions not to spell check.
1575 The alist key must be a regular expression.
1576 Valid forms include:
1577 (KEY) - just skip the key.
1578 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
1579 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
1580 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
1581 (put 'ispell-skip-region-alist
'risky-local-variable t
)
1585 (defvar ispell-tex-skip-alists
1587 '((;;("%\\[" . "%\\]") ; AMStex block comment...
1588 ;; All the standard LaTeX keywords from L. Lamport's guide:
1589 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1590 ;; \label, \nocite, \rule (in ispell - rest included here)
1591 ("\\\\addcontentsline" ispell-tex-arg-end
2)
1592 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end
)
1593 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end
)
1594 ;;("\\\\author" ispell-tex-arg-end)
1595 ("\\\\bibliographystyle" ispell-tex-arg-end
)
1596 ("\\\\makebox" ispell-tex-arg-end
0)
1597 ("\\\\e?psfig" ispell-tex-arg-end
)
1598 ("\\\\document\\(class\\|style\\)" .
1599 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1600 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1601 ;; equation, minipage, picture, tabular, tabular* (ispell)
1602 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end
0)
1603 ("list" ispell-tex-arg-end
2)
1604 ("program" .
"\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1605 ("verbatim\\*?" .
"\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}"))))
1606 "Lists of regions to be skipped in TeX mode.
1607 First list is used raw.
1608 Second list has key placed inside \\begin{}.
1610 Delete or add any regions you want to be automatically selected
1611 for skipping in latex mode.")
1612 (put 'ispell-tex-skip-alist
'risky-local-variable t
)
1616 (defconst ispell-html-skip-alists
1617 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1618 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1619 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1620 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1621 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1624 ("&[^ \t\n;]" "[; \t\n]"))
1625 "Lists of start and end keys to skip in HTML buffers.
1626 Same format as `ispell-skip-region-alist'.
1627 Note - substrings of other matches must come last
1628 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1629 (put 'ispell-html-skip-alists
'risky-local-variable t
)
1631 (defvar ispell-local-pdict ispell-personal-dictionary
1632 "A buffer local variable containing the current personal dictionary.
1633 If non-nil, the value must be a string, which is a file name.
1635 If you specify a personal dictionary for the current buffer which is
1636 different from the current personal dictionary, the effect is similar
1637 to calling \\[ispell-change-dictionary]. This variable is automatically
1638 set when defined in the file with either `ispell-pdict-keyword' or the
1639 local variable syntax.")
1641 (make-variable-buffer-local 'ispell-local-pdict
)
1642 ;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
1644 (defvar ispell-buffer-local-name nil
1645 "Contains the buffer name if local word definitions were used.
1646 Ispell is then restarted because the local words could conflict.")
1648 (defvar ispell-buffer-session-localwords nil
1649 "List of words accepted for session in this buffer.")
1651 (make-variable-buffer-local 'ispell-buffer-session-localwords
)
1653 (defvar ispell-parser
'use-mode-name
1654 "Indicates whether ispell should parse the current buffer as TeX Code.
1655 Special value `use-mode-name' tries to guess using the name of `major-mode'.
1656 Default parser is `nroff'.
1657 Currently the only other valid parser is `tex'.
1659 You can set this variable in hooks in your init file -- eg:
1661 \(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
1663 (defvar ispell-region-end
(make-marker)
1664 "Marker that allows spelling continuations.")
1666 (defvar ispell-check-only nil
1667 "If non-nil, `ispell-word' does not try to correct the word.")
1670 ;;; **********************************************************************
1671 ;;; **********************************************************************
1675 ;;;###autoload (define-key esc-map "$" 'ispell-word)
1678 (defun ispell-accept-output (&optional timeout-secs timeout-msecs
)
1679 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1680 If asynchronous subprocesses are not supported, call function `ispell-filter'
1681 and pass it the output of the last ispell invocation."
1682 (if ispell-async-processp
1683 (accept-process-output ispell-process timeout-secs timeout-msecs
)
1684 (if (null ispell-process
)
1685 (error "No Ispell process to read output from!")
1686 (let ((buf ispell-output-buffer
)
1688 (if (not (bufferp buf
))
1689 (setq ispell-filter nil
)
1690 (with-current-buffer buf
1691 (setq ispell-output
(buffer-substring-no-properties
1692 (point-min) (point-max))))
1693 (ispell-filter t ispell-output
)
1694 (with-current-buffer buf
1695 (erase-buffer)))))))
1697 (defun ispell-send-replacement (misspelled replacement
)
1698 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1699 This allows it to improve the suggestion list based on actual misspellings."
1700 (and ispell-really-aspell
1701 (ispell-send-string (concat "$$ra " misspelled
"," replacement
"\n"))))
1704 (defun ispell-send-string (string)
1705 "Send the string STRING to the Ispell process."
1706 (if ispell-async-processp
1707 (process-send-string ispell-process string
)
1708 ;; Asynchronous subprocesses aren't supported on this losing system.
1709 ;; We keep all the directives passed to Ispell during the entire
1710 ;; session in a buffer, and pass them anew each time we invoke
1711 ;; Ispell to process another chunk of text. (Yes, I know this is a
1712 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1713 (let ((cmd (aref string
0))
1714 ;; The following commands are not passed to Ispell until
1715 ;; we have a *real* reason to invoke it.
1716 (cmds-to-defer '(?
* ?
@ ?~ ?
+ ?- ?
! ?%
))
1717 (session-buf ispell-session-buffer
)
1718 (output-buf ispell-output-buffer
)
1719 (ispell-args ispell-cmd-args
)
1720 (defdir ispell-process-directory
)
1722 (with-current-buffer session-buf
1723 (setq prev-pos
(point))
1724 (setq default-directory defdir
)
1726 (if (not (memq cmd cmds-to-defer
))
1727 (let (coding-system-for-read coding-system-for-write status
)
1728 (if (and (boundp 'enable-multibyte-characters
)
1729 enable-multibyte-characters
)
1730 (setq coding-system-for-read
(ispell-get-coding-system)
1731 coding-system-for-write
(ispell-get-coding-system)))
1732 (set-buffer output-buf
)
1734 (set-buffer session-buf
)
1736 (apply 'ispell-call-process-region
1737 (point-min) (point-max)
1738 ispell-program-name nil
1741 ;; hunspell -m option means something different
1742 (if ispell-really-hunspell
"" "-m")
1744 (set-buffer output-buf
)
1745 (goto-char (point-min))
1747 (if (not (looking-at "@(#) "))
1748 (error "Ispell error: %s"
1749 (buffer-substring-no-properties
1750 (point) (progn (end-of-line) (point)))))
1751 ;; If STRING is "^Z\n", we just started Ispell and need
1752 ;; to retain its version ID line in the output buffer.
1753 ;; Otherwise, remove the ID line, as it will confuse
1755 (or (string= string
"\032\n")
1758 (delete-region (point-min) (point))))
1759 ;; If STRING begins with ^ or any normal character, we need
1760 ;; to remove the last line from the session buffer, since it
1761 ;; was just spell-checked, and we don't want to check it again.
1762 ;; The same goes for the # command, since Ispell already saved
1763 ;; the personal dictionary.
1764 (set-buffer session-buf
)
1765 (delete-region prev-pos
(point))
1766 ;; Ispell run synchronously saves the personal dictionary
1767 ;; after each successful command. So we can remove any
1768 ;; lines in the session buffer that insert words into the
1770 (if (memq status
'(0 nil
))
1771 (let ((more-lines t
))
1772 (goto-char (point-min))
1774 (if (looking-at "^\\*")
1775 (let ((start (point)))
1777 (delete-region start
(point)))
1778 (setq more-lines
(= 0 (forward-line))))))))))))))
1782 (defun ispell-word (&optional following quietly continue region
)
1783 "Check spelling of word under or before the cursor.
1784 If the word is not found in dictionary, display possible corrections
1785 in a window allowing you to choose one.
1787 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1788 is non-nil when called interactively, then the following word
1789 \(rather than preceding\) is checked when the cursor is not over a word.
1790 When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
1791 when called interactively, non-corrective messages are suppressed.
1793 With a prefix argument (or if CONTINUE is non-nil),
1794 resume interrupted spell-checking of a buffer or region.
1796 Interactively, in Transient Mark mode when the mark is active, call
1797 `ispell-region' to check the active region for spelling errors.
1799 Word syntax is controlled by the definition of the chosen dictionary,
1800 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1802 This will check or reload the dictionary. Use \\[ispell-change-dictionary]
1803 or \\[ispell-region] to update the Ispell process.
1806 nil word is correct or spelling is accepted.
1807 0 word is inserted into buffer-local definitions.
1808 \"word\" word corrected from word list.
1809 \(\"word\" arg\) word is hand entered.
1810 quit spell session exited."
1811 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t
))
1814 (if (featurep 'emacs
)
1816 (and (boundp 'transient-mark-mode
) transient-mark-mode
1817 (boundp 'mark-active
) mark-active
1818 (not (eq (region-beginning) (region-end))))))
1819 (ispell-region (region-beginning) (region-end)))
1820 (continue (ispell-continue))
1822 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1823 (ispell-accept-buffer-local-defs) ; use the correct dictionary
1824 (let ((cursor-location (point)) ; retain cursor location
1825 (word (ispell-get-word following
))
1826 start end poss new-word replace
)
1827 ;; De-structure return word info list.
1828 (setq start
(car (cdr word
))
1829 end
(car (cdr (cdr word
)))
1832 ;; At this point it used to ignore 2-letter words.
1833 ;; But that is silly; if the user asks for it, we should do it. - rms.
1835 (message "Checking spelling of %s..."
1836 (funcall ispell-format-word-function word
)))
1837 (ispell-send-string "%\n") ; put in verbose mode
1838 (ispell-send-string (concat "^" word
"\n"))
1839 ;; wait until ispell has processed word
1841 (ispell-accept-output)
1842 (not (string= "" (car ispell-filter
)))))
1843 ;;(ispell-send-string "!\n") ;back to terse mode.
1844 (setq ispell-filter
(cdr ispell-filter
)) ; remove extra \n
1845 (if (and ispell-filter
(listp ispell-filter
))
1846 (if (> (length ispell-filter
) 1)
1847 (error "Ispell and its process have different character maps")
1848 (setq poss
(ispell-parse-output (car ispell-filter
)))))
1851 (message "%s is correct"
1852 (funcall ispell-format-word-function word
)))
1853 (and (featurep 'xemacs
)
1855 (and (fboundp 'delete-extent
)
1856 (delete-extent (extent-at start
)))))
1859 (message "%s is correct because of root %s"
1860 (funcall ispell-format-word-function word
)
1861 (funcall ispell-format-word-function poss
)))
1862 (and (featurep 'xemacs
)
1864 (and (fboundp 'delete-extent
)
1865 (delete-extent (extent-at start
)))))
1867 (message "Error checking word %s using %s with %s dictionary"
1868 (funcall ispell-format-word-function word
)
1869 (file-name-nondirectory ispell-program-name
)
1870 (or ispell-current-dictionary
"default")))
1871 (ispell-check-only ; called from ispell minor mode.
1872 (if (fboundp 'make-extent
)
1873 (if (fboundp 'set-extent-property
)
1874 (let ((ext (make-extent start end
)))
1875 (set-extent-property ext
'face ispell-highlight-face
)
1876 (set-extent-property ext
'priority
2000)))
1878 (message "%s is incorrect"
1879 (funcall ispell-format-word-function word
))))
1880 (t ; prompt for correct word.
1881 (save-window-excursion
1882 (setq replace
(ispell-command-loop
1883 (car (cdr (cdr poss
)))
1884 (car (cdr (cdr (cdr poss
))))
1885 (car poss
) start end
)))
1886 (cond ((equal 0 replace
)
1887 (ispell-add-per-file-word-list (car poss
)))
1889 (setq new-word
(if (atom replace
) replace
(car replace
))
1890 cursor-location
(+ (- (length word
) (- end start
))
1892 (if (not (equal new-word
(car poss
)))
1895 ;; Insert first and then delete,
1896 ;; to avoid collapsing markers before and after
1897 ;; into a single place.
1899 (delete-region (point) end
)
1900 ;; It is meaningless to preserve the cursor position
1901 ;; inside a word that has changed.
1902 (setq cursor-location
(point))
1903 (setq end
(point))))
1904 (if (not (atom replace
)) ;recheck spelling of replacement
1906 (if (car (cdr replace
)) ; query replace requested
1907 (save-window-excursion
1908 (query-replace word new-word t
)))
1910 ;; single word could be split into multiple words
1911 (setq ispell-quit
(not (ispell-region start end
)))
1913 ;; keep if rechecking word and we keep choices win.
1914 (if (get-buffer ispell-choices-buffer
)
1915 (kill-buffer ispell-choices-buffer
))))
1916 (ispell-pdict-save ispell-silently-savep
)
1917 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
1918 (if ispell-quit
(setq ispell-quit nil replace
'quit
))
1919 (goto-char cursor-location
) ; return to original location
1923 (defun ispell-get-word (following &optional extra-otherchars
)
1924 "Return the word for spell-checking according to ispell syntax.
1925 If optional argument FOLLOWING is non-nil or if `ispell-following-word'
1926 is non-nil when called interactively, then the following word
1927 \(rather than preceding\) is checked when the cursor is not over a word.
1928 Optional second argument contains otherchars that can be included in word
1929 many times (see the doc string of `ispell-dictionary-alist' for details
1932 Word syntax is controlled by the definition of the chosen dictionary,
1933 which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
1934 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
1935 (let* ((ispell-casechars (ispell-get-casechars))
1936 (ispell-not-casechars (ispell-get-not-casechars))
1937 (ispell-otherchars (ispell-get-otherchars))
1938 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1939 (word-regexp (concat ispell-casechars
1941 (if (not (string= "" ispell-otherchars
))
1942 (concat ispell-otherchars
"?"))
1943 (if extra-otherchars
1944 (concat extra-otherchars
"?"))
1947 (if (or ispell-many-otherchars-p
1953 (if (not (looking-at ispell-casechars
))
1955 (re-search-forward ispell-casechars
(point-max) t
)
1956 (re-search-backward ispell-casechars
(point-min) t
)))
1957 ;; move to front of word
1958 (re-search-backward ispell-not-casechars
(point-min) 'start
)
1959 (while (and (or (and (not (string= "" ispell-otherchars
))
1960 (looking-at ispell-otherchars
))
1961 (and extra-otherchars
(looking-at extra-otherchars
)))
1963 (or (not did-it-once
)
1964 ispell-many-otherchars-p
)
1965 (not (eq prevpt
(point))))
1966 (if (and extra-otherchars
(looking-at extra-otherchars
))
1969 (if (looking-at ispell-casechars
)
1970 (re-search-backward ispell-not-casechars
(point-min) 'move
)))
1974 (if (looking-at ispell-casechars
)
1975 (re-search-backward ispell-not-casechars
(point-min) 'move
)
1976 (backward-char -
1))))
1977 ;; Now mark the word and save to string.
1978 (if (not (re-search-forward word-regexp
(point-max) t
))
1979 (if ispell-check-only
1980 ;; return dummy word when just flagging misspellings
1981 (list "" (point) (point))
1982 (error "No word found to check!"))
1983 (setq start
(copy-marker (match-beginning 0))
1985 word
(buffer-substring-no-properties start end
))
1986 (list word start end
))))
1989 ;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1990 ;; tracks changes in the dictionary. The global may either be
1991 ;; a value or a list, whose value is the state of whether the
1992 ;; dictionary needs to be saved.
1995 (defun ispell-pdict-save (&optional no-query force-save
)
1996 "Check to see if the personal dictionary has been modified.
1997 If so, ask if it needs to be saved."
1998 (interactive (list ispell-silently-savep t
))
1999 (if (and ispell-pdict-modified-p
(listp ispell-pdict-modified-p
))
2000 (setq ispell-pdict-modified-p
(car ispell-pdict-modified-p
)))
2001 (when (and (or ispell-pdict-modified-p force-save
)
2003 (y-or-n-p "Personal dictionary modified. Save? ")))
2004 (ispell-send-string "#\n") ; save dictionary
2005 (message "Personal dictionary saved.")
2009 ;; unassert variable, even if not saved to avoid questioning.
2010 (setq ispell-pdict-modified-p nil
))
2013 (defun ispell-command-loop (miss guess word start end
)
2014 "Display possible corrections from list MISS.
2015 GUESS lists possibly valid affix construction of WORD.
2016 Returns nil to keep word.
2017 Returns 0 to insert locally into buffer-local dictionary.
2018 Returns string for new chosen word.
2019 Returns list for new replacement word (will be rechecked).
2020 Query-replace when list length is 2.
2021 Automatic query-replace when second element is `query-replace'.
2022 Highlights the word, which is assumed to run from START to END.
2023 Global `ispell-pdict-modified-p' becomes a list where the only value
2024 indicates whether the dictionary has been modified when option `a'
2026 Global `ispell-quit' set to start location to continue spell session."
2028 (line ispell-choices-win-default-height
)
2029 ;; ensure 4 context lines.
2030 (max-lines (- (ispell-adjusted-window-height) 4))
2032 (window-min-height (min window-min-height
2033 ispell-choices-win-default-height
))
2034 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m
))
2035 (dedicated (window-dedicated-p (selected-window)))
2037 char num result textwin dedicated-win
)
2039 ;; setup the *Choices* buffer with valid data.
2040 (with-current-buffer (get-buffer-create ispell-choices-buffer
)
2041 (setq mode-line-format
2043 "-- %b -- word: " word
2044 " -- dict: " (or ispell-current-dictionary
"default")
2045 " -- prog: " (file-name-nondirectory ispell-program-name
)))
2046 ;; XEmacs: no need for horizontal scrollbar in choices window
2047 (ispell-with-no-warnings
2048 (and (fboundp 'set-specifier
)
2049 (boundp 'horizontal-scrollbar-visible-p
)
2050 (set-specifier horizontal-scrollbar-visible-p nil
2051 (cons (current-buffer) nil
))))
2055 (insert "Affix rules generate and capitalize "
2056 "this word as shown below:\n\t")
2058 (if (> (+ 4 (current-column) (length (car guess
)))
2062 (setq line
(1+ line
))))
2063 (insert (car guess
) " ")
2064 (setq guess
(cdr guess
)))
2065 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.\n")
2066 (setq line
(+ line
(if choices
3 2)))))
2068 (< (if (> (+ 7 (current-column) (length (car choices
))
2069 (if (> count ?~
) 3 0))
2073 (setq line
(1+ line
)))
2076 ;; not so good if there are over 20 or 30 options, but then, if
2077 ;; there are that many you don't want to scan them all anyway...
2078 (while (memq count command-characters
) ; skip command characters.
2079 (setq count
(ispell-int-char (1+ count
))
2080 skipped
(1+ skipped
)))
2081 (insert "(" count
") " (car choices
) " ")
2082 (setq choices
(cdr choices
)
2083 count
(ispell-int-char (1+ count
))))
2084 (setq count
(ispell-int-char (- count ?
0 skipped
))))
2086 ;; ensure word is visible
2087 (if (not (pos-visible-in-window-p end
))
2090 ;; allow temporary split of dedicated windows...
2093 (setq dedicated-win
(selected-window))
2094 (set-window-dedicated-p dedicated-win nil
)))
2096 ;; Display choices for misspelled word.
2097 (ispell-show-choices line end
)
2098 (select-window (setq textwin
(next-window)))
2100 ;; highlight word, protecting current buffer status
2103 (and ispell-highlight-p
2104 (ispell-highlight-spelling-error start end t
))
2105 ;; Loop until a valid choice is made.
2113 (let (message-log-max)
2114 (message (concat "C-h or ? for more options; SPC to leave "
2115 "unchanged, Character to replace word")))
2116 (let ((inhibit-quit t
)
2118 (setq char nil skipped
0)
2119 ;; If the user types C-g, or generates some other
2120 ;; non-character event (such as a frame switch
2121 ;; event), stop ispell. As a special exception,
2122 ;; ignore mouse events occurring in the same frame.
2123 (while (and input-valid
(not (characterp char
)))
2124 (setq char
(read-key))
2126 (or (characterp char
)
2127 (and (mouse-event-p char
)
2128 (eq (selected-frame)
2130 (posn-window (event-start char
))))))))
2131 (when (or quit-flag
(not input-valid
) (= char ?\C-g
))
2132 (setq char ?X quit-flag nil
)))
2133 ;; Adjust num to array offset skipping command characters.
2134 (let ((com-chars command-characters
))
2136 (if (and (> (car com-chars
) ?
0) (< (car com-chars
) char
))
2137 (setq skipped
(1+ skipped
)))
2138 (setq com-chars
(cdr com-chars
)))
2139 (setq num
(- char ?
0 skipped
)))
2142 ((= char ?
) nil
) ; accept word this time only
2143 ((= char ?i
) ; accept and insert word into pers dict
2144 (ispell-send-string (concat "*" word
"\n"))
2145 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2147 ((or (= char ?a
) (= char ?A
)) ; accept word without insert
2148 (ispell-send-string (concat "@" word
"\n"))
2149 (add-to-list 'ispell-buffer-session-localwords word
)
2150 (or ispell-buffer-local-name
; session localwords might conflict
2151 (setq ispell-buffer-local-name
(buffer-name)))
2152 (if (null ispell-pdict-modified-p
)
2153 (setq ispell-pdict-modified-p
2154 (list ispell-pdict-modified-p
)))
2155 (if (= char ?A
) 0)) ; return 0 for ispell-add buffer-local
2156 ((or (= char ?r
) (= char ?R
)) ; type in replacement
2157 (and (eq 'block ispell-highlight-p
) ; refresh tty's
2158 (ispell-highlight-spelling-error start end nil t
))
2160 (if (or (= char ?R
) ispell-query-replace-choices
)
2162 (format "Query-replacement for %s: "word
)
2165 (cons (read-string "Replacement for: " word
)
2167 (and (eq 'block ispell-highlight-p
)
2168 (ispell-highlight-spelling-error start end nil
2171 ((or (= char ??
) (= char help-char
) (= char ?\C-h
))
2172 (and (eq 'block ispell-highlight-p
)
2173 (ispell-highlight-spelling-error start end nil t
))
2175 (and (eq 'block ispell-highlight-p
)
2176 (ispell-highlight-spelling-error start end nil
2179 ;; Quit and move point back.
2181 (ispell-pdict-save ispell-silently-savep
)
2182 (message "Exited spell-checking")
2183 (setq ispell-quit t
)
2185 ;; Quit and preserve point.
2187 (ispell-pdict-save ispell-silently-savep
)
2189 (substitute-command-keys
2190 (concat "Spell-checking suspended;"
2191 " use C-u \\[ispell-word] to resume")))
2192 (setq ispell-quit start
)
2195 (if (y-or-n-p "Really kill Ispell process? ")
2197 (ispell-kill-ispell t
) ; terminate process.
2198 (setq ispell-quit
(or (not ispell-checking-message
)
2200 ispell-pdict-modified-p nil
))
2201 t
)) ; continue if they don't quit.
2203 (and (eq 'block ispell-highlight-p
) ; refresh tty displays
2204 (ispell-highlight-spelling-error start end nil t
))
2205 (let ((new-word (read-string
2206 "Lookup string (`*' is wildcard): "
2210 (with-current-buffer (get-buffer-create
2211 ispell-choices-buffer
)
2215 mode-line-format
;; setup the *Choices* buffer with valid data.
2216 (concat "-- %b -- word: " new-word
2218 (or ispell-complete-word-dict
2219 ispell-alternate-dictionary
))
2220 miss
(lookup-words new-word
)
2222 line ispell-choices-win-default-height
)
2223 (while (and choices
; adjust choices window.
2224 (< (if (> (+ 7 (current-column)
2225 (length (car choices
))
2226 (if (> count ?~
) 3 0))
2230 (setq line
(1+ line
)))
2233 (while (memq count command-characters
)
2234 (setq count
(ispell-int-char (1+ count
))
2235 skipped
(1+ skipped
)))
2236 (insert "(" count
") " (car choices
) " ")
2237 (setq choices
(cdr choices
)
2238 count
(ispell-int-char (1+ count
))))
2239 (setq count
(ispell-int-char
2240 (- count ?
0 skipped
))))
2241 (ispell-show-choices line end
)
2242 (select-window (next-window)))))
2243 (and (eq 'block ispell-highlight-p
)
2244 (ispell-highlight-spelling-error start end nil
2246 t
) ; reselect from new choices
2247 ((= char ?u
) ; insert lowercase into dictionary
2248 (ispell-send-string (concat "*" (downcase word
) "\n"))
2249 (setq ispell-pdict-modified-p
'(t)) ; dictionary modified!
2251 ((= char ?m
) ; type in what to insert
2253 (concat "*" (read-string "Insert: " word
) "\n"))
2254 (setq ispell-pdict-modified-p
'(t))
2256 ((and (>= num
0) (< num count
))
2257 (if ispell-query-replace-choices
; Query replace flag
2258 (list (nth num miss
) 'query-replace
)
2263 ;; This may have alignment errors if current line is edited
2264 (if (marker-position ispell-recursive-edit-marker
)
2266 (message "Only one recursive edit session supported")
2269 (set-marker ispell-recursive-edit-marker start
)
2270 ;;(set-marker ispell-region-end reg-end)
2271 (and ispell-highlight-p
; unhighlight
2272 (ispell-highlight-spelling-error start end
))
2277 (substitute-command-keys
2278 (concat "Exit recursive edit with"
2279 " \\[exit-recursive-edit]")))
2280 (save-window-excursion (save-excursion
2283 (goto-char ispell-recursive-edit-marker
)
2284 (if (not (equal (marker-buffer
2285 ispell-recursive-edit-marker
)
2288 (set-marker ispell-recursive-edit-marker nil
)
2290 "Cannot continue ispell from this buffer.")))
2291 (set-marker ispell-recursive-edit-marker nil
)))
2292 (list word nil
)) ; recheck starting at this word.
2294 (funcall (key-binding "\C-z"))
2299 (and ispell-highlight-p
; unhighlight
2300 (save-window-excursion
2301 (select-window textwin
)
2302 (ispell-highlight-spelling-error start end
)))
2304 (set-window-dedicated-p dedicated-win t
)))))
2308 (defun ispell-show-choices (line end
)
2309 "Show the choices in another buffer or frame."
2310 (if (and ispell-use-framepop-p
(fboundp 'framepop-display-buffer
))
2312 (framepop-display-buffer (get-buffer ispell-choices-buffer
))
2313 ;; (get-buffer-window ispell-choices-buffer t)
2314 (select-window (previous-window))) ; *Choices* window
2315 ;; standard selection by splitting a small buffer out of this window.
2316 (let ((choices-window (get-buffer-window ispell-choices-buffer
)))
2318 (if (= line
(ispell-adjusted-window-height choices-window
))
2319 (select-window choices-window
)
2320 ;; *Choices* window changed size. Adjust the choices window
2321 ;; without scrolling the spelled window when possible
2323 (- line
(ispell-adjusted-window-height choices-window
)))
2324 (visible (progn (vertical-motion -
1) (point))))
2325 (if (< line ispell-choices-win-default-height
)
2326 (setq window-line
(+ window-line
2327 (- ispell-choices-win-default-height
2329 (move-to-window-line 0)
2330 (vertical-motion window-line
)
2331 (set-window-start (selected-window)
2332 (if (> (point) visible
) visible
(point)))
2334 (select-window choices-window
)
2335 (enlarge-window window-line
)))
2336 ;; Overlay *Choices* window when it isn't showing
2337 (ispell-overlay-window (max line ispell-choices-win-default-height
)))
2338 (switch-to-buffer ispell-choices-buffer
)
2339 (goto-char (point-min)))))
2343 (defun ispell-help ()
2344 "Display a list of the options available when a misspelling is encountered.
2348 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2349 SPC: Accept word this time.
2350 `i': Accept word and insert into private dictionary.
2351 `a': Accept word for this session.
2352 `A': Accept word and place in `buffer-local dictionary'.
2353 `r': Replace word with typed-in value. Rechecked.
2354 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2355 `?': Show these commands.
2356 `x': Exit spelling buffer. Move cursor to original point.
2357 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2358 the aborted check to be completed later.
2359 `q': Quit spelling session (Kills ispell process).
2360 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2361 `u': Like `i', but the word is lower-cased first.
2362 `m': Place typed-in value in personal dictionary, then recheck current word.
2363 `C-l': Redraw screen.
2364 `C-r': Recursive edit.
2365 `C-z': Suspend Emacs or iconify frame."
2367 (if (equal ispell-help-in-bufferp
'electric
)
2371 (function (lambda ()
2372 ;;This shouldn't be necessary: with-electric-help needs
2373 ;; an optional argument telling it about the smallest
2374 ;; acceptable window-height of the help buffer.
2375 ;;(if (< (window-height) 15)
2377 ;; (- 15 (ispell-adjusted-window-height))))
2378 (princ "Selections are:
2380 DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2381 SPC: Accept word this time.
2382 `i': Accept word and insert into private dictionary.
2383 `a': Accept word for this session.
2384 `A': Accept word and place in `buffer-local dictionary'.
2385 `r': Replace word with typed-in value. Rechecked.
2386 `R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2387 `?': Show these commands.
2388 `x': Exit spelling buffer. Move cursor to original point.
2389 `X': Exit spelling buffer. Leaves cursor at the current point, and permits
2390 the aborted check to be completed later.
2391 `q': Quit spelling session (Kills ispell process).
2392 `l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2393 `u': Like `i', but the word is lower-cased first.
2394 `m': Place typed-in value in personal dictionary, then recheck current word.
2395 `C-l': Redraw screen.
2396 `C-r': Recursive edit.
2397 `C-z': Suspend Emacs or iconify frame.")
2401 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2402 "[i]nsert into private dictionary"))
2403 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2404 "e[x/X]it; [q]uit session"))
2405 (help-3 (concat "[u]ncapitalized insert into dict. "
2406 "Type 'x C-h f ispell-help' for more help")))
2407 (save-window-excursion
2408 (if ispell-help-in-bufferp
2410 (ispell-overlay-window 4)
2411 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2412 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2414 (kill-buffer "*Ispell Help*"))
2416 (let ((resize-mini-windows 'grow-only
))
2417 (select-window (minibuffer-window))
2420 ;;(set-minibuffer-window (selected-window))
2422 (insert (concat help-1
"\n" help-2
"\n" help-3
))
2424 (erase-buffer)))))))
2427 (defun lookup-words (word &optional lookup-dict
)
2428 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
2429 A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2430 Otherwise the variable `ispell-grep-command' contains the command used to
2431 search for the words (usually egrep).
2433 Optional second argument contains the dictionary to use; the default is
2434 `ispell-alternate-dictionary', overridden by `ispell-complete-word-dict'
2436 ;; We don't use the filter for this function, rather the result is written
2437 ;; into a buffer. Hence there is no need to save the filter values.
2438 (if (null lookup-dict
)
2439 (setq lookup-dict
(or ispell-complete-word-dict
2440 ispell-alternate-dictionary
)))
2443 (unless (file-readable-p lookup-dict
)
2444 (error "lookup-words error: Unreadable or missing plain word-list %s."
2446 (error (concat "lookup-words error: No plain word-list found at system"
2447 "default locations. "
2448 "Customize `ispell-alternate-dictionary' to set yours.")))
2450 (let* ((process-connection-type ispell-use-ptys-p
)
2451 (wild-p (string-match "\\*" word
))
2452 (look-p (and ispell-look-p
; Only use look for an exact match.
2453 (or ispell-have-new-look
(not wild-p
))))
2454 (prog (if look-p ispell-look-command ispell-grep-command
))
2455 (args (if look-p ispell-look-options ispell-grep-options
))
2458 (message "Starting \"%s\" process..." (file-name-nondirectory prog
))
2462 (insert "^" word
"$")
2463 (while (search-backward "*" nil t
) (insert "."))
2464 (setq word
(buffer-string))
2466 (setq status
(apply 'ispell-call-process prog nil t nil
2467 (nconc (if (and args
(> (length args
) 0))
2472 (if lookup-dict
(list lookup-dict
)))))
2473 ;; `grep' returns status 1 and no output when word not found, which
2474 ;; is a perfectly normal thing.
2475 (if (stringp status
)
2476 (error "error: %s exited with signal %s"
2477 (file-name-nondirectory prog
) status
)
2478 ;; Else collect words into `results' in FIFO order.
2479 (goto-char (point-max))
2480 ;; Assure we've ended with \n.
2481 (or (bobp) (= (preceding-char) ?
\n) (insert ?
\n))
2485 (push (buffer-substring-no-properties (point)
2488 (if (and results
(string-match ".+: " (car results
)))
2489 (error "%s error: %s" ispell-grep-command
(car results
)))
2493 ;; "ispell-filter" is a list of output lines from the generating function.
2494 ;; Each full line (ending with \n) is a separate item on the list.
2495 ;; "output" can contain multiple lines, part of a line, or both.
2496 ;; "start" and "end" are used to keep bounds on lines when "output" contains
2498 ;; "ispell-filter-continue" is true when we have received only part of a
2499 ;; line as output from a generating function ("output" did not end with \n)
2500 ;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2501 ;; This is the case when a process dies or fails. The default behavior
2502 ;; in this case treats the next input received as fresh input.
2504 (defun ispell-filter (process output
)
2505 "Output filter function for ispell, grep, and look."
2510 (setq end
(string-match "\n" output start
)) ; get text up to the newline.
2511 ;; If we get out of sync and ispell-filter-continue is asserted when we
2512 ;; are not continuing, treat the next item as a separate list. When
2513 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2516 ;; Continue with same line (item)?
2517 (if (and ispell-filter-continue ispell-filter
(listp ispell-filter
))
2518 ;; Yes. Add it to the prev item
2519 (setcar ispell-filter
2520 (concat (car ispell-filter
) (substring output start end
)))
2521 ;; No. This is a new line and item.
2523 (cons (substring output start end
) ispell-filter
)))
2525 ;; We've completed reading the output, but didn't finish the line.
2526 (setq ispell-filter-continue t continue nil
)
2527 ;; skip over newline, this line complete.
2528 (setq ispell-filter-continue nil end
(1+ end
))
2529 (if (= end
(length output
)) ; No more lines in output
2530 (setq continue nil
) ; so we can exit the filter.
2531 (setq start end
)))))) ; else move start to next line of input
2534 ;; This function destroys the mark location if it is in the word being
2536 (defun ispell-highlight-spelling-error-generic (start end
&optional highlight
2538 "Highlight the word from START to END with a kludge using `inverse-video'.
2539 When the optional third arg HIGHLIGHT is set, the word is highlighted;
2540 otherwise it is displayed normally.
2541 Uses block cursor to highlight one character.
2542 Optional REFRESH will unhighlighted then highlight, using block cursor
2543 highlighting when REFRESH is equal to `block'."
2544 (and (eq 'block ispell-highlight-p
)
2545 (or (eq 'block refresh
)
2546 (setq start
(1+ start
)))) ; On block non-refresh, inc start.
2547 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2548 (buffer-read-only nil
) ; Allow highlighting read-only buffers.
2549 (text (buffer-substring-no-properties start end
))
2550 ; Save highlight region.
2551 (inhibit-quit t
) ; inhibit interrupt processing here.
2552 (buffer-undo-list t
)) ; don't clutter the undo list.
2554 (delete-region start end
)
2555 (insert-char ?
(- end start
)) ; minimize amount of redisplay
2556 (sit-for 0) ; update display
2557 (if highlight
(setq inverse-video
(not inverse-video
))) ; toggle video
2558 (delete-region start end
) ; delete whitespace
2559 (insert text
) ; insert text in inverse video.
2560 (sit-for 0) ; update display showing inverse video.
2563 (setq inverse-video
(not inverse-video
)) ; toggle video
2564 (and (eq 'block ispell-highlight-p
)
2565 (goto-char (1- start
)))) ; use block cursor to "highlight" char
2566 (set-buffer-modified-p modified
) ; don't modify if flag not set.
2567 (and refresh
; re-highlight
2568 (ispell-highlight-spelling-error-generic
2569 (if (eq 'block refresh
) start
(- start
2)) end t
))))
2572 (defun ispell-highlight-spelling-error-xemacs (start end
&optional highlight
)
2573 "Highlight the word from START to END using `isearch-highlight'.
2574 When the optional third arg HIGHLIGHT is set, the word is highlighted,
2575 otherwise it is displayed normally."
2577 (isearch-highlight start end
)
2578 (isearch-dehighlight))
2583 (defun ispell-highlight-spelling-error-overlay (start end
&optional highlight
)
2584 "Highlight the word from START to END using overlays.
2585 When the optional third arg HIGHLIGHT is set, the word is highlighted
2586 otherwise it is displayed normally.
2588 The variable `ispell-highlight-face' selects the face to use for highlighting."
2591 (move-overlay ispell-overlay start end
(current-buffer))
2592 (setq ispell-overlay
(make-overlay start end
))
2593 (overlay-put ispell-overlay
'priority
1001) ;higher than lazy overlays
2594 (overlay-put ispell-overlay
'face ispell-highlight-face
))
2596 (delete-overlay ispell-overlay
)))
2597 (if (and ispell-lazy-highlight
(boundp 'lazy-highlight-cleanup
))
2599 (let ((isearch-string
2602 (regexp-quote (buffer-substring-no-properties start end
))
2605 (isearch-case-fold-search nil
))
2606 (isearch-lazy-highlight-new-loop
2607 (if (boundp 'reg-start
) reg-start
)
2608 (if (boundp 'reg-end
) reg-end
)))
2609 (lazy-highlight-cleanup lazy-highlight-cleanup
)
2610 (setq isearch-lazy-highlight-last-string nil
))))
2613 (defun ispell-highlight-spelling-error (start end
&optional highlight refresh
)
2616 (ispell-highlight-spelling-error-xemacs start end highlight
))
2617 ((and (featurep 'faces
)
2618 (or (and (fboundp 'display-color-p
) (display-color-p))
2620 (ispell-highlight-spelling-error-overlay start end highlight
))
2621 (t (ispell-highlight-spelling-error-generic start end highlight refresh
))))
2623 (defun ispell-adjusted-window-height (&optional window
)
2624 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2625 The value returned is actually the nominal number of text-lines in the
2626 window plus 1. On a terminal, this is the same value returned by
2627 `window-height', but if the window has a mode-line is taller than a normal
2628 text line, the returned value may be smaller than that from
2630 (cond ((fboundp 'window-text-height
)
2631 (1+ (window-text-height window
)))
2632 ((or (and (fboundp 'display-graphic-p
) (display-graphic-p))
2633 (and (featurep 'xemacs
) window-system
))
2634 (1- (window-height window
)))
2636 (window-height window
))))
2638 (defun ispell-overlay-window (height)
2639 "Create a window covering the top HEIGHT lines of the current window.
2640 Ensure that the line above point is still visible but otherwise avoid
2641 scrolling the current window. Leave the new window selected."
2643 (let ((oldot (save-excursion (vertical-motion -
1) (point)))
2644 (top (save-excursion (move-to-window-line height
) (point))))
2645 ;; If line above old point (line starting at oldot) would be
2646 ;; hidden by new window, scroll it to just below new win
2647 ;; otherwise set top line of other win so it doesn't scroll.
2648 (if (< oldot top
) (setq top oldot
))
2649 ;; if frame is unsplittable, temporarily disable that...
2650 (if (cdr (assq 'unsplittable
(frame-parameters (selected-frame))))
2651 (let ((frame (selected-frame)))
2652 (modify-frame-parameters frame
'((unsplittable . nil
)))
2653 (split-window nil height
)
2654 (modify-frame-parameters frame
'((unsplittable . t
))))
2655 (split-window nil height
))
2656 (let ((deficit (- height
(ispell-adjusted-window-height))))
2658 ;; Number of lines the window is still too short. We ensure that
2659 ;; there are at least (1- HEIGHT) lines visible in the window.
2660 (enlarge-window deficit
)
2662 (vertical-motion deficit
)
2663 (setq top
(min (point) oldot
))))
2664 (set-window-start (next-window) top
))))
2667 ;; Should we add a compound word match return value?
2668 (defun ispell-parse-output (output &optional accept-list shift
)
2669 "Parse the OUTPUT string from Ispell process and return:
2670 1: t for an exact match.
2671 2: A string containing the root word matched via suffix removal.
2672 3: A list of possible correct spellings of the format:
2673 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
2674 ORIGINAL-WORD is a string of the possibly misspelled word.
2675 OFFSET is an integer giving the line offset of the word.
2676 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
2677 4: nil when an error has occurred.
2679 Optional second arg ACCEPT-LIST is list of words already accepted.
2680 Optional third arg SHIFT is an offset to apply based on previous corrections."
2682 ((string= output
"") t
) ; for startup with pipes...
2683 ((string= output
"*") t
) ; exact match
2684 ((string= output
"-") t
) ; compound word match
2685 ((eq (aref output
0) ?
+) ; found because of root word
2686 (substring output
2)) ; return root word
2687 ((equal 0 (string-match "[\ra-zA-Z]" output
))
2688 (ding) ; error message from ispell!
2689 (message "Ispell error: %s" output
)
2692 (t ; need to process &, ?, and #'s
2693 (let ((type (aref output
0)) ; &, ?, or #
2694 (original-word (substring output
2 (string-match " " output
2)))
2695 (cur-count 0) ; contains number of misses + guesses
2696 count miss-list guess-list offset
)
2697 (setq output
(substring output
(match-end 0))) ; skip over misspelling
2699 (setq count
0) ; no misses for type #
2700 (setq count
(string-to-number output
) ; get number of misses.
2701 output
(substring output
(1+ (string-match " " output
1)))))
2702 (setq offset
(string-to-number output
))
2703 (setq output
(if (eq type ?
#) ; No miss or guess list.
2705 (substring output
(1+ (string-match " " output
1)))))
2707 (let ((end (string-match ", \\|\\($\\)" output
))) ; end of miss/guess.
2708 (setq cur-count
(1+ cur-count
))
2709 (if (> cur-count count
)
2710 (push (substring output
0 end
) guess-list
)
2711 (push (substring output
0 end
) miss-list
))
2712 (setq output
(if (match-end 1) ; True only when at end of line.
2713 nil
; No more misses or guesses.
2714 (substring output
(+ end
2))))))
2715 ;; return results. Accept word if it was already accepted.
2717 (if (member original-word accept-list
)
2720 (if (numberp shift
) (+ shift offset
) offset
)
2721 (nreverse miss-list
) (nreverse guess-list
)))))))
2724 (defun ispell-process-status ()
2725 "Return the status of the Ispell process.
2726 When asynchronous processes are not supported, `run' is always returned."
2727 (if ispell-async-processp
2728 (process-status ispell-process
)
2729 (and ispell-process
'run
)))
2732 (defun ispell-start-process ()
2733 "Start the Ispell process, with support for no asynchronous processes.
2734 Keeps argument list for future Ispell invocations for no async support."
2735 ;; `ispell-current-dictionary' and `ispell-current-personal-dictionary'
2736 ;; are properly set in `ispell-internal-change-dictionary'.
2737 (let* ((default-directory
2738 (if (and (file-directory-p default-directory
)
2739 (file-readable-p default-directory
))
2741 ;; Defend against bad `default-directory'.
2742 (expand-file-name "~/")))
2743 (orig-args (ispell-get-ispell-args))
2746 (if (and ispell-current-dictionary
; Not for default dict (nil)
2747 (not (member "-d" orig-args
))) ; Only define if not overridden.
2748 (list "-d" ispell-current-dictionary
))
2750 (if ispell-current-personal-dictionary
; Use specified pers dict.
2751 (list "-p" ispell-current-personal-dictionary
))
2752 ;; If we are using recent aspell or hunspell, make sure we use the
2753 ;; right encoding for communication. ispell or older aspell/hunspell
2754 ;; does not support this.
2755 (if ispell-encoding8-command
2756 (if ispell-really-hunspell
2757 (list ispell-encoding8-command
2758 (upcase (symbol-name (ispell-get-coding-system))))
2760 (concat ispell-encoding8-command
2761 (symbol-name (ispell-get-coding-system))))))
2762 ispell-extra-args
)))
2764 ;; Initially we don't know any buffer's local words.
2765 (setq ispell-buffer-local-name nil
)
2767 (if ispell-async-processp
2768 (let ((process-connection-type ispell-use-ptys-p
))
2769 (apply 'start-process
2770 "ispell" nil ispell-program-name
2771 "-a" ; Accept single input lines.
2772 ;; Make root/affix combos not in dict.
2773 ;; hunspell -m option means different.
2774 (if ispell-really-hunspell
"" "-m")
2776 (setq ispell-cmd-args args
2777 ispell-output-buffer
(generate-new-buffer " *ispell-output*")
2778 ispell-session-buffer
(generate-new-buffer " *ispell-session*"))
2779 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2783 (defun ispell-init-process ()
2784 "Check status of Ispell process and start if necessary."
2785 (let* (;; Basename of dictionary used by the spell-checker
2786 (dict-bname (or (car (cdr (member "-d" (ispell-get-ispell-args))))
2787 ispell-current-dictionary
))
2788 ;; The directory where process was started.
2789 (current-ispell-directory default-directory
)
2790 ;; The default directory for the process.
2791 ;; Use "~/" as default-directory unless using Ispell with per-dir
2792 ;; personal dictionaries and not in a minibuffer under XEmacs
2794 (if (or ispell-really-aspell
2795 ispell-really-hunspell
2796 ;; Protect against bad default-directory
2797 (not (and (file-directory-p default-directory
)
2798 (file-readable-p default-directory
)))
2799 ;; Ispell and per-dir personal dicts available
2800 (not (or (file-readable-p (concat default-directory
2802 (file-readable-p (concat default-directory
2806 ;; Ispell, in a minibuffer, and XEmacs
2807 (and (window-minibuffer-p)
2808 (not (fboundp 'minibuffer-selected-window
))))
2809 (expand-file-name "~/")
2810 (expand-file-name default-directory
))))
2811 ;; Check if process needs restart
2812 (if (and ispell-process
2813 (eq (ispell-process-status) 'run
)
2814 ;; Unless we are using an explicit personal dictionary, ensure
2815 ;; we're in the same default directory! Restart check for
2816 ;; personal dictionary is done in
2817 ;; `ispell-internal-change-dictionary', called from
2818 ;; `ispell-buffer-local-dict'
2819 (or (or ispell-local-pdict ispell-personal-dictionary
)
2820 (equal ispell-process-directory default-directory
)))
2821 (setq ispell-filter nil ispell-filter-continue nil
)
2822 ;; may need to restart to select new personal dictionary.
2823 (ispell-kill-ispell t
)
2824 (message "Starting new Ispell process [%s::%s] ..."
2826 (or ispell-local-dictionary ispell-dictionary
"default"))
2828 (setq ispell-library-directory
(ispell-check-version)
2829 ispell-process
(ispell-start-process)
2831 ispell-filter-continue nil
2832 ispell-process-directory default-directory
)
2834 (unless (equal ispell-process-directory
(expand-file-name "~/"))
2835 ;; At this point, `ispell-process-directory' will be "~/" unless using
2836 ;; Ispell with directory-specific dicts and not in XEmacs minibuffer.
2837 ;; If not, kill ispell process when killing buffer. It may be in a
2838 ;; removable device that would otherwise become un-mountable.
2839 (with-current-buffer
2840 (if (and (window-minibuffer-p) ;; In minibuffer
2841 (fboundp 'minibuffer-selected-window
)) ;; Not XEmacs.
2842 ;; In this case kill ispell only when parent buffer is killed
2843 ;; to avoid over and over ispell kill.
2844 (window-buffer (minibuffer-selected-window))
2846 ;; 'local does not automatically make hook buffer-local in XEmacs.
2847 (if (featurep 'xemacs
)
2848 (make-local-hook 'kill-buffer-hook
))
2849 (add-hook 'kill-buffer-hook
2850 (lambda () (ispell-kill-ispell t
)) nil
'local
)))
2852 (if ispell-async-processp
2853 (set-process-filter ispell-process
'ispell-filter
))
2854 ;; Protect against XEmacs bogus binding of `enable-multibyte-characters'.
2855 (if (and (or (featurep 'xemacs
)
2856 (and (boundp 'enable-multibyte-characters
)
2857 enable-multibyte-characters
))
2858 (fboundp 'set-process-coding-system
))
2859 (set-process-coding-system ispell-process
(ispell-get-coding-system)
2860 (ispell-get-coding-system)))
2861 ;; Get version ID line
2862 (ispell-accept-output 3)
2863 ;; get more output if filter empty?
2864 (if (null ispell-filter
) (ispell-accept-output 3))
2865 (cond ((null ispell-filter
)
2866 (error "%s did not output version line" ispell-program-name
))
2868 (stringp (car ispell-filter
))
2869 (if (string-match "warning: " (car ispell-filter
))
2871 (ispell-accept-output 3) ; was warn msg.
2872 (stringp (car ispell-filter
)))
2873 (null (cdr ispell-filter
)))
2874 (string-match "^@(#) " (car ispell-filter
)))
2875 ;; got the version line as expected (we already know it's the right
2876 ;; version, so don't bother checking again.)
2879 ;; Otherwise, it must be an error message. Show the user.
2880 ;; But first wait to see if some more output is going to arrive.
2881 ;; Otherwise we get cool errors like "Can't open ".
2883 (ispell-accept-output 3)
2884 (error "%s" (mapconcat 'identity ispell-filter
"\n"))))
2885 (setq ispell-filter nil
) ; Discard version ID line
2886 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2887 (if extended-char-mode
; ~ extended character mode
2888 (ispell-send-string (concat extended-char-mode
"\n"))))
2889 (if ispell-async-processp
2890 (if (featurep 'emacs
)
2891 (set-process-query-on-exit-flag ispell-process nil
)
2892 (if (fboundp 'set-process-query-on-exit-flag
)
2893 (set-process-query-on-exit-flag ispell-process nil
)
2894 (process-kill-without-query ispell-process
)))))))
2897 (defun ispell-kill-ispell (&optional no-error clear
)
2898 "Kill current Ispell process (so that you may start a fresh one).
2899 With NO-ERROR, just return non-nil if there was no Ispell running.
2900 With CLEAR, buffer session localwords are cleaned."
2902 ;; This hook is typically used by flyspell to flush some variables used
2903 ;; to optimize the common cases.
2904 (run-hooks 'ispell-kill-ispell-hook
)
2906 (if (featurep 'xemacs
)
2908 (called-interactively-p 'interactive
)))
2909 (setq ispell-buffer-session-localwords nil
))
2910 (if (not (and ispell-process
2911 (eq (ispell-process-status) 'run
)))
2913 (error "There is no Ispell process running!"))
2914 (if ispell-async-processp
2915 (delete-process ispell-process
)
2916 ;; Synchronous processes.
2917 (ispell-send-string "\n") ; Make sure side effects occurred.
2918 (kill-buffer ispell-output-buffer
)
2919 (kill-buffer ispell-session-buffer
)
2920 (setq ispell-output-buffer nil
2921 ispell-session-buffer nil
))
2922 (setq ispell-process nil
)
2923 (message "Ispell process killed")
2926 ;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2927 ;; call ispell-init-process rather than wait for a spell checking command?
2930 (defun ispell-change-dictionary (dict &optional arg
)
2931 "Change to dictionary DICT for Ispell.
2932 With a prefix arg, set it \"globally\", for all buffers.
2933 Without a prefix arg, set it \"locally\", just for this buffer.
2935 By just answering RET you can find out what the current dictionary is."
2937 (list (completing-read
2938 "Use new dictionary (RET for current, SPC to complete): "
2939 (and (fboundp 'ispell-valid-dictionary-list
)
2940 (mapcar 'list
(ispell-valid-dictionary-list)))
2942 current-prefix-arg
))
2943 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
2944 (unless arg
(ispell-buffer-local-dict 'no-reload
))
2945 (if (equal dict
"default") (setq dict nil
))
2946 ;; This relies on completing-read's bug of returning "" for no match
2947 (cond ((equal dict
"")
2948 (ispell-internal-change-dictionary)
2949 (message "Using %s dictionary"
2950 (or (and (not arg
) ispell-local-dictionary
)
2951 ispell-dictionary
"default")))
2952 ((equal dict
(or (and (not arg
) ispell-local-dictionary
)
2953 ispell-dictionary
"default"))
2954 ;; Specified dictionary is the default already. Could reload
2955 ;; the dictionaries if needed.
2956 (ispell-internal-change-dictionary)
2957 (and (if (featurep 'xemacs
)
2959 (called-interactively-p 'interactive
))
2960 (message "No change, using %s dictionary" dict
)))
2961 (t ; reset dictionary!
2962 (if (or (assoc dict ispell-local-dictionary-alist
)
2963 (assoc dict ispell-dictionary-alist
))
2965 ;; set default dictionary
2966 (setq ispell-dictionary dict
)
2967 ;; set local dictionary
2968 (setq ispell-local-dictionary dict
)
2969 (setq ispell-local-dictionary-overridden t
))
2970 (error "Undefined dictionary: %s" dict
))
2971 (ispell-internal-change-dictionary)
2972 (setq ispell-buffer-session-localwords nil
)
2973 (message "%s Ispell dictionary set to %s"
2974 (if arg
"Global" "Local")
2977 (defun ispell-internal-change-dictionary ()
2978 "Update the dictionary and the personal dictionary used by Ispell.
2979 This may kill the Ispell process; if so, a new one will be started
2981 (let* ((dict (or ispell-local-dictionary ispell-dictionary
))
2982 (pdict (or ispell-local-pdict ispell-personal-dictionary
))
2983 (expanded-pdict (if pdict
(expand-file-name pdict
))))
2984 (unless (and (equal ispell-current-dictionary dict
)
2985 (equal ispell-current-personal-dictionary
2987 (ispell-kill-ispell t
)
2988 (setq ispell-current-dictionary dict
2989 ispell-current-personal-dictionary expanded-pdict
))))
2991 ;; Avoid error messages when compiling for these dynamic variables.
2992 (defvar ispell-start
)
2995 ;; Spelling of comments are checked when ispell-check-comments is non-nil.
2998 (defun ispell-region (reg-start reg-end
&optional recheckp shift
)
2999 "Interactively check a region for spelling errors.
3000 Return nil if spell session was terminated, otherwise returns shift offset
3001 amount for last line processed."
3002 (interactive "r") ; Don't flag errors on read-only bufs.
3003 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
3005 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
3006 (let ((skip-region-start (make-marker))
3007 (rstart (make-marker))
3008 (region-type (if (and (= reg-start
(point-min)) (= reg-end
(point-max)))
3009 (buffer-name) "region"))
3010 (program-basename (file-name-nondirectory ispell-program-name
))
3011 (dictionary (or ispell-current-dictionary
"default")))
3014 (message "Spell-checking %s using %s with %s dictionary..."
3015 region-type program-basename dictionary
)
3016 ;; Returns cursor to original location.
3017 (save-window-excursion
3018 (goto-char reg-start
)
3019 (let ((transient-mark-mode)
3020 (case-fold-search case-fold-search
)
3023 (ispell-print-if-debug
3026 "ispell-region: (ispell-skip-region-list):\n%s\n"
3027 (ispell-skip-region-list))
3029 "ispell-region: (ispell-begin-skip-region-regexp):\n%s\n"
3030 (ispell-begin-skip-region-regexp))
3031 "ispell-region: Search for first region to skip after (ispell-begin-skip-region-regexp)\n"))
3032 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t
)
3034 (setq key
(match-string-no-properties 0))
3035 (set-marker skip-region-start
(- (point) (length key
)))
3036 (goto-char reg-start
)
3037 (ispell-print-if-debug
3038 (format "ispell-region: First skip: %s at (pos,line,column): (%s,%s,%s).\n"
3040 (save-excursion (goto-char skip-region-start
) (point))
3041 (line-number-at-pos skip-region-start
)
3042 (save-excursion (goto-char skip-region-start
) (current-column))))))
3043 (ispell-print-if-debug
3045 "ispell-region: Continue spell-checking with %s and %s dictionary...\n"
3046 program-basename dictionary
))
3047 (set-marker rstart reg-start
)
3048 (set-marker ispell-region-end reg-end
)
3049 (while (and (not ispell-quit
)
3050 (< (point) ispell-region-end
))
3051 ;; spell-check region with skipping
3052 (if (and (marker-position skip-region-start
)
3053 (<= skip-region-start
(point)))
3055 ;; If region inside line comment, must keep comment start.
3056 (setq in-comment
(point)
3059 (or (null comment-end
) (string= "" comment-end
))
3062 (re-search-forward comment-start in-comment t
))
3064 ;; Can change skip-regexps (in ispell-message)
3065 (ispell-skip-region key
) ; moves pt past region.
3066 (set-marker rstart
(point))
3067 ;; check for saving large attachments...
3068 (setq query-fcc
(and query-fcc
3069 (ispell-ignore-fcc skip-region-start
3071 (if (and (< rstart ispell-region-end
)
3073 (ispell-begin-skip-region-regexp)
3074 ispell-region-end t
))
3076 (setq key
(match-string-no-properties 0))
3077 (set-marker skip-region-start
3078 (- (point) (length key
)))
3080 (ispell-print-if-debug
3081 (format "ispell-region: Next skip: %s at (pos,line,column): (%s,%s,%s).\n"
3083 (save-excursion (goto-char skip-region-start
) (point))
3084 (line-number-at-pos skip-region-start
)
3085 (save-excursion (goto-char skip-region-start
) (current-column)))))
3086 (set-marker skip-region-start nil
))))
3087 (setq reg-end
(max (point)
3088 (if (marker-position skip-region-start
)
3089 (min skip-region-start ispell-region-end
)
3090 (marker-position ispell-region-end
))))
3091 (let* ((ispell-start (point))
3092 (ispell-end (min (point-at-eol) reg-end
))
3093 ;; See if line must be prefixed by comment string to let ispell know this is
3094 ;; part of a comment string. This is only supported in some modes.
3095 ;; In particular, this is not supported in autoconf mode where adding the
3096 ;; comment string messes everything up because ispell tries to spellcheck the
3097 ;; `dnl' string header causing misalignments in some cases (debbugs.gnu.org: #12768).
3098 (add-comment (and in-comment
3099 (not (string= in-comment
"dnl "))
3101 (string (ispell-get-line
3102 ispell-start ispell-end add-comment
)))
3103 (ispell-print-if-debug
3105 "ispell-region: string pos (%s->%s), eol: %s, [in-comment]: [%s], [add-comment]: [%s], [string]: [%s]\n"
3106 ispell-start ispell-end
(point-at-eol) in-comment add-comment string
))
3107 (if add-comment
; account for comment chars added
3108 (setq ispell-start
(- ispell-start
(length add-comment
))
3110 (setq ispell-end
(point)) ; "end" tracks region retrieved.
3111 (if string
; there is something to spell check!
3112 ;; (special start end)
3113 (setq shift
(ispell-process-line string
3114 (and recheckp shift
))))
3115 (goto-char ispell-end
)))))
3120 (if (and (not (and recheckp ispell-keep-choices-win
))
3121 (get-buffer ispell-choices-buffer
))
3122 (kill-buffer ispell-choices-buffer
))
3123 (set-marker skip-region-start nil
)
3124 (set-marker rstart nil
)
3127 ;; preserve or clear the region for ispell-continue.
3128 (if (not (numberp ispell-quit
))
3129 (set-marker ispell-region-end nil
)
3130 ;; Ispell-continue enabled - ispell-region-end is set.
3131 (goto-char ispell-quit
))
3132 ;; Check for aborting
3133 (if (and ispell-checking-message
(numberp ispell-quit
))
3135 (setq ispell-quit nil
)
3136 (error "Message send aborted")))
3137 (if (not recheckp
) (setq ispell-quit nil
)))
3138 (if (not recheckp
) (set-marker ispell-region-end nil
))
3139 ;; Only save if successful exit.
3140 (ispell-pdict-save ispell-silently-savep
)
3141 (message "Spell-checking %s using %s with %s dictionary...done"
3142 region-type program-basename dictionary
)))))
3145 (defun ispell-begin-skip-region-regexp ()
3146 "Return a regexp of the search keys for region skipping.
3147 Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
3148 Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
3154 (if (and ispell-checking-message
3155 (not (eq t ispell-checking-message
)))
3156 (mapconcat #'car ispell-checking-message
"\\|"))
3158 (if (eq ispell-parser
'tex
)
3159 (ispell-begin-tex-skip-regexp))
3161 (if ispell-skip-html
3162 (ispell-begin-skip-region ispell-html-skip-alists
))
3164 (if ispell-skip-tib ispell-tib-ref-beginning
)
3166 (if (and (eq 'exclusive ispell-check-comments
) comment-start
)
3167 ;; search from end of current comment to start of next comment.
3168 (if (string= "" comment-end
) "^" (regexp-quote comment-end
)))
3169 (if (and (null ispell-check-comments
) comment-start
)
3170 (regexp-quote comment-start
))
3171 (ispell-begin-skip-region ispell-skip-region-alist
)))
3175 (defun ispell-begin-skip-region (skip-alist)
3176 "Regular expression for start of regions to skip generated from SKIP-ALIST.
3177 Each selection should be a key of SKIP-ALIST;
3178 otherwise, the current line is skipped."
3179 (mapconcat (lambda (lst) (if (stringp (car lst
)) (car lst
) (eval (car lst
))))
3184 (defun ispell-begin-tex-skip-regexp ()
3185 "Regular expression of tex commands to skip.
3186 Generated from `ispell-tex-skip-alists'."
3189 (mapconcat (function (lambda (lst) (car lst
)))
3190 (car ispell-tex-skip-alists
)
3193 ;; keys wrapped in begin{}
3194 (mapconcat (function (lambda (lst)
3195 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
3198 (car (cdr ispell-tex-skip-alists
))
3202 (defun ispell-skip-region-list ()
3203 "Return a list describing key and body regions to skip for this buffer.
3204 Includes regions defined by `ispell-skip-region-alist', tex mode,
3205 `ispell-html-skip-alists', and `ispell-checking-message'.
3206 Manual checking must include comments and tib references.
3207 The list is of the form described by variable `ispell-skip-region-alist'.
3208 Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
3209 (let ((skip-alist ispell-skip-region-alist
))
3210 ;; only additional explicit region definition is tex.
3211 (if (eq ispell-parser
'tex
)
3212 (setq case-fold-search nil
3213 skip-alist
(append (car ispell-tex-skip-alists
)
3214 (car (cdr ispell-tex-skip-alists
))
3216 (if ispell-skip-html
3217 (setq skip-alist
(append ispell-html-skip-alists skip-alist
)))
3218 (if (and ispell-checking-message
3219 (not (eq t ispell-checking-message
)))
3220 (setq skip-alist
(append ispell-checking-message skip-alist
)))
3224 (defun ispell-tex-arg-end (&optional arg
)
3225 "Skip across ARG number of braces."
3228 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
3229 (forward-sexp (or arg
1)))
3231 (message "Error skipping s-expressions at point %d." (point))
3236 (defun ispell-ignore-fcc (start end
)
3237 "Delete the Fcc: message header when large attachments are included.
3238 Return value `nil' if file with large attachments is saved.
3239 This can be used to avoid multiple questions for multiple large attachments.
3240 Returns point to starting location afterwards."
3242 (if (and ispell-checking-message ispell-message-fcc-skip
)
3243 (if (< ispell-message-fcc-skip
(- end start
))
3244 (let (case-fold-search head-end
)
3245 (goto-char (point-min))
3247 (or (re-search-forward
3248 (concat "^" (regexp-quote mail-header-separator
) "$")
3250 (re-search-forward "^$" nil t
)
3252 (goto-char (point-min))
3253 (if (re-search-forward "^Fcc:" head-end t
)
3255 "Save copy of this message with large attachments? ")
3263 (defun ispell-skip-region (key)
3264 "Skip across KEY and then to end of region.
3265 Key lookup determines region to skip.
3266 Point is placed at end of skipped region."
3267 ;; move over key to begin checking.
3268 (forward-char (length key
))
3269 (let ((start (point))
3270 ;; Regenerate each call... This function can change region definition.
3271 (alist (ispell-skip-region-list))
3272 alist-key null-skip
)
3274 ;; what about quoted comment, or comment inside strings?
3275 ((and (null ispell-check-comments
) comment-start
3276 (string= key comment-start
))
3277 (if (string= "" comment-end
)
3279 (search-forward comment-end ispell-region-end t
)))
3280 ((and (eq 'exclusive ispell-check-comments
) comment-start
3281 (string= key comment-end
))
3282 (search-forward comment-start ispell-region-end
:end
))
3283 ((and ispell-skip-tib
(string-match ispell-tib-ref-beginning key
))
3284 (re-search-forward ispell-tib-ref-end ispell-region-end t
))
3285 ;; markings from alist
3288 (setq alist-key
(eval (car (car alist
))))
3289 (if (string-match alist-key key
)
3291 (setq alist
(cdr (car alist
)))
3293 ((null alist
) (setq null-skip t
)) ; done! Just skip key.
3294 ((not (consp alist
))
3295 ;; Search past end of spell region to find this region end.
3296 (re-search-forward (eval alist
) (point-max) t
))
3297 ((and (= 1 (length alist
))
3298 (stringp (car alist
)))
3299 (re-search-forward (car alist
) (point-max) t
))
3301 (setq null-skip t
) ; error handling in functions!
3302 (if (consp (cdr alist
))
3303 (apply (car alist
) (cdr alist
))
3304 (funcall (car alist
)))))
3306 (setq alist
(cdr alist
))))))
3307 (if (and (= start
(point)) (null null-skip
))
3309 (message "Matching region end for `%s' point %d not found"
3315 (defun ispell-get-line (start end in-comment
)
3316 "Grab the next line of data.
3317 Returns a string with the line data."
3318 (let ((ispell-casechars (ispell-get-casechars))
3320 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
3321 ((eolp) ; END OF LINE, just go to next line.
3323 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
3324 ;; (forward-char 1)) ; not needed as quoted below.
3325 ((or (re-search-forward ispell-casechars end t
) ; TEXT EXISTS
3326 (re-search-forward "[][()${}]" end t
)) ; or MATH COMMANDS
3327 (setq string
(concat "^" in-comment
3328 (buffer-substring-no-properties start end
)
3331 (t (goto-char end
))) ; EMPTY LINE, skip it.
3335 (defun ispell-looking-at (string)
3336 (let ((coding (ispell-get-coding-system))
3337 (len (length string
)))
3338 (and (<= (+ (point) len
) (point-max))
3339 (equal (encode-coding-string string coding
)
3340 (encode-coding-string (buffer-substring-no-properties
3341 (point) (+ (point) len
))
3344 (defun ispell-process-line (string shift
)
3345 "Send STRING, a line of text, to ispell and process the result.
3346 This will modify the buffer for spelling errors.
3347 Requires variables ISPELL-START and ISPELL-END to be defined in its
3349 Returns the sum SHIFT due to changes in word replacements."
3350 ;;(declare special ispell-start ispell-end)
3351 (let (poss accept-list
)
3352 (if (not (numberp shift
))
3354 ;; send string to spell process and get input.
3355 (ispell-send-string string
)
3357 (ispell-accept-output)
3358 ;; Last item of output contains a blank line.
3359 (not (string= "" (car ispell-filter
)))))
3360 ;; parse all inputs from the stream one word at a time.
3361 ;; Place in FIFO order and remove the blank item.
3362 (setq ispell-filter
(nreverse (cdr ispell-filter
)))
3363 (while (and (not ispell-quit
) ispell-filter
)
3364 ;; get next word, accounting for accepted words and start shifts
3365 (setq poss
(ispell-parse-output (car ispell-filter
)
3367 (if (and poss
(listp poss
)) ; spelling error occurred.
3368 ;; Whenever we have misspellings, we can change
3369 ;; the buffer. Keep boundaries as markers.
3370 ;; Markers can move with highlighting! This destroys
3371 ;; end of region markers line-end and ispell-region-end
3373 (copy-marker (+ ispell-start ispell-offset
(car (cdr poss
)))))
3374 (word-len (length (car poss
)))
3375 (line-end (copy-marker ispell-end
))
3376 (line-start (copy-marker ispell-start
))
3377 recheck-region replace
)
3378 (goto-char word-start
)
3379 ;; Adjust the horizontal scroll & point
3380 (ispell-horiz-scroll)
3381 (goto-char (+ word-len word-start
))
3382 (ispell-horiz-scroll)
3383 (goto-char word-start
)
3384 (ispell-horiz-scroll)
3386 ;; Alignment cannot be tracked and this error will occur when
3387 ;; `query-replace' makes multiple corrections on the starting line.
3388 (or (ispell-looking-at (car poss
))
3389 ;; This error occurs due to filter pipe problems
3390 (let* ((ispell-pipe-word (car poss
))
3391 (actual-point (marker-position word-start
))
3392 (actual-line (line-number-at-pos actual-point
))
3393 (actual-column (save-excursion (goto-char actual-point
) (current-column))))
3394 (ispell-print-if-debug
3396 "ispell-process-line: Ispell misalignment error:\n"
3397 (format " [Word from ispell pipe]: [%s], actual (point,line,column): (%s,%s,%s)\n"
3398 ispell-pipe-word actual-point actual-line actual-column
)))
3399 (error (concat "Ispell misalignment: word "
3400 "`%s' point %d; probably incompatible versions")
3401 ispell-pipe-word actual-point
)))
3402 ;; ispell-cmd-loop can go recursive & change buffer
3403 (if ispell-keep-choices-win
3404 (setq replace
(ispell-command-loop
3405 (car (cdr (cdr poss
)))
3406 (car (cdr (cdr (cdr poss
))))
3407 (car poss
) (marker-position word-start
)
3408 (+ word-len
(marker-position word-start
))))
3409 (save-window-excursion
3410 (setq replace
(ispell-command-loop
3411 (car (cdr (cdr poss
)))
3412 (car (cdr (cdr (cdr poss
))))
3413 (car poss
) (marker-position word-start
)
3414 (+ word-len
(marker-position word-start
))))))
3416 (goto-char word-start
)
3417 ;; Recheck when query replace edit changes misspelled word.
3418 ;; Error in tex mode when a potential math mode change exists.
3419 (if (and replace
(listp replace
) (= 2 (length replace
)))
3420 (if (and (eq ispell-parser
'tex
)
3421 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3422 (regexp-quote string
)))
3424 "Don't start query replace on a line with math characters"
3426 (set-marker line-end
(point))
3427 (setq ispell-filter nil
3430 ;; insert correction if needed
3433 (equal 0 replace
)) ; ACCEPT/INSERT
3434 (if (equal 0 replace
) ; BUFFER-LOCAL DICT ADD
3435 (ispell-add-per-file-word-list (car poss
)))
3436 ;; do not recheck accepted word on this line
3437 (setq accept-list
(cons (car poss
) accept-list
)))
3438 (t ; replacement word selected or entered
3439 (delete-region (point) (+ word-len
(point)))
3440 (if (not (listp replace
))
3442 (insert replace
) ; insert dictionary word
3443 (ispell-send-replacement (car poss
) replace
)
3444 (setq accept-list
(cons replace accept-list
)))
3445 (let ((replace-word (car replace
)))
3446 ;; Recheck hand entered replacement word
3447 (insert replace-word
)
3448 (ispell-send-replacement (car poss
) replace-word
)
3449 (if (car (cdr replace
))
3450 (save-window-excursion
3451 (delete-other-windows) ; to correctly show help.
3452 ;; Assume case-replace &
3453 ;; case-fold-search correct?
3454 (query-replace (car poss
) (car replace
) t
)))
3455 (goto-char word-start
)
3456 ;; do not recheck if already accepted
3457 (if (member replace-word accept-list
)
3458 (setq accept-list
(cons replace-word accept-list
)
3459 replace replace-word
)
3460 (let ((region-end (copy-marker ispell-region-end
)))
3461 (setq recheck-region ispell-filter
3462 ispell-filter nil
; save filter
3463 shift
0 ; already accounted
3464 shift
(ispell-region
3466 (+ word-start
(length replace-word
))
3468 (if (null shift
) ; quitting check.
3470 (set-marker ispell-region-end region-end
)
3471 (set-marker region-end nil
)
3472 (setq ispell-filter recheck-region
3474 replace replace-word
)))))
3476 (setq shift
(+ shift
(- (length replace
) word-len
)))
3478 ;; Move line-start across word...
3479 ;; new shift function does this now...
3480 ;;(set-marker line-start (+ line-start
3481 ;; (- (length replace)
3482 ;; (length (car poss)))))
3484 (if (not ispell-quit
)
3485 ;; FIXME: remove redundancy with identical code above.
3486 (let (message-log-max)
3488 "Continuing spelling check using %s with %s dictionary..."
3489 (file-name-nondirectory ispell-program-name
)
3490 (or ispell-current-dictionary
"default"))))
3492 (setq ispell-start
(marker-position line-start
)
3493 ispell-end
(marker-position line-end
))
3494 ;; Adjust markers when end of region lost from highlighting.
3495 (if (and (not recheck-region
)
3496 (< ispell-end
(+ word-start word-len
)))
3497 (setq ispell-end
(+ word-start word-len
)))
3498 (if (= word-start ispell-region-end
)
3499 (set-marker ispell-region-end
(+ word-start word-len
)))
3500 ;; going out of scope - unneeded
3501 (set-marker line-start nil
)
3502 (set-marker word-start nil
)
3503 (set-marker line-end nil
)))
3504 ;; finished with misspelling!
3505 (setq ispell-filter
(cdr ispell-filter
)))
3510 (defun ispell-comments-and-strings ()
3511 "Check comments and strings in the current buffer for spelling errors."
3513 (goto-char (point-min))
3517 (setq state
(parse-partial-sexp (point) (point-max)
3518 nil nil state
'syntax-table
))
3519 (if (or (nth 3 state
) (nth 4 state
))
3520 (let ((start (point)))
3521 (setq state
(parse-partial-sexp start
(point-max)
3522 nil nil state
'syntax-table
))
3523 (if (or (nth 3 state
) (nth 4 state
))
3524 (error "Unterminated string or comment"))
3526 (setq done
(not (ispell-region start
(point))))))))))
3530 (defun ispell-buffer ()
3531 "Check the current buffer for spelling errors interactively."
3533 (ispell-region (point-min) (point-max)))
3536 (defun ispell-buffer-with-debug (&optional append
)
3537 "`ispell-buffer' with some output sent to `ispell-debug-buffer' buffer.
3538 Use APPEND to append the info to previous buffer if exists."
3540 (let ((ispell-debug-buffer (ispell-create-debug-buffer append
)))
3544 (defun ispell-continue ()
3545 "Continue a halted spelling session beginning with the current word."
3547 (if (not (marker-position ispell-region-end
))
3548 (message "No session to continue. Use 'X' command when checking!")
3549 (if (not (equal (marker-buffer ispell-region-end
) (current-buffer)))
3550 (message "Must continue ispell from buffer %s"
3551 (buffer-name (marker-buffer ispell-region-end
)))
3553 ;; find beginning of current word:
3554 (car (cdr (ispell-get-word t
)))
3555 (marker-position ispell-region-end
)))))
3558 ;;; Horizontal scrolling
3559 (defun ispell-horiz-scroll ()
3560 "Place point within the horizontal visibility of its window area."
3561 (if truncate-lines
; display truncating lines?
3562 ;; See if display needs to be scrolled.
3563 (let ((column (- (current-column) (max (window-hscroll) 1))))
3564 (if (and (< column
0) (> (window-hscroll) 0))
3565 (scroll-right (max (- column
) 10))
3566 (if (>= column
(- (window-width) 2))
3567 (scroll-left (max (- column
(window-width) -
3) 10)))))))
3570 ;;; Interactive word completion.
3571 ;; Forces "previous-word" processing. Do we want to make this selectable?
3574 (defun ispell-complete-word (&optional interior-frag
)
3575 "Try to complete the word before or under point (see `lookup-words').
3576 If optional INTERIOR-FRAG is non-nil then the word may be a character
3577 sequence inside of a word.
3579 Standard ispell choices are then available."
3580 ;; FIXME: completion-at-point-function.
3582 (let ((cursor-location (point))
3583 (case-fold-search-val case-fold-search
)
3584 (word (ispell-get-word nil
"\\*")) ; force "previous-word" processing.
3585 start end possibilities replacement
)
3586 (setq start
(car (cdr word
))
3587 end
(car (cdr (cdr word
)))
3590 (or (string= word
"") ; Will give you every word
3591 (lookup-words (concat (and interior-frag
"*") word
3592 (if (or interior-frag
(null ispell-look-p
))
3594 (or ispell-complete-word-dict
3595 ispell-alternate-dictionary
))))
3596 (cond ((eq possibilities t
)
3597 (message "No word to complete"))
3598 ((null possibilities
)
3599 (message "No match for \"%s\"" word
))
3600 (t ; There is a modification...
3601 (setq case-fold-search nil
) ; Try and respect case of word.
3603 ((string-equal (upcase word
) word
)
3604 (setq possibilities
(mapcar 'upcase possibilities
)))
3605 ((eq (upcase (aref word
0)) (aref word
0))
3606 (setq possibilities
(mapcar (function
3608 (if (eq (aref word
0) (aref pos
0))
3612 (setq case-fold-search case-fold-search-val
)
3613 (save-window-excursion
3615 (ispell-command-loop possibilities nil word start end
)))
3617 ((equal 0 replacement
) ; BUFFER-LOCAL ADDITION
3618 (ispell-add-per-file-word-list word
))
3619 (replacement ; REPLACEMENT WORD
3620 (delete-region start end
)
3621 (setq word
(if (atom replacement
) replacement
(car replacement
))
3622 cursor-location
(+ (- (length word
) (- end start
))
3625 (if (not (atom replacement
)) ; recheck spelling of replacement.
3627 (goto-char cursor-location
)
3628 (ispell-word nil t
)))))
3629 (if (get-buffer ispell-choices-buffer
)
3630 (kill-buffer ispell-choices-buffer
))))
3631 (ispell-pdict-save ispell-silently-savep
)
3632 (goto-char cursor-location
)))
3636 (defun ispell-complete-word-interior-frag ()
3637 "Completes word matching character sequence inside a word."
3639 (ispell-complete-word t
))
3644 "Interactively check a region or buffer for spelling errors.
3645 If `transient-mark-mode' is on, and a region is active, spell-check
3646 that region. Otherwise spell-check the buffer.
3648 Ispell dictionaries are not distributed with Emacs. If you are
3649 looking for a dictionary, please see the distribution of the GNU ispell
3650 program, or do an Internet search; there are various dictionaries
3651 available on the net."
3653 (if (and (boundp 'transient-mark-mode
) transient-mark-mode
3654 (boundp 'mark-active
) mark-active
)
3655 (ispell-region (region-beginning) (region-end))
3659 ;;; **********************************************************************
3660 ;;; Ispell Minor Mode
3661 ;;; **********************************************************************
3663 (defvar ispell-minor-keymap
3664 (let ((map (make-sparse-keymap)))
3665 (define-key map
" " 'ispell-minor-check
)
3666 (define-key map
"\r" 'ispell-minor-check
)
3668 "Keymap used for Ispell minor mode.")
3671 (define-minor-mode ispell-minor-mode
3672 "Toggle last-word spell checking (Ispell minor mode).
3673 With a prefix argument ARG, enable Ispell minor mode if ARG is
3674 positive, and disable it otherwise. If called from Lisp, enable
3675 the mode if ARG is omitted or nil.
3677 Ispell minor mode is a buffer-local minor mode. When enabled,
3678 typing SPC or RET warns you if the previous word is incorrectly
3681 All the buffer-local variables and dictionaries are ignored. To
3682 read them into the running ispell process, type \\[ispell-word]
3685 For spell-checking \"on the fly\", not just after typing SPC or
3686 RET, use `flyspell-mode'."
3687 nil
" Spell" ispell-minor-keymap
)
3689 (defun ispell-minor-check ()
3690 "Check previous word, then continue with the normal binding of this key.
3691 Don't check previous word when character before point is a space or newline.
3692 Don't read buffer-local settings or word lists."
3694 (let ((ispell-minor-mode nil
)
3695 (ispell-check-only t
)
3696 (last-char (char-after (1- (point)))))
3697 (command-execute (key-binding (this-command-keys)))
3698 (if (not (or (eq last-char ?\
) (eq last-char ?
\n)
3699 (and ispell-skip-html
(eq last-char ?
>))
3700 (and ispell-skip-html
(eq last-char ?\
;))))
3701 (ispell-word nil t
))))
3704 ;;; **********************************************************************
3706 ;;; **********************************************************************
3708 (defvar ispell-message-text-end
3709 (mapconcat (function identity
)
3711 ;; Don't spell check signatures
3713 ;; Matches PostScript files.
3714 ;;"^%!PS-Adobe-[123].0"
3715 ;; Matches uuencoded text
3716 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
3717 ;; Matches shell files (especially auto-decoding)
3719 ;; Matches context difference listing
3720 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3721 ;; Matches unidiff difference listing
3722 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@"
3723 ;; Matches reporter.el bug report
3724 "^current state:\n==============\n"
3725 ;; Matches commonly used "cut" boundaries
3726 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
3728 "Text beyond which `ispell-message' will not spell-check.
3729 If it is a string, limit is the first occurrence of that regular expression.
3730 Otherwise, it must be a function which is called to get the limit.")
3731 (put 'ispell-message-text-end
'risky-local-variable t
)
3734 (defun ispell-mime-multipartp (&optional limit
)
3735 "Return multipart message start boundary or nil if none."
3736 ;; caller must ensure `case-fold-search' is set to `t'
3739 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3742 (if (looking-at "\"")
3745 (setq start
(point))
3746 (while (not (looking-at "\""))
3748 (setq boundary
(buffer-substring-no-properties start
(point))))
3749 (let ((start (point)))
3750 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3752 (setq boundary
(buffer-substring-no-properties start
(point)))))
3753 (if (< (length boundary
) 1)
3755 (concat "--" boundary
)))))
3758 (defun ispell-mime-skip-part (boundary)
3759 "Move point across header, or entire MIME part if message is encoded.
3760 All specified types except `7bit' `8bit' and `quoted-printable' are considered
3761 encoded and therefore skipped. See rfc 1521, 2183, ...
3762 If no boundary is given, then entire message is skipped.
3764 This starts one line ABOVE the MIME content messages, on the boundary marker,
3765 for operation with the generic region-skipping code.
3766 This places new MIME boundaries into variable `ispell-checking-message'."
3767 (forward-line) ; skip over boundary to headers
3768 (let ((save-case-fold-search case-fold-search
)
3771 (setq case-fold-search t
3772 ispell-skip-html nil
)
3774 (setq continuep nil
)
3775 (if (looking-at "Content-Type: *text/")
3777 (goto-char (match-end 0))
3778 (if (looking-at "html")
3779 (setq ispell-skip-html t
))
3782 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3784 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3785 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3786 (setq textp
(member (upcase match
)
3787 ;; only spell check the following encodings:
3788 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3790 (goto-char (match-end 0))
3791 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t
)
3793 ;; hierarchical boundary definition
3794 (if (looking-at "Content-Type: *multipart/")
3795 (let ((new-boundary (ispell-mime-multipartp)))
3796 (if (string-match new-boundary boundary
)
3798 ;; first pass redefine skip function to include new boundary
3799 ;;(re-search-backward boundary nil t)
3801 (setq ispell-checking-message
3803 (list new-boundary
'ispell-mime-skip-part new-boundary
)
3804 (if (eq t ispell-checking-message
) nil
3805 ispell-checking-message
))
3808 ;; Skip all MIME headers that don't affect spelling
3809 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3812 (goto-char (match-end 0))
3815 (setq case-fold-search save-case-fold-search
)
3818 ;; encoded message. Skip to boundary, or entire message.
3820 (goto-char (point-max))
3821 (re-search-forward boundary nil t
)
3827 (defun ispell-message ()
3828 "Check the spelling of a mail message or news post.
3829 Don't check spelling of message headers except the Subject field.
3830 Don't check included messages.
3832 To abort spell checking of a message region and send the message anyway,
3833 use the `x' command. (Any subsequent regions will be checked.)
3834 The `X' command aborts sending the message so that you can edit the buffer.
3836 To spell-check whenever a message is sent, include the appropriate lines
3838 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3839 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
3840 (add-hook 'mail-send-hook 'ispell-message)
3841 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3843 You can bind this to the key C-c i in GNUS or mail by adding to
3844 `news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
3845 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3848 (goto-char (point-min))
3849 (let* (boundary mimep
3850 (ispell-skip-region-alist-save ispell-skip-region-alist
)
3851 ;; Nil when message came from outside (eg calling Emacs as editor)
3852 ;; Non-nil marker of end of headers.
3855 (concat "^" (regexp-quote mail-header-separator
) "$") nil t
))
3856 (end-of-headers ; Start of body.
3858 (or internal-messagep
3859 (re-search-forward "^$" nil t
)
3861 (limit (copy-marker ; End of region we will spell check.
3863 ((not ispell-message-text-end
) (point-max))
3864 ((char-or-string-p ispell-message-text-end
)
3865 (if (re-search-forward ispell-message-text-end nil t
)
3868 (t (min (point-max) (funcall ispell-message-text-end
))))))
3869 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3870 (if (and (boundp 'mail-yank-prefix
) mail-yank-prefix
)
3871 (ispell-non-empty-string mail-yank-prefix
)
3873 (cite-regexp ;Prefix of quoted text
3875 ((functionp 'sc-cite-regexp
) ; sc 3.0
3876 (ispell-with-no-warnings
3877 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3878 (ispell-non-empty-string sc-reference-tag-string
))))
3879 ((boundp 'sc-cite-regexp
) ; sc 2.3
3880 (concat "\\(" sc-cite-regexp
"\\)" "\\|"
3881 (ispell-with-no-warnings
3882 (ispell-non-empty-string sc-reference-tag-string
))))
3883 ((or (equal major-mode
'news-reply-mode
) ;GNUS 4 & below
3884 (equal major-mode
'message-mode
)) ;GNUS 5
3885 (concat "In article <" "\\|"
3886 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
3887 (ispell-with-no-warnings message-cite-prefix-regexp
)
3890 ((equal major-mode
'mh-letter-mode
) ; mh mail message
3891 (concat "[^,;&+=\n]+ writes:" "\\|"
3892 (ispell-with-no-warnings
3893 (ispell-non-empty-string mh-ins-buf-prefix
))))
3894 ((not internal-messagep
) ; Assume nn sent us this message.
3895 (concat "In [a-zA-Z.]+ you write:" "\\|"
3896 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3898 ((boundp 'vm-included-text-prefix
) ; VM mail message
3899 (concat "[^,;&+=\n]+ writes:" "\\|"
3900 (ispell-non-empty-string vm-included-text-prefix
)))
3901 (t default-prefix
)))
3902 (ispell-skip-region-alist
3903 (cons (list (concat "^\\(" cite-regexp
"\\)")
3904 (function forward-line
))
3905 ispell-skip-region-alist
))
3906 (old-case-fold-search case-fold-search
)
3907 (dictionary-alist ispell-message-dictionary-alist
)
3908 (ispell-checking-message t
))
3910 ;; Select dictionary for message
3911 (or (local-variable-p 'ispell-local-dictionary
(current-buffer))
3912 (while dictionary-alist
3913 (goto-char (point-min))
3914 (if (re-search-forward (car (car dictionary-alist
))
3916 (setq ispell-local-dictionary
(cdr (car dictionary-alist
))
3917 dictionary-alist nil
)
3918 (setq dictionary-alist
(cdr dictionary-alist
)))))
3922 ;; Spell check any original Subject:
3923 (goto-char (point-min))
3924 (setq case-fold-search t
3925 mimep
(re-search-forward "MIME-Version:" end-of-headers t
))
3926 (goto-char (point-min))
3927 (if (re-search-forward "^Subject: *" end-of-headers t
)
3929 (goto-char (match-end 0))
3930 (if (and (not (looking-at ".*Re\\>"))
3931 (not (looking-at "\\[")))
3933 (setq case-fold-search old-case-fold-search
)
3934 (ispell-region (point)
3935 (progn ;Tab-initiated continuation lns.
3937 (while (looking-at "\n[ \t]")
3942 (goto-char (point-min))
3943 (setq boundary
(ispell-mime-multipartp end-of-headers
))))
3944 ;; Adjust message limit to MIME message if necessary.
3946 (re-search-forward (concat boundary
"--") nil t
)
3947 (re-search-backward boundary nil t
)
3948 (< (point) (marker-position limit
))
3949 (set-marker limit
(point)))
3950 (goto-char (point-min))
3951 ;; Select type or skip checking if this is a non-multipart message
3952 ;; Point moved to end of buffer if region is encoded.
3953 (when (and mimep
(not boundary
))
3954 (goto-char (point-min))
3955 (re-search-forward "Content-[^ \t]*:" end-of-headers t
)
3956 (forward-line -
1) ; following fn starts one line above
3957 (ispell-mime-skip-part nil
)
3958 ;; if message-text-end region, limit may be less than point.
3959 (if (> (point) limit
)
3960 (set-marker limit
(point))))
3961 (goto-char (max end-of-headers
(point)))
3963 (setq case-fold-search old-case-fold-search
)
3964 ;; Define MIME regions to skip.
3966 (setq ispell-checking-message
3967 (list (list boundary
'ispell-mime-skip-part boundary
))))
3968 (ispell-region (point) limit
))
3969 (set-marker end-of-headers nil
)
3970 (set-marker limit nil
)
3971 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3972 ispell-skip-html nil
3973 case-fold-search old-case-fold-search
)))))
3976 (defun ispell-non-empty-string (string)
3977 (if (or (not string
) (string-equal string
""))
3978 "\\'\\`" ; An unmatchable string if string is null.
3979 (regexp-quote string
)))
3982 ;;; **********************************************************************
3983 ;;; Buffer Local Functions
3984 ;;; **********************************************************************
3987 (defun ispell-accept-buffer-local-defs ()
3988 "Load all buffer-local information, restarting Ispell when necessary."
3989 (ispell-buffer-local-dict) ; May kill ispell-process.
3990 (ispell-buffer-local-words) ; Will initialize ispell-process.
3991 (ispell-buffer-local-parsing))
3994 (defun ispell-buffer-local-parsing ()
3995 "Place Ispell into parsing mode for this buffer.
3996 Overrides the default parsing mode.
3997 Includes LaTeX/Nroff modes and extended character mode."
3998 ;; (ispell-init-process) must already be called.
3999 (ispell-send-string "!\n") ; Put process in terse mode.
4000 ;; We assume all major modes with "tex-mode" in them should use latex parsing
4001 ;; When exclusively checking comments, set to raw text mode (nroff).
4002 (if (and (not (eq 'exclusive ispell-check-comments
))
4003 (or (and (eq ispell-parser
'use-mode-name
)
4004 (string-match "[Tt][Ee][Xx]-mode"
4005 (symbol-name major-mode
)))
4006 (eq ispell-parser
'tex
)))
4008 (ispell-send-string "+\n") ; set ispell mode to tex
4009 (if (not (eq ispell-parser
'tex
))
4010 (set (make-local-variable 'ispell-parser
) 'tex
)))
4011 (ispell-send-string "-\n")) ; set mode to normal (nroff)
4012 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
4013 (if (and ispell-skip-html
(not (eq ispell-skip-html t
)))
4014 (setq ispell-skip-html
4015 (not (null (string-match "sgml\\|html\\|xml"
4016 (downcase (symbol-name major-mode
)))))))
4017 ;; Set default extended character mode for given buffer, if any.
4018 (let ((extended-char-mode (ispell-get-extended-character-mode)))
4019 (if extended-char-mode
4020 (ispell-send-string (concat extended-char-mode
"\n"))))
4021 ;; Set buffer-local parsing mode and extended character mode, if specified.
4023 (goto-char (point-max))
4024 ;; Uses last occurrence of ispell-parsing-keyword
4025 (if (search-backward ispell-parsing-keyword nil t
)
4026 (let ((end (point-at-eol))
4028 (search-forward ispell-parsing-keyword
)
4029 (while (re-search-forward " *\\([^ \"]+\\)" end t
)
4030 ;; space separated definitions.
4031 (setq string
(downcase (match-string-no-properties 1)))
4032 (cond ((and (string-match "latex-mode" string
)
4033 (not (eq 'exclusive ispell-check-comments
)))
4034 (ispell-send-string "+\n~tex\n"))
4035 ((string-match "nroff-mode" string
)
4036 (ispell-send-string "-\n~nroff\n"))
4037 ((string-match "~" string
) ; Set extended character mode.
4038 (ispell-send-string (concat string
"\n")))
4039 (t (message "Invalid Ispell Parsing argument!")
4043 ;; Can kill the current ispell process
4045 (defun ispell-buffer-local-dict (&optional no-reload
)
4046 "Initializes local dictionary and local personal dictionary.
4047 If optional NO-RELOAD is non-nil, do not reload any dictionary.
4048 When a dictionary is defined in the buffer (see variable
4049 `ispell-dictionary-keyword'), it will override the local setting
4050 from \\[ispell-change-dictionary].
4051 Both should not be used to define a buffer-local dictionary."
4053 (goto-char (point-min))
4055 ;; Override the local variable definition.
4056 ;; Uses last occurrence of ispell-dictionary-keyword.
4057 (goto-char (point-max))
4058 (unless ispell-local-dictionary-overridden
4059 (if (search-backward ispell-dictionary-keyword nil t
)
4061 (search-forward ispell-dictionary-keyword
)
4062 (setq end
(point-at-eol))
4063 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
4064 (setq ispell-local-dictionary
4065 (match-string-no-properties 1))))))
4066 (goto-char (point-max))
4067 (if (search-backward ispell-pdict-keyword nil t
)
4069 (search-forward ispell-pdict-keyword
)
4070 (setq end
(point-at-eol))
4071 (if (re-search-forward " *\\([^ \"]+\\)" end t
)
4072 (setq ispell-local-pdict
4073 (match-string-no-properties 1)))))))
4075 ;; Reload if new dictionary (maybe the personal one) defined.
4076 (ispell-internal-change-dictionary)))
4079 (defun ispell-buffer-local-words ()
4080 "Load the buffer-local dictionary in the current buffer."
4081 ;; If there's an existing ispell process that's wrong for this use,
4083 (if (and ispell-buffer-local-name
4084 (not (equal ispell-buffer-local-name
(buffer-name))))
4085 (ispell-kill-ispell t
))
4086 ;; Actually start a new ispell process, because we need
4087 ;; to send commands now to specify the local words to it.
4088 (ispell-init-process)
4089 (dolist (session-localword ispell-buffer-session-localwords
)
4090 (ispell-send-string (concat "@" session-localword
"\n")))
4091 (or ispell-buffer-local-name
4092 (if ispell-buffer-session-localwords
4093 (setq ispell-buffer-local-name
(buffer-name))))
4095 (goto-char (point-min))
4096 (while (search-forward ispell-words-keyword nil t
)
4097 (or ispell-buffer-local-name
4098 (setq ispell-buffer-local-name
(buffer-name)))
4099 (let ((end (point-at-eol))
4100 (ispell-casechars (ispell-get-casechars))
4102 ;; buffer-local words separated by a space, and can contain
4103 ;; any character other than a space. Not rigorous enough.
4104 (while (re-search-forward " *\\([^ ]+\\)" end t
)
4105 (setq string
(match-string-no-properties 1))
4106 ;; This can fail when string contains a word with invalid chars.
4107 ;; Error handling needs to be added between ispell and Emacs.
4108 (if (and (< 1 (length string
))
4109 (equal 0 (string-match ispell-casechars string
)))
4110 (ispell-send-string (concat "@" string
"\n"))))))))
4113 ;; Returns optionally adjusted region-end-point.
4115 ;; If comment-padright is defined, newcomment must be loaded.
4116 (declare-function comment-add
"newcomment" (arg))
4118 (defun ispell-add-per-file-word-list (word)
4119 "Add WORD to the per-file word list."
4120 (or ispell-buffer-local-name
4121 (setq ispell-buffer-local-name
(buffer-name)))
4123 (goto-char (point-min))
4124 (let (line-okay search done found
)
4126 (let ((case-fold-search nil
))
4127 (setq search
(search-forward ispell-words-keyword nil
'move
)
4128 found
(or found search
)
4129 line-okay
(< (+ (length word
) 1 ; 1 for space after word..
4130 (progn (end-of-line) (current-column)))
4132 (if (or (and search line-okay
)
4139 (unless found
(newline))
4140 (insert (if comment-start
4142 (if (fboundp 'comment-padright
)
4143 ;; Try and use the proper comment marker,
4144 ;; e.g. ";;" rather than ";".
4145 (comment-padright comment-start
4150 ispell-words-keyword
)
4151 (if (and comment-end
(> (length comment-end
) 0))
4154 (insert comment-end
)))))
4155 (insert (concat " " word
))))))))
4157 (add-to-list 'debug-ignored-errors
"^No word found to check!$")
4162 ;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
4164 ;; Local Variable options:
4165 ;; mode: name(-mode)
4167 ;; local-variable: value
4169 ;; The following sets the buffer local dictionary to `american' English
4170 ;; and spell checks only comments.
4174 ;; comment-column: 40
4175 ;; ispell-check-comments: exclusive
4176 ;; ispell-local-dictionary: "american"
4180 ;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
4182 ;; The following places this file in nroff parsing and extended char modes.
4183 ;; Local IspellParsing: nroff-mode ~nroff
4184 ;; Change IspellPersDict to IspellPersDict: to enable the following line.
4185 ;; Local IspellPersDict ~/.ispell_lisp
4186 ;; The following were automatically generated by ispell using the 'A' command:
4187 ; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
4188 ; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
4189 ; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
4190 ; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
4191 ; LocalWords: minipage pers dict unhighlight buf grep sync prev inc
4192 ; LocalWords: fn oldot NB AIX msg init read's bufs pt cmd Quinlan eg
4193 ; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict
4194 ; LocalWords: lns XEmacs HTML casechars Multibyte
4196 ;;; ispell.el ends here