xref: /qemu/qobject/qjson.c (revision 47e6b297e76007c04a1e9c492006fe093d932cd9)
1b4748b9bSAnthony Liguori /*
2b4748b9bSAnthony Liguori  * QObject JSON integration
3b4748b9bSAnthony Liguori  *
4b4748b9bSAnthony Liguori  * Copyright IBM, Corp. 2009
5b4748b9bSAnthony Liguori  *
6b4748b9bSAnthony Liguori  * Authors:
7b4748b9bSAnthony Liguori  *  Anthony Liguori   <aliguori@us.ibm.com>
8b4748b9bSAnthony Liguori  *
9b4748b9bSAnthony Liguori  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10b4748b9bSAnthony Liguori  * See the COPYING.LIB file in the top-level directory.
11b4748b9bSAnthony Liguori  *
12b4748b9bSAnthony Liguori  */
13b4748b9bSAnthony Liguori 
14f2ad72b3SPeter Maydell #include "qemu/osdep.h"
1599dbfd1dSMarkus Armbruster #include "qapi/error.h"
167b1b5d19SPaolo Bonzini #include "qapi/qmp/json-lexer.h"
177b1b5d19SPaolo Bonzini #include "qapi/qmp/json-parser.h"
187b1b5d19SPaolo Bonzini #include "qapi/qmp/json-streamer.h"
197b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h"
206b673957SMarkus Armbruster #include "qapi/qmp/qbool.h"
21*47e6b297SMarkus Armbruster #include "qapi/qmp/qlist.h"
2215280c36SMarkus Armbruster #include "qapi/qmp/qnum.h"
23f348b6d1SVeronia Bahaa #include "qemu/unicode.h"
24b4748b9bSAnthony Liguori 
25b4748b9bSAnthony Liguori typedef struct JSONParsingState
26b4748b9bSAnthony Liguori {
27b4748b9bSAnthony Liguori     JSONMessageParser parser;
28b4748b9bSAnthony Liguori     va_list *ap;
29b4748b9bSAnthony Liguori     QObject *result;
3099dbfd1dSMarkus Armbruster     Error *err;
31b4748b9bSAnthony Liguori } JSONParsingState;
32b4748b9bSAnthony Liguori 
3395385fe9SPaolo Bonzini static void parse_json(JSONMessageParser *parser, GQueue *tokens)
34b4748b9bSAnthony Liguori {
35b4748b9bSAnthony Liguori     JSONParsingState *s = container_of(parser, JSONParsingState, parser);
3699dbfd1dSMarkus Armbruster 
3799dbfd1dSMarkus Armbruster     s->result = json_parser_parse_err(tokens, s->ap, &s->err);
38b4748b9bSAnthony Liguori }
39b4748b9bSAnthony Liguori 
4099dbfd1dSMarkus Armbruster QObject *qobject_from_jsonv(const char *string, va_list *ap, Error **errp)
41b4748b9bSAnthony Liguori {
42b4748b9bSAnthony Liguori     JSONParsingState state = {};
43b4748b9bSAnthony Liguori 
448ff5a7d3SLuiz Capitulino     state.ap = ap;
458ff5a7d3SLuiz Capitulino 
46b4748b9bSAnthony Liguori     json_message_parser_init(&state.parser, parse_json);
47b4748b9bSAnthony Liguori     json_message_parser_feed(&state.parser, string, strlen(string));
48b4748b9bSAnthony Liguori     json_message_parser_flush(&state.parser);
49b4748b9bSAnthony Liguori     json_message_parser_destroy(&state.parser);
50b4748b9bSAnthony Liguori 
5199dbfd1dSMarkus Armbruster     error_propagate(errp, state.err);
52b4748b9bSAnthony Liguori     return state.result;
53b4748b9bSAnthony Liguori }
54b4748b9bSAnthony Liguori 
5557348c2fSMarkus Armbruster QObject *qobject_from_json(const char *string, Error **errp)
568ff5a7d3SLuiz Capitulino {
5757348c2fSMarkus Armbruster     return qobject_from_jsonv(string, NULL, errp);
588ff5a7d3SLuiz Capitulino }
598ff5a7d3SLuiz Capitulino 
60668e3cacSLuiz Capitulino /*
61668e3cacSLuiz Capitulino  * IMPORTANT: This function aborts on error, thus it must not
62668e3cacSLuiz Capitulino  * be used with untrusted arguments.
63668e3cacSLuiz Capitulino  */
64b4748b9bSAnthony Liguori QObject *qobject_from_jsonf(const char *string, ...)
65b4748b9bSAnthony Liguori {
668ff5a7d3SLuiz Capitulino     QObject *obj;
67b4748b9bSAnthony Liguori     va_list ap;
68b4748b9bSAnthony Liguori 
69b4748b9bSAnthony Liguori     va_start(ap, string);
70ea5ef5c8SMarkus Armbruster     obj = qobject_from_jsonv(string, &ap, &error_abort);
71b4748b9bSAnthony Liguori     va_end(ap);
72b4748b9bSAnthony Liguori 
73668e3cacSLuiz Capitulino     assert(obj != NULL);
748ff5a7d3SLuiz Capitulino     return obj;
75b4748b9bSAnthony Liguori }
761fd825f7SAnthony Liguori 
771fd825f7SAnthony Liguori typedef struct ToJsonIterState
781fd825f7SAnthony Liguori {
79212b6008SDaniel P. Berrange     int indent;
80212b6008SDaniel P. Berrange     int pretty;
811fd825f7SAnthony Liguori     int count;
821fd825f7SAnthony Liguori     QString *str;
831fd825f7SAnthony Liguori } ToJsonIterState;
841fd825f7SAnthony Liguori 
85212b6008SDaniel P. Berrange static void to_json(const QObject *obj, QString *str, int pretty, int indent);
861fd825f7SAnthony Liguori 
871fd825f7SAnthony Liguori static void to_json_dict_iter(const char *key, QObject *obj, void *opaque)
881fd825f7SAnthony Liguori {
891fd825f7SAnthony Liguori     ToJsonIterState *s = opaque;
901fd825f7SAnthony Liguori     QString *qkey;
91212b6008SDaniel P. Berrange     int j;
921fd825f7SAnthony Liguori 
934b58554aSMax Reitz     if (s->count) {
944b58554aSMax Reitz         qstring_append(s->str, s->pretty ? "," : ", ");
954b58554aSMax Reitz     }
96212b6008SDaniel P. Berrange 
97212b6008SDaniel P. Berrange     if (s->pretty) {
98212b6008SDaniel P. Berrange         qstring_append(s->str, "\n");
99212b6008SDaniel P. Berrange         for (j = 0 ; j < s->indent ; j++)
100212b6008SDaniel P. Berrange             qstring_append(s->str, "    ");
1011fd825f7SAnthony Liguori     }
1021fd825f7SAnthony Liguori 
1031fd825f7SAnthony Liguori     qkey = qstring_from_str(key);
104212b6008SDaniel P. Berrange     to_json(QOBJECT(qkey), s->str, s->pretty, s->indent);
1051fd825f7SAnthony Liguori     QDECREF(qkey);
1061fd825f7SAnthony Liguori 
1071fd825f7SAnthony Liguori     qstring_append(s->str, ": ");
108212b6008SDaniel P. Berrange     to_json(obj, s->str, s->pretty, s->indent);
1091fd825f7SAnthony Liguori     s->count++;
1101fd825f7SAnthony Liguori }
1111fd825f7SAnthony Liguori 
1121fd825f7SAnthony Liguori static void to_json_list_iter(QObject *obj, void *opaque)
1131fd825f7SAnthony Liguori {
1141fd825f7SAnthony Liguori     ToJsonIterState *s = opaque;
115212b6008SDaniel P. Berrange     int j;
1161fd825f7SAnthony Liguori 
1174b58554aSMax Reitz     if (s->count) {
1184b58554aSMax Reitz         qstring_append(s->str, s->pretty ? "," : ", ");
1194b58554aSMax Reitz     }
120212b6008SDaniel P. Berrange 
121212b6008SDaniel P. Berrange     if (s->pretty) {
122212b6008SDaniel P. Berrange         qstring_append(s->str, "\n");
123212b6008SDaniel P. Berrange         for (j = 0 ; j < s->indent ; j++)
124212b6008SDaniel P. Berrange             qstring_append(s->str, "    ");
1251fd825f7SAnthony Liguori     }
1261fd825f7SAnthony Liguori 
127212b6008SDaniel P. Berrange     to_json(obj, s->str, s->pretty, s->indent);
1281fd825f7SAnthony Liguori     s->count++;
1291fd825f7SAnthony Liguori }
1301fd825f7SAnthony Liguori 
131212b6008SDaniel P. Berrange static void to_json(const QObject *obj, QString *str, int pretty, int indent)
1321fd825f7SAnthony Liguori {
1331fd825f7SAnthony Liguori     switch (qobject_type(obj)) {
134481b002cSMarkus Armbruster     case QTYPE_QNULL:
135481b002cSMarkus Armbruster         qstring_append(str, "null");
136481b002cSMarkus Armbruster         break;
13701b2ffceSMarc-André Lureau     case QTYPE_QNUM: {
13801b2ffceSMarc-André Lureau         QNum *val = qobject_to_qnum(obj);
13901b2ffceSMarc-André Lureau         char *buffer = qnum_to_string(val);
1401fd825f7SAnthony Liguori         qstring_append(str, buffer);
14101b2ffceSMarc-André Lureau         g_free(buffer);
1421fd825f7SAnthony Liguori         break;
1431fd825f7SAnthony Liguori     }
1441fd825f7SAnthony Liguori     case QTYPE_QSTRING: {
1451fd825f7SAnthony Liguori         QString *val = qobject_to_qstring(obj);
1461fd825f7SAnthony Liguori         const char *ptr;
147e2ec3f97SMarkus Armbruster         int cp;
148e2ec3f97SMarkus Armbruster         char buf[16];
149e2ec3f97SMarkus Armbruster         char *end;
1501fd825f7SAnthony Liguori 
1511fd825f7SAnthony Liguori         ptr = qstring_get_str(val);
1521fd825f7SAnthony Liguori         qstring_append(str, "\"");
1531fd825f7SAnthony Liguori 
154e2ec3f97SMarkus Armbruster         for (; *ptr; ptr = end) {
155e2ec3f97SMarkus Armbruster             cp = mod_utf8_codepoint(ptr, 6, &end);
156e2ec3f97SMarkus Armbruster             switch (cp) {
1571fd825f7SAnthony Liguori             case '\"':
1581fd825f7SAnthony Liguori                 qstring_append(str, "\\\"");
1591fd825f7SAnthony Liguori                 break;
1601fd825f7SAnthony Liguori             case '\\':
1611fd825f7SAnthony Liguori                 qstring_append(str, "\\\\");
1621fd825f7SAnthony Liguori                 break;
1631fd825f7SAnthony Liguori             case '\b':
1641fd825f7SAnthony Liguori                 qstring_append(str, "\\b");
1651fd825f7SAnthony Liguori                 break;
166bd032695SLuiz Capitulino             case '\f':
167bd032695SLuiz Capitulino                 qstring_append(str, "\\f");
168bd032695SLuiz Capitulino                 break;
1691fd825f7SAnthony Liguori             case '\n':
1701fd825f7SAnthony Liguori                 qstring_append(str, "\\n");
1711fd825f7SAnthony Liguori                 break;
1721fd825f7SAnthony Liguori             case '\r':
1731fd825f7SAnthony Liguori                 qstring_append(str, "\\r");
1741fd825f7SAnthony Liguori                 break;
1751fd825f7SAnthony Liguori             case '\t':
1761fd825f7SAnthony Liguori                 qstring_append(str, "\\t");
1771fd825f7SAnthony Liguori                 break;
178e2ec3f97SMarkus Armbruster             default:
179e2ec3f97SMarkus Armbruster                 if (cp < 0) {
180e2ec3f97SMarkus Armbruster                     cp = 0xFFFD; /* replacement character */
181e2ec3f97SMarkus Armbruster                 }
182e2ec3f97SMarkus Armbruster                 if (cp > 0xFFFF) {
183e2ec3f97SMarkus Armbruster                     /* beyond BMP; need a surrogate pair */
184e2ec3f97SMarkus Armbruster                     snprintf(buf, sizeof(buf), "\\u%04X\\u%04X",
185e2ec3f97SMarkus Armbruster                              0xD800 + ((cp - 0x10000) >> 10),
186e2ec3f97SMarkus Armbruster                              0xDC00 + ((cp - 0x10000) & 0x3FF));
187e2ec3f97SMarkus Armbruster                 } else if (cp < 0x20 || cp >= 0x7F) {
188e2ec3f97SMarkus Armbruster                     snprintf(buf, sizeof(buf), "\\u%04X", cp);
189ff06ea21SAnthony Liguori                 } else {
190e2ec3f97SMarkus Armbruster                     buf[0] = cp;
191e2ec3f97SMarkus Armbruster                     buf[1] = 0;
192e2ec3f97SMarkus Armbruster                 }
1931fd825f7SAnthony Liguori                 qstring_append(str, buf);
194ff06ea21SAnthony Liguori             }
195e2ec3f97SMarkus Armbruster         };
196e2ec3f97SMarkus Armbruster 
1971fd825f7SAnthony Liguori         qstring_append(str, "\"");
1981fd825f7SAnthony Liguori         break;
1991fd825f7SAnthony Liguori     }
2001fd825f7SAnthony Liguori     case QTYPE_QDICT: {
2011fd825f7SAnthony Liguori         ToJsonIterState s;
2021fd825f7SAnthony Liguori         QDict *val = qobject_to_qdict(obj);
2031fd825f7SAnthony Liguori 
2041fd825f7SAnthony Liguori         s.count = 0;
2051fd825f7SAnthony Liguori         s.str = str;
206212b6008SDaniel P. Berrange         s.indent = indent + 1;
207212b6008SDaniel P. Berrange         s.pretty = pretty;
2081fd825f7SAnthony Liguori         qstring_append(str, "{");
2091fd825f7SAnthony Liguori         qdict_iter(val, to_json_dict_iter, &s);
210212b6008SDaniel P. Berrange         if (pretty) {
211212b6008SDaniel P. Berrange             int j;
212212b6008SDaniel P. Berrange             qstring_append(str, "\n");
213212b6008SDaniel P. Berrange             for (j = 0 ; j < indent ; j++)
214212b6008SDaniel P. Berrange                 qstring_append(str, "    ");
215212b6008SDaniel P. Berrange         }
2161fd825f7SAnthony Liguori         qstring_append(str, "}");
2171fd825f7SAnthony Liguori         break;
2181fd825f7SAnthony Liguori     }
2191fd825f7SAnthony Liguori     case QTYPE_QLIST: {
2201fd825f7SAnthony Liguori         ToJsonIterState s;
2211fd825f7SAnthony Liguori         QList *val = qobject_to_qlist(obj);
2221fd825f7SAnthony Liguori 
2231fd825f7SAnthony Liguori         s.count = 0;
2241fd825f7SAnthony Liguori         s.str = str;
225212b6008SDaniel P. Berrange         s.indent = indent + 1;
226212b6008SDaniel P. Berrange         s.pretty = pretty;
2271fd825f7SAnthony Liguori         qstring_append(str, "[");
2281fd825f7SAnthony Liguori         qlist_iter(val, (void *)to_json_list_iter, &s);
229212b6008SDaniel P. Berrange         if (pretty) {
230212b6008SDaniel P. Berrange             int j;
231212b6008SDaniel P. Berrange             qstring_append(str, "\n");
232212b6008SDaniel P. Berrange             for (j = 0 ; j < indent ; j++)
233212b6008SDaniel P. Berrange                 qstring_append(str, "    ");
234212b6008SDaniel P. Berrange         }
2351fd825f7SAnthony Liguori         qstring_append(str, "]");
2361fd825f7SAnthony Liguori         break;
2371fd825f7SAnthony Liguori     }
2381fd825f7SAnthony Liguori     case QTYPE_QBOOL: {
2391fd825f7SAnthony Liguori         QBool *val = qobject_to_qbool(obj);
2401fd825f7SAnthony Liguori 
241fc48ffc3SEric Blake         if (qbool_get_bool(val)) {
2421fd825f7SAnthony Liguori             qstring_append(str, "true");
2431fd825f7SAnthony Liguori         } else {
2441fd825f7SAnthony Liguori             qstring_append(str, "false");
2451fd825f7SAnthony Liguori         }
2461fd825f7SAnthony Liguori         break;
2471fd825f7SAnthony Liguori     }
248a7c31816SMarkus Armbruster     default:
24969dd62dfSKevin Wolf         abort();
2501fd825f7SAnthony Liguori     }
2511fd825f7SAnthony Liguori }
2521fd825f7SAnthony Liguori 
2531fd825f7SAnthony Liguori QString *qobject_to_json(const QObject *obj)
2541fd825f7SAnthony Liguori {
2551fd825f7SAnthony Liguori     QString *str = qstring_new();
2561fd825f7SAnthony Liguori 
257212b6008SDaniel P. Berrange     to_json(obj, str, 0, 0);
258212b6008SDaniel P. Berrange 
259212b6008SDaniel P. Berrange     return str;
260212b6008SDaniel P. Berrange }
261212b6008SDaniel P. Berrange 
262212b6008SDaniel P. Berrange QString *qobject_to_json_pretty(const QObject *obj)
263212b6008SDaniel P. Berrange {
264212b6008SDaniel P. Berrange     QString *str = qstring_new();
265212b6008SDaniel P. Berrange 
266212b6008SDaniel P. Berrange     to_json(obj, str, 1, 0);
2671fd825f7SAnthony Liguori 
2681fd825f7SAnthony Liguori     return str;
2691fd825f7SAnthony Liguori }
270