list-objects-filter: use empty string instead of NULL for sparse "base"
[git/git.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 filter_options->sparse_oid_name = xstrdup(v0);
67 filter_options->choice = LOFC_SPARSE_OID;
68 return 0;
69
70 } else if (skip_prefix(arg, "sparse:path=", &v0)) {
71 if (errbuf) {
72 strbuf_addstr(
73 errbuf,
74 _("sparse:path filters support has been dropped"));
75 }
76 return 1;
77 }
78 /*
79 * Please update _git_fetch() in git-completion.bash when you
80 * add new filters
81 */
82
83 if (errbuf)
84 strbuf_addf(errbuf, _("invalid filter-spec '%s'"), arg);
85
86 memset(filter_options, 0, sizeof(*filter_options));
87 return 1;
88 }
89
90 int parse_list_objects_filter(struct list_objects_filter_options *filter_options,
91 const char *arg)
92 {
93 struct strbuf buf = STRBUF_INIT;
94 if (gently_parse_list_objects_filter(filter_options, arg, &buf))
95 die("%s", buf.buf);
96 return 0;
97 }
98
99 int opt_parse_list_objects_filter(const struct option *opt,
100 const char *arg, int unset)
101 {
102 struct list_objects_filter_options *filter_options = opt->value;
103
104 if (unset || !arg) {
105 list_objects_filter_set_no_filter(filter_options);
106 return 0;
107 }
108
109 return parse_list_objects_filter(filter_options, arg);
110 }
111
112 void expand_list_objects_filter_spec(
113 const struct list_objects_filter_options *filter,
114 struct strbuf *expanded_spec)
115 {
116 strbuf_init(expanded_spec, strlen(filter->filter_spec));
117 if (filter->choice == LOFC_BLOB_LIMIT)
118 strbuf_addf(expanded_spec, "blob:limit=%lu",
119 filter->blob_limit_value);
120 else if (filter->choice == LOFC_TREE_DEPTH)
121 strbuf_addf(expanded_spec, "tree:%lu",
122 filter->tree_exclude_depth);
123 else
124 strbuf_addstr(expanded_spec, filter->filter_spec);
125 }
126
127 void list_objects_filter_release(
128 struct list_objects_filter_options *filter_options)
129 {
130 free(filter_options->filter_spec);
131 free(filter_options->sparse_oid_name);
132 memset(filter_options, 0, sizeof(*filter_options));
133 }
134
135 void partial_clone_register(
136 const char *remote,
137 const struct list_objects_filter_options *filter_options)
138 {
139 /*
140 * Record the name of the partial clone remote in the
141 * config and in the global variable -- the latter is
142 * used throughout to indicate that partial clone is
143 * enabled and to expect missing objects.
144 */
145 if (repository_format_partial_clone &&
146 *repository_format_partial_clone &&
147 strcmp(remote, repository_format_partial_clone))
148 die(_("cannot change partial clone promisor remote"));
149
150 git_config_set("core.repositoryformatversion", "1");
151 git_config_set("extensions.partialclone", remote);
152
153 repository_format_partial_clone = xstrdup(remote);
154
155 /*
156 * Record the initial filter-spec in the config as
157 * the default for subsequent fetches from this remote.
158 */
159 core_partial_clone_filter_default =
160 xstrdup(filter_options->filter_spec);
161 git_config_set("core.partialclonefilter",
162 core_partial_clone_filter_default);
163 }
164
165 void partial_clone_get_default_filter_spec(
166 struct list_objects_filter_options *filter_options)
167 {
168 /*
169 * Parse default value, but silently ignore it if it is invalid.
170 */
171 if (!core_partial_clone_filter_default)
172 return;
173 gently_parse_list_objects_filter(filter_options,
174 core_partial_clone_filter_default,
175 NULL);
176 }