git.oblomov.eu Git - linux-2.6/blob - Documentation/perf_counter/util/parse-options.c

   1 #include "util.h"
   2 #include "parse-options.h"
   3 #include "cache.h"
   4
   5 #define OPT_SHORT 1
   6 #define OPT_UNSET 2
   7
   8 static int opterror(const struct option *opt, const char *reason, int flags)
   9 {
  10         if (flags & OPT_SHORT)
  11                 return error("switch `%c' %s", opt->short_name, reason);
  12         if (flags & OPT_UNSET)
  13                 return error("option `no-%s' %s", opt->long_name, reason);
  14         return error("option `%s' %s", opt->long_name, reason);
  15 }
  16
  17 static int get_arg(struct parse_opt_ctx_t *p, const struct option *opt,
  18                    int flags, const char **arg)
  19 {
  20         if (p->opt) {
  21                 *arg = p->opt;
  22                 p->opt = NULL;
  23         } else if (p->argc == 1 && (opt->flags & PARSE_OPT_LASTARG_DEFAULT)) {
  24                 *arg = (const char *)opt->defval;
  25         } else if (p->argc > 1) {
  26                 p->argc--;
  27                 *arg = *++p->argv;
  28         } else
  29                 return opterror(opt, "requires a value", flags);
  30         return 0;
  31 }
  32
  33 static int get_value(struct parse_opt_ctx_t *p,
  34                      const struct option *opt, int flags)
  35 {
  36         const char *s, *arg;
  37         const int unset = flags & OPT_UNSET;
  38
  39         if (unset && p->opt)
  40                 return opterror(opt, "takes no value", flags);
  41         if (unset && (opt->flags & PARSE_OPT_NONEG))
  42                 return opterror(opt, "isn't available", flags);
  43
  44         if (!(flags & OPT_SHORT) && p->opt) {
  45                 switch (opt->type) {
  46                 case OPTION_CALLBACK:
  47                         if (!(opt->flags & PARSE_OPT_NOARG))
  48                                 break;
  49                         /* FALLTHROUGH */
  50                 case OPTION_BOOLEAN:
  51                 case OPTION_BIT:
  52                 case OPTION_SET_INT:
  53                 case OPTION_SET_PTR:
  54                         return opterror(opt, "takes no value", flags);
  55                 default:
  56                         break;
  57                 }
  58         }
  59
  60         switch (opt->type) {
  61         case OPTION_BIT:
  62                 if (unset)
  63                         *(int *)opt->value &= ~opt->defval;
  64                 else
  65                         *(int *)opt->value |= opt->defval;
  66                 return 0;
  67
  68         case OPTION_BOOLEAN:
  69                 *(int *)opt->value = unset ? 0 : *(int *)opt->value + 1;
  70                 return 0;
  71
  72         case OPTION_SET_INT:
  73                 *(int *)opt->value = unset ? 0 : opt->defval;
  74                 return 0;
  75
  76         case OPTION_SET_PTR:
  77                 *(void **)opt->value = unset ? NULL : (void *)opt->defval;
  78                 return 0;
  79
  80         case OPTION_STRING:
  81                 if (unset)
  82                         *(const char **)opt->value = NULL;
  83                 else if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
  84                         *(const char **)opt->value = (const char *)opt->defval;
  85                 else
  86                         return get_arg(p, opt, flags, (const char **)opt->value);
  87                 return 0;
  88
  89         case OPTION_CALLBACK:
  90                 if (unset)
  91                         return (*opt->callback)(opt, NULL, 1) ? (-1) : 0;
  92                 if (opt->flags & PARSE_OPT_NOARG)
  93                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
  94                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt)
  95                         return (*opt->callback)(opt, NULL, 0) ? (-1) : 0;
  96                 if (get_arg(p, opt, flags, &arg))
  97                         return -1;
  98                 return (*opt->callback)(opt, arg, 0) ? (-1) : 0;
  99
 100         case OPTION_INTEGER:
 101                 if (unset) {
 102                         *(int *)opt->value = 0;
 103                         return 0;
 104                 }
 105                 if (opt->flags & PARSE_OPT_OPTARG && !p->opt) {
 106                         *(int *)opt->value = opt->defval;
 107                         return 0;
 108                 }
 109                 if (get_arg(p, opt, flags, &arg))
 110                         return -1;
 111                 *(int *)opt->value = strtol(arg, (char **)&s, 10);
 112                 if (*s)
 113                         return opterror(opt, "expects a numerical value", flags);
 114                 return 0;
 115
 116         default:
 117                 die("should not happen, someone must be hit on the forehead");
 118         }
 119 }
 120
 121 static int parse_short_opt(struct parse_opt_ctx_t *p, const struct option *options)
 122 {
 123         for (; options->type != OPTION_END; options++) {
 124                 if (options->short_name == *p->opt) {
 125                         p->opt = p->opt[1] ? p->opt + 1 : NULL;
 126                         return get_value(p, options, OPT_SHORT);
 127                 }
 128         }
 129         return -2;
 130 }
 131
 132 static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg,
 133                           const struct option *options)
 134 {
 135         const char *arg_end = strchr(arg, '=');
 136         const struct option *abbrev_option = NULL, *ambiguous_option = NULL;
 137         int abbrev_flags = 0, ambiguous_flags = 0;
 138
 139         if (!arg_end)
 140                 arg_end = arg + strlen(arg);
 141
 142         for (; options->type != OPTION_END; options++) {
 143                 const char *rest;
 144                 int flags = 0;
 145
 146                 if (!options->long_name)
 147                         continue;
 148
 149                 rest = skip_prefix(arg, options->long_name);
 150                 if (options->type == OPTION_ARGUMENT) {
 151                         if (!rest)
 152                                 continue;
 153                         if (*rest == '=')
 154                                 return opterror(options, "takes no value", flags);
 155                         if (*rest)
 156                                 continue;
 157                         p->out[p->cpidx++] = arg - 2;
 158                         return 0;
 159                 }
 160                 if (!rest) {
 161                         /* abbreviated? */
 162                         if (!strncmp(options->long_name, arg, arg_end - arg)) {
 163 is_abbreviated:
 164                                 if (abbrev_option) {
 165                                         /*
 166                                          * If this is abbreviated, it is
 167                                          * ambiguous. So when there is no
 168                                          * exact match later, we need to
 169                                          * error out.
 170                                          */
 171                                         ambiguous_option = abbrev_option;
 172                                         ambiguous_flags = abbrev_flags;
 173                                 }
 174                                 if (!(flags & OPT_UNSET) && *arg_end)
 175                                         p->opt = arg_end + 1;
 176                                 abbrev_option = options;
 177                                 abbrev_flags = flags;
 178                                 continue;
 179                         }
 180                         /* negated and abbreviated very much? */
 181                         if (!prefixcmp("no-", arg)) {
 182                                 flags |= OPT_UNSET;
 183                                 goto is_abbreviated;
 184                         }
 185                         /* negated? */
 186                         if (strncmp(arg, "no-", 3))
 187                                 continue;
 188                         flags |= OPT_UNSET;
 189                         rest = skip_prefix(arg + 3, options->long_name);
 190                         /* abbreviated and negated? */
 191                         if (!rest && !prefixcmp(options->long_name, arg + 3))
 192                                 goto is_abbreviated;
 193                         if (!rest)
 194                                 continue;
 195                 }
 196                 if (*rest) {
 197                         if (*rest != '=')
 198                                 continue;
 199                         p->opt = rest + 1;
 200                 }
 201                 return get_value(p, options, flags);
 202         }
 203
 204         if (ambiguous_option)
 205                 return error("Ambiguous option: %s "
 206                         "(could be --%s%s or --%s%s)",
 207                         arg,
 208                         (ambiguous_flags & OPT_UNSET) ?  "no-" : "",
 209                         ambiguous_option->long_name,
 210                         (abbrev_flags & OPT_UNSET) ?  "no-" : "",
 211                         abbrev_option->long_name);
 212         if (abbrev_option)
 213                 return get_value(p, abbrev_option, abbrev_flags);
 214         return -2;
 215 }
 216
 217 static void check_typos(const char *arg, const struct option *options)
 218 {
 219         if (strlen(arg) < 3)
 220                 return;
 221
 222         if (!prefixcmp(arg, "no-")) {
 223                 error ("did you mean `--%s` (with two dashes ?)", arg);
 224                 exit(129);
 225         }
 226
 227         for (; options->type != OPTION_END; options++) {
 228                 if (!options->long_name)
 229                         continue;
 230                 if (!prefixcmp(options->long_name, arg)) {
 231                         error ("did you mean `--%s` (with two dashes ?)", arg);
 232                         exit(129);
 233                 }
 234         }
 235 }
 236
 237 void parse_options_start(struct parse_opt_ctx_t *ctx,
 238                          int argc, const char **argv, int flags)
 239 {
 240         memset(ctx, 0, sizeof(*ctx));
 241         ctx->argc = argc - 1;
 242         ctx->argv = argv + 1;
 243         ctx->out  = argv;
 244         ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0);
 245         ctx->flags = flags;
 246         if ((flags & PARSE_OPT_KEEP_UNKNOWN) &&
 247             (flags & PARSE_OPT_STOP_AT_NON_OPTION))
 248                 die("STOP_AT_NON_OPTION and KEEP_UNKNOWN don't go together");
 249 }
 250
 251 static int usage_with_options_internal(const char * const *,
 252                                        const struct option *, int);
 253
 254 int parse_options_step(struct parse_opt_ctx_t *ctx,
 255                        const struct option *options,
 256                        const char * const usagestr[])
 257 {
 258         int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP);
 259
 260         /* we must reset ->opt, unknown short option leave it dangling */
 261         ctx->opt = NULL;
 262
 263         for (; ctx->argc; ctx->argc--, ctx->argv++) {
 264                 const char *arg = ctx->argv[0];
 265
 266                 if (*arg != '-' || !arg[1]) {
 267                         if (ctx->flags & PARSE_OPT_STOP_AT_NON_OPTION)
 268                                 break;
 269                         ctx->out[ctx->cpidx++] = ctx->argv[0];
 270                         continue;
 271                 }
 272
 273                 if (arg[1] != '-') {
 274                         ctx->opt = arg + 1;
 275                         if (internal_help && *ctx->opt == 'h')
 276                                 return parse_options_usage(usagestr, options);
 277                         switch (parse_short_opt(ctx, options)) {
 278                         case -1:
 279                                 return parse_options_usage(usagestr, options);
 280                         case -2:
 281                                 goto unknown;
 282                         }
 283                         if (ctx->opt)
 284                                 check_typos(arg + 1, options);
 285                         while (ctx->opt) {
 286                                 if (internal_help && *ctx->opt == 'h')
 287                                         return parse_options_usage(usagestr, options);
 288                                 switch (parse_short_opt(ctx, options)) {
 289                                 case -1:
 290                                         return parse_options_usage(usagestr, options);
 291                                 case -2:
 292                                         /* fake a short option thing to hide the fact that we may have
 293                                          * started to parse aggregated stuff
 294                                          *
 295                                          * This is leaky, too bad.
 296                                          */
 297                                         ctx->argv[0] = strdup(ctx->opt - 1);
 298                                         *(char *)ctx->argv[0] = '-';
 299                                         goto unknown;
 300                                 }
 301                         }
 302                         continue;
 303                 }
 304
 305                 if (!arg[2]) { /* "--" */
 306                         if (!(ctx->flags & PARSE_OPT_KEEP_DASHDASH)) {
 307                                 ctx->argc--;
 308                                 ctx->argv++;
 309                         }
 310                         break;
 311                 }
 312
 313                 if (internal_help && !strcmp(arg + 2, "help-all"))
 314                         return usage_with_options_internal(usagestr, options, 1);
 315                 if (internal_help && !strcmp(arg + 2, "help"))
 316                         return parse_options_usage(usagestr, options);
 317                 switch (parse_long_opt(ctx, arg + 2, options)) {
 318                 case -1:
 319                         return parse_options_usage(usagestr, options);
 320                 case -2:
 321                         goto unknown;
 322                 }
 323                 continue;
 324 unknown:
 325                 if (!(ctx->flags & PARSE_OPT_KEEP_UNKNOWN))
 326                         return PARSE_OPT_UNKNOWN;
 327                 ctx->out[ctx->cpidx++] = ctx->argv[0];
 328                 ctx->opt = NULL;
 329         }
 330         return PARSE_OPT_DONE;
 331 }
 332
 333 int parse_options_end(struct parse_opt_ctx_t *ctx)
 334 {
 335         memmove(ctx->out + ctx->cpidx, ctx->argv, ctx->argc * sizeof(*ctx->out));
 336         ctx->out[ctx->cpidx + ctx->argc] = NULL;
 337         return ctx->cpidx + ctx->argc;
 338 }
 339
 340 int parse_options(int argc, const char **argv, const struct option *options,
 341                   const char * const usagestr[], int flags)
 342 {
 343         struct parse_opt_ctx_t ctx;
 344
 345         parse_options_start(&ctx, argc, argv, flags);
 346         switch (parse_options_step(&ctx, options, usagestr)) {
 347         case PARSE_OPT_HELP:
 348                 exit(129);
 349         case PARSE_OPT_DONE:
 350                 break;
 351         default: /* PARSE_OPT_UNKNOWN */
 352                 if (ctx.argv[0][1] == '-') {
 353                         error("unknown option `%s'", ctx.argv[0] + 2);
 354                 } else {
 355                         error("unknown switch `%c'", *ctx.opt);
 356                 }
 357                 usage_with_options(usagestr, options);
 358         }
 359
 360         return parse_options_end(&ctx);
 361 }
 362
 363 #define USAGE_OPTS_WIDTH 24
 364 #define USAGE_GAP         2
 365
 366 int usage_with_options_internal(const char * const *usagestr,
 367                                 const struct option *opts, int full)
 368 {
 369         if (!usagestr)
 370                 return PARSE_OPT_HELP;
 371
 372         fprintf(stderr, "usage: %s\n", *usagestr++);
 373         while (*usagestr && **usagestr)
 374                 fprintf(stderr, "   or: %s\n", *usagestr++);
 375         while (*usagestr) {
 376                 fprintf(stderr, "%s%s\n",
 377                                 **usagestr ? "    " : "",
 378                                 *usagestr);
 379                 usagestr++;
 380         }
 381
 382         if (opts->type != OPTION_GROUP)
 383                 fputc('\n', stderr);
 384
 385         for (; opts->type != OPTION_END; opts++) {
 386                 size_t pos;
 387                 int pad;
 388
 389                 if (opts->type == OPTION_GROUP) {
 390                         fputc('\n', stderr);
 391                         if (*opts->help)
 392                                 fprintf(stderr, "%s\n", opts->help);
 393                         continue;
 394                 }
 395                 if (!full && (opts->flags & PARSE_OPT_HIDDEN))
 396                         continue;
 397
 398                 pos = fprintf(stderr, "    ");
 399                 if (opts->short_name)
 400                         pos += fprintf(stderr, "-%c", opts->short_name);
 401                 if (opts->long_name && opts->short_name)
 402                         pos += fprintf(stderr, ", ");
 403                 if (opts->long_name)
 404                         pos += fprintf(stderr, "--%s", opts->long_name);
 405
 406                 switch (opts->type) {
 407                 case OPTION_ARGUMENT:
 408                         break;
 409                 case OPTION_INTEGER:
 410                         if (opts->flags & PARSE_OPT_OPTARG)
 411                                 if (opts->long_name)
 412                                         pos += fprintf(stderr, "[=<n>]");
 413                                 else
 414                                         pos += fprintf(stderr, "[<n>]");
 415                         else
 416                                 pos += fprintf(stderr, " <n>");
 417                         break;
 418                 case OPTION_CALLBACK:
 419                         if (opts->flags & PARSE_OPT_NOARG)
 420                                 break;
 421                         /* FALLTHROUGH */
 422                 case OPTION_STRING:
 423                         if (opts->argh) {
 424                                 if (opts->flags & PARSE_OPT_OPTARG)
 425                                         if (opts->long_name)
 426                                                 pos += fprintf(stderr, "[=<%s>]", opts->argh);
 427                                         else
 428                                                 pos += fprintf(stderr, "[<%s>]", opts->argh);
 429                                 else
 430                                         pos += fprintf(stderr, " <%s>", opts->argh);
 431                         } else {
 432                                 if (opts->flags & PARSE_OPT_OPTARG)
 433                                         if (opts->long_name)
 434                                                 pos += fprintf(stderr, "[=...]");
 435                                         else
 436                                                 pos += fprintf(stderr, "[...]");
 437                                 else
 438                                         pos += fprintf(stderr, " ...");
 439                         }
 440                         break;
 441                 default: /* OPTION_{BIT,BOOLEAN,SET_INT,SET_PTR} */
 442                         break;
 443                 }
 444
 445                 if (pos <= USAGE_OPTS_WIDTH)
 446                         pad = USAGE_OPTS_WIDTH - pos;
 447                 else {
 448                         fputc('\n', stderr);
 449                         pad = USAGE_OPTS_WIDTH;
 450                 }
 451                 fprintf(stderr, "%*s%s\n", pad + USAGE_GAP, "", opts->help);
 452         }
 453         fputc('\n', stderr);
 454
 455         return PARSE_OPT_HELP;
 456 }
 457
 458 void usage_with_options(const char * const *usagestr,
 459                         const struct option *opts)
 460 {
 461         usage_with_options_internal(usagestr, opts, 0);
 462         exit(129);
 463 }
 464
 465 int parse_options_usage(const char * const *usagestr,
 466                         const struct option *opts)
 467 {
 468         return usage_with_options_internal(usagestr, opts, 0);
 469 }
 470
 471
 472 int parse_opt_verbosity_cb(const struct option *opt, const char *arg,
 473                            int unset)
 474 {
 475         int *target = opt->value;
 476
 477         if (unset)
 478                 /* --no-quiet, --no-verbose */
 479                 *target = 0;
 480         else if (opt->short_name == 'v') {
 481                 if (*target >= 0)
 482                         (*target)++;
 483                 else
 484                         *target = 1;
 485         } else {
 486                 if (*target <= 0)
 487                         (*target)--;
 488                 else
 489                         *target = -1;
 490         }
 491         return 0;
 492 }