document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/thread.h b/include/wx/thread.h
index 49e7b0a582abd0bb7842fd59b09f928d5072ed2a..999d4f91665f3dd1f7093d04b63c3686df3c78a5 100644 (file)
--- a/include/wx/thread.h
+++ b/include/wx/thread.h
@@ -22,18 +22,6 @@
 
 #if wxUSE_THREADS
 
 
 #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
-#endif
-
-#include "wx/module.h"
-

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -45,6 +33,7 @@ enum wxMutexError
     wxMUTEX_DEAD_LOCK,      // mutex is already locked by the calling thread
     wxMUTEX_BUSY,           // mutex is already locked by another thread
     wxMUTEX_UNLOCKED,       // attempt to unlock a mutex which is not locked
     wxMUTEX_DEAD_LOCK,      // mutex is already locked by the calling thread
     wxMUTEX_BUSY,           // mutex is already locked by another thread
     wxMUTEX_UNLOCKED,       // attempt to unlock a mutex which is not locked

+    wxMUTEX_TIMEOUT,        // LockTimeout() has timed out

     wxMUTEX_MISC_ERROR      // any other error
 };
 
     wxMUTEX_MISC_ERROR      // any other error
 };
 


@@ -116,10 +105,11 @@ enum wxMutexType
 };
 
 // forward declarations
 };
 
 // forward declarations

-class WXDLLEXPORT wxConditionInternal;
-class WXDLLEXPORT wxMutexInternal;
-class WXDLLEXPORT wxSemaphoreInternal;
-class WXDLLEXPORT wxThreadInternal;
+class WXDLLIMPEXP_FWD_BASE wxThreadHelper;
+class WXDLLIMPEXP_FWD_BASE wxConditionInternal;
+class WXDLLIMPEXP_FWD_BASE wxMutexInternal;
+class WXDLLIMPEXP_FWD_BASE wxSemaphoreInternal;
+class WXDLLIMPEXP_FWD_BASE wxThreadInternal;

 
 // ----------------------------------------------------------------------------
 // A mutex object is a synchronization object whose state is set to signaled
 
 // ----------------------------------------------------------------------------
 // A mutex object is a synchronization object whose state is set to signaled


@@ -130,7 +120,7 @@ class WXDLLEXPORT wxThreadInternal;
 
 // you should consider wxMutexLocker whenever possible instead of directly
 // working with wxMutex class - it is safer
 
 // you should consider wxMutexLocker whenever possible instead of directly
 // working with wxMutex class - it is safer

