; ede-locate-create/update-root-database: Fix docstring typo
[emacs.git] / lisp / cedet / ede / locate.el
bloba076c46513ce4b0a0f12a7fdac767045777ffd27
1 ;;; ede/locate.el --- Locate support
3 ;; Copyright (C) 2008-2015 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
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/>.
22 ;;; Commentary:
24 ;; Support for various LOCATE type functions.
26 ;; A key feature of EDE is `ede-expand-filename', which allows a
27 ;; project to expand a filename reference in one file to some actual
28 ;; filename.
30 ;; In that way, you may #include <foo.h>, and without knowing how to
31 ;; read a Makefile, find it in <root>/include/foo.h.
33 ;; Some projects are regular, such as the Emacs project. Some
34 ;; projects are completely controlled by EDE, such sh the Project.ede
35 ;; based projects.
37 ;; For other projects, having a "quick hack" to support these location
38 ;; routines is handy.
40 ;; The baseclass `ede-locate-base' provides the abstract interface to
41 ;; finding files in a project.
43 ;; New location routines will subclass `ede-locate-base'.
45 ;; How to use:
47 ;; Configure `ede-locate-setup-options' to add the types of locate
48 ;; features you have available. EDE will then enable the correct one
49 ;; when it is available.
51 (require 'ede)
52 (eval-when-compile (require 'locate))
54 ;;; Code:
55 (defcustom ede-locate-setup-options
56 '(ede-locate-base)
57 "List of locate objects to try out by default.
58 Listed in order of preference. If the first item cannot be used in
59 a particular project, then the next one is tried.
60 It is always assumed that `ede-locate-base' is at end of the list."
61 :group 'ede
62 :type '(repeat
63 (choice (const :tag "None" ede-locate-base)
64 (const :tag "locate" ede-locate-locate)
65 (const :tag "GNU Global" ede-locate-global)
66 (const :tag "ID Utils" ede-locate-idutils)
67 (const :tag "CScope" ede-locate-cscope)))
70 ;;;###autoload
71 (defun ede-enable-locate-on-project (&optional project)
72 "Enable an EDE locate feature on PROJECT.
73 Attempt to guess which project locate style to use
74 based on `ede-locate-setup-options'."
75 (interactive)
76 (let* ((proj (or project (ede-toplevel)))
77 (root (ede-project-root-directory proj))
78 (opts ede-locate-setup-options)
79 (ans nil))
80 (while (and opts (not ans))
81 (when (ede-locate-ok-in-project (car opts) root)
82 ;; If interactive, check with the user.
83 (when (or (not (called-interactively-p 'any))
84 (y-or-n-p (format "Set project locator to %s? " (car opts))))
85 (setq ans (car opts))))
86 (setq opts (cdr opts)))
87 ;; No match? Always create the baseclass for the hashing tool.
88 (when (not ans)
89 (when (called-interactively-p 'interactive)
90 (message "Setting locator to ede-locate-base"))
91 (setq ans 'ede-locate-base))
92 (oset proj locate-obj (make-instance ans "Loc" :root root))
93 (when (called-interactively-p 'interactive)
94 (message "Setting locator to %s" ans))
97 ;;; LOCATE BASECLASS
99 ;; The baseclass for all location style queries.
100 (defclass ede-locate-base ()
101 ((root :initarg :root
102 :documentation
103 "The root of these locat searches.")
104 (file :documentation
105 "The last file search for with EDE locate.")
106 (lastanswer :documentation
107 "The last answer provided by the locator.")
108 (hash :documentation
109 "Hash table of previously found files.")
111 "Baseclass for LOCATE feature in EDE.")
113 (cl-defmethod initialize-instance ((loc ede-locate-base) &rest fields)
114 "Make sure we have a hash table."
115 ;; Basic setup.
116 (cl-call-next-method)
117 ;; Make sure we have a hash table.
118 (ede-locate-flush-hash loc)
121 (cl-defmethod ede-locate-ok-in-project ((loc (subclass ede-locate-base))
122 root)
123 "Is it ok to use this project type under ROOT."
126 (cl-defmethod ede-locate-flush-hash ((loc ede-locate-base))
127 "For LOC, flush hashtable and start from scratch."
128 (oset loc hash (make-hash-table :test 'equal)))
130 (cl-defmethod ede-locate-file-in-hash ((loc ede-locate-base)
131 filestring)
132 "For LOC, is the file FILESTRING in our hashtable?"
133 (gethash filestring (oref loc hash)))
135 (cl-defmethod ede-locate-add-file-to-hash ((loc ede-locate-base)
136 filestring fullfilename)
137 "For LOC, add FILESTR to the hash with FULLFILENAME."
138 (puthash filestring fullfilename (oref loc hash)))
140 (cl-defmethod ede-locate-file-in-project ((loc ede-locate-base)
141 filesubstring
143 "Locate with LOC occurrences of FILESUBSTRING.
144 Searches are done under the current root of the EDE project
145 that created this EDE locate object."
146 (let ((ans (ede-locate-file-in-project-impl loc filesubstring))
148 (oset loc file filesubstring)
149 (oset loc lastanswer ans)
150 ans))
152 (cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-base)
153 filesubstring
155 "Locate with LOC occurrences of FILESUBSTRING.
156 Searches are done under the current root of the EDE project
157 that created this EDE locate object."
161 (cl-defmethod ede-locate-create/update-root-database
162 ((loc (subclass ede-locate-base)) root)
163 "Create or update the database for the current project.
164 You cannot create projects for the baseclass."
165 (error "Cannot create/update a database of type %S"
166 (eieio-object-name loc)))
168 ;;; LOCATE
170 ;; Using the standard unix "locate" command.
171 ;; Since locate is system wide, we need to hack the search
172 ;; to restrict it to within just this project.
174 (defclass ede-locate-locate (ede-locate-base)
176 "EDE Locator using the locate command.
177 Configure the Emacs `locate-program' variable to also
178 configure the use of EDE locate.")
180 (cl-defmethod ede-locate-ok-in-project ((loc (subclass ede-locate-locate))
181 root)
182 "Is it ok to use this project type under ROOT."
183 (or (featurep 'locate) (locate-library "locate"))
186 (cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-locate)
187 filesubstring)
188 "Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT.
189 Searches are done under the current root of the EDE project
190 that created this EDE locate object."
191 ;; We want something like:
192 ;; /my/project/root*/filesubstring.c
193 (let* ((searchstr (concat (directory-file-name (oref loc root))
194 "*/" filesubstring))
195 (b (get-buffer-create "*LOCATE*"))
196 (cd default-directory)
198 (with-current-buffer b
199 (setq default-directory cd)
200 (erase-buffer))
201 (apply 'call-process locate-command
202 nil b nil
203 searchstr nil)
204 (with-current-buffer b
205 (split-string (buffer-string) "\n" t))
209 ;;; GLOBAL
212 (declare-function cedet-gnu-global-version-check "cedet-global")
213 (declare-function cedet-gnu-global-root "cedet-global")
214 (declare-function cedet-gnu-global-expand-filename "cedet-global")
215 (declare-function cedet-gnu-global-create/update-database "cedet-global")
217 (defclass ede-locate-global (ede-locate-base)
219 "EDE Locator using GNU Global.
220 Configure EDE's use of GNU Global through the cedet-global.el
221 variable `cedet-global-command'.")
223 (cl-defmethod initialize-instance ((loc ede-locate-global)
224 &rest slots)
225 "Make sure that we can use GNU Global."
226 (require 'cedet-global)
227 ;; Get ourselves initialized.
228 (cl-call-next-method)
229 ;; Do the checks.
230 (cedet-gnu-global-version-check)
231 (let* ((default-directory (oref loc root))
232 (root (cedet-gnu-global-root)))
233 (when (not root)
234 (error "Cannot use GNU Global in %s"
235 (oref loc root))))
238 (cl-defmethod ede-locate-ok-in-project ((loc (subclass ede-locate-global))
239 root)
240 "Is it ok to use this project type under ROOT."
241 (require 'cedet-global)
242 (cedet-gnu-global-version-check)
243 (let* ((default-directory root)
244 (newroot (cedet-gnu-global-root)))
245 newroot))
247 (cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-global)
248 filesubstring)
249 "Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT.
250 Searches are done under the current root of the EDE project
251 that created this EDE locate object."
252 (require 'cedet-global)
253 (let ((default-directory (oref loc root)))
254 (cedet-gnu-global-expand-filename filesubstring)))
256 (cl-defmethod ede-locate-create/update-root-database
257 ((loc (subclass ede-locate-global)) root)
258 "Create or update the GNU Global database for the current project."
259 (cedet-gnu-global-create/update-database root))
261 ;;; IDUTILS
264 (declare-function cedet-idutils-version-check "cedet-idutils")
265 (declare-function cedet-idutils-support-for-directory "cedet-idutils")
266 (declare-function cedet-idutils-expand-filename "cedet-idutils")
267 (declare-function cedet-idutils-create/update-database "cedet-idutils")
269 (defclass ede-locate-idutils (ede-locate-base)
271 "EDE Locator using IDUtils.
272 Configure EDE's use of IDUtils through the cedet-idutils.el
273 file name searching variable `cedet-idutils-file-command'.")
275 (cl-defmethod initialize-instance ((loc ede-locate-idutils)
276 &rest slots)
277 "Make sure that we can use IDUtils."
278 ;; Get ourselves initialized.
279 (cl-call-next-method)
280 ;; Do the checks.
281 (require 'cedet-idutils)
282 (cedet-idutils-version-check)
283 (when (not (cedet-idutils-support-for-directory (oref loc root)))
284 (error "Cannot use IDUtils in %s"
285 (oref loc root)))
288 (cl-defmethod ede-locate-ok-in-project ((loc (subclass ede-locate-idutils))
289 root)
290 "Is it ok to use this project type under ROOT."
291 (require 'cedet-idutils)
292 (cedet-idutils-version-check)
293 (when (cedet-idutils-support-for-directory root)
294 root))
296 (cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-idutils)
297 filesubstring)
298 "Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT.
299 Searches are done under the current root of the EDE project
300 that created this EDE locate object."
301 (require 'cedet-idutils)
302 (let ((default-directory (oref loc root)))
303 (cedet-idutils-expand-filename filesubstring)))
305 (cl-defmethod ede-locate-create/update-root-database
306 ((loc (subclass ede-locate-idutils)) root)
307 "Create or update the GNU Global database for the current project."
308 (cedet-idutils-create/update-database root))
310 ;;; CSCOPE
313 (declare-function cedet-cscope-version-check "cedet-cscope")
314 (declare-function cedet-cscope-support-for-directory "cedet-cscope")
315 (declare-function cedet-cscope-expand-filename "cedet-cscope")
316 (declare-function cedet-cscope-create/update-database "cedet-cscope")
318 (defclass ede-locate-cscope (ede-locate-base)
320 "EDE Locator using Cscope.
321 Configure EDE's use of Cscope through the cedet-cscope.el
322 file name searching variable `cedet-cscope-file-command'.")
324 (cl-defmethod initialize-instance ((loc ede-locate-cscope)
325 &rest slots)
326 "Make sure that we can use Cscope."
327 ;; Get ourselves initialized.
328 (cl-call-next-method)
329 ;; Do the checks.
330 (require 'cedet-cscope)
331 (cedet-cscope-version-check)
332 (when (not (cedet-cscope-support-for-directory (oref loc root)))
333 (error "Cannot use Cscope in %s"
334 (oref loc root)))
337 (cl-defmethod ede-locate-ok-in-project ((loc (subclass ede-locate-cscope))
338 root)
339 "Is it ok to use this project type under ROOT."
340 (require 'cedet-cscope)
341 (cedet-cscope-version-check)
342 (when (cedet-cscope-support-for-directory root)
343 root))
345 (cl-defmethod ede-locate-file-in-project-impl ((loc ede-locate-cscope)
346 filesubstring)
347 "Locate with LOC occurrences of FILESUBSTRING under PROJECTROOT.
348 Searches are done under the current root of the EDE project
349 that created this EDE locate object."
350 (let ((default-directory (oref loc root)))
351 (require 'cedet-cscope)
352 (cedet-cscope-expand-filename filesubstring)))
354 (cl-defmethod ede-locate-create/update-root-database
355 ((loc (subclass ede-locate-cscope)) root)
356 "Create or update the Cscope database for the current project."
357 (require 'cedet-cscope)
358 (cedet-cscope-create/update-database root))
360 (provide 'ede/locate)
362 ;; Local variables:
363 ;; generated-autoload-file: "loaddefs.el"
364 ;; generated-autoload-load-name: "ede/locate"
365 ;; End:
367 ;;; ede/locate.el ends here