args.c 8.41 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar's avatar
John Koleszar committed
3
 *
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar's avatar
John Koleszar committed
10 11 12 13 14 15 16
 */

#include <stdlib.h>
#include <string.h>
#include <limits.h>
#include "args.h"

17
#include "aom/aom_integer.h"
18
#include "aom_ports/msvc.h"
John Koleszar's avatar
John Koleszar committed
19 20 21 22 23 24 25

#if defined(__GNUC__) && __GNUC__
extern void die(const char *fmt, ...) __attribute__((noreturn));
#else
extern void die(const char *fmt, ...);
#endif

John Koleszar's avatar
John Koleszar committed
26 27 28
struct arg arg_init(char **argv) {
  struct arg a;

clang-format's avatar
clang-format committed
29
  a.argv = argv;
John Koleszar's avatar
John Koleszar committed
30
  a.argv_step = 1;
clang-format's avatar
clang-format committed
31 32 33
  a.name = NULL;
  a.val = NULL;
  a.def = NULL;
John Koleszar's avatar
John Koleszar committed
34
  return a;
John Koleszar's avatar
John Koleszar committed
35 36
}

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
char *ignore_front_spaces(const char *str) {
  while (str[0] == ' ' || str[0] == '\t') ++str;
  return (char *)str;
}

void ignore_end_spaces(char *str) {
  char *end = str + strlen(str);
  while (end > str && (end[0] == ' ' || end[0] == '\t' || end[0] == '\n' ||
                       end[0] == '\r' || end[0] == '\0'))
    --end;
  if (end >= str) end[1] = '\0';
}

int arg_cfg(int *argc, char ***argv, const char *file) {
  char **argv_local = (char **)*argv;
  char **argv_org = (char **)*argv;
  char line[1024 * 10];
  FILE *f = fopen(file, "r");
  if (!f) return 1;

  while (fgets(line, sizeof(line) - 1, f)) {
    char *actual_line = ignore_front_spaces(line);
    char *left, *right, *comment;
    size_t length = strlen(actual_line);

    if (length == 0 || actual_line[0] == '#') continue;
    right = strchr(actual_line, ':');
    if (right == NULL) continue;
    right[0] = '\0';

    left = ignore_front_spaces(actual_line);
    right = ignore_front_spaces(right + 1);

    comment = strchr(right, '#');
    if (comment != NULL) comment[0] = '\0';

    ignore_end_spaces(left);
    ignore_end_spaces(right);

    char **new_args = argv_dup(*argc, (const char **)argv_local);
    char *new_line = (char *)malloc(sizeof(*new_line) * 128);

    if (argv_local != argv_org) free(argv_local);

    if (!strcmp(right, "ON"))
      snprintf(new_line, sizeof(*new_line) * 128, "--%s", left);
    else
      snprintf(new_line, sizeof(*new_line) * 128, "--%s=%s", left, right);

    new_args[(*argc) - 1] = new_args[(*argc) - 2];
    new_args[(*argc) - 2] = new_line;
    argv_local = new_args;
    *argv = new_args;
    (*argc)++;
  }
  fclose(f);
  return 0;
}

