[PATCH 3/3] Emacs: Add address completion based on company-mode
authorDavid Bremner <david@tethera.net>
Sat, 24 Oct 2015 17:41:24 +0000 (14:41 +2100)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 21:49:54 +0000 (14:49 -0700)
d7/ee5dd11497808f91d8d9f5e06386811853cf81 [new file with mode: 0644]

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