1 ;;; semantic/symref/grep.el --- Symref implementation using find/grep
3 ;; Copyright (C) 2008, 2009 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)
33 (defvar ede-minor-mode)
34 (declare-function ede-toplevel "ede/files")
35 (declare-function ede-project-root-directory "ede/files")
41 (defclass semantic-symref-tool-grep (semantic-symref-tool-baseclass)
44 "A symref tool implementation using grep.
45 This tool uses EDE to find he root of the project, then executes
46 find-grep in the project. The output is parsed for hits
47 and those hits returned.")
49 (defvar semantic-symref-filepattern-alist
51 (c++-mode "*.[chCH]" "*.[ch]pp" "*.cc" "*.hh")
52 (html-mode "*.s?html" "*.php")
54 "List of major modes and file extension pattern regexp.
55 See find -regex man page for format.")
57 (defun semantic-symref-derive-find-filepatterns (&optional mode)
58 "Derive a list of file patterns for the current buffer.
59 Looks first in `semantic-symref-filepattern-alist'. If it is not
60 there, it then looks in `auto-mode-alist', and attempts to derive something
62 Optional argument MODE specifies the `major-mode' to test."
63 ;; First, try the filepattern alist.
64 (let* ((mode (or mode major-mode))
65 (pat (cdr (assoc mode semantic-symref-filepattern-alist))))
67 ;; No hit, try auto-mode-alist.
68 (dolist (X auto-mode-alist)
69 (when (eq (cdr X) mode)
70 ;; Only take in simple patterns, so try to convert this one.
72 (cond ((string-match "\\\\\\.\\([^\\'>]+\\)\\\\'" (car X))
73 (concat "*." (match-string 1 (car X))))
76 (setq pat (cons Xp pat))))
78 ;; Convert the list into some find-flags.
79 (cond ((= (length pat) 1)
80 (concat "-name \"" (car pat) "\""))
83 (mapconcat (lambda (s)
84 (concat "-name \"" s "\""))
89 (error "Configuration for `semantic-symref-tool-grep' needed for %s" major-mode))
92 (defvar semantic-symref-grep-expand-keywords
94 (let* ((kw (copy-alist grep-expand-keywords))
98 (setcdr R 'greppattern)
101 "Grep expand keywords used when expanding templates for symref.")
103 (defun semantic-symref-grep-use-template (rootdir filepattern grepflags greppattern)
104 "Use the grep template expand feature to create a grep command.
105 ROOTDIR is the root location to run the `find' from.
106 FILEPATTERN is a string representing find flags for searching file patterns.
107 GREPFLAGS are flags passed to grep, such as -n or -l.
108 GREPPATTERN is the pattern used by grep."
109 ;; We have grep-compute-defaults. Lets use it.
110 (grep-compute-defaults)
111 (let* ((grep-expand-keywords semantic-symref-grep-expand-keywords)
112 (cmd (grep-expand-template grep-find-template
116 ;; For some reason, my default has no <D> in it.
117 (when (string-match "find \\(\\.\\)" cmd)
118 (setq cmd (replace-match rootdir t t cmd 1)))
119 ;;(message "New command: %s" cmd)
122 (defmethod semantic-symref-perform-search ((tool semantic-symref-tool-grep))
123 "Perform a search with Grep."
124 ;; Grep doesn't support some types of searches.
125 (let ((st (oref tool :searchtype)))
126 (when (not (eq st 'symbol))
127 (error "Symref impl GREP does not support searchtype of %s" st))
129 ;; Find the root of the project, and do a find-grep...
130 (let* (;; Find the file patterns to use.
131 (pat (cdr (assoc major-mode semantic-symref-filepattern-alist)))
133 ;; Project root via EDE.
134 ((eq (oref tool :searchscope) 'project)
135 (let ((rootproj (when (and (featurep 'ede) ede-minor-mode)
138 (ede-project-root-directory rootproj)
140 ;; Calculate the target files as just in
141 ;; this directory... cause I'm lazy.
142 ((eq (oref tool :searchscope) 'target)
145 (filepattern (semantic-symref-derive-find-filepatterns))
147 (grepflags (cond ((eq (oref tool :resulttype) 'file)
150 (greppat (cond ((eq (oref tool :searchtype) 'regexp)
151 (oref tool searchfor))
153 (concat "'\\<" (oref tool searchfor) "\\>'"))))
155 (b (get-buffer-create "*Semantic SymRef*"))
159 (with-current-buffer b
161 (setq default-directory rootdir)
163 (if (not (fboundp 'grep-compute-defaults))
165 ;; find . -type f -print0 | xargs -0 -e grep -nH -e
166 ;; Note : I removed -e as it is not posix, nor necessary it seems.
168 (let ((cmd (concat "find " default-directory " -type f " filepattern " -print0 "
169 "| xargs -0 grep -H " grepflags "-e " greppat)))
170 ;;(message "Old command: %s" cmd)
171 (call-process "sh" nil b nil "-c" cmd)
173 (let ((cmd (semantic-symref-grep-use-template rootdir filepattern grepflags greppat)))
174 (call-process "sh" nil b nil "-c" cmd))
176 (setq ans (semantic-symref-parse-tool-output tool b))
180 (defmethod semantic-symref-parse-tool-output-one-line ((tool semantic-symref-tool-grep))
181 "Parse one line of grep output, and return it as a match list.
182 Moves cursor to end of the match."
183 (cond ((eq (oref tool :resulttype) 'file)
185 (when (re-search-forward "^\\([^\n]+\\)$" nil t)
188 (when (re-search-forward "^\\(\\(?:[a-zA-Z]:\\)?[^:\n]+\\):\\([0-9]+\\):" nil t)
189 (cons (string-to-number (match-string 2))
193 (provide 'semantic/symref/grep)
196 ;; generated-autoload-file: "../loaddefs.el"
197 ;; generated-autoload-feature: semantic/loaddefs
198 ;; generated-autoload-load-name: "semantic/symref/grep"
201 ;; arch-tag: 43d4469d-963c-4094-ac6f-99f7490973ce
202 ;;; semantic/symref/grep.el ends here