/////////////////////////////////////////////////////////////////////////////
-// 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
/////////////////////////////////////////////////////////////////////////////
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#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 <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>
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
// ----------------------------------------------------------------------------
public:
~wxExecuteData()
{
-#ifndef __WIN16__
if ( !::CloseHandle(hProcess) )
{
wxLogLastError(wxT("CloseHandle(hProcess)"));
}
-#endif
}
HWND hWnd; // window to send wxWM_PROC_TERMINATED to
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
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;
DECLARE_DYNAMIC_CLASS(wxExecuteModule)
};
+IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule)
+
#if wxUSE_STREAMS && !defined(__WXWINCE__)
// ----------------------------------------------------------------------------
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:
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);
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
// 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
{
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;
{
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;
}
{
// we're executing synchronously, tell the waiting thread
// that the process finished
- data->state = 0;
+ data->state = false;
}
else
{
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;
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;
: 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;
}
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
#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 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
{
#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, 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;
// case we execute just <command> 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);
ddeCommand.reserve(256);
const wxChar *p = cmd.c_str() + 7;
- while ( *p && *p != _T('#') )
+ while ( *p && *p != wxT('#') )
{
command += *p++;
}
}
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++;
}
}
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++;
}
}
else
{
- wxFAIL_MSG(_T("invalid WX_DDE command in wxExecute"));
+ wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute"));
}
while ( *p )
DUPLICATE_SAME_ACCESS // same access as for src handle
) )
{
- wxLogLastError(_T("DuplicateHandle"));
+ wxLogLastError(wxT("DuplicateHandle"));
}
::CloseHandle(pipeInWrite);
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
+ wxWxCharBuffer envBuffer;
+ bool useCwd = false;
+ if ( env )
+ {
+ 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;
+ }
+ }
+
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
+ envBuffer.data(), // environment (may be NULL which is fine)
+ useCwd // initial working directory
+ ? const_cast<wxChar *>(env->cwd.wx_str())
+ : NULL, // (or use the same)
+ &si, // startup info (unused here)
+ &pi // process info
) != 0;
#if wxUSE_STREAMS && !defined(__WXWINCE__)
{
// may be NULL or not
data->handler = handler;
+
+ if (handler)
+ handler->SetPid(pi.dwProcessId);
}
DWORD tid;
// close unneeded handle
if ( !::CloseHandle(pi.hThread) )
+ {
wxLogLastError(wxT("CloseHandle(hThread)"));
+ }
if ( !hThread )
{
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
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:
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());
}
}
}
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;
return dwExitCode;
}
-long wxExecute(wxChar **argv, int flags, wxProcess *handler)
+template <typename CharType>
+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
projects / wxWidgets.git / blobdiff