grep.el 27.6 KB
Newer Older
Eli Zaretskii's avatar
Eli Zaretskii committed
1
;;; grep.el --- run Grep as inferior of Emacs, parse match messages
2

3
;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2001, 2002, 2003, 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; Author: Roland McGrath <roland@gnu.org>
;; Maintainer: FSF
;; Keywords: tools, processes

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26 27 28 29 30 31 32 33 34 35

;;; Commentary:

;; This package provides the grep facilities documented in the Emacs
;; user's manual.

;;; Code:

(require 'compile)

36

37
(defgroup grep nil
Kim F. Storm's avatar
Kim F. Storm committed
38
  "Run grep as inferior of Emacs, parse error messages."
39 40 41 42 43 44 45 46 47
  :group 'tools
  :group 'processes)


;;;###autoload
(defcustom grep-window-height nil
  "*Number of lines in a grep window.  If nil, use `compilation-window-height'."
  :type '(choice (const :tag "Default" nil)
		 integer)
48
  :version "22.1"
49 50
  :group 'grep)

51
(defcustom grep-highlight-matches 'auto-detect
52
  "If t, use special markers to highlight grep matches.
53 54 55 56 57 58 59 60

Some grep programs are able to surround matches with special
markers in grep output.  Such markers can be used to highlight
matches in grep mode.

This option sets the environment variable GREP_COLOR to specify
markers for highlighting and GREP_OPTIONS to add the --color
option in front of any explicit grep options before starting
61 62 63 64
the grep.

The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program."
65 66 67
  :type '(choice (const :tag "Do not highlight matches with grep markers" nil)
		 (const :tag "Highlight matches with grep markers" t)
		 (other :tag "Not Set" auto-detect))
68
  :version "22.1"
69 70
  :group 'grep)

71 72 73 74 75 76 77
(defcustom grep-scroll-output nil
  "*Non-nil to scroll the *grep* buffer window as output appears.

Setting it causes the grep commands to put point at the end of their
output window so that the end of the output is always visible rather
than the begining."
  :type 'boolean
78
  :version "22.1"
79 80
  :group 'grep)

81
;;;###autoload
82 83 84 85 86 87 88 89 90 91 92 93
(defcustom grep-command nil
  "The default grep command for \\[grep].
If the grep program used supports an option to always include file names
in its output (such as the `-H' option to GNU grep), it's a good idea to
include it when specifying `grep-command'.

The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program."
  :type '(choice string
		 (const :tag "Not Set" nil))
  :group 'grep)

Kim F. Storm's avatar
Kim F. Storm committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107
(defcustom grep-template nil
  "The default command to run for \\[lgrep].
The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program.
The following place holders should be present in the string:
 <C> - place to put -i if case insensitive grep.
 <F> - file names and wildcards to search.
 <R> - the regular expression searched for.
 <N> - place to insert null-device."
  :type '(choice string
		 (const :tag "Not Set" nil))
  :version "22.1"
  :group 'grep)

108 109 110 111 112 113 114 115 116 117 118 119 120
(defcustom grep-use-null-device 'auto-detect
  "If t, append the value of `null-device' to `grep' commands.
This is done to ensure that the output of grep includes the filename of
any match in the case where only a single file is searched, and is not
necessary if the grep program used supports the `-H' option.

The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program."
  :type '(choice (const :tag "Do Not Append Null Device" nil)
		 (const :tag "Append Null Device" t)
		 (other :tag "Not Set" auto-detect))
  :group 'grep)

121
;;;###autoload
122 123 124 125 126 127 128 129
(defcustom grep-find-command nil
  "The default find command for \\[grep-find].
The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program."
  :type '(choice string
		 (const :tag "Not Set" nil))
  :group 'grep)

Kim F. Storm's avatar
Kim F. Storm committed
130 131
(defcustom grep-find-template nil
  "The default command to run for \\[rgrep].
132 133 134 135 136 137 138 139 140 141
The default value of this variable is set up by `grep-compute-defaults';
call that function before using this variable in your program.
The following place holders should be present in the string:
 <D> - base directory for find
 <X> - find options to restrict or expand the directory list
 <F> - find options to limit the files matched
 <C> - place to put -i if case insensitive grep
 <R> - the regular expression searched for."
  :type '(choice string
		 (const :tag "Not Set" nil))
142
  :version "22.1"
143 144
  :group 'grep)

Kim F. Storm's avatar
Kim F. Storm committed
145 146
(defcustom grep-files-aliases '(
	("el" .	"*.el")
147 148 149 150
	("ch" .	"*.[ch]")
	("c" .	"*.c")
	("h" .	"*.h")
	("asm" . "*.[sS]")
Kim F. Storm's avatar
Kim F. Storm committed
151 152
	("m" .	"[Mm]akefile*")
	("l" . "[Cc]hange[Ll]og*")
153 154
	("tex" . "*.tex")
	("texi" . "*.texi")
155
	)
Kim F. Storm's avatar
Kim F. Storm committed
156
  "*Alist of aliases for the FILES argument to `lgrep' and `rgrep'."
157 158 159
  :type 'alist
  :group 'grep)

160 161
(defcustom grep-find-ignored-directories '("CVS" ".svn" "{arch}" ".hg" "_darcs"
					   ".git" ".bzr")
Kim F. Storm's avatar
Kim F. Storm committed
162 163
  "*List of names of sub-directories which `rgrep' shall not recurse into."
  :type '(repeat string)
164 165
  :group 'grep)

166 167 168 169 170
(defcustom grep-error-screen-columns nil
  "*If non-nil, column numbers in grep hits are screen columns.
See `compilation-error-screen-columns'"
  :type '(choice (const :tag "Default" nil)
		 integer)
171
  :version "22.1"
172 173
  :group 'grep)

174 175 176 177 178 179 180 181 182 183
;;;###autoload
(defcustom grep-setup-hook nil
  "List of hook functions run by `grep-process-setup' (see `run-hooks')."
  :type 'hook
  :group 'grep)

(defvar grep-mode-map
  (let ((map (cons 'keymap compilation-minor-mode-map)))
    (define-key map " " 'scroll-up)
    (define-key map "\^?" 'scroll-down)
184
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
185 186 187 188 189 190

    (define-key map "\r" 'compile-goto-error)  ;; ?
    (define-key map "n" 'next-error-no-select)
    (define-key map "p" 'previous-error-no-select)
    (define-key map "{" 'compilation-previous-file)
    (define-key map "}" 'compilation-next-file)
191 192
    (define-key map "\t" 'compilation-next-error)
    (define-key map [backtab] 'compilation-previous-error)
193 194 195 196 197 198 199 200 201 202 203 204

    ;; Set up the menu-bar
    (define-key map [menu-bar grep]
      (cons "Grep" (make-sparse-keymap "Grep")))

    (define-key map [menu-bar grep compilation-kill-compilation]
      '("Kill Grep" . kill-compilation))
    (define-key map [menu-bar grep compilation-separator2]
      '("----" . nil))
    (define-key map [menu-bar grep compilation-compile]
      '("Compile..." . compile))
    (define-key map [menu-bar grep compilation-grep]
205
      '("Another grep..." . grep))
Kim F. Storm's avatar
Kim F. Storm committed
206 207
    (define-key map [menu-bar grep compilation-grep-find]
      '("Recursive grep..." . grep-find))
208 209 210 211 212 213 214 215 216 217 218 219 220 221
    (define-key map [menu-bar grep compilation-recompile]
      '("Repeat grep" . recompile))
    (define-key map [menu-bar grep compilation-separator2]
      '("----" . nil))
    (define-key map [menu-bar grep compilation-first-error]
      '("First Match" . first-error))
    (define-key map [menu-bar grep compilation-previous-error]
      '("Previous Match" . previous-error))
    (define-key map [menu-bar grep compilation-next-error]
      '("Next Match" . next-error))
    map)
  "Keymap for grep buffers.
`compilation-minor-mode-map' is a cdr of this.")

222 223
(defalias 'kill-grep 'kill-compilation)

224 225
;;;; TODO --- refine this!!

226 227 228 229 230 231 232 233
;;; (defcustom grep-use-compilation-buffer t
;;;   "When non-nil, grep specific commands update `compilation-last-buffer'.
;;; This means that standard compile commands like \\[next-error] and \\[compile-goto-error]
;;; can be used to navigate between grep matches (the default).
;;; Otherwise, the grep specific commands like \\[grep-next-match] must
;;; be used to navigate between grep matches."
;;;   :type 'boolean
;;;   :group 'grep)
234 235 236 237

;; override compilation-last-buffer
(defvar grep-last-buffer nil
  "The most recent grep buffer.
238
A grep buffer becomes most recent when you select Grep mode in it.
239 240 241
Notice that using \\[next-error] or \\[compile-goto-error] modifies
`complation-last-buffer' rather than `grep-last-buffer'.")

242
;;;###autoload
243
(defvar grep-regexp-alist
244
  '(("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2"
245 246 247
     1 3)
    ;; Rule to match column numbers is commented out since no known grep
    ;; produces them
248
    ;; ("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2\\(?:\\([0-9]+\\)\\(?:-\\([0-9]+\\)\\)?\\2\\)?"
249
    ;;  1 3 (4 . 5))
250
    ("^\\(\\(.+?\\):\\([0-9]+\\):\\).*?\
Juri Linkov's avatar
Juri Linkov committed
251
\\(\033\\[01;31m\\(?:\033\\[K\\)?\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
252
     2 3
253
     ;; Calculate column positions (beg . end) of first grep match on a line
254
     ((lambda ()
Juri Linkov's avatar
Juri Linkov committed
255 256
	(setq compilation-error-screen-columns nil)
        (- (match-beginning 4) (match-end 1)))
257
      .
Juri Linkov's avatar
Juri Linkov committed
258 259
      (lambda () (- (match-end 5) (match-end 1)
		    (- (match-end 4) (match-beginning 4)))))
260
     nil 1)
261
    ("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
262 263
  "Regexp used to match grep hits.  See `compilation-error-regexp-alist'.")

264 265 266 267 268 269 270 271
(defvar grep-error "grep hit"
  "Message to print when no matches are found.")

;; Reverse the colors because grep hits are not errors (though we jump there
;; with `next-error'), and unreadable files can't be gone to.
(defvar grep-hit-face	compilation-info-face
  "Face name to use for grep hits.")

272
(defvar grep-error-face	'compilation-error
273 274
  "Face name to use for grep error messages.")

Juri Linkov's avatar
Juri Linkov committed
275 276 277
(defvar grep-match-face	'match
  "Face name to use for grep matches.")

278 279 280
(defvar grep-context-face 'shadow
  "Face name to use for grep context lines.")

281 282 283 284 285 286
(defvar grep-mode-font-lock-keywords
   '(;; Command output lines.
     ("^\\([A-Za-z_0-9/\.+-]+\\)[ \t]*:" 1 font-lock-function-name-face)
     (": \\(.+\\): \\(?:Permission denied\\|No such \\(?:file or directory\\|device or address\\)\\)$"
      1 grep-error-face)
     ;; remove match from grep-regexp-alist before fontifying
287
     ("^Grep[/a-zA-z]* started.*"
288
      (0 '(face nil message nil help-echo nil mouse-face nil) t))
289
     ("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
290
      (0 '(face nil message nil help-echo nil mouse-face nil) t)
291 292
      (1 compilation-info-face nil t)
      (2 compilation-warning-face nil t))
293
     ("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
294
      (0 '(face nil message nil help-echo nil mouse-face nil) t)
295
      (1 grep-error-face)
296
      (2 grep-error-face nil t))
297
     ("^.+?-[0-9]+-.*\n" (0 grep-context-face))
298
     ;; Highlight grep matches and delete markers
Juri Linkov's avatar
Juri Linkov committed
299
     ("\\(\033\\[01;31m\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
300 301 302 303
      ;; Refontification does not work after the markers have been
      ;; deleted.  So we use the font-lock-face property here as Font
      ;; Lock does not clear that.
      (2 (list 'face nil 'font-lock-face grep-match-face))
Juri Linkov's avatar
Juri Linkov committed
304
      ((lambda (bound))
305 306 307 308
       (progn
	 ;; Delete markers with `replace-match' because it updates
	 ;; the match-data, whereas `delete-region' would render it obsolete.
	 (replace-match "" t t nil 3)
Juri Linkov's avatar
Juri Linkov committed
309 310 311 312 313
	 (replace-match "" t t nil 1))))
     ("\\(\033\\[[0-9;]*[mK]\\)"
      ;; Delete all remaining escape sequences
      ((lambda (bound))
       (replace-match "" t t nil 1))))
314 315 316
   "Additional things to highlight in grep output.
This gets tacked on the end of the generated expressions.")

317
;;;###autoload
318
(defvar grep-program "grep"
319 320 321
  "The default grep program for `grep-command' and `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")

322
;;;###autoload
323 324 325 326
(defvar find-program "find"
  "The default find program for `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")

327
;;;###autoload
328 329 330
(defvar grep-find-use-xargs nil
  "Whether \\[grep-find] uses the `xargs' utility by default.

331
If `exec', it uses `find -exec'; if `gnu', it uses `find -print0' and `xargs -0';
332 333 334 335 336
if not nil and not `gnu', it uses `find -print' and `xargs'.

This variable's value takes effect when `grep-compute-defaults' is called.")

;; History of grep commands.
337
;;;###autoload
338
(defvar grep-history nil)
339
;;;###autoload
340 341
(defvar grep-find-history nil)

Kim F. Storm's avatar
Kim F. Storm committed
342 343 344 345 346
;; History of lgrep and rgrep regexp and files args.
(defvar grep-regexp-history nil)
(defvar grep-files-history '("ch" "el"))


347
;;;###autoload
348 349
(defun grep-process-setup ()
  "Setup compilation variables and buffer for `grep'.
350
Set up `compilation-exit-message-function' and run `grep-setup-hook'."
351 352 353
  (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
    (grep-compute-defaults))
  (when (eq grep-highlight-matches t)
354 355
    ;; Modify `process-environment' locally bound in `compilation-start'
    (setenv "GREP_OPTIONS" (concat (getenv "GREP_OPTIONS") " --color=always"))
Juri Linkov's avatar
Juri Linkov committed
356 357 358 359
    ;; for GNU grep 2.5.1
    (setenv "GREP_COLOR" "01;31")
    ;; for GNU grep 2.5.1-cvs
    (setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:ml=:cx=:ne"))
360 361 362 363 364 365 366 367 368 369 370 371
  (set (make-local-variable 'compilation-exit-message-function)
       (lambda (status code msg)
	 (if (eq status 'exit)
	     (cond ((zerop code)
		    '("finished (matches found)\n" . "matched"))
		   ((= code 1)
		    '("finished with no matches found\n" . "no match"))
		   (t
		    (cons msg code)))
	   (cons msg code))))
  (run-hooks 'grep-setup-hook))

Kim F. Storm's avatar
Kim F. Storm committed
372 373 374 375 376 377
(defun grep-probe (command args &optional func result)
  (equal (condition-case nil
	     (apply (or func 'call-process) command args)
	   (error nil))
	 (or result 0)))

378
;;;###autoload
379 380 381 382 383 384
(defun grep-compute-defaults ()
  (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
    (setq grep-use-null-device
	  (with-temp-buffer
	    (let ((hello-file (expand-file-name "HELLO" data-directory)))
	      (not
Kim F. Storm's avatar
Kim F. Storm committed
385 386 387 388 389 390 391 392 393
	       (and (if grep-command
			;; `grep-command' is already set, so
			;; use that for testing.
			(grep-probe grep-command
				    `(nil t nil "^English" ,hello-file)
				    #'call-process-shell-command)
		      ;; otherwise use `grep-program'
		      (grep-probe grep-program
				  `(nil t nil "-nH" "^English" ,hello-file)))
394 395 396 397 398
		    (progn
		      (goto-char (point-min))
		      (looking-at
		       (concat (regexp-quote hello-file)
			       ":[0-9]+:English")))))))))
Kim F. Storm's avatar
Kim F. Storm committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  (unless (and grep-command grep-find-command
	       grep-template grep-find-template)
    (let ((grep-options
	   (concat (if grep-use-null-device "-n" "-nH")
		   (if (grep-probe grep-program
				   `(nil nil nil "-e" "foo" ,null-device)
				   nil 1)
		       " -e"))))
      (unless grep-command
	(setq grep-command
	      (format "%s %s " grep-program grep-options)))
      (unless grep-template
	(setq grep-template
	      (format "%s <C> %s <R> <F>" grep-program grep-options)))
      (unless grep-find-use-xargs
	(setq grep-find-use-xargs
415 416 417 418 419 420 421
	      (cond
	       ((and
		 (grep-probe find-program `(nil nil nil ,null-device "-print0"))
		 (grep-probe "xargs" `(nil nil nil "-0" "-e" "echo")))
		'gnu)
	       (t
		'exec))))
Kim F. Storm's avatar
Kim F. Storm committed
422 423 424 425 426
      (unless grep-find-command
	(setq grep-find-command
	      (cond ((eq grep-find-use-xargs 'gnu)
		     (format "%s . -type f -print0 | xargs -0 -e %s"
			     find-program grep-command))
427 428 429 430 431 432 433 434 435
		    ((eq grep-find-use-xargs 'exec)
		     (let ((cmd0 (format "%s . -type f -exec %s"
					 find-program grep-command)))
		       (cons
			(format "%s {} %s %s"
				cmd0 null-device
				(shell-quote-argument ";"))
			(1+ (length cmd0)))))
		    (t
Kim F. Storm's avatar
Kim F. Storm committed
436
		     (format "%s . -type f -print | xargs %s"
437
			     find-program grep-command)))))
Kim F. Storm's avatar
Kim F. Storm committed
438 439 440 441 442 443 444
      (unless grep-find-template
	(setq grep-find-template
	      (let ((gcmd (format "%s <C> %s <R>"
				  grep-program grep-options)))
		(cond ((eq grep-find-use-xargs 'gnu)
		       (format "%s . <X> -type f <F> -print0 | xargs -0 -e %s"
			       find-program gcmd))
445 446 447 448 449
		      ((eq grep-find-use-xargs 'exec)
		       (format "%s . <X> -type f <F> -exec %s {} %s %s"
			       find-program gcmd null-device
			       (shell-quote-argument ";")))
		      (t
Kim F. Storm's avatar
Kim F. Storm committed
450
		       (format "%s . <X> -type f <F> -print | xargs %s"
451
			       find-program gcmd))))))))
452 453 454
  (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
    (setq grep-highlight-matches
	  (with-temp-buffer
Kim F. Storm's avatar
Kim F. Storm committed
455
	    (and (grep-probe grep-program '(nil t nil "--help"))
456 457 458 459
		 (progn
		   (goto-char (point-min))
		   (search-forward "--color" nil t))
		 t)))))
460

461 462 463 464 465 466 467 468 469
(defun grep-tag-default ()
  (or (and transient-mark-mode mark-active
	   (/= (point) (mark))
	   (buffer-substring-no-properties (point) (mark)))
      (funcall (or find-tag-default-function
		   (get major-mode 'find-tag-default-function)
		   'find-tag-default))
      ""))

470
(defun grep-default-command ()
471
  "Compute the default grep command for C-u M-x grep to offer."
472
  (let ((tag-default (shell-quote-argument (grep-tag-default)))
473 474
	;; This a regexp to match single shell arguments.
	;; Could someone please add comments explaining it?
475 476
	(sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
	(grep-default (or (car grep-history) grep-command)))
477
    ;; In the default command, find the arg that specifies the pattern.
478 479 480 481 482 483
    (when (or (string-match
	       (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
		       sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
	       grep-default)
	      ;; If the string is not yet complete.
	      (string-match "\\(\\)\\'" grep-default))
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
      ;; Maybe we will replace the pattern with the default tag.
      ;; But first, maybe replace the file name pattern.
      (condition-case nil
	  (unless (or (not (stringp buffer-file-name))
		      (when (match-beginning 2)
			(save-match-data
			  (string-match
			   (wildcard-to-regexp
			    (file-name-nondirectory
			     (match-string 3 grep-default)))
			   (file-name-nondirectory buffer-file-name)))))
	    (setq grep-default (concat (substring grep-default
						  0 (match-beginning 2))
				       " *."
				       (file-name-extension buffer-file-name))))
	;; In case wildcard-to-regexp gets an error
	;; from invalid data.
	(error nil))
      ;; Now replace the pattern with the default tag.
503
      (replace-match tag-default t t grep-default 1))))
504

Kim F. Storm's avatar
Kim F. Storm committed
505

506
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520
(define-compilation-mode grep-mode "Grep"
  "Sets `grep-last-buffer' and `compilation-window-height'."
  (setq grep-last-buffer (current-buffer))
  (set (make-local-variable 'compilation-error-face)
       grep-hit-face)
  (set (make-local-variable 'compilation-error-regexp-alist)
       grep-regexp-alist)
  (set (make-local-variable 'compilation-process-setup-function)
       'grep-process-setup)
  (set (make-local-variable 'compilation-disable-input) t))


;;;###autoload
(defun grep (command-args)
521 522
  "Run grep, with user-specified args, and collect output in a buffer.
While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
Luc Teirlinck's avatar
Luc Teirlinck committed
523
or \\<grep-mode-map>\\[compile-goto-error] in the grep \
524 525 526
output buffer, to go to the lines
where grep found matches.

527
For doing a recursive `grep', see the `rgrep' command.  For running
528
`grep' in a specific directory, see `lgrep'.
529

530 531 532 533 534 535
This command uses a special history list for its COMMAND-ARGS, so you can
easily repeat a grep command.

A prefix argument says to default the argument based upon the current
tag the cursor is over, substituting it into the last grep command
in the grep command history (or into `grep-command'
Kim F. Storm's avatar
Kim F. Storm committed
536
if that history list is empty)."
537 538
  (interactive
   (progn
Kim F. Storm's avatar
Kim F. Storm committed
539
     (grep-compute-defaults)
540 541 542 543 544 545 546 547 548
     (let ((default (grep-default-command)))
       (list (read-from-minibuffer "Run grep (like this): "
				   (if current-prefix-arg
				       default grep-command)
				   nil nil 'grep-history
				   (if current-prefix-arg nil default))))))

  ;; Setting process-setup-function makes exit-message-function work
  ;; even when async processes aren't supported.
549 550 551
  (compilation-start (if (and grep-use-null-device null-device)
			 (concat command-args " " null-device)
		       command-args)
Kim F. Storm's avatar
Kim F. Storm committed
552
		     'grep-mode))
553

554 555 556 557 558 559 560 561 562 563 564 565

;;;###autoload
(defun grep-find (command-args)
  "Run grep via find, with user-specified args COMMAND-ARGS.
Collect output in a buffer.
While find runs asynchronously, you can use the \\[next-error] command
to find the text that grep hits refer to.

This command uses a special history list for its arguments, so you can
easily repeat a find command."
  (interactive
   (progn
Kim F. Storm's avatar
Kim F. Storm committed
566
     (grep-compute-defaults)
567 568 569 570 571 572 573 574
     (if grep-find-command
	 (list (read-from-minibuffer "Run find (like this): "
				     grep-find-command nil nil
                                     'grep-find-history))
       ;; No default was set
       (read-string
        "compile.el: No `grep-find-command' command available. Press RET.")
       (list nil))))
575
  (when command-args
576 577
    (let ((null-device nil))		; see grep
      (grep command-args))))
578

579 580 581
;;;###autoload
(defalias 'find-grep 'grep-find)

Kim F. Storm's avatar
Kim F. Storm committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

;; User-friendly interactive API.

(defconst grep-expand-keywords
  '(("<C>" . (and cf (isearch-no-upper-case-p regexp t) "-i"))
    ("<D>" . dir)
    ("<F>" . files)
    ("<N>" . null-device)
    ("<X>" . excl)
    ("<R>" . (shell-quote-argument (or regexp ""))))
  "List of substitutions performed by `grep-expand-template'.
If car of an element matches, the cdr is evalled in to get the
substitution string.  Note dynamic scoping of variables.")

(defun grep-expand-template (template &optional regexp files dir excl)
  "Patch grep COMMAND string replacing <C>, <D>, <F>, <R>, and <X>."
  (let ((command template)
	(cf case-fold-search)
	(case-fold-search nil))
    (dolist (kw grep-expand-keywords command)
      (if (string-match (car kw) command)
603 604 605
	  (setq command
		(replace-match
		 (or (if (symbolp (cdr kw))
606
			 (symbol-value (cdr kw))
607 608 609
		       (save-match-data (eval (cdr kw))))
		     "")
		 t t command))))))
Kim F. Storm's avatar
Kim F. Storm committed
610 611 612

(defun grep-read-regexp ()
  "Read regexp arg for interactive grep."
613
  (let ((default (grep-tag-default)))
Kim F. Storm's avatar
Kim F. Storm committed
614 615 616
    (read-string
     (concat "Search for"
	     (if (and default (> (length default) 0))
617
		 (format " (default \"%s\"): " default) ": "))
Kim F. Storm's avatar
Kim F. Storm committed
618 619 620 621
     nil 'grep-regexp-history default)))

(defun grep-read-files (regexp)
  "Read files arg for interactive grep."
622 623 624 625 626 627 628
  (let* ((bn (or (buffer-file-name) (buffer-name)))
	 (fn (and bn
		  (stringp bn)
		  (file-name-nondirectory bn)))
	 (default
	   (or (and fn
		    (let ((aliases grep-files-aliases)
Kim F. Storm's avatar
Kim F. Storm committed
629 630 631 632 633 634 635 636
			  alias)
		      (while aliases
			(setq alias (car aliases)
			      aliases (cdr aliases))
			(if (string-match (wildcard-to-regexp (cdr alias)) fn)
			    (setq aliases nil)
			  (setq alias nil)))
		      (cdr alias)))
637 638
	       (and fn
		    (let ((ext (file-name-extension fn)))
639 640 641
		      (and ext (concat "*." ext))))
	       (car grep-files-history)
	       (car (car grep-files-aliases))))
Kim F. Storm's avatar
Kim F. Storm committed
642 643
	 (files (read-string
		 (concat "Search for \"" regexp
644 645 646
			 "\" in files"
			 (if default (concat " (default " default ")"))
			 ": ")
Kim F. Storm's avatar
Kim F. Storm committed
647 648 649 650
		 nil 'grep-files-history default)))
    (and files
	 (or (cdr (assoc files grep-files-aliases))
	     files))))
651 652

;;;###autoload
653 654
(defun lgrep (regexp &optional files dir)
  "Run grep, searching for REGEXP in FILES in directory DIR.
655
The search is limited to file names matching shell pattern FILES.
Kim F. Storm's avatar
Kim F. Storm committed
656
FILES may use abbreviations defined in `grep-files-aliases', e.g.
657 658
entering `ch' is equivalent to `*.[ch]'.

Kim F. Storm's avatar
Kim F. Storm committed
659 660 661
With \\[universal-argument] prefix, you can edit the constructed shell command line
before it is executed.
With two \\[universal-argument] prefixes, directly edit and run `grep-command'.
662

Kim F. Storm's avatar
Kim F. Storm committed
663 664 665
Collect output in a buffer.  While grep runs asynchronously, you
can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error]
in the grep output buffer, to go to the lines where grep found matches.
666

Kim F. Storm's avatar
Kim F. Storm committed
667
This command shares argument histories with \\[rgrep] and \\[grep]."
668
  (interactive
Kim F. Storm's avatar
Kim F. Storm committed
669 670 671 672 673 674 675 676 677 678 679
   (progn
     (grep-compute-defaults)
     (cond
      ((and grep-command (equal current-prefix-arg '(16)))
       (list (read-from-minibuffer "Run: " grep-command
				   nil nil 'grep-history)
	     nil))
      ((not grep-template)
       (list nil
	     (read-string "grep.el: No `grep-template' available. Press RET.")))
      (t (let* ((regexp (grep-read-regexp))
680 681 682 683
		(files (grep-read-files regexp))
		(dir (read-directory-name "In directory: "
					  nil default-directory t)))
	   (list regexp files dir))))))
Kim F. Storm's avatar
Kim F. Storm committed
684 685 686 687 688
  (when (and (stringp regexp) (> (length regexp) 0))
    (let ((command regexp))
      (if (null files)
	  (if (string= command grep-command)
	      (setq command nil))
689
	(setq dir (file-name-as-directory (expand-file-name dir)))
Kim F. Storm's avatar
Kim F. Storm committed
690 691 692 693 694 695 696 697 698
	(setq command (grep-expand-template
		       grep-template
		       regexp
		       files))
	(when command
	  (if (equal current-prefix-arg '(4))
	      (setq command
		    (read-from-minibuffer "Confirm: "
					  command nil nil 'grep-history))
699
	    (add-to-history 'grep-history command))))
Kim F. Storm's avatar
Kim F. Storm committed
700
      (when command
701 702 703 704 705 706 707 708 709
	(let ((default-directory dir))
	  ;; Setting process-setup-function makes exit-message-function work
	  ;; even when async processes aren't supported.
	  (compilation-start (if (and grep-use-null-device null-device)
				 (concat command " " null-device)
			       command) 'grep-mode))
	(if (eq next-error-last-buffer (current-buffer))
	    (setq default-directory dir))))))

Kim F. Storm's avatar
Kim F. Storm committed
710 711 712 713


;;;###autoload
(defun rgrep (regexp &optional files dir)
Kim F. Storm's avatar
Kim F. Storm committed
714
  "Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
Kim F. Storm's avatar
Kim F. Storm committed
715 716 717 718
The search is limited to file names matching shell pattern FILES.
FILES may use abbreviations defined in `grep-files-aliases', e.g.
entering `ch' is equivalent to `*.[ch]'.

Kim F. Storm's avatar
Kim F. Storm committed
719 720 721
With \\[universal-argument] prefix, you can edit the constructed shell command line
before it is executed.
With two \\[universal-argument] prefixes, directly edit and run `grep-find-command'.
Kim F. Storm's avatar
Kim F. Storm committed
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747

Collect output in a buffer.  While find runs asynchronously, you
can use \\[next-error] (M-x next-error), or \\<grep-mode-map>\\[compile-goto-error]
in the grep output buffer, to go to the lines where grep found matches.

This command shares argument histories with \\[lgrep] and \\[grep-find]."
  (interactive
   (progn
     (grep-compute-defaults)
     (cond
      ((and grep-find-command (equal current-prefix-arg '(16)))
       (list (read-from-minibuffer "Run: " grep-find-command
				   nil nil 'grep-find-history)
	     nil))
      ((not grep-find-template)
       (list nil nil
	     (read-string "grep.el: No `grep-find-template' available. Press RET.")))
      (t (let* ((regexp (grep-read-regexp))
		(files (grep-read-files regexp))
		(dir (read-directory-name "Base directory: "
					  nil default-directory t)))
	   (list regexp files dir))))))
  (when (and (stringp regexp) (> (length regexp) 0))
    (if (null files)
	(if (not (string= regexp grep-find-command))
	    (compilation-start regexp 'grep-mode))
748 749 750 751
      (setq dir (file-name-as-directory (expand-file-name dir)))
      (let ((command (grep-expand-template
		      grep-find-template
		      regexp
752 753
		      (concat (shell-quote-argument "(")
			      " -name "
754 755 756
			      (mapconcat #'shell-quote-argument
					 (split-string files)
					 " -o -name ")
757 758
			      " "
			      (shell-quote-argument ")"))
759
		       dir
Kim F. Storm's avatar
Kim F. Storm committed
760
		       (and grep-find-ignored-directories
761 762 763 764 765 766
			    (concat (shell-quote-argument "(")
				    ;; we should use shell-quote-argument here
				    " -path "
				    (mapconcat #'(lambda (dir)
						   (shell-quote-argument
						    (concat "*/" dir)))
Kim F. Storm's avatar
Kim F. Storm committed
767
					       grep-find-ignored-directories
768 769 770 771
					       " -o -path ")
				    " "
				    (shell-quote-argument ")")
				    " -prune -o ")))))
Kim F. Storm's avatar
Kim F. Storm committed
772 773 774 775 776
	(when command
	  (if current-prefix-arg
	      (setq command
		    (read-from-minibuffer "Confirm: "
					  command nil nil 'grep-find-history))
777
	    (add-to-history 'grep-find-history command))
778 779 780 781 782
	  (let ((default-directory dir))
	    (compilation-start command 'grep-mode))
	  ;; Set default-directory if we started rgrep in the *grep* buffer.
	  (if (eq next-error-last-buffer (current-buffer))
	      (setq default-directory dir)))))))
783 784 785 786


(provide 'grep)

787
;; arch-tag: 5a5b9169-a79d-4f38-9c38-f69615f39c4d
788
;;; grep.el ends here