ispell.el: Fix ispell personal dictionary name expansion.
[bpt/emacs.git] / lisp / textmodes / ispell.el
CommitLineData
e8af40ee 1;;; ispell.el --- interface to International Ispell Versions 3.1 and 3.2
be010748 2
acaf905b 3;; Copyright (C) 1994-1995, 1997-2012 Free Software Foundation, Inc.
be010748 4
e8af40ee
PJ
5;; Author: Ken Stevens <k.stevens@ieee.org>
6;; Maintainer: Ken Stevens <k.stevens@ieee.org>
4d170362
SM
7;; Stevens Mod Date: Mon Jan 7 12:32:44 PST 2003
8;; Stevens Revision: 3.6
9050446c 9;; Status : Release with 3.1.12+ and 3.2.0+ ispell.
f5136913
RS
10;; Bug Reports : ispell-el-bugs@itcorp.com
11;; Web Site : http://kdstevens.com/~stevens/ispell-page.html
32395297 12;; Keywords: unix wp
be010748 13
b578f267
EN
14;; This file is part of GNU Emacs.
15
1fecc8fe 16;; GNU Emacs is free software: you can redistribute it and/or modify
b578f267 17;; it under the terms of the GNU General Public License as published by
1fecc8fe
GM
18;; the Free Software Foundation, either version 3 of the License, or
19;; (at your option) any later version.
b578f267
EN
20
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.
25
26;; You should have received a copy of the GNU General Public License
1fecc8fe 27;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
b578f267
EN
28
29;; Note: version numbers and time stamp are not updated
f753f75d 30;; when this file is edited for release with GNU Emacs.
be010748 31
007852e0 32;;; Commentary:
007852e0 33
b578f267 34;; INSTRUCTIONS
f5136913 35
6fdf40f3
KH
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
b578f267 40;; themselves.
6fdf40f3 41;; You particularly may want to change the default dictionary for your
b578f267 42;; country and language.
6fdf40f3
KH
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
a6e7a34b
RS
45;; file. Use the variable `ispell-local-dictionary-alist' to specify
46;; your own dictionaries.
f5136913 47
b578f267 48;; Depending on the mail system you use, you may want to include these:
b578f267
EN
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)
f5136913 52
6fdf40f3 53;; Ispell has a TeX parser and a nroff parser (the default).
b578f267
EN
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.
f5136913
RS
57
58
b578f267 59;; TABLE OF CONTENTS
f5136913 60
b578f267
EN
61;; ispell-word
62;; ispell-region
63;; ispell-buffer
64;; ispell-message
bc7d6816 65;; ispell-comments-and-strings
b578f267
EN
66;; ispell-continue
67;; ispell-complete-word
68;; ispell-complete-word-interior-frag
69;; ispell-change-dictionary
70;; ispell-kill-ispell
71;; ispell-pdict-save
f5136913
RS
72;; ispell-skip-region-alist
73
b578f267
EN
74;; Commands in ispell-region:
75;; Character replacement: Replace word with choice. May query-replace.
f5136913
RS
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
f753f75d 92;; `C-z': suspend Emacs or iconify frame
f5136913 93
b578f267
EN
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:
f5136913 102
b578f267
EN
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
f5136913
RS
109
110;; Region skipping:
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.
115
b578f267 116;; BUGS:
9050446c
GM
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
f753f75d
SM
120;; evil "misalignment error" in some versions of MULE Emacs.
121;; On some versions of Emacs, growing the minibuffer fails.
6fdf40f3 122;; see `ispell-help-in-bufferp'.
9050446c
GM
123;; Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
124;; can cause misalignment errors.
6fdf40f3
KH
125
126;; HISTORY
127
128;; Modifications made in latest versions:
129
4d170362
SM
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.
138
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)
147
fea6948a
GM
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.
f753f75d 156;; one arg always for XEmacs sleep-for (gunnar Evermann)
8eba343c
EZ
157;; support for synchronous processes (Eli Zaretskii)
158
9050446c
GM
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>
168;; fonts.
169
6fdf40f3
KH
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.
176
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.
9050446c 193;; Improved skipping support for SGML.
6fdf40f3
KH
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.
007852e0 197
e26a7bc0 198;;; Compatibility code for XEmacs and (not too) older emacsen:
0aef89e7 199
e26a7bc0 200(eval-and-compile ;; Protect against declare-function undefined in XEmacs
034dc2a3
AM
201 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
202
049cb685 203(declare-function ispell-check-minver "ispell" (v1 v2))
531b1264
GM
204(declare-function ispell-looking-back "ispell"
205 (regexp &optional limit &rest ignored))
049cb685 206
0aef89e7
AM
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.
2188975f
JB
211Both must be in [0-9]+.[0-9]+... format. This is a fallback
212compatibility function in case `version<=' is not available."
0aef89e7
AM
213 (let ((pending t)
214 (return t)
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.
219 (while pending
220 (let (ver mver)
221 (if (string-match "[0-9]+" version start-ver)
222 (setq start-ver (match-end 0)
5abf1556 223 ver (string-to-number (match-string 0 version))))
0aef89e7
AM
224 (if (string-match "[0-9]+" minver start-mver)
225 (setq start-mver (match-end 0)
5abf1556 226 mver (string-to-number (match-string 0 minver))))
0aef89e7
AM
227
228 (if (or ver mver)
229 (progn
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.
234 (if (> ver mver)
235 (setq pending nil)
236 (if (< ver mver)
237 (setq pending nil
238 return nil))))
239 (setq pending nil))))
240 return)))
b9431ae0 241
e26a7bc0
AM
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.
247Like `looking-at' except matches before point, and is slower.
248LIMIT if non-nil speeds up the search by specifying a minimum
249starting position, to avoid checking matches that would start
250before LIMIT.
251
252This is a stripped down compatibility function for use when
253full featured `looking-back' function is missing."
254 (save-excursion
255 (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t))))
256
6e8a1786
AM
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))
85c8c5b6 260
007852e0
RS
261;;; Code:
262
66793230
JB
263(defvar mail-yank-prefix)
264
87a609d3 265(defgroup ispell nil
24b52f08 266 "User variables for Emacs ispell interface."
87a609d3 267 :group 'applications)
f2b7eb26 268
8eba343c
EZ
269(if (not (fboundp 'buffer-substring-no-properties))
270 (defun buffer-substring-no-properties (start end)
271 (buffer-substring start end)))
f5136913 272
4d170362 273(defalias 'check-ispell-version 'ispell-check-version)
8eba343c 274
f5136913
RS
275;;; **********************************************************************
276;;; The following variables should be set according to personal preference
277;;; and location of binaries:
278;;; **********************************************************************
279
280
6fdf40f3 281;;; ******* THIS FILE IS WRITTEN FOR ISPELL VERSION 3.1+
f5136913
RS
282
283(defcustom ispell-highlight-p 'block
fb7ada5f 284 "Highlight spelling errors when non-nil.
f5136913 285When set to `block', assumes a block cursor with TTY displays."
b9431ae0 286 :type '(choice (const block) (const :tag "off" nil) (const :tag "on" t))
f2b7eb26
RS
287 :group 'ispell)
288
1332f1a0 289(defcustom ispell-lazy-highlight (boundp 'lazy-highlight-cleanup)
fb7ada5f 290 "Controls the lazy-highlighting of spelling errors.
1332f1a0
JL
291When non-nil, all text in the buffer matching the current spelling
292error is highlighted lazily using isearch lazy highlighting (see
293`lazy-highlight-initial-delay' and `lazy-highlight-interval')."
294 :type 'boolean
295 :group 'lazy-highlight
296 :group 'ispell
297 :version "22.1")
298
299(defcustom ispell-highlight-face (if ispell-lazy-highlight 'isearch 'highlight)
37269466 300 "Face used for Ispell highlighting.
007852e0
RS
301This variable can be set by the user to whatever face they desire.
302It's most convenient if the cursor color and highlight color are
f2b7eb26
RS
303slightly different."
304 :type 'face
305 :group 'ispell)
007852e0 306
f2b7eb26 307(defcustom ispell-check-comments t
fb7ada5f 308 "Spelling of comments checked when non-nil.
f5136913
RS
309When set to `exclusive', ONLY comments are checked. (For code comments).
310Warning! Not checking comments, when a comment start is embedded in strings,
311may produce undesired results."
b9431ae0 312 :type '(choice (const exclusive) (const :tag "off" nil) (const :tag "on" t))
f2b7eb26 313 :group 'ispell)
5abf1556
SM
314;;;###autoload
315(put 'ispell-check-comments 'safe-local-variable
316 (lambda (a) (memq a '(nil t exclusive))))
007852e0 317
f2b7eb26 318(defcustom ispell-query-replace-choices nil
fb7ada5f 319 "Corrections made throughout region when non-nil.
f2b7eb26
RS
320Uses `query-replace' (\\[query-replace]) for corrections."
321 :type 'boolean
322 :group 'ispell)
007852e0 323
f2b7eb26 324(defcustom ispell-skip-tib nil
fb7ada5f 325 "Does not spell check `tib' bibliography references when non-nil.
4b03da72 326Skips any text between strings matching regular expressions
a9210a53 327`ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
007852e0 328
d9a8eb66
EZ
329TeX users beware: Any text between [. and .] will be skipped -- even if
330that's your whole buffer -- unless you set `ispell-skip-tib' to nil.
331That includes the [.5mm] type of number..."
f2b7eb26
RS
332 :type 'boolean
333 :group 'ispell)
007852e0
RS
334
335(defvar ispell-tib-ref-beginning "[[<]\\."
336 "Regexp matching the beginning of a Tib reference.")
337
338(defvar ispell-tib-ref-end "\\.[]>]"
339 "Regexp matching the end of a Tib reference.")
340
f2b7eb26 341(defcustom ispell-keep-choices-win t
fb7ada5f 342 "If non-nil, keep the `*Choices*' window for the entire spelling session.
f2b7eb26
RS
343This minimizes redisplay thrashing."
344 :type 'boolean
345 :group 'ispell)
007852e0 346
e34850d1 347(defcustom ispell-choices-win-default-height 2
fb7ada5f 348 "The default size of the `*Choices*' window, including the mode line.
e34850d1 349Must be greater than 1."
f2b7eb26
RS
350 :type 'integer
351 :group 'ispell)
007852e0 352
55b958f0 353(defcustom ispell-program-name
60c4db3a
SM
354 (or (executable-find "aspell")
355 (executable-find "ispell")
356 (executable-find "hunspell")
55b958f0 357 "ispell")
f2b7eb26
RS
358 "Program invoked by \\[ispell-word] and \\[ispell-region] commands."
359 :type 'string
53fc914f
AM
360 :set (lambda (symbol value)
361 (set-default symbol value)
362 (if (featurep 'ispell)
363 (ispell-set-spellchecker-params)))
f2b7eb26 364 :group 'ispell)
007852e0 365
f2b7eb26 366(defcustom ispell-alternate-dictionary
fd5539c6
AM
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")
2b2eabed 373 "/usr/share/lib/dict/words")
fd5539c6 374 ((file-readable-p "/sys/dict") "/sys/dict"))
fb7ada5f 375 "Alternate plain word-list dictionary for spelling help."
71c62b6b 376 :type '(choice file (const :tag "None" nil))
f2b7eb26 377 :group 'ispell)
007852e0 378
fd5539c6 379(defcustom ispell-complete-word-dict nil
fb7ada5f 380 "Plain word-list dictionary used for word completion if
fd5539c6 381different from `ispell-alternate-dictionary'."
71c62b6b 382 :type '(choice file (const :tag "None" nil))
f2b7eb26 383 :group 'ispell)
007852e0 384
f5136913 385(defcustom ispell-message-dictionary-alist nil
fb7ada5f 386 "List used by `ispell-message' to select a new dictionary.
f5136913
RS
387It consists of pairs (REGEXP . DICTIONARY). If REGEXP is found
388in the message headers, `ispell-local-dictionary' will be set to
389DICTIONARY if `ispell-local-dictionary' is not buffer-local.
390E.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))
394 :group 'ispell)
007852e0 395
f5136913 396
4d170362 397(defcustom ispell-message-fcc-skip 50000
fb7ada5f 398 "Query before saving Fcc message copy if attachment larger than this value.
4d170362
SM
399Always stores Fcc copy of message when nil."
400 :type '(choice integer (const :tag "off" nil))
401 :group 'ispell)
402
403
6a314a29
EZ
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
407 ;; below).
408 (if (memq system-type '(windows-nt ms-dos)) "grep" "egrep")
f5136913
RS
409 "Name of the grep command for search processes."
410 :type 'string
411 :group 'ispell)
412
6a314a29
EZ
413(defcustom ispell-grep-options
414 (if (memq system-type '(windows-nt ms-dos)) "-Ei" "-i")
a9210a53 415 "String of options to use when running the program in `ispell-grep-command'.
007852e0 416Should probably be \"-i\" or \"-e\".
d1f18ec0 417Some machines (like the NeXT) don't support \"-i\"."
f5136913
RS
418 :type 'string
419 :group 'ispell)
007852e0 420
f5136913
RS
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")
425 (t "look"))
007852e0 426 "Name of the look command for search processes.
f5136913
RS
427This must be an absolute file name."
428 :type 'file
429 :group 'ispell)
007852e0 430
f2b7eb26 431(defcustom ispell-look-p (file-exists-p ispell-look-command)
fb7ada5f 432 "Non-nil means use `look' rather than `grep'.
f2b7eb26
RS
433Default is based on whether `look' seems to be available."
434 :type 'boolean
435 :group 'ispell)
007852e0 436
f2b7eb26 437(defcustom ispell-have-new-look nil
fb7ada5f 438 "Non-nil means use the `-r' option (regexp) when running `look'."
f2b7eb26
RS
439 :type 'boolean
440 :group 'ispell)
007852e0 441
f5136913
RS
442(defcustom ispell-look-options (if ispell-have-new-look "-dfr" "-df")
443 "String of command options for `ispell-look-command'."
444 :type 'string
445 :group 'ispell)
007852e0 446
f5136913 447(defcustom ispell-use-ptys-p nil
a9210a53 448 "When non-nil, Emacs uses ptys to communicate with Ispell.
f5136913
RS
449When nil, Emacs uses pipes."
450 :type 'boolean
451 :group 'ispell)
007852e0 452
f2b7eb26 453(defcustom ispell-following-word nil
fb7ada5f 454 "Non-nil means `ispell-word' checks the word around or after point.
f2b7eb26
RS
455Otherwise `ispell-word' checks the preceding word."
456 :type 'boolean
457 :group 'ispell)
007852e0 458
f2b7eb26 459(defcustom ispell-help-in-bufferp nil
fb7ada5f 460 "Non-nil means display interactive keymap help in a buffer.
b9431ae0 461The following values are supported:
f5136913
RS
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.
fea6948a 466 electric Pop up a new buffer and display a long help message there.
f5136913 467 User can browse and then exit the help mode."
b9431ae0 468 :type '(choice (const electric) (const :tag "off" nil) (const :tag "on" t))
f2b7eb26 469 :group 'ispell)
007852e0 470
f2b7eb26 471(defcustom ispell-quietly nil
fb7ada5f 472 "Non-nil means suppress messages in `ispell-word'."
f2b7eb26
RS
473 :type 'boolean
474 :group 'ispell)
007852e0 475
41d207e1 476(defcustom ispell-format-word-function (function upcase)
fb7ada5f 477 "Formatting function for displaying word being spell checked.
f2b7eb26
RS
478The function must take one string argument and return a string."
479 :type 'function
480 :group 'ispell)
41d207e1 481(defvaralias 'ispell-format-word 'ispell-format-word-function)
007852e0 482
f5136913
RS
483(defcustom ispell-use-framepop-p nil
484 "When non-nil ispell uses framepop to display choices in a dedicated frame.
485You can set this variable to dynamically use framepop if you are in a
486window system by evaluating the following on startup to set this variable:
487 (and window-system (condition-case () (require 'framepop) (error nil)))"
488 :type 'boolean
489 :group 'ispell)
490
d38e5dbe 491;;;###autoload
f2b7eb26 492(defcustom ispell-personal-dictionary nil
fb7ada5f 493 "File name of your personal spelling dictionary, or nil.
1525771e
AM
494If 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
496default dictionary and LANG the two letter language code."
6c80b133
RS
497 :type '(choice file
498 (const :tag "default" nil))
f2b7eb26 499 :group 'ispell)
007852e0 500
f2b7eb26 501(defcustom ispell-silently-savep nil
fb7ada5f 502 "When non-nil, save personal dictionary without asking for confirmation."
f2b7eb26
RS
503 :type 'boolean
504 :group 'ispell)
007852e0 505
a6e7a34b
RS
506(defvar ispell-local-dictionary-overridden nil
507 "Non-nil means the user has explicitly set this buffer's Ispell dictionary.")
a8097641 508(make-variable-buffer-local 'ispell-local-dictionary-overridden)
a6e7a34b 509
f5136913 510(defcustom ispell-local-dictionary nil
a6e7a34b
RS
511 "If non-nil, the dictionary to be used for Ispell commands in this buffer.
512The value must be a string dictionary name,
513or nil, which means use the global setting in `ispell-dictionary'.
514Dictionary names are defined in `ispell-local-dictionary-alist'
34995333 515and `ispell-dictionary-alist'.
f5136913 516
b9431ae0 517Setting `ispell-local-dictionary' to a value has the same effect as
f5136913
RS
518calling \\[ispell-change-dictionary] with that value. This variable
519is automatically set when defined in the file with either
a6e7a34b 520`ispell-dictionary-keyword' or the Local Variable syntax."
f5136913
RS
521 :type '(choice string
522 (const :tag "default" nil))
523 :group 'ispell)
5abf1556
SM
524;;;###autoload
525(put 'ispell-local-dictionary 'safe-local-variable 'string-or-null-p)
f5136913
RS
526
527(make-variable-buffer-local 'ispell-local-dictionary)
528
820c1f50
AM
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))
533 :group 'ispell)
534
f2b7eb26 535(defcustom ispell-extra-args nil
fb7ada5f 536 "If non-nil, a list of extra switches to pass to the Ispell program.
f5136913 537For example, (\"-W\" \"3\") to cause it to accept all 1-3 character
4b03da72 538words as correct. See also `ispell-dictionary-alist', which may be used
f2b7eb26
RS
539for language-specific arguments."
540 :type '(repeat string)
541 :group 'ispell)
4b03da72 542
6fdf40f3 543
8eba343c 544
fea6948a 545(defcustom ispell-skip-html 'use-mode-name
fb7ada5f 546 "Indicates whether ispell should skip spell checking of SGML markup.
8eba343c
EZ
547If t, always skip SGML markup; if nil, never skip; if non-t and non-nil,
548guess whether SGML markup should be skipped according to the name of the
549buffer's major mode."
550 :type '(choice (const :tag "always" t) (const :tag "never" nil)
551 (const :tag "use-mode-name" use-mode-name))
552 :group 'ispell)
553
4d170362
SM
554(make-variable-buffer-local 'ispell-skip-html)
555
8eba343c 556
6fdf40f3 557(defcustom ispell-local-dictionary-alist nil
fb7ada5f 558 "List of local or customized dictionary definitions.
a6e7a34b 559These can override the values in `ispell-dictionary-alist'.
4d170362 560
a6e7a34b
RS
561To make permanent changes to your dictionary definitions, you
562will need to make your changes in this variable, save, and then
24b52f08 563re-start Emacs."
6fdf40f3
KH
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"
572 (string :tag "Arg"))
573 (choice :tag "Extended character mode"
574 (const "~tex") (const "~plaintex")
575 (const "~nroff") (const "~list")
fea6948a 576 (const "~latin1") (const "~latin3")
6fdf40f3 577 (const :tag "default" nil))
72e4724b 578 (coding-system :tag "Coding System")))
6fdf40f3
KH
579 :group 'ispell)
580
581
f753f75d 582(defvar ispell-dictionary-base-alist
3851314b 583 '((nil ; default
a1e34e71
SM
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
3851314b
AM
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)
f753f75d
SM
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)
605 ("czech"
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)
609 ("dansk" ; Dansk.aff
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)
614 ("deutsch8"
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)
620 ("esperanto"
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)
624 ("esperanto-tex"
625 "[A-Za-z^\\]" "[^A-Za-z^\\]"
626 "[-'`\"]" t ("-C" "-d" "esperanto") "~tex" iso-8859-3)
aa311d6e
CY
627 ("finnish"
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)
f753f75d
SM
631 ("francais7"
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
30d7ac37
AM
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]"
f753f75d
SM
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]"
e2627d21
EZ
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))
f753f75d
SM
695 "Base value for `ispell-dictionary-alist'.")
696
697(defvar ispell-dictionary-alist nil
007852e0
RS
698 "An alist of dictionaries and their associated parameters.
699
700Each element of this list is also a list:
701
4b03da72 702\(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
f5136913 703 ISPELL-ARGS EXTENDED-CHARACTER-MODE CHARACTER-SET\)
007852e0 704
f5136913
RS
705DICTIONARY-NAME is a possible string value of variable `ispell-dictionary',
706nil means the default dictionary.
007852e0 707
b11a1b2e 708CASECHARS is a regular expression of valid characters that comprise a word.
007852e0
RS
709
710NOT-CASECHARS is the opposite regexp of CASECHARS.
711
f5136913
RS
712OTHERCHARS is a regexp of characters in the NOT-CASECHARS set but which can be
713used to construct words in some special way. If OTHERCHARS characters follow
714and precede characters from CASECHARS, they are parsed as part of a word,
fbbd6e46 715otherwise they become word-breaks. As an example in English, assume the
f5136913 716regular expression \"[']\" for OTHERCHARS. Then \"they're\" and
fbbd6e46
RS
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.
f5136913 719If you want OTHERCHARS to be empty, use the empty string.
007852e0
RS
720Hint: regexp syntax requires the hyphen to be declared first here.
721
ce6fb7e6 722CASECHARS, NOT-CASECHARS, and OTHERCHARS must be unibyte strings
bb1954bd 723containing bytes of CHARACTER-SET. In addition, if they contain
d9a8eb66 724non-ASCII bytes, the regular expression must be a single
bb1954bd
KH
725`character set' construct that doesn't specify a character range
726for non-ASCII bytes.
727
fbbd6e46
RS
728MANY-OTHERCHARS-P is non-nil when multiple OTHERCHARS are allowed in a word.
729Otherwise only a single OTHERCHARS character is allowed to be part of any
730single word.
007852e0
RS
731
732ISPELL-ARGS is a list of additional arguments passed to the ispell
733subprocess.
734
735EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
e29702dd 736have been configured in an Ispell affix file. (For example, umlauts
007852e0 737can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
a9210a53
RS
738in English. This has the same effect as the command-line `-T' option.
739The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
007852e0 740but the dictionary can control the extended character mode.
d1f18ec0 741Both defaults can be overruled in a buffer-local fashion. See
a9210a53 742`ispell-parsing-keyword' for details on this.
007852e0 743
d9a8eb66
EZ
744CHARACTER-SET used to encode text sent to the ispell subprocess
745when the language uses non-ASCII characters.
f5136913 746
d9a8eb66
EZ
747Note that with \"ispell\" as the speller, the CASECHARS and
748OTHERCHARS slots of the alist should contain the same character
749set as casechars and otherchars in the LANGUAGE.aff file \(e.g.,
425df10c 750english.aff\). aspell and hunspell don't have this limitation.")
b9431ae0 751
5abf1556
SM
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.
57bf8fd4 754(defvar ispell-encoding8-command nil
d9a8eb66
EZ
755 "Command line option prefix to select encoding if supported, nil otherwise.
756If setting the encoding is supported by spellchecker and is selectable from
757the command line, this variable will contain \"--encoding=\" for aspell
758and \"-i \" for hunspell, so the appropriate mime charset can be selected.
759That will be set in `ispell-check-version' for hunspell >= 1.1.6 and
760aspell >= 0.60.
761
762For aspell, non-nil also means to try to automatically find its dictionaries.
763
764Earlier aspell versions do not consistently support charset encoding. Handling
4ca8965c 765this would require some extra guessing in `ispell-aspell-find-dictionary'.")
8eba343c 766
57bf8fd4 767(defvar ispell-aspell-supports-utf8 nil
d9a8eb66 768 "Non-nil if aspell has consistent command line UTF-8 support. Obsolete.
57bf8fd4 769ispell.el and flyspell.el will use for this purpose the more generic
d1f18ec0 770variable `ispell-encoding8-command' for both aspell and hunspell. Is left
57bf8fd4
AM
771here just for backwards compatibility.")
772
773(make-obsolete-variable 'ispell-aspell-supports-utf8
774 'ispell-encoding8-command "23.1")
8eba343c 775
177eca34
AM
776(defvar ispell-emacs-alpha-regexp
777 (if (string-match "^[[:alpha:]]+$" "abcde")
778 "[[:alpha:]]"
779 nil)
780 "[[:alpha:]] if Emacs supports [:alpha:] regexp, nil
781otherwise (current XEmacs does not support it).")
8eba343c
EZ
782
783;;; **********************************************************************
784;;; The following are used by ispell, and should not be changed.
785;;; **********************************************************************
786
007852e0 787
9050446c 788
94eb3112
SM
789;; The version must be 3.1 or greater for this version of ispell.el
790;; There is an incompatibility between version 3.1.12 and lower versions.
9050446c
GM
791(defconst ispell-required-version '(3 1 12)
792 "Ispell versions with which this version of ispell.el is known to work.")
793(defvar ispell-offset -1
794 "Offset that maps protocol differences between ispell 3.1 versions.")
795
4d170362 796(defconst ispell-version "ispell.el 3.6 - 7-Jan-2003")
9050446c
GM
797
798
4d170362 799(defun ispell-check-version (&optional interactivep)
d9a8eb66 800 "Ensure that `ispell-program-name' is valid and has the correct version.
9050446c 801Returns version number if called interactively.
a60f1fcd 802Otherwise returns the library directory name, if that is defined."
9050446c
GM
803 ;; This is a little wasteful as we actually launch ispell twice: once
804 ;; to make sure it's the right version, and once for real. But people
805 ;; get confused by version mismatches *all* the time (and I've got the
806 ;; email to prove it) so I think this is worthwhile. And the -v[ersion]
807 ;; option is the only way I can think of to do this that works with
808 ;; all versions, since versions earlier than 3.0.09 didn't identify
809 ;; themselves on startup.
810 (interactive "p")
72f16325 811 (let ((default-directory (or (and (boundp 'temporary-file-directory)
4d170362
SM
812 temporary-file-directory)
813 default-directory))
0aef89e7 814 result status ispell-program-version)
0764ed37
AM
815
816 (with-temp-buffer
bc4c6633 817 (setq status (ispell-call-process
6ef3fdfb
EZ
818 ispell-program-name nil t nil
819 ;; aspell doesn't accept the -vv switch.
820 (let ((case-fold-search
821 (memq system-type '(ms-dos windows-nt)))
822 (speller
823 (file-name-nondirectory ispell-program-name)))
824 ;; Assume anything that isn't `aspell' is Ispell.
825 (if (string-match "\\`aspell" speller) "-v" "-vv"))))
9050446c
GM
826 (goto-char (point-min))
827 (if interactivep
4d170362 828 ;; report version information of ispell and ispell.el
9050446c
GM
829 (progn
830 (end-of-line)
831 (setq result (concat (buffer-substring-no-properties (point-min)
832 (point))
833 ", "
834 ispell-version))
5673af85 835 (message "%s" result))
a60f1fcd 836 ;; return library directory.
27ce741e 837 (if (re-search-forward "LIBDIR = \\\"\\([^ \t\n]*\\)\\\"" nil t)
72f16325 838 (setq result (match-string 1))))
9050446c
GM
839 (goto-char (point-min))
840 (if (not (memq status '(0 nil)))
841 (error "%s exited with %s %s" ispell-program-name
842 (if (stringp status) "signal" "code") status))
0aef89e7
AM
843
844 ;; Get relevant version strings. Only xx.yy.... format works well
845 (let (case-fold-search)
846 (setq ispell-program-version
847 (and (search-forward-regexp "\\([0-9]+\\.[0-9\\.]+\\)" nil t)
848 (match-string 1)))
849
850 ;; Make sure these variables are (re-)initialized to the default value
851 (setq ispell-really-aspell nil
852 ispell-aspell-supports-utf8 nil
57bf8fd4
AM
853 ispell-really-hunspell nil
854 ispell-encoding8-command nil)
0aef89e7
AM
855
856 (goto-char (point-min))
857 (or (setq ispell-really-aspell
858 (and (search-forward-regexp
d1dca201 859 "(but really Aspell \\([0-9]+\\.[0-9\\.-]+\\)?)" nil t)
0aef89e7
AM
860 (match-string 1)))
861 (setq ispell-really-hunspell
862 (and (search-forward-regexp
72f16325
SM
863 "(but really Hunspell \\([0-9]+\\.[0-9\\.-]+\\)?)"
864 nil t)
0aef89e7
AM
865 (match-string 1)))))
866
867 (let ((aspell-minver "0.50")
868 (aspell8-minver "0.60")
869 (ispell0-minver "3.1.0")
870 (ispell-minver "3.1.12")
871 (hunspell8-minver "1.1.6"))
872
873 (if (ispell-check-minver ispell0-minver ispell-program-version)
874 (or (ispell-check-minver ispell-minver ispell-program-version)
875 (setq ispell-offset 0))
876 (error "%s release %s or greater is required"
877 ispell-program-name
878 ispell-minver))
879
880 (cond
881 (ispell-really-aspell
882 (if (ispell-check-minver aspell-minver ispell-really-aspell)
883 (if (ispell-check-minver aspell8-minver ispell-really-aspell)
57bf8fd4
AM
884 (progn
885 (setq ispell-aspell-supports-utf8 t)
886 (setq ispell-encoding8-command "--encoding=")))
0aef89e7
AM
887 (setq ispell-really-aspell nil)))
888 (ispell-really-hunspell
57bf8fd4 889 (if (ispell-check-minver hunspell8-minver ispell-really-hunspell)
b39bb7e1 890 (setq ispell-encoding8-command "-i")
57bf8fd4 891 (setq ispell-really-hunspell nil))))))
9050446c
GM
892 result))
893
bc4c6633
RS
894(defun ispell-call-process (&rest args)
895 "Like `call-process' but defend against bad `default-directory'."
896 (let ((default-directory default-directory))
897 (unless (and (file-directory-p default-directory)
898 (file-readable-p default-directory))
899 (setq default-directory (expand-file-name "~/")))
900 (apply 'call-process args)))
901
902(defun ispell-call-process-region (&rest args)
903 "Like `call-process-region' but defend against bad `default-directory'."
904 (let ((default-directory default-directory))
905 (unless (and (file-directory-p default-directory)
906 (file-readable-p default-directory))
907 (setq default-directory (expand-file-name "~/")))
908 (apply 'call-process-region args)))
909
b159a1fd
AM
910(defun ispell-create-debug-buffer (&optional append)
911 "Create an ispell debug buffer for debugging output.
912Use APPEND to append the info to previous buffer if exists,
913otherwise is reset. Returns name of ispell debug buffer.
914See `ispell-buffer-with-debug' for an example of use."
915 (let ((ispell-debug-buffer (get-buffer-create "*ispell-debug*")))
916 (with-current-buffer ispell-debug-buffer
917 (if append
918 (insert
919 (format "-----------------------------------------------\n"))
920 (erase-buffer)))
921 ispell-debug-buffer))
922
923(defsubst ispell-print-if-debug (string)
924 "Print STRING to `ispell-debug-buffer' buffer if enabled."
925 (if (boundp 'ispell-debug-buffer)
926 (with-current-buffer ispell-debug-buffer
927 (insert string))))
9050446c 928
8eba343c 929
72f16325
SM
930;; The preparation of the menu bar menu must be autoloaded
931;; because otherwise this file gets autoloaded every time Emacs starts
932;; so that it can set up the menus and determine keyboard equivalents.
8eba343c 933
d38e5dbe 934;;;###autoload
b9431ae0 935(defvar ispell-menu-map nil "Key map for ispell menu.")
60c4db3a 936;; Redo menu when loading ispell to get dictionary modifications
cbef3295 937(setq ispell-menu-map nil)
007852e0 938
d38e5dbe 939;;;###autoload
f5136913
RS
940(defvar ispell-menu-xemacs nil
941 "Spelling menu for XEmacs.
942If nil when package is loaded, a standard menu will be set,
943and added as a submenu of the \"Edit\" menu.")
e29702dd 944
f753f75d
SM
945;; Break out XEmacs menu and split into several calls to avoid having
946;; long lines in loaddefs.el. Detect need off following constant.
12e53d2e 947
f5136913 948;;; Set up dictionary
d38e5dbe 949;;;###autoload
9050446c 950(defvar ispell-menu-map-needed
f5136913 951 ;; only needed when not version 18 and not XEmacs.
e29702dd 952 (and (not ispell-menu-map)
877d353a 953 (not (featurep 'xemacs))
9050446c
GM
954 'reload))
955
a60f1fcd 956(defvar ispell-library-directory (condition-case ()
4d170362 957 (ispell-check-version)
a60f1fcd
RS
958 (error nil))
959 "Directory where ispell dictionaries reside.")
9050446c 960
fea6948a
GM
961(defvar ispell-process nil
962 "The process object for Ispell.")
963
2a997209 964(defvar ispell-async-processp (and (fboundp 'delete-process)
fea6948a
GM
965 (fboundp 'process-send-string)
966 (fboundp 'accept-process-output)
967 ;;(fboundp 'start-process)
968 ;;(fboundp 'set-process-filter)
969 ;;(fboundp 'process-kill-without-query)
970 )
971 "Non-nil means that the OS supports asynchronous processes.")
e29702dd 972
e7cdb3e0
RS
973;; Make ispell.el work better with aspell.
974
caea54f8
SM
975(defvar ispell-aspell-dictionary-alist nil
976 "An alist of parsed aspell dicts and associated parameters.
977Internal use.")
999f7d65 978
e7cdb3e0
RS
979(defun ispell-find-aspell-dictionaries ()
980 "Find Aspell's dictionaries, and record in `ispell-dictionary-alist'."
034dc2a3 981 (unless (and ispell-really-aspell ispell-encoding8-command)
5a0c3f56 982 (error "This function only works with aspell >= 0.60"))
a8097641
RS
983 (let* ((dictionaries
984 (split-string
985 (with-temp-buffer
bc4c6633 986 (ispell-call-process ispell-program-name nil t nil "dicts")
a8097641
RS
987 (buffer-string))))
988 ;; Search for the named dictionaries.
989 (found
24b52f08 990 (delq nil
a8097641 991 (mapcar #'ispell-aspell-find-dictionary dictionaries))))
918555b8
EZ
992 ;; Ensure aspell's alias dictionary will override standard
993 ;; definitions.
994 (setq found (ispell-aspell-add-aliases found))
8cab9efc 995 ;; Merge into FOUND any elements from the standard ispell-dictionary-base-alist
24b52f08 996 ;; which have no element in FOUND at all.
8cab9efc 997 (dolist (dict ispell-dictionary-base-alist)
a8097641
RS
998 (unless (assoc (car dict) found)
999 (setq found (nconc found (list dict)))))
caea54f8 1000 (setq ispell-aspell-dictionary-alist found)
e7cdb3e0 1001 ;; Add a default entry
5abf1556
SM
1002 (let ((default-dict
1003 '(nil "[[:alpha:]]" "[^[:alpha:]]" "[']" nil ("-B") nil utf-8)))
caea54f8 1004 (push default-dict ispell-aspell-dictionary-alist))))
e7cdb3e0
RS
1005
1006(defvar ispell-aspell-data-dir nil
1007 "Data directory of Aspell.")
1008
1009(defvar ispell-aspell-dict-dir nil
1010 "Dictionary directory of Aspell.")
1011
1012(defun ispell-get-aspell-config-value (key)
1013 "Return value of Aspell configuration option KEY.
1014Assumes that value contains no whitespace."
1015 (with-temp-buffer
bc4c6633 1016 (ispell-call-process ispell-program-name nil t nil "config" key)
e7cdb3e0
RS
1017 (car (split-string (buffer-string)))))
1018
1019(defun ispell-aspell-find-dictionary (dict-name)
df987d70 1020 "For aspell dictionary DICT-NAME, return a list of parameters if an
d9a8eb66
EZ
1021associated data file is found or nil otherwise. List format is that
1022of `ispell-dictionary-base-alist' elements."
df987d70
AM
1023 ;; Make sure `ispell-aspell-data-dir' is defined
1024 (or ispell-aspell-data-dir
1025 (setq ispell-aspell-data-dir
1026 (ispell-get-aspell-config-value "data-dir")))
1027 ;; Try finding associated datafile
1028 (let* ((datafile1
1029 (concat ispell-aspell-data-dir "/"
1030 ;; Strip out variant, country code, etc.
1031 (and (string-match "^[[:alpha:]]+" dict-name)
1032 (match-string 0 dict-name)) ".dat"))
1033 (datafile2
1034 (concat ispell-aspell-data-dir "/"
1035 ;; Strip out anything but xx_YY.
1036 (and (string-match "^[[:alpha:]_]+" dict-name)
1037 (match-string 0 dict-name)) ".dat"))
e7cdb3e0 1038 (data-file
df987d70
AM
1039 (if (file-readable-p datafile1)
1040 datafile1
1041 (if (file-readable-p datafile2)
1042 datafile2)))
e7cdb3e0 1043 otherchars)
df987d70
AM
1044
1045 (if data-file
a8097641
RS
1046 (with-temp-buffer
1047 (insert-file-contents data-file)
1048 ;; There is zero or one line with special characters declarations.
1049 (when (search-forward-regexp "^special" nil t)
1050 (let ((specials (split-string
1051 (buffer-substring (point)
1052 (progn (end-of-line) (point))))))
1053 ;; The line looks like: special ' -** - -** . -** : -*-
1054 ;; -** means that this character
1055 ;; - doesn't appear at word start
1056 ;; * may appear in the middle of a word
1057 ;; * may appear at word end
1058 ;; `otherchars' is about the middle case.
1059 (while specials
1060 (when (eq (aref (cadr specials) 1) ?*)
1061 (push (car specials) otherchars))
1062 (setq specials (cddr specials)))))
1063 (list dict-name
1064 "[[:alpha:]]"
1065 "[^[:alpha:]]"
1066 (regexp-opt otherchars)
1067 t ; We can't tell, so set this to t
acf7984c 1068 (list "-d" dict-name)
a8097641
RS
1069 nil ; aspell doesn't support this
1070 ;; Here we specify the encoding to use while communicating with
1071 ;; aspell. This doesn't apply to command line arguments, so
1072 ;; just don't pass words to spellcheck as arguments...
df987d70 1073 'utf-8)))))
e7cdb3e0 1074
918555b8
EZ
1075(defun ispell-aspell-add-aliases (alist)
1076 "Find aspell's dictionary aliases and add them to dictionary ALIST.
1077Return the new dictionary alist."
5abf1556
SM
1078 (let ((aliases
1079 (file-expand-wildcards
e7cdb3e0
RS
1080 (concat (or ispell-aspell-dict-dir
1081 (setq ispell-aspell-dict-dir
1082 (ispell-get-aspell-config-value "dict-dir")))
1083 "/*.alias"))))
1084 (dolist (alias-file aliases)
1085 (with-temp-buffer
1086 (insert-file-contents alias-file)
1087 ;; Look for a line "add FOO.multi", extract FOO
1088 (when (search-forward-regexp "^add \\([^.]+\\)\\.multi" nil t)
d2c32364 1089 (let* ((aliasname (file-name-base alias-file))
918555b8 1090 (already-exists-p (assoc aliasname alist))
e7cdb3e0 1091 (realname (match-string 1))
918555b8 1092 (realdict (assoc realname alist)))
e7cdb3e0 1093 (when (and realdict (not already-exists-p))
918555b8
EZ
1094 (push (cons aliasname (cdr realdict)) alist))))))
1095 alist))
e7cdb3e0 1096
caea54f8
SM
1097;; Set params according to the selected spellchecker
1098
1099(defvar ispell-last-program-name nil
d1f18ec0 1100 "Last value of `ispell-program-name'. Internal use.")
caea54f8
SM
1101
1102(defvar ispell-initialize-spellchecker-hook nil
f753f75d
SM
1103 "Normal hook run on spellchecker initialization.
1104This hook is run when a spellchecker is used for the first
1105time, before `ispell-dictionary-alist' is set. It is intended for
1106sysadmins to override entries in `ispell-dictionary-base-alist'
1107by putting those overrides in `ispell-base-dicts-override-alist', which is
1108a dynamically scoped var with same format as `ispell-dictionary-alist'.
1109This alist will not override the auto-detected values (e.g. if a recent
1110aspell is used along with Emacs).")
caea54f8
SM
1111
1112(defun ispell-set-spellchecker-params ()
1113 "Initialize some spellchecker parameters when changed or first used."
1114 (unless (eq ispell-last-program-name ispell-program-name)
1115 (setq ispell-last-program-name ispell-program-name)
1116 (ispell-kill-ispell t)
1117 (if (and (condition-case ()
1118 (progn
1119 (setq ispell-library-directory (ispell-check-version))
1120 t)
1121 (error nil))
1122 ispell-really-aspell
57bf8fd4 1123 ispell-encoding8-command
177eca34 1124 ispell-emacs-alpha-regexp)
caea54f8
SM
1125 (unless ispell-aspell-dictionary-alist
1126 (ispell-find-aspell-dictionaries)))
1127
1128 ;; Substitute ispell-dictionary-alist with the list of dictionaries
1129 ;; corresponding to the given spellchecker. If a recent aspell, use
1130 ;; the list of really installed dictionaries and add to it elements
1131 ;; of the original list that are not present there. Allow distro info.
f753f75d 1132 (let ((found-dicts-alist
caea54f8 1133 (if (and ispell-really-aspell
57bf8fd4 1134 ispell-encoding8-command)
caea54f8
SM
1135 ispell-aspell-dictionary-alist
1136 nil))
1137 ispell-base-dicts-override-alist ; Override only base-dicts-alist
1138 all-dicts-alist)
1139
1140 (run-hooks 'ispell-initialize-spellchecker-hook)
1141
1142 ;; Add dicts to ``ispell-dictionary-alist'' unless already present.
1143 (dolist (dict (append found-dicts-alist
1144 ispell-base-dicts-override-alist
f753f75d 1145 ispell-dictionary-base-alist))
caea54f8
SM
1146 (unless (assoc (car dict) all-dicts-alist)
1147 (add-to-list 'all-dicts-alist dict)))
177eca34
AM
1148 (setq ispell-dictionary-alist all-dicts-alist))
1149
1150 ;; If Emacs flavor supports [:alpha:] use it for global dicts. If
1151 ;; spellchecker also supports UTF-8 via command-line option use it
865fe16f
CY
1152 ;; in communication. This does not affect definitions in your
1153 ;; init file.
177eca34
AM
1154 (if ispell-emacs-alpha-regexp
1155 (let (tmp-dicts-alist)
1156 (dolist (adict ispell-dictionary-alist)
1157 (add-to-list 'tmp-dicts-alist
1158 (list
1159 (nth 0 adict) ; dict name
1160 "[[:alpha:]]" ; casechars
1161 "[^[:alpha:]]" ; not-casechars
1162 (nth 3 adict) ; otherchars
1163 (nth 4 adict) ; many-otherchars-p
1164 (nth 5 adict) ; ispell-args
1165 (nth 6 adict) ; extended-character-mode
1166 (if ispell-encoding8-command
1167 'utf-8
1168 (nth 7 adict)))))
1169 (setq ispell-dictionary-alist tmp-dicts-alist)))))
caea54f8 1170
4d170362 1171(defun ispell-valid-dictionary-list ()
94eb3112 1172 "Return a list of valid dictionaries.
d9a8eb66 1173The variable `ispell-library-directory' defines their location."
caea54f8 1174 ;; Initialize variables and dictionaries alists for desired spellchecker.
f753f75d 1175 ;; Make sure ispell.el is loaded to avoid some autoload loops in XEmacs
caea54f8
SM
1176 ;; (and may be others)
1177 (if (featurep 'ispell)
1178 (ispell-set-spellchecker-params))
1179
a6e7a34b 1180 (let ((dicts (append ispell-local-dictionary-alist ispell-dictionary-alist))
4d170362 1181 (dict-list (cons "default" nil))
73b4d51a 1182 name dict-bname)
4d170362
SM
1183 (dolist (dict dicts)
1184 (setq name (car dict)
73b4d51a
AM
1185 dict-bname (or (car (cdr (member "-d" (nth 5 dict))))
1186 name))
4d170362
SM
1187 ;; Include if the dictionary is in the library, or dir not defined.
1188 (if (and
1189 name
e7cdb3e0
RS
1190 ;; For Aspell, we already know which dictionaries exist.
1191 (or ispell-really-aspell
73b4d51a
AM
1192 ;; Include all dictionaries if lib directory not known.
1193 ;; Same for Hunspell, where ispell-library-directory is nil.
e7cdb3e0 1194 (not ispell-library-directory)
4d170362 1195 (file-exists-p (concat ispell-library-directory
73b4d51a
AM
1196 "/" dict-bname ".hash"))
1197 (file-exists-p (concat ispell-library-directory
1198 "/" dict-bname ".has"))))
1199 (push name dict-list)))
4d170362
SM
1200 dict-list))
1201
60c4db3a 1202;; Define commands in menu in opposite order you want them to appear.
d38e5dbe 1203;;;###autoload
a60f1fcd 1204(if ispell-menu-map-needed
12e53d2e 1205 (progn
e7cdb3e0 1206 (setq ispell-menu-map (make-sparse-keymap "Spell"))
12e53d2e 1207 (define-key ispell-menu-map [ispell-change-dictionary]
8f43cbf3
DN
1208 `(menu-item ,(purecopy "Change Dictionary...") ispell-change-dictionary
1209 :help ,(purecopy "Supply explicit dictionary file name")))
12e53d2e 1210 (define-key ispell-menu-map [ispell-kill-ispell]
da00640a
AM
1211 `(menu-item ,(purecopy "Kill Process")
1212 (lambda () (interactive) (ispell-kill-ispell nil 'clear))
cdd0f857 1213 :enable (and (boundp 'ispell-process) ispell-process
8eba343c 1214 (eq (ispell-process-status) 'run))
8f43cbf3 1215 :help ,(purecopy "Terminate Ispell subprocess")))
12e53d2e 1216 (define-key ispell-menu-map [ispell-pdict-save]
8f43cbf3 1217 `(menu-item ,(purecopy "Save Dictionary")
fea6948a 1218 (lambda () (interactive) (ispell-pdict-save t t))
8f43cbf3 1219 :help ,(purecopy "Save personal dictionary")))
a9c6d330 1220 (define-key ispell-menu-map [ispell-customize]
8f43cbf3 1221 `(menu-item ,(purecopy "Customize...")
a9c6d330 1222 (lambda () (interactive) (customize-group 'ispell))
8f43cbf3 1223 :help ,(purecopy "Customize spell checking options")))
8eba343c
EZ
1224 (define-key ispell-menu-map [ispell-help]
1225 ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
8f43cbf3 1226 `(menu-item ,(purecopy "Help")
fea6948a 1227 (lambda () (interactive) (describe-function 'ispell-help))
8f43cbf3 1228 :help ,(purecopy "Show standard Ispell keybindings and commands")))
a9c6d330 1229 (define-key ispell-menu-map [flyspell-mode]
8f43cbf3 1230 `(menu-item ,(purecopy "Automatic spell checking (Flyspell)")
a9c6d330 1231 flyspell-mode
8f43cbf3 1232 :help ,(purecopy "Check spelling while you edit the text")
420adcc6 1233 :button (:toggle . (bound-and-true-p flyspell-mode))))
12e53d2e 1234 (define-key ispell-menu-map [ispell-complete-word]
8f43cbf3
DN
1235 `(menu-item ,(purecopy "Complete Word") ispell-complete-word
1236 :help ,(purecopy "Complete word at cursor using dictionary")))
12e53d2e 1237 (define-key ispell-menu-map [ispell-complete-word-interior-frag]
5abf1556
SM
1238 `(menu-item ,(purecopy "Complete Word Fragment")
1239 ispell-complete-word-interior-frag
8f43cbf3 1240 :help ,(purecopy "Complete word fragment at cursor")))))
12e53d2e 1241
d38e5dbe 1242;;;###autoload
a60f1fcd 1243(if ispell-menu-map-needed
12e53d2e
RS
1244 (progn
1245 (define-key ispell-menu-map [ispell-continue]
8f43cbf3 1246 `(menu-item ,(purecopy "Continue Spell-Checking") ispell-continue
8eba343c
EZ
1247 :enable (and (boundp 'ispell-region-end)
1248 (marker-position ispell-region-end)
1249 (equal (marker-buffer ispell-region-end)
fea6948a 1250 (current-buffer)))
8f43cbf3 1251 :help ,(purecopy "Continue spell checking last region")))
12e53d2e 1252 (define-key ispell-menu-map [ispell-word]
8f43cbf3
DN
1253 `(menu-item ,(purecopy "Spell-Check Word") ispell-word
1254 :help ,(purecopy "Spell-check word at cursor")))
f5136913 1255 (define-key ispell-menu-map [ispell-comments-and-strings]
5abf1556
SM
1256 `(menu-item ,(purecopy "Spell-Check Comments")
1257 ispell-comments-and-strings
8f43cbf3 1258 :help ,(purecopy "Spell-check only comments and strings")))))
60d48874 1259
d38e5dbe 1260;;;###autoload
a60f1fcd 1261(if ispell-menu-map-needed
60d48874 1262 (progn
8eba343c 1263 (define-key ispell-menu-map [ispell-region]
8f43cbf3 1264 `(menu-item ,(purecopy "Spell-Check Region") ispell-region
8eba343c 1265 :enable mark-active
8f43cbf3 1266 :help ,(purecopy "Spell-check text in marked region")))
12e53d2e 1267 (define-key ispell-menu-map [ispell-message]
8f43cbf3 1268 `(menu-item ,(purecopy "Spell-Check Message") ispell-message
17849b4a 1269 :visible (eq major-mode 'mail-mode)
8f43cbf3 1270 :help ,(purecopy "Skip headers and included message text")))
8eba343c 1271 (define-key ispell-menu-map [ispell-buffer]
8f43cbf3
DN
1272 `(menu-item ,(purecopy "Spell-Check Buffer") ispell-buffer
1273 :help ,(purecopy "Check spelling of selected buffer")))
fea6948a 1274 ;;(put 'ispell-region 'menu-enable 'mark-active)
e29702dd
KH
1275 (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
1276
9050446c 1277;;; XEmacs versions 19 & 20
877d353a 1278(if (and (featurep 'xemacs)
f5136913 1279 (featurep 'menubar)
4d170362 1280 ;;(null ispell-menu-xemacs)
f5136913 1281 (not (and (boundp 'infodock-version) infodock-version)))
4d170362
SM
1282 (let ((dicts (if (fboundp 'ispell-valid-dictionary-list)
1283 (reverse (ispell-valid-dictionary-list))))
e29702dd
KH
1284 (current-menubar (or current-menubar default-menubar))
1285 (menu
1286 '(["Help" (describe-function 'ispell-help) t]
1287 ;;["Help" (popup-menu ispell-help-list) t]
1288 ["Check Message" ispell-message t]
1289 ["Check Buffer" ispell-buffer t]
f5136913 1290 ["Check Comments" ispell-comments-and-strings t]
e29702dd
KH
1291 ["Check Word" ispell-word t]
1292 ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
1293 ["Continue Check" ispell-continue t]
1294 ["Complete Word Frag"ispell-complete-word-interior-frag t]
1295 ["Complete Word" ispell-complete-word t]
da00640a 1296 ["Kill Process" (ispell-kill-ispell nil 'clear) t]
4d170362
SM
1297 ["Customize..." (customize-group 'ispell) t]
1298 ;; flyspell-mode may not be bound...
1299 ;;["flyspell" flyspell-mode
1300 ;; :style toggle :selected flyspell-mode ]
e29702dd 1301 "-"
9050446c 1302 ["Save Personal Dict"(ispell-pdict-save t t) t]
4d170362
SM
1303 ["Change Dictionary" ispell-change-dictionary t])))
1304 (if (null dicts)
1305 (setq dicts (cons "default" nil)))
1306 (dolist (name dicts)
1307 (setq menu (append menu
1308 (list
1309 (vector
1310 (concat "Select " (capitalize name))
1311 (list 'ispell-change-dictionary name)
1312 t)))))
f5136913 1313 (setq ispell-menu-xemacs menu)
e29702dd
KH
1314 (if current-menubar
1315 (progn
4d170362
SM
1316 (if (car (find-menu-item current-menubar '("Cmds")))
1317 (progn
1318 ;; XEmacs 21.2
1319 (delete-menu-item '("Cmds" "Spell-Check"))
1320 (add-menu '("Cmds") "Spell-Check" ispell-menu-xemacs))
1321 ;; previous
1322 (delete-menu-item '("Edit" "Spell")) ; in case already defined
1323 (add-menu '("Edit") "Spell" ispell-menu-xemacs))))))
f5136913 1324
ec6918a8
DN
1325(defalias 'ispell-int-char
1326 ;; Allow incrementing characters as integers in XEmacs 20
1327 (if (and (featurep 'xemacs)
1328 (fboundp 'int-char))
1329 'int-char
1330 ;; Emacs and XEmacs 19 or earlier
1331 'identity))
007852e0
RS
1332
1333
1334;;; **********************************************************************
007852e0 1335
a6e7a34b 1336(defvar ispell-current-dictionary nil
f5136913 1337 "The name of the current dictionary, or nil for the default.
f5136913 1338This is passed to the ispell process using the `-d' switch and is
a6e7a34b
RS
1339used as key in `ispell-local-dictionary-alist' and `ispell-dictionary-alist'.")
1340
09b2eb5e
RS
1341(defvar ispell-current-personal-dictionary nil
1342 "The name of the current personal dictionary, or nil for the default.
1343This is passed to the ispell process using the `-p' switch.")
1344
ef128a91 1345(defun ispell-decode-string (str)
9050446c
GM
1346 "Decodes multibyte character strings.
1347Protects against bogus binding of `enable-multibyte-characters' in XEmacs."
f753f75d
SM
1348 ;; FIXME: enable-multibyte-characters is read-only, so bogus bindings are
1349 ;; really nasty (they signal an error in Emacs): Who does that? --Stef
877d353a 1350 (if (and (or (featurep 'xemacs)
9050446c
GM
1351 (and (boundp 'enable-multibyte-characters)
1352 enable-multibyte-characters))
f5136913 1353 (fboundp 'decode-coding-string)
f5136913
RS
1354 (ispell-get-coding-system))
1355 (decode-coding-string str (ispell-get-coding-system))
1356 str))
ef128a91 1357
ce77af79 1358;; Return a string decoded from Nth element of the current dictionary.
8253213c 1359(defun ispell-get-decoded-string (n)
94eb3112 1360 "Get the decoded string in slot N of the descriptor of the current dict."
a6e7a34b
RS
1361 (let* ((slot (or
1362 (assoc ispell-current-dictionary ispell-local-dictionary-alist)
a567af58 1363 (assoc ispell-current-dictionary ispell-dictionary-alist)
9ac7a13f
EZ
1364 (error "No data for dictionary \"%s\", neither in `ispell-local-dictionary-alist' nor in `ispell-dictionary-alist'"
1365 ispell-current-dictionary)))
8253213c
KH
1366 (str (nth n slot)))
1367 (when (and (> (length str) 0)
1368 (not (multibyte-string-p str)))
1369 (setq str (ispell-decode-string str))
ce77af79 1370 (or (multibyte-string-p str)
c31fd3c0 1371 (setq str (string-to-multibyte str))))
8253213c
KH
1372 str))
1373
007852e0 1374(defun ispell-get-casechars ()
8253213c 1375 (ispell-get-decoded-string 1))
007852e0 1376(defun ispell-get-not-casechars ()
8253213c 1377 (ispell-get-decoded-string 2))
007852e0 1378(defun ispell-get-otherchars ()
8253213c 1379 (ispell-get-decoded-string 3))
007852e0 1380(defun ispell-get-many-otherchars-p ()
a6e7a34b
RS
1381 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1382 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1383(defun ispell-get-ispell-args ()
a6e7a34b
RS
1384 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1385 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1386(defun ispell-get-extended-character-mode ()
935d1290
AM
1387 (if ispell-really-hunspell ;; hunspell treats ~word as ordinary words
1388 nil ;; in pipe mode. Disable extended-char-mode
1389 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1390 (assoc ispell-current-dictionary ispell-dictionary-alist)))))
ef128a91 1391(defun ispell-get-coding-system ()
a6e7a34b
RS
1392 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1393 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1394
8eba343c 1395
007852e0 1396(defvar ispell-pdict-modified-p nil
a9210a53 1397 "Non-nil means personal dictionary has modifications to be saved.")
007852e0 1398
60c4db3a
SM
1399;; If you want to save the dictionary when quitting, must do so explicitly.
1400;; When non-nil, the spell session is terminated.
1401;; When numeric, contains cursor location in buffer, and cursor remains there.
a9210a53 1402(defvar ispell-quit nil)
007852e0 1403
8eba343c
EZ
1404(defvar ispell-process-directory nil
1405 "The directory where `ispell-process' was started.")
1406
007852e0 1407(defvar ispell-filter nil
a9210a53 1408 "Output filter from piped calls to Ispell.")
007852e0
RS
1409
1410(defvar ispell-filter-continue nil
a9210a53 1411 "Control variable for Ispell filter function.")
007852e0 1412
8eba343c
EZ
1413(defvar ispell-output-buffer nil
1414 "Buffer used for reading output of a synchronous Ispell subprocess.")
1415
1416(defvar ispell-session-buffer nil
1417 "Buffer used for passing input to a synchronous Ispell subprocess.")
1418
1419(defvar ispell-cmd-args nil
1420 "Command-line arguments to pass to a synchronous Ispell subprocess.")
007852e0
RS
1421
1422(defvar ispell-query-replace-marker (make-marker)
a9210a53 1423 "Marker for `query-replace' processing.")
007852e0 1424
f5136913
RS
1425(defvar ispell-recursive-edit-marker (make-marker)
1426 "Marker for return point from recursive edit.")
1427
007852e0 1428(defvar ispell-checking-message nil
4d170362
SM
1429 "Non-nil when we're checking a mail message.
1430Set to the MIME boundary locations when checking messages.")
007852e0
RS
1431
1432(defconst ispell-choices-buffer "*Choices*")
1433
a9210a53 1434(defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
007852e0
RS
1435
1436;;; *** Buffer Local Definitions ***
1437
db95369b 1438(defconst ispell-words-keyword "LocalWords: "
007852e0
RS
1439 "The keyword for local oddly-spelled words to accept.
1440The keyword will be followed by any number of local word spellings.
d9a8eb66 1441There can be multiple instances of this keyword in the file.")
007852e0
RS
1442
1443(defconst ispell-dictionary-keyword "Local IspellDict: "
f5136913 1444 "The keyword for a local dictionary to use.
a6e7a34b
RS
1445The keyword must be followed by a valid dictionary name, defined in
1446`ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1447When multiple occurrences exist, the last keyword
f5136913
RS
1448definition is used.")
1449
1450(defconst ispell-pdict-keyword "Local IspellPersDict: "
1451 "The keyword for defining buffer local dictionaries.
1452Keyword must be followed by the filename of a personal dictionary.
1453The last occurring definition in the buffer will be used.")
007852e0
RS
1454
1455(defconst ispell-parsing-keyword "Local IspellParsing: "
a9210a53 1456 "The keyword for overriding default Ispell parsing.
007852e0
RS
1457The above keyword string should be followed by `latex-mode' or
1458`nroff-mode' to put the current buffer into the desired parsing mode.
1459
1460Extended character mode can be changed for this buffer by placing
f5136913
RS
1461a `~' followed by an extended-character mode -- such as `~.tex'.
1462The last occurring definition in the buffer will be used.")
1463
1464;;;###autoload
1465(defvar ispell-skip-region-alist
ca0a881a 1466 `((ispell-words-keyword forward-line)
f5136913
RS
1467 (ispell-dictionary-keyword forward-line)
1468 (ispell-pdict-keyword forward-line)
1469 (ispell-parsing-keyword forward-line)
5abf1556
SM
1470 (,(purecopy "^---*BEGIN PGP [A-Z ]*--*")
1471 . ,(purecopy "^---*END PGP [A-Z ]*--*"))
4d170362 1472 ;; assume multiline uuencoded file? "\nM.*$"?
ca0a881a
DN
1473 (,(purecopy "^begin [0-9][0-9][0-9] [^ \t]+$") . ,(purecopy "\nend\n"))
1474 (,(purecopy "^%!PS-Adobe-[123].0") . ,(purecopy "\n%%EOF\n"))
1475 (,(purecopy "^---* \\(Start of \\)?[Ff]orwarded [Mm]essage")
1476 . ,(purecopy "^---* End of [Ff]orwarded [Mm]essage"))
b857cb5c
EZ
1477 ;; Matches e-mail addresses, file names, http addresses, etc. The
1478 ;; `-+' `_+' patterns are necessary for performance reasons when
1479 ;; `-' or `_' part of word syntax.
6d341a2a 1480 (,(purecopy "\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)"))
4d170362
SM
1481 ;; above checks /.\w sequences
1482 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
f5136913 1483 ;; This is a pretty complex regexp. It can be simplified to the following:
fea6948a 1484 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
6fdf40f3 1485 ;; but some valid text will be skipped, e.g. "his/her". This could be
f5136913
RS
1486 ;; fixed up (at the expense of a moderately more complex regexp)
1487 ;; by not allowing "/" to be the character which triggers the
1488 ;; identification of the computer name, e.g.:
fea6948a 1489 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
f5136913 1490 )
94487c4e 1491 "Alist expressing beginning and end of regions not to spell check.
f5136913
RS
1492The alist key must be a regular expression.
1493Valid forms include:
1494 (KEY) - just skip the key.
94487c4e 1495 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
f5136913 1496 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
94487c4e 1497 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
09b2eb5e 1498(put 'ispell-skip-region-alist 'risky-local-variable t)
007852e0 1499
f5136913
RS
1500
1501;;;###autoload
1502(defvar ispell-tex-skip-alists
1e8780b1 1503 (purecopy
6fdf40f3 1504 '((;;("%\\[" . "%\\]") ; AMStex block comment...
f5136913
RS
1505 ;; All the standard LaTeX keywords from L. Lamport's guide:
1506 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1507 ;; \label, \nocite, \rule (in ispell - rest included here)
1508 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1509 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1510 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
6fdf40f3 1511 ;;("\\\\author" ispell-tex-arg-end)
f5136913
RS
1512 ("\\\\bibliographystyle" ispell-tex-arg-end)
1513 ("\\\\makebox" ispell-tex-arg-end 0)
fea6948a 1514 ("\\\\e?psfig" ispell-tex-arg-end)
f5136913
RS
1515 ("\\\\document\\(class\\|style\\)" .
1516 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1517 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1518 ;; equation, minipage, picture, tabular, tabular* (ispell)
fea6948a
GM
1519 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1520 ("list" ispell-tex-arg-end 2)
f5136913 1521 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1e8780b1 1522 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}"))))
fb7ada5f 1523 "Lists of regions to be skipped in TeX mode.
f5136913
RS
1524First list is used raw.
1525Second list has key placed inside \\begin{}.
1526
1527Delete or add any regions you want to be automatically selected
1528for skipping in latex mode.")
09b2eb5e 1529(put 'ispell-tex-skip-alist 'risky-local-variable t)
f5136913
RS
1530
1531
4d170362 1532;;;###autoload
1e8780b1 1533(defconst ispell-html-skip-alists
4d170362
SM
1534 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1535 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1536 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1537 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1538 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1539 ("<[tT][tT]/" "/")
1540 ("<[^ \t\n>]" ">")
1541 ("&[^ \t\n;]" "[; \t\n]"))
fb7ada5f 1542 "Lists of start and end keys to skip in HTML buffers.
2188975f 1543Same format as `ispell-skip-region-alist'.
4d170362 1544Note - substrings of other matches must come last
74a18969 1545 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
09b2eb5e 1546(put 'ispell-html-skip-alists 'risky-local-variable t)
4d170362 1547
007852e0 1548(defvar ispell-local-pdict ispell-personal-dictionary
4b03da72 1549 "A buffer local variable containing the current personal dictionary.
a9210a53 1550If non-nil, the value must be a string, which is a file name.
4b03da72 1551
a9210a53
RS
1552If you specify a personal dictionary for the current buffer which is
1553different from the current personal dictionary, the effect is similar
1554to calling \\[ispell-change-dictionary]. This variable is automatically
1555set when defined in the file with either `ispell-pdict-keyword' or the
1556local variable syntax.")
007852e0
RS
1557
1558(make-variable-buffer-local 'ispell-local-pdict)
c38fe6ca 1559;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
007852e0 1560
007852e0
RS
1561(defvar ispell-buffer-local-name nil
1562 "Contains the buffer name if local word definitions were used.
1563Ispell is then restarted because the local words could conflict.")
1564
da00640a
AM
1565(defvar ispell-buffer-session-localwords nil
1566 "List of words accepted for session in this buffer.")
1567
1568(make-variable-buffer-local 'ispell-buffer-session-localwords)
1569
007852e0 1570(defvar ispell-parser 'use-mode-name
fb7ada5f 1571 "Indicates whether ispell should parse the current buffer as TeX Code.
b9431ae0 1572Special value `use-mode-name' tries to guess using the name of `major-mode'.
f5136913
RS
1573Default parser is `nroff'.
1574Currently the only other valid parser is `tex'.
007852e0
RS
1575
1576You can set this variable in hooks in your init file -- eg:
1577
877d353a 1578\(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
007852e0
RS
1579
1580(defvar ispell-region-end (make-marker)
1581 "Marker that allows spelling continuations.")
1582
0349bab6
RS
1583(defvar ispell-check-only nil
1584 "If non-nil, `ispell-word' does not try to correct the word.")
007852e0 1585
e29702dd 1586
007852e0
RS
1587;;; **********************************************************************
1588;;; **********************************************************************
1589
1590
f5136913 1591
a1ff29b9 1592;;;###autoload (define-key esc-map "$" 'ispell-word)
b9431ae0 1593
4b03da72 1594
8eba343c
EZ
1595(defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1596 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1597If asynchronous subprocesses are not supported, call `ispell-filter' and
1598pass it the output of the last ispell invocation."
1599 (if ispell-async-processp
1600 (accept-process-output ispell-process timeout-secs timeout-msecs)
1601 (if (null ispell-process)
1602 (error "No Ispell process to read output from!")
1603 (let ((buf ispell-output-buffer)
1604 ispell-output)
1605 (if (not (bufferp buf))
1606 (setq ispell-filter nil)
0c3cc4dd 1607 (with-current-buffer buf
8eba343c
EZ
1608 (setq ispell-output (buffer-substring-no-properties
1609 (point-min) (point-max))))
1610 (ispell-filter t ispell-output)
0c3cc4dd 1611 (with-current-buffer buf
8eba343c
EZ
1612 (erase-buffer)))))))
1613
8f0d9e76
EZ
1614(defun ispell-send-replacement (misspelled replacement)
1615 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
2188975f 1616This allows it to improve the suggestion list based on actual misspellings."
8f0d9e76
EZ
1617 (and ispell-really-aspell
1618 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1619
8eba343c
EZ
1620
1621(defun ispell-send-string (string)
1622 "Send the string STRING to the Ispell process."
1623 (if ispell-async-processp
1624 (process-send-string ispell-process string)
1625 ;; Asynchronous subprocesses aren't supported on this losing system.
1626 ;; We keep all the directives passed to Ispell during the entire
1627 ;; session in a buffer, and pass them anew each time we invoke
1628 ;; Ispell to process another chunk of text. (Yes, I know this is a
1629 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1630 (let ((cmd (aref string 0))
1631 ;; The following commands are not passed to Ispell until
3849454a 1632 ;; we have a *real* reason to invoke it.
8eba343c 1633 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
8eba343c
EZ
1634 (session-buf ispell-session-buffer)
1635 (output-buf ispell-output-buffer)
1636 (ispell-args ispell-cmd-args)
1637 (defdir ispell-process-directory)
1638 prev-pos)
72f16325 1639 (with-current-buffer session-buf
8eba343c
EZ
1640 (setq prev-pos (point))
1641 (setq default-directory defdir)
1642 (insert string)
1643 (if (not (memq cmd cmds-to-defer))
1644 (let (coding-system-for-read coding-system-for-write status)
4d170362
SM
1645 (if (and (boundp 'enable-multibyte-characters)
1646 enable-multibyte-characters)
8eba343c
EZ
1647 (setq coding-system-for-read (ispell-get-coding-system)
1648 coding-system-for-write (ispell-get-coding-system)))
1649 (set-buffer output-buf)
1650 (erase-buffer)
1651 (set-buffer session-buf)
1652 (setq status
bc4c6633
RS
1653 (apply 'ispell-call-process-region
1654 (point-min) (point-max)
8eba343c
EZ
1655 ispell-program-name nil
1656 output-buf nil
c478e4c5
AM
1657 "-a"
1658 ;; hunspell -m option means something different
1659 (if ispell-really-hunspell "" "-m")
1660 ispell-args))
8eba343c
EZ
1661 (set-buffer output-buf)
1662 (goto-char (point-min))
1663 (save-match-data
1664 (if (not (looking-at "@(#) "))
1665 (error "Ispell error: %s"
1666 (buffer-substring-no-properties
1667 (point) (progn (end-of-line) (point)))))
1668 ;; If STRING is "^Z\n", we just started Ispell and need
1669 ;; to retain its version ID line in the output buffer.
1670 ;; Otherwise, remove the ID line, as it will confuse
1671 ;; `ispell-filter'.
1672 (or (string= string "\032\n")
1673 (progn
1674 (forward-line)
1675 (delete-region (point-min) (point))))
1676 ;; If STRING begins with ^ or any normal character, we need
1677 ;; to remove the last line from the session buffer, since it
1678 ;; was just spell-checked, and we don't want to check it again.
1679 ;; The same goes for the # command, since Ispell already saved
1680 ;; the personal dictionary.
1681 (set-buffer session-buf)
1682 (delete-region prev-pos (point))
1683 ;; Ispell run synchronously saves the personal dictionary
1684 ;; after each successful command. So we can remove any
1685 ;; lines in the session buffer that insert words into the
1686 ;; dictionary.
1687 (if (memq status '(0 nil))
1688 (let ((more-lines t))
1689 (goto-char (point-min))
1690 (while more-lines
1691 (if (looking-at "^\\*")
1692 (let ((start (point)))
1693 (forward-line)
1694 (delete-region start (point)))
1695 (setq more-lines (= 0 (forward-line))))))))))))))
1696
f441b81f 1697
007852e0 1698;;;###autoload
69f5930a 1699(defun ispell-word (&optional following quietly continue region)
007852e0 1700 "Check spelling of word under or before the cursor.
a9210a53 1701If the word is not found in dictionary, display possible corrections
e29702dd 1702in a window allowing you to choose one.
a9210a53 1703
4b03da72 1704If optional argument FOLLOWING is non-nil or if `ispell-following-word'
007852e0 1705is non-nil when called interactively, then the following word
3ee3ac77 1706\(rather than preceding\) is checked when the cursor is not over a word.
4b03da72 1707When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
007852e0
RS
1708when called interactively, non-corrective messages are suppressed.
1709
b9431ae0
RS
1710With a prefix argument (or if CONTINUE is non-nil),
1711resume interrupted spell-checking of a buffer or region.
1712
69f5930a
JL
1713Interactively, in Transient Mark mode when the mark is active, call
1714`ispell-region' to check the active region for spelling errors.
1715
a6e7a34b
RS
1716Word syntax is controlled by the definition of the chosen dictionary,
1717which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
007852e0
RS
1718
1719This will check or reload the dictionary. Use \\[ispell-change-dictionary]
9050446c
GM
1720or \\[ispell-region] to update the Ispell process.
1721
b11a1b2e 1722Return values:
4d170362 1723nil word is correct or spelling is accepted.
9050446c
GM
17240 word is inserted into buffer-local definitions.
1725\"word\" word corrected from word list.
1726\(\"word\" arg\) word is hand entered.
1727quit spell session exited."
69f5930a 1728 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t))
75662d96 1729 (cond
85c8c5b6
AM
1730 ((and region
1731 (if (featurep 'emacs)
1732 (use-region-p)
1733 (and (boundp 'transient-mark-mode) transient-mark-mode
1734 (boundp 'mark-active) mark-active
1735 (not (eq (region-beginning) (region-end))))))
75662d96
JL
1736 (ispell-region (region-beginning) (region-end)))
1737 (continue (ispell-continue))
1738 (t
caea54f8 1739 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
e29702dd 1740 (ispell-accept-buffer-local-defs) ; use the correct dictionary
9e7ad89a 1741 (let ((cursor-location (point)) ; retain cursor location
9e7ad89a 1742 (word (ispell-get-word following))
f5136913
RS
1743 start end poss new-word replace)
1744 ;; De-structure return word info list.
1745 (setq start (car (cdr word))
1746 end (car (cdr (cdr word)))
1747 word (car word))
1748
f0a1f8bd
RS
1749 ;; At this point it used to ignore 2-letter words.
1750 ;; But that is silly; if the user asks for it, we should do it. - rms.
1751 (or quietly
1752 (message "Checking spelling of %s..."
41d207e1 1753 (funcall ispell-format-word-function word)))
f0a1f8bd
RS
1754 (ispell-send-string "%\n") ; put in verbose mode
1755 (ispell-send-string (concat "^" word "\n"))
1756 ;; wait until ispell has processed word
1757 (while (progn
1758 (ispell-accept-output)
1759 (not (string= "" (car ispell-filter)))))
1760 ;;(ispell-send-string "!\n") ;back to terse mode.
1761 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1762 (if (and ispell-filter (listp ispell-filter))
1763 (if (> (length ispell-filter) 1)
1764 (error "Ispell and its process have different character maps")
1765 (setq poss (ispell-parse-output (car ispell-filter)))))
1766 (cond ((eq poss t)
1767 (or quietly
1768 (message "%s is correct"
41d207e1 1769 (funcall ispell-format-word-function word)))
a445370f 1770 (and (featurep 'xemacs)
f0a1f8bd 1771 (extent-at start)
e7cdb3e0
RS
1772 (and (fboundp 'delete-extent)
1773 (delete-extent (extent-at start)))))
f0a1f8bd
RS
1774 ((stringp poss)
1775 (or quietly
1776 (message "%s is correct because of root %s"
41d207e1
RW
1777 (funcall ispell-format-word-function word)
1778 (funcall ispell-format-word-function poss)))
a445370f 1779 (and (featurep 'xemacs)
f0a1f8bd 1780 (extent-at start)
e7cdb3e0
RS
1781 (and (fboundp 'delete-extent)
1782 (delete-extent (extent-at start)))))
744ba0e3
JL
1783 ((null poss)
1784 (message "Error checking word %s using %s with %s dictionary"
1785 (funcall ispell-format-word-function word)
1786 (file-name-nondirectory ispell-program-name)
1787 (or ispell-current-dictionary "default")))
f0a1f8bd
RS
1788 (ispell-check-only ; called from ispell minor mode.
1789 (if (fboundp 'make-extent)
e7cdb3e0
RS
1790 (if (fboundp 'set-extent-property)
1791 (let ((ext (make-extent start end)))
1792 (set-extent-property ext 'face ispell-highlight-face)
1793 (set-extent-property ext 'priority 2000)))
f0a1f8bd 1794 (beep)
41d207e1
RW
1795 (message "%s is incorrect"
1796 (funcall ispell-format-word-function word))))
f0a1f8bd
RS
1797 (t ; prompt for correct word.
1798 (save-window-excursion
1799 (setq replace (ispell-command-loop
1800 (car (cdr (cdr poss)))
1801 (car (cdr (cdr (cdr poss))))
1802 (car poss) start end)))
1803 (cond ((equal 0 replace)
1804 (ispell-add-per-file-word-list (car poss)))
1805 (replace
1806 (setq new-word (if (atom replace) replace (car replace))
1807 cursor-location (+ (- (length word) (- end start))
1808 cursor-location))
1809 (if (not (equal new-word (car poss)))
1810 (progn
76a47494
RS
1811 (goto-char start)
1812 ;; Insert first and then delete,
1813 ;; to avoid collapsing markers before and after
1814 ;; into a single place.
f621ccf5 1815 (insert new-word)
64953c0a 1816 (delete-region (point) end)
76a47494
RS
1817 ;; It is meaningless to preserve the cursor position
1818 ;; inside a word that has changed.
1819 (setq cursor-location (point))
f0a1f8bd
RS
1820 (setq end (point))))
1821 (if (not (atom replace)) ;recheck spelling of replacement
1822 (progn
1823 (if (car (cdr replace)) ; query replace requested
1824 (save-window-excursion
1825 (query-replace word new-word t)))
1826 (goto-char start)
1827 ;; single word could be split into multiple words
1828 (setq ispell-quit (not (ispell-region start end)))
1829 ))))
1830 ;; keep if rechecking word and we keep choices win.
1831 (if (get-buffer ispell-choices-buffer)
1832 (kill-buffer ispell-choices-buffer))))
1833 (ispell-pdict-save ispell-silently-savep)
1834 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
edfa1c2e 1835 (if ispell-quit (setq ispell-quit nil replace 'quit))
9050446c 1836 (goto-char cursor-location) ; return to original location
75662d96 1837 replace))))
007852e0
RS
1838
1839
1840(defun ispell-get-word (following &optional extra-otherchars)
1841 "Return the word for spell-checking according to ispell syntax.
3ee3ac77 1842If optional argument FOLLOWING is non-nil or if `ispell-following-word'
007852e0 1843is non-nil when called interactively, then the following word
e29702dd 1844\(rather than preceding\) is checked when the cursor is not over a word.
4b03da72 1845Optional second argument contains otherchars that can be included in word
d9a8eb66
EZ
1846many times (see the doc string of `ispell-dictionary-alist' for details
1847about otherchars).
007852e0 1848
a6e7a34b
RS
1849Word syntax is controlled by the definition of the chosen dictionary,
1850which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
0579b5b1 1851 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
007852e0
RS
1852 (let* ((ispell-casechars (ispell-get-casechars))
1853 (ispell-not-casechars (ispell-get-not-casechars))
1854 (ispell-otherchars (ispell-get-otherchars))
1855 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1856 (word-regexp (concat ispell-casechars
1857 "+\\("
f5136913
RS
1858 (if (not (string= "" ispell-otherchars))
1859 (concat ispell-otherchars "?"))
007852e0
RS
1860 (if extra-otherchars
1861 (concat extra-otherchars "?"))
1862 ispell-casechars
1863 "+\\)"
1864 (if (or ispell-many-otherchars-p
1865 extra-otherchars)
1866 "*" "?")))
f5136913 1867 did-it-once prevpt
007852e0
RS
1868 start end word)
1869 ;; find the word
1870 (if (not (looking-at ispell-casechars))
1871 (if following
1872 (re-search-forward ispell-casechars (point-max) t)
1873 (re-search-backward ispell-casechars (point-min) t)))
1874 ;; move to front of word
1875 (re-search-backward ispell-not-casechars (point-min) 'start)
f5136913
RS
1876 (while (and (or (and (not (string= "" ispell-otherchars))
1877 (looking-at ispell-otherchars))
007852e0
RS
1878 (and extra-otherchars (looking-at extra-otherchars)))
1879 (not (bobp))
1880 (or (not did-it-once)
f5136913
RS
1881 ispell-many-otherchars-p)
1882 (not (eq prevpt (point))))
007852e0
RS
1883 (if (and extra-otherchars (looking-at extra-otherchars))
1884 (progn
1885 (backward-char 1)
1886 (if (looking-at ispell-casechars)
1887 (re-search-backward ispell-not-casechars (point-min) 'move)))
f5136913
RS
1888 (setq did-it-once t
1889 prevpt (point))
007852e0
RS
1890 (backward-char 1)
1891 (if (looking-at ispell-casechars)
1892 (re-search-backward ispell-not-casechars (point-min) 'move)
1893 (backward-char -1))))
1894 ;; Now mark the word and save to string.
909f0455
RS
1895 (if (not (re-search-forward word-regexp (point-max) t))
1896 (if ispell-check-only
f5136913 1897 ;; return dummy word when just flagging misspellings
909f0455
RS
1898 (list "" (point) (point))
1899 (error "No word found to check!"))
64953c0a
RS
1900 (setq start (copy-marker (match-beginning 0))
1901 end (point-marker)
909f0455
RS
1902 word (buffer-substring-no-properties start end))
1903 (list word start end))))
007852e0
RS
1904
1905
60c4db3a
SM
1906;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1907;; tracks changes in the dictionary. The global may either be
1908;; a value or a list, whose value is the state of whether the
1909;; dictionary needs to be saved.
007852e0 1910
23b809c2 1911;;;###autoload
007852e0
RS
1912(defun ispell-pdict-save (&optional no-query force-save)
1913 "Check to see if the personal dictionary has been modified.
3ee3ac77 1914If so, ask if it needs to be saved."
007852e0
RS
1915 (interactive (list ispell-silently-savep t))
1916 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1917 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
0d11ff1c
CY
1918 (when (and (or ispell-pdict-modified-p force-save)
1919 (or no-query
1920 (y-or-n-p "Personal dictionary modified. Save? ")))
1921 (ispell-send-string "#\n") ; save dictionary
1922 (message "Personal dictionary saved.")
1923 (when flyspell-mode
1924 (flyspell-mode 0)
1925 (flyspell-mode 1)))
007852e0
RS
1926 ;; unassert variable, even if not saved to avoid questioning.
1927 (setq ispell-pdict-modified-p nil))
1928
1929
29aec366 1930(defun ispell-command-loop (miss guess word start end)
007852e0
RS
1931 "Display possible corrections from list MISS.
1932GUESS lists possibly valid affix construction of WORD.
1933Returns nil to keep word.
4b03da72
RS
1934Returns 0 to insert locally into buffer-local dictionary.
1935Returns string for new chosen word.
1936Returns list for new replacement word (will be rechecked).
f5136913
RS
1937 Query-replace when list length is 2.
1938 Automatic query-replace when second element is `query-replace'.
29aec366 1939Highlights the word, which is assumed to run from START to END.
3ee3ac77 1940Global `ispell-pdict-modified-p' becomes a list where the only value
2188975f
JB
1941indicates whether the dictionary has been modified when option `a'
1942or `i' is used.
f5136913 1943Global `ispell-quit' set to start location to continue spell session."
9050446c 1944 (let ((count ?0)
24b0afdc 1945 (line ispell-choices-win-default-height)
47a9f362
MB
1946 ;; ensure 4 context lines.
1947 (max-lines (- (ispell-adjusted-window-height) 4))
e29702dd
KH
1948 (choices miss)
1949 (window-min-height (min window-min-height
24b0afdc 1950 ispell-choices-win-default-height))
e29702dd 1951 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
8896f22d 1952 (dedicated (window-dedicated-p (selected-window)))
f5136913 1953 (skipped 0)
9050446c 1954 char num result textwin dedicated-win)
e29702dd
KH
1955
1956 ;; setup the *Choices* buffer with valid data.
0c3cc4dd 1957 (with-current-buffer (get-buffer-create ispell-choices-buffer)
4a65d2b3 1958 (setq mode-line-format
5abf1556
SM
1959 (concat
1960 "-- %b -- word: " word
1961 " -- dict: " (or ispell-current-dictionary "default")
1962 " -- prog: " (file-name-nondirectory ispell-program-name)))
4d170362 1963 ;; XEmacs: no need for horizontal scrollbar in choices window
85c8c5b6 1964 (ispell-with-no-warnings
6063ae55
RS
1965 (and (fboundp 'set-specifier)
1966 (boundp 'horizontal-scrollbar-visible-p)
1967 (set-specifier horizontal-scrollbar-visible-p nil
1968 (cons (current-buffer) nil))))
e29702dd
KH
1969 (erase-buffer)
1970 (if guess
1971 (progn
1972 (insert "Affix rules generate and capitalize "
1973 "this word as shown below:\n\t")
1974 (while guess
1975 (if (> (+ 4 (current-column) (length (car guess)))
1976 (window-width))
1977 (progn
1978 (insert "\n\t")
1979 (setq line (1+ line))))
1980 (insert (car guess) " ")
1981 (setq guess (cdr guess)))
f65d1611 1982 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.\n")
e29702dd
KH
1983 (setq line (+ line (if choices 3 2)))))
1984 (while (and choices
1985 (< (if (> (+ 7 (current-column) (length (car choices))
1986 (if (> count ?~) 3 0))
1987 (window-width))
1988 (progn
1989 (insert "\n")
1990 (setq line (1+ line)))
1991 line)
1992 max-lines))
1993 ;; not so good if there are over 20 or 30 options, but then, if
1994 ;; there are that many you don't want to scan them all anyway...
1995 (while (memq count command-characters) ; skip command characters.
f5136913 1996 (setq count (ispell-int-char (1+ count))
e29702dd
KH
1997 skipped (1+ skipped)))
1998 (insert "(" count ") " (car choices) " ")
1999 (setq choices (cdr choices)
f5136913
RS
2000 count (ispell-int-char (1+ count))))
2001 (setq count (ispell-int-char (- count ?0 skipped))))
e29702dd 2002
8eba343c 2003 ;; ensure word is visible
e29702dd
KH
2004 (if (not (pos-visible-in-window-p end))
2005 (sit-for 0))
fea6948a 2006
f5136913
RS
2007 ;; allow temporary split of dedicated windows...
2008 (if dedicated
2009 (progn
2010 (setq dedicated-win (selected-window))
2011 (set-window-dedicated-p dedicated-win nil)))
2012
e29702dd 2013 ;; Display choices for misspelled word.
f5136913 2014 (ispell-show-choices line end)
e29702dd
KH
2015 (select-window (setq textwin (next-window)))
2016
2017 ;; highlight word, protecting current buffer status
29aec366 2018 (unwind-protect
e29702dd 2019 (progn
f5136913
RS
2020 (and ispell-highlight-p
2021 (ispell-highlight-spelling-error start end t))
e29702dd 2022 ;; Loop until a valid choice is made.
29aec366
RS
2023 (while
2024 (eq
2025 t
2026 (setq
2027 result
2028 (progn
2029 (undo-boundary)
ab9d539c
KH
2030 (let (message-log-max)
2031 (message (concat "C-h or ? for more options; SPC to leave "
2032 "unchanged, Character to replace word")))
09144fdd
CY
2033 (let ((inhibit-quit t)
2034 (input-valid t))
2035 (setq char nil skipped 0)
2036 ;; If the user types C-g, or generates some other
2037 ;; non-character event (such as a frame switch
2038 ;; event), stop ispell. As a special exception,
d1f18ec0 2039 ;; ignore mouse events occurring in the same frame.
09144fdd 2040 (while (and input-valid (not (characterp char)))
7d0105e5 2041 (setq char (read-key))
09144fdd
CY
2042 (setq input-valid
2043 (or (characterp char)
2044 (and (mouse-event-p char)
2045 (eq (selected-frame)
2046 (window-frame
2047 (posn-window (event-start char))))))))
2048 (when (or quit-flag (not input-valid) (= char ?\C-g))
2049 (setq char ?X quit-flag nil)))
29aec366
RS
2050 ;; Adjust num to array offset skipping command characters.
2051 (let ((com-chars command-characters))
2052 (while com-chars
2053 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
2054 (setq skipped (1+ skipped)))
2055 (setq com-chars (cdr com-chars)))
2056 (setq num (- char ?0 skipped)))
2057
2058 (cond
e29702dd 2059 ((= char ? ) nil) ; accept word this time only
29aec366 2060 ((= char ?i) ; accept and insert word into pers dict
8eba343c 2061 (ispell-send-string (concat "*" word "\n"))
29aec366
RS
2062 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
2063 nil)
2064 ((or (= char ?a) (= char ?A)) ; accept word without insert
8eba343c 2065 (ispell-send-string (concat "@" word "\n"))
da00640a
AM
2066 (add-to-list 'ispell-buffer-session-localwords word)
2067 (or ispell-buffer-local-name ; session localwords might conflict
2068 (setq ispell-buffer-local-name (buffer-name)))
29aec366
RS
2069 (if (null ispell-pdict-modified-p)
2070 (setq ispell-pdict-modified-p
2071 (list ispell-pdict-modified-p)))
2072 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
2073 ((or (= char ?r) (= char ?R)) ; type in replacement
f5136913
RS
2074 (and (eq 'block ispell-highlight-p) ; refresh tty's
2075 (ispell-highlight-spelling-error start end nil t))
2076 (let ((result
2077 (if (or (= char ?R) ispell-query-replace-choices)
9050446c
GM
2078 (list (read-string
2079 (format "Query-replacement for %s: "word)
2080 word)
2081 t)
f5136913
RS
2082 (cons (read-string "Replacement for: " word)
2083 nil))))
2084 (and (eq 'block ispell-highlight-p)
2085 (ispell-highlight-spelling-error start end nil
2086 'block))
2087 result))
29aec366 2088 ((or (= char ??) (= char help-char) (= char ?\C-h))
f5136913
RS
2089 (and (eq 'block ispell-highlight-p)
2090 (ispell-highlight-spelling-error start end nil t))
29aec366 2091 (ispell-help)
f5136913
RS
2092 (and (eq 'block ispell-highlight-p)
2093 (ispell-highlight-spelling-error start end nil
2094 'block))
29aec366
RS
2095 t)
2096 ;; Quit and move point back.
2097 ((= char ?x)
2098 (ispell-pdict-save ispell-silently-savep)
2099 (message "Exited spell-checking")
2100 (setq ispell-quit t)
2101 nil)
2102 ;; Quit and preserve point.
2103 ((= char ?X)
2104 (ispell-pdict-save ispell-silently-savep)
10ba4783 2105 (message "%s"
29aec366
RS
2106 (substitute-command-keys
2107 (concat "Spell-checking suspended;"
2108 " use C-u \\[ispell-word] to resume")))
f5136913 2109 (setq ispell-quit start)
29aec366
RS
2110 nil)
2111 ((= char ?q)
2112 (if (y-or-n-p "Really kill Ispell process? ")
2113 (progn
2114 (ispell-kill-ispell t) ; terminate process.
2115 (setq ispell-quit (or (not ispell-checking-message)
2116 (point))
2117 ispell-pdict-modified-p nil))
e29702dd 2118 t)) ; continue if they don't quit.
29aec366 2119 ((= char ?l)
f5136913
RS
2120 (and (eq 'block ispell-highlight-p) ; refresh tty displays
2121 (ispell-highlight-spelling-error start end nil t))
29aec366
RS
2122 (let ((new-word (read-string
2123 "Lookup string (`*' is wildcard): "
9050446c 2124 word)))
29aec366 2125 (if new-word
007852e0 2126 (progn
0c3cc4dd
SM
2127 (with-current-buffer (get-buffer-create
2128 ispell-choices-buffer)
29aec366
RS
2129 (erase-buffer)
2130 (setq count ?0
2131 skipped 0
fd5539c6 2132 mode-line-format ;; setup the *Choices* buffer with valid data.
4a65d2b3 2133 (concat "-- %b -- word: " new-word
fd5539c6
AM
2134 " -- word-list: "
2135 (or ispell-complete-word-dict
2136 ispell-alternate-dictionary))
29aec366 2137 miss (lookup-words new-word)
9050446c 2138 choices miss
24b0afdc 2139 line ispell-choices-win-default-height)
29aec366
RS
2140 (while (and choices ; adjust choices window.
2141 (< (if (> (+ 7 (current-column)
2142 (length (car choices))
2143 (if (> count ?~) 3 0))
2144 (window-width))
2145 (progn
2146 (insert "\n")
9050446c
GM
2147 (setq line (1+ line)))
2148 line)
29aec366
RS
2149 max-lines))
2150 (while (memq count command-characters)
f5136913 2151 (setq count (ispell-int-char (1+ count))
29aec366
RS
2152 skipped (1+ skipped)))
2153 (insert "(" count ") " (car choices) " ")
2154 (setq choices (cdr choices)
f5136913
RS
2155 count (ispell-int-char (1+ count))))
2156 (setq count (ispell-int-char
2157 (- count ?0 skipped))))
9050446c 2158 (ispell-show-choices line end)
29aec366 2159 (select-window (next-window)))))
f5136913
RS
2160 (and (eq 'block ispell-highlight-p)
2161 (ispell-highlight-spelling-error start end nil
2162 'block))
29aec366 2163 t) ; reselect from new choices
6fdf40f3 2164 ((= char ?u) ; insert lowercase into dictionary
8eba343c 2165 (ispell-send-string (concat "*" (downcase word) "\n"))
29aec366
RS
2166 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
2167 nil)
2168 ((= char ?m) ; type in what to insert
8eba343c
EZ
2169 (ispell-send-string
2170 (concat "*" (read-string "Insert: " word) "\n"))
29aec366
RS
2171 (setq ispell-pdict-modified-p '(t))
2172 (cons word nil))
2173 ((and (>= num 0) (< num count))
2174 (if ispell-query-replace-choices ; Query replace flag
2175 (list (nth num miss) 'query-replace)
2176 (nth num miss)))
2177 ((= char ?\C-l)
2178 (redraw-display) t)
2179 ((= char ?\C-r)
9050446c 2180 ;; This may have alignment errors if current line is edited
f5136913
RS
2181 (if (marker-position ispell-recursive-edit-marker)
2182 (progn
2183 (message "Only one recursive edit session supported")
9050446c
GM
2184 (beep)
2185 (sit-for 2))
f5136913
RS
2186 (set-marker ispell-recursive-edit-marker start)
2187 ;;(set-marker ispell-region-end reg-end)
2188 (and ispell-highlight-p ; unhighlight
2189 (ispell-highlight-spelling-error start end))
2190 (unwind-protect
2191 (progn
9050446c
GM
2192 (message
2193 "%s"
2194 (substitute-command-keys
2195 (concat "Exit recursive edit with"
2196 " \\[exit-recursive-edit]")))
f5136913 2197 (save-window-excursion (save-excursion
9050446c
GM
2198 (recursive-edit))))
2199 ;; protected
2200 (goto-char ispell-recursive-edit-marker)
2201 (if (not (equal (marker-buffer
2202 ispell-recursive-edit-marker)
2203 (current-buffer)))
2204 (progn
2205 (set-marker ispell-recursive-edit-marker nil)
2206 (error
2207 "Cannot continue ispell from this buffer.")))
f5136913 2208 (set-marker ispell-recursive-edit-marker nil)))
9050446c 2209 (list word nil)) ; recheck starting at this word.
29aec366
RS
2210 ((= char ?\C-z)
2211 (funcall (key-binding "\C-z"))
2212 t)
2213 (t (ding) t))))))
2214 result)
e29702dd 2215 ;; protected
f5136913
RS
2216 (and ispell-highlight-p ; unhighlight
2217 (save-window-excursion
2218 (select-window textwin)
2219 (ispell-highlight-spelling-error start end)))
2220 (if dedicated
2221 (set-window-dedicated-p dedicated-win t)))))
2222
2223
2224
2225(defun ispell-show-choices (line end)
2188975f 2226 "Show the choices in another buffer or frame."
9050446c 2227 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
f5136913
RS
2228 (progn
2229 (framepop-display-buffer (get-buffer ispell-choices-buffer))
94eb3112 2230 ;; (get-buffer-window ispell-choices-buffer t)
f5136913
RS
2231 (select-window (previous-window))) ; *Choices* window
2232 ;; standard selection by splitting a small buffer out of this window.
2233 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
2234 (if choices-window
47a9f362 2235 (if (= line (ispell-adjusted-window-height choices-window))
f5136913
RS
2236 (select-window choices-window)
2237 ;; *Choices* window changed size. Adjust the choices window
2238 ;; without scrolling the spelled window when possible
47a9f362
MB
2239 (let ((window-line
2240 (- line (ispell-adjusted-window-height choices-window)))
f5136913 2241 (visible (progn (vertical-motion -1) (point))))
24b0afdc 2242 (if (< line ispell-choices-win-default-height)
f5136913 2243 (setq window-line (+ window-line
24b0afdc 2244 (- ispell-choices-win-default-height
f5136913
RS
2245 line))))
2246 (move-to-window-line 0)
2247 (vertical-motion window-line)
2248 (set-window-start (selected-window)
2249 (if (> (point) visible) visible (point)))
2250 (goto-char end)
4d170362 2251 (select-window choices-window)
f5136913
RS
2252 (enlarge-window window-line)))
2253 ;; Overlay *Choices* window when it isn't showing
24b0afdc 2254 (ispell-overlay-window (max line ispell-choices-win-default-height)))
f5136913
RS
2255 (switch-to-buffer ispell-choices-buffer)
2256 (goto-char (point-min)))))
007852e0
RS
2257
2258
829b9e73 2259;;;###autoload
007852e0 2260(defun ispell-help ()
3ee3ac77 2261 "Display a list of the options available when a misspelling is encountered.
007852e0
RS
2262
2263Selections are:
2264
2265DIGIT: Replace the word with a digit offered in the *Choices* buffer.
a9210a53
RS
2266SPC: Accept word this time.
2267`i': Accept word and insert into private dictionary.
2268`a': Accept word for this session.
2269`A': Accept word and place in `buffer-local dictionary'.
2270`r': Replace word with typed-in value. Rechecked.
d1f18ec0 2271`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
a9210a53
RS
2272`?': Show these commands.
2273`x': Exit spelling buffer. Move cursor to original point.
2274`X': Exit spelling buffer. Leaves cursor at the current point, and permits
007852e0 2275 the aborted check to be completed later.
a9210a53
RS
2276`q': Quit spelling session (Kills ispell process).
2277`l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2278`u': Like `i', but the word is lower-cased first.
f5136913 2279`m': Place typed-in value in personal dictionary, then recheck current word.
b11a1b2e
JB
2280`C-l': Redraw screen.
2281`C-r': Recursive edit.
2282`C-z': Suspend Emacs or iconify frame."
007852e0 2283
f5136913
RS
2284 (if (equal ispell-help-in-bufferp 'electric)
2285 (progn
2286 (require 'ehelp)
fea6948a 2287 (with-electric-help
f5136913
RS
2288 (function (lambda ()
2289 ;;This shouldn't be necessary: with-electric-help needs
2290 ;; an optional argument telling it about the smallest
2291 ;; acceptable window-height of the help buffer.
4d170362
SM
2292 ;;(if (< (window-height) 15)
2293 ;; (enlarge-window
2294 ;; (- 15 (ispell-adjusted-window-height))))
f5136913
RS
2295 (princ "Selections are:
2296
2297DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2298SPC: Accept word this time.
2299`i': Accept word and insert into private dictionary.
2300`a': Accept word for this session.
2301`A': Accept word and place in `buffer-local dictionary'.
2302`r': Replace word with typed-in value. Rechecked.
d1f18ec0 2303`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
f5136913
RS
2304`?': Show these commands.
2305`x': Exit spelling buffer. Move cursor to original point.
2306`X': Exit spelling buffer. Leaves cursor at the current point, and permits
2307 the aborted check to be completed later.
2308`q': Quit spelling session (Kills ispell process).
2309`l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2310`u': Like `i', but the word is lower-cased first.
2311`m': Place typed-in value in personal dictionary, then recheck current word.
b11a1b2e
JB
2312`C-l': Redraw screen.
2313`C-r': Recursive edit.
2314`C-z': Suspend Emacs or iconify frame.")
2315 nil))))
f5136913
RS
2316
2317
2318 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2319 "[i]nsert into private dictionary"))
2320 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2321 "e[x/X]it; [q]uit session"))
2322 (help-3 (concat "[u]ncapitalized insert into dict. "
b3955f8d 2323 "Type 'x C-h f ispell-help' for more help")))
f5136913
RS
2324 (save-window-excursion
2325 (if ispell-help-in-bufferp
2326 (progn
24b0afdc 2327 (ispell-overlay-window 4)
f5136913
RS
2328 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2329 (insert (concat help-1 "\n" help-2 "\n" help-3))
2330 (sit-for 5)
2331 (kill-buffer "*Ispell Help*"))
41b495af 2332 (unwind-protect
56351784 2333 (let ((resize-mini-windows 'grow-only))
41b495af
RS
2334 (select-window (minibuffer-window))
2335 (erase-buffer)
2336 (message nil)
2337 ;;(set-minibuffer-window (selected-window))
2338 (enlarge-window 2)
2339 (insert (concat help-1 "\n" help-2 "\n" help-3))
2340 (sit-for 5))
2341 (erase-buffer)))))))
007852e0
RS
2342
2343
2344(defun lookup-words (word &optional lookup-dict)
b9431ae0 2345 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
4b03da72
RS
2346A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2347Otherwise the variable `ispell-grep-command' contains the command used to
2348search for the words (usually egrep).
2349
3ee3ac77 2350Optional second argument contains the dictionary to use; the default is
0b381c7e 2351`ispell-alternate-dictionary', overridden by `ispell-complete-word-dict'
fd5539c6 2352if defined."
007852e0
RS
2353 ;; We don't use the filter for this function, rather the result is written
2354 ;; into a buffer. Hence there is no need to save the filter values.
2355 (if (null lookup-dict)
fd5539c6
AM
2356 (setq lookup-dict (or ispell-complete-word-dict
2357 ispell-alternate-dictionary)))
2358
2359 (if lookup-dict
2360 (unless (file-readable-p lookup-dict)
2361 (error "lookup-words error: Unreadable or missing plain word-list %s."
2362 lookup-dict))
5abf1556
SM
2363 (error (concat "lookup-words error: No plain word-list found at system"
2364 "default locations. "
2365 "Customize `ispell-alternate-dictionary' to set yours.")))
007852e0
RS
2366
2367 (let* ((process-connection-type ispell-use-ptys-p)
2368 (wild-p (string-match "\\*" word))
2369 (look-p (and ispell-look-p ; Only use look for an exact match.
2370 (or ispell-have-new-look (not wild-p))))
007852e0
RS
2371 (prog (if look-p ispell-look-command ispell-grep-command))
2372 (args (if look-p ispell-look-options ispell-grep-options))
2373 status results loc)
52d3c2d0
SM
2374 (with-temp-buffer
2375 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
2376 (if look-p
2377 nil
2378 ;; Convert * to .*
2379 (insert "^" word "$")
2380 (while (search-backward "*" nil t) (insert "."))
2381 (setq word (buffer-string))
2382 (erase-buffer))
2383 (setq status (apply 'ispell-call-process prog nil t nil
2384 (nconc (if (and args (> (length args) 0))
2385 (list args)
2386 (if look-p nil
2387 (list "-e")))
2388 (list word)
2389 (if lookup-dict (list lookup-dict)))))
2390 ;; `grep' returns status 1 and no output when word not found, which
2391 ;; is a perfectly normal thing.
2392 (if (stringp status)
2393 (error "error: %s exited with signal %s"
2394 (file-name-nondirectory prog) status)
2395 ;; Else collect words into `results' in FIFO order.
2396 (goto-char (point-max))
2397 ;; Assure we've ended with \n.
2398 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
2399 (while (not (bobp))
2400 (setq loc (point))
2401 (forward-line -1)
2402 (push (buffer-substring-no-properties (point)
2403 (1- loc))
2404 results))))
2405 (if (and results (string-match ".+: " (car results)))
2406 (error "%s error: %s" ispell-grep-command (car results)))
007852e0
RS
2407 results))
2408
2409
5abf1556
SM
2410;; "ispell-filter" is a list of output lines from the generating function.
2411;; Each full line (ending with \n) is a separate item on the list.
2412;; "output" can contain multiple lines, part of a line, or both.
2413;; "start" and "end" are used to keep bounds on lines when "output" contains
2414;; multiple lines.
2415;; "ispell-filter-continue" is true when we have received only part of a
2416;; line as output from a generating function ("output" did not end with \n)
2417;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
2418;; This is the case when a process dies or fails. The default behavior
2419;; in this case treats the next input received as fresh input.
007852e0
RS
2420
2421(defun ispell-filter (process output)
2422 "Output filter function for ispell, grep, and look."
2423 (let ((start 0)
2424 (continue t)
2425 end)
2426 (while continue
2427 (setq end (string-match "\n" output start)) ; get text up to the newline.
2428 ;; If we get out of sync and ispell-filter-continue is asserted when we
2429 ;; are not continuing, treat the next item as a separate list. When
2430 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2431 ;; list!
2432
2433 ;; Continue with same line (item)?
2434 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
2435 ;; Yes. Add it to the prev item
2436 (setcar ispell-filter
2437 (concat (car ispell-filter) (substring output start end)))
2438 ;; No. This is a new line and item.
2439 (setq ispell-filter
2440 (cons (substring output start end) ispell-filter)))
2441 (if (null end)
2442 ;; We've completed reading the output, but didn't finish the line.
2443 (setq ispell-filter-continue t continue nil)
2444 ;; skip over newline, this line complete.
2445 (setq ispell-filter-continue nil end (1+ end))
2446 (if (= end (length output)) ; No more lines in output
2447 (setq continue nil) ; so we can exit the filter.
2448 (setq start end)))))) ; else move start to next line of input
2449
2450
60c4db3a
SM
2451;; This function destroys the mark location if it is in the word being
2452;; highlighted.
f5136913
RS
2453(defun ispell-highlight-spelling-error-generic (start end &optional highlight
2454 refresh)
3ee3ac77
RS
2455 "Highlight the word from START to END with a kludge using `inverse-video'.
2456When the optional third arg HIGHLIGHT is set, the word is highlighted;
f5136913 2457otherwise it is displayed normally.
5755be32 2458Uses block cursor to highlight one character.
f5136913
RS
2459Optional REFRESH will unhighlighted then highlight, using block cursor
2460 highlighting when REFRESH is equal to `block'."
2461 (and (eq 'block ispell-highlight-p)
2462 (or (eq 'block refresh)
2463 (setq start (1+ start)))) ; On block non-refresh, inc start.
007852e0
RS
2464 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2465 (buffer-read-only nil) ; Allow highlighting read-only buffers.
e4769531
PE
2466 (text (buffer-substring-no-properties start end))
2467 ; Save highlight region.
007852e0 2468 (inhibit-quit t) ; inhibit interrupt processing here.
29aec366 2469 (buffer-undo-list t)) ; don't clutter the undo list.
f5136913 2470 (goto-char end)
007852e0 2471 (delete-region start end)
a7acbbe4 2472 (insert-char ? (- end start)) ; minimize amount of redisplay
007852e0
RS
2473 (sit-for 0) ; update display
2474 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2475 (delete-region start end) ; delete whitespace
2476 (insert text) ; insert text in inverse video.
2477 (sit-for 0) ; update display showing inverse video.
f5136913
RS
2478 (if (not highlight)
2479 (goto-char end)
2480 (setq inverse-video (not inverse-video)) ; toggle video
2481 (and (eq 'block ispell-highlight-p)
2482 (goto-char (1- start)))) ; use block cursor to "highlight" char
2483 (set-buffer-modified-p modified) ; don't modify if flag not set.
2484 (and refresh ; re-highlight
2485 (ispell-highlight-spelling-error-generic
2486 (if (eq 'block refresh) start (- start 2)) end t))))
2487
2488
2489(defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
3ee3ac77 2490 "Highlight the word from START to END using `isearch-highlight'.
e29702dd 2491When the optional third arg HIGHLIGHT is set, the word is highlighted,
007852e0
RS
2492otherwise it is displayed normally."
2493 (if highlight
2494 (isearch-highlight start end)
1332f1a0 2495 (isearch-dehighlight))
007852e0
RS
2496 ;;(sit-for 0)
2497 )
2498
2499
4b03da72 2500(defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
3ee3ac77
RS
2501 "Highlight the word from START to END using overlays.
2502When the optional third arg HIGHLIGHT is set, the word is highlighted
2503otherwise it is displayed normally.
4b03da72 2504
a9210a53 2505The variable `ispell-highlight-face' selects the face to use for highlighting."
007852e0 2506 (if highlight
9bb3de4b
JL
2507 (if ispell-overlay
2508 (move-overlay ispell-overlay start end (current-buffer))
007852e0 2509 (setq ispell-overlay (make-overlay start end))
9bb3de4b 2510 (overlay-put ispell-overlay 'priority 1001) ;higher than lazy overlays
007852e0 2511 (overlay-put ispell-overlay 'face ispell-highlight-face))
9bb3de4b
JL
2512 (if ispell-overlay
2513 (delete-overlay ispell-overlay)))
1332f1a0
JL
2514 (if (and ispell-lazy-highlight (boundp 'lazy-highlight-cleanup))
2515 (if highlight
2516 (let ((isearch-string
2517 (concat
2518 "\\b"
2519 (regexp-quote (buffer-substring-no-properties start end))
2520 "\\b"))
2521 (isearch-regexp t)
2522 (isearch-case-fold-search nil))
2523 (isearch-lazy-highlight-new-loop
2524 (if (boundp 'reg-start) reg-start)
2525 (if (boundp 'reg-end) reg-end)))
2526 (lazy-highlight-cleanup lazy-highlight-cleanup)
2527 (setq isearch-lazy-highlight-last-string nil))))
007852e0
RS
2528
2529
f5136913 2530(defun ispell-highlight-spelling-error (start end &optional highlight refresh)
29aec366 2531 (cond
877d353a 2532 ((featurep 'xemacs)
f5136913 2533 (ispell-highlight-spelling-error-xemacs start end highlight))
bb41818d 2534 ((and (featurep 'faces)
3b5fab87
EZ
2535 (or (and (fboundp 'display-color-p) (display-color-p))
2536 window-system))
29aec366 2537 (ispell-highlight-spelling-error-overlay start end highlight))
f5136913 2538 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
007852e0 2539
47a9f362
MB
2540(defun ispell-adjusted-window-height (&optional window)
2541 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2542The value returned is actually the nominal number of text-lines in the
2543window plus 1. On a terminal, this is the same value returned by
2544`window-height', but if the window has a mode-line is taller than a normal
2545text line, the returned value may be smaller than that from
2546`window-height'."
2547 (cond ((fboundp 'window-text-height)
2548 (1+ (window-text-height window)))
4d170362
SM
2549 ((or (and (fboundp 'display-graphic-p) (display-graphic-p))
2550 (and (featurep 'xemacs) window-system))
47a9f362
MB
2551 (1- (window-height window)))
2552 (t
2553 (window-height window))))
e29702dd 2554
007852e0 2555(defun ispell-overlay-window (height)
3ee3ac77
RS
2556 "Create a window covering the top HEIGHT lines of the current window.
2557Ensure that the line above point is still visible but otherwise avoid
045dbcbc 2558scrolling the current window. Leave the new window selected."
007852e0 2559 (save-excursion
24b0afdc 2560 (let ((oldot (save-excursion (vertical-motion -1) (point)))
007852e0 2561 (top (save-excursion (move-to-window-line height) (point))))
6fdf40f3 2562 ;; If line above old point (line starting at oldot) would be
007852e0
RS
2563 ;; hidden by new window, scroll it to just below new win
2564 ;; otherwise set top line of other win so it doesn't scroll.
2565 (if (< oldot top) (setq top oldot))
c80e3b4a 2566 ;; if frame is unsplittable, temporarily disable that...
f5136913
RS
2567 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2568 (let ((frame (selected-frame)))
2569 (modify-frame-parameters frame '((unsplittable . nil)))
2570 (split-window nil height)
2571 (modify-frame-parameters frame '((unsplittable . t))))
2572 (split-window nil height))
47a9f362 2573 (let ((deficit (- height (ispell-adjusted-window-height))))
24b0afdc 2574 (when (> deficit 0)
47a9f362
MB
2575 ;; Number of lines the window is still too short. We ensure that
2576 ;; there are at least (1- HEIGHT) lines visible in the window.
24b0afdc
MB
2577 (enlarge-window deficit)
2578 (goto-char top)
2579 (vertical-motion deficit)
2580 (setq top (min (point) oldot))))
007852e0
RS
2581 (set-window-start (next-window) top))))
2582
2583
60c4db3a 2584;; Should we add a compound word match return value?
9050446c 2585(defun ispell-parse-output (output &optional accept-list shift)
f5136913 2586 "Parse the OUTPUT string from Ispell process and return:
a9210a53 25871: t for an exact match.
f5136913 25882: A string containing the root word matched via suffix removal.
007852e0 25893: A list of possible correct spellings of the format:
f5136913 2590 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
3ee3ac77
RS
2591 ORIGINAL-WORD is a string of the possibly misspelled word.
2592 OFFSET is an integer giving the line offset of the word.
f5136913 2593 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
f0529b5b 25944: nil when an error has occurred.
9050446c 2595
72c04ce2 2596Optional second arg ACCEPT-LIST is list of words already accepted.
9050446c 2597Optional third arg SHIFT is an offset to apply based on previous corrections."
007852e0
RS
2598 (cond
2599 ((string= output "") t) ; for startup with pipes...
2600 ((string= output "*") t) ; exact match
f5136913 2601 ((string= output "-") t) ; compound word match
877d353a 2602 ((eq (aref output 0) ?+) ; found because of root word
007852e0 2603 (substring output 2)) ; return root word
b9431ae0 2604 ((equal 0 (string-match "[\ra-zA-Z]" output))
f5136913 2605 (ding) ; error message from ispell!
5673af85 2606 (message "Ispell error: %s" output)
f5136913
RS
2607 (sit-for 5)
2608 nil)
007852e0 2609 (t ; need to process &, ?, and #'s
877d353a 2610 (let ((type (aref output 0)) ; &, ?, or #
007852e0
RS
2611 (original-word (substring output 2 (string-match " " output 2)))
2612 (cur-count 0) ; contains number of misses + guesses
2613 count miss-list guess-list offset)
2614 (setq output (substring output (match-end 0))) ; skip over misspelling
877d353a 2615 (if (eq type ?#)
007852e0 2616 (setq count 0) ; no misses for type #
027a4b6b 2617 (setq count (string-to-number output) ; get number of misses.
007852e0 2618 output (substring output (1+ (string-match " " output 1)))))
027a4b6b 2619 (setq offset (string-to-number output))
94eb3112
SM
2620 (setq output (if (eq type ?#) ; No miss or guess list.
2621 nil
2622 (substring output (1+ (string-match " " output 1)))))
007852e0
RS
2623 (while output
2624 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2625 (setq cur-count (1+ cur-count))
2626 (if (> cur-count count)
94eb3112
SM
2627 (push (substring output 0 end) guess-list)
2628 (push (substring output 0 end) miss-list))
2629 (setq output (if (match-end 1) ; True only when at end of line.
2630 nil ; No more misses or guesses.
2631 (substring output (+ end 2))))))
9050446c
GM
2632 ;; return results. Accept word if it was already accepted.
2633 ;; adjust offset.
2634 (if (member original-word accept-list)
2635 t
2636 (list original-word
2637 (if (numberp shift) (+ shift offset) offset)
2638 (nreverse miss-list) (nreverse guess-list)))))))
007852e0
RS
2639
2640
8eba343c
EZ
2641(defun ispell-process-status ()
2642 "Return the status of the Ispell process.
2643When asynchronous processes are not supported, `run' is always returned."
2644 (if ispell-async-processp
2645 (process-status ispell-process)
2646 (and ispell-process 'run)))
2647
2648
2649(defun ispell-start-process ()
60c4db3a
SM
2650 "Start the Ispell process, with support for no asynchronous processes.
2651Keeps argument list for future Ispell invocations for no async support."
5abf1556
SM
2652 ;; Local dictionary becomes the global dictionary in use.
2653 (setq ispell-current-dictionary
2654 (or ispell-local-dictionary ispell-dictionary))
2655 (setq ispell-current-personal-dictionary
2656 (or ispell-local-pdict ispell-personal-dictionary))
2657 (let* ((default-directory
2658 (if (and (file-directory-p default-directory)
2659 (file-readable-p default-directory))
2660 default-directory
2661 ;; Defend against bad `default-directory'.
2662 (expand-file-name "~/")))
308e764f 2663 (orig-args (ispell-get-ispell-args))
5abf1556
SM
2664 (args
2665 (append
308e764f
AM
2666 (if (and ispell-current-dictionary ; Not for default dict (nil)
2667 (not (member "-d" orig-args))) ; Only define if not overridden.
5abf1556 2668 (list "-d" ispell-current-dictionary))
308e764f 2669 orig-args
5abf1556
SM
2670 (if ispell-current-personal-dictionary ; Use specified pers dict.
2671 (list "-p"
329bfd64
AM
2672 (expand-file-name ispell-current-personal-dictionary
2673 current-ispell-directory)))
5abf1556
SM
2674 ;; If we are using recent aspell or hunspell, make sure we use the
2675 ;; right encoding for communication. ispell or older aspell/hunspell
2676 ;; does not support this.
2677 (if ispell-encoding8-command
b39bb7e1
EZ
2678 (if ispell-really-hunspell
2679 (list ispell-encoding8-command
2680 (upcase (symbol-name (ispell-get-coding-system))))
2681 (list
2682 (concat ispell-encoding8-command
2683 (symbol-name (ispell-get-coding-system))))))
5abf1556 2684 ispell-extra-args)))
8eba343c 2685
09b2eb5e
RS
2686 ;; Initially we don't know any buffer's local words.
2687 (setq ispell-buffer-local-name nil)
2688
8eba343c
EZ
2689 (if ispell-async-processp
2690 (let ((process-connection-type ispell-use-ptys-p))
2691 (apply 'start-process
2692 "ispell" nil ispell-program-name
5abf1556
SM
2693 "-a" ; Accept single input lines.
2694 ;; Make root/affix combos not in dict.
2695 ;; hunspell -m option means different.
2696 (if ispell-really-hunspell "" "-m")
2697 args))
8eba343c
EZ
2698 (setq ispell-cmd-args args
2699 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2700 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2701 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2702 t)))
2703
2704
007852e0 2705(defun ispell-init-process ()
3ee3ac77 2706 "Check status of Ispell process and start if necessary."
567efba9
AM
2707 (let* (;; Basename of dictionary used by the spell-checker
2708 (dict-bname (or (car (cdr (member "-d" (ispell-get-ispell-args))))
2709 ispell-current-dictionary))
329bfd64
AM
2710 ;; The directory where process was started.
2711 (current-ispell-directory default-directory)
2712 ;; The default directory for the process.
567efba9
AM
2713 ;; Use "~/" as default-directory unless using Ispell with per-dir
2714 ;; personal dictionaries and not in a minibuffer under XEmacs
2715 (default-directory
2716 (if (or ispell-really-aspell
2717 ispell-really-hunspell
2718 ;; Protect against bad default-directory
2719 (not (and (file-directory-p default-directory)
2720 (file-readable-p default-directory)))
2721 ;; Ispell and per-dir personal dicts available
2722 (not (or (file-readable-p (concat default-directory
2723 ".ispell_words"))
2724 (file-readable-p (concat default-directory
2725 ".ispell_"
2726 (or dict-bname
2727 "default")))))
2728 ;; Ispell, in a minibuffer, and XEmacs
2729 (and (window-minibuffer-p)
2730 (not (fboundp 'minibuffer-selected-window))))
2731 (expand-file-name "~/")
2732 (expand-file-name default-directory))))
2733 ;; Check if process needs restart
2734 (if (and ispell-process
2735 (eq (ispell-process-status) 'run)
5abf1556
SM
2736 ;; Unless we are using an explicit personal dictionary, ensure
2737 ;; we're in the same default directory! Restart check for
2738 ;; personal dictionary is done in
2739 ;; `ispell-internal-change-dictionary', called from
2740 ;; `ispell-buffer-local-dict'
567efba9
AM
2741 (or (or ispell-local-pdict ispell-personal-dictionary)
2742 (equal ispell-process-directory default-directory)))
2743 (setq ispell-filter nil ispell-filter-continue nil)
2744 ;; may need to restart to select new personal dictionary.
2745 (ispell-kill-ispell t)
8cab9efc
AM
2746 (message "Starting new Ispell process [%s::%s] ..."
2747 ispell-program-name
567efba9
AM
2748 (or ispell-local-dictionary ispell-dictionary "default"))
2749 (sit-for 0)
2750 (setq ispell-library-directory (ispell-check-version)
2751 ispell-process (ispell-start-process)
2752 ispell-filter nil
2753 ispell-filter-continue nil
2754 ispell-process-directory default-directory)
5abf1556 2755
5abf1556 2756 (unless (equal ispell-process-directory (expand-file-name "~/"))
36f7d366
AM
2757 ;; At this point, `ispell-process-directory' will be "~/" unless using
2758 ;; Ispell with directory-specific dicts and not in XEmacs minibuffer.
2759 ;; If not, kill ispell process when killing buffer. It may be in a
2760 ;; removable device that would otherwise become un-mountable.
2761 (with-current-buffer
2762 (if (and (window-minibuffer-p) ;; In minibuffer
2763 (fboundp 'minibuffer-selected-window)) ;; Not XEmacs.
2764 ;; In this case kill ispell only when parent buffer is killed
2765 ;; to avoid over and over ispell kill.
567efba9 2766 (window-buffer (minibuffer-selected-window))
36f7d366
AM
2767 (current-buffer))
2768 ;; 'local does not automatically make hook buffer-local in XEmacs.
2769 (if (featurep 'xemacs)
2770 (make-local-hook 'kill-buffer-hook))
2771 (add-hook 'kill-buffer-hook
2772 (lambda () (ispell-kill-ispell t)) nil 'local)))
567efba9
AM
2773
2774 (if ispell-async-processp
2775 (set-process-filter ispell-process 'ispell-filter))
36f7d366 2776 ;; Protect against XEmacs bogus binding of `enable-multibyte-characters'.
567efba9
AM
2777 (if (and (or (featurep 'xemacs)
2778 (and (boundp 'enable-multibyte-characters)
2779 enable-multibyte-characters))
2780 (fboundp 'set-process-coding-system))
2781 (set-process-coding-system ispell-process (ispell-get-coding-system)
2782 (ispell-get-coding-system)))
2783 ;; Get version ID line
2784 (ispell-accept-output 3)
2785 ;; get more output if filter empty?
2786 (if (null ispell-filter) (ispell-accept-output 3))
2787 (cond ((null ispell-filter)
2788 (error "%s did not output version line" ispell-program-name))
2789 ((and
2790 (stringp (car ispell-filter))
2791 (if (string-match "warning: " (car ispell-filter))
2792 (progn
2793 (ispell-accept-output 3) ; was warn msg.
2794 (stringp (car ispell-filter)))
2795 (null (cdr ispell-filter)))
2796 (string-match "^@(#) " (car ispell-filter)))
2797 ;; got the version line as expected (we already know it's the right
2798 ;; version, so don't bother checking again.)
2799 nil)
2800 (t
2801 ;; Otherwise, it must be an error message. Show the user.
2802 ;; But first wait to see if some more output is going to arrive.
2803 ;; Otherwise we get cool errors like "Can't open ".
2804 (sleep-for 1)
2805 (ispell-accept-output 3)
2806 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2807 (setq ispell-filter nil) ; Discard version ID line
2808 (let ((extended-char-mode (ispell-get-extended-character-mode)))
2809 (if extended-char-mode ; ~ extended character mode
2810 (ispell-send-string (concat extended-char-mode "\n"))))
2811 (if ispell-async-processp
e337e22c 2812 (if (featurep 'emacs)
36f7d366 2813 (set-process-query-on-exit-flag ispell-process nil)
e337e22c
GM
2814 (if (fboundp 'set-process-query-on-exit-flag)
2815 (set-process-query-on-exit-flag ispell-process nil)
2816 (process-kill-without-query ispell-process)))))))
007852e0 2817
829b9e73 2818;;;###autoload
da00640a 2819(defun ispell-kill-ispell (&optional no-error clear)
a9210a53 2820 "Kill current Ispell process (so that you may start a fresh one).
da00640a
AM
2821With NO-ERROR, just return non-nil if there was no Ispell running.
2822With CLEAR, buffer session localwords are cleaned."
007852e0 2823 (interactive)
2834b9b3
SM
2824 ;; This hook is typically used by flyspell to flush some variables used
2825 ;; to optimize the common cases.
2826 (run-hooks 'ispell-kill-ispell-hook)
6e8a1786
AM
2827 (if (or clear
2828 (if (featurep 'xemacs)
2829 (interactive-p)
2830 (called-interactively-p 'interactive)))
da00640a 2831 (setq ispell-buffer-session-localwords nil))
007852e0 2832 (if (not (and ispell-process
8eba343c 2833 (eq (ispell-process-status) 'run)))
007852e0 2834 (or no-error
60c4db3a 2835 (error "There is no Ispell process running!"))
8eba343c 2836 (if ispell-async-processp
2a997209 2837 (delete-process ispell-process)
60c4db3a
SM
2838 ;; Synchronous processes.
2839 (ispell-send-string "\n") ; Make sure side effects occurred.
8eba343c
EZ
2840 (kill-buffer ispell-output-buffer)
2841 (kill-buffer ispell-session-buffer)
2842 (setq ispell-output-buffer nil
2843 ispell-session-buffer nil))
007852e0 2844 (setq ispell-process nil)
3ee3ac77 2845 (message "Ispell process killed")
007852e0
RS
2846 nil))
2847
60c4db3a
SM
2848;; ispell-change-dictionary is set in some people's hooks. Maybe this should
2849;; call ispell-init-process rather than wait for a spell checking command?
1335d078 2850
007852e0
RS
2851;;;###autoload
2852(defun ispell-change-dictionary (dict &optional arg)
a6e7a34b 2853 "Change to dictionary DICT for Ispell.
8e07e84a
RS
2854With a prefix arg, set it \"globally\", for all buffers.
2855Without a prefix arg, set it \"locally\", just for this buffer.
007852e0 2856
8e07e84a 2857By just answering RET you can find out what the current dictionary is."
007852e0
RS
2858 (interactive
2859 (list (completing-read
2860 "Use new dictionary (RET for current, SPC to complete): "
4d170362 2861 (and (fboundp 'ispell-valid-dictionary-list)
a6e7a34b 2862 (mapcar 'list (ispell-valid-dictionary-list)))
4d170362 2863 nil t)
007852e0 2864 current-prefix-arg))
f6b1b0a8 2865 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
87a6b92c 2866 (unless arg (ispell-buffer-local-dict 'no-reload))
007852e0
RS
2867 (if (equal dict "default") (setq dict nil))
2868 ;; This relies on completing-read's bug of returning "" for no match
2869 (cond ((equal dict "")
87a6b92c 2870 (ispell-internal-change-dictionary)
007852e0 2871 (message "Using %s dictionary"
e42a01cb
CY
2872 (or (and (not arg) ispell-local-dictionary)
2873 ispell-dictionary "default")))
2874 ((equal dict (or (and (not arg) ispell-local-dictionary)
a6e7a34b 2875 ispell-dictionary "default"))
87a6b92c
EZ
2876 ;; Specified dictionary is the default already. Could reload
2877 ;; the dictionaries if needed.
2878 (ispell-internal-change-dictionary)
6e8a1786
AM
2879 (and (if (featurep 'xemacs)
2880 (interactive-p)
2881 (called-interactively-p 'interactive))
a6e7a34b 2882 (message "No change, using %s dictionary" dict)))
007852e0 2883 (t ; reset dictionary!
a6e7a34b
RS
2884 (if (or (assoc dict ispell-local-dictionary-alist)
2885 (assoc dict ispell-dictionary-alist))
2886 (if arg
2887 ;; set default dictionary
2888 (setq ispell-dictionary dict)
2889 ;; set local dictionary
2890 (setq ispell-local-dictionary dict)
2891 (setq ispell-local-dictionary-overridden t))
f5136913 2892 (error "Undefined dictionary: %s" dict))
fc8a237d 2893 (ispell-internal-change-dictionary)
da00640a 2894 (setq ispell-buffer-session-localwords nil)
a6e7a34b
RS
2895 (message "%s Ispell dictionary set to %s"
2896 (if arg "Global" "Local")
2897 dict))))
2898
2899(defun ispell-internal-change-dictionary ()
87a6b92c 2900 "Update the dictionary and the personal dictionary used by Ispell.
d9a8eb66
EZ
2901This may kill the Ispell process; if so, a new one will be started
2902when needed."
87a6b92c
EZ
2903 (let ((dict (or ispell-local-dictionary ispell-dictionary))
2904 (pdict (or ispell-local-pdict ispell-personal-dictionary)))
2905 (unless (and (equal ispell-current-dictionary dict)
2906 (equal ispell-current-personal-dictionary pdict))
09b2eb5e 2907 (ispell-kill-ispell t)
87a6b92c
EZ
2908 (setq ispell-current-dictionary dict
2909 ispell-current-personal-dictionary pdict))))
007852e0 2910
a9cb95dd
SM
2911;; Avoid error messages when compiling for these dynamic variables.
2912(defvar ispell-start)
2913(defvar ispell-end)
2914
2915;; Spelling of comments are checked when ispell-check-comments is non-nil.
007852e0
RS
2916
2917;;;###autoload
9050446c 2918(defun ispell-region (reg-start reg-end &optional recheckp shift)
5755be32 2919 "Interactively check a region for spelling errors.
d9a8eb66
EZ
2920Return nil if spell session was terminated, otherwise returns shift offset
2921amount for last line processed."
007852e0 2922 (interactive "r") ; Don't flag errors on read-only bufs.
caea54f8 2923 (ispell-set-spellchecker-params) ; Initialize variables and dicts alists
9050446c
GM
2924 (if (not recheckp)
2925 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
4d170362 2926 (let ((skip-region-start (make-marker))
b159a1fd
AM
2927 (rstart (make-marker))
2928 (region-type (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2929 (buffer-name) "region"))
2930 (program-basename (file-name-nondirectory ispell-program-name))
2931 (dictionary (or ispell-current-dictionary "default")))
f0704a9a
AM
2932 (unwind-protect
2933 (save-excursion
2934 (message "Spell-checking %s using %s with %s dictionary..."
b159a1fd 2935 region-type program-basename dictionary)
f0704a9a
AM
2936 ;; Returns cursor to original location.
2937 (save-window-excursion
2938 (goto-char reg-start)
2939 (let ((transient-mark-mode)
2940 (case-fold-search case-fold-search)
2941 (query-fcc t)
2942 in-comment key)
b159a1fd
AM
2943 (ispell-print-if-debug
2944 (concat
2945 (format
2946 "ispell-region: (ispell-skip-region-list):\n%s\n"
2947 (ispell-skip-region-list))
2948 (format
2949 "ispell-region: (ispell-begin-skip-region-regexp):\n%s\n"
2950 (ispell-begin-skip-region-regexp))
2951 "ispell-region: Search for first region to skip after (ispell-begin-skip-region-regexp)\n"))
f0704a9a
AM
2952 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t)
2953 (progn
2954 (setq key (match-string-no-properties 0))
2955 (set-marker skip-region-start (- (point) (length key)))
b159a1fd
AM
2956 (goto-char reg-start)
2957 (ispell-print-if-debug
2958 (format "ispell-region: First skip: %s at (pos,line,column): (%s,%s,%s).\n"
2959 key
2960 (save-excursion (goto-char skip-region-start) (point))
2961 (line-number-at-pos skip-region-start)
2962 (save-excursion (goto-char skip-region-start) (current-column))))))
2963 (ispell-print-if-debug
2964 (format
2965 "ispell-region: Continue spell-checking with %s and %s dictionary...\n"
2966 program-basename dictionary))
f0704a9a
AM
2967 (set-marker rstart reg-start)
2968 (set-marker ispell-region-end reg-end)
2969 (while (and (not ispell-quit)
2970 (< (point) ispell-region-end))
2971 ;; spell-check region with skipping
2972 (if (and (marker-position skip-region-start)
2973 (<= skip-region-start (point)))
2974 (progn
2975 ;; If region inside line comment, must keep comment start.
2976 (setq in-comment (point)
2977 in-comment
2978 (and comment-start
2979 (or (null comment-end) (string= "" comment-end))
2980 (save-excursion
2981 (beginning-of-line)
2982 (re-search-forward comment-start in-comment t))
2983 comment-start))
2984 ;; Can change skip-regexps (in ispell-message)
2985 (ispell-skip-region key) ; moves pt past region.
2986 (set-marker rstart (point))
2987 ;; check for saving large attachments...
2988 (setq query-fcc (and query-fcc
2989 (ispell-ignore-fcc skip-region-start
2990 rstart)))
2991 (if (and (< rstart ispell-region-end)
2992 (re-search-forward
2993 (ispell-begin-skip-region-regexp)
2994 ispell-region-end t))
2995 (progn
2996 (setq key (match-string-no-properties 0))
2997 (set-marker skip-region-start
2998 (- (point) (length key)))
b159a1fd
AM
2999 (goto-char rstart)
3000 (ispell-print-if-debug
3001 (format "ispell-region: Next skip: %s at (pos,line,column): (%s,%s,%s).\n"
3002 key
3003 (save-excursion (goto-char skip-region-start) (point))
3004 (line-number-at-pos skip-region-start)
3005 (save-excursion (goto-char skip-region-start) (current-column)))))
f0704a9a
AM
3006 (set-marker skip-region-start nil))))
3007 (setq reg-end (max (point)
3008 (if (marker-position skip-region-start)
3009 (min skip-region-start ispell-region-end)
3010 (marker-position ispell-region-end))))
3011 (let* ((ispell-start (point))
3012 (ispell-end (min (point-at-eol) reg-end))
056cb3a1
AM
3013 ;; See if line must be prefixed by comment string to let ispell know this is
3014 ;; part of a comment string. This is only supported in some modes.
3015 ;; In particular, this is not supported in autoconf mode where adding the
3016 ;; comment string messes everything up because ispell tries to spellcheck the
3017 ;; `dnl' string header causing misalignments in some cases (debbugs.gnu.org: #12768).
3018 (add-comment (and in-comment
3019 (not (string= in-comment "dnl "))
3020 in-comment))
f0704a9a 3021 (string (ispell-get-line
056cb3a1 3022 ispell-start ispell-end add-comment)))
b159a1fd
AM
3023 (ispell-print-if-debug
3024 (format
056cb3a1
AM
3025 "ispell-region: string pos (%s->%s), eol: %s, [in-comment]: [%s], [add-comment]: [%s], [string]: [%s]\n"
3026 ispell-start ispell-end (point-at-eol) in-comment add-comment string))
3027 (if add-comment ; account for comment chars added
3028 (setq ispell-start (- ispell-start (length add-comment))
3029 add-comment nil))
f0704a9a
AM
3030 (setq ispell-end (point)) ; "end" tracks region retrieved.
3031 (if string ; there is something to spell check!
3032 ;; (special start end)
3033 (setq shift (ispell-process-line string
3034 (and recheckp shift))))
3035 (goto-char ispell-end)))))
3036 (if ispell-quit
3037 nil
3038 (or shift 0)))
3039 ;; protected
3040 (if (and (not (and recheckp ispell-keep-choices-win))
3041 (get-buffer ispell-choices-buffer))
3042 (kill-buffer ispell-choices-buffer))
3043 (set-marker skip-region-start nil)
3044 (set-marker rstart nil)
3045 (if ispell-quit
3046 (progn
3047 ;; preserve or clear the region for ispell-continue.
3048 (if (not (numberp ispell-quit))
3049 (set-marker ispell-region-end nil)
3050 ;; Ispell-continue enabled - ispell-region-end is set.
3051 (goto-char ispell-quit))
3052 ;; Check for aborting
3053 (if (and ispell-checking-message (numberp ispell-quit))
3054 (progn
3055 (setq ispell-quit nil)
3056 (error "Message send aborted")))
3057 (if (not recheckp) (setq ispell-quit nil)))
3058 (if (not recheckp) (set-marker ispell-region-end nil))
3059 ;; Only save if successful exit.
3060 (ispell-pdict-save ispell-silently-savep)
3061 (message "Spell-checking %s using %s with %s dictionary...done"
b159a1fd 3062 region-type program-basename dictionary)))))
007852e0
RS
3063
3064
f5136913 3065(defun ispell-begin-skip-region-regexp ()
2188975f 3066 "Return a regexp of the search keys for region skipping.
4d170362 3067Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
d9a8eb66 3068Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
94eb3112
SM
3069 (mapconcat
3070 'identity
3071 (delq nil
3072 (list
3073 ;; messages
3074 (if (and ispell-checking-message
3075 (not (eq t ispell-checking-message)))
3076 (mapconcat #'car ispell-checking-message "\\|"))
3077 ;; tex
3078 (if (eq ispell-parser 'tex)
3079 (ispell-begin-tex-skip-regexp))
3080 ;; html stuff
3081 (if ispell-skip-html
3082 (ispell-begin-skip-region ispell-html-skip-alists))
3083 ;; tib
3084 (if ispell-skip-tib ispell-tib-ref-beginning)
3085 ;; Comments
3086 (if (and (eq 'exclusive ispell-check-comments) comment-start)
3087 ;; search from end of current comment to start of next comment.
3088 (if (string= "" comment-end) "^" (regexp-quote comment-end)))
3089 (if (and (null ispell-check-comments) comment-start)
3090 (regexp-quote comment-start))
3091 (ispell-begin-skip-region ispell-skip-region-alist)))
3092 "\\|"))
f5136913
RS
3093
3094
4d170362
SM
3095(defun ispell-begin-skip-region (skip-alist)
3096 "Regular expression for start of regions to skip generated from SKIP-ALIST.
3097Each selection should be a key of SKIP-ALIST;
3098otherwise, the current line is skipped."
3099 (mapconcat (lambda (lst) (if (stringp (car lst)) (car lst) (eval (car lst))))
3100 skip-alist
3101 "\\|"))
3102
3103
f5136913 3104(defun ispell-begin-tex-skip-regexp ()
b9431ae0
RS
3105 "Regular expression of tex commands to skip.
3106Generated from `ispell-tex-skip-alists'."
f5136913 3107 (concat
4d170362 3108 ;; raw tex keys
f5136913
RS
3109 (mapconcat (function (lambda (lst) (car lst)))
3110 (car ispell-tex-skip-alists)
3111 "\\|")
3112 "\\|"
4d170362 3113 ;; keys wrapped in begin{}
f5136913
RS
3114 (mapconcat (function (lambda (lst)
3115 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
3116 (car lst)
3117 "[ \t\n]*}")))
3118 (car (cdr ispell-tex-skip-alists))
3119 "\\|")))
3120
3121
4d170362 3122(defun ispell-skip-region-list ()
2188975f 3123 "Return a list describing key and body regions to skip for this buffer.
4d170362
SM
3124Includes regions defined by `ispell-skip-region-alist', tex mode,
3125`ispell-html-skip-alists', and `ispell-checking-message'.
3126Manual checking must include comments and tib references.
3127The list is of the form described by variable `ispell-skip-region-alist'.
d9a8eb66 3128Must be called after `ispell-buffer-local-parsing' due to dependence on mode."
4d170362
SM
3129 (let ((skip-alist ispell-skip-region-alist))
3130 ;; only additional explicit region definition is tex.
3131 (if (eq ispell-parser 'tex)
3132 (setq case-fold-search nil
3133 skip-alist (append (car ispell-tex-skip-alists)
3134 (car (cdr ispell-tex-skip-alists))
3135 skip-alist)))
3136 (if ispell-skip-html
3137 (setq skip-alist (append ispell-html-skip-alists skip-alist)))
3138 (if (and ispell-checking-message
3139 (not (eq t ispell-checking-message)))
3140 (setq skip-alist (append ispell-checking-message skip-alist)))
3141 skip-alist))
f5136913
RS
3142
3143
3144(defun ispell-tex-arg-end (&optional arg)
4d170362 3145 "Skip across ARG number of braces."
f5136913
RS
3146 (condition-case nil
3147 (progn
3148 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
3149 (forward-sexp (or arg 1)))
3150 (error
744ba0e3 3151 (message "Error skipping s-expressions at point %d." (point))
f5136913
RS
3152 (beep)
3153 (sit-for 2))))
3154
3155
4d170362 3156(defun ispell-ignore-fcc (start end)
2188975f 3157 "Delete the Fcc: message header when large attachments are included.
d9a8eb66 3158Return value `nil' if file with large attachments is saved.
4d170362
SM
3159This can be used to avoid multiple questions for multiple large attachments.
3160Returns point to starting location afterwards."
3161 (let ((result t))
3162 (if (and ispell-checking-message ispell-message-fcc-skip)
3163 (if (< ispell-message-fcc-skip (- end start))
3164 (let (case-fold-search head-end)
3165 (goto-char (point-min))
3166 (setq head-end
3167 (or (re-search-forward
3168 (concat "^" (regexp-quote mail-header-separator) "$")
3169 nil t)
3170 (re-search-forward "^$" nil t)
3171 (point-min)))
3172 (goto-char (point-min))
3173 (if (re-search-forward "^Fcc:" head-end t)
3174 (if (y-or-n-p
3175 "Save copy of this message with large attachments? ")
3176 (setq result nil)
3177 (beginning-of-line)
3178 (kill-line 1)))
3179 (goto-char end))))
3180 result))
3181
3182
3183(defun ispell-skip-region (key)
2188975f 3184 "Skip across KEY and then to end of region.
4d170362
SM
3185Key lookup determines region to skip.
3186Point is placed at end of skipped region."
f5136913
RS
3187 ;; move over key to begin checking.
3188 (forward-char (length key))
3189 (let ((start (point))
4d170362
SM
3190 ;; Regenerate each call... This function can change region definition.
3191 (alist (ispell-skip-region-list))
f5136913
RS
3192 alist-key null-skip)
3193 (cond
3194 ;; what about quoted comment, or comment inside strings?
3195 ((and (null ispell-check-comments) comment-start
3196 (string= key comment-start))
3197 (if (string= "" comment-end)
3198 (forward-line)
3199 (search-forward comment-end ispell-region-end t)))
3200 ((and (eq 'exclusive ispell-check-comments) comment-start
3201 (string= key comment-end))
7a914d3e 3202 (search-forward comment-start ispell-region-end :end))
f5136913
RS
3203 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
3204 (re-search-forward ispell-tib-ref-end ispell-region-end t))
f5136913
RS
3205 ;; markings from alist
3206 (t
3207 (while alist
3208 (setq alist-key (eval (car (car alist))))
3209 (if (string-match alist-key key)
3210 (progn
3211 (setq alist (cdr (car alist)))
3212 (cond
3213 ((null alist) (setq null-skip t)) ; done! Just skip key.
3214 ((not (consp alist))
3215 ;; Search past end of spell region to find this region end.
3216 (re-search-forward (eval alist) (point-max) t))
4d170362
SM
3217 ((and (= 1 (length alist))
3218 (stringp (car alist)))
3219 (re-search-forward (car alist) (point-max) t))
3220 (t
3221 (setq null-skip t) ; error handling in functions!
3222 (if (consp (cdr alist))
3223 (apply (car alist) (cdr alist))
3224 (funcall (car alist)))))
f5136913
RS
3225 (setq alist nil))
3226 (setq alist (cdr alist))))))
3227 (if (and (= start (point)) (null null-skip))
3228 (progn
3229 (message "Matching region end for `%s' point %d not found"
3230 key (point))
3231 (beep)
3232 (sit-for 2)))))
3233
3234
4d170362 3235(defun ispell-get-line (start end in-comment)
5abf1556
SM
3236 "Grab the next line of data.
3237Returns a string with the line data."
f5136913
RS
3238 (let ((ispell-casechars (ispell-get-casechars))
3239 string)
3240 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
3241 ((eolp) ; END OF LINE, just go to next line.
3242 (forward-line))
fea6948a 3243 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
6fdf40f3 3244 ;; (forward-char 1)) ; not needed as quoted below.
f5136913
RS
3245 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
3246 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
4d170362
SM
3247 (setq string (concat "^" in-comment
3248 (buffer-substring-no-properties start end)
f5136913
RS
3249 "\n"))
3250 (goto-char end))
3251 (t (goto-char end))) ; EMPTY LINE, skip it.
3252 string))
3253
3254
664ca704
KH
3255(defun ispell-looking-at (string)
3256 (let ((coding (ispell-get-coding-system))
3257 (len (length string)))
3258 (and (<= (+ (point) len) (point-max))
3259 (equal (encode-coding-string string coding)
3260 (encode-coding-string (buffer-substring-no-properties
3261 (point) (+ (point) len))
3262 coding)))))
3263
9050446c 3264(defun ispell-process-line (string shift)
d9a8eb66 3265 "Send STRING, a line of text, to ispell and process the result.
9050446c 3266This will modify the buffer for spelling errors.
a9cb95dd
SM
3267Requires variables ISPELL-START and ISPELL-END to be defined in its
3268dynamic scope.
b11a1b2e 3269Returns the sum SHIFT due to changes in word replacements."
a9cb95dd 3270 ;;(declare special ispell-start ispell-end)
9050446c
GM
3271 (let (poss accept-list)
3272 (if (not (numberp shift))
3273 (setq shift 0))
f5136913 3274 ;; send string to spell process and get input.
8eba343c 3275 (ispell-send-string string)
f5136913 3276 (while (progn
8eba343c 3277 (ispell-accept-output)
f5136913
RS
3278 ;; Last item of output contains a blank line.
3279 (not (string= "" (car ispell-filter)))))
3280 ;; parse all inputs from the stream one word at a time.
3281 ;; Place in FIFO order and remove the blank item.
3282 (setq ispell-filter (nreverse (cdr ispell-filter)))
3283 (while (and (not ispell-quit) ispell-filter)
9050446c
GM
3284 ;; get next word, accounting for accepted words and start shifts
3285 (setq poss (ispell-parse-output (car ispell-filter)
3286 accept-list shift))
f5136913
RS
3287 (if (and poss (listp poss)) ; spelling error occurred.
3288 ;; Whenever we have misspellings, we can change
3289 ;; the buffer. Keep boundaries as markers.
3290 ;; Markers can move with highlighting! This destroys
3291 ;; end of region markers line-end and ispell-region-end
3292 (let ((word-start
a9cb95dd 3293 (copy-marker (+ ispell-start ispell-offset (car (cdr poss)))))
f5136913 3294 (word-len (length (car poss)))
a9cb95dd
SM
3295 (line-end (copy-marker ispell-end))
3296 (line-start (copy-marker ispell-start))
f5136913
RS
3297 recheck-region replace)
3298 (goto-char word-start)
3299 ;; Adjust the horizontal scroll & point
3300 (ispell-horiz-scroll)
3301 (goto-char (+ word-len word-start))
3302 (ispell-horiz-scroll)
3303 (goto-char word-start)
3304 (ispell-horiz-scroll)
9050446c
GM
3305
3306 ;; Alignment cannot be tracked and this error will occur when
3307 ;; `query-replace' makes multiple corrections on the starting line.
664ca704 3308 (or (ispell-looking-at (car poss))
b159a1fd
AM
3309 ;; This error occurs due to filter pipe problems
3310 (let* ((ispell-pipe-word (car poss))
3311 (actual-point (marker-position word-start))
3312 (actual-line (line-number-at-pos actual-point))
3313 (actual-column (save-excursion (goto-char actual-point) (current-column))))
3314 (ispell-print-if-debug
3315 (concat
3316 "ispell-process-line: Ispell misalignment error:\n"
3317 (format " [Word from ispell pipe]: [%s], actual (point,line,column): (%s,%s,%s)\n"
3318 ispell-pipe-word actual-point actual-line actual-column)))
3319 (error (concat "Ispell misalignment: word "
3320 "`%s' point %d; probably incompatible versions")
3321 ispell-pipe-word actual-point)))
f5136913
RS
3322 ;; ispell-cmd-loop can go recursive & change buffer
3323 (if ispell-keep-choices-win
3324 (setq replace (ispell-command-loop
3325 (car (cdr (cdr poss)))
3326 (car (cdr (cdr (cdr poss))))
3327 (car poss) (marker-position word-start)
3328 (+ word-len (marker-position word-start))))
3329 (save-window-excursion
3330 (setq replace (ispell-command-loop
3331 (car (cdr (cdr poss)))
3332 (car (cdr (cdr (cdr poss))))
3333 (car poss) (marker-position word-start)
3334 (+ word-len (marker-position word-start))))))
3335
f5136913 3336 (goto-char word-start)
9050446c
GM
3337 ;; Recheck when query replace edit changes misspelled word.
3338 ;; Error in tex mode when a potential math mode change exists.
3339 (if (and replace (listp replace) (= 2 (length replace)))
3340 (if (and (eq ispell-parser 'tex)
3341 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3342 (regexp-quote string)))
3343 (error
3344 "Don't start query replace on a line with math characters"
3345 )
f5136913
RS
3346 (set-marker line-end (point))
3347 (setq ispell-filter nil
3348 recheck-region t)))
8eba343c 3349
9050446c 3350 ;; insert correction if needed
f5136913 3351 (cond
f5136913
RS
3352 ((or (null replace)
3353 (equal 0 replace)) ; ACCEPT/INSERT
3354 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
3355 (ispell-add-per-file-word-list (car poss)))
9050446c
GM
3356 ;; do not recheck accepted word on this line
3357 (setq accept-list (cons (car poss) accept-list)))
3358 (t ; replacement word selected or entered
f5136913 3359 (delete-region (point) (+ word-len (point)))
9050446c
GM
3360 (if (not (listp replace))
3361 (progn
f621ccf5 3362 (insert replace) ; insert dictionary word
8f0d9e76 3363 (ispell-send-replacement (car poss) replace)
9050446c
GM
3364 (setq accept-list (cons replace accept-list)))
3365 (let ((replace-word (car replace)))
3366 ;; Recheck hand entered replacement word
3367 (insert replace-word)
8f0d9e76 3368 (ispell-send-replacement (car poss) replace-word)
9050446c
GM
3369 (if (car (cdr replace))
3370 (save-window-excursion
3371 (delete-other-windows) ; to correctly show help.
3372 ;; Assume case-replace &
3373 ;; case-fold-search correct?
3374 (query-replace (car poss) (car replace) t)))
3375 (goto-char word-start)
3376 ;; do not recheck if already accepted
3377 (if (member replace-word accept-list)
3378 (setq accept-list (cons replace-word accept-list)
3379 replace replace-word)
3380 (let ((region-end (copy-marker ispell-region-end)))
3381 (setq recheck-region ispell-filter
3382 ispell-filter nil ; save filter
fea6948a 3383 shift 0 ; already accounted
9050446c 3384 shift (ispell-region
fea6948a
GM
3385 word-start
3386 (+ word-start (length replace-word))
3387 t shift))
9050446c
GM
3388 (if (null shift) ; quitting check.
3389 (setq shift 0))
3390 (set-marker ispell-region-end region-end)
3391 (set-marker region-end nil)
3392 (setq ispell-filter recheck-region
3393 recheck-region nil
3394 replace replace-word)))))
3395
3396 (setq shift (+ shift (- (length replace) word-len)))
3397
3398 ;; Move line-start across word...
3399 ;; new shift function does this now...
3400 ;;(set-marker line-start (+ line-start
fa72a6a1
SM
3401 ;; (- (length replace)
3402 ;; (length (car poss)))))
9050446c 3403 ))
f5136913 3404 (if (not ispell-quit)
5abf1556 3405 ;; FIXME: remove redundancy with identical code above.
f5136913 3406 (let (message-log-max)
5abf1556
SM
3407 (message
3408 "Continuing spelling check using %s with %s dictionary..."
3409 (file-name-nondirectory ispell-program-name)
3410 (or ispell-current-dictionary "default"))))
f5136913 3411 (sit-for 0)
a9cb95dd
SM
3412 (setq ispell-start (marker-position line-start)
3413 ispell-end (marker-position line-end))
f5136913 3414 ;; Adjust markers when end of region lost from highlighting.
a9cb95dd
SM
3415 (if (and (not recheck-region)
3416 (< ispell-end (+ word-start word-len)))
3417 (setq ispell-end (+ word-start word-len)))
f5136913
RS
3418 (if (= word-start ispell-region-end)
3419 (set-marker ispell-region-end (+ word-start word-len)))
3420 ;; going out of scope - unneeded
3421 (set-marker line-start nil)
3422 (set-marker word-start nil)
3423 (set-marker line-end nil)))
3424 ;; finished with misspelling!
9050446c
GM
3425 (setq ispell-filter (cdr ispell-filter)))
3426 shift))
f5136913
RS
3427
3428
bc7d6816
GM
3429;;;###autoload
3430(defun ispell-comments-and-strings ()
3431 "Check comments and strings in the current buffer for spelling errors."
3432 (interactive)
3433 (goto-char (point-min))
3434 (let (state done)
3435 (while (not done)
3436 (setq done t)
3437 (setq state (parse-partial-sexp (point) (point-max)
3438 nil nil state 'syntax-table))
6fdf40f3
KH
3439 (if (or (nth 3 state) (nth 4 state))
3440 (let ((start (point)))
3441 (setq state (parse-partial-sexp start (point-max)
3442 nil nil state 'syntax-table))
3443 (if (or (nth 3 state) (nth 4 state))
3444 (error "Unterminated string or comment"))
3445 (save-excursion
3446 (setq done (not (ispell-region start (point))))))))))
bc7d6816 3447
007852e0
RS
3448
3449;;;###autoload
4b03da72 3450(defun ispell-buffer ()
007852e0
RS
3451 "Check the current buffer for spelling errors interactively."
3452 (interactive)
3453 (ispell-region (point-min) (point-max)))
3454
b159a1fd
AM
3455;;;###autoload
3456(defun ispell-buffer-with-debug (&optional append)
3457 "`ispell-buffer' with some output sent to `ispell-debug-buffer' buffer.
3458Use APPEND to append the info to previous buffer if exists."
3459 (interactive)
3460 (let ((ispell-debug-buffer (ispell-create-debug-buffer append)))
3461 (ispell-buffer)))
4b03da72 3462
829b9e73 3463;;;###autoload
007852e0 3464(defun ispell-continue ()
f5136913 3465 "Continue a halted spelling session beginning with the current word."
b9431ae0 3466 (interactive)
007852e0
RS
3467 (if (not (marker-position ispell-region-end))
3468 (message "No session to continue. Use 'X' command when checking!")
3469 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
3470 (message "Must continue ispell from buffer %s"
3471 (buffer-name (marker-buffer ispell-region-end)))
f5136913
RS
3472 (ispell-region
3473 ;; find beginning of current word:
3474 (car (cdr (ispell-get-word t)))
3475 (marker-position ispell-region-end)))))
007852e0
RS
3476
3477
3478;;; Horizontal scrolling
4b03da72 3479(defun ispell-horiz-scroll ()
2188975f 3480 "Place point within the horizontal visibility of its window area."
007852e0
RS
3481 (if truncate-lines ; display truncating lines?
3482 ;; See if display needs to be scrolled.
3483 (let ((column (- (current-column) (max (window-hscroll) 1))))
3484 (if (and (< column 0) (> (window-hscroll) 0))
3485 (scroll-right (max (- column) 10))
3486 (if (>= column (- (window-width) 2))
3487 (scroll-left (max (- column (window-width) -3) 10)))))))
3488
3489
3490;;; Interactive word completion.
5abf1556 3491;; Forces "previous-word" processing. Do we want to make this selectable?
007852e0
RS
3492
3493;;;###autoload
3494(defun ispell-complete-word (&optional interior-frag)
05f362a8 3495 "Try to complete the word before or under point (see `lookup-words').
b9431ae0
RS
3496If optional INTERIOR-FRAG is non-nil then the word may be a character
3497sequence inside of a word.
007852e0
RS
3498
3499Standard ispell choices are then available."
60c4db3a 3500 ;; FIXME: completion-at-point-function.
007852e0
RS
3501 (interactive "P")
3502 (let ((cursor-location (point))
b9431ae0 3503 (case-fold-search-val case-fold-search)
007852e0
RS
3504 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
3505 start end possibilities replacement)
3506 (setq start (car (cdr word))
3507 end (car (cdr (cdr word)))
3508 word (car word)
3509 possibilities
3510 (or (string= word "") ; Will give you every word
f5136913
RS
3511 (lookup-words (concat (and interior-frag "*") word
3512 (if (or interior-frag (null ispell-look-p))
3513 "*"))
fd5539c6
AM
3514 (or ispell-complete-word-dict
3515 ispell-alternate-dictionary))))
007852e0
RS
3516 (cond ((eq possibilities t)
3517 (message "No word to complete"))
3518 ((null possibilities)
3519 (message "No match for \"%s\"" word))
3520 (t ; There is a modification...
b9431ae0
RS
3521 (setq case-fold-search nil) ; Try and respect case of word.
3522 (cond
3523 ((string-equal (upcase word) word)
4b03da72 3524 (setq possibilities (mapcar 'upcase possibilities)))
877d353a 3525 ((eq (upcase (aref word 0)) (aref word 0))
b9431ae0
RS
3526 (setq possibilities (mapcar (function
3527 (lambda (pos)
877d353a 3528 (if (eq (aref word 0) (aref pos 0))
b9431ae0
RS
3529 pos
3530 (capitalize pos))))
3531 possibilities))))
3532 (setq case-fold-search case-fold-search-val)
29aec366
RS
3533 (save-window-excursion
3534 (setq replacement
3535 (ispell-command-loop possibilities nil word start end)))
007852e0
RS
3536 (cond
3537 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
3538 (ispell-add-per-file-word-list word))
3539 (replacement ; REPLACEMENT WORD
3540 (delete-region start end)
3541 (setq word (if (atom replacement) replacement (car replacement))
3542 cursor-location (+ (- (length word) (- end start))
3543 cursor-location))
f621ccf5 3544 (insert word)
007852e0
RS
3545 (if (not (atom replacement)) ; recheck spelling of replacement.
3546 (progn
3547 (goto-char cursor-location)
3548 (ispell-word nil t)))))
3549 (if (get-buffer ispell-choices-buffer)
3550 (kill-buffer ispell-choices-buffer))))
3551 (ispell-pdict-save ispell-silently-savep)
3552 (goto-char cursor-location)))
3553
3554
3555;;;###autoload
3556(defun ispell-complete-word-interior-frag ()
4b03da72 3557 "Completes word matching character sequence inside a word."
007852e0
RS
3558 (interactive)
3559 (ispell-complete-word t))
3560
e29702dd 3561
754bd273
GM
3562;;;###autoload
3563(defun ispell ()
3564 "Interactively check a region or buffer for spelling errors.
fea6948a 3565If `transient-mark-mode' is on, and a region is active, spell-check
3dfd2532
GM
3566that region. Otherwise spell-check the buffer.
3567
3568Ispell dictionaries are not distributed with Emacs. If you are
3569looking for a dictionary, please see the distribution of the GNU ispell
3570program, or do an Internet search; there are various dictionaries
3571available on the net."
754bd273 3572 (interactive)
4d170362
SM
3573 (if (and (boundp 'transient-mark-mode) transient-mark-mode
3574 (boundp 'mark-active) mark-active)
754bd273
GM
3575 (ispell-region (region-beginning) (region-end))
3576 (ispell-buffer)))
3577
3578
0349bab6
RS
3579;;; **********************************************************************
3580;;; Ispell Minor Mode
3581;;; **********************************************************************
3582
0349bab6
RS
3583(defvar ispell-minor-keymap
3584 (let ((map (make-sparse-keymap)))
3585 (define-key map " " 'ispell-minor-check)
3586 (define-key map "\r" 'ispell-minor-check)
3587 map)
3588 "Keymap used for Ispell minor mode.")
3589
0349bab6 3590;;;###autoload
94eb3112 3591(define-minor-mode ispell-minor-mode
ac6c8639
CY
3592 "Toggle last-word spell checking (Ispell minor mode).
3593With a prefix argument ARG, enable Ispell minor mode if ARG is
3594positive, and disable it otherwise. If called from Lisp, enable
3595the mode if ARG is omitted or nil.
fea6948a 3596
d9a8eb66 3597Ispell minor mode is a buffer-local minor mode. When enabled,
ac6c8639
CY
3598typing SPC or RET warns you if the previous word is incorrectly
3599spelled.
f5136913 3600
ac6c8639
CY
3601All the buffer-local variables and dictionaries are ignored. To
3602read them into the running ispell process, type \\[ispell-word]
3603SPC.
3604
3605For spell-checking \"on the fly\", not just after typing SPC or
3606RET, use `flyspell-mode'."
94eb3112 3607 nil " Spell" ispell-minor-keymap)
fea6948a 3608
0349bab6 3609(defun ispell-minor-check ()
d9a8eb66 3610 "Check previous word, then continue with the normal binding of this key.
f5136913
RS
3611Don't check previous word when character before point is a space or newline.
3612Don't read buffer-local settings or word lists."
0349bab6
RS
3613 (interactive "*")
3614 (let ((ispell-minor-mode nil)
f5136913
RS
3615 (ispell-check-only t)
3616 (last-char (char-after (1- (point)))))
6fdf40f3
KH
3617 (command-execute (key-binding (this-command-keys)))
3618 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
fea6948a
GM
3619 (and ispell-skip-html (eq last-char ?>))
3620 (and ispell-skip-html (eq last-char ?\;))))
6fdf40f3 3621 (ispell-word nil t))))
007852e0 3622
e29702dd 3623
007852e0
RS
3624;;; **********************************************************************
3625;;; Ispell Message
3626;;; **********************************************************************
7492978d
RS
3627
3628(defvar ispell-message-text-end
3629 (mapconcat (function identity)
3630 '(
f5136913
RS
3631 ;; Don't spell check signatures
3632 "^-- $"
7877f373 3633 ;; Matches PostScript files.
4d170362 3634 ;;"^%!PS-Adobe-[123].0"
7492978d 3635 ;; Matches uuencoded text
4d170362 3636 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
6fdf40f3 3637 ;; Matches shell files (especially auto-decoding)
e29702dd 3638 "^#! /bin/[ck]?sh"
8581f180 3639 ;; Matches context difference listing
f5136913
RS
3640 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3641 ;; Matches unidiff difference listing
02ba1267 3642 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@"
f5136913
RS
3643 ;; Matches reporter.el bug report
3644 "^current state:\n==============\n"
3645 ;; Matches commonly used "cut" boundaries
3646 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
7492978d 3647 "\\|")
fb7ada5f 3648 "Text beyond which `ispell-message' will not spell-check.
d9a8eb66 3649If it is a string, limit is the first occurrence of that regular expression.
7492978d 3650Otherwise, it must be a function which is called to get the limit.")
41d207e1 3651(put 'ispell-message-text-end 'risky-local-variable t)
007852e0 3652
4b03da72 3653
4d170362
SM
3654(defun ispell-mime-multipartp (&optional limit)
3655 "Return multipart message start boundary or nil if none."
3656 ;; caller must ensure `case-fold-search' is set to `t'
3657 (and
3658 (re-search-forward
3659 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3660 limit t)
3661 (let (boundary)
3662 (if (looking-at "\"")
3663 (let (start)
3664 (forward-char)
3665 (setq start (point))
3666 (while (not (looking-at "\""))
3667 (forward-char 1))
3668 (setq boundary (buffer-substring-no-properties start (point))))
3669 (let ((start (point)))
3670 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3671 (forward-char))
3672 (setq boundary (buffer-substring-no-properties start (point)))))
3673 (if (< (length boundary) 1)
3674 (setq boundary nil)
3675 (concat "--" boundary)))))
3676
3677
3678(defun ispell-mime-skip-part (boundary)
2188975f 3679 "Move point across header, or entire MIME part if message is encoded.
4d170362
SM
3680All specified types except `7bit' `8bit' and `quoted-printable' are considered
3681encoded and therefore skipped. See rfc 1521, 2183, ...
3682If no boundary is given, then entire message is skipped.
3683
3684This starts one line ABOVE the MIME content messages, on the boundary marker,
3685for operation with the generic region-skipping code.
3686This places new MIME boundaries into variable `ispell-checking-message'."
3687 (forward-line) ; skip over boundary to headers
3688 (let ((save-case-fold-search case-fold-search)
3689 (continuep t)
3690 textp)
3691 (setq case-fold-search t
3692 ispell-skip-html nil)
3693 (while continuep
3694 (setq continuep nil)
3695 (if (looking-at "Content-Type: *text/")
3696 (progn
3697 (goto-char (match-end 0))
3698 (if (looking-at "html")
3699 (setq ispell-skip-html t))
3700 (setq textp t
3701 continuep t)
3702 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3703 (forward-line)))
3704 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3705 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3706 (setq textp (member (upcase match)
3707 ;; only spell check the following encodings:
3708 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3709 continuep t)
3710 (goto-char (match-end 0))
3711 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3712 (forward-line)))
3713 ;; hierarchical boundary definition
3714 (if (looking-at "Content-Type: *multipart/")
3715 (let ((new-boundary (ispell-mime-multipartp)))
3716 (if (string-match new-boundary boundary)
3717 (setq continuep t)
3718 ;; first pass redefine skip function to include new boundary
3719 ;;(re-search-backward boundary nil t)
3720 (forward-line)
3721 (setq ispell-checking-message
3722 (cons
3723 (list new-boundary 'ispell-mime-skip-part new-boundary)
3724 (if (eq t ispell-checking-message) nil
3725 ispell-checking-message))
3726 textp t
3727 continuep t)))
3728 ;; Skip all MIME headers that don't affect spelling
3729 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3730 (progn
3731 (setq continuep t)
3732 (goto-char (match-end 0))
3733 (forward-line)))))
3734
3735 (setq case-fold-search save-case-fold-search)
3736 (if textp
3737 (point)
3738 ;; encoded message. Skip to boundary, or entire message.
3739 (if (not boundary)
3740 (goto-char (point-max))
3741 (re-search-forward boundary nil t)
3742 (beginning-of-line)
3743 (point)))))
3744
8ce8687e 3745
007852e0
RS
3746;;;###autoload
3747(defun ispell-message ()
3748 "Check the spelling of a mail message or news post.
3749Don't check spelling of message headers except the Subject field.
3750Don't check included messages.
3751
6ec7837b
RS
3752To abort spell checking of a message region and send the message anyway,
3753use the `x' command. (Any subsequent regions will be checked.)
d9a8eb66 3754The `X' command aborts sending the message so that you can edit the buffer.
007852e0
RS
3755
3756To spell-check whenever a message is sent, include the appropriate lines
865fe16f 3757in your init file:
f5136913
RS
3758 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3759 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
007852e0
RS
3760 (add-hook 'mail-send-hook 'ispell-message)
3761 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3762
e29702dd 3763You can bind this to the key C-c i in GNUS or mail by adding to
a9210a53 3764`news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
007852e0
RS
3765 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3766 (interactive)
7492978d 3767 (save-excursion
4b03da72 3768 (goto-char (point-min))
4d170362
SM
3769 (let* (boundary mimep
3770 (ispell-skip-region-alist-save ispell-skip-region-alist)
f753f75d 3771 ;; Nil when message came from outside (eg calling Emacs as editor)
f5136913
RS
3772 ;; Non-nil marker of end of headers.
3773 (internal-messagep
3774 (re-search-forward
3775 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3776 (end-of-headers ; Start of body.
3777 (copy-marker
3778 (or internal-messagep
3779 (re-search-forward "^$" nil t)
3780 (point-min))))
3781 (limit (copy-marker ; End of region we will spell check.
4b03da72
RS
3782 (cond
3783 ((not ispell-message-text-end) (point-max))
3784 ((char-or-string-p ispell-message-text-end)
3785 (if (re-search-forward ispell-message-text-end nil t)
3786 (match-beginning 0)
3787 (point-max)))
3788 (t (min (point-max) (funcall ispell-message-text-end))))))
f5136913
RS
3789 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3790 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3791 (ispell-non-empty-string mail-yank-prefix)
3792 " \\|\t"))
3793 (cite-regexp ;Prefix of quoted text
7492978d 3794 (cond
4d170362 3795 ((functionp 'sc-cite-regexp) ; sc 3.0
85c8c5b6 3796 (ispell-with-no-warnings
6e8a1786
AM
3797 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3798 (ispell-non-empty-string sc-reference-tag-string))))
4d170362 3799 ((boundp 'sc-cite-regexp) ; sc 2.3
7492978d 3800 (concat "\\(" sc-cite-regexp "\\)" "\\|"
85c8c5b6 3801 (ispell-with-no-warnings
6063ae55 3802 (ispell-non-empty-string sc-reference-tag-string))))
f5136913
RS
3803 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3804 (equal major-mode 'message-mode)) ;GNUS 5
7492978d 3805 (concat "In article <" "\\|"
b9431ae0 3806 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
85c8c5b6 3807 (ispell-with-no-warnings message-cite-prefix-regexp)
6063ae55 3808 "\\|"
f5136913 3809 default-prefix))
7492978d 3810 ((equal major-mode 'mh-letter-mode) ; mh mail message
b9431ae0 3811 (concat "[^,;&+=\n]+ writes:" "\\|"
85c8c5b6 3812 (ispell-with-no-warnings
6063ae55 3813 (ispell-non-empty-string mh-ins-buf-prefix))))
f5136913 3814 ((not internal-messagep) ; Assume nn sent us this message.
7492978d
RS
3815 (concat "In [a-zA-Z.]+ you write:" "\\|"
3816 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3817 " *> *"))
3818 ((boundp 'vm-included-text-prefix) ; VM mail message
b9431ae0 3819 (concat "[^,;&+=\n]+ writes:" "\\|"
7492978d 3820 (ispell-non-empty-string vm-included-text-prefix)))
f5136913
RS
3821 (t default-prefix)))
3822 (ispell-skip-region-alist
3823 (cons (list (concat "^\\(" cite-regexp "\\)")
3824 (function forward-line))
3825 ispell-skip-region-alist))
4b03da72 3826 (old-case-fold-search case-fold-search)
f5136913 3827 (dictionary-alist ispell-message-dictionary-alist)
4b03da72 3828 (ispell-checking-message t))
f5136913
RS
3829
3830 ;; Select dictionary for message
3831 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3832 (while dictionary-alist
3833 (goto-char (point-min))
3834 (if (re-search-forward (car (car dictionary-alist))
3835 end-of-headers t)
3836 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3837 dictionary-alist nil)
3838 (setq dictionary-alist (cdr dictionary-alist)))))
3839
3840 (unwind-protect
3841 (progn
3842 ;; Spell check any original Subject:
3843 (goto-char (point-min))
4d170362
SM
3844 (setq case-fold-search t
3845 mimep (re-search-forward "MIME-Version:" end-of-headers t))
3846 (goto-char (point-min))
f5136913
RS
3847 (if (re-search-forward "^Subject: *" end-of-headers t)
3848 (progn
3849 (goto-char (match-end 0))
3850 (if (and (not (looking-at ".*Re\\>"))
3851 (not (looking-at "\\[")))
b9431ae0
RS
3852 (progn
3853 (setq case-fold-search old-case-fold-search)
f5136913
RS
3854 (ispell-region (point)
3855 (progn ;Tab-initiated continuation lns.
3856 (end-of-line)
3857 (while (looking-at "\n[ \t]")
3858 (end-of-line 2))
3859 (point)))))))
4d170362
SM
3860 (if mimep
3861 (progn
3862 (goto-char (point-min))
3863 (setq boundary (ispell-mime-multipartp end-of-headers))))
3864 ;; Adjust message limit to MIME message if necessary.
3865 (and boundary
3866 (re-search-forward (concat boundary "--") nil t)
3867 (re-search-backward boundary nil t)
3868 (< (point) (marker-position limit))
3869 (set-marker limit (point)))
3870 (goto-char (point-min))
3871 ;; Select type or skip checking if this is a non-multipart message
3872 ;; Point moved to end of buffer if region is encoded.
94eb3112 3873 (when (and mimep (not boundary))
4d170362
SM
3874 (goto-char (point-min))
3875 (re-search-forward "Content-[^ \t]*:" end-of-headers t)
3876 (forward-line -1) ; following fn starts one line above
3877 (ispell-mime-skip-part nil)
3878 ;; if message-text-end region, limit may be less than point.
3879 (if (> (point) limit)
94eb3112 3880 (set-marker limit (point))))
4d170362 3881 (goto-char (max end-of-headers (point)))
f5136913 3882 (forward-line 1)
4d170362
SM
3883 (setq case-fold-search old-case-fold-search)
3884 ;; Define MIME regions to skip.
3885 (if boundary
3886 (setq ispell-checking-message
3887 (list (list boundary 'ispell-mime-skip-part boundary))))
f5136913
RS
3888 (ispell-region (point) limit))
3889 (set-marker end-of-headers nil)
4d170362
SM
3890 (set-marker limit nil)
3891 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3892 ispell-skip-html nil
3893 case-fold-search old-case-fold-search)))))
4b03da72 3894
007852e0
RS
3895
3896(defun ispell-non-empty-string (string)
3897 (if (or (not string) (string-equal string ""))
3898 "\\'\\`" ; An unmatchable string if string is null.
3899 (regexp-quote string)))
3900
3901
3902;;; **********************************************************************
3903;;; Buffer Local Functions
3904;;; **********************************************************************
3905
3906
3907(defun ispell-accept-buffer-local-defs ()
f5136913 3908 "Load all buffer-local information, restarting Ispell when necessary."
007852e0
RS
3909 (ispell-buffer-local-dict) ; May kill ispell-process.
3910 (ispell-buffer-local-words) ; Will initialize ispell-process.
3911 (ispell-buffer-local-parsing))
3912
3913
007852e0 3914(defun ispell-buffer-local-parsing ()
a9210a53 3915 "Place Ispell into parsing mode for this buffer.
4b03da72 3916Overrides the default parsing mode.
d9a8eb66 3917Includes LaTeX/Nroff modes and extended character mode."
007852e0 3918 ;; (ispell-init-process) must already be called.
8eba343c 3919 (ispell-send-string "!\n") ; Put process in terse mode.
007852e0 3920 ;; We assume all major modes with "tex-mode" in them should use latex parsing
6fdf40f3
KH
3921 ;; When exclusively checking comments, set to raw text mode (nroff).
3922 (if (and (not (eq 'exclusive ispell-check-comments))
3923 (or (and (eq ispell-parser 'use-mode-name)
3924 (string-match "[Tt][Ee][Xx]-mode"
3925 (symbol-name major-mode)))
3926 (eq ispell-parser 'tex)))
f5136913 3927 (progn
8eba343c 3928 (ispell-send-string "+\n") ; set ispell mode to tex
f5136913
RS
3929 (if (not (eq ispell-parser 'tex))
3930 (set (make-local-variable 'ispell-parser) 'tex)))
8eba343c 3931 (ispell-send-string "-\n")) ; set mode to normal (nroff)
f5136913 3932 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
fea6948a 3933 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
4d170362
SM
3934 (setq ispell-skip-html
3935 (not (null (string-match "sgml\\|html\\|xml"
3936 (downcase (symbol-name major-mode)))))))
007852e0
RS
3937 ;; Set default extended character mode for given buffer, if any.
3938 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3939 (if extended-char-mode
8eba343c 3940 (ispell-send-string (concat extended-char-mode "\n"))))
e29702dd 3941 ;; Set buffer-local parsing mode and extended character mode, if specified.
007852e0 3942 (save-excursion
f5136913
RS
3943 (goto-char (point-max))
3944 ;; Uses last occurrence of ispell-parsing-keyword
3945 (if (search-backward ispell-parsing-keyword nil t)
e180ab9f 3946 (let ((end (point-at-eol))
f5136913
RS
3947 string)
3948 (search-forward ispell-parsing-keyword)
3949 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3950 ;; space separated definitions.
81771793 3951 (setq string (downcase (match-string-no-properties 1)))
6fdf40f3
KH
3952 (cond ((and (string-match "latex-mode" string)
3953 (not (eq 'exclusive ispell-check-comments)))
8eba343c 3954 (ispell-send-string "+\n~tex\n"))
f5136913 3955 ((string-match "nroff-mode" string)
8eba343c 3956 (ispell-send-string "-\n~nroff\n"))
f5136913 3957 ((string-match "~" string) ; Set extended character mode.
8eba343c 3958 (ispell-send-string (concat string "\n")))
f5136913
RS
3959 (t (message "Invalid Ispell Parsing argument!")
3960 (sit-for 2))))))))
007852e0
RS
3961
3962
94eb3112 3963;; Can kill the current ispell process
007852e0 3964
87a6b92c 3965(defun ispell-buffer-local-dict (&optional no-reload)
f5136913 3966 "Initializes local dictionary and local personal dictionary.
d9a8eb66 3967If optional NO-RELOAD is non-nil, do not reload any dictionary.
007852e0 3968When a dictionary is defined in the buffer (see variable
a9210a53 3969`ispell-dictionary-keyword'), it will override the local setting
007852e0
RS
3970from \\[ispell-change-dictionary].
3971Both should not be used to define a buffer-local dictionary."
3972 (save-excursion
3973 (goto-char (point-min))
3974 (let (end)
3975 ;; Override the local variable definition.
f5136913
RS
3976 ;; Uses last occurrence of ispell-dictionary-keyword.
3977 (goto-char (point-max))
a6e7a34b
RS
3978 (unless ispell-local-dictionary-overridden
3979 (if (search-backward ispell-dictionary-keyword nil t)
3980 (progn
3981 (search-forward ispell-dictionary-keyword)
e180ab9f 3982 (setq end (point-at-eol))
a6e7a34b
RS
3983 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3984 (setq ispell-local-dictionary
81771793 3985 (match-string-no-properties 1))))))
f5136913
RS
3986 (goto-char (point-max))
3987 (if (search-backward ispell-pdict-keyword nil t)
3988 (progn
3989 (search-forward ispell-pdict-keyword)
e180ab9f 3990 (setq end (point-at-eol))
f5136913
RS
3991 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3992 (setq ispell-local-pdict
81771793 3993 (match-string-no-properties 1)))))))
87a6b92c
EZ
3994 (unless no-reload
3995 ;; Reload if new dictionary (maybe the personal one) defined.
3996 (ispell-internal-change-dictionary)))
007852e0
RS
3997
3998
3999(defun ispell-buffer-local-words ()
2188975f 4000 "Load the buffer-local dictionary in the current buffer."
09b2eb5e
RS
4001 ;; If there's an existing ispell process that's wrong for this use,
4002 ;; kill it.
007852e0
RS
4003 (if (and ispell-buffer-local-name
4004 (not (equal ispell-buffer-local-name (buffer-name))))
09b2eb5e
RS
4005 (ispell-kill-ispell t))
4006 ;; Actually start a new ispell process, because we need
4007 ;; to send commands now to specify the local words to it.
007852e0 4008 (ispell-init-process)
da00640a
AM
4009 (dolist (session-localword ispell-buffer-session-localwords)
4010 (ispell-send-string (concat "@" session-localword "\n")))
4011 (or ispell-buffer-local-name
4012 (if ispell-buffer-session-localwords
4013 (setq ispell-buffer-local-name (buffer-name))))
007852e0
RS
4014 (save-excursion
4015 (goto-char (point-min))
4016 (while (search-forward ispell-words-keyword nil t)
4017 (or ispell-buffer-local-name
4018 (setq ispell-buffer-local-name (buffer-name)))
e180ab9f 4019 (let ((end (point-at-eol))
f5136913 4020 (ispell-casechars (ispell-get-casechars))
007852e0 4021 string)
e29702dd 4022 ;; buffer-local words separated by a space, and can contain
f5136913 4023 ;; any character other than a space. Not rigorous enough.
7195bb71 4024 (while (re-search-forward " *\\([^ ]+\\)" end t)
81771793 4025 (setq string (match-string-no-properties 1))
64ef5f39 4026 ;; This can fail when string contains a word with invalid chars.
f753f75d 4027 ;; Error handling needs to be added between ispell and Emacs.
f5136913
RS
4028 (if (and (< 1 (length string))
4029 (equal 0 (string-match ispell-casechars string)))
8eba343c 4030 (ispell-send-string (concat "@" string "\n"))))))))
007852e0
RS
4031
4032
60c4db3a 4033;; Returns optionally adjusted region-end-point.
007852e0 4034
806c491a
GM
4035;; If comment-padright is defined, newcomment must be loaded.
4036(declare-function comment-add "newcomment" (arg))
4037
f5136913 4038(defun ispell-add-per-file-word-list (word)
b9431ae0 4039 "Add WORD to the per-file word list."
007852e0
RS
4040 (or ispell-buffer-local-name
4041 (setq ispell-buffer-local-name (buffer-name)))
007852e0
RS
4042 (save-excursion
4043 (goto-char (point-min))
94eb3112 4044 (let (line-okay search done found)
007852e0 4045 (while (not done)
94eb3112
SM
4046 (let ((case-fold-search nil))
4047 (setq search (search-forward ispell-words-keyword nil 'move)
fea6948a 4048 found (or found search)
007852e0
RS
4049 line-okay (< (+ (length word) 1 ; 1 for space after word..
4050 (progn (end-of-line) (current-column)))
94eb3112 4051 fill-column)))
007852e0
RS
4052 (if (or (and search line-okay)
4053 (null search))
4054 (progn
4055 (setq done t)
4056 (if (null search)
4057 (progn
4058 (open-line 1)
fea6948a 4059 (unless found (newline))
bf242939 4060 (insert (if comment-start
5192af46 4061 (concat
bf242939
AM
4062 (if (fboundp 'comment-padright)
4063 ;; Try and use the proper comment marker,
4064 ;; e.g. ";;" rather than ";".
4065 (comment-padright comment-start
4066 (comment-add nil))
4067 comment-start)
4068 " ")
4069 "")
4070 ispell-words-keyword)
4071 (if (and comment-end (> (length comment-end) 0))
007852e0 4072 (save-excursion
fea6948a 4073 (newline)
007852e0 4074 (insert comment-end)))))
f5136913 4075 (insert (concat " " word))))))))
007852e0 4076
f1ed9461 4077(add-to-list 'debug-ignored-errors "^No word found to check!$")
007852e0 4078
007852e0
RS
4079(provide 'ispell)
4080
4081\f
4082;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
4083
f753f75d
SM
4084;; Local Variable options:
4085;; mode: name(-mode)
4086;; eval: expression
4087;; local-variable: value
007852e0 4088
f753f75d
SM
4089;; The following sets the buffer local dictionary to `american' English
4090;; and spell checks only comments.
007852e0 4091
f753f75d
SM
4092;; Local Variables:
4093;; mode: emacs-lisp
4094;; comment-column: 40
4095;; ispell-check-comments: exclusive
4096;; ispell-local-dictionary: "american"
4097;; End:
007852e0
RS
4098
4099
4100;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
4101
f753f75d
SM
4102;; The following places this file in nroff parsing and extended char modes.
4103;; Local IspellParsing: nroff-mode ~nroff
4104;; Change IspellPersDict to IspellPersDict: to enable the following line.
4105;; Local IspellPersDict ~/.ispell_lisp
4106;; The following were automatically generated by ispell using the 'A' command:
6fdf40f3
KH
4107; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
4108; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
4109; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
4110; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
37269466 4111; LocalWords: minipage pers dict unhighlight buf grep sync prev inc
e4769531 4112; LocalWords: fn oldot NB AIX msg init read's bufs pt cmd Quinlan eg
c80e3b4a 4113; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict
9050446c 4114; LocalWords: lns XEmacs HTML casechars Multibyte
f5136913
RS
4115
4116;;; ispell.el ends here