json_writer.h 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. #ifndef _JSON_WRITER_H_
  15. #define _JSON_WRITER_H_
  16. #include <stdbool.h>
  17. #include <stdint.h>
  18. #include <stdarg.h>
  19. /* Opaque class structure */
  20. typedef struct json_writer json_writer_t;
  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. /* Cause output to have pretty whitespace */
  26. void jsonw_pretty(json_writer_t *self, bool on);
  27. /* Add property name */
  28. void jsonw_name(json_writer_t *self, const char *name);
  29. /* Add value */
  30. void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap);
  31. void jsonw_printf(json_writer_t *self, const char *fmt, ...);
  32. void jsonw_string(json_writer_t *self, const char *value);
  33. void jsonw_bool(json_writer_t *self, bool value);
  34. void jsonw_float(json_writer_t *self, double number);
  35. void jsonw_float_fmt(json_writer_t *self, const char *fmt, double num);
  36. void jsonw_uint(json_writer_t *self, uint64_t number);
  37. void jsonw_hu(json_writer_t *self, unsigned short number);
  38. void jsonw_int(json_writer_t *self, int64_t number);
  39. void jsonw_null(json_writer_t *self);
  40. void jsonw_lluint(json_writer_t *self, unsigned long long int num);
  41. /* Useful Combinations of name and value */
  42. void jsonw_string_field(json_writer_t *self, const char *prop, const char *val);
  43. void jsonw_bool_field(json_writer_t *self, const char *prop, bool value);
  44. void jsonw_float_field(json_writer_t *self, const char *prop, double num);
  45. void jsonw_uint_field(json_writer_t *self, const char *prop, uint64_t num);
  46. void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num);
  47. void jsonw_int_field(json_writer_t *self, const char *prop, int64_t num);
  48. void jsonw_null_field(json_writer_t *self, const char *prop);
  49. void jsonw_lluint_field(json_writer_t *self, const char *prop,
  50. unsigned long long int num);
  51. void jsonw_float_field_fmt(json_writer_t *self, const char *prop,
  52. const char *fmt, double val);
  53. /* Collections */
  54. void jsonw_start_object(json_writer_t *self);
  55. void jsonw_end_object(json_writer_t *self);
  56. void jsonw_start_array(json_writer_t *self);
  57. void jsonw_end_array(json_writer_t *self);
  58. /* Override default exception handling */
  59. typedef void (jsonw_err_handler_fn)(const char *);
  60. #endif /* _JSON_WRITER_H_ */