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

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

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

Jim Blandy's avatar
Jim Blandy committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
14 15 16 17 18 19 20 21 22 23 24
;; 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
25 26
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
27
;;;###autoload
28 29
(defvar tags-file-name nil
  "*File name of tags table.
Roland McGrath's avatar
Roland McGrath committed
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'.
Roland McGrath's avatar
Roland McGrath committed
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.
Roland McGrath's avatar
Roland McGrath committed
34
;;;###autoload (put 'tags-file-name 'variable-interactive "fVisit tags table: ")
Roland McGrath's avatar
Roland McGrath committed
35 36

;;;###autoload
37
;; Use `visit-tags-table-buffer' to cycle through tags tables in this list.
Roland McGrath's avatar
Roland McGrath committed
38
(defvar tags-table-list nil
39 40 41 42 43
  "*List of file names of tags tables to search.
An element that is a directory means the file \"TAGS\" in that directory.
To switch to a new list of tags tables, setting this variable is sufficient.
If you set this variable, do not also set `tags-file-name'.
Use the `etags' program to make a tags table file.")
Roland McGrath's avatar
Roland McGrath committed
44 45

(defvar tags-table-list-pointer nil
Roland McGrath's avatar
Roland McGrath committed
46 47 48 49 50 51
  "Pointer into `tags-table-list' where the current state of searching is.
Might instead point into a list of included tags tables.
Use `visit-tags-table-buffer' to cycle through tags tables in this list.")

(defvar tags-table-list-started-at nil
  "Pointer into `tags-table-list', where the current search started.")
Roland McGrath's avatar
Roland McGrath committed
52 53

(defvar tags-table-parent-pointer-list nil
Roland McGrath's avatar
Roland McGrath committed
54 55 56 57
  "Saved state of the tags table that included this one.
Each element is (POINTER . STARTED-AT), giving the values of
 `tags-table-list-pointer' and `tags-table-list-started-at' from
 before we moved into the current table.")
Roland McGrath's avatar
Roland McGrath committed
58 59 60 61 62 63 64 65 66 67 68 69 70

(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
Roland McGrath's avatar
Roland McGrath committed
71 72
  "*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'
Roland McGrath's avatar
Roland McGrath committed
73 74 75 76 77 78 79
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.")
80 81 82 83

(defvar tags-location-stack nil
  "List of markers which are locations visited by \\[find-tag].
Pop back to the last location with \\[negative-argument] \\[find-tag].")
Roland McGrath's avatar
Roland McGrath committed
84 85 86

;; Tags table state.
;; These variables are local in tags table buffers.
Jim Blandy's avatar
Jim Blandy committed
87

Roland McGrath's avatar
Roland McGrath committed
88 89 90
(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
91

Roland McGrath's avatar
Roland McGrath committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
(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
108
				  recognize-empty-tags-table)
Roland McGrath's avatar
Roland McGrath committed
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
  "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
144
  "Function to return t iff the current buffer contains a valid
Roland McGrath's avatar
Roland McGrath committed
145 146
\(already initialized\) tags file.")

147 148 149 150
;; Initialize the tags table in the current buffer.
;; Returns non-nil iff it is a valid tags table.  On
;; non-nil return, the tags table state variable are
;; made buffer-local and initialized to nil.
Roland McGrath's avatar
Roland McGrath committed
151
(defun initialize-new-tags-table ()
152 153 154 155
  (set (make-local-variable 'tag-lines-already-matched) nil)
  (set (make-local-variable 'tags-table-files) nil)
  (set (make-local-variable 'tags-completion-table) nil)
  (set (make-local-variable 'tags-included-tables) nil)
Roland McGrath's avatar
Roland McGrath committed
156 157 158 159 160 161
  ;; 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
162

Jim Blandy's avatar
Jim Blandy committed
163
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
164 165
(defun visit-tags-table (file &optional local)
  "Tell tags commands to use tags table file FILE.
Jim Blandy's avatar
Jim Blandy committed
166
FILE should be the name of a file created with the `etags' program.
Roland McGrath's avatar
Roland McGrath committed
167 168 169 170 171 172 173
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
174 175
  (interactive (list (read-file-name "Visit tags table: (default TAGS) "
				     default-directory
Roland McGrath's avatar
Roland McGrath committed
176 177 178 179
				     (expand-file-name "TAGS"
						       default-directory)
				     t)
		     current-prefix-arg))
180 181 182
  ;; Calling visit-tags-table-buffer with tags-file-name set to FILE will
  ;; initialize a buffer for FILE and set tags-file-name to the
  ;; fully-expanded name.
Roland McGrath's avatar
Roland McGrath committed
183 184
  (let ((tags-file-name file))
    (save-excursion
Roland McGrath's avatar
Roland McGrath committed
185
      (or (visit-tags-table-buffer 'same)
Roland McGrath's avatar
Roland McGrath committed
186 187 188
	  (signal 'file-error (list "Visiting tags table"
				    "file does not exist"
				    file)))
189
      ;; Set FILE to the expanded name.
Roland McGrath's avatar
Roland McGrath committed
190
      (setq file tags-file-name)))
Roland McGrath's avatar
Roland McGrath committed
191
  (if local
192
      ;; Set the local value of tags-file-name.
Roland McGrath's avatar
Roland McGrath committed
193
      (set (make-local-variable 'tags-file-name) file)
194
    ;; Set the global value of tags-file-name.
Roland McGrath's avatar
Roland McGrath committed
195 196 197
    (setq-default tags-file-name file)))

;; Move tags-table-list-pointer along and set tags-file-name.
198
;; If NO-INCLUDES is non-nil, ignore included tags tables.
Roland McGrath's avatar
Roland McGrath committed
199
;; Returns nil when out of tables.
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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
(defun tags-next-table (&optional no-includes)
  ;; Do we have any included tables?
  (if (and (not no-includes)
	   (visit-tags-table-buffer 'same)
	   (tags-included-tables))

      ;; Move into the included tags tables.
      (setq tags-table-parent-pointer-list
	    ;; Save the current state of what table we are in.
	    (cons (cons tags-table-list-pointer tags-table-list-started-at)
		  tags-table-parent-pointer-list)
	    ;; Start the pointer in the list of included tables.
	    tags-table-list-pointer tags-included-tables
	    tags-table-list-started-at tags-included-tables)

    ;; No included tables.  Go to the next table in the list.
    (setq tags-table-list-pointer
	  (cdr tags-table-list-pointer))
    (or tags-table-list-pointer
	;; Wrap around.
	(setq tags-table-list-pointer tags-table-list))

    (if (eq tags-table-list-pointer tags-table-list-started-at)
	;; We have come full circle.  No more tables.
	(if tags-table-parent-pointer-list
	    ;; Pop back to the tags table which includes this one.
	    (progn
	      ;; Restore the state variables.
	      (setq tags-table-list-pointer
		    (car (car tags-table-parent-pointer-list))
		    tags-table-list-started-at
		    (cdr (car tags-table-parent-pointer-list))
		    tags-table-parent-pointer-list
		    (cdr tags-table-parent-pointer-list))
	      ;; Recurse to skip to the next table after the parent.
	      (tags-next-table t))
	  ;; All out of tags tables.
	  (setq tags-table-list-pointer nil))))

  (and tags-table-list-pointer
       ;; Set tags-file-name to the fully-expanded name.
       (setq tags-file-name
	     (tags-expand-table-name (car tags-table-list-pointer)))))

;; Expand tags table name FILE into a complete file name.
Roland McGrath's avatar
Roland McGrath committed
245 246 247 248 249 250
(defun tags-expand-table-name (file)
  (setq file (expand-file-name file))
  (if (file-directory-p file)
      (expand-file-name "TAGS" file)
    file))

251 252
;; Return the cdr of LIST (default: tags-table-list) whose car
;; is equal to FILE after tags-expand-table-name on both sides.
Roland McGrath's avatar
Roland McGrath committed
253 254 255 256 257 258 259 260 261
(defun tags-table-list-member (file &optional list)
  (or list
      (setq list tags-table-list))
  (setq file (tags-expand-table-name file))
  (while (and list
	      (not (string= file (tags-expand-table-name (car list)))))
    (setq list (cdr list)))
  list)

262 263 264 265
;; Local var in visit-tags-table-buffer-cont
;; which is set by tags-table-including.
(defvar visit-tags-table-buffer-cont)

Roland McGrath's avatar
Roland McGrath committed
266
;; Subroutine of visit-tags-table-buffer.  Frobs its local vars.
267 268 269 270 271 272
;; Search TABLES for one that has tags for THIS-FILE.  Recurses on
;; included tables.  Returns the tail of TABLES (or of an inner
;; included list) whose car is a table listing THIS-FILE.  If
;; CORE-ONLY is non-nil, check only tags tables that are already in
;; buffers--don't visit any new files.
(defun tags-table-including (this-file tables core-only &optional recursing)
Roland McGrath's avatar
Roland McGrath committed
273
  (let ((found nil))
274
    ;; Loop over TABLES, looking for one containing tags for THIS-FILE.
Roland McGrath's avatar
Roland McGrath committed
275 276 277 278
    (while (and (not found)
		tables)
      (let ((tags-file-name (tags-expand-table-name (car tables))))
	(if (or (get-file-buffer tags-file-name)
279 280
		(and (not core-only)
		     (file-exists-p tags-file-name)))
Roland McGrath's avatar
Roland McGrath committed
281 282 283 284 285 286 287 288 289 290 291 292
	    (progn
	      ;; Select the tags table buffer and get the file list up to date.
	      (visit-tags-table-buffer 'same)
	      (or tags-table-files
		  (setq tags-table-files
			(funcall tags-table-files-function)))

	      (cond ((member this-file tags-table-files)
		     ;; Found it.
		     (setq found tables))

		    ((tags-included-tables)
293
		     ;; This table has included tables.  Check them.
Roland McGrath's avatar
Roland McGrath committed
294 295 296 297 298 299 300 301 302
		     (let ((old tags-table-parent-pointer-list))
		       (unwind-protect
			   (progn
			     (or recursing
				 ;; At top level (not in an included tags
				 ;; table), set the list to nil so we can
				 ;; collect just the elts from this run.
				 (setq tags-table-parent-pointer-list nil))
			     (setq found
303
				   ;; Recurse on the list of included tables.
Roland McGrath's avatar
Roland McGrath committed
304 305
				   (tags-table-including this-file
							 tags-included-tables
306
							 core-only
Roland McGrath's avatar
Roland McGrath committed
307 308
							 t))
			     (if found
309 310 311 312 313 314 315 316 317 318
				 ;; One of them lists THIS-FILE.
				 ;; Set the table list state variables to move
				 ;; us inside the list of included tables.
				 (setq tags-table-parent-pointer-list
				       (cons
					(cons tags-table-list-pointer
					      tags-table-list-started-at)
					tags-table-parent-pointer-list)
				       tags-table-list-pointer found
				       tags-table-list-started-at found
319
				       ;; Set a local variable of
320 321
				       ;; our caller, visit-tags-table-buffer.
				       ;; Set it so we won't frob lists later.
322 323
				       visit-tags-table-buffer-cont
				       'included)))
Roland McGrath's avatar
Roland McGrath committed
324
			 (or recursing
325 326 327 328 329 330 331 332 333
			     ;; tags-table-parent-pointer-list now describes
			     ;; the path of included tables taken by recursive
			     ;; invocations of this function.  The recursive
			     ;; calls have consed onto the front of the list,
			     ;; so it is now outermost first.  We want it
			     ;; innermost first, so reverse it.  Then append
			     ;; the old list (from before we were called the
			     ;; outermost time), to get the complete current
			     ;; state of included tables.
Roland McGrath's avatar
Roland McGrath committed
334 335 336 337 338 339
			     (setq tags-table-parent-pointer-list
				   (nconc (nreverse
					   tags-table-parent-pointer-list)
					  old))))))))))
      (setq tables (cdr tables)))
    found))
Roland McGrath's avatar
Roland McGrath committed
340 341 342 343 344

(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 `same', don't look for a new table;
345
 just select the buffer visiting `tags-file-name'.
Roland McGrath's avatar
Roland McGrath committed
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'.
Roland McGrath's avatar
Roland McGrath committed
348
Returns t if it visits a tags table, or nil if there are no more in the list."
349 350

  ;; Set tags-file-name to the tags table file we want to visit.
351 352 353 354 355 356 357 358 359 360 361 362 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 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
  (let ((visit-tags-table-buffer-cont cont))
    (cond ((eq visit-tags-table-buffer-cont 'same)
	   ;; Use the ambient value of tags-file-name.
	   (or tags-file-name
	       (error (substitute-command-keys
		       (concat "No tags table in use!  "
			       "Use \\[visit-tags-table] to select one."))))
	   ;; Set VISIT-TAGS-TABLE-BUFFER-CONT to nil
	   ;; so the code below will make sure tags-file-name
	   ;; is in tags-table-list.
	   (setq visit-tags-table-buffer-cont nil))

	  (visit-tags-table-buffer-cont
	   ;; Find the next table.
	   (if (tags-next-table)
	       ;; Skip over nonexistent files.
	       (while (and (let ((file (tags-expand-table-name tags-file-name)))
			     (not (or (get-file-buffer file)
				      (file-exists-p file))))
			   (tags-next-table)))))

	  (t
	   ;; Pick a table out of our hat.
	   (setq tags-file-name
		 (or
		  ;; First, try a local variable.
		  (cdr (assq 'tags-file-name (buffer-local-variables)))
		  ;; Second, try a user-specified function to guess.
		  (and default-tags-table-function
		       (funcall default-tags-table-function))
		  ;; Third, look for a tags table that contains
		  ;; tags for the current buffer's file.
		  ;; If one is found, the lists will be frobnicated,
		  ;; and VISIT-TAGS-TABLE-BUFFER-CONT
		  ;; will be set non-nil so we don't do it below.
		  (car (or 
			;; First check only tables already in buffers.
			(save-excursion (tags-table-including buffer-file-name
								 tags-table-list
								 t))
			;; Since that didn't find any, now do the
			;; expensive version: reading new files.
			(save-excursion (tags-table-including buffer-file-name
							      tags-table-list
							      nil))))
		  ;; Fourth, use the user variable tags-file-name, if it is not
		  ;; already in tags-table-list.
		  (and tags-file-name
		       (not (tags-table-list-member tags-file-name))
		       tags-file-name)
		  ;; Fifth, use the user variable giving the table list.
		  ;; Find the first element of the list that actually exists.
		  (let ((list tags-table-list)
			file)
		    (while (and list
				(setq file (tags-expand-table-name (car list)))
				(not (get-file-buffer file))
				(not (file-exists-p file)))
		      (setq list (cdr list)))
		    (car list))
		  ;; Finally, prompt the user for a file name.
		  (expand-file-name
		   (read-file-name "Visit tags table: (default TAGS) "
				   default-directory
				   "TAGS"
				   t))))))

    ;; Expand the table name into a full file name.
    (setq tags-file-name (tags-expand-table-name tags-file-name))

    (if (and (eq visit-tags-table-buffer-cont t) (null tags-table-list-pointer))
	;; All out of tables.
	nil

      ;; Verify that tags-file-name is a valid tags table.
      (if (if (get-file-buffer tags-file-name)
	      ;; The file is already in a buffer.  Check for the visited file
	      ;; having changed since we last used it.
	      (let (win)
		(set-buffer (get-file-buffer tags-file-name))
		(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 tags-file-name))
	    (or (string= tags-file-name buffer-file-name)
		;; find-file-noselect has changed the file name.
		;; Propagate the change to tags-file-name and tags-table-list.
		(let ((tail (member tags-file-name tags-table-list)))
		  (if tail
		      (setcar tail buffer-file-name))
		  (setq tags-file-name buffer-file-name)))
	    (initialize-new-tags-table))

	  ;; We have a valid tags table.
	  (progn
	    ;; Bury the tags table buffer so it
	    ;; doesn't get in the user's way.
	    (bury-buffer (current-buffer))

	    (if visit-tags-table-buffer-cont
		;; No list frobbing required.
		nil

	      ;; Look in the list for the table we chose.
	      (let ((elt (tags-table-list-member tags-file-name)))
		(or elt
		    ;; 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 (tags-table-list-member
						  tags-file-name (car sets)))))
			(setq sets (cdr sets)))
		      (if sets
			  ;; Found in some other set.  Switch to that set.
			  (progn
			    (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)))

			;; Not found in any existing set.
			(if (and tags-table-list
				 (y-or-n-p (concat "Add " tags-file-name
						   " to current list"
						   " of tags tables? ")))
			    ;; Add it to the current list.
			    (setq tags-table-list (cons tags-file-name
							tags-table-list))
			  ;; Make a fresh list, and store the old one.
Roland McGrath's avatar
Roland McGrath committed
488 489
			  (or (memq tags-table-list tags-table-set-list)
			      (setq tags-table-set-list
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
				    (cons tags-table-list tags-table-set-list)))
			  (setq tags-table-list (list tags-file-name)))
			(setq elt tags-table-list))))

		;; Set the tags table list state variables to point at the table
		;; we want to use first.
		(setq tags-table-list-started-at elt
		      tags-table-list-pointer elt)))

	    ;; Return of t says the tags table is valid.
	    t)

	;; The buffer was not valid.  Don't use it again.
	(let ((file tags-file-name))
	  (kill-local-variable 'tags-file-name)
	  (if (eq file tags-file-name)
	      (setq tags-file-name nil)))
	(error "File %s is not a valid tags table" buffer-file-name)))))
508

Jim Blandy's avatar
Jim Blandy committed
509 510
(defun file-of-tag ()
  "Return the file name of the file whose tags point is within.
Roland McGrath's avatar
Roland McGrath committed
511 512 513
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
514

Jim Blandy's avatar
Jim Blandy committed
515
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
516 517
(defun tags-table-files ()
  "Return a list of files in the current tags table.
518
Assumes the tags table is the current buffer.
Jim Blandy's avatar
Jim Blandy committed
519
File names returned are absolute."
520 521 522
  (or tags-table-files
      (setq tags-table-files
	    (funcall tags-table-files-function))))
Roland McGrath's avatar
Roland McGrath committed
523 524

(defun tags-included-tables ()
525 526
  "Return a list of tags tables included by the current table.
Assumes the tags table is the current buffer."
Roland McGrath's avatar
Roland McGrath committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540
  (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
541 542
	       ;; Iterate over the list of included tables, and combine each
	       ;; included table's completion obarray to the parent obarray.
Roland McGrath's avatar
Roland McGrath committed
543
	       (while included
544
		 ;; Visit the buffer.
Roland McGrath's avatar
Roland McGrath committed
545
		 (let ((tags-file-name (car included)))
Roland McGrath's avatar
Roland McGrath committed
546
		   (visit-tags-table-buffer 'same))
547
		 ;; Recurse in that buffer to compute its completion table.
Roland McGrath's avatar
Roland McGrath committed
548
		 (if (tags-completion-table)
549
		     ;; Combine the tables.
Roland McGrath's avatar
Roland McGrath committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
		     (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))))
569

Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574
;; 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
575 576 577 578 579 580 581
    (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
582 583 584 585 586 587 588
	       (buffer-substring (point)
				 (progn (forward-sexp -1)
					(while (looking-at "\\s'")
					  (forward-char 1))
					(point))))
      nil)))

Roland McGrath's avatar
Roland McGrath committed
589
;; Read a tag name from the minibuffer with defaulting and completion.
Jim Blandy's avatar
Jim Blandy committed
590
(defun find-tag-tag (string)
Roland McGrath's avatar
Roland McGrath committed
591 592 593 594 595 596 597
  (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)))
598 599 600
    (if (equal spec "")
	(or default (error "There is no default tag"))
      spec)))
Jim Blandy's avatar
Jim Blandy committed
601

Roland McGrath's avatar
Roland McGrath committed
602 603 604
(defvar last-tag nil
  "Last tag found by \\[find-tag].")

605 606 607 608 609 610 611 612 613 614
;; Get interactive args for find-tag{-noselect,-other-window,-regexp}.
(defun find-tag-interactive (prompt &optional no-default)
  (if current-prefix-arg
      (list nil (if (< (prefix-numeric-value current-prefix-arg) 0)
		    '-
		  t))
    (list (if no-default
	      (read-string prompt)
	    (find-tag-tag prompt)))))

Jim Blandy's avatar
Jim Blandy committed
615
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
616 617
(defun find-tag-noselect (tagname &optional next-p regexp-p)
  "Find tag (in current tags table) whose name contains TAGNAME.
618
Returns the buffer containing the tag's definition and moves its point there,
Roland McGrath's avatar
Roland McGrath committed
619 620 621
but does not select the buffer.
The default for TAGNAME is the expression in the buffer near point.

622 623 624 625 626
If second arg NEXT-P is t (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.  If NEXT-P
is the atom `-' (interactively, with prefix arg that is a negative number
or just \\[negative-argument]), pop back to the previous tag gone to.
Jim Blandy's avatar
Jim Blandy committed
627

Roland McGrath's avatar
Roland McGrath committed
628 629 630
If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.

See documentation of variable `tags-file-name'."
631 632
  (interactive (find-tag-interactive "Find tag: "))

633 634
  ;; Save the current buffer's value of `find-tag-hook' before selecting the
  ;; tags table buffer.
Roland McGrath's avatar
Roland McGrath committed
635
  (let ((local-find-tag-hook find-tag-hook))
636 637 638 639 640 641 642 643 644 645 646
    (if (eq '- next-p)
	;; Pop back to a previous location.
	(if (null tags-location-stack)
	    (error "No previous tag locations")
	  (let ((marker (car tags-location-stack)))
	    ;; Pop the stack.
	    (setq tags-location-stack (cdr tags-location-stack))
	    (prog1
		;; Move to the saved location.
		(set-buffer (marker-buffer marker))
	      (goto-char (marker-position marker))
647
	      ;; Kill that marker so it doesn't slow down editing.
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
	      (set-marker marker nil nil)
	      ;; Run the user's hook.  Do we really want to do this for pop?
	      (run-hooks 'local-find-tag-hook))))
      (if next-p
	  ;; Find the same table we last used.
	  (visit-tags-table-buffer 'same)
	;; Pick a table to use.
	(visit-tags-table-buffer)
	;; Record TAGNAME for a future call with NEXT-P non-nil.
	(setq last-tag tagname))
      (prog1
	  ;; Record the location so we can pop back to it later.
	  (marker-buffer
	   (car
	    (setq tags-location-stack
		  (cons (let ((marker (make-marker)))
			  (save-excursion
			    (set-buffer
			     ;; find-tag-in-order does the real work.
			     (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)))
			    (set-marker marker (point))))
			tags-location-stack))))
	(run-hooks 'local-find-tag-hook)))))
Jim Blandy's avatar
Jim Blandy committed
683

Jim Blandy's avatar
Jim Blandy committed
684
;;;###autoload
685
(defun find-tag (tagname &optional next-p regexp-p)
Roland McGrath's avatar
Roland McGrath committed
686 687 688
  "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
689

690 691 692 693 694
If second arg NEXT-P is t (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.  If NEXT-P
is the atom `-' (interactively, with prefix arg that is a negative number
or just \\[negative-argument]), pop back to the previous tag gone to.
Jim Blandy's avatar
Jim Blandy committed
695

Roland McGrath's avatar
Roland McGrath committed
696
See documentation of variable `tags-file-name'."
697 698
  (interactive (find-tag-interactive "Find tag: "))
  (switch-to-buffer (find-tag-noselect tagname next-p regexp-p)))
Roland McGrath's avatar
Roland McGrath committed
699
;;;###autoload (define-key esc-map "." 'find-tag)
Jim Blandy's avatar
Jim Blandy committed
700

Jim Blandy's avatar
Jim Blandy committed
701
;;;###autoload
702
(defun find-tag-other-window (tagname &optional next-p regexp-p)
Roland McGrath's avatar
Roland McGrath committed
703
  "Find tag (in current tags table) whose name contains TAGNAME.
704 705 706
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.
Roland McGrath's avatar
Roland McGrath committed
707

708 709 710 711 712
If second arg NEXT-P is t (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.  If NEXT-P
is negative (interactively, with prefix arg that is a negative number or
just \\[negative-argument]), pop back to the previous tag gone to.
Roland McGrath's avatar
Roland McGrath committed
713 714

See documentation of variable `tags-file-name'."
715 716
  (interactive (find-tag-interactive "Find tag other window: "))

717 718 719 720 721
  ;; This hair is to deal with the case where the tag is found in the
  ;; selected window's buffer; without the hair, point is moved in both
  ;; windows.  To prevent this, we save the selected window's point before
  ;; doing find-tag-noselect, and restore it after.
  (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 725
    (set-window-point (prog1
			  (selected-window)
726 727 728 729 730 731 732
			(switch-to-buffer-other-window tagbuf)
			;; We have to set this new window's point; it
			;; might already have been displaying a
			;; different portion of tagbuf, in which case
			;; switch-to-buffer-other-window doesn't set
			;; the window's point from the buffer.
			(set-window-point (selected-window) tagpoint))
733
		      window-point)))
Roland McGrath's avatar
Roland McGrath committed
734 735
;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)

Roland McGrath's avatar
Roland McGrath committed
736
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
737
(defun find-tag-other-frame (tagname &optional next-p)
738 739 740 741 742 743 744 745 746 747
  "Find tag (in current tags table) whose name contains TAGNAME.
Select the buffer containing the tag's definition in another frame, and
move point there.  The default for TAGNAME is the expression in the buffer
around or before point.

If second arg NEXT-P is t (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.  If NEXT-P
is negative (interactively, with prefix arg that is a negative number or
just \\[negative-argument]), pop back to the previous tag gone to.
Jim Blandy's avatar
Jim Blandy committed
748

Roland McGrath's avatar
Roland McGrath committed
749
See documentation of variable `tags-file-name'."
750
  (interactive (find-tag-interactive "Find tag other frame: "))
Roland McGrath's avatar
Roland McGrath committed
751 752 753 754
  (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
755
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
756 757 758
(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
759

760 761 762 763 764
If second arg NEXT-P is t (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.  If NEXT-P
is negative (interactively, with prefix arg that is a negative number or
just \\[negative-argument]), pop back to the previous tag gone to.
Roland McGrath's avatar
Roland McGrath committed
765 766 767 768

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

See documentation of variable `tags-file-name'."
769 770 771 772
  (interactive (find-tag-interactive "Find tag regexp: " t))
  ;; We go through find-tag-other-window to do all the display hair there.
  (funcall (if other-window 'find-tag-other-window 'find-tag)
	   regexp next-p t))
Roland McGrath's avatar
Roland McGrath committed
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792

;; 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.

793 794 795 796 797 798
(defun find-tag-in-order (pattern
			  search-forward-func
			  order
			  next-line-after-failure-p
			  matching
			  first-search)
Roland McGrath's avatar
Roland McGrath committed
799 800 801 802 803 804 805 806
  (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
Roland McGrath's avatar
Roland McGrath committed
807 808 809
      (or first-search			;find-tag-noselect has already done it.
	  (visit-tags-table-buffer 'same))

Roland McGrath's avatar
Roland McGrath committed
810 811
      ;; Get a qualified match.
      (catch 'qualified-match-found
Roland McGrath's avatar
Roland McGrath committed
812

813
	;; Iterate over the list of tags tables.
Roland McGrath's avatar
Roland McGrath committed
814 815 816 817 818 819
	(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
820 821 822 823
	  (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
824 825

	  (setq tags-table-file buffer-file-name)
826
	  ;; Iterate over the list of ordering predicates.
Roland McGrath's avatar
Roland McGrath committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
	  (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))

854
      ;; Get the local value in the tags table buffer before switching buffers.
Roland McGrath's avatar
Roland McGrath committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
      (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.

874 875
;; If the current buffer is a valid etags TAGS file, give it local values of
;; the tags table format variables, and return non-nil.
Roland McGrath's avatar
Roland McGrath committed
876
(defun etags-recognize-tags-table ()
877
  (and (etags-verify-tags-table)
Jim Blandy's avatar
Jim Blandy committed
878 879 880
       ;; It is annoying to flash messages on the screen briefly,
       ;; and this message is not useful.  -- rms
       ;; (message "%s is an `etags' TAGS file" buffer-file-name)
Roland McGrath's avatar
Roland McGrath committed
881
       (mapcar (function (lambda (elt)
882
			   (set (make-local-variable (car elt)) (cdr elt))))
Roland McGrath's avatar
Roland McGrath committed
883 884 885 886 887 888 889
	       '((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))
890
		 (find-tag-regexp-next-line-after-failure-p . t)
Roland McGrath's avatar
Roland McGrath committed
891 892 893 894 895 896 897 898 899 900
		 (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)
		 ))))

901
;; Return non-nil iff the current buffer is a valid etags TAGS file.
Roland McGrath's avatar
Roland McGrath committed
902
(defun etags-verify-tags-table ()
903 904
  ;; Use eq instead of = in case char-after returns nil.
  (eq (char-after 1) ?\f))
Roland McGrath's avatar
Roland McGrath committed
905 906 907 908 909 910 911 912 913 914 915 916

(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))
917 918 919 920
      ;; This monster regexp matches an etags tag line.
      ;;   \1 is the string to match;
      ;;   \2 is not interesting;
      ;;   \3 is the guessed tag name; XXX guess should be better eg DEFUN
921 922 923 924
      ;;   \4 is not interesting;
      ;;   \5 is the explicitly-specified tag name.
      ;;   \6 is the line to start searching at;
      ;;   \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 933 934
		  ;; No explicit tag name.  Best guess.
		  (buffer-substring (match-beginning 3) (match-end 3)))
		table)))
Roland McGrath's avatar
Roland McGrath committed
935 936 937 938 939 940 941 942
    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))))
943 944
    ;; Skip explicit tag name if present.
    (search-forward "\001" (save-excursion (forward-line 1) (point)) t)
Roland McGrath's avatar
Roland McGrath committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
    (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)
962 963 964
	(pat (concat (if (eq selective-display t)
			 "\\(^\\|\^m\\)" "^")
		     (regexp-quote (car tag-info)))))
Roland McGrath's avatar
Roland McGrath committed
965 966 967 968 969 970 971 972 973 974 975 976 977
    (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)))
978 979 980 981 982
  ;; Position point at the right place
  ;; if the search string matched an extra Ctrl-m at the beginning.
  (and (eq selective-display t)
       (looking-at "\^m")
       (forward-char 1))
Roland McGrath's avatar
Roland McGrath committed
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
  (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.

1035 1036
;; Recognize an empty file and give it local values of the tags table format
;; variables which do nothing.
Roland McGrath's avatar
Roland McGrath committed
1037 1038 1039
(defun recognize-empty-tags-table ()
  (and (zerop (buffer-size))
       (mapcar (function (lambda (sym)
1040
			   (set (make-local-variable sym) 'ignore)))
Roland McGrath's avatar
Roland McGrath committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
	       '(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.
1052
;;; XXX these functions assume etags file format.
Roland McGrath's avatar
Roland McGrath committed
1053

Roland McGrath's avatar
Roland McGrath committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
;; 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
1069

Roland McGrath's avatar
Roland McGrath committed
1070 1071
;; 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
1072 1073 1074 1075 1076
(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
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087

;; 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
1088

Roland McGrath's avatar
Roland McGrath committed
1089 1090 1091 1092 1093 1094 1095 1096
;; 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
1097
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1098 1099
(defun next-file (&optional initialize novisit)
  "Select next file among files in current tags table.
1100 1101 1102 1103

A first argument of t (prefix arg, if interactive) initializes to the
beginning of the list of files in the tags table.  If the argument is
neither nil nor t, it is evalled to initialize the list of files.
Roland McGrath's avatar
Roland McGrath committed
1104 1105 1106 1107 1108 1109

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
1110
  (interactive "P")
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
  (cond ((not initialize)
	 ;; Not the first run.
	 )
	((eq initialize t)
	 ;; Initialize the list from the tags table.
	 (save-excursion
	   ;; Visit the tags table buffer to get its list of files.
	   (visit-tags-table-buffer)
	   (setq next-file-list (tags-table-files))))
	(t
	 ;; Initialize the list by evalling the argument.
	 (setq next-file-list (eval initialize))))
Jim Blandy's avatar
Jim Blandy committed
1123
  (or next-file-list
Roland McGrath's avatar
Roland McGrath committed
1124
      (save-excursion
1125
	;; Get the files from the next tags table.
Roland McGrath's avatar
Roland McGrath committed
1126
	;; When doing (visit-tags-table-buffer t),
Roland McGrath's avatar
Roland McGrath committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
	;; 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
1146

Roland McGrath's avatar
Roland McGrath committed
1147 1148 1149
(defvar tags-loop-operate nil
  "Form for `tags-loop-continue' to eval to change one file.")

1150 1151 1152
(defvar tags-loop-scan
  '(error (substitute-command-keys
	   "No \\[tags-search] or \\[tags-query-replace] in progress."))
Roland McGrath's avatar
Roland McGrath committed
1153 1154 1155
  "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
1156

Jim Blandy's avatar
Jim Blandy committed
1157
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
1158 1159
(defun tags-loop-continue (&optional first-time)
  "Continue last \\[tags-search] or \\[tags-query-replace] command.
1160 1161
Used noninteractively with non-nil argument to begin such a command (the
argument is passed to `next-file', which see).
Roland McGrath's avatar
Roland McGrath committed
1162 1163 1164 1165 1166
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
1167
  (interactive)
Roland McGrath's avatar
Roland McGrath committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
  (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
1205

Jim Blandy's avatar
Jim Blandy committed
1206
;;;###autoload
1207
(defun tags-search (regexp &optional file-list-form)
Roland McGrath's avatar
Roland McGrath committed
1208
  "Search through all files listed in tags table for match for REGEXP.
Jim Blandy's avatar
Jim Blandy committed
1209 1210 1211
Stops when a match is found.
To continue searching for next match, use command \\[tags-loop-continue].

Roland McGrath's avatar
Roland McGrath committed
1212
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
1213 1214
  (interactive "sTags search (regexp): ")
  (if (and (equal regexp "")
Roland McGrath's avatar
Roland McGrath committed
1215
	   (eq (car tags-loop-scan) 're-search-forward)
1216
	   (null tags-loop-operate))
Roland McGrath's avatar
Roland McGrath committed
1217
      ;; Continue last tags-search as if by M-,.
Jim Blandy's avatar
Jim Blandy committed
1218
      (tags-loop-continue nil)
Roland McGrath's avatar
Roland McGrath committed
1219 1220 1221
    (setq tags-loop-scan
	  (list 're-search-forward regexp nil t)
	  tags-loop-operate nil)
1222
    (tags-loop-continue (or file-list-form t))))
Jim Blandy's avatar
Jim Blandy committed
1223

Jim Blandy's avatar
Jim Blandy committed
1224
;;;###autoload
1225
(defun tags-query-replace (from to &optional delimited file-list-form)
Roland McGrath's avatar
Roland McGrath committed
1226
  "Query-replace-regexp FROM with TO through all files listed in tags table.
Jim Blandy's avatar
Jim Blandy committed
1227
Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
Roland McGrath's avatar
Roland McGrath committed
1228
If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace
Jim Blandy's avatar
Jim Blandy committed
1229 1230
with the command \\[tags-loop-continue].

Roland McGrath's avatar
Roland McGrath committed
1231 1232 1233
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
1234
  (setq tags-loop-scan (list 'prog1
Roland McGrath's avatar
Roland McGrath committed
1235
			     (list 'if (list 're-search-forward from nil t)
Roland McGrath's avatar
Roland McGrath committed
1236 1237 1238 1239
				   ;; 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
1240
	tags-loop-operate (list 'perform-replace from to t t delimited))
1241
  (tags-loop-continue (or file-list-form t)))
Roland McGrath's avatar
Roland McGrath committed
1242

Jim Blandy's avatar
Jim Blandy committed
1243
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1244
(defun list-tags (file)
Jim Blandy's avatar
Jim Blandy committed
1245
  "Display list of tags in file FILE.
Roland McGrath's avatar
Roland McGrath committed
1246 1247 1248 1249
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
1250 1251
  (with-output-to-temp-buffer "*Tags List*"
    (princ "Tags in file ")