add blitz files

include/blitz/common/NonCopyable.h

@@ -0,0 +1,25 @@
+#pragma once
+
+/**
+ * \file NonCopyable.h
+ * \brief File containing the blitz::NonCopyable class
+ */
+
+namespace blitz {
+
+/**
+ * \class NonCopyable
+ * \brief Class used to make a class non copyable
+ * \note Inherit from this class privately to make a class non copyable
+ */
+class NonCopyable {
+  public:
+	NonCopyable(const NonCopyable&) = delete;
+	NonCopyable& operator=(const NonCopyable&) = delete;
+
+  protected:
+	NonCopyable() {}
+	~NonCopyable() {}
+};
+
+}  // namespace blitz

include/blitz/common/Types.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <cstdint>
+
+namespace blitz {
+
+using EntityID = std::uint64_t;
+using PeerID = std::int32_t;
+using PlayerID = PeerID;
+
+}  // namespace blitz

include/blitz/protocol/ByteBuffer.h

@@ -0,0 +1,89 @@
+#pragma once
+
+#include <godot_cpp/variant/packed_byte_array.hpp>
+#include <godot_cpp/variant/string.hpp>
+#include <vector>
+
+namespace blitz {
+namespace protocol {
+
+class PlayerInfo;
+
+#define Operators(Type, GodotType)                                                                                                    \
+	ByteBuffer& operator>>(Type& a_Data) {                                                                                            \
+		a_Data = m_Buffer.decode_##GodotType(m_ReadOffset);                                                                           \
+		m_ReadOffset += sizeof(a_Data);                                                                                               \
+		return *this;                                                                                                                 \
+	}                                                                                                                                 \
+                                                                                                                                      \
+	ByteBuffer& operator<<(Type a_Data) {                                                                                             \
+		m_Buffer.resize(m_Buffer.size() + sizeof(a_Data));                                                                            \
+		m_Buffer.encode_##GodotType(m_Buffer.size() - sizeof(a_Data), a_Data);                                                        \
+		return *this;                                                                                                                 \
+	}
+
+class ByteBuffer {
+  private:
+	godot::PackedByteArray m_Buffer;
+	std::size_t m_ReadOffset;
+
+  public:
+	ByteBuffer(godot::PackedByteArray&& a_Buffer) : m_Buffer(std::move(a_Buffer)), m_ReadOffset(0) {}
+	ByteBuffer() : m_ReadOffset(0) {
+		m_Buffer.resize(0);
+	}
+
+	const godot::PackedByteArray& GetByteArray() const {
+		return m_Buffer;
+	}
+
+	godot::PackedByteArray& GetByteArray() {
+		return m_Buffer;
+	}
+
+	// Integers
+	Operators(int8_t, s8);
+	Operators(uint8_t, u8);
+	Operators(int16_t, s16);
+	Operators(uint16_t, u16);
+	Operators(int32_t, s32);
+	Operators(uint32_t, u32);
+	Operators(int64_t, s64);
+	Operators(uint64_t, u64);
+
+	// Reals
+	Operators(float, float);
+	Operators(double, double);
+
+	ByteBuffer& operator<<(const godot::String& a_Data);
+	ByteBuffer& operator>>(godot::String& a_Data);
+
+	ByteBuffer& operator<<(const godot::Vector3& a_Data);
+	ByteBuffer& operator>>(godot::Vector3& a_Data);
+
+	template <typename T>
+	ByteBuffer& operator<<(const std::vector<T>& a_Data) {
+		*this << static_cast<std::uint32_t>(a_Data.size());
+		for (const T& data : a_Data) {
+			*this << data;
+		}
+		return *this;
+	}
+
+	template <typename T>
+	ByteBuffer& operator>>(std::vector<T>& a_Data) {
+		std::uint32_t arraySize;
+		*this >> arraySize;
+		a_Data.resize(arraySize);
+		for (std::uint32_t i = 0; i < arraySize; i++) {
+			*this >> a_Data[i];
+		}
+		return *this;
+	}
+
+	ByteBuffer& operator<<(const PlayerInfo& a_Data);
+	ByteBuffer& operator>>(PlayerInfo& a_Data);
+};
+
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketData.h

@@ -0,0 +1,72 @@
+#pragma once
+
+#include <blitz/common/Types.h>
+#include <vector>
+#include <godot_cpp/variant/string.hpp>
+#include <godot_cpp/variant/vector3.hpp>
+
+namespace blitz {
+namespace protocol {
+
+struct PlayerInfo {
+	PlayerID m_PlayerId;
+	godot::String m_PlayerName;
+};
+
+namespace data {
+
+struct PlayerLogin {
+	godot::String m_PlayerName;
+};
+
+struct UpdateHealth {
+	float m_NewHealth;
+};
+
+struct LoggingSuccess {
+	PlayerID m_PlayerId;
+};
+
+struct PlayerDeath {};
+
+struct PlayerJoin {
+	PlayerInfo m_Player;
+};
+
+struct PlayerLeave {
+	PlayerID m_PlayerId;
+};
+
+struct PlayerStats {};
+
+struct PlayerList {
+	std::vector<PlayerInfo> m_Players;
+};
+
+struct ServerConfig {};
+
+struct ServerTps {};
+
+struct UpdateGameState {};
+
+struct KeepAlive {
+	std::uint64_t m_KeepAliveId;
+};
+
+struct Disconnect {};
+
+struct ChatMessage {
+	godot::String m_Text;
+};
+
+struct PlayerPositionAndRotation {
+	PlayerID m_Player;
+	godot::Vector3 m_Position;
+	godot::Vector3 m_Rotation;
+};
+
+struct PlayerShoot {};
+
+}  // namespace data
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketDeclare.h

@@ -0,0 +1,49 @@
+#pragma once
+
+/**
+ * \file PacketDeclare.h
+ * \brief Holds the definitions of the packets (but not their content)
+ */
+
+namespace blitz {
+namespace protocol {
+
+/**
+ * \enum PacketSender
+ * \brief Indicate who should send a packet
+ */
+enum class PacketSender {
+	/** Sent by clients and server */
+	Both,
+	/** Sent by clients to the server */
+	Client,
+	/** Sent by server to the clients */
+	Server,
+};
+
+
+/**
+ * \def DeclareAllPacket
+ * \brief Avoids repetitive operations on packets
+ */
+#define DeclareAllPacket() \
+	DeclarePacket(ChatMessage, Reliable, Both) \
+	DeclarePacket(Disconnect, Reliable, Both) \
+	DeclarePacket(KeepAlive, Reliable, Both)  \
+	DeclarePacket(LoggingSuccess, Reliable, Server) \
+	DeclarePacket(PlayerDeath, Reliable, Server) \
+	DeclarePacket(PlayerJoin, Reliable, Server) \
+	DeclarePacket(PlayerLeave, Reliable, Server) \
+	DeclarePacket(PlayerList, Reliable, Server) \
+	DeclarePacket(PlayerLogin, Reliable, Client) \
+	DeclarePacket(PlayerPositionAndRotation, Reliable, Both) \
+	DeclarePacket(PlayerShoot, Reliable, Both) \
+	DeclarePacket(PlayerStats, Reliable, Server) \
+	DeclarePacket(ServerConfig, Reliable, Server) \
+	DeclarePacket(ServerTps, Reliable, Server) \
+	DeclarePacket(UpdateGameState, Reliable, Server) \
+	DeclarePacket(UpdateHealth, Reliable, Client)
+
+
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketDispatcher.h

@@ -0,0 +1,58 @@
+#pragma once
+
+/**
+ * \file PacketDispatcher.h
+ * \brief File containing the blitz::protocol::PacketDispatcher class
+ */
+
+#include <blitz/common/NonCopyable.h>
+#include <blitz/protocol/Packets.h>
+
+#include <map>
+
+namespace blitz {
+namespace protocol {
+
+class PacketHandler;
+
+/**
+ * \class PacketDispatcher
+ * \brief Class used to dispatch packets
+ */
+class PacketDispatcher : private NonCopyable {
+  private:
+	std::map<PacketType, std::vector<PacketHandler*>> m_Handlers;
+
+  public:
+	/**
+	 * \brief Constructor
+	 */
+	PacketDispatcher() {}
+
+	/**
+	 * \brief Dispatch a packet
+	 * \param packet The packet to dispatch
+	 */
+	void Dispatch(const Packet& packet);
+
+	/**
+	 * \brief Register a packet handler
+	 * \param type The packet type
+	 * \param handler The packet handler
+	 */
+	void RegisterHandler(PacketType type, PacketHandler& handler);
+	/**
+	 * \brief Unregister a packet handler
+	 * \param type The packet type
+	 * \param handler The packet handler
+	 */
+	void UnregisterHandler(PacketType type, PacketHandler& handler);
+	/**
+	 * \brief Unregister a packet handler
+	 * \param handler The packet handler
+	 */
+	void UnregisterHandler(PacketHandler& handler);
+};
+
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketFactory.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <blitz/protocol/Packets.h>
+#include <memory>
+
+namespace blitz {
+namespace protocol {
+namespace PacketFactory {
+
+template<typename PacketDerived, typename = typename std::enable_if<std::is_base_of<Packet, PacketDerived>::value>::type>
+std::unique_ptr<PacketDerived> CreatePacket() {
+    return std::make_unique<PacketDerived>();
+}
+
+const std::unique_ptr<Packet>& CreateReadOnlyPacket(PacketType a_Type);
+
+void Init();
+
+}  // namespace PacketFactory
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketHandler.h

@@ -0,0 +1,34 @@
+#pragma once
+
+/**
+ * \file PacketHandler.h
+ * \brief File containing the blitz::protocol::PacketHandler class
+ */
+
+#include <blitz/protocol/Packets.h>
+#include <blitz/protocol/PacketVisitor.h>
+
+namespace blitz {
+namespace protocol {
+
+class PacketDispatcher;
+
+#define DeclarePacket(PacketName, ...) virtual void Visit(const packets::PacketName&); virtual void HandlePacket(const packets::PacketName&) {}
+
+/**
+ * \class PacketHandler
+ * \brief Class used to handle packets
+ */
+class PacketHandler : public PacketVisitor {
+  public:
+	PacketHandler() {}
+	~PacketHandler() {}
+
+	DeclareAllPacket()
+
+};
+
+#undef DeclarePacket
+
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketSerializer.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <blitz/protocol/Packets.h>
+#include <godot_cpp/variant/packed_byte_array.hpp>
+#include <memory>
+
+namespace blitz {
+namespace protocol {
+
+using PacketPtr = std::unique_ptr<Packet>;
+
+namespace PacketSerializer {
+
+godot::PackedByteArray Serialize(const Packet& a_Packet);
+
+std::unique_ptr<Packet> Deserialize(godot::PackedByteArray& a_Data);
+
+}
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/PacketVisitor.h

@@ -0,0 +1,39 @@
+#pragma once
+
+/**
+ * \file PacketVisitor.h
+ * \brief File containing the blitz::protocol::PacketVisitor class
+ */
+
+#include <blitz/protocol/Packets.h>
+
+namespace blitz {
+namespace protocol {
+
+#define DeclarePacket(PacketName, ...)                                                                                                \
+	/** This function is called when the packet processed by PacketVisitor::Check is a PacketName */                                                                                                                            \
+	virtual void Visit(const packets::PacketName&) {}
+
+/**
+ * \class PacketVisitor
+ * \brief This class uses double-dispatch in order to find the real type of a packet
+ */
+class PacketVisitor : private NonCopyable {
+  protected:
+	PacketVisitor() {}
+	virtual ~PacketVisitor() {}
+
+  public:
+	/**
+	 * \brief Calls the right PacketVisitor::Visit method corresponding to the real type of the packet
+	 * \param packet the Packet to visit
+	 */
+	void Check(const Packet& packet);
+
+	DeclareAllPacket()
+};
+
+#undef DeclarePacket
+
+}  // namespace protocol
+}  // namespace blitz

include/blitz/protocol/Packets.h

@@ -0,0 +1,112 @@
+#pragma once
+
+/**
+ * \file Packets.h
+ * \brief File containing the definitions of the packets
+ */
+
+#include <blitz/common/NonCopyable.h>
+#include <blitz/protocol/PacketData.h>
+#include <blitz/protocol/PacketDeclare.h>
+
+namespace blitz {
+namespace protocol {
+
+class PacketVisitor;
+
+/** A Packet id is 8 bits wide */
+using PacketID = std::uint8_t;
+
+#define DeclarePacket(PacketName, ...) /** PacketName */ PacketName,
+
+/**
+ * \enum PacketType
+ * \brief Map a Packet to an id
+ */
+enum class PacketType : PacketID {
+
+	DeclareAllPacket()
+
+	/** The number of packets */
+	PACKET_COUNT
+};
+
+
+#undef DeclarePacket
+
+
+class Packet : private NonCopyable {
+  public:
+	/**
+	 * \return The real type of the packet
+	 */
+	virtual PacketType GetType() const = 0;
+
+	/**
+	 * \brief The network peer who sent the packet
+	 */
+	PeerID m_Sender;
+
+  private:
+	/** Use a PacketVisitor to make double-dispatch possible */
+	virtual void Accept(PacketVisitor& a_Visitor) const = 0;
+
+	friend class PacketVisitor;
+};
+
+
+
+
+
+namespace packets {
+
+/**
+ * \class ConcretePacket
+ * \brief A Packet associated with an id and holding data
+ * \tparam PT The packet type
+ * \tparam Data The structure holding the data of the packet (in blitz::protocol::data namespace)
+ */
+template <PacketType PT, typename Data>
+class ConcretePacket : public Packet {
+  public:
+	/** The type of the struct holding the data */
+	using PacketDataType = Data;
+
+	/** The structure holding the actual data */
+	PacketDataType m_Data;
+
+	/** Construct the packet with data of type PacketDataType */
+	ConcretePacket(const PacketDataType& a_Data = {});
+
+	constexpr PacketType GetType() const override {
+		return PT;
+	};
+
+  private:
+	void Accept(PacketVisitor& a_Visitor) const override;
+};
+
+
+
+
+
+// define BLITZ_INSTANCIATE_PACKETS
+// before including this file
+// if you want to instantiate templates
+#ifdef BLITZ_INSTANCIATE_PACKETS
+#define DeclarePacket(PacketName, ...)                                                                                                \
+	using PacketName = ConcretePacket<PacketType::PacketName, data::PacketName>;                                                      \
+	template class ConcretePacket<PacketType::PacketName, data::PacketName>;
+#else
+#define DeclarePacket(PacketName, ...) /** Defines the PacketName packet */                                                           \
+	using PacketName = ConcretePacket<PacketType::PacketName, data::PacketName>;
+#endif
+
+DeclareAllPacket()
+
+#undef DeclarePacket
+
+}  // namespace packets
+
+}  // namespace protocol
+}  // namespace blitz