X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/38c39207e99b6446b3a5b09667f2706c64aae91a..07aaf32633ecf18ec3edfbb41793a112914792d0:/src/msw/utilsexc.cpp diff --git a/src/msw/utilsexc.cpp b/src/msw/utilsexc.cpp index b8de30fdff..9c959de05e 100644 --- a/src/msw/utilsexc.cpp +++ b/src/msw/utilsexc.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: msw/utilsexec.cpp +// Name: src/msw/utilsexc.cpp // Purpose: wxExecute implementation for MSW // Author: Julian Smart // Modified by: @@ -29,25 +29,27 @@ #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 #endif -#endif #if defined(__GNUWIN32__) #include @@ -78,9 +80,16 @@ #include "wx/dde.h" // for WX_DDE hack in wxExecute #endif // wxUSE_IPC -// implemented in utils.cpp -extern "C" WXDLLIMPEXP_BASE HWND -wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc); +#include "wx/msw/private/hiddenwin.h" + +// FIXME-VC6: These are not defined in VC6 SDK headers. +#ifndef BELOW_NORMAL_PRIORITY_CLASS + #define BELOW_NORMAL_PRIORITY_CLASS 0x4000 +#endif + +#ifndef ABOVE_NORMAL_PRIORITY_CLASS + #define ABOVE_NORMAL_PRIORITY_CLASS 0x8000 +#endif // ---------------------------------------------------------------------------- // constants @@ -99,6 +108,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 // ---------------------------------------------------------------------------- @@ -129,11 +145,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; @@ -144,6 +197,8 @@ private: DECLARE_DYNAMIC_CLASS(wxExecuteModule) }; +IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule) + #if wxUSE_STREAMS && !defined(__WXWINCE__) // ---------------------------------------------------------------------------- @@ -168,7 +223,7 @@ protected: protected: HANDLE m_hInput; - DECLARE_NO_COPY_CLASS(wxPipeInputStream) + wxDECLARE_NO_COPY_CLASS(wxPipeInputStream); }; class wxPipeOutputStream: public wxOutputStream @@ -184,7 +239,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 @@ -279,22 +334,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") ); + + // send a message indicating process termination to the window + ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data); + break; - wxASSERT_MSG( data->dwExitCode != STILL_ACTIVE, - wxT("process should have terminated") ); + 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; - // send a message indicating process termination to the window - ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data); + default: + wxLogDebug(wxT("Waiting for the process termination failed!")); + } return 0; } @@ -319,7 +400,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 { @@ -358,8 +439,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() ) + { + // set back to mark Eof as it may have been unset by Ungetch() + self->m_lasterror = wxSTREAM_EOF; return false; + } DWORD nAvailable; @@ -378,15 +470,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 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; @@ -437,7 +527,7 @@ wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput) NULL // timeout (we don't set it neither) ) ) { - wxLogLastError(_T("SetNamedPipeHandleState(PIPE_NOWAIT)")); + wxLogLastError(wxT("SetNamedPipeHandleState(PIPE_NOWAIT)")); } } @@ -525,7 +615,8 @@ wxExecuteDDE(const wxString& ddeServer, #endif // wxUSE_IPC -long wxExecute(const wxString& cmd, int flags, wxProcess *handler) +long wxExecute(const wxString& cmd, int flags, wxProcess *handler, + const wxExecuteEnv *env) { wxCHECK_MSG( !cmd.empty(), 0, wxT("empty command in wxExecute") ); @@ -534,7 +625,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) // 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; @@ -550,7 +641,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); @@ -558,7 +649,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++; } @@ -570,10 +661,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++; } @@ -585,10 +676,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++; } @@ -600,7 +691,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 ) @@ -671,15 +762,6 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) si.hStdOutput = pipeOut[wxPipe::Write]; si.hStdError = pipeErr[wxPipe::Write]; - // when the std IO is redirected, we don't show the (console) process - // window by default, but this can be overridden by the caller by - // specifying wxEXEC_NOHIDE flag - if ( !(flags & wxEXEC_NOHIDE) ) - { - si.dwFlags |= STARTF_USESHOWWINDOW; - si.wShowWindow = SW_HIDE; - } - // we must duplicate the handle to the write side of stdin pipe to make // it non inheritable: indeed, we must close the writing end of pipeIn // before launching the child process as otherwise this handle will be @@ -697,56 +779,132 @@ 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); } #endif // wxUSE_STREAMS + // The default logic for showing the console is to show it only if the IO + // is not redirected however wxEXEC_{SHOW,HIDE}_CONSOLE flags can be + // explicitly specified to change it. + if ( (flags & wxEXEC_HIDE_CONSOLE) || + (redirect && !(flags & wxEXEC_SHOW_CONSOLE)) ) + { + si.dwFlags |= STARTF_USESHOWWINDOW; + si.wShowWindow = SW_HIDE; + } + + PROCESS_INFORMATION pi; DWORD dwFlags = CREATE_SUSPENDED; #ifndef __WXWINCE__ + if ( (flags & wxEXEC_MAKE_GROUP_LEADER) && + (wxGetOsVersion() == wxOS_WINDOWS_NT) ) + dwFlags |= CREATE_NEW_PROCESS_GROUP; + dwFlags |= CREATE_DEFAULT_ERROR_MODE ; #else - wxString moduleName; - wxString arguments; - int idx = command.Find( wxT(' ') ); - if( idx >= 0 ) + // we are assuming commands without spaces for now + wxString moduleName = command.BeforeFirst(wxT(' ')); + wxString arguments = command.AfterFirst(wxT(' ')); +#endif + + wxWxCharBuffer envBuffer; + bool useCwd = false; + if ( env ) { - moduleName = command.Left(idx); - arguments = command.Mid(idx+1); + useCwd = !env->cwd.empty(); + + // Translate environment variable map into NUL-terminated list of + // NUL-terminated strings. + if ( !env->env.empty() ) + { +#if wxUSE_UNICODE + // Environment variables can contain non-ASCII characters. We could + // check for it and not use this flag if everything is really ASCII + // only but there doesn't seem to be any reason to do it so just + // assume Unicode by default. + dwFlags |= CREATE_UNICODE_ENVIRONMENT; +#endif // wxUSE_UNICODE + + wxEnvVariableHashMap::const_iterator it; + + size_t envSz = 1; // ending '\0' + for ( it = env->env.begin(); it != env->env.end(); ++it ) + { + // Add size of env variable name and value, and '=' char and + // ending '\0' + envSz += it->first.length() + it->second.length() + 2; + } + + envBuffer.extend(envSz); + + wxChar *p = envBuffer.data(); + for ( it = env->env.begin(); it != env->env.end(); ++it ) + { + const wxString line = it->first + wxS("=") + it->second; + + // Include the trailing NUL which will always terminate the + // buffer returned by t_str(). + const size_t len = line.length() + 1; + + wxTmemcpy(p, line.t_str(), len); + + p += len; + } + + // And another NUL to terminate the list of NUL-terminated strings. + *p = 0; + } } - else + + // Translate wxWidgets priority to Windows conventions. + if ( handler ) { - moduleName = command; + unsigned prio = handler->GetPriority(); + if ( prio <= 20 ) + dwFlags |= IDLE_PRIORITY_CLASS; + else if ( prio <= 40 ) + dwFlags |= BELOW_NORMAL_PRIORITY_CLASS; + else if ( prio <= 60 ) + dwFlags |= NORMAL_PRIORITY_CLASS; + else if ( prio <= 80 ) + dwFlags |= ABOVE_NORMAL_PRIORITY_CLASS; + else if ( prio <= 99 ) + dwFlags |= HIGH_PRIORITY_CLASS; + else if ( prio <= 100 ) + dwFlags |= REALTIME_PRIORITY_CLASS; + else + { + wxFAIL_MSG(wxT("invalid value of thread priority parameter")); + dwFlags |= NORMAL_PRIORITY_CLASS; + } } -#endif bool ok = ::CreateProcess ( - // WinCE requires appname to be non null + // WinCE requires appname to be non null // Win32 allows for null #ifdef __WXWINCE__ - (wxChar *) - moduleName.c_str(), // application name - (wxChar *) - arguments.c_str(), // arguments - + moduleName.t_str(), // application name + wxMSW_CONV_LPTSTR(arguments), // arguments #else - NULL, // application name (use only cmd line) - (wxChar *) - command.c_str(), // full command line + NULL, // application name (use only cmd line) + wxMSW_CONV_LPTSTR(command), // 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 + NULL, // security attributes: defaults for both + NULL, // the process and its main thread + redirect, // inherit handles if we use pipes + dwFlags, // process creation flags + envBuffer.data(), // environment (may be NULL which is fine) + useCwd // initial working directory + ? wxMSW_CONV_LPTSTR(env->cwd) + : NULL, // (or use the same) + &si, // startup info (unused here) + &pi // process info ) != 0; #if wxUSE_STREAMS && !defined(__WXWINCE__) @@ -825,6 +983,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; @@ -845,7 +1006,9 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) // close unneeded handle if ( !::CloseHandle(pi.hThread) ) + { wxLogLastError(wxT("CloseHandle(hThread)")); + } if ( !hThread ) { @@ -858,14 +1021,14 @@ 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 // just launched process if ( !ddeServer.empty() ) { - bool ok; + bool ddeOK; // give the process the time to init itself // @@ -875,26 +1038,26 @@ 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")); + case WAIT_FAILED: + wxLogLastError(wxT("WaitForInputIdle() in wxExecute")); case WAIT_TIMEOUT: - wxLogDebug(_T("Timeout too small in WaitForInputIdle")); + wxLogDebug(wxT("Timeout too small in WaitForInputIdle")); - ok = false; + ddeOK = false; break; case 0: // ok, process ready to accept DDE requests - ok = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand); + ddeOK = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand); } - if ( !ok ) + if ( !ddeOK ) { - 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()); } } @@ -909,7 +1072,7 @@ 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()?") ); void *cookie = NULL; if ( !(flags & wxEXEC_NODISABLE) ) @@ -922,16 +1085,27 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler) 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(); + } } if ( !(flags & wxEXEC_NODISABLE) ) @@ -947,19 +1121,62 @@ 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, + const wxExecuteEnv *env) { 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); + return wxExecute(command, flags, handler, env); +} + +long wxExecute(char **argv, int flags, wxProcess *handler, + const wxExecuteEnv *env) +{ + return wxExecuteImpl(argv, flags, handler, env); +} + +#if wxUSE_UNICODE + +long wxExecute(wchar_t **argv, int flags, wxProcess *handler, + const wxExecuteEnv *env) +{ + return wxExecuteImpl(argv, flags, handler, env); } +#endif // wxUSE_UNICODE