warning suppressed for MSVC++

[wxWidgets.git] / include / wx / thread.h

diff --git a/include/wx/thread.h b/include/wx/thread.h
index 9700b4ddfd7214b4df86930347d520cba6270e9f..909608c60620a094ee0eae6199bbeca97a69da52 100644 (file)
--- a/include/wx/thread.h
+++ b/include/wx/thread.h
@@ -16,58 +16,168 @@
 #pragma interface "thread.h"
 #endif
 
 #pragma interface "thread.h"
 #endif
 

-#include "wx/object.h"
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 #include "wx/setup.h"
 
 #include "wx/setup.h"
 

-typedef enum {
-  MUTEX_NO_ERROR=0,
-  MUTEX_DEAD_LOCK,             // Mutex has been already locked by THE CALLING thread 
-  MUTEX_BUSY,                  // Mutex has been already locked by ONE thread
-  MUTEX_UNLOCKED
+#if wxUSE_THREADS
+#include "wx/module.h"
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+typedef enum 
+{
+  wxMUTEX_NO_ERROR = 0,
+  wxMUTEX_DEAD_LOCK,      // Mutex has been already locked by THE CALLING thread 
+  wxMUTEX_BUSY,           // Mutex has been already locked by ONE thread
+  wxMUTEX_UNLOCKED,
+  wxMUTEX_MISC_ERROR

 } wxMutexError;
 
 } wxMutexError;
 

-typedef enum {
-  THREAD_NO_ERROR=0,           // No error
-  THREAD_NO_RESOURCE,          // No resource left to create a new thread
-  THREAD_RUNNING,              // The thread is already running
-  THREAD_NOT_RUNNING,          // The thread isn't running
-  THREAD_MISC_ERROR             // Some other error
+typedef enum 
+{
+  wxTHREAD_NO_ERROR = 0,      // No error
+  wxTHREAD_NO_RESOURCE,       // No resource left to create a new thread
+  wxTHREAD_RUNNING,           // The thread is already running
+  wxTHREAD_NOT_RUNNING,       // The thread isn't running
+  wxTHREAD_MISC_ERROR         // Some other error

 } wxThreadError;
 
 } wxThreadError;
 

-// defines the interval of priority.
-#define WXTHREAD_MIN_PRIORITY 0
+/* defines the interval of priority. */
+#define WXTHREAD_MIN_PRIORITY     0

 #define WXTHREAD_DEFAULT_PRIORITY 50
 #define WXTHREAD_DEFAULT_PRIORITY 50

-#define WXTHREAD_MAX_PRIORITY 100
+#define WXTHREAD_MAX_PRIORITY     100
+
+// ----------------------------------------------------------------------------
+// A mutex object is a synchronization object whose state is set to signaled
+// when it is not owned by any thread, and nonsignaled when it is owned. Its
+// name comes from its usefulness in coordinating mutually-exclusive access to
+// a shared resource. Only one thread at a time can own a mutex object.
+// ----------------------------------------------------------------------------

 
 

-// ---------------------------------------------------------------------------
-// Mutex handler
+// you should consider wxMutexLocker whenever possible instead of directly
+// working with wxMutex class - it is safer

 class WXDLLEXPORT wxMutexInternal;
 class WXDLLEXPORT wxMutexInternal;

