1 ;; etags.el --- etags facility for Emacs
3 ;; Copyright (C) 1985, 1986, 1988, 1989, 1992 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 (defvar tags-file-name nil "\
28 *File name of tags table.
29 To switch to a new tags table, setting this variable is sufficient.
30 Use the `etags' program to make a tags table file.")
31 ;;;###autoload (put 'tags-file-name 'variable-interactive "fVisit tags table: ")
34 (defvar tags-table-list nil
35 "*List of names of tags table files which are currently being searched.
36 Elements that are directories mean the file \"TAGS\" in that directory.
37 An element of nil means to look for a file \"TAGS\" in the current directory.
38 Use `visit-tags-table-buffer' to cycle through tags tables in this list.")
40 (defvar tags-table-list-pointer nil
41 "Pointer into `tags-table-list' where the current state of searching is.
42 Might instead point into a list of included tags tables.
43 Use `visit-tags-table-buffer' to cycle through tags tables in this list.")
45 (defvar tags-table-list-started-at nil
46 "Pointer into `tags-table-list', where the current search started.")
48 (defvar tags-table-parent-pointer-list nil
49 "Saved state of the tags table that included this one.
50 Each element is (POINTER . STARTED-AT), giving the values of
51 `tags-table-list-pointer' and `tags-table-list-started-at' from
52 before we moved into the current table.")
54 (defvar tags-table-set-list nil
55 "List of sets of tags table which have been used together in the past.
56 Each element is a list of strings which are file names.")
59 (defvar find-tag-hook nil
60 "*Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'.
61 The value in the buffer in which \\[find-tag] is done is used,
62 not the value in the buffer \\[find-tag] goes to.")
65 (defvar find-tag-default-function nil
66 "*A function of no arguments used by \\[find-tag] to pick a default tag.
67 If nil, and the symbol that is the value of `major-mode'
68 has a `find-tag-default-function' property (see `put'), that is used.
69 Otherwise, `find-tag-default' is used.")
72 (defvar default-tags-table-function nil
73 "*If non-nil, a function of no arguments to choose a default tags file
74 for a particular buffer.")
77 ;; These variables are local in tags table buffers.
79 (defvar tag-lines-already-matched nil
80 "List of positions of beginnings of lines within the tags table
81 that are already matched.")
83 (defvar tags-table-files nil
84 "List of file names covered by current tags table.
85 nil means it has not yet been computed; use `tags-table-files' to do so.")
87 (defvar tags-completion-table nil
88 "Alist of tag names defined in current tags table.")
90 (defvar tags-included-tables nil
91 "List of tags tables included by the current tags table.")
93 (defvar next-file-list nil
94 "List of files for \\[next-file] to process.")
96 ;; Hooks for file formats.
98 (defvar tags-table-format-hooks '(etags-recognize-tags-table
99 recognize-empty-tags-table)
100 "List of functions to be called in a tags table buffer to identify
101 the type of tags table. The functions are called in order, with no arguments,
102 until one returns non-nil. The function should make buffer-local bindings
103 of the format-parsing tags function variables if successful.")
105 (defvar file-of-tag-function nil
106 "Function to do the work of `file-of-tag' (which see).")
107 (defvar tags-table-files-function nil
108 "Function to do the work of `tags-table-files' (which see).")
109 (defvar tags-completion-table-function nil
110 "Function to build the tags-completion-table.")
111 (defvar snarf-tag-function nil
112 "Function to get info about a matched tag for `goto-tag-location-function'.")
113 (defvar goto-tag-location-function nil
114 "Function of to go to the location in the buffer specified by a tag.
115 One argument, the tag info returned by `snarf-tag-function'.")
116 (defvar find-tag-regexp-search-function nil
117 "Search function passed to `find-tag-in-order' for finding a regexp tag.")
118 (defvar find-tag-regexp-tag-order nil
119 "Tag order passed to `find-tag-in-order' for finding a regexp tag.")
120 (defvar find-tag-regexp-next-line-after-failure-p nil
121 "Flag passed to `find-tag-in-order' for finding a regexp tag.")
122 (defvar find-tag-search-function nil
123 "Search function passed to `find-tag-in-order' for finding a tag.")
124 (defvar find-tag-tag-order nil
125 "Tag order passed to `find-tag-in-order' for finding a tag.")
126 (defvar find-tag-next-line-after-failure-p nil
127 "Flag passed to `find-tag-in-order' for finding a tag.")
128 (defvar list-tags-function nil
129 "Function to do the work of `list-tags' (which see).")
130 (defvar tags-apropos-function nil
131 "Function to do the work of `tags-apropos' (which see).")
132 (defvar tags-included-tables-function nil
133 "Function to do the work of `tags-included-tables' (which see).")
134 (defvar verify-tags-table-function nil
135 "Function to return t iff the current buffer vontains a valid
136 \(already initialized\) tags file.")
138 (defun initialize-new-tags-table ()
139 "Initialize the tags table in the current buffer.
140 Returns non-nil iff it is a valid tags table."
141 (make-local-variable 'tag-lines-already-matched)
142 (make-local-variable 'tags-table-files)
143 (make-local-variable 'tags-completion-table)
144 (make-local-variable 'tags-included-tables)
145 (setq tags-table-files nil
146 tag-lines-already-matched nil
147 tags-completion-table nil
148 tags-included-tables nil)
149 ;; Value is t if we have found a valid tags table buffer.
150 (let ((hooks tags-table-format-hooks))
152 (not (funcall (car hooks))))
153 (setq hooks (cdr hooks)))
157 (defun visit-tags-table (file &optional local)
158 "Tell tags commands to use tags table file FILE.
159 FILE should be the name of a file created with the `etags' program.
160 A directory name is ok too; it means file TAGS in that directory.
162 Normally \\[visit-tags-table] sets the global value of `tags-file-name'.
163 With a prefix arg, set the buffer-local value instead.
164 When you find a tag with \\[find-tag], the buffer it finds the tag
165 in is given a local value of this variable which is the name of the tags
166 file the tag was in."
167 (interactive (list (read-file-name "Visit tags table: (default TAGS) "
169 (expand-file-name "TAGS"
173 (let ((tags-file-name file))
175 (or (visit-tags-table-buffer 'same)
176 (signal 'file-error (list "Visiting tags table"
177 "file does not exist"
179 (setq file tags-file-name)))
181 (set (make-local-variable 'tags-file-name) file)
182 (setq-default tags-file-name file)))
184 ;; Move tags-table-list-pointer along and set tags-file-name.
185 ;; Returns nil when out of tables.
186 (defun tags-next-table (&optional reset no-includes)
188 (setq tags-table-list-pointer tags-table-list)
190 (if (and (not no-includes)
191 (visit-tags-table-buffer 'same)
192 (tags-included-tables))
193 ;; Move into the included tags tables.
194 (setq tags-table-parent-pointer-list
195 (cons (cons tags-table-list-pointer tags-table-list-started-at)
196 tags-table-parent-pointer-list)
197 tags-table-list-pointer tags-included-tables
198 tags-table-list-started-at tags-included-tables)
200 ;; Go to the next table in the list.
201 (setq tags-table-list-pointer
202 (cdr tags-table-list-pointer))
203 (or tags-table-list-pointer
205 (setq tags-table-list-pointer tags-table-list))
207 (if (eq tags-table-list-pointer tags-table-list-started-at)
208 ;; We have come full circle.
209 (if tags-table-parent-pointer-list
210 ;; Pop back to the tags table which includes this one.
212 (setq tags-table-list-pointer
213 (car (car tags-table-parent-pointer-list))
214 tags-table-list-started-at
215 (cdr (car tags-table-parent-pointer-list))
216 tags-table-parent-pointer-list
217 (cdr tags-table-parent-pointer-list))
218 (tags-next-table nil t))
219 ;; All out of tags tables.
220 (setq tags-table-list-pointer nil))))
222 (and tags-table-list-pointer
224 (tags-expand-table-name (car tags-table-list-pointer))))))
226 (defun tags-expand-table-name (file)
228 ;; nil means look for TAGS in current directory.
229 (setq file default-directory))
230 (setq file (expand-file-name file))
231 (if (file-directory-p file)
232 (expand-file-name "TAGS" file)
235 (defun tags-table-list-member (file &optional list)
237 (setq list tags-table-list))
238 (setq file (tags-expand-table-name file))
240 (not (string= file (tags-expand-table-name (car list)))))
241 (setq list (cdr list)))
244 ;; Subroutine of visit-tags-table-buffer. Frobs its local vars.
245 ;; Search TABLES for one that has tags for THIS-FILE.
246 ;; Recurses on included tables.
247 (defun tags-table-including (this-file tables &optional recursing)
249 (while (and (not found)
251 (let ((tags-file-name (tags-expand-table-name (car tables))))
252 (if (or (get-file-buffer tags-file-name)
253 (file-exists-p tags-file-name))
255 ;; Select the tags table buffer and get the file list up to date.
256 (visit-tags-table-buffer 'same)
258 (setq tags-table-files
259 (funcall tags-table-files-function)))
261 (cond ((member this-file tags-table-files)
265 ((tags-included-tables)
266 (let ((old tags-table-parent-pointer-list))
270 ;; At top level (not in an included tags
271 ;; table), set the list to nil so we can
272 ;; collect just the elts from this run.
273 (setq tags-table-parent-pointer-list nil))
275 (tags-table-including this-file
280 (setq tags-table-parent-pointer-list
282 (cons tags-table-list-pointer
283 tags-table-list-started-at)
284 tags-table-parent-pointer-list)
285 tags-table-list-pointer found
286 tags-table-list-started-at found
287 ;; Don't frob lists later.
290 ;; Recursive calls have consed onto the front
291 ;; of the list, so it is now outermost first.
292 ;; We want it innermost first.
293 (setq tags-table-parent-pointer-list
295 tags-table-parent-pointer-list)
297 (setq tables (cdr tables)))
300 (defun visit-tags-table-buffer (&optional cont)
301 "Select the buffer containing the current tags table.
302 If optional arg is t, visit the next table in `tags-table-list'.
303 If optional arg is the atom `same', don't look for a new table;
304 just select the buffer.
305 If arg is nil or absent, choose a first buffer from information in
306 `tags-file-name', `tags-table-list', `tags-table-list-pointer'.
307 Returns t if it visits a tags table, or nil if there are no more in the list."
308 (cond ((eq cont 'same))
311 (if (tags-next-table)
312 ;; Skip over nonexistent files.
313 (while (and (let ((file (tags-expand-table-name tags-file-name)))
314 (not (or (get-file-buffer file)
315 (file-exists-p file))))
316 (tags-next-table)))))
320 (or (cdr (assq 'tags-file-name (buffer-local-variables)))
321 (and default-tags-table-function
322 (funcall default-tags-table-function))
323 ;; Look for a tags table that contains
324 ;; tags for the current buffer's file.
325 ;; If one is found, the lists will be frobnicated,
326 ;; and CONT will be set non-nil so we don't do it below.
327 (let ((found (save-excursion
328 (tags-table-including buffer-file-name
331 ;; Expand it so it won't be nil.
332 (tags-expand-table-name (car found))))
333 (tags-expand-table-name (car tags-table-list))
334 (tags-expand-table-name tags-file-name)
336 (read-file-name "Visit tags table: (default TAGS) "
341 (setq tags-file-name (tags-expand-table-name tags-file-name))
343 (if (and (eq cont t) (null tags-table-list-pointer))
344 ;; All out of tables.
347 (if (if (get-file-buffer tags-file-name)
349 (set-buffer (get-file-buffer tags-file-name))
350 (setq win (or verify-tags-table-function
351 (initialize-new-tags-table)))
352 (if (or (verify-visited-file-modtime (current-buffer))
354 "Tags file has changed, read new contents? ")))
355 (and win (funcall verify-tags-table-function))
357 (initialize-new-tags-table)))
358 (set-buffer (find-file-noselect tags-file-name))
359 (or (string= tags-file-name buffer-file-name)
360 ;; find-file-noselect has changed the file name.
361 ;; Propagate change to tags-file-name and tags-table-list.
362 (let ((tail (member file tags-table-list)))
364 (setcar tail buffer-file-name))
365 (setq tags-file-name buffer-file-name)))
366 (initialize-new-tags-table))
368 ;; We have a valid tags table.
370 ;; Bury the tags table buffer so it
371 ;; doesn't get in the user's way.
372 (bury-buffer (current-buffer))
375 ;; No list frobbing required.
378 ;; Look in the list for the table we chose.
379 (let ((elt (tags-table-list-member tags-file-name)))
381 ;; The table is not in the current set.
382 ;; Try to find it in another previously used set.
383 (let ((sets tags-table-set-list))
385 (not (setq elt (tags-table-list-member
386 tags-file-name (car sets)))))
387 (setq sets (cdr sets)))
390 ;; Found in some other set. Switch to that set.
391 (or (memq tags-table-list tags-table-set-list)
392 ;; Save the current list.
393 (setq tags-table-set-list
394 (cons tags-table-list
395 tags-table-set-list)))
396 (setq tags-table-list (car sets)))
398 ;; Not found in any existing set.
399 (if (and tags-table-list
400 (y-or-n-p (concat "Add " tags-file-name
402 " of tags tables? ")))
403 ;; Add it to the current list.
404 (setq tags-table-list (cons tags-file-name
406 ;; Make a fresh list, and store the old one.
407 (or (memq tags-table-list tags-table-set-list)
408 (setq tags-table-set-list
409 (cons tags-table-list tags-table-set-list)))
410 (setq tags-table-list (list tags-file-name)))
411 (setq elt tags-table-list))))
413 (setq tags-table-list-started-at elt
414 tags-table-list-pointer elt)))
416 ;; Return of t says the tags table is valid.
419 ;; The buffer was not valid. Don't use it again.
420 (kill-local-variable 'tags-file-name)
421 (setq tags-file-name nil)
422 (error "File %s is not a valid tags table" buffer-file-name))))
424 (defun file-of-tag ()
425 "Return the file name of the file whose tags point is within.
426 Assumes the tags table is the current buffer.
427 File name returned is relative to tags table file's directory."
428 (funcall file-of-tag-function))
431 (defun tags-table-files ()
432 "Return a list of files in the current tags table.
433 File names returned are absolute."
435 (setq tags-table-files
436 (funcall tags-table-files-function))))
438 (defun tags-included-tables ()
439 "Return a list of tags tables included by the current table."
440 (or tags-included-tables
441 (setq tags-included-tables (funcall tags-included-tables-function))))
443 ;; Build tags-completion-table on demand. The single current tags table
444 ;; and its included tags tables (and their included tables, etc.) have
445 ;; their tags included in the completion table.
446 (defun tags-completion-table ()
447 (or tags-completion-table
450 (message "Making tags completion table for %s..." buffer-file-name)
451 (let ((included (tags-included-tables))
452 (table (funcall tags-completion-table-function)))
455 (let ((tags-file-name (car included)))
456 (visit-tags-table-buffer 'same))
457 (if (tags-completion-table)
460 (intern (symbol-name sym) table)))
461 tags-completion-table))
462 (setq included (cdr included))))
463 (setq tags-completion-table table))
464 (message "Making tags completion table for %s...done"
466 (quit (message "Tags completion table construction aborted.")
467 (setq tags-completion-table nil)))))
469 ;; Completion function for tags. Does normal try-completion,
470 ;; but builds tags-completion-table on demand.
471 (defun tags-complete-tag (string predicate what)
473 (visit-tags-table-buffer)
475 (all-completions string (tags-completion-table) predicate)
476 (try-completion string (tags-completion-table) predicate))))
478 ;; Return a default tag to search for, based on the text at point.
479 (defun find-tag-default ()
481 (while (looking-at "\\sw\\|\\s_")
483 (if (or (re-search-backward "\\sw\\|\\s_"
484 (save-excursion (beginning-of-line) (point))
486 (re-search-forward "\\(\\sw\\|\\s_\\)+"
487 (save-excursion (end-of-line) (point))
489 (progn (goto-char (match-end 0))
490 (buffer-substring (point)
491 (progn (forward-sexp -1)
492 (while (looking-at "\\s'")
497 ;; Read a tag name from the minibuffer with defaulting and completion.
498 (defun find-tag-tag (string)
499 (let* ((default (funcall (or find-tag-default-function
500 (get major-mode 'find-tag-default-function)
502 (spec (completing-read (if default
503 (format "%s(default %s) " string default)
505 'tags-complete-tag)))
506 (list (if (equal spec "")
507 (or default (error "There is no default tag"))
511 "Last tag found by \\[find-tag].")
514 (defun find-tag-noselect (tagname &optional next-p regexp-p)
515 "Find tag (in current tags table) whose name contains TAGNAME.
516 Returns the buffer containing the tag's definition and moves its point there,
517 but does not select the buffer.
518 The default for TAGNAME is the expression in the buffer near point.
520 If second arg NEXT-P is non-nil (interactively, with prefix arg), search
521 for another tag that matches the last tagname or regexp used. When there
522 are multiple matches for a tag, more exact matches are found first.
524 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
526 See documentation of variable `tags-file-name'."
527 (interactive (if current-prefix-arg
529 (find-tag-tag "Find tag: ")))
530 (let ((local-find-tag-hook find-tag-hook))
532 (visit-tags-table-buffer 'same)
533 (setq last-tag tagname)
534 (visit-tags-table-buffer))
536 (find-tag-in-order (if next-p last-tag tagname)
538 find-tag-regexp-search-function
539 find-tag-search-function)
541 find-tag-regexp-tag-order
544 find-tag-regexp-next-line-after-failure-p
545 find-tag-next-line-after-failure-p)
546 (if regexp-p "matching" "containing")
548 (run-hooks 'local-find-tag-hook))))
551 (defun find-tag (tagname &optional next-p)
552 "Find tag (in current tags table) whose name contains TAGNAME.
553 Select the buffer containing the tag's definition, and move point there.
554 The default for TAGNAME is the expression in the buffer around or before point.
556 If second arg NEXT-P is non-nil (interactively, with prefix arg), search
557 for another tag that matches the last tagname used. When there are
558 multiple matches, more exact matches are found first.
560 See documentation of variable `tags-file-name'."
561 (interactive (if current-prefix-arg
563 (find-tag-tag "Find tag: ")))
564 (switch-to-buffer (find-tag-noselect tagname next-p)))
565 ;;;###autoload (define-key esc-map "." 'find-tag)
568 (defun find-tag-other-window (tagname &optional next-p)
569 "Find tag (in current tags table) whose name contains TAGNAME.
570 Select the buffer containing the tag's definition
571 in another window, and move point there.
572 The default for TAGNAME is the expression in the buffer around or before point.
574 If second arg NEXT-P is non-nil (interactively, with prefix arg), search
575 for another tag that matches the last tagname used. When there are
576 multiple matches, more exact matches are found first.
578 See documentation of variable `tags-file-name'."
579 (interactive (if current-prefix-arg
581 (find-tag-tag "Find tag other window: ")))
582 (switch-to-buffer-other-window (find-tag-noselect tagname next-p)))
583 ;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)
586 (defun find-tag-other-frame (tagname &optional next-p)
587 "Find tag (in current tag table) whose name contains TAGNAME.
588 Selects the buffer that the tag is contained in in another frame
589 and puts point at its definition.
590 If TAGNAME is a null string, the expression in the buffer
591 around or before point is used as the tag name.
592 If second arg NEXT-P is non-nil (interactively, with prefix arg),
593 searches for the next tag in the tag table
594 that matches the tagname used in the previous find-tag.
596 See documentation of variable `tags-file-name'."
597 (interactive (if current-prefix-arg
599 (find-tag-tag "Find tag other window: ")))
600 (let ((pop-up-frames t))
601 (find-tag-other-window tagname next-p)))
602 ;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame)
605 (defun find-tag-regexp (regexp &optional next-p other-window)
606 "Find tag (in current tags table) whose name matches REGEXP.
607 Select the buffer containing the tag's definition and move point there.
609 If second arg NEXT-P is non-nil (interactively, with prefix arg), search
610 for another tag that matches the last tagname used.
612 If third arg OTHER-WINDOW is non-nil, select the buffer in another window.
614 See documentation of variable `tags-file-name'."
615 (interactive (if current-prefix-arg
617 (read-string "Find tag regexp: ")))
618 (funcall (if other-window 'switch-to-buffer-other-window 'switch-to-buffer)
619 (find-tag-noselect regexp next-p t)))
621 ;; Internal tag finding function.
623 ;; PATTERN is a string to pass to second arg SEARCH-FORWARD-FUNC, and to
624 ;; any member of the function list ORDER (third arg). If ORDER is nil,
625 ;; use saved state to continue a previous search.
627 ;; Fourth arg MATCHING is a string, an English '-ing' word, to be used in
630 ;; Fifth arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match,
631 ;; point should be moved to the next line.
633 ;; Algorithm is as follows. For each qualifier-func in ORDER, go to
634 ;; beginning of tags file, and perform inner loop: for each naive match for
635 ;; PATTERN found using SEARCH-FORWARD-FUNC, qualify the naive match using
636 ;; qualifier-func. If it qualifies, go to the specified line in the
637 ;; specified source file and return. Qualified matches are remembered to
638 ;; avoid repetition. State is saved so that the loop can be continued.
640 (defun find-tag-in-order (pattern
643 next-line-after-failure-p
646 (let (file ;name of file containing tag
647 tag-info ;where to find the tag in FILE
648 tags-table-file ;name of tags file
654 (or first-search ;find-tag-noselect has already done it.
655 (visit-tags-table-buffer 'same))
657 ;; Get a qualified match.
658 (catch 'qualified-match-found
660 (while (or first-table
661 (visit-tags-table-buffer t))
664 (setq tag-lines-already-matched nil))
666 (and first-search first-table
667 ;; Start at beginning of tags file.
668 (goto-char (point-min)))
669 (setq first-table nil)
671 (setq tags-table-file buffer-file-name)
673 (while (funcall search-forward-func pattern nil t)
674 ;; Naive match found. Qualify the match.
675 (and (funcall (car order) pattern)
676 ;; Make sure it is not a previous qualified match.
677 ;; Use of `memq' depends on numbers being eq.
678 (not (memq (save-excursion (beginning-of-line) (point))
679 tag-lines-already-matched))
680 (throw 'qualified-match-found nil))
681 (if next-line-after-failure-p
683 ;; Try the next flavor of match.
684 (setq order (cdr order))
685 (goto-char (point-min)))
686 (setq order tag-order))
687 ;; We throw out on match, so only get here if there were no matches.
688 (error "No %stags %s %s" (if first-search "" "more ")
691 ;; Found a tag; extract location info.
693 (setq tag-lines-already-matched (cons (point)
694 tag-lines-already-matched))
695 ;; Expand the filename, using the tags table buffer's default-directory.
696 (setq file (expand-file-name (file-of-tag))
697 tag-info (funcall snarf-tag-function))
699 ;; Get the local value in the tags table buffer.
700 (setq goto-func goto-tag-location-function)
702 ;; Find the right line in the specified file.
703 (set-buffer (find-file-noselect file))
706 (funcall goto-func tag-info)
708 ;; Give this buffer a local value of tags-file-name.
709 ;; The next time visit-tags-table-buffer is called,
710 ;; it will use the same tags table that found a match in this buffer.
711 (make-local-variable 'tags-file-name)
712 (setq tags-file-name tags-table-file)
714 ;; Return the buffer where the tag was found.
717 ;; `etags' TAGS file format support.
719 (defun etags-recognize-tags-table ()
720 (and (eq (char-after 1) ?\f)
721 ;; It is annoying to flash messages on the screen briefly,
722 ;; and this message is not useful. -- rms
723 ;; (message "%s is an `etags' TAGS file" buffer-file-name)
724 (mapcar (function (lambda (elt)
725 (make-local-variable (car elt))
726 (set (car elt) (cdr elt))))
727 '((file-of-tag-function . etags-file-of-tag)
728 (tags-table-files-function . etags-tags-table-files)
729 (tags-completion-table-function . etags-tags-completion-table)
730 (snarf-tag-function . etags-snarf-tag)
731 (goto-tag-location-function . etags-goto-tag-location)
732 (find-tag-regexp-search-function . re-search-forward)
733 (find-tag-regexp-tag-order . (tag-re-match-p))
734 (find-tag-regexp-next-line-after-failuire-p . t)
735 (find-tag-search-function . search-forward)
736 (find-tag-tag-order . (tag-exact-match-p tag-word-match-p
738 (find-tag-next-line-after-failure-p . nil)
739 (list-tags-function . etags-list-tags)
740 (tags-apropos-function . etags-tags-apropos)
741 (tags-included-tables-function . etags-tags-included-tables)
742 (verify-tags-table-function . etags-verify-tags-table)
745 (defun etags-verify-tags-table ()
746 (= (char-after 1) ?\f))
748 (defun etags-file-of-tag ()
750 (search-backward "\f\n")
752 (buffer-substring (point)
753 (progn (skip-chars-forward "^,") (point)))))
755 (defun etags-tags-completion-table ()
756 (let ((table (make-vector 511 0)))
758 (goto-char (point-min))
759 (while (search-forward "\177" nil t)
760 ;; Handle multiple \177's on a line.
762 (skip-chars-backward "^-A-Za-z0-9_$\n") ;sym syntax? XXX
764 (intern (buffer-substring
767 (skip-chars-backward "-A-Za-z0-9_$")
769 ;; `::' in the middle of a C++ tag.
770 (and (= (preceding-char) ?:)
771 (= (char-after (- (point) 2)) ?:)
780 (defun etags-snarf-tag ()
781 (let (tag-text startpos)
782 (search-forward "\177")
783 (setq tag-text (buffer-substring (1- (point))
784 (save-excursion (beginning-of-line)
787 (setq startpos (string-to-int (buffer-substring
789 (progn (skip-chars-forward "0-9")
791 ;; Leave point on the next line of the tags file.
793 (cons tag-text startpos)))
795 (defun etags-goto-tag-location (tag-info)
796 (let ((startpos (cdr tag-info))
797 ;; This constant is 1/2 the initial search window.
798 ;; There is no sense in making it too small,
799 ;; since just going around the loop once probably
800 ;; costs about as much as searching 2000 chars.
803 (pat (concat "^" (regexp-quote (car tag-info)))))
805 (setq startpos (point-min)))
806 (while (and (not found)
808 (goto-char (- startpos offset))
811 (re-search-forward pat (+ startpos offset) t)
812 offset (* 3 offset))) ; expand search window
814 (re-search-forward pat nil t)
815 (error "`%s' not found in %s; time to rerun etags"
816 pat buffer-file-name)))
819 (defun etags-list-tags (file)
821 (if (not (search-forward (concat "\f\n" file ",") nil t))
824 (while (not (or (eobp) (looking-at "\f")))
825 (princ (buffer-substring (point)
826 (progn (skip-chars-forward "^\177")
831 (defun etags-tags-apropos (string)
833 (while (re-search-forward string nil t)
835 (princ (buffer-substring (point)
836 (progn (skip-chars-forward "^\177")
841 (defun etags-tags-table-files ()
844 (goto-char (point-min))
845 (while (search-forward "\f\n" nil t)
847 (skip-chars-forward "^,\n")
848 (or (looking-at ",include$")
849 ;; Expand in the default-directory of the tags table buffer.
850 (setq files (cons (expand-file-name (buffer-substring beg (point)))
854 (defun etags-tags-included-tables ()
857 (goto-char (point-min))
858 (while (search-forward "\f\n" nil t)
860 (skip-chars-forward "^,\n")
861 (if (looking-at ",include$")
862 ;; Expand in the default-directory of the tags table buffer.
863 (setq files (cons (expand-file-name (buffer-substring beg (point)))
867 ;; Empty tags file support.
869 (defun recognize-empty-tags-table ()
870 (and (zerop (buffer-size))
871 (mapcar (function (lambda (sym)
872 (make-local-variable sym)
874 '(tags-table-files-function
875 tags-completion-table-function
876 find-tag-regexp-search-function
877 find-tag-search-function
878 tags-apropos-function
879 tags-included-tables-function))
880 (set (make-local-variable 'verify-tags-table-function)
882 (zerop (buffer-size)))))))
884 ;;; Match qualifier functions for tagnames.
886 ;; This might be a neat idea, but it's too hairy at the moment.
887 ;;(defmacro tags-with-syntax (&rest body)
888 ;; (` (let ((current (current-buffer))
889 ;; (otable (syntax-table))
890 ;; (buffer (find-file-noselect (file-of-tag)))
894 ;; (set-buffer buffer)
895 ;; (setq table (syntax-table))
896 ;; (set-buffer current)
897 ;; (set-syntax-table table)
899 ;; (set-syntax-table otable)))))
900 ;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form))
902 ;; t if point is at a tag line that matches TAG "exactly".
903 ;; point should be just after a string that matches TAG.
904 (defun tag-exact-match-p (tag)
905 (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177") ;not a symbol char
907 (backward-char (1+ (length tag)))
908 (and (looking-at "\\Sw") (looking-at "\\S_")))))
910 ;; t if point is at a tag line that matches TAG as a word.
911 ;; point should be just after a string that matches TAG.
912 (defun tag-word-match-p (tag)
913 (and (looking-at "\\b.*\177")
914 (save-excursion (backward-char (1+ (length tag)))
915 (looking-at "\\b"))))
917 ;; t if point is in a tag line with a tag containing TAG as a substring.
918 (defun tag-any-match-p (tag)
919 (looking-at ".*\177"))
921 ;; t if point is at a tag line that matches RE as a regexp.
922 (defun tag-re-match-p (re)
926 (and (search-forward "\177" (save-excursion (end-of-line) (point)) t)
927 (re-search-backward re bol t)))))
930 (defun next-file (&optional initialize novisit)
931 "Select next file among files in current tags table.
932 Non-nil first argument (prefix arg, if interactive)
933 initializes to the beginning of the list of files in the tags table.
935 Non-nil second argument NOVISIT means use a temporary buffer
936 to save time and avoid uninteresting warnings.
938 Value is nil if the file was already visited;
939 if the file was newly read in, the value is the filename."
943 (visit-tags-table-buffer)
944 (setq next-file-list (tags-table-files))))
947 ;; Get the files from the next tags table.
948 ;; When doing (visit-tags-table-buffer t),
949 ;; the tags table buffer must be current.
950 (if (and (visit-tags-table-buffer 'same)
951 (visit-tags-table-buffer t))
952 (setq next-file-list (tags-table-files))
954 (get-buffer " *next-file*")
955 (kill-buffer " *next-file*"))
956 (error "All files processed."))))
957 (let ((new (not (get-file-buffer (car next-file-list)))))
958 (if (not (and new novisit))
959 (set-buffer (find-file-noselect (car next-file-list) novisit))
960 ;; Like find-file, but avoids random warning messages.
961 (set-buffer (get-buffer-create " *next-file*"))
962 (kill-all-local-variables)
964 (setq new (car next-file-list))
965 (insert-file-contents new nil))
966 (setq next-file-list (cdr next-file-list))
969 (defvar tags-loop-operate nil
970 "Form for `tags-loop-continue' to eval to change one file.")
972 (defvar tags-loop-scan nil
973 "Form for `tags-loop-continue' to eval to scan one file.
974 If it returns non-nil, this file needs processing by evalling
975 \`tags-loop-operate'. Otherwise, move on to the next file.")
978 (defun tags-loop-continue (&optional first-time)
979 "Continue last \\[tags-search] or \\[tags-query-replace] command.
980 Used noninteractively with non-nil argument to begin such a command.
981 Two variables control the processing we do on each file:
982 the value of `tags-loop-scan' is a form to be executed on each file
983 to see if it is interesting (it returns non-nil if so)
984 and `tags-loop-operate' is a form to execute to operate on an interesting file
985 If the latter returns non-nil, we exit; otherwise we scan the next file."
991 ;; Scan files quickly for the first or next interesting one.
992 (while (or first-time
995 (not (eval tags-loop-scan))))
996 (setq new (next-file first-time t))
997 ;; If NEW is non-nil, we got a temp buffer,
998 ;; and NEW is the file name.
1000 (and (not first-time)
1001 (> baud-rate search-slow-speed)
1003 (message "Scanning file %s..." (or new buffer-file-name)))
1004 (setq first-time nil)
1005 (goto-char (point-min)))
1007 ;; If we visited it in a temp buffer, visit it now for real.
1009 (let ((pos (point)))
1011 (set-buffer (find-file-noselect new))
1015 (switch-to-buffer (current-buffer))
1017 ;; Now operate on the file.
1018 ;; If value is non-nil, continue to scan the next file.
1019 (eval tags-loop-operate)))
1021 (null tags-loop-operate)
1022 (message "Scanning file %s...found" buffer-file-name))))
1024 ;;;###autoload (define-key esc-map "," 'tags-loop-continue)
1027 (defun tags-search (regexp)
1028 "Search through all files listed in tags table for match for REGEXP.
1029 Stops when a match is found.
1030 To continue searching for next match, use command \\[tags-loop-continue].
1032 See documentation of variable `tags-file-name'."
1033 (interactive "sTags search (regexp): ")
1034 (if (and (equal regexp "")
1035 (eq (car tags-loop-scan) 're-search-forward)
1036 (eq tags-loop-operate t))
1037 ;; Continue last tags-search as if by M-,.
1038 (tags-loop-continue nil)
1039 (setq tags-loop-scan
1040 (list 're-search-forward regexp nil t)
1041 tags-loop-operate nil)
1042 (tags-loop-continue t)))
1045 (defun tags-query-replace (from to &optional delimited)
1046 "Query-replace-regexp FROM with TO through all files listed in tags table.
1047 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1048 If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace
1049 with the command \\[tags-loop-continue].
1051 See documentation of variable `tags-file-name'."
1053 "sTags query replace (regexp): \nsTags query replace %s by: \nP")
1054 (setq tags-loop-scan (list 'prog1
1055 (list 'if (list 're-search-forward form nil t)
1056 ;; When we find a match, move back
1057 ;; to the beginning of it so perform-replace
1059 '(goto-char (match-beginning 0))))
1060 tags-loop-operate (list 'perform-replace from to t t delimited))
1061 (tags-loop-continue t))
1064 (defun list-tags (file)
1065 "Display list of tags in file FILE.
1066 FILE should not contain a directory specification
1067 unless it has one in the tags table."
1068 (interactive (list (completing-read "List tags in file: " nil
1069 'tags-table-files t nil)))
1070 (with-output-to-temp-buffer "*Tags List*"
1071 (princ "Tags in file ")
1075 (let ((first-time t)
1077 (while (visit-tags-table-buffer (not first-time))
1078 (if (funcall list-tags-function file)
1081 (error "File %s not in current tags tables"))))))
1084 (defun tags-apropos (regexp)
1085 "Display list of all tags in tags table REGEXP matches."
1086 (interactive "sTags apropos (regexp): ")
1087 (with-output-to-temp-buffer "*Tags List*"
1088 (princ "Tags matching regexp ")
1092 (let ((first-time t))
1093 (while (visit-tags-table-buffer (not first-time))
1094 (setq first-time nil)
1095 (funcall tags-apropos-function regexp))))))
1097 ;;; XXX Kludge interface.
1099 ;; XXX If a file is in multiple tables, selection may get the wrong one.
1101 (defun select-tags-table ()
1102 "Select a tags table file from a menu of those you have already used.
1103 The list of tags tables to select from is stored in `tags-table-file-list';
1104 see the doc of that variable if you want to add names to the list."
1106 (pop-to-buffer "*Tags Table List*")
1107 (setq buffer-read-only nil)
1109 (setq selective-display t
1110 selective-display-ellipses nil)
1111 (let ((set-list tags-table-set-list)
1112 (desired-point nil))
1115 (setq desired-point (point-marker))
1116 (princ tags-table-list (current-buffer))
1118 (prin1 (car tags-table-list) (current-buffer)) ;invisible
1121 (if (eq (car set-list) tags-table-list)
1122 ;; Already printed it.
1124 (princ (car set-list) (current-buffer))
1126 (prin1 (car (car set-list)) (current-buffer)) ;invisible
1128 (setq set-list (cdr set-list)))
1132 (setq desired-point (point-marker)))
1133 (insert tags-file-name "\C-m")
1134 (prin1 tags-file-name (current-buffer)) ;invisible
1136 (setq set-list (delete tags-file-name
1137 (apply 'nconc (cons tags-table-list
1138 (mapcar 'copy-sequence
1139 tags-table-set-list)))))
1141 (insert (car set-list) "\C-m")
1142 (prin1 (car set-list) (current-buffer)) ;invisible
1144 (setq set-list (delete (car set-list) set-list)))
1146 (insert-before-markers
1147 "Type `t' to select a tags table or set of tags tables:\n\n")
1149 (goto-char desired-point))
1150 (set-window-start (selected-window) 1 t))
1151 (set-buffer-modified-p nil)
1152 (setq buffer-read-only t
1153 mode-name "Select Tags Table")
1154 (let ((map (make-sparse-keymap)))
1155 (define-key map "t" 'select-tags-table-select)
1156 (define-key map " " 'next-line)
1157 (define-key map "\^?" 'previous-line)
1158 (define-key map "n" 'next-line)
1159 (define-key map "p" 'previous-line)
1160 (define-key map "q" 'select-tags-table-quit)
1161 (use-local-map map)))
1163 (defun select-tags-table-select ()
1164 "Select the tags table named on this line."
1166 (search-forward "\C-m")
1167 (let ((name (read (current-buffer))))
1168 (visit-tags-table name)
1169 (select-tags-table-quit)
1170 (message "Tags table now %s" name)))
1172 (defun select-tags-table-quit ()
1173 "Kill the buffer and delete the selected window."
1175 (kill-buffer (current-buffer))
1180 (defun complete-tag ()
1181 "Perform tags completion on the text around point.
1182 Completes to the set of names listed in the current tags table.
1183 The string to complete is chosen in the same way as the default
1184 for \\[find-tag] (which see)."
1188 (error (substitute-command-keys
1189 "No tags table loaded. Try \\[visit-tags-table].")))
1190 (let ((pattern (funcall (or find-tag-default-function
1191 (get major-mode 'find-tag-default-function)
1192 'find-tag-default)))
1196 (error "Nothing to complete"))
1197 (search-backward pattern)
1199 (forward-char (length pattern))
1200 (setq completion (try-completion pattern 'tags-complete-tag nil))
1201 (cond ((eq completion t))
1203 (message "Can't find completion for \"%s\"" pattern)
1205 ((not (string= pattern completion))
1206 (delete-region beg (point))
1207 (insert completion))
1209 (message "Making completion list...")
1210 (with-output-to-temp-buffer " *Completions*"
1211 (display-completion-list
1212 (all-completions pattern 'tags-complete-tag nil)))
1213 (message "Making completion list...%s" "done")))))
1215 ;;;###autoload (define-key esc-map "\t" 'complete-tag)
1219 ;;; etags.el ends here