2010-05-12 23:34:42 +04:00
|
|
|
/*
|
|
|
|
* QDict Module
|
|
|
|
*
|
|
|
|
* Copyright (C) 2009 Red Hat Inc.
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Luiz Capitulino <lcapitulino@redhat.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
|
|
*/
|
|
|
|
|
2009-08-28 22:27:07 +04:00
|
|
|
#ifndef QDICT_H
|
|
|
|
#define QDICT_H
|
|
|
|
|
2012-12-17 21:19:43 +04:00
|
|
|
#include "qapi/qmp/qobject.h"
|
|
|
|
#include "qapi/qmp/qlist.h"
|
2017-06-07 19:35:58 +03:00
|
|
|
#include "qapi/qmp/qnum.h"
|
2012-12-17 21:20:00 +04:00
|
|
|
#include "qemu/queue.h"
|
2009-08-28 22:27:07 +04:00
|
|
|
|
2010-06-07 22:45:22 +04:00
|
|
|
#define QDICT_BUCKET_MAX 512
|
2009-08-28 22:27:07 +04:00
|
|
|
|
|
|
|
typedef struct QDictEntry {
|
|
|
|
char *key;
|
|
|
|
QObject *value;
|
2009-09-12 11:36:22 +04:00
|
|
|
QLIST_ENTRY(QDictEntry) next;
|
2009-08-28 22:27:07 +04:00
|
|
|
} QDictEntry;
|
|
|
|
|
|
|
|
typedef struct QDict {
|
2015-10-15 17:15:32 +03:00
|
|
|
QObject base;
|
2009-08-28 22:27:07 +04:00
|
|
|
size_t size;
|
2010-06-07 22:45:22 +04:00
|
|
|
QLIST_HEAD(,QDictEntry) table[QDICT_BUCKET_MAX];
|
2009-08-28 22:27:07 +04:00
|
|
|
} QDict;
|
|
|
|
|
|
|
|
/* Object API */
|
|
|
|
QDict *qdict_new(void);
|
2010-06-07 23:53:51 +04:00
|
|
|
const char *qdict_entry_key(const QDictEntry *entry);
|
|
|
|
QObject *qdict_entry_value(const QDictEntry *entry);
|
2009-08-28 22:27:07 +04:00
|
|
|
size_t qdict_size(const QDict *qdict);
|
|
|
|
void qdict_put_obj(QDict *qdict, const char *key, QObject *value);
|
|
|
|
void qdict_del(QDict *qdict, const char *key);
|
|
|
|
int qdict_haskey(const QDict *qdict, const char *key);
|
|
|
|
QObject *qdict_get(const QDict *qdict, const char *key);
|
|
|
|
QDict *qobject_to_qdict(const QObject *obj);
|
2009-10-13 20:56:58 +04:00
|
|
|
void qdict_iter(const QDict *qdict,
|
|
|
|
void (*iter)(const char *key, QObject *obj, void *opaque),
|
|
|
|
void *opaque);
|
2010-06-07 23:07:29 +04:00
|
|
|
const QDictEntry *qdict_first(const QDict *qdict);
|
|
|
|
const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry);
|
2015-12-02 08:20:45 +03:00
|
|
|
void qdict_destroy_obj(QObject *obj);
|
2009-08-28 22:27:07 +04:00
|
|
|
|
|
|
|
/* Helper to qdict_put_obj(), accepts any object */
|
|
|
|
#define qdict_put(qdict, key, obj) \
|
|
|
|
qdict_put_obj(qdict, key, QOBJECT(obj))
|
|
|
|
|
2017-08-25 13:59:00 +03:00
|
|
|
/* Helpers for int, bool, null, and string */
|
2017-04-28 00:58:16 +03:00
|
|
|
#define qdict_put_int(qdict, key, value) \
|
2017-06-07 19:35:58 +03:00
|
|
|
qdict_put(qdict, key, qnum_from_int(value))
|
2017-04-28 00:58:16 +03:00
|
|
|
#define qdict_put_bool(qdict, key, value) \
|
|
|
|
qdict_put(qdict, key, qbool_from_bool(value))
|
|
|
|
#define qdict_put_str(qdict, key, value) \
|
|
|
|
qdict_put(qdict, key, qstring_from_str(value))
|
2017-08-25 13:59:00 +03:00
|
|
|
#define qdict_put_null(qdict, key) \
|
|
|
|
qdict_put(qdict, key, qnull())
|
2017-04-28 00:58:16 +03:00
|
|
|
|
2009-08-28 22:27:07 +04:00
|
|
|
/* High level helpers */
|
2010-01-27 19:16:38 +03:00
|
|
|
double qdict_get_double(const QDict *qdict, const char *key);
|
2009-08-28 22:27:07 +04:00
|
|
|
int64_t qdict_get_int(const QDict *qdict, const char *key);
|
2015-05-16 01:25:00 +03:00
|
|
|
bool qdict_get_bool(const QDict *qdict, const char *key);
|
2009-12-10 22:15:54 +03:00
|
|
|
QList *qdict_get_qlist(const QDict *qdict, const char *key);
|
2010-01-22 00:15:39 +03:00
|
|
|
QDict *qdict_get_qdict(const QDict *qdict, const char *key);
|
2009-08-28 22:27:07 +04:00
|
|
|
const char *qdict_get_str(const QDict *qdict, const char *key);
|
|
|
|
int64_t qdict_get_try_int(const QDict *qdict, const char *key,
|
2010-06-05 02:20:54 +04:00
|
|
|
int64_t def_value);
|
2015-05-16 01:25:00 +03:00
|
|
|
bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value);
|
2009-08-28 22:27:07 +04:00
|
|
|
const char *qdict_get_try_str(const QDict *qdict, const char *key);
|
|
|
|
|
2015-01-19 23:22:45 +03:00
|
|
|
void qdict_copy_default(QDict *dst, QDict *src, const char *key);
|
|
|
|
void qdict_set_default_str(QDict *dst, const char *key, const char *val);
|
|
|
|
|
2013-03-15 13:35:03 +04:00
|
|
|
QDict *qdict_clone_shallow(const QDict *src);
|
2013-07-08 19:11:58 +04:00
|
|
|
void qdict_flatten(QDict *qdict);
|
2013-03-15 13:35:03 +04:00
|
|
|
|
2013-09-25 15:30:01 +04:00
|
|
|
void qdict_extract_subqdict(QDict *src, QDict **dst, const char *start);
|
2013-12-20 22:28:03 +04:00
|
|
|
void qdict_array_split(QDict *src, QList **dst);
|
2015-01-21 19:15:44 +03:00
|
|
|
int qdict_array_entries(QDict *src, const char *subqdict);
|
qdict: implement a qdict_crumple method for un-flattening a dict
The qdict_flatten() method will take a dict whose elements are
further nested dicts/lists and flatten them by concatenating
keys.
The qdict_crumple() method aims to do the reverse, taking a flat
qdict, and turning it into a set of nested dicts/lists. It will
apply nesting based on the key name, with a '.' indicating a
new level in the hierarchy. If the keys in the nested structure
are all numeric, it will create a list, otherwise it will create
a dict.
If the keys are a mixture of numeric and non-numeric, or the
numeric keys are not in strictly ascending order, an error will
be reported.
As an example, a flat dict containing
{
'foo.0.bar': 'one',
'foo.0.wizz': '1',
'foo.1.bar': 'two',
'foo.1.wizz': '2'
}
will get turned into a dict with one element 'foo' whose
value is a list. The list elements will each in turn be
dicts.
{
'foo': [
{ 'bar': 'one', 'wizz': '1' },
{ 'bar': 'two', 'wizz': '2' }
],
}
If the key is intended to contain a literal '.', then it must
be escaped as '..'. ie a flat dict
{
'foo..bar': 'wizz',
'bar.foo..bar': 'eek',
'bar.hello': 'world'
}
Will end up as
{
'foo.bar': 'wizz',
'bar': {
'foo.bar': 'eek',
'hello': 'world'
}
}
The intent of this function is that it allows a set of QemuOpts
to be turned into a nested data structure that mirrors the nesting
used when the same object is defined over QMP.
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Message-Id: <1475246744-29302-3-git-send-email-berrange@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Parameter recursive dropped along with its tests; whitespace style
touched up]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2016-09-30 17:45:25 +03:00
|
|
|
QObject *qdict_crumple(const QDict *src, Error **errp);
|
2013-09-25 15:30:01 +04:00
|
|
|
|
2014-05-08 22:12:39 +04:00
|
|
|
void qdict_join(QDict *dest, QDict *src, bool overwrite);
|
|
|
|
|
2009-08-28 22:27:07 +04:00
|
|
|
#endif /* QDICT_H */
|