grep: slight refactoring to the code that disables threading
[git/git.git] / builtin / grep.c
CommitLineData
5010cb5f
JH
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"
1362671f 11#include "tree-walk.h"
5010cb5f 12#include "builtin.h"
3e230fa1 13#include "parse-options.h"
678e484b
JS
14#include "string-list.h"
15#include "run-command.h"
60ecac98 16#include "userdiff.h"
83b5d2f5 17#include "grep.h"
493b7a08 18#include "quote.h"
59332d13 19#include "dir.h"
64acde94 20#include "pathspec.h"
5b594f45 21
3e230fa1 22static char const * const grep_usage[] = {
9c9b4f2f 23 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
3e230fa1
RS
24 NULL
25};
26
5b594f45
FK
27static int use_threads = 1;
28
29#ifndef NO_PTHREADS
30#define THREADS 8
31static pthread_t threads[THREADS];
32
5b594f45
FK
33/* We use one producer thread and THREADS consumer
34 * threads. The producer adds struct work_items to 'todo' and the
35 * consumers pick work items from the same array.
36 */
9cba13ca 37struct work_item {
8f24a632 38 struct grep_source source;
5b594f45
FK
39 char done;
40 struct strbuf out;
41};
42
43/* In the range [todo_done, todo_start) in 'todo' we have work_items
44 * that have been or are processed by a consumer thread. We haven't
45 * written the result for these to stdout yet.
46 *
47 * The work_items in [todo_start, todo_end) are waiting to be picked
48 * up by a consumer thread.
49 *
50 * The ranges are modulo TODO_SIZE.
51 */
52#define TODO_SIZE 128
53static struct work_item todo[TODO_SIZE];
54static int todo_start;
55static int todo_end;
56static int todo_done;
57
58/* Has all work items been added? */
59static int all_work_added;
60
61/* This lock protects all the variables above. */
62static pthread_mutex_t grep_mutex;
63
1487a12b
JH
64static inline void grep_lock(void)
65{
66 if (use_threads)
67 pthread_mutex_lock(&grep_mutex);
68}
69
70static inline void grep_unlock(void)
71{
72 if (use_threads)
73 pthread_mutex_unlock(&grep_mutex);
74}
75
5b594f45
FK
76/* Signalled when a new work_item is added to todo. */
77static pthread_cond_t cond_add;
78
79/* Signalled when the result from one work_item is written to
80 * stdout.
81 */
82static pthread_cond_t cond_write;
83
84/* Signalled when we are finished with everything. */
85static pthread_cond_t cond_result;
86
08303c36 87static int skip_first_line;
431d6e7b 88
9dd5245c 89static void add_work(struct grep_opt *opt, enum grep_source_type type,
55c61688 90 const char *name, const char *path, const void *id)
5b594f45
FK
91{
92 grep_lock();
93
94 while ((todo_end+1) % ARRAY_SIZE(todo) == todo_done) {
95 pthread_cond_wait(&cond_write, &grep_mutex);
96 }
97
55c61688 98 grep_source_init(&todo[todo_end].source, type, name, path, id);
9dd5245c
JK
99 if (opt->binary != GREP_BINARY_TEXT)
100 grep_source_load_driver(&todo[todo_end].source);
5b594f45
FK
101 todo[todo_end].done = 0;
102 strbuf_reset(&todo[todo_end].out);
103 todo_end = (todo_end + 1) % ARRAY_SIZE(todo);
104
105 pthread_cond_signal(&cond_add);
106 grep_unlock();
107}
108
109static struct work_item *get_work(void)
110{
111 struct work_item *ret;
112
113 grep_lock();
114 while (todo_start == todo_end && !all_work_added) {
115 pthread_cond_wait(&cond_add, &grep_mutex);
116 }
117
118 if (todo_start == todo_end && all_work_added) {
119 ret = NULL;
120 } else {
121 ret = &todo[todo_start];
122 todo_start = (todo_start + 1) % ARRAY_SIZE(todo);
123 }
124 grep_unlock();
125 return ret;
126}
127
5b594f45
FK
128static void work_done(struct work_item *w)
129{
130 int old_done;
131
132 grep_lock();
133 w->done = 1;
134 old_done = todo_done;
135 for(; todo[todo_done].done && todo_done != todo_start;
136 todo_done = (todo_done+1) % ARRAY_SIZE(todo)) {
137 w = &todo[todo_done];
431d6e7b 138 if (w->out.len) {
08303c36
RS
139 const char *p = w->out.buf;
140 size_t len = w->out.len;
141
142 /* Skip the leading hunk mark of the first file. */
143 if (skip_first_line) {
144 while (len) {
145 len--;
146 if (*p++ == '\n')
147 break;
148 }
149 skip_first_line = 0;
150 }
151
152 write_or_die(1, p, len);
431d6e7b 153 }
8f24a632 154 grep_source_clear(&w->source);
5b594f45
FK
155 }
156
157 if (old_done != todo_done)
158 pthread_cond_signal(&cond_write);
159
160 if (all_work_added && todo_done == todo_end)
161 pthread_cond_signal(&cond_result);
162
163 grep_unlock();
164}
165
166static void *run(void *arg)
167{
168 int hit = 0;
169 struct grep_opt *opt = arg;
170
171 while (1) {
172 struct work_item *w = get_work();
173 if (!w)
174 break;
175
176 opt->output_priv = w;
8f24a632
JK
177 hit |= grep_source(opt, &w->source);
178 grep_source_clear_data(&w->source);
5b594f45
FK
179 work_done(w);
180 }
bfac23d9
DM
181 free_grep_patterns(arg);
182 free(arg);
5b594f45
FK
183
184 return (void*) (intptr_t) hit;
185}
186
187static void strbuf_out(struct grep_opt *opt, const void *buf, size_t size)
188{
189 struct work_item *w = opt->output_priv;
190 strbuf_add(&w->out, buf, size);
191}
192
193static void start_threads(struct grep_opt *opt)
194{
195 int i;
196
197 pthread_mutex_init(&grep_mutex, NULL);
b3aeb285 198 pthread_mutex_init(&grep_read_mutex, NULL);
0579f91d 199 pthread_mutex_init(&grep_attr_mutex, NULL);
5b594f45
FK
200 pthread_cond_init(&cond_add, NULL);
201 pthread_cond_init(&cond_write, NULL);
202 pthread_cond_init(&cond_result, NULL);
78db6ea9 203 grep_use_locks = 1;
5b594f45
FK
204
205 for (i = 0; i < ARRAY_SIZE(todo); i++) {
206 strbuf_init(&todo[i].out, 0);
207 }
208
209 for (i = 0; i < ARRAY_SIZE(threads); i++) {
210 int err;
211 struct grep_opt *o = grep_opt_dup(opt);
212 o->output = strbuf_out;
208f5aa4 213 o->debug = 0;
5b594f45
FK
214 compile_grep_patterns(o);
215 err = pthread_create(&threads[i], NULL, run, o);
216
217 if (err)
2fc5f9f1 218 die(_("grep: failed to create thread: %s"),
5b594f45
FK
219 strerror(err));
220 }
221}
222
223static int wait_all(void)
224{
225 int hit = 0;
226 int i;
227
228 grep_lock();
229 all_work_added = 1;
230
231 /* Wait until all work is done. */
232 while (todo_done != todo_end)
233 pthread_cond_wait(&cond_result, &grep_mutex);
234
235 /* Wake up all the consumer threads so they can see that there
236 * is no more work to do.
237 */
238 pthread_cond_broadcast(&cond_add);
239 grep_unlock();
240
241 for (i = 0; i < ARRAY_SIZE(threads); i++) {
242 void *h;
243 pthread_join(threads[i], &h);
244 hit |= (int) (intptr_t) h;
245 }
246
247 pthread_mutex_destroy(&grep_mutex);
b3aeb285 248 pthread_mutex_destroy(&grep_read_mutex);
0579f91d 249 pthread_mutex_destroy(&grep_attr_mutex);
5b594f45
FK
250 pthread_cond_destroy(&cond_add);
251 pthread_cond_destroy(&cond_write);
252 pthread_cond_destroy(&cond_result);
78db6ea9 253 grep_use_locks = 0;
5b594f45
FK
254
255 return hit;
256}
257#else /* !NO_PTHREADS */
5b594f45
FK
258
259static int wait_all(void)
260{
261 return 0;
262}
263#endif
264
15fabd1b
JH
265static int grep_cmd_config(const char *var, const char *value, void *cb)
266{
267 int st = grep_config(var, value, cb);
268 if (git_color_default_config(var, value, cb) < 0)
269 st = -1;
270 return st;
271}
272
5f02d315
JH
273static void *lock_and_read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
274{
275 void *data;
276
b3aeb285 277 grep_read_lock();
76416139 278 data = read_sha1_file(sha1, type, size);
b3aeb285 279 grep_read_unlock();
5b594f45
FK
280 return data;
281}
282
283static int grep_sha1(struct grep_opt *opt, const unsigned char *sha1,
55c61688
NTND
284 const char *filename, int tree_name_len,
285 const char *path)
5b594f45
FK
286{
287 struct strbuf pathbuf = STRBUF_INIT;
5b594f45 288
0d042fec 289 if (opt->relative && opt->prefix_length) {
39598f99 290 quote_path_relative(filename + tree_name_len, opt->prefix, &pathbuf);
5b594f45
FK
291 strbuf_insert(&pathbuf, 0, filename, tree_name_len);
292 } else {
293 strbuf_addstr(&pathbuf, filename);
294 }
295
5b594f45
FK
296#ifndef NO_PTHREADS
297 if (use_threads) {
55c61688 298 add_work(opt, GREP_SOURCE_SHA1, pathbuf.buf, path, sha1);
8f24a632 299 strbuf_release(&pathbuf);
5b594f45
FK
300 return 0;
301 } else
302#endif
303 {
8f24a632 304 struct grep_source gs;
5b594f45 305 int hit;
5010cb5f 306
55c61688 307 grep_source_init(&gs, GREP_SOURCE_SHA1, pathbuf.buf, path, sha1);
8f24a632
JK
308 strbuf_release(&pathbuf);
309 hit = grep_source(opt, &gs);
dc49cd76 310
8f24a632
JK
311 grep_source_clear(&gs);
312 return hit;
5010cb5f 313 }
5b594f45
FK
314}
315
316static int grep_file(struct grep_opt *opt, const char *filename)
317{
318 struct strbuf buf = STRBUF_INIT;
5b594f45 319
0d042fec 320 if (opt->relative && opt->prefix_length)
39598f99 321 quote_path_relative(filename, opt->prefix, &buf);
5b594f45
FK
322 else
323 strbuf_addstr(&buf, filename);
5b594f45
FK
324
325#ifndef NO_PTHREADS
326 if (use_threads) {
55c61688 327 add_work(opt, GREP_SOURCE_FILE, buf.buf, filename, filename);
8f24a632 328 strbuf_release(&buf);
5b594f45
FK
329 return 0;
330 } else
331#endif
332 {
8f24a632 333 struct grep_source gs;
5b594f45 334 int hit;
5b594f45 335
55c61688 336 grep_source_init(&gs, GREP_SOURCE_FILE, buf.buf, filename, filename);
8f24a632
JK
337 strbuf_release(&buf);
338 hit = grep_source(opt, &gs);
339
340 grep_source_clear(&gs);
5b594f45
FK
341 return hit;
342 }
5010cb5f
JH
343}
344
678e484b
JS
345static void append_path(struct grep_opt *opt, const void *data, size_t len)
346{
347 struct string_list *path_list = opt->output_priv;
348
349 if (len == 1 && *(const char *)data == '\0')
350 return;
0c72cead 351 string_list_append(path_list, xstrndup(data, len));
678e484b
JS
352}
353
354static void run_pager(struct grep_opt *opt, const char *prefix)
355{
356 struct string_list *path_list = opt->output_priv;
357 const char **argv = xmalloc(sizeof(const char *) * (path_list->nr + 1));
358 int i, status;
359
360 for (i = 0; i < path_list->nr; i++)
361 argv[i] = path_list->items[i].string;
362 argv[path_list->nr] = NULL;
363
26ecfe3e 364 status = run_command_v_opt_cd_env(argv, RUN_USING_SHELL, prefix, NULL);
678e484b
JS
365 if (status)
366 exit(status);
367 free(argv);
368}
369
f34bbc15 370static int grep_cache(struct grep_opt *opt, const struct pathspec *pathspec, int cached)
5010cb5f
JH
371{
372 int hit = 0;
373 int nr;
374 read_cache();
375
376 for (nr = 0; nr < active_nr; nr++) {
9c5e6c80 377 const struct cache_entry *ce = active_cache[nr];
7a51ed66 378 if (!S_ISREG(ce->ce_mode))
5010cb5f 379 continue;
429bb40a 380 if (!ce_path_match(ce, pathspec, NULL))
5010cb5f 381 continue;
57d43466
NTND
382 /*
383 * If CE_VALID is on, we assume worktree file and its cache entry
384 * are identical, even if worktree file has been modified, so use
385 * cache version instead
386 */
b4d1690d 387 if (cached || (ce->ce_flags & CE_VALID) || ce_skip_worktree(ce)) {
36f2587f
JH
388 if (ce_stage(ce))
389 continue;
55c61688 390 hit |= grep_sha1(opt, ce->sha1, ce->name, 0, ce->name);
36f2587f 391 }
5010cb5f
JH
392 else
393 hit |= grep_file(opt, ce->name);
36f2587f
JH
394 if (ce_stage(ce)) {
395 do {
396 nr++;
397 } while (nr < active_nr &&
398 !strcmp(ce->name, active_cache[nr]->name));
399 nr--; /* compensate for loop control */
400 }
c8610a2e
JH
401 if (hit && opt->status_only)
402 break;
5010cb5f
JH
403 }
404 return hit;
405}
406
f34bbc15 407static int grep_tree(struct grep_opt *opt, const struct pathspec *pathspec,
55c61688
NTND
408 struct tree_desc *tree, struct strbuf *base, int tn_len,
409 int check_attr)
5010cb5f 410{
d688cf07
NTND
411 int hit = 0;
412 enum interesting match = entry_not_interesting;
4c068a98 413 struct name_entry entry;
e5e062b6 414 int old_baselen = base->len;
5010cb5f 415
4c068a98 416 while (tree_entry(tree, &entry)) {
0de16337 417 int te_len = tree_entry_len(&entry);
e5e062b6 418
d688cf07 419 if (match != all_entries_interesting) {
97d0b74a 420 match = tree_entry_interesting(&entry, base, tn_len, pathspec);
d688cf07 421 if (match == all_entries_not_interesting)
97d0b74a 422 break;
d688cf07 423 if (match == entry_not_interesting)
1376e507
NTND
424 continue;
425 }
5010cb5f 426
1376e507 427 strbuf_add(base, entry.path, te_len);
e0eb889f 428
1376e507 429 if (S_ISREG(entry.mode)) {
55c61688
NTND
430 hit |= grep_sha1(opt, entry.sha1, base->buf, tn_len,
431 check_attr ? base->buf + tn_len : NULL);
e5e062b6 432 }
4c068a98 433 else if (S_ISDIR(entry.mode)) {
21666f1a 434 enum object_type type;
5010cb5f
JH
435 struct tree_desc sub;
436 void *data;
6fda5e51
LT
437 unsigned long size;
438
5f02d315 439 data = lock_and_read_sha1_file(entry.sha1, &type, &size);
5010cb5f 440 if (!data)
2fc5f9f1 441 die(_("unable to read tree (%s)"),
4c068a98 442 sha1_to_hex(entry.sha1));
1376e507
NTND
443
444 strbuf_addch(base, '/');
6fda5e51 445 init_tree_desc(&sub, data, size);
55c61688
NTND
446 hit |= grep_tree(opt, pathspec, &sub, base, tn_len,
447 check_attr);
5010cb5f
JH
448 free(data);
449 }
e5e062b6
NTND
450 strbuf_setlen(base, old_baselen);
451
c8610a2e
JH
452 if (hit && opt->status_only)
453 break;
5010cb5f
JH
454 }
455 return hit;
456}
457
f34bbc15 458static int grep_object(struct grep_opt *opt, const struct pathspec *pathspec,
9e0c3c4f 459 struct object *obj, const char *name, const char *path)
5010cb5f 460{
1974632c 461 if (obj->type == OBJ_BLOB)
9e0c3c4f 462 return grep_sha1(opt, obj->sha1, name, 0, path);
1974632c 463 if (obj->type == OBJ_COMMIT || obj->type == OBJ_TREE) {
5010cb5f
JH
464 struct tree_desc tree;
465 void *data;
6fda5e51 466 unsigned long size;
e5e062b6
NTND
467 struct strbuf base;
468 int hit, len;
469
b3aeb285 470 grep_read_lock();
5010cb5f 471 data = read_object_with_reference(obj->sha1, tree_type,
6fda5e51 472 &size, NULL);
b3aeb285 473 grep_read_unlock();
8cb5775b 474
5010cb5f 475 if (!data)
2fc5f9f1 476 die(_("unable to read tree (%s)"), sha1_to_hex(obj->sha1));
e5e062b6
NTND
477
478 len = name ? strlen(name) : 0;
479 strbuf_init(&base, PATH_MAX + len + 1);
480 if (len) {
481 strbuf_add(&base, name, len);
482 strbuf_addch(&base, ':');
483 }
6fda5e51 484 init_tree_desc(&tree, data, size);
55c61688
NTND
485 hit = grep_tree(opt, pathspec, &tree, &base, base.len,
486 obj->type == OBJ_COMMIT);
e5e062b6 487 strbuf_release(&base);
5010cb5f
JH
488 free(data);
489 return hit;
490 }
2fc5f9f1 491 die(_("unable to grep from object of type %s"), typename(obj->type));
5010cb5f
JH
492}
493
f34bbc15 494static int grep_objects(struct grep_opt *opt, const struct pathspec *pathspec,
30d00c39
JN
495 const struct object_array *list)
496{
497 unsigned int i;
498 int hit = 0;
499 const unsigned int nr = list->nr;
500
501 for (i = 0; i < nr; i++) {
502 struct object *real_obj;
503 real_obj = deref_tag(list->objects[i].item, NULL, 0);
9e0c3c4f 504 if (grep_object(opt, pathspec, real_obj, list->objects[i].name, list->objects[i].path)) {
30d00c39
JN
505 hit = 1;
506 if (opt->status_only)
507 break;
508 }
509 }
510 return hit;
511}
512
dbfae86a
JH
513static int grep_directory(struct grep_opt *opt, const struct pathspec *pathspec,
514 int exc_std)
59332d13
JH
515{
516 struct dir_struct dir;
517 int i, hit = 0;
518
519 memset(&dir, 0, sizeof(dir));
0a93fb8a
JH
520 if (exc_std)
521 setup_standard_excludes(&dir);
59332d13 522
7327d3d1 523 fill_directory(&dir, pathspec);
59332d13 524 for (i = 0; i < dir.nr; i++) {
ebb32893 525 if (!dir_path_match(dir.entries[i], pathspec, 0, NULL))
9d8b831b 526 continue;
59332d13
JH
527 hit |= grep_file(opt, dir.entries[i]->name);
528 if (hit && opt->status_only)
529 break;
530 }
59332d13
JH
531 return hit;
532}
533
ff3c7f9a
RS
534static int context_callback(const struct option *opt, const char *arg,
535 int unset)
3e230fa1
RS
536{
537 struct grep_opt *grep_opt = opt->value;
538 int value;
539 const char *endp;
540
541 if (unset) {
542 grep_opt->pre_context = grep_opt->post_context = 0;
543 return 0;
544 }
545 value = strtol(arg, (char **)&endp, 10);
546 if (*endp) {
2fc5f9f1 547 return error(_("switch `%c' expects a numerical value"),
3e230fa1
RS
548 opt->short_name);
549 }
550 grep_opt->pre_context = grep_opt->post_context = value;
551 return 0;
552}
553
ff3c7f9a 554static int file_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
555{
556 struct grep_opt *grep_opt = opt->value;
c41dd2fd 557 int from_stdin = !strcmp(arg, "-");
3e230fa1
RS
558 FILE *patterns;
559 int lno = 0;
cfe370c6 560 struct strbuf sb = STRBUF_INIT;
3e230fa1 561
c41dd2fd 562 patterns = from_stdin ? stdin : fopen(arg, "r");
3e230fa1 563 if (!patterns)
2fc5f9f1 564 die_errno(_("cannot open '%s'"), arg);
3e230fa1
RS
565 while (strbuf_getline(&sb, patterns, '\n') == 0) {
566 /* ignore empty line like grep does */
567 if (sb.len == 0)
568 continue;
ed40a095 569
ec830611
RS
570 append_grep_pat(grep_opt, sb.buf, sb.len, arg, ++lno,
571 GREP_PATTERN);
3e230fa1 572 }
c41dd2fd
RS
573 if (!from_stdin)
574 fclose(patterns);
3e230fa1
RS
575 strbuf_release(&sb);
576 return 0;
577}
578
ff3c7f9a 579static int not_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
580{
581 struct grep_opt *grep_opt = opt->value;
582 append_grep_pattern(grep_opt, "--not", "command line", 0, GREP_NOT);
583 return 0;
584}
585
ff3c7f9a 586static int and_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
587{
588 struct grep_opt *grep_opt = opt->value;
589 append_grep_pattern(grep_opt, "--and", "command line", 0, GREP_AND);
590 return 0;
591}
592
ff3c7f9a 593static int open_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
594{
595 struct grep_opt *grep_opt = opt->value;
596 append_grep_pattern(grep_opt, "(", "command line", 0, GREP_OPEN_PAREN);
597 return 0;
598}
599
ff3c7f9a 600static int close_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
601{
602 struct grep_opt *grep_opt = opt->value;
603 append_grep_pattern(grep_opt, ")", "command line", 0, GREP_CLOSE_PAREN);
604 return 0;
605}
606
ff3c7f9a
RS
607static int pattern_callback(const struct option *opt, const char *arg,
608 int unset)
3e230fa1
RS
609{
610 struct grep_opt *grep_opt = opt->value;
611 append_grep_pattern(grep_opt, arg, "-e option", 0, GREP_PATTERN);
612 return 0;
613}
5010cb5f 614
ff3c7f9a 615static int help_callback(const struct option *opt, const char *arg, int unset)
3e230fa1
RS
616{
617 return -1;
618}
088b084b 619
a633fca0 620int cmd_grep(int argc, const char **argv, const char *prefix)
5010cb5f 621{
5010cb5f 622 int hit = 0;
0a93fb8a 623 int cached = 0, untracked = 0, opt_exclude = -1;
5acd64ed 624 int seen_dashdash = 0;
bbc09c22 625 int external_grep_allowed__ignored;
0af88c15 626 const char *show_in_pager = NULL, *default_pager = "dummy";
5010cb5f 627 struct grep_opt opt;
3cd47459 628 struct object_array list = OBJECT_ARRAY_INIT;
f34bbc15 629 struct pathspec pathspec;
183113a5 630 struct string_list path_list = STRING_LIST_INIT_NODUP;
5acd64ed 631 int i;
3e230fa1 632 int dummy;
ff38d1a9 633 int use_index = 1;
84befcd0 634 int pattern_type_arg = GREP_PATTERN_TYPE_UNSPECIFIED;
cca2c172 635
3e230fa1 636 struct option options[] = {
d5d09d47 637 OPT_BOOL(0, "cached", &cached,
4b407bc5 638 N_("search in index instead of in the work tree")),
cbb08c2e 639 OPT_NEGBIT(0, "no-index", &use_index,
f63cf8c9 640 N_("find in contents not managed by git"), 1),
d5d09d47 641 OPT_BOOL(0, "untracked", &untracked,
4b407bc5 642 N_("search in both tracked and untracked files")),
0a93fb8a 643 OPT_SET_INT(0, "exclude-standard", &opt_exclude,
77fdb8a8 644 N_("ignore files specified via '.gitignore'"), 1),
3e230fa1 645 OPT_GROUP(""),
d5d09d47 646 OPT_BOOL('v', "invert-match", &opt.invert,
4b407bc5 647 N_("show non-matching lines")),
d5d09d47 648 OPT_BOOL('i', "ignore-case", &opt.ignore_case,
4b407bc5 649 N_("case insensitive matching")),
d5d09d47 650 OPT_BOOL('w', "word-regexp", &opt.word_regexp,
4b407bc5 651 N_("match patterns only at word boundaries")),
3e230fa1 652 OPT_SET_INT('a', "text", &opt.binary,
4b407bc5 653 N_("process binary files as text"), GREP_BINARY_TEXT),
3e230fa1 654 OPT_SET_INT('I', NULL, &opt.binary,
4b407bc5 655 N_("don't match patterns in binary files"),
3e230fa1 656 GREP_BINARY_NOMATCH),
335ec3bf
JK
657 OPT_BOOL(0, "textconv", &opt.allow_textconv,
658 N_("process binary files with textconv filters")),
4b407bc5
NTND
659 { OPTION_INTEGER, 0, "max-depth", &opt.max_depth, N_("depth"),
660 N_("descend at most <depth> levels"), PARSE_OPT_NONEG,
a91f453f 661 NULL, 1 },
3e230fa1 662 OPT_GROUP(""),
84befcd0 663 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg,
4b407bc5 664 N_("use extended POSIX regular expressions"),
84befcd0
S
665 GREP_PATTERN_TYPE_ERE),
666 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg,
4b407bc5 667 N_("use basic POSIX regular expressions (default)"),
84befcd0
S
668 GREP_PATTERN_TYPE_BRE),
669 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg,
4b407bc5 670 N_("interpret patterns as fixed strings"),
84befcd0
S
671 GREP_PATTERN_TYPE_FIXED),
672 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg,
4b407bc5 673 N_("use Perl-compatible regular expressions"),
84befcd0 674 GREP_PATTERN_TYPE_PCRE),
3e230fa1 675 OPT_GROUP(""),
d5d09d47 676 OPT_BOOL('n', "line-number", &opt.linenum, N_("show line numbers")),
4b407bc5
NTND
677 OPT_NEGBIT('h', NULL, &opt.pathname, N_("don't show filenames"), 1),
678 OPT_BIT('H', NULL, &opt.pathname, N_("show filenames"), 1),
3e230fa1 679 OPT_NEGBIT(0, "full-name", &opt.relative,
4b407bc5 680 N_("show filenames relative to top directory"), 1),
d5d09d47 681 OPT_BOOL('l', "files-with-matches", &opt.name_only,
4b407bc5 682 N_("show only filenames instead of matching lines")),
d5d09d47 683 OPT_BOOL(0, "name-only", &opt.name_only,
4b407bc5 684 N_("synonym for --files-with-matches")),
d5d09d47 685 OPT_BOOL('L', "files-without-match",
3e230fa1 686 &opt.unmatch_name_only,
4b407bc5 687 N_("show only the names of files without match")),
d5d09d47 688 OPT_BOOL('z', "null", &opt.null_following_name,
4b407bc5 689 N_("print NUL after filenames")),
d5d09d47 690 OPT_BOOL('c', "count", &opt.count,
4b407bc5
NTND
691 N_("show the number of matches instead of matching lines")),
692 OPT__COLOR(&opt.color, N_("highlight matches")),
d5d09d47 693 OPT_BOOL(0, "break", &opt.file_break,
4b407bc5 694 N_("print empty line between matches from different files")),
d5d09d47 695 OPT_BOOL(0, "heading", &opt.heading,
4b407bc5 696 N_("show filename only once above matches from same file")),
3e230fa1 697 OPT_GROUP(""),
4b407bc5
NTND
698 OPT_CALLBACK('C', "context", &opt, N_("n"),
699 N_("show <n> context lines before and after matches"),
3e230fa1 700 context_callback),
317f63c2 701 OPT_INTEGER('B', "before-context", &opt.pre_context,
4b407bc5 702 N_("show <n> context lines before matches")),
317f63c2 703 OPT_INTEGER('A', "after-context", &opt.post_context,
4b407bc5
NTND
704 N_("show <n> context lines after matches")),
705 OPT_NUMBER_CALLBACK(&opt, N_("shortcut for -C NUM"),
3e230fa1 706 context_callback),
d5d09d47 707 OPT_BOOL('p', "show-function", &opt.funcname,
4b407bc5 708 N_("show a line with the function name before matches")),
d5d09d47 709 OPT_BOOL('W', "function-context", &opt.funcbody,
4b407bc5 710 N_("show the surrounding function")),
3e230fa1 711 OPT_GROUP(""),
4b407bc5
NTND
712 OPT_CALLBACK('f', NULL, &opt, N_("file"),
713 N_("read patterns from file"), file_callback),
714 { OPTION_CALLBACK, 'e', NULL, &opt, N_("pattern"),
715 N_("match <pattern>"), PARSE_OPT_NONEG, pattern_callback },
3e230fa1 716 { OPTION_CALLBACK, 0, "and", &opt, NULL,
4b407bc5 717 N_("combine patterns specified with -e"),
3e230fa1 718 PARSE_OPT_NOARG | PARSE_OPT_NONEG, and_callback },
d5d09d47 719 OPT_BOOL(0, "or", &dummy, ""),
3e230fa1
RS
720 { OPTION_CALLBACK, 0, "not", &opt, NULL, "",
721 PARSE_OPT_NOARG | PARSE_OPT_NONEG, not_callback },
722 { OPTION_CALLBACK, '(', NULL, &opt, NULL, "",
723 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
724 open_callback },
725 { OPTION_CALLBACK, ')', NULL, &opt, NULL, "",
726 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_NODASH,
727 close_callback },
d52ee6e6 728 OPT__QUIET(&opt.status_only,
4b407bc5 729 N_("indicate hit with exit status without output")),
d5d09d47 730 OPT_BOOL(0, "all-match", &opt.all_match,
4b407bc5 731 N_("show only matches from files that match all patterns")),
17bf35a3 732 { OPTION_SET_INT, 0, "debug", &opt.debug, NULL,
3d7535e4 733 N_("show parse tree for grep expression"),
17bf35a3 734 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1 },
3e230fa1 735 OPT_GROUP(""),
0af88c15 736 { OPTION_STRING, 'O', "open-files-in-pager", &show_in_pager,
4b407bc5 737 N_("pager"), N_("show matching files in the pager"),
0af88c15 738 PARSE_OPT_OPTARG, NULL, (intptr_t)default_pager },
d5d09d47
SB
739 OPT_BOOL(0, "ext-grep", &external_grep_allowed__ignored,
740 N_("allow calling of grep(1) (ignored by this build)")),
5dcd1b15 741 { OPTION_CALLBACK, 0, "help-all", NULL, NULL, N_("show usage"),
3e230fa1
RS
742 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
743 OPT_END()
744 };
5010cb5f 745
9c855c31
JN
746 /*
747 * 'git grep -h', unlike 'git grep -h <pattern>', is a request
748 * to show usage information and exit.
749 */
750 if (argc == 2 && !strcmp(argv[1], "-h"))
751 usage_with_options(grep_usage, options);
752
15fabd1b
JH
753 init_grep_defaults();
754 git_config(grep_cmd_config, NULL);
755 grep_init(&opt, prefix);
7e8f59d5 756
5010cb5f 757 /*
5acd64ed
JH
758 * If there is no -- then the paths must exist in the working
759 * tree. If there is no explicit pattern specified with -e or
760 * -f, we take the first unrecognized non option to be the
761 * pattern, but then what follows it must be zero or more
762 * valid refs up to the -- (if exists), and then existing
763 * paths. If there is an explicit pattern, then the first
82e5a82f 764 * unrecognized non option is the beginning of the refs list
5acd64ed 765 * that continues up to the -- (if exists), and then paths.
5010cb5f 766 */
37782920 767 argc = parse_options(argc, argv, prefix, options, grep_usage,
3e230fa1
RS
768 PARSE_OPT_KEEP_DASHDASH |
769 PARSE_OPT_STOP_AT_NON_OPTION |
770 PARSE_OPT_NO_INTERNAL_HELP);
c5c31d33 771 grep_commit_pattern_type(pattern_type_arg, &opt);
3e230fa1 772
ff38d1a9 773 if (use_index && !startup_info->have_repository)
59332d13
JH
774 /* die the same way as if we did it at the beginning */
775 setup_git_directory();
776
1123c67c
JK
777 /*
778 * skip a -- separator; we know it cannot be
779 * separating revisions from pathnames if
780 * we haven't even had any patterns yet
781 */
782 if (argc > 0 && !opt.pattern_list && !strcmp(argv[0], "--")) {
783 argv++;
784 argc--;
785 }
786
3e230fa1
RS
787 /* First unrecognized non-option token */
788 if (argc > 0 && !opt.pattern_list) {
789 append_grep_pattern(&opt, argv[0], "command line", 0,
790 GREP_PATTERN);
791 argv++;
792 argc--;
5010cb5f 793 }
5acd64ed 794
0af88c15
JS
795 if (show_in_pager == default_pager)
796 show_in_pager = git_pager(1);
678e484b 797 if (show_in_pager) {
e7b082a4 798 opt.color = 0;
0af88c15
JS
799 opt.name_only = 1;
800 opt.null_following_name = 1;
801 opt.output_priv = &path_list;
802 opt.output = append_path;
0c72cead 803 string_list_append(&path_list, show_in_pager);
678e484b
JS
804 }
805
f9b9faf6 806 if (!opt.pattern_list)
2fc5f9f1 807 die(_("no pattern given."));
5183bf67
BC
808 if (!opt.fixed && opt.ignore_case)
809 opt.regflags |= REG_ICASE;
5b594f45 810
83b5d2f5 811 compile_grep_patterns(&opt);
5acd64ed
JH
812
813 /* Check revs and then paths */
3e230fa1 814 for (i = 0; i < argc; i++) {
5acd64ed 815 const char *arg = argv[i];
1362671f 816 unsigned char sha1[20];
afa15f3c 817 struct object_context oc;
5acd64ed 818 /* Is it a rev? */
afa15f3c 819 if (!get_sha1_with_context(arg, 0, sha1, &oc)) {
f7892d18 820 struct object *object = parse_object_or_die(sha1, arg);
0b0ecaac
NTND
821 if (!seen_dashdash)
822 verify_non_filename(prefix, arg);
9e0c3c4f 823 add_object_array_with_path(object, arg, &list, oc.mode, oc.path);
5acd64ed
JH
824 continue;
825 }
826 if (!strcmp(arg, "--")) {
827 i++;
828 seen_dashdash = 1;
829 }
830 break;
1362671f 831 }
5acd64ed 832
53b8d931 833#ifndef NO_PTHREADS
044b1f3c 834 if (list.nr || cached || show_in_pager)
53b8d931
TR
835 use_threads = 0;
836#else
837 use_threads = 0;
838#endif
839
53b8d931
TR
840#ifndef NO_PTHREADS
841 if (use_threads) {
50dd0f2f
AY
842 if (!(opt.name_only || opt.unmatch_name_only || opt.count)
843 && (opt.pre_context || opt.post_context ||
844 opt.file_break || opt.funcbody))
53b8d931
TR
845 skip_first_line = 1;
846 start_threads(&opt);
847 }
848#endif
849
5acd64ed
JH
850 /* The rest are paths */
851 if (!seen_dashdash) {
852 int j;
c39c4f47 853 for (j = i; j < argc; j++)
023e37c3 854 verify_filename(prefix, argv[j], j == i);
5acd64ed
JH
855 }
856
0fdc2ae5 857 parse_pathspec(&pathspec, 0,
6330a171
NTND
858 PATHSPEC_PREFER_CWD |
859 (opt.max_depth != -1 ? PATHSPEC_MAXDEPTH_VALID : 0),
0fdc2ae5 860 prefix, argv + i);
1376e507
NTND
861 pathspec.max_depth = opt.max_depth;
862 pathspec.recursive = 1;
5010cb5f 863
678e484b 864 if (show_in_pager && (cached || list.nr))
e4fe4ba5 865 die(_("--open-files-in-pager only works on the worktree"));
678e484b
JS
866
867 if (show_in_pager && opt.pattern_list && !opt.pattern_list->next) {
868 const char *pager = path_list.items[0].string;
869 int len = strlen(pager);
870
871 if (len > 4 && is_dir_sep(pager[len - 5]))
872 pager += len - 4;
873
f7febbea
JS
874 if (opt.ignore_case && !strcmp("less", pager))
875 string_list_append(&path_list, "-I");
876
678e484b
JS
877 if (!strcmp("less", pager) || !strcmp("vi", pager)) {
878 struct strbuf buf = STRBUF_INIT;
879 strbuf_addf(&buf, "+/%s%s",
880 strcmp("less", pager) ? "" : "*",
881 opt.pattern_list->pattern);
0c72cead 882 string_list_append(&path_list, buf.buf);
678e484b
JS
883 strbuf_detach(&buf, NULL);
884 }
885 }
886
c2048f0b 887 if (!show_in_pager && !opt.status_only)
678e484b
JS
888 setup_pager();
889
0a93fb8a 890 if (!use_index && (untracked || cached))
dbfae86a 891 die(_("--cached or --untracked cannot be used with --no-index."));
678e484b 892
0a93fb8a 893 if (!use_index || untracked) {
0a93fb8a 894 int use_exclude = (opt_exclude < 0) ? use_index : !!opt_exclude;
59332d13 895 if (list.nr)
dbfae86a
JH
896 die(_("--no-index or --untracked cannot be used with revs."));
897 hit = grep_directory(&opt, &pathspec, use_exclude);
898 } else if (0 <= opt_exclude) {
9fddaf78 899 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
685359cf 900 } else if (!list.nr) {
6577f542
NTND
901 if (!cached)
902 setup_work_tree();
5b594f45 903
f34bbc15 904 hit = grep_cache(&opt, &pathspec, cached);
685359cf
JS
905 } else {
906 if (cached)
2fc5f9f1 907 die(_("both --cached and trees are given."));
f34bbc15 908 hit = grep_objects(&opt, &pathspec, &list);
5010cb5f 909 }
5b594f45
FK
910
911 if (use_threads)
912 hit |= wait_all();
678e484b
JS
913 if (hit && show_in_pager)
914 run_pager(&opt, prefix);
b48fb5b6 915 free_grep_patterns(&opt);
5010cb5f
JH
916 return !hit;
917}