etags.el 40 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;; etags.el --- etags facility for Emacs

3
;; Copyright (C) 1985, 1986, 1988, 1989, 1992 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6 7
;; Author: Roland McGrath <roland@gnu.ai.mit.edu>
;; Keywords: tools

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
24 25
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
26 27
;;;###autoload
(defvar tags-file-name nil "\
Roland McGrath's avatar
Roland McGrath committed
28 29 30
*File name of tags table.
To switch to a new tags table, setting this variable is sufficient.
Use the `etags' program to make a tags table file.")
Roland McGrath's avatar
Roland McGrath committed
31
;;;###autoload (put 'tags-file-name 'variable-interactive "fVisit tags table: ")
Roland McGrath's avatar
Roland McGrath committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

;;;###autoload
(defvar tags-table-list nil
  "*List of names of tags table files which are currently being searched.
An element of nil means to look for a file \"TAGS\" in the current directory.
Use `visit-tags-table-buffer' to cycle through tags tables in this list.")

(defvar tags-table-list-pointer nil
  "Pointer into `tags-table-list', or into a list of included tags tables,
where the current state of searching is.  Use `visit-tags-table-buffer' to
cycle through tags tables in this list.")

(defvar tags-table-parent-pointer-list nil
  "List of values to restore into `tags-table-list-pointer' when it hits nil.")

(defvar tags-table-set-list nil
  "List of sets of tags table which have been used together in the past.
Each element is a list of strings which are file names.")

;;;###autoload
(defvar find-tag-hook nil
  "*Hook to be run by \\[find-tag] after finding a tag.  See `run-hooks'.
The value in the buffer in which \\[find-tag] is done is used,
not the value in the buffer \\[find-tag] goes to.")

;;;###autoload
(defvar find-tag-default-function nil
  "*If non-nil, a function of no arguments used by \\[find-tag] to pick a
default tag.  If nil, and the symbol that is the value of `major-mode'
has a `find-tag-default-function' property (see `put'), that is used.
Otherwise, `find-tag-default' is used.")

;;;###autoload
(defvar default-tags-table-function nil
  "*If non-nil, a function of no arguments to choose a default tags file
for a particular buffer.")

;; Tags table state.
;; These variables are local in tags table buffers.
Jim Blandy's avatar
Jim Blandy committed
71

Roland McGrath's avatar
Roland McGrath committed
72 73 74
(defvar tag-lines-already-matched nil
  "List of positions of beginnings of lines within the tags table
that are already matched.")
Jim Blandy's avatar
Jim Blandy committed
75

Roland McGrath's avatar
Roland McGrath committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
(defvar tags-table-files nil
  "List of file names covered by current tags table.
nil means it has not yet been computed; use `tags-table-files' to do so.")

(defvar tags-completion-table nil
  "Alist of tag names defined in current tags table.")

(defvar tags-included-tables nil
  "List of tags tables included by the current tags table.")

(defvar next-file-list nil
  "List of files for \\[next-file] to process.")

;; Hooks for file formats.

(defvar tags-table-format-hooks '(etags-recognize-tags-table
Roland McGrath's avatar
Roland McGrath committed
92
				  recognize-empty-tags-table)
Roland McGrath's avatar
Roland McGrath committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  "List of functions to be called in a tags table buffer to identify
the type of tags table.  The functions are called in order, with no arguments,
until one returns non-nil.  The function should make buffer-local bindings
of the format-parsing tags function variables if successful.")

(defvar file-of-tag-function nil
  "Function to do the work of `file-of-tag' (which see).")
(defvar tags-table-files-function nil
  "Function to do the work of `tags-table-files' (which see).")
(defvar tags-completion-table-function nil
  "Function to build the tags-completion-table.")
(defvar snarf-tag-function nil
  "Function to get info about a matched tag for `goto-tag-location-function'.")
(defvar goto-tag-location-function nil
  "Function of to go to the location in the buffer specified by a tag.
One argument, the tag info returned by `snarf-tag-function'.")
(defvar find-tag-regexp-search-function nil
  "Search function passed to `find-tag-in-order' for finding a regexp tag.")
(defvar find-tag-regexp-tag-order nil
  "Tag order passed to `find-tag-in-order' for finding a regexp tag.")
(defvar find-tag-regexp-next-line-after-failure-p nil
  "Flag passed to `find-tag-in-order' for finding a regexp tag.")
(defvar find-tag-search-function nil
  "Search function passed to `find-tag-in-order' for finding a tag.")
(defvar find-tag-tag-order nil
  "Tag order passed to `find-tag-in-order' for finding a tag.")
(defvar find-tag-next-line-after-failure-p nil
  "Flag passed to `find-tag-in-order' for finding a tag.")
(defvar list-tags-function nil
  "Function to do the work of `list-tags' (which see).")
(defvar tags-apropos-function nil
  "Function to do the work of `tags-apropos' (which see).")
(defvar tags-included-tables-function nil
  "Function to do the work of `tags-included-tables' (which see).")
(defvar verify-tags-table-function nil
  "Function to return t iff the current buffer vontains a valid
\(already initialized\) tags file.")

(defun initialize-new-tags-table ()
  "Initialize the tags table in the current buffer.
Returns non-nil iff it is a valid tags table."
  (make-local-variable 'tag-lines-already-matched)
  (make-local-variable 'tags-table-files)
  (make-local-variable 'tags-completion-table)
  (make-local-variable 'tags-included-tables)
  (setq tags-table-files nil
	tag-lines-already-matched nil
	tags-completion-table nil
	tags-included-tables nil)
  ;; Value is t if we have found a valid tags table buffer.
  (let ((hooks tags-table-format-hooks))
    (while (and hooks
		(not (funcall (car hooks))))
      (setq hooks (cdr hooks)))
    hooks))
Jim Blandy's avatar
Jim Blandy committed
148

Jim Blandy's avatar
Jim Blandy committed
149
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
150 151
(defun visit-tags-table (file &optional local)
  "Tell tags commands to use tags table file FILE.
Jim Blandy's avatar
Jim Blandy committed
152
FILE should be the name of a file created with the `etags' program.
Roland McGrath's avatar
Roland McGrath committed
153 154 155 156 157 158 159
A directory name is ok too; it means file TAGS in that directory.

Normally \\[visit-tags-table] sets the global value of `tags-file-name'.
With a prefix arg, set the buffer-local value instead.
When you find a tag with \\[find-tag], the buffer it finds the tag
in is given a local value of this variable which is the name of the tags
file the tag was in."
Jim Blandy's avatar
Jim Blandy committed
160 161
  (interactive (list (read-file-name "Visit tags table: (default TAGS) "
				     default-directory
Roland McGrath's avatar
Roland McGrath committed
162 163 164 165
				     (expand-file-name "TAGS"
						       default-directory)
				     t)
		     current-prefix-arg))
Jim Blandy's avatar
Jim Blandy committed
166
  (if (file-directory-p file)
Roland McGrath's avatar
Roland McGrath committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
      (setq file (expand-file-name "TAGS" file)))
  (if local
      (setq tags-file-name file)
    (kill-local-variable 'tags-file-name)
    (setq-default tags-file-name file))
  (save-excursion
    (visit-tags-file t)))

(defun visit-tags-table-buffer (&optional cont)
  "Select the buffer containing the current tags table.
If optional arg is t, visit the next table in `tags-table-list'.
If optional arg is the atom `reset', reset to the head of `tags-table-list'.
If optional arg is the atom `same', don't look for a new table;
 just select the buffer.
If arg is nil or absent, choose a buffer from information in
`tags-file-name', `tags-table-list', `tags-table-list-pointer'.
Returns t if it visits a tags table, or nil if there are no more in the list."
  (if (eq cont 'same)
      (let ((tags-file-name (car tags-table-list-pointer)))
	(if (null tags-file-name)
	    nil
	  (visit-tags-file nil)
	  t))
    (let ((put-in-list t))
      (if (cond ((eq cont 'reset)
		 (setq tags-table-list-pointer tags-table-list
		       cont nil)
		 nil)
		(cont
		 (setq tags-table-list-pointer (cdr tags-table-list-pointer))
		 (if (tags-included-tables)
		     (progn
		       ;; Move into the included tags tables.
		       (if tags-table-list-pointer
			   (setq tags-table-parent-pointer-list
				 (cons tags-table-list-pointer
				       tags-table-parent-pointer-list)))
		       (setq tags-table-list-pointer tags-included-tables)))
		 (or tags-table-list-pointer
		     ;; Pop back to the tags table after the one which includes
		     ;; this one.
		     (setq tags-table-list-pointer
			   (car tags-table-parent-pointer-list)
			   tags-table-parent-pointer-list
			   (cdr tags-table-parent-pointer-list)))
		 (setq put-in-list nil)
		 (null tags-table-list-pointer)))
	  ;; No more tags table files in the list.
	  nil
	(setq tags-file-name
	      (or (if cont
		      (and tags-table-list-pointer
			   (or (car tags-table-list-pointer)
			       ;; nil means look for TAGS in current directory.
			       (if (file-exists-p
				    (expand-file-name "TAGS"
						      default-directory))
				   (expand-file-name "TAGS"
						     default-directory))))
		    (cdr (assq 'tags-file-name (buffer-local-variables))))
		  (and default-tags-table-function
		       (funcall default-tags-table-function))
Roland McGrath's avatar
Roland McGrath committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
		  ;; Look for a tags table that contains
		  ;; tags for the current buffer's file.
		  (let ((tables tags-table-list)
			(this-file (buffer-file-name))
			(found nil))
		    (save-excursion
		      (while tables
			(if (assoc this-file
				   (let ((tags-file-name (car tables)))
				     (visit-tags-file nil)
				     (or tags-table-files
					 (setq tags-table-files
					       (funcall
						tags-table-files-function)))))
			    (setq found (car tables)
				  tables nil)
			  (setq tables (cdr tables)))))
		    found)
Roland McGrath's avatar
Roland McGrath committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
		  (car tags-table-list-pointer)
		  tags-file-name
		  (expand-file-name
		   (read-file-name "Visit tags table: (default TAGS) "
				   default-directory
				   (expand-file-name "TAGS" default-directory)
				   t))))
	(if (file-directory-p tags-file-name)
	    (setq tags-file-name (expand-file-name "TAGS" tags-file-name)))
	(visit-tags-file put-in-list)
	t))))

;; Visit tags-file-name and check that it's a valid tags table.
;; On return, tags-table-list and tags-table-list-pointer
;; point to tags-file-name.
(defun visit-tags-file (put-in-list)
  ;; FILE is never changed, but we don't just use tags-file-name
  ;; directly because we don't want to get its buffer-local value
  ;; in the buffer we switch to.
  (let ((file tags-file-name))
    (if (if (get-file-buffer file)
	    (let (win)
	      (set-buffer (get-file-buffer file))
	      (setq win (or verify-tags-table-function
			    (initialize-new-tags-table)))
	      (if (or (verify-visited-file-modtime (current-buffer))
		      (not (yes-or-no-p
			    "Tags file has changed, read new contents? ")))
		  (and win (funcall verify-tags-table-function))
		(revert-buffer t t)
		(initialize-new-tags-table)))
	  (set-buffer (find-file-noselect file))
Roland McGrath's avatar
Roland McGrath committed
279 280 281 282 283 284 285
	  (or (string= file buffer-file-name)
	      ;; find-file-noselect has changed the file name.
	      ;; Propagate the change to tags-file-name and tags-table-list.
	      (let ((tail (assoc file tags-table-list)))
		(if tail
		    (setcar tail buffer-file-name))
		(setq tags-file-name buffer-file-name)))
Roland McGrath's avatar
Roland McGrath committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
	  (initialize-new-tags-table))
	
	(if (and put-in-list
		 (not (equal file (car tags-table-list-pointer))))
	    (let (elt)
	      ;; Bury the tags table buffer so it
	      ;; doesn't get in the user's way.
	      (bury-buffer (current-buffer))
	      ;; Look for this file in the current list of tags files.
	      (if (setq elt (member file tags-table-list))
		  (if (eq elt tags-table-list)
		      ;; Already at the head of the list.
		      ()
		    ;; Rotate this element to the head of the search list.
		    (setq tags-table-list-pointer (nconc elt tags-table-list))
		    (while (not (eq (cdr tags-table-list) elt))
		      (setq tags-table-list (cdr tags-table-list)))
		    (setcdr tags-table-list nil)
		    (setq tags-table-list tags-table-list-pointer))
		;; The table is not in the current set.
		;; Try to find it in another previously used set.
		(let ((sets tags-table-set-list))
		  (while (and sets
			      (not (setq elt (member file
						     (car sets)))))
		    (setq sets (cdr sets)))
		  (if sets
		      (progn
			;; Found in some other set.  Switch to that set, making
			;; the selected tags table the head of the search list.
			(or (memq tags-table-list tags-table-set-list)
			    ;; Save the current list.
			    (setq tags-table-set-list
				  (cons tags-table-list tags-table-set-list)))
			(setq tags-table-list (car sets))
			(if (eq elt tags-table-list)
			    ;; Already at the head of the list
			    ()
			  ;; Rotate this element to the head of the list.
			  (setq tags-table-list-pointer
				(nconc elt tags-table-list))
			  (while (not (eq (cdr tags-table-list) elt))
			    (setq tags-table-list (cdr tags-table-list)))
			  (setcdr tags-table-list nil)
			  (setq tags-table-list tags-table-list-pointer)
			  (setcar sets tags-table-list)))
		    ;; Not found in any current set.
		    (if (and tags-table-list
			     (y-or-n-p
			      (concat "Add " file
				      " to current list of tags tables? ")))
			;; Add it to the current list.
			(setq tags-table-list
			      (cons file tags-table-list))
		      ;; Make a fresh list, and store the old one.
		      (or (memq tags-table-list tags-table-set-list)
			  (setq tags-table-set-list
				(cons tags-table-list tags-table-set-list)))
		      (setq tags-table-list (cons file nil)))
		    (setq tags-table-list-pointer tags-table-list))))))
      
      ;; The buffer was not valid.  Don't use it again.
      (kill-local-variable 'tags-file-name)
      (setq tags-file-name nil)
      (error "File %s is not a valid tags table" buffer-file-name))))
Jim Blandy's avatar
Jim Blandy committed
351 352 353

(defun file-of-tag ()
  "Return the file name of the file whose tags point is within.
Roland McGrath's avatar
Roland McGrath committed
354 355 356
Assumes the tags table is the current buffer.
File name returned is relative to tags table file's directory."
  (funcall file-of-tag-function))
Jim Blandy's avatar
Jim Blandy committed
357

Jim Blandy's avatar
Jim Blandy committed
358
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
359 360
(defun tags-table-files ()
  "Return a list of files in the current tags table.
Jim Blandy's avatar
Jim Blandy committed
361 362
File names returned are absolute."
  (save-excursion
Roland McGrath's avatar
Roland McGrath committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
    (visit-tags-table-buffer)
    (or tags-table-files
	(setq tags-table-files
	      (funcall tags-table-files-function)))))

(defun tags-included-tables ()
  "Return a list of tags tables included by the current table."
  (or tags-included-tables
      (setq tags-included-tables (funcall tags-included-tables-function))))

;; Build tags-completion-table on demand.  The single current tags table
;; and its included tags tables (and their included tables, etc.) have
;; their tags included in the completion table.
(defun tags-completion-table ()
  (or tags-completion-table
      (condition-case ()
	  (prog2
	   (message "Making tags completion table for %s..." buffer-file-name)
	   (let ((included (tags-included-tables))
		 (table (funcall tags-completion-table-function)))
	     (save-excursion
	       (while included
		 (let ((tags-file-name (car included)))
		   (visit-tags-file nil))
		 (if (tags-completion-table)
		     (mapatoms (function
				(lambda (sym)
				  (intern (symbol-name sym) table)))
			       tags-completion-table))
		 (setq included (cdr included))))
	     (setq tags-completion-table table))
	   (message "Making tags completion table for %s...done"
		    buffer-file-name))
	(quit (message "Tags completion table construction aborted.")
	      (setq tags-completion-table nil)))))

;; Completion function for tags.  Does normal try-completion,
;; but builds tags-completion-table on demand.
(defun tags-complete-tag (string predicate what)
  (save-excursion
    (visit-tags-table-buffer)
    (if (eq what t)
	(all-completions string (tags-completion-table) predicate)
      (try-completion string (tags-completion-table) predicate))))
Jim Blandy's avatar
Jim Blandy committed
407 408 409 410 411 412

;; Return a default tag to search for, based on the text at point.
(defun find-tag-default ()
  (save-excursion
    (while (looking-at "\\sw\\|\\s_")
      (forward-char 1))
Roland McGrath's avatar
Roland McGrath committed
413 414 415 416 417 418 419
    (if (or (re-search-backward "\\sw\\|\\s_"
				(save-excursion (beginning-of-line) (point))
				t)
	    (re-search-forward "\\(\\sw\\|\\s_\\)+"
			       (save-excursion (end-of-line) (point))
			       t))
	(progn (goto-char (match-end 0))
Jim Blandy's avatar
Jim Blandy committed
420 421 422 423 424 425 426
	       (buffer-substring (point)
				 (progn (forward-sexp -1)
					(while (looking-at "\\s'")
					  (forward-char 1))
					(point))))
      nil)))

Roland McGrath's avatar
Roland McGrath committed
427
;; Read a tag name from the minibuffer with defaulting and completion.
Jim Blandy's avatar
Jim Blandy committed
428
(defun find-tag-tag (string)
Roland McGrath's avatar
Roland McGrath committed
429 430 431 432 433 434 435
  (let* ((default (funcall (or find-tag-default-function
			       (get major-mode 'find-tag-default-function)
			       'find-tag-default)))
	 (spec (completing-read (if default
				    (format "%s(default %s) " string default)
				  string)
				'tags-complete-tag)))
Jim Blandy's avatar
Jim Blandy committed
436
    (list (if (equal spec "")
Roland McGrath's avatar
Roland McGrath committed
437
	      (or default (error "There is no default tag"))
Jim Blandy's avatar
Jim Blandy committed
438 439
	    spec))))

Roland McGrath's avatar
Roland McGrath committed
440 441 442
(defvar last-tag nil
  "Last tag found by \\[find-tag].")

Jim Blandy's avatar
Jim Blandy committed
443
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
444 445 446 447 448 449 450 451 452
(defun find-tag-noselect (tagname &optional next-p regexp-p)
  "Find tag (in current tags table) whose name contains TAGNAME.
Returns the buffer containing the tag's definition moves its point there,
but does not select the buffer.
The default for TAGNAME is the expression in the buffer near point.

If second arg NEXT-P is non-nil (interactively, with prefix arg), search
for another tag that matches the last tagname or regexp used.  When there
are multiple matches for a tag, more exact matches are found first.
Jim Blandy's avatar
Jim Blandy committed
453

Roland McGrath's avatar
Roland McGrath committed
454 455 456
If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.

See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
457 458 459
  (interactive (if current-prefix-arg
		   '(nil t)
		 (find-tag-tag "Find tag: ")))
Roland McGrath's avatar
Roland McGrath committed
460
  (let ((local-find-tag-hook find-tag-hook))
Roland McGrath's avatar
Roland McGrath committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
    (if next-p
	nil
      (setq last-tag tagname)
      (visit-tags-table-buffer 'reset))
    (prog1
	(find-tag-in-order (if next-p last-tag tagname)
			   (if regexp-p
			       find-tag-regexp-search-function
			     find-tag-search-function)
			   (if regexp-p
			       find-tag-regexp-tag-order
			     find-tag-tag-order)
			   (if regexp-p
			       find-tag-regexp-next-line-after-failure-p
			     find-tag-next-line-after-failure-p)
			   (if regexp-p "matching" "containing")
			   (not next-p))
      (run-hooks 'local-find-tag-hook))))
Jim Blandy's avatar
Jim Blandy committed
479

Jim Blandy's avatar
Jim Blandy committed
480
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
481 482 483 484
(defun find-tag (tagname &optional next-p)
  "Find tag (in current tags table) whose name contains TAGNAME.
Select the buffer containing the tag's definition, and move point there.
The default for TAGNAME is the expression in the buffer around or before point.
Jim Blandy's avatar
Jim Blandy committed
485

Roland McGrath's avatar
Roland McGrath committed
486 487 488
If second arg NEXT-P is non-nil (interactively, with prefix arg), search
for another tag that matches the last tagname used.  When there are
multiple matches, more exact matches are found first.
Jim Blandy's avatar
Jim Blandy committed
489

Roland McGrath's avatar
Roland McGrath committed
490
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
491 492
  (interactive (if current-prefix-arg
		   '(nil t)
Roland McGrath's avatar
Roland McGrath committed
493
		 (find-tag-tag "Find tag: ")))
Roland McGrath's avatar
Roland McGrath committed
494 495
  (switch-to-buffer (find-tag-noselect tagname next-p)))
;;;###autoload (define-key esc-map "." 'find-tag)
Jim Blandy's avatar
Jim Blandy committed
496

Jim Blandy's avatar
Jim Blandy committed
497
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
(defun find-tag-other-window (tagname &optional next-p)
  "Find tag (in current tags table) whose name contains TAGNAME.
Select the buffer containing the tag's definition
in another window, and move point there.
The default for TAGNAME is the expression in the buffer around or before point.

If second arg NEXT-P is non-nil (interactively, with prefix arg), search
for another tag that matches the last tagname used.  When there are
multiple matches, more exact matches are found first.

See documentation of variable `tags-file-name'."
  (interactive (if current-prefix-arg
		   '(nil t)
		 (find-tag-tag "Find tag other window: ")))
  (switch-to-buffer-other-window (find-tag-noselect tagname next-p)))
;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)

Roland McGrath's avatar
Roland McGrath committed
515
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
516
(defun find-tag-other-frame (tagname &optional next-p)
Jim Blandy's avatar
Jim Blandy committed
517 518 519 520 521
  "Find tag (in current tag table) whose name contains TAGNAME.
 Selects the buffer that the tag is contained in in another frame
and puts point at its definition.
 If TAGNAME is a null string, the expression in the buffer
around or before point is used as the tag name.
Roland McGrath's avatar
Roland McGrath committed
522
 If second arg NEXT-P is non-nil (interactively, with prefix arg),
Jim Blandy's avatar
Jim Blandy committed
523 524 525
searches for the next tag in the tag table
that matches the tagname used in the previous find-tag.

Roland McGrath's avatar
Roland McGrath committed
526
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
527 528 529
  (interactive (if current-prefix-arg
		   '(nil t)
		   (find-tag-tag "Find tag other window: ")))
Roland McGrath's avatar
Roland McGrath committed
530 531 532 533
  (let ((pop-up-frames t))
    (find-tag-other-window tagname next-p)))
;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame)

Jim Blandy's avatar
Jim Blandy committed
534
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
535 536 537
(defun find-tag-regexp (regexp &optional next-p other-window)
  "Find tag (in current tags table) whose name matches REGEXP.
Select the buffer containing the tag's definition and move point there.
Jim Blandy's avatar
Jim Blandy committed
538

Roland McGrath's avatar
Roland McGrath committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
If second arg NEXT-P is non-nil (interactively, with prefix arg), search
for another tag that matches the last tagname used.

If third arg OTHER-WINDOW is non-nil, select the buffer in another window.

See documentation of variable `tags-file-name'."
  (interactive (if current-prefix-arg
		   '(nil t)
		 (read-string "Find tag regexp: ")))
  (funcall (if other-window 'switch-to-buffer-other-window 'switch-to-buffer)
	   (find-tag-noselect regexp next-p t)))

;; Internal tag finding function.

;; PATTERN is a string to pass to second arg SEARCH-FORWARD-FUNC, and to
;; any member of the function list ORDER (third arg).  If ORDER is nil,
;; use saved state to continue a previous search.

;; Fourth arg MATCHING is a string, an English '-ing' word, to be used in
;; an error message.

;; Fifth arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match,
;; point should be moved to the next line.

;; Algorithm is as follows.  For each qualifier-func in ORDER, go to
;; beginning of tags file, and perform inner loop: for each naive match for
;; PATTERN found using SEARCH-FORWARD-FUNC, qualify the naive match using
;; qualifier-func.  If it qualifies, go to the specified line in the
;; specified source file and return.  Qualified matches are remembered to
;; avoid repetition.  State is saved so that the loop can be continued.

(defun find-tag-in-order (pattern search-forward-func order
				  next-line-after-failure-p matching
				  first-search)
  (let (file				;name of file containing tag
	tag-info			;where to find the tag in FILE
	tags-table-file			;name of tags file
	(first-table t)
	(tag-order order)
	goto-func
	)
    (save-excursion
      (or first-search
	  (visit-tags-table-buffer))
      ;; Get a qualified match.
      (catch 'qualified-match-found
	(while (or first-table
		   (visit-tags-table-buffer t))

	  (if first-search
	      (setq tag-lines-already-matched nil))

Roland McGrath's avatar
Roland McGrath committed
591 592 593 594
	  (and first-search first-table
	       ;; Start at beginning of tags file.
	       (goto-char (point-min)))
	  (setq first-table nil)
Roland McGrath's avatar
Roland McGrath committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

	  (setq tags-table-file buffer-file-name)
	  (while order
	    (while (funcall search-forward-func pattern nil t)
	      ;; Naive match found.  Qualify the match.
	      (and (funcall (car order) pattern)
		   ;; Make sure it is not a previous qualified match.
		   ;; Use of `memq' depends on numbers being eq.
		   (not (memq (save-excursion (beginning-of-line) (point))
			      tag-lines-already-matched))
		   (throw 'qualified-match-found nil))
	      (if next-line-after-failure-p
		  (forward-line 1)))
	    ;; Try the next flavor of match.
	    (setq order (cdr order))
	    (goto-char (point-min)))
	  (setq order tag-order))
	;; We throw out on match, so only get here if there were no matches.
	(error "No %stags %s %s" (if first-search "" "more ")
	       matching pattern))
      
      ;; Found a tag; extract location info.
      (beginning-of-line)
      (setq tag-lines-already-matched (cons (point)
					    tag-lines-already-matched))
      ;; Expand the filename, using the tags table buffer's default-directory.
      (setq file (expand-file-name (file-of-tag))
	    tag-info (funcall snarf-tag-function))

      ;; Get the local value in the tags table buffer.
      (setq goto-func goto-tag-location-function)

      ;; Find the right line in the specified file.
      (set-buffer (find-file-noselect file))
      (widen)
      (push-mark)
      (funcall goto-func tag-info)
      
      ;; Give this buffer a local value of tags-file-name.
      ;; The next time visit-tags-table-buffer is called,
      ;; it will use the same tags table that found a match in this buffer.
      (make-local-variable 'tags-file-name)
      (setq tags-file-name tags-table-file)
      
      ;; Return the buffer where the tag was found.
      (current-buffer))))

;; `etags' TAGS file format support.

(defun etags-recognize-tags-table ()
  (and (eq (char-after 1) ?\f)
       (message "%s is an `etags' TAGS file" buffer-file-name)
       (mapcar (function (lambda (elt)
			   (make-local-variable (car elt))
			   (set (car elt) (cdr elt))))
	       '((file-of-tag-function . etags-file-of-tag)
		 (tags-table-files-function . etags-tags-table-files)
		 (tags-completion-table-function . etags-tags-completion-table)
		 (snarf-tag-function . etags-snarf-tag)
		 (goto-tag-location-function . etags-goto-tag-location)
		 (find-tag-regexp-search-function . re-search-forward)
		 (find-tag-regexp-tag-order . (tag-re-match-p))
		 (find-tag-regexp-next-line-after-failuire-p . t)
		 (find-tag-search-function . search-forward)
		 (find-tag-tag-order . (tag-exact-match-p tag-word-match-p
							  tag-any-match-p))
		 (find-tag-next-line-after-failure-p . nil)
		 (list-tags-function . etags-list-tags)
		 (tags-apropos-function . etags-tags-apropos)
		 (tags-included-tables-function . etags-tags-included-tables)
		 (verify-tags-table-function . etags-verify-tags-table)
		 ))))

(defun etags-verify-tags-table ()
  (= (char-after 1) ?\f))

(defun etags-file-of-tag ()
  (save-excursion
    (search-backward "\f\n")
    (forward-char 2)
    (buffer-substring (point)
		      (progn (skip-chars-forward "^,") (point)))))

(defun etags-tags-completion-table ()
  (let ((table (make-vector 511 0)))
    (save-excursion
      (goto-char (point-min))
      (while (search-forward "\177" nil t)
	;; Handle multiple \177's on a line.
	(save-excursion
	  (skip-chars-backward "^-A-Za-z0-9_$\n") ;sym syntax? XXX
	  (or (bolp)
	      (intern (buffer-substring
		       (point)
		       (progn
			 (skip-chars-backward "-A-Za-z0-9_$")
			 ;; ??? New
			 ;; `::' in the middle of a C++ tag.
			 (and (= (preceding-char) ?:)
			      (= (char-after (- (point) 2)) ?:)
			      (progn
				(backward-char 2)
				(skip-chars-backward
				 "-A-Za-z0-9_$")))
			 (point)))
		      table)))))
    table))

(defun etags-snarf-tag ()
  (let (tag-text startpos)
    (search-forward "\177")
    (setq tag-text (buffer-substring (1- (point))
				     (save-excursion (beginning-of-line)
						     (point))))
    (search-forward ",")
    (setq startpos (string-to-int (buffer-substring
				   (point)
				   (progn (skip-chars-forward "0-9")
					  (point)))))
    ;; Leave point on the next line of the tags file.
    (forward-line 1)
    (cons tag-text startpos)))

(defun etags-goto-tag-location (tag-info)
  (let ((startpos (cdr tag-info))
	;; This constant is 1/2 the initial search window.
	;; There is no sense in making it too small,
	;; since just going around the loop once probably
	;; costs about as much as searching 2000 chars.
	(offset 1000)
	(found nil)
	(pat (concat "^" (regexp-quote (car tag-info)))))
    (or startpos
	(setq startpos (point-min)))
    (while (and (not found)
		(progn
		  (goto-char (- startpos offset))
		  (not (bobp))))
      (setq found
	    (re-search-forward pat (+ startpos offset) t)
	    offset (* 3 offset)))	; expand search window
    (or found
	(re-search-forward pat nil t)
	(error "`%s' not found in %s; time to rerun etags"
	       pat buffer-file-name)))
  (beginning-of-line))

(defun etags-list-tags (file)
  (goto-char 1)
  (if (not (search-forward (concat "\f\n" file ",") nil t))
      nil
    (forward-line 1)
    (while (not (or (eobp) (looking-at "\f")))
      (princ (buffer-substring (point)
			       (progn (skip-chars-forward "^\177")
				      (point))))
      (terpri)
      (forward-line 1))))

(defun etags-tags-apropos (string)
  (goto-char 1)
  (while (re-search-forward string nil t)
    (beginning-of-line)
    (princ (buffer-substring (point)
			     (progn (skip-chars-forward "^\177")
				    (point))))
    (terpri)
    (forward-line 1)))

(defun etags-tags-table-files ()
  (let ((files nil)
	beg)
    (goto-char (point-min))
    (while (search-forward "\f\n" nil t)
      (setq beg (point))
      (skip-chars-forward "^,\n")
      (or (looking-at ",include$")
	  ;; Expand in the default-directory of the tags table buffer.
	  (setq files (cons (expand-file-name (buffer-substring beg (point)))
			    files))))
    (nreverse files)))

(defun etags-tags-included-tables ()
  (let ((files nil)
	beg)
    (goto-char (point-min))
    (while (search-forward "\f\n" nil t)
      (setq beg (point))
      (skip-chars-forward "^,\n")
      (if (looking-at ",include$")
	  ;; Expand in the default-directory of the tags table buffer.
	  (setq files (cons (expand-file-name (buffer-substring beg (point)))
			    files))))
    (nreverse files)))

;; Empty tags file support.

(defun recognize-empty-tags-table ()
  (and (zerop (buffer-size))
       (mapcar (function (lambda (sym)
			   (make-local-variable sym)
Roland McGrath's avatar
Roland McGrath committed
796
			   (set sym 'ignore)))
Roland McGrath's avatar
Roland McGrath committed
797 798 799 800 801 802 803 804 805 806 807 808
	       '(tags-table-files-function
		 tags-completion-table-function
		 find-tag-regexp-search-function
		 find-tag-search-function
		 tags-apropos-function
		 tags-included-tables-function))
       (set (make-local-variable 'verify-tags-table-function)
	    (function (lambda ()
			(zerop (buffer-size)))))))

;;; Match qualifier functions for tagnames.

Roland McGrath's avatar
Roland McGrath committed
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
;; This might be a neat idea, but it's too hairy at the moment.
;;(defmacro tags-with-syntax (&rest body)
;;  (` (let ((current (current-buffer))
;;	   (otable (syntax-table))
;;	   (buffer (find-file-noselect (file-of-tag)))
;;	   table)
;;       (unwind-protect
;;	   (progn
;;	     (set-buffer buffer)
;;	     (setq table (syntax-table))
;;	     (set-buffer current)
;;	     (set-syntax-table table)
;;	     (,@ body))
;;	 (set-syntax-table otable)))))
;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form))
Roland McGrath's avatar
Roland McGrath committed
824

Roland McGrath's avatar
Roland McGrath committed
825 826
;; t if point is at a tag line that matches TAG "exactly".
;; point should be just after a string that matches TAG.
Roland McGrath's avatar
Roland McGrath committed
827 828 829 830 831
(defun tag-exact-match-p (tag)
  (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177") ;not a symbol char
       (save-excursion
	 (backward-char (1+ (length tag)))
	 (and (looking-at "\\Sw") (looking-at "\\S_")))))
Roland McGrath's avatar
Roland McGrath committed
832 833 834 835 836 837 838 839 840 841 842

;; t if point is at a tag line that matches TAG as a word.
;; point should be just after a string that matches TAG.
(defun tag-word-match-p (tag)
  (and (looking-at "\\b.*\177")
       (save-excursion (backward-char (1+ (length tag)))
		       (looking-at "\\b"))))

;; t if point is in a tag line with a tag containing TAG as a substring.
(defun tag-any-match-p (tag)
  (looking-at ".*\177"))
Jim Blandy's avatar
Jim Blandy committed
843

Roland McGrath's avatar
Roland McGrath committed
844 845 846 847 848 849 850 851
;; t if point is at a tag line that matches RE as a regexp.
(defun tag-re-match-p (re)
  (save-excursion
    (beginning-of-line)
    (let ((bol (point)))
      (and (search-forward "\177" (save-excursion (end-of-line) (point)) t)
	   (re-search-backward re bol t)))))

Jim Blandy's avatar
Jim Blandy committed
852
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
853 854 855 856 857 858 859 860 861 862
(defun next-file (&optional initialize novisit)
  "Select next file among files in current tags table.
Non-nil first argument (prefix arg, if interactive)
initializes to the beginning of the list of files in the tags table.

Non-nil second argument NOVISIT means use a temporary buffer
 to save time and avoid uninteresting warnings.

Value is nil if the file was already visited;
if the file was newly read in, the value is the filename."
Jim Blandy's avatar
Jim Blandy committed
863
  (interactive "P")
Roland McGrath's avatar
Roland McGrath committed
864 865 866 867
  (and initialize
       (save-excursion
	 (visit-tags-table-buffer 'reset)
	 (setq next-file-list (tags-table-files))))
Jim Blandy's avatar
Jim Blandy committed
868
  (or next-file-list
Roland McGrath's avatar
Roland McGrath committed
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
      (save-excursion
	;; When doing (visit-tag-table-buffer t),
	;; the tags table buffer must be current.
	(if (and (visit-tags-table-buffer 'same)
		 (visit-tags-table-buffer t))
	    (setq next-file-list (tags-table-files))
	  (and novisit
	       (get-buffer " *next-file*")
	       (kill-buffer " *next-file*"))
	  (error "All files processed."))))
  (let ((new (not (get-file-buffer (car next-file-list)))))
    (if (not (and new novisit))
	(set-buffer (find-file-noselect (car next-file-list) novisit))
      ;; Like find-file, but avoids random warning messages.
      (set-buffer (get-buffer-create " *next-file*"))
      (kill-all-local-variables)
      (erase-buffer)
      (setq new (car next-file-list))
      (insert-file-contents new nil))
    (setq next-file-list (cdr next-file-list))
    new))
Jim Blandy's avatar
Jim Blandy committed
890

Roland McGrath's avatar
Roland McGrath committed
891 892 893 894 895 896 897
(defvar tags-loop-operate nil
  "Form for `tags-loop-continue' to eval to change one file.")

(defvar tags-loop-scan nil
  "Form for `tags-loop-continue' to eval to scan one file.
If it returns non-nil, this file needs processing by evalling
\`tags-loop-operate'.  Otherwise, move on to the next file.")
Jim Blandy's avatar
Jim Blandy committed
898

Jim Blandy's avatar
Jim Blandy committed
899
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
900 901
(defun tags-loop-continue (&optional first-time)
  "Continue last \\[tags-search] or \\[tags-query-replace] command.
Roland McGrath's avatar
Roland McGrath committed
902 903 904 905 906 907
Used noninteractively with non-nil argument to begin such a command.
Two variables control the processing we do on each file:
the value of `tags-loop-scan' is a form to be executed on each file
to see if it is interesting (it returns non-nil if so)
and `tags-loop-operate' is a form to execute to operate on an interesting file
If the latter returns non-nil, we exit; otherwise we scan the next file."
Jim Blandy's avatar
Jim Blandy committed
908
  (interactive)
Roland McGrath's avatar
Roland McGrath committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
  (let (new
	(messaged nil))
    (while
	(progn
	  ;; Scan files quickly for the first or next interesting one.
	  (while (or first-time
		     (save-restriction
		       (widen)
		       (not (eval tags-loop-scan))))
	    (setq new (next-file first-time t))
	    ;; If NEW is non-nil, we got a temp buffer,
	    ;; and NEW is the file name.
	    (if (or messaged
		    (and (not first-time)
			 (> baud-rate search-slow-speed)
			 (setq messaged t)))
		(message "Scanning file %s..." (or new buffer-file-name)))
	    (setq first-time nil)
	    (goto-char (point-min)))

	  ;; If we visited it in a temp buffer, visit it now for real.
	  (if new
	      (let ((pos (point)))
		(erase-buffer)
		(set-buffer (find-file-noselect new))
		(widen)
		(goto-char pos)))

	  (switch-to-buffer (current-buffer))

	  ;; Now operate on the file.
	  ;; If value is non-nil, continue to scan the next file.
	  (eval tags-loop-operate)))
    (and messaged
	 (null tags-loop-operate)
	 (message "Scanning file %s...found" buffer-file-name))))
    
;;;###autoload (define-key esc-map "," 'tags-loop-continue)
Jim Blandy's avatar
Jim Blandy committed
947

Jim Blandy's avatar
Jim Blandy committed
948
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
949
(defun tags-search (regexp)
Roland McGrath's avatar
Roland McGrath committed
950
  "Search through all files listed in tags table for match for REGEXP.
Jim Blandy's avatar
Jim Blandy committed
951 952 953
Stops when a match is found.
To continue searching for next match, use command \\[tags-loop-continue].

Roland McGrath's avatar
Roland McGrath committed
954
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
955 956
  (interactive "sTags search (regexp): ")
  (if (and (equal regexp "")
Roland McGrath's avatar
Roland McGrath committed
957 958 959
	   (eq (car tags-loop-scan) 're-search-forward)
	   (eq tags-loop-operate t))
      ;; Continue last tags-search as if by M-,.
Jim Blandy's avatar
Jim Blandy committed
960
      (tags-loop-continue nil)
Roland McGrath's avatar
Roland McGrath committed
961 962 963
    (setq tags-loop-scan
	  (list 're-search-forward regexp nil t)
	  tags-loop-operate nil)
Jim Blandy's avatar
Jim Blandy committed
964 965
    (tags-loop-continue t)))

Jim Blandy's avatar
Jim Blandy committed
966
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
967
(defun tags-query-replace (from to &optional delimited)
Roland McGrath's avatar
Roland McGrath committed
968
  "Query-replace-regexp FROM with TO through all files listed in tags table.
Jim Blandy's avatar
Jim Blandy committed
969
Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
Roland McGrath's avatar
Roland McGrath committed
970
If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace
Jim Blandy's avatar
Jim Blandy committed
971 972
with the command \\[tags-loop-continue].

Roland McGrath's avatar
Roland McGrath committed
973 974 975
See documentation of variable `tags-file-name'."
  (interactive
   "sTags query replace (regexp): \nsTags query replace %s by: \nP")
Roland McGrath's avatar
Roland McGrath committed
976 977 978 979 980 981
  (setq tags-loop-scan (list 'prog1
			     (list 'if (list 're-search-forward form nil t)
				   ;; When we find a match, move back
				   ;; to the beginning of it so perform-replace
				   ;; will see it.
				   '(goto-char (match-beginning 0))))
Roland McGrath's avatar
Roland McGrath committed
982
	tags-loop-operate (list 'perform-replace from to t t delimited))
Jim Blandy's avatar
Jim Blandy committed
983
  (tags-loop-continue t))
Roland McGrath's avatar
Roland McGrath committed
984

Jim Blandy's avatar
Jim Blandy committed
985
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
986
(defun list-tags (file)
Jim Blandy's avatar
Jim Blandy committed
987
  "Display list of tags in file FILE.
Roland McGrath's avatar
Roland McGrath committed
988 989 990 991
FILE should not contain a directory specification
unless it has one in the tags table."
  (interactive (list (completing-read "List tags in file: " nil
				      'tags-table-files t nil)))
Jim Blandy's avatar
Jim Blandy committed
992 993
  (with-output-to-temp-buffer "*Tags List*"
    (princ "Tags in file ")
Roland McGrath's avatar
Roland McGrath committed
994
    (princ file)
Jim Blandy's avatar
Jim Blandy committed
995 996
    (terpri)
    (save-excursion
Roland McGrath's avatar
Roland McGrath committed
997 998 999 1000 1001 1002 1003
      (let ((first-time t)
	    (gotany nil))
	(while (visit-tags-table-buffer (if first-time 'reset t))
	  (if (funcall list-tags-function file)
	      (setq gotany t)))
	(or gotany
	    (error "File %s not in current tags tables"))))))
Jim Blandy's avatar
Jim Blandy committed
1004

Jim Blandy's avatar
Jim Blandy committed
1005
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1006 1007 1008
(defun tags-apropos (regexp)
  "Display list of all tags in tags table REGEXP matches."
  (interactive "sTags apropos (regexp): ")
Jim Blandy's avatar
Jim Blandy committed
1009 1010
  (with-output-to-temp-buffer "*Tags List*"
    (princ "Tags matching regexp ")
Roland McGrath's avatar
Roland McGrath committed
1011
    (prin1 regexp)
Jim Blandy's avatar
Jim Blandy committed
1012 1013
    (terpri)
    (save-excursion
Roland McGrath's avatar
Roland McGrath committed
1014 1015 1016 1017 1018
      (let ((first-time nil))
	(while (visit-tags-table-buffer (if first-time 'reset t))
	  (funcall tags-apropos-function))))))

;;; XXX Kludge interface.
Jim Blandy's avatar
Jim Blandy committed
1019

Roland McGrath's avatar
Roland McGrath committed
1020
;; XXX If a file is in multiple tables, selection may get the wrong one.
Roland McGrath's avatar
Roland McGrath committed
1021
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
(defun select-tags-table ()
  "Select a tags table file from a menu of those you have already used.
The list of tags tables to select from is stored in `tags-table-file-list';
see the doc of that variable if you want to add names to the list."
  (interactive)
  (pop-to-buffer "*Tags Table List*")
  (setq buffer-read-only nil)
  (erase-buffer)
  (setq selective-display t
	selective-display-ellipses nil)
  (let ((set-list tags-table-set-list)
	(desired-point nil))
    (if tags-table-list
	(progn
	  (setq desired-point (point-marker))
	  (princ tags-table-list (current-buffer))
	  (insert "\C-m")
	  (prin1 (car tags-table-list) (current-buffer)) ;invisible
	  (insert "\n")))
    (while set-list
      (if (eq (car set-list) tags-table-list)
	  ;; Already printed it.
	  ()
	(princ (car set-list) (current-buffer))
	(insert "\C-m")
	(prin1 (car (car set-list)) (current-buffer)) ;invisible
	(insert "\n"))
      (setq set-list (cdr set-list)))
    (if tags-file-name
	(progn
	  (or desired-point
	      (setq desired-point (point-marker)))
	  (insert tags-file-name "\C-m")
	  (prin1 tags-file-name (current-buffer)) ;invisible
	  (insert "\n")))
    (setq set-list (delete tags-file-name
			   (apply 'nconc (cons tags-table-list
					       (mapcar 'copy-sequence
						       tags-table-set-list)))))
    (while set-list
      (insert (car set-list) "\C-m")
      (prin1 (car set-list) (current-buffer)) ;invisible
      (insert "\n")
      (setq set-list (delete (car set-list) set-list)))
    (goto-char 1)
    (insert-before-markers
     "Type `t' to select a tags table or set of tags tables:\n\n")
    (if desired-point
	(goto-char desired-point))
    (set-window-start (selected-window) 1 t))
  (set-buffer-modified-p nil)
  (setq buffer-read-only t
	mode-name "Select Tags Table")
  (let ((map (make-sparse-keymap)))
    (define-key map "t" 'select-tags-table-select)
    (define-key map " " 'next-line)
    (define-key map "\^?" 'previous-line)
    (define-key map "n" 'next-line)
    (define-key map "p" 'previous-line)
    (define-key map "q" 'select-tags-table-quit)
    (use-local-map map)))
  
(defun select-tags-table-select ()
  "Select the tags table named on this line."
  (interactive)
  (search-forward "\C-m")
  (let ((name (read (current-buffer))))
    (visit-tags-table name)
    (select-tags-table-quit)
    (message "Tags table now %s" name)))
Jim Blandy's avatar
Jim Blandy committed
1092

Roland McGrath's avatar
Roland McGrath committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
(defun select-tags-table-quit ()
  "Kill the buffer and delete the selected window."
  (interactive)
  (kill-buffer (current-buffer))
  (or (one-window-p)
      (delete-window)))  

;;;###autoload
(defun complete-tag ()
  "Perform tags completion on the text around point.
Completes to the set of names listed in the current tags table.  
The string to complete is chosen in the same way as the default
for \\[find-tag] (which see).  See also `visit-tags-table-buffer'."
  (interactive)
  (let ((pattern (funcall (or find-tag-default-function
			      (get major-mode 'find-tag-default-function)
			      'find-tag-default)))
	beg
	completion)
    (or pattern
	(error "Nothing to complete"))
    (search-backward pattern)
    (setq beg (point))
    (forward-char (length pattern))
    (setq completion (try-completion pattern 'tags-complete-tag nil))
    (cond ((eq completion t))
	  ((null completion)
	   (message "Can't find completion for \"%s\"" pattern)
	   (ding))
	  ((not (string= pattern completion))
	   (delete-region beg (point))
	   (insert completion))
	  (t
	   (message "Making completion list...")
	   (with-output-to-temp-buffer " *Completions*"
	     (display-completion-list
	      (all-completions pattern 'tags-complete-tag nil)))
	   (message "Making completion list...%s" "done")))))
Roland McGrath's avatar
Roland McGrath committed
1131 1132

;;;###autoload (define-key esc-map "\t" 'complete-tag)
Roland McGrath's avatar
Roland McGrath committed
1133 1134

(provide 'etags)
Eric S. Raymond's avatar
Eric S. Raymond committed
1135 1136

;;; etags.el ends here