]>
git.proxmox.com Git - mirror_qemu.git/blob - include/qemu/option.h
2 * Commandline option parsing functions
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
29 #include "qemu/queue.h"
31 const char *get_opt_value(const char *p
, char **value
);
33 void parse_option_size(const char *name
, const char *value
,
34 uint64_t *ret
, Error
**errp
);
35 bool has_help_option(const char *param
);
38 QEMU_OPT_STRING
= 0, /* no parsing (use string as-is) */
39 QEMU_OPT_BOOL
, /* on/off */
40 QEMU_OPT_NUMBER
, /* simple number */
41 QEMU_OPT_SIZE
, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */
44 typedef struct QemuOptDesc
{
46 enum QemuOptType type
;
48 const char *def_value_str
;
53 const char *implied_opt_name
;
54 bool merge_lists
; /* Merge multiple uses of option into a single list? */
55 QTAILQ_HEAD(, QemuOpts
) head
;
59 const char *qemu_opt_get(QemuOpts
*opts
, const char *name
);
60 char *qemu_opt_get_del(QemuOpts
*opts
, const char *name
);
62 * qemu_opt_has_help_opt:
63 * @opts: options to search for a help request
65 * Check whether the options specified by @opts include one of the
66 * standard strings which indicate that the user is asking for a
67 * list of the valid values for a command line option (as defined
68 * by is_help_option()).
70 * Returns: true if @opts includes 'help' or equivalent.
72 bool qemu_opt_has_help_opt(QemuOpts
*opts
);
73 QemuOpt
*qemu_opt_find(QemuOpts
*opts
, const char *name
);
74 bool qemu_opt_get_bool(QemuOpts
*opts
, const char *name
, bool defval
);
75 uint64_t qemu_opt_get_number(QemuOpts
*opts
, const char *name
, uint64_t defval
);
76 uint64_t qemu_opt_get_size(QemuOpts
*opts
, const char *name
, uint64_t defval
);
77 bool qemu_opt_get_bool_del(QemuOpts
*opts
, const char *name
, bool defval
);
78 uint64_t qemu_opt_get_number_del(QemuOpts
*opts
, const char *name
,
80 uint64_t qemu_opt_get_size_del(QemuOpts
*opts
, const char *name
,
82 int qemu_opt_unset(QemuOpts
*opts
, const char *name
);
83 void qemu_opt_set(QemuOpts
*opts
, const char *name
, const char *value
,
85 void qemu_opt_set_bool(QemuOpts
*opts
, const char *name
, bool val
,
87 void qemu_opt_set_number(QemuOpts
*opts
, const char *name
, int64_t val
,
89 typedef int (*qemu_opt_loopfunc
)(void *opaque
,
90 const char *name
, const char *value
,
92 int qemu_opt_foreach(QemuOpts
*opts
, qemu_opt_loopfunc func
, void *opaque
,
101 void qemu_opt_iter_init(QemuOptsIter
*iter
, QemuOpts
*opts
, const char *name
);
102 const char *qemu_opt_iter_next(QemuOptsIter
*iter
);
104 QemuOpts
*qemu_opts_find(QemuOptsList
*list
, const char *id
);
105 QemuOpts
*qemu_opts_create(QemuOptsList
*list
, const char *id
,
106 int fail_if_exists
, Error
**errp
);
107 void qemu_opts_reset(QemuOptsList
*list
);
108 void qemu_opts_loc_restore(QemuOpts
*opts
);
109 void qemu_opts_set(QemuOptsList
*list
, const char *id
,
110 const char *name
, const char *value
, Error
**errp
);
111 const char *qemu_opts_id(QemuOpts
*opts
);
112 void qemu_opts_set_id(QemuOpts
*opts
, char *id
);
113 void qemu_opts_del(QemuOpts
*opts
);
114 void qemu_opts_validate(QemuOpts
*opts
, const QemuOptDesc
*desc
, Error
**errp
);
115 void qemu_opts_do_parse(QemuOpts
*opts
, const char *params
,
116 const char *firstname
, Error
**errp
);
117 QemuOpts
*qemu_opts_parse_noisily(QemuOptsList
*list
, const char *params
,
119 QemuOpts
*qemu_opts_parse(QemuOptsList
*list
, const char *params
,
120 bool permit_abbrev
, Error
**errp
);
121 void qemu_opts_set_defaults(QemuOptsList
*list
, const char *params
,
123 QemuOpts
*qemu_opts_from_qdict(QemuOptsList
*list
, const QDict
*qdict
,
125 QDict
*qemu_opts_to_qdict_filtered(QemuOpts
*opts
, QDict
*qdict
,
126 QemuOptsList
*list
, bool del
);
127 QDict
*qemu_opts_to_qdict(QemuOpts
*opts
, QDict
*qdict
);
128 void qemu_opts_absorb_qdict(QemuOpts
*opts
, QDict
*qdict
, Error
**errp
);
130 typedef int (*qemu_opts_loopfunc
)(void *opaque
, QemuOpts
*opts
, Error
**errp
);
131 int qemu_opts_foreach(QemuOptsList
*list
, qemu_opts_loopfunc func
,
132 void *opaque
, Error
**errp
);
133 void qemu_opts_print(QemuOpts
*opts
, const char *sep
);
134 void qemu_opts_print_help(QemuOptsList
*list
, bool print_caption
);
135 void qemu_opts_free(QemuOptsList
*list
);
136 QemuOptsList
*qemu_opts_append(QemuOptsList
*dst
, QemuOptsList
*list
);
138 QDict
*keyval_parse(const char *params
, const char *implied_key
,