which-func.el 7.46 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>
Dave Love's avatar
Dave Love committed
6
;; Keywords: mode-line, imenu, tools
Richard M. Stallman's avatar
Richard M. Stallman committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

;; 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
25 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
;;; 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
66 67 68
(defvar which-func-unknown "???"
  "String to display in the mode line when current function is unknown.")

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

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

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

(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)

(defcustom which-func-format '(" [" which-func-current "]")
  "Format for displaying the function in the mode line."
  :group 'which-func
  :type 'sexp)

Dave Love's avatar
Dave Love committed
104 105 106
;;;###autoload
(defcustom which-func-mode-global nil
  "*Toggle `which-func-mode'.
107
This variable should be set only with \\[customize], which is equivalent
Karl Heuer's avatar
Karl Heuer committed
108
to using the function `which-func-mode'."
Dave Love's avatar
Dave Love committed
109
  :set #'(lambda (symbol value)
110
	   (which-func-mode (if value 1 0)))
Dave Love's avatar
Dave Love committed
111 112 113 114 115
  :initialize 'custom-initialize-default
  :type    'boolean
  :group   'which-func
  :require 'which-func)

Richard M. Stallman's avatar
Richard M. Stallman committed
116 117 118 119 120 121 122 123 124 125 126 127
;;; 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
128
This makes a difference only if `which-func-mode-global' is non-nil")
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132 133 134 135 136 137 138 139 140
(make-variable-buffer-local 'which-func-mode)
(put 'which-func-mode 'permanent-local t)

(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."
  (if (or (eq which-func-modes t) (member major-mode which-func-modes))
      (setq which-func-mode which-func-mode-global)
    (setq which-func-mode nil))

141 142 143 144 145 146 147 148 149
  (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))))
Richard M. Stallman's avatar
Richard M. Stallman committed
150 151 152 153

(defun which-func-update ()
  ;; Update the string containing the current function.
  (condition-case info
154 155 156 157 158 159 160
      (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))))
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162 163 164
    (error
     (ding)
     (remove-hook 'post-command-hook 'which-func-update)
     (which-func-mode -1)   ; Function mode off
165
     (message "Error in which-func-update: %s" info))))
Richard M. Stallman's avatar
Richard M. Stallman committed
166

167 168 169 170
;; This is the name people would normally expect.
;;;###autoload
(defalias 'which-function-mode 'which-func-mode)

Dave Love's avatar
Dave Love committed
171
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
(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.

With prefix arg, turn Which Function mode on iff arg is positive,
and off otherwise."
  (interactive "P")
  (if (or (and (null arg) which-func-mode-global)
          (<= (prefix-numeric-value arg) 0))
      ;; Turn it off
      (if which-func-mode-global
          (progn
            (remove-hook 'post-command-hook 'which-func-update)
            (setq which-func-mode-global nil)
            (setq which-func-mode nil)
            (force-mode-line-update)))
    ;;Turn it on
    (if which-func-mode-global
        ()
      (add-hook 'post-command-hook 'which-func-update)
      (setq which-func-mode-global t)
      (setq which-func-mode
	    (or (eq which-func-modes t)
		(member major-mode which-func-modes))))))

(defun which-function ()
Dave Love's avatar
Dave Love committed
199 200
  "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
201 202 203 204 205 206 207
is located before first function, returns nil."
  (and
   (boundp 'imenu--index-alist)
   imenu--index-alist
   (let ((pair (car-safe imenu--index-alist))
         (rest (cdr-safe imenu--index-alist))
         (name nil))
208 209 210
     (while (and (or rest pair)
		 (or (not (number-or-marker-p (cdr pair)))
		     (> (point) (cdr pair))))
Richard M. Stallman's avatar
Richard M. Stallman committed
211 212 213 214 215 216 217 218
       (setq name (car pair))
       (setq pair (car-safe rest))
       (setq rest (cdr-safe rest)))
     name)))

(provide 'which-func)

;; which-func.el ends here