4 * Copyright (c) 2006 Junio C Hamano
11 #include "tree-walk.h"
18 * git grep pathspecs are somewhat different from diff-tree pathspecs;
19 * pathname wildcards are allowed.
21 static int pathspec_matches(const char **paths
, const char *name
)
24 if (!paths
|| !*paths
)
26 namelen
= strlen(name
);
27 for (i
= 0; paths
[i
]; i
++) {
28 const char *match
= paths
[i
];
29 int matchlen
= strlen(match
);
30 const char *cp
, *meta
;
32 if ((matchlen
<= namelen
) &&
33 !strncmp(name
, match
, matchlen
) &&
34 (match
[matchlen
-1] == '/' ||
35 name
[matchlen
] == '\0' || name
[matchlen
] == '/'))
37 if (!fnmatch(match
, name
, 0))
39 if (name
[namelen
-1] != '/')
42 /* We are being asked if the directory ("name") is worth
45 * Find the longest leading directory name that does
46 * not have metacharacter in the pathspec; the name
47 * we are looking at must overlap with that directory.
49 for (cp
= match
, meta
= NULL
; cp
- match
< matchlen
; cp
++) {
51 if (ch
== '*' || ch
== '[' || ch
== '?') {
57 meta
= cp
; /* fully literal */
59 if (namelen
<= meta
- match
) {
60 /* Looking at "Documentation/" and
61 * the pattern says "Documentation/howto/", or
62 * "Documentation/diff*.txt". The name we
63 * have should match prefix.
65 if (!memcmp(match
, name
, namelen
))
70 if (meta
- match
< namelen
) {
71 /* Looking at "Documentation/howto/" and
72 * the pattern says "Documentation/h*";
73 * match up to "Do.../h"; this avoids descending
74 * into "Documentation/technical/".
76 if (!memcmp(match
, name
, meta
- match
))
85 struct grep_pat
*next
;
93 struct grep_pat
*pattern_list
;
94 struct grep_pat
**pattern_tail
;
99 unsigned unmatch_name_only
:1;
101 unsigned word_regexp
:1;
103 #define GREP_BINARY_DEFAULT 0
104 #define GREP_BINARY_NOMATCH 1
105 #define GREP_BINARY_TEXT 2
108 unsigned pre_context
;
109 unsigned post_context
;
112 static void add_pattern(struct grep_opt
*opt
, const char *pat
,
113 const char *origin
, int no
)
115 struct grep_pat
*p
= xcalloc(1, sizeof(*p
));
119 *opt
->pattern_tail
= p
;
120 opt
->pattern_tail
= &p
->next
;
124 static void compile_patterns(struct grep_opt
*opt
)
127 for (p
= opt
->pattern_list
; p
; p
= p
->next
) {
128 int err
= regcomp(&p
->regexp
, p
->pattern
, opt
->regflags
);
133 sprintf(where
, "In '%s' at %d, ",
136 sprintf(where
, "%s, ", p
->origin
);
139 regerror(err
, &p
->regexp
, errbuf
, 1024);
141 die("%s'%s': %s", where
, p
->pattern
, errbuf
);
146 static char *end_of_line(char *cp
, unsigned long *left
)
148 unsigned long l
= *left
;
149 while (l
&& *cp
!= '\n') {
157 static int word_char(char ch
)
159 return isalnum(ch
) || ch
== '_';
162 static void show_line(struct grep_opt
*opt
, const char *bol
, const char *eol
,
163 const char *name
, unsigned lno
, char sign
)
165 printf("%s%c", name
, sign
);
167 printf("%d%c", lno
, sign
);
168 printf("%.*s\n", (int)(eol
-bol
), bol
);
172 * NEEDSWORK: share code with diff.c
174 #define FIRST_FEW_BYTES 8000
175 static int buffer_is_binary(const char *ptr
, unsigned long size
)
177 if (FIRST_FEW_BYTES
< size
)
178 size
= FIRST_FEW_BYTES
;
179 if (memchr(ptr
, 0, size
))
184 static int fixmatch(const char *pattern
, char *line
, regmatch_t
*match
)
186 char *hit
= strstr(line
, pattern
);
188 match
->rm_so
= match
->rm_eo
= -1;
192 match
->rm_so
= hit
- line
;
193 match
->rm_eo
= match
->rm_so
+ strlen(pattern
);
198 static int grep_buffer(struct grep_opt
*opt
, const char *name
,
199 char *buf
, unsigned long size
)
202 unsigned long left
= size
;
204 struct pre_context_line
{
207 } *prev
= NULL
, *pcl
;
208 unsigned last_hit
= 0;
209 unsigned last_shown
= 0;
210 int binary_match_only
= 0;
211 const char *hunk_mark
= "";
214 if (buffer_is_binary(buf
, size
)) {
215 switch (opt
->binary
) {
216 case GREP_BINARY_DEFAULT
:
217 binary_match_only
= 1;
219 case GREP_BINARY_NOMATCH
:
220 return 0; /* Assume unmatch */
227 if (opt
->pre_context
)
228 prev
= xcalloc(opt
->pre_context
, sizeof(*prev
));
229 if (opt
->pre_context
|| opt
->post_context
)
233 regmatch_t pmatch
[10];
238 eol
= end_of_line(bol
, &left
);
242 for (p
= opt
->pattern_list
; p
; p
= p
->next
) {
244 regex_t
*exp
= &p
->regexp
;
245 hit
= !regexec(exp
, bol
, ARRAY_SIZE(pmatch
),
249 hit
= !fixmatch(p
->pattern
, bol
, pmatch
);
252 if (hit
&& opt
->word_regexp
) {
253 /* Match beginning must be either
254 * beginning of the line, or at word
255 * boundary (i.e. the last char must
256 * not be alnum or underscore).
258 if ((pmatch
[0].rm_so
< 0) ||
259 (eol
- bol
) <= pmatch
[0].rm_so
||
260 (pmatch
[0].rm_eo
< 0) ||
261 (eol
- bol
) < pmatch
[0].rm_eo
)
262 die("regexp returned nonsense");
263 if (pmatch
[0].rm_so
!= 0 &&
264 word_char(bol
[pmatch
[0].rm_so
-1]))
266 if (pmatch
[0].rm_eo
!= (eol
-bol
) &&
267 word_char(bol
[pmatch
[0].rm_eo
]))
273 /* "grep -v -e foo -e bla" should list lines
274 * that do not have either, so inversion should
279 if (opt
->unmatch_name_only
) {
286 if (binary_match_only
) {
287 printf("Binary file %s matches\n", name
);
290 if (opt
->name_only
) {
291 printf("%s\n", name
);
294 /* Hit at this line. If we haven't shown the
295 * pre-context lines, we would need to show them.
296 * When asked to do "count", this still show
297 * the context which is nonsense, but the user
298 * deserves to get that ;-).
300 if (opt
->pre_context
) {
302 if (opt
->pre_context
< lno
)
303 from
= lno
- opt
->pre_context
;
306 if (from
<= last_shown
)
307 from
= last_shown
+ 1;
308 if (last_shown
&& from
!= last_shown
+ 1)
311 pcl
= &prev
[lno
-from
-1];
312 show_line(opt
, pcl
->bol
, pcl
->eol
,
318 if (last_shown
&& lno
!= last_shown
+ 1)
321 show_line(opt
, bol
, eol
, name
, lno
, ':');
322 last_shown
= last_hit
= lno
;
325 lno
<= last_hit
+ opt
->post_context
) {
326 /* If the last hit is within the post context,
327 * we need to show this line.
329 if (last_shown
&& lno
!= last_shown
+ 1)
331 show_line(opt
, bol
, eol
, name
, lno
, '-');
334 if (opt
->pre_context
) {
335 memmove(prev
+1, prev
,
336 (opt
->pre_context
-1) * sizeof(*prev
));
350 if (opt
->unmatch_name_only
) {
351 /* We did not see any hit, so we want to show this */
352 printf("%s\n", name
);
357 * The real "grep -c foo *.c" gives many "bar.c:0" lines,
358 * which feels mostly useless but sometimes useful. Maybe
359 * make it another option? For now suppress them.
361 if (opt
->count
&& count
)
362 printf("%s:%u\n", name
, count
);
366 static int grep_sha1(struct grep_opt
*opt
, const unsigned char *sha1
, const char *name
)
372 data
= read_sha1_file(sha1
, type
, &size
);
374 error("'%s': unable to read %s", name
, sha1_to_hex(sha1
));
377 hit
= grep_buffer(opt
, name
, data
, size
);
382 static int grep_file(struct grep_opt
*opt
, const char *filename
)
387 if (lstat(filename
, &st
) < 0) {
390 error("'%s': %s", filename
, strerror(errno
));
394 return 0; /* empty file -- no grep hit */
395 if (!S_ISREG(st
.st_mode
))
397 i
= open(filename
, O_RDONLY
);
400 data
= xmalloc(st
.st_size
+ 1);
401 if (st
.st_size
!= xread(i
, data
, st
.st_size
)) {
402 error("'%s': short read %s", filename
, strerror(errno
));
408 i
= grep_buffer(opt
, filename
, data
, st
.st_size
);
413 static int exec_grep(int argc
, const char **argv
)
423 execvp("grep", (char **) argv
);
426 while (waitpid(pid
, &status
, 0) < 0) {
431 if (WIFEXITED(status
)) {
432 if (!WEXITSTATUS(status
))
441 #define push_arg(a) do { \
442 if (nr < MAXARGS) argv[nr++] = (a); \
443 else die("maximum number of args exceeded"); \
446 static int external_grep(struct grep_opt
*opt
, const char **paths
, int cached
)
448 int i
, nr
, argc
, hit
, len
;
449 const char *argv
[MAXARGS
+1];
450 char randarg
[ARGBUF
];
451 char *argptr
= randarg
;
460 if (opt
->regflags
& REG_EXTENDED
)
462 if (opt
->word_regexp
)
466 if (opt
->unmatch_name_only
)
470 if (opt
->post_context
|| opt
->pre_context
) {
471 if (opt
->post_context
!= opt
->pre_context
) {
472 if (opt
->pre_context
) {
474 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
475 "%u", opt
->pre_context
);
476 if (sizeof(randarg
) <= len
)
477 die("maximum length of args exceeded");
481 if (opt
->post_context
) {
483 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
484 "%u", opt
->post_context
);
485 if (sizeof(randarg
) <= len
)
486 die("maximum length of args exceeded");
493 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
494 "%u", opt
->post_context
);
495 if (sizeof(randarg
) <= len
)
496 die("maximum length of args exceeded");
501 for (p
= opt
->pattern_list
; p
; p
= p
->next
) {
503 push_arg(p
->pattern
);
507 * To make sure we get the header printed out when we want it,
508 * add /dev/null to the paths to grep. This is unnecessary
509 * (and wrong) with "-l" or "-L", which always print out the
512 * GNU grep has "-H", but this is portable.
514 if (!opt
->name_only
&& !opt
->unmatch_name_only
)
515 push_arg("/dev/null");
519 for (i
= 0; i
< active_nr
; i
++) {
520 struct cache_entry
*ce
= active_cache
[i
];
522 if (ce_stage(ce
) || !S_ISREG(ntohl(ce
->ce_mode
)))
524 if (!pathspec_matches(paths
, ce
->name
))
527 if (name
[0] == '-') {
528 int len
= ce_namelen(ce
);
529 name
= xmalloc(len
+ 3);
530 memcpy(name
, "./", 2);
531 memcpy(name
+ 2, ce
->name
, len
+ 1);
536 hit
+= exec_grep(argc
, argv
);
540 hit
+= exec_grep(argc
, argv
);
544 static int grep_cache(struct grep_opt
*opt
, const char **paths
, int cached
)
552 * Use the external "grep" command for the case where
553 * we grep through the checked-out files. It tends to
554 * be a lot more optimized
557 hit
= external_grep(opt
, paths
, cached
);
563 for (nr
= 0; nr
< active_nr
; nr
++) {
564 struct cache_entry
*ce
= active_cache
[nr
];
565 if (ce_stage(ce
) || !S_ISREG(ntohl(ce
->ce_mode
)))
567 if (!pathspec_matches(paths
, ce
->name
))
570 hit
|= grep_sha1(opt
, ce
->sha1
, ce
->name
);
572 hit
|= grep_file(opt
, ce
->name
);
577 static int grep_tree(struct grep_opt
*opt
, const char **paths
,
578 struct tree_desc
*tree
,
579 const char *tree_name
, const char *base
)
583 struct name_entry entry
;
585 char *path_buf
= xmalloc(PATH_MAX
+ strlen(tree_name
) + 100);
588 int offset
= sprintf(path_buf
, "%s:", tree_name
);
589 down
= path_buf
+ offset
;
596 len
= strlen(path_buf
);
598 while (tree_entry(tree
, &entry
)) {
599 strcpy(path_buf
+ len
, entry
.path
);
601 if (S_ISDIR(entry
.mode
))
602 /* Match "abc/" against pathspec to
603 * decide if we want to descend into "abc"
606 strcpy(path_buf
+ len
+ entry
.pathlen
, "/");
608 if (!pathspec_matches(paths
, down
))
610 else if (S_ISREG(entry
.mode
))
611 hit
|= grep_sha1(opt
, entry
.sha1
, path_buf
);
612 else if (S_ISDIR(entry
.mode
)) {
614 struct tree_desc sub
;
616 data
= read_sha1_file(entry
.sha1
, type
, &sub
.size
);
618 die("unable to read tree (%s)",
619 sha1_to_hex(entry
.sha1
));
621 hit
|= grep_tree(opt
, paths
, &sub
, tree_name
, down
);
628 static int grep_object(struct grep_opt
*opt
, const char **paths
,
629 struct object
*obj
, const char *name
)
631 if (!strcmp(obj
->type
, blob_type
))
632 return grep_sha1(opt
, obj
->sha1
, name
);
633 if (!strcmp(obj
->type
, commit_type
) ||
634 !strcmp(obj
->type
, tree_type
)) {
635 struct tree_desc tree
;
638 data
= read_object_with_reference(obj
->sha1
, tree_type
,
641 die("unable to read tree (%s)", sha1_to_hex(obj
->sha1
));
643 hit
= grep_tree(opt
, paths
, &tree
, name
, "");
647 die("unable to grep from object of type %s", obj
->type
);
650 static const char builtin_grep_usage
[] =
651 "git-grep <option>* <rev>* [-e] <pattern> [<path>...]";
653 int cmd_grep(int argc
, const char **argv
, char **envp
)
657 int seen_dashdash
= 0;
659 struct object_list
*list
, **tail
, *object_list
= NULL
;
660 const char *prefix
= setup_git_directory();
661 const char **paths
= NULL
;
664 memset(&opt
, 0, sizeof(opt
));
665 opt
.pattern_tail
= &opt
.pattern_list
;
666 opt
.regflags
= REG_NEWLINE
;
669 * If there is no -- then the paths must exist in the working
670 * tree. If there is no explicit pattern specified with -e or
671 * -f, we take the first unrecognized non option to be the
672 * pattern, but then what follows it must be zero or more
673 * valid refs up to the -- (if exists), and then existing
674 * paths. If there is an explicit pattern, then the first
675 * unrecocnized non option is the beginning of the refs list
676 * that continues up to the -- (if exists), and then paths.
681 const char *arg
= argv
[1];
683 if (!strcmp("--cached", arg
)) {
687 if (!strcmp("-a", arg
) ||
688 !strcmp("--text", arg
)) {
689 opt
.binary
= GREP_BINARY_TEXT
;
692 if (!strcmp("-i", arg
) ||
693 !strcmp("--ignore-case", arg
)) {
694 opt
.regflags
|= REG_ICASE
;
697 if (!strcmp("-I", arg
)) {
698 opt
.binary
= GREP_BINARY_NOMATCH
;
701 if (!strcmp("-v", arg
) ||
702 !strcmp("--invert-match", arg
)) {
706 if (!strcmp("-E", arg
) ||
707 !strcmp("--extended-regexp", arg
)) {
708 opt
.regflags
|= REG_EXTENDED
;
711 if (!strcmp("-F", arg
) ||
712 !strcmp("--fixed-strings", arg
)) {
716 if (!strcmp("-G", arg
) ||
717 !strcmp("--basic-regexp", arg
)) {
718 opt
.regflags
&= ~REG_EXTENDED
;
721 if (!strcmp("-n", arg
)) {
725 if (!strcmp("-H", arg
)) {
726 /* We always show the pathname, so this
731 if (!strcmp("-l", arg
) ||
732 !strcmp("--files-with-matches", arg
)) {
736 if (!strcmp("-L", arg
) ||
737 !strcmp("--files-without-match", arg
)) {
738 opt
.unmatch_name_only
= 1;
741 if (!strcmp("-c", arg
) ||
742 !strcmp("--count", arg
)) {
746 if (!strcmp("-w", arg
) ||
747 !strcmp("--word-regexp", arg
)) {
751 if (!strncmp("-A", arg
, 2) ||
752 !strncmp("-B", arg
, 2) ||
753 !strncmp("-C", arg
, 2) ||
754 (arg
[0] == '-' && '1' <= arg
[1] && arg
[1] <= '9')) {
758 case 'A': case 'B': case 'C':
761 usage(builtin_grep_usage
);
772 if (sscanf(scan
, "%u", &num
) != 1)
773 usage(builtin_grep_usage
);
776 opt
.post_context
= num
;
780 opt
.post_context
= num
;
782 opt
.pre_context
= num
;
787 if (!strcmp("-f", arg
)) {
792 usage(builtin_grep_usage
);
793 patterns
= fopen(argv
[1], "r");
795 die("'%s': %s", argv
[1], strerror(errno
));
796 while (fgets(buf
, sizeof(buf
), patterns
)) {
797 int len
= strlen(buf
);
798 if (buf
[len
-1] == '\n')
800 /* ignore empty line like grep does */
803 add_pattern(&opt
, strdup(buf
), argv
[1], ++lno
);
810 if (!strcmp("-e", arg
)) {
812 add_pattern(&opt
, argv
[1], "-e option", 0);
817 usage(builtin_grep_usage
);
819 if (!strcmp("--", arg
))
822 usage(builtin_grep_usage
);
824 /* First unrecognized non-option token */
825 if (!opt
.pattern_list
) {
826 add_pattern(&opt
, arg
, "command line", 0);
830 /* We are looking at the first path or rev;
831 * it is found at argv[1] after leaving the
839 if (!opt
.pattern_list
)
840 die("no pattern given.");
841 if ((opt
.regflags
!= REG_NEWLINE
) && opt
.fixed
)
842 die("cannot mix --fixed-strings and regexp");
844 compile_patterns(&opt
);
846 /* Check revs and then paths */
847 for (i
= 1; i
< argc
; i
++) {
848 const char *arg
= argv
[i
];
849 unsigned char sha1
[20];
851 if (!get_sha1(arg
, sha1
)) {
852 struct object
*object
= parse_object(sha1
);
853 struct object_list
*elem
;
855 die("bad object %s", arg
);
856 elem
= object_list_insert(object
, tail
);
861 if (!strcmp(arg
, "--")) {
868 /* The rest are paths */
869 if (!seen_dashdash
) {
871 for (j
= i
; j
< argc
; j
++)
872 verify_filename(prefix
, argv
[j
]);
876 paths
= get_pathspec(prefix
, argv
+ i
);
878 paths
= xcalloc(2, sizeof(const char *));
884 return !grep_cache(&opt
, paths
, cached
);
887 die("both --cached and trees are given.");
889 for (list
= object_list
; list
; list
= list
->next
) {
890 struct object
*real_obj
;
891 real_obj
= deref_tag(list
->item
, NULL
, 0);
892 if (grep_object(&opt
, paths
, real_obj
, list
->name
))