LXR qemu/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 "qapi/qmp/qlist.h"
  18#include "qapi/qmp/qnum.h"
  19#include "qemu/queue.h"
  20
  21#define QDICT_BUCKET_MAX 512
  22
  23typedef struct QDictEntry {
  24    char *key;
  25    QObject *value;
  26    QLIST_ENTRY(QDictEntry) next;
  27} QDictEntry;
  28
  29typedef struct QDict {
  30    QObject base;
  31    size_t size;
  32    QLIST_HEAD(,QDictEntry) table[QDICT_BUCKET_MAX];
  33} QDict;
  34
  35/* Object API */
  36QDict *qdict_new(void);
  37const char *qdict_entry_key(const QDictEntry *entry);
  38QObject *qdict_entry_value(const QDictEntry *entry);
  39size_t qdict_size(const QDict *qdict);
  40void qdict_put_obj(QDict *qdict, const char *key, QObject *value);
  41void qdict_del(QDict *qdict, const char *key);
  42int qdict_haskey(const QDict *qdict, const char *key);
  43QObject *qdict_get(const QDict *qdict, const char *key);
  44QDict *qobject_to_qdict(const QObject *obj);
  45void qdict_iter(const QDict *qdict,
  46                void (*iter)(const char *key, QObject *obj, void *opaque),
  47                void *opaque);
  48const QDictEntry *qdict_first(const QDict *qdict);
  49const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry);
  50void qdict_destroy_obj(QObject *obj);
  51
  52/* Helper to qdict_put_obj(), accepts any object */
  53#define qdict_put(qdict, key, obj) \
  54        qdict_put_obj(qdict, key, QOBJECT(obj))
  55
  56/* Helpers for int, bool, and string */
  57#define qdict_put_int(qdict, key, value) \
  58        qdict_put(qdict, key, qnum_from_int(value))
  59#define qdict_put_bool(qdict, key, value) \
  60        qdict_put(qdict, key, qbool_from_bool(value))
  61#define qdict_put_str(qdict, key, value) \
  62        qdict_put(qdict, key, qstring_from_str(value))
  63
  64/* High level helpers */
  65double qdict_get_double(const QDict *qdict, const char *key);
  66int64_t qdict_get_int(const QDict *qdict, const char *key);
  67bool qdict_get_bool(const QDict *qdict, const char *key);
  68QList *qdict_get_qlist(const QDict *qdict, const char *key);
  69QDict *qdict_get_qdict(const QDict *qdict, const char *key);
  70const char *qdict_get_str(const QDict *qdict, const char *key);
  71int64_t qdict_get_try_int(const QDict *qdict, const char *key,
  72                          int64_t def_value);
  73bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value);
  74const char *qdict_get_try_str(const QDict *qdict, const char *key);
  75
  76void qdict_copy_default(QDict *dst, QDict *src, const char *key);
  77void qdict_set_default_str(QDict *dst, const char *key, const char *val);
  78
  79QDict *qdict_clone_shallow(const QDict *src);
  80void qdict_flatten(QDict *qdict);
  81
  82void qdict_extract_subqdict(QDict *src, QDict **dst, const char *start);
  83void qdict_array_split(QDict *src, QList **dst);
  84int qdict_array_entries(QDict *src, const char *subqdict);
  85QObject *qdict_crumple(const QDict *src, Error **errp);
  86
  87void qdict_join(QDict *dest, QDict *src, bool overwrite);
  88
  89#endif /* QDICT_H */
  90