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