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