parse-options.c

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