grep.el 32.2 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,
4 5
;;   2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
;;   Free Software Foundation, Inc.
6 7 8 9 10 11 12 13 14

;; 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
15
;; the Free Software Foundation; either version 3, or (at your option)
16 17 18 19 20 21 22 23 24
;; 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
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
27 28 29 30 31 32 33 34 35 36

;;; Commentary:

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

;;; Code:

(require 'compile)

37

38
(defgroup grep nil
Kim F. Storm's avatar
Kim F. Storm committed
39
  "Run grep as inferior of Emacs, parse error messages."
40 41 42 43 44 45 46 47 48
  :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)
49
  :version "22.1"
50 51
  :group 'grep)

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

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
62 63 64 65
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."
66 67 68
  :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))
69
  :version "22.1"
70 71
  :group 'grep)

72 73 74 75 76 77 78
(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
79
  :version "22.1"
80 81
  :group 'grep)

82
;;;###autoload
83 84 85 86 87 88 89 90 91 92 93 94
(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
95 96 97 98 99 100 101 102 103 104 105 106 107 108
(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)

109 110 111 112 113 114 115 116 117 118 119 120 121
(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)

122
;;;###autoload
123 124 125 126 127 128 129 130
(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
131 132
(defcustom grep-find-template nil
  "The default command to run for \\[rgrep].
133 134 135 136 137 138 139 140 141 142
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))
143
  :version "22.1"
144 145
  :group 'grep)

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

161
(defcustom grep-find-ignored-directories
162
  vc-directory-exclusion-list
Kim F. Storm's avatar
Kim F. Storm committed
163 164
  "*List of names of sub-directories which `rgrep' shall not recurse into."
  :type '(repeat string)
165 166
  :group 'grep)

167 168 169 170 171
(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)
172
  :version "22.1"
173 174
  :group 'grep)

175 176 177 178 179 180 181 182 183 184
;;;###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)
185
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
186 187 188 189

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

    ;; 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]
201 202 203
      '(menu-item "Kill Grep" kill-compilation
		  :help "Kill the currently running grep process"))
    (define-key map [menu-bar grep compilation-separator2] '("----"))
204
    (define-key map [menu-bar grep compilation-compile]
205 206
      '(menu-item "Compile..." compile
		  :help "Compile the program including the current buffer.  Default: run `make'"))
207
    (define-key map [menu-bar grep compilation-grep]
208 209
      '(menu-item "Another grep..." grep
		  :help "Run grep, with user-specified args, and collect output in a buffer."))
Kim F. Storm's avatar
Kim F. Storm committed
210
    (define-key map [menu-bar grep compilation-grep-find]
211 212
      '(menu-item "Recursive grep..." grep-find
		  :help "Run grep via find, with user-specified args"))
213
    (define-key map [menu-bar grep compilation-recompile]
214 215 216
      '(menu-item "Repeat grep" recompile
		  :help "Run grep again"))
    (define-key map [menu-bar grep compilation-separator2] '("----"))
217
    (define-key map [menu-bar grep compilation-first-error]
218 219
      '(menu-item "First Match" first-error
		  :help "Restart at the first match, visit corresponding location"))
220
    (define-key map [menu-bar grep compilation-previous-error]
221 222
      '(menu-item "Previous Match" previous-error
		  :help "Visit the previous match and corresponding location"))
223
    (define-key map [menu-bar grep compilation-next-error]
224 225
      '(menu-item "Next Match" next-error
		  :help "Visit the next match and corresponding location"))
226 227 228 229
    map)
  "Keymap for grep buffers.
`compilation-minor-mode-map' is a cdr of this.")

230 231 232 233
(defvar grep-mode-tool-bar-map
  (if (display-graphic-p)
      (let ((map (butlast (copy-keymap tool-bar-map)))
	    (help (last tool-bar-map))) ;; Keep Help last in tool bar
234
	(tool-bar-local-item
235 236 237
	 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
	 :rtl "right-arrow"
	 :help "Goto previous match")
238 239 240 241
	(tool-bar-local-item
	 "right-arrow" 'next-error-no-select 'next-error-no-select map
	 :rtl "left-arrow"
	 :help "Goto next match")
242
	(tool-bar-local-item
243
	 "cancel" 'kill-compilation 'kill-compilation map
244 245
	 :enable '(let ((buffer (compilation-find-buffer)))
		    (get-buffer-process buffer))
246
	 :help "Stop grep")
247
	(tool-bar-local-item
248 249 250 251
	 "refresh" 'recompile 'recompile map
	 :help "Restart grep")
	(append map help))))

252 253
(defalias 'kill-grep 'kill-compilation)

254 255
;;;; TODO --- refine this!!

Stefan Monnier's avatar
Stefan Monnier committed
256 257 258 259 260 261 262 263
;; (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)
264 265 266 267

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

272
;;;###autoload
273
(defvar grep-regexp-alist
274
  '(("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2"
275 276 277
     1 3)
    ;; Rule to match column numbers is commented out since no known grep
    ;; produces them
278
    ;; ("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2\\(?:\\([0-9]+\\)\\(?:-\\([0-9]+\\)\\)?\\2\\)?"
279
    ;;  1 3 (4 . 5))
280
    ("^\\(\\(.+?\\):\\([0-9]+\\):\\).*?\
Juri Linkov's avatar
Juri Linkov committed
281
\\(\033\\[01;31m\\(?:\033\\[K\\)?\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
282
     2 3
283
     ;; Calculate column positions (beg . end) of first grep match on a line
284
     ((lambda ()
Juri Linkov's avatar
Juri Linkov committed
285 286
	(setq compilation-error-screen-columns nil)
        (- (match-beginning 4) (match-end 1)))
287
      .
Juri Linkov's avatar
Juri Linkov committed
288 289
      (lambda () (- (match-end 5) (match-end 1)
		    (- (match-end 4) (match-beginning 4)))))
290
     nil 1)
291
    ("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
292 293
  "Regexp used to match grep hits.  See `compilation-error-regexp-alist'.")

294 295 296 297 298 299 300 301
(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.")

302
(defvar grep-error-face	'compilation-error
303 304
  "Face name to use for grep error messages.")

Juri Linkov's avatar
Juri Linkov committed
305 306 307
(defvar grep-match-face	'match
  "Face name to use for grep matches.")

308 309 310
(defvar grep-context-face 'shadow
  "Face name to use for grep context lines.")

311 312 313 314 315 316
(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
317
     ("^Grep[/a-zA-z]* started.*"
318
      (0 '(face nil message nil help-echo nil mouse-face nil) t))
319
     ("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
320
      (0 '(face nil message nil help-echo nil mouse-face nil) t)
321 322
      (1 compilation-info-face nil t)
      (2 compilation-warning-face nil t))
323
     ("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
324
      (0 '(face nil message nil help-echo nil mouse-face nil) t)
325
      (1 grep-error-face)
326
      (2 grep-error-face nil t))
327
     ("^.+?-[0-9]+-.*\n" (0 grep-context-face))
328
     ;; Highlight grep matches and delete markers
Juri Linkov's avatar
Juri Linkov committed
329
     ("\\(\033\\[01;31m\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
330 331 332 333
      ;; 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
334
      ((lambda (bound))
335 336 337 338
       (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
339 340 341 342 343
	 (replace-match "" t t nil 1))))
     ("\\(\033\\[[0-9;]*[mK]\\)"
      ;; Delete all remaining escape sequences
      ((lambda (bound))
       (replace-match "" t t nil 1))))
344 345 346
   "Additional things to highlight in grep output.
This gets tacked on the end of the generated expressions.")

347
;;;###autoload
348
(defvar grep-program "grep"
349 350 351
  "The default grep program for `grep-command' and `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")

352
;;;###autoload
353 354 355 356
(defvar find-program "find"
  "The default find program for `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")

357 358 359 360 361 362
;;;###autoload
(defvar xargs-program "xargs"
  "The default xargs program for `grep-find-command'.
See `grep-find-use-xargs'.
This variable's value takes effect when `grep-compute-defaults' is called.")

363
;;;###autoload
364
(defvar grep-find-use-xargs nil
365 366 367 368
  "Non-nil means that `grep-find' uses the `xargs' utility by default.
If `exec', use `find -exec'.
If `gnu', use `find -print0' and `xargs -0'.
Any other non-nil value means to use `find -print' and `xargs'.
369 370 371 372

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

;; History of grep commands.
373
;;;###autoload
374
(defvar grep-history nil)
375
;;;###autoload
376 377
(defvar grep-find-history nil)

Kim F. Storm's avatar
Kim F. Storm committed
378 379 380 381
;; History of lgrep and rgrep regexp and files args.
(defvar grep-regexp-history nil)
(defvar grep-files-history '("ch" "el"))

382 383 384 385 386 387
(defvar grep-host-defaults-alist nil
  "Default values depending on target host.
`grep-compute-defaults' returns default values for every local or
remote host `grep' runs.  These values can differ from host to
host.  Once computed, the default values are kept here in order
to avoid computing them again.")
Kim F. Storm's avatar
Kim F. Storm committed
388

389
;;;###autoload
390 391
(defun grep-process-setup ()
  "Setup compilation variables and buffer for `grep'.
392
Set up `compilation-exit-message-function' and run `grep-setup-hook'."
393 394 395
  (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
    (grep-compute-defaults))
  (when (eq grep-highlight-matches t)
396 397 398 399 400 401 402 403
    ;; `setenv' modifies `process-environment' let-bound in `compilation-start'
    ;; Any TERM except "dumb" allows GNU grep to use `--color=auto'
    (setenv "TERM" "emacs-grep")
    ;; `--color=auto' emits escape sequences on a tty rather than on a pipe,
    ;; thus allowing to use multiple grep filters on the command line
    ;; and to output escape sequences only on the final grep output
    (setenv "GREP_OPTIONS" (concat (getenv "GREP_OPTIONS") " --color=auto"))
    ;; GREP_COLOR is used in GNU grep 2.5.1, but deprecated in later versions
Juri Linkov's avatar
Juri Linkov committed
404
    (setenv "GREP_COLOR" "01;31")
405
    ;; GREP_COLORS is used in GNU grep 2.5.2 and later versions
Juri Linkov's avatar
Juri Linkov committed
406
    (setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:ml=:cx=:ne"))
407 408 409 410 411 412 413 414 415 416 417 418
  (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
419 420
(defun grep-probe (command args &optional func result)
  (equal (condition-case nil
421
	     (apply (or func 'process-file) command args)
Kim F. Storm's avatar
Kim F. Storm committed
422 423 424
	   (error nil))
	 (or result 0)))

425
;;;###autoload
426
(defun grep-compute-defaults ()
427 428 429 430 431 432 433 434 435 436 437 438 439
  ;; Keep default values.
  (unless grep-host-defaults-alist
    (add-to-list
     'grep-host-defaults-alist
     (cons nil
	   `((grep-command ,grep-command)
	     (grep-template ,grep-template)
	     (grep-use-null-device ,grep-use-null-device)
	     (grep-find-command ,grep-find-command)
	     (grep-find-template ,grep-find-template)
	     (grep-find-use-xargs ,grep-find-use-xargs)
	     (grep-highlight-matches ,grep-highlight-matches)))))
  (let* ((host-id
Stefan Monnier's avatar
Stefan Monnier committed
440
	  (intern (or (file-remote-p default-directory) "localhost")))
441 442
	 (host-defaults (assq host-id grep-host-defaults-alist))
	 (defaults (assq nil grep-host-defaults-alist)))
443
    ;; There are different defaults on different hosts.  They must be
444
    ;; computed for every host once.
445
    (setq grep-command
446 447
	  (or (cadr (assq 'grep-command host-defaults))
	      (cadr (assq 'grep-command defaults)))
448 449

	  grep-template
450 451
          (or (cadr (assq 'grep-template host-defaults))
	      (cadr (assq 'grep-template defaults)))
452 453

	  grep-use-null-device
454 455
	  (or (cadr (assq 'grep-use-null-device host-defaults))
	      (cadr (assq 'grep-use-null-device defaults)))
456 457

	  grep-find-command
458 459
	  (or (cadr (assq 'grep-find-command host-defaults))
	      (cadr (assq 'grep-find-command defaults)))
460 461

	  grep-find-template
462 463
	  (or (cadr (assq 'grep-find-template host-defaults))
	      (cadr (assq 'grep-find-template defaults)))
464 465

	  grep-find-use-xargs
466 467
	  (or (cadr (assq 'grep-find-use-xargs host-defaults))
	      (cadr (assq 'grep-find-use-xargs defaults)))
468 469

	  grep-highlight-matches
470 471
	  (or (cadr (assq 'grep-highlight-matches host-defaults))
	      (cadr (assq 'grep-highlight-matches defaults))))
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

    (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
		 (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)))
		      (progn
			(goto-char (point-min))
			(looking-at
			 (concat (regexp-quote hello-file)
				 ":[0-9]+:English")))))))))
    (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
		(cond
		 ((and
		   (grep-probe find-program `(nil nil nil ,null-device "-print0"))
511
		   (grep-probe xargs-program `(nil nil nil "-0" "-e" "echo")))
512 513 514 515 516
		  'gnu)
		 (t
		  'exec))))
	(unless grep-find-command
	  (setq grep-find-command
Kim F. Storm's avatar
Kim F. Storm committed
517
		(cond ((eq grep-find-use-xargs 'gnu)
518 519
		       (format "%s . -type f -print0 | %s -0 -e %s"
			       find-program xargs-program grep-command))
520
		      ((eq grep-find-use-xargs 'exec)
521 522 523 524 525 526 527
		       (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)))))
528
		      (t
529 530
		       (format "%s . -type f -print | %s %s"
			       find-program xargs-program grep-command)))))
531 532 533 534 535
	(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)
536 537
			 (format "%s . <X> -type f <F> -print0 | %s -0 -e %s"
				 find-program xargs-program gcmd))
538 539 540 541 542
			((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
543 544
			 (format "%s . <X> -type f <F> -print | %s %s"
				 find-program xargs-program gcmd))))))))
545 546 547 548 549 550 551 552 553 554
    (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
      (setq grep-highlight-matches
	    (with-temp-buffer
	      (and (grep-probe grep-program '(nil t nil "--help"))
		   (progn
		     (goto-char (point-min))
		     (search-forward "--color" nil t))
		   t))))

    ;; Save defaults for this host.
555 556 557 558 559 560 561 562 563 564 565 566 567
    (setq grep-host-defaults-alist
	  (delete (assq host-id grep-host-defaults-alist)
		  grep-host-defaults-alist))
    (add-to-list
     'grep-host-defaults-alist
     (cons host-id
	   `((grep-command ,grep-command)
	     (grep-template ,grep-template)
	     (grep-use-null-device ,grep-use-null-device)
	     (grep-find-command ,grep-find-command)
	     (grep-find-template ,grep-find-template)
	     (grep-find-use-xargs ,grep-find-use-xargs)
	     (grep-highlight-matches ,grep-highlight-matches))))))
568

569 570 571 572 573 574 575 576 577
(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))
      ""))

578
(defun grep-default-command ()
579
  "Compute the default grep command for \\[universal-argument] \\[grep] to offer."
580
  (let ((tag-default (shell-quote-argument (grep-tag-default)))
581 582
	;; This a regexp to match single shell arguments.
	;; Could someone please add comments explaining it?
583 584
	(sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
	(grep-default (or (car grep-history) grep-command)))
585
    ;; In the default command, find the arg that specifies the pattern.
586 587 588 589 590 591
    (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))
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
      ;; 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.
611
      (replace-match tag-default t t grep-default 1))))
612

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

614
;;;###autoload
Kim F. Storm's avatar
Kim F. Storm committed
615 616 617
(define-compilation-mode grep-mode "Grep"
  "Sets `grep-last-buffer' and `compilation-window-height'."
  (setq grep-last-buffer (current-buffer))
618
  (set (make-local-variable 'tool-bar-map) grep-mode-tool-bar-map)
Kim F. Storm's avatar
Kim F. Storm committed
619 620 621 622 623 624 625 626 627 628 629
  (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)
630 631
  "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
632
or \\<grep-mode-map>\\[compile-goto-error] in the grep \
633 634
output buffer, to go to the lines where grep
found matches.
635

636
For doing a recursive `grep', see the `rgrep' command.  For running
637
`grep' in a specific directory, see `lgrep'.
638

639 640
This command uses a special history list for its COMMAND-ARGS, so you
can easily repeat a grep command.
641 642 643

A prefix argument says to default the argument based upon the current
tag the cursor is over, substituting it into the last grep command
644 645
in the grep command history (or into `grep-command' if that history
list is empty)."
646 647
  (interactive
   (progn
Kim F. Storm's avatar
Kim F. Storm committed
648
     (grep-compute-defaults)
649
     (let ((default (grep-default-command)))
650 651 652 653
       (list (read-shell-command "Run grep (like this): "
                                 (if current-prefix-arg default grep-command)
                                 'grep-history
                                 (if current-prefix-arg nil default))))))
654 655 656

  ;; Setting process-setup-function makes exit-message-function work
  ;; even when async processes aren't supported.
657 658 659
  (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
660
		     'grep-mode))
661

662 663 664 665 666 667 668 669 670 671 672 673

;;;###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
674
     (grep-compute-defaults)
675
     (if grep-find-command
676 677
	 (list (read-shell-command "Run find (like this): "
                                   grep-find-command 'grep-find-history))
678 679 680 681
       ;; No default was set
       (read-string
        "compile.el: No `grep-find-command' command available. Press RET.")
       (list nil))))
682
  (when command-args
683 684
    (let ((null-device nil))		; see grep
      (grep command-args))))
685

686 687 688
;;;###autoload
(defalias 'find-grep 'grep-find)

Kim F. Storm's avatar
Kim F. Storm committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709

;; 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)
710 711 712
	  (setq command
		(replace-match
		 (or (if (symbolp (cdr kw))
713
			 (symbol-value (cdr kw))
714 715 716
		       (save-match-data (eval (cdr kw))))
		     "")
		 t t command))))))
Kim F. Storm's avatar
Kim F. Storm committed
717 718 719

(defun grep-read-regexp ()
  "Read regexp arg for interactive grep."
720
  (let ((default (grep-tag-default)))
Kim F. Storm's avatar
Kim F. Storm committed
721 722 723
    (read-string
     (concat "Search for"
	     (if (and default (> (length default) 0))
724
		 (format " (default \"%s\"): " default) ": "))
Kim F. Storm's avatar
Kim F. Storm committed
725 726 727 728
     nil 'grep-regexp-history default)))

(defun grep-read-files (regexp)
  "Read files arg for interactive grep."
729 730 731 732 733 734 735
  (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
736 737 738 739 740 741 742 743
			  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)))
744 745
	       (and fn
		    (let ((ext (file-name-extension fn)))
746 747 748
		      (and ext (concat "*." ext))))
	       (car grep-files-history)
	       (car (car grep-files-aliases))))
Kim F. Storm's avatar
Kim F. Storm committed
749 750
	 (files (read-string
		 (concat "Search for \"" regexp
751 752 753
			 "\" in files"
			 (if default (concat " (default " default ")"))
			 ": ")
Kim F. Storm's avatar
Kim F. Storm committed
754 755 756 757
		 nil 'grep-files-history default)))
    (and files
	 (or (cdr (assoc files grep-files-aliases))
	     files))))
758 759

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

Kim F. Storm's avatar
Kim F. Storm committed
766 767 768
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'.
769

Kim F. Storm's avatar
Kim F. Storm committed
770
Collect output in a buffer.  While grep runs asynchronously, you
771 772 773
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.
774

Kim F. Storm's avatar
Kim F. Storm committed
775
This command shares argument histories with \\[rgrep] and \\[grep]."
776
  (interactive
Kim F. Storm's avatar
Kim F. Storm committed
777 778 779 780 781 782 783 784 785 786 787
   (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))
788 789 790 791
		(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
792 793 794 795 796
  (when (and (stringp regexp) (> (length regexp) 0))
    (let ((command regexp))
      (if (null files)
	  (if (string= command grep-command)
	      (setq command nil))
797
	(setq dir (file-name-as-directory (expand-file-name dir)))
Kim F. Storm's avatar
Kim F. Storm committed
798 799 800 801 802 803 804 805 806
	(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))
807
	    (add-to-history 'grep-history command))))
Kim F. Storm's avatar
Kim F. Storm committed
808
      (when command
809 810 811 812 813
	(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)
Richard M. Stallman's avatar
Richard M. Stallman committed
814 815
			       command)
			     'grep-mode))
816 817 818
	(if (eq next-error-last-buffer (current-buffer))
	    (setq default-directory dir))))))

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

820
(defvar find-name-arg)                  ; autoloaded
Kim F. Storm's avatar
Kim F. Storm committed
821 822 823

;;;###autoload
(defun rgrep (regexp &optional files dir)
Kim F. Storm's avatar
Kim F. Storm committed
824
  "Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
Kim F. Storm's avatar
Kim F. Storm committed
825 826 827 828
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
829 830 831
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
832 833

Collect output in a buffer.  While find runs asynchronously, you
834 835 836
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.
Kim F. Storm's avatar
Kim F. Storm committed
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

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))
859 860 861 862
      (setq dir (file-name-as-directory (expand-file-name dir)))
      (let ((command (grep-expand-template
		      grep-find-template
		      regexp
863
		      (concat (shell-quote-argument "(")
Jason Rumney's avatar
Jason Rumney committed
864
			      " " find-name-arg " "
865 866
			      (mapconcat #'shell-quote-argument
					 (split-string files)
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
867
					 (concat " -o " find-name-arg " "))
868 869
			      " "
			      (shell-quote-argument ")"))
870
		       dir
Kim F. Storm's avatar
Kim F. Storm committed
871
		       (and grep-find-ignored-directories
872 873 874 875 876 877
			    (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
878
					       grep-find-ignored-directories
879 880 881 882
					       " -o -path ")
				    " "
				    (shell-quote-argument ")")
				    " -prune -o ")))))
Kim F. Storm's avatar
Kim F. Storm committed
883 884 885 886 887
	(when command
	  (if current-prefix-arg
	      (setq command
		    (read-from-minibuffer "Confirm: "
					  command nil nil 'grep-find-history))
888
	    (add-to-history 'grep-find-history command))
889 890 891 892 893
	  (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)))))))
894 895 896 897


(provide 'grep)

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