Don't build external_grep if its not used
[git] / builtin-grep.c
1 /*
2  * Builtin "git grep"
3  *
4  * Copyright (c) 2006 Junio C Hamano
5  */
6 #include "cache.h"
7 #include "blob.h"
8 #include "tree.h"
9 #include "commit.h"
10 #include "tag.h"
11 #include "tree-walk.h"
12 #include "builtin.h"
13 #include "grep.h"
14
15 /*
16  * git grep pathspecs are somewhat different from diff-tree pathspecs;
17  * pathname wildcards are allowed.
18  */
19 static int pathspec_matches(const char **paths, const char *name)
20 {
21         int namelen, i;
22         if (!paths || !*paths)
23                 return 1;
24         namelen = strlen(name);
25         for (i = 0; paths[i]; i++) {
26                 const char *match = paths[i];
27                 int matchlen = strlen(match);
28                 const char *cp, *meta;
29
30                 if (!matchlen ||
31                     ((matchlen <= namelen) &&
32                      !strncmp(name, match, matchlen) &&
33                      (match[matchlen-1] == '/' ||
34                       name[matchlen] == '\0' || name[matchlen] == '/')))
35                         return 1;
36                 if (!fnmatch(match, name, 0))
37                         return 1;
38                 if (name[namelen-1] != '/')
39                         continue;
40
41                 /* We are being asked if the directory ("name") is worth
42                  * descending into.
43                  *
44                  * Find the longest leading directory name that does
45                  * not have metacharacter in the pathspec; the name
46                  * we are looking at must overlap with that directory.
47                  */
48                 for (cp = match, meta = NULL; cp - match < matchlen; cp++) {
49                         char ch = *cp;
50                         if (ch == '*' || ch == '[' || ch == '?') {
51                                 meta = cp;
52                                 break;
53                         }
54                 }
55                 if (!meta)
56                         meta = cp; /* fully literal */
57
58                 if (namelen <= meta - match) {
59                         /* Looking at "Documentation/" and
60                          * the pattern says "Documentation/howto/", or
61                          * "Documentation/diff*.txt".  The name we
62                          * have should match prefix.
63                          */
64                         if (!memcmp(match, name, namelen))
65                                 return 1;
66                         continue;
67                 }
68
69                 if (meta - match < namelen) {
70                         /* Looking at "Documentation/howto/" and
71                          * the pattern says "Documentation/h*";
72                          * match up to "Do.../h"; this avoids descending
73                          * into "Documentation/technical/".
74                          */
75                         if (!memcmp(match, name, meta - match))
76                                 return 1;
77                         continue;
78                 }
79         }
80         return 0;
81 }
82
83 static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1, const char *name, int tree_name_len)
84 {
85         unsigned long size;
86         char *data;
87         enum object_type type;
88         char *to_free = NULL;
89         int hit;
90
91         data = read_sha1_file(sha1, &type, &size);
92         if (!data) {
93                 error("'%s': unable to read %s", name, sha1_to_hex(sha1));
94                 return 0;
95         }
96         if (opt->relative && opt->prefix_length) {
97                 static char name_buf[PATH_MAX];
98                 char *cp;
99                 int name_len = strlen(name) - opt->prefix_length + 1;
100
101                 if (!tree_name_len)
102                         name += opt->prefix_length;
103                 else {
104                         if (ARRAY_SIZE(name_buf) <= name_len)
105                                 cp = to_free = xmalloc(name_len);
106                         else
107                                 cp = name_buf;
108                         memcpy(cp, name, tree_name_len);
109                         strcpy(cp + tree_name_len,
110                                name + tree_name_len + opt->prefix_length);
111                         name = cp;
112                 }
113         }
114         hit = grep_buffer(opt, name, data, size);
115         free(data);
116         free(to_free);
117         return hit;
118 }
119
120 static int grep_file(struct grep_opt *opt, const char *filename)
121 {
122         struct stat st;
123         int i;
124         char *data;
125         if (lstat(filename, &st) < 0) {
126         err_ret:
127                 if (errno != ENOENT)
128                         error("'%s': %s", filename, strerror(errno));
129                 return 0;
130         }
131         if (!st.st_size)
132                 return 0; /* empty file -- no grep hit */
133         if (!S_ISREG(st.st_mode))
134                 return 0;
135         i = open(filename, O_RDONLY);
136         if (i < 0)
137                 goto err_ret;
138         data = xmalloc(st.st_size + 1);
139         if (st.st_size != read_in_full(i, data, st.st_size)) {
140                 error("'%s': short read %s", filename, strerror(errno));
141                 close(i);
142                 free(data);
143                 return 0;
144         }
145         close(i);
146         if (opt->relative && opt->prefix_length)
147                 filename += opt->prefix_length;
148         i = grep_buffer(opt, filename, data, st.st_size);
149         free(data);
150         return i;
151 }
152
153 #ifdef __unix__
154 static int exec_grep(int argc, const char **argv)
155 {
156         pid_t pid;
157         int status;
158
159         argv[argc] = NULL;
160         pid = fork();
161         if (pid < 0)
162                 return pid;
163         if (!pid) {
164                 execvp("grep", (char **) argv);
165                 exit(255);
166         }
167         while (waitpid(pid, &status, 0) < 0) {
168                 if (errno == EINTR)
169                         continue;
170                 return -1;
171         }
172         if (WIFEXITED(status)) {
173                 if (!WEXITSTATUS(status))
174                         return 1;
175                 return 0;
176         }
177         return -1;
178 }
179
180 #define MAXARGS 1000
181 #define ARGBUF 4096
182 #define push_arg(a) do { \
183         if (nr < MAXARGS) argv[nr++] = (a); \
184         else die("maximum number of args exceeded"); \
185         } while (0)
186
187 static int external_grep(struct grep_opt *opt, const char **paths, int cached)
188 {
189         int i, nr, argc, hit, len, status;
190         const char *argv[MAXARGS+1];
191         char randarg[ARGBUF];
192         char *argptr = randarg;
193         struct grep_pat *p;
194
195         if (opt->extended || (opt->relative && opt->prefix_length))
196                 return -1;
197         len = nr = 0;
198         push_arg("grep");
199         if (opt->fixed)
200                 push_arg("-F");
201         if (opt->linenum)
202                 push_arg("-n");
203         if (!opt->pathname)
204                 push_arg("-h");
205         if (opt->regflags & REG_EXTENDED)
206                 push_arg("-E");
207         if (opt->regflags & REG_ICASE)
208                 push_arg("-i");
209         if (opt->word_regexp)
210                 push_arg("-w");
211         if (opt->name_only)
212                 push_arg("-l");
213         if (opt->unmatch_name_only)
214                 push_arg("-L");
215         if (opt->count)
216                 push_arg("-c");
217         if (opt->post_context || opt->pre_context) {
218                 if (opt->post_context != opt->pre_context) {
219                         if (opt->pre_context) {
220                                 push_arg("-B");
221                                 len += snprintf(argptr, sizeof(randarg)-len,
222                                                 "%u", opt->pre_context);
223                                 if (sizeof(randarg) <= len)
224                                         die("maximum length of args exceeded");
225                                 push_arg(argptr);
226                                 argptr += len;
227                         }
228                         if (opt->post_context) {
229                                 push_arg("-A");
230                                 len += snprintf(argptr, sizeof(randarg)-len,
231                                                 "%u", opt->post_context);
232                                 if (sizeof(randarg) <= len)
233                                         die("maximum length of args exceeded");
234                                 push_arg(argptr);
235                                 argptr += len;
236                         }
237                 }
238                 else {
239                         push_arg("-C");
240                         len += snprintf(argptr, sizeof(randarg)-len,
241                                         "%u", opt->post_context);
242                         if (sizeof(randarg) <= len)
243                                 die("maximum length of args exceeded");
244                         push_arg(argptr);
245                         argptr += len;
246                 }
247         }
248         for (p = opt->pattern_list; p; p = p->next) {
249                 push_arg("-e");
250                 push_arg(p->pattern);
251         }
252
253         /*
254          * To make sure we get the header printed out when we want it,
255          * add /dev/null to the paths to grep.  This is unnecessary
256          * (and wrong) with "-l" or "-L", which always print out the
257          * name anyway.
258          *
259          * GNU grep has "-H", but this is portable.
260          */
261         if (!opt->name_only && !opt->unmatch_name_only)
262                 push_arg("/dev/null");
263
264         hit = 0;
265         argc = nr;
266         for (i = 0; i < active_nr; i++) {
267                 struct cache_entry *ce = active_cache[i];
268                 char *name;
269                 if (!S_ISREG(ntohl(ce->ce_mode)))
270                         continue;
271                 if (!pathspec_matches(paths, ce->name))
272                         continue;
273                 name = ce->name;
274                 if (name[0] == '-') {
275                         int len = ce_namelen(ce);
276                         name = xmalloc(len + 3);
277                         memcpy(name, "./", 2);
278                         memcpy(name + 2, ce->name, len + 1);
279                 }
280                 argv[argc++] = name;
281                 if (argc < MAXARGS && !ce_stage(ce))
282                         continue;
283                 status = exec_grep(argc, argv);
284                 if (0 < status)
285                         hit = 1;
286                 argc = nr;
287                 if (ce_stage(ce)) {
288                         do {
289                                 i++;
290                         } while (i < active_nr &&
291                                  !strcmp(ce->name, active_cache[i]->name));
292                         i--; /* compensate for loop control */
293                 }
294         }
295         if (argc > nr) {
296                 status = exec_grep(argc, argv);
297                 if (0 < status)
298                         hit = 1;
299         }
300         return hit;
301 }
302 #endif
303
304 static int grep_cache(struct grep_opt *opt, const char **paths, int cached)
305 {
306         int hit = 0;
307         int nr;
308         read_cache();
309
310 #ifdef __unix__
311         /*
312          * Use the external "grep" command for the case where
313          * we grep through the checked-out files. It tends to
314          * be a lot more optimized
315          */
316         if (!cached) {
317                 hit = external_grep(opt, paths, cached);
318                 if (hit >= 0)
319                         return hit;
320         }
321 #endif
322
323         for (nr = 0; nr < active_nr; nr++) {
324                 struct cache_entry *ce = active_cache[nr];
325                 if (!S_ISREG(ntohl(ce->ce_mode)))
326                         continue;
327                 if (!pathspec_matches(paths, ce->name))
328                         continue;
329                 if (cached) {
330                         if (ce_stage(ce))
331                                 continue;
332                         hit |= grep_sha1(opt, ce->sha1, ce->name, 0);
333                 }
334                 else
335                         hit |= grep_file(opt, ce->name);
336                 if (ce_stage(ce)) {
337                         do {
338                                 nr++;
339                         } while (nr < active_nr &&
340                                  !strcmp(ce->name, active_cache[nr]->name));
341                         nr--; /* compensate for loop control */
342                 }
343         }
344         free_grep_patterns(opt);
345         return hit;
346 }
347
348 static int grep_tree(struct grep_opt *opt, const char **paths,
349                      struct tree_desc *tree,
350                      const char *tree_name, const char *base)
351 {
352         int len;
353         int hit = 0;
354         struct name_entry entry;
355         char *down;
356         int tn_len = strlen(tree_name);
357         char *path_buf = xmalloc(PATH_MAX + tn_len + 100);
358
359         if (tn_len) {
360                 tn_len = sprintf(path_buf, "%s:", tree_name);
361                 down = path_buf + tn_len;
362                 strcat(down, base);
363         }
364         else {
365                 down = path_buf;
366                 strcpy(down, base);
367         }
368         len = strlen(path_buf);
369
370         while (tree_entry(tree, &entry)) {
371                 strcpy(path_buf + len, entry.path);
372
373                 if (S_ISDIR(entry.mode))
374                         /* Match "abc/" against pathspec to
375                          * decide if we want to descend into "abc"
376                          * directory.
377                          */
378                         strcpy(path_buf + len + entry.pathlen, "/");
379
380                 if (!pathspec_matches(paths, down))
381                         ;
382                 else if (S_ISREG(entry.mode))
383                         hit |= grep_sha1(opt, entry.sha1, path_buf, tn_len);
384                 else if (S_ISDIR(entry.mode)) {
385                         enum object_type type;
386                         struct tree_desc sub;
387                         void *data;
388                         data = read_sha1_file(entry.sha1, &type, &sub.size);
389                         if (!data)
390                                 die("unable to read tree (%s)",
391                                     sha1_to_hex(entry.sha1));
392                         sub.buf = data;
393                         hit |= grep_tree(opt, paths, &sub, tree_name, down);
394                         free(data);
395                 }
396         }
397         return hit;
398 }
399
400 static int grep_object(struct grep_opt *opt, const char **paths,
401                        struct object *obj, const char *name)
402 {
403         if (obj->type == OBJ_BLOB)
404                 return grep_sha1(opt, obj->sha1, name, 0);
405         if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
406                 struct tree_desc tree;
407                 void *data;
408                 int hit;
409                 data = read_object_with_reference(obj->sha1, tree_type,
410                                                   &tree.size, NULL);
411                 if (!data)
412                         die("unable to read tree (%s)", sha1_to_hex(obj->sha1));
413                 tree.buf = data;
414                 hit = grep_tree(opt, paths, &tree, name, "");
415                 free(data);
416                 return hit;
417         }
418         die("unable to grep from object of type %s", typename(obj->type));
419 }
420
421 static const char builtin_grep_usage[] =
422 "git-grep <option>* <rev>* [-e] <pattern> [<path>...]";
423
424 static const char emsg_invalid_context_len[] =
425 "%s: invalid context length argument";
426 static const char emsg_missing_context_len[] =
427 "missing context length argument";
428 static const char emsg_missing_argument[] =
429 "option requires an argument -%s";
430
431 int cmd_grep(int argc, const char **argv, const char *prefix)
432 {
433         int hit = 0;
434         int cached = 0;
435         int seen_dashdash = 0;
436         struct grep_opt opt;
437         struct object_array list = { 0, 0, NULL };
438         const char **paths = NULL;
439         int i;
440
441         memset(&opt, 0, sizeof(opt));
442         opt.prefix_length = (prefix && *prefix) ? strlen(prefix) : 0;
443         opt.relative = 1;
444         opt.pathname = 1;
445         opt.pattern_tail = &opt.pattern_list;
446         opt.regflags = REG_NEWLINE;
447
448         /*
449          * If there is no -- then the paths must exist in the working
450          * tree.  If there is no explicit pattern specified with -e or
451          * -f, we take the first unrecognized non option to be the
452          * pattern, but then what follows it must be zero or more
453          * valid refs up to the -- (if exists), and then existing
454          * paths.  If there is an explicit pattern, then the first
455          * unrecognized non option is the beginning of the refs list
456          * that continues up to the -- (if exists), and then paths.
457          */
458
459         while (1 < argc) {
460                 const char *arg = argv[1];
461                 argc--; argv++;
462                 if (!strcmp("--cached", arg)) {
463                         cached = 1;
464                         continue;
465                 }
466                 if (!strcmp("-a", arg) ||
467                     !strcmp("--text", arg)) {
468                         opt.binary = GREP_BINARY_TEXT;
469                         continue;
470                 }
471                 if (!strcmp("-i", arg) ||
472                     !strcmp("--ignore-case", arg)) {
473                         opt.regflags |= REG_ICASE;
474                         continue;
475                 }
476                 if (!strcmp("-I", arg)) {
477                         opt.binary = GREP_BINARY_NOMATCH;
478                         continue;
479                 }
480                 if (!strcmp("-v", arg) ||
481                     !strcmp("--invert-match", arg)) {
482                         opt.invert = 1;
483                         continue;
484                 }
485                 if (!strcmp("-E", arg) ||
486                     !strcmp("--extended-regexp", arg)) {
487                         opt.regflags |= REG_EXTENDED;
488                         continue;
489                 }
490                 if (!strcmp("-F", arg) ||
491                     !strcmp("--fixed-strings", arg)) {
492                         opt.fixed = 1;
493                         continue;
494                 }
495                 if (!strcmp("-G", arg) ||
496                     !strcmp("--basic-regexp", arg)) {
497                         opt.regflags &= ~REG_EXTENDED;
498                         continue;
499                 }
500                 if (!strcmp("-n", arg)) {
501                         opt.linenum = 1;
502                         continue;
503                 }
504                 if (!strcmp("-h", arg)) {
505                         opt.pathname = 0;
506                         continue;
507                 }
508                 if (!strcmp("-H", arg)) {
509                         opt.pathname = 1;
510                         continue;
511                 }
512                 if (!strcmp("-l", arg) ||
513                     !strcmp("--files-with-matches", arg)) {
514                         opt.name_only = 1;
515                         continue;
516                 }
517                 if (!strcmp("-L", arg) ||
518                     !strcmp("--files-without-match", arg)) {
519                         opt.unmatch_name_only = 1;
520                         continue;
521                 }
522                 if (!strcmp("-c", arg) ||
523                     !strcmp("--count", arg)) {
524                         opt.count = 1;
525                         continue;
526                 }
527                 if (!strcmp("-w", arg) ||
528                     !strcmp("--word-regexp", arg)) {
529                         opt.word_regexp = 1;
530                         continue;
531                 }
532                 if (!prefixcmp(arg, "-A") ||
533                     !prefixcmp(arg, "-B") ||
534                     !prefixcmp(arg, "-C") ||
535                     (arg[0] == '-' && '1' <= arg[1] && arg[1] <= '9')) {
536                         unsigned num;
537                         const char *scan;
538                         switch (arg[1]) {
539                         case 'A': case 'B': case 'C':
540                                 if (!arg[2]) {
541                                         if (argc <= 1)
542                                                 die(emsg_missing_context_len);
543                                         scan = *++argv;
544                                         argc--;
545                                 }
546                                 else
547                                         scan = arg + 2;
548                                 break;
549                         default:
550                                 scan = arg + 1;
551                                 break;
552                         }
553                         if (sscanf(scan, "%u", &num) != 1)
554                                 die(emsg_invalid_context_len, scan);
555                         switch (arg[1]) {
556                         case 'A':
557                                 opt.post_context = num;
558                                 break;
559                         default:
560                         case 'C':
561                                 opt.post_context = num;
562                         case 'B':
563                                 opt.pre_context = num;
564                                 break;
565                         }
566                         continue;
567                 }
568                 if (!strcmp("-f", arg)) {
569                         FILE *patterns;
570                         int lno = 0;
571                         char buf[1024];
572                         if (argc <= 1)
573                                 die(emsg_missing_argument, arg);
574                         patterns = fopen(argv[1], "r");
575                         if (!patterns)
576                                 die("'%s': %s", argv[1], strerror(errno));
577                         while (fgets(buf, sizeof(buf), patterns)) {
578                                 int len = strlen(buf);
579                                 if (buf[len-1] == '\n')
580                                         buf[len-1] = 0;
581                                 /* ignore empty line like grep does */
582                                 if (!buf[0])
583                                         continue;
584                                 append_grep_pattern(&opt, xstrdup(buf),
585                                                     argv[1], ++lno,
586                                                     GREP_PATTERN);
587                         }
588                         fclose(patterns);
589                         argv++;
590                         argc--;
591                         continue;
592                 }
593                 if (!strcmp("--not", arg)) {
594                         append_grep_pattern(&opt, arg, "command line", 0,
595                                             GREP_NOT);
596                         continue;
597                 }
598                 if (!strcmp("--and", arg)) {
599                         append_grep_pattern(&opt, arg, "command line", 0,
600                                             GREP_AND);
601                         continue;
602                 }
603                 if (!strcmp("--or", arg))
604                         continue; /* no-op */
605                 if (!strcmp("(", arg)) {
606                         append_grep_pattern(&opt, arg, "command line", 0,
607                                             GREP_OPEN_PAREN);
608                         continue;
609                 }
610                 if (!strcmp(")", arg)) {
611                         append_grep_pattern(&opt, arg, "command line", 0,
612                                             GREP_CLOSE_PAREN);
613                         continue;
614                 }
615                 if (!strcmp("--all-match", arg)) {
616                         opt.all_match = 1;
617                         continue;
618                 }
619                 if (!strcmp("-e", arg)) {
620                         if (1 < argc) {
621                                 append_grep_pattern(&opt, argv[1],
622                                                     "-e option", 0,
623                                                     GREP_PATTERN);
624                                 argv++;
625                                 argc--;
626                                 continue;
627                         }
628                         die(emsg_missing_argument, arg);
629                 }
630                 if (!strcmp("--full-name", arg)) {
631                         opt.relative = 0;
632                         continue;
633                 }
634                 if (!strcmp("--", arg)) {
635                         /* later processing wants to have this at argv[1] */
636                         argv--;
637                         argc++;
638                         break;
639                 }
640                 if (*arg == '-')
641                         usage(builtin_grep_usage);
642
643                 /* First unrecognized non-option token */
644                 if (!opt.pattern_list) {
645                         append_grep_pattern(&opt, arg, "command line", 0,
646                                             GREP_PATTERN);
647                         break;
648                 }
649                 else {
650                         /* We are looking at the first path or rev;
651                          * it is found at argv[1] after leaving the
652                          * loop.
653                          */
654                         argc++; argv--;
655                         break;
656                 }
657         }
658
659         if (!opt.pattern_list)
660                 die("no pattern given.");
661         if ((opt.regflags != REG_NEWLINE) && opt.fixed)
662                 die("cannot mix --fixed-strings and regexp");
663         compile_grep_patterns(&opt);
664
665         /* Check revs and then paths */
666         for (i = 1; i < argc; i++) {
667                 const char *arg = argv[i];
668                 unsigned char sha1[20];
669                 /* Is it a rev? */
670                 if (!get_sha1(arg, sha1)) {
671                         struct object *object = parse_object(sha1);
672                         if (!object)
673                                 die("bad object %s", arg);
674                         add_object_array(object, arg, &list);
675                         continue;
676                 }
677                 if (!strcmp(arg, "--")) {
678                         i++;
679                         seen_dashdash = 1;
680                 }
681                 break;
682         }
683
684         /* The rest are paths */
685         if (!seen_dashdash) {
686                 int j;
687                 for (j = i; j < argc; j++)
688                         verify_filename(prefix, argv[j]);
689         }
690
691         if (i < argc) {
692                 paths = get_pathspec(prefix, argv + i);
693                 if (opt.prefix_length && opt.relative) {
694                         /* Make sure we do not get outside of paths */
695                         for (i = 0; paths[i]; i++)
696                                 if (strncmp(prefix, paths[i], opt.prefix_length))
697                                         die("git-grep: cannot generate relative filenames containing '..'");
698                 }
699         }
700         else if (prefix) {
701                 paths = xcalloc(2, sizeof(const char *));
702                 paths[0] = prefix;
703                 paths[1] = NULL;
704         }
705
706         if (!list.nr)
707                 return !grep_cache(&opt, paths, cached);
708
709         if (cached)
710                 die("both --cached and trees are given.");
711
712         for (i = 0; i < list.nr; i++) {
713                 struct object *real_obj;
714                 real_obj = deref_tag(list.objects[i].item, NULL, 0);
715                 if (grep_object(&opt, paths, real_obj, list.objects[i].name))
716                         hit = 1;
717         }
718         free_grep_patterns(&opt);
719         return !hit;
720 }