Commit | Line | Data |
---|---|---|
c8472948 | 1 | ;;; etags.el --- etags facility for Emacs |
8c8f9bc1 | 2 | |
95df8112 GM |
3 | ;; Copyright (C) 1985-1986, 1988-1989, 1992-1996, 1998, 2000-2011 |
4 | ;; Free Software Foundation, Inc. | |
ff1f0fa6 | 5 | |
5762abec | 6 | ;; Author: Roland McGrath <roland@gnu.org> |
d6b8c85b | 7 | ;; Maintainer: FSF |
3a801d0c ER |
8 | ;; Keywords: tools |
9 | ||
ff1f0fa6 JB |
10 | ;; This file is part of GNU Emacs. |
11 | ||
b1fc2b50 | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
ff1f0fa6 | 13 | ;; it under the terms of the GNU General Public License as published by |
b1fc2b50 GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
ff1f0fa6 JB |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b1fc2b50 | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
ff1f0fa6 | 24 | |
6010664f SM |
25 | ;;; Commentary: |
26 | ||
e5167999 ER |
27 | ;;; Code: |
28 | ||
f0d732ae AS |
29 | (eval-when-compile |
30 | (require 'cl)) | |
b533f3c5 | 31 | (require 'ring) |
89228b63 | 32 | (require 'button) |
b533f3c5 | 33 | |
c086701a | 34 | ;;;###autoload |
b6176f64 RM |
35 | (defvar tags-file-name nil |
36 | "*File name of tags table. | |
9708f7fc | 37 | To switch to a new tags table, setting this variable is sufficient. |
b6176f64 | 38 | If you set this variable, do not also set `tags-table-list'. |
9708f7fc | 39 | Use the `etags' program to make a tags table file.") |
b6176f64 | 40 | ;; Make M-x set-variable tags-file-name like M-x visit-tags-table. |
1e8780b1 | 41 | ;;;###autoload (put 'tags-file-name 'variable-interactive (purecopy "fVisit tags table: ")) |
6f1a6faf | 42 | ;;;###autoload (put 'tags-file-name 'safe-local-variable 'stringp) |
9708f7fc | 43 | |
99730b0e | 44 | (defgroup etags nil "Tags tables." |
99783bde RS |
45 | :group 'tools) |
46 | ||
ece6e35a GM |
47 | ;;;###autoload |
48 | (defcustom tags-case-fold-search 'default | |
49 | "*Whether tags operations should be case-sensitive. | |
50 | A value of t means case-insensitive, a value of nil means case-sensitive. | |
51 | Any other value means use the setting of `case-fold-search'." | |
52 | :group 'etags | |
53 | :type '(choice (const :tag "Case-sensitive" nil) | |
54 | (const :tag "Case-insensitive" t) | |
55 | (other :tag "Use default" default)) | |
56 | :version "21.1") | |
57 | ||
9708f7fc | 58 | ;;;###autoload |
b6176f64 | 59 | ;; Use `visit-tags-table-buffer' to cycle through tags tables in this list. |
99783bde | 60 | (defcustom tags-table-list nil |
b6176f64 RM |
61 | "*List of file names of tags tables to search. |
62 | An element that is a directory means the file \"TAGS\" in that directory. | |
63 | To switch to a new list of tags tables, setting this variable is sufficient. | |
64 | If you set this variable, do not also set `tags-file-name'. | |
99783bde RS |
65 | Use the `etags' program to make a tags table file." |
66 | :group 'etags | |
67 | :type '(repeat file)) | |
9708f7fc | 68 | |
ddc76b00 | 69 | ;;;###autoload |
4c964351 UM |
70 | (defcustom tags-compression-info-list |
71 | (purecopy '("" ".Z" ".bz2" ".gz" ".xz" ".tgz")) | |
ddc76b00 FP |
72 | "*List of extensions tried by etags when jka-compr is used. |
73 | An empty string means search the non-compressed file. | |
74 | These extensions will be tried only if jka-compr was activated | |
1ea98518 SM |
75 | \(i.e. via customize of `auto-compression-mode' or by calling the function |
76 | `auto-compression-mode')." | |
4c964351 | 77 | :version "24.1" ; added xz |
1ea98518 | 78 | :type '(repeat string) |
ddc76b00 FP |
79 | :group 'etags) |
80 | ||
1ea98518 SM |
81 | ;; !!! tags-compression-info-list should probably be replaced by access |
82 | ;; to directory list and matching jka-compr-compression-info-list. Currently, | |
83 | ;; this implementation forces each modification of | |
84 | ;; jka-compr-compression-info-list to be reflected in this var. | |
85 | ;; An alternative could be to say that introducing a special | |
86 | ;; element in this list (e.g. t) means : try at this point | |
87 | ;; using directory listing and regexp matching using | |
88 | ;; jka-compr-compression-info-list. | |
ddc76b00 FP |
89 | |
90 | ||
33633b28 | 91 | ;;;###autoload |
99783bde | 92 | (defcustom tags-add-tables 'ask-user |
0c37b824 RS |
93 | "*Control whether to add a new tags table to the current list. |
94 | t means do; nil means don't (always start a new list). | |
95 | Any other value means ask the user whether to add a new tags table | |
99783bde RS |
96 | to the current list (as opposed to starting a new list)." |
97 | :group 'etags | |
98 | :type '(choice (const :tag "Do" t) | |
99 | (const :tag "Don't" nil) | |
add3e8b3 | 100 | (other :tag "Ask" ask-user))) |
99783bde RS |
101 | |
102 | (defcustom tags-revert-without-query nil | |
103 | "*Non-nil means reread a TAGS table without querying, if it has changed." | |
104 | :group 'etags | |
105 | :type 'boolean) | |
5f8cdaf2 | 106 | |
a3d358c6 RM |
107 | (defvar tags-table-computed-list nil |
108 | "List of tags tables to search, computed from `tags-table-list'. | |
109 | This includes tables implicitly included by other tables. The list is not | |
110 | always complete: the included tables of a table are not known until that | |
6010664f | 111 | table is read into core. An element that is t is a placeholder |
a3d358c6 RM |
112 | indicating that the preceding element is a table that has not been read |
113 | into core and might contain included tables to search. | |
114 | See `tags-table-check-computed-list'.") | |
115 | ||
116 | (defvar tags-table-computed-list-for nil | |
117 | "Value of `tags-table-list' that `tags-table-computed-list' corresponds to. | |
118 | If `tags-table-list' changes, `tags-table-computed-list' is thrown away and | |
119 | recomputed; see `tags-table-check-computed-list'.") | |
120 | ||
9708f7fc | 121 | (defvar tags-table-list-pointer nil |
a3d358c6 | 122 | "Pointer into `tags-table-computed-list' for the current state of searching. |
47f3c459 RM |
123 | Use `visit-tags-table-buffer' to cycle through tags tables in this list.") |
124 | ||
125 | (defvar tags-table-list-started-at nil | |
a3d358c6 | 126 | "Pointer into `tags-table-computed-list', where the current search started.") |
9708f7fc RM |
127 | |
128 | (defvar tags-table-set-list nil | |
129 | "List of sets of tags table which have been used together in the past. | |
130 | Each element is a list of strings which are file names.") | |
131 | ||
132 | ;;;###autoload | |
99783bde | 133 | (defcustom find-tag-hook nil |
9708f7fc RM |
134 | "*Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'. |
135 | The value in the buffer in which \\[find-tag] is done is used, | |
99783bde RS |
136 | not the value in the buffer \\[find-tag] goes to." |
137 | :group 'etags | |
138 | :type 'hook) | |
9708f7fc RM |
139 | |
140 | ;;;###autoload | |
99783bde | 141 | (defcustom find-tag-default-function nil |
47f3c459 RM |
142 | "*A function of no arguments used by \\[find-tag] to pick a default tag. |
143 | If nil, and the symbol that is the value of `major-mode' | |
9708f7fc | 144 | has a `find-tag-default-function' property (see `put'), that is used. |
99783bde RS |
145 | Otherwise, `find-tag-default' is used." |
146 | :group 'etags | |
d639db36 | 147 | :type '(choice (const nil) function)) |
9708f7fc | 148 | |
b533f3c5 RS |
149 | (defcustom find-tag-marker-ring-length 16 |
150 | "*Length of marker rings `find-tag-marker-ring' and `tags-location-ring'." | |
151 | :group 'etags | |
cd32a7ba DN |
152 | :type 'integer |
153 | :version "20.3") | |
b533f3c5 | 154 | |
7e7b42b2 GM |
155 | (defcustom tags-tag-face 'default |
156 | "*Face for tags in the output of `tags-apropos'." | |
157 | :group 'etags | |
158 | :type 'face | |
159 | :version "21.1") | |
160 | ||
161 | (defcustom tags-apropos-verbose nil | |
162 | "If non-nil, print the name of the tags file in the *Tags List* buffer." | |
163 | :group 'etags | |
164 | :type 'boolean | |
165 | :version "21.1") | |
166 | ||
167 | (defcustom tags-apropos-additional-actions nil | |
168 | "Specify additional actions for `tags-apropos'. | |
169 | ||
170 | If non-nil, value should be a list of triples (TITLE FUNCTION | |
171 | TO-SEARCH). For each triple, `tags-apropos' processes TO-SEARCH and | |
172 | lists tags from it. TO-SEARCH should be an alist, obarray, or symbol. | |
173 | If it is a symbol, the symbol's value is used. | |
6010664f | 174 | TITLE, a string, is a title used to label the additional list of tags. |
7e7b42b2 GM |
175 | FUNCTION is a function to call when a symbol is selected in the |
176 | *Tags List* buffer. It will be called with one argument SYMBOL which | |
177 | is the symbol being selected. | |
178 | ||
179 | Example value: | |
180 | ||
181 | '((\"Emacs Lisp\" Info-goto-emacs-command-node obarray) | |
182 | (\"Common Lisp\" common-lisp-hyperspec common-lisp-hyperspec-obarray) | |
183 | (\"SCWM\" scwm-documentation scwm-obarray))" | |
184 | :group 'etags | |
61520f26 DL |
185 | :type '(repeat (list (string :tag "Title") |
186 | function | |
187 | (sexp :tag "Tags to search"))) | |
7e7b42b2 GM |
188 | :version "21.1") |
189 | ||
b533f3c5 RS |
190 | (defvar find-tag-marker-ring (make-ring find-tag-marker-ring-length) |
191 | "Ring of markers which are locations from which \\[find-tag] was invoked.") | |
192 | ||
9708f7fc | 193 | (defvar default-tags-table-function nil |
5f8cdaf2 RS |
194 | "If non-nil, a function to choose a default tags file for a buffer. |
195 | This function receives no arguments and should return the default | |
196 | tags table file to use for the current buffer.") | |
d74e816f | 197 | |
b533f3c5 RS |
198 | (defvar tags-location-ring (make-ring find-tag-marker-ring-length) |
199 | "Ring of markers which are locations visited by \\[find-tag]. | |
d74e816f | 200 | Pop back to the last location with \\[negative-argument] \\[find-tag].") |
9708f7fc RM |
201 | \f |
202 | ;; Tags table state. | |
203 | ;; These variables are local in tags table buffers. | |
ff1f0fa6 | 204 | |
9708f7fc RM |
205 | (defvar tags-table-files nil |
206 | "List of file names covered by current tags table. | |
207 | nil means it has not yet been computed; use `tags-table-files' to do so.") | |
208 | ||
209 | (defvar tags-completion-table nil | |
7e7b42b2 | 210 | "Obarray of tag names defined in current tags table.") |
9708f7fc RM |
211 | |
212 | (defvar tags-included-tables nil | |
213 | "List of tags tables included by the current tags table.") | |
214 | ||
215 | (defvar next-file-list nil | |
216 | "List of files for \\[next-file] to process.") | |
217 | \f | |
218 | ;; Hooks for file formats. | |
219 | ||
d6b8c85b SM |
220 | (defvar tags-table-format-functions '(etags-recognize-tags-table |
221 | tags-recognize-empty-tags-table) | |
6010664f | 222 | "Hook to be called in a tags table buffer to identify the type of tags table. |
b533f3c5 | 223 | The functions are called in order, with no arguments, |
9708f7fc RM |
224 | until one returns non-nil. The function should make buffer-local bindings |
225 | of the format-parsing tags function variables if successful.") | |
226 | ||
227 | (defvar file-of-tag-function nil | |
79e01623 JB |
228 | "Function to do the work of `file-of-tag' (which see). |
229 | One optional argument, a boolean specifying to return complete path (nil) or | |
230 | relative path (non-nil).") | |
9708f7fc RM |
231 | (defvar tags-table-files-function nil |
232 | "Function to do the work of `tags-table-files' (which see).") | |
233 | (defvar tags-completion-table-function nil | |
6010664f | 234 | "Function to build the `tags-completion-table'.") |
9708f7fc | 235 | (defvar snarf-tag-function nil |
79e01623 JB |
236 | "Function to get info about a matched tag for `goto-tag-location-function'. |
237 | One optional argument, specifying to use explicit tag (non-nil) or not (nil). | |
238 | The default is nil.") | |
9708f7fc RM |
239 | (defvar goto-tag-location-function nil |
240 | "Function of to go to the location in the buffer specified by a tag. | |
241 | One argument, the tag info returned by `snarf-tag-function'.") | |
242 | (defvar find-tag-regexp-search-function nil | |
243 | "Search function passed to `find-tag-in-order' for finding a regexp tag.") | |
244 | (defvar find-tag-regexp-tag-order nil | |
245 | "Tag order passed to `find-tag-in-order' for finding a regexp tag.") | |
246 | (defvar find-tag-regexp-next-line-after-failure-p nil | |
247 | "Flag passed to `find-tag-in-order' for finding a regexp tag.") | |
248 | (defvar find-tag-search-function nil | |
249 | "Search function passed to `find-tag-in-order' for finding a tag.") | |
250 | (defvar find-tag-tag-order nil | |
251 | "Tag order passed to `find-tag-in-order' for finding a tag.") | |
252 | (defvar find-tag-next-line-after-failure-p nil | |
253 | "Flag passed to `find-tag-in-order' for finding a tag.") | |
254 | (defvar list-tags-function nil | |
255 | "Function to do the work of `list-tags' (which see).") | |
256 | (defvar tags-apropos-function nil | |
257 | "Function to do the work of `tags-apropos' (which see).") | |
258 | (defvar tags-included-tables-function nil | |
259 | "Function to do the work of `tags-included-tables' (which see).") | |
260 | (defvar verify-tags-table-function nil | |
e7f767c2 | 261 | "Function to return t if current buffer contains valid tags file.") |
9708f7fc RM |
262 | \f |
263 | (defun initialize-new-tags-table () | |
cba9bdd2 RS |
264 | "Initialize the tags table in the current buffer. |
265 | Return non-nil if it is a valid tags table, and | |
e02f48d7 | 266 | in that case, also make the tags table state variables |
cba9bdd2 | 267 | buffer-local and set them to nil." |
b6176f64 RM |
268 | (set (make-local-variable 'tags-table-files) nil) |
269 | (set (make-local-variable 'tags-completion-table) nil) | |
270 | (set (make-local-variable 'tags-included-tables) nil) | |
931f525c RS |
271 | ;; We used to initialize find-tag-marker-ring and tags-location-ring |
272 | ;; here, to new empty rings. But that is wrong, because those | |
273 | ;; are global. | |
274 | ||
9708f7fc | 275 | ;; Value is t if we have found a valid tags table buffer. |
d6b8c85b | 276 | (run-hook-with-args-until-success 'tags-table-format-functions)) |
ff1f0fa6 | 277 | |
0f518b6b JL |
278 | ;;;###autoload |
279 | (defun tags-table-mode () | |
280 | "Major mode for tags table file buffers." | |
281 | (interactive) | |
175069ef | 282 | (setq major-mode 'tags-table-mode ;FIXME: Use define-derived-mode. |
5ec19a11 | 283 | mode-name "Tags Table" |
8e004a44 | 284 | buffer-undo-list t) |
0f518b6b JL |
285 | (initialize-new-tags-table)) |
286 | ||
c086701a | 287 | ;;;###autoload |
9708f7fc RM |
288 | (defun visit-tags-table (file &optional local) |
289 | "Tell tags commands to use tags table file FILE. | |
ff1f0fa6 | 290 | FILE should be the name of a file created with the `etags' program. |
9708f7fc RM |
291 | A directory name is ok too; it means file TAGS in that directory. |
292 | ||
293 | Normally \\[visit-tags-table] sets the global value of `tags-file-name'. | |
294 | With a prefix arg, set the buffer-local value instead. | |
295 | When you find a tag with \\[find-tag], the buffer it finds the tag | |
296 | in is given a local value of this variable which is the name of the tags | |
297 | file the tag was in." | |
5b76833f | 298 | (interactive (list (read-file-name "Visit tags table (default TAGS): " |
ff1f0fa6 | 299 | default-directory |
9708f7fc RM |
300 | (expand-file-name "TAGS" |
301 | default-directory) | |
302 | t) | |
303 | current-prefix-arg)) | |
aab936ad RM |
304 | (or (stringp file) (signal 'wrong-type-argument (list 'stringp file))) |
305 | ;; Bind tags-file-name so we can control below whether the local or | |
dcaaec23 | 306 | ;; global value gets set. |
5e882a6a RS |
307 | ;; Calling visit-tags-table-buffer with tags-file-name set to FILE will |
308 | ;; initialize a buffer for FILE and set tags-file-name to the | |
b6176f64 | 309 | ;; fully-expanded name. |
9806213d RM |
310 | (let ((tags-file-name file)) |
311 | (save-excursion | |
aab936ad | 312 | (or (visit-tags-table-buffer file) |
9806213d RM |
313 | (signal 'file-error (list "Visiting tags table" |
314 | "file does not exist" | |
315 | file))) | |
b6176f64 | 316 | ;; Set FILE to the expanded name. |
9806213d | 317 | (setq file tags-file-name))) |
9708f7fc | 318 | (if local |
b6176f64 | 319 | ;; Set the local value of tags-file-name. |
47f3c459 | 320 | (set (make-local-variable 'tags-file-name) file) |
b6176f64 | 321 | ;; Set the global value of tags-file-name. |
9806213d RM |
322 | (setq-default tags-file-name file))) |
323 | ||
a3d358c6 RM |
324 | (defun tags-table-check-computed-list () |
325 | "Compute `tags-table-computed-list' from `tags-table-list' if necessary." | |
326 | (let ((expanded-list (mapcar 'tags-expand-table-name tags-table-list))) | |
327 | (or (equal tags-table-computed-list-for expanded-list) | |
328 | ;; The list (or default-directory) has changed since last computed. | |
329 | (let* ((compute-for (mapcar 'copy-sequence expanded-list)) | |
330 | (tables (copy-sequence compute-for)) ;Mutated in the loop. | |
331 | (computed nil) | |
332 | table-buffer) | |
333 | ||
334 | (while tables | |
335 | (setq computed (cons (car tables) computed) | |
336 | table-buffer (get-file-buffer (car tables))) | |
83287e5b | 337 | (if (and table-buffer |
c49a777a RM |
338 | ;; There is a buffer visiting the file. Now make sure |
339 | ;; it is initialized as a tag table buffer. | |
340 | (save-excursion | |
341 | (tags-verify-table (buffer-file-name table-buffer)))) | |
dcaaec23 | 342 | (with-current-buffer table-buffer |
a3d358c6 RM |
343 | (if (tags-included-tables) |
344 | ;; Insert the included tables into the list we | |
345 | ;; are processing. | |
b1c7e434 RM |
346 | (setcdr tables (nconc (mapcar 'tags-expand-table-name |
347 | (tags-included-tables)) | |
348 | (cdr tables))))) | |
a3d358c6 RM |
349 | ;; This table is not in core yet. Insert a placeholder |
350 | ;; saying we must read it into core to check for included | |
351 | ;; tables before searching the next table in the list. | |
352 | (setq computed (cons t computed))) | |
353 | (setq tables (cdr tables))) | |
354 | ||
355 | ;; Record the tags-table-list value (and the context of the | |
356 | ;; current directory) we computed from. | |
357 | (setq tags-table-computed-list-for compute-for | |
358 | tags-table-computed-list (nreverse computed)))))) | |
359 | ||
a3d358c6 | 360 | (defun tags-table-extend-computed-list () |
cba9bdd2 RS |
361 | "Extend `tags-table-computed-list' to remove the first t placeholder. |
362 | ||
363 | An element of the list that is t is a placeholder indicating that the | |
364 | preceding element is a table that has not been read in and might | |
365 | contain included tables to search. This function reads in the first | |
366 | such table and puts its included tables into the list." | |
a3d358c6 RM |
367 | (let ((list tags-table-computed-list)) |
368 | (while (not (eq (nth 1 list) t)) | |
369 | (setq list (cdr list))) | |
370 | (save-excursion | |
371 | (if (tags-verify-table (car list)) | |
372 | ;; We are now in the buffer visiting (car LIST). Extract its | |
373 | ;; list of included tables and insert it into the computed list. | |
374 | (let ((tables (tags-included-tables)) | |
375 | (computed nil) | |
376 | table-buffer) | |
377 | (while tables | |
378 | (setq computed (cons (car tables) computed) | |
379 | table-buffer (get-file-buffer (car tables))) | |
380 | (if table-buffer | |
dcaaec23 | 381 | (with-current-buffer table-buffer |
a3d358c6 RM |
382 | (if (tags-included-tables) |
383 | ;; Insert the included tables into the list we | |
384 | ;; are processing. | |
385 | (setcdr tables (append (tags-included-tables) | |
386 | tables)))) | |
387 | ;; This table is not in core yet. Insert a placeholder | |
388 | ;; saying we must read it into core to check for included | |
389 | ;; tables before searching the next table in the list. | |
e99045bb RM |
390 | (setq computed (cons t computed))) |
391 | (setq tables (cdr tables))) | |
a3d358c6 RM |
392 | (setq computed (nreverse computed)) |
393 | ;; COMPUTED now contains the list of included tables (and | |
394 | ;; tables included by them, etc.). Now splice this into the | |
395 | ;; current list. | |
396 | (setcdr list (nconc computed (cdr (cdr list))))) | |
397 | ;; It was not a valid table, so just remove the following placeholder. | |
398 | (setcdr list (cdr (cdr list))))))) | |
b6176f64 | 399 | |
47f3c459 | 400 | (defun tags-expand-table-name (file) |
cba9bdd2 | 401 | "Expand tags table name FILE into a complete file name." |
47f3c459 RM |
402 | (setq file (expand-file-name file)) |
403 | (if (file-directory-p file) | |
404 | (expand-file-name "TAGS" file) | |
405 | file)) | |
406 | ||
a3d358c6 RM |
407 | ;; Like member, but comparison is done after tags-expand-table-name on both |
408 | ;; sides and elements of LIST that are t are skipped. | |
409 | (defun tags-table-list-member (file list) | |
cba9bdd2 RS |
410 | "Like (member FILE LIST) after applying `tags-expand-table-name'. |
411 | More precisely, apply `tags-expand-table-name' to FILE | |
412 | and each element of LIST, returning the link whose car is the first match. | |
413 | If an element of LIST is t, ignore it." | |
47f3c459 | 414 | (setq file (tags-expand-table-name file)) |
a3d358c6 RM |
415 | (while (and list |
416 | (or (eq (car list) t) | |
417 | (not (string= file (tags-expand-table-name (car list)))))) | |
418 | (setq list (cdr list))) | |
47f3c459 RM |
419 | list) |
420 | ||
a3d358c6 RM |
421 | (defun tags-verify-table (file) |
422 | "Read FILE into a buffer and verify that it is a valid tags table. | |
423 | Sets the current buffer to one visiting FILE (if it exists). | |
e7f767c2 | 424 | Returns non-nil if it is a valid table." |
a3d358c6 RM |
425 | (if (get-file-buffer file) |
426 | ;; The file is already in a buffer. Check for the visited file | |
427 | ;; having changed since we last used it. | |
8c0bf8b3 | 428 | (progn |
a3d358c6 | 429 | (set-buffer (get-file-buffer file)) |
8c0bf8b3 | 430 | (or verify-tags-table-function (tags-table-mode)) |
a3d358c6 | 431 | (if (or (verify-visited-file-modtime (current-buffer)) |
350ce4cf RS |
432 | ;; Decide whether to revert the file. |
433 | ;; revert-without-query can say to revert | |
434 | ;; or the user can say to revert. | |
435 | (not (or (let ((tail revert-without-query) | |
436 | (found nil)) | |
437 | (while tail | |
438 | (if (string-match (car tail) buffer-file-name) | |
439 | (setq found t)) | |
440 | (setq tail (cdr tail))) | |
441 | found) | |
99783bde | 442 | tags-revert-without-query |
350ce4cf RS |
443 | (yes-or-no-p |
444 | (format "Tags file %s has changed, read new contents? " | |
445 | file))))) | |
446 | (and verify-tags-table-function | |
447 | (funcall verify-tags-table-function)) | |
a3d358c6 | 448 | (revert-buffer t t) |
0f518b6b | 449 | (tags-table-mode))) |
dcaaec23 SM |
450 | (when (file-exists-p file) |
451 | (let* ((buf (find-file-noselect file)) | |
452 | (newfile (buffer-file-name buf))) | |
453 | (unless (string= file newfile) | |
454 | ;; find-file-noselect has changed the file name. | |
455 | ;; Propagate the change to tags-file-name and tags-table-list. | |
456 | (let ((tail (member file tags-table-list))) | |
457 | (if tail (setcar tail newfile))) | |
458 | (if (eq file tags-file-name) (setq tags-file-name newfile))) | |
459 | ;; Only change buffer now that we're done using potentially | |
460 | ;; buffer-local variables. | |
461 | (set-buffer buf) | |
462 | (tags-table-mode))))) | |
a3d358c6 RM |
463 | |
464 | ;; Subroutine of visit-tags-table-buffer. Search the current tags tables | |
465 | ;; for one that has tags for THIS-FILE (or that includes a table that | |
c3dea9ba RM |
466 | ;; does). Return the name of the first table table listing THIS-FILE; if |
467 | ;; the table is one included by another table, it is the master table that | |
468 | ;; we return. If CORE-ONLY is non-nil, check only tags tables that are | |
469 | ;; already in buffers--don't visit any new files. | |
a3d358c6 | 470 | (defun tags-table-including (this-file core-only) |
cba9bdd2 RS |
471 | "Search current tags tables for tags for THIS-FILE. |
472 | Subroutine of `visit-tags-table-buffer'. | |
473 | Looks for a tags table that has such tags or that includes a table | |
474 | that has them. Returns the name of the first such table. | |
475 | Non-nil CORE-ONLY means check only tags tables that are already in | |
40b1a3a9 | 476 | buffers. If CORE-ONLY is nil, it is ignored." |
a3d358c6 | 477 | (let ((tables tags-table-computed-list) |
f06df563 | 478 | (found nil)) |
a3d358c6 | 479 | ;; Loop over the list, looking for a table containing tags for THIS-FILE. |
47f3c459 RM |
480 | (while (and (not found) |
481 | tables) | |
9d591df8 RM |
482 | |
483 | (if core-only | |
484 | ;; Skip tables not in core. | |
485 | (while (eq (nth 1 tables) t) | |
486 | (setq tables (cdr (cdr tables)))) | |
487 | (if (eq (nth 1 tables) t) | |
488 | ;; This table has not been read into core yet. Read it in now. | |
489 | (tags-table-extend-computed-list))) | |
a3d358c6 | 490 | |
3cc3f703 RM |
491 | (if tables |
492 | ;; Select the tags table buffer and get the file list up to date. | |
493 | (let ((tags-file-name (car tables))) | |
494 | (visit-tags-table-buffer 'same) | |
83287e5b RM |
495 | (if (member this-file (mapcar 'expand-file-name |
496 | (tags-table-files))) | |
3cc3f703 RM |
497 | ;; Found it. |
498 | (setq found tables)))) | |
47f3c459 | 499 | (setq tables (cdr tables))) |
3cc3f703 RM |
500 | (if found |
501 | ;; Now determine if the table we found was one included by another | |
82f75cca RM |
502 | ;; table, not explicitly listed. We do this by checking each |
503 | ;; element of the computed list to see if it appears in the user's | |
504 | ;; explicit list; the last element we will check is FOUND itself. | |
505 | ;; Then we return the last one which did in fact appear in | |
506 | ;; tags-table-list. | |
3cc3f703 RM |
507 | (let ((could-be nil) |
508 | (elt tags-table-computed-list)) | |
509 | (while (not (eq elt (cdr found))) | |
510 | (if (tags-table-list-member (car elt) tags-table-list) | |
511 | ;; This table appears in the user's list, so it could be | |
512 | ;; the one which includes the table we found. | |
82f75cca RM |
513 | (setq could-be (car elt))) |
514 | (setq elt (cdr elt)) | |
515 | (if (eq t (car elt)) | |
516 | (setq elt (cdr elt)))) | |
ec623f1b RM |
517 | ;; The last element we found in the computed list before FOUND |
518 | ;; that appears in the user's list will be the table that | |
83287e5b | 519 | ;; included the one we found. |
82f75cca | 520 | could-be)))) |
9708f7fc | 521 | |
a3d358c6 | 522 | (defun tags-next-table () |
cba9bdd2 RS |
523 | "Move `tags-table-list-pointer' along and set `tags-file-name'. |
524 | Subroutine of `visit-tags-table-buffer'.\ | |
525 | Returns nil when out of tables." | |
a3d358c6 RM |
526 | ;; If there is a placeholder element next, compute the list to replace it. |
527 | (while (eq (nth 1 tags-table-list-pointer) t) | |
528 | (tags-table-extend-computed-list)) | |
529 | ||
530 | ;; Go to the next table in the list. | |
531 | (setq tags-table-list-pointer (cdr tags-table-list-pointer)) | |
532 | (or tags-table-list-pointer | |
533 | ;; Wrap around. | |
534 | (setq tags-table-list-pointer tags-table-computed-list)) | |
535 | ||
536 | (if (eq tags-table-list-pointer tags-table-list-started-at) | |
537 | ;; We have come full circle. No more tables. | |
538 | (setq tags-table-list-pointer nil) | |
539 | ;; Set tags-file-name to the name from the list. It is already expanded. | |
540 | (setq tags-file-name (car tags-table-list-pointer)))) | |
541 | ||
97534f32 | 542 | ;;;###autoload |
9708f7fc RM |
543 | (defun visit-tags-table-buffer (&optional cont) |
544 | "Select the buffer containing the current tags table. | |
aab936ad | 545 | If optional arg is a string, visit that file as a tags table. |
9708f7fc | 546 | If optional arg is t, visit the next table in `tags-table-list'. |
9708f7fc | 547 | If optional arg is the atom `same', don't look for a new table; |
b6176f64 | 548 | just select the buffer visiting `tags-file-name'. |
47f3c459 | 549 | If arg is nil or absent, choose a first buffer from information in |
b6176f64 | 550 | `tags-file-name', `tags-table-list', `tags-table-list-pointer'. |
9708f7fc | 551 | Returns t if it visits a tags table, or nil if there are no more in the list." |
b6176f64 RM |
552 | |
553 | ;; Set tags-file-name to the tags table file we want to visit. | |
a3d358c6 RM |
554 | (cond ((eq cont 'same) |
555 | ;; Use the ambient value of tags-file-name. | |
556 | (or tags-file-name | |
b0b3cce2 KH |
557 | (error "%s" |
558 | (substitute-command-keys | |
4fa15f59 RS |
559 | (concat "No tags table in use; " |
560 | "use \\[visit-tags-table] to select one"))))) | |
a3d358c6 RM |
561 | |
562 | ((eq t cont) | |
563 | ;; Find the next table. | |
564 | (if (tags-next-table) | |
565 | ;; Skip over nonexistent files. | |
566 | (while (and (not (or (get-file-buffer tags-file-name) | |
567 | (file-exists-p tags-file-name))) | |
568 | (tags-next-table))))) | |
569 | ||
570 | (t | |
571 | ;; Pick a table out of our hat. | |
572 | (tags-table-check-computed-list) ;Get it up to date, we might use it. | |
573 | (setq tags-file-name | |
574 | (or | |
575 | ;; If passed a string, use that. | |
576 | (if (stringp cont) | |
577 | (prog1 cont | |
578 | (setq cont nil))) | |
579 | ;; First, try a local variable. | |
580 | (cdr (assq 'tags-file-name (buffer-local-variables))) | |
581 | ;; Second, try a user-specified function to guess. | |
582 | (and default-tags-table-function | |
583 | (funcall default-tags-table-function)) | |
584 | ;; Third, look for a tags table that contains tags for the | |
585 | ;; current buffer's file. If one is found, the lists will | |
586 | ;; be frobnicated, and CONT will be set non-nil so we don't | |
587 | ;; do it below. | |
588 | (and buffer-file-name | |
83287e5b | 589 | (or |
c3dea9ba RM |
590 | ;; First check only tables already in buffers. |
591 | (tags-table-including buffer-file-name t) | |
592 | ;; Since that didn't find any, now do the | |
593 | ;; expensive version: reading new files. | |
594 | (tags-table-including buffer-file-name nil))) | |
a3d358c6 RM |
595 | ;; Fourth, use the user variable tags-file-name, if it is |
596 | ;; not already in the current list. | |
597 | (and tags-file-name | |
598 | (not (tags-table-list-member tags-file-name | |
599 | tags-table-computed-list)) | |
600 | tags-file-name) | |
601 | ;; Fifth, use the user variable giving the table list. | |
602 | ;; Find the first element of the list that actually exists. | |
603 | (let ((list tags-table-list) | |
604 | file) | |
605 | (while (and list | |
606 | (setq file (tags-expand-table-name (car list))) | |
607 | (not (get-file-buffer file)) | |
608 | (not (file-exists-p file))) | |
609 | (setq list (cdr list))) | |
610 | (car list)) | |
611 | ;; Finally, prompt the user for a file name. | |
612 | (expand-file-name | |
5b76833f | 613 | (read-file-name "Visit tags table (default TAGS): " |
a3d358c6 RM |
614 | default-directory |
615 | "TAGS" | |
616 | t)))))) | |
617 | ||
618 | ;; Expand the table name into a full file name. | |
619 | (setq tags-file-name (tags-expand-table-name tags-file-name)) | |
620 | ||
7e7b42b2 | 621 | (unless (and (eq cont t) (null tags-table-list-pointer)) |
a3d358c6 | 622 | ;; Verify that tags-file-name names a valid tags table. |
229b7986 RM |
623 | ;; Bind another variable with the value of tags-file-name |
624 | ;; before we switch buffers, in case tags-file-name is buffer-local. | |
625 | (let ((curbuf (current-buffer)) | |
626 | (local-tags-file-name tags-file-name)) | |
627 | (if (tags-verify-table local-tags-file-name) | |
628 | ||
629 | ;; We have a valid tags table. | |
630 | (progn | |
631 | ;; Bury the tags table buffer so it | |
632 | ;; doesn't get in the user's way. | |
633 | (bury-buffer (current-buffer)) | |
634 | ||
635 | ;; If this was a new table selection (CONT is nil), make | |
636 | ;; sure tags-table-list includes the chosen table, and | |
637 | ;; update the list pointer variables. | |
638 | (or cont | |
639 | ;; Look in the list for the table we chose. | |
640 | (let ((found (tags-table-list-member | |
641 | local-tags-file-name | |
642 | tags-table-computed-list))) | |
643 | (if found | |
644 | ;; There it is. Just switch to it. | |
645 | (setq tags-table-list-pointer found | |
646 | tags-table-list-started-at found) | |
647 | ||
648 | ;; The table is not in the current set. | |
649 | ;; Try to find it in another previously used set. | |
650 | (let ((sets tags-table-set-list)) | |
651 | (while (and sets | |
652 | (not (tags-table-list-member | |
653 | local-tags-file-name | |
654 | (car sets)))) | |
655 | (setq sets (cdr sets))) | |
656 | (if sets | |
657 | ;; Found in some other set. Switch to that set. | |
658 | (progn | |
659 | (or (memq tags-table-list tags-table-set-list) | |
660 | ;; Save the current list. | |
661 | (setq tags-table-set-list | |
662 | (cons tags-table-list | |
663 | tags-table-set-list))) | |
664 | (setq tags-table-list (car sets))) | |
665 | ||
666 | ;; Not found in any existing set. | |
667 | (if (and tags-table-list | |
668 | (or (eq t tags-add-tables) | |
669 | (and tags-add-tables | |
670 | (y-or-n-p | |
671 | (concat "Keep current list of " | |
672 | "tags tables also? "))))) | |
673 | ;; Add it to the current list. | |
674 | (setq tags-table-list (cons local-tags-file-name | |
675 | tags-table-list)) | |
676 | ||
677 | ;; Make a fresh list, and store the old one. | |
678 | (message "Starting a new list of tags tables") | |
679 | (or (null tags-table-list) | |
680 | (memq tags-table-list tags-table-set-list) | |
f06df563 RM |
681 | (setq tags-table-set-list |
682 | (cons tags-table-list | |
683 | tags-table-set-list))) | |
dd2cedb9 DL |
684 | ;; Clear out buffers holding old tables. |
685 | (dolist (table tags-table-list) | |
cba9bdd2 | 686 | ;; The list can contain items t. |
84d51f9b DL |
687 | (if (stringp table) |
688 | (let ((buffer (find-buffer-visiting table))) | |
dd2cedb9 | 689 | (if buffer |
84d51f9b | 690 | (kill-buffer buffer))))) |
229b7986 RM |
691 | (setq tags-table-list (list local-tags-file-name)))) |
692 | ||
693 | ;; Recompute tags-table-computed-list. | |
694 | (tags-table-check-computed-list) | |
695 | ;; Set the tags table list state variables to start | |
696 | ;; over from tags-table-computed-list. | |
697 | (setq tags-table-list-started-at tags-table-computed-list | |
698 | tags-table-list-pointer | |
699 | tags-table-computed-list))))) | |
700 | ||
701 | ;; Return of t says the tags table is valid. | |
702 | t) | |
703 | ||
704 | ;; The buffer was not valid. Don't use it again. | |
705 | (set-buffer curbuf) | |
a3d358c6 | 706 | (kill-local-variable 'tags-file-name) |
229b7986 | 707 | (if (eq local-tags-file-name tags-file-name) |
e98cc0af | 708 | (setq tags-file-name nil)) |
229b7986 | 709 | (error "File %s is not a valid tags table" local-tags-file-name))))) |
c6987f0b RM |
710 | |
711 | (defun tags-reset-tags-tables () | |
b533f3c5 | 712 | "Reset tags state to cancel effect of any previous \\[visit-tags-table] or \\[find-tag]." |
c6987f0b | 713 | (interactive) |
466886a2 KH |
714 | ;; Clear out the markers we are throwing away. |
715 | (let ((i 0)) | |
716 | (while (< i find-tag-marker-ring-length) | |
717 | (if (aref (cddr tags-location-ring) i) | |
718 | (set-marker (aref (cddr tags-location-ring) i) nil)) | |
719 | (if (aref (cddr find-tag-marker-ring) i) | |
720 | (set-marker (aref (cddr find-tag-marker-ring) i) nil)) | |
721 | (setq i (1+ i)))) | |
c6987f0b | 722 | (setq tags-file-name nil |
466886a2 KH |
723 | tags-location-ring (make-ring find-tag-marker-ring-length) |
724 | find-tag-marker-ring (make-ring find-tag-marker-ring-length) | |
c6987f0b RM |
725 | tags-table-list nil |
726 | tags-table-computed-list nil | |
727 | tags-table-computed-list-for nil | |
728 | tags-table-list-pointer nil | |
729 | tags-table-list-started-at nil | |
730 | tags-table-set-list nil)) | |
a128c7a0 | 731 | \f |
79e01623 | 732 | (defun file-of-tag (&optional relative) |
ff1f0fa6 | 733 | "Return the file name of the file whose tags point is within. |
9708f7fc | 734 | Assumes the tags table is the current buffer. |
79e01623 JB |
735 | If RELATIVE is non-nil, file name returned is relative to tags |
736 | table file's directory. If RELATIVE is nil, file name returned | |
737 | is complete." | |
738 | (funcall file-of-tag-function relative)) | |
ff1f0fa6 | 739 | |
c086701a | 740 | ;;;###autoload |
9708f7fc RM |
741 | (defun tags-table-files () |
742 | "Return a list of files in the current tags table. | |
83287e5b RM |
743 | Assumes the tags table is the current buffer. The file names are returned |
744 | as they appeared in the `etags' command that created the table, usually | |
745 | without directory names." | |
a128c7a0 RM |
746 | (or tags-table-files |
747 | (setq tags-table-files | |
748 | (funcall tags-table-files-function)))) | |
9708f7fc RM |
749 | |
750 | (defun tags-included-tables () | |
b6176f64 RM |
751 | "Return a list of tags tables included by the current table. |
752 | Assumes the tags table is the current buffer." | |
9708f7fc RM |
753 | (or tags-included-tables |
754 | (setq tags-included-tables (funcall tags-included-tables-function)))) | |
755 | \f | |
9708f7fc | 756 | (defun tags-completion-table () |
cba9bdd2 RS |
757 | "Build `tags-completion-table' on demand. |
758 | The tags included in the completion table are those in the current | |
759 | tags table and its (recursively) included tags tables." | |
9708f7fc | 760 | (or tags-completion-table |
f37de644 | 761 | ;; No cached value for this buffer. |
9708f7fc | 762 | (condition-case () |
f37de644 FP |
763 | (let (current-table combined-table) |
764 | (message "Making tags completion table for %s..." buffer-file-name) | |
765 | (save-excursion | |
766 | ;; Iterate over the current list of tags tables. | |
767 | (while (visit-tags-table-buffer (and combined-table t)) | |
768 | ;; Find possible completions in this table. | |
769 | (setq current-table (funcall tags-completion-table-function)) | |
770 | ;; Merge this buffer's completions into the combined table. | |
771 | (if combined-table | |
772 | (mapatoms | |
773 | (lambda (sym) (intern (symbol-name sym) combined-table)) | |
774 | current-table) | |
775 | (setq combined-table current-table)))) | |
776 | (message "Making tags completion table for %s...done" | |
777 | buffer-file-name) | |
f0d732ae | 778 | ;; Cache the result in a buffer-local variable. |
f37de644 | 779 | (setq tags-completion-table combined-table)) |
9708f7fc RM |
780 | (quit (message "Tags completion table construction aborted.") |
781 | (setq tags-completion-table nil))))) | |
782 | ||
b5507bc1 SM |
783 | (defun tags-lazy-completion-table () |
784 | (lexical-let ((buf (current-buffer))) | |
785 | (lambda (string pred action) | |
786 | (with-current-buffer buf | |
787 | (save-excursion | |
788 | ;; If we need to ask for the tag table, allow that. | |
789 | (let ((enable-recursive-minibuffers t)) | |
790 | (visit-tags-table-buffer)) | |
791 | (complete-with-action action (tags-completion-table) string pred)))))) | |
8c0bf8b3 SM |
792 | |
793 | ;;;###autoload (defun tags-completion-at-point-function () | |
794 | ;;;###autoload (if (or tags-table-list tags-file-name) | |
795 | ;;;###autoload (progn | |
796 | ;;;###autoload (load "etags") | |
797 | ;;;###autoload (tags-completion-at-point-function)))) | |
798 | ||
799 | (defun tags-completion-at-point-function () | |
800 | "Using tags, return a completion table for the text around point. | |
801 | If no tags table is loaded, do nothing and return nil." | |
802 | (when (or tags-table-list tags-file-name) | |
803 | (let ((completion-ignore-case (if (memq tags-case-fold-search '(t nil)) | |
804 | tags-case-fold-search | |
805 | case-fold-search)) | |
806 | (pattern (funcall (or find-tag-default-function | |
807 | (get major-mode 'find-tag-default-function) | |
808 | 'find-tag-default))) | |
809 | beg) | |
810 | (when pattern | |
811 | (save-excursion | |
812 | (search-backward pattern) ;FIXME: will fail if we're inside pattern. | |
813 | (setq beg (point)) | |
814 | (forward-char (length pattern)) | |
0ff8e1ba | 815 | (list beg (point) (tags-lazy-completion-table) :exclusive 'no)))))) |
a128c7a0 | 816 | \f |
ff1f0fa6 | 817 | (defun find-tag-tag (string) |
cba9bdd2 | 818 | "Read a tag name, with defaulting and completion." |
8a294d90 FP |
819 | (let* ((completion-ignore-case (if (memq tags-case-fold-search '(t nil)) |
820 | tags-case-fold-search | |
821 | case-fold-search)) | |
822 | (default (funcall (or find-tag-default-function | |
9708f7fc RM |
823 | (get major-mode 'find-tag-default-function) |
824 | 'find-tag-default))) | |
825 | (spec (completing-read (if default | |
ebc6b37c SM |
826 | (format "%s (default %s): " |
827 | (substring string 0 (string-match "[ :]+\\'" string)) | |
828 | default) | |
9708f7fc | 829 | string) |
b5507bc1 | 830 | (tags-lazy-completion-table) |
ab685b6b | 831 | nil nil nil nil default))) |
b6176f64 RM |
832 | (if (equal spec "") |
833 | (or default (error "There is no default tag")) | |
834 | spec))) | |
ff1f0fa6 | 835 | |
21800cb8 RM |
836 | (defvar last-tag nil |
837 | "Last tag found by \\[find-tag].") | |
838 | ||
d74e816f | 839 | (defun find-tag-interactive (prompt &optional no-default) |
cba9bdd2 RS |
840 | "Get interactive arguments for tag functions. |
841 | The functions using this are `find-tag-noselect', | |
842 | `find-tag-other-window', and `find-tag-regexp'." | |
926861fb | 843 | (if (and current-prefix-arg last-tag) |
d74e816f RM |
844 | (list nil (if (< (prefix-numeric-value current-prefix-arg) 0) |
845 | '- | |
846 | t)) | |
847 | (list (if no-default | |
848 | (read-string prompt) | |
849 | (find-tag-tag prompt))))) | |
850 | ||
cba9bdd2 | 851 | (defvar find-tag-history nil) ; Doc string? |
c5507689 | 852 | |
dd2cedb9 | 853 | ;; Dynamic bondage: |
0d56ae89 GM |
854 | (defvar etags-case-fold-search) |
855 | (defvar etags-syntax-table) | |
e02f48d7 | 856 | (defvar local-find-tag-hook) |
dd2cedb9 | 857 | |
c086701a | 858 | ;;;###autoload |
9708f7fc RM |
859 | (defun find-tag-noselect (tagname &optional next-p regexp-p) |
860 | "Find tag (in current tags table) whose name contains TAGNAME. | |
f90a6155 | 861 | Returns the buffer containing the tag's definition and moves its point there, |
9708f7fc RM |
862 | but does not select the buffer. |
863 | The default for TAGNAME is the expression in the buffer near point. | |
864 | ||
d74e816f RM |
865 | If second arg NEXT-P is t (interactively, with prefix arg), search for |
866 | another tag that matches the last tagname or regexp used. When there are | |
867 | multiple matches for a tag, more exact matches are found first. If NEXT-P | |
868 | is the atom `-' (interactively, with prefix arg that is a negative number | |
869 | or just \\[negative-argument]), pop back to the previous tag gone to. | |
ff1f0fa6 | 870 | |
9708f7fc RM |
871 | If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp. |
872 | ||
a70ea557 | 873 | A marker representing the point when this command is invoked is pushed |
b533f3c5 RS |
874 | onto a ring and may be popped back to with \\[pop-tag-mark]. |
875 | Contrast this with the ring of marks gone to by the command. | |
876 | ||
9708f7fc | 877 | See documentation of variable `tags-file-name'." |
d74e816f RM |
878 | (interactive (find-tag-interactive "Find tag: ")) |
879 | ||
c5507689 | 880 | (setq find-tag-history (cons tagname find-tag-history)) |
e1cf67b6 GM |
881 | ;; Save the current buffer's value of `find-tag-hook' before |
882 | ;; selecting the tags table buffer. For the same reason, save value | |
883 | ;; of `tags-file-name' in case it has a buffer-local value. | |
dc0274bd | 884 | (let ((local-find-tag-hook find-tag-hook)) |
d74e816f RM |
885 | (if (eq '- next-p) |
886 | ;; Pop back to a previous location. | |
b533f3c5 | 887 | (if (ring-empty-p tags-location-ring) |
d74e816f | 888 | (error "No previous tag locations") |
b533f3c5 | 889 | (let ((marker (ring-remove tags-location-ring 0))) |
d74e816f RM |
890 | (prog1 |
891 | ;; Move to the saved location. | |
b533f3c5 RS |
892 | (set-buffer (or (marker-buffer marker) |
893 | (error "The marked buffer has been deleted"))) | |
d74e816f | 894 | (goto-char (marker-position marker)) |
eb8c3be9 | 895 | ;; Kill that marker so it doesn't slow down editing. |
d74e816f RM |
896 | (set-marker marker nil nil) |
897 | ;; Run the user's hook. Do we really want to do this for pop? | |
898 | (run-hooks 'local-find-tag-hook)))) | |
b533f3c5 RS |
899 | ;; Record whence we came. |
900 | (ring-insert find-tag-marker-ring (point-marker)) | |
926861fb | 901 | (if (and next-p last-tag) |
d74e816f RM |
902 | ;; Find the same table we last used. |
903 | (visit-tags-table-buffer 'same) | |
904 | ;; Pick a table to use. | |
905 | (visit-tags-table-buffer) | |
906 | ;; Record TAGNAME for a future call with NEXT-P non-nil. | |
907 | (setq last-tag tagname)) | |
4cc32db6 RS |
908 | ;; Record the location so we can pop back to it later. |
909 | (let ((marker (make-marker))) | |
dcaaec23 SM |
910 | (with-current-buffer |
911 | ;; find-tag-in-order does the real work. | |
912 | (find-tag-in-order | |
913 | (if (and next-p last-tag) last-tag tagname) | |
914 | (if regexp-p | |
915 | find-tag-regexp-search-function | |
916 | find-tag-search-function) | |
917 | (if regexp-p | |
918 | find-tag-regexp-tag-order | |
919 | find-tag-tag-order) | |
920 | (if regexp-p | |
921 | find-tag-regexp-next-line-after-failure-p | |
922 | find-tag-next-line-after-failure-p) | |
923 | (if regexp-p "matching" "containing") | |
924 | (or (not next-p) (not last-tag))) | |
4cc32db6 RS |
925 | (set-marker marker (point)) |
926 | (run-hooks 'local-find-tag-hook) | |
b533f3c5 | 927 | (ring-insert tags-location-ring marker) |
4cc32db6 | 928 | (current-buffer)))))) |
ff1f0fa6 | 929 | |
c086701a | 930 | ;;;###autoload |
d74e816f | 931 | (defun find-tag (tagname &optional next-p regexp-p) |
9708f7fc RM |
932 | "Find tag (in current tags table) whose name contains TAGNAME. |
933 | Select the buffer containing the tag's definition, and move point there. | |
934 | The default for TAGNAME is the expression in the buffer around or before point. | |
c086701a | 935 | |
d74e816f RM |
936 | If second arg NEXT-P is t (interactively, with prefix arg), search for |
937 | another tag that matches the last tagname or regexp used. When there are | |
938 | multiple matches for a tag, more exact matches are found first. If NEXT-P | |
939 | is the atom `-' (interactively, with prefix arg that is a negative number | |
940 | or just \\[negative-argument]), pop back to the previous tag gone to. | |
ff1f0fa6 | 941 | |
b533f3c5 RS |
942 | If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp. |
943 | ||
a70ea557 | 944 | A marker representing the point when this command is invoked is pushed |
b533f3c5 RS |
945 | onto a ring and may be popped back to with \\[pop-tag-mark]. |
946 | Contrast this with the ring of marks gone to by the command. | |
947 | ||
9708f7fc | 948 | See documentation of variable `tags-file-name'." |
d74e816f | 949 | (interactive (find-tag-interactive "Find tag: ")) |
ebc6b37c SM |
950 | (let* ((buf (find-tag-noselect tagname next-p regexp-p)) |
951 | (pos (with-current-buffer buf (point)))) | |
6010664f SM |
952 | (condition-case nil |
953 | (switch-to-buffer buf) | |
ebc6b37c SM |
954 | (error (pop-to-buffer buf))) |
955 | (goto-char pos))) | |
9708f7fc | 956 | ;;;###autoload (define-key esc-map "." 'find-tag) |
ff1f0fa6 | 957 | |
daa37602 | 958 | ;;;###autoload |
d74e816f | 959 | (defun find-tag-other-window (tagname &optional next-p regexp-p) |
9708f7fc | 960 | "Find tag (in current tags table) whose name contains TAGNAME. |
d74e816f RM |
961 | Select the buffer containing the tag's definition in another window, and |
962 | move point there. The default for TAGNAME is the expression in the buffer | |
963 | around or before point. | |
9708f7fc | 964 | |
d74e816f RM |
965 | If second arg NEXT-P is t (interactively, with prefix arg), search for |
966 | another tag that matches the last tagname or regexp used. When there are | |
967 | multiple matches for a tag, more exact matches are found first. If NEXT-P | |
968 | is negative (interactively, with prefix arg that is a negative number or | |
969 | just \\[negative-argument]), pop back to the previous tag gone to. | |
9708f7fc | 970 | |
b533f3c5 RS |
971 | If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp. |
972 | ||
a70ea557 | 973 | A marker representing the point when this command is invoked is pushed |
b533f3c5 RS |
974 | onto a ring and may be popped back to with \\[pop-tag-mark]. |
975 | Contrast this with the ring of marks gone to by the command. | |
976 | ||
9708f7fc | 977 | See documentation of variable `tags-file-name'." |
d74e816f RM |
978 | (interactive (find-tag-interactive "Find tag other window: ")) |
979 | ||
b6176f64 RM |
980 | ;; This hair is to deal with the case where the tag is found in the |
981 | ;; selected window's buffer; without the hair, point is moved in both | |
982 | ;; windows. To prevent this, we save the selected window's point before | |
983 | ;; doing find-tag-noselect, and restore it after. | |
984 | (let* ((window-point (window-point (selected-window))) | |
d74e816f | 985 | (tagbuf (find-tag-noselect tagname next-p regexp-p)) |
49693298 | 986 | (tagpoint (progn (set-buffer tagbuf) (point)))) |
b6176f64 RM |
987 | (set-window-point (prog1 |
988 | (selected-window) | |
49693298 JB |
989 | (switch-to-buffer-other-window tagbuf) |
990 | ;; We have to set this new window's point; it | |
991 | ;; might already have been displaying a | |
992 | ;; different portion of tagbuf, in which case | |
993 | ;; switch-to-buffer-other-window doesn't set | |
994 | ;; the window's point from the buffer. | |
995 | (set-window-point (selected-window) tagpoint)) | |
b6176f64 | 996 | window-point))) |
9708f7fc RM |
997 | ;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window) |
998 | ||
29add8b9 | 999 | ;;;###autoload |
9708f7fc | 1000 | (defun find-tag-other-frame (tagname &optional next-p) |
d74e816f RM |
1001 | "Find tag (in current tags table) whose name contains TAGNAME. |
1002 | Select the buffer containing the tag's definition in another frame, and | |
1003 | move point there. The default for TAGNAME is the expression in the buffer | |
1004 | around or before point. | |
1005 | ||
1006 | If second arg NEXT-P is t (interactively, with prefix arg), search for | |
1007 | another tag that matches the last tagname or regexp used. When there are | |
1008 | multiple matches for a tag, more exact matches are found first. If NEXT-P | |
1009 | is negative (interactively, with prefix arg that is a negative number or | |
1010 | just \\[negative-argument]), pop back to the previous tag gone to. | |
daa37602 | 1011 | |
b533f3c5 RS |
1012 | If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp. |
1013 | ||
a70ea557 | 1014 | A marker representing the point when this command is invoked is pushed |
b533f3c5 RS |
1015 | onto a ring and may be popped back to with \\[pop-tag-mark]. |
1016 | Contrast this with the ring of marks gone to by the command. | |
1017 | ||
9708f7fc | 1018 | See documentation of variable `tags-file-name'." |
d74e816f | 1019 | (interactive (find-tag-interactive "Find tag other frame: ")) |
9708f7fc RM |
1020 | (let ((pop-up-frames t)) |
1021 | (find-tag-other-window tagname next-p))) | |
1022 | ;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame) | |
1023 | ||
daa37602 | 1024 | ;;;###autoload |
9708f7fc RM |
1025 | (defun find-tag-regexp (regexp &optional next-p other-window) |
1026 | "Find tag (in current tags table) whose name matches REGEXP. | |
1027 | Select the buffer containing the tag's definition and move point there. | |
daa37602 | 1028 | |
d74e816f RM |
1029 | If second arg NEXT-P is t (interactively, with prefix arg), search for |
1030 | another tag that matches the last tagname or regexp used. When there are | |
1031 | multiple matches for a tag, more exact matches are found first. If NEXT-P | |
1032 | is negative (interactively, with prefix arg that is a negative number or | |
1033 | just \\[negative-argument]), pop back to the previous tag gone to. | |
9708f7fc RM |
1034 | |
1035 | If third arg OTHER-WINDOW is non-nil, select the buffer in another window. | |
1036 | ||
a70ea557 | 1037 | A marker representing the point when this command is invoked is pushed |
b533f3c5 RS |
1038 | onto a ring and may be popped back to with \\[pop-tag-mark]. |
1039 | Contrast this with the ring of marks gone to by the command. | |
1040 | ||
9708f7fc | 1041 | See documentation of variable `tags-file-name'." |
d74e816f RM |
1042 | (interactive (find-tag-interactive "Find tag regexp: " t)) |
1043 | ;; We go through find-tag-other-window to do all the display hair there. | |
1044 | (funcall (if other-window 'find-tag-other-window 'find-tag) | |
1045 | regexp next-p t)) | |
a6125773 | 1046 | ;;;###autoload (define-key esc-map [?\C-.] 'find-tag-regexp) |
b533f3c5 RS |
1047 | |
1048 | ;;;###autoload (define-key esc-map "*" 'pop-tag-mark) | |
1049 | ||
1050 | ;;;###autoload | |
1051 | (defun pop-tag-mark () | |
1052 | "Pop back to where \\[find-tag] was last invoked. | |
1053 | ||
1054 | This is distinct from invoking \\[find-tag] with a negative argument | |
1055 | since that pops a stack of markers at which tags were found, not from | |
1056 | where they were found." | |
1057 | (interactive) | |
1058 | (if (ring-empty-p find-tag-marker-ring) | |
1059 | (error "No previous locations for find-tag invocation")) | |
1060 | (let ((marker (ring-remove find-tag-marker-ring 0))) | |
1061 | (switch-to-buffer (or (marker-buffer marker) | |
1062 | (error "The marked buffer has been deleted"))) | |
1063 | (goto-char (marker-position marker)) | |
1064 | (set-marker marker nil nil))) | |
9708f7fc | 1065 | \f |
cba9bdd2 RS |
1066 | (defvar tag-lines-already-matched nil |
1067 | "Matches remembered between calls.") ; Doc string: calls to what? | |
b7089f3c | 1068 | |
f90a6155 JB |
1069 | (defun find-tag-in-order (pattern |
1070 | search-forward-func | |
1071 | order | |
1072 | next-line-after-failure-p | |
1073 | matching | |
1074 | first-search) | |
cba9bdd2 RS |
1075 | "Internal tag-finding function. |
1076 | PATTERN is a string to pass to arg SEARCH-FORWARD-FUNC, and to any | |
1077 | member of the function list ORDER. If ORDER is nil, use saved state | |
1078 | to continue a previous search. | |
1079 | ||
1080 | Arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match, | |
1081 | point should be moved to the next line. | |
1082 | ||
1083 | Arg MATCHING is a string, an English `-ing' word, to be used in an | |
1084 | error message." | |
1085 | ;; Algorithm is as follows: | |
1086 | ;; For each qualifier-func in ORDER, go to beginning of tags file, and | |
1087 | ;; perform inner loop: for each naive match for PATTERN found using | |
1088 | ;; SEARCH-FORWARD-FUNC, qualify the naive match using qualifier-func. If | |
1089 | ;; it qualifies, go to the specified line in the specified source file | |
1090 | ;; and return. Qualified matches are remembered to avoid repetition. | |
1091 | ;; State is saved so that the loop can be continued. | |
9708f7fc RM |
1092 | (let (file ;name of file containing tag |
1093 | tag-info ;where to find the tag in FILE | |
9708f7fc RM |
1094 | (first-table t) |
1095 | (tag-order order) | |
b7089f3c | 1096 | (match-marker (make-marker)) |
9708f7fc | 1097 | goto-func |
ece6e35a GM |
1098 | (case-fold-search (if (memq tags-case-fold-search '(nil t)) |
1099 | tags-case-fold-search | |
1100 | case-fold-search)) | |
9708f7fc RM |
1101 | ) |
1102 | (save-excursion | |
b7089f3c RM |
1103 | |
1104 | (if first-search | |
1105 | ;; This is the start of a search for a fresh tag. | |
1106 | ;; Clear the list of tags matched by the previous search. | |
1107 | ;; find-tag-noselect has already put us in the first tags table | |
1108 | ;; buffer before we got called. | |
1109 | (setq tag-lines-already-matched nil) | |
1110 | ;; Continuing to search for the tag specified last time. | |
1111 | ;; tag-lines-already-matched lists locations matched in previous | |
1112 | ;; calls so we don't visit the same tag twice if it matches twice | |
1113 | ;; during two passes with different qualification predicates. | |
1114 | ;; Switch to the current tags table buffer. | |
1115 | (visit-tags-table-buffer 'same)) | |
47f3c459 | 1116 | |
9708f7fc | 1117 | ;; Get a qualified match. |
83287e5b | 1118 | (catch 'qualified-match-found |
47f3c459 | 1119 | |
b6176f64 | 1120 | ;; Iterate over the list of tags tables. |
9708f7fc RM |
1121 | (while (or first-table |
1122 | (visit-tags-table-buffer t)) | |
1123 | ||
6218e8c6 RM |
1124 | (and first-search first-table |
1125 | ;; Start at beginning of tags file. | |
1126 | (goto-char (point-min))) | |
5e882a6a | 1127 | |
6218e8c6 | 1128 | (setq first-table nil) |
9708f7fc | 1129 | |
b6176f64 | 1130 | ;; Iterate over the list of ordering predicates. |
9708f7fc RM |
1131 | (while order |
1132 | (while (funcall search-forward-func pattern nil t) | |
1133 | ;; Naive match found. Qualify the match. | |
1134 | (and (funcall (car order) pattern) | |
1135 | ;; Make sure it is not a previous qualified match. | |
9b026d9f | 1136 | (not (member (set-marker match-marker (point-at-bol)) |
b7089f3c | 1137 | tag-lines-already-matched)) |
9708f7fc RM |
1138 | (throw 'qualified-match-found nil)) |
1139 | (if next-line-after-failure-p | |
1140 | (forward-line 1))) | |
1141 | ;; Try the next flavor of match. | |
1142 | (setq order (cdr order)) | |
1143 | (goto-char (point-min))) | |
1144 | (setq order tag-order)) | |
1145 | ;; We throw out on match, so only get here if there were no matches. | |
b7089f3c | 1146 | ;; Clear out the markers we use to avoid duplicate matches so they |
4c36be58 | 1147 | ;; don't slow down editing and are immediately available for GC. |
b7089f3c RM |
1148 | (while tag-lines-already-matched |
1149 | (set-marker (car tag-lines-already-matched) nil nil) | |
1150 | (setq tag-lines-already-matched (cdr tag-lines-already-matched))) | |
1151 | (set-marker match-marker nil nil) | |
9708f7fc | 1152 | (error "No %stags %s %s" (if first-search "" "more ") |
83287e5b RM |
1153 | matching pattern)) |
1154 | ||
9708f7fc RM |
1155 | ;; Found a tag; extract location info. |
1156 | (beginning-of-line) | |
b7089f3c | 1157 | (setq tag-lines-already-matched (cons match-marker |
9708f7fc RM |
1158 | tag-lines-already-matched)) |
1159 | ;; Expand the filename, using the tags table buffer's default-directory. | |
fb7775eb | 1160 | ;; We should be able to search for file-name backwards in file-of-tag: |
ddc76b00 | 1161 | ;; the beginning-of-line is ok except when positioned on a "file-name" tag. |
fb7775eb | 1162 | (setq file (expand-file-name |
ddc76b00 FP |
1163 | (if (memq (car order) '(tag-exact-file-name-match-p |
1164 | tag-file-name-match-p | |
1165 | tag-partial-file-name-match-p)) | |
7caf6803 | 1166 | (save-excursion (forward-line 1) |
fb7775eb GM |
1167 | (file-of-tag)) |
1168 | (file-of-tag))) | |
9708f7fc RM |
1169 | tag-info (funcall snarf-tag-function)) |
1170 | ||
b6176f64 | 1171 | ;; Get the local value in the tags table buffer before switching buffers. |
9708f7fc | 1172 | (setq goto-func goto-tag-location-function) |
84406262 | 1173 | (tag-find-file-of-tag-noselect file) |
9708f7fc RM |
1174 | (widen) |
1175 | (push-mark) | |
83287e5b RM |
1176 | (funcall goto-func tag-info) |
1177 | ||
9708f7fc RM |
1178 | ;; Return the buffer where the tag was found. |
1179 | (current-buffer)))) | |
79e01623 | 1180 | |
84406262 | 1181 | (defun tag-find-file-of-tag-noselect (file) |
cba9bdd2 RS |
1182 | "Find the right line in the specified FILE." |
1183 | ;; If interested in compressed-files, search files with extensions. | |
1184 | ;; Otherwise, search only the real file. | |
79e01623 JB |
1185 | (let* ((buffer-search-extensions (if (featurep 'jka-compr) |
1186 | tags-compression-info-list | |
1187 | '(""))) | |
1188 | the-buffer | |
1189 | (file-search-extensions buffer-search-extensions)) | |
1190 | ;; search a buffer visiting the file with each possible extension | |
1191 | ;; Note: there is a small inefficiency in find-buffer-visiting : | |
1192 | ;; truename is computed even if not needed. Not too sure about this | |
1193 | ;; but I suspect truename computation accesses the disk. | |
e1dbe924 | 1194 | ;; It is maybe a good idea to optimize this find-buffer-visiting. |
79e01623 JB |
1195 | ;; An alternative would be to use only get-file-buffer |
1196 | ;; but this looks less "sure" to find the buffer for the file. | |
1197 | (while (and (not the-buffer) buffer-search-extensions) | |
1198 | (setq the-buffer (find-buffer-visiting (concat file (car buffer-search-extensions)))) | |
1199 | (setq buffer-search-extensions (cdr buffer-search-extensions))) | |
1200 | ;; if found a buffer but file modified, ensure we re-read ! | |
1201 | (if (and the-buffer (not (verify-visited-file-modtime the-buffer))) | |
1202 | (find-file-noselect (buffer-file-name the-buffer))) | |
1203 | ;; if no buffer found, search for files with possible extensions on disk | |
1204 | (while (and (not the-buffer) file-search-extensions) | |
1205 | (if (not (file-exists-p (concat file (car file-search-extensions)))) | |
1206 | (setq file-search-extensions (cdr file-search-extensions)) | |
1207 | (setq the-buffer (find-file-noselect (concat file (car file-search-extensions)))))) | |
1208 | (if (not the-buffer) | |
1209 | (if (featurep 'jka-compr) | |
1210 | (error "File %s (with or without extensions %s) not found" file tags-compression-info-list) | |
1211 | (error "File %s not found" file)) | |
1212 | (set-buffer the-buffer)))) | |
1213 | ||
cba9bdd2 | 1214 | (defun tag-find-file-of-tag (file) ; Doc string? |
84406262 | 1215 | (let ((buf (tag-find-file-of-tag-noselect file))) |
79e01623 JB |
1216 | (condition-case nil |
1217 | (switch-to-buffer buf) | |
1218 | (error (pop-to-buffer buf))))) | |
9708f7fc RM |
1219 | \f |
1220 | ;; `etags' TAGS file format support. | |
1221 | ||
1222 | (defun etags-recognize-tags-table () | |
cba9bdd2 RS |
1223 | "If `etags-verify-tags-table', make buffer-local format variables. |
1224 | If current buffer is a valid etags TAGS file, then give it | |
1225 | buffer-local values of tags table format variables." | |
b6176f64 | 1226 | (and (etags-verify-tags-table) |
9508896e JB |
1227 | ;; It is annoying to flash messages on the screen briefly, |
1228 | ;; and this message is not useful. -- rms | |
1229 | ;; (message "%s is an `etags' TAGS file" buffer-file-name) | |
dd2cedb9 DL |
1230 | (mapc (lambda (elt) (set (make-local-variable (car elt)) (cdr elt))) |
1231 | '((file-of-tag-function . etags-file-of-tag) | |
1232 | (tags-table-files-function . etags-tags-table-files) | |
1233 | (tags-completion-table-function . etags-tags-completion-table) | |
1234 | (snarf-tag-function . etags-snarf-tag) | |
1235 | (goto-tag-location-function . etags-goto-tag-location) | |
1236 | (find-tag-regexp-search-function . re-search-forward) | |
1237 | (find-tag-regexp-tag-order . (tag-re-match-p)) | |
1238 | (find-tag-regexp-next-line-after-failure-p . t) | |
1239 | (find-tag-search-function . search-forward) | |
1240 | (find-tag-tag-order . (tag-exact-file-name-match-p | |
ddc76b00 | 1241 | tag-file-name-match-p |
dd2cedb9 | 1242 | tag-exact-match-p |
d30ffe0e | 1243 | tag-implicit-name-match-p |
dd2cedb9 DL |
1244 | tag-symbol-match-p |
1245 | tag-word-match-p | |
fb7775eb | 1246 | tag-partial-file-name-match-p |
dd2cedb9 DL |
1247 | tag-any-match-p)) |
1248 | (find-tag-next-line-after-failure-p . nil) | |
1249 | (list-tags-function . etags-list-tags) | |
1250 | (tags-apropos-function . etags-tags-apropos) | |
1251 | (tags-included-tables-function . etags-tags-included-tables) | |
1252 | (verify-tags-table-function . etags-verify-tags-table) | |
1253 | )))) | |
9708f7fc RM |
1254 | |
1255 | (defun etags-verify-tags-table () | |
e7f767c2 | 1256 | "Return non-nil if the current buffer is a valid etags TAGS file." |
e4fc4f58 | 1257 | ;; Use eq instead of = in case char-after returns nil. |
a1906d51 | 1258 | (eq (char-after (point-min)) ?\f)) |
9708f7fc | 1259 | |
cba9bdd2 | 1260 | (defun etags-file-of-tag (&optional relative) ; Doc string? |
9708f7fc | 1261 | (save-excursion |
5e0b7560 | 1262 | (re-search-backward "\f\n\\([^\n]+\\),[0-9]*\n") |
bfa4f190 SS |
1263 | (let ((str (convert-standard-filename |
1264 | (buffer-substring (match-beginning 1) (match-end 1))))) | |
79e01623 JB |
1265 | (if relative |
1266 | str | |
bfa4f190 | 1267 | (expand-file-name str (file-truename default-directory)))))) |
9708f7fc | 1268 | |
aa27fbb4 | 1269 | |
cba9bdd2 | 1270 | (defun etags-tags-completion-table () ; Doc string? |
46de1c5a | 1271 | (let ((table (make-vector 511 0)) |
4f124fb5 EZ |
1272 | (progress-reporter |
1273 | (make-progress-reporter | |
1274 | (format "Making tags completion table for %s..." buffer-file-name) | |
1275 | (point-min) (point-max)))) | |
9708f7fc RM |
1276 | (save-excursion |
1277 | (goto-char (point-min)) | |
4a92b718 RM |
1278 | ;; This monster regexp matches an etags tag line. |
1279 | ;; \1 is the string to match; | |
1280 | ;; \2 is not interesting; | |
1281 | ;; \3 is the guessed tag name; XXX guess should be better eg DEFUN | |
eb6a920f RM |
1282 | ;; \4 is not interesting; |
1283 | ;; \5 is the explicitly-specified tag name. | |
1284 | ;; \6 is the line to start searching at; | |
1285 | ;; \7 is the char to start searching at. | |
4a92b718 | 1286 | (while (re-search-forward |
a7885816 | 1287 | "^\\(\\([^\177]+[^-a-zA-Z0-9_+*$:\177]+\\)?\ |
7e7b42b2 GM |
1288 | \\([-a-zA-Z0-9_+*$?:]+\\)[^-a-zA-Z0-9_+*$?:\177]*\\)\177\ |
1289 | \\(\\([^\n\001]+\\)\001\\)?\\([0-9]+\\)?,\\([0-9]+\\)?\n" | |
4a92b718 | 1290 | nil t) |
46de1c5a MY |
1291 | (intern (prog1 (if (match-beginning 5) |
1292 | ;; There is an explicit tag name. | |
1293 | (buffer-substring (match-beginning 5) (match-end 5)) | |
1294 | ;; No explicit tag name. Best guess. | |
1295 | (buffer-substring (match-beginning 3) (match-end 3))) | |
4f124fb5 | 1296 | (progress-reporter-update progress-reporter (point))) |
4a92b718 | 1297 | table))) |
9708f7fc RM |
1298 | table)) |
1299 | ||
cba9bdd2 | 1300 | (defun etags-snarf-tag (&optional use-explicit) ; Doc string? |
79e01623 | 1301 | (let (tag-text line startpos explicit-start) |
83287e5b RM |
1302 | (if (save-excursion |
1303 | (forward-line -1) | |
1304 | (looking-at "\f\n")) | |
1305 | ;; The match was for a source file name, not any tag within a file. | |
1306 | ;; Give text of t, meaning to go exactly to the location we specify, | |
1307 | ;; the beginning of the file. | |
1308 | (setq tag-text t | |
1309 | line nil | |
a1906d51 | 1310 | startpos (point-min)) |
83287e5b RM |
1311 | |
1312 | ;; Find the end of the tag and record the whole tag text. | |
1313 | (search-forward "\177") | |
9b026d9f | 1314 | (setq tag-text (buffer-substring (1- (point)) (point-at-bol))) |
79e01623 JB |
1315 | ;; If use-explicit is non nil and explicit tag is present, use it as part of |
1316 | ;; return value. Else just skip it. | |
1317 | (setq explicit-start (point)) | |
9b026d9f | 1318 | (when (and (search-forward "\001" (point-at-bol 2) t) |
79e01623 JB |
1319 | use-explicit) |
1320 | (setq tag-text (buffer-substring explicit-start (1- (point))))) | |
1321 | ||
1322 | ||
83287e5b | 1323 | (if (looking-at "[0-9]") |
027a4b6b JB |
1324 | (setq line (string-to-number (buffer-substring |
1325 | (point) | |
1326 | (progn (skip-chars-forward "0-9") | |
1327 | (point)))))) | |
83287e5b RM |
1328 | (search-forward ",") |
1329 | (if (looking-at "[0-9]") | |
027a4b6b JB |
1330 | (setq startpos (string-to-number (buffer-substring |
1331 | (point) | |
1332 | (progn (skip-chars-forward "0-9") | |
1333 | (point))))))) | |
9708f7fc RM |
1334 | ;; Leave point on the next line of the tags file. |
1335 | (forward-line 1) | |
e1dec509 RM |
1336 | (cons tag-text (cons line startpos)))) |
1337 | ||
9708f7fc | 1338 | (defun etags-goto-tag-location (tag-info) |
cba9bdd2 RS |
1339 | "Go to location of tag specified by TAG-INFO. |
1340 | TAG-INFO is a cons (TEXT LINE . POSITION). | |
1341 | TEXT is the initial part of a line containing the tag. | |
1342 | LINE is the line number. | |
1343 | POSITION is the (one-based) char position of TEXT within the file. | |
1344 | ||
1345 | If TEXT is t, it means the tag refers to exactly LINE or POSITION, | |
1346 | whichever is present, LINE having preference, no searching. | |
1347 | Either LINE or POSITION can be nil. POSITION is used if present. | |
1348 | ||
1349 | If the tag isn't exactly at the given position, then look near that | |
1350 | position using a search window that expands progressively until it | |
1351 | hits the start of file." | |
e1dec509 | 1352 | (let ((startpos (cdr (cdr tag-info))) |
a0f09378 | 1353 | (line (car (cdr tag-info))) |
83287e5b RM |
1354 | offset found pat) |
1355 | (if (eq (car tag-info) t) | |
1356 | ;; Direct file tag. | |
d80619fa GM |
1357 | (cond (line (progn (goto-char (point-min)) |
1358 | (forward-line (1- line)))) | |
a0f09378 | 1359 | (startpos (goto-char startpos)) |
83287e5b RM |
1360 | (t (error "etags.el BUG: bogus direct file tag"))) |
1361 | ;; This constant is 1/2 the initial search window. | |
1362 | ;; There is no sense in making it too small, | |
1363 | ;; since just going around the loop once probably | |
1364 | ;; costs about as much as searching 2000 chars. | |
1365 | (setq offset 1000 | |
1366 | found nil | |
1367 | pat (concat (if (eq selective-display t) | |
1368 | "\\(^\\|\^m\\)" "^") | |
1369 | (regexp-quote (car tag-info)))) | |
1370 | ;; The character position in the tags table is 0-origin. | |
1371 | ;; Convert it to a 1-origin Emacs character position. | |
1372 | (if startpos (setq startpos (1+ startpos))) | |
1373 | ;; If no char pos was given, try the given line number. | |
1374 | (or startpos | |
a0f09378 | 1375 | (if line |
d80619fa GM |
1376 | (setq startpos (progn (goto-char (point-min)) |
1377 | (forward-line (1- line)) | |
83287e5b RM |
1378 | (point))))) |
1379 | (or startpos | |
1380 | (setq startpos (point-min))) | |
1381 | ;; First see if the tag is right at the specified location. | |
1382 | (goto-char startpos) | |
1383 | (setq found (looking-at pat)) | |
1384 | (while (and (not found) | |
1385 | (progn | |
1386 | (goto-char (- startpos offset)) | |
1387 | (not (bobp)))) | |
1388 | (setq found | |
1389 | (re-search-forward pat (+ startpos offset) t) | |
1390 | offset (* 3 offset))) ; expand search window | |
1391 | (or found | |
1392 | (re-search-forward pat nil t) | |
1393 | (error "Rerun etags: `%s' not found in %s" | |
1394 | pat buffer-file-name))) | |
1395 | ;; Position point at the right place | |
1396 | ;; if the search string matched an extra Ctrl-m at the beginning. | |
1397 | (and (eq selective-display t) | |
1398 | (looking-at "\^m") | |
1399 | (forward-char 1)) | |
1400 | (beginning-of-line))) | |
9708f7fc | 1401 | |
cba9bdd2 | 1402 | (defun etags-list-tags (file) ; Doc string? |
a1906d51 | 1403 | (goto-char (point-min)) |
79e01623 JB |
1404 | (when (re-search-forward (concat "\f\n" "\\(" file "\\)" ",") nil t) |
1405 | (let ((path (save-excursion (forward-line 1) (file-of-tag))) | |
1406 | ;; Get the local value in the tags table | |
1407 | ;; buffer before switching buffers. | |
1408 | (goto-func goto-tag-location-function) | |
1409 | tag tag-info pt) | |
9708f7fc RM |
1410 | (forward-line 1) |
1411 | (while (not (or (eobp) (looking-at "\f"))) | |
79e01623 JB |
1412 | (setq tag-info (save-excursion (funcall snarf-tag-function t)) |
1413 | tag (car tag-info) | |
1414 | pt (with-current-buffer standard-output (point))) | |
1415 | (princ tag) | |
1416 | (when (= (aref tag 0) ?\() (princ " ...)")) | |
1417 | (with-current-buffer standard-output | |
1418 | (make-text-button pt (point) | |
1419 | 'tag-info tag-info | |
1420 | 'file-path path | |
1421 | 'goto-func goto-func | |
1422 | 'action (lambda (button) | |
1423 | (let ((tag-info (button-get button 'tag-info)) | |
1424 | (goto-func (button-get button 'goto-func))) | |
84406262 | 1425 | (tag-find-file-of-tag (button-get button 'file-path)) |
79e01623 JB |
1426 | (widen) |
1427 | (funcall goto-func tag-info))) | |
26581f0e CY |
1428 | 'follow-link t |
1429 | 'face tags-tag-face | |
79e01623 | 1430 | 'type 'button)) |
9708f7fc | 1431 | (terpri) |
274d013d | 1432 | (forward-line 1)) |
79e01623 | 1433 | t))) |
9708f7fc | 1434 | |
7e7b42b2 GM |
1435 | (defmacro tags-with-face (face &rest body) |
1436 | "Execute BODY, give output to `standard-output' face FACE." | |
06adf6b1 | 1437 | (let ((pp (make-symbol "start"))) |
286c138d | 1438 | `(let ((,pp (with-current-buffer standard-output (point)))) |
7e7b42b2 | 1439 | ,@body |
286c138d | 1440 | (put-text-property ,pp (with-current-buffer standard-output (point)) |
7e7b42b2 GM |
1441 | 'face ,face standard-output)))) |
1442 | ||
1443 | (defun etags-tags-apropos-additional (regexp) | |
1444 | "Display tags matching REGEXP from `tags-apropos-additional-actions'." | |
1445 | (with-current-buffer standard-output | |
1446 | (dolist (oba tags-apropos-additional-actions) | |
1447 | (princ "\n\n") | |
1448 | (tags-with-face 'highlight (princ (car oba))) | |
1449 | (princ":\n\n") | |
79e01623 | 1450 | (let* ((beg (point)) |
7e7b42b2 GM |
1451 | (symbs (car (cddr oba))) |
1452 | (ins-symb (lambda (sy) | |
1453 | (let ((sn (symbol-name sy))) | |
1454 | (when (string-match regexp sn) | |
79e01623 JB |
1455 | (make-text-button (point) |
1456 | (progn (princ sy) (point)) | |
1457 | 'action-internal(cadr oba) | |
1458 | 'action (lambda (button) (funcall | |
1459 | (button-get button 'action-internal) | |
1460 | (button-get button 'item))) | |
1461 | 'item sn | |
1462 | 'face tags-tag-face | |
26581f0e | 1463 | 'follow-link t |
79e01623 | 1464 | 'type 'button) |
7e7b42b2 GM |
1465 | (terpri)))))) |
1466 | (when (symbolp symbs) | |
1467 | (if (boundp symbs) | |
1468 | (setq symbs (symbol-value symbs)) | |
1469 | (insert "symbol `" (symbol-name symbs) "' has no value\n") | |
1470 | (setq symbs nil))) | |
1471 | (if (vectorp symbs) | |
1472 | (mapatoms ins-symb symbs) | |
1473 | (dolist (sy symbs) | |
1474 | (funcall ins-symb (car sy)))) | |
1475 | (sort-lines nil beg (point)))))) | |
1476 | ||
cba9bdd2 | 1477 | (defun etags-tags-apropos (string) ; Doc string? |
7e7b42b2 GM |
1478 | (when tags-apropos-verbose |
1479 | (princ "Tags in file `") | |
1480 | (tags-with-face 'highlight (princ buffer-file-name)) | |
1481 | (princ "':\n\n")) | |
a1906d51 | 1482 | (goto-char (point-min)) |
4f124fb5 EZ |
1483 | (let ((progress-reporter (make-progress-reporter |
1484 | (format "Making tags apropos buffer for `%s'..." | |
1485 | string) | |
1486 | (point-min) (point-max)))) | |
31f98a93 | 1487 | (while (re-search-forward string nil t) |
4f124fb5 | 1488 | (progress-reporter-update progress-reporter (point)) |
31f98a93 MY |
1489 | (beginning-of-line) |
1490 | ||
1491 | (let* ( ;; Get the local value in the tags table | |
1492 | ;; buffer before switching buffers. | |
1493 | (goto-func goto-tag-location-function) | |
1494 | (tag-info (save-excursion (funcall snarf-tag-function))) | |
1495 | (tag (if (eq t (car tag-info)) nil (car tag-info))) | |
1496 | (file-path (save-excursion (if tag (file-of-tag) | |
7caf6803 | 1497 | (save-excursion (forward-line 1) |
31f98a93 MY |
1498 | (file-of-tag))))) |
1499 | (file-label (if tag (file-of-tag t) | |
7caf6803 | 1500 | (save-excursion (forward-line 1) |
31f98a93 MY |
1501 | (file-of-tag t)))) |
1502 | (pt (with-current-buffer standard-output (point)))) | |
1503 | (if tag | |
1504 | (progn | |
1505 | (princ (format "[%s]: " file-label)) | |
1506 | (princ tag) | |
1507 | (when (= (aref tag 0) ?\() (princ " ...)")) | |
1508 | (with-current-buffer standard-output | |
1509 | (make-text-button pt (point) | |
1510 | 'tag-info tag-info | |
1511 | 'file-path file-path | |
1512 | 'goto-func goto-func | |
1513 | 'action (lambda (button) | |
1514 | (let ((tag-info (button-get button 'tag-info)) | |
1515 | (goto-func (button-get button 'goto-func))) | |
1516 | (tag-find-file-of-tag (button-get button 'file-path)) | |
1517 | (widen) | |
1518 | (funcall goto-func tag-info))) | |
26581f0e CY |
1519 | 'follow-link t |
1520 | 'face tags-tag-face | |
31f98a93 MY |
1521 | 'type 'button))) |
1522 | (princ (format "- %s" file-label)) | |
1523 | (with-current-buffer standard-output | |
1524 | (make-text-button pt (point) | |
1525 | 'file-path file-path | |
1526 | 'action (lambda (button) | |
1527 | (tag-find-file-of-tag (button-get button 'file-path)) | |
1528 | ;; Get the local value in the tags table | |
1529 | ;; buffer before switching buffers. | |
1530 | (goto-char (point-min))) | |
26581f0e CY |
1531 | 'follow-link t |
1532 | 'face tags-tag-face | |
1533 | 'type 'button)))) | |
31f98a93 MY |
1534 | (terpri) |
1535 | (forward-line 1)) | |
1536 | (message nil)) | |
7e7b42b2 | 1537 | (when tags-apropos-verbose (princ "\n"))) |
9708f7fc | 1538 | |
cba9bdd2 | 1539 | (defun etags-tags-table-files () ; Doc string? |
9708f7fc RM |
1540 | (let ((files nil) |
1541 | beg) | |
1542 | (goto-char (point-min)) | |
1543 | (while (search-forward "\f\n" nil t) | |
1544 | (setq beg (point)) | |
610c25c1 RS |
1545 | (end-of-line) |
1546 | (skip-chars-backward "^," beg) | |
1547 | (or (looking-at "include$") | |
bfa4f190 SS |
1548 | (push (convert-standard-filename |
1549 | (buffer-substring beg (1- (point)))) | |
1550 | files))) | |
9708f7fc RM |
1551 | (nreverse files))) |
1552 | ||
cba9bdd2 | 1553 | (defun etags-tags-included-tables () ; Doc string? |
9708f7fc RM |
1554 | (let ((files nil) |
1555 | beg) | |
1556 | (goto-char (point-min)) | |
1557 | (while (search-forward "\f\n" nil t) | |
1558 | (setq beg (point)) | |
610c25c1 RS |
1559 | (end-of-line) |
1560 | (skip-chars-backward "^," beg) | |
bfa4f190 SS |
1561 | (when (looking-at "include$") |
1562 | ;; Expand in the default-directory of the tags table buffer. | |
1563 | (push (expand-file-name (convert-standard-filename | |
1564 | (buffer-substring beg (1- (point))))) | |
1565 | files))) | |
9708f7fc RM |
1566 | (nreverse files))) |
1567 | \f | |
1568 | ;; Empty tags file support. | |
1569 | ||
7e7b42b2 | 1570 | (defun tags-recognize-empty-tags-table () |
cba9bdd2 RS |
1571 | "Return non-nil if current buffer is empty. |
1572 | If empty, make buffer-local values of the tags table format variables | |
1573 | that do nothing." | |
9708f7fc | 1574 | (and (zerop (buffer-size)) |
dd2cedb9 DL |
1575 | (mapc (lambda (sym) (set (make-local-variable sym) 'ignore)) |
1576 | '(tags-table-files-function | |
1577 | tags-completion-table-function | |
1578 | find-tag-regexp-search-function | |
1579 | find-tag-search-function | |
1580 | tags-apropos-function | |
1581 | tags-included-tables-function)) | |
9708f7fc | 1582 | (set (make-local-variable 'verify-tags-table-function) |
7e7b42b2 | 1583 | (lambda () (zerop (buffer-size)))))) |
9708f7fc | 1584 | \f |
7e7b42b2 | 1585 | ;; Match qualifier functions for tagnames. |
2aa9d1be | 1586 | ;; These functions assume the etags file format defined in etc/ETAGS.EBNF. |
9708f7fc | 1587 | |
6218e8c6 RM |
1588 | ;; This might be a neat idea, but it's too hairy at the moment. |
1589 | ;;(defmacro tags-with-syntax (&rest body) | |
dcaaec23 SM |
1590 | ;; `(with-syntax-table |
1591 | ;; (with-current-buffer (find-file-noselect (file-of-tag)) | |
1592 | ;; (syntax-table)) | |
1593 | ;; ,@body)) | |
6218e8c6 | 1594 | ;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form)) |
8a4c10dc | 1595 | |
2aa9d1be FP |
1596 | ;; exact file name match, i.e. searched tag must match complete file |
1597 | ;; name including directories parts if there are some. | |
1598 | (defun tag-exact-file-name-match-p (tag) | |
cba9bdd2 RS |
1599 | "Return non-nil if TAG matches complete file name. |
1600 | Any directory part of the file name is also matched." | |
2aa9d1be FP |
1601 | (and (looking-at ",[0-9\n]") |
1602 | (save-excursion (backward-char (+ 2 (length tag))) | |
1603 | (looking-at "\f\n")))) | |
cba9bdd2 | 1604 | |
2aa9d1be FP |
1605 | ;; file name match as above, but searched tag must match the file |
1606 | ;; name not including the directories if there are some. | |
1607 | (defun tag-file-name-match-p (tag) | |
cba9bdd2 | 1608 | "Return non-nil if TAG matches file name, excluding directory part." |
2aa9d1be FP |
1609 | (and (looking-at ",[0-9\n]") |
1610 | (save-excursion (backward-char (1+ (length tag))) | |
1611 | (looking-at "/")))) | |
cba9bdd2 | 1612 | |
2aa9d1be FP |
1613 | ;; this / to detect we are after a directory separator is ok for unix, |
1614 | ;; is there a variable that contains the regexp for directory separator | |
1615 | ;; on whatever operating system ? | |
1616 | ;; Looks like ms-win will lose here :). | |
1617 | ||
eb21e7ae | 1618 | ;; t if point is at a tag line that matches TAG exactly. |
9708f7fc | 1619 | ;; point should be just after a string that matches TAG. |
6218e8c6 | 1620 | (defun tag-exact-match-p (tag) |
cba9bdd2 RS |
1621 | "Return non-nil if current tag line matches TAG exactly. |
1622 | Point should be just after a string that matches TAG." | |
add3312f | 1623 | ;; The match is really exact if there is an explicit tag name. |
63aeffd5 | 1624 | (or (and (eq (char-after (point)) ?\001) |
40ce9268 | 1625 | (eq (char-after (- (point) (length tag) 1)) ?\177)) |
63aeffd5 | 1626 | ;; We are not on the explicit tag name, but perhaps it follows. |
eb21e7ae RM |
1627 | (looking-at (concat "[^\177\n]*\177" (regexp-quote tag) "\001")))) |
1628 | ||
d30ffe0e FP |
1629 | ;; t if point is at a tag line that has an implicit name. |
1630 | ;; point should be just after a string that matches TAG. | |
1631 | (defun tag-implicit-name-match-p (tag) | |
cba9bdd2 RS |
1632 | "Return non-nil if current tag line has an implicit name. |
1633 | Point should be just after a string that matches TAG." | |
d30ffe0e FP |
1634 | ;; Look at the comment of the make_tag function in lib-src/etags.c for |
1635 | ;; a textual description of the four rules. | |
1636 | (and (string-match "^[^ \t()=,;]+$" tag) ;rule #1 | |
1637 | (looking-at "[ \t()=,;]?\177") ;rules #2 and #4 | |
1638 | (save-excursion | |
1639 | (backward-char (1+ (length tag))) | |
1640 | (looking-at "[\n \t()=,;]")))) ;rule #3 | |
1641 | ||
eb21e7ae RM |
1642 | ;; t if point is at a tag line that matches TAG as a symbol. |
1643 | ;; point should be just after a string that matches TAG. | |
1644 | (defun tag-symbol-match-p (tag) | |
cba9bdd2 RS |
1645 | "Return non-nil if current tag line matches TAG as a symbol. |
1646 | Point should be just after a string that matches TAG." | |
eb21e7ae RM |
1647 | (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177") |
1648 | (save-excursion | |
1649 | (backward-char (1+ (length tag))) | |
1650 | (and (looking-at "\\Sw") (looking-at "\\S_"))))) | |
9708f7fc RM |
1651 | |
1652 | ;; t if point is at a tag line that matches TAG as a word. | |
1653 | ;; point should be just after a string that matches TAG. | |
1654 | (defun tag-word-match-p (tag) | |
cba9bdd2 RS |
1655 | "Return non-nil if current tag line matches TAG as a word. |
1656 | Point should be just after a string that matches TAG." | |
9708f7fc | 1657 | (and (looking-at "\\b.*\177") |
a0f09378 | 1658 | (save-excursion (backward-char (length tag)) |
9708f7fc RM |
1659 | (looking-at "\\b")))) |
1660 | ||
1ea98518 SM |
1661 | ;; partial file name match, i.e. searched tag must match a substring |
1662 | ;; of the file name (potentially including a directory separator). | |
e02f48d7 | 1663 | (defun tag-partial-file-name-match-p (_tag) |
cba9bdd2 RS |
1664 | "Return non-nil if current tag matches file name. |
1665 | This is a substring match, and it can include directory separators. | |
1666 | Point should be just after a string that matches TAG." | |
1f21ea94 | 1667 | (and (looking-at ".*,[0-9\n]") |
fb7775eb GM |
1668 | (save-excursion (beginning-of-line) |
1669 | (backward-char 2) | |
1670 | (looking-at "\f\n")))) | |
5e882a6a | 1671 | |
9708f7fc | 1672 | ;; t if point is in a tag line with a tag containing TAG as a substring. |
e02f48d7 | 1673 | (defun tag-any-match-p (_tag) |
cba9bdd2 | 1674 | "Return non-nil if current tag line contains TAG as a substring." |
9708f7fc | 1675 | (looking-at ".*\177")) |
ff1f0fa6 | 1676 | |
9708f7fc RM |
1677 | ;; t if point is at a tag line that matches RE as a regexp. |
1678 | (defun tag-re-match-p (re) | |
cba9bdd2 | 1679 | "Return non-nil if current tag line matches regexp RE." |
9708f7fc RM |
1680 | (save-excursion |
1681 | (beginning-of-line) | |
1682 | (let ((bol (point))) | |
5ed619e0 | 1683 | (and (search-forward "\177" (line-end-position) t) |
9708f7fc RM |
1684 | (re-search-backward re bol t))))) |
1685 | \f | |
6613bf7a CY |
1686 | (defcustom tags-loop-revert-buffers nil |
1687 | "*Non-nil means tags-scanning loops should offer to reread changed files. | |
1688 | These loops normally read each file into Emacs, but when a file | |
1689 | is already visited, they use the existing buffer. | |
1690 | When this flag is non-nil, they offer to revert the existing buffer | |
1691 | in the case where the file has changed since you visited it." | |
d5792fb2 RS |
1692 | :type 'boolean |
1693 | :group 'etags) | |
1694 | ||
c086701a | 1695 | ;;;###autoload |
9708f7fc RM |
1696 | (defun next-file (&optional initialize novisit) |
1697 | "Select next file among files in current tags table. | |
4f1388fd RM |
1698 | |
1699 | A first argument of t (prefix arg, if interactive) initializes to the | |
1700 | beginning of the list of files in the tags table. If the argument is | |
1701 | neither nil nor t, it is evalled to initialize the list of files. | |
9708f7fc RM |
1702 | |
1703 | Non-nil second argument NOVISIT means use a temporary buffer | |
1704 | to save time and avoid uninteresting warnings. | |
1705 | ||
1706 | Value is nil if the file was already visited; | |
1707 | if the file was newly read in, the value is the filename." | |
c20032c4 RS |
1708 | ;; Make the interactive arg t if there was any prefix arg. |
1709 | (interactive (list (if current-prefix-arg t))) | |
4f1388fd RM |
1710 | (cond ((not initialize) |
1711 | ;; Not the first run. | |
1712 | ) | |
1713 | ((eq initialize t) | |
1714 | ;; Initialize the list from the tags table. | |
1715 | (save-excursion | |
1716 | ;; Visit the tags table buffer to get its list of files. | |
1717 | (visit-tags-table-buffer) | |
83287e5b RM |
1718 | ;; Copy the list so we can setcdr below, and expand the file |
1719 | ;; names while we are at it, in this buffer's default directory. | |
1720 | (setq next-file-list (mapcar 'expand-file-name (tags-table-files))) | |
5c9e49a9 RM |
1721 | ;; Iterate over all the tags table files, collecting |
1722 | ;; a complete list of referenced file names. | |
1723 | (while (visit-tags-table-buffer t) | |
1724 | ;; Find the tail of the working list and chain on the new | |
1725 | ;; sublist for this tags table. | |
1726 | (let ((tail next-file-list)) | |
1727 | (while (cdr tail) | |
1728 | (setq tail (cdr tail))) | |
1729 | ;; Use a copy so the next loop iteration will not modify the | |
1730 | ;; list later returned by (tags-table-files). | |
2f14fde6 | 1731 | (if tail |
83287e5b RM |
1732 | (setcdr tail (mapcar 'expand-file-name (tags-table-files))) |
1733 | (setq next-file-list (mapcar 'expand-file-name | |
1734 | (tags-table-files)))))))) | |
4f1388fd RM |
1735 | (t |
1736 | ;; Initialize the list by evalling the argument. | |
1737 | (setq next-file-list (eval initialize)))) | |
7e7b42b2 | 1738 | (unless next-file-list |
5c9e49a9 RM |
1739 | (and novisit |
1740 | (get-buffer " *next-file*") | |
1741 | (kill-buffer " *next-file*")) | |
4fa15f59 | 1742 | (error "All files processed")) |
f042d383 | 1743 | (let* ((next (car next-file-list)) |
d5792fb2 RS |
1744 | (buffer (get-file-buffer next)) |
1745 | (new (not buffer))) | |
f042d383 RM |
1746 | ;; Advance the list before trying to find the file. |
1747 | ;; If we get an error finding the file, don't get stuck on it. | |
1748 | (setq next-file-list (cdr next-file-list)) | |
d5792fb2 RS |
1749 | ;; Optionally offer to revert buffers |
1750 | ;; if the files have changed on disk. | |
1751 | (and buffer tags-loop-revert-buffers | |
1752 | (not (verify-visited-file-modtime buffer)) | |
6613bf7a CY |
1753 | (y-or-n-p |
1754 | (format | |
1755 | (if (buffer-modified-p buffer) | |
1756 | "File %s changed on disk. Discard your edits? " | |
1757 | "File %s changed on disk. Reread from disk? ") | |
1758 | next)) | |
d5792fb2 | 1759 | (with-current-buffer buffer |
6613bf7a | 1760 | (revert-buffer t t))) |
9708f7fc | 1761 | (if (not (and new novisit)) |
7031be6d | 1762 | (find-file next novisit) |
9708f7fc | 1763 | ;; Like find-file, but avoids random warning messages. |
7031be6d | 1764 | (switch-to-buffer (get-buffer-create " *next-file*")) |
9708f7fc RM |
1765 | (kill-all-local-variables) |
1766 | (erase-buffer) | |
f042d383 | 1767 | (setq new next) |
9708f7fc | 1768 | (insert-file-contents new nil)) |
9708f7fc | 1769 | new)) |
ff1f0fa6 | 1770 | |
9708f7fc RM |
1771 | (defvar tags-loop-operate nil |
1772 | "Form for `tags-loop-continue' to eval to change one file.") | |
1773 | ||
0f6b9c32 | 1774 | (defvar tags-loop-scan |
b0b3cce2 KH |
1775 | '(error "%s" |
1776 | (substitute-command-keys | |
4fa15f59 | 1777 | "No \\[tags-search] or \\[tags-query-replace] in progress")) |
9708f7fc RM |
1778 | "Form for `tags-loop-continue' to eval to scan one file. |
1779 | If it returns non-nil, this file needs processing by evalling | |
1780 | \`tags-loop-operate'. Otherwise, move on to the next file.") | |
ff1f0fa6 | 1781 | |
ece6e35a GM |
1782 | (defun tags-loop-eval (form) |
1783 | "Evaluate FORM and return its result. | |
1784 | Bind `case-fold-search' during the evaluation, depending on the value of | |
1785 | `tags-case-fold-search'." | |
1786 | (let ((case-fold-search (if (memq tags-case-fold-search '(t nil)) | |
1787 | tags-case-fold-search | |
1788 | case-fold-search))) | |
1789 | (eval form))) | |
ddc76b00 | 1790 | |
ece6e35a | 1791 | |
c086701a | 1792 | ;;;###autoload |
ff1f0fa6 JB |
1793 | (defun tags-loop-continue (&optional first-time) |
1794 | "Continue last \\[tags-search] or \\[tags-query-replace] command. | |
4f1388fd RM |
1795 | Used noninteractively with non-nil argument to begin such a command (the |
1796 | argument is passed to `next-file', which see). | |
78809db7 RM |
1797 | |
1798 | Two variables control the processing we do on each file: the value of | |
1799 | `tags-loop-scan' is a form to be executed on each file to see if it is | |
1800 | interesting (it returns non-nil if so) and `tags-loop-operate' is a form to | |
1801 | evaluate to operate on an interesting file. If the latter evaluates to | |
1802 | nil, we exit; otherwise we scan the next file." | |
ff1f0fa6 | 1803 | (interactive) |
9708f7fc | 1804 | (let (new |
565c8985 RS |
1805 | ;; Non-nil means we have finished one file |
1806 | ;; and should not scan it again. | |
1807 | file-finished | |
04528cda | 1808 | original-point |
9708f7fc RM |
1809 | (messaged nil)) |
1810 | (while | |
1811 | (progn | |
1812 | ;; Scan files quickly for the first or next interesting one. | |
04528cda | 1813 | ;; This starts at point in the current buffer. |
565c8985 | 1814 | (while (or first-time file-finished |
9708f7fc RM |
1815 | (save-restriction |
1816 | (widen) | |
ece6e35a | 1817 | (not (tags-loop-eval tags-loop-scan)))) |
04528cda GM |
1818 | ;; If nothing was found in the previous file, and |
1819 | ;; that file isn't in a temp buffer, restore point to | |
1820 | ;; where it was. | |
1821 | (when original-point | |
1822 | (goto-char original-point)) | |
1823 | ||
565c8985 | 1824 | (setq file-finished nil) |
9708f7fc | 1825 | (setq new (next-file first-time t)) |
04528cda | 1826 | |
9708f7fc RM |
1827 | ;; If NEW is non-nil, we got a temp buffer, |
1828 | ;; and NEW is the file name. | |
04528cda GM |
1829 | (when (or messaged |
1830 | (and (not first-time) | |
1831 | (> baud-rate search-slow-speed) | |
1832 | (setq messaged t))) | |
1833 | (message "Scanning file %s..." (or new buffer-file-name))) | |
1834 | ||
9708f7fc | 1835 | (setq first-time nil) |
04528cda | 1836 | (setq original-point (if new nil (point))) |
9708f7fc RM |
1837 | (goto-char (point-min))) |
1838 | ||
1839 | ;; If we visited it in a temp buffer, visit it now for real. | |
1840 | (if new | |
1841 | (let ((pos (point))) | |
1842 | (erase-buffer) | |
1843 | (set-buffer (find-file-noselect new)) | |
78809db7 | 1844 | (setq new nil) ;No longer in a temp buffer. |
9708f7fc | 1845 | (widen) |
04528cda GM |
1846 | (goto-char pos)) |
1847 | (push-mark original-point t)) | |
9708f7fc RM |
1848 | |
1849 | (switch-to-buffer (current-buffer)) | |
1850 | ||
1851 | ;; Now operate on the file. | |
1852 | ;; If value is non-nil, continue to scan the next file. | |
ece6e35a | 1853 | (tags-loop-eval tags-loop-operate)) |
565c8985 | 1854 | (setq file-finished t)) |
9708f7fc RM |
1855 | (and messaged |
1856 | (null tags-loop-operate) | |
1857 | (message "Scanning file %s...found" buffer-file-name)))) | |
9708f7fc | 1858 | ;;;###autoload (define-key esc-map "," 'tags-loop-continue) |
ff1f0fa6 | 1859 | |
c086701a | 1860 | ;;;###autoload |
4f1388fd | 1861 | (defun tags-search (regexp &optional file-list-form) |
9708f7fc | 1862 | "Search through all files listed in tags table for match for REGEXP. |
ff1f0fa6 JB |
1863 | Stops when a match is found. |
1864 | To continue searching for next match, use command \\[tags-loop-continue]. | |
1865 | ||
a762e966 | 1866 | If FILE-LIST-FORM is non-nil, it should be a form that, when |
343c3b5a LMI |
1867 | evaluated, will return a list of file names. The search will be |
1868 | restricted to these files. | |
1869 | ||
1870 | Aleso see the documentation of the `tags-file-name' variable." | |
ff1f0fa6 JB |
1871 | (interactive "sTags search (regexp): ") |
1872 | (if (and (equal regexp "") | |
9708f7fc | 1873 | (eq (car tags-loop-scan) 're-search-forward) |
b6176f64 | 1874 | (null tags-loop-operate)) |
9708f7fc | 1875 | ;; Continue last tags-search as if by M-,. |
ff1f0fa6 | 1876 | (tags-loop-continue nil) |
06adf6b1 | 1877 | (setq tags-loop-scan `(re-search-forward ',regexp nil t) |
9708f7fc | 1878 | tags-loop-operate nil) |
4f1388fd | 1879 | (tags-loop-continue (or file-list-form t)))) |
ff1f0fa6 | 1880 | |
c086701a | 1881 | ;;;###autoload |
c575e658 | 1882 | (defun tags-query-replace (from to &optional delimited file-list-form) |
056f8a11 | 1883 | "Do `query-replace-regexp' of FROM with TO on all files listed in tags table. |
ff1f0fa6 | 1884 | Third arg DELIMITED (prefix arg) means replace only word-delimited matches. |
056f8a11 | 1885 | If you exit (\\[keyboard-quit], RET or q), you can resume the query replace |
ff1f0fa6 | 1886 | with the command \\[tags-loop-continue]. |
405b8be3 EZ |
1887 | Fourth arg FILE-LIST-FORM non-nil means initialize the replacement loop. |
1888 | Fifth and sixth arguments START and END are accepted, for compatibility | |
1889 | with `query-replace-regexp', and ignored. | |
ff1f0fa6 | 1890 | |
c575e658 RS |
1891 | If FILE-LIST-FORM is non-nil, it is a form to evaluate to |
1892 | produce the list of files to search. | |
1893 | ||
1894 | See also the documentation of the variable `tags-file-name'." | |
17b9c33c | 1895 | (interactive (query-replace-read-args "Tags query replace (regexp)" t t)) |
06adf6b1 SM |
1896 | (setq tags-loop-scan `(let ,(unless (equal from (downcase from)) |
1897 | '((case-fold-search nil))) | |
1898 | (if (re-search-forward ',from nil t) | |
1899 | ;; When we find a match, move back | |
1900 | ;; to the beginning of it so perform-replace | |
1901 | ;; will see it. | |
1902 | (goto-char (match-beginning 0)))) | |
64b98d12 JL |
1903 | tags-loop-operate `(perform-replace ',from ',to t t ',delimited |
1904 | nil multi-query-replace-map)) | |
4f1388fd | 1905 | (tags-loop-continue (or file-list-form t))) |
9708f7fc | 1906 | \f |
cba9bdd2 | 1907 | (defun tags-complete-tags-table-file (string predicate what) ; Doc string? |
83287e5b RM |
1908 | (save-excursion |
1909 | ;; If we need to ask for the tag table, allow that. | |
1910 | (let ((enable-recursive-minibuffers t)) | |
1911 | (visit-tags-table-buffer)) | |
1912 | (if (eq what t) | |
725349c8 SM |
1913 | (all-completions string (tags-table-files) predicate) |
1914 | (try-completion string (tags-table-files) predicate)))) | |
83287e5b | 1915 | |
c086701a | 1916 | ;;;###autoload |
e02f48d7 | 1917 | (defun list-tags (file &optional _next-match) |
83287e5b RM |
1918 | "Display list of tags in file FILE. |
1919 | This searches only the first table in the list, and no included tables. | |
1920 | FILE should be as it appeared in the `etags' command, usually without a | |
1921 | directory specification." | |
1922 | (interactive (list (completing-read "List tags in file: " | |
1923 | 'tags-complete-tags-table-file | |
1924 | nil t nil))) | |
1925 | (with-output-to-temp-buffer "*Tags List*" | |
7e7b42b2 GM |
1926 | (princ "Tags in file `") |
1927 | (tags-with-face 'highlight (princ file)) | |
1928 | (princ "':\n\n") | |
83287e5b RM |
1929 | (save-excursion |
1930 | (let ((first-time t) | |
1931 | (gotany nil)) | |
1932 | (while (visit-tags-table-buffer (not first-time)) | |
1933 | (setq first-time nil) | |
1934 | (if (funcall list-tags-function file) | |
1935 | (setq gotany t))) | |
1936 | (or gotany | |
7e7b42b2 GM |
1937 | (error "File %s not in current tags tables" file))))) |
1938 | (with-current-buffer "*Tags List*" | |
a6e7bdf1 | 1939 | (require 'apropos) |
6ef254ec RS |
1940 | (with-no-warnings |
1941 | (apropos-mode)) | |
79e01623 | 1942 | (setq buffer-read-only t))) |
ff1f0fa6 | 1943 | |
c086701a | 1944 | ;;;###autoload |
9708f7fc RM |
1945 | (defun tags-apropos (regexp) |
1946 | "Display list of all tags in tags table REGEXP matches." | |
1947 | (interactive "sTags apropos (regexp): ") | |
ff1f0fa6 | 1948 | (with-output-to-temp-buffer "*Tags List*" |
7e7b42b2 GM |
1949 | (princ "Click mouse-2 to follow tags.\n\nTags matching regexp `") |
1950 | (tags-with-face 'highlight (princ regexp)) | |
1951 | (princ "':\n\n") | |
ff1f0fa6 | 1952 | (save-excursion |
47f3c459 RM |
1953 | (let ((first-time t)) |
1954 | (while (visit-tags-table-buffer (not first-time)) | |
1955 | (setq first-time nil) | |
7e7b42b2 GM |
1956 | (funcall tags-apropos-function regexp)))) |
1957 | (etags-tags-apropos-additional regexp)) | |
1958 | (with-current-buffer "*Tags List*" | |
7caf6803 | 1959 | (eval-and-compile (require 'apropos)) |
89228b63 JB |
1960 | (apropos-mode) |
1961 | ;; apropos-mode is derived from fundamental-mode and it kills | |
1962 | ;; all local variables. | |
1963 | (setq buffer-read-only t))) | |
9708f7fc | 1964 | \f |
1ea98518 | 1965 | ;; XXX Kludge interface. |
aa228418 | 1966 | |
36278af3 | 1967 | (define-button-type 'tags-select-tags-table |
29878150 | 1968 | 'action 'select-tags-table-select |
26581f0e | 1969 | 'follow-link t |
36278af3 MY |
1970 | 'help-echo "RET, t or mouse-2: select tags table") |
1971 | ||
9708f7fc | 1972 | ;; XXX If a file is in multiple tables, selection may get the wrong one. |
29add8b9 | 1973 | ;;;###autoload |
9708f7fc RM |
1974 | (defun select-tags-table () |
1975 | "Select a tags table file from a menu of those you have already used. | |
168e43e7 | 1976 | The list of tags tables to select from is stored in `tags-table-set-list'; |
9708f7fc RM |
1977 | see the doc of that variable if you want to add names to the list." |
1978 | (interactive) | |
1979 | (pop-to-buffer "*Tags Table List*") | |
9099b373 GM |
1980 | (setq buffer-read-only nil |
1981 | buffer-undo-list t) | |
9708f7fc | 1982 | (erase-buffer) |
9708f7fc | 1983 | (let ((set-list tags-table-set-list) |
36278af3 MY |
1984 | (desired-point nil) |
1985 | b) | |
7e7b42b2 | 1986 | (when tags-table-list |
29878150 SM |
1987 | (setq desired-point (point-marker)) |
1988 | (setq b (point)) | |
1989 | (princ (mapcar 'abbreviate-file-name tags-table-list) (current-buffer)) | |
1990 | (make-text-button b (point) 'type 'tags-select-tags-table | |
1991 | 'etags-table (car tags-table-list)) | |
7e7b42b2 | 1992 | (insert "\n")) |
9708f7fc | 1993 | (while set-list |
7e7b42b2 | 1994 | (unless (eq (car set-list) tags-table-list) |
36278af3 | 1995 | (setq b (point)) |
29878150 SM |
1996 | (princ (mapcar 'abbreviate-file-name (car set-list)) (current-buffer)) |
1997 | (make-text-button b (point) 'type 'tags-select-tags-table | |
1998 | 'etags-table (car (car set-list))) | |
9708f7fc RM |
1999 | (insert "\n")) |
2000 | (setq set-list (cdr set-list))) | |
7e7b42b2 | 2001 | (when tags-file-name |
29878150 SM |
2002 | (or desired-point |
2003 | (setq desired-point (point-marker))) | |
2004 | (setq b (point)) | |
2005 | (insert (abbreviate-file-name tags-file-name)) | |
2006 | (make-text-button b (point) 'type 'tags-select-tags-table | |
2007 | 'etags-table tags-file-name) | |
7e7b42b2 | 2008 | (insert "\n")) |
9708f7fc | 2009 | (setq set-list (delete tags-file-name |
9993b561 | 2010 | (apply 'nconc (cons (copy-sequence tags-table-list) |
9708f7fc RM |
2011 | (mapcar 'copy-sequence |
2012 | tags-table-set-list))))) | |
2013 | (while set-list | |
36278af3 | 2014 | (setq b (point)) |
29878150 SM |
2015 | (insert (abbreviate-file-name (car set-list))) |
2016 | (make-text-button b (point) 'type 'tags-select-tags-table | |
2017 | 'etags-table (car set-list)) | |
9708f7fc RM |
2018 | (insert "\n") |
2019 | (setq set-list (delete (car set-list) set-list))) | |
a1906d51 | 2020 | (goto-char (point-min)) |
9708f7fc RM |
2021 | (insert-before-markers |
2022 | "Type `t' to select a tags table or set of tags tables:\n\n") | |
2023 | (if desired-point | |
2024 | (goto-char desired-point)) | |
2025 | (set-window-start (selected-window) 1 t)) | |
2026 | (set-buffer-modified-p nil) | |
ef90db45 RS |
2027 | (select-tags-table-mode)) |
2028 | ||
cba9bdd2 | 2029 | (defvar select-tags-table-mode-map ; Doc string? |
29878150 SM |
2030 | (let ((map (make-sparse-keymap))) |
2031 | (set-keymap-parent map button-buffer-map) | |
36278af3 MY |
2032 | (define-key map "t" 'push-button) |
2033 | (define-key map " " 'next-line) | |
2034 | (define-key map "\^?" 'previous-line) | |
2035 | (define-key map "n" 'next-line) | |
2036 | (define-key map "p" 'previous-line) | |
2037 | (define-key map "q" 'select-tags-table-quit) | |
2038 | map)) | |
ef90db45 | 2039 | |
175069ef SM |
2040 | (define-derived-mode select-tags-table-mode special-mode "Select Tags Table" |
2041 | "Major mode for choosing a current tags table among those already loaded." | |
29878150 SM |
2042 | (setq buffer-read-only t)) |
2043 | ||
2044 | (defun select-tags-table-select (button) | |
9708f7fc | 2045 | "Select the tags table named on this line." |
29878150 SM |
2046 | (interactive (list (or (button-at (line-beginning-position)) |
2047 | (error "No tags table on current line")))) | |
2048 | (let ((name (button-get button 'etags-table))) | |
9708f7fc RM |
2049 | (visit-tags-table name) |
2050 | (select-tags-table-quit) | |
2051 | (message "Tags table now %s" name))) | |
49116ac0 | 2052 | |
9708f7fc RM |
2053 | (defun select-tags-table-quit () |
2054 | "Kill the buffer and delete the selected window." | |
2055 | (interactive) | |
7591cf05 | 2056 | (quit-window t (selected-window))) |
9708f7fc | 2057 | \f |
3a07ffce CY |
2058 | ;;;###autoload |
2059 | (defun complete-tag () | |
2060 | "Perform tags completion on the text around point. | |
2061 | Completes to the set of names listed in the current tags table. | |
2062 | The string to complete is chosen in the same way as the default | |
2063 | for \\[find-tag] (which see)." | |
2064 | (interactive) | |
2065 | (or tags-table-list | |
2066 | tags-file-name | |
2067 | (error "%s" | |
2068 | (substitute-command-keys | |
2069 | "No tags table loaded; try \\[visit-tags-table]"))) | |
8c0bf8b3 SM |
2070 | (let ((comp-data (tags-completion-at-point-function))) |
2071 | (if (null comp-data) | |
2072 | (error "Nothing to complete") | |
8f1383f7 GM |
2073 | (completion-in-region (car comp-data) (cadr comp-data) |
2074 | (nth 2 comp-data) | |
2075 | (plist-get (nthcdr 3 comp-data) :predicate))))) | |
3a07ffce | 2076 | |
dd2cedb9 DL |
2077 | (dolist (x '("^No tags table in use; use .* to select one$" |
2078 | "^There is no default tag$" | |
2079 | "^No previous tag locations$" | |
2080 | "^File .* is not a valid tags table$" | |
2081 | "^No \\(more \\|\\)tags \\(matching\\|containing\\) " | |
2082 | "^Rerun etags: `.*' not found in " | |
2083 | "^All files processed$" | |
2084 | "^No .* or .* in progress$" | |
2085 | "^File .* not in current tags tables$" | |
2086 | "^No tags table loaded" | |
2087 | "^Nothing to complete$")) | |
2088 | (add-to-list 'debug-ignored-errors x)) | |
9708f7fc RM |
2089 | \f |
2090 | (provide 'etags) | |
e5167999 ER |
2091 | |
2092 | ;;; etags.el ends here |