Merge remote-tracking branch 'remotes/jnsnow/tags/bitmaps-pull-request' into staging
[qemu/ar7.git] / qobject / qdict.c
blob3d8c2f7bbcc6cc5c9f05bc6ae2613f1dd3efba03
1 /*
2 * QDict Module
4 * Copyright (C) 2009 Red Hat Inc.
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.com>
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.
13 #include "qemu/osdep.h"
14 #include "qapi/qmp/qnum.h"
15 #include "qapi/qmp/qdict.h"
16 #include "qapi/qmp/qbool.h"
17 #include "qapi/qmp/qnull.h"
18 #include "qapi/qmp/qstring.h"
20 /**
21 * qdict_new(): Create a new QDict
23 * Return strong reference.
25 QDict *qdict_new(void)
27 QDict *qdict;
29 qdict = g_malloc0(sizeof(*qdict));
30 qobject_init(QOBJECT(qdict), QTYPE_QDICT);
32 return qdict;
35 /**
36 * tdb_hash(): based on the hash agorithm from gdbm, via tdb
37 * (from module-init-tools)
39 static unsigned int tdb_hash(const char *name)
41 unsigned value; /* Used to compute the hash value. */
42 unsigned i; /* Used to cycle through random values. */
44 /* Set the initial value from the key size. */
45 for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++)
46 value = (value + (((const unsigned char *)name)[i] << (i*5 % 24)));
48 return (1103515243 * value + 12345);
51 /**
52 * alloc_entry(): allocate a new QDictEntry
54 static QDictEntry *alloc_entry(const char *key, QObject *value)
56 QDictEntry *entry;
58 entry = g_malloc0(sizeof(*entry));
59 entry->key = g_strdup(key);
60 entry->value = value;
62 return entry;
65 /**
66 * qdict_entry_value(): Return qdict entry value
68 * Return weak reference.
70 QObject *qdict_entry_value(const QDictEntry *entry)
72 return entry->value;
75 /**
76 * qdict_entry_key(): Return qdict entry key
78 * Return a *pointer* to the string, it has to be duplicated before being
79 * stored.
81 const char *qdict_entry_key(const QDictEntry *entry)
83 return entry->key;
86 /**
87 * qdict_find(): List lookup function
89 static QDictEntry *qdict_find(const QDict *qdict,
90 const char *key, unsigned int bucket)
92 QDictEntry *entry;
94 QLIST_FOREACH(entry, &qdict->table[bucket], next)
95 if (!strcmp(entry->key, key))
96 return entry;
98 return NULL;
102 * qdict_put_obj(): Put a new QObject into the dictionary
104 * Insert the pair 'key:value' into 'qdict', if 'key' already exists
105 * its 'value' will be replaced.
107 * This is done by freeing the reference to the stored QObject and
108 * storing the new one in the same entry.
110 * NOTE: ownership of 'value' is transferred to the QDict
112 void qdict_put_obj(QDict *qdict, const char *key, QObject *value)
114 unsigned int bucket;
115 QDictEntry *entry;
117 bucket = tdb_hash(key) % QDICT_BUCKET_MAX;
118 entry = qdict_find(qdict, key, bucket);
119 if (entry) {
120 /* replace key's value */
121 qobject_unref(entry->value);
122 entry->value = value;
123 } else {
124 /* allocate a new entry */
125 entry = alloc_entry(key, value);
126 QLIST_INSERT_HEAD(&qdict->table[bucket], entry, next);
127 qdict->size++;
131 void qdict_put_int(QDict *qdict, const char *key, int64_t value)
133 qdict_put(qdict, key, qnum_from_int(value));
136 void qdict_put_bool(QDict *qdict, const char *key, bool value)
138 qdict_put(qdict, key, qbool_from_bool(value));
141 void qdict_put_str(QDict *qdict, const char *key, const char *value)
143 qdict_put(qdict, key, qstring_from_str(value));
146 void qdict_put_null(QDict *qdict, const char *key)
148 qdict_put(qdict, key, qnull());
152 * qdict_get(): Lookup for a given 'key'
154 * Return a weak reference to the QObject associated with 'key' if
155 * 'key' is present in the dictionary, NULL otherwise.
157 QObject *qdict_get(const QDict *qdict, const char *key)
159 QDictEntry *entry;
161 entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX);
162 return (entry == NULL ? NULL : entry->value);
166 * qdict_haskey(): Check if 'key' exists
168 * Return 1 if 'key' exists in the dict, 0 otherwise
170 int qdict_haskey(const QDict *qdict, const char *key)
172 unsigned int bucket = tdb_hash(key) % QDICT_BUCKET_MAX;
173 return (qdict_find(qdict, key, bucket) == NULL ? 0 : 1);
177 * qdict_size(): Return the size of the dictionary
179 size_t qdict_size(const QDict *qdict)
181 return qdict->size;
185 * qdict_get_double(): Get an number mapped by 'key'
187 * This function assumes that 'key' exists and it stores a QNum.
189 * Return number mapped by 'key'.
191 double qdict_get_double(const QDict *qdict, const char *key)
193 return qnum_get_double(qobject_to(QNum, qdict_get(qdict, key)));
197 * qdict_get_int(): Get an integer mapped by 'key'
199 * This function assumes that 'key' exists and it stores a
200 * QNum representable as int.
202 * Return integer mapped by 'key'.
204 int64_t qdict_get_int(const QDict *qdict, const char *key)
206 return qnum_get_int(qobject_to(QNum, qdict_get(qdict, key)));
210 * qdict_get_bool(): Get a bool mapped by 'key'
212 * This function assumes that 'key' exists and it stores a
213 * QBool object.
215 * Return bool mapped by 'key'.
217 bool qdict_get_bool(const QDict *qdict, const char *key)
219 return qbool_get_bool(qobject_to(QBool, qdict_get(qdict, key)));
223 * qdict_get_qlist(): If @qdict maps @key to a QList, return it, else NULL.
225 QList *qdict_get_qlist(const QDict *qdict, const char *key)
227 return qobject_to(QList, qdict_get(qdict, key));
231 * qdict_get_qdict(): If @qdict maps @key to a QDict, return it, else NULL.
233 QDict *qdict_get_qdict(const QDict *qdict, const char *key)
235 return qobject_to(QDict, qdict_get(qdict, key));
239 * qdict_get_str(): Get a pointer to the stored string mapped
240 * by 'key'
242 * This function assumes that 'key' exists and it stores a
243 * QString object.
245 * Return pointer to the string mapped by 'key'.
247 const char *qdict_get_str(const QDict *qdict, const char *key)
249 return qstring_get_str(qobject_to(QString, qdict_get(qdict, key)));
253 * qdict_get_try_int(): Try to get integer mapped by 'key'
255 * Return integer mapped by 'key', if it is not present in the
256 * dictionary or if the stored object is not a QNum representing an
257 * integer, 'def_value' will be returned.
259 int64_t qdict_get_try_int(const QDict *qdict, const char *key,
260 int64_t def_value)
262 QNum *qnum = qobject_to(QNum, qdict_get(qdict, key));
263 int64_t val;
265 if (!qnum || !qnum_get_try_int(qnum, &val)) {
266 return def_value;
269 return val;
273 * qdict_get_try_bool(): Try to get a bool mapped by 'key'
275 * Return bool mapped by 'key', if it is not present in the
276 * dictionary or if the stored object is not of QBool type
277 * 'def_value' will be returned.
279 bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value)
281 QBool *qbool = qobject_to(QBool, qdict_get(qdict, key));
283 return qbool ? qbool_get_bool(qbool) : def_value;
287 * qdict_get_try_str(): Try to get a pointer to the stored string
288 * mapped by 'key'
290 * Return a pointer to the string mapped by 'key', if it is not present
291 * in the dictionary or if the stored object is not of QString type
292 * NULL will be returned.
294 const char *qdict_get_try_str(const QDict *qdict, const char *key)
296 QString *qstr = qobject_to(QString, qdict_get(qdict, key));
298 return qstr ? qstring_get_str(qstr) : NULL;
302 * qdict_iter(): Iterate over all the dictionary's stored values.
304 * This function allows the user to provide an iterator, which will be
305 * called for each stored value in the dictionary.
307 void qdict_iter(const QDict *qdict,
308 void (*iter)(const char *key, QObject *obj, void *opaque),
309 void *opaque)
311 int i;
312 QDictEntry *entry;
314 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
315 QLIST_FOREACH(entry, &qdict->table[i], next)
316 iter(entry->key, entry->value, opaque);
320 static QDictEntry *qdict_next_entry(const QDict *qdict, int first_bucket)
322 int i;
324 for (i = first_bucket; i < QDICT_BUCKET_MAX; i++) {
325 if (!QLIST_EMPTY(&qdict->table[i])) {
326 return QLIST_FIRST(&qdict->table[i]);
330 return NULL;
334 * qdict_first(): Return first qdict entry for iteration.
336 const QDictEntry *qdict_first(const QDict *qdict)
338 return qdict_next_entry(qdict, 0);
342 * qdict_next(): Return next qdict entry in an iteration.
344 const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry)
346 QDictEntry *ret;
348 ret = QLIST_NEXT(entry, next);
349 if (!ret) {
350 unsigned int bucket = tdb_hash(entry->key) % QDICT_BUCKET_MAX;
351 ret = qdict_next_entry(qdict, bucket + 1);
354 return ret;
358 * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but
359 * another reference is added.
361 QDict *qdict_clone_shallow(const QDict *src)
363 QDict *dest;
364 QDictEntry *entry;
365 int i;
367 dest = qdict_new();
369 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
370 QLIST_FOREACH(entry, &src->table[i], next) {
371 qdict_put_obj(dest, entry->key, qobject_ref(entry->value));
375 return dest;
379 * qentry_destroy(): Free all the memory allocated by a QDictEntry
381 static void qentry_destroy(QDictEntry *e)
383 assert(e != NULL);
384 assert(e->key != NULL);
385 assert(e->value != NULL);
387 qobject_unref(e->value);
388 g_free(e->key);
389 g_free(e);
393 * qdict_del(): Delete a 'key:value' pair from the dictionary
395 * This will destroy all data allocated by this entry.
397 void qdict_del(QDict *qdict, const char *key)
399 QDictEntry *entry;
401 entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX);
402 if (entry) {
403 QLIST_REMOVE(entry, next);
404 qentry_destroy(entry);
405 qdict->size--;
410 * qdict_is_equal(): Test whether the two QDicts are equal
412 * Here, equality means whether they contain the same keys and whether
413 * the respective values are in turn equal (i.e. invoking
414 * qobject_is_equal() on them yields true).
416 bool qdict_is_equal(const QObject *x, const QObject *y)
418 const QDict *dict_x = qobject_to(QDict, x);
419 const QDict *dict_y = qobject_to(QDict, y);
420 const QDictEntry *e;
422 if (qdict_size(dict_x) != qdict_size(dict_y)) {
423 return false;
426 for (e = qdict_first(dict_x); e; e = qdict_next(dict_x, e)) {
427 const QObject *obj_x = qdict_entry_value(e);
428 const QObject *obj_y = qdict_get(dict_y, qdict_entry_key(e));
430 if (!qobject_is_equal(obj_x, obj_y)) {
431 return false;
435 return true;
439 * qdict_destroy_obj(): Free all the memory allocated by a QDict
441 void qdict_destroy_obj(QObject *obj)
443 int i;
444 QDict *qdict;
446 assert(obj != NULL);
447 qdict = qobject_to(QDict, obj);
449 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
450 QDictEntry *entry = QLIST_FIRST(&qdict->table[i]);
451 while (entry) {
452 QDictEntry *tmp = QLIST_NEXT(entry, next);
453 QLIST_REMOVE(entry, next);
454 qentry_destroy(entry);
455 entry = tmp;
459 g_free(qdict);