sentry_json.h

#ifndef SENTRY_JSON_H_INCLUDED
#define SENTRY_JSON_H_INCLUDED

#include "sentry_boot.h"
#include "sentry_path.h"
#include "sentry_string.h"
#include "sentry_writer.h"

typedef struct sentry_jsonwriter_s sentry_jsonwriter_t;

/**
 * This creates a JSON writer on top of an existing generic byte writer. The
 * JSON writer does not own `writer` and will not close or free it.
 */
sentry_jsonwriter_t *sentry__jsonwriter_new_writer(sentry_writer_t *writer);

/**
 * This creates a new JSON writer.
 *
 * It will use an existing `sentry_stringbuilder_t` as its output if one is
 * provided, otherwise it will allocate a new one.
 */
sentry_jsonwriter_t *sentry__jsonwriter_new_sb(sentry_stringbuilder_t *sb);

/**
 * This creates a new JSON writer.
 *
 * It requires an existing `sentry_filewriter_t` as its output.
 */
sentry_jsonwriter_t *sentry__jsonwriter_new_fw(sentry_filewriter_t *fw);

/**
 * Deallocates a JSON writer.
 */
void sentry__jsonwriter_free(sentry_jsonwriter_t *jw);

/**
 * Resets the JSON grammar state of a JSON writer.
 *
 * This intentionally does not clear the sticky failure state of either the
 * JSON writer or its underlying byte writer.
 */
void sentry__jsonwriter_reset(sentry_jsonwriter_t *jw);

/**
 * Returns true if any write operation on this JSON writer has failed.
 */
bool sentry__jsonwriter_has_failed(const sentry_jsonwriter_t *jw);

/**
 * This will consume and deallocate the JSON writer, returning the generated
 * JSON string, and writing its length into `len_out`.
 */
char *sentry__jsonwriter_into_string(sentry_jsonwriter_t *jw, size_t *len_out);

/**
 * Write a `null` into the JSON.
 */
void sentry__jsonwriter_write_null(sentry_jsonwriter_t *jw);

/**
 * Write a JSON boolean.
 */
void sentry__jsonwriter_write_bool(sentry_jsonwriter_t *jw, bool val);

/**
 * Write a 32-bit number, which will be encoded in a JSON number.
 */
void sentry__jsonwriter_write_int32(sentry_jsonwriter_t *jw, int32_t val);

/**
 * Write a 64-bit signed integer, encoded as JSON number.
 */
void sentry__jsonwriter_write_int64(sentry_jsonwriter_t *jw, int64_t val);

/**
 * Write a 64-bit unsigned integer, encoded as JSON number.
 */
void sentry__jsonwriter_write_uint64(sentry_jsonwriter_t *jw, uint64_t val);

/**
 * Write a 64-bit float, encoded as JSON number.
 */
void sentry__jsonwriter_write_double(sentry_jsonwriter_t *jw, double val);

/**
 * Write a zero-terminated string.
 */
void sentry__jsonwriter_write_str(sentry_jsonwriter_t *jw, const char *val);

/**
 * Write a UUID as a JSON string.
 * See `sentry_uuid_as_string`.
 */
void sentry__jsonwriter_write_uuid(
    sentry_jsonwriter_t *jw, const sentry_uuid_t *uuid);

/**
 * This will write a microsecond resolution timestamp formattad as an ISO8601
 * string.
 * See `sentry__usec_time_to_iso8601`.
 */
void sentry__jsonwriter_write_usec_timestamp(
    sentry_jsonwriter_t *jw, uint64_t time);

/**
 * Writes the *Key* part of an object Key-Value pair.
 */
void sentry__jsonwriter_write_key(sentry_jsonwriter_t *jw, const char *val);

/**
 * Start a new JSON array.
 * Needs to be closed with `sentry__jsonwriter_write_list_end`.
 */
void sentry__jsonwriter_write_list_start(sentry_jsonwriter_t *jw);

/**
 * End the previously started JSON array.
 */
void sentry__jsonwriter_write_list_end(sentry_jsonwriter_t *jw);

/**
 * Start a new JSON object.
 * Needs to be closed with `sentry__jsonwriter_write_object_end`.
 */
void sentry__jsonwriter_write_object_start(sentry_jsonwriter_t *jw);

/**
 * End the previously started JSON object.
 */
void sentry__jsonwriter_write_object_end(sentry_jsonwriter_t *jw);

/**
 * Parse the given JSON string into a new Value.
 *
 * Exported via `SENTRY_API` so the Android JNI bridge can link against.
 */
SENTRY_API sentry_value_t sentry__value_from_json(
    const char *buf, size_t buflen);

#endif