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 #define OPT_SHORT 1
  10 #define OPT_UNSET 2
  11
  12 int optbug(const struct option *opt, const char *reason)
  13 {
  14         if (opt->long_name) {
  15                 if (opt->short_name)
  16                         return error("BUG: switch '%c' (--%s) %s",
  17                                      opt->short_name, opt->long_name, reason);
  18                 return error("BUG: option '%s' %s", opt->long_name, reason);
  19         }
  20         return error("BUG: switch '%c' %s", opt->short_name, reason);
  21 }
  22
  23 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
  24                    int flags, const char **arg)
  25 {
  26         if (p->opt) {
  27                 *arg = p->opt;
  28                 p->opt = NULL;
  29         } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
  30                 *arg = (const char *)opt->defval;
  31         } else if (p->argc > 1) {
  32                 p->argc--;
  33                 *arg = *++p->argv;
  34         } else
  35                 return opterror(opt, "requires a value", flags);
  36         return 0;
  37 }
  38
  39 static void fix_filename(const char *prefix, const char **file)
  40 {
  41         if (!file || !*file || !prefix || is_absolute_path(*file)
  42             || !strcmp("-", *file))
  43                 return;
  44         *file = prefix_filename(prefix, *file);
  45 }
  46
  47 static int opt_command_mode_error(const struct option *opt,
  48                                   const struct option *all_opts,
  49                                   int flags)
  50 {
  51         const struct option *that;
  52         struct strbuf message = STRBUF_INIT;
  53         struct strbuf that_name = STRBUF_INIT;
  54
  55         /*
  56          * Find the other option that was used to set the variable
  57          * already, and report that this is not compatible with it.
  58          */
  59         for (that = all_opts; that->type != OPTION_END; that++) {
  60                 if (that == opt ||
  61                     that->type != OPTION_CMDMODE ||
  62                     that->value != opt->value ||
  63                     that->defval != *(int *)opt->value)
  64                         continue;
  65
  66                 if (that->long_name)
  67                         strbuf_addf(&that_name, "--%s", that->long_name);
  68                 else
  69                         strbuf_addf(&that_name, "-%c", that->short_name);
  70                 strbuf_addf(&message, ": incompatible with %s", that_name.buf);
  71                 strbuf_release(&that_name);
  72                 opterror(opt, message.buf, flags);
  73                 strbuf_release(&message);
  74                 return -1;
  75         }
  76         return opterror(opt, ": incompatible with something else", flags);
  77 }
  78
  79 static int get_value(struct parse_opt_ctx_t *p,
  80                      const struct option *opt,
  81                      const struct option *all_opts,
  82                      int flags)
  83 {
  84         const char *s, *arg;
  85         const int unset = flags & OPT_UNSET;
  86         int err;
  87
  88         if (unset && p->opt)
  89                 return opterror(opt, "takes no value", flags);
  90         if (unset && (opt->flags & PARSE_OPT_NONEG))
  91                 return opterror(opt, "isn't available", flags);
  92         if (!(flags & OPT_SHORT) && p->opt && (opt->flags & PARSE_OPT_NOARG))
  93                 return opterror(opt, "takes no value", flags);
  94
  95         switch (opt->type) {
  96         case OPTION_LOWLEVEL_CALLBACK:
  97                 return (*(parse_opt_ll_cb *)opt->callback)(p, opt, unset);
  98
  99         case OPTION_BIT:
 100                 if (unset)
 101                         *(int *)opt->value &= ~opt->defval;
 102                 else
 103                         *(int *)opt->value |= opt->defval;
 104                 return 0;
 105
 106         case OPTION_NEGBIT:
 107                 if (unset)
 108                         *(int *)opt->value |= opt->defval;
 109                 else
 110                         *(int *)opt->value &= ~opt->defval;
 111                 return 0;
 112
 113         case OPTION_COUNTUP:
 114                 if (*(int *)opt->value < 0)
 115                         *(int *)opt->value = 0;
 116                 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
 117                 return 0;
 118
 119         case OPTION_SET_INT:
 120                 *(int *)opt->value = unset ? 0 : opt->defval;
 121                 return 0;
 122
 123         case OPTION_CMDMODE:
 124                 /*
 125                  * Giving the same mode option twice, although is unnecessary,
 126                  * is not a grave error, so let it pass.
 127                  */
 128                 if (*(int *)opt->value && *(int *)opt->value != opt->defval)
 129                         return opt_command_mode_error(opt, all_opts, flags);
 130                 *(int *)opt->value = opt->defval;
 131                 return 0;
 132
 133         case OPTION_STRING:
 134                 if (unset)
 135                         *(const char **)opt->value = NULL;
 136                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 137                         *(const char **)opt->value = (const char *)opt->defval;
 138                 else
 139                         return get_arg(p, opt, flags, (const char **)opt->value);
 140                 return 0;
 141
 142         case OPTION_FILENAME:
 143                 err = 0;
 144                 if (unset)
 145                         *(const char **)opt->value = NULL;
 146                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 147                         *(const char **)opt->value = (const char *)opt->defval;
 148                 else
 149                         err = get_arg(p, opt, flags, (const char **)opt->value);
 150
 151                 if (!err)
 152                         fix_filename(p->prefix, (const char **)opt->value);
 153                 return err;
 154
 155         case OPTION_CALLBACK:
 156                 if (unset)
 157                         return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
 158                 if (opt->flags & PARSE_OPT_NOARG)
 159                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
 160                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
 161                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
 162                 if (get_arg(p, opt, flags, &arg))
 163                         return -1;
 164                 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
 165
 166         case OPTION_INTEGER:
 167                 if (unset) {
 168                         *(int *)opt->value = 0;
 169                         return 0;
 170                 }
 171                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 172                         *(int *)opt->value = opt->defval;
 173                         return 0;
 174                 }
 175                 if (get_arg(p, opt, flags, &arg))
 176                         return -1;
 177                 *(int *)opt->value = strtol(arg, (char **)&s, 10);
 178                 if (*s)
 179                         return opterror(opt, "expects a numerical value", flags);
 180                 return 0;
 181
 182         case OPTION_MAGNITUDE:
 183                 if (unset) {
 184                         *(unsigned long *)opt->value = 0;
 185                         return 0;
 186                 }
 187                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 188                         *(unsigned long *)opt->value = opt->defval;
 189                         return 0;
 190                 }
 191                 if (get_arg(p, opt, flags, &arg))
 192                         return -1;
 193                 if (!git_parse_ulong(arg, opt->value))
 194                         return opterror(opt,
 195                                 "expects a non-negative integer value with an optional k/m/g suffix",
 196                                 flags);
 197                 return 0;
 198
 199         default:
 200                 die("should not happen, someone must be hit on the forehead");
 201         }
 202 }
 203
 204 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
 205 {
 206         const struct option *all_opts = options;
 207         const struct option *numopt = NULL;
 208
 209         for (; options->type != OPTION_END; options++) {
 210                 if (options->short_name == *p->opt) {
 211                         p->opt = p->opt[1] ? p->opt + 1 : NULL;
 212                         return get_value(p, options, all_opts, OPT_SHORT);
 213                 }
 214
 215                 /*
 216                  * Handle the numerical option later, explicit one-digit
 217                  * options take precedence over it.
 218                  */
 219                 if (options->type == OPTION_NUMBER)
 220                         numopt = options;
 221         }
 222         if (numopt && isdigit(*p->opt)) {
 223                 size_t len = 1;
 224                 char *arg;
 225                 int rc;
 226
 227                 while (isdigit(p->opt[len]))
 228                         len++;
 229                 arg = xmemdupz(p->opt, len);
 230                 p->opt = p->opt[len] ? p->opt + len : NULL;
 231                 rc = (*numopt->callback)(numopt, arg, 0) ? (-1) : 0;
 232                 free(arg);
 233                 return rc;
 234         }
 235         return -2;
 236 }
 237
 238 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
 239                           const struct option *options)
 240 {
 241         const struct option *all_opts = options;
 242         const char *arg_end = strchrnul(arg, '=');
 243         const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
 244         int abbrev_flags = 0, ambiguous_flags = 0;
 245
 246         for (; options->type != OPTION_END; options++) {
 247                 const char *rest, *long_name = options->long_name;
 248                 int flags = 0, opt_flags = 0;
 249
 250                 if (!long_name)
 251                         continue;
 252
 253 again:
 254                 if (!skip_prefix(arg, long_name, &rest))
 255                         rest = NULL;
 256                 if (options->type == OPTION_ARGUMENT) {
 257                         if (!rest)
 258                                 continue;
 259                         if (*rest == '=')
 260                                 return opterror(options, "takes no value", flags);
 261                         if (*rest)
 262                                 continue;
 263                         p->out[p->cpidx++] = arg - 2;
 264                         return 0;
 265                 }
 266                 if (!rest) {
 267                         /* abbreviated? */
 268                         if (!strncmp(long_name, arg, arg_end - arg)) {
 269 is_abbreviated:
 270                                 if (abbrev_option) {
 271                                         /*
 272                                          * If this is abbreviated, it is
 273                                          * ambiguous. So when there is no
 274                                          * exact match later, we need to
 275                                          * error out.
 276                                          */
 277                                         ambiguous_option = abbrev_option;
 278                                         ambiguous_flags = abbrev_flags;
 279                                 }
 280                                 if (!(flags & OPT_UNSET) && *arg_end)
 281                                         p->opt = arg_end + 1;
 282                                 abbrev_option = options;
 283                                 abbrev_flags = flags ^ opt_flags;
 284                                 continue;
 285                         }
 286                         /* negation allowed? */
 287                         if (options->flags & PARSE_OPT_NONEG)
 288                                 continue;
 289                         /* negated and abbreviated very much? */
 290                         if (starts_with("no-", arg)) {
 291                                 flags |= OPT_UNSET;
 292                                 goto is_abbreviated;
 293                         }
 294                         /* negated? */
 295                         if (!starts_with(arg, "no-")) {
 296                                 if (starts_with(long_name, "no-")) {
 297                                         long_name += 3;
 298                                         opt_flags |= OPT_UNSET;
 299                                         goto again;
 300                                 }
 301                                 continue;
 302                         }
 303                         flags |= OPT_UNSET;
 304                         if (!skip_prefix(arg + 3, long_name, &rest)) {
 305                                 /* abbreviated and negated? */
 306                                 if (starts_with(long_name, arg + 3))
 307                                         goto is_abbreviated;
 308                                 else
 309                                         continue;
 310                         }
 311                 }
 312                 if (*rest) {
 313                         if (*rest != '=')
 314                                 continue;
 315                         p->opt = rest + 1;
 316                 }
 317                 return get_value(p, options, all_opts, flags ^ opt_flags);
 318         }
 319
 320         if (ambiguous_option)
 321                 return error("Ambiguous option: %s "
 322                         "(could be --%s%s or --%s%s)",
 323                         arg,
 324                         (ambiguous_flags & OPT_UNSET) ?  "no-" : "",
 325                         ambiguous_option->long_name,
 326                         (abbrev_flags & OPT_UNSET) ?  "no-" : "",
 327                         abbrev_option->long_name);
 328         if (abbrev_option)
 329                 return get_value(p, abbrev_option, all_opts, abbrev_flags);
 330         return -2;
 331 }
 332
 333 static int parse_nodash_opt(struct parse_opt_ctx_t *p, const char *arg,
 334                             const struct option *options)
 335 {
 336         const struct option *all_opts = options;
 337
 338         for (; options->type != OPTION_END; options++) {
 339                 if (!(options->flags & PARSE_OPT_NODASH))
 340                         continue;
 341                 if (options->short_name == arg[0] && arg[1] == '\0')
 342                         return get_value(p, options, all_opts, OPT_SHORT);
 343         }
 344         return -2;
 345 }
 346
 347 static void check_typos(const char *arg, const struct option *options)
 348 {
 349         if (strlen(arg) < 3)
 350                 return;
 351
 352         if (starts_with(arg, "no-")) {
 353                 error ("did you mean `--%s` (with two dashes ?)", arg);
 354                 exit(129);
 355         }
 356
 357         for (; options->type != OPTION_END; options++) {
 358                 if (!options->long_name)
 359                         continue;
 360                 if (starts_with(options->long_name, arg)) {
 361                         error ("did you mean `--%s` (with two dashes ?)", arg);
 362                         exit(129);
 363                 }
 364         }
 365 }
 366
 367 static void parse_options_check(const struct option *opts)
 368 {
 369         int err = 0;
 370         char short_opts[128];
 371
 372         memset(short_opts, '\0', sizeof(short_opts));
 373         for (; opts->type != OPTION_END; opts++) {
 374                 if ((opts->flags & PARSE_OPT_LASTARG_DEFAULT) &&
 375                     (opts->flags & PARSE_OPT_OPTARG))
 376                         err |= optbug(opts, "uses incompatible flags "
 377                                         "LASTARG_DEFAULT and OPTARG");
 378                 if (opts->short_name) {
 379                         if (0x7F <= opts->short_name)
 380                                 err |= optbug(opts, "invalid short name");
 381                         else if (short_opts[opts->short_name]++)
 382                                 err |= optbug(opts, "short name already used");
 383                 }
 384                 if (opts->flags & PARSE_OPT_NODASH &&
 385                     ((opts->flags & PARSE_OPT_OPTARG) ||
 386                      !(opts->flags & PARSE_OPT_NOARG) ||
 387                      !(opts->flags & PARSE_OPT_NONEG) ||
 388                      opts->long_name))
 389                         err |= optbug(opts, "uses feature "
 390                                         "not supported for dashless options");
 391                 switch (opts->type) {
 392                 case OPTION_COUNTUP:
 393                 case OPTION_BIT:
 394                 case OPTION_NEGBIT:
 395                 case OPTION_SET_INT:
 396                 case OPTION_NUMBER:
 397                         if ((opts->flags & PARSE_OPT_OPTARG) ||
 398                             !(opts->flags & PARSE_OPT_NOARG))
 399                                 err |= optbug(opts, "should not accept an argument");
 400                 default:
 401                         ; /* ok. (usually accepts an argument) */
 402                 }
 403                 if (opts->argh &&
 404                     strcspn(opts->argh, " _") != strlen(opts->argh))
 405                         err |= optbug(opts, "multi-word argh should use dash to separate words");
 406         }
 407         if (err)
 408                 exit(128);
 409 }
 410
 411 void parse_options_start(struct parse_opt_ctx_t *ctx,
 412                          int argc, const char **argv, const char *prefix,
 413                          const struct option *options, int flags)
 414 {
 415         memset(ctx, 0, sizeof(*ctx));
 416         ctx->argc = ctx->total = argc - 1;
 417         ctx->argv = argv + 1;
 418         ctx->out  = argv;
 419         ctx->prefix = prefix;
 420         ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
 421         ctx->flags = flags;
 422         if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
 423             (flags & PARSE_OPT_STOP_AT_NON_OPTION))
 424                 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
 425         parse_options_check(options);
 426 }
 427
 428 /*
 429  * TODO: we are not completing the --no-XXX form yet because there are
 430  * many options that do not suppress it properly.
 431  */
 432 static int show_gitcomp(struct parse_opt_ctx_t *ctx,
 433                         const struct option *opts)
 434 {
 435         for (; opts->type != OPTION_END; opts++) {
 436                 const char *suffix = "";
 437
 438                 if (!opts->long_name)
 439                         continue;
 440                 if (opts->flags & (PARSE_OPT_HIDDEN | PARSE_OPT_NOCOMPLETE))
 441                         continue;
 442
 443                 switch (opts->type) {
 444                 case OPTION_GROUP:
 445                         continue;
 446                 case OPTION_STRING:
 447                 case OPTION_FILENAME:
 448                 case OPTION_INTEGER:
 449                 case OPTION_MAGNITUDE:
 450                 case OPTION_CALLBACK:
 451                         if (opts->flags & PARSE_OPT_NOARG)
 452                                 break;
 453                         if (opts->flags & PARSE_OPT_OPTARG)
 454                                 break;
 455                         if (opts->flags & PARSE_OPT_LASTARG_DEFAULT)
 456                                 break;
 457                         suffix = "=";
 458                         break;
 459                 default:
 460                         break;
 461                 }
 462                 printf(" --%s%s", opts->long_name, suffix);
 463         }
 464         fputc('\n', stdout);
 465         exit(0);
 466 }
 467
 468 static int usage_with_options_internal(struct parse_opt_ctx_t *,
 469                                        const char * const *,
 470                                        const struct option *, int, int);
 471
 472 int parse_options_step(struct parse_opt_ctx_t *ctx,
 473                        const struct option *options,
 474                        const char * const usagestr[])
 475 {
 476         int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
 477         int err = 0;
 478
 479         /* we must reset ->opt, unknown short option leave it dangling */
 480         ctx->opt = NULL;
 481
 482         for (; ctx->argc; ctx->argc--, ctx->argv++) {
 483                 const char *arg = ctx->argv[0];
 484
 485                 if (*arg != '-' || !arg[1]) {
 486                         if (parse_nodash_opt(ctx, arg, options) == 0)
 487                                 continue;
 488                         if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
 489                                 return PARSE_OPT_NON_OPTION;
 490                         ctx->out[ctx->cpidx++] = ctx->argv[0];
 491                         continue;
 492                 }
 493
 494                 /* lone -h asks for help */
 495                 if (internal_help && ctx->total == 1 && !strcmp(arg + 1, "h"))
 496                         goto show_usage;
 497
 498                 /* lone --git-completion-helper is asked by git-completion.bash */
 499                 if (ctx->total == 1 && !strcmp(arg + 1, "-git-completion-helper"))
 500                         return show_gitcomp(ctx, options);
 501
 502                 if (arg[1] != '-') {
 503                         ctx->opt = arg + 1;
 504                         switch (parse_short_opt(ctx, options)) {
 505                         case -1:
 506                                 goto show_usage_error;
 507                         case -2:
 508                                 if (ctx->opt)
 509                                         check_typos(arg + 1, options);
 510                                 if (internal_help && *ctx->opt == 'h')
 511                                         goto show_usage;
 512                                 goto unknown;
 513                         }
 514                         if (ctx->opt)
 515                                 check_typos(arg + 1, options);
 516                         while (ctx->opt) {
 517                                 switch (parse_short_opt(ctx, options)) {
 518                                 case -1:
 519                                         goto show_usage_error;
 520                                 case -2:
 521                                         if (internal_help && *ctx->opt == 'h')
 522                                                 goto show_usage;
 523
 524                                         /* fake a short option thing to hide the fact that we may have
 525                                          * started to parse aggregated stuff
 526                                          *
 527                                          * This is leaky, too bad.
 528                                          */
 529                                         ctx->argv[0] = xstrdup(ctx->opt - 1);
 530                                         *(char *)ctx->argv[0] = '-';
 531                                         goto unknown;
 532                                 }
 533                         }
 534                         continue;
 535                 }
 536
 537                 if (!arg[2]) { /* "--" */
 538                         if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
 539                                 ctx->argc--;
 540                                 ctx->argv++;
 541                         }
 542                         break;
 543                 }
 544
 545                 if (internal_help && !strcmp(arg + 2, "help-all"))
 546                         return usage_with_options_internal(ctx, usagestr, options, 1, 0);
 547                 if (internal_help && !strcmp(arg + 2, "help"))
 548                         goto show_usage;
 549                 switch (parse_long_opt(ctx, arg + 2, options)) {
 550                 case -1:
 551                         goto show_usage_error;
 552                 case -2:
 553                         goto unknown;
 554                 }
 555                 continue;
 556 unknown:
 557                 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
 558                         return PARSE_OPT_UNKNOWN;
 559                 ctx->out[ctx->cpidx++] = ctx->argv[0];
 560                 ctx->opt = NULL;
 561         }
 562         return PARSE_OPT_DONE;
 563
 564  show_usage_error:
 565         err = 1;
 566  show_usage:
 567         return usage_with_options_internal(ctx, usagestr, options, 0, err);
 568 }
 569
 570 int parse_options_end(struct parse_opt_ctx_t *ctx)
 571 {
 572         memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
 573         ctx->out[ctx->cpidx + ctx->argc] = NULL;
 574         return ctx->cpidx + ctx->argc;
 575 }
 576
 577 int parse_options(int argc, const char **argv, const char *prefix,
 578                   const struct option *options, const char * const usagestr[],
 579                   int flags)
 580 {
 581         struct parse_opt_ctx_t ctx;
 582
 583         parse_options_start(&ctx, argc, argv, prefix, options, flags);
 584         switch (parse_options_step(&ctx, options, usagestr)) {
 585         case PARSE_OPT_HELP:
 586                 exit(129);
 587         case PARSE_OPT_NON_OPTION:
 588         case PARSE_OPT_DONE:
 589                 break;
 590         default: /* PARSE_OPT_UNKNOWN */
 591                 if (ctx.argv[0][1] == '-') {
 592                         error("unknown option `%s'", ctx.argv[0] + 2);
 593                 } else if (isascii(*ctx.opt)) {
 594                         error("unknown switch `%c'", *ctx.opt);
 595                 } else {
 596                         error("unknown non-ascii option in string: `%s'",
 597                               ctx.argv[0]);
 598                 }
 599                 usage_with_options(usagestr, options);
 600         }
 601
 602         precompose_argv(argc, argv);
 603         return parse_options_end(&ctx);
 604 }
 605
 606 static int usage_argh(const struct option *opts, FILE *outfile)
 607 {
 608         const char *s;
 609         int literal = (opts->flags & PARSE_OPT_LITERAL_ARGHELP) || !opts->argh;
 610         if (opts->flags & PARSE_OPT_OPTARG)
 611                 if (opts->long_name)
 612                         s = literal ? "[=%s]" : "[=<%s>]";
 613                 else
 614                         s = literal ? "[%s]" : "[<%s>]";
 615         else
 616                 s = literal ? " %s" : " <%s>";
 617         return utf8_fprintf(outfile, s, opts->argh ? _(opts->argh) : _("..."));
 618 }
 619
 620 #define USAGE_OPTS_WIDTH 24
 621 #define USAGE_GAP         2
 622
 623 static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 624                                        const char * const *usagestr,
 625                                        const struct option *opts, int full, int err)
 626 {
 627         FILE *outfile = err ? stderr : stdout;
 628         int need_newline;
 629
 630         if (!usagestr)
 631                 return PARSE_OPT_HELP;
 632
 633         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 634                 fprintf(outfile, "cat <<\\EOF\n");
 635
 636         fprintf_ln(outfile, _("usage: %s"), _(*usagestr++));
 637         while (*usagestr && **usagestr)
 638                 /*
 639                  * TRANSLATORS: the colon here should align with the
 640                  * one in "usage: %s" translation.
 641                  */
 642                 fprintf_ln(outfile, _("   or: %s"), _(*usagestr++));
 643         while (*usagestr) {
 644                 if (**usagestr)
 645                         fprintf_ln(outfile, _("    %s"), _(*usagestr));
 646                 else
 647                         fputc('\n', outfile);
 648                 usagestr++;
 649         }
 650
 651         need_newline = 1;
 652
 653         for (; opts->type != OPTION_END; opts++) {
 654                 size_t pos;
 655                 int pad;
 656
 657                 if (opts->type == OPTION_GROUP) {
 658                         fputc('\n', outfile);
 659                         need_newline = 0;
 660                         if (*opts->help)
 661                                 fprintf(outfile, "%s\n", _(opts->help));
 662                         continue;
 663                 }
 664                 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
 665                         continue;
 666
 667                 if (need_newline) {
 668                         fputc('\n', outfile);
 669                         need_newline = 0;
 670                 }
 671
 672                 pos = fprintf(outfile, "    ");
 673                 if (opts->short_name) {
 674                         if (opts->flags & PARSE_OPT_NODASH)
 675                                 pos += fprintf(outfile, "%c", opts->short_name);
 676                         else
 677                                 pos += fprintf(outfile, "-%c", opts->short_name);
 678                 }
 679                 if (opts->long_name && opts->short_name)
 680                         pos += fprintf(outfile, ", ");
 681                 if (opts->long_name)
 682                         pos += fprintf(outfile, "--%s", opts->long_name);
 683                 if (opts->type == OPTION_NUMBER)
 684                         pos += utf8_fprintf(outfile, _("-NUM"));
 685
 686                 if ((opts->flags & PARSE_OPT_LITERAL_ARGHELP) ||
 687                     !(opts->flags & PARSE_OPT_NOARG))
 688                         pos += usage_argh(opts, outfile);
 689
 690                 if (pos <= USAGE_OPTS_WIDTH)
 691                         pad = USAGE_OPTS_WIDTH - pos;
 692                 else {
 693                         fputc('\n', outfile);
 694                         pad = USAGE_OPTS_WIDTH;
 695                 }
 696                 fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
 697         }
 698         fputc('\n', outfile);
 699
 700         if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 701                 fputs("EOF\n", outfile);
 702
 703         return PARSE_OPT_HELP;
 704 }
 705
 706 void NORETURN usage_with_options(const char * const *usagestr,
 707                         const struct option *opts)
 708 {
 709         usage_with_options_internal(NULL, usagestr, opts, 0, 1);
 710         exit(129);
 711 }
 712
 713 void NORETURN usage_msg_opt(const char *msg,
 714                    const char * const *usagestr,
 715                    const struct option *options)
 716 {
 717         fprintf(stderr, "fatal: %s\n\n", msg);
 718         usage_with_options(usagestr, options);
 719 }
 720
 721 #undef opterror
 722 int opterror(const struct option *opt, const char *reason, int flags)
 723 {
 724         if (flags & OPT_SHORT)
 725                 return error("switch `%c' %s", opt->short_name, reason);
 726         if (flags & OPT_UNSET)
 727                 return error("option `no-%s' %s", opt->long_name, reason);
 728         return error("option `%s' %s", opt->long_name, reason);
 729 }