4 * Copyright (c) 2006 Junio C Hamano
11 #include "tree-walk.h"
15 #ifndef NO_EXTERNAL_GREP
17 #define NO_EXTERNAL_GREP 0
19 #define NO_EXTERNAL_GREP 1
24 * git grep pathspecs are somewhat different from diff-tree pathspecs;
25 * pathname wildcards are allowed.
27 static int pathspec_matches(const char **paths
, const char *name
)
30 if (!paths
|| !*paths
)
32 namelen
= strlen(name
);
33 for (i
= 0; paths
[i
]; i
++) {
34 const char *match
= paths
[i
];
35 int matchlen
= strlen(match
);
36 const char *cp
, *meta
;
39 ((matchlen
<= namelen
) &&
40 !strncmp(name
, match
, matchlen
) &&
41 (match
[matchlen
-1] == '/' ||
42 name
[matchlen
] == '\0' || name
[matchlen
] == '/')))
44 if (!fnmatch(match
, name
, 0))
46 if (name
[namelen
-1] != '/')
49 /* We are being asked if the directory ("name") is worth
52 * Find the longest leading directory name that does
53 * not have metacharacter in the pathspec; the name
54 * we are looking at must overlap with that directory.
56 for (cp
= match
, meta
= NULL
; cp
- match
< matchlen
; cp
++) {
58 if (ch
== '*' || ch
== '[' || ch
== '?') {
64 meta
= cp
; /* fully literal */
66 if (namelen
<= meta
- match
) {
67 /* Looking at "Documentation/" and
68 * the pattern says "Documentation/howto/", or
69 * "Documentation/diff*.txt". The name we
70 * have should match prefix.
72 if (!memcmp(match
, name
, namelen
))
77 if (meta
- match
< namelen
) {
78 /* Looking at "Documentation/howto/" and
79 * the pattern says "Documentation/h*";
80 * match up to "Do.../h"; this avoids descending
81 * into "Documentation/technical/".
83 if (!memcmp(match
, name
, meta
- match
))
91 static int grep_sha1(struct grep_opt
*opt
, const unsigned char *sha1
, const char *name
, int tree_name_len
)
95 enum object_type type
;
99 data
= read_sha1_file(sha1
, &type
, &size
);
101 error("'%s': unable to read %s", name
, sha1_to_hex(sha1
));
104 if (opt
->relative
&& opt
->prefix_length
) {
105 static char name_buf
[PATH_MAX
];
107 int name_len
= strlen(name
) - opt
->prefix_length
+ 1;
110 name
+= opt
->prefix_length
;
112 if (ARRAY_SIZE(name_buf
) <= name_len
)
113 cp
= to_free
= xmalloc(name_len
);
116 memcpy(cp
, name
, tree_name_len
);
117 strcpy(cp
+ tree_name_len
,
118 name
+ tree_name_len
+ opt
->prefix_length
);
122 hit
= grep_buffer(opt
, name
, data
, size
);
128 static int grep_file(struct grep_opt
*opt
, const char *filename
)
135 if (lstat(filename
, &st
) < 0) {
138 error("'%s': %s", filename
, strerror(errno
));
142 return 0; /* empty file -- no grep hit */
143 if (!S_ISREG(st
.st_mode
))
145 sz
= xsize_t(st
.st_size
);
146 i
= open(filename
, O_RDONLY
);
149 data
= xmalloc(sz
+ 1);
150 if (st
.st_size
!= read_in_full(i
, data
, sz
)) {
151 error("'%s': short read %s", filename
, strerror(errno
));
157 if (opt
->relative
&& opt
->prefix_length
)
158 filename
+= opt
->prefix_length
;
159 i
= grep_buffer(opt
, filename
, data
, sz
);
164 #if !NO_EXTERNAL_GREP
165 static int exec_grep(int argc
, const char **argv
)
175 execvp("grep", (char **) argv
);
178 while (waitpid(pid
, &status
, 0) < 0) {
183 if (WIFEXITED(status
)) {
184 if (!WEXITSTATUS(status
))
193 #define push_arg(a) do { \
194 if (nr < MAXARGS) argv[nr++] = (a); \
195 else die("maximum number of args exceeded"); \
199 * If you send a singleton filename to grep, it does not give
200 * the name of the file. GNU grep has "-H" but we would want
201 * that behaviour in a portable way.
203 * So we keep two pathnames in argv buffer unsent to grep in
204 * the main loop if we need to do more than one grep.
206 static int flush_grep(struct grep_opt
*opt
,
207 int argc
, int arg0
, const char **argv
, int *kept
)
210 int count
= argc
- arg0
;
211 const char *kept_0
= NULL
;
215 * Because we keep at least 2 paths in the call from
216 * the main loop (i.e. kept != NULL), and MAXARGS is
217 * far greater than 2, this usually is a call to
218 * conclude the grep. However, the user could attempt
219 * to overflow the argv buffer by giving too many
220 * options to leave very small number of real
221 * arguments even for the call in the main loop.
224 die("insanely many options to grep");
227 * If we have two or more paths, we do not have to do
228 * anything special, but we need to push /dev/null to
229 * get "-H" behaviour of GNU grep portably but when we
230 * are not doing "-l" nor "-L" nor "-c".
234 !opt
->unmatch_name_only
&&
236 argv
[argc
++] = "/dev/null";
243 * Called because we found many paths and haven't finished
244 * iterating over the cache yet. We keep two paths
245 * for the concluding call. argv[argc-2] and argv[argc-1]
246 * has the last two paths, so save the first one away,
247 * replace it with NULL while sending the list to grep,
248 * and recover them after we are done.
251 kept_0
= argv
[argc
-2];
256 status
= exec_grep(argc
, argv
);
260 * Then recover them. Now the last arg is beyond the
261 * terminating NULL which is at argc, and the second
262 * from the last is what we saved away in kept_0
264 argv
[arg0
++] = kept_0
;
265 argv
[arg0
] = argv
[argc
+1];
270 static int external_grep(struct grep_opt
*opt
, const char **paths
, int cached
)
272 int i
, nr
, argc
, hit
, len
, status
;
273 const char *argv
[MAXARGS
+1];
274 char randarg
[ARGBUF
];
275 char *argptr
= randarg
;
278 if (opt
->extended
|| (opt
->relative
&& opt
->prefix_length
))
288 if (opt
->regflags
& REG_EXTENDED
)
290 if (opt
->regflags
& REG_ICASE
)
292 if (opt
->word_regexp
)
296 if (opt
->unmatch_name_only
)
298 if (opt
->null_following_name
)
299 /* in GNU grep git's "-z" translates to "-Z" */
303 if (opt
->post_context
|| opt
->pre_context
) {
304 if (opt
->post_context
!= opt
->pre_context
) {
305 if (opt
->pre_context
) {
307 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
308 "%u", opt
->pre_context
) + 1;
309 if (sizeof(randarg
) <= len
)
310 die("maximum length of args exceeded");
314 if (opt
->post_context
) {
316 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
317 "%u", opt
->post_context
) + 1;
318 if (sizeof(randarg
) <= len
)
319 die("maximum length of args exceeded");
326 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
327 "%u", opt
->post_context
) + 1;
328 if (sizeof(randarg
) <= len
)
329 die("maximum length of args exceeded");
334 for (p
= opt
->pattern_list
; p
; p
= p
->next
) {
336 push_arg(p
->pattern
);
341 for (i
= 0; i
< active_nr
; i
++) {
342 struct cache_entry
*ce
= active_cache
[i
];
345 if (!S_ISREG(ce
->ce_mode
))
347 if (!pathspec_matches(paths
, ce
->name
))
350 if (name
[0] == '-') {
351 int len
= ce_namelen(ce
);
352 name
= xmalloc(len
+ 3);
353 memcpy(name
, "./", 2);
354 memcpy(name
+ 2, ce
->name
, len
+ 1);
357 if (MAXARGS
<= argc
) {
358 status
= flush_grep(opt
, argc
, nr
, argv
, &kept
);
366 } while (i
< active_nr
&&
367 !strcmp(ce
->name
, active_cache
[i
]->name
));
368 i
--; /* compensate for loop control */
372 status
= flush_grep(opt
, argc
, nr
, argv
, NULL
);
380 static int grep_cache(struct grep_opt
*opt
, const char **paths
, int cached
)
386 #if !NO_EXTERNAL_GREP
388 * Use the external "grep" command for the case where
389 * we grep through the checked-out files. It tends to
390 * be a lot more optimized
393 hit
= external_grep(opt
, paths
, cached
);
399 for (nr
= 0; nr
< active_nr
; nr
++) {
400 struct cache_entry
*ce
= active_cache
[nr
];
401 if (!S_ISREG(ce
->ce_mode
))
403 if (!pathspec_matches(paths
, ce
->name
))
408 hit
|= grep_sha1(opt
, ce
->sha1
, ce
->name
, 0);
411 hit
|= grep_file(opt
, ce
->name
);
415 } while (nr
< active_nr
&&
416 !strcmp(ce
->name
, active_cache
[nr
]->name
));
417 nr
--; /* compensate for loop control */
420 free_grep_patterns(opt
);
424 static int grep_tree(struct grep_opt
*opt
, const char **paths
,
425 struct tree_desc
*tree
,
426 const char *tree_name
, const char *base
)
430 struct name_entry entry
;
432 int tn_len
= strlen(tree_name
);
433 struct strbuf pathbuf
;
435 strbuf_init(&pathbuf
, PATH_MAX
+ tn_len
);
438 strbuf_add(&pathbuf
, tree_name
, tn_len
);
439 strbuf_addch(&pathbuf
, ':');
440 tn_len
= pathbuf
.len
;
442 strbuf_addstr(&pathbuf
, base
);
445 while (tree_entry(tree
, &entry
)) {
446 int te_len
= tree_entry_len(entry
.path
, entry
.sha1
);
448 strbuf_add(&pathbuf
, entry
.path
, te_len
);
450 if (S_ISDIR(entry
.mode
))
451 /* Match "abc/" against pathspec to
452 * decide if we want to descend into "abc"
455 strbuf_addch(&pathbuf
, '/');
457 down
= pathbuf
.buf
+ tn_len
;
458 if (!pathspec_matches(paths
, down
))
460 else if (S_ISREG(entry
.mode
))
461 hit
|= grep_sha1(opt
, entry
.sha1
, pathbuf
.buf
, tn_len
);
462 else if (S_ISDIR(entry
.mode
)) {
463 enum object_type type
;
464 struct tree_desc sub
;
468 data
= read_sha1_file(entry
.sha1
, &type
, &size
);
470 die("unable to read tree (%s)",
471 sha1_to_hex(entry
.sha1
));
472 init_tree_desc(&sub
, data
, size
);
473 hit
|= grep_tree(opt
, paths
, &sub
, tree_name
, down
);
477 strbuf_release(&pathbuf
);
481 static int grep_object(struct grep_opt
*opt
, const char **paths
,
482 struct object
*obj
, const char *name
)
484 if (obj
->type
== OBJ_BLOB
)
485 return grep_sha1(opt
, obj
->sha1
, name
, 0);
486 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
487 struct tree_desc tree
;
491 data
= read_object_with_reference(obj
->sha1
, tree_type
,
494 die("unable to read tree (%s)", sha1_to_hex(obj
->sha1
));
495 init_tree_desc(&tree
, data
, size
);
496 hit
= grep_tree(opt
, paths
, &tree
, name
, "");
500 die("unable to grep from object of type %s", typename(obj
->type
));
503 static const char builtin_grep_usage
[] =
504 "git grep <option>* [-e] <pattern> <rev>* [[--] <path>...]";
506 static const char emsg_invalid_context_len
[] =
507 "%s: invalid context length argument";
508 static const char emsg_missing_context_len
[] =
509 "missing context length argument";
510 static const char emsg_missing_argument
[] =
511 "option requires an argument -%s";
513 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
517 int seen_dashdash
= 0;
519 struct object_array list
= { 0, 0, NULL
};
520 const char **paths
= NULL
;
523 memset(&opt
, 0, sizeof(opt
));
524 opt
.prefix_length
= (prefix
&& *prefix
) ? strlen(prefix
) : 0;
527 opt
.pattern_tail
= &opt
.pattern_list
;
528 opt
.regflags
= REG_NEWLINE
;
531 * If there is no -- then the paths must exist in the working
532 * tree. If there is no explicit pattern specified with -e or
533 * -f, we take the first unrecognized non option to be the
534 * pattern, but then what follows it must be zero or more
535 * valid refs up to the -- (if exists), and then existing
536 * paths. If there is an explicit pattern, then the first
537 * unrecognized non option is the beginning of the refs list
538 * that continues up to the -- (if exists), and then paths.
542 const char *arg
= argv
[1];
544 if (!strcmp("--cached", arg
)) {
548 if (!strcmp("-a", arg
) ||
549 !strcmp("--text", arg
)) {
550 opt
.binary
= GREP_BINARY_TEXT
;
553 if (!strcmp("-i", arg
) ||
554 !strcmp("--ignore-case", arg
)) {
555 opt
.regflags
|= REG_ICASE
;
558 if (!strcmp("-I", arg
)) {
559 opt
.binary
= GREP_BINARY_NOMATCH
;
562 if (!strcmp("-v", arg
) ||
563 !strcmp("--invert-match", arg
)) {
567 if (!strcmp("-E", arg
) ||
568 !strcmp("--extended-regexp", arg
)) {
569 opt
.regflags
|= REG_EXTENDED
;
572 if (!strcmp("-F", arg
) ||
573 !strcmp("--fixed-strings", arg
)) {
577 if (!strcmp("-G", arg
) ||
578 !strcmp("--basic-regexp", arg
)) {
579 opt
.regflags
&= ~REG_EXTENDED
;
582 if (!strcmp("-n", arg
)) {
586 if (!strcmp("-h", arg
)) {
590 if (!strcmp("-H", arg
)) {
594 if (!strcmp("-l", arg
) ||
595 !strcmp("--name-only", arg
) ||
596 !strcmp("--files-with-matches", arg
)) {
600 if (!strcmp("-L", arg
) ||
601 !strcmp("--files-without-match", arg
)) {
602 opt
.unmatch_name_only
= 1;
605 if (!strcmp("-z", arg
) ||
606 !strcmp("--null", arg
)) {
607 opt
.null_following_name
= 1;
610 if (!strcmp("-c", arg
) ||
611 !strcmp("--count", arg
)) {
615 if (!strcmp("-w", arg
) ||
616 !strcmp("--word-regexp", arg
)) {
620 if (!prefixcmp(arg
, "-A") ||
621 !prefixcmp(arg
, "-B") ||
622 !prefixcmp(arg
, "-C") ||
623 (arg
[0] == '-' && '1' <= arg
[1] && arg
[1] <= '9')) {
627 case 'A': case 'B': case 'C':
630 die(emsg_missing_context_len
);
641 if (strtoul_ui(scan
, 10, &num
))
642 die(emsg_invalid_context_len
, scan
);
645 opt
.post_context
= num
;
649 opt
.post_context
= num
;
651 opt
.pre_context
= num
;
656 if (!strcmp("-f", arg
)) {
661 die(emsg_missing_argument
, arg
);
662 patterns
= fopen(argv
[1], "r");
664 die("'%s': %s", argv
[1], strerror(errno
));
665 while (fgets(buf
, sizeof(buf
), patterns
)) {
666 int len
= strlen(buf
);
667 if (len
&& buf
[len
-1] == '\n')
669 /* ignore empty line like grep does */
672 append_grep_pattern(&opt
, xstrdup(buf
),
681 if (!strcmp("--not", arg
)) {
682 append_grep_pattern(&opt
, arg
, "command line", 0,
686 if (!strcmp("--and", arg
)) {
687 append_grep_pattern(&opt
, arg
, "command line", 0,
691 if (!strcmp("--or", arg
))
692 continue; /* no-op */
693 if (!strcmp("(", arg
)) {
694 append_grep_pattern(&opt
, arg
, "command line", 0,
698 if (!strcmp(")", arg
)) {
699 append_grep_pattern(&opt
, arg
, "command line", 0,
703 if (!strcmp("--all-match", arg
)) {
707 if (!strcmp("-e", arg
)) {
709 append_grep_pattern(&opt
, argv
[1],
716 die(emsg_missing_argument
, arg
);
718 if (!strcmp("--full-name", arg
)) {
722 if (!strcmp("--", arg
)) {
723 /* later processing wants to have this at argv[1] */
729 usage(builtin_grep_usage
);
731 /* First unrecognized non-option token */
732 if (!opt
.pattern_list
) {
733 append_grep_pattern(&opt
, arg
, "command line", 0,
738 /* We are looking at the first path or rev;
739 * it is found at argv[1] after leaving the
747 if (!opt
.pattern_list
)
748 die("no pattern given.");
749 if ((opt
.regflags
!= REG_NEWLINE
) && opt
.fixed
)
750 die("cannot mix --fixed-strings and regexp");
751 compile_grep_patterns(&opt
);
753 /* Check revs and then paths */
754 for (i
= 1; i
< argc
; i
++) {
755 const char *arg
= argv
[i
];
756 unsigned char sha1
[20];
758 if (!get_sha1(arg
, sha1
)) {
759 struct object
*object
= parse_object(sha1
);
761 die("bad object %s", arg
);
762 add_object_array(object
, arg
, &list
);
765 if (!strcmp(arg
, "--")) {
772 /* The rest are paths */
773 if (!seen_dashdash
) {
775 for (j
= i
; j
< argc
; j
++)
776 verify_filename(prefix
, argv
[j
]);
780 paths
= get_pathspec(prefix
, argv
+ i
);
781 if (opt
.prefix_length
&& opt
.relative
) {
782 /* Make sure we do not get outside of paths */
783 for (i
= 0; paths
[i
]; i
++)
784 if (strncmp(prefix
, paths
[i
], opt
.prefix_length
))
785 die("git grep: cannot generate relative filenames containing '..'");
789 paths
= xcalloc(2, sizeof(const char *));
797 return !grep_cache(&opt
, paths
, cached
);
801 die("both --cached and trees are given.");
803 for (i
= 0; i
< list
.nr
; i
++) {
804 struct object
*real_obj
;
805 real_obj
= deref_tag(list
.objects
[i
].item
, NULL
, 0);
806 if (grep_object(&opt
, paths
, real_obj
, list
.objects
[i
].name
))
809 free_grep_patterns(&opt
);