4 * Copyright (c) 2006 Junio C Hamano
11 #include "tree-walk.h"
13 #include "parse-options.h"
14 #include "string-list.h"
15 #include "run-command.h"
21 static char const * const grep_usage
[] = {
22 N_("git grep [options] [-e] <pattern> [<rev>...] [[--] <path>...]"),
26 static int use_threads
= 1;
30 static pthread_t threads
[THREADS
];
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.
37 struct grep_source source
;
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.
46 * The work_items in [todo_start, todo_end) are waiting to be picked
47 * up by a consumer thread.
49 * The ranges are modulo TODO_SIZE.
52 static struct work_item todo
[TODO_SIZE
];
53 static int todo_start
;
57 /* Has all work items been added? */
58 static int all_work_added
;
60 /* This lock protects all the variables above. */
61 static pthread_mutex_t grep_mutex
;
63 static inline void grep_lock(void)
66 pthread_mutex_lock(&grep_mutex
);
69 static inline void grep_unlock(void)
72 pthread_mutex_unlock(&grep_mutex
);
75 /* Signalled when a new work_item is added to todo. */
76 static pthread_cond_t cond_add
;
78 /* Signalled when the result from one work_item is written to
81 static pthread_cond_t cond_write
;
83 /* Signalled when we are finished with everything. */
84 static pthread_cond_t cond_result
;
86 static int skip_first_line
;
88 static void add_work(struct grep_opt
*opt
, enum grep_source_type type
,
89 const char *name
, const void *id
)
93 while ((todo_end
+1) % ARRAY_SIZE(todo
) == todo_done
) {
94 pthread_cond_wait(&cond_write
, &grep_mutex
);
97 grep_source_init(&todo
[todo_end
].source
, type
, name
, id
);
98 if (opt
->binary
!= GREP_BINARY_TEXT
)
99 grep_source_load_driver(&todo
[todo_end
].source
);
100 todo
[todo_end
].done
= 0;
101 strbuf_reset(&todo
[todo_end
].out
);
102 todo_end
= (todo_end
+ 1) % ARRAY_SIZE(todo
);
104 pthread_cond_signal(&cond_add
);
108 static struct work_item
*get_work(void)
110 struct work_item
*ret
;
113 while (todo_start
== todo_end
&& !all_work_added
) {
114 pthread_cond_wait(&cond_add
, &grep_mutex
);
117 if (todo_start
== todo_end
&& all_work_added
) {
120 ret
= &todo
[todo_start
];
121 todo_start
= (todo_start
+ 1) % ARRAY_SIZE(todo
);
127 static void work_done(struct work_item
*w
)
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
];
138 const char *p
= w
->out
.buf
;
139 size_t len
= w
->out
.len
;
141 /* Skip the leading hunk mark of the first file. */
142 if (skip_first_line
) {
151 write_or_die(1, p
, len
);
153 grep_source_clear(&w
->source
);
156 if (old_done
!= todo_done
)
157 pthread_cond_signal(&cond_write
);
159 if (all_work_added
&& todo_done
== todo_end
)
160 pthread_cond_signal(&cond_result
);
165 static void *run(void *arg
)
168 struct grep_opt
*opt
= arg
;
171 struct work_item
*w
= get_work();
175 opt
->output_priv
= w
;
176 hit
|= grep_source(opt
, &w
->source
);
177 grep_source_clear_data(&w
->source
);
180 free_grep_patterns(arg
);
183 return (void*) (intptr_t) hit
;
186 static void strbuf_out(struct grep_opt
*opt
, const void *buf
, size_t size
)
188 struct work_item
*w
= opt
->output_priv
;
189 strbuf_add(&w
->out
, buf
, size
);
192 static void start_threads(struct grep_opt
*opt
)
196 pthread_mutex_init(&grep_mutex
, NULL
);
197 pthread_mutex_init(&grep_read_mutex
, NULL
);
198 pthread_mutex_init(&grep_attr_mutex
, NULL
);
199 pthread_cond_init(&cond_add
, NULL
);
200 pthread_cond_init(&cond_write
, NULL
);
201 pthread_cond_init(&cond_result
, NULL
);
204 for (i
= 0; i
< ARRAY_SIZE(todo
); i
++) {
205 strbuf_init(&todo
[i
].out
, 0);
208 for (i
= 0; i
< ARRAY_SIZE(threads
); i
++) {
210 struct grep_opt
*o
= grep_opt_dup(opt
);
211 o
->output
= strbuf_out
;
213 compile_grep_patterns(o
);
214 err
= pthread_create(&threads
[i
], NULL
, run
, o
);
217 die(_("grep: failed to create thread: %s"),
222 static int wait_all(void)
230 /* Wait until all work is done. */
231 while (todo_done
!= todo_end
)
232 pthread_cond_wait(&cond_result
, &grep_mutex
);
234 /* Wake up all the consumer threads so they can see that there
235 * is no more work to do.
237 pthread_cond_broadcast(&cond_add
);
240 for (i
= 0; i
< ARRAY_SIZE(threads
); i
++) {
242 pthread_join(threads
[i
], &h
);
243 hit
|= (int) (intptr_t) h
;
246 pthread_mutex_destroy(&grep_mutex
);
247 pthread_mutex_destroy(&grep_read_mutex
);
248 pthread_mutex_destroy(&grep_attr_mutex
);
249 pthread_cond_destroy(&cond_add
);
250 pthread_cond_destroy(&cond_write
);
251 pthread_cond_destroy(&cond_result
);
256 #else /* !NO_PTHREADS */
258 static int wait_all(void)
264 static int parse_pattern_type_arg(const char *opt
, const char *arg
)
266 if (!strcmp(arg
, "default"))
267 return GREP_PATTERN_TYPE_UNSPECIFIED
;
268 else if (!strcmp(arg
, "basic"))
269 return GREP_PATTERN_TYPE_BRE
;
270 else if (!strcmp(arg
, "extended"))
271 return GREP_PATTERN_TYPE_ERE
;
272 else if (!strcmp(arg
, "fixed"))
273 return GREP_PATTERN_TYPE_FIXED
;
274 else if (!strcmp(arg
, "perl"))
275 return GREP_PATTERN_TYPE_PCRE
;
276 die("bad %s argument: %s", opt
, arg
);
279 static void grep_pattern_type_options(const int pattern_type
, struct grep_opt
*opt
)
281 switch (pattern_type
) {
282 case GREP_PATTERN_TYPE_UNSPECIFIED
:
285 case GREP_PATTERN_TYPE_BRE
:
288 opt
->regflags
&= ~REG_EXTENDED
;
291 case GREP_PATTERN_TYPE_ERE
:
294 opt
->regflags
|= REG_EXTENDED
;
297 case GREP_PATTERN_TYPE_FIXED
:
300 opt
->regflags
&= ~REG_EXTENDED
;
303 case GREP_PATTERN_TYPE_PCRE
:
306 opt
->regflags
&= ~REG_EXTENDED
;
311 static struct grep_opt grep_defaults
;
314 * Initialize the grep_defaults template with hardcoded defaults.
315 * We could let the compiler do this, but without C99 initializers
316 * the code gets unwieldy and unreadable, so...
318 static void init_grep_defaults(void)
320 struct grep_opt
*opt
= &grep_defaults
;
322 memset(opt
, 0, sizeof(*opt
));
325 opt
->regflags
= REG_NEWLINE
;
327 opt
->pattern_type_option
= GREP_PATTERN_TYPE_UNSPECIFIED
;
328 opt
->extended_regexp_option
= 0;
329 strcpy(opt
->color_context
, "");
330 strcpy(opt
->color_filename
, "");
331 strcpy(opt
->color_function
, "");
332 strcpy(opt
->color_lineno
, "");
333 strcpy(opt
->color_match
, GIT_COLOR_BOLD_RED
);
334 strcpy(opt
->color_selected
, "");
335 strcpy(opt
->color_sep
, GIT_COLOR_CYAN
);
340 * Read the configuration file once and store it in
341 * the grep_defaults template.
343 static int grep_config(const char *var
, const char *value
, void *cb
)
345 struct grep_opt
*opt
= &grep_defaults
;
348 if (userdiff_config(var
, value
) < 0)
351 if (!strcmp(var
, "grep.extendedregexp")) {
352 if (git_config_bool(var
, value
))
353 opt
->extended_regexp_option
= 1;
355 opt
->extended_regexp_option
= 0;
359 if (!strcmp(var
, "grep.patterntype")) {
360 opt
->pattern_type_option
= parse_pattern_type_arg(var
, value
);
364 if (!strcmp(var
, "grep.linenumber")) {
365 opt
->linenum
= git_config_bool(var
, value
);
369 if (!strcmp(var
, "color.grep"))
370 opt
->color
= git_config_colorbool(var
, value
);
371 else if (!strcmp(var
, "color.grep.context"))
372 color
= opt
->color_context
;
373 else if (!strcmp(var
, "color.grep.filename"))
374 color
= opt
->color_filename
;
375 else if (!strcmp(var
, "color.grep.function"))
376 color
= opt
->color_function
;
377 else if (!strcmp(var
, "color.grep.linenumber"))
378 color
= opt
->color_lineno
;
379 else if (!strcmp(var
, "color.grep.match"))
380 color
= opt
->color_match
;
381 else if (!strcmp(var
, "color.grep.selected"))
382 color
= opt
->color_selected
;
383 else if (!strcmp(var
, "color.grep.separator"))
384 color
= opt
->color_sep
;
388 return config_error_nonbool(var
);
389 color_parse(value
, var
, color
);
395 * Initialize one instance of grep_opt and copy the
396 * default values from the template we read the configuration
397 * information in an earlier call to git_config(grep_config).
399 static void grep_init(struct grep_opt
*opt
, const char *prefix
)
401 struct grep_opt
*def
= &grep_defaults
;
403 memset(opt
, 0, sizeof(*opt
));
404 opt
->prefix
= prefix
;
405 opt
->prefix_length
= (prefix
&& *prefix
) ? strlen(prefix
) : 0;
406 opt
->pattern_tail
= &opt
->pattern_list
;
407 opt
->header_tail
= &opt
->header_list
;
409 opt
->color
= def
->color
;
410 opt
->extended_regexp_option
= def
->extended_regexp_option
;
411 opt
->pattern_type_option
= def
->pattern_type_option
;
412 opt
->linenum
= def
->linenum
;
413 opt
->max_depth
= def
->max_depth
;
414 opt
->pathname
= def
->pathname
;
415 opt
->regflags
= def
->regflags
;
416 opt
->relative
= def
->relative
;
418 strcpy(opt
->color_context
, def
->color_context
);
419 strcpy(opt
->color_filename
, def
->color_filename
);
420 strcpy(opt
->color_function
, def
->color_function
);
421 strcpy(opt
->color_lineno
, def
->color_lineno
);
422 strcpy(opt
->color_match
, def
->color_match
);
423 strcpy(opt
->color_selected
, def
->color_selected
);
424 strcpy(opt
->color_sep
, def
->color_sep
);
427 static int grep_cmd_config(const char *var
, const char *value
, void *cb
)
429 int st
= grep_config(var
, value
, cb
);
430 if (git_color_default_config(var
, value
, cb
) < 0)
435 static void *lock_and_read_sha1_file(const unsigned char *sha1
, enum object_type
*type
, unsigned long *size
)
440 data
= read_sha1_file(sha1
, type
, size
);
445 static int grep_sha1(struct grep_opt
*opt
, const unsigned char *sha1
,
446 const char *filename
, int tree_name_len
)
448 struct strbuf pathbuf
= STRBUF_INIT
;
450 if (opt
->relative
&& opt
->prefix_length
) {
451 quote_path_relative(filename
+ tree_name_len
, -1, &pathbuf
,
453 strbuf_insert(&pathbuf
, 0, filename
, tree_name_len
);
455 strbuf_addstr(&pathbuf
, filename
);
460 add_work(opt
, GREP_SOURCE_SHA1
, pathbuf
.buf
, sha1
);
461 strbuf_release(&pathbuf
);
466 struct grep_source gs
;
469 grep_source_init(&gs
, GREP_SOURCE_SHA1
, pathbuf
.buf
, sha1
);
470 strbuf_release(&pathbuf
);
471 hit
= grep_source(opt
, &gs
);
473 grep_source_clear(&gs
);
478 static int grep_file(struct grep_opt
*opt
, const char *filename
)
480 struct strbuf buf
= STRBUF_INIT
;
482 if (opt
->relative
&& opt
->prefix_length
)
483 quote_path_relative(filename
, -1, &buf
, opt
->prefix
);
485 strbuf_addstr(&buf
, filename
);
489 add_work(opt
, GREP_SOURCE_FILE
, buf
.buf
, filename
);
490 strbuf_release(&buf
);
495 struct grep_source gs
;
498 grep_source_init(&gs
, GREP_SOURCE_FILE
, buf
.buf
, filename
);
499 strbuf_release(&buf
);
500 hit
= grep_source(opt
, &gs
);
502 grep_source_clear(&gs
);
507 static void append_path(struct grep_opt
*opt
, const void *data
, size_t len
)
509 struct string_list
*path_list
= opt
->output_priv
;
511 if (len
== 1 && *(const char *)data
== '\0')
513 string_list_append(path_list
, xstrndup(data
, len
));
516 static void run_pager(struct grep_opt
*opt
, const char *prefix
)
518 struct string_list
*path_list
= opt
->output_priv
;
519 const char **argv
= xmalloc(sizeof(const char *) * (path_list
->nr
+ 1));
522 for (i
= 0; i
< path_list
->nr
; i
++)
523 argv
[i
] = path_list
->items
[i
].string
;
524 argv
[path_list
->nr
] = NULL
;
526 if (prefix
&& chdir(prefix
))
527 die(_("Failed to chdir: %s"), prefix
);
528 status
= run_command_v_opt(argv
, RUN_USING_SHELL
);
534 static int grep_cache(struct grep_opt
*opt
, const struct pathspec
*pathspec
, int cached
)
540 for (nr
= 0; nr
< active_nr
; nr
++) {
541 struct cache_entry
*ce
= active_cache
[nr
];
542 if (!S_ISREG(ce
->ce_mode
))
544 if (!match_pathspec_depth(pathspec
, ce
->name
, ce_namelen(ce
), 0, NULL
))
547 * If CE_VALID is on, we assume worktree file and its cache entry
548 * are identical, even if worktree file has been modified, so use
549 * cache version instead
551 if (cached
|| (ce
->ce_flags
& CE_VALID
) || ce_skip_worktree(ce
)) {
554 hit
|= grep_sha1(opt
, ce
->sha1
, ce
->name
, 0);
557 hit
|= grep_file(opt
, ce
->name
);
561 } while (nr
< active_nr
&&
562 !strcmp(ce
->name
, active_cache
[nr
]->name
));
563 nr
--; /* compensate for loop control */
565 if (hit
&& opt
->status_only
)
571 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
572 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
)
575 enum interesting match
= entry_not_interesting
;
576 struct name_entry entry
;
577 int old_baselen
= base
->len
;
579 while (tree_entry(tree
, &entry
)) {
580 int te_len
= tree_entry_len(&entry
);
582 if (match
!= all_entries_interesting
) {
583 match
= tree_entry_interesting(&entry
, base
, tn_len
, pathspec
);
584 if (match
== all_entries_not_interesting
)
586 if (match
== entry_not_interesting
)
590 strbuf_add(base
, entry
.path
, te_len
);
592 if (S_ISREG(entry
.mode
)) {
593 hit
|= grep_sha1(opt
, entry
.sha1
, base
->buf
, tn_len
);
595 else if (S_ISDIR(entry
.mode
)) {
596 enum object_type type
;
597 struct tree_desc sub
;
601 data
= lock_and_read_sha1_file(entry
.sha1
, &type
, &size
);
603 die(_("unable to read tree (%s)"),
604 sha1_to_hex(entry
.sha1
));
606 strbuf_addch(base
, '/');
607 init_tree_desc(&sub
, data
, size
);
608 hit
|= grep_tree(opt
, pathspec
, &sub
, base
, tn_len
);
611 strbuf_setlen(base
, old_baselen
);
613 if (hit
&& opt
->status_only
)
619 static int grep_object(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
620 struct object
*obj
, const char *name
)
622 if (obj
->type
== OBJ_BLOB
)
623 return grep_sha1(opt
, obj
->sha1
, name
, 0);
624 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
625 struct tree_desc tree
;
632 data
= read_object_with_reference(obj
->sha1
, tree_type
,
637 die(_("unable to read tree (%s)"), sha1_to_hex(obj
->sha1
));
639 len
= name
? strlen(name
) : 0;
640 strbuf_init(&base
, PATH_MAX
+ len
+ 1);
642 strbuf_add(&base
, name
, len
);
643 strbuf_addch(&base
, ':');
645 init_tree_desc(&tree
, data
, size
);
646 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
);
647 strbuf_release(&base
);
651 die(_("unable to grep from object of type %s"), typename(obj
->type
));
654 static int grep_objects(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
655 const struct object_array
*list
)
659 const unsigned int nr
= list
->nr
;
661 for (i
= 0; i
< nr
; i
++) {
662 struct object
*real_obj
;
663 real_obj
= deref_tag(list
->objects
[i
].item
, NULL
, 0);
664 if (grep_object(opt
, pathspec
, real_obj
, list
->objects
[i
].name
)) {
666 if (opt
->status_only
)
673 static int grep_directory(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
676 struct dir_struct dir
;
679 memset(&dir
, 0, sizeof(dir
));
681 setup_standard_excludes(&dir
);
683 fill_directory(&dir
, pathspec
->raw
);
684 for (i
= 0; i
< dir
.nr
; i
++) {
685 const char *name
= dir
.entries
[i
]->name
;
686 int namelen
= strlen(name
);
687 if (!match_pathspec_depth(pathspec
, name
, namelen
, 0, NULL
))
689 hit
|= grep_file(opt
, dir
.entries
[i
]->name
);
690 if (hit
&& opt
->status_only
)
696 static int context_callback(const struct option
*opt
, const char *arg
,
699 struct grep_opt
*grep_opt
= opt
->value
;
704 grep_opt
->pre_context
= grep_opt
->post_context
= 0;
707 value
= strtol(arg
, (char **)&endp
, 10);
709 return error(_("switch `%c' expects a numerical value"),
712 grep_opt
->pre_context
= grep_opt
->post_context
= value
;
716 static int file_callback(const struct option
*opt
, const char *arg
, int unset
)
718 struct grep_opt
*grep_opt
= opt
->value
;
719 int from_stdin
= !strcmp(arg
, "-");
722 struct strbuf sb
= STRBUF_INIT
;
724 patterns
= from_stdin
? stdin
: fopen(arg
, "r");
726 die_errno(_("cannot open '%s'"), arg
);
727 while (strbuf_getline(&sb
, patterns
, '\n') == 0) {
728 /* ignore empty line like grep does */
732 append_grep_pat(grep_opt
, sb
.buf
, sb
.len
, arg
, ++lno
,
741 static int not_callback(const struct option
*opt
, const char *arg
, int unset
)
743 struct grep_opt
*grep_opt
= opt
->value
;
744 append_grep_pattern(grep_opt
, "--not", "command line", 0, GREP_NOT
);
748 static int and_callback(const struct option
*opt
, const char *arg
, int unset
)
750 struct grep_opt
*grep_opt
= opt
->value
;
751 append_grep_pattern(grep_opt
, "--and", "command line", 0, GREP_AND
);
755 static int open_callback(const struct option
*opt
, const char *arg
, int unset
)
757 struct grep_opt
*grep_opt
= opt
->value
;
758 append_grep_pattern(grep_opt
, "(", "command line", 0, GREP_OPEN_PAREN
);
762 static int close_callback(const struct option
*opt
, const char *arg
, int unset
)
764 struct grep_opt
*grep_opt
= opt
->value
;
765 append_grep_pattern(grep_opt
, ")", "command line", 0, GREP_CLOSE_PAREN
);
769 static int pattern_callback(const struct option
*opt
, const char *arg
,
772 struct grep_opt
*grep_opt
= opt
->value
;
773 append_grep_pattern(grep_opt
, arg
, "-e option", 0, GREP_PATTERN
);
777 static int help_callback(const struct option
*opt
, const char *arg
, int unset
)
782 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
785 int cached
= 0, untracked
= 0, opt_exclude
= -1;
786 int seen_dashdash
= 0;
787 int external_grep_allowed__ignored
;
788 const char *show_in_pager
= NULL
, *default_pager
= "dummy";
790 struct object_array list
= OBJECT_ARRAY_INIT
;
791 const char **paths
= NULL
;
792 struct pathspec pathspec
;
793 struct string_list path_list
= STRING_LIST_INIT_NODUP
;
797 int pattern_type_arg
= GREP_PATTERN_TYPE_UNSPECIFIED
;
799 struct option options
[] = {
800 OPT_BOOLEAN(0, "cached", &cached
,
801 N_("search in index instead of in the work tree")),
802 OPT_NEGBIT(0, "no-index", &use_index
,
803 N_("find in contents not managed by git"), 1),
804 OPT_BOOLEAN(0, "untracked", &untracked
,
805 N_("search in both tracked and untracked files")),
806 OPT_SET_INT(0, "exclude-standard", &opt_exclude
,
807 N_("search also in ignored files"), 1),
809 OPT_BOOLEAN('v', "invert-match", &opt
.invert
,
810 N_("show non-matching lines")),
811 OPT_BOOLEAN('i', "ignore-case", &opt
.ignore_case
,
812 N_("case insensitive matching")),
813 OPT_BOOLEAN('w', "word-regexp", &opt
.word_regexp
,
814 N_("match patterns only at word boundaries")),
815 OPT_SET_INT('a', "text", &opt
.binary
,
816 N_("process binary files as text"), GREP_BINARY_TEXT
),
817 OPT_SET_INT('I', NULL
, &opt
.binary
,
818 N_("don't match patterns in binary files"),
819 GREP_BINARY_NOMATCH
),
820 { OPTION_INTEGER
, 0, "max-depth", &opt
.max_depth
, N_("depth"),
821 N_("descend at most <depth> levels"), PARSE_OPT_NONEG
,
824 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg
,
825 N_("use extended POSIX regular expressions"),
826 GREP_PATTERN_TYPE_ERE
),
827 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg
,
828 N_("use basic POSIX regular expressions (default)"),
829 GREP_PATTERN_TYPE_BRE
),
830 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg
,
831 N_("interpret patterns as fixed strings"),
832 GREP_PATTERN_TYPE_FIXED
),
833 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg
,
834 N_("use Perl-compatible regular expressions"),
835 GREP_PATTERN_TYPE_PCRE
),
837 OPT_BOOLEAN('n', "line-number", &opt
.linenum
, N_("show line numbers")),
838 OPT_NEGBIT('h', NULL
, &opt
.pathname
, N_("don't show filenames"), 1),
839 OPT_BIT('H', NULL
, &opt
.pathname
, N_("show filenames"), 1),
840 OPT_NEGBIT(0, "full-name", &opt
.relative
,
841 N_("show filenames relative to top directory"), 1),
842 OPT_BOOLEAN('l', "files-with-matches", &opt
.name_only
,
843 N_("show only filenames instead of matching lines")),
844 OPT_BOOLEAN(0, "name-only", &opt
.name_only
,
845 N_("synonym for --files-with-matches")),
846 OPT_BOOLEAN('L', "files-without-match",
847 &opt
.unmatch_name_only
,
848 N_("show only the names of files without match")),
849 OPT_BOOLEAN('z', "null", &opt
.null_following_name
,
850 N_("print NUL after filenames")),
851 OPT_BOOLEAN('c', "count", &opt
.count
,
852 N_("show the number of matches instead of matching lines")),
853 OPT__COLOR(&opt
.color
, N_("highlight matches")),
854 OPT_BOOLEAN(0, "break", &opt
.file_break
,
855 N_("print empty line between matches from different files")),
856 OPT_BOOLEAN(0, "heading", &opt
.heading
,
857 N_("show filename only once above matches from same file")),
859 OPT_CALLBACK('C', "context", &opt
, N_("n"),
860 N_("show <n> context lines before and after matches"),
862 OPT_INTEGER('B', "before-context", &opt
.pre_context
,
863 N_("show <n> context lines before matches")),
864 OPT_INTEGER('A', "after-context", &opt
.post_context
,
865 N_("show <n> context lines after matches")),
866 OPT_NUMBER_CALLBACK(&opt
, N_("shortcut for -C NUM"),
868 OPT_BOOLEAN('p', "show-function", &opt
.funcname
,
869 N_("show a line with the function name before matches")),
870 OPT_BOOLEAN('W', "function-context", &opt
.funcbody
,
871 N_("show the surrounding function")),
873 OPT_CALLBACK('f', NULL
, &opt
, N_("file"),
874 N_("read patterns from file"), file_callback
),
875 { OPTION_CALLBACK
, 'e', NULL
, &opt
, N_("pattern"),
876 N_("match <pattern>"), PARSE_OPT_NONEG
, pattern_callback
},
877 { OPTION_CALLBACK
, 0, "and", &opt
, NULL
,
878 N_("combine patterns specified with -e"),
879 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, and_callback
},
880 OPT_BOOLEAN(0, "or", &dummy
, ""),
881 { OPTION_CALLBACK
, 0, "not", &opt
, NULL
, "",
882 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, not_callback
},
883 { OPTION_CALLBACK
, '(', NULL
, &opt
, NULL
, "",
884 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
886 { OPTION_CALLBACK
, ')', NULL
, &opt
, NULL
, "",
887 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
889 OPT__QUIET(&opt
.status_only
,
890 N_("indicate hit with exit status without output")),
891 OPT_BOOLEAN(0, "all-match", &opt
.all_match
,
892 N_("show only matches from files that match all patterns")),
893 { OPTION_SET_INT
, 0, "debug", &opt
.debug
, NULL
,
894 N_("show parse tree for grep expression"),
895 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
, NULL
, 1 },
897 { OPTION_STRING
, 'O', "open-files-in-pager", &show_in_pager
,
898 N_("pager"), N_("show matching files in the pager"),
899 PARSE_OPT_OPTARG
, NULL
, (intptr_t)default_pager
},
900 OPT_BOOLEAN(0, "ext-grep", &external_grep_allowed__ignored
,
901 N_("allow calling of grep(1) (ignored by this build)")),
902 { OPTION_CALLBACK
, 0, "help-all", &options
, NULL
, N_("show usage"),
903 PARSE_OPT_HIDDEN
| PARSE_OPT_NOARG
, help_callback
},
908 * 'git grep -h', unlike 'git grep -h <pattern>', is a request
909 * to show usage information and exit.
911 if (argc
== 2 && !strcmp(argv
[1], "-h"))
912 usage_with_options(grep_usage
, options
);
914 init_grep_defaults();
915 git_config(grep_cmd_config
, NULL
);
916 grep_init(&opt
, prefix
);
919 * If there is no -- then the paths must exist in the working
920 * tree. If there is no explicit pattern specified with -e or
921 * -f, we take the first unrecognized non option to be the
922 * pattern, but then what follows it must be zero or more
923 * valid refs up to the -- (if exists), and then existing
924 * paths. If there is an explicit pattern, then the first
925 * unrecognized non option is the beginning of the refs list
926 * that continues up to the -- (if exists), and then paths.
928 argc
= parse_options(argc
, argv
, prefix
, options
, grep_usage
,
929 PARSE_OPT_KEEP_DASHDASH
|
930 PARSE_OPT_STOP_AT_NON_OPTION
|
931 PARSE_OPT_NO_INTERNAL_HELP
);
933 if (pattern_type_arg
!= GREP_PATTERN_TYPE_UNSPECIFIED
)
934 grep_pattern_type_options(pattern_type_arg
, &opt
);
935 else if (opt
.pattern_type_option
!= GREP_PATTERN_TYPE_UNSPECIFIED
)
936 grep_pattern_type_options(opt
.pattern_type_option
, &opt
);
937 else if (opt
.extended_regexp_option
)
938 grep_pattern_type_options(GREP_PATTERN_TYPE_ERE
, &opt
);
940 if (use_index
&& !startup_info
->have_repository
)
941 /* die the same way as if we did it at the beginning */
942 setup_git_directory();
945 * skip a -- separator; we know it cannot be
946 * separating revisions from pathnames if
947 * we haven't even had any patterns yet
949 if (argc
> 0 && !opt
.pattern_list
&& !strcmp(argv
[0], "--")) {
954 /* First unrecognized non-option token */
955 if (argc
> 0 && !opt
.pattern_list
) {
956 append_grep_pattern(&opt
, argv
[0], "command line", 0,
962 if (show_in_pager
== default_pager
)
963 show_in_pager
= git_pager(1);
967 opt
.null_following_name
= 1;
968 opt
.output_priv
= &path_list
;
969 opt
.output
= append_path
;
970 string_list_append(&path_list
, show_in_pager
);
974 if (!opt
.pattern_list
)
975 die(_("no pattern given."));
976 if (!opt
.fixed
&& opt
.ignore_case
)
977 opt
.regflags
|= REG_ICASE
;
979 compile_grep_patterns(&opt
);
981 /* Check revs and then paths */
982 for (i
= 0; i
< argc
; i
++) {
983 const char *arg
= argv
[i
];
984 unsigned char sha1
[20];
986 if (!get_sha1(arg
, sha1
)) {
987 struct object
*object
= parse_object(sha1
);
989 die(_("bad object %s"), arg
);
990 add_object_array(object
, arg
, &list
);
993 if (!strcmp(arg
, "--")) {
1001 if (list
.nr
|| cached
|| online_cpus() == 1)
1009 if (!(opt
.name_only
|| opt
.unmatch_name_only
|| opt
.count
)
1010 && (opt
.pre_context
|| opt
.post_context
||
1011 opt
.file_break
|| opt
.funcbody
))
1012 skip_first_line
= 1;
1013 start_threads(&opt
);
1017 /* The rest are paths */
1018 if (!seen_dashdash
) {
1020 for (j
= i
; j
< argc
; j
++)
1021 verify_filename(prefix
, argv
[j
], j
== i
);
1024 paths
= get_pathspec(prefix
, argv
+ i
);
1025 init_pathspec(&pathspec
, paths
);
1026 pathspec
.max_depth
= opt
.max_depth
;
1027 pathspec
.recursive
= 1;
1029 if (show_in_pager
&& (cached
|| list
.nr
))
1030 die(_("--open-files-in-pager only works on the worktree"));
1032 if (show_in_pager
&& opt
.pattern_list
&& !opt
.pattern_list
->next
) {
1033 const char *pager
= path_list
.items
[0].string
;
1034 int len
= strlen(pager
);
1036 if (len
> 4 && is_dir_sep(pager
[len
- 5]))
1039 if (!strcmp("less", pager
) || !strcmp("vi", pager
)) {
1040 struct strbuf buf
= STRBUF_INIT
;
1041 strbuf_addf(&buf
, "+/%s%s",
1042 strcmp("less", pager
) ? "" : "*",
1043 opt
.pattern_list
->pattern
);
1044 string_list_append(&path_list
, buf
.buf
);
1045 strbuf_detach(&buf
, NULL
);
1052 if (!use_index
&& (untracked
|| cached
))
1053 die(_("--cached or --untracked cannot be used with --no-index."));
1055 if (!use_index
|| untracked
) {
1056 int use_exclude
= (opt_exclude
< 0) ? use_index
: !!opt_exclude
;
1058 die(_("--no-index or --untracked cannot be used with revs."));
1059 hit
= grep_directory(&opt
, &pathspec
, use_exclude
);
1060 } else if (0 <= opt_exclude
) {
1061 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1062 } else if (!list
.nr
) {
1066 hit
= grep_cache(&opt
, &pathspec
, cached
);
1069 die(_("both --cached and trees are given."));
1070 hit
= grep_objects(&opt
, &pathspec
, &list
);
1075 if (hit
&& show_in_pager
)
1076 run_pager(&opt
, prefix
);
1077 free_grep_patterns(&opt
);