1 ;;; gpr-query.el --- minor-mode for navigating sources using the
2 ;;; custom gpr_query tool, based on AdaCore cross reference tool
5 ;;; gpr-query supports Ada and any gcc language that supports the
6 ;;; AdaCore -fdump-xref switch (which includes C, C++).
8 ;;; Copyright (C) 2013, 2014 Free Software Foundation, Inc.
10 ;; Author: Stephen Leake <stephen_leake@member.fsf.org>
11 ;; Maintainer: Stephen Leake <stephen_leake@member.fsf.org>
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software: you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation, either version 3 of the License, or
19 ;; (at your option) any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 (require 'ada-mode) ;; for ada-prj-*, some other things
40 ;; gpr_query reads the project files and the database at startup,
41 ;; which is noticeably slow for a reasonably sized project. But
42 ;; running queries after startup is fast. So we leave gpr_query
43 ;; running, and send it new queries via stdin, getting responses via
46 ;; We maintain a cache of active sessions, one per gnat project.
48 (cl-defstruct (gpr-query--session)
49 (process nil) ;; running gpr_query
50 (buffer nil)) ;; receives output of gpr_query
52 (defconst gpr-query-buffer-name-prefix " *gpr_query-")
54 (defun gpr-query--start-process (session)
55 "Start the session process running gpr_query."
56 (unless (buffer-live-p (gpr-query--session-buffer session))
57 ;; user may have killed buffer
58 (setf (gpr-query--session-buffer session) (gnat-run-buffer gpr-query-buffer-name-prefix)))
60 (with-current-buffer (gpr-query--session-buffer session)
61 (let ((process-environment (ada-prj-get 'proc_env)) ;; for GPR_PROJECT_PATH
63 (project-file (file-name-nondirectory (ada-prj-get 'gpr_file))))
64 (erase-buffer); delete any previous messages, prompt
65 (setf (gpr-query--session-process session)
66 ;; gnatcoll-1.6 can't handle aggregate projects; M910-032
67 ;; gpr_query can handle some aggregate projects, but not all
68 ;; FIXME: need good error message on bad project file:
69 ;; "can't handle aggregate projects?")
70 (start-process (concat "gpr_query " (buffer-name))
71 (gpr-query--session-buffer session)
73 (concat "--project=" project-file)))
74 (set-process-query-on-exit-flag (gpr-query--session-process session) nil)
75 (gpr-query-session-wait session)
77 ;; check for warnings about invalid directories etc
78 (goto-char (point-min))
79 (when (search-forward "warning:" nil t)
80 (error "gpr_query warnings"))
83 (defun gpr-query--make-session ()
84 "Create and return a session for the current project file."
86 (make-gpr-query--session
87 :buffer (gnat-run-buffer gpr-query-buffer-name-prefix))))
88 (gpr-query--start-process session)
91 (defvar gpr-query--sessions '()
92 "Assoc list of sessions, indexed by absolute GNAT project file name.")
94 (defun gpr-query-cached-session ()
95 "Return a session for the current project file, creating it if necessary."
96 (let* ((session (cdr (assoc ada-prj-current-file gpr-query--sessions))))
99 (unless (process-live-p (gpr-query--session-process session))
100 (gpr-query--start-process session))
104 (setq session (gpr-query--make-session))
105 (setq gpr-query--sessions
106 (cl-acons ada-prj-current-file session gpr-query--sessions))))
109 (defconst gpr-query-prompt "^>>> $"
110 ;; gpr_query output ends with this
111 "Regexp matching gpr_query prompt; indicates previous command is complete.")
113 (defun gpr-query-session-wait (session)
114 "Wait for the current command to complete."
115 (unless (process-live-p (gpr-query--session-process session))
116 (gpr-query-show-buffer session)
117 (error "gpr-query process died"))
119 (with-current-buffer (gpr-query--session-buffer session)
120 (let ((process (gpr-query--session-process session))
121 (search-start (point-min))
123 (while (and (process-live-p process)
125 ;; process output is inserted before point, so move back over it to search it
126 (goto-char search-start)
127 (not (re-search-forward gpr-query-prompt (point-max) 1))))
128 (setq search-start (point));; don't search same text again
129 (message (concat "running gpr_query ..." (make-string wait-count ?.)))
130 ;; FIXME: use --display-progress
131 (accept-process-output process 1.0)
132 (setq wait-count (1+ wait-count)))
133 (if (process-live-p process)
134 (message (concat "running gpr_query ... done"))
135 (gpr-query-show-buffer session)
136 (error "gpr_query process died"))
139 (defun gpr-require-prj ()
140 "Throw error if no project file defined."
141 (unless (or (ada-prj-get 'gpr_file)
142 (ada-prj-get 'gpr_query_file))
143 (error "no gpr project file defined.")))
145 (defun gpr-query-session-send (cmd wait)
146 "Send CMD to gpr_query session for current project.
147 If WAIT is non-nil, wait for command to complete.
148 Return buffer that holds output."
150 (let ((session (gpr-query-cached-session)))
151 ;; always wait for previous command to complete; also checks for
153 (gpr-query-session-wait session)
154 (with-current-buffer (gpr-query--session-buffer session)
156 (process-send-string (gpr-query--session-process session)
159 (gpr-query-session-wait session))
163 (defun gpr-query-kill-session (session)
164 (let ((process (gpr-query--session-process session)))
165 (when (process-live-p process)
166 (process-send-string (gpr-query--session-process session) "exit\n")
167 (while (process-live-p process)
168 (accept-process-output process 1.0)))
171 (defun gpr-query-kill-all-sessions ()
174 (mapc (lambda (assoc)
175 (let ((session (cdr assoc)))
176 (when (process-live-p (gpr-query--session-process session))
177 (setq count (1+ count))
178 (process-send-string (gpr-query--session-process session) "exit\n")
181 (message "Killed %d sessions" count)
184 (defun gpr-query-show-buffer (&optional session)
185 "For `ada-show-xref-tool-buffer'; show gpr-query buffer for current project."
187 (pop-to-buffer (gpr-query--session-buffer (or session (gpr-query-cached-session)))))
191 (defun gpr-query-get-src-dirs (src-dirs)
192 "Append list of source dirs in current gpr project to SRC-DIRS.
193 Uses 'gpr_query'. Returns new list."
195 (with-current-buffer (gpr-query--session-buffer (gpr-query-cached-session))
196 (gpr-query-session-send "source_dirs" t)
197 (goto-char (point-min))
198 (while (not (looking-at gpr-query-prompt))
199 (cl-pushnew (directory-file-name
200 (buffer-substring-no-properties (point) (point-at-eol)))
201 src-dirs :test #'equal)
206 (defun gpr-query-get-prj-dirs (prj-dirs)
207 "Append list of source dirs in current gpr project to PRJ-DIRS.
208 Uses 'gpr_query'. Returns new list."
210 (with-current-buffer (gpr-query--session-buffer (gpr-query-cached-session))
211 (gpr-query-session-send "project_path" t)
212 (goto-char (point-min))
213 (while (not (looking-at gpr-query-prompt))
214 (cl-pushnew (directory-file-name
215 (buffer-substring-no-properties (point) (point-at-eol)))
216 prj-dirs :test #'equal)
221 (defconst gpr-query-ident-file-regexp
222 ;; C:\Projects\GDS\work_dscovr_release\common\1553\gds-mil_std_1553-utf.ads:252:25
223 ;; /Projects/GDS/work_dscovr_release/common/1553/gds-mil_std_1553-utf.ads:252:25
224 "\\(\\(?:.:\\\|/\\)[^:]*\\):\\([0123456789]+\\):\\([0123456789]+\\)"
226 "Regexp matching <file>:<line>:<column>")
228 (defconst gpr-query-ident-file-regexp-alist
229 (list (concat "^" gpr-query-ident-file-regexp) 1 2 3)
230 "For compilation-error-regexp-alist, matching gpr_query output")
232 (defconst gpr-query-ident-file-type-regexp
233 (concat gpr-query-ident-file-regexp " (\\(.*\\))")
234 "Regexp matching <file>:<line>:<column> (<type>)")
237 ;; in *compilation-gpr_query-refs*, run
238 ;; (progn (set-text-properties (point-min)(point-max) nil)(compilation-parse-errors (point-min)(point-max) gpr-query-ident-file-regexp-alist))
240 (defun gpr-query-compilation (identifier file line col cmd comp-err)
241 "Run gpr_query IDENTIFIER:FILE:LINE:COL CMD,
242 set compilation-mode with compilation-error-regexp-alist set to COMP-ERR."
243 ;; Useful when gpr_query will return a list of references; we use
244 ;; `compilation-start' to run gpr_query, so the user can navigate
245 ;; to each result in turn via `next-error'.
246 (let ((cmd-1 (format "%s %s:%s:%d:%d" cmd identifier file line col))
249 ;; FIXME: Code duplication with gnat-inspect-compilation!
250 (with-current-buffer (gpr-query--session-buffer (gpr-query-cached-session))
252 (setq buffer-read-only nil)
253 (set (make-local-variable 'compilation-error-regexp-alist) (list comp-err))
254 (gpr-query-session-send cmd-1 t)
255 ;; point is at EOB. gpr_query returns one line per result plus prompt
256 (setq result-count (- (line-number-at-pos) 1))
257 ;; Won't be needed in 24.5 any more.
258 (if (fboundp 'font-lock-ensure)
260 (font-lock-fontify-buffer))
261 ;; font-lock-fontify-buffer applies compilation-message text properties
262 ;; NOTE: Won't be needed in 24.5 any more, since compilation-next-error
263 ;; will apply compilation-message text properties on the fly.
264 ;; IMPROVEME: for some reason, next-error works, but the font
265 ;; colors are not right (no koolaid!)
266 (goto-char (point-min))
268 (cl-case result-count
270 (error "gpr_query returned no results"))
272 (when (looking-at "^Error: entity not found")
273 (error (buffer-substring-no-properties (line-beginning-position) (line-end-position))))
275 ;; just go there, don't display session-buffer. We have to
276 ;; fetch the compilation-message while in the session-buffer.
277 (let* ((msg (compilation-next-error 0 nil (point-min)))
278 ;; FIXME: Woah! This is messing with very internal details!
279 (loc (compilation--message->loc msg)))
280 (setq file (caar (compilation--loc->file-struct loc))
281 line (caar (cddr (compilation--loc->file-struct loc)))
282 column (1- (compilation--loc->col loc)))
286 ;; for next-error, below
287 (setq next-error-last-buffer (current-buffer)))
289 ));; case, with-currrent-buffer
291 (if (> result-count 1)
292 ;; more than one result; display session buffer, goto first ref
294 ;; compilation-next-error-function assumes there is not an error
295 ;; at point-min; work around that by moving forward 0 errors for
296 ;; the first one. Unless the first line contains "warning: ".
297 (if (looking-at "^warning: ")
301 ;; just one result; go there
302 (ada-goto-source file line column nil))
305 (defun gpr-query-dist (found-line line found-col col)
306 "Return distance between FOUND-LINE FOUND-COL and LINE COL."
307 (+ (abs (- found-col col))
308 (* (abs (- found-line line)) 250)))
310 ;;;;; user interface functions
312 (defun gpr-query-show-references ()
313 "Show all references of identifier at point."
316 (thing-at-point 'symbol)
317 (file-name-nondirectory (buffer-file-name))
319 (1+ (current-column)))
322 (defun gpr-query-overridden (other-window)
323 "Move to the overridden declaration of the identifier around point.
324 If OTHER-WINDOW (set by interactive prefix) is non-nil, show the
325 buffer in another window."
329 (gpr-query-overridden-1
330 (thing-at-point 'symbol)
334 (goto-char (car (bounds-of-thing-at-point 'symbol)))
335 (1+ (current-column)))
338 (ada-goto-source (nth 0 target)
344 (defun gpr-query-goto-declaration (other-window)
345 "Move to the declaration or body of the identifier around point.
346 If at the declaration, go to the body, and vice versa. If at a
347 reference, goto the declaration.
349 If OTHER-WINDOW (set by interactive prefix) is non-nil, show the
350 buffer in another window."
355 (thing-at-point 'symbol)
359 (goto-char (car (bounds-of-thing-at-point 'symbol)))
360 (1+ (current-column)))
363 (ada-goto-source (nth 0 target)
369 (defvar gpr-query-map
370 (let ((map (make-sparse-keymap)))
371 ;; C-c C-i prefix for gpr-query minor mode
373 (define-key map "\C-c\C-i\C-d" 'gpr-query-goto-declaration)
374 (define-key map "\C-c\C-i\C-p" 'ada-build-prompt-select-prj-file)
375 (define-key map "\C-c\C-i\C-q" 'gpr-query-refresh)
376 (define-key map "\C-c\C-i\C-r" 'gpr-query-show-references)
377 ;; FIXME: (define-key map "\C-c\M-d" 'gpr-query-parents)
380 ) "Local keymap used for GNAT inspect minor mode.")
382 (defvar gpr-query-menu (make-sparse-keymap "gpr-query"))
383 (easy-menu-define gpr-query-menu gpr-query-map "Menu keymap for gpr-query minor mode"
385 ["Find and select project ..." ada-build-prompt-select-prj-file t]
386 ["Select project ..." ada-prj-select t]
387 ["Show current project" ada-prj-show t]
388 ["Show gpr-query buffer" gpr-query-show-buffer t]
389 ["Next compilation error" next-error t]
390 ["Show secondary error" ada-show-secondary-error t]
391 ["Goto declaration/body" gpr-query-goto-declaration t]
392 ["Show parent declarations" ada-show-declaration-parents t]
393 ["Show references" gpr-query-show-references t]
394 ;; ["Show overriding" gpr-query-show-overriding t]
395 ;; ["Show overridden" gpr-query-show-overridden t]
396 ["Refresh cross reference cache" gpr-query-refresh t]
399 (define-minor-mode gpr-query
400 "Minor mode for navigating sources using GNAT cross reference tool.
401 Enable mode if ARG is positive"
403 :lighter " gpr-query" ;; mode line
405 ;; just enable the menu and keymap
408 ;;;;; support for Ada mode
410 (defun gpr-query-refresh ()
411 "For `ada-xref-refresh-function', using gpr_query."
413 ;; need to kill session to get changed env vars etc
414 (let ((session (gpr-query-cached-session)))
415 (gpr-query-kill-session session)
416 (gpr-query--start-process session)))
418 (defun gpr-query-other (identifier file line col)
419 "For `ada-xref-other-function', using gpr_query."
420 (when (eq ?\" (aref identifier 0))
421 ;; gpr_query wants the quotes stripped
423 (setq identifier (substring identifier 1 (1- (length identifier))))
426 (when (eq system-type 'windows-nt)
427 ;; Since Windows file system is case insensitive, GNAT and Emacs
428 ;; can disagree on the case, so convert all to lowercase.
429 (setq file (downcase file)))
431 (let ((cmd (format "refs %s:%s:%d:%d" identifier (file-name-nondirectory file) line col))
435 (min-distance (1- (expt 2 29)))
438 (with-current-buffer (gpr-query-session-send cmd t)
439 ;; 'gpr_query refs' returns a list containing the declaration,
440 ;; the body, and all the references, in no particular order.
442 ;; We search the list, looking for the input location,
443 ;; declaration and body, then return the declaration or body as
446 ;; the format of each line is file:line:column (type)
452 ;; full declaration (for a private type)
453 ;; implicit reference
457 ;; Module_Type:/home/Projects/GDS/work_stephe_2/common/1553/gds-hardware-bus_1553-wrapper.ads:171:9 (full declaration)
459 ;; itc_assert:/home/Projects/GDS/work_stephe_2/common/itc/opsim/itc_dscovr_gdsi/Gds1553/src/Gds1553.cpp:830:9 (reference)
461 (message "parsing result ...")
463 (goto-char (point-min))
467 ((looking-at gpr-query-ident-file-type-regexp)
469 (let* ((found-file (match-string 1))
470 (found-line (string-to-number (match-string 2)))
471 (found-col (string-to-number (match-string 3)))
472 (found-type (match-string 4))
473 (dist (gpr-query-dist found-line line found-col col))
476 (when (eq system-type 'windows-nt)
477 ;; 'expand-file-name' converts Windows directory
478 ;; separators to normal Emacs. Since Windows file
479 ;; system is case insensitive, GNAT and Emacs can
480 ;; disagree on the case, so convert all to lowercase.
481 (setq found-file (downcase (expand-file-name found-file))))
483 (when (string-equal found-type "declaration")
484 (setq decl-loc (list found-file found-line (1- found-col))))
487 (string-equal found-type "body")
488 (string-equal found-type "full declaration"))
489 (setq body-loc (list found-file found-line (1- found-col))))
492 ;; The source may have changed since the xref database
493 ;; was computed, so allow for fuzzy matches.
494 (and (equal found-file file)
495 (< dist min-distance))
496 (setq min-distance dist)
497 (setq search-type found-type))
502 ;; This skips GPR_PROJECT_PATH and echoed command at start of buffer.
504 ;; It also skips warning lines. For example,
505 ;; gnatcoll-1.6w-20130902 can't handle the Auto_Text_IO
506 ;; language, because it doesn't use the gprconfig
507 ;; configuration project. That gives lines like:
509 ;; common_text_io.gpr:15:07: language unknown for "gds-hardware-bus_1553-time_tone.ads"
511 ;; There are probably other warnings that might be reported as well.
522 (string-equal search-type "declaration")
524 (setq result body-loc))
527 (setq result decl-loc))
531 (error "gpr_query did not return other item; refresh?"))
533 (message "parsing result ... done")
536 (defun gpr-query-all (identifier file line col)
537 "For `ada-xref-all-function', using gpr_query."
538 (gpr-query-compilation identifier file line col "refs" 'gpr-query-ident-file))
540 (defun gpr-query-parents (identifier file line col)
541 "For `ada-xref-parent-function', using gpr_query."
542 (gpr-query-compilation identifier file line col "parent_types" 'gpr-query-ident-file))
544 (defun gpr-query-overriding (identifier file line col)
545 "For `ada-xref-overriding-function', using gpr_query."
546 (gpr-query-compilation identifier file line col "overriding" 'gpr-query-ident-file))
548 (defun gpr-query-overridden-1 (identifier file line col)
549 "For `ada-xref-overridden-function', using gpr_query."
550 (when (eq ?\" (aref identifier 0))
551 ;; gpr_query wants the quotes stripped
553 (setq identifier (substring identifier 1 (1- (length identifier))))
556 (let ((cmd (format "overridden %s:%s:%d:%d" identifier (file-name-nondirectory file) line col))
558 (with-current-buffer (gpr-query-session-send cmd t)
560 (goto-char (point-min))
561 (when (looking-at gpr-query-ident-file-regexp)
565 (string-to-number (match-string 2))
566 (string-to-number (match-string 3)))))
569 (error "gpr_query did not return a result; refresh?"))
571 (message "parsing result ... done")
574 (defun ada-gpr-query-select-prj ()
575 (setq ada-file-name-from-ada-name 'ada-gnat-file-name-from-ada-name)
576 (setq ada-ada-name-from-file-name 'ada-gnat-ada-name-from-file-name)
577 (setq ada-make-package-body 'ada-gnat-make-package-body)
579 (add-hook 'ada-syntax-propertize-hook 'gnatprep-syntax-propertize)
581 ;; must be after indentation engine setup, because that resets the
582 ;; indent function list.
583 (add-hook 'ada-mode-hook 'ada-gpr-query-setup t)
585 (setq ada-xref-refresh-function 'gpr-query-refresh)
586 (setq ada-xref-all-function 'gpr-query-all)
587 (setq ada-xref-other-function 'gpr-query-other)
588 (setq ada-xref-parent-function 'gpr-query-parents)
589 (setq ada-xref-all-function 'gpr-query-all)
590 (setq ada-xref-overriding-function 'gpr-query-overriding)
591 (setq ada-xref-overridden-function 'gpr-query-overridden-1)
592 (setq ada-show-xref-tool-buffer 'gpr-query-show-buffer)
594 (add-to-list 'completion-ignored-extensions ".ali") ;; gnat library files, used for cross reference
597 (defun ada-gpr-query-deselect-prj ()
598 (setq ada-file-name-from-ada-name nil)
599 (setq ada-ada-name-from-file-name nil)
600 (setq ada-make-package-body nil)
602 (setq ada-syntax-propertize-hook (delq 'gnatprep-syntax-propertize ada-syntax-propertize-hook))
603 (setq ada-mode-hook (delq 'ada-gpr-query-setup ada-mode-hook))
605 (setq ada-xref-other-function nil)
606 (setq ada-xref-parent-function nil)
607 (setq ada-xref-all-function nil)
608 (setq ada-xref-overriding-function nil)
609 (setq ada-xref-overridden-function nil)
610 (setq ada-show-xref-tool-buffer nil)
612 (setq completion-ignored-extensions (delete ".ali" completion-ignored-extensions))
615 (defun ada-gpr-query-setup ()
616 (when (boundp 'wisi-indent-calculate-functions)
617 (add-to-list 'wisi-indent-calculate-functions 'gnatprep-indent))
620 (defun ada-gpr-query ()
621 "Set Ada mode global vars to use gpr_query."
622 (add-to-list 'ada-prj-parser-alist '("gpr" . gnat-parse-gpr))
623 (add-to-list 'ada-select-prj-xref-tool '(gpr_query . ada-gpr-query-select-prj))
624 (add-to-list 'ada-deselect-prj-xref-tool '(gpr_query . ada-gpr-query-deselect-prj))
628 (font-lock-add-keywords 'ada-mode
629 ;; gnatprep preprocessor line
630 (list (list "^[ \t]*\\(#.*\n\\)" '(1 font-lock-type-face t))))
634 (provide 'ada-xref-tool)
636 (add-to-list 'compilation-error-regexp-alist-alist
637 (cons 'gpr-query-ident-file gpr-query-ident-file-regexp-alist))
639 (unless (and (boundp 'ada-xref-tool)
640 (default-value 'ada-xref-tool))
641 (setq ada-xref-tool 'gpr_query))