lisp/textmodes/spell.el

   1 ;;; spell.el --- spelling correction interface for Emacs
   2
   3 ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: wp, unix
   8
   9 ;; This file is part of GNU Emacs.
  10
  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, or (at your option)
  14 ;; any later version.
  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
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This mode provides an Emacs interface to the UNIX spell(1) program.
  29 ;; Entry points are `spell-buffer', `spell-word', `spell-region' and
  30 ;; `spell-string'.
  31
  32 ;; See also ispell.el for an interface to the ispell program.
  33
  34 ;;; Code:
  35
  36 (defgroup spell nil
  37   "Interface to the UNIX spell(1) program."
  38   :prefix "spell-"
  39   :group 'applications)
  40
  41 (defcustom spell-command "spell"
  42   "*Command to run the spell program."
  43   :type 'string
  44   :group 'spell)
  45
  46 (defcustom spell-filter nil
  47   "*Filter function to process text before passing it to spell program.
  48 This function might remove text-processor commands.
  49 nil means don't alter the text before checking it."
  50   :type '(choice (const nil) function)
  51   :group 'spell)
  52
  53 ;;;###autoload
  54 (put 'spell-filter 'risky-local-variable t)
  55
  56 ;;;###autoload
  57 (defun spell-buffer ()
  58   "Check spelling of every word in the buffer.
  59 For each incorrect word, you are asked for the correct spelling
  60 and then put into a query-replace to fix some or all occurrences.
  61 If you do not want to change a word, just give the same word
  62 as its \"correct\" spelling; then the query replace is skipped."
  63   (interactive)
  64   ;; Don't warn about spell-region being obsolete.
  65   (with-no-warnings
  66     (spell-region (point-min) (point-max) "buffer")))
  67 ;;;###autoload
  68 (make-obsolete 'spell-buffer 'ispell-buffer "23.1")
  69
  70 ;;;###autoload
  71 (defun spell-word ()
  72   "Check spelling of word at or before point.
  73 If it is not correct, ask user for the correct spelling
  74 and `query-replace' the entire buffer to substitute it."
  75   (interactive)
  76   (let (beg end spell-filter)
  77     (save-excursion
  78      (if (not (looking-at "\\<"))
  79          (forward-word -1))
  80      (setq beg (point))
  81      (forward-word 1)
  82      (setq end (point)))
  83     ;; Don't warn about spell-region being obsolete.
  84     (with-no-warnings
  85       (spell-region beg end (buffer-substring beg end)))))
  86 ;;;###autoload
  87 (make-obsolete 'spell-word 'ispell-word "23.1")
  88
  89 ;;;###autoload
  90 (defun spell-region (start end &optional description)
  91   "Like `spell-buffer' but applies only to region.
  92 Used in a program, applies from START to END.
  93 DESCRIPTION is an optional string naming the unit being checked:
  94 for example, \"word\"."
  95   (interactive "r")
  96   (let ((filter spell-filter)
  97         (buf (get-buffer-create " *temp*")))
  98     (save-excursion
  99      (set-buffer buf)
 100      (widen)
 101      (erase-buffer))
 102     (message "Checking spelling of %s..." (or description "region"))
 103     (if (and (null filter) (= ?\n (char-after (1- end))))
 104         (if (string= "spell" spell-command)
 105             (call-process-region start end "spell" nil buf)
 106           (call-process-region start end shell-file-name
 107                                nil buf nil "-c" spell-command))
 108       (let ((oldbuf (current-buffer)))
 109         (save-excursion
 110          (set-buffer buf)
 111          (insert-buffer-substring oldbuf start end)
 112          (or (bolp) (insert ?\n))
 113          (if filter (funcall filter))
 114          (if (string= "spell" spell-command)
 115              (call-process-region (point-min) (point-max) "spell" t buf)
 116            (call-process-region (point-min) (point-max) shell-file-name
 117                                 t buf nil "-c" spell-command)))))
 118     (message "Checking spelling of %s...%s"
 119              (or description "region")
 120              (if (save-excursion
 121                   (set-buffer buf)
 122                   (> (buffer-size) 0))
 123                  "not correct"
 124                "correct"))
 125     (let (word newword
 126           (case-fold-search t)
 127           (case-replace t))
 128       (while (save-excursion
 129               (set-buffer buf)
 130               (> (buffer-size) 0))
 131         (save-excursion
 132          (set-buffer buf)
 133          (goto-char (point-min))
 134          (setq word (downcase
 135                      (buffer-substring (point)
 136                                        (progn (end-of-line) (point)))))
 137          (forward-char 1)
 138          (delete-region (point-min) (point))
 139          (setq newword
 140                (read-string (concat "`" word
 141                                     "' not recognized; edit a replacement: ")
 142                             word))
 143          (flush-lines (concat "^" (regexp-quote word) "$")))
 144         (if (not (equal word newword))
 145             (progn
 146              (goto-char (point-min))
 147              (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b")
 148                                    newword)))))))
 149 ;;;###autoload
 150 (make-obsolete 'spell-region 'ispell-region "23.1")
 151
 152 ;;;###autoload
 153 (defun spell-string (string)
 154   "Check spelling of string supplied as argument."
 155   (interactive "sSpell string: ")
 156   (let ((buf (get-buffer-create " *temp*")))
 157     (save-excursion
 158      (set-buffer buf)
 159      (widen)
 160      (erase-buffer)
 161      (insert string "\n")
 162      (if (string= "spell" spell-command)
 163          (call-process-region (point-min) (point-max) "spell"
 164                               t t)
 165        (call-process-region (point-min) (point-max) shell-file-name
 166                             t t nil "-c" spell-command))
 167      (if (= 0 (buffer-size))
 168          (message "%s is correct" string)
 169        (goto-char (point-min))
 170        (while (search-forward "\n" nil t)
 171          (replace-match " "))
 172        (message "%sincorrect" (buffer-substring 1 (point-max)))))))
 173 ;;;###autoload
 174 (make-obsolete 'spell-string "The `spell' package is obsolete - use `ispell'."
 175                "23.1")
 176
 177 (provide 'spell)
 178
 179 ;; arch-tag: 7eabb848-9c76-431a-bcdb-0e0592d2db04
 180 ;;; spell.el ends here