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