4 * Copyright (c) 2006 Junio C Hamano
7 #include "repository.h"
13 #include "tree-walk.h"
15 #include "parse-options.h"
16 #include "string-list.h"
17 #include "run-command.h"
23 #include "submodule.h"
24 #include "submodule-config.h"
26 static char const * const grep_usage
[] = {
27 N_("git grep [<options>] [-e] <pattern> [<rev>...] [[--] <path>...]"),
31 static int recurse_submodules
;
33 #define GREP_NUM_THREADS_DEFAULT 8
34 static int num_threads
;
37 static pthread_t
*threads
;
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.
44 struct grep_source source
;
49 /* In the range [todo_done, todo_start) in 'todo' we have work_items
50 * that have been or are processed by a consumer thread. We haven't
51 * written the result for these to stdout yet.
53 * The work_items in [todo_start, todo_end) are waiting to be picked
54 * up by a consumer thread.
56 * The ranges are modulo TODO_SIZE.
59 static struct work_item todo
[TODO_SIZE
];
60 static int todo_start
;
64 /* Has all work items been added? */
65 static int all_work_added
;
67 /* This lock protects all the variables above. */
68 static pthread_mutex_t grep_mutex
;
70 static inline void grep_lock(void)
73 pthread_mutex_lock(&grep_mutex
);
76 static inline void grep_unlock(void)
79 pthread_mutex_unlock(&grep_mutex
);
82 /* Signalled when a new work_item is added to todo. */
83 static pthread_cond_t cond_add
;
85 /* Signalled when the result from one work_item is written to
88 static pthread_cond_t cond_write
;
90 /* Signalled when we are finished with everything. */
91 static pthread_cond_t cond_result
;
93 static int skip_first_line
;
95 static void add_work(struct grep_opt
*opt
, const struct grep_source
*gs
)
99 while ((todo_end
+1) % ARRAY_SIZE(todo
) == todo_done
) {
100 pthread_cond_wait(&cond_write
, &grep_mutex
);
103 todo
[todo_end
].source
= *gs
;
104 if (opt
->binary
!= GREP_BINARY_TEXT
)
105 grep_source_load_driver(&todo
[todo_end
].source
);
106 todo
[todo_end
].done
= 0;
107 strbuf_reset(&todo
[todo_end
].out
);
108 todo_end
= (todo_end
+ 1) % ARRAY_SIZE(todo
);
110 pthread_cond_signal(&cond_add
);
114 static struct work_item
*get_work(void)
116 struct work_item
*ret
;
119 while (todo_start
== todo_end
&& !all_work_added
) {
120 pthread_cond_wait(&cond_add
, &grep_mutex
);
123 if (todo_start
== todo_end
&& all_work_added
) {
126 ret
= &todo
[todo_start
];
127 todo_start
= (todo_start
+ 1) % ARRAY_SIZE(todo
);
133 static void work_done(struct work_item
*w
)
139 old_done
= todo_done
;
140 for(; todo
[todo_done
].done
&& todo_done
!= todo_start
;
141 todo_done
= (todo_done
+1) % ARRAY_SIZE(todo
)) {
142 w
= &todo
[todo_done
];
144 const char *p
= w
->out
.buf
;
145 size_t len
= w
->out
.len
;
147 /* Skip the leading hunk mark of the first file. */
148 if (skip_first_line
) {
157 write_or_die(1, p
, len
);
159 grep_source_clear(&w
->source
);
162 if (old_done
!= todo_done
)
163 pthread_cond_signal(&cond_write
);
165 if (all_work_added
&& todo_done
== todo_end
)
166 pthread_cond_signal(&cond_result
);
171 static void *run(void *arg
)
174 struct grep_opt
*opt
= arg
;
177 struct work_item
*w
= get_work();
181 opt
->output_priv
= w
;
182 hit
|= grep_source(opt
, &w
->source
);
183 grep_source_clear_data(&w
->source
);
186 free_grep_patterns(arg
);
189 return (void*) (intptr_t) hit
;
192 static void strbuf_out(struct grep_opt
*opt
, const void *buf
, size_t size
)
194 struct work_item
*w
= opt
->output_priv
;
195 strbuf_add(&w
->out
, buf
, size
);
198 static void start_threads(struct grep_opt
*opt
)
202 pthread_mutex_init(&grep_mutex
, NULL
);
203 pthread_mutex_init(&grep_read_mutex
, NULL
);
204 pthread_mutex_init(&grep_attr_mutex
, NULL
);
205 pthread_cond_init(&cond_add
, NULL
);
206 pthread_cond_init(&cond_write
, NULL
);
207 pthread_cond_init(&cond_result
, NULL
);
210 for (i
= 0; i
< ARRAY_SIZE(todo
); i
++) {
211 strbuf_init(&todo
[i
].out
, 0);
214 threads
= xcalloc(num_threads
, sizeof(*threads
));
215 for (i
= 0; i
< num_threads
; i
++) {
217 struct grep_opt
*o
= grep_opt_dup(opt
);
218 o
->output
= strbuf_out
;
221 compile_grep_patterns(o
);
222 err
= pthread_create(&threads
[i
], NULL
, run
, o
);
225 die(_("grep: failed to create thread: %s"),
230 static int wait_all(void)
238 /* Wait until all work is done. */
239 while (todo_done
!= todo_end
)
240 pthread_cond_wait(&cond_result
, &grep_mutex
);
242 /* Wake up all the consumer threads so they can see that there
243 * is no more work to do.
245 pthread_cond_broadcast(&cond_add
);
248 for (i
= 0; i
< num_threads
; i
++) {
250 pthread_join(threads
[i
], &h
);
251 hit
|= (int) (intptr_t) h
;
256 pthread_mutex_destroy(&grep_mutex
);
257 pthread_mutex_destroy(&grep_read_mutex
);
258 pthread_mutex_destroy(&grep_attr_mutex
);
259 pthread_cond_destroy(&cond_add
);
260 pthread_cond_destroy(&cond_write
);
261 pthread_cond_destroy(&cond_result
);
266 #else /* !NO_PTHREADS */
268 static int wait_all(void)
274 static int grep_cmd_config(const char *var
, const char *value
, void *cb
)
276 int st
= grep_config(var
, value
, cb
);
277 if (git_color_default_config(var
, value
, cb
) < 0)
280 if (!strcmp(var
, "grep.threads")) {
281 num_threads
= git_config_int(var
, value
);
283 die(_("invalid number of threads specified (%d) for %s"),
286 else if (num_threads
&& num_threads
!= 1) {
288 * TRANSLATORS: %s is the configuration
289 * variable for tweaking threads, currently
292 warning(_("no threads support, ignoring %s"), var
);
298 if (!strcmp(var
, "submodule.recurse"))
299 recurse_submodules
= git_config_bool(var
, value
);
304 static void *lock_and_read_oid_file(const struct object_id
*oid
, enum object_type
*type
, unsigned long *size
)
309 data
= read_sha1_file(oid
->hash
, type
, size
);
314 static int grep_oid(struct grep_opt
*opt
, const struct object_id
*oid
,
315 const char *filename
, int tree_name_len
,
318 struct strbuf pathbuf
= STRBUF_INIT
;
319 struct grep_source gs
;
321 if (opt
->relative
&& opt
->prefix_length
) {
322 quote_path_relative(filename
+ tree_name_len
, opt
->prefix
, &pathbuf
);
323 strbuf_insert(&pathbuf
, 0, filename
, tree_name_len
);
325 strbuf_addstr(&pathbuf
, filename
);
328 grep_source_init(&gs
, GREP_SOURCE_OID
, pathbuf
.buf
, path
, oid
);
333 * add_work() copies gs and thus assumes ownership of
334 * its fields, so do not call grep_source_clear()
337 strbuf_release(&pathbuf
);
344 strbuf_release(&pathbuf
);
345 hit
= grep_source(opt
, &gs
);
347 grep_source_clear(&gs
);
352 static int grep_file(struct grep_opt
*opt
, const char *filename
)
354 struct strbuf buf
= STRBUF_INIT
;
355 struct grep_source gs
;
357 if (opt
->relative
&& opt
->prefix_length
)
358 quote_path_relative(filename
, opt
->prefix
, &buf
);
360 strbuf_addstr(&buf
, filename
);
362 grep_source_init(&gs
, GREP_SOURCE_FILE
, buf
.buf
, filename
, filename
);
367 * add_work() copies gs and thus assumes ownership of
368 * its fields, so do not call grep_source_clear()
371 strbuf_release(&buf
);
378 strbuf_release(&buf
);
379 hit
= grep_source(opt
, &gs
);
381 grep_source_clear(&gs
);
386 static void append_path(struct grep_opt
*opt
, const void *data
, size_t len
)
388 struct string_list
*path_list
= opt
->output_priv
;
390 if (len
== 1 && *(const char *)data
== '\0')
392 string_list_append(path_list
, xstrndup(data
, len
));
395 static void run_pager(struct grep_opt
*opt
, const char *prefix
)
397 struct string_list
*path_list
= opt
->output_priv
;
398 struct child_process child
= CHILD_PROCESS_INIT
;
401 for (i
= 0; i
< path_list
->nr
; i
++)
402 argv_array_push(&child
.args
, path_list
->items
[i
].string
);
406 status
= run_command(&child
);
411 static int grep_cache(struct grep_opt
*opt
, struct repository
*repo
,
412 const struct pathspec
*pathspec
, int cached
);
413 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
414 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
415 int check_attr
, struct repository
*repo
);
417 static int grep_submodule(struct grep_opt
*opt
, struct repository
*superproject
,
418 const struct pathspec
*pathspec
,
419 const struct object_id
*oid
,
420 const char *filename
, const char *path
)
422 struct repository submodule
;
425 if (!is_submodule_active(superproject
, path
))
428 if (repo_submodule_init(&submodule
, superproject
, path
))
431 repo_read_gitmodules(&submodule
);
434 * NEEDSWORK: This adds the submodule's object directory to the list of
435 * alternates for the single in-memory object store. This has some bad
436 * consequences for memory (processed objects will never be freed) and
437 * performance (this increases the number of pack files git has to pay
438 * attention to, to the sum of the number of pack files in all the
439 * repositories processed so far). This can be removed once the object
440 * store is no longer global and instead is a member of the repository
444 add_to_alternates_memory(submodule
.objectdir
);
448 struct object
*object
;
449 struct tree_desc tree
;
452 struct strbuf base
= STRBUF_INIT
;
454 object
= parse_object_or_die(oid
, oid_to_hex(oid
));
457 data
= read_object_with_reference(object
->oid
.hash
, tree_type
,
462 die(_("unable to read tree (%s)"), oid_to_hex(&object
->oid
));
464 strbuf_addstr(&base
, filename
);
465 strbuf_addch(&base
, '/');
467 init_tree_desc(&tree
, data
, size
);
468 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
,
469 object
->type
== OBJ_COMMIT
, &submodule
);
470 strbuf_release(&base
);
473 hit
= grep_cache(opt
, &submodule
, pathspec
, 1);
476 repo_clear(&submodule
);
480 static int grep_cache(struct grep_opt
*opt
, struct repository
*repo
,
481 const struct pathspec
*pathspec
, int cached
)
485 struct strbuf name
= STRBUF_INIT
;
486 int name_base_len
= 0;
487 if (repo
->submodule_prefix
) {
488 name_base_len
= strlen(repo
->submodule_prefix
);
489 strbuf_addstr(&name
, repo
->submodule_prefix
);
492 repo_read_index(repo
);
494 for (nr
= 0; nr
< repo
->index
->cache_nr
; nr
++) {
495 const struct cache_entry
*ce
= repo
->index
->cache
[nr
];
496 strbuf_setlen(&name
, name_base_len
);
497 strbuf_addstr(&name
, ce
->name
);
499 if (S_ISREG(ce
->ce_mode
) &&
500 match_pathspec(pathspec
, name
.buf
, name
.len
, 0, NULL
,
501 S_ISDIR(ce
->ce_mode
) ||
502 S_ISGITLINK(ce
->ce_mode
))) {
504 * If CE_VALID is on, we assume worktree file and its
505 * cache entry are identical, even if worktree file has
506 * been modified, so use cache version instead
508 if (cached
|| (ce
->ce_flags
& CE_VALID
) ||
509 ce_skip_worktree(ce
)) {
510 if (ce_stage(ce
) || ce_intent_to_add(ce
))
512 hit
|= grep_oid(opt
, &ce
->oid
, name
.buf
,
515 hit
|= grep_file(opt
, name
.buf
);
517 } else if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
518 submodule_path_match(pathspec
, name
.buf
, NULL
)) {
519 hit
|= grep_submodule(opt
, repo
, pathspec
, NULL
, ce
->name
, ce
->name
);
527 } while (nr
< repo
->index
->cache_nr
&&
528 !strcmp(ce
->name
, repo
->index
->cache
[nr
]->name
));
529 nr
--; /* compensate for loop control */
531 if (hit
&& opt
->status_only
)
535 strbuf_release(&name
);
539 static int grep_tree(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
540 struct tree_desc
*tree
, struct strbuf
*base
, int tn_len
,
541 int check_attr
, struct repository
*repo
)
544 enum interesting match
= entry_not_interesting
;
545 struct name_entry entry
;
546 int old_baselen
= base
->len
;
547 struct strbuf name
= STRBUF_INIT
;
548 int name_base_len
= 0;
549 if (repo
->submodule_prefix
) {
550 strbuf_addstr(&name
, repo
->submodule_prefix
);
551 name_base_len
= name
.len
;
554 while (tree_entry(tree
, &entry
)) {
555 int te_len
= tree_entry_len(&entry
);
557 if (match
!= all_entries_interesting
) {
558 strbuf_addstr(&name
, base
->buf
+ tn_len
);
559 match
= tree_entry_interesting(&entry
, &name
,
561 strbuf_setlen(&name
, name_base_len
);
563 if (match
== all_entries_not_interesting
)
565 if (match
== entry_not_interesting
)
569 strbuf_add(base
, entry
.path
, te_len
);
571 if (S_ISREG(entry
.mode
)) {
572 hit
|= grep_oid(opt
, entry
.oid
, base
->buf
, tn_len
,
573 check_attr
? base
->buf
+ tn_len
: NULL
);
574 } else if (S_ISDIR(entry
.mode
)) {
575 enum object_type type
;
576 struct tree_desc sub
;
580 data
= lock_and_read_oid_file(entry
.oid
, &type
, &size
);
582 die(_("unable to read tree (%s)"),
583 oid_to_hex(entry
.oid
));
585 strbuf_addch(base
, '/');
586 init_tree_desc(&sub
, data
, size
);
587 hit
|= grep_tree(opt
, pathspec
, &sub
, base
, tn_len
,
590 } else if (recurse_submodules
&& S_ISGITLINK(entry
.mode
)) {
591 hit
|= grep_submodule(opt
, repo
, pathspec
, entry
.oid
,
592 base
->buf
, base
->buf
+ tn_len
);
595 strbuf_setlen(base
, old_baselen
);
597 if (hit
&& opt
->status_only
)
601 strbuf_release(&name
);
605 static int grep_object(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
606 struct object
*obj
, const char *name
, const char *path
,
607 struct repository
*repo
)
609 if (obj
->type
== OBJ_BLOB
)
610 return grep_oid(opt
, &obj
->oid
, name
, 0, path
);
611 if (obj
->type
== OBJ_COMMIT
|| obj
->type
== OBJ_TREE
) {
612 struct tree_desc tree
;
619 data
= read_object_with_reference(obj
->oid
.hash
, tree_type
,
624 die(_("unable to read tree (%s)"), oid_to_hex(&obj
->oid
));
626 len
= name
? strlen(name
) : 0;
627 strbuf_init(&base
, PATH_MAX
+ len
+ 1);
629 strbuf_add(&base
, name
, len
);
630 strbuf_addch(&base
, ':');
632 init_tree_desc(&tree
, data
, size
);
633 hit
= grep_tree(opt
, pathspec
, &tree
, &base
, base
.len
,
634 obj
->type
== OBJ_COMMIT
, repo
);
635 strbuf_release(&base
);
639 die(_("unable to grep from object of type %s"), typename(obj
->type
));
642 static int grep_objects(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
643 struct repository
*repo
,
644 const struct object_array
*list
)
648 const unsigned int nr
= list
->nr
;
650 for (i
= 0; i
< nr
; i
++) {
651 struct object
*real_obj
;
652 real_obj
= deref_tag(list
->objects
[i
].item
, NULL
, 0);
654 /* load the gitmodules file for this rev */
655 if (recurse_submodules
) {
657 gitmodules_config_oid(&real_obj
->oid
);
659 if (grep_object(opt
, pathspec
, real_obj
, list
->objects
[i
].name
, list
->objects
[i
].path
,
662 if (opt
->status_only
)
669 static int grep_directory(struct grep_opt
*opt
, const struct pathspec
*pathspec
,
670 int exc_std
, int use_index
)
672 struct dir_struct dir
;
675 memset(&dir
, 0, sizeof(dir
));
677 dir
.flags
|= DIR_NO_GITLINKS
;
679 setup_standard_excludes(&dir
);
681 fill_directory(&dir
, &the_index
, pathspec
);
682 for (i
= 0; i
< dir
.nr
; i
++) {
683 if (!dir_path_match(dir
.entries
[i
], pathspec
, 0, NULL
))
685 hit
|= grep_file(opt
, dir
.entries
[i
]->name
);
686 if (hit
&& opt
->status_only
)
692 static int context_callback(const struct option
*opt
, const char *arg
,
695 struct grep_opt
*grep_opt
= opt
->value
;
700 grep_opt
->pre_context
= grep_opt
->post_context
= 0;
703 value
= strtol(arg
, (char **)&endp
, 10);
705 return error(_("switch `%c' expects a numerical value"),
708 grep_opt
->pre_context
= grep_opt
->post_context
= value
;
712 static int file_callback(const struct option
*opt
, const char *arg
, int unset
)
714 struct grep_opt
*grep_opt
= opt
->value
;
715 int from_stdin
= !strcmp(arg
, "-");
718 struct strbuf sb
= STRBUF_INIT
;
720 patterns
= from_stdin
? stdin
: fopen(arg
, "r");
722 die_errno(_("cannot open '%s'"), arg
);
723 while (strbuf_getline(&sb
, patterns
) == 0) {
724 /* ignore empty line like grep does */
728 append_grep_pat(grep_opt
, sb
.buf
, sb
.len
, arg
, ++lno
,
737 static int not_callback(const struct option
*opt
, const char *arg
, int unset
)
739 struct grep_opt
*grep_opt
= opt
->value
;
740 append_grep_pattern(grep_opt
, "--not", "command line", 0, GREP_NOT
);
744 static int and_callback(const struct option
*opt
, const char *arg
, int unset
)
746 struct grep_opt
*grep_opt
= opt
->value
;
747 append_grep_pattern(grep_opt
, "--and", "command line", 0, GREP_AND
);
751 static int open_callback(const struct option
*opt
, const char *arg
, int unset
)
753 struct grep_opt
*grep_opt
= opt
->value
;
754 append_grep_pattern(grep_opt
, "(", "command line", 0, GREP_OPEN_PAREN
);
758 static int close_callback(const struct option
*opt
, const char *arg
, int unset
)
760 struct grep_opt
*grep_opt
= opt
->value
;
761 append_grep_pattern(grep_opt
, ")", "command line", 0, GREP_CLOSE_PAREN
);
765 static int pattern_callback(const struct option
*opt
, const char *arg
,
768 struct grep_opt
*grep_opt
= opt
->value
;
769 append_grep_pattern(grep_opt
, arg
, "-e option", 0, GREP_PATTERN
);
773 int cmd_grep(int argc
, const char **argv
, const char *prefix
)
776 int cached
= 0, untracked
= 0, opt_exclude
= -1;
777 int seen_dashdash
= 0;
778 int external_grep_allowed__ignored
;
779 const char *show_in_pager
= NULL
, *default_pager
= "dummy";
781 struct object_array list
= OBJECT_ARRAY_INIT
;
782 struct pathspec pathspec
;
783 struct string_list path_list
= STRING_LIST_INIT_NODUP
;
787 int pattern_type_arg
= GREP_PATTERN_TYPE_UNSPECIFIED
;
790 struct option options
[] = {
791 OPT_BOOL(0, "cached", &cached
,
792 N_("search in index instead of in the work tree")),
793 OPT_NEGBIT(0, "no-index", &use_index
,
794 N_("find in contents not managed by git"), 1),
795 OPT_BOOL(0, "untracked", &untracked
,
796 N_("search in both tracked and untracked files")),
797 OPT_SET_INT(0, "exclude-standard", &opt_exclude
,
798 N_("ignore files specified via '.gitignore'"), 1),
799 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
800 N_("recursively search in each submodule")),
802 OPT_BOOL('v', "invert-match", &opt
.invert
,
803 N_("show non-matching lines")),
804 OPT_BOOL('i', "ignore-case", &opt
.ignore_case
,
805 N_("case insensitive matching")),
806 OPT_BOOL('w', "word-regexp", &opt
.word_regexp
,
807 N_("match patterns only at word boundaries")),
808 OPT_SET_INT('a', "text", &opt
.binary
,
809 N_("process binary files as text"), GREP_BINARY_TEXT
),
810 OPT_SET_INT('I', NULL
, &opt
.binary
,
811 N_("don't match patterns in binary files"),
812 GREP_BINARY_NOMATCH
),
813 OPT_BOOL(0, "textconv", &opt
.allow_textconv
,
814 N_("process binary files with textconv filters")),
815 { OPTION_INTEGER
, 0, "max-depth", &opt
.max_depth
, N_("depth"),
816 N_("descend at most <depth> levels"), PARSE_OPT_NONEG
,
819 OPT_SET_INT('E', "extended-regexp", &pattern_type_arg
,
820 N_("use extended POSIX regular expressions"),
821 GREP_PATTERN_TYPE_ERE
),
822 OPT_SET_INT('G', "basic-regexp", &pattern_type_arg
,
823 N_("use basic POSIX regular expressions (default)"),
824 GREP_PATTERN_TYPE_BRE
),
825 OPT_SET_INT('F', "fixed-strings", &pattern_type_arg
,
826 N_("interpret patterns as fixed strings"),
827 GREP_PATTERN_TYPE_FIXED
),
828 OPT_SET_INT('P', "perl-regexp", &pattern_type_arg
,
829 N_("use Perl-compatible regular expressions"),
830 GREP_PATTERN_TYPE_PCRE
),
832 OPT_BOOL('n', "line-number", &opt
.linenum
, N_("show line numbers")),
833 OPT_NEGBIT('h', NULL
, &opt
.pathname
, N_("don't show filenames"), 1),
834 OPT_BIT('H', NULL
, &opt
.pathname
, N_("show filenames"), 1),
835 OPT_NEGBIT(0, "full-name", &opt
.relative
,
836 N_("show filenames relative to top directory"), 1),
837 OPT_BOOL('l', "files-with-matches", &opt
.name_only
,
838 N_("show only filenames instead of matching lines")),
839 OPT_BOOL(0, "name-only", &opt
.name_only
,
840 N_("synonym for --files-with-matches")),
841 OPT_BOOL('L', "files-without-match",
842 &opt
.unmatch_name_only
,
843 N_("show only the names of files without match")),
844 OPT_BOOL('z', "null", &opt
.null_following_name
,
845 N_("print NUL after filenames")),
846 OPT_BOOL('c', "count", &opt
.count
,
847 N_("show the number of matches instead of matching lines")),
848 OPT__COLOR(&opt
.color
, N_("highlight matches")),
849 OPT_BOOL(0, "break", &opt
.file_break
,
850 N_("print empty line between matches from different files")),
851 OPT_BOOL(0, "heading", &opt
.heading
,
852 N_("show filename only once above matches from same file")),
854 OPT_CALLBACK('C', "context", &opt
, N_("n"),
855 N_("show <n> context lines before and after matches"),
857 OPT_INTEGER('B', "before-context", &opt
.pre_context
,
858 N_("show <n> context lines before matches")),
859 OPT_INTEGER('A', "after-context", &opt
.post_context
,
860 N_("show <n> context lines after matches")),
861 OPT_INTEGER(0, "threads", &num_threads
,
862 N_("use <n> worker threads")),
863 OPT_NUMBER_CALLBACK(&opt
, N_("shortcut for -C NUM"),
865 OPT_BOOL('p', "show-function", &opt
.funcname
,
866 N_("show a line with the function name before matches")),
867 OPT_BOOL('W', "function-context", &opt
.funcbody
,
868 N_("show the surrounding function")),
870 OPT_CALLBACK('f', NULL
, &opt
, N_("file"),
871 N_("read patterns from file"), file_callback
),
872 { OPTION_CALLBACK
, 'e', NULL
, &opt
, N_("pattern"),
873 N_("match <pattern>"), PARSE_OPT_NONEG
, pattern_callback
},
874 { OPTION_CALLBACK
, 0, "and", &opt
, NULL
,
875 N_("combine patterns specified with -e"),
876 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, and_callback
},
877 OPT_BOOL(0, "or", &dummy
, ""),
878 { OPTION_CALLBACK
, 0, "not", &opt
, NULL
, "",
879 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, not_callback
},
880 { OPTION_CALLBACK
, '(', NULL
, &opt
, NULL
, "",
881 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
883 { OPTION_CALLBACK
, ')', NULL
, &opt
, NULL
, "",
884 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
| PARSE_OPT_NODASH
,
886 OPT__QUIET(&opt
.status_only
,
887 N_("indicate hit with exit status without output")),
888 OPT_BOOL(0, "all-match", &opt
.all_match
,
889 N_("show only matches from files that match all patterns")),
890 { OPTION_SET_INT
, 0, "debug", &opt
.debug
, NULL
,
891 N_("show parse tree for grep expression"),
892 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
, NULL
, 1 },
894 { OPTION_STRING
, 'O', "open-files-in-pager", &show_in_pager
,
895 N_("pager"), N_("show matching files in the pager"),
896 PARSE_OPT_OPTARG
, NULL
, (intptr_t)default_pager
},
897 OPT_BOOL(0, "ext-grep", &external_grep_allowed__ignored
,
898 N_("allow calling of grep(1) (ignored by this build)")),
902 init_grep_defaults();
903 git_config(grep_cmd_config
, NULL
);
904 grep_init(&opt
, prefix
);
907 * If there is no -- then the paths must exist in the working
908 * tree. If there is no explicit pattern specified with -e or
909 * -f, we take the first unrecognized non option to be the
910 * pattern, but then what follows it must be zero or more
911 * valid refs up to the -- (if exists), and then existing
912 * paths. If there is an explicit pattern, then the first
913 * unrecognized non option is the beginning of the refs list
914 * that continues up to the -- (if exists), and then paths.
916 argc
= parse_options(argc
, argv
, prefix
, options
, grep_usage
,
917 PARSE_OPT_KEEP_DASHDASH
|
918 PARSE_OPT_STOP_AT_NON_OPTION
);
919 grep_commit_pattern_type(pattern_type_arg
, &opt
);
921 if (use_index
&& !startup_info
->have_repository
) {
923 git_config_get_bool("grep.fallbacktonoindex", &fallback
);
927 /* die the same way as if we did it at the beginning */
928 setup_git_directory();
932 * skip a -- separator; we know it cannot be
933 * separating revisions from pathnames if
934 * we haven't even had any patterns yet
936 if (argc
> 0 && !opt
.pattern_list
&& !strcmp(argv
[0], "--")) {
941 /* First unrecognized non-option token */
942 if (argc
> 0 && !opt
.pattern_list
) {
943 append_grep_pattern(&opt
, argv
[0], "command line", 0,
949 if (show_in_pager
== default_pager
)
950 show_in_pager
= git_pager(1);
954 opt
.null_following_name
= 1;
955 opt
.output_priv
= &path_list
;
956 opt
.output
= append_path
;
957 string_list_append(&path_list
, show_in_pager
);
960 if (!opt
.pattern_list
)
961 die(_("no pattern given."));
964 * We have to find "--" in a separate pass, because its presence
965 * influences how we will parse arguments that come before it.
967 for (i
= 0; i
< argc
; i
++) {
968 if (!strcmp(argv
[i
], "--")) {
975 * Resolve any rev arguments. If we have a dashdash, then everything up
976 * to it must resolve as a rev. If not, then we stop at the first
977 * non-rev and assume everything else is a path.
979 allow_revs
= use_index
&& !untracked
;
980 for (i
= 0; i
< argc
; i
++) {
981 const char *arg
= argv
[i
];
982 struct object_id oid
;
983 struct object_context oc
;
984 struct object
*object
;
986 if (!strcmp(arg
, "--")) {
993 die(_("--no-index or --untracked cannot be used with revs"));
997 if (get_oid_with_context(arg
, GET_OID_RECORD_PATH
,
1000 die(_("unable to resolve revision: %s"), arg
);
1004 object
= parse_object_or_die(&oid
, arg
);
1006 verify_non_filename(prefix
, arg
);
1007 add_object_array_with_path(object
, arg
, &list
, oc
.mode
, oc
.path
);
1012 * Anything left over is presumed to be a path. But in the non-dashdash
1013 * "do what I mean" case, we verify and complain when that isn't true.
1015 if (!seen_dashdash
) {
1017 for (j
= i
; j
< argc
; j
++)
1018 verify_filename(prefix
, argv
[j
], j
== i
&& allow_revs
);
1021 parse_pathspec(&pathspec
, 0,
1022 PATHSPEC_PREFER_CWD
|
1023 (opt
.max_depth
!= -1 ? PATHSPEC_MAXDEPTH_VALID
: 0),
1025 pathspec
.max_depth
= opt
.max_depth
;
1026 pathspec
.recursive
= 1;
1027 pathspec
.recurse_submodules
= !!recurse_submodules
;
1030 if (list
.nr
|| cached
|| show_in_pager
)
1032 else if (num_threads
== 0)
1033 num_threads
= GREP_NUM_THREADS_DEFAULT
;
1034 else if (num_threads
< 0)
1035 die(_("invalid number of threads specified (%d)"), num_threads
);
1036 if (num_threads
== 1)
1040 warning(_("no threads support, ignoring --threads"));
1046 * The compiled patterns on the main path are only
1047 * used when not using threading. Otherwise
1048 * start_threads() below calls compile_grep_patterns()
1051 compile_grep_patterns(&opt
);
1055 if (!(opt
.name_only
|| opt
.unmatch_name_only
|| opt
.count
)
1056 && (opt
.pre_context
|| opt
.post_context
||
1057 opt
.file_break
|| opt
.funcbody
))
1058 skip_first_line
= 1;
1059 start_threads(&opt
);
1063 if (show_in_pager
&& (cached
|| list
.nr
))
1064 die(_("--open-files-in-pager only works on the worktree"));
1066 if (show_in_pager
&& opt
.pattern_list
&& !opt
.pattern_list
->next
) {
1067 const char *pager
= path_list
.items
[0].string
;
1068 int len
= strlen(pager
);
1070 if (len
> 4 && is_dir_sep(pager
[len
- 5]))
1073 if (opt
.ignore_case
&& !strcmp("less", pager
))
1074 string_list_append(&path_list
, "-I");
1076 if (!strcmp("less", pager
) || !strcmp("vi", pager
)) {
1077 struct strbuf buf
= STRBUF_INIT
;
1078 strbuf_addf(&buf
, "+/%s%s",
1079 strcmp("less", pager
) ? "" : "*",
1080 opt
.pattern_list
->pattern
);
1081 string_list_append(&path_list
, buf
.buf
);
1082 strbuf_detach(&buf
, NULL
);
1086 if (recurse_submodules
&& (!use_index
|| untracked
))
1087 die(_("option not supported with --recurse-submodules."));
1089 if (!show_in_pager
&& !opt
.status_only
)
1092 if (!use_index
&& (untracked
|| cached
))
1093 die(_("--cached or --untracked cannot be used with --no-index."));
1095 if (!use_index
|| untracked
) {
1096 int use_exclude
= (opt_exclude
< 0) ? use_index
: !!opt_exclude
;
1097 hit
= grep_directory(&opt
, &pathspec
, use_exclude
, use_index
);
1098 } else if (0 <= opt_exclude
) {
1099 die(_("--[no-]exclude-standard cannot be used for tracked contents."));
1100 } else if (!list
.nr
) {
1104 hit
= grep_cache(&opt
, the_repository
, &pathspec
, cached
);
1107 die(_("both --cached and trees are given."));
1109 hit
= grep_objects(&opt
, &pathspec
, the_repository
, &list
);
1114 if (hit
&& show_in_pager
)
1115 run_pager(&opt
, prefix
);
1116 clear_pathspec(&pathspec
);
1117 free_grep_patterns(&opt
);