From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Spencer Baugh Newsgroups: gmane.emacs.bugs Subject: bug#64533: [PATCH] Support displaying function name in the header line Date: Sat, 08 Jul 2023 15:26:23 -0400 Message-ID: References: <83y1jqb7pt.fsf@gnu.org> <83wmzab6d5.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7841"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 64533@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jul 08 21:27:17 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qIDaO-0001pC-Ql for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 08 Jul 2023 21:27:16 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qIDaC-0007bf-RV; Sat, 08 Jul 2023 15:27:04 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qIDaB-0007bF-0K for bug-gnu-emacs@gnu.org; Sat, 08 Jul 2023 15:27:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qIDaA-0005Dg-OL for bug-gnu-emacs@gnu.org; Sat, 08 Jul 2023 15:27:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qIDaA-0003H2-Gr for bug-gnu-emacs@gnu.org; Sat, 08 Jul 2023 15:27:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Spencer Baugh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 08 Jul 2023 19:27:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 64533 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 64533-submit@debbugs.gnu.org id=B64533.168884439112532 (code B ref 64533); Sat, 08 Jul 2023 19:27:02 +0000 Original-Received: (at 64533) by debbugs.gnu.org; 8 Jul 2023 19:26:31 +0000 Original-Received: from localhost ([127.0.0.1]:45230 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qIDZe-0003G4-Vo for submit@debbugs.gnu.org; Sat, 08 Jul 2023 15:26:31 -0400 Original-Received: from mxout6.mail.janestreet.com ([64.215.233.21]:48953) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qIDZc-0003Fo-P4 for 64533@debbugs.gnu.org; Sat, 08 Jul 2023 15:26:29 -0400 In-Reply-To: <83wmzab6d5.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 08 Jul 2023 21:33:42 +0300") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:264791 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: >> From: Spencer Baugh >> Date: Sat, 8 Jul 2023 14:14:30 -0400 >> Cc: 64533@debbugs.gnu.org >> >> Although I could make these current defcustoms into internal variables and just set them based on a >> single defcustom, would that be good? > > Yes, why not? Fixed, along with your previous comments. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Support-displaying-function-name-in-the-header-line.patch >From 3086671e447a188b2cdceda779b447d095b3b118 Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Sat, 8 Jul 2023 13:54:01 -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. (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 | 39 ++++++++++++++++++++++++++++++------ 3 files changed, 50 insertions(+), 8 deletions(-) diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi index 953de2e4786..c01503ab9f0 100644 --- a/doc/emacs/programs.texi +++ b/doc/emacs/programs.texi @@ -396,8 +396,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 @@ -410,6 +410,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{both} 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 0556e8be585..9f100d93281 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -243,6 +243,15 @@ docstring, or a comment, or (re)indents the surrounding defun if point is not in a comment or a string. It is by default bound to 'M-q' in 'prog-mode' and all its descendants. +** Which Function Mode + ++++ +*** Displaying the function name in the header line is now supported. +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. 'both' 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..0152670bc98 100644 --- a/lisp/progmodes/which-func.el +++ b/lisp/progmodes/which-func.el @@ -86,6 +86,16 @@ 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 'both, 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" both)) + :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 +194,33 @@ 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 both))) + (setq which-func--use-header-line (member which-func-display '(header both))) + (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 +236,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 +257,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 +267,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.39.3 --=-=-=--