Merge branch 'en/merge-options-doc'
[git.git] / parse-options-cb.c
blob2733393546d4d4dd9a55c5934531398f4a827ead
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"
10 /*----- some often used options -----*/
12 int parse_opt_abbrev_cb(const struct option *opt, const char *arg, int unset)
14 int v;
16 if (!arg) {
17 v = unset ? 0 : DEFAULT_ABBREV;
18 } else {
19 v = strtol(arg, (char **)&arg, 10);
20 if (*arg)
21 return error(_("option `%s' expects a numerical value"),
22 opt->long_name);
23 if (v && v < MINIMUM_ABBREV)
24 v = MINIMUM_ABBREV;
25 else if (v > 40)
26 v = 40;
28 *(int *)(opt->value) = v;
29 return 0;
32 int parse_opt_expiry_date_cb(const struct option *opt, const char *arg,
33 int unset)
35 if (unset)
36 arg = "never";
37 if (parse_expiry_date(arg, (timestamp_t *)opt->value))
38 die(_("malformed expiration date '%s'"), arg);
39 return 0;
42 int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
43 int unset)
45 int value;
47 if (!arg)
48 arg = unset ? "never" : (const char *)opt->defval;
49 value = git_config_colorbool(NULL, arg);
50 if (value < 0)
51 return error(_("option `%s' expects \"always\", \"auto\", or \"never\""),
52 opt->long_name);
53 *(int *)opt->value = value;
54 return 0;
57 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
58 int unset)
60 int *target = opt->value;
62 BUG_ON_OPT_ARG(arg);
64 if (unset)
65 /* --no-quiet, --no-verbose */
66 *target = 0;
67 else if (opt->short_name == 'v') {
68 if (*target >= 0)
69 (*target)++;
70 else
71 *target = 1;
72 } else {
73 if (*target <= 0)
74 (*target)--;
75 else
76 *target = -1;
78 return 0;
81 int parse_opt_commits(const struct option *opt, const char *arg, int unset)
83 struct object_id oid;
84 struct commit *commit;
86 BUG_ON_OPT_NEG(unset);
88 if (!arg)
89 return -1;
90 if (get_oid(arg, &oid))
91 return error("malformed object name %s", arg);
92 commit = lookup_commit_reference(the_repository, &oid);
93 if (!commit)
94 return error("no such commit %s", arg);
95 commit_list_insert(commit, opt->value);
96 return 0;
99 int parse_opt_object_name(const struct option *opt, const char *arg, int unset)
101 struct object_id oid;
103 if (unset) {
104 oid_array_clear(opt->value);
105 return 0;
107 if (!arg)
108 return -1;
109 if (get_oid(arg, &oid))
110 return error(_("malformed object name '%s'"), arg);
111 oid_array_append(opt->value, &oid);
112 return 0;
115 int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
117 int *target = opt->value;
119 BUG_ON_OPT_ARG(arg);
121 *target = unset ? 2 : 1;
122 return 0;
125 struct option *parse_options_concat(struct option *a, struct option *b)
127 struct option *ret;
128 size_t i, a_len = 0, b_len = 0;
130 for (i = 0; a[i].type != OPTION_END; i++)
131 a_len++;
132 for (i = 0; b[i].type != OPTION_END; i++)
133 b_len++;
135 ALLOC_ARRAY(ret, st_add3(a_len, b_len, 1));
136 for (i = 0; i < a_len; i++)
137 ret[i] = a[i];
138 for (i = 0; i < b_len; i++)
139 ret[a_len + i] = b[i];
140 ret[a_len + b_len] = b[b_len]; /* final OPTION_END */
142 return ret;
145 int parse_opt_string_list(const struct option *opt, const char *arg, int unset)
147 struct string_list *v = opt->value;
149 if (unset) {
150 string_list_clear(v, 0);
151 return 0;
154 if (!arg)
155 return -1;
157 string_list_append(v, arg);
158 return 0;
161 int parse_opt_noop_cb(const struct option *opt, const char *arg, int unset)
163 return 0;
167 * Report that the option is unknown, so that other code can handle
168 * it. This can be used as a callback together with
169 * OPTION_LOWLEVEL_CALLBACK to allow an option to be documented in the
170 * "-h" output even if it's not being handled directly by
171 * parse_options().
173 enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
174 const struct option *opt,
175 const char *arg, int unset)
177 BUG_ON_OPT_ARG(arg);
178 return PARSE_OPT_UNKNOWN;
182 * Recreates the command-line option in the strbuf.
184 static int recreate_opt(struct strbuf *sb, const struct option *opt,
185 const char *arg, int unset)
187 strbuf_reset(sb);
189 if (opt->long_name) {
190 strbuf_addstr(sb, unset ? "--no-" : "--");
191 strbuf_addstr(sb, opt->long_name);
192 if (arg) {
193 strbuf_addch(sb, '=');
194 strbuf_addstr(sb, arg);
196 } else if (opt->short_name && !unset) {
197 strbuf_addch(sb, '-');
198 strbuf_addch(sb, opt->short_name);
199 if (arg)
200 strbuf_addstr(sb, arg);
201 } else
202 return -1;
204 return 0;
208 * For an option opt, recreates the command-line option in opt->value which
209 * must be an char* initialized to NULL. This is useful when we need to pass
210 * the command-line option to another command. Since any previous value will be
211 * overwritten, this callback should only be used for options where the last
212 * one wins.
214 int parse_opt_passthru(const struct option *opt, const char *arg, int unset)
216 static struct strbuf sb = STRBUF_INIT;
217 char **opt_value = opt->value;
219 if (recreate_opt(&sb, opt, arg, unset) < 0)
220 return -1;
222 free(*opt_value);
224 *opt_value = strbuf_detach(&sb, NULL);
226 return 0;
230 * For an option opt, recreate the command-line option, appending it to
231 * opt->value which must be a argv_array. This is useful when we need to pass
232 * the command-line option, which can be specified multiple times, to another
233 * command.
235 int parse_opt_passthru_argv(const struct option *opt, const char *arg, int unset)
237 static struct strbuf sb = STRBUF_INIT;
238 struct argv_array *opt_value = opt->value;
240 if (recreate_opt(&sb, opt, arg, unset) < 0)
241 return -1;
243 argv_array_push(opt_value, sb.buf);
245 return 0;