tmux/json.c

/*
 * Copyright (c) 2026 Dane Jensen <dhcjensen@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/types.h>

#include <ctype.h>
#include <errno.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>

#include "tmux.h"

#define TOKENS_MAX	4096
#define ERROR_CTX_LEN	8

/* JSON Token types. */
enum json_token_type {
	TOK_OPENOBJECT,
	TOK_CLOSEOBJECT,
	TOK_OPENARRAY,
	TOK_CLOSEARRAY,
	TOK_COMMA,
	TOK_COLON,
	TOK_QUOTE,
	TOK_VALUE,
	TOK_EOF
};

/* JSON token. */
struct json_token {
	enum json_token_type	type;
	struct json_string	val;
};

/* JSON tokens. */
struct json_tokens {
	struct json_token	*toks;
	int			 size;
};

static struct json_tokens *json_tokenize_input(const char *, char **);
static int		 json_tokenize_value(struct json_tokens *, const char *,
			     struct json_string *);
static struct json_tokens *json_create_tokens(void);
static void		 json_free_tokens(struct json_tokens *);
static int		 json_add_token(struct json_tokens *,
			     enum json_token_type, struct json_string *);
static const struct json_token *json_tokens_tail(struct json_tokens *);

static struct json_node	*json_create_node(struct json_node *,
			     enum json_node_type, struct json_string *,
			     const void *);
static void		 json_assign_value(struct json_node *, const void *);
static struct json_node *json_parse_tokens(struct json_tokens **, char **);
static int		 json_parse_key(struct json_token **,
			     struct json_string *, char **);
static struct json_node	*json_parse_object(struct json_token **,
			     struct json_node *, struct json_string *, char **);
static struct json_node	*json_parse_array(struct json_token **,
			     struct json_node *, struct json_string *, char **);
static struct json_node	*json_parse_string(struct json_token **,
			     struct json_node *, struct json_string *, char **);
static struct json_node	*json_parse_number(struct json_token **,
			     struct json_node *, struct json_string *, char **);
static struct json_node	*json_parse_boolean(struct json_token **,
			     struct json_node *, struct json_string *, char **);

/* Fill an error cause. */
static void
json_error(char **cause, const char *reason, const char *input)
{
	const char	*ellipsis = "...";
	int		 i;

	if (input == NULL || *input == '\0') {
		xasprintf(cause, "%s", reason);
		return;
	}

	for (i = 0; i < ERROR_CTX_LEN; i++) {
		if (input[i] == '\0') {
			ellipsis = "";
			break;
		}
	}

	xasprintf(cause, "%s: %.*s%s", reason, ERROR_CTX_LEN, input, ellipsis);
}

/* Wrapper for string views with strcmp semantics. */
static int
jstrcmp(const struct json_string *jstr, const char *s)
{
	size_t	slen;

	slen = strlen(s);
	if ((size_t)jstr->len < slen)
		return (-1);
	if ((size_t)jstr->len > slen)
		return (1);

	return (memcmp(jstr->ptr, s, jstr->len));
}

/* Tokenize the json string. */
static struct json_tokens *
json_tokenize_input(const char *input, char **cause)
{
	struct json_tokens	*tokens = json_create_tokens();
	enum json_token_type	 type;
	struct json_string	 jstr;
	int			 scan;

	while (*input != '\0') {
		if (tokens->size >= TOKENS_MAX)
			goto fail;

		jstr.ptr = input;
		jstr.len = 1;

		switch (*input) {
		case ' ':
		case '\t':
		case '\n':
		case '\r':
			input++;
			continue;
		case '{':
			type = TOK_OPENOBJECT;
			break;
		case '}':
			type = TOK_CLOSEOBJECT;
			break;
		case '[':
			type = TOK_OPENARRAY;
			break;
		case ']':
			type = TOK_CLOSEARRAY;
			break;
		case '"':
			type = TOK_QUOTE;
			break;
		case ':':
			type = TOK_COLON;
			break;
		case ',':
			type = TOK_COMMA;
			break;
		default:
			type = TOK_VALUE;
			scan = json_tokenize_value(tokens, input, &jstr);
			if (scan == -1)
				goto fail;
			input += scan - 1;
		}
		if (json_add_token(tokens, type, &jstr) != 0)
			goto fail;

		input++;
	}
	if (json_add_token(tokens, TOK_EOF, NULL) != 0)
		goto fail;

	return (tokens);
fail:
	json_error(cause, "tokenization error", input);
	json_free_tokens(tokens);
	return (NULL);
}

