(etags-goto-tag-location): If match started with Ctrl-m,
[emacs.git] / lisp / progmodes / etags.el
blobfe7367e96395b652cf00337a14c64be18740f6fc
1 ;;; etags.el --- etags facility for Emacs
3 ;; Copyright (C) 1985, 1986, 1988, 1989, 1992, 1993
4 ;; Free Software Foundation, Inc.
6 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
7 ;; Keywords: tools
9 ;; This file is part of GNU Emacs.
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.
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.
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.
25 ;;; Code:
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: ")
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.")
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.")
50 (defvar tags-table-list-started-at nil
51 "Pointer into `tags-table-list', where the current search started.")
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.")
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.")
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.")
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.")
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.")
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].")
85 ;; Tags table state.
86 ;; These variables are local in tags table buffers.
88 (defvar tag-lines-already-matched nil
89 "List of positions of beginnings of lines within the tags table
90 that are already matched.")
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.")
96 (defvar tags-completion-table nil
97 "Alist of tag names defined in current tags table.")
99 (defvar tags-included-tables nil
100 "List of tags tables included by the current tags table.")
102 (defvar next-file-list nil
103 "List of files for \\[next-file] to process.")
105 ;; Hooks for file formats.
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.")
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 contains a valid
145 \(already initialized\) tags file.")
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))
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.
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)
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)))
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))
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)
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))
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))))
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)))))
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))
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)
262 ;; Local var in visit-tags-table-buffer-cont
263 ;; which is set by tags-table-including.
264 (defvar visit-tags-table-buffer-cont)
266 ;; Subroutine of visit-tags-table-buffer. Frobs its local vars.
267 ;; Search TABLES for one that has tags for THIS-FILE. Recurses on
268 ;; included tables. Returns the tail of TABLES (or of an inner
269 ;; included list) whose car is a table listing THIS-FILE. If
270 ;; CORE-ONLY is non-nil, check only tags tables that are already in
271 ;; buffers--don't visit any new files.
272 (defun tags-table-including (this-file tables core-only &optional recursing)
273 (let ((found nil))
274 ;; Loop over TABLES, looking for one containing tags for THIS-FILE.
275 (while (and (not found)
276 tables)
277 (let ((tags-file-name (tags-expand-table-name (car tables))))
278 (if (or (get-file-buffer tags-file-name)
279 (and (not core-only)
280 (file-exists-p tags-file-name)))
281 (progn
282 ;; Select the tags table buffer and get the file list up to date.
283 (visit-tags-table-buffer 'same)
284 (or tags-table-files
285 (setq tags-table-files
286 (funcall tags-table-files-function)))
288 (cond ((member this-file tags-table-files)
289 ;; Found it.
290 (setq found tables))
292 ((tags-included-tables)
293 ;; This table has included tables. Check them.
294 (let ((old tags-table-parent-pointer-list))
295 (unwind-protect
296 (progn
297 (or recursing
298 ;; At top level (not in an included tags
299 ;; table), set the list to nil so we can
300 ;; collect just the elts from this run.
301 (setq tags-table-parent-pointer-list nil))
302 (setq found
303 ;; Recurse on the list of included tables.
304 (tags-table-including this-file
305 tags-included-tables
306 core-only
308 (if found
309 ;; One of them lists THIS-FILE.
310 ;; Set the table list state variables to move
311 ;; us inside the list of included tables.
312 (setq tags-table-parent-pointer-list
313 (cons
314 (cons tags-table-list-pointer
315 tags-table-list-started-at)
316 tags-table-parent-pointer-list)
317 tags-table-list-pointer found
318 tags-table-list-started-at found
319 ;; Set a local variable of
320 ;; our caller, visit-tags-table-buffer.
321 ;; Set it so we won't frob lists later.
322 visit-tags-table-buffer-cont
323 'included)))
324 (or recursing
325 ;; tags-table-parent-pointer-list now describes
326 ;; the path of included tables taken by recursive
327 ;; invocations of this function. The recursive
328 ;; calls have consed onto the front of the list,
329 ;; so it is now outermost first. We want it
330 ;; innermost first, so reverse it. Then append
331 ;; the old list (from before we were called the
332 ;; outermost time), to get the complete current
333 ;; state of included tables.
334 (setq tags-table-parent-pointer-list
335 (nconc (nreverse
336 tags-table-parent-pointer-list)
337 old))))))))))
338 (setq tables (cdr tables)))
339 found))
341 (defun visit-tags-table-buffer (&optional cont)
342 "Select the buffer containing the current tags table.
343 If optional arg is t, visit the next table in `tags-table-list'.
344 If optional arg is the atom `same', don't look for a new table;
345 just select the buffer visiting `tags-file-name'.
346 If arg is nil or absent, choose a first buffer from information in
347 `tags-file-name', `tags-table-list', `tags-table-list-pointer'.
348 Returns t if it visits a tags table, or nil if there are no more in the list."
350 ;; Set tags-file-name to the tags table file we want to visit.
351 (let ((visit-tags-table-buffer-cont cont))
352 (cond ((eq visit-tags-table-buffer-cont 'same)
353 ;; Use the ambient value of tags-file-name.
354 (or tags-file-name
355 (error (substitute-command-keys
356 (concat "No tags table in use! "
357 "Use \\[visit-tags-table] to select one."))))
358 ;; Set VISIT-TAGS-TABLE-BUFFER-CONT to nil
359 ;; so the code below will make sure tags-file-name
360 ;; is in tags-table-list.
361 (setq visit-tags-table-buffer-cont nil))
363 (visit-tags-table-buffer-cont
364 ;; Find the next table.
365 (if (tags-next-table)
366 ;; Skip over nonexistent files.
367 (while (and (let ((file (tags-expand-table-name tags-file-name)))
368 (not (or (get-file-buffer file)
369 (file-exists-p file))))
370 (tags-next-table)))))
373 ;; Pick a table out of our hat.
374 (setq tags-file-name
376 ;; First, try a local variable.
377 (cdr (assq 'tags-file-name (buffer-local-variables)))
378 ;; Second, try a user-specified function to guess.
379 (and default-tags-table-function
380 (funcall default-tags-table-function))
381 ;; Third, look for a tags table that contains
382 ;; tags for the current buffer's file.
383 ;; If one is found, the lists will be frobnicated,
384 ;; and VISIT-TAGS-TABLE-BUFFER-CONT
385 ;; will be set non-nil so we don't do it below.
386 (car (or
387 ;; First check only tables already in buffers.
388 (save-excursion (tags-table-including buffer-file-name
389 tags-table-list
391 ;; Since that didn't find any, now do the
392 ;; expensive version: reading new files.
393 (save-excursion (tags-table-including buffer-file-name
394 tags-table-list
395 nil))))
396 ;; Fourth, use the user variable tags-file-name, if it is not
397 ;; already in tags-table-list.
398 (and tags-file-name
399 (not (tags-table-list-member tags-file-name))
400 tags-file-name)
401 ;; Fifth, use the user variable giving the table list.
402 ;; Find the first element of the list that actually exists.
403 (let ((list tags-table-list)
404 file)
405 (while (and list
406 (setq file (tags-expand-table-name (car list)))
407 (not (get-file-buffer file))
408 (not (file-exists-p file)))
409 (setq list (cdr list)))
410 (car list))
411 ;; Finally, prompt the user for a file name.
412 (expand-file-name
413 (read-file-name "Visit tags table: (default TAGS) "
414 default-directory
415 "TAGS"
416 t))))))
418 ;; Expand the table name into a full file name.
419 (setq tags-file-name (tags-expand-table-name tags-file-name))
421 (if (and (eq visit-tags-table-buffer-cont t) (null tags-table-list-pointer))
422 ;; All out of tables.
425 ;; Verify that tags-file-name is a valid tags table.
426 (if (if (get-file-buffer tags-file-name)
427 ;; The file is already in a buffer. Check for the visited file
428 ;; having changed since we last used it.
429 (let (win)
430 (set-buffer (get-file-buffer tags-file-name))
431 (setq win (or verify-tags-table-function
432 (initialize-new-tags-table)))
433 (if (or (verify-visited-file-modtime (current-buffer))
434 (not (yes-or-no-p
435 "Tags file has changed, read new contents? ")))
436 (and win (funcall verify-tags-table-function))
437 (revert-buffer t t)
438 (initialize-new-tags-table)))
439 (set-buffer (find-file-noselect tags-file-name))
440 (or (string= tags-file-name buffer-file-name)
441 ;; find-file-noselect has changed the file name.
442 ;; Propagate the change to tags-file-name and tags-table-list.
443 (let ((tail (member tags-file-name tags-table-list)))
444 (if tail
445 (setcar tail buffer-file-name))
446 (setq tags-file-name buffer-file-name)))
447 (initialize-new-tags-table))
449 ;; We have a valid tags table.
450 (progn
451 ;; Bury the tags table buffer so it
452 ;; doesn't get in the user's way.
453 (bury-buffer (current-buffer))
455 (if visit-tags-table-buffer-cont
456 ;; No list frobbing required.
459 ;; Look in the list for the table we chose.
460 (let ((elt (tags-table-list-member tags-file-name)))
461 (or elt
462 ;; The table is not in the current set.
463 ;; Try to find it in another previously used set.
464 (let ((sets tags-table-set-list))
465 (while (and sets
466 (not (setq elt (tags-table-list-member
467 tags-file-name (car sets)))))
468 (setq sets (cdr sets)))
469 (if sets
470 ;; Found in some other set. Switch to that set.
471 (progn
472 (or (memq tags-table-list tags-table-set-list)
473 ;; Save the current list.
474 (setq tags-table-set-list
475 (cons tags-table-list
476 tags-table-set-list)))
477 (setq tags-table-list (car sets)))
479 ;; Not found in any existing set.
480 (if (and tags-table-list
481 (y-or-n-p (concat "Add " tags-file-name
482 " to current list"
483 " of tags tables? ")))
484 ;; Add it to the current list.
485 (setq tags-table-list (cons tags-file-name
486 tags-table-list))
487 ;; Make a fresh list, and store the old one.
488 (or (memq tags-table-list tags-table-set-list)
489 (setq tags-table-set-list
490 (cons tags-table-list tags-table-set-list)))
491 (setq tags-table-list (list tags-file-name)))
492 (setq elt tags-table-list))))
494 ;; Set the tags table list state variables to point at the table
495 ;; we want to use first.
496 (setq tags-table-list-started-at elt
497 tags-table-list-pointer elt)))
499 ;; Return of t says the tags table is valid.
502 ;; The buffer was not valid. Don't use it again.
503 (let ((file tags-file-name))
504 (kill-local-variable 'tags-file-name)
505 (if (eq file tags-file-name)
506 (setq tags-file-name nil)))
507 (error "File %s is not a valid tags table" buffer-file-name)))))
509 (defun file-of-tag ()
510 "Return the file name of the file whose tags point is within.
511 Assumes the tags table is the current buffer.
512 File name returned is relative to tags table file's directory."
513 (funcall file-of-tag-function))
515 ;;;###autoload
516 (defun tags-table-files ()
517 "Return a list of files in the current tags table.
518 Assumes the tags table is the current buffer.
519 File names returned are absolute."
520 (or tags-table-files
521 (setq tags-table-files
522 (funcall tags-table-files-function))))
524 (defun tags-included-tables ()
525 "Return a list of tags tables included by the current table.
526 Assumes the tags table is the current buffer."
527 (or tags-included-tables
528 (setq tags-included-tables (funcall tags-included-tables-function))))
530 ;; Build tags-completion-table on demand. The single current tags table
531 ;; and its included tags tables (and their included tables, etc.) have
532 ;; their tags included in the completion table.
533 (defun tags-completion-table ()
534 (or tags-completion-table
535 (condition-case ()
536 (prog2
537 (message "Making tags completion table for %s..." buffer-file-name)
538 (let ((included (tags-included-tables))
539 (table (funcall tags-completion-table-function)))
540 (save-excursion
541 ;; Iterate over the list of included tables, and combine each
542 ;; included table's completion obarray to the parent obarray.
543 (while included
544 ;; Visit the buffer.
545 (let ((tags-file-name (car included)))
546 (visit-tags-table-buffer 'same))
547 ;; Recurse in that buffer to compute its completion table.
548 (if (tags-completion-table)
549 ;; Combine the tables.
550 (mapatoms (function
551 (lambda (sym)
552 (intern (symbol-name sym) table)))
553 tags-completion-table))
554 (setq included (cdr included))))
555 (setq tags-completion-table table))
556 (message "Making tags completion table for %s...done"
557 buffer-file-name))
558 (quit (message "Tags completion table construction aborted.")
559 (setq tags-completion-table nil)))))
561 ;; Completion function for tags. Does normal try-completion,
562 ;; but builds tags-completion-table on demand.
563 (defun tags-complete-tag (string predicate what)
564 (save-excursion
565 (visit-tags-table-buffer)
566 (if (eq what t)
567 (all-completions string (tags-completion-table) predicate)
568 (try-completion string (tags-completion-table) predicate))))
570 ;; Return a default tag to search for, based on the text at point.
571 (defun find-tag-default ()
572 (save-excursion
573 (while (looking-at "\\sw\\|\\s_")
574 (forward-char 1))
575 (if (or (re-search-backward "\\sw\\|\\s_"
576 (save-excursion (beginning-of-line) (point))
578 (re-search-forward "\\(\\sw\\|\\s_\\)+"
579 (save-excursion (end-of-line) (point))
581 (progn (goto-char (match-end 0))
582 (buffer-substring (point)
583 (progn (forward-sexp -1)
584 (while (looking-at "\\s'")
585 (forward-char 1))
586 (point))))
587 nil)))
589 ;; Read a tag name from the minibuffer with defaulting and completion.
590 (defun find-tag-tag (string)
591 (let* ((default (funcall (or find-tag-default-function
592 (get major-mode 'find-tag-default-function)
593 'find-tag-default)))
594 (spec (completing-read (if default
595 (format "%s(default %s) " string default)
596 string)
597 'tags-complete-tag)))
598 (if (equal spec "")
599 (or default (error "There is no default tag"))
600 spec)))
602 (defvar last-tag nil
603 "Last tag found by \\[find-tag].")
605 ;; Get interactive args for find-tag{-noselect,-other-window,-regexp}.
606 (defun find-tag-interactive (prompt &optional no-default)
607 (if current-prefix-arg
608 (list nil (if (< (prefix-numeric-value current-prefix-arg) 0)
611 (list (if no-default
612 (read-string prompt)
613 (find-tag-tag prompt)))))
615 ;;;###autoload
616 (defun find-tag-noselect (tagname &optional next-p regexp-p)
617 "Find tag (in current tags table) whose name contains TAGNAME.
618 Returns the buffer containing the tag's definition and moves its point there,
619 but does not select the buffer.
620 The default for TAGNAME is the expression in the buffer near point.
622 If second arg NEXT-P is t (interactively, with prefix arg), search for
623 another tag that matches the last tagname or regexp used. When there are
624 multiple matches for a tag, more exact matches are found first. If NEXT-P
625 is the atom `-' (interactively, with prefix arg that is a negative number
626 or just \\[negative-argument]), pop back to the previous tag gone to.
628 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
630 See documentation of variable `tags-file-name'."
631 (interactive (find-tag-interactive "Find tag: "))
633 ;; Save the current buffer's value of `find-tag-hook' before selecting the
634 ;; tags table buffer.
635 (let ((local-find-tag-hook find-tag-hook))
636 (if (eq '- next-p)
637 ;; Pop back to a previous location.
638 (if (null tags-location-stack)
639 (error "No previous tag locations")
640 (let ((marker (car tags-location-stack)))
641 ;; Pop the stack.
642 (setq tags-location-stack (cdr tags-location-stack))
643 (prog1
644 ;; Move to the saved location.
645 (set-buffer (marker-buffer marker))
646 (goto-char (marker-position marker))
647 ;; Kill that marker so it doesn't slow down editing.
648 (set-marker marker nil nil)
649 ;; Run the user's hook. Do we really want to do this for pop?
650 (run-hooks 'local-find-tag-hook))))
651 (if next-p
652 ;; Find the same table we last used.
653 (visit-tags-table-buffer 'same)
654 ;; Pick a table to use.
655 (visit-tags-table-buffer)
656 ;; Record TAGNAME for a future call with NEXT-P non-nil.
657 (setq last-tag tagname))
658 (prog1
659 ;; Record the location so we can pop back to it later.
660 (marker-buffer
661 (car
662 (setq tags-location-stack
663 (cons (let ((marker (make-marker)))
664 (save-excursion
665 (set-buffer
666 ;; find-tag-in-order does the real work.
667 (find-tag-in-order
668 (if next-p last-tag tagname)
669 (if regexp-p
670 find-tag-regexp-search-function
671 find-tag-search-function)
672 (if regexp-p
673 find-tag-regexp-tag-order
674 find-tag-tag-order)
675 (if regexp-p
676 find-tag-regexp-next-line-after-failure-p
677 find-tag-next-line-after-failure-p)
678 (if regexp-p "matching" "containing")
679 (not next-p)))
680 (set-marker marker (point))))
681 tags-location-stack))))
682 (run-hooks 'local-find-tag-hook)))))
684 ;;;###autoload
685 (defun find-tag (tagname &optional next-p regexp-p)
686 "Find tag (in current tags table) whose name contains TAGNAME.
687 Select the buffer containing the tag's definition, and move point there.
688 The default for TAGNAME is the expression in the buffer around or before point.
690 If second arg NEXT-P is t (interactively, with prefix arg), search for
691 another tag that matches the last tagname or regexp used. When there are
692 multiple matches for a tag, more exact matches are found first. If NEXT-P
693 is the atom `-' (interactively, with prefix arg that is a negative number
694 or just \\[negative-argument]), pop back to the previous tag gone to.
696 See documentation of variable `tags-file-name'."
697 (interactive (find-tag-interactive "Find tag: "))
698 (switch-to-buffer (find-tag-noselect tagname next-p regexp-p)))
699 ;;;###autoload (define-key esc-map "." 'find-tag)
701 ;;;###autoload
702 (defun find-tag-other-window (tagname &optional next-p regexp-p)
703 "Find tag (in current tags table) whose name contains TAGNAME.
704 Select the buffer containing the tag's definition in another window, and
705 move point there. The default for TAGNAME is the expression in the buffer
706 around or before point.
708 If second arg NEXT-P is t (interactively, with prefix arg), search for
709 another tag that matches the last tagname or regexp used. When there are
710 multiple matches for a tag, more exact matches are found first. If NEXT-P
711 is negative (interactively, with prefix arg that is a negative number or
712 just \\[negative-argument]), pop back to the previous tag gone to.
714 See documentation of variable `tags-file-name'."
715 (interactive (find-tag-interactive "Find tag other window: "))
717 ;; This hair is to deal with the case where the tag is found in the
718 ;; selected window's buffer; without the hair, point is moved in both
719 ;; windows. To prevent this, we save the selected window's point before
720 ;; doing find-tag-noselect, and restore it after.
721 (let* ((window-point (window-point (selected-window)))
722 (tagbuf (find-tag-noselect tagname next-p regexp-p))
723 (tagpoint (progn (set-buffer tagbuf) (point))))
724 (set-window-point (prog1
725 (selected-window)
726 (switch-to-buffer-other-window tagbuf)
727 ;; We have to set this new window's point; it
728 ;; might already have been displaying a
729 ;; different portion of tagbuf, in which case
730 ;; switch-to-buffer-other-window doesn't set
731 ;; the window's point from the buffer.
732 (set-window-point (selected-window) tagpoint))
733 window-point)))
734 ;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)
736 ;;;###autoload
737 (defun find-tag-other-frame (tagname &optional next-p)
738 "Find tag (in current tags table) whose name contains TAGNAME.
739 Select the buffer containing the tag's definition in another frame, and
740 move point there. The default for TAGNAME is the expression in the buffer
741 around or before point.
743 If second arg NEXT-P is t (interactively, with prefix arg), search for
744 another tag that matches the last tagname or regexp used. When there are
745 multiple matches for a tag, more exact matches are found first. If NEXT-P
746 is negative (interactively, with prefix arg that is a negative number or
747 just \\[negative-argument]), pop back to the previous tag gone to.
749 See documentation of variable `tags-file-name'."
750 (interactive (find-tag-interactive "Find tag other frame: "))
751 (let ((pop-up-frames t))
752 (find-tag-other-window tagname next-p)))
753 ;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame)
755 ;;;###autoload
756 (defun find-tag-regexp (regexp &optional next-p other-window)
757 "Find tag (in current tags table) whose name matches REGEXP.
758 Select the buffer containing the tag's definition and move point there.
760 If second arg NEXT-P is t (interactively, with prefix arg), search for
761 another tag that matches the last tagname or regexp used. When there are
762 multiple matches for a tag, more exact matches are found first. If NEXT-P
763 is negative (interactively, with prefix arg that is a negative number or
764 just \\[negative-argument]), pop back to the previous tag gone to.
766 If third arg OTHER-WINDOW is non-nil, select the buffer in another window.
768 See documentation of variable `tags-file-name'."
769 (interactive (find-tag-interactive "Find tag regexp: " t))
770 ;; We go through find-tag-other-window to do all the display hair there.
771 (funcall (if other-window 'find-tag-other-window 'find-tag)
772 regexp next-p t))
774 ;; Internal tag finding function.
776 ;; PATTERN is a string to pass to second arg SEARCH-FORWARD-FUNC, and to
777 ;; any member of the function list ORDER (third arg). If ORDER is nil,
778 ;; use saved state to continue a previous search.
780 ;; Fourth arg MATCHING is a string, an English '-ing' word, to be used in
781 ;; an error message.
783 ;; Fifth arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match,
784 ;; point should be moved to the next line.
786 ;; Algorithm is as follows. For each qualifier-func in ORDER, go to
787 ;; beginning of tags file, and perform inner loop: for each naive match for
788 ;; PATTERN found using SEARCH-FORWARD-FUNC, qualify the naive match using
789 ;; qualifier-func. If it qualifies, go to the specified line in the
790 ;; specified source file and return. Qualified matches are remembered to
791 ;; avoid repetition. State is saved so that the loop can be continued.
793 (defun find-tag-in-order (pattern
794 search-forward-func
795 order
796 next-line-after-failure-p
797 matching
798 first-search)
799 (let (file ;name of file containing tag
800 tag-info ;where to find the tag in FILE
801 tags-table-file ;name of tags file
802 (first-table t)
803 (tag-order order)
804 goto-func
806 (save-excursion
807 (or first-search ;find-tag-noselect has already done it.
808 (visit-tags-table-buffer 'same))
810 ;; Get a qualified match.
811 (catch 'qualified-match-found
813 ;; Iterate over the list of tags tables.
814 (while (or first-table
815 (visit-tags-table-buffer t))
817 (if first-search
818 (setq tag-lines-already-matched nil))
820 (and first-search first-table
821 ;; Start at beginning of tags file.
822 (goto-char (point-min)))
823 (setq first-table nil)
825 (setq tags-table-file buffer-file-name)
826 ;; Iterate over the list of ordering predicates.
827 (while order
828 (while (funcall search-forward-func pattern nil t)
829 ;; Naive match found. Qualify the match.
830 (and (funcall (car order) pattern)
831 ;; Make sure it is not a previous qualified match.
832 ;; Use of `memq' depends on numbers being eq.
833 (not (memq (save-excursion (beginning-of-line) (point))
834 tag-lines-already-matched))
835 (throw 'qualified-match-found nil))
836 (if next-line-after-failure-p
837 (forward-line 1)))
838 ;; Try the next flavor of match.
839 (setq order (cdr order))
840 (goto-char (point-min)))
841 (setq order tag-order))
842 ;; We throw out on match, so only get here if there were no matches.
843 (error "No %stags %s %s" (if first-search "" "more ")
844 matching pattern))
846 ;; Found a tag; extract location info.
847 (beginning-of-line)
848 (setq tag-lines-already-matched (cons (point)
849 tag-lines-already-matched))
850 ;; Expand the filename, using the tags table buffer's default-directory.
851 (setq file (expand-file-name (file-of-tag))
852 tag-info (funcall snarf-tag-function))
854 ;; Get the local value in the tags table buffer before switching buffers.
855 (setq goto-func goto-tag-location-function)
857 ;; Find the right line in the specified file.
858 (set-buffer (find-file-noselect file))
859 (widen)
860 (push-mark)
861 (funcall goto-func tag-info)
863 ;; Give this buffer a local value of tags-file-name.
864 ;; The next time visit-tags-table-buffer is called,
865 ;; it will use the same tags table that found a match in this buffer.
866 (make-local-variable 'tags-file-name)
867 (setq tags-file-name tags-table-file)
869 ;; Return the buffer where the tag was found.
870 (current-buffer))))
872 ;; `etags' TAGS file format support.
874 ;; If the current buffer is a valid etags TAGS file, give it local values of
875 ;; the tags table format variables, and return non-nil.
876 (defun etags-recognize-tags-table ()
877 (and (etags-verify-tags-table)
878 ;; It is annoying to flash messages on the screen briefly,
879 ;; and this message is not useful. -- rms
880 ;; (message "%s is an `etags' TAGS file" buffer-file-name)
881 (mapcar (function (lambda (elt)
882 (set (make-local-variable (car elt)) (cdr elt))))
883 '((file-of-tag-function . etags-file-of-tag)
884 (tags-table-files-function . etags-tags-table-files)
885 (tags-completion-table-function . etags-tags-completion-table)
886 (snarf-tag-function . etags-snarf-tag)
887 (goto-tag-location-function . etags-goto-tag-location)
888 (find-tag-regexp-search-function . re-search-forward)
889 (find-tag-regexp-tag-order . (tag-re-match-p))
890 (find-tag-regexp-next-line-after-failure-p . t)
891 (find-tag-search-function . search-forward)
892 (find-tag-tag-order . (tag-exact-match-p tag-word-match-p
893 tag-any-match-p))
894 (find-tag-next-line-after-failure-p . nil)
895 (list-tags-function . etags-list-tags)
896 (tags-apropos-function . etags-tags-apropos)
897 (tags-included-tables-function . etags-tags-included-tables)
898 (verify-tags-table-function . etags-verify-tags-table)
899 ))))
901 ;; Return non-nil iff the current buffer is a valid etags TAGS file.
902 (defun etags-verify-tags-table ()
903 ;; Use eq instead of = in case char-after returns nil.
904 (eq (char-after 1) ?\f))
906 (defun etags-file-of-tag ()
907 (save-excursion
908 (search-backward "\f\n")
909 (forward-char 2)
910 (buffer-substring (point)
911 (progn (skip-chars-forward "^,") (point)))))
913 (defun etags-tags-completion-table ()
914 (let ((table (make-vector 511 0)))
915 (save-excursion
916 (goto-char (point-min))
917 ;; This monster regexp matches an etags tag line.
918 ;; \1 is the string to match;
919 ;; \2 is not interesting;
920 ;; \3 is the guessed tag name; XXX guess should be better eg DEFUN
921 ;; \4 is not interesting;
922 ;; \5 is the explicitly-specified tag name.
923 ;; \6 is the line to start searching at;
924 ;; \7 is the char to start searching at.
925 (while (re-search-forward
926 "^\\(\\(.+[^-a-zA-Z0-9_$]+\\)?\\([-a-zA-Z0-9_$]+\\)\
927 \[^-a-zA-Z0-9_$]*\\)\177\\(\\([^\n\001]+\\)\001\\)?\\([0-9]+\\),\\([0-9]+\\)\n"
928 nil t)
929 (intern (if (match-beginning 5)
930 ;; There is an explicit tag name.
931 (buffer-substring (match-beginning 5) (match-end 5))
932 ;; No explicit tag name. Best guess.
933 (buffer-substring (match-beginning 3) (match-end 3)))
934 table)))
935 table))
937 (defun etags-snarf-tag ()
938 (let (tag-text startpos)
939 (search-forward "\177")
940 (setq tag-text (buffer-substring (1- (point))
941 (save-excursion (beginning-of-line)
942 (point))))
943 ;; Skip explicit tag name if present.
944 (search-forward "\001" (save-excursion (forward-line 1) (point)) t)
945 (search-forward ",")
946 (setq startpos (string-to-int (buffer-substring
947 (point)
948 (progn (skip-chars-forward "0-9")
949 (point)))))
950 ;; Leave point on the next line of the tags file.
951 (forward-line 1)
952 (cons tag-text startpos)))
954 (defun etags-goto-tag-location (tag-info)
955 (let ((startpos (cdr tag-info))
956 ;; This constant is 1/2 the initial search window.
957 ;; There is no sense in making it too small,
958 ;; since just going around the loop once probably
959 ;; costs about as much as searching 2000 chars.
960 (offset 1000)
961 (found nil)
962 (pat (concat (if (eq selective-display t)
963 "\\(^\\|\^m\\)" "^")
964 (regexp-quote (car tag-info)))))
965 (or startpos
966 (setq startpos (point-min)))
967 (while (and (not found)
968 (progn
969 (goto-char (- startpos offset))
970 (not (bobp))))
971 (setq found
972 (re-search-forward pat (+ startpos offset) t)
973 offset (* 3 offset))) ; expand search window
974 (or found
975 (re-search-forward pat nil t)
976 (error "`%s' not found in %s; time to rerun etags"
977 pat buffer-file-name)))
978 ;; Position point at the right place
979 ;; if the search string matched an extra Ctrl-m at the beginning.
980 (and (eq selective-display t)
981 (looking-at "\^m")
982 (forward-char 1))
983 (beginning-of-line))
985 (defun etags-list-tags (file)
986 (goto-char 1)
987 (if (not (search-forward (concat "\f\n" file ",") nil t))
989 (forward-line 1)
990 (while (not (or (eobp) (looking-at "\f")))
991 (princ (buffer-substring (point)
992 (progn (skip-chars-forward "^\177")
993 (point))))
994 (terpri)
995 (forward-line 1))))
997 (defun etags-tags-apropos (string)
998 (goto-char 1)
999 (while (re-search-forward string nil t)
1000 (beginning-of-line)
1001 (princ (buffer-substring (point)
1002 (progn (skip-chars-forward "^\177")
1003 (point))))
1004 (terpri)
1005 (forward-line 1)))
1007 (defun etags-tags-table-files ()
1008 (let ((files nil)
1009 beg)
1010 (goto-char (point-min))
1011 (while (search-forward "\f\n" nil t)
1012 (setq beg (point))
1013 (skip-chars-forward "^,\n")
1014 (or (looking-at ",include$")
1015 ;; Expand in the default-directory of the tags table buffer.
1016 (setq files (cons (expand-file-name (buffer-substring beg (point)))
1017 files))))
1018 (nreverse files)))
1020 (defun etags-tags-included-tables ()
1021 (let ((files nil)
1022 beg)
1023 (goto-char (point-min))
1024 (while (search-forward "\f\n" nil t)
1025 (setq beg (point))
1026 (skip-chars-forward "^,\n")
1027 (if (looking-at ",include$")
1028 ;; Expand in the default-directory of the tags table buffer.
1029 (setq files (cons (expand-file-name (buffer-substring beg (point)))
1030 files))))
1031 (nreverse files)))
1033 ;; Empty tags file support.
1035 ;; Recognize an empty file and give it local values of the tags table format
1036 ;; variables which do nothing.
1037 (defun recognize-empty-tags-table ()
1038 (and (zerop (buffer-size))
1039 (mapcar (function (lambda (sym)
1040 (set (make-local-variable sym) 'ignore)))
1041 '(tags-table-files-function
1042 tags-completion-table-function
1043 find-tag-regexp-search-function
1044 find-tag-search-function
1045 tags-apropos-function
1046 tags-included-tables-function))
1047 (set (make-local-variable 'verify-tags-table-function)
1048 (function (lambda ()
1049 (zerop (buffer-size)))))))
1051 ;;; Match qualifier functions for tagnames.
1052 ;;; XXX these functions assume etags file format.
1054 ;; This might be a neat idea, but it's too hairy at the moment.
1055 ;;(defmacro tags-with-syntax (&rest body)
1056 ;; (` (let ((current (current-buffer))
1057 ;; (otable (syntax-table))
1058 ;; (buffer (find-file-noselect (file-of-tag)))
1059 ;; table)
1060 ;; (unwind-protect
1061 ;; (progn
1062 ;; (set-buffer buffer)
1063 ;; (setq table (syntax-table))
1064 ;; (set-buffer current)
1065 ;; (set-syntax-table table)
1066 ;; (,@ body))
1067 ;; (set-syntax-table otable)))))
1068 ;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form))
1070 ;; t if point is at a tag line that matches TAG "exactly".
1071 ;; point should be just after a string that matches TAG.
1072 (defun tag-exact-match-p (tag)
1073 (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177") ;not a symbol char
1074 (save-excursion
1075 (backward-char (1+ (length tag)))
1076 (and (looking-at "\\Sw") (looking-at "\\S_")))))
1078 ;; t if point is at a tag line that matches TAG as a word.
1079 ;; point should be just after a string that matches TAG.
1080 (defun tag-word-match-p (tag)
1081 (and (looking-at "\\b.*\177")
1082 (save-excursion (backward-char (1+ (length tag)))
1083 (looking-at "\\b"))))
1085 ;; t if point is in a tag line with a tag containing TAG as a substring.
1086 (defun tag-any-match-p (tag)
1087 (looking-at ".*\177"))
1089 ;; t if point is at a tag line that matches RE as a regexp.
1090 (defun tag-re-match-p (re)
1091 (save-excursion
1092 (beginning-of-line)
1093 (let ((bol (point)))
1094 (and (search-forward "\177" (save-excursion (end-of-line) (point)) t)
1095 (re-search-backward re bol t)))))
1097 ;;;###autoload
1098 (defun next-file (&optional initialize novisit)
1099 "Select next file among files in current tags table.
1100 Non-nil first argument (prefix arg, if interactive)
1101 initializes to the beginning of the list of files in the tags table.
1103 Non-nil second argument NOVISIT means use a temporary buffer
1104 to save time and avoid uninteresting warnings.
1106 Value is nil if the file was already visited;
1107 if the file was newly read in, the value is the filename."
1108 (interactive "P")
1109 (and initialize
1110 (save-excursion
1111 ;; Visit the tags table buffer to get its list of files.
1112 (visit-tags-table-buffer)
1113 (setq next-file-list (tags-table-files))))
1114 (or next-file-list
1115 (save-excursion
1116 ;; Get the files from the next tags table.
1117 ;; When doing (visit-tags-table-buffer t),
1118 ;; the tags table buffer must be current.
1119 (if (and (visit-tags-table-buffer 'same)
1120 (visit-tags-table-buffer t))
1121 (setq next-file-list (tags-table-files))
1122 (and novisit
1123 (get-buffer " *next-file*")
1124 (kill-buffer " *next-file*"))
1125 (error "All files processed."))))
1126 (let ((new (not (get-file-buffer (car next-file-list)))))
1127 (if (not (and new novisit))
1128 (set-buffer (find-file-noselect (car next-file-list) novisit))
1129 ;; Like find-file, but avoids random warning messages.
1130 (set-buffer (get-buffer-create " *next-file*"))
1131 (kill-all-local-variables)
1132 (erase-buffer)
1133 (setq new (car next-file-list))
1134 (insert-file-contents new nil))
1135 (setq next-file-list (cdr next-file-list))
1136 new))
1138 (defvar tags-loop-operate nil
1139 "Form for `tags-loop-continue' to eval to change one file.")
1141 (defvar tags-loop-scan
1142 '(error (substitute-command-keys
1143 "No \\[tags-search] or \\[tags-query-replace] in progress."))
1144 "Form for `tags-loop-continue' to eval to scan one file.
1145 If it returns non-nil, this file needs processing by evalling
1146 \`tags-loop-operate'. Otherwise, move on to the next file.")
1148 ;;;###autoload
1149 (defun tags-loop-continue (&optional first-time)
1150 "Continue last \\[tags-search] or \\[tags-query-replace] command.
1151 Used noninteractively with non-nil argument to begin such a command.
1152 Two variables control the processing we do on each file:
1153 the value of `tags-loop-scan' is a form to be executed on each file
1154 to see if it is interesting (it returns non-nil if so)
1155 and `tags-loop-operate' is a form to execute to operate on an interesting file
1156 If the latter returns non-nil, we exit; otherwise we scan the next file."
1157 (interactive)
1158 (let (new
1159 (messaged nil))
1160 (while
1161 (progn
1162 ;; Scan files quickly for the first or next interesting one.
1163 (while (or first-time
1164 (save-restriction
1165 (widen)
1166 (not (eval tags-loop-scan))))
1167 (setq new (next-file first-time t))
1168 ;; If NEW is non-nil, we got a temp buffer,
1169 ;; and NEW is the file name.
1170 (if (or messaged
1171 (and (not first-time)
1172 (> baud-rate search-slow-speed)
1173 (setq messaged t)))
1174 (message "Scanning file %s..." (or new buffer-file-name)))
1175 (setq first-time nil)
1176 (goto-char (point-min)))
1178 ;; If we visited it in a temp buffer, visit it now for real.
1179 (if new
1180 (let ((pos (point)))
1181 (erase-buffer)
1182 (set-buffer (find-file-noselect new))
1183 (widen)
1184 (goto-char pos)))
1186 (switch-to-buffer (current-buffer))
1188 ;; Now operate on the file.
1189 ;; If value is non-nil, continue to scan the next file.
1190 (eval tags-loop-operate)))
1191 (and messaged
1192 (null tags-loop-operate)
1193 (message "Scanning file %s...found" buffer-file-name))))
1194 ;;;###autoload (define-key esc-map "," 'tags-loop-continue)
1196 ;;;###autoload
1197 (defun tags-search (regexp)
1198 "Search through all files listed in tags table for match for REGEXP.
1199 Stops when a match is found.
1200 To continue searching for next match, use command \\[tags-loop-continue].
1202 See documentation of variable `tags-file-name'."
1203 (interactive "sTags search (regexp): ")
1204 (if (and (equal regexp "")
1205 (eq (car tags-loop-scan) 're-search-forward)
1206 (null tags-loop-operate))
1207 ;; Continue last tags-search as if by M-,.
1208 (tags-loop-continue nil)
1209 (setq tags-loop-scan
1210 (list 're-search-forward regexp nil t)
1211 tags-loop-operate nil)
1212 (tags-loop-continue t)))
1214 ;;;###autoload
1215 (defun tags-query-replace (from to &optional delimited)
1216 "Query-replace-regexp FROM with TO through all files listed in tags table.
1217 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1218 If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace
1219 with the command \\[tags-loop-continue].
1221 See documentation of variable `tags-file-name'."
1222 (interactive
1223 "sTags query replace (regexp): \nsTags query replace %s by: \nP")
1224 (setq tags-loop-scan (list 'prog1
1225 (list 'if (list 're-search-forward from nil t)
1226 ;; When we find a match, move back
1227 ;; to the beginning of it so perform-replace
1228 ;; will see it.
1229 '(goto-char (match-beginning 0))))
1230 tags-loop-operate (list 'perform-replace from to t t delimited))
1231 (tags-loop-continue t))
1233 ;;;###autoload
1234 (defun list-tags (file)
1235 "Display list of tags in file FILE.
1236 FILE should not contain a directory specification
1237 unless it has one in the tags table."
1238 (interactive (list (completing-read "List tags in file: " nil
1239 'tags-table-files t nil)))
1240 (with-output-to-temp-buffer "*Tags List*"
1241 (princ "Tags in file ")
1242 (princ file)
1243 (terpri)
1244 (save-excursion
1245 (let ((first-time t)
1246 (gotany nil))
1247 (while (visit-tags-table-buffer (not first-time))
1248 (if (funcall list-tags-function file)
1249 (setq gotany t)))
1250 (or gotany
1251 (error "File %s not in current tags tables"))))))
1253 ;;;###autoload
1254 (defun tags-apropos (regexp)
1255 "Display list of all tags in tags table REGEXP matches."
1256 (interactive "sTags apropos (regexp): ")
1257 (with-output-to-temp-buffer "*Tags List*"
1258 (princ "Tags matching regexp ")
1259 (prin1 regexp)
1260 (terpri)
1261 (save-excursion
1262 (let ((first-time t))
1263 (while (visit-tags-table-buffer (not first-time))
1264 (setq first-time nil)
1265 (funcall tags-apropos-function regexp))))))
1267 ;;; XXX Kludge interface.
1269 ;; XXX If a file is in multiple tables, selection may get the wrong one.
1270 ;;;###autoload
1271 (defun select-tags-table ()
1272 "Select a tags table file from a menu of those you have already used.
1273 The list of tags tables to select from is stored in `tags-table-file-list';
1274 see the doc of that variable if you want to add names to the list."
1275 (interactive)
1276 (pop-to-buffer "*Tags Table List*")
1277 (setq buffer-read-only nil)
1278 (erase-buffer)
1279 (setq selective-display t
1280 selective-display-ellipses nil)
1281 (let ((set-list tags-table-set-list)
1282 (desired-point nil))
1283 (if tags-table-list
1284 (progn
1285 (setq desired-point (point-marker))
1286 (princ tags-table-list (current-buffer))
1287 (insert "\C-m")
1288 (prin1 (car tags-table-list) (current-buffer)) ;invisible
1289 (insert "\n")))
1290 (while set-list
1291 (if (eq (car set-list) tags-table-list)
1292 ;; Already printed it.
1294 (princ (car set-list) (current-buffer))
1295 (insert "\C-m")
1296 (prin1 (car (car set-list)) (current-buffer)) ;invisible
1297 (insert "\n"))
1298 (setq set-list (cdr set-list)))
1299 (if tags-file-name
1300 (progn
1301 (or desired-point
1302 (setq desired-point (point-marker)))
1303 (insert tags-file-name "\C-m")
1304 (prin1 tags-file-name (current-buffer)) ;invisible
1305 (insert "\n")))
1306 (setq set-list (delete tags-file-name
1307 (apply 'nconc (cons tags-table-list
1308 (mapcar 'copy-sequence
1309 tags-table-set-list)))))
1310 (while set-list
1311 (insert (car set-list) "\C-m")
1312 (prin1 (car set-list) (current-buffer)) ;invisible
1313 (insert "\n")
1314 (setq set-list (delete (car set-list) set-list)))
1315 (goto-char 1)
1316 (insert-before-markers
1317 "Type `t' to select a tags table or set of tags tables:\n\n")
1318 (if desired-point
1319 (goto-char desired-point))
1320 (set-window-start (selected-window) 1 t))
1321 (set-buffer-modified-p nil)
1322 (setq buffer-read-only t
1323 mode-name "Select Tags Table")
1324 (let ((map (make-sparse-keymap)))
1325 (define-key map "t" 'select-tags-table-select)
1326 (define-key map " " 'next-line)
1327 (define-key map "\^?" 'previous-line)
1328 (define-key map "n" 'next-line)
1329 (define-key map "p" 'previous-line)
1330 (define-key map "q" 'select-tags-table-quit)
1331 (use-local-map map)))
1333 (defun select-tags-table-select ()
1334 "Select the tags table named on this line."
1335 (interactive)
1336 (search-forward "\C-m")
1337 (let ((name (read (current-buffer))))
1338 (visit-tags-table name)
1339 (select-tags-table-quit)
1340 (message "Tags table now %s" name)))
1342 (defun select-tags-table-quit ()
1343 "Kill the buffer and delete the selected window."
1344 (interactive)
1345 (kill-buffer (current-buffer))
1346 (or (one-window-p)
1347 (delete-window)))
1349 ;;;###autoload
1350 (defun complete-tag ()
1351 "Perform tags completion on the text around point.
1352 Completes to the set of names listed in the current tags table.
1353 The string to complete is chosen in the same way as the default
1354 for \\[find-tag] (which see)."
1355 (interactive)
1356 (or tags-table-list
1357 tags-file-name
1358 (error (substitute-command-keys
1359 "No tags table loaded. Try \\[visit-tags-table].")))
1360 (let ((pattern (funcall (or find-tag-default-function
1361 (get major-mode 'find-tag-default-function)
1362 'find-tag-default)))
1364 completion)
1365 (or pattern
1366 (error "Nothing to complete"))
1367 (search-backward pattern)
1368 (setq beg (point))
1369 (forward-char (length pattern))
1370 (setq completion (try-completion pattern 'tags-complete-tag nil))
1371 (cond ((eq completion t))
1372 ((null completion)
1373 (message "Can't find completion for \"%s\"" pattern)
1374 (ding))
1375 ((not (string= pattern completion))
1376 (delete-region beg (point))
1377 (insert completion))
1379 (message "Making completion list...")
1380 (with-output-to-temp-buffer " *Completions*"
1381 (display-completion-list
1382 (all-completions pattern 'tags-complete-tag nil)))
1383 (message "Making completion list...%s" "done")))))
1385 ;;;###autoload (define-key esc-map "\t" 'complete-tag)
1387 (provide 'etags)
1389 ;;; etags.el ends here