]> git.saurik.com Git - wxWidgets.git/blobdiff - src/os2/thread.cpp
cleanup
[wxWidgets.git] / src / os2 / thread.cpp
index c837f5c1a72630ddb39144901b8de0ff2025df3a..f4234f2d85a6500b9786c42e263a59fede7e44d6 100644 (file)
@@ -6,14 +6,9 @@
 // Created:     04/22/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Stefan Neis (2003)
-//                         
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-    #pragma implementation "thread.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 #if wxUSE_THREADS
 
-#include <stdio.h>
+#include "wx/thread.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/module.h"
+#endif //WX_PRECOMP
 
-#include "wx/app.h"
 #include "wx/apptrait.h"
-#include "wx/module.h"
-#include "wx/intl.h"
 #include "wx/utils.h"
-#include "wx/log.h"
-#include "wx/thread.h"
+
+#include <stdio.h>
 
 #define INCL_DOSSEMAPHORES
 #define INCL_DOSPROCESS
@@ -62,10 +61,10 @@ static ULONG                        s_ulIdMainThread = 1;
 wxMutex*                            p_wxMainMutex;
 
 // OS2 substitute for Tls pointer the current parent thread object
-wxThread*                           m_pThread;    // pointer to the wxWindows thread object
+wxThread*                           m_pThread;    // pointer to the wxWidgets thread object
 
-// if it's FALSE, some secondary thread is holding the GUI lock
-static bool gs_bGuiOwnedByMainThread = TRUE;
+// if it's false, some secondary thread is holding the GUI lock
+static bool gs_bGuiOwnedByMainThread = true;
 
 // critical section which controls access to all GUI functions: any secondary
 // thread (i.e. except the main one) must enter this crit section before doing
@@ -79,7 +78,7 @@ static wxCriticalSection *gs_pCritsectWaitingForGui = NULL;
 static size_t gs_nWaitingForGui = 0;
 
 // are we waiting for a thread termination?
-static bool gs_bWaitingForThread = FALSE;
+static bool gs_bWaitingForThread = false;
 
 // ============================================================================
 // OS/2 implementation of thread and related classes
@@ -97,7 +96,8 @@ public:
     bool IsOk() const { return m_vMutex != NULL; }
 
     wxMutexError Lock() { return LockTimeout(SEM_INDEFINITE_WAIT); }
-    wxMutexError TryLock() { return LockTimeout(SEM_IMMEDIATE_RETURN); }
+    wxMutexError Lock(unsigned long ms) { return LockTimeout(ms); }
+    wxMutexError TryLock();
     wxMutexError Unlock();
 
 private:
@@ -109,13 +109,9 @@ private:
 // (Calls to DosRequestMutexSem and DosReleaseMutexSem can be nested, but
 //  the request count for a semaphore cannot exceed 65535. If an attempt is
 //  made to exceed this number, ERROR_TOO_MANY_SEM_REQUESTS is returned.)
-wxMutexInternal::wxMutexInternal(
-  wxMutexType                       WXUNUSED(eMutexType)
-)
+wxMutexInternal::wxMutexInternal(wxMutexType WXUNUSED(eMutexType))
 {
-    APIRET                          ulrc;
-
-    ulrc = ::DosCreateMutexSem(NULL, &m_vMutex, 0L, FALSE);
+    APIRET ulrc = ::DosCreateMutexSem(NULL, &m_vMutex, 0L, FALSE);
     if (ulrc != 0)
     {
         wxLogSysError(_("Can not create mutex."));
@@ -132,6 +128,14 @@ wxMutexInternal::~wxMutexInternal()
     }
 }
 
