imenu.el 28.1 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; imenu.el --- Framework for mode-specific buffer indexes.

3
;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

;; Author: Ake Stenhoff <etxaksf@aom.ericsson.se>
;;         Lars Lindberg <lli@sypro.cap.se>
;; Created: 8 Feb 1994
;; Keywords: tools
;;
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

;;; Commentary:
;;
;; Purpose of this package:
;;   To present a framework for mode-specific buffer indexes.
;;   A buffer index is an alist of names and buffer positions.
;;   For instance all functions in a C-file and their positions.
;;
;; How it works:

;;   A mode-specific function is called to generate the index.  It is
;;   then presented to the user, who can choose from this index.
;;
;;   The package comes with a set of example functions for how to
;;   utilize this package.

39 40 41 42
;;   There are *examples* for index gathering functions/regular
;;   expressions for C/C++ and Lisp/Emacs Lisp but it is easy to
;;   customize for other modes.  A function for jumping to the chosen
;;   index position is also supplied.
Richard M. Stallman's avatar
Richard M. Stallman committed
43

Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46
;;; Thanks goes to
;;  [simon] - Simon Leinen simon@lia.di.epfl.ch
;;  [dean] - Dean Andrews ada@unison.com
47
;;  [alon] - Alon Albert al@mercury.co.il 
48
;;  [greg] - Greg Thompson gregt@porsche.visix.COM
49
;;  [wolfgang] - Wolfgang Bangerth zcg51122@rpool1.rus.uni-stuttgart.de
50
;;  [kai] - Kai Grossjohann grossjoh@linus.informatik.uni-dortmund.de
51
;;  [david] - David M. Smith dsmith@stats.adelaide.edu.au
52 53 54
;;  [christian] - Christian Egli Christian.Egli@hcsd.hac.com
;;  [karl] - Karl Fogel kfogel@floss.life.uiuc.edu

