From: Spyros Roum <spyros.roum@posteo.net>
To: visuweshm@gmail.com
Cc: philipk@posteo.net, juri@linkov.net, emacs-devel@gnu.org
Subject: Re: Add completion to compilation-read-command
Date: Thu, 26 Dec 2024 14:46:03 +0000 [thread overview]
Message-ID: <0a433f95-62cb-4941-a1fb-0a5266a3c9b2@posteo.net> (raw)
In-Reply-To: <87ldw2d1m2.fsf@gmail.com>
[-- Attachment #1.1: Type: text/plain, Size: 3310 bytes --]
Visuwesh wrote:
> [வியாழன் டிசம்பர் 26, 2024] Spyros Roum wrote:
>
> I don't really have much to say about the change but:
>
>> [...]
>> I based the entry on a similar entry from a few lines up:
>>
>> > *** New user option 'completion-pcm-leading-wildcard'.
>> > This option configures how the partial-completion style does
>> completion.
>> > It defaults to nil, which preserves the existing behavior. When it
>> is set
>> > to t, the partial-completion style behaves more like the substring
>> > style, in that a string being completed can match against a candidate
>> > anywhere in the candidate string.
>>
>> If you think however that the options are not necessary, I can keep
>> the first sentence only.
>>
>> Patch attached has the corrected `:version` and ChangeLog, no other
>> changes (also rebased to master).
>> From fa17714fcb12079bc37e5be54fe6b2a68bcd34ff Mon Sep 17 00:00:00 2001
>> From: Spyros Roum<spyros.roum@posteo.net>
>> Date: Wed, 25 Dec 2024 17:32:31 +0200
>> Subject: [PATCH] Add option for making compilation-read-command use
>> completing-read
>> [...]
>> diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
>> index 6784a12fd63..d0da96069af 100644
>> --- a/lisp/progmodes/compile.el
>> +++ b/lisp/progmodes/compile.el
>> @@ -1797,12 +1797,38 @@ 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-with-history-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
>> + "`compilation-read-command' uses this function to get user's input.
>> +Defaults to `compilation-prompt-read-shell-command',
>> +but 'compilation-prompt-read-with-history-completion' can be used instead for
>> +a completing version based on past runs."
>> + :version "31.1"
>> + :type 'function
>> + :options
>> + (list
>> + #'compilation-prompt-read-shell-command
>> + #'compilation-prompt-read-with-history-completion))
> It would be nice to say what these options mean in plain English (with
> :tag IIRC).
I like this suggestion, and it made me realize that even though I use
`:options`, there is no actual list of
options in the customization interface, which seems weird.
This is what I ended up with after looking at other `defcustom`s.
Itworks as expected, showing a values menu and using the `:tag`s for
descriptions.
However, I do not know what the technical differences are between this
and the previous versions and if one is more correct than the other. I
am inclined to keep this though since it provides the Values Menu, which
is nice.
[-- Attachment #1.2: Type: text/html, Size: 3918 bytes --]
[-- Attachment #2: 0001-Add-option-for-making-compilation-read-command-use-c.patch --]
[-- Type: text/x-patch, Size: 3467 bytes --]
From f2145d9acf36d3c8ab0c38b8fa8eeb72c1806f85 Mon Sep 17 00:00:00 2001
From: Spyros Roum <spyros.roum@posteo.net>
Date: Thu, 26 Dec 2024 16:42:56 +0200
Subject: [PATCH] Add option for making compilation-read-command use
completing-read
* etc/NEWS: Add to NEWS
* lisp/progmodes/compile.el (compilation-read-command):
Call function based on `compilation-read-command-function`.
(compilation-prompt-read-shell-command): The existing
functionality from compilation-read-command extracted to
a function.
(compilation-prompt-read-with-history-completion): A
function that uses completing-read to read the command.
(compilation-read-command-function): The new option that
controlls which function is used.
---
etc/NEWS | 8 ++++++++
lisp/progmodes/compile.el | 31 ++++++++++++++++++++++++++++++-
2 files changed, 38 insertions(+), 1 deletion(-)
diff --git a/etc/NEWS b/etc/NEWS
index 8adead78a32..a9862ccf3ff 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -147,6 +147,14 @@ will still be on that candidate after "*Completions*" is updated with a
new list of completions. The candidate is automatically deselected when
the "*Completions*" buffer is hidden.
+---
+*** New user option 'compilation-read-command-function'.
+This option controls what function is used to read user input for
+'compilation-read-command'.
+It defaults to 'compilation-prompt-read-shell-command', which preserves
+existing behavior. When set to 'compilation-prompt-read-with-history-completion',
+'completing-read' is used allowing autocomplete based on past runs of 'compile'.
+
** Windows
+++
diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index 6784a12fd63..7638e5b4df1 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -1797,12 +1797,41 @@ 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-with-history-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
+ "`compilation-read-command' uses this function to get user's input.
+Defaults to `compilation-prompt-read-shell-command',
+but `compilation-prompt-read-with-history-completion' can be used instead for
+a completing version based on past runs."
+ :version "31.1"
+ :type
+ '(choice
+ (function :tag
+ "Read command using read-shell-command"
+ compilation-prompt-read-shell-command)
+ (function :tag
+ "Read command using completing-read, completing on compile-history"
+ compilation-prompt-read-with-history-completion)))
+
+(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))
+
\f
;;;###autoload
(defun compile (command &optional comint)
--
2.47.1
next prev parent reply other threads:[~2024-12-26 14:46 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-24 8:53 Add completion to compilation-read-command Spyros Roum
2024-12-24 11:35 ` Philip Kaludercic
2024-12-24 11:57 ` Spyros Roum
2024-12-24 12:53 ` Philip Kaludercic
2024-12-24 13:43 ` Spyros Roum
2024-12-24 14:53 ` Philip Kaludercic
2024-12-24 17:03 ` Juri Linkov
2024-12-24 18:36 ` Spyros Roum
2024-12-24 18:50 ` Juri Linkov
2024-12-24 18:59 ` Spyros Roum
2024-12-24 22:35 ` Philip Kaludercic
2024-12-25 7:27 ` Juri Linkov
2024-12-24 19:56 ` [External] : " Drew Adams
2024-12-25 7:29 ` Juri Linkov
2024-12-25 19:46 ` Drew Adams
2024-12-24 22:44 ` Philip Kaludercic
2024-12-25 8:26 ` Spyros Roum
2024-12-25 11:33 ` Philip Kaludercic
2024-12-25 15:44 ` Spyros Roum
2024-12-25 16:38 ` Philip Kaludercic
2024-12-25 22:11 ` Spyros Roum
2024-12-26 11:39 ` Philip Kaludercic
2024-12-26 13:13 ` Spyros Roum
2024-12-26 13:18 ` Visuwesh
2024-12-26 14:46 ` Spyros Roum [this message]
2024-12-26 15:04 ` Visuwesh
2024-12-26 16:00 ` Spyros Roum
2024-12-25 17:32 ` Juri Linkov
2024-12-25 18:02 ` Spyros Roum
2024-12-25 19:36 ` [External] : " Drew Adams
2024-12-24 19:27 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0a433f95-62cb-4941-a1fb-0a5266a3c9b2@posteo.net \
--to=spyros.roum@posteo.net \
--cc=emacs-devel@gnu.org \
--cc=juri@linkov.net \
--cc=philipk@posteo.net \
--cc=visuweshm@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.