John Koleszar's avatar
John Koleszar committed
96 97
int arg_match(struct arg *arg_, const struct arg_def *def, char **argv) {
  struct arg arg;
John Koleszar's avatar
John Koleszar committed
98

clang-format's avatar
clang-format committed
99
  if (!argv[0] || argv[0][0] != '-') return 0;
John Koleszar's avatar
John Koleszar committed
100

John Koleszar's avatar
John Koleszar committed
101
  arg = arg_init(argv);
John Koleszar's avatar
John Koleszar committed
102

clang-format's avatar
clang-format committed
103 104
  if (def->short_name && strlen(arg.argv[0]) == strlen(def->short_name) + 1 &&
      !strcmp(arg.argv[0] + 1, def->short_name)) {
John Koleszar's avatar
John Koleszar committed
105 106 107 108
    arg.name = arg.argv[0] + 1;
    arg.val = def->has_val ? arg.argv[1] : NULL;
    arg.argv_step = def->has_val ? 2 : 1;
  } else if (def->long_name) {
John Koleszar's avatar
John Koleszar committed
109
    const size_t name_len = strlen(def->long_name);
John Koleszar's avatar
John Koleszar committed
110

clang-format's avatar
clang-format committed
111 112 113 114
    if (strlen(arg.argv[0]) >= name_len + 2 && arg.argv[0][1] == '-' &&
        !strncmp(arg.argv[0] + 2, def->long_name, name_len) &&
        (arg.argv[0][name_len + 2] == '=' ||
         arg.argv[0][name_len + 2] == '\0')) {
John Koleszar's avatar
John Koleszar committed
115 116 117
      arg.name = arg.argv[0] + 2;
      arg.val = arg.name[name_len] == '=' ? arg.name + name_len + 1 : NULL;
      arg.argv_step = 1;
John Koleszar's avatar
John Koleszar committed
118
    }
John Koleszar's avatar
John Koleszar committed
119
  }
John Koleszar's avatar
John Koleszar committed
120

John Koleszar's avatar
John Koleszar committed
121 122
  if (arg.name && !arg.val && def->has_val)
    die("Error: option %s requires argument.\n", arg.name);
John Koleszar's avatar
John Koleszar committed
123

John Koleszar's avatar
John Koleszar committed
124 125
  if (arg.name && arg.val && !def->has_val)
    die("Error: option %s requires no argument.\n", arg.name);
John Koleszar's avatar
John Koleszar committed
126

clang-format's avatar
clang-format committed
127
  if (arg.name && (arg.val || !def->has_val)) {
John Koleszar's avatar
John Koleszar committed
128 129 130 131
    arg.def = def;
    *arg_ = arg;
    return 1;
  }
John Koleszar's avatar
John Koleszar committed
132

John Koleszar's avatar
John Koleszar committed
133
  return 0;
John Koleszar's avatar
John Koleszar committed
134 135
}

John Koleszar's avatar
John Koleszar committed
136
const char *arg_next(struct arg *arg) {
clang-format's avatar
clang-format committed
137
  if (arg->argv[0]) arg->argv += arg->argv_step;
John Koleszar's avatar
John Koleszar committed
138

John Koleszar's avatar
John Koleszar committed
139
  return *arg->argv;
John Koleszar's avatar
John Koleszar committed
140 141
}

John Koleszar's avatar
John Koleszar committed
142 143
char **argv_dup(int argc, const char **argv) {
  char **new_argv = malloc((argc + 1) * sizeof(*argv));
John Koleszar's avatar
John Koleszar committed
144

John Koleszar's avatar
John Koleszar committed
145 146 147
  memcpy(new_argv, argv, argc * sizeof(*argv));
  new_argv[argc] = NULL;
  return new_argv;
John Koleszar's avatar
John Koleszar committed
148 149
}