Richard M. Stallman's avatar
Richard M. Stallman committed
55
;;; Code
56
(eval-when-compile (require 'cl))
Richard M. Stallman's avatar
Richard M. Stallman committed
57 58 59 60 61 62

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Customizable variables
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
63
(defvar imenu-use-keymap-menu nil
64
  "*Non-nil means use a keymap when making the mouse menu.")
65 66

(defvar imenu-auto-rescan nil
67
  "*Non-nil means Imenu should always rescan the buffers.")
68 69 70

(defvar imenu-auto-rescan-maxout 60000 
  "* auto-rescan is disabled in buffers larger than this.
71
This variable is buffer-local.")
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74 75 76 77

(defvar imenu-always-use-completion-buffer-p nil
  "*Set this to non-nil for displaying the index in a completion buffer.

Non-nil means always display the index in a completion buffer.
Nil means display the index as a mouse menu when the mouse was
78 79
used to invoke `imenu'.
`never' means never automatically display a listing of any kind.")
Richard M. Stallman's avatar
Richard M. Stallman committed
80 81 82 83 84 85 86 87 88 89

(defvar 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.

90
Set it to `imenu--sort-by-name' if you want alphabetic sorting.
Richard M. Stallman's avatar
Richard M. Stallman committed
91 92 93

The function should take two arguments and return T if the first
element should come before the second.  The arguments are cons cells;
Richard M. Stallman's avatar
Richard M. Stallman committed
94
\(NAME . POSITION).  Look at `imenu--sort-by-name' for an example.")
Richard M. Stallman's avatar
Richard M. Stallman committed
95 96 97 98

(defvar imenu-max-items 25
  "*Maximum number of elements in an index mouse-menu.")

99
(defvar imenu-scanning-message "Scanning buffer for index (%3d%%)"
Richard M. Stallman's avatar
Richard M. Stallman committed
100
  "*Progress message during the index scanning of the buffer.
101
If non-nil, user gets a message during the scanning of the buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103

Relevant only if the mode-specific function that creates the buffer
104
index use `imenu-progress-message'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118

(defvar 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.")

(defvar 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.")

(defvar imenu-submenu-name-format "%s..."
  "*The format for making a submenu name.")

119
;;;###autoload
120
(defvar imenu-generic-expression nil
121 122 123 124 125 126 127 128 129 130 131 132
  "The regex pattern to use for creating a buffer index.

If non-nil this pattern is passed to `imenu-create-index-with-pattern'
to create a buffer index.

It is an alist with elements that look like this: (MENU-TITLE
REGEXP INDEX). 

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
133 134 135
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.
136 137 138

INDEX points to the substring in REGEXP that contains the name (of the
function, variable or type) that is to appear in the menu.
139

140 141
For emacs-lisp-mode for example PATTERN would look like:

142 143 144
'((nil \"^\\\\s-*(def\\\\(un\\\\|subst\\\\|macro\\\\|advice\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2)
  (\"*Vars*\" \"^\\\\s-*(def\\\\(var\\\\|const\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2)
  (\"*Types*\" \"^\\\\s-*(def\\\\(type\\\\|struct\\\\|class\\\\|ine-condition\\\\)\\\\s-+\\\\([-A-Za-z0-9+]+\\\\)\" 2))
145 146 147

The variable is buffer-local.")

148
(make-variable-buffer-local 'imenu-generic-expression)
149

Richard M. Stallman's avatar
Richard M. Stallman committed
150 151 152 153 154 155
;;;; Hooks

(defvar imenu-create-index-function 'imenu-default-create-index-function
  "The function to use for creating a buffer index.

It should be a function that takes no arguments and returns an index
156 157
of the current buffer as an alist.  The elements in the alist look
like: (INDEX-NAME . INDEX-POSITION).  You may also nest index list like
Richard M. Stallman's avatar
Richard M. Stallman committed
158
\(INDEX-NAME . INDEX-ALIST).
Richard M. Stallman's avatar
Richard M. Stallman committed
159

160
This function is called within a `save-excursion'.
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162 163 164

The variable is buffer-local.")
(make-variable-buffer-local 'imenu-create-index-function)

165
(defvar imenu-prev-index-position-function 'beginning-of-defun
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167
  "Function for finding the next index position.

168 169
If `imenu-create-index-function' is set to
`imenu-default-create-index-function', then you must set this variable
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171 172 173
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
174
index and it should return nil when it doesn't find another index.")
175
(make-variable-buffer-local 'imenu-prev-index-position-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
176

177
(defvar imenu-extract-index-name-function nil
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179 180
  "Function for extracting the index name.

This function is called after the function pointed out by
181 182
`imenu-prev-index-position-function'.")
(make-variable-buffer-local 'imenu-extract-index-name-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
183

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
;;;
;;; Macro to display a progress message.
;;; RELPOS is the relative position to display.
;;; If RELPOS is nil, then the relative position in the buffer
;;; is calculated.
;;; PREVPOS is the variable in which we store the last position displayed.
(defmacro imenu-progress-message (prevpos &optional relpos reverse)
  (` (and
      imenu-scanning-message
      (let ((pos (, (if relpos
			relpos
		      (` (imenu--relative-position (, reverse)))))))
	(if (, (if relpos t
		 (` (> pos (+ 5 (, prevpos))))))
	    (progn
	      (message imenu-scanning-message pos)
	      (setq (, prevpos) pos)))))))


;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;
;;;; Some examples of functions utilizing the framework of this
;;;; package.
;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

Karl Heuer's avatar
Karl Heuer committed
210
;; Return the current/previous sexp and the location of the sexp (its
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
;; beginning) without moving the point.
(defun imenu-example--name-and-position ()
  (save-excursion
    (forward-sexp -1)
    (let ((beg (point))
	  (end (progn (forward-sexp) (point)))
	  (marker (make-marker)))
      (set-marker marker beg)
      (cons (buffer-substring beg end)
	    marker))))

;;;
;;; Lisp
;;; 

(defun imenu-example--lisp-extract-index-name ()
  ;; Example of a candidate for `imenu-extract-index-name-function'.
  ;; This will generate a flat index of definitions in a lisp file.
  (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 ()
  ;; Example of a candidate for `imenu-create-index-function'.
  ;; It will generate a nested index of definitions.
  (let ((index-alist '())
	(index-var-alist '())
	(index-type-alist '())
	(index-unknown-alist '())
	prev-pos)
    (goto-char (point-max))
    (imenu-progress-message prev-pos 0)
    ;; Search for the function
    (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 (imenu-create-submenu-name "Variables") index-var-alist)
	       index-alist))
    (and index-type-alist
 	 (push (cons (imenu-create-submenu-name "Types") index-type-alist)
  	       index-alist))
    (and index-unknown-alist
	 (push (cons (imenu-create-submenu-name "Syntax-unknown") index-unknown-alist)
	       index-alist))
    index-alist))

;; Regular expression to find C functions
(defvar imenu-example--function-name-regexp-c
  (concat 
   "^[a-zA-Z0-9]+[ \t]?"		; type specs; there can be no
   "\\([a-zA-Z0-9_*]+[ \t]+\\)?"	; more than 3 tokens, right?
   "\\([a-zA-Z0-9_*]+[ \t]+\\)?"
   "\\([*&]+[ \t]*\\)?"			; pointer
   "\\([a-zA-Z0-9_*]+\\)[ \t]*("	; name
   ))

(defun imenu-example--create-c-index (&optional regexp)
  (let ((index-alist '())
	prev-pos char)
    (goto-char (point-min))
    (imenu-progress-message prev-pos 0)
    ;; Search for the function
    (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)))
	;; Skip this function name if it is a prototype declaration.
	(if (not (eq char ?\;))
	    (push (imenu-example--name-and-position) index-alist))))
    (imenu-progress-message prev-pos 100)
    (nreverse index-alist)))

322

Richard M. Stallman's avatar
Richard M. Stallman committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Internal variables
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; The item to use in the index for rescanning the buffer.
(defconst imenu--rescan-item '("*Rescan*" . -99))

;; The latest buffer index.
;; Buffer local.
(defvar imenu--index-alist nil)
(make-variable-buffer-local 'imenu--index-alist)

337 338 339 340
;; The latest buffer index used to update the menu bar menu.
(defvar imenu--last-menubar-index-alist nil)
(make-variable-buffer-local 'imenu--last-menubar-index-alist)

Richard M. Stallman's avatar
Richard M. Stallman committed
341
;; History list for 'jump-to-function-in-buffer'.
342
;; Making this buffer local caused it not to work!
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
(defvar imenu--history-list nil)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; Internal support functions
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;;
;;; Sort function
;;; Sorts the items depending on their index name.
;;; An item look like (NAME . POSITION).
;;;
(defun imenu--sort-by-name (item1 item2)
  (string-lessp (car item1) (car 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
  ;; If REVERSE is non-nil then the beginning is 100 and the end is 0.
  (let ((pos (point))
	(total (buffer-size)))
    (and reverse (setq pos (- total pos)))
    (if (> total 50000)
	;; Avoid overflow from multiplying by 100!
	(/ (1- pos) (max (/ total 100) 1))
      (/ (* 100 (1- pos)) (max total 1)))))

;;;
Karl Heuer's avatar
Karl Heuer committed
372
;;; Function for supporting general looking submenu names.
373
;;; Uses `imenu-submenu-name-format' for creating the name.
Richard M. Stallman's avatar
Richard M. Stallman committed
374 375 376
;;; NAME is the base of the new submenu name.
;;;
(defun imenu-create-submenu-name (name)
377
   (format imenu-submenu-name-format name))
Richard M. Stallman's avatar
Richard M. Stallman committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

;; Split LIST into sublists of max length N.
;; Example (imenu--split '(1 2 3 4 5 6 7 8) 3)-> '((1 2 3) (4 5 6) (7 8))
(defun imenu--split (list n)
  (let ((remain list)
	(result '())
	(sublist '())
	(i 0))
    (while remain
      (push (pop remain) sublist)
      (incf i)
      (and (= i n)
	   ;; We have finished a sublist
	   (progn (push (nreverse sublist) result)
		  (setq i 0)
		  (setq sublist '()))))
    ;; There might be a sublist (if the length of LIST mod n is != 0)
    ;; that has to be added to the result list.
    (and sublist
	 (push (nreverse sublist) result))
    (nreverse result)))

;;;
;;; Split a menu in to several menus.
;;;
(defun imenu--split-menu (menulist title)
404
  (cons "Index menu"
Richard M. Stallman's avatar
Richard M. Stallman committed
405 406 407 408 409 410 411 412 413 414 415 416
	(mapcar
	 (function
	  (lambda (menu)
	    (cons (format "(%s)" title) menu)))
	 (imenu--split menulist imenu-max-items))))

;;;
;;; Find all items in this buffer that should be in the index.
;;; Returns an alist on the form
;;; ((NAME . POSITION) (NAME . POSITION) ...)
;;;

417
(defun imenu--make-index-alist (&optional noerror)
Richard M. Stallman's avatar
Richard M. Stallman committed
418
  ;; Create a list for this buffer only when needed.
419 420 421 422
  (or (and imenu--index-alist
	   (or (not imenu-auto-rescan)
	       (and imenu-auto-rescan
		    (> (buffer-size)  imenu-auto-rescan-maxout))))
Richard M. Stallman's avatar
Richard M. Stallman committed
423 424 425 426
      ;; Get the index
      (setq imenu--index-alist
	    (save-excursion
	      (funcall imenu-create-index-function))))
427
  (or imenu--index-alist noerror
428
      (error "No items suitable for an index found in this buffer"))
429 430
  (or imenu--index-alist
      (setq imenu--index-alist (list nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
431 432
  ;; Add a rescan option to the index.
  (cons imenu--rescan-item imenu--index-alist))
433 434 435 436 437 438 439 440
;;;
;;; Find all markers in alist and makes
;;; them point nowhere.
;;;
(defun imenu--cleanup (&optional alist)
  ;; Sets the markers in imenu--index-alist 
  ;; point nowhere.
  ;; if alist is provided use that list.
441 442 443
  (or alist
      (setq alist imenu--index-alist))
  (and alist
444
       (mapcar
445 446 447 448 449
	(function
	 (lambda (item)
	   (cond
	    ((markerp (cdr item))
	     (set-marker (cdr item) nil))
450
	    ((consp (cdr item))
451
	     (imenu--cleanup (cdr item))))))
452
	alist)
453 454
       t))

455
(defun imenu--create-keymap-2 (alist counter &optional commands)
456 457 458 459 460 461
  (let ((map nil))
    (mapcar
     (function
      (lambda (item)
	(cond
	 ((listp (cdr item))
462 463
	  (append (list (setq counter (1+ counter))
			(car item) 'keymap (car item))
464
		  (imenu--create-keymap-2 (cdr item) (+ counter 10) commands)))
465
	 (t
466 467
	  (let ((end (if commands `(lambda () (interactive)
				     (imenu--menubar-select ',item))
468
		       (cons '(nil) t))))
469
	    (setq foo end)
470 471 472 473 474
	    (cons (car item)
		  (cons (car item) end))))
	 )))
     alist)))

475 476 477 478 479
;; If COMMANDS is non-nil, make a real keymap
;; with a real command used as the definition.
;; If it is nil, make something suitable for x-popup-menu.
(defun imenu--create-keymap-1 (title alist &optional commands)
  (append (list 'keymap title) (imenu--create-keymap-2 alist 0 commands)))
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497


(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)) 
      (if (string= str head)
	  (setq alist nil res elt)
	(if (and (listp tail)
		 (setq res (imenu--in-alist str tail)))
	    (setq alist nil))))
    res))

Richard M. Stallman's avatar
Richard M. Stallman committed
498 499 500 501
(defun imenu-default-create-index-function ()
  "*Wrapper for index searching functions.

Moves point to end of buffer and then repeatedly calls
502
`imenu-prev-index-position-function' and `imenu-extract-index-name-function'.
Richard M. Stallman's avatar
Richard M. Stallman committed
503
Their results are gathered into an index alist."
504 505
  ;; These should really be done by setting imenu-create-index-function
  ;; in these major modes.  But save that change for later.
506 507
  (cond ((and (fboundp imenu-prev-index-position-function)
	      (fboundp imenu-extract-index-name-function))
508
	 (let ((index-alist '())
509
	       prev-pos name)
510
	   (goto-char (point-max))
511
	   (imenu-progress-message prev-pos 0 t)
512 513
	   ;; Search for the function
	   (while (funcall imenu-prev-index-position-function) 
514
	     (imenu-progress-message prev-pos nil t)
515 516 517 518
	     (save-excursion
	       (setq name (funcall imenu-extract-index-name-function)))
	     (and (stringp name)
		  (push (cons name (point)) index-alist)))
519
	   (imenu-progress-message prev-pos 100 t)
520 521 522
	   index-alist))
	;; Use generic expression if possible.
	((and imenu-generic-expression)
Karl Heuer's avatar
Karl Heuer committed
523
	 (imenu--generic-function imenu-generic-expression)) 
524 525 526
	(t
	 (error "The mode \"%s\" does not take full advantage of imenu.el yet."
		mode-name))))      
Richard M. Stallman's avatar
Richard M. Stallman committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

(defun imenu--replace-spaces (name replacement)
  ;; Replace all spaces in NAME with REPLACEMENT.
  ;; That second argument should be a string.
  (mapconcat
   (function
    (lambda (ch)
      (if (char-equal ch ?\ )
	  replacement
	(char-to-string ch))))
   name
   ""))

(defun imenu--flatten-index-alist (index-alist &optional concat-names prefix)
  ;; Takes a nested INDEX-ALIST and returns a flat index alist.
  ;; If optional CONCAT-NAMES is non-nil, then a nested index has its
  ;; name and a space concatenated to the names of the children.
  ;; Third argument PREFIX is for internal use only.
  (mapcan
   (function
    (lambda (item)
      (let* ((name (car item))
	     (pos (cdr item))
	     (new-prefix (and concat-names
			      (if prefix
				  (concat prefix imenu-level-separator name)
				name))))
	(cond
555
	 ((or (markerp pos) (numberp pos))
Richard M. Stallman's avatar
Richard M. Stallman committed
556 557 558 559 560
	  (list (cons new-prefix pos)))
	 (t
	  (imenu--flatten-index-alist pos new-prefix))))))
   index-alist))

561 562 563
;;;
;;; Generic index gathering function.
;;;
564 565 566 567 568 569 570

(defun imenu--generic-function (patterns)
;; Built on some ideas that Erik Naggum <erik@naggum.no> once posted
;; to comp.emacs
  "Return an index of the current buffer as an alist.

PATTERN is an alist with elements that look like this: (MENU-TITLE
571
REGEXP INDEX).
572 573 574 575 576

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
577 578 579
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.
580 581 582 583 584 585

INDEX points to the substring in REGEXP that contains the name (of the
function, variable or type) that is to appear in the menu.

For emacs-lisp-mode for example PATTERN would look like:

586 587 588
'((nil \"^\\\\s-*(def\\\\(un\\\\|subst\\\\|macro\\\\|advice\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2)
  (\"*Vars*\" \"^\\\\s-*(def\\\\(var\\\\|const\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2)
  (\"*Types*\" \"^\\\\s-*(def\\\\(type\\\\|struct\\\\|class\\\\|ine-condition\\\\)\\\\s-+\\\\([-A-Za-z0-9]+\\\\)\" 2))'
589

590 591
Returns an index of the current buffer as an alist.  The elements in
the alist look like: (INDEX-NAME . INDEX-POSITION).  They may also be
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
nested index lists like (INDEX-NAME . INDEX-ALIST) depending on
pattern.

\(imenu--generic-function PATTERN\)."

  (let ((index-alist (list 'dummy))
        (found nil)
	(global-regexp 
	 (concat "\\(" 
		 (mapconcat
		  (function (lambda (pattern) (identity (cadr pattern)))) 
		  patterns "\\)\\|\\(") 
		 "\\)"))
	prev-pos)

607 608
    (goto-char (point-max))
    (imenu-progress-message prev-pos 0 t)
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    (save-match-data
      (while (re-search-backward global-regexp nil t)
	(imenu-progress-message prev-pos nil t)
        (setq found nil)
	(save-excursion
	  (goto-char (match-beginning 0))
	  (mapcar 
	   (function 
	    (lambda (pat) 
	      (let ((menu-title (car pat))
		    (regexp (cadr pat))
		    (index (caddr pat)))
		    (if (and (not found) ; Only allow one entry;
			     (looking-at regexp))
			(let ((beg (match-beginning index))
			      (end (match-end index)))
			  (setq found t)
			  (push 
			   (cons (buffer-substring beg end) beg)
			   (cdr 
			    (or (if (not (stringp menu-title)) index-alist) 
				(assoc 
				 (imenu-create-submenu-name menu-title) 
				 index-alist)
				(car (push 
				      (cons 
				       (imenu-create-submenu-name menu-title) 
				       '()) 
				      index-alist))))))))))
	    patterns))))
      (imenu-progress-message prev-pos 100 t)
      (delete 'dummy index-alist)))
641

Richard M. Stallman's avatar
Richard M. Stallman committed
642 643 644 645 646 647 648 649 650 651 652 653
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
;;; The main functions for this package!
;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun imenu--completion-buffer (index-alist &optional prompt)
  "Let the user select from INDEX-ALIST in a completion buffer with PROMPT.

Returns t for rescan and otherwise a position number."
  ;; Create a list for this buffer only when needed.
  (let (name choice
654 655 656 657 658 659 660
	     (prepared-index-alist
	      (mapcar
	       (function
		(lambda (item)
		  (cons (imenu--replace-spaces (car item) imenu-space-replacement)
			(cdr item))))
	       index-alist)))
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
    (if (eq imenu-always-use-completion-buffer-p 'never)
  	(setq name (completing-read (or prompt "Index item: ")
  				    prepared-index-alist
 				    nil t nil 'imenu--history-list))
      (save-window-excursion
	;; Display the completion buffer
	(with-output-to-temp-buffer "*Completions*"
	  (display-completion-list
	   (all-completions "" prepared-index-alist )))
	(let ((minibuffer-setup-hook
	       (function (lambda ()
			   (let ((buffer (current-buffer)))
			     (save-excursion
			       (set-buffer "*Completions*")
			       (setq completion-reference-buffer buffer)))))))
	  ;; Make a completion question
	  (setq name (completing-read (or prompt "Index item: ")
				      prepared-index-alist
				      nil t nil 'imenu--history-list)))))
680 681 682 683 684 685 686 687 688
    (cond ((not (stringp name))
	   nil)
	  ((string= name (car imenu--rescan-item))
	   t)
	  (t
	   (setq choice (assoc name prepared-index-alist))
	   (if (listp (cdr choice))
	       (imenu--completion-buffer (cdr choice) prompt)
	     choice)))))
689

Richard M. Stallman's avatar
Richard M. Stallman committed
690 691 692 693 694 695 696 697
(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 a position number."
  (let* ((menu 	(imenu--split-menu
		 (if imenu-sort-function
698 699 700 701 702 703 704
		     (sort
		      (let ((res nil)
			    (oldlist index-alist))
			;; Copy list method from the cl package `copy-list'
			(while (consp oldlist) (push (pop oldlist) res))
			(prog1 (nreverse res) (setcdr res oldlist)))
		      imenu-sort-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
705 706 707
		   index-alist)
		 (or title (buffer-name))))
	 position)
708 709 710 711 712
    (and imenu-use-keymap-menu
	 (setq menu (imenu--create-keymap-1 (car menu) 
					    (if (< 1 (length (cdr menu)))
						(cdr menu)
					      (cdr (cadr menu))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
713
    (setq position (x-popup-menu event menu))
714 715 716 717 718 719 720 721 722 723
    (if imenu-use-keymap-menu
	(progn
	  (cond 
	   ((and (listp position)
		 (numberp (car position))
		 (stringp (nth (1- (length position)) position)))
	    (setq position (nth (1- (length position)) position)))
	   ((and (stringp (car position))
		 (null (cdr position)))
	    (setq position (car position))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
724 725 726
    (cond
     ((eq position nil)
      position)
Richard M. Stallman's avatar
Richard M. Stallman committed
727
     ((listp position)
Richard M. Stallman's avatar
Richard M. Stallman committed
728 729 730 731 732
      (imenu--mouse-menu position event
			 (if title
			     (concat title imenu-level-separator
				     (car (rassq position index-alist)))
			   (car (rassq position index-alist)))))
733 734 735 736 737 738
     ((stringp position)
      (or (string= position (car imenu--rescan-item))
	  (imenu--in-alist position index-alist)))
     ((or (= position (cdr imenu--rescan-item))
	  (and (stringp position)
	       (string= position (car imenu--rescan-item))))
Richard M. Stallman's avatar
Richard M. Stallman committed
739 740 741 742
      t)
     (t
      (rassq position index-alist)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
743
(defun imenu-choose-buffer-index (&optional prompt alist)
Richard M. Stallman's avatar
Richard M. Stallman committed
744 745 746 747 748 749
  "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.

Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752
If you call this function with index alist ALIST, then it lets the user
select from ALIST.

753
With no index alist ALIST, it calls `imenu--make-index-alist' to
Richard M. Stallman's avatar
Richard M. Stallman committed
754 755
create the index alist.

756
If `imenu-always-use-completion-buffer-p' is non-nil, then the
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758 759 760 761
completion buffer is always used, no matter if the mouse was used or
not.

The returned value is on the form (INDEX-NAME . INDEX-POSITION)."
  (let (index-alist
762
	(mouse-triggered (listp last-nonmenu-event))
Richard M. Stallman's avatar
Richard M. Stallman committed
763 764 765 766
	(result t) )
    ;; If selected by mouse, see to that the window where the mouse is
    ;; really is selected.
    (and mouse-triggered
767
	 (not (equal last-nonmenu-event '(menu-bar)))
768
	 (let ((window (posn-window (event-start last-nonmenu-event))))
769
	   (or (framep window) (null window) (select-window window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
770 771
    ;; Create a list for this buffer only when needed.
    (while (eq result t)
Richard M. Stallman's avatar
Richard M. Stallman committed
772
      (setq index-alist (if alist alist (imenu--make-index-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
773 774 775
      (setq result
	    (if (and mouse-triggered
		     (not imenu-always-use-completion-buffer-p))
776
		(imenu--mouse-menu index-alist last-nonmenu-event)
Richard M. Stallman's avatar
Richard M. Stallman committed
777 778
	      (imenu--completion-buffer index-alist prompt)))
      (and (eq result t)
779
	   (imenu--cleanup)
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781 782
	   (setq imenu--index-alist nil)))
    result))

783
;;;###autoload
784
(defun imenu-add-to-menubar (name)
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
  "Adds an \"imenu\" entry to the menu bar for the current major mode.
NAME is a string used to name the menu bar item.
See `imenu' for more information."
  (interactive "sImenu menu item name: ")
  (define-key (current-local-map) [menu-bar index]
    (cons name (nconc (make-sparse-keymap "Imenu") (make-sparse-keymap))))
  (add-hook 'menu-bar-update-hook 'imenu-update-menubar))

(defun imenu-update-menubar ()
  (and (current-local-map)
       (keymapp (lookup-key (current-local-map) [menu-bar index]))
       (let ((index-alist (imenu--make-index-alist t)))
	 ;; Don't bother updating if the index-alist has not changed
	 ;; since the last time we did it.
	 (or (equal index-alist imenu--last-menubar-index-alist)
	     (let (menu menu1 old)
	       (setq imenu--last-menubar-index-alist index-alist)
	       (setq menu (imenu--split-menu
			   (if imenu-sort-function
			       (sort
				(let ((res nil)
				      (oldlist index-alist))
				  ;; Copy list method from the cl package `copy-list'
				  (while (consp oldlist) (push (pop oldlist) res))
				  (prog1 (nreverse res) (setcdr res oldlist)))
				imenu-sort-function)
			     index-alist)
			   (buffer-name)))
	       (setq menu1 (imenu--create-keymap-1 (car menu) 
						   (if (< 1 (length (cdr menu)))
						       (cdr menu)
						     (cdr (car (cdr menu))))
						   t))
	       (setq old (lookup-key (current-local-map) [menu-bar index]))
	       (if (keymapp old)
		   (setcdr (nthcdr 2 old) menu1)))))))

(defun imenu--menubar-select (item)
  "Use Imenu to select the function or variable named in this menu item."
  (interactive)
  (imenu item))
826

827
;;;###autoload
828
(defun imenu (index-item)
829
  "Jump to a place in the buffer chosen using a buffer menu or mouse menu.
830
See `imenu-choose-buffer-index' for more information."
831 832 833
  (interactive
   (list (save-restriction 
	   (widen)
834 835 836 837
	   (car (imenu-choose-buffer-index)))))
  ;; Convert a string to an alist element.
  (if (stringp index-item)
      (setq index-item (assoc index-item (imenu--make-index-alist))))
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
  (and index-item
       (progn
	 (push-mark)
	 (cond
	  ((markerp (cdr index-item))
	   (if (or ( > (marker-position (cdr index-item)) (point-min))
		   ( < (marker-position (cdr index-item)) (point-max)))
	       ;; widen if outside narrowing
	       (widen))
	   (goto-char (marker-position (cdr index-item))))
	  (t
	   (if (or ( > (cdr index-item) (point-min))
		   ( < (cdr index-item) (point-max)))
	       ;; widen if outside narrowing
	       (widen))
	   (goto-char (cdr index-item)))))))
854

Richard M. Stallman's avatar
Richard M. Stallman committed
855 856 857
(provide 'imenu)

;;; imenu.el ends here