|
428
|
1 ;;; etags.el --- etags facility for Emacs
|
|
|
2
|
|
|
3 ;; Copyright 1985, 1986, 1988, 1990, 1997 Free Software Foundation, Inc.
|
|
|
4
|
|
|
5 ;; Author: Their Name is Legion (see list below)
|
|
|
6 ;; Maintainer: XEmacs Development Team
|
|
|
7 ;; Keywords: tools
|
|
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
|
10
|
|
|
11 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
12 ;; under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
14 ;; any later version.
|
|
|
15
|
|
|
16 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
19 ;; General Public License for more details.
|
|
|
20
|
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
|
22 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
|
|
|
24 ;; Boston, MA 02111-1307, USA.
|
|
|
25
|
|
|
26 ;;; Synched up with: Not synched with FSF.
|
|
|
27
|
|
|
28 ;;; Commentary:
|
|
|
29
|
|
|
30 ;; This file is completely different from FSF's etags.el. It appears
|
|
|
31 ;; that an early version of this file (tags.el) has been rewritten by
|
|
|
32 ;; two different people; we got one, FSF got the other. Various
|
|
|
33 ;; people have said that our version is better and faster.
|
|
|
34
|
|
|
35 ;; TODO:
|
|
|
36 ;; - DOCUMENT!
|
|
|
37
|
|
|
38 ;; Derived from the original lisp/tags.el.
|
|
|
39
|
|
|
40 ;; Ideas and code from the work of the following people:
|
|
|
41 ;; Andy Norman <ange@hplb.hpl.hp.com>, author of ange-tags.el
|
|
|
42 ;; Ramana Rao <rao@arisia.xerox.com>
|
|
|
43 ;; John Sturdy <jcgs@harlqn.co.uk>, author of tags-helper.el
|
|
|
44 ;; Henry Kautz <kautz@allegra.att.com>, author of tag-completion.el
|
|
|
45 ;; Dan LaLiberte <liberte@cs.uiuc.edu>, author of local-tags.el
|
|
|
46 ;; Tom Dietterich <tgd@turing.cs.orst.edu>, author of quest.el
|
|
|
47 ;; The author(s) of lisp/simple.el
|
|
|
48 ;; Duke Briscoe <briscoe@cs.yale.edu>
|
|
|
49 ;; Lynn Slater <lrs@indetech.com>, author of location.el
|
|
|
50 ;; Shinichirou Sugou <shin@sgtp.apple.juice.or.jp>
|
|
|
51 ;; an unidentified anonymous elisp hacker
|
|
|
52 ;; Kyle Jones <kyle_jones@wonderworks.com>
|
|
|
53 ;; added "Exact match, then inexact" code
|
|
|
54 ;; added support for include directive.
|
|
|
55 ;; Hrvoje Niksic <hniksic@xemacs.org>
|
|
|
56 ;; various changes.
|
|
|
57
|
|
|
58
|
|
|
59 ;;; User variables.
|
|
|
60
|
|
|
61 (defgroup etags nil
|
|
|
62 "Etags facility for Emacs.
|
|
|
63 Using etags, you can create tag tables for any number of files, and
|
|
|
64 easily access the symbols in those files, using the `\\[find-tag]'
|
|
|
65 command."
|
|
|
66 :prefix "tags-"
|
|
|
67 :group 'tools)
|
|
|
68
|
|
|
69
|
|
|
70 (defcustom tags-build-completion-table 'ask
|
|
|
71 "*If this variable is nil, then tags completion is disabled.
|
|
|
72 If it is t, then things which prompt for tags will do so with completion
|
|
|
73 across all known tags.
|
|
|
74 If it is the symbol `ask', you will be asked whether each tags table
|
|
|
75 should be added to the completion list as it is read in. (With the
|
|
|
76 exception that for very small tags tables, you will not be asked,
|
|
|
77 since they can be parsed quickly.)"
|
|
|
78 :type '(choice (const :tag "Disabled" nil)
|
|
|
79 (const :tag "Complete All" t)
|
|
|
80 (const :tag "Ask" ask))
|
|
|
81 :group 'etags)
|
|
|
82
|
|
|
83 (defcustom tags-always-exact nil
|
|
|
84 "*If this variable is non-nil, then tags always looks for exact matches.
|
|
|
85 If it is nil (the default), tags will first go through exact matches,
|
|
|
86 then through the non-exact ones."
|
|
|
87 :type 'boolean
|
|
|
88 :group 'etags)
|
|
|
89
|
|
|
90 (defcustom tag-table-alist nil
|
|
|
91 "*A list which determines which tags files are active for a buffer.
|
|
|
92 This is not really an association list, in that all elements are
|
|
|
93 checked. The CAR of each element of this list is a pattern against
|
|
|
94 which the buffer's file name is compared; if it matches, then the CDR
|
|
|
95 of the list should be the name of the tags table to use. If more than
|
|
|
96 one element of this list matches the buffer's file name, then all of
|
|
|
97 the associated tags tables will be used. Earlier ones will be
|
|
|
98 searched first.
|
|
|
99
|
|
|
100 If the CAR of elements of this list are strings, then they are treated
|
|
|
101 as regular-expressions against which the file is compared (like the
|
|
|
102 auto-mode-alist). If they are not strings, then they are evaluated.
|
|
|
103 If they evaluate to non-nil, then the current buffer is considered to
|
|
|
104 match.
|
|
|
105
|
|
|
106 If the CDR of the elements of this list are strings, then they are
|
|
|
107 assumed to name a TAGS file. If they name a directory, then the string
|
|
|
108 \"TAGS\" is appended to them to get the file name. If they are not
|
|
|
109 strings, then they are evaluated, and must return an appropriate string.
|
|
|
110
|
|
|
111 For example:
|
|
|
112 (setq tag-table-alist
|
|
|
113 '((\"/usr/src/public/perl/\" . \"/usr/src/public/perl/perl-3.0/\")
|
|
|
114 (\"\\\\.el$\" . \"/usr/local/emacs/src/\")
|
|
|
115 (\"/jbw/gnu/\" . \"/usr15/degree/stud/jbw/gnu/\")
|
|
|
116 (\"\" . \"/usr/local/emacs/src/\")
|
|
|
117 ))
|
|
|
118
|
|
|
119 This means that anything in the /usr/src/public/perl/ directory should use
|
|
|
120 the TAGS file /usr/src/public/perl/perl-3.0/TAGS; and file ending in .el should
|
|
|
121 use the TAGS file /usr/local/emacs/src/TAGS; and anything in or below the
|
|
|
122 directory /jbw/gnu/ should use the TAGS file /usr15/degree/stud/jbw/gnu/TAGS.
|
|
|
123 A file called something like \"/usr/jbw/foo.el\" would use both the TAGS files
|
|
|
124 /usr/local/emacs/src/TAGS and /usr15/degree/stud/jbw/gnu/TAGS (in that order)
|
|
|
125 because it matches both patterns.
|
|
|
126
|
|
|
127 If the buffer-local variable `buffer-tag-table' is set, then it names a tags
|
|
|
128 table that is searched before all others when find-tag is executed from this
|
|
|
129 buffer.
|
|
|
130
|
|
|
131 If there is a file called \"TAGS\" in the same directory as the file in
|
|
|
132 question, then that tags file will always be used as well (after the
|
|
|
133 `buffer-tag-table' but before the tables specified by this list.)
|
|
|
134
|
|
|
135 If the variable tags-file-name is set, then the tags file it names will apply
|
|
|
136 to all buffers (for backwards compatibility.) It is searched first."
|
|
|
137 :type '(repeat (cons :format "%v"
|
|
|
138 (choice :value ""
|
|
|
139 (regexp :tag "Buffer regexp")
|
|
|
140 sexp)
|
|
|
141 (choice :value ""
|
|
|
142 (string :tag "Tag file or directory")
|
|
|
143 sexp)))
|
|
|
144 :group 'etags)
|
|
|
145
|
|
|
146 (defvar buffer-tag-table nil
|
|
|
147 "*The additional name of one TAGS table to be used for this buffer.
|
|
|
148 You can set this with `\\[set-buffer-tag-table]'. See the documentation
|
|
|
149 for the variable `tag-table-alist' for more information.")
|
|
|
150 (make-variable-buffer-local 'buffer-tag-table)
|
|
|
151
|
|
|
152 (defvar tags-file-name nil
|
|
|
153 "The name of the tags-table used by all buffers.
|
|
|
154 This is for backwards compatibility, and is largely supplanted by the
|
|
|
155 variable tag-table-alist.")
|
|
|
156
|
|
|
157 (defcustom tags-auto-read-changed-tag-files nil
|
|
|
158 "*If non-nil, always re-read changed TAGS file without prompting.
|
|
|
159 If nil, prompt whether to re-read the changed TAGS file."
|
|
|
160 :type 'boolean
|
|
|
161 :group 'etags)
|
|
|
162
|
|
|
163 (defcustom make-tags-files-invisible nil
|
|
|
164 "*If non-nil, TAGS-files will not show up in buffer-lists or be
|
|
|
165 selectable (or deletable.)"
|
|
|
166 :type 'boolean
|
|
|
167 :group 'etags)
|
|
|
168
|
|
|
169 (defcustom tags-search-nuke-uninteresting-buffers t
|
|
|
170 "*If non-nil, keep newly-visited files if they contain the search target.
|
|
|
171 This affects the `tags-search' and `tags-query-replace' commands."
|
|
|
172 :type 'boolean
|
|
|
173 :group 'etags)
|
|
|
174
|
|
502
|
175 (defcustom tags-check-parent-directories-for-tag-files t
|
|
|
176 "*If non-nil, look for TAGS files in all parent directories."
|
|
|
177 :type 'boolean
|
|
|
178 :group 'etags)
|
|
|
179
|
|
428
|
180
|
|
|
181 ;; Buffer tag tables.
|
|
|
182
|
|
|
183 (defun buffer-tag-table-list ()
|
|
|
184 "Returns a list (ordered) of the tags tables which should be used for
|
|
|
185 the current buffer."
|
|
|
186 (let (result)
|
|
|
187 ;; Explicitly set buffer-tag-table
|
|
|
188 (when buffer-tag-table
|
|
|
189 (push buffer-tag-table result))
|
|
|
190 ;; Current directory
|
|
|
191 (when (file-readable-p (concat default-directory "TAGS"))
|
|
|
192 (push (concat default-directory "TAGS") result))
|
|
502
|
193 ;; Parent directories
|
|
|
194 (when tags-check-parent-directories-for-tag-files
|
|
|
195 (let ((cur default-directory))
|
|
593
|
196 ;; Fuck! Shouldn't there be a more obvious portable way
|
|
|
197 ;; to determine if we're the root? Shouldn't we have a
|
|
|
198 ;; proper path manipulation API? Do you know how many
|
|
|
199 ;; god-damn bugs are lurking out there because of Unix/
|
|
|
200 ;; Windows differences? And how much code is littered
|
|
|
201 ;; with stuff such as 10 lines down from here?
|
|
|
202 (while (not (and (equal (file-name-as-directory cur) cur)
|
|
|
203 (equal (directory-file-name cur) cur)))
|
|
|
204 (setq cur (expand-file-name ".." cur))
|
|
502
|
205 (let ((parent-tag-file (expand-file-name "TAGS" cur)))
|
|
|
206 (when (file-readable-p parent-tag-file)
|
|
|
207 (push parent-tag-file result))))))
|
|
428
|
208 ;; tag-table-alist
|
|
442
|
209 (let* ((key (or buffer-file-name
|
|
|
210 (concat default-directory (buffer-name))))
|
|
|
211 (key (if (eq system-type 'windows-nt)
|
|
|
212 (replace-in-string key "\\\\" "/")
|
|
|
213 key))
|
|
|
214 expression)
|
|
428
|
215 (dolist (item tag-table-alist)
|
|
|
216 (setq expression (car item))
|
|
|
217 ;; If the car of the alist item is a string, apply it as a regexp
|
|
|
218 ;; to the buffer-file-name. Otherwise, evaluate it. If the
|
|
|
219 ;; regexp matches, or the expression evaluates non-nil, then this
|
|
|
220 ;; item in tag-table-alist applies to this buffer.
|
|
|
221 (when (if (stringp expression)
|
|
|
222 (string-match expression key)
|
|
|
223 (ignore-errors
|
|
|
224 (eval expression)))
|
|
|
225 ;; Now evaluate the cdr of the alist item to get the name of
|
|
|
226 ;; the tag table file.
|
|
|
227 (setq expression (ignore-errors
|
|
|
228 (eval (cdr item))))
|
|
|
229 (if (stringp expression)
|
|
|
230 (push expression result)
|
|
|
231 (error "Expression in tag-table-alist evaluated to non-string")))))
|
|
|
232 (setq result
|
|
|
233 (mapcar
|
|
|
234 (lambda (name)
|
|
|
235 (when (file-directory-p name)
|
|
|
236 (setq name (concat (file-name-as-directory name) "TAGS")))
|
|
|
237 (and (file-readable-p name)
|
|
|
238 ;; get-tag-table-buffer has side-effects
|
|
|
239 (symbol-value-in-buffer 'buffer-file-name
|
|
|
240 (get-tag-table-buffer name))))
|
|
|
241 result))
|
|
|
242 (setq result (delq nil result))
|
|
|
243 ;; If no TAGS file has been found, ask the user explicitly.
|
|
|
244 ;; #### tags-file-name is *evil*.
|
|
|
245 (or result tags-file-name
|
|
|
246 (call-interactively 'visit-tags-table))
|
|
|
247 (when tags-file-name
|
|
|
248 (setq result (nconc result (list tags-file-name))))
|
|
|
249 (or result (error "Buffer has no associated tag tables"))
|
|
|
250 (delete-duplicates (nreverse result) :test 'equal)))
|
|
|
251
|
|
|
252 ;;;###autoload
|
|
|
253 (defun visit-tags-table (file)
|
|
|
254 "Tell tags commands to use tags table file FILE when all else fails.
|
|
|
255 FILE should be the name of a file created with the `etags' program.
|
|
|
256 A directory name is ok too; it means file TAGS in that directory."
|
|
|
257 (interactive (list (read-file-name "Visit tags table: (default TAGS) "
|
|
|
258 default-directory
|
|
|
259 (expand-file-name "TAGS" default-directory)
|
|
|
260 t)))
|
|
|
261 (if (string-equal file "")
|
|
|
262 (setq tags-file-name nil)
|
|
|
263 (setq file (expand-file-name file))
|
|
|
264 (when (file-directory-p file)
|
|
|
265 (setq file (expand-file-name "TAGS" file)))
|
|
|
266 ;; It used to be that, if a user pressed RET by mistake, the bogus
|
|
|
267 ;; `tags-file-name' would remain, causing the error at
|
|
|
268 ;; `buffer-tag-table'.
|
|
|
269 (when (file-exists-p file)
|
|
|
270 (setq tags-file-name file))))
|
|
|
271
|
|
|
272 (defun set-buffer-tag-table (file)
|
|
|
273 "In addition to the tags tables specified by the variable `tag-table-alist',
|
|
|
274 each buffer can have one additional table. This command sets that.
|
|
|
275 See the documentation for the variable `tag-table-alist' for more information."
|
|
|
276 (interactive
|
|
|
277 (list
|
|
|
278 (read-file-name "Visit tags table: (directory sufficient) "
|
|
|
279 nil default-directory t)))
|
|
|
280 (or file (error "No TAGS file name supplied"))
|
|
|
281 (setq file (expand-file-name file))
|
|
|
282 (when (file-directory-p file)
|
|
|
283 (setq file (expand-file-name "TAGS" file)))
|
|
|
284 (or (file-exists-p file) (error "TAGS file missing: %s" file))
|
|
|
285 (setq buffer-tag-table file))
|
|
|
286
|
|
|
287
|
|
|
288 ;; Manipulating the tag table buffer
|
|
|
289
|
|
|
290 (defconst tag-table-completion-status nil
|
|
|
291 "Indicates whether a completion table has been built.
|
|
|
292 Either nil, t, or `disabled'.")
|
|
|
293 (make-variable-buffer-local 'tag-table-completion-status)
|
|
|
294
|
|
|
295 (defconst tag-table-files nil
|
|
|
296 "If the current buffer is a TAGS table, this holds a list of the files
|
|
|
297 referenced by this file, or nil if that hasn't been computed yet.")
|
|
|
298 (make-variable-buffer-local 'tag-table-files)
|
|
|
299
|
|
|
300 (defun get-tag-table-buffer (tag-table)
|
|
|
301 "Returns a buffer visiting the given TAGS table.
|
|
|
302 If appropriate, reverting the buffer, and possibly build a completion-table."
|
|
|
303 (or (stringp tag-table)
|
|
|
304 (error "Bad tags file name supplied: %s" tag-table))
|
|
|
305 ;; Remove symbolic links from name.
|
|
|
306 (setq tag-table (symlink-expand-file-name tag-table))
|
|
|
307 (let (buf build-completion check-name)
|
|
|
308 (setq buf (get-file-buffer tag-table))
|
|
|
309 (unless buf
|
|
|
310 (if (file-readable-p tag-table)
|
|
|
311 (setq buf (find-file-noselect tag-table)
|
|
|
312 check-name t)
|
|
|
313 (error "No such tags file: %s" tag-table)))
|
|
|
314 (with-current-buffer buf
|
|
|
315 ;; Make the TAGS buffer invisible.
|
|
|
316 (when (and check-name
|
|
|
317 make-tags-files-invisible
|
|
|
318 (string-match "\\`[^ ]" (buffer-name)))
|
|
|
319 (rename-buffer (generate-new-buffer-name
|
|
|
320 (concat " " (buffer-name)))))
|
|
|
321 (or (verify-visited-file-modtime buf)
|
|
|
322 (cond ((or tags-auto-read-changed-tag-files
|
|
|
323 (yes-or-no-p
|
|
|
324 (format "Tags file %s has changed, read new contents? "
|
|
|
325 tag-table)))
|
|
|
326 (when tags-auto-read-changed-tag-files
|
|
|
327 (message "Tags file %s has changed, reading new contents..."
|
|
|
328 tag-table))
|
|
|
329 (revert-buffer t t)
|
|
|
330 (when (eq tag-table-completion-status t)
|
|
|
331 (setq tag-table-completion-status nil))
|
|
|
332 (setq tag-table-files nil))))
|
|
|
333 (or (eq (char-after 1) ?\f)
|
|
|
334 (error "File %s not a valid tags file" tag-table))
|
|
|
335 (or (memq tag-table-completion-status '(t disabled))
|
|
|
336 (setq build-completion t))
|
|
|
337 (when build-completion
|
|
|
338 (if (ecase tags-build-completion-table
|
|
|
339 ((nil) nil)
|
|
|
340 ((t) t)
|
|
|
341 ((ask)
|
|
|
342 ;; don't bother asking for small ones
|
|
|
343 (or (< (buffer-size) 20000)
|
|
|
344 (y-or-n-p
|
|
|
345 (format "Build tag completion table for %s? "
|
|
|
346 tag-table)))))
|
|
|
347 ;; The user wants to build the table:
|
|
|
348 (condition-case nil
|
|
|
349 (progn
|
|
|
350 (add-to-tag-completion-table)
|
|
|
351 (setq tag-table-completion-status t))
|
|
|
352 ;; Allow user to C-g out correctly
|
|
|
353 (quit
|
|
|
354 (message "Tags completion table construction aborted")
|
|
|
355 (setq tag-table-completion-status nil
|
|
|
356 quit-flag t)
|
|
|
357 t))
|
|
|
358 ;; The table is verboten.
|
|
|
359 (setq tag-table-completion-status 'disabled))))
|
|
|
360 buf))
|
|
|
361
|
|
|
362 (defun file-of-tag ()
|
|
|
363 "Return the file name of the file whose tags point is within.
|
|
|
364 Assumes the tag table is the current buffer.
|
|
|
365 File name returned is relative to tag table file's directory."
|
|
|
366 (let ((opoint (point))
|
|
|
367 prev size)
|
|
|
368 (save-excursion
|
|
|
369 (goto-char (point-min))
|
|
|
370 (while (< (point) opoint)
|
|
|
371 (forward-line 1)
|
|
|
372 (end-of-line)
|
|
|
373 (skip-chars-backward "^,\n")
|
|
|
374 (setq prev (point)
|
|
|
375 size (read (current-buffer)))
|
|
|
376 (goto-char prev)
|
|
|
377 (forward-line 1)
|
|
|
378 ;; New include syntax
|
|
|
379 ;; filename,include
|
|
|
380 ;; tacked on to the end of a tag file means use filename
|
|
|
381 ;; as a tag file before giving up.
|
|
|
382 ;; Skip it here.
|
|
|
383 (unless (eq size 'include)
|
|
|
384 (forward-char size)))
|
|
|
385 (goto-char (1- prev))
|
|
|
386 (buffer-substring (point) (point-at-bol)))))
|
|
|
387
|
|
|
388 (defun tag-table-include-files ()
|
|
|
389 "Return all file names associated with `include' directives in a tag buffer."
|
|
|
390 ;; New include syntax
|
|
|
391 ;; filename,include
|
|
|
392 ;; tacked on to the end of a tag file means use filename as a
|
|
|
393 ;; tag file before giving up.
|
|
|
394 (let ((files nil))
|
|
|
395 (save-excursion
|
|
|
396 (goto-char (point-min))
|
|
|
397 (while (re-search-forward "\f\n\\(.*\\),include$" nil t)
|
|
|
398 (push (match-string 1) files)))
|
|
|
399 files))
|
|
|
400
|
|
|
401 (defun tag-table-files (tag-table)
|
|
|
402 "Returns a list of the files referenced by the named TAGS table."
|
|
|
403 (with-current-buffer (get-tag-table-buffer tag-table)
|
|
|
404 (unless tag-table-files
|
|
|
405 (let (files prev size)
|
|
|
406 (goto-char (point-min))
|
|
|
407 (while (not (eobp))
|
|
|
408 (forward-line 1)
|
|
|
409 (end-of-line)
|
|
|
410 (skip-chars-backward "^,\n")
|
|
|
411 (setq prev (point)
|
|
|
412 size (read (current-buffer)))
|
|
|
413 (goto-char prev)
|
|
|
414 (push (expand-file-name (buffer-substring (1- (point))
|
|
|
415 (point-at-bol))
|
|
|
416 default-directory)
|
|
|
417 files)
|
|
|
418 (forward-line 1)
|
|
|
419 (forward-char size))
|
|
|
420 (setq tag-table-files (nreverse files))))
|
|
|
421 tag-table-files))
|
|
|
422
|
|
|
423 ;; #### should this be on previous page?
|
|
|
424 (defun buffer-tag-table-files ()
|
|
|
425 "Returns a list of all files referenced by all TAGS tables that
|
|
|
426 this buffer uses."
|
|
444
|
427 (apply #'append
|
|
428
|
428 (mapcar #'tag-table-files (buffer-tag-table-list))))
|
|
|
429
|
|
|
430
|
|
|
431 ;; Building the completion table
|
|
|
432
|
|
|
433 ;; Test cases for building completion table; must handle these properly:
|
|
|
434 ;; Lisp_Int, XSETINT, current_column 60,2282
|
|
|
435 ;; Lisp_Int, XSETINT, point>NumCharacters ? 0 : CharAt(363,9935
|
|
|
436 ;; Lisp_Int, XSETINT, point<=FirstCharacter ? 0 : CharAt(366,10108
|
|
|
437 ;; point<=FirstCharacter || CharAt(378,10630
|
|
|
438 ;; point>NumCharacters || CharAt(382,10825
|
|
|
439 ;; DEFUN ("x-set-foreground-color", Fx_set_foreground_color,191,4562
|
|
|
440 ;; DEFUN ("x-set-foreground-color", Fx_set_foreground_color,191,4562
|
|
|
441 ;; DEFUN ("*", Ftimes,1172,32079
|
|
|
442 ;; DEFUN ("/=", Fneq,1035,28839
|
|
|
443 ;; defun_internal 4199,101362
|
|
|
444 ;; int pure[PURESIZE / sizeof 53,1564
|
|
|
445 ;; char staticvec1[NSTATICS * sizeof 667,17608
|
|
|
446 ;; Date: 04 May 87 23:53:11 PDT 26,1077
|
|
|
447 ;; #define anymacroname(324,4344
|
|
|
448 ;; (define-key ctl-x-map 311,11784
|
|
|
449 ;; (define-abbrev-table 'c-mode-abbrev-table 24,1016
|
|
|
450 ;; static char *skip_white(116,3443
|
|
|
451 ;; static foo 348,11643
|
|
|
452 ;; (defun texinfo-insert-@code 91,3358
|
|
|
453 ;; (defvar texinfo-kindex)29,1105
|
|
|
454 ;; (defun texinfo-format-\. 548,18376
|
|
|
455 ;; (defvar sm::menu-kludge-y 621,22726
|
|
|
456 ;; (defvar *mouse-drag-window* 103,3642
|
|
|
457 ;; (defun simula-back-level(317,11263
|
|
|
458 ;; } DPxAC,380,14024
|
|
|
459 ;; } BM_QCB;69,2990
|
|
|
460 ;; #define MTOS_DONE\t
|
|
|
461
|
|
|
462 ;; "^[^ ]+ +\\([^ ]+\\) "
|
|
|
463
|
|
|
464 ;; void *find_cactus_segment(116,2444
|
|
|
465 ;; void *find_pdb_segment(162,3688
|
|
|
466 ;; void init_dclpool(410,10739
|
|
|
467 ;; WORD insert_draw_command(342,8881
|
|
|
468 ;; void *req_pdbmem(579,15574
|
|
|
469
|
|
|
470 (defvar tag-completion-table (make-vector 511 0))
|
|
|
471
|
|
|
472 (defvar tag-symbol)
|
|
|
473 (defvar tag-table-symbol)
|
|
|
474 (defvar tag-symbol-tables)
|
|
|
475 (defvar buffer-tag-table-list)
|
|
|
476
|
|
|
477 (defmacro intern-tag-symbol (tag)
|
|
|
478 `(progn
|
|
|
479 (setq tag-symbol (intern ,tag tag-completion-table)
|
|
|
480 tag-symbol-tables (and (boundp tag-symbol)
|
|
|
481 (symbol-value tag-symbol)))
|
|
|
482 (or (memq tag-table-symbol tag-symbol-tables)
|
|
|
483 (set tag-symbol (cons tag-table-symbol tag-symbol-tables)))))
|
|
|
484
|
|
|
485 ;; Can't use "\\s " in these patterns because that will include newline
|
|
|
486 (defconst tags-DEFUN-pattern
|
|
|
487 "DEFUN[ \t]*(\"\\([^\"]+\\)\",[ \t]*\\(\\(\\sw\\|\\s_\\)+\\),\C-?")
|
|
|
488 (defconst tags-array-pattern ".*[ \t]+\\([^ \[]+\\)\\[")
|
|
|
489 (defconst tags-def-pattern
|
|
|
490 "\\(.*[ \t]+\\)?\\**\\(\\(\\sw\\|\\s_\\)+\\)[ ();,\t]*\C-?"
|
|
|
491 ;; "\\(.*[ \t]+\\)?\\(\\(\\sw\\|\\s_\\)+\\)[ ()]*\C-?"
|
|
|
492 ;; "\\(\\sw\\|\\s_\\)+[ ()]*\C-?"
|
|
|
493 )
|
|
|
494 (defconst tags-file-pattern "^\f\n\\(.+\\),[0-9]+\n")
|
|
|
495
|
|
|
496 ;; #### Should make it work with the `include' directive!
|
|
|
497 (defun add-to-tag-completion-table ()
|
|
|
498 "Sucks the current buffer (a TAGS table) into the completion-table."
|
|
|
499 (message "Adding %s to tags completion table..." buffer-file-name)
|
|
|
500 (goto-char (point-min))
|
|
|
501 (let ((tag-table-symbol (intern buffer-file-name tag-completion-table))
|
|
|
502 ;; tag-table-symbol is used by intern-tag-symbol
|
|
|
503 filename file-type name name2 tag-symbol
|
|
|
504 tag-symbol-tables
|
|
|
505 (case-fold-search nil))
|
|
|
506 ;; Loop over the files mentioned in the TAGS file for each file,
|
|
|
507 ;; try to find its major-mode, then process tags appropriately.
|
|
|
508 (while (looking-at tags-file-pattern)
|
|
|
509 (goto-char (match-end 0))
|
|
|
510 (setq filename (file-name-sans-versions (match-string 1))
|
|
|
511 ;; We used to check auto-mode-alist for the proper
|
|
|
512 ;; file-type. This was way too slow, as it had to process
|
|
|
513 ;; an enormous amount of regexps for each time. Now we
|
|
|
514 ;; use the shotgun approach with only two regexps.
|
|
|
515 file-type (cond ((string-match "\\.\\([cC]\\|cc\\|cxx\\)\\'"
|
|
|
516 filename)
|
|
|
517 'c-mode)
|
|
|
518 ((string-match "\\.\\(el\\|cl\\|lisp\\)\\'"
|
|
|
519 filename)
|
|
|
520 'lisp-mode)
|
|
|
521 ((string-match "\\.scm\\'" filename)
|
|
|
522 'scheme-mode)
|
|
|
523 (t nil)))
|
|
442
|
524 (defvar c-mode-syntax-table)
|
|
428
|
525 (set-syntax-table (cond ((and (eq file-type 'c-mode)
|
|
|
526 c-mode-syntax-table)
|
|
|
527 c-mode-syntax-table)
|
|
|
528 ((eq file-type 'lisp-mode)
|
|
|
529 lisp-mode-syntax-table)
|
|
|
530 (t (standard-syntax-table))))
|
|
|
531 ;; Clear loop variables.
|
|
|
532 (setq name nil name2 nil)
|
|
|
533 (lmessage 'progress "%s..." filename)
|
|
|
534 ;; Loop over the individual tag lines.
|
|
|
535 (while (not (or (eobp) (eq (char-after) ?\f)))
|
|
|
536 (cond ((and (eq file-type 'c-mode)
|
|
|
537 (looking-at "DEFUN[ \t]"))
|
|
|
538 ;; DEFUN
|
|
|
539 (or (looking-at tags-DEFUN-pattern)
|
|
|
540 (error "DEFUN doesn't fit pattern"))
|
|
|
541 (setq name (match-string 1)
|
|
|
542 name2 (match-string 2)))
|
|
|
543 ;;((looking-at "\\s ")
|
|
|
544 ;; skip probably bogus entry:
|
|
|
545 ;;)
|
|
|
546 ((and (eq file-type 'c-mode)
|
|
|
547 (looking-at ".*\\["))
|
|
|
548 ;; Array
|
|
|
549 (cond ((not (looking-at tags-array-pattern))
|
|
|
550 (message "array definition doesn't fit pattern")
|
|
|
551 (setq name nil))
|
|
|
552 (t
|
|
|
553 (setq name (match-string 1)))))
|
|
|
554 ((and (eq file-type 'scheme-mode)
|
|
|
555 (looking-at "\\s-*(\\s-*def\\sw*\\s-*(?\\s-*\\(\\(\\sw\\|\\s_\\|:\\)+\\))?\\s-*\C-?"))
|
|
|
556 ;; Something Schemish (is this really necessary??)
|
|
|
557 (setq name (match-string 1)))
|
|
|
558 ((looking-at tags-def-pattern)
|
|
|
559 ;; ???
|
|
|
560 (setq name (match-string 2))))
|
|
|
561 ;; add the tags we found to the completion table
|
|
|
562 (and name (intern-tag-symbol name))
|
|
|
563 (and name2 (intern-tag-symbol name2))
|
|
|
564 (forward-line 1)))
|
|
|
565 (or (eobp) (error "Bad TAGS file")))
|
|
|
566 (message "Adding %s to tags completion table...done" buffer-file-name))
|
|
|
567
|
|
|
568
|
|
|
569 ;; Interactive find-tag
|
|
|
570
|
|
|
571 (defvar find-tag-default-hook nil
|
|
|
572 "Function to call to create a default tag.
|
|
|
573 Make it buffer-local in a mode hook. The function is called with no
|
|
|
574 arguments.")
|
|
|
575
|
|
|
576 (defvar find-tag-hook nil
|
|
|
577 "*Function to call after a tag is found.
|
|
|
578 Make it buffer-local in a mode hook. The function is called with no
|
|
|
579 arguments.")
|
|
|
580
|
|
|
581 ;; Return a default tag to search for, based on the text at point.
|
|
|
582 (defun find-tag-default ()
|
|
|
583 (or (and (not (memq find-tag-default-hook '(nil find-tag-default)))
|
|
793
|
584 (with-trapping-errors
|
|
|
585 :function 'find-tag-default-hook
|
|
|
586 :error-form nil
|
|
|
587 (funcall find-tag-default-hook)))
|
|
428
|
588 (symbol-near-point)))
|
|
|
589
|
|
|
590 ;; This function depends on the following symbols being bound properly:
|
|
|
591 ;; buffer-tag-table-list,
|
|
|
592 ;; tag-symbol-tables (value irrelevant, bound outside for efficiency)
|
|
|
593 (defun tag-completion-predicate (tag-symbol)
|
|
|
594 (and (boundp tag-symbol)
|
|
|
595 (setq tag-symbol-tables (symbol-value tag-symbol))
|
|
|
596 (catch 'found
|
|
|
597 (while tag-symbol-tables
|
|
|
598 (when (memq (car tag-symbol-tables) buffer-tag-table-list)
|
|
|
599 (throw 'found t))
|
|
|
600 (setq tag-symbol-tables (cdr tag-symbol-tables))))))
|
|
|
601
|
|
|
602 (defun buffer-tag-table-symbol-list ()
|
|
|
603 (mapcar (lambda (table-name)
|
|
|
604 (intern table-name tag-completion-table))
|
|
|
605 (buffer-tag-table-list)))
|
|
|
606
|
|
|
607 (defvar find-tag-history nil "History list for find-tag-tag.")
|
|
|
608
|
|
|
609 (defun find-tag-tag (prompt)
|
|
|
610 (let* ((default (find-tag-default))
|
|
|
611 (buffer-tag-table-list (buffer-tag-table-symbol-list))
|
|
|
612 tag-symbol-tables tag-name)
|
|
|
613 (setq tag-name
|
|
|
614 (completing-read
|
|
|
615 (if default
|
|
|
616 (format "%s(default %s) " prompt default)
|
|
|
617 prompt)
|
|
|
618 tag-completion-table 'tag-completion-predicate nil nil
|
|
440
|
619 'find-tag-history default))
|
|
|
620 tag-name))
|
|
428
|
621
|
|
|
622 (defvar last-tag-data nil
|
|
|
623 "Information for continuing a tag search.
|
|
|
624 Is of the form (TAG POINT MATCHING-EXACT TAG-TABLE TAG-TABLE ...).")
|
|
|
625
|
|
|
626 (defvar tags-loop-operate nil
|
|
|
627 "Form for `tags-loop-continue' to eval to change one file.")
|
|
|
628
|
|
|
629 (defvar tags-loop-scan
|
|
|
630 '(error "%s" (substitute-command-keys
|
|
|
631 "No \\[tags-search] or \\[tags-query-replace] in progress."))
|
|
|
632 "Form for `tags-loop-continue' to eval to scan one file.
|
|
|
633 If it returns non-nil, this file needs processing by evalling
|
|
|
634 \`tags-loop-operate'. Otherwise, move on to the next file.")
|
|
|
635
|
|
|
636 (autoload 'get-symbol-syntax-table "symbol-syntax")
|
|
|
637
|
|
|
638 (defun find-tag-internal (tagname)
|
|
487
|
639
|
|
428
|
640 (let ((next (null tagname))
|
|
|
641 (tmpnext (null tagname))
|
|
|
642 ;; If tagname is a list: (TAGNAME), this indicates
|
|
|
643 ;; requiring an exact symbol match.
|
|
|
644 (exact (or tags-always-exact (consp tagname)))
|
|
|
645 (normal-syntax-table (syntax-table))
|
|
|
646 (exact-syntax-table (get-symbol-syntax-table (syntax-table)))
|
|
|
647 tag-table-currently-matching-exact
|
|
|
648 tag-target exact-tagname
|
|
487
|
649 tag-tables tag-table-point file linebeg line startpos buf
|
|
428
|
650 offset found pat syn-tab)
|
|
|
651 (when (consp tagname)
|
|
|
652 (setq tagname (car tagname)))
|
|
|
653 (cond (next
|
|
|
654 (setq tagname (car last-tag-data))
|
|
|
655 (setq tag-table-currently-matching-exact
|
|
|
656 (car (cdr (cdr last-tag-data)))))
|
|
|
657 (t
|
|
|
658 (setq tag-table-currently-matching-exact t)))
|
|
|
659 ;; \_ in the tagname is used to indicate a symbol boundary.
|
|
442
|
660 (setq exact-tagname (format "\C-?\\_%s\\_\C-a\\|\\_%s\\_" tagname tagname))
|
|
428
|
661 (while (string-match "\\\\_" exact-tagname)
|
|
|
662 (aset exact-tagname (1- (match-end 0)) ?b))
|
|
|
663 (save-excursion
|
|
|
664 (catch 'found
|
|
|
665 ;; Loop searching for exact matches and then inexact matches.
|
|
|
666 (while (not (eq tag-table-currently-matching-exact 'neither))
|
|
|
667 (cond (tmpnext
|
|
|
668 (setq tag-tables (cdr (cdr (cdr last-tag-data)))
|
|
|
669 tag-table-point (car (cdr last-tag-data)))
|
|
|
670 ;; Start from the beginning of the table list on the
|
|
|
671 ;; next iteration of the loop.
|
|
|
672 (setq tmpnext nil))
|
|
|
673 (t
|
|
|
674 (setq tag-tables (buffer-tag-table-list)
|
|
|
675 tag-table-point 1)))
|
|
|
676 (if tag-table-currently-matching-exact
|
|
|
677 (setq tag-target exact-tagname
|
|
|
678 syn-tab exact-syntax-table)
|
|
|
679 (setq tag-target tagname
|
|
|
680 syn-tab normal-syntax-table))
|
|
|
681 (with-search-caps-disable-folding tag-target t
|
|
|
682 (while tag-tables
|
|
|
683 (set-buffer (get-tag-table-buffer (car tag-tables)))
|
|
|
684 (bury-buffer (current-buffer))
|
|
|
685 (goto-char (or tag-table-point (point-min)))
|
|
|
686 (setq tag-table-point nil)
|
|
|
687 (letf (((syntax-table) syn-tab)
|
|
|
688 (case-fold-search nil))
|
|
|
689 ;; #### should there be support for non-regexp
|
|
|
690 ;; tag searches?
|
|
|
691 (while (re-search-forward tag-target nil t)
|
|
|
692 (and (save-match-data
|
|
442
|
693 (save-excursion
|
|
|
694 (goto-char (match-beginning 0))
|
|
|
695 (looking-at "[^\n\C-?]*\C-?")))
|
|
428
|
696 ;; If we're looking for inexact matches, skip
|
|
|
697 ;; exact matches since we've visited them
|
|
|
698 ;; already.
|
|
|
699 (or tag-table-currently-matching-exact
|
|
|
700 (letf (((syntax-table) exact-syntax-table))
|
|
|
701 (save-excursion
|
|
|
702 (goto-char (match-beginning 0))
|
|
|
703 (not (looking-at exact-tagname)))))
|
|
|
704 (throw 'found t))))
|
|
|
705 (setq tag-tables
|
|
|
706 (nconc (tag-table-include-files) (cdr tag-tables)))))
|
|
|
707 (if (and (not exact) (eq tag-table-currently-matching-exact t))
|
|
|
708 (setq tag-table-currently-matching-exact nil)
|
|
|
709 (setq tag-table-currently-matching-exact 'neither)))
|
|
|
710 (error "No %sentries %s %s"
|
|
|
711 (if next "more " "")
|
|
|
712 (if exact "matching" "containing")
|
|
|
713 tagname))
|
|
442
|
714 (beginning-of-line)
|
|
487
|
715
|
|
|
716 ;; from here down, synched with FSF 20.7
|
|
|
717 ;; etags-snarf-tag and etags-goto-tag-location. --ben
|
|
|
718
|
|
|
719 (if (save-excursion
|
|
|
720 (forward-line -1)
|
|
|
721 (looking-at "\f\n"))
|
|
|
722 (progn
|
|
|
723 ;; The match was for a source file name, not any tag
|
|
|
724 ;; within a file. Give text of t, meaning to go exactly
|
|
|
725 ;; to the location we specify, the beginning of the file.
|
|
|
726 (setq linebeg t
|
|
|
727 line nil
|
|
|
728 startpos 1)
|
|
|
729 (setq file
|
|
|
730 (expand-file-name (file-of-tag)
|
|
|
731 ;; In XEmacs, this needs to be
|
|
|
732 ;; relative to:
|
|
|
733 (or (file-name-directory (car tag-tables))
|
|
|
734 "./"))))
|
|
|
735 (search-forward "\C-?")
|
|
|
736 (setq file
|
|
|
737 (expand-file-name (file-of-tag)
|
|
|
738 ;; In XEmacs, this needs to be
|
|
|
739 ;; relative to:
|
|
|
740 (or (file-name-directory (car tag-tables))
|
|
|
741 "./")))
|
|
|
742 (setq linebeg (buffer-substring (1- (point)) (point-at-bol)))
|
|
|
743 ;; Skip explicit tag name if present.
|
|
|
744 (search-forward "\001" (save-excursion (forward-line 1) (point)) t)
|
|
|
745 (if (looking-at "[0-9]")
|
|
|
746 (setq line (string-to-int (buffer-substring
|
|
|
747 (point)
|
|
|
748 (progn (skip-chars-forward "0-9")
|
|
|
749 (point))))))
|
|
|
750 (search-forward ",")
|
|
|
751 (if (looking-at "[0-9]")
|
|
|
752 (setq startpos (string-to-int (buffer-substring
|
|
|
753 (point)
|
|
|
754 (progn (skip-chars-forward "0-9")
|
|
|
755 (point)))))))
|
|
|
756 ;; Leave point on the next line of the tags file.
|
|
|
757 (forward-line 1)
|
|
428
|
758 (setq last-tag-data
|
|
|
759 (nconc (list tagname (point) tag-table-currently-matching-exact)
|
|
|
760 tag-tables))
|
|
|
761 (setq buf (find-file-noselect file))
|
|
487
|
762
|
|
|
763 ;; LINEBEG is the initial part of a line containing the tag and
|
|
|
764 ;; STARTPOS is the character position of LINEBEG within the file
|
|
|
765 ;; (starting from 1); LINE is the line number. If LINEBEG is t,
|
|
|
766 ;; it means the tag refers to exactly LINE or STARTPOS
|
|
|
767 ;; (whichever is present, LINE having preference, no searching).
|
|
|
768 ;; Either LINE or STARTPOS may be nil; STARTPOS is used if
|
|
|
769 ;; present. If the tag isn't exactly at the given position then
|
|
|
770 ;; look around that position using a search window which expands
|
|
|
771 ;; until it hits the start of file.
|
|
|
772
|
|
428
|
773 (with-current-buffer buf
|
|
|
774 (save-excursion
|
|
|
775 (save-restriction
|
|
|
776 (widen)
|
|
487
|
777 (if (eq linebeg t)
|
|
|
778 ;; Direct file tag.
|
|
|
779 (cond (line (goto-line line))
|
|
|
780 (startpos (goto-char startpos))
|
|
|
781 (t (error "etags.el BUG: bogus direct file tag")))
|
|
|
782 ;; Here we search for PAT in the range [STARTPOS - OFFSET,
|
|
|
783 ;; STARTPOS + OFFSET], with increasing values of OFFSET.
|
|
|
784 ;;
|
|
|
785 ;; We used to set the initial offset to 1000, but the
|
|
|
786 ;; actual sources show that finer-grained control is
|
|
|
787 ;; needed (e.g. two `hash_string's in src/symbols.c.) So,
|
|
|
788 ;; I changed 1000 to 100, and (* 3 offset) to (* 5 offset).
|
|
|
789 (setq offset 100)
|
|
|
790 (setq pat (concat (if (eq selective-display t)
|
|
|
791 "\\(^\\|\^m\\)" "^")
|
|
|
792 (regexp-quote linebeg)))
|
|
|
793
|
|
|
794 ;; The character position in the tags table is 0-origin.
|
|
|
795 ;; Convert it to a 1-origin Emacs character position.
|
|
|
796 (if startpos (setq startpos (1+ startpos)))
|
|
|
797 ;; If no char pos was given, try the given line number.
|
|
|
798 (or startpos
|
|
|
799 (if line
|
|
|
800 (setq startpos (progn (goto-line line)
|
|
|
801 (point)))))
|
|
|
802 (or startpos
|
|
|
803 (setq startpos (point-min)))
|
|
|
804 ;; First see if the tag is right at the specified location.
|
|
|
805 (goto-char startpos)
|
|
|
806 (setq found (looking-at pat))
|
|
|
807 (while (and (not found)
|
|
|
808 (progn
|
|
|
809 (goto-char (- startpos offset))
|
|
|
810 (not (bobp))))
|
|
|
811 (setq found
|
|
|
812 (re-search-forward pat (+ startpos offset) t)
|
|
|
813 offset (* 5 offset))) ; expand search window
|
|
|
814 ;; Finally, try finding it anywhere in the buffer.
|
|
|
815 (or found
|
|
|
816 (re-search-forward pat nil t)
|
|
|
817 (error "Rerun etags: `%s' not found in %s"
|
|
|
818 pat file))))
|
|
|
819 ;; Position point at the right place
|
|
|
820 ;; if the search string matched an extra Ctrl-m at the beginning.
|
|
|
821 (and (eq selective-display t)
|
|
|
822 (looking-at "\^m")
|
|
|
823 (forward-char 1))
|
|
|
824 (beginning-of-line)
|
|
|
825 (setq startpos (point))))
|
|
428
|
826 (cons buf startpos))))
|
|
|
827
|
|
|
828 ;;;###autoload
|
|
442
|
829 (defun find-tag-at-point (tagname &optional other-window)
|
|
|
830 "*Find tag whose name contains TAGNAME.
|
|
|
831 Identical to `find-tag' but does not prompt for tag when called interactively;
|
|
|
832 instead, uses tag around or before point."
|
|
|
833 (interactive (if current-prefix-arg
|
|
|
834 '(nil nil)
|
|
|
835 (list (find-tag-default) nil)))
|
|
|
836 (find-tag tagname other-window))
|
|
|
837
|
|
|
838 ;;;###autoload
|
|
428
|
839 (defun find-tag (tagname &optional other-window)
|
|
|
840 "*Find tag whose name contains TAGNAME.
|
|
|
841 Selects the buffer that the tag is contained in
|
|
|
842 and puts point at its definition.
|
|
|
843 If TAGNAME is a null string, the expression in the buffer
|
|
|
844 around or before point is used as the tag name.
|
|
|
845 If called interactively with a numeric argument, searches for the next tag
|
|
|
846 in the tag table that matches the tagname used in the previous find-tag.
|
|
|
847 If second arg OTHER-WINDOW is non-nil, uses another window to display
|
|
|
848 the tag.
|
|
|
849
|
|
|
850 This version of this function supports multiple active tags tables,
|
|
|
851 and completion.
|
|
|
852
|
|
|
853 Variables of note:
|
|
|
854
|
|
|
855 tag-table-alist controls which tables apply to which buffers
|
|
|
856 tags-file-name a default tags table
|
|
|
857 tags-build-completion-table controls completion behavior
|
|
|
858 buffer-tag-table another way of specifying a buffer-local table
|
|
|
859 make-tags-files-invisible whether tags tables should be very hidden
|
|
|
860 tag-mark-stack-max how many tags-based hops to remember"
|
|
|
861 (interactive (if current-prefix-arg
|
|
|
862 '(nil nil)
|
|
|
863 (list (find-tag-tag "Find tag: ") nil)))
|
|
|
864 (let* ((local-find-tag-hook find-tag-hook)
|
|
|
865 (next (null tagname))
|
|
|
866 (result (find-tag-internal tagname))
|
|
|
867 (tag-buf (car result))
|
|
|
868 (tag-point (cdr result)))
|
|
|
869 ;; Push old position on the tags mark stack.
|
|
|
870 (if (or (not next)
|
|
|
871 (not (memq last-command
|
|
|
872 '(find-tag find-tag-other-window tags-loop-continue))))
|
|
|
873 (push-tag-mark))
|
|
|
874 (if other-window
|
|
442
|
875 (pop-to-buffer tag-buf t)
|
|
428
|
876 (switch-to-buffer tag-buf))
|
|
|
877 (widen)
|
|
|
878 (push-mark)
|
|
|
879 (goto-char tag-point)
|
|
|
880 (if find-tag-hook
|
|
|
881 (run-hooks 'find-tag-hook)
|
|
|
882 (if local-find-tag-hook
|
|
|
883 (run-hooks 'local-find-tag-hook))))
|
|
|
884 (setq tags-loop-scan (list 'find-tag nil nil)
|
|
|
885 tags-loop-operate nil)
|
|
|
886 ;; Return t in case used as the tags-loop-scan.
|
|
|
887 t)
|
|
|
888
|
|
|
889 ;;;###autoload
|
|
|
890 (defun find-tag-other-window (tagname &optional next)
|
|
442
|
891 "*Find tag whose name contains TAGNAME, in another window.
|
|
428
|
892 Selects the buffer that the tag is contained in in another window
|
|
|
893 and puts point at its definition.
|
|
|
894 If TAGNAME is a null string, the expression in the buffer
|
|
|
895 around or before point is used as the tag name.
|
|
|
896 If second arg NEXT is non-nil (interactively, with prefix arg),
|
|
|
897 searches for the next tag in the tag table
|
|
|
898 that matches the tagname used in the previous find-tag.
|
|
|
899
|
|
|
900 This version of this function supports multiple active tags tables,
|
|
|
901 and completion.
|
|
|
902
|
|
|
903 Variables of note:
|
|
|
904
|
|
|
905 tag-table-alist controls which tables apply to which buffers
|
|
|
906 tags-file-name a default tags table
|
|
|
907 tags-build-completion-table controls completion behavior
|
|
|
908 buffer-tag-table another way of specifying a buffer-local table
|
|
|
909 make-tags-files-invisible whether tags tables should be very hidden
|
|
|
910 tag-mark-stack-max how many tags-based hops to remember"
|
|
|
911 (interactive (if current-prefix-arg
|
|
|
912 '(nil t)
|
|
|
913 (list (find-tag-tag "Find tag other window: "))))
|
|
|
914 (if next
|
|
|
915 (find-tag nil t)
|
|
|
916 (find-tag tagname t)))
|
|
|
917
|
|
|
918
|
|
|
919 ;; Completion on tags in the buffer.
|
|
|
920
|
|
|
921 (defun complete-symbol (&optional table predicate prettify)
|
|
|
922 (let* ((end (point))
|
|
|
923 (beg (save-excursion
|
|
|
924 (backward-sexp 1)
|
|
|
925 ;;(while (= (char-syntax (following-char)) ?\')
|
|
|
926 ;; (forward-char 1))
|
|
|
927 (skip-syntax-forward "'")
|
|
|
928 (point)))
|
|
|
929 (pattern (buffer-substring beg end))
|
|
|
930 (table (or table obarray))
|
|
|
931 (completion (try-completion pattern table predicate)))
|
|
|
932 (cond ((eq completion t))
|
|
|
933 ((null completion)
|
|
|
934 (error "Can't find completion for \"%s\"" pattern))
|
|
|
935 ((not (string-equal pattern completion))
|
|
|
936 (delete-region beg end)
|
|
|
937 (insert completion))
|
|
|
938 (t
|
|
|
939 (message "Making completion list...")
|
|
|
940 (let ((list (all-completions pattern table predicate)))
|
|
|
941 (if prettify
|
|
|
942 (setq list (funcall prettify list)))
|
|
|
943 (with-output-to-temp-buffer "*Help*"
|
|
|
944 (display-completion-list list)))
|
|
|
945 (message "Making completion list...%s" "done")))))
|
|
|
946
|
|
|
947 ;;;###autoload
|
|
|
948 (defun tag-complete-symbol ()
|
|
|
949 "The function used to do tags-completion (using 'tag-completion-predicate)."
|
|
|
950 (interactive)
|
|
|
951 (let* ((buffer-tag-table-list (buffer-tag-table-symbol-list))
|
|
|
952 tag-symbol-tables)
|
|
|
953 (complete-symbol tag-completion-table 'tag-completion-predicate)))
|
|
|
954
|
|
|
955
|
|
|
956 ;; Applying a command to files mentioned in tag tables
|
|
|
957
|
|
|
958 (defvar next-file-list nil
|
|
|
959 "List of files for next-file to process.")
|
|
|
960
|
|
|
961 ;;;###autoload
|
|
|
962 (defun next-file (&optional initialize novisit)
|
|
|
963 "Select next file among files in current tag table(s).
|
|
|
964
|
|
|
965 A first argument of t (prefix arg, if interactive) initializes to the
|
|
|
966 beginning of the list of files in the (first) tags table. If the argument
|
|
|
967 is neither nil nor t, it is evalled to initialize the list of files.
|
|
|
968
|
|
|
969 Non-nil second argument NOVISIT means use a temporary buffer
|
|
|
970 to save time and avoid uninteresting warnings.
|
|
|
971
|
|
|
972 Value is nil if the file was already visited;
|
|
|
973 if the file was newly read in, the value is the filename."
|
|
|
974 (interactive "P")
|
|
|
975 (cond ((not initialize)
|
|
|
976 ;; Not the first run.
|
|
|
977 )
|
|
|
978 ((eq initialize t)
|
|
|
979 ;; Initialize the list from the tags table.
|
|
|
980 (setq next-file-list (buffer-tag-table-files)))
|
|
|
981 (t
|
|
|
982 ;; Initialize the list by evalling the argument.
|
|
|
983 (setq next-file-list (eval initialize))))
|
|
|
984 (when (null next-file-list)
|
|
|
985 (and novisit
|
|
|
986 (get-buffer " *next-file*")
|
|
|
987 (kill-buffer " *next-file*"))
|
|
|
988 (error "All files processed"))
|
|
|
989 (let* ((file (car next-file-list))
|
|
|
990 (buf (get-file-buffer file))
|
|
|
991 (new (not buf)))
|
|
|
992 (pop next-file-list)
|
|
|
993
|
|
|
994 (if (not (and new novisit))
|
|
|
995 (switch-to-buffer (find-file-noselect file novisit) t)
|
|
|
996 ;; Like find-file, but avoids random junk.
|
|
|
997 (set-buffer (get-buffer-create " *next-file*"))
|
|
|
998 (kill-all-local-variables)
|
|
|
999 (erase-buffer)
|
|
|
1000 (insert-file-contents file nil))
|
|
|
1001 (widen)
|
|
|
1002 (when (> (point) (point-min))
|
|
|
1003 (push-mark nil t)
|
|
|
1004 (goto-char (point-min)))
|
|
|
1005 (and new file)))
|
|
|
1006
|
|
|
1007 ;;;###autoload
|
|
|
1008 (defun tags-loop-continue (&optional first-time)
|
|
|
1009 "Continue last \\[tags-search] or \\[tags-query-replace] command.
|
|
|
1010 Used noninteractively with non-nil argument to begin such a command (the
|
|
|
1011 argument is passed to `next-file', which see).
|
|
|
1012 Two variables control the processing we do on each file:
|
|
|
1013 the value of `tags-loop-scan' is a form to be executed on each file
|
|
|
1014 to see if it is interesting (it returns non-nil if so)
|
|
|
1015 and `tags-loop-operate' is a form to execute to operate on an interesting file
|
|
|
1016 If the latter returns non-nil, we exit; otherwise we scan the next file."
|
|
|
1017 (interactive)
|
|
|
1018 (let ((messaged nil)
|
|
|
1019 (more-files-p t)
|
|
|
1020 new)
|
|
|
1021 (while more-files-p
|
|
|
1022 ;; Scan files quickly for the first or next interesting one.
|
|
|
1023 (while (or first-time
|
|
|
1024 (save-restriction
|
|
|
1025 (widen)
|
|
|
1026 (not (eval tags-loop-scan))))
|
|
|
1027 (setq new (next-file first-time
|
|
|
1028 tags-search-nuke-uninteresting-buffers))
|
|
|
1029 ;; If NEW is non-nil, we got a temp buffer,
|
|
|
1030 ;; and NEW is the file name.
|
|
|
1031 (if (or messaged
|
|
|
1032 (and (not first-time)
|
|
|
1033 (> (device-baud-rate) search-slow-speed)
|
|
|
1034 (setq messaged t)))
|
|
|
1035 (lmessage 'progress
|
|
|
1036 "Scanning file %s..." (or new buffer-file-name)))
|
|
|
1037 (setq first-time nil)
|
|
|
1038 (goto-char (point-min)))
|
|
|
1039
|
|
|
1040 ;; If we visited it in a temp buffer, visit it now for real.
|
|
|
1041 (if (and new tags-search-nuke-uninteresting-buffers)
|
|
|
1042 (let ((pos (point)))
|
|
|
1043 (erase-buffer)
|
|
|
1044 (set-buffer (find-file-noselect new))
|
|
|
1045 (widen)
|
|
|
1046 (goto-char pos)))
|
|
|
1047
|
|
|
1048 (switch-to-buffer (current-buffer))
|
|
|
1049
|
|
|
1050 ;; Now operate on the file.
|
|
|
1051 ;; If value is non-nil, continue to scan the next file.
|
|
|
1052 (setq more-files-p (eval tags-loop-operate)))
|
|
|
1053 (and messaged
|
|
|
1054 (null tags-loop-operate)
|
|
|
1055 (message "Scanning file %s...found" buffer-file-name))))
|
|
|
1056
|
|
|
1057
|
|
|
1058 ;;;###autoload
|
|
|
1059 (defun tags-search (regexp &optional file-list-form)
|
|
|
1060 "Search through all files listed in tags table for match for REGEXP.
|
|
|
1061 Stops when a match is found.
|
|
|
1062 To continue searching for next match, use command \\[tags-loop-continue].
|
|
|
1063
|
|
|
1064 See documentation of variable `tag-table-alist'."
|
|
|
1065 (interactive "sTags search (regexp): ")
|
|
|
1066 (if (and (equal regexp "")
|
|
|
1067 (eq (car tags-loop-scan) 'with-search-caps-disable-folding)
|
|
|
1068 (null tags-loop-operate))
|
|
|
1069 ;; Continue last tags-search as if by `M-,'.
|
|
|
1070 (tags-loop-continue nil)
|
|
|
1071 (setq tags-loop-scan `(with-search-caps-disable-folding ,regexp t
|
|
|
1072 (re-search-forward ,regexp nil t))
|
|
|
1073 tags-loop-operate nil)
|
|
|
1074 (tags-loop-continue (or file-list-form t))))
|
|
|
1075
|
|
|
1076 ;;;###autoload
|
|
|
1077 (defun tags-query-replace (from to &optional delimited file-list-form)
|
|
|
1078 "Query-replace-regexp FROM with TO through all files listed in tags table.
|
|
|
1079 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
|
|
|
1080 If you exit (\\[keyboard-quit] or ESC), you can resume the query-replace
|
|
|
1081 with the command \\[tags-loop-continue].
|
|
|
1082
|
|
|
1083 See documentation of variable `tag-table-alist'."
|
|
|
1084 (interactive
|
|
|
1085 "sTags query replace (regexp): \nsTags query replace %s by: \nP")
|
|
|
1086 (setq tags-loop-scan `(with-search-caps-disable-folding ,from t
|
|
|
1087 (if (re-search-forward ,from nil t)
|
|
|
1088 ;; When we find a match, move back
|
|
|
1089 ;; to the beginning of it so perform-replace
|
|
|
1090 ;; will see it.
|
|
|
1091 (progn (goto-char (match-beginning 0)) t)))
|
|
|
1092 tags-loop-operate (list 'perform-replace from to t t
|
|
|
1093 (not (null delimited))))
|
|
|
1094 (tags-loop-continue (or file-list-form t)))
|
|
|
1095
|
|
|
1096 ;; Miscellaneous
|
|
|
1097
|
|
|
1098 ;;;###autoload
|
|
|
1099 (defun list-tags (file)
|
|
|
1100 "Display list of tags in FILE."
|
|
|
1101 (interactive (list (read-file-name
|
|
|
1102 (if (buffer-file-name)
|
|
|
1103 (format "List tags (in file, %s by default): "
|
|
|
1104 (file-name-nondirectory (buffer-file-name)))
|
|
|
1105 "List tags (in file): ")
|
|
|
1106 nil (buffer-file-name) t)))
|
|
|
1107 (find-file-noselect file)
|
|
|
1108 (with-output-to-temp-buffer "*Tags List*"
|
|
|
1109 (princ "Tags in file ")
|
|
|
1110 (princ file)
|
|
|
1111 (terpri)
|
|
|
1112 (save-excursion
|
|
|
1113 (dolist (tags-file (with-current-buffer (get-file-buffer file)
|
|
|
1114 (buffer-tag-table-list)))
|
|
|
1115 ;; We don't want completions getting in the way.
|
|
|
1116 (let ((tags-build-completion-table nil))
|
|
|
1117 (set-buffer (get-tag-table-buffer tags-file)))
|
|
|
1118 (goto-char (point-min))
|
|
|
1119 (when
|
|
|
1120 (search-forward (concat "\f\n" (file-name-nondirectory file) ",")
|
|
|
1121 nil t)
|
|
|
1122 (forward-line 1)
|
|
|
1123 (while (not (or (eobp) (looking-at "\f")))
|
|
|
1124 (princ (buffer-substring (point)
|
|
|
1125 (progn (skip-chars-forward "^\C-?")
|
|
|
1126 (point))))
|
|
|
1127 (terpri)
|
|
|
1128 (forward-line 1)))))))
|
|
|
1129
|
|
|
1130 ;;;###autoload
|
|
|
1131 (defun tags-apropos (string)
|
|
|
1132 "Display list of all tags in tag table REGEXP matches."
|
|
|
1133 (interactive "sTag apropos (regexp): ")
|
|
|
1134 (with-output-to-temp-buffer "*Tags List*"
|
|
|
1135 (princ "Tags matching regexp ")
|
|
|
1136 (prin1 string)
|
|
|
1137 (terpri)
|
|
|
1138 (save-excursion
|
|
|
1139 (visit-tags-table-buffer)
|
|
|
1140 (goto-char 1)
|
|
|
1141 (while (re-search-forward string nil t)
|
|
|
1142 (beginning-of-line)
|
|
|
1143 (princ (buffer-substring (point)
|
|
|
1144 (progn (skip-chars-forward "^\C-?")
|
|
|
1145 (point))))
|
|
|
1146 (terpri)
|
|
|
1147 (forward-line 1)))))
|
|
|
1148
|
|
|
1149 ;; #### copied from tags.el. This function is *very* big in FSF.
|
|
|
1150 (defun visit-tags-table-buffer ()
|
|
|
1151 "Select the buffer containing the current tag table."
|
|
|
1152 (or tags-file-name
|
|
|
1153 (call-interactively 'visit-tags-table))
|
|
|
1154 (set-buffer (or (get-file-buffer tags-file-name)
|
|
|
1155 (progn
|
|
|
1156 (setq tag-table-files nil)
|
|
|
1157 (find-file-noselect tags-file-name))))
|
|
|
1158 (or (verify-visited-file-modtime (get-file-buffer tags-file-name))
|
|
|
1159 (cond ((yes-or-no-p "Tags file has changed, read new contents? ")
|
|
|
1160 (revert-buffer t t)
|
|
|
1161 (setq tag-table-files nil))))
|
|
|
1162 (or (eq (char-after 1) ?\^L)
|
|
|
1163 (error "File %s not a valid tag table" tags-file-name)))
|
|
|
1164
|
|
|
1165
|
|
|
1166 ;; Sample uses of find-tag-hook and find-tag-default-hook
|
|
|
1167
|
|
|
1168 ;; This is wrong. We should either make this behavior default and
|
|
|
1169 ;; back it up, or not use it at all. For now, I've commented it out.
|
|
|
1170 ;; --hniksic
|
|
|
1171
|
|
|
1172 ;; Example buffer-local tag finding
|
|
|
1173
|
|
|
1174 ;(add-hook 'emacs-lisp-mode-hook 'setup-emacs-lisp-default-tag-hook)
|
|
|
1175
|
|
|
1176 ;(defun setup-emacs-lisp-default-tag-hook ()
|
|
|
1177 ; (cond ((eq major-mode 'emacs-lisp-mode)
|
|
|
1178 ; (make-variable-buffer-local 'find-tag-default-hook)
|
|
|
1179 ; (setq find-tag-default-hook 'emacs-lisp-default-tag))))
|
|
|
1180 ;;; Run it once immediately
|
|
|
1181 ;(setup-emacs-lisp-default-tag-hook)
|
|
|
1182 ;(when (get-buffer "*scratch*")
|
|
|
1183 ; (with-current-buffer "*scratch*"
|
|
|
1184 ; (setup-emacs-lisp-default-tag-hook)))
|
|
|
1185
|
|
|
1186 ;(defun emacs-lisp-default-tag ()
|
|
|
1187 ; "Function to return a default tag for Emacs-Lisp mode."
|
|
|
1188 ; (let ((tag (or (variable-at-point)
|
|
|
1189 ; (function-at-point))))
|
|
|
1190 ; (if tag (symbol-name tag))))
|
|
|
1191
|
|
|
1192
|
|
|
1193 ;; Display short info on tag in minibuffer
|
|
|
1194
|
|
|
1195 ;; Don't pollute `M-?' -- we may need it for more important stuff. --hniksic
|
|
|
1196 ;(if (null (lookup-key esc-map "?"))
|
|
|
1197 ; (define-key esc-map "?" 'display-tag-info))
|
|
|
1198
|
|
|
1199 (defun display-tag-info (tagname)
|
|
|
1200 "Prints a description of the first tag matching TAGNAME in the echo area.
|
|
|
1201 If this is an elisp function, prints something like \"(defun foo (x y z)\".
|
|
|
1202 That is, is prints the first line of the definition of the form.
|
|
|
1203 If this is a C-defined elisp function, it does something more clever."
|
|
|
1204 (interactive (if current-prefix-arg
|
|
|
1205 '(nil)
|
|
|
1206 (list (find-tag-tag "Display tag info: "))))
|
|
|
1207 (let* ((results (find-tag-internal tagname))
|
|
|
1208 (tag-buf (car results))
|
|
|
1209 (tag-point (cdr results))
|
|
|
1210 info lname min max fname args)
|
|
|
1211 (with-current-buffer tag-buf
|
|
|
1212 (save-excursion
|
|
|
1213 (save-restriction
|
|
|
1214 (widen)
|
|
|
1215 (goto-char tag-point)
|
|
|
1216 (cond ((let ((case-fold-search nil))
|
|
|
1217 (looking-at "^DEFUN[ \t]"))
|
|
|
1218 (forward-sexp 1)
|
|
|
1219 (down-list 1)
|
|
|
1220 (setq lname (read (current-buffer))
|
|
|
1221 fname (buffer-substring
|
|
|
1222 (progn (forward-sexp 1) (point))
|
|
|
1223 (progn (backward-sexp 1) (point)))
|
|
|
1224 min (buffer-substring
|
|
|
1225 (progn (forward-sexp 3) (point))
|
|
|
1226 (progn (backward-sexp 1) (point)))
|
|
|
1227 max (buffer-substring
|
|
|
1228 (progn (forward-sexp 2) (point))
|
|
|
1229 (progn (backward-sexp 1) (point))))
|
|
|
1230 (backward-up-list 1)
|
|
|
1231 (setq args (buffer-substring
|
|
|
1232 (progn (forward-sexp 2) (point))
|
|
|
1233 (progn (backward-sexp 1) (point))))
|
|
|
1234 (setq info (format "Elisp: %s, C: %s %s, #args: %s"
|
|
|
1235 lname
|
|
|
1236 fname args
|
|
|
1237 (if (string-equal min max)
|
|
|
1238 min
|
|
|
1239 (format "from %s to %s" min max)))))
|
|
|
1240 (t
|
|
|
1241 (setq info
|
|
|
1242 (buffer-substring
|
|
|
1243 (progn (beginning-of-line) (point))
|
|
|
1244 (progn (end-of-line) (point)))))))))
|
|
|
1245 (message "%s" info))
|
|
|
1246 (setq tags-loop-scan '(display-tag-info nil)
|
|
|
1247 tags-loop-operate nil)
|
|
|
1248 ;; Always return non-nil
|
|
|
1249 t)
|
|
|
1250
|
|
|
1251
|
|
|
1252 ;; Tag mark stack.
|
|
|
1253
|
|
|
1254 (defvar tag-mark-stack1 nil)
|
|
|
1255 (defvar tag-mark-stack2 nil)
|
|
|
1256
|
|
|
1257 (defcustom tag-mark-stack-max 16
|
|
|
1258 "*The maximum number of elements kept on the mark-stack used
|
|
|
1259 by tags-search. See also the commands `\\[push-tag-mark]' and
|
|
|
1260 and `\\[pop-tag-mark]'."
|
|
|
1261 :type 'integer
|
|
|
1262 :group 'etags)
|
|
|
1263
|
|
|
1264 (defun push-mark-on-stack (stack-symbol &optional max-size)
|
|
|
1265 (let ((stack (symbol-value stack-symbol)))
|
|
|
1266 (push (point-marker) stack)
|
|
|
1267 (cond ((and max-size
|
|
|
1268 (> (length stack) max-size))
|
|
|
1269 (set-marker (car (nthcdr max-size stack)) nil)
|
|
|
1270 (setcdr (nthcdr (1- max-size) stack) nil)))
|
|
|
1271 (set stack-symbol stack)))
|
|
|
1272
|
|
|
1273 (defun pop-mark-from-stack (stack-symbol1 stack-symbol2 &optional max-size)
|
|
|
1274 (let* ((stack (or (symbol-value stack-symbol1)
|
|
|
1275 (error "No more tag marks on stack")))
|
|
|
1276 (marker (car stack))
|
|
|
1277 (m-buf (marker-buffer marker)))
|
|
|
1278 (set stack-symbol1 (cdr stack))
|
|
|
1279 (or m-buf
|
|
|
1280 (error "Marker has no buffer"))
|
|
|
1281 (or (buffer-live-p m-buf)
|
|
|
1282 (error "Buffer has been killed"))
|
|
|
1283 (push-mark-on-stack stack-symbol2 max-size)
|
|
|
1284 (switch-to-buffer m-buf)
|
|
|
1285 (widen)
|
|
|
1286 (goto-char marker)))
|
|
|
1287
|
|
|
1288 (defun push-tag-mark ()
|
|
|
1289 (push-mark-on-stack 'tag-mark-stack1 tag-mark-stack-max))
|
|
|
1290
|
|
|
1291 ;;;###autoload (define-key esc-map "*" 'pop-tag-mark)
|
|
|
1292
|
|
|
1293 ;;;###autoload
|
|
|
1294 (defun pop-tag-mark (arg)
|
|
|
1295 "Go to last tag position.
|
|
|
1296 `find-tag' maintains a mark-stack seperate from the \\[set-mark-command] mark-stack.
|
|
|
1297 This function pops (and moves to) the tag at the top of this stack."
|
|
|
1298 (interactive "P")
|
|
|
1299 (if (not arg)
|
|
|
1300 (pop-mark-from-stack
|
|
|
1301 'tag-mark-stack1 'tag-mark-stack2 tag-mark-stack-max)
|
|
|
1302 (pop-mark-from-stack
|
|
|
1303 'tag-mark-stack2 'tag-mark-stack1 tag-mark-stack-max)))
|
|
|
1304
|
|
|
1305
|
|
|
1306 (provide 'etags)
|
|
|
1307 (provide 'tags)
|
|
|
1308
|
|
|
1309 ;;; etags.el ends here
|
