docs: explain how to deal with files that are always modified
[git.git] / parse-options-cb.c
blobd9d3b0819f711ea0db1cfa115832f3b2f616c142
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 "strvec.h"
8 #include "oid-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 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;
31 *(int *)(opt->value) = v;
32 return 0;
35 int parse_opt_expiry_date_cb(const struct option *opt, const char *arg,
36 int unset)
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;
45 int parse_opt_color_flag_cb(const struct option *opt, const char *arg,
46 int unset)
48 int value;
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;
60 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
61 int unset)
63 int *target = opt->value;
65 BUG_ON_OPT_ARG(arg);
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;
81 return 0;
84 int parse_opt_commits(const struct option *opt, const char *arg, int unset)
86 struct object_id oid;
87 struct commit *commit;
89 BUG_ON_OPT_NEG(unset);
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;
102 int parse_opt_commit(const struct option *opt, const char *arg, int unset)
104 struct object_id oid;
105 struct commit *commit;
106 struct commit **target = opt->value;
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;
119 int parse_opt_object_name(const struct option *opt, const char *arg, int unset)
121 struct object_id oid;
123 if (unset) {
124 oid_array_clear(opt->value);
125 return 0;
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;
135 int parse_opt_object_id(const struct option *opt, const char *arg, int unset)
137 struct object_id oid;
138 struct object_id *target = opt->value;
140 if (unset) {
141 *target = null_oid;
142 return 0;
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;
152 int parse_opt_tertiary(const struct option *opt, const char *arg, int unset)
154 int *target = opt->value;
156 BUG_ON_OPT_ARG(arg);
158 *target = unset ? 2 : 1;
159 return 0;
162 static size_t parse_options_count(const struct option *opt)
164 size_t n = 0;
166 for (; opt && opt->type != OPTION_END; opt++)
167 n++;
168 return n;
171 struct option *parse_options_dup(const struct option *o)
173 struct option no_options[] = { OPT_END() };
175 return parse_options_concat(o, no_options);
178 struct option *parse_options_concat(const struct option *a,
179 const struct option *b)
181 struct option *ret;
182 size_t a_len = parse_options_count(a);
183 size_t b_len = parse_options_count(b);
185 ALLOC_ARRAY(ret, st_add3(a_len, b_len, 1));
186 COPY_ARRAY(ret, a, a_len);
187 COPY_ARRAY(ret + a_len, b, b_len + 1); /* + 1 for final OPTION_END */
189 return ret;
192 int parse_opt_string_list(const struct option *opt, const char *arg, int unset)
194 struct string_list *v = opt->value;
196 if (unset) {
197 string_list_clear(v, 0);
198 return 0;
201 if (!arg)
202 return -1;
204 string_list_append(v, arg);
205 return 0;
208 int parse_opt_noop_cb(const struct option *opt, const char *arg, int unset)
210 return 0;
214 * Report that the option is unknown, so that other code can handle
215 * it. This can be used as a callback together with
216 * OPTION_LOWLEVEL_CALLBACK to allow an option to be documented in the
217 * "-h" output even if it's not being handled directly by
218 * parse_options().
220 enum parse_opt_result parse_opt_unknown_cb(struct parse_opt_ctx_t *ctx,
221 const struct option *opt,
222 const char *arg, int unset)
224 BUG_ON_OPT_ARG(arg);
225 return PARSE_OPT_UNKNOWN;
229 * Recreates the command-line option in the strbuf.
231 static int recreate_opt(struct strbuf *sb, const struct option *opt,
232 const char *arg, int unset)
234 strbuf_reset(sb);
236 if (opt->long_name) {
237 strbuf_addstr(sb, unset ? "--no-" : "--");
238 strbuf_addstr(sb, opt->long_name);
239 if (arg) {
240 strbuf_addch(sb, '=');
241 strbuf_addstr(sb, arg);
243 } else if (opt->short_name && !unset) {
244 strbuf_addch(sb, '-');
245 strbuf_addch(sb, opt->short_name);
246 if (arg)
247 strbuf_addstr(sb, arg);
248 } else
249 return -1;
251 return 0;
255 * For an option opt, recreates the command-line option in opt->value which
256 * must be an char* initialized to NULL. This is useful when we need to pass
257 * the command-line option to another command. Since any previous value will be
258 * overwritten, this callback should only be used for options where the last
259 * one wins.
261 int parse_opt_passthru(const struct option *opt, const char *arg, int unset)
263 static struct strbuf sb = STRBUF_INIT;
264 char **opt_value = opt->value;
266 if (recreate_opt(&sb, opt, arg, unset) < 0)
267 return -1;
269 free(*opt_value);
271 *opt_value = strbuf_detach(&sb, NULL);
273 return 0;
277 * For an option opt, recreate the command-line option, appending it to
278 * opt->value which must be a strvec. This is useful when we need to pass
279 * the command-line option, which can be specified multiple times, to another
280 * command.
282 int parse_opt_passthru_argv(const struct option *opt, const char *arg, int unset)
284 static struct strbuf sb = STRBUF_INIT;
285 struct strvec *opt_value = opt->value;
287 if (recreate_opt(&sb, opt, arg, unset) < 0)
288 return -1;
290 strvec_push(opt_value, sb.buf);
292 return 0;