]> git.saurik.com Git - wxWidgets.git/blame - include/wx/thread.h
Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl
[wxWidgets.git] / include / wx / thread.h
CommitLineData
10b959e3 1/////////////////////////////////////////////////////////////////////////////
9e84b847 2// Name: wx/thread.h
10b959e3
JS
3// Purpose: Thread API
4// Author: Guilhem Lavaux
bf1852e1
VZ
5// Modified by: Vadim Zeitlin (modifications partly inspired by omnithreads
6// package from Olivetti & Oracle Research Laboratory)
10b959e3
JS
7// Created: 04/13/98
8// RCS-ID: $Id$
9// Copyright: (c) Guilhem Lavaux
10// Licence: wxWindows licence
11/////////////////////////////////////////////////////////////////////////////
12
9e84b847
VZ
13#ifndef _WX_THREAD_H_
14#define _WX_THREAD_H_
10b959e3 15
9d133d87
VZ
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
bf1852e1
VZ
19
20// get the value of wxUSE_THREADS configuration flag
9e84b847 21#include "wx/defs.h"
9d133d87
VZ
22
23#if wxUSE_THREADS
6d167489
VZ
24
25// only for wxUSE_THREADS - otherwise we'd get undefined symbols
12028905 26#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
80cb83be
KB
27 #pragma interface "thread.h"
28#endif
bf1852e1
VZ
29
30// Windows headers define it
31#ifdef Yield
32 #undef Yield
33#endif
34
a6b0bd49
VZ
35// ----------------------------------------------------------------------------
36// constants
37// ----------------------------------------------------------------------------
38
6d167489 39enum wxMutexError
d524867f 40{
9e84b847
VZ
41 wxMUTEX_NO_ERROR = 0, // operation completed successfully
42 wxMUTEX_INVALID, // mutex hasn't been initialized
43 wxMUTEX_DEAD_LOCK, // mutex is already locked by the calling thread
44 wxMUTEX_BUSY, // mutex is already locked by another thread
45 wxMUTEX_UNLOCKED, // attempt to unlock a mutex which is not locked
46 wxMUTEX_MISC_ERROR // any other error
47};
48
49enum wxCondError
50{
51 wxCOND_NO_ERROR = 0,
52 wxCOND_INVALID,
53 wxCOND_TIMEOUT, // WaitTimeout() has timed out
54 wxCOND_MISC_ERROR
55};
56
57enum wxSemaError
58{
59 wxSEMA_NO_ERROR = 0,
60 wxSEMA_INVALID, // semaphore hasn't been initialized successfully
61 wxSEMA_BUSY, // returned by TryWait() if Wait() would block
62 wxSEMA_TIMEOUT, // returned by WaitTimeout()
63 wxSEMA_OVERFLOW, // Post() would increase counter past the max
64 wxSEMA_MISC_ERROR
6d167489 65};
10b959e3 66
6d167489 67enum wxThreadError
d524867f 68{
9fc3ad34
VZ
69 wxTHREAD_NO_ERROR = 0, // No error
70 wxTHREAD_NO_RESOURCE, // No resource left to create a new thread
71 wxTHREAD_RUNNING, // The thread is already running
72 wxTHREAD_NOT_RUNNING, // The thread isn't running
73 wxTHREAD_KILLED, // Thread we waited for had to be killed
74 wxTHREAD_MISC_ERROR // Some other error
6d167489 75};
10b959e3 76
b568d04f
VZ
77enum wxThreadKind
78{
79 wxTHREAD_DETACHED,
80 wxTHREAD_JOINABLE
81};
82
bf1852e1 83// defines the interval of priority
6d167489
VZ
84enum
85{
86 WXTHREAD_MIN_PRIORITY = 0u,
87 WXTHREAD_DEFAULT_PRIORITY = 50u,
88 WXTHREAD_MAX_PRIORITY = 100u
89};
10b959e3 90
9e84b847
VZ
91// There are 2 types of mutexes: normal mutexes and recursive ones. The attempt
92// to lock a normal mutex by a thread which already owns it results in
93// undefined behaviour (it always works under Windows, it will almost always
94// result in a deadlock under Unix). Locking a recursive mutex in such
95// situation always succeeds and it must be unlocked as many times as it has
96// been locked.
97//
98// However recursive mutexes have several important drawbacks: first, in the
99// POSIX implementation, they're less efficient. Second, and more importantly,
100// they CAN NOT BE USED WITH CONDITION VARIABLES under Unix! Using them with
101// wxCondition will work under Windows and some Unices (notably Linux) but will
102// deadlock under other Unix versions (e.g. Solaris). As it might be difficult
103// to ensure that a recursive mutex is not used with wxCondition, it is a good
104// idea to avoid using recursive mutexes at all. Also, the last problem with
105// them is that some (older) Unix versions don't support this at all -- which
106// results in a configure warning when building and a deadlock when using them.
107enum wxMutexType
108{
109 // normal mutex: try to always use this one
110 wxMUTEX_DEFAULT,
111
112 // recursive mutex: don't use these ones with wxCondition
113 wxMUTEX_RECURSIVE
114};
115
116// forward declarations
78ee6a47 117class WXDLLIMPEXP_BASE wxThreadHelper;
bb24c68f
VS
118class WXDLLIMPEXP_BASE wxConditionInternal;
119class WXDLLIMPEXP_BASE wxMutexInternal;
120class WXDLLIMPEXP_BASE wxSemaphoreInternal;
121class WXDLLIMPEXP_BASE wxThreadInternal;
9e84b847 122
d524867f 123// ----------------------------------------------------------------------------
9d133d87
VZ
124// A mutex object is a synchronization object whose state is set to signaled
125// when it is not owned by any thread, and nonsignaled when it is owned. Its
126// name comes from its usefulness in coordinating mutually-exclusive access to
127// a shared resource. Only one thread at a time can own a mutex object.
a6b0bd49 128// ----------------------------------------------------------------------------
d524867f 129
9d133d87
VZ
130// you should consider wxMutexLocker whenever possible instead of directly
131// working with wxMutex class - it is safer
bb24c68f 132class WXDLLIMPEXP_BASE wxMutex
d524867f 133{
10b959e3 134public:
bf1852e1 135 // constructor & destructor
9e84b847
VZ
136 // ------------------------
137
138 // create either default (always safe) or recursive mutex
139 wxMutex(wxMutexType mutexType = wxMUTEX_DEFAULT);
140
141 // destroys the mutex kernel object
cb4f1ca4 142 ~wxMutex();
10b959e3 143
9e84b847
VZ
144 // test if the mutex has been created successfully
145 bool IsOk() const;
146
147 // mutex operations
148 // ----------------
149
150 // Lock the mutex, blocking on it until it is unlocked by the other thread.
151 // The result of locking a mutex already locked by the current thread
152 // depend on the mutex type.
153 //
154 // The caller must call Unlock() later if Lock() returned wxMUTEX_NO_ERROR.
cb4f1ca4 155 wxMutexError Lock();
9e84b847
VZ
156
157 // Try to lock the mutex: if it is currently locked, return immediately
158 // with an error. Otherwise the caller must call Unlock().
cb4f1ca4 159 wxMutexError TryLock();
10b959e3 160
9e84b847
VZ
161 // Unlock the mutex. It is an error to unlock an already unlocked mutex
162 wxMutexError Unlock();
a6b0bd49 163
10b959e3 164protected:
9fc3ad34 165 wxMutexInternal *m_internal;
be809868
VZ
166
167 friend class wxConditionInternal;
9e84b847
VZ
168
169 DECLARE_NO_COPY_CLASS(wxMutex)
10b959e3
JS
170};
171
9d133d87
VZ
172// a helper class which locks the mutex in the ctor and unlocks it in the dtor:
173// this ensures that mutex is always unlocked, even if the function returns or
174// throws an exception before it reaches the end
bb24c68f 175class WXDLLIMPEXP_BASE wxMutexLocker
9d133d87
VZ
176{
177public:
178 // lock the mutex in the ctor
be52b341
GD
179 wxMutexLocker(wxMutex& mutex)
180 : m_isOk(FALSE), m_mutex(mutex)
181 { m_isOk = ( m_mutex.Lock() == wxMUTEX_NO_ERROR ); }
9d133d87
VZ
182
183 // returns TRUE if mutex was successfully locked in ctor
7c3d7e2d
VZ
184 bool IsOk() const
185 { return m_isOk; }
9d133d87
VZ
186
187 // unlock the mutex in dtor
7c3d7e2d
VZ
188 ~wxMutexLocker()
189 { if ( IsOk() ) m_mutex.Unlock(); }
9d133d87
VZ
190
191private:
cb4f1ca4
VZ
192 // no assignment operator nor copy ctor
193 wxMutexLocker(const wxMutexLocker&);
194 wxMutexLocker& operator=(const wxMutexLocker&);
195
9d133d87 196 bool m_isOk;
7c3d7e2d 197 wxMutex& m_mutex;
9d133d87
VZ
198};
199
200// ----------------------------------------------------------------------------
201// Critical section: this is the same as mutex but is only visible to the
202// threads of the same process. For the platforms which don't have native
203// support for critical sections, they're implemented entirely in terms of
6d167489
VZ
204// mutexes.
205//
206// NB: wxCriticalSection object does not allocate any memory in its ctor
207// which makes it possible to have static globals of this class
9d133d87
VZ
208// ----------------------------------------------------------------------------
209
6d167489
VZ
210// in order to avoid any overhead under platforms where critical sections are
211// just mutexes make all wxCriticalSection class functions inline
d1bab566 212#if !defined(__WXMSW__)
6d167489 213 #define wxCRITSECT_IS_MUTEX 1
d42e3d59
VZ
214
215 #define wxCRITSECT_INLINE inline
d1bab566 216#else // MSW
6d167489 217 #define wxCRITSECT_IS_MUTEX 0
d42e3d59
VZ
218
219 #define wxCRITSECT_INLINE
f6ddc54a 220#endif // MSW/!MSW
bf1852e1
VZ
221
222// you should consider wxCriticalSectionLocker whenever possible instead of
223// directly working with wxCriticalSection class - it is safer
bb24c68f 224class WXDLLIMPEXP_BASE wxCriticalSection
9d133d87
VZ
225{
226public:
227 // ctor & dtor
d42e3d59
VZ
228 wxCRITSECT_INLINE wxCriticalSection();
229 wxCRITSECT_INLINE ~wxCriticalSection();
9d133d87
VZ
230
231 // enter the section (the same as locking a mutex)
d42e3d59 232 wxCRITSECT_INLINE void Enter();
9e84b847 233
9d133d87 234 // leave the critical section (same as unlocking a mutex)
d42e3d59 235 wxCRITSECT_INLINE void Leave();
9d133d87
VZ
236
237private:
6d167489 238#if wxCRITSECT_IS_MUTEX
f6ddc54a 239 wxMutex m_mutex;
6d167489
VZ
240#elif defined(__WXMSW__)
241 // we can't allocate any memory in the ctor, so use placement new -
242 // unfortunately, we have to hardcode the sizeof() here because we can't
dac348b9
VZ
243 // include windows.h from this public header and we also have to use the
244 // union to force the correct (i.e. maximal) alignment
9e84b847
VZ
245 //
246 // if CRITICAL_SECTION size changes in Windows, you'll get an assert from
247 // thread.cpp and will need to increase the buffer size
dac348b9
VZ
248 //
249 // finally, we need this typedef instead of declaring m_buffer directly
250 // because otherwise the assert mentioned above wouldn't compile with some
251 // compilers (notably CodeWarrior 8)
252 typedef char wxCritSectBuffer[24];
253 union
254 {
255 unsigned long m_dummy1;
256 void *m_dummy2;
257
258 wxCritSectBuffer m_buffer;
259 };
d1bab566 260#endif // Unix&OS2/Win32
9e84b847
VZ
261
262 DECLARE_NO_COPY_CLASS(wxCriticalSection)
9d133d87
VZ
263};
264
9e84b847
VZ
265#if wxCRITSECT_IS_MUTEX
266 // implement wxCriticalSection using mutexes
d42e3d59
VZ
267 inline wxCriticalSection::wxCriticalSection() { }
268 inline wxCriticalSection::~wxCriticalSection() { }
9e84b847 269
d42e3d59
VZ
270 inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
271 inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
9e84b847 272#endif // wxCRITSECT_IS_MUTEX
bf1852e1 273
d42e3d59
VZ
274#undef wxCRITSECT_INLINE
275#undef wxCRITSECT_IS_MUTEX
276
9d133d87
VZ
277// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
278// to th mutexes
bb24c68f 279class WXDLLIMPEXP_BASE wxCriticalSectionLocker
9d133d87
VZ
280{
281public:
9e84b847
VZ
282 wxCriticalSectionLocker(wxCriticalSection& cs)
283 : m_critsect(cs)
284 {
285 m_critsect.Enter();
286 }
9d133d87 287
9e84b847
VZ
288 ~wxCriticalSectionLocker()
289 {
290 m_critsect.Leave();
291 }
cb4f1ca4 292
9e84b847 293private:
bee503b0 294 wxCriticalSection& m_critsect;
9e84b847
VZ
295
296 DECLARE_NO_COPY_CLASS(wxCriticalSectionLocker)
9d133d87
VZ
297};
298
a6b0bd49 299// ----------------------------------------------------------------------------
be809868
VZ
300// wxCondition models a POSIX condition variable which allows one (or more)
301// thread(s) to wait until some condition is fulfilled
a6b0bd49 302// ----------------------------------------------------------------------------
d524867f 303
bb24c68f 304class WXDLLIMPEXP_BASE wxCondition
d524867f 305{
10b959e3 306public:
9e84b847
VZ
307 // Each wxCondition object is associated with a (single) wxMutex object.
308 // The mutex object MUST be locked before calling Wait()
c112e100 309 wxCondition(wxMutex& mutex);
be809868
VZ
310
311 // dtor is not virtual, don't use this class polymorphically
9fc3ad34
VZ
312 ~wxCondition();
313
9e84b847
VZ
314 // return TRUE if the condition has been created successfully
315 bool IsOk() const;
316
be809868
VZ
317 // NB: the associated mutex MUST be locked beforehand by the calling thread
318 //
319 // it atomically releases the lock on the associated mutex
320 // and starts waiting to be woken up by a Signal()/Broadcast()
321 // once its signaled, then it will wait until it can reacquire
322 // the lock on the associated mutex object, before returning.
9e84b847 323 wxCondError Wait();
9fc3ad34 324
be809868
VZ
325 // exactly as Wait() except that it may also return if the specified
326 // timeout ellapses even if the condition hasn't been signalled: in this
327 // case, the return value is FALSE, otherwise (i.e. in case of a normal
328 // return) it is TRUE
329 //
330 // the timeeout parameter specifies a interval that needs to be waited in
331 // milliseconds
9e84b847 332 wxCondError WaitTimeout(unsigned long milliseconds);
be809868
VZ
333
334 // NB: the associated mutex may or may not be locked by the calling thread
335 //
336 // this method unblocks one thread if any are blocking on the condition.
337 // if no thread is blocking in Wait(), then the signal is NOT remembered
338 // The thread which was blocking on Wait(), will then reacquire the lock
339 // on the associated mutex object before returning
9e84b847 340 wxCondError Signal();
a6b0bd49 341
be809868
VZ
342 // NB: the associated mutex may or may not be locked by the calling thread
343 //
344 // this method unblocks all threads if any are blocking on the condition.
345 // if no thread is blocking in Wait(), then the signal is NOT remembered
346 // The threads which were blocking on Wait(), will then reacquire the lock
347 // on the associated mutex object before returning.
9e84b847
VZ
348 wxCondError Broadcast();
349
350
351 // deprecated version, don't use
352 bool Wait(unsigned long milliseconds)
353 { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; }
8d5eff60 354
10b959e3 355private:
9fc3ad34 356 wxConditionInternal *m_internal;
9e84b847
VZ
357
358 DECLARE_NO_COPY_CLASS(wxCondition)
10b959e3
JS
359};
360
a6b0bd49 361// ----------------------------------------------------------------------------
be809868
VZ
362// wxSemaphore: a counter limiting the number of threads concurrently accessing
363// a shared resource
364// ----------------------------------------------------------------------------
365
bb24c68f 366class WXDLLIMPEXP_BASE wxSemaphore
be809868
VZ
367{
368public:
369 // specifying a maxcount of 0 actually makes wxSemaphore behave as if there
370 // is no upper limit, if maxcount is 1 the semaphore behaves as a mutex
371 wxSemaphore( int initialcount = 0, int maxcount = 0 );
372
373 // dtor is not virtual, don't use this class polymorphically
374 ~wxSemaphore();
375
9e84b847
VZ
376 // return TRUE if the semaphore has been created successfully
377 bool IsOk() const;
378
be809868
VZ
379 // wait indefinitely, until the semaphore count goes beyond 0
380 // and then decrement it and return (this method might have been called
381 // Acquire())
9e84b847 382 wxSemaError Wait();
be809868 383
9e84b847
VZ
384 // same as Wait(), but does not block, returns wxSEMA_NO_ERROR if
385 // successful and wxSEMA_BUSY if the count is currently zero
386 wxSemaError TryWait();
be809868 387
9e84b847
VZ
388 // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the
389 // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has ellapsed
390 wxSemaError WaitTimeout(unsigned long milliseconds);
be809868
VZ
391
392 // increments the semaphore count and signals one of the waiting threads
9e84b847 393 wxSemaError Post();
be809868
VZ
394
395private:
396 wxSemaphoreInternal *m_internal;
9e84b847
VZ
397
398 DECLARE_NO_COPY_CLASS(wxSemaphore)
be809868
VZ
399};
400
401// ----------------------------------------------------------------------------
402// wxThread: class encpasulating a thread of execution
a6b0bd49 403// ----------------------------------------------------------------------------
d524867f 404
b568d04f
VZ
405// there are two different kinds of threads: joinable and detached (default)
406// ones. Only joinable threads can return a return code and only detached
407// threads auto-delete themselves - the user should delete the joinable
408// threads manually.
bf1852e1
VZ
409
410// NB: in the function descriptions the words "this thread" mean the thread
411// created by the wxThread object while "main thread" is the thread created
412// during the process initialization (a.k.a. the GUI thread)
b568d04f 413
547b93ab
VZ
414// On VMS thread pointers are 64 bits (also needed for other systems???
415#ifdef __VMS
416 typedef unsigned long long wxThreadIdType;
417#else
418 typedef unsigned long wxThreadIdType;
419#endif
420
bb24c68f 421class WXDLLIMPEXP_BASE wxThread
d524867f 422{
10b959e3 423public:
bf1852e1
VZ
424 // the return type for the thread function
425 typedef void *ExitCode;
426
427 // static functions
428 // Returns the wxThread object for the calling thread. NULL is returned
429 // if the caller is the main thread (but it's recommended to use
430 // IsMain() and only call This() for threads other than the main one
431 // because NULL is also returned on error). If the thread wasn't
432 // created with wxThread class, the returned value is undefined.
433 static wxThread *This();
434
435 // Returns true if current thread is the main thread.
436 static bool IsMain();
437
438 // Release the rest of our time slice leting the other threads run
439 static void Yield();
440
441 // Sleep during the specified period of time in milliseconds
442 //
443 // NB: at least under MSW worker threads can not call ::wxSleep()!
444 static void Sleep(unsigned long milliseconds);
445
ef8d96c2
VZ
446 // get the number of system CPUs - useful with SetConcurrency()
447 // (the "best" value for it is usually number of CPUs + 1)
448 //
449 // Returns -1 if unknown, number of CPUs otherwise
450 static int GetCPUCount();
451
4958ea8f
RD
452 // Get the platform specific thread ID and return as a long. This
453 // can be used to uniquely identify threads, even if they are not
454 // wxThreads. This is used by wxPython.
547b93ab
VZ
455 static wxThreadIdType GetCurrentId();
456
ef8d96c2
VZ
457 // sets the concurrency level: this is, roughly, the number of threads
458 // the system tries to schedule to run in parallel. 0 means the
459 // default value (usually acceptable, but may not yield the best
460 // performance for this process)
461 //
462 // Returns TRUE on success, FALSE otherwise (if not implemented, for
463 // example)
464 static bool SetConcurrency(size_t level);
465
b568d04f
VZ
466 // constructor only creates the C++ thread object and doesn't create (or
467 // start) the real thread
468 wxThread(wxThreadKind kind = wxTHREAD_DETACHED);
469
470 // functions that change the thread state: all these can only be called
471 // from _another_ thread (typically the thread that created this one, e.g.
472 // the main thread), not from the thread itself
bf1852e1 473
6fe73788
RL
474 // create a new thread and optionally set the stack size on
475 // platforms that support that - call Run() to start it
476 // (special cased for watcom which won't accept 0 default)
477
6fe73788 478 wxThreadError Create(unsigned int stackSize = 0);
bf1852e1 479
b568d04f
VZ
480 // starts execution of the thread - from the moment Run() is called
481 // the execution of wxThread::Entry() may start at any moment, caller
bf1852e1
VZ
482 // shouldn't suppose that it starts after (or before) Run() returns.
483 wxThreadError Run();
484
b568d04f
VZ
485 // stops the thread if it's running and deletes the wxThread object if
486 // this is a detached thread freeing its memory - otherwise (for
487 // joinable threads) you still need to delete wxThread object
488 // yourself.
489 //
490 // this function only works if the thread calls TestDestroy()
491 // periodically - the thread will only be deleted the next time it
492 // does it!
493 //
494 // will fill the rc pointer with the thread exit code if it's !NULL
495 wxThreadError Delete(ExitCode *rc = (ExitCode *)NULL);
496
497 // waits for a joinable thread to finish and returns its exit code
498 //
499 // Returns (ExitCode)-1 on error (for example, if the thread is not
500 // joinable)
501 ExitCode Wait();
bf1852e1
VZ
502
503 // kills the thread without giving it any chance to clean up - should
504 // not be used in normal circumstances, use Delete() instead. It is a
505 // dangerous function that should only be used in the most extreme
b568d04f
VZ
506 // cases!
507 //
508 // The wxThread object is deleted by Kill() if the thread is
509 // detachable, but you still have to delete it manually for joinable
510 // threads.
bf1852e1
VZ
511 wxThreadError Kill();
512
b568d04f
VZ
513 // pause a running thread: as Delete(), this only works if the thread
514 // calls TestDestroy() regularly
bf1852e1
VZ
515 wxThreadError Pause();
516
517 // resume a paused thread
518 wxThreadError Resume();
519
520 // priority
521 // Sets the priority to "prio": see WXTHREAD_XXX_PRIORITY constants
522 //
523 // NB: the priority can only be set before the thread is created
524 void SetPriority(unsigned int prio);
525
526 // Get the current priority.
527 unsigned int GetPriority() const;
528
bf1852e1
VZ
529 // thread status inquiries
530 // Returns true if the thread is alive: i.e. running or suspended
531 bool IsAlive() const;
532 // Returns true if the thread is running (not paused, not killed).
533 bool IsRunning() const;
534 // Returns true if the thread is suspended
a737331d 535 bool IsPaused() const;
bf1852e1 536
b568d04f
VZ
537 // is the thread of detached kind?
538 bool IsDetached() const { return m_isDetached; }
539
540 // Get the thread ID - a platform dependent number which uniquely
541 // identifies a thread inside a process
547b93ab 542 wxThreadIdType GetId() const;
4958ea8f 543
bf1852e1
VZ
544 // called when the thread exits - in the context of this thread
545 //
546 // NB: this function will not be called if the thread is Kill()ed
547 virtual void OnExit() { }
10b959e3 548
b568d04f
VZ
549 // dtor is public, but the detached threads should never be deleted - use
550 // Delete() instead (or leave the thread terminate by itself)
551 virtual ~wxThread();
552
bf1852e1
VZ
553protected:
554 // Returns TRUE if the thread was asked to terminate: this function should
555 // be called by the thread from time to time, otherwise the main thread
556 // will be left forever in Delete()!
8c10faf1 557 bool TestDestroy();
10b959e3 558
bf1852e1 559 // exits from the current thread - can be called only from this thread
b568d04f 560 void Exit(ExitCode exitcode = 0);
9d133d87 561
bf1852e1
VZ
562 // entry point for the thread - called by Run() and executes in the context
563 // of this thread.
564 virtual void *Entry() = 0;
a6b0bd49 565
10b959e3 566private:
bf1852e1
VZ
567 // no copy ctor/assignment operator
568 wxThread(const wxThread&);
569 wxThread& operator=(const wxThread&);
10b959e3 570
bf1852e1
VZ
571 friend class wxThreadInternal;
572
573 // the (platform-dependent) thread class implementation
9fc3ad34 574 wxThreadInternal *m_internal;
10b959e3 575
bf1852e1
VZ
576 // protects access to any methods of wxThreadInternal object
577 wxCriticalSection m_critsect;
b568d04f
VZ
578
579 // true if the thread is detached, false if it is joinable
580 bool m_isDetached;
10b959e3
JS
581};
582
78ee6a47
VZ
583// wxThreadHelperThread class
584// --------------------------
585
586class WXDLLIMPEXP_BASE wxThreadHelperThread : public wxThread
587{
588public:
589 // constructor only creates the C++ thread object and doesn't create (or
590 // start) the real thread
591 wxThreadHelperThread(wxThreadHelper& owner)
592 : wxThread(wxTHREAD_JOINABLE), m_owner(owner)
593 { }
594
595protected:
596 // entry point for the thread -- calls Entry() in owner.
597 virtual void *Entry();
598
599private:
600 // the owner of the thread
601 wxThreadHelper& m_owner;
602
603 // no copy ctor/assignment operator
604 wxThreadHelperThread(const wxThreadHelperThread&);
605 wxThreadHelperThread& operator=(const wxThreadHelperThread&);
606};
607
608// ----------------------------------------------------------------------------
609// wxThreadHelper: this class implements the threading logic to run a
610// background task in another object (such as a window). It is a mix-in: just
611// derive from it to implement a threading background task in your class.
612// ----------------------------------------------------------------------------
613
614class WXDLLIMPEXP_BASE wxThreadHelper
615{
616private:
617 void KillThread()
618 {
619 if ( m_thread )
620 {
621 m_thread->Kill();
622 delete m_thread;
623 }
624 }
625
626public:
627 // constructor only initializes m_thread to NULL
628 wxThreadHelper() : m_thread(NULL) { }
629
630 // destructor deletes m_thread
631 virtual ~wxThreadHelper() { KillThread(); }
632
633 // create a new thread (and optionally set the stack size on platforms that
634 // support/need that), call Run() to start it
635 wxThreadError Create(unsigned int stackSize = 0)
636 {
637 KillThread();
638
639 m_thread = new wxThreadHelperThread(*this);
640
641 return m_thread->Create(stackSize);
642 }
643
644 // entry point for the thread - called by Run() and executes in the context
645 // of this thread.
646 virtual void *Entry() = 0;
647
648 // returns a pointer to the thread which can be used to call Run()
649 wxThread *GetThread() const { return m_thread; }
650
651protected:
652 wxThread *m_thread;
653};
654
655// call Entry() in owner, put it down here to avoid circular declarations
656inline void *wxThreadHelperThread::Entry()
657{
658 return m_owner.Entry();
659}
660
a6b0bd49 661// ----------------------------------------------------------------------------
d524867f 662// Automatic initialization
a6b0bd49 663// ----------------------------------------------------------------------------
10b959e3 664
9d133d87 665// GUI mutex handling.
bb24c68f
VS
666void WXDLLIMPEXP_BASE wxMutexGuiEnter();
667void WXDLLIMPEXP_BASE wxMutexGuiLeave();
d524867f 668
72cdf4c9
VZ
669// macros for entering/leaving critical sections which may be used without
670// having to take them inside "#if wxUSE_THREADS"
b568d04f
VZ
671#define wxENTER_CRIT_SECT(cs) (cs).Enter()
672#define wxLEAVE_CRIT_SECT(cs) (cs).Leave()
bdc72a22 673#define wxCRIT_SECT_DECLARE(cs) static wxCriticalSection cs
db882c54 674#define wxCRIT_SECT_DECLARE_MEMBER(cs) wxCriticalSection cs
b568d04f 675#define wxCRIT_SECT_LOCKER(name, cs) wxCriticalSectionLocker name(cs)
72cdf4c9 676
17dbd230
VZ
677// function for checking if we're in the main thread which may be used whether
678// wxUSE_THREADS is 0 or 1
679inline bool wxIsMainThread() { return wxThread::IsMain(); }
680
9d133d87 681#else // !wxUSE_THREADS
d524867f 682
9d133d87 683// no thread support
bb24c68f
VS
684inline void WXDLLIMPEXP_BASE wxMutexGuiEnter() { }
685inline void WXDLLIMPEXP_BASE wxMutexGuiLeave() { }
d524867f 686
72cdf4c9
VZ
687// macros for entering/leaving critical sections which may be used without
688// having to take them inside "#if wxUSE_THREADS"
689#define wxENTER_CRIT_SECT(cs)
690#define wxLEAVE_CRIT_SECT(cs)
bdc72a22 691#define wxCRIT_SECT_DECLARE(cs)
db882c54 692#define wxCRIT_SECT_DECLARE_MEMBER(cs)
72cdf4c9
VZ
693#define wxCRIT_SECT_LOCKER(name, cs)
694
17dbd230
VZ
695// if there is only one thread, it is always the main one
696inline bool wxIsMainThread() { return true; }
697
9e84b847 698#endif // wxUSE_THREADS/!wxUSE_THREADS
10b959e3 699
4562f685
VZ
700// mark part of code as being a critical section: this macro declares a
701// critical section with the given name and enters it immediately and leaves
702// it at the end of the current scope
703//
704// example:
705//
706// int Count()
707// {
708// static int s_counter = 0;
709//
710// wxCRITICAL_SECTION(counter);
711//
712// return ++s_counter;
713// }
714//
715// this function is MT-safe in presence of the threads but there is no
716// overhead when the library is compiled without threads
717#define wxCRITICAL_SECTION(name) \
718 wxCRIT_SECT_DECLARE(s_cs##name); \
719 wxCRIT_SECT_LOCKER(cs##name##Locker, s_cs##name)
720
9e84b847 721// automatically lock GUI mutex in ctor and unlock it in dtor
bb24c68f 722class WXDLLIMPEXP_BASE wxMutexGuiLocker
bee503b0
VZ
723{
724public:
725 wxMutexGuiLocker() { wxMutexGuiEnter(); }
726 ~wxMutexGuiLocker() { wxMutexGuiLeave(); }
727};
728
f6ddc54a
VZ
729// -----------------------------------------------------------------------------
730// implementation only until the end of file
731// -----------------------------------------------------------------------------
dcda1c71 732
9838df2c 733#if wxUSE_THREADS
dcda1c71 734
f877815e 735#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXPM__) || defined(__EMX__)
f6ddc54a
VZ
736 // unlock GUI if there are threads waiting for and lock it back when
737 // there are no more of them - should be called periodically by the main
738 // thread
bb24c68f 739 extern void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter();
f6ddc54a
VZ
740
741 // returns TRUE if the main thread has GUI lock
bb24c68f 742 extern bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread();
f6ddc54a 743
9e84b847 744#ifndef __WXPM__
f6ddc54a 745 // wakes up the main thread if it's sleeping inside ::GetMessage()
bb24c68f 746 extern void WXDLLIMPEXP_BASE wxWakeUpMainThread();
9e84b847 747#endif // !OS/2
bf1852e1 748
e7549107
SC
749 // return TRUE if the main thread is waiting for some other to terminate:
750 // wxApp then should block all "dangerous" messages
bb24c68f 751 extern bool WXDLLIMPEXP_BASE wxIsWaitingForThread();
9e84b847 752#endif // MSW, Mac, OS/2
dcda1c71 753
f6ddc54a
VZ
754#endif // wxUSE_THREADS
755
9e84b847 756#endif // _WX_THREAD_H_
6fe73788 757