/*
 * Tokenize a value from the input string. Strings are terminated by a '"', and
 * numbers/booleans are terminated by a ',', ']', '}', or whitespace.
 */
static int
json_tokenize_value(struct json_tokens *tokens, const char *input,
    struct json_string *jstr)
{
	const struct json_token	*prev = json_tokens_tail(tokens);
	int			 scan = 0, escaping = 0;

	if (prev == NULL)
		return (-1);
	if (prev->type == TOK_QUOTE) {
		do {
			if (input[scan] == '\0')
				return (-1);
			if (input[scan] == '\\' && !escaping)
				escaping = 1;
			else if (escaping)
				escaping = 0;
			scan++;
		} while (input[scan] != '"' || escaping);
	} else if (prev->type == TOK_COLON) {
		do {
			if (input[scan] == '\0')
				return (-1);
			scan++;
		} while (input[scan] != ']' && input[scan] != '}' &&
		    input[scan] != ',' && !isspace((u_char) input[scan]));
	} else
		return (-1);

	jstr->ptr = input;
	jstr->len = scan;

	return (scan);
}

/* Create a new token container. */
static struct json_tokens *
json_create_tokens(void)
{
	struct json_tokens	*tokens;

	tokens = xmalloc(sizeof *tokens);
	tokens->size = 0;
	tokens->toks = xmalloc(sizeof *tokens->toks * TOKENS_MAX);

	return (tokens);
}

/* Free a token container. */
static void
json_free_tokens(struct json_tokens *tokens)
{
	free(tokens->toks);
	tokens->toks = NULL;
	free(tokens);
}

/* Add a token to tokens. */
static int
json_add_token(struct json_tokens *tokens, enum json_token_type type,
    struct json_string *jstr)
{
	struct json_token	*tok;

	if (tokens->size >= TOKENS_MAX)
		return (-1);

	tok = &tokens->toks[tokens->size++];
	tok->type = type;
	if (jstr != NULL) {
		tok->val.ptr = jstr->ptr;
		tok->val.len = jstr->len;
	} else {
		tok->val.ptr = NULL;
		tok->val.len = 0;
	}

	return (0);
}

/* Returns a reference to the last token. */
static const struct json_token *
json_tokens_tail(struct json_tokens *tokens)
{
	if (tokens->size == 0)
		return (NULL);
	return (&tokens->toks[tokens->size - 1]);
}

/* Create a node and assign given values. */
static struct json_node *
json_create_node(struct json_node *parent, enum json_node_type type,
    struct json_string *key, const void *val)
{
	struct json_node	*node;

	node = xcalloc(1, sizeof *node);
	node->parent = parent;
	if (key != NULL) {
		node->key.ptr = key->ptr;
		node->key.len = key->len;
	}
	node->type = type;
	TAILQ_INIT(&node->val.fields);
	if (val != NULL)
		json_assign_value(node, val);

	return (node);
}

/* Assign a value to a node. */
static void
json_assign_value(struct json_node *node, const void *val)
{
	struct json_node	*child;
	struct json_string	*jstr;

	switch (node->type) {
	case NODE_STRING:
		jstr = (struct json_string *)val;
		node->val.jstr.ptr = jstr->ptr;
		node->val.jstr.len = jstr->len;
		break;
	case NODE_NUMBER:
		node->val.num = *(int64_t *)val;
		break;
	case NODE_BOOLEAN:
		node->val.boolean = *(int *)val;
		break;
	case NODE_OBJECT:
	case NODE_ARRAY:
		child = (struct json_node *)val;
		TAILQ_INSERT_TAIL(&node->val.fields, child, entry);
		break;
	default:
		fatalx("unknown node type");
	}
}

/* Destroy a node and all of the node's fields. */
void
json_destroy_node(struct json_node *node)
{
	struct json_node	*field;

	if (node == NULL)
		return;

	switch (node->type) {
	case NODE_STRING:
	case NODE_NUMBER:
	case NODE_BOOLEAN:
		break;
	case NODE_OBJECT:
	case NODE_ARRAY:
		while (!TAILQ_EMPTY(&node->val.fields)) {
			field = TAILQ_FIRST(&node->val.fields);
			TAILQ_REMOVE(&node->val.fields, field, entry);
			json_destroy_node(field);
		}
		break;
	}

	free(node);
}

