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