+wxMutexError wxMutexInternal::TryLock()
+{
+    const wxMutexError rc = LockTimeout( SEM_IMMEDIATE_RETURN );
+
+    // we have a special return code for timeout in this case
+    return rc == wxMUTEX_TIMEOUT ? wxMUTEX_BUSY : rc;
+}
+
 wxMutexError wxMutexInternal::LockTimeout(ULONG ulMilliseconds)
 {
     APIRET                          ulrc;
@@ -141,6 +145,7 @@ wxMutexError wxMutexInternal::LockTimeout(ULONG ulMilliseconds)
     switch (ulrc)
     {
         case ERROR_TIMEOUT:
+            return wxMUTEX_TIMEOUT;
         case ERROR_TOO_MANY_SEM_REQUESTS:
             return wxMUTEX_BUSY;
 
@@ -383,17 +388,15 @@ public:
 private:
     // Threads in OS/2 have only an ID, so m_hThread is both it's handle and ID
     // PM also has no real Tls mechanism to index pointers by so we'll just
-    // keep track of the wxWindows parent object here.
+    // keep track of the wxWidgets parent object here.
     TID                             m_hThread;    // handle and ID of the thread
     wxThreadState                   m_eState;     // state, see wxThreadState enum
     unsigned int                    m_nPriority;  // thread priority in "wx" units
 };
 
-void wxThreadInternal::OS2ThreadStart(
-  void * pParam
-)
+void wxThreadInternal::OS2ThreadStart( void * pParam )
 {
-    DWORD                           dwRet;
+    DWORD dwRet;
     bool bWasCancelled;
 
     wxThread *pThread = (wxThread *)pParam;
@@ -406,25 +409,25 @@ void wxThreadInternal::OS2ThreadStart(
     if ( pThread->m_internal->GetState() == STATE_EXITED )
     {
         dwRet = (DWORD)-1;
-        bWasCancelled = TRUE;
+        bWasCancelled = true;
     }
     else // do run thread
     {
         wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
         unsigned long ulHab;
-       if (traits)
-           traits->InitializeGui(ulHab);
+        if (traits)
+            traits->InitializeGui(ulHab);
         dwRet = (DWORD)pThread->Entry();
-       if (traits)
-           traits->TerminateGui(ulHab);
+        if (traits)
+            traits->TerminateGui(ulHab);
 
-       // enter m_critsect before changing the thread state
-       pThread->m_critsect.Enter();
+        // enter m_critsect before changing the thread state
+        pThread->m_critsect.Enter();
 
-       bWasCancelled = pThread->m_internal->GetState() == STATE_CANCELED;
+        bWasCancelled = pThread->m_internal->GetState() == STATE_CANCELED;
 
-       pThread->m_internal->SetState(STATE_EXITED);
-       pThread->m_critsect.Leave();
+        pThread->m_internal->SetState(STATE_EXITED);
+        pThread->m_critsect.Leave();
     }
     pThread->OnExit();
 
@@ -443,7 +446,7 @@ void wxThreadInternal::SetPriority(
   unsigned int                      nPriority
 )
 {
-    // translate wxWindows priority to the PM one
+    // translate wxWidgets priority to the PM one
     ULONG                           ulOS2_PriorityClass;
     ULONG                           ulOS2_SubPriority;
     ULONG                           ulrc;
@@ -474,23 +477,22 @@ void wxThreadInternal::SetPriority(
     }
 }
 
-bool wxThreadInternal::Create(
-  wxThread*                         pThread
-, unsigned int                      uStackSize
-)
+bool wxThreadInternal::Create( wxThread* pThread,
+                               unsigned int uStackSize)
 {
-    int                          tid;
-    
+    int tid;
+
     if (!uStackSize)
-      uStackSize = 131072;
+        uStackSize = 131072;
+
     pThread->m_critsect.Enter();
     tid = _beginthread(wxThreadInternal::OS2ThreadStart,
-                            NULL, uStackSize, pThread);
+                             NULL, uStackSize, pThread);
     if(tid == -1)
     {
         wxLogSysError(_("Can't create thread"));
 
-        return FALSE;
+        return false;
     }
     m_hThread = tid;
     if (m_nPriority != WXTHREAD_DEFAULT_PRIORITY)
@@ -498,30 +500,31 @@ bool wxThreadInternal::Create(
         SetPriority(m_nPriority);
     }
 
-    return(TRUE);
+    return true;
 }
 
 bool wxThreadInternal::Suspend()
 {
-    ULONG                           ulrc = ::DosSuspendThread(m_hThread);
+    ULONG ulrc = ::DosSuspendThread(m_hThread);
 
     if (ulrc != 0)
     {
         wxLogSysError(_("Can not suspend thread %lu"), m_hThread);
-        return FALSE;
+        return false;
     }
     m_eState = STATE_PAUSED;
-    return TRUE;
+
+    return true;
 }
 
 bool wxThreadInternal::Resume()
 {
-    ULONG                           ulrc = ::DosResumeThread(m_hThread);
+    ULONG ulrc = ::DosResumeThread(m_hThread);
 
     if (ulrc != 0)
     {
         wxLogSysError(_("Can not resume thread %lu"), m_hThread);
-        return FALSE;
+        return false;
     }
 
     // don't change the state from STATE_EXITED because it's special and means
@@ -532,7 +535,7 @@ bool wxThreadInternal::Resume()
         m_eState = STATE_RUNNING;
     }
 
-    return TRUE;
+    return true;
 }
 
 // static functions
@@ -546,14 +549,15 @@ wxThread *wxThread::This()
 
 bool wxThread::IsMain()
 {
-    PTIB                            ptib;
-    PPIB                            ppib;
+    PTIB ptib;
+    PPIB ppib;
 
     ::DosGetInfoBlocks(&ptib, &ppib);
 
     if (ptib->tib_ptib2->tib2_ultid == s_ulIdMainThread)
-        return TRUE;
-    return FALSE;
+        return true;
+
+    return false;
 }
 
 #ifdef Yield
@@ -662,9 +666,9 @@ wxThreadError wxThread::Resume()
 {
     if (m_internal->GetState() == STATE_NEW)
     {
-       m_internal->SetState(STATE_RUNNING);
+        m_internal->SetState(STATE_RUNNING);
         m_critsect.Leave();
-       return wxTHREAD_NO_ERROR;
+        return wxTHREAD_NO_ERROR;
     }
 
     wxCriticalSectionLocker         lock((wxCriticalSection &)m_critsect);
@@ -694,9 +698,9 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
 
     // we might need to resume the thread, but we might also not need to cancel
     // it if it doesn't run yet
-    bool shouldResume = FALSE,
-         shouldCancel = TRUE,
-         isRunning = FALSE;
+    bool shouldResume = false,
+         shouldCancel = true,
+         isRunning = false;
 
     // check if the thread already started to run
     {
@@ -711,10 +715,10 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
 
             Resume();   // it knows about STATE_EXITED special case
 
-            shouldCancel = FALSE;
-            isRunning = TRUE;
+            shouldCancel = false;
+            isRunning = true;
 
-            // shouldResume is correctly set to FALSE here
+            // shouldResume is correctly set to false here
         }
         else
         {
@@ -726,15 +730,15 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
     if ( shouldResume )
         Resume();
 
-    TID                             hThread = m_internal->GetHandle();
+    TID hThread = m_internal->GetHandle();
 
     if ( isRunning || IsRunning())
     {
         if (IsMain())
         {
             // set flag for wxIsWaitingForThread()
-            gs_bWaitingForThread = TRUE;
-       }
+            gs_bWaitingForThread = true;
+        }
 
         // ask the thread to terminate
         if ( shouldCancel )
@@ -744,7 +748,7 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
             m_internal->Cancel();
         }
 
-#if wxUSE_GUI
+#if 0
         // we can't just wait for the thread to terminate because it might be
         // calling some GUI functions and so it will never terminate before we
         // process the Windows messages that result from these functions
@@ -762,41 +766,41 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
             }
 
             result = ::DosWaitThread(&hThread, DCWW_NOWAIT);
-           // FIXME: We ought to have a message processing loop here!!
+            // FIXME: We ought to have a message processing loop here!!
 
             switch ( result )
-           {
-               case ERROR_INTERRUPT:
-               case ERROR_THREAD_NOT_TERMINATED:
-                   break;
-               case ERROR_INVALID_THREADID:
+            {
+                case ERROR_INTERRUPT:
+                case ERROR_THREAD_NOT_TERMINATED:
+                    break;
+                case ERROR_INVALID_THREADID:
                 case NO_ERROR:
                     // thread we're waiting for just terminated
-                   // or even does not exist any more.
-                   result = NO_ERROR;
-                   break;
+                    // or even does not exist any more.
+                    result = NO_ERROR;
+                    break;
                 default:
                     wxFAIL_MSG(wxT("unexpected result of DosWaitThread"));
             }
-           if ( IsMain() )
-           {
-               // event processing - needed if we are the main thread
-               // to give other threads a chance to do remaining GUI
-               // processing and terminate cleanly.
-               wxTheApp->HandleSockets();
-               if (wxTheApp->Pending())
-                 if ( !wxTheApp->DoMessage() )
-                 {
-                     // WM_QUIT received: kill the thread
-                     Kill();
-
-                     return wxTHREAD_KILLED;
-                 }
-                 else
-                   wxUsleep(10);
-           }
-           else
-               wxUsleep(10);
+            if ( IsMain() )
+            {
+                // event processing - needed if we are the main thread
+                // to give other threads a chance to do remaining GUI
+                // processing and terminate cleanly.
+                wxTheApp->HandleSockets();
+                if (wxTheApp->Pending())
+                  if ( !wxTheApp->DoMessage() )
+                  {
+                      // WM_QUIT received: kill the thread
+                      Kill();
+
+                      return wxTHREAD_KILLED;
+                  }
+                  else
+                    wxUsleep(10);
+            }
+            else
+                wxUsleep(10);
         } while ( result != NO_ERROR );
 #else // !wxUSE_GUI
         // simply wait for the thread to terminate
@@ -811,7 +815,7 @@ wxThreadError wxThread::Delete(ExitCode *pRc)
 
         if ( IsMain() )
         {
-            gs_bWaitingForThread = FALSE;
+            gs_bWaitingForThread = false;
         }
     }
 
