Working 'noshadow' animation

[simgear.git] / simgear / threads / SGQueue.hxx

diff --git a/simgear/threads/SGQueue.hxx b/simgear/threads/SGQueue.hxx
index 80877375e96fa391c57c449e54aa1d670d73ad4e..37122c5ae150be619b48a62e85cba2ad1a6393ea 100644 (file)
--- a/simgear/threads/SGQueue.hxx
+++ b/simgear/threads/SGQueue.hxx
@@ -5,9 +5,8 @@
 
 #include <cassert>
 #include <queue>
-#include <OpenThreads/Mutex>
-#include <OpenThreads/ScopedLock>
-#include <OpenThreads/Condition>
+#include "SGGuard.hxx"
+#include "SGThread.hxx"
 
 /**
  * SGQueue defines an interface for a FIFO.
@@ -66,7 +65,7 @@ public:
 
 protected:
     /**
-     * 
+     *
      */
     std::queue<T> fifo;
 };
@@ -74,7 +73,7 @@ protected:
 /**
  * A simple thread safe queue.  All access functions are guarded with a mutex.
  */
-template<class T, class SGLOCK=OpenThreads::Mutex>
+template<class T>
 class SGLockedQueue : public SGQueue<T>
 {
 public:
@@ -95,7 +94,7 @@ public:
      * @return bool True if queue is empty, otherwisr false.
      */
     virtual bool empty() {
-       OpenThreads::ScopedLock<SGLOCK> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        return this->fifo.empty();
     }
 
@@ -105,7 +104,7 @@ public:
      * @param T object to add.
      */
     virtual void push( const T& item ) {
-       OpenThreads::ScopedLock<SGLOCK> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        this->fifo.push( item );
     }
 
@@ -115,7 +114,7 @@ public:
      * @return T next available object.
      */
     virtual T front() {
-       OpenThreads::ScopedLock<SGLOCK> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        assert( ! this->fifo.empty() );
        T item = this->fifo.front();
        return item;
@@ -127,7 +126,7 @@ public:
      * @return T next available object.
      */
     virtual T pop() {
-       OpenThreads::ScopedLock<SGLOCK> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        //if (fifo.empty()) throw NoSuchElementException();
        assert( ! this->fifo.empty() );
 //     if (fifo.empty())
@@ -146,7 +145,7 @@ public:
      * @return size_t size of queue.
      */
     virtual size_t size() {
-       OpenThreads::ScopedLock<SGLOCK> g(mutex);
+       SGGuard<SGMutex> g(mutex);
         return this->fifo.size();
     }
 
@@ -155,7 +154,7 @@ private:
     /**
      * Mutex to serialise access.
      */
-    SGLOCK mutex;
+    SGMutex mutex;
 
 private:
     // Prevent copying.
@@ -182,10 +181,10 @@ public:
     ~SGBlockingQueue() {}
 
     /**
-     * 
+     *
      */
     virtual bool empty() {
-       OpenThreads::ScopedLock<OpenThreads::Mutex> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        return this->fifo.empty();
     }
 
@@ -195,7 +194,7 @@ public:
      * @param T object to add.
      */
     virtual void push( const T& item ) {
-       OpenThreads::ScopedLock<OpenThreads::Mutex> g(mutex);
+       SGGuard<SGMutex> g(mutex);
        this->fifo.push( item );
        not_empty.signal();
     }
@@ -207,7 +206,7 @@ public:
      * @return T next available object.
      */
     virtual T front() {
-       OpenThreads::ScopedLock<OpenThreads::Mutex> g(mutex);
+       SGGuard<SGMutex> g(mutex);
 
        assert(this->fifo.empty() != true);
        //if (fifo.empty()) throw ??
@@ -223,10 +222,10 @@ public:
      * @return T next available object.
      */
     virtual T pop() {
-       OpenThreads::ScopedLock<OpenThreads::Mutex> g(mutex);
+       SGGuard<SGMutex> g(mutex);
 
        while (this->fifo.empty())
-           not_empty.wait(&mutex);
+           not_empty.wait(mutex);
 
        assert(this->fifo.empty() != true);
        //if (fifo.empty()) throw ??
@@ -242,7 +241,7 @@ public:
      * @return size_t size of queue.
      */
     virtual size_t size() {
-       OpenThreads::ScopedLock<OpenThreads::Mutex> g(mutex);
+       SGGuard<SGMutex> g(mutex);
         return this->fifo.size();
     }
 
@@ -251,12 +250,12 @@ private:
     /**
      * Mutex to serialise access.
      */
-    OpenThreads::Mutex mutex;
+    SGMutex mutex;
 
     /**
      * Condition to signal when queue not empty.
      */
-    OpenThreads::Condition not_empty;
+    SGWaitCondition not_empty;
 
 private:
     // Prevent copying.
@@ -264,4 +263,148 @@ private:
     SGBlockingQueue& operator=( const SGBlockingQueue& );
 };
 
+
+/**
+ * A guarded deque blocks threads trying to retrieve items
+ * when none are available.
+ */
+template<class T>
+class SGBlockingDeque
+{
+public:
+    /**
+     * Create a new SGBlockingDequeue.
+     */
+    SGBlockingDeque() {}
+
+    /**
+     * Destroy this dequeue.
+     */
+    ~SGBlockingDeque() {}
+
+    /**
+     *
+     */
+    virtual void clear() {
+    SGGuard<SGMutex> g(mutex);
+    this->queue.clear();
+    }
+
+    /**
+     *
+     */
+    virtual bool empty() {
+    SGGuard<SGMutex> g(mutex);
+    return this->queue.empty();
+    }
+
+    /**
+     * Add an item to the front of the queue.
+     *
+     * @param T object to add.
+     */
+    virtual void push_front( const T& item ) {
+    SGGuard<SGMutex> g(mutex);
+    this->queue.push_front( item );
+    not_empty.signal();
+    }
+
+    /**
+     * Add an item to the back of the queue.
+     *
+     * @param T object to add.
+     */
+    virtual void push_back( const T& item ) {
+    SGGuard<SGMutex> g(mutex);
+    this->queue.push_back( item );
+    not_empty.signal();
+    }
+
+    /**
+     * View the item from the head of the queue.
+     * Calling thread is not suspended
+     *
+     * @return T next available object.
+     */
+    virtual T front() {
+    SGGuard<SGMutex> g(mutex);
+
+    assert(this->queue.empty() != true);
+    //if (queue.empty()) throw ??
+
+    T item = this->queue.front();
+    return item;
+    }
+
+    /**
+     * Get an item from the head of the queue.
+     * If no items are available then the calling thread is suspended
+     *
+     * @return T next available object.
+     */
+    virtual T pop_front() {
+    SGGuard<SGMutex> g(mutex);
+
+    while (this->queue.empty())
+        not_empty.wait(mutex);
+
+    assert(this->queue.empty() != true);
+    //if (queue.empty()) throw ??
+
+    T item = this->queue.front();
+    this->queue.pop_front();
+    return item;
+    }
+
+    /**
+     * Get an item from the tail of the queue.
+     * If no items are available then the calling thread is suspended
+     *
+     * @return T next available object.
+     */
+    virtual T pop_back() {
+    SGGuard<SGMutex> g(mutex);
+
+    while (this->queue.empty())
+        not_empty.wait(mutex);
+
+    assert(this->queue.empty() != true);
+    //if (queue.empty()) throw ??
+
+    T item = this->queue.back();
+    this->queue.pop_back();
+    return item;
+    }
+
+    /**
+     * Query the size of the queue
+     *
+     * @return size_t size of queue.
+     */
+    virtual size_t size() {
+    SGGuard<SGMutex> g(mutex);
+        return this->queue.size();
+    }
+
+private:
+
+    /**
+     * Mutex to serialise access.
+     */
+    SGMutex mutex;
+
+    /**
+     * Condition to signal when queue not empty.
+     */
+    SGWaitCondition not_empty;
+
+private:
+    // Prevent copying.
+    SGBlockingDeque( const SGBlockingDeque& );
+    SGBlockingDeque& operator=( const SGBlockingDeque& );
+
+protected:
+    std::deque<T> queue;
+};
+
 #endif // SGQUEUE_HXX_INCLUDED