Change way commands are displayed in chat window
[oweals/minetest.git] / src / client.h
index a1ee3f762b62b0c122c310f537cff3e618a720c9..1a7ef924ac53d7b9085c4a75e59e480dd60f9761 100644 (file)
@@ -27,6 +27,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "common_irrlicht.h"
 #include "jmutex.h"
 #include <ostream>
+#include "clientobject.h"
+#include "utility.h" // For IntervalLimiter
+
+struct MeshMakeData;
 
 class ClientNotReadyException : public BaseException
 {
@@ -36,115 +40,110 @@ public:
        {}
 };
 
-class Client;
-
-class ClientUpdateThread : public SimpleThread
+struct QueuedMeshUpdate
 {
-       Client *m_client;
+       v3s16 p;
+       MeshMakeData *data;
+       bool ack_block_to_server;
+
+       QueuedMeshUpdate();
+       ~QueuedMeshUpdate();
+};
 
+/*
+       A thread-safe queue of mesh update tasks
+*/
+class MeshUpdateQueue
+{
 public:
+       MeshUpdateQueue();
+
+       ~MeshUpdateQueue();
+       
+       /*
+               peer_id=0 adds with nobody to send to
+       */
+       void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
+
+       // Returned pointer must be deleted
+       // Returns NULL if queue is empty
+       QueuedMeshUpdate * pop();
 
-       ClientUpdateThread(Client *client):
-                       SimpleThread(),
-                       m_client(client)
+       u32 size()
        {
+               JMutexAutoLock lock(m_mutex);
+               return m_queue.size();
        }
-
-       void * Thread();
+       
+private:
+       core::list<QueuedMeshUpdate*> m_queue;
+       JMutex m_mutex;
 };
 
-struct IncomingPacket
+struct MeshUpdateResult
 {
-       IncomingPacket()
-       {
-               m_data = NULL;
-               m_datalen = 0;
-               m_refcount = NULL;
-       }
-       IncomingPacket(const IncomingPacket &a)
+       v3s16 p;
+       scene::SMesh *mesh;
+       bool ack_block_to_server;
+
+       MeshUpdateResult():
+               p(-1338,-1338,-1338),
+               mesh(NULL),
+               ack_block_to_server(false)
        {
-               m_data = a.m_data;
-               m_datalen = a.m_datalen;
-               m_refcount = a.m_refcount;
-               if(m_refcount != NULL)
-                       (*m_refcount)++;
        }
-       IncomingPacket(u8 *data, u32 datalen)
-       {
-               m_data = new u8[datalen];
-               memcpy(m_data, data, datalen);
-               m_datalen = datalen;
-               m_refcount = new s32(1);
-       }
-       ~IncomingPacket()
-       {
-               if(m_refcount != NULL){
-                       assert(*m_refcount > 0);
-                       (*m_refcount)--;
-                       if(*m_refcount == 0){
-                               if(m_data != NULL)
-                                       delete[] m_data;
-                               delete m_refcount;
-                       }
-               }
-       }
-       /*IncomingPacket & operator=(IncomingPacket a)
-       {
-               m_data = a.m_data;
-               m_datalen = a.m_datalen;
-               m_refcount = a.m_refcount;
-               (*m_refcount)++;
-               return *this;
-       }*/
-       u8 *m_data;
-       u32 m_datalen;
-       s32 *m_refcount;
 };
 
-// TODO: Remove this. It is not used as supposed.
-class LazyMeshUpdater
+class MeshUpdateThread : public SimpleThread
 {
 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)
+
+       MeshUpdateThread()
        {
-               m_blocks.insert(p, true);
        }
-private:
-       Environment *m_env;
-       core::map<v3s16, bool> m_blocks;
+
+       void * Thread();
+
+       MeshUpdateQueue m_queue_in;
+
+       MutexedQueue<MeshUpdateResult> m_queue_out;
+};
+
+enum ClientEventType
+{
+       CE_NONE,
+       CE_PLAYER_DAMAGE,
+       CE_PLAYER_FORCE_MOVE
+};
+
+struct ClientEvent
+{
+       ClientEventType type;
+       union{
+               struct{
+               } none;
+               struct{
+                       u8 amount;
+               } player_damage;
+               struct{
+                       f32 pitch;
+                       f32 yaw;
+               } player_force_move;
+       };
 };
 
-class Client : public con::PeerHandler
+class Client : public con::PeerHandler, public InventoryManager
 {
 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
+                       std::string password,
+                       MapDrawControl &control
                        );
        
        ~Client();
