Mercurial > emacs
annotate lisp/which-func.el @ 21811:180afb14ad52
(main): Fix bug report address.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 28 Apr 1998 21:33:28 +0000 |
parents | ecfe9bc12b7f |
children | 79c7369b9ab4 |
rev | line source |
---|---|
20322 | 1 ;;; which-func.el --- Print current function in mode line |
20321 | 2 |
21697 | 3 ;; Copyright (C) 1994, 1997, 1998 Free Software Foundation, Inc. |
20321 | 4 |
5 ;; Author: Alex Rezinsky <alexr@msil.sps.mot.com> | |
21697 | 6 ;; Keywords: mode-line, imenu, tools |
20321 | 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 | |
21697 | 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. | |
20321 | 30 |
21697 | 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. | |
20321 | 38 |
21697 | 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: | |
20321 | 48 |
21697 | 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. | |
20321 | 60 |
21697 | 61 ;;; Code: |
62 | |
63 ;; Variables for customization | |
64 ;; --------------------------- | |
65 ;; | |
20321 | 66 (defvar which-func-unknown "???" |
67 "String to display in the mode line when current function is unknown.") | |
68 | |
21653
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
69 (defgroup which-func nil |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
70 "Mode to display the current function name in the modeline." |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
71 :group 'tools |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
72 :version "20.3") |
e95a88dc6110
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
20573
diff
changeset
|
73 |
20321 | 74 (defcustom which-func-modes |
75 '(emacs-lisp-mode c-mode c++-mode perl-mode makefile-mode sh-mode) | |
76 "List of major modes for which `which-func-mode' should be used. | |
77 For other modes it is disabled. If this is equal to t, | |
78 then current-function recognition is enabled in any mode." | |
79 :group 'which-func | |
80 :type '(choice (const :tag "All modes" t) | |
81 (list (symbol :tag "Major mode")))) | |
82 | |
83 (defcustom which-func-amodes '(emacs-lisp-mode c-mode c++-mode) | |
84 "List of major modes for which the Imenu menu should be computed automatically. | |
85 It is computed when you visit a file in one of these major modes. | |
86 If the variable's value is nil, then the Imenu menu is not computed | |
87 automatically in any mode. Note that the menu is never computed | |
88 automatically if the buffer size exceeds `which-func-maxout'." | |
89 :group 'which-func | |
90 :type '(list (symbol :tag "Major mode"))) | |
91 | |
92 (defcustom which-func-maxout 100000 | |
93 "Don't automatically compute the Imenu menu if buffer is this big or bigger. | |
94 Zero means compute the Imenu menu regardless of size." | |
95 :group 'which-func | |
96 :type 'integer) | |
97 | |
98 (defcustom which-func-format '(" [" which-func-current "]") | |
99 "Format for displaying the function in the mode line." | |
100 :group 'which-func | |
101 :type 'sexp) | |
102 | |
21697 | 103 ;;;###autoload |
104 (defcustom which-func-mode-global nil | |
105 "*Toggle `which-func-mode'. | |
106 You must modify via \\[customize] for this variable to have an effect." | |
107 :set #'(lambda (symbol value) | |
108 (which-func-mode (or value 0))) | |
109 :initialize 'custom-initialize-default | |
110 :type 'boolean | |
111 :group 'which-func | |
112 :require 'which-func) | |
113 | |
20321 | 114 ;;; Code, nothing to customize below here |
115 ;;; ------------------------------------- | |
116 ;;; | |
117 (require 'imenu) | |
118 | |
119 (defvar which-func-current which-func-unknown) | |
120 (defvar which-func-previous which-func-unknown) | |
121 (make-variable-buffer-local 'which-func-current) | |
122 (make-variable-buffer-local 'which-func-previous) | |
123 | |
124 (defvar which-func-mode nil | |
125 "Non-nil means display current function name in mode line. | |
21697 | 126 This makes a difference only if `which-func-mode-global' is non-nil") |
20321 | 127 (make-variable-buffer-local 'which-func-mode) |
128 (put 'which-func-mode 'permanent-local t) | |
129 | |
130 (add-hook 'find-file-hooks 'which-func-ff-hook t) | |
131 | |
132 (defun which-func-ff-hook () | |
133 "File find hook for Which Function mode. | |
134 It creates the Imenu index for the buffer, if necessary." | |
135 (if (or (eq which-func-modes t) (member major-mode which-func-modes)) | |
136 (setq which-func-mode which-func-mode-global) | |
137 (setq which-func-mode nil)) | |
138 | |
139 (if (and which-func-mode | |
140 (member major-mode which-func-amodes) | |
141 (or (< buffer-saved-size which-func-maxout) | |
142 (= which-func-maxout 0))) | |
143 (setq imenu--index-alist | |
144 (save-excursion (funcall imenu-create-index-function))))) | |
145 | |
146 (defun which-func-update () | |
147 ;; Update the string containing the current function. | |
148 (condition-case info | |
20573
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
149 (progn |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
150 (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
|
151 (setq which-func-current which-func-unknown)) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
152 (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
|
153 (progn |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
154 (force-mode-line-update) |
b46523ef0e0a
(which-func-update): Fix paren error.
Richard M. Stallman <rms@gnu.org>
parents:
20322
diff
changeset
|
155 (setq which-func-previous which-func-current)))) |
20321 | 156 (error |
157 (ding) | |
158 (remove-hook 'post-command-hook 'which-func-update) | |
159 (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
|
160 (message "Error in which-func-update: %s" info)))) |
20321 | 161 |
21697 | 162 ;;;###autoload |
20321 | 163 (defun which-func-mode (&optional arg) |
164 "Toggle Which Function mode, globally. | |
165 When Which Function mode is enabled, the current function name is | |
166 continuously displayed in the mode line, in certain major modes. | |
167 | |
168 With prefix arg, turn Which Function mode on iff arg is positive, | |
169 and off otherwise." | |
170 (interactive "P") | |
171 (if (or (and (null arg) which-func-mode-global) | |
172 (<= (prefix-numeric-value arg) 0)) | |
173 ;; Turn it off | |
174 (if which-func-mode-global | |
175 (progn | |
176 (remove-hook 'post-command-hook 'which-func-update) | |
177 (setq which-func-mode-global nil) | |
178 (setq which-func-mode nil) | |
179 (force-mode-line-update))) | |
180 ;;Turn it on | |
181 (if which-func-mode-global | |
182 () | |
183 (add-hook 'post-command-hook 'which-func-update) | |
184 (setq which-func-mode-global t) | |
185 (setq which-func-mode | |
186 (or (eq which-func-modes t) | |
187 (member major-mode which-func-modes)))))) | |
188 | |
189 (defun which-function () | |
21697 | 190 "Return current function name based on point. |
191 If `imenu--index-alist' does not exist, or is empty or if point | |
20321 | 192 is located before first function, returns nil." |
193 (and | |
194 (boundp 'imenu--index-alist) | |
195 imenu--index-alist | |
196 (let ((pair (car-safe imenu--index-alist)) | |
197 (rest (cdr-safe imenu--index-alist)) | |
198 (name nil)) | |
199 (while (and pair (or (not (number-or-marker-p (cdr pair))) | |
200 (> (point) (cdr pair)))) | |
201 (setq name (car pair)) | |
202 (setq pair (car-safe rest)) | |
203 (setq rest (cdr-safe rest))) | |
204 name))) | |
205 | |
206 (provide 'which-func) | |
207 | |
208 ;; which-func.el ends here |