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
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; This mode provides an Emacs interface to the UNIX spell(1) program.
27 ;; Entry points are `spell-buffer', `spell-word', `spell-region' and
28 ;; `spell-string'. These facilities are documented in the Emacs user's
33 (defvar spell-command "spell"
34 "*Command to run the spell program.")
36 (defvar spell-filter nil
37 "*Filter function to process text before passing it to spell program.
38 This function might remove text-processor commands.
39 nil means don't alter the text before checking it.")
42 (put 'spell-filter 'risky-local-variable t)
45 (defun spell-buffer ()
46 "Check spelling of every word in the buffer.
47 For each incorrect word, you are asked for the correct spelling
48 and then put into a query-replace to fix some or all occurrences.
49 If you do not want to change a word, just give the same word
50 as its \"correct\" spelling; then the query replace is skipped."
52 (spell-region (point-min) (point-max) "buffer"))
56 "Check spelling of word at or before point.
57 If it is not correct, ask user for the correct spelling
58 and `query-replace' the entire buffer to substitute it."
60 (let (beg end spell-filter)
62 (if (not (looking-at "\\<"))
67 (spell-region beg end (buffer-substring beg end))))
70 (defun spell-region (start end &optional description)
71 "Like `spell-buffer' but applies only to region.
72 Used in a program, applies from START to END.
73 DESCRIPTION is an optional string naming the unit being checked:
74 for example, \"word\"."
76 (let ((filter spell-filter)
77 (buf (get-buffer-create " *temp*")))
82 (message "Checking spelling of %s..." (or description "region"))
83 (if (and (null filter) (= ?\n (char-after (1- end))))
84 (if (string= "spell" spell-command)
85 (call-process-region start end "spell" nil buf)
86 (call-process-region start end shell-file-name
87 nil buf nil "-c" spell-command))
88 (let ((oldbuf (current-buffer)))
91 (insert-buffer-substring oldbuf start end)
92 (or (bolp) (insert ?\n))
93 (if filter (funcall filter))
94 (if (string= "spell" spell-command)
95 (call-process-region (point-min) (point-max) "spell" t buf)
96 (call-process-region (point-min) (point-max) shell-file-name
97 t buf nil "-c" spell-command)))))
98 (message "Checking spelling of %s...%s"
99 (or description "region")
108 (while (save-excursion
113 (goto-char (point-min))
115 (buffer-substring (point)
116 (progn (end-of-line) (point)))))
118 (delete-region (point-min) (point))
120 (read-input (concat "`" word
121 "' not recognized; edit a replacement: ")
123 (flush-lines (concat "^" (regexp-quote word) "$")))
124 (if (not (equal word newword))
126 (goto-char (point-min))
127 (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b")
132 (defun spell-string (string)
133 "Check spelling of string supplied as argument."
134 (interactive "sSpell string: ")
135 (let ((buf (get-buffer-create " *temp*")))
141 (if (string= "spell" spell-command)
142 (call-process-region (point-min) (point-max) "spell"
144 (call-process-region (point-min) (point-max) shell-file-name
145 t t nil "-c" spell-command))
146 (if (= 0 (buffer-size))
147 (message "%s is correct" string)
148 (goto-char (point-min))
149 (while (search-forward "\n" nil t)
151 (message "%sincorrect" (buffer-substring 1 (point-max)))))))
153 ;;; spell.el ends here