which-func.el 8.31 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; which-func.el --- Print current function in mode line
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Dave Love's avatar
Dave Love committed
3
;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author:   Alex Rezinsky <alexr@msil.sps.mot.com>
Stefan Monnier's avatar
Stefan Monnier committed
6
;;           (doesn't seem to be responsive any more)
Dave Love's avatar
Dave Love committed
7
;; Keywords: mode-line, imenu, tools
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

Dave Love's avatar
Dave Love committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
;;; 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
;; ---------------------------
;;  
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69
(defvar which-func-unknown "???"
  "String to display in the mode line when current function is unknown.")

Dan Nicolaescu's avatar
Dan Nicolaescu committed
70 71 72 73 74
(defgroup which-func nil
  "Mode to display the current function name in the modeline."
  :group 'tools
  :version "20.3")

75
(defcustom which-func-modes
76 77
  '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode
		    fortran-mode)
78
  "List of major modes for which Which Function mode should be used.
Richard M. Stallman's avatar
Richard M. Stallman committed
79
For other modes it is disabled.  If this is equal to t,
80
then Which Function mode is enabled in any major mode that supports it."
Richard M. Stallman's avatar
Richard M. Stallman committed
81 82
  :group 'which-func
  :type '(choice (const :tag "All modes" t)
83
		 (repeat (symbol :tag "Major mode"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
84

85 86
(defcustom which-func-non-auto-modes nil
  "List of major modes where Which Function mode is inactive till Imenu is used.
87 88 89 90
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."
Richard M. Stallman's avatar
Richard M. Stallman committed
91
  :group 'which-func
92
  :type '(repeat (symbol :tag "Major mode")))
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96 97 98 99

(defcustom which-func-maxout 100000
  "Don't automatically compute the Imenu menu if buffer is this big or bigger.
Zero means compute the Imenu menu regardless of size."
  :group 'which-func
  :type 'integer)

100
(defcustom which-func-format '("[" which-func-current "]")
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104
  "Format for displaying the function in the mode line."
  :group 'which-func
  :type 'sexp)

Dave Love's avatar
Dave Love committed
105 106
;;;###autoload
(defcustom which-func-mode-global nil
Dave Love's avatar
Dave Love committed
107 108 109
  "*Toggle `which-func-mode' globally.
Setting this variable directly does not take effect;
use either \\[customize] or the function `which-func-mode'."
Dave Love's avatar
Dave Love committed
110
  :set #'(lambda (symbol value)
111
	   (which-func-mode (if value 1 0)))
Dave Love's avatar
Dave Love committed
112 113 114 115 116
  :initialize 'custom-initialize-default
  :type    'boolean
  :group   'which-func
  :require 'which-func)

117 118 119 120 121 122 123 124 125 126 127
(defvar which-func-cleanup-function nil
  "Function to transform a string before displaying it in the mode line.
The function is called with one argument, the string to display.
Its return value is displayed in the modeline.
If nil, no function is called.  The default value is nil.

This feature can be useful if Imenu is set up to make more
detailed entries (e.g., containing the argument list of a function),
and you want to simplify them for the mode line
\(e.g., removing the parameter list to just have the function name.)")

Richard M. Stallman's avatar
Richard M. Stallman committed
128 129 130 131 132 133 134 135 136 137 138 139
;;; Code, nothing to customize below here
;;; -------------------------------------
;;;
(require 'imenu)

(defvar which-func-current  which-func-unknown)
(defvar which-func-previous which-func-unknown)
(make-variable-buffer-local 'which-func-current)
(make-variable-buffer-local 'which-func-previous)

(defvar which-func-mode nil
  "Non-nil means display current function name in mode line.
Dave Love's avatar
Dave Love committed
140
This makes a difference only if `which-func-mode-global' is non-nil")
Richard M. Stallman's avatar
Richard M. Stallman committed
141
(make-variable-buffer-local 'which-func-mode)
142
;;(put 'which-func-mode 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145 146 147 148

(add-hook 'find-file-hooks 'which-func-ff-hook t)

(defun which-func-ff-hook ()
  "File find hook for Which Function mode.
It creates the Imenu index for the buffer, if necessary."
149 150 151
  (setq which-func-mode
	(and which-func-mode-global
	     (or (eq which-func-modes t) (member major-mode which-func-modes))))
Richard M. Stallman's avatar
Richard M. Stallman committed
152

153 154 155
  (condition-case nil
      (if (and which-func-mode
	       (not (member major-mode which-func-non-auto-modes))
156 157
	       (or (null which-func-maxout)
		   (< buffer-saved-size which-func-maxout)
158 159 160 161 162
		   (= which-func-maxout 0)))
	  (setq imenu--index-alist
		(save-excursion (funcall imenu-create-index-function))))
    (error
     (setq which-func-mode nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
163 164 165

(defun which-func-update ()
  ;; Update the string containing the current function.
166 167 168 169 170
  (when which-func-mode
    (condition-case info
	(progn
	  (setq which-func-current (or (which-function) which-func-unknown))
	  (unless (string= which-func-current which-func-previous)
171
	    (force-mode-line-update)
172 173 174 175
	    (setq which-func-previous which-func-current)))
      (error
       (which-func-mode -1)
       (error "Error in which-func-update: %s" info)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
176

177 178 179 180
;; This is the name people would normally expect.
;;;###autoload
(defalias 'which-function-mode 'which-func-mode)

Dave Love's avatar
Dave Love committed
181
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184 185 186
(defun which-func-mode (&optional arg)
  "Toggle Which Function mode, globally.
When Which Function mode is enabled, the current function name is
continuously displayed in the mode line, in certain major modes.

187
With prefix ARG, turn Which Function mode on iff arg is positive,
Richard M. Stallman's avatar
Richard M. Stallman committed
188 189
and off otherwise."
  (interactive "P")
190
  (setq which-func-mode-global
191 192
        (and (or arg (not which-func-mode-global))
             (> (prefix-numeric-value arg) 0)))
193
  (if which-func-mode-global
194
      ;;Turn it on
195
      (progn
196 197 198 199 200 201 202 203
        (add-hook 'post-command-idle-hook 'which-func-update)
        (dolist (buf (buffer-list))
          (with-current-buffer buf
            (setq which-func-mode
                  (or (eq which-func-modes t)
                      (member major-mode which-func-modes))))))
    ;; Turn it off
    (remove-hook 'post-command-idle-hook 'which-func-update)
204
    (dolist (buf (buffer-list))
205
      (with-current-buffer buf (setq which-func-mode nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207

(defun which-function ()
Dave Love's avatar
Dave Love committed
208 209
  "Return current function name based on point.
If `imenu--index-alist' does not exist, or is empty  or if point
Richard M. Stallman's avatar
Richard M. Stallman committed
210
is located before first function, returns nil."
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
  (let (name)
    ;; First try using imenu support.
    (when (and (boundp 'imenu--index-alist) imenu--index-alist)
      (let ((pair (car-safe imenu--index-alist))
	    (rest (cdr-safe imenu--index-alist)))
	(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)))))
    ;; Try using add-log support.
    (when (and (null name) (boundp 'add-log-current-defun-function)
	       add-log-current-defun-function)
      (setq name (funcall add-log-current-defun-function)))
    ;; Filter the name if requested.
    (when name
      (if which-func-cleanup-function
	  (funcall which-func-cleanup-function name)
	name))))
Richard M. Stallman's avatar
Richard M. Stallman committed
231 232 233 234

(provide 'which-func)

;; which-func.el ends here