/* Parse an input string into JSON. */
struct json_node *
json_parse(const char *input, char **cause)
{
	struct json_tokens	*tokens;

	if ((tokens = json_tokenize_input(input, cause)) == NULL)
		return (NULL);

	return (json_parse_tokens(&tokens, cause));
}

/* Parse a stream of tokens into nodes. Consumes the tokens. */
static struct json_node *
json_parse_tokens(struct json_tokens **tokens, char **cause)
{
	struct json_token	*toks = (*tokens)->toks;
	struct json_node	*json = NULL;

	if (toks->type == TOK_OPENOBJECT)
		json = json_parse_object(&toks, NULL, NULL, cause);
	else {
		json_error(cause, "expected object", toks->val.ptr);
		goto fail;
	}

	if (json == NULL)
		goto fail;

	if (toks->type != TOK_EOF) {
		json_error(cause, "unexpected trailing data", toks->val.ptr);
		goto fail;
	}
	json_free_tokens(*tokens);
	*tokens = NULL;

	return (json);
fail:
	if (json != NULL)
		json_destroy_node(json);
	json_free_tokens(*tokens);
	*tokens = NULL;
	return (NULL);
}

/* Parse and return a key string, and advance the token pointer. */
static int
json_parse_key(struct json_token **toks, struct json_string *jstr,
    char **cause)
{
	const char	*start = (*toks)->val.ptr;

	if ((*toks)->type != TOK_QUOTE)
		goto fail;
	(*toks)++;
	if ((*toks)->type != TOK_VALUE)
		goto fail;

	jstr->ptr = (*toks)->val.ptr;
	jstr->len = (*toks)->val.len;

	(*toks)++;
	if ((*toks)->type != TOK_QUOTE)
		goto fail;

	(*toks)++;

	return (0);
fail:
	json_error(cause, "invalid key", start);
	return (-1);
}

/* Parse an object value, return the node, and advance the token pointer. */
static struct json_node *
json_parse_object(struct json_token **toks, struct json_node *parent,
    struct json_string *key, char **cause)
{
	struct json_node	*object, *field;
	struct json_string	 fkey, *val;
	u_char			*valstr;

	if ((*toks)->type != TOK_OPENOBJECT)
		return (NULL);
	(*toks)++;

	object = json_create_node(parent, NODE_OBJECT, key, NULL);
	while ((*toks)->type != TOK_CLOSEOBJECT) {
		if (json_parse_key(toks, &fkey, cause) != 0)
			goto fail;
		if ((*toks)->type != TOK_COLON) {
			json_error(cause, "missing colon", (*toks)->val.ptr);
			goto fail;
		}
		(*toks)++;

		switch ((*toks)->type) {
		case TOK_QUOTE:
			field = json_parse_string(toks, object, &fkey, cause);
			break;
		case TOK_VALUE:
			val = &(*toks)->val;
			valstr = (u_char *)val->ptr;
			if (jstrcmp(val, "true") == 0 ||
			    jstrcmp(val, "false") == 0) {
				field = json_parse_boolean(toks, object, &fkey,
				    cause);
			} else if ((*valstr == '-' && isdigit(valstr[1])) ||
			    isdigit(*valstr)) {
				field = json_parse_number(toks, object, &fkey,
				    cause);
			} else {
				json_error(cause, "invalid value", val->ptr);
				goto fail;
			}
			break;
		case TOK_OPENOBJECT:
			field = json_parse_object(toks, object, &fkey, cause);
			break;
		case TOK_OPENARRAY:
			field = json_parse_array(toks, object, &fkey, cause);
			break;
		default:
			json_error(cause, "unsupported object token",
			    (*toks)->val.ptr);
			goto fail;
		}
		if (field == NULL)
			goto fail;

		json_assign_value(object, field);
		if ((*toks)->type == TOK_COMMA) {
			if ((*toks)[1].type == TOK_CLOSEOBJECT) {
				json_error(cause, "invalid object",
				    (*toks)->val.ptr);
				goto fail;
			}
			(*toks)++;
		} else if ((*toks)->type != TOK_CLOSEOBJECT) {
			json_error(cause, "invalid object", (*toks)->val.ptr);
			goto fail;
		}
	}
	(*toks)++;
	return (object);
fail:
	json_destroy_node(object);
	return (NULL);
}

/* Parse an array value, return the node, and advance the token pointer. */
static struct json_node *
json_parse_array(struct json_token **toks, struct json_node *parent,
    struct json_string *key, char **cause)
{
	struct json_node	*array;
	struct json_node	*member;

	if ((*toks)->type != TOK_OPENARRAY)
		return (NULL);
	(*toks)++;

	array = json_create_node(parent, NODE_ARRAY, key, NULL);
	while ((*toks)->type != TOK_CLOSEARRAY) {
		switch ((*toks)->type) {
		case TOK_OPENOBJECT:
			member = json_parse_object(toks, array, NULL, cause);
			break;
		default:
			json_error(cause, "invalid array member",
			    (*toks)->val.ptr);
			goto fail;
		}
		if (member == NULL)
			goto fail;

		json_assign_value(array, member);

		if ((*toks)->type == TOK_COMMA) {
			if ((*toks)[1].type == TOK_CLOSEARRAY) {
				json_error(cause, "invalid array",
				    (*toks)->val.ptr);
				goto fail;
			}
			(*toks)++;
		} else if ((*toks)->type != TOK_CLOSEARRAY) {
			json_error(cause, "invalid array", (*toks)->val.ptr);
			goto fail;
		}
	}
	(*toks)++;
	return (array);
fail:
	json_destroy_node(array);
	return (NULL);
}

/* Parse a string value, return the node, and advance the token pointer. */
static struct json_node *
json_parse_string(struct json_token **toks, struct json_node *parent,
    struct json_string *key, char **cause)
{
	struct json_string	*val;
	const char		*start = (*toks)->val.ptr;

	if ((*toks)->type != TOK_QUOTE)
		goto fail;
	(*toks)++;
	if ((*toks)->type != TOK_VALUE)
		goto fail;

	val = &(*toks)->val;
	(*toks)++;

	if ((*toks)->type != TOK_QUOTE)
		goto fail;
	(*toks)++;

	return (json_create_node(parent, NODE_STRING, key, val));
fail:
	json_error(cause, "invalid string", start);
	return (NULL);
}

/* Parse a number value, return the node, and advance the token pointer. */
static struct json_node *
json_parse_number(struct json_token **toks, struct json_node *parent,
    struct json_string *key, char **cause)
{
	const char	*numstr = (*toks)->val.ptr;
	char		*endptr;
	int64_t		 val;

	errno = 0;
	val = strtoll(numstr, &endptr, 10);
	if (errno != 0 || endptr != numstr + (*toks)->val.len)
		goto fail;
	(*toks)++;

	return (json_create_node(parent, NODE_NUMBER, key, &val));
fail:
	json_error(cause, "invalid number", numstr);
	return (NULL);
}

/* Parse a boolean value, return the node, and advance the token pointer. */
static struct json_node *
json_parse_boolean(struct json_token **toks, struct json_node *parent,
    struct json_string *key, char **cause)
{
	const char	*start = (*toks)->val.ptr;
	int		 val;

	if (jstrcmp(&(*toks)->val, "true") == 0)
		val = 1;
	else if (jstrcmp(&(*toks)->val, "false") == 0)
		val = 0;
	else
		goto fail;

	(*toks)++;

	return (json_create_node(parent, NODE_BOOLEAN, key, &val));
fail:
	json_error(cause, "invalid boolean", start);
	return (NULL);
}

/* Return 1 when the node's key is equal to the parameter. */
int
json_key_is_eq(const struct json_node *field, const char *key)
{
	return (jstrcmp(&field->key, key) == 0);
}

/* Return 1 when the node's value is equal to the parameter. */
int
json_val_is_eq(const struct json_node *field, const void *val)
{
	switch (field->type) {
	case NODE_STRING:
		return (jstrcmp(&field->val.jstr, val) == 0);
	case NODE_NUMBER:
		return (field->val.num == *(int64_t *)val);
	case NODE_BOOLEAN:
		return (field->val.boolean == *(int *)val);
	case NODE_OBJECT:
	case NODE_ARRAY:
		fatalx("cannot compare object or array");
	}
	return (0);
}