]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/thread.h
Minor changes.
[wxWidgets.git] / include / wx / thread.h
index cb3f0192361cb9f925196c4746a0694974368a8b..641ce6330b823a4d62b32a45aa3200b043571c12 100644 (file)
 #ifndef __THREADH__
 #define __THREADH__
 
-#ifdef __GNUG__
-    #pragma interface "thread.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 #if wxUSE_THREADS
 
+// only for wxUSE_THREADS - otherwise we'd get undefined symbols
+#ifdef __GNUG__
+    #pragma interface "thread.h"
+#endif
+
 // Windows headers define it
 #ifdef Yield
     #undef Yield
 // constants
 // ----------------------------------------------------------------------------
 
-typedef enum
+enum wxMutexError
 {
   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;
+};
 
-typedef enum
+enum wxThreadError
 {
   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;
+};
 
 // defines the interval of priority
-#define WXTHREAD_MIN_PRIORITY     0u
-#define WXTHREAD_DEFAULT_PRIORITY 50u
-#define WXTHREAD_MAX_PRIORITY     100u
+enum
+{
+    WXTHREAD_MIN_PRIORITY      = 0u,
+    WXTHREAD_DEFAULT_PRIORITY  = 50u,
+    WXTHREAD_MAX_PRIORITY      = 100u
+};
 
 // ----------------------------------------------------------------------------
 // A mutex object is a synchronization object whose state is set to signaled
@@ -129,16 +133,24 @@ private:
 // 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
+// mutexes.
+//
+// NB: wxCriticalSection object does not allocate any memory in its ctor
+//     which makes it possible to have static globals of this class
 // ----------------------------------------------------------------------------
 
-// in order to avoid any overhead under !MSW make all wxCriticalSection class
-// functions inline - but this can't be done under MSW
-#ifdef __WXMSW__
-    class WXDLLEXPORT wxCriticalSectionInternal;
-    #define WXCRITICAL_INLINE
-#else // !MSW
+class WXDLLEXPORT wxCriticalSectionInternal;
+
+// in order to avoid any overhead under platforms where critical sections are
+// just mutexes make all wxCriticalSection class functions inline
+#if !defined(__WXMSW__) && !defined(__WXPM__) && !defined(__WXMAC__)
     #define WXCRITICAL_INLINE   inline
+
+    #define wxCRITSECT_IS_MUTEX 1
+#else // MSW || Mac || OS2
+    #define WXCRITICAL_INLINE
+
+    #define wxCRITSECT_IS_MUTEX 0
 #endif // MSW/!MSW
 
 // you should consider wxCriticalSectionLocker whenever possible instead of
@@ -151,20 +163,27 @@ public:
     WXCRITICAL_INLINE ~wxCriticalSection();
 
     // enter the section (the same as locking a mutex)
-    void WXCRITICAL_INLINE Enter();
+    WXCRITICAL_INLINE void Enter();
     // leave the critical section (same as unlocking a mutex)
-    void WXCRITICAL_INLINE Leave();
+    WXCRITICAL_INLINE void Leave();
 
 private:
     // no assignment operator nor copy ctor
     wxCriticalSection(const wxCriticalSection&);
     wxCriticalSection& operator=(const wxCriticalSection&);
 
-#ifdef __WXMSW__
-    wxCriticalSectionInternal *m_critsect;
-#else // !MSW
+#if wxCRITSECT_IS_MUTEX
     wxMutex m_mutex;
-#endif // MSW/!MSW
+#elif defined(__WXMSW__)
+    // we can't allocate any memory in the ctor, so use placement new -
+    // unfortunately, we have to hardcode the sizeof() here because we can't
+    // include windows.h from this public header
+    char m_buffer[24];
+#elif !defined(__WXPM__)
+    wxCriticalSectionInternal *m_critsect;
+#else
+    // nothing for OS/2
+#endif // !Unix/Unix
 };
 
 // keep your preprocessor name space clean
