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 "parse-options.h"
14 #include "string-list.h"
15 #include "run-command.h"
16 #include "userdiff.h"
17 #include "grep.h"
18 #include "quote.h"
19 #include "dir.h"
20 #include "thread-utils.h"
22 static char const * const grep_usage[] = {
23 "git grep [options] [-e] <pattern> [<rev>...] [[--] <path>...]",
24 NULL
25 };
27 static int use_threads = 1;
29 #ifndef NO_PTHREADS
30 #define THREADS 8
31 static pthread_t threads[THREADS];
33 static void *load_sha1(const unsigned char *sha1, unsigned long *size,
34 const char *name);
35 static void *load_file(const char *filename, size_t *sz);
37 enum work_type {WORK_SHA1, WORK_FILE};
39 /* We use one producer thread and THREADS consumer
40 * threads. The producer adds struct work_items to 'todo' and the
41 * consumers pick work items from the same array.
42 */
43 struct work_item {
44 enum work_type type;
45 char *name;
47 /* if type == WORK_SHA1, then 'identifier' is a SHA1,
48 * otherwise type == WORK_FILE, and 'identifier' is a NUL
49 * terminated filename.
50 */
51 void *identifier;
52 char done;
53 struct strbuf out;
54 };
56 /* In the range [todo_done, todo_start) in 'todo' we have work_items
57 * that have been or are processed by a consumer thread. We haven't
58 * written the result for these to stdout yet.
59 *
60 * The work_items in [todo_start, todo_end) are waiting to be picked
61 * up by a consumer thread.
62 *
63 * The ranges are modulo TODO_SIZE.
64 */
65 #define TODO_SIZE 128
66 static struct work_item todo[TODO_SIZE];
67 static int todo_start;
68 static int todo_end;
69 static int todo_done;
71 /* Has all work items been added? */
72 static int all_work_added;
74 /* This lock protects all the variables above. */
75 static pthread_mutex_t grep_mutex;
77 /* Used to serialize calls to read_sha1_file. */
78 static pthread_mutex_t read_sha1_mutex;
80 #define WHEN_THREADED(x) do { if (use_threads) (x); } while (0)
81 #define grep_lock() WHEN_THREADED(pthread_mutex_lock(&grep_mutex))
82 #define grep_unlock() WHEN_THREADED(pthread_mutex_unlock(&grep_mutex))
83 #define read_sha1_lock() WHEN_THREADED(pthread_mutex_lock(&read_sha1_mutex))
84 #define read_sha1_unlock() WHEN_THREADED(pthread_mutex_unlock(&read_sha1_mutex))
86 /* Signalled when a new work_item is added to todo. */
87 static pthread_cond_t cond_add;
89 /* Signalled when the result from one work_item is written to
90 * stdout.
91 */
92 static pthread_cond_t cond_write;
94 /* Signalled when we are finished with everything. */
95 static pthread_cond_t cond_result;
97 static int skip_first_line;
99 static void add_work(enum work_type type, char *name, void *id)
100 {
101 grep_lock();
103 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
104 pthread_cond_wait(&cond_write, &grep_mutex);
105 }
107 todo[todo_end].type = type;
108 todo[todo_end].name = name;
109 todo[todo_end].identifier = id;
110 todo[todo_end].done = 0;
111 strbuf_reset(&todo[todo_end].out);
112 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
114 pthread_cond_signal(&cond_add);
115 grep_unlock();
116 }
118 static struct work_item *get_work(void)
119 {
120 struct work_item *ret;
122 grep_lock();
123 while (todo_start == todo_end && !all_work_added) {
124 pthread_cond_wait(&cond_add, &grep_mutex);
125 }
127 if (todo_start == todo_end && all_work_added) {
128 ret = NULL;
129 } else {
130 ret = &todo[todo_start];
131 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
132 }
133 grep_unlock();
134 return ret;
135 }
137 static void grep_sha1_async(struct grep_opt *opt, char *name,
138 const unsigned char *sha1)
139 {
140 unsigned char *s;
141 s = xmalloc(20);
142 memcpy(s, sha1, 20);
143 add_work(WORK_SHA1, name, s);
144 }
146 static void grep_file_async(struct grep_opt *opt, char *name,
147 const char *filename)
148 {
149 add_work(WORK_FILE, name, xstrdup(filename));
150 }
152 static void work_done(struct work_item *w)
153 {
154 int old_done;
156 grep_lock();
157 w->done = 1;
158 old_done = todo_done;
159 for(; todo[todo_done].done && todo_done != todo_start;
160 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
161 w = &todo[todo_done];
162 if (w->out.len) {
163 const char *p = w->out.buf;
164 size_t len = w->out.len;
166 /* Skip the leading hunk mark of the first file. */
167 if (skip_first_line) {
168 while (len) {
169 len--;
170 if (*p++ == '\n')
171 break;
172 }
173 skip_first_line = 0;
174 }
176 write_or_die(1, p, len);
177 }
178 free(w->name);
179 free(w->identifier);
180 }
182 if (old_done != todo_done)
183 pthread_cond_signal(&cond_write);
185 if (all_work_added && todo_done == todo_end)
186 pthread_cond_signal(&cond_result);
188 grep_unlock();
189 }
191 static void *run(void *arg)
192 {
193 int hit = 0;
194 struct grep_opt *opt = arg;
196 while (1) {
197 struct work_item *w = get_work();
198 if (!w)
199 break;
201 opt->output_priv = w;
202 if (w->type == WORK_SHA1) {
203 unsigned long sz;
204 void* data = load_sha1(w->identifier, &sz, w->name);
206 if (data) {
207 hit |= grep_buffer(opt, w->name, data, sz);
208 free(data);
209 }
210 } else if (w->type == WORK_FILE) {
211 size_t sz;
212 void* data = load_file(w->identifier, &sz);
213 if (data) {
214 hit |= grep_buffer(opt, w->name, data, sz);
215 free(data);
216 }
217 } else {
218 assert(0);
219 }
221 work_done(w);
222 }
223 free_grep_patterns(arg);
224 free(arg);
226 return (void*) (intptr_t) hit;
227 }
229 static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
230 {
231 struct work_item *w = opt->output_priv;
232 strbuf_add(&w->out, buf, size);
233 }
235 static void start_threads(struct grep_opt *opt)
236 {
237 int i;
239 pthread_mutex_init(&grep_mutex, NULL);
240 pthread_mutex_init(&read_sha1_mutex, NULL);
241 pthread_cond_init(&cond_add, NULL);
242 pthread_cond_init(&cond_write, NULL);
243 pthread_cond_init(&cond_result, NULL);
245 for (i = 0; i < ARRAY_SIZE(todo); i++) {
246 strbuf_init(&todo[i].out, 0);
247 }
249 for (i = 0; i < ARRAY_SIZE(threads); i++) {
250 int err;
251 struct grep_opt *o = grep_opt_dup(opt);
252 o->output = strbuf_out;
253 compile_grep_patterns(o);
254 err = pthread_create(&threads[i], NULL, run, o);
256 if (err)
257 die(_("grep: failed to create thread: %s"),
258 strerror(err));
259 }
260 }
262 static int wait_all(void)
263 {
264 int hit = 0;
265 int i;
267 grep_lock();
268 all_work_added = 1;
270 /* Wait until all work is done. */
271 while (todo_done != todo_end)
272 pthread_cond_wait(&cond_result, &grep_mutex);
274 /* Wake up all the consumer threads so they can see that there
275 * is no more work to do.
276 */
277 pthread_cond_broadcast(&cond_add);
278 grep_unlock();
280 for (i = 0; i < ARRAY_SIZE(threads); i++) {
281 void *h;
282 pthread_join(threads[i], &h);
283 hit |= (int) (intptr_t) h;
284 }
286 pthread_mutex_destroy(&grep_mutex);
287 pthread_mutex_destroy(&read_sha1_mutex);
288 pthread_cond_destroy(&cond_add);
289 pthread_cond_destroy(&cond_write);
290 pthread_cond_destroy(&cond_result);
292 return hit;
293 }
294 #else /* !NO_PTHREADS */
295 #define read_sha1_lock()
296 #define read_sha1_unlock()
298 static int wait_all(void)
299 {
300 return 0;
301 }
302 #endif
304 static int grep_config(const char *var, const char *value, void *cb)
305 {
306 struct grep_opt *opt = cb;
307 char *color = NULL;
309 switch (userdiff_config(var, value)) {
310 case 0: break;
311 case -1: return -1;
312 default: return 0;
313 }
315 if (!strcmp(var, "grep.extendedregexp")) {
316 if (git_config_bool(var, value))
317 opt->regflags |= REG_EXTENDED;
318 else
319 opt->regflags &= ~REG_EXTENDED;
320 return 0;
321 }
323 if (!strcmp(var, "grep.linenumber")) {
324 opt->linenum = git_config_bool(var, value);
325 return 0;
326 }
328 if (!strcmp(var, "color.grep"))
329 opt->color = git_config_colorbool(var, value);
330 else if (!strcmp(var, "color.grep.context"))
331 color = opt->color_context;
332 else if (!strcmp(var, "color.grep.filename"))
333 color = opt->color_filename;
334 else if (!strcmp(var, "color.grep.function"))
335 color = opt->color_function;
336 else if (!strcmp(var, "color.grep.linenumber"))
337 color = opt->color_lineno;
338 else if (!strcmp(var, "color.grep.match"))
339 color = opt->color_match;
340 else if (!strcmp(var, "color.grep.selected"))
341 color = opt->color_selected;
342 else if (!strcmp(var, "color.grep.separator"))
343 color = opt->color_sep;
344 else
345 return git_color_default_config(var, value, cb);
346 if (color) {
347 if (!value)
348 return config_error_nonbool(var);
349 color_parse(value, var, color);
350 }
351 return 0;
352 }
354 static void *lock_and_read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
355 {
356 void *data;
358 if (use_threads) {
359 read_sha1_lock();
360 data = read_sha1_file(sha1, type, size);
361 read_sha1_unlock();
362 } else {
363 data = read_sha1_file(sha1, type, size);
364 }
365 return data;
366 }
368 static void *load_sha1(const unsigned char *sha1, unsigned long *size,
369 const char *name)
370 {
371 enum object_type type;
372 void *data = lock_and_read_sha1_file(sha1, &type, size);
374 if (!data)
375 error(_("'%s': unable to read %s"), name, sha1_to_hex(sha1));
377 return data;
378 }
380 static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1,
381 const char *filename, int tree_name_len)
382 {
383 struct strbuf pathbuf = STRBUF_INIT;
384 char *name;
386 if (opt->relative && opt->prefix_length) {
387 quote_path_relative(filename + tree_name_len, -1, &pathbuf,
388 opt->prefix);
389 strbuf_insert(&pathbuf, 0, filename, tree_name_len);
390 } else {
391 strbuf_addstr(&pathbuf, filename);
392 }
394 name = strbuf_detach(&pathbuf, NULL);
396 #ifndef NO_PTHREADS
397 if (use_threads) {
398 grep_sha1_async(opt, name, sha1);
399 return 0;
400 } else
401 #endif
402 {
403 int hit;
404 unsigned long sz;
405 void *data = load_sha1(sha1, &sz, name);
406 if (!data)
407 hit = 0;
408 else
409 hit = grep_buffer(opt, name, data, sz);
411 free(data);
412 free(name);
413 return hit;
414 }
415 }
417 static void *load_file(const char *filename, size_t *sz)
418 {
419 struct stat st;
420 char *data;
421 int i;
423 if (lstat(filename, &st) < 0) {
424 err_ret:
425 if (errno != ENOENT)
426 error(_("'%s': %s"), filename, strerror(errno));
427 return NULL;
428 }
429 if (!S_ISREG(st.st_mode))
430 return NULL;
431 *sz = xsize_t(st.st_size);
432 i = open(filename, O_RDONLY);
433 if (i < 0)
434 goto err_ret;
435 data = xmalloc(*sz + 1);
436 if (st.st_size != read_in_full(i, data, *sz)) {
437 error(_("'%s': short read %s"), filename, strerror(errno));
438 close(i);
439 free(data);
440 return NULL;
441 }
442 close(i);
443 data[*sz] = 0;
444 return data;
445 }
447 static int grep_file(struct grep_opt *opt, const char *filename)
448 {
449 struct strbuf buf = STRBUF_INIT;
450 char *name;
452 if (opt->relative && opt->prefix_length)
453 quote_path_relative(filename, -1, &buf, opt->prefix);
454 else
455 strbuf_addstr(&buf, filename);
456 name = strbuf_detach(&buf, NULL);
458 #ifndef NO_PTHREADS
459 if (use_threads) {
460 grep_file_async(opt, name, filename);
461 return 0;
462 } else
463 #endif
464 {
465 int hit;
466 size_t sz;
467 void *data = load_file(filename, &sz);
468 if (!data)
469 hit = 0;
470 else
471 hit = grep_buffer(opt, name, data, sz);
473 free(data);
474 free(name);
475 return hit;
476 }
477 }
479 static void append_path(struct grep_opt *opt, const void *data, size_t len)
480 {
481 struct string_list *path_list = opt->output_priv;
483 if (len == 1 && *(const char *)data == '\0')
484 return;
485 string_list_append(path_list, xstrndup(data, len));
486 }
488 static void run_pager(struct grep_opt *opt, const char *prefix)
489 {
490 struct string_list *path_list = opt->output_priv;
491 const char **argv = xmalloc(sizeof(const char *) * (path_list->nr + 1));
492 int i, status;
494 for (i = 0; i < path_list->nr; i++)
495 argv[i] = path_list->items[i].string;
496 argv[path_list->nr] = NULL;
498 if (prefix && chdir(prefix))
499 die(_("Failed to chdir: %s"), prefix);
500 status = run_command_v_opt(argv, RUN_USING_SHELL);
501 if (status)
502 exit(status);
503 free(argv);
504 }
506 static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec, int cached)
507 {
508 int hit = 0;
509 int nr;
510 read_cache();
512 for (nr = 0; nr < active_nr; nr++) {
513 struct cache_entry *ce = active_cache[nr];
514 if (!S_ISREG(ce->ce_mode))
515 continue;
516 if (!match_pathspec_depth(pathspec, ce->name, ce_namelen(ce), 0, NULL))
517 continue;
518 /*
519 * If CE_VALID is on, we assume worktree file and its cache entry
520 * are identical, even if worktree file has been modified, so use
521 * cache version instead
522 */
523 if (cached || (ce->ce_flags & CE_VALID) || ce_skip_worktree(ce)) {
524 if (ce_stage(ce))
525 continue;
526 hit |= grep_sha1(opt, ce->sha1, ce->name, 0);
527 }
528 else
529 hit |= grep_file(opt, ce->name);
530 if (ce_stage(ce)) {
531 do {
532 nr++;
533 } while (nr < active_nr &&
534 !strcmp(ce->name, active_cache[nr]->name));
535 nr--; /* compensate for loop control */
536 }
537 if (hit && opt->status_only)
538 break;
539 }
540 return hit;
541 }
543 static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
544 struct tree_desc *tree, struct strbuf *base, int tn_len)
545 {
546 int hit = 0, match = 0;
547 struct name_entry entry;
548 int old_baselen = base->len;
550 while (tree_entry(tree, &entry)) {
551 int te_len = tree_entry_len(entry.path, entry.sha1);
553 if (match != 2) {
554 match = tree_entry_interesting(&entry, base, tn_len, pathspec);
555 if (match < 0)
556 break;
557 if (match == 0)
558 continue;
559 }
561 strbuf_add(base, entry.path, te_len);
563 if (S_ISREG(entry.mode)) {
564 hit |= grep_sha1(opt, entry.sha1, base->buf, tn_len);
565 }
566 else if (S_ISDIR(entry.mode)) {
567 enum object_type type;
568 struct tree_desc sub;
569 void *data;
570 unsigned long size;
572 data = lock_and_read_sha1_file(entry.sha1, &type, &size);
573 if (!data)
574 die(_("unable to read tree (%s)"),
575 sha1_to_hex(entry.sha1));
577 strbuf_addch(base, '/');
578 init_tree_desc(&sub, data, size);
579 hit |= grep_tree(opt, pathspec, &sub, base, tn_len);
580 free(data);
581 }
582 strbuf_setlen(base, old_baselen);
584 if (hit && opt->status_only)
585 break;
586 }
587 return hit;
588 }
590 static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
591 struct object *obj, const char *name)
592 {
593 if (obj->type == OBJ_BLOB)
594 return grep_sha1(opt, obj->sha1, name, 0);
595 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
596 struct tree_desc tree;
597 void *data;
598 unsigned long size;
599 struct strbuf base;
600 int hit, len;
602 read_sha1_lock();
603 data = read_object_with_reference(obj->sha1, tree_type,
604 &size, NULL);
605 read_sha1_unlock();
607 if (!data)
608 die(_("unable to read tree (%s)"), sha1_to_hex(obj->sha1));
610 len = name ? strlen(name) : 0;
611 strbuf_init(&base, PATH_MAX + len + 1);
612 if (len) {
613 strbuf_add(&base, name, len);
614 strbuf_addch(&base, ':');
615 }
616 init_tree_desc(&tree, data, size);
617 hit = grep_tree(opt, pathspec, &tree, &base, base.len);
618 strbuf_release(&base);
619 free(data);
620 return hit;
621 }
622 die(_("unable to grep from object of type %s"), typename(obj->type));
623 }
625 static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
626 const struct object_array *list)
627 {
628 unsigned int i;
629 int hit = 0;
630 const unsigned int nr = list->nr;
632 for (i = 0; i < nr; i++) {
633 struct object *real_obj;
634 real_obj = deref_tag(list->objects[i].item, NULL, 0);
635 if (grep_object(opt, pathspec, real_obj, list->objects[i].name)) {
636 hit = 1;
637 if (opt->status_only)
638 break;
639 }
640 }
641 return hit;
642 }
644 static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
645 int exc_std)
646 {
647 struct dir_struct dir;
648 int i, hit = 0;
650 memset(&dir, 0, sizeof(dir));
651 if (exc_std)
652 setup_standard_excludes(&dir);
654 fill_directory(&dir, pathspec->raw);
655 for (i = 0; i < dir.nr; i++) {
656 const char *name = dir.entries[i]->name;
657 int namelen = strlen(name);
658 if (!match_pathspec_depth(pathspec, name, namelen, 0, NULL))
659 continue;
660 hit |= grep_file(opt, dir.entries[i]->name);
661 if (hit && opt->status_only)
662 break;
663 }
664 return hit;
665 }
667 static int context_callback(const struct option *opt, const char *arg,
668 int unset)
669 {
670 struct grep_opt *grep_opt = opt->value;
671 int value;
672 const char *endp;
674 if (unset) {
675 grep_opt->pre_context = grep_opt->post_context = 0;
676 return 0;
677 }
678 value = strtol(arg, (char **)&endp, 10);
679 if (*endp) {
680 return error(_("switch `%c' expects a numerical value"),
681 opt->short_name);
682 }
683 grep_opt->pre_context = grep_opt->post_context = value;
684 return 0;
685 }
687 static int file_callback(const struct option *opt, const char *arg, int unset)
688 {
689 struct grep_opt *grep_opt = opt->value;
690 int from_stdin = !strcmp(arg, "-");
691 FILE *patterns;
692 int lno = 0;
693 struct strbuf sb = STRBUF_INIT;
695 patterns = from_stdin ? stdin : fopen(arg, "r");
696 if (!patterns)
697 die_errno(_("cannot open '%s'"), arg);
698 while (strbuf_getline(&sb, patterns, '\n') == 0) {
699 char *s;
700 size_t len;
702 /* ignore empty line like grep does */
703 if (sb.len == 0)
704 continue;
706 s = strbuf_detach(&sb, &len);
707 append_grep_pat(grep_opt, s, len, arg, ++lno, GREP_PATTERN);
708 }
709 if (!from_stdin)
710 fclose(patterns);
711 strbuf_release(&sb);
712 return 0;
713 }
715 static int not_callback(const struct option *opt, const char *arg, int unset)
716 {
717 struct grep_opt *grep_opt = opt->value;
718 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
719 return 0;
720 }
722 static int and_callback(const struct option *opt, const char *arg, int unset)
723 {
724 struct grep_opt *grep_opt = opt->value;
725 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
726 return 0;
727 }
729 static int open_callback(const struct option *opt, const char *arg, int unset)
730 {
731 struct grep_opt *grep_opt = opt->value;
732 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
733 return 0;
734 }
736 static int close_callback(const struct option *opt, const char *arg, int unset)
737 {
738 struct grep_opt *grep_opt = opt->value;
739 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
740 return 0;
741 }
743 static int pattern_callback(const struct option *opt, const char *arg,
744 int unset)
745 {
746 struct grep_opt *grep_opt = opt->value;
747 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
748 return 0;
749 }
751 static int help_callback(const struct option *opt, const char *arg, int unset)
752 {
753 return -1;
754 }
756 int cmd_grep(int argc, const char **argv, const char *prefix)
757 {
758 int hit = 0;
759 int cached = 0, untracked = 0, opt_exclude = -1;
760 int seen_dashdash = 0;
761 int external_grep_allowed__ignored;
762 const char *show_in_pager = NULL, *default_pager = "dummy";
763 struct grep_opt opt;
764 struct object_array list = OBJECT_ARRAY_INIT;
765 const char **paths = NULL;
766 struct pathspec pathspec;
767 struct string_list path_list = STRING_LIST_INIT_NODUP;
768 int i;
769 int dummy;
770 int use_index = 1;
771 enum {
772 pattern_type_unspecified = 0,
773 pattern_type_bre,
774 pattern_type_ere,
775 pattern_type_fixed,
776 pattern_type_pcre,
777 };
778 int pattern_type = pattern_type_unspecified;
780 struct option options[] = {
781 OPT_BOOLEAN(0, "cached", &cached,
782 "search in index instead of in the work tree"),
783 { OPTION_BOOLEAN, 0, "index", &use_index, NULL,
784 "finds in contents not managed by git",
785 PARSE_OPT_NOARG | PARSE_OPT_NEGHELP },
786 OPT_BOOLEAN(0, "untracked", &untracked,
787 "search in both tracked and untracked files"),
788 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
789 "search also in ignored files", 1),
790 OPT_GROUP(""),
791 OPT_BOOLEAN('v', "invert-match", &opt.invert,
792 "show non-matching lines"),
793 OPT_BOOLEAN('i', "ignore-case", &opt.ignore_case,
794 "case insensitive matching"),
795 OPT_BOOLEAN('w', "word-regexp", &opt.word_regexp,
796 "match patterns only at word boundaries"),
797 OPT_SET_INT('a', "text", &opt.binary,
798 "process binary files as text", GREP_BINARY_TEXT),
799 OPT_SET_INT('I', NULL, &opt.binary,
800 "don't match patterns in binary files",
801 GREP_BINARY_NOMATCH),
802 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, "depth",
803 "descend at most <depth> levels", PARSE_OPT_NONEG,
804 NULL, 1 },
805 OPT_GROUP(""),
806 OPT_SET_INT('E', "extended-regexp", &pattern_type,
807 "use extended POSIX regular expressions",
808 pattern_type_ere),
809 OPT_SET_INT('G', "basic-regexp", &pattern_type,
810 "use basic POSIX regular expressions (default)",
811 pattern_type_bre),
812 OPT_SET_INT('F', "fixed-strings", &pattern_type,
813 "interpret patterns as fixed strings",
814 pattern_type_fixed),
815 OPT_SET_INT('P', "perl-regexp", &pattern_type,
816 "use Perl-compatible regular expressions",
817 pattern_type_pcre),
818 OPT_GROUP(""),
819 OPT_BOOLEAN('n', "line-number", &opt.linenum, "show line numbers"),
820 OPT_NEGBIT('h', NULL, &opt.pathname, "don't show filenames", 1),
821 OPT_BIT('H', NULL, &opt.pathname, "show filenames", 1),
822 OPT_NEGBIT(0, "full-name", &opt.relative,
823 "show filenames relative to top directory", 1),
824 OPT_BOOLEAN('l', "files-with-matches", &opt.name_only,
825 "show only filenames instead of matching lines"),
826 OPT_BOOLEAN(0, "name-only", &opt.name_only,
827 "synonym for --files-with-matches"),
828 OPT_BOOLEAN('L', "files-without-match",
829 &opt.unmatch_name_only,
830 "show only the names of files without match"),
831 OPT_BOOLEAN('z', "null", &opt.null_following_name,
832 "print NUL after filenames"),
833 OPT_BOOLEAN('c', "count", &opt.count,
834 "show the number of matches instead of matching lines"),
835 OPT__COLOR(&opt.color, "highlight matches"),
836 OPT_BOOLEAN(0, "break", &opt.file_break,
837 "print empty line between matches from different files"),
838 OPT_BOOLEAN(0, "heading", &opt.heading,
839 "show filename only once above matches from same file"),
840 OPT_GROUP(""),
841 OPT_CALLBACK('C', "context", &opt, "n",
842 "show <n> context lines before and after matches",
843 context_callback),
844 OPT_INTEGER('B', "before-context", &opt.pre_context,
845 "show <n> context lines before matches"),
846 OPT_INTEGER('A', "after-context", &opt.post_context,
847 "show <n> context lines after matches"),
848 OPT_NUMBER_CALLBACK(&opt, "shortcut for -C NUM",
849 context_callback),
850 OPT_BOOLEAN('p', "show-function", &opt.funcname,
851 "show a line with the function name before matches"),
852 OPT_BOOLEAN('W', "function-context", &opt.funcbody,
853 "show the surrounding function"),
854 OPT_GROUP(""),
855 OPT_CALLBACK('f', NULL, &opt, "file",
856 "read patterns from file", file_callback),
857 { OPTION_CALLBACK, 'e', NULL, &opt, "pattern",
858 "match <pattern>", PARSE_OPT_NONEG, pattern_callback },
859 { OPTION_CALLBACK, 0, "and", &opt, NULL,
860 "combine patterns specified with -e",
861 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
862 OPT_BOOLEAN(0, "or", &dummy, ""),
863 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
864 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
865 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
866 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
867 open_callback },
868 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
869 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
870 close_callback },
871 OPT__QUIET(&opt.status_only,
872 "indicate hit with exit status without output"),
873 OPT_BOOLEAN(0, "all-match", &opt.all_match,
874 "show only matches from files that match all patterns"),
875 OPT_GROUP(""),
876 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
877 "pager", "show matching files in the pager",
878 PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
879 OPT_BOOLEAN(0, "ext-grep", &external_grep_allowed__ignored,
880 "allow calling of grep(1) (ignored by this build)"),
881 { OPTION_CALLBACK, 0, "help-all", &options, NULL, "show usage",
882 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
883 OPT_END()
884 };
886 /*
887 * 'git grep -h', unlike 'git grep -h <pattern>', is a request
888 * to show usage information and exit.
889 */
890 if (argc == 2 && !strcmp(argv[1], "-h"))
891 usage_with_options(grep_usage, options);
893 memset(&opt, 0, sizeof(opt));
894 opt.prefix = prefix;
895 opt.prefix_length = (prefix && *prefix) ? strlen(prefix) : 0;
896 opt.relative = 1;
897 opt.pathname = 1;
898 opt.pattern_tail = &opt.pattern_list;
899 opt.header_tail = &opt.header_list;
900 opt.regflags = REG_NEWLINE;
901 opt.max_depth = -1;
903 strcpy(opt.color_context, "");
904 strcpy(opt.color_filename, "");
905 strcpy(opt.color_function, "");
906 strcpy(opt.color_lineno, "");
907 strcpy(opt.color_match, GIT_COLOR_BOLD_RED);
908 strcpy(opt.color_selected, "");
909 strcpy(opt.color_sep, GIT_COLOR_CYAN);
910 opt.color = -1;
911 git_config(grep_config, &opt);
913 /*
914 * If there is no -- then the paths must exist in the working
915 * tree. If there is no explicit pattern specified with -e or
916 * -f, we take the first unrecognized non option to be the
917 * pattern, but then what follows it must be zero or more
918 * valid refs up to the -- (if exists), and then existing
919 * paths. If there is an explicit pattern, then the first
920 * unrecognized non option is the beginning of the refs list
921 * that continues up to the -- (if exists), and then paths.
922 */
923 argc = parse_options(argc, argv, prefix, options, grep_usage,
924 PARSE_OPT_KEEP_DASHDASH |
925 PARSE_OPT_STOP_AT_NON_OPTION |
926 PARSE_OPT_NO_INTERNAL_HELP);
927 switch (pattern_type) {
928 case pattern_type_fixed:
929 opt.fixed = 1;
930 opt.pcre = 0;
931 break;
932 case pattern_type_bre:
933 opt.fixed = 0;
934 opt.pcre = 0;
935 opt.regflags &= ~REG_EXTENDED;
936 break;
937 case pattern_type_ere:
938 opt.fixed = 0;
939 opt.pcre = 0;
940 opt.regflags |= REG_EXTENDED;
941 break;
942 case pattern_type_pcre:
943 opt.fixed = 0;
944 opt.pcre = 1;
945 break;
946 default:
947 break; /* nothing */
948 }
950 if (use_index && !startup_info->have_repository)
951 /* die the same way as if we did it at the beginning */
952 setup_git_directory();
954 /*
955 * skip a -- separator; we know it cannot be
956 * separating revisions from pathnames if
957 * we haven't even had any patterns yet
958 */
959 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
960 argv++;
961 argc--;
962 }
964 /* First unrecognized non-option token */
965 if (argc > 0 && !opt.pattern_list) {
966 append_grep_pattern(&opt, argv[0], "command line", 0,
967 GREP_PATTERN);
968 argv++;
969 argc--;
970 }
972 if (show_in_pager == default_pager)
973 show_in_pager = git_pager(1);
974 if (show_in_pager) {
975 opt.color = 0;
976 opt.name_only = 1;
977 opt.null_following_name = 1;
978 opt.output_priv = &path_list;
979 opt.output = append_path;
980 string_list_append(&path_list, show_in_pager);
981 use_threads = 0;
982 }
984 if (!opt.pattern_list)
985 die(_("no pattern given."));
986 if (!opt.fixed && opt.ignore_case)
987 opt.regflags |= REG_ICASE;
989 #ifndef NO_PTHREADS
990 if (online_cpus() == 1 || !grep_threads_ok(&opt))
991 use_threads = 0;
993 if (use_threads) {
994 if (opt.pre_context || opt.post_context || opt.file_break ||
995 opt.funcbody)
996 skip_first_line = 1;
997 start_threads(&opt);
998 }
999 #else
1000 use_threads = 0;
1001 #endif
1003 compile_grep_patterns(&opt);
1005 /* Check revs and then paths */
1006 for (i = 0; i < argc; i++) {
1007 const char *arg = argv[i];
1008 unsigned char sha1[20];
1009 /* Is it a rev? */
1010 if (!get_sha1(arg, sha1)) {
1011 struct object *object = parse_object(sha1);
1012 if (!object)
1013 die(_("bad object %s"), arg);
1014 add_object_array(object, arg, &list);
1015 continue;
1016 }
1017 if (!strcmp(arg, "--")) {
1018 i++;
1019 seen_dashdash = 1;
1020 }
1021 break;
1022 }
1024 /* The rest are paths */
1025 if (!seen_dashdash) {
1026 int j;
1027 for (j = i; j < argc; j++)
1028 verify_filename(prefix, argv[j]);
1029 }
1031 paths = get_pathspec(prefix, argv + i);
1032 init_pathspec(&pathspec, paths);
1033 pathspec.max_depth = opt.max_depth;
1034 pathspec.recursive = 1;
1036 if (show_in_pager && (cached || list.nr))
1037 die(_("--open-files-in-pager only works on the worktree"));
1039 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
1040 const char *pager = path_list.items[0].string;
1041 int len = strlen(pager);
1043 if (len > 4 && is_dir_sep(pager[len - 5]))
1044 pager += len - 4;
1046 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
1047 struct strbuf buf = STRBUF_INIT;
1048 strbuf_addf(&buf, "+/%s%s",
1049 strcmp("less", pager) ? "" : "*",
1050 opt.pattern_list->pattern);
1051 string_list_append(&path_list, buf.buf);
1052 strbuf_detach(&buf, NULL);
1053 }
1054 }
1056 if (!show_in_pager)
1057 setup_pager();
1059 if (!use_index && (untracked || cached))
1060 die(_("--cached or --untracked cannot be used with --no-index."));
1062 if (!use_index || untracked) {
1063 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
1064 if (list.nr)
1065 die(_("--no-index or --untracked cannot be used with revs."));
1066 hit = grep_directory(&opt, &pathspec, use_exclude);
1067 } else if (0 <= opt_exclude) {
1068 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1069 } else if (!list.nr) {
1070 if (!cached)
1071 setup_work_tree();
1073 hit = grep_cache(&opt, &pathspec, cached);
1074 } else {
1075 if (cached)
1076 die(_("both --cached and trees are given."));
1077 hit = grep_objects(&opt, &pathspec, &list);
1078 }
1080 if (use_threads)
1081 hit |= wait_all();
1082 if (hit && show_in_pager)
1083 run_pager(&opt, prefix);
1084 free_grep_patterns(&opt);
1085 return !hit;
1086 }