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