1 /* SPDX-License-Identifier: (GPL-2.0 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 <[email protected]> 9 */ 10 11 #ifndef _JSON_WRITER_H_ 12 #define _JSON_WRITER_H_ 13 14 #include <stdbool.h> 15 #include <stdint.h> 16 17 /* Opaque class structure */ 18 typedef struct json_writer json_writer_t; 19 20 /* Create a new JSON stream */ 21 json_writer_t *jsonw_new(FILE *f); 22 /* End output to JSON stream */ 23 void jsonw_destroy(json_writer_t **self_p); 24 25 /* Cause output to have pretty whitespace */ 26 void jsonw_pretty(json_writer_t *self, bool on); 27 28 /* Add property name */ 29 void jsonw_name(json_writer_t *self, const char *name); 30 31 /* Add value */ 32 __attribute__((format(printf, 2, 3))) 33 void jsonw_printf(json_writer_t *self, const char *fmt, ...); 34 void jsonw_string(json_writer_t *self, const char *value); 35 void jsonw_bool(json_writer_t *self, bool value); 36 void jsonw_float(json_writer_t *self, double number); 37 void jsonw_float_fmt(json_writer_t *self, const char *fmt, double num); 38 void jsonw_uint(json_writer_t *self, unsigned int number); 39 void jsonw_u64(json_writer_t *self, uint64_t number); 40 void jsonw_xint(json_writer_t *self, uint64_t number); 41 void jsonw_hhu(json_writer_t *self, unsigned char num); 42 void jsonw_hu(json_writer_t *self, unsigned short number); 43 void jsonw_int(json_writer_t *self, int number); 44 void jsonw_s64(json_writer_t *self, int64_t number); 45 void jsonw_null(json_writer_t *self); 46 void jsonw_luint(json_writer_t *self, unsigned long num); 47 void jsonw_lluint(json_writer_t *self, unsigned long long num); 48 49 /* Useful Combinations of name and value */ 50 void jsonw_string_field(json_writer_t *self, const char *prop, const char *val); 51 void jsonw_bool_field(json_writer_t *self, const char *prop, bool value); 52 void jsonw_float_field(json_writer_t *self, const char *prop, double num); 53 void jsonw_uint_field(json_writer_t *self, const char *prop, unsigned int num); 54 void jsonw_u64_field(json_writer_t *self, const char *prop, uint64_t num); 55 void jsonw_xint_field(json_writer_t *self, const char *prop, uint64_t num); 56 void jsonw_hhu_field(json_writer_t *self, const char *prop, unsigned char num); 57 void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num); 58 void jsonw_int_field(json_writer_t *self, const char *prop, int num); 59 void jsonw_s64_field(json_writer_t *self, const char *prop, int64_t num); 60 void jsonw_null_field(json_writer_t *self, const char *prop); 61 void jsonw_luint_field(json_writer_t *self, const char *prop, 62 unsigned long num); 63 void jsonw_lluint_field(json_writer_t *self, const char *prop, 64 unsigned long long num); 65 66 /* Collections */ 67 void jsonw_start_object(json_writer_t *self); 68 void jsonw_end_object(json_writer_t *self); 69 70 void jsonw_start_array(json_writer_t *self); 71 void jsonw_end_array(json_writer_t *self); 72 73 /* Override default exception handling */ 74 typedef void (jsonw_err_handler_fn)(const char *); 75 76 #endif /* _JSON_WRITER_H_ */ 77