Translated using Weblate (Chinese (Simplified))

[minetest.git] / src / network / networkpacket.h

diff --git a/src/network/networkpacket.h b/src/network/networkpacket.h
index c9f7e3cdedf5d74e5048f98cecc2e8e63a463f2e..e77bfb7447b5e6b5eab698f29e2f25d5ae1de6df 100644 (file)
--- a/src/network/networkpacket.h
+++ b/src/network/networkpacket.h
@@ -1,6 +1,5 @@
 /*
 Minetest
-Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 Copyright (C) 2015 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
 
 This program is free software; you can redistribute it and/or modify
@@ -18,69 +17,120 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef NETWORKPACKET_HEADER
-#define NETWORKPACKET_HEADER
+#pragma once
 
+#include "util/pointer.h"
 #include "util/numeric.h"
 #include "networkprotocol.h"
+#include <SColor.h>
 
 class NetworkPacket
 {
 
 public:
-               NetworkPacket(u8 *data, u32 datasize, u16 peer_id);
-               ~NetworkPacket();
+       NetworkPacket(u16 command, u32 datasize, session_t peer_id);
+       NetworkPacket(u16 command, u32 datasize);
+       NetworkPacket() = default;
 
-               // Getters
-               u32 getSize() { return m_datasize; }
-               u16 getPeerId() { return m_peer_id; }
+       ~NetworkPacket();
 
-               // Data extractors
-               char* getString(u32 from_offset);
-               NetworkPacket& operator>>(std::string& dst);
-               NetworkPacket& operator>>(std::wstring& dst);
-               std::string readLongString();
+       void putRawPacket(u8 *data, u32 datasize, session_t peer_id);
+       void clear();
 
-               char getChar(u32 offset);
-               NetworkPacket& operator>>(char& dst);
+       // Getters
+       u32 getSize() const { return m_datasize; }
+       session_t getPeerId() const { return m_peer_id; }
+       u16 getCommand() { return m_command; }
+       const u32 getRemainingBytes() const { return m_datasize - m_read_offset; }
+       const char *getRemainingString() { return getString(m_read_offset); }
 
-               NetworkPacket& operator>>(bool& dst);
+       // Returns a c-string without copying.
+       // A better name for this would be getRawString()
+       const char *getString(u32 from_offset);
+       // major difference to putCString(): doesn't write len into the buffer
+       void putRawString(const char *src, u32 len);
+       void putRawString(const std::string &src)
+       {
+               putRawString(src.c_str(), src.size());
+       }
 
-               u8 getU8(u32 offset);
-               NetworkPacket& operator>>(u8& dst);
+       NetworkPacket &operator>>(std::string &dst);
+       NetworkPacket &operator<<(const std::string &src);
 
-               u8* getU8Ptr(u32 offset);
-               u16 getU16(u32 from_offset);
-               NetworkPacket& operator>>(u16& dst);
-               u32 getU32(u32 from_offset);
-               NetworkPacket& operator>>(u32& dst);
-               u64 getU64(u32 from_offset);
-               NetworkPacket& operator>>(u64& dst);
+       void putLongString(const std::string &src);
 
-               float getF1000(u32 offset);
-               NetworkPacket& operator>>(float& dst);
-               NetworkPacket& operator>>(v2f& dst);
-               NetworkPacket& operator>>(v3f& dst);
+       NetworkPacket &operator>>(std::wstring &dst);
+       NetworkPacket &operator<<(const std::wstring &src);
 
-               s16 getS16(u32 from_offset);
-               NetworkPacket& operator>>(s16& dst);
-               s32 getS32(u32 from_offset);
-               NetworkPacket& operator>>(s32& dst);
+       std::string readLongString();
 
-               NetworkPacket& operator>>(v2s32& dst);
+       NetworkPacket &operator>>(char &dst);
+       NetworkPacket &operator<<(char src);
 
-               v3s16 getV3S16(u32 from_offset);
-               NetworkPacket& operator>>(v3s16& dst);
+       NetworkPacket &operator>>(bool &dst);
+       NetworkPacket &operator<<(bool src);
 
-               v3s32 getV3S32(u32 from_offset);
-               NetworkPacket& operator>>(v3s32& dst);
+       u8 getU8(u32 offset);
+
+       NetworkPacket &operator>>(u8 &dst);
+       NetworkPacket &operator<<(u8 src);
+
+       u8 *getU8Ptr(u32 offset);
+
+       u16 getU16(u32 from_offset);
+       NetworkPacket &operator>>(u16 &dst);
+       NetworkPacket &operator<<(u16 src);
+
+       NetworkPacket &operator>>(u32 &dst);
+       NetworkPacket &operator<<(u32 src);
+
+       NetworkPacket &operator>>(u64 &dst);
+       NetworkPacket &operator<<(u64 src);
+
+       NetworkPacket &operator>>(float &dst);
+       NetworkPacket &operator<<(float src);
+
+       NetworkPacket &operator>>(v2f &dst);
+       NetworkPacket &operator<<(v2f src);
+
+       NetworkPacket &operator>>(v3f &dst);
+       NetworkPacket &operator<<(v3f src);
+
+       NetworkPacket &operator>>(s16 &dst);
+       NetworkPacket &operator<<(s16 src);
+
+       NetworkPacket &operator>>(s32 &dst);
+       NetworkPacket &operator<<(s32 src);
+
+       NetworkPacket &operator>>(v2s32 &dst);
+       NetworkPacket &operator<<(v2s32 src);
+
+       NetworkPacket &operator>>(v3s16 &dst);
+       NetworkPacket &operator<<(v3s16 src);
+
+       NetworkPacket &operator>>(v3s32 &dst);
+       NetworkPacket &operator<<(v3s32 src);
+
+       NetworkPacket &operator>>(video::SColor &dst);
+       NetworkPacket &operator<<(video::SColor src);
+
+       // Temp, we remove SharedBuffer when migration finished
+       SharedBuffer<u8> oldForgePacket();
 
-protected:
-               u8 *m_data;
-               u32 m_datasize;
-               u32 m_read_offset;
 private:
-               u16 m_peer_id;
+       void checkReadOffset(u32 from_offset, u32 field_size);
+
+       inline void checkDataSize(u32 field_size)
+       {
+               if (m_read_offset + field_size > m_datasize) {
+                       m_datasize = m_read_offset + field_size;
+                       m_data.resize(m_datasize);
+               }
+       }
+
+       std::vector<u8> m_data;
+       u32 m_datasize = 0;
+       u32 m_read_offset = 0;
+       u16 m_command = 0;
+       session_t m_peer_id = 0;
 };
-
-#endif