#pragma interface "thread.h"
#endif
-#include "wx/object.h"
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
#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;
-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
+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;
-// 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_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
-class wxMutexInternal;
-class WXDLLEXPORT wxMutex {
+// you should consider wxMutexLocker whenever possible instead of directly
+// working with wxMutex class - it is safer
+class WXDLLEXPORT wxMutexInternal;
+class WXDLLEXPORT wxMutex
+{
public:
// constructor & destructor
wxMutex();
// Returns true if the mutex is locked.
bool IsLocked() const { return (m_locked > 0); }
+
protected:
friend class wxCondition;
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;
+};
+
+// ----------------------------------------------------------------------------
+// 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)->Enter(); }
+ ~wxCriticalSectionLocker()
+ { m_critsect->Leave(); }
+
+private:
+ wxCriticalSection *m_critsect;
+};
+
+// ----------------------------------------------------------------------------
// Condition handler.
+// ----------------------------------------------------------------------------
+
class wxConditionInternal;
-class WXDLLEXPORT wxCondition {
+class WXDLLEXPORT wxCondition
+{
public:
// constructor & destructor
wxCondition();
void Signal();
// Broadcasts to all "Waiters".
void Broadcast();
+
private:
wxConditionInternal *p_internal;
};
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
// Thread management class
+// ----------------------------------------------------------------------------
+
class wxThreadInternal;
-class WXDLLEXPORT wxThread {
+class WXDLLEXPORT wxThread
+{
public:
// constructor & destructor.
wxThread();
// Destroys the thread immediately if the defer flag isn't true.
wxThreadError Destroy();
+ // Pause a running thread
+ wxThreadError Pause();
+
+ // Resume a paused thread
+ wxThreadError Resume();
+
// Switches on the defer flag.
void DeferDestroy(bool on);
// Returns true if the thread is alive.
bool IsAlive() const;
- // Returns true if the thread is the main thread (aka the GUI thread).
+ // 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(); }
+
+ // 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);
+
private:
// Entry point for the thread.
virtual void *Entry() = 0;
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
+
+#endif // __THREADH__
projects / wxWidgets.git / blobdiff