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
)
300 if (opt
->post_context
|| opt
->pre_context
) {
301 if (opt
->post_context
!= opt
->pre_context
) {
302 if (opt
->pre_context
) {
304 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
305 "%u", opt
->pre_context
) + 1;
306 if (sizeof(randarg
) <= len
)
307 die("maximum length of args exceeded");
311 if (opt
->post_context
) {
313 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
314 "%u", opt
->post_context
) + 1;
315 if (sizeof(randarg
) <= len
)
316 die("maximum length of args exceeded");
323 len
+= snprintf(argptr
, sizeof(randarg
)-len
,
324 "%u", opt
->post_context
) + 1;
325 if (sizeof(randarg
) <= len
)
326 die("maximum length of args exceeded");
331 for (p
= opt
->pattern_list
; p
; p
= p
->next
) {
333 push_arg(p
->pattern
);
338 for (i
= 0; i
< active_nr
; i
++) {
339 struct cache_entry
*ce
= active_cache
[i
];
342 if (!S_ISREG(ce
->ce_mode
))
344 if (!pathspec_matches(paths
, ce
->name
))
347 if (name
[0] == '-') {
348 int len
= ce_namelen(ce
);
349 name
= xmalloc(len
+ 3);
350 memcpy(name
, "./", 2);
351 memcpy(name
+ 2, ce
->name
, len
+ 1);
354 if (MAXARGS
<= argc
) {
355 status
= flush_grep(opt
, argc
, nr
, argv
, &kept
);
363 } while (i
< active_nr
&&
364 !strcmp(ce
->name
, active_cache
[i
]->name
));
365 i
--; /* compensate for loop control */
369 status
= flush_grep(opt
, argc
, nr
, argv
, NULL
);
377 static int grep_cache(struct grep_opt
*opt
, const char **paths
, int cached
)
383 #if !NO_EXTERNAL_GREP
385 * Use the external "grep" command for the case where
386 * we grep through the checked-out files. It tends to
387 * be a lot more optimized
390 hit
= external_grep(opt
, paths
, cached
);
396 for (nr
= 0; nr
< active_nr
; nr
++) {
397 struct cache_entry
*ce
= active_cache
[nr
];
398 if (!S_ISREG(ce
->ce_mode
))
400 if (!pathspec_matches(paths
, ce
->name
))
405 hit
|= grep_sha1(opt
, ce
->sha1
, ce
->name
, 0);
408 hit
|= grep_file(opt
, ce
->name
);
412 } while (nr
< active_nr
&&
413 !strcmp(ce
->name
, active_cache
[nr
]->name
));
414 nr
--; /* compensate for loop control */
417 free_grep_patterns(opt
);
421 static int grep_tree(struct grep_opt
*opt
, const char **paths
,
422 struct tree_desc
*tree
,
423 const char *tree_name
, const char *base
)
427 struct name_entry entry
;
429 int tn_len
= strlen(tree_name
);
430 struct strbuf pathbuf
;
432 strbuf_init(&pathbuf
, PATH_MAX
+ tn_len
);
435 strbuf_add(&pathbuf
, tree_name
, tn_len
);
436 strbuf_addch(&pathbuf
, ':');
437 tn_len
= pathbuf
.len
;
439 strbuf_addstr(&pathbuf
, base
);
442 while (tree_entry(tree
, &entry
)) {
443 int te_len
= tree_entry_len(entry
.path
, entry
.sha1
);
445 strbuf_add(&pathbuf
, entry
.path
, te_len
);
447 if (S_ISDIR(entry
.mode
))
448 /* Match "abc/" against pathspec to
449 * decide if we want to descend into "abc"
452 strbuf_addch(&pathbuf
, '/');
454 down
= pathbuf
.buf
+ tn_len
;
455 if (!pathspec_matches(paths
, down
))
457 else if (S_ISREG(entry
.mode
))
458 hit
|= grep_sha1(opt
, entry
.sha1
, pathbuf
.buf
, tn_len
);
459 else if (S_ISDIR(entry
.mode
)) {
460 enum object_type type
;
461 struct tree_desc sub
;
465 data
= read_sha1_file(entry
.sha1
, &type
, &size
);
467 die("unable to read tree (%s)",
468 sha1_to_hex(entry
.sha1
));
469 init_tree_desc(&sub
, data
, size
);
470 hit
|= grep_tree(opt
, paths
, &sub
, tree_name
, down
);
474 strbuf_release(&pathbuf
);
478 static int grep_object(struct grep_opt
*opt
, const char **paths
,
479 struct object
*obj
, const char *name
)
481 if (obj
->type
== OBJ_BLOB
)
482 return grep_sha1(opt
, obj
->sha1
, name
, 0);
483 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
484 struct tree_desc tree
;
488 data
= read_object_with_reference(obj
->sha1
, tree_type
,
491 die("unable to read tree (%s)", sha1_to_hex(obj
->sha1
));
492 init_tree_desc(&tree
, data
, size
);
493 hit
= grep_tree(opt
, paths
, &tree
, name
, "");
497 die("unable to grep from object of type %s", typename(obj
->type
));
500 static const char builtin_grep_usage
[] =
501 "git grep <option>* [-e] <pattern> <rev>* [[--] <path>...]";
503 static const char emsg_invalid_context_len
[] =
504 "%s: invalid context length argument";
505 static const char emsg_missing_context_len
[] =
506 "missing context length argument";
507 static const char emsg_missing_argument
[] =
508 "option requires an argument -%s";
510 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
514 int seen_dashdash
= 0;
516 struct object_array list
= { 0, 0, NULL
};
517 const char **paths
= NULL
;
520 memset(&opt
, 0, sizeof(opt
));
521 opt
.prefix_length
= (prefix
&& *prefix
) ? strlen(prefix
) : 0;
524 opt
.pattern_tail
= &opt
.pattern_list
;
525 opt
.regflags
= REG_NEWLINE
;
528 * If there is no -- then the paths must exist in the working
529 * tree. If there is no explicit pattern specified with -e or
530 * -f, we take the first unrecognized non option to be the
531 * pattern, but then what follows it must be zero or more
532 * valid refs up to the -- (if exists), and then existing
533 * paths. If there is an explicit pattern, then the first
534 * unrecognized non option is the beginning of the refs list
535 * that continues up to the -- (if exists), and then paths.
539 const char *arg
= argv
[1];
541 if (!strcmp("--cached", arg
)) {
545 if (!strcmp("-a", arg
) ||
546 !strcmp("--text", arg
)) {
547 opt
.binary
= GREP_BINARY_TEXT
;
550 if (!strcmp("-i", arg
) ||
551 !strcmp("--ignore-case", arg
)) {
552 opt
.regflags
|= REG_ICASE
;
555 if (!strcmp("-I", arg
)) {
556 opt
.binary
= GREP_BINARY_NOMATCH
;
559 if (!strcmp("-v", arg
) ||
560 !strcmp("--invert-match", arg
)) {
564 if (!strcmp("-E", arg
) ||
565 !strcmp("--extended-regexp", arg
)) {
566 opt
.regflags
|= REG_EXTENDED
;
569 if (!strcmp("-F", arg
) ||
570 !strcmp("--fixed-strings", arg
)) {
574 if (!strcmp("-G", arg
) ||
575 !strcmp("--basic-regexp", arg
)) {
576 opt
.regflags
&= ~REG_EXTENDED
;
579 if (!strcmp("-n", arg
)) {
583 if (!strcmp("-h", arg
)) {
587 if (!strcmp("-H", arg
)) {
591 if (!strcmp("-l", arg
) ||
592 !strcmp("--name-only", arg
) ||
593 !strcmp("--files-with-matches", arg
)) {
597 if (!strcmp("-L", arg
) ||
598 !strcmp("--files-without-match", arg
)) {
599 opt
.unmatch_name_only
= 1;
602 if (!strcmp("-c", arg
) ||
603 !strcmp("--count", arg
)) {
607 if (!strcmp("-w", arg
) ||
608 !strcmp("--word-regexp", arg
)) {
612 if (!prefixcmp(arg
, "-A") ||
613 !prefixcmp(arg
, "-B") ||
614 !prefixcmp(arg
, "-C") ||
615 (arg
[0] == '-' && '1' <= arg
[1] && arg
[1] <= '9')) {
619 case 'A': case 'B': case 'C':
622 die(emsg_missing_context_len
);
633 if (strtoul_ui(scan
, 10, &num
))
634 die(emsg_invalid_context_len
, scan
);
637 opt
.post_context
= num
;
641 opt
.post_context
= num
;
643 opt
.pre_context
= num
;
648 if (!strcmp("-f", arg
)) {
653 die(emsg_missing_argument
, arg
);
654 patterns
= fopen(argv
[1], "r");
656 die("'%s': %s", argv
[1], strerror(errno
));
657 while (fgets(buf
, sizeof(buf
), patterns
)) {
658 int len
= strlen(buf
);
659 if (len
&& buf
[len
-1] == '\n')
661 /* ignore empty line like grep does */
664 append_grep_pattern(&opt
, xstrdup(buf
),
673 if (!strcmp("--not", arg
)) {
674 append_grep_pattern(&opt
, arg
, "command line", 0,
678 if (!strcmp("--and", arg
)) {
679 append_grep_pattern(&opt
, arg
, "command line", 0,
683 if (!strcmp("--or", arg
))
684 continue; /* no-op */
685 if (!strcmp("(", arg
)) {
686 append_grep_pattern(&opt
, arg
, "command line", 0,
690 if (!strcmp(")", arg
)) {
691 append_grep_pattern(&opt
, arg
, "command line", 0,
695 if (!strcmp("--all-match", arg
)) {
699 if (!strcmp("-e", arg
)) {
701 append_grep_pattern(&opt
, argv
[1],
708 die(emsg_missing_argument
, arg
);
710 if (!strcmp("--full-name", arg
)) {
714 if (!strcmp("--", arg
)) {
715 /* later processing wants to have this at argv[1] */
721 usage(builtin_grep_usage
);
723 /* First unrecognized non-option token */
724 if (!opt
.pattern_list
) {
725 append_grep_pattern(&opt
, arg
, "command line", 0,
730 /* We are looking at the first path or rev;
731 * it is found at argv[1] after leaving the
739 if (!opt
.pattern_list
)
740 die("no pattern given.");
741 if ((opt
.regflags
!= REG_NEWLINE
) && opt
.fixed
)
742 die("cannot mix --fixed-strings and regexp");
743 compile_grep_patterns(&opt
);
745 /* Check revs and then paths */
746 for (i
= 1; i
< argc
; i
++) {
747 const char *arg
= argv
[i
];
748 unsigned char sha1
[20];
750 if (!get_sha1(arg
, sha1
)) {
751 struct object
*object
= parse_object(sha1
);
753 die("bad object %s", arg
);
754 add_object_array(object
, arg
, &list
);
757 if (!strcmp(arg
, "--")) {
764 /* The rest are paths */
765 if (!seen_dashdash
) {
767 for (j
= i
; j
< argc
; j
++)
768 verify_filename(prefix
, argv
[j
]);
772 paths
= get_pathspec(prefix
, argv
+ i
);
773 if (opt
.prefix_length
&& opt
.relative
) {
774 /* Make sure we do not get outside of paths */
775 for (i
= 0; paths
[i
]; i
++)
776 if (strncmp(prefix
, paths
[i
], opt
.prefix_length
))
777 die("git grep: cannot generate relative filenames containing '..'");
781 paths
= xcalloc(2, sizeof(const char *));
787 return !grep_cache(&opt
, paths
, cached
);
790 die("both --cached and trees are given.");
792 for (i
= 0; i
< list
.nr
; i
++) {
793 struct object
*real_obj
;
794 real_obj
= deref_tag(list
.objects
[i
].item
, NULL
, 0);
795 if (grep_object(&opt
, paths
, real_obj
, list
.objects
[i
].name
))
798 free_grep_patterns(&opt
);