John Koleszar's avatar
John Koleszar committed
150
void arg_show_usage(FILE *fp, const struct arg_def *const *defs) {
clang-format's avatar
clang-format committed
151
  char option_text[40] = { 0 };
John Koleszar's avatar
John Koleszar committed
152

John Koleszar's avatar
John Koleszar committed
153 154 155 156
  for (; *defs; defs++) {
    const struct arg_def *def = *defs;
    char *short_val = def->has_val ? " <arg>" : "";
    char *long_val = def->has_val ? "=<arg>" : "";
John Koleszar's avatar
John Koleszar committed
157

John Koleszar's avatar
John Koleszar committed
158 159
    if (def->short_name && def->long_name) {
      char *comma = def->has_val ? "," : ",      ";
160

clang-format's avatar
clang-format committed
161 162
      snprintf(option_text, 37, "-%s%s%s --%s%6s", def->short_name, short_val,
               comma, def->long_name, long_val);
John Koleszar's avatar
John Koleszar committed
163
    } else if (def->short_name)
clang-format's avatar
clang-format committed
164
      snprintf(option_text, 37, "-%s%s", def->short_name, short_val);
John Koleszar's avatar
John Koleszar committed
165
    else if (def->long_name)
clang-format's avatar
clang-format committed
166
      snprintf(option_text, 37, "          --%s%s", def->long_name, long_val);
John Koleszar's avatar
John Koleszar committed
167

John Koleszar's avatar
John Koleszar committed
168
    fprintf(fp, "  %-37s\t%s\n", option_text, def->desc);
John Koleszar's avatar
John Koleszar committed
169

John Koleszar's avatar
John Koleszar committed
170 171
    if (def->enums) {
      const struct arg_enum_list *listptr;
John Koleszar's avatar
John Koleszar committed
172

John Koleszar's avatar
John Koleszar committed
173
      fprintf(fp, "  %-37s\t  ", "");
John Koleszar's avatar
John Koleszar committed
174

John Koleszar's avatar
John Koleszar committed
175
      for (listptr = def->enums; listptr->name; listptr++)
clang-format's avatar
clang-format committed
176
        fprintf(fp, "%s%s", listptr->name, listptr[1].name ? ", " : "\n");
John Koleszar's avatar
John Koleszar committed
177
    }
John Koleszar's avatar
John Koleszar committed
178
  }
John Koleszar's avatar
John Koleszar committed
179 180
}

John Koleszar's avatar
John Koleszar committed
181
unsigned int arg_parse_uint(const struct arg *arg) {
clang-format's avatar
clang-format committed
182
  char *endptr;
183
  const unsigned long rawval = strtoul(arg->val, &endptr, 10);  // NOLINT
John Koleszar's avatar
John Koleszar committed
184

John Koleszar's avatar
John Koleszar committed
185
  if (arg->val[0] != '\0' && endptr[0] == '\0') {
James Zern's avatar
James Zern committed
186
    if (rawval <= UINT_MAX) return (unsigned int)rawval;
John Koleszar's avatar
John Koleszar committed
187

188
    die("Option %s: Value %lu out of range for unsigned int\n", arg->name,
clang-format's avatar
clang-format committed
189
        rawval);
John Koleszar's avatar
John Koleszar committed
190
  }
John Koleszar's avatar
John Koleszar committed
191

John Koleszar's avatar
John Koleszar committed
192 193
  die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
  return 0;
John Koleszar's avatar
John Koleszar committed
194 195
}

John Koleszar's avatar
John Koleszar committed
196
int arg_parse_int(const struct arg *arg) {
clang-format's avatar
clang-format committed
197
  char *endptr;
198
  const long rawval = strtol(arg->val, &endptr, 10);  // NOLINT
John Koleszar's avatar
John Koleszar committed
199

John Koleszar's avatar
John Koleszar committed
200
  if (arg->val[0] != '\0' && endptr[0] == '\0') {
James Zern's avatar
James Zern committed
201
    if (rawval >= INT_MIN && rawval <= INT_MAX) return (int)rawval;
John Koleszar's avatar
John Koleszar committed
202

clang-format's avatar
clang-format committed
203 204
    die("Option %s: Value %ld out of range for signed int\n", arg->name,
        rawval);
John Koleszar's avatar
John Koleszar committed
205
  }
John Koleszar's avatar
John Koleszar committed
206

John Koleszar's avatar
John Koleszar committed
207 208
  die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
  return 0;
John Koleszar's avatar
John Koleszar committed
209 210
}

211
struct aom_rational {
John Koleszar's avatar
John Koleszar committed
212 213
  int num; /**< fraction numerator */
  int den; /**< fraction denominator */
John Koleszar's avatar
John Koleszar committed
214
};
215
struct aom_rational arg_parse_rational(const struct arg *arg) {
clang-format's avatar
clang-format committed
216 217
  long int rawval;
  char *endptr;
218
  struct aom_rational rat;
John Koleszar's avatar
John Koleszar committed
219 220 221 222 223 224

  /* parse numerator */
  rawval = strtol(arg->val, &endptr, 10);

