Mercurial > emacs
annotate lisp/textmodes/spell.el @ 110855:bec49af30c2f
Merge changes from emacs-23 branch.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Fri, 08 Oct 2010 12:14:47 +0200 |
parents | 7c4da622f181 |
children | 417b1e4d63cd |
rev | line source |
---|---|
38412
253f761ad37b
Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents:
35965
diff
changeset
|
1 ;;; spell.el --- spelling correction interface for Emacs |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
2 |
110494
7c4da622f181
Remove leading `*' from docs of some defcustoms etc.
Glenn Morris <rgm@gnu.org>
parents:
106815
diff
changeset
|
3 ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, |
7c4da622f181
Remove leading `*' from docs of some defcustoms etc.
Glenn Morris <rgm@gnu.org>
parents:
106815
diff
changeset
|
4 ;; 2009, 2010 Free Software Foundation, Inc. |
841 | 5 |
787
3cece0106722
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
6 ;; Maintainer: FSF |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
7 ;; Keywords: wp, unix |
36 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
36 | 12 ;; it under the terms of the GNU General Public License as published by |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
14 ;; (at your option) any later version. |
36 | 15 |
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. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
94670
f4a69fedbd46
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
36 | 23 |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
24 ;;; Commentary: |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
25 |
3591
507f64624555
Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents:
2315
diff
changeset
|
26 ;; This mode provides an Emacs interface to the UNIX spell(1) program. |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
27 ;; Entry points are `spell-buffer', `spell-word', `spell-region' and |
20963
0d56074cec59
Doc fix in Commentary section.
Stephen Eglen <stephen@gnu.org>
parents:
20959
diff
changeset
|
28 ;; `spell-string'. |
0d56074cec59
Doc fix in Commentary section.
Stephen Eglen <stephen@gnu.org>
parents:
20959
diff
changeset
|
29 |
0d56074cec59
Doc fix in Commentary section.
Stephen Eglen <stephen@gnu.org>
parents:
20959
diff
changeset
|
30 ;; See also ispell.el for an interface to the ispell program. |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
31 |
787
3cece0106722
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
32 ;;; Code: |
36 | 33 |
20959 | 34 (defgroup spell nil |
35 "Interface to the UNIX spell(1) program." | |
36 :prefix "spell-" | |
37 :group 'applications) | |
36 | 38 |
20959 | 39 (defcustom spell-command "spell" |
110494
7c4da622f181
Remove leading `*' from docs of some defcustoms etc.
Glenn Morris <rgm@gnu.org>
parents:
106815
diff
changeset
|
40 "Command to run the spell program." |
20959 | 41 :type 'string |
42 :group 'spell) | |
43 | |
44 (defcustom spell-filter nil | |
110494
7c4da622f181
Remove leading `*' from docs of some defcustoms etc.
Glenn Morris <rgm@gnu.org>
parents:
106815
diff
changeset
|
45 "Filter function to process text before passing it to spell program. |
36 | 46 This function might remove text-processor commands. |
20959 | 47 nil means don't alter the text before checking it." |
35965 | 48 :type '(choice (const nil) function) |
20959 | 49 :group 'spell) |
36 | 50 |
258 | 51 ;;;###autoload |
10323
759195dcd02b
(spell-filter): Make it a risky-local-variable.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
52 (put 'spell-filter 'risky-local-variable t) |
759195dcd02b
(spell-filter): Make it a risky-local-variable.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
53 |
759195dcd02b
(spell-filter): Make it a risky-local-variable.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
54 ;;;###autoload |
36 | 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) | |
92087
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
62 ;; Don't warn about spell-region being obsolete. |
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
63 (with-no-warnings |
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
64 (spell-region (point-min) (point-max) "buffer"))) |
92041
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
65 ;;;###autoload |
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
66 (make-obsolete 'spell-buffer 'ispell-buffer "23.1") |
36 | 67 |
258 | 68 ;;;###autoload |
36 | 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 | |
1541 | 72 and `query-replace' the entire buffer to substitute it." |
36 | 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))) | |
92087
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
81 ;; Don't warn about spell-region being obsolete. |
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
82 (with-no-warnings |
facc33e36f8b
(spell-buffer, spell-word): Suppress compiler warnings about
Glenn Morris <rgm@gnu.org>
parents:
92041
diff
changeset
|
83 (spell-region beg end (buffer-substring beg end))))) |
92041
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
84 ;;;###autoload |
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
85 (make-obsolete 'spell-word 'ispell-word "23.1") |
36 | 86 |
258 | 87 ;;;###autoload |
36 | 88 (defun spell-region (start end &optional description) |
1541 | 89 "Like `spell-buffer' but applies only to region. |
36 | 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*"))) | |
105813
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
96 (with-current-buffer buf |
36 | 97 (widen) |
98 (erase-buffer)) | |
99 (message "Checking spelling of %s..." (or description "region")) | |
100 (if (and (null filter) (= ?\n (char-after (1- end)))) | |
101 (if (string= "spell" spell-command) | |
102 (call-process-region start end "spell" nil buf) | |
103 (call-process-region start end shell-file-name | |
104 nil buf nil "-c" spell-command)) | |
105 (let ((oldbuf (current-buffer))) | |
105813
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
106 (with-current-buffer buf |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
107 (insert-buffer-substring oldbuf start end) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
108 (or (bolp) (insert ?\n)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
109 (if filter (funcall filter)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
110 (if (string= "spell" spell-command) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
111 (call-process-region (point-min) (point-max) "spell" t buf) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
112 (call-process-region (point-min) (point-max) shell-file-name |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
113 t buf nil "-c" spell-command))))) |
36 | 114 (message "Checking spelling of %s...%s" |
115 (or description "region") | |
105813
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
116 (if (with-current-buffer buf |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
117 (> (buffer-size) 0)) |
36 | 118 "not correct" |
119 "correct")) | |
120 (let (word newword | |
121 (case-fold-search t) | |
122 (case-replace t)) | |
105813
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
123 (while (with-current-buffer buf |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
124 (> (buffer-size) 0)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
125 (with-current-buffer buf |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
126 (goto-char (point-min)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
127 (setq word (downcase |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
128 (buffer-substring (point) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
129 (progn (end-of-line) (point))))) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
130 (forward-char 1) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
131 (delete-region (point-min) (point)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
132 (setq newword |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
133 (read-string (concat "`" word |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
134 "' not recognized; edit a replacement: ") |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
135 word)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
136 (flush-lines (concat "^" (regexp-quote word) "$"))) |
36 | 137 (if (not (equal word newword)) |
138 (progn | |
139 (goto-char (point-min)) | |
140 (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b") | |
141 newword))))))) | |
92041
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
142 ;;;###autoload |
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
143 (make-obsolete 'spell-region 'ispell-region "23.1") |
36 | 144 |
258 | 145 ;;;###autoload |
36 | 146 (defun spell-string (string) |
147 "Check spelling of string supplied as argument." | |
148 (interactive "sSpell string: ") | |
149 (let ((buf (get-buffer-create " *temp*"))) | |
105813
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
150 (with-current-buffer buf |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
151 (widen) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
152 (erase-buffer) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
153 (insert string "\n") |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
154 (if (string= "spell" spell-command) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
155 (call-process-region (point-min) (point-max) "spell" |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
156 t t) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
157 (call-process-region (point-min) (point-max) shell-file-name |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
158 t t nil "-c" spell-command)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
159 (if (= 0 (buffer-size)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
160 (message "%s is correct" string) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
161 (goto-char (point-min)) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
162 (while (search-forward "\n" nil t) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
163 (replace-match " ")) |
df4934f25eef
* textmodes/two-column.el (2C-split):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
164 (message "%sincorrect" (buffer-substring 1 (point-max))))))) |
92041
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
165 ;;;###autoload |
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
166 (make-obsolete 'spell-string "The `spell' package is obsolete - use `ispell'." |
c4f57f87fefe
(spell-buffer, spell-word, spell-region)
Glenn Morris <rgm@gnu.org>
parents:
79719
diff
changeset
|
167 "23.1") |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
168 |
18383 | 169 (provide 'spell) |
170 | |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
92087
diff
changeset
|
171 ;; arch-tag: 7eabb848-9c76-431a-bcdb-0e0592d2db04 |
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
258
diff
changeset
|
172 ;;; spell.el ends here |