@@ -175,10 +194,8 @@ private:
 class WXDLLEXPORT wxCriticalSectionLocker
 {
 public:
-    wxCriticalSectionLocker(wxCriticalSection& critsect) : m_critsect(critsect)
-        { m_critsect.Enter(); }
-    ~wxCriticalSectionLocker()
-        { m_critsect.Leave(); }
+    inline wxCriticalSectionLocker(wxCriticalSection& critsect);
+    inline ~wxCriticalSectionLocker();
 
 private:
     // no assignment operator nor copy ctor
@@ -301,7 +318,7 @@ public:
         // Returns true if the thread is running (not paused, not killed).
     bool IsRunning() const;
         // Returns true if the thread is suspended
-    bool IsPaused() const { return IsAlive() && !IsRunning(); }
+    bool IsPaused() const;
 
     // called when the thread exits - in the context of this thread
     //
@@ -312,7 +329,7 @@ protected:
     // Returns TRUE if the thread was asked to terminate: this function should
     // be called by the thread from time to time, otherwise the main thread
     // will be left forever in Delete()!
-    bool TestDestroy() const;
+    bool TestDestroy();
 
     // exits from the current thread - can be called only from this thread
     void Exit(void *exitcode = 0);
@@ -350,12 +367,26 @@ private:
 void WXDLLEXPORT wxMutexGuiEnter();
 void WXDLLEXPORT wxMutexGuiLeave();
 
+// macros for entering/leaving critical sections which may be used without
+// having to take them inside "#if wxUSE_THREADS"
+#define wxENTER_CRIT_SECT(cs)   (cs)->Enter()
+#define wxLEAVE_CRIT_SECT(cs)   (cs)->Leave()
+#define wxCRIT_SECT_LOCKER(name, cs)  wxCriticalSectionLocker name(*cs)
+
 #else // !wxUSE_THREADS
 
+#include "wx/defs.h" // for WXDLLEXPORT
+
 // no thread support
 inline void WXDLLEXPORT wxMutexGuiEnter() { }
 inline void WXDLLEXPORT wxMutexGuiLeave() { }
 
+// macros for entering/leaving critical sections which may be used without
+// having to take them inside "#if wxUSE_THREADS"
+#define wxENTER_CRIT_SECT(cs)
+#define wxLEAVE_CRIT_SECT(cs)
+#define wxCRIT_SECT_LOCKER(name, cs)
+
 #endif // wxUSE_THREADS
 
 // automatically unlock GUI mutex in dtor
@@ -369,8 +400,10 @@ public:
 // -----------------------------------------------------------------------------
 // implementation only until the end of file
 // -----------------------------------------------------------------------------
-#ifdef wxUSE_THREADS
-#ifdef __WXMSW__
+
+#if wxUSE_THREADS
+
+#if defined(__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
@@ -385,7 +418,32 @@ public:
     // return TRUE if the main thread is waiting for some other to terminate:
     // wxApp then should block all "dangerous" messages
     extern bool WXDLLEXPORT wxIsWaitingForThread();
-#else // !MSW
+#elif defined(__WXMAC__)
+    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();
+
+    // return TRUE if the main thread is waiting for some other to terminate:
+    // wxApp then should block all "dangerous" messages
+    extern bool WXDLLEXPORT wxIsWaitingForThread();
+#elif defined(__WXPM__)
+    // 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();
+
+    // return TRUE if the main thread is waiting for some other to terminate:
+    // wxApp then should block all "dangerous" messages
+    extern bool WXDLLEXPORT wxIsWaitingForThread();
+
+#else // !MSW && !PM
     // implement wxCriticalSection using mutexes
     inline wxCriticalSection::wxCriticalSection() { }
     inline wxCriticalSection::~wxCriticalSection() { }
@@ -393,6 +451,14 @@ public:
     inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
     inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
 #endif // MSW/!MSW
+
+    // we can define these inline functions now (they should be defined after
+    // wxCriticalSection::Enter/Leave)
+    inline
+    wxCriticalSectionLocker:: wxCriticalSectionLocker(wxCriticalSection& cs)
+        : m_critsect(cs) { m_critsect.Enter(); }
+    inline
+    wxCriticalSectionLocker::~wxCriticalSectionLocker() { m_critsect.Leave(); }
 #endif // wxUSE_THREADS
 
 #endif // __THREADH__