X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/487f2d58e9d1c28cc54e9800affd91623adadac7..ca1f7cb56322e35a5bf3d9612cd14c128246947c:/src/msw/utilsexc.cpp diff --git a/src/msw/utilsexc.cpp b/src/msw/utilsexc.cpp index 17b1c30a40..8e86fb663c 100644 --- a/src/msw/utilsexc.cpp +++ b/src/msw/utilsexc.cpp @@ -1,11 +1,11 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msw/utilsexec.cpp +// Name: src/msw/utilsexc.cpp // Purpose: wxExecute implementation for MSW // Author: Julian Smart // Modified by: // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) 1998-2002 wxWindows dev team +// Copyright: (c) 1998-2002 wxWidgets dev team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -33,20 +29,24 @@ #include "wx/app.h" #include "wx/intl.h" #include "wx/log.h" + #if wxUSE_STREAMS + #include "wx/stream.h" + #endif + #include "wx/module.h" #endif -#include "wx/stream.h" #include "wx/process.h" - +#include "wx/thread.h" #include "wx/apptrait.h" +#include "wx/evtloop.h" +#include "wx/vector.h" -#include "wx/module.h" #include "wx/msw/private.h" #include -#if !defined(__GNUWIN32__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) +#if !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__) #include #ifndef __MWERKS__ #include @@ -103,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; +// 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 gs_asyncThreads; + // ---------------------------------------------------------------------------- // private types // ---------------------------------------------------------------------------- @@ -113,12 +120,10 @@ struct wxExecuteData public: ~wxExecuteData() { -#ifndef __WIN16__ if ( !::CloseHandle(hProcess) ) { wxLogLastError(wxT("CloseHandle(hProcess)")); } -#endif } HWND hWnd; // window to send wxWM_PROC_TERMINATED to @@ -126,7 +131,7 @@ public: DWORD dwProcessId; // pid of the process wxProcess *handler; DWORD dwExitCode; // the exit code of the process - bool state; // set to FALSE when the process finishes + bool state; // set to false when the process finishes }; class wxExecuteModule : public wxModule @@ -135,11 +140,48 @@ public: 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(wxT("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(wxT("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()) ) { - wxLogLastError(_T("UnregisterClass(wxExecClass)")); + wxLogLastError(wxT("UnregisterClass(wxExecClass)")); } gs_classForHiddenWindow = NULL; @@ -150,6 +192,8 @@ private: DECLARE_DYNAMIC_CLASS(wxExecuteModule) }; +IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule) + #if wxUSE_STREAMS && !defined(__WXWINCE__) // ---------------------------------------------------------------------------- @@ -162,10 +206,10 @@ public: wxPipeInputStream(HANDLE hInput); virtual ~wxPipeInputStream(); - // returns TRUE if the pipe is still opened + // returns true if the pipe is still opened bool IsOpened() const { return m_hInput != INVALID_HANDLE_VALUE; } - // returns TRUE if there is any data to be read from the pipe + // returns true if there is any data to be read from the pipe virtual bool CanRead() const; protected: @@ -174,14 +218,15 @@ protected: protected: HANDLE m_hInput; - DECLARE_NO_COPY_CLASS(wxPipeInputStream) + wxDECLARE_NO_COPY_CLASS(wxPipeInputStream); }; class wxPipeOutputStream: public wxOutputStream { public: wxPipeOutputStream(HANDLE hOutput); - virtual ~wxPipeOutputStream(); + virtual ~wxPipeOutputStream() { Close(); } + bool Close(); protected: size_t OnSysWrite(const void *buffer, size_t len); @@ -189,7 +234,7 @@ protected: 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 @@ -213,7 +258,7 @@ public: // default ctor doesn't do anything wxPipe() { m_handles[Read] = m_handles[Write] = INVALID_HANDLE_VALUE; } - // create the pipe, return TRUE if ok, FALSE on error + // create the pipe, return true if ok, false on error bool Create() { // default secutiry attributes @@ -227,31 +272,22 @@ public: { wxLogSysError(_("Failed to create an anonymous pipe")); - return FALSE; + return false; } - return TRUE; + return true; } - // return TRUE if we were created successfully + // return true if we were created successfully bool IsOk() const { return m_handles[Read] != INVALID_HANDLE_VALUE; } // return the descriptor for one of the pipe ends - HANDLE operator[](Direction which) const - { - wxASSERT_MSG( which >= 0 && (size_t)which < WXSIZEOF(m_handles), - _T("invalid pipe index") ); - - return m_handles[which]; - } + HANDLE operator[](Direction which) const { return m_handles[which]; } // detach a descriptor, meaning that the pipe dtor won't close it, and // return it HANDLE Detach(Direction which) { - wxASSERT_MSG( which >= 0 && (size_t)which < WXSIZEOF(m_handles), - _T("invalid pipe index") ); - HANDLE handle = m_handles[which]; m_handles[which] = INVALID_HANDLE_VALUE; @@ -293,22 +329,48 @@ static DWORD __stdcall wxExecuteThread(void *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(wxT("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(wxT("Waiting for the process termination failed!")); + } return 0; } @@ -333,7 +395,7 @@ LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message, { // we're executing synchronously, tell the waiting thread // that the process finished - data->state = 0; + data->state = false; } else { @@ -372,8 +434,19 @@ wxPipeInputStream::~wxPipeInputStream() 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() ) - return FALSE; + { + // set back to mark Eof as it may have been unset by Ungetch() + self->m_lasterror = wxSTREAM_EOF; + return false; + } DWORD nAvailable; @@ -392,15 +465,13 @@ bool wxPipeInputStream::CanRead() const if ( ::GetLastError() != ERROR_BROKEN_PIPE ) { // unexpected error - wxLogLastError(_T("PeekNamedPipe")); + wxLogLastError(wxT("PeekNamedPipe")); } - // don't try to continue reading from a pipe if an error occured or if + // don't try to continue reading from a pipe if an error occurred or if // it had been closed ::CloseHandle(m_hInput); - wxPipeInputStream *self = wxConstCast(this, wxPipeInputStream); - self->m_hInput = INVALID_HANDLE_VALUE; self->m_lasterror = wxSTREAM_EOF; @@ -427,7 +498,7 @@ size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len) : wxSTREAM_READ_ERROR; } - // bytesRead is set to 0, as desired, if an error occured + // bytesRead is set to 0, as desired, if an error occurred return bytesRead; } @@ -438,26 +509,54 @@ size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len) wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput) { m_hOutput = hOutput; + + // unblock the pipe to prevent deadlocks when we're writing to the pipe + // from which the child process can't read because it is writing in its own + // end of it + DWORD mode = PIPE_READMODE_BYTE | PIPE_NOWAIT; + if ( !::SetNamedPipeHandleState + ( + m_hOutput, + &mode, + NULL, // collection count (we don't set it) + NULL // timeout (we don't set it neither) + ) ) + { + wxLogLastError(wxT("SetNamedPipeHandleState(PIPE_NOWAIT)")); + } } -wxPipeOutputStream::~wxPipeOutputStream() +bool wxPipeOutputStream::Close() { - ::CloseHandle(m_hOutput); + return ::CloseHandle(m_hOutput) != 0; } + size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len) { - DWORD bytesWritten; - m_lasterror = wxSTREAM_NO_ERROR; - if ( !::WriteFile(m_hOutput, buffer, len, &bytesWritten, NULL) ) + + DWORD totalWritten = 0; + while ( len > 0 ) { - m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE - ? wxSTREAM_EOF - : wxSTREAM_WRITE_ERROR; + DWORD chunkWritten; + if ( !::WriteFile(m_hOutput, buffer, len, &chunkWritten, NULL) ) + { + m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE + ? wxSTREAM_EOF + : wxSTREAM_WRITE_ERROR; + break; + } + + if ( !chunkWritten ) + break; + + buffer = (char *)buffer + chunkWritten; + totalWritten += chunkWritten; + len -= chunkWritten; } - return bytesWritten; + return totalWritten; } #endif // wxUSE_STREAMS @@ -469,19 +568,19 @@ size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len) #if wxUSE_IPC // connect to the given server via DDE and ask it to execute the command -static bool wxExecuteDDE(const wxString& ddeServer, - const wxString& ddeTopic, - const wxString& ddeCommand) +bool +wxExecuteDDE(const wxString& ddeServer, + const wxString& ddeTopic, + const wxString& ddeCommand) { - bool ok = FALSE; + bool ok wxDUMMY_INITIALIZE(false); wxDDEClient client; - wxConnectionBase *conn = client.MakeConnection(wxEmptyString, - ddeServer, - ddeTopic); + wxConnectionBase * + conn = client.MakeConnection(wxEmptyString, ddeServer, ddeTopic); if ( !conn ) { - ok = FALSE; + ok = false; } else // connected to DDE server { @@ -513,14 +612,14 @@ static bool wxExecuteDDE(const wxString& ddeServer, long wxExecute(const wxString& cmd, int flags, wxProcess *handler) { - wxCHECK_MSG( !!cmd, 0, wxT("empty command in wxExecute") ); + wxCHECK_MSG( !cmd.empty(), 0, wxT("empty command in wxExecute") ); #if wxUSE_THREADS // for many reasons, the code below breaks down if it's called from another // thread -- this could be fixed, but as Unix versions don't support this // neither I don't want to waste time on this now wxASSERT_MSG( wxThread::IsMain(), - _T("wxExecute() can be called only from the main thread") ); + wxT("wxExecute() can be called only from the main thread") ); #endif // wxUSE_THREADS wxString command; @@ -536,7 +635,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) // case we execute just and process the rest below wxString ddeServer, ddeTopic, ddeCommand; static const size_t lenDdePrefix = 7; // strlen("WX_DDE:") - if ( cmd.Left(lenDdePrefix) == _T("WX_DDE#") ) + if ( cmd.Left(lenDdePrefix) == wxT("WX_DDE#") ) { // speed up the concatenations below ddeServer.reserve(256); @@ -544,7 +643,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) ddeCommand.reserve(256); const wxChar *p = cmd.c_str() + 7; - while ( *p && *p != _T('#') ) + while ( *p && *p != wxT('#') ) { command += *p++; } @@ -556,10 +655,10 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) } else { - wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute")); + wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute")); } - while ( *p && *p != _T('#') ) + while ( *p && *p != wxT('#') ) { ddeServer += *p++; } @@ -571,10 +670,10 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) } else { - wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute")); + wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute")); } - while ( *p && *p != _T('#') ) + while ( *p && *p != wxT('#') ) { ddeTopic += *p++; } @@ -586,7 +685,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) } else { - wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute")); + wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute")); } while ( *p ) @@ -683,7 +782,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) DUPLICATE_SAME_ACCESS // same access as for src handle ) ) { - wxLogLastError(_T("DuplicateHandle")); + wxLogLastError(wxT("DuplicateHandle")); } ::CloseHandle(pipeInWrite); @@ -692,23 +791,37 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) PROCESS_INFORMATION pi; DWORD dwFlags = CREATE_SUSPENDED; + #ifndef __WXWINCE__ dwFlags |= CREATE_DEFAULT_ERROR_MODE ; +#else + // we are assuming commands without spaces for now + wxString moduleName = command.BeforeFirst(wxT(' ')); + wxString arguments = command.AfterFirst(wxT(' ')); #endif bool ok = ::CreateProcess ( - NULL, // application name (use only cmd line) + // WinCE requires appname to be non null + // Win32 allows for null +#ifdef __WXWINCE__ (wxChar *) - command.c_str(), // full command line - NULL, // security attributes: defaults for both - NULL, // the process and its main thread - redirect, // inherit handles if we use pipes - dwFlags, // process creation flags - NULL, // environment (use the same) - NULL, // current directory (use the same) - &si, // startup info (unused here) - &pi // process info + moduleName.wx_str(),// application name + (wxChar *) + arguments.wx_str(), // arguments +#else + NULL, // application name (use only cmd line) + (wxChar *) + command.wx_str(), // full command line +#endif + NULL, // security attributes: defaults for both + NULL, // the process and its main thread + redirect, // inherit handles if we use pipes + dwFlags, // process creation flags + NULL, // environment (use the same) + NULL, // current directory (use the same) + &si, // startup info (unused here) + &pi // process info ) != 0; #if wxUSE_STREAMS && !defined(__WXWINCE__) @@ -787,6 +900,9 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) { // may be NULL or not data->handler = handler; + + if (handler) + handler->SetPid(pi.dwProcessId); } DWORD tid; @@ -807,7 +923,9 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) // close unneeded handle if ( !::CloseHandle(pi.hThread) ) + { wxLogLastError(wxT("CloseHandle(hThread)")); + } if ( !hThread ) { @@ -820,7 +938,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) 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 @@ -837,16 +955,16 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) switch ( ::WaitForInputIdle(pi.hProcess, 10000 /* 10 seconds */) ) { default: - wxFAIL_MSG( _T("unexpected WaitForInputIdle() return code") ); + wxFAIL_MSG( wxT("unexpected WaitForInputIdle() return code") ); // fall through case -1: - wxLogLastError(_T("WaitForInputIdle() in wxExecute")); + wxLogLastError(wxT("WaitForInputIdle() in wxExecute")); case WAIT_TIMEOUT: - wxLogDebug(_T("Timeout too small in WaitForInputIdle")); + wxLogDebug(wxT("Timeout too small in WaitForInputIdle")); - ok = FALSE; + ok = false; break; case 0: @@ -856,7 +974,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) if ( !ok ) { - wxLogDebug(_T("Failed to send DDE request to the process \"%s\"."), + wxLogDebug(wxT("Failed to send DDE request to the process \"%s\"."), cmd.c_str()); } } @@ -871,28 +989,47 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) } wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; - wxCHECK_MSG( traits, -1, _T("no wxAppTraits in wxExecute()?") ); + wxCHECK_MSG( traits, -1, wxT("no wxAppTraits in wxExecute()?") ); - // disable all app windows while waiting for the child process to finish - void *cookie = traits->BeforeChildWaitLoop(); + void *cookie = NULL; + if ( !(flags & wxEXEC_NODISABLE) ) + { + // disable all app windows while waiting for the child process to finish + cookie = traits->BeforeChildWaitLoop(); + } // wait until the child process terminates while ( data->state ) { #if wxUSE_STREAMS && !defined(__WXWINCE__) - bufOut.Update(); - bufErr.Update(); + if ( !bufOut.Update() && !bufErr.Update() ) #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(); + } } - traits->AfterChildWaitLoop(cookie); + if ( !(flags & wxEXEC_NODISABLE) ) + { + // reenable disabled windows back + traits->AfterChildWaitLoop(cookie); + } DWORD dwExitCode = data->dwExitCode; delete data; @@ -901,19 +1038,59 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) return dwExitCode; } -long wxExecute(wxChar **argv, int flags, wxProcess *handler) +template +long wxExecuteImpl(CharType **argv, int flags, wxProcess *handler) { wxString command; + command.reserve(1024); + wxString arg; 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; - command += _T(' '); + command += ' '; } 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