From: Juri Linkov <juri@linkov.net>
To: Dmitry Gutov <dmitry@gutov.dev>
Cc: Spencer Baugh <sbaugh@janestreet.com>,
63648@debbugs.gnu.org, sbaugh@catern.com
Subject: bug#63648: 29.0.90; project.el: with switch-use-entire-map, switch-project errors on non-project commands
Date: Thu, 21 Sep 2023 09:58:57 +0300 [thread overview]
Message-ID: <86msxgatuy.fsf@mail.linkov.net> (raw)
In-Reply-To: <6fc81cbf-a21f-c5b4-aa56-e8518b8570d7@gutov.dev> (Dmitry Gutov's message of "Thu, 21 Sep 2023 04:16:32 +0300")
[-- Attachment #1: Type: text/plain, Size: 4829 bytes --]
>>>>> E.g. would people who customized project-switch-commands to a symbol be
>>>>> okay with not being able to use the other functionality of
>>>>> other-project-prefix?
>>>> Symbolic project-switch-commands is supported by other-project-prefix.
>>>
>>> Yes, and that could be a problem: if I as a user want 'C-x p p' to always
>>> run 'project-find-file', for example (in the other project), but I also
>>> want to be able to sometimes call 'M-x other-project-prefix' (or use
>>> a custom binding) to run an arbitrary command in the other project.
>> With other-project-prefix, users can run 'project-find-file'
>> in another project with just:
>> ```
>> (defun other-project-find-file ()
>> (interactive)
>> (call-interactively 'other-project-prefix)
>> (call-interactively 'project-find-file))
>> ```
>
> Right... but they'd have to define a custom function for any such
> command. I think the idea behind 'other-project-prefix' is that one
> wouldn't have to.
Only one custom function. Or they can just bind the most used command
to the most easily typed key RET.
>>>>> Or what about the variable project-switch-use-entire-map? I'm not sure
>>>>> about dropping it, at least without notifying about that in the UI somehow.
>>>> project-switch-use-entire-map could be handled in other-project-prefix.
>>>> But is this really needed? I can't imagine why anyone might want
>>>> to disable keys from project-prefix-map.
>>>
>>> I think if project-switch-use-entire-map is still wanted, we should just
>>> keep these commands separate (the same logic as in the previous paragraph).
>> No problem, project-switch-use-entire-map can be easily supported in
>> other-project-prefix.
>
> I'm not saying it's hard to support it there. But it could make the command
> less useful.
When all global keybindings are available, it's strange to remove
keys from project-prefix-map. But ok, the patch below supports
project-switch-use-entire-map.
>>> Why not remove that option? Consider the current UI (which looks almost the
>>> same in your latest patch): user types 'C-x p p', chooses the project and
>>> then sees the prompt which only offers the options from
>>> project-switch-commands. They are not informed that any other keys could be
>>> used too. So if we were to change the default behavior, I think this
>>> UI/prompt needs to change, at the very least.
>> Agreed, a better prompt needed. Maybe with the standard C-h key for
>> help.
>
> Some short version initially, and perhaps a more expanded if the user hits
> 'C-h'.
I tried to use 'help-form' in a new patch, but actually 'C-h' is
quite useless when not using the ad-hoc loop as e.g. in y-or-n-p that
forces to type a limited set of keys.
>>>>> Finally, the current patch drops the loop, so if the user types the wrong
>>>>> key, they will need to repeat the command and choose the project again.
>>>> Indeed, the loop now is the command loop, and maybe it's possible to
>>>> write a hack to set a catch-all in set-transient-map that is not
>>>> finished until a key in the map is typed. But as with any command,
>>>> if the user types a wrong key sequence, then need to type it again.
>>>> I do this all the time with mistakenly typed keys. I don't see why
>>>> project keys are the exception.
>>>
>>> Maybe because in the middle of it all you have interacted with Emacs to
>>> choose the other project, and that can be a significant amount of typing?
>> Then for repeating the previously selected project it will be in the
>> history:
>> 'C-x p p M-p'.
>
> Fair point. Still, that's more typing and required one to remember/know
> about M-p.
If 'project-prompt-project-dir' remembered the selected directory
like 'project-current' does, then would be possible to repeat with:
'C-x p p M-n'.
>>>> A different key binding for the commands that do the same thing?
>>>> Only because the new command uses the command loop?
>>>
>>> project-switch-project would continue to show the menu with commands, only
>>> work with them by default, and obey project-switch-use-entire-map, which,
>>> when set to t, would enable other commands from the project keymap, but
>>> only them. All accessible via one character binding. And when
>>> project-switch-commands is set to a symbol, it would only invoke that one
>>> command without additional prompting.
>>>
>>> other-project-prefix would accept all commands but require full key
>>> sequence for the invoked command.
>> And also other-project-prefix will fix such bugs as bug#65558.
>>
>>> Would it add shortcuts to the commands from the project keymap?
>>> Possibly. Any ideas how to inform the user about that?
>> By a different prompt?
>
> Probably. Would you like to propose one? So that I have something to
> compare to, and have something specific to put to the vote as well.
Ok, something like this:
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: project-default-directory.patch --]
[-- Type: text/x-diff, Size: 9146 bytes --]
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 2e6ae89a443..6d5664c0e98 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -197,6 +197,14 @@ project-current-directory-override
"Value to use instead of `default-directory' when detecting the project.
When it is non-nil, `project-current' will always skip prompting too.")
+(defvar-local project-default-directory nil
+ "Value to use instead of `default-directory' when detecting the project.
+For the next command after switching the project, this buffer-local
+variable contains the original value of `default-directory'.
+Whereas the buffer-local `default-directory' is temporarily set
+to the root directory of the switched project.
+When it is non-nil, `project-current' will always skip prompting too.")
+
(defcustom project-prompter #'project-prompt-project-dir
"Function to call to prompt for a project.
Called with no arguments and should return a project root dir."
@@ -232,7 +240,8 @@ project-current
(let ((pr (project--find-in-directory directory)))
(cond
(pr)
- ((unless project-current-directory-override
+ ((unless (or project-current-directory-override
+ project-default-directory)
maybe-prompt)
(setq directory (funcall project-prompter)
pr (project--find-in-directory directory))))
@@ -397,8 +406,10 @@ project-buffers
(let ((root (expand-file-name (file-name-as-directory (project-root project))))
bufs)
(dolist (buf (buffer-list))
- (when (string-prefix-p root (expand-file-name
- (buffer-local-value 'default-directory buf)))
+ (when (string-prefix-p
+ root (expand-file-name
+ (or (buffer-local-value 'project-default-directory buf)
+ (buffer-local-value 'default-directory buf))))
(push buf bufs)))
(nreverse bufs)))
@@ -813,7 +824,9 @@ project-buffers
dd
bufs)
(dolist (buf (buffer-list))
- (setq dd (expand-file-name (buffer-local-value 'default-directory buf)))
+ (setq dd (expand-file-name
+ (or (buffer-local-value 'project-default-directory buf)
+ (buffer-local-value 'default-directory buf))))
(when (and (string-prefix-p root dd)
(not (cl-find-if (lambda (module) (string-prefix-p module dd))
modules)))
@@ -842,7 +855,9 @@ project-prefix-map
(define-key map "c" 'project-compile)
(define-key map "e" 'project-eshell)
(define-key map "k" 'project-kill-buffers)
- (define-key map "p" 'project-switch-project)
+ (define-key map "p" (if (< emacs-major-version 30)
+ 'project-switch-project
+ 'other-project-prefix))
(define-key map "g" 'project-find-regexp)
(define-key map "G" 'project-or-external-find-regexp)
(define-key map "r" 'project-query-replace-regexp)
@@ -889,10 +904,16 @@ project-other-window-command
\\{project-prefix-map}
\\{project-other-window-map}"
(interactive)
- (project--other-place-command '((display-buffer-pop-up-window)
- (inhibit-same-window . t))
- project-other-window-map))
+ (if (< emacs-major-version 30)
+ (project--other-place-command '((display-buffer-pop-up-window)
+ (inhibit-same-window . t))
+ project-other-window-map)
+ (let ((inhibit-message t)) (other-window-prefix))
+ (message "Display next project command buffer in a new window...")
+ (set-transient-map (make-composed-keymap project-prefix-map
+ project-other-window-map))))
+;; TODO: maybe rename to project-other-window-prefix
;;;###autoload (define-key ctl-x-4-map "p" #'project-other-window-command)
;;;###autoload
@@ -904,8 +925,13 @@ project-other-frame-command
\\{project-prefix-map}
\\{project-other-frame-map}"
(interactive)
- (project--other-place-command '((display-buffer-pop-up-frame))
- project-other-frame-map))
+ (if (< emacs-major-version 30)
+ (project--other-place-command '((display-buffer-pop-up-frame))
+ project-other-frame-map)
+ (let ((inhibit-message t)) (other-frame-prefix))
+ (message "Display next project command buffer in a new frame...")
+ (set-transient-map (make-composed-keymap project-prefix-map
+ project-other-frame-map))))
;;;###autoload (define-key ctl-x-5-map "p" #'project-other-frame-command)
@@ -917,7 +943,11 @@ project-other-tab-command
\\{project-prefix-map}"
(interactive)
- (project--other-place-command '((display-buffer-in-new-tab))))
+ (if (< emacs-major-version 30)
+ (project--other-place-command '((display-buffer-in-new-tab)))
+ (let ((inhibit-message t)) (other-tab-prefix))
+ (message "Display next project command buffer in a new tab...")
+ (set-transient-map project-prefix-map)))
;;;###autoload
(when (bound-and-true-p tab-prefix-map)
@@ -1000,14 +1030,16 @@ project--find-default-from
"Ensure FILENAME is in PROJECT.
Usually, just return FILENAME. But if
-`project-current-directory-override' is set, adjust it to be
+`project-default-directory' is set, adjust it to be
relative to PROJECT instead.
This supports using a relative file name from the current buffer
when switching projects with `project-switch-project' and then
using a command like `project-find-file'."
- (if-let (filename-proj (and project-current-directory-override
- (project-current nil default-directory)))
+ (if-let (filename-proj (or (and project-current-directory-override
+ (project-current nil default-directory))
+ (and project-default-directory
+ (project-current nil project-default-directory))))
;; file-name-concat requires Emacs 28+
(concat (file-name-as-directory (project-root project))
(file-relative-name filename (project-root filename-proj)))
@@ -1993,6 +2025,60 @@ project-switch-project
(let ((project-current-directory-override dir))
(call-interactively command))))
+;;;###autoload
+(defun other-project-prefix (dir)
+ "\"Switch\" to another project before running an Emacs command.
+The available commands are presented as a dispatch menu
+made from `project-switch-commands'.
+
+When called in a program, it will use the project corresponding
+to directory DIR."
+ (interactive (list (funcall project-prompter)))
+ (if (symbolp project-switch-commands)
+ (let* ((project-default-directory default-directory)
+ (default-directory dir))
+ (call-interactively project-switch-commands))
+ (prefix-command-preserve-state)
+ (letrec ((minibuffer-depth (minibuffer-depth))
+ (command this-command)
+ (old-buffer (current-buffer))
+ (echofun (lambda () "[switch-project]"))
+ (postfun
+ (lambda ()
+ (unless (or (eq this-command command)
+ (> (minibuffer-depth) minibuffer-depth))
+ (remove-hook 'post-command-hook postfun)
+ (remove-hook 'prefix-command-echo-keystrokes-functions
+ echofun)
+ (when (buffer-live-p old-buffer)
+ (with-current-buffer old-buffer
+ (when project-default-directory
+ (setq-local default-directory project-default-directory)
+ (kill-local-variable 'project-default-directory))))))))
+ (add-hook 'post-command-hook postfun)
+ (add-hook 'prefix-command-echo-keystrokes-functions echofun)
+ (setq-local project-default-directory default-directory)
+ (setq-local default-directory dir)
+ (message (concat (project--keymap-prompt) " or any global key."))
+ (let ((map (make-sparse-keymap)))
+ (if project-switch-use-entire-map
+ (set-keymap-parent map project-prefix-map)
+ (dolist (row project-switch-commands map)
+ (when-let* ((cmd (nth 0 row))
+ (key (nth 2 row))
+ (keychar (if key (vector key)
+ (where-is-internal
+ cmd (list project-prefix-map) t))))
+ (define-key map keychar cmd))))
+ (define-key map (vector help-char)
+ (lambda ()
+ (interactive)
+ (let ((help-form "\
+You can use any global keybinding."))
+ (help-form-show))))
+ ;; Should return exitfun from set-transient-map
+ (set-transient-map map)))))
+
;;;###autoload
(defun project-uniquify-dirname-transform (dirname)
"Uniquify name of directory DIRNAME using `project-name', if in a project.
next prev parent reply other threads:[~2023-09-21 6:58 UTC|newest]
Thread overview: 109+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-22 16:27 bug#63648: 29.0.90; project.el: with switch-use-entire-map, switch-project errors on non-project commands Spencer Baugh
2023-05-22 17:51 ` Juri Linkov
2023-05-24 1:14 ` Dmitry Gutov
2023-05-24 6:20 ` Juri Linkov
2023-05-24 15:46 ` Dmitry Gutov
2023-05-24 16:20 ` Juri Linkov
2023-05-24 17:37 ` Juri Linkov
2023-05-24 17:44 ` Juri Linkov
2023-06-01 16:05 ` Juri Linkov
2023-06-02 1:40 ` Dmitry Gutov
2023-06-02 6:40 ` Juri Linkov
2023-06-03 1:30 ` Dmitry Gutov
2023-08-10 11:56 ` sbaugh
2023-08-23 13:53 ` Spencer Baugh
2023-08-23 17:54 ` Juri Linkov
2023-08-29 20:36 ` Spencer Baugh
2023-08-29 20:40 ` Dmitry Gutov
2023-08-29 21:47 ` Spencer Baugh
2023-08-29 22:32 ` Dmitry Gutov
2023-08-30 16:27 ` Juri Linkov
2023-08-31 2:01 ` Dmitry Gutov
2023-08-31 6:47 ` Juri Linkov
2023-08-31 11:13 ` Dmitry Gutov
2023-08-31 16:36 ` Juri Linkov
2023-09-01 1:11 ` Dmitry Gutov
2023-09-01 6:46 ` Juri Linkov
2023-09-01 9:53 ` Dmitry Gutov
2023-09-01 15:59 ` Spencer Baugh
2023-09-02 1:47 ` Dmitry Gutov
2023-09-03 17:11 ` Juri Linkov
2023-09-11 20:16 ` Spencer Baugh
2023-09-12 6:55 ` Juri Linkov
2023-09-10 15:30 ` Juri Linkov
2023-09-12 23:47 ` Dmitry Gutov
2023-09-13 6:47 ` Juri Linkov
2023-09-18 0:12 ` Dmitry Gutov
2023-09-18 6:51 ` Juri Linkov
2023-09-18 11:00 ` Dmitry Gutov
2023-09-18 13:56 ` Dmitry Gutov
2023-09-19 17:57 ` Juri Linkov
2023-09-20 0:39 ` Dmitry Gutov
2023-09-20 17:10 ` Juri Linkov
2023-09-21 1:16 ` Dmitry Gutov
2023-09-21 6:58 ` Juri Linkov [this message]
2023-09-22 15:52 ` Juri Linkov
2023-10-19 0:42 ` Dmitry Gutov
2023-10-19 4:46 ` Eli Zaretskii
2023-10-19 6:43 ` Juri Linkov
2023-10-19 7:51 ` Eli Zaretskii
2023-10-19 9:46 ` Dmitry Gutov
2023-10-19 11:05 ` Eli Zaretskii
2023-10-19 11:34 ` Dmitry Gutov
2023-10-19 12:22 ` sbaugh
2023-10-19 12:49 ` Dmitry Gutov
2023-10-19 14:00 ` Spencer Baugh
2023-10-19 17:17 ` Dmitry Gutov
2023-10-19 19:30 ` Spencer Baugh
2023-10-19 23:25 ` Dmitry Gutov
2023-10-21 16:09 ` Spencer Baugh
2023-10-21 18:43 ` Dmitry Gutov
2023-10-19 18:03 ` Juri Linkov
2023-10-19 19:38 ` Spencer Baugh
2023-10-19 17:56 ` Juri Linkov
2023-10-19 22:39 ` Dmitry Gutov
2023-10-20 6:44 ` Juri Linkov
2023-10-20 19:25 ` Dmitry Gutov
2023-10-23 6:58 ` Juri Linkov
2023-10-23 17:24 ` Dmitry Gutov
2023-10-23 17:34 ` Juri Linkov
2023-10-23 17:36 ` Dmitry Gutov
2023-10-23 18:42 ` Juri Linkov
2023-10-23 18:49 ` Dmitry Gutov
2023-10-25 16:53 ` Juri Linkov
2023-10-25 22:26 ` Dmitry Gutov
2023-10-27 6:50 ` Juri Linkov
2023-10-27 9:38 ` Dmitry Gutov
2023-10-28 16:56 ` Juri Linkov
2023-11-01 21:12 ` Dmitry Gutov
2023-11-02 17:20 ` Juri Linkov
2023-11-02 21:33 ` Dmitry Gutov
2023-11-04 17:28 ` Juri Linkov
2023-11-05 0:55 ` Dmitry Gutov
2023-11-06 7:16 ` Juri Linkov
2023-11-06 22:49 ` Dmitry Gutov
2023-10-21 13:27 ` sbaugh
2023-10-21 18:41 ` Dmitry Gutov
2023-10-21 13:14 ` sbaugh
2023-08-28 22:44 ` Dmitry Gutov
2023-08-29 20:34 ` Spencer Baugh
2023-06-02 12:46 ` Eli Zaretskii
2023-06-02 16:09 ` Juri Linkov
2023-06-02 6:32 ` Eli Zaretskii
2023-06-02 6:55 ` Juri Linkov
2023-06-02 11:39 ` Eli Zaretskii
2023-06-02 16:11 ` Juri Linkov
2023-06-05 6:53 ` Juri Linkov
2023-06-02 17:07 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-06-05 6:50 ` Juri Linkov
2023-06-05 14:44 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-06-05 16:31 ` Juri Linkov
2023-05-24 14:55 ` Spencer Baugh
2023-05-24 16:24 ` Juri Linkov
2023-05-26 15:16 ` Spencer Baugh
2023-05-30 17:48 ` Juri Linkov
2023-06-01 20:31 ` Spencer Baugh
2023-06-01 21:09 ` Drew Adams
2023-06-02 6:33 ` Eli Zaretskii
2023-06-02 6:46 ` Juri Linkov
2023-08-10 11:52 ` sbaugh
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86msxgatuy.fsf@mail.linkov.net \
--to=juri@linkov.net \
--cc=63648@debbugs.gnu.org \
--cc=dmitry@gutov.dev \
--cc=sbaugh@catern.com \
--cc=sbaugh@janestreet.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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).