code.delx.au - gnu-emacs/blob - lisp/cedet/semantic/symref/grep.el

   1 ;;; semantic/symref/grep.el --- Symref implementation using find/grep
   2
   3 ;; Copyright (C) 2008-2015 Free Software Foundation, Inc.
   4
   5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
   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 ;; Implement the symref tool API using the external tools find/grep.
  25 ;;
  26 ;; The symref GREP tool uses grep in a project to find symbol references.
  27 ;; This is a lowest-common-denominator tool with sucky performance that
  28 ;; can be used in small projects to find symbol references.
  29
  30 (require 'semantic/symref)
  31 (require 'grep)
  32
  33 ;;; Code:
  34
  35 ;;; GREP
  36 ;;;###autoload
  37 (defclass semantic-symref-tool-grep (semantic-symref-tool-baseclass)
  38   (
  39    )
  40   "A symref tool implementation using grep.
  41 This tool uses EDE to find he root of the project, then executes
  42 find-grep in the project.  The output is parsed for hits
  43 and those hits returned.")
  44
  45 (defvar semantic-symref-filepattern-alist
  46   '((c-mode "*.[ch]")
  47     (c++-mode "*.[chCH]" "*.[ch]pp" "*.cc" "*.hh")
  48     (html-mode "*.s?html" "*.php")
  49     (ruby-mode "*.r[bu]" "*.rake" "*.gemspec" "*.erb" "*.haml"
  50                "Rakefile" "Thorfile" "Capfile" "Guardfile" "Vagrantfile")
  51     )
  52   "List of major modes and file extension pattern.
  53 See find -name man page for format.")
  54
  55 (defun semantic-symref-derive-find-filepatterns (&optional mode)
  56   "Derive a list of file patterns for the current buffer.
  57 Looks first in `semantic-symref-filepattern-alist'.  If it is not
  58 there, it then looks in `auto-mode-alist', and attempts to derive something
  59 from that.
  60 Optional argument MODE specifies the `major-mode' to test."
  61   ;; First, try the filepattern alist.
  62   (let* ((mode (or mode major-mode))
  63          (pat (cdr (assoc mode semantic-symref-filepattern-alist))))
  64     (when (not pat)
  65       ;; No hit, try auto-mode-alist.
  66       (dolist (X auto-mode-alist)
  67         (when (eq (cdr X) mode)
  68           ;; Only take in simple patterns, so try to convert this one.
  69           (let ((Xp
  70                  (cond ((string-match "\\\\\\.\\([^\\'>]+\\)\\\\'" (car X))
  71                         (concat "*." (match-string 1 (car X))))
  72                        (t nil))))
  73             (when Xp
  74               (setq pat (cons Xp pat))))
  75           )))
  76     ;; Convert the list into some find-flags.
  77     (cond ((= (length pat) 1)
  78            (concat "-name \"" (car pat) "\""))
  79           ((consp pat)
  80            (concat "\\( "
  81                    (mapconcat (lambda (s)
  82                                 (concat "-name \"" s "\""))
  83                               pat
  84                               " -o ")
  85                    " \\)"))
  86           (t
  87            (error "Customize `semantic-symref-filepattern-alist' for %s" major-mode))
  88           )))
  89
  90 (defvar grepflags)
  91 (defvar greppattern)
  92
  93 (defvar semantic-symref-grep-expand-keywords
  94   (condition-case nil
  95       (let* ((kw (copy-alist grep-expand-keywords))
  96              (C (assoc "<C>" kw))
  97              (R (assoc "<R>" kw)))
  98         (setcdr C 'grepflags)
  99         (setcdr R 'greppattern)
 100         kw)
 101     (error nil))
 102   "Grep expand keywords used when expanding templates for symref.")
 103
 104 (defun semantic-symref-grep-use-template (rootdir filepattern flags pattern)
 105   "Use the grep template expand feature to create a grep command.
 106 ROOTDIR is the root location to run the `find' from.
 107 FILEPATTERN is a string representing find flags for searching file patterns.
 108 GREPFLAGS are flags passed to grep, such as -n or -l.
 109 GREPPATTERN is the pattern used by grep."
 110   ;; We have grep-compute-defaults.  Let's use it.
 111   (grep-compute-defaults)
 112   (let* ((grepflags flags)
 113          (greppattern pattern)
 114          (grep-expand-keywords semantic-symref-grep-expand-keywords)
 115          (cmd (grep-expand-template
 116                (if (memq system-type '(windows-nt ms-dos))
 117                    ;; grep-find uses '--color=always' on MS-Windows
 118                    ;; because it wants the colorized output, to show
 119                    ;; it to the user.  By contrast, here we don't show
 120                    ;; the output, and the SGR escapes get in the way
 121                    ;; of parsing the output.
 122                    (replace-regexp-in-string "--color=always" ""
 123                                              grep-find-template t t)
 124                  grep-find-template)
 125                greppattern
 126                filepattern
 127                rootdir)))
 128     ;; For some reason, my default has no <D> in it.
 129     (when (string-match "find \\(\\.\\)" cmd)
 130       (setq cmd (replace-match rootdir t t cmd 1)))
 131     ;;(message "New command: %s" cmd)
 132     cmd))
 133
 134 (defcustom semantic-symref-grep-shell shell-file-name
 135   "The shell command to use for executing find/grep.
 136 This shell should support pipe redirect syntax."
 137   :group 'semantic
 138   :type 'string)
 139
 140 (cl-defmethod semantic-symref-perform-search ((tool semantic-symref-tool-grep))
 141   "Perform a search with Grep."
 142   ;; Grep doesn't support some types of searches.
 143   (let ((st (oref tool :searchtype)))
 144     (when (not (memq st '(symbol regexp)))
 145       (error "Symref impl GREP does not support searchtype of %s" st))
 146     )
 147   ;; Find the root of the project, and do a find-grep...
 148   (let* (;; Find the file patterns to use.
 149          (rootdir (semantic-symref-calculate-rootdir))
 150          (filepattern (semantic-symref-derive-find-filepatterns))
 151          ;; Grep based flags.
 152          (grepflags (cond ((eq (oref tool :resulttype) 'file)
 153                            "-l ")
 154                           ((eq (oref tool :searchtype) 'regexp)
 155                            "-nE ")
 156                           (t "-n ")))
 157          (greppat (shell-quote-argument
 158                    (cond ((eq (oref tool :searchtype) 'regexp)
 159                           (oref tool searchfor))
 160                          (t
 161                           ;; Can't use the word boundaries: Grep
 162                           ;; doesn't always agrees with the language
 163                           ;; syntax on those.
 164                           (format "\\(^\\|\\W\\)%s\\(\\W\\|$\\)"
 165                                   (oref tool searchfor))))))
 166          ;; Misc
 167          (b (get-buffer-create "*Semantic SymRef*"))
 168          (ans nil)
 169          )
 170
 171     (with-current-buffer b
 172       (erase-buffer)
 173       (setq default-directory rootdir)
 174
 175       (if (not (fboundp 'grep-compute-defaults))
 176
 177           ;; find . -type f -print0 | xargs -0 -e grep -nH -e
 178           ;; Note : I removed -e as it is not posix, nor necessary it seems.
 179
 180           (let ((cmd (concat "find " default-directory " -type f " filepattern " -print0 "
 181                              "| xargs -0 grep -H " grepflags "-e " greppat)))
 182             ;;(message "Old command: %s" cmd)
 183             (call-process semantic-symref-grep-shell nil b nil
 184                           shell-command-switch cmd)
 185             )
 186         (let ((cmd (semantic-symref-grep-use-template rootdir filepattern grepflags greppat)))
 187           (call-process semantic-symref-grep-shell nil b nil
 188                         shell-command-switch cmd))
 189         ))
 190     (setq ans (semantic-symref-parse-tool-output tool b))
 191     ;; Return the answer
 192     ans))
 193
 194 (cl-defmethod semantic-symref-parse-tool-output-one-line ((tool semantic-symref-tool-grep))
 195   "Parse one line of grep output, and return it as a match list.
 196 Moves cursor to end of the match."
 197   (cond ((eq (oref tool :resulttype) 'file)
 198          ;; Search for files
 199          (when (re-search-forward "^\\([^\n]+\\)$" nil t)
 200            (match-string 1)))
 201         (t
 202          (when (re-search-forward  "^\\(\\(?:[a-zA-Z]:\\)?[^:\n]+\\):\\([0-9]+\\):" nil t)
 203            (cons (string-to-number (match-string 2))
 204                  (match-string 1))
 205            ))))
 206
 207 (provide 'semantic/symref/grep)
 208
 209 ;; Local variables:
 210 ;; generated-autoload-file: "../loaddefs.el"
 211 ;; generated-autoload-load-name: "semantic/symref/grep"
 212 ;; End:
 213
 214 ;;; semantic/symref/grep.el ends here