1 ;;; semantic/symref/grep.el --- Symref implementation using find/grep
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/>.
24 ;; Implement the symref tool API using the external tools find/grep.
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.
30 (require 'semantic
/symref
)
37 (defclass semantic-symref-tool-grep
(semantic-symref-tool-baseclass)
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.")
45 (defvar semantic-symref-filepattern-alist
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")
52 "List of major modes and file extension pattern.
53 See find -name man page for format.")
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
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
))))
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.
70 (cond ((string-match "\\\\\\.\\([^\\'>]+\\)\\\\'" (car X
))
71 (concat "*." (match-string 1 (car X
))))
74 (setq pat
(cons Xp pat
))))
76 ;; Convert the list into some find-flags.
77 (cond ((= (length pat
) 1)
78 (concat "-name \"" (car pat
) "\""))
81 (mapconcat (lambda (s)
82 (concat "-name \"" s
"\""))
87 (error "Customize `semantic-symref-filepattern-alist' for %s" major-mode
))
93 (defvar semantic-symref-grep-expand-keywords
95 (let* ((kw (copy-alist grep-expand-keywords
))
99 (setcdr R
'greppattern
)
102 "Grep expand keywords used when expanding templates for symref.")
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
)
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)
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."
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
))
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))
152 (grepflags (cond ((eq (oref tool
:resulttype
) 'file
)
154 ((eq (oref tool
:searchtype
) 'regexp
)
157 (greppat (shell-quote-argument
158 (cond ((eq (oref tool
:searchtype
) 'regexp
)
159 (oref tool searchfor
))
161 (concat "\\<" (oref tool searchfor
) "\\>")))))
163 (b (get-buffer-create "*Semantic SymRef*"))
167 (with-current-buffer b
169 (setq default-directory rootdir
)
171 (if (not (fboundp 'grep-compute-defaults
))
173 ;; find . -type f -print0 | xargs -0 -e grep -nH -e
174 ;; Note : I removed -e as it is not posix, nor necessary it seems.
176 (let ((cmd (concat "find " default-directory
" -type f " filepattern
" -print0 "
177 "| xargs -0 grep -H " grepflags
"-e " greppat
)))
178 ;;(message "Old command: %s" cmd)
179 (call-process semantic-symref-grep-shell nil b nil
180 shell-command-switch cmd
)
182 (let ((cmd (semantic-symref-grep-use-template rootdir filepattern grepflags greppat
)))
183 (call-process semantic-symref-grep-shell nil b nil
184 shell-command-switch cmd
))
186 (setq ans
(semantic-symref-parse-tool-output tool b
))
190 (cl-defmethod semantic-symref-parse-tool-output-one-line ((tool semantic-symref-tool-grep
))
191 "Parse one line of grep output, and return it as a match list.
192 Moves cursor to end of the match."
193 (cond ((eq (oref tool
:resulttype
) 'file
)
195 (when (re-search-forward "^\\([^\n]+\\)$" nil t
)
198 (when (re-search-forward "^\\(\\(?:[a-zA-Z]:\\)?[^:\n]+\\):\\([0-9]+\\):" nil t
)
199 (cons (string-to-number (match-string 2))
203 (provide 'semantic
/symref
/grep
)
206 ;; generated-autoload-file: "../loaddefs.el"
207 ;; generated-autoload-load-name: "semantic/symref/grep"
210 ;;; semantic/symref/grep.el ends here