-class WXDLLEXPORT wxMutex {
+class WXDLLEXPORT wxMutex 
+{

 public:
 public:

-  // constructor & destructor 
-  wxMutex();
-  ~wxMutex();
-
-  // Lock the mutex.
-  wxMutexError Lock();
-  // Try to lock the mutex: if it can't, returns immediately with an error.
-  wxMutexError TryLock();
-  // Unlock the mutex.
-  wxMutexError Unlock();
-
-  // Returns true if the mutex is locked.
-  bool IsLocked() const { return (m_locked > 0); }
+    // constructor & destructor 
+    wxMutex();
+    ~wxMutex();
+
+    // Lock the mutex.
+    wxMutexError Lock();
+    // Try to lock the mutex: if it can't, returns immediately with an error.
+    wxMutexError TryLock();
+    // Unlock the mutex.
+    wxMutexError Unlock();
+
+    // Returns true if the mutex is locked.
+    bool IsLocked() const { return (m_locked > 0); }
+

 protected:
 protected:

-  friend class wxCondition;
+    friend class wxCondition;
+
+    // no assignment operator nor copy ctor
+    wxMutex(const wxMutex&);
+    wxMutex& operator=(const wxMutex&);
+
+    int m_locked;
+    wxMutexInternal *p_internal;
+};
+
+// a helper class which locks the mutex in the ctor and unlocks it in the dtor:
+// this ensures that mutex is always unlocked, even if the function returns or
+// throws an exception before it reaches the end
+class WXDLLEXPORT wxMutexLocker
+{
+public:
+    // lock the mutex in the ctor
+    wxMutexLocker(wxMutex *mutex)
+        { m_isOk = mutex && ((m_mutex = mutex)->Lock() == wxMUTEX_NO_ERROR); }
+
+    // returns TRUE if mutex was successfully locked in ctor
+    bool IsOk() const { return m_isOk; }
+
+    // unlock the mutex in dtor
+    ~wxMutexLocker() { if ( IsOk() ) m_mutex->Unlock(); }
+
+private:
+    // no assignment operator nor copy ctor
+    wxMutexLocker(const wxMutexLocker&);
+    wxMutexLocker& operator=(const wxMutexLocker&);
+
+    bool     m_isOk;
+    wxMutex *m_mutex;
+};
+
+// ----------------------------------------------------------------------------
+// Critical section: this is the same as mutex but is only visible to the
+// threads of the same process. For the platforms which don't have native
+// support for critical sections, they're implemented entirely in terms of
+// mutexes
+// ----------------------------------------------------------------------------
+
+// you should consider wxCriticalSectionLocker whenever possible instead of
+// directly working with wxCriticalSection class - it is safer
+#ifdef __WXMSW__
+    class WXDLLEXPORT wxCriticalSectionInternal;
+    #define WXCRITICAL_INLINE
+#else // !MSW
+    #define WXCRITICAL_INLINE   inline
+#endif // MSW/!MSW
+class WXDLLEXPORT wxCriticalSection
+{
+public:
+    // ctor & dtor
+    WXCRITICAL_INLINE wxCriticalSection();
+    WXCRITICAL_INLINE ~wxCriticalSection();
+
+    // enter the section (the same as locking a mutex)
+    void WXCRITICAL_INLINE Enter();
+    // leave the critical section (same as unlocking a mutex)
+    void WXCRITICAL_INLINE Leave();
+
+private:
+    // no assignment operator nor copy ctor
+    wxCriticalSection(const wxCriticalSection&);
+    wxCriticalSection& operator=(const wxCriticalSection&);

 
 

-  int m_locked;
-  wxMutexInternal *p_internal;
+#ifdef __WXMSW__
+    wxCriticalSectionInternal *m_critsect;
+#else // !MSW
+    wxMutex m_mutex;
+#endif // MSW/!MSW

 };
 
 };
 

-// ---------------------------------------------------------------------------
+// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
+// to th mutexes
+class WXDLLEXPORT wxCriticalSectionLocker
+{
+public:
+    wxCriticalSectionLocker(wxCriticalSection& critsect) : m_critsect(critsect)
+        { m_critsect.Enter(); }
+    ~wxCriticalSectionLocker()
+        { m_critsect.Leave(); }
+
+private:
+    // no assignment operator nor copy ctor
+    wxCriticalSectionLocker(const wxCriticalSectionLocker&);
+    wxCriticalSectionLocker& operator=(const wxCriticalSectionLocker&);
+
+    wxCriticalSection& m_critsect;
+};
+
+// ----------------------------------------------------------------------------

 // Condition handler.
 // Condition handler.

+// ----------------------------------------------------------------------------
+

 class wxConditionInternal;
 class wxConditionInternal;

-class WXDLLEXPORT wxCondition {
+class WXDLLEXPORT wxCondition 
+{

 public:
   // constructor & destructor
   wxCondition();
 public:
   // constructor & destructor
   wxCondition();


@@ -81,14 +191,18 @@ public:
   void Signal();
   // Broadcasts to all "Waiters".
   void Broadcast();
   void Signal();
   // Broadcasts to all "Waiters".
   void Broadcast();

+

 private:
   wxConditionInternal *p_internal;
 };
 
 private:
   wxConditionInternal *p_internal;
 };
 

