xref: /qemu/qobject/qjson.c (revision 01b2ffcedd94ad7b42bc870e4c6936c87ad03429)
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"
20c7eb39cbSEric Blake #include "qapi/qmp/types.h"
21f348b6d1SVeronia Bahaa #include "qemu/unicode.h"
22b4748b9bSAnthony Liguori 
23b4748b9bSAnthony Liguori typedef struct JSONParsingState
24b4748b9bSAnthony Liguori {
25b4748b9bSAnthony Liguori     JSONMessageParser parser;
26b4748b9bSAnthony Liguori     va_list *ap;
27b4748b9bSAnthony Liguori     QObject *result;
2899dbfd1dSMarkus Armbruster     Error *err;
29b4748b9bSAnthony Liguori } JSONParsingState;
30b4748b9bSAnthony Liguori 
3195385fe9SPaolo Bonzini static void parse_json(JSONMessageParser *parser, GQueue *tokens)
32b4748b9bSAnthony Liguori {
33b4748b9bSAnthony Liguori     JSONParsingState *s = container_of(parser, JSONParsingState, parser);
3499dbfd1dSMarkus Armbruster 
3599dbfd1dSMarkus Armbruster     s->result = json_parser_parse_err(tokens, s->ap, &s->err);
36b4748b9bSAnthony Liguori }
37b4748b9bSAnthony Liguori 
3899dbfd1dSMarkus Armbruster QObject *qobject_from_jsonv(const char *string, va_list *ap, Error **errp)
39b4748b9bSAnthony Liguori {
40b4748b9bSAnthony Liguori     JSONParsingState state = {};
41b4748b9bSAnthony Liguori 
428ff5a7d3SLuiz Capitulino     state.ap = ap;
438ff5a7d3SLuiz Capitulino 
44b4748b9bSAnthony Liguori     json_message_parser_init(&state.parser, parse_json);
45b4748b9bSAnthony Liguori     json_message_parser_feed(&state.parser, string, strlen(string));
46b4748b9bSAnthony Liguori     json_message_parser_flush(&state.parser);
47b4748b9bSAnthony Liguori     json_message_parser_destroy(&state.parser);
48b4748b9bSAnthony Liguori 
4999dbfd1dSMarkus Armbruster     error_propagate(errp, state.err);
50b4748b9bSAnthony Liguori     return state.result;
51b4748b9bSAnthony Liguori }
52b4748b9bSAnthony Liguori 
5357348c2fSMarkus Armbruster QObject *qobject_from_json(const char *string, Error **errp)
548ff5a7d3SLuiz Capitulino {
5557348c2fSMarkus Armbruster     return qobject_from_jsonv(string, NULL, errp);
568ff5a7d3SLuiz Capitulino }
578ff5a7d3SLuiz Capitulino 
58668e3cacSLuiz Capitulino /*
59668e3cacSLuiz Capitulino  * IMPORTANT: This function aborts on error, thus it must not
60668e3cacSLuiz Capitulino  * be used with untrusted arguments.
61668e3cacSLuiz Capitulino  */
62b4748b9bSAnthony Liguori QObject *qobject_from_jsonf(const char *string, ...)
63b4748b9bSAnthony Liguori {
648ff5a7d3SLuiz Capitulino     QObject *obj;
65b4748b9bSAnthony Liguori     va_list ap;
66b4748b9bSAnthony Liguori 
67b4748b9bSAnthony Liguori     va_start(ap, string);
68ea5ef5c8SMarkus Armbruster     obj = qobject_from_jsonv(string, &ap, &error_abort);
69b4748b9bSAnthony Liguori     va_end(ap);
70b4748b9bSAnthony Liguori 
71668e3cacSLuiz Capitulino     assert(obj != NULL);
728ff5a7d3SLuiz Capitulino     return obj;
73b4748b9bSAnthony Liguori }
741fd825f7SAnthony Liguori 
751fd825f7SAnthony Liguori typedef struct ToJsonIterState
761fd825f7SAnthony Liguori {
77212b6008SDaniel P. Berrange     int indent;
78212b6008SDaniel P. Berrange     int pretty;
791fd825f7SAnthony Liguori     int count;
801fd825f7SAnthony Liguori     QString *str;
811fd825f7SAnthony Liguori } ToJsonIterState;
821fd825f7SAnthony Liguori 
83212b6008SDaniel P. Berrange static void to_json(const QObject *obj, QString *str, int pretty, int indent);
841fd825f7SAnthony Liguori 
851fd825f7SAnthony Liguori static void to_json_dict_iter(const char *key, QObject *obj, void *opaque)
861fd825f7SAnthony Liguori {
871fd825f7SAnthony Liguori     ToJsonIterState *s = opaque;
881fd825f7SAnthony Liguori     QString *qkey;
89212b6008SDaniel P. Berrange     int j;
901fd825f7SAnthony Liguori 
914b58554aSMax Reitz     if (s->count) {
924b58554aSMax Reitz         qstring_append(s->str, s->pretty ? "," : ", ");
934b58554aSMax Reitz     }
94212b6008SDaniel P. Berrange 
95212b6008SDaniel P. Berrange     if (s->pretty) {
96212b6008SDaniel P. Berrange         qstring_append(s->str, "\n");
97212b6008SDaniel P. Berrange         for (j = 0 ; j < s->indent ; j++)
98212b6008SDaniel P. Berrange             qstring_append(s->str, "    ");
991fd825f7SAnthony Liguori     }
1001fd825f7SAnthony Liguori 
1011fd825f7SAnthony Liguori     qkey = qstring_from_str(key);
102212b6008SDaniel P. Berrange     to_json(QOBJECT(qkey), s->str, s->pretty, s->indent);
1031fd825f7SAnthony Liguori     QDECREF(qkey);
1041fd825f7SAnthony Liguori 
1051fd825f7SAnthony Liguori     qstring_append(s->str, ": ");
106212b6008SDaniel P. Berrange     to_json(obj, s->str, s->pretty, s->indent);
1071fd825f7SAnthony Liguori     s->count++;
1081fd825f7SAnthony Liguori }
1091fd825f7SAnthony Liguori 
1101fd825f7SAnthony Liguori static void to_json_list_iter(QObject *obj, void *opaque)
1111fd825f7SAnthony Liguori {
1121fd825f7SAnthony Liguori     ToJsonIterState *s = opaque;
113212b6008SDaniel P. Berrange     int j;
1141fd825f7SAnthony Liguori 
1154b58554aSMax Reitz     if (s->count) {
1164b58554aSMax Reitz         qstring_append(s->str, s->pretty ? "," : ", ");
1174b58554aSMax Reitz     }
118212b6008SDaniel P. Berrange 
119212b6008SDaniel P. Berrange     if (s->pretty) {
120212b6008SDaniel P. Berrange         qstring_append(s->str, "\n");
121212b6008SDaniel P. Berrange         for (j = 0 ; j < s->indent ; j++)
122212b6008SDaniel P. Berrange             qstring_append(s->str, "    ");
1231fd825f7SAnthony Liguori     }
1241fd825f7SAnthony Liguori 
125212b6008SDaniel P. Berrange     to_json(obj, s->str, s->pretty, s->indent);
1261fd825f7SAnthony Liguori     s->count++;
1271fd825f7SAnthony Liguori }
1281fd825f7SAnthony Liguori 
129212b6008SDaniel P. Berrange static void to_json(const QObject *obj, QString *str, int pretty, int indent)
1301fd825f7SAnthony Liguori {
1311fd825f7SAnthony Liguori     switch (qobject_type(obj)) {
132481b002cSMarkus Armbruster     case QTYPE_QNULL:
133481b002cSMarkus Armbruster         qstring_append(str, "null");
134481b002cSMarkus Armbruster         break;
135*01b2ffceSMarc-André Lureau     case QTYPE_QNUM: {
136*01b2ffceSMarc-André Lureau         QNum *val = qobject_to_qnum(obj);
137*01b2ffceSMarc-André Lureau         char *buffer = qnum_to_string(val);
1381fd825f7SAnthony Liguori         qstring_append(str, buffer);
139*01b2ffceSMarc-André Lureau         g_free(buffer);
1401fd825f7SAnthony Liguori         break;
1411fd825f7SAnthony Liguori     }
1421fd825f7SAnthony Liguori     case QTYPE_QSTRING: {
1431fd825f7SAnthony Liguori         QString *val = qobject_to_qstring(obj);
1441fd825f7SAnthony Liguori         const char *ptr;
145e2ec3f97SMarkus Armbruster         int cp;
146e2ec3f97SMarkus Armbruster         char buf[16];
147e2ec3f97SMarkus Armbruster         char *end;
1481fd825f7SAnthony Liguori 
1491fd825f7SAnthony Liguori         ptr = qstring_get_str(val);
1501fd825f7SAnthony Liguori         qstring_append(str, "\"");
1511fd825f7SAnthony Liguori 
152e2ec3f97SMarkus Armbruster         for (; *ptr; ptr = end) {
153e2ec3f97SMarkus Armbruster             cp = mod_utf8_codepoint(ptr, 6, &end);
154e2ec3f97SMarkus Armbruster             switch (cp) {
1551fd825f7SAnthony Liguori             case '\"':
1561fd825f7SAnthony Liguori                 qstring_append(str, "\\\"");
1571fd825f7SAnthony Liguori                 break;
1581fd825f7SAnthony Liguori             case '\\':
1591fd825f7SAnthony Liguori                 qstring_append(str, "\\\\");
1601fd825f7SAnthony Liguori                 break;
1611fd825f7SAnthony Liguori             case '\b':
1621fd825f7SAnthony Liguori                 qstring_append(str, "\\b");
1631fd825f7SAnthony Liguori                 break;
164bd032695SLuiz Capitulino             case '\f':
165bd032695SLuiz Capitulino                 qstring_append(str, "\\f");
166bd032695SLuiz Capitulino                 break;
1671fd825f7SAnthony Liguori             case '\n':
1681fd825f7SAnthony Liguori                 qstring_append(str, "\\n");
1691fd825f7SAnthony Liguori                 break;
1701fd825f7SAnthony Liguori             case '\r':
1711fd825f7SAnthony Liguori                 qstring_append(str, "\\r");
1721fd825f7SAnthony Liguori                 break;
1731fd825f7SAnthony Liguori             case '\t':
1741fd825f7SAnthony Liguori                 qstring_append(str, "\\t");
1751fd825f7SAnthony Liguori                 break;
176e2ec3f97SMarkus Armbruster             default:
177e2ec3f97SMarkus Armbruster                 if (cp < 0) {
178e2ec3f97SMarkus Armbruster                     cp = 0xFFFD; /* replacement character */
179e2ec3f97SMarkus Armbruster                 }
180e2ec3f97SMarkus Armbruster                 if (cp > 0xFFFF) {
181e2ec3f97SMarkus Armbruster                     /* beyond BMP; need a surrogate pair */
182e2ec3f97SMarkus Armbruster                     snprintf(buf, sizeof(buf), "\\u%04X\\u%04X",
183e2ec3f97SMarkus Armbruster                              0xD800 + ((cp - 0x10000) >> 10),
184e2ec3f97SMarkus Armbruster                              0xDC00 + ((cp - 0x10000) & 0x3FF));
185e2ec3f97SMarkus Armbruster                 } else if (cp < 0x20 || cp >= 0x7F) {
186e2ec3f97SMarkus Armbruster                     snprintf(buf, sizeof(buf), "\\u%04X", cp);
187ff06ea21SAnthony Liguori                 } else {
188e2ec3f97SMarkus Armbruster                     buf[0] = cp;
189e2ec3f97SMarkus Armbruster                     buf[1] = 0;
190e2ec3f97SMarkus Armbruster                 }
1911fd825f7SAnthony Liguori                 qstring_append(str, buf);
192ff06ea21SAnthony Liguori             }
193e2ec3f97SMarkus Armbruster         };
194e2ec3f97SMarkus Armbruster 
1951fd825f7SAnthony Liguori         qstring_append(str, "\"");
1961fd825f7SAnthony Liguori         break;
1971fd825f7SAnthony Liguori     }
1981fd825f7SAnthony Liguori     case QTYPE_QDICT: {
1991fd825f7SAnthony Liguori         ToJsonIterState s;
2001fd825f7SAnthony Liguori         QDict *val = qobject_to_qdict(obj);
2011fd825f7SAnthony Liguori 
2021fd825f7SAnthony Liguori         s.count = 0;
2031fd825f7SAnthony Liguori         s.str = str;
204212b6008SDaniel P. Berrange         s.indent = indent + 1;
205212b6008SDaniel P. Berrange         s.pretty = pretty;
2061fd825f7SAnthony Liguori         qstring_append(str, "{");
2071fd825f7SAnthony Liguori         qdict_iter(val, to_json_dict_iter, &s);
208212b6008SDaniel P. Berrange         if (pretty) {
209212b6008SDaniel P. Berrange             int j;
210212b6008SDaniel P. Berrange             qstring_append(str, "\n");
211212b6008SDaniel P. Berrange             for (j = 0 ; j < indent ; j++)
212212b6008SDaniel P. Berrange                 qstring_append(str, "    ");
213212b6008SDaniel P. Berrange         }
2141fd825f7SAnthony Liguori         qstring_append(str, "}");
2151fd825f7SAnthony Liguori         break;
2161fd825f7SAnthony Liguori     }
2171fd825f7SAnthony Liguori     case QTYPE_QLIST: {
2181fd825f7SAnthony Liguori         ToJsonIterState s;
2191fd825f7SAnthony Liguori         QList *val = qobject_to_qlist(obj);
2201fd825f7SAnthony Liguori 
2211fd825f7SAnthony Liguori         s.count = 0;
2221fd825f7SAnthony Liguori         s.str = str;
223212b6008SDaniel P. Berrange         s.indent = indent + 1;
224212b6008SDaniel P. Berrange         s.pretty = pretty;
2251fd825f7SAnthony Liguori         qstring_append(str, "[");
2261fd825f7SAnthony Liguori         qlist_iter(val, (void *)to_json_list_iter, &s);
227212b6008SDaniel P. Berrange         if (pretty) {
228212b6008SDaniel P. Berrange             int j;
229212b6008SDaniel P. Berrange             qstring_append(str, "\n");
230212b6008SDaniel P. Berrange             for (j = 0 ; j < indent ; j++)
231212b6008SDaniel P. Berrange                 qstring_append(str, "    ");
232212b6008SDaniel P. Berrange         }
2331fd825f7SAnthony Liguori         qstring_append(str, "]");
2341fd825f7SAnthony Liguori         break;
2351fd825f7SAnthony Liguori     }
2361fd825f7SAnthony Liguori     case QTYPE_QBOOL: {
2371fd825f7SAnthony Liguori         QBool *val = qobject_to_qbool(obj);
2381fd825f7SAnthony Liguori 
239fc48ffc3SEric Blake         if (qbool_get_bool(val)) {
2401fd825f7SAnthony Liguori             qstring_append(str, "true");
2411fd825f7SAnthony Liguori         } else {
2421fd825f7SAnthony Liguori             qstring_append(str, "false");
2431fd825f7SAnthony Liguori         }
2441fd825f7SAnthony Liguori         break;
2451fd825f7SAnthony Liguori     }
246a7c31816SMarkus Armbruster     default:
24769dd62dfSKevin Wolf         abort();
2481fd825f7SAnthony Liguori     }
2491fd825f7SAnthony Liguori }
2501fd825f7SAnthony Liguori 
2511fd825f7SAnthony Liguori QString *qobject_to_json(const QObject *obj)
2521fd825f7SAnthony Liguori {
2531fd825f7SAnthony Liguori     QString *str = qstring_new();
2541fd825f7SAnthony Liguori 
255212b6008SDaniel P. Berrange     to_json(obj, str, 0, 0);
256212b6008SDaniel P. Berrange 
257212b6008SDaniel P. Berrange     return str;
258212b6008SDaniel P. Berrange }
259212b6008SDaniel P. Berrange 
260212b6008SDaniel P. Berrange QString *qobject_to_json_pretty(const QObject *obj)
261212b6008SDaniel P. Berrange {
262212b6008SDaniel P. Berrange     QString *str = qstring_new();
263212b6008SDaniel P. Berrange 
264212b6008SDaniel P. Berrange     to_json(obj, str, 1, 0);
2651fd825f7SAnthony Liguori 
2661fd825f7SAnthony Liguori     return str;
2671fd825f7SAnthony Liguori }
268