]> git.saurik.com Git - wxWidgets.git/blame - include/wx/thread.h
wxUSE_XML
[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
af49c4b8 26#if defined(__GNUG__) && !defined(__APPLE__)
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
acd9676e 212#if !defined(__WXMSW__) && !defined(__WXPM__)
6d167489 213 #define wxCRITSECT_IS_MUTEX 1
d42e3d59
VZ
214
215 #define wxCRITSECT_INLINE inline
acd9676e 216#else // MSW || OS2
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 };
6d167489
VZ
260#else
261 // nothing for OS/2
9e84b847
VZ
262#endif // Unix/Win32/OS2
263
264 DECLARE_NO_COPY_CLASS(wxCriticalSection)
9d133d87
VZ
265};
266
9e84b847
VZ
267#if wxCRITSECT_IS_MUTEX
268 // implement wxCriticalSection using mutexes
d42e3d59
VZ
269 inline wxCriticalSection::wxCriticalSection() { }
270 inline wxCriticalSection::~wxCriticalSection() { }
9e84b847 271
d42e3d59
VZ
272 inline void wxCriticalSection::Enter() { (void)m_mutex.Lock(); }
273 inline void wxCriticalSection::Leave() { (void)m_mutex.Unlock(); }
9e84b847 274#endif // wxCRITSECT_IS_MUTEX
bf1852e1 275
d42e3d59
VZ
276#undef wxCRITSECT_INLINE
277#undef wxCRITSECT_IS_MUTEX
278
9d133d87
VZ
279// wxCriticalSectionLocker is the same to critical sections as wxMutexLocker is
280// to th mutexes
bb24c68f 281class WXDLLIMPEXP_BASE wxCriticalSectionLocker
9d133d87
VZ
282{
283public:
9e84b847
VZ
284 wxCriticalSectionLocker(wxCriticalSection& cs)
285 : m_critsect(cs)
286 {
287 m_critsect.Enter();
288 }
9d133d87 289
9e84b847
VZ
290 ~wxCriticalSectionLocker()
291 {
292 m_critsect.Leave();
293 }
cb4f1ca4 294
9e84b847 295private:
bee503b0 296 wxCriticalSection& m_critsect;
9e84b847
VZ
297
298 DECLARE_NO_COPY_CLASS(wxCriticalSectionLocker)
9d133d87
VZ
299};
300
a6b0bd49 301// ----------------------------------------------------------------------------
be809868
VZ
302// wxCondition models a POSIX condition variable which allows one (or more)
303// thread(s) to wait until some condition is fulfilled
a6b0bd49 304// ----------------------------------------------------------------------------
d524867f 305
bb24c68f 306class WXDLLIMPEXP_BASE wxCondition
d524867f 307{
10b959e3 308public:
9e84b847
VZ
309 // Each wxCondition object is associated with a (single) wxMutex object.
310 // The mutex object MUST be locked before calling Wait()
c112e100 311 wxCondition(wxMutex& mutex);
be809868
VZ
312
313 // dtor is not virtual, don't use this class polymorphically
9fc3ad34
VZ
314 ~wxCondition();
315
9e84b847
VZ
316 // return TRUE if the condition has been created successfully
317 bool IsOk() const;
318
be809868
VZ
319 // NB: the associated mutex MUST be locked beforehand by the calling thread
320 //
321 // it atomically releases the lock on the associated mutex
322 // and starts waiting to be woken up by a Signal()/Broadcast()
323 // once its signaled, then it will wait until it can reacquire
324 // the lock on the associated mutex object, before returning.
9e84b847 325 wxCondError Wait();
9fc3ad34 326
be809868
VZ
327 // exactly as Wait() except that it may also return if the specified
328 // timeout ellapses even if the condition hasn't been signalled: in this
329 // case, the return value is FALSE, otherwise (i.e. in case of a normal
330 // return) it is TRUE
331 //
332 // the timeeout parameter specifies a interval that needs to be waited in
333 // milliseconds
9e84b847 334 wxCondError WaitTimeout(unsigned long milliseconds);
be809868
VZ
335
336 // NB: the associated mutex may or may not be locked by the calling thread
337 //
338 // this method unblocks one thread if any are blocking on the condition.
339 // if no thread is blocking in Wait(), then the signal is NOT remembered
340 // The thread which was blocking on Wait(), will then reacquire the lock
341 // on the associated mutex object before returning
9e84b847 342 wxCondError Signal();
a6b0bd49 343
be809868
VZ
344 // NB: the associated mutex may or may not be locked by the calling thread
345 //
346 // this method unblocks all threads if any are blocking on the condition.
347 // if no thread is blocking in Wait(), then the signal is NOT remembered
348 // The threads which were blocking on Wait(), will then reacquire the lock
349 // on the associated mutex object before returning.
9e84b847
VZ
350 wxCondError Broadcast();
351
352
353 // deprecated version, don't use
354 bool Wait(unsigned long milliseconds)
355 { return WaitTimeout(milliseconds) == wxCOND_NO_ERROR; }
8d5eff60 356
10b959e3 357private:
9fc3ad34 358 wxConditionInternal *m_internal;
9e84b847
VZ
359
360 DECLARE_NO_COPY_CLASS(wxCondition)
10b959e3
JS
361};
362
a6b0bd49 363// ----------------------------------------------------------------------------
be809868
VZ
364// wxSemaphore: a counter limiting the number of threads concurrently accessing
365// a shared resource
366// ----------------------------------------------------------------------------
367
bb24c68f 368class WXDLLIMPEXP_BASE wxSemaphore
be809868
VZ
369{
370public:
371 // specifying a maxcount of 0 actually makes wxSemaphore behave as if there
372 // is no upper limit, if maxcount is 1 the semaphore behaves as a mutex
373 wxSemaphore( int initialcount = 0, int maxcount = 0 );
374
375 // dtor is not virtual, don't use this class polymorphically
376 ~wxSemaphore();
377
9e84b847
VZ
378 // return TRUE if the semaphore has been created successfully
379 bool IsOk() const;
380
be809868
VZ
381 // wait indefinitely, until the semaphore count goes beyond 0
382 // and then decrement it and return (this method might have been called
383 // Acquire())
9e84b847 384 wxSemaError Wait();
be809868 385
9e84b847
VZ
386 // same as Wait(), but does not block, returns wxSEMA_NO_ERROR if
387 // successful and wxSEMA_BUSY if the count is currently zero
388 wxSemaError TryWait();
be809868 389
9e84b847
VZ
390 // same as Wait(), but as a timeout limit, returns wxSEMA_NO_ERROR if the
391 // semaphore was acquired and wxSEMA_TIMEOUT if the timeout has ellapsed
392 wxSemaError WaitTimeout(unsigned long milliseconds);
be809868
VZ
393
394 // increments the semaphore count and signals one of the waiting threads
9e84b847 395 wxSemaError Post();
be809868
VZ
396
397private:
398 wxSemaphoreInternal *m_internal;
9e84b847
VZ
399
400 DECLARE_NO_COPY_CLASS(wxSemaphore)
be809868
VZ
401};
402
403// ----------------------------------------------------------------------------
404// wxThread: class encpasulating a thread of execution
a6b0bd49 405// ----------------------------------------------------------------------------
d524867f 406
b568d04f
VZ
407// there are two different kinds of threads: joinable and detached (default)
408// ones. Only joinable threads can return a return code and only detached
409// threads auto-delete themselves - the user should delete the joinable
410// threads manually.
bf1852e1
VZ
411
412// NB: in the function descriptions the words "this thread" mean the thread
413// created by the wxThread object while "main thread" is the thread created
414// during the process initialization (a.k.a. the GUI thread)
b568d04f 415
547b93ab
VZ
416// On VMS thread pointers are 64 bits (also needed for other systems???
417#ifdef __VMS
418 typedef unsigned long long wxThreadIdType;
419#else
420 typedef unsigned long wxThreadIdType;
421#endif
422
bb24c68f 423class WXDLLIMPEXP_BASE wxThread
d524867f 424{
10b959e3 425public:
bf1852e1
VZ
426 // the return type for the thread function
427 typedef void *ExitCode;
428
429 // static functions
430 // Returns the wxThread object for the calling thread. NULL is returned
431 // if the caller is the main thread (but it's recommended to use
432 // IsMain() and only call This() for threads other than the main one
433 // because NULL is also returned on error). If the thread wasn't
434 // created with wxThread class, the returned value is undefined.
435 static wxThread *This();
436
437 // Returns true if current thread is the main thread.
438 static bool IsMain();
439
440 // Release the rest of our time slice leting the other threads run
441 static void Yield();
442
443 // Sleep during the specified period of time in milliseconds
444 //
445 // NB: at least under MSW worker threads can not call ::wxSleep()!
446 static void Sleep(unsigned long milliseconds);
447
ef8d96c2
VZ
448 // get the number of system CPUs - useful with SetConcurrency()
449 // (the "best" value for it is usually number of CPUs + 1)
450 //
451 // Returns -1 if unknown, number of CPUs otherwise
452 static int GetCPUCount();
453
4958ea8f
RD
454 // Get the platform specific thread ID and return as a long. This
455 // can be used to uniquely identify threads, even if they are not
456 // wxThreads. This is used by wxPython.
547b93ab
VZ
457 static wxThreadIdType GetCurrentId();
458
ef8d96c2
VZ
459 // sets the concurrency level: this is, roughly, the number of threads
460 // the system tries to schedule to run in parallel. 0 means the
461 // default value (usually acceptable, but may not yield the best
462 // performance for this process)
463 //
464 // Returns TRUE on success, FALSE otherwise (if not implemented, for
465 // example)
466 static bool SetConcurrency(size_t level);
467
b568d04f
VZ
468 // constructor only creates the C++ thread object and doesn't create (or
469 // start) the real thread
470 wxThread(wxThreadKind kind = wxTHREAD_DETACHED);
471
472 // functions that change the thread state: all these can only be called
473 // from _another_ thread (typically the thread that created this one, e.g.
474 // the main thread), not from the thread itself
bf1852e1 475
6fe73788
RL
476 // create a new thread and optionally set the stack size on
477 // platforms that support that - call Run() to start it
478 // (special cased for watcom which won't accept 0 default)
479
6fe73788 480 wxThreadError Create(unsigned int stackSize = 0);
bf1852e1 481
b568d04f
VZ
482 // starts execution of the thread - from the moment Run() is called
483 // the execution of wxThread::Entry() may start at any moment, caller
bf1852e1
VZ
484 // shouldn't suppose that it starts after (or before) Run() returns.
485 wxThreadError Run();
486
b568d04f
VZ
487 // stops the thread if it's running and deletes the wxThread object if
488 // this is a detached thread freeing its memory - otherwise (for
489 // joinable threads) you still need to delete wxThread object
490 // yourself.
491 //
492 // this function only works if the thread calls TestDestroy()
493 // periodically - the thread will only be deleted the next time it
494 // does it!
495 //
496 // will fill the rc pointer with the thread exit code if it's !NULL
497 wxThreadError Delete(ExitCode *rc = (ExitCode *)NULL);
498
499 // waits for a joinable thread to finish and returns its exit code
500 //
501 // Returns (ExitCode)-1 on error (for example, if the thread is not
502 // joinable)
503 ExitCode Wait();
bf1852e1
VZ
504
505 // kills the thread without giving it any chance to clean up - should
506 // not be used in normal circumstances, use Delete() instead. It is a
507 // dangerous function that should only be used in the most extreme
b568d04f
VZ
508 // cases!
509 //
510 // The wxThread object is deleted by Kill() if the thread is
511 // detachable, but you still have to delete it manually for joinable
512 // threads.
bf1852e1
VZ
513 wxThreadError Kill();
514
b568d04f
VZ
515 // pause a running thread: as Delete(), this only works if the thread
516 // calls TestDestroy() regularly
bf1852e1
VZ
517 wxThreadError Pause();
518
519 // resume a paused thread
520 wxThreadError Resume();
521
522 // priority
523 // Sets the priority to "prio": see WXTHREAD_XXX_PRIORITY constants
524 //
525 // NB: the priority can only be set before the thread is created
526 void SetPriority(unsigned int prio);
527
528 // Get the current priority.
529 unsigned int GetPriority() const;
530
bf1852e1
VZ
531 // thread status inquiries
532 // Returns true if the thread is alive: i.e. running or suspended
533 bool IsAlive() const;
534 // Returns true if the thread is running (not paused, not killed).
535 bool IsRunning() const;
536 // Returns true if the thread is suspended
a737331d 537 bool IsPaused() const;
bf1852e1 538
b568d04f
VZ
539 // is the thread of detached kind?
540 bool IsDetached() const { return m_isDetached; }
541
542 // Get the thread ID - a platform dependent number which uniquely
543 // identifies a thread inside a process
547b93ab 544 wxThreadIdType GetId() const;
4958ea8f 545
bf1852e1
VZ
546 // called when the thread exits - in the context of this thread
547 //
548 // NB: this function will not be called if the thread is Kill()ed
549 virtual void OnExit() { }
10b959e3 550
b568d04f
VZ
551 // dtor is public, but the detached threads should never be deleted - use
552 // Delete() instead (or leave the thread terminate by itself)
553 virtual ~wxThread();
554
bf1852e1
VZ
555protected:
556 // Returns TRUE if the thread was asked to terminate: this function should
557 // be called by the thread from time to time, otherwise the main thread
558 // will be left forever in Delete()!
8c10faf1 559 bool TestDestroy();
10b959e3 560
bf1852e1 561 // exits from the current thread - can be called only from this thread
b568d04f 562 void Exit(ExitCode exitcode = 0);
9d133d87 563
bf1852e1
VZ
564 // entry point for the thread - called by Run() and executes in the context
565 // of this thread.
566 virtual void *Entry() = 0;
a6b0bd49 567
10b959e3 568private:
bf1852e1
VZ
569 // no copy ctor/assignment operator
570 wxThread(const wxThread&);
571 wxThread& operator=(const wxThread&);
10b959e3 572
bf1852e1
VZ
573 friend class wxThreadInternal;
574
575 // the (platform-dependent) thread class implementation
9fc3ad34 576 wxThreadInternal *m_internal;
10b959e3 577
bf1852e1
VZ
578 // protects access to any methods of wxThreadInternal object
579 wxCriticalSection m_critsect;
b568d04f
VZ
580
581 // true if the thread is detached, false if it is joinable
582 bool m_isDetached;
10b959e3
JS
583};
584
78ee6a47
VZ
585// wxThreadHelperThread class
586// --------------------------
587
588class WXDLLIMPEXP_BASE wxThreadHelperThread : public wxThread
589{
590public:
591 // constructor only creates the C++ thread object and doesn't create (or
592 // start) the real thread
593 wxThreadHelperThread(wxThreadHelper& owner)
594 : wxThread(wxTHREAD_JOINABLE), m_owner(owner)
595 { }
596
597protected:
598 // entry point for the thread -- calls Entry() in owner.
599 virtual void *Entry();
600
601private:
602 // the owner of the thread
603 wxThreadHelper& m_owner;
604
605 // no copy ctor/assignment operator
606 wxThreadHelperThread(const wxThreadHelperThread&);
607 wxThreadHelperThread& operator=(const wxThreadHelperThread&);
608};
609
610// ----------------------------------------------------------------------------
611// wxThreadHelper: this class implements the threading logic to run a
612// background task in another object (such as a window). It is a mix-in: just
613// derive from it to implement a threading background task in your class.
614// ----------------------------------------------------------------------------
615
616class WXDLLIMPEXP_BASE wxThreadHelper
617{
618private:
619 void KillThread()
620 {
621 if ( m_thread )
622 {
623 m_thread->Kill();
624 delete m_thread;
625 }
626 }
627
628public:
629 // constructor only initializes m_thread to NULL
630 wxThreadHelper() : m_thread(NULL) { }
631
632 // destructor deletes m_thread
633 virtual ~wxThreadHelper() { KillThread(); }
634
635 // create a new thread (and optionally set the stack size on platforms that
636 // support/need that), call Run() to start it
637 wxThreadError Create(unsigned int stackSize = 0)
638 {
639 KillThread();
640
641 m_thread = new wxThreadHelperThread(*this);
642
643 return m_thread->Create(stackSize);
644 }
645
646 // entry point for the thread - called by Run() and executes in the context
647 // of this thread.
648 virtual void *Entry() = 0;
649
650 // returns a pointer to the thread which can be used to call Run()
651 wxThread *GetThread() const { return m_thread; }
652
653protected:
654 wxThread *m_thread;
655};
656
657// call Entry() in owner, put it down here to avoid circular declarations
658inline void *wxThreadHelperThread::Entry()
659{
660 return m_owner.Entry();
661}
662
a6b0bd49 663// ----------------------------------------------------------------------------
d524867f 664// Automatic initialization
a6b0bd49 665// ----------------------------------------------------------------------------
10b959e3 666
9d133d87 667// GUI mutex handling.
bb24c68f
VS
668void WXDLLIMPEXP_BASE wxMutexGuiEnter();
669void WXDLLIMPEXP_BASE wxMutexGuiLeave();
d524867f 670
72cdf4c9
VZ
671// macros for entering/leaving critical sections which may be used without
672// having to take them inside "#if wxUSE_THREADS"
b568d04f
VZ
673#define wxENTER_CRIT_SECT(cs) (cs).Enter()
674#define wxLEAVE_CRIT_SECT(cs) (cs).Leave()
bdc72a22 675#define wxCRIT_SECT_DECLARE(cs) static wxCriticalSection cs
db882c54 676#define wxCRIT_SECT_DECLARE_MEMBER(cs) wxCriticalSection cs
b568d04f 677#define wxCRIT_SECT_LOCKER(name, cs) wxCriticalSectionLocker name(cs)
72cdf4c9 678
17dbd230
VZ
679// function for checking if we're in the main thread which may be used whether
680// wxUSE_THREADS is 0 or 1
681inline bool wxIsMainThread() { return wxThread::IsMain(); }
682
9d133d87 683#else // !wxUSE_THREADS
d524867f 684
9d133d87 685// no thread support
bb24c68f
VS
686inline void WXDLLIMPEXP_BASE wxMutexGuiEnter() { }
687inline void WXDLLIMPEXP_BASE wxMutexGuiLeave() { }
d524867f 688
72cdf4c9
VZ
689// macros for entering/leaving critical sections which may be used without
690// having to take them inside "#if wxUSE_THREADS"
691#define wxENTER_CRIT_SECT(cs)
692#define wxLEAVE_CRIT_SECT(cs)
bdc72a22 693#define wxCRIT_SECT_DECLARE(cs)
db882c54 694#define wxCRIT_SECT_DECLARE_MEMBER(cs)
72cdf4c9
VZ
695#define wxCRIT_SECT_LOCKER(name, cs)
696
17dbd230
VZ
697// if there is only one thread, it is always the main one
698inline bool wxIsMainThread() { return true; }
699
9e84b847 700#endif // wxUSE_THREADS/!wxUSE_THREADS
10b959e3 701
4562f685
VZ
702// mark part of code as being a critical section: this macro declares a
703// critical section with the given name and enters it immediately and leaves
704// it at the end of the current scope
705//
706// example:
707//
708// int Count()
709// {
710// static int s_counter = 0;
711//
712// wxCRITICAL_SECTION(counter);
713//
714// return ++s_counter;
715// }
716//
717// this function is MT-safe in presence of the threads but there is no
718// overhead when the library is compiled without threads
719#define wxCRITICAL_SECTION(name) \
720 wxCRIT_SECT_DECLARE(s_cs##name); \
721 wxCRIT_SECT_LOCKER(cs##name##Locker, s_cs##name)
722
9e84b847 723// automatically lock GUI mutex in ctor and unlock it in dtor
bb24c68f 724class WXDLLIMPEXP_BASE wxMutexGuiLocker
bee503b0
VZ
725{
726public:
727 wxMutexGuiLocker() { wxMutexGuiEnter(); }
728 ~wxMutexGuiLocker() { wxMutexGuiLeave(); }
729};
730
f6ddc54a
VZ
731// -----------------------------------------------------------------------------
732// implementation only until the end of file
733// -----------------------------------------------------------------------------
dcda1c71 734
9838df2c 735#if wxUSE_THREADS
dcda1c71 736
9e84b847 737#if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXPM__)
f6ddc54a
VZ
738 // unlock GUI if there are threads waiting for and lock it back when
739 // there are no more of them - should be called periodically by the main
740 // thread
bb24c68f 741 extern void WXDLLIMPEXP_BASE wxMutexGuiLeaveOrEnter();
f6ddc54a
VZ
742
743 // returns TRUE if the main thread has GUI lock
bb24c68f 744 extern bool WXDLLIMPEXP_BASE wxGuiOwnedByMainThread();
f6ddc54a 745
9e84b847 746#ifndef __WXPM__
f6ddc54a 747 // wakes up the main thread if it's sleeping inside ::GetMessage()
bb24c68f 748 extern void WXDLLIMPEXP_BASE wxWakeUpMainThread();
9e84b847 749#endif // !OS/2
bf1852e1 750
e7549107
SC
751 // return TRUE if the main thread is waiting for some other to terminate:
752 // wxApp then should block all "dangerous" messages
bb24c68f 753 extern bool WXDLLIMPEXP_BASE wxIsWaitingForThread();
9e84b847 754#endif // MSW, Mac, OS/2
dcda1c71 755
f6ddc54a
VZ
756#endif // wxUSE_THREADS
757
9e84b847 758#endif // _WX_THREAD_H_
6fe73788 759