1 /* $OpenBSD: arguments.c,v 1.26 2019/06/20 07:10:56 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2010 Nicholas Marriott <nicholas.marriott@gmail.com> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER 15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/types.h> 20 21 #include <stdlib.h> 22 #include <string.h> 23 #include <unistd.h> 24 #include <vis.h> 25 26 #include "tmux.h" 27 28 /* 29 * Manipulate command arguments. 30 */ 31 32 struct args_value { 33 char *value; 34 TAILQ_ENTRY(args_value) entry; 35 }; 36 TAILQ_HEAD(args_values, args_value); 37 38 struct args_entry { 39 u_char flag; 40 struct args_values values; 41 RB_ENTRY(args_entry) entry; 42 }; 43 44 static struct args_entry *args_find(struct args *, u_char); 45 46 static int args_cmp(struct args_entry *, struct args_entry *); 47 RB_GENERATE_STATIC(args_tree, args_entry, entry, args_cmp); 48 49 /* Arguments tree comparison function. */ 50 static int 51 args_cmp(struct args_entry *a1, struct args_entry *a2) 52 { 53 return (a1->flag - a2->flag); 54 } 55 56 /* Find a flag in the arguments tree. */ 57 static struct args_entry * 58 args_find(struct args *args, u_char ch) 59 { 60 struct args_entry entry; 61 62 entry.flag = ch; 63 return (RB_FIND(args_tree, &args->tree, &entry)); 64 } 65 66 /* Parse an argv and argc into a new argument set. */ 67 struct args * 68 args_parse(const char *template, int argc, char **argv) 69 { 70 struct args *args; 71 int opt; 72 73 args = xcalloc(1, sizeof *args); 74 75 optreset = 1; 76 optind = 1; 77 78 while ((opt = getopt(argc, argv, template)) != -1) { 79 if (opt < 0) 80 continue; 81 if (opt == '?' || strchr(template, opt) == NULL) { 82 args_free(args); 83 return (NULL); 84 } 85 args_set(args, opt, optarg); 86 } 87 argc -= optind; 88 argv += optind; 89 90 args->argc = argc; 91 args->argv = cmd_copy_argv(argc, argv); 92 93 return (args); 94 } 95 96 /* Free an arguments set. */ 97 void 98 args_free(struct args *args) 99 { 100 struct args_entry *entry; 101 struct args_entry *entry1; 102 struct args_value *value; 103 struct args_value *value1; 104 105 cmd_free_argv(args->argc, args->argv); 106 107 RB_FOREACH_SAFE(entry, args_tree, &args->tree, entry1) { 108 RB_REMOVE(args_tree, &args->tree, entry); 109 TAILQ_FOREACH_SAFE(value, &entry->values, entry, value1) { 110 TAILQ_REMOVE(&entry->values, value, entry); 111 free(value->value); 112 free(value); 113 } 114 free(entry); 115 } 116 117 free(args); 118 } 119 120 /* Add to string. */ 121 static void printflike(3, 4) 122 args_print_add(char **buf, size_t *len, const char *fmt, ...) 123 { 124 va_list ap; 125 char *s; 126 size_t slen; 127 128 va_start(ap, fmt); 129 slen = xvasprintf(&s, fmt, ap); 130 va_end(ap); 131 132 *len += slen; 133 *buf = xrealloc(*buf, *len); 134 135 strlcat(*buf, s, *len); 136 free(s); 137 } 138 139 /* Add value to string. */ 140 static void 141 args_print_add_value(char **buf, size_t *len, struct args_entry *entry, 142 struct args_value *value) 143 { 144 char *escaped; 145 146 if (**buf != '\0') 147 args_print_add(buf, len, " -%c ", entry->flag); 148 else 149 args_print_add(buf, len, "-%c ", entry->flag); 150 151 escaped = args_escape(value->value); 152 args_print_add(buf, len, "%s", escaped); 153 free(escaped); 154 } 155 156 /* Add argument to string. */ 157 static void 158 args_print_add_argument(char **buf, size_t *len, const char *argument) 159 { 160 char *escaped; 161 162 if (**buf != '\0') 163 args_print_add(buf, len, " "); 164 165 escaped = args_escape(argument); 166 args_print_add(buf, len, "%s", escaped); 167 free(escaped); 168 } 169 170 /* Print a set of arguments. */ 171 char * 172 args_print(struct args *args) 173 { 174 size_t len; 175 char *buf; 176 int i; 177 struct args_entry *entry; 178 struct args_value *value; 179 180 len = 1; 181 buf = xcalloc(1, len); 182 183 /* Process the flags first. */ 184 RB_FOREACH(entry, args_tree, &args->tree) { 185 if (!TAILQ_EMPTY(&entry->values)) 186 continue; 187 188 if (*buf == '\0') 189 args_print_add(&buf, &len, "-"); 190 args_print_add(&buf, &len, "%c", entry->flag); 191 } 192 193 /* Then the flags with arguments. */ 194 RB_FOREACH(entry, args_tree, &args->tree) { 195 TAILQ_FOREACH(value, &entry->values, entry) 196 args_print_add_value(&buf, &len, entry, value); 197 } 198 199 /* And finally the argument vector. */ 200 for (i = 0; i < args->argc; i++) 201 args_print_add_argument(&buf, &len, args->argv[i]); 202 203 return (buf); 204 } 205 206 /* Escape an argument. */ 207 char * 208 args_escape(const char *s) 209 { 210 static const char quoted[] = " #\"';${}"; 211 char *escaped, *result; 212 int flags; 213 214 if (*s == '\0') 215 return (xstrdup(s)); 216 if (s[0] != ' ' && 217 (strchr(quoted, s[0]) != NULL || s[0] == '~') && 218 s[1] == '\0') { 219 xasprintf(&escaped, "\\%c", s[0]); 220 return (escaped); 221 } 222 223 flags = VIS_OCTAL|VIS_CSTYLE|VIS_TAB|VIS_NL; 224 if (s[strcspn(s, quoted)] != '\0') 225 flags |= VIS_DQ; 226 utf8_stravis(&escaped, s, flags); 227 228 if (flags & VIS_DQ) { 229 if (*escaped == '~') 230 xasprintf(&result, "\"\\%s\"", escaped); 231 else 232 xasprintf(&result, "\"%s\"", escaped); 233 } else { 234 if (*escaped == '~') 235 xasprintf(&result, "\\%s", escaped); 236 else 237 result = xstrdup(escaped); 238 } 239 free(escaped); 240 return (result); 241 } 242 243 /* Return if an argument is present. */ 244 int 245 args_has(struct args *args, u_char ch) 246 { 247 return (args_find(args, ch) != NULL); 248 } 249 250 /* Set argument value in the arguments tree. */ 251 void 252 args_set(struct args *args, u_char ch, const char *s) 253 { 254 struct args_entry *entry; 255 struct args_value *value; 256 257 entry = args_find(args, ch); 258 if (entry == NULL) { 259 entry = xcalloc(1, sizeof *entry); 260 entry->flag = ch; 261 TAILQ_INIT(&entry->values); 262 RB_INSERT(args_tree, &args->tree, entry); 263 } 264 265 if (s != NULL) { 266 value = xcalloc(1, sizeof *value); 267 value->value = xstrdup(s); 268 TAILQ_INSERT_TAIL(&entry->values, value, entry); 269 } 270 } 271 272 /* Get argument value. Will be NULL if it isn't present. */ 273 const char * 274 args_get(struct args *args, u_char ch) 275 { 276 struct args_entry *entry; 277 278 if ((entry = args_find(args, ch)) == NULL) 279 return (NULL); 280 return (TAILQ_LAST(&entry->values, args_values)->value); 281 } 282 283 /* Get first value in argument. */ 284 const char * 285 args_first_value(struct args *args, u_char ch, struct args_value **value) 286 { 287 struct args_entry *entry; 288 289 if ((entry = args_find(args, ch)) == NULL) 290 return (NULL); 291 292 *value = TAILQ_FIRST(&entry->values); 293 if (*value == NULL) 294 return (NULL); 295 return ((*value)->value); 296 } 297 298 /* Get next value in argument. */ 299 const char * 300 args_next_value(struct args_value **value) 301 { 302 if (*value == NULL) 303 return (NULL); 304 *value = TAILQ_NEXT(*value, entry); 305 if (*value == NULL) 306 return (NULL); 307 return ((*value)->value); 308 } 309 310 /* Convert an argument value to a number. */ 311 long long 312 args_strtonum(struct args *args, u_char ch, long long minval, long long maxval, 313 char **cause) 314 { 315 const char *errstr; 316 long long ll; 317 struct args_entry *entry; 318 struct args_value *value; 319 320 if ((entry = args_find(args, ch)) == NULL) { 321 *cause = xstrdup("missing"); 322 return (0); 323 } 324 value = TAILQ_LAST(&entry->values, args_values); 325 326 ll = strtonum(value->value, minval, maxval, &errstr); 327 if (errstr != NULL) { 328 *cause = xstrdup(errstr); 329 return (0); 330 } 331 332 *cause = NULL; 333 return (ll); 334 } 335