Node metadata framework
[oweals/minetest.git] / src / client.h
index 3c8bbfaf6206e5872d6a6dc8f10c9cc0bd77494c..3915282865e0365609550a42a7530f42445d74f3 100644 (file)
@@ -27,6 +27,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "common_irrlicht.h"
 #include "jmutex.h"
 #include <ostream>
+#include "clientobject.h"
 
 class ClientNotReadyException : public BaseException
 {
@@ -36,23 +37,144 @@ public:
        {}
 };
 
-class Client;
+struct QueuedMeshUpdate
+{
+       v3s16 p;
+       MeshMakeData *data;
+       bool ack_block_to_server;
+
+       QueuedMeshUpdate():
+               p(-1337,-1337,-1337),
+               data(NULL),
+               ack_block_to_server(false)
+       {
+       }
+       
+       ~QueuedMeshUpdate()
+       {
+               if(data)
+                       delete data;
+       }
+};
+
+/*
+       A thread-safe queue of mesh update tasks
+*/
+class MeshUpdateQueue
+{
+public:
+       MeshUpdateQueue()
+       {
+               m_mutex.Init();
+       }
+
+       ~MeshUpdateQueue()
+       {
+               JMutexAutoLock lock(m_mutex);
+
+               core::list<QueuedMeshUpdate*>::Iterator i;
+               for(i=m_queue.begin(); i!=m_queue.end(); i++)
+               {
+                       QueuedMeshUpdate *q = *i;
+                       delete q;
+               }
+       }
+       
+       /*
+               peer_id=0 adds with nobody to send to
+       */
+       void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server)
+       {
+               DSTACK(__FUNCTION_NAME);
+
+               assert(data);
+       
+               JMutexAutoLock lock(m_mutex);
 
-class ClientUpdateThread : public SimpleThread
+               /*
+                       Find if block is already in queue.
+                       If it is, update the data and quit.
+               */
+               core::list<QueuedMeshUpdate*>::Iterator i;
+               for(i=m_queue.begin(); i!=m_queue.end(); i++)
+               {
+                       QueuedMeshUpdate *q = *i;
+                       if(q->p == p)
+                       {
+                               if(q->data)
+                                       delete q->data;
+                               q->data = data;
+                               if(ack_block_to_server)
+                                       q->ack_block_to_server = true;
+                               return;
+                       }
+               }
+               
+               /*
+                       Add the block
+               */
+               QueuedMeshUpdate *q = new QueuedMeshUpdate;
+               q->p = p;
+               q->data = data;
+               q->ack_block_to_server = ack_block_to_server;
+               m_queue.push_back(q);
+       }
+
+       // Returned pointer must be deleted
+       // Returns NULL if queue is empty
+       QueuedMeshUpdate * pop()
+       {
+               JMutexAutoLock lock(m_mutex);
+
+               core::list<QueuedMeshUpdate*>::Iterator i = m_queue.begin();
+               if(i == m_queue.end())
+                       return NULL;
+               QueuedMeshUpdate *q = *i;
+               m_queue.erase(i);
+               return q;
+       }
+
+       u32 size()
+       {
+               JMutexAutoLock lock(m_mutex);
+               return m_queue.size();
+       }
+       
+private:
+       core::list<QueuedMeshUpdate*> m_queue;
+       JMutex m_mutex;
+};
+
+struct MeshUpdateResult
 {
-       Client *m_client;
+       v3s16 p;
+       scene::SMesh *mesh;
+       bool ack_block_to_server;
+
+       MeshUpdateResult():
+               p(-1338,-1338,-1338),
+               mesh(NULL),
+               ack_block_to_server(false)
+       {
+       }
+};
 
+class MeshUpdateThread : public SimpleThread
+{
 public:
 
-       ClientUpdateThread(Client *client):
-                       SimpleThread(),
-                       m_client(client)
+       MeshUpdateThread()
        {
        }
 
        void * Thread();
+
+       MeshUpdateQueue m_queue_in;
+
+       MutexedQueue<MeshUpdateResult> m_queue_out;
 };
 
