Merge remote-tracking branch 'remotes/vivier2/tags/trivial-branch-for-5.2-pull-reques...
[qemu.git] / include / qapi / qmp / qdict.h
1 /*
2 * QDict Module
3 *
4 * Copyright (C) 2009 Red Hat Inc.
5 *
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.com>
8 *
9 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10 * See the COPYING.LIB file in the top-level directory.
11 */
12
13 #ifndef QDICT_H
14 #define QDICT_H
15
16 #include "qapi/qmp/qobject.h"
17 #include "qemu/queue.h"
18
19 #define QDICT_BUCKET_MAX 512
20
21 typedef struct QDictEntry {
22 char *key;
23 QObject *value;
24 QLIST_ENTRY(QDictEntry) next;
25 } QDictEntry;
26
27 struct QDict {
28 struct QObjectBase_ base;
29 size_t size;
30 QLIST_HEAD(,QDictEntry) table[QDICT_BUCKET_MAX];
31 };
32
33 /* Object API */
34 QDict *qdict_new(void);
35 const char *qdict_entry_key(const QDictEntry *entry);
36 QObject *qdict_entry_value(const QDictEntry *entry);
37 size_t qdict_size(const QDict *qdict);
38 void qdict_put_obj(QDict *qdict, const char *key, QObject *value);
39 void qdict_del(QDict *qdict, const char *key);
40 int qdict_haskey(const QDict *qdict, const char *key);
41 QObject *qdict_get(const QDict *qdict, const char *key);
42 bool qdict_is_equal(const QObject *x, const QObject *y);
43 const QDictEntry *qdict_first(const QDict *qdict);
44 const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry);
45 void qdict_destroy_obj(QObject *obj);
46
47 /* Helper to qdict_put_obj(), accepts any object */
48 #define qdict_put(qdict, key, obj) \
49 qdict_put_obj(qdict, key, QOBJECT(obj))
50
51 void qdict_put_bool(QDict *qdict, const char *key, bool value);
52 void qdict_put_int(QDict *qdict, const char *key, int64_t value);
53 void qdict_put_null(QDict *qdict, const char *key);
54 void qdict_put_str(QDict *qdict, const char *key, const char *value);
55
56 double qdict_get_double(const QDict *qdict, const char *key);
57 int64_t qdict_get_int(const QDict *qdict, const char *key);
58 bool qdict_get_bool(const QDict *qdict, const char *key);
59 QList *qdict_get_qlist(const QDict *qdict, const char *key);
60 QDict *qdict_get_qdict(const QDict *qdict, const char *key);
61 const char *qdict_get_str(const QDict *qdict, const char *key);
62 int64_t qdict_get_try_int(const QDict *qdict, const char *key,
63 int64_t def_value);
64 bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value);
65 const char *qdict_get_try_str(const QDict *qdict, const char *key);
66
67 QDict *qdict_clone_shallow(const QDict *src);
68
69 #endif /* QDICT_H */