etags.el 47.6 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 80 81 82
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
83

Roland McGrath's avatar
Roland McGrath committed
84 85 86
(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
87

Roland McGrath's avatar
Roland McGrath committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
(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
104
				  recognize-empty-tags-table)
Roland McGrath's avatar
Roland McGrath committed
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
  "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.")

143 144 145 146
;; 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
147
(defun initialize-new-tags-table ()
148 149 150 151
  (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
152 153 154 155 156 157
  ;; 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
158

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

;; Move tags-table-list-pointer along and set tags-file-name.
194
;; If NO-INCLUDES is non-nil, ignore included tags tables.
Roland McGrath's avatar
Roland McGrath committed
195
;; Returns nil when out of tables.
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 229 230 231 232 233 234 235 236 237 238 239 240
(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
241 242 243 244 245 246
(defun tags-expand-table-name (file)
  (setq file (expand-file-name file))
  (if (file-directory-p file)
      (expand-file-name "TAGS" file)
    file))

247 248
;; 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
249 250 251 252 253 254 255 256 257 258
(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)

;; Subroutine of visit-tags-table-buffer.  Frobs its local vars.
259 260 261
;; 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.
Roland McGrath's avatar
Roland McGrath committed
262 263
(defun tags-table-including (this-file tables &optional recursing)
  (let ((found nil))
264
    ;; Loop over TABLES, looking for one containing tags for THIS-FILE.
Roland McGrath's avatar
Roland McGrath committed
265 266 267 268
    (while (and (not found)
		tables)
      (let ((tags-file-name (tags-expand-table-name (car tables))))
	(if (or (get-file-buffer tags-file-name)
269
		(file-exists-p tags-file-name))	;XXX check all in core first.
Roland McGrath's avatar
Roland McGrath committed
270 271 272 273 274 275 276 277 278 279 280 281
	    (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)
282
		     ;; This table has included tables.  Check them.
Roland McGrath's avatar
Roland McGrath committed
283 284 285 286 287 288 289 290 291
		     (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
292
				   ;; Recurse on the list of included tables.
Roland McGrath's avatar
Roland McGrath committed
293 294 295 296
				   (tags-table-including this-file
							 tags-included-tables
							 t))
			     (if found
297 298 299 300 301 302 303 304 305 306 307 308 309 310
				 ;; 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
				       ;; CONT is a local variable of
				       ;; our caller, visit-tags-table-buffer.
				       ;; Set it so we won't frob lists later.
				       cont 'included)))
Roland McGrath's avatar
Roland McGrath committed
311
			 (or recursing
312 313 314 315 316 317 318 319 320
			     ;; 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
321 322 323 324 325 326
			     (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
327 328 329 330 331

(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;
332
 just select the buffer visiting `tags-file-name'.
Roland McGrath's avatar
Roland McGrath committed
333
If arg is nil or absent, choose a first buffer from information in
334
 `tags-file-name', `tags-table-list', `tags-table-list-pointer'.
Roland McGrath's avatar
Roland McGrath committed
335
Returns t if it visits a tags table, or nil if there are no more in the list."
336 337 338

  ;; Set tags-file-name to the tags table file we want to visit.
  (cond ((eq cont 'same)
339 340 341 342 343 344 345
	 ;; 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 CONT to nil so the code below will make sure tags-file-name
	 ;; is in tags-table-list.
346
	 (setq cont nil))
Roland McGrath's avatar
Roland McGrath committed
347 348

	(cont
349
	 ;; Find the next table.
Roland McGrath's avatar
Roland McGrath committed
350 351 352 353 354 355 356 357
	 (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
358
	 ;; Pick a table out of our hat.
Roland McGrath's avatar
Roland McGrath committed
359
	 (setq tags-file-name
360 361 362 363 364 365 366 367 368 369 370 371 372 373
	       (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 CONT will be set non-nil so we don't do it below.
		(car (save-excursion (tags-table-including buffer-file-name
							   tags-table-list)))
		;; Fourth, use the user variable tags-file-name, if it is not
		;; already in tags-table-list.
374 375
		(and tags-file-name
		     (not (tags-table-list-member tags-file-name))
376 377
		     tags-file-name)
		;; Fifth, use the user variable giving the table list.
378 379 380 381 382 383 384 385 386
		;; 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))
387 388 389 390 391 392 393 394
		;; 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.
Roland McGrath's avatar
Roland McGrath committed
395 396
  (setq tags-file-name (tags-expand-table-name tags-file-name))

Roland McGrath's avatar
Roland McGrath committed
397
  (if (and (eq cont t) (null tags-table-list-pointer))
Roland McGrath's avatar
Roland McGrath committed
398 399 400
      ;; All out of tables.
      nil

401
    ;; Verify that tags-file-name is a valid tags table.
Roland McGrath's avatar
Roland McGrath committed
402
    (if (if (get-file-buffer tags-file-name)
403 404
	    ;; The file is already in a buffer.  Check for the visited file
	    ;; having changed since we last used it.
Roland McGrath's avatar
Roland McGrath committed
405 406 407 408 409 410 411 412 413 414 415 416 417
	    (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.
418
	      ;; Propagate the change to tags-file-name and tags-table-list.
419
	      (let ((tail (member tags-file-name tags-table-list)))
Roland McGrath's avatar
Roland McGrath committed
420 421 422 423 424 425 426 427 428 429
		(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))
Roland McGrath's avatar
Roland McGrath committed
430
	
Roland McGrath's avatar
Roland McGrath committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
	  (if 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
446
			;; Found in some other set.  Switch to that set.
Roland McGrath's avatar
Roland McGrath committed
447
			(progn
Roland McGrath's avatar
Roland McGrath committed
448
			  (or (memq tags-table-list tags-table-set-list)
Roland McGrath's avatar
Roland McGrath committed
449
			      ;; Save the current list.
Roland McGrath's avatar
Roland McGrath committed
450 451 452
			      (setq tags-table-set-list
				    (cons tags-table-list
					  tags-table-set-list)))
Roland McGrath's avatar
Roland McGrath committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
			  (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.
			(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 (list tags-file-name)))
		      (setq elt tags-table-list))))

470 471
	      ;; Set the tags table list state variables to point at the table
	      ;; we want to use first.
Roland McGrath's avatar
Roland McGrath committed
472
	      (setq tags-table-list-started-at elt
Roland McGrath's avatar
Roland McGrath committed
473 474 475 476
		    tags-table-list-pointer elt)))

	  ;; Return of t says the tags table is valid.
	  t)
Roland McGrath's avatar
Roland McGrath committed
477 478

      ;; The buffer was not valid.  Don't use it again.
479 480 481 482
      (let ((file tags-file-name))
	(kill-local-variable 'tags-file-name)
	(if (eq file tags-file-name)
	    (setq tags-file-name nil)))
Roland McGrath's avatar
Roland McGrath committed
483
      (error "File %s is not a valid tags table" buffer-file-name))))
484

Jim Blandy's avatar
Jim Blandy committed
485 486
(defun file-of-tag ()
  "Return the file name of the file whose tags point is within.
Roland McGrath's avatar
Roland McGrath committed
487 488 489
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
490

Jim Blandy's avatar
Jim Blandy committed
491
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
492 493
(defun tags-table-files ()
  "Return a list of files in the current tags table.
494
Assumes the tags table is the current buffer.
Jim Blandy's avatar
Jim Blandy committed
495
File names returned are absolute."
496 497 498
  (or tags-table-files
      (setq tags-table-files
	    (funcall tags-table-files-function))))
Roland McGrath's avatar
Roland McGrath committed
499 500

(defun tags-included-tables ()
501 502
  "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
503 504 505 506 507 508 509 510 511 512 513 514 515 516
  (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
517 518
	       ;; 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
519
	       (while included
520
		 ;; Visit the buffer.
Roland McGrath's avatar
Roland McGrath committed
521
		 (let ((tags-file-name (car included)))
Roland McGrath's avatar
Roland McGrath committed
522
		   (visit-tags-table-buffer 'same))
523
		 ;; Recurse in that buffer to compute its completion table.
Roland McGrath's avatar
Roland McGrath committed
524
		 (if (tags-completion-table)
525
		     ;; Combine the tables.
Roland McGrath's avatar
Roland McGrath committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
		     (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))))
545

Jim Blandy's avatar
Jim Blandy committed
546 547 548 549 550
;; 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
551 552 553 554 555 556 557
    (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
558 559 560 561 562 563 564
	       (buffer-substring (point)
				 (progn (forward-sexp -1)
					(while (looking-at "\\s'")
					  (forward-char 1))
					(point))))
      nil)))

Roland McGrath's avatar
Roland McGrath committed
565
;; Read a tag name from the minibuffer with defaulting and completion.
Jim Blandy's avatar
Jim Blandy committed
566
(defun find-tag-tag (string)
Roland McGrath's avatar
Roland McGrath committed
567 568 569 570 571 572 573
  (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)))
574 575 576
    (if (equal spec "")
	(or default (error "There is no default tag"))
      spec)))
Jim Blandy's avatar
Jim Blandy committed
577

Roland McGrath's avatar
Roland McGrath committed
578 579 580
(defvar last-tag nil
  "Last tag found by \\[find-tag].")

Jim Blandy's avatar
Jim Blandy committed
581
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
582 583
(defun find-tag-noselect (tagname &optional next-p regexp-p)
  "Find tag (in current tags table) whose name contains TAGNAME.
584
Returns the buffer containing the tag's definition and moves its point there,
Roland McGrath's avatar
Roland McGrath committed
585 586 587 588 589 590
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
591

Roland McGrath's avatar
Roland McGrath committed
592 593 594
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
595 596
  (interactive (if current-prefix-arg
		   '(nil t)
597 598 599
		 (list (find-tag-tag "Find tag: "))))
  ;; Save the current buffer's value of `find-tag-hook' before selecting the
  ;; tags table buffer.
Roland McGrath's avatar
Roland McGrath committed
600
  (let ((local-find-tag-hook find-tag-hook))
Roland McGrath's avatar
Roland McGrath committed
601
    (if next-p
602
	;; Find the same table we last used.
Roland McGrath's avatar
Roland McGrath committed
603
	(visit-tags-table-buffer 'same)
604 605 606 607
      ;; Pick a table to use.
      (visit-tags-table-buffer)
      ;; Record TAGNAME for a future call with NEXT-P non-nil.
      (setq last-tag tagname))
Roland McGrath's avatar
Roland McGrath committed
608
    (prog1
609
	;; find-tag-in-order does the real work.
Roland McGrath's avatar
Roland McGrath committed
610 611 612 613 614 615 616 617 618 619 620 621 622
	(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
623

Jim Blandy's avatar
Jim Blandy committed
624
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
625 626 627 628
(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
629

Roland McGrath's avatar
Roland McGrath committed
630 631 632
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
633

Roland McGrath's avatar
Roland McGrath committed
634
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
635 636
  (interactive (if current-prefix-arg
		   '(nil t)
637
		 (list (find-tag-tag "Find tag: "))))
Roland McGrath's avatar
Roland McGrath committed
638 639
  (switch-to-buffer (find-tag-noselect tagname next-p)))
;;;###autoload (define-key esc-map "." 'find-tag)
Jim Blandy's avatar
Jim Blandy committed
640

Jim Blandy's avatar
Jim Blandy committed
641
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
642 643 644 645 646 647 648 649 650 651 652 653 654
(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)
655 656 657 658 659 660
		 (list (find-tag-tag "Find tag other window: "))))
  ;; 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)))
661 662
	 (tagbuf (find-tag-noselect tagname next-p))
	 (tagpoint (progn (set-buffer tagbuf) (point))))
663 664
    (set-window-point (prog1
			  (selected-window)
665 666 667 668 669 670 671
			(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))
672
		      window-point)))
Roland McGrath's avatar
Roland McGrath committed
673 674
;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)

Roland McGrath's avatar
Roland McGrath committed
675
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
676
(defun find-tag-other-frame (tagname &optional next-p)
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680 681
  "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
682
 If second arg NEXT-P is non-nil (interactively, with prefix arg),
Jim Blandy's avatar
Jim Blandy committed
683 684 685
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
686
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
687 688
  (interactive (if current-prefix-arg
		   '(nil t)
689
		 (list (find-tag-tag "Find tag other window: "))))
Roland McGrath's avatar
Roland McGrath committed
690 691 692 693
  (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
694
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
695 696 697
(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
698

Roland McGrath's avatar
Roland McGrath committed
699 700 701 702 703 704 705 706
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)
707
		 (list (read-string "Find tag regexp: "))))
Roland McGrath's avatar
Roland McGrath committed
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
  (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.

730 731 732 733 734 735
(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
736 737 738 739 740 741 742 743
  (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
744 745 746
      (or first-search			;find-tag-noselect has already done it.
	  (visit-tags-table-buffer 'same))

Roland McGrath's avatar
Roland McGrath committed
747 748
      ;; Get a qualified match.
      (catch 'qualified-match-found
Roland McGrath's avatar
Roland McGrath committed
749

750
	;; Iterate over the list of tags tables.
Roland McGrath's avatar
Roland McGrath committed
751 752 753 754 755 756
	(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
757 758 759 760
	  (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
761 762

	  (setq tags-table-file buffer-file-name)
763
	  ;; Iterate over the list of ordering predicates.
Roland McGrath's avatar
Roland McGrath committed
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
	  (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))

791
      ;; Get the local value in the tags table buffer before switching buffers.
Roland McGrath's avatar
Roland McGrath committed
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
      (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.

811 812
;; 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
813
(defun etags-recognize-tags-table ()
814
  (and (etags-verify-tags-table)
Jim Blandy's avatar
Jim Blandy committed
815 816 817
       ;; 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
818
       (mapcar (function (lambda (elt)
819
			   (set (make-local-variable (car elt)) (cdr elt))))
Roland McGrath's avatar
Roland McGrath committed
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
	       '((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)
		 ))))

838
;; Return non-nil iff the current buffer is a valid etags TAGS file.
Roland McGrath's avatar
Roland McGrath committed
839
(defun etags-verify-tags-table ()
840 841
  ;; Use eq instead of = in case char-after returns nil.
  (eq (char-after 1) ?\f))
Roland McGrath's avatar
Roland McGrath committed
842 843 844 845 846 847 848 849 850 851 852 853

(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))
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
      ;; 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
      ;;   \4 is the char to start searching at;
      ;;   \5 is the line to start searching at;
      ;;   \6 is not interesting;
      ;;   \7 is the explicitly-specified tag name.
      (while (re-search-forward
	      "^\\(\\(.+[ \t]+\\)?\\([-a-zA-Z0-9_$]+\\)[^-a-zA-Z0-9_$]*\\)\177\
\\([0-9]+\\),\\([0-9]+\\)\\(,\001\\([^\n]+\\)\\)?\n"
	      nil t)
	(intern	(if (match-beginning 6)
		    ;; There is an explicit tag name.
		    (buffer-substring (match-beginning 6) (match-end 6))
		  ;; No explicit tag name.  Best guess.
		  (buffer-substring (match-beginning 3) (match-end 3)))
		table)))
Roland McGrath's avatar
Roland McGrath committed
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 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 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
    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.

963 964
;; 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
965 966 967
(defun recognize-empty-tags-table ()
  (and (zerop (buffer-size))
       (mapcar (function (lambda (sym)
968
			   (set (make-local-variable sym) 'ignore)))
Roland McGrath's avatar
Roland McGrath committed
969 970 971 972 973 974 975 976 977 978 979
	       '(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.
980
;;; XXX these functions assume etags file format.
Roland McGrath's avatar
Roland McGrath committed
981

Roland McGrath's avatar
Roland McGrath committed
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
;; 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
997

Roland McGrath's avatar
Roland McGrath committed
998 999
;; 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
1000 1001 1002 1003 1004
(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
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

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

Roland McGrath's avatar
Roland McGrath committed
1017 1018 1019 1020 1021 1022 1023 1024
;; 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
1025
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
(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
1036
  (interactive "P")
Roland McGrath's avatar
Roland McGrath committed
1037 1038
  (and initialize
       (save-excursion
1039
	 ;; Visit the tags table buffer to get its list of files.
Roland McGrath's avatar
Roland McGrath committed
1040
	 (visit-tags-table-buffer)
Roland McGrath's avatar
Roland McGrath committed
1041
	 (setq next-file-list (tags-table-files))))
Jim Blandy's avatar
Jim Blandy committed
1042
  (or next-file-list
Roland McGrath's avatar
Roland McGrath committed
1043
      (save-excursion
1044
	;; Get the files from the next tags table.
Roland McGrath's avatar
Roland McGrath committed
1045
	;; When doing (visit-tags-table-buffer t),
Roland McGrath's avatar
Roland McGrath committed
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
	;; 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
1065

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

1069 1070 1071
(defvar tags-loop-scan
  '(error (substitute-command-keys
	   "No \\[tags-search] or \\[tags-query-replace] in progress."))
Roland McGrath's avatar
Roland McGrath committed
1072 1073 1074
  "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
1075

Jim Blandy's avatar
Jim Blandy committed
1076
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
1077 1078
(defun tags-loop-continue (&optional first-time)
  "Continue last \\[tags-search] or \\[tags-query-replace] command.
Roland McGrath's avatar
Roland McGrath committed
1079 1080 1081 1082 1083 1084
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
1085
  (interactive)
Roland McGrath's avatar
Roland McGrath committed
1086 1087 1088 1089 1090 1091 1092 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
  (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
1123

Jim Blandy's avatar
Jim Blandy committed
1124
;;;###autoload
Jim Blandy's avatar
Jim Blandy committed
1125
(defun tags-search (regexp)
Roland McGrath's avatar
Roland McGrath committed
1126
  "Search through all files listed in tags table for match for REGEXP.
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129
Stops when a match is found.
To continue searching for next match, use command \\[tags-loop-continue].

Roland McGrath's avatar
Roland McGrath committed
1130
See documentation of variable `tags-file-name'."
Jim Blandy's avatar
Jim Blandy committed
1131 1132
  (interactive "sTags search (regexp): ")
  (if (and (equal regexp "")
Roland McGrath's avatar
Roland McGrath committed
1133
	   (eq (car tags-loop-scan) 're-search-forward)
1134
	   (null tags-loop-operate))
Roland McGrath's avatar
Roland McGrath committed
1135
      ;; Continue last tags-search as if by M-,.
Jim Blandy's avatar
Jim Blandy committed
1136
      (tags-loop-continue nil)
Roland McGrath's avatar
Roland McGrath committed
1137 1138 1139
    (setq tags-loop-scan
	  (list 're-search-forward regexp nil t)
	  tags-loop-operate nil)
Jim Blandy's avatar
Jim Blandy committed
1140 1141
    (tags-loop-continue t)))

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

Roland McGrath's avatar
Roland McGrath committed
1149 1150 1151
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
1152
  (setq tags-loop-scan (list 'prog1
Roland McGrath's avatar
Roland McGrath committed
1153
			     (list 'if (list 're-search-forward from nil t)
Roland McGrath's avatar
Roland McGrath committed
1154 1155 1156 1157
				   ;; 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
1158
	tags-loop-operate (list 'perform-replace from to t t delimited))
Jim Blandy's avatar
Jim Blandy committed
1159
  (tags-loop-continue t))
Roland McGrath's avatar
Roland McGrath committed
1160

Jim Blandy's avatar
Jim Blandy committed
1161
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1162
(defun list-tags (file)
Jim Blandy's avatar
Jim Blandy committed
1163
  "Display list of tags in file FILE.
Roland McGrath's avatar
Roland McGrath committed
1164 1165 1166 1167
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
1168 1169
  (with-output-to-temp-buffer "*Tags List*"
    (princ "Tags in file ")
Roland McGrath's avatar
Roland McGrath committed
1170
    (princ file)
Jim Blandy's avatar
Jim Blandy committed
1171 1172
    (terpri)
    (save-excursion
Roland McGrath's avatar
Roland McGrath committed
1173 1174
      (let ((first-time t)
	    (gotany nil))
Roland McGrath's avatar
Roland McGrath committed
1175
	(while (visit-tags-table-buffer (not first-time))
Roland McGrath's avatar
Roland McGrath committed
1176 1177 1178 1179
	  (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
1180

Jim Blandy's avatar
Jim Blandy committed
1181
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1182 1183 1184
(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
1185 1186
  (with-output-to-temp-buffer "*Tags List*"
    (princ "Tags matching regexp ")
Roland McGrath's avatar
Roland McGrath committed
1187
    (prin1 regexp)
Jim Blandy's avatar
Jim Blandy committed
1188 1189
    (terpri)
    (save-excursion
Roland McGrath's avatar
Roland McGrath committed
1190 1191 1192
      (let ((first-time t))
	(while (visit-tags-table-buffer (not first-time))
	  (setq first-time nil)
Roland McGrath's avatar
Roland McGrath committed
1193
	  (funcall tags-apropos-function regexp))))))
Roland McGrath's avatar
Roland McGrath committed
1194 1195

;;; XXX Kludge interface.
Jim Blandy's avatar
Jim Blandy committed
1196

Roland McGrath's avatar
Roland McGrath committed
1197
;; XXX If a file is in multiple tables, selection may get the wrong one.
Roland McGrath's avatar
Roland McGrath committed
1198
;;;###autoload
Roland McGrath's avatar
Roland McGrath committed
1199 1200