no real changes, just extract private classes from msw/dc.cpp into a private header...

[wxWidgets.git] / src / msw / utilsexc.cpp

diff --git a/src/msw/utilsexc.cpp b/src/msw/utilsexc.cpp
index 60dc54d9e1738c628c5f746dd33cd83cfd2b65f9..5d2e0b52cb8fca4b7c19ae9c46265c304f92beba 100644 (file)
--- a/src/msw/utilsexc.cpp
+++ b/src/msw/utilsexc.cpp
@@ -36,15 +36,17 @@
 #endif
 
 #include "wx/process.h"
 #endif
 
 #include "wx/process.h"

-
+#include "wx/thread.h"

 #include "wx/apptrait.h"
 #include "wx/apptrait.h"

+#include "wx/evtloop.h"
+#include "wx/vector.h"

 
 
 #include "wx/msw/private.h"
 
 #include <ctype.h>
 
 
 
 #include "wx/msw/private.h"
 
 #include <ctype.h>
 

-#if !defined(__GNUWIN32__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
+#if !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)

     #include <direct.h>
 #ifndef __MWERKS__
     #include <dos.h>
     #include <direct.h>
 #ifndef __MWERKS__
     #include <dos.h>


@@ -101,6 +103,13 @@ wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
 static const wxChar *wxMSWEXEC_WNDCLASSNAME = wxT("_wxExecute_Internal_Class");
 static const wxChar *gs_classForHiddenWindow = NULL;
 
 static const wxChar *wxMSWEXEC_WNDCLASSNAME = wxT("_wxExecute_Internal_Class");
 static const wxChar *gs_classForHiddenWindow = NULL;
 

+// event used to wake up threads waiting in wxExecuteThread
+static HANDLE gs_heventShutdown = NULL;
+
+// handles of all threads monitoring the execution of asynchronously running
+// processes
+static wxVector<HANDLE> gs_asyncThreads;
+

 // ----------------------------------------------------------------------------
 // private types
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private types
 // ----------------------------------------------------------------------------


@@ -131,7 +140,44 @@ public:
     virtual bool OnInit() { return true; }
     virtual void OnExit()
     {
     virtual bool OnInit() { return true; }
     virtual void OnExit()
     {

-        if ( *gs_classForHiddenWindow )
+        if ( gs_heventShutdown )
+        {
+            // stop any threads waiting for the termination of asynchronously
+            // running processes
+            if ( !::SetEvent(gs_heventShutdown) )
+            {
+                wxLogDebug(_T("Failed to set shutdown event in wxExecuteModule"));
+            }
+
+            ::CloseHandle(gs_heventShutdown);
+            gs_heventShutdown = NULL;
+
+            // now wait until they terminate
+            if ( !gs_asyncThreads.empty() )
+            {
+                const size_t numThreads = gs_asyncThreads.size();
+
+                if ( ::WaitForMultipleObjects
+                       (
+                        numThreads,
+                        &gs_asyncThreads[0],
+                        TRUE,   // wait for all of them to become signalled
+                        3000    // long but finite value
+                       ) == WAIT_TIMEOUT )
+                {
+                    wxLogDebug(_T("Failed to stop all wxExecute monitor threads"));
+                }
+
+                for ( size_t n = 0; n < numThreads; n++ )
+                {
+                    ::CloseHandle(gs_asyncThreads[n]);
+                }
+
+                gs_asyncThreads.clear();
+            }
+        }
+
+        if ( gs_classForHiddenWindow )

         {
             if ( !::UnregisterClass(wxMSWEXEC_WNDCLASSNAME, wxGetInstance()) )
             {
         {
             if ( !::UnregisterClass(wxMSWEXEC_WNDCLASSNAME, wxGetInstance()) )
             {


@@ -146,6 +192,8 @@ private:
     DECLARE_DYNAMIC_CLASS(wxExecuteModule)
 };
 
     DECLARE_DYNAMIC_CLASS(wxExecuteModule)
 };
 

+IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule)
+

 #if wxUSE_STREAMS && !defined(__WXWINCE__)
 
 // ----------------------------------------------------------------------------
 #if wxUSE_STREAMS && !defined(__WXWINCE__)
 
 // ----------------------------------------------------------------------------


@@ -170,7 +218,7 @@ protected:
 protected:
     HANDLE m_hInput;
 
 protected:
     HANDLE m_hInput;
 

-    DECLARE_NO_COPY_CLASS(wxPipeInputStream)
+    wxDECLARE_NO_COPY_CLASS(wxPipeInputStream);

 };
 
 class wxPipeOutputStream: public wxOutputStream
 };
 
 class wxPipeOutputStream: public wxOutputStream


@@ -186,7 +234,7 @@ protected:
 protected:
     HANDLE m_hOutput;
 
 protected:
     HANDLE m_hOutput;
 

-    DECLARE_NO_COPY_CLASS(wxPipeOutputStream)
+    wxDECLARE_NO_COPY_CLASS(wxPipeOutputStream);

 };
 
 // define this to let wxexec.cpp know that we know what we're doing
 };
 
 // define this to let wxexec.cpp know that we know what we're doing


