1 ;;; semantic/ia.el --- Interactive Analysis functions
3 ;;; Copyright (C) 2000-2014 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Interactive access to `semantic-analyze'.
27 ;; These routines are fairly simple, and show how to use the Semantic
28 ;; analyzer to provide things such as completion lists, summaries,
29 ;; locations, or documentation.
34 ;; fast-jump. For a virtual method, offer some of the possible
35 ;; implementations in various sub-classes.
37 (require 'semantic
/analyze
)
38 (require 'semantic
/format
)
40 (require 'semantic
/senator
)
41 (require 'semantic
/analyze
/refs
)
43 (require 'semantic
/analyze
)
44 (require 'semantic
/find
))
46 (declare-function imenu--mouse-menu
"imenu")
52 ;; This set of routines provides some simplisting completion
55 (defcustom semantic-ia-completion-format-tag-function
56 'semantic-format-tag-prototype
57 "Function used to convert a tag to a string during completion."
59 :type semantic-format-tag-custom-list
)
63 ;; This overload function handles inserting a tag
64 ;; into a buffer for these local completion routines.
66 ;; By creating the functions as overloadable, it can be
67 ;; customized. For example, the default will put a paren "("
68 ;; character after function names. For Lisp, it might check
69 ;; to put a "(" in front of a function name.
71 (define-overloadable-function semantic-ia-insert-tag
(tag)
72 "Insert TAG into the current buffer based on completion.")
74 (defun semantic-ia-insert-tag-default (tag)
75 "Insert TAG into the current buffer based on completion."
76 (insert (semantic-tag-name tag
))
77 (let ((tt (semantic-tag-class tag
)))
78 (cond ((eq tt
'function
)
82 (defalias 'semantic-ia-get-completions
'semantic-ia-get-completions-deprecated
83 "`Semantic-ia-get-completions' is obsolete.
84 Use `semantic-analyze-possible-completions' instead.")
86 (defun semantic-ia-get-completions-deprecated (context point
)
87 "A function to help transition away from `semantic-ia-get-completions'.
88 Return completions based on CONTEXT at POINT.
89 You should not use this, nor the aliased version.
90 Use `semantic-analyze-possible-completions' instead."
91 (semantic-analyze-possible-completions context
))
94 (defun semantic-ia-complete-symbol (&optional pos
)
95 "Complete the current symbol at POS.
96 If POS is nil, default to point.
97 Completion options are calculated with `semantic-analyze-possible-completions'."
99 (when (semantic-active-p)
100 (or pos
(setq pos
(point)))
101 ;; Calculating completions is a two step process.
103 ;; The first analyzer the current context, which finds tags for
104 ;; all the stuff that may be references by the code around POS.
106 ;; The second step derives completions from that context.
107 (let* ((a (semantic-analyze-current-context pos
))
108 (syms (semantic-analyze-possible-completions a
))
109 (pre (car (reverse (oref a prefix
)))))
110 ;; If PRE was actually an already completed symbol, it doesn't
111 ;; come in as a string, but as a tag instead.
112 (if (semantic-tag-p pre
)
113 ;; We will try completions on it anyway.
114 (setq pre
(semantic-tag-name pre
)))
115 ;; Complete this symbol.
117 (if (semantic-analyze-context-p a
)
118 ;; This is a clever hack. If we were unable to find any
119 ;; smart completions, let's divert to how senator derives
122 ;; This is a way of making this fcn more useful since
123 ;; the smart completion engine sometimes fails.
124 (semantic-complete-symbol))
125 ;; Use try completion to seek a common substring.
126 (let ((tc (try-completion (or pre
"") syms
)))
127 (if (and (stringp tc
) (not (string= tc
(or pre
""))))
128 (let ((tok (semantic-find-first-tag-by-name
130 ;; Delete what came before...
131 (when (and (car (oref a bounds
)) (cdr (oref a bounds
)))
132 (delete-region (car (oref a bounds
))
133 (cdr (oref a bounds
)))
134 (goto-char (car (oref a bounds
))))
135 ;; We have some new text. Stick it in.
137 (semantic-ia-insert-tag tok
)
139 ;; We don't have new text. Show all completions.
140 (when (cdr (oref a bounds
))
141 (goto-char (cdr (oref a bounds
))))
142 (with-output-to-temp-buffer "*Completions*"
143 (display-completion-list
144 (mapcar semantic-ia-completion-format-tag-function syms
)))))))))
146 (defcustom semantic-ia-completion-menu-format-tag-function
147 'semantic-format-tag-uml-concise-prototype
148 "*Function used to convert a tag to a string during completion."
150 :type semantic-format-tag-custom-list
)
152 ;; Disabled - see http://debbugs.gnu.org/14522
154 ;; (defun semantic-ia-complete-symbol-menu (point)
155 ;; "Complete the current symbol via a menu based at POINT.
156 ;; Completion options are calculated with `semantic-analyze-possible-completions'."
159 ;; (let* ((a (semantic-analyze-current-context point))
160 ;; (syms (semantic-analyze-possible-completions a))
162 ;; ;; Complete this symbol.
165 ;; (message "No smart completions found. Trying Senator.")
166 ;; (when (semantic-analyze-context-p a)
167 ;; ;; This is a quick way of getting a nice completion list
168 ;; ;; in the menu if the regular context mechanism fails.
169 ;; (senator-completion-menu-popup)))
175 ;; (funcall semantic-ia-completion-menu-format-tag-function tag)
179 ;; (imenu--mouse-menu
180 ;; ;; XEmacs needs that the menu has at least 2 items. So,
181 ;; ;; include a nil item that will be ignored by imenu.
183 ;; (senator-completion-menu-point-as-event)
186 ;; (if (not (semantic-tag-p ans))
187 ;; (setq ans (aref (cdr ans) 0)))
188 ;; (delete-region (car (oref a bounds)) (cdr (oref a bounds)))
189 ;; (semantic-ia-insert-tag ans))
194 ;; This functions shows how to get the list of completions,
195 ;; to place in a tooltip. It doesn't actually do any completion.
198 (defun semantic-ia-complete-tip (point)
199 "Pop up a tooltip for completion at POINT."
201 (let* ((a (semantic-analyze-current-context point
))
202 (syms (semantic-analyze-possible-completions a
))
203 (x (mod (- (current-column) (window-hscroll))
208 (narrow-to-region (window-start) (point))
209 (goto-char (point-min))
210 (1+ (vertical-motion (buffer-size))))))
211 (str (mapconcat #'semantic-tag-name
215 (cond ((fboundp 'x-show-tip
)
227 ;; Like idle-summary-mode, this shows how to get something to
228 ;; show a summary on.
231 (defun semantic-ia-show-summary (point)
232 "Display a summary for the symbol under POINT."
234 (let* ((ctxt (semantic-analyze-current-context point
))
236 ;; The CTXT is an EIEIO object. The below
237 ;; method will attempt to pick the most interesting
238 ;; tag associated with the current context.
239 (semantic-analyze-interesting-tag ctxt
)))
242 (message "%s" (semantic-format-tag-summarize pf nil t
))
243 (message "No summary info available"))))
247 ;; Show all variants for the symbol under point.
250 (defun semantic-ia-show-variants (point)
251 "Display a list of all variants for the symbol under POINT."
253 (let* ((ctxt (semantic-analyze-current-context point
))
256 ;; We really want to look at the function if we are on an
257 ;; argument. Are there some additional rules we care about for
258 ;; changing the CTXT we look at?
259 (when (semantic-analyze-context-functionarg-p ctxt
)
260 (goto-char (cdr (oref ctxt bounds
)))
261 (setq ctxt
(semantic-analyze-current-context (point))))
263 ;; Get the "completion list", but remove ALL filters to get the master list
264 ;; of all the possible things.
265 (setq comp
(semantic-analyze-possible-completions ctxt
'no-unique
'no-tc
))
267 ;; Special case for a single type. List the constructors?
268 (when (and (= (length comp
) 1) (semantic-tag-of-class-p (car comp
) 'type
))
269 (setq comp
(semantic-find-tags-by-name (semantic-tag-name (car comp
))
270 (semantic-tag-type-members (car comp
)))))
272 ;; Display the results.
273 (cond ((= (length comp
) 0)
274 (message "No Variants found."))
276 (message "%s" (semantic-format-tag-summarize (car comp
) nil t
)))
278 (with-output-to-temp-buffer "*Symbol Variants*"
279 (semantic-analyze-princ-sequence comp
"" (current-buffer)))
280 (shrink-window-if-larger-than-buffer
281 (get-buffer-window "*Symbol Variants*")))
286 ;; Jump to a destination based on the local context.
288 ;; This shows how to use the analyzer context, and the
289 ;; analyzer references objects to choose a good destination.
291 (defun semantic-ia--fast-jump-helper (dest)
292 "Jump to DEST, a Semantic tag.
293 This helper manages the mark, buffer switching, and pulsing."
294 ;; We have a tag, but in C++, we usually get a prototype instead
295 ;; because of header files. Let's try to find the actual
296 ;; implementation instead.
297 (when (semantic-tag-prototype-p dest
)
298 (let* ((refs (semantic-analyze-tag-references dest
))
299 (impl (semantic-analyze-refs-impl refs t
))
301 (when impl
(setq dest
(car impl
)))))
303 ;; Make sure we have a place to go...
304 (if (not (and (or (semantic-tag-with-position-p dest
)
305 (semantic-tag-get-attribute dest
:line
))
306 (semantic-tag-file-name dest
)))
307 (error "Tag %s has no buffer information"
308 (semantic-format-tag-name dest
)))
310 ;; Once we have the tag, we can jump to it. Here
311 ;; are the key bits to the jump:
313 ;; 1) Push the mark, so you can pop global mark back, or
314 ;; use semantic-mru-bookmark mode to do so.
316 (when (fboundp 'push-tag-mark
)
318 ;; 2) Visits the tag.
319 (semantic-go-to-tag dest
)
320 ;; 3) go-to-tag doesn't switch the buffer in the current window,
321 ;; so it is like find-file-noselect. Bring it forward.
322 (switch-to-buffer (current-buffer))
324 (pulse-momentary-highlight-one-line (point))
327 (declare-function semantic-decoration-include-visit
"semantic/decorate/include")
330 (defun semantic-ia-fast-jump (point)
331 "Jump to the tag referred to by the code at POINT.
332 Uses `semantic-analyze-current-context' output to identify an accurate
333 origin of the code at point."
335 (let* ((ctxt (semantic-analyze-current-context point
))
336 (pf (and ctxt
(reverse (oref ctxt prefix
))))
337 ;; In the analyzer context, the PREFIX is the list of items
338 ;; that makes up the code context at point. Thus the c++ code
339 ;; this.that().theothe
340 ;; would make a list:
341 ;; ( ("this" variable ..) ("that" function ...) "theothe")
342 ;; Where the first two elements are the semantic tags of the prefix.
344 ;; PF is the reverse of this list. If the first item is a string,
345 ;; then it is an incomplete symbol, thus we pick the second.
346 ;; The second cannot be a string, as that would have been an error.
351 ((semantic-tag-p first
)
352 ;; We have a match. Just go there.
353 (semantic-ia--fast-jump-helper first
))
355 ((semantic-tag-p second
)
356 ;; Because FIRST failed, we should visit our second tag.
357 ;; HOWEVER, the tag we actually want that was only an unfound
358 ;; string may be related to some take in the datatype that belongs
359 ;; to SECOND. Thus, instead of visiting second directly, we
360 ;; can offer to find the type of SECOND, and go there.
361 (let ((secondclass (car (reverse (oref ctxt prefixtypes
)))))
363 ((and (semantic-tag-with-position-p secondclass
)
364 (y-or-n-p (format "Could not find `%s'. Jump to %s? "
365 first
(semantic-tag-name secondclass
))))
366 (semantic-ia--fast-jump-helper secondclass
)
368 ;; If we missed out on the class of the second item, then
369 ;; just visit SECOND.
370 ((and (semantic-tag-p second
)
371 (y-or-n-p (format "Could not find `%s'. Jump to %s? "
372 first
(semantic-tag-name second
))))
373 (semantic-ia--fast-jump-helper second
)
376 ((semantic-tag-of-class-p (semantic-current-tag) 'include
)
377 ;; Just borrow this cool fcn.
378 (require 'semantic
/decorate
/include
)
379 (semantic-decoration-include-visit)
383 (error "Could not find suitable jump point for %s"
388 (defun semantic-ia-fast-mouse-jump (evt)
389 "Jump to the tag referred to by the point clicked on.
390 See `semantic-ia-fast-jump' for details on how it works.
391 This command is meant to be bound to a mouse event."
393 (semantic-ia-fast-jump
395 (posn-set-point (event-end evt
))
400 ;; These routines show how to get additional information about a tag
401 ;; for purposes of describing or showing documentation about them.
403 (defun semantic-ia-show-doc (point)
404 "Display the code-level documentation for the symbol at POINT."
406 (let* ((ctxt (semantic-analyze-current-context point
))
407 (pf (reverse (oref ctxt prefix
)))
409 ;; If PF, the prefix is non-nil, then the last element is either
410 ;; a string (incomplete type), or a semantic TAG. If it is a TAG
411 ;; then we should be able to find DOC for it.
414 (message "Incomplete symbol name."))
415 ((semantic-tag-p (car pf
))
416 ;; The `semantic-documentation-for-tag' fcn is language
417 ;; specific. If it doesn't return what you expect, you may
418 ;; need to implement something for your language.
420 ;; The default tries to find a comment in front of the tag
421 ;; and then strings off comment prefixes.
422 (let ((doc (semantic-documentation-for-tag (car pf
))))
423 (if (or (null doc
) (string= doc
""))
424 (message "Doc unavailable for: %s"
425 (semantic-format-tag-prototype (car pf
)))
426 (with-output-to-temp-buffer "*TAG DOCUMENTATION*"
428 (princ (semantic-format-tag-prototype (car pf
)))
431 (princ "Snarfed Documentation: ")
436 (princ " Documentation unavailable."))
439 (message "Unknown tag.")))
443 (defun semantic-ia-describe-class (typename)
444 "Display all known parts for the datatype TYPENAME.
445 If the type in question is a class, all methods and other accessible
446 parts of the parent classes are displayed."
447 ;; @todo - use a fancy completing reader.
448 (interactive "sType Name: ")
450 ;; When looking for a tag of any name there are a couple ways to do
451 ;; it. The simple `semanticdb-find-tag-by-...' are simple, and
452 ;; you need to pass it the exact name you want.
454 ;; The analyzer function `semantic-analyze-tag-name' will take
455 ;; more complex names, such as the cpp symbol foo::bar::baz,
456 ;; and break it up, and dive through the namespaces.
457 (let ((class (semantic-analyze-find-tag typename
)))
459 (when (not (semantic-tag-p class
))
460 (error "Cannot find class %s" class
))
461 (with-output-to-temp-buffer "*TAG DOCUMENTATION*"
462 ;; There are many semantic-format-tag-* fcns.
463 ;; The summarize routine is a fairly generic one.
464 (princ (semantic-format-tag-summarize class
))
466 (princ " Type Members:\n")
467 ;; The type tag contains all the parts of the type.
468 ;; In complex languages with inheritance, not all the
469 ;; parts are in the tag. This analyzer fcn will traverse
470 ;; the inheritance tree, and find all the pieces that
472 (let ((parts (semantic-analyze-scoped-type-parts class
)))
475 (princ (semantic-format-tag-summarize (car parts
)))
477 (setq parts
(cdr parts
)))
481 (provide 'semantic
/ia
)
484 ;; generated-autoload-file: "loaddefs.el"
485 ;; generated-autoload-load-name: "semantic/ia"
488 ;;; semantic/ia.el ends here