-class WXDLLEXPORT wxMutex
+class WXDLLIMPEXP_BASE wxMutex

 {
 public:
     // constructor & destructor
 {
 public:
     // constructor & destructor


@@ -155,6 +145,10 @@ public:
     // The caller must call Unlock() later if Lock() returned wxMUTEX_NO_ERROR.
     wxMutexError Lock();
 
     // The caller must call Unlock() later if Lock() returned wxMUTEX_NO_ERROR.
     wxMutexError Lock();
 

+    // Same as Lock() but return wxMUTEX_TIMEOUT if the mutex can't be locked
+    // during the given number of milliseconds
+    wxMutexError LockTimeout(unsigned long ms);
+

     // Try to lock the mutex: if it is currently locked, return immediately
     // with an error. Otherwise the caller must call Unlock().
     wxMutexError TryLock();
     // Try to lock the mutex: if it is currently locked, return immediately
     // with an error. Otherwise the caller must call Unlock().
     wxMutexError TryLock();


@@ -173,15 +167,15 @@ protected:
 // 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
 // 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
+class WXDLLIMPEXP_BASE wxMutexLocker

 {
 public:
     // lock the mutex in the ctor
     wxMutexLocker(wxMutex& mutex)
 {
 public:
     // lock the mutex in the ctor
     wxMutexLocker(wxMutex& mutex)

-        : m_isOk(FALSE), m_mutex(mutex)
+        : m_isOk(false), m_mutex(mutex)

         { m_isOk = ( m_mutex.Lock() == wxMUTEX_NO_ERROR ); }
 
         { m_isOk = ( m_mutex.Lock() == wxMUTEX_NO_ERROR ); }
 

-    // returns TRUE if mutex was successfully locked in ctor
+    // returns true if mutex was successfully locked in ctor

     bool IsOk() const
         { return m_isOk; }
 
     bool IsOk() const
         { return m_isOk; }
 


@@ -210,26 +204,38 @@ private:
 
 // in order to avoid any overhead under platforms where critical sections are
 // just mutexes make all wxCriticalSection class functions inline
 
 // 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__)
+#if !defined(__WXMSW__)

     #define wxCRITSECT_IS_MUTEX 1
     #define wxCRITSECT_IS_MUTEX 1

-#else // MSW || OS2
+
+    #define wxCRITSECT_INLINE WXEXPORT inline
+#else // MSW

     #define wxCRITSECT_IS_MUTEX 0
     #define wxCRITSECT_IS_MUTEX 0

+
+    #define wxCRITSECT_INLINE

 #endif // MSW/!MSW
 
 #endif // MSW/!MSW
 

+enum wxCriticalSectionType
+{
+    // recursive critical section
+    wxCRITSEC_DEFAULT,
+
+    // non-recursive critical section
+    wxCRITSEC_NON_RECURSIVE
+};
+

 // you should consider wxCriticalSectionLocker whenever possible instead of
 // directly working with wxCriticalSection class - it is safer
 // you should consider wxCriticalSectionLocker whenever possible instead of
 // directly working with wxCriticalSection class - it is safer

-class WXDLLEXPORT wxCriticalSection
+class WXDLLIMPEXP_BASE wxCriticalSection

 {
 public:
     // ctor & dtor
 {
 public:
     // ctor & dtor

-    wxCriticalSection();
-    ~wxCriticalSection();
-
+    wxCRITSECT_INLINE wxCriticalSection( wxCriticalSectionType critSecType = wxCRITSEC_DEFAULT );
+    wxCRITSECT_INLINE ~wxCriticalSection();

     // enter the section (the same as locking a mutex)
     // enter the section (the same as locking a mutex)

-    void Enter();
+    wxCRITSECT_INLINE void Enter();

 
     // leave the critical section (same as unlocking a mutex)
 
     // leave the critical section (same as unlocking a mutex)

-    void Leave();
+    wxCRITSECT_INLINE void Leave();

 
 private:
 #if wxCRITSECT_IS_MUTEX
 
 private:
 #if wxCRITSECT_IS_MUTEX


@@ -237,30 +243,48 @@ private:
 #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
 #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
+    // include windows.h from this public header and we also have to use the
+    // union to force the correct (i.e. maximal) alignment

     //
     // if CRITICAL_SECTION size changes in Windows, you'll get an assert from
     // thread.cpp and will need to increase the buffer size
     //
     // if CRITICAL_SECTION size changes in Windows, you'll get an assert from
     // thread.cpp and will need to increase the buffer size

-    char m_buffer[24];
-#else
-    // nothing for OS/2
-#endif // Unix/Win32/OS2
+    //
+    // finally, we need this typedef instead of declaring m_buffer directly
+    // because otherwise the assert mentioned above wouldn't compile with some
+    // compilers (notably CodeWarrior 8)
+#ifdef __WIN64__
+    typedef char wxCritSectBuffer[40];
+#else // __WIN32__
+    typedef char wxCritSectBuffer[24];
+#endif
+    union
+    {
+        unsigned long m_dummy1;
+        void *m_dummy2;
+
+        wxCritSectBuffer m_buffer;
+    };
+#endif // Unix&OS2/Win32

 
     DECLARE_NO_COPY_CLASS(wxCriticalSection)
 };
 
 #if wxCRITSECT_IS_MUTEX
     // implement wxCriticalSection using mutexes
 
     DECLARE_NO_COPY_CLASS(wxCriticalSection)
 };
 
 #if wxCRITSECT_IS_MUTEX
     // implement wxCriticalSection using mutexes

-    wxCriticalSection::wxCriticalSection() { }
-    wxCriticalSection::~wxCriticalSection() { }
+    inline wxCriticalSection::wxCriticalSection( wxCriticalSectionType critSecType )
+       : m_mutex( critSecType == wxCRITSEC_DEFAULT ? wxMUTEX_RECURSIVE : wxMUTEX_DEFAULT )  { }
+    inline wxCriticalSection::~wxCriticalSection() { }

 
 

-    void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
-    void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
+    inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
+    inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }

 #endif // wxCRITSECT_IS_MUTEX
 
 #endif // wxCRITSECT_IS_MUTEX
 

+#undef wxCRITSECT_INLINE
+#undef wxCRITSECT_IS_MUTEX
+

 // wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
 // wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is

-// to th mutexes
-class WXDLLEXPORT wxCriticalSectionLocker
+// to mutexes
+class WXDLLIMPEXP_BASE wxCriticalSectionLocker

 {
 public:
     wxCriticalSectionLocker(wxCriticalSection& cs)
 {
 public:
     wxCriticalSectionLocker(wxCriticalSection& cs)


@@ -285,7 +309,7 @@ private:
 // thread(s) to wait until some condition is fulfilled
 // ----------------------------------------------------------------------------
 
 // thread(s) to wait until some condition is fulfilled
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCondition
+class WXDLLIMPEXP_BASE wxCondition

 {
 public:
     // Each wxCondition object is associated with a (single) wxMutex object.
 {
 public:
     // Each wxCondition object is associated with a (single) wxMutex object.


@@ -295,11 +319,11 @@ public:
     // dtor is not virtual, don't use this class polymorphically
     ~wxCondition();
 
     // dtor is not virtual, don't use this class polymorphically
     ~wxCondition();
 

-    // return TRUE if the condition has been created successfully
+    // return true if the condition has been created successfully

     bool IsOk() const;
 
     // NB: the associated mutex MUST be locked beforehand by the calling thread
     bool IsOk() const;
 
     // NB: the associated mutex MUST be locked beforehand by the calling thread

-    // 
+    //

     // it atomically releases the lock on the associated mutex
     // and starts waiting to be woken up by a Signal()/Broadcast()
     // once its signaled, then it will wait until it can reacquire
     // it atomically releases the lock on the associated mutex
     // and starts waiting to be woken up by a Signal()/Broadcast()
     // once its signaled, then it will wait until it can reacquire


@@ -307,19 +331,19 @@ public:
     wxCondError Wait();
 
     // exactly as Wait() except that it may also return if the specified
     wxCondError Wait();
 
     // exactly as Wait() except that it may also return if the specified

-    // timeout ellapses even if the condition hasn't been signalled: in this
-    // case, the return value is FALSE, otherwise (i.e. in case of a normal
-    // return) it is TRUE
-    // 
-    // the timeeout parameter specifies a interval that needs to be waited in
-    // milliseconds
+    // timeout elapses even if the condition hasn't been signalled: in this
+    // case, the return value is false, otherwise (i.e. in case of a normal
+    // return) it is true
+    //
+    // the timeout parameter specifies an interval that needs to be waited for
+    // in milliseconds

     wxCondError WaitTimeout(unsigned long milliseconds);
 
     // NB: the associated mutex may or may not be locked by the calling thread
     //
     // this method unblocks one thread if any are blocking on the condition.
     // if no thread is blocking in Wait(), then the signal is NOT remembered
     wxCondError WaitTimeout(unsigned long milliseconds);
 
     // NB: the associated mutex may or may not be locked by the calling thread
     //
     // this method unblocks one thread if any are blocking on the condition.
     // if no thread is blocking in Wait(), then the signal is NOT remembered

-    // The thread which was blocking on Wait(), will then reacquire the lock
+    // The thread which was blocking on Wait() will then reacquire the lock

     // on the associated mutex object before returning
     wxCondError Signal();
 
     // on the associated mutex object before returning
     wxCondError Signal();
 


@@ -327,14 +351,15 @@ public:
     //
     // this method unblocks all threads if any are blocking on the condition.
     // if no thread is blocking in Wait(), then the signal is NOT remembered
     //
     // this method unblocks all threads if any are blocking on the condition.
     // if no thread is blocking in Wait(), then the signal is NOT remembered

-    // The threads which were blocking on Wait(), will then reacquire the lock
+    // The threads which were blocking on Wait() will then reacquire the lock

     // on the associated mutex object before returning.
     wxCondError Broadcast();
 
 
     // on the associated mutex object before returning.
     wxCondError Broadcast();
 
 

+#if WXWIN_COMPATIBILITY_2_6

     // deprecated version, don't use
     // deprecated version, don't use

-    bool Wait(unsigned long milliseconds)
-        { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; }
+    wxDEPRECATED( bool Wait(unsigned long milliseconds) );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 private:
     wxConditionInternal *m_internal;
 
 private:
     wxConditionInternal *m_internal;


@@ -342,12 +367,17 @@ private:
     DECLARE_NO_COPY_CLASS(wxCondition)
 };
 
     DECLARE_NO_COPY_CLASS(wxCondition)
 };
 

+#if WXWIN_COMPATIBILITY_2_6
+    inline bool wxCondition::Wait(unsigned long milliseconds)
+        { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; }
+#endif // WXWIN_COMPATIBILITY_2_6
+

 // ----------------------------------------------------------------------------
 // wxSemaphore: a counter limiting the number of threads concurrently accessing
 //              a shared resource
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxSemaphore: a counter limiting the number of threads concurrently accessing
 //              a shared resource
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxSemaphore
+class WXDLLIMPEXP_BASE wxSemaphore

 {
 public:
     // specifying a maxcount of 0 actually makes wxSemaphore behave as if there
 {
 public:
     // specifying a maxcount of 0 actually makes wxSemaphore behave as if there


@@ -357,7 +387,7 @@ public:
     // dtor is not virtual, don't use this class polymorphically
     ~wxSemaphore();
 
     // dtor is not virtual, don't use this class polymorphically
     ~wxSemaphore();
 

-    // return TRUE if the semaphore has been created successfully
+    // return true if the semaphore has been created successfully

     bool IsOk() const;
 
     // wait indefinitely, until the semaphore count goes beyond 0
     bool IsOk() const;
 
     // wait indefinitely, until the semaphore count goes beyond 0


@@ -370,7 +400,7 @@ public:
     wxSemaError TryWait();
 
     // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the
     wxSemaError TryWait();
 
     // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the

-    // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has ellapsed
+    // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has elapsed

     wxSemaError WaitTimeout(unsigned long milliseconds);
 
     // increments the semaphore count and signals one of the waiting threads
     wxSemaError WaitTimeout(unsigned long milliseconds);
 
     // increments the semaphore count and signals one of the waiting threads


@@ -383,7 +413,7 @@ private:
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// wxThread: class encpasulating a thread of execution
+// wxThread: class encapsulating a thread of execution

 // ----------------------------------------------------------------------------
 
 // there are two different kinds of threads: joinable and detached (default)
 // ----------------------------------------------------------------------------
 
 // there are two different kinds of threads: joinable and detached (default)


@@ -402,7 +432,7 @@ private:
    typedef unsigned long wxThreadIdType;
 #endif
 
    typedef unsigned long wxThreadIdType;
 #endif
 

-class WXDLLEXPORT wxThread
+class WXDLLIMPEXP_BASE wxThread

 {
 public:
     // the return type for the thread function
 {
 public:
     // the return type for the thread function


@@ -419,12 +449,12 @@ public:
         // Returns true if current thread is the main thread.
     static bool IsMain();
 
         // Returns true if current thread is the main thread.
     static bool IsMain();
 

-        // Release the rest of our time slice leting the other threads run
+        // Release the rest of our time slice letting the other threads run

     static void Yield();
 
         // Sleep during the specified period of time in milliseconds
         //
     static void Yield();
 
         // Sleep during the specified period of time in milliseconds
         //

-        // NB: at least under MSW worker threads can not call ::wxSleep()!
+        // This is the same as wxMilliSleep().

     static void Sleep(unsigned long milliseconds);
 
         // get the number of system CPUs - useful with SetConcurrency()
     static void Sleep(unsigned long milliseconds);
 
         // get the number of system CPUs - useful with SetConcurrency()


@@ -443,7 +473,7 @@ public:
         // default value (usually acceptable, but may not yield the best
         // performance for this process)
         //
         // default value (usually acceptable, but may not yield the best
         // performance for this process)
         //

-        // Returns TRUE on success, FALSE otherwise (if not implemented, for
+        // Returns true on success, false otherwise (if not implemented, for

         // example)
     static bool SetConcurrency(size_t level);
 
         // example)
     static bool SetConcurrency(size_t level);
 


@@ -476,7 +506,7 @@ public:
         // does it!
         //
         // will fill the rc pointer with the thread exit code if it's !NULL
         // does it!
         //
         // will fill the rc pointer with the thread exit code if it's !NULL

-    wxThreadError Delete(ExitCode *rc = (ExitCode *)NULL);
+    wxThreadError Delete(ExitCode *rc = NULL);

 
         // waits for a joinable thread to finish and returns its exit code
         //
 
         // waits for a joinable thread to finish and returns its exit code
         //


@@ -485,9 +515,9 @@ public:
     ExitCode Wait();
 
         // kills the thread without giving it any chance to clean up - should
     ExitCode Wait();
 
         // kills the thread without giving it any chance to clean up - should

-        // not be used in normal circumstances, use Delete() instead. It is a
-        // dangerous function that should only be used in the most extreme
-        // cases!
+        // not be used under normal circumstances, use Delete() instead.
+        // It is a dangerous function that should only be used in the most
+        // extreme cases!

         //
         // The wxThread object is deleted by Kill() if the thread is
         // detachable, but you still have to delete it manually for joinable
         //
         // The wxThread object is deleted by Kill() if the thread is
         // detachable, but you still have to delete it manually for joinable


@@ -525,21 +555,19 @@ public:
     // identifies a thread inside a process
     wxThreadIdType GetId() const;
 
     // identifies a thread inside a process
     wxThreadIdType GetId() const;
 

-    // called when the thread exits - in the context of this thread
-    //
-    // NB: this function will not be called if the thread is Kill()ed
-    virtual void OnExit() { }
+    wxThreadKind GetKind() const
+        { return m_isDetached ? wxTHREAD_DETACHED : wxTHREAD_JOINABLE; }
+
+    // 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()!
+    virtual bool TestDestroy();

 
     // dtor is public, but the detached threads should never be deleted - use
     // Delete() instead (or leave the thread terminate by itself)
     virtual ~wxThread();
 
 protected:
 
     // dtor is public, but the detached threads should never be deleted - use
     // Delete() instead (or leave the thread terminate by itself)
     virtual ~wxThread();
 
 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();
-

     // exits from the current thread - can be called only from this thread
     void Exit(ExitCode exitcode = 0);
 
     // exits from the current thread - can be called only from this thread
     void Exit(ExitCode exitcode = 0);
 


@@ -552,6 +580,11 @@ private:
     wxThread(const wxThread&);
     wxThread& operator=(const wxThread&);
 
     wxThread(const wxThread&);
     wxThread& operator=(const wxThread&);
 

+    // called when the thread exits - in the context of this thread
+    //
+    // NB: this function will not be called if the thread is Kill()ed
+    virtual void OnExit() { }
+

     friend class wxThreadInternal;
 
     // the (platform-dependent) thread class implementation
     friend class wxThreadInternal;
 
     // the (platform-dependent) thread class implementation


@@ -564,33 +597,165 @@ private:
     bool m_isDetached;
 };
 
     bool m_isDetached;
 };
 

+// wxThreadHelperThread class
+// --------------------------
+
+class WXDLLIMPEXP_BASE wxThreadHelperThread : public wxThread
+{
+public:
+    // constructor only creates the C++ thread object and doesn't create (or
+    // start) the real thread
+    wxThreadHelperThread(wxThreadHelper& owner, wxThreadKind kind)
+        : wxThread(kind), m_owner(owner)
+        { }
+
+protected:
+    // entry point for the thread -- calls Entry() in owner.
+    virtual void *Entry();
+
+private:
+    // the owner of the thread
+    wxThreadHelper& m_owner;
+
+    // no copy ctor/assignment operator
+    wxThreadHelperThread(const wxThreadHelperThread&);
+    wxThreadHelperThread& operator=(const wxThreadHelperThread&);
+};
+
+// ----------------------------------------------------------------------------
+// wxThreadHelper: this class implements the threading logic to run a
+// background task in another object (such as a window).  It is a mix-in: just
+// derive from it to implement a threading background task in your class.
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxThreadHelper
+{
+private:
+    void KillThread()
+    {
+        // If wxThreadHelperThread is detached and is about to finish, it will
+        // set m_thread to NULL so don't delete it then.
+        // But if KillThread is called before wxThreadHelperThread (in detached mode)
+        // sets it to NULL, then the thread object still exists and can be killed
+        wxCriticalSectionLocker locker(m_critSection);
+
+        if ( m_thread )
+        {
+            m_thread->Kill();
+
+            if ( m_kind == wxTHREAD_JOINABLE )
+              delete m_thread;
+
+            m_thread = NULL;
+        }
+    }
+
+public:
+    // constructor only initializes m_thread to NULL
+    wxThreadHelper(wxThreadKind kind = wxTHREAD_JOINABLE)
+        : m_thread(NULL), m_kind(kind) { }
+
+    // destructor deletes m_thread
+    virtual ~wxThreadHelper() { KillThread(); }
+
+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED( wxThreadError Create(unsigned int stackSize = 0) );
+#endif
+
+    // create a new thread (and optionally set the stack size on platforms that
+    // support/need that), call Run() to start it
+    wxThreadError CreateThread(wxThreadKind kind = wxTHREAD_JOINABLE,
+                               unsigned int stackSize = 0)
+    {
+        KillThread();
+
+        m_kind = kind;
+        m_thread = new wxThreadHelperThread(*this, m_kind);
+
+        return m_thread->Create(stackSize);
+    }
+
+    // entry point for the thread - called by Run() and executes in the context
+    // of this thread.
+    virtual void *Entry() = 0;
+
+    // returns a pointer to the thread which can be used to call Run()
+    wxThread *GetThread() const
+    {
+        wxCriticalSectionLocker locker((wxCriticalSection&)m_critSection);
+
+        wxThread* thread = m_thread;
+
+        return thread;
+    }
+
+protected:
+    wxThread *m_thread;
+    wxThreadKind m_kind;
+    wxCriticalSection m_critSection; // To guard the m_thread variable
+
+    friend class wxThreadHelperThread;
+};
+
+#if WXWIN_COMPATIBILITY_2_8
+inline wxThreadError wxThreadHelper::Create(unsigned int stackSize)
+{ return CreateThread(m_kind, stackSize); }
+#endif
+
+// call Entry() in owner, put it down here to avoid circular declarations
+inline void *wxThreadHelperThread::Entry()
+{
+    void * const result = m_owner.Entry();
+
+    wxCriticalSectionLocker locker(m_owner.m_critSection);
+
+    // Detached thread will be deleted after returning, so make sure
+    // wxThreadHelper::GetThread will not return an invalid pointer.
+    // And that wxThreadHelper::KillThread will not try to kill
+    // an already deleted thread
+    if ( m_owner.m_kind == wxTHREAD_DETACHED )
+        m_owner.m_thread = NULL;
+
+    return result;
+}
+

 // ----------------------------------------------------------------------------
 // Automatic initialization
 // ----------------------------------------------------------------------------
 
 // GUI mutex handling.
 // ----------------------------------------------------------------------------
 // Automatic initialization
 // ----------------------------------------------------------------------------
 
 // GUI mutex handling.

-void WXDLLEXPORT wxMutexGuiEnter();
-void WXDLLEXPORT wxMutexGuiLeave();
+void WXDLLIMPEXP_BASE wxMutexGuiEnter();
+void WXDLLIMPEXP_BASE 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_DECLARE(cs) static wxCriticalSection cs
 
 // 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_DECLARE(cs) static wxCriticalSection cs

+#define wxCRIT_SECT_DECLARE_MEMBER(cs) wxCriticalSection cs

 #define wxCRIT_SECT_LOCKER(name, cs)  wxCriticalSectionLocker name(cs)
 
 #define wxCRIT_SECT_LOCKER(name, cs)  wxCriticalSectionLocker name(cs)
 

+// function for checking if we're in the main thread which may be used whether
+// wxUSE_THREADS is 0 or 1
+inline bool wxIsMainThread() { return wxThread::IsMain(); }
+

 #else // !wxUSE_THREADS
 
 // no thread support
 #else // !wxUSE_THREADS
 
 // no thread support

-inline void WXDLLEXPORT wxMutexGuiEnter() { }
-inline void WXDLLEXPORT wxMutexGuiLeave() { }
+inline void wxMutexGuiEnter() { }
+inline void wxMutexGuiLeave() { }

 
 // macros for entering/leaving critical sections which may be used without
 // having to take them inside "#if wxUSE_THREADS"
 
 // 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_DECLARE(cs)
-#define wxCRIT_SECT_LOCKER(name, cs)
+// (the implementation uses dummy structs to force semicolon after the macro)
+#define wxENTER_CRIT_SECT(cs)            do {} while (0)
+#define wxLEAVE_CRIT_SECT(cs)            do {} while (0)
+#define wxCRIT_SECT_DECLARE(cs)          struct wxDummyCS##cs
+#define wxCRIT_SECT_DECLARE_MEMBER(cs)   struct wxDummyCSMember##cs
+#define wxCRIT_SECT_LOCKER(name, cs)     struct wxDummyCSLocker##name
+
+// if there is only one thread, it is always the main one
+inline bool wxIsMainThread() { return true; }

 
 #endif // wxUSE_THREADS/!wxUSE_THREADS
 
 
 #endif // wxUSE_THREADS/!wxUSE_THREADS
 


@@ -616,7 +781,7 @@ inline void WXDLLEXPORT wxMutexGuiLeave() { }
     wxCRIT_SECT_LOCKER(cs##name##Locker, s_cs##name)
 
 // automatically lock GUI mutex in ctor and unlock it in dtor
     wxCRIT_SECT_LOCKER(cs##name##Locker, s_cs##name)
 
 // automatically lock GUI mutex in ctor and unlock it in dtor

-class WXDLLEXPORT wxMutexGuiLocker
+class WXDLLIMPEXP_BASE wxMutexGuiLocker

 {
 public:
     wxMutexGuiLocker() { wxMutexGuiEnter(); }
 {
 public:
     wxMutexGuiLocker() { wxMutexGuiEnter(); }


@@ -629,26 +794,23 @@ public:
 
 #if wxUSE_THREADS
 
 
 #if wxUSE_THREADS
 

-#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXPM__)
+#if defined(__WXMSW__) || defined(__OS2__) || defined(__EMX__)

     // 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
     // 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();
+    extern void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter();

 
 

-    // returns TRUE if the main thread has GUI lock
-    extern bool WXDLLEXPORT wxGuiOwnedByMainThread();
+    // returns true if the main thread has GUI lock
+    extern bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread();

 
 

-#ifndef __WXPM__

     // wakes up the main thread if it's sleeping inside ::GetMessage()
     // wakes up the main thread if it's sleeping inside ::GetMessage()

-    extern void WXDLLEXPORT wxWakeUpMainThread();
-#endif // !OS/2
+    extern void WXDLLIMPEXP_BASE wxWakeUpMainThread();

 
 

-    // return TRUE if the main thread is waiting for some other to terminate:
+    // return true if the main thread is waiting for some other to terminate:

     // wxApp then should block all "dangerous" messages
     // wxApp then should block all "dangerous" messages

-    extern bool WXDLLEXPORT wxIsWaitingForThread();
-#endif // MSW, Mac, OS/2
+    extern bool WXDLLIMPEXP_BASE wxIsWaitingForThread();
+#endif // MSW, OS/2

 
 #endif // wxUSE_THREADS
 
 #endif // _WX_THREAD_H_
 
 #endif // wxUSE_THREADS
 
 #endif // _WX_THREAD_H_

-