@@ -171,55 +170,61 @@ 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 removeNode(v3s16 nodepos);
-       void addNodeFromInventory(v3s16 nodepos, u16 i);*/
-       void pressGround(u8 button, v3s16 nodepos_undersurface,
+       void groundAction(u8 action, v3s16 nodepos_undersurface,
                        v3s16 nodepos_oversurface, u16 item);
        void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
-       void stopDigging();
+       void clickActiveObject(u8 button, u16 id, u16 item);
 
        void sendSignText(v3s16 blockpos, s16 id, std::string text);
+       void sendSignNodeText(v3s16 p, std::string text);
+       void sendInventoryAction(InventoryAction *a);
+       void sendChatMessage(const std::wstring &message);
+       void sendChangePassword(const std::wstring oldpassword,
+               const std::wstring newpassword);
+       void sendDamage(u8 damage);
+       
+       // 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
-       //f32 getGroundHeight(v2s16 p);
-       // Returns InvalidPositionException if not found
-       bool isNodeUnderground(v3s16 p);
+       // Wrapper to Map
+       NodeMetadata* getNodeMetadata(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();
+       // Get the player position, and optionally put the
+       // eye position in *eye_position
+       v3f getPlayerPosition(v3f *eye_position=NULL);
 
        void setPlayerControl(PlayerControl &control);
-       
+
+       void selectPlayerItem(u16 item);
+
        // Returns true if the inventory of the local player has been
        // updated from the server. If it is true, it is set to false.
        bool getLocalInventoryUpdated();
        // Copies the inventory of the local player to parameter
        void getLocalInventory(Inventory &dst);
-       // TODO: Functions for sending inventory editing commands to
-       //       server
        
+       InventoryContext *getInventoryContext();
+
+       Inventory* getInventory(InventoryContext *c, std::string id);
+       void inventoryAction(InventoryAction *a);
+
        // Gets closest object pointed by the shootline
        // Returns NULL if not found
        MapBlockObject * getSelectedObject(
@@ -228,14 +233,85 @@ public:
                        core::line3d<f32> shootline_on_map
        );
 
+       // Gets closest object pointed by the shootline
+       // Returns NULL if not found
+       ClientActiveObject * getSelectedActiveObject(
+                       f32 max_d,
+                       v3f from_pos_f_on_map,
+                       core::line3d<f32> shootline_on_map
+       );
+
        // Prints a line or two of info
        void printDebugInfo(std::ostream &os);
 
-       //s32 getDayNightIndex();
        u32 getDayNightRatio();
 
-       //void updateSomeExpiredMeshes();
+       u16 getHP();
+
+       void setTempMod(v3s16 p, NodeMod mod);
+       void clearTempMod(v3s16 p);
+
+       float getAvgRtt()
+       {
+               //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)
+       {
+               if (message[0] == L'/') {
+                       m_chat_queue.push_back(
+                               (std::wstring)L"issued command: "+message);
+                       return;
+               }
+
+               //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; }
+
+       void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
+       // Including blocks at appropriate edges
+       void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
+
+       // Get event from queue. CE_NONE is returned if queue is empty.
+       ClientEvent getClientEvent();
+       
+       inline bool accessDenied()
+       {
+               return m_access_denied;
+       }
+
+       inline std::wstring accessDeniedReason()
+       {
+               return m_access_denied_reason;
+       }
        
+       /*
+               This should only be used for calling the special drawing stuff in
+               ClientEnvironment
+       */
+       ClientEnvironment * getEnv()
+       {
+               return &m_env;
+       }
+
 private:
        
        // Virtual methods from con::PeerHandler
@@ -248,29 +324,21 @@ private:
        void sendPlayerPos();
        // This sends the player's current name etc to the server
        void sendPlayerInfo();
-
+       // Send the item number 'item' as player item to the server
+       void sendPlayerItem(u16 item);
+       
        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;
+       float m_ignore_damage_timer; // Used after server moves player
+       IntervalLimiter m_map_timer_and_unload_interval;
 
-       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;
 
@@ -280,9 +348,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;
 
@@ -291,11 +356,26 @@ 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;
+       
+       std::string m_password;
+       bool m_access_denied;
+       std::wstring m_access_denied_reason;
+
+       InventoryContext m_inventory_context;
+
+       Queue<ClientEvent> m_client_event_queue;
+
+       friend class FarMesh;
 };
 
 #endif // !SERVER