+#if 0
 struct IncomingPacket
 {
        IncomingPacket()
@@ -100,51 +222,19 @@ struct IncomingPacket
        u32 m_datalen;
        s32 *m_refcount;
 };
-
-// TODO: Remove this. It is not used as supposed.
-class LazyMeshUpdater
-{
-public:
-       LazyMeshUpdater(Environment *env)
-       {
-               m_env = env;
-       }
-       ~LazyMeshUpdater()
-       {
-               /*
-                       TODO: This could be optimized. It will currently
-                       double-update some blocks.
-               */
-               for(core::map<v3s16, bool>::Iterator
-                               i = m_blocks.getIterator();
-                               i.atEnd() == false; i++)
-               {
-                       v3s16 p = i.getNode()->getKey();
-                       m_env->updateMeshes(p);
-               }
-               m_blocks.clear();
-       }
-       void add(v3s16 p)
-       {
-               m_blocks.insert(p, true);
-       }
-private:
-       Environment *m_env;
-       core::map<v3s16, bool> m_blocks;
-};
+#endif
 
 class Client : public con::PeerHandler
 {
 public:
        /*
-               NOTE: Every public method should be thread-safe
+               NOTE: Nothing is thread-safe here.
        */
+
        Client(
                        IrrlichtDevice *device,
                        const char *playername,
-                       JMutex &range_mutex,
-                       s16 &viewing_range_nodes,
-                       bool &viewing_range_all
+                       MapDrawControl &control
                        );
        
        ~Client();
@@ -171,19 +261,16 @@ public:
 
        // Called from updater thread
        // Returns dtime
-       float asyncStep();
+       //float asyncStep();
 
        void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
        // Returns true if something was received
-       bool AsyncProcessPacket(LazyMeshUpdater &mesh_updater);
+       bool AsyncProcessPacket();
        bool AsyncProcessData();
        void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 
-       //TODO: Remove
-       bool isFetchingBlocks();
-
        // Pops out a packet from the packet queue
-       IncomingPacket getPacket();
+       //IncomingPacket getPacket();
 
        void groundAction(u8 action, v3s16 nodepos_undersurface,
                        v3s16 nodepos_oversurface, u16 item);
@@ -191,24 +278,20 @@ public:
 
        void sendSignText(v3s16 blockpos, s16 id, std::string text);
        void sendInventoryAction(InventoryAction *a);
+       void sendChatMessage(const std::wstring &message);
+       
+       // locks envlock
+       void removeNode(v3s16 p);
+       // locks envlock
+       void addNode(v3s16 p, MapNode n);
        
        void updateCamera(v3f pos, v3f dir);
        
        // Returns InvalidPositionException if not found
        MapNode getNode(v3s16 p);
-       // Returns InvalidPositionException if not found
-       //void setNode(v3s16 p, MapNode n);
+       // Wrapper to Map
+       NodeMetadata* getNodeMetadata(v3s16 p);
 
-       // Returns InvalidPositionException if not found
-       //f32 getGroundHeight(v2s16 p);
-       // Returns InvalidPositionException if not found
-       //bool isNodeUnderground(v3s16 p);
-
-       // Note: The players should not be exposed outside
-       // Return value is valid until client is destroyed
-       //Player * getLocalPlayer();
-       // Return value is valid until step()
-       //core::list<Player*> getPlayers();
        v3f getPlayerPosition();
 
        void setPlayerControl(PlayerControl &control);
@@ -218,8 +301,6 @@ public:
        bool getLocalInventoryUpdated();
        // Copies the inventory of the local player to parameter
        void getLocalInventory(Inventory &dst);
-       // TODO: Functions for sending inventory editing commands to
-       //       server
        
        // Gets closest object pointed by the shootline
        // Returns NULL if not found
@@ -232,35 +313,79 @@ public:
        // Prints a line or two of info
        void printDebugInfo(std::ostream &os);
 
-       //s32 getDayNightIndex();
        u32 getDayNightRatio();
 
        //void updateSomeExpiredMeshes();
        
        void setTempMod(v3s16 p, NodeMod mod)
        {
-               JMutexAutoLock envlock(m_env_mutex);
+               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
                assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
-               v3s16 blockpos = ((ClientMap&)m_env.getMap()).setTempMod(p, mod);
-               m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
+
+               core::map<v3s16, MapBlock*> affected_blocks;
+               ((ClientMap&)m_env.getMap()).setTempMod(p, mod,
+                               &affected_blocks);
+
+               for(core::map<v3s16, MapBlock*>::Iterator
+                               i = affected_blocks.getIterator();
+                               i.atEnd() == false; i++)
+               {
+                       i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
+               }
        }
        void clearTempMod(v3s16 p)
        {
-               JMutexAutoLock envlock(m_env_mutex);
+               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
                assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
-               v3s16 blockpos = ((ClientMap&)m_env.getMap()).clearTempMod(p);
-               m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
+
+               core::map<v3s16, MapBlock*> affected_blocks;
+               ((ClientMap&)m_env.getMap()).clearTempMod(p,
+                               &affected_blocks);
+
+               for(core::map<v3s16, MapBlock*>::Iterator
+                               i = affected_blocks.getIterator();
+                               i.atEnd() == false; i++)
+               {
+                       i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
+               }
        }
 
        float getAvgRtt()
        {
-               JMutexAutoLock lock(m_con_mutex);
+               //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
                con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
                if(peer == NULL)
                        return 0.0;
                return peer->avg_rtt;
        }
-       
+
+       bool getChatMessage(std::wstring &message)
+       {
+               if(m_chat_queue.size() == 0)
+                       return false;
+               message = m_chat_queue.pop_front();
+               return true;
+       }
+
+       void addChatMessage(const std::wstring &message)
+       {
+               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
+               LocalPlayer *player = m_env.getLocalPlayer();
+               assert(player != NULL);
+               std::wstring name = narrow_to_wide(player->getName());
+               m_chat_queue.push_back(
+                               (std::wstring)L"<"+name+L"> "+message);
+       }
+
+       u64 getMapSeed(){ return m_map_seed; }
+
+       /*
+               These are not thread-safe
+       */
+       void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
+       // Including blocks at appropriate edges
+       void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
+
 private:
        
        // Virtual methods from con::PeerHandler
@@ -273,29 +398,18 @@ private:
        void sendPlayerPos();
        // This sends the player's current name etc to the server
        void sendPlayerInfo();
-
+       
        float m_packetcounter_timer;
        float m_delete_unused_sectors_timer;
        float m_connection_reinit_timer;
        float m_avg_rtt_timer;
        float m_playerpos_send_timer;
 
-       ClientUpdateThread m_thread;
+       MeshUpdateThread m_mesh_update_thread;
        
-       // NOTE: If connection and environment are both to be locked,
-       // environment shall be locked first.
-
-       Environment m_env;
-       JMutex m_env_mutex;
+       ClientEnvironment m_env;
        
        con::Connection m_con;
-       JMutex m_con_mutex;
-
-       /*core::map<v3s16, float> m_fetchblock_history;
-       JMutex m_fetchblock_mutex;*/
-
-       core::list<IncomingPacket> m_incoming_queue;
-       JMutex m_incoming_queue_mutex;
 
        IrrlichtDevice *m_device;
 
@@ -305,9 +419,6 @@ private:
        // Server serialization version
        u8 m_server_ser_ver;
 
-       float m_step_dtime;
-       JMutex m_step_dtime_mutex;
-
        // This is behind m_env_mutex.
        bool m_inventory_updated;
 
@@ -316,11 +427,16 @@ private:
        PacketCounter m_packetcounter;
        
        // Received from the server. 0-23999
-       MutexedVariable<u32> m_time_of_day;
+       u32 m_time_of_day;
        
        // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
        //s32 m_daynight_i;
        //u32 m_daynight_ratio;
+
+       Queue<std::wstring> m_chat_queue;
+       
+       // The seed returned by the server in TOCLIENT_INIT is stored here
+       u64 m_map_seed;
 };
 
 #endif // !SERVER