Mercurial > emacs
annotate lisp/progmodes/etags.el @ 3962:38041a5069a8
(Faccessible_keymaps): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 03 Jul 1993 03:58:10 +0000 |
parents | 5bcb8bd982d0 |
children | 102019d30432 |
rev | line source |
---|---|
2229
bd3c525fa6fc
Added standard library headers.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1976
diff
changeset
|
1 ;;; etags.el --- etags facility for Emacs |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
2 |
1806
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1988, 1989, 1992, 1993 |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
4 ;; Free Software Foundation, Inc. |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
824
diff
changeset
|
5 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
6 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu> |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
7 ;; Keywords: tools |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
8 |
342 | 9 ;; This file is part of GNU Emacs. |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
727 | 13 ;; the Free Software Foundation; either version 2, or (at your option) |
342 | 14 ;; any later version. |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
24 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
25 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
26 |
360 | 27 ;;;###autoload |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
28 (defvar tags-file-name nil |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
29 "*File name of tags table. |
799 | 30 To switch to a new tags table, setting this variable is sufficient. |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
31 If you set this variable, do not also set `tags-table-list'. |
799 | 32 Use the `etags' program to make a tags table file.") |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
33 ;; Make M-x set-variable tags-file-name like M-x visit-tags-table. |
824 | 34 ;;;###autoload (put 'tags-file-name 'variable-interactive "fVisit tags table: ") |
799 | 35 |
36 ;;;###autoload | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
37 ;; Use `visit-tags-table-buffer' to cycle through tags tables in this list. |
799 | 38 (defvar tags-table-list nil |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
39 "*List of file names of tags tables to search. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
40 An element that is a directory means the file \"TAGS\" in that directory. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
41 To switch to a new list of tags tables, setting this variable is sufficient. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
42 If you set this variable, do not also set `tags-file-name'. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
43 Use the `etags' program to make a tags table file.") |
799 | 44 |
45 (defvar tags-table-list-pointer nil | |
1149 | 46 "Pointer into `tags-table-list' where the current state of searching is. |
47 Might instead point into a list of included tags tables. | |
48 Use `visit-tags-table-buffer' to cycle through tags tables in this list.") | |
49 | |
50 (defvar tags-table-list-started-at nil | |
51 "Pointer into `tags-table-list', where the current search started.") | |
342 | 52 |
799 | 53 (defvar tags-table-parent-pointer-list nil |
1149 | 54 "Saved state of the tags table that included this one. |
55 Each element is (POINTER . STARTED-AT), giving the values of | |
56 `tags-table-list-pointer' and `tags-table-list-started-at' from | |
57 before we moved into the current table.") | |
799 | 58 |
59 (defvar tags-table-set-list nil | |
60 "List of sets of tags table which have been used together in the past. | |
61 Each element is a list of strings which are file names.") | |
342 | 62 |
799 | 63 ;;;###autoload |
64 (defvar find-tag-hook nil | |
65 "*Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. | |
66 The value in the buffer in which \\[find-tag] is done is used, | |
67 not the value in the buffer \\[find-tag] goes to.") | |
68 | |
69 ;;;###autoload | |
70 (defvar find-tag-default-function nil | |
1149 | 71 "*A function of no arguments used by \\[find-tag] to pick a default tag. |
72 If nil, and the symbol that is the value of `major-mode' | |
799 | 73 has a `find-tag-default-function' property (see `put'), that is used. |
74 Otherwise, `find-tag-default' is used.") | |
342 | 75 |
360 | 76 ;;;###autoload |
799 | 77 (defvar default-tags-table-function nil |
78 "*If non-nil, a function of no arguments to choose a default tags file | |
79 for a particular buffer.") | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
80 |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
81 (defvar tags-location-stack nil |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
82 "List of markers which are locations visited by \\[find-tag]. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
83 Pop back to the last location with \\[negative-argument] \\[find-tag].") |
799 | 84 |
85 ;; Tags table state. | |
86 ;; These variables are local in tags table buffers. | |
87 | |
88 (defvar tag-lines-already-matched nil | |
89 "List of positions of beginnings of lines within the tags table | |
90 that are already matched.") | |
91 | |
92 (defvar tags-table-files nil | |
93 "List of file names covered by current tags table. | |
94 nil means it has not yet been computed; use `tags-table-files' to do so.") | |
95 | |
96 (defvar tags-completion-table nil | |
97 "Alist of tag names defined in current tags table.") | |
98 | |
99 (defvar tags-included-tables nil | |
100 "List of tags tables included by the current tags table.") | |
101 | |
102 (defvar next-file-list nil | |
103 "List of files for \\[next-file] to process.") | |
104 | |
105 ;; Hooks for file formats. | |
106 | |
107 (defvar tags-table-format-hooks '(etags-recognize-tags-table | |
824 | 108 recognize-empty-tags-table) |
799 | 109 "List of functions to be called in a tags table buffer to identify |
110 the type of tags table. The functions are called in order, with no arguments, | |
111 until one returns non-nil. The function should make buffer-local bindings | |
112 of the format-parsing tags function variables if successful.") | |
113 | |
114 (defvar file-of-tag-function nil | |
115 "Function to do the work of `file-of-tag' (which see).") | |
116 (defvar tags-table-files-function nil | |
117 "Function to do the work of `tags-table-files' (which see).") | |
118 (defvar tags-completion-table-function nil | |
119 "Function to build the tags-completion-table.") | |
120 (defvar snarf-tag-function nil | |
121 "Function to get info about a matched tag for `goto-tag-location-function'.") | |
122 (defvar goto-tag-location-function nil | |
123 "Function of to go to the location in the buffer specified by a tag. | |
124 One argument, the tag info returned by `snarf-tag-function'.") | |
125 (defvar find-tag-regexp-search-function nil | |
126 "Search function passed to `find-tag-in-order' for finding a regexp tag.") | |
127 (defvar find-tag-regexp-tag-order nil | |
128 "Tag order passed to `find-tag-in-order' for finding a regexp tag.") | |
129 (defvar find-tag-regexp-next-line-after-failure-p nil | |
130 "Flag passed to `find-tag-in-order' for finding a regexp tag.") | |
131 (defvar find-tag-search-function nil | |
132 "Search function passed to `find-tag-in-order' for finding a tag.") | |
133 (defvar find-tag-tag-order nil | |
134 "Tag order passed to `find-tag-in-order' for finding a tag.") | |
135 (defvar find-tag-next-line-after-failure-p nil | |
136 "Flag passed to `find-tag-in-order' for finding a tag.") | |
137 (defvar list-tags-function nil | |
138 "Function to do the work of `list-tags' (which see).") | |
139 (defvar tags-apropos-function nil | |
140 "Function to do the work of `tags-apropos' (which see).") | |
141 (defvar tags-included-tables-function nil | |
142 "Function to do the work of `tags-included-tables' (which see).") | |
143 (defvar verify-tags-table-function nil | |
3591
507f64624555
Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents:
3548
diff
changeset
|
144 "Function to return t iff the current buffer contains a valid |
799 | 145 \(already initialized\) tags file.") |
146 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
147 ;; Initialize the tags table in the current buffer. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
148 ;; Returns non-nil iff it is a valid tags table. On |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
149 ;; non-nil return, the tags table state variable are |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
150 ;; made buffer-local and initialized to nil. |
799 | 151 (defun initialize-new-tags-table () |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
152 (set (make-local-variable 'tag-lines-already-matched) nil) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
153 (set (make-local-variable 'tags-table-files) nil) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
154 (set (make-local-variable 'tags-completion-table) nil) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
155 (set (make-local-variable 'tags-included-tables) nil) |
799 | 156 ;; Value is t if we have found a valid tags table buffer. |
157 (let ((hooks tags-table-format-hooks)) | |
158 (while (and hooks | |
159 (not (funcall (car hooks)))) | |
160 (setq hooks (cdr hooks))) | |
161 hooks)) | |
162 | |
163 ;;;###autoload | |
164 (defun visit-tags-table (file &optional local) | |
165 "Tell tags commands to use tags table file FILE. | |
342 | 166 FILE should be the name of a file created with the `etags' program. |
799 | 167 A directory name is ok too; it means file TAGS in that directory. |
168 | |
169 Normally \\[visit-tags-table] sets the global value of `tags-file-name'. | |
170 With a prefix arg, set the buffer-local value instead. | |
171 When you find a tag with \\[find-tag], the buffer it finds the tag | |
172 in is given a local value of this variable which is the name of the tags | |
173 file the tag was in." | |
342 | 174 (interactive (list (read-file-name "Visit tags table: (default TAGS) " |
175 default-directory | |
799 | 176 (expand-file-name "TAGS" |
177 default-directory) | |
178 t) | |
179 current-prefix-arg)) | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
180 ;; Calling visit-tags-table-buffer with tags-file-name set to FILE will |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
181 ;; initialize a buffer for FILE and set tags-file-name to the |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
182 ;; fully-expanded name. |
1138 | 183 (let ((tags-file-name file)) |
184 (save-excursion | |
1149 | 185 (or (visit-tags-table-buffer 'same) |
1138 | 186 (signal 'file-error (list "Visiting tags table" |
187 "file does not exist" | |
188 file))) | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
189 ;; Set FILE to the expanded name. |
1138 | 190 (setq file tags-file-name))) |
799 | 191 (if local |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
192 ;; Set the local value of tags-file-name. |
1149 | 193 (set (make-local-variable 'tags-file-name) file) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
194 ;; Set the global value of tags-file-name. |
1138 | 195 (setq-default tags-file-name file))) |
196 | |
197 ;; Move tags-table-list-pointer along and set tags-file-name. | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
198 ;; If NO-INCLUDES is non-nil, ignore included tags tables. |
1138 | 199 ;; Returns nil when out of tables. |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
200 (defun tags-next-table (&optional no-includes) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
201 ;; Do we have any included tables? |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
202 (if (and (not no-includes) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
203 (visit-tags-table-buffer 'same) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
204 (tags-included-tables)) |
1149 | 205 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
206 ;; Move into the included tags tables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
207 (setq tags-table-parent-pointer-list |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
208 ;; Save the current state of what table we are in. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
209 (cons (cons tags-table-list-pointer tags-table-list-started-at) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
210 tags-table-parent-pointer-list) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
211 ;; Start the pointer in the list of included tables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
212 tags-table-list-pointer tags-included-tables |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
213 tags-table-list-started-at tags-included-tables) |
1149 | 214 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
215 ;; No included tables. Go to the next table in the list. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
216 (setq tags-table-list-pointer |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
217 (cdr tags-table-list-pointer)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
218 (or tags-table-list-pointer |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
219 ;; Wrap around. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
220 (setq tags-table-list-pointer tags-table-list)) |
1149 | 221 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
222 (if (eq tags-table-list-pointer tags-table-list-started-at) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
223 ;; We have come full circle. No more tables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
224 (if tags-table-parent-pointer-list |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
225 ;; Pop back to the tags table which includes this one. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
226 (progn |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
227 ;; Restore the state variables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
228 (setq tags-table-list-pointer |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
229 (car (car tags-table-parent-pointer-list)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
230 tags-table-list-started-at |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
231 (cdr (car tags-table-parent-pointer-list)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
232 tags-table-parent-pointer-list |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
233 (cdr tags-table-parent-pointer-list)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
234 ;; Recurse to skip to the next table after the parent. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
235 (tags-next-table t)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
236 ;; All out of tags tables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
237 (setq tags-table-list-pointer nil)))) |
1149 | 238 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
239 (and tags-table-list-pointer |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
240 ;; Set tags-file-name to the fully-expanded name. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
241 (setq tags-file-name |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
242 (tags-expand-table-name (car tags-table-list-pointer))))) |
1149 | 243 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
244 ;; Expand tags table name FILE into a complete file name. |
1149 | 245 (defun tags-expand-table-name (file) |
246 (setq file (expand-file-name file)) | |
247 (if (file-directory-p file) | |
248 (expand-file-name "TAGS" file) | |
249 file)) | |
1138 | 250 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
251 ;; Return the cdr of LIST (default: tags-table-list) whose car |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
252 ;; is equal to FILE after tags-expand-table-name on both sides. |
1149 | 253 (defun tags-table-list-member (file &optional list) |
254 (or list | |
255 (setq list tags-table-list)) | |
256 (setq file (tags-expand-table-name file)) | |
257 (while (and list | |
258 (not (string= file (tags-expand-table-name (car list))))) | |
259 (setq list (cdr list))) | |
260 list) | |
261 | |
262 ;; Subroutine of visit-tags-table-buffer. Frobs its local vars. | |
2768
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
263 ;; Search TABLES for one that has tags for THIS-FILE. Recurses on |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
264 ;; included tables. Returns the tail of TABLES (or of an inner |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
265 ;; included list) whose car is a table listing THIS-FILE. If |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
266 ;; CORE-ONLY is non-nil, check only tags tables that are already in |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
267 ;; buffers--don't visit any new files. |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
268 (defun tags-table-including (this-file tables core-only &optional recursing) |
1149 | 269 (let ((found nil)) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
270 ;; Loop over TABLES, looking for one containing tags for THIS-FILE. |
1149 | 271 (while (and (not found) |
272 tables) | |
273 (let ((tags-file-name (tags-expand-table-name (car tables)))) | |
274 (if (or (get-file-buffer tags-file-name) | |
2768
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
275 (and (not core-only) |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
276 (file-exists-p tags-file-name))) |
1149 | 277 (progn |
278 ;; Select the tags table buffer and get the file list up to date. | |
279 (visit-tags-table-buffer 'same) | |
280 (or tags-table-files | |
281 (setq tags-table-files | |
282 (funcall tags-table-files-function))) | |
283 | |
284 (cond ((member this-file tags-table-files) | |
285 ;; Found it. | |
286 (setq found tables)) | |
1138 | 287 |
1149 | 288 ((tags-included-tables) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
289 ;; This table has included tables. Check them. |
1149 | 290 (let ((old tags-table-parent-pointer-list)) |
291 (unwind-protect | |
292 (progn | |
293 (or recursing | |
294 ;; At top level (not in an included tags | |
295 ;; table), set the list to nil so we can | |
296 ;; collect just the elts from this run. | |
297 (setq tags-table-parent-pointer-list nil)) | |
298 (setq found | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
299 ;; Recurse on the list of included tables. |
1149 | 300 (tags-table-including this-file |
301 tags-included-tables | |
2768
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
302 core-only |
1149 | 303 t)) |
304 (if found | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
305 ;; One of them lists THIS-FILE. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
306 ;; Set the table list state variables to move |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
307 ;; us inside the list of included tables. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
308 (setq tags-table-parent-pointer-list |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
309 (cons |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
310 (cons tags-table-list-pointer |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
311 tags-table-list-started-at) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
312 tags-table-parent-pointer-list) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
313 tags-table-list-pointer found |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
314 tags-table-list-started-at found |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
315 ;; CONT is a local variable of |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
316 ;; our caller, visit-tags-table-buffer. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
317 ;; Set it so we won't frob lists later. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
318 cont 'included))) |
1149 | 319 (or recursing |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
320 ;; tags-table-parent-pointer-list now describes |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
321 ;; the path of included tables taken by recursive |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
322 ;; invocations of this function. The recursive |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
323 ;; calls have consed onto the front of the list, |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
324 ;; so it is now outermost first. We want it |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
325 ;; innermost first, so reverse it. Then append |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
326 ;; the old list (from before we were called the |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
327 ;; outermost time), to get the complete current |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
328 ;; state of included tables. |
1149 | 329 (setq tags-table-parent-pointer-list |
330 (nconc (nreverse | |
331 tags-table-parent-pointer-list) | |
332 old)))))))))) | |
333 (setq tables (cdr tables))) | |
334 found)) | |
799 | 335 |
336 (defun visit-tags-table-buffer (&optional cont) | |
337 "Select the buffer containing the current tags table. | |
338 If optional arg is t, visit the next table in `tags-table-list'. | |
339 If optional arg is the atom `same', don't look for a new table; | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
340 just select the buffer visiting `tags-file-name'. |
1149 | 341 If arg is nil or absent, choose a first buffer from information in |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
342 `tags-file-name', `tags-table-list', `tags-table-list-pointer'. |
799 | 343 Returns t if it visits a tags table, or nil if there are no more in the list." |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
344 |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
345 ;; Set tags-file-name to the tags table file we want to visit. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
346 (cond ((eq cont 'same) |
1806
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
347 ;; Use the ambient value of tags-file-name. |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
348 (or tags-file-name |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
349 (error (substitute-command-keys |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
350 (concat "No tags table in use! " |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
351 "Use \\[visit-tags-table] to select one.")))) |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
352 ;; Set CONT to nil so the code below will make sure tags-file-name |
da47cfb7624e
(visit-tags-table-buffer): Error if called with 'same and no current table.
Roland McGrath <roland@gnu.org>
parents:
1724
diff
changeset
|
353 ;; is in tags-table-list. |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
354 (setq cont nil)) |
1138 | 355 |
1149 | 356 (cont |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
357 ;; Find the next table. |
1149 | 358 (if (tags-next-table) |
359 ;; Skip over nonexistent files. | |
360 (while (and (let ((file (tags-expand-table-name tags-file-name))) | |
361 (not (or (get-file-buffer file) | |
362 (file-exists-p file)))) | |
363 (tags-next-table))))) | |
342 | 364 |
1149 | 365 (t |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
366 ;; Pick a table out of our hat. |
1149 | 367 (setq tags-file-name |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
368 (or |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
369 ;; First, try a local variable. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
370 (cdr (assq 'tags-file-name (buffer-local-variables))) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
371 ;; Second, try a user-specified function to guess. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
372 (and default-tags-table-function |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
373 (funcall default-tags-table-function)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
374 ;; Third, look for a tags table that contains |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
375 ;; tags for the current buffer's file. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
376 ;; If one is found, the lists will be frobnicated, |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
377 ;; and CONT will be set non-nil so we don't do it below. |
2768
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
378 (car (or |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
379 ;; First check only tables already in buffers. |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
380 (save-excursion (tags-table-including buffer-file-name |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
381 tags-table-list |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
382 t)) |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
383 ;; Since that didn't find any, now do the |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
384 ;; expensive version: reading new files. |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
385 (save-excursion (tags-table-including buffer-file-name |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
386 tags-table-list |
82797c755adc
(tags-table-including): Take new third arg CORE-ONLY. If non-nil,
Roland McGrath <roland@gnu.org>
parents:
2590
diff
changeset
|
387 nil)))) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
388 ;; Fourth, use the user variable tags-file-name, if it is not |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
389 ;; already in tags-table-list. |
1697
f14e1a6ac205
(visit-tags-table-buffer): Don't look in list for tags-file-name if nil.
Roland McGrath <roland@gnu.org>
parents:
1696
diff
changeset
|
390 (and tags-file-name |
f14e1a6ac205
(visit-tags-table-buffer): Don't look in list for tags-file-name if nil.
Roland McGrath <roland@gnu.org>
parents:
1696
diff
changeset
|
391 (not (tags-table-list-member tags-file-name)) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
392 tags-file-name) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
393 ;; Fifth, use the user variable giving the table list. |
1724
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
394 ;; Find the first element of the list that actually exists. |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
395 (let ((list tags-table-list) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
396 file) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
397 (while (and list |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
398 (setq file (tags-expand-table-name (car list))) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
399 (not (get-file-buffer file)) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
400 (not (file-exists-p file))) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
401 (setq list (cdr list))) |
2dccfada2107
(visit-tags-table-buffer): When picking a table and using tags-table-list,
Roland McGrath <roland@gnu.org>
parents:
1723
diff
changeset
|
402 (car list)) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
403 ;; Finally, prompt the user for a file name. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
404 (expand-file-name |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
405 (read-file-name "Visit tags table: (default TAGS) " |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
406 default-directory |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
407 "TAGS" |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
408 t)))))) |
1149 | 409 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
410 ;; Expand the table name into a full file name. |
1149 | 411 (setq tags-file-name (tags-expand-table-name tags-file-name)) |
412 | |
1156 | 413 (if (and (eq cont t) (null tags-table-list-pointer)) |
1149 | 414 ;; All out of tables. |
415 nil | |
1138 | 416 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
417 ;; Verify that tags-file-name is a valid tags table. |
1149 | 418 (if (if (get-file-buffer tags-file-name) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
419 ;; The file is already in a buffer. Check for the visited file |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
420 ;; having changed since we last used it. |
1149 | 421 (let (win) |
422 (set-buffer (get-file-buffer tags-file-name)) | |
423 (setq win (or verify-tags-table-function | |
424 (initialize-new-tags-table))) | |
425 (if (or (verify-visited-file-modtime (current-buffer)) | |
426 (not (yes-or-no-p | |
427 "Tags file has changed, read new contents? "))) | |
428 (and win (funcall verify-tags-table-function)) | |
429 (revert-buffer t t) | |
430 (initialize-new-tags-table))) | |
431 (set-buffer (find-file-noselect tags-file-name)) | |
432 (or (string= tags-file-name buffer-file-name) | |
433 ;; find-file-noselect has changed the file name. | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
434 ;; Propagate the change to tags-file-name and tags-table-list. |
1807
1059b972916c
(visit-tags-table-buffer): When propagating a change of name after
Roland McGrath <roland@gnu.org>
parents:
1806
diff
changeset
|
435 (let ((tail (member tags-file-name tags-table-list))) |
1149 | 436 (if tail |
437 (setcar tail buffer-file-name)) | |
438 (setq tags-file-name buffer-file-name))) | |
439 (initialize-new-tags-table)) | |
440 | |
441 ;; We have a valid tags table. | |
442 (progn | |
443 ;; Bury the tags table buffer so it | |
444 ;; doesn't get in the user's way. | |
445 (bury-buffer (current-buffer)) | |
799 | 446 |
1149 | 447 (if cont |
448 ;; No list frobbing required. | |
449 nil | |
450 | |
451 ;; Look in the list for the table we chose. | |
452 (let ((elt (tags-table-list-member tags-file-name))) | |
453 (or elt | |
454 ;; The table is not in the current set. | |
455 ;; Try to find it in another previously used set. | |
456 (let ((sets tags-table-set-list)) | |
457 (while (and sets | |
458 (not (setq elt (tags-table-list-member | |
459 tags-file-name (car sets))))) | |
460 (setq sets (cdr sets))) | |
461 (if sets | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
462 ;; Found in some other set. Switch to that set. |
1149 | 463 (progn |
1138 | 464 (or (memq tags-table-list tags-table-set-list) |
1149 | 465 ;; Save the current list. |
1138 | 466 (setq tags-table-set-list |
467 (cons tags-table-list | |
468 tags-table-set-list))) | |
1149 | 469 (setq tags-table-list (car sets))) |
470 | |
471 ;; Not found in any existing set. | |
472 (if (and tags-table-list | |
473 (y-or-n-p (concat "Add " tags-file-name | |
474 " to current list" | |
475 " of tags tables? "))) | |
476 ;; Add it to the current list. | |
477 (setq tags-table-list (cons tags-file-name | |
478 tags-table-list)) | |
479 ;; Make a fresh list, and store the old one. | |
480 (or (memq tags-table-list tags-table-set-list) | |
481 (setq tags-table-set-list | |
482 (cons tags-table-list tags-table-set-list))) | |
483 (setq tags-table-list (list tags-file-name))) | |
484 (setq elt tags-table-list)))) | |
485 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
486 ;; Set the tags table list state variables to point at the table |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
487 ;; we want to use first. |
1149 | 488 (setq tags-table-list-started-at elt |
1156 | 489 tags-table-list-pointer elt))) |
490 | |
491 ;; Return of t says the tags table is valid. | |
492 t) | |
1149 | 493 |
494 ;; The buffer was not valid. Don't use it again. | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
495 (let ((file tags-file-name)) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
496 (kill-local-variable 'tags-file-name) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
497 (if (eq file tags-file-name) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
498 (setq tags-file-name nil))) |
1149 | 499 (error "File %s is not a valid tags table" buffer-file-name)))) |
1397
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
500 |
342 | 501 (defun file-of-tag () |
502 "Return the file name of the file whose tags point is within. | |
799 | 503 Assumes the tags table is the current buffer. |
504 File name returned is relative to tags table file's directory." | |
505 (funcall file-of-tag-function)) | |
342 | 506 |
360 | 507 ;;;###autoload |
799 | 508 (defun tags-table-files () |
509 "Return a list of files in the current tags table. | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
510 Assumes the tags table is the current buffer. |
342 | 511 File names returned are absolute." |
1397
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
512 (or tags-table-files |
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
513 (setq tags-table-files |
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
514 (funcall tags-table-files-function)))) |
799 | 515 |
516 (defun tags-included-tables () | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
517 "Return a list of tags tables included by the current table. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
518 Assumes the tags table is the current buffer." |
799 | 519 (or tags-included-tables |
520 (setq tags-included-tables (funcall tags-included-tables-function)))) | |
521 | |
522 ;; Build tags-completion-table on demand. The single current tags table | |
523 ;; and its included tags tables (and their included tables, etc.) have | |
524 ;; their tags included in the completion table. | |
525 (defun tags-completion-table () | |
526 (or tags-completion-table | |
527 (condition-case () | |
528 (prog2 | |
529 (message "Making tags completion table for %s..." buffer-file-name) | |
530 (let ((included (tags-included-tables)) | |
531 (table (funcall tags-completion-table-function))) | |
532 (save-excursion | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
533 ;; Iterate over the list of included tables, and combine each |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
534 ;; included table's completion obarray to the parent obarray. |
799 | 535 (while included |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
536 ;; Visit the buffer. |
799 | 537 (let ((tags-file-name (car included))) |
1149 | 538 (visit-tags-table-buffer 'same)) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
539 ;; Recurse in that buffer to compute its completion table. |
799 | 540 (if (tags-completion-table) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
541 ;; Combine the tables. |
799 | 542 (mapatoms (function |
543 (lambda (sym) | |
544 (intern (symbol-name sym) table))) | |
545 tags-completion-table)) | |
546 (setq included (cdr included)))) | |
547 (setq tags-completion-table table)) | |
548 (message "Making tags completion table for %s...done" | |
549 buffer-file-name)) | |
550 (quit (message "Tags completion table construction aborted.") | |
551 (setq tags-completion-table nil))))) | |
552 | |
553 ;; Completion function for tags. Does normal try-completion, | |
554 ;; but builds tags-completion-table on demand. | |
555 (defun tags-complete-tag (string predicate what) | |
556 (save-excursion | |
557 (visit-tags-table-buffer) | |
558 (if (eq what t) | |
559 (all-completions string (tags-completion-table) predicate) | |
560 (try-completion string (tags-completion-table) predicate)))) | |
1397
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
561 |
342 | 562 ;; Return a default tag to search for, based on the text at point. |
563 (defun find-tag-default () | |
564 (save-excursion | |
565 (while (looking-at "\\sw\\|\\s_") | |
566 (forward-char 1)) | |
799 | 567 (if (or (re-search-backward "\\sw\\|\\s_" |
568 (save-excursion (beginning-of-line) (point)) | |
569 t) | |
570 (re-search-forward "\\(\\sw\\|\\s_\\)+" | |
571 (save-excursion (end-of-line) (point)) | |
572 t)) | |
573 (progn (goto-char (match-end 0)) | |
342 | 574 (buffer-substring (point) |
575 (progn (forward-sexp -1) | |
576 (while (looking-at "\\s'") | |
577 (forward-char 1)) | |
578 (point)))) | |
579 nil))) | |
580 | |
799 | 581 ;; Read a tag name from the minibuffer with defaulting and completion. |
342 | 582 (defun find-tag-tag (string) |
799 | 583 (let* ((default (funcall (or find-tag-default-function |
584 (get major-mode 'find-tag-default-function) | |
585 'find-tag-default))) | |
586 (spec (completing-read (if default | |
587 (format "%s(default %s) " string default) | |
588 string) | |
589 'tags-complete-tag))) | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
590 (if (equal spec "") |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
591 (or default (error "There is no default tag")) |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
592 spec))) |
342 | 593 |
852 | 594 (defvar last-tag nil |
595 "Last tag found by \\[find-tag].") | |
596 | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
597 ;; Get interactive args for find-tag{-noselect,-other-window,-regexp}. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
598 (defun find-tag-interactive (prompt &optional no-default) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
599 (if current-prefix-arg |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
600 (list nil (if (< (prefix-numeric-value current-prefix-arg) 0) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
601 '- |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
602 t)) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
603 (list (if no-default |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
604 (read-string prompt) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
605 (find-tag-tag prompt))))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
606 |
799 | 607 ;;;###autoload |
608 (defun find-tag-noselect (tagname &optional next-p regexp-p) | |
609 "Find tag (in current tags table) whose name contains TAGNAME. | |
1555
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
610 Returns the buffer containing the tag's definition and moves its point there, |
799 | 611 but does not select the buffer. |
612 The default for TAGNAME is the expression in the buffer near point. | |
474 | 613 |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
614 If second arg NEXT-P is t (interactively, with prefix arg), search for |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
615 another tag that matches the last tagname or regexp used. When there are |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
616 multiple matches for a tag, more exact matches are found first. If NEXT-P |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
617 is the atom `-' (interactively, with prefix arg that is a negative number |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
618 or just \\[negative-argument]), pop back to the previous tag gone to. |
450
0bac8c701777
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
449
diff
changeset
|
619 |
799 | 620 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp. |
342 | 621 |
799 | 622 See documentation of variable `tags-file-name'." |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
623 (interactive (find-tag-interactive "Find tag: ")) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
624 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
625 ;; Save the current buffer's value of `find-tag-hook' before selecting the |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
626 ;; tags table buffer. |
799 | 627 (let ((local-find-tag-hook find-tag-hook)) |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
628 (if (eq '- next-p) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
629 ;; Pop back to a previous location. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
630 (if (null tags-location-stack) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
631 (error "No previous tag locations") |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
632 (let ((marker (car tags-location-stack))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
633 ;; Pop the stack. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
634 (setq tags-location-stack (cdr tags-location-stack)) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
635 (prog1 |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
636 ;; Move to the saved location. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
637 (set-buffer (marker-buffer marker)) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
638 (goto-char (marker-position marker)) |
3591
507f64624555
Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents:
3548
diff
changeset
|
639 ;; Kill that marker so it doesn't slow down editing. |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
640 (set-marker marker nil nil) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
641 ;; Run the user's hook. Do we really want to do this for pop? |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
642 (run-hooks 'local-find-tag-hook)))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
643 (if next-p |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
644 ;; Find the same table we last used. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
645 (visit-tags-table-buffer 'same) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
646 ;; Pick a table to use. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
647 (visit-tags-table-buffer) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
648 ;; Record TAGNAME for a future call with NEXT-P non-nil. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
649 (setq last-tag tagname)) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
650 (prog1 |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
651 ;; Record the location so we can pop back to it later. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
652 (marker-buffer |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
653 (car |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
654 (setq tags-location-stack |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
655 (cons (let ((marker (make-marker))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
656 (save-excursion |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
657 (set-buffer |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
658 ;; find-tag-in-order does the real work. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
659 (find-tag-in-order |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
660 (if next-p last-tag tagname) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
661 (if regexp-p |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
662 find-tag-regexp-search-function |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
663 find-tag-search-function) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
664 (if regexp-p |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
665 find-tag-regexp-tag-order |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
666 find-tag-tag-order) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
667 (if regexp-p |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
668 find-tag-regexp-next-line-after-failure-p |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
669 find-tag-next-line-after-failure-p) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
670 (if regexp-p "matching" "containing") |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
671 (not next-p))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
672 (set-marker marker (point)))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
673 tags-location-stack)))) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
674 (run-hooks 'local-find-tag-hook))))) |
360 | 675 |
676 ;;;###autoload | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
677 (defun find-tag (tagname &optional next-p regexp-p) |
799 | 678 "Find tag (in current tags table) whose name contains TAGNAME. |
679 Select the buffer containing the tag's definition, and move point there. | |
680 The default for TAGNAME is the expression in the buffer around or before point. | |
342 | 681 |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
682 If second arg NEXT-P is t (interactively, with prefix arg), search for |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
683 another tag that matches the last tagname or regexp used. When there are |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
684 multiple matches for a tag, more exact matches are found first. If NEXT-P |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
685 is the atom `-' (interactively, with prefix arg that is a negative number |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
686 or just \\[negative-argument]), pop back to the previous tag gone to. |
799 | 687 |
688 See documentation of variable `tags-file-name'." | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
689 (interactive (find-tag-interactive "Find tag: ")) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
690 (switch-to-buffer (find-tag-noselect tagname next-p regexp-p))) |
799 | 691 ;;;###autoload (define-key esc-map "." 'find-tag) |
342 | 692 |
727 | 693 ;;;###autoload |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
694 (defun find-tag-other-window (tagname &optional next-p regexp-p) |
799 | 695 "Find tag (in current tags table) whose name contains TAGNAME. |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
696 Select the buffer containing the tag's definition in another window, and |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
697 move point there. The default for TAGNAME is the expression in the buffer |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
698 around or before point. |
799 | 699 |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
700 If second arg NEXT-P is t (interactively, with prefix arg), search for |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
701 another tag that matches the last tagname or regexp used. When there are |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
702 multiple matches for a tag, more exact matches are found first. If NEXT-P |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
703 is negative (interactively, with prefix arg that is a negative number or |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
704 just \\[negative-argument]), pop back to the previous tag gone to. |
799 | 705 |
706 See documentation of variable `tags-file-name'." | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
707 (interactive (find-tag-interactive "Find tag other window: ")) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
708 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
709 ;; This hair is to deal with the case where the tag is found in the |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
710 ;; selected window's buffer; without the hair, point is moved in both |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
711 ;; windows. To prevent this, we save the selected window's point before |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
712 ;; doing find-tag-noselect, and restore it after. |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
713 (let* ((window-point (window-point (selected-window))) |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
714 (tagbuf (find-tag-noselect tagname next-p regexp-p)) |
1976
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
715 (tagpoint (progn (set-buffer tagbuf) (point)))) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
716 (set-window-point (prog1 |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
717 (selected-window) |
1976
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
718 (switch-to-buffer-other-window tagbuf) |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
719 ;; We have to set this new window's point; it |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
720 ;; might already have been displaying a |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
721 ;; different portion of tagbuf, in which case |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
722 ;; switch-to-buffer-other-window doesn't set |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
723 ;; the window's point from the buffer. |
eda7eec8f8ad
* etags.el (find-tag-other-window): If another window is already
Jim Blandy <jimb@redhat.com>
parents:
1816
diff
changeset
|
724 (set-window-point (selected-window) tagpoint)) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
725 window-point))) |
799 | 726 ;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window) |
727 | |
804 | 728 ;;;###autoload |
799 | 729 (defun find-tag-other-frame (tagname &optional next-p) |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
730 "Find tag (in current tags table) whose name contains TAGNAME. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
731 Select the buffer containing the tag's definition in another frame, and |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
732 move point there. The default for TAGNAME is the expression in the buffer |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
733 around or before point. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
734 |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
735 If second arg NEXT-P is t (interactively, with prefix arg), search for |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
736 another tag that matches the last tagname or regexp used. When there are |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
737 multiple matches for a tag, more exact matches are found first. If NEXT-P |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
738 is negative (interactively, with prefix arg that is a negative number or |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
739 just \\[negative-argument]), pop back to the previous tag gone to. |
727 | 740 |
799 | 741 See documentation of variable `tags-file-name'." |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
742 (interactive (find-tag-interactive "Find tag other frame: ")) |
799 | 743 (let ((pop-up-frames t)) |
744 (find-tag-other-window tagname next-p))) | |
745 ;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame) | |
342 | 746 |
360 | 747 ;;;###autoload |
799 | 748 (defun find-tag-regexp (regexp &optional next-p other-window) |
749 "Find tag (in current tags table) whose name matches REGEXP. | |
750 Select the buffer containing the tag's definition and move point there. | |
751 | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
752 If second arg NEXT-P is t (interactively, with prefix arg), search for |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
753 another tag that matches the last tagname or regexp used. When there are |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
754 multiple matches for a tag, more exact matches are found first. If NEXT-P |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
755 is negative (interactively, with prefix arg that is a negative number or |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
756 just \\[negative-argument]), pop back to the previous tag gone to. |
799 | 757 |
758 If third arg OTHER-WINDOW is non-nil, select the buffer in another window. | |
759 | |
760 See documentation of variable `tags-file-name'." | |
2590
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
761 (interactive (find-tag-interactive "Find tag regexp: " t)) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
762 ;; We go through find-tag-other-window to do all the display hair there. |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
763 (funcall (if other-window 'find-tag-other-window 'find-tag) |
9dace03bd76c
(find-tag-interactive): New function to read args for find-tag et al.
Roland McGrath <roland@gnu.org>
parents:
2448
diff
changeset
|
764 regexp next-p t)) |
799 | 765 |
766 ;; Internal tag finding function. | |
767 | |
768 ;; PATTERN is a string to pass to second arg SEARCH-FORWARD-FUNC, and to | |
769 ;; any member of the function list ORDER (third arg). If ORDER is nil, | |
770 ;; use saved state to continue a previous search. | |
771 | |
772 ;; Fourth arg MATCHING is a string, an English '-ing' word, to be used in | |
773 ;; an error message. | |
774 | |
775 ;; Fifth arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match, | |
776 ;; point should be moved to the next line. | |
777 | |
778 ;; Algorithm is as follows. For each qualifier-func in ORDER, go to | |
779 ;; beginning of tags file, and perform inner loop: for each naive match for | |
780 ;; PATTERN found using SEARCH-FORWARD-FUNC, qualify the naive match using | |
781 ;; qualifier-func. If it qualifies, go to the specified line in the | |
782 ;; specified source file and return. Qualified matches are remembered to | |
783 ;; avoid repetition. State is saved so that the loop can be continued. | |
784 | |
1555
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
785 (defun find-tag-in-order (pattern |
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
786 search-forward-func |
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
787 order |
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
788 next-line-after-failure-p |
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
789 matching |
695c6eb2ff31
* etags.el (find-tag-noselect): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1397
diff
changeset
|
790 first-search) |
799 | 791 (let (file ;name of file containing tag |
792 tag-info ;where to find the tag in FILE | |
793 tags-table-file ;name of tags file | |
794 (first-table t) | |
795 (tag-order order) | |
796 goto-func | |
797 ) | |
798 (save-excursion | |
1149 | 799 (or first-search ;find-tag-noselect has already done it. |
800 (visit-tags-table-buffer 'same)) | |
801 | |
799 | 802 ;; Get a qualified match. |
803 (catch 'qualified-match-found | |
1149 | 804 |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
805 ;; Iterate over the list of tags tables. |
799 | 806 (while (or first-table |
807 (visit-tags-table-buffer t)) | |
808 | |
809 (if first-search | |
810 (setq tag-lines-already-matched nil)) | |
811 | |
884 | 812 (and first-search first-table |
813 ;; Start at beginning of tags file. | |
814 (goto-char (point-min))) | |
815 (setq first-table nil) | |
799 | 816 |
817 (setq tags-table-file buffer-file-name) | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
818 ;; Iterate over the list of ordering predicates. |
799 | 819 (while order |
820 (while (funcall search-forward-func pattern nil t) | |
821 ;; Naive match found. Qualify the match. | |
822 (and (funcall (car order) pattern) | |
823 ;; Make sure it is not a previous qualified match. | |
824 ;; Use of `memq' depends on numbers being eq. | |
825 (not (memq (save-excursion (beginning-of-line) (point)) | |
826 tag-lines-already-matched)) | |
827 (throw 'qualified-match-found nil)) | |
828 (if next-line-after-failure-p | |
829 (forward-line 1))) | |
830 ;; Try the next flavor of match. | |
831 (setq order (cdr order)) | |
832 (goto-char (point-min))) | |
833 (setq order tag-order)) | |
834 ;; We throw out on match, so only get here if there were no matches. | |
835 (error "No %stags %s %s" (if first-search "" "more ") | |
836 matching pattern)) | |
837 | |
838 ;; Found a tag; extract location info. | |
839 (beginning-of-line) | |
840 (setq tag-lines-already-matched (cons (point) | |
841 tag-lines-already-matched)) | |
842 ;; Expand the filename, using the tags table buffer's default-directory. | |
843 (setq file (expand-file-name (file-of-tag)) | |
844 tag-info (funcall snarf-tag-function)) | |
845 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
846 ;; Get the local value in the tags table buffer before switching buffers. |
799 | 847 (setq goto-func goto-tag-location-function) |
848 | |
849 ;; Find the right line in the specified file. | |
850 (set-buffer (find-file-noselect file)) | |
851 (widen) | |
852 (push-mark) | |
853 (funcall goto-func tag-info) | |
854 | |
855 ;; Give this buffer a local value of tags-file-name. | |
856 ;; The next time visit-tags-table-buffer is called, | |
857 ;; it will use the same tags table that found a match in this buffer. | |
858 (make-local-variable 'tags-file-name) | |
859 (setq tags-file-name tags-table-file) | |
860 | |
861 ;; Return the buffer where the tag was found. | |
862 (current-buffer)))) | |
863 | |
864 ;; `etags' TAGS file format support. | |
865 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
866 ;; If the current buffer is a valid etags TAGS file, give it local values of |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
867 ;; the tags table format variables, and return non-nil. |
799 | 868 (defun etags-recognize-tags-table () |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
869 (and (etags-verify-tags-table) |
1136 | 870 ;; It is annoying to flash messages on the screen briefly, |
871 ;; and this message is not useful. -- rms | |
872 ;; (message "%s is an `etags' TAGS file" buffer-file-name) | |
799 | 873 (mapcar (function (lambda (elt) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
874 (set (make-local-variable (car elt)) (cdr elt)))) |
799 | 875 '((file-of-tag-function . etags-file-of-tag) |
876 (tags-table-files-function . etags-tags-table-files) | |
877 (tags-completion-table-function . etags-tags-completion-table) | |
878 (snarf-tag-function . etags-snarf-tag) | |
879 (goto-tag-location-function . etags-goto-tag-location) | |
880 (find-tag-regexp-search-function . re-search-forward) | |
881 (find-tag-regexp-tag-order . (tag-re-match-p)) | |
3548
54b82ecde27b
(etags-recognize-tags-table): Fix misspelling of
Richard M. Stallman <rms@gnu.org>
parents:
2768
diff
changeset
|
882 (find-tag-regexp-next-line-after-failure-p . t) |
799 | 883 (find-tag-search-function . search-forward) |
884 (find-tag-tag-order . (tag-exact-match-p tag-word-match-p | |
885 tag-any-match-p)) | |
886 (find-tag-next-line-after-failure-p . nil) | |
887 (list-tags-function . etags-list-tags) | |
888 (tags-apropos-function . etags-tags-apropos) | |
889 (tags-included-tables-function . etags-tags-included-tables) | |
890 (verify-tags-table-function . etags-verify-tags-table) | |
891 )))) | |
892 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
893 ;; Return non-nil iff the current buffer is a valid etags TAGS file. |
799 | 894 (defun etags-verify-tags-table () |
1723
4023bea27d64
(etags-verify-tags-table): Use eq instead of = in case char-after returns
Roland McGrath <roland@gnu.org>
parents:
1697
diff
changeset
|
895 ;; Use eq instead of = in case char-after returns nil. |
4023bea27d64
(etags-verify-tags-table): Use eq instead of = in case char-after returns
Roland McGrath <roland@gnu.org>
parents:
1697
diff
changeset
|
896 (eq (char-after 1) ?\f)) |
799 | 897 |
898 (defun etags-file-of-tag () | |
899 (save-excursion | |
900 (search-backward "\f\n") | |
901 (forward-char 2) | |
902 (buffer-substring (point) | |
903 (progn (skip-chars-forward "^,") (point))))) | |
904 | |
905 (defun etags-tags-completion-table () | |
906 (let ((table (make-vector 511 0))) | |
907 (save-excursion | |
908 (goto-char (point-min)) | |
2448
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
909 ;; This monster regexp matches an etags tag line. |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
910 ;; \1 is the string to match; |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
911 ;; \2 is not interesting; |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
912 ;; \3 is the guessed tag name; XXX guess should be better eg DEFUN |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
913 ;; \4 is the char to start searching at; |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
914 ;; \5 is the line to start searching at; |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
915 ;; \6 is not interesting; |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
916 ;; \7 is the explicitly-specified tag name. |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
917 (while (re-search-forward |
3702
5bcb8bd982d0
(etags-tags-completion-table): When skipping the noise
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
918 "^\\(\\(.+[^-a-zA-Z0-9_$]+\\)?\\([-a-zA-Z0-9_$]+\\)\ |
5bcb8bd982d0
(etags-tags-completion-table): When skipping the noise
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
919 \[^-a-zA-Z0-9_$]*\\)\177\ |
2448
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
920 \\([0-9]+\\),\\([0-9]+\\)\\(,\001\\([^\n]+\\)\\)?\n" |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
921 nil t) |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
922 (intern (if (match-beginning 6) |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
923 ;; There is an explicit tag name. |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
924 (buffer-substring (match-beginning 6) (match-end 6)) |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
925 ;; No explicit tag name. Best guess. |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
926 (buffer-substring (match-beginning 3) (match-end 3))) |
0d7fdb12dcdb
(etags-tags-completion-table): Rewritten with a mondo regexp.
Roland McGrath <roland@gnu.org>
parents:
2445
diff
changeset
|
927 table))) |
799 | 928 table)) |
929 | |
930 (defun etags-snarf-tag () | |
931 (let (tag-text startpos) | |
932 (search-forward "\177") | |
933 (setq tag-text (buffer-substring (1- (point)) | |
934 (save-excursion (beginning-of-line) | |
935 (point)))) | |
936 (search-forward ",") | |
937 (setq startpos (string-to-int (buffer-substring | |
938 (point) | |
939 (progn (skip-chars-forward "0-9") | |
940 (point))))) | |
941 ;; Leave point on the next line of the tags file. | |
942 (forward-line 1) | |
943 (cons tag-text startpos))) | |
944 | |
945 (defun etags-goto-tag-location (tag-info) | |
946 (let ((startpos (cdr tag-info)) | |
947 ;; This constant is 1/2 the initial search window. | |
948 ;; There is no sense in making it too small, | |
949 ;; since just going around the loop once probably | |
950 ;; costs about as much as searching 2000 chars. | |
951 (offset 1000) | |
952 (found nil) | |
953 (pat (concat "^" (regexp-quote (car tag-info))))) | |
954 (or startpos | |
955 (setq startpos (point-min))) | |
956 (while (and (not found) | |
957 (progn | |
958 (goto-char (- startpos offset)) | |
959 (not (bobp)))) | |
960 (setq found | |
961 (re-search-forward pat (+ startpos offset) t) | |
962 offset (* 3 offset))) ; expand search window | |
963 (or found | |
964 (re-search-forward pat nil t) | |
965 (error "`%s' not found in %s; time to rerun etags" | |
966 pat buffer-file-name))) | |
967 (beginning-of-line)) | |
968 | |
969 (defun etags-list-tags (file) | |
970 (goto-char 1) | |
971 (if (not (search-forward (concat "\f\n" file ",") nil t)) | |
972 nil | |
973 (forward-line 1) | |
974 (while (not (or (eobp) (looking-at "\f"))) | |
975 (princ (buffer-substring (point) | |
976 (progn (skip-chars-forward "^\177") | |
977 (point)))) | |
978 (terpri) | |
979 (forward-line 1)))) | |
980 | |
981 (defun etags-tags-apropos (string) | |
982 (goto-char 1) | |
983 (while (re-search-forward string nil t) | |
984 (beginning-of-line) | |
985 (princ (buffer-substring (point) | |
986 (progn (skip-chars-forward "^\177") | |
987 (point)))) | |
988 (terpri) | |
989 (forward-line 1))) | |
990 | |
991 (defun etags-tags-table-files () | |
992 (let ((files nil) | |
993 beg) | |
994 (goto-char (point-min)) | |
995 (while (search-forward "\f\n" nil t) | |
996 (setq beg (point)) | |
997 (skip-chars-forward "^,\n") | |
998 (or (looking-at ",include$") | |
999 ;; Expand in the default-directory of the tags table buffer. | |
1000 (setq files (cons (expand-file-name (buffer-substring beg (point))) | |
1001 files)))) | |
1002 (nreverse files))) | |
1003 | |
1004 (defun etags-tags-included-tables () | |
1005 (let ((files nil) | |
1006 beg) | |
1007 (goto-char (point-min)) | |
1008 (while (search-forward "\f\n" nil t) | |
1009 (setq beg (point)) | |
1010 (skip-chars-forward "^,\n") | |
1011 (if (looking-at ",include$") | |
1012 ;; Expand in the default-directory of the tags table buffer. | |
1013 (setq files (cons (expand-file-name (buffer-substring beg (point))) | |
1014 files)))) | |
1015 (nreverse files))) | |
1016 | |
1017 ;; Empty tags file support. | |
1018 | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1019 ;; Recognize an empty file and give it local values of the tags table format |
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1020 ;; variables which do nothing. |
799 | 1021 (defun recognize-empty-tags-table () |
1022 (and (zerop (buffer-size)) | |
1023 (mapcar (function (lambda (sym) | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1024 (set (make-local-variable sym) 'ignore))) |
799 | 1025 '(tags-table-files-function |
1026 tags-completion-table-function | |
1027 find-tag-regexp-search-function | |
1028 find-tag-search-function | |
1029 tags-apropos-function | |
1030 tags-included-tables-function)) | |
1031 (set (make-local-variable 'verify-tags-table-function) | |
1032 (function (lambda () | |
1033 (zerop (buffer-size))))))) | |
1034 | |
1035 ;;; Match qualifier functions for tagnames. | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1036 ;;; XXX these functions assume etags file format. |
799 | 1037 |
884 | 1038 ;; This might be a neat idea, but it's too hairy at the moment. |
1039 ;;(defmacro tags-with-syntax (&rest body) | |
1040 ;; (` (let ((current (current-buffer)) | |
1041 ;; (otable (syntax-table)) | |
1042 ;; (buffer (find-file-noselect (file-of-tag))) | |
1043 ;; table) | |
1044 ;; (unwind-protect | |
1045 ;; (progn | |
1046 ;; (set-buffer buffer) | |
1047 ;; (setq table (syntax-table)) | |
1048 ;; (set-buffer current) | |
1049 ;; (set-syntax-table table) | |
1050 ;; (,@ body)) | |
1051 ;; (set-syntax-table otable))))) | |
1052 ;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form)) | |
877 | 1053 |
799 | 1054 ;; t if point is at a tag line that matches TAG "exactly". |
1055 ;; point should be just after a string that matches TAG. | |
884 | 1056 (defun tag-exact-match-p (tag) |
1057 (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177") ;not a symbol char | |
1058 (save-excursion | |
1059 (backward-char (1+ (length tag))) | |
1060 (and (looking-at "\\Sw") (looking-at "\\S_"))))) | |
799 | 1061 |
1062 ;; t if point is at a tag line that matches TAG as a word. | |
1063 ;; point should be just after a string that matches TAG. | |
1064 (defun tag-word-match-p (tag) | |
1065 (and (looking-at "\\b.*\177") | |
1066 (save-excursion (backward-char (1+ (length tag))) | |
1067 (looking-at "\\b")))) | |
1068 | |
1069 ;; t if point is in a tag line with a tag containing TAG as a substring. | |
1070 (defun tag-any-match-p (tag) | |
1071 (looking-at ".*\177")) | |
1072 | |
1073 ;; t if point is at a tag line that matches RE as a regexp. | |
1074 (defun tag-re-match-p (re) | |
1075 (save-excursion | |
1076 (beginning-of-line) | |
1077 (let ((bol (point))) | |
1078 (and (search-forward "\177" (save-excursion (end-of-line) (point)) t) | |
1079 (re-search-backward re bol t))))) | |
1080 | |
1081 ;;;###autoload | |
1082 (defun next-file (&optional initialize novisit) | |
1083 "Select next file among files in current tags table. | |
1084 Non-nil first argument (prefix arg, if interactive) | |
1085 initializes to the beginning of the list of files in the tags table. | |
1086 | |
1087 Non-nil second argument NOVISIT means use a temporary buffer | |
1088 to save time and avoid uninteresting warnings. | |
1089 | |
1090 Value is nil if the file was already visited; | |
1091 if the file was newly read in, the value is the filename." | |
342 | 1092 (interactive "P") |
799 | 1093 (and initialize |
1094 (save-excursion | |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1095 ;; Visit the tags table buffer to get its list of files. |
1149 | 1096 (visit-tags-table-buffer) |
799 | 1097 (setq next-file-list (tags-table-files)))) |
342 | 1098 (or next-file-list |
799 | 1099 (save-excursion |
1397
d469afe703c4
(visit-tags-table-buffer): When trying to pick table, call
Roland McGrath <roland@gnu.org>
parents:
1156
diff
changeset
|
1100 ;; Get the files from the next tags table. |
1152 | 1101 ;; When doing (visit-tags-table-buffer t), |
799 | 1102 ;; the tags table buffer must be current. |
1103 (if (and (visit-tags-table-buffer 'same) | |
1104 (visit-tags-table-buffer t)) | |
1105 (setq next-file-list (tags-table-files)) | |
1106 (and novisit | |
1107 (get-buffer " *next-file*") | |
1108 (kill-buffer " *next-file*")) | |
1109 (error "All files processed.")))) | |
1110 (let ((new (not (get-file-buffer (car next-file-list))))) | |
1111 (if (not (and new novisit)) | |
1112 (set-buffer (find-file-noselect (car next-file-list) novisit)) | |
1113 ;; Like find-file, but avoids random warning messages. | |
1114 (set-buffer (get-buffer-create " *next-file*")) | |
1115 (kill-all-local-variables) | |
1116 (erase-buffer) | |
1117 (setq new (car next-file-list)) | |
1118 (insert-file-contents new nil)) | |
1119 (setq next-file-list (cdr next-file-list)) | |
1120 new)) | |
342 | 1121 |
799 | 1122 (defvar tags-loop-operate nil |
1123 "Form for `tags-loop-continue' to eval to change one file.") | |
1124 | |
1808
60685747963c
(tags-loop-scan): Set default value to an error form.
Roland McGrath <roland@gnu.org>
parents:
1807
diff
changeset
|
1125 (defvar tags-loop-scan |
60685747963c
(tags-loop-scan): Set default value to an error form.
Roland McGrath <roland@gnu.org>
parents:
1807
diff
changeset
|
1126 '(error (substitute-command-keys |
60685747963c
(tags-loop-scan): Set default value to an error form.
Roland McGrath <roland@gnu.org>
parents:
1807
diff
changeset
|
1127 "No \\[tags-search] or \\[tags-query-replace] in progress.")) |
799 | 1128 "Form for `tags-loop-continue' to eval to scan one file. |
1129 If it returns non-nil, this file needs processing by evalling | |
1130 \`tags-loop-operate'. Otherwise, move on to the next file.") | |
342 | 1131 |
360 | 1132 ;;;###autoload |
342 | 1133 (defun tags-loop-continue (&optional first-time) |
1134 "Continue last \\[tags-search] or \\[tags-query-replace] command. | |
799 | 1135 Used noninteractively with non-nil argument to begin such a command. |
1136 Two variables control the processing we do on each file: | |
1137 the value of `tags-loop-scan' is a form to be executed on each file | |
1138 to see if it is interesting (it returns non-nil if so) | |
1139 and `tags-loop-operate' is a form to execute to operate on an interesting file | |
1140 If the latter returns non-nil, we exit; otherwise we scan the next file." | |
342 | 1141 (interactive) |
799 | 1142 (let (new |
1143 (messaged nil)) | |
1144 (while | |
1145 (progn | |
1146 ;; Scan files quickly for the first or next interesting one. | |
1147 (while (or first-time | |
1148 (save-restriction | |
1149 (widen) | |
1150 (not (eval tags-loop-scan)))) | |
1151 (setq new (next-file first-time t)) | |
1152 ;; If NEW is non-nil, we got a temp buffer, | |
1153 ;; and NEW is the file name. | |
1154 (if (or messaged | |
1155 (and (not first-time) | |
1156 (> baud-rate search-slow-speed) | |
1157 (setq messaged t))) | |
1158 (message "Scanning file %s..." (or new buffer-file-name))) | |
1159 (setq first-time nil) | |
1160 (goto-char (point-min))) | |
1161 | |
1162 ;; If we visited it in a temp buffer, visit it now for real. | |
1163 (if new | |
1164 (let ((pos (point))) | |
1165 (erase-buffer) | |
1166 (set-buffer (find-file-noselect new)) | |
1167 (widen) | |
1168 (goto-char pos))) | |
1169 | |
1170 (switch-to-buffer (current-buffer)) | |
1171 | |
1172 ;; Now operate on the file. | |
1173 ;; If value is non-nil, continue to scan the next file. | |
1174 (eval tags-loop-operate))) | |
1175 (and messaged | |
1176 (null tags-loop-operate) | |
1177 (message "Scanning file %s...found" buffer-file-name)))) | |
1178 ;;;###autoload (define-key esc-map "," 'tags-loop-continue) | |
342 | 1179 |
360 | 1180 ;;;###autoload |
342 | 1181 (defun tags-search (regexp) |
799 | 1182 "Search through all files listed in tags table for match for REGEXP. |
342 | 1183 Stops when a match is found. |
1184 To continue searching for next match, use command \\[tags-loop-continue]. | |
1185 | |
799 | 1186 See documentation of variable `tags-file-name'." |
342 | 1187 (interactive "sTags search (regexp): ") |
1188 (if (and (equal regexp "") | |
799 | 1189 (eq (car tags-loop-scan) 're-search-forward) |
1696
cceb5375ce40
Many comments added and docstrings fixed.
Roland McGrath <roland@gnu.org>
parents:
1555
diff
changeset
|
1190 (null tags-loop-operate)) |
799 | 1191 ;; Continue last tags-search as if by M-,. |
342 | 1192 (tags-loop-continue nil) |
799 | 1193 (setq tags-loop-scan |
1194 (list 're-search-forward regexp nil t) | |
1195 tags-loop-operate nil) | |
342 | 1196 (tags-loop-continue t))) |
1197 | |
360 | 1198 ;;;###autoload |
342 | 1199 (defun tags-query-replace (from to &optional delimited) |
799 | 1200 "Query-replace-regexp FROM with TO through all files listed in tags table. |
342 | 1201 Third arg DELIMITED (prefix arg) means replace only word-delimited matches. |
799 | 1202 If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace |
342 | 1203 with the command \\[tags-loop-continue]. |
1204 | |
799 | 1205 See documentation of variable `tags-file-name'." |
1206 (interactive | |
1207 "sTags query replace (regexp): \nsTags query replace %s by: \nP") | |
804 | 1208 (setq tags-loop-scan (list 'prog1 |
1816 | 1209 (list 'if (list 're-search-forward from nil t) |
804 | 1210 ;; When we find a match, move back |
1211 ;; to the beginning of it so perform-replace | |
1212 ;; will see it. | |
1213 '(goto-char (match-beginning 0)))) | |
799 | 1214 tags-loop-operate (list 'perform-replace from to t t delimited)) |
342 | 1215 (tags-loop-continue t)) |
799 | 1216 |
1217 ;;;###autoload | |
1218 (defun list-tags (file) | |
1219 "Display list of tags in file FILE. | |
1220 FILE should not contain a directory specification | |
1221 unless it has one in the tags table." | |
1222 (interactive (list (completing-read "List tags in file: " nil | |
1223 'tags-table-files t nil))) | |
1224 (with-output-to-temp-buffer "*Tags List*" | |
1225 (princ "Tags in file ") | |
1226 (princ file) | |
1227 (terpri) | |
1228 (save-excursion | |
1229 (let ((first-time t) | |
1230 (gotany nil)) | |
1149 | 1231 (while (visit-tags-table-buffer (not first-time)) |
799 | 1232 (if (funcall list-tags-function file) |
1233 (setq gotany t))) | |
1234 (or gotany | |
1235 (error "File %s not in current tags tables")))))) | |
342 | 1236 |
360 | 1237 ;;;###autoload |
799 | 1238 (defun tags-apropos (regexp) |
1239 "Display list of all tags in tags table REGEXP matches." | |
1240 (interactive "sTags apropos (regexp): ") | |
342 | 1241 (with-output-to-temp-buffer "*Tags List*" |
799 | 1242 (princ "Tags matching regexp ") |
1243 (prin1 regexp) | |
342 | 1244 (terpri) |
1245 (save-excursion | |
1149 | 1246 (let ((first-time t)) |
1247 (while (visit-tags-table-buffer (not first-time)) | |
1248 (setq first-time nil) | |
1151 | 1249 (funcall tags-apropos-function regexp)))))) |
799 | 1250 |
1251 ;;; XXX Kludge interface. | |
342 | 1252 |
799 | 1253 ;; XXX If a file is in multiple tables, selection may get the wrong one. |
804 | 1254 ;;;###autoload |
799 | 1255 (defun select-tags-table () |
1256 "Select a tags table file from a menu of those you have already used. | |
1257 The list of tags tables to select from is stored in `tags-table-file-list'; | |
1258 see the doc of that variable if you want to add names to the list." | |
1259 (interactive) | |
1260 (pop-to-buffer "*Tags Table List*") | |
1261 (setq buffer-read-only nil) | |
1262 (erase-buffer) | |
1263 (setq selective-display t | |
1264 selective-display-ellipses nil) | |
1265 (let ((set-list tags-table-set-list) | |
1266 (desired-point nil)) | |
1267 (if tags-table-list | |
1268 (progn | |
1269 (setq desired-point (point-marker)) | |
1270 (princ tags-table-list (current-buffer)) | |
1271 (insert "\C-m") | |
1272 (prin1 (car tags-table-list) (current-buffer)) ;invisible | |
1273 (insert "\n"))) | |
1274 (while set-list | |
1275 (if (eq (car set-list) tags-table-list) | |
1276 ;; Already printed it. | |
1277 () | |
1278 (princ (car set-list) (current-buffer)) | |
1279 (insert "\C-m") | |
1280 (prin1 (car (car set-list)) (current-buffer)) ;invisible | |
1281 (insert "\n")) | |
1282 (setq set-list (cdr set-list))) | |
1283 (if tags-file-name | |
1284 (progn | |
1285 (or desired-point | |
1286 (setq desired-point (point-marker))) | |
1287 (insert tags-file-name "\C-m") | |
1288 (prin1 tags-file-name (current-buffer)) ;invisible | |
1289 (insert "\n"))) | |
1290 (setq set-list (delete tags-file-name | |
1291 (apply 'nconc (cons tags-table-list | |
1292 (mapcar 'copy-sequence | |
1293 tags-table-set-list))))) | |
1294 (while set-list | |
1295 (insert (car set-list) "\C-m") | |
1296 (prin1 (car set-list) (current-buffer)) ;invisible | |
1297 (insert "\n") | |
1298 (setq set-list (delete (car set-list) set-list))) | |
1299 (goto-char 1) | |
1300 (insert-before-markers | |
1301 "Type `t' to select a tags table or set of tags tables:\n\n") | |
1302 (if desired-point | |
1303 (goto-char desired-point)) | |
1304 (set-window-start (selected-window) 1 t)) | |
1305 (set-buffer-modified-p nil) | |
1306 (setq buffer-read-only t | |
1307 mode-name "Select Tags Table") | |
1308 (let ((map (make-sparse-keymap))) | |
1309 (define-key map "t" 'select-tags-table-select) | |
1310 (define-key map " " 'next-line) | |
1311 (define-key map "\^?" 'previous-line) | |
1312 (define-key map "n" 'next-line) | |
1313 (define-key map "p" 'previous-line) | |
1314 (define-key map "q" 'select-tags-table-quit) | |
1315 (use-local-map map))) | |
1316 | |
1317 (defun select-tags-table-select () | |
1318 "Select the tags table named on this line." | |
1319 (interactive) | |
1320 (search-forward "\C-m") | |
1321 (let ((name (read (current-buffer)))) | |
1322 (visit-tags-table name) | |
1323 (select-tags-table-quit) | |
1324 (message "Tags table now %s" name))) | |
1325 | |
1326 (defun select-tags-table-quit () | |
1327 "Kill the buffer and delete the selected window." | |
1328 (interactive) | |
1329 (kill-buffer (current-buffer)) | |
1330 (or (one-window-p) | |
1331 (delete-window))) | |
1332 | |
360 | 1333 ;;;###autoload |
799 | 1334 (defun complete-tag () |
1335 "Perform tags completion on the text around point. | |
1336 Completes to the set of names listed in the current tags table. | |
1337 The string to complete is chosen in the same way as the default | |
981 | 1338 for \\[find-tag] (which see)." |
799 | 1339 (interactive) |
981 | 1340 (or tags-table-list |
1341 tags-file-name | |
1342 (error (substitute-command-keys | |
1343 "No tags table loaded. Try \\[visit-tags-table]."))) | |
799 | 1344 (let ((pattern (funcall (or find-tag-default-function |
1345 (get major-mode 'find-tag-default-function) | |
1346 'find-tag-default))) | |
1347 beg | |
1348 completion) | |
1349 (or pattern | |
1350 (error "Nothing to complete")) | |
1351 (search-backward pattern) | |
1352 (setq beg (point)) | |
1353 (forward-char (length pattern)) | |
1354 (setq completion (try-completion pattern 'tags-complete-tag nil)) | |
1355 (cond ((eq completion t)) | |
1356 ((null completion) | |
1357 (message "Can't find completion for \"%s\"" pattern) | |
1358 (ding)) | |
1359 ((not (string= pattern completion)) | |
1360 (delete-region beg (point)) | |
1361 (insert completion)) | |
1362 (t | |
1363 (message "Making completion list...") | |
1364 (with-output-to-temp-buffer " *Completions*" | |
1365 (display-completion-list | |
1366 (all-completions pattern 'tags-complete-tag nil))) | |
1367 (message "Making completion list...%s" "done"))))) | |
884 | 1368 |
1369 ;;;###autoload (define-key esc-map "\t" 'complete-tag) | |
799 | 1370 |
584 | 1371 (provide 'etags) |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
1372 |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
1373 ;;; etags.el ends here |