-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // Thread management class
 // Thread management class

+// ----------------------------------------------------------------------------
+

 class wxThreadInternal;
 class wxThreadInternal;

-class WXDLLEXPORT wxThread {
+class WXDLLEXPORT wxThread 
+{

 public:
   // constructor & destructor.
   wxThread();
 public:
   // constructor & destructor.
   wxThread();


@@ -126,19 +240,22 @@ public:
   bool IsAlive() const;
   // Returns true if the thread is running (not paused, not killed).
   bool IsRunning() const;
   bool IsAlive() const;
   // Returns true if the thread is running (not paused, not killed).
   bool IsRunning() const;

-  // Returns true if the thread is the main thread (aka the GUI thread).
+  // Returns true if the thread is suspended
+  bool IsPaused() const { return IsAlive() && !IsRunning(); }
+
+  // Returns true if current thread is the main thread (aka the GUI thread)

   static bool IsMain();
 
   // Called when thread exits.
   virtual void OnExit();
 
   static bool IsMain();
 
   // Called when thread exits.
   virtual void OnExit();
 

-  // Returns the wxThread object which corresponds to the ID.
-  static wxThread *GetThreadFromID(unsigned long id);

 protected:
 protected:

-  // In case, the DIFFER flag is true, enables another thread to kill this one.
-  void TestDestroy();
+  // Returns TRUE if the thread was asked to terminate
+  bool TestDestroy();
+

   // Exits from the current thread.
   void Exit(void *status = NULL);
   // Exits from the current thread.
   void Exit(void *status = NULL);

+

 private:
   // Entry point for the thread.
   virtual void *Entry() = 0;
 private:
   // Entry point for the thread.
   virtual void *Entry() = 0;


@@ -149,10 +266,53 @@ private:
   wxThreadInternal *p_internal;
 };
 
   wxThreadInternal *p_internal;
 };
 

-// ---------------------------------------------------------------------------
-// Global variables
+// ----------------------------------------------------------------------------
+// Automatic initialization
+// ----------------------------------------------------------------------------

 
 

-// GUI mutex.
-WXDLLEXPORT_DATA(extern wxMutex) wxMainMutex;
+// GUI mutex handling.
+void WXDLLEXPORT wxMutexGuiEnter();
+void WXDLLEXPORT wxMutexGuiLeave();

 
 

-#endif
+#else // !wxUSE_THREADS
+
+// no thread support
+inline void WXDLLEXPORT wxMutexGuiEnter() { }
+inline void WXDLLEXPORT wxMutexGuiLeave() { }
+
+#endif // wxUSE_THREADS
+
+// automatically unlock GUI mutex in dtor
+class WXDLLEXPORT wxMutexGuiLocker
+{
+public:
+    wxMutexGuiLocker() { wxMutexGuiEnter(); }
+   ~wxMutexGuiLocker() { wxMutexGuiLeave(); }
+};
+
+// -----------------------------------------------------------------------------
+// implementation only until the end of file
+// -----------------------------------------------------------------------------
+#ifdef wxUSE_THREADS
+#ifdef __WXMSW__
+    // unlock GUI if there are threads waiting for and lock it back when
+    // there are no more of them - should be called periodically by the main
+    // thread
+    extern void WXDLLEXPORT wxMutexGuiLeaveOrEnter();
+
+    // returns TRUE if the main thread has GUI lock
+    extern bool WXDLLEXPORT wxGuiOwnedByMainThread();
+
+    // wakes up the main thread if it's sleeping inside ::GetMessage()
+    extern void WXDLLEXPORT wxWakeUpMainThread();
+#else // !MSW
+    // implement wxCriticalSection using mutexes
+    inline wxCriticalSection::wxCriticalSection() { }
+    inline wxCriticalSection::~wxCriticalSection() { }
+
+    inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
+    inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
+#endif // MSW/!MSW
+#endif // wxUSE_THREADS
+
+#endif // __THREADH__