1 ;;; gnat-inspect.el --- minor-mode for navigating sources using the
2 ;;; AdaCore cross reference tool gnatinspect.
4 ;;; gnatinspect supports Ada and any gcc language that supports the
5 ;;; -fdump-xref switch (which includes C, C++).
7 ;;; Copyright (C) 2013, 2014 Free Software Foundation, Inc.
9 ;; Author: Stephen Leake <stephen_leake@member.fsf.org>
10 ;; Maintainer: Stephen Leake <stephen_leake@member.fsf.org>
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 (require 'ada-mode) ;; for ada-prj-*, some other things
38 ;; gnatinspect reads the project files and the database at startup,
39 ;; which is noticeably slow for a reasonably sized project. But
40 ;; running queries after startup is fast. So we leave gnatinspect
41 ;; running, and send it new queries via stdin, getting responses via
44 ;; We maintain a cache of active sessions, one per gnat project.
46 (cl-defstruct (gnat-inspect--session)
47 (process nil) ;; running gnatinspect
48 (buffer nil) ;; receives output of gnatinspect
52 (defconst gnat-inspect-buffer-name-prefix " *gnatinspect-")
54 (defun gnat-inspect--start-process (session)
55 "Start the session process running gnatinspect."
56 (unless (buffer-live-p (gnat-inspect--session-buffer session))
57 ;; user may have killed buffer
58 (setf (gnat-inspect--session-buffer session) (gnat-run-buffer gnat-inspect-buffer-name-prefix)))
60 (with-current-buffer (gnat-inspect--session-buffer session)
61 (let ((process-environment (ada-prj-get 'proc_env)) ;; for GPR_PROJECT_PATH
63 ;; WORKAROUND: gnatinspect from gnatcoll-1.6w-20130902 can't handle aggregate projects; M910-032
64 (project-file (file-name-nondirectory
65 (ada-prj-get 'gpr_file))))
66 (erase-buffer); delete any previous messages, prompt
67 (setf (gnat-inspect--session-process session)
68 ;; FIXME: need good error message on bad project file:
69 ;; "can't handle aggregate projects?")
70 (start-process (concat "gnatinspect " (buffer-name))
71 (gnat-inspect--session-buffer session)
73 (concat "--project=" project-file)))
74 (set-process-query-on-exit-flag (gnat-inspect--session-process session) nil)
75 (gnat-inspect-session-wait session)
78 (defun gnat-inspect--make-session ()
79 "Create and return a session for the current project file."
81 (make-gnat-inspect--session
82 :buffer (gnat-run-buffer gnat-inspect-buffer-name-prefix))))
83 (gnat-inspect--start-process session)
86 (defvar gnat-inspect--sessions '()
87 "Assoc list of sessions, indexed by absolute GNAT project file name.")
89 (defun gnat-inspect-cached-session ()
90 "Return a session for the current project file, creating it if necessary."
91 (gnat-inspect-ensure-gpr)
93 (let* ((session (cdr (assoc ada-prj-current-file gnat-inspect--sessions))))
96 (unless (process-live-p (gnat-inspect--session-process session))
97 (gnat-inspect--start-process session))
101 (setq session (gnat-inspect--make-session))
102 (setq gnat-inspect--sessions
103 (cl-acons ada-prj-current-file session gnat-inspect--sessions))))
106 (defun gnat-inspect-show-session-buffer ()
108 (pop-to-buffer (gnat-inspect-cached-session)))
110 (defconst gnat-inspect-prompt "^>>> $"
111 ;; gnatinspect output ends with this
112 "Regexp matching gnatinspect prompt; indicates previous command is complete.")
114 (defun gnat-inspect-session-wait (session)
115 "Wait for the current command to complete."
116 (unless (process-live-p (gnat-inspect--session-process session))
117 (error "gnatinspect process failed"))
119 (with-current-buffer (gnat-inspect--session-buffer session)
120 (let ((process (gnat-inspect--session-process session))
121 (search-start (point-min))
124 ;; process output is inserted before point, so move back over it to search it
125 (goto-char search-start)
126 (not (re-search-forward gnat-inspect-prompt (point-max) 1)));; don't search same text again
127 (setq search-start (point))
128 (message (concat "running gnatinspect ..." (make-string wait-count ?.)))
129 (accept-process-output process 1.0)
130 (setq wait-count (1+ wait-count)))
131 (message (concat "running gnatinspect ... done"))
134 (defun gnat-inspect-session-send (cmd wait)
135 "Send CMD to gnatinspect session for current project.
136 If WAIT is non-nil, wait for command to complete.
137 Return buffer that holds output."
138 (let ((session (gnat-inspect-cached-session)))
139 (with-current-buffer (gnat-inspect--session-buffer session)
141 (process-send-string (gnat-inspect--session-process session)
144 (gnat-inspect-session-wait session))
148 (defun gnat-inspect-kill-all-sessions ()
151 (mapc (lambda (assoc)
152 (let ((session (cdr assoc)))
153 (when (process-live-p (gnat-inspect--session-process session))
154 (setq count (1+ count))
155 (process-send-string (gnat-inspect--session-process session) "exit\n")
157 gnat-inspect--sessions)
158 (message "Killed %d sessions" count)
163 (defun gnat-inspect-ensure-gpr ()
164 (unless (ada-prj-get 'gpr_file)
165 (error "no gpr file specified")))
167 (defconst gnat-inspect-ident-file-regexp
168 ;; Write_Message:C:\Projects\GDS\work_dscovr_release\common\1553\gds-mil_std_1553-utf.ads:252:25
169 ;; Write_Message:/Projects/GDS/work_dscovr_release/common/1553/gds-mil_std_1553-utf.ads:252:25
170 "\\([^:]*\\):\\(\\(?:.:\\\|/\\)[^:]*\\):\\([0123456789]+\\):\\([0123456789]+\\)"
171 "Regexp matching <identifier>:<file>:<line>:<column>")
173 (defconst gnat-inspect-ident-file-regexp-alist
174 (list (concat "^" gnat-inspect-ident-file-regexp) 2 3 4)
175 "For compilation-error-regexp-alist, matching `gnatinspect overriding_recursive' output")
177 (defconst gnat-inspect-ident-file-type-regexp
178 (concat gnat-inspect-ident-file-regexp " (\\(.*\\))")
179 "Regexp matching <identifier>:<file>:<line>:<column> (<type>)")
181 (defconst gnat-inspect-ident-file-scope-regexp-alist
182 ;; RX_Enable:C:\common\1553\gds-hardware-bus_1553-raw_read_write.adb:163:13 (write reference) scope=New_Packet_TX:C:\common\1553\gds-hardware-bus_1553-raw_read_write.adb:97:14
185 gnat-inspect-ident-file-regexp
188 gnat-inspect-ident-file-regexp
190 2 3 4;; file line column
193 ;; (list 4 'gnat-inspect-scope-secondary-error)
195 "For compilation-error-regexp-alist, matching `gnatinspect refs' output")
198 ;; in *compilation-gnatinspect-refs*, run
199 ;; (progn (set-text-properties (point-min)(point-max) nil)(compilation-parse-errors (point-min)(point-max) gnat-inspect-ident-file-scope-regexp-alist))
201 (defun gnat-inspect-compilation (identifier file line col cmd comp-err)
202 "Run gnatinspect IDENTIFIER:FILE:LINE:COL CMD,
203 set compilation-mode with compilation-error-regexp-alist set to COMP-ERR."
204 (gnat-inspect-ensure-gpr)
206 (let ((cmd-1 (format "%s %s:%s:%d:%d" cmd identifier file line col))
209 (with-current-buffer (gnat-inspect--session-buffer (gnat-inspect-cached-session))
211 (setq buffer-read-only nil)
212 (set (make-local-variable 'compilation-error-regexp-alist) (list comp-err))
213 (gnat-inspect-session-send cmd-1 t)
214 ;; at EOB. gnatinspect returns one line per result
215 (setq result-count (- (line-number-at-pos) 1))
216 (if (fboundp 'font-lock-ensure)
218 (font-lock-fontify-buffer))
219 ;; font-lock-fontify-buffer applies compilation-message text properties
220 ;; NOTE: Won't be needed in 24.5 any more, since compilation-next-error
221 ;; will apply compilation-message text properties on the fly.
222 ;; IMPROVEME: for some reason, next-error works, but the font
223 ;; colors are not right (no koolaid!)
224 (goto-char (point-min))
226 (cl-case result-count
228 (error "gnatinspect returned no results"))
230 ;; just go there, don't display session-buffer. We have to
231 ;; fetch the compilation-message while in the session-buffer.
232 (let* ((msg (compilation-next-error 0 nil (point-min)))
233 ;; FIXME: Woah! This is messing with very internal details!
234 (loc (compilation--message->loc msg)))
235 (setq file (caar (compilation--loc->file-struct loc))
236 line (caar (cddr (compilation--loc->file-struct loc)))
237 column (1- (compilation--loc->col loc)))
240 ));; case, with-currrent-buffer
242 ;; compilation-next-error-function assumes there is not at error
243 ;; at point-min; work around that by moving forward 0 errors for
245 (if (> result-count 1)
246 ;; more than one result; display session buffer
248 ;; else don't display
249 (ada-goto-source file line column nil))
252 (defun gnat-inspect-dist (found-line line found-col col)
253 "Return non-nil if found-line, -col is closer to line, col than min-distance."
254 (+ (abs (- found-line line))
255 (* (abs (- found-col col)) 250)))
257 ;;;;; user interface functions
259 (defun gnat-inspect-refresh ()
260 "For `ada-xref-refresh-function', using gnatinspect."
262 (gnat-inspect-session-send "refresh" t))
264 (defun gnat-inspect-other (identifier file line col)
265 "For `ada-xref-other-function', using gnatinspect."
266 (when (eq ?\" (aref identifier 0))
267 ;; gnatinspect wants the quotes stripped
269 (setq identifier (substring identifier 1 (1- (length identifier))))
272 (let ((cmd (format "refs %s:%s:%d:%d" identifier (file-name-nondirectory file) line col))
276 (min-distance (1- (expt 2 29)))
279 (with-current-buffer (gnat-inspect-session-send cmd t)
280 ;; 'gnatinspect refs' returns a list containing the declaration,
281 ;; the body, and all the references, in no particular order.
283 ;; We search the list, looking for the input location,
284 ;; declaration and body, then return the declaration or body as
287 ;; the format of each line is name:file:line:column (type) scope=name:file:line:column
293 ;; full declaration (for a private type)
294 ;; implicit reference
298 ;; Module_Type:/home/Projects/GDS/work_stephe_2/common/1553/gds-hardware-bus_1553-wrapper.ads:171:9 (full declaration) scope=Wrapper:/home/Projects/GDS/work_stephe_2/common/1553/gds-hardware-bus_1553-wrapper.ads:49:31
300 ;; itc_assert:/home/Projects/GDS/work_stephe_2/common/itc/opsim/itc_dscovr_gdsi/Gds1553/src/Gds1553.cpp:830:9 (reference) scope=Gds1553WriteSubaddress:/home/Projects/GDS/work_stephe_2/common/itc/opsim/itc_dscovr_gdsi/Gds1553/inc/Gds1553.hpp:173:24
302 (message "parsing result ...")
304 (goto-char (point-min))
308 ((looking-at gnat-inspect-ident-file-type-regexp)
310 (let* ((found-file (expand-file-name (match-string 2)));; converts Windows to normal
311 (found-line (string-to-number (match-string 3)))
312 (found-col (string-to-number (match-string 4)))
313 (found-type (match-string 5))
314 (dist (gnat-inspect-dist found-line line found-col col))
317 (when (string-equal found-type "declaration")
318 (setq decl-loc (list found-file found-line (1- found-col))))
321 (string-equal found-type "body")
322 (string-equal found-type "full declaration"))
323 (setq body-loc (list found-file found-line (1- found-col))))
326 ;; In general, we don't know where in the gnatinspect
327 ;; output the search item occurs, so we search for it.
329 ;; We use the same distance algorithm as gnatinspect
330 ;; to allow a fuzzy match on edited code.
331 (and (equal found-file file)
332 (< dist min-distance))
333 (setq min-distance dist)
334 (setq search-type found-type))
339 ;; This skips GPR_PROJECT_PATH and echoed command at start of buffer.
341 ;; It also skips warning lines. For example,
342 ;; gnatcoll-1.6w-20130902 can't handle the Auto_Text_IO
343 ;; language, because it doesn't use the gprconfig
344 ;; configuration project. That gives lines like:
346 ;; common_text_io.gpr:15:07: language unknown for "gds-hardware-bus_1553-time_tone.ads"
348 ;; There are probably other warnings that might be reported as well.
356 (error "gnatinspect did not return other item; refresh?"))
359 (string-equal search-type "declaration")
361 (setq result body-loc))
364 (setq result decl-loc))
368 (error "gnatinspect did not return other item; refresh?"))
370 (message "parsing result ... done")
373 (defun gnat-inspect-all (identifier file line col)
374 "For `ada-xref-all-function', using gnatinspect."
375 ;; This will in general return a list of references, so we use
376 ;; `compilation-start' to run gnatinspect, so the user can navigate
377 ;; to each result in turn via `next-error'.
378 (gnat-inspect-compilation identifier file line col "refs" 'gnat-inspect-ident-file))
380 (defun gnat-inspect-parents (identifier file line col)
381 "For `ada-xref-parent-function', using gnatinspect."
382 (gnat-inspect-compilation identifier file line col "parent_types" 'gnat-inspect-ident-file))
384 (defun gnat-inspect-overriding (identifier file line col)
385 "For `ada-xref-overriding-function', using gnatinspect."
386 (gnat-inspect-compilation identifier file line col "overridden_recursive" 'gnat-inspect-ident-file))
388 (defun gnat-inspect-overridden-1 (identifier file line col)
389 "For `ada-xref-overridden-function', using gnatinspect."
390 (unless (ada-prj-get 'gpr_file)
391 (error "no gnat project file defined."))
393 (when (eq ?\" (aref identifier 0))
394 ;; gnatinspect wants the quotes stripped
396 (setq identifier (substring identifier 1 (1- (length identifier))))
399 (let ((cmd (format "overrides %s:%s:%d:%d" identifier (file-name-nondirectory file) line col))
401 (with-current-buffer (gnat-inspect-session-send cmd t)
403 (goto-char (point-min))
404 (when (looking-at gnat-inspect-ident-file-regexp)
408 (string-to-number (match-string 3))
409 (string-to-number (match-string 4)))))
412 (error "gnatinspect did not return other item; refresh?"))
414 (message "parsing result ... done")
417 (defun gnat-inspect-overridden (other-window)
418 "Move to the overridden declaration of the identifier around point.
419 If OTHER-WINDOW (set by interactive prefix) is non-nil, show the
420 buffer in another window."
424 (gnat-inspect-overridden-1
425 (thing-at-point 'symbol)
429 (goto-char (car (bounds-of-thing-at-point 'symbol)))
430 (1+ (current-column)))
433 (ada-goto-source (nth 0 target)
439 (defun gnat-inspect-goto-declaration (other-window)
440 "Move to the declaration or body of the identifier around point.
441 If at the declaration, go to the body, and vice versa. If at a
442 reference, goto the declaration.
444 If OTHER-WINDOW (set by interactive prefix) is non-nil, show the
445 buffer in another window."
450 (thing-at-point 'symbol)
454 (goto-char (car (bounds-of-thing-at-point 'symbol)))
455 (1+ (current-column)))
458 (ada-goto-source (nth 0 target)
464 (defvar gnat-inspect-map
465 (let ((map (make-sparse-keymap)))
466 ;; C-c C-i prefix for gnat-inspect minor mode
468 (define-key map "\C-c\C-i\C-d" 'gnat-inspect-goto-declaration)
469 (define-key map "\C-c\C-i\C-p" 'ada-build-prompt-select-prj-file)
470 (define-key map "\C-c\C-i\C-q" 'gnat-inspect-refresh)
471 (define-key map "\C-c\C-i\C-r" 'gnat-inspect-all)
473 ) "Local keymap used for GNAT inspect minor mode.")
475 (defvar gnat-inspect-menu (make-sparse-keymap "gnat-inspect"))
476 (easy-menu-define gnat-inspect-menu gnat-inspect-map "Menu keymap for gnat-inspect minor mode"
478 ["Find and select project ..." ada-build-prompt-select-prj-file t]
479 ["Select project ..." ada-prj-select t]
480 ["Show current project" ada-prj-show t]
481 ["Next compilation error" next-error t]
482 ["Show secondary error" ada-show-secondary-error t]
483 ["Refresh cross reference cache" gnat-inspect-refresh t]
486 (define-minor-mode gnat-inspect
487 "Minor mode for navigating sources using GNAT cross reference tool.
488 Enable mode if ARG is positive"
490 :lighter " gnat-inspect" ;; mode line
492 ;; just enable the menu and keymap
495 ;;;;; support for Ada mode
497 (defun ada-gnat-inspect-select-prj ()
498 (setq ada-file-name-from-ada-name 'ada-gnat-file-name-from-ada-name)
499 (setq ada-ada-name-from-file-name 'ada-gnat-ada-name-from-file-name)
500 (setq ada-make-package-body 'ada-gnat-make-package-body)
502 (add-hook 'ada-syntax-propertize-hook 'gnatprep-syntax-propertize)
504 ;; must be after indentation engine setup, because that resets the
505 ;; indent function list.
506 (add-hook 'ada-mode-hook 'ada-gnat-inspect-setup t)
508 (setq ada-xref-refresh-function 'gnat-inspect-refresh)
509 (setq ada-xref-all-function 'gnat-inspect-all)
510 (setq ada-xref-other-function 'gnat-inspect-other)
511 (setq ada-xref-parent-function 'gnat-inspect-parents)
512 (setq ada-xref-all-function 'gnat-inspect-all)
513 (setq ada-xref-overriding-function 'gnat-inspect-overriding)
514 (setq ada-xref-overridden-function 'gnat-inspect-overridden-1)
515 (setq ada-show-xref-tool-buffer 'gnat-inspect-show-session-buffer)
517 (add-to-list 'completion-ignored-extensions ".ali") ;; gnat library files, used for cross reference
520 (defun ada-gnat-inspect-deselect-prj ()
521 (setq ada-file-name-from-ada-name nil)
522 (setq ada-ada-name-from-file-name nil)
523 (setq ada-make-package-body nil)
525 (setq ada-syntax-propertize-hook (delq 'gnatprep-syntax-propertize ada-syntax-propertize-hook))
526 (setq ada-mode-hook (delq 'ada-gnat-inspect-setup ada-mode-hook))
528 (setq ada-xref-other-function nil)
529 (setq ada-xref-parent-function nil)
530 (setq ada-xref-all-function nil)
531 (setq ada-xref-overriding-function nil)
532 (setq ada-xref-overridden-function nil)
533 (setq ada-show-xref-tool-buffer nil)
535 (setq completion-ignored-extensions (delete ".ali" completion-ignored-extensions))
538 (defun ada-gnat-inspect-setup ()
539 (when (boundp 'wisi-indent-calculate-functions)
540 (add-to-list 'wisi-indent-calculate-functions 'gnatprep-indent))
543 (defun ada-gnat-inspect ()
544 "Set Ada mode global vars to use gnatinspect."
545 (add-to-list 'ada-prj-parser-alist '("gpr" . gnat-parse-gpr))
546 (add-to-list 'ada-select-prj-xref-tool '(gnat_inspect . ada-gnat-inspect-select-prj))
547 (add-to-list 'ada-deselect-prj-xref-tool '(gnat_inspect . ada-gnat-inspect-deselect-prj))
551 (font-lock-add-keywords 'ada-mode
552 ;; gnatprep preprocessor line
553 (list (list "^[ \t]*\\(#.*\n\\)" '(1 font-lock-type-face t))))
555 (add-hook 'ada-gnat-fix-error-hook 'ada-gnat-fix-error)
558 (provide 'gnat-inspect)
559 (provide 'ada-xref-tool)
561 (add-to-list 'compilation-error-regexp-alist-alist
562 (cons 'gnat-inspect-ident-file gnat-inspect-ident-file-regexp-alist))
563 (add-to-list 'compilation-error-regexp-alist-alist
564 (cons 'gnat-inspect-ident-file-scope gnat-inspect-ident-file-scope-regexp-alist))
566 (unless (and (boundp 'ada-xref-tool)
567 (default-value 'ada-xref-tool))
568 (setq ada-xref-tool 'gnat_inspect))