From: sbaugh@catern.com
To: Eli Zaretskii <eliz@gnu.org>
Cc: Spencer Baugh <sbaugh@janestreet.com>,
schwab@linux-m68k.org, 64533@debbugs.gnu.org
Subject: bug#64533: [PATCH] Support displaying function name in the header line
Date: Sun, 09 Jul 2023 17:26:09 +0000 (UTC) [thread overview]
Message-ID: <87r0phkndb.fsf@catern.com> (raw)
In-Reply-To: <83o7klbq8q.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 09 Jul 2023 08:36:37 +0300")
[-- Attachment #1: Type: text/plain, Size: 1279 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Spencer Baugh <sbaugh@janestreet.com>
>> Cc: Eli Zaretskii <eliz@gnu.org>, 64533@debbugs.gnu.org
>> Date: Sat, 08 Jul 2023 16:58:50 -0400
>>
>> +** Which Function Mode
>> +
>> ++++
>> +*** Displaying the function name in the header line is now supported.
>
> Passive voice alert! Here's a better wording (also for reasons other
> than passive voice);;
>
> Which Function Mode can now display function names on the header line.
Fixed.
>> +(defcustom which-func-display '(mode)
>> + "Where to display the function name.
>> +
>> +This should be a list of symbols. If it contains 'mode, display
>> +in the mode line. If it contains 'header, display in the header
>> +line."
>
> Which leaves it to the user to deduce that '(mode header) means both:
> yet another reason not to prefer this kind of values in user options.
>
> It also doesn't tell how to disable this display: another riddle left
> to the user to solve.
>
> Let's always remember that Emacs users are not necessarily experienced
> Lispers. User options should not be "tricky", especially where such
> trickery is unjustified. And the doc strings should not pose riddles,
> however logical they seem to us.
>
> Thanks.
Fair point. Back to the single symbol.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Support-displaying-function-name-in-the-header-line.patch --]
[-- Type: text/x-patch, Size: 6520 bytes --]
From 3f23e559cae5ce864aef2c15e990f6beb5484eb7 Mon Sep 17 00:00:00 2001
From: Spencer Baugh <sbaugh@catern.com>
Date: Sun, 9 Jul 2023 12:16:28 -0400
Subject: [PATCH] Support displaying function name in the header line
In some languages, the function name as displayed in the mode-line by
which-func-mode can be quite long. It's useful to be able to display
it in the header-line instead. Let's support that.
* lisp/progmodes/which-func.el (which-func-display)
(which-func--use-header-line, which-func--use-mode-line):
Add. (Bug#64533)
(which-func-try-to-enable): Support which-func--use-header-line.
(which-func--disable): Add, to support which-func--use-header-line.
(which-func-ff-hook, which-func-update-1): Use which-func--disable.
---
doc/emacs/programs.texi | 10 +++++++--
etc/NEWS | 9 ++++++++
lisp/progmodes/which-func.el | 42 ++++++++++++++++++++++++++++++------
3 files changed, 53 insertions(+), 8 deletions(-)
diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi
index a0e0fc06385..41780a95489 100644
--- a/doc/emacs/programs.texi
+++ b/doc/emacs/programs.texi
@@ -335,8 +335,8 @@ Which Function
@cindex current function name in mode line
Which Function mode is a global minor mode (@pxref{Minor Modes})
-which displays the current function name in the mode line, updating it
-as you move around in a buffer.
+which displays the current function name in the mode line or header
+line, updating it as you move around in a buffer.
@findex which-function-mode
@vindex which-func-modes
@@ -349,6 +349,12 @@ Which Function
@code{t} (which means to support all available major modes) to a list
of major mode names.
+@vindex which-func-display
+ By default, Which Function mode displays the current function name
+using the mode line. Customize @code{which-func-display} to
+@code{header}, @code{mode}, or @code{mode-and-header} to use the
+header line, mode line, or both, respectively.
+
@node Program Indent
@section Indentation for Programs
@cindex indentation for programs
diff --git a/etc/NEWS b/etc/NEWS
index 9c99cf6c725..efd323cb1da 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2989,6 +2989,15 @@ The newly created buffer will be displayed via 'display-buffer', which
can be customized through the usual mechanism of 'display-buffer-alist'
and friends.
+** Which Function Mode
+
++++
+*** Which Function Mode can now display function names on the header line.
+The new user option 'which-func-display' allows choosing where the
+function name is displayed. The default is 'mode' to display in the
+mode line. 'header' will display in the header line.
+'mode-and-header' displays in both the header line and mode line.
+
** Tramp
+++
diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el
index 09937a60988..631d47bb729 100644
--- a/lisp/progmodes/which-func.el
+++ b/lisp/progmodes/which-func.el
@@ -86,6 +86,17 @@ which-func-non-auto-modes
activation of Which Function until Imenu is used for the first time."
:type '(repeat (symbol :tag "Major mode")))
+(defcustom which-func-display 'mode
+ "Where to display the function name.
+
+If 'mode, display in the mode line. If 'header, display in the
+header line. If 'mode-and-header, display in both."
+ :type '(choice (const :tag "Display in mode line" mode)
+ (const :tag "Display in header line" header)
+ (const :tag "Display in both header and mode line"
+ mode-and-header))
+ :version "30.1")
+
(defcustom which-func-maxout 500000
"Don't automatically compute the Imenu menu if buffer is this big or bigger.
Zero means compute the Imenu menu regardless of size.
@@ -184,17 +195,35 @@ which-func-current
;;;###autoload (put 'which-func-current 'risky-local-variable t)
(defvar-local which-func-mode nil
- "Non-nil means display current function name in mode line.
+ "Non-nil means display current function name in mode or header line.
This makes a difference only if variable `which-function-mode' is
non-nil.")
+(defvar-local which-func--use-header-line nil
+ "If non-nil, display the function name in the header line.")
+
+(defvar-local which-func--use-mode-line nil
+ "If non-nil, display the function name in the mode line.")
+
(add-hook 'after-change-major-mode-hook #'which-func-ff-hook t)
(defun which-func-try-to-enable ()
(unless (or (not which-function-mode)
(local-variable-p 'which-func-mode))
(setq which-func-mode (or (eq which-func-modes t)
- (member major-mode which-func-modes)))))
+ (member major-mode which-func-modes)))
+ (setq which-func--use-mode-line
+ (member which-func-display '(mode mode-and-header)))
+ (setq which-func--use-header-line
+ (member which-func-display '(header mode-and-header)))
+ (when (and which-func-mode which-func--use-header-line)
+ (add-to-list 'header-line-format '("" which-func-format " ")))))
+
+(defun which-func--disable ()
+ (when (and which-func-mode which-func--use-header-line)
+ (setq header-line-format
+ (delete '("" which-func-format " ") header-line-format)))
+ (setq which-func-mode nil))
(defun which-func-ff-hook ()
"`after-change-major-mode-hook' for Which Function mode.
@@ -210,10 +239,10 @@ which-func-ff-hook
(setq imenu--index-alist
(save-excursion (funcall imenu-create-index-function))))
(imenu-unavailable
- (setq which-func-mode nil))
+ (which-func--disable))
(error
(message "which-func-ff-hook error: %S" err)
- (setq which-func-mode nil))))
+ (which-func--disable))))
(defun which-func-update ()
"Update the Which-Function mode display in the current window."
@@ -231,7 +260,7 @@ which-func-update-1
(puthash window current which-func-table)
(force-mode-line-update)))
(error
- (setq which-func-mode nil)
+ (which-func--disable)
(error "Error in which-func-update: %S" info))))))
(defvar which-func-update-timer nil)
@@ -241,7 +270,8 @@ which-func-update-timer
(add-to-list 'mode-line-misc-info
'(which-function-mode ;Only display if mode is enabled.
(which-func-mode ;Only display if buffer supports it.
- ("" which-func-format " ")))))
+ (which-func--use-mode-line
+ ("" which-func-format " "))))))
;; This is the name people would normally expect.
;;;###autoload
--
2.41.0
next prev parent reply other threads:[~2023-07-09 17:26 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-08 17:56 bug#64533: [PATCH] Support displaying function name in the header line Spencer Baugh
2023-07-08 18:04 ` Eli Zaretskii
2023-07-08 18:14 ` Spencer Baugh
2023-07-08 18:33 ` Eli Zaretskii
2023-07-08 19:26 ` Spencer Baugh
2023-07-08 20:46 ` Andreas Schwab
2023-07-08 20:56 ` Spencer Baugh
2023-07-08 20:58 ` Spencer Baugh
2023-07-09 5:36 ` Eli Zaretskii
2023-07-09 17:26 ` sbaugh [this message]
2023-07-15 8:02 ` Eli Zaretskii
2023-07-09 5:29 ` 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=87r0phkndb.fsf@catern.com \
--to=sbaugh@catern.com \
--cc=64533@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=sbaugh@janestreet.com \
--cc=schwab@linux-m68k.org \
/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.