tools/bpf/bpftool/json_writer.h

   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  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version
  11  * 2 of the License, or (at your option) any later version.
  12  *
  13  * Authors:     Stephen Hemminger <stephen@networkplumber.org>
  14  */
  15
  16 #ifndef _JSON_WRITER_H_
  17 #define _JSON_WRITER_H_
  18
  19 #include <stdbool.h>
  20 #include <stdint.h>
  21 #include <stdarg.h>
  22
  23 /* Opaque class structure */
  24 typedef struct json_writer json_writer_t;
  25
  26 /* Create a new JSON stream */
  27 json_writer_t *jsonw_new(FILE *f);
  28 /* End output to JSON stream */
  29 void jsonw_destroy(json_writer_t **self_p);
  30
  31 /* Cause output to have pretty whitespace */
  32 void jsonw_pretty(json_writer_t *self, bool on);
  33
  34 /* Add property name */
  35 void jsonw_name(json_writer_t *self, const char *name);
  36
  37 /* Add value  */
  38 void jsonw_vprintf_enquote(json_writer_t *self, const char *fmt, va_list ap);
  39 void jsonw_printf(json_writer_t *self, const char *fmt, ...);
  40 void jsonw_string(json_writer_t *self, const char *value);
  41 void jsonw_bool(json_writer_t *self, bool value);
  42 void jsonw_float(json_writer_t *self, double number);
  43 void jsonw_float_fmt(json_writer_t *self, const char *fmt, double num);
  44 void jsonw_uint(json_writer_t *self, uint64_t number);
  45 void jsonw_hu(json_writer_t *self, unsigned short number);
  46 void jsonw_int(json_writer_t *self, int64_t number);
  47 void jsonw_null(json_writer_t *self);
  48 void jsonw_lluint(json_writer_t *self, unsigned long long int num);
  49
  50 /* Useful Combinations of name and value */
  51 void jsonw_string_field(json_writer_t *self, const char *prop, const char *val);
  52 void jsonw_bool_field(json_writer_t *self, const char *prop, bool value);
  53 void jsonw_float_field(json_writer_t *self, const char *prop, double num);
  54 void jsonw_uint_field(json_writer_t *self, const char *prop, uint64_t num);
  55 void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num);
  56 void jsonw_int_field(json_writer_t *self, const char *prop, int64_t num);
  57 void jsonw_null_field(json_writer_t *self, const char *prop);
  58 void jsonw_lluint_field(json_writer_t *self, const char *prop,
  59                         unsigned long long int num);
  60 void jsonw_float_field_fmt(json_writer_t *self, const char *prop,
  61                            const char *fmt, double val);
  62
  63 /* Collections */
  64 void jsonw_start_object(json_writer_t *self);
  65 void jsonw_end_object(json_writer_t *self);
  66
  67 void jsonw_start_array(json_writer_t *self);
  68 void jsonw_end_array(json_writer_t *self);
  69
  70 /* Override default exception handling */
  71 typedef void (jsonw_err_handler_fn)(const char *);
  72
  73 #endif /* _JSON_WRITER_H_ */