parse-options.c

   1 #include "git-compat-util.h"
   2 #include "parse-options.h"
   3 #include "cache.h"
   4 #include "config.h"
   5 #include "commit.h"
   6 #include "color.h"
   7 #include "utf8.h"
   8
   9 static int disallow_abbreviated_options;
  10
  11 enum opt_parsed {
  12         OPT_LONG  = 0,
  13         OPT_SHORT = 1<<0,
  14         OPT_UNSET = 1<<1,
  15 };
  16
  17 static void optbug(const struct option *opt, const char *reason)
  18 {
  19         if (opt->long_name && opt->short_name)
  20                 bug("switch '%c' (--%s) %s", opt->short_name,
  21                     opt->long_name, reason);
  22         else if (opt->long_name)
  23                 bug("option '%s' %s", opt->long_name, reason);
  24         else
  25                 bug("switch '%c' %s", opt->short_name, reason);
  26 }
  27
  28 static const char *optname(const struct option *opt, enum opt_parsed flags)
  29 {
  30         static struct strbuf sb = STRBUF_INIT;
  31
  32         strbuf_reset(&sb);
  33         if (flags & OPT_SHORT)
  34                 strbuf_addf(&sb, "switch `%c'", opt->short_name);
  35         else if (flags & OPT_UNSET)
  36                 strbuf_addf(&sb, "option `no-%s'", opt->long_name);
  37         else if (flags == OPT_LONG)
  38                 strbuf_addf(&sb, "option `%s'", opt->long_name);
  39         else
  40                 BUG("optname() got unknown flags %d", flags);
  41
  42         return sb.buf;
  43 }
  44
  45 static enum parse_opt_result get_arg(struct parse_opt_ctx_t *p,
  46                                      const struct option *opt,
  47                                      enum opt_parsed flags, const char **arg)
  48 {
  49         if (p->opt) {
  50                 *arg = p->opt;
  51                 p->opt = NULL;
  52         } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
  53                 *arg = (const char *)opt->defval;
  54         } else if (p->argc > 1) {
  55                 p->argc--;
  56                 *arg = *++p->argv;
  57         } else
  58                 return error(_("%s requires a value"), optname(opt, flags));
  59         return 0;
  60 }
  61
  62 static void fix_filename(const char *prefix, const char **file)
  63 {
  64         if (!file || !*file || !prefix || is_absolute_path(*file)
  65             || !strcmp("-", *file))
  66                 return;
  67         *file = prefix_filename(prefix, *file);
  68 }
  69
  70 static enum parse_opt_result opt_command_mode_error(
  71         const struct option *opt,
  72         const struct option *all_opts,
  73         enum opt_parsed flags)
  74 {
  75         const struct option *that;
  76         struct strbuf that_name = STRBUF_INIT;
  77
  78         /*
  79          * Find the other option that was used to set the variable
  80          * already, and report that this is not compatible with it.
  81          */
  82         for (that = all_opts; that->type != OPTION_END; that++) {
  83                 if (that == opt ||
  84                     !(that->flags & PARSE_OPT_CMDMODE) ||
  85                     that->value != opt->value ||
  86                     that->defval != *(int *)opt->value)
  87                         continue;
  88
  89                 if (that->long_name)
  90                         strbuf_addf(&that_name, "--%s", that->long_name);
  91                 else
  92                         strbuf_addf(&that_name, "-%c", that->short_name);
  93                 error(_("%s is incompatible with %s"),
  94                       optname(opt, flags), that_name.buf);
  95                 strbuf_release(&that_name);
  96                 return PARSE_OPT_ERROR;
  97         }
  98         return error(_("%s : incompatible with something else"),
  99                      optname(opt, flags));
 100 }
 101
 102 static enum parse_opt_result get_value(struct parse_opt_ctx_t *p,
 103                                        const struct option *opt,
 104                                        const struct option *all_opts,
 105                                        enum opt_parsed flags)
 106 {
 107         const char *s, *arg;
 108         const int unset = flags & OPT_UNSET;
 109         int err;
 110
 111         if (unset && p->opt)
 112                 return error(_("%s takes no value"), optname(opt, flags));
 113         if (unset && (opt->flags & PARSE_OPT_NONEG))
 114                 return error(_("%s isn't available"), optname(opt, flags));
 115         if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
 116                 return error(_("%s takes no value"), optname(opt, flags));
 117
 118         /*
 119          * Giving the same mode option twice, although unnecessary,
 120          * is not a grave error, so let it pass.
 121          */
 122         if ((opt->flags & PARSE_OPT_CMDMODE) &&
 123             *(int *)opt->value && *(int *)opt->value != opt->defval)
 124                 return opt_command_mode_error(opt, all_opts, flags);
 125
 126         switch (opt->type) {
 127         case OPTION_LOWLEVEL_CALLBACK:
 128                 return opt->ll_callback(p, opt, NULL, unset);
 129
 130         case OPTION_BIT:
 131                 if (unset)
 132                         *(int *)opt->value &= ~opt->defval;
 133                 else
 134                         *(int *)opt->value |= opt->defval;
 135                 return 0;
 136
 137         case OPTION_NEGBIT:
 138                 if (unset)
 139                         *(int *)opt->value |= opt->defval;
 140                 else
 141                         *(int *)opt->value &= ~opt->defval;
 142                 return 0;
 143
 144         case OPTION_BITOP:
 145                 if (unset)
 146                         BUG("BITOP can't have unset form");
 147                 *(int *)opt->value &= ~opt->extra;
 148                 *(int *)opt->value |= opt->defval;
 149                 return 0;
 150
 151         case OPTION_COUNTUP:
 152                 if (*(int *)opt->value < 0)
 153                         *(int *)opt->value = 0;
 154                 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
 155                 return 0;
 156
 157         case OPTION_SET_INT:
 158                 *(int *)opt->value = unset ? 0 : opt->defval;
 159                 return 0;
 160
 161         case OPTION_STRING:
 162                 if (unset)
 163                         *(const char **)opt->value = NULL;
 164                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 165                         *(const char **)opt->value = (const char *)opt->defval;
 166                 else
 167                         return get_arg(p, opt, flags, (const char **)opt->value);
 168                 return 0;
 169
 170         case OPTION_FILENAME:
 171                 err = 0;
 172                 if (unset)
 173                         *(const char **)opt->value = NULL;
 174                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 175                         *(const char **)opt->value = (const char *)opt->defval;
 176                 else
 177                         err = get_arg(p, opt, flags, (const char **)opt->value);
 178
 179                 if (!err)
 180                         fix_filename(p->prefix, (const char **)opt->value);
 181                 return err;
 182
 183         case OPTION_CALLBACK:
 184         {
 185                 const char *p_arg = NULL;
 186                 int p_unset;
 187
 188                 if (unset)
 189                         p_unset = 1;
 190                 else if (opt->flags & PARSE_OPT_NOARG)
 191                         p_unset = 0;
 192                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 193                         p_unset = 0;
 194                 else if (get_arg(p, opt, flags, &arg))
 195                         return -1;
 196                 else {
 197                         p_unset = 0;
 198                         p_arg = arg;
 199                 }
 200                 if (opt->callback)
 201                         return (*opt->callback)(opt, p_arg, p_unset) ? (-1) : 0;
 202                 else
 203                         return (*opt->ll_callback)(p, opt, p_arg, p_unset);
 204         }
 205         case OPTION_INTEGER:
 206                 if (unset) {
 207                         *(int *)opt->value = 0;
 208                         return 0;
 209                 }
 210                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 211                         *(int *)opt->value = opt->defval;
 212                         return 0;
 213                 }
 214                 if (get_arg(p, opt, flags, &arg))
 215                         return -1;
 216                 if (!*arg)
 217                         return error(_("%s expects a numerical value"),
 218                                      optname(opt, flags));
 219                 *(int *)opt->value = strtol(arg, (char **)&s, 10);
 220                 if (*s)
 221                         return error(_("%s expects a numerical value"),
 222                                      optname(opt, flags));
 223                 return 0;
 224
 225         case OPTION_MAGNITUDE:
 226                 if (unset) {
 227                         *(unsigned long *)opt->value = 0;
 228                         return 0;
 229                 }
 230                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 231                         *(unsigned long *)opt->value = opt->defval;
 232                         return 0;
 233                 }
 234                 if (get_arg(p, opt, flags, &arg))
 235                         return -1;
 236                 if (!git_parse_ulong(arg, opt->value))
 237                         return error(_("%s expects a non-negative integer value"
 238                                        " with an optional k/m/g suffix"),
 239                                      optname(opt, flags));
 240                 return 0;
 241
 242         default:
 243                 BUG("opt->type %d should not happen", opt->type);
 244         }
 245 }
 246
 247 static enum parse_opt_result parse_short_opt(struct parse_opt_ctx_t *p,
 248                                              const struct option *options)
 249 {
 250         const struct option *all_opts = options;
 251         const struct option *numopt = NULL;
 252
 253         for (; options->type != OPTION_END; options++) {
 254                 if (options->short_name == *p->opt) {
 255                         p->opt = p->opt[1] ? p->opt + 1 : NULL;
 256                         return get_value(p, options, all_opts, OPT_SHORT);
 257                 }
 258
 259                 /*
 260                  * Handle the numerical option later, explicit one-digit
 261                  * options take precedence over it.
 262                  */
 263                 if (options->type == OPTION_NUMBER)
 264                         numopt = options;
 265         }
 266         if (numopt && isdigit(*p->opt)) {
 267                 size_t len = 1;
 268                 char *arg;
 269                 int rc;
 270
 271                 while (isdigit(p->opt[len]))
 272                         len++;
 273                 arg = xmemdupz(p->opt, len);
 274                 p->opt = p->opt[len] ? p->opt + len : NULL;
 275                 if (numopt->callback)
 276                         rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
 277                 else
 278                         rc = (*numopt->ll_callback)(p, numopt, arg, 0);
 279                 free(arg);
 280                 return rc;
 281         }
 282         return PARSE_OPT_UNKNOWN;
 283 }
 284
 285 static int has_string(const char *it, const char **array)
 286 {
 287         while (*array)
 288                 if (!strcmp(it, *(array++)))
 289                         return 1;
 290         return 0;
 291 }
 292
 293 static int is_alias(struct parse_opt_ctx_t *ctx,
 294                     const struct option *one_opt,
 295                     const struct option *another_opt)
 296 {
 297         const char **group;
 298
 299         if (!ctx->alias_groups)
 300                 return 0;
 301
 302         if (!one_opt->long_name || !another_opt->long_name)
 303                 return 0;
 304
 305         for (group = ctx->alias_groups; *group; group += 3) {
 306                 /* it and other are from the same family? */
 307                 if (has_string(one_opt->long_name, group) &&
 308                     has_string(another_opt->long_name, group))
 309                         return 1;
 310         }
 311         return 0;
 312 }
 313
 314 static enum parse_opt_result parse_long_opt(
 315         struct parse_opt_ctx_t *p, const char *arg,
 316         const struct option *options)
 317 {
 318         const struct option *all_opts = options;
 319         const char *arg_end = strchrnul(arg, '=');
 320         const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
 321         enum opt_parsed abbrev_flags = OPT_LONG, ambiguous_flags = OPT_LONG;
 322
 323         for (; options->type != OPTION_END; options++) {
 324                 const char *rest, *long_name = options->long_name;
 325                 enum opt_parsed flags = OPT_LONG, opt_flags = OPT_LONG;
 326
 327                 if (!long_name)
 328                         continue;
 329
 330 again:
 331                 if (!skip_prefix(arg, long_name, &rest))
 332                         rest = NULL;
 333                 if (!rest) {
 334                         /* abbreviated? */
 335                         if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) &&
 336                             !strncmp(long_name, arg, arg_end - arg)) {
 337 is_abbreviated:
 338                                 if (abbrev_option &&
 339                                     !is_alias(p, abbrev_option, options)) {
 340                                         /*
 341                                          * If this is abbreviated, it is
 342                                          * ambiguous. So when there is no
 343                                          * exact match later, we need to
 344                                          * error out.
 345                                          */
 346                                         ambiguous_option = abbrev_option;
 347                                         ambiguous_flags = abbrev_flags;
 348                                 }
 349                                 if (!(flags & OPT_UNSET) && *arg_end)
 350                                         p->opt = arg_end + 1;
 351                                 abbrev_option = options;
 352                                 abbrev_flags = flags ^ opt_flags;
 353                                 continue;
 354                         }
 355                         /* negation allowed? */
 356                         if (options->flags & PARSE_OPT_NONEG)
 357                                 continue;
 358                         /* negated and abbreviated very much? */
 359                         if (starts_with("no-", arg)) {
 360                                 flags |= OPT_UNSET;
 361                                 goto is_abbreviated;
 362                         }
 363                         /* negated? */
 364                         if (!starts_with(arg, "no-")) {
 365                                 if (skip_prefix(long_name, "no-", &long_name)) {
 366                                         opt_flags |= OPT_UNSET;
 367                                         goto again;
 368                                 }
 369                                 continue;
 370                         }
 371                         flags |= OPT_UNSET;
 372                         if (!skip_prefix(arg + 3, long_name, &rest)) {
 373                                 /* abbreviated and negated? */
 374                                 if (starts_with(long_name, arg + 3))
 375                                         goto is_abbreviated;
 376                                 else
 377                                         continue;
 378                         }
 379                 }
 380                 if (*rest) {
 381                         if (*rest != '=')
 382                                 continue;
 383                         p->opt = rest + 1;
 384                 }
 385                 return get_value(p, options, all_opts, flags ^ opt_flags);
 386         }
 387
 388         if (disallow_abbreviated_options && (ambiguous_option || abbrev_option))
 389                 die("disallowed abbreviated or ambiguous option '%.*s'",
 390                     (int)(arg_end - arg), arg);
 391
 392         if (ambiguous_option) {
 393                 error(_("ambiguous option: %s "
 394                         "(could be --%s%s or --%s%s)"),
 395                         arg,
 396                         (ambiguous_flags & OPT_UNSET) ?  "no-" : "",
 397                         ambiguous_option->long_name,
 398                         (abbrev_flags & OPT_UNSET) ?  "no-" : "",
 399                         abbrev_option->long_name);
 400                 return PARSE_OPT_HELP;
 401         }
 402         if (abbrev_option)
 403                 return get_value(p, abbrev_option, all_opts, abbrev_flags);
 404         return PARSE_OPT_UNKNOWN;
 405 }
 406
 407 static enum parse_opt_result parse_nodash_opt(struct parse_opt_ctx_t *p,
 408                                               const char *arg,
 409                                               const struct option *options)
 410 {
 411         const struct option *all_opts = options;
 412
 413         for (; options->type != OPTION_END; options++) {
 414                 if (!(options->flags & PARSE_OPT_NODASH))
 415                         continue;
 416                 if (options->short_name == arg[0] && arg[1] == '\0')
 417                         return get_value(p, options, all_opts, OPT_SHORT);
 418         }
 419         return PARSE_OPT_ERROR;
 420 }
 421
 422 static void check_typos(const char *arg, const struct option *options)
 423 {
 424         if (strlen(arg) < 3)
 425                 return;
 426
 427         if (starts_with(arg, "no-")) {
 428                 error(_("did you mean `--%s` (with two dashes)?"), arg);
 429                 exit(129);
 430         }
 431
 432         for (; options->type != OPTION_END; options++) {
 433                 if (!options->long_name)
 434                         continue;
 435                 if (starts_with(options->long_name, arg)) {
 436                         error(_("did you mean `--%s` (with two dashes)?"), arg);
 437                         exit(129);
 438                 }
 439         }
 440 }
 441
 442 static void parse_options_check(const struct option *opts)
 443 {
 444         char short_opts[128];
 445
 446         memset(short_opts, '\0', sizeof(short_opts));
 447         for (; opts->type != OPTION_END; opts++) {
 448                 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
 449                     (opts->flags & PARSE_OPT_OPTARG))
 450                         optbug(opts, "uses incompatible flags "
 451                                "LASTARG_DEFAULT and OPTARG");
 452                 if (opts->short_name) {
 453                         if (0x7F <= opts->short_name)
 454                                 optbug(opts, "invalid short name");
 455                         else if (short_opts[opts->short_name]++)
 456                                 optbug(opts, "short name already used");
 457                 }
 458                 if (opts->flags & PARSE_OPT_NODASH &&
 459                     ((opts->flags & PARSE_OPT_OPTARG) ||
 460                      !(opts->flags & PARSE_OPT_NOARG) ||
 461                      !(opts->flags & PARSE_OPT_NONEG) ||
 462                      opts->long_name))
 463                         optbug(opts, "uses feature "
 464                                "not supported for dashless options");
 465                 switch (opts->type) {
 466                 case OPTION_COUNTUP:
 467                 case OPTION_BIT:
 468                 case OPTION_NEGBIT:
 469                 case OPTION_SET_INT:
 470                 case OPTION_NUMBER:
 471                         if ((opts->flags & PARSE_OPT_OPTARG) ||
 472                             !(opts->flags & PARSE_OPT_NOARG))
 473                                 optbug(opts, "should not accept an argument");
 474                         break;
 475                 case OPTION_CALLBACK:
 476                         if (!opts->callback && !opts->ll_callback)
 477                                 optbug(opts, "OPTION_CALLBACK needs one callback");
 478                         else if (opts->callback && opts->ll_callback)
 479                                 optbug(opts, "OPTION_CALLBACK can't have two callbacks");
 480                         break;
 481                 case OPTION_LOWLEVEL_CALLBACK:
 482                         if (!opts->ll_callback)
 483                                 optbug(opts, "OPTION_LOWLEVEL_CALLBACK needs a callback");
 484                         if (opts->callback)
 485                                 optbug(opts, "OPTION_LOWLEVEL_CALLBACK needs no high level callback");
 486                         break;
 487                 case OPTION_ALIAS:
 488                         optbug(opts, "OPT_ALIAS() should not remain at this point. "
 489                                "Are you using parse_options_step() directly?\n"
 490                                "That case is not supported yet.");
 491                         break;
 492                 default:
 493                         ; /* ok. (usually accepts an argument) */
 494                 }
 495                 if (opts->argh &&
 496                     strcspn(opts->argh, " _") != strlen(opts->argh))
 497                         optbug(opts, "multi-word argh should use dash to separate words");
 498         }
 499         BUG_if_bug("invalid 'struct option'");
 500 }
 501
 502 static void parse_options_start_1(struct parse_opt_ctx_t *ctx,
 503                                   int argc, const char **argv, const char *prefix,
 504                                   const struct option *options,
 505                                   enum parse_opt_flags flags)
 506 {
 507         ctx->argc = argc;
 508         ctx->argv = argv;
 509         if (!(flags & PARSE_OPT_ONE_SHOT)) {
 510                 ctx->argc--;
 511                 ctx->argv++;
 512         }
 513         ctx->total = ctx->argc;
 514         ctx->out   = argv;
 515         ctx->prefix = prefix;
 516         ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
 517         ctx->flags = flags;
 518         if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
 519             (flags & PARSE_OPT_STOP_AT_NON_OPTION) &&
 520             !(flags & PARSE_OPT_ONE_SHOT))
 521                 BUG("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
 522         if ((flags & PARSE_OPT_ONE_SHOT) &&
 523             (flags & PARSE_OPT_KEEP_ARGV0))
 524                 BUG("Can't keep argv0 if you don't have it");
 525         parse_options_check(options);
 526 }
 527
 528 void parse_options_start(struct parse_opt_ctx_t *ctx,
 529                          int argc, const char **argv, const char *prefix,
 530                          const struct option *options,
 531                          enum parse_opt_flags flags)
 532 {
 533         memset(ctx, 0, sizeof(*ctx));
 534         parse_options_start_1(ctx, argc, argv, prefix, options, flags);
 535 }
 536
 537 static void show_negated_gitcomp(const struct option *opts, int show_all,
 538                                  int nr_noopts)
 539 {
 540         int printed_dashdash = 0;
 541
 542         for (; opts->type != OPTION_END; opts++) {
 543                 int has_unset_form = 0;
 544                 const char *name;
 545
 546                 if (!opts->long_name)
 547                         continue;
 548                 if (!show_all &&
 549                         (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE)))
 550                         continue;
 551                 if (opts->flags & PARSE_OPT_NONEG)
 552                         continue;
 553
 554                 switch (opts->type) {
 555                 case OPTION_STRING:
 556                 case OPTION_FILENAME:
 557                 case OPTION_INTEGER:
 558                 case OPTION_MAGNITUDE:
 559                 case OPTION_CALLBACK:
 560                 case OPTION_BIT:
 561                 case OPTION_NEGBIT:
 562                 case OPTION_COUNTUP:
 563                 case OPTION_SET_INT:
 564                         has_unset_form = 1;
 565                         break;
 566                 default:
 567                         break;
 568                 }
 569                 if (!has_unset_form)
 570                         continue;
 571
 572                 if (skip_prefix(opts->long_name, "no-", &name)) {
 573                         if (nr_noopts < 0)
 574                                 printf(" --%s", name);
 575                 } else if (nr_noopts >= 0) {
 576                         if (nr_noopts && !printed_dashdash) {
 577                                 printf(" --");
 578                                 printed_dashdash = 1;
 579                         }
 580                         printf(" --no-%s", opts->long_name);
 581                         nr_noopts++;
 582                 }
 583         }
 584 }
 585
 586 static int show_gitcomp(const struct option *opts, int show_all)
 587 {
 588         const struct option *original_opts = opts;
 589         int nr_noopts = 0;
 590
 591         for (; opts->type != OPTION_END; opts++) {
 592                 const char *suffix = "";
 593
 594                 if (!opts->long_name)
 595                         continue;
 596                 if (!show_all &&
 597                         (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE | PARSE_OPT_FROM_ALIAS)))
 598                         continue;
 599
 600                 switch (opts->type) {
 601                 case OPTION_GROUP:
 602                         continue;
 603                 case OPTION_STRING:
 604                 case OPTION_FILENAME:
 605                 case OPTION_INTEGER:
 606                 case OPTION_MAGNITUDE:
 607                 case OPTION_CALLBACK:
 608                         if (opts->flags & PARSE_OPT_NOARG)
 609                                 break;
 610                         if (opts->flags & PARSE_OPT_OPTARG)
 611                                 break;
 612                         if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
 613                                 break;
 614                         suffix = "=";
 615                         break;
 616                 default:
 617                         break;
 618                 }
 619                 if (opts->flags & PARSE_OPT_COMP_ARG)
 620                         suffix = "=";
 621                 if (starts_with(opts->long_name, "no-"))
 622                         nr_noopts++;
 623                 printf(" --%s%s", opts->long_name, suffix);
 624         }
 625         show_negated_gitcomp(original_opts, show_all, -1);
 626         show_negated_gitcomp(original_opts, show_all, nr_noopts);
 627         fputc('\n', stdout);
 628         return PARSE_OPT_COMPLETE;
 629 }
 630
 631 /*
 632  * Scan and may produce a new option[] array, which should be used
 633  * instead of the original 'options'.
 634  *
 635  * Right now this is only used to preprocess and substitute
 636  * OPTION_ALIAS.
 637  *
 638  * The returned options should be freed using free_preprocessed_options.
 639  */
 640 static struct option *preprocess_options(struct parse_opt_ctx_t *ctx,
 641                                          const struct option *options)
 642 {
 643         struct option *newopt;
 644         int i, nr, alias;
 645         int nr_aliases = 0;
 646
 647         for (nr = 0; options[nr].type != OPTION_END; nr++) {
 648                 if (options[nr].type == OPTION_ALIAS)
 649                         nr_aliases++;
 650         }
 651
 652         if (!nr_aliases)
 653                 return NULL;
 654
 655         ALLOC_ARRAY(newopt, nr + 1);
 656         COPY_ARRAY(newopt, options, nr + 1);
 657
 658         /* each alias has two string pointers and NULL */
 659         CALLOC_ARRAY(ctx->alias_groups, 3 * (nr_aliases + 1));
 660
 661         for (alias = 0, i = 0; i < nr; i++) {
 662                 int short_name;
 663                 const char *long_name;
 664                 const char *source;
 665                 struct strbuf help = STRBUF_INIT;
 666                 int j;
 667
 668                 if (newopt[i].type != OPTION_ALIAS)
 669                         continue;
 670
 671                 short_name = newopt[i].short_name;
 672                 long_name = newopt[i].long_name;
 673                 source = newopt[i].value;
 674
 675                 if (!long_name)
 676                         BUG("An alias must have long option name");
 677                 strbuf_addf(&help, _("alias of --%s"), source);
 678
 679                 for (j = 0; j < nr; j++) {
 680                         const char *name = options[j].long_name;
 681
 682                         if (!name || strcmp(name, source))
 683                                 continue;
 684
 685                         if (options[j].type == OPTION_ALIAS)
 686                                 BUG("No please. Nested aliases are not supported.");
 687
 688                         memcpy(newopt + i, options + j, sizeof(*newopt));
 689                         newopt[i].short_name = short_name;
 690                         newopt[i].long_name = long_name;
 691                         newopt[i].help = strbuf_detach(&help, NULL);
 692                         newopt[i].flags |= PARSE_OPT_FROM_ALIAS;
 693                         break;
 694                 }
 695
 696                 if (j == nr)
 697                         BUG("could not find source option '%s' of alias '%s'",
 698                             source, newopt[i].long_name);
 699                 ctx->alias_groups[alias * 3 + 0] = newopt[i].long_name;
 700                 ctx->alias_groups[alias * 3 + 1] = options[j].long_name;
 701                 ctx->alias_groups[alias * 3 + 2] = NULL;
 702                 alias++;
 703         }
 704
 705         return newopt;
 706 }
 707
 708 static void free_preprocessed_options(struct option *options)
 709 {
 710         int i;
 711
 712         if (!options)
 713                 return;
 714
 715         for (i = 0; options[i].type != OPTION_END; i++) {
 716                 if (options[i].flags & PARSE_OPT_FROM_ALIAS)
 717                         free((void *)options[i].help);
 718         }
 719         free(options);
 720 }
 721
 722 static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t *,
 723                                                          const char * const *,
 724                                                          const struct option *,
 725                                                          int, int);
 726
 727 enum parse_opt_result parse_options_step(struct parse_opt_ctx_t *ctx,
 728                                          const struct option *options,
 729                                          const char * const usagestr[])
 730 {
 731         int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
 732
 733         /* we must reset ->opt, unknown short option leave it dangling */
 734         ctx->opt = NULL;
 735
 736         for (; ctx->argc; ctx->argc--, ctx->argv++) {
 737                 const char *arg = ctx->argv[0];
 738
 739                 if (ctx->flags & PARSE_OPT_ONE_SHOT &&
 740                     ctx->argc != ctx->total)
 741                         break;
 742
 743                 if (*arg != '-' || !arg[1]) {
 744                         if (parse_nodash_opt(ctx, arg, options) == 0)
 745                                 continue;
 746                         if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
 747                                 return PARSE_OPT_NON_OPTION;
 748                         ctx->out[ctx->cpidx++] = ctx->argv[0];
 749                         continue;
 750                 }
 751
 752                 /* lone -h asks for help */
 753                 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
 754                         goto show_usage;
 755
 756                 /*
 757                  * lone --git-completion-helper and --git-completion-helper-all
 758                  * are asked by git-completion.bash
 759                  */
 760                 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper"))
 761                         return show_gitcomp(options, 0);
 762                 if (ctx->total == 1 && !strcmp(arg, "--git-completion-helper-all"))
 763                         return show_gitcomp(options, 1);
 764
 765                 if (arg[1] != '-') {
 766                         ctx->opt = arg + 1;
 767                         switch (parse_short_opt(ctx, options)) {
 768                         case PARSE_OPT_ERROR:
 769                                 return PARSE_OPT_ERROR;
 770                         case PARSE_OPT_UNKNOWN:
 771                                 if (ctx->opt)
 772                                         check_typos(arg + 1, options);
 773                                 if (internal_help && *ctx->opt == 'h')
 774                                         goto show_usage;
 775                                 goto unknown;
 776                         case PARSE_OPT_NON_OPTION:
 777                         case PARSE_OPT_HELP:
 778                         case PARSE_OPT_COMPLETE:
 779                                 BUG("parse_short_opt() cannot return these");
 780                         case PARSE_OPT_DONE:
 781                                 break;
 782                         }
 783                         if (ctx->opt)
 784                                 check_typos(arg + 1, options);
 785                         while (ctx->opt) {
 786                                 switch (parse_short_opt(ctx, options)) {
 787                                 case PARSE_OPT_ERROR:
 788                                         return PARSE_OPT_ERROR;
 789                                 case PARSE_OPT_UNKNOWN:
 790                                         if (internal_help && *ctx->opt == 'h')
 791                                                 goto show_usage;
 792
 793                                         /* fake a short option thing to hide the fact that we may have
 794                                          * started to parse aggregated stuff
 795                                          *
 796                                          * This is leaky, too bad.
 797                                          */
 798                                         ctx->argv[0] = xstrdup(ctx->opt - 1);
 799                                         *(char *)ctx->argv[0] = '-';
 800                                         goto unknown;
 801                                 case PARSE_OPT_NON_OPTION:
 802                                 case PARSE_OPT_COMPLETE:
 803                                 case PARSE_OPT_HELP:
 804                                         BUG("parse_short_opt() cannot return these");
 805                                 case PARSE_OPT_DONE:
 806                                         break;
 807                                 }
 808                         }
 809                         continue;
 810                 }
 811
 812                 if (!arg[2] /* "--" */ ||
 813                     !strcmp(arg + 2, "end-of-options")) {
 814                         if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
 815                                 ctx->argc--;
 816                                 ctx->argv++;
 817                         }
 818                         break;
 819                 }
 820
 821                 if (internal_help && !strcmp(arg + 2, "help-all"))
 822                         return usage_with_options_internal(ctx, usagestr, options, 1, 0);
 823                 if (internal_help && !strcmp(arg + 2, "help"))
 824                         goto show_usage;
 825                 switch (parse_long_opt(ctx, arg + 2, options)) {
 826                 case PARSE_OPT_ERROR:
 827                         return PARSE_OPT_ERROR;
 828                 case PARSE_OPT_UNKNOWN:
 829                         goto unknown;
 830                 case PARSE_OPT_HELP:
 831                         goto show_usage;
 832                 case PARSE_OPT_NON_OPTION:
 833                 case PARSE_OPT_COMPLETE:
 834                         BUG("parse_long_opt() cannot return these");
 835                 case PARSE_OPT_DONE:
 836                         break;
 837                 }
 838                 continue;
 839 unknown:
 840                 if (ctx->flags & PARSE_OPT_ONE_SHOT)
 841                         break;
 842                 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
 843                         return PARSE_OPT_UNKNOWN;
 844                 ctx->out[ctx->cpidx++] = ctx->argv[0];
 845                 ctx->opt = NULL;
 846         }
 847         return PARSE_OPT_DONE;
 848
 849  show_usage:
 850         return usage_with_options_internal(ctx, usagestr, options, 0, 0);
 851 }
 852
 853 int parse_options_end(struct parse_opt_ctx_t *ctx)
 854 {
 855         if (ctx->flags & PARSE_OPT_ONE_SHOT)
 856                 return ctx->total - ctx->argc;
 857
 858         MOVE_ARRAY(ctx->out + ctx->cpidx, ctx->argv, ctx->argc);
 859         ctx->out[ctx->cpidx + ctx->argc] = NULL;
 860         return ctx->cpidx + ctx->argc;
 861 }
 862
 863 int parse_options(int argc, const char **argv,
 864                   const char *prefix,
 865                   const struct option *options,
 866                   const char * const usagestr[],
 867                   enum parse_opt_flags flags)
 868 {
 869         struct parse_opt_ctx_t ctx;
 870         struct option *real_options;
 871
 872         disallow_abbreviated_options =
 873                 git_env_bool("GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS", 0);
 874
 875         memset(&ctx, 0, sizeof(ctx));
 876         real_options = preprocess_options(&ctx, options);
 877         if (real_options)
 878                 options = real_options;
 879         parse_options_start_1(&ctx, argc, argv, prefix, options, flags);
 880         switch (parse_options_step(&ctx, options, usagestr)) {
 881         case PARSE_OPT_HELP:
 882         case PARSE_OPT_ERROR:
 883                 exit(129);
 884         case PARSE_OPT_COMPLETE:
 885                 exit(0);
 886         case PARSE_OPT_NON_OPTION:
 887         case PARSE_OPT_DONE:
 888                 break;
 889         case PARSE_OPT_UNKNOWN:
 890                 if (ctx.argv[0][1] == '-') {
 891                         error(_("unknown option `%s'"), ctx.argv[0] + 2);
 892                 } else if (isascii(*ctx.opt)) {
 893                         error(_("unknown switch `%c'"), *ctx.opt);
 894                 } else {
 895                         error(_("unknown non-ascii option in string: `%s'"),
 896                               ctx.argv[0]);
 897                 }
 898                 usage_with_options(usagestr, options);
 899         }
 900
 901         precompose_argv_prefix(argc, argv, NULL);
 902         free_preprocessed_options(real_options);
 903         free(ctx.alias_groups);
 904         return parse_options_end(&ctx);
 905 }
 906
 907 static int usage_argh(const struct option *opts, FILE *outfile)
 908 {
 909         const char *s;
 910         int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
 911                 !opts->argh || !!strpbrk(opts->argh, "()<>[]|");
 912         if (opts->flags & PARSE_OPT_OPTARG)
 913                 if (opts->long_name)
 914                         s = literal ? "[=%s]" : "[=<%s>]";
 915                 else
 916                         s = literal ? "[%s]" : "[<%s>]";
 917         else
 918                 s = literal ? " %s" : " <%s>";
 919         return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
 920 }
 921
 922 #define USAGE_OPTS_WIDTH 24
 923 #define USAGE_GAP         2
 924
 925 static enum parse_opt_result usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 926                                                          const char * const *usagestr,
 927                                                          const struct option *opts,
 928                                                          int full, int err)
 929 {
 930         FILE *outfile = err ? stderr : stdout;
 931         int need_newline;
 932
 933         const char *usage_prefix = _("usage: %s");
 934         /*
 935          * The translation could be anything, but we can count on
 936          * msgfmt(1)'s --check option to have asserted that "%s" is in
 937          * the translation. So compute the length of the "usage: "
 938          * part. We are assuming that the translator wasn't overly
 939          * clever and used e.g. "%1$s" instead of "%s", there's only
 940          * one "%s" in "usage_prefix" above, so there's no reason to
 941          * do so even with a RTL language.
 942          */
 943         size_t usage_len = strlen(usage_prefix) - strlen("%s");
 944         /*
 945          * TRANSLATORS: the colon here should align with the
 946          * one in "usage: %s" translation.
 947          */
 948         const char *or_prefix = _("   or: %s");
 949         /*
 950          * TRANSLATORS: You should only need to translate this format
 951          * string if your language is a RTL language (e.g. Arabic,
 952          * Hebrew etc.), not if it's a LTR language (e.g. German,
 953          * Russian, Chinese etc.).
 954          *
 955          * When a translated usage string has an embedded "\n" it's
 956          * because options have wrapped to the next line. The line
 957          * after the "\n" will then be padded to align with the
 958          * command name, such as N_("git cmd [opt]\n<8
 959          * spaces>[opt2]"), where the 8 spaces are the same length as
 960          * "git cmd ".
 961          *
 962          * This format string prints out that already-translated
 963          * line. The "%*s" is whitespace padding to account for the
 964          * padding at the start of the line that we add in this
 965          * function. The "%s" is a line in the (hopefully already
 966          * translated) N_() usage string, which contained embedded
 967          * newlines before we split it up.
 968          */
 969         const char *usage_continued = _("%*s%s");
 970         const char *prefix = usage_prefix;
 971         int saw_empty_line = 0;
 972
 973         if (!usagestr)
 974                 return PARSE_OPT_HELP;
 975
 976         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 977                 fprintf(outfile, "cat <<\\EOF\n");
 978
 979         while (*usagestr) {
 980                 const char *str = _(*usagestr++);
 981                 struct string_list list = STRING_LIST_INIT_DUP;
 982                 unsigned int j;
 983
 984                 if (!saw_empty_line && !*str)
 985                         saw_empty_line = 1;
 986
 987                 string_list_split(&list, str, '\n', -1);
 988                 for (j = 0; j < list.nr; j++) {
 989                         const char *line = list.items[j].string;
 990
 991                         if (saw_empty_line && *line)
 992                                 fprintf_ln(outfile, _("    %s"), line);
 993                         else if (saw_empty_line)
 994                                 fputc('\n', outfile);
 995                         else if (!j)
 996                                 fprintf_ln(outfile, prefix, line);
 997                         else
 998                                 fprintf_ln(outfile, usage_continued,
 999                                            (int)usage_len, "", line);
1000                 }
1001                 string_list_clear(&list, 0);
1002
1003                 prefix = or_prefix;
1004         }
1005
1006         need_newline = 1;
1007
1008         for (; opts->type != OPTION_END; opts++) {
1009                 size_t pos;
1010                 int pad;
1011
1012                 if (opts->type == OPTION_GROUP) {
1013                         fputc('\n', outfile);
1014                         need_newline = 0;
1015                         if (*opts->help)
1016                                 fprintf(outfile, "%s\n", _(opts->help));
1017                         continue;
1018                 }
1019                 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
1020                         continue;
1021
1022                 if (need_newline) {
1023                         fputc('\n', outfile);
1024                         need_newline = 0;
1025                 }
1026
1027                 pos = fprintf(outfile, "    ");
1028                 if (opts->short_name) {
1029                         if (opts->flags & PARSE_OPT_NODASH)
1030                                 pos += fprintf(outfile, "%c", opts->short_name);
1031                         else
1032                                 pos += fprintf(outfile, "-%c", opts->short_name);
1033                 }
1034                 if (opts->long_name && opts->short_name)
1035                         pos += fprintf(outfile, ", ");
1036                 if (opts->long_name)
1037                         pos += fprintf(outfile, "--%s", opts->long_name);
1038                 if (opts->type == OPTION_NUMBER)
1039                         pos += utf8_fprintf(outfile, _("-NUM"));
1040
1041                 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
1042                     !(opts->flags & PARSE_OPT_NOARG))
1043                         pos += usage_argh(opts, outfile);
1044
1045                 if (pos <= USAGE_OPTS_WIDTH)
1046                         pad = USAGE_OPTS_WIDTH - pos;
1047                 else {
1048                         fputc('\n', outfile);
1049                         pad = USAGE_OPTS_WIDTH;
1050                 }
1051                 if (opts->type == OPTION_ALIAS) {
1052                         fprintf(outfile, "%*s", pad + USAGE_GAP, "");
1053                         fprintf_ln(outfile, _("alias of --%s"),
1054                                    (const char *)opts->value);
1055                         continue;
1056                 }
1057                 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
1058         }
1059         fputc('\n', outfile);
1060
1061         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
1062                 fputs("EOF\n", outfile);
1063
1064         return PARSE_OPT_HELP;
1065 }
1066
1067 void NORETURN usage_with_options(const char * const *usagestr,
1068                         const struct option *opts)
1069 {
1070         usage_with_options_internal(NULL, usagestr, opts, 0, 1);
1071         exit(129);
1072 }
1073
1074 void NORETURN usage_msg_opt(const char *msg,
1075                    const char * const *usagestr,
1076                    const struct option *options)
1077 {
1078         die_message("%s\n", msg); /* The extra \n is intentional */
1079         usage_with_options(usagestr, options);
1080 }
1081
1082 void NORETURN usage_msg_optf(const char * const fmt,
1083                              const char * const *usagestr,
1084                              const struct option *options, ...)
1085 {
1086         struct strbuf msg = STRBUF_INIT;
1087         va_list ap;
1088         va_start(ap, options);
1089         strbuf_vaddf(&msg, fmt, ap);
1090         va_end(ap);
1091
1092         usage_msg_opt(msg.buf, usagestr, options);
1093 }
1094
1095 void die_for_incompatible_opt4(int opt1, const char *opt1_name,
1096                                int opt2, const char *opt2_name,
1097                                int opt3, const char *opt3_name,
1098                                int opt4, const char *opt4_name)
1099 {
1100         int count = 0;
1101         const char *options[4];
1102
1103         if (opt1)
1104                 options[count++] = opt1_name;
1105         if (opt2)
1106                 options[count++] = opt2_name;
1107         if (opt3)
1108                 options[count++] = opt3_name;
1109         if (opt4)
1110                 options[count++] = opt4_name;
1111         switch (count) {
1112         case 4:
1113                 die(_("options '%s', '%s', '%s', and '%s' cannot be used together"),
1114                     opt1_name, opt2_name, opt3_name, opt4_name);
1115                 break;
1116         case 3:
1117                 die(_("options '%s', '%s', and '%s' cannot be used together"),
1118                     options[0], options[1], options[2]);
1119                 break;
1120         case 2:
1121                 die(_("options '%s' and '%s' cannot be used together"),
1122                     options[0], options[1]);
1123                 break;
1124         default:
1125                 break;
1126         }
1127 }