Mercurial > emacs
annotate lisp/which-func.el @ 21689:95c0fe8d25a7
(easy-menu-do-add-item):
Do the right thing when nil is specified as criterion for activeness.
Fix string used to report an invalid item.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 21 Apr 1998 04:54:46 +0000 |
parents | e95a88dc6110 |
children | ecfe9bc12b7f |
rev | line source |
---|---|
20322 | 1 ;;; which-func.el --- Print current function in mode line |
20321 | 2 |
3 ;; Copyright (C) 1994, 1997 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Alex Rezinsky <alexr@msil.sps.mot.com> | |
6 ;; Keywords: mode-line imenu | |
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 | |
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 | |
34 ;;; is located now", but "nearest function which defined above the | |
35 ;;; current point". So if your current point is located after end of | |
36 ;;; function FOO but before begin of function BAR, FOO will be | |
37 ;;; displayed in mode 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 ;;; THANKS TO | |
48 ;;; --------- | |
49 ;;; Per Abrahamsen <abraham@iesd.auc.dk> | |
50 ;;; Some ideas (inserting in mode-line, using of post-command hook | |
51 ;;; and toggling this mode) have been borrowed from his package | |
52 ;;; column.el | |
53 ;;; Peter Eisenhauer <pipe@fzi.de> | |
54 ;;; Bug fixing in case nested indexes. | |
55 ;;; Terry Tateyama <ttt@ursa0.cs.utah.edu> | |
56 ;;; Suggestion to use find-file-hooks for first imenu | |
57 ;;; index building. | |
58 | |
59 ;;; Variables for customization | |
60 ;;; --------------------------- | |
61 ;;; | |
62 (defvar which-func-unknown "???" | |
63 "String to display in the mode line when current function is unknown.") | |
64 | |
21653
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
65 (defgroup which-func nil |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
66 "Mode to display the current function name in the modeline." |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
67 :group 'tools |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
68 :version "20.3") |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
69 |
20321 | 70 (defcustom which-func-modes |
71 '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode) | |
72 "List of major modes for which `which-func-mode' should be used. | |
73 For other modes it is disabled. If this is equal to t, | |
74 then current-function recognition is enabled in any mode." | |
75 :group 'which-func | |
76 :type '(choice (const :tag "All modes" t) | |
77 (list (symbol :tag "Major mode")))) | |
78 | |
79 (defcustom which-func-amodes '(emacs-lisp-mode c-mode c++-mode) | |
80 "List of major modes for which the Imenu menu should be computed automatically. | |
81 It is computed when you visit a file in one of these major modes. | |
82 If the variable's value is nil, then the Imenu menu is not computed | |
83 automatically in any mode. Note that the menu is never computed | |
84 automatically if the buffer size exceeds `which-func-maxout'." | |
85 :group 'which-func | |
86 :type '(list (symbol :tag "Major mode"))) | |
87 | |
88 (defcustom which-func-maxout 100000 | |
89 "Don't automatically compute the Imenu menu if buffer is this big or bigger. | |
90 Zero means compute the Imenu menu regardless of size." | |
91 :group 'which-func | |
92 :type 'integer) | |
93 | |
94 (defcustom which-func-format '(" [" which-func-current "]") | |
95 "Format for displaying the function in the mode line." | |
96 :group 'which-func | |
97 :type 'sexp) | |
98 | |
99 ;;; Code, nothing to customize below here | |
100 ;;; ------------------------------------- | |
101 ;;; | |
102 (require 'imenu) | |
103 | |
104 (defvar which-func-current which-func-unknown) | |
105 (defvar which-func-previous which-func-unknown) | |
106 (make-variable-buffer-local 'which-func-current) | |
107 (make-variable-buffer-local 'which-func-previous) | |
108 | |
109 (defvar which-func-mode-global nil | |
110 "Non-nil means display current function name in mode line.") | |
111 | |
112 (defvar which-func-mode nil | |
113 "Non-nil means display current function name in mode line. | |
114 This makes a difference only if which-func-mode-global is non-nil") | |
115 (make-variable-buffer-local 'which-func-mode) | |
116 (put 'which-func-mode 'permanent-local t) | |
117 | |
118 (add-hook 'find-file-hooks 'which-func-ff-hook t) | |
119 | |
120 (defun which-func-ff-hook () | |
121 "File find hook for Which Function mode. | |
122 It creates the Imenu index for the buffer, if necessary." | |
123 (if (or (eq which-func-modes t) (member major-mode which-func-modes)) | |
124 (setq which-func-mode which-func-mode-global) | |
125 (setq which-func-mode nil)) | |
126 | |
127 (if (and which-func-mode | |
128 (member major-mode which-func-amodes) | |
129 (or (< buffer-saved-size which-func-maxout) | |
130 (= which-func-maxout 0))) | |
131 (setq imenu--index-alist | |
132 (save-excursion (funcall imenu-create-index-function))))) | |
133 | |
134 (defun which-func-update () | |
135 ;; Update the string containing the current function. | |
136 (condition-case info | |
20573
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
137 (progn |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
138 (if (not (setq which-func-current (which-function))) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
139 (setq which-func-current which-func-unknown)) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
140 (if (not (string= which-func-current which-func-previous)) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
141 (progn |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
142 (force-mode-line-update) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
143 (setq which-func-previous which-func-current)))) |
20321 | 144 (error |
145 (ding) | |
146 (remove-hook 'post-command-hook 'which-func-update) | |
147 (which-func-mode -1) ; Function mode off | |
20573
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
148 (message "Error in which-func-update: %s" info)))) |
20321 | 149 |
150 (defun which-func-mode (&optional arg) | |
151 "Toggle Which Function mode, globally. | |
152 When Which Function mode is enabled, the current function name is | |
153 continuously displayed in the mode line, in certain major modes. | |
154 | |
155 With prefix arg, turn Which Function mode on iff arg is positive, | |
156 and off otherwise." | |
157 (interactive "P") | |
158 (if (or (and (null arg) which-func-mode-global) | |
159 (<= (prefix-numeric-value arg) 0)) | |
160 ;; Turn it off | |
161 (if which-func-mode-global | |
162 (progn | |
163 (remove-hook 'post-command-hook 'which-func-update) | |
164 (setq which-func-mode-global nil) | |
165 (setq which-func-mode nil) | |
166 (force-mode-line-update))) | |
167 ;;Turn it on | |
168 (if which-func-mode-global | |
169 () | |
170 (add-hook 'post-command-hook 'which-func-update) | |
171 (setq which-func-mode-global t) | |
172 (setq which-func-mode | |
173 (or (eq which-func-modes t) | |
174 (member major-mode which-func-modes)))))) | |
175 | |
176 (defun which-function () | |
177 "Returns current function name based on point. | |
178 If imenu--index-alist does not exist, or is empty or if point | |
179 is located before first function, returns nil." | |
180 (and | |
181 (boundp 'imenu--index-alist) | |
182 imenu--index-alist | |
183 (let ((pair (car-safe imenu--index-alist)) | |
184 (rest (cdr-safe imenu--index-alist)) | |
185 (name nil)) | |
186 (while (and pair (or (not (number-or-marker-p (cdr pair))) | |
187 (> (point) (cdr pair)))) | |
188 (setq name (car pair)) | |
189 (setq pair (car-safe rest)) | |
190 (setq rest (cdr-safe rest))) | |
191 name))) | |
192 | |
193 (provide 'which-func) | |
194 | |
195 ;; which-func.el ends here |