@@ -858,9 +862,7 @@ wxThreadError wxThread::Kill()
     return wxTHREAD_NO_ERROR;
 }
 
-void wxThread::Exit(
-  ExitCode                          pStatus
-)
+void wxThread::Exit(ExitCode WXUNUSED(pStatus))
 {
     delete this;
     _endthread();
@@ -942,13 +944,13 @@ bool wxThreadModule::OnInit()
     gs_pCritsectGui = new wxCriticalSection();
     gs_pCritsectGui->Enter();
 
-    PTIB                            ptib;
-    PPIB                            ppib;
+    PTIB ptib;
+    PPIB ppib;
 
     ::DosGetInfoBlocks(&ptib, &ppib);
 
     s_ulIdMainThread = ptib->tib_ptib2->tib2_ultid;
-    return TRUE;
+    return true;
 }
 
 void wxThreadModule::OnExit()
@@ -1011,7 +1013,7 @@ void WXDLLEXPORT wxMutexGuiLeave()
 
     if ( wxThread::IsMain() )
     {
-        gs_bGuiOwnedByMainThread = FALSE;
+        gs_bGuiOwnedByMainThread = false;
     }
     else
     {
@@ -1042,7 +1044,7 @@ void WXDLLEXPORT wxMutexGuiLeaveOrEnter()
         {
             gs_pCritsectGui->Enter();
 
-            gs_bGuiOwnedByMainThread = TRUE;
+            gs_bGuiOwnedByMainThread = true;
         }
         //else: already have it, nothing to do
     }