@matheusbsbs / matheus-bagliano / commits / 3f9ab7ccde

parse-options.[ch]: consistently use "enum parse_opt_flags"

Use the "enum parse_opt_flags" instead of an "int flags" as arguments to the various functions in parse-options.c. Even though this is an enum bitfield there's there's a benefit to doing this when it comes to the wider C ecosystem. E.g. the GNU debugger (gdb) will helpfully detect and print out meaningful enum labels in this case. Here's the output before and after when breaking in "parse_options()" after invoking "git stash show": Before: (gdb) p flags $1 = 9 After: (gdb) p flags $1 = (PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_UNKNOWN) Of course as noted in[1] there's a limit to this smartness, i.e. manually setting it with unrelated enum labels won't be caught. There are some third-party extensions to do more exhaustive checking[2], perhaps we'll be able to make use of them sooner than later. We've also got prior art using this pattern in the codebase. See e.g. "enum bloom_filter_computed" added in 312cff52074 (bloom: split 'get_bloom_filter()' in two, 2020-09-16) and the "permitted" enum added in ce910287e72 (add -p: fix checking of user input, 2020-08-17). 1. https://lore.kernel.org/git/87mtnvvj3c.fsf@evledraar.gmail.com/ 2. https://github.com/sinelaw/elfs-clang-plugins/blob/master/enums_conversion/README.md Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Oct 8, 2021 at 21:07 UTC 3f9ab7ccdea91b8312a14d39ce752b4d6685d067

2 files changed +12 -7

parse-options.c

+7 -4

@@ -481,7 +481,8 @@ static void parse_options_check(const struct option *opts)

481

482 static void parse_options_start_1(struct parse_opt_ctx_t *ctx,

483 int argc, const char **argv, const char *prefix,

484 - const struct option *options, int flags)

484 + const struct option *options,

485 + enum parse_opt_flags flags)

486 {

487 ctx->argc = argc;

488 ctx->argv = argv;

@@ -506,7 +507,8 @@ static void parse_options_start_1(struct parse_opt_ctx_t *ctx,

507

508 void parse_options_start(struct parse_opt_ctx_t *ctx,

509 int argc, const char **argv, const char *prefix,

509 - const struct option *options, int flags)

510 + const struct option *options,

511 + enum parse_opt_flags flags)

512 {

513 memset(ctx, 0, sizeof(*ctx));

514 parse_options_start_1(ctx, argc, argv, prefix, options, flags);

@@ -838,8 +840,9 @@ int parse_options_end(struct parse_opt_ctx_t *ctx)

840 }

841

842 int parse_options(int argc, const char **argv, const char *prefix,

841 - const struct option *options, const char * const usagestr[],

842 - int flags)

843 + const struct option *options,

844 + const char * const usagestr[],

845 + enum parse_opt_flags flags)

846 {

847 struct parse_opt_ctx_t ctx;

848 struct option *real_options;

parse-options.h

+5 -3

@@ -213,7 +213,8 @@ struct option {

213 */

214 int parse_options(int argc, const char **argv, const char *prefix,

215 const struct option *options,

216 - const char * const usagestr[], int flags);

216 + const char * const usagestr[],

217 + enum parse_opt_flags flags);

218

219 NORETURN void usage_with_options(const char * const *usagestr,

220 const struct option *options);

@@ -262,7 +263,7 @@ struct parse_opt_ctx_t {

263 const char **out;

264 int argc, cpidx, total;

265 const char *opt;

265 - int flags;

266 + enum parse_opt_flags flags;

267 const char *prefix;

268 const char **alias_groups; /* must be in groups of 3 elements! */

269 struct option *updated_options;

@@ -270,7 +271,8 @@ struct parse_opt_ctx_t {

271

272 void parse_options_start(struct parse_opt_ctx_t *ctx,

273 int argc, const char **argv, const char *prefix,

273 - const struct option *options, int flags);

274 + const struct option *options,

275 + enum parse_opt_flags flags);

276

277 int parse_options_step(struct parse_opt_ctx_t *ctx,

278 const struct option *options,