From: Noam Postavsky <npostavs@gmail.com>
To: "Basil L. Contovounesios" <contovob@tcd.ie>
Cc: 36886@debbugs.gnu.org, sanelz@gmail.com
Subject: bug#36886: 26.2; (global-eldoc-mode -1) should disable eldoc completely
Date: Wed, 14 Aug 2019 20:58:12 -0400 [thread overview]
Message-ID: <8736i3qm6z.fsf@gmail.com> (raw)
In-Reply-To: <87a7cproch.fsf@gmail.com> (Noam Postavsky's message of "Sun, 04 Aug 2019 10:34:38 -0400")
[-- Attachment #1: Type: text/plain, Size: 83 bytes --]
Updated patch attached. I'll push in a few days, assuming nothing else
turns up.
[-- Attachment #2: patch --]
[-- Type: text/plain, Size: 8139 bytes --]
From d2557c135a83eda9e1c5347850669c195ae588b4 Mon Sep 17 00:00:00 2001
From: Noam Postavsky <npostavs@gmail.com>
Date: Sat, 3 Aug 2019 20:19:31 -0400
Subject: [PATCH] Respect global-eldoc-mode in minibuffers (Bug#36886)
* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Accept
a BODY parameter.
* doc/lispref/modes.texi (Defining Minor Modes): Document new
parameter.
* etc/NEWS: Announce it.
* lisp/simple.el (read--expression): Move eldoc-mode setup to...
* lisp/emacs-lisp/eldoc.el (eldoc--eval-expression-setup): ... here,
new function.
(global-eldoc-mode): Add or remove it to
eval-expression-minibuffer-setup-hook when enabling or disabling
global-eldoc-mode. This enables eldoc in the minibuffer (solving
Bug#27202), only when global-eldoc-mode is enabled.
---
doc/lispref/modes.texi | 8 ++++----
etc/NEWS | 3 +++
lisp/emacs-lisp/easy-mmode.el | 38 ++++++++++++++++++++++----------------
lisp/emacs-lisp/eldoc.el | 19 ++++++++++++++++++-
lisp/simple.el | 6 ++----
5 files changed, 49 insertions(+), 25 deletions(-)
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index d12f241424..d7e1213ea9 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -1783,12 +1783,12 @@ Defining Minor Modes
(hungry-electric-delete t)))))
@end smallexample
-@defmac define-globalized-minor-mode global-mode mode turn-on keyword-args@dots{}
+@defmac define-globalized-minor-mode global-mode mode turn-on keyword-args@dots{} body@dots{}
This defines a global toggle named @var{global-mode} whose meaning is
to enable or disable the buffer-local minor mode @var{mode} in all
-buffers. To turn on the minor mode in a buffer, it uses the function
-@var{turn-on}; to turn off the minor mode, it calls @var{mode} with
-@minus{}1 as argument.
+buffers. It also executes the @var{body} forms. To turn on the minor
+mode in a buffer, it uses the function @var{turn-on}; to turn off the
+minor mode, it calls @var{mode} with @minus{}1 as argument.
Globally enabling the mode also affects buffers subsequently created
by visiting files, and buffers that use a major mode other than
diff --git a/etc/NEWS b/etc/NEWS
index 13de6bb0f8..318bfe4259 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2378,6 +2378,9 @@ the Emacs Lisp manual.
** `directory-files-recursively' can now take an optional PREDICATE
parameter to control descending into subdirectories.
++++
+** 'define-globalized-minor-mode' now takes BODY forms.
+
\f
* Changes in Emacs 27.1 on Non-Free Operating Systems
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index be531aab84..fcbddc8629 100644
--- a/lisp/emacs-lisp/easy-mmode.el
+++ b/lisp/emacs-lisp/easy-mmode.el
@@ -363,18 +363,21 @@ 'easy-mmode-define-global-mode
;;;###autoload
(defalias 'define-global-minor-mode 'define-globalized-minor-mode)
;;;###autoload
-(defmacro define-globalized-minor-mode (global-mode mode turn-on &rest keys)
+(defmacro define-globalized-minor-mode (global-mode mode turn-on &rest body)
"Make a global mode GLOBAL-MODE corresponding to buffer-local minor MODE.
TURN-ON is a function that will be called with no args in every buffer
and that should try to turn MODE on if applicable for that buffer.
-KEYS is a list of CL-style keyword arguments. As the minor mode
- defined by this function is always global, any :global keyword is
- ignored. Other keywords have the same meaning as in `define-minor-mode',
- which see. In particular, :group specifies the custom group.
- The most useful keywords are those that are passed on to the
- `defcustom'. It normally makes no sense to pass the :lighter
- or :keymap keywords to `define-globalized-minor-mode', since these
- are usually passed to the buffer-local version of the minor mode.
+Each of KEY VALUE is a pair of CL-style keyword arguments. As
+ the minor mode defined by this function is always global, any
+ :global keyword is ignored. Other keywords have the same
+ meaning as in `define-minor-mode', which see. In particular,
+ :group specifies the custom group. The most useful keywords
+ are those that are passed on to the `defcustom'. It normally
+ makes no sense to pass the :lighter or :keymap keywords to
+ `define-globalized-minor-mode', since these are usually passed
+ to the buffer-local version of the minor mode.
+BODY contains code to execute each time the mode is enabled or disabled.
+ It is executed after toggling the mode, and before running GLOBAL-MODE-hook.
If MODE's set-up depends on the major mode in effect when it was
enabled, then disabling and reenabling MODE should make MODE work
@@ -384,7 +387,9 @@ define-globalized-minor-mode
When a major mode is initialized, MODE is actually turned on just
after running the major mode's hook. However, MODE is not turned
-on if the hook has explicitly disabled it."
+on if the hook has explicitly disabled it.
+
+\(fn GLOBAL-MODE MODE TURN-ON [KEY VALUE]... BODY)"
(declare (doc-string 2))
(let* ((global-mode-name (symbol-name global-mode))
(mode-name (symbol-name mode))
@@ -404,12 +409,12 @@ define-globalized-minor-mode
keyw)
;; Check keys.
- (while (keywordp (setq keyw (car keys)))
- (setq keys (cdr keys))
+ (while (keywordp (setq keyw (car body)))
+ (pop body)
(pcase keyw
- (:group (setq group (nconc group (list :group (pop keys)))))
- (:global (setq keys (cdr keys)))
- (_ (push keyw extra-keywords) (push (pop keys) extra-keywords))))
+ (:group (setq group (nconc group (list :group (pop body)))))
+ (:global (pop body))
+ (_ (push keyw extra-keywords) (push (pop body) extra-keywords))))
`(progn
(progn
@@ -446,7 +451,8 @@ define-globalized-minor-mode
;; Go through existing buffers.
(dolist (buf (buffer-list))
(with-current-buffer buf
- (if ,global-mode (funcall #',turn-on) (when ,mode (,mode -1))))))
+ (if ,global-mode (funcall #',turn-on) (when ,mode (,mode -1)))))
+ ,@body)
;; Autoloading define-globalized-minor-mode autoloads everything
;; up-to-here.
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el
index 16b5863209..2892faae21 100644
--- a/lisp/emacs-lisp/eldoc.el
+++ b/lisp/emacs-lisp/eldoc.el
@@ -207,7 +207,24 @@ eldoc-mode
(define-globalized-minor-mode global-eldoc-mode eldoc-mode turn-on-eldoc-mode
:group 'eldoc
:initialize 'custom-initialize-delay
- :init-value t)
+ :init-value t
+ ;; For `read--expression', the usual global mode mechanism of
+ ;; `change-major-mode-hook' runs in the minibuffer before
+ ;; `eldoc-documentation-function' is set, so `turn-on-eldoc-mode'
+ ;; does nothing. Configure and enable eldoc from
+ ;; `eval-expression-minibuffer-setup-hook' instead.
+ (if global-eldoc-mode
+ (add-hook 'eval-expression-minibuffer-setup-hook
+ #'eldoc--eval-expression-setup)
+ (remove-hook 'eval-expression-minibuffer-setup-hook
+ #'eldoc--eval-expression-setup)))
+
+(defun eldoc--eval-expression-setup ()
+ ;; Setup `eldoc', similar to `emacs-lisp-mode'. FIXME: Call
+ ;; `emacs-lisp-mode' itself?
+ (add-function :before-until (local 'eldoc-documentation-function)
+ #'elisp-eldoc-documentation-function)
+ (eldoc-mode +1))
;;;###autoload
(defun turn-on-eldoc-mode ()
diff --git a/lisp/simple.el b/lisp/simple.el
index e33709e8ad..479c2d38fd 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -1580,10 +1580,8 @@ read--expression
(let ((minibuffer-completing-symbol t))
(minibuffer-with-setup-hook
(lambda ()
- ;; FIXME: call emacs-lisp-mode?
- (add-function :before-until (local 'eldoc-documentation-function)
- #'elisp-eldoc-documentation-function)
- (eldoc-mode 1)
+ ;; FIXME: call emacs-lisp-mode (see also
+ ;; `eldoc--eval-expression-setup')?
(add-hook 'completion-at-point-functions
#'elisp-completion-at-point nil t)
(run-hooks 'eval-expression-minibuffer-setup-hook))
--
2.11.0
next prev parent reply other threads:[~2019-08-15 0:58 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-01 10:30 bug#36886: 26.2; (global-eldoc-mode -1) should disable eldoc completely Sanel Zukan
2019-08-01 11:37 ` Basil L. Contovounesios
2019-08-01 12:29 ` Sanel Zukan
2019-08-01 13:38 ` Dmitry Gutov
2019-08-02 6:35 ` Eli Zaretskii
2019-08-02 9:35 ` Sanel Zukan
2019-08-02 11:44 ` Basil L. Contovounesios
2019-08-02 12:00 ` Eli Zaretskii
2019-08-02 13:19 ` Basil L. Contovounesios
2019-08-02 14:28 ` Eli Zaretskii
2019-08-04 0:35 ` Noam Postavsky
2019-08-04 7:51 ` Basil L. Contovounesios
2019-08-04 9:00 ` Štěpán Němec
2019-08-04 14:34 ` Noam Postavsky
2019-08-15 0:58 ` Noam Postavsky [this message]
2019-08-15 8:31 ` Štěpán Němec
2019-08-21 0:24 ` Noam Postavsky
2019-08-04 16:27 ` Eli Zaretskii
2019-08-02 12:36 ` Sanel Zukan
2019-08-02 11:50 ` Eli Zaretskii
2019-08-02 12:51 ` Sanel Zukan
2019-08-02 14:33 ` 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=8736i3qm6z.fsf@gmail.com \
--to=npostavs@gmail.com \
--cc=36886@debbugs.gnu.org \
--cc=contovob@tcd.ie \
--cc=sanelz@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.