Merge branch 'jk/doc-credential-helper' into maint
[git] / parse-options-cb.c
1 #include "git-compat-util.h"
2 #include "parse-options.h"
3 #include "cache.h"
4 #include "commit.h"
5 #include "color.h"
6 #include "string-list.h"
7 #include "argv-array.h"
8 #include "sha1-array.h"
9
10 /*----- some often used options -----*/
11
12 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
13 {
14         int v;
15
16         if (!arg) {
17                 v = unset ? 0 : DEFAULT_ABBREV;
18         } else {
19                 if (!*arg)
20                         return error(_("option `%s' expects a numerical value"),
21                                      opt->long_name);
22                 v = strtol(arg, (char **)&arg, 10);
23                 if (*arg)
24                         return error(_("option `%s' expects a numerical value"),
25                                      opt->long_name);
26                 if (v && v < MINIMUM_ABBREV)
27                         v = MINIMUM_ABBREV;
28                 else if (v > the_hash_algo->hexsz)
29                         v = the_hash_algo->hexsz;
30         }
31         *(int *)(opt->value) = v;
32         return 0;
33 }
34
35 int parse_opt_expiry_date_cb(const struct option *opt, const char *arg,
36                              int unset)
37 {
38         if (unset)
39                 arg = "never";
40         if (parse_expiry_date(arg, (timestamp_t *)opt->value))
41                 die(_("malformed expiration date '%s'"), arg);
42         return 0;
43 }
44
45 int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
46                             int unset)
47 {
48         int value;
49
50         if (!arg)
51                 arg = unset ? "never" : (const char *)opt->defval;
52         value = git_config_colorbool(NULL, arg);
53         if (value < 0)
54                 return error(_("option `%s' expects \"always\", \"auto\", or \"never\""),
55                              opt->long_name);
56         *(int *)opt->value = value;
57         return 0;
58 }
59
60 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
61                            int unset)
62 {
63         int *target = opt->value;
64
65         BUG_ON_OPT_ARG(arg);
66
67         if (unset)
68                 /* --no-quiet, --no-verbose */
69                 *target = 0;
70         else if (opt->short_name == 'v') {
71                 if (*target >= 0)
72                         (*target)++;
73                 else
74                         *target = 1;
75         } else {
76                 if (*target <= 0)
77                         (*target)--;
78                 else
79                         *target = -1;
80         }
81         return 0;
82 }
83
84 int parse_opt_commits(const struct option *opt, const char *arg, int unset)
85 {
86         struct object_id oid;
87         struct commit *commit;
88
89         BUG_ON_OPT_NEG(unset);
90
91         if (!arg)
92                 return -1;
93         if (get_oid(arg, &oid))
94                 return error("malformed object name %s", arg);
95         commit = lookup_commit_reference(the_repository, &oid);
96         if (!commit)
97                 return error("no such commit %s", arg);
98         commit_list_insert(commit, opt->value);
99         return 0;
100 }
101
102 int parse_opt_commit(const struct option *opt, const char *arg, int unset)
103 {
104         struct object_id oid;
105         struct commit *commit;
106         struct commit **target = opt->value;
107
108         if (!arg)
109                 return -1;
110         if (get_oid(arg, &oid))
111                 return error("malformed object name %s", arg);
112         commit = lookup_commit_reference(the_repository, &oid);
113         if (!commit)
114                 return error("no such commit %s", arg);
115         *target = commit;
116         return 0;
117 }
118
119 int parse_opt_object_name(const struct option *opt, const char *arg, int unset)
120 {
121         struct object_id oid;
122
123         if (unset) {
124                 oid_array_clear(opt->value);
125                 return 0;
126         }
127         if (!arg)
128                 return -1;
129         if (get_oid(arg, &oid))
130                 return error(_("malformed object name '%s'"), arg);
131         oid_array_append(opt->value, &oid);
132         return 0;
133 }
134
135 int parse_opt_object_id(const struct option *opt, const char *arg, int unset)
136 {
137         struct object_id oid;
138         struct object_id *target = opt->value;
139
140         if (unset) {
141                 *target = null_oid;
142                 return 0;
143         }
144         if (!arg)
145                 return -1;
146         if (get_oid(arg, &oid))
147                 return error(_("malformed object name '%s'"), arg);
148         *target = oid;
149         return 0;
150 }
151
152 int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
153 {
154         int *target = opt->value;
155
156         BUG_ON_OPT_ARG(arg);
157
158         *target = unset ? 2 : 1;
159         return 0;
160 }
161
162 struct option *parse_options_dup(const struct option *o)
163 {
164         const struct option *orig = o;
165         struct option *opts;
166         int nr = 0;
167
168         while (o && o->type != OPTION_END) {
169                 nr++;
170                 o++;
171         }
172
173         ALLOC_ARRAY(opts, nr + 1);
174         COPY_ARRAY(opts, orig, nr);
175         memset(opts + nr, 0, sizeof(*opts));
176         opts[nr].type = OPTION_END;
177         return opts;
178 }
179
180 struct option *parse_options_concat(struct option *a, struct option *b)
181 {
182         struct option *ret;
183         size_t i, a_len = 0, b_len = 0;
184
185         for (i = 0; a[i].type != OPTION_END; i++)
186                 a_len++;
187         for (i = 0; b[i].type != OPTION_END; i++)
188                 b_len++;
189
190         ALLOC_ARRAY(ret, st_add3(a_len, b_len, 1));
191         for (i = 0; i < a_len; i++)
192                 ret[i] = a[i];
193         for (i = 0; i < b_len; i++)
194                 ret[a_len + i] = b[i];
195         ret[a_len + b_len] = b[b_len]; /* final OPTION_END */
196
197         return ret;
198 }
199
200 int parse_opt_string_list(const struct option *opt, const char *arg, int unset)
201 {
202         struct string_list *v = opt->value;
203
204         if (unset) {
205                 string_list_clear(v, 0);
206                 return 0;
207         }
208
209         if (!arg)
210                 return -1;
211
212         string_list_append(v, arg);
213         return 0;
214 }
215
216 int parse_opt_noop_cb(const struct option *opt, const char *arg, int unset)
217 {
218         return 0;
219 }
220
221 /**
222  * Report that the option is unknown, so that other code can handle
223  * it. This can be used as a callback together with
224  * OPTION_LOWLEVEL_CALLBACK to allow an option to be documented in the
225  * "-h" output even if it's not being handled directly by
226  * parse_options().
227  */
228 enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
229                                            const struct option *opt,
230                                            const char *arg, int unset)
231 {
232         BUG_ON_OPT_ARG(arg);
233         return PARSE_OPT_UNKNOWN;
234 }
235
236 /**
237  * Recreates the command-line option in the strbuf.
238  */
239 static int recreate_opt(struct strbuf *sb, const struct option *opt,
240                 const char *arg, int unset)
241 {
242         strbuf_reset(sb);
243
244         if (opt->long_name) {
245                 strbuf_addstr(sb, unset ? "--no-" : "--");
246                 strbuf_addstr(sb, opt->long_name);
247                 if (arg) {
248                         strbuf_addch(sb, '=');
249                         strbuf_addstr(sb, arg);
250                 }
251         } else if (opt->short_name && !unset) {
252                 strbuf_addch(sb, '-');
253                 strbuf_addch(sb, opt->short_name);
254                 if (arg)
255                         strbuf_addstr(sb, arg);
256         } else
257                 return -1;
258
259         return 0;
260 }
261
262 /**
263  * For an option opt, recreates the command-line option in opt->value which
264  * must be an char* initialized to NULL. This is useful when we need to pass
265  * the command-line option to another command. Since any previous value will be
266  * overwritten, this callback should only be used for options where the last
267  * one wins.
268  */
269 int parse_opt_passthru(const struct option *opt, const char *arg, int unset)
270 {
271         static struct strbuf sb = STRBUF_INIT;
272         char **opt_value = opt->value;
273
274         if (recreate_opt(&sb, opt, arg, unset) < 0)
275                 return -1;
276
277         free(*opt_value);
278
279         *opt_value = strbuf_detach(&sb, NULL);
280
281         return 0;
282 }
283
284 /**
285  * For an option opt, recreate the command-line option, appending it to
286  * opt->value which must be a argv_array. This is useful when we need to pass
287  * the command-line option, which can be specified multiple times, to another
288  * command.
289  */
290 int parse_opt_passthru_argv(const struct option *opt, const char *arg, int unset)
291 {
292         static struct strbuf sb = STRBUF_INIT;
293         struct argv_array *opt_value = opt->value;
294
295         if (recreate_opt(&sb, opt, arg, unset) < 0)
296                 return -1;
297
298         argv_array_push(opt_value, sb.buf);
299
300         return 0;
301 }