More SC++ fixes; HelpGen starting to compile with VC++; image sample now compiles...

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

diff --git a/include/wx/thread.h b/include/wx/thread.h
index aa435992563832a4cc1945eb73f08a7190c17bf5..fb12b9ccc8b8e1dd36002ef41d320f28fe958ed2 100644 (file)
--- a/include/wx/thread.h
+++ b/include/wx/thread.h
@@ -16,8 +16,12 @@
 #pragma interface "thread.h"
 #endif
 
-#include "wx/object.h"
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
 #include "wx/setup.h"
+
+#if wxUSE_THREADS
 #include "wx/module.h"
 
 // ----------------------------------------------------------------------------
@@ -48,16 +52,14 @@ typedef enum
 #define WXTHREAD_MAX_PRIORITY     100
 
 // ----------------------------------------------------------------------------
-// GUI mutex handling.
-// ----------------------------------------------------------------------------
-
-void WXDLLEXPORT wxMutexGuiEnter();
-void WXDLLEXPORT wxMutexGuiLeave();
-
-// ----------------------------------------------------------------------------
-// Mutex handler
+// 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.
 // ----------------------------------------------------------------------------
 
+// you should consider wxMutexLocker whenever possible instead of directly
+// working with wxMutex class - it is safer
 class WXDLLEXPORT wxMutexInternal;
 class WXDLLEXPORT wxMutex 
 {
@@ -83,6 +85,71 @@ protected:
   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:
+    bool     m_isOk;
+    wxMutex *m_mutex;
+};
+
+#ifdef __WXMSW__
+
+// ----------------------------------------------------------------------------
+// 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
+class WXDLLEXPORT wxCriticalSectionInternal;
+class WXDLLEXPORT wxCriticalSection
+{
+public:
+    // ctor & dtor
+    wxCriticalSection();
+    ~wxCriticalSection();
+
+    // enter the section (the same as locking a mutex)
+    void Enter();
+    // leave the critical section (same as unlocking a mutex)
+    void Leave();
+
+private:
+    wxCriticalSectionInternal *m_critsect;
+};
+
+// 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:
+    wxCriticalSection& m_critsect;
+};
+
+#endif
+
 // ----------------------------------------------------------------------------
 // Condition handler.
 // ----------------------------------------------------------------------------
@@ -155,15 +222,16 @@ public:
   // Returns true if the thread is suspended
   bool IsPaused() const { return IsAlive() && !IsRunning(); }
 
-  // Returns true if the thread is the main thread (aka the GUI thread).
+  // Returns true if current thread is the main thread (aka the GUI thread)
   static bool IsMain();
 
   // Called when thread exits.
   virtual void OnExit();
 
 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);
 
@@ -181,17 +249,38 @@ private:
 // Automatic initialization
 // ----------------------------------------------------------------------------
 
-class wxThreadModule : public wxModule 
-{
-  DECLARE_DYNAMIC_CLASS(wxThreadModule)
-  
-public:
-  wxThreadModule() {}
+// GUI mutex handling.
+void WXDLLEXPORT wxMutexGuiEnter();
+void WXDLLEXPORT wxMutexGuiLeave();
 
-  virtual bool OnInit();
-  virtual void OnExit();
-};
+// implementation only
+#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
+    void WXDLLEXPORT wxMutexGuiLeaveOrEnter();
+
+    // returns TRUE if the main thread has GUI lock
+    inline bool WXDLLEXPORT wxGuiOwnedByMainThread();
 
+    // wakes up the main thread if it's sleeping inside ::GetMessage()
+    inline void WXDLLEXPORT wxWakeUpMainThread();
+#endif // MSW
 
+#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(); }
+};
 
 #endif // __THREADH__