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;
33 ((matchlen <= namelen) &&
34 !strncmp(name, match, matchlen) &&
35 (match[matchlen-1] == '/' ||
36 name[matchlen] == '\0' || name[matchlen] == '/')))
38 if (!fnmatch(match, name, 0))
40 if (name[namelen-1] != '/')
43 /* We are being asked if the directory ("name") is worth
46 * Find the longest leading directory name that does
47 * not have metacharacter in the pathspec; the name
48 * we are looking at must overlap with that directory.
50 for (cp = match, meta = NULL; cp - match < matchlen; cp++) {
52 if (ch == '*' || ch == '[' || ch == '?') {
58 meta = cp; /* fully literal */
60 if (namelen <= meta - match) {
61 /* Looking at "Documentation/" and
62 * the pattern says "Documentation/howto/", or
63 * "Documentation/diff*.txt". The name we
64 * have should match prefix.
66 if (!memcmp(match, name, namelen))
71 if (meta - match < namelen) {
72 /* Looking at "Documentation/howto/" and
73 * the pattern says "Documentation/h*";
74 * match up to "Do.../h"; this avoids descending
75 * into "Documentation/technical/".
77 if (!memcmp(match, name, meta - match))
86 struct grep_pat *next;
94 struct grep_pat *pattern_list;
95 struct grep_pat **pattern_tail;
100 unsigned unmatch_name_only:1;
102 unsigned word_regexp:1;
104 #define GREP_BINARY_DEFAULT 0
105 #define GREP_BINARY_NOMATCH 1
106 #define GREP_BINARY_TEXT 2
109 unsigned pre_context;
110 unsigned post_context;
113 static void add_pattern(struct grep_opt *opt, const char *pat,
114 const char *origin, int no)
116 struct grep_pat *p = xcalloc(1, sizeof(*p));
120 *opt->pattern_tail = p;
121 opt->pattern_tail = &p->next;
125 static void compile_patterns(struct grep_opt *opt)
128 for (p = opt->pattern_list; p; p = p->next) {
129 int err = regcomp(&p->regexp, p->pattern, opt->regflags);
134 sprintf(where, "In '%s' at %d, ",
137 sprintf(where, "%s, ", p->origin);
140 regerror(err, &p->regexp, errbuf, 1024);
142 die("%s'%s': %s", where, p->pattern, errbuf);
147 static char *end_of_line(char *cp, unsigned long *left)
149 unsigned long l = *left;
150 while (l && *cp != '\n') {
158 static int word_char(char ch)
160 return isalnum(ch) || ch == '_';
163 static void show_line(struct grep_opt *opt, const char *bol, const char *eol,
164 const char *name, unsigned lno, char sign)
166 printf("%s%c", name, sign);
168 printf("%d%c", lno, sign);
169 printf("%.*s\n", (int)(eol-bol), bol);
173 * NEEDSWORK: share code with diff.c
175 #define FIRST_FEW_BYTES 8000
176 static int buffer_is_binary(const char *ptr, unsigned long size)
178 if (FIRST_FEW_BYTES < size)
179 size = FIRST_FEW_BYTES;
180 if (memchr(ptr, 0, size))
185 static int fixmatch(const char *pattern, char *line, regmatch_t *match)
187 char *hit = strstr(line, pattern);
189 match->rm_so = match->rm_eo = -1;
193 match->rm_so = hit - line;
194 match->rm_eo = match->rm_so + strlen(pattern);
199 static int grep_buffer(struct grep_opt *opt, const char *name,
200 char *buf, unsigned long size)
203 unsigned long left = size;
205 struct pre_context_line {
208 } *prev = NULL, *pcl;
209 unsigned last_hit = 0;
210 unsigned last_shown = 0;
211 int binary_match_only = 0;
212 const char *hunk_mark = "";
215 if (buffer_is_binary(buf, size)) {
216 switch (opt->binary) {
217 case GREP_BINARY_DEFAULT:
218 binary_match_only = 1;
220 case GREP_BINARY_NOMATCH:
221 return 0; /* Assume unmatch */
228 if (opt->pre_context)
229 prev = xcalloc(opt->pre_context, sizeof(*prev));
230 if (opt->pre_context || opt->post_context)
234 regmatch_t pmatch[10];
239 eol = end_of_line(bol, &left);
243 for (p = opt->pattern_list; p; p = p->next) {
245 regex_t *exp = &p->regexp;
246 hit = !regexec(exp, bol, ARRAY_SIZE(pmatch),
250 hit = !fixmatch(p->pattern, bol, pmatch);
253 if (hit && opt->word_regexp) {
254 /* Match beginning must be either
255 * beginning of the line, or at word
256 * boundary (i.e. the last char must
257 * not be alnum or underscore).
259 if ((pmatch[0].rm_so < 0) ||
260 (eol - bol) <= pmatch[0].rm_so ||
261 (pmatch[0].rm_eo < 0) ||
262 (eol - bol) < pmatch[0].rm_eo)
263 die("regexp returned nonsense");
264 if (pmatch[0].rm_so != 0 &&
265 word_char(bol[pmatch[0].rm_so-1]))
267 if (pmatch[0].rm_eo != (eol-bol) &&
268 word_char(bol[pmatch[0].rm_eo]))
274 /* "grep -v -e foo -e bla" should list lines
275 * that do not have either, so inversion should
280 if (opt->unmatch_name_only) {
287 if (binary_match_only) {
288 printf("Binary file %s matches\n", name);
291 if (opt->name_only) {
292 printf("%s\n", name);
295 /* Hit at this line. If we haven't shown the
296 * pre-context lines, we would need to show them.
297 * When asked to do "count", this still show
298 * the context which is nonsense, but the user
299 * deserves to get that ;-).
301 if (opt->pre_context) {
303 if (opt->pre_context < lno)
304 from = lno - opt->pre_context;
307 if (from <= last_shown)
308 from = last_shown + 1;
309 if (last_shown && from != last_shown + 1)
312 pcl = &prev[lno-from-1];
313 show_line(opt, pcl->bol, pcl->eol,
319 if (last_shown && lno != last_shown + 1)
322 show_line(opt, bol, eol, name, lno, ':');
323 last_shown = last_hit = lno;
326 lno <= last_hit + opt->post_context) {
327 /* If the last hit is within the post context,
328 * we need to show this line.
330 if (last_shown && lno != last_shown + 1)
332 show_line(opt, bol, eol, name, lno, '-');
335 if (opt->pre_context) {
336 memmove(prev+1, prev,
337 (opt->pre_context-1) * sizeof(*prev));
351 if (opt->unmatch_name_only) {
352 /* We did not see any hit, so we want to show this */
353 printf("%s\n", name);
358 * The real "grep -c foo *.c" gives many "bar.c:0" lines,
359 * which feels mostly useless but sometimes useful. Maybe
360 * make it another option? For now suppress them.
362 if (opt->count && count)
363 printf("%s:%u\n", name, count);
367 static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1, const char *name)
373 data = read_sha1_file(sha1, type, &size);
375 error("'%s': unable to read %s", name, sha1_to_hex(sha1));
378 hit = grep_buffer(opt, name, data, size);
383 static int grep_file(struct grep_opt *opt, const char *filename)
388 if (lstat(filename, &st) < 0) {
391 error("'%s': %s", filename, strerror(errno));
395 return 0; /* empty file -- no grep hit */
396 if (!S_ISREG(st.st_mode))
398 i = open(filename, O_RDONLY);
401 data = xmalloc(st.st_size + 1);
402 if (st.st_size != xread(i, data, st.st_size)) {
403 error("'%s': short read %s", filename, strerror(errno));
409 i = grep_buffer(opt, filename, data, st.st_size);
414 static int exec_grep(int argc, const char **argv)
424 execvp("grep", (char **) argv);
427 while (waitpid(pid, &status, 0) < 0) {
432 if (WIFEXITED(status)) {
433 if (!WEXITSTATUS(status))
442 #define push_arg(a) do { \
443 if (nr < MAXARGS) argv[nr++] = (a); \
444 else die("maximum number of args exceeded"); \
447 static int external_grep(struct grep_opt *opt, const char **paths, int cached)
449 int i, nr, argc, hit, len;
450 const char *argv[MAXARGS+1];
451 char randarg[ARGBUF];
452 char *argptr = randarg;
461 if (opt->regflags & REG_EXTENDED)
463 if (opt->regflags & REG_ICASE)
465 if (opt->word_regexp)
469 if (opt->unmatch_name_only)
473 if (opt->post_context || opt->pre_context) {
474 if (opt->post_context != opt->pre_context) {
475 if (opt->pre_context) {
477 len += snprintf(argptr, sizeof(randarg)-len,
478 "%u", opt->pre_context);
479 if (sizeof(randarg) <= len)
480 die("maximum length of args exceeded");
484 if (opt->post_context) {
486 len += snprintf(argptr, sizeof(randarg)-len,
487 "%u", opt->post_context);
488 if (sizeof(randarg) <= len)
489 die("maximum length of args exceeded");
496 len += snprintf(argptr, sizeof(randarg)-len,
497 "%u", opt->post_context);
498 if (sizeof(randarg) <= len)
499 die("maximum length of args exceeded");
504 for (p = opt->pattern_list; p; p = p->next) {
506 push_arg(p->pattern);
510 * To make sure we get the header printed out when we want it,
511 * add /dev/null to the paths to grep. This is unnecessary
512 * (and wrong) with "-l" or "-L", which always print out the
515 * GNU grep has "-H", but this is portable.
517 if (!opt->name_only && !opt->unmatch_name_only)
518 push_arg("/dev/null");
522 for (i = 0; i < active_nr; i++) {
523 struct cache_entry *ce = active_cache[i];
525 if (ce_stage(ce) || !S_ISREG(ntohl(ce->ce_mode)))
527 if (!pathspec_matches(paths, ce->name))
530 if (name[0] == '-') {
531 int len = ce_namelen(ce);
532 name = xmalloc(len + 3);
533 memcpy(name, "./", 2);
534 memcpy(name + 2, ce->name, len + 1);
539 hit += exec_grep(argc, argv);
543 hit += exec_grep(argc, argv);
547 static int grep_cache(struct grep_opt *opt, const char **paths, int cached)
555 * Use the external "grep" command for the case where
556 * we grep through the checked-out files. It tends to
557 * be a lot more optimized
560 hit = external_grep(opt, paths, cached);
566 for (nr = 0; nr < active_nr; nr++) {
567 struct cache_entry *ce = active_cache[nr];
568 if (ce_stage(ce) || !S_ISREG(ntohl(ce->ce_mode)))
570 if (!pathspec_matches(paths, ce->name))
573 hit |= grep_sha1(opt, ce->sha1, ce->name);
575 hit |= grep_file(opt, ce->name);
580 static int grep_tree(struct grep_opt *opt, const char **paths,
581 struct tree_desc *tree,
582 const char *tree_name, const char *base)
586 struct name_entry entry;
588 char *path_buf = xmalloc(PATH_MAX + strlen(tree_name) + 100);
591 int offset = sprintf(path_buf, "%s:", tree_name);
592 down = path_buf + offset;
599 len = strlen(path_buf);
601 while (tree_entry(tree, &entry)) {
602 strcpy(path_buf + len, entry.path);
604 if (S_ISDIR(entry.mode))
605 /* Match "abc/" against pathspec to
606 * decide if we want to descend into "abc"
609 strcpy(path_buf + len + entry.pathlen, "/");
611 if (!pathspec_matches(paths, down))
613 else if (S_ISREG(entry.mode))
614 hit |= grep_sha1(opt, entry.sha1, path_buf);
615 else if (S_ISDIR(entry.mode)) {
617 struct tree_desc sub;
619 data = read_sha1_file(entry.sha1, type, &sub.size);
621 die("unable to read tree (%s)",
622 sha1_to_hex(entry.sha1));
624 hit |= grep_tree(opt, paths, &sub, tree_name, down);
631 static int grep_object(struct grep_opt *opt, const char **paths,
632 struct object *obj, const char *name)
634 if (obj->type == TYPE_BLOB)
635 return grep_sha1(opt, obj->sha1, name);
636 if (obj->type == TYPE_COMMIT || obj->type == TYPE_TREE) {
637 struct tree_desc tree;
640 data = read_object_with_reference(obj->sha1, tree_type,
643 die("unable to read tree (%s)", sha1_to_hex(obj->sha1));
645 hit = grep_tree(opt, paths, &tree, name, "");
649 die("unable to grep from object of type %s", typename(obj->type));
652 static const char builtin_grep_usage[] =
653 "git-grep <option>* <rev>* [-e] <pattern> [<path>...]";
655 int cmd_grep(int argc, const char **argv, char **envp)
659 int seen_dashdash = 0;
661 struct object_array list = { 0, 0, NULL };
662 const char *prefix = setup_git_directory();
663 const char **paths = NULL;
666 memset(&opt, 0, sizeof(opt));
667 opt.pattern_tail = &opt.pattern_list;
668 opt.regflags = REG_NEWLINE;
671 * If there is no -- then the paths must exist in the working
672 * tree. If there is no explicit pattern specified with -e or
673 * -f, we take the first unrecognized non option to be the
674 * pattern, but then what follows it must be zero or more
675 * valid refs up to the -- (if exists), and then existing
676 * paths. If there is an explicit pattern, then the first
677 * unrecocnized non option is the beginning of the refs list
678 * that continues up to the -- (if exists), and then paths.
682 const char *arg = argv[1];
684 if (!strcmp("--cached", arg)) {
688 if (!strcmp("-a", arg) ||
689 !strcmp("--text", arg)) {
690 opt.binary = GREP_BINARY_TEXT;
693 if (!strcmp("-i", arg) ||
694 !strcmp("--ignore-case", arg)) {
695 opt.regflags |= REG_ICASE;
698 if (!strcmp("-I", arg)) {
699 opt.binary = GREP_BINARY_NOMATCH;
702 if (!strcmp("-v", arg) ||
703 !strcmp("--invert-match", arg)) {
707 if (!strcmp("-E", arg) ||
708 !strcmp("--extended-regexp", arg)) {
709 opt.regflags |= REG_EXTENDED;
712 if (!strcmp("-F", arg) ||
713 !strcmp("--fixed-strings", arg)) {
717 if (!strcmp("-G", arg) ||
718 !strcmp("--basic-regexp", arg)) {
719 opt.regflags &= ~REG_EXTENDED;
722 if (!strcmp("-n", arg)) {
726 if (!strcmp("-H", arg)) {
727 /* We always show the pathname, so this
732 if (!strcmp("-l", arg) ||
733 !strcmp("--files-with-matches", arg)) {
737 if (!strcmp("-L", arg) ||
738 !strcmp("--files-without-match", arg)) {
739 opt.unmatch_name_only = 1;
742 if (!strcmp("-c", arg) ||
743 !strcmp("--count", arg)) {
747 if (!strcmp("-w", arg) ||
748 !strcmp("--word-regexp", arg)) {
752 if (!strncmp("-A", arg, 2) ||
753 !strncmp("-B", arg, 2) ||
754 !strncmp("-C", arg, 2) ||
755 (arg[0] == '-' && '1' <= arg[1] && arg[1] <= '9')) {
759 case 'A': case 'B': case 'C':
762 usage(builtin_grep_usage);
773 if (sscanf(scan, "%u", &num) != 1)
774 usage(builtin_grep_usage);
777 opt.post_context = num;
781 opt.post_context = num;
783 opt.pre_context = num;
788 if (!strcmp("-f", arg)) {
793 usage(builtin_grep_usage);
794 patterns = fopen(argv[1], "r");
796 die("'%s': %s", argv[1], strerror(errno));
797 while (fgets(buf, sizeof(buf), patterns)) {
798 int len = strlen(buf);
799 if (buf[len-1] == '\n')
801 /* ignore empty line like grep does */
804 add_pattern(&opt, strdup(buf), argv[1], ++lno);
811 if (!strcmp("-e", arg)) {
813 add_pattern(&opt, argv[1], "-e option", 0);
818 usage(builtin_grep_usage);
820 if (!strcmp("--", arg))
823 usage(builtin_grep_usage);
825 /* First unrecognized non-option token */
826 if (!opt.pattern_list) {
827 add_pattern(&opt, arg, "command line", 0);
831 /* We are looking at the first path or rev;
832 * it is found at argv[1] after leaving the
840 if (!opt.pattern_list)
841 die("no pattern given.");
842 if ((opt.regflags != REG_NEWLINE) && opt.fixed)
843 die("cannot mix --fixed-strings and regexp");
845 compile_patterns(&opt);
847 /* Check revs and then paths */
848 for (i = 1; i < argc; i++) {
849 const char *arg = argv[i];
850 unsigned char sha1[20];
852 if (!get_sha1(arg, sha1)) {
853 struct object *object = parse_object(sha1);
855 die("bad object %s", arg);
856 add_object_array(object, arg, &list);
859 if (!strcmp(arg, "--")) {
866 /* The rest are paths */
867 if (!seen_dashdash) {
869 for (j = i; j < argc; j++)
870 verify_filename(prefix, argv[j]);
874 paths = get_pathspec(prefix, argv + i);
876 paths = xcalloc(2, sizeof(const char *));
882 return !grep_cache(&opt, paths, cached);
885 die("both --cached and trees are given.");
887 for (i = 0; i < list.nr; i++) {
888 struct object *real_obj;
889 real_obj = deref_tag(list.objects[i].item, NULL, 0);
890 if (grep_object(&opt, paths, real_obj, list.objects[i].name))