From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#67479: [PATCH] Facilitate using Completion Preview with the mouse Date: Mon, 27 Nov 2023 08:41:56 +0100 Message-ID: Reply-To: Eshel Yaron Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="6828"; mail-complaints-to="usenet@ciao.gmane.io" To: 67479@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Nov 27 08:43:21 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1r7WH3-0001cW-2S for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 27 Nov 2023 08:43:21 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r7WGh-0006d2-7c; Mon, 27 Nov 2023 02:42:59 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r7WGe-0006cc-TY for bug-gnu-emacs@gnu.org; Mon, 27 Nov 2023 02:42:56 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r7WGe-0004n0-Kz for bug-gnu-emacs@gnu.org; Mon, 27 Nov 2023 02:42:56 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r7WGk-00048z-O0 for bug-gnu-emacs@gnu.org; Mon, 27 Nov 2023 02:43:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eshel Yaron Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 27 Nov 2023 07:43:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 67479 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.170107093915851 (code B ref -1); Mon, 27 Nov 2023 07:43:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 27 Nov 2023 07:42:19 +0000 Original-Received: from localhost ([127.0.0.1]:43164 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r7WG2-00047b-El for submit@debbugs.gnu.org; Mon, 27 Nov 2023 02:42:19 -0500 Original-Received: from lists.gnu.org ([2001:470:142::17]:35560) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r7WFy-00047G-SQ for submit@debbugs.gnu.org; Mon, 27 Nov 2023 02:42:16 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r7WFm-0006ay-Ef for bug-gnu-emacs@gnu.org; Mon, 27 Nov 2023 02:42:02 -0500 Original-Received: from mail.eshelyaron.com ([107.175.124.16] helo=eshelyaron.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r7WFk-0004gq-Jn for bug-gnu-emacs@gnu.org; Mon, 27 Nov 2023 02:42:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=eshelyaron.com; s=mail; t=1701070918; bh=QOdYpr6x9KZKuOnwA8dsE79WHnJR1siccJKmq8hf5BY=; h=From:To:Subject:Date:From; b=ZyEtdRqTez6K7dqSewqvNwjTAxG3Od5xQUW/PcTFY5wd21oegIez8nJUo3+JeiRCG cgGZ2Jtdm/aaTG585w/ssbvappiHA7sA8Mf/xeQwBqj0EDCI1MOB7ZqcsOuw2x8BIY S2x3ejvDSDb6vzWbYFUYePQCKhcQXHgCE2ud/AfbkHgK7iXq2qBfCE5bXWw/lSJSGu mwY1UyUHul9bodQdZKNe42gEgmKgtdJH4EHenvNHyDwmGUtSrpV3T9asWsfwME+DVM lcKmW9v6LOhBfPz60s7InMrrsTB9q70kZJFGeJXSa1KC7PBlGjo65NKAYrN0VdbAnj BSuyp/K/sUSYQ== X-Hashcash: 1:20:231127:bug-gnu-emacs@gnu.org::K+qdTGX1lZPDQ7MN:0S8f Received-SPF: pass client-ip=107.175.124.16; envelope-from=me@eshelyaron.com; helo=eshelyaron.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:275106 Archived-At: --=-=-= Content-Type: text/plain Tags: patch This patch makes Completion Preview mode more convenient, and useful, when you're working with one hand on a mouse or similar device. Thanks, Eshel --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-Facilitate-using-Completion-Preview-with-the-mouse.patch >From 2a1f17d183d1b72faf6a37a272c18a5766189006 Mon Sep 17 00:00:00 2001 From: Eshel Yaron Date: Sun, 26 Nov 2023 17:00:32 +0100 Subject: [PATCH] Facilitate using Completion Preview with the mouse Allow users to accept the completion suggestion by clicking on it, and to cycle between completion suggestions by scrolling (with a mouse wheel or a trackpad) over the preview. Also display a message by default when cycling to inform the user about the index of the current suggestion out of the available total. * lisp/completion-preview.el (completion-preview-highlight): New face. (completion-preview-message-format): New user option. (completion-preview--mouse-map): New keymap. (completion-preview--try-table, completion-preview--show) (completion-preview-next-candidate): Apply 'keymap' and 'mouse-face' properties to completion preview string. (completion-preview--internal-commands): Add 'mwheel-scroll'. This prevents incidental scrolls outside of the preview from dismissing the preview when you actually want to cycle it. (completion-preview--active-p): New function. Use it as a 'completion-predicate' symbol property for commands that should only be used when the preview is shown to otherwise exclude these commands from M-x completion candidates. --- lisp/completion-preview.el | 66 ++++++++++++++++++++++++++++++++++---- 1 file changed, 60 insertions(+), 6 deletions(-) diff --git a/lisp/completion-preview.el b/lisp/completion-preview.el index 039a330bc84..1d5f1253702 100644 --- a/lisp/completion-preview.el +++ b/lisp/completion-preview.el @@ -83,6 +83,22 @@ completion-preview-minimum-symbol-length :type 'natnum :version "30.1") +(defcustom completion-preview-message-format + "Completion suggestion %i out of %n" + "Message to show after cycling the completion preview suggestion. + +If the value is a string, `completion-preview-next-candidate' and +`completion-preview-prev-candidate' display this string in the +echo area, after substituting \"%i\" with the 1-based index of +the completion suggestion that the preview is showing, and \"%n\" +with the total number of available completion suggestions for the +text around point. + +If this option is nil, these commands do not display any message." + :type '(choice (string :tag "Message format") + (const :tag "No message" nil)) + :version "30.1") + (defvar completion-preview-sort-function #'minibuffer--sort-by-length-alpha "Sort function to use for choosing a completion candidate to preview.") @@ -100,6 +116,11 @@ completion-preview-exact "Face for exact completion preview overlay." :version "30.1") +(defface completion-preview-highlight + '((t :inherit highlight)) + "Face for highlighting the completion preview when the mouse is over it." + :version "30.1") + (defvar-keymap completion-preview-active-mode-map :doc "Keymap for Completion Preview Active mode." "C-i" #'completion-preview-insert @@ -107,11 +128,26 @@ completion-preview-active-mode-map ;; "M-p" #'completion-preview-prev-candidate ) +(defvar-keymap completion-preview--mouse-map + :doc "Keymap for mouse clicks on the completion preview." + "" #'completion-preview-insert + "C-" #'completion-at-point + "" #'completion-at-point + (format "<%s>" mouse-wheel-up-event) #'completion-preview-prev-candidate + (format "<%s>" mouse-wheel-up-alternate-event) #'completion-preview-prev-candidate + (format "<%s>" mouse-wheel-down-event) #'completion-preview-next-candidate + (format "<%s>" mouse-wheel-down-alternate-event) #'completion-preview-next-candidate) + (defvar-local completion-preview--overlay nil) (defvar completion-preview--internal-commands - '(completion-preview-next-candidate completion-preview-prev-candidate) - "List of commands that manipulate the completion preview.") + '(completion-preview-next-candidate + completion-preview-prev-candidate + ;; Don't dismiss or update the preview when the user scrolls. + mwheel-scroll) + "List of commands that manipulate the completion preview. + +Completion Preview mode avoids updating the preview after these commands.") (defsubst completion-preview--internal-command-p () "Return non-nil if `this-command' manipulates the completion preview." @@ -194,7 +230,9 @@ completion-preview--try-table (list (propertize (substring (car sorted) (length prefix)) 'face (if (cdr sorted) 'completion-preview - 'completion-preview-exact)) + 'completion-preview-exact) + 'mouse-face 'completion-preview-highlight + 'keymap completion-preview--mouse-map) (+ beg base) end sorted (substring string 0 base) exit-fn)))))) @@ -255,7 +293,9 @@ completion-preview--show ;; The previous preview is still applicable, update it. (overlay-put (completion-preview--make-overlay cur (propertize (substring cand (- cur beg)) - 'face face)) + 'face face + 'mouse-face 'completion-preview-highlight + 'keymap completion-preview--mouse-map)) 'completion-preview-end cur) ;; The previous preview is no longer applicable, hide it. (completion-preview-active-mode -1)))) @@ -318,10 +358,24 @@ completion-preview-next-candidate (let ((aft (propertize (substring str (- pos beg)) 'face (if (< 1 len) 'completion-preview - 'completion-preview-exact)))) + 'completion-preview-exact) + 'mouse-face 'completion-preview-highlight + 'keymap completion-preview--mouse-map))) (add-text-properties 0 1 '(cursor 1) aft) (overlay-put completion-preview--overlay 'completion-preview-index new) - (overlay-put completion-preview--overlay 'after-string aft))))) + (overlay-put completion-preview--overlay 'after-string aft)) + (when completion-preview-message-format + (message (format-spec completion-preview-message-format + `((?i . ,(1+ new)) (?n . ,len)))))))) + +(defun completion-preview--active-p (_symbol buffer) + "Check if the completion preview is currently shown in BUFFER." + (buffer-local-value 'completion-preview-active-mode buffer)) + +(dolist (cmd '(completion-preview-insert + completion-preview-prev-candidate + completion-preview-next-candidate)) + (put cmd 'completion-predicate #'completion-preview--active-p)) ;;;###autoload (define-minor-mode completion-preview-mode -- 2.42.0 --=-=-=--