Checked anti.texi, errors.texi, and maps.texi.
[emacs.git] / lisp / textmodes / spell.el
blobaa062edffc4ada6ccf23bb000394e38d44e27a57
1 ;;; spell.el --- spelling correction interface for Emacs
3 ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: wp, unix
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
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'.
30 ;; See also ispell.el for an interface to the ispell program.
32 ;;; Code:
34 (defgroup spell nil
35 "Interface to the UNIX spell(1) program."
36 :prefix "spell-"
37 :group 'applications)
39 (defcustom spell-command "spell"
40 "*Command to run the spell program."
41 :type 'string
42 :group 'spell)
44 (defcustom spell-filter nil
45 "*Filter function to process text before passing it to spell program.
46 This function might remove text-processor commands.
47 nil means don't alter the text before checking it."
48 :type '(choice (const nil) function)
49 :group 'spell)
51 ;;;###autoload
52 (put 'spell-filter 'risky-local-variable t)
54 ;;;###autoload
55 (defun spell-buffer ()
56 "Check spelling of every word in the buffer.
57 For each incorrect word, you are asked for the correct spelling
58 and then put into a query-replace to fix some or all occurrences.
59 If you do not want to change a word, just give the same word
60 as its \"correct\" spelling; then the query replace is skipped."
61 (interactive)
62 ;; Don't warn about spell-region being obsolete.
63 (with-no-warnings
64 (spell-region (point-min) (point-max) "buffer")))
65 ;;;###autoload
66 (make-obsolete 'spell-buffer 'ispell-buffer "23.1")
68 ;;;###autoload
69 (defun spell-word ()
70 "Check spelling of word at or before point.
71 If it is not correct, ask user for the correct spelling
72 and `query-replace' the entire buffer to substitute it."
73 (interactive)
74 (let (beg end spell-filter)
75 (save-excursion
76 (if (not (looking-at "\\<"))
77 (forward-word -1))
78 (setq beg (point))
79 (forward-word 1)
80 (setq end (point)))
81 ;; Don't warn about spell-region being obsolete.
82 (with-no-warnings
83 (spell-region beg end (buffer-substring beg end)))))
84 ;;;###autoload
85 (make-obsolete 'spell-word 'ispell-word "23.1")
87 ;;;###autoload
88 (defun spell-region (start end &optional description)
89 "Like `spell-buffer' but applies only to region.
90 Used in a program, applies from START to END.
91 DESCRIPTION is an optional string naming the unit being checked:
92 for example, \"word\"."
93 (interactive "r")
94 (let ((filter spell-filter)
95 (buf (get-buffer-create " *temp*")))
96 (save-excursion
97 (set-buffer buf)
98 (widen)
99 (erase-buffer))
100 (message "Checking spelling of %s..." (or description "region"))
101 (if (and (null filter) (= ?\n (char-after (1- end))))
102 (if (string= "spell" spell-command)
103 (call-process-region start end "spell" nil buf)
104 (call-process-region start end shell-file-name
105 nil buf nil "-c" spell-command))
106 (let ((oldbuf (current-buffer)))
107 (save-excursion
108 (set-buffer buf)
109 (insert-buffer-substring oldbuf start end)
110 (or (bolp) (insert ?\n))
111 (if filter (funcall filter))
112 (if (string= "spell" spell-command)
113 (call-process-region (point-min) (point-max) "spell" t buf)
114 (call-process-region (point-min) (point-max) shell-file-name
115 t buf nil "-c" spell-command)))))
116 (message "Checking spelling of %s...%s"
117 (or description "region")
118 (if (save-excursion
119 (set-buffer buf)
120 (> (buffer-size) 0))
121 "not correct"
122 "correct"))
123 (let (word newword
124 (case-fold-search t)
125 (case-replace t))
126 (while (save-excursion
127 (set-buffer buf)
128 (> (buffer-size) 0))
129 (save-excursion
130 (set-buffer buf)
131 (goto-char (point-min))
132 (setq word (downcase
133 (buffer-substring (point)
134 (progn (end-of-line) (point)))))
135 (forward-char 1)
136 (delete-region (point-min) (point))
137 (setq newword
138 (read-string (concat "`" word
139 "' not recognized; edit a replacement: ")
140 word))
141 (flush-lines (concat "^" (regexp-quote word) "$")))
142 (if (not (equal word newword))
143 (progn
144 (goto-char (point-min))
145 (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b")
146 newword)))))))
147 ;;;###autoload
148 (make-obsolete 'spell-region 'ispell-region "23.1")
150 ;;;###autoload
151 (defun spell-string (string)
152 "Check spelling of string supplied as argument."
153 (interactive "sSpell string: ")
154 (let ((buf (get-buffer-create " *temp*")))
155 (save-excursion
156 (set-buffer buf)
157 (widen)
158 (erase-buffer)
159 (insert string "\n")
160 (if (string= "spell" spell-command)
161 (call-process-region (point-min) (point-max) "spell"
162 t t)
163 (call-process-region (point-min) (point-max) shell-file-name
164 t t nil "-c" spell-command))
165 (if (= 0 (buffer-size))
166 (message "%s is correct" string)
167 (goto-char (point-min))
168 (while (search-forward "\n" nil t)
169 (replace-match " "))
170 (message "%sincorrect" (buffer-substring 1 (point-max)))))))
171 ;;;###autoload
172 (make-obsolete 'spell-string "The `spell' package is obsolete - use `ispell'."
173 "23.1")
175 (provide 'spell)
177 ;; arch-tag: 7eabb848-9c76-431a-bcdb-0e0592d2db04
178 ;;; spell.el ends here