Expose getPointedThing to Lua
[oweals/minetest.git] / src / util / container.h
index 267d54c16632cce645aee9df2db856b831d3cc0e..caaa1c328fdd32bb10c319c802770b82722970c1 100644 (file)
@@ -22,9 +22,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "../irrlichttypes.h"
 #include "../exceptions.h"
-#include "../jthread/jmutex.h"
-#include "../jthread/jmutexautolock.h"
-#include "../jthread/jsemaphore.h"
+#include "../threading/mutex_auto_lock.h"
+#include "../threading/semaphore.h"
 #include <list>
 #include <vector>
 #include <map>
@@ -81,111 +80,47 @@ template<typename Key, typename Value>
 class MutexedMap
 {
 public:
-       MutexedMap()
-       {
-       }
+       MutexedMap() {}
 
        void set(const Key &name, const Value &value)
        {
-               JMutexAutoLock lock(m_mutex);
-
+               MutexAutoLock lock(m_mutex);
                m_values[name] = value;
        }
 
-       bool get(const Key &name, Value *result)
+       bool get(const Key &name, Value *result) const
        {
-               JMutexAutoLock lock(m_mutex);
-
-               typename std::map<Key, Value>::iterator n;
-               n = m_values.find(name);
-
-               if(n == m_values.end())
+               MutexAutoLock lock(m_mutex);
+               typename std::map<Key, Value>::const_iterator n =
+                       m_values.find(name);
+               if (n == m_values.end())
                        return false;
-
-               if(result != NULL)
+               if (result)
                        *result = n->second;
-
                return true;
        }
 
-       std::vector<Value> getValues()
+       std::vector<Value> getValues() const
        {
+               MutexAutoLock lock(m_mutex);
                std::vector<Value> result;
-               for(typename std::map<Key, Value>::iterator
-                       i = m_values.begin();
-                       i != m_values.end(); ++i){
-                       result.push_back(i->second);
+               for (typename std::map<Key, Value>::const_iterator
+                               it = m_values.begin();
+                               it != m_values.end(); ++it){
+                       result.push_back(it->second);
                }
                return result;
        }
 
-       void clear ()
-       {
-               m_values.clear();
-       }
+       void clear() { m_values.clear(); }
 
 private:
        std::map<Key, Value> m_values;
-       JMutex m_mutex;
+       mutable std::mutex m_mutex;
 };
 
-/*
-Generates ids for comparable values.
-Id=0 is reserved for "no value".
 
-Is fast at:
-- Returning value by id (very fast)
-- Returning id by value
-- Generating a new id for a value
-
-Is not able to:
-- Remove an id/value pair (is possible to implement but slow)
-*/
-template<typename T>
-class MutexedIdGenerator
-{
-public:
-       MutexedIdGenerator()
-       {
-       }
-
-       // Returns true if found
-       bool getValue(u32 id, T &value)
-       {
-               if(id == 0)
-                       return false;
-               JMutexAutoLock lock(m_mutex);
-               if(m_id_to_value.size() < id)
-                       return false;
-               value = m_id_to_value[id-1];
-               return true;
-       }
-
-       // If id exists for value, returns the id.
-       // Otherwise generates an id for the value.
-       u32 getId(const T &value)
-       {
-               JMutexAutoLock lock(m_mutex);
-               typename std::map<T, u32>::iterator n;
-               n = m_value_to_id.find(value);
-               if(n != m_value_to_id.end())
-                       return n->second;
-               m_id_to_value.push_back(value);
-               u32 new_id = m_id_to_value.size();
-               m_value_to_id.insert(value, new_id);
-               return new_id;
-       }
-
-private:
-       JMutex m_mutex;
-       // Values are stored here at id-1 position (id 1 = [0])
-       std::vector<T> m_id_to_value;
-       std::map<T, u32> m_value_to_id;
-};
-
-/*
-Thread-safe FIFO queue (well, actually a FILO also)
-*/
+// Thread-safe Double-ended queue
 
 template<typename T>
 class MutexedQueue
@@ -194,19 +129,18 @@ public:
        template<typename Key, typename U, typename Caller, typename CallerData>
        friend class RequestQueue;
 
-       MutexedQueue()
-       {
-       }
-       bool empty()
+       MutexedQueue() {}
+       bool empty() const
        {
-               JMutexAutoLock lock(m_mutex);
-               return (m_queue.size() == 0);
+               MutexAutoLock lock(m_mutex);
+               return m_queue.empty();
        }
+
        void push_back(T t)
        {
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
                m_queue.push_back(t);
-               m_size.Post();
+               m_signal.post();
        }
 
        /* this version of pop_front returns a empty element of T on timeout.
@@ -214,37 +148,35 @@ public:
        */
        T pop_frontNoEx(u32 wait_time_max_ms)
        {
-               if (m_size.Wait(wait_time_max_ms)) {
-                       JMutexAutoLock lock(m_mutex);
+               if (m_signal.wait(wait_time_max_ms)) {
+                       MutexAutoLock lock(m_mutex);
 
                        T t = m_queue.front();
                        m_queue.pop_front();
                        return t;
-               }
-               else {
+               } else {
                        return T();
                }
        }
 
        T pop_front(u32 wait_time_max_ms)
        {
-               if (m_size.Wait(wait_time_max_ms)) {
-                       JMutexAutoLock lock(m_mutex);
+               if (m_signal.wait(wait_time_max_ms)) {
+                       MutexAutoLock lock(m_mutex);
 
                        T t = m_queue.front();
                        m_queue.pop_front();
                        return t;
-               }
-               else {
+               } else {
                        throw ItemNotFoundException("MutexedQueue: queue is empty");
                }
        }
 
        T pop_frontNoEx()
        {
-               m_size.Wait();
+               m_signal.wait();
 
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
 
                T t = m_queue.front();
                m_queue.pop_front();
@@ -253,14 +185,13 @@ public:
 
        T pop_back(u32 wait_time_max_ms=0)
        {
-               if (m_size.Wait(wait_time_max_ms)) {
-                       JMutexAutoLock lock(m_mutex);
+               if (m_signal.wait(wait_time_max_ms)) {
+                       MutexAutoLock lock(m_mutex);
 
                        T t = m_queue.back();
                        m_queue.pop_back();
                        return t;
-               }
-               else {
+               } else {
                        throw ItemNotFoundException("MutexedQueue: queue is empty");
                }
        }
@@ -268,25 +199,24 @@ public:
        /* this version of pop_back returns a empty element of T on timeout.
        * Make sure default constructor of T creates a recognizable "empty" element
        */
-       T pop_backNoEx(u32 wait_time_max_ms=0)
+       T pop_backNoEx(u32 wait_time_max_ms)
        {
-               if (m_size.Wait(wait_time_max_ms)) {
-                       JMutexAutoLock lock(m_mutex);
+               if (m_signal.wait(wait_time_max_ms)) {
+                       MutexAutoLock lock(m_mutex);
 
                        T t = m_queue.back();
                        m_queue.pop_back();
                        return t;
-               }
-               else {
+               } else {
                        return T();
                }
        }
 
        T pop_backNoEx()
        {
-               m_size.Wait();
+               m_signal.wait();
 
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
 
                T t = m_queue.back();
                m_queue.pop_back();
@@ -294,19 +224,13 @@ public:
        }
 
 protected:
-       JMutex & getMutex()
-       {
-               return m_mutex;
-       }
+       std::mutex &getMutex() { return m_mutex; }
 
-       std::deque<T> & getQueue()
-       {
-               return m_queue;
-       }
+       std::deque<T> &getQueue() { return m_queue; }
 
        std::deque<T> m_queue;
-       JMutex m_mutex;
-       JSemaphore m_size;
+       mutable std::mutex m_mutex;
+       Semaphore m_signal;
 };
 
 template<typename K, typename V>