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