ChangeLog simplification
[emacs.git] / lisp / progmodes / grep.el
blob99629450c1b88d7b02fc9d67569bdbaa4f55a24b
1 ;;; grep.el --- run `grep' and display the results
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2014 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Roland McGrath <roland@gnu.org>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: tools, processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This package provides the grep facilities documented in the Emacs
28 ;; user's manual.
30 ;;; Code:
32 (require 'compile)
35 (defgroup grep nil
36 "Run `grep' and display the results."
37 :group 'tools
38 :group 'processes)
40 (defvar grep-host-defaults-alist nil
41 "Default values depending on target host.
42 `grep-compute-defaults' returns default values for every local or
43 remote host `grep' runs. These values can differ from host to
44 host. Once computed, the default values are kept here in order
45 to avoid computing them again.")
47 (defun grep-apply-setting (symbol value)
48 "Set SYMBOL to VALUE, and update `grep-host-defaults-alist'.
49 SYMBOL should be one of `grep-command', `grep-template',
50 `grep-use-null-device', `grep-find-command',
51 `grep-find-template', `grep-find-use-xargs', or
52 `grep-highlight-matches'."
53 (when grep-host-defaults-alist
54 (let* ((host-id
55 (intern (or (file-remote-p default-directory) "localhost")))
56 (host-defaults (assq host-id grep-host-defaults-alist))
57 (defaults (assq nil grep-host-defaults-alist)))
58 (setcar (cdr (assq symbol host-defaults)) value)
59 (setcar (cdr (assq symbol defaults)) value)))
60 (set-default symbol value))
62 ;;;###autoload
63 (defcustom grep-window-height nil
64 "Number of lines in a grep window. If nil, use `compilation-window-height'."
65 :type '(choice (const :tag "Default" nil)
66 integer)
67 :version "22.1"
68 :group 'grep)
70 (defcustom grep-highlight-matches 'auto-detect
71 "Use special markers to highlight grep matches.
73 Some grep programs are able to surround matches with special
74 markers in grep output. Such markers can be used to highlight
75 matches in grep mode. This requires `font-lock-mode' to be active
76 in grep buffers, so if you have globally disabled font-lock-mode,
77 you will not get highlighting.
79 This option sets the environment variable GREP_COLORS to specify
80 markers for highlighting and GREP_OPTIONS to add the --color
81 option in front of any explicit grep options before starting
82 the grep.
84 When this option is `auto', grep uses `--color=auto' to highlight
85 matches only when it outputs to a terminal (when `grep' is the last
86 command in the pipe), thus avoiding the use of any potentially-harmful
87 escape sequences when standard output goes to a file or pipe.
89 To make grep highlight matches even into a pipe, you need the option
90 `always' that forces grep to use `--color=always' to unconditionally
91 output escape sequences.
93 In interactive usage, the actual value of this variable is set up
94 by `grep-compute-defaults' when the default value is `auto-detect'.
95 To change the default value, use Customize or call the function
96 `grep-apply-setting'."
97 :type '(choice (const :tag "Do not highlight matches with grep markers" nil)
98 (const :tag "Highlight matches with grep markers" t)
99 (const :tag "Use --color=always" always)
100 (const :tag "Use --color=auto" auto)
101 (other :tag "Not Set" auto-detect))
102 :set 'grep-apply-setting
103 :version "22.1"
104 :group 'grep)
106 (defcustom grep-scroll-output nil
107 "Non-nil to scroll the *grep* buffer window as output appears.
109 Setting it causes the grep commands to put point at the end of their
110 output window so that the end of the output is always visible rather
111 than the beginning."
112 :type 'boolean
113 :version "22.1"
114 :group 'grep)
116 ;;;###autoload
117 (defcustom grep-command nil
118 "The default grep command for \\[grep].
119 If the grep program used supports an option to always include file names
120 in its output (such as the `-H' option to GNU grep), it's a good idea to
121 include it when specifying `grep-command'.
123 In interactive usage, the actual value of this variable is set up
124 by `grep-compute-defaults'; to change the default value, use
125 Customize or call the function `grep-apply-setting'."
126 :type '(choice string
127 (const :tag "Not Set" nil))
128 :set 'grep-apply-setting
129 :group 'grep)
131 (defcustom grep-template nil
132 "The default command to run for \\[lgrep].
133 The following place holders should be present in the string:
134 <C> - place to put -i if case insensitive grep.
135 <F> - file names and wildcards to search.
136 <X> - file names and wildcards to exclude.
137 <R> - the regular expression searched for.
138 <N> - place to insert null-device.
140 In interactive usage, the actual value of this variable is set up
141 by `grep-compute-defaults'; to change the default value, use
142 Customize or call the function `grep-apply-setting'."
143 :type '(choice string
144 (const :tag "Not Set" nil))
145 :set 'grep-apply-setting
146 :version "22.1"
147 :group 'grep)
149 (defcustom grep-use-null-device 'auto-detect
150 "If t, append the value of `null-device' to `grep' commands.
151 This is done to ensure that the output of grep includes the filename of
152 any match in the case where only a single file is searched, and is not
153 necessary if the grep program used supports the `-H' option.
155 In interactive usage, the actual value of this variable is set up
156 by `grep-compute-defaults'; to change the default value, use
157 Customize or call the function `grep-apply-setting'."
158 :type '(choice (const :tag "Do Not Append Null Device" nil)
159 (const :tag "Append Null Device" t)
160 (other :tag "Not Set" auto-detect))
161 :set 'grep-apply-setting
162 :group 'grep)
164 ;;;###autoload
165 (defcustom grep-find-command nil
166 "The default find command for \\[grep-find].
167 In interactive usage, the actual value of this variable is set up
168 by `grep-compute-defaults'; to change the default value, use
169 Customize or call the function `grep-apply-setting'."
170 :type '(choice string
171 (const :tag "Not Set" nil))
172 :set 'grep-apply-setting
173 :group 'grep)
175 (defcustom grep-find-template nil
176 "The default command to run for \\[rgrep].
177 The following place holders should be present in the string:
178 <D> - base directory for find
179 <X> - find options to restrict or expand the directory list
180 <F> - find options to limit the files matched
181 <C> - place to put -i if case insensitive grep
182 <R> - the regular expression searched for.
183 In interactive usage, the actual value of this variable is set up
184 by `grep-compute-defaults'; to change the default value, use
185 Customize or call the function `grep-apply-setting'."
186 :type '(choice string
187 (const :tag "Not Set" nil))
188 :set 'grep-apply-setting
189 :version "22.1"
190 :group 'grep)
192 (defcustom grep-files-aliases
193 '(("all" . "* .*")
194 ("el" . "*.el")
195 ("ch" . "*.[ch]")
196 ("c" . "*.c")
197 ("cc" . "*.cc *.cxx *.cpp *.C *.CC *.c++")
198 ("cchh" . "*.cc *.[ch]xx *.[ch]pp *.[CHh] *.CC *.HH *.[ch]++")
199 ("hh" . "*.hxx *.hpp *.[Hh] *.HH *.h++")
200 ("h" . "*.h")
201 ("l" . "[Cc]hange[Ll]og*")
202 ("m" . "[Mm]akefile*")
203 ("tex" . "*.tex")
204 ("texi" . "*.texi")
205 ("asm" . "*.[sS]"))
206 "Alist of aliases for the FILES argument to `lgrep' and `rgrep'."
207 :type 'alist
208 :group 'grep)
210 (defcustom grep-find-ignored-directories
211 vc-directory-exclusion-list
212 "List of names of sub-directories which `rgrep' shall not recurse into.
213 If an element is a cons cell, the car is called on the search directory
214 to determine whether cdr should not be recursed into."
215 :type '(choice (repeat :tag "Ignored directories" string)
216 (const :tag "No ignored directories" nil))
217 :group 'grep)
219 (defcustom grep-find-ignored-files
220 (cons ".#*" (delq nil (mapcar (lambda (s)
221 (unless (string-match-p "/\\'" s)
222 (concat "*" s)))
223 completion-ignored-extensions)))
224 "List of file names which `rgrep' and `lgrep' shall exclude.
225 If an element is a cons cell, the car is called on the search directory
226 to determine whether cdr should not be excluded."
227 :type '(choice (repeat :tag "Ignored file" string)
228 (const :tag "No ignored files" nil))
229 :group 'grep)
231 (defcustom grep-error-screen-columns nil
232 "If non-nil, column numbers in grep hits are screen columns.
233 See `compilation-error-screen-columns'"
234 :type '(choice (const :tag "Default" nil)
235 integer)
236 :version "22.1"
237 :group 'grep)
239 ;;;###autoload
240 (defcustom grep-setup-hook nil
241 "List of hook functions run by `grep-process-setup' (see `run-hooks')."
242 :type 'hook
243 :group 'grep)
245 (defvar grep-mode-map
246 (let ((map (make-sparse-keymap)))
247 (set-keymap-parent map compilation-minor-mode-map)
248 (define-key map " " 'scroll-up-command)
249 (define-key map [?\S-\ ] 'scroll-down-command)
250 (define-key map "\^?" 'scroll-down-command)
251 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
253 (define-key map "\r" 'compile-goto-error) ;; ?
254 (define-key map "n" 'next-error-no-select)
255 (define-key map "p" 'previous-error-no-select)
256 (define-key map "{" 'compilation-previous-file)
257 (define-key map "}" 'compilation-next-file)
258 (define-key map "\t" 'compilation-next-error)
259 (define-key map [backtab] 'compilation-previous-error)
261 ;; Set up the menu-bar
262 (define-key map [menu-bar grep]
263 (cons "Grep" (make-sparse-keymap "Grep")))
265 (define-key map [menu-bar grep compilation-kill-compilation]
266 '(menu-item "Kill Grep" kill-compilation
267 :help "Kill the currently running grep process"))
268 (define-key map [menu-bar grep compilation-separator2] '("----"))
269 (define-key map [menu-bar grep compilation-compile]
270 '(menu-item "Compile..." compile
271 :help "Compile the program including the current buffer. Default: run `make'"))
272 (define-key map [menu-bar grep compilation-rgrep]
273 '(menu-item "Recursive grep..." rgrep
274 :help "User-friendly recursive grep in directory tree"))
275 (define-key map [menu-bar grep compilation-lgrep]
276 '(menu-item "Local grep..." lgrep
277 :help "User-friendly grep in a directory"))
278 (define-key map [menu-bar grep compilation-grep-find]
279 '(menu-item "Grep via Find..." grep-find
280 :help "Run grep via find, with user-specified args"))
281 (define-key map [menu-bar grep compilation-grep]
282 '(menu-item "Another grep..." grep
283 :help "Run grep, with user-specified args, and collect output in a buffer."))
284 (define-key map [menu-bar grep compilation-recompile]
285 '(menu-item "Repeat grep" recompile
286 :help "Run grep again"))
287 (define-key map [menu-bar grep compilation-separator2] '("----"))
288 (define-key map [menu-bar grep compilation-first-error]
289 '(menu-item "First Match" first-error
290 :help "Restart at the first match, visit corresponding location"))
291 (define-key map [menu-bar grep compilation-previous-error]
292 '(menu-item "Previous Match" previous-error
293 :help "Visit the previous match and corresponding location"))
294 (define-key map [menu-bar grep compilation-next-error]
295 '(menu-item "Next Match" next-error
296 :help "Visit the next match and corresponding location"))
297 map)
298 "Keymap for grep buffers.
299 `compilation-minor-mode-map' is a cdr of this.")
301 (defvar grep-mode-tool-bar-map
302 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
303 ;; so don't do anything.
304 (when (keymapp (butlast tool-bar-map))
305 (let ((map (butlast (copy-keymap tool-bar-map)))
306 (help (last tool-bar-map))) ;; Keep Help last in tool bar
307 (tool-bar-local-item
308 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
309 :rtl "right-arrow"
310 :help "Goto previous match")
311 (tool-bar-local-item
312 "right-arrow" 'next-error-no-select 'next-error-no-select map
313 :rtl "left-arrow"
314 :help "Goto next match")
315 (tool-bar-local-item
316 "cancel" 'kill-compilation 'kill-compilation map
317 :enable '(let ((buffer (compilation-find-buffer)))
318 (get-buffer-process buffer))
319 :help "Stop grep")
320 (tool-bar-local-item
321 "refresh" 'recompile 'recompile map
322 :help "Restart grep")
323 (append map help))))
325 (defalias 'kill-grep 'kill-compilation)
327 ;;;; TODO --- refine this!!
329 ;; (defcustom grep-use-compilation-buffer t
330 ;; "When non-nil, grep specific commands update `compilation-last-buffer'.
331 ;; This means that standard compile commands like \\[next-error] and \\[compile-goto-error]
332 ;; can be used to navigate between grep matches (the default).
333 ;; Otherwise, the grep specific commands like \\[grep-next-match] must
334 ;; be used to navigate between grep matches."
335 ;; :type 'boolean
336 ;; :group 'grep)
338 ;; override compilation-last-buffer
339 (defvar grep-last-buffer nil
340 "The most recent grep buffer.
341 A grep buffer becomes most recent when you select Grep mode in it.
342 Notice that using \\[next-error] or \\[compile-goto-error] modifies
343 `compilation-last-buffer' rather than `grep-last-buffer'.")
345 ;;;###autoload
346 (defconst grep-regexp-alist
348 ;; Rule to match column numbers is commented out since no known grep
349 ;; produces them
350 ;; ("^\\(.+?\\)\\(:[ \t]*\\)\\([1-9][0-9]*\\)\\2\\(?:\\([1-9][0-9]*\\)\\(?:-\\([1-9][0-9]*\\)\\)?\\2\\)?"
351 ;; 1 3 (4 . 5))
352 ;; Note that we want to use as tight a regexp as we can to try and
353 ;; handle weird file names (with colons in them) as well as possible.
354 ;; E.g. we use [1-9][0-9]* rather than [0-9]+ so as to accept ":034:"
355 ;; in file names.
356 ("^\\(.+?\\)\\(:[ \t]*\\)\\([1-9][0-9]*\\)\\2"
358 ;; Calculate column positions (col . end-col) of first grep match on a line
359 ((lambda ()
360 (when grep-highlight-matches
361 (let* ((beg (match-end 0))
362 (end (save-excursion (goto-char beg) (line-end-position)))
363 (mbeg (text-property-any beg end 'font-lock-face grep-match-face)))
364 (when mbeg
365 (- mbeg beg)))))
367 (lambda ()
368 (when grep-highlight-matches
369 (let* ((beg (match-end 0))
370 (end (save-excursion (goto-char beg) (line-end-position)))
371 (mbeg (text-property-any beg end 'font-lock-face grep-match-face))
372 (mend (and mbeg (next-single-property-change mbeg 'font-lock-face nil end))))
373 (when mend
374 (- mend beg)))))))
375 ("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
376 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
378 (defvar grep-first-column 0 ; bug#10594
379 "Value to use for `compilation-first-column' in grep buffers.")
381 (defvar grep-error "grep hit"
382 "Message to print when no matches are found.")
384 ;; Reverse the colors because grep hits are not errors (though we jump there
385 ;; with `next-error'), and unreadable files can't be gone to.
386 (defvar grep-hit-face compilation-info-face
387 "Face name to use for grep hits.")
389 (defvar grep-error-face 'compilation-error
390 "Face name to use for grep error messages.")
392 (defvar grep-match-face 'match
393 "Face name to use for grep matches.")
395 (defvar grep-context-face 'shadow
396 "Face name to use for grep context lines.")
398 (defvar grep-mode-font-lock-keywords
399 '(;; Command output lines.
400 (": \\(.+\\): \\(?:Permission denied\\|No such \\(?:file or directory\\|device or address\\)\\)$"
401 1 grep-error-face)
402 ;; remove match from grep-regexp-alist before fontifying
403 ("^Grep[/a-zA-z]* started.*"
404 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t))
405 ("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
406 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
407 (1 compilation-info-face nil t)
408 (2 compilation-warning-face nil t))
409 ("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
410 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
411 (1 grep-error-face)
412 (2 grep-error-face nil t))
413 ;; "filename-linenumber-" format is used for context lines in GNU grep,
414 ;; "filename=linenumber=" for lines with function names in "git grep -p".
415 ("^.+?[-=][0-9]+[-=].*\n" (0 grep-context-face)))
416 "Additional things to highlight in grep output.
417 This gets tacked on the end of the generated expressions.")
419 ;;;###autoload
420 (defvar grep-program (purecopy "grep")
421 "The default grep program for `grep-command' and `grep-find-command'.
422 This variable's value takes effect when `grep-compute-defaults' is called.")
424 ;;;###autoload
425 (defvar find-program (purecopy "find")
426 "The default find program.
427 This is used by commands like `grep-find-command', `find-dired'
428 and others.")
430 ;;;###autoload
431 (defvar xargs-program (purecopy "xargs")
432 "The default xargs program for `grep-find-command'.
433 See `grep-find-use-xargs'.
434 This variable's value takes effect when `grep-compute-defaults' is called.")
436 ;;;###autoload
437 (defvar grep-find-use-xargs nil
438 "How to invoke find and grep.
439 If `exec', use `find -exec {} ;'.
440 If `exec-plus' use `find -exec {} +'.
441 If `gnu', use `find -print0' and `xargs -0'.
442 Any other value means to use `find -print' and `xargs'.
444 This variable's value takes effect when `grep-compute-defaults' is called.")
446 ;; History of grep commands.
447 ;;;###autoload
448 (defvar grep-history nil "History list for grep.")
449 ;;;###autoload
450 (defvar grep-find-history nil "History list for grep-find.")
452 ;; History of lgrep and rgrep regexp and files args.
453 (defvar grep-regexp-history nil)
454 (defvar grep-files-history nil)
456 ;;;###autoload
457 (defun grep-process-setup ()
458 "Setup compilation variables and buffer for `grep'.
459 Set up `compilation-exit-message-function' and run `grep-setup-hook'."
460 (when (eq grep-highlight-matches 'auto-detect)
461 (grep-compute-defaults))
462 (unless (or (eq grep-highlight-matches 'auto-detect)
463 (null grep-highlight-matches)
464 ;; Don't output color escapes if they can't be
465 ;; highlighted with `font-lock-face' by `grep-filter'.
466 (null font-lock-mode))
467 ;; `setenv' modifies `process-environment' let-bound in `compilation-start'
468 ;; Any TERM except "dumb" allows GNU grep to use `--color=auto'
469 (setenv "TERM" "emacs-grep")
470 (setenv "GREP_OPTIONS"
471 (concat (getenv "GREP_OPTIONS")
472 " --color=" (if (eq grep-highlight-matches 'always)
473 "always" "auto")))
474 ;; GREP_COLOR is used in GNU grep 2.5.1, but deprecated in later versions
475 (setenv "GREP_COLOR" "01;31")
476 ;; GREP_COLORS is used in GNU grep 2.5.2 and later versions
477 (setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:sl=:cx=:ne"))
478 (set (make-local-variable 'compilation-exit-message-function)
479 (lambda (status code msg)
480 (if (eq status 'exit)
481 ;; This relies on the fact that `compilation-start'
482 ;; sets buffer-modified to nil before running the command,
483 ;; so the buffer is still unmodified if there is no output.
484 (cond ((and (zerop code) (buffer-modified-p))
485 '("finished (matches found)\n" . "matched"))
486 ((not (buffer-modified-p))
487 '("finished with no matches found\n" . "no match"))
489 (cons msg code)))
490 (cons msg code))))
491 (run-hooks 'grep-setup-hook))
493 (defun grep-filter ()
494 "Handle match highlighting escape sequences inserted by the grep process.
495 This function is called from `compilation-filter-hook'."
496 (save-excursion
497 (forward-line 0)
498 (let ((end (point)) beg)
499 (goto-char compilation-filter-start)
500 (forward-line 0)
501 (setq beg (point))
502 ;; Only operate on whole lines so we don't get caught with part of an
503 ;; escape sequence in one chunk and the rest in another.
504 (when (< (point) end)
505 (setq end (copy-marker end))
506 ;; Highlight grep matches and delete marking sequences.
507 (while (re-search-forward "\033\\[0?1;31m\\(.*?\\)\033\\[[0-9]*m" end 1)
508 (replace-match (propertize (match-string 1)
509 'face nil 'font-lock-face grep-match-face)
510 t t))
511 ;; Delete all remaining escape sequences
512 (goto-char beg)
513 (while (re-search-forward "\033\\[[0-9;]*[mK]" end 1)
514 (replace-match "" t t))))))
516 (defun grep-probe (command args &optional func result)
517 (let (process-file-side-effects)
518 (equal (condition-case nil
519 (apply (or func 'process-file) command args)
520 (error nil))
521 (or result 0))))
523 ;;;###autoload
524 (defun grep-compute-defaults ()
525 ;; Keep default values.
526 (unless grep-host-defaults-alist
527 (add-to-list
528 'grep-host-defaults-alist
529 (cons nil
530 `((grep-command ,grep-command)
531 (grep-template ,grep-template)
532 (grep-use-null-device ,grep-use-null-device)
533 (grep-find-command ,grep-find-command)
534 (grep-find-template ,grep-find-template)
535 (grep-find-use-xargs ,grep-find-use-xargs)
536 (grep-highlight-matches ,grep-highlight-matches)))))
537 (let* ((host-id
538 (intern (or (file-remote-p default-directory) "localhost")))
539 (host-defaults (assq host-id grep-host-defaults-alist))
540 (defaults (assq nil grep-host-defaults-alist)))
541 ;; There are different defaults on different hosts. They must be
542 ;; computed for every host once.
543 (dolist (setting '(grep-command grep-template
544 grep-use-null-device grep-find-command
545 grep-find-template grep-find-use-xargs
546 grep-highlight-matches))
547 (set setting
548 (cadr (or (assq setting host-defaults)
549 (assq setting defaults)))))
551 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
552 (setq grep-use-null-device
553 (with-temp-buffer
554 (let ((hello-file (expand-file-name "HELLO" data-directory)))
555 (not
556 (and (if grep-command
557 ;; `grep-command' is already set, so
558 ;; use that for testing.
559 (grep-probe grep-command
560 `(nil t nil "^English" ,hello-file)
561 #'call-process-shell-command)
562 ;; otherwise use `grep-program'
563 (grep-probe grep-program
564 `(nil t nil "-nH" "^English" ,hello-file)))
565 (progn
566 (goto-char (point-min))
567 (looking-at
568 (concat (regexp-quote hello-file)
569 ":[0-9]+:English")))))))))
570 (unless (and grep-command grep-find-command
571 grep-template grep-find-template)
572 (let ((grep-options
573 (concat (if grep-use-null-device "-n" "-nH")
574 (if (grep-probe grep-program
575 `(nil nil nil "-e" "foo" ,null-device)
576 nil 1)
577 " -e"))))
578 (unless grep-command
579 (setq grep-command
580 (format "%s %s " grep-program grep-options)))
581 (unless grep-template
582 (setq grep-template
583 (format "%s <X> <C> %s <R> <F>" grep-program grep-options)))
584 (unless grep-find-use-xargs
585 (setq grep-find-use-xargs
586 (cond
587 ((grep-probe find-program
588 `(nil nil nil ,null-device "-exec" "echo"
589 "{}" "+"))
590 'exec-plus)
591 ((and
592 (grep-probe find-program `(nil nil nil ,null-device "-print0"))
593 (grep-probe xargs-program `(nil nil nil "-0" "echo")))
594 'gnu)
596 'exec))))
597 (unless grep-find-command
598 (setq grep-find-command
599 (cond ((eq grep-find-use-xargs 'gnu)
600 ;; Windows shells need the program file name
601 ;; after the pipe symbol be quoted if they use
602 ;; forward slashes as directory separators.
603 (format "%s . -type f -print0 | \"%s\" -0 %s"
604 find-program xargs-program grep-command))
605 ((memq grep-find-use-xargs '(exec exec-plus))
606 (let ((cmd0 (format "%s . -type f -exec %s"
607 find-program grep-command))
608 (null (if grep-use-null-device
609 (format "%s " null-device)
610 "")))
611 (cons
612 (if (eq grep-find-use-xargs 'exec-plus)
613 (format "%s %s{} +" cmd0 null)
614 (format "%s {} %s%s" cmd0 null
615 (shell-quote-argument ";")))
616 (1+ (length cmd0)))))
618 (format "%s . -type f -print | \"%s\" %s"
619 find-program xargs-program grep-command)))))
620 (unless grep-find-template
621 (setq grep-find-template
622 (let ((gcmd (format "%s <C> %s <R>"
623 grep-program grep-options))
624 (null (if grep-use-null-device
625 (format "%s " null-device)
626 "")))
627 (cond ((eq grep-find-use-xargs 'gnu)
628 (format "%s . <X> -type f <F> -print0 | \"%s\" -0 %s"
629 find-program xargs-program gcmd))
630 ((eq grep-find-use-xargs 'exec)
631 (format "%s . <X> -type f <F> -exec %s {} %s%s"
632 find-program gcmd null
633 (shell-quote-argument ";")))
634 ((eq grep-find-use-xargs 'exec-plus)
635 (format "%s . <X> -type f <F> -exec %s %s{} +"
636 find-program gcmd null))
638 (format "%s . <X> -type f <F> -print | \"%s\" %s"
639 find-program xargs-program gcmd))))))))
640 (when (eq grep-highlight-matches 'auto-detect)
641 (setq grep-highlight-matches
642 (with-temp-buffer
643 (and (grep-probe grep-program '(nil t nil "--help"))
644 (progn
645 (goto-char (point-min))
646 (search-forward "--color" nil t))
647 ;; Windows and DOS pipes fail `isatty' detection in Grep.
648 (if (memq system-type '(windows-nt ms-dos))
649 'always 'auto)))))
651 ;; Save defaults for this host.
652 (setq grep-host-defaults-alist
653 (delete (assq host-id grep-host-defaults-alist)
654 grep-host-defaults-alist))
655 (add-to-list
656 'grep-host-defaults-alist
657 (cons host-id
658 `((grep-command ,grep-command)
659 (grep-template ,grep-template)
660 (grep-use-null-device ,grep-use-null-device)
661 (grep-find-command ,grep-find-command)
662 (grep-find-template ,grep-find-template)
663 (grep-find-use-xargs ,grep-find-use-xargs)
664 (grep-highlight-matches ,grep-highlight-matches))))))
666 (defun grep-tag-default ()
667 (or (and transient-mark-mode mark-active
668 (/= (point) (mark))
669 (buffer-substring-no-properties (point) (mark)))
670 (funcall (or find-tag-default-function
671 (get major-mode 'find-tag-default-function)
672 'find-tag-default))
673 ""))
675 (defun grep-default-command ()
676 "Compute the default grep command for \\[universal-argument] \\[grep] to offer."
677 (let ((tag-default (shell-quote-argument (grep-tag-default)))
678 ;; This a regexp to match single shell arguments.
679 ;; Could someone please add comments explaining it?
680 (sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
681 (grep-default (or (car grep-history) grep-command)))
682 ;; In the default command, find the arg that specifies the pattern.
683 (when (or (string-match
684 (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
685 sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
686 grep-default)
687 ;; If the string is not yet complete.
688 (string-match "\\(\\)\\'" grep-default))
689 ;; Maybe we will replace the pattern with the default tag.
690 ;; But first, maybe replace the file name pattern.
691 (condition-case nil
692 (unless (or (not (stringp buffer-file-name))
693 (when (match-beginning 2)
694 (save-match-data
695 (string-match
696 (wildcard-to-regexp
697 (file-name-nondirectory
698 (match-string 3 grep-default)))
699 (file-name-nondirectory buffer-file-name)))))
700 (setq grep-default (concat (substring grep-default
701 0 (match-beginning 2))
702 " *."
703 (file-name-extension buffer-file-name))))
704 ;; In case wildcard-to-regexp gets an error
705 ;; from invalid data.
706 (error nil))
707 ;; Now replace the pattern with the default tag.
708 (replace-match tag-default t t grep-default 1))))
711 ;;;###autoload
712 (define-compilation-mode grep-mode "Grep"
713 "Sets `grep-last-buffer' and `compilation-window-height'."
714 (setq grep-last-buffer (current-buffer))
715 (set (make-local-variable 'tool-bar-map) grep-mode-tool-bar-map)
716 (set (make-local-variable 'compilation-error-face)
717 grep-hit-face)
718 (set (make-local-variable 'compilation-error-regexp-alist)
719 grep-regexp-alist)
720 ;; compilation-directory-matcher can't be nil, so we set it to a regexp that
721 ;; can never match.
722 (set (make-local-variable 'compilation-directory-matcher) '("\\`a\\`"))
723 (set (make-local-variable 'compilation-process-setup-function)
724 'grep-process-setup)
725 (set (make-local-variable 'compilation-disable-input) t)
726 (set (make-local-variable 'compilation-error-screen-columns)
727 grep-error-screen-columns)
728 (add-hook 'compilation-filter-hook 'grep-filter nil t))
731 ;;;###autoload
732 (defun grep (command-args)
733 "Run grep, with user-specified args, and collect output in a buffer.
734 While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
735 or \\<grep-mode-map>\\[compile-goto-error] in the *grep* \
736 buffer, to go to the lines where grep found
737 matches. To kill the grep job before it finishes, type \\[kill-compilation].
739 For doing a recursive `grep', see the `rgrep' command. For running
740 `grep' in a specific directory, see `lgrep'.
742 This command uses a special history list for its COMMAND-ARGS, so you
743 can easily repeat a grep command.
745 A prefix argument says to default the argument based upon the current
746 tag the cursor is over, substituting it into the last grep command
747 in the grep command history (or into `grep-command' if that history
748 list is empty)."
749 (interactive
750 (progn
751 (grep-compute-defaults)
752 (let ((default (grep-default-command)))
753 (list (read-shell-command "Run grep (like this): "
754 (if current-prefix-arg default grep-command)
755 'grep-history
756 (if current-prefix-arg nil default))))))
758 ;; Setting process-setup-function makes exit-message-function work
759 ;; even when async processes aren't supported.
760 (compilation-start (if (and grep-use-null-device null-device)
761 (concat command-args " " null-device)
762 command-args)
763 'grep-mode))
766 ;;;###autoload
767 (defun grep-find (command-args)
768 "Run grep via find, with user-specified args COMMAND-ARGS.
769 Collect output in a buffer.
770 While find runs asynchronously, you can use the \\[next-error] command
771 to find the text that grep hits refer to.
773 This command uses a special history list for its arguments, so you can
774 easily repeat a find command."
775 (interactive
776 (progn
777 (grep-compute-defaults)
778 (if grep-find-command
779 (list (read-shell-command "Run find (like this): "
780 grep-find-command 'grep-find-history))
781 ;; No default was set
782 (read-string
783 "compile.el: No `grep-find-command' command available. Press RET.")
784 (list nil))))
785 (when command-args
786 (let ((null-device nil)) ; see grep
787 (grep command-args))))
789 ;;;###autoload
790 (defalias 'find-grep 'grep-find)
793 ;; User-friendly interactive API.
795 (defconst grep-expand-keywords
796 '(("<C>" . (and cf (isearch-no-upper-case-p regexp t) "-i"))
797 ("<D>" . dir)
798 ("<F>" . files)
799 ("<N>" . null-device)
800 ("<X>" . excl)
801 ("<R>" . (shell-quote-argument (or regexp ""))))
802 "List of substitutions performed by `grep-expand-template'.
803 If car of an element matches, the cdr is evalled in to get the
804 substitution string. Note dynamic scoping of variables.")
806 (defun grep-expand-template (template &optional regexp files dir excl)
807 "Patch grep COMMAND string replacing <C>, <D>, <F>, <R>, and <X>."
808 (let ((command template)
809 (cf case-fold-search)
810 (case-fold-search nil))
811 (dolist (kw grep-expand-keywords command)
812 (if (string-match (car kw) command)
813 (setq command
814 (replace-match
815 (or (if (symbolp (cdr kw))
816 (symbol-value (cdr kw))
817 (save-match-data (eval (cdr kw))))
819 t t command))))))
821 (defun grep-read-regexp ()
822 "Read regexp arg for interactive grep using `read-regexp'."
823 (read-regexp "Search for" 'grep-tag-default 'grep-regexp-history))
825 (defun grep-read-files (regexp)
826 "Read files arg for interactive grep."
827 (let* ((bn (or (buffer-file-name)
828 (replace-regexp-in-string "<[0-9]+>\\'" "" (buffer-name))))
829 (fn (and bn
830 (stringp bn)
831 (file-name-nondirectory bn)))
832 (default-alias
833 (and fn
834 (let ((aliases (remove (assoc "all" grep-files-aliases)
835 grep-files-aliases))
836 alias)
837 (while aliases
838 (setq alias (car aliases)
839 aliases (cdr aliases))
840 (if (string-match (mapconcat
841 'wildcard-to-regexp
842 (split-string (cdr alias) nil t)
843 "\\|")
845 (setq aliases nil)
846 (setq alias nil)))
847 (cdr alias))))
848 (default-extension
849 (and fn
850 (let ((ext (file-name-extension fn)))
851 (and ext (concat "*." ext)))))
852 (default
853 (or default-alias
854 default-extension
855 (car grep-files-history)
856 (car (car grep-files-aliases))))
857 (files (completing-read
858 (concat "Search for \"" regexp
859 "\" in files"
860 (if default (concat " (default " default ")"))
861 ": ")
862 'read-file-name-internal
863 nil nil nil 'grep-files-history
864 (delete-dups
865 (delq nil (append (list default default-alias default-extension)
866 (mapcar 'car grep-files-aliases)))))))
867 (and files
868 (or (cdr (assoc files grep-files-aliases))
869 files))))
871 ;;;###autoload
872 (defun lgrep (regexp &optional files dir confirm)
873 "Run grep, searching for REGEXP in FILES in directory DIR.
874 The search is limited to file names matching shell pattern FILES.
875 FILES may use abbreviations defined in `grep-files-aliases', e.g.
876 entering `ch' is equivalent to `*.[ch]'.
878 With \\[universal-argument] prefix, you can edit the constructed shell command line
879 before it is executed.
880 With two \\[universal-argument] prefixes, directly edit and run `grep-command'.
882 Collect output in a buffer. While grep runs asynchronously, you
883 can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
884 in the grep output buffer,
885 to go to the lines where grep found matches.
887 This command shares argument histories with \\[rgrep] and \\[grep]."
888 (interactive
889 (progn
890 (grep-compute-defaults)
891 (cond
892 ((and grep-command (equal current-prefix-arg '(16)))
893 (list (read-from-minibuffer "Run: " grep-command
894 nil nil 'grep-history)))
895 ((not grep-template)
896 (error "grep.el: No `grep-template' available"))
897 (t (let* ((regexp (grep-read-regexp))
898 (files (grep-read-files regexp))
899 (dir (read-directory-name "In directory: "
900 nil default-directory t))
901 (confirm (equal current-prefix-arg '(4))))
902 (list regexp files dir confirm))))))
903 (when (and (stringp regexp) (> (length regexp) 0))
904 (unless (and dir (file-directory-p dir) (file-readable-p dir))
905 (setq dir default-directory))
906 (let ((command regexp))
907 (if (null files)
908 (if (string= command grep-command)
909 (setq command nil))
910 (setq dir (file-name-as-directory (expand-file-name dir)))
911 (setq command (grep-expand-template
912 grep-template
913 regexp
914 files
916 (and grep-find-ignored-files
917 (concat " --exclude="
918 (mapconcat
919 #'(lambda (ignore)
920 (cond ((stringp ignore)
921 (shell-quote-argument ignore))
922 ((consp ignore)
923 (and (funcall (car ignore) dir)
924 (shell-quote-argument
925 (cdr ignore))))))
926 grep-find-ignored-files
927 " --exclude=")))))
928 (when command
929 (if confirm
930 (setq command
931 (read-from-minibuffer "Confirm: "
932 command nil nil 'grep-history))
933 (add-to-history 'grep-history command))))
934 (when command
935 (let ((default-directory dir))
936 ;; Setting process-setup-function makes exit-message-function work
937 ;; even when async processes aren't supported.
938 (compilation-start (if (and grep-use-null-device null-device)
939 (concat command " " null-device)
940 command)
941 'grep-mode))
942 (if (eq next-error-last-buffer (current-buffer))
943 (setq default-directory dir))))))
946 (defvar find-name-arg) ; not autoloaded but defined in find-dired
948 ;;;###autoload
949 (defun rgrep (regexp &optional files dir confirm)
950 "Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
951 The search is limited to file names matching shell pattern FILES.
952 FILES may use abbreviations defined in `grep-files-aliases', e.g.
953 entering `ch' is equivalent to `*.[ch]'.
955 With \\[universal-argument] prefix, you can edit the constructed shell command line
956 before it is executed.
957 With two \\[universal-argument] prefixes, directly edit and run `grep-find-command'.
959 Collect output in a buffer. While the recursive grep is running,
960 you can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
961 in the grep output buffer,
962 to visit the lines where matches were found. To kill the job
963 before it finishes, type \\[kill-compilation].
965 This command shares argument histories with \\[lgrep] and \\[grep-find].
967 When called programmatically and FILES is nil, REGEXP is expected
968 to specify a command to run."
969 (interactive
970 (progn
971 (grep-compute-defaults)
972 (cond
973 ((and grep-find-command (equal current-prefix-arg '(16)))
974 (list (read-from-minibuffer "Run: " grep-find-command
975 nil nil 'grep-find-history)))
976 ((not grep-find-template)
977 (error "grep.el: No `grep-find-template' available"))
978 (t (let* ((regexp (grep-read-regexp))
979 (files (grep-read-files regexp))
980 (dir (read-directory-name "Base directory: "
981 nil default-directory t))
982 (confirm (equal current-prefix-arg '(4))))
983 (list regexp files dir confirm))))))
984 (when (and (stringp regexp) (> (length regexp) 0))
985 (unless (and dir (file-directory-p dir) (file-readable-p dir))
986 (setq dir default-directory))
987 (if (null files)
988 (if (not (string= regexp (if (consp grep-find-command)
989 (car grep-find-command)
990 grep-find-command)))
991 (compilation-start regexp 'grep-mode))
992 (setq dir (file-name-as-directory (expand-file-name dir)))
993 (require 'find-dired) ; for `find-name-arg'
994 (let ((command (grep-expand-template
995 grep-find-template
996 regexp
997 (concat (shell-quote-argument "(")
998 " " find-name-arg " "
999 (mapconcat
1000 #'shell-quote-argument
1001 (split-string files)
1002 (concat " -o " find-name-arg " "))
1004 (shell-quote-argument ")"))
1006 (concat
1007 (and grep-find-ignored-directories
1008 (concat "-type d "
1009 (shell-quote-argument "(")
1010 ;; we should use shell-quote-argument here
1011 " -path "
1012 (mapconcat
1013 #'(lambda (ignore)
1014 (cond ((stringp ignore)
1015 (shell-quote-argument
1016 (concat "*/" ignore)))
1017 ((consp ignore)
1018 (and (funcall (car ignore) dir)
1019 (shell-quote-argument
1020 (concat "*/"
1021 (cdr ignore)))))))
1022 grep-find-ignored-directories
1023 " -o -path ")
1025 (shell-quote-argument ")")
1026 " -prune -o "))
1027 (and grep-find-ignored-files
1028 (concat (shell-quote-argument "!") " -type d "
1029 (shell-quote-argument "(")
1030 ;; we should use shell-quote-argument here
1031 " -name "
1032 (mapconcat
1033 #'(lambda (ignore)
1034 (cond ((stringp ignore)
1035 (shell-quote-argument ignore))
1036 ((consp ignore)
1037 (and (funcall (car ignore) dir)
1038 (shell-quote-argument
1039 (cdr ignore))))))
1040 grep-find-ignored-files
1041 " -o -name ")
1043 (shell-quote-argument ")")
1044 " -prune -o "))))))
1045 (when command
1046 (if confirm
1047 (setq command
1048 (read-from-minibuffer "Confirm: "
1049 command nil nil 'grep-find-history))
1050 (add-to-history 'grep-find-history command))
1051 (let ((default-directory dir))
1052 (compilation-start command 'grep-mode))
1053 ;; Set default-directory if we started rgrep in the *grep* buffer.
1054 (if (eq next-error-last-buffer (current-buffer))
1055 (setq default-directory dir)))))))
1057 ;;;###autoload
1058 (defun zrgrep (regexp &optional files dir confirm grep-find-template)
1059 "Recursively grep for REGEXP in gzipped FILES in tree rooted at DIR.
1060 Like `rgrep' but uses `zgrep' for `grep-program', sets the default
1061 file name to `*.gz', and sets `grep-highlight-matches' to `always'."
1062 (interactive
1063 (progn
1064 ;; Compute standard default values.
1065 (grep-compute-defaults)
1066 ;; Compute the default zrgrep command by running `grep-compute-defaults'
1067 ;; for grep program "zgrep", but not changing global values.
1068 (let ((grep-program "zgrep")
1069 ;; Don't change global values for variables computed
1070 ;; by `grep-compute-defaults'.
1071 (grep-find-template nil)
1072 (grep-find-command nil)
1073 (grep-host-defaults-alist nil)
1074 ;; Use for `grep-read-files'
1075 (grep-files-aliases '(("all" . "* .*")
1076 ("gz" . "*.gz"))))
1077 ;; Recompute defaults using let-bound values above.
1078 (grep-compute-defaults)
1079 (cond
1080 ((and grep-find-command (equal current-prefix-arg '(16)))
1081 (list (read-from-minibuffer "Run: " grep-find-command
1082 nil nil 'grep-find-history)))
1083 ((not grep-find-template)
1084 (error "grep.el: No `grep-find-template' available"))
1085 (t (let* ((regexp (grep-read-regexp))
1086 (files (grep-read-files regexp))
1087 (dir (read-directory-name "Base directory: "
1088 nil default-directory t))
1089 (confirm (equal current-prefix-arg '(4))))
1090 (list regexp files dir confirm grep-find-template)))))))
1091 ;; Set `grep-highlight-matches' to `always'
1092 ;; since `zgrep' puts filters in the grep output.
1093 (let ((grep-highlight-matches 'always))
1094 ;; `rgrep' uses the dynamically bound value `grep-find-template'
1095 ;; from the argument `grep-find-template' whose value is computed
1096 ;; in the `interactive' spec.
1097 (rgrep regexp files dir confirm)))
1099 ;;;###autoload
1100 (defalias 'rzgrep 'zrgrep)
1102 (provide 'grep)
1104 ;;; grep.el ends here