Blame lib/json_writer.c

Packit Service 3880ab
/* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */
Packit Service 3880ab
/*
Packit Service 3880ab
 * Simple streaming JSON writer
Packit Service 3880ab
 *
Packit Service 3880ab
 * This takes care of the annoying bits of JSON syntax like the commas
Packit Service 3880ab
 * after elements
Packit Service 3880ab
 *
Packit Service 3880ab
 * Authors:	Stephen Hemminger <stephen@networkplumber.org>
Packit Service 3880ab
 */
Packit Service 3880ab
Packit Service 3880ab
#include <stdio.h>
Packit Service 3880ab
#include <stdbool.h>
Packit Service 3880ab
#include <stdarg.h>
Packit Service 3880ab
#include <assert.h>
Packit Service 3880ab
#include <malloc.h>
Packit Service 3880ab
#include <inttypes.h>
Packit Service 3880ab
#include <stdint.h>
Packit Service 3880ab
Packit Service 3880ab
#include "json_writer.h"
Packit Service 3880ab
Packit Service 3880ab
struct json_writer {
Packit Service 3880ab
	FILE		*out;	/* output file */
Packit Service 3880ab
	unsigned	depth;  /* nesting */
Packit Service 3880ab
	bool		pretty; /* optional whitepace */
Packit Service 3880ab
	char		sep;	/* either nul or comma */
Packit Service 3880ab
};
Packit Service 3880ab
Packit Service 3880ab
/* indentation for pretty print */
Packit Service 3880ab
static void jsonw_indent(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	unsigned i;
Packit Service 3880ab
	for (i = 0; i < self->depth; ++i)
Packit Service 3880ab
		fputs("    ", self->out);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* end current line and indent if pretty printing */
Packit Service 3880ab
static void jsonw_eol(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	if (!self->pretty)
Packit Service 3880ab
		return;
Packit Service 3880ab
Packit Service 3880ab
	putc('\n', self->out);
Packit Service 3880ab
	jsonw_indent(self);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* If current object is not empty print a comma */
Packit Service 3880ab
static void jsonw_eor(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	if (self->sep != '\0')
Packit Service 3880ab
		putc(self->sep, self->out);
Packit Service 3880ab
	self->sep = ',';
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
Packit Service 3880ab
/* Output JSON encoded string */
Packit Service 3880ab
/* Handles C escapes, does not do Unicode */
Packit Service 3880ab
static void jsonw_puts(json_writer_t *self, const char *str)
Packit Service 3880ab
{
Packit Service 3880ab
	putc('"', self->out);
Packit Service 3880ab
	for (; *str; ++str)
Packit Service 3880ab
		switch (*str) {
Packit Service 3880ab
		case '\t':
Packit Service 3880ab
			fputs("\\t", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\n':
Packit Service 3880ab
			fputs("\\n", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\r':
Packit Service 3880ab
			fputs("\\r", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\f':
Packit Service 3880ab
			fputs("\\f", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\b':
Packit Service 3880ab
			fputs("\\b", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\\':
Packit Service 3880ab
			fputs("\\\\", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '"':
Packit Service 3880ab
			fputs("\\\"", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		case '\'':
Packit Service 3880ab
			fputs("\\\'", self->out);
Packit Service 3880ab
			break;
Packit Service 3880ab
		default:
Packit Service 3880ab
			putc(*str, self->out);
Packit Service 3880ab
		}
Packit Service 3880ab
	putc('"', self->out);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* Create a new JSON stream */
Packit Service 3880ab
json_writer_t *jsonw_new(FILE *f)
Packit Service 3880ab
{
Packit Service 3880ab
	json_writer_t *self = malloc(sizeof(*self));
Packit Service 3880ab
	if (self) {
Packit Service 3880ab
		self->out = f;
Packit Service 3880ab
		self->depth = 0;
Packit Service 3880ab
		self->pretty = false;
Packit Service 3880ab
		self->sep = '\0';
Packit Service 3880ab
	}
Packit Service 3880ab
	return self;
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* End output to JSON stream */
Packit Service 3880ab
void jsonw_destroy(json_writer_t **self_p)
Packit Service 3880ab
{
Packit Service 3880ab
	json_writer_t *self = *self_p;
Packit Service 3880ab
Packit Service 3880ab
	assert(self->depth == 0);
Packit Service 3880ab
	fputs("\n", self->out);
Packit Service 3880ab
	fflush(self->out);
Packit Service 3880ab
	free(self);
Packit Service 3880ab
	*self_p = NULL;
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_pretty(json_writer_t *self, bool on)
Packit Service 3880ab
{
Packit Service 3880ab
	self->pretty = on;
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* Basic blocks */
Packit Service 3880ab
static void jsonw_begin(json_writer_t *self, int c)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_eor(self);
Packit Service 3880ab
	putc(c, self->out);
Packit Service 3880ab
	++self->depth;
Packit Service 3880ab
	self->sep = '\0';
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
static void jsonw_end(json_writer_t *self, int c)
Packit Service 3880ab
{
Packit Service 3880ab
	assert(self->depth > 0);
Packit Service 3880ab
Packit Service 3880ab
	--self->depth;
Packit Service 3880ab
	if (self->sep != '\0')
Packit Service 3880ab
		jsonw_eol(self);
Packit Service 3880ab
	putc(c, self->out);
Packit Service 3880ab
	self->sep = ',';
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
Packit Service 3880ab
/* Add a JSON property name */
Packit Service 3880ab
void jsonw_name(json_writer_t *self, const char *name)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_eor(self);
Packit Service 3880ab
	jsonw_eol(self);
Packit Service 3880ab
	self->sep = '\0';
Packit Service 3880ab
	jsonw_puts(self, name);
Packit Service 3880ab
	putc(':', self->out);
Packit Service 3880ab
	if (self->pretty)
Packit Service 3880ab
		putc(' ', self->out);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
__attribute__((format(printf, 2, 3)))
Packit Service 3880ab
void jsonw_printf(json_writer_t *self, const char *fmt, ...)
Packit Service 3880ab
{
Packit Service 3880ab
	va_list ap;
Packit Service 3880ab
Packit Service 3880ab
	va_start(ap, fmt);
Packit Service 3880ab
	jsonw_eor(self);
Packit Service 3880ab
	vfprintf(self->out, fmt, ap);
Packit Service 3880ab
	va_end(ap);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* Collections */
Packit Service 3880ab
void jsonw_start_object(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_begin(self, '{');
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_end_object(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_end(self, '}');
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_start_array(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_begin(self, '[');
Packit Service 3880ab
	if (self->pretty)
Packit Service 3880ab
		putc(' ', self->out);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_end_array(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	if (self->pretty && self->sep)
Packit Service 3880ab
		putc(' ', self->out);
Packit Service 3880ab
	self->sep = '\0';
Packit Service 3880ab
	jsonw_end(self, ']');
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* JSON value types */
Packit Service 3880ab
void jsonw_string(json_writer_t *self, const char *value)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_eor(self);
Packit Service 3880ab
	jsonw_puts(self, value);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_bool(json_writer_t *self, bool val)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%s", val ? "true" : "false");
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_null(json_writer_t *self)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "null");
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_float(json_writer_t *self, double num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%g", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_hhu(json_writer_t *self, unsigned char num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%hhu", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_hu(json_writer_t *self, unsigned short num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%hu", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_uint(json_writer_t *self, unsigned int num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%u", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_u64(json_writer_t *self, uint64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%"PRIu64, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_xint(json_writer_t *self, uint64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%"PRIx64, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_luint(json_writer_t *self, unsigned long num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%lu", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_lluint(json_writer_t *self, unsigned long long num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%llu", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_int(json_writer_t *self, int num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%d", num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_s64(json_writer_t *self, int64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_printf(self, "%"PRId64, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
/* Basic name/value objects */
Packit Service 3880ab
void jsonw_string_field(json_writer_t *self, const char *prop, const char *val)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_string(self, val);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_bool_field(json_writer_t *self, const char *prop, bool val)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_bool(self, val);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_float_field(json_writer_t *self, const char *prop, double val)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_float(self, val);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_uint_field(json_writer_t *self, const char *prop, unsigned int num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_uint(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_u64_field(json_writer_t *self, const char *prop, uint64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_u64(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_xint_field(json_writer_t *self, const char *prop, uint64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_xint(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_hhu_field(json_writer_t *self, const char *prop, unsigned char num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_hhu(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_hu_field(json_writer_t *self, const char *prop, unsigned short num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_hu(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_luint_field(json_writer_t *self,
Packit Service 3880ab
			const char *prop,
Packit Service 3880ab
			unsigned long num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_luint(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_lluint_field(json_writer_t *self,
Packit Service 3880ab
			const char *prop,
Packit Service 3880ab
			unsigned long long num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_lluint(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_int_field(json_writer_t *self, const char *prop, int num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_int(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_s64_field(json_writer_t *self, const char *prop, int64_t num)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_s64(self, num);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
void jsonw_null_field(json_writer_t *self, const char *prop)
Packit Service 3880ab
{
Packit Service 3880ab
	jsonw_name(self, prop);
Packit Service 3880ab
	jsonw_null(self);
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
#ifdef TEST
Packit Service 3880ab
int main(int argc, char **argv)
Packit Service 3880ab
{
Packit Service 3880ab
	json_writer_t *wr = jsonw_new(stdout);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_start_object(wr);
Packit Service 3880ab
	jsonw_pretty(wr, true);
Packit Service 3880ab
	jsonw_name(wr, "Vyatta");
Packit Service 3880ab
	jsonw_start_object(wr);
Packit Service 3880ab
	jsonw_string_field(wr, "url", "http://vyatta.com");
Packit Service 3880ab
	jsonw_uint_field(wr, "downloads", 2000000ul);
Packit Service 3880ab
	jsonw_float_field(wr, "stock", 8.16);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_name(wr, "ARGV");
Packit Service 3880ab
	jsonw_start_array(wr);
Packit Service 3880ab
	while (--argc)
Packit Service 3880ab
		jsonw_string(wr, *++argv);
Packit Service 3880ab
	jsonw_end_array(wr);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_name(wr, "empty");
Packit Service 3880ab
	jsonw_start_array(wr);
Packit Service 3880ab
	jsonw_end_array(wr);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_name(wr, "NIL");
Packit Service 3880ab
	jsonw_start_object(wr);
Packit Service 3880ab
	jsonw_end_object(wr);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_null_field(wr, "my_null");
Packit Service 3880ab
Packit Service 3880ab
	jsonw_name(wr, "special chars");
Packit Service 3880ab
	jsonw_start_array(wr);
Packit Service 3880ab
	jsonw_string_field(wr, "slash", "/");
Packit Service 3880ab
	jsonw_string_field(wr, "newline", "\n");
Packit Service 3880ab
	jsonw_string_field(wr, "tab", "\t");
Packit Service 3880ab
	jsonw_string_field(wr, "ff", "\f");
Packit Service 3880ab
	jsonw_string_field(wr, "quote", "\"");
Packit Service 3880ab
	jsonw_string_field(wr, "tick", "\'");
Packit Service 3880ab
	jsonw_string_field(wr, "backslash", "\\");
Packit Service 3880ab
	jsonw_end_array(wr);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_end_object(wr);
Packit Service 3880ab
Packit Service 3880ab
	jsonw_end_object(wr);
Packit Service 3880ab
	jsonw_destroy(&wr);
Packit Service 3880ab
	return 0;
Packit Service 3880ab
}
Packit Service 3880ab
Packit Service 3880ab
#endif