Fix up comment convention on the arch-tag lines.
[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
ce77af79 1193;; Return a string decoded from Nth element of the current dictionary.
8253213c 1194(defun ispell-get-decoded-string (n)
a6e7a34b
RS
1195 (let* ((slot (or
1196 (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1197 (assoc ispell-current-dictionary ispell-dictionary-alist)))
8253213c
KH
1198 (str (nth n slot)))
1199 (when (and (> (length str) 0)
1200 (not (multibyte-string-p str)))
1201 (setq str (ispell-decode-string str))
ce77af79
KH
1202 (or (multibyte-string-p str)
1203 (setq str (string-to-multibyte str)))
8253213c
KH
1204 (setcar (nthcdr n slot) str))
1205 str))
1206
007852e0 1207(defun ispell-get-casechars ()
8253213c 1208 (ispell-get-decoded-string 1))
007852e0 1209(defun ispell-get-not-casechars ()
8253213c 1210 (ispell-get-decoded-string 2))
007852e0 1211(defun ispell-get-otherchars ()
8253213c 1212 (ispell-get-decoded-string 3))
007852e0 1213(defun ispell-get-many-otherchars-p ()
a6e7a34b
RS
1214 (nth 4 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1215 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1216(defun ispell-get-ispell-args ()
a6e7a34b
RS
1217 (nth 5 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1218 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1219(defun ispell-get-extended-character-mode ()
a6e7a34b
RS
1220 (nth 6 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1221 (assoc ispell-current-dictionary ispell-dictionary-alist))))
ef128a91 1222(defun ispell-get-coding-system ()
a6e7a34b
RS
1223 (nth 7 (or (assoc ispell-current-dictionary ispell-local-dictionary-alist)
1224 (assoc ispell-current-dictionary ispell-dictionary-alist))))
007852e0 1225
8eba343c 1226
007852e0 1227(defvar ispell-pdict-modified-p nil
a9210a53 1228 "Non-nil means personal dictionary has modifications to be saved.")
007852e0
RS
1229
1230;;; If you want to save the dictionary when quitting, must do so explicitly.
e29702dd
KH
1231;;; When non-nil, the spell session is terminated.
1232;;; When numeric, contains cursor location in buffer, and cursor remains there.
a9210a53 1233(defvar ispell-quit nil)
007852e0 1234
8eba343c
EZ
1235(defvar ispell-process-directory nil
1236 "The directory where `ispell-process' was started.")
1237
007852e0 1238(defvar ispell-filter nil
a9210a53 1239 "Output filter from piped calls to Ispell.")
007852e0
RS
1240
1241(defvar ispell-filter-continue nil
a9210a53 1242 "Control variable for Ispell filter function.")
007852e0 1243
8eba343c
EZ
1244(defvar ispell-output-buffer nil
1245 "Buffer used for reading output of a synchronous Ispell subprocess.")
1246
1247(defvar ispell-session-buffer nil
1248 "Buffer used for passing input to a synchronous Ispell subprocess.")
1249
1250(defvar ispell-cmd-args nil
1251 "Command-line arguments to pass to a synchronous Ispell subprocess.")
007852e0
RS
1252
1253(defvar ispell-query-replace-marker (make-marker)
a9210a53 1254 "Marker for `query-replace' processing.")
007852e0 1255
f5136913
RS
1256(defvar ispell-recursive-edit-marker (make-marker)
1257 "Marker for return point from recursive edit.")
1258
007852e0 1259(defvar ispell-checking-message nil
4d170362
SM
1260 "Non-nil when we're checking a mail message.
1261Set to the MIME boundary locations when checking messages.")
007852e0
RS
1262
1263(defconst ispell-choices-buffer "*Choices*")
1264
a9210a53 1265(defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
007852e0
RS
1266
1267;;; *** Buffer Local Definitions ***
1268
db95369b 1269(defconst ispell-words-keyword "LocalWords: "
007852e0
RS
1270 "The keyword for local oddly-spelled words to accept.
1271The keyword will be followed by any number of local word spellings.
1272There can be multiple of these keywords in the file.")
1273
1274(defconst ispell-dictionary-keyword "Local IspellDict: "
f5136913 1275 "The keyword for a local dictionary to use.
a6e7a34b
RS
1276The keyword must be followed by a valid dictionary name, defined in
1277`ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
1278When multiple occurrences exist, the last keyword
f5136913
RS
1279definition is used.")
1280
1281(defconst ispell-pdict-keyword "Local IspellPersDict: "
1282 "The keyword for defining buffer local dictionaries.
1283Keyword must be followed by the filename of a personal dictionary.
1284The last occurring definition in the buffer will be used.")
007852e0
RS
1285
1286(defconst ispell-parsing-keyword "Local IspellParsing: "
a9210a53 1287 "The keyword for overriding default Ispell parsing.
007852e0
RS
1288The above keyword string should be followed by `latex-mode' or
1289`nroff-mode' to put the current buffer into the desired parsing mode.
1290
1291Extended character mode can be changed for this buffer by placing
f5136913
RS
1292a `~' followed by an extended-character mode -- such as `~.tex'.
1293The last occurring definition in the buffer will be used.")
1294
1295;;;###autoload
1296(defvar ispell-skip-region-alist
1297 '((ispell-words-keyword forward-line)
1298 (ispell-dictionary-keyword forward-line)
1299 (ispell-pdict-keyword forward-line)
1300 (ispell-parsing-keyword forward-line)
1301 ("^---*BEGIN PGP [A-Z ]*--*" . "^---*END PGP [A-Z ]*--*")
4d170362
SM
1302 ;; assume multiline uuencoded file? "\nM.*$"?
1303 ("^begin [0-9][0-9][0-9] [^ \t]+$" . "\nend\n")
1304 ("^%!PS-Adobe-[123].0" . "\n%%EOF\n")
1305 ("^---* \\(Start of \\)?[Ff]orwarded [Mm]essage"
1306 . "^---* End of [Ff]orwarded [Mm]essage")
b857cb5c
EZ
1307 ;; Matches e-mail addresses, file names, http addresses, etc. The
1308 ;; `-+' `_+' patterns are necessary for performance reasons when
1309 ;; `-' or `_' part of word syntax.
1310 ("\\(--+\\|_+\\|\\(/\\w\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
4d170362
SM
1311 ;; above checks /.\w sequences
1312 ;;("\\(--+\\|\\(/\\|\\(\\(\\w\\|[-_]\\)+[.:@]\\)\\)\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_~=?&]\\)+\\)+\\)")
f5136913 1313 ;; This is a pretty complex regexp. It can be simplified to the following:
fea6948a 1314 ;; "\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
6fdf40f3 1315 ;; but some valid text will be skipped, e.g. "his/her". This could be
f5136913
RS
1316 ;; fixed up (at the expense of a moderately more complex regexp)
1317 ;; by not allowing "/" to be the character which triggers the
1318 ;; identification of the computer name, e.g.:
fea6948a 1319 ;; "\\(\\w\\|[-_]\\)+[.:@]\\(\\w\\|[-_]\\)*\\([.:/@]+\\(\\w\\|[-_]\\|~\\)+\\)+"
f5136913 1320 )
94487c4e 1321 "Alist expressing beginning and end of regions not to spell check.
f5136913
RS
1322The alist key must be a regular expression.
1323Valid forms include:
1324 (KEY) - just skip the key.
94487c4e 1325 (KEY . REGEXP) - skip to the end of REGEXP. REGEXP may be string or symbol.
f5136913 1326 (KEY REGEXP) - skip to end of REGEXP. REGEXP must be a string.
94487c4e 1327 (KEY FUNCTION ARGS) - FUNCTION called with ARGS returns end of region.")
09b2eb5e 1328(put 'ispell-skip-region-alist 'risky-local-variable t)
007852e0 1329
f5136913
RS
1330
1331;;;###autoload
1332(defvar ispell-tex-skip-alists
6fdf40f3 1333 '((;;("%\\[" . "%\\]") ; AMStex block comment...
f5136913
RS
1334 ;; All the standard LaTeX keywords from L. Lamport's guide:
1335 ;; \cite, \hspace, \hspace*, \hyphenation, \include, \includeonly, \input,
1336 ;; \label, \nocite, \rule (in ispell - rest included here)
1337 ("\\\\addcontentsline" ispell-tex-arg-end 2)
1338 ("\\\\add\\(tocontents\\|vspace\\)" ispell-tex-arg-end)
1339 ("\\\\\\([aA]lph\\|arabic\\)" ispell-tex-arg-end)
6fdf40f3 1340 ;;("\\\\author" ispell-tex-arg-end)
f5136913
RS
1341 ("\\\\bibliographystyle" ispell-tex-arg-end)
1342 ("\\\\makebox" ispell-tex-arg-end 0)
fea6948a 1343 ("\\\\e?psfig" ispell-tex-arg-end)
f5136913
RS
1344 ("\\\\document\\(class\\|style\\)" .
1345 "\\\\begin[ \t\n]*{[ \t\n]*document[ \t\n]*}"))
1346 (;; delimited with \begin. In ispell: displaymath, eqnarray, eqnarray*,
1347 ;; equation, minipage, picture, tabular, tabular* (ispell)
fea6948a
GM
1348 ("\\(figure\\|table\\)\\*?" ispell-tex-arg-end 0)
1349 ("list" ispell-tex-arg-end 2)
f5136913
RS
1350 ("program" . "\\\\end[ \t\n]*{[ \t\n]*program[ \t\n]*}")
1351 ("verbatim\\*?" . "\\\\end[ \t\n]*{[ \t\n]*verbatim\\*?[ \t\n]*}")))
1352 "*Lists of regions to be skipped in TeX mode.
1353First list is used raw.
1354Second list has key placed inside \\begin{}.
1355
1356Delete or add any regions you want to be automatically selected
1357for skipping in latex mode.")
09b2eb5e 1358(put 'ispell-tex-skip-alist 'risky-local-variable t)
f5136913
RS
1359
1360
4d170362
SM
1361;;;###autoload
1362(defvar ispell-html-skip-alists
1363 '(("<[cC][oO][dD][eE]\\>[^>]*>" "</[cC][oO][dD][eE]*>")
1364 ("<[sS][cC][rR][iI][pP][tT]\\>[^>]*>" "</[sS][cC][rR][iI][pP][tT]>")
1365 ("<[aA][pP][pP][lL][eE][tT]\\>[^>]*>" "</[aA][pP][pP][lL][eE][tT]>")
1366 ("<[vV][eE][rR][bB]\\>[^>]*>" "<[vV][eE][rR][bB]\\>[^>]*>")
1367 ;;("<[tT][tT]\\>[^>]*>" "<[tT][tT]\\>[^>]*>")
1368 ("<[tT][tT]/" "/")
1369 ("<[^ \t\n>]" ">")
1370 ("&[^ \t\n;]" "[; \t\n]"))
1371 "*Lists of start and end keys to skip in HTML buffers.
1372Same format as `ispell-skip-region-alist'
1373Note - substrings of other matches must come last
74a18969 1374 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
09b2eb5e 1375(put 'ispell-html-skip-alists 'risky-local-variable t)
4d170362 1376
007852e0 1377(defvar ispell-local-pdict ispell-personal-dictionary
4b03da72 1378 "A buffer local variable containing the current personal dictionary.
a9210a53 1379If non-nil, the value must be a string, which is a file name.
4b03da72 1380
a9210a53
RS
1381If you specify a personal dictionary for the current buffer which is
1382different from the current personal dictionary, the effect is similar
1383to calling \\[ispell-change-dictionary]. This variable is automatically
1384set when defined in the file with either `ispell-pdict-keyword' or the
1385local variable syntax.")
007852e0
RS
1386
1387(make-variable-buffer-local 'ispell-local-pdict)
c38fe6ca 1388;;;###autoload(put 'ispell-local-pdict 'safe-local-variable 'stringp)
007852e0 1389
007852e0
RS
1390(defvar ispell-buffer-local-name nil
1391 "Contains the buffer name if local word definitions were used.
1392Ispell is then restarted because the local words could conflict.")
1393
1394(defvar ispell-parser 'use-mode-name
1395 "*Indicates whether ispell should parse the current buffer as TeX Code.
b9431ae0 1396Special value `use-mode-name' tries to guess using the name of `major-mode'.
f5136913
RS
1397Default parser is `nroff'.
1398Currently the only other valid parser is `tex'.
007852e0
RS
1399
1400You can set this variable in hooks in your init file -- eg:
1401
877d353a 1402\(add-hook 'tex-mode-hook (lambda () (setq ispell-parser 'tex)))")
007852e0
RS
1403
1404(defvar ispell-region-end (make-marker)
1405 "Marker that allows spelling continuations.")
1406
0349bab6
RS
1407(defvar ispell-check-only nil
1408 "If non-nil, `ispell-word' does not try to correct the word.")
007852e0 1409
e29702dd 1410
007852e0
RS
1411;;; **********************************************************************
1412;;; **********************************************************************
1413
1414
f5136913 1415
a1ff29b9 1416;;;###autoload (define-key esc-map "$" 'ispell-word)
b9431ae0 1417
4b03da72 1418
8eba343c
EZ
1419(defun ispell-accept-output (&optional timeout-secs timeout-msecs)
1420 "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS.
1421If asynchronous subprocesses are not supported, call `ispell-filter' and
1422pass it the output of the last ispell invocation."
1423 (if ispell-async-processp
1424 (accept-process-output ispell-process timeout-secs timeout-msecs)
1425 (if (null ispell-process)
1426 (error "No Ispell process to read output from!")
1427 (let ((buf ispell-output-buffer)
1428 ispell-output)
1429 (if (not (bufferp buf))
1430 (setq ispell-filter nil)
1431 (save-excursion
1432 (set-buffer buf)
1433 (setq ispell-output (buffer-substring-no-properties
1434 (point-min) (point-max))))
1435 (ispell-filter t ispell-output)
1436 (save-excursion
1437 (set-buffer buf)
1438 (erase-buffer)))))))
1439
8f0d9e76
EZ
1440(defun ispell-send-replacement (misspelled replacement)
1441 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1442This allows it to improve the suggestion list based on actual mispellings."
1443 (and ispell-really-aspell
1444 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1445
8eba343c
EZ
1446
1447(defun ispell-send-string (string)
1448 "Send the string STRING to the Ispell process."
1449 (if ispell-async-processp
1450 (process-send-string ispell-process string)
1451 ;; Asynchronous subprocesses aren't supported on this losing system.
1452 ;; We keep all the directives passed to Ispell during the entire
1453 ;; session in a buffer, and pass them anew each time we invoke
1454 ;; Ispell to process another chunk of text. (Yes, I know this is a
1455 ;; terrible kludge, and it's a bit slow, but it does get the work done.)
1456 (let ((cmd (aref string 0))
1457 ;; The following commands are not passed to Ispell until
3849454a 1458 ;; we have a *real* reason to invoke it.
8eba343c
EZ
1459 (cmds-to-defer '(?* ?@ ?~ ?+ ?- ?! ?%))
1460 (default-major-mode 'fundamental-mode)
1461 (session-buf ispell-session-buffer)
1462 (output-buf ispell-output-buffer)
1463 (ispell-args ispell-cmd-args)
1464 (defdir ispell-process-directory)
1465 prev-pos)
1466 (save-excursion
1467 (set-buffer session-buf)
1468 (setq prev-pos (point))
1469 (setq default-directory defdir)
1470 (insert string)
1471 (if (not (memq cmd cmds-to-defer))
1472 (let (coding-system-for-read coding-system-for-write status)
4d170362
SM
1473 (if (and (boundp 'enable-multibyte-characters)
1474 enable-multibyte-characters)
8eba343c
EZ
1475 (setq coding-system-for-read (ispell-get-coding-system)
1476 coding-system-for-write (ispell-get-coding-system)))
1477 (set-buffer output-buf)
1478 (erase-buffer)
1479 (set-buffer session-buf)
1480 (setq status
bc4c6633
RS
1481 (apply 'ispell-call-process-region
1482 (point-min) (point-max)
8eba343c
EZ
1483 ispell-program-name nil
1484 output-buf nil
1485 "-a" "-m" ispell-args))
1486 (set-buffer output-buf)
1487 (goto-char (point-min))
1488 (save-match-data
1489 (if (not (looking-at "@(#) "))
1490 (error "Ispell error: %s"
1491 (buffer-substring-no-properties
1492 (point) (progn (end-of-line) (point)))))
1493 ;; If STRING is "^Z\n", we just started Ispell and need
1494 ;; to retain its version ID line in the output buffer.
1495 ;; Otherwise, remove the ID line, as it will confuse
1496 ;; `ispell-filter'.
1497 (or (string= string "\032\n")
1498 (progn
1499 (forward-line)
1500 (delete-region (point-min) (point))))
1501 ;; If STRING begins with ^ or any normal character, we need
1502 ;; to remove the last line from the session buffer, since it
1503 ;; was just spell-checked, and we don't want to check it again.
1504 ;; The same goes for the # command, since Ispell already saved
1505 ;; the personal dictionary.
1506 (set-buffer session-buf)
1507 (delete-region prev-pos (point))
1508 ;; Ispell run synchronously saves the personal dictionary
1509 ;; after each successful command. So we can remove any
1510 ;; lines in the session buffer that insert words into the
1511 ;; dictionary.
1512 (if (memq status '(0 nil))
1513 (let ((more-lines t))
1514 (goto-char (point-min))
1515 (while more-lines
1516 (if (looking-at "^\\*")
1517 (let ((start (point)))
1518 (forward-line)
1519 (delete-region start (point)))
1520 (setq more-lines (= 0 (forward-line))))))))))))))
1521
f5136913 1522
ca8d88cd
KH
1523;; Insert WORD while translating Latin characters to the equivalent
1524;; characters that is supported by buffer-file-coding-system.
1525
1526(defun ispell-insert-word (word)
1527 (let ((pos (point)))
1528 (insert word)
1529 (if (char-table-p translation-table-for-input)
1530 (translate-region pos (point) translation-table-for-input))))
a870f917 1531
007852e0 1532;;;###autoload
69f5930a 1533(defun ispell-word (&optional following quietly continue region)
007852e0 1534 "Check spelling of word under or before the cursor.
a9210a53 1535If the word is not found in dictionary, display possible corrections
e29702dd 1536in a window allowing you to choose one.
a9210a53 1537
4b03da72 1538If optional argument FOLLOWING is non-nil or if `ispell-following-word'
007852e0 1539is non-nil when called interactively, then the following word
3ee3ac77 1540\(rather than preceding\) is checked when the cursor is not over a word.
4b03da72 1541When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
007852e0
RS
1542when called interactively, non-corrective messages are suppressed.
1543
b9431ae0
RS
1544With a prefix argument (or if CONTINUE is non-nil),
1545resume interrupted spell-checking of a buffer or region.
1546
69f5930a
JL
1547Interactively, in Transient Mark mode when the mark is active, call
1548`ispell-region' to check the active region for spelling errors.
1549
a6e7a34b
RS
1550Word syntax is controlled by the definition of the chosen dictionary,
1551which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'.
007852e0
RS
1552
1553This will check or reload the dictionary. Use \\[ispell-change-dictionary]
9050446c
GM
1554or \\[ispell-region] to update the Ispell process.
1555
b11a1b2e 1556Return values:
4d170362 1557nil word is correct or spelling is accepted.
9050446c
GM
15580 word is inserted into buffer-local definitions.
1559\"word\" word corrected from word list.
1560\(\"word\" arg\) word is hand entered.
1561quit spell session exited."
69f5930a 1562 (interactive (list ispell-following-word ispell-quietly current-prefix-arg t))
75662d96 1563 (cond
69f5930a 1564 ((and region transient-mark-mode mark-active
75662d96
JL
1565 (not (eq (region-beginning) (region-end))))
1566 (ispell-region (region-beginning) (region-end)))
1567 (continue (ispell-continue))
1568 (t
966a7f49 1569 (ispell-maybe-find-aspell-dictionaries)
e29702dd 1570 (ispell-accept-buffer-local-defs) ; use the correct dictionary
9e7ad89a 1571 (let ((cursor-location (point)) ; retain cursor location
9e7ad89a 1572 (word (ispell-get-word following))
f5136913
RS
1573 start end poss new-word replace)
1574 ;; De-structure return word info list.
1575 (setq start (car (cdr word))
1576 end (car (cdr (cdr word)))
1577 word (car word))
1578
f0a1f8bd
RS
1579 ;; At this point it used to ignore 2-letter words.
1580 ;; But that is silly; if the user asks for it, we should do it. - rms.
1581 (or quietly
1582 (message "Checking spelling of %s..."
41d207e1 1583 (funcall ispell-format-word-function word)))
f0a1f8bd
RS
1584 (ispell-send-string "%\n") ; put in verbose mode
1585 (ispell-send-string (concat "^" word "\n"))
1586 ;; wait until ispell has processed word
1587 (while (progn
1588 (ispell-accept-output)
1589 (not (string= "" (car ispell-filter)))))
1590 ;;(ispell-send-string "!\n") ;back to terse mode.
1591 (setq ispell-filter (cdr ispell-filter)) ; remove extra \n
1592 (if (and ispell-filter (listp ispell-filter))
1593 (if (> (length ispell-filter) 1)
1594 (error "Ispell and its process have different character maps")
1595 (setq poss (ispell-parse-output (car ispell-filter)))))
1596 (cond ((eq poss t)
1597 (or quietly
1598 (message "%s is correct"
41d207e1 1599 (funcall ispell-format-word-function word)))
a445370f 1600 (and (featurep 'xemacs)
f0a1f8bd 1601 (extent-at start)
e7cdb3e0
RS
1602 (and (fboundp 'delete-extent)
1603 (delete-extent (extent-at start)))))
f0a1f8bd
RS
1604 ((stringp poss)
1605 (or quietly
1606 (message "%s is correct because of root %s"
41d207e1
RW
1607 (funcall ispell-format-word-function word)
1608 (funcall ispell-format-word-function poss)))
a445370f 1609 (and (featurep 'xemacs)
f0a1f8bd 1610 (extent-at start)
e7cdb3e0
RS
1611 (and (fboundp 'delete-extent)
1612 (delete-extent (extent-at start)))))
f0a1f8bd
RS
1613 ((null poss) (message "Error in ispell process"))
1614 (ispell-check-only ; called from ispell minor mode.
1615 (if (fboundp 'make-extent)
e7cdb3e0
RS
1616 (if (fboundp 'set-extent-property)
1617 (let ((ext (make-extent start end)))
1618 (set-extent-property ext 'face ispell-highlight-face)
1619 (set-extent-property ext 'priority 2000)))
f0a1f8bd 1620 (beep)
41d207e1
RW
1621 (message "%s is incorrect"
1622 (funcall ispell-format-word-function word))))
f0a1f8bd
RS
1623 (t ; prompt for correct word.
1624 (save-window-excursion
1625 (setq replace (ispell-command-loop
1626 (car (cdr (cdr poss)))
1627 (car (cdr (cdr (cdr poss))))
1628 (car poss) start end)))
1629 (cond ((equal 0 replace)
1630 (ispell-add-per-file-word-list (car poss)))
1631 (replace
1632 (setq new-word (if (atom replace) replace (car replace))
1633 cursor-location (+ (- (length word) (- end start))
1634 cursor-location))
1635 (if (not (equal new-word (car poss)))
1636 (progn
76a47494
RS
1637 (goto-char start)
1638 ;; Insert first and then delete,
1639 ;; to avoid collapsing markers before and after
1640 ;; into a single place.
f0a1f8bd 1641 (ispell-insert-word new-word)
64953c0a 1642 (delete-region (point) end)
76a47494
RS
1643 ;; It is meaningless to preserve the cursor position
1644 ;; inside a word that has changed.
1645 (setq cursor-location (point))
f0a1f8bd
RS
1646 (setq end (point))))
1647 (if (not (atom replace)) ;recheck spelling of replacement
1648 (progn
1649 (if (car (cdr replace)) ; query replace requested
1650 (save-window-excursion
1651 (query-replace word new-word t)))
1652 (goto-char start)
1653 ;; single word could be split into multiple words
1654 (setq ispell-quit (not (ispell-region start end)))
1655 ))))
1656 ;; keep if rechecking word and we keep choices win.
1657 (if (get-buffer ispell-choices-buffer)
1658 (kill-buffer ispell-choices-buffer))))
1659 (ispell-pdict-save ispell-silently-savep)
1660 ;; NB: Cancels ispell-quit incorrectly if called from ispell-region
edfa1c2e 1661 (if ispell-quit (setq ispell-quit nil replace 'quit))
9050446c 1662 (goto-char cursor-location) ; return to original location
75662d96 1663 replace))))
007852e0
RS
1664
1665
1666(defun ispell-get-word (following &optional extra-otherchars)
1667 "Return the word for spell-checking according to ispell syntax.
3ee3ac77 1668If optional argument FOLLOWING is non-nil or if `ispell-following-word'
007852e0 1669is non-nil when called interactively, then the following word
e29702dd 1670\(rather than preceding\) is checked when the cursor is not over a word.
4b03da72 1671Optional second argument contains otherchars that can be included in word
007852e0
RS
1672many times.
1673
a6e7a34b
RS
1674Word syntax is controlled by the definition of the chosen dictionary,
1675which is in `ispell-local-dictionary-alist' or `ispell-dictionary-alist'."
007852e0
RS
1676 (let* ((ispell-casechars (ispell-get-casechars))
1677 (ispell-not-casechars (ispell-get-not-casechars))
1678 (ispell-otherchars (ispell-get-otherchars))
1679 (ispell-many-otherchars-p (ispell-get-many-otherchars-p))
1680 (word-regexp (concat ispell-casechars
1681 "+\\("
f5136913
RS
1682 (if (not (string= "" ispell-otherchars))
1683 (concat ispell-otherchars "?"))
007852e0
RS
1684 (if extra-otherchars
1685 (concat extra-otherchars "?"))
1686 ispell-casechars
1687 "+\\)"
1688 (if (or ispell-many-otherchars-p
1689 extra-otherchars)
1690 "*" "?")))
f5136913 1691 did-it-once prevpt
007852e0
RS
1692 start end word)
1693 ;; find the word
1694 (if (not (looking-at ispell-casechars))
1695 (if following
1696 (re-search-forward ispell-casechars (point-max) t)
1697 (re-search-backward ispell-casechars (point-min) t)))
1698 ;; move to front of word
1699 (re-search-backward ispell-not-casechars (point-min) 'start)
f5136913
RS
1700 (while (and (or (and (not (string= "" ispell-otherchars))
1701 (looking-at ispell-otherchars))
007852e0
RS
1702 (and extra-otherchars (looking-at extra-otherchars)))
1703 (not (bobp))
1704 (or (not did-it-once)
f5136913
RS
1705 ispell-many-otherchars-p)
1706 (not (eq prevpt (point))))
007852e0
RS
1707 (if (and extra-otherchars (looking-at extra-otherchars))
1708 (progn
1709 (backward-char 1)
1710 (if (looking-at ispell-casechars)
1711 (re-search-backward ispell-not-casechars (point-min) 'move)))
f5136913
RS
1712 (setq did-it-once t
1713 prevpt (point))
007852e0
RS
1714 (backward-char 1)
1715 (if (looking-at ispell-casechars)
1716 (re-search-backward ispell-not-casechars (point-min) 'move)
1717 (backward-char -1))))
1718 ;; Now mark the word and save to string.
909f0455
RS
1719 (if (not (re-search-forward word-regexp (point-max) t))
1720 (if ispell-check-only
f5136913 1721 ;; return dummy word when just flagging misspellings
909f0455
RS
1722 (list "" (point) (point))
1723 (error "No word found to check!"))
64953c0a
RS
1724 (setq start (copy-marker (match-beginning 0))
1725 end (point-marker)
909f0455
RS
1726 word (buffer-substring-no-properties start end))
1727 (list word start end))))
007852e0
RS
1728
1729
1730;;; Global ispell-pdict-modified-p is set by ispell-command-loop and
1731;;; tracks changes in the dictionary. The global may either be
1732;;; a value or a list, whose value is the state of whether the
1733;;; dictionary needs to be saved.
1734
23b809c2 1735;;;###autoload
007852e0
RS
1736(defun ispell-pdict-save (&optional no-query force-save)
1737 "Check to see if the personal dictionary has been modified.
3ee3ac77 1738If so, ask if it needs to be saved."
007852e0
RS
1739 (interactive (list ispell-silently-savep t))
1740 (if (and ispell-pdict-modified-p (listp ispell-pdict-modified-p))
1741 (setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
1742 (if (or ispell-pdict-modified-p force-save)
1743 (if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
1335d078 1744 (progn
8eba343c 1745 (ispell-send-string "#\n") ; save dictionary
1335d078 1746 (message "Personal dictionary saved."))))
007852e0
RS
1747 ;; unassert variable, even if not saved to avoid questioning.
1748 (setq ispell-pdict-modified-p nil))
1749
1750
29aec366 1751(defun ispell-command-loop (miss guess word start end)
007852e0
RS
1752 "Display possible corrections from list MISS.
1753GUESS lists possibly valid affix construction of WORD.
1754Returns nil to keep word.
4b03da72
RS
1755Returns 0 to insert locally into buffer-local dictionary.
1756Returns string for new chosen word.
1757Returns list for new replacement word (will be rechecked).
f5136913
RS
1758 Query-replace when list length is 2.
1759 Automatic query-replace when second element is `query-replace'.
29aec366 1760Highlights the word, which is assumed to run from START to END.
3ee3ac77
RS
1761Global `ispell-pdict-modified-p' becomes a list where the only value
1762indicates whether the dictionary has been modified when option `a' or `i' is
f5136913
RS
1763used.
1764Global `ispell-quit' set to start location to continue spell session."
9050446c 1765 (let ((count ?0)
24b0afdc 1766 (line ispell-choices-win-default-height)
47a9f362
MB
1767 ;; ensure 4 context lines.
1768 (max-lines (- (ispell-adjusted-window-height) 4))
e29702dd
KH
1769 (choices miss)
1770 (window-min-height (min window-min-height
24b0afdc 1771 ispell-choices-win-default-height))
e29702dd 1772 (command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
8896f22d 1773 (dedicated (window-dedicated-p (selected-window)))
f5136913 1774 (skipped 0)
9050446c 1775 char num result textwin dedicated-win)
e29702dd
KH
1776
1777 ;; setup the *Choices* buffer with valid data.
1778 (save-excursion
1779 (set-buffer (get-buffer-create ispell-choices-buffer))
4a65d2b3
JL
1780 (setq mode-line-format
1781 (concat "-- %b -- word: " word
1782 " -- dict: " (or ispell-current-dictionary "default")
1783 " -- prog: " (file-name-nondirectory ispell-program-name)))
4d170362 1784 ;; XEmacs: no need for horizontal scrollbar in choices window
6063ae55
RS
1785 (with-no-warnings
1786 (and (fboundp 'set-specifier)
1787 (boundp 'horizontal-scrollbar-visible-p)
1788 (set-specifier horizontal-scrollbar-visible-p nil
1789 (cons (current-buffer) nil))))
e29702dd
KH
1790 (erase-buffer)
1791 (if guess
1792 (progn
1793 (insert "Affix rules generate and capitalize "
1794 "this word as shown below:\n\t")
1795 (while guess
1796 (if (> (+ 4 (current-column) (length (car guess)))
1797 (window-width))
1798 (progn
1799 (insert "\n\t")
1800 (setq line (1+ line))))
1801 (insert (car guess) " ")
1802 (setq guess (cdr guess)))
d27a3d16 1803 (insert "\nUse option `i' to accept this spelling and put it in your private dictionary.")
e29702dd
KH
1804 (setq line (+ line (if choices 3 2)))))
1805 (while (and choices
1806 (< (if (> (+ 7 (current-column) (length (car choices))
1807 (if (> count ?~) 3 0))
1808 (window-width))
1809 (progn
1810 (insert "\n")
1811 (setq line (1+ line)))
1812 line)
1813 max-lines))
1814 ;; not so good if there are over 20 or 30 options, but then, if
1815 ;; there are that many you don't want to scan them all anyway...
1816 (while (memq count command-characters) ; skip command characters.
f5136913 1817 (setq count (ispell-int-char (1+ count))
e29702dd
KH
1818 skipped (1+ skipped)))
1819 (insert "(" count ") " (car choices) " ")
1820 (setq choices (cdr choices)
f5136913
RS
1821 count (ispell-int-char (1+ count))))
1822 (setq count (ispell-int-char (- count ?0 skipped))))
e29702dd 1823
8eba343c 1824 ;; ensure word is visible
e29702dd
KH
1825 (if (not (pos-visible-in-window-p end))
1826 (sit-for 0))
fea6948a 1827
f5136913
RS
1828 ;; allow temporary split of dedicated windows...
1829 (if dedicated
1830 (progn
1831 (setq dedicated-win (selected-window))
1832 (set-window-dedicated-p dedicated-win nil)))
1833
e29702dd 1834 ;; Display choices for misspelled word.
f5136913 1835 (ispell-show-choices line end)
e29702dd
KH
1836 (select-window (setq textwin (next-window)))
1837
1838 ;; highlight word, protecting current buffer status
29aec366 1839 (unwind-protect
e29702dd 1840 (progn
f5136913
RS
1841 (and ispell-highlight-p
1842 (ispell-highlight-spelling-error start end t))
e29702dd 1843 ;; Loop until a valid choice is made.
29aec366
RS
1844 (while
1845 (eq
1846 t
1847 (setq
1848 result
1849 (progn
1850 (undo-boundary)
ab9d539c
KH
1851 (let (message-log-max)
1852 (message (concat "C-h or ? for more options; SPC to leave "
1853 "unchanged, Character to replace word")))
29aec366
RS
1854 (let ((inhibit-quit t))
1855 (setq char (if (fboundp 'read-char-exclusive)
1856 (read-char-exclusive)
1857 (read-char))
1858 skipped 0)
1859 (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
1860 (setq char ?X
1861 quit-flag nil)))
1862 ;; Adjust num to array offset skipping command characters.
1863 (let ((com-chars command-characters))
1864 (while com-chars
1865 (if (and (> (car com-chars) ?0) (< (car com-chars) char))
1866 (setq skipped (1+ skipped)))
1867 (setq com-chars (cdr com-chars)))
1868 (setq num (- char ?0 skipped)))
1869
1870 (cond
e29702dd 1871 ((= char ? ) nil) ; accept word this time only
29aec366 1872 ((= char ?i) ; accept and insert word into pers dict
8eba343c 1873 (ispell-send-string (concat "*" word "\n"))
29aec366
RS
1874 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1875 nil)
1876 ((or (= char ?a) (= char ?A)) ; accept word without insert
8eba343c 1877 (ispell-send-string (concat "@" word "\n"))
29aec366
RS
1878 (if (null ispell-pdict-modified-p)
1879 (setq ispell-pdict-modified-p
1880 (list ispell-pdict-modified-p)))
1881 (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
1882 ((or (= char ?r) (= char ?R)) ; type in replacement
f5136913
RS
1883 (and (eq 'block ispell-highlight-p) ; refresh tty's
1884 (ispell-highlight-spelling-error start end nil t))
1885 (let ((result
1886 (if (or (= char ?R) ispell-query-replace-choices)
9050446c
GM
1887 (list (read-string
1888 (format "Query-replacement for %s: "word)
1889 word)
1890 t)
f5136913
RS
1891 (cons (read-string "Replacement for: " word)
1892 nil))))
1893 (and (eq 'block ispell-highlight-p)
1894 (ispell-highlight-spelling-error start end nil
1895 'block))
1896 result))
29aec366 1897 ((or (= char ??) (= char help-char) (= char ?\C-h))
f5136913
RS
1898 (and (eq 'block ispell-highlight-p)
1899 (ispell-highlight-spelling-error start end nil t))
29aec366 1900 (ispell-help)
f5136913
RS
1901 (and (eq 'block ispell-highlight-p)
1902 (ispell-highlight-spelling-error start end nil
1903 'block))
29aec366
RS
1904 t)
1905 ;; Quit and move point back.
1906 ((= char ?x)
1907 (ispell-pdict-save ispell-silently-savep)
1908 (message "Exited spell-checking")
1909 (setq ispell-quit t)
1910 nil)
1911 ;; Quit and preserve point.
1912 ((= char ?X)
1913 (ispell-pdict-save ispell-silently-savep)
10ba4783 1914 (message "%s"
29aec366
RS
1915 (substitute-command-keys
1916 (concat "Spell-checking suspended;"
1917 " use C-u \\[ispell-word] to resume")))
f5136913 1918 (setq ispell-quit start)
29aec366
RS
1919 nil)
1920 ((= char ?q)
1921 (if (y-or-n-p "Really kill Ispell process? ")
1922 (progn
1923 (ispell-kill-ispell t) ; terminate process.
1924 (setq ispell-quit (or (not ispell-checking-message)
1925 (point))
1926 ispell-pdict-modified-p nil))
e29702dd 1927 t)) ; continue if they don't quit.
29aec366 1928 ((= char ?l)
f5136913
RS
1929 (and (eq 'block ispell-highlight-p) ; refresh tty displays
1930 (ispell-highlight-spelling-error start end nil t))
29aec366
RS
1931 (let ((new-word (read-string
1932 "Lookup string (`*' is wildcard): "
9050446c 1933 word)))
29aec366 1934 (if new-word
007852e0 1935 (progn
29aec366
RS
1936 (save-excursion
1937 (set-buffer (get-buffer-create
1938 ispell-choices-buffer))
1939 (erase-buffer)
1940 (setq count ?0
1941 skipped 0
4a65d2b3
JL
1942 mode-line-format
1943 (concat "-- %b -- word: " new-word
1944 " -- dict: "
1945 ispell-alternate-dictionary)
29aec366 1946 miss (lookup-words new-word)
9050446c 1947 choices miss
24b0afdc 1948 line ispell-choices-win-default-height)
29aec366
RS
1949 (while (and choices ; adjust choices window.
1950 (< (if (> (+ 7 (current-column)
1951 (length (car choices))
1952 (if (> count ?~) 3 0))
1953 (window-width))
1954 (progn
1955 (insert "\n")
9050446c
GM
1956 (setq line (1+ line)))
1957 line)
29aec366
RS
1958 max-lines))
1959 (while (memq count command-characters)
f5136913 1960 (setq count (ispell-int-char (1+ count))
29aec366
RS
1961 skipped (1+ skipped)))
1962 (insert "(" count ") " (car choices) " ")
1963 (setq choices (cdr choices)
f5136913
RS
1964 count (ispell-int-char (1+ count))))
1965 (setq count (ispell-int-char
1966 (- count ?0 skipped))))
9050446c 1967 (ispell-show-choices line end)
29aec366 1968 (select-window (next-window)))))
f5136913
RS
1969 (and (eq 'block ispell-highlight-p)
1970 (ispell-highlight-spelling-error start end nil
1971 'block))
29aec366 1972 t) ; reselect from new choices
6fdf40f3 1973 ((= char ?u) ; insert lowercase into dictionary
8eba343c 1974 (ispell-send-string (concat "*" (downcase word) "\n"))
29aec366
RS
1975 (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
1976 nil)
1977 ((= char ?m) ; type in what to insert
8eba343c
EZ
1978 (ispell-send-string
1979 (concat "*" (read-string "Insert: " word) "\n"))
29aec366
RS
1980 (setq ispell-pdict-modified-p '(t))
1981 (cons word nil))
1982 ((and (>= num 0) (< num count))
1983 (if ispell-query-replace-choices ; Query replace flag
1984 (list (nth num miss) 'query-replace)
1985 (nth num miss)))
1986 ((= char ?\C-l)
1987 (redraw-display) t)
1988 ((= char ?\C-r)
9050446c 1989 ;; This may have alignment errors if current line is edited
f5136913
RS
1990 (if (marker-position ispell-recursive-edit-marker)
1991 (progn
1992 (message "Only one recursive edit session supported")
9050446c
GM
1993 (beep)
1994 (sit-for 2))
f5136913
RS
1995 (set-marker ispell-recursive-edit-marker start)
1996 ;;(set-marker ispell-region-end reg-end)
1997 (and ispell-highlight-p ; unhighlight
1998 (ispell-highlight-spelling-error start end))
1999 (unwind-protect
2000 (progn
9050446c
GM
2001 (message
2002 "%s"
2003 (substitute-command-keys
2004 (concat "Exit recursive edit with"
2005 " \\[exit-recursive-edit]")))
f5136913 2006 (save-window-excursion (save-excursion
9050446c
GM
2007 (recursive-edit))))
2008 ;; protected
2009 (goto-char ispell-recursive-edit-marker)
2010 (if (not (equal (marker-buffer
2011 ispell-recursive-edit-marker)
2012 (current-buffer)))
2013 (progn
2014 (set-marker ispell-recursive-edit-marker nil)
2015 (error
2016 "Cannot continue ispell from this buffer.")))
f5136913 2017 (set-marker ispell-recursive-edit-marker nil)))
9050446c 2018 (list word nil)) ; recheck starting at this word.
29aec366
RS
2019 ((= char ?\C-z)
2020 (funcall (key-binding "\C-z"))
2021 t)
2022 (t (ding) t))))))
2023 result)
e29702dd 2024 ;; protected
f5136913
RS
2025 (and ispell-highlight-p ; unhighlight
2026 (save-window-excursion
2027 (select-window textwin)
2028 (ispell-highlight-spelling-error start end)))
2029 (if dedicated
2030 (set-window-dedicated-p dedicated-win t)))))
2031
2032
2033
2034(defun ispell-show-choices (line end)
2035 "Shows the choices in another buffer or frame."
9050446c 2036 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
f5136913
RS
2037 (progn
2038 (framepop-display-buffer (get-buffer ispell-choices-buffer))
6063ae55 2039;;; (get-buffer-window ispell-choices-buffer t)
f5136913
RS
2040 (select-window (previous-window))) ; *Choices* window
2041 ;; standard selection by splitting a small buffer out of this window.
2042 (let ((choices-window (get-buffer-window ispell-choices-buffer)))
2043 (if choices-window
47a9f362 2044 (if (= line (ispell-adjusted-window-height choices-window))
f5136913
RS
2045 (select-window choices-window)
2046 ;; *Choices* window changed size. Adjust the choices window
2047 ;; without scrolling the spelled window when possible
47a9f362
MB
2048 (let ((window-line
2049 (- line (ispell-adjusted-window-height choices-window)))
f5136913 2050 (visible (progn (vertical-motion -1) (point))))
24b0afdc 2051 (if (< line ispell-choices-win-default-height)
f5136913 2052 (setq window-line (+ window-line
24b0afdc 2053 (- ispell-choices-win-default-height
f5136913
RS
2054 line))))
2055 (move-to-window-line 0)
2056 (vertical-motion window-line)
2057 (set-window-start (selected-window)
2058 (if (> (point) visible) visible (point)))
2059 (goto-char end)
4d170362 2060 (select-window choices-window)
f5136913
RS
2061 (enlarge-window window-line)))
2062 ;; Overlay *Choices* window when it isn't showing
24b0afdc 2063 (ispell-overlay-window (max line ispell-choices-win-default-height)))
f5136913
RS
2064 (switch-to-buffer ispell-choices-buffer)
2065 (goto-char (point-min)))))
007852e0
RS
2066
2067
829b9e73 2068;;;###autoload
007852e0 2069(defun ispell-help ()
3ee3ac77 2070 "Display a list of the options available when a misspelling is encountered.
007852e0
RS
2071
2072Selections are:
2073
2074DIGIT: Replace the word with a digit offered in the *Choices* buffer.
a9210a53
RS
2075SPC: Accept word this time.
2076`i': Accept word and insert into private dictionary.
2077`a': Accept word for this session.
2078`A': Accept word and place in `buffer-local dictionary'.
2079`r': Replace word with typed-in value. Rechecked.
2080`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2081`?': Show these commands.
2082`x': Exit spelling buffer. Move cursor to original point.
2083`X': Exit spelling buffer. Leaves cursor at the current point, and permits
007852e0 2084 the aborted check to be completed later.
a9210a53
RS
2085`q': Quit spelling session (Kills ispell process).
2086`l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2087`u': Like `i', but the word is lower-cased first.
f5136913 2088`m': Place typed-in value in personal dictionary, then recheck current word.
b11a1b2e
JB
2089`C-l': Redraw screen.
2090`C-r': Recursive edit.
2091`C-z': Suspend Emacs or iconify frame."
007852e0 2092
f5136913
RS
2093 (if (equal ispell-help-in-bufferp 'electric)
2094 (progn
2095 (require 'ehelp)
fea6948a 2096 (with-electric-help
f5136913
RS
2097 (function (lambda ()
2098 ;;This shouldn't be necessary: with-electric-help needs
2099 ;; an optional argument telling it about the smallest
2100 ;; acceptable window-height of the help buffer.
4d170362
SM
2101 ;;(if (< (window-height) 15)
2102 ;; (enlarge-window
2103 ;; (- 15 (ispell-adjusted-window-height))))
f5136913
RS
2104 (princ "Selections are:
2105
2106DIGIT: Replace the word with a digit offered in the *Choices* buffer.
2107SPC: Accept word this time.
2108`i': Accept word and insert into private dictionary.
2109`a': Accept word for this session.
2110`A': Accept word and place in `buffer-local dictionary'.
2111`r': Replace word with typed-in value. Rechecked.
2112`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
2113`?': Show these commands.
2114`x': Exit spelling buffer. Move cursor to original point.
2115`X': Exit spelling buffer. Leaves cursor at the current point, and permits
2116 the aborted check to be completed later.
2117`q': Quit spelling session (Kills ispell process).
2118`l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
2119`u': Like `i', but the word is lower-cased first.
2120`m': Place typed-in value in personal dictionary, then recheck current word.
b11a1b2e
JB
2121`C-l': Redraw screen.
2122`C-r': Recursive edit.
2123`C-z': Suspend Emacs or iconify frame.")
2124 nil))))
f5136913
RS
2125
2126
2127 (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
2128 "[i]nsert into private dictionary"))
2129 (help-2 (concat "[l]ook a word up in alternate dictionary; "
2130 "e[x/X]it; [q]uit session"))
2131 (help-3 (concat "[u]ncapitalized insert into dict. "
b3955f8d 2132 "Type 'x C-h f ispell-help' for more help")))
f5136913
RS
2133 (save-window-excursion
2134 (if ispell-help-in-bufferp
2135 (progn
24b0afdc 2136 (ispell-overlay-window 4)
f5136913
RS
2137 (switch-to-buffer (get-buffer-create "*Ispell Help*"))
2138 (insert (concat help-1 "\n" help-2 "\n" help-3))
2139 (sit-for 5)
2140 (kill-buffer "*Ispell Help*"))
41b495af 2141 (unwind-protect
56351784 2142 (let ((resize-mini-windows 'grow-only))
41b495af
RS
2143 (select-window (minibuffer-window))
2144 (erase-buffer)
2145 (message nil)
2146 ;;(set-minibuffer-window (selected-window))
2147 (enlarge-window 2)
2148 (insert (concat help-1 "\n" help-2 "\n" help-3))
2149 (sit-for 5))
2150 (erase-buffer)))))))
007852e0
RS
2151
2152
2153(defun lookup-words (word &optional lookup-dict)
b9431ae0 2154 "Look up WORD in optional word-list dictionary LOOKUP-DICT.
4b03da72
RS
2155A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
2156Otherwise the variable `ispell-grep-command' contains the command used to
2157search for the words (usually egrep).
2158
3ee3ac77 2159Optional second argument contains the dictionary to use; the default is
4b03da72 2160`ispell-alternate-dictionary'."
007852e0
RS
2161 ;; We don't use the filter for this function, rather the result is written
2162 ;; into a buffer. Hence there is no need to save the filter values.
2163 (if (null lookup-dict)
2164 (setq lookup-dict ispell-alternate-dictionary))
2165
2166 (let* ((process-connection-type ispell-use-ptys-p)
2167 (wild-p (string-match "\\*" word))
2168 (look-p (and ispell-look-p ; Only use look for an exact match.
2169 (or ispell-have-new-look (not wild-p))))
2170 (ispell-grep-buffer (get-buffer-create "*Ispell-Temp*")) ; result buf
2171 (prog (if look-p ispell-look-command ispell-grep-command))
2172 (args (if look-p ispell-look-options ispell-grep-options))
2173 status results loc)
2174 (unwind-protect
2175 (save-window-excursion
2176 (message "Starting \"%s\" process..." (file-name-nondirectory prog))
2177 (set-buffer ispell-grep-buffer)
2178 (if look-p
2179 nil
2180 ;; convert * to .*
2181 (insert "^" word "$")
2182 (while (search-backward "*" nil t) (insert "."))
2183 (setq word (buffer-string))
2184 (erase-buffer))
bc4c6633 2185 (setq status (apply 'ispell-call-process prog nil t nil
7924c5df
RS
2186 (nconc (if (and args (> (length args) 0))
2187 (list args)
2188 (if look-p nil
2189 (list "-e")))
2190 (list word)
2191 (if lookup-dict (list lookup-dict)))))
007852e0
RS
2192 ;; grep returns status 1 and no output when word not found, which
2193 ;; is a perfectly normal thing.
2194 (if (stringp status)
2195 (setq results (cons (format "error: %s exited with signal %s"
2196 (file-name-nondirectory prog) status)
2197 results))
2198 ;; else collect words into `results' in FIFO order
2199 (goto-char (point-max))
2200 ;; assure we've ended with \n
2201 (or (bobp) (= (preceding-char) ?\n) (insert ?\n))
2202 (while (not (bobp))
2203 (setq loc (point))
2204 (forward-line -1)
f5136913
RS
2205 (setq results (cons (buffer-substring-no-properties (point)
2206 (1- loc))
007852e0
RS
2207 results)))))
2208 ;; protected
2209 (kill-buffer ispell-grep-buffer)
2210 (if (and results (string-match ".+: " (car results)))
2211 (error "%s error: %s" ispell-grep-command (car results))))
2212 results))
2213
2214
2215;;; "ispell-filter" is a list of output lines from the generating function.
2216;;; Each full line (ending with \n) is a separate item on the list.
2217;;; "output" can contain multiple lines, part of a line, or both.
2218;;; "start" and "end" are used to keep bounds on lines when "output" contains
2219;;; multiple lines.
2220;;; "ispell-filter-continue" is true when we have received only part of a
2221;;; line as output from a generating function ("output" did not end with \n)
a7acbbe4 2222;;; THIS FUNCTION WILL FAIL IF THE PROCESS OUTPUT DOESN'T END WITH \n!
007852e0
RS
2223;;; This is the case when a process dies or fails. The default behavior
2224;;; in this case treats the next input received as fresh input.
2225
2226(defun ispell-filter (process output)
2227 "Output filter function for ispell, grep, and look."
2228 (let ((start 0)
2229 (continue t)
2230 end)
2231 (while continue
2232 (setq end (string-match "\n" output start)) ; get text up to the newline.
2233 ;; If we get out of sync and ispell-filter-continue is asserted when we
2234 ;; are not continuing, treat the next item as a separate list. When
2235 ;; ispell-filter-continue is asserted, ispell-filter *should* always be a
2236 ;; list!
2237
2238 ;; Continue with same line (item)?
2239 (if (and ispell-filter-continue ispell-filter (listp ispell-filter))
2240 ;; Yes. Add it to the prev item
2241 (setcar ispell-filter
2242 (concat (car ispell-filter) (substring output start end)))
2243 ;; No. This is a new line and item.
2244 (setq ispell-filter
2245 (cons (substring output start end) ispell-filter)))
2246 (if (null end)
2247 ;; We've completed reading the output, but didn't finish the line.
2248 (setq ispell-filter-continue t continue nil)
2249 ;; skip over newline, this line complete.
2250 (setq ispell-filter-continue nil end (1+ end))
2251 (if (= end (length output)) ; No more lines in output
2252 (setq continue nil) ; so we can exit the filter.
2253 (setq start end)))))) ; else move start to next line of input
2254
2255
2256;;; This function destroys the mark location if it is in the word being
2257;;; highlighted.
f5136913
RS
2258(defun ispell-highlight-spelling-error-generic (start end &optional highlight
2259 refresh)
3ee3ac77
RS
2260 "Highlight the word from START to END with a kludge using `inverse-video'.
2261When the optional third arg HIGHLIGHT is set, the word is highlighted;
f5136913 2262otherwise it is displayed normally.
5755be32 2263Uses block cursor to highlight one character.
f5136913
RS
2264Optional REFRESH will unhighlighted then highlight, using block cursor
2265 highlighting when REFRESH is equal to `block'."
2266 (and (eq 'block ispell-highlight-p)
2267 (or (eq 'block refresh)
2268 (setq start (1+ start)))) ; On block non-refresh, inc start.
007852e0
RS
2269 (let ((modified (buffer-modified-p)) ; don't allow this fn to modify buffer
2270 (buffer-read-only nil) ; Allow highlighting read-only buffers.
f5136913 2271 (text (buffer-substring-no-properties start end)) ; Save hilight region
007852e0 2272 (inhibit-quit t) ; inhibit interrupt processing here.
29aec366 2273 (buffer-undo-list t)) ; don't clutter the undo list.
f5136913 2274 (goto-char end)
007852e0 2275 (delete-region start end)
a7acbbe4 2276 (insert-char ? (- end start)) ; minimize amount of redisplay
007852e0
RS
2277 (sit-for 0) ; update display
2278 (if highlight (setq inverse-video (not inverse-video))) ; toggle video
2279 (delete-region start end) ; delete whitespace
2280 (insert text) ; insert text in inverse video.
2281 (sit-for 0) ; update display showing inverse video.
f5136913
RS
2282 (if (not highlight)
2283 (goto-char end)
2284 (setq inverse-video (not inverse-video)) ; toggle video
2285 (and (eq 'block ispell-highlight-p)
2286 (goto-char (1- start)))) ; use block cursor to "highlight" char
2287 (set-buffer-modified-p modified) ; don't modify if flag not set.
2288 (and refresh ; re-highlight
2289 (ispell-highlight-spelling-error-generic
2290 (if (eq 'block refresh) start (- start 2)) end t))))
2291
2292
2293(defun ispell-highlight-spelling-error-xemacs (start end &optional highlight)
3ee3ac77 2294 "Highlight the word from START to END using `isearch-highlight'.
e29702dd 2295When the optional third arg HIGHLIGHT is set, the word is highlighted,
007852e0
RS
2296otherwise it is displayed normally."
2297 (if highlight
2298 (isearch-highlight start end)
1332f1a0 2299 (isearch-dehighlight))
007852e0
RS
2300 ;;(sit-for 0)
2301 )
2302
2303
4b03da72 2304(defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
3ee3ac77
RS
2305 "Highlight the word from START to END using overlays.
2306When the optional third arg HIGHLIGHT is set, the word is highlighted
2307otherwise it is displayed normally.
4b03da72 2308
a9210a53 2309The variable `ispell-highlight-face' selects the face to use for highlighting."
007852e0 2310 (if highlight
9bb3de4b
JL
2311 (if ispell-overlay
2312 (move-overlay ispell-overlay start end (current-buffer))
007852e0 2313 (setq ispell-overlay (make-overlay start end))
9bb3de4b 2314 (overlay-put ispell-overlay 'priority 1001) ;higher than lazy overlays
007852e0 2315 (overlay-put ispell-overlay 'face ispell-highlight-face))
9bb3de4b
JL
2316 (if ispell-overlay
2317 (delete-overlay ispell-overlay)))
1332f1a0
JL
2318 (if (and ispell-lazy-highlight (boundp 'lazy-highlight-cleanup))
2319 (if highlight
2320 (let ((isearch-string
2321 (concat
2322 "\\b"
2323 (regexp-quote (buffer-substring-no-properties start end))
2324 "\\b"))
2325 (isearch-regexp t)
2326 (isearch-case-fold-search nil))
2327 (isearch-lazy-highlight-new-loop
2328 (if (boundp 'reg-start) reg-start)
2329 (if (boundp 'reg-end) reg-end)))
2330 (lazy-highlight-cleanup lazy-highlight-cleanup)
2331 (setq isearch-lazy-highlight-last-string nil))))
007852e0
RS
2332
2333
f5136913 2334(defun ispell-highlight-spelling-error (start end &optional highlight refresh)
29aec366 2335 (cond
877d353a 2336 ((featurep 'xemacs)
f5136913 2337 (ispell-highlight-spelling-error-xemacs start end highlight))
bb41818d 2338 ((and (featurep 'faces)
3b5fab87
EZ
2339 (or (and (fboundp 'display-color-p) (display-color-p))
2340 window-system))
29aec366 2341 (ispell-highlight-spelling-error-overlay start end highlight))
f5136913 2342 (t (ispell-highlight-spelling-error-generic start end highlight refresh))))
007852e0 2343
47a9f362
MB
2344(defun ispell-adjusted-window-height (&optional window)
2345 "Like `window-height', adjusted to correct for the effect of tall mode-lines.
2346The value returned is actually the nominal number of text-lines in the
2347window plus 1. On a terminal, this is the same value returned by
2348`window-height', but if the window has a mode-line is taller than a normal
2349text line, the returned value may be smaller than that from
2350`window-height'."
2351 (cond ((fboundp 'window-text-height)
2352 (1+ (window-text-height window)))
4d170362
SM
2353 ((or (and (fboundp 'display-graphic-p) (display-graphic-p))
2354 (and (featurep 'xemacs) window-system))
47a9f362
MB
2355 (1- (window-height window)))
2356 (t
2357 (window-height window))))
e29702dd 2358
007852e0 2359(defun ispell-overlay-window (height)
3ee3ac77
RS
2360 "Create a window covering the top HEIGHT lines of the current window.
2361Ensure that the line above point is still visible but otherwise avoid
045dbcbc 2362scrolling the current window. Leave the new window selected."
007852e0 2363 (save-excursion
24b0afdc 2364 (let ((oldot (save-excursion (vertical-motion -1) (point)))
007852e0 2365 (top (save-excursion (move-to-window-line height) (point))))
6fdf40f3 2366 ;; If line above old point (line starting at oldot) would be
007852e0
RS
2367 ;; hidden by new window, scroll it to just below new win
2368 ;; otherwise set top line of other win so it doesn't scroll.
2369 (if (< oldot top) (setq top oldot))
f5136913
RS
2370 ;; if frame is unsplitable, temporarily disable that...
2371 (if (cdr (assq 'unsplittable (frame-parameters (selected-frame))))
2372 (let ((frame (selected-frame)))
2373 (modify-frame-parameters frame '((unsplittable . nil)))
2374 (split-window nil height)
2375 (modify-frame-parameters frame '((unsplittable . t))))
2376 (split-window nil height))
47a9f362 2377 (let ((deficit (- height (ispell-adjusted-window-height))))
24b0afdc 2378 (when (> deficit 0)
47a9f362
MB
2379 ;; Number of lines the window is still too short. We ensure that
2380 ;; there are at least (1- HEIGHT) lines visible in the window.
24b0afdc
MB
2381 (enlarge-window deficit)
2382 (goto-char top)
2383 (vertical-motion deficit)
2384 (setq top (min (point) oldot))))
007852e0
RS
2385 (set-window-start (next-window) top))))
2386
2387
2388;;; Should we add a compound word match return value?
9050446c 2389(defun ispell-parse-output (output &optional accept-list shift)
f5136913 2390 "Parse the OUTPUT string from Ispell process and return:
a9210a53 23911: t for an exact match.
f5136913 23922: A string containing the root word matched via suffix removal.
007852e0 23933: A list of possible correct spellings of the format:
f5136913 2394 (\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
3ee3ac77
RS
2395 ORIGINAL-WORD is a string of the possibly misspelled word.
2396 OFFSET is an integer giving the line offset of the word.
f5136913 2397 MISS-LIST and GUESS-LIST are possibly null lists of guesses and misses.
f0529b5b 23984: nil when an error has occurred.
9050446c 2399
72c04ce2 2400Optional second arg ACCEPT-LIST is list of words already accepted.
9050446c 2401Optional third arg SHIFT is an offset to apply based on previous corrections."
007852e0
RS
2402 (cond
2403 ((string= output "") t) ; for startup with pipes...
2404 ((string= output "*") t) ; exact match
f5136913 2405 ((string= output "-") t) ; compound word match
877d353a 2406 ((eq (aref output 0) ?+) ; found because of root word
007852e0 2407 (substring output 2)) ; return root word
b9431ae0 2408 ((equal 0 (string-match "[\ra-zA-Z]" output))
f5136913 2409 (ding) ; error message from ispell!
5673af85 2410 (message "Ispell error: %s" output)
f5136913
RS
2411 (sit-for 5)
2412 nil)
007852e0 2413 (t ; need to process &, ?, and #'s
877d353a 2414 (let ((type (aref output 0)) ; &, ?, or #
007852e0
RS
2415 (original-word (substring output 2 (string-match " " output 2)))
2416 (cur-count 0) ; contains number of misses + guesses
2417 count miss-list guess-list offset)
2418 (setq output (substring output (match-end 0))) ; skip over misspelling
877d353a 2419 (if (eq type ?#)
007852e0 2420 (setq count 0) ; no misses for type #
027a4b6b 2421 (setq count (string-to-number output) ; get number of misses.
007852e0 2422 output (substring output (1+ (string-match " " output 1)))))
027a4b6b 2423 (setq offset (string-to-number output))
877d353a 2424 (if (eq type ?#) ; No miss or guess list.
007852e0
RS
2425 (setq output nil)
2426 (setq output (substring output (1+ (string-match " " output 1)))))
2427 (while output
2428 (let ((end (string-match ", \\|\\($\\)" output))) ; end of miss/guess.
2429 (setq cur-count (1+ cur-count))
2430 (if (> cur-count count)
2431 (setq guess-list (cons (substring output 0 end) guess-list))
2432 (setq miss-list (cons (substring output 0 end) miss-list)))
2433 (if (match-end 1) ; True only when at end of line.
2434 (setq output nil) ; no more misses or guesses
2435 (setq output (substring output (+ end 2))))))
9050446c
GM
2436 ;; return results. Accept word if it was already accepted.
2437 ;; adjust offset.
2438 (if (member original-word accept-list)
2439 t
2440 (list original-word
2441 (if (numberp shift) (+ shift offset) offset)
2442 (nreverse miss-list) (nreverse guess-list)))))))
007852e0
RS
2443
2444
8eba343c
EZ
2445(defun ispell-process-status ()
2446 "Return the status of the Ispell process.
2447When asynchronous processes are not supported, `run' is always returned."
2448 (if ispell-async-processp
2449 (process-status ispell-process)
2450 (and ispell-process 'run)))
2451
2452
2453(defun ispell-start-process ()
2454 "Start the ispell process, with support for no asynchronous processes.
2455Keeps argument list for future ispell invocations for no async support."
ef1f3012
MR
2456 (let ((default-directory default-directory)
2457 args)
2458 (unless (and (file-directory-p default-directory)
2459 (file-readable-p default-directory))
2460 ;; Defend against bad `default-directory'.
2461 (setq default-directory (expand-file-name "~/")))
8eba343c 2462 ;; Local dictionary becomes the global dictionary in use.
a6e7a34b
RS
2463 (setq ispell-current-dictionary
2464 (or ispell-local-dictionary ispell-dictionary))
09b2eb5e
RS
2465 (setq ispell-current-personal-dictionary
2466 (or ispell-local-pdict ispell-personal-dictionary))
8eba343c 2467 (setq args (ispell-get-ispell-args))
a6e7a34b 2468 (if (and ispell-current-dictionary ; use specified dictionary
4d170362 2469 (not (member "-d" args))) ; only define if not overridden
8eba343c 2470 (setq args
a6e7a34b 2471 (append (list "-d" ispell-current-dictionary) args)))
09b2eb5e 2472 (if ispell-current-personal-dictionary ; use specified pers dict
8eba343c
EZ
2473 (setq args
2474 (append args
2475 (list "-p"
09b2eb5e 2476 (expand-file-name ispell-current-personal-dictionary)))))
acf7984c
GM
2477 (if (and ispell-really-aspell
2478 ispell-aspell-supports-utf8)
2479 (setq args
2480 (append args
2481 (list
2482 (concat "--encoding="
2483 (symbol-name (ispell-get-coding-system)))))))
8eba343c
EZ
2484 (setq args (append args ispell-extra-args))
2485
09b2eb5e
RS
2486 ;; Initially we don't know any buffer's local words.
2487 (setq ispell-buffer-local-name nil)
2488
8eba343c
EZ
2489 (if ispell-async-processp
2490 (let ((process-connection-type ispell-use-ptys-p))
2491 (apply 'start-process
2492 "ispell" nil ispell-program-name
2493 "-a" ; accept single input lines
2494 "-m" ; make root/affix combos not in dict
2495 args))
2496 (setq ispell-cmd-args args
2497 ispell-output-buffer (generate-new-buffer " *ispell-output*")
2498 ispell-session-buffer (generate-new-buffer " *ispell-session*"))
2499 (ispell-send-string "\032\n") ; so Ispell prints version and exits
2500 t)))
2501
2502
2503
007852e0 2504(defun ispell-init-process ()
3ee3ac77 2505 "Check status of Ispell process and start if necessary."
007852e0 2506 (if (and ispell-process
8eba343c 2507 (eq (ispell-process-status) 'run)
fea6948a 2508 ;; If we're using a personal dictionary, ensure
007852e0
RS
2509 ;; we're in the same default directory!
2510 (or (not ispell-personal-dictionary)
2511 (equal ispell-process-directory default-directory)))
2512 (setq ispell-filter nil ispell-filter-continue nil)
2513 ;; may need to restart to select new personal dictionary.
2514 (ispell-kill-ispell t)
fc8a237d
EZ
2515 (message "Starting new Ispell process [%s] ..."
2516 (or ispell-local-dictionary ispell-dictionary "default"))
007852e0 2517 (sit-for 0)
4d170362
SM
2518 (setq ispell-library-directory (ispell-check-version)
2519 ispell-process-directory default-directory
8eba343c 2520 ispell-process (ispell-start-process)
007852e0 2521 ispell-filter nil
8eba343c
EZ
2522 ispell-filter-continue nil)
2523 (if ispell-async-processp
2524 (set-process-filter ispell-process 'ispell-filter))
9050446c 2525 ;; protect against bogus binding of `enable-multibyte-characters' in XEmacs
877d353a 2526 (if (and (or (featurep 'xemacs)
9050446c
GM
2527 (and (boundp 'enable-multibyte-characters)
2528 enable-multibyte-characters))
2529 (fboundp 'set-process-coding-system))
b9431ae0
RS
2530 (set-process-coding-system ispell-process (ispell-get-coding-system)
2531 (ispell-get-coding-system)))
f5136913 2532 ;; Get version ID line
bb41818d 2533 (ispell-accept-output 3)
f5136913 2534 ;; get more output if filter empty?
8eba343c 2535 (if (null ispell-filter) (ispell-accept-output 3))
007852e0 2536 (cond ((null ispell-filter)
a8928dd2 2537 (error "%s did not output version line" ispell-program-name))
01ea0e3b
RS
2538 ((and
2539 (stringp (car ispell-filter))
2540 (if (string-match "warning: " (car ispell-filter))
2541 (progn
bb41818d 2542 (ispell-accept-output 3) ; was warn msg.
01ea0e3b
RS
2543 (stringp (car ispell-filter)))
2544 (null (cdr ispell-filter)))
2545 (string-match "^@(#) " (car ispell-filter)))
007852e0
RS
2546 ;; got the version line as expected (we already know it's the right
2547 ;; version, so don't bother checking again.)
2548 nil)
2549 (t
2550 ;; Otherwise, it must be an error message. Show the user.
2551 ;; But first wait to see if some more output is going to arrive.
2552 ;; Otherwise we get cool errors like "Can't open ".
2553 (sleep-for 1)
8eba343c 2554 (ispell-accept-output 3)
007852e0
RS
2555 (error "%s" (mapconcat 'identity ispell-filter "\n"))))
2556 (setq ispell-filter nil) ; Discard version ID line
2557 (let ((extended-char-mode (ispell-get-extended-character-mode)))
6fdf40f3 2558 (if extended-char-mode ; ~ extended character mode
8eba343c
EZ
2559 (ispell-send-string (concat extended-char-mode "\n"))))
2560 (if ispell-async-processp
6063ae55 2561 (set-process-query-on-exit-flag ispell-process nil))))
007852e0 2562
829b9e73 2563;;;###autoload
007852e0 2564(defun ispell-kill-ispell (&optional no-error)
a9210a53
RS
2565 "Kill current Ispell process (so that you may start a fresh one).
2566With NO-ERROR, just return non-nil if there was no Ispell running."
007852e0 2567 (interactive)
2834b9b3
SM
2568 ;; This hook is typically used by flyspell to flush some variables used
2569 ;; to optimize the common cases.
2570 (run-hooks 'ispell-kill-ispell-hook)
007852e0 2571 (if (not (and ispell-process
8eba343c 2572 (eq (ispell-process-status) 'run)))
007852e0
RS
2573 (or no-error
2574 (error "There is no ispell process running!"))
8eba343c 2575 (if ispell-async-processp
2a997209 2576 (delete-process ispell-process)
8eba343c
EZ
2577 ;; synchronous processes
2578 (ispell-send-string "\n") ; make sure side effects occurred.
2579 (kill-buffer ispell-output-buffer)
2580 (kill-buffer ispell-session-buffer)
2581 (setq ispell-output-buffer nil
2582 ispell-session-buffer nil))
007852e0 2583 (setq ispell-process nil)
3ee3ac77 2584 (message "Ispell process killed")
007852e0
RS
2585 nil))
2586
2587
8ce8687e 2588;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
1335d078
RS
2589;;; call ispell-init-process rather than wait for a spell checking command?
2590
007852e0
RS
2591;;;###autoload
2592(defun ispell-change-dictionary (dict &optional arg)
a6e7a34b 2593 "Change to dictionary DICT for Ispell.
8e07e84a
RS
2594With a prefix arg, set it \"globally\", for all buffers.
2595Without a prefix arg, set it \"locally\", just for this buffer.
007852e0 2596
8e07e84a 2597By just answering RET you can find out what the current dictionary is."
007852e0
RS
2598 (interactive
2599 (list (completing-read
2600 "Use new dictionary (RET for current, SPC to complete): "
4d170362 2601 (and (fboundp 'ispell-valid-dictionary-list)
a6e7a34b 2602 (mapcar 'list (ispell-valid-dictionary-list)))
4d170362 2603 nil t)
007852e0 2604 current-prefix-arg))
423cef56 2605 (ispell-maybe-find-aspell-dictionaries)
87a6b92c 2606 (unless arg (ispell-buffer-local-dict 'no-reload))
007852e0
RS
2607 (if (equal dict "default") (setq dict nil))
2608 ;; This relies on completing-read's bug of returning "" for no match
2609 (cond ((equal dict "")
87a6b92c 2610 (ispell-internal-change-dictionary)
007852e0 2611 (message "Using %s dictionary"
e42a01cb
CY
2612 (or (and (not arg) ispell-local-dictionary)
2613 ispell-dictionary "default")))
2614 ((equal dict (or (and (not arg) ispell-local-dictionary)
a6e7a34b 2615 ispell-dictionary "default"))
87a6b92c
EZ
2616 ;; Specified dictionary is the default already. Could reload
2617 ;; the dictionaries if needed.
2618 (ispell-internal-change-dictionary)
1335d078 2619 (and (interactive-p)
a6e7a34b 2620 (message "No change, using %s dictionary" dict)))
007852e0 2621 (t ; reset dictionary!
a6e7a34b
RS
2622 (if (or (assoc dict ispell-local-dictionary-alist)
2623 (assoc dict ispell-dictionary-alist))
2624 (if arg
2625 ;; set default dictionary
2626 (setq ispell-dictionary dict)
2627 ;; set local dictionary
2628 (setq ispell-local-dictionary dict)
2629 (setq ispell-local-dictionary-overridden t))
f5136913 2630 (error "Undefined dictionary: %s" dict))
fc8a237d 2631 (ispell-internal-change-dictionary)
a6e7a34b
RS
2632 (message "%s Ispell dictionary set to %s"
2633 (if arg "Global" "Local")
2634 dict))))
2635
2636(defun ispell-internal-change-dictionary ()
87a6b92c 2637 "Update the dictionary and the personal dictionary used by Ispell.
a6e7a34b
RS
2638This may kill the Ispell process; if so,
2639a new one will be started when needed."
87a6b92c
EZ
2640 (let ((dict (or ispell-local-dictionary ispell-dictionary))
2641 (pdict (or ispell-local-pdict ispell-personal-dictionary)))
2642 (unless (and (equal ispell-current-dictionary dict)
2643 (equal ispell-current-personal-dictionary pdict))
09b2eb5e 2644 (ispell-kill-ispell t)
87a6b92c
EZ
2645 (setq ispell-current-dictionary dict
2646 ispell-current-personal-dictionary pdict))))
007852e0
RS
2647
2648;;; Spelling of comments are checked when ispell-check-comments is non-nil.
2649
2650;;;###autoload
9050446c 2651(defun ispell-region (reg-start reg-end &optional recheckp shift)
5755be32 2652 "Interactively check a region for spelling errors.
9050446c
GM
2653Return nil if spell session is quit,
2654 otherwise returns shift offset amount for last line processed."
007852e0 2655 (interactive "r") ; Don't flag errors on read-only bufs.
966a7f49 2656 (ispell-maybe-find-aspell-dictionaries)
9050446c
GM
2657 (if (not recheckp)
2658 (ispell-accept-buffer-local-defs)) ; set up dictionary, local words, etc.
4d170362
SM
2659 (let ((skip-region-start (make-marker))
2660 (rstart (make-marker)))
007852e0 2661 (unwind-protect
4b03da72 2662 (save-excursion
75662d96 2663 (message "Spell-checking %s using %s with %s dictionary..."
4b03da72 2664 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
e29702dd 2665 (buffer-name) "region")
4a65d2b3 2666 (file-name-nondirectory ispell-program-name)
a6e7a34b 2667 (or ispell-current-dictionary "default"))
e29702dd 2668 ;; Returns cursor to original location.
4b03da72 2669 (save-window-excursion
4b03da72 2670 (goto-char reg-start)
9050446c 2671 (let ((transient-mark-mode)
f5136913 2672 (case-fold-search case-fold-search)
4d170362
SM
2673 (query-fcc t)
2674 in-comment key)
f5136913
RS
2675 (let (message-log-max)
2676 (message "searching for regions to skip"))
4d170362 2677 (if (re-search-forward (ispell-begin-skip-region-regexp) reg-end t)
f5136913
RS
2678 (progn
2679 (setq key (buffer-substring-no-properties
2680 (match-beginning 0) (match-end 0)))
2681 (set-marker skip-region-start (- (point) (length key)))
2682 (goto-char reg-start)))
2683 (let (message-log-max)
4a65d2b3
JL
2684 (message "Continuing spelling check using %s with %s dictionary..."
2685 (file-name-nondirectory ispell-program-name)
a6e7a34b 2686 (or ispell-current-dictionary "default")))
4d170362 2687 (set-marker rstart reg-start)
f5136913
RS
2688 (set-marker ispell-region-end reg-end)
2689 (while (and (not ispell-quit)
2690 (< (point) ispell-region-end))
2691 ;; spell-check region with skipping
2692 (if (and (marker-position skip-region-start)
2693 (<= skip-region-start (point)))
2694 (progn
4d170362
SM
2695 ;; If region inside line comment, must keep comment start.
2696 (setq in-comment (point)
2697 in-comment
2698 (and comment-start
2699 (or (null comment-end) (string= "" comment-end))
2700 (save-excursion
2701 (beginning-of-line)
2702 (re-search-forward comment-start in-comment t))
2703 comment-start))
2704 ;; Can change skip-regexps (in ispell-message)
2705 (ispell-skip-region key) ; moves pt past region.
2706 (set-marker rstart (point))
2707 ;; check for saving large attachments...
2708 (setq query-fcc (and query-fcc
2709 (ispell-ignore-fcc skip-region-start
2710 rstart)))
2711 (if (and (< rstart ispell-region-end)
2712 (re-search-forward
2713 (ispell-begin-skip-region-regexp)
2714 ispell-region-end t))
f5136913 2715 (progn
81771793 2716 (setq key (match-string-no-properties 0))
f5136913
RS
2717 (set-marker skip-region-start
2718 (- (point) (length key)))
4d170362 2719 (goto-char rstart))
f5136913 2720 (set-marker skip-region-start nil))))
4d170362
SM
2721 (setq reg-end (max (point)
2722 (if (marker-position skip-region-start)
2723 (min skip-region-start ispell-region-end)
2724 (marker-position ispell-region-end))))
f5136913
RS
2725 (let* ((start (point))
2726 (end (save-excursion (end-of-line) (min (point) reg-end)))
4d170362
SM
2727 (string (ispell-get-line start end in-comment)))
2728 (if in-comment ; account for comment chars added
2729 (setq start (- start (length in-comment))
2730 in-comment nil))
f5136913
RS
2731 (setq end (point)) ; "end" tracks region retrieved.
2732 (if string ; there is something to spell check!
9050446c
GM
2733 ;; (special start end)
2734 (setq shift (ispell-process-line string
2735 (and recheckp shift))))
4b03da72 2736 (goto-char end)))))
9050446c
GM
2737 (if ispell-quit
2738 nil
2739 (or shift 0)))
4b03da72 2740 ;; protected
9050446c
GM
2741 (if (and (not (and recheckp ispell-keep-choices-win))
2742 (get-buffer ispell-choices-buffer))
4b03da72 2743 (kill-buffer ispell-choices-buffer))
4d170362
SM
2744 (set-marker skip-region-start nil)
2745 (set-marker rstart nil)
4b03da72
RS
2746 (if ispell-quit
2747 (progn
2748 ;; preserve or clear the region for ispell-continue.
2749 (if (not (numberp ispell-quit))
2750 (set-marker ispell-region-end nil)
f5136913 2751 ;; Ispell-continue enabled - ispell-region-end is set.
4b03da72
RS
2752 (goto-char ispell-quit))
2753 ;; Check for aborting
2754 (if (and ispell-checking-message (numberp ispell-quit))
2755 (progn
2756 (setq ispell-quit nil)
b9431ae0 2757 (error "Message send aborted")))
9050446c
GM
2758 (if (not recheckp) (setq ispell-quit nil)))
2759 (if (not recheckp) (set-marker ispell-region-end nil))
4b03da72
RS
2760 ;; Only save if successful exit.
2761 (ispell-pdict-save ispell-silently-savep)
75662d96
JL
2762 (message "Spell-checking %s using %s with %s dictionary done"
2763 (if (and (= reg-start (point-min)) (= reg-end (point-max)))
2764 (buffer-name) "region")
4a65d2b3
JL
2765 (file-name-nondirectory ispell-program-name)
2766 (or ispell-current-dictionary "default"))))))
007852e0
RS
2767
2768
f5136913 2769(defun ispell-begin-skip-region-regexp ()
4d170362
SM
2770 "Returns a regexp of the search keys for region skipping.
2771Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
b11a1b2e 2772Must call after `ispell-buffer-local-parsing' due to dependence on mode."
4d170362
SM
2773 ;; start with regions generic to all buffers
2774 (let ((skip-regexp (ispell-begin-skip-region ispell-skip-region-alist)))
2775 ;; Comments
f5136913
RS
2776 (if (and (null ispell-check-comments) comment-start)
2777 (setq skip-regexp (concat (regexp-quote comment-start) "\\|"
2778 skip-regexp)))
2779 (if (and (eq 'exclusive ispell-check-comments) comment-start)
4d170362 2780 ;; search from end of current comment to start of next comment.
f5136913
RS
2781 (setq skip-regexp (concat (if (string= "" comment-end) "^"
2782 (regexp-quote comment-end))
2783 "\\|" skip-regexp)))
4d170362 2784 ;; tib
f5136913
RS
2785 (if ispell-skip-tib
2786 (setq skip-regexp (concat ispell-tib-ref-beginning "\\|" skip-regexp)))
4d170362 2787 ;; html stuff
fea6948a 2788 (if ispell-skip-html
4d170362
SM
2789 (setq skip-regexp (concat
2790 (ispell-begin-skip-region ispell-html-skip-alists)
2791 "\\|"
2792 skip-regexp)))
2793 ;; tex
f5136913
RS
2794 (if (eq ispell-parser 'tex)
2795 (setq skip-regexp (concat (ispell-begin-tex-skip-regexp) "\\|"
2796 skip-regexp)))
4d170362
SM
2797 ;; messages
2798 (if (and ispell-checking-message
2799 (not (eq t ispell-checking-message)))
2800 (setq skip-regexp (concat
2801 (mapconcat (lambda (lst) (car lst))
2802 ispell-checking-message
2803 "\\|")
2804 "\\|"
2805 skip-regexp)))
2806
2807 ;; return new regexp
f5136913
RS
2808 skip-regexp))
2809
2810
4d170362
SM
2811(defun ispell-begin-skip-region (skip-alist)
2812 "Regular expression for start of regions to skip generated from SKIP-ALIST.
2813Each selection should be a key of SKIP-ALIST;
2814otherwise, the current line is skipped."
2815 (mapconcat (lambda (lst) (if (stringp (car lst)) (car lst) (eval (car lst))))
2816 skip-alist
2817 "\\|"))
2818
2819
f5136913 2820(defun ispell-begin-tex-skip-regexp ()
b9431ae0
RS
2821 "Regular expression of tex commands to skip.
2822Generated from `ispell-tex-skip-alists'."
f5136913 2823 (concat
4d170362 2824 ;; raw tex keys
f5136913
RS
2825 (mapconcat (function (lambda (lst) (car lst)))
2826 (car ispell-tex-skip-alists)
2827 "\\|")
2828 "\\|"
4d170362 2829 ;; keys wrapped in begin{}
f5136913
RS
2830 (mapconcat (function (lambda (lst)
2831 (concat "\\\\begin[ \t\n]*{[ \t\n]*"
2832 (car lst)
2833 "[ \t\n]*}")))
2834 (car (cdr ispell-tex-skip-alists))
2835 "\\|")))
2836
2837
4d170362
SM
2838(defun ispell-skip-region-list ()
2839 "Returns a list describing key and body regions to skip for this buffer.
2840Includes regions defined by `ispell-skip-region-alist', tex mode,
2841`ispell-html-skip-alists', and `ispell-checking-message'.
2842Manual checking must include comments and tib references.
2843The list is of the form described by variable `ispell-skip-region-alist'.
2844Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2845 (let ((skip-alist ispell-skip-region-alist))
2846 ;; only additional explicit region definition is tex.
2847 (if (eq ispell-parser 'tex)
2848 (setq case-fold-search nil
2849 skip-alist (append (car ispell-tex-skip-alists)
2850 (car (cdr ispell-tex-skip-alists))
2851 skip-alist)))
2852 (if ispell-skip-html
2853 (setq skip-alist (append ispell-html-skip-alists skip-alist)))
2854 (if (and ispell-checking-message
2855 (not (eq t ispell-checking-message)))
2856 (setq skip-alist (append ispell-checking-message skip-alist)))
2857 skip-alist))
f5136913
RS
2858
2859
2860(defun ispell-tex-arg-end (&optional arg)
4d170362 2861 "Skip across ARG number of braces."
f5136913
RS
2862 (condition-case nil
2863 (progn
2864 (while (looking-at "[ \t\n]*\\[") (forward-sexp))
2865 (forward-sexp (or arg 1)))
2866 (error
2867 (message "error skipping s-expressions at point %d." (point))
2868 (beep)
2869 (sit-for 2))))
2870
2871
4d170362
SM
2872(defun ispell-ignore-fcc (start end)
2873 "Deletes the Fcc: message header when large attachments are included.
2874Return value `nil' if file with large attachments are saved.
2875This can be used to avoid multiple questions for multiple large attachments.
2876Returns point to starting location afterwards."
2877 (let ((result t))
2878 (if (and ispell-checking-message ispell-message-fcc-skip)
2879 (if (< ispell-message-fcc-skip (- end start))
2880 (let (case-fold-search head-end)
2881 (goto-char (point-min))
2882 (setq head-end
2883 (or (re-search-forward
2884 (concat "^" (regexp-quote mail-header-separator) "$")
2885 nil t)
2886 (re-search-forward "^$" nil t)
2887 (point-min)))
2888 (goto-char (point-min))
2889 (if (re-search-forward "^Fcc:" head-end t)
2890 (if (y-or-n-p
2891 "Save copy of this message with large attachments? ")
2892 (setq result nil)
2893 (beginning-of-line)
2894 (kill-line 1)))
2895 (goto-char end))))
2896 result))
2897
2898
2899(defun ispell-skip-region (key)
2900 "Skips across KEY and then to end of region.
2901Key lookup determines region to skip.
2902Point is placed at end of skipped region."
f5136913
RS
2903 ;; move over key to begin checking.
2904 (forward-char (length key))
2905 (let ((start (point))
4d170362
SM
2906 ;; Regenerate each call... This function can change region definition.
2907 (alist (ispell-skip-region-list))
f5136913
RS
2908 alist-key null-skip)
2909 (cond
2910 ;; what about quoted comment, or comment inside strings?
2911 ((and (null ispell-check-comments) comment-start
2912 (string= key comment-start))
2913 (if (string= "" comment-end)
2914 (forward-line)
2915 (search-forward comment-end ispell-region-end t)))
2916 ((and (eq 'exclusive ispell-check-comments) comment-start
2917 (string= key comment-end))
7a914d3e 2918 (search-forward comment-start ispell-region-end :end))
f5136913
RS
2919 ((and ispell-skip-tib (string-match ispell-tib-ref-beginning key))
2920 (re-search-forward ispell-tib-ref-end ispell-region-end t))
f5136913
RS
2921 ;; markings from alist
2922 (t
2923 (while alist
2924 (setq alist-key (eval (car (car alist))))
2925 (if (string-match alist-key key)
2926 (progn
2927 (setq alist (cdr (car alist)))
2928 (cond
2929 ((null alist) (setq null-skip t)) ; done! Just skip key.
2930 ((not (consp alist))
2931 ;; Search past end of spell region to find this region end.
2932 (re-search-forward (eval alist) (point-max) t))
4d170362
SM
2933 ((and (= 1 (length alist))
2934 (stringp (car alist)))
2935 (re-search-forward (car alist) (point-max) t))
2936 (t
2937 (setq null-skip t) ; error handling in functions!
2938 (if (consp (cdr alist))
2939 (apply (car alist) (cdr alist))
2940 (funcall (car alist)))))
f5136913
RS
2941 (setq alist nil))
2942 (setq alist (cdr alist))))))
2943 (if (and (= start (point)) (null null-skip))
2944 (progn
2945 (message "Matching region end for `%s' point %d not found"
2946 key (point))
2947 (beep)
2948 (sit-for 2)))))
2949
2950
2951;;; Grab the next line of data.
2952;;; Returns a string with the line data
4d170362 2953(defun ispell-get-line (start end in-comment)
f5136913
RS
2954 (let ((ispell-casechars (ispell-get-casechars))
2955 string)
2956 (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
2957 ((eolp) ; END OF LINE, just go to next line.
2958 (forward-line))
fea6948a 2959 ;;((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
6fdf40f3 2960 ;; (forward-char 1)) ; not needed as quoted below.
f5136913
RS
2961 ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
2962 (re-search-forward "[][()${}]" end t)) ; or MATH COMMANDS
4d170362
SM
2963 (setq string (concat "^" in-comment
2964 (buffer-substring-no-properties start end)
f5136913
RS
2965 "\n"))
2966 (goto-char end))
2967 (t (goto-char end))) ; EMPTY LINE, skip it.
2968 string))
2969
2970
664ca704
KH
2971(defun ispell-looking-at (string)
2972 (let ((coding (ispell-get-coding-system))
2973 (len (length string)))
2974 (and (<= (+ (point) len) (point-max))
2975 (equal (encode-coding-string string coding)
2976 (encode-coding-string (buffer-substring-no-properties
2977 (point) (+ (point) len))
2978 coding)))))
2979
fea6948a 2980;;; Avoid error messages when compiling for these dynamic variables.
d83d8efe
SM
2981(defvar start)
2982(defvar end)
fea6948a 2983
9050446c 2984(defun ispell-process-line (string shift)
b11a1b2e 2985 "Sends STRING, a line of text, to ispell and processes the result.
9050446c
GM
2986This will modify the buffer for spelling errors.
2987Requires variables START and END to be defined in its lexical scope.
b11a1b2e 2988Returns the sum SHIFT due to changes in word replacements."
f5136913 2989 ;;(declare special start end)
9050446c
GM
2990 (let (poss accept-list)
2991 (if (not (numberp shift))
2992 (setq shift 0))
f5136913 2993 ;; send string to spell process and get input.
8eba343c 2994 (ispell-send-string string)
f5136913 2995 (while (progn
8eba343c 2996 (ispell-accept-output)
f5136913
RS
2997 ;; Last item of output contains a blank line.
2998 (not (string= "" (car ispell-filter)))))
2999 ;; parse all inputs from the stream one word at a time.
3000 ;; Place in FIFO order and remove the blank item.
3001 (setq ispell-filter (nreverse (cdr ispell-filter)))
3002 (while (and (not ispell-quit) ispell-filter)
9050446c
GM
3003 ;; get next word, accounting for accepted words and start shifts
3004 (setq poss (ispell-parse-output (car ispell-filter)
3005 accept-list shift))
f5136913
RS
3006 (if (and poss (listp poss)) ; spelling error occurred.
3007 ;; Whenever we have misspellings, we can change
3008 ;; the buffer. Keep boundaries as markers.
3009 ;; Markers can move with highlighting! This destroys
3010 ;; end of region markers line-end and ispell-region-end
3011 (let ((word-start
9050446c 3012 (copy-marker (+ start ispell-offset (car (cdr poss)))))
f5136913
RS
3013 (word-len (length (car poss)))
3014 (line-end (copy-marker end))
3015 (line-start (copy-marker start))
3016 recheck-region replace)
3017 (goto-char word-start)
3018 ;; Adjust the horizontal scroll & point
3019 (ispell-horiz-scroll)
3020 (goto-char (+ word-len word-start))
3021 (ispell-horiz-scroll)
3022 (goto-char word-start)
3023 (ispell-horiz-scroll)
9050446c
GM
3024
3025 ;; Alignment cannot be tracked and this error will occur when
3026 ;; `query-replace' makes multiple corrections on the starting line.
664ca704 3027 (or (ispell-looking-at (car poss))
f5136913
RS
3028 ;; This occurs due to filter pipe problems
3029 (error (concat "Ispell misalignment: word "
3030 "`%s' point %d; probably incompatible versions")
3031 (car poss) (marker-position word-start)))
f5136913
RS
3032 ;; ispell-cmd-loop can go recursive & change buffer
3033 (if ispell-keep-choices-win
3034 (setq replace (ispell-command-loop
3035 (car (cdr (cdr poss)))
3036 (car (cdr (cdr (cdr poss))))
3037 (car poss) (marker-position word-start)
3038 (+ word-len (marker-position word-start))))
3039 (save-window-excursion
3040 (setq replace (ispell-command-loop
3041 (car (cdr (cdr poss)))
3042 (car (cdr (cdr (cdr poss))))
3043 (car poss) (marker-position word-start)
3044 (+ word-len (marker-position word-start))))))
3045
f5136913 3046 (goto-char word-start)
9050446c
GM
3047 ;; Recheck when query replace edit changes misspelled word.
3048 ;; Error in tex mode when a potential math mode change exists.
3049 (if (and replace (listp replace) (= 2 (length replace)))
3050 (if (and (eq ispell-parser 'tex)
3051 (string-match "[\\\\][]()[]\\|\\\\begin\\|\\$"
3052 (regexp-quote string)))
3053 (error
3054 "Don't start query replace on a line with math characters"
3055 )
f5136913
RS
3056 (set-marker line-end (point))
3057 (setq ispell-filter nil
3058 recheck-region t)))
8eba343c 3059
9050446c 3060 ;; insert correction if needed
f5136913 3061 (cond
f5136913
RS
3062 ((or (null replace)
3063 (equal 0 replace)) ; ACCEPT/INSERT
3064 (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
3065 (ispell-add-per-file-word-list (car poss)))
9050446c
GM
3066 ;; do not recheck accepted word on this line
3067 (setq accept-list (cons (car poss) accept-list)))
3068 (t ; replacement word selected or entered
f5136913 3069 (delete-region (point) (+ word-len (point)))
9050446c
GM
3070 (if (not (listp replace))
3071 (progn
ca8d88cd 3072 (ispell-insert-word replace) ; insert dictionary word
8f0d9e76 3073 (ispell-send-replacement (car poss) replace)
9050446c
GM
3074 (setq accept-list (cons replace accept-list)))
3075 (let ((replace-word (car replace)))
3076 ;; Recheck hand entered replacement word
3077 (insert replace-word)
8f0d9e76 3078 (ispell-send-replacement (car poss) replace-word)
9050446c
GM
3079 (if (car (cdr replace))
3080 (save-window-excursion
3081 (delete-other-windows) ; to correctly show help.
3082 ;; Assume case-replace &
3083 ;; case-fold-search correct?
3084 (query-replace (car poss) (car replace) t)))
3085 (goto-char word-start)
3086 ;; do not recheck if already accepted
3087 (if (member replace-word accept-list)
3088 (setq accept-list (cons replace-word accept-list)
3089 replace replace-word)
3090 (let ((region-end (copy-marker ispell-region-end)))
3091 (setq recheck-region ispell-filter
3092 ispell-filter nil ; save filter
fea6948a 3093 shift 0 ; already accounted
9050446c 3094 shift (ispell-region
fea6948a
GM
3095 word-start
3096 (+ word-start (length replace-word))
3097 t shift))
9050446c
GM
3098 (if (null shift) ; quitting check.
3099 (setq shift 0))
3100 (set-marker ispell-region-end region-end)
3101 (set-marker region-end nil)
3102 (setq ispell-filter recheck-region
3103 recheck-region nil
3104 replace replace-word)))))
3105
3106 (setq shift (+ shift (- (length replace) word-len)))
3107
3108 ;; Move line-start across word...
3109 ;; new shift function does this now...
3110 ;;(set-marker line-start (+ line-start
fa72a6a1
SM
3111 ;; (- (length replace)
3112 ;; (length (car poss)))))
9050446c 3113 ))
f5136913
RS
3114 (if (not ispell-quit)
3115 (let (message-log-max)
4a65d2b3
JL
3116 (message "Continuing spelling check using %s with %s dictionary..."
3117 (file-name-nondirectory ispell-program-name)
a6e7a34b 3118 (or ispell-current-dictionary "default"))))
f5136913
RS
3119 (sit-for 0)
3120 (setq start (marker-position line-start)
3121 end (marker-position line-end))
3122 ;; Adjust markers when end of region lost from highlighting.
3123 (if (and (not recheck-region) (< end (+ word-start word-len)))
3124 (setq end (+ word-start word-len)))
3125 (if (= word-start ispell-region-end)
3126 (set-marker ispell-region-end (+ word-start word-len)))
3127 ;; going out of scope - unneeded
3128 (set-marker line-start nil)
3129 (set-marker word-start nil)
3130 (set-marker line-end nil)))
3131 ;; finished with misspelling!
9050446c
GM
3132 (setq ispell-filter (cdr ispell-filter)))
3133 shift))
f5136913
RS
3134
3135
bc7d6816
GM
3136;;;###autoload
3137(defun ispell-comments-and-strings ()
3138 "Check comments and strings in the current buffer for spelling errors."
3139 (interactive)
3140 (goto-char (point-min))
3141 (let (state done)
3142 (while (not done)
3143 (setq done t)
3144 (setq state (parse-partial-sexp (point) (point-max)
3145 nil nil state 'syntax-table))
6fdf40f3
KH
3146 (if (or (nth 3 state) (nth 4 state))
3147 (let ((start (point)))
3148 (setq state (parse-partial-sexp start (point-max)
3149 nil nil state 'syntax-table))
3150 (if (or (nth 3 state) (nth 4 state))
3151 (error "Unterminated string or comment"))
3152 (save-excursion
3153 (setq done (not (ispell-region start (point))))))))))
bc7d6816 3154
007852e0
RS
3155
3156;;;###autoload
4b03da72 3157(defun ispell-buffer ()
007852e0
RS
3158 "Check the current buffer for spelling errors interactively."
3159 (interactive)
3160 (ispell-region (point-min) (point-max)))
3161
4b03da72 3162
829b9e73 3163;;;###autoload
007852e0 3164(defun ispell-continue ()
f5136913 3165 "Continue a halted spelling session beginning with the current word."
b9431ae0 3166 (interactive)
007852e0
RS
3167 (if (not (marker-position ispell-region-end))
3168 (message "No session to continue. Use 'X' command when checking!")
3169 (if (not (equal (marker-buffer ispell-region-end) (current-buffer)))
3170 (message "Must continue ispell from buffer %s"
3171 (buffer-name (marker-buffer ispell-region-end)))
f5136913
RS
3172 (ispell-region
3173 ;; find beginning of current word:
3174 (car (cdr (ispell-get-word t)))
3175 (marker-position ispell-region-end)))))
007852e0
RS
3176
3177
3178;;; Horizontal scrolling
4b03da72
RS
3179(defun ispell-horiz-scroll ()
3180 "Places point within the horizontal visibility of its window area."
007852e0
RS
3181 (if truncate-lines ; display truncating lines?
3182 ;; See if display needs to be scrolled.
3183 (let ((column (- (current-column) (max (window-hscroll) 1))))
3184 (if (and (< column 0) (> (window-hscroll) 0))
3185 (scroll-right (max (- column) 10))
3186 (if (>= column (- (window-width) 2))
3187 (scroll-left (max (- column (window-width) -3) 10)))))))
3188
3189
3190;;; Interactive word completion.
3191;;; Forces "previous-word" processing. Do we want to make this selectable?
3192
3193;;;###autoload
3194(defun ispell-complete-word (&optional interior-frag)
05f362a8 3195 "Try to complete the word before or under point (see `lookup-words').
b9431ae0
RS
3196If optional INTERIOR-FRAG is non-nil then the word may be a character
3197sequence inside of a word.
007852e0
RS
3198
3199Standard ispell choices are then available."
3200 (interactive "P")
3201 (let ((cursor-location (point))
b9431ae0 3202 (case-fold-search-val case-fold-search)
007852e0
RS
3203 (word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
3204 start end possibilities replacement)
3205 (setq start (car (cdr word))
3206 end (car (cdr (cdr word)))
3207 word (car word)
3208 possibilities
3209 (or (string= word "") ; Will give you every word
f5136913
RS
3210 (lookup-words (concat (and interior-frag "*") word
3211 (if (or interior-frag (null ispell-look-p))
3212 "*"))
007852e0
RS
3213 ispell-complete-word-dict)))
3214 (cond ((eq possibilities t)
3215 (message "No word to complete"))
3216 ((null possibilities)
3217 (message "No match for \"%s\"" word))
3218 (t ; There is a modification...
b9431ae0
RS
3219 (setq case-fold-search nil) ; Try and respect case of word.
3220 (cond
3221 ((string-equal (upcase word) word)
4b03da72 3222 (setq possibilities (mapcar 'upcase possibilities)))
877d353a 3223 ((eq (upcase (aref word 0)) (aref word 0))
b9431ae0
RS
3224 (setq possibilities (mapcar (function
3225 (lambda (pos)
877d353a 3226 (if (eq (aref word 0) (aref pos 0))
b9431ae0
RS
3227 pos
3228 (capitalize pos))))
3229 possibilities))))
3230 (setq case-fold-search case-fold-search-val)
29aec366
RS
3231 (save-window-excursion
3232 (setq replacement
3233 (ispell-command-loop possibilities nil word start end)))
007852e0
RS
3234 (cond
3235 ((equal 0 replacement) ; BUFFER-LOCAL ADDITION
3236 (ispell-add-per-file-word-list word))
3237 (replacement ; REPLACEMENT WORD
3238 (delete-region start end)
3239 (setq word (if (atom replacement) replacement (car replacement))
3240 cursor-location (+ (- (length word) (- end start))
3241 cursor-location))
ca8d88cd 3242 (ispell-insert-word word)
007852e0
RS
3243 (if (not (atom replacement)) ; recheck spelling of replacement.
3244 (progn
3245 (goto-char cursor-location)
3246 (ispell-word nil t)))))
3247 (if (get-buffer ispell-choices-buffer)
3248 (kill-buffer ispell-choices-buffer))))
3249 (ispell-pdict-save ispell-silently-savep)
3250 (goto-char cursor-location)))
3251
3252
3253;;;###autoload
3254(defun ispell-complete-word-interior-frag ()
4b03da72 3255 "Completes word matching character sequence inside a word."
007852e0
RS
3256 (interactive)
3257 (ispell-complete-word t))
3258
e29702dd 3259
754bd273
GM
3260;;;###autoload
3261(defun ispell ()
3262 "Interactively check a region or buffer for spelling errors.
fea6948a 3263If `transient-mark-mode' is on, and a region is active, spell-check
3dfd2532
GM
3264that region. Otherwise spell-check the buffer.
3265
3266Ispell dictionaries are not distributed with Emacs. If you are
3267looking for a dictionary, please see the distribution of the GNU ispell
3268program, or do an Internet search; there are various dictionaries
3269available on the net."
754bd273 3270 (interactive)
4d170362
SM
3271 (if (and (boundp 'transient-mark-mode) transient-mark-mode
3272 (boundp 'mark-active) mark-active)
754bd273
GM
3273 (ispell-region (region-beginning) (region-end))
3274 (ispell-buffer)))
3275
3276
0349bab6
RS
3277;;; **********************************************************************
3278;;; Ispell Minor Mode
3279;;; **********************************************************************
3280
3281(defvar ispell-minor-mode nil
3282 "Non-nil if Ispell minor mode is enabled.")
3283;; Variable indicating that ispell minor mode is active.
3284(make-variable-buffer-local 'ispell-minor-mode)
3285
3286(or (assq 'ispell-minor-mode minor-mode-alist)
3287 (setq minor-mode-alist
3288 (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
3289
3290(defvar ispell-minor-keymap
3291 (let ((map (make-sparse-keymap)))
3292 (define-key map " " 'ispell-minor-check)
3293 (define-key map "\r" 'ispell-minor-check)
3294 map)
3295 "Keymap used for Ispell minor mode.")
3296
3297(or (not (boundp 'minor-mode-map-alist))
3298 (assoc 'ispell-minor-mode minor-mode-map-alist)
3299 (setq minor-mode-map-alist
3300 (cons (cons 'ispell-minor-mode ispell-minor-keymap)
3301 minor-mode-map-alist)))
3302
3303;;;###autoload
3304(defun ispell-minor-mode (&optional arg)
3305 "Toggle Ispell minor mode.
3ecd3a56
GM
3306With prefix argument ARG, turn Ispell minor mode on if ARG is positive,
3307otherwise turn it off.
fea6948a 3308
0349bab6 3309In Ispell minor mode, pressing SPC or RET
f5136913
RS
3310warns you if the previous word is incorrectly spelled.
3311
3312All the buffer-local variables and dictionaries are ignored -- to read
3313them into the running ispell process, type \\[ispell-word] SPC."
0349bab6
RS
3314 (interactive "P")
3315 (setq ispell-minor-mode
3316 (not (or (and (null arg) ispell-minor-mode)
3317 (<= (prefix-numeric-value arg) 0))))
2bcf8edb 3318 (force-mode-line-update))
fea6948a 3319
0349bab6 3320(defun ispell-minor-check ()
f5136913
RS
3321 "Check previous word then continue with the normal binding of this key.
3322Don't check previous word when character before point is a space or newline.
3323Don't read buffer-local settings or word lists."
0349bab6
RS
3324 (interactive "*")
3325 (let ((ispell-minor-mode nil)
f5136913
RS
3326 (ispell-check-only t)
3327 (last-char (char-after (1- (point)))))
6fdf40f3
KH
3328 (command-execute (key-binding (this-command-keys)))
3329 (if (not (or (eq last-char ?\ ) (eq last-char ?\n)
fea6948a
GM
3330 (and ispell-skip-html (eq last-char ?>))
3331 (and ispell-skip-html (eq last-char ?\;))))
6fdf40f3 3332 (ispell-word nil t))))
007852e0 3333
e29702dd 3334
007852e0
RS
3335;;; **********************************************************************
3336;;; Ispell Message
3337;;; **********************************************************************
7492978d
RS
3338
3339(defvar ispell-message-text-end
3340 (mapconcat (function identity)
3341 '(
f5136913
RS
3342 ;; Don't spell check signatures
3343 "^-- $"
7492978d 3344 ;; Matches postscript files.
4d170362 3345 ;;"^%!PS-Adobe-[123].0"
7492978d 3346 ;; Matches uuencoded text
4d170362 3347 ;;"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
6fdf40f3 3348 ;; Matches shell files (especially auto-decoding)
e29702dd 3349 "^#! /bin/[ck]?sh"
8581f180 3350 ;; Matches context difference listing
f5136913
RS
3351 "\\(\\(^cd .*\n\\)?diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
3352 ;; Matches unidiff difference listing
3353 "\\(diff -u .*\\)?\n--- .*\n\\+\\+\\+ .*\n@@ [-+][0-9]+,[0-9]+ [-+][0-9]+,[0-9]+ @@\n"
3354 ;; Matches reporter.el bug report
3355 "^current state:\n==============\n"
3356 ;; Matches commonly used "cut" boundaries
3357 "^\\(- \\)?[-=_]+\\s ?\\(cut here\\|Environment Follows\\)")
7492978d 3358 "\\|")
b9431ae0 3359 "*End of text which will be checked in `ispell-message'.
e29702dd 3360If it is a string, limit at first occurrence of that regular expression.
7492978d 3361Otherwise, it must be a function which is called to get the limit.")
41d207e1 3362(put 'ispell-message-text-end 'risky-local-variable t)
007852e0 3363
4b03da72 3364
4d170362
SM
3365(defun ispell-mime-multipartp (&optional limit)
3366 "Return multipart message start boundary or nil if none."
3367 ;; caller must ensure `case-fold-search' is set to `t'
3368 (and
3369 (re-search-forward
3370 "Content-Type: *multipart/\\([^ \t\n]*;[ \t]*[\n]?[ \t]*\\)+boundary="
3371 limit t)
3372 (let (boundary)
3373 (if (looking-at "\"")
3374 (let (start)
3375 (forward-char)
3376 (setq start (point))
3377 (while (not (looking-at "\""))
3378 (forward-char 1))
3379 (setq boundary (buffer-substring-no-properties start (point))))
3380 (let ((start (point)))
3381 (while (looking-at "[-0-9a-zA-Z'()+_,./:=?]")
3382 (forward-char))
3383 (setq boundary (buffer-substring-no-properties start (point)))))
3384 (if (< (length boundary) 1)
3385 (setq boundary nil)
3386 (concat "--" boundary)))))
3387
3388
3389(defun ispell-mime-skip-part (boundary)
3390 "Moves point across header, or entire MIME part if message is encoded.
3391All specified types except `7bit' `8bit' and `quoted-printable' are considered
3392encoded and therefore skipped. See rfc 1521, 2183, ...
3393If no boundary is given, then entire message is skipped.
3394
3395This starts one line ABOVE the MIME content messages, on the boundary marker,
3396for operation with the generic region-skipping code.
3397This places new MIME boundaries into variable `ispell-checking-message'."
3398 (forward-line) ; skip over boundary to headers
3399 (let ((save-case-fold-search case-fold-search)
3400 (continuep t)
3401 textp)
3402 (setq case-fold-search t
3403 ispell-skip-html nil)
3404 (while continuep
3405 (setq continuep nil)
3406 (if (looking-at "Content-Type: *text/")
3407 (progn
3408 (goto-char (match-end 0))
3409 (if (looking-at "html")
3410 (setq ispell-skip-html t))
3411 (setq textp t
3412 continuep t)
3413 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3414 (forward-line)))
3415 (if (looking-at "Content-Transfer-Encoding: *\\([^ \t\n]*\\)")
3416 (let ((match (buffer-substring (match-beginning 1) (match-end 1))))
3417 (setq textp (member (upcase match)
3418 ;; only spell check the following encodings:
3419 '("7BIT" "8BIT" "QUOTED-PRINTABLE" "BINARY"))
3420 continuep t)
3421 (goto-char (match-end 0))
3422 (re-search-forward "\\(.*;[ \t]*[\n]\\)*.*$" nil t)
3423 (forward-line)))
3424 ;; hierarchical boundary definition
3425 (if (looking-at "Content-Type: *multipart/")
3426 (let ((new-boundary (ispell-mime-multipartp)))
3427 (if (string-match new-boundary boundary)
3428 (setq continuep t)
3429 ;; first pass redefine skip function to include new boundary
3430 ;;(re-search-backward boundary nil t)
3431 (forward-line)
3432 (setq ispell-checking-message
3433 (cons
3434 (list new-boundary 'ispell-mime-skip-part new-boundary)
3435 (if (eq t ispell-checking-message) nil
3436 ispell-checking-message))
3437 textp t
3438 continuep t)))
3439 ;; Skip all MIME headers that don't affect spelling
3440 (if (looking-at "Content-[^ \t]*: *\\(.*;[ \t]*[\n]\\)*.*$")
3441 (progn
3442 (setq continuep t)
3443 (goto-char (match-end 0))
3444 (forward-line)))))
3445
3446 (setq case-fold-search save-case-fold-search)
3447 (if textp
3448 (point)
3449 ;; encoded message. Skip to boundary, or entire message.
3450 (if (not boundary)
3451 (goto-char (point-max))
3452 (re-search-forward boundary nil t)
3453 (beginning-of-line)
3454 (point)))))
3455
8ce8687e 3456
007852e0
RS
3457;;;###autoload
3458(defun ispell-message ()
3459 "Check the spelling of a mail message or news post.
3460Don't check spelling of message headers except the Subject field.
3461Don't check included messages.
3462
6ec7837b
RS
3463To abort spell checking of a message region and send the message anyway,
3464use the `x' command. (Any subsequent regions will be checked.)
a9210a53 3465The `X' command aborts the message send so that you can edit the buffer.
007852e0
RS
3466
3467To spell-check whenever a message is sent, include the appropriate lines
3468in your .emacs file:
f5136913
RS
3469 (add-hook 'message-send-hook 'ispell-message) ;; GNUS 5
3470 (add-hook 'news-inews-hook 'ispell-message) ;; GNUS 4
007852e0
RS
3471 (add-hook 'mail-send-hook 'ispell-message)
3472 (add-hook 'mh-before-send-letter-hook 'ispell-message)
3473
e29702dd 3474You can bind this to the key C-c i in GNUS or mail by adding to
a9210a53 3475`news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
007852e0
RS
3476 (function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
3477 (interactive)
7492978d 3478 (save-excursion
4b03da72 3479 (goto-char (point-min))
4d170362
SM
3480 (let* (boundary mimep
3481 (ispell-skip-region-alist-save ispell-skip-region-alist)
f5136913
RS
3482 ;; Nil when message came from outside (eg calling emacs as editor)
3483 ;; Non-nil marker of end of headers.
3484 (internal-messagep
3485 (re-search-forward
3486 (concat "^" (regexp-quote mail-header-separator) "$") nil t))
3487 (end-of-headers ; Start of body.
3488 (copy-marker
3489 (or internal-messagep
3490 (re-search-forward "^$" nil t)
3491 (point-min))))
3492 (limit (copy-marker ; End of region we will spell check.
4b03da72
RS
3493 (cond
3494 ((not ispell-message-text-end) (point-max))
3495 ((char-or-string-p ispell-message-text-end)
3496 (if (re-search-forward ispell-message-text-end nil t)
3497 (match-beginning 0)
3498 (point-max)))
3499 (t (min (point-max) (funcall ispell-message-text-end))))))
f5136913
RS
3500 (default-prefix ; Vanilla cite prefix (just used for cite-regexp)
3501 (if (and (boundp 'mail-yank-prefix) mail-yank-prefix)
3502 (ispell-non-empty-string mail-yank-prefix)
3503 " \\|\t"))
3504 (cite-regexp ;Prefix of quoted text
7492978d 3505 (cond
4d170362 3506 ((functionp 'sc-cite-regexp) ; sc 3.0
ec6918a8
DN
3507 (with-no-warnings
3508 (concat "\\(" (sc-cite-regexp) "\\)" "\\|"
3509 (ispell-non-empty-string sc-reference-tag-string))))
4d170362 3510 ((boundp 'sc-cite-regexp) ; sc 2.3
7492978d 3511 (concat "\\(" sc-cite-regexp "\\)" "\\|"
6063ae55
RS
3512 (with-no-warnings
3513 (ispell-non-empty-string sc-reference-tag-string))))
f5136913
RS
3514 ((or (equal major-mode 'news-reply-mode) ;GNUS 4 & below
3515 (equal major-mode 'message-mode)) ;GNUS 5
7492978d 3516 (concat "In article <" "\\|"
b9431ae0 3517 "[^,;&+=\n]+ <[^,;&+=]+> writes:" "\\|"
6063ae55
RS
3518 (with-no-warnings message-cite-prefix-regexp)
3519 "\\|"
f5136913 3520 default-prefix))
7492978d 3521 ((equal major-mode 'mh-letter-mode) ; mh mail message
b9431ae0 3522 (concat "[^,;&+=\n]+ writes:" "\\|"
6063ae55
RS
3523 (with-no-warnings
3524 (ispell-non-empty-string mh-ins-buf-prefix))))
f5136913 3525 ((not internal-messagep) ; Assume nn sent us this message.
7492978d
RS
3526 (concat "In [a-zA-Z.]+ you write:" "\\|"
3527 "In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
3528 " *> *"))
3529 ((boundp 'vm-included-text-prefix) ; VM mail message
b9431ae0 3530 (concat "[^,;&+=\n]+ writes:" "\\|"
7492978d 3531 (ispell-non-empty-string vm-included-text-prefix)))
f5136913
RS
3532 (t default-prefix)))
3533 (ispell-skip-region-alist
3534 (cons (list (concat "^\\(" cite-regexp "\\)")
3535 (function forward-line))
3536 ispell-skip-region-alist))
4b03da72 3537 (old-case-fold-search case-fold-search)
f5136913 3538 (dictionary-alist ispell-message-dictionary-alist)
4b03da72 3539 (ispell-checking-message t))
f5136913
RS
3540
3541 ;; Select dictionary for message
3542 (or (local-variable-p 'ispell-local-dictionary (current-buffer))
3543 (while dictionary-alist
3544 (goto-char (point-min))
3545 (if (re-search-forward (car (car dictionary-alist))
3546 end-of-headers t)
3547 (setq ispell-local-dictionary (cdr (car dictionary-alist))
3548 dictionary-alist nil)
3549 (setq dictionary-alist (cdr dictionary-alist)))))
3550
3551 (unwind-protect
3552 (progn
3553 ;; Spell check any original Subject:
3554 (goto-char (point-min))
4d170362
SM
3555 (setq case-fold-search t
3556 mimep (re-search-forward "MIME-Version:" end-of-headers t))
3557 (goto-char (point-min))
f5136913
RS
3558 (if (re-search-forward "^Subject: *" end-of-headers t)
3559 (progn
3560 (goto-char (match-end 0))
3561 (if (and (not (looking-at ".*Re\\>"))
3562 (not (looking-at "\\[")))
b9431ae0
RS
3563 (progn
3564 (setq case-fold-search old-case-fold-search)
f5136913
RS
3565 (ispell-region (point)
3566 (progn ;Tab-initiated continuation lns.
3567 (end-of-line)
3568 (while (looking-at "\n[ \t]")
3569 (end-of-line 2))
3570 (point)))))))
4d170362
SM
3571 (if mimep
3572 (progn
3573 (goto-char (point-min))
3574 (setq boundary (ispell-mime-multipartp end-of-headers))))
3575 ;; Adjust message limit to MIME message if necessary.
3576 (and boundary
3577 (re-search-forward (concat boundary "--") nil t)
3578 (re-search-backward boundary nil t)
3579 (< (point) (marker-position limit))
3580 (set-marker limit (point)))
3581 (goto-char (point-min))
3582 ;; Select type or skip checking if this is a non-multipart message
3583 ;; Point moved to end of buffer if region is encoded.
3584 (if (and mimep (not boundary))
3585 (let (skip-regexp) ; protect from `ispell-mime-skip-part'
3586 (goto-char (point-min))
3587 (re-search-forward "Content-[^ \t]*:" end-of-headers t)
3588 (forward-line -1) ; following fn starts one line above
3589 (ispell-mime-skip-part nil)
3590 ;; if message-text-end region, limit may be less than point.
3591 (if (> (point) limit)
3592 (set-marker limit (point)))))
3593 (goto-char (max end-of-headers (point)))
f5136913 3594 (forward-line 1)
4d170362
SM
3595 (setq case-fold-search old-case-fold-search)
3596 ;; Define MIME regions to skip.
3597 (if boundary
3598 (setq ispell-checking-message
3599 (list (list boundary 'ispell-mime-skip-part boundary))))
f5136913
RS
3600 (ispell-region (point) limit))
3601 (set-marker end-of-headers nil)
4d170362
SM
3602 (set-marker limit nil)
3603 (setq ispell-skip-region-alist ispell-skip-region-alist-save
3604 ispell-skip-html nil
3605 case-fold-search old-case-fold-search)))))
4b03da72 3606
007852e0
RS
3607
3608(defun ispell-non-empty-string (string)
3609 (if (or (not string) (string-equal string ""))
3610 "\\'\\`" ; An unmatchable string if string is null.
3611 (regexp-quote string)))
3612
3613
3614;;; **********************************************************************
3615;;; Buffer Local Functions
3616;;; **********************************************************************
3617
3618
3619(defun ispell-accept-buffer-local-defs ()
f5136913 3620 "Load all buffer-local information, restarting Ispell when necessary."
007852e0
RS
3621 (ispell-buffer-local-dict) ; May kill ispell-process.
3622 (ispell-buffer-local-words) ; Will initialize ispell-process.
3623 (ispell-buffer-local-parsing))
3624
3625
007852e0 3626(defun ispell-buffer-local-parsing ()
a9210a53 3627 "Place Ispell into parsing mode for this buffer.
4b03da72 3628Overrides the default parsing mode.
f5136913 3629Includes Latex/Nroff modes and extended character mode."
007852e0 3630 ;; (ispell-init-process) must already be called.
8eba343c 3631 (ispell-send-string "!\n") ; Put process in terse mode.
007852e0 3632 ;; We assume all major modes with "tex-mode" in them should use latex parsing
6fdf40f3
KH
3633 ;; When exclusively checking comments, set to raw text mode (nroff).
3634 (if (and (not (eq 'exclusive ispell-check-comments))
3635 (or (and (eq ispell-parser 'use-mode-name)
3636 (string-match "[Tt][Ee][Xx]-mode"
3637 (symbol-name major-mode)))
3638 (eq ispell-parser 'tex)))
f5136913 3639 (progn
8eba343c 3640 (ispell-send-string "+\n") ; set ispell mode to tex
f5136913
RS
3641 (if (not (eq ispell-parser 'tex))
3642 (set (make-local-variable 'ispell-parser) 'tex)))
8eba343c 3643 (ispell-send-string "-\n")) ; set mode to normal (nroff)
f5136913 3644 ;; If needed, test for SGML & HTML modes and set a buffer local nil/t value.
fea6948a 3645 (if (and ispell-skip-html (not (eq ispell-skip-html t)))
4d170362
SM
3646 (setq ispell-skip-html
3647 (not (null (string-match "sgml\\|html\\|xml"
3648 (downcase (symbol-name major-mode)))))))
007852e0
RS
3649 ;; Set default extended character mode for given buffer, if any.
3650 (let ((extended-char-mode (ispell-get-extended-character-mode)))
3651 (if extended-char-mode
8eba343c 3652 (ispell-send-string (concat extended-char-mode "\n"))))
e29702dd 3653 ;; Set buffer-local parsing mode and extended character mode, if specified.
007852e0 3654 (save-excursion
f5136913
RS
3655 (goto-char (point-max))
3656 ;; Uses last occurrence of ispell-parsing-keyword
3657 (if (search-backward ispell-parsing-keyword nil t)
3658 (let ((end (save-excursion (end-of-line) (point)))
f5136913
RS
3659 string)
3660 (search-forward ispell-parsing-keyword)
3661 (while (re-search-forward " *\\([^ \"]+\\)" end t)
3662 ;; space separated definitions.
81771793 3663 (setq string (downcase (match-string-no-properties 1)))
6fdf40f3
KH
3664 (cond ((and (string-match "latex-mode" string)
3665 (not (eq 'exclusive ispell-check-comments)))
8eba343c 3666 (ispell-send-string "+\n~tex\n"))
f5136913 3667 ((string-match "nroff-mode" string)
8eba343c 3668 (ispell-send-string "-\n~nroff\n"))
f5136913 3669 ((string-match "~" string) ; Set extended character mode.
8eba343c 3670 (ispell-send-string (concat string "\n")))
f5136913
RS
3671 (t (message "Invalid Ispell Parsing argument!")
3672 (sit-for 2))))))))
007852e0
RS
3673
3674
3675;;; Can kill the current ispell process
3676
87a6b92c 3677(defun ispell-buffer-local-dict (&optional no-reload)
f5136913 3678 "Initializes local dictionary and local personal dictionary.
87a6b92c 3679If optional NO-RELOAD is non-nil, do not make any dictionary reloading.
007852e0 3680When a dictionary is defined in the buffer (see variable
a9210a53 3681`ispell-dictionary-keyword'), it will override the local setting
007852e0
RS
3682from \\[ispell-change-dictionary].
3683Both should not be used to define a buffer-local dictionary."
3684 (save-excursion
3685 (goto-char (point-min))
3686 (let (end)
3687 ;; Override the local variable definition.
f5136913
RS
3688 ;; Uses last occurrence of ispell-dictionary-keyword.
3689 (goto-char (point-max))
a6e7a34b
RS
3690 (unless ispell-local-dictionary-overridden
3691 (if (search-backward ispell-dictionary-keyword nil t)
3692 (progn
3693 (search-forward ispell-dictionary-keyword)
3694 (setq end (save-excursion (end-of-line) (point)))
3695 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3696 (setq ispell-local-dictionary
81771793 3697 (match-string-no-properties 1))))))
f5136913
RS
3698 (goto-char (point-max))
3699 (if (search-backward ispell-pdict-keyword nil t)
3700 (progn
3701 (search-forward ispell-pdict-keyword)
3702 (setq end (save-excursion (end-of-line) (point)))
3703 (if (re-search-forward " *\\([^ \"]+\\)" end t)
3704 (setq ispell-local-pdict
81771793 3705 (match-string-no-properties 1)))))))
87a6b92c
EZ
3706 (unless no-reload
3707 ;; Reload if new dictionary (maybe the personal one) defined.
3708 (ispell-internal-change-dictionary)))
007852e0
RS
3709
3710
3711(defun ispell-buffer-local-words ()
a9210a53 3712 "Loads the buffer-local dictionary in the current buffer."
09b2eb5e
RS
3713 ;; If there's an existing ispell process that's wrong for this use,
3714 ;; kill it.
007852e0
RS
3715 (if (and ispell-buffer-local-name
3716 (not (equal ispell-buffer-local-name (buffer-name))))
09b2eb5e
RS
3717 (ispell-kill-ispell t))
3718 ;; Actually start a new ispell process, because we need
3719 ;; to send commands now to specify the local words to it.
007852e0
RS
3720 (ispell-init-process)
3721 (save-excursion
3722 (goto-char (point-min))
3723 (while (search-forward ispell-words-keyword nil t)
3724 (or ispell-buffer-local-name
3725 (setq ispell-buffer-local-name (buffer-name)))
3726 (let ((end (save-excursion (end-of-line) (point)))
f5136913 3727 (ispell-casechars (ispell-get-casechars))
007852e0 3728 string)
e29702dd 3729 ;; buffer-local words separated by a space, and can contain
f5136913 3730 ;; any character other than a space. Not rigorous enough.
7195bb71 3731 (while (re-search-forward " *\\([^ ]+\\)" end t)
81771793 3732 (setq string (match-string-no-properties 1))
64ef5f39 3733 ;; This can fail when string contains a word with invalid chars.
f5136913
RS
3734 ;; Error handling needs to be added between ispell and emacs.
3735 (if (and (< 1 (length string))
3736 (equal 0 (string-match ispell-casechars string)))
8eba343c 3737 (ispell-send-string (concat "@" string "\n"))))))))
007852e0
RS
3738
3739
3740;;; returns optionally adjusted region-end-point.
3741
f5136913 3742(defun ispell-add-per-file-word-list (word)
b9431ae0 3743 "Add WORD to the per-file word list."
007852e0
RS
3744 (or ispell-buffer-local-name
3745 (setq ispell-buffer-local-name (buffer-name)))
007852e0
RS
3746 (save-excursion
3747 (goto-char (point-min))
b9431ae0 3748 (let ((old-case-fold-search case-fold-search)
fea6948a 3749 line-okay search done found)
007852e0 3750 (while (not done)
b9431ae0
RS
3751 (setq case-fold-search nil
3752 search (search-forward ispell-words-keyword nil 'move)
fea6948a 3753 found (or found search)
007852e0
RS
3754 line-okay (< (+ (length word) 1 ; 1 for space after word..
3755 (progn (end-of-line) (current-column)))
b9431ae0
RS
3756 80)
3757 case-fold-search old-case-fold-search)
007852e0
RS
3758 (if (or (and search line-okay)
3759 (null search))
3760 (progn
3761 (setq done t)
3762 (if (null search)
3763 (progn
3764 (open-line 1)
fea6948a
GM
3765 (unless found (newline))
3766 (insert (concat comment-start " " ispell-words-keyword))
3767 (if (> (length comment-end) 0)
007852e0 3768 (save-excursion
fea6948a 3769 (newline)
007852e0 3770 (insert comment-end)))))
f5136913 3771 (insert (concat " " word))))))))
007852e0 3772
f1ed9461 3773(add-to-list 'debug-ignored-errors "^No word found to check!$")
007852e0 3774
007852e0
RS
3775(provide 'ispell)
3776
3777\f
3778;;; LOCAL VARIABLES AND BUFFER-LOCAL VALUE EXAMPLES.
3779
3780;;; Local Variable options:
3781;;; mode: name(-mode)
3782;;; eval: expression
3783;;; local-variable: value
3784
6fdf40f3 3785;;; The following sets the buffer local dictionary to `american' English
f5136913 3786;;; and spell checks only comments.
007852e0
RS
3787
3788;;; Local Variables:
3789;;; mode: emacs-lisp
3790;;; comment-column: 40
f5136913 3791;;; ispell-check-comments: exclusive
9050446c 3792;;; ispell-local-dictionary: "american"
007852e0
RS
3793;;; End:
3794
3795
3796;;; MORE EXAMPLES OF ISPELL BUFFER-LOCAL VALUES
3797
3798;;; The following places this file in nroff parsing and extended char modes.
3799;;; Local IspellParsing: nroff-mode ~nroff
007852e0
RS
3800;;; Change IspellPersDict to IspellPersDict: to enable the following line.
3801;;; Local IspellPersDict ~/.ispell_lisp
3802;;; The following were automatically generated by ispell using the 'A' command:
6fdf40f3
KH
3803; LocalWords: settable alist inews mh frag pdict Wildcards iconify arg tex kss
3804; LocalWords: alists minibuffer bufferp autoload loaddefs aff Dansk KOI SPC op
3805; LocalWords: Francais Nederlands charset autoloaded popup nonmenu regexp num
3806; LocalWords: AMStex hspace includeonly nocite epsfig displaymath eqnarray reg
3807; LocalWords: minipage modeline pers dict unhighlight buf grep sync prev inc
3808; LocalWords: fn hilight oldot NB AIX msg init read's bufs pt cmd Quinlan eg
3809; LocalWords: uuencoded unidiff sc nn VM SGML eval IspellPersDict unsplitable
9050446c 3810; LocalWords: lns XEmacs HTML casechars Multibyte
f5136913 3811
cbee283d 3812;; arch-tag: 4941b9f9-3b7c-4a76-a4ed-5fa8b6010ef5
f5136913 3813;;; ispell.el ends here