emacs/lisp/erc/erc-spelling.el

123 lines
4.3 KiB
EmacsLisp

;;; erc-spelling.el --- use flyspell in ERC -*- lexical-binding: t; -*-
;; Copyright (C) 2005-2024 Free Software Foundation, Inc.
;; Author: Jorgen Schaefer <forcer@forcix.cx>
;; Maintainer: Amin Bandali <bandali@gnu.org>, F. Jason Park <jp@neverwas.me>
;; Keywords: comm, irc
;; URL: https://www.emacswiki.org/emacs/ErcSpelling
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This is an ERC module to enable flyspell mode in ERC buffers. This
;; ensures correct behavior of flyspell, and even sets up a
;; channel-local dictionary if so required.
;;; Code:
(require 'erc)
(require 'flyspell)
(defgroup erc-spelling nil
"Flyspell integration for ERC."
:group 'erc)
;;;###autoload(autoload 'erc-spelling-mode "erc-spelling" nil t)
(define-erc-module spelling nil
"Enable flyspell mode in ERC buffers."
;; Use erc-connect-pre-hook instead of erc-mode-hook as pre-hook is
;; called AFTER the server buffer is initialized.
((add-hook 'erc-connect-pre-hook #'erc-spelling-init)
(unless erc--updating-modules-p
(erc-with-all-buffers-of-server nil nil
(erc-spelling-init (current-buffer)))))
((remove-hook 'erc-connect-pre-hook #'erc-spelling-init)
(dolist (buffer (erc-buffer-list))
(with-current-buffer buffer (flyspell-mode 0)))))
(defcustom erc-spelling-dictionaries nil
"An alist mapping buffer names to dictionaries.
Each element is a list of the form (KEY VALUE), where KEY is a buffer
name and VALUE a locale or dictionary name known to `ispell', for
example: ((\"Libera.Chat\" \"en_US\") (\"#esperanto\" \"esperanto\")).
The dictionary is inherited from server buffers, so if you want a
default dictionary for some server, you can use a server buffer
name here."
:type '(choice (const nil)
(repeat (list (string :tag "Buffer name")
(string :tag "Dictionary")))))
(defun erc-spelling-init (buffer)
"Enable flyspell mode in an ERC buffer.
The current buffer is given by BUFFER."
(with-current-buffer buffer
(let ((name (downcase (buffer-name)))
(dicts erc-spelling-dictionaries))
(when dicts
(while (and dicts
(not (string= name (downcase (caar dicts)))))
(setq dicts (cdr dicts)))
(setq ispell-local-dictionary
(if dicts
(cadr (car dicts))
(erc-with-server-buffer ispell-local-dictionary)))))
(setq flyspell-generic-check-word-predicate #'erc-spelling-flyspell-verify)
(flyspell-mode 1)))
(defun erc-spelling-unhighlight-word (word)
"Unhighlight the given WORD.
The cadr is the beginning and the caddr is the end."
(let ((beg (nth 1 word))
(end (nth 2 word)))
(flyspell-unhighlight-at beg)
(when (> end beg)
(flyspell-unhighlight-at (1- end)))))
(defun erc-spelling-flyspell-verify ()
"Flyspell only the input line, nothing else."
;; FIXME: Don't use `flyspell-word'!
(let ((word-data (and (boundp 'flyspell-word)
flyspell-word)))
(when word-data
(cond ((< (point) erc-input-marker)
nil)
;; don't spell-check names of users
((and erc-channel-users
(erc-get-channel-user (car word-data)))
(erc-spelling-unhighlight-word word-data)
nil)
;; if '/' occurs before the word, don't spell-check it
((eq (char-before (nth 1 word-data)) ?/)
(erc-spelling-unhighlight-word word-data)
nil)
(t t)))))
(put 'erc-mode
'flyspell-mode-predicate
#'erc-spelling-flyspell-verify)
(provide 'erc-spelling)
;;; erc-spelling.el ends here
;; Local Variables:
;; generated-autoload-file: "erc-loaddefs.el"
;; End: