lisp/obsolete/spell.el

   1 ;;; spell.el --- spelling correction interface for Emacs
   2
   3 ;; Copyright (C) 1985, 2001-2013 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: wp, unix
   7 ;; Obsolete-since: 23.1
   8 ;;   (not in obsolete/ directory then, but all functions marked obsolete)
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; This mode provides an Emacs interface to the UNIX spell(1) program.
  28 ;; Entry points are `spell-buffer', `spell-word', `spell-region' and
  29 ;; `spell-string'.
  30
  31 ;; See also ispell.el for an interface to the ispell program.
  32
  33 ;;; Code:
  34
  35 (defgroup spell nil
  36   "Interface to the UNIX spell(1) program."
  37   :prefix "spell-"
  38   :group 'applications)
  39
  40 (defcustom spell-command "spell"
  41   "Command to run the spell program."
  42   :type 'string
  43   :group 'spell)
  44
  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."
  49   :type '(choice (const nil) function)
  50   :group 'spell)
  51
  52 ;;;###autoload
  53 (put 'spell-filter 'risky-local-variable t)
  54
  55 ;;;###autoload
  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."
  62   (interactive)
  63   ;; Don't warn about spell-region being obsolete.
  64   (with-no-warnings
  65     (spell-region (point-min) (point-max) "buffer")))
  66 ;;;###autoload
  67 (make-obsolete 'spell-buffer 'ispell-buffer "23.1")
  68
  69 ;;;###autoload
  70 (defun spell-word ()
  71   "Check spelling of word at or before point.
  72 If it is not correct, ask user for the correct spelling
  73 and `query-replace' the entire buffer to substitute it."
  74   (interactive)
  75   (let (beg end spell-filter)
  76     (save-excursion
  77      (if (not (looking-at "\\<"))
  78          (forward-word -1))
  79      (setq beg (point))
  80      (forward-word 1)
  81      (setq end (point)))
  82     ;; Don't warn about spell-region being obsolete.
  83     (with-no-warnings
  84       (spell-region beg end (buffer-substring beg end)))))
  85 ;;;###autoload
  86 (make-obsolete 'spell-word 'ispell-word "23.1")
  87
  88 ;;;###autoload
  89 (defun spell-region (start end &optional description)
  90   "Like `spell-buffer' but applies only to region.
  91 Used in a program, applies from START to END.
  92 DESCRIPTION is an optional string naming the unit being checked:
  93 for example, \"word\"."
  94   (interactive "r")
  95   (let ((filter spell-filter)
  96         (buf (get-buffer-create " *temp*")))
  97     (with-current-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         (with-current-buffer buf
 108           (insert-buffer-substring oldbuf start end)
 109           (or (bolp) (insert ?\n))
 110           (if filter (funcall filter))
 111           (if (string= "spell" spell-command)
 112               (call-process-region (point-min) (point-max) "spell" t buf)
 113             (call-process-region (point-min) (point-max) shell-file-name
 114                                  t buf nil "-c" spell-command)))))
 115     (message "Checking spelling of %s...%s"
 116              (or description "region")
 117              (if (with-current-buffer buf
 118                    (> (buffer-size) 0))
 119                  "not correct"
 120                "correct"))
 121     (let (word newword
 122           (case-fold-search t)
 123           (case-replace t))
 124       (while (with-current-buffer buf
 125                (> (buffer-size) 0))
 126         (with-current-buffer buf
 127           (goto-char (point-min))
 128           (setq word (downcase
 129                       (buffer-substring (point)
 130                                         (progn (end-of-line) (point)))))
 131           (forward-char 1)
 132           (delete-region (point-min) (point))
 133           (setq newword
 134                 (read-string (concat "`" word
 135                                      "' not recognized; edit a replacement: ")
 136                              word))
 137           (flush-lines (concat "^" (regexp-quote word) "$")))
 138         (if (not (equal word newword))
 139             (progn
 140              (goto-char (point-min))
 141              (query-replace-regexp (concat "\\b" (regexp-quote word) "\\b")
 142                                    newword)))))))
 143 ;;;###autoload
 144 (make-obsolete 'spell-region 'ispell-region "23.1")
 145
 146 ;;;###autoload
 147 (defun spell-string (string)
 148   "Check spelling of string supplied as argument."
 149   (interactive "sSpell string: ")
 150   (with-temp-buffer
 151     (widen)
 152     (erase-buffer)
 153     (insert string "\n")
 154     (if (string= "spell" spell-command)
 155         (call-process-region (point-min) (point-max) "spell"
 156                              t t)
 157       (call-process-region (point-min) (point-max) shell-file-name
 158                            t t nil "-c" spell-command))
 159     (if (= 0 (buffer-size))
 160         (message "%s is correct" string)
 161       (goto-char (point-min))
 162       (while (search-forward "\n" nil t)
 163         (replace-match " "))
 164       (message "%sincorrect" (buffer-substring 1 (point-max))))))
 165 ;;;###autoload
 166 (make-obsolete 'spell-string "The `spell' package is obsolete - use `ispell'."
 167                "23.1")
 168
 169 (provide 'spell)
 170
 171 ;;; spell.el ends here