src/util/container.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef UTIL_CONTAINER_HEADER
  21 #define UTIL_CONTAINER_HEADER
  22
  23 #include "../irrlichttypes.h"
  24 #include "../exceptions.h"
  25 #include "../jthread/jmutex.h"
  26 #include "../jthread/jmutexautolock.h"
  27 #include "../jthread/jsemaphore.h"
  28 #include <list>
  29 #include <vector>
  30 #include <map>
  31 #include <set>
  32 #include <queue>
  33
  34 /*
  35 Queue with unique values with fast checking of value existence
  36 */
  37
  38 template<typename Value>
  39 class UniqueQueue
  40 {
  41 public:
  42
  43         /*
  44         Does nothing if value is already queued.
  45         Return value:
  46         true: value added
  47         false: value already exists
  48         */
  49         bool push_back(const Value& value)
  50         {
  51                 if (m_set.insert(value).second)
  52                 {
  53                         m_queue.push(value);
  54                         return true;
  55                 }
  56                 return false;
  57         }
  58
  59         void pop_front()
  60         {
  61                 m_set.erase(m_queue.front());
  62                 m_queue.pop();
  63         }
  64
  65         const Value& front() const
  66         {
  67                 return m_queue.front();
  68         }
  69
  70         u32 size() const
  71         {
  72                 return m_queue.size();
  73         }
  74
  75 private:
  76         std::set<Value> m_set;
  77         std::queue<Value> m_queue;
  78 };
  79
  80 template<typename Key, typename Value>
  81 class MutexedMap
  82 {
  83 public:
  84         MutexedMap()
  85         {
  86         }
  87
  88         void set(const Key &name, const Value &value)
  89         {
  90                 JMutexAutoLock lock(m_mutex);
  91
  92                 m_values[name] = value;
  93         }
  94
  95         bool get(const Key &name, Value *result)
  96         {
  97                 JMutexAutoLock lock(m_mutex);
  98
  99                 typename std::map<Key, Value>::iterator n;
 100                 n = m_values.find(name);
 101
 102                 if(n == m_values.end())
 103                         return false;
 104
 105                 if(result != NULL)
 106                         *result = n->second;
 107
 108                 return true;
 109         }
 110
 111         std::vector<Value> getValues()
 112         {
 113                 std::vector<Value> result;
 114                 for(typename std::map<Key, Value>::iterator
 115                         i = m_values.begin();
 116                         i != m_values.end(); ++i){
 117                         result.push_back(i->second);
 118                 }
 119                 return result;
 120         }
 121
 122         void clear ()
 123         {
 124                 m_values.clear();
 125         }
 126
 127 private:
 128         std::map<Key, Value> m_values;
 129         JMutex m_mutex;
 130 };
 131
 132 /*
 133 Generates ids for comparable values.
 134 Id=0 is reserved for "no value".
 135
 136 Is fast at:
 137 - Returning value by id (very fast)
 138 - Returning id by value
 139 - Generating a new id for a value
 140
 141 Is not able to:
 142 - Remove an id/value pair (is possible to implement but slow)
 143 */
 144 template<typename T>
 145 class MutexedIdGenerator
 146 {
 147 public:
 148         MutexedIdGenerator()
 149         {
 150         }
 151
 152         // Returns true if found
 153         bool getValue(u32 id, T &value)
 154         {
 155                 if(id == 0)
 156                         return false;
 157                 JMutexAutoLock lock(m_mutex);
 158                 if(m_id_to_value.size() < id)
 159                         return false;
 160                 value = m_id_to_value[id-1];
 161                 return true;
 162         }
 163
 164         // If id exists for value, returns the id.
 165         // Otherwise generates an id for the value.
 166         u32 getId(const T &value)
 167         {
 168                 JMutexAutoLock lock(m_mutex);
 169                 typename std::map<T, u32>::iterator n;
 170                 n = m_value_to_id.find(value);
 171                 if(n != m_value_to_id.end())
 172                         return n->second;
 173                 m_id_to_value.push_back(value);
 174                 u32 new_id = m_id_to_value.size();
 175                 m_value_to_id.insert(value, new_id);
 176                 return new_id;
 177         }
 178
 179 private:
 180         JMutex m_mutex;
 181         // Values are stored here at id-1 position (id 1 = [0])
 182         std::vector<T> m_id_to_value;
 183         std::map<T, u32> m_value_to_id;
 184 };
 185
 186 /*
 187 Thread-safe FIFO queue (well, actually a FILO also)
 188 */
 189
 190 template<typename T>
 191 class MutexedQueue
 192 {
 193 public:
 194         template<typename Key, typename U, typename Caller, typename CallerData>
 195         friend class RequestQueue;
 196
 197         MutexedQueue()
 198         {
 199         }
 200         bool empty()
 201         {
 202                 JMutexAutoLock lock(m_mutex);
 203                 return (m_size.GetValue() == 0);
 204         }
 205         void push_back(T t)
 206         {
 207                 JMutexAutoLock lock(m_mutex);
 208                 m_list.push_back(t);
 209                 m_size.Post();
 210         }
 211
 212         /* this version of pop_front returns a empty element of T on timeout.
 213         * Make sure default constructor of T creates a recognizable "empty" element
 214         */
 215         T pop_frontNoEx(u32 wait_time_max_ms)
 216         {
 217                 if (m_size.Wait(wait_time_max_ms))
 218                 {
 219                         JMutexAutoLock lock(m_mutex);
 220
 221                         typename std::list<T>::iterator begin = m_list.begin();
 222                         T t = *begin;
 223                         m_list.erase(begin);
 224                         return t;
 225                 }
 226                 else
 227                 {
 228                         return T();
 229                 }
 230         }
 231
 232         T pop_front(u32 wait_time_max_ms)
 233         {
 234                 if (m_size.Wait(wait_time_max_ms))
 235                 {
 236                         JMutexAutoLock lock(m_mutex);
 237
 238                         typename std::list<T>::iterator begin = m_list.begin();
 239                         T t = *begin;
 240                         m_list.erase(begin);
 241                         return t;
 242                 }
 243                 else
 244                 {
 245                         throw ItemNotFoundException("MutexedQueue: queue is empty");
 246                 }
 247         }
 248
 249         T pop_frontNoEx()
 250         {
 251                 m_size.Wait();
 252
 253                 JMutexAutoLock lock(m_mutex);
 254
 255                 typename std::list<T>::iterator begin = m_list.begin();
 256                 T t = *begin;
 257                 m_list.erase(begin);
 258                 return t;
 259         }
 260
 261         T pop_back(u32 wait_time_max_ms=0)
 262         {
 263                 if (m_size.Wait(wait_time_max_ms))
 264                 {
 265                         JMutexAutoLock lock(m_mutex);
 266
 267                         typename std::list<T>::iterator last = m_list.end();
 268                         last--;
 269                         T t = *last;
 270                         m_list.erase(last);
 271                         return t;
 272                 }
 273                 else
 274                 {
 275                         throw ItemNotFoundException("MutexedQueue: queue is empty");
 276                 }
 277         }
 278
 279         /* this version of pop_back returns a empty element of T on timeout.
 280         * Make sure default constructor of T creates a recognizable "empty" element
 281         */
 282         T pop_backNoEx(u32 wait_time_max_ms=0)
 283         {
 284                 if (m_size.Wait(wait_time_max_ms))
 285                 {
 286                         JMutexAutoLock lock(m_mutex);
 287
 288                         typename std::list<T>::iterator last = m_list.end();
 289                         last--;
 290                         T t = *last;
 291                         m_list.erase(last);
 292                         return t;
 293                 }
 294                 else
 295                 {
 296                         return T();
 297                 }
 298         }
 299
 300         T pop_backNoEx()
 301         {
 302                 m_size.Wait();
 303
 304                 JMutexAutoLock lock(m_mutex);
 305
 306                 typename std::list<T>::iterator last = m_list.end();
 307                 last--;
 308                 T t = *last;
 309                 m_list.erase(last);
 310                 return t;
 311         }
 312
 313 protected:
 314         JMutex & getMutex()
 315         {
 316                 return m_mutex;
 317         }
 318
 319         // NEVER EVER modify the >>list<< you got by using this function!
 320         // You may only modify it's content
 321         std::list<T> & getList()
 322         {
 323                 return m_list;
 324         }
 325
 326         JMutex m_mutex;
 327         std::list<T> m_list;
 328         JSemaphore m_size;
 329 };
 330
 331 #endif
 332