From: Michal Sojka Date: Mon, 26 Oct 2015 23:22:49 +0000 (+0100) Subject: [PATCH v8 3/3] Emacs: Add address completion based on company-mode X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=36b18d7bdbebd3f0bd0cc2bd825d94bf53a1d953;p=notmuch-archives.git [PATCH v8 3/3] Emacs: Add address completion based on company-mode --- diff --git a/29/6027c3dac6ebeec4065e6983672acff02b490e b/29/6027c3dac6ebeec4065e6983672acff02b490e new file mode 100644 index 000000000..b92e9013d --- /dev/null +++ b/29/6027c3dac6ebeec4065e6983672acff02b490e @@ -0,0 +1,221 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id 230546DE17D7 + for ; Mon, 26 Oct 2015 16:30:12 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: -0.612 +X-Spam-Level: +X-Spam-Status: No, score=-0.612 tagged_above=-999 required=5 tests=[AWL=2.238, + RCVD_IN_DNSWL_MED=-2.3, RP_MATCHES_RCVD=-0.55] 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 K91wbfQuo-P7 for ; + Mon, 26 Oct 2015 16:30:09 -0700 (PDT) +X-Greylist: delayed 421 seconds by postgrey-1.35 at arlo; + Mon, 26 Oct 2015 16:30:08 PDT +Received: from max.feld.cvut.cz (max.feld.cvut.cz [147.32.192.36]) + by arlo.cworth.org (Postfix) with ESMTP id C2C356DE0B4B + for ; Mon, 26 Oct 2015 16:30:08 -0700 (PDT) +Received: from localhost (unknown [192.168.200.7]) + by max.feld.cvut.cz (Postfix) with ESMTP id 5DAFF19F499E; + Tue, 27 Oct 2015 00:23:05 +0100 (CET) +X-Virus-Scanned: IMAP STYX AMAVIS +Received: from max.feld.cvut.cz ([192.168.200.1]) + by localhost (styx.feld.cvut.cz [192.168.200.7]) (amavisd-new, port 10044) + with ESMTP id HeYVG38Z3t1B; Tue, 27 Oct 2015 00:23:03 +0100 (CET) +Received: from imap.feld.cvut.cz (imap.feld.cvut.cz [147.32.192.34]) + by max.feld.cvut.cz (Postfix) with ESMTP id AFE6019F49C3; + Tue, 27 Oct 2015 00:23:02 +0100 (CET) +Received: from wsh by steelpick.2x.cz with local (Exim 4.86) + (envelope-from ) + id 1Zqr6S-0007al-LC; Tue, 27 Oct 2015 00:23:00 +0100 +From: Michal Sojka +To: notmuch@notmuchmail.org +Subject: [PATCH v8 3/3] Emacs: Add address completion based on company-mode +Date: Tue, 27 Oct 2015 00:22:49 +0100 +Message-Id: <1445901769-29134-4-git-send-email-sojkam1@fel.cvut.cz> +X-Mailer: git-send-email 2.5.3 +In-Reply-To: <1445901769-29134-1-git-send-email-sojkam1@fel.cvut.cz> +References: <1445901769-29134-1-git-send-email-sojkam1@fel.cvut.cz> +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: Mon, 26 Oct 2015 23:30:12 -0000 + +When company-mode is available (Emacs >= 24), address completion +candidates are shown in a nice popup box. This is triggered either by +pressing TAB or by waiting a while during typing an address. 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. + +[Improved by David Bremner] +--- + emacs/Makefile.local | 1 + + emacs/notmuch-address.el | 18 ++++++++-- + emacs/notmuch-company.el | 86 ++++++++++++++++++++++++++++++++++++++++++++++++ + 3 files changed, 103 insertions(+), 2 deletions(-) + 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-address.el b/emacs/notmuch-address.el +index 498ef8a..49e2402 100644 +--- a/emacs/notmuch-address.el ++++ b/emacs/notmuch-address.el +@@ -22,7 +22,9 @@ + (require 'message) + (require 'notmuch-parser) + (require 'notmuch-lib) ++(require 'notmuch-company) + ;; ++(declare-function company-manual-begin "company") + + (defcustom notmuch-address-command 'internal + "The command which generates possible addresses. It must take a +@@ -72,9 +74,21 @@ finished") + (defun notmuch-address-message-insinuate () + (message "calling notmuch-address-message-insinuate is no longer needed")) + ++(defcustom notmuch-address-use-company t ++ "If available, use company mode for address completion" ++ :type 'boolean ++ :group 'notmuch-send) ++ + (defun notmuch-address-setup () +- (let ((pair (cons notmuch-address-completion-headers-regexp +- #'notmuch-address-expand-name))) ++ (let* ((use-company (and notmuch-address-use-company ++ (eq notmuch-address-command 'internal) ++ (require 'company nil t))) ++ (pair (cons notmuch-address-completion-headers-regexp ++ (if use-company ++ #'company-manual-begin ++ #'notmuch-address-expand-name)))) ++ (when use-company ++ (notmuch-company-setup)) + (unless (memq pair message-completion-alist) + (setq message-completion-alist + (push pair message-completion-alist))))) +diff --git a/emacs/notmuch-company.el b/emacs/notmuch-company.el +new file mode 100644 +index 0000000..add3161 +--- /dev/null ++++ b/emacs/notmuch-company.el +@@ -0,0 +1,86 @@ ++;; 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/) ++;; ++;; NB company-minimum-prefix-length defaults to 3 so you don't get ++;; completion unless you type 3 characters ++ ++;;; Code: ++ ++(eval-when-compile (require 'cl)) ++ ++(defvar notmuch-company-last-prefix nil) ++(make-variable-buffer-local 'notmuch-company-last-prefix) ++(declare-function company-begin-backend "company") ++(declare-function company-grab "company") ++(declare-function company-mode "company") ++(declare-function company-manual-begin "company") ++(defvar company-backends) ++ ++(declare-function notmuch-address-harvest "notmuch-address") ++(declare-function notmuch-address-harvest-trigger "notmuch-address") ++(declare-function notmuch-address-matching "notmuch-address") ++(defvar notmuch-address-full-harvest-finished) ++(defvar notmuch-address-completion-headers-regexp) ++ ++;;;###autoload ++(defun notmuch-company-setup () ++ (company-mode) ++ (make-local-variable 'company-backends) ++ (setq company-backends '(notmuch-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)) ++ (case command ++ (interactive (company-begin-backend 'notmuch-company)) ++ (prefix (and (derived-mode-p 'message-mode) ++ (looking-back (concat notmuch-address-completion-headers-regexp ".*") ++ (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 start the (potentially long-running) full asynchronous harvest if necessary ++ (notmuch-address-harvest-trigger)))))))) ++ (match (if (string-match notmuch-company-last-prefix arg) ++ (match-end 0) ++ 0)) ++ (no-cache t)))) ++ ++ ++(provide 'notmuch-company) +-- +2.5.3 +