Mercurial > emacs
annotate lisp/imenu.el @ 106508:8c836ea59444
* net/tramp.el (tramp-handle-insert-directory): Suppress error messages.
author | Michael Albinus <michael.albinus@gmx.de> |
---|---|
date | Wed, 09 Dec 2009 10:23:00 +0000 |
parents | c220a29e75fd |
children | 9479a9da9b8c |
rev | line source |
---|---|
38412
253f761ad37b
Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents:
36637
diff
changeset
|
1 ;;; imenu.el --- framework for mode-specific buffer indexes |
6230 | 2 |
74442 | 3 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 2001, 2002, 2003, 2004, |
100908 | 4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
6230 | 5 |
6 ;; Author: Ake Stenhoff <etxaksf@aom.ericsson.se> | |
7 ;; Lars Lindberg <lli@sypro.cap.se> | |
17970 | 8 ;; Maintainer: FSF |
6230 | 9 ;; Created: 8 Feb 1994 |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21959
diff
changeset
|
10 ;; Keywords: tools convenience |
14169 | 11 |
12 ;; This file is part of GNU Emacs. | |
13 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87567
diff
changeset
|
14 ;; GNU Emacs is free software: you can redistribute it and/or modify |
6230 | 15 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87567
diff
changeset
|
16 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87567
diff
changeset
|
17 ;; (at your option) any later version. |
14169 | 18 |
19 ;; GNU Emacs is distributed in the hope that it will be useful, | |
6230 | 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. | |
14169 | 23 |
6230 | 24 ;; You should have received a copy of the GNU General Public License |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87567
diff
changeset
|
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
6230 | 26 |
27 ;;; Commentary: | |
14169 | 28 |
6230 | 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. | |
33 ;; | |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
34 ;; It is documented in the Emacs Lisp manual. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
35 ;; |
6230 | 36 ;; How it works: |
37 | |
38 ;; A mode-specific function is called to generate the index. It is | |
39 ;; then presented to the user, who can choose from this index. | |
40 ;; | |
41 ;; The package comes with a set of example functions for how to | |
42 ;; utilize this package. | |
43 | |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
44 ;; There are *examples* for index gathering functions/regular |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
45 ;; expressions for C/C++ and Lisp/Emacs Lisp but it is easy to |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
46 ;; customize for other modes. A function for jumping to the chosen |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
47 ;; index position is also supplied. |
6230 | 48 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
49 ;;; History: |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
50 ;; Thanks go to |
6241 | 51 ;; [simon] - Simon Leinen simon@lia.di.epfl.ch |
52 ;; [dean] - Dean Andrews ada@unison.com | |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
53 ;; [alon] - Alon Albert al@mercury.co.il |
9176
5646f9ac8ec3
(imenu--cleanup): Changed 'mapc' to 'mapcar'.
Richard M. Stallman <rms@gnu.org>
parents:
8408
diff
changeset
|
54 ;; [greg] - Greg Thompson gregt@porsche.visix.COM |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
55 ;; [wolfgang] - Wolfgang Bangerth zcg51122@rpool1.rus.uni-stuttgart.de |
10072
a7b70665c937
(imenu): Widen temporary before scan the file.
Richard M. Stallman <rms@gnu.org>
parents:
9176
diff
changeset
|
56 ;; [kai] - Kai Grossjohann grossjoh@linus.informatik.uni-dortmund.de |
10221
34b66bff7aec
(imenu-always-use-completion-buffer-p): A value of
Richard M. Stallman <rms@gnu.org>
parents:
10093
diff
changeset
|
57 ;; [david] - David M. Smith dsmith@stats.adelaide.edu.au |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
58 ;; [christian] - Christian Egli Christian.Egli@hcsd.hac.com |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
59 ;; [karl] - Karl Fogel kfogel@floss.life.uiuc.edu |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
60 |
38412
253f761ad37b
Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents:
36637
diff
changeset
|
61 ;;; Code: |
14169 | 62 |
6909
9e59751db725
Require cl only at compile time.
Richard M. Stallman <rms@gnu.org>
parents:
6241
diff
changeset
|
63 (eval-when-compile (require 'cl)) |
6230 | 64 |
65 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
66 ;;; | |
67 ;;; Customizable variables | |
68 ;;; | |
69 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
70 |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
71 (defgroup imenu nil |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
72 "Mode-specific buffer indexes." |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
73 :group 'matching |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
74 :group 'frames |
22250
a77d473867b8
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21959
diff
changeset
|
75 :group 'convenience |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
76 :link '(custom-manual "(elisp)Imenu")) |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
77 |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
78 (defcustom imenu-use-markers t |
100171 | 79 "Non-nil means use markers instead of integers for Imenu buffer positions. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
80 |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
81 Setting this to nil makes Imenu work a little faster but editing the |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
82 buffer will make the generated index positions wrong. |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
83 |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
84 This might not yet be honored by all index-building functions." |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
85 :type 'boolean |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
86 :group 'imenu) |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
87 |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
88 |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
89 (defcustom imenu-max-item-length 60 |
100171 | 90 "If a number, truncate Imenu entries to that length." |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
91 :type '(choice integer |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
92 (const :tag "Unlimited")) |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
93 :group 'imenu) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
94 |
17677
3ab08563e855
(imenu-auto-rescan): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents:
17634
diff
changeset
|
95 (defcustom imenu-auto-rescan nil |
100171 | 96 "Non-nil means Imenu should always rescan the buffers." |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
97 :type 'boolean |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
98 :group 'imenu) |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
99 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
100 (defcustom imenu-auto-rescan-maxout 60000 |
100171 | 101 "Imenu auto-rescan is disabled in buffers larger than this size (in bytes). |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
102 This variable is buffer-local." |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
103 :type 'integer |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
104 :group 'imenu) |
6230 | 105 |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
106 (defvar imenu-always-use-completion-buffer-p nil) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
107 (make-obsolete-variable 'imenu-always-use-completion-buffer-p |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59568
diff
changeset
|
108 'imenu-use-popup-menu "22.1") |
6230 | 109 |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
110 (defcustom imenu-use-popup-menu |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
111 (if imenu-always-use-completion-buffer-p |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
112 (not (eq imenu-always-use-completion-buffer-p 'never)) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
113 'on-mouse) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
114 "Use a popup menu rather than a minibuffer prompt. |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
115 If nil, always use a minibuffer prompt. |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
116 If t, always use a popup menu, |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
117 If `on-mouse' use a popup menu when `imenu' was invoked with the mouse." |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
118 :type '(choice (const :tag "On Mouse" on-mouse) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
119 (const :tag "Never" nil) |
62531
c905fcf5e3d9
Specify missing group (and type, if simple) in defcustom.
Juanma Barranquero <lekktu@gmail.com>
parents:
61769
diff
changeset
|
120 (other :tag "Always" t)) |
c905fcf5e3d9
Specify missing group (and type, if simple) in defcustom.
Juanma Barranquero <lekktu@gmail.com>
parents:
61769
diff
changeset
|
121 :group 'imenu) |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
122 |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
123 (defcustom imenu-eager-completion-buffer |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
124 (not (eq imenu-always-use-completion-buffer-p 'never)) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
125 "If non-nil, eagerly popup the completion buffer." |
57926
f697668630d7
(imenu-eager-completion-buffer): Add :version.
Richard M. Stallman <rms@gnu.org>
parents:
57775
diff
changeset
|
126 :type 'boolean |
f697668630d7
(imenu-eager-completion-buffer): Add :version.
Richard M. Stallman <rms@gnu.org>
parents:
57775
diff
changeset
|
127 :group 'imenu |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59568
diff
changeset
|
128 :version "22.1") |
6230 | 129 |
25810
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
130 (defcustom imenu-after-jump-hook nil |
100171 | 131 "Hooks called after jumping to a place in the buffer. |
25810
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
132 |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
133 Useful things to use here include `reposition-window', `recenter', and |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
134 \(lambda () (recenter 0)) to show at top of screen." |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
135 :type 'hook |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
136 :group 'imenu) |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
137 |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
138 ;;;###autoload |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
139 (defcustom imenu-sort-function nil |
100171 | 140 "The function to use for sorting the index mouse-menu. |
6230 | 141 |
142 Affects only the mouse index menu. | |
143 | |
144 Set this to nil if you don't want any sorting (faster). | |
145 The items in the menu are then presented in the order they were found | |
146 in the buffer. | |
147 | |
6909
9e59751db725
Require cl only at compile time.
Richard M. Stallman <rms@gnu.org>
parents:
6241
diff
changeset
|
148 Set it to `imenu--sort-by-name' if you want alphabetic sorting. |
6230 | 149 |
23358
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
150 The function should take two arguments and return t if the first |
6230 | 151 element should come before the second. The arguments are cons cells; |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
152 \(NAME . POSITION). Look at `imenu--sort-by-name' for an example." |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
153 :type '(choice (const :tag "No sorting" nil) |
24233
5e43fcb42e81
(imenu-sort-function): Fix custom type.
Richard M. Stallman <rms@gnu.org>
parents:
23358
diff
changeset
|
154 (const :tag "Sort by name" imenu--sort-by-name) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
155 (function :tag "Another function")) |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
156 :group 'imenu) |
6230 | 157 |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
158 (defcustom imenu-max-items 25 |
100171 | 159 "Maximum number of elements in a mouse menu for Imenu." |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
160 :type 'integer |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
161 :group 'imenu) |
6230 | 162 |
57775
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
163 ;; No longer used. KFS 2004-10-27 |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
164 ;; (defcustom imenu-scanning-message "Scanning buffer for index (%3d%%)" |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
165 ;; "*Progress message during the index scanning of the buffer. |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
166 ;; If non-nil, user gets a message during the scanning of the buffer. |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
167 ;; |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
168 ;; Relevant only if the mode-specific function that creates the buffer |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
169 ;; index use `imenu-progress-message', and not useful if that is fast, in |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
170 ;; which case you might as well set this to nil." |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
171 ;; :type '(choice string |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
172 ;; (const :tag "None" nil)) |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
173 ;; :group 'imenu) |
6230 | 174 |
22628
d5a086ed37f5
(imenu-space-replacement): Use `.'.
Richard M. Stallman <rms@gnu.org>
parents:
22586
diff
changeset
|
175 (defcustom imenu-space-replacement "." |
100171 | 176 "The replacement string for spaces in index names. |
22628
d5a086ed37f5
(imenu-space-replacement): Use `.'.
Richard M. Stallman <rms@gnu.org>
parents:
22586
diff
changeset
|
177 Used when presenting the index in a completion buffer to make the |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
178 names work as tokens." |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
179 :type '(choice string (const nil)) |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
180 :group 'imenu) |
6230 | 181 |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
182 (defcustom imenu-level-separator ":" |
100171 | 183 "The separator between index names of different levels. |
6230 | 184 Used for making mouse-menu titles and for flattening nested indexes |
17634
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
185 with name concatenation." |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
186 :type 'string |
247c2a11843d
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17307
diff
changeset
|
187 :group 'imenu) |
6230 | 188 |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
189 ;;;###autoload |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
190 (defvar imenu-generic-expression nil |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
191 "The regex pattern to use for creating a buffer index. |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
192 |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
193 If non-nil this pattern is passed to `imenu--generic-function' to |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
194 create a buffer index. Look there for the documentation of this |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
195 pattern's structure. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
196 |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
197 For example, see the value of `fortran-imenu-generic-expression' used by |
36013
fc00137bf0bf
(imenu-generic-expression): Doc fix.
Dave Love <fx@gnu.org>
parents:
35688
diff
changeset
|
198 `fortran-mode' with `imenu-syntax-alist' set locally to give the |
fc00137bf0bf
(imenu-generic-expression): Doc fix.
Dave Love <fx@gnu.org>
parents:
35688
diff
changeset
|
199 characters which normally have \"symbol\" syntax \"word\" syntax |
fc00137bf0bf
(imenu-generic-expression): Doc fix.
Dave Love <fx@gnu.org>
parents:
35688
diff
changeset
|
200 during matching.") |
104612
c220a29e75fd
Define risky-local-variable property here rather than in files.el.
Glenn Morris <rgm@gnu.org>
parents:
104545
diff
changeset
|
201 ;;;###autoload(put 'imenu-generic-expression 'risky-local-variable t) |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
202 |
14816
485422b900d3
(imenu-generic-expression): Autoload the make-variable-buffer-local call.
Richard M. Stallman <rms@gnu.org>
parents:
14798
diff
changeset
|
203 ;;;###autoload |
12664
ce1cae301efe
(imenu--history-list): Don't make this buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
12635
diff
changeset
|
204 (make-variable-buffer-local 'imenu-generic-expression) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
205 |
6230 | 206 ;;;; Hooks |
207 | |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
208 ;;;###autoload |
6230 | 209 (defvar imenu-create-index-function 'imenu-default-create-index-function |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
210 "The function to use for creating an index alist of the current buffer. |
16271
00bece0cd6c2
(imenu--generic-function): Create a special entry
Richard M. Stallman <rms@gnu.org>
parents:
16244
diff
changeset
|
211 |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
212 It should be a function that takes no arguments and returns |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
213 an index alist of the current buffer. The function is |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
214 called within a `save-excursion'. |
6230 | 215 |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
216 See `imenu--index-alist' for the format of the buffer index alist.") |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
217 ;;;###autoload |
6230 | 218 (make-variable-buffer-local 'imenu-create-index-function) |
219 | |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
220 ;;;###autoload |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
221 (defvar imenu-prev-index-position-function 'beginning-of-defun |
6230 | 222 "Function for finding the next index position. |
223 | |
6909
9e59751db725
Require cl only at compile time.
Richard M. Stallman <rms@gnu.org>
parents:
6241
diff
changeset
|
224 If `imenu-create-index-function' is set to |
9e59751db725
Require cl only at compile time.
Richard M. Stallman <rms@gnu.org>
parents:
6241
diff
changeset
|
225 `imenu-default-create-index-function', then you must set this variable |
6230 | 226 to a function that will find the next index, looking backwards in the |
227 file. | |
228 | |
229 The function should leave point at the place to be connected to the | |
56549
7e0e6be19969
(imenu-prev-index-position-function)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55826
diff
changeset
|
230 index and it should return nil when it doesn't find another index.") |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
231 ;;;###autoload |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
232 (make-variable-buffer-local 'imenu-prev-index-position-function) |
6230 | 233 |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
234 ;;;###autoload |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
235 (defvar imenu-extract-index-name-function nil |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
236 "Function for extracting the index item name, given a position. |
6230 | 237 |
20857
185fa242a2ea
(imenu-generic-expression): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
20770
diff
changeset
|
238 This function is called after `imenu-prev-index-position-function' |
185fa242a2ea
(imenu-generic-expression): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
20770
diff
changeset
|
239 finds a position for an index item, with point at that position. |
56549
7e0e6be19969
(imenu-prev-index-position-function)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55826
diff
changeset
|
240 It should return the name for that index item.") |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
241 ;;;###autoload |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
242 (make-variable-buffer-local 'imenu-extract-index-name-function) |
6230 | 243 |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
244 ;;;###autoload |
25810
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
245 (defvar imenu-name-lookup-function nil |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
246 "Function to compare string with index item. |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
247 |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
248 This function will be called with two strings, and should return |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
249 non-nil if they match. |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
250 |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
251 If nil, comparison is done with `string='. |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
252 Set this to some other function for more advanced comparisons, |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
253 such as \"begins with\" or \"name matches and number of |
56549
7e0e6be19969
(imenu-prev-index-position-function)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55826
diff
changeset
|
254 arguments match\".") |
25810
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
255 ;;;###autoload |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
256 (make-variable-buffer-local 'imenu-name-lookup-function) |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
257 |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
258 ;;;###autoload |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
259 (defvar imenu-default-goto-function 'imenu-default-goto-function |
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
260 "The default function called when selecting an Imenu item. |
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
261 The function in this variable is called when selecting a normal index-item.") |
22798
434ac4a14be3
(imenu-create-index-function): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
22628
diff
changeset
|
262 ;;;###autoload |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
263 (make-variable-buffer-local 'imenu-default-goto-function) |
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
264 |
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
265 |
16271
00bece0cd6c2
(imenu--generic-function): Create a special entry
Richard M. Stallman <rms@gnu.org>
parents:
16244
diff
changeset
|
266 (defun imenu--subalist-p (item) |
00bece0cd6c2
(imenu--generic-function): Create a special entry
Richard M. Stallman <rms@gnu.org>
parents:
16244
diff
changeset
|
267 (and (consp (cdr item)) (listp (cadr item)) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
268 (not (eq (car (cadr item)) 'lambda)))) |
16271
00bece0cd6c2
(imenu--generic-function): Create a special entry
Richard M. Stallman <rms@gnu.org>
parents:
16244
diff
changeset
|
269 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
270 ;; Macro to display a progress message. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
271 ;; RELPOS is the relative position to display. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
272 ;; If RELPOS is nil, then the relative position in the buffer |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
273 ;; is calculated. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
274 ;; PREVPOS is the variable in which we store the last position displayed. |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
275 (defmacro imenu-progress-message (prevpos &optional relpos reverse) |
57775
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
276 |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
277 ;; Made obsolete/empty, as computers are now faster than the eye, and |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
278 ;; it had problems updating the messages correctly, and could shadow |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
279 ;; more important messages/prompts in the minibuffer. KFS 2004-10-27. |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
280 |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
281 ;; `(and |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
282 ;; imenu-scanning-message |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
283 ;; (let ((pos ,(if relpos |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
284 ;; relpos |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
285 ;; `(imenu--relative-position ,reverse)))) |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
286 ;; (if ,(if relpos t |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
287 ;; `(> pos (+ 5 ,prevpos))) |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
288 ;; (progn |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
289 ;; (message imenu-scanning-message pos) |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
290 ;; (setq ,prevpos pos))))) |
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
291 ) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
292 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
293 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
294 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
295 ;;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
296 ;;;; Some examples of functions utilizing the framework of this |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
297 ;;;; package. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
298 ;;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
299 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
300 |
104545 | 301 ;; FIXME: This was the only imenu-example-* definition actually used, |
302 ;; by cperl-mode.el. Now cperl-mode has its own copy, so these can | |
303 ;; all be removed. | |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
304 (defun imenu-example--name-and-position () |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
305 "Return the current/previous sexp and its (beginning) location. |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
306 Don't move point." |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
307 (save-excursion |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
308 (forward-sexp -1) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
309 ;; [ydi] modified for imenu-use-markers |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
310 (let ((beg (if imenu-use-markers (point-marker) (point))) |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
311 (end (progn (forward-sexp) (point)))) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
312 (cons (buffer-substring beg end) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
313 beg)))) |
104389
03262c903016
(imenu-example--name-and-position): Fix obsolescence message.
Glenn Morris <rgm@gnu.org>
parents:
104364
diff
changeset
|
314 (make-obsolete 'imenu-example--name-and-position |
03262c903016
(imenu-example--name-and-position): Fix obsolescence message.
Glenn Morris <rgm@gnu.org>
parents:
104364
diff
changeset
|
315 "use your own function instead." "23.2") |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
316 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
317 ;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
318 ;;; Lisp |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
319 ;;; |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
320 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
321 (defun imenu-example--lisp-extract-index-name () |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
322 ;; Example of a candidate for `imenu-extract-index-name-function'. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
323 ;; This will generate a flat index of definitions in a lisp file. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
324 (save-match-data |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
325 (and (looking-at "(def") |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
326 (condition-case nil |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
327 (progn |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
328 (down-list 1) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
329 (forward-sexp 2) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
330 (let ((beg (point)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
331 (end (progn (forward-sexp -1) (point)))) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
332 (buffer-substring beg end))) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
333 (error nil))))) |
104364
82c4f7cce5f9
(imenu-example--name-and-position, imenu-example--lisp-extract-index-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
334 (make-obsolete 'imenu-example--lisp-extract-index-name "your own" "23.2") |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
335 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
336 (defun imenu-example--create-lisp-index () |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
337 ;; Example of a candidate for `imenu-create-index-function'. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
338 ;; It will generate a nested index of definitions. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
339 (let ((index-alist '()) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
340 (index-var-alist '()) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
341 (index-type-alist '()) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
342 (index-unknown-alist '()) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
343 prev-pos) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
344 (goto-char (point-max)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
345 (imenu-progress-message prev-pos 0) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
346 ;; Search for the function |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
347 (while (beginning-of-defun) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
348 (imenu-progress-message prev-pos nil t) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
349 (save-match-data |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
350 (and (looking-at "(def") |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
351 (save-excursion |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
352 (down-list 1) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
353 (cond |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
354 ((looking-at "def\\(var\\|const\\)") |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
355 (forward-sexp 2) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
356 (push (imenu-example--name-and-position) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
357 index-var-alist)) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
358 ((looking-at "def\\(un\\|subst\\|macro\\|advice\\)") |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
359 (forward-sexp 2) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
360 (push (imenu-example--name-and-position) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
361 index-alist)) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
362 ((looking-at "def\\(type\\|struct\\|class\\|ine-condition\\)") |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
363 (forward-sexp 2) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
364 (if (= (char-after (1- (point))) ?\)) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
365 (progn |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
366 (forward-sexp -1) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
367 (down-list 1) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
368 (forward-sexp 1))) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
369 (push (imenu-example--name-and-position) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
370 index-type-alist)) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
371 (t |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
372 (forward-sexp 2) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
373 (push (imenu-example--name-and-position) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
374 index-unknown-alist))))))) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
375 (imenu-progress-message prev-pos 100) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
376 (and index-var-alist |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
377 (push (cons "Variables" index-var-alist) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
378 index-alist)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
379 (and index-type-alist |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
380 (push (cons "Types" index-type-alist) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
381 index-alist)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
382 (and index-unknown-alist |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
383 (push (cons "Syntax-unknown" index-unknown-alist) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
384 index-alist)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
385 index-alist)) |
104364
82c4f7cce5f9
(imenu-example--name-and-position, imenu-example--lisp-extract-index-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
386 (make-obsolete 'imenu-example--create-lisp-index "your own" "23.2") |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
387 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
388 ;; Regular expression to find C functions |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
389 (defvar imenu-example--function-name-regexp-c |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
390 (concat |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
391 "^[a-zA-Z0-9]+[ \t]?" ; type specs; there can be no |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
392 "\\([a-zA-Z0-9_*]+[ \t]+\\)?" ; more than 3 tokens, right? |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
393 "\\([a-zA-Z0-9_*]+[ \t]+\\)?" |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
394 "\\([*&]+[ \t]*\\)?" ; pointer |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
395 "\\([a-zA-Z0-9_*]+\\)[ \t]*(" ; name |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
396 )) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
397 |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
398 (defun imenu-example--create-c-index (&optional regexp) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
399 (let ((index-alist '()) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
400 prev-pos char) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
401 (goto-char (point-min)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
402 (imenu-progress-message prev-pos 0) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
403 ;; Search for the function |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
404 (save-match-data |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
405 (while (re-search-forward |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
406 (or regexp imenu-example--function-name-regexp-c) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
407 nil t) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
408 (imenu-progress-message prev-pos) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
409 (backward-up-list 1) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
410 (save-excursion |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
411 (goto-char (scan-sexps (point) 1)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
412 (setq char (following-char))) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
413 ;; Skip this function name if it is a prototype declaration. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
414 (if (not (eq char ?\;)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
415 (push (imenu-example--name-and-position) index-alist)))) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
416 (imenu-progress-message prev-pos 100) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
417 (nreverse index-alist))) |
104364
82c4f7cce5f9
(imenu-example--name-and-position, imenu-example--lisp-extract-index-name)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
100908
diff
changeset
|
418 (make-obsolete 'imenu-example--create-c-index "your own" "23.2") |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
419 |
6230 | 420 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
421 ;;; | |
422 ;;; Internal variables | |
423 ;;; | |
424 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
425 | |
426 ;; The item to use in the index for rescanning the buffer. | |
427 (defconst imenu--rescan-item '("*Rescan*" . -99)) | |
428 | |
429 ;; The latest buffer index. | |
430 ;; Buffer local. | |
20857
185fa242a2ea
(imenu-generic-expression): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
20770
diff
changeset
|
431 (defvar imenu--index-alist nil |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
432 "The buffer index alist computed for this buffer in Imenu. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
433 |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
434 Simple elements in the alist look like (INDEX-NAME . POSITION). |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
435 POSITION is the buffer position of the item; to go to the item |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
436 is simply to move point to that position. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
437 |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
438 Special elements look like (INDEX-NAME POSITION FUNCTION ARGUMENTS...). |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
439 To \"go to\" a special element means applying FUNCTION |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
440 to INDEX-NAME, POSITION, and the ARGUMENTS. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
441 |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
442 A nested sub-alist element looks like (INDEX-NAME SUB-ALIST). |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
443 The function `imenu--subalist-p' tests an element and returns t |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
444 if it is a sub-alist. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
445 |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
446 There is one simple element with negative POSITION; selecting that |
70105
ed33247a09d2
(imenu--index-alist): Balance parentheses.
Luc Teirlinck <teirllm@auburn.edu>
parents:
70098
diff
changeset
|
447 element recalculates the buffer's index alist.") |
104612
c220a29e75fd
Define risky-local-variable property here rather than in files.el.
Glenn Morris <rgm@gnu.org>
parents:
104545
diff
changeset
|
448 ;;;###autoload(put 'imenu--index-alist 'risky-local-variable t) |
20857
185fa242a2ea
(imenu-generic-expression): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
20770
diff
changeset
|
449 |
6230 | 450 (make-variable-buffer-local 'imenu--index-alist) |
451 | |
24270
02ae21f066ec
(imenu--last-menubar-index-alist): Add doc.
Richard M. Stallman <rms@gnu.org>
parents:
24233
diff
changeset
|
452 (defvar imenu--last-menubar-index-alist nil |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
453 "The latest buffer index alist used to update the menu bar menu.") |
24270
02ae21f066ec
(imenu--last-menubar-index-alist): Add doc.
Richard M. Stallman <rms@gnu.org>
parents:
24233
diff
changeset
|
454 |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
455 (make-variable-buffer-local 'imenu--last-menubar-index-alist) |
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
456 |
6230 | 457 ;; History list for 'jump-to-function-in-buffer'. |
12664
ce1cae301efe
(imenu--history-list): Don't make this buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
12635
diff
changeset
|
458 ;; Making this buffer local caused it not to work! |
6230 | 459 (defvar imenu--history-list nil) |
460 | |
461 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
462 ;;; | |
463 ;;; Internal support functions | |
464 ;;; | |
465 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
466 | |
467 ;;; | |
468 ;;; Sort function | |
469 ;;; Sorts the items depending on their index name. | |
23358
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
470 ;;; An item looks like (NAME . POSITION). |
6230 | 471 ;;; |
472 (defun imenu--sort-by-name (item1 item2) | |
473 (string-lessp (car item1) (car item2))) | |
474 | |
23358
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
475 (defun imenu--sort-by-position (item1 item2) |
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
476 (< (cdr item1) (cdr item2))) |
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
477 |
6230 | 478 (defun imenu--relative-position (&optional reverse) |
479 ;; Support function to calculate relative position in buffer | |
480 ;; Beginning of buffer is 0 and end of buffer is 100 | |
481 ;; If REVERSE is non-nil then the beginning is 100 and the end is 0. | |
482 (let ((pos (point)) | |
483 (total (buffer-size))) | |
484 (and reverse (setq pos (- total pos))) | |
485 (if (> total 50000) | |
486 ;; Avoid overflow from multiplying by 100! | |
487 (/ (1- pos) (max (/ total 100) 1)) | |
488 (/ (* 100 (1- pos)) (max total 1))))) | |
489 | |
490 ;; Split LIST into sublists of max length N. | |
491 ;; Example (imenu--split '(1 2 3 4 5 6 7 8) 3)-> '((1 2 3) (4 5 6) (7 8)) | |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
492 ;; |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
493 ;; The returned list DOES NOT share structure with LIST. |
6230 | 494 (defun imenu--split (list n) |
495 (let ((remain list) | |
496 (result '()) | |
497 (sublist '()) | |
498 (i 0)) | |
499 (while remain | |
500 (push (pop remain) sublist) | |
501 (incf i) | |
502 (and (= i n) | |
503 ;; We have finished a sublist | |
504 (progn (push (nreverse sublist) result) | |
505 (setq i 0) | |
506 (setq sublist '())))) | |
507 ;; There might be a sublist (if the length of LIST mod n is != 0) | |
508 ;; that has to be added to the result list. | |
509 (and sublist | |
510 (push (nreverse sublist) result)) | |
511 (nreverse result))) | |
512 | |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
513 ;;; Split the alist MENULIST into a nested alist, if it is long enough. |
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
514 ;;; In any case, add TITLE to the front of the alist. |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
515 ;;; If IMENU--RESCAN-ITEM is present in MENULIST, it is moved to the |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
516 ;;; beginning of the returned alist. |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
517 ;;; |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
518 ;;; The returned alist DOES NOT share structure with MENULIST. |
6230 | 519 (defun imenu--split-menu (menulist title) |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
520 (let ((menulist (copy-sequence menulist)) |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
521 keep-at-top tail) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
522 (if (memq imenu--rescan-item menulist) |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
523 (setq keep-at-top (list imenu--rescan-item) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
524 menulist (delq imenu--rescan-item menulist))) |
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
525 (setq tail menulist) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
526 (dolist (item tail) |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
527 (when (imenu--subalist-p item) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
528 (push item keep-at-top) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
529 (setq menulist (delq item menulist)))) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
530 (if imenu-sort-function |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
531 (setq menulist (sort menulist imenu-sort-function))) |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
532 (if (> (length menulist) imenu-max-items) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
533 (setq menulist |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
534 (mapcar |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
535 (lambda (menu) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
536 (cons (format "From: %s" (caar menu)) menu)) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
537 (imenu--split menulist imenu-max-items)))) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
538 (cons title |
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
539 (nconc (nreverse keep-at-top) menulist)))) |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
540 |
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
541 ;;; Split up each long alist that are nested within ALIST |
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
542 ;;; into nested alists. |
98404
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
543 ;;; |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
544 ;;; Return a split and sorted copy of ALIST. The returned alist DOES |
16ab17bf44bb
Daniel Colascione <danc at merrillpress.com>
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
545 ;;; NOT share structure with ALIST. |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
546 (defun imenu--split-submenus (alist) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
547 (mapcar (function |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
548 (lambda (elt) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
549 (if (and (consp elt) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
550 (stringp (car elt)) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
551 (listp (cdr elt))) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
552 (imenu--split-menu (cdr elt) (car elt)) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
553 elt))) |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
554 alist)) |
6230 | 555 |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
556 ;;; Truncate all strings in MENULIST to imenu-max-item-length |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
557 (defun imenu--truncate-items (menulist) |
35243
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
558 (mapcar (function |
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
559 (lambda (item) |
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
560 (cond |
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
561 ((consp (cdr item)) |
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
562 (imenu--truncate-items (cdr item))) |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
563 ;; truncate if necessary |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
564 ((and (numberp imenu-max-item-length) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
565 (> (length (car item)) imenu-max-item-length)) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
566 (setcar item (substring (car item) 0 imenu-max-item-length)))))) |
35243
569b2a1b20df
(imenu--truncate-items): Revert last change.
Dave Love <fx@gnu.org>
parents:
32780
diff
changeset
|
567 menulist)) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
568 |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
569 |
16369
187e7c8aaff5
(imenu--make-index-alist): Add doc string.
Richard M. Stallman <rms@gnu.org>
parents:
16315
diff
changeset
|
570 (defun imenu--make-index-alist (&optional noerror) |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
571 "Create an index alist for the definitions in the current buffer. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
572 This works by using the hook function `imenu-create-index-function'. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
573 Report an error if the list is empty unless NOERROR is supplied and |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
574 non-nil. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
575 |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
576 See `imenu--index-alist' for the format of the index alist." |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
577 (or (and imenu--index-alist |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
578 (or (not imenu-auto-rescan) |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
579 (and imenu-auto-rescan |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
580 (> (buffer-size) imenu-auto-rescan-maxout)))) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
581 ;; Get the index; truncate if necessary |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
582 (progn |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
583 (setq imenu--index-alist |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
584 (save-excursion |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
585 (save-restriction |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
586 (widen) |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
587 (funcall imenu-create-index-function)))) |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
588 (imenu--truncate-items imenu--index-alist))) |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
589 (or imenu--index-alist noerror |
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
590 (error "No items suitable for an index found in this buffer")) |
6230 | 591 (or imenu--index-alist |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
592 (setq imenu--index-alist (list nil))) |
6230 | 593 ;; Add a rescan option to the index. |
594 (cons imenu--rescan-item imenu--index-alist)) | |
16315
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
595 |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
596 ;;; Find all markers in alist and makes |
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
597 ;;; them point nowhere. |
16315
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
598 ;;; The top-level call uses nil as the argument; |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
599 ;;; non-nil arguments are in recursivecalls. |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
600 (defvar imenu--cleanup-seen) |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
601 |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
602 (defun imenu--cleanup (&optional alist) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
603 ;; If alist is provided use that list. |
16315
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
604 ;; If not, empty the table of lists already seen |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
605 ;; and use imenu--index-alist. |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
606 (if alist |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
607 (setq imenu--cleanup-seen (cons alist imenu--cleanup-seen)) |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
608 (setq alist imenu--index-alist imenu--cleanup-seen (list alist))) |
cca1c6324cab
(imenu--cleanup): Handle shared structure in alist.
Richard M. Stallman <rms@gnu.org>
parents:
16272
diff
changeset
|
609 |
10795
8cbc8846b19b
(imenu--cleanup): Set alist to its default just once, at the beginning.
Richard M. Stallman <rms@gnu.org>
parents:
10221
diff
changeset
|
610 (and alist |
31560
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
611 (mapc |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
612 (lambda (item) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
613 (cond |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
614 ((markerp (cdr item)) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
615 (set-marker (cdr item) nil)) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
616 ;; Don't process one alist twice. |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
617 ((memq (cdr item) imenu--cleanup-seen)) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
618 ((imenu--subalist-p item) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
619 (imenu--cleanup (cdr item))))) |
10795
8cbc8846b19b
(imenu--cleanup): Set alist to its default just once, at the beginning.
Richard M. Stallman <rms@gnu.org>
parents:
10221
diff
changeset
|
620 alist) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
621 t)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
622 |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
623 (defun imenu--create-keymap (title alist &optional cmd) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
624 (list* 'keymap title |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
625 (mapcar |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
626 (lambda (item) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
627 (list* (car item) (car item) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
628 (cond |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
629 ((imenu--subalist-p item) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
630 (imenu--create-keymap (car item) (cdr item) cmd)) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
631 (t |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
632 `(lambda () (interactive) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
633 ,(if cmd `(,cmd ',item) (list 'quote item))))))) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
634 alist))) |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
635 |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
636 (defun imenu--in-alist (str alist) |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
637 "Check whether the string STR is contained in multi-level ALIST." |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
638 (let (elt head tail res) |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
639 (setq res nil) |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
640 (while alist |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
641 (setq elt (car alist) |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
642 tail (cdr elt) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
643 alist (cdr alist) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
644 head (car elt)) |
15929
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
645 ;; A nested ALIST element looks like |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
646 ;; (INDEX-NAME (INDEX-NAME . INDEX-POSITION) ...) |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
647 ;; while a bottom-level element looks like |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
648 ;; (INDEX-NAME . INDEX-POSITION) |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
649 ;; We are only interested in the bottom-level elements, so we need to |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
650 ;; recurse if TAIL is a list. |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
651 (cond ((listp tail) |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
652 (if (setq res (imenu--in-alist str tail)) |
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
653 (setq alist nil))) |
25810
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
654 ((if imenu-name-lookup-function |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
655 (funcall imenu-name-lookup-function str head) |
f1417ed050c0
(imenu-after-jump-hook): New variable.
Phillip Rulon <pjr@gnu.org>
parents:
24578
diff
changeset
|
656 (string= str head)) |
15929
955269257adf
(imenu--in-alist): Accept only bottom-level matches.
Richard M. Stallman <rms@gnu.org>
parents:
15831
diff
changeset
|
657 (setq alist nil res elt)))) |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
658 res)) |
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
659 |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
660 (defvar imenu-syntax-alist nil |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
661 "Alist of syntax table modifiers to use while in `imenu--generic-function'. |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
662 |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
663 The car of the assocs may be either a character or a string and the |
46981
db48206dc290
(imenu-syntax-alist): Doc fix.
Glenn Morris <rgm@gnu.org>
parents:
46977
diff
changeset
|
664 cdr is a syntax description appropriate for `modify-syntax-entry'. For |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
665 a string, all the characters in the string get the specified syntax. |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
666 |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
667 This is typically used to give word syntax to characters which |
22260 | 668 normally have symbol syntax to simplify `imenu-expression' |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
669 and speed-up matching.") |
35688
8b295a5d2192
(imenu-syntax-alist): Add autoload cookie for
Gerd Moellmann <gerd@gnu.org>
parents:
35243
diff
changeset
|
670 ;;;###autoload |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
671 (make-variable-buffer-local 'imenu-syntax-alist) |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
672 |
6230 | 673 (defun imenu-default-create-index-function () |
100171 | 674 "Default function to create an index alist of the current buffer. |
6230 | 675 |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
676 The most general method is to move point to end of buffer, then repeatedly call |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
677 `imenu-prev-index-position-function' and `imenu-extract-index-name-function'. |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
678 All the results returned by the latter are gathered into an index alist. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
679 This method is used if those two variables are non-nil. |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
680 |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
681 The alternate method, which is the one most often used, is to call |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
682 `imenu--generic-function' with `imenu-generic-expression' as argument." |
7350
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
683 ;; These should really be done by setting imenu-create-index-function |
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
684 ;; in these major modes. But save that change for later. |
20249
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
685 (cond ((and imenu-prev-index-position-function |
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
686 imenu-extract-index-name-function) |
7350
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
687 (let ((index-alist '()) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
688 prev-pos name) |
7350
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
689 (goto-char (point-max)) |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
690 (imenu-progress-message prev-pos 0 t) |
7350
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
691 ;; Search for the function |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
692 (while (funcall imenu-prev-index-position-function) |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
693 (imenu-progress-message prev-pos nil t) |
7350
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
694 (save-excursion |
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
695 (setq name (funcall imenu-extract-index-name-function))) |
542ab48d0f18
(imenu-default-create-index-function):
Richard M. Stallman <rms@gnu.org>
parents:
7319
diff
changeset
|
696 (and (stringp name) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
697 ;; [ydi] updated for imenu-use-markers |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
698 (push (cons name (if imenu-use-markers (point-marker) (point))) |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
699 index-alist))) |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
700 (imenu-progress-message prev-pos 100 t) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
701 index-alist)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
702 ;; Use generic expression if possible. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
703 ((and imenu-generic-expression) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
704 (imenu--generic-function imenu-generic-expression)) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
705 (t |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
706 (error "This buffer cannot use `imenu-default-create-index-function'")))) |
6230 | 707 |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
708 ;;; |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
709 ;;; Generic index gathering function. |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
710 ;;; |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
711 |
20769
aa3481dd4d84
(imenu-case-fold-search): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20249
diff
changeset
|
712 (defvar imenu-case-fold-search t |
aa3481dd4d84
(imenu-case-fold-search): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20249
diff
changeset
|
713 "Defines whether `imenu--generic-function' should fold case when matching. |
aa3481dd4d84
(imenu-case-fold-search): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20249
diff
changeset
|
714 |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
715 This variable should be set (only) by initialization code |
50846
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
716 for modes which use `imenu--generic-function'. If it is not set, but |
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
717 `font-lock-defaults' is set, then font-lock's setting is used.") |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
718 ;;;###autoload |
20769
aa3481dd4d84
(imenu-case-fold-search): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20249
diff
changeset
|
719 (make-variable-buffer-local 'imenu-case-fold-search) |
aa3481dd4d84
(imenu-case-fold-search): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20249
diff
changeset
|
720 |
58489
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
721 ;; This function can be called with quitting disabled, |
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
722 ;; so it needs to be careful never to loop! |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
723 (defun imenu--generic-function (patterns) |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
724 "Return an index alist of the current buffer based on PATTERNS. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
725 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
726 PATTERNS is an alist with elements that look like this: |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
727 (MENU-TITLE REGEXP INDEX) |
52733
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
728 or like this: |
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
729 (MENU-TITLE REGEXP INDEX FUNCTION ARGUMENTS...) |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
730 with zero or more ARGUMENTS. The former format creates a simple |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
731 element in the index alist when it matches; the latter creates a |
70098
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
732 special element of the form (INDEX-NAME POSITION-MARKER FUNCTION |
bd71e8bcb103
(imenu-create-index-function, imenu--index-alist)
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
733 ARGUMENTS...) with FUNCTION and ARGUMENTS copied from PATTERNS. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
734 |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
735 MENU-TITLE is a string used as the title for the submenu or nil |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
736 if the entries are not nested. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
737 |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
738 REGEXP is a regexp that should match a construct in the buffer |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
739 that is to be displayed in the menu; i.e., function or variable |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
740 definitions, etc. It contains a substring which is the name to |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
741 appear in the menu. See the info section on Regexps for more |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
742 information. REGEXP may also be a function, called without |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
743 arguments. It is expected to search backwards. It shall return |
78492
7c8949dbfa0d
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
744 true and set `match-data' if it finds another element. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
745 |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
746 INDEX points to the substring in REGEXP that contains the |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
747 name (of the function, variable or type) that is to appear in the |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
748 menu. |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
749 |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
750 The variable `imenu-case-fold-search' determines whether or not the |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
751 regexp matches are case sensitive, and `imenu-syntax-alist' can be |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
752 used to alter the syntax table for the search. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
753 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
754 See `lisp-imenu-generic-expression' for an example of PATTERNS. |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
755 |
12664
ce1cae301efe
(imenu--history-list): Don't make this buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
12635
diff
changeset
|
756 Returns an index of the current buffer as an alist. The elements in |
52733
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
757 the alist look like: |
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
758 (INDEX-NAME . INDEX-POSITION) |
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
759 or like: |
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
760 (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...) |
57775
206e30bf844c
(imenu-scanning-message): Remove.
Kim F. Storm <storm@cua.dk>
parents:
57717
diff
changeset
|
761 They may also be nested index alists like: |
52733
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
762 (INDEX-NAME . INDEX-ALIST) |
9cb896b7b7e2
(imenu--generic-function): Docstring fix.
Lute Kamstra <lute@gnu.org>
parents:
52401
diff
changeset
|
763 depending on PATTERNS." |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
764 |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
765 (let ((index-alist (list 'dummy)) |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
766 prev-pos |
50846
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
767 (case-fold-search (if (or (local-variable-p 'imenu-case-fold-search) |
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
768 (not (local-variable-p 'font-lock-defaults))) |
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
769 imenu-case-fold-search |
1ac6f8245bff
(imenu--generic-function): Use font-lock-defaults
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46981
diff
changeset
|
770 (nth 2 font-lock-defaults))) |
20770
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
771 (old-table (syntax-table)) |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
772 (table (copy-syntax-table (syntax-table))) |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
773 (slist imenu-syntax-alist)) |
31a8ad177c4c
(imenu-syntax-alist): New buffer-local variable.
Dave Love <fx@gnu.org>
parents:
20769
diff
changeset
|
774 ;; Modify the syntax table used while matching regexps. |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
775 (dolist (syn slist) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
776 ;; The character(s) to modify may be a single char or a string. |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
777 (if (numberp (car syn)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
778 (modify-syntax-entry (car syn) (cdr syn) table) |
46977
54ce0e6e293f
(imenu--generic-function): Use mapc.
Glenn Morris <rgm@gnu.org>
parents:
46894
diff
changeset
|
779 (mapc (lambda (c) |
54ce0e6e293f
(imenu--generic-function): Use mapc.
Glenn Morris <rgm@gnu.org>
parents:
46894
diff
changeset
|
780 (modify-syntax-entry c (cdr syn) table)) |
54ce0e6e293f
(imenu--generic-function): Use mapc.
Glenn Morris <rgm@gnu.org>
parents:
46894
diff
changeset
|
781 (car syn)))) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
782 (goto-char (point-max)) |
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
783 (imenu-progress-message prev-pos 0 t) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
784 (unwind-protect ; for syntax table |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
785 (save-match-data |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
786 (set-syntax-table table) |
58489
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
787 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
788 ;; map over the elements of imenu-generic-expression |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
789 ;; (typically functions, variables ...) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
790 (dolist (pat patterns) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
791 (let ((menu-title (car pat)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
792 (regexp (nth 1 pat)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
793 (index (nth 2 pat)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
794 (function (nth 3 pat)) |
57717
d198f03d3ba5
(imenu--generic-function): Skip matches in comments.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
57417
diff
changeset
|
795 (rest (nthcdr 4 pat)) |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
796 start beg) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
797 ;; Go backwards for convenience of adding items in order. |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
798 (goto-char (point-max)) |
62568
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
799 (while (and (if (functionp regexp) |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
800 (funcall regexp) |
7be08219b736
(imenu-generic-expression, imenu--generic-function'): REGEXP may also be a search function now. The part of doc-string for describing the structure was 95% identical to that of `imenu--generic-function'. Unify it there.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
62531
diff
changeset
|
801 (re-search-backward regexp nil t)) |
58489
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
802 ;; Exit the loop if we get an empty match, |
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
803 ;; because it means a bad regexp was specified. |
5df4ac03694d
Don't always require newcomment.
Richard M. Stallman <rms@gnu.org>
parents:
58364
diff
changeset
|
804 (not (= (match-beginning 0) (match-end 0)))) |
58364
c8e69a3cb57f
(imenu--generic-function):
Richard M. Stallman <rms@gnu.org>
parents:
57926
diff
changeset
|
805 (setq start (point)) |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
806 ;; Record the start of the line in which the match starts. |
59568
3c6c2682ad8f
(imenu--split-menu): Copy menulist before sorting.
Richard M. Stallman <rms@gnu.org>
parents:
58743
diff
changeset
|
807 ;; That's the official position of this definition. |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
808 (goto-char (match-beginning index)) |
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
809 (beginning-of-line) |
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
810 (setq beg (point)) |
58743
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
811 (imenu-progress-message prev-pos nil t) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
812 ;; Add this sort of submenu only when we've found an |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
813 ;; item for it, avoiding empty, duff menus. |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
814 (unless (assoc menu-title index-alist) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
815 (push (list menu-title) index-alist)) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
816 (if imenu-use-markers |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
817 (setq beg (copy-marker beg))) |
58743
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
818 (let ((item |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
819 (if function |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
820 (nconc (list (match-string-no-properties index) |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
821 beg function) |
58743
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
822 rest) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
823 (cons (match-string-no-properties index) |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
824 beg))) |
58743
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
825 ;; This is the desired submenu, |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
826 ;; starting with its title (or nil). |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
827 (menu (assoc menu-title index-alist))) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
828 ;; Insert the item unless it is already present. |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
829 (unless (member item (cdr menu)) |
6abce81016a6
(imenu--generic-function): Delete code to exclude matches in comments.
Richard M. Stallman <rms@gnu.org>
parents:
58489
diff
changeset
|
830 (setcdr menu |
61769
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
831 (cons item (cdr menu))))) |
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
832 ;; Go to the start of the match, to make sure we |
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
833 ;; keep making progress backwards. |
ff6d0a7e180e
(imenu--generic-function): The official position of a
Richard M. Stallman <rms@gnu.org>
parents:
59996
diff
changeset
|
834 (goto-char start)))) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
835 (set-syntax-table old-table))) |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
836 (imenu-progress-message prev-pos 100 t) |
23358
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
837 ;; Sort each submenu by position. |
3812bb3ae006
(imenu--generic-function): Sort each submenu by position.
Karl Heuer <kwzh@gnu.org>
parents:
22798
diff
changeset
|
838 ;; This is in case one submenu gets items from two different regexps. |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
839 (dolist (item index-alist) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
840 (when (listp item) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
841 (setcdr item (sort (cdr item) 'imenu--sort-by-position)))) |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
842 (let ((main-element (assq nil index-alist))) |
16272
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
843 (nconc (delq main-element (delq 'dummy index-alist)) |
b64d00e44e7b
(imenu--split-menu): Keep the rescan item at top level.
Richard M. Stallman <rms@gnu.org>
parents:
16271
diff
changeset
|
844 (cdr main-element))))) |
10093
caafb376e619
(imenu-generic-expression): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
10072
diff
changeset
|
845 |
6230 | 846 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
847 ;;; | |
848 ;;; The main functions for this package! | |
849 ;;; | |
850 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
851 | |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
852 ;; See also info-lookup-find-item |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
853 (defun imenu-find-default (guess completions) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
854 "Fuzzily find an item based on GUESS inside the alist COMPLETIONS." |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
855 (catch 'found |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
856 (let ((case-fold-search t)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
857 (if (assoc guess completions) guess |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
858 (dolist (re (list (concat "\\`" (regexp-quote guess) "\\'") |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
859 (concat "\\`" (regexp-quote guess)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
860 (concat (regexp-quote guess) "\\'") |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
861 (regexp-quote guess))) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
862 (dolist (x completions) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
863 (if (string-match re (car x)) (throw 'found (car x))))))))) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
864 |
6230 | 865 (defun imenu--completion-buffer (index-alist &optional prompt) |
866 "Let the user select from INDEX-ALIST in a completion buffer with PROMPT. | |
867 | |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
868 Return one of the entries in index-alist or nil." |
6230 | 869 ;; Create a list for this buffer only when needed. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
870 (let ((name (thing-at-point 'symbol)) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
871 choice |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
872 (prepared-index-alist |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
873 (if (not imenu-space-replacement) index-alist |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
874 (mapcar |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
875 (lambda (item) |
63848
65786fe1837b
(imenu--completion-buffer): Change space constants followed by a sexp to "?\s ".
Juanma Barranquero <lekktu@gmail.com>
parents:
62568
diff
changeset
|
876 (cons (subst-char-in-string ?\s (aref imenu-space-replacement 0) |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
877 (car item)) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
878 (cdr item))) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
879 index-alist)))) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
880 (when (stringp name) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
881 (setq name (or (imenu-find-default name prepared-index-alist) name))) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
882 (cond (prompt) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
883 ((and name (imenu--in-alist name prepared-index-alist)) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
884 (setq prompt (format "Index item (default %s): " name))) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
885 (t (setq prompt "Index item: "))) |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
886 (let ((minibuffer-setup-hook minibuffer-setup-hook)) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
887 ;; Display the completion buffer. |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
888 (if (not imenu-eager-completion-buffer) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
889 (add-hook 'minibuffer-setup-hook 'minibuffer-completion-help)) |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
890 (setq name (completing-read prompt |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
891 prepared-index-alist |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
892 nil t nil 'imenu--history-list name))) |
55826
e7bdb5b77df2
(imenu--menubar-select): Set imenu-menubar-modified-tick
Richard M. Stallman <rms@gnu.org>
parents:
52733
diff
changeset
|
893 |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
894 (when (stringp name) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
895 (setq choice (assoc name prepared-index-alist)) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
896 (if (imenu--subalist-p choice) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
897 (imenu--completion-buffer (cdr choice) prompt) |
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
898 choice)))) |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
899 |
6230 | 900 (defun imenu--mouse-menu (index-alist event &optional title) |
901 "Let the user select from a buffer index from a mouse menu. | |
902 | |
903 INDEX-ALIST is the buffer index and EVENT is a mouse event. | |
904 | |
16148
8ca583c0b988
(imenu): Tests for when to widen were backwards.
Richard M. Stallman <rms@gnu.org>
parents:
15929
diff
changeset
|
905 Returns t for rescan and otherwise an element or subelement of INDEX-ALIST." |
14726
35e1cfdd29a4
(imenu--menubar-select): No longer interactive.
Richard M. Stallman <rms@gnu.org>
parents:
14725
diff
changeset
|
906 (setq index-alist (imenu--split-submenus index-alist)) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
907 (let* ((menu (imenu--split-menu index-alist (or title (buffer-name)))) |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
908 (map (imenu--create-keymap (car menu) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
909 (cdr (if (< 1 (length (cdr menu))) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
910 menu |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
911 (car (cdr menu))))))) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
912 (popup-menu map event))) |
6230 | 913 |
6241 | 914 (defun imenu-choose-buffer-index (&optional prompt alist) |
6230 | 915 "Let the user select from a buffer index and return the chosen index. |
916 | |
917 If the user originally activated this function with the mouse, a mouse | |
918 menu is used. Otherwise a completion buffer is used and the user is | |
919 prompted with PROMPT. | |
920 | |
6241 | 921 If you call this function with index alist ALIST, then it lets the user |
922 select from ALIST. | |
923 | |
6909
9e59751db725
Require cl only at compile time.
Richard M. Stallman <rms@gnu.org>
parents:
6241
diff
changeset
|
924 With no index alist ALIST, it calls `imenu--make-index-alist' to |
6241 | 925 create the index alist. |
926 | |
71725
240e662ee053
(imenu-choose-buffer-index): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
70105
diff
changeset
|
927 If `imenu-use-popup-menu' is nil, then the completion buffer |
240e662ee053
(imenu-choose-buffer-index): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
70105
diff
changeset
|
928 is always used, no matter if the mouse was used or not. |
6230 | 929 |
16369
187e7c8aaff5
(imenu--make-index-alist): Add doc string.
Richard M. Stallman <rms@gnu.org>
parents:
16315
diff
changeset
|
930 The returned value is of the form (INDEX-NAME . INDEX-POSITION)." |
6230 | 931 (let (index-alist |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
932 (mouse-triggered (listp last-nonmenu-event)) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
933 (result t)) |
6230 | 934 ;; If selected by mouse, see to that the window where the mouse is |
935 ;; really is selected. | |
936 (and mouse-triggered | |
12396
d0c82df80d70
(imenu-choose-buffer-index): Understand that (menu-bar)
Richard M. Stallman <rms@gnu.org>
parents:
12394
diff
changeset
|
937 (not (equal last-nonmenu-event '(menu-bar))) |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
938 (let ((window (posn-window (event-start last-nonmenu-event)))) |
12635
f12b1374fb5b
(imenu-choose-buffer-index): Avoid trying to select WINDOW if it is nil.
Richard M. Stallman <rms@gnu.org>
parents:
12396
diff
changeset
|
939 (or (framep window) (null window) (select-window window)))) |
6230 | 940 ;; Create a list for this buffer only when needed. |
941 (while (eq result t) | |
6241 | 942 (setq index-alist (if alist alist (imenu--make-index-alist))) |
6230 | 943 (setq result |
46894
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
944 (if (and imenu-use-popup-menu |
f8b45e2dec81
(imenu-always-use-completion-buffer-p): Make obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
43982
diff
changeset
|
945 (or (eq imenu-use-popup-menu t) mouse-triggered)) |
8296
b2b493c007ff
(imenu-choose-buffer-index): Use last-nonmenu-event
Richard M. Stallman <rms@gnu.org>
parents:
8256
diff
changeset
|
946 (imenu--mouse-menu index-alist last-nonmenu-event) |
6230 | 947 (imenu--completion-buffer index-alist prompt))) |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
948 (and (equal result imenu--rescan-item) |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
949 (imenu--cleanup) |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
950 (setq result t imenu--index-alist nil))) |
6230 | 951 result)) |
952 | |
12394
4fbc70e4d5e7
(imenu-use-keymap-menu): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
10795
diff
changeset
|
953 ;;;###autoload |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
954 (defun imenu-add-to-menubar (name) |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
955 "Add an `imenu' entry to the menu bar for the current buffer. |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
956 NAME is a string used to name the menu bar item. |
14657
4bedd113757f
(imenu-add-to-menubar): Add menu item for current buf only.
Richard M. Stallman <rms@gnu.org>
parents:
14656
diff
changeset
|
957 See the command `imenu' for more information." |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
958 (interactive "sImenu menu item name: ") |
20249
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
959 (if (or (and imenu-prev-index-position-function |
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
960 imenu-extract-index-name-function) |
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
961 imenu-generic-expression |
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
962 (not (eq imenu-create-index-function |
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
963 'imenu-default-create-index-function))) |
31560
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
964 (let ((newmap (make-sparse-keymap))) |
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
965 (set-keymap-parent newmap (current-local-map)) |
24270
02ae21f066ec
(imenu--last-menubar-index-alist): Add doc.
Richard M. Stallman <rms@gnu.org>
parents:
24233
diff
changeset
|
966 (setq imenu--last-menubar-index-alist nil) |
32279
869a035f39fa
(imenu-add-to-menubar): Fix last change.
Dave Love <fx@gnu.org>
parents:
31560
diff
changeset
|
967 (define-key newmap [menu-bar index] |
32284
700a91f9a4b4
(imenu-add-to-menubar): Fix again.
Dave Love <fx@gnu.org>
parents:
32279
diff
changeset
|
968 `(menu-item ,name ,(make-sparse-keymap "Imenu"))) |
31560
5dd0eccb46c5
(imenu--truncate-items, imenu--cleanup)
Dave Love <fx@gnu.org>
parents:
29552
diff
changeset
|
969 (use-local-map newmap) |
20249
c42156dab61b
(imenu-default-create-index-function):
Karl Heuer <kwzh@gnu.org>
parents:
20051
diff
changeset
|
970 (add-hook 'menu-bar-update-hook 'imenu-update-menubar)) |
87567
4c3c683cdff8
* erc-ibuffer.el (erc-channel-modes):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
78492
diff
changeset
|
971 (error "The mode `%s' does not support Imenu" |
4c3c683cdff8
* erc-ibuffer.el (erc-channel-modes):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
78492
diff
changeset
|
972 (format-mode-line mode-name)))) |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
973 |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
974 ;;;###autoload |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
975 (defun imenu-add-menubar-index () |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
976 "Add an Imenu \"Index\" entry on the menu bar for the current buffer. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
977 |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
978 A trivial interface to `imenu-add-to-menubar' suitable for use in a hook." |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
979 (interactive) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
980 (imenu-add-to-menubar "Index")) |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
981 |
14642
01e8fdb45deb
(imenu-buffer-menubar): Add defvar.
Karl Heuer <kwzh@gnu.org>
parents:
14575
diff
changeset
|
982 (defvar imenu-buffer-menubar nil) |
01e8fdb45deb
(imenu-buffer-menubar): Add defvar.
Karl Heuer <kwzh@gnu.org>
parents:
14575
diff
changeset
|
983 |
43982
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
984 (defvar imenu-menubar-modified-tick 0 |
72595
c1a0f40d53a7
* imenu.el (imenu-update-menubar): Use buffer-chars-modified-tick.
Chong Yidong <cyd@stupidchicken.com>
parents:
71725
diff
changeset
|
985 "The value of (buffer-chars-modified-tick) as of the last call |
c1a0f40d53a7
* imenu.el (imenu-update-menubar): Use buffer-chars-modified-tick.
Chong Yidong <cyd@stupidchicken.com>
parents:
71725
diff
changeset
|
986 to `imenu-update-menubar'.") |
43982
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
987 (make-variable-buffer-local 'imenu-menubar-modified-tick) |
43832
5d834c3f5d18
(imenu-update-menubar-modified-tick): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
41305
diff
changeset
|
988 |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
989 (defun imenu-update-menubar () |
43982
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
990 (when (and (current-local-map) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
991 (keymapp (lookup-key (current-local-map) [menu-bar index])) |
72595
c1a0f40d53a7
* imenu.el (imenu-update-menubar): Use buffer-chars-modified-tick.
Chong Yidong <cyd@stupidchicken.com>
parents:
71725
diff
changeset
|
992 (/= (buffer-chars-modified-tick) imenu-menubar-modified-tick)) |
c1a0f40d53a7
* imenu.el (imenu-update-menubar): Use buffer-chars-modified-tick.
Chong Yidong <cyd@stupidchicken.com>
parents:
71725
diff
changeset
|
993 (setq imenu-menubar-modified-tick (buffer-chars-modified-tick)) |
43982
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
994 (let ((index-alist (imenu--make-index-alist t))) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
995 ;; Don't bother updating if the index-alist has not changed |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
996 ;; since the last time we did it. |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
997 (unless (equal index-alist imenu--last-menubar-index-alist) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
998 (let (menu menu1 old) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
999 (setq imenu--last-menubar-index-alist index-alist) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
1000 (setq index-alist (imenu--split-submenus index-alist)) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
1001 (setq menu (imenu--split-menu index-alist |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
1002 (buffer-name))) |
51024
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
1003 (setq menu1 (imenu--create-keymap (car menu) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
1004 (cdr (if (< 1 (length (cdr menu))) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
1005 menu |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
1006 (car (cdr menu)))) |
4efabfff9aa1
(imenu--split-menu): Remove unused var `count'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50846
diff
changeset
|
1007 'imenu--menubar-select)) |
43982
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
1008 (setq old (lookup-key (current-local-map) [menu-bar index])) |
a40fcee55faa
(imenu-menubar-modified-tick): Renamed from
Richard M. Stallman <rms@gnu.org>
parents:
43832
diff
changeset
|
1009 (setcdr old (cdr menu1))))))) |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
1010 |
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
1011 (defun imenu--menubar-select (item) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1012 "Use Imenu to select the function or variable named in this menu ITEM." |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
1013 (if (equal item imenu--rescan-item) |
14796
29e7001fecf0
(imenu--menubar-select): Handle the "rescan" item.
Richard M. Stallman <rms@gnu.org>
parents:
14733
diff
changeset
|
1014 (progn |
29e7001fecf0
(imenu--menubar-select): Handle the "rescan" item.
Richard M. Stallman <rms@gnu.org>
parents:
14733
diff
changeset
|
1015 (imenu--cleanup) |
55826
e7bdb5b77df2
(imenu--menubar-select): Set imenu-menubar-modified-tick
Richard M. Stallman <rms@gnu.org>
parents:
52733
diff
changeset
|
1016 ;; Make sure imenu-update-menubar redoes everything. |
e7bdb5b77df2
(imenu--menubar-select): Set imenu-menubar-modified-tick
Richard M. Stallman <rms@gnu.org>
parents:
52733
diff
changeset
|
1017 (setq imenu-menubar-modified-tick -1) |
14796
29e7001fecf0
(imenu--menubar-select): Handle the "rescan" item.
Richard M. Stallman <rms@gnu.org>
parents:
14733
diff
changeset
|
1018 (setq imenu--index-alist nil) |
55826
e7bdb5b77df2
(imenu--menubar-select): Set imenu-menubar-modified-tick
Richard M. Stallman <rms@gnu.org>
parents:
52733
diff
changeset
|
1019 (setq imenu--last-menubar-index-alist nil) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1020 (imenu-update-menubar) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1021 t) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1022 (imenu item) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1023 nil)) |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
1024 |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
1025 (defun imenu-default-goto-function (name position &optional rest) |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
1026 "Move to the given position. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1027 |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1028 NAME is ignored. POSITION is where to move. REST is also ignored. |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1029 The ignored args just make this function have the same interface as a |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1030 function placed in a special index-item." |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
1031 (if (or (< position (point-min)) |
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
1032 (> position (point-max))) |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
1033 ;; widen if outside narrowing |
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
1034 (widen)) |
17307
830ad59547e4
(imenu-default-goto-function): Simplify.
Richard M. Stallman <rms@gnu.org>
parents:
17230
diff
changeset
|
1035 (goto-char position)) |
17229
b48a8dd2d8ce
(imenu-scanning-message): Support for bigger numbers.
Richard M. Stallman <rms@gnu.org>
parents:
16698
diff
changeset
|
1036 |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
1037 ;;;###autoload |
12664
ce1cae301efe
(imenu--history-list): Don't make this buffer-local.
Richard M. Stallman <rms@gnu.org>
parents:
12635
diff
changeset
|
1038 (defun imenu (index-item) |
7319
cd73ba498964
(imenu): Renamed from goto-index-pos.
Richard M. Stallman <rms@gnu.org>
parents:
6909
diff
changeset
|
1039 "Jump to a place in the buffer chosen using a buffer menu or mouse menu. |
21852
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1040 INDEX-ITEM specifies the position. See `imenu-choose-buffer-index' |
5898cd2e4cd6
(imenu--generic-function): Doc fix. Rewritten to be faster.
Richard M. Stallman <rms@gnu.org>
parents:
20857
diff
changeset
|
1041 for more information." |
16698
13920eac02e0
(imenu-generic-expression): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
16612
diff
changeset
|
1042 (interactive (list (imenu-choose-buffer-index))) |
13798
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
1043 ;; Convert a string to an alist element. |
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
1044 (if (stringp index-item) |
4eac65d000d3
(imenu-update-menubar): New function.
Karl Heuer <kwzh@gnu.org>
parents:
13645
diff
changeset
|
1045 (setq index-item (assoc index-item (imenu--make-index-alist)))) |
41305
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1046 (when index-item |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1047 (push-mark) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1048 (let* ((is-special-item (listp (cdr index-item))) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1049 (function |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1050 (if is-special-item |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1051 (nth 2 index-item) imenu-default-goto-function)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1052 (position (if is-special-item |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1053 (cadr index-item) (cdr index-item))) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1054 (rest (if is-special-item (cddr index-item)))) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1055 (apply function (car index-item) position rest)) |
71197bcff33c
(imenu--split-menu): Use dolist and copy-sequence.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
38412
diff
changeset
|
1056 (run-hooks 'imenu-after-jump-hook))) |
8408
109166e311ce
(imenu, imenu--flatten-index-alist): Add marker support.
Richard M. Stallman <rms@gnu.org>
parents:
8296
diff
changeset
|
1057 |
29078 | 1058 (dolist (mess |
1059 '("^No items suitable for an index found in this buffer$" | |
1060 "^This buffer cannot use `imenu-default-create-index-function'$" | |
1061 "^The mode `.*' does not support Imenu$")) | |
1062 (add-to-list 'debug-ignored-errors mess)) | |
1063 | |
6230 | 1064 (provide 'imenu) |
1065 | |
57417
1389687cfa0a
(imenu--completion-buffer): Don't return t for rescan.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
56683
diff
changeset
|
1066 ;; arch-tag: 98a2f5f5-4b91-4704-b18c-3aacf77d77a7 |
6230 | 1067 ;;; imenu.el ends here |