@@ -281,22 +329,48 @@ static DWORD __stdcall wxExecuteThread(void *arg)
 {
     wxExecuteData * const data = (wxExecuteData *)arg;
 
 {
     wxExecuteData * const data = (wxExecuteData *)arg;
 

-    if ( ::WaitForSingleObject(data->hProcess, INFINITE) != WAIT_OBJECT_0 )
+    // create the shutdown event if we're the first thread starting to wait
+    if ( !gs_heventShutdown )

     {
     {

-        wxLogDebug(_T("Waiting for the process termination failed!"));
+        // create a manual initially non-signalled event object
+        gs_heventShutdown = ::CreateEvent(NULL, TRUE, FALSE, NULL);
+        if ( !gs_heventShutdown )
+        {
+            wxLogDebug(_T("CreateEvent() in wxExecuteThread failed"));
+        }

     }
 
     }
 

-    // get the exit code
-    if ( !::GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
+    HANDLE handles[2] = { data->hProcess, gs_heventShutdown };
+    switch ( ::WaitForMultipleObjects(2, handles, FALSE, INFINITE) )

     {
     {

-        wxLogLastError(wxT("GetExitCodeProcess"));
-    }
+        case WAIT_OBJECT_0:
+            // process terminated, get its exit code
+            if ( !::GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
+            {
+                wxLogLastError(wxT("GetExitCodeProcess"));
+            }

 
 

-    wxASSERT_MSG( data->dwExitCode != STILL_ACTIVE,
-                  wxT("process should have terminated") );
+            wxASSERT_MSG( data->dwExitCode != STILL_ACTIVE,
+                          wxT("process should have terminated") );

 
 

-    // send a message indicating process termination to the window
-    ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
+            // send a message indicating process termination to the window
+            ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
+            break;
+
+        case WAIT_OBJECT_0 + 1:
+            // we're shutting down but the process is still running -- leave it
+            // run but clean up the associated data
+            if ( !data->state )
+            {
+                delete data;
+            }
+            //else: exiting while synchronously executing process is still
+            //      running? this shouldn't happen...
+            break;
+
+        default:
+            wxLogDebug(_T("Waiting for the process termination failed!"));
+    }

 
     return 0;
 }
 
     return 0;
 }


@@ -321,7 +395,7 @@ LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
         {
             // we're executing synchronously, tell the waiting thread
             // that the process finished
         {
             // we're executing synchronously, tell the waiting thread
             // that the process finished

-            data->state = 0;
+            data->state = false;

         }
         else
         {
         }
         else
         {


@@ -360,8 +434,19 @@ wxPipeInputStream::~wxPipeInputStream()
 
 bool wxPipeInputStream::CanRead() const
 {
 
 bool wxPipeInputStream::CanRead() const
 {

+    // we can read if there's something in the put back buffer
+    // even pipe is closed
+    if ( m_wbacksize > m_wbackcur )
+        return true;
+
+    wxPipeInputStream * const self = wxConstCast(this, wxPipeInputStream);
+

     if ( !IsOpened() )
     if ( !IsOpened() )

+    {
+        // set back to mark Eof as it may have been unset by Ungetch()
+        self->m_lasterror = wxSTREAM_EOF;

         return false;
         return false;

+    }

 
     DWORD nAvailable;
 
 
     DWORD nAvailable;
 


@@ -387,8 +472,6 @@ bool wxPipeInputStream::CanRead() const
         // it had been closed
         ::CloseHandle(m_hInput);
 
         // it had been closed
         ::CloseHandle(m_hInput);
 

-        wxPipeInputStream *self = wxConstCast(this, wxPipeInputStream);
-

         self->m_hInput = INVALID_HANDLE_VALUE;
         self->m_lasterror = wxSTREAM_EOF;
 
         self->m_hInput = INVALID_HANDLE_VALUE;
         self->m_lasterror = wxSTREAM_EOF;
 


@@ -817,6 +900,9 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
     {
         // may be NULL or not
         data->handler = handler;
     {
         // may be NULL or not
         data->handler = handler;

+
+        if (handler)
+            handler->SetPid(pi.dwProcessId);

     }
 
     DWORD tid;
     }
 
     DWORD tid;


@@ -850,7 +936,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
         return pi.dwProcessId;
     }
 
         return pi.dwProcessId;
     }
 

-    ::CloseHandle(hThread);
+    gs_asyncThreads.push_back(hThread);

 
 #if wxUSE_IPC && !defined(__WXWINCE__)
     // second part of DDE hack: now establish the DDE conversation with the
 
 #if wxUSE_IPC && !defined(__WXWINCE__)
     // second part of DDE hack: now establish the DDE conversation with the


@@ -914,16 +1000,27 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
     while ( data->state )
     {
 #if wxUSE_STREAMS && !defined(__WXWINCE__)
     while ( data->state )
     {
 #if wxUSE_STREAMS && !defined(__WXWINCE__)

-        bufOut.Update();
-        bufErr.Update();
+        if ( !bufOut.Update() && !bufErr.Update() )

 #endif // wxUSE_STREAMS
 #endif // wxUSE_STREAMS

+        {
+            // don't eat 100% of the CPU -- ugly but anything else requires
+            // real async IO which we don't have for the moment
+            ::Sleep(50);
+        }

 
 

-        // don't eat 100% of the CPU -- ugly but anything else requires
-        // real async IO which we don't have for the moment
-        ::Sleep(50);
+        // we must always process messages for our hidden window or we'd never
+        // get wxWM_PROC_TERMINATED and so this loop would never terminate
+        MSG msg;
+        ::PeekMessage(&msg, data->hWnd, 0, 0, PM_REMOVE);

 
 

-        // we must process messages or we'd never get wxWM_PROC_TERMINATED
-        traits->AlwaysYield();
+        // we may also need to process messages for all the other application
+        // windows
+        if ( !(flags & wxEXEC_NOEVENTS) )
+        {
+            wxEventLoopBase * const loop = wxEventLoopBase::GetActive();
+            if ( loop )
+                loop->Yield();
+        }

     }
 
     if ( !(flags & wxEXEC_NODISABLE) )
     }
 
     if ( !(flags & wxEXEC_NODISABLE) )


@@ -939,18 +1036,59 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
     return dwExitCode;
 }
 
     return dwExitCode;
 }
 

-long wxExecute(wxChar **argv, int flags, wxProcess *handler)
+template <typename CharType>
+long wxExecuteImpl(CharType **argv, int flags, wxProcess *handler)

 {
     wxString command;
 {
     wxString command;

+    command.reserve(1024);

 
 

+    wxString arg;

     for ( ;; )
     {
     for ( ;; )
     {

-        command += *argv++;
+        arg = *argv++;
+
+        bool quote;
+        if ( arg.empty() )
+        {
+            // we need to quote empty arguments, otherwise they'd just
+            // disappear
+            quote = true;
+        }
+        else // non-empty
+        {
+            // escape any quotes present in the string to avoid interfering
+            // with the command line parsing in the child process
+            arg.Replace("\"", "\\\"", true /* replace all */);
+
+            // and quote any arguments containing the spaces to prevent them from
+            // being broken down
+            quote = arg.find_first_of(" \t") != wxString::npos;
+        }
+
+        if ( quote )
+            command += '\"' + arg + '\"';
+        else
+            command += arg;
+

         if ( !*argv )
             break;
 
         if ( !*argv )
             break;
 

-        command += _T(' ');
+        command += ' ';

     }
 
     return wxExecute(command, flags, handler);
 }
     }
 
     return wxExecute(command, flags, handler);
 }

+
+long wxExecute(char **argv, int flags, wxProcess *handler)
+{
+    return wxExecuteImpl(argv, flags, handler);
+}
+
+#if wxUSE_UNICODE
+
+long wxExecute(wchar_t **argv, int flags, wxProcess *handler)
+{
+    return wxExecuteImpl(argv, flags, handler);
+}
+
+#endif // wxUSE_UNICODE