From: "João Távora" <joaotavora@gmail.com>
To: Eshel Yaron <me@eshelyaron.com>
Cc: Eli Zaretskii <eliz@gnu.org>, 68547@debbugs.gnu.org
Subject: bug#68547: [PATCH] ; Fix 'mode-line-format-right-align' with ElDoc
Date: Sat, 20 Jan 2024 18:08:35 +0000 [thread overview]
Message-ID: <CALDnm50S6F3JkeAJUcrbL8X3BCUMC=5wCKTZ6vwmCuJgZ0P7oQ@mail.gmail.com> (raw)
In-Reply-To: <m1le8k58a7.fsf@dazzs-mbp.home>
On Sat, Jan 20, 2024 at 3:33 PM Eshel Yaron <me@eshelyaron.com> wrote:
> Then I tried the following (somewhat pathological) use case:
>
> 0. Setup: (keymap-global-set "C-x w a" #'windmove-swap-states-left)
> 1. Open two buffers in two windows side by side.
> 2. Say `M-: (car `, to show info in the mode line of the left window.
> 3. Without quitting the minibuffer, use `C-x o` to switch to the right
> window, followed by `C-x w a` to switch the buffers in the left and
> right windows.
> 4. Return to the minibuffer and type `nil) RET` or something like that
> to exit the minibuffer.
> 5. The `mode-line-format` of the left buffer is becomes nil, i.e. no mode line.
>
> Shuffling `mode-line-format` around is really tricky :(
Indeed. Your case is pathological, but not particularly hard to
trigger. Given the consequences are somewhat dire (vanished mode-line)
, it should most definitely be handled.
Try this version, please. Only difference is it uses a setq-local
for eldoc--saved-mlf instead of a setq.
Please give it as much testing as you can.
João
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el
index 912a7357ca7..1ba4e6a006f 100644
--- a/lisp/emacs-lisp/eldoc.el
+++ b/lisp/emacs-lisp/eldoc.el
@@ -182,7 +182,7 @@ eldoc-current-idle-delay
"Idle time delay currently in use by timer.
This is used to determine if `eldoc-idle-delay' is changed by the user.")
-(defvar eldoc-message-function #'eldoc-minibuffer-message
+(defvar eldoc-message-function #'eldoc--minibuffer-message
"The function used by `eldoc--message' to display messages.
It should receive the same arguments as `message'.")
@@ -292,43 +292,42 @@ eldoc-schedule-timer
(setq eldoc-current-idle-delay eldoc-idle-delay)
(timer-set-idle-time eldoc-timer eldoc-idle-delay t))))
-(defvar eldoc-mode-line-string nil)
-(put 'eldoc-mode-line-string 'risky-local-variable t)
-
-(defun eldoc-minibuffer-message (format-string &rest args)
+(defvar eldoc--saved-mlf nil
+ "Saved `mode-line-format' used in `eldoc--minibuffer-message'.")
+(defun eldoc--minibuffer-message (format-string &rest args)
"Display message specified by FORMAT-STRING and ARGS on the
mode-line as needed.
This function displays the message produced by formatting ARGS
with FORMAT-STRING on the mode line when the current buffer is a minibuffer.
Otherwise, it displays the message like `message' would."
- (if (or (bound-and-true-p edebug-mode) (minibufferp))
- (progn
- (add-hook 'post-command-hook #'eldoc-minibuffer--cleanup)
- (with-current-buffer
- (window-buffer
- (or (window-in-direction 'above (minibuffer-window))
- (minibuffer-selected-window)
- (get-largest-window)))
- (when (and mode-line-format
- (not (and (listp mode-line-format)
- (assq 'eldoc-mode-line-string
mode-line-format))))
- (setq mode-line-format
- (funcall
- (if (listp mode-line-format) #'append #'list)
- (list "" '(eldoc-mode-line-string
- (" " eldoc-mode-line-string " ")))
- mode-line-format)))
- (setq eldoc-mode-line-string
- (when (stringp format-string)
- (apply #'format-message format-string args)))
- (force-mode-line-update)))
- (apply #'message format-string args)))
-
-(defun eldoc-minibuffer--cleanup ()
- (unless (or (bound-and-true-p edebug-mode) (minibufferp))
- (setq eldoc-mode-line-string nil
- ;; https://debbugs.gnu.org/16920
- eldoc-last-message nil)
- (remove-hook 'post-command-hook #'eldoc-minibuffer--cleanup)))
+ (cond ((bound-and-true-p edebug-mode)
+ (eldoc--message-in-mode-line 'edebug-mode-hook format-string args))
+ ((minibufferp)
+ (eldoc--message-in-mode-line 'minibuffer-exit-hook
format-string args))
+ (t
+ (apply #'message format-string args))))
+
+(defun eldoc--message-in-mode-line (hook format-string args)
+ (with-current-buffer
+ (window-buffer
+ (or (window-in-direction 'above (minibuffer-window))
+ (minibuffer-selected-window)
+ (get-largest-window)))
+ (let ((buf (current-buffer)))
+ (cl-labels ((cleanup ()
+ (with-current-buffer buf
+ (remove-hook hook #'cleanup)
+ (setq mode-line-format eldoc--saved-mlf
+ eldoc--saved-mlf nil))))
+ (add-hook hook #'cleanup)
+ (setq-local eldoc--saved-mlf (or eldoc--saved-mlf mode-line-format))
+ (when format-string
+ (setq-local
+ mode-line-format
+ (funcall (if (listp eldoc--saved-mlf) #'cons #'list)
+ (and format-string
+ (apply #'format-message format-string args))
+ eldoc--saved-mlf)))
+ (force-mode-line-update)))))
(make-obsolete
'eldoc-message "use `eldoc-documentation-functions' instead." "eldoc-1.1.0")
--
João Távora
next prev parent reply other threads:[~2024-01-20 18:08 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-17 19:44 bug#68547: [PATCH] ; Fix 'mode-line-format-right-align' with ElDoc Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-01-20 9:56 ` Eli Zaretskii
2024-01-20 10:20 ` João Távora
2024-01-20 10:58 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-01-20 12:01 ` João Távora
2024-01-20 13:55 ` João Távora
2024-01-20 15:33 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-01-20 18:08 ` João Távora [this message]
2024-01-20 18:16 ` Eli Zaretskii
2024-01-20 21:12 ` João Távora
2024-01-21 5:18 ` Eli Zaretskii
2024-01-21 8:34 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-01-21 8:52 ` João Távora
2024-01-21 13:20 ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
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='CALDnm50S6F3JkeAJUcrbL8X3BCUMC=5wCKTZ6vwmCuJgZ0P7oQ@mail.gmail.com' \
--to=joaotavora@gmail.com \
--cc=68547@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=me@eshelyaron.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).