1 ;;; grep.el --- run `grep' and display the results -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2016 Free Software
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/>.
27 ;; This package provides the grep facilities documented in the Emacs
36 "Run `grep' and display the results."
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
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))
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)
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 adds the --color option in front of
81 any explicit grep options before starting the grep.
83 When this option is `auto', grep uses `--color' to highlight
84 matches only when it outputs to a terminal (when `grep' is the last
85 command in the pipe), thus avoiding the use of any potentially-harmful
86 escape sequences when standard output goes to a file or pipe.
88 To make grep highlight matches even into a pipe, you need the option
89 `always' that forces grep to use `--color=always' to unconditionally
90 output escape sequences.
92 In interactive usage, the actual value of this variable is set up
93 by `grep-compute-defaults' when the default value is `auto-detect'.
94 To change the default value, use Customize or call the function
95 `grep-apply-setting'."
96 :type '(choice (const :tag "Do not highlight matches with grep markers" nil)
97 (const :tag "Highlight matches with grep markers" t)
98 (const :tag "Use --color=always" always)
99 (const :tag "Use --color" auto)
100 (other :tag "Not Set" auto-detect))
101 :set 'grep-apply-setting
105 (defcustom grep-scroll-output nil
106 "Non-nil to scroll the *grep* buffer window as output appears.
108 Setting it causes the grep commands to put point at the end of their
109 output window so that the end of the output is always visible rather
116 (defcustom grep-command nil
117 "The default grep command for \\[grep].
118 If the grep program used supports an option to always include file names
119 in its output (such as the `-H' option to GNU grep), it's a good idea to
120 include it when specifying `grep-command'.
122 In interactive usage, the actual value of this variable is set up
123 by `grep-compute-defaults'; to change the default value, use
124 Customize or call the function `grep-apply-setting'."
125 :type '(choice string
126 (const :tag "Not Set" nil))
127 :set 'grep-apply-setting
130 (defcustom grep-template nil
131 "The default command to run for \\[lgrep].
132 The following place holders should be present in the string:
133 <C> - place to put the options like -i and --color.
134 <F> - file names and wildcards to search.
135 <X> - file names and wildcards to exclude.
136 <R> - the regular expression searched for.
137 <N> - place to insert null-device.
139 In interactive usage, the actual value of this variable is set up
140 by `grep-compute-defaults'; to change the default value, use
141 Customize or call the function `grep-apply-setting'."
142 :type '(choice string
143 (const :tag "Not Set" nil))
144 :set 'grep-apply-setting
148 (defcustom grep-use-null-device 'auto-detect
149 "If t, append the value of `null-device' to `grep' commands.
150 This is done to ensure that the output of grep includes the filename of
151 any match in the case where only a single file is searched, and is not
152 necessary if the grep program used supports the `-H' option.
154 In interactive usage, the actual value of this variable is set up
155 by `grep-compute-defaults'; to change the default value, use
156 Customize or call the function `grep-apply-setting'."
157 :type '(choice (const :tag "Do Not Append Null Device" nil)
158 (const :tag "Append Null Device" t)
159 (other :tag "Not Set" auto-detect))
160 :set 'grep-apply-setting
164 (defcustom grep-find-command nil
165 "The default find command for \\[grep-find].
166 In interactive usage, the actual value of this variable is set up
167 by `grep-compute-defaults'; to change the default value, use
168 Customize or call the function `grep-apply-setting'."
169 :type '(choice string
170 (const :tag "Not Set" nil))
171 :set 'grep-apply-setting
174 (defcustom grep-find-template nil
175 "The default command to run for \\[rgrep].
176 The following place holders should be present in the string:
177 <D> - base directory for find
178 <X> - find options to restrict or expand the directory list
179 <F> - find options to limit the files matched
180 <C> - place to put the grep options like -i and --color
181 <R> - the regular expression searched for.
182 In interactive usage, the actual value of this variable is set up
183 by `grep-compute-defaults'; to change the default value, use
184 Customize or call the function `grep-apply-setting'."
185 :type '(choice string
186 (const :tag "Not Set" nil))
187 :set 'grep-apply-setting
191 (defcustom grep-files-aliases
192 '(("all" . "* .[!.]* ..?*") ;; Don't match `..'. See bug#22577
196 ("cc" . "*.cc *.cxx *.cpp *.C *.CC *.c++")
197 ("cchh" . "*.cc *.[ch]xx *.[ch]pp *.[CHh] *.CC *.HH *.[ch]++")
198 ("hh" . "*.hxx *.hpp *.[Hh] *.HH *.h++")
200 ("l" . "[Cc]hange[Ll]og*")
201 ("m" . "[Mm]akefile*")
205 "Alist of aliases for the FILES argument to `lgrep' and `rgrep'."
209 (defcustom grep-find-ignored-directories
210 vc-directory-exclusion-list
211 "List of names of sub-directories which `rgrep' shall not recurse into.
212 If an element is a cons cell, the car is called on the search directory
213 to determine whether cdr should not be recursed into."
214 :type '(choice (repeat :tag "Ignored directories" string)
215 (const :tag "No ignored directories" nil))
218 (defcustom grep-find-ignored-files
219 (cons ".#*" (delq nil (mapcar (lambda (s)
220 (unless (string-match-p "/\\'" s)
222 completion-ignored-extensions)))
223 "List of file names which `rgrep' and `lgrep' shall exclude.
224 If an element is a cons cell, the car is called on the search directory
225 to determine whether cdr should not be excluded."
226 :type '(choice (repeat :tag "Ignored file" string)
227 (const :tag "No ignored files" nil))
230 (defcustom grep-save-buffers 'ask
231 "If non-nil, save buffers before running the grep commands.
232 If `ask', ask before saving. If a function, call it with no arguments
233 with each buffer current, as a predicate to determine whether that
234 buffer should be saved or not. E.g., one can set this to
236 (string-prefix-p my-grep-root (file-truename (buffer-file-name))))
237 to limit saving to files located under `my-grep-root'."
240 (const :tag "Ask before saving" ask)
241 (const :tag "Don't save buffers" nil)
243 (other :tag "Save all buffers" t))
246 (defcustom grep-error-screen-columns nil
247 "If non-nil, column numbers in grep hits are screen columns.
248 See `compilation-error-screen-columns'"
249 :type '(choice (const :tag "Default" nil)
255 (defcustom grep-setup-hook nil
256 "List of hook functions run by `grep-process-setup' (see `run-hooks')."
260 (defvar grep-mode-map
261 (let ((map (make-sparse-keymap)))
262 (set-keymap-parent map compilation-minor-mode-map)
263 (define-key map " " 'scroll-up-command)
264 (define-key map [?\S-\ ] 'scroll-down-command)
265 (define-key map "\^?" 'scroll-down-command)
266 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
268 (define-key map "\r" 'compile-goto-error) ;; ?
269 (define-key map "n" 'next-error-no-select)
270 (define-key map "p" 'previous-error-no-select)
271 (define-key map "{" 'compilation-previous-file)
272 (define-key map "}" 'compilation-next-file)
273 (define-key map "\t" 'compilation-next-error)
274 (define-key map "r" 'grep-forward-history)
275 (define-key map "l" 'grep-backward-history)
276 (define-key map [backtab] 'compilation-previous-error)
278 ;; Set up the menu-bar
279 (define-key map [menu-bar grep]
280 (cons "Grep" (make-sparse-keymap "Grep")))
282 (define-key map [menu-bar grep compilation-kill-compilation]
283 '(menu-item "Kill Grep" kill-compilation
284 :help "Kill the currently running grep process"))
285 (define-key map [menu-bar grep compilation-separator2] '("----"))
286 (define-key map [menu-bar grep compilation-compile]
287 '(menu-item "Compile..." compile
288 :help "Compile the program including the current buffer. Default: run `make'"))
289 (define-key map [menu-bar grep compilation-rgrep]
290 '(menu-item "Recursive grep..." rgrep
291 :help "User-friendly recursive grep in directory tree"))
292 (define-key map [menu-bar grep compilation-lgrep]
293 '(menu-item "Local grep..." lgrep
294 :help "User-friendly grep in a directory"))
295 (define-key map [menu-bar grep compilation-grep-find]
296 '(menu-item "Grep via Find..." grep-find
297 :help "Run grep via find, with user-specified args"))
298 (define-key map [menu-bar grep compilation-grep]
299 '(menu-item "Another grep..." grep
300 :help "Run grep, with user-specified args, and collect output in a buffer."))
301 (define-key map [menu-bar grep compilation-recompile]
302 '(menu-item "Repeat grep" recompile
303 :help "Run grep again"))
304 (define-key map [menu-bar grep compilation-separator2] '("----"))
305 (define-key map [menu-bar grep compilation-first-error]
306 '(menu-item "First Match" first-error
307 :help "Restart at the first match, visit corresponding location"))
308 (define-key map [menu-bar grep compilation-previous-error]
309 '(menu-item "Previous Match" previous-error
310 :help "Visit the previous match and corresponding location"))
311 (define-key map [menu-bar grep compilation-next-error]
312 '(menu-item "Next Match" next-error
313 :help "Visit the next match and corresponding location"))
314 (define-key map [menu-bar grep grep-backward-history]
315 '(menu-item "Previous Command" grep-backward-history
316 :help "Run the previous grep command from the command history"))
317 (define-key map [menu-bar grep grep-forward-history]
318 '(menu-item "Next Command" grep-forward-history
319 :help "Run the next grep command from the command history"))
321 "Keymap for grep buffers.
322 `compilation-minor-mode-map' is a cdr of this.")
324 (defvar grep-mode-tool-bar-map
325 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
326 ;; so don't do anything.
327 (when (keymapp (butlast tool-bar-map))
328 (let ((map (butlast (copy-keymap tool-bar-map)))
329 (help (last tool-bar-map))) ;; Keep Help last in tool bar
331 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
333 :help "Goto previous match")
335 "right-arrow" 'next-error-no-select 'next-error-no-select map
337 :help "Goto next match")
339 "cancel" 'kill-compilation 'kill-compilation map
340 :enable '(let ((buffer (compilation-find-buffer)))
341 (get-buffer-process buffer))
344 "refresh" 'recompile 'recompile map
345 :help "Restart grep")
348 (defalias 'kill-grep 'kill-compilation)
350 ;;;; TODO --- refine this!!
352 ;; (defcustom grep-use-compilation-buffer t
353 ;; "When non-nil, grep specific commands update `compilation-last-buffer'.
354 ;; This means that standard compile commands like \\[next-error] and \\[compile-goto-error]
355 ;; can be used to navigate between grep matches (the default).
356 ;; Otherwise, the grep specific commands like \\[grep-next-match] must
357 ;; be used to navigate between grep matches."
361 ;; override compilation-last-buffer
362 (defvar grep-last-buffer nil
363 "The most recent grep buffer.
364 A grep buffer becomes most recent when you select Grep mode in it.
365 Notice that using \\[next-error] or \\[compile-goto-error] modifies
366 `compilation-last-buffer' rather than `grep-last-buffer'.")
369 (defconst grep-regexp-alist
371 ;; Use a tight regexp to handle weird file names (with colons
372 ;; in them) as well as possible. E.g., use [1-9][0-9]* rather
373 ;; than [0-9]+ so as to accept ":034:" in file names.
374 ("^\\(.*?[^/\n]\\):[ \t]*\\([1-9][0-9]*\\)[ \t]*:"
376 ;; Calculate column positions (col . end-col) of first grep match on a line
378 (when grep-highlight-matches
379 (let* ((beg (match-end 0))
380 (end (save-excursion (goto-char beg) (line-end-position)))
381 (mbeg (text-property-any beg end 'font-lock-face grep-match-face)))
386 (when grep-highlight-matches
387 (let* ((beg (match-end 0))
388 (end (save-excursion (goto-char beg) (line-end-position)))
389 (mbeg (text-property-any beg end 'font-lock-face grep-match-face))
390 (mend (and mbeg (next-single-property-change mbeg 'font-lock-face nil end))))
393 ("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
394 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
396 (defvar grep-first-column 0 ; bug#10594
397 "Value to use for `compilation-first-column' in grep buffers.")
399 (defvar grep-error "grep hit"
400 "Message to print when no matches are found.")
402 ;; Reverse the colors because grep hits are not errors (though we jump there
403 ;; with `next-error'), and unreadable files can't be gone to.
404 (defvar grep-hit-face compilation-info-face
405 "Face name to use for grep hits.")
407 (defvar grep-error-face 'compilation-error
408 "Face name to use for grep error messages.")
410 (defvar grep-match-face 'match
411 "Face name to use for grep matches.")
413 (defvar grep-context-face 'shadow
414 "Face name to use for grep context lines.")
416 (defvar grep-mode-font-lock-keywords
417 '(;; Command output lines.
418 (": \\(.+\\): \\(?:Permission denied\\|No such \\(?:file or directory\\|device or address\\)\\)$"
420 ;; remove match from grep-regexp-alist before fontifying
421 ("^Grep[/a-zA-z]* started.*"
422 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t))
423 ("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
424 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
425 (1 compilation-info-face nil t)
426 (2 compilation-warning-face nil t))
427 ("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
428 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
430 (2 grep-error-face nil t))
431 ;; "filename-linenumber-" format is used for context lines in GNU grep,
432 ;; "filename=linenumber=" for lines with function names in "git grep -p".
433 ("^.+?[-=][0-9]+[-=].*\n" (0 grep-context-face)))
434 "Additional things to highlight in grep output.
435 This gets tacked on the end of the generated expressions.")
438 (defvar grep-program (purecopy "grep")
439 "The default grep program for `grep-command' and `grep-find-command'.
440 This variable's value takes effect when `grep-compute-defaults' is called.")
443 (defvar find-program (purecopy "find")
444 "The default find program.
445 This is used by commands like `grep-find-command', `find-dired'
449 (defvar xargs-program (purecopy "xargs")
450 "The default xargs program for `grep-find-command'.
451 See `grep-find-use-xargs'.
452 This variable's value takes effect when `grep-compute-defaults' is called.")
455 (defvar grep-find-use-xargs nil
456 "How to invoke find and grep.
457 If `exec', use `find -exec {} ;'.
458 If `exec-plus' use `find -exec {} +'.
459 If `gnu', use `find -print0' and `xargs -0'.
460 Any other value means to use `find -print' and `xargs'.
462 This variable's value takes effect when `grep-compute-defaults' is called.")
464 ;; History of grep commands.
466 (defvar grep-history nil "History list for grep.")
468 (defvar grep-find-history nil "History list for grep-find.")
470 ;; History of lgrep and rgrep regexp and files args.
471 (defvar grep-regexp-history nil)
472 (defvar grep-files-history nil)
475 (defun grep-process-setup ()
476 "Setup compilation variables and buffer for `grep'.
477 Set up `compilation-exit-message-function' and run `grep-setup-hook'."
478 (when (eq grep-highlight-matches 'auto-detect)
479 (grep-compute-defaults))
480 (unless (or (eq grep-highlight-matches 'auto-detect)
481 (null grep-highlight-matches)
482 ;; Don't output color escapes if they can't be
483 ;; highlighted with `font-lock-face' by `grep-filter'.
484 (null font-lock-mode))
485 ;; `setenv' modifies `process-environment' let-bound in `compilation-start'
486 ;; Any TERM except "dumb" allows GNU grep to use `--color=auto'
487 (setenv "TERM" "emacs-grep")
488 ;; GREP_COLOR is used in GNU grep 2.5.1, but deprecated in later versions
489 (setenv "GREP_COLOR" "01;31")
490 ;; GREP_COLORS is used in GNU grep 2.5.2 and later versions
491 (setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:sl=:cx=:ne"))
492 (set (make-local-variable 'compilation-exit-message-function)
493 (lambda (status code msg)
494 (if (eq status 'exit)
495 ;; This relies on the fact that `compilation-start'
496 ;; sets buffer-modified to nil before running the command,
497 ;; so the buffer is still unmodified if there is no output.
498 (cond ((and (zerop code) (buffer-modified-p))
499 '("finished (matches found)\n" . "matched"))
500 ((not (buffer-modified-p))
501 '("finished with no matches found\n" . "no match"))
505 (run-hooks 'grep-setup-hook))
507 (defun grep-filter ()
508 "Handle match highlighting escape sequences inserted by the grep process.
509 This function is called from `compilation-filter-hook'."
512 (let ((end (point)) beg)
513 (goto-char compilation-filter-start)
516 ;; Only operate on whole lines so we don't get caught with part of an
517 ;; escape sequence in one chunk and the rest in another.
518 (when (< (point) end)
519 (setq end (copy-marker end))
520 ;; Highlight grep matches and delete marking sequences.
521 (while (re-search-forward "\033\\[0?1;31m\\(.*?\\)\033\\[[0-9]*m" end 1)
522 (replace-match (propertize (match-string 1)
523 'face nil 'font-lock-face grep-match-face)
525 ;; Delete all remaining escape sequences
527 (while (re-search-forward "\033\\[[0-9;]*[mK]" end 1)
528 (replace-match "" t t))))))
530 (defun grep-probe (command args &optional func result)
531 (let (process-file-side-effects)
532 (equal (condition-case nil
533 (apply (or func 'process-file) command args)
538 (defun grep-compute-defaults ()
539 ;; Keep default values.
540 (unless grep-host-defaults-alist
542 'grep-host-defaults-alist
544 `((grep-command ,grep-command)
545 (grep-template ,grep-template)
546 (grep-use-null-device ,grep-use-null-device)
547 (grep-find-command ,grep-find-command)
548 (grep-find-template ,grep-find-template)
549 (grep-find-use-xargs ,grep-find-use-xargs)
550 (grep-highlight-matches ,grep-highlight-matches)))))
552 (intern (or (file-remote-p default-directory) "localhost")))
553 (host-defaults (assq host-id grep-host-defaults-alist))
554 (defaults (assq nil grep-host-defaults-alist)))
555 ;; There are different defaults on different hosts. They must be
556 ;; computed for every host once.
557 (dolist (setting '(grep-command grep-template
558 grep-use-null-device grep-find-command
559 grep-find-template grep-find-use-xargs
560 grep-highlight-matches))
562 (cadr (or (assq setting host-defaults)
563 (assq setting defaults)))))
565 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
566 (setq grep-use-null-device
568 (let ((hello-file (expand-file-name "HELLO" data-directory)))
570 (and (if grep-command
571 ;; `grep-command' is already set, so
572 ;; use that for testing.
573 (grep-probe grep-command
574 `(nil t nil "^English" ,hello-file)
575 #'call-process-shell-command)
576 ;; otherwise use `grep-program'
577 (grep-probe grep-program
578 `(nil t nil "-nH" "^English" ,hello-file)))
580 (goto-char (point-min))
582 (concat (regexp-quote hello-file)
583 ":[0-9]+:English")))))))))
585 (when (eq grep-highlight-matches 'auto-detect)
586 (setq grep-highlight-matches
588 (and (grep-probe grep-program '(nil t nil "--help"))
590 (goto-char (point-min))
591 (search-forward "--color" nil t))
592 ;; Windows and DOS pipes fail `isatty' detection in Grep.
593 (if (memq system-type '(windows-nt ms-dos))
596 (unless (and grep-command grep-find-command
597 grep-template grep-find-template)
599 (concat (if grep-use-null-device "-n" "-nH")
600 (if (grep-probe grep-program
601 `(nil nil nil "-e" "foo" ,null-device)
606 (format "%s %s %s " grep-program
608 (and grep-highlight-matches
609 (grep-probe grep-program
610 `(nil nil nil "--color" "x" ,null-device)
612 (if (eq grep-highlight-matches 'always)
613 "--color=always" "--color"))
616 (unless grep-template
618 (format "%s <X> <C> %s <R> <F>" grep-program grep-options)))
619 (unless grep-find-use-xargs
620 (setq grep-find-use-xargs
622 ((grep-probe find-program
623 `(nil nil nil ,null-device "-exec" "echo"
627 (grep-probe find-program `(nil nil nil ,null-device "-print0"))
628 (grep-probe xargs-program `(nil nil nil "-0" "echo")))
632 (unless grep-find-command
633 (setq grep-find-command
634 (cond ((eq grep-find-use-xargs 'gnu)
635 ;; Windows shells need the program file name
636 ;; after the pipe symbol be quoted if they use
637 ;; forward slashes as directory separators.
638 (format "%s . -type f -print0 | \"%s\" -0 %s"
639 find-program xargs-program grep-command))
640 ((memq grep-find-use-xargs '(exec exec-plus))
641 (let ((cmd0 (format "%s . -type f -exec %s"
642 find-program grep-command))
643 (null (if grep-use-null-device
644 (format "%s " null-device)
647 (if (eq grep-find-use-xargs 'exec-plus)
648 (format "%s %s{} +" cmd0 null)
649 (format "%s {} %s%s" cmd0 null
650 (shell-quote-argument ";")))
651 (1+ (length cmd0)))))
653 (format "%s . -type f -print | \"%s\" %s"
654 find-program xargs-program grep-command)))))
655 (unless grep-find-template
656 (setq grep-find-template
657 (let ((gcmd (format "%s <C> %s <R>"
658 grep-program grep-options))
659 (null (if grep-use-null-device
660 (format "%s " null-device)
662 (cond ((eq grep-find-use-xargs 'gnu)
663 (format "%s <D> <X> -type f <F> -print0 | \"%s\" -0 %s"
664 find-program xargs-program gcmd))
665 ((eq grep-find-use-xargs 'exec)
666 (format "%s <D> <X> -type f <F> -exec %s {} %s%s"
667 find-program gcmd null
668 (shell-quote-argument ";")))
669 ((eq grep-find-use-xargs 'exec-plus)
670 (format "%s <D> <X> -type f <F> -exec %s %s{} +"
671 find-program gcmd null))
673 (format "%s <D> <X> -type f <F> -print | \"%s\" %s"
674 find-program xargs-program gcmd))))))))
676 ;; Save defaults for this host.
677 (setq grep-host-defaults-alist
678 (delete (assq host-id grep-host-defaults-alist)
679 grep-host-defaults-alist))
681 'grep-host-defaults-alist
683 `((grep-command ,grep-command)
684 (grep-template ,grep-template)
685 (grep-use-null-device ,grep-use-null-device)
686 (grep-find-command ,grep-find-command)
687 (grep-find-template ,grep-find-template)
688 (grep-find-use-xargs ,grep-find-use-xargs)
689 (grep-highlight-matches ,grep-highlight-matches))))))
691 (defun grep-tag-default ()
692 (or (and transient-mark-mode mark-active
694 (buffer-substring-no-properties (point) (mark)))
695 (funcall (or find-tag-default-function
696 (get major-mode 'find-tag-default-function)
700 (defun grep-default-command ()
701 "Compute the default grep command for \\[universal-argument] \\[grep] to offer."
702 (let ((tag-default (shell-quote-argument (grep-tag-default)))
703 ;; This a regexp to match single shell arguments.
704 ;; Could someone please add comments explaining it?
705 (sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
706 (grep-default (or (car grep-history) grep-command)))
707 ;; In the default command, find the arg that specifies the pattern.
708 (when (or (string-match
709 (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
710 sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
712 ;; If the string is not yet complete.
713 (string-match "\\(\\)\\'" grep-default))
714 ;; Maybe we will replace the pattern with the default tag.
715 ;; But first, maybe replace the file name pattern.
717 (unless (or (not (stringp buffer-file-name))
718 (when (match-beginning 2)
722 (file-name-nondirectory
723 (match-string 3 grep-default)))
724 (file-name-nondirectory buffer-file-name)))))
725 (setq grep-default (concat (substring grep-default
726 0 (match-beginning 2))
728 (file-name-extension buffer-file-name))))
729 ;; In case wildcard-to-regexp gets an error
730 ;; from invalid data.
732 ;; Now replace the pattern with the default tag.
733 (replace-match tag-default t t grep-default 1))))
737 (define-compilation-mode grep-mode "Grep"
738 "Sets `grep-last-buffer' and `compilation-window-height'."
739 (setq grep-last-buffer (current-buffer))
740 (set (make-local-variable 'tool-bar-map) grep-mode-tool-bar-map)
741 (set (make-local-variable 'compilation-error-face)
743 (set (make-local-variable 'compilation-error-regexp-alist)
745 ;; compilation-directory-matcher can't be nil, so we set it to a regexp that
747 (set (make-local-variable 'compilation-directory-matcher) '("\\`a\\`"))
748 (set (make-local-variable 'compilation-process-setup-function)
750 (set (make-local-variable 'compilation-disable-input) t)
751 (set (make-local-variable 'compilation-error-screen-columns)
752 grep-error-screen-columns)
753 (add-hook 'compilation-filter-hook 'grep-filter nil t))
755 (defvar grep--command-history nil)
756 (defvar grep--history-inhibit nil)
757 (defvar grep--history-place 0)
759 (defun grep--save-history (command)
760 (unless grep--history-inhibit
761 (push (cons default-directory command) grep--command-history)
762 (setq grep--history-place 0)
763 ;; Don't let the history grow without bounds.
764 (when (> (length grep--command-history) 100)
765 (setcdr (nthcdr 100 grep--command-history) nil))))
767 (defun grep-forward-history ()
768 "Go to the next result in the grep command history.
769 Also see `grep-backward-history'."
771 (let ((elem (and (> grep--history-place 0)
772 (nth (1- grep--history-place) grep--command-history)))
773 (grep--history-inhibit t))
775 (error "Nothing further in the command history"))
776 (cl-decf grep--history-place)
777 (let ((default-directory (car elem)))
780 (defun grep-backward-history ()
781 "Go to the previous result in the grep command history.
782 Also see `grep-forward-history'."
784 (let ((elem (nth (1+ grep--history-place) grep--command-history))
785 (grep--history-inhibit t))
787 (error "Nothing further in the command history"))
788 (cl-incf grep--history-place)
789 (let ((default-directory (car elem)))
792 (defun grep--save-buffers ()
793 (when grep-save-buffers
794 (save-some-buffers (and (not (eq grep-save-buffers 'ask))
795 (not (functionp grep-save-buffers)))
796 (and (functionp grep-save-buffers)
797 grep-save-buffers))))
800 (defun grep (command-args)
801 "Run Grep with user-specified COMMAND-ARGS, collect output in a buffer.
802 While Grep runs asynchronously, you can use \\[next-error] (M-x next-error),
803 or \\<grep-mode-map>\\[compile-goto-error] in the *grep* \
804 buffer, to go to the lines where Grep found
805 matches. To kill the Grep job before it finishes, type \\[kill-compilation].
807 Noninteractively, COMMAND-ARGS should specify the Grep command-line
810 For doing a recursive `grep', see the `rgrep' command. For running
811 Grep in a specific directory, see `lgrep'.
813 This command uses a special history list for its COMMAND-ARGS, so you
814 can easily repeat a grep command.
816 A prefix argument says to default the COMMAND-ARGS based on the current
817 tag the cursor is over, substituting it into the last Grep command
818 in the Grep command history (or into `grep-command' if that history
822 (grep-compute-defaults)
823 (let ((default (grep-default-command)))
824 (list (read-shell-command "Run grep (like this): "
825 (if current-prefix-arg default grep-command)
827 (if current-prefix-arg nil default))))))
828 (grep--save-history command-args)
830 ;; Setting process-setup-function makes exit-message-function work
831 ;; even when async processes aren't supported.
832 (compilation-start (if (and grep-use-null-device null-device)
833 (concat command-args " " null-device)
839 (defun grep-find (command-args)
840 "Run grep via find, with user-specified args COMMAND-ARGS.
841 Collect output in a buffer.
842 While find runs asynchronously, you can use the \\[next-error] command
843 to find the text that grep hits refer to.
845 This command uses a special history list for its arguments, so you can
846 easily repeat a find command."
849 (grep-compute-defaults)
850 (if grep-find-command
851 (list (read-shell-command "Run find (like this): "
852 grep-find-command 'grep-find-history))
853 ;; No default was set
855 "compile.el: No `grep-find-command' command available. Press RET.")
858 (let ((null-device nil)) ; see grep
859 (grep command-args))))
862 (defalias 'find-grep 'grep-find)
865 ;; User-friendly interactive API.
867 (defconst grep-expand-keywords
868 '(("<C>" . (mapconcat #'identity opts " "))
869 ("<D>" . (or dir "."))
871 ("<N>" . null-device)
873 ("<R>" . (shell-quote-argument (or regexp ""))))
874 "List of substitutions performed by `grep-expand-template'.
875 If car of an element matches, the cdr is evalled in to get the
876 substitution string. Note dynamic scoping of variables.")
878 (defun grep-expand-template (template &optional regexp files dir excl)
879 "Patch grep COMMAND string replacing <C>, <D>, <F>, <R>, and <X>."
880 (let* ((command template)
881 (env `((opts . ,(let (opts)
882 (when (and case-fold-search
883 (isearch-no-upper-case-p regexp t))
886 ((eq grep-highlight-matches 'always)
887 (push "--color=always" opts))
888 ((eq grep-highlight-matches 'auto)
889 (push "--color" opts)))
895 (case-fold-search nil))
896 (dolist (kw grep-expand-keywords command)
897 (if (string-match (car kw) command)
900 (or (if (symbolp (cdr kw))
902 (save-match-data (eval (cdr kw) env)))
906 (defun grep-read-regexp ()
907 "Read regexp arg for interactive grep using `read-regexp'."
908 (read-regexp "Search for" 'grep-tag-default 'grep-regexp-history))
910 (defun grep-read-files (regexp)
911 "Read files arg for interactive grep."
912 (let* ((bn (or (buffer-file-name)
913 (replace-regexp-in-string "<[0-9]+>\\'" "" (buffer-name))))
916 (file-name-nondirectory bn)))
919 (let ((aliases (remove (assoc "all" grep-files-aliases)
923 (setq alias (car aliases)
924 aliases (cdr aliases))
925 (if (string-match (mapconcat
927 (split-string (cdr alias) nil t)
935 (let ((ext (file-name-extension fn)))
936 (and ext (concat "*." ext)))))
940 (car grep-files-history)
941 (car (car grep-files-aliases))))
942 (files (completing-read
943 (concat "Search for \"" regexp
945 (if default (concat " (default " default ")"))
947 'read-file-name-internal
948 nil nil nil 'grep-files-history
950 (delq nil (append (list default default-alias default-extension)
951 (mapcar 'car grep-files-aliases)))))))
953 (or (cdr (assoc files grep-files-aliases))
957 (defun lgrep (regexp &optional files dir confirm)
958 "Run grep, searching for REGEXP in FILES in directory DIR.
959 The search is limited to file names matching shell pattern FILES.
960 FILES may use abbreviations defined in `grep-files-aliases', e.g.
961 entering `ch' is equivalent to `*.[ch]'.
963 With \\[universal-argument] prefix, you can edit the constructed shell command line
964 before it is executed.
965 With two \\[universal-argument] prefixes, directly edit and run `grep-command'.
967 Collect output in a buffer. While grep runs asynchronously, you
968 can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
969 in the grep output buffer,
970 to go to the lines where grep found matches.
972 This command shares argument histories with \\[rgrep] and \\[grep]."
975 (grep-compute-defaults)
977 ((and grep-command (equal current-prefix-arg '(16)))
978 (list (read-from-minibuffer "Run: " grep-command
979 nil nil 'grep-history)))
981 (error "grep.el: No `grep-template' available"))
982 (t (let* ((regexp (grep-read-regexp))
983 (files (grep-read-files regexp))
984 (dir (read-directory-name "In directory: "
985 nil default-directory t))
986 (confirm (equal current-prefix-arg '(4))))
987 (list regexp files dir confirm))))))
988 (when (and (stringp regexp) (> (length regexp) 0))
989 (unless (and dir (file-accessible-directory-p dir))
990 (setq dir default-directory))
991 (let ((command regexp))
993 (if (string= command grep-command)
995 (setq dir (file-name-as-directory (expand-file-name dir)))
996 (setq command (grep-expand-template
1001 (and grep-find-ignored-files
1002 (concat " --exclude="
1005 (cond ((stringp ignore)
1006 (shell-quote-argument ignore))
1008 (and (funcall (car ignore) dir)
1009 (shell-quote-argument
1011 grep-find-ignored-files
1016 (read-from-minibuffer "Confirm: "
1017 command nil nil 'grep-history))
1018 (add-to-history 'grep-history command))))
1020 (let ((default-directory dir))
1021 ;; Setting process-setup-function makes exit-message-function work
1022 ;; even when async processes aren't supported.
1023 (grep--save-buffers)
1024 (compilation-start (if (and grep-use-null-device null-device)
1025 (concat command " " null-device)
1028 (if (eq next-error-last-buffer (current-buffer))
1029 (setq default-directory dir))))))
1032 (defvar find-name-arg) ; not autoloaded but defined in find-dired
1035 (defun rgrep (regexp &optional files dir confirm)
1036 "Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
1037 The search is limited to file names matching shell pattern FILES.
1038 FILES may use abbreviations defined in `grep-files-aliases', e.g.
1039 entering `ch' is equivalent to `*.[ch]'.
1041 With \\[universal-argument] prefix, you can edit the constructed shell command line
1042 before it is executed.
1043 With two \\[universal-argument] prefixes, directly edit and run `grep-find-command'.
1045 Collect output in a buffer. While the recursive grep is running,
1046 you can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
1047 in the grep output buffer,
1048 to visit the lines where matches were found. To kill the job
1049 before it finishes, type \\[kill-compilation].
1051 This command shares argument histories with \\[lgrep] and \\[grep-find].
1053 When called programmatically and FILES is nil, REGEXP is expected
1054 to specify a command to run."
1057 (grep-compute-defaults)
1059 ((and grep-find-command (equal current-prefix-arg '(16)))
1060 (list (read-from-minibuffer "Run: " grep-find-command
1061 nil nil 'grep-find-history)))
1062 ((not grep-find-template)
1063 (error "grep.el: No `grep-find-template' available"))
1064 (t (let* ((regexp (grep-read-regexp))
1065 (files (grep-read-files regexp))
1066 (dir (read-directory-name "Base directory: "
1067 nil default-directory t))
1068 (confirm (equal current-prefix-arg '(4))))
1069 (list regexp files dir confirm))))))
1070 (when (and (stringp regexp) (> (length regexp) 0))
1071 (unless (and dir (file-accessible-directory-p dir))
1072 (setq dir default-directory))
1074 (if (not (string= regexp (if (consp grep-find-command)
1075 (car grep-find-command)
1076 grep-find-command)))
1077 (compilation-start regexp 'grep-mode))
1078 (setq dir (file-name-as-directory (expand-file-name dir)))
1079 (let ((command (rgrep-default-command regexp files nil)))
1083 (read-from-minibuffer "Confirm: "
1084 command nil nil 'grep-find-history))
1085 (add-to-history 'grep-find-history command))
1086 (grep--save-buffers)
1087 (let ((default-directory dir))
1088 (compilation-start command 'grep-mode))
1089 ;; Set default-directory if we started rgrep in the *grep* buffer.
1090 (if (eq next-error-last-buffer (current-buffer))
1091 (setq default-directory dir)))))))
1093 (defun rgrep-default-command (regexp files dir)
1094 "Compute the command for \\[rgrep] to use by default."
1095 (require 'find-dired) ; for `find-name-arg'
1096 (grep-expand-template
1099 (concat (shell-quote-argument "(")
1100 " " find-name-arg " "
1102 #'shell-quote-argument
1103 (split-string files)
1104 (concat " -o " find-name-arg " "))
1106 (shell-quote-argument ")"))
1109 (and grep-find-ignored-directories
1111 (shell-quote-argument "(")
1112 ;; we should use shell-quote-argument here
1118 (cond ((stringp ignore)
1119 (shell-quote-argument
1120 (concat "*/" ignore)))
1122 (and (funcall (car ignore) dir)
1123 (shell-quote-argument
1126 grep-find-ignored-directories))
1129 (shell-quote-argument ")")
1131 (and grep-find-ignored-files
1132 (concat (shell-quote-argument "!") " -type d "
1133 (shell-quote-argument "(")
1134 ;; we should use shell-quote-argument here
1138 (cond ((stringp ignore)
1139 (shell-quote-argument ignore))
1141 (and (funcall (car ignore) dir)
1142 (shell-quote-argument
1144 grep-find-ignored-files
1147 (shell-quote-argument ")")
1151 (defun zrgrep (regexp &optional files dir confirm template)
1152 "Recursively grep for REGEXP in gzipped FILES in tree rooted at DIR.
1153 Like `rgrep' but uses `zgrep' for `grep-program', sets the default
1154 file name to `*.gz', and sets `grep-highlight-matches' to `always'."
1157 ;; Compute standard default values.
1158 (grep-compute-defaults)
1159 ;; Compute the default zrgrep command by running `grep-compute-defaults'
1160 ;; for grep program "zgrep", but not changing global values.
1161 (let ((grep-program "zgrep")
1162 ;; Don't change global values for variables computed
1163 ;; by `grep-compute-defaults'.
1164 (grep-find-template nil)
1165 (grep-find-command nil)
1166 (grep-host-defaults-alist nil)
1167 ;; Use for `grep-read-files'
1168 (grep-files-aliases '(("all" . "* .*")
1170 ;; Recompute defaults using let-bound values above.
1171 (grep-compute-defaults)
1173 ((and grep-find-command (equal current-prefix-arg '(16)))
1174 (list (read-from-minibuffer "Run: " grep-find-command
1175 nil nil 'grep-find-history)))
1176 ((not grep-find-template)
1177 (error "grep.el: No `grep-find-template' available"))
1178 (t (let* ((regexp (grep-read-regexp))
1179 (files (grep-read-files regexp))
1180 (dir (read-directory-name "Base directory: "
1181 nil default-directory t))
1182 (confirm (equal current-prefix-arg '(4))))
1183 (list regexp files dir confirm grep-find-template)))))))
1184 (let ((grep-find-template template)
1185 ;; Set `grep-highlight-matches' to `always'
1186 ;; since `zgrep' puts filters in the grep output.
1187 (grep-highlight-matches 'always))
1188 (rgrep regexp files dir confirm)))
1191 (defalias 'rzgrep 'zrgrep)
1195 ;;; grep.el ends here