1 ;;; spell.el --- spelling correction interface for Emacs.
3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This mode provides an Emacs interface to the UNIX spell(1) program.
28 ;; Entry points are `spell-buffer', `spell-word', `spell-region' and
31 ;; See also ispell.el for an interface to the ispell program.
36 "Interface to the UNIX spell(1) program."
40 (defcustom spell-command "spell"
41 "*Command to run the spell program."
45 (defcustom spell-filter nil
46 "*Filter function to process text before passing it to spell program.
47 This function might remove text-processor commands.
48 nil means don't alter the text before checking it."
53 (put 'spell-filter 'risky-local-variable t)
56 (defun spell-buffer ()
57 "Check spelling of every word in the buffer.
58 For each incorrect word, you are asked for the correct spelling
59 and then put into a query-replace to fix some or all occurrences.
60 If you do not want to change a word, just give the same word
61 as its \"correct\" spelling; then the query replace is skipped."
63 (spell-region (point-min) (point-max) "buffer"))
67 "Check spelling of word at or before point.
68 If it is not correct, ask user for the correct spelling
69 and `query-replace' the entire buffer to substitute it."
71 (let (beg end spell-filter)
73 (if (not (looking-at "\\<"))
78 (spell-region beg end (buffer-substring beg end))))
81 (defun spell-region (start end &optional description)
82 "Like `spell-buffer' but applies only to region.
83 Used in a program, applies from START to END.
84 DESCRIPTION is an optional string naming the unit being checked:
85 for example, \"word\"."
87 (let ((filter spell-filter)
88 (buf (get-buffer-create " *temp*")))
93 (message "Checking spelling of %s..." (or description "region"))
94 (if (and (null filter) (= ?\n (char-after (1- end))))
95 (if (string= "spell" spell-command)
96 (call-process-region start end "spell" nil buf)
97 (call-process-region start end shell-file-name
98 nil buf nil "-c" spell-command))
99 (let ((oldbuf (current-buffer)))
102 (insert-buffer-substring oldbuf start end)
103 (or (bolp) (insert ?\n))
104 (if filter (funcall filter))
105 (if (string= "spell" spell-command)
106 (call-process-region (point-min) (point-max) "spell" t buf)
107 (call-process-region (point-min) (point-max) shell-file-name
108 t buf nil "-c" spell-command)))))
109 (message "Checking spelling of %s...%s"
110 (or description "region")
119 (while (save-excursion
124 (goto-char (point-min))
126 (buffer-substring (point)
127 (progn (end-of-line) (point)))))
129 (delete-region (point-min) (point))
131 (read-input (concat "`" word
132 "' not recognized; edit a replacement: ")
134 (flush-lines (concat "^" (regexp-quote word) "$")))
135 (if (not (equal word newword))
137 (goto-char (point-min))
138 (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b")
143 (defun spell-string (string)
144 "Check spelling of string supplied as argument."
145 (interactive "sSpell string: ")
146 (let ((buf (get-buffer-create " *temp*")))
152 (if (string= "spell" spell-command)
153 (call-process-region (point-min) (point-max) "spell"
155 (call-process-region (point-min) (point-max) shell-file-name
156 t t nil "-c" spell-command))
157 (if (= 0 (buffer-size))
158 (message "%s is correct" string)
159 (goto-char (point-min))
160 (while (search-forward "\n" nil t)
162 (message "%sincorrect" (buffer-substring 1 (point-max)))))))
166 ;;; spell.el ends here