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