From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id F38DC6DE1410 for ; Sat, 24 Oct 2015 10:44:01 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: 0.098 X-Spam-Level: X-Spam-Status: No, score=0.098 tagged_above=-999 required=5 tests=[AWL=0.098] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id PGF7NYmgAgfN for ; Sat, 24 Oct 2015 10:43:58 -0700 (PDT) Received: from gitolite.debian.net (gitolite.debian.net [87.98.215.224]) by arlo.cworth.org (Postfix) with ESMTPS id 7CDA76DE1403 for ; Sat, 24 Oct 2015 10:43:58 -0700 (PDT) Received: from remotemail by gitolite.debian.net with local (Exim 4.80) (envelope-from ) id 1Zq2pl-0001Hr-FX; Sat, 24 Oct 2015 17:42:25 +0000 Received: (nullmailer pid 32265 invoked by uid 1000); Sat, 24 Oct 2015 17:41:28 -0000 From: David Bremner To: Mark Walters , notmuch@notmuchmail.org Subject: [PATCH 3/3] Emacs: Add address completion based on company-mode Date: Sat, 24 Oct 2015 14:41:24 -0300 Message-Id: <1445708484-32189-4-git-send-email-david@tethera.net> X-Mailer: git-send-email 2.6.1 In-Reply-To: <1445708484-32189-1-git-send-email-david@tethera.net> References: <1445702019-10638-1-git-send-email-markwalters1009@gmail.com> <1445708484-32189-1-git-send-email-david@tethera.net> X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 24 Oct 2015 17:44:02 -0000 From: Michal Sojka With this patch, address completion candidates are shown automatically after short typing delay in a nice popup box. This requires company-mode to be installed and it works only on Emacs >= 24. The completion is based entirely on the asynchronous address harvesting from notmuch-address.el so the GUI is theoretically not blocked for long time. The completion works similarly as the TAB-initiated completion from notmuch-address.el, i.e. quick harvest based on user input is executed first and only after full harvesting is finished, in-memory cached data is used. --- emacs/Makefile.local | 1 + emacs/notmuch-company.el | 73 ++++++++++++++++++++++++++++++++++++++++++++++++ emacs/notmuch-mua.el | 13 ++++++++- 3 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 emacs/notmuch-company.el diff --git a/emacs/Makefile.local b/emacs/Makefile.local index 1109cfa..4c06c52 100644 --- a/emacs/Makefile.local +++ b/emacs/Makefile.local @@ -20,6 +20,7 @@ emacs_sources := \ $(dir)/notmuch-print.el \ $(dir)/notmuch-version.el \ $(dir)/notmuch-jump.el \ + $(dir)/notmuch-company.el $(dir)/notmuch-version.el: $(dir)/Makefile.local version.stamp $(dir)/notmuch-version.el: $(srcdir)/$(dir)/notmuch-version.el.tmpl diff --git a/emacs/notmuch-company.el b/emacs/notmuch-company.el new file mode 100644 index 0000000..03c492f --- /dev/null +++ b/emacs/notmuch-company.el @@ -0,0 +1,73 @@ +;; notmuch-company.el --- Mail address completion for notmuch via company-mode -*- lexical-binding: t -*- + + +;; Authors: Trevor Jim +;; Michal Sojka +;; +;; Keywords: mail, completion + +;; This program 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. + +;; This program 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 this program. If not, see . + +;;; Commentary: + +;; To enable this, install company mode (https://company-mode.github.io/) +;; and customize notmuch-message-use-company +;; +;; NB company-minimum-prefix-length defaults to 3 so you don't get +;; completion unless you type 3 characters + +;;; Code: + +(require 'notmuch-address) +(require 'cl-lib) + +(defvar-local notmuch-company-last-prefix nil) +(declare-function company-begin-backend "company") +(declare-function company-grab "company") + +;;;###autoload +(defun notmuch-company (command &optional arg &rest _ignore) + "`company-mode' completion back-end for `notmuch'." + (interactive (list 'interactive)) + (require 'company) + (let ((case-fold-search t) + (completion-ignore-case t)) + (cl-case command + (interactive (company-begin-backend 'notmuch-company)) + (prefix (and (derived-mode-p 'message-mode) + (looking-back "^\\(To\\|Cc\\|Bcc\\):.*" + (line-beginning-position)) + (setq notmuch-company-last-prefix (company-grab "[:,][ \t]*\\(.*\\)" 1 (point-at-bol))))) + (candidates (cond + (notmuch-address-full-harvest-finished + ;; Update harvested addressed from time to time + (notmuch-address-harvest-trigger) + (notmuch-address-matching arg)) + (t + (cons :async + (lambda (callback) + ;; First run quick asynchronous harvest based on what the user entered so far + (notmuch-address-harvest + (format "to:%s*" arg) nil + (lambda (_proc _event) + (funcall callback (notmuch-address-matching arg)) + ;; Then (re)start potentially long-running full asynchronous harvesting + (notmuch-address-harvest-trigger)))))))) + (match (if (string-match notmuch-company-last-prefix arg) + (match-end 0) + 0)) + (no-cache t)))) + + +(provide 'notmuch-company) diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el index 6cc9656..c90381d 100644 --- a/emacs/notmuch-mua.el +++ b/emacs/notmuch-mua.el @@ -25,6 +25,7 @@ (require 'notmuch-lib) (require 'notmuch-address) +(require 'notmuch-company) (eval-when-compile (require 'cl)) @@ -268,12 +269,22 @@ Note that these functions use `mail-citation-hook' if that is non-nil." (message-goto-body) (set-buffer-modified-p nil)) +(defcustom notmuch-message-use-company t + "If available, use company mode for completion in notmuch-message-mode" + :type 'boolean + :group 'notmuch-send) + (define-derived-mode notmuch-message-mode message-mode "Message[Notmuch]" "Notmuch message composition mode. Mostly like `message-mode'" (when notmuch-address-command (unless (memq notmuch-address-message-alist-member message-completion-alist) (setq message-completion-alist - (push notmuch-address-message-alist-member message-completion-alist))))) + (push notmuch-address-message-alist-member message-completion-alist)))) + (when (and notmuch-message-use-company + (require 'company nil t)) + (company-mode) + (make-local-variable 'company-backends) + (setq company-backends '(notmuch-company)))) (define-key notmuch-message-mode-map (kbd "C-c C-c") #'notmuch-mua-send-and-exit) (define-key notmuch-message-mode-map (kbd "C-c C-s") #'notmuch-mua-send) -- 2.6.1