]> git.proxmox.com Git - mirror_iproute2.git/blame - include/json_writer.h
bridge: man: fix "brige" typo
[mirror_iproute2.git] / include / json_writer.h
CommitLineData
fcc16c22
SH
1/*
2 * Simple streaming JSON writer
3 *
4 * This takes care of the annoying bits of JSON syntax like the commas
5 * after elements
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 * Authors: Stephen Hemminger <stephen@networkplumber.org>
13 */
14
15#ifndef _JSON_WRITER_H_
16#define _JSON_WRITER_H_
17
18#include <stdbool.h>
19#include <stdint.h>
20
21/* Opaque class structure */
22typedef struct json_writer json_writer_t;
23
24/* Create a new JSON stream */
25json_writer_t *jsonw_new(FILE *f);
26/* End output to JSON stream */
27void jsonw_destroy(json_writer_t **self_p);
28
29/* Cause output to have pretty whitespace */
30void jsonw_pretty(json_writer_t *self, bool on);
31
32/* Add property name */
33void jsonw_name(json_writer_t *self, const char *name);
34
35/* Add value */
36void jsonw_string(json_writer_t *self, const char *value);
37void jsonw_bool(json_writer_t *self, bool value);
38void jsonw_float(json_writer_t *self, double number);
39void jsonw_uint(json_writer_t *self, uint64_t number);
40void jsonw_int(json_writer_t *self, int64_t number);
41void jsonw_null(json_writer_t *self);
42
43/* Useful Combinations of name and value */
44void jsonw_string_field(json_writer_t *self, const char *prop, const char *val);
45void jsonw_bool_field(json_writer_t *self, const char *prop, bool value);
46void jsonw_float_field(json_writer_t *self, const char *prop, double num);
47void jsonw_uint_field(json_writer_t *self, const char *prop, uint64_t num);
48void jsonw_int_field(json_writer_t *self, const char *prop, int64_t num);
49void jsonw_null_field(json_writer_t *self, const char *prop);
50
51/* Collections */
52void jsonw_start_object(json_writer_t *self);
53void jsonw_end_object(json_writer_t *self);
54
55void jsonw_start_array(json_writer_t *self);
56void jsonw_end_array(json_writer_t *self);
57
58/* Override default exception handling */
59typedef void (jsonw_err_handler_fn)(const char *);
60
61#endif /* _JSON_WRITER_H_ */