1 /* 2 * Commandline option parsing functions 3 * 4 * Copyright (c) 2003-2008 Fabrice Bellard 5 * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com> 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a copy 8 * of this software and associated documentation files (the "Software"), to deal 9 * in the Software without restriction, including without limitation the rights 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 * copies of the Software, and to permit persons to whom the Software is 12 * furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in 15 * all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 23 * THE SOFTWARE. 24 */ 25 26 #ifndef QEMU_OPTIONS_H 27 #define QEMU_OPTIONS_H 28 29 #include <stdint.h> 30 #include "qemu-queue.h" 31 32 enum QEMUOptionParType { 33 OPT_FLAG, 34 OPT_NUMBER, 35 OPT_SIZE, 36 OPT_STRING, 37 }; 38 39 typedef struct QEMUOptionParameter { 40 const char *name; 41 enum QEMUOptionParType type; 42 union { 43 uint64_t n; 44 char* s; 45 } value; 46 const char *help; 47 } QEMUOptionParameter; 48 49 50 const char *get_opt_name(char *buf, int buf_size, const char *p, char delim); 51 const char *get_opt_value(char *buf, int buf_size, const char *p); 52 int get_next_param_value(char *buf, int buf_size, 53 const char *tag, const char **pstr); 54 int get_param_value(char *buf, int buf_size, 55 const char *tag, const char *str); 56 int check_params(char *buf, int buf_size, 57 const char * const *params, const char *str); 58 59 60 /* 61 * The following functions take a parameter list as input. This is a pointer to 62 * the first element of a QEMUOptionParameter array which is terminated by an 63 * entry with entry->name == NULL. 64 */ 65 66 QEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list, 67 const char *name); 68 int set_option_parameter(QEMUOptionParameter *list, const char *name, 69 const char *value); 70 int set_option_parameter_int(QEMUOptionParameter *list, const char *name, 71 uint64_t value); 72 QEMUOptionParameter *parse_option_parameters(const char *param, 73 QEMUOptionParameter *list, QEMUOptionParameter *dest); 74 void free_option_parameters(QEMUOptionParameter *list); 75 void print_option_parameters(QEMUOptionParameter *list); 76 void print_option_help(QEMUOptionParameter *list); 77 78 /* ------------------------------------------------------------------ */ 79 80 typedef struct QemuOpt QemuOpt; 81 typedef struct QemuOpts QemuOpts; 82 typedef struct QemuOptsList QemuOptsList; 83 84 enum QemuOptType { 85 QEMU_OPT_STRING = 0, /* no parsing (use string as-is) */ 86 QEMU_OPT_BOOL, /* on/off */ 87 QEMU_OPT_NUMBER, /* simple number */ 88 QEMU_OPT_SIZE, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */ 89 }; 90 91 typedef struct QemuOptDesc { 92 const char *name; 93 enum QemuOptType type; 94 const char *help; 95 } QemuOptDesc; 96 97 struct QemuOptsList { 98 const char *name; 99 QTAILQ_HEAD(, QemuOpts) head; 100 QemuOptDesc desc[]; 101 }; 102 103 const char *qemu_opt_get(QemuOpts *opts, const char *name); 104 int qemu_opt_get_bool(QemuOpts *opts, const char *name, int defval); 105 uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); 106 uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); 107 int qemu_opt_set(QemuOpts *opts, const char *name, const char *value); 108 typedef int (*qemu_opt_loopfunc)(const char *name, const char *value, void *opaque); 109 int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, 110 int abort_on_failure); 111 112 QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); 113 QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, int fail_if_exists); 114 int qemu_opts_set(QemuOptsList *list, const char *id, 115 const char *name, const char *value); 116 const char *qemu_opts_id(QemuOpts *opts); 117 void qemu_opts_del(QemuOpts *opts); 118 int qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc); 119 int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname); 120 QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, const char *firstname); 121 122 typedef int (*qemu_opts_loopfunc)(QemuOpts *opts, void *opaque); 123 int qemu_opts_print(QemuOpts *opts, void *dummy); 124 int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque, 125 int abort_on_failure); 126 127 #endif 128