1 ;;; grep.el --- run `grep' and display the results -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2014 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@gnu.org>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: tools, processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; This package provides the grep facilities documented in the Emacs
35 "Run `grep' and display the results."
39 (defvar grep-host-defaults-alist nil
40 "Default values depending on target host.
41 `grep-compute-defaults' returns default values for every local or
42 remote host `grep' runs. These values can differ from host to
43 host. Once computed, the default values are kept here in order
44 to avoid computing them again.")
46 (defun grep-apply-setting (symbol value
)
47 "Set SYMBOL to VALUE, and update `grep-host-defaults-alist'.
48 SYMBOL should be one of `grep-command', `grep-template',
49 `grep-use-null-device', `grep-find-command',
50 `grep-find-template', `grep-find-use-xargs', or
51 `grep-highlight-matches'."
52 (when grep-host-defaults-alist
54 (intern (or (file-remote-p default-directory
) "localhost")))
55 (host-defaults (assq host-id grep-host-defaults-alist
))
56 (defaults (assq nil grep-host-defaults-alist
)))
57 (setcar (cdr (assq symbol host-defaults
)) value
)
58 (setcar (cdr (assq symbol defaults
)) value
)))
59 (set-default symbol value
))
62 (defcustom grep-window-height nil
63 "Number of lines in a grep window. If nil, use `compilation-window-height'."
64 :type
'(choice (const :tag
"Default" nil
)
69 (defcustom grep-highlight-matches
'auto-detect
70 "Use special markers to highlight grep matches.
72 Some grep programs are able to surround matches with special
73 markers in grep output. Such markers can be used to highlight
74 matches in grep mode. This requires `font-lock-mode' to be active
75 in grep buffers, so if you have globally disabled font-lock-mode,
76 you will not get highlighting.
78 This option sets the environment variable GREP_COLORS to specify
79 markers for highlighting and GREP_OPTIONS to add the --color
80 option in front of any explicit grep options before starting
83 When this option is `auto', grep uses `--color=auto' 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" 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 -i if case insensitive grep.
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 -i if case insensitive grep
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
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-error-screen-columns nil
231 "If non-nil, column numbers in grep hits are screen columns.
232 See `compilation-error-screen-columns'"
233 :type
'(choice (const :tag
"Default" nil
)
239 (defcustom grep-setup-hook nil
240 "List of hook functions run by `grep-process-setup' (see `run-hooks')."
244 (defvar grep-mode-map
245 (let ((map (make-sparse-keymap)))
246 (set-keymap-parent map compilation-minor-mode-map
)
247 (define-key map
" " 'scroll-up-command
)
248 (define-key map
[?\S-\
] 'scroll-down-command
)
249 (define-key map
"\^?" 'scroll-down-command
)
250 (define-key map
"\C-c\C-f" 'next-error-follow-minor-mode
)
252 (define-key map
"\r" 'compile-goto-error
) ;; ?
253 (define-key map
"n" 'next-error-no-select
)
254 (define-key map
"p" 'previous-error-no-select
)
255 (define-key map
"{" 'compilation-previous-file
)
256 (define-key map
"}" 'compilation-next-file
)
257 (define-key map
"\t" 'compilation-next-error
)
258 (define-key map
[backtab] 'compilation-previous-error)
260 ;; Set up the menu-bar
261 (define-key map [menu-bar grep]
262 (cons "Grep" (make-sparse-keymap "Grep")))
264 (define-key map [menu-bar grep compilation-kill-compilation]
265 '(menu-item "Kill Grep" kill-compilation
266 :help "Kill the currently running grep process"))
267 (define-key map [menu-bar grep compilation-separator2] '("----"))
268 (define-key map [menu-bar grep compilation-compile]
269 '(menu-item "Compile..." compile
270 :help "Compile the program including the current buffer. Default: run `make'"))
271 (define-key map [menu-bar grep compilation-rgrep]
272 '(menu-item "Recursive grep..." rgrep
273 :help "User-friendly recursive grep in directory tree"))
274 (define-key map [menu-bar grep compilation-lgrep]
275 '(menu-item "Local grep..." lgrep
276 :help "User-friendly grep in a directory"))
277 (define-key map [menu-bar grep compilation-grep-find]
278 '(menu-item "Grep via Find..." grep-find
279 :help "Run grep via find, with user-specified args"))
280 (define-key map [menu-bar grep compilation-grep]
281 '(menu-item "Another grep..." grep
282 :help "Run grep, with user-specified args, and collect output in a buffer."))
283 (define-key map [menu-bar grep compilation-recompile]
284 '(menu-item "Repeat grep" recompile
285 :help "Run grep again"))
286 (define-key map [menu-bar grep compilation-separator2] '("----"))
287 (define-key map [menu-bar grep compilation-first-error]
288 '(menu-item "First Match" first-error
289 :help "Restart at the first match, visit corresponding location"))
290 (define-key map [menu-bar grep compilation-previous-error]
291 '(menu-item "Previous Match" previous-error
292 :help "Visit the previous match and corresponding location"))
293 (define-key map [menu-bar grep compilation-next-error]
294 '(menu-item "Next Match" next-error
295 :help "Visit the next match and corresponding location"))
297 "Keymap for grep buffers.
298 `compilation-minor-mode-map' is a cdr of this.")
300 (defvar grep-mode-tool-bar-map
301 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
302 ;; so don't do anything.
303 (when (keymapp (butlast tool-bar-map))
304 (let ((map (butlast (copy-keymap tool-bar-map)))
305 (help (last tool-bar-map))) ;; Keep Help last in tool bar
307 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
309 :help "Goto previous match")
311 "right-arrow" 'next-error-no-select 'next-error-no-select map
313 :help "Goto next match")
315 "cancel" 'kill-compilation 'kill-compilation map
316 :enable '(let ((buffer (compilation-find-buffer)))
317 (get-buffer-process buffer))
320 "refresh" 'recompile 'recompile map
321 :help "Restart grep")
324 (defalias 'kill-grep 'kill-compilation)
326 ;;;; TODO --- refine this!!
328 ;; (defcustom grep-use-compilation-buffer t
329 ;; "When non-nil, grep specific commands update `compilation-last-buffer'.
330 ;; This means that standard compile commands like \\[next-error] and \\[compile-goto-error]
331 ;; can be used to navigate between grep matches (the default).
332 ;; Otherwise, the grep specific commands like \\[grep-next-match] must
333 ;; be used to navigate between grep matches."
337 ;; override compilation-last-buffer
338 (defvar grep-last-buffer nil
339 "The most recent grep buffer.
340 A grep buffer becomes most recent when you select Grep mode in it.
341 Notice that using \\[next-error] or \\[compile-goto-error] modifies
342 `compilation-last-buffer' rather than `grep-last-buffer'.")
345 (defconst grep-regexp-alist
347 ;; Rule to match column numbers is commented out since no known grep
349 ;; ("^\\(.+?\\)\\(:[ \t]*\\)\\([1-9][0-9]*\\)\\2\\(?:\\([1-9][0-9]*\\)\\(?:-\\([1-9][0-9]*\\)\\)?\\2\\)?"
351 ;; Note that we want to use as tight a regexp as we can to try and
352 ;; handle weird file names (with colons in them) as well as possible.
353 ;; E.g. we use [1-9][0-9]* rather than [0-9]+ so as to accept ":034:"
355 ("^\\(.+?\\)\\(:[ \t]*\\)\\([1-9][0-9]*\\)\\2"
357 ;; Calculate column positions (col . end-col) of first grep match on a line
359 (when grep-highlight-matches
360 (let* ((beg (match-end 0))
361 (end (save-excursion (goto-char beg) (line-end-position)))
362 (mbeg (text-property-any beg end 'font-lock-face grep-match-face)))
367 (when grep-highlight-matches
368 (let* ((beg (match-end 0))
369 (end (save-excursion (goto-char beg) (line-end-position)))
370 (mbeg (text-property-any beg end 'font-lock-face grep-match-face))
371 (mend (and mbeg (next-single-property-change mbeg 'font-lock-face nil end))))
374 ("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
375 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
377 (defvar grep-first-column 0 ; bug#10594
378 "Value to use for `compilation-first-column' in grep buffers.")
380 (defvar grep-error "grep hit"
381 "Message to print when no matches are found.")
383 ;; Reverse the colors because grep hits are not errors (though we jump there
384 ;; with `next-error'), and unreadable files can't be gone to.
385 (defvar grep-hit-face compilation-info-face
386 "Face name to use for grep hits.")
388 (defvar grep-error-face 'compilation-error
389 "Face name to use for grep error messages.")
391 (defvar grep-match-face 'match
392 "Face name to use for grep matches.")
394 (defvar grep-context-face 'shadow
395 "Face name to use for grep context lines.")
397 (defvar grep-mode-font-lock-keywords
398 '(;; Command output lines.
399 (": \\(.+\\): \\(?:Permission denied\\|No such \\(?:file or directory\\|device or address\\)\\)$"
401 ;; remove match from grep-regexp-alist before fontifying
402 ("^Grep[/a-zA-z]* started.*"
403 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t))
404 ("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
405 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
406 (1 compilation-info-face nil t)
407 (2 compilation-warning-face nil t))
408 ("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
409 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
411 (2 grep-error-face nil t))
412 ;; "filename-linenumber-" format is used for context lines in GNU grep,
413 ;; "filename=linenumber=" for lines with function names in "git grep -p".
414 ("^.+?[-=][0-9]+[-=].*\n" (0 grep-context-face)))
415 "Additional things to highlight in grep output.
416 This gets tacked on the end of the generated expressions.")
419 (defvar grep-program (purecopy "grep")
420 "The default grep program for `grep-command' and `grep-find-command'.
421 This variable's value takes effect when `grep-compute-defaults' is called.")
424 (defvar find-program (purecopy "find")
425 "The default find program.
426 This is used by commands like `grep-find-command', `find-dired'
430 (defvar xargs-program (purecopy "xargs")
431 "The default xargs program for `grep-find-command'.
432 See `grep-find-use-xargs'.
433 This variable's value takes effect when `grep-compute-defaults' is called.")
436 (defvar grep-find-use-xargs nil
437 "How to invoke find and grep.
438 If `exec', use `find -exec {} ;'.
439 If `exec-plus' use `find -exec {} +'.
440 If `gnu', use `find -print0' and `xargs -0'.
441 Any other value means to use `find -print' and `xargs'.
443 This variable's value takes effect when `grep-compute-defaults' is called.")
445 ;; History of grep commands.
447 (defvar grep-history nil "History list for grep.")
449 (defvar grep-find-history nil "History list for grep-find.")
451 ;; History of lgrep and rgrep regexp and files args.
452 (defvar grep-regexp-history nil)
453 (defvar grep-files-history nil)
456 (defun grep-process-setup ()
457 "Setup compilation variables and buffer for `grep'.
458 Set up `compilation-exit-message-function' and run `grep-setup-hook'."
459 (when (eq grep-highlight-matches 'auto-detect)
460 (grep-compute-defaults))
461 (unless (or (eq grep-highlight-matches 'auto-detect)
462 (null grep-highlight-matches)
463 ;; Don't output color escapes if they can't be
464 ;; highlighted with `font-lock-face' by `grep-filter'.
465 (null font-lock-mode))
466 ;; `setenv' modifies `process-environment' let-bound in `compilation-start'
467 ;; Any TERM except "dumb" allows GNU grep to use `--color=auto'
468 (setenv "TERM" "emacs-grep")
469 (setenv "GREP_OPTIONS"
470 (concat (getenv "GREP_OPTIONS")
471 " --color=" (if (eq grep-highlight-matches 'always)
473 ;; GREP_COLOR is used in GNU grep 2.5.1, but deprecated in later versions
474 (setenv "GREP_COLOR" "01;31")
475 ;; GREP_COLORS is used in GNU grep 2.5.2 and later versions
476 (setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:sl=:cx=:ne"))
477 (set (make-local-variable 'compilation-exit-message-function)
478 (lambda (status code msg)
479 (if (eq status 'exit)
480 ;; This relies on the fact that `compilation-start'
481 ;; sets buffer-modified to nil before running the command,
482 ;; so the buffer is still unmodified if there is no output.
483 (cond ((and (zerop code) (buffer-modified-p))
484 '("finished (matches found)\n" . "matched"))
485 ((not (buffer-modified-p))
486 '("finished with no matches found\n" . "no match"))
490 (run-hooks 'grep-setup-hook))
492 (defun grep-filter ()
493 "Handle match highlighting escape sequences inserted by the grep process.
494 This function is called from `compilation-filter-hook'."
497 (let ((end (point)) beg)
498 (goto-char compilation-filter-start)
501 ;; Only operate on whole lines so we don't get caught with part of an
502 ;; escape sequence in one chunk and the rest in another.
503 (when (< (point) end)
504 (setq end (copy-marker end))
505 ;; Highlight grep matches and delete marking sequences.
506 (while (re-search-forward "\033\\[0?1;31m\\(.*?\\)\033\\[[0-9]*m" end 1)
507 (replace-match (propertize (match-string 1)
508 'face nil 'font-lock-face grep-match-face)
510 ;; Delete all remaining escape sequences
512 (while (re-search-forward "\033\\[[0-9;]*[mK]" end 1)
513 (replace-match "" t t))))))
515 (defun grep-probe (command args &optional func result)
516 (let (process-file-side-effects)
517 (equal (condition-case nil
518 (apply (or func 'process-file) command args)
523 (defun grep-compute-defaults ()
524 ;; Keep default values.
525 (unless grep-host-defaults-alist
527 'grep-host-defaults-alist
529 `((grep-command ,grep-command)
530 (grep-template ,grep-template)
531 (grep-use-null-device ,grep-use-null-device)
532 (grep-find-command ,grep-find-command)
533 (grep-find-template ,grep-find-template)
534 (grep-find-use-xargs ,grep-find-use-xargs)
535 (grep-highlight-matches ,grep-highlight-matches)))))
537 (intern (or (file-remote-p default-directory) "localhost")))
538 (host-defaults (assq host-id grep-host-defaults-alist))
539 (defaults (assq nil grep-host-defaults-alist)))
540 ;; There are different defaults on different hosts. They must be
541 ;; computed for every host once.
542 (dolist (setting '(grep-command grep-template
543 grep-use-null-device grep-find-command
544 grep-find-template grep-find-use-xargs
545 grep-highlight-matches))
547 (cadr (or (assq setting host-defaults)
548 (assq setting defaults)))))
550 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
551 (setq grep-use-null-device
553 (let ((hello-file (expand-file-name "HELLO" data-directory)))
555 (and (if grep-command
556 ;; `grep-command' is already set, so
557 ;; use that for testing.
558 (grep-probe grep-command
559 `(nil t nil "^English" ,hello-file)
560 #'call-process-shell-command)
561 ;; otherwise use `grep-program'
562 (grep-probe grep-program
563 `(nil t nil "-nH" "^English" ,hello-file)))
565 (goto-char (point-min))
567 (concat (regexp-quote hello-file)
568 ":[0-9]+:English")))))))))
569 (unless (and grep-command grep-find-command
570 grep-template grep-find-template)
572 (concat (if grep-use-null-device "-n" "-nH")
573 (if (grep-probe grep-program
574 `(nil nil nil "-e" "foo" ,null-device)
579 (format "%s %s " grep-program grep-options)))
580 (unless grep-template
582 (format "%s <X> <C> %s <R> <F>" grep-program grep-options)))
583 (unless grep-find-use-xargs
584 (setq grep-find-use-xargs
586 ((grep-probe find-program
587 `(nil nil nil ,null-device "-exec" "echo"
591 (grep-probe find-program `(nil nil nil ,null-device "-print0"))
592 (grep-probe xargs-program `(nil nil nil "-0" "echo")))
596 (unless grep-find-command
597 (setq grep-find-command
598 (cond ((eq grep-find-use-xargs 'gnu)
599 ;; Windows shells need the program file name
600 ;; after the pipe symbol be quoted if they use
601 ;; forward slashes as directory separators.
602 (format "%s . -type f -print0 | \"%s\" -0 %s"
603 find-program xargs-program grep-command))
604 ((memq grep-find-use-xargs '(exec exec-plus))
605 (let ((cmd0 (format "%s . -type f -exec %s"
606 find-program grep-command))
607 (null (if grep-use-null-device
608 (format "%s " null-device)
611 (if (eq grep-find-use-xargs 'exec-plus)
612 (format "%s %s{} +" cmd0 null)
613 (format "%s {} %s%s" cmd0 null
614 (shell-quote-argument ";")))
615 (1+ (length cmd0)))))
617 (format "%s . -type f -print | \"%s\" %s"
618 find-program xargs-program grep-command)))))
619 (unless grep-find-template
620 (setq grep-find-template
621 (let ((gcmd (format "%s <C> %s <R>"
622 grep-program grep-options))
623 (null (if grep-use-null-device
624 (format "%s " null-device)
626 (cond ((eq grep-find-use-xargs 'gnu)
627 (format "%s . <X> -type f <F> -print0 | \"%s\" -0 %s"
628 find-program xargs-program gcmd))
629 ((eq grep-find-use-xargs 'exec)
630 (format "%s . <X> -type f <F> -exec %s {} %s%s"
631 find-program gcmd null
632 (shell-quote-argument ";")))
633 ((eq grep-find-use-xargs 'exec-plus)
634 (format "%s . <X> -type f <F> -exec %s %s{} +"
635 find-program gcmd null))
637 (format "%s . <X> -type f <F> -print | \"%s\" %s"
638 find-program xargs-program gcmd))))))))
639 (when (eq grep-highlight-matches 'auto-detect)
640 (setq grep-highlight-matches
642 (and (grep-probe grep-program '(nil t nil "--help"))
644 (goto-char (point-min))
645 (search-forward "--color" nil t))
646 ;; Windows and DOS pipes fail `isatty' detection in Grep.
647 (if (memq system-type '(windows-nt ms-dos))
650 ;; Save defaults for this host.
651 (setq grep-host-defaults-alist
652 (delete (assq host-id grep-host-defaults-alist)
653 grep-host-defaults-alist))
655 'grep-host-defaults-alist
657 `((grep-command ,grep-command)
658 (grep-template ,grep-template)
659 (grep-use-null-device ,grep-use-null-device)
660 (grep-find-command ,grep-find-command)
661 (grep-find-template ,grep-find-template)
662 (grep-find-use-xargs ,grep-find-use-xargs)
663 (grep-highlight-matches ,grep-highlight-matches))))))
665 (defun grep-tag-default ()
666 (or (and transient-mark-mode mark-active
668 (buffer-substring-no-properties (point) (mark)))
669 (funcall (or find-tag-default-function
670 (get major-mode 'find-tag-default-function)
674 (defun grep-default-command ()
675 "Compute the default grep command for \\[universal-argument] \\[grep] to offer."
676 (let ((tag-default (shell-quote-argument (grep-tag-default)))
677 ;; This a regexp to match single shell arguments.
678 ;; Could someone please add comments explaining it?
679 (sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
680 (grep-default (or (car grep-history) grep-command)))
681 ;; In the default command, find the arg that specifies the pattern.
682 (when (or (string-match
683 (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
684 sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
686 ;; If the string is not yet complete.
687 (string-match "\\(\\)\\'" grep-default))
688 ;; Maybe we will replace the pattern with the default tag.
689 ;; But first, maybe replace the file name pattern.
691 (unless (or (not (stringp buffer-file-name))
692 (when (match-beginning 2)
696 (file-name-nondirectory
697 (match-string 3 grep-default)))
698 (file-name-nondirectory buffer-file-name)))))
699 (setq grep-default (concat (substring grep-default
700 0 (match-beginning 2))
702 (file-name-extension buffer-file-name))))
703 ;; In case wildcard-to-regexp gets an error
704 ;; from invalid data.
706 ;; Now replace the pattern with the default tag.
707 (replace-match tag-default t t grep-default 1))))
711 (define-compilation-mode grep-mode "Grep"
712 "Sets `grep-last-buffer' and `compilation-window-height'."
713 (setq grep-last-buffer (current-buffer))
714 (set (make-local-variable 'tool-bar-map) grep-mode-tool-bar-map)
715 (set (make-local-variable 'compilation-error-face)
717 (set (make-local-variable 'compilation-error-regexp-alist)
719 ;; compilation-directory-matcher can't be nil, so we set it to a regexp that
721 (set (make-local-variable 'compilation-directory-matcher) '("\\`a\\`"))
722 (set (make-local-variable 'compilation-process-setup-function)
724 (set (make-local-variable 'compilation-disable-input) t)
725 (set (make-local-variable 'compilation-error-screen-columns)
726 grep-error-screen-columns)
727 (add-hook 'compilation-filter-hook 'grep-filter nil t))
731 (defun grep (command-args)
732 "Run grep, with user-specified args, and collect output in a buffer.
733 While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
734 or \\<grep-mode-map>\\[compile-goto-error] in the *grep* \
735 buffer, to go to the lines where grep found
736 matches. To kill the grep job before it finishes, type \\[kill-compilation].
738 For doing a recursive `grep', see the `rgrep' command. For running
739 `grep' in a specific directory, see `lgrep'.
741 This command uses a special history list for its COMMAND-ARGS, so you
742 can easily repeat a grep command.
744 A prefix argument says to default the argument based upon the current
745 tag the cursor is over, substituting it into the last grep command
746 in the grep command history (or into `grep-command' if that history
750 (grep-compute-defaults)
751 (let ((default (grep-default-command)))
752 (list (read-shell-command "Run grep (like this): "
753 (if current-prefix-arg default grep-command)
755 (if current-prefix-arg nil default))))))
757 ;; Setting process-setup-function makes exit-message-function work
758 ;; even when async processes aren't supported.
759 (compilation-start (if (and grep-use-null-device null-device)
760 (concat command-args " " null-device)
766 (defun grep-find (command-args)
767 "Run grep via find, with user-specified args COMMAND-ARGS.
768 Collect output in a buffer.
769 While find runs asynchronously, you can use the \\[next-error] command
770 to find the text that grep hits refer to.
772 This command uses a special history list for its arguments, so you can
773 easily repeat a find command."
776 (grep-compute-defaults)
777 (if grep-find-command
778 (list (read-shell-command "Run find (like this): "
779 grep-find-command 'grep-find-history))
780 ;; No default was set
782 "compile.el: No `grep-find-command' command available. Press RET.")
785 (let ((null-device nil)) ; see grep
786 (grep command-args))))
789 (defalias 'find-grep 'grep-find)
792 ;; User-friendly interactive API.
794 (defconst grep-expand-keywords
795 '(("<C>" . (and cf (isearch-no-upper-case-p regexp t) "-i"))
798 ("<N>" . null-device)
800 ("<R>" . (shell-quote-argument (or regexp ""))))
801 "List of substitutions performed by `grep-expand-template'.
802 If car of an element matches, the cdr is evalled in to get the
803 substitution string. Note dynamic scoping of variables.")
805 (defun grep-expand-template (template &optional regexp files dir excl)
806 "Patch grep COMMAND string replacing <C>, <D>, <F>, <R>, and <X>."
807 (let* ((command template)
808 (env `((cf . ,case-fold-search)
813 (case-fold-search nil))
814 (dolist (kw grep-expand-keywords command)
815 (if (string-match (car kw) command)
818 (or (if (symbolp (cdr kw))
820 (save-match-data (eval (cdr kw) env)))
824 (defun grep-read-regexp ()
825 "Read regexp arg for interactive grep using `read-regexp'."
826 (read-regexp "Search for" 'grep-tag-default 'grep-regexp-history))
828 (defun grep-read-files (regexp)
829 "Read files arg for interactive grep."
830 (let* ((bn (or (buffer-file-name)
831 (replace-regexp-in-string "<[0-9]+>\\'" "" (buffer-name))))
834 (file-name-nondirectory bn)))
837 (let ((aliases (remove (assoc "all" grep-files-aliases)
841 (setq alias (car aliases)
842 aliases (cdr aliases))
843 (if (string-match (mapconcat
845 (split-string (cdr alias) nil t)
853 (let ((ext (file-name-extension fn)))
854 (and ext (concat "*." ext)))))
858 (car grep-files-history)
859 (car (car grep-files-aliases))))
860 (files (completing-read
861 (concat "Search for \"" regexp
863 (if default (concat " (default " default ")"))
865 'read-file-name-internal
866 nil nil nil 'grep-files-history
868 (delq nil (append (list default default-alias default-extension)
869 (mapcar 'car grep-files-aliases)))))))
871 (or (cdr (assoc files grep-files-aliases))
875 (defun lgrep (regexp &optional files dir confirm)
876 "Run grep, searching for REGEXP in FILES in directory DIR.
877 The search is limited to file names matching shell pattern FILES.
878 FILES may use abbreviations defined in `grep-files-aliases', e.g.
879 entering `ch' is equivalent to `*.[ch]'.
881 With \\[universal-argument] prefix, you can edit the constructed shell command line
882 before it is executed.
883 With two \\[universal-argument] prefixes, directly edit and run `grep-command'.
885 Collect output in a buffer. While grep runs asynchronously, you
886 can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
887 in the grep output buffer,
888 to go to the lines where grep found matches.
890 This command shares argument histories with \\[rgrep] and \\[grep]."
893 (grep-compute-defaults)
895 ((and grep-command (equal current-prefix-arg '(16)))
896 (list (read-from-minibuffer "Run: " grep-command
897 nil nil 'grep-history)))
899 (error "grep.el: No `grep-template' available"))
900 (t (let* ((regexp (grep-read-regexp))
901 (files (grep-read-files regexp))
902 (dir (read-directory-name "In directory: "
903 nil default-directory t))
904 (confirm (equal current-prefix-arg '(4))))
905 (list regexp files dir confirm))))))
906 (when (and (stringp regexp) (> (length regexp) 0))
907 (unless (and dir (file-accessible-directory-p dir))
908 (setq dir default-directory))
909 (let ((command regexp))
911 (if (string= command grep-command)
913 (setq dir (file-name-as-directory (expand-file-name dir)))
914 (setq command (grep-expand-template
919 (and grep-find-ignored-files
920 (concat " --exclude="
923 (cond ((stringp ignore)
924 (shell-quote-argument ignore))
926 (and (funcall (car ignore) dir)
927 (shell-quote-argument
929 grep-find-ignored-files
934 (read-from-minibuffer "Confirm: "
935 command nil nil 'grep-history))
936 (add-to-history 'grep-history command))))
938 (let ((default-directory dir))
939 ;; Setting process-setup-function makes exit-message-function work
940 ;; even when async processes aren't supported.
941 (compilation-start (if (and grep-use-null-device null-device)
942 (concat command " " null-device)
945 (if (eq next-error-last-buffer (current-buffer))
946 (setq default-directory dir))))))
949 (defvar find-name-arg) ; not autoloaded but defined in find-dired
952 (defun rgrep (regexp &optional files dir confirm)
953 "Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
954 The search is limited to file names matching shell pattern FILES.
955 FILES may use abbreviations defined in `grep-files-aliases', e.g.
956 entering `ch' is equivalent to `*.[ch]'.
958 With \\[universal-argument] prefix, you can edit the constructed shell command line
959 before it is executed.
960 With two \\[universal-argument] prefixes, directly edit and run `grep-find-command'.
962 Collect output in a buffer. While the recursive grep is running,
963 you can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error] \
964 in the grep output buffer,
965 to visit the lines where matches were found. To kill the job
966 before it finishes, type \\[kill-compilation].
968 This command shares argument histories with \\[lgrep] and \\[grep-find].
970 When called programmatically and FILES is nil, REGEXP is expected
971 to specify a command to run."
974 (grep-compute-defaults)
976 ((and grep-find-command (equal current-prefix-arg '(16)))
977 (list (read-from-minibuffer "Run: " grep-find-command
978 nil nil 'grep-find-history)))
979 ((not grep-find-template)
980 (error "grep.el: No `grep-find-template' available"))
981 (t (let* ((regexp (grep-read-regexp))
982 (files (grep-read-files regexp))
983 (dir (read-directory-name "Base directory: "
984 nil default-directory t))
985 (confirm (equal current-prefix-arg '(4))))
986 (list regexp files dir confirm))))))
987 (when (and (stringp regexp) (> (length regexp) 0))
988 (unless (and dir (file-accessible-directory-p dir))
989 (setq dir default-directory))
991 (if (not (string= regexp (if (consp grep-find-command)
992 (car grep-find-command)
994 (compilation-start regexp 'grep-mode))
995 (setq dir (file-name-as-directory (expand-file-name dir)))
996 (require 'find-dired) ; for `find-name-arg'
997 (let ((command (grep-expand-template
1000 (concat (shell-quote-argument "(")
1001 " " find-name-arg " "
1003 #'shell-quote-argument
1004 (split-string files)
1005 (concat " -o " find-name-arg " "))
1007 (shell-quote-argument ")"))
1010 (and grep-find-ignored-directories
1012 (shell-quote-argument "(")
1013 ;; we should use shell-quote-argument here
1017 (cond ((stringp ignore)
1018 (shell-quote-argument
1019 (concat "*/" ignore)))
1021 (and (funcall (car ignore) dir)
1022 (shell-quote-argument
1025 grep-find-ignored-directories
1028 (shell-quote-argument ")")
1030 (and grep-find-ignored-files
1031 (concat (shell-quote-argument "!") " -type d "
1032 (shell-quote-argument "(")
1033 ;; we should use shell-quote-argument here
1037 (cond ((stringp ignore)
1038 (shell-quote-argument ignore))
1040 (and (funcall (car ignore) dir)
1041 (shell-quote-argument
1043 grep-find-ignored-files
1046 (shell-quote-argument ")")
1051 (read-from-minibuffer "Confirm: "
1052 command nil nil 'grep-find-history))
1053 (add-to-history 'grep-find-history command))
1054 (let ((default-directory dir))
1055 (compilation-start command 'grep-mode))
1056 ;; Set default-directory if we started rgrep in the *grep* buffer.
1057 (if (eq next-error-last-buffer (current-buffer))
1058 (setq default-directory dir)))))))
1061 (defun zrgrep (regexp &optional files dir confirm template)
1062 "Recursively grep for REGEXP in gzipped FILES in tree rooted at DIR.
1063 Like `rgrep' but uses `zgrep' for `grep-program', sets the default
1064 file name to `*.gz', and sets `grep-highlight-matches' to `always'."
1067 ;; Compute standard default values.
1068 (grep-compute-defaults)
1069 ;; Compute the default zrgrep command by running `grep-compute-defaults'
1070 ;; for grep program "zgrep", but not changing global values.
1071 (let ((grep-program "zgrep")
1072 ;; Don't change global values for variables computed
1073 ;; by `grep-compute-defaults'.
1074 (grep-find-template nil)
1075 (grep-find-command nil)
1076 (grep-host-defaults-alist nil)
1077 ;; Use for `grep-read-files'
1078 (grep-files-aliases '(("all" . "* .*")
1080 ;; Recompute defaults using let-bound values above.
1081 (grep-compute-defaults)
1083 ((and grep-find-command (equal current-prefix-arg '(16)))
1084 (list (read-from-minibuffer "Run: " grep-find-command
1085 nil nil 'grep-find-history)))
1086 ((not grep-find-template)
1087 (error "grep.el: No `grep-find-template' available"))
1088 (t (let* ((regexp (grep-read-regexp))
1089 (files (grep-read-files regexp))
1090 (dir (read-directory-name "Base directory: "
1091 nil default-directory t))
1092 (confirm (equal current-prefix-arg '(4))))
1093 (list regexp files dir confirm grep-find-template)))))))
1094 ;; Set `grep-highlight-matches' to `always'
1095 ;; since `zgrep' puts filters in the grep output.
1096 (let ((grep-find-template template)
1097 (grep-highlight-matches 'always))
1098 (rgrep regexp files dir confirm)))
1101 (defalias 'rzgrep 'zrgrep)
1105 ;;; grep.el ends here