Commit | Line | Data |
---|---|---|
666fd2cc CY |
1 | ;;; cedet-cscope.el --- CScope support for CEDET |
2 | ||
ba318903 | 3 | ;;; Copyright (C) 2009-2014 Free Software Foundation, Inc. |
666fd2cc CY |
4 | |
5 | ;; Author: Eric M. Ludlam <zappo@gnu.org> | |
bd78fa1d | 6 | ;; Package: cedet |
666fd2cc CY |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
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. | |
14 | ||
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. | |
19 | ||
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/>. | |
22 | ||
23 | ;;; Commentary: | |
24 | ;; | |
25 | ;; Support using CScope for symbol lookups. | |
26 | ||
27 | ;;; Code: | |
28 | ||
29 | (declare-function inversion-check-version "inversion") | |
30 | ||
62a81506 | 31 | (defvar cedet-cscope-min-version "15.7" |
666fd2cc CY |
32 | "Minimum version of CScope required.") |
33 | ||
34 | (defcustom cedet-cscope-command "cscope" | |
35 | "Command name for the CScope executable." | |
36 | :type 'string | |
37 | :group 'cedet) | |
38 | ||
39 | (defun cedet-cscope-search (searchtext texttype type scope) | |
40 | "Perform a search with CScope, return the created buffer. | |
41 | SEARCHTEXT is text to find. | |
42 | TEXTTYPE is the type of text, such as 'regexp, 'string, 'tagname, | |
43 | 'tagregexp, or 'tagcompletions. | |
44 | TYPE is the type of search, meaning that SEARCHTEXT is compared to | |
45 | filename, tagname (tags table), references (uses of a tag) , or | |
46 | symbol (uses of something not in the tag table.) | |
47 | SCOPE is the scope of the search, such as 'project or 'subdirs." | |
48 | ;; CScope is an interactive program. It uses number flags | |
49 | ;; in order to perform command line searches. Useful for this | |
50 | ;; tool are: | |
51 | ;; | |
52 | ;; -0 = Find C symbol | |
53 | ;; -1 = Find global definition | |
54 | ;; -3 = Find references | |
55 | ;; -6 = Find egrep pattern | |
56 | ;; -7 = Find file | |
57 | (let ((idx (cond ((eq type 'file) | |
58 | "-7") | |
59 | ;; Non files are symbols and such | |
60 | ((eq texttype 'tagname) | |
61 | "-1") | |
62 | ((eq texttype 'tagregexp) | |
63 | "-0") | |
64 | ((eq texttype 'tagcompletions) | |
65 | (setq searchtext (concat "^" searchtext ".*")) | |
66 | "-1") | |
67 | ((eq texttype 'regexp) | |
68 | "-5") | |
69 | (t | |
70 | "-3") | |
71 | ) | |
72 | ) | |
73 | ) | |
74 | (cedet-cscope-call (list "-d" "-L" idx searchtext)))) | |
75 | ||
cb85c0d8 EL |
76 | (defun cedet-cscope-create (flags) |
77 | "Create a CScope database at the current directory. | |
78 | FLAGS are additional flags to pass to cscope beyond the | |
79 | options -cR." | |
80 | (cedet-cscope-call (append (list "-cR") flags))) | |
81 | ||
666fd2cc CY |
82 | (defun cedet-cscope-call (flags) |
83 | "Call CScope with the list of FLAGS." | |
84 | (let ((b (get-buffer-create "*CEDET CScope*")) | |
85 | (cd default-directory) | |
86 | ) | |
0816d744 | 87 | (with-current-buffer b |
666fd2cc CY |
88 | (setq default-directory cd) |
89 | (erase-buffer)) | |
90 | (apply 'call-process cedet-cscope-command | |
91 | nil b nil | |
92 | flags) | |
93 | b)) | |
94 | ||
95 | (defun cedet-cscope-expand-filename (filename) | |
96 | "Expand the FILENAME with CScope. | |
97 | Return a fully qualified filename." | |
98 | (interactive "sFile: ") | |
0816d744 SM |
99 | (let* ((ans1 (with-current-buffer |
100 | (cedet-cscope-call (list "-d" "-L" "-7" filename)) | |
666fd2cc CY |
101 | (goto-char (point-min)) |
102 | (if (looking-at "[^ \n]*cscope: ") | |
103 | (error "CScope not available") | |
104 | (split-string (buffer-string) "\n" t)))) | |
105 | (ans2 (mapcar (lambda (hit) | |
106 | (expand-file-name (car (split-string hit " ")))) | |
107 | ans1))) | |
2054a44c | 108 | (when (called-interactively-p 'interactive) |
666fd2cc CY |
109 | (if ans2 |
110 | (if (= (length ans2) 1) | |
111 | (message "%s" (car ans2)) | |
112 | (message "%s + %d others" (car ans2) | |
113 | (length (cdr ans2)))) | |
114 | (error "No file found"))) | |
115 | ans2)) | |
116 | ||
117 | (defun cedet-cscope-support-for-directory (&optional dir) | |
118 | "Return non-nil if CScope has a support file for DIR. | |
119 | If DIR is not supplied, use the current default directory. | |
120 | This works by running cscope on a bogus symbol, and looking for | |
121 | the error code." | |
cb85c0d8 | 122 | (interactive "DDirectory: ") |
666fd2cc CY |
123 | (save-excursion |
124 | (let ((default-directory (or dir default-directory))) | |
125 | (set-buffer (cedet-cscope-call (list "-d" "-L" "-7" "moose"))) | |
126 | (goto-char (point-min)) | |
cb85c0d8 EL |
127 | (let ((ans (looking-at "[^ \n]*cscope: "))) |
128 | (if (called-interactively-p 'interactive) | |
129 | (if ans | |
130 | (message "No support for CScope in %s" default-directory) | |
131 | (message "CScope is supported in %s" default-directory)) | |
132 | (if ans | |
133 | nil | |
134 | t)))))) | |
666fd2cc CY |
135 | |
136 | (defun cedet-cscope-version-check (&optional noerror) | |
137 | "Check the version of the installed CScope command. | |
cd1181db JB |
138 | If optional programmatic argument NOERROR is non-nil, |
139 | then instead of throwing an error if CScope isn't available, | |
666fd2cc CY |
140 | return nil." |
141 | (interactive) | |
142 | (require 'inversion) | |
143 | (let ((b (condition-case nil | |
144 | (cedet-cscope-call (list "-V")) | |
145 | (error nil))) | |
146 | (rev nil)) | |
147 | (if (not b) | |
148 | (progn | |
2054a44c | 149 | (when (called-interactively-p 'interactive) |
666fd2cc CY |
150 | (message "CScope not found.")) |
151 | nil) | |
0816d744 | 152 | (with-current-buffer b |
666fd2cc CY |
153 | (goto-char (point-min)) |
154 | (re-search-forward "cscope: version \\([0-9.]+\\)" nil t) | |
155 | (setq rev (match-string 1)) | |
156 | (if (inversion-check-version rev nil cedet-cscope-min-version) | |
157 | (if noerror | |
158 | nil | |
159 | (error "Version of CScope is %s. Need at least %s" | |
160 | rev cedet-cscope-min-version)) | |
161 | ;; Else, return TRUE, as in good enough. | |
2054a44c | 162 | (when (called-interactively-p 'interactive) |
666fd2cc CY |
163 | (message "CScope %s - Good enough for CEDET." rev)) |
164 | t))))) | |
165 | ||
cb85c0d8 EL |
166 | (defun cedet-cscope-create/update-database (&optional dir) |
167 | "Create a CScope database in DIR. | |
168 | CScope will automatically choose incremental rebuild if | |
169 | there is already a database in DIR." | |
170 | (interactive "DDirectory: ") | |
171 | (let ((default-directory dir)) | |
172 | (cedet-cscope-create nil))) | |
173 | ||
666fd2cc CY |
174 | (provide 'cedet-cscope) |
175 | ||
176 | ;;; cedet-cscope.el ends here |