Commit | Line | Data |
---|---|---|
95044490 | 1 | ;;; which-func.el --- Print current function in mode line |
d6d2fa1f | 2 | |
0211dda3 | 3 | ;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc. |
d6d2fa1f RS |
4 | |
5 | ;; Author: Alex Rezinsky <alexr@msil.sps.mot.com> | |
0211dda3 | 6 | ;; Keywords: mode-line, imenu, tools |
d6d2fa1f RS |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
24 | ||
0211dda3 DL |
25 | ;;; Commentary: |
26 | ||
27 | ;; This package prints name of function where your current point is | |
28 | ;; located in mode line. It assumes that you work with imenu package | |
29 | ;; and imenu--index-alist is up to date. | |
30 | ||
31 | ;; KNOWN BUGS | |
32 | ;; ---------- | |
33 | ;; Really this package shows not "function where the current point is | |
34 | ;; located now", but "nearest function which defined above the current | |
35 | ;; point". So if your current point is located after end of function | |
36 | ;; FOO but before begin of function BAR, FOO will be displayed in mode | |
37 | ;; line. | |
38 | ||
39 | ;; TODO LIST | |
40 | ;; --------- | |
41 | ;; 1. Dependence on imenu package should be removed. Separate | |
42 | ;; function determination mechanism should be used to determine the end | |
43 | ;; of a function as well as the beginning of a function. | |
44 | ;; 2. This package should be realized with the help of overlay | |
45 | ;; properties instead of imenu--index-alist variable. | |
46 | ||
47 | ;;; History: | |
48 | ||
49 | ;; THANKS TO | |
50 | ;; --------- | |
51 | ;; Per Abrahamsen <abraham@iesd.auc.dk> | |
52 | ;; Some ideas (inserting in mode-line, using of post-command hook | |
53 | ;; and toggling this mode) have been borrowed from his package | |
54 | ;; column.el | |
55 | ;; Peter Eisenhauer <pipe@fzi.de> | |
56 | ;; Bug fixing in case nested indexes. | |
57 | ;; Terry Tateyama <ttt@ursa0.cs.utah.edu> | |
58 | ;; Suggestion to use find-file-hooks for first imenu | |
59 | ;; index building. | |
60 | ||
61 | ;;; Code: | |
62 | ||
63 | ;; Variables for customization | |
64 | ;; --------------------------- | |
65 | ;; | |
d6d2fa1f RS |
66 | (defvar which-func-unknown "???" |
67 | "String to display in the mode line when current function is unknown.") | |
68 | ||
daa02ea5 DN |
69 | (defgroup which-func nil |
70 | "Mode to display the current function name in the modeline." | |
71 | :group 'tools | |
72 | :version "20.3") | |
73 | ||
d6d2fa1f | 74 | (defcustom which-func-modes |
70066cfd RS |
75 | '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode |
76 | fortran-mode) | |
5686b9d4 | 77 | "List of major modes for which Which Function mode should be used. |
d6d2fa1f | 78 | For other modes it is disabled. If this is equal to t, |
5686b9d4 | 79 | then Which Function mode is enabled in any major mode that supports it." |
d6d2fa1f RS |
80 | :group 'which-func |
81 | :type '(choice (const :tag "All modes" t) | |
5686b9d4 | 82 | (repeat (symbol :tag "Major mode")))) |
d6d2fa1f | 83 | |
4962cb1a RS |
84 | (defcustom which-func-non-auto-modes nil |
85 | "List of major modes where Which Function mode is inactive till Imenu is used. | |
5686b9d4 RS |
86 | This means that Which Function mode won't really do anything |
87 | until you use Imenu, in these modes. Note that files | |
88 | larger than `which-func-maxout' behave in this way too; | |
89 | Which Function mode doesn't do anything until you use Imenu." | |
d6d2fa1f | 90 | :group 'which-func |
5686b9d4 | 91 | :type '(repeat (symbol :tag "Major mode"))) |
d6d2fa1f RS |
92 | |
93 | (defcustom which-func-maxout 100000 | |
94 | "Don't automatically compute the Imenu menu if buffer is this big or bigger. | |
95 | Zero means compute the Imenu menu regardless of size." | |
96 | :group 'which-func | |
97 | :type 'integer) | |
98 | ||
99 | (defcustom which-func-format '(" [" which-func-current "]") | |
100 | "Format for displaying the function in the mode line." | |
101 | :group 'which-func | |
102 | :type 'sexp) | |
103 | ||
0211dda3 DL |
104 | ;;;###autoload |
105 | (defcustom which-func-mode-global nil | |
739db504 DL |
106 | "*Toggle `which-func-mode' globally. |
107 | Setting this variable directly does not take effect; | |
108 | use either \\[customize] or the function `which-func-mode'." | |
0211dda3 | 109 | :set #'(lambda (symbol value) |
2b7b0d15 | 110 | (which-func-mode (if value 1 0))) |
0211dda3 DL |
111 | :initialize 'custom-initialize-default |
112 | :type 'boolean | |
113 | :group 'which-func | |
114 | :require 'which-func) | |
115 | ||
1e68f8d0 RS |
116 | (defvar which-func-cleanup-function nil |
117 | "Function to transform a string before displaying it in the mode line. | |
118 | The function is called with one argument, the string to display. | |
119 | Its return value is displayed in the modeline. | |
120 | If nil, no function is called. The default value is nil. | |
121 | ||
122 | This feature can be useful if Imenu is set up to make more | |
123 | detailed entries (e.g., containing the argument list of a function), | |
124 | and you want to simplify them for the mode line | |
125 | \(e.g., removing the parameter list to just have the function name.)") | |
126 | ||
d6d2fa1f RS |
127 | ;;; Code, nothing to customize below here |
128 | ;;; ------------------------------------- | |
129 | ;;; | |
130 | (require 'imenu) | |
131 | ||
132 | (defvar which-func-current which-func-unknown) | |
133 | (defvar which-func-previous which-func-unknown) | |
134 | (make-variable-buffer-local 'which-func-current) | |
135 | (make-variable-buffer-local 'which-func-previous) | |
136 | ||
d6d2fa1f RS |
137 | (defvar which-func-mode nil |
138 | "Non-nil means display current function name in mode line. | |
0211dda3 | 139 | This makes a difference only if `which-func-mode-global' is non-nil") |
d6d2fa1f RS |
140 | (make-variable-buffer-local 'which-func-mode) |
141 | (put 'which-func-mode 'permanent-local t) | |
142 | ||
143 | (add-hook 'find-file-hooks 'which-func-ff-hook t) | |
144 | ||
145 | (defun which-func-ff-hook () | |
146 | "File find hook for Which Function mode. | |
147 | It creates the Imenu index for the buffer, if necessary." | |
148 | (if (or (eq which-func-modes t) (member major-mode which-func-modes)) | |
149 | (setq which-func-mode which-func-mode-global) | |
150 | (setq which-func-mode nil)) | |
151 | ||
2576f5d2 KH |
152 | (condition-case nil |
153 | (if (and which-func-mode | |
154 | (not (member major-mode which-func-non-auto-modes)) | |
155 | (or (< buffer-saved-size which-func-maxout) | |
156 | (= which-func-maxout 0))) | |
157 | (setq imenu--index-alist | |
158 | (save-excursion (funcall imenu-create-index-function)))) | |
159 | (error | |
160 | (setq which-func-mode nil)))) | |
d6d2fa1f RS |
161 | |
162 | (defun which-func-update () | |
163 | ;; Update the string containing the current function. | |
164 | (condition-case info | |
c5059c2c RS |
165 | (progn |
166 | (if (not (setq which-func-current (which-function))) | |
167 | (setq which-func-current which-func-unknown)) | |
168 | (if (not (string= which-func-current which-func-previous)) | |
169 | (progn | |
170 | (force-mode-line-update) | |
171 | (setq which-func-previous which-func-current)))) | |
d6d2fa1f RS |
172 | (error |
173 | (ding) | |
174 | (remove-hook 'post-command-hook 'which-func-update) | |
175 | (which-func-mode -1) ; Function mode off | |
c5059c2c | 176 | (message "Error in which-func-update: %s" info)))) |
d6d2fa1f | 177 | |
4ed0c28d RS |
178 | ;; This is the name people would normally expect. |
179 | ;;;###autoload | |
180 | (defalias 'which-function-mode 'which-func-mode) | |
181 | ||
0211dda3 | 182 | ;;;###autoload |
d6d2fa1f RS |
183 | (defun which-func-mode (&optional arg) |
184 | "Toggle Which Function mode, globally. | |
185 | When Which Function mode is enabled, the current function name is | |
186 | continuously displayed in the mode line, in certain major modes. | |
187 | ||
188 | With prefix arg, turn Which Function mode on iff arg is positive, | |
189 | and off otherwise." | |
190 | (interactive "P") | |
191 | (if (or (and (null arg) which-func-mode-global) | |
192 | (<= (prefix-numeric-value arg) 0)) | |
193 | ;; Turn it off | |
194 | (if which-func-mode-global | |
195 | (progn | |
196 | (remove-hook 'post-command-hook 'which-func-update) | |
197 | (setq which-func-mode-global nil) | |
198 | (setq which-func-mode nil) | |
199 | (force-mode-line-update))) | |
200 | ;;Turn it on | |
201 | (if which-func-mode-global | |
202 | () | |
203 | (add-hook 'post-command-hook 'which-func-update) | |
204 | (setq which-func-mode-global t) | |
205 | (setq which-func-mode | |
206 | (or (eq which-func-modes t) | |
207 | (member major-mode which-func-modes)))))) | |
208 | ||
209 | (defun which-function () | |
0211dda3 DL |
210 | "Return current function name based on point. |
211 | If `imenu--index-alist' does not exist, or is empty or if point | |
d6d2fa1f RS |
212 | is located before first function, returns nil." |
213 | (and | |
214 | (boundp 'imenu--index-alist) | |
215 | imenu--index-alist | |
216 | (let ((pair (car-safe imenu--index-alist)) | |
217 | (rest (cdr-safe imenu--index-alist)) | |
218 | (name nil)) | |
d1804b71 KH |
219 | (while (and (or rest pair) |
220 | (or (not (number-or-marker-p (cdr pair))) | |
221 | (> (point) (cdr pair)))) | |
d6d2fa1f RS |
222 | (setq name (car pair)) |
223 | (setq pair (car-safe rest)) | |
224 | (setq rest (cdr-safe rest))) | |
1e68f8d0 RS |
225 | (and name |
226 | (if which-func-cleanup-function | |
227 | (funcall which-func-cleanup-function name) | |
228 | name))))) | |
d6d2fa1f RS |
229 | |
230 | (provide 'which-func) | |
231 | ||
232 | ;; which-func.el ends here |