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