1 ;;; imenu.el --- Framework for mode-specific buffer indexes.
3 ;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Ake Stenhoff <etxaksf@aom.ericsson.se>
6 ;; Lars Lindberg <lli@sypro.cap.se>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; Purpose of this package:
30 ;; To present a framework for mode-specific buffer indexes.
31 ;; A buffer index is an alist of names and buffer positions.
32 ;; For instance all functions in a C-file and their positions.
36 ;; A mode-specific function is called to generate the index. It is
37 ;; then presented to the user, who can choose from this index.
39 ;; The package comes with a set of example functions for how to
40 ;; utilize this package.
42 ;; There are *examples* for index gathering functions/regular
43 ;; expressions for C/C++ and Lisp/Emacs Lisp but it is easy to
44 ;; customize for other modes. A function for jumping to the chosen
45 ;; index position is also supplied.
48 ;; [simon] - Simon Leinen simon@lia.di.epfl.ch
49 ;; [dean] - Dean Andrews ada@unison.com
50 ;; [alon] - Alon Albert al@mercury.co.il
51 ;; [greg] - Greg Thompson gregt@porsche.visix.COM
52 ;; [wolfgang] - Wolfgang Bangerth zcg51122@rpool1.rus.uni-stuttgart.de
53 ;; [kai] - Kai Grossjohann grossjoh@linus.informatik.uni-dortmund.de
54 ;; [david] - David M. Smith dsmith@stats.adelaide.edu.au
55 ;; [christian] - Christian Egli Christian.Egli@hcsd.hac.com
56 ;; [karl] - Karl Fogel kfogel@floss.life.uiuc.edu
60 (eval-when-compile (require 'cl
))
62 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
64 ;;; Customizable variables
66 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
67 (defvar imenu-use-keymap-menu nil
68 "*Non-nil means use a keymap when making the mouse menu.")
70 (defvar imenu-auto-rescan nil
71 "*Non-nil means Imenu should always rescan the buffers.")
73 (defvar imenu-auto-rescan-maxout
60000
74 "* auto-rescan is disabled in buffers larger than this.
75 This variable is buffer-local.")
77 (defvar imenu-always-use-completion-buffer-p nil
78 "*Set this to non-nil for displaying the index in a completion buffer.
80 Non-nil means always display the index in a completion buffer.
81 Nil means display the index as a mouse menu when the mouse was
82 used to invoke `imenu'.
83 `never' means never automatically display a listing of any kind.")
85 (defvar imenu-sort-function nil
86 "*The function to use for sorting the index mouse-menu.
88 Affects only the mouse index menu.
90 Set this to nil if you don't want any sorting (faster).
91 The items in the menu are then presented in the order they were found
94 Set it to `imenu--sort-by-name' if you want alphabetic sorting.
96 The function should take two arguments and return T if the first
97 element should come before the second. The arguments are cons cells;
98 \(NAME . POSITION). Look at `imenu--sort-by-name' for an example.")
100 (defvar imenu-max-items
25
101 "*Maximum number of elements in an index mouse-menu.")
103 (defvar imenu-scanning-message
"Scanning buffer for index (%3d%%)"
104 "*Progress message during the index scanning of the buffer.
105 If non-nil, user gets a message during the scanning of the buffer
107 Relevant only if the mode-specific function that creates the buffer
108 index use `imenu-progress-message'.")
110 (defvar imenu-space-replacement
"^"
111 "*The replacement string for spaces in index names.
112 Used when presenting the index in a completion-buffer to make the
113 names work as tokens.")
115 (defvar imenu-level-separator
":"
116 "*The separator between index names of different levels.
117 Used for making mouse-menu titles and for flattening nested indexes
118 with name concatenation.")
120 (defvar imenu-submenu-name-format
"%s..."
121 "*The format for making a submenu name.")
124 (defvar imenu-generic-expression nil
125 "The regex pattern to use for creating a buffer index.
127 If non-nil this pattern is passed to `imenu-create-index-with-pattern'
128 to create a buffer index.
130 It is an alist with elements that look like this: (MENU-TITLE
133 MENU-TITLE is a string used as the title for the submenu or nil if the
134 entries are not nested.
136 REGEXP is a regexp that should match a construct in the buffer that is
137 to be displayed in the menu; i.e., function or variable definitions,
138 etc. It contains a substring which is the name to appear in the
139 menu. See the info section on Regexps for more information.
141 INDEX points to the substring in REGEXP that contains the name (of the
142 function, variable or type) that is to appear in the menu.
144 For emacs-lisp-mode for example PATTERN would look like:
146 '((nil \"^\\\\s-*(def\\\\(un\\\\|subst\\\\|macro\\\\|advice\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2)
147 (\"*Vars*\" \"^\\\\s-*(def\\\\(var\\\\|const\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2)
148 (\"*Types*\" \"^\\\\s-*(def\\\\(type\\\\|struct\\\\|class\\\\|ine-condition\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2))
150 The variable is buffer-local.")
152 (make-variable-buffer-local 'imenu-generic-expression
)
156 (defvar imenu-create-index-function
'imenu-default-create-index-function
157 "The function to use for creating a buffer index.
159 It should be a function that takes no arguments and returns an index
160 of the current buffer as an alist. The elements in the alist look
161 like: (INDEX-NAME . INDEX-POSITION). You may also nest index list like
162 \(INDEX-NAME . INDEX-ALIST).
164 This function is called within a `save-excursion'.
166 The variable is buffer-local.")
167 (make-variable-buffer-local 'imenu-create-index-function
)
169 (defvar imenu-prev-index-position-function
'beginning-of-defun
170 "Function for finding the next index position.
172 If `imenu-create-index-function' is set to
173 `imenu-default-create-index-function', then you must set this variable
174 to a function that will find the next index, looking backwards in the
177 The function should leave point at the place to be connected to the
178 index and it should return nil when it doesn't find another index.")
179 (make-variable-buffer-local 'imenu-prev-index-position-function
)
181 (defvar imenu-extract-index-name-function nil
182 "Function for extracting the index name.
184 This function is called after the function pointed out by
185 `imenu-prev-index-position-function'.")
186 (make-variable-buffer-local 'imenu-extract-index-name-function
)
189 ;;; Macro to display a progress message.
190 ;;; RELPOS is the relative position to display.
191 ;;; If RELPOS is nil, then the relative position in the buffer
193 ;;; PREVPOS is the variable in which we store the last position displayed.
194 (defmacro imenu-progress-message
(prevpos &optional relpos reverse
)
196 imenu-scanning-message
197 (let ((pos (, (if relpos
199 (` (imenu--relative-position (, reverse
)))))))
201 (` (> pos
(+ 5 (, prevpos
))))))
203 (message imenu-scanning-message pos
)
204 (setq (, prevpos
) pos
)))))))
207 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
209 ;;;; Some examples of functions utilizing the framework of this
212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
214 ;; Return the current/previous sexp and the location of the sexp (its
215 ;; beginning) without moving the point.
216 (defun imenu-example--name-and-position ()
220 (end (progn (forward-sexp) (point)))
221 (marker (make-marker)))
222 (set-marker marker beg
)
223 (cons (buffer-substring beg end
)
230 (defun imenu-example--lisp-extract-index-name ()
231 ;; Example of a candidate for `imenu-extract-index-name-function'.
232 ;; This will generate a flat index of definitions in a lisp file.
234 (and (looking-at "(def")
240 (end (progn (forward-sexp -
1) (point))))
241 (buffer-substring beg end
)))
244 (defun imenu-example--create-lisp-index ()
245 ;; Example of a candidate for `imenu-create-index-function'.
246 ;; It will generate a nested index of definitions.
247 (let ((index-alist '())
248 (index-var-alist '())
249 (index-type-alist '())
250 (index-unknown-alist '())
252 (goto-char (point-max))
253 (imenu-progress-message prev-pos
0)
254 ;; Search for the function
255 (while (beginning-of-defun)
256 (imenu-progress-message prev-pos nil t
)
258 (and (looking-at "(def")
262 ((looking-at "def\\(var\\|const\\)")
264 (push (imenu-example--name-and-position)
266 ((looking-at "def\\(un\\|subst\\|macro\\|advice\\)")
268 (push (imenu-example--name-and-position)
270 ((looking-at "def\\(type\\|struct\\|class\\|ine-condition\\)")
272 (if (= (char-after (1- (point))) ?\
))
277 (push (imenu-example--name-and-position)
281 (push (imenu-example--name-and-position)
282 index-unknown-alist
)))))))
283 (imenu-progress-message prev-pos
100)
285 (push (cons (imenu-create-submenu-name "Variables") index-var-alist
)
287 (and index-type-alist
288 (push (cons (imenu-create-submenu-name "Types") index-type-alist
)
290 (and index-unknown-alist
291 (push (cons (imenu-create-submenu-name "Syntax-unknown") index-unknown-alist
)
295 ;; Regular expression to find C functions
296 (defvar imenu-example--function-name-regexp-c
298 "^[a-zA-Z0-9]+[ \t]?" ; type specs; there can be no
299 "\\([a-zA-Z0-9_*]+[ \t]+\\)?" ; more than 3 tokens, right?
300 "\\([a-zA-Z0-9_*]+[ \t]+\\)?"
301 "\\([*&]+[ \t]*\\)?" ; pointer
302 "\\([a-zA-Z0-9_*]+\\)[ \t]*(" ; name
305 (defun imenu-example--create-c-index (&optional regexp
)
306 (let ((index-alist '())
308 (goto-char (point-min))
309 (imenu-progress-message prev-pos
0)
310 ;; Search for the function
312 (while (re-search-forward
313 (or regexp imenu-example--function-name-regexp-c
)
315 (imenu-progress-message prev-pos
)
318 (goto-char (scan-sexps (point) 1))
319 (setq char
(following-char)))
320 ;; Skip this function name if it is a prototype declaration.
321 (if (not (eq char ?\
;))
322 (push (imenu-example--name-and-position) index-alist
))))
323 (imenu-progress-message prev-pos
100)
324 (nreverse index-alist
)))
327 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
329 ;;; Internal variables
331 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
333 ;; The item to use in the index for rescanning the buffer.
334 (defconst imenu--rescan-item
'("*Rescan*" . -
99))
336 ;; The latest buffer index.
338 (defvar imenu--index-alist nil
)
339 (make-variable-buffer-local 'imenu--index-alist
)
341 ;; The latest buffer index used to update the menu bar menu.
342 (defvar imenu--last-menubar-index-alist nil
)
343 (make-variable-buffer-local 'imenu--last-menubar-index-alist
)
345 ;; History list for 'jump-to-function-in-buffer'.
346 ;; Making this buffer local caused it not to work!
347 (defvar imenu--history-list nil
)
349 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
351 ;;; Internal support functions
353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
357 ;;; Sorts the items depending on their index name.
358 ;;; An item look like (NAME . POSITION).
360 (defun imenu--sort-by-name (item1 item2
)
361 (string-lessp (car item1
) (car item2
)))
363 (defun imenu--relative-position (&optional reverse
)
364 ;; Support function to calculate relative position in buffer
365 ;; Beginning of buffer is 0 and end of buffer is 100
366 ;; If REVERSE is non-nil then the beginning is 100 and the end is 0.
368 (total (buffer-size)))
369 (and reverse
(setq pos
(- total pos
)))
371 ;; Avoid overflow from multiplying by 100!
372 (/ (1- pos
) (max (/ total
100) 1))
373 (/ (* 100 (1- pos
)) (max total
1)))))
376 ;;; Function for supporting general looking submenu names.
377 ;;; Uses `imenu-submenu-name-format' for creating the name.
378 ;;; NAME is the base of the new submenu name.
380 (defun imenu-create-submenu-name (name)
381 (format imenu-submenu-name-format name
))
383 ;; Split LIST into sublists of max length N.
384 ;; Example (imenu--split '(1 2 3 4 5 6 7 8) 3)-> '((1 2 3) (4 5 6) (7 8))
385 (defun imenu--split (list n
)
391 (push (pop remain
) sublist
)
394 ;; We have finished a sublist
395 (progn (push (nreverse sublist
) result
)
397 (setq sublist
'()))))
398 ;; There might be a sublist (if the length of LIST mod n is != 0)
399 ;; that has to be added to the result list.
401 (push (nreverse sublist
) result
))
405 ;;; Split a menu in to several menus.
407 (defun imenu--split-menu (menulist title
)
412 (cons (format "(%s)" title
) menu
)))
413 (imenu--split menulist imenu-max-items
))))
416 ;;; Find all items in this buffer that should be in the index.
417 ;;; Returns an alist on the form
418 ;;; ((NAME . POSITION) (NAME . POSITION) ...)
421 (defun imenu--make-index-alist (&optional noerror
)
422 ;; Create a list for this buffer only when needed.
423 (or (and imenu--index-alist
424 (or (not imenu-auto-rescan
)
425 (and imenu-auto-rescan
426 (> (buffer-size) imenu-auto-rescan-maxout
))))
428 (setq imenu--index-alist
430 (funcall imenu-create-index-function
))))
431 (or imenu--index-alist noerror
432 (error "No items suitable for an index found in this buffer"))
433 (or imenu--index-alist
434 (setq imenu--index-alist
(list nil
)))
435 ;; Add a rescan option to the index.
436 (cons imenu--rescan-item imenu--index-alist
))
438 ;;; Find all markers in alist and makes
439 ;;; them point nowhere.
441 (defun imenu--cleanup (&optional alist
)
442 ;; Sets the markers in imenu--index-alist
444 ;; if alist is provided use that list.
446 (setq alist imenu--index-alist
))
452 ((markerp (cdr item
))
453 (set-marker (cdr item
) nil
))
455 (imenu--cleanup (cdr item
))))))
459 (defun imenu--create-keymap-2 (alist counter
&optional commands
)
466 (append (list (setq counter
(1+ counter
))
467 (car item
) 'keymap
(car item
))
468 (imenu--create-keymap-2 (cdr item
) (+ counter
10) commands
)))
470 (let ((end (if commands
`(lambda () (interactive)
471 (imenu--menubar-select ',item
))
474 (cons (car item
) end
))))
478 ;; If COMMANDS is non-nil, make a real keymap
479 ;; with a real command used as the definition.
480 ;; If it is nil, make something suitable for x-popup-menu.
481 (defun imenu--create-keymap-1 (title alist
&optional commands
)
482 (append (list 'keymap title
) (imenu--create-keymap-2 alist
0 commands
)))
485 (defun imenu--in-alist (str alist
)
486 "Check whether the string STR is contained in multi-level ALIST."
487 (let (elt head tail res
)
490 (setq elt
(car alist
)
494 (if (string= str head
)
495 (setq alist nil res elt
)
496 (if (and (listp tail
)
497 (setq res
(imenu--in-alist str tail
)))
501 (defun imenu-default-create-index-function ()
502 "*Wrapper for index searching functions.
504 Moves point to end of buffer and then repeatedly calls
505 `imenu-prev-index-position-function' and `imenu-extract-index-name-function'.
506 Their results are gathered into an index alist."
507 ;; These should really be done by setting imenu-create-index-function
508 ;; in these major modes. But save that change for later.
509 (cond ((and (fboundp imenu-prev-index-position-function
)
510 (fboundp imenu-extract-index-name-function
))
511 (let ((index-alist '())
513 (goto-char (point-max))
514 (imenu-progress-message prev-pos
0 t
)
515 ;; Search for the function
516 (while (funcall imenu-prev-index-position-function
)
517 (imenu-progress-message prev-pos nil t
)
519 (setq name
(funcall imenu-extract-index-name-function
)))
521 (push (cons name
(point)) index-alist
)))
522 (imenu-progress-message prev-pos
100 t
)
524 ;; Use generic expression if possible.
525 ((and imenu-generic-expression
)
526 (imenu--generic-function imenu-generic-expression
))
528 (error "The mode \"%s\" does not take full advantage of imenu.el yet."
531 (defun imenu--replace-spaces (name replacement
)
532 ;; Replace all spaces in NAME with REPLACEMENT.
533 ;; That second argument should be a string.
537 (if (char-equal ch ?\
)
539 (char-to-string ch
))))
543 (defun imenu--flatten-index-alist (index-alist &optional concat-names prefix
)
544 ;; Takes a nested INDEX-ALIST and returns a flat index alist.
545 ;; If optional CONCAT-NAMES is non-nil, then a nested index has its
546 ;; name and a space concatenated to the names of the children.
547 ;; Third argument PREFIX is for internal use only.
551 (let* ((name (car item
))
553 (new-prefix (and concat-names
555 (concat prefix imenu-level-separator name
)
558 ((or (markerp pos
) (numberp pos
))
559 (list (cons new-prefix pos
)))
561 (imenu--flatten-index-alist pos new-prefix
))))))
565 ;;; Generic index gathering function.
568 (defun imenu--generic-function (patterns)
569 ;; Built on some ideas that Erik Naggum <erik@naggum.no> once posted
571 "Return an index of the current buffer as an alist.
573 PATTERN is an alist with elements that look like this: (MENU-TITLE
576 MENU-TITLE is a string used as the title for the submenu or nil if the
577 entries are not nested.
579 REGEXP is a regexp that should match a construct in the buffer that is
580 to be displayed in the menu; i.e., function or variable definitions,
581 etc. It contains a substring which is the name to appear in the
582 menu. See the info section on Regexps for more information.
584 INDEX points to the substring in REGEXP that contains the name (of the
585 function, variable or type) that is to appear in the menu.
587 For emacs-lisp-mode for example PATTERN would look like:
589 '((nil \"^\\\\s-*(def\\\\(un\\\\|subst\\\\|macro\\\\|advice\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2)
590 (\"*Vars*\" \"^\\\\s-*(def\\\\(var\\\\|const\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2)
591 (\"*Types*\" \"^\\\\s-*(def\\\\(type\\\\|struct\\\\|class\\\\|ine-condition\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2))'
593 Returns an index of the current buffer as an alist. The elements in
594 the alist look like: (INDEX-NAME . INDEX-POSITION). They may also be
595 nested index lists like (INDEX-NAME . INDEX-ALIST) depending on
598 \(imenu--generic-function PATTERN\)."
600 (let ((index-alist (list 'dummy
))
605 (function (lambda (pattern) (identity (cadr pattern
))))
606 patterns
"\\)\\|\\(")
610 (goto-char (point-max))
611 (imenu-progress-message prev-pos
0 t
)
613 (while (re-search-backward global-regexp nil t
)
614 (imenu-progress-message prev-pos nil t
)
617 (goto-char (match-beginning 0))
621 (let ((menu-title (car pat
))
624 (if (and (not found
) ; Only allow one entry;
626 (let ((beg (match-beginning index
))
627 (end (match-end index
)))
630 (cons (buffer-substring beg end
) beg
)
632 (or (if (not (stringp menu-title
)) index-alist
)
634 (imenu-create-submenu-name menu-title
)
638 (imenu-create-submenu-name menu-title
)
640 index-alist
))))))))))
642 (imenu-progress-message prev-pos
100 t
)
643 (delete 'dummy index-alist
)))
645 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
647 ;;; The main functions for this package!
649 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
651 (defun imenu--completion-buffer (index-alist &optional prompt
)
652 "Let the user select from INDEX-ALIST in a completion buffer with PROMPT.
654 Returns t for rescan and otherwise a position number."
655 ;; Create a list for this buffer only when needed.
657 (prepared-index-alist
661 (cons (imenu--replace-spaces (car item
) imenu-space-replacement
)
664 (if (eq imenu-always-use-completion-buffer-p
'never
)
665 (setq name
(completing-read (or prompt
"Index item: ")
667 nil t nil
'imenu--history-list
))
668 (save-window-excursion
669 ;; Display the completion buffer
670 (with-output-to-temp-buffer "*Completions*"
671 (display-completion-list
672 (all-completions "" prepared-index-alist
)))
673 (let ((minibuffer-setup-hook
675 (let ((buffer (current-buffer)))
677 (set-buffer "*Completions*")
678 (setq completion-reference-buffer buffer
)))))))
679 ;; Make a completion question
680 (setq name
(completing-read (or prompt
"Index item: ")
682 nil t nil
'imenu--history-list
)))))
683 (cond ((not (stringp name
))
685 ((string= name
(car imenu--rescan-item
))
688 (setq choice
(assoc name prepared-index-alist
))
689 (if (listp (cdr choice
))
690 (imenu--completion-buffer (cdr choice
) prompt
)
693 (defun imenu--mouse-menu (index-alist event
&optional title
)
694 "Let the user select from a buffer index from a mouse menu.
696 INDEX-ALIST is the buffer index and EVENT is a mouse event.
698 Returns t for rescan and otherwise a position number."
699 (let* ((menu (imenu--split-menu
700 (if imenu-sort-function
703 (oldlist index-alist
))
704 ;; Copy list method from the cl package `copy-list'
705 (while (consp oldlist
) (push (pop oldlist
) res
))
706 (prog1 (nreverse res
) (setcdr res oldlist
)))
709 (or title
(buffer-name))))
711 (and imenu-use-keymap-menu
712 (setq menu
(imenu--create-keymap-1 (car menu
)
713 (if (< 1 (length (cdr menu
)))
715 (cdr (cadr menu
))))))
716 (setq position
(x-popup-menu event menu
))
717 (if imenu-use-keymap-menu
720 ((and (listp position
)
721 (numberp (car position
))
722 (stringp (nth (1- (length position
)) position
)))
723 (setq position
(nth (1- (length position
)) position
)))
724 ((and (stringp (car position
))
725 (null (cdr position
)))
726 (setq position
(car position
))))))
731 (imenu--mouse-menu position event
733 (concat title imenu-level-separator
734 (car (rassq position index-alist
)))
735 (car (rassq position index-alist
)))))
737 (or (string= position
(car imenu--rescan-item
))
738 (imenu--in-alist position index-alist
)))
739 ((or (= position
(cdr imenu--rescan-item
))
740 (and (stringp position
)
741 (string= position
(car imenu--rescan-item
))))
744 (rassq position index-alist
)))))
746 (defun imenu-choose-buffer-index (&optional prompt alist
)
747 "Let the user select from a buffer index and return the chosen index.
749 If the user originally activated this function with the mouse, a mouse
750 menu is used. Otherwise a completion buffer is used and the user is
751 prompted with PROMPT.
753 If you call this function with index alist ALIST, then it lets the user
756 With no index alist ALIST, it calls `imenu--make-index-alist' to
757 create the index alist.
759 If `imenu-always-use-completion-buffer-p' is non-nil, then the
760 completion buffer is always used, no matter if the mouse was used or
763 The returned value is on the form (INDEX-NAME . INDEX-POSITION)."
765 (mouse-triggered (listp last-nonmenu-event
))
767 ;; If selected by mouse, see to that the window where the mouse is
768 ;; really is selected.
770 (not (equal last-nonmenu-event
'(menu-bar)))
771 (let ((window (posn-window (event-start last-nonmenu-event
))))
772 (or (framep window
) (null window
) (select-window window
))))
773 ;; Create a list for this buffer only when needed.
775 (setq index-alist
(if alist alist
(imenu--make-index-alist)))
777 (if (and mouse-triggered
778 (not imenu-always-use-completion-buffer-p
))
779 (imenu--mouse-menu index-alist last-nonmenu-event
)
780 (imenu--completion-buffer index-alist prompt
)))
783 (setq imenu--index-alist nil
)))
787 (defun imenu-add-to-menubar (name)
788 "Adds an \"imenu\" entry to the menu bar for the current major mode.
789 NAME is a string used to name the menu bar item.
790 See `imenu' for more information."
791 (interactive "sImenu menu item name: ")
792 (define-key (current-local-map) [menu-bar index
]
793 (cons name
(nconc (make-sparse-keymap "Imenu") (make-sparse-keymap))))
794 (add-hook 'menu-bar-update-hook
'imenu-update-menubar
))
796 (defun imenu-update-menubar ()
797 (and (current-local-map)
798 (keymapp (lookup-key (current-local-map) [menu-bar index
]))
799 (let ((index-alist (imenu--make-index-alist t
)))
800 ;; Don't bother updating if the index-alist has not changed
801 ;; since the last time we did it.
802 (or (equal index-alist imenu--last-menubar-index-alist
)
803 (let (menu menu1 old
)
804 (setq imenu--last-menubar-index-alist index-alist
)
805 (setq menu
(imenu--split-menu
806 (if imenu-sort-function
809 (oldlist index-alist
))
810 ;; Copy list method from the cl package `copy-list'
811 (while (consp oldlist
) (push (pop oldlist
) res
))
812 (prog1 (nreverse res
) (setcdr res oldlist
)))
816 (setq menu1
(imenu--create-keymap-1 (car menu
)
817 (if (< 1 (length (cdr menu
)))
819 (cdr (car (cdr menu
))))
821 (setq old
(lookup-key (current-local-map) [menu-bar index
]))
823 (setcdr (nthcdr 2 old
) menu1
)))))))
825 (defun imenu--menubar-select (item)
826 "Use Imenu to select the function or variable named in this menu item."
831 (defun imenu (index-item)
832 "Jump to a place in the buffer chosen using a buffer menu or mouse menu.
833 See `imenu-choose-buffer-index' for more information."
835 (list (save-restriction
837 (car (imenu-choose-buffer-index)))))
838 ;; Convert a string to an alist element.
839 (if (stringp index-item
)
840 (setq index-item
(assoc index-item
(imenu--make-index-alist))))
845 ((markerp (cdr index-item
))
846 (if (or ( > (marker-position (cdr index-item
)) (point-min))
847 ( < (marker-position (cdr index-item
)) (point-max)))
848 ;; widen if outside narrowing
850 (goto-char (marker-position (cdr index-item
))))
852 (if (or ( > (cdr index-item
) (point-min))
853 ( < (cdr index-item
) (point-max)))
854 ;; widen if outside narrowing
856 (goto-char (cdr index-item
)))))))
860 ;;; imenu.el ends here