Merge branch 'jc/update-index-doc'
[git] / builtin / for-each-ref.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "config.h"
4 #include "refs.h"
5 #include "object.h"
6 #include "parse-options.h"
7 #include "ref-filter.h"
8
9 static char const * const for_each_ref_usage[] = {
10         N_("git for-each-ref [<options>] [<pattern>]"),
11         N_("git for-each-ref [--points-at <object>]"),
12         N_("git for-each-ref [(--merged | --no-merged) [<commit>]]"),
13         N_("git for-each-ref [--contains [<commit>]] [--no-contains [<commit>]]"),
14         NULL
15 };
16
17 int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
18 {
19         int i;
20         struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
21         int maxcount = 0, icase = 0;
22         struct ref_array array;
23         struct ref_filter filter;
24         struct ref_format format = REF_FORMAT_INIT;
25
26         struct option opts[] = {
27                 OPT_BIT('s', "shell", &format.quote_style,
28                         N_("quote placeholders suitably for shells"), QUOTE_SHELL),
29                 OPT_BIT('p', "perl",  &format.quote_style,
30                         N_("quote placeholders suitably for perl"), QUOTE_PERL),
31                 OPT_BIT(0 , "python", &format.quote_style,
32                         N_("quote placeholders suitably for python"), QUOTE_PYTHON),
33                 OPT_BIT(0 , "tcl",  &format.quote_style,
34                         N_("quote placeholders suitably for Tcl"), QUOTE_TCL),
35
36                 OPT_GROUP(""),
37                 OPT_INTEGER( 0 , "count", &maxcount, N_("show only <n> matched refs")),
38                 OPT_STRING(  0 , "format", &format.format, N_("format"), N_("format to use for the output")),
39                 OPT__COLOR(&format.use_color, N_("respect format colors")),
40                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
41                             N_("field name to sort on"), &parse_opt_ref_sorting),
42                 OPT_CALLBACK(0, "points-at", &filter.points_at,
43                              N_("object"), N_("print only refs which points at the given object"),
44                              parse_opt_object_name),
45                 OPT_MERGED(&filter, N_("print only refs that are merged")),
46                 OPT_NO_MERGED(&filter, N_("print only refs that are not merged")),
47                 OPT_CONTAINS(&filter.with_commit, N_("print only refs which contain the commit")),
48                 OPT_NO_CONTAINS(&filter.no_commit, N_("print only refs which don't contain the commit")),
49                 OPT_BOOL(0, "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
50                 OPT_END(),
51         };
52
53         memset(&array, 0, sizeof(array));
54         memset(&filter, 0, sizeof(filter));
55
56         format.format = "%(objectname) %(objecttype)\t%(refname)";
57
58         git_config(git_default_config, NULL);
59
60         parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
61         if (maxcount < 0) {
62                 error("invalid --count argument: `%d'", maxcount);
63                 usage_with_options(for_each_ref_usage, opts);
64         }
65         if (HAS_MULTI_BITS(format.quote_style)) {
66                 error("more than one quoting style?");
67                 usage_with_options(for_each_ref_usage, opts);
68         }
69         if (verify_ref_format(&format))
70                 usage_with_options(for_each_ref_usage, opts);
71
72         if (!sorting)
73                 sorting = ref_default_sorting();
74         sorting->ignore_case = icase;
75         filter.ignore_case = icase;
76
77         filter.name_patterns = argv;
78         filter.match_as_path = 1;
79         filter_refs(&array, &filter, FILTER_REFS_ALL | FILTER_REFS_INCLUDE_BROKEN);
80         ref_array_sort(sorting, &array);
81
82         if (!maxcount || array.nr < maxcount)
83                 maxcount = array.nr;
84         for (i = 0; i < maxcount; i++)
85                 show_ref_array_item(array.items[i], &format);
86         ref_array_clear(&array);
87         return 0;
88 }