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