Merge branch 'jk/ls-files-doc-markup-fix'
[git] / list-objects-filter-options.c
1 #include "cache.h"
2 #include "commit.h"
3 #include "config.h"
4 #include "revision.h"
5 #include "argv-array.h"
6 #include "list-objects.h"
7 #include "list-objects-filter.h"
8 #include "list-objects-filter-options.h"
9
10 /*
11  * Parse value of the argument to the "filter" keyword.
12  * On the command line this looks like:
13  *       --filter=<arg>
14  * and in the pack protocol as:
15  *       "filter" SP <arg>
16  *
17  * The filter keyword will be used by many commands.
18  * See Documentation/rev-list-options.txt for allowed values for <arg>.
19  *
20  * Capture the given arg as the "filter_spec".  This can be forwarded to
21  * subordinate commands when necessary (although it's better to pass it through
22  * expand_list_objects_filter_spec() first).  We also "intern" the arg for the
23  * convenience of the current command.
24  */
25 static int gently_parse_list_objects_filter(
26         struct list_objects_filter_options *filter_options,
27         const char *arg,
28         struct strbuf *errbuf)
29 {
30         const char *v0;
31
32         if (filter_options->choice) {
33                 if (errbuf) {
34                         strbuf_addstr(
35                                 errbuf,
36                                 _("multiple filter-specs cannot be combined"));
37                 }
38                 return 1;
39         }
40
41         filter_options->filter_spec = strdup(arg);
42
43         if (!strcmp(arg, "blob:none")) {
44                 filter_options->choice = LOFC_BLOB_NONE;
45                 return 0;
46
47         } else if (skip_prefix(arg, "blob:limit=", &v0)) {
48                 if (git_parse_ulong(v0, &filter_options->blob_limit_value)) {
49                         filter_options->choice = LOFC_BLOB_LIMIT;
50                         return 0;
51                 }
52
53         } else if (skip_prefix(arg, "tree:", &v0)) {
54                 if (!git_parse_ulong(v0, &filter_options->tree_exclude_depth)) {
55                         if (errbuf) {
56                                 strbuf_addstr(
57                                         errbuf,
58                                         _("expected 'tree:<depth>'"));
59                         }
60                         return 1;
61                 }
62                 filter_options->choice = LOFC_TREE_DEPTH;
63                 return 0;
64
65         } else if (skip_prefix(arg, "sparse:oid=", &v0)) {
66                 struct object_context oc;
67                 struct object_id sparse_oid;
68
69                 /*
70                  * Try to parse <oid-expression> into an OID for the current
71                  * command, but DO NOT complain if we don't have the blob or
72                  * ref locally.
73                  */
74                 if (!get_oid_with_context(the_repository, v0, GET_OID_BLOB,
75                                           &sparse_oid, &oc))
76                         filter_options->sparse_oid_value = oiddup(&sparse_oid);
77                 filter_options->choice = LOFC_SPARSE_OID;
78                 return 0;
79
80         } else if (skip_prefix(arg, "sparse:path=", &v0)) {
81                 filter_options->choice = LOFC_SPARSE_PATH;
82                 filter_options->sparse_path_value = strdup(v0);
83                 return 0;
84         }
85         /*
86          * Please update _git_fetch() in git-completion.bash when you
87          * add new filters
88          */
89
90         if (errbuf)
91                 strbuf_addf(errbuf, "invalid filter-spec '%s'", arg);
92
93         memset(filter_options, 0, sizeof(*filter_options));
94         return 1;
95 }
96
97 int parse_list_objects_filter(struct list_objects_filter_options *filter_options,
98                               const char *arg)
99 {
100         struct strbuf buf = STRBUF_INIT;
101         if (gently_parse_list_objects_filter(filter_options, arg, &buf))
102                 die("%s", buf.buf);
103         return 0;
104 }
105
106 int opt_parse_list_objects_filter(const struct option *opt,
107                                   const char *arg, int unset)
108 {
109         struct list_objects_filter_options *filter_options = opt->value;
110
111         if (unset || !arg) {
112                 list_objects_filter_set_no_filter(filter_options);
113                 return 0;
114         }
115
116         return parse_list_objects_filter(filter_options, arg);
117 }
118
119 void expand_list_objects_filter_spec(
120         const struct list_objects_filter_options *filter,
121         struct strbuf *expanded_spec)
122 {
123         strbuf_init(expanded_spec, strlen(filter->filter_spec));
124         if (filter->choice == LOFC_BLOB_LIMIT)
125                 strbuf_addf(expanded_spec, "blob:limit=%lu",
126                             filter->blob_limit_value);
127         else if (filter->choice == LOFC_TREE_DEPTH)
128                 strbuf_addf(expanded_spec, "tree:%lu",
129                             filter->tree_exclude_depth);
130         else
131                 strbuf_addstr(expanded_spec, filter->filter_spec);
132 }
133
134 void list_objects_filter_release(
135         struct list_objects_filter_options *filter_options)
136 {
137         free(filter_options->filter_spec);
138         free(filter_options->sparse_oid_value);
139         free(filter_options->sparse_path_value);
140         memset(filter_options, 0, sizeof(*filter_options));
141 }
142
143 void partial_clone_register(
144         const char *remote,
145         const struct list_objects_filter_options *filter_options)
146 {
147         /*
148          * Record the name of the partial clone remote in the
149          * config and in the global variable -- the latter is
150          * used throughout to indicate that partial clone is
151          * enabled and to expect missing objects.
152          */
153         if (repository_format_partial_clone &&
154             *repository_format_partial_clone &&
155             strcmp(remote, repository_format_partial_clone))
156                 die(_("cannot change partial clone promisor remote"));
157
158         git_config_set("core.repositoryformatversion", "1");
159         git_config_set("extensions.partialclone", remote);
160
161         repository_format_partial_clone = xstrdup(remote);
162
163         /*
164          * Record the initial filter-spec in the config as
165          * the default for subsequent fetches from this remote.
166          */
167         core_partial_clone_filter_default =
168                 xstrdup(filter_options->filter_spec);
169         git_config_set("core.partialclonefilter",
170                        core_partial_clone_filter_default);
171 }
172
173 void partial_clone_get_default_filter_spec(
174         struct list_objects_filter_options *filter_options)
175 {
176         /*
177          * Parse default value, but silently ignore it if it is invalid.
178          */
179         if (!core_partial_clone_filter_default)
180                 return;
181         gently_parse_list_objects_filter(filter_options,
182                                          core_partial_clone_filter_default,
183                                          NULL);
184 }