(other :tag "Always" t))
:group 'imenu)
+(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)
+
;;;###autoload
(defcustom imenu-sort-function nil
"*The function to use for sorting the index mouse-menu.
Set it to `imenu--sort-by-name' if you want alphabetic sorting.
-The function should take two arguments and return T if the first
+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)
+ (const :tag "Sort by name" imenu--sort-by-name)
(function :tag "Another function"))
:group 'imenu)
;;;###autoload
(make-variable-buffer-local 'imenu-extract-index-name-function)
+;;;###autoload
+(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\".
+
+This variable is local in all buffers.")
+;;;###autoload
+(make-variable-buffer-local 'imenu-name-lookup-function)
+
;;;###autoload
(defvar imenu-default-goto-function 'imenu-default-goto-function
"The default function called when selecting an Imenu item.
(make-variable-buffer-local 'imenu--index-alist)
-;; The latest buffer index used to update the menu bar menu.
-(defvar imenu--last-menubar-index-alist nil)
+(defvar imenu--last-menubar-index-alist nil
+ "The latest buffer index used to update the menu bar menu.")
+
(make-variable-buffer-local 'imenu--last-menubar-index-alist)
;; History list for 'jump-to-function-in-buffer'.
;;;
;;; Sort function
;;; Sorts the items depending on their index name.
-;;; An item look like (NAME . POSITION).
+;;; An item looks like (NAME . POSITION).
;;;
(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)
;; Support function to calculate relative position in buffer
;; Beginning of buffer is 0 and end of buffer is 100
(cond ((listp tail)
(if (setq res (imenu--in-alist str tail))
(setq alist nil)))
- ((string= str head)
+ ((if imenu-name-lookup-function
+ (funcall imenu-name-lookup-function str head)
+ (string= str head))
(setq alist nil res elt))))
res))
rest)
(cons (match-string-no-properties index)
beg)))
- (menu (cdr (assoc menu-title index-alist))))
- ;; avoid duplicates from, e.g. cc-mode patterns
- (unless (member item menu)
- ;; insert the item after the (sub-)menu title
- (setcdr (assoc menu-title index-alist)
- (cons item menu))))))))
+ ;; This is the desired submenu,
+ ;; starting with its title (or nil).
+ (menu (assoc menu-title index-alist)))
+ ;; Insert the item unless it is already present.
+ (unless (member item (cdr menu))
+ (setcdr menu
+ (cons item (cdr menu)))))))))
patterns)
(set-syntax-table old-table)))
(imenu-progress-message prev-pos 100 t)
+ ;; Sort each submenu by position.
+ ;; This is in case one submenu gets items from two different regexps.
+ (let ((tail index-alist))
+ (while tail
+ (if (listp (car tail))
+ (setcdr (car tail)
+ (sort (cdr (car tail)) 'imenu--sort-by-position)))
+ (setq tail (cdr tail))))
(let ((main-element (assq nil index-alist)))
(nconc (delq main-element (delq 'dummy index-alist))
(cdr main-element)))))
(stringp (nth (1- (length position)) position)))
(let ((final menu))
(while position
- (setq final (assoc (car position) final))
+ (setq final (assq (car position) final))
(setq position (cdr position)))
(or (string= (car final) (car imenu--rescan-item))
(nthcdr 3 final))))
'imenu-default-create-index-function)))
(let ((newmap (make-sparse-keymap))
(menu-bar (lookup-key (current-local-map) [menu-bar])))
+ (setq imenu--last-menubar-index-alist nil)
(define-key newmap [menu-bar]
(append (make-sparse-keymap) menu-bar))
(define-key newmap [menu-bar index]
(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)))))
+ (apply function (car index-item) position rest))))
+ (run-hooks 'imenu-after-jump-hook))
(provide 'imenu)