args.c

   1 /*
   2  * Copyright (c) 2016, Alliance for Open Media. All rights reserved
   3  *
   4  * This source code is subject to the terms of the BSD 2 Clause License and
   5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
   6  * was not distributed with this source code in the LICENSE file, you can
   7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
   8  * Media Patent License 1.0 was not distributed with this source code in the
   9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
  10  */
  11
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <limits.h>
  15 #include "args.h"
  16
  17 #include "aom/aom_integer.h"
  18 #include "aom_ports/msvc.h"
  19
  20 #if defined(__GNUC__) && __GNUC__
  21 extern void die(const char *fmt, ...) __attribute__((noreturn));
  22 #else
  23 extern void die(const char *fmt, ...);
  24 #endif
  25
  26 struct arg arg_init(char **argv) {
  27   struct arg a;
  28
  29   a.argv = argv;
  30   a.argv_step = 1;
  31   a.name = NULL;
  32   a.val = NULL;
  33   a.def = NULL;
  34   return a;
  35 }
  36
  37 int arg_match(struct arg *arg_, const struct arg_def *def, char **argv) {
  38   struct arg arg;
  39
  40   if (!argv[0] || argv[0][0] != '-') return 0;
  41
  42   arg = arg_init(argv);
  43
  44   if (def->short_name && strlen(arg.argv[0]) == strlen(def->short_name) + 1 &&
  45       !strcmp(arg.argv[0] + 1, def->short_name)) {
  46     arg.name = arg.argv[0] + 1;
  47     arg.val = def->has_val ? arg.argv[1] : NULL;
  48     arg.argv_step = def->has_val ? 2 : 1;
  49   } else if (def->long_name) {
  50     const size_t name_len = strlen(def->long_name);
  51
  52     if (strlen(arg.argv[0]) >= name_len + 2 && arg.argv[0][1] == '-' &&
  53         !strncmp(arg.argv[0] + 2, def->long_name, name_len) &&
  54         (arg.argv[0][name_len + 2] == '=' ||
  55          arg.argv[0][name_len + 2] == '\0')) {
  56       arg.name = arg.argv[0] + 2;
  57       arg.val = arg.name[name_len] == '=' ? arg.name + name_len + 1 : NULL;
  58       arg.argv_step = 1;
  59     }
  60   }
  61
  62   if (arg.name && !arg.val && def->has_val)
  63     die("Error: option %s requires argument.\n", arg.name);
  64
  65   if (arg.name && arg.val && !def->has_val)
  66     die("Error: option %s requires no argument.\n", arg.name);
  67
  68   if (arg.name && (arg.val || !def->has_val)) {
  69     arg.def = def;
  70     *arg_ = arg;
  71     return 1;
  72   }
  73
  74   return 0;
  75 }
  76
  77 const char *arg_next(struct arg *arg) {
  78   if (arg->argv[0]) arg->argv += arg->argv_step;
  79
  80   return *arg->argv;
  81 }
  82
  83 char **argv_dup(int argc, const char **argv) {
  84   char **new_argv = malloc((argc + 1) * sizeof(*argv));
  85
  86   memcpy(new_argv, argv, argc * sizeof(*argv));
  87   new_argv[argc] = NULL;
  88   return new_argv;
  89 }
  90
  91 void arg_show_usage(FILE *fp, const struct arg_def *const *defs) {
  92   char option_text[40] = { 0 };
  93
  94   for (; *defs; defs++) {
  95     const struct arg_def *def = *defs;
  96     char *short_val = def->has_val ? " <arg>" : "";
  97     char *long_val = def->has_val ? "=<arg>" : "";
  98
  99     if (def->short_name && def->long_name) {
 100       char *comma = def->has_val ? "," : ",      ";
 101
 102       snprintf(option_text, 37, "-%s%s%s --%s%6s", def->short_name, short_val,
 103                comma, def->long_name, long_val);
 104     } else if (def->short_name)
 105       snprintf(option_text, 37, "-%s%s", def->short_name, short_val);
 106     else if (def->long_name)
 107       snprintf(option_text, 37, "          --%s%s", def->long_name, long_val);
 108
 109     fprintf(fp, "  %-37s\t%s\n", option_text, def->desc);
 110
 111     if (def->enums) {
 112       const struct arg_enum_list *listptr;
 113
 114       fprintf(fp, "  %-37s\t  ", "");
 115
 116       for (listptr = def->enums; listptr->name; listptr++)
 117         fprintf(fp, "%s%s", listptr->name, listptr[1].name ? ", " : "\n");
 118     }
 119   }
 120 }
 121
 122 unsigned int arg_parse_uint(const struct arg *arg) {
 123   char *endptr;
 124   const unsigned long rawval = strtoul(arg->val, &endptr, 10);  // NOLINT
 125
 126   if (arg->val[0] != '\0' && endptr[0] == '\0') {
 127     if (rawval <= UINT_MAX) return (unsigned int)rawval;
 128
 129     die("Option %s: Value %lu out of range for unsigned int\n", arg->name,
 130         rawval);
 131   }
 132
 133   die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
 134   return 0;
 135 }
 136
 137 int arg_parse_int(const struct arg *arg) {
 138   char *endptr;
 139   const long rawval = strtol(arg->val, &endptr, 10);  // NOLINT
 140
 141   if (arg->val[0] != '\0' && endptr[0] == '\0') {
 142     if (rawval >= INT_MIN && rawval <= INT_MAX) return (int)rawval;
 143
 144     die("Option %s: Value %ld out of range for signed int\n", arg->name,
 145         rawval);
 146   }
 147
 148   die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
 149   return 0;
 150 }
 151
 152 struct aom_rational {
 153   int num; /**< fraction numerator */
 154   int den; /**< fraction denominator */
 155 };
 156 struct aom_rational arg_parse_rational(const struct arg *arg) {
 157   long int rawval;
 158   char *endptr;
 159   struct aom_rational rat;
 160
 161   /* parse numerator */
 162   rawval = strtol(arg->val, &endptr, 10);
 163
 164   if (arg->val[0] != '\0' && endptr[0] == '/') {
 165     if (rawval >= INT_MIN && rawval <= INT_MAX)
 166       rat.num = (int)rawval;
 167     else
 168       die("Option %s: Value %ld out of range for signed int\n", arg->name,
 169           rawval);
 170   } else
 171     die("Option %s: Expected / at '%c'\n", arg->name, *endptr);
 172
 173   /* parse denominator */
 174   rawval = strtol(endptr + 1, &endptr, 10);
 175
 176   if (arg->val[0] != '\0' && endptr[0] == '\0') {
 177     if (rawval >= INT_MIN && rawval <= INT_MAX)
 178       rat.den = (int)rawval;
 179     else
 180       die("Option %s: Value %ld out of range for signed int\n", arg->name,
 181           rawval);
 182   } else
 183     die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
 184
 185   return rat;
 186 }
 187
 188 int arg_parse_enum(const struct arg *arg) {
 189   const struct arg_enum_list *listptr;
 190   long int rawval;
 191   char *endptr;
 192
 193   /* First see if the value can be parsed as a raw value */
 194   rawval = strtol(arg->val, &endptr, 10);
 195   if (arg->val[0] != '\0' && endptr[0] == '\0') {
 196     /* Got a raw value, make sure it's valid */
 197     for (listptr = arg->def->enums; listptr->name; listptr++)
 198       if (listptr->val == rawval) return (int)rawval;
 199   }
 200
 201   /* Next see if it can be parsed as a string */
 202   for (listptr = arg->def->enums; listptr->name; listptr++)
 203     if (!strcmp(arg->val, listptr->name)) return listptr->val;
 204
 205   die("Option %s: Invalid value '%s'\n", arg->name, arg->val);
 206   return 0;
 207 }
 208
 209 int arg_parse_enum_or_int(const struct arg *arg) {
 210   if (arg->def->enums) return arg_parse_enum(arg);
 211   return arg_parse_int(arg);
 212 }
 213
 214 // parse a comma separated list of at most n integers
 215 // return the number of elements in the list
 216 int arg_parse_list(const struct arg *arg, int *list, int n) {
 217   const char *ptr = arg->val;
 218   char *endptr;
 219   int i = 0;
 220
 221   while (ptr[0] != '\0') {
 222     int32_t rawval = (int32_t)strtol(ptr, &endptr, 10);
 223     if (rawval < INT_MIN || rawval > INT_MAX) {
 224       die("Option %s: Value %ld out of range for signed int\n", arg->name,
 225           rawval);
 226     } else if (i >= n) {
 227       die("Option %s: List has more than %d entries\n", arg->name, n);
 228     } else if (*endptr == ',') {
 229       endptr++;
 230     } else if (*endptr != '\0') {
 231       die("Option %s: Bad list separator '%c'\n", arg->name, *endptr);
 232     }
 233     list[i++] = (int)rawval;
 234     ptr = endptr;
 235   }
 236   return i;
 237 }