;;; which-func.el --- Print current function in mode line
-;; Copyright (C) 1994, 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc.
;; Author: Alex Rezinsky <alexr@msil.sps.mot.com>
-;; Keywords: mode-line imenu
+;; Keywords: mode-line, imenu, tools
;; This file is part of GNU Emacs.
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
-;;; COMMENTARY
-;;; ----------
-;;; This package prints name of function where your current point is
-;;; located in mode line. It assumes that you work with imenu package
-;;; and imenu--index-alist is up to date.
-
-;;; KNOWN BUGS
-;;; ----------
-;;; Really this package shows not "function where the current point
-;;; is located now", but "nearest function which defined above the
-;;; current point". So if your current point is located after end of
-;;; function FOO but before begin of function BAR, FOO will be
-;;; displayed in mode line.
-
-;;; TODO LIST
-;;; ---------
-;;; 1. Dependence on imenu package should be removed. Separate
-;;; function determination mechanism should be used to determine the end
-;;; of a function as well as the beginning of a function.
-;;; 2. This package should be realized with the help of overlay
-;;; properties instead of imenu--index-alist variable.
-
-;;; THANKS TO
-;;; ---------
-;;; Per Abrahamsen <abraham@iesd.auc.dk>
-;;; Some ideas (inserting in mode-line, using of post-command hook
-;;; and toggling this mode) have been borrowed from his package
-;;; column.el
-;;; Peter Eisenhauer <pipe@fzi.de>
-;;; Bug fixing in case nested indexes.
-;;; Terry Tateyama <ttt@ursa0.cs.utah.edu>
-;;; Suggestion to use find-file-hooks for first imenu
-;;; index building.
-
-;;; Variables for customization
-;;; ---------------------------
-;;;
+;;; Commentary:
+
+;; This package prints name of function where your current point is
+;; located in mode line. It assumes that you work with imenu package
+;; and imenu--index-alist is up to date.
+
+;; KNOWN BUGS
+;; ----------
+;; Really this package shows not "function where the current point is
+;; located now", but "nearest function which defined above the current
+;; point". So if your current point is located after end of function
+;; FOO but before begin of function BAR, FOO will be displayed in mode
+;; line.
+
+;; TODO LIST
+;; ---------
+;; 1. Dependence on imenu package should be removed. Separate
+;; function determination mechanism should be used to determine the end
+;; of a function as well as the beginning of a function.
+;; 2. This package should be realized with the help of overlay
+;; properties instead of imenu--index-alist variable.
+
+;;; History:
+
+;; THANKS TO
+;; ---------
+;; Per Abrahamsen <abraham@iesd.auc.dk>
+;; Some ideas (inserting in mode-line, using of post-command hook
+;; and toggling this mode) have been borrowed from his package
+;; column.el
+;; Peter Eisenhauer <pipe@fzi.de>
+;; Bug fixing in case nested indexes.
+;; Terry Tateyama <ttt@ursa0.cs.utah.edu>
+;; Suggestion to use find-file-hooks for first imenu
+;; index building.
+
+;;; Code:
+
+;; Variables for customization
+;; ---------------------------
+;;
(defvar which-func-unknown "???"
"String to display in the mode line when current function is unknown.")
+(defgroup which-func nil
+ "Mode to display the current function name in the modeline."
+ :group 'tools
+ :version "20.3")
+
(defcustom which-func-modes
- '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode)
- "List of major modes for which `which-func-mode' should be used.
+ '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode
+ fortran-mode)
+ "List of major modes for which Which Function mode should be used.
For other modes it is disabled. If this is equal to t,
-then current-function recognition is enabled in any mode."
+then Which Function mode is enabled in any major mode that supports it."
:group 'which-func
:type '(choice (const :tag "All modes" t)
- (list (symbol :tag "Major mode"))))
-
-(defcustom which-func-amodes '(emacs-lisp-mode c-mode c++-mode)
- "List of major modes for which the Imenu menu should be computed automatically.
-It is computed when you visit a file in one of these major modes.
-If the variable's value is nil, then the Imenu menu is not computed
-automatically in any mode. Note that the menu is never computed
-automatically if the buffer size exceeds `which-func-maxout'."
+ (repeat (symbol :tag "Major mode"))))
+
+(defcustom which-func-non-auto-modes nil
+ "List of major modes where Which Function mode is inactive till Imenu is used.
+This means that Which Function mode won't really do anything
+until you use Imenu, in these modes. Note that files
+larger than `which-func-maxout' behave in this way too;
+Which Function mode doesn't do anything until you use Imenu."
:group 'which-func
- :type '(list (symbol :tag "Major mode")))
+ :type '(repeat (symbol :tag "Major mode")))
(defcustom which-func-maxout 100000
"Don't automatically compute the Imenu menu if buffer is this big or bigger.
:group 'which-func
:type 'sexp)
+;;;###autoload
+(defcustom which-func-mode-global nil
+ "*Toggle `which-func-mode'.
+You must modify via \\[customize] for this variable to have an effect."
+ :set #'(lambda (symbol value)
+ (which-func-mode (if value 1 0)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'which-func
+ :require 'which-func)
+
;;; Code, nothing to customize below here
;;; -------------------------------------
;;;
(make-variable-buffer-local 'which-func-current)
(make-variable-buffer-local 'which-func-previous)
-(defvar which-func-mode-global nil
- "Non-nil means display current function name in mode line.")
-
(defvar which-func-mode nil
"Non-nil means display current function name in mode line.
-This makes a difference only if which-func-mode-global is non-nil")
+This makes a difference only if `which-func-mode-global' is non-nil")
(make-variable-buffer-local 'which-func-mode)
(put 'which-func-mode 'permanent-local t)
(setq which-func-mode which-func-mode-global)
(setq which-func-mode nil))
- (if (and which-func-mode
- (member major-mode which-func-amodes)
- (or (< buffer-saved-size which-func-maxout)
- (= which-func-maxout 0)))
- (setq imenu--index-alist
- (save-excursion (funcall imenu-create-index-function)))))
+ (condition-case nil
+ (if (and which-func-mode
+ (not (member major-mode which-func-non-auto-modes))
+ (or (< buffer-saved-size which-func-maxout)
+ (= which-func-maxout 0)))
+ (setq imenu--index-alist
+ (save-excursion (funcall imenu-create-index-function))))
+ (error
+ (setq which-func-mode nil))))
(defun which-func-update ()
;; Update the string containing the current function.
(condition-case info
- (progn
- (if (not (setq which-func-current (which-function)))
- (setq which-func-current which-func-unknown))
- (if (not (string= which-func-current which-func-previous))
- (progn
- (force-mode-line-update)
- (setq which-func-previous which-func-current))))
+ (progn
+ (if (not (setq which-func-current (which-function)))
+ (setq which-func-current which-func-unknown))
+ (if (not (string= which-func-current which-func-previous))
+ (progn
+ (force-mode-line-update)
+ (setq which-func-previous which-func-current))))
(error
(ding)
(remove-hook 'post-command-hook 'which-func-update)
(which-func-mode -1) ; Function mode off
- (message "Error in which-func-update: %s" info)))
+ (message "Error in which-func-update: %s" info))))
+
+;; This is the name people would normally expect.
+;;;###autoload
+(defalias 'which-function-mode 'which-func-mode)
+;;;###autoload
(defun which-func-mode (&optional arg)
"Toggle Which Function mode, globally.
When Which Function mode is enabled, the current function name is
(member major-mode which-func-modes))))))
(defun which-function ()
- "Returns current function name based on point.
-If imenu--index-alist does not exist, or is empty or if point
+ "Return current function name based on point.
+If `imenu--index-alist' does not exist, or is empty or if point
is located before first function, returns nil."
(and
(boundp 'imenu--index-alist)
(let ((pair (car-safe imenu--index-alist))
(rest (cdr-safe imenu--index-alist))
(name nil))
- (while (and pair (or (not (number-or-marker-p (cdr pair)))
- (> (point) (cdr pair))))
+ (while (and (or rest pair)
+ (or (not (number-or-marker-p (cdr pair)))
+ (> (point) (cdr pair))))
(setq name (car pair))
(setq pair (car-safe rest))
(setq rest (cdr-safe rest)))