company-ispell.el

;;; company-ispell.el --- company-mode completion backend using Ispell  -*- lexical-binding: t -*-

;; Copyright (C) 2009-2011, 2013-2016, 2018, 2021, 2023  Free Software Foundation, Inc.

;; Author: Nikolaj Schumacher

;; 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:
;;

;;; Code:

(require 'company)
(require 'cl-lib)
(require 'ispell)

(defgroup company-ispell nil
  "Completion backend using Ispell."
  :group 'company)

(defun company--set-dictionary (symbol value)
  (set-default-toplevel-value symbol value)
  (company-cache-delete 'ispell-candidates))

(defcustom company-ispell-dictionary nil
  "Dictionary to use for `company-ispell'.

If nil, use `ispell-complete-word-dict' or `ispell-alternate-dictionary'."
  :type '(choice (const :tag "default (nil)" nil)
                 (file :tag "dictionary" t))
  :set #'company--set-dictionary)

(defvar company-ispell-available 'unknown)

(defun company-ispell-available ()
  (when (eq company-ispell-available 'unknown)
    (condition-case err
        (progn
          (ispell-lookup-words "WHATEVER")
          (setq company-ispell-available t))
      (error
       (message "Company-Ispell: %s" (error-message-string err))
       (setq company-ispell-available nil))))
  company-ispell-available)

(defun company--ispell-dict ()
  "Determine which dictionary to use."
  (let ((dict (or company-ispell-dictionary
                  ispell-complete-word-dict
                  ispell-alternate-dictionary)))
    (when dict
      (expand-file-name dict))))

;;;###autoload
(defun company-ispell (command &optional arg &rest _ignored)
  "`company-mode' completion backend using Ispell."
  (interactive (list 'interactive))
  (cl-case command
    (interactive (company-begin-backend 'company-ispell))
    (prefix (when (company-ispell-available)
              (company-grab-word)))
    (candidates
     (let* ((dict (company--ispell-dict))
            (all-words
             (company-cache-fetch 'ispell-candidates
                                  (lambda () (ispell-lookup-words "" dict))
                                  :check-tag dict))
            (completion-ignore-case t))
       (if (string-empty-p arg)
           ;; Small optimization.
           all-words
         (company-substitute-prefix
          arg
          ;; Work around issue #284.
          (all-completions arg all-words)))))
    (kind 'text)
    (no-cache t)
    (sorted t)
    (ignore-case t)))

(provide 'company-ispell)
;;; company-ispell.el ends here