Mercurial > emacs
annotate lisp/progmodes/which-func.el @ 110855:bec49af30c2f
Merge changes from emacs-23 branch.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Fri, 08 Oct 2010 12:14:47 +0200 |
parents | b1689e2cce22 |
children | 7bd5c179aeff |
rev | line source |
---|---|
51349 | 1 ;;; which-func.el --- print current function in mode line |
2 | |
98407
352e7f3ed660
(which-func-imenu-joiner-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
98406
diff
changeset
|
3 ;; Copyright (C) 1994, 1997, 1998, 2001, 2002, 2003, 2004, 2005, 2006 |
106815 | 4 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
51349 | 5 |
6 ;; Author: Alex Rezinsky <alexr@msil.sps.mot.com> | |
7 ;; (doesn't seem to be responsive any more) | |
8 ;; Keywords: mode-line, imenu, tools | |
9 | |
10 ;; This file is part of GNU Emacs. | |
11 | |
94673
52b7a8c22af5
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
12 ;; GNU Emacs is free software: you can redistribute it and/or modify |
51349 | 13 ;; it under the terms of the GNU General Public License as published by |
94673
52b7a8c22af5
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
14 ;; the Free Software Foundation, either version 3 of the License, or |
52b7a8c22af5
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
15 ;; (at your option) any later version. |
51349 | 16 |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
94673
52b7a8c22af5
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
51349 | 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 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 ;; - if two windows display the same buffer, both windows | |
39 ;; show the same `which-func' information. | |
40 | |
41 ;; TODO LIST | |
42 ;; --------- | |
43 ;; 1. Dependence on imenu package should be removed. Separate | |
44 ;; function determination mechanism should be used to determine the end | |
45 ;; of a function as well as the beginning of a function. | |
46 ;; 2. This package should be realized with the help of overlay | |
47 ;; properties instead of imenu--index-alist variable. | |
48 | |
49 ;;; History: | |
50 | |
51 ;; THANKS TO | |
52 ;; --------- | |
53 ;; Per Abrahamsen <abraham@iesd.auc.dk> | |
54 ;; Some ideas (inserting in mode-line, using of post-command hook | |
55 ;; and toggling this mode) have been borrowed from his package | |
56 ;; column.el | |
57 ;; Peter Eisenhauer <pipe@fzi.de> | |
58 ;; Bug fixing in case nested indexes. | |
59 ;; Terry Tateyama <ttt@ursa0.cs.utah.edu> | |
60 ;; Suggestion to use find-file-hook for first imenu | |
61 ;; index building. | |
62 | |
63 ;;; Code: | |
64 | |
65 ;; Variables for customization | |
66 ;; --------------------------- | |
67 ;; | |
68 (defvar which-func-unknown "???" | |
69 "String to display in the mode line when current function is unknown.") | |
70 | |
71 (defgroup which-func nil | |
72 "Mode to display the current function name in the modeline." | |
73 :group 'tools | |
74 :version "20.3") | |
75 | |
76 (defcustom which-func-modes | |
81825
69b5e2969dfe
(which-func-modes): Add `python-mode'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
75347
diff
changeset
|
77 '(emacs-lisp-mode c-mode c++-mode perl-mode cperl-mode python-mode |
84390
28620c3d5a1a
Added diff-mode to `which-func-modes'.
Masatake YAMATO <jet@gyve.org>
parents:
82365
diff
changeset
|
78 makefile-mode sh-mode fortran-mode f90-mode ada-mode |
28620c3d5a1a
Added diff-mode to `which-func-modes'.
Masatake YAMATO <jet@gyve.org>
parents:
82365
diff
changeset
|
79 diff-mode) |
51349 | 80 "List of major modes for which Which Function mode should be used. |
81 For other modes it is disabled. If this is equal to t, | |
82 then Which Function mode is enabled in any major mode that supports it." | |
83 :group 'which-func | |
84 :type '(choice (const :tag "All modes" t) | |
85 (repeat (symbol :tag "Major mode")))) | |
86 | |
87 (defcustom which-func-non-auto-modes nil | |
88 "List of major modes where Which Function mode is inactive till Imenu is used. | |
89 This means that Which Function mode won't really do anything | |
90 until you use Imenu, in these modes. Note that files | |
91 larger than `which-func-maxout' behave in this way too; | |
92 Which Function mode doesn't do anything until you use Imenu." | |
93 :group 'which-func | |
94 :type '(repeat (symbol :tag "Major mode"))) | |
95 | |
96 (defcustom which-func-maxout 500000 | |
97 "Don't automatically compute the Imenu menu if buffer is this big or bigger. | |
98 Zero means compute the Imenu menu regardless of size." | |
99 :group 'which-func | |
100 :type 'integer) | |
101 | |
56442
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
102 (defvar which-func-keymap |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
103 (let ((map (make-sparse-keymap))) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
104 (define-key map [mode-line mouse-1] 'beginning-of-defun) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
105 (define-key map [mode-line mouse-2] |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
106 (lambda () |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
107 (interactive) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
108 (if (eq (point-min) 1) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
109 (narrow-to-defun) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
110 (widen)))) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
111 (define-key map [mode-line mouse-3] 'end-of-defun) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
112 map) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
113 "Keymap to display on mode line which-func.") |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
114 |
63457
581fdd0b552d
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-417
Miles Bader <miles@gnu.org>
parents:
62858
diff
changeset
|
115 (defface which-func |
63463
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
116 ;; Whether `font-lock-function-name-face' is an appropriate face to |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
117 ;; inherit depends on the mode-line face; define several variants based |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
118 ;; on the default mode-line face. |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
119 '(;; The default mode-line face on a high-color display is a relatively |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
120 ;; light color ("grey75"), and only the light-background variant of |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
121 ;; `font-lock-function-name-face' is visible against it. |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
122 (((class color) (min-colors 88) (background light)) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
123 :inherit font-lock-function-name-face) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
124 ;; The default mode-line face on other display types is inverse-video; |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
125 ;; it seems that only in the dark-background case is |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
126 ;; `font-lock-function-name-face' visible against it. |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
127 (((class grayscale mono) (background dark)) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
128 :inherit font-lock-function-name-face) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
129 (((class color) (background light)) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
130 :inherit font-lock-function-name-face) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
131 ;; If none of the above cases, use an explicit color chosen to contrast |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
132 ;; well with the default mode-line face. |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
133 (((class color) (min-colors 88) (background dark)) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
134 :foreground "Blue1") |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
135 (((background dark)) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
136 :foreground "Blue1") |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
137 (t |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
138 :foreground "LightSkyBlue")) |
ad343539d42b
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-421
Miles Bader <miles@gnu.org>
parents:
63457
diff
changeset
|
139 "Face used to highlight mode line function names." |
56442
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
140 :group 'which-func) |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
141 |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
142 (defcustom which-func-format |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
143 `("[" |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
144 (:propertize which-func-current |
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
145 local-map ,which-func-keymap |
63457
581fdd0b552d
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-417
Miles Bader <miles@gnu.org>
parents:
62858
diff
changeset
|
146 face which-func |
56442
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
147 ;;mouse-face highlight ; currently not evaluated :-( |
109708
b1689e2cce22
which-func.el (which-func-format): Split help-echo text into lines.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
148 help-echo "mouse-1: go to beginning\n\ |
b1689e2cce22
which-func.el (which-func-format): Split help-echo text into lines.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
149 mouse-2: toggle rest visibility\n\ |
b1689e2cce22
which-func.el (which-func-format): Split help-echo text into lines.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
150 mouse-3: go to end") |
56442
e8032355ca23
(which-func-keymap): New var.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
53618
diff
changeset
|
151 "]") |
51349 | 152 "Format for displaying the function in the mode line." |
153 :group 'which-func | |
154 :type 'sexp) | |
155 ;;;###autoload (put 'which-func-format 'risky-local-variable t) | |
156 | |
98406
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
157 (defvar which-func-imenu-joiner-function #'last |
98407
352e7f3ed660
(which-func-imenu-joiner-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
98406
diff
changeset
|
158 "Function to join together multiple levels of imenu nomenclature. |
352e7f3ed660
(which-func-imenu-joiner-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
98406
diff
changeset
|
159 Called with a single argument, a list of strings giving the names |
352e7f3ed660
(which-func-imenu-joiner-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
98406
diff
changeset
|
160 of the menus we had to traverse to get to the item. Returns a |
352e7f3ed660
(which-func-imenu-joiner-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
98406
diff
changeset
|
161 single string, the new name of the item.") |
98406
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
162 |
51349 | 163 (defvar which-func-cleanup-function nil |
164 "Function to transform a string before displaying it in the mode line. | |
165 The function is called with one argument, the string to display. | |
166 Its return value is displayed in the modeline. | |
167 If nil, no function is called. The default value is nil. | |
168 | |
169 This feature can be useful if Imenu is set up to make more | |
170 detailed entries (e.g., containing the argument list of a function), | |
171 and you want to simplify them for the mode line | |
172 \(e.g., removing the parameter list to just have the function name.)") | |
173 | |
174 ;;; Code, nothing to customize below here | |
175 ;;; ------------------------------------- | |
176 ;;; | |
177 (require 'imenu) | |
178 | |
179 (defvar which-func-table (make-hash-table :test 'eq :weakness 'key)) | |
180 | |
181 (defconst which-func-current | |
182 '(:eval (gethash (selected-window) which-func-table which-func-unknown))) | |
183 ;;;###autoload (put 'which-func-current 'risky-local-variable t) | |
184 | |
185 (defvar which-func-mode nil | |
186 "Non-nil means display current function name in mode line. | |
187 This makes a difference only if `which-function-mode' is non-nil.") | |
188 (make-variable-buffer-local 'which-func-mode) | |
189 ;;(put 'which-func-mode 'permanent-local t) | |
190 | |
191 (add-hook 'find-file-hook 'which-func-ff-hook t) | |
192 | |
193 (defun which-func-ff-hook () | |
194 "File find hook for Which Function mode. | |
195 It creates the Imenu index for the buffer, if necessary." | |
196 (setq which-func-mode | |
197 (and which-function-mode | |
198 (or (eq which-func-modes t) | |
199 (member major-mode which-func-modes)))) | |
200 | |
201 (condition-case nil | |
202 (if (and which-func-mode | |
203 (not (member major-mode which-func-non-auto-modes)) | |
204 (or (null which-func-maxout) | |
205 (< buffer-saved-size which-func-maxout) | |
206 (= which-func-maxout 0))) | |
207 (setq imenu--index-alist | |
208 (save-excursion (funcall imenu-create-index-function)))) | |
209 (error | |
210 (setq which-func-mode nil)))) | |
211 | |
212 (defun which-func-update () | |
213 ;; "Update the Which-Function mode display for all windows." | |
214 ;; (walk-windows 'which-func-update-1 nil 'visible)) | |
215 (which-func-update-1 (selected-window))) | |
216 | |
217 (defun which-func-update-1 (window) | |
56689
f54e121491eb
(which-func-update-1): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
56442
diff
changeset
|
218 "Update the Which Function mode display for window WINDOW." |
51349 | 219 (with-selected-window window |
220 (when which-func-mode | |
221 (condition-case info | |
222 (let ((current (which-function))) | |
223 (unless (equal current (gethash window which-func-table)) | |
224 (puthash window current which-func-table) | |
225 (force-mode-line-update))) | |
226 (error | |
62858
c23f28be371c
(which-func-update-1): Turn the mode
Richard M. Stallman <rms@gnu.org>
parents:
61089
diff
changeset
|
227 (setq which-func-mode nil) |
51349 | 228 (error "Error in which-func-update: %s" info)))))) |
229 | |
230 ;;;###autoload | |
231 (defalias 'which-func-mode 'which-function-mode) | |
232 | |
233 (defvar which-func-update-timer nil) | |
234 | |
235 ;; This is the name people would normally expect. | |
236 ;;;###autoload | |
237 (define-minor-mode which-function-mode | |
238 "Toggle Which Function mode, globally. | |
239 When Which Function mode is enabled, the current function name is | |
240 continuously displayed in the mode line, in certain major modes. | |
241 | |
78487
419c5c316b51
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78234
diff
changeset
|
242 With prefix ARG, turn Which Function mode on if arg is positive, |
51349 | 243 and off otherwise." |
244 :global t :group 'which-func | |
245 (if which-function-mode | |
246 ;;Turn it on | |
247 (progn | |
248 (setq which-func-update-timer | |
249 (run-with-idle-timer idle-update-delay t 'which-func-update)) | |
250 (dolist (buf (buffer-list)) | |
251 (with-current-buffer buf | |
252 (setq which-func-mode | |
253 (or (eq which-func-modes t) | |
254 (member major-mode which-func-modes)))))) | |
255 ;; Turn it off | |
53618
bd715b02e44e
David Ponce <david@dponce.com>
Glenn Morris <rgm@gnu.org>
parents:
52691
diff
changeset
|
256 (when (timerp which-func-update-timer) |
bd715b02e44e
David Ponce <david@dponce.com>
Glenn Morris <rgm@gnu.org>
parents:
52691
diff
changeset
|
257 (cancel-timer which-func-update-timer)) |
51349 | 258 (setq which-func-update-timer nil) |
259 (dolist (buf (buffer-list)) | |
260 (with-current-buffer buf (setq which-func-mode nil))))) | |
261 | |
262 (defvar which-function-imenu-failed nil | |
263 "Locally t in a buffer if `imenu--make-index-alist' found nothing there.") | |
264 | |
52691
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
265 (defvar which-func-functions nil |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
266 "List of functions for `which-function' to call with no arguments. |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
267 It calls them sequentially, and if any returns non-nil, |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
268 `which-function' uses that name and stops looking for the name.") |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
269 |
51349 | 270 (defun which-function () |
271 "Return current function name based on point. | |
72144
2824d0383afd
(which-function): Fix documentation/comment typo.
Nick Roberts <nickrob@snap.net.nz>
parents:
68773
diff
changeset
|
272 Uses `which-func-functions', `imenu--index-alist' |
52691
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
273 or `add-log-current-defun-function'. |
51349 | 274 If no function name is found, return nil." |
58774 | 275 (let ((name |
72144
2824d0383afd
(which-function): Fix documentation/comment typo.
Nick Roberts <nickrob@snap.net.nz>
parents:
68773
diff
changeset
|
276 ;; Try the `which-func-functions' functions first. |
58774 | 277 (run-hook-with-args-until-success 'which-func-functions))) |
52691
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
278 |
51349 | 279 ;; If Imenu is loaded, try to make an index alist with it. |
52691
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
280 (when (and (null name) |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
281 (boundp 'imenu--index-alist) (null imenu--index-alist) |
51349 | 282 (null which-function-imenu-failed)) |
61089
dc55bf752d7c
(which-function): Be robust in the face of an
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58774
diff
changeset
|
283 (imenu--make-index-alist t) |
51349 | 284 (unless imenu--index-alist |
285 (make-local-variable 'which-function-imenu-failed) | |
286 (setq which-function-imenu-failed t))) | |
287 ;; If we have an index alist, use it. | |
52691
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
288 (when (and (null name) |
ccda1b53b035
(which-func-modes): Add ada-mode.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
289 (boundp 'imenu--index-alist) imenu--index-alist) |
51349 | 290 (let ((alist imenu--index-alist) |
291 (minoffset (point-max)) | |
98406
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
292 offset pair mark imstack namestack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
293 ;; Elements of alist are either ("name" . marker), or |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
294 ;; ("submenu" ("name" . marker) ... ). The list can be |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
295 ;; arbitrarily nested. |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
296 (while (or alist imstack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
297 (if alist |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
298 (progn |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
299 (setq pair (car-safe alist) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
300 alist (cdr-safe alist)) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
301 |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
302 (cond ((atom pair)) ; skip anything not a cons |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
303 |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
304 ((imenu--subalist-p pair) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
305 (setq imstack (cons alist imstack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
306 namestack (cons (car pair) namestack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
307 alist (cdr pair))) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
308 |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
309 ((number-or-marker-p (setq mark (cdr pair))) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
310 (if (>= (setq offset (- (point) mark)) 0) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
311 (if (< offset minoffset) ; find the closest item |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
312 (setq minoffset offset |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
313 name (funcall |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
314 which-func-imenu-joiner-function |
103096
d98eb168e700
* progmodes/which-func.el (which-function): Don't assume that
Chong Yidong <cyd@stupidchicken.com>
parents:
100908
diff
changeset
|
315 (reverse (cons (car pair) |
d98eb168e700
* progmodes/which-func.el (which-function): Don't assume that
Chong Yidong <cyd@stupidchicken.com>
parents:
100908
diff
changeset
|
316 namestack))))))))) |
98406
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
317 (setq alist (car imstack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
318 namestack (cdr namestack) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
319 imstack (cdr imstack)))))) |
6d3479368dfd
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94673
diff
changeset
|
320 |
51349 | 321 ;; Try using add-log support. |
322 (when (and (null name) (boundp 'add-log-current-defun-function) | |
323 add-log-current-defun-function) | |
324 (setq name (funcall add-log-current-defun-function))) | |
325 ;; Filter the name if requested. | |
326 (when name | |
327 (if which-func-cleanup-function | |
328 (funcall which-func-cleanup-function name) | |
329 name)))) | |
330 | |
331 (provide 'which-func) | |
332 | |
61089
dc55bf752d7c
(which-function): Be robust in the face of an
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58774
diff
changeset
|
333 ;; arch-tag: fa8a55c7-bfe3-4ffc-95ab-01bf21796827 |
51349 | 334 ;;; which-func.el ends here |