1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */ 2 /* 3 * Simple streaming JSON writer 4 * 5 * This takes care of the annoying bits of JSON syntax like the commas 6 * after elements 7 * 8 * 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> 16 #include <stdarg.h> 17 18 /* Opaque class structure */ 19 typedef struct json_writer json_writer_t; 20 21 /* Create a new JSON stream */ 22 json_writer_t *jsonw_new(FILE *f); 23 /* End output to JSON stream */ 24 void jsonw_destroy(json_writer_t **self_p); 25 26 /* Cause output to have pretty whitespace */ 27 void jsonw_pretty(json_writer_t *self, bool on); 28 29 /* Add property name */ 30 void jsonw_name(json_writer_t *self, const char *name); 31 32 /* Add value */ 33 void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap); 34 void jsonw_printf(json_writer_t *self, const char *fmt, ...); 35 void jsonw_string(json_writer_t *self, const char *value); 36 void jsonw_bool(json_writer_t *self, bool value); 37 void jsonw_float(json_writer_t *self, double number); 38 void jsonw_float_fmt(json_writer_t *self, const char *fmt, double num); 39 void jsonw_uint(json_writer_t *self, uint64_t number); 40 void jsonw_hu(json_writer_t *self, unsigned short number); 41 void jsonw_int(json_writer_t *self, int64_t number); 42 void jsonw_null(json_writer_t *self); 43 void jsonw_lluint(json_writer_t *self, unsigned long long int num); 44 45 /* Useful Combinations of name and value */ 46 void jsonw_string_field(json_writer_t *self, const char *prop, const char *val); 47 void jsonw_bool_field(json_writer_t *self, const char *prop, bool value); 48 void jsonw_float_field(json_writer_t *self, const char *prop, double num); 49 void jsonw_uint_field(json_writer_t *self, const char *prop, uint64_t num); 50 void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num); 51 void jsonw_int_field(json_writer_t *self, const char *prop, int64_t num); 52 void jsonw_null_field(json_writer_t *self, const char *prop); 53 void jsonw_lluint_field(json_writer_t *self, const char *prop, 54 unsigned long long int num); 55 void jsonw_float_field_fmt(json_writer_t *self, const char *prop, 56 const char *fmt, double val); 57 58 /* Collections */ 59 void jsonw_start_object(json_writer_t *self); 60 void jsonw_end_object(json_writer_t *self); 61 62 void jsonw_start_array(json_writer_t *self); 63 void jsonw_end_array(json_writer_t *self); 64 65 /* Override default exception handling */ 66 typedef void (jsonw_err_handler_fn)(const char *); 67 68 #endif /* _JSON_WRITER_H_ */ 69