  if (arg->val[0] != '\0' && endptr[0] == '/') {
    if (rawval >= INT_MIN && rawval <= INT_MAX)
James Zern's avatar
James Zern committed
225
      rat.num = (int)rawval;
clang-format's avatar
clang-format committed
226 227 228 229 230
    else
      die("Option %s: Value %ld out of range for signed int\n", arg->name,
          rawval);
  } else
    die("Option %s: Expected / at '%c'\n", arg->name, *endptr);
John Koleszar's avatar
John Koleszar committed
231 232 233 234 235 236

  /* parse denominator */
  rawval = strtol(endptr + 1, &endptr, 10);

  if (arg->val[0] != '\0' && endptr[0] == '\0') {
    if (rawval >= INT_MIN && rawval <= INT_MAX)
James Zern's avatar
James Zern committed
237
      rat.den = (int)rawval;
clang-format's avatar
clang-format committed
238 239 240 241 242
    else
      die("Option %s: Value %ld out of range for signed int\n", arg->name,
          rawval);
  } else
    die("Option %s: Invalid character '%c'\n", arg->name, *endptr);
John Koleszar's avatar
John Koleszar committed
243 244

  return rat;
John Koleszar's avatar
John Koleszar committed
245
}
John Koleszar's avatar
John Koleszar committed
246

John Koleszar's avatar
John Koleszar committed
247 248
int arg_parse_enum(const struct arg *arg) {
  const struct arg_enum_list *listptr;
clang-format's avatar
clang-format committed
249 250
  long int rawval;
  char *endptr;
John Koleszar's avatar
John Koleszar committed
251

John Koleszar's avatar
John Koleszar committed
252 253 254 255 256
  /* First see if the value can be parsed as a raw value */
  rawval = strtol(arg->val, &endptr, 10);
  if (arg->val[0] != '\0' && endptr[0] == '\0') {
    /* Got a raw value, make sure it's valid */
    for (listptr = arg->def->enums; listptr->name; listptr++)
James Zern's avatar
James Zern committed
257
      if (listptr->val == rawval) return (int)rawval;
John Koleszar's avatar
John Koleszar committed
258
  }
John Koleszar's avatar
John Koleszar committed
259

John Koleszar's avatar
John Koleszar committed
260 261
  /* Next see if it can be parsed as a string */
  for (listptr = arg->def->enums; listptr->name; listptr++)
clang-format's avatar
clang-format committed
262
    if (!strcmp(arg->val, listptr->name)) return listptr->val;
John Koleszar's avatar
John Koleszar committed
263 264 265

  die("Option %s: Invalid value '%s'\n", arg->name, arg->val);
  return 0;
John Koleszar's avatar
John Koleszar committed
266 267
}

John Koleszar's avatar
John Koleszar committed
268
int arg_parse_enum_or_int(const struct arg *arg) {
clang-format's avatar
clang-format committed
269
  if (arg->def->enums) return arg_parse_enum(arg);
John Koleszar's avatar
John Koleszar committed
270
  return arg_parse_int(arg);
John Koleszar's avatar
John Koleszar committed
271
}
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

// parse a comma separated list of at most n integers
// return the number of elements in the list
int arg_parse_list(const struct arg *arg, int *list, int n) {
  const char *ptr = arg->val;
  char *endptr;
  int i = 0;

  while (ptr[0] != '\0') {
    int32_t rawval = (int32_t)strtol(ptr, &endptr, 10);
    if (rawval < INT_MIN || rawval > INT_MAX) {
      die("Option %s: Value %ld out of range for signed int\n", arg->name,
          rawval);
    } else if (i >= n) {
      die("Option %s: List has more than %d entries\n", arg->name, n);
    } else if (*endptr == ',') {
      endptr++;
    } else if (*endptr != '\0') {
      die("Option %s: Bad list separator '%c'\n", arg->name, *endptr);
    }
    list[i++] = (int)rawval;
    ptr = endptr;
  }
  return i;
}