blob: cb9a1993681c6e3997e07343b3d5c9a4a68b9e6e [file] [log] [blame]
Jakub Kicinski907b2232018-12-12 19:59:26 -08001/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
Quentin Monnetb66e9072017-10-23 09:24:05 -07002/*
3 * Simple streaming JSON writer
4 *
5 * This takes care of the annoying bits of JSON syntax like the commas
6 * after elements
7 *
Quentin Monnetb66e9072017-10-23 09:24:05 -07008 * Authors: Stephen Hemminger <stephen@networkplumber.org>
9 */
10
11#ifndef _JSON_WRITER_H_
12#define _JSON_WRITER_H_
13
14#include <stdbool.h>
15#include <stdint.h>
Quentin Monnetf05e2c32017-10-23 09:24:10 -070016#include <stdarg.h>
Quentin Monnetb66e9072017-10-23 09:24:05 -070017
18/* Opaque class structure */
19typedef struct json_writer json_writer_t;
20
21/* Create a new JSON stream */
22json_writer_t *jsonw_new(FILE *f);
23/* End output to JSON stream */
24void jsonw_destroy(json_writer_t **self_p);
25
26/* Cause output to have pretty whitespace */
27void jsonw_pretty(json_writer_t *self, bool on);
28
29/* Add property name */
30void jsonw_name(json_writer_t *self, const char *name);
31
32/* Add value */
Quentin Monnetf05e2c32017-10-23 09:24:10 -070033void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap);
Quentin Monnetb66e9072017-10-23 09:24:05 -070034void jsonw_printf(json_writer_t *self, const char *fmt, ...);
35void jsonw_string(json_writer_t *self, const char *value);
36void jsonw_bool(json_writer_t *self, bool value);
37void jsonw_float(json_writer_t *self, double number);
38void jsonw_float_fmt(json_writer_t *self, const char *fmt, double num);
39void jsonw_uint(json_writer_t *self, uint64_t number);
40void jsonw_hu(json_writer_t *self, unsigned short number);
41void jsonw_int(json_writer_t *self, int64_t number);
42void jsonw_null(json_writer_t *self);
43void jsonw_lluint(json_writer_t *self, unsigned long long int num);
44
45/* Useful Combinations of name and value */
46void jsonw_string_field(json_writer_t *self, const char *prop, const char *val);
47void jsonw_bool_field(json_writer_t *self, const char *prop, bool value);
48void jsonw_float_field(json_writer_t *self, const char *prop, double num);
49void jsonw_uint_field(json_writer_t *self, const char *prop, uint64_t num);
50void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num);
51void jsonw_int_field(json_writer_t *self, const char *prop, int64_t num);
52void jsonw_null_field(json_writer_t *self, const char *prop);
53void jsonw_lluint_field(json_writer_t *self, const char *prop,
54 unsigned long long int num);
55void jsonw_float_field_fmt(json_writer_t *self, const char *prop,
56 const char *fmt, double val);
57
58/* Collections */
59void jsonw_start_object(json_writer_t *self);
60void jsonw_end_object(json_writer_t *self);
61
62void jsonw_start_array(json_writer_t *self);
63void jsonw_end_array(json_writer_t *self);
64
65/* Override default exception handling */
66typedef void (jsonw_err_handler_fn)(const char *);
67
68#endif /* _JSON_WRITER_H_ */