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