1 ;;; semantic/analyze/debug.el --- Debug the analyzer
3 ;;; Copyright (C) 2008-2011 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; Provide a top-order debugging tool for figuring out what's going on with
25 ;; smart completion and analyzer mode.
28 (require 'semantic/analyze)
29 (require 'semantic/analyze/complete)
30 (require 'semantic/db-typecache)
32 ;; For semantic-find-tags-by-class:
33 (eval-when-compile (require 'semantic/find))
35 (declare-function ede-get-locator-object "ede/files")
39 (defun semantic-analyze-debug-assist ()
40 "Debug semantic analysis at the current point."
42 (let ((actualfcn (fetch-overload 'semantic-analyze-current-context))
43 (ctxt (semantic-analyze-current-context))
47 (message "Mode %s does not use the default analyzer."
51 (or (semantic-analyzer-debug-test-local-context)
52 (and ctxt (semantic-analyzer-debug-found-prefix ctxt))
57 ;; @TODO - If this happens, but the last found type is
58 ;; a datatype, then the below is wrong
59 (defun semantic-analyzer-debug-found-prefix (ctxt)
60 "Debug the prefix found by the analyzer output CTXT."
61 (let* ((pf (oref ctxt prefix))
62 (pft (oref ctxt prefixtypes))
65 (comp (condition-case nil
66 (semantic-analyze-possible-completions ctxt)
69 (while (and (nth idx pf) (not stop))
70 (let ((pentry (nth idx pf))
71 (ptentry (nth idx pft)))
72 (if (or (stringp pentry) (not ptentry))
73 ;; Found someting ok. stop
75 (setq idx (1+ idx)))))
76 ;; We found the first non-tag entry. What is the situation?
78 ((and (eq idx 0) (stringp (car pf)))
79 ;; First part, we couldn't find it.
80 (semantic-analyzer-debug-global-symbol ctxt (car pf) comp))
81 ((not (nth (1- idx) pft)) ;; idx can't be 0 here.
82 ;; The previous entry failed to have an identifiable data
83 ;; type, which is a global search.
84 (semantic-analyzer-debug-missing-datatype ctxt idx comp))
85 ((and (nth (1- idx) pft) (stringp (nth idx pf)))
86 ;; Non-first search, didn't find string in known data type.
87 (semantic-analyzer-debug-missing-innertype ctxt idx comp))
90 (message "Things look ok."))
93 (defun semantic-analyzer-debug-global-symbol (ctxt prefix comp)
94 "Debug why we can't find the first entry in the CTXT PREFIX.
95 Argument COMP are possible completions here."
96 (let ((tab semanticdb-current-table)
98 (origbuf (current-buffer))
100 (with-output-to-temp-buffer (help-buffer)
101 (with-current-buffer standard-output
102 (princ "Unable to find symbol ")
106 ;; NOTE: This line is copied from semantic-analyze-current-context.
107 ;; You will need to update both places.
109 (with-current-buffer origbuf
110 (let* ((position (or (cdr-safe (oref ctxt bounds)) (point)))
111 (prefixtypes nil) ; Used as type return
112 (scope (semantic-calculate-scope position))
114 (semantic-analyze-find-tag-sequence
115 (list prefix "") scope 'prefixtypes)
118 (error (setq finderr err)))
122 (princ "The prefix lookup code threw the following error:\n ")
124 (princ "\n\nTo debug this error you can do this:
125 M-x toggle-debug-on-error RET
126 and then re-run the debug analyzer.\n")
128 ;; No find error, just not found
129 (princ "The prefix ")
131 (princ " could not be found in the local scope,
132 nor in any search tables.\n")
136 ;; Describe local scope, and why we might not be able to
138 (semantic-analyzer-debug-describe-scope ctxt)
140 (semantic-analyzer-debug-show-completions comp)
142 (princ "When Semantic cannot find a symbol, it could be because the include
143 path was setup incorrectly.\n")
145 (semantic-analyzer-debug-insert-include-summary tab)
148 (semantic-analyzer-debug-add-buttons)
151 (defun semantic-analyzer-debug-missing-datatype (ctxt idx comp)
152 "Debug why we can't find a datatype entry for CTXT prefix at IDX.
153 Argument COMP are possible completions here."
154 (let* ((prefixitem (nth idx (oref ctxt prefix)))
155 (dt (nth (1- idx) (oref ctxt prefixtypes)))
156 (tt (semantic-tag-type prefixitem))
157 (tab semanticdb-current-table)
159 (when dt (error "Missing Datatype debugger is confused"))
160 (with-output-to-temp-buffer (help-buffer)
161 (with-current-buffer standard-output
162 (princ "Unable to find datatype for: \"")
163 (princ (semantic-format-tag-prototype prefixitem))
166 (when (semantic-tag-p tt)
167 (semantic-analyzer-debug-insert-tag tt)
168 (princ "\nRaw data type is: "))
169 (princ (format "%S" tt))
172 Semantic could not find this data type in any of its global tables.
174 Semantic locates datatypes through either the local scope, or the global
178 ;; Describe local scope, and why we might not be able to
180 (semantic-analyzer-debug-describe-scope ctxt '(type))
182 ;; Describe the typecache.
183 (princ "\nSemantic creates and maintains a type cache for each buffer.
184 If the type is a global type, then it should appear in they typecache.
185 To examine the typecache, type:
187 M-x semanticdb-typecache-dump RET
189 Current typecache Statistics:\n")
190 (princ (format " %4d types global in this file\n %4d types from includes.\n"
191 (length (semanticdb-typecache-file-tags tab))
192 (length (semanticdb-typecache-include-tags tab))))
194 (princ "\nIf the datatype is not in the typecache, then your include
195 path may be incorrect. ")
197 (semantic-analyzer-debug-insert-include-summary tab)
201 (semantic-analyzer-debug-add-buttons)
204 (defun semantic-analyzer-debug-missing-innertype (ctxt idx comp)
205 "Debug why we can't find an entry for CTXT prefix at IDX for known type.
206 We need to see if we have possible completions against the entry before
207 being too vocal about it.
208 Argument COMP are possible completions here."
209 (let* ((prefixitem (nth idx (oref ctxt prefix)))
210 (prevprefix (nth (1- idx) (oref ctxt prefix)))
211 (dt (nth (1- idx) (oref ctxt prefixtypes)))
212 (desired-type (semantic-analyze-type-constraint ctxt))
213 (orig-buffer (current-buffer))
214 (ots (semantic-analyze-tag-type prevprefix
219 (when (not dt) (error "Missing Innertype debugger is confused"))
220 (with-output-to-temp-buffer (help-buffer)
221 (with-current-buffer standard-output
222 (princ "Cannot find symbol \"")
224 (princ "\" in datatype:
226 (semantic-analyzer-debug-insert-tag dt)
230 ;; Any language with a namespace.
231 ((string= (semantic-tag-type dt) "namespace")
232 (princ "Semantic may not have found all possible namespaces with
234 (princ (semantic-tag-name dt))
235 (princ ". You can debug the entire typecache, including merged namespaces
238 M-x semanticdb-typecache-dump RET")
241 ;; @todo - external declarations??
245 ;; A generic explanation
247 (princ "\nSemantic has found the datatype ")
248 (semantic-analyzer-debug-insert-tag dt)
249 (if (or (not (semantic-equivalent-tag-p ots dt))
250 (not (with-current-buffer orig-buffer
251 (car (semantic-analyze-dereference-metatype
252 ots (oref ctxt scope))))))
254 (nexttype (with-current-buffer orig-buffer
255 (car (semantic-analyze-dereference-metatype
256 ots (oref ctxt scope))))))
257 (if (eq nexttype lasttype)
258 (princ "\n [ Debugger error trying to help with metatypes ]")
261 (princ "\nwhich is a metatype")
262 (princ "\nwhich is derived from metatype ")
263 (semantic-analyzer-debug-insert-tag lasttype)))
265 (princ ".\nThe Metatype stack is:\n")
267 (semantic-analyzer-debug-insert-tag lasttype)
270 (not (eq nexttype lasttype)))
272 (semantic-analyzer-debug-insert-tag nexttype)
274 (setq lasttype nexttype
276 (with-current-buffer orig-buffer
277 (car (semantic-analyze-dereference-metatype
278 nexttype (oref ctxt scope)))))
283 "Last metatype is nil. This means that semantic cannot derive
284 the list of members because the type referred to cannot be found.\n")
287 (princ "\nand its list of members.")
291 (princ " Semantic does not know what
292 possible completions there are for \"")
294 (princ "\". Examine the known
295 members below for more."))
296 (princ " Semantic knows of some
297 possible completions for \"")
305 (semantic-analyzer-debug-show-completions comp)
307 (princ "\nKnown members of ")
308 (princ (semantic-tag-name dt))
310 (dolist (M (semantic-tag-type-members dt))
312 ;;(princ (semantic-format-tag-prototype M))
313 (semantic-analyzer-debug-insert-tag M)
316 ;; This doesn't refer to in-type completions.
317 ;;(semantic-analyzer-debug-global-miss-text prefixitem)
321 (princ "\nWhen there are known members that would make good completion
322 candidates that are not in the completion list, then the most likely
323 cause is a type constraint. Semantic has determined that there is a
324 type constraint looking for the type ")
325 (if (semantic-tag-p desired-type)
326 (semantic-analyzer-debug-insert-tag desired-type)
327 (princ (format "%S" desired-type)))
330 (semantic-analyzer-debug-add-buttons)
335 (defun semantic-analyzer-debug-test-local-context ()
336 "Test the local context parsed from the file."
337 (let* ((prefixandbounds (semantic-ctxt-current-symbol-and-bounds (point)))
338 (prefix (car prefixandbounds))
339 (bounds (nth 2 prefixandbounds))
341 (when (and (or (not prefixandbounds)
345 (with-output-to-temp-buffer (help-buffer)
346 (with-current-buffer standard-output
347 (princ "Local Context Parser Failed.
349 If this is unexpected, then there is likely a bug in the Semantic
350 local context parser.
352 Consider debugging the function ")
353 (let ((lcf (fetch-overload 'semantic-ctxt-current-symbol-and-bounds)))
355 (princ (symbol-name lcf))
356 (princ "semantic-ctxt-current-symbol-and-bounds,
357 or implementing a version specific to ")
358 (princ (symbol-name major-mode))
361 (semantic-analyzer-debug-add-buttons)
365 ;;; General Inserters with help
367 (defun semantic-analyzer-debug-show-completions (comp)
368 "Show the completion list COMP."
370 (princ "\nNo known possible completions.\n")
372 (princ "\nPossible completions are:\n")
379 (semantic-analyzer-debug-insert-tag C)))
383 (defvar semantic-dependency-system-include-path)
385 (defun semantic-analyzer-debug-insert-include-summary (table)
386 "Display a summary of includes for the semanticdb TABLE."
387 (require 'semantic/dep)
388 (semantic-fetch-tags)
389 (let ((inc (semantic-find-tags-by-class 'include table))
390 ;;(path (semanticdb-find-test-translate-path-no-loading))
392 (with-current-buffer (semanticdb-get-buffer table)
393 semanticdb-find-lost-includes))
395 (with-current-buffer (semanticdb-get-buffer table)
396 semantic-dependency-system-include-path))
398 (with-current-buffer (semanticdb-get-buffer table)
399 (and (boundp 'ede-object)
402 (with-current-buffer (semanticdb-get-buffer table)
403 (and (boundp 'ede-object-project)
404 ede-object-project))))
406 (princ "\n\nInclude Path Summary:")
408 (princ "\n\nThis file's project include search is handled by the EDE object:\n")
409 (princ " Buffer Target: ")
410 (princ (object-print edeobj))
412 (when (not (eq edeobj edeproj))
413 (princ " Buffer Project: ")
414 (princ (object-print edeproj))
417 (let ((loc (ede-get-locator-object edeproj)))
418 (princ " Backup Locator: ")
419 (princ (object-print loc))
423 (princ "\n\nThe system include path is:\n")
429 (princ "\n\nInclude Summary: ")
430 (princ (semanticdb-full-filename table))
432 (princ (format "%s contains %d includes.\n"
433 (file-name-nondirectory
434 (semanticdb-full-filename table))
441 (let* ((fileinner (semantic-dependency-tag-file i))
442 (tableinner (when fileinner
443 (semanticdb-file-table-object fileinner t))))
444 (cond ((not fileinner)
445 (setq unknown (1+ unknown)))
446 ((number-or-marker-p (oref tableinner pointmax))
449 (setq unparsed (1+ unparsed))))))
450 (setq all (+ ok unknown unparsed))
451 (when (not (= 0 all))
452 (princ (format " Unknown Includes: %d\n" unknown))
453 (princ (format " Unparsed Includes: %d\n" unparsed))
454 (princ (format " Parsed Includes: %d\n" ok)))
460 (princ "\nA likely cause of an unfound tag is missing include files.")
461 (semantic-analyzer-debug-insert-tag-list
462 "The following includes were not found" unk)
464 (princ "\nYou can fix the include path for ")
465 (princ (symbol-name (oref table major-mode)))
466 (princ " by using this function:
468 M-x semantic-customize-system-include-path RET
470 which customizes the mode specific variable for the mode-local
471 variable `semantic-dependency-system-include-path'.")
474 (princ "\n No unknown includes.\n"))
477 (defun semantic-analyzer-debug-describe-scope (ctxt &optional classconstraint)
478 "Describe the scope in CTXT for finding a global symbol.
479 Optional argument CLASSCONSTRAINT says to output to tags of that class."
480 (let* ((scope (oref ctxt :scope))
481 (parents (oref scope parents))
482 (cc (or classconstraint (oref ctxt prefixclass)))
484 (princ "\nLocal Scope Information:")
485 (princ "\n * Tag Class Constraint against SCOPE: ")
486 (princ (format "%S" classconstraint))
489 (semantic-analyzer-debug-insert-tag-list
490 " >> Known parent types with possible in scope symbols"
492 (princ "\n * No known parents in current scope."))
494 (let ((si (semantic-analyze-tags-of-class-list
495 (oref scope scope) cc))
496 (lv (semantic-analyze-tags-of-class-list
497 (oref scope localvar) cc))
500 (semantic-analyzer-debug-insert-tag-list
501 " >> Known symbols within the current scope"
503 (princ "\n * No known symbols currently in scope."))
506 (semantic-analyzer-debug-insert-tag-list
507 " >> Known symbols that are declared locally"
509 (princ "\n * No known symbols declared locally."))
514 (defun semantic-analyzer-debug-global-miss-text (name-in)
515 "Use 'princ' to show text describing not finding symbol NAME-IN.
516 NAME is the name of the unfound symbol."
517 (let ((name (cond ((stringp name-in)
519 ((semantic-tag-p name-in)
520 (semantic-format-tag-name name-in))
521 (t (format "%S" name-in)))))
522 (when (not (string= name ""))
525 (princ " is a local variable, argument, or symbol in some
526 namespace or class exposed via scoping statements, then it should
529 Debugging the scope can be done with:
530 M-x semantic-calculate-scope RET
532 If the prefix is a global symbol, in an included file, then
533 your search path may be incomplete.
538 (defun semantic-analyzer-debug-insert-tag-list (text taglist)
539 "Prefixing with TEXT, dump TAGLIST in a help buffer."
540 (princ "\n") (princ text) (princ ":\n")
544 ;;(princ (semantic-format-tag-prototype M))
545 (semantic-analyzer-debug-insert-tag M)
549 (defun semantic-analyzer-debug-insert-tag (tag &optional parent)
550 "Display a TAG by name, with possible jumpitude.
551 PARENT is a possible parent (by nesting) tag."
552 (let ((str (semantic-format-tag-prototype tag parent)))
553 (if (and (semantic-tag-with-position-p tag)
554 (semantic-tag-file-name tag))
555 (with-current-buffer standard-output
557 'mouse-face 'custom-button-pressed-face
565 (button-get button 'tag))
566 (setq buff (current-buffer))
568 (if (get-buffer-window buff)
569 (select-window (get-buffer-window buff))
570 (pop-to-buffer buff t))
572 (pulse-line-hook-function)))
579 (defvar semantic-analyzer-debug-orig nil
580 "The originating buffer for a help button.")
582 (defun semantic-analyzer-debug-add-buttons ()
583 "Add push-buttons to the *Help* buffer.
584 Look for key expressions, and add push-buttons near them."
585 (let ((orig-buffer (make-marker)))
586 (set-marker orig-buffer (point) (current-buffer))
587 ;; Get a buffer ready.
588 (with-current-buffer "*Help*"
589 (let ((inhibit-read-only t))
590 (goto-char (point-min))
591 (set (make-local-variable 'semantic-analyzer-debug-orig) orig-buffer)
592 ;; First, add do-in buttons to recommendations.
593 (while (re-search-forward "^\\s-*M-x \\(\\(\\w\\|\\s_\\)+\\) " nil t)
594 (let ((fcn (match-string 1)))
595 (when (not (fboundp (intern-soft fcn)))
596 (error "Help Err: Can't find %s" fcn))
599 (insert-button "[ Do It ]"
600 'mouse-face 'custom-button-pressed-face
602 'action `(lambda (arg)
603 (let ((M semantic-analyzer-debug-orig))
604 (set-buffer (marker-buffer M))
606 (call-interactively (quote ,(intern-soft fcn))))))))
607 ;; Do something else?
609 (set-buffer-modified-p nil))))
611 (provide 'semantic/analyze/debug)
613 ;;; semantic/analyze/debug.el ends here