parse-options.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
   7 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
   8                                const char * const *usagestr,
   9                                const struct option *opts, int err);
  10
  11 #define OPT_SHORT 1
  12 #define OPT_UNSET 2
  13
  14 int optbug(const struct option *opt, const char *reason)
  15 {
  16         if (opt->long_name)
  17                 return error("BUG: option '%s' %s", opt->long_name, reason);
  18         return error("BUG: switch '%c' %s", opt->short_name, reason);
  19 }
  20
  21 int opterror(const struct option *opt, const char *reason, int flags)
  22 {
  23         if (flags & OPT_SHORT)
  24                 return error("switch `%c' %s", opt->short_name, reason);
  25         if (flags & OPT_UNSET)
  26                 return error("option `no-%s' %s", opt->long_name, reason);
  27         return error("option `%s' %s", opt->long_name, reason);
  28 }
  29
  30 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
  31                    int flags, const char **arg)
  32 {
  33         if (p->opt) {
  34                 *arg = p->opt;
  35                 p->opt = NULL;
  36         } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
  37                 *arg = (const char *)opt->defval;
  38         } else if (p->argc > 1) {
  39                 p->argc--;
  40                 *arg = *++p->argv;
  41         } else
  42                 return opterror(opt, "requires a value", flags);
  43         return 0;
  44 }
  45
  46 static void fix_filename(const char *prefix, const char **file)
  47 {
  48         if (!file || !*file || !prefix || is_absolute_path(*file)
  49             || !strcmp("-", *file))
  50                 return;
  51         *file = xstrdup(prefix_filename(prefix, strlen(prefix), *file));
  52 }
  53
  54 static int get_value(struct parse_opt_ctx_t *p,
  55                      const struct option *opt, int flags)
  56 {
  57         const char *s, *arg;
  58         const int unset = flags & OPT_UNSET;
  59         int err;
  60
  61         if (unset && p->opt)
  62                 return opterror(opt, "takes no value", flags);
  63         if (unset && (opt->flags & PARSE_OPT_NONEG))
  64                 return opterror(opt, "isn't available", flags);
  65         if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
  66                 return opterror(opt, "takes no value", flags);
  67
  68         switch (opt->type) {
  69         case OPTION_LOWLEVEL_CALLBACK:
  70                 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
  71
  72         case OPTION_BIT:
  73                 if (unset)
  74                         *(int *)opt->value &= ~opt->defval;
  75                 else
  76                         *(int *)opt->value |= opt->defval;
  77                 return 0;
  78
  79         case OPTION_NEGBIT:
  80                 if (unset)
  81                         *(int *)opt->value |= opt->defval;
  82                 else
  83                         *(int *)opt->value &= ~opt->defval;
  84                 return 0;
  85
  86         case OPTION_COUNTUP:
  87                 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
  88                 return 0;
  89
  90         case OPTION_SET_INT:
  91                 *(int *)opt->value = unset ? 0 : opt->defval;
  92                 return 0;
  93
  94         case OPTION_SET_PTR:
  95                 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
  96                 return 0;
  97
  98         case OPTION_STRING:
  99                 if (unset)
 100                         *(const char **)opt->value = NULL;
 101                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 102                         *(const char **)opt->value = (const char *)opt->defval;
 103                 else
 104                         return get_arg(p, opt, flags, (const char **)opt->value);
 105                 return 0;
 106
 107         case OPTION_FILENAME:
 108                 err = 0;
 109                 if (unset)
 110                         *(const char **)opt->value = NULL;
 111                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 112                         *(const char **)opt->value = (const char *)opt->defval;
 113                 else
 114                         err = get_arg(p, opt, flags, (const char **)opt->value);
 115
 116                 if (!err)
 117                         fix_filename(p->prefix, (const char **)opt->value);
 118                 return err;
 119
 120         case OPTION_CALLBACK:
 121                 if (unset)
 122                         return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
 123                 if (opt->flags & PARSE_OPT_NOARG)
 124                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
 125                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 126                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
 127                 if (get_arg(p, opt, flags, &arg))
 128                         return -1;
 129                 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
 130
 131         case OPTION_INTEGER:
 132                 if (unset) {
 133                         *(int *)opt->value = 0;
 134                         return 0;
 135                 }
 136                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 137                         *(int *)opt->value = opt->defval;
 138                         return 0;
 139                 }
 140                 if (get_arg(p, opt, flags, &arg))
 141                         return -1;
 142                 *(int *)opt->value = strtol(arg, (char **)&s, 10);
 143                 if (*s)
 144                         return opterror(opt, "expects a numerical value", flags);
 145                 return 0;
 146
 147         default:
 148                 die("should not happen, someone must be hit on the forehead");
 149         }
 150 }
 151
 152 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
 153 {
 154         const struct option *numopt = NULL;
 155
 156         for (; options->type != OPTION_END; options++) {
 157                 if (options->short_name == *p->opt) {
 158                         p->opt = p->opt[1] ? p->opt + 1 : NULL;
 159                         return get_value(p, options, OPT_SHORT);
 160                 }
 161
 162                 /*
 163                  * Handle the numerical option later, explicit one-digit
 164                  * options take precedence over it.
 165                  */
 166                 if (options->type == OPTION_NUMBER)
 167                         numopt = options;
 168         }
 169         if (numopt && isdigit(*p->opt)) {
 170                 size_t len = 1;
 171                 char *arg;
 172                 int rc;
 173
 174                 while (isdigit(p->opt[len]))
 175                         len++;
 176                 arg = xmemdupz(p->opt, len);
 177                 p->opt = p->opt[len] ? p->opt + len : NULL;
 178                 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
 179                 free(arg);
 180                 return rc;
 181         }
 182         return -2;
 183 }
 184
 185 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
 186                           const struct option *options)
 187 {
 188         const char *arg_end = strchr(arg, '=');
 189         const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
 190         int abbrev_flags = 0, ambiguous_flags = 0;
 191
 192         if (!arg_end)
 193                 arg_end = arg + strlen(arg);
 194
 195         for (; options->type != OPTION_END; options++) {
 196                 const char *rest, *long_name = options->long_name;
 197                 int flags = 0, opt_flags = 0;
 198
 199                 if (!long_name)
 200                         continue;
 201
 202 again:
 203                 rest = skip_prefix(arg, long_name);
 204                 if (options->type == OPTION_ARGUMENT) {
 205                         if (!rest)
 206                                 continue;
 207                         if (*rest == '=')
 208                                 return opterror(options, "takes no value", flags);
 209                         if (*rest)
 210                                 continue;
 211                         p->out[p->cpidx++] = arg - 2;
 212                         return 0;
 213                 }
 214                 if (!rest) {
 215                         /* abbreviated? */
 216                         if (!strncmp(long_name, arg, arg_end - arg)) {
 217 is_abbreviated:
 218                                 if (abbrev_option) {
 219                                         /*
 220                                          * If this is abbreviated, it is
 221                                          * ambiguous. So when there is no
 222                                          * exact match later, we need to
 223                                          * error out.
 224                                          */
 225                                         ambiguous_option = abbrev_option;
 226                                         ambiguous_flags = abbrev_flags;
 227                                 }
 228                                 if (!(flags & OPT_UNSET) && *arg_end)
 229                                         p->opt = arg_end + 1;
 230                                 abbrev_option = options;
 231                                 abbrev_flags = flags ^ opt_flags;
 232                                 continue;
 233                         }
 234                         /* negation allowed? */
 235                         if (options->flags & PARSE_OPT_NONEG)
 236                                 continue;
 237                         /* negated and abbreviated very much? */
 238                         if (!prefixcmp("no-", arg)) {
 239                                 flags |= OPT_UNSET;
 240                                 goto is_abbreviated;
 241                         }
 242                         /* negated? */
 243                         if (prefixcmp(arg, "no-")) {
 244                                 if (!prefixcmp(long_name, "no-")) {
 245                                         long_name += 3;
 246                                         opt_flags |= OPT_UNSET;
 247                                         goto again;
 248                                 }
 249                                 continue;
 250                         }
 251                         flags |= OPT_UNSET;
 252                         rest = skip_prefix(arg + 3, long_name);
 253                         /* abbreviated and negated? */
 254                         if (!rest && !prefixcmp(long_name, arg + 3))
 255                                 goto is_abbreviated;
 256                         if (!rest)
 257                                 continue;
 258                 }
 259                 if (*rest) {
 260                         if (*rest != '=')
 261                                 continue;
 262                         p->opt = rest + 1;
 263                 }
 264                 return get_value(p, options, flags ^ opt_flags);
 265         }
 266
 267         if (ambiguous_option)
 268                 return error("Ambiguous option: %s "
 269                         "(could be --%s%s or --%s%s)",
 270                         arg,
 271                         (ambiguous_flags & OPT_UNSET) ?  "no-" : "",
 272                         ambiguous_option->long_name,
 273                         (abbrev_flags & OPT_UNSET) ?  "no-" : "",
 274                         abbrev_option->long_name);
 275         if (abbrev_option)
 276                 return get_value(p, abbrev_option, abbrev_flags);
 277         return -2;
 278 }
 279
 280 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
 281                             const struct option *options)
 282 {
 283         for (; options->type != OPTION_END; options++) {
 284                 if (!(options->flags & PARSE_OPT_NODASH))
 285                         continue;
 286                 if (options->short_name == arg[0] && arg[1] == '\0')
 287                         return get_value(p, options, OPT_SHORT);
 288         }
 289         return -2;
 290 }
 291
 292 static void check_typos(const char *arg, const struct option *options)
 293 {
 294         if (strlen(arg) < 3)
 295                 return;
 296
 297         if (!prefixcmp(arg, "no-")) {
 298                 error ("did you mean `--%s` (with two dashes ?)", arg);
 299                 exit(129);
 300         }
 301
 302         for (; options->type != OPTION_END; options++) {
 303                 if (!options->long_name)
 304                         continue;
 305                 if (!prefixcmp(options->long_name, arg)) {
 306                         error ("did you mean `--%s` (with two dashes ?)", arg);
 307                         exit(129);
 308                 }
 309         }
 310 }
 311
 312 static void parse_options_check(const struct option *opts)
 313 {
 314         int err = 0;
 315
 316         for (; opts->type != OPTION_END; opts++) {
 317                 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
 318                     (opts->flags & PARSE_OPT_OPTARG))
 319                         err |= optbug(opts, "uses incompatible flags "
 320                                         "LASTARG_DEFAULT and OPTARG");
 321                 if (opts->flags & PARSE_OPT_NODASH &&
 322                     ((opts->flags & PARSE_OPT_OPTARG) ||
 323                      !(opts->flags & PARSE_OPT_NOARG) ||
 324                      !(opts->flags & PARSE_OPT_NONEG) ||
 325                      opts->long_name))
 326                         err |= optbug(opts, "uses feature "
 327                                         "not supported for dashless options");
 328                 switch (opts->type) {
 329                 case OPTION_COUNTUP:
 330                 case OPTION_BIT:
 331                 case OPTION_NEGBIT:
 332                 case OPTION_SET_INT:
 333                 case OPTION_SET_PTR:
 334                 case OPTION_NUMBER:
 335                         if ((opts->flags & PARSE_OPT_OPTARG) ||
 336                             !(opts->flags & PARSE_OPT_NOARG))
 337                                 err |= optbug(opts, "should not accept an argument");
 338                 default:
 339                         ; /* ok. (usually accepts an argument) */
 340                 }
 341         }
 342         if (err)
 343                 exit(128);
 344 }
 345
 346 void parse_options_start(struct parse_opt_ctx_t *ctx,
 347                          int argc, const char **argv, const char *prefix,
 348                          const struct option *options, int flags)
 349 {
 350         memset(ctx, 0, sizeof(*ctx));
 351         ctx->argc = argc - 1;
 352         ctx->argv = argv + 1;
 353         ctx->out  = argv;
 354         ctx->prefix = prefix;
 355         ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
 356         ctx->flags = flags;
 357         if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
 358             (flags & PARSE_OPT_STOP_AT_NON_OPTION))
 359                 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
 360         parse_options_check(options);
 361 }
 362
 363 static int usage_with_options_internal(struct parse_opt_ctx_t *,
 364                                        const char * const *,
 365                                        const struct option *, int, int);
 366
 367 int parse_options_step(struct parse_opt_ctx_t *ctx,
 368                        const struct option *options,
 369                        const char * const usagestr[])
 370 {
 371         int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
 372
 373         /* we must reset ->opt, unknown short option leave it dangling */
 374         ctx->opt = NULL;
 375
 376         for (; ctx->argc; ctx->argc--, ctx->argv++) {
 377                 const char *arg = ctx->argv[0];
 378
 379                 if (*arg != '-' || !arg[1]) {
 380                         if (parse_nodash_opt(ctx, arg, options) == 0)
 381                                 continue;
 382                         if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
 383                                 return PARSE_OPT_NON_OPTION;
 384                         ctx->out[ctx->cpidx++] = ctx->argv[0];
 385                         continue;
 386                 }
 387
 388                 if (arg[1] != '-') {
 389                         ctx->opt = arg + 1;
 390                         if (internal_help && *ctx->opt == 'h')
 391                                 return parse_options_usage(ctx, usagestr, options, 0);
 392                         switch (parse_short_opt(ctx, options)) {
 393                         case -1:
 394                                 return parse_options_usage(ctx, usagestr, options, 1);
 395                         case -2:
 396                                 goto unknown;
 397                         }
 398                         if (ctx->opt)
 399                                 check_typos(arg + 1, options);
 400                         while (ctx->opt) {
 401                                 if (internal_help && *ctx->opt == 'h')
 402                                         return parse_options_usage(ctx, usagestr, options, 0);
 403                                 switch (parse_short_opt(ctx, options)) {
 404                                 case -1:
 405                                         return parse_options_usage(ctx, usagestr, options, 1);
 406                                 case -2:
 407                                         /* fake a short option thing to hide the fact that we may have
 408                                          * started to parse aggregated stuff
 409                                          *
 410                                          * This is leaky, too bad.
 411                                          */
 412                                         ctx->argv[0] = xstrdup(ctx->opt - 1);
 413                                         *(char *)ctx->argv[0] = '-';
 414                                         goto unknown;
 415                                 }
 416                         }
 417                         continue;
 418                 }
 419
 420                 if (!arg[2]) { /* "--" */
 421                         if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
 422                                 ctx->argc--;
 423                                 ctx->argv++;
 424                         }
 425                         break;
 426                 }
 427
 428                 if (internal_help && !strcmp(arg + 2, "help-all"))
 429                         return usage_with_options_internal(ctx, usagestr, options, 1, 0);
 430                 if (internal_help && !strcmp(arg + 2, "help"))
 431                         return parse_options_usage(ctx, usagestr, options, 0);
 432                 switch (parse_long_opt(ctx, arg + 2, options)) {
 433                 case -1:
 434                         return parse_options_usage(ctx, usagestr, options, 1);
 435                 case -2:
 436                         goto unknown;
 437                 }
 438                 continue;
 439 unknown:
 440                 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
 441                         return PARSE_OPT_UNKNOWN;
 442                 ctx->out[ctx->cpidx++] = ctx->argv[0];
 443                 ctx->opt = NULL;
 444         }
 445         return PARSE_OPT_DONE;
 446 }
 447
 448 int parse_options_end(struct parse_opt_ctx_t *ctx)
 449 {
 450         memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
 451         ctx->out[ctx->cpidx + ctx->argc] = NULL;
 452         return ctx->cpidx + ctx->argc;
 453 }
 454
 455 int parse_options(int argc, const char **argv, const char *prefix,
 456                   const struct option *options, const char * const usagestr[],
 457                   int flags)
 458 {
 459         struct parse_opt_ctx_t ctx;
 460
 461         parse_options_start(&ctx, argc, argv, prefix, options, flags);
 462         switch (parse_options_step(&ctx, options, usagestr)) {
 463         case PARSE_OPT_HELP:
 464                 exit(129);
 465         case PARSE_OPT_NON_OPTION:
 466         case PARSE_OPT_DONE:
 467                 break;
 468         default: /* PARSE_OPT_UNKNOWN */
 469                 if (ctx.argv[0][1] == '-') {
 470                         error("unknown option `%s'", ctx.argv[0] + 2);
 471                 } else {
 472                         error("unknown switch `%c'", *ctx.opt);
 473                 }
 474                 usage_with_options(usagestr, options);
 475         }
 476
 477         return parse_options_end(&ctx);
 478 }
 479
 480 static int usage_argh(const struct option *opts, FILE *outfile)
 481 {
 482         const char *s;
 483         int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
 484         if (opts->flags & PARSE_OPT_OPTARG)
 485                 if (opts->long_name)
 486                         s = literal ? "[=%s]" : "[=<%s>]";
 487                 else
 488                         s = literal ? "[%s]" : "[<%s>]";
 489         else
 490                 s = literal ? " %s" : " <%s>";
 491         return fprintf(outfile, s, opts->argh ? opts->argh : "...");
 492 }
 493
 494 #define USAGE_OPTS_WIDTH 24
 495 #define USAGE_GAP         2
 496
 497 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 498                                        const char * const *usagestr,
 499                                        const struct option *opts, int full, int err)
 500 {
 501         FILE *outfile = err ? stderr : stdout;
 502
 503         if (!usagestr)
 504                 return PARSE_OPT_HELP;
 505
 506         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 507                 fprintf(outfile, "cat <<\\EOF\n");
 508
 509         fprintf(outfile, "usage: %s\n", *usagestr++);
 510         while (*usagestr && **usagestr)
 511                 fprintf(outfile, "   or: %s\n", *usagestr++);
 512         while (*usagestr) {
 513                 fprintf(outfile, "%s%s\n",
 514                                 **usagestr ? "    " : "",
 515                                 *usagestr);
 516                 usagestr++;
 517         }
 518
 519         if (opts->type != OPTION_GROUP)
 520                 fputc('\n', outfile);
 521
 522         for (; opts->type != OPTION_END; opts++) {
 523                 size_t pos;
 524                 int pad;
 525
 526                 if (opts->type == OPTION_GROUP) {
 527                         fputc('\n', outfile);
 528                         if (*opts->help)
 529                                 fprintf(outfile, "%s\n", opts->help);
 530                         continue;
 531                 }
 532                 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
 533                         continue;
 534
 535                 pos = fprintf(outfile, "    ");
 536                 if (opts->short_name) {
 537                         if (opts->flags & PARSE_OPT_NODASH)
 538                                 pos += fprintf(outfile, "%c", opts->short_name);
 539                         else
 540                                 pos += fprintf(outfile, "-%c", opts->short_name);
 541                 }
 542                 if (opts->long_name && opts->short_name)
 543                         pos += fprintf(outfile, ", ");
 544                 if (opts->long_name)
 545                         pos += fprintf(outfile, "--%s", opts->long_name);
 546                 if (opts->type == OPTION_NUMBER)
 547                         pos += fprintf(outfile, "-NUM");
 548
 549                 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
 550                     !(opts->flags & PARSE_OPT_NOARG))
 551                         pos += usage_argh(opts, outfile);
 552
 553                 if (pos <= USAGE_OPTS_WIDTH)
 554                         pad = USAGE_OPTS_WIDTH - pos;
 555                 else {
 556                         fputc('\n', outfile);
 557                         pad = USAGE_OPTS_WIDTH;
 558                 }
 559                 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
 560         }
 561         fputc('\n', outfile);
 562
 563         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 564                 fputs("EOF\n", outfile);
 565
 566         return PARSE_OPT_HELP;
 567 }
 568
 569 void NORETURN usage_with_options(const char * const *usagestr,
 570                         const struct option *opts)
 571 {
 572         usage_with_options_internal(NULL, usagestr, opts, 0, 1);
 573         exit(129);
 574 }
 575
 576 void NORETURN usage_msg_opt(const char *msg,
 577                    const char * const *usagestr,
 578                    const struct option *options)
 579 {
 580         fprintf(stderr, "%s\n\n", msg);
 581         usage_with_options(usagestr, options);
 582 }
 583
 584 static int parse_options_usage(struct parse_opt_ctx_t *ctx,
 585                                const char * const *usagestr,
 586                                const struct option *opts, int err)
 587 {
 588         return usage_with_options_internal(ctx, usagestr, opts, 0, err);
 589 }
 590