]> git.saurik.com Git - wxWidgets.git/blame - src/os2/thread.cpp
Send all menu item actions to a dedicated target. This is to ensure
[wxWidgets.git] / src / os2 / thread.cpp
CommitLineData
0e320a79 1/////////////////////////////////////////////////////////////////////////////
d1bab566
SN
2// Name: src/os2/thread.cpp
3// Purpose: wxThread Implementation
4// Author: Original from Wolfram Gloger/Guilhem Lavaux/David Webster
5// Modified by: Stefan Neis
0e320a79
DW
6// Created: 04/22/98
7// RCS-ID: $Id$
d1bab566
SN
8// Copyright: (c) Stefan Neis (2003)
9//
0e320a79
DW
10// Licence: wxWindows licence
11/////////////////////////////////////////////////////////////////////////////
12
2b5f62a0
VZ
13#ifdef __GNUG__
14 #pragma implementation "thread.h"
15#endif
16
d90895ac
DW
17// ----------------------------------------------------------------------------
18// headers
19// ----------------------------------------------------------------------------
0e320a79 20
d90895ac
DW
21// For compilers that support precompilation, includes "wx.h".
22#include "wx/wxprec.h"
0e320a79
DW
23
24#if wxUSE_THREADS
25
d90895ac
DW
26#include <stdio.h>
27
d1bab566 28#include "wx/app.h"
d90895ac 29#include "wx/module.h"
19193a2c
KB
30#include "wx/intl.h"
31#include "wx/utils.h"
32#include "wx/log.h"
d90895ac
DW
33#include "wx/thread.h"
34
c5fb56c0
DW
35#define INCL_DOSSEMAPHORES
36#define INCL_DOSPROCESS
d1bab566 37#define INCL_DOSMISC
c5fb56c0
DW
38#define INCL_ERRORS
39#include <os2.h>
2b5f62a0 40#ifndef __EMX__
c5fb56c0 41#include <bseerr.h>
2b5f62a0 42#endif
d90895ac
DW
43// the possible states of the thread ("=>" shows all possible transitions from
44// this state)
45enum wxThreadState
46{
47 STATE_NEW, // didn't start execution yet (=> RUNNING)
48 STATE_RUNNING, // thread is running (=> PAUSED, CANCELED)
49 STATE_PAUSED, // thread is temporarily suspended (=> RUNNING)
50 STATE_CANCELED, // thread should terminate a.s.a.p. (=> EXITED)
51 STATE_EXITED // thread is terminating
0e320a79
DW
52};
53
d90895ac 54// ----------------------------------------------------------------------------
d1bab566 55// this module's globals
d90895ac 56// ----------------------------------------------------------------------------
0e320a79 57
d90895ac
DW
58// id of the main thread - the one which can call GUI functions without first
59// calling wxMutexGuiEnter()
d1bab566 60static ULONG s_ulIdMainThread = 1;
c5fb56c0
DW
61wxMutex* p_wxMainMutex;
62
63// OS2 substitute for Tls pointer the current parent thread object
64wxThread* m_pThread; // pointer to the wxWindows thread object
d90895ac
DW
65
66// if it's FALSE, some secondary thread is holding the GUI lock
43543d98 67static bool gs_bGuiOwnedByMainThread = TRUE;
0e320a79 68
d90895ac
DW
69// critical section which controls access to all GUI functions: any secondary
70// thread (i.e. except the main one) must enter this crit section before doing
71// any GUI calls
43543d98 72static wxCriticalSection *gs_pCritsectGui = NULL;
d90895ac
DW
73
74// critical section which protects s_nWaitingForGui variable
43543d98 75static wxCriticalSection *gs_pCritsectWaitingForGui = NULL;
d90895ac
DW
76
77// number of threads waiting for GUI in wxMutexGuiEnter()
43543d98 78static size_t gs_nWaitingForGui = 0;
d90895ac
DW
79
80// are we waiting for a thread termination?
43543d98 81static bool gs_bWaitingForThread = FALSE;
d90895ac
DW
82
83// ============================================================================
d1bab566 84// OS/2 implementation of thread and related classes
d90895ac
DW
85// ============================================================================
86
87// ----------------------------------------------------------------------------
88// wxMutex implementation
89// ----------------------------------------------------------------------------
90class wxMutexInternal
91{
0e320a79 92public:
d1bab566
SN
93 wxMutexInternal(wxMutexType mutexType);
94 ~wxMutexInternal();
95
96 bool IsOk() const { return m_vMutex != NULL; }
97
98 wxMutexError Lock() { return LockTimeout(SEM_INDEFINITE_WAIT); }
99 wxMutexError TryLock() { return LockTimeout(SEM_IMMEDIATE_RETURN); }
100 wxMutexError Unlock();
101
102private:
103 wxMutexError LockTimeout(ULONG ulMilliseconds);
c5fb56c0 104 HMTX m_vMutex;
0e320a79
DW
105};
106
d1bab566
SN
107// all mutexes are "pseudo-"recursive under OS2 so we don't use mutexType
108// (Calls to DosRequestMutexSem and DosReleaseMutexSem can be nested, but
109// the request count for a semaphore cannot exceed 65535. If an attempt is
110// made to exceed this number, ERROR_TOO_MANY_SEM_REQUESTS is returned.)
111wxMutexInternal::wxMutexInternal(
112 wxMutexType WXUNUSED(eMutexType)
47df2b8c 113)
0e320a79 114{
c5fb56c0
DW
115 APIRET ulrc;
116
d1bab566 117 ulrc = ::DosCreateMutexSem(NULL, &m_vMutex, 0L, FALSE);
c5fb56c0 118 if (ulrc != 0)
d90895ac
DW
119 {
120 wxLogSysError(_("Can not create mutex."));
d1bab566 121 m_vMutex = NULL;
d90895ac 122 }
0e320a79
DW
123}
124
d1bab566 125wxMutexInternal::~wxMutexInternal()
0e320a79 126{
d1bab566
SN
127 if (m_vMutex)
128 {
129 if (::DosCloseMutexSem(m_vMutex))
130 wxLogLastError(_T("DosCloseMutexSem(mutex)"));
131 }
0e320a79
DW
132}
133
d1bab566 134wxMutexError wxMutexInternal::LockTimeout(ULONG ulMilliseconds)
0e320a79 135{
c5fb56c0
DW
136 APIRET ulrc;
137
d1bab566 138 ulrc = ::DosRequestMutexSem(m_vMutex, ulMilliseconds);
d90895ac 139
c5fb56c0 140 switch (ulrc)
d90895ac 141 {
d1bab566 142 case ERROR_TIMEOUT:
c5fb56c0 143 case ERROR_TOO_MANY_SEM_REQUESTS:
d90895ac
DW
144 return wxMUTEX_BUSY;
145
c5fb56c0 146 case NO_ERROR:
d90895ac
DW
147 // ok
148 break;
149
c5fb56c0
DW
150 case ERROR_INVALID_HANDLE:
151 case ERROR_INTERRUPT:
152 case ERROR_SEM_OWNER_DIED:
d90895ac
DW
153 wxLogSysError(_("Couldn't acquire a mutex lock"));
154 return wxMUTEX_MISC_ERROR;
155
d90895ac
DW
156 default:
157 wxFAIL_MSG(wxT("impossible return value in wxMutex::Lock"));
d1bab566
SN
158 return wxMUTEX_MISC_ERROR;
159 }
0e320a79
DW
160 return wxMUTEX_NO_ERROR;
161}
162
d1bab566 163wxMutexError wxMutexInternal::Unlock()
0e320a79 164{
c5fb56c0
DW
165 APIRET ulrc;
166
d1bab566 167 ulrc = ::DosReleaseMutexSem(m_vMutex);
c5fb56c0 168 if (ulrc != 0)
d90895ac
DW
169 {
170 wxLogSysError(_("Couldn't release a mutex"));
171 return wxMUTEX_MISC_ERROR;
172 }
0e320a79
DW
173 return wxMUTEX_NO_ERROR;
174}
175
d1bab566
SN
176// --------------------------------------------------------------------------
177// wxSemaphore
178// --------------------------------------------------------------------------
d90895ac 179
d1bab566
SN
180// a trivial wrapper around OS2 event semaphore
181class wxSemaphoreInternal
d90895ac 182{
0e320a79 183public:
d1bab566
SN
184 wxSemaphoreInternal(int initialcount, int maxcount);
185 ~wxSemaphoreInternal();
d01cc696 186
d1bab566 187 bool IsOk() const { return m_vEvent != NULL; }
d01cc696 188
d1bab566
SN
189 wxSemaError Wait() { return WaitTimeout(SEM_INDEFINITE_WAIT); }
190 wxSemaError TryWait() { return WaitTimeout(SEM_IMMEDIATE_RETURN); }
191 wxSemaError WaitTimeout(unsigned long milliseconds);
d01cc696 192
d1bab566 193 wxSemaError Post();
d01cc696 194
d1bab566
SN
195private:
196 HEV m_vEvent;
197 HMTX m_vMutex;
198 int m_count;
199 int m_maxcount;
0e320a79
DW
200};
201
d1bab566 202wxSemaphoreInternal::wxSemaphoreInternal(int initialcount, int maxcount)
0e320a79 203{
d1bab566
SN
204 APIRET ulrc;
205 if ( maxcount == 0 )
d90895ac 206 {
d1bab566
SN
207 // make it practically infinite
208 maxcount = INT_MAX;
d90895ac 209 }
0e320a79 210
d1bab566
SN
211 m_count = initialcount;
212 m_maxcount = maxcount;
213 ulrc = ::DosCreateMutexSem(NULL, &m_vMutex, 0L, FALSE);
214 if (ulrc != 0)
47df2b8c 215 {
d1bab566
SN
216 wxLogLastError(_T("DosCreateMutexSem()"));
217 m_vMutex = NULL;
218 m_vEvent = NULL;
219 return;
47df2b8c 220 }
d1bab566
SN
221 ulrc = ::DosCreateEventSem(NULL, &m_vEvent, 0L, FALSE);
222 if ( ulrc != 0)
47df2b8c 223 {
d1bab566
SN
224 wxLogLastError(_T("DosCreateEventSem()"));
225 ::DosCloseMutexSem(m_vMutex);
226 m_vMutex = NULL;
227 m_vEvent = NULL;
47df2b8c 228 }
d1bab566
SN
229 if (initialcount)
230 ::DosPostEventSem(m_vEvent);
0e320a79
DW
231}
232
d1bab566 233wxSemaphoreInternal::~wxSemaphoreInternal()
0e320a79 234{
d1bab566 235 if ( m_vEvent )
d90895ac 236 {
d1bab566 237 if ( ::DosCloseEventSem(m_vEvent) )
d90895ac 238 {
d1bab566 239 wxLogLastError(_T("DosCloseEventSem(semaphore)"));
d90895ac 240 }
d1bab566
SN
241 if ( ::DosCloseMutexSem(m_vMutex) )
242 {
243 wxLogLastError(_T("DosCloseMutexSem(semaphore)"));
244 }
245 else
246 m_vEvent = NULL;
47df2b8c 247 }
0e320a79
DW
248}
249
d1bab566 250wxSemaError wxSemaphoreInternal::WaitTimeout(unsigned long ulMilliseconds)
892b89f3 251{
d1bab566
SN
252 APIRET ulrc;
253 do {
254 ulrc = ::DosWaitEventSem(m_vEvent, ulMilliseconds );
255 switch ( ulrc )
256 {
257 case NO_ERROR:
258 break;
259
260 case ERROR_TIMEOUT:
261 if (ulMilliseconds == SEM_IMMEDIATE_RETURN)
262 return wxSEMA_BUSY;
263 else
264 return wxSEMA_TIMEOUT;
265
266 default:
267 wxLogLastError(_T("DosWaitEventSem(semaphore)"));
268 return wxSEMA_MISC_ERROR;
269 }
270 ulrc = :: DosRequestMutexSem(m_vMutex, ulMilliseconds);
271 switch ( ulrc )
272 {
273 case NO_ERROR:
274 // ok
275 break;
276
277 case ERROR_TIMEOUT:
278 case ERROR_TOO_MANY_SEM_REQUESTS:
279 if (ulMilliseconds == SEM_IMMEDIATE_RETURN)
280 return wxSEMA_BUSY;
281 else
282 return wxSEMA_TIMEOUT;
283
284 default:
285 wxFAIL_MSG(wxT("DosRequestMutexSem(mutex)"));
286 return wxSEMA_MISC_ERROR;
287 }
288 bool OK = false;
289 if (m_count > 0)
290 {
291 m_count--;
292 OK = true;
293 }
294 else
295 {
296 ULONG ulPostCount;
297 ::DosResetEventSem(m_vEvent, &ulPostCount);
298 }
299 ::DosReleaseMutexSem(m_vMutex);
300 if (OK)
301 return wxSEMA_NO_ERROR;
302 } while (ulMilliseconds == SEM_INDEFINITE_WAIT);
303
304 if (ulMilliseconds == SEM_IMMEDIATE_RETURN)
305 return wxSEMA_BUSY;
306 return wxSEMA_TIMEOUT;
892b89f3
DW
307}
308
d1bab566 309wxSemaError wxSemaphoreInternal::Post()
892b89f3 310{
d1bab566
SN
311 APIRET ulrc;
312 ulrc = ::DosRequestMutexSem(m_vMutex, SEM_INDEFINITE_WAIT);
313 if (ulrc != NO_ERROR)
314 return wxSEMA_MISC_ERROR;
315 bool OK = false;
316 if (m_count < m_maxcount)
317 {
318 m_count++;
319 ulrc = ::DosPostEventSem(m_vEvent);
320 OK = true;
321 }
322 ::DosReleaseMutexSem(m_vMutex);
323 if (!OK)
324 return wxSEMA_OVERFLOW;
325 if ( ulrc != NO_ERROR && ulrc != ERROR_ALREADY_POSTED )
326 {
327 wxLogLastError(_T("DosPostEventSem(semaphore)"));
892b89f3 328
d1bab566
SN
329 return wxSEMA_MISC_ERROR;
330 }
892b89f3 331
d1bab566 332 return wxSEMA_NO_ERROR;
892b89f3
DW
333}
334
d90895ac
DW
335// ----------------------------------------------------------------------------
336// wxThread implementation
337// ----------------------------------------------------------------------------
338
339// wxThreadInternal class
340// ----------------------
341
342class wxThreadInternal
343{
344public:
c5fb56c0 345 inline wxThreadInternal()
d90895ac
DW
346 {
347 m_hThread = 0;
c5fb56c0 348 m_eState = STATE_NEW;
d1bab566 349 m_nPriority = WXTHREAD_DEFAULT_PRIORITY;
d90895ac
DW
350 }
351
d01cc696
DW
352 ~wxThreadInternal()
353 {
d1bab566 354 m_hThread = 0;
d01cc696
DW
355 }
356
d90895ac 357 // create a new (suspended) thread (for the given thread object)
793c7f9b
DW
358 bool Create( wxThread* pThread
359 ,unsigned int uStackSize
360 );
d90895ac
DW
361
362 // suspend/resume/terminate
363 bool Suspend();
364 bool Resume();
c5fb56c0 365 inline void Cancel() { m_eState = STATE_CANCELED; }
d90895ac
DW
366
367 // thread state
c5fb56c0
DW
368 inline void SetState(wxThreadState eState) { m_eState = eState; }
369 inline wxThreadState GetState() const { return m_eState; }
d90895ac
DW
370
371 // thread priority
d01cc696 372 void SetPriority(unsigned int nPriority);
c5fb56c0 373 inline unsigned int GetPriority() const { return m_nPriority; }
d90895ac
DW
374
375 // thread handle and id
c5fb56c0
DW
376 inline TID GetHandle() const { return m_hThread; }
377 TID GetId() const { return m_hThread; }
d90895ac
DW
378
379 // thread function
d1bab566 380 static DWORD OS2ThreadStart(ULONG ulParam);
d90895ac
DW
381
382private:
c5fb56c0
DW
383 // Threads in OS/2 have only an ID, so m_hThread is both it's handle and ID
384 // PM also has no real Tls mechanism to index pointers by so we'll just
385 // keep track of the wxWindows parent object here.
386 TID m_hThread; // handle and ID of the thread
387 wxThreadState m_eState; // state, see wxThreadState enum
388 unsigned int m_nPriority; // thread priority in "wx" units
d90895ac
DW
389};
390
c5fb56c0 391ULONG wxThreadInternal::OS2ThreadStart(
d1bab566 392 ULONG ulParam
c5fb56c0 393)
d90895ac 394{
d1bab566
SN
395 DWORD dwRet;
396 bool bWasCancelled;
d90895ac 397
d1bab566
SN
398 // first of all, check whether we hadn't been cancelled already and don't
399 // start the user code at all then
400 wxThread *pThread = (wxThread *)ulParam;
401 if ( pThread->m_internal->GetState() == STATE_EXITED )
402 {
403 dwRet = (DWORD)-1;
404 bWasCancelled = TRUE;
405 }
406 else // do run thread
407 {
408 dwRet = (DWORD)pThread->Entry();
d01cc696 409
d1bab566
SN
410 // enter m_critsect before changing the thread state
411 pThread->m_critsect.Enter();
d01cc696 412
d1bab566 413 bWasCancelled = pThread->m_internal->GetState() == STATE_CANCELED;
d01cc696 414
d1bab566
SN
415 pThread->m_internal->SetState(STATE_EXITED);
416 pThread->m_critsect.Leave();
417 }
c5fb56c0 418 pThread->OnExit();
d90895ac 419
d01cc696
DW
420 // if the thread was cancelled (from Delete()), then it the handle is still
421 // needed there
422 if (pThread->IsDetached() && !bWasCancelled)
423 {
424 // auto delete
43543d98 425 delete pThread;
d01cc696
DW
426 }
427 //else: the joinable threads handle will be closed when Wait() is done
c5fb56c0 428 return dwRet;
d90895ac
DW
429}
430
d01cc696
DW
431void wxThreadInternal::SetPriority(
432 unsigned int nPriority
c5fb56c0 433)
d90895ac 434{
c5fb56c0 435 // translate wxWindows priority to the PM one
d1bab566
SN
436 ULONG ulOS2_PriorityClass;
437 ULONG ulOS2_SubPriority;
43543d98 438 ULONG ulrc;
c5fb56c0 439
d01cc696 440 m_nPriority = nPriority;
d1bab566
SN
441 if (m_nPriority <= 25)
442 ulOS2_PriorityClass = PRTYC_IDLETIME;
443 else if (m_nPriority <= 50)
444 ulOS2_PriorityClass = PRTYC_REGULAR;
445 else if (m_nPriority <= 75)
446 ulOS2_PriorityClass = PRTYC_TIMECRITICAL;
c5fb56c0 447 else if (m_nPriority <= 100)
d1bab566 448 ulOS2_PriorityClass = PRTYC_FOREGROUNDSERVER;
d90895ac
DW
449 else
450 {
451 wxFAIL_MSG(wxT("invalid value of thread priority parameter"));
d1bab566 452 ulOS2_PriorityClass = PRTYC_REGULAR;
d90895ac 453 }
d1bab566 454 ulOS2_SubPriority = (ULONG) (((m_nPriority - 1) % 25 + 1) * 31.0 / 25);
c5fb56c0 455 ulrc = ::DosSetPriority( PRTYS_THREAD
d1bab566
SN
456 ,ulOS2_PriorityClass
457 ,ulOS2_SubPriority
c5fb56c0
DW
458 ,(ULONG)m_hThread
459 );
460 if (ulrc != 0)
d90895ac
DW
461 {
462 wxLogSysError(_("Can't set thread priority"));
463 }
d01cc696
DW
464}
465
466bool wxThreadInternal::Create(
467 wxThread* pThread
793c7f9b 468, unsigned int uStackSize
d01cc696
DW
469)
470{
471 APIRET ulrc;
472
473 ulrc = ::DosCreateThread( &m_hThread
474 ,(PFNTHREAD)wxThreadInternal::OS2ThreadStart
475 ,(ULONG)pThread
476 ,CREATE_SUSPENDED | STACK_SPARSE
793c7f9b 477 ,(ULONG)uStackSize
d01cc696
DW
478 );
479 if(ulrc != 0)
480 {
481 wxLogSysError(_("Can't create thread"));
482
483 return FALSE;
484 }
485 if (m_nPriority != WXTHREAD_DEFAULT_PRIORITY)
486 {
487 SetPriority(m_nPriority);
488 }
1dfc3cda 489
d01cc696 490 return(TRUE);
d90895ac
DW
491}
492
493bool wxThreadInternal::Suspend()
494{
c5fb56c0 495 ULONG ulrc = ::DosSuspendThread(m_hThread);
d90895ac 496
c5fb56c0
DW
497 if (ulrc != 0)
498 {
499 wxLogSysError(_("Can not suspend thread %lu"), m_hThread);
d90895ac
DW
500 return FALSE;
501 }
c5fb56c0
DW
502 m_eState = STATE_PAUSED;
503 return TRUE;
d90895ac
DW
504}
505
506bool wxThreadInternal::Resume()
507{
c5fb56c0 508 ULONG ulrc = ::DosResumeThread(m_hThread);
d90895ac 509
c5fb56c0
DW
510 if (ulrc != 0)
511 {
512 wxLogSysError(_("Can not suspend thread %lu"), m_hThread);
d90895ac
DW
513 return FALSE;
514 }
d1bab566
SN
515
516 // don't change the state from STATE_EXITED because it's special and means
517 // we are going to terminate without running any user code - if we did it,
518 // the codei n Delete() wouldn't work
519 if ( m_eState != STATE_EXITED )
520 {
521 m_eState = STATE_RUNNING;
522 }
523
c5fb56c0 524 return TRUE;
d90895ac
DW
525}
526
527// static functions
528// ----------------
529
8e5052fa
SN
530bool WXDLLEXPORT wxGuiOwnedByMainThread();
531
d90895ac
DW
532wxThread *wxThread::This()
533{
c5fb56c0
DW
534 wxThread* pThread = m_pThread;
535 return pThread;
d90895ac
DW
536}
537
538bool wxThread::IsMain()
539{
c5fb56c0
DW
540 PTIB ptib;
541 PPIB ppib;
542
543 ::DosGetInfoBlocks(&ptib, &ppib);
544
545 if (ptib->tib_ptib2->tib2_ultid == s_ulIdMainThread)
546 return TRUE;
d90895ac
DW
547 return FALSE;
548}
549
550#ifdef Yield
551 #undef Yield
552#endif
553
554void wxThread::Yield()
555{
d90895ac
DW
556 ::DosSleep(0);
557}
558
c5fb56c0
DW
559void wxThread::Sleep(
560 unsigned long ulMilliseconds
561)
d90895ac 562{
c5fb56c0 563 ::DosSleep(ulMilliseconds);
d90895ac
DW
564}
565
d1bab566
SN
566int wxThread::GetCPUCount()
567{
568 ULONG CPUCount;
569 APIRET ulrc;
570 ulrc = ::DosQuerySysInfo(26, 26, (void *)&CPUCount, sizeof(ULONG));
571 // QSV_NUMPROCESSORS(26) is typically not defined in header files
572
573 if (ulrc != 0)
574 CPUCount = 1;
575
576 return CPUCount;
577}
578
579unsigned long wxThread::GetCurrentId()
580{
581 PTIB ptib;
582 PPIB ppib;
583
584 ::DosGetInfoBlocks(&ptib, &ppib);
585 return (unsigned long) ptib->tib_ptib2->tib2_ultid;
586}
587
588bool wxThread::SetConcurrency(size_t level)
589{
590 wxASSERT_MSG( IsMain(), _T("should only be called from the main thread") );
591
592 // ok only for the default one
593 if ( level == 0 )
594 return 0;
595
596 // Don't know how to realize this on OS/2.
597 return level == 1;
598}
599
d01cc696
DW
600// ctor and dtor
601// -------------
602
603wxThread::wxThread(wxThreadKind kind)
604{
605 m_internal = new wxThreadInternal();
606
607 m_isDetached = kind == wxTHREAD_DETACHED;
608}
609
610wxThread::~wxThread()
611{
612 delete m_internal;
613}
614
d90895ac
DW
615// create/start thread
616// -------------------
617
793c7f9b
DW
618wxThreadError wxThread::Create(
619 unsigned int uStackSize
620)
0e320a79 621{
d1bab566
SN
622 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
623
793c7f9b 624 if ( !m_internal->Create(this, uStackSize) )
d90895ac
DW
625 return wxTHREAD_NO_RESOURCE;
626
0e320a79
DW
627 return wxTHREAD_NO_ERROR;
628}
629
d90895ac 630wxThreadError wxThread::Run()
0e320a79 631{
c5fb56c0 632 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 633
d01cc696 634 if ( m_internal->GetState() != STATE_NEW )
d90895ac
DW
635 {
636 // actually, it may be almost any state at all, not only STATE_RUNNING
637 return wxTHREAD_RUNNING;
638 }
d90895ac 639 return Resume();
0e320a79
DW
640}
641
d90895ac
DW
642// suspend/resume thread
643// ---------------------
644
0e320a79
DW
645wxThreadError wxThread::Pause()
646{
c5fb56c0 647 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 648
d01cc696 649 return m_internal->Suspend() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
0e320a79
DW
650}
651
652wxThreadError wxThread::Resume()
653{
c5fb56c0 654 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
0e320a79 655
d01cc696 656 return m_internal->Resume() ? wxTHREAD_NO_ERROR : wxTHREAD_MISC_ERROR;
0e320a79
DW
657}
658
d90895ac
DW
659// stopping thread
660// ---------------
661
d01cc696 662wxThread::ExitCode wxThread::Wait()
0e320a79 663{
d01cc696
DW
664 // although under Windows we can wait for any thread, it's an error to
665 // wait for a detached one in wxWin API
666 wxCHECK_MSG( !IsDetached(), (ExitCode)-1,
667 _T("can't wait for detached thread") );
668 ExitCode rc = (ExitCode)-1;
669 (void)Delete(&rc);
d01cc696
DW
670 return(rc);
671}
672
673wxThreadError wxThread::Delete(ExitCode *pRc)
674{
675 ExitCode rc = 0;
d90895ac
DW
676
677 // Delete() is always safe to call, so consider all possible states
d1bab566
SN
678
679 // we might need to resume the thread, but we might also not need to cancel
680 // it if it doesn't run yet
681 bool shouldResume = FALSE,
682 shouldCancel = TRUE,
683 isRunning = FALSE;
684
685 // check if the thread already started to run
686 {
687 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
688
689 if ( m_internal->GetState() == STATE_NEW )
690 {
691 // WinThreadStart() will see it and terminate immediately, no need
692 // to cancel the thread - but we still need to resume it to let it
693 // run
694 m_internal->SetState(STATE_EXITED);
695
696 Resume(); // it knows about STATE_EXITED special case
697
698 shouldCancel = FALSE;
699 isRunning = TRUE;
700
701 // shouldResume is correctly set to FALSE here
702 }
703 else
704 {
705 shouldResume = IsPaused();
706 }
707 }
708
709 // resume the thread if it is paused
710 if ( shouldResume )
d90895ac
DW
711 Resume();
712
d01cc696
DW
713 TID hThread = m_internal->GetHandle();
714
d1bab566 715 if ( isRunning || IsRunning())
d90895ac 716 {
c5fb56c0 717 if (IsMain())
d90895ac
DW
718 {
719 // set flag for wxIsWaitingForThread()
43543d98 720 gs_bWaitingForThread = TRUE;
d1bab566 721 }
d90895ac 722
d01cc696 723 // ask the thread to terminate
d1bab566 724 if ( shouldCancel )
d90895ac 725 {
d01cc696 726 wxCriticalSectionLocker lock(m_critsect);
d1bab566 727
d01cc696 728 m_internal->Cancel();
d90895ac
DW
729 }
730
d01cc696 731#if wxUSE_GUI
d1bab566
SN
732 // we can't just wait for the thread to terminate because it might be
733 // calling some GUI functions and so it will never terminate before we
734 // process the Windows messages that result from these functions
735 DWORD result = 0; // suppress warnings from broken compilers
736 do
d01cc696 737 {
d1bab566
SN
738 if ( IsMain() )
739 {
740 // give the thread we're waiting for chance to do the GUI call
741 // it might be in
742 if ( (gs_nWaitingForGui > 0) && wxGuiOwnedByMainThread() )
743 {
744 wxMutexGuiLeave();
745 }
746 }
747
748 result = ::DosWaitThread(&hThread, DCWW_WAIT);
749 // FIXME: We ought to have a message processing loop here!!
750
751 switch ( result )
752 {
753 case ERROR_THREAD_NOT_TERMINATED:
754 case ERROR_INVALID_THREADID:
755 // error
756 wxLogSysError(_("Can not wait for thread termination"));
757 Kill();
758 return wxTHREAD_KILLED;
3b9e3455 759
d1bab566
SN
760 case NO_ERROR:
761 // thread we're waiting for terminated
762 break;
3b9e3455 763
d1bab566
SN
764 default:
765 wxFAIL_MSG(wxT("unexpected result of DosWaitThread"));
766 }
767 } while ( result != NO_ERROR );
768#else // !wxUSE_GUI
769 // simply wait for the thread to terminate
770 //
771 // OTOH, even console apps create windows (in wxExecute, for WinSock
772 // &c), so may be use MsgWaitForMultipleObject() too here?
773 if ( ::DosWaitThread(&hThread, DCWW_WAIT) != NO_ERROR )
774 {
775 wxFAIL_MSG(wxT("unexpected result of DosWaitThread"));
776 }
d01cc696 777#endif // wxUSE_GUI/!wxUSE_GUI
d90895ac 778
d01cc696 779 if ( IsMain() )
d90895ac 780 {
43543d98 781 gs_bWaitingForThread = FALSE;
d90895ac 782 }
d01cc696
DW
783 }
784
d1bab566
SN
785#if 0
786 // although the thread might be already in the EXITED state it might not
787 // have terminated yet and so we are not sure that it has actually
788 // terminated if the "if" above hadn't been taken
789 do
790 {
791 if ( !::GetExitCodeThread(hThread, (LPDWORD)&rc) )
792 {
793 wxLogLastError(wxT("GetExitCodeThread"));
794
795 rc = (ExitCode)-1;
796 }
797 } while ( (DWORD)rc == STILL_ACTIVE );
798#endif
799
800 if ( IsDetached() )
d01cc696 801 {
d1bab566
SN
802 // if the thread exits normally, this is done in WinThreadStart, but in
803 // this case it would have been too early because
804 // MsgWaitForMultipleObject() would fail if the thread handle was
805 // closed while we were waiting on it, so we must do it here
d01cc696
DW
806 delete this;
807 }
808
d01cc696
DW
809 if ( pRc )
810 *pRc = rc;
811
812 return rc == (ExitCode)-1 ? wxTHREAD_MISC_ERROR : wxTHREAD_NO_ERROR;
0e320a79
DW
813}
814
d90895ac 815wxThreadError wxThread::Kill()
0e320a79 816{
c5fb56c0 817 if (!IsRunning())
d90895ac
DW
818 return wxTHREAD_NOT_RUNNING;
819
d01cc696 820 ::DosKillThread(m_internal->GetHandle());
3b9e3455
DW
821 if (IsDetached())
822 {
823 delete this;
824 }
d90895ac 825 return wxTHREAD_NO_ERROR;
0e320a79
DW
826}
827
c5fb56c0 828void wxThread::Exit(
3b9e3455 829 ExitCode pStatus
c5fb56c0 830)
0e320a79 831{
d90895ac 832 delete this;
c5fb56c0
DW
833 ::DosExit(EXIT_THREAD, ULONG(pStatus));
834 wxFAIL_MSG(wxT("Couldn't return from DosExit()!"));
0e320a79
DW
835}
836
c5fb56c0
DW
837void wxThread::SetPriority(
838 unsigned int nPrio
839)
0e320a79 840{
c5fb56c0 841 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 842
d01cc696 843 m_internal->SetPriority(nPrio);
0e320a79
DW
844}
845
d90895ac 846unsigned int wxThread::GetPriority() const
0e320a79 847{
c5fb56c0 848 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 849
d01cc696 850 return m_internal->GetPriority();
0e320a79
DW
851}
852
3b9e3455
DW
853unsigned long wxThread::GetId() const
854{
855 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect); // const_cast
856
857 return (unsigned long)m_internal->GetId();
858}
859
d90895ac 860bool wxThread::IsRunning() const
0e320a79 861{
c5fb56c0 862 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 863
3b9e3455 864 return(m_internal->GetState() == STATE_RUNNING);
0e320a79 865}
0e320a79
DW
866
867bool wxThread::IsAlive() const
868{
c5fb56c0 869 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 870
d01cc696
DW
871 return (m_internal->GetState() == STATE_RUNNING) ||
872 (m_internal->GetState() == STATE_PAUSED);
0e320a79
DW
873}
874
d90895ac 875bool wxThread::IsPaused() const
0e320a79 876{
c5fb56c0 877 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 878
d01cc696 879 return (m_internal->GetState() == STATE_PAUSED);
0e320a79
DW
880}
881
d90895ac 882bool wxThread::TestDestroy()
0e320a79 883{
c5fb56c0 884 wxCriticalSectionLocker lock((wxCriticalSection &)m_critsect);
d90895ac 885
d01cc696 886 return m_internal->GetState() == STATE_CANCELED;
0e320a79
DW
887}
888
d90895ac
DW
889// ----------------------------------------------------------------------------
890// Automatic initialization for thread module
891// ----------------------------------------------------------------------------
0e320a79 892
d90895ac
DW
893class wxThreadModule : public wxModule
894{
0e320a79 895public:
d90895ac
DW
896 virtual bool OnInit();
897 virtual void OnExit();
0e320a79 898
d90895ac
DW
899private:
900 DECLARE_DYNAMIC_CLASS(wxThreadModule)
0e320a79
DW
901};
902
903IMPLEMENT_DYNAMIC_CLASS(wxThreadModule, wxModule)
904
d90895ac
DW
905bool wxThreadModule::OnInit()
906{
43543d98 907 gs_pCritsectWaitingForGui = new wxCriticalSection();
d90895ac 908
43543d98
DW
909 gs_pCritsectGui = new wxCriticalSection();
910 gs_pCritsectGui->Enter();
d90895ac 911
c5fb56c0
DW
912 PTIB ptib;
913 PPIB ppib;
d90895ac 914
c5fb56c0 915 ::DosGetInfoBlocks(&ptib, &ppib);
d90895ac 916
c5fb56c0 917 s_ulIdMainThread = ptib->tib_ptib2->tib2_ultid;
d90895ac
DW
918 return TRUE;
919}
920
921void wxThreadModule::OnExit()
922{
43543d98 923 if (gs_pCritsectGui)
d90895ac 924 {
43543d98 925 gs_pCritsectGui->Leave();
f6bcfd97 926#if (!(defined(__VISAGECPP__) && (__IBMCPP__ < 400 || __IBMC__ < 400 )))
43543d98 927 delete gs_pCritsectGui;
f6bcfd97 928#endif
43543d98 929 gs_pCritsectGui = NULL;
d90895ac
DW
930 }
931
f6bcfd97 932#if (!(defined(__VISAGECPP__) && (__IBMCPP__ < 400 || __IBMC__ < 400 )))
43543d98 933 wxDELETE(gs_pCritsectWaitingForGui);
f6bcfd97 934#endif
d90895ac
DW
935}
936
937// ----------------------------------------------------------------------------
c5fb56c0 938// Helper functions
d90895ac
DW
939// ----------------------------------------------------------------------------
940
d1bab566 941// wake up the main thread if it's in ::GetMessage()
c5fb56c0 942void WXDLLEXPORT wxWakeUpMainThread()
d90895ac 943{
8e5052fa 944#if 0
d1bab566
SN
945 if ( !::WinPostQueueMsg(wxTheApp->m_hMq, WM_NULL, 0, 0) )
946 {
947 // should never happen
948 wxLogLastError(wxT("WinPostMessage(WM_NULL)"));
949 }
8e5052fa 950#endif
d90895ac
DW
951}
952
28a75c29
SN
953void WXDLLEXPORT wxMutexGuiEnter()
954{
955 // this would dead lock everything...
956 wxASSERT_MSG( !wxThread::IsMain(),
957 wxT("main thread doesn't want to block in wxMutexGuiEnter()!") );
958
959 // the order in which we enter the critical sections here is crucial!!
960
961 // set the flag telling to the main thread that we want to do some GUI
962 {
963 wxCriticalSectionLocker enter(*gs_pCritsectWaitingForGui);
964
965 gs_nWaitingForGui++;
966 }
967
968 wxWakeUpMainThread();
969
970 // now we may block here because the main thread will soon let us in
971 // (during the next iteration of OnIdle())
972 gs_pCritsectGui->Enter();
973}
974
d90895ac
DW
975void WXDLLEXPORT wxMutexGuiLeave()
976{
43543d98 977 wxCriticalSectionLocker enter(*gs_pCritsectWaitingForGui);
d90895ac
DW
978
979 if ( wxThread::IsMain() )
980 {
43543d98 981 gs_bGuiOwnedByMainThread = FALSE;
d90895ac
DW
982 }
983 else
984 {
985 // decrement the number of waiters now
43543d98 986 wxASSERT_MSG(gs_nWaitingForGui > 0,
d90895ac
DW
987 wxT("calling wxMutexGuiLeave() without entering it first?") );
988
43543d98 989 gs_nWaitingForGui--;
d90895ac
DW
990
991 wxWakeUpMainThread();
992 }
993
43543d98 994 gs_pCritsectGui->Leave();
d90895ac
DW
995}
996
997void WXDLLEXPORT wxMutexGuiLeaveOrEnter()
998{
999 wxASSERT_MSG( wxThread::IsMain(),
1000 wxT("only main thread may call wxMutexGuiLeaveOrEnter()!") );
1001
43543d98 1002 wxCriticalSectionLocker enter(*gs_pCritsectWaitingForGui);
d90895ac 1003
43543d98 1004 if (gs_nWaitingForGui == 0)
d90895ac
DW
1005 {
1006 // no threads are waiting for GUI - so we may acquire the lock without
1007 // any danger (but only if we don't already have it)
c5fb56c0 1008 if (!wxGuiOwnedByMainThread())
d90895ac 1009 {
43543d98 1010 gs_pCritsectGui->Enter();
d90895ac 1011
43543d98 1012 gs_bGuiOwnedByMainThread = TRUE;
d90895ac
DW
1013 }
1014 //else: already have it, nothing to do
1015 }
1016 else
1017 {
1018 // some threads are waiting, release the GUI lock if we have it
c5fb56c0 1019 if (wxGuiOwnedByMainThread())
d90895ac
DW
1020 {
1021 wxMutexGuiLeave();
1022 }
1023 //else: some other worker thread is doing GUI
1024 }
1025}
1026
1027bool WXDLLEXPORT wxGuiOwnedByMainThread()
1028{
43543d98 1029 return gs_bGuiOwnedByMainThread;
d90895ac
DW
1030}
1031
9ed0fac8
DW
1032bool WXDLLEXPORT wxIsWaitingForThread()
1033{
43543d98 1034 return gs_bWaitingForThread;
9ed0fac8
DW
1035}
1036
d1bab566
SN
1037// ----------------------------------------------------------------------------
1038// include common implementation code
1039// ----------------------------------------------------------------------------
1040
1041#include "wx/thrimpl.cpp"
1042
0e320a79
DW
1043#endif
1044 // wxUSE_THREADS