From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Add completion to compilation-read-command Date: Wed, 25 Dec 2024 16:38:26 +0000 Message-ID: <87ldw390ql.fsf@posteo.net> References: <87ttatb9g0.fsf@posteo.net> <87a5clm3p5.fsf@mail.linkov.net> <8734icaegs.fsf@posteo.net> <9a4bb215-561c-468f-97de-7d84fe7adc43@posteo.net> <87ttas80au.fsf@posteo.net> <962064f8-fab7-4867-af04-135e48a9dd15@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7274"; mail-complaints-to="usenet@ciao.gmane.io" Cc: juri@linkov.net, emacs-devel@gnu.org To: Spyros Roum Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Dec 25 17:39:21 2024 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 1tQUPo-0001mJ-SM for ged-emacs-devel@m.gmane-mx.org; Wed, 25 Dec 2024 17:39:21 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tQUPA-0008RS-CZ; Wed, 25 Dec 2024 11:38:40 -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 1tQUP7-0008Qn-MU for emacs-devel@gnu.org; Wed, 25 Dec 2024 11:38:38 -0500 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tQUP2-0005ei-VK for emacs-devel@gnu.org; Wed, 25 Dec 2024 11:38:36 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 64702240027 for ; Wed, 25 Dec 2024 17:38:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1735144707; bh=SNuE4+GAMzJuDxhME4NXz9Rl7O29vGFGbXLJ/xPkQU4=; h=From:To:Cc:Subject:Autocrypt:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=U+V9enH6GyR51w4ZuMO6f6puuZD/Ln4kTrk53jWITtFmtogdWStQcl01pgNWF405/ u9VHxnUR0UZvfzIiZwqFwgZjjS4VpgB2srjC29Y+rhS/45i1zuRyw8zk3po5CSiSMd yfIqf0VgQniPqACy9KXheYmIxwzK28I1Alr8G/qNqOmn3wrr6TWG3ZBgmPIfp8D1Zn BvRYDnotlPqnz3rLDcFtYPkNaOxPG/xxhS9poxdYm0xXbsmilzAT+Xti9or0GOL1R3 CooecqAz6eBkhIYlIMN/mPJM0EDhnt82USkcHiSpqstJuRX1VAjQe4loMKxnNwR9rH 5hLE6wdDFbSmw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4YJHWQ5hNCz9rxD; Wed, 25 Dec 2024 17:38:26 +0100 (CET) In-Reply-To: <962064f8-fab7-4867-af04-135e48a9dd15@posteo.net> (Spyros Roum's message of "Wed, 25 Dec 2024 15:44:42 +0000") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM OpenPGP: id=philipk@posteo.net; url="https://keys.openpgp.org/vks/v1/by-email/philipk@posteo.net"; preference=signencrypt Received-SPF: pass client-ip=185.67.36.65; envelope-from=philipk@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=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.29 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-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:327110 Archived-At: Spyros Roum writes: > Philip Kaludercic wrote: >>> To make sure I understand correctly, when using `completing-read` to >>> read user input, that is narrowing, >>> while the `C-x ` and *Completions* buffer is completion. >> No, `completing-read' just invokes an interface, that frontends can >> implement a UI for. The default UI provides a completing/expanding >> interface, while Vertico, Helm, Ivy, etc. do selecting/narrowing. When >> using `completing-read' you cannot really assume one or the other, so in >> effect one has to find a middle ground. It is best you try your code in >> emacs -Q without any changes and see how it behaves. Things like SPC >> doing something else than you would expect is just one pitfall, others >> I can recall are providing text that is difficult to input (I wrote a >> package a few years back called "insert-kaomoji" that used >> `completing-read' to prompt the user eastern-style emoticons; it is easy >> to use with a selecting framework, but more inconvenient if the user is >> first made to complete a string that is difficult to write, as most of >> the characters are not easy to type). > > I tried the attached patch with `emacs -q` and now I understand how > this would be very annoying without something like vertico installed > haha. Nevertheless, it seems to work! Of course it will work, after all it is just text (input) with some convenient bindings for easy completion. Even if SPC is bound to something else, you can always use C-q SPC. > I'm attaching a patch based on the conversation so far to get feedback on. > > I believe I should also write something to the NEWS file. Right, you can always check the CONTRIBUTE file in the emacs.git root. > Also, I'm wondering if this counts as non-trivial enough that I would > need to sign the FSF copyright. It looks like it to me, and either way it is not bad to do that so that you have it behind you for future contributions either to Emacs or ELPA. > Regarding testing, as far as I can tell, there are currently no tests > for `compilation-read-command`. > Should I add anything? If yes, I'll probably need someone to point to > existing tests for similar things that I can copy from. You could take a look at test/lisp/progmodes/compile-tests.el, but I don't think this breaks the patch, especially when dealing with something as interactive as what you are proposing. > > Am I forgetting anything else? > From e1068206662913978d541f924205a0615f8d2d95 Mon Sep 17 00:00:00 2001 > From: Spyros Roum > Date: Wed, 25 Dec 2024 17:32:31 +0200 > Subject: [PATCH] Add option for making compilation-read-command use > completing-read A ChageLog style commit message would be expected here as well. You can inject the structure in vc-mode using C-c C-w. > > --- > lisp/progmodes/compile.el | 24 +++++++++++++++++++++++- > 1 file changed, 23 insertions(+), 1 deletion(-) > > diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el > index 6784a12fd63..a318937e96d 100644 > --- a/lisp/progmodes/compile.el > +++ b/lisp/progmodes/compile.el > @@ -1797,12 +1797,34 @@ compilation-mode-font-lock-keywords > '((compilation--ensure-parse)) > compilation-mode-font-lock-keywords)) > > -(defun compilation-read-command (command) > +(defun compilation-prompt-read-shell-command (command) > (read-shell-command "Compile command: " command > (if (equal (car compile-history) command) > '(compile-history . 1) > 'compile-history))) > > +(defun compilation-prompt-read-command-with-completion (command) > + (completing-read "Compile command: " compile-history > + nil nil command > + (if (equal (car compile-history) command) > + '(compile-history . 1) > + 'compile-history))) > + > +(defcustom compilation-read-command-function > + 'compilation-prompt-read-shell-command Please sharp-quote (#'). > + "Function used by `compilation-read-command' to get user's input. > +Defaults to `compilation-prompt-read-shell-command', > +but `compilation-prompt-read-command-with-completion' can be used instead for If possible, avoid the passive phrase here. > +a completing version based on past runs." > + :version "31.0" > + :type 'function > + :options '(compilation-prompt-read-command-with-completion)) It would also be good to add the default value here. I prefer using (list ...) and sharp-quoting all the function names, so that the byte-compiler verifies that these are all known. > + > +(defun compilation-read-command (command) > + "Prompt user for command to run. > +`compilation-read-command-function' controls the way input is read from the minibuffer." > + (funcall compilation-read-command-function command)) > + > > ;;;###autoload > (defun compile (command &optional comint)