Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; imenu.el --- framework for mode-specific buffer indexes |
0a688fd0 | 2 | |
38357a23 SM |
3 | ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 2003, 2004 |
4 | ;; Free Software Foundation, Inc. | |
0a688fd0 RS |
5 | |
6 | ;; Author: Ake Stenhoff <etxaksf@aom.ericsson.se> | |
7 | ;; Lars Lindberg <lli@sypro.cap.se> | |
e4874521 | 8 | ;; Maintainer: FSF |
0a688fd0 | 9 | ;; Created: 8 Feb 1994 |
f5f727f8 | 10 | ;; Keywords: tools convenience |
b578f267 EN |
11 | |
12 | ;; This file is part of GNU Emacs. | |
13 | ||
14 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
0a688fd0 RS |
15 | ;; it under the terms of the GNU General Public License as published by |
16 | ;; the Free Software Foundation; either version 2, or (at your option) | |
17 | ;; any later version. | |
b578f267 EN |
18 | |
19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
0a688fd0 RS |
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | ;; GNU General Public License for more details. | |
b578f267 | 23 | |
0a688fd0 | 24 | ;; You should have received a copy of the GNU General Public License |
b578f267 EN |
25 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
26 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
27 | ;; Boston, MA 02111-1307, USA. | |
0a688fd0 RS |
28 | |
29 | ;;; Commentary: | |
b578f267 | 30 | |
0a688fd0 RS |
31 | ;; Purpose of this package: |
32 | ;; To present a framework for mode-specific buffer indexes. | |
33 | ;; A buffer index is an alist of names and buffer positions. | |
34 | ;; For instance all functions in a C-file and their positions. | |
35 | ;; | |
fe2908be RS |
36 | ;; It is documented in the Emacs Lisp manual. |
37 | ;; | |
0a688fd0 RS |
38 | ;; How it works: |
39 | ||
40 | ;; A mode-specific function is called to generate the index. It is | |
41 | ;; then presented to the user, who can choose from this index. | |
42 | ;; | |
43 | ;; The package comes with a set of example functions for how to | |
44 | ;; utilize this package. | |
45 | ||
2d24227e RS |
46 | ;; There are *examples* for index gathering functions/regular |
47 | ;; expressions for C/C++ and Lisp/Emacs Lisp but it is easy to | |
48 | ;; customize for other modes. A function for jumping to the chosen | |
49 | ;; index position is also supplied. | |
0a688fd0 | 50 | |
fe2908be RS |
51 | ;;; History: |
52 | ;; Thanks go to | |
26d6bb60 RS |
53 | ;; [simon] - Simon Leinen simon@lia.di.epfl.ch |
54 | ;; [dean] - Dean Andrews ada@unison.com | |
fe2908be | 55 | ;; [alon] - Alon Albert al@mercury.co.il |
7804cd27 | 56 | ;; [greg] - Greg Thompson gregt@porsche.visix.COM |
615b306c | 57 | ;; [wolfgang] - Wolfgang Bangerth zcg51122@rpool1.rus.uni-stuttgart.de |
056ab244 | 58 | ;; [kai] - Kai Grossjohann grossjoh@linus.informatik.uni-dortmund.de |
af447694 | 59 | ;; [david] - David M. Smith dsmith@stats.adelaide.edu.au |
2d24227e RS |
60 | ;; [christian] - Christian Egli Christian.Egli@hcsd.hac.com |
61 | ;; [karl] - Karl Fogel kfogel@floss.life.uiuc.edu | |
62 | ||
55535639 | 63 | ;;; Code: |
b578f267 | 64 | |
0ee4f8ad | 65 | (eval-when-compile (require 'cl)) |
0a688fd0 RS |
66 | |
67 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
68 | ;;; | |
69 | ;;; Customizable variables | |
70 | ;;; | |
71 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
2d24227e | 72 | |
94114394 RS |
73 | (defgroup imenu nil |
74 | "Mode-specific buffer indexes." | |
75 | :group 'matching | |
fe2908be | 76 | :group 'frames |
f5f727f8 | 77 | :group 'convenience |
fe2908be | 78 | :link '(custom-manual "(elisp)Imenu")) |
94114394 RS |
79 | |
80 | (defcustom imenu-use-markers t | |
e7c8378c | 81 | "*Non-nil means use markers instead of integers for Imenu buffer positions. |
fe2908be RS |
82 | |
83 | Setting this to nil makes Imenu work a little faster but editing the | |
84 | buffer will make the generated index positions wrong. | |
e7c8378c | 85 | |
94114394 RS |
86 | This might not yet be honored by all index-building functions." |
87 | :type 'boolean | |
88 | :group 'imenu) | |
89 | ||
e7c8378c | 90 | |
94114394 RS |
91 | (defcustom imenu-max-item-length 60 |
92 | "*If a number, truncate Imenu entries to that length." | |
fe2908be RS |
93 | :type '(choice integer |
94 | (const :tag "Unlimited")) | |
94114394 | 95 | :group 'imenu) |
e7c8378c | 96 | |
9df23821 | 97 | (defcustom imenu-auto-rescan nil |
94114394 RS |
98 | "*Non-nil means Imenu should always rescan the buffers." |
99 | :type 'boolean | |
100 | :group 'imenu) | |
2d24227e | 101 | |
fe2908be RS |
102 | (defcustom imenu-auto-rescan-maxout 60000 |
103 | "*Imenu auto-rescan is disabled in buffers larger than this size (in bytes). | |
94114394 RS |
104 | This variable is buffer-local." |
105 | :type 'integer | |
106 | :group 'imenu) | |
0a688fd0 | 107 | |
5988bd27 SM |
108 | (defvar imenu-always-use-completion-buffer-p nil) |
109 | (make-obsolete-variable 'imenu-always-use-completion-buffer-p | |
bf247b6e | 110 | 'imenu-use-popup-menu "22.1") |
5988bd27 SM |
111 | |
112 | (defcustom imenu-use-popup-menu | |
113 | (if imenu-always-use-completion-buffer-p | |
114 | (not (eq imenu-always-use-completion-buffer-p 'never)) | |
115 | 'on-mouse) | |
116 | "Use a popup menu rather than a minibuffer prompt. | |
117 | If nil, always use a minibuffer prompt. | |
118 | If t, always use a popup menu, | |
119 | If `on-mouse' use a popup menu when `imenu' was invoked with the mouse." | |
120 | :type '(choice (const :tag "On Mouse" on-mouse) | |
121 | (const :tag "Never" nil) | |
f5307782 JB |
122 | (other :tag "Always" t)) |
123 | :group 'imenu) | |
5988bd27 SM |
124 | |
125 | (defcustom imenu-eager-completion-buffer | |
126 | (not (eq imenu-always-use-completion-buffer-p 'never)) | |
127 | "If non-nil, eagerly popup the completion buffer." | |
977bbd4d RS |
128 | :type 'boolean |
129 | :group 'imenu | |
bf247b6e | 130 | :version "22.1") |
0a688fd0 | 131 | |
020e8fdf PR |
132 | (defcustom imenu-after-jump-hook nil |
133 | "*Hooks called after jumping to a place in the buffer. | |
134 | ||
135 | Useful things to use here include `reposition-window', `recenter', and | |
136 | \(lambda () (recenter 0)) to show at top of screen." | |
137 | :type 'hook | |
138 | :group 'imenu) | |
139 | ||
31f2a064 | 140 | ;;;###autoload |
94114394 | 141 | (defcustom imenu-sort-function nil |
0a688fd0 RS |
142 | "*The function to use for sorting the index mouse-menu. |
143 | ||
144 | Affects only the mouse index menu. | |
145 | ||
146 | Set this to nil if you don't want any sorting (faster). | |
147 | The items in the menu are then presented in the order they were found | |
148 | in the buffer. | |
149 | ||
0ee4f8ad | 150 | Set it to `imenu--sort-by-name' if you want alphabetic sorting. |
0a688fd0 | 151 | |
c01ee596 | 152 | The function should take two arguments and return t if the first |
0a688fd0 | 153 | element should come before the second. The arguments are cons cells; |
94114394 | 154 | \(NAME . POSITION). Look at `imenu--sort-by-name' for an example." |
fe2908be | 155 | :type '(choice (const :tag "No sorting" nil) |
df90db13 | 156 | (const :tag "Sort by name" imenu--sort-by-name) |
fe2908be | 157 | (function :tag "Another function")) |
94114394 | 158 | :group 'imenu) |
0a688fd0 | 159 | |
94114394 RS |
160 | (defcustom imenu-max-items 25 |
161 | "*Maximum number of elements in a mouse menu for Imenu." | |
162 | :type 'integer | |
163 | :group 'imenu) | |
0a688fd0 | 164 | |
9d4af4c7 KS |
165 | ;; No longer used. KFS 2004-10-27 |
166 | ;; (defcustom imenu-scanning-message "Scanning buffer for index (%3d%%)" | |
167 | ;; "*Progress message during the index scanning of the buffer. | |
168 | ;; If non-nil, user gets a message during the scanning of the buffer. | |
169 | ;; | |
170 | ;; Relevant only if the mode-specific function that creates the buffer | |
171 | ;; index use `imenu-progress-message', and not useful if that is fast, in | |
172 | ;; which case you might as well set this to nil." | |
173 | ;; :type '(choice string | |
174 | ;; (const :tag "None" nil)) | |
175 | ;; :group 'imenu) | |
0a688fd0 | 176 | |
a742f6cc | 177 | (defcustom imenu-space-replacement "." |
0a688fd0 | 178 | "*The replacement string for spaces in index names. |
a742f6cc | 179 | Used when presenting the index in a completion buffer to make the |
94114394 | 180 | names work as tokens." |
5988bd27 | 181 | :type '(choice string (const nil)) |
94114394 | 182 | :group 'imenu) |
0a688fd0 | 183 | |
94114394 | 184 | (defcustom imenu-level-separator ":" |
0a688fd0 RS |
185 | "*The separator between index names of different levels. |
186 | Used for making mouse-menu titles and for flattening nested indexes | |
94114394 RS |
187 | with name concatenation." |
188 | :type 'string | |
189 | :group 'imenu) | |
0a688fd0 | 190 | |
2d24227e | 191 | ;;;###autoload |
615b306c | 192 | (defvar imenu-generic-expression nil |
2d24227e RS |
193 | "The regex pattern to use for creating a buffer index. |
194 | ||
01e980fb | 195 | If non-nil this pattern is passed to `imenu--generic-function' |
2d24227e RS |
196 | to create a buffer index. |
197 | ||
215b077e RS |
198 | The value should be an alist with elements that look like this: |
199 | (MENU-TITLE REGEXP INDEX) | |
200 | or like this: | |
201 | (MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...) | |
202 | with zero or more ARGUMENTS. The former format creates a simple element in | |
203 | the index alist when it matches; the latter creates a special element | |
70223ca4 SM |
204 | of the form (NAME POSITION-MARKER FUNCTION ARGUMENTS...) |
205 | with FUNCTION and ARGUMENTS copied from `imenu-generic-expression'. | |
2d24227e RS |
206 | |
207 | MENU-TITLE is a string used as the title for the submenu or nil if the | |
208 | entries are not nested. | |
209 | ||
210 | REGEXP is a regexp that should match a construct in the buffer that is | |
6c1bf12b RS |
211 | to be displayed in the menu; i.e., function or variable definitions, |
212 | etc. It contains a substring which is the name to appear in the | |
213 | menu. See the info section on Regexps for more information. | |
2d24227e RS |
214 | |
215 | INDEX points to the substring in REGEXP that contains the name (of the | |
216 | function, variable or type) that is to appear in the menu. | |
615b306c | 217 | |
73f48953 | 218 | The variable `imenu-case-fold-search' determines whether or not the |
1447c4b1 | 219 | regexp matches are case sensitive, and `imenu-syntax-alist' can be |
fe2908be RS |
220 | used to alter the syntax table for the search. |
221 | ||
0cdb3baa | 222 | For example, see the value of `fortran-imenu-generic-expression' used by |
1447c4b1 DL |
223 | `fortran-mode' with `imenu-syntax-alist' set locally to give the |
224 | characters which normally have \"symbol\" syntax \"word\" syntax | |
225 | during matching.") | |
2d24227e | 226 | |
af5eb153 | 227 | ;;;###autoload |
6c1bf12b | 228 | (make-variable-buffer-local 'imenu-generic-expression) |
615b306c | 229 | |
0a688fd0 RS |
230 | ;;;; Hooks |
231 | ||
31f2a064 | 232 | ;;;###autoload |
0a688fd0 RS |
233 | (defvar imenu-create-index-function 'imenu-default-create-index-function |
234 | "The function to use for creating a buffer index. | |
235 | ||
236 | It should be a function that takes no arguments and returns an index | |
215b077e RS |
237 | of the current buffer as an alist. |
238 | ||
239 | Simple elements in the alist look like (INDEX-NAME . INDEX-POSITION). | |
35c8b898 | 240 | Special elements look like (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...). |
215b077e RS |
241 | A nested sub-alist element looks like (INDEX-NAME SUB-ALIST). |
242 | The function `imenu--subalist-p' tests an element and returns t | |
fe2908be | 243 | if it is a sub-alist. |
0a688fd0 | 244 | |
9a69579e | 245 | This function is called within a `save-excursion'.") |
31f2a064 | 246 | ;;;###autoload |
0a688fd0 RS |
247 | (make-variable-buffer-local 'imenu-create-index-function) |
248 | ||
31f2a064 | 249 | ;;;###autoload |
68e01f5a | 250 | (defvar imenu-prev-index-position-function 'beginning-of-defun |
0a688fd0 RS |
251 | "Function for finding the next index position. |
252 | ||
0ee4f8ad RS |
253 | If `imenu-create-index-function' is set to |
254 | `imenu-default-create-index-function', then you must set this variable | |
0a688fd0 RS |
255 | to a function that will find the next index, looking backwards in the |
256 | file. | |
257 | ||
258 | The function should leave point at the place to be connected to the | |
38357a23 | 259 | index and it should return nil when it doesn't find another index.") |
31f2a064 | 260 | ;;;###autoload |
68e01f5a | 261 | (make-variable-buffer-local 'imenu-prev-index-position-function) |
0a688fd0 | 262 | |
31f2a064 | 263 | ;;;###autoload |
68e01f5a | 264 | (defvar imenu-extract-index-name-function nil |
fe2908be | 265 | "Function for extracting the index item name, given a position. |
35c8b898 RS |
266 | |
267 | This function is called after `imenu-prev-index-position-function' | |
268 | finds a position for an index item, with point at that position. | |
38357a23 | 269 | It should return the name for that index item.") |
31f2a064 | 270 | ;;;###autoload |
68e01f5a | 271 | (make-variable-buffer-local 'imenu-extract-index-name-function) |
0a688fd0 | 272 | |
020e8fdf PR |
273 | ;;;###autoload |
274 | (defvar imenu-name-lookup-function nil | |
275 | "Function to compare string with index item. | |
276 | ||
277 | This function will be called with two strings, and should return | |
278 | non-nil if they match. | |
279 | ||
280 | If nil, comparison is done with `string='. | |
281 | Set this to some other function for more advanced comparisons, | |
282 | such as \"begins with\" or \"name matches and number of | |
38357a23 | 283 | arguments match\".") |
020e8fdf PR |
284 | ;;;###autoload |
285 | (make-variable-buffer-local 'imenu-name-lookup-function) | |
286 | ||
31f2a064 | 287 | ;;;###autoload |
37954a9a RS |
288 | (defvar imenu-default-goto-function 'imenu-default-goto-function |
289 | "The default function called when selecting an Imenu item. | |
290 | The function in this variable is called when selecting a normal index-item.") | |
31f2a064 | 291 | ;;;###autoload |
37954a9a RS |
292 | (make-variable-buffer-local 'imenu-default-goto-function) |
293 | ||
294 | ||
215b077e RS |
295 | (defun imenu--subalist-p (item) |
296 | (and (consp (cdr item)) (listp (cadr item)) | |
fe2908be | 297 | (not (eq (car (cadr item)) 'lambda)))) |
215b077e | 298 | |
fe2908be RS |
299 | ;; Macro to display a progress message. |
300 | ;; RELPOS is the relative position to display. | |
301 | ;; If RELPOS is nil, then the relative position in the buffer | |
302 | ;; is calculated. | |
303 | ;; PREVPOS is the variable in which we store the last position displayed. | |
615b306c | 304 | (defmacro imenu-progress-message (prevpos &optional relpos reverse) |
9d4af4c7 KS |
305 | |
306 | ;; Made obsolete/empty, as computers are now faster than the eye, and | |
307 | ;; it had problems updating the messages correctly, and could shadow | |
308 | ;; more important messages/prompts in the minibuffer. KFS 2004-10-27. | |
309 | ||
310 | ;; `(and | |
311 | ;; imenu-scanning-message | |
312 | ;; (let ((pos ,(if relpos | |
313 | ;; relpos | |
314 | ;; `(imenu--relative-position ,reverse)))) | |
315 | ;; (if ,(if relpos t | |
316 | ;; `(> pos (+ 5 ,prevpos))) | |
317 | ;; (progn | |
318 | ;; (message imenu-scanning-message pos) | |
319 | ;; (setq ,prevpos pos))))) | |
320 | ) | |
615b306c KH |
321 | |
322 | ||
323 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
324 | ;;;; | |
325 | ;;;; Some examples of functions utilizing the framework of this | |
326 | ;;;; package. | |
327 | ;;;; | |
328 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
329 | ||
bfbc9ea9 SM |
330 | ;; FIXME: This is the only imenu-example-* definition that's actually used, |
331 | ;; and it seems to only be used by cperl-mode.el. We should just move it to | |
332 | ;; cperl-mode.el and remove the rest. | |
615b306c | 333 | (defun imenu-example--name-and-position () |
bfbc9ea9 SM |
334 | "Return the current/previous sexp and its (beginning) location. |
335 | Don't move point." | |
615b306c KH |
336 | (save-excursion |
337 | (forward-sexp -1) | |
e7c8378c RS |
338 | ;; [ydi] modified for imenu-use-markers |
339 | (let ((beg (if imenu-use-markers (point-marker) (point))) | |
340 | (end (progn (forward-sexp) (point)))) | |
615b306c | 341 | (cons (buffer-substring beg end) |
e7c8378c | 342 | beg)))) |
615b306c KH |
343 | |
344 | ;;; | |
345 | ;;; Lisp | |
fe2908be | 346 | ;;; |
615b306c KH |
347 | |
348 | (defun imenu-example--lisp-extract-index-name () | |
349 | ;; Example of a candidate for `imenu-extract-index-name-function'. | |
350 | ;; This will generate a flat index of definitions in a lisp file. | |
351 | (save-match-data | |
352 | (and (looking-at "(def") | |
353 | (condition-case nil | |
354 | (progn | |
355 | (down-list 1) | |
356 | (forward-sexp 2) | |
357 | (let ((beg (point)) | |
358 | (end (progn (forward-sexp -1) (point)))) | |
359 | (buffer-substring beg end))) | |
360 | (error nil))))) | |
361 | ||
362 | (defun imenu-example--create-lisp-index () | |
363 | ;; Example of a candidate for `imenu-create-index-function'. | |
364 | ;; It will generate a nested index of definitions. | |
365 | (let ((index-alist '()) | |
366 | (index-var-alist '()) | |
367 | (index-type-alist '()) | |
368 | (index-unknown-alist '()) | |
369 | prev-pos) | |
370 | (goto-char (point-max)) | |
371 | (imenu-progress-message prev-pos 0) | |
372 | ;; Search for the function | |
373 | (while (beginning-of-defun) | |
374 | (imenu-progress-message prev-pos nil t) | |
fe2908be RS |
375 | (save-match-data |
376 | (and (looking-at "(def") | |
377 | (save-excursion | |
615b306c | 378 | (down-list 1) |
fe2908be | 379 | (cond |
615b306c | 380 | ((looking-at "def\\(var\\|const\\)") |
fe2908be RS |
381 | (forward-sexp 2) |
382 | (push (imenu-example--name-and-position) | |
383 | index-var-alist)) | |
615b306c | 384 | ((looking-at "def\\(un\\|subst\\|macro\\|advice\\)") |
fe2908be RS |
385 | (forward-sexp 2) |
386 | (push (imenu-example--name-and-position) | |
387 | index-alist)) | |
615b306c | 388 | ((looking-at "def\\(type\\|struct\\|class\\|ine-condition\\)") |
fe2908be | 389 | (forward-sexp 2) |
615b306c | 390 | (if (= (char-after (1- (point))) ?\)) |
fe2908be | 391 | (progn |
615b306c | 392 | (forward-sexp -1) |
fe2908be | 393 | (down-list 1) |
615b306c | 394 | (forward-sexp 1))) |
fe2908be RS |
395 | (push (imenu-example--name-and-position) |
396 | index-type-alist)) | |
397 | (t | |
398 | (forward-sexp 2) | |
399 | (push (imenu-example--name-and-position) | |
615b306c KH |
400 | index-unknown-alist))))))) |
401 | (imenu-progress-message prev-pos 100) | |
402 | (and index-var-alist | |
0c20ee61 | 403 | (push (cons "Variables" index-var-alist) |
615b306c KH |
404 | index-alist)) |
405 | (and index-type-alist | |
0c20ee61 | 406 | (push (cons "Types" index-type-alist) |
615b306c KH |
407 | index-alist)) |
408 | (and index-unknown-alist | |
0c20ee61 | 409 | (push (cons "Syntax-unknown" index-unknown-alist) |
615b306c KH |
410 | index-alist)) |
411 | index-alist)) | |
412 | ||
615b306c KH |
413 | ;; Regular expression to find C functions |
414 | (defvar imenu-example--function-name-regexp-c | |
fe2908be | 415 | (concat |
615b306c KH |
416 | "^[a-zA-Z0-9]+[ \t]?" ; type specs; there can be no |
417 | "\\([a-zA-Z0-9_*]+[ \t]+\\)?" ; more than 3 tokens, right? | |
418 | "\\([a-zA-Z0-9_*]+[ \t]+\\)?" | |
419 | "\\([*&]+[ \t]*\\)?" ; pointer | |
420 | "\\([a-zA-Z0-9_*]+\\)[ \t]*(" ; name | |
421 | )) | |
422 | ||
423 | (defun imenu-example--create-c-index (&optional regexp) | |
424 | (let ((index-alist '()) | |
425 | prev-pos char) | |
426 | (goto-char (point-min)) | |
427 | (imenu-progress-message prev-pos 0) | |
428 | ;; Search for the function | |
429 | (save-match-data | |
430 | (while (re-search-forward | |
431 | (or regexp imenu-example--function-name-regexp-c) | |
432 | nil t) | |
433 | (imenu-progress-message prev-pos) | |
434 | (backward-up-list 1) | |
435 | (save-excursion | |
436 | (goto-char (scan-sexps (point) 1)) | |
437 | (setq char (following-char))) | |
438 | ;; Skip this function name if it is a prototype declaration. | |
439 | (if (not (eq char ?\;)) | |
440 | (push (imenu-example--name-and-position) index-alist)))) | |
441 | (imenu-progress-message prev-pos 100) | |
442 | (nreverse index-alist))) | |
443 | ||
2d24227e | 444 | |
0a688fd0 RS |
445 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
446 | ;;; | |
447 | ;;; Internal variables | |
448 | ;;; | |
449 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
450 | ||
451 | ;; The item to use in the index for rescanning the buffer. | |
452 | (defconst imenu--rescan-item '("*Rescan*" . -99)) | |
453 | ||
454 | ;; The latest buffer index. | |
455 | ;; Buffer local. | |
35c8b898 RS |
456 | (defvar imenu--index-alist nil |
457 | "The buffer index computed for this buffer in Imenu. | |
458 | Simple elements in the alist look like (INDEX-NAME . INDEX-POSITION). | |
459 | Special elements look like (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...). | |
38357a23 | 460 | A nested sub-alist element looks like (INDEX-NAME SUB-ALIST).") |
35c8b898 | 461 | |
0a688fd0 RS |
462 | (make-variable-buffer-local 'imenu--index-alist) |
463 | ||
0cff96e7 RS |
464 | (defvar imenu--last-menubar-index-alist nil |
465 | "The latest buffer index used to update the menu bar menu.") | |
466 | ||
0a8e8bc6 KH |
467 | (make-variable-buffer-local 'imenu--last-menubar-index-alist) |
468 | ||
0a688fd0 | 469 | ;; History list for 'jump-to-function-in-buffer'. |
6c1bf12b | 470 | ;; Making this buffer local caused it not to work! |
0a688fd0 | 471 | (defvar imenu--history-list nil) |
0a688fd0 RS |
472 | |
473 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
474 | ;;; | |
475 | ;;; Internal support functions | |
476 | ;;; | |
477 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
478 | ||
479 | ;;; | |
480 | ;;; Sort function | |
481 | ;;; Sorts the items depending on their index name. | |
c01ee596 | 482 | ;;; An item looks like (NAME . POSITION). |
0a688fd0 RS |
483 | ;;; |
484 | (defun imenu--sort-by-name (item1 item2) | |
485 | (string-lessp (car item1) (car item2))) | |
486 | ||
c01ee596 KH |
487 | (defun imenu--sort-by-position (item1 item2) |
488 | (< (cdr item1) (cdr item2))) | |
489 | ||
0a688fd0 RS |
490 | (defun imenu--relative-position (&optional reverse) |
491 | ;; Support function to calculate relative position in buffer | |
492 | ;; Beginning of buffer is 0 and end of buffer is 100 | |
493 | ;; If REVERSE is non-nil then the beginning is 100 and the end is 0. | |
494 | (let ((pos (point)) | |
495 | (total (buffer-size))) | |
496 | (and reverse (setq pos (- total pos))) | |
497 | (if (> total 50000) | |
498 | ;; Avoid overflow from multiplying by 100! | |
499 | (/ (1- pos) (max (/ total 100) 1)) | |
500 | (/ (* 100 (1- pos)) (max total 1))))) | |
501 | ||
0a688fd0 RS |
502 | ;; Split LIST into sublists of max length N. |
503 | ;; Example (imenu--split '(1 2 3 4 5 6 7 8) 3)-> '((1 2 3) (4 5 6) (7 8)) | |
504 | (defun imenu--split (list n) | |
505 | (let ((remain list) | |
506 | (result '()) | |
507 | (sublist '()) | |
508 | (i 0)) | |
509 | (while remain | |
510 | (push (pop remain) sublist) | |
511 | (incf i) | |
512 | (and (= i n) | |
513 | ;; We have finished a sublist | |
514 | (progn (push (nreverse sublist) result) | |
515 | (setq i 0) | |
516 | (setq sublist '())))) | |
517 | ;; There might be a sublist (if the length of LIST mod n is != 0) | |
518 | ;; that has to be added to the result list. | |
519 | (and sublist | |
520 | (push (nreverse sublist) result)) | |
521 | (nreverse result))) | |
522 | ||
0c20ee61 RS |
523 | ;;; Split the alist MENULIST into a nested alist, if it is long enough. |
524 | ;;; In any case, add TITLE to the front of the alist. | |
0a688fd0 | 525 | (defun imenu--split-menu (menulist title) |
7ebea144 RS |
526 | (let (keep-at-top tail) |
527 | (if (memq imenu--rescan-item menulist) | |
528 | (setq keep-at-top (cons imenu--rescan-item nil) | |
529 | menulist (delq imenu--rescan-item menulist))) | |
530 | (setq tail menulist) | |
0cdb3baa | 531 | (dolist (item tail) |
dd631e8a SM |
532 | (when (imenu--subalist-p item) |
533 | (push item keep-at-top) | |
534 | (setq menulist (delq item menulist)))) | |
7ebea144 | 535 | (if imenu-sort-function |
5f7bccda | 536 | (setq menulist (sort (copy-sequence menulist) imenu-sort-function))) |
7ebea144 | 537 | (if (> (length menulist) imenu-max-items) |
dd631e8a SM |
538 | (setq menulist |
539 | (mapcar | |
540 | (lambda (menu) | |
541 | (cons (format "From: %s" (caar menu)) menu)) | |
542 | (imenu--split menulist imenu-max-items)))) | |
7ebea144 RS |
543 | (cons title |
544 | (nconc (nreverse keep-at-top) menulist)))) | |
0c20ee61 RS |
545 | |
546 | ;;; Split up each long alist that are nested within ALIST | |
547 | ;;; into nested alists. | |
548 | (defun imenu--split-submenus (alist) | |
fe2908be RS |
549 | (mapcar (function |
550 | (lambda (elt) | |
551 | (if (and (consp elt) | |
552 | (stringp (car elt)) | |
553 | (listp (cdr elt))) | |
554 | (imenu--split-menu (cdr elt) (car elt)) | |
555 | elt))) | |
0c20ee61 | 556 | alist)) |
0a688fd0 | 557 | |
e7c8378c RS |
558 | ;;; Truncate all strings in MENULIST to imenu-max-item-length |
559 | (defun imenu--truncate-items (menulist) | |
117be359 DL |
560 | (mapcar (function |
561 | (lambda (item) | |
562 | (cond | |
563 | ((consp (cdr item)) | |
564 | (imenu--truncate-items (cdr item))) | |
bfbc9ea9 SM |
565 | ;; truncate if necessary |
566 | ((and (numberp imenu-max-item-length) | |
567 | (> (length (car item)) imenu-max-item-length)) | |
568 | (setcar item (substring (car item) 0 imenu-max-item-length)))))) | |
117be359 | 569 | menulist)) |
e7c8378c RS |
570 | |
571 | ||
0a8e8bc6 | 572 | (defun imenu--make-index-alist (&optional noerror) |
7e563e04 RS |
573 | "Create an index-alist for the definitions in the current buffer. |
574 | ||
fe2908be RS |
575 | Report an error if the list is empty unless NOERROR is supplied and |
576 | non-nil. | |
577 | ||
7e563e04 RS |
578 | Simple elements in the alist look like (INDEX-NAME . INDEX-POSITION). |
579 | Special elements look like (INDEX-NAME FUNCTION ARGUMENTS...). | |
580 | A nested sub-alist element looks like (INDEX-NAME SUB-ALIST). | |
581 | The function `imenu--subalist-p' tests an element and returns t | |
fe2908be | 582 | if it is a sub-alist. |
7e563e04 RS |
583 | |
584 | There is one simple element with negative POSITION; that's intended | |
585 | as a way for the user to ask to recalculate the buffer's index alist." | |
2d24227e RS |
586 | (or (and imenu--index-alist |
587 | (or (not imenu-auto-rescan) | |
588 | (and imenu-auto-rescan | |
589 | (> (buffer-size) imenu-auto-rescan-maxout)))) | |
e7c8378c RS |
590 | ;; Get the index; truncate if necessary |
591 | (progn | |
592 | (setq imenu--index-alist | |
593 | (save-excursion | |
594 | (save-restriction | |
595 | (widen) | |
596 | (funcall imenu-create-index-function)))) | |
597 | (imenu--truncate-items imenu--index-alist))) | |
0a8e8bc6 | 598 | (or imenu--index-alist noerror |
6c1bf12b | 599 | (error "No items suitable for an index found in this buffer")) |
0a8e8bc6 KH |
600 | (or imenu--index-alist |
601 | (setq imenu--index-alist (list nil))) | |
0a688fd0 RS |
602 | ;; Add a rescan option to the index. |
603 | (cons imenu--rescan-item imenu--index-alist)) | |
79e098ca | 604 | |
5d3b0f18 RS |
605 | ;;; Find all markers in alist and makes |
606 | ;;; them point nowhere. | |
79e098ca RS |
607 | ;;; The top-level call uses nil as the argument; |
608 | ;;; non-nil arguments are in recursivecalls. | |
609 | (defvar imenu--cleanup-seen) | |
610 | ||
5d3b0f18 | 611 | (defun imenu--cleanup (&optional alist) |
fe2908be | 612 | ;; If alist is provided use that list. |
79e098ca RS |
613 | ;; If not, empty the table of lists already seen |
614 | ;; and use imenu--index-alist. | |
615 | (if alist | |
616 | (setq imenu--cleanup-seen (cons alist imenu--cleanup-seen)) | |
617 | (setq alist imenu--index-alist imenu--cleanup-seen (list alist))) | |
618 | ||
4818d210 | 619 | (and alist |
e26b2a28 DL |
620 | (mapc |
621 | (lambda (item) | |
622 | (cond | |
623 | ((markerp (cdr item)) | |
624 | (set-marker (cdr item) nil)) | |
625 | ;; Don't process one alist twice. | |
626 | ((memq (cdr item) imenu--cleanup-seen)) | |
627 | ((imenu--subalist-p item) | |
628 | (imenu--cleanup (cdr item))))) | |
4818d210 | 629 | alist) |
615b306c KH |
630 | t)) |
631 | ||
dd631e8a SM |
632 | (defun imenu--create-keymap (title alist &optional cmd) |
633 | (list* 'keymap title | |
634 | (mapcar | |
635 | (lambda (item) | |
636 | (list* (car item) (car item) | |
637 | (cond | |
638 | ((imenu--subalist-p item) | |
639 | (imenu--create-keymap (car item) (cdr item) cmd)) | |
640 | (t | |
641 | `(lambda () (interactive) | |
642 | ,(if cmd `(,cmd ',item) (list 'quote item))))))) | |
643 | alist))) | |
2d24227e | 644 | |
2d24227e RS |
645 | (defun imenu--in-alist (str alist) |
646 | "Check whether the string STR is contained in multi-level ALIST." | |
647 | (let (elt head tail res) | |
648 | (setq res nil) | |
649 | (while alist | |
fe2908be | 650 | (setq elt (car alist) |
2d24227e | 651 | tail (cdr elt) |
fe2908be RS |
652 | alist (cdr alist) |
653 | head (car elt)) | |
8396299d RS |
654 | ;; A nested ALIST element looks like |
655 | ;; (INDEX-NAME (INDEX-NAME . INDEX-POSITION) ...) | |
656 | ;; while a bottom-level element looks like | |
657 | ;; (INDEX-NAME . INDEX-POSITION) | |
658 | ;; We are only interested in the bottom-level elements, so we need to | |
659 | ;; recurse if TAIL is a list. | |
660 | (cond ((listp tail) | |
661 | (if (setq res (imenu--in-alist str tail)) | |
662 | (setq alist nil))) | |
020e8fdf PR |
663 | ((if imenu-name-lookup-function |
664 | (funcall imenu-name-lookup-function str head) | |
665 | (string= str head)) | |
8396299d | 666 | (setq alist nil res elt)))) |
2d24227e RS |
667 | res)) |
668 | ||
fea79780 | 669 | (defvar imenu-syntax-alist nil |
0cdb3baa | 670 | "Alist of syntax table modifiers to use while in `imenu--generic-function'. |
fea79780 DL |
671 | |
672 | The car of the assocs may be either a character or a string and the | |
23d468da | 673 | cdr is a syntax description appropriate for `modify-syntax-entry'. For |
fea79780 DL |
674 | a string, all the characters in the string get the specified syntax. |
675 | ||
676 | This is typically used to give word syntax to characters which | |
90806abc | 677 | normally have symbol syntax to simplify `imenu-expression' |
fea79780 | 678 | and speed-up matching.") |
005913e4 | 679 | ;;;###autoload |
fea79780 DL |
680 | (make-variable-buffer-local 'imenu-syntax-alist) |
681 | ||
0a688fd0 RS |
682 | (defun imenu-default-create-index-function () |
683 | "*Wrapper for index searching functions. | |
684 | ||
685 | Moves point to end of buffer and then repeatedly calls | |
68e01f5a | 686 | `imenu-prev-index-position-function' and `imenu-extract-index-name-function'. |
0a688fd0 | 687 | Their results are gathered into an index alist." |
3e062f78 RS |
688 | ;; These should really be done by setting imenu-create-index-function |
689 | ;; in these major modes. But save that change for later. | |
e536ef56 KH |
690 | (cond ((and imenu-prev-index-position-function |
691 | imenu-extract-index-name-function) | |
3e062f78 | 692 | (let ((index-alist '()) |
615b306c | 693 | prev-pos name) |
3e062f78 | 694 | (goto-char (point-max)) |
7dea4e70 | 695 | (imenu-progress-message prev-pos 0 t) |
3e062f78 | 696 | ;; Search for the function |
fe2908be | 697 | (while (funcall imenu-prev-index-position-function) |
7dea4e70 | 698 | (imenu-progress-message prev-pos nil t) |
3e062f78 RS |
699 | (save-excursion |
700 | (setq name (funcall imenu-extract-index-name-function))) | |
701 | (and (stringp name) | |
e7c8378c RS |
702 | ;; [ydi] updated for imenu-use-markers |
703 | (push (cons name (if imenu-use-markers (point-marker) (point))) | |
704 | index-alist))) | |
7dea4e70 | 705 | (imenu-progress-message prev-pos 100 t) |
615b306c KH |
706 | index-alist)) |
707 | ;; Use generic expression if possible. | |
708 | ((and imenu-generic-expression) | |
fe2908be | 709 | (imenu--generic-function imenu-generic-expression)) |
615b306c | 710 | (t |
e7c8378c | 711 | (error "This buffer cannot use `imenu-default-create-index-function'")))) |
0a688fd0 | 712 | |
fe2908be | 713 | ;; Not used and would require cl at run time |
dd631e8a SM |
714 | ;; (defun imenu--flatten-index-alist (index-alist &optional concat-names prefix) |
715 | ;; ;; Takes a nested INDEX-ALIST and returns a flat index alist. | |
716 | ;; ;; If optional CONCAT-NAMES is non-nil, then a nested index has its | |
717 | ;; ;; name and a space concatenated to the names of the children. | |
718 | ;; ;; Third argument PREFIX is for internal use only. | |
719 | ;; (mapcan | |
720 | ;; (lambda (item) | |
721 | ;; (let* ((name (car item)) | |
722 | ;; (pos (cdr item)) | |
723 | ;; (new-prefix (and concat-names | |
724 | ;; (if prefix | |
725 | ;; (concat prefix imenu-level-separator name) | |
726 | ;; name)))) | |
727 | ;; (cond | |
728 | ;; ((or (markerp pos) (numberp pos)) | |
729 | ;; (list (cons new-prefix pos))) | |
730 | ;; (t | |
731 | ;; (imenu--flatten-index-alist pos new-prefix))))) | |
732 | ;; index-alist)) | |
0a688fd0 | 733 | |
615b306c KH |
734 | ;;; |
735 | ;;; Generic index gathering function. | |
736 | ;;; | |
2d24227e | 737 | |
73f48953 DL |
738 | (defvar imenu-case-fold-search t |
739 | "Defines whether `imenu--generic-function' should fold case when matching. | |
740 | ||
0cdb3baa | 741 | This variable should be set (only) by initialization code |
95e60ff9 SM |
742 | for modes which use `imenu--generic-function'. If it is not set, but |
743 | `font-lock-defaults' is set, then font-lock's setting is used.") | |
fe2908be | 744 | ;;;###autoload |
73f48953 DL |
745 | (make-variable-buffer-local 'imenu-case-fold-search) |
746 | ||
71eb6308 RS |
747 | ;; This function can be called with quitting disabled, |
748 | ;; so it needs to be careful never to loop! | |
2d24227e | 749 | (defun imenu--generic-function (patterns) |
2d24227e RS |
750 | "Return an index of the current buffer as an alist. |
751 | ||
fe2908be RS |
752 | PATTERNS is an alist with elements that look like this: |
753 | (MENU-TITLE REGEXP INDEX). | |
61567afa LK |
754 | or like this: |
755 | (MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...) | |
756 | with zero or more ARGUMENTS. | |
2d24227e RS |
757 | |
758 | MENU-TITLE is a string used as the title for the submenu or nil if the | |
759 | entries are not nested. | |
760 | ||
761 | REGEXP is a regexp that should match a construct in the buffer that is | |
6c1bf12b RS |
762 | to be displayed in the menu; i.e., function or variable definitions, |
763 | etc. It contains a substring which is the name to appear in the | |
764 | menu. See the info section on Regexps for more information. | |
2d24227e RS |
765 | |
766 | INDEX points to the substring in REGEXP that contains the name (of the | |
767 | function, variable or type) that is to appear in the menu. | |
768 | ||
fe2908be | 769 | See `lisp-imenu-generic-expression' for an example of PATTERNS. |
2d24227e | 770 | |
6c1bf12b | 771 | Returns an index of the current buffer as an alist. The elements in |
61567afa LK |
772 | the alist look like: |
773 | (INDEX-NAME . INDEX-POSITION) | |
774 | or like: | |
775 | (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...) | |
9d4af4c7 | 776 | They may also be nested index alists like: |
61567afa LK |
777 | (INDEX-NAME . INDEX-ALIST) |
778 | depending on PATTERNS." | |
2d24227e RS |
779 | |
780 | (let ((index-alist (list 'dummy)) | |
1cade2b6 | 781 | prev-pos |
95e60ff9 SM |
782 | (case-fold-search (if (or (local-variable-p 'imenu-case-fold-search) |
783 | (not (local-variable-p 'font-lock-defaults))) | |
784 | imenu-case-fold-search | |
785 | (nth 2 font-lock-defaults))) | |
fea79780 DL |
786 | (old-table (syntax-table)) |
787 | (table (copy-syntax-table (syntax-table))) | |
788 | (slist imenu-syntax-alist)) | |
789 | ;; Modify the syntax table used while matching regexps. | |
0cdb3baa | 790 | (dolist (syn slist) |
fe2908be | 791 | ;; The character(s) to modify may be a single char or a string. |
0cdb3baa SM |
792 | (if (numberp (car syn)) |
793 | (modify-syntax-entry (car syn) (cdr syn) table) | |
5b89a8c9 GM |
794 | (mapc (lambda (c) |
795 | (modify-syntax-entry c (cdr syn) table)) | |
796 | (car syn)))) | |
615b306c KH |
797 | (goto-char (point-max)) |
798 | (imenu-progress-message prev-pos 0 t) | |
fe2908be RS |
799 | (unwind-protect ; for syntax table |
800 | (save-match-data | |
801 | (set-syntax-table table) | |
71eb6308 | 802 | |
fe2908be RS |
803 | ;; map over the elements of imenu-generic-expression |
804 | ;; (typically functions, variables ...) | |
0cdb3baa SM |
805 | (dolist (pat patterns) |
806 | (let ((menu-title (car pat)) | |
807 | (regexp (nth 1 pat)) | |
808 | (index (nth 2 pat)) | |
809 | (function (nth 3 pat)) | |
8522009e | 810 | (rest (nthcdr 4 pat)) |
1cade2b6 | 811 | start beg) |
0cdb3baa SM |
812 | ;; Go backwards for convenience of adding items in order. |
813 | (goto-char (point-max)) | |
71eb6308 RS |
814 | (while (and (re-search-backward regexp nil t) |
815 | ;; Exit the loop if we get an empty match, | |
816 | ;; because it means a bad regexp was specified. | |
817 | (not (= (match-beginning 0) (match-end 0)))) | |
58b00d47 | 818 | (setq start (point)) |
1cade2b6 | 819 | ;; Record the start of the line in which the match starts. |
5f7bccda | 820 | ;; That's the official position of this definition. |
1cade2b6 RS |
821 | (goto-char (match-beginning index)) |
822 | (beginning-of-line) | |
823 | (setq beg (point)) | |
237470e8 RS |
824 | (imenu-progress-message prev-pos nil t) |
825 | ;; Add this sort of submenu only when we've found an | |
826 | ;; item for it, avoiding empty, duff menus. | |
827 | (unless (assoc menu-title index-alist) | |
828 | (push (list menu-title) index-alist)) | |
829 | (if imenu-use-markers | |
1cade2b6 | 830 | (setq beg (copy-marker beg))) |
237470e8 RS |
831 | (let ((item |
832 | (if function | |
833 | (nconc (list (match-string-no-properties index) | |
1cade2b6 | 834 | beg function) |
237470e8 RS |
835 | rest) |
836 | (cons (match-string-no-properties index) | |
1cade2b6 | 837 | beg))) |
237470e8 RS |
838 | ;; This is the desired submenu, |
839 | ;; starting with its title (or nil). | |
840 | (menu (assoc menu-title index-alist))) | |
841 | ;; Insert the item unless it is already present. | |
842 | (unless (member item (cdr menu)) | |
843 | (setcdr menu | |
1cade2b6 RS |
844 | (cons item (cdr menu))))) |
845 | ;; Go to the start of the match, to make sure we | |
846 | ;; keep making progress backwards. | |
847 | (goto-char start)))) | |
fe2908be | 848 | (set-syntax-table old-table))) |
0c20ee61 | 849 | (imenu-progress-message prev-pos 100 t) |
c01ee596 KH |
850 | ;; Sort each submenu by position. |
851 | ;; This is in case one submenu gets items from two different regexps. | |
0cdb3baa SM |
852 | (dolist (item index-alist) |
853 | (when (listp item) | |
854 | (setcdr item (sort (cdr item) 'imenu--sort-by-position)))) | |
0c20ee61 | 855 | (let ((main-element (assq nil index-alist))) |
7ebea144 RS |
856 | (nconc (delq main-element (delq 'dummy index-alist)) |
857 | (cdr main-element))))) | |
615b306c | 858 | |
0a688fd0 RS |
859 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
860 | ;;; | |
861 | ;;; The main functions for this package! | |
862 | ;;; | |
863 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
864 | ||
0cdb3baa SM |
865 | ;; See also info-lookup-find-item |
866 | (defun imenu-find-default (guess completions) | |
867 | "Fuzzily find an item based on GUESS inside the alist COMPLETIONS." | |
868 | (catch 'found | |
869 | (let ((case-fold-search t)) | |
870 | (if (assoc guess completions) guess | |
871 | (dolist (re (list (concat "\\`" (regexp-quote guess) "\\'") | |
872 | (concat "\\`" (regexp-quote guess)) | |
873 | (concat (regexp-quote guess) "\\'") | |
874 | (regexp-quote guess))) | |
875 | (dolist (x completions) | |
876 | (if (string-match re (car x)) (throw 'found (car x))))))))) | |
877 | ||
0a688fd0 RS |
878 | (defun imenu--completion-buffer (index-alist &optional prompt) |
879 | "Let the user select from INDEX-ALIST in a completion buffer with PROMPT. | |
880 | ||
bfbc9ea9 | 881 | Return one of the entries in index-alist or nil." |
0a688fd0 | 882 | ;; Create a list for this buffer only when needed. |
fe2908be RS |
883 | (let ((name (thing-at-point 'symbol)) |
884 | choice | |
885 | (prepared-index-alist | |
5988bd27 SM |
886 | (if (not imenu-space-replacement) index-alist |
887 | (mapcar | |
888 | (lambda (item) | |
889 | (cons (subst-char-in-string ?\ (aref imenu-space-replacement 0) | |
890 | (car item)) | |
891 | (cdr item))) | |
892 | index-alist)))) | |
0cdb3baa SM |
893 | (when (stringp name) |
894 | (setq name (or (imenu-find-default name prepared-index-alist) name))) | |
fe2908be RS |
895 | (cond (prompt) |
896 | ((and name (imenu--in-alist name prepared-index-alist)) | |
897 | (setq prompt (format "Index item (default %s): " name))) | |
898 | (t (setq prompt "Index item: "))) | |
5988bd27 SM |
899 | (let ((minibuffer-setup-hook minibuffer-setup-hook)) |
900 | ;; Display the completion buffer. | |
901 | (if (not imenu-eager-completion-buffer) | |
902 | (add-hook 'minibuffer-setup-hook 'minibuffer-completion-help)) | |
903 | (setq name (completing-read prompt | |
904 | prepared-index-alist | |
905 | nil t nil 'imenu--history-list name))) | |
bcaa1cef | 906 | |
bfbc9ea9 SM |
907 | (when (stringp name) |
908 | (setq choice (assoc name prepared-index-alist)) | |
909 | (if (imenu--subalist-p choice) | |
910 | (imenu--completion-buffer (cdr choice) prompt) | |
911 | choice)))) | |
68e01f5a | 912 | |
0a688fd0 RS |
913 | (defun imenu--mouse-menu (index-alist event &optional title) |
914 | "Let the user select from a buffer index from a mouse menu. | |
915 | ||
916 | INDEX-ALIST is the buffer index and EVENT is a mouse event. | |
917 | ||
32c1a22e | 918 | Returns t for rescan and otherwise an element or subelement of INDEX-ALIST." |
0c20ee61 | 919 | (setq index-alist (imenu--split-submenus index-alist)) |
0cdb3baa | 920 | (let* ((menu (imenu--split-menu index-alist (or title (buffer-name)))) |
dd631e8a SM |
921 | (map (imenu--create-keymap (car menu) |
922 | (cdr (if (< 1 (length (cdr menu))) | |
923 | menu | |
924 | (car (cdr menu))))))) | |
0cdb3baa | 925 | (popup-menu map event))) |
0a688fd0 | 926 | |
26d6bb60 | 927 | (defun imenu-choose-buffer-index (&optional prompt alist) |
0a688fd0 RS |
928 | "Let the user select from a buffer index and return the chosen index. |
929 | ||
930 | If the user originally activated this function with the mouse, a mouse | |
0a688fd0 RS |
931 | menu is used. Otherwise a completion buffer is used and the user is |
932 | prompted with PROMPT. | |
933 | ||
26d6bb60 RS |
934 | If you call this function with index alist ALIST, then it lets the user |
935 | select from ALIST. | |
936 | ||
0ee4f8ad | 937 | With no index alist ALIST, it calls `imenu--make-index-alist' to |
26d6bb60 RS |
938 | create the index alist. |
939 | ||
5988bd27 | 940 | If `imenu-use-popup-menu' is non-nil, then the |
0a688fd0 RS |
941 | completion buffer is always used, no matter if the mouse was used or |
942 | not. | |
943 | ||
7e563e04 | 944 | The returned value is of the form (INDEX-NAME . INDEX-POSITION)." |
0a688fd0 | 945 | (let (index-alist |
7dea4e70 | 946 | (mouse-triggered (listp last-nonmenu-event)) |
0cdb3baa | 947 | (result t)) |
0a688fd0 RS |
948 | ;; If selected by mouse, see to that the window where the mouse is |
949 | ;; really is selected. | |
950 | (and mouse-triggered | |
4cde72b4 | 951 | (not (equal last-nonmenu-event '(menu-bar))) |
7dea4e70 | 952 | (let ((window (posn-window (event-start last-nonmenu-event)))) |
4a840d8b | 953 | (or (framep window) (null window) (select-window window)))) |
0a688fd0 RS |
954 | ;; Create a list for this buffer only when needed. |
955 | (while (eq result t) | |
26d6bb60 | 956 | (setq index-alist (if alist alist (imenu--make-index-alist))) |
0a688fd0 | 957 | (setq result |
5988bd27 SM |
958 | (if (and imenu-use-popup-menu |
959 | (or (eq imenu-use-popup-menu t) mouse-triggered)) | |
7dea4e70 | 960 | (imenu--mouse-menu index-alist last-nonmenu-event) |
0a688fd0 | 961 | (imenu--completion-buffer index-alist prompt))) |
bfbc9ea9 | 962 | (and (equal result imenu--rescan-item) |
5d3b0f18 | 963 | (imenu--cleanup) |
bfbc9ea9 | 964 | (setq result t imenu--index-alist nil))) |
0a688fd0 RS |
965 | result)) |
966 | ||
2d24227e | 967 | ;;;###autoload |
5d3b0f18 | 968 | (defun imenu-add-to-menubar (name) |
fe2908be | 969 | "Add an `imenu' entry to the menu bar for the current buffer. |
0a8e8bc6 | 970 | NAME is a string used to name the menu bar item. |
d1757026 | 971 | See the command `imenu' for more information." |
0a8e8bc6 | 972 | (interactive "sImenu menu item name: ") |
e536ef56 KH |
973 | (if (or (and imenu-prev-index-position-function |
974 | imenu-extract-index-name-function) | |
975 | imenu-generic-expression | |
976 | (not (eq imenu-create-index-function | |
977 | 'imenu-default-create-index-function))) | |
e26b2a28 DL |
978 | (let ((newmap (make-sparse-keymap))) |
979 | (set-keymap-parent newmap (current-local-map)) | |
0cff96e7 | 980 | (setq imenu--last-menubar-index-alist nil) |
f1d7969d | 981 | (define-key newmap [menu-bar index] |
fbfb705c | 982 | `(menu-item ,name ,(make-sparse-keymap "Imenu"))) |
e26b2a28 | 983 | (use-local-map newmap) |
e536ef56 | 984 | (add-hook 'menu-bar-update-hook 'imenu-update-menubar)) |
37954a9a | 985 | (error "The mode `%s' does not support Imenu" mode-name))) |
0a8e8bc6 | 986 | |
fe2908be RS |
987 | ;;;###autoload |
988 | (defun imenu-add-menubar-index () | |
989 | "Add an Imenu \"Index\" entry on the menu bar for the current buffer. | |
990 | ||
991 | A trivial interface to `imenu-add-to-menubar' suitable for use in a hook." | |
992 | (interactive) | |
993 | (imenu-add-to-menubar "Index")) | |
994 | ||
6d7a4832 KH |
995 | (defvar imenu-buffer-menubar nil) |
996 | ||
9fb980fc | 997 | (defvar imenu-menubar-modified-tick 0 |
9a69579e | 998 | "The value of (buffer-modified-tick) as of last call to `imenu-update-menubar'.") |
9fb980fc | 999 | (make-variable-buffer-local 'imenu-menubar-modified-tick) |
a3841d3b | 1000 | |
0a8e8bc6 | 1001 | (defun imenu-update-menubar () |
9fb980fc RS |
1002 | (when (and (current-local-map) |
1003 | (keymapp (lookup-key (current-local-map) [menu-bar index])) | |
1004 | (not (eq (buffer-modified-tick) | |
1005 | imenu-menubar-modified-tick))) | |
1006 | (setq imenu-menubar-modified-tick (buffer-modified-tick)) | |
1007 | (let ((index-alist (imenu--make-index-alist t))) | |
1008 | ;; Don't bother updating if the index-alist has not changed | |
1009 | ;; since the last time we did it. | |
1010 | (unless (equal index-alist imenu--last-menubar-index-alist) | |
1011 | (let (menu menu1 old) | |
1012 | (setq imenu--last-menubar-index-alist index-alist) | |
1013 | (setq index-alist (imenu--split-submenus index-alist)) | |
1014 | (setq menu (imenu--split-menu index-alist | |
1015 | (buffer-name))) | |
dd631e8a SM |
1016 | (setq menu1 (imenu--create-keymap (car menu) |
1017 | (cdr (if (< 1 (length (cdr menu))) | |
1018 | menu | |
1019 | (car (cdr menu)))) | |
1020 | 'imenu--menubar-select)) | |
9fb980fc RS |
1021 | (setq old (lookup-key (current-local-map) [menu-bar index])) |
1022 | (setcdr old (cdr menu1))))))) | |
0a8e8bc6 KH |
1023 | |
1024 | (defun imenu--menubar-select (item) | |
0cdb3baa | 1025 | "Use Imenu to select the function or variable named in this menu ITEM." |
37954a9a | 1026 | (if (equal item imenu--rescan-item) |
e63679b8 RS |
1027 | (progn |
1028 | (imenu--cleanup) | |
bcaa1cef RS |
1029 | ;; Make sure imenu-update-menubar redoes everything. |
1030 | (setq imenu-menubar-modified-tick -1) | |
e63679b8 | 1031 | (setq imenu--index-alist nil) |
bcaa1cef | 1032 | (setq imenu--last-menubar-index-alist nil) |
0cdb3baa SM |
1033 | (imenu-update-menubar) |
1034 | t) | |
1035 | (imenu item) | |
1036 | nil)) | |
5d3b0f18 | 1037 | |
37954a9a | 1038 | (defun imenu-default-goto-function (name position &optional rest) |
bfbc9ea9 | 1039 | "Move to the given position. |
fe2908be RS |
1040 | |
1041 | NAME is ignored. POSITION is where to move. REST is also ignored. | |
1042 | The ignored args just make this function have the same interface as a | |
1043 | function placed in a special index-item." | |
e7c8378c RS |
1044 | (if (or (< position (point-min)) |
1045 | (> position (point-max))) | |
37954a9a RS |
1046 | ;; widen if outside narrowing |
1047 | (widen)) | |
e7c8378c | 1048 | (goto-char position)) |
37954a9a | 1049 | |
68e01f5a | 1050 | ;;;###autoload |
6c1bf12b | 1051 | (defun imenu (index-item) |
68e01f5a | 1052 | "Jump to a place in the buffer chosen using a buffer menu or mouse menu. |
fe2908be RS |
1053 | INDEX-ITEM specifies the position. See `imenu-choose-buffer-index' |
1054 | for more information." | |
01e980fb | 1055 | (interactive (list (imenu-choose-buffer-index))) |
0a8e8bc6 KH |
1056 | ;; Convert a string to an alist element. |
1057 | (if (stringp index-item) | |
1058 | (setq index-item (assoc index-item (imenu--make-index-alist)))) | |
0cdb3baa SM |
1059 | (when index-item |
1060 | (push-mark) | |
1061 | (let* ((is-special-item (listp (cdr index-item))) | |
1062 | (function | |
1063 | (if is-special-item | |
1064 | (nth 2 index-item) imenu-default-goto-function)) | |
1065 | (position (if is-special-item | |
1066 | (cadr index-item) (cdr index-item))) | |
1067 | (rest (if is-special-item (cddr index-item)))) | |
1068 | (apply function (car index-item) position rest)) | |
1069 | (run-hooks 'imenu-after-jump-hook))) | |
5d3b0f18 | 1070 | |
f1ed9461 DL |
1071 | (dolist (mess |
1072 | '("^No items suitable for an index found in this buffer$" | |
1073 | "^This buffer cannot use `imenu-default-create-index-function'$" | |
1074 | "^The mode `.*' does not support Imenu$")) | |
1075 | (add-to-list 'debug-ignored-errors mess)) | |
1076 | ||
0a688fd0 RS |
1077 | (provide 'imenu) |
1078 | ||
bfbc9ea9 | 1079 | ;; arch-tag: 98a2f5f5-4b91-4704-b18c-3aacf77d77a7 |
0a688fd0 | 1080 | ;;; imenu.el ends here |