1 ;;; etags.el --- etags facility for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1988-1989, 1992-1996, 1998, 2000-2013 Free
4 ;; Software Foundation, Inc.
6 ;; Author: Roland McGrath <roland@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 (defvar tags-file-name nil
34 "File name of tags table.
35 To switch to a new tags table, setting this variable is sufficient.
36 If you set this variable, do not also set `tags-table-list'.
37 Use the `etags' program to make a tags table file.")
38 ;; Make M-x set-variable tags-file-name like M-x visit-tags-table.
39 ;;;###autoload (put 'tags-file-name 'variable-interactive (purecopy "fVisit tags table: "))
40 ;;;###autoload (put 'tags-file-name 'safe-local-variable 'stringp)
42 (defgroup etags nil
"Tags tables."
46 (defcustom tags-case-fold-search
'default
47 "Whether tags operations should be case-sensitive.
48 A value of t means case-insensitive, a value of nil means case-sensitive.
49 Any other value means use the setting of `case-fold-search'."
51 :type
'(choice (const :tag
"Case-sensitive" nil
)
52 (const :tag
"Case-insensitive" t
)
53 (other :tag
"Use default" default
))
57 ;; Use `visit-tags-table-buffer' to cycle through tags tables in this list.
58 (defcustom tags-table-list nil
59 "List of file names of tags tables to search.
60 An element that is a directory means the file \"TAGS\" in that directory.
61 To switch to a new list of tags tables, setting this variable is sufficient.
62 If you set this variable, do not also set `tags-file-name'.
63 Use the `etags' program to make a tags table file."
68 (defcustom tags-compression-info-list
69 (purecopy '("" ".Z" ".bz2" ".gz" ".xz" ".tgz"))
70 "List of extensions tried by etags when jka-compr is used.
71 An empty string means search the non-compressed file.
72 These extensions will be tried only if jka-compr was activated
73 \(i.e. via customize of `auto-compression-mode' or by calling the function
74 `auto-compression-mode')."
75 :version
"24.1" ; added xz
76 :type
'(repeat string
)
79 ;; !!! tags-compression-info-list should probably be replaced by access
80 ;; to directory list and matching jka-compr-compression-info-list. Currently,
81 ;; this implementation forces each modification of
82 ;; jka-compr-compression-info-list to be reflected in this var.
83 ;; An alternative could be to say that introducing a special
84 ;; element in this list (e.g. t) means : try at this point
85 ;; using directory listing and regexp matching using
86 ;; jka-compr-compression-info-list.
90 (defcustom tags-add-tables
'ask-user
91 "Control whether to add a new tags table to the current list.
92 t means do; nil means don't (always start a new list).
93 Any other value means ask the user whether to add a new tags table
94 to the current list (as opposed to starting a new list)."
96 :type
'(choice (const :tag
"Do" t
)
97 (const :tag
"Don't" nil
)
98 (other :tag
"Ask" ask-user
)))
100 (defcustom tags-revert-without-query nil
101 "Non-nil means reread a TAGS table without querying, if it has changed."
105 (defvar tags-table-computed-list nil
106 "List of tags tables to search, computed from `tags-table-list'.
107 This includes tables implicitly included by other tables. The list is not
108 always complete: the included tables of a table are not known until that
109 table is read into core. An element that is t is a placeholder
110 indicating that the preceding element is a table that has not been read
111 into core and might contain included tables to search.
112 See `tags-table-check-computed-list'.")
114 (defvar tags-table-computed-list-for nil
115 "Value of `tags-table-list' that `tags-table-computed-list' corresponds to.
116 If `tags-table-list' changes, `tags-table-computed-list' is thrown away and
117 recomputed; see `tags-table-check-computed-list'.")
119 (defvar tags-table-list-pointer nil
120 "Pointer into `tags-table-computed-list' for the current state of searching.
121 Use `visit-tags-table-buffer' to cycle through tags tables in this list.")
123 (defvar tags-table-list-started-at nil
124 "Pointer into `tags-table-computed-list', where the current search started.")
126 (defvar tags-table-set-list nil
127 "List of sets of tags table which have been used together in the past.
128 Each element is a list of strings which are file names.")
131 (defcustom find-tag-hook nil
132 "Hook to be run by \\[find-tag] after finding a tag. See `run-hooks'.
133 The value in the buffer in which \\[find-tag] is done is used,
134 not the value in the buffer \\[find-tag] goes to."
139 (defcustom find-tag-default-function nil
140 "A function of no arguments used by \\[find-tag] to pick a default tag.
141 If nil, and the symbol that is the value of `major-mode'
142 has a `find-tag-default-function' property (see `put'), that is used.
143 Otherwise, `find-tag-default' is used."
145 :type
'(choice (const nil
) function
))
147 (defcustom find-tag-marker-ring-length
16
148 "Length of marker rings `find-tag-marker-ring' and `tags-location-ring'."
153 (defcustom tags-tag-face
'default
154 "Face for tags in the output of `tags-apropos'."
159 (defcustom tags-apropos-verbose nil
160 "If non-nil, print the name of the tags file in the *Tags List* buffer."
165 (defcustom tags-apropos-additional-actions nil
166 "Specify additional actions for `tags-apropos'.
168 If non-nil, value should be a list of triples (TITLE FUNCTION
169 TO-SEARCH). For each triple, `tags-apropos' processes TO-SEARCH and
170 lists tags from it. TO-SEARCH should be an alist, obarray, or symbol.
171 If it is a symbol, the symbol's value is used.
172 TITLE, a string, is a title used to label the additional list of tags.
173 FUNCTION is a function to call when a symbol is selected in the
174 *Tags List* buffer. It will be called with one argument SYMBOL which
175 is the symbol being selected.
179 '((\"Emacs Lisp\" Info-goto-emacs-command-node obarray)
180 (\"Common Lisp\" common-lisp-hyperspec common-lisp-hyperspec-obarray)
181 (\"SCWM\" scwm-documentation scwm-obarray))"
183 :type
'(repeat (list (string :tag
"Title")
185 (sexp :tag
"Tags to search")))
188 (defvar find-tag-marker-ring
(make-ring find-tag-marker-ring-length
)
189 "Ring of markers which are locations from which \\[find-tag] was invoked.")
191 (defvar default-tags-table-function nil
192 "If non-nil, a function to choose a default tags file for a buffer.
193 This function receives no arguments and should return the default
194 tags table file to use for the current buffer.")
196 (defvar tags-location-ring
(make-ring find-tag-marker-ring-length
)
197 "Ring of markers which are locations visited by \\[find-tag].
198 Pop back to the last location with \\[negative-argument] \\[find-tag].")
201 ;; These variables are local in tags table buffers.
203 (defvar tags-table-files nil
204 "List of file names covered by current tags table.
205 nil means it has not yet been computed; use `tags-table-files' to do so.")
207 (defvar tags-completion-table nil
208 "Obarray of tag names defined in current tags table.")
210 (defvar tags-included-tables nil
211 "List of tags tables included by the current tags table.")
213 (defvar next-file-list nil
214 "List of files for \\[next-file] to process.")
216 ;; Hooks for file formats.
218 (defvar tags-table-format-functions
'(etags-recognize-tags-table
219 tags-recognize-empty-tags-table
)
220 "Hook to be called in a tags table buffer to identify the type of tags table.
221 The functions are called in order, with no arguments,
222 until one returns non-nil. The function should make buffer-local bindings
223 of the format-parsing tags function variables if successful.")
225 (defvar file-of-tag-function nil
226 "Function to do the work of `file-of-tag' (which see).
227 One optional argument, a boolean specifying to return complete path (nil) or
228 relative path (non-nil).")
229 (defvar tags-table-files-function nil
230 "Function to do the work of `tags-table-files' (which see).")
231 (defvar tags-completion-table-function nil
232 "Function to build the `tags-completion-table'.")
233 (defvar snarf-tag-function nil
234 "Function to get info about a matched tag for `goto-tag-location-function'.
235 One optional argument, specifying to use explicit tag (non-nil) or not (nil).
236 The default is nil.")
237 (defvar goto-tag-location-function nil
238 "Function of to go to the location in the buffer specified by a tag.
239 One argument, the tag info returned by `snarf-tag-function'.")
240 (defvar find-tag-regexp-search-function nil
241 "Search function passed to `find-tag-in-order' for finding a regexp tag.")
242 (defvar find-tag-regexp-tag-order nil
243 "Tag order passed to `find-tag-in-order' for finding a regexp tag.")
244 (defvar find-tag-regexp-next-line-after-failure-p nil
245 "Flag passed to `find-tag-in-order' for finding a regexp tag.")
246 (defvar find-tag-search-function nil
247 "Search function passed to `find-tag-in-order' for finding a tag.")
248 (defvar find-tag-tag-order nil
249 "Tag order passed to `find-tag-in-order' for finding a tag.")
250 (defvar find-tag-next-line-after-failure-p nil
251 "Flag passed to `find-tag-in-order' for finding a tag.")
252 (defvar list-tags-function nil
253 "Function to do the work of `list-tags' (which see).")
254 (defvar tags-apropos-function nil
255 "Function to do the work of `tags-apropos' (which see).")
256 (defvar tags-included-tables-function nil
257 "Function to do the work of `tags-included-tables' (which see).")
258 (defvar verify-tags-table-function nil
259 "Function to return t if current buffer contains valid tags file.")
261 (defun initialize-new-tags-table ()
262 "Initialize the tags table in the current buffer.
263 Return non-nil if it is a valid tags table, and
264 in that case, also make the tags table state variables
265 buffer-local and set them to nil."
266 (set (make-local-variable 'tags-table-files
) nil
)
267 (set (make-local-variable 'tags-completion-table
) nil
)
268 (set (make-local-variable 'tags-included-tables
) nil
)
269 ;; We used to initialize find-tag-marker-ring and tags-location-ring
270 ;; here, to new empty rings. But that is wrong, because those
273 ;; Value is t if we have found a valid tags table buffer.
274 (run-hook-with-args-until-success 'tags-table-format-functions
))
277 (defun tags-table-mode ()
278 "Major mode for tags table file buffers."
280 (setq major-mode
'tags-table-mode
;FIXME: Use define-derived-mode.
281 mode-name
"Tags Table"
283 (initialize-new-tags-table))
286 (defun visit-tags-table (file &optional local
)
287 "Tell tags commands to use tags table file FILE.
288 FILE should be the name of a file created with the `etags' program.
289 A directory name is ok too; it means file TAGS in that directory.
291 Normally \\[visit-tags-table] sets the global value of `tags-file-name'.
292 With a prefix arg, set the buffer-local value instead.
293 When you find a tag with \\[find-tag], the buffer it finds the tag
294 in is given a local value of this variable which is the name of the tags
295 file the tag was in."
296 (interactive (list (read-file-name "Visit tags table (default TAGS): "
298 (expand-file-name "TAGS"
302 (or (stringp file
) (signal 'wrong-type-argument
(list 'stringp file
)))
303 ;; Bind tags-file-name so we can control below whether the local or
304 ;; global value gets set.
305 ;; Calling visit-tags-table-buffer with tags-file-name set to FILE will
306 ;; initialize a buffer for FILE and set tags-file-name to the
307 ;; fully-expanded name.
308 (let ((tags-file-name file
))
310 (or (visit-tags-table-buffer file
)
311 (signal 'file-error
(list "Visiting tags table"
312 "file does not exist"
314 ;; Set FILE to the expanded name.
315 (setq file tags-file-name
)))
317 ;; Set the local value of tags-file-name.
318 (set (make-local-variable 'tags-file-name
) file
)
319 ;; Set the global value of tags-file-name.
320 (setq-default tags-file-name file
)))
322 (defun tags-table-check-computed-list ()
323 "Compute `tags-table-computed-list' from `tags-table-list' if necessary."
324 (let ((expanded-list (mapcar 'tags-expand-table-name tags-table-list
)))
325 (or (equal tags-table-computed-list-for expanded-list
)
326 ;; The list (or default-directory) has changed since last computed.
327 (let* ((compute-for (mapcar 'copy-sequence expanded-list
))
328 (tables (copy-sequence compute-for
)) ;Mutated in the loop.
333 (setq computed
(cons (car tables
) computed
)
334 table-buffer
(get-file-buffer (car tables
)))
335 (if (and table-buffer
336 ;; There is a buffer visiting the file. Now make sure
337 ;; it is initialized as a tag table buffer.
339 (tags-verify-table (buffer-file-name table-buffer
))))
340 (with-current-buffer table-buffer
341 (if (tags-included-tables)
342 ;; Insert the included tables into the list we
344 (setcdr tables
(nconc (mapcar 'tags-expand-table-name
345 (tags-included-tables))
347 ;; This table is not in core yet. Insert a placeholder
348 ;; saying we must read it into core to check for included
349 ;; tables before searching the next table in the list.
350 (setq computed
(cons t computed
)))
351 (setq tables
(cdr tables
)))
353 ;; Record the tags-table-list value (and the context of the
354 ;; current directory) we computed from.
355 (setq tags-table-computed-list-for compute-for
356 tags-table-computed-list
(nreverse computed
))))))
358 (defun tags-table-extend-computed-list ()
359 "Extend `tags-table-computed-list' to remove the first t placeholder.
361 An element of the list that is t is a placeholder indicating that the
362 preceding element is a table that has not been read in and might
363 contain included tables to search. This function reads in the first
364 such table and puts its included tables into the list."
365 (let ((list tags-table-computed-list
))
366 (while (not (eq (nth 1 list
) t
))
367 (setq list
(cdr list
)))
369 (if (tags-verify-table (car list
))
370 ;; We are now in the buffer visiting (car LIST). Extract its
371 ;; list of included tables and insert it into the computed list.
372 (let ((tables (tags-included-tables))
376 (setq computed
(cons (car tables
) computed
)
377 table-buffer
(get-file-buffer (car tables
)))
379 (with-current-buffer table-buffer
380 (if (tags-included-tables)
381 ;; Insert the included tables into the list we
383 (setcdr tables
(append (tags-included-tables)
385 ;; This table is not in core yet. Insert a placeholder
386 ;; saying we must read it into core to check for included
387 ;; tables before searching the next table in the list.
388 (setq computed
(cons t computed
)))
389 (setq tables
(cdr tables
)))
390 (setq computed
(nreverse computed
))
391 ;; COMPUTED now contains the list of included tables (and
392 ;; tables included by them, etc.). Now splice this into the
394 (setcdr list
(nconc computed
(cdr (cdr list
)))))
395 ;; It was not a valid table, so just remove the following placeholder.
396 (setcdr list
(cdr (cdr list
)))))))
398 (defun tags-expand-table-name (file)
399 "Expand tags table name FILE into a complete file name."
400 (setq file
(expand-file-name file
))
401 (if (file-directory-p file
)
402 (expand-file-name "TAGS" file
)
405 ;; Like member, but comparison is done after tags-expand-table-name on both
406 ;; sides and elements of LIST that are t are skipped.
407 (defun tags-table-list-member (file list
)
408 "Like (member FILE LIST) after applying `tags-expand-table-name'.
409 More precisely, apply `tags-expand-table-name' to FILE
410 and each element of LIST, returning the link whose car is the first match.
411 If an element of LIST is t, ignore it."
412 (setq file
(tags-expand-table-name file
))
414 (or (eq (car list
) t
)
415 (not (string= file
(tags-expand-table-name (car list
))))))
416 (setq list
(cdr list
)))
419 (defun tags-verify-table (file)
420 "Read FILE into a buffer and verify that it is a valid tags table.
421 Sets the current buffer to one visiting FILE (if it exists).
422 Returns non-nil if it is a valid table."
423 (if (get-file-buffer file
)
424 ;; The file is already in a buffer. Check for the visited file
425 ;; having changed since we last used it.
427 (set-buffer (get-file-buffer file
))
428 (or verify-tags-table-function
(tags-table-mode))
429 (if (or (verify-visited-file-modtime (current-buffer))
430 ;; Decide whether to revert the file.
431 ;; revert-without-query can say to revert
432 ;; or the user can say to revert.
433 (not (or (let ((tail revert-without-query
)
436 (if (string-match (car tail
) buffer-file-name
)
438 (setq tail
(cdr tail
)))
440 tags-revert-without-query
442 (format "Tags file %s has changed, read new contents? "
444 (and verify-tags-table-function
445 (funcall verify-tags-table-function
))
448 (when (file-exists-p file
)
449 (let* ((buf (find-file-noselect file
))
450 (newfile (buffer-file-name buf
)))
451 (unless (string= file newfile
)
452 ;; find-file-noselect has changed the file name.
453 ;; Propagate the change to tags-file-name and tags-table-list.
454 (let ((tail (member file tags-table-list
)))
455 (if tail
(setcar tail newfile
)))
456 (if (eq file tags-file-name
) (setq tags-file-name newfile
)))
457 ;; Only change buffer now that we're done using potentially
458 ;; buffer-local variables.
460 (tags-table-mode)))))
462 ;; Subroutine of visit-tags-table-buffer. Search the current tags tables
463 ;; for one that has tags for THIS-FILE (or that includes a table that
464 ;; does). Return the name of the first table listing THIS-FILE; if
465 ;; the table is one included by another table, it is the master table that
466 ;; we return. If CORE-ONLY is non-nil, check only tags tables that are
467 ;; already in buffers--don't visit any new files.
468 (defun tags-table-including (this-file core-only
)
469 "Search current tags tables for tags for THIS-FILE.
470 Subroutine of `visit-tags-table-buffer'.
471 Looks for a tags table that has such tags or that includes a table
472 that has them. Returns the name of the first such table.
473 Non-nil CORE-ONLY means check only tags tables that are already in
474 buffers. If CORE-ONLY is nil, it is ignored."
475 (let ((tables tags-table-computed-list
)
477 ;; Loop over the list, looking for a table containing tags for THIS-FILE.
478 (while (and (not found
)
482 ;; Skip tables not in core.
483 (while (eq (nth 1 tables
) t
)
484 (setq tables
(cdr (cdr tables
))))
485 (if (eq (nth 1 tables
) t
)
486 ;; This table has not been read into core yet. Read it in now.
487 (tags-table-extend-computed-list)))
490 ;; Select the tags table buffer and get the file list up to date.
491 (let ((tags-file-name (car tables
)))
492 (visit-tags-table-buffer 'same
)
493 (if (member this-file
(mapcar 'expand-file-name
496 (setq found tables
))))
497 (setq tables
(cdr tables
)))
499 ;; Now determine if the table we found was one included by another
500 ;; table, not explicitly listed. We do this by checking each
501 ;; element of the computed list to see if it appears in the user's
502 ;; explicit list; the last element we will check is FOUND itself.
503 ;; Then we return the last one which did in fact appear in
506 (elt tags-table-computed-list
))
507 (while (not (eq elt
(cdr found
)))
508 (if (tags-table-list-member (car elt
) tags-table-list
)
509 ;; This table appears in the user's list, so it could be
510 ;; the one which includes the table we found.
511 (setq could-be
(car elt
)))
514 (setq elt
(cdr elt
))))
515 ;; The last element we found in the computed list before FOUND
516 ;; that appears in the user's list will be the table that
517 ;; included the one we found.
520 (defun tags-next-table ()
521 "Move `tags-table-list-pointer' along and set `tags-file-name'.
522 Subroutine of `visit-tags-table-buffer'.\
523 Returns nil when out of tables."
524 ;; If there is a placeholder element next, compute the list to replace it.
525 (while (eq (nth 1 tags-table-list-pointer
) t
)
526 (tags-table-extend-computed-list))
528 ;; Go to the next table in the list.
529 (setq tags-table-list-pointer
(cdr tags-table-list-pointer
))
530 (or tags-table-list-pointer
532 (setq tags-table-list-pointer tags-table-computed-list
))
534 (if (eq tags-table-list-pointer tags-table-list-started-at
)
535 ;; We have come full circle. No more tables.
536 (setq tags-table-list-pointer nil
)
537 ;; Set tags-file-name to the name from the list. It is already expanded.
538 (setq tags-file-name
(car tags-table-list-pointer
))))
541 (defun visit-tags-table-buffer (&optional cont
)
542 "Select the buffer containing the current tags table.
543 If optional arg is a string, visit that file as a tags table.
544 If optional arg is t, visit the next table in `tags-table-list'.
545 If optional arg is the atom `same', don't look for a new table;
546 just select the buffer visiting `tags-file-name'.
547 If arg is nil or absent, choose a first buffer from information in
548 `tags-file-name', `tags-table-list', `tags-table-list-pointer'.
549 Returns t if it visits a tags table, or nil if there are no more in the list."
551 ;; Set tags-file-name to the tags table file we want to visit.
552 (cond ((eq cont
'same
)
553 ;; Use the ambient value of tags-file-name.
556 (substitute-command-keys
557 (concat "No tags table in use; "
558 "use \\[visit-tags-table] to select one")))))
560 ;; Find the next table.
561 (if (tags-next-table)
562 ;; Skip over nonexistent files.
563 (while (and (not (or (get-file-buffer tags-file-name
)
564 (file-exists-p tags-file-name
)))
565 (tags-next-table)))))
567 ;; Pick a table out of our hat.
568 (tags-table-check-computed-list) ;Get it up to date, we might use it.
571 ;; If passed a string, use that.
575 ;; First, try a local variable.
576 (cdr (assq 'tags-file-name
(buffer-local-variables)))
577 ;; Second, try a user-specified function to guess.
578 (and default-tags-table-function
579 (funcall default-tags-table-function
))
580 ;; Third, look for a tags table that contains tags for the
581 ;; current buffer's file. If one is found, the lists will
582 ;; be frobnicated, and CONT will be set non-nil so we don't
584 (and buffer-file-name
586 ;; First check only tables already in buffers.
587 (tags-table-including buffer-file-name t
)
588 ;; Since that didn't find any, now do the
589 ;; expensive version: reading new files.
590 (tags-table-including buffer-file-name nil
)))
591 ;; Fourth, use the user variable tags-file-name, if it is
592 ;; not already in the current list.
594 (not (tags-table-list-member tags-file-name
595 tags-table-computed-list
))
597 ;; Fifth, use the user variable giving the table list.
598 ;; Find the first element of the list that actually exists.
599 (let ((list tags-table-list
)
602 (setq file
(tags-expand-table-name (car list
)))
603 (not (get-file-buffer file
))
604 (not (file-exists-p file
)))
605 (setq list
(cdr list
)))
607 ;; Finally, prompt the user for a file name.
609 (read-file-name "Visit tags table (default TAGS): "
614 ;; Expand the table name into a full file name.
615 (setq tags-file-name
(tags-expand-table-name tags-file-name
))
617 (unless (and (eq cont t
) (null tags-table-list-pointer
))
618 ;; Verify that tags-file-name names a valid tags table.
619 ;; Bind another variable with the value of tags-file-name
620 ;; before we switch buffers, in case tags-file-name is buffer-local.
621 (let ((curbuf (current-buffer))
622 (local-tags-file-name tags-file-name
))
623 (if (tags-verify-table local-tags-file-name
)
625 ;; We have a valid tags table.
627 ;; Bury the tags table buffer so it
628 ;; doesn't get in the user's way.
629 (bury-buffer (current-buffer))
631 ;; If this was a new table selection (CONT is nil), make
632 ;; sure tags-table-list includes the chosen table, and
633 ;; update the list pointer variables.
635 ;; Look in the list for the table we chose.
636 (let ((found (tags-table-list-member
638 tags-table-computed-list
)))
640 ;; There it is. Just switch to it.
641 (setq tags-table-list-pointer found
642 tags-table-list-started-at found
)
644 ;; The table is not in the current set.
645 ;; Try to find it in another previously used set.
646 (let ((sets tags-table-set-list
))
648 (not (tags-table-list-member
651 (setq sets
(cdr sets
)))
653 ;; Found in some other set. Switch to that set.
655 (or (memq tags-table-list tags-table-set-list
)
656 ;; Save the current list.
657 (setq tags-table-set-list
658 (cons tags-table-list
659 tags-table-set-list
)))
660 (setq tags-table-list
(car sets
)))
662 ;; Not found in any existing set.
663 (if (and tags-table-list
664 (or (eq t tags-add-tables
)
667 (concat "Keep current list of "
668 "tags tables also? ")))))
669 ;; Add it to the current list.
670 (setq tags-table-list
(cons local-tags-file-name
673 ;; Make a fresh list, and store the old one.
674 (message "Starting a new list of tags tables")
675 (or (null tags-table-list
)
676 (memq tags-table-list tags-table-set-list
)
677 (setq tags-table-set-list
678 (cons tags-table-list
679 tags-table-set-list
)))
680 ;; Clear out buffers holding old tables.
681 (dolist (table tags-table-list
)
682 ;; The list can contain items t.
684 (let ((buffer (find-buffer-visiting table
)))
686 (kill-buffer buffer
)))))
687 (setq tags-table-list
(list local-tags-file-name
))))
689 ;; Recompute tags-table-computed-list.
690 (tags-table-check-computed-list)
691 ;; Set the tags table list state variables to start
692 ;; over from tags-table-computed-list.
693 (setq tags-table-list-started-at tags-table-computed-list
694 tags-table-list-pointer
695 tags-table-computed-list
)))))
697 ;; Return of t says the tags table is valid.
700 ;; The buffer was not valid. Don't use it again.
702 (kill-local-variable 'tags-file-name
)
703 (if (eq local-tags-file-name tags-file-name
)
704 (setq tags-file-name nil
))
705 (user-error (if (file-exists-p local-tags-file-name
)
706 "File %s is not a valid tags table"
707 "File %s does not exist")
708 local-tags-file-name
)))))
710 (defun tags-reset-tags-tables ()
711 "Reset tags state to cancel effect of any previous \\[visit-tags-table] or \\[find-tag]."
713 ;; Clear out the markers we are throwing away.
715 (while (< i find-tag-marker-ring-length
)
716 (if (aref (cddr tags-location-ring
) i
)
717 (set-marker (aref (cddr tags-location-ring
) i
) nil
))
718 (if (aref (cddr find-tag-marker-ring
) i
)
719 (set-marker (aref (cddr find-tag-marker-ring
) i
) nil
))
721 (setq tags-file-name nil
722 tags-location-ring
(make-ring find-tag-marker-ring-length
)
723 find-tag-marker-ring
(make-ring find-tag-marker-ring-length
)
725 tags-table-computed-list nil
726 tags-table-computed-list-for nil
727 tags-table-list-pointer nil
728 tags-table-list-started-at nil
729 tags-table-set-list nil
))
731 (defun file-of-tag (&optional relative
)
732 "Return the file name of the file whose tags point is within.
733 Assumes the tags table is the current buffer.
734 If RELATIVE is non-nil, file name returned is relative to tags
735 table file's directory. If RELATIVE is nil, file name returned
737 (funcall file-of-tag-function relative
))
740 (defun tags-table-files ()
741 "Return a list of files in the current tags table.
742 Assumes the tags table is the current buffer. The file names are returned
743 as they appeared in the `etags' command that created the table, usually
744 without directory names."
746 (setq tags-table-files
747 (funcall tags-table-files-function
))))
749 (defun tags-included-tables ()
750 "Return a list of tags tables included by the current table.
751 Assumes the tags table is the current buffer."
752 (or tags-included-tables
753 (setq tags-included-tables
(funcall tags-included-tables-function
))))
755 (defun tags-completion-table ()
756 "Build `tags-completion-table' on demand.
757 The tags included in the completion table are those in the current
758 tags table and its (recursively) included tags tables."
759 (or tags-completion-table
760 ;; No cached value for this buffer.
762 (let (current-table combined-table
)
763 (message "Making tags completion table for %s..." buffer-file-name
)
765 ;; Iterate over the current list of tags tables.
766 (while (visit-tags-table-buffer (and combined-table t
))
767 ;; Find possible completions in this table.
768 (setq current-table
(funcall tags-completion-table-function
))
769 ;; Merge this buffer's completions into the combined table.
772 (lambda (sym) (intern (symbol-name sym
) combined-table
))
774 (setq combined-table current-table
))))
775 (message "Making tags completion table for %s...done"
777 ;; Cache the result in a buffer-local variable.
778 (setq tags-completion-table combined-table
))
779 (quit (message "Tags completion table construction aborted.")
780 (setq tags-completion-table nil
)))))
782 (defun tags-lazy-completion-table ()
783 (let ((buf (current-buffer)))
784 (lambda (string pred action
)
785 (with-current-buffer buf
787 ;; If we need to ask for the tag table, allow that.
788 (let ((enable-recursive-minibuffers t
))
789 (visit-tags-table-buffer))
790 (complete-with-action action
(tags-completion-table) string pred
))))))
792 ;;;###autoload (defun tags-completion-at-point-function ()
793 ;;;###autoload (if (or tags-table-list tags-file-name)
794 ;;;###autoload (progn
795 ;;;###autoload (load "etags")
796 ;;;###autoload (tags-completion-at-point-function))))
798 (defun tags-completion-at-point-function ()
799 "Using tags, return a completion table for the text around point.
800 If no tags table is loaded, do nothing and return nil."
801 (when (or tags-table-list tags-file-name
)
802 (let ((completion-ignore-case (if (memq tags-case-fold-search
'(t nil
))
803 tags-case-fold-search
805 (pattern (funcall (or find-tag-default-function
806 (get major-mode
'find-tag-default-function
)
811 (forward-char (1- (length pattern
)))
812 (search-backward pattern
)
814 (forward-char (length pattern
))
815 (list beg
(point) (tags-lazy-completion-table) :exclusive
'no
))))))
817 (defun find-tag-tag (string)
818 "Read a tag name, with defaulting and completion."
819 (let* ((completion-ignore-case (if (memq tags-case-fold-search
'(t nil
))
820 tags-case-fold-search
822 (default (funcall (or find-tag-default-function
823 (get major-mode
'find-tag-default-function
)
825 (spec (completing-read (if default
826 (format "%s (default %s): "
827 (substring string
0 (string-match "[ :]+\\'" string
))
830 (tags-lazy-completion-table)
831 nil nil nil nil default
)))
833 (or default
(user-error "There is no default tag"))
837 "Last tag found by \\[find-tag].")
839 (defun find-tag-interactive (prompt &optional no-default
)
840 "Get interactive arguments for tag functions.
841 The functions using this are `find-tag-noselect',
842 `find-tag-other-window', and `find-tag-regexp'."
843 (if (and current-prefix-arg last-tag
)
844 (list nil
(if (< (prefix-numeric-value current-prefix-arg
) 0)
849 (find-tag-tag prompt
)))))
851 (defvar find-tag-history nil
) ; Doc string?
854 (defvar etags-case-fold-search
)
855 (defvar etags-syntax-table
)
856 (defvar local-find-tag-hook
)
859 (defun find-tag-noselect (tagname &optional next-p regexp-p
)
860 "Find tag (in current tags table) whose name contains TAGNAME.
861 Returns the buffer containing the tag's definition and moves its point there,
862 but does not select the buffer.
863 The default for TAGNAME is the expression in the buffer near point.
865 If second arg NEXT-P is t (interactively, with prefix arg), search for
866 another tag that matches the last tagname or regexp used. When there are
867 multiple matches for a tag, more exact matches are found first. If NEXT-P
868 is the atom `-' (interactively, with prefix arg that is a negative number
869 or just \\[negative-argument]), pop back to the previous tag gone to.
871 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
873 A marker representing the point when this command is invoked is pushed
874 onto a ring and may be popped back to with \\[pop-tag-mark].
875 Contrast this with the ring of marks gone to by the command.
877 See documentation of variable `tags-file-name'."
878 (interactive (find-tag-interactive "Find tag: "))
880 (setq find-tag-history
(cons tagname find-tag-history
))
881 ;; Save the current buffer's value of `find-tag-hook' before
882 ;; selecting the tags table buffer. For the same reason, save value
883 ;; of `tags-file-name' in case it has a buffer-local value.
884 (let ((local-find-tag-hook find-tag-hook
))
886 ;; Pop back to a previous location.
887 (if (ring-empty-p tags-location-ring
)
888 (user-error "No previous tag locations")
889 (let ((marker (ring-remove tags-location-ring
0)))
891 ;; Move to the saved location.
892 (set-buffer (or (marker-buffer marker
)
893 (error "The marked buffer has been deleted")))
894 (goto-char (marker-position marker
))
895 ;; Kill that marker so it doesn't slow down editing.
896 (set-marker marker nil nil
)
897 ;; Run the user's hook. Do we really want to do this for pop?
898 (run-hooks 'local-find-tag-hook
))))
899 ;; Record whence we came.
900 (ring-insert find-tag-marker-ring
(point-marker))
901 (if (and next-p last-tag
)
902 ;; Find the same table we last used.
903 (visit-tags-table-buffer 'same
)
904 ;; Pick a table to use.
905 (visit-tags-table-buffer)
906 ;; Record TAGNAME for a future call with NEXT-P non-nil.
907 (setq last-tag tagname
))
908 ;; Record the location so we can pop back to it later.
909 (let ((marker (make-marker)))
911 ;; find-tag-in-order does the real work.
913 (if (and next-p last-tag
) last-tag tagname
)
915 find-tag-regexp-search-function
916 find-tag-search-function
)
918 find-tag-regexp-tag-order
921 find-tag-regexp-next-line-after-failure-p
922 find-tag-next-line-after-failure-p
)
923 (if regexp-p
"matching" "containing")
924 (or (not next-p
) (not last-tag
)))
925 (set-marker marker
(point))
926 (run-hooks 'local-find-tag-hook
)
927 (ring-insert tags-location-ring marker
)
928 (current-buffer))))))
931 (defun find-tag (tagname &optional next-p regexp-p
)
932 "Find tag (in current tags table) whose name contains TAGNAME.
933 Select the buffer containing the tag's definition, and move point there.
934 The default for TAGNAME is the expression in the buffer around or before point.
936 If second arg NEXT-P is t (interactively, with prefix arg), search for
937 another tag that matches the last tagname or regexp used. When there are
938 multiple matches for a tag, more exact matches are found first. If NEXT-P
939 is the atom `-' (interactively, with prefix arg that is a negative number
940 or just \\[negative-argument]), pop back to the previous tag gone to.
942 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
944 A marker representing the point when this command is invoked is pushed
945 onto a ring and may be popped back to with \\[pop-tag-mark].
946 Contrast this with the ring of marks gone to by the command.
948 See documentation of variable `tags-file-name'."
949 (interactive (find-tag-interactive "Find tag: "))
950 (let* ((buf (find-tag-noselect tagname next-p regexp-p
))
951 (pos (with-current-buffer buf
(point))))
953 (switch-to-buffer buf
)
954 (error (pop-to-buffer buf
)))
956 ;;;###autoload (define-key esc-map "." 'find-tag)
959 (defun find-tag-other-window (tagname &optional next-p regexp-p
)
960 "Find tag (in current tags table) whose name contains TAGNAME.
961 Select the buffer containing the tag's definition in another window, and
962 move point there. The default for TAGNAME is the expression in the buffer
963 around or before point.
965 If second arg NEXT-P is t (interactively, with prefix arg), search for
966 another tag that matches the last tagname or regexp used. When there are
967 multiple matches for a tag, more exact matches are found first. If NEXT-P
968 is negative (interactively, with prefix arg that is a negative number or
969 just \\[negative-argument]), pop back to the previous tag gone to.
971 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
973 A marker representing the point when this command is invoked is pushed
974 onto a ring and may be popped back to with \\[pop-tag-mark].
975 Contrast this with the ring of marks gone to by the command.
977 See documentation of variable `tags-file-name'."
978 (interactive (find-tag-interactive "Find tag other window: "))
980 ;; This hair is to deal with the case where the tag is found in the
981 ;; selected window's buffer; without the hair, point is moved in both
982 ;; windows. To prevent this, we save the selected window's point before
983 ;; doing find-tag-noselect, and restore it after.
984 (let* ((window-point (window-point (selected-window)))
985 (tagbuf (find-tag-noselect tagname next-p regexp-p
))
986 (tagpoint (progn (set-buffer tagbuf
) (point))))
987 (set-window-point (prog1
989 (switch-to-buffer-other-window tagbuf
)
990 ;; We have to set this new window's point; it
991 ;; might already have been displaying a
992 ;; different portion of tagbuf, in which case
993 ;; switch-to-buffer-other-window doesn't set
994 ;; the window's point from the buffer.
995 (set-window-point (selected-window) tagpoint
))
997 ;;;###autoload (define-key ctl-x-4-map "." 'find-tag-other-window)
1000 (defun find-tag-other-frame (tagname &optional next-p
)
1001 "Find tag (in current tags table) whose name contains TAGNAME.
1002 Select the buffer containing the tag's definition in another frame, and
1003 move point there. The default for TAGNAME is the expression in the buffer
1004 around or before point.
1006 If second arg NEXT-P is t (interactively, with prefix arg), search for
1007 another tag that matches the last tagname or regexp used. When there are
1008 multiple matches for a tag, more exact matches are found first. If NEXT-P
1009 is negative (interactively, with prefix arg that is a negative number or
1010 just \\[negative-argument]), pop back to the previous tag gone to.
1012 If third arg REGEXP-P is non-nil, treat TAGNAME as a regexp.
1014 A marker representing the point when this command is invoked is pushed
1015 onto a ring and may be popped back to with \\[pop-tag-mark].
1016 Contrast this with the ring of marks gone to by the command.
1018 See documentation of variable `tags-file-name'."
1019 (interactive (find-tag-interactive "Find tag other frame: "))
1020 (let ((pop-up-frames t
))
1021 (find-tag-other-window tagname next-p
)))
1022 ;;;###autoload (define-key ctl-x-5-map "." 'find-tag-other-frame)
1025 (defun find-tag-regexp (regexp &optional next-p other-window
)
1026 "Find tag (in current tags table) whose name matches REGEXP.
1027 Select the buffer containing the tag's definition and move point there.
1029 If second arg NEXT-P is t (interactively, with prefix arg), search for
1030 another tag that matches the last tagname or regexp used. When there are
1031 multiple matches for a tag, more exact matches are found first. If NEXT-P
1032 is negative (interactively, with prefix arg that is a negative number or
1033 just \\[negative-argument]), pop back to the previous tag gone to.
1035 If third arg OTHER-WINDOW is non-nil, select the buffer in another window.
1037 A marker representing the point when this command is invoked is pushed
1038 onto a ring and may be popped back to with \\[pop-tag-mark].
1039 Contrast this with the ring of marks gone to by the command.
1041 See documentation of variable `tags-file-name'."
1042 (interactive (find-tag-interactive "Find tag regexp: " t
))
1043 ;; We go through find-tag-other-window to do all the display hair there.
1044 (funcall (if other-window
'find-tag-other-window
'find-tag
)
1046 ;;;###autoload (define-key esc-map [?\C-.] 'find-tag-regexp)
1048 ;;;###autoload (define-key esc-map "*" 'pop-tag-mark)
1051 (defun pop-tag-mark ()
1052 "Pop back to where \\[find-tag] was last invoked.
1054 This is distinct from invoking \\[find-tag] with a negative argument
1055 since that pops a stack of markers at which tags were found, not from
1056 where they were found."
1058 (if (ring-empty-p find-tag-marker-ring
)
1059 (error "No previous locations for find-tag invocation"))
1060 (let ((marker (ring-remove find-tag-marker-ring
0)))
1061 (switch-to-buffer (or (marker-buffer marker
)
1062 (error "The marked buffer has been deleted")))
1063 (goto-char (marker-position marker
))
1064 (set-marker marker nil nil
)))
1066 (defvar tag-lines-already-matched nil
1067 "Matches remembered between calls.") ; Doc string: calls to what?
1069 (defun find-tag-in-order (pattern
1072 next-line-after-failure-p
1075 "Internal tag-finding function.
1076 PATTERN is a string to pass to arg SEARCH-FORWARD-FUNC, and to any
1077 member of the function list ORDER. If ORDER is nil, use saved state
1078 to continue a previous search.
1080 Arg NEXT-LINE-AFTER-FAILURE-P is non-nil if after a failed match,
1081 point should be moved to the next line.
1083 Arg MATCHING is a string, an English `-ing' word, to be used in an
1085 ;; Algorithm is as follows:
1086 ;; For each qualifier-func in ORDER, go to beginning of tags file, and
1087 ;; perform inner loop: for each naive match for PATTERN found using
1088 ;; SEARCH-FORWARD-FUNC, qualify the naive match using qualifier-func. If
1089 ;; it qualifies, go to the specified line in the specified source file
1090 ;; and return. Qualified matches are remembered to avoid repetition.
1091 ;; State is saved so that the loop can be continued.
1092 (let (file ;name of file containing tag
1093 tag-info
;where to find the tag in FILE
1096 (match-marker (make-marker))
1098 (case-fold-search (if (memq tags-case-fold-search
'(nil t
))
1099 tags-case-fold-search
1105 ;; This is the start of a search for a fresh tag.
1106 ;; Clear the list of tags matched by the previous search.
1107 ;; find-tag-noselect has already put us in the first tags table
1108 ;; buffer before we got called.
1109 (setq tag-lines-already-matched nil
)
1110 ;; Continuing to search for the tag specified last time.
1111 ;; tag-lines-already-matched lists locations matched in previous
1112 ;; calls so we don't visit the same tag twice if it matches twice
1113 ;; during two passes with different qualification predicates.
1114 ;; Switch to the current tags table buffer.
1115 (visit-tags-table-buffer 'same
))
1117 ;; Get a qualified match.
1118 (catch 'qualified-match-found
1120 ;; Iterate over the list of tags tables.
1121 (while (or first-table
1122 (visit-tags-table-buffer t
))
1124 (and first-search first-table
1125 ;; Start at beginning of tags file.
1126 (goto-char (point-min)))
1128 (setq first-table nil
)
1130 ;; Iterate over the list of ordering predicates.
1132 (while (funcall search-forward-func pattern nil t
)
1133 ;; Naive match found. Qualify the match.
1134 (and (funcall (car order
) pattern
)
1135 ;; Make sure it is not a previous qualified match.
1136 (not (member (set-marker match-marker
(point-at-bol))
1137 tag-lines-already-matched
))
1138 (throw 'qualified-match-found nil
))
1139 (if next-line-after-failure-p
1141 ;; Try the next flavor of match.
1142 (setq order
(cdr order
))
1143 (goto-char (point-min)))
1144 (setq order tag-order
))
1145 ;; We throw out on match, so only get here if there were no matches.
1146 ;; Clear out the markers we use to avoid duplicate matches so they
1147 ;; don't slow down editing and are immediately available for GC.
1148 (while tag-lines-already-matched
1149 (set-marker (car tag-lines-already-matched
) nil nil
)
1150 (setq tag-lines-already-matched
(cdr tag-lines-already-matched
)))
1151 (set-marker match-marker nil nil
)
1152 (user-error "No %stags %s %s" (if first-search
"" "more ")
1155 ;; Found a tag; extract location info.
1157 (setq tag-lines-already-matched
(cons match-marker
1158 tag-lines-already-matched
))
1159 ;; Expand the filename, using the tags table buffer's default-directory.
1160 ;; We should be able to search for file-name backwards in file-of-tag:
1161 ;; the beginning-of-line is ok except when positioned on a "file-name" tag.
1162 (setq file
(expand-file-name
1163 (if (memq (car order
) '(tag-exact-file-name-match-p
1164 tag-file-name-match-p
1165 tag-partial-file-name-match-p
))
1166 (save-excursion (forward-line 1)
1169 tag-info
(funcall snarf-tag-function
))
1171 ;; Get the local value in the tags table buffer before switching buffers.
1172 (setq goto-func goto-tag-location-function
)
1173 (tag-find-file-of-tag-noselect file
)
1176 (funcall goto-func tag-info
)
1178 ;; Return the buffer where the tag was found.
1181 (defun tag-find-file-of-tag-noselect (file)
1182 "Find the right line in the specified FILE."
1183 ;; If interested in compressed-files, search files with extensions.
1184 ;; Otherwise, search only the real file.
1185 (let* ((buffer-search-extensions (if (featurep 'jka-compr
)
1186 tags-compression-info-list
1189 (file-search-extensions buffer-search-extensions
))
1190 ;; search a buffer visiting the file with each possible extension
1191 ;; Note: there is a small inefficiency in find-buffer-visiting :
1192 ;; truename is computed even if not needed. Not too sure about this
1193 ;; but I suspect truename computation accesses the disk.
1194 ;; It is maybe a good idea to optimize this find-buffer-visiting.
1195 ;; An alternative would be to use only get-file-buffer
1196 ;; but this looks less "sure" to find the buffer for the file.
1197 (while (and (not the-buffer
) buffer-search-extensions
)
1198 (setq the-buffer
(find-buffer-visiting (concat file
(car buffer-search-extensions
))))
1199 (setq buffer-search-extensions
(cdr buffer-search-extensions
)))
1200 ;; if found a buffer but file modified, ensure we re-read !
1201 (if (and the-buffer
(not (verify-visited-file-modtime the-buffer
)))
1202 (find-file-noselect (buffer-file-name the-buffer
)))
1203 ;; if no buffer found, search for files with possible extensions on disk
1204 (while (and (not the-buffer
) file-search-extensions
)
1205 (if (not (file-exists-p (concat file
(car file-search-extensions
))))
1206 (setq file-search-extensions
(cdr file-search-extensions
))
1207 (setq the-buffer
(find-file-noselect (concat file
(car file-search-extensions
))))))
1208 (if (not the-buffer
)
1209 (if (featurep 'jka-compr
)
1210 (error "File %s (with or without extensions %s) not found" file tags-compression-info-list
)
1211 (error "File %s not found" file
))
1212 (set-buffer the-buffer
))))
1214 (defun tag-find-file-of-tag (file) ; Doc string?
1215 (let ((buf (tag-find-file-of-tag-noselect file
)))
1217 (switch-to-buffer buf
)
1218 (error (pop-to-buffer buf
)))))
1220 ;; `etags' TAGS file format support.
1222 (defun etags-recognize-tags-table ()
1223 "If `etags-verify-tags-table', make buffer-local format variables.
1224 If current buffer is a valid etags TAGS file, then give it
1225 buffer-local values of tags table format variables."
1226 (and (etags-verify-tags-table)
1227 ;; It is annoying to flash messages on the screen briefly,
1228 ;; and this message is not useful. -- rms
1229 ;; (message "%s is an `etags' TAGS file" buffer-file-name)
1230 (mapc (lambda (elt) (set (make-local-variable (car elt
)) (cdr elt
)))
1231 '((file-of-tag-function . etags-file-of-tag
)
1232 (tags-table-files-function . etags-tags-table-files
)
1233 (tags-completion-table-function . etags-tags-completion-table
)
1234 (snarf-tag-function . etags-snarf-tag
)
1235 (goto-tag-location-function . etags-goto-tag-location
)
1236 (find-tag-regexp-search-function . re-search-forward
)
1237 (find-tag-regexp-tag-order .
(tag-re-match-p))
1238 (find-tag-regexp-next-line-after-failure-p . t
)
1239 (find-tag-search-function . search-forward
)
1240 (find-tag-tag-order .
(tag-exact-file-name-match-p
1241 tag-file-name-match-p
1243 tag-implicit-name-match-p
1246 tag-partial-file-name-match-p
1248 (find-tag-next-line-after-failure-p . nil
)
1249 (list-tags-function . etags-list-tags
)
1250 (tags-apropos-function . etags-tags-apropos
)
1251 (tags-included-tables-function . etags-tags-included-tables
)
1252 (verify-tags-table-function . etags-verify-tags-table
)
1255 (defun etags-verify-tags-table ()
1256 "Return non-nil if the current buffer is a valid etags TAGS file."
1257 ;; Use eq instead of = in case char-after returns nil.
1258 (eq (char-after (point-min)) ?
\f))
1260 (defun etags-file-of-tag (&optional relative
) ; Doc string?
1262 (re-search-backward "\f\n\\([^\n]+\\),[0-9]*\n")
1263 (let ((str (convert-standard-filename
1264 (buffer-substring (match-beginning 1) (match-end 1)))))
1267 (expand-file-name str
(file-truename default-directory
))))))
1270 (defun etags-tags-completion-table () ; Doc string?
1271 (let ((table (make-vector 511 0))
1273 (make-progress-reporter
1274 (format "Making tags completion table for %s..." buffer-file-name
)
1275 (point-min) (point-max))))
1277 (goto-char (point-min))
1278 ;; This monster regexp matches an etags tag line.
1279 ;; \1 is the string to match;
1280 ;; \2 is not interesting;
1281 ;; \3 is the guessed tag name; XXX guess should be better eg DEFUN
1282 ;; \4 is not interesting;
1283 ;; \5 is the explicitly-specified tag name.
1284 ;; \6 is the line to start searching at;
1285 ;; \7 is the char to start searching at.
1286 (while (re-search-forward
1287 "^\\(\\([^\177]+[^-a-zA-Z0-9_+*$:\177]+\\)?\
1288 \\([-a-zA-Z0-9_+*$?:]+\\)[^-a-zA-Z0-9_+*$?:\177]*\\)\177\
1289 \\(\\([^\n\001]+\\)\001\\)?\\([0-9]+\\)?,\\([0-9]+\\)?\n"
1291 (intern (prog1 (if (match-beginning 5)
1292 ;; There is an explicit tag name.
1293 (buffer-substring (match-beginning 5) (match-end 5))
1294 ;; No explicit tag name. Best guess.
1295 (buffer-substring (match-beginning 3) (match-end 3)))
1296 (progress-reporter-update progress-reporter
(point)))
1300 (defun etags-snarf-tag (&optional use-explicit
) ; Doc string?
1301 (let (tag-text line startpos explicit-start
)
1304 (looking-at "\f\n"))
1305 ;; The match was for a source file name, not any tag within a file.
1306 ;; Give text of t, meaning to go exactly to the location we specify,
1307 ;; the beginning of the file.
1310 startpos
(point-min))
1312 ;; Find the end of the tag and record the whole tag text.
1313 (search-forward "\177")
1314 (setq tag-text
(buffer-substring (1- (point)) (point-at-bol)))
1315 ;; If use-explicit is non nil and explicit tag is present, use it as part of
1316 ;; return value. Else just skip it.
1317 (setq explicit-start
(point))
1318 (when (and (search-forward "\001" (point-at-bol 2) t
)
1320 (setq tag-text
(buffer-substring explicit-start
(1- (point)))))
1323 (if (looking-at "[0-9]")
1324 (setq line
(string-to-number (buffer-substring
1326 (progn (skip-chars-forward "0-9")
1328 (search-forward ",")
1329 (if (looking-at "[0-9]")
1330 (setq startpos
(string-to-number (buffer-substring
1332 (progn (skip-chars-forward "0-9")
1334 ;; Leave point on the next line of the tags file.
1336 (cons tag-text
(cons line startpos
))))
1338 (defun etags-goto-tag-location (tag-info)
1339 "Go to location of tag specified by TAG-INFO.
1340 TAG-INFO is a cons (TEXT LINE . POSITION).
1341 TEXT is the initial part of a line containing the tag.
1342 LINE is the line number.
1343 POSITION is the (one-based) char position of TEXT within the file.
1345 If TEXT is t, it means the tag refers to exactly LINE or POSITION,
1346 whichever is present, LINE having preference, no searching.
1347 Either LINE or POSITION can be nil. POSITION is used if present.
1349 If the tag isn't exactly at the given position, then look near that
1350 position using a search window that expands progressively until it
1351 hits the start of file."
1352 (let ((startpos (cdr (cdr tag-info
)))
1353 (line (car (cdr tag-info
)))
1355 (if (eq (car tag-info
) t
)
1357 (cond (line (progn (goto-char (point-min))
1358 (forward-line (1- line
))))
1359 (startpos (goto-char startpos
))
1360 (t (error "etags.el BUG: bogus direct file tag")))
1361 ;; This constant is 1/2 the initial search window.
1362 ;; There is no sense in making it too small,
1363 ;; since just going around the loop once probably
1364 ;; costs about as much as searching 2000 chars.
1367 pat
(concat (if (eq selective-display t
)
1368 "\\(^\\|\^m\\)" "^")
1369 (regexp-quote (car tag-info
))))
1370 ;; The character position in the tags table is 0-origin.
1371 ;; Convert it to a 1-origin Emacs character position.
1372 (if startpos
(setq startpos
(1+ startpos
)))
1373 ;; If no char pos was given, try the given line number.
1376 (setq startpos
(progn (goto-char (point-min))
1377 (forward-line (1- line
))
1380 (setq startpos
(point-min)))
1381 ;; First see if the tag is right at the specified location.
1382 (goto-char startpos
)
1383 (setq found
(looking-at pat
))
1384 (while (and (not found
)
1386 (goto-char (- startpos offset
))
1389 (re-search-forward pat
(+ startpos offset
) t
)
1390 offset
(* 3 offset
))) ; expand search window
1392 (re-search-forward pat nil t
)
1393 (user-error "Rerun etags: `%s' not found in %s"
1394 pat buffer-file-name
)))
1395 ;; Position point at the right place
1396 ;; if the search string matched an extra Ctrl-m at the beginning.
1397 (and (eq selective-display t
)
1400 (beginning-of-line)))
1402 (defun etags-list-tags (file) ; Doc string?
1403 (goto-char (point-min))
1404 (when (re-search-forward (concat "\f\n" "\\(" file
"\\)" ",") nil t
)
1405 (let ((path (save-excursion (forward-line 1) (file-of-tag)))
1406 ;; Get the local value in the tags table
1407 ;; buffer before switching buffers.
1408 (goto-func goto-tag-location-function
)
1411 (while (not (or (eobp) (looking-at "\f")))
1412 ;; We used to use explicit tags when available, but the current goto-func
1413 ;; can only handle implicit tags.
1414 (setq tag-info
(save-excursion (funcall snarf-tag-function nil
))
1416 pt
(with-current-buffer standard-output
(point)))
1418 (when (= (aref tag
0) ?\
() (princ " ...)"))
1419 (with-current-buffer standard-output
1420 (make-text-button pt
(point)
1423 'goto-func goto-func
1424 'action
(lambda (button)
1425 (let ((tag-info (button-get button
'tag-info
))
1426 (goto-func (button-get button
'goto-func
)))
1427 (tag-find-file-of-tag (button-get button
'file-path
))
1429 (funcall goto-func tag-info
)))
1437 (defmacro tags-with-face
(face &rest body
)
1438 "Execute BODY, give output to `standard-output' face FACE."
1439 (let ((pp (make-symbol "start")))
1440 `(let ((,pp
(with-current-buffer standard-output
(point))))
1442 (put-text-property ,pp
(with-current-buffer standard-output
(point))
1443 'face
,face standard-output
))))
1445 (defun etags-tags-apropos-additional (regexp)
1446 "Display tags matching REGEXP from `tags-apropos-additional-actions'."
1447 (with-current-buffer standard-output
1448 (dolist (oba tags-apropos-additional-actions
)
1450 (tags-with-face 'highlight
(princ (car oba
)))
1452 (let* ((beg (point))
1453 (symbs (car (cddr oba
)))
1454 (ins-symb (lambda (sy)
1455 (let ((sn (symbol-name sy
)))
1456 (when (string-match regexp sn
)
1457 (make-text-button (point)
1458 (progn (princ sy
) (point))
1459 'action-internal
(cadr oba
)
1460 'action
(lambda (button) (funcall
1461 (button-get button
'action-internal
)
1462 (button-get button
'item
)))
1468 (when (symbolp symbs
)
1470 (setq symbs
(symbol-value symbs
))
1471 (insert "symbol `" (symbol-name symbs
) "' has no value\n")
1474 (mapatoms ins-symb symbs
)
1476 (funcall ins-symb
(car sy
))))
1477 (sort-lines nil beg
(point))))))
1479 (defun etags-tags-apropos (string) ; Doc string?
1480 (when tags-apropos-verbose
1481 (princ "Tags in file `")
1482 (tags-with-face 'highlight
(princ buffer-file-name
))
1484 (goto-char (point-min))
1485 (let ((progress-reporter (make-progress-reporter
1486 (format "Making tags apropos buffer for `%s'..."
1488 (point-min) (point-max))))
1489 (while (re-search-forward string nil t
)
1490 (progress-reporter-update progress-reporter
(point))
1493 (let* ( ;; Get the local value in the tags table
1494 ;; buffer before switching buffers.
1495 (goto-func goto-tag-location-function
)
1496 (tag-info (save-excursion (funcall snarf-tag-function
)))
1497 (tag (if (eq t
(car tag-info
)) nil
(car tag-info
)))
1498 (file-path (save-excursion (if tag
(file-of-tag)
1499 (save-excursion (forward-line 1)
1501 (file-label (if tag
(file-of-tag t
)
1502 (save-excursion (forward-line 1)
1504 (pt (with-current-buffer standard-output
(point))))
1507 (princ (format "[%s]: " file-label
))
1509 (when (= (aref tag
0) ?\
() (princ " ...)"))
1510 (with-current-buffer standard-output
1511 (make-text-button pt
(point)
1513 'file-path file-path
1514 'goto-func goto-func
1515 'action
(lambda (button)
1516 (let ((tag-info (button-get button
'tag-info
))
1517 (goto-func (button-get button
'goto-func
)))
1518 (tag-find-file-of-tag (button-get button
'file-path
))
1520 (funcall goto-func tag-info
)))
1524 (princ (format "- %s" file-label
))
1525 (with-current-buffer standard-output
1526 (make-text-button pt
(point)
1527 'file-path file-path
1528 'action
(lambda (button)
1529 (tag-find-file-of-tag (button-get button
'file-path
))
1530 ;; Get the local value in the tags table
1531 ;; buffer before switching buffers.
1532 (goto-char (point-min)))
1539 (when tags-apropos-verbose
(princ "\n")))
1541 (defun etags-tags-table-files () ; Doc string?
1544 (goto-char (point-min))
1545 (while (search-forward "\f\n" nil t
)
1548 (skip-chars-backward "^," beg
)
1549 (or (looking-at "include$")
1550 (push (convert-standard-filename
1551 (buffer-substring beg
(1- (point))))
1555 (defun etags-tags-included-tables () ; Doc string?
1558 (goto-char (point-min))
1559 (while (search-forward "\f\n" nil t
)
1562 (skip-chars-backward "^," beg
)
1563 (when (looking-at "include$")
1564 ;; Expand in the default-directory of the tags table buffer.
1565 (push (expand-file-name (convert-standard-filename
1566 (buffer-substring beg
(1- (point)))))
1570 ;; Empty tags file support.
1572 (defun tags-recognize-empty-tags-table ()
1573 "Return non-nil if current buffer is empty.
1574 If empty, make buffer-local values of the tags table format variables
1576 (and (zerop (buffer-size))
1577 (mapc (lambda (sym) (set (make-local-variable sym
) 'ignore
))
1578 '(tags-table-files-function
1579 tags-completion-table-function
1580 find-tag-regexp-search-function
1581 find-tag-search-function
1582 tags-apropos-function
1583 tags-included-tables-function
))
1584 (set (make-local-variable 'verify-tags-table-function
)
1585 (lambda () (zerop (buffer-size))))))
1587 ;; Match qualifier functions for tagnames.
1588 ;; These functions assume the etags file format defined in etc/ETAGS.EBNF.
1590 ;; This might be a neat idea, but it's too hairy at the moment.
1591 ;;(defmacro tags-with-syntax (&rest body)
1592 ;; `(with-syntax-table
1593 ;; (with-current-buffer (find-file-noselect (file-of-tag))
1596 ;;(put 'tags-with-syntax 'edebug-form-spec '(&rest form))
1598 ;; exact file name match, i.e. searched tag must match complete file
1599 ;; name including directories parts if there are some.
1600 (defun tag-exact-file-name-match-p (tag)
1601 "Return non-nil if TAG matches complete file name.
1602 Any directory part of the file name is also matched."
1603 (and (looking-at ",[0-9\n]")
1604 (save-excursion (backward-char (+ 2 (length tag
)))
1605 (looking-at "\f\n"))))
1607 ;; file name match as above, but searched tag must match the file
1608 ;; name not including the directories if there are some.
1609 (defun tag-file-name-match-p (tag)
1610 "Return non-nil if TAG matches file name, excluding directory part."
1611 (and (looking-at ",[0-9\n]")
1612 (save-excursion (backward-char (1+ (length tag
)))
1615 ;; this / to detect we are after a directory separator is ok for unix,
1616 ;; is there a variable that contains the regexp for directory separator
1617 ;; on whatever operating system ?
1618 ;; Looks like ms-win will lose here :).
1620 ;; t if point is at a tag line that matches TAG exactly.
1621 ;; point should be just after a string that matches TAG.
1622 (defun tag-exact-match-p (tag)
1623 "Return non-nil if current tag line matches TAG exactly.
1624 Point should be just after a string that matches TAG."
1625 ;; The match is really exact if there is an explicit tag name.
1626 (or (and (eq (char-after (point)) ?
\001)
1627 (eq (char-after (- (point) (length tag
) 1)) ?
\177))
1628 ;; We are not on the explicit tag name, but perhaps it follows.
1629 (looking-at (concat "[^\177\n]*\177" (regexp-quote tag
) "\001"))))
1631 ;; t if point is at a tag line that has an implicit name.
1632 ;; point should be just after a string that matches TAG.
1633 (defun tag-implicit-name-match-p (tag)
1634 "Return non-nil if current tag line has an implicit name.
1635 Point should be just after a string that matches TAG."
1636 ;; Look at the comment of the make_tag function in lib-src/etags.c for
1637 ;; a textual description of the four rules.
1638 (and (string-match "^[^ \t()=,;]+$" tag
) ;rule #1
1639 (looking-at "[ \t()=,;]?\177") ;rules #2 and #4
1641 (backward-char (1+ (length tag
)))
1642 (looking-at "[\n \t()=,;]")))) ;rule #3
1644 ;; t if point is at a tag line that matches TAG as a symbol.
1645 ;; point should be just after a string that matches TAG.
1646 (defun tag-symbol-match-p (tag)
1647 "Return non-nil if current tag line matches TAG as a symbol.
1648 Point should be just after a string that matches TAG."
1649 (and (looking-at "\\Sw.*\177") (looking-at "\\S_.*\177")
1651 (backward-char (1+ (length tag
)))
1652 (and (looking-at "\\Sw") (looking-at "\\S_")))))
1654 ;; t if point is at a tag line that matches TAG as a word.
1655 ;; point should be just after a string that matches TAG.
1656 (defun tag-word-match-p (tag)
1657 "Return non-nil if current tag line matches TAG as a word.
1658 Point should be just after a string that matches TAG."
1659 (and (looking-at "\\b.*\177")
1660 (save-excursion (backward-char (length tag
))
1661 (looking-at "\\b"))))
1663 ;; partial file name match, i.e. searched tag must match a substring
1664 ;; of the file name (potentially including a directory separator).
1665 (defun tag-partial-file-name-match-p (_tag)
1666 "Return non-nil if current tag matches file name.
1667 This is a substring match, and it can include directory separators.
1668 Point should be just after a string that matches TAG."
1669 (and (looking-at ".*,[0-9\n]")
1670 (save-excursion (beginning-of-line)
1672 (looking-at "\f\n"))))
1674 ;; t if point is in a tag line with a tag containing TAG as a substring.
1675 (defun tag-any-match-p (_tag)
1676 "Return non-nil if current tag line contains TAG as a substring."
1677 (looking-at ".*\177"))
1679 ;; t if point is at a tag line that matches RE as a regexp.
1680 (defun tag-re-match-p (re)
1681 "Return non-nil if current tag line matches regexp RE."
1684 (let ((bol (point)))
1685 (and (search-forward "\177" (line-end-position) t
)
1686 (re-search-backward re bol t
)))))
1688 (defcustom tags-loop-revert-buffers nil
1689 "Non-nil means tags-scanning loops should offer to reread changed files.
1690 These loops normally read each file into Emacs, but when a file
1691 is already visited, they use the existing buffer.
1692 When this flag is non-nil, they offer to revert the existing buffer
1693 in the case where the file has changed since you visited it."
1698 (defun next-file (&optional initialize novisit
)
1699 "Select next file among files in current tags table.
1701 A first argument of t (prefix arg, if interactive) initializes to the
1702 beginning of the list of files in the tags table. If the argument is
1703 neither nil nor t, it is evalled to initialize the list of files.
1705 Non-nil second argument NOVISIT means use a temporary buffer
1706 to save time and avoid uninteresting warnings.
1708 Value is nil if the file was already visited;
1709 if the file was newly read in, the value is the filename."
1710 ;; Make the interactive arg t if there was any prefix arg.
1711 (interactive (list (if current-prefix-arg t
)))
1712 (cond ((not initialize
)
1713 ;; Not the first run.
1716 ;; Initialize the list from the tags table.
1718 ;; Visit the tags table buffer to get its list of files.
1719 (visit-tags-table-buffer)
1720 ;; Copy the list so we can setcdr below, and expand the file
1721 ;; names while we are at it, in this buffer's default directory.
1722 (setq next-file-list
(mapcar 'expand-file-name
(tags-table-files)))
1723 ;; Iterate over all the tags table files, collecting
1724 ;; a complete list of referenced file names.
1725 (while (visit-tags-table-buffer t
)
1726 ;; Find the tail of the working list and chain on the new
1727 ;; sublist for this tags table.
1728 (let ((tail next-file-list
))
1730 (setq tail
(cdr tail
)))
1731 ;; Use a copy so the next loop iteration will not modify the
1732 ;; list later returned by (tags-table-files).
1734 (setcdr tail
(mapcar 'expand-file-name
(tags-table-files)))
1735 (setq next-file-list
(mapcar 'expand-file-name
1736 (tags-table-files))))))))
1738 ;; Initialize the list by evalling the argument.
1739 (setq next-file-list
(eval initialize
))))
1740 (unless next-file-list
1742 (get-buffer " *next-file*")
1743 (kill-buffer " *next-file*"))
1744 (user-error "All files processed"))
1745 (let* ((next (car next-file-list
))
1746 (buffer (get-file-buffer next
))
1748 ;; Advance the list before trying to find the file.
1749 ;; If we get an error finding the file, don't get stuck on it.
1750 (setq next-file-list
(cdr next-file-list
))
1751 ;; Optionally offer to revert buffers
1752 ;; if the files have changed on disk.
1753 (and buffer tags-loop-revert-buffers
1754 (not (verify-visited-file-modtime buffer
))
1757 (if (buffer-modified-p buffer
)
1758 "File %s changed on disk. Discard your edits? "
1759 "File %s changed on disk. Reread from disk? ")
1761 (with-current-buffer buffer
1762 (revert-buffer t t
)))
1763 (if (not (and new novisit
))
1764 (find-file next novisit
)
1765 ;; Like find-file, but avoids random warning messages.
1766 (switch-to-buffer (get-buffer-create " *next-file*"))
1767 (kill-all-local-variables)
1770 (insert-file-contents new nil
))
1773 (defvar tags-loop-operate nil
1774 "Form for `tags-loop-continue' to eval to change one file.")
1776 (defvar tags-loop-scan
1778 (substitute-command-keys
1779 "No \\[tags-search] or \\[tags-query-replace] in progress"))
1780 "Form for `tags-loop-continue' to eval to scan one file.
1781 If it returns non-nil, this file needs processing by evalling
1782 \`tags-loop-operate'. Otherwise, move on to the next file.")
1784 (defun tags-loop-eval (form)
1785 "Evaluate FORM and return its result.
1786 Bind `case-fold-search' during the evaluation, depending on the value of
1787 `tags-case-fold-search'."
1788 (let ((case-fold-search (if (memq tags-case-fold-search
'(t nil
))
1789 tags-case-fold-search
1795 (defun tags-loop-continue (&optional first-time
)
1796 "Continue last \\[tags-search] or \\[tags-query-replace] command.
1797 Used noninteractively with non-nil argument to begin such a command (the
1798 argument is passed to `next-file', which see).
1800 Two variables control the processing we do on each file: the value of
1801 `tags-loop-scan' is a form to be executed on each file to see if it is
1802 interesting (it returns non-nil if so) and `tags-loop-operate' is a form to
1803 evaluate to operate on an interesting file. If the latter evaluates to
1804 nil, we exit; otherwise we scan the next file."
1807 ;; Non-nil means we have finished one file
1808 ;; and should not scan it again.
1814 ;; Scan files quickly for the first or next interesting one.
1815 ;; This starts at point in the current buffer.
1816 (while (or first-time file-finished
1819 (not (tags-loop-eval tags-loop-scan
))))
1820 ;; If nothing was found in the previous file, and
1821 ;; that file isn't in a temp buffer, restore point to
1823 (when original-point
1824 (goto-char original-point
))
1826 (setq file-finished nil
)
1827 (setq new
(next-file first-time t
))
1829 ;; If NEW is non-nil, we got a temp buffer,
1830 ;; and NEW is the file name.
1832 (and (not first-time
)
1833 (> baud-rate search-slow-speed
)
1835 (message "Scanning file %s..." (or new buffer-file-name
)))
1837 (setq first-time nil
)
1838 (setq original-point
(if new nil
(point)))
1839 (goto-char (point-min)))
1841 ;; If we visited it in a temp buffer, visit it now for real.
1843 (let ((pos (point)))
1845 (set-buffer (find-file-noselect new
))
1846 (setq new nil
) ;No longer in a temp buffer.
1849 (push-mark original-point t
))
1851 (switch-to-buffer (current-buffer))
1853 ;; Now operate on the file.
1854 ;; If value is non-nil, continue to scan the next file.
1855 (tags-loop-eval tags-loop-operate
))
1856 (setq file-finished t
))
1858 (null tags-loop-operate
)
1859 (message "Scanning file %s...found" buffer-file-name
))))
1860 ;;;###autoload (define-key esc-map "," 'tags-loop-continue)
1863 (defun tags-search (regexp &optional file-list-form
)
1864 "Search through all files listed in tags table for match for REGEXP.
1865 Stops when a match is found.
1866 To continue searching for next match, use command \\[tags-loop-continue].
1868 If FILE-LIST-FORM is non-nil, it should be a form that, when
1869 evaluated, will return a list of file names. The search will be
1870 restricted to these files.
1872 Also see the documentation of the `tags-file-name' variable."
1873 (interactive "sTags search (regexp): ")
1874 (if (and (equal regexp
"")
1875 (eq (car tags-loop-scan
) 're-search-forward
)
1876 (null tags-loop-operate
))
1877 ;; Continue last tags-search as if by M-,.
1878 (tags-loop-continue nil
)
1879 (setq tags-loop-scan
`(re-search-forward ',regexp nil t
)
1880 tags-loop-operate nil
)
1881 (tags-loop-continue (or file-list-form t
))))
1884 (defun tags-query-replace (from to
&optional delimited file-list-form
)
1885 "Do `query-replace-regexp' of FROM with TO on all files listed in tags table.
1886 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
1887 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
1888 with the command \\[tags-loop-continue].
1889 Fourth arg FILE-LIST-FORM non-nil means initialize the replacement loop.
1890 Fifth and sixth arguments START and END are accepted, for compatibility
1891 with `query-replace-regexp', and ignored.
1893 If FILE-LIST-FORM is non-nil, it is a form to evaluate to
1894 produce the list of files to search.
1896 See also the documentation of the variable `tags-file-name'."
1897 (interactive (query-replace-read-args "Tags query replace (regexp)" t t
))
1898 (setq tags-loop-scan
`(let ,(unless (equal from
(downcase from
))
1899 '((case-fold-search nil
)))
1900 (if (re-search-forward ',from nil t
)
1901 ;; When we find a match, move back
1902 ;; to the beginning of it so perform-replace
1904 (goto-char (match-beginning 0))))
1905 tags-loop-operate
`(perform-replace ',from
',to t t
',delimited
1906 nil multi-query-replace-map
))
1907 (tags-loop-continue (or file-list-form t
)))
1909 (defun tags-complete-tags-table-file (string predicate what
) ; Doc string?
1911 ;; If we need to ask for the tag table, allow that.
1912 (let ((enable-recursive-minibuffers t
))
1913 (visit-tags-table-buffer))
1915 (all-completions string
(tags-table-files) predicate
)
1916 (try-completion string
(tags-table-files) predicate
))))
1919 (defun list-tags (file &optional _next-match
)
1920 "Display list of tags in file FILE.
1921 This searches only the first table in the list, and no included tables.
1922 FILE should be as it appeared in the `etags' command, usually without a
1923 directory specification."
1924 (interactive (list (completing-read "List tags in file: "
1925 'tags-complete-tags-table-file
1927 (with-output-to-temp-buffer "*Tags List*"
1928 (princ "Tags in file `")
1929 (tags-with-face 'highlight
(princ file
))
1932 (let ((first-time t
)
1934 (while (visit-tags-table-buffer (not first-time
))
1935 (setq first-time nil
)
1936 (if (funcall list-tags-function file
)
1939 (user-error "File %s not in current tags tables" file
)))))
1940 (with-current-buffer "*Tags List*"
1944 (setq buffer-read-only t
)))
1947 (defun tags-apropos (regexp)
1948 "Display list of all tags in tags table REGEXP matches."
1949 (interactive "sTags apropos (regexp): ")
1950 (with-output-to-temp-buffer "*Tags List*"
1951 (princ "Click mouse-2 to follow tags.\n\nTags matching regexp `")
1952 (tags-with-face 'highlight
(princ regexp
))
1955 (let ((first-time t
))
1956 (while (visit-tags-table-buffer (not first-time
))
1957 (setq first-time nil
)
1958 (funcall tags-apropos-function regexp
))))
1959 (etags-tags-apropos-additional regexp
))
1960 (with-current-buffer "*Tags List*"
1961 (eval-and-compile (require 'apropos
))
1963 ;; apropos-mode is derived from fundamental-mode and it kills
1964 ;; all local variables.
1965 (setq buffer-read-only t
)))
1967 ;; XXX Kludge interface.
1969 (define-button-type 'tags-select-tags-table
1970 'action
'select-tags-table-select
1972 'help-echo
"RET, t or mouse-2: select tags table")
1974 ;; XXX If a file is in multiple tables, selection may get the wrong one.
1976 (defun select-tags-table ()
1977 "Select a tags table file from a menu of those you have already used.
1978 The list of tags tables to select from is stored in `tags-table-set-list';
1979 see the doc of that variable if you want to add names to the list."
1981 (pop-to-buffer "*Tags Table List*")
1982 (setq buffer-read-only nil
1985 (let ((set-list tags-table-set-list
)
1988 (when tags-table-list
1989 (setq desired-point
(point-marker))
1991 (princ (mapcar 'abbreviate-file-name tags-table-list
) (current-buffer))
1992 (make-text-button b
(point) 'type
'tags-select-tags-table
1993 'etags-table
(car tags-table-list
))
1996 (unless (eq (car set-list
) tags-table-list
)
1998 (princ (mapcar 'abbreviate-file-name
(car set-list
)) (current-buffer))
1999 (make-text-button b
(point) 'type
'tags-select-tags-table
2000 'etags-table
(car (car set-list
)))
2002 (setq set-list
(cdr set-list
)))
2003 (when tags-file-name
2005 (setq desired-point
(point-marker)))
2007 (insert (abbreviate-file-name tags-file-name
))
2008 (make-text-button b
(point) 'type
'tags-select-tags-table
2009 'etags-table tags-file-name
)
2011 (setq set-list
(delete tags-file-name
2012 (apply 'nconc
(cons (copy-sequence tags-table-list
)
2013 (mapcar 'copy-sequence
2014 tags-table-set-list
)))))
2017 (insert (abbreviate-file-name (car set-list
)))
2018 (make-text-button b
(point) 'type
'tags-select-tags-table
2019 'etags-table
(car set-list
))
2021 (setq set-list
(delete (car set-list
) set-list
)))
2022 (goto-char (point-min))
2023 (insert-before-markers
2024 "Type `t' to select a tags table or set of tags tables:\n\n")
2026 (goto-char desired-point
))
2027 (set-window-start (selected-window) 1 t
))
2028 (set-buffer-modified-p nil
)
2029 (select-tags-table-mode))
2031 (defvar select-tags-table-mode-map
; Doc string?
2032 (let ((map (make-sparse-keymap)))
2033 (set-keymap-parent map button-buffer-map
)
2034 (define-key map
"t" 'push-button
)
2035 (define-key map
" " 'next-line
)
2036 (define-key map
"\^?" 'previous-line
)
2037 (define-key map
"n" 'next-line
)
2038 (define-key map
"p" 'previous-line
)
2039 (define-key map
"q" 'select-tags-table-quit
)
2042 (define-derived-mode select-tags-table-mode special-mode
"Select Tags Table"
2043 "Major mode for choosing a current tags table among those already loaded."
2044 (setq buffer-read-only t
))
2046 (defun select-tags-table-select (button)
2047 "Select the tags table named on this line."
2048 (interactive (list (or (button-at (line-beginning-position))
2049 (error "No tags table on current line"))))
2050 (let ((name (button-get button
'etags-table
)))
2051 (visit-tags-table name
)
2052 (select-tags-table-quit)
2053 (message "Tags table now %s" name
)))
2055 (defun select-tags-table-quit ()
2056 "Kill the buffer and delete the selected window."
2058 (quit-window t
(selected-window)))
2061 (defun complete-tag ()
2062 "Perform tags completion on the text around point.
2063 Completes to the set of names listed in the current tags table.
2064 The string to complete is chosen in the same way as the default
2065 for \\[find-tag] (which see)."
2070 (substitute-command-keys
2071 "No tags table loaded; try \\[visit-tags-table]")))
2072 (let ((comp-data (tags-completion-at-point-function)))
2073 (if (null comp-data
)
2074 (user-error "Nothing to complete")
2075 (completion-in-region (car comp-data
) (cadr comp-data
)
2077 (plist-get (nthcdr 3 comp-data
) :predicate
)))))
2081 ;;; etags.el ends here
HCoop / bpt / emacs.git / blob