#pragma once
/*
 * Copyright 2010-2020, Tarantool AUTHORS, please see AUTHORS file.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#if defined(__cplusplus)
extern "C" {
#endif /* defined(__cplusplus) */

#include <stdint.h>
#include <stdio.h>
#include <assert.h>

struct mpstream;
struct error;

/**
 * @brief Encode error to mpstream as MP_ERROR.
 * @param error pointer to struct error for encoding.
 * @param stream pointer to output stream.
 */
void
error_to_mpstream(const struct error *error, struct mpstream *stream);

void
error_to_mpstream_noext(const struct error *error, struct mpstream *stream);

struct error *
error_unpack_unsafe(const char **data);

/**
 * @brief Unpack MP_ERROR to error.
 * @param data pointer to MP_ERROR.
 * @param len data size.
 * @return struct error * or NULL if failed.
 */
static inline struct error *
error_unpack(const char **data, uint32_t len)
{
	const char *end = *data + len;
	struct error *e = error_unpack_unsafe(data);
	(void)end;
	assert(*data == end);
	return e;
}

/**
 * @brief Calculate the exact buffer size needed to encode an error in MsgPack.
 * @param error The error.
 * @return the size.
 */
uint32_t
mp_sizeof_error(const struct error *error);

/**
 * @brief Encode an error in MsgPack.
 * @param data Pointer to the buffer to write the result to.
 * @param error The error.
 * @return @a data + mp_sizeof_error(@a error).
 */
char *
mp_encode_error(char *data, const struct error *error);

/**
 * Print error's string representation into a given buffer.
 * @param buf Target buffer to write string to.
 * @param size Buffer size.
 * @param data MessagePack encoded error, without MP_EXT header.
 * @param len Length of @a data. If not all data is used, it is
 *        an error.
 * @retval <0 Error. Couldn't decode error.
 * @retval >=0 How many bytes were written, or would have been
 *        written, if there was enough buffer space.
 */
int
mp_snprint_error(char *buf, int size, const char **data, int depth);

/**
 * Print error's string representation into a stream.
 * @param file Target stream to write string to.
 * @param data MessagePack encoded error, without MP_EXT header.
 * @param len Length of @a data. If not all data is used, it is
 *        an error.
 * @retval <0 Error. Couldn't decode error, or couldn't write to
 *        the stream.
 * @retval >=0 How many bytes were written.
 */
int
mp_fprint_error(FILE *file, const char **data, int depth);

#if defined(__cplusplus)
} /* extern "C" */
#endif /* defined(__cplusplus) */
