-;;;;;;;;;;;;;;;;;;;;;;;;;;; -*- Mode: emacs-lisp -*- ;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; GNU EMACS interface for International Ispell Version 3.1 by Geoff Kuenning.
-;;;
-;;;
-;;; Copyright (C) 1994 Free Software Foundation, Inc.
-;;;
-;;;
-;;; Authors : Ken Stevens et. al.
-;;; Last Modified By: Ken Stevens <k.stevens@ieee.org>
-;;; Last Modified On: Tue Feb 15 16:11:14 MST 1994
-;;; Update Revision : 2.26
+;;; ispell.el --- spell checking using Ispell
+
+;;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
+
+;;; Authors : Ken Stevens <k.stevens@ieee.org>
+;;; Note: version numbers and time stamp are not updated
+;;; when this file is edited for release with GNU Emacs.
+;;; Last Modified On: Tue Jun 13 12:05:28 EDT 1995
+;;; Update Revision : 2.37
;;; Syntax : emacs-lisp
-;;; Status : Release with 3.1.03 ispell.
+;;; Status : Release with 3.1.12+ ispell.
;;; Version : International Ispell Version 3.1 by Geoff Kuenning.
-;;;
+;;; Bug Reports : ispell-el-bugs@itcorp.com
+
+;;; Note: version numbers and time stamp are not updated
+;;; when this file is edited for release with GNU Emacs.
+
;;; This file is part of GNU Emacs.
;;;
;;; GNU Emacs is free software; you can redistribute it and/or modify
;;; country and language.
;;;
;;;
-;;; To fully install this, add this file to your GNU lisp directory and
+;;; To fully install this, add this file to your Emacs Lisp directory and
;;; compile it with M-X byte-compile-file. Then add the following to the
;;; appropriate init file:
;;;
;;;
;;; HISTORY
;;;
-;;; Revision 2.26
+;;; Revision 2.37 1995/6/13 12:05:28 stevens
+;;; Removed autoload from ispell-dictionary-alist. *choices* mode-line shows
+;;; misspelled word. Block skip for pgp & forwarded messages added.
+;;; RMS: the autoload changes had problems and I removed them.
+;;;
+;;; Revision 2.36 1995/2/6 17:39:38 stevens
+;;; Properly adjust screen with different ispell-choices-win-default-height
+;;; settings. Skips SGML entity references.
+;;;
+;;; Revision 2.35 1995/1/13 14:16:46 stevens
+;;; Skips SGML tags, ispell-change-dictionary fix for add-hook, assure personal
+;;; dictionary is saved when called from the menu
+;;;
+;;; Revision 2.34 1994/12/08 13:17:41 stevens
+;;; Interaction corrected to function with all 3.1 ispell versions.
+;;;
+;;; Revision 2.33 1994/11/24 02:31:20 stevens
+;;; Repaired bug introduced in 2.32 that corrupts buffers when correcting.
+;;; Improved buffer scrolling. Nondestructive buffer selections allowed.
+;;;
+;;; Revision 2.32 1994/10/31 21:10:08 geoff
+;;; Many revisions accepted from RMS/FSF. I think (though I don't know) that
+;;; this represents an 'official' version.
+;;;
+;;; Revision 2.31 1994/5/31 10:18:17 stevens
+;;; Repaired comments. buffer-local commands executed in `ispell-word' now.
+;;; German dictionary described for extended character mode. Dict messages.
+;;;
+;;; Revision 2.30 1994/5/20 22:18:36 stevens
+;;; Continue ispell from ispell-word, C-z functionality fixed.
+;;;
+;;; Revision 2.29 1994/5/12 09:44:33 stevens
+;;; Restored ispell-use-ptys-p, ispell-message aborts sends with interrupt.
+;;; defined fn ispell
+;;;
+;;; Revision 2.28 1994/4/28 16:24:40 stevens
+;;; Window checking when ispell-message put on gnus-inews-article-hook jwz.
+;;; prefixed ispell- to highlight functions and horiz-scroll fn.
+;;; Try and respect case of word in ispell-complete-word.
+;;; Ignore non-char events. Ispell-use-ptys-p commented out. Lucid menu.
+;;; Better interrupt handling. ispell-message improvements from Ethan.
+;;;
+;;; Revision 2.27
+;;; version 18 explicit C-g handling disabled as it didn't work. Added
+;;; ispell-extra-args for ispell customization (jwz)
+;;;
+;;; Revision 2.26 1994/2/15 16:11:14 stevens
;;; name changes for copyright assignment. Added word-frags in complete-word.
-;;; Horizontal scroll (John Conover) Query-replace matches words now. bugs.
+;;; Horizontal scroll (John Conover). Query-replace matches words now. bugs.
;;;
;;; Revision 2.25
;;; minor mods, upgraded ispell-message
;;; Code:
(defvar ispell-highlight-p t
- "*When not nil, spelling errors will be highlighted.")
+ "*Highlight spelling errors when non-nil.")
(defvar ispell-highlight-face 'highlight
- "*The face used for ispell highlighting. For Emacses with overlays.
-Common values for GNU emacs are highlight, modeline, secondary-selection,
- region, and underline.
+ "*The face used for Ispell highlighting. For Emacses with overlays.
+Possible values are `highlight', `modeline', `secondary-selection',
+`region', and `underline'.
This variable can be set by the user to whatever face they desire.
It's most convenient if the cursor color and highlight color are
- slightly different.")
+slightly different.")
(defvar ispell-check-comments nil
- "*When true, the spelling of comments in region is checked.")
+ "*Spelling of comments checked when non-nil.")
(defvar ispell-query-replace-choices nil
- "*When true and spell checking a region, the correction will be made
-throughout the buffer using \\[query-replace].")
+ "*Corrections made throughout region when non-nil.
+Uses `query-replace' (\\[query-replace]) for corrections.")
(defvar ispell-skip-tib nil
- "*If non-nil, the spelling of references for the tib(1) bibliography
-program are skipped. Otherwise any text between strings matching the regexps
-ispell-tib-ref-beginning and ispell-tib-ref-end is ignored.
+ "*Does not spell check `tib' bibliography references when non-nil.
+Skips any text between strings matching regular expressions
+`ispell-tib-ref-beginning' and `ispell-tib-ref-end'.
TeX users beware: Any field starting with [. will skip until a .] -- even
-your whole buffer -- unless you set ispell-skip-tib to nil. That includes
+your whole buffer -- unless you set `ispell-skip-tib' to nil. That includes
a [.5mm] type of number....")
(defvar ispell-tib-ref-beginning "[[<]\\."
"Regexp matching the end of a Tib reference.")
(defvar ispell-keep-choices-win t
- "*When not nil, the *Choices* window remains for spelling session.
+ "*When not nil, the `*Choices*' window remains for spelling session.
This minimizes redisplay thrashing.")
(defvar ispell-choices-win-default-height 2
- "*The default size of the *Choices*, including status line.
- Must be greater than 1.")
+ "*The default size of the `*Choices*' window, including status line.
+Must be greater than 1.")
(defvar ispell-program-name "ispell"
"Program invoked by \\[ispell-word] and \\[ispell-region] commands.")
(defvar ispell-alternate-dictionary
(cond ((file-exists-p "/usr/dict/web2") "/usr/dict/web2")
+ ((file-exists-p "/usr/share/dict/web2") "/usr/share/dict/web2")
((file-exists-p "/usr/dict/words") "/usr/dict/words")
((file-exists-p "/usr/lib/dict/words") "/usr/lib/dict/words")
+ ((file-exists-p "/usr/share/dict/words") "/usr/share/dict/words")
((file-exists-p "/sys/dict") "/sys/dict")
(t "/usr/dict/words"))
"*Alternate dictionary for spelling help.")
(defvar ispell-complete-word-dict ispell-alternate-dictionary
"*Dictionary used for word completion.")
-(defvar ispell-grep-command "/usr/bin/egrep"
+(defvar ispell-grep-command "egrep"
"Name of the grep command for search processes.")
(defvar ispell-grep-options "-i"
- "Options for ispell-grep-command.
+ "String of options to use when running the program in `ispell-grep-command'.
Should probably be \"-i\" or \"-e\".
Some machines (like the NeXT) don't support \"-i\"")
-(defvar ispell-look-command "/usr/bin/look"
+(defvar ispell-look-command "look"
"Name of the look command for search processes.
-Must contain complete path!")
+This must be an absolute file name.")
(defvar ispell-look-p (file-exists-p ispell-look-command)
- "*Use look. Should be nil if your UNIX doesn't have this program.
-Attempts to automatically reset if look not available")
+ "*Non-nil means use `look' rather than `grep'.
+Default is based on whether `look' seems to be available.")
(defvar ispell-have-new-look nil
"*Non-nil means use the `-r' option (regexp) when running `look'.")
(defvar ispell-look-options (if ispell-have-new-look "-dfr" "-df")
- "Options for ispell-look-command")
+ "String of command options for `ispell-look-command'.")
(defvar ispell-use-ptys-p nil
- "When t, Emacs uses pty's to communicate with Ispell.
+ "When non-nil, Emacs uses ptys to communicate with Ispell.
When nil, Emacs uses pipes.")
(defvar ispell-following-word nil
- "*If non-nil the \\[ispell-word] command will check the spelling
-of the word under or following \(rather than preceding\) the cursor
-when called interactively.")
+ "*Non-nil means `ispell-word' checks the word around or after point.
+Otherwise `ispell-word' checks the preceding word.")
-(defvar ispell-help-in-bufferp t
- "*If non-nil, the \\[ispell-help] command will display its
-message in a buffer. Otherwise the minibuffer will be used.")
+(defvar ispell-help-in-bufferp nil
+ "*Non-nil means display interactive keymap help in a buffer.
+Otherwise use the minibuffer.")
(defvar ispell-quietly nil
- "*If non-nil, the \\[ispell-word] command will suppress all
-non-corrective messages when called interactively.")
+ "*Non-nil means suppress messages in `ispell-word'.")
(defvar ispell-format-word (function upcase)
- "*The function called to format the word whose spelling is being checked,
-in diagnostic messages to the user. The function must take one string
-argument and return a string.")
+ "*Formatting function for displaying word being spell checked.
+The function must take one string argument and return a string.")
+;;;###autoload
(defvar ispell-personal-dictionary nil
- "*A string or nil. If nil, the default directory, ~/.ispell_words is used.")
+ "*File name of your personal spelling dictionary, or nil.
+If nil, the default personal dictionary, \"~/.ispell_DICTNAME\" is used,
+where DICTNAME is the name of your default dictionary.")
(defvar ispell-silently-savep nil
- "*When non-nil, save the personal dictionary without user verification.")
+ "*When non-nil, save the personal dictionary without confirmation.")
;;; This variable contains the current dictionary being used if the ispell
;;; process is running. Otherwise it contains the global default.
(defvar ispell-dictionary nil
"If non-nil, a dictionary to use instead of the default one.
-This is passed to the ispell process using the \"-d\" switch and is
-used as key in ispell-dictionary-alist (which see).
+This is passed to the ispell process using the `-d' switch and is
+used as key in `ispell-dictionary-alist' (which see).
+
+You should set this variable before your first use of Emacs spell-checking
+commands in the Emacs session, or else use the \\[ispell-change-dictionary]
+command to change it. Otherwise, this variable only takes effect in a newly
+started Ispell process.")
-You should set this variable before your first call to ispell (e.g. in
-your .emacs), or use the \\[ispell-change-dictionary] command to
-change it, as changing this variable only takes effect in a newly
-started ispell process.")
+(defvar ispell-extra-args nil
+ "*If non-nil, a list of extra switches to pass to the Ispell program.
+For example, '(\"-W\" \"3\") to cause it to accept all 1-3 character
+words as correct. See also `ispell-dictionary-alist', which may be used
+for language-specific arguments.")
+
+;;; The preparation of the menu bar menu must be autoloaded
+;;; because otherwise this file gets autoloaded every time Emacs starts
+;;; so that it can set up the menus and determine keyboard equivalents.
;;;###autoload
-(defvar ispell-dictionary-alist ; sk 9-Aug-1991 18:28
+(defvar ispell-dictionary-alist-1 ; sk 9-Aug-1991 18:28
'((nil ; default (english.aff)
- "[A-Za-z]" "[^A-Za-z]" "[-']" nil ("-B") nil)
+ "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
("english" ; make english explicitly selectable
- "[A-Za-z]" "[^A-Za-z]" "[-']" nil ("-B") nil)
+ "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
+ ("british" ; british version
+ "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B" "-d" "british") nil)
("deutsch" ; deutsch.aff
- "[a-zA-Z\"]" "[^a-zA-Z\"]" "[-']" t ("-C") nil)
+ "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex")
("deutsch8"
"[a-zA-Z\304\326\334\344\366\337\374]"
"[^a-zA-Z\304\326\334\344\366\337\374]"
- "[-']" t ("-C" "-d" "deutsch") "~latin1")
+ "[']" t ("-C" "-d" "deutsch") "~latin1")
+ ("nederlands" ; nederlands.aff
+ "[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
+ "[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
+ "[']" t ("-C") nil)
("nederlands8" ; dutch8.aff
"[A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
"[^A-Za-z\300-\305\307\310-\317\322-\326\331-\334\340-\345\347\350-\357\361\362-\366\371-\374]"
- "[-']" t ("-C") nil)
- ("svenska" ;7 bit swedish mode
+ "[']" t ("-C") nil)))
+
+;;;###autoload
+(defvar ispell-dictionary-alist-2
+ '(("svenska" ;7 bit swedish mode
"[A-Za-z}{|\\133\\135\\\\]" "[^A-Za-z}{|\\133\\135\\\\]"
- "[-']" nil ("-C") nil)
+ "[']" nil ("-C") nil)
("svenska8" ;8 bit swedish mode
"[A-Za-z\345\344\366\305\304\366]" "[^A-Za-z\345\344\366\305\304\366]"
- "[-']" nil ("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
- ("francais"
- "[A-Za-z]" "[^A-Za-z]" "[-`'\^]" nil nil nil)
- ("danish" ; danish.aff
+ "[']" nil ("-C" "-d" "svenska") "~list") ; Add `"-T" "list"' instead?
+ ("francais7"
+ "[A-Za-z]" "[^A-Za-z]" "[`'^---]" t nil nil)
+ ("francais" ; francais.aff
+ "[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]"
+ "[^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]"
+ "[---']" t nil "~list")
+ ("francais-tex" ; francais.aff
+ "[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\\]"
+ "[^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\\]"
+ "[---'^`\"]" t nil "~tex")
+ ("dansk" ; dansk.aff
"[A-Z\306\330\305a-z\346\370\345]" "[^A-Z\306\330\305a-z\346\370\345]"
- "[-]" nil ("-C") nil)
- )
+ "" nil ("-C") nil)
+ ))
+
+
+;;; ispell-dictionary-alist is set up from two subvariables above
+;;; to avoid having very long lines in loaddefs.el.
+;;;###autoload
+(defvar ispell-dictionary-alist
+ (append ispell-dictionary-alist-1 ispell-dictionary-alist-2)
"An alist of dictionaries and their associated parameters.
Each element of this list is also a list:
- \(DICTIONARY-NAME
- CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
+\(DICTIONARY-NAME CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
ISPELL-ARGS EXTENDED-CHARACTER-MODE\)
-DICTIONARY-NAME is a possible value of variable ispell-dictionary, nil
+DICTIONARY-NAME is a possible value of variable `ispell-dictionary', nil
means the default dictionary.
CASECHARS is a regular expression of valid characters that comprise a
subprocess.
EXTENDED-CHARACTER-MODE should be used when dictionaries are used which
-have been configured in ispell's parse.y. (For example, umlauts
+have been configured in an Ispell affix file. (For example, umlauts
can be encoded as \\\"a, a\\\", \"a, ...) Defaults are ~tex and ~nroff
-in english. This has the same effect as the command-line `-T' option.
-The buffer Major Mode controls ispell's parsing in tex or nroff mode,
+in English. This has the same effect as the command-line `-T' option.
+The buffer Major Mode controls Ispell's parsing in tex or nroff mode,
but the dictionary can control the extended character mode.
Both defaults can be overruled in a buffer-local fashion. See
-ispell-parsing-keyword for details on this.
+`ispell-parsing-keyword' for details on this.
Note that the CASECHARS and OTHERCHARS slots of the alist should
contain the same character set as casechars and otherchars in the
language.aff file \(e.g., english.aff\).")
+;;;###autoload
+(defvar ispell-menu-map nil "Key map for ispell menu")
-;;; ispell-menu-map from menu-bar.el
+;;;###autoload
+(defvar ispell-menu-lucid nil "Spelling menu for Lucid Emacs.")
+
+;;; Break out lucid menu and split into several calls to avoid having
+;;; long lines in loaddefs.el. Detect need off following constant.
;;;###autoload
-(defvar ispell-menu-map nil)
+(defconst ispell-menu-map-needed ; make sure this is not Lucid Emacs
+ (and (not ispell-menu-map)
+;;; This is commented out because it fails in Emacs.
+;;; due to the fact that menu-bar is loaded much later than loaddefs.
+;;; ;; make sure this isn't Lucid Emacs
+;;; (featurep 'menu-bar)
+ (not (string-match "Lucid" emacs-version))))
+
+;;; Set up dictionary
;;;###autoload
-(if (null ispell-menu-map)
+(if ispell-menu-map-needed
(let ((dicts (reverse (cons (cons "default" nil) ispell-dictionary-alist)))
name)
(setq ispell-menu-map (make-sparse-keymap "Spell"))
+ ;; add the dictionaries to the bottom of the list.
(while dicts
(setq name (car (car dicts))
dicts (cdr dicts))
(define-key ispell-menu-map (vector (intern name))
(cons (concat "Select " (capitalize name))
(list 'lambda () '(interactive)
- (list 'ispell-change-dictionary name))))))
- ;; Why do we need an alias here?
- (defalias 'ispell-menu-map ispell-menu-map)
- ;; Define commands in opposite order you want them to appear in menu.
+ (list 'ispell-change-dictionary name))))))))
+
+;;; define commands in menu in opposite order you want them to appear.
+;;;###autoload
+(if ispell-menu-map-needed
+ (progn
(define-key ispell-menu-map [ispell-change-dictionary]
'("Change Dictionary" . ispell-change-dictionary))
(define-key ispell-menu-map [ispell-kill-ispell]
'("Kill Process" . ispell-kill-ispell))
(define-key ispell-menu-map [ispell-pdict-save]
- '("Save Dictionary" . (lambda () (interactive) (ispell-pdict-save t))))
+ '("Save Dictionary" . (lambda () (interactive) (ispell-pdict-save t t))))
(define-key ispell-menu-map [ispell-complete-word]
'("Complete Word" . ispell-complete-word))
(define-key ispell-menu-map [ispell-complete-word-interior-frag]
- '("Complete Word Frag" . ispell-complete-word-interior-frag))
+ '("Complete Word Frag" . ispell-complete-word-interior-frag))))
+
+;;;###autoload
+(if ispell-menu-map-needed
+ (progn
(define-key ispell-menu-map [ispell-continue]
'("Continue Check" . ispell-continue))
- (define-key ispell-menu-map [ispell-region]
- '("Check Region" . ispell-region))
(define-key ispell-menu-map [ispell-word]
'("Check Word" . ispell-word))
+ (define-key ispell-menu-map [ispell-region]
+ '("Check Region" . ispell-region))
(define-key ispell-menu-map [ispell-buffer]
- '("Check Buffer" . ispell-buffer))
+ '("Check Buffer" . ispell-buffer))))
+
+;;;###autoload
+(if ispell-menu-map-needed
+ (progn
(define-key ispell-menu-map [ispell-message]
'("Check Message" . ispell-message))
(define-key ispell-menu-map [ispell-help]
+ ;; use (x-popup-menu last-nonmenu-event(list "" ispell-help-list)) ?
'("Help" . (lambda () (interactive) (describe-function 'ispell-help))))
- ))
-
+ (put 'ispell-region 'menu-enable 'mark-active)
+ (fset 'ispell-menu-map (symbol-value 'ispell-menu-map))))
+
+;;; Xemacs version 19
+(if (and (string-lessp "19" emacs-version)
+ (string-match "Lucid" emacs-version))
+ (let ((dicts (cons (cons "default" nil) ispell-dictionary-alist))
+ (current-menubar (or current-menubar default-menubar))
+ (menu
+ '(["Help" (describe-function 'ispell-help) t]
+ ;;["Help" (popup-menu ispell-help-list) t]
+ ["Check Message" ispell-message t]
+ ["Check Buffer" ispell-buffer t]
+ ["Check Word" ispell-word t]
+ ["Check Region" ispell-region (or (not zmacs-regions) (mark))]
+ ["Continue Check" ispell-continue t]
+ ["Complete Word Frag"ispell-complete-word-interior-frag t]
+ ["Complete Word" ispell-complete-word t]
+ ["Kill Process" ispell-kill-ispell t]
+ "-"
+ ["Save Dictionary" (ispell-pdict-save t t) t]
+ ["Change Dictionary" ispell-change-dictionary t]))
+ name)
+ (while dicts
+ (setq name (car (car dicts))
+ dicts (cdr dicts))
+ (if (stringp name)
+ (setq menu (append menu
+ (list
+ (vector (concat "Select " (capitalize name))
+ (list 'ispell-change-dictionary name)
+ t))))))
+ (setq ispell-menu-lucid menu)
+ (if current-menubar
+ (progn
+ (delete-menu-item '("Edit" "Spell")) ; in case already defined
+ (add-menu '("Edit") "Spell" ispell-menu-lucid)))))
;;; **********************************************************************
;;; **********************************************************************
-;;; This doesn't match the LAST patch number -- this is for 3.1 or 3.0.09
-(defconst ispell-required-versions '("3.1." "3.0.09")
+;;; The version must be 3.1 or greater for this version of ispell.el
+;;; There is an incompatibility between version 3.1.12 and lower versions.
+(defconst ispell-required-version '("3.1." 12)
"Ispell versions with which this version of ispell.el is known to work.")
+(defvar ispell-offset 1
+ "Offset that maps protocol differences between ispell 3.1 versions.")
(defun ispell-get-casechars ()
(nth 1 (assoc ispell-dictionary ispell-dictionary-alist)))
(nth 6 (assoc ispell-dictionary ispell-dictionary-alist)))
(defvar ispell-process nil
- "Holds the process object for 'ispell'")
+ "The process object for Ispell.")
(defvar ispell-pdict-modified-p nil
- "T when the personal dictionary has modifications that need to be written.")
+ "Non-nil means personal dictionary has modifications to be saved.")
;;; If you want to save the dictionary when quitting, must do so explicitly.
-(defvar ispell-quit nil
- "Set to t or point when user wants to abort ispell session.")
+;;; When non-nil, the spell session is terminated.
+;;; When numeric, contains cursor location in buffer, and cursor remains there.
+(defvar ispell-quit nil)
(defvar ispell-filter nil
- "Output filter from piped calls to ispell.")
+ "Output filter from piped calls to Ispell.")
(defvar ispell-filter-continue nil
- "Control variable for ispell filter function.")
+ "Control variable for Ispell filter function.")
(defvar ispell-process-directory nil
- "The directory where ispell-process was started.")
+ "The directory where `ispell-process' was started.")
(defvar ispell-query-replace-marker (make-marker)
- "Marker for query-replace processing.")
+ "Marker for `query-replace' processing.")
(defvar ispell-checking-message nil
"Non-nil when we're checking a mail message")
(defconst ispell-choices-buffer "*Choices*")
-(defvar ispell-overlay nil "overlay variable for ispell")
+(defvar ispell-overlay nil "Overlay variable for Ispell highlighting.")
;;; *** Buffer Local Definitions ***
;;; This is the local dictionary to use. When nil the default dictionary will
;;; be used. Do not redefine default value or it will override the global!
(defvar ispell-local-dictionary nil
- "A buffer local variable. If non-nil, a dictionary to be used when running
-an ispell-command in this buffer. Setting ispell-local-dictionary to a value
-has the same effect as calling \\[ispell-change-dictionary] with that value.
-This variable is automatically set when defined in the file with either
-ispell-dictionary-keyword or the Local Variable syntax.
-If using Local Variable syntax, the dictionary must be a string.")
+ "If non-nil, a dictionary to use for Ispell commands in this buffer.
+The value must be a string dictionary name in `ispell-dictionary-alist'.
+This variable becomes buffer-local when set in any fashion.
+
+Setting ispell-local-dictionary to a value has the same effect as
+calling \\[ispell-change-dictionary] with that value. This variable
+is automatically set when defined in the file with either
+`ispell-dictionary-keyword' or the Local Variable syntax.")
(make-variable-buffer-local 'ispell-local-dictionary)
(defconst ispell-dictionary-keyword "Local IspellDict: "
"The keyword for local dictionary definitions.
There should be only one dictionary keyword definition per file, and it
-should be followed by a correct dictionary name in ispell-dictionary-alist.")
+should be followed by a correct dictionary name in `ispell-dictionary-alist'.")
(defconst ispell-parsing-keyword "Local IspellParsing: "
- "The keyword for overriding default ispell parsing as determined by
-the buffer's major mode and extended-character mode as determined by the
-default dictionary.
+ "The keyword for overriding default Ispell parsing.
+Determined by the buffer's major mode and extended-character mode as well as
+the default dictionary.
The above keyword string should be followed by `latex-mode' or
`nroff-mode' to put the current buffer into the desired parsing mode.
Extended character mode can be changed for this buffer by placing
a `~' followed by an extended-character mode -- such as `~.tex'.")
+(defvar ispell-skip-sgml nil
+ "Skips spell checking of SGML tags and entity references when non-nil.
+This variable is set when major-mode is sgml-mode or html-mode.")
+
(defvar ispell-local-pdict ispell-personal-dictionary
- "A buffer local variable. If a personal dictionary is specified for
-the current buffer which is different from the current personal dictionary,
-the effect will be similar to calling \\[ispell-change-dictionary].
-This variable is automatically set when defined in the file with either
-ispell-pdict-keyword or the local variable syntax.
-If using Local variable syntax, the dictionary must be nil or a string.")
+ "A buffer local variable containing the current personal dictionary.
+If non-nil, the value must be a string, which is a file name.
+
+If you specify a personal dictionary for the current buffer which is
+different from the current personal dictionary, the effect is similar
+to calling \\[ispell-change-dictionary]. This variable is automatically
+set when defined in the file with either `ispell-pdict-keyword' or the
+local variable syntax.")
(make-variable-buffer-local 'ispell-local-pdict)
(defvar ispell-parser 'use-mode-name
"*Indicates whether ispell should parse the current buffer as TeX Code.
-Special value 'use-mode-name tries to guess using the name of major-mode.
+Special value `use-mode-name' tries to guess using the name of major-mode.
Default parser is 'nroff.
Currently the only other valid parser is 'tex.
(defvar ispell-region-end (make-marker)
"Marker that allows spelling continuations.")
+(defvar ispell-check-only nil
+ "If non-nil, `ispell-word' does not try to correct the word.")
+
;;; **********************************************************************
;;; **********************************************************************
-;;;###autoload (define-key global-map "\M-$" 'ispell-word)
+(and (string-lessp "19" emacs-version)
+ (not (boundp 'epoch::version))
+ (defalias 'ispell 'ispell-buffer))
+
+;;;###autoload
+(define-key global-map "\M-$" 'ispell-word)
;;;###autoload
(defun ispell-word (&optional following quietly continue)
"Check spelling of word under or before the cursor.
-If word not found in dictionary, display possible corrections in a window
-and let user select.
- With a prefix argument (or if CONTINUE is non-nil),
+If the word is not found in dictionary, display possible corrections
+in a window allowing you to choose one.
+
+With a prefix argument (or if CONTINUE is non-nil),
resume interrupted spell-checking of a buffer or region.
- If optional argument FOLLOWING is non-nil or if `ispell-following-word'
+
+If optional argument FOLLOWING is non-nil or if `ispell-following-word'
is non-nil when called interactively, then the following word
\(rather than preceding\) is checked when the cursor is not over a word.
- When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
+When the optional argument QUIETLY is non-nil or `ispell-quietly' is non-nil
when called interactively, non-corrective messages are suppressed.
- Word syntax described by `ispell-dictionary-alist' (which see).
+Word syntax described by `ispell-dictionary-alist' (which see).
This will check or reload the dictionary. Use \\[ispell-change-dictionary]
or \\[ispell-region] to update the Ispell process."
(if (interactive-p)
(setq following ispell-following-word
quietly ispell-quietly))
- (ispell-buffer-local-dict) ; use the correct dictionary
+ (ispell-accept-buffer-local-defs) ; use the correct dictionary
(let ((cursor-location (point)) ; retain cursor location
- ispell-keep-choices-win ; override global to force creation
(word (ispell-get-word following))
start end poss replace)
;; destructure return word info list.
(or quietly
(message "Checking spelling of %s..."
(funcall ispell-format-word word)))
- (ispell-init-process) ; erases ispell output buffer
(process-send-string ispell-process "%\n") ;put in verbose mode
(process-send-string ispell-process (concat "^" word "\n"))
;; wait until ispell has processed word
(funcall ispell-format-word word)
(funcall ispell-format-word poss))))
((null poss) (message "Error in ispell process"))
+ (ispell-check-only ; called from ispell minor mode.
+ (beep))
(t ; prompt for correct word.
- (unwind-protect
- (progn
- (if ispell-highlight-p
- (highlight-spelling-error start end t)) ; highlight word
- (setq replace (ispell-command-loop
- (car (cdr (cdr poss)))
- (car (cdr (cdr (cdr poss))))
- (car poss))))
- ;; protected
- (if ispell-highlight-p ; clear highlight
- (highlight-spelling-error start end)))
+ (save-window-excursion
+ (setq replace (ispell-command-loop
+ (car (cdr (cdr poss)))
+ (car (cdr (cdr (cdr poss))))
+ (car poss) start end)))
(cond ((equal 0 replace)
(ispell-add-per-file-word-list (car poss)))
(replace
- (delete-region start end)
(setq word (if (atom replace) replace (car replace))
cursor-location (+ (- (length word) (- end start))
cursor-location))
- (insert word)
+ (if (not (equal word (car poss)))
+ (progn
+ (delete-region start end)
+ (insert word)))
(if (not (atom replace)) ; recheck spelling of replacement
(progn
(goto-char cursor-location)
"Return the word for spell-checking according to ispell syntax.
If optional argument FOLLOWING is non-nil or if `ispell-following-word'
is non-nil when called interactively, then the following word
-\(rather than preceeding\) is checked when the cursor is not over a word.
- Optional second argument contains otherchars that can be included in word
+\(rather than preceding\) is checked when the cursor is not over a word.
+Optional second argument contains otherchars that can be included in word
many times.
- Word syntax described by `ispell-dictionary-alist' (which see)."
+Word syntax described by `ispell-dictionary-alist' (which see)."
(let* ((ispell-casechars (ispell-get-casechars))
(ispell-not-casechars (ispell-get-not-casechars))
(ispell-otherchars (ispell-get-otherchars))
;;; a value or a list, whose value is the state of whether the
;;; dictionary needs to be saved.
-;;;###autoload
(defun ispell-pdict-save (&optional no-query force-save)
"Check to see if the personal dictionary has been modified.
If so, ask if it needs to be saved."
(setq ispell-pdict-modified-p (car ispell-pdict-modified-p)))
(if (or ispell-pdict-modified-p force-save)
(if (or no-query (y-or-n-p "Personal dictionary modified. Save? "))
- (process-send-string ispell-process "#\n")))
+ (progn
+ (process-send-string ispell-process "#\n")
+ (message "Personal dictionary saved."))))
;; unassert variable, even if not saved to avoid questioning.
(setq ispell-pdict-modified-p nil))
-(defun ispell-command-loop (miss guess word)
+(defun ispell-command-loop (miss guess word start end)
"Display possible corrections from list MISS.
GUESS lists possibly valid affix construction of WORD.
Returns nil to keep word.
- 0 to insert locally into buffer-local dictionary.
- string for new chosen word.
- list for new replacement word (will be rechecked).
- Optional second argument means replace misspelling in
- the rest of the region.
+Returns 0 to insert locally into buffer-local dictionary.
+Returns string for new chosen word.
+Returns list for new replacement word (will be rechecked).
+Highlights the word, which is assumed to run from START to END.
Global `ispell-pdict-modified-p' becomes a list where the only value
indicates whether the dictionary has been modified when option `a' or `i' is
used."
- (unwind-protect
- (save-window-excursion
- (let ((count ?0)
+ (let ((textbuf (current-buffer))
+ (count ?0)
(line 2)
(max-lines (- (window-height) 4)) ; assure 4 context lines.
(choices miss)
ispell-choices-win-default-height))
(command-characters '( ? ?i ?a ?A ?r ?R ?? ?x ?X ?q ?l ?u ?m ))
(skipped 0)
- char num result)
+ char num result textwin highlighted)
+
+ ;; setup the *Choices* buffer with valid data.
(save-excursion
- (if ispell-keep-choices-win
- (select-window (previous-window))
(set-buffer (get-buffer-create ispell-choices-buffer))
- (setq mode-line-format "-- %b --"))
- (if (equal (get-buffer ispell-choices-buffer) (current-buffer))
- (erase-buffer)
- (error "Bogus, dude! I should be in the *Choices* buffer, but I'm not!"))
- (if guess
- (progn
- (insert
- "Affix rules generate and capitalize this word as shown below:\n\t")
- (while guess
- (if (> (+ 4 (current-column) (length (car guess)))
- (window-width))
- (progn
- (insert "\n\t")
- (setq line (1+ line))))
- (insert (car guess) " ")
- (setq guess (cdr guess)))
- (insert "\nUse option `i' if this is a correct composition from the derivative root\n")
- (setq line (+ line (if choices 3 2)))))
- (while (and choices
- (< (if (> (+ 7 (current-column) (length (car choices))
- (if (> count ?~) 3 0))
- (window-width))
- (progn
- (insert "\n")
- (setq line (1+ line)))
- line)
- max-lines))
- ;; not so good if there are over 20 or 30 options, but then, if
- ;; there are that many you don't want to have to scan them all anyway...
- (while (memq count command-characters) ; skip command characters.
- (setq count (1+ count)
- skipped (1+ skipped)))
- (insert "(" count ") " (car choices) " ")
- (setq choices (cdr choices)
- count (1+ count)))
- (setq count (- count ?0 skipped)))
-
- (if ispell-keep-choices-win
- (if (> line ispell-keep-choices-win)
- (progn
- (switch-to-buffer ispell-choices-buffer)
- (select-window (next-window))
- (save-excursion
- (let ((cur-point (point)))
- (move-to-window-line (- line ispell-keep-choices-win))
- (if (<= (point) cur-point)
- (set-window-start (selected-window) (point)))))
- (select-window (previous-window))
- (enlarge-window (- line ispell-keep-choices-win))
- (goto-char (point-min))))
- (ispell-overlay-window (max line ispell-choices-win-default-height)))
- (switch-to-buffer ispell-choices-buffer)
- (goto-char (point-min))
- (select-window (next-window))
- (while
- (eq
- t
- (setq
- result
+ (setq mode-line-format (concat "-- %b -- word: " word))
+ (erase-buffer)
+ (if guess
(progn
- (undo-boundary)
- (message "C-h or ? for more options; SPC to leave unchanged, Character to replace word")
- (let ((inhibit-quit t))
- (setq char (read-char)
- skipped 0)
- ;; Implement quit by using the X command to get out.
- (if (eq char (nth 3 (current-input-mode)))
- (setq char ?X
- quit-flag nil)))
- ;; Adjust num to array offset skipping command characters.
- (let ((com-chars command-characters))
- (while com-chars
- (if (and (> (car com-chars) ?0) (< (car com-chars) char))
- (setq skipped (1+ skipped)))
- (setq com-chars (cdr com-chars)))
- (setq num (- char ?0 skipped)))
-
- (cond
- ((= char ? ) nil) ; accept word this time only
- ((= char ?i) ; accept and insert word into pers dict
- (process-send-string ispell-process (concat "*" word "\n"))
- (setq ispell-pdict-modified-p '(t)) ; dictionary was modified!
- nil)
- ((or (= char ?a) (= char ?A)) ; accept word, don't insert in dict
- (process-send-string ispell-process (concat "@" word "\n"))
- (if (null ispell-pdict-modified-p)
- (setq ispell-pdict-modified-p
- (list ispell-pdict-modified-p)))
- (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
- ((or (= char ?r) (= char ?R)) ; type in replacement
- (if (or (= char ?R) ispell-query-replace-choices)
- (list (read-string "Query-replacement for: " word) t)
- (cons (read-string "Replacement for: " word) nil)))
- ((or (= char ??) (= char help-char) (= char ?\C-h))
- (ispell-help)
- t)
- ;; Quit and move point back.
- ((= char ?x)
- (ispell-pdict-save ispell-silently-savep)
- (message "Exited spell-checking")
- (setq ispell-quit t)
- nil)
- ;; Quit and preserve point.
- ((= char ?X)
- (ispell-pdict-save ispell-silently-savep)
- (message
- (substitute-command-keys
- "Spell-checking suspended; use C-u \\[ispell-word] to resume"))
- (setq ispell-quit (max (point-min) (- (point) (length word))))
- nil)
- ((= char ?q)
- (if (y-or-n-p "Really quit ignoring changes? ")
+ (insert "Affix rules generate and capitalize "
+ "this word as shown below:\n\t")
+ (while guess
+ (if (> (+ 4 (current-column) (length (car guess)))
+ (window-width))
(progn
- (ispell-kill-ispell t) ; terminate process.
- (setq ispell-quit t
- ispell-pdict-modified-p nil))
- t)) ; continue if they don't quit.
- ((= char ?l)
- (let ((new-word (read-string "Lookup string (`*' is wildcard): "
- word))
- (new-line 2))
- (if new-word
- (progn
- (save-excursion
- (set-buffer (get-buffer-create ispell-choices-buffer))
- (erase-buffer)
- (setq count ?0
- skipped 0
- mode-line-format "-- %b --"
- miss (lookup-words new-word)
- choices miss)
- (while (and choices ; adjust choices window.
- (< (if (> (+ 7 (current-column)
- (length (car choices))
- (if (> count ?~) 3 0))
- (window-width))
- (progn
- (insert "\n")
- (setq new-line (1+ new-line)))
- new-line)
- max-lines))
- (while (memq count command-characters)
- (setq count (1+ count)
- skipped (1+ skipped)))
- (insert "(" count ") " (car choices) " ")
- (setq choices (cdr choices)
- count (1+ count)))
- (setq count (- count ?0 skipped)))
- (select-window (previous-window))
- (if (/= new-line line)
+ (insert "\n\t")
+ (setq line (1+ line))))
+ (insert (car guess) " ")
+ (setq guess (cdr guess)))
+ (insert "\nUse option `i' if this is a correct composition"
+ " from the derivative root.\n")
+ (setq line (+ line (if choices 3 2)))))
+ (while (and choices
+ (< (if (> (+ 7 (current-column) (length (car choices))
+ (if (> count ?~) 3 0))
+ (window-width))
+ (progn
+ (insert "\n")
+ (setq line (1+ line)))
+ line)
+ max-lines))
+ ;; not so good if there are over 20 or 30 options, but then, if
+ ;; there are that many you don't want to scan them all anyway...
+ (while (memq count command-characters) ; skip command characters.
+ (setq count (1+ count)
+ skipped (1+ skipped)))
+ (insert "(" count ") " (car choices) " ")
+ (setq choices (cdr choices)
+ count (1+ count)))
+ (setq count (- count ?0 skipped)))
+
+ ;; Assure word is visible
+ (if (not (pos-visible-in-window-p end))
+ (sit-for 0))
+ ;; Display choices for misspelled word.
+ (let ((choices-window (get-buffer-window ispell-choices-buffer)))
+ (if choices-window
+ (if (= line (window-height choices-window))
+ (select-window choices-window)
+ ;; *Choices* window changed size. Adjust the choices window
+ ;; without scrolling the spelled window when possible
+ (let ((window-line (- line (window-height choices-window)))
+ (visible (progn (forward-line -1) (point))))
+ (if (< line ispell-choices-win-default-height)
+ (setq window-line (+ window-line
+ (- ispell-choices-win-default-height
+ line))))
+ (move-to-window-line 0)
+ (forward-line window-line)
+ (set-window-start (selected-window)
+ (if (> (point) visible) visible (point)))
+ (goto-char end)
+ (select-window (previous-window)) ; *Choices* window
+ (enlarge-window window-line)))
+ ;; Overlay *Choices* window when it isn't showing
+ (ispell-overlay-window (max line ispell-choices-win-default-height)))
+ (switch-to-buffer ispell-choices-buffer)
+ (goto-char (point-min)))
+
+ (select-window (setq textwin (next-window)))
+
+ ;; highlight word, protecting current buffer status
+ (unwind-protect
+ (progn
+ (if ispell-highlight-p
+ (ispell-highlight-spelling-error start end t))
+ ;; Loop until a valid choice is made.
+ (while
+ (eq
+ t
+ (setq
+ result
+ (progn
+ (undo-boundary)
+ (message (concat "C-h or ? for more options; SPC to leave "
+ "unchanged, Character to replace word"))
+ (let ((inhibit-quit t))
+ (setq char (if (fboundp 'read-char-exclusive)
+ (read-char-exclusive)
+ (read-char))
+ skipped 0)
+ (if (or quit-flag (= char ?\C-g)) ; C-g is like typing X
+ (setq char ?X
+ quit-flag nil)))
+ ;; Adjust num to array offset skipping command characters.
+ (let ((com-chars command-characters))
+ (while com-chars
+ (if (and (> (car com-chars) ?0) (< (car com-chars) char))
+ (setq skipped (1+ skipped)))
+ (setq com-chars (cdr com-chars)))
+ (setq num (- char ?0 skipped)))
+
+ (cond
+ ((= char ? ) nil) ; accept word this time only
+ ((= char ?i) ; accept and insert word into pers dict
+ (process-send-string ispell-process (concat "*" word "\n"))
+ (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
+ nil)
+ ((or (= char ?a) (= char ?A)) ; accept word without insert
+ (process-send-string ispell-process (concat "@" word "\n"))
+ (if (null ispell-pdict-modified-p)
+ (setq ispell-pdict-modified-p
+ (list ispell-pdict-modified-p)))
+ (if (= char ?A) 0)) ; return 0 for ispell-add buffer-local
+ ((or (= char ?r) (= char ?R)) ; type in replacement
+ (if (or (= char ?R) ispell-query-replace-choices)
+ (list (read-string "Query-replacement for: " word) t)
+ (cons (read-string "Replacement for: " word) nil)))
+ ((or (= char ??) (= char help-char) (= char ?\C-h))
+ (ispell-help)
+ t)
+ ;; Quit and move point back.
+ ((= char ?x)
+ (ispell-pdict-save ispell-silently-savep)
+ (message "Exited spell-checking")
+ (setq ispell-quit t)
+ nil)
+ ;; Quit and preserve point.
+ ((= char ?X)
+ (ispell-pdict-save ispell-silently-savep)
+ (message
+ (substitute-command-keys
+ (concat "Spell-checking suspended;"
+ " use C-u \\[ispell-word] to resume")))
+ (setq ispell-quit (max (point-min)
+ (- (point) (length word))))
+ nil)
+ ((= char ?q)
+ (if (y-or-n-p "Really kill Ispell process? ")
+ (progn
+ (ispell-kill-ispell t) ; terminate process.
+ (setq ispell-quit (or (not ispell-checking-message)
+ (point))
+ ispell-pdict-modified-p nil))
+ t)) ; continue if they don't quit.
+ ((= char ?l)
+ (let ((new-word (read-string
+ "Lookup string (`*' is wildcard): "
+ word))
+ (new-line 2))
+ (if new-word
(progn
- (if (> new-line line)
- (enlarge-window (- new-line line))
- (shrink-window (- line new-line)))
- (setq line new-line)))
- (select-window (next-window)))))
- t) ; reselect from new choices
- ((= char ?u)
- (process-send-string ispell-process
- (concat "*" (downcase word) "\n"))
- (setq ispell-pdict-modified-p '(t)) ; dictionary was modified!
- nil)
- ((= char ?m) ; type in what to insert
- (process-send-string
- ispell-process (concat "*" (read-string "Insert: " word) "\n"))
- (setq ispell-pdict-modified-p '(t))
- (cons word nil))
- ((and (>= num 0) (< num count))
- (if ispell-query-replace-choices ; Query replace when flag set.
- (list (nth num miss) 'query-replace)
- (nth num miss)))
- ((= char ?\C-l)
- (redraw-display) t)
- ((= char ?\C-r)
- (save-window-excursion (recursive-edit)) t)
- ((= char ?\C-z)
- (funcall (key-binding "\C-z"))
- t)
- (t (ding) t))))))
- result))
- (if (not ispell-keep-choices-win) (bury-buffer ispell-choices-buffer))))
+ (save-excursion
+ (set-buffer (get-buffer-create
+ ispell-choices-buffer))
+ (erase-buffer)
+ (setq count ?0
+ skipped 0
+ mode-line-format (concat
+ "-- %b -- word: "
+ new-word)
+ miss (lookup-words new-word)
+ choices miss)
+ (while (and choices ; adjust choices window.
+ (< (if (> (+ 7 (current-column)
+ (length (car choices))
+ (if (> count ?~) 3 0))
+ (window-width))
+ (progn
+ (insert "\n")
+ (setq new-line
+ (1+ new-line)))
+ new-line)
+ max-lines))
+ (while (memq count command-characters)
+ (setq count (1+ count)
+ skipped (1+ skipped)))
+ (insert "(" count ") " (car choices) " ")
+ (setq choices (cdr choices)
+ count (1+ count)))
+ (setq count (- count ?0 skipped)))
+ (select-window (previous-window))
+ (if (and (/= new-line line)
+ (> (max line new-line)
+ ispell-choices-win-default-height))
+ (let* ((minh ispell-choices-win-default-height)
+ (gr-bl (if (< line minh) ; blanks
+ (- minh line)
+ 0))
+ (shr-bl (if (< new-line minh) ; blanks
+ (- minh new-line)
+ 0)))
+ (if (> new-line line)
+ (enlarge-window (- new-line line gr-bl))
+ (shrink-window (- line new-line shr-bl)))
+ (setq line new-line)))
+ (select-window (next-window)))))
+ t) ; reselect from new choices
+ ((= char ?u)
+ (process-send-string ispell-process
+ (concat "*" (downcase word) "\n"))
+ (setq ispell-pdict-modified-p '(t)) ; dictionary modified!
+ nil)
+ ((= char ?m) ; type in what to insert
+ (process-send-string
+ ispell-process (concat "*" (read-string "Insert: " word)
+ "\n"))
+ (setq ispell-pdict-modified-p '(t))
+ (cons word nil))
+ ((and (>= num 0) (< num count))
+ (if ispell-query-replace-choices ; Query replace flag
+ (list (nth num miss) 'query-replace)
+ (nth num miss)))
+ ((= char ?\C-l)
+ (redraw-display) t)
+ ((= char ?\C-r)
+ (save-window-excursion (recursive-edit)) t)
+ ((= char ?\C-z)
+ (funcall (key-binding "\C-z"))
+ t)
+ (t (ding) t))))))
+ result)
+ ;; protected
+ (if ispell-highlight-p ; unhighlight
+ (save-window-excursion
+ (select-window textwin)
+ (ispell-highlight-spelling-error start end))))))
;;;###autoload
Selections are:
DIGIT: Replace the word with a digit offered in the *Choices* buffer.
-' ': Accept word this time.
-'i': Accept word and insert into private dictionary.
-'a': Accept word for this session.
-'A': Accept word and place in `buffer-local dictionary'.
-'r': Replace word with typed-in value. Rechecked.
-'R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
-'?': Show these commands.
-'x': Exit spelling buffer. Move cursor to original point.
-'X': Exit spelling buffer. Leaves cursor at the current point, and permits
+SPC: Accept word this time.
+`i': Accept word and insert into private dictionary.
+`a': Accept word for this session.
+`A': Accept word and place in `buffer-local dictionary'.
+`r': Replace word with typed-in value. Rechecked.
+`R': Replace word with typed-in value. Query-replaced in buffer. Rechecked.
+`?': Show these commands.
+`x': Exit spelling buffer. Move cursor to original point.
+`X': Exit spelling buffer. Leaves cursor at the current point, and permits
the aborted check to be completed later.
-'q': Quit spelling session (Kills ispell process).
-'l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
-'u': Like 'i', but the word is lower-cased first.
-'m': Like 'i', but allows one to include dictionary completion information.
-'C-l': redraws screen
-'C-r': recursive edit
-'C-z': suspend emacs or iconify frame"
-
- (let ((help-1 "[r/R]eplace word; [a/A]ccept for this session; [i]nsert into private dictionary")
- (help-2 "[l]ook a word up in alternate dictionary; e[x/X]it; [q]uit session")
- (help-3 "[u]ncapitalized insert into dictionary. Type 'C-h d ispell-help' for more help"))
+`q': Quit spelling session (Kills ispell process).
+`l': Look up typed-in replacement in alternate dictionary. Wildcards okay.
+`u': Like `i', but the word is lower-cased first.
+`m': Like `i', but allows one to include dictionary completion information.
+`C-l': redraws screen
+`C-r': recursive edit
+`C-z': suspend emacs or iconify frame"
+
+ (let ((help-1 (concat "[r/R]eplace word; [a/A]ccept for this session; "
+ "[i]nsert into private dictionary"))
+ (help-2 (concat "[l]ook a word up in alternate dictionary; "
+ "e[x/X]it; [q]uit session"))
+ (help-3 (concat "[u]ncapitalized insert into dictionary. "
+ "Type 'C-h d ispell-help' for more help")))
(save-window-excursion
(if ispell-help-in-bufferp
(progn
(sit-for 5)
(kill-buffer "*Ispell Help*"))
(select-window (minibuffer-window))
- (enlarge-window 2)
+ ;;(enlarge-window 2)
(erase-buffer)
(cond ((string-match "Lucid" emacs-version)
(message help-3)
(enlarge-window 1)
(message help-2)
(enlarge-window 1)
- (message help-1))
+ (message help-1)
+ (goto-char (point-min)))
(t
- (if (string-match "^19\\." emacs-version)
+ (if (string-lessp "19" emacs-version)
(message nil))
(enlarge-window 2)
(insert (concat help-1 "\n" help-2 "\n" help-3))))
(defun lookup-words (word &optional lookup-dict)
"Look up word in word-list dictionary.
-A `*' is serves as a wild card. If no wild cards, `look' is used if it exists.
- Otherwise the variable `ispell-grep-command' contains the command used to
- search for the words (usually egrep).
+A `*' serves as a wild card. If no wild cards, `look' is used if it exists.
+Otherwise the variable `ispell-grep-command' contains the command used to
+search for the words (usually egrep).
+
Optional second argument contains the dictionary to use; the default is
- `ispell-alternate-dictionary'."
+`ispell-alternate-dictionary'."
;; We don't use the filter for this function, rather the result is written
;; into a buffer. Hence there is no need to save the filter values.
(if (null lookup-dict)
;;; This function destroys the mark location if it is in the word being
;;; highlighted.
-(defun highlight-spelling-error-generic (start end &optional highlight)
+(defun ispell-highlight-spelling-error-generic (start end &optional highlight)
"Highlight the word from START to END with a kludge using `inverse-video'.
When the optional third arg HIGHLIGHT is set, the word is highlighted;
otherwise it is displayed normally."
(buffer-read-only nil) ; Allow highlighting read-only buffers.
(text (buffer-substring start end)) ; Save highlight region
(inhibit-quit t) ; inhibit interrupt processing here.
- (buffer-undo-list nil)) ; don't clutter the undo list.
+ (buffer-undo-list t)) ; don't clutter the undo list.
(delete-region start end)
(insert-char ? (- end start)) ; mimimize amount of redisplay
(sit-for 0) ; update display
(set-buffer-modified-p modified))) ; don't modify if flag not set.
-(defun highlight-spelling-error-lucid (start end &optional highlight)
+(defun ispell-highlight-spelling-error-lucid (start end &optional highlight)
"Highlight the word from START to END using `isearch-highlight'.
-When the optional third arg HIGHLIGHT is set, the word is highlighted
+When the optional third arg HIGHLIGHT is set, the word is highlighted,
otherwise it is displayed normally."
(if highlight
(isearch-highlight start end)
)
-(defun highlight-spelling-error-overlay (start end &optional highlight)
+(defun ispell-highlight-spelling-error-overlay (start end &optional highlight)
"Highlight the word from START to END using overlays.
When the optional third arg HIGHLIGHT is set, the word is highlighted
otherwise it is displayed normally.
- The variable ispell-highlight-face selects the face that will be used
-for highlighting."
+
+The variable `ispell-highlight-face' selects the face to use for highlighting."
(if highlight
(progn
(setq ispell-overlay (make-overlay start end))
(delete-overlay ispell-overlay)))
-;;; Choose a highlight function at load time.
-(fset 'highlight-spelling-error
- (symbol-function
- (cond
- ((string-match "Lucid" emacs-version) 'highlight-spelling-error-lucid)
- ((and (string-match "^19\\." emacs-version)
- (featurep 'faces)) 'highlight-spelling-error-overlay)
- (t 'highlight-spelling-error-generic))))
+(defun ispell-highlight-spelling-error (start end &optional highlight)
+ (cond
+ ((string-match "Lucid" emacs-version)
+ (ispell-highlight-spelling-error-lucid start end highlight))
+ ((and (string-lessp "19" emacs-version)
+ (featurep 'faces) window-system)
+ (ispell-highlight-spelling-error-overlay start end highlight))
+ (t (ispell-highlight-spelling-error-generic start end highlight))))
(defun ispell-overlay-window (height)
"Create a window covering the top HEIGHT lines of the current window.
Ensure that the line above point is still visible but otherwise avoid
-scrolling the current window. Leave the old window selected."
+scrolling the current window. Leave the new window selected."
(save-excursion
(let ((oldot (save-excursion (forward-line -1) (point)))
(top (save-excursion (move-to-window-line height) (point))))
;; hidden by new window, scroll it to just below new win
;; otherwise set top line of other win so it doesn't scroll.
(if (< oldot top) (setq top oldot))
+ ;; NB: Lemacs 19.9 bug: If a window of size N (N includes the mode
+ ;; line) is demanded, the last line is not visible.
+ ;; At least this happens on AIX 3.2, lemacs w/ Motif, font 9x15.
+ ;; So we increment the height for this case.
+ (if (string-match "19\.9.*Lucid" (emacs-version))
+ (setq height (1+ height)))
(split-window nil height)
(set-window-start (next-window) top))))
;;; Should we add a compound word match return value?
(defun ispell-parse-output (output)
- "Parse the OUTPUT string of `ispell' and return:
-1: T for an exact match.
+ "Parse the OUTPUT string from Ispell and return:
+1: t for an exact match.
2: A string containing the root word for a match via suffix removal.
3: A list of possible correct spellings of the format:
'(\"ORIGINAL-WORD\" OFFSET MISS-LIST GUESS-LIST)
;; option is the only way I can think of to do this that works with
;; all versions, since versions earlier than 3.0.09 didn't identify
;; themselves on startup.
- ;;
- ;; If the ispell.el file ever supports more than one version of the
- ;; external ispell program, then this should be reworked to accept more
- ;; than one version, but until that happens, doing so would be false
- ;; generality.
- ;;
(save-excursion
- (set-buffer (get-buffer-create " *ispell-tmp*"))
- (erase-buffer)
- (let ((status (call-process ispell-program-name nil t nil "-v"))
- (case-fold-search t))
+ (let ((case-fold-search t)
+ ;; avoid bugs when syntax of `.' changes in various default modes
+ (default-major-mode 'fundamental-mode)
+ status)
+ (set-buffer (get-buffer-create " *ispell-tmp*"))
+ (erase-buffer)
+ (setq status (call-process ispell-program-name nil t nil "-v"))
(goto-char (point-min))
- (cond ((not (memq status '(0 nil)))
- (error "%s exited with %s %s" ispell-program-name
- (if (stringp status) "signal" "code") status))
- ((not (re-search-forward
- (concat "\\b\\("
- (mapconcat 'regexp-quote
- ispell-required-versions
- "\\|")
- "\\)\\b")
- nil t))
- (error "version mismatch: ispell.el is for %s, %s is %s"
- (car ispell-required-versions)
- ispell-program-name
- (if (re-search-forward "version \\([0-9][0-9.]+\\)\\b"
- nil t)
- (buffer-substring (match-beginning 1) (match-end 1))
- "an unknown version"))))
+ (if (not (memq status '(0 nil)))
+ (error "%s exited with %s %s" ispell-program-name
+ (if (stringp status) "signal" "code") status))
+ (if (not (re-search-forward
+ (concat "\\b\\("
+ (regexp-quote (car ispell-required-version))
+ "\\)\\([0-9]*\\)\\b")
+ nil t))
+ (error
+ "%s version %s* is required: try renaming ispell4.el to ispell.el"
+ ispell-program-name (car ispell-required-version))
+ ;; check that it is the correct version.
+ (if (< (car (read-from-string (buffer-substring
+ (match-beginning 2) (match-end 2))))
+ (car (cdr ispell-required-version)))
+ (setq ispell-offset 0)))
(kill-buffer (current-buffer)))))
(list "-p"
(expand-file-name
ispell-personal-dictionary)))))
+ (setq args (append args ispell-extra-args))
args)))
ispell-filter nil
ispell-filter-continue nil
(set-process-filter ispell-process 'ispell-filter)
(accept-process-output ispell-process) ; Get version ID line
(cond ((null ispell-filter)
- (error "%s did not output version line"))
- ((and (null (cdr ispell-filter))
- (stringp (car ispell-filter))
- (string-match "^@(#) " (car ispell-filter)))
+ (error "%s did not output version line" ispell-program-name))
+ ((and
+ (stringp (car ispell-filter))
+ (if (string-match "warning: " (car ispell-filter))
+ (progn
+ (accept-process-output ispell-process 5) ; 1st was warn msg.
+ (stringp (car ispell-filter)))
+ (null (cdr ispell-filter)))
+ (string-match "^@(#) " (car ispell-filter)))
;; got the version line as expected (we already know it's the right
;; version, so don't bother checking again.)
nil)
(concat extended-char-mode "\n"))))
(process-kill-without-query ispell-process)))
-
;;;###autoload
(defun ispell-kill-ispell (&optional no-error)
- "Kill current ispell process (so that you may start a fresh one).
-With NO-ERROR, just return non-nil if there was no ispell running."
+ "Kill current Ispell process (so that you may start a fresh one).
+With NO-ERROR, just return non-nil if there was no Ispell running."
(interactive)
(if (not (and ispell-process
(eq (process-status ispell-process) 'run)))
nil))
+;;; ispell-change-dictionary is set in some people's hooks. Maybe this should
+;;; call ispell-init-process rather than wait for a spell checking command?
+
;;;###autoload
(defun ispell-change-dictionary (dict &optional arg)
- "Change ispell-dictionary (q.v.) and kill old ispell process.
+ "Change `ispell-dictionary' (q.v.) and kill old Ispell process.
A new one will be started as soon as necessary.
By just answering RET you can find out what the current dictionary is.
(message "Using %s dictionary"
(or ispell-local-dictionary ispell-dictionary "default")))
((and (equal dict ispell-dictionary)
- (equal dict ispell-local-dictionary))
+ (or (null ispell-local-dictionary)
+ (equal dict ispell-local-dictionary)))
;; Specified dictionary is the default already. No-op
- (message "No change, using %s dictionary" (or dict "default")))
+ (and (interactive-p)
+ (message "No change, using %s dictionary" (or dict "default"))))
(t ; reset dictionary!
(if (assoc dict ispell-dictionary-alist)
(progn
(interactive "r") ; Don't flag errors on read-only bufs.
(ispell-accept-buffer-local-defs) ; set up dictionary, local words, etc.
(unwind-protect
- (save-excursion
- (message "Spell checking %s..."
- (if (and (= reg-start (point-min)) (= reg-end (point-max)))
- (buffer-name) "region"))
- (sit-for 0)
- ;; must be top level now, not inside ispell-command-loop for keeping window.
- (save-window-excursion
- (if ispell-keep-choices-win
- (let ((window-min-height ispell-choices-win-default-height))
- ;; This keeps the default window size when choices window saved.
- (setq ispell-keep-choices-win ispell-choices-win-default-height)
- (ispell-overlay-window ispell-choices-win-default-height)
- (switch-to-buffer (get-buffer-create ispell-choices-buffer))
- (setq mode-line-format "-- %b --")
- (erase-buffer)
- (select-window (next-window))
- (sit-for 0)))
- (goto-char reg-start)
- (let ((transient-mark-mode nil))
- (while (and (not ispell-quit) (< (point) reg-end))
- (let ((start (point))
- (offset-change 0)
- (end (save-excursion (end-of-line) (min (point) reg-end)))
- (ispell-casechars (ispell-get-casechars))
- string)
- (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
- ((eolp) ; END OF LINE, just go to next line.
- (forward-char 1))
- ((and (null ispell-check-comments) ; SKIPING COMMENTS
- comment-start ; skip comments that start on the line.
- (search-forward comment-start end t)) ; a comment is on this line.
- (if (= (- (point) start) (length comment-start))
- ;; comment starts the line. We can skip the entire line or region
- (if (string= "" comment-end) ; skip to next line over comment
- (beginning-of-line 2)
- (search-forward comment-end reg-end 'limit)) ; jmp to comment end
- ;; Comment starts later on line. Check for spelling before comment.
- (let ((limit (- (point) (length comment-start))))
- (goto-char (1- limit))
- (if (looking-at "\\\\") ; "quoted" comment, don't skip
- ;; quoted comment. Skip over comment-start and continue.
- (if (= start (1- limit))
- (setq limit (+ limit (length comment-start)))
- (setq limit (1- limit))))
- (goto-char start)
- ;; Only check if there are "casechars" or math chars before comment
- (if (or (re-search-forward ispell-casechars limit t)
- (re-search-forward "[][()$]" limit t))
- (setq string (concat "^" (buffer-substring start limit) "\n")))
- (goto-char limit))))
- ((and ispell-skip-tib ; SKIP TIB REFERENCES!
- (re-search-forward ispell-tib-ref-beginning end t))
- (if (= (- (point) 2) start) ; tib ref is 2 chars.
- ;; Skip to end of tib ref, not necessarily on this line.
- ;; Return an error if tib ref not found
- (if (not (re-search-forward ispell-tib-ref-end reg-end t))
- (progn
- (ispell-pdict-save ispell-silently-savep)
- (ding)
- (message "Open tib reference--set `ispell-skip-tib' to nil to avoid this error")
- (setq ispell-quit (- (point) 2)))) ; leave dot at error loc.
- ;; tib ref starts later on line. Check spelling before tib.
- (let ((limit (- (point) 2)))
- (goto-char start)
- (if (or (re-search-forward ispell-casechars limit t)
- (re-search-forward "[][()$]" limit t))
- (setq string (concat "^" (buffer-substring start limit) "\n")))
- (goto-char limit))))
- ((looking-at "[-#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
- (forward-char 1))
- ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS...
- (re-search-forward "[][()$]" end t)) ; or MATH COMMANDS...
- (setq string (concat "^" (buffer-substring start end) "\n"))
- (goto-char end))
- (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
-
- (setq end (point)) ; "end" tracks end of region to check.
-
- (if string ; there is something to spell!
- (let (poss)
- ;; send string to spell process and get input.
- (process-send-string ispell-process string)
- (while (progn
- (accept-process-output ispell-process)
- ;; Last item of output contains a blank line.
- (not (string= "" (car ispell-filter)))))
- ;; parse all inputs from the stream one word at a time.
- ;; Place in FIFO order and remove the blank item.
- (setq ispell-filter (nreverse (cdr ispell-filter)))
- (while (and (not ispell-quit) ispell-filter)
- (setq poss (ispell-parse-output (car ispell-filter)))
- (if (listp poss) ; spelling error occurred.
- (let* ((word-start (+ start offset-change (car (cdr poss))))
- (word-end (+ word-start (length (car poss))))
- replace)
- (goto-char word-start)
- ;; The following lines adjust the horizontal scroll & point
- (horiz-scroll)
- (goto-char word-end)
- (horiz-scroll)
- (goto-char word-start)
- (horiz-scroll)
- (if (/= word-end (progn
- (search-forward (car poss) word-end t)
- (point)))
- ;; This usually occurs due to filter pipe problems
- (error "Ispell misalignment: word `%s' point %d; please retry"
- (car poss) word-start))
- (unwind-protect
- (progn
- (if ispell-highlight-p
- (highlight-spelling-error word-start word-end t))
- (sit-for 0) ; update screen display
- (setq replace (ispell-command-loop
- (car (cdr (cdr poss)))
- (car (cdr (cdr (cdr poss))))
- (car poss))))
- ;; protected
- (if ispell-highlight-p
- (highlight-spelling-error word-start word-end)))
- (cond
- ((and replace (listp replace))
- ;; REPLACEMENT WORD entered. Recheck line starting with
- ;; the replacement word.
- (setq ispell-filter nil
- string (buffer-substring word-start word-end))
- (let ((change (- (length (car replace)) ; adjust
- (length (car poss))))) ; regions
- (setq reg-end (+ reg-end change)
- offset-change (+ offset-change change)))
- (delete-region word-start word-end)
- (insert (car replace))
- ;; I only need to recheck typed-in replacements.
- (if (not (eq 'query-replace (car (cdr replace))))
- (backward-char (length (car replace))))
- (setq end (point)) ; reposition in region to recheck
- ;; when second arg exists, query-replace, saving regions
- (if (car (cdr replace))
- (unwind-protect
- (save-window-excursion ; save if help is called.
- (set-marker ispell-query-replace-marker reg-end)
- ;; Assume case-replace & case-fold-search correct?
- (query-replace string (car replace) t))
- ;; protected
- (setq reg-end (marker-position
- ispell-query-replace-marker))
- (set-marker ispell-query-replace-marker nil))))
- ((or (null replace) (equal 0 replace)) ; ACCEPT/INSERT
- (if (equal 0 replace) ; BUFFER-LOCAL DICTIONARY ADD
- (setq reg-end (ispell-add-per-file-word-list
- (car poss) reg-end)))
- ;; This prevents us from pointing out the word that was
- ;; just accepted (via 'i' or 'a') if it follows on the
- ;; same line. (The drawback of processing entire lines.)
- ;; Redo check following the accepted word.
- (if (and ispell-pdict-modified-p
- (listp ispell-pdict-modified-p))
- ;; We have accepted or inserted a word. Re-check line
- (setq ispell-pdict-modified-p ; fix update flag
- (car ispell-pdict-modified-p)
- ispell-filter nil ; don't continue check.
- end word-start))) ; reposition continue loc
- (replace ; STRING REPLACEMENT for this word.
- (delete-region word-start word-end)
- (insert replace)
- (let ((change (- (length replace) (length (car poss)))))
- (setq reg-end (+ reg-end change)
- offset-change (+ offset-change change)
- end (+ end change)))))
- (if (not ispell-quit)
- (message "Continuing spelling check..."))
- (sit-for 0)))
- (setq ispell-filter (cdr ispell-filter))))) ; finished with line
- (goto-char end)))))
- (not ispell-quit))
- ;; protected
- (if (get-buffer ispell-choices-buffer)
- (kill-buffer ispell-choices-buffer))
- (if ispell-quit
- (progn
- ;; preserve or clear the region for ispell-continue.
- (if (not (numberp ispell-quit))
- (set-marker ispell-region-end nil)
- ;; Enable ispell-continue.
- (set-marker ispell-region-end reg-end)
- (goto-char ispell-quit))
- ;; Check for aborting
- (if (and ispell-checking-message (numberp ispell-quit))
- (progn
- (setq ispell-quit nil)
- (error "Message send aborted.")))
- (setq ispell-quit nil))
- (set-marker ispell-region-end nil)
- ;; Only save if successful exit.
- (ispell-pdict-save ispell-silently-savep)
- (message "Spell-checking done"))))
+ (save-excursion
+ (message "Spell checking %s using %s dictionary..."
+ (if (and (= reg-start (point-min)) (= reg-end (point-max)))
+ (buffer-name) "region")
+ (or ispell-dictionary "default"))
+ ;; Returns cursor to original location.
+ (save-window-excursion
+ (goto-char reg-start)
+ (let ((transient-mark-mode nil)
+ ref-type)
+ (while (and (not ispell-quit) (< (point) reg-end))
+ (let ((start (point))
+ (offset-change 0)
+ (end (save-excursion (end-of-line) (min (point) reg-end)))
+ (ispell-casechars (ispell-get-casechars))
+ string)
+ (cond ; LOOK AT THIS LINE AND SKIP OR PROCESS
+ ((eolp) ; END OF LINE, just go to next line.
+ (forward-char 1))
+ ((and (null ispell-check-comments) ; SKIPPING COMMENTS
+ comment-start ; skip comments that start on the line.
+ (search-forward comment-start end t)) ; or found here.
+ (if (= (- (point) start) (length comment-start))
+ ;; comment starts the line. Skip entire line or region
+ (if (string= "" comment-end) ; skip to next line
+ (beginning-of-line 2) ; or jump to comment end.
+ (search-forward comment-end reg-end 'limit))
+ ;; Comment later in line. Check spelling before comment.
+ (let ((limit (- (point) (length comment-start))))
+ (goto-char (1- limit))
+ (if (looking-at "\\\\") ; "quoted" comment, don't skip
+ ;; quoted comment. Skip over comment-start
+ (if (= start (1- limit))
+ (setq limit (+ limit (length comment-start)))
+ (setq limit (1- limit))))
+ (goto-char start)
+ ;; Only check when "casechars" or math before comment
+ (if (or (re-search-forward ispell-casechars limit t)
+ (re-search-forward "[][()$]" limit t))
+ (setq string
+ (concat "^" (buffer-substring start limit)
+ "\n")
+ offset-change (- offset-change ispell-offset)))
+ (goto-char limit))))
+ ((looking-at "[---#@*+!%~^]") ; SKIP SPECIAL ISPELL CHARACTERS
+ (forward-char 1))
+ ((or (and ispell-skip-tib ; SKIP TIB REFERENCES OR SGML MARKUP
+ (re-search-forward ispell-tib-ref-beginning end t)
+ (setq ref-type 'tib))
+ (and ispell-skip-sgml
+ (search-forward "[<&]" end t)
+ (setq ref-type 'sgml)))
+ (if (or (and (eq 'tib ref-type) ; tib tag is 2 chars.
+ (= (- (point) 2) start))
+ (and (eq 'sgml ref-type) ; sgml skips 1 char.
+ (= (- (point) 1) start)))
+ ;; Skip to end of reference, not necessarily on this line
+ ;; Return an error if tib/sgml reference not found
+ (if (or
+ (and
+ (eq 'tib ref-type)
+ (not
+ (re-search-forward ispell-tib-ref-end reg-end t)))
+ (and (eq 'sgml ref-type)
+ (not (search-forward "[>;]" reg-end t))))
+ (progn
+ (ispell-pdict-save ispell-silently-savep)
+ (ding)
+ (message
+ (concat
+ "Open tib or SGML command. Fix buffer or set "
+ (if (eq 'tib ref-type)
+ "ispell-skip-tib"
+ "ispell-skip-sgml")
+ " to nil"))
+ ;; keep cursor at error location
+ (setq ispell-quit (- (point) 2))))
+ ;; Check spelling between reference and start of the line.
+ (let ((limit (- (point) (if (eq 'tib ref-type) 2 1))))
+ (goto-char start)
+ (if (or (re-search-forward ispell-casechars limit t)
+ (re-search-forward "[][()$]" limit t))
+ (setq string
+ (concat "^" (buffer-substring start limit)
+ "\n")
+ offset-change (- offset-change ispell-offset)))
+ (goto-char limit))))
+ ((or (re-search-forward ispell-casechars end t) ; TEXT EXISTS
+ (re-search-forward "[][()$]" end t)) ; or MATH COMMANDS
+ (setq string (concat "^" (buffer-substring start end) "\n")
+ offset-change (- offset-change ispell-offset))
+ (goto-char end))
+ (t (beginning-of-line 2))) ; EMPTY LINE, skip it.
+
+ (setq end (point)) ; "end" tracks end of region to check.
+
+ (if string ; there is something to spell!
+ (let (poss)
+ ;; send string to spell process and get input.
+ (process-send-string ispell-process string)
+ (while (progn
+ (accept-process-output ispell-process)
+ ;; Last item of output contains a blank line.
+ (not (string= "" (car ispell-filter)))))
+ ;; parse all inputs from the stream one word at a time.
+ ;; Place in FIFO order and remove the blank item.
+ (setq ispell-filter (nreverse (cdr ispell-filter)))
+ (while (and (not ispell-quit) ispell-filter)
+ (setq poss (ispell-parse-output (car ispell-filter)))
+ (if (listp poss) ; spelling error occurred.
+ (let* ((word-start (+ start offset-change
+ (car (cdr poss))))
+ (word-end (+ word-start
+ (length (car poss))))
+ replace)
+ (goto-char word-start)
+ ;; Adjust the horizontal scroll & point
+ (ispell-horiz-scroll)
+ (goto-char word-end)
+ (ispell-horiz-scroll)
+ (goto-char word-start)
+ (ispell-horiz-scroll)
+ (if (/= word-end
+ (progn
+ (search-forward (car poss) word-end t)
+ (point)))
+ ;; This occurs due to filter pipe problems
+ (error
+ (concat "Ispell misalignment: word "
+ "`%s' point %d; please retry")
+ (car poss) word-start))
+ (if (not (pos-visible-in-window-p))
+ (sit-for 0))
+ (if ispell-keep-choices-win
+ (setq replace
+ (ispell-command-loop
+ (car (cdr (cdr poss)))
+ (car (cdr (cdr (cdr poss))))
+ (car poss) word-start word-end))
+ (save-window-excursion
+ (setq replace
+ (ispell-command-loop
+ (car (cdr (cdr poss)))
+ (car (cdr (cdr (cdr poss))))
+ (car poss) word-start word-end))))
+ (cond
+ ((and replace (listp replace))
+ ;; REPLACEMENT WORD entered. Recheck line
+ ;; starting with the replacement word.
+ (setq ispell-filter nil
+ string (buffer-substring word-start
+ word-end))
+ (let ((change (- (length (car replace))
+ (length (car poss)))))
+ ;; adjust regions
+ (setq reg-end (+ reg-end change)
+ offset-change (+ offset-change
+ change)))
+ (if (not (equal (car replace) (car poss)))
+ (progn
+ (delete-region word-start word-end)
+ (insert (car replace))))
+ ;; I only need to recheck typed-in replacements
+ (if (not (eq 'query-replace
+ (car (cdr replace))))
+ (backward-char (length (car replace))))
+ (setq end (point)) ; reposition for recheck
+ ;; when second arg exists, query-replace, saving regions
+ (if (car (cdr replace))
+ (unwind-protect
+ (save-window-excursion
+ (set-marker
+ ispell-query-replace-marker reg-end)
+ ;; Assume case-replace &
+ ;; case-fold-search correct?
+ (query-replace string (car replace)
+ t))
+ (setq reg-end
+ (marker-position
+ ispell-query-replace-marker))
+ (set-marker ispell-query-replace-marker
+ nil))))
+ ((or (null replace)
+ (equal 0 replace)) ; ACCEPT/INSERT
+ (if (equal 0 replace) ; BUFFER-LOCAL DICT ADD
+ (setq reg-end
+ (ispell-add-per-file-word-list
+ (car poss) reg-end)))
+ ;; This avoids pointing out the word that was
+ ;; just accepted (via 'i' or 'a') if it follows
+ ;; on the same line.
+ ;; Redo check following the accepted word.
+ (if (and ispell-pdict-modified-p
+ (listp ispell-pdict-modified-p))
+ ;; Word accepted. Recheck line.
+ (setq ispell-pdict-modified-p ; update flag
+ (car ispell-pdict-modified-p)
+ ispell-filter nil ; discontinue check
+ end word-start))) ; reposition loc.
+ (replace ; STRING REPLACEMENT for this word.
+ (delete-region word-start word-end)
+ (insert replace)
+ (let ((change (- (length replace)
+ (length (car poss)))))
+ (setq reg-end (+ reg-end change)
+ offset-change (+ offset-change change)
+ end (+ end change)))))
+ (if (not ispell-quit)
+ (message
+ (concat "Continuing spelling check using "
+ (or ispell-dictionary "default")
+ " dictionary...")))
+ (sit-for 0)))
+ ;; finished with line!
+ (setq ispell-filter (cdr ispell-filter)))))
+ (goto-char end)))))
+ (not ispell-quit))
+ ;; protected
+ (if (get-buffer ispell-choices-buffer)
+ (kill-buffer ispell-choices-buffer))
+ (if ispell-quit
+ (progn
+ ;; preserve or clear the region for ispell-continue.
+ (if (not (numberp ispell-quit))
+ (set-marker ispell-region-end nil)
+ ;; Enable ispell-continue.
+ (set-marker ispell-region-end reg-end)
+ (goto-char ispell-quit))
+ ;; Check for aborting
+ (if (and ispell-checking-message (numberp ispell-quit))
+ (progn
+ (setq ispell-quit nil)
+ (error "Message send aborted.")))
+ (setq ispell-quit nil))
+ (set-marker ispell-region-end nil)
+ ;; Only save if successful exit.
+ (ispell-pdict-save ispell-silently-savep)
+ (message "Spell-checking done"))))
;;;###autoload
-(defun ispell-buffer ()
+(defun ispell-buffer ()
"Check the current buffer for spelling errors interactively."
(interactive)
(ispell-region (point-min) (point-max)))
+
;;;###autoload
(defun ispell-continue ()
(interactive)
;;; Horizontal scrolling
-(defun horiz-scroll ()
- "This function checks if the point is within the horizontal
-visibility of its window area."
+(defun ispell-horiz-scroll ()
+ "Places point within the horizontal visibility of its window area."
(if truncate-lines ; display truncating lines?
;; See if display needs to be scrolled.
(let ((column (- (current-column) (max (window-hscroll) 1))))
Standard ispell choices are then available."
(interactive "P")
(let ((cursor-location (point))
- ispell-keep-choices-win
+ case-fold-search
(word (ispell-get-word nil "\\*")) ; force "previous-word" processing.
start end possibilities replacement)
(setq start (car (cdr word))
((null possibilities)
(message "No match for \"%s\"" word))
(t ; There is a modification...
- (unwind-protect
- (progn
- (if ispell-highlight-p
- (highlight-spelling-error start end t)) ; highlight word
- (setq replacement (ispell-command-loop possibilities nil word)))
- ;; protected
- (if ispell-highlight-p
- (highlight-spelling-error start end))) ; un-highlight
+ (cond ; Try and respect case of word.
+ ((string-match "^[^A-Z]+$" word)
+ (setq possibilities (mapcar 'downcase possibilities)))
+ ((string-match "^[^a-z]+$" word)
+ (setq possibilities (mapcar 'upcase possibilities)))
+ ((string-match "^[A-Z]" word)
+ (setq possibilities (mapcar 'capitalize possibilities))))
+ (save-window-excursion
+ (setq replacement
+ (ispell-command-loop possibilities nil word start end)))
(cond
((equal 0 replacement) ; BUFFER-LOCAL ADDITION
(ispell-add-per-file-word-list word))
;;;###autoload
(defun ispell-complete-word-interior-frag ()
- "Runs `ispell-complete-word' assuming that the word is a character sequence
-inside of a word."
+ "Completes word matching character sequence inside a word."
(interactive)
(ispell-complete-word t))
+;;; **********************************************************************
+;;; Ispell Minor Mode
+;;; **********************************************************************
+
+(defvar ispell-minor-mode nil
+ "Non-nil if Ispell minor mode is enabled.")
+;; Variable indicating that ispell minor mode is active.
+(make-variable-buffer-local 'ispell-minor-mode)
+
+(or (assq 'ispell-minor-mode minor-mode-alist)
+ (setq minor-mode-alist
+ (cons '(ispell-minor-mode " Spell") minor-mode-alist)))
+
+(defvar ispell-minor-keymap
+ (let ((map (make-sparse-keymap)))
+ (define-key map " " 'ispell-minor-check)
+ (define-key map "\r" 'ispell-minor-check)
+ map)
+ "Keymap used for Ispell minor mode.")
+
+(or (not (boundp 'minor-mode-map-alist))
+ (assoc 'ispell-minor-mode minor-mode-map-alist)
+ (setq minor-mode-map-alist
+ (cons (cons 'ispell-minor-mode ispell-minor-keymap)
+ minor-mode-map-alist)))
+
+;;;###autoload
+(defun ispell-minor-mode (&optional arg)
+ "Toggle Ispell minor mode.
+With prefix arg, turn Ispell minor mode on iff arg is positive.
+
+In Ispell minor mode, pressing SPC or RET
+warns you if the previous word is incorrectly spelled."
+ (interactive "P")
+ (setq ispell-minor-mode
+ (not (or (and (null arg) ispell-minor-mode)
+ (<= (prefix-numeric-value arg) 0))))
+ (force-mode-line-update))
+
+(defun ispell-minor-check ()
+ ;; Check previous word then continue with the normal binding of this key.
+ (interactive "*")
+ (let ((ispell-minor-mode nil)
+ (ispell-check-only t))
+ (save-restriction
+ (narrow-to-region (point-min) (point))
+ (ispell-word nil t))
+ (call-interactively (key-binding (this-command-keys)))))
+
+
;;; **********************************************************************
;;; Ispell Message
;;; **********************************************************************
(mapconcat (function identity)
'(
;; Matches postscript files.
- "^%!PS-Adobe-2.0"
+ "^%!PS-Adobe-[123].0"
;; Matches uuencoded text
"^begin [0-9][0-9][0-9] .*\nM.*\nM.*\nM"
;; Matches shell files (esp. auto-decoding)
- "^#! /bin/sh"
- ;; Matches difference listing
- "diff -c .*\n\\*\\*\\* .*\n--- "
+ "^#! /bin/[ck]?sh"
+ ;; Matches context difference listing
+ "\\(diff -c .*\\)?\n\\*\\*\\* .*\n--- .*\n\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*"
+ ;; Matches reporter.el bug report
+ "^current state:\n==============\n"
;; Matches "----------------- cut here"
- "^[-=]+\\s cut here")
+ ;; and "------- Start of forwarded message"
+ "^[-=_]+\\s ?\\(cut here\\|Start of forwarded message\\)")
"\\|")
"*End of text which will be checked in ispell-message.
-If it is a string, limit at first occurence of that regular expression.
+If it is a string, limit at first occurrence of that regular expression.
Otherwise, it must be a function which is called to get the limit.")
+
+(defvar ispell-message-start-skip
+ (mapconcat (function identity)
+ '(
+ ;; Matches forwarded messages
+ "^---* Forwarded Message"
+ ;; Matches PGP Public Key block
+ "^---*BEGIN PGP [A-Z ]*--*"
+ )
+ "\\|")
+ "Spelling is skipped inside these start/end groups by ispell-message.
+Assumed that blocks are not mutually inclusive.")
+
+
+(defvar ispell-message-end-skip
+ (mapconcat (function identity)
+ '(
+ ;; Matches forwarded messages
+ "^--- End of Forwarded Message"
+ ;; Matches PGP Public Key block
+ "^---*END PGP [A-Z ]*--*"
+ )
+ "\\|")
+ "Spelling is skipped inside these start/end groups by ispell-message.
+Assumed that blocks are not mutually inclusive.")
+
+
;;;###autoload
(defun ispell-message ()
"Check the spelling of a mail message or news post.
Don't check included messages.
To abort spell checking of a message REGION and send the message anyway,
-use the 'x' or 'q' command. (Any subsequent regions will be checked.)
-The 'X' command aborts the message send so that you can edit the buffer.
+use the `x' or `q' command. (Any subsequent regions will be checked.)
+The `X' command aborts the message send so that you can edit the buffer.
To spell-check whenever a message is sent, include the appropriate lines
in your .emacs file:
(add-hook 'mail-send-hook 'ispell-message)
(add-hook 'mh-before-send-letter-hook 'ispell-message)
-Or you can bind the function C-c i in gnus or mail by setting
-news-reply-mode-hook or mail-mode-hook to the following lambda expression:
+You can bind this to the key C-c i in GNUS or mail by adding to
+`news-reply-mode-hook' or `mail-mode-hook' the following lambda expression:
(function (lambda () (local-set-key \"\\C-ci\" 'ispell-message)))"
(interactive)
(save-excursion
- (beginning-of-buffer)
- (let* ((internal-messagep
- (search-forward mail-header-separator nil t))
+ (goto-char (point-min))
+ (let* ((internal-messagep (save-excursion
+ (re-search-forward
+ (concat "^"
+ (regexp-quote mail-header-separator)
+ "$")
+ nil t)))
(limit (copy-marker
- (cond
- ((not ispell-message-text-end) (point-max))
- ((char-or-string-p ispell-message-text-end)
- (if (re-search-forward ispell-message-text-end nil t)
- (match-beginning 0)
- (point-max)))
- (t (min (point-max) (funcall ispell-message-text-end))))))
+ (cond
+ ((not ispell-message-text-end) (point-max))
+ ((char-or-string-p ispell-message-text-end)
+ (if (re-search-forward ispell-message-text-end nil t)
+ (match-beginning 0)
+ (point-max)))
+ (t (min (point-max) (funcall ispell-message-text-end))))))
(cite-regexp ;Prefix of inserted text
(cond
((featurep 'supercite) ; sc 3.0
((featurep 'sc) ; sc 2.3
(concat "\\(" sc-cite-regexp "\\)" "\\|"
(ispell-non-empty-string sc-reference-tag-string)))
- ((equal major-mode 'news-reply-mode) ;Gnus
+ ((equal major-mode 'news-reply-mode) ;GNUS
(concat "In article <" "\\|"
(if mail-yank-prefix
(ispell-non-empty-string mail-yank-prefix)
"^ \\|^\t")))
((equal major-mode 'mh-letter-mode) ; mh mail message
(ispell-non-empty-string mh-ins-buf-prefix))
- ((not internal-messagep) ; Assume nn sent us this message.
+ ((not internal-messagep) ; Assume n sent us this message.
(concat "In [a-zA-Z.]+ you write:" "\\|"
"In <[^,;&+=]+> [^,;&+=]+ writes:" "\\|"
" *> *"))
(mail-yank-prefix ; vanilla mail message.
(ispell-non-empty-string mail-yank-prefix))
(t "^ \\|^\t")))
- (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp))
- (cite-regexp-end (concat "^\\(" cite-regexp "\\)"))
- (old-case-fold-search case-fold-search)
- (case-fold-search t)
- (ispell-checking-message t))
- (save-excursion
- (beginning-of-buffer)
+ (cite-regexp-start (concat "^[ \t]*$\\|" cite-regexp))
+ (cite-regexp-end (concat "^\\(" cite-regexp "\\)"))
+ (old-case-fold-search case-fold-search)
+ (case-fold-search t)
+ (ispell-checking-message t))
+ (goto-char (point-min))
;; Skip header fields except Subject: without Re:'s
;;(search-forward mail-header-separator nil t)
(while (if internal-messagep
(< (point) internal-messagep)
- (and (looking-at "[-a-zA-Z]+:\\|\t\\| ")
+ (and (looking-at "[a-zA-Z---]+:\\|\t\\| ")
(not (eobp))))
-
- ;; spell check Subject: field without Re:'s.
- (if (looking-at "Subject: *")
+ (if (looking-at "Subject: *") ; Spell check new subject fields
(progn
(goto-char (match-end 0))
(if (and (not (looking-at ".*Re\\>"))
(forward-line 1))
(setq case-fold-search nil)
;; Skip mail header, particularly for non-english languages.
- (if (looking-at mail-header-separator)
+ (if (looking-at (concat (regexp-quote mail-header-separator) "$"))
(forward-line 1))
(while (< (point) limit)
;; Skip across text cited from other messages.
(while (and (looking-at cite-regexp-start)
- (< (point) limit))
- (forward-line 1))
+ (< (point) limit)
+ (zerop (forward-line 1))))
+
(if (< (point) limit)
- ;; Check the next batch of lines that *aren't* cited.
- (let ((end (save-excursion
- (if (re-search-forward cite-regexp-end limit 'end)
- (match-beginning 0)
- (marker-position limit)))))
- (ispell-region (point) end)
- (goto-char end)))))
- (set-marker limit nil))))
+ (let* ((start (point))
+ ;; Check the next batch of lines that *aren't* cited.
+ (end-c (and (re-search-forward cite-regexp-end limit 'end)
+ (match-beginning 0)))
+ ;; Skip a block of included text.
+ (end-fwd (and (goto-char start)
+ (re-search-forward ispell-message-start-skip
+ limit 'end)
+ (progn (beginning-of-line)
+ (point))))
+ (end (or (and end-c end-fwd (min end-c end-fwd))
+ end-c end-fwd
+ ;; defalut to limit of text.
+ (marker-position limit))))
+ (goto-char start)
+ (ispell-region start end)
+ (if (and end-fwd (= end end-fwd))
+ (progn
+ (goto-char end)
+ (re-search-forward ispell-message-end-skip limit 'end))
+ (goto-char end)))))
+ (set-marker limit nil))))
+
(defun ispell-non-empty-string (string)
(if (or (not string) (string-equal string ""))
(defun ispell-accept-buffer-local-defs ()
- "Loads all buffer-local information, restarting ispell when necessary."
+ "Load all buffer-local information, restarting ispell when necessary."
(ispell-buffer-local-dict) ; May kill ispell-process.
(ispell-buffer-local-words) ; Will initialize ispell-process.
(ispell-buffer-local-parsing))
-;;; Currently ispell version 3.0.09 (beta) doesn't fully support the "~"
-;;; pipe mode command. Should be fixed in the next release.
-
(defun ispell-buffer-local-parsing ()
- "Places ispell into parsing mode for this buffer.
-This overrides the default parsing mode.
-This includes latex/nroff modes and extended character mode."
+ "Place Ispell into parsing mode for this buffer.
+Overrides the default parsing mode.
+Includes latex/nroff modes and extended character mode."
;; (ispell-init-process) must already be called.
(process-send-string ispell-process "!\n") ; Put process in terse mode.
;; We assume all major modes with "tex-mode" in them should use latex parsing
(eq ispell-parser 'tex))
(process-send-string ispell-process "+\n") ; set ispell mode to tex
(process-send-string ispell-process "-\n")) ; set mode to normal (nroff)
+ ;; Hard-wire test for SGML & HTML mode.
+ (setq ispell-skip-sgml (memq major-mode '(sgml-mode html-mode)))
;; Set default extended character mode for given buffer, if any.
(let ((extended-char-mode (ispell-get-extended-character-mode)))
(if extended-char-mode
(process-send-string ispell-process (concat extended-char-mode "\n"))))
- ;; Set buffer-local parsing mode and extended charater mode, if specified.
+ ;; Set buffer-local parsing mode and extended character mode, if specified.
(save-excursion
(goto-char (point-min))
;; Uses last valid definition
;; space separated definitions.
(setq string (buffer-substring (match-beginning 1) (match-end 1)))
(cond ((string-match "latex-mode" string)
- (process-send-string ispell-process "+\n"))
+ (process-send-string ispell-process "+\n~tex\n"))
((string-match "nroff-mode" string)
- (process-send-string ispell-process "-\n"))
+ (process-send-string ispell-process "-\n~nroff"))
((string-match "~" string) ; Set extended character mode.
(process-send-string ispell-process (concat string "\n")))
(t (message "Illegal Ispell Parsing argument!")
;;; Can kill the current ispell process
(defun ispell-buffer-local-dict ()
- "Does necessary local dictionary initialization.
+ "Initializes local dictionary.
When a dictionary is defined in the buffer (see variable
-ispell-dictionary-keyword), it will override the local setting
+`ispell-dictionary-keyword'), it will override the local setting
from \\[ispell-change-dictionary].
Both should not be used to define a buffer-local dictionary."
(save-excursion
(defun ispell-buffer-local-words ()
- "Loads the buffer-local \"dictionary\" in the current buffer."
+ "Loads the buffer-local dictionary in the current buffer."
(if (and ispell-buffer-local-name
(not (equal ispell-buffer-local-name (buffer-name))))
(progn
(setq ispell-buffer-local-name (buffer-name)))
(let ((end (save-excursion (end-of-line) (point)))
string)
- (while (re-search-forward " *\\([^ \"]+\\)" end t)
+ ;; buffer-local words separated by a space, and can contain
+ ;; any character other than a space.
+ (while (re-search-forward " *\\([^ ]+\\)" end t)
(setq string (buffer-substring (match-beginning 1) (match-end 1)))
- (process-send-string
- ispell-process (concat "@" (buffer-substring (match-beginning 1)
- (match-end 1))
- "\n")))))))
+ (process-send-string ispell-process (concat "@" string "\n")))))))
;;; returns optionally adjusted region-end-point.
(setq reg-end 0))
(save-excursion
(goto-char (point-min))
- (let ((case-fold-search nil)
- line-okay search done string)
+ (let (case-fold-search line-okay search done string)
(while (not done)
(setq search (search-forward ispell-words-keyword nil 'move)
line-okay (< (+ (length word) 1 ; 1 for space after word..
reg-end)
-(defconst ispell-version "2.26 Tue Feb 15 16:11:14 MST 1994")
+(defconst ispell-version "2.37 -- Tue Jun 13 12:05:28 EDT 1995")
(provide 'ispell)