lisp/cedet/cedet-cscope.el

   1 ;;; cedet-cscope.el --- CScope support for CEDET
   2
   3 ;;; Copyright (C) 2009 Free Software Foundation, Inc.
   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         )
  80     (save-excursion
  81       (set-buffer b)
  82       (setq default-directory cd)
  83       (erase-buffer))
  84     (apply 'call-process cedet-cscope-command
  85            nil b nil
  86            flags)
  87     b))
  88
  89 (defun cedet-cscope-expand-filename (filename)
  90   "Expand the FILENAME with CScope.
  91 Return a fully qualified filename."
  92   (interactive "sFile: ")
  93   (let* ((ans1 (save-excursion
  94                  (set-buffer (cedet-cscope-call (list "-d" "-L" "-7" filename)))
  95                  (goto-char (point-min))
  96                  (if (looking-at "[^ \n]*cscope: ")
  97                      (error "CScope not available")
  98                    (split-string (buffer-string) "\n" t))))
  99          (ans2 (mapcar (lambda (hit)
 100                          (expand-file-name (car (split-string hit " "))))
 101                        ans1)))
 102     (when (interactive-p)
 103       (if ans2
 104           (if (= (length ans2) 1)
 105               (message "%s" (car ans2))
 106             (message "%s + %d others" (car ans2)
 107                      (length (cdr ans2))))
 108         (error "No file found")))
 109     ans2))
 110
 111 (defun cedet-cscope-support-for-directory (&optional dir)
 112   "Return non-nil if CScope has a support file for DIR.
 113 If DIR is not supplied, use the current default directory.
 114 This works by running cscope on a bogus symbol, and looking for
 115 the error code."
 116   (save-excursion
 117     (let ((default-directory (or dir default-directory)))
 118       (set-buffer (cedet-cscope-call (list "-d" "-L" "-7" "moose")))
 119       (goto-char (point-min))
 120       (if (looking-at "[^ \n]*cscope: ")
 121           nil
 122         t))))
 123
 124 (defun cedet-cscope-version-check (&optional noerror)
 125   "Check the version of the installed CScope command.
 126 If optional programatic argument NOERROR is non-nil, then
 127 instead of throwing an error if CScope isn't available, then
 128 return nil."
 129   (interactive)
 130   (require 'inversion)
 131   (let ((b (condition-case nil
 132                (cedet-cscope-call (list "-V"))
 133              (error nil)))
 134         (rev nil))
 135     (if (not b)
 136         (progn
 137           (when (interactive-p)
 138             (message "CScope not found."))
 139           nil)
 140       (save-excursion
 141         (set-buffer b)
 142         (goto-char (point-min))
 143         (re-search-forward "cscope: version \\([0-9.]+\\)" nil t)
 144         (setq rev (match-string 1))
 145         (if (inversion-check-version rev nil cedet-cscope-min-version)
 146             (if noerror
 147                 nil
 148               (error "Version of CScope is %s.  Need at least %s"
 149                      rev cedet-cscope-min-version))
 150           ;; Else, return TRUE, as in good enough.
 151           (when (interactive-p)
 152             (message "CScope %s  - Good enough for CEDET." rev))
 153           t)))))
 154
 155 (provide 'cedet-cscope)
 156
 157 ;;; cedet-cscope.el ends here