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