(eval-when-compile (require 'cl))
(defgroup imenu nil
"Mode-specific buffer indexes."
:group 'matching
:group 'frames
:group 'convenience
:link '(custom-manual "(elisp)Imenu"))
(defcustom imenu-use-markers t
"*Non-nil means use markers instead of integers for Imenu buffer positions.
Setting this to nil makes Imenu work a little faster but editing the
buffer will make the generated index positions wrong.
This might not yet be honored by all index-building functions."
:type 'boolean
:group 'imenu)
(defcustom imenu-max-item-length 60
"*If a number, truncate Imenu entries to that length."
:type '(choice integer
(const :tag "Unlimited"))
:group 'imenu)
(defcustom imenu-auto-rescan nil
"*Non-nil means Imenu should always rescan the buffers."
:type 'boolean
:group 'imenu)
(defcustom imenu-auto-rescan-maxout 60000
"*Imenu auto-rescan is disabled in buffers larger than this size (in bytes).
This variable is buffer-local."
:type 'integer
:group 'imenu)
(defvar imenu-always-use-completion-buffer-p nil)
(make-obsolete-variable 'imenu-always-use-completion-buffer-p
'imenu-use-popup-menu "22.1")
(defcustom imenu-use-popup-menu
(if imenu-always-use-completion-buffer-p
(not (eq imenu-always-use-completion-buffer-p 'never))
'on-mouse)
"Use a popup menu rather than a minibuffer prompt.
If nil, always use a minibuffer prompt.
If t, always use a popup menu,
If `on-mouse' use a popup menu when `imenu' was invoked with the mouse."
:type '(choice (const :tag "On Mouse" on-mouse)
(const :tag "Never" nil)
(other :tag "Always" t))
:group 'imenu)
(defcustom imenu-eager-completion-buffer
(not (eq imenu-always-use-completion-buffer-p 'never))
"If non-nil, eagerly popup the completion buffer."
:type 'boolean
:group 'imenu
:version "22.1")
(defcustom imenu-after-jump-hook nil
"*Hooks called after jumping to a place in the buffer.
Useful things to use here include `reposition-window', `recenter', and
\(lambda () (recenter 0)) to show at top of screen."
:type 'hook
:group 'imenu)
(defcustom imenu-sort-function nil
"*The function to use for sorting the index mouse-menu.
Affects only the mouse index menu.
Set this to nil if you don't want any sorting (faster).
The items in the menu are then presented in the order they were found
in the buffer.
Set it to `imenu--sort-by-name' if you want alphabetic sorting.
The function should take two arguments and return t if the first
element should come before the second. The arguments are cons cells;
\(NAME . POSITION). Look at `imenu--sort-by-name' for an example."
:type '(choice (const :tag "No sorting" nil)
(const :tag "Sort by name" imenu--sort-by-name)
(function :tag "Another function"))
:group 'imenu)
(defcustom imenu-max-items 25
"*Maximum number of elements in a mouse menu for Imenu."
:type 'integer
:group 'imenu)
(defcustom imenu-space-replacement "."
"*The replacement string for spaces in index names.
Used when presenting the index in a completion buffer to make the
names work as tokens."
:type '(choice string (const nil))
:group 'imenu)
(defcustom imenu-level-separator ":"
"*The separator between index names of different levels.
Used for making mouse-menu titles and for flattening nested indexes
with name concatenation."
:type 'string
:group 'imenu)
(defvar imenu-generic-expression nil
"The regex pattern to use for creating a buffer index.
If non-nil this pattern is passed to `imenu--generic-function' to
create a buffer index. Look there for the documentation of this
pattern's structure.
For example, see the value of `fortran-imenu-generic-expression' used by
`fortran-mode' with `imenu-syntax-alist' set locally to give the
characters which normally have \"symbol\" syntax \"word\" syntax
during matching.")
(make-variable-buffer-local 'imenu-generic-expression)
(defvar imenu-create-index-function 'imenu-default-create-index-function
"The function to use for creating an index alist of the current buffer.
It should be a function that takes no arguments and returns
an index alist of the current buffer. The function is
called within a `save-excursion'.
See `imenu--index-alist' for the format of the buffer index alist.")
(make-variable-buffer-local 'imenu-create-index-function)
(defvar imenu-prev-index-position-function 'beginning-of-defun
"Function for finding the next index position.
If `imenu-create-index-function' is set to
`imenu-default-create-index-function', then you must set this variable
to a function that will find the next index, looking backwards in the
file.
The function should leave point at the place to be connected to the
index and it should return nil when it doesn't find another index.")
(make-variable-buffer-local 'imenu-prev-index-position-function)
(defvar imenu-extract-index-name-function nil
"Function for extracting the index item name, given a position.
This function is called after `imenu-prev-index-position-function'
finds a position for an index item, with point at that position.
It should return the name for that index item.")
(make-variable-buffer-local 'imenu-extract-index-name-function)
(defvar imenu-name-lookup-function nil
"Function to compare string with index item.
This function will be called with two strings, and should return
non-nil if they match.
If nil, comparison is done with `string='.
Set this to some other function for more advanced comparisons,
such as \"begins with\" or \"name matches and number of
arguments match\".")
(make-variable-buffer-local 'imenu-name-lookup-function)
(defvar imenu-default-goto-function 'imenu-default-goto-function
"The default function called when selecting an Imenu item.
The function in this variable is called when selecting a normal index-item.")
(make-variable-buffer-local 'imenu-default-goto-function)
(defun imenu--subalist-p (item)
(and (consp (cdr item)) (listp (cadr item))
(not (eq (car (cadr item)) 'lambda))))
(defmacro imenu-progress-message (prevpos &optional relpos reverse)
)
(defun imenu-example--name-and-position ()
"Return the current/previous sexp and its (beginning) location.
Don't move point."
(save-excursion
(forward-sexp -1)
(let ((beg (if imenu-use-markers (point-marker) (point)))
(end (progn (forward-sexp) (point))))
(cons (buffer-substring beg end)
beg))))
(defun imenu-example--lisp-extract-index-name ()
(save-match-data
(and (looking-at "(def")
(condition-case nil
(progn
(down-list 1)
(forward-sexp 2)
(let ((beg (point))
(end (progn (forward-sexp -1) (point))))
(buffer-substring beg end)))
(error nil)))))
(defun imenu-example--create-lisp-index ()
(let ((index-alist '())
(index-var-alist '())
(index-type-alist '())
(index-unknown-alist '())
prev-pos)
(goto-char (point-max))
(imenu-progress-message prev-pos 0)
(while (beginning-of-defun)
(imenu-progress-message prev-pos nil t)
(save-match-data
(and (looking-at "(def")
(save-excursion
(down-list 1)
(cond
((looking-at "def\\(var\\|const\\)")
(forward-sexp 2)
(push (imenu-example--name-and-position)
index-var-alist))
((looking-at "def\\(un\\|subst\\|macro\\|advice\\)")
(forward-sexp 2)
(push (imenu-example--name-and-position)
index-alist))
((looking-at "def\\(type\\|struct\\|class\\|ine-condition\\)")
(forward-sexp 2)
(if (= (char-after (1- (point))) ?\))
(progn
(forward-sexp -1)
(down-list 1)
(forward-sexp 1)))
(push (imenu-example--name-and-position)
index-type-alist))
(t
(forward-sexp 2)
(push (imenu-example--name-and-position)
index-unknown-alist)))))))
(imenu-progress-message prev-pos 100)
(and index-var-alist
(push (cons "Variables" index-var-alist)
index-alist))
(and index-type-alist
(push (cons "Types" index-type-alist)
index-alist))
(and index-unknown-alist
(push (cons "Syntax-unknown" index-unknown-alist)
index-alist))
index-alist))
(defvar imenu-example--function-name-regexp-c
(concat
"^[a-zA-Z0-9]+[ \t]?" "\\([a-zA-Z0-9_*]+[ \t]+\\)?" "\\([a-zA-Z0-9_*]+[ \t]+\\)?"
"\\([*&]+[ \t]*\\)?" "\\([a-zA-Z0-9_*]+\\)[ \t]*(" ))
(defun imenu-example--create-c-index (&optional regexp)
(let ((index-alist '())
prev-pos char)
(goto-char (point-min))
(imenu-progress-message prev-pos 0)
(save-match-data
(while (re-search-forward
(or regexp imenu-example--function-name-regexp-c)
nil t)
(imenu-progress-message prev-pos)
(backward-up-list 1)
(save-excursion
(goto-char (scan-sexps (point) 1))
(setq char (following-char)))
(if (not (eq char ?\ (push (imenu-example--name-and-position) index-alist))))
(imenu-progress-message prev-pos 100)
(nreverse index-alist)))
(defconst imenu--rescan-item '("*Rescan*" . -99))
(defvar imenu--index-alist nil
"The buffer index alist computed for this buffer in Imenu.
Simple elements in the alist look like (INDEX-NAME . POSITION).
POSITION is the buffer position of the item; to go to the item
is simply to move point to that position.
Special elements look like (INDEX-NAME POSITION FUNCTION ARGUMENTS...).
To \"go to\" a special element means applying FUNCTION
to INDEX-NAME, POSITION, and the ARGUMENTS.
A nested sub-alist element looks like (INDEX-NAME SUB-ALIST).
The function `imenu--subalist-p' tests an element and returns t
if it is a sub-alist.
There is one simple element with negative POSITION; selecting that
element recalculates the buffer's index alist.")
(make-variable-buffer-local 'imenu--index-alist)
(defvar imenu--last-menubar-index-alist nil
"The latest buffer index alist used to update the menu bar menu.")
(make-variable-buffer-local 'imenu--last-menubar-index-alist)
(defvar imenu--history-list nil)
(defun imenu--sort-by-name (item1 item2)
(string-lessp (car item1) (car item2)))
(defun imenu--sort-by-position (item1 item2)
(< (cdr item1) (cdr item2)))
(defun imenu--relative-position (&optional reverse)
(let ((pos (point))
(total (buffer-size)))
(and reverse (setq pos (- total pos)))
(if (> total 50000)
(/ (1- pos) (max (/ total 100) 1))
(/ (* 100 (1- pos)) (max total 1)))))
(defun imenu--split (list n)
(let ((remain list)
(result '())
(sublist '())
(i 0))
(while remain
(push (pop remain) sublist)
(incf i)
(and (= i n)
(progn (push (nreverse sublist) result)
(setq i 0)
(setq sublist '()))))
(and sublist
(push (nreverse sublist) result))
(nreverse result)))
(defun imenu--split-menu (menulist title)
(let (keep-at-top tail)
(if (memq imenu--rescan-item menulist)
(setq keep-at-top (cons imenu--rescan-item nil)
menulist (delq imenu--rescan-item menulist)))
(setq tail menulist)
(dolist (item tail)
(when (imenu--subalist-p item)
(push item keep-at-top)
(setq menulist (delq item menulist))))
(if imenu-sort-function
(setq menulist (sort (copy-sequence menulist) imenu-sort-function)))
(if (> (length menulist) imenu-max-items)
(setq menulist
(mapcar
(lambda (menu)
(cons (format "From: %s" (caar menu)) menu))
(imenu--split menulist imenu-max-items))))
(cons title
(nconc (nreverse keep-at-top) menulist))))
(defun imenu--split-submenus (alist)
(mapcar (function
(lambda (elt)
(if (and (consp elt)
(stringp (car elt))
(listp (cdr elt)))
(imenu--split-menu (cdr elt) (car elt))
elt)))
alist))
(defun imenu--truncate-items (menulist)
(mapcar (function
(lambda (item)
(cond
((consp (cdr item))
(imenu--truncate-items (cdr item)))
((and (numberp imenu-max-item-length)
(> (length (car item)) imenu-max-item-length))
(setcar item (substring (car item) 0 imenu-max-item-length))))))
menulist))
(defun imenu--make-index-alist (&optional noerror)
"Create an index alist for the definitions in the current buffer.
This works by using the hook function `imenu-create-index-function'.
Report an error if the list is empty unless NOERROR is supplied and
non-nil.
See `imenu--index-alist' for the format of the index alist."
(or (and imenu--index-alist
(or (not imenu-auto-rescan)
(and imenu-auto-rescan
(> (buffer-size) imenu-auto-rescan-maxout))))
(progn
(setq imenu--index-alist
(save-excursion
(save-restriction
(widen)
(funcall imenu-create-index-function))))
(imenu--truncate-items imenu--index-alist)))
(or imenu--index-alist noerror
(error "No items suitable for an index found in this buffer"))
(or imenu--index-alist
(setq imenu--index-alist (list nil)))
(cons imenu--rescan-item imenu--index-alist))
(defvar imenu--cleanup-seen)
(defun imenu--cleanup (&optional alist)
(if alist
(setq imenu--cleanup-seen (cons alist imenu--cleanup-seen))
(setq alist imenu--index-alist imenu--cleanup-seen (list alist)))
(and alist
(mapc
(lambda (item)
(cond
((markerp (cdr item))
(set-marker (cdr item) nil))
((memq (cdr item) imenu--cleanup-seen))
((imenu--subalist-p item)
(imenu--cleanup (cdr item)))))
alist)
t))
(defun imenu--create-keymap (title alist &optional cmd)
(list* 'keymap title
(mapcar
(lambda (item)
(list* (car item) (car item)
(cond
((imenu--subalist-p item)
(imenu--create-keymap (car item) (cdr item) cmd))
(t
`(lambda () (interactive)
,(if cmd `(,cmd ',item) (list 'quote item)))))))
alist)))
(defun imenu--in-alist (str alist)
"Check whether the string STR is contained in multi-level ALIST."
(let (elt head tail res)
(setq res nil)
(while alist
(setq elt (car alist)
tail (cdr elt)
alist (cdr alist)
head (car elt))
(cond ((listp tail)
(if (setq res (imenu--in-alist str tail))
(setq alist nil)))
((if imenu-name-lookup-function
(funcall imenu-name-lookup-function str head)
(string= str head))
(setq alist nil res elt))))
res))
(defvar imenu-syntax-alist nil
"Alist of syntax table modifiers to use while in `imenu--generic-function'.
The car of the assocs may be either a character or a string and the
cdr is a syntax description appropriate for `modify-syntax-entry'. For
a string, all the characters in the string get the specified syntax.
This is typically used to give word syntax to characters which
normally have symbol syntax to simplify `imenu-expression'
and speed-up matching.")
(make-variable-buffer-local 'imenu-syntax-alist)
(defun imenu-default-create-index-function ()
"*Default function to create an index alist of the current buffer.
The most general method is to move point to end of buffer, then repeatedly call
`imenu-prev-index-position-function' and `imenu-extract-index-name-function'.
All the results returned by the latter are gathered into an index alist.
This method is used if those two variables are non-nil.
The alternate method, which is the one most often used, is to call
`imenu--generic-function' with `imenu-generic-expression' as argument."
(cond ((and imenu-prev-index-position-function
imenu-extract-index-name-function)
(let ((index-alist '())
prev-pos name)
(goto-char (point-max))
(imenu-progress-message prev-pos 0 t)
(while (funcall imenu-prev-index-position-function)
(imenu-progress-message prev-pos nil t)
(save-excursion
(setq name (funcall imenu-extract-index-name-function)))
(and (stringp name)
(push (cons name (if imenu-use-markers (point-marker) (point)))
index-alist)))
(imenu-progress-message prev-pos 100 t)
index-alist))
((and imenu-generic-expression)
(imenu--generic-function imenu-generic-expression))
(t
(error "This buffer cannot use `imenu-default-create-index-function'"))))
(defvar imenu-case-fold-search t
"Defines whether `imenu--generic-function' should fold case when matching.
This variable should be set (only) by initialization code
for modes which use `imenu--generic-function'. If it is not set, but
`font-lock-defaults' is set, then font-lock's setting is used.")
(make-variable-buffer-local 'imenu-case-fold-search)
(defun imenu--generic-function (patterns)
"Return an index alist of the current buffer based on PATTERNS.
PATTERNS is an alist with elements that look like this:
(MENU-TITLE REGEXP INDEX)
or like this:
(MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...)
with zero or more ARGUMENTS. The former format creates a simple
element in the index alist when it matches; the latter creates a
special element of the form (INDEX-NAME POSITION-MARKER FUNCTION
ARGUMENTS...) with FUNCTION and ARGUMENTS copied from PATTERNS.
MENU-TITLE is a string used as the title for the submenu or nil
if the entries are not nested.
REGEXP is a regexp that should match a construct in the buffer
that is to be displayed in the menu; i.e., function or variable
definitions, etc. It contains a substring which is the name to
appear in the menu. See the info section on Regexps for more
information. REGEXP may also be a function, called without
arguments. It is expected to search backwards. It shall return
true and set `match-data' iff it finds another element.
INDEX points to the substring in REGEXP that contains the
name (of the function, variable or type) that is to appear in the
menu.
The variable `imenu-case-fold-search' determines whether or not the
regexp matches are case sensitive, and `imenu-syntax-alist' can be
used to alter the syntax table for the search.
See `lisp-imenu-generic-expression' for an example of PATTERNS.
Returns an index of the current buffer as an alist. The elements in
the alist look like:
(INDEX-NAME . INDEX-POSITION)
or like:
(INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...)
They may also be nested index alists like:
(INDEX-NAME . INDEX-ALIST)
depending on PATTERNS."
(let ((index-alist (list 'dummy))
prev-pos
(case-fold-search (if (or (local-variable-p 'imenu-case-fold-search)
(not (local-variable-p 'font-lock-defaults)))
imenu-case-fold-search
(nth 2 font-lock-defaults)))
(old-table (syntax-table))
(table (copy-syntax-table (syntax-table)))
(slist imenu-syntax-alist))
(dolist (syn slist)
(if (numberp (car syn))
(modify-syntax-entry (car syn) (cdr syn) table)
(mapc (lambda (c)
(modify-syntax-entry c (cdr syn) table))
(car syn))))
(goto-char (point-max))
(imenu-progress-message prev-pos 0 t)
(unwind-protect (save-match-data
(set-syntax-table table)
(dolist (pat patterns)
(let ((menu-title (car pat))
(regexp (nth 1 pat))
(index (nth 2 pat))
(function (nth 3 pat))
(rest (nthcdr 4 pat))
start beg)
(goto-char (point-max))
(while (and (if (functionp regexp)
(funcall regexp)
(re-search-backward regexp nil t))
(not (= (match-beginning 0) (match-end 0))))
(setq start (point))
(goto-char (match-beginning index))
(beginning-of-line)
(setq beg (point))
(imenu-progress-message prev-pos nil t)
(unless (assoc menu-title index-alist)
(push (list menu-title) index-alist))
(if imenu-use-markers
(setq beg (copy-marker beg)))
(let ((item
(if function
(nconc (list (match-string-no-properties index)
beg function)
rest)
(cons (match-string-no-properties index)
beg)))
(menu (assoc menu-title index-alist)))
(unless (member item (cdr menu))
(setcdr menu
(cons item (cdr menu)))))
(goto-char start))))
(set-syntax-table old-table)))
(imenu-progress-message prev-pos 100 t)
(dolist (item index-alist)
(when (listp item)
(setcdr item (sort (cdr item) 'imenu--sort-by-position))))
(let ((main-element (assq nil index-alist)))
(nconc (delq main-element (delq 'dummy index-alist))
(cdr main-element)))))
(defun imenu-find-default (guess completions)
"Fuzzily find an item based on GUESS inside the alist COMPLETIONS."
(catch 'found
(let ((case-fold-search t))
(if (assoc guess completions) guess
(dolist (re (list (concat "\\`" (regexp-quote guess) "\\'")
(concat "\\`" (regexp-quote guess))
(concat (regexp-quote guess) "\\'")
(regexp-quote guess)))
(dolist (x completions)
(if (string-match re (car x)) (throw 'found (car x)))))))))
(defun imenu--completion-buffer (index-alist &optional prompt)
"Let the user select from INDEX-ALIST in a completion buffer with PROMPT.
Return one of the entries in index-alist or nil."
(let ((name (thing-at-point 'symbol))
choice
(prepared-index-alist
(if (not imenu-space-replacement) index-alist
(mapcar
(lambda (item)
(cons (subst-char-in-string ?\s (aref imenu-space-replacement 0)
(car item))
(cdr item)))
index-alist))))
(when (stringp name)
(setq name (or (imenu-find-default name prepared-index-alist) name)))
(cond (prompt)
((and name (imenu--in-alist name prepared-index-alist))
(setq prompt (format "Index item (default %s): " name)))
(t (setq prompt "Index item: ")))
(let ((minibuffer-setup-hook minibuffer-setup-hook))
(if (not imenu-eager-completion-buffer)
(add-hook 'minibuffer-setup-hook 'minibuffer-completion-help))
(setq name (completing-read prompt
prepared-index-alist
nil t nil 'imenu--history-list name)))
(when (stringp name)
(setq choice (assoc name prepared-index-alist))
(if (imenu--subalist-p choice)
(imenu--completion-buffer (cdr choice) prompt)
choice))))
(defun imenu--mouse-menu (index-alist event &optional title)
"Let the user select from a buffer index from a mouse menu.
INDEX-ALIST is the buffer index and EVENT is a mouse event.
Returns t for rescan and otherwise an element or subelement of INDEX-ALIST."
(setq index-alist (imenu--split-submenus index-alist))
(let* ((menu (imenu--split-menu index-alist (or title (buffer-name))))
(map (imenu--create-keymap (car menu)
(cdr (if (< 1 (length (cdr menu)))
menu
(car (cdr menu)))))))
(popup-menu map event)))
(defun imenu-choose-buffer-index (&optional prompt alist)
"Let the user select from a buffer index and return the chosen index.
If the user originally activated this function with the mouse, a mouse
menu is used. Otherwise a completion buffer is used and the user is
prompted with PROMPT.
If you call this function with index alist ALIST, then it lets the user
select from ALIST.
With no index alist ALIST, it calls `imenu--make-index-alist' to
create the index alist.
If `imenu-use-popup-menu' is nil, then the completion buffer
is always used, no matter if the mouse was used or not.
The returned value is of the form (INDEX-NAME . INDEX-POSITION)."
(let (index-alist
(mouse-triggered (listp last-nonmenu-event))
(result t))
(and mouse-triggered
(not (equal last-nonmenu-event '(menu-bar)))
(let ((window (posn-window (event-start last-nonmenu-event))))
(or (framep window) (null window) (select-window window))))
(while (eq result t)
(setq index-alist (if alist alist (imenu--make-index-alist)))
(setq result
(if (and imenu-use-popup-menu
(or (eq imenu-use-popup-menu t) mouse-triggered))
(imenu--mouse-menu index-alist last-nonmenu-event)
(imenu--completion-buffer index-alist prompt)))
(and (equal result imenu--rescan-item)
(imenu--cleanup)
(setq result t imenu--index-alist nil)))
result))
(defun imenu-add-to-menubar (name)
"Add an `imenu' entry to the menu bar for the current buffer.
NAME is a string used to name the menu bar item.
See the command `imenu' for more information."
(interactive "sImenu menu item name: ")
(if (or (and imenu-prev-index-position-function
imenu-extract-index-name-function)
imenu-generic-expression
(not (eq imenu-create-index-function
'imenu-default-create-index-function)))
(let ((newmap (make-sparse-keymap)))
(set-keymap-parent newmap (current-local-map))
(setq imenu--last-menubar-index-alist nil)
(define-key newmap [menu-bar index]
`(menu-item ,name ,(make-sparse-keymap "Imenu")))
(use-local-map newmap)
(add-hook 'menu-bar-update-hook 'imenu-update-menubar))
(error "The mode `%s' does not support Imenu" mode-name)))
(defun imenu-add-menubar-index ()
"Add an Imenu \"Index\" entry on the menu bar for the current buffer.
A trivial interface to `imenu-add-to-menubar' suitable for use in a hook."
(interactive)
(imenu-add-to-menubar "Index"))
(defvar imenu-buffer-menubar nil)
(defvar imenu-menubar-modified-tick 0
"The value of (buffer-chars-modified-tick) as of the last call
to `imenu-update-menubar'.")
(make-variable-buffer-local 'imenu-menubar-modified-tick)
(defun imenu-update-menubar ()
(when (and (current-local-map)
(keymapp (lookup-key (current-local-map) [menu-bar index]))
(/= (buffer-chars-modified-tick) imenu-menubar-modified-tick))
(setq imenu-menubar-modified-tick (buffer-chars-modified-tick))
(let ((index-alist (imenu--make-index-alist t)))
(unless (equal index-alist imenu--last-menubar-index-alist)
(let (menu menu1 old)
(setq imenu--last-menubar-index-alist index-alist)
(setq index-alist (imenu--split-submenus index-alist))
(setq menu (imenu--split-menu index-alist
(buffer-name)))
(setq menu1 (imenu--create-keymap (car menu)
(cdr (if (< 1 (length (cdr menu)))
menu
(car (cdr menu))))
'imenu--menubar-select))
(setq old (lookup-key (current-local-map) [menu-bar index]))
(setcdr old (cdr menu1)))))))
(defun imenu--menubar-select (item)
"Use Imenu to select the function or variable named in this menu ITEM."
(if (equal item imenu--rescan-item)
(progn
(imenu--cleanup)
(setq imenu-menubar-modified-tick -1)
(setq imenu--index-alist nil)
(setq imenu--last-menubar-index-alist nil)
(imenu-update-menubar)
t)
(imenu item)
nil))
(defun imenu-default-goto-function (name position &optional rest)
"Move to the given position.
NAME is ignored. POSITION is where to move. REST is also ignored.
The ignored args just make this function have the same interface as a
function placed in a special index-item."
(if (or (< position (point-min))
(> position (point-max)))
(widen))
(goto-char position))
(defun imenu (index-item)
"Jump to a place in the buffer chosen using a buffer menu or mouse menu.
INDEX-ITEM specifies the position. See `imenu-choose-buffer-index'
for more information."
(interactive (list (imenu-choose-buffer-index)))
(if (stringp index-item)
(setq index-item (assoc index-item (imenu--make-index-alist))))
(when index-item
(push-mark)
(let* ((is-special-item (listp (cdr index-item)))
(function
(if is-special-item
(nth 2 index-item) imenu-default-goto-function))
(position (if is-special-item
(cadr index-item) (cdr index-item)))
(rest (if is-special-item (cddr index-item))))
(apply function (car index-item) position rest))
(run-hooks 'imenu-after-jump-hook)))
(dolist (mess
'("^No items suitable for an index found in this buffer$"
"^This buffer cannot use `imenu-default-create-index-function'$"
"^The mode `.*' does not support Imenu$"))
(add-to-list 'debug-ignored-errors mess))
(provide 'imenu)