From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel Subject: Re: on helm substantial differences Date: Tue, 17 Nov 2020 22:32:51 +0200 Organization: LINKOV.NET Message-ID: <87lfezd8r0.fsf@mail.linkov.net> References: <87wnymda5g.fsf@mail.linkov.net> <87ima5he8j.fsf@mail.linkov.net> <87mtzfzt9a.fsf@mail.linkov.net> 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="6729"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) Cc: spacibba@aol.com, Jean Louis , andreyk.mad@gmail.com, emacs-devel@gnu.org, rudalics@gmx.at, Gregory Heytings , Eli Zaretskii , Drew Adams To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Nov 17 21:41:20 2020 Return-path: Envelope-to: ged-emacs-devel@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 1kf7my-0001d1-2d for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Nov 2020 21:41:20 +0100 Original-Received: from localhost ([::1]:41110 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kf7mx-00017t-1I for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Nov 2020 15:41:19 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52644) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kf7mP-0000g6-Rg for emacs-devel@gnu.org; Tue, 17 Nov 2020 15:40:45 -0500 Original-Received: from relay11.mail.gandi.net ([217.70.178.231]:38317) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kf7mN-0005LY-8P; Tue, 17 Nov 2020 15:40:45 -0500 Original-Received: from mail.gandi.net (m91-129-97-46.cust.tele2.ee [91.129.97.46]) (Authenticated sender: juri@linkov.net) by relay11.mail.gandi.net (Postfix) with ESMTPSA id 3B168100003; Tue, 17 Nov 2020 20:40:34 +0000 (UTC) In-Reply-To: <87mtzfzt9a.fsf@mail.linkov.net> (Juri Linkov's message of "Tue, 17 Nov 2020 21:18:57 +0200") Received-SPF: pass client-ip=217.70.178.231; envelope-from=juri@linkov.net; helo=relay11.mail.gandi.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/17 15:40:39 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:259312 Archived-At: --=-=-= Content-Type: text/plain >> Before knowing what's the best approach, I think we should clearly >> decide what would be the "ideal" new API. E.g. should it return "any >> string" and then it'd be up to the infrastructure code to store >> side-info about what is the corresponding candidate's actual text? > > After trying different variants, it turned out that the most convenient > is to use annotation-function that can contain a placeholder for the > completion candidate. Currently "%s" is used as a placeholder, > for example, "prefix %s suffix" but it can be any string. Actually, I discovered that unfortunately annotation-function is unsuitable for formatting data in a columnar format. It needs to receive a complete list of completions to be able to adjust their widths for more optimal overall columnar layout. So a new function is needed that is like annotation-function but accepts a list of all completions. There is an existing similar function 'display-sort-function' that could be abused to add prefix/suffix annotations, but maybe a separate function would be preferable for cleaner API? --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=display-function.patch diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index e18c5c1372..c671750e9a 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -117,6 +117,9 @@ completion-metadata - `annotation-function': function to add annotations in *Completions*. Takes one argument (STRING), which is a possible completion and returns a string to append to STRING. +- `display-function': function to display entries in *Completions*. + Takes one argument (COMPLETIONS) and should return a list + of completions with a placeholder that separates prefix/suffix. - `display-sort-function': function to sort entries in *Completions*. Takes one argument (COMPLETIONS) and should return a new list of completions. Can operate destructively. @@ -1885,6 +1888,9 @@ completion-extra-properties completion). The function can access the completion data via `minibuffer-completion-table' and related variables. +`:display-function': Function to display completions. + The function must accept one argument, a list of completions. + `:exit-function': Function to run after completion is performed. The function must accept two arguments, STRING and STATUS. @@ -1971,6 +1977,9 @@ minibuffer-completion-help (plist-get completion-extra-properties :annotation-function) completion-annotate-function)) + (dfun (or (completion-metadata-get all-md 'display-function) + (plist-get completion-extra-properties + :display-function))) (mainbuf (current-buffer)) ;; If the *Completions* buffer is shown in a new ;; window, mark it as softly-dedicated, so bury-buffer in @@ -2017,6 +2026,9 @@ minibuffer-completion-help (let ((ann (funcall afun s))) (if ann (list s ann) s))) completions))) + (when dfun + (setq completions + (funcall dfun completions))) (with-current-buffer standard-output (set (make-local-variable 'completion-base-position) --=-=-=--