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