;;; grep.el --- run Grep as inferior of Emacs, parse match messages
-;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
-;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 1985-1987, 1993-1999, 2001-2011
+;; Free Software Foundation, Inc.
;; Author: Roland McGrath <roland@gnu.org>
;; Maintainer: FSF
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, 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
;; 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
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
:group 'tools
:group 'processes)
+(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.")
+
+(defun grep-apply-setting (symbol value)
+ "Set SYMBOL to VALUE, and update `grep-host-defaults-alist'.
+SYMBOL should be one of `grep-command', `grep-template',
+`grep-use-null-device', `grep-find-command',
+`grep-find-template', `grep-find-use-xargs', or
+`grep-highlight-matches'."
+ (when grep-host-defaults-alist
+ (let* ((host-id
+ (intern (or (file-remote-p default-directory) "localhost")))
+ (host-defaults (assq host-id grep-host-defaults-alist))
+ (defaults (assq nil grep-host-defaults-alist)))
+ (setcar (cdr (assq symbol host-defaults)) value)
+ (setcar (cdr (assq symbol defaults)) value)))
+ (set-default symbol value))
;;;###autoload
(defcustom grep-window-height nil
:group 'grep)
(defcustom grep-highlight-matches 'auto-detect
- "If t, use special markers to highlight grep matches.
+ "Use special markers to highlight grep matches.
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
+This option sets the environment variable GREP_COLORS to specify
markers for highlighting and GREP_OPTIONS to add the --color
option in front of any explicit grep options before starting
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."
+When this option is `auto', grep uses `--color=auto' to highlight
+matches only when it outputs to a terminal (when `grep' is the last
+command in the pipe), thus avoiding the use of any potentially-harmful
+escape sequences when standard output goes to a file or pipe.
+
+To make grep highlight matches even into a pipe, you need the option
+`always' that forces grep to use `--color=always' to unconditionally
+output escape sequences.
+
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults' when the default value is `auto-detect'.
+To change the default value, use Customize or call the function
+`grep-apply-setting'."
:type '(choice (const :tag "Do not highlight matches with grep markers" nil)
(const :tag "Highlight matches with grep markers" t)
+ (const :tag "Use --color=always" always)
+ (const :tag "Use --color=auto" auto)
(other :tag "Not Set" auto-detect))
+ :set 'grep-apply-setting
:version "22.1"
:group 'grep)
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."
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults'; to change the default value, use
+Customize or call the function `grep-apply-setting'."
:type '(choice string
(const :tag "Not Set" nil))
+ :set 'grep-apply-setting
:group 'grep)
(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.
+ <X> - file names and wildcards to exclude.
<R> - the regular expression searched for.
- <N> - place to insert null-device."
+ <N> - place to insert null-device.
+
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults'; to change the default value, use
+Customize or call the function `grep-apply-setting'."
:type '(choice string
(const :tag "Not Set" nil))
+ :set 'grep-apply-setting
:version "22.1"
:group 'grep)
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."
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults'; to change the default value, use
+Customize or call the function `grep-apply-setting'."
:type '(choice (const :tag "Do Not Append Null Device" nil)
(const :tag "Append Null Device" t)
(other :tag "Not Set" auto-detect))
+ :set 'grep-apply-setting
:group 'grep)
;;;###autoload
(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."
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults'; to change the default value, use
+Customize or call the function `grep-apply-setting'."
:type '(choice string
(const :tag "Not Set" nil))
+ :set 'grep-apply-setting
:group 'grep)
(defcustom grep-find-template nil
"The default command to run for \\[rgrep].
-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."
+ <R> - the regular expression searched for.
+In interactive usage, the actual value of this variable is set up
+by `grep-compute-defaults'; to change the default value, use
+Customize or call the function `grep-apply-setting'."
:type '(choice string
(const :tag "Not Set" nil))
+ :set 'grep-apply-setting
:version "22.1"
:group 'grep)
-(defcustom grep-files-aliases '(
- ("el" . "*.el")
- ("ch" . "*.[ch]")
- ("c" . "*.c")
- ("h" . "*.h")
- ("asm" . "*.[sS]")
- ("m" . "[Mm]akefile*")
- ("l" . "[Cc]hange[Ll]og*")
- ("tex" . "*.tex")
- ("texi" . "*.texi")
- )
+(defcustom grep-files-aliases
+ '(("all" . "* .*")
+ ("el" . "*.el")
+ ("ch" . "*.[ch]")
+ ("c" . "*.c")
+ ("cc" . "*.cc *.cxx *.cpp *.C *.CC *.c++")
+ ("cchh" . "*.cc *.[ch]xx *.[ch]pp *.[CHh] *.CC *.HH *.[ch]++")
+ ("hh" . "*.hxx *.hpp *.[Hh] *.HH *.h++")
+ ("h" . "*.h")
+ ("l" . "[Cc]hange[Ll]og*")
+ ("m" . "[Mm]akefile*")
+ ("tex" . "*.tex")
+ ("texi" . "*.texi")
+ ("asm" . "*.[sS]"))
"*Alist of aliases for the FILES argument to `lgrep' and `rgrep'."
:type 'alist
:group 'grep)
-(defcustom grep-find-ignored-directories '("CVS" ".svn" "{arch}" ".hg" "_darcs"
- ".git" ".bzr")
- "*List of names of sub-directories which `rgrep' shall not recurse into."
- :type '(repeat string)
+(defcustom grep-find-ignored-directories
+ vc-directory-exclusion-list
+ "*List of names of sub-directories which `rgrep' shall not recurse into.
+If an element is a cons cell, the car is called on the search directory
+to determine whether cdr should not be recursed into."
+ :type '(choice (repeat :tag "Ignored directories" string)
+ (const :tag "No ignored directories" nil))
+ :group 'grep)
+
+(defcustom grep-find-ignored-files
+ (cons ".#*" (delq nil (mapcar (lambda (s)
+ (unless (string-match-p "/\\'" s)
+ (concat "*" s)))
+ completion-ignored-extensions)))
+ "*List of file names which `rgrep' and `lgrep' shall exclude.
+If an element is a cons cell, the car is called on the search directory
+to determine whether cdr should not be excluded."
+ :type '(choice (repeat :tag "Ignored file" string)
+ (const :tag "No ignored files" nil))
:group 'grep)
(defcustom grep-error-screen-columns nil
:group 'grep)
(defvar grep-mode-map
- (let ((map (cons 'keymap compilation-minor-mode-map)))
+ (let ((map (make-sparse-keymap)))
+ (set-keymap-parent map compilation-minor-mode-map)
(define-key map " " 'scroll-up)
(define-key map "\^?" 'scroll-down)
(define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
(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))
+ '(menu-item "Kill Grep" kill-compilation
+ :help "Kill the currently running grep process"))
+ (define-key map [menu-bar grep compilation-separator2] '("----"))
(define-key map [menu-bar grep compilation-compile]
- '("Compile..." . compile))
- (define-key map [menu-bar grep compilation-grep]
- '("Another grep..." . grep))
+ '(menu-item "Compile..." compile
+ :help "Compile the program including the current buffer. Default: run `make'"))
+ (define-key map [menu-bar grep compilation-rgrep]
+ '(menu-item "Recursive grep..." rgrep
+ :help "User-friendly recursive grep in directory tree"))
+ (define-key map [menu-bar grep compilation-lgrep]
+ '(menu-item "Local grep..." lgrep
+ :help "User-friendly grep in a directory"))
(define-key map [menu-bar grep compilation-grep-find]
- '("Recursive grep..." . grep-find))
+ '(menu-item "Grep via Find..." grep-find
+ :help "Run grep via find, with user-specified args"))
+ (define-key map [menu-bar grep compilation-grep]
+ '(menu-item "Another grep..." grep
+ :help "Run grep, with user-specified args, and collect output in a buffer."))
(define-key map [menu-bar grep compilation-recompile]
- '("Repeat grep" . recompile))
- (define-key map [menu-bar grep compilation-separator2]
- '("----" . nil))
+ '(menu-item "Repeat grep" recompile
+ :help "Run grep again"))
+ (define-key map [menu-bar grep compilation-separator2] '("----"))
(define-key map [menu-bar grep compilation-first-error]
- '("First Match" . first-error))
+ '(menu-item "First Match" first-error
+ :help "Restart at the first match, visit corresponding location"))
(define-key map [menu-bar grep compilation-previous-error]
- '("Previous Match" . previous-error))
+ '(menu-item "Previous Match" previous-error
+ :help "Visit the previous match and corresponding location"))
(define-key map [menu-bar grep compilation-next-error]
- '("Next Match" . next-error))
+ '(menu-item "Next Match" next-error
+ :help "Visit the next match and corresponding location"))
map)
"Keymap for grep buffers.
`compilation-minor-mode-map' is a cdr of this.")
+(defvar grep-mode-tool-bar-map
+ ;; When bootstrapping, tool-bar-map is not properly initialized yet,
+ ;; so don't do anything.
+ (when (keymapp (butlast tool-bar-map))
+ (let ((map (butlast (copy-keymap tool-bar-map)))
+ (help (last tool-bar-map))) ;; Keep Help last in tool bar
+ (tool-bar-local-item
+ "left-arrow" 'previous-error-no-select 'previous-error-no-select map
+ :rtl "right-arrow"
+ :help "Goto previous match")
+ (tool-bar-local-item
+ "right-arrow" 'next-error-no-select 'next-error-no-select map
+ :rtl "left-arrow"
+ :help "Goto next match")
+ (tool-bar-local-item
+ "cancel" 'kill-compilation 'kill-compilation map
+ :enable '(let ((buffer (compilation-find-buffer)))
+ (get-buffer-process buffer))
+ :help "Stop grep")
+ (tool-bar-local-item
+ "refresh" 'recompile 'recompile map
+ :help "Restart grep")
+ (append map help))))
+
(defalias 'kill-grep 'kill-compilation)
;;;; TODO --- refine this!!
-;;; (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)
+;; (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)
;; override compilation-last-buffer
(defvar grep-last-buffer nil
`complation-last-buffer' rather than `grep-last-buffer'.")
;;;###autoload
-(defvar grep-regexp-alist
- '(("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2"
+(defconst grep-regexp-alist
+ '(("^\\(.+?\\)\\(:[ \t]*\\)\\([1-9][0-9]*\\)\\2"
1 3)
;; Rule to match column numbers is commented out since no known grep
;; produces them
;; ("^\\(.+?\\)\\(:[ \t]*\\)\\([0-9]+\\)\\2\\(?:\\([0-9]+\\)\\(?:-\\([0-9]+\\)\\)?\\2\\)?"
;; 1 3 (4 . 5))
- ("^\\(\\(.+?\\):\\([0-9]+\\):\\).*?\
+ ;; Note that we want to use as tight a regexp as we can to try and
+ ;; handle weird file names (with colons in them) as well as possible.
+ ;; E.g. we use [1-9][0-9]* rather than [0-9]+ so as to accept ":034:" in
+ ;; file names.
+ ("^\\(\\(.+?\\):\\([1-9][0-9]*\\):\\).*?\
\\(\033\\[01;31m\\(?:\033\\[K\\)?\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
2 3
;; Calculate column positions (beg . end) of first grep match on a line
(- (match-beginning 4) (match-end 1)))
.
(lambda () (- (match-end 5) (match-end 1)
- (- (match-end 4) (match-beginning 4)))))
+ (- (match-end 4) (match-beginning 4)))))
nil 1)
("^Binary file \\(.+\\) matches$" 1 nil nil 0 1))
"Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
(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
("^Grep[/a-zA-z]* started.*"
- (0 '(face nil message nil help-echo nil mouse-face nil) t))
+ (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t))
("^Grep[/a-zA-z]* finished \\(?:(\\(matches found\\))\\|with \\(no matches found\\)\\).*"
- (0 '(face nil message nil help-echo nil mouse-face nil) t)
+ (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
(1 compilation-info-face nil t)
(2 compilation-warning-face nil t))
("^Grep[/a-zA-z]* \\(exited abnormally\\|interrupt\\|killed\\|terminated\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
- (0 '(face nil message nil help-echo nil mouse-face nil) t)
+ (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
(1 grep-error-face)
(2 grep-error-face nil t))
("^.+?-[0-9]+-.*\n" (0 grep-context-face))
- ;; Highlight grep matches and delete markers
+ ;; Highlight grep matches and delete markers.
+ ;; FIXME: Modifying the buffer text from font-lock is a bad idea!
("\\(\033\\[01;31m\\)\\(.*?\\)\\(\033\\[[0-9]*m\\)"
;; Refontification does not work after the markers have been
;; deleted. So we use the font-lock-face property here as Font
(progn
;; Delete markers with `replace-match' because it updates
;; the match-data, whereas `delete-region' would render it obsolete.
+ (syntax-ppss-flush-cache (match-beginning 0))
(replace-match "" t t nil 3)
(replace-match "" t t nil 1))))
- ("\\(\033\\[[0-9;]*[mK]\\)"
+ ("\033\\[[0-9;]*[mK]"
;; Delete all remaining escape sequences
((lambda (bound))
- (replace-match "" t t nil 1))))
+ (syntax-ppss-flush-cache (match-beginning 0))
+ (replace-match "" t t))))
"Additional things to highlight in grep output.
This gets tacked on the end of the generated expressions.")
;;;###autoload
-(defvar grep-program "grep"
+(defvar grep-program (purecopy "grep")
"The default grep program for `grep-command' and `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")
;;;###autoload
-(defvar find-program "find"
+(defvar find-program (purecopy "find")
"The default find program for `grep-find-command'.
This variable's value takes effect when `grep-compute-defaults' is called.")
+;;;###autoload
+(defvar xargs-program (purecopy "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.")
+
;;;###autoload
(defvar grep-find-use-xargs nil
"Non-nil means that `grep-find' uses the `xargs' utility by default.
;; History of lgrep and rgrep regexp and files args.
(defvar grep-regexp-history nil)
-(defvar grep-files-history '("ch" "el"))
-
-(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.")
+(defvar grep-files-history nil)
;;;###autoload
(defun grep-process-setup ()
"Setup compilation variables and buffer for `grep'.
Set up `compilation-exit-message-function' and run `grep-setup-hook'."
- (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
+ (when (eq grep-highlight-matches 'auto-detect)
(grep-compute-defaults))
- (when (eq grep-highlight-matches t)
- ;; Modify `process-environment' locally bound in `compilation-start'
- (setenv "GREP_OPTIONS" (concat (getenv "GREP_OPTIONS") " --color=always"))
- ;; for GNU grep 2.5.1
+ (unless (or (eq grep-highlight-matches 'auto-detect)
+ (null grep-highlight-matches))
+ ;; `setenv' modifies `process-environment' let-bound in `compilation-start'
+ ;; Any TERM except "dumb" allows GNU grep to use `--color=auto'
+ (setenv "TERM" "emacs-grep")
+ (setenv "GREP_OPTIONS"
+ (concat (getenv "GREP_OPTIONS")
+ " --color=" (if (eq grep-highlight-matches 'always)
+ "always" "auto")))
+ ;; GREP_COLOR is used in GNU grep 2.5.1, but deprecated in later versions
(setenv "GREP_COLOR" "01;31")
- ;; for GNU grep 2.5.1-cvs
+ ;; GREP_COLORS is used in GNU grep 2.5.2 and later versions
(setenv "GREP_COLORS" "mt=01;31:fn=:ln=:bn=:se=:ml=:cx=:ne"))
(set (make-local-variable 'compilation-exit-message-function)
(lambda (status code msg)
(run-hooks 'grep-setup-hook))
(defun grep-probe (command args &optional func result)
- (equal (condition-case nil
- (apply (or func 'process-file) command args)
- (error nil))
- (or result 0)))
+ (let (process-file-side-effects)
+ (equal (condition-case nil
+ (apply (or func 'process-file) command args)
+ (error nil))
+ (or result 0))))
;;;###autoload
(defun grep-compute-defaults ()
(grep-find-use-xargs ,grep-find-use-xargs)
(grep-highlight-matches ,grep-highlight-matches)))))
(let* ((host-id
- (intern (or (file-remote-p default-directory 'host) "localhost")))
+ (intern (or (file-remote-p default-directory) "localhost")))
(host-defaults (assq host-id grep-host-defaults-alist))
(defaults (assq nil grep-host-defaults-alist)))
;; There are different defaults on different hosts. They must be
;; computed for every host once.
- (setq grep-command
- (or (cadr (assq 'grep-command host-defaults))
- (cadr (assq 'grep-command defaults)))
-
- grep-template
- (or (cadr (assq 'grep-template host-defaults))
- (cadr (assq 'grep-template defaults)))
-
- grep-use-null-device
- (or (cadr (assq 'grep-use-null-device host-defaults))
- (cadr (assq 'grep-use-null-device defaults)))
-
- grep-find-command
- (or (cadr (assq 'grep-find-command host-defaults))
- (cadr (assq 'grep-find-command defaults)))
-
- grep-find-template
- (or (cadr (assq 'grep-find-template host-defaults))
- (cadr (assq 'grep-find-template defaults)))
-
- grep-find-use-xargs
- (or (cadr (assq 'grep-find-use-xargs host-defaults))
- (cadr (assq 'grep-find-use-xargs defaults)))
-
- grep-highlight-matches
- (or (cadr (assq 'grep-highlight-matches host-defaults))
- (cadr (assq 'grep-highlight-matches defaults))))
+ (dolist (setting '(grep-command grep-template
+ grep-use-null-device grep-find-command
+ grep-find-template grep-find-use-xargs
+ grep-highlight-matches))
+ (set setting
+ (cadr (or (assq setting host-defaults)
+ (assq setting defaults)))))
(unless (or (not grep-use-null-device) (eq grep-use-null-device t))
(setq grep-use-null-device
(format "%s %s " grep-program grep-options)))
(unless grep-template
(setq grep-template
- (format "%s <C> %s <R> <F>" grep-program grep-options)))
+ (format "%s <X> <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"))
- (grep-probe "xargs" `(nil nil nil "-0" "-e" "echo")))
+ (grep-probe xargs-program `(nil nil nil "-0" "-e" "echo")))
'gnu)
(t
'exec))))
(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))
+ ;; Windows shells need the program file name
+ ;; after the pipe symbol be quoted if they use
+ ;; forward slashes as directory separators.
+ (format "%s . -type f -print0 | \"%s\" -0 -e %s"
+ find-program xargs-program grep-command))
((eq grep-find-use-xargs 'exec)
(let ((cmd0 (format "%s . -type f -exec %s"
find-program grep-command)))
(shell-quote-argument ";"))
(1+ (length cmd0)))))
(t
- (format "%s . -type f -print | xargs %s"
- find-program grep-command)))))
+ (format "%s . -type f -print | \"%s\" %s"
+ find-program xargs-program grep-command)))))
(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))
+ (format "%s . <X> -type f <F> -print0 | \"%s\" -0 -e %s"
+ find-program xargs-program gcmd))
((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
- (format "%s . <X> -type f <F> -print | xargs %s"
- find-program gcmd))))))))
- (unless (or (not grep-highlight-matches) (eq grep-highlight-matches t))
+ (format "%s . <X> -type f <F> -print | \"%s\" %s"
+ find-program xargs-program gcmd))))))))
+ (when (eq grep-highlight-matches 'auto-detect)
(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))))
+ ;; Windows and DOS pipes fail `isatty' detection in Grep.
+ (if (memq system-type '(windows-nt ms-dos))
+ 'always 'auto)))))
;; Save defaults for this host.
(setq grep-host-defaults-alist
""))
(defun grep-default-command ()
- "Compute the default grep command for C-u M-x grep to offer."
+ "Compute the default grep command for \\[universal-argument] \\[grep] to offer."
(let ((tag-default (shell-quote-argument (grep-tag-default)))
;; This a regexp to match single shell arguments.
;; Could someone please add comments explaining it?
(define-compilation-mode grep-mode "Grep"
"Sets `grep-last-buffer' and `compilation-window-height'."
(setq grep-last-buffer (current-buffer))
+ (set (make-local-variable 'tool-bar-map) grep-mode-tool-bar-map)
(set (make-local-variable 'compilation-error-face)
grep-hit-face)
(set (make-local-variable 'compilation-error-regexp-alist)
"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),
or \\<grep-mode-map>\\[compile-goto-error] in the grep \
-output buffer, to go to the lines
-where grep found matches.
+output buffer, to go to the lines where grep
+found matches.
For doing a recursive `grep', see the `rgrep' command. For running
`grep' in a specific directory, see `lgrep'.
-This command uses a special history list for its COMMAND-ARGS, so you can
-easily repeat a grep command.
+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'
-if that history list is empty)."
+in the grep command history (or into `grep-command' if that history
+list is empty)."
(interactive
(progn
(grep-compute-defaults)
(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))))))
+ (list (read-shell-command "Run grep (like this): "
+ (if current-prefix-arg default grep-command)
+ 'grep-history
+ (if current-prefix-arg nil default))))))
;; Setting process-setup-function makes exit-message-function work
;; even when async processes aren't supported.
(progn
(grep-compute-defaults)
(if grep-find-command
- (list (read-from-minibuffer "Run find (like this): "
- grep-find-command nil nil
- 'grep-find-history))
+ (list (read-shell-command "Run find (like this): "
+ grep-find-command 'grep-find-history))
;; No default was set
(read-string
"compile.el: No `grep-find-command' command available. Press RET.")
(defun grep-read-files (regexp)
"Read files arg for interactive grep."
- (let* ((bn (or (buffer-file-name) (buffer-name)))
+ (let* ((bn (or (buffer-file-name)
+ (replace-regexp-in-string "<[0-9]+>\\'" "" (buffer-name))))
(fn (and bn
(stringp bn)
(file-name-nondirectory bn)))
+ (default-alias
+ (and fn
+ (let ((aliases (remove (assoc "all" grep-files-aliases)
+ grep-files-aliases))
+ alias)
+ (while aliases
+ (setq alias (car aliases)
+ aliases (cdr aliases))
+ (if (string-match (mapconcat
+ 'wildcard-to-regexp
+ (split-string (cdr alias) nil t)
+ "\\|")
+ fn)
+ (setq aliases nil)
+ (setq alias nil)))
+ (cdr alias))))
+ (default-extension
+ (and fn
+ (let ((ext (file-name-extension fn)))
+ (and ext (concat "*." ext)))))
(default
- (or (and fn
- (let ((aliases grep-files-aliases)
- 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)))
- (and fn
- (let ((ext (file-name-extension fn)))
- (and ext (concat "*." ext))))
+ (or default-alias
+ default-extension
(car grep-files-history)
(car (car grep-files-aliases))))
- (files (read-string
+ (files (completing-read
(concat "Search for \"" regexp
"\" in files"
(if default (concat " (default " default ")"))
": ")
- nil 'grep-files-history default)))
+ 'read-file-name-internal
+ nil nil nil 'grep-files-history
+ (delete-dups
+ (delq nil (append (list default default-alias default-extension)
+ (mapcar 'car grep-files-aliases)))))))
(and files
(or (cdr (assoc files grep-files-aliases))
files))))
;;;###autoload
-(defun lgrep (regexp &optional files dir)
+(defun lgrep (regexp &optional files dir confirm)
"Run grep, searching for REGEXP in FILES in directory DIR.
The search is limited to file names matching shell pattern FILES.
FILES may use abbreviations defined in `grep-files-aliases', e.g.
With two \\[universal-argument] prefixes, directly edit and run `grep-command'.
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.
+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 \\[rgrep] and \\[grep]."
(interactive
(cond
((and grep-command (equal current-prefix-arg '(16)))
(list (read-from-minibuffer "Run: " grep-command
- nil nil 'grep-history)
- nil))
+ nil nil 'grep-history)))
((not grep-template)
- (list nil
- (read-string "grep.el: No `grep-template' available. Press RET.")))
+ (error "grep.el: No `grep-template' available"))
(t (let* ((regexp (grep-read-regexp))
(files (grep-read-files regexp))
(dir (read-directory-name "In directory: "
- nil default-directory t)))
- (list regexp files dir))))))
+ nil default-directory t))
+ (confirm (equal current-prefix-arg '(4))))
+ (list regexp files dir confirm))))))
(when (and (stringp regexp) (> (length regexp) 0))
+ (unless (and dir (file-directory-p dir) (file-readable-p dir))
+ (setq dir default-directory))
(let ((command regexp))
(if (null files)
(if (string= command grep-command)
(setq command (grep-expand-template
grep-template
regexp
- files))
+ files
+ nil
+ (and grep-find-ignored-files
+ (concat " --exclude="
+ (mapconcat
+ #'(lambda (ignore)
+ (cond ((stringp ignore)
+ (shell-quote-argument ignore))
+ ((consp ignore)
+ (and (funcall (car ignore) dir)
+ (shell-quote-argument
+ (cdr ignore))))))
+ grep-find-ignored-files
+ " --exclude=")))))
(when command
- (if (equal current-prefix-arg '(4))
+ (if confirm
(setq command
(read-from-minibuffer "Confirm: "
command nil nil 'grep-history))
;; even when async processes aren't supported.
(compilation-start (if (and grep-use-null-device null-device)
(concat command " " null-device)
- command) 'grep-mode))
+ command)
+ 'grep-mode))
(if (eq next-error-last-buffer (current-buffer))
(setq default-directory dir))))))
+(defvar find-name-arg) ; not autoloaded but defined in find-dired
;;;###autoload
-(defun rgrep (regexp &optional files dir)
+(defun rgrep (regexp &optional files dir confirm)
"Recursively grep for REGEXP in FILES in directory tree rooted at DIR.
The search is limited to file names matching shell pattern FILES.
FILES may use abbreviations defined in `grep-files-aliases', e.g.
With two \\[universal-argument] prefixes, directly edit and run `grep-find-command'.
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.
+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
(cond
((and grep-find-command (equal current-prefix-arg '(16)))
(list (read-from-minibuffer "Run: " grep-find-command
- nil nil 'grep-find-history)
- nil))
+ nil nil 'grep-find-history)))
((not grep-find-template)
- (list nil nil
- (read-string "grep.el: No `grep-find-template' available. Press RET.")))
+ (error "grep.el: No `grep-find-template' available"))
(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))))))
+ nil default-directory t))
+ (confirm (equal current-prefix-arg '(4))))
+ (list regexp files dir confirm))))))
(when (and (stringp regexp) (> (length regexp) 0))
+ (unless (and dir (file-directory-p dir) (file-readable-p dir))
+ (setq dir default-directory))
(if (null files)
(if (not (string= regexp grep-find-command))
(compilation-start regexp 'grep-mode))
(setq dir (file-name-as-directory (expand-file-name dir)))
+ (require 'find-dired) ; for `find-name-arg'
(let ((command (grep-expand-template
grep-find-template
regexp
(concat (shell-quote-argument "(")
- " -name "
+ " " find-name-arg " "
(mapconcat #'shell-quote-argument
(split-string files)
- " -o -name ")
+ (concat " -o " find-name-arg " "))
" "
(shell-quote-argument ")"))
- dir
+ dir
+ (concat
(and grep-find-ignored-directories
(concat (shell-quote-argument "(")
;; we should use shell-quote-argument here
" -path "
- (mapconcat #'(lambda (dir)
- (shell-quote-argument
- (concat "*/" dir)))
- grep-find-ignored-directories
- " -o -path ")
+ (mapconcat
+ #'(lambda (ignore)
+ (cond ((stringp ignore)
+ (shell-quote-argument
+ (concat "*/" ignore)))
+ ((consp ignore)
+ (and (funcall (car ignore) dir)
+ (shell-quote-argument
+ (concat "*/"
+ (cdr ignore)))))))
+ grep-find-ignored-directories
+ " -o -path ")
" "
(shell-quote-argument ")")
- " -prune -o ")))))
+ " -prune -o "))
+ (and grep-find-ignored-files
+ (concat (shell-quote-argument "(")
+ ;; we should use shell-quote-argument here
+ " -name "
+ (mapconcat
+ #'(lambda (ignore)
+ (cond ((stringp ignore)
+ (shell-quote-argument ignore))
+ ((consp ignore)
+ (and (funcall (car ignore) dir)
+ (shell-quote-argument
+ (cdr ignore))))))
+ grep-find-ignored-files
+ " -o -name ")
+ " "
+ (shell-quote-argument ")")
+ " -prune -o "))))))
(when command
- (if current-prefix-arg
+ (if confirm
(setq command
(read-from-minibuffer "Confirm: "
command nil nil 'grep-find-history))
(if (eq next-error-last-buffer (current-buffer))
(setq default-directory dir)))))))
+;;;###autoload
+(defun zrgrep (regexp &optional files dir confirm grep-find-template)
+ "Recursively grep for REGEXP in gzipped FILES in tree rooted at DIR.
+Like `rgrep' but uses `zgrep' for `grep-program', sets the default
+file name to `*.gz', and sets `grep-highlight-matches' to `always'."
+ (interactive
+ (progn
+ ;; Compute standard default values.
+ (grep-compute-defaults)
+ ;; Compute the default zrgrep command by running `grep-compute-defaults'
+ ;; for grep program "zgrep", but not changing global values.
+ (let ((grep-program "zgrep")
+ ;; Don't change global values for variables computed
+ ;; by `grep-compute-defaults'.
+ (grep-find-template nil)
+ (grep-find-command nil)
+ (grep-host-defaults-alist nil)
+ ;; Use for `grep-read-files'
+ (grep-files-aliases '(("all" . "* .*")
+ ("gz" . "*.gz"))))
+ ;; Recompute defaults using let-bound values above.
+ (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)))
+ ((not grep-find-template)
+ (error "grep.el: No `grep-find-template' available"))
+ (t (let* ((regexp (grep-read-regexp))
+ (files (grep-read-files regexp))
+ (dir (read-directory-name "Base directory: "
+ nil default-directory t))
+ (confirm (equal current-prefix-arg '(4))))
+ (list regexp files dir confirm grep-find-template)))))))
+ ;; Set `grep-highlight-matches' to `always'
+ ;; since `zgrep' puts filters in the grep output.
+ (let ((grep-highlight-matches 'always))
+ ;; `rgrep' uses the dynamically bound value `grep-find-template'
+ ;; from the argument `grep-find-template' whose value is computed
+ ;; in the `interactive' spec.
+ (rgrep regexp files dir confirm)))
+
+;;;###autoload
+(defalias 'rzgrep 'zrgrep)
(provide 'grep)
-;; arch-tag: 5a5b9169-a79d-4f38-9c38-f69615f39c4d
;;; grep.el ends here