/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2023, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */
#pragma once

#include <mrpt/serialization/CSerializable.h>

#include <cstdint>
#include <vector>

namespace mrpt::serialization
{
/** A class that contain generic messages, that can be sent and received from a
 * "CClientTCPSocket" object.
 *  A message consists of a "header" (or type), and a "body" (or content).
 *  Apart from arbitrary data, specific methods are provided for easing the
 * serialization of MRPT's "CSerializable" objects.
 *  This class is also used for passing data to hardware interfaces (see
 * mrpt::comms::CSerialPort)
 * \sa CClientTCPSocket
 * \ingroup mrpt_serialization_grp
 */
class CMessage
{
   public:
	/** An identifier of the message type (only the least-sig byte is typically
	 * sent) */
	uint32_t type;
	/** The contents of the message (memory is automatically handled by the
	 * std::vector object) */
	std::vector<uint8_t> content;

	/** A method for serializing a MRPT's object into the content.
	 *  Any modification to data in "content" after this will corrupt the
	 * object serialization.
	 *  Member "type" is unmodified in this method.
	 */
	void serializeObject(const CSerializable* obj);

	/** A method that parse the data in the message into an existing object.
	 *  Note that the class of the object must be known and must match the one
	 * of the serialized object.
	 * \except std::exception On corrupt data, unknown serialized objects,
	 * unknown serialized object version, non-matching classes,...
	 */
	void deserializeIntoExistingObject(CSerializable* obj);

	/** A method that parse the data in the message into a new object of (a
	 * priori) unknown class.
	 *  The pointer will contain on return a copy of the reconstructed object.
	 * Deleting this object when
	 *   no longer required is the responsability of the user. Note that
	 * previous contents of the pointer
	 *   will be ignored (it should be nullptr).
	 * \except std::exception On corrupt data, unknown serialized objects,
	 * unknown serialized object version,...
	 */
	void deserializeIntoNewObject(CSerializable::Ptr& obj);

	/** Sets the contents of the message from a string
	 * \sa getContentAsString
	 */
	void setContentFromString(const std::string& str);

	/** Gets the contents of the message as a string
	 * \sa setContentFromString
	 */
	void getContentAsString(std::string& str);

	/** Sets the contents of the message from an arbitary structure - This is
	 * intended for inter-thread comms only, the message will be not
	 * cross-platform.
	 * \sa getContentAsStruct
	 */
	template <class T>
	void setContentFromStruct(const T& data)
	{
		content.resize(sizeof(data));
		T* ptr = reinterpret_cast<T*>(&content[0]);
		*ptr = data;
	}

	/** Gets the contents of the message as an arbitary structure - This is
	 * intended for inter-thread comms only, the message will be not
	 * cross-platform.
	 * \sa setContentFromStruct
	 */
	template <class T>
	void getContentAsStruct(T& data) const
	{
		MRPT_START
		ASSERT_(content.size() == sizeof(data));
		data = *reinterpret_cast<T*>(&content[0]);
		MRPT_END
	}

};	// End of class

}  // namespace mrpt::serialization
