/////////////////////////////////////////////////////////////////////////////
-// Name: msw/utilsexec.cpp
-// Purpose: Various utilities
+// Name: src/msw/utilsexc.cpp
+// Purpose: wxExecute implementation for MSW
// Author: Julian Smart
// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) 1998-2002 wxWidgets dev team
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#include "wx/utils.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/log.h"
+#include "wx/process.h"
+#include "wx/thread.h"
+#include "wx/apptrait.h"
+#include "wx/evtloop.h"
+#include "wx/vector.h"
-#ifdef __WIN32__
- #include "wx/stream.h"
- #include "wx/process.h"
-#endif
#include "wx/msw/private.h"
#include <ctype.h>
-#if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__)
+#if !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
#include <direct.h>
-#ifndef __MWERKS__
#include <dos.h>
#endif
-#endif
-#if defined(__GNUWIN32__) && !defined(__TWIN32__)
+#if defined(__GNUWIN32__)
#include <sys/unistd.h>
#include <sys/stat.h>
#endif
-#if defined(__WIN32__) && !defined(__WXWINE__)
-#include <io.h>
+#if !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
+ #ifndef __UNIX__
+ #include <io.h>
+ #endif
-#ifndef __GNUWIN32__
-#include <shellapi.h>
-#endif
+ #ifndef __GNUWIN32__
+ #include <shellapi.h>
+ #endif
#endif
#include <stdio.h>
#include "wx/dde.h" // for WX_DDE hack in wxExecute
#endif // wxUSE_IPC
+#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
// ----------------------------------------------------------------------------
// we need to create a hidden window to receive the process termination
// notifications and for this we need a (Win) class name for it which we will
// register the first time it's needed
+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
+{
+public:
+ virtual bool OnInit() { return true; }
+ virtual void OnExit()
+ {
+ 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(wxT("UnregisterClass(wxExecClass)"));
+ }
+
+ gs_classForHiddenWindow = NULL;
+ }
+ }
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxExecuteModule)
};
-#if defined(__WIN32__) && wxUSE_STREAMS
+IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule)
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
// ----------------------------------------------------------------------------
// wxPipeStreams
{
public:
wxPipeInputStream(HANDLE hInput);
- ~wxPipeInputStream();
+ virtual ~wxPipeInputStream();
- virtual bool Eof() const;
+ // 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
+ virtual bool CanRead() const;
protected:
size_t OnSysRead(void *buffer, size_t len);
protected:
HANDLE m_hInput;
+
+ wxDECLARE_NO_COPY_CLASS(wxPipeInputStream);
};
class wxPipeOutputStream: public wxOutputStream
{
public:
wxPipeOutputStream(HANDLE hOutput);
- ~wxPipeOutputStream();
+ virtual ~wxPipeOutputStream() { Close(); }
+ bool Close();
protected:
size_t OnSysWrite(const void *buffer, size_t len);
protected:
HANDLE m_hOutput;
+
+ wxDECLARE_NO_COPY_CLASS(wxPipeOutputStream);
+};
+
+// define this to let wxexec.cpp know that we know what we're doing
+#define _WX_USED_BY_WXEXECUTE_
+#include "../common/execcmn.cpp"
+
+// ----------------------------------------------------------------------------
+// wxPipe represents a Win32 anonymous pipe
+// ----------------------------------------------------------------------------
+
+class wxPipe
+{
+public:
+ // the symbolic names for the pipe ends
+ enum Direction
+ {
+ Read,
+ Write
+ };
+
+ // 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
+ bool Create()
+ {
+ // default secutiry attributes
+ SECURITY_ATTRIBUTES security;
+
+ security.nLength = sizeof(security);
+ security.lpSecurityDescriptor = NULL;
+ security.bInheritHandle = TRUE; // to pass it to the child
+
+ if ( !::CreatePipe(&m_handles[0], &m_handles[1], &security, 0) )
+ {
+ wxLogSysError(_("Failed to create an anonymous pipe"));
+
+ return false;
+ }
+
+ return true;
+ }
+
+ // 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 { return m_handles[which]; }
+
+ // detach a descriptor, meaning that the pipe dtor won't close it, and
+ // return it
+ HANDLE Detach(Direction which)
+ {
+ HANDLE handle = m_handles[which];
+ m_handles[which] = INVALID_HANDLE_VALUE;
+
+ return handle;
+ }
+
+ // close the pipe descriptors
+ void Close()
+ {
+ for ( size_t n = 0; n < WXSIZEOF(m_handles); n++ )
+ {
+ if ( m_handles[n] != INVALID_HANDLE_VALUE )
+ {
+ ::CloseHandle(m_handles[n]);
+ m_handles[n] = INVALID_HANDLE_VALUE;
+ }
+ }
+ }
+
+ // dtor closes the pipe descriptors
+ ~wxPipe() { Close(); }
+
+private:
+ HANDLE m_handles[2];
};
-// ==================
-// wxPipeInputStream
-// ==================
+#endif // wxUSE_STREAMS
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// process termination detecting support
+// ----------------------------------------------------------------------------
+
+// thread function for the thread monitoring the process termination
+static DWORD __stdcall wxExecuteThread(void *arg)
+{
+ wxExecuteData * const data = (wxExecuteData *)arg;
+
+ // create the shutdown event if we're the first thread starting to wait
+ if ( !gs_heventShutdown )
+ {
+ // create a manual initially non-signalled event object
+ gs_heventShutdown = ::CreateEvent(NULL, TRUE, FALSE, NULL);
+ if ( !gs_heventShutdown )
+ {
+ wxLogDebug(wxT("CreateEvent() in wxExecuteThread failed"));
+ }
+ }
+
+ HANDLE handles[2] = { data->hProcess, gs_heventShutdown };
+ switch ( ::WaitForMultipleObjects(2, handles, FALSE, INFINITE) )
+ {
+ 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;
+
+ 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;
+}
+
+// window procedure of a hidden window which is created just to receive
+// the notification message when a process exits
+LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
+ WPARAM wParam, LPARAM lParam)
+{
+ if ( message == wxWM_PROC_TERMINATED )
+ {
+ DestroyWindow(hWnd); // we don't need it any more
+
+ wxExecuteData * const data = (wxExecuteData *)lParam;
+ if ( data->handler )
+ {
+ data->handler->OnTerminate((int)data->dwProcessId,
+ (int)data->dwExitCode);
+ }
+
+ if ( data->state )
+ {
+ // we're executing synchronously, tell the waiting thread
+ // that the process finished
+ data->state = false;
+ }
+ else
+ {
+ // asynchronous execution - we should do the clean up
+ delete data;
+ }
+
+ return 0;
+ }
+ else
+ {
+ return ::DefWindowProc(hWnd, message, wParam, lParam);
+ }
+}
+
+// ============================================================================
+// implementation of IO redirection support classes
+// ============================================================================
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+
+// ----------------------------------------------------------------------------
+// wxPipeInputStreams
+// ----------------------------------------------------------------------------
wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
{
wxPipeInputStream::~wxPipeInputStream()
{
- ::CloseHandle(m_hInput);
+ if ( m_hInput != INVALID_HANDLE_VALUE )
+ ::CloseHandle(m_hInput);
}
-bool wxPipeInputStream::Eof() 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() )
+ {
+ // set back to mark Eof as it may have been unset by Ungetch()
+ self->m_lasterror = wxSTREAM_EOF;
+ return false;
+ }
+
DWORD nAvailable;
// function name is misleading, it works with anon pipes as well
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
- return TRUE;
- }
- else
- {
- return nAvailable == 0;
+ ::CloseHandle(m_hInput);
+
+ self->m_hInput = INVALID_HANDLE_VALUE;
+ self->m_lasterror = wxSTREAM_EOF;
+
+ nAvailable = 0;
}
+
+ return nAvailable != 0;
}
size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len)
{
- // reading from a pipe may block if there is no more data, always check for
- // EOF first
- m_lasterror = wxSTREAM_NOERROR;
- if ( Eof() )
+ if ( !IsOpened() )
+ {
+ m_lasterror = wxSTREAM_EOF;
+
return 0;
+ }
DWORD bytesRead;
if ( !::ReadFile(m_hInput, buffer, len, &bytesRead, NULL) )
{
- if ( ::GetLastError() == ERROR_BROKEN_PIPE )
- m_lasterror = wxSTREAM_EOF;
- else
- m_lasterror = wxSTREAM_READ_ERROR;
+ m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE
+ ? wxSTREAM_EOF
+ : wxSTREAM_READ_ERROR;
}
+ // bytesRead is set to 0, as desired, if an error occurred
return bytesRead;
}
-// ==================
+// ----------------------------------------------------------------------------
// wxPipeOutputStream
-// ==================
+// ----------------------------------------------------------------------------
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 bytesRead;
+ m_lasterror = wxSTREAM_NO_ERROR;
- m_lasterror = wxSTREAM_NOERROR;
- if ( !::WriteFile(m_hOutput, buffer, len, &bytesRead, NULL) )
+ DWORD totalWritten = 0;
+ while ( len > 0 )
{
- if ( ::GetLastError() == ERROR_BROKEN_PIPE )
- m_lasterror = wxSTREAM_EOF;
- else
- m_lasterror = wxSTREAM_READ_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 bytesRead;
+ return totalWritten;
}
-#endif // __WIN32__
+#endif // wxUSE_STREAMS
// ============================================================================
-// implementation
+// wxExecute functions family
// ============================================================================
-#ifdef __WIN32__
+#if wxUSE_IPC
-static DWORD wxExecuteThread(wxExecuteData *data)
+// connect to the given server via DDE and ask it to execute the command
+bool
+wxExecuteDDE(const wxString& ddeServer,
+ const wxString& ddeTopic,
+ const wxString& ddeCommand)
{
- WaitForSingleObject(data->hProcess, INFINITE);
+ bool ok wxDUMMY_INITIALIZE(false);
- // get the exit code
- if ( !GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
+ wxDDEClient client;
+ wxConnectionBase *
+ conn = client.MakeConnection(wxEmptyString, ddeServer, ddeTopic);
+ if ( !conn )
{
- wxLogLastError(wxT("GetExitCodeProcess"));
+ ok = false;
}
-
- 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);
-
- return 0;
-}
-
-// window procedure of a hidden window which is created just to receive
-// the notification message when a process exits
-LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
- WPARAM wParam, LPARAM lParam)
-{
- if ( message == wxWM_PROC_TERMINATED )
+ else // connected to DDE server
{
- DestroyWindow(hWnd); // we don't need it any more
-
- wxExecuteData *data = (wxExecuteData *)lParam;
- if ( data->handler )
+ // the added complication here is that although most programs use
+ // XTYP_EXECUTE for their DDE API, some important ones -- like Word
+ // and other MS stuff - use XTYP_REQUEST!
+ //
+ // moreover, anotheri mportant program (IE) understands both but
+ // returns an error from Execute() so we must try Request() first
+ // to avoid doing it twice
{
- data->handler->OnTerminate((int)data->dwProcessId,
- (int)data->dwExitCode);
- }
+ // we're prepared for this one to fail, so don't show errors
+ wxLogNull noErrors;
- if ( data->state )
- {
- // we're executing synchronously, tell the waiting thread
- // that the process finished
- data->state = 0;
+ ok = conn->Request(ddeCommand) != NULL;
}
- else
+
+ if ( !ok )
{
- // asynchronous execution - we should do the clean up
- delete data;
+ // now try execute -- but show the errors
+ ok = conn->Execute(ddeCommand);
}
-
- return 0;
- }
- else
- {
- return DefWindowProc(hWnd, message, wParam, lParam);
}
+
+ return ok;
}
-#endif // Win32
-long wxExecute(const wxString& cmd, bool sync, wxProcess *handler)
+#endif // wxUSE_IPC
+
+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(),
+ 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);
+ ddeTopic.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 )
ddeCommand += *p++;
}
- // maybe we don't have to launch the DDE server at all - if it is
- // already running, for example
- wxDDEClient client;
- wxLogNull nolog;
- wxConnectionBase *conn = client.MakeConnection(_T(""),
- ddeServer,
- ddeTopic);
- if ( conn )
+ // if we want to just launch the program and not wait for its
+ // termination, try to execute DDE command right now, it can succeed if
+ // the process is already running - but as it fails if it's not
+ // running, suppress any errors it might generate
+ if ( !(flags & wxEXEC_SYNC) )
{
- // FIXME we don't check the return code as for some strange reason
- // it will sometimes be FALSE - it is probably a bug in our
- // DDE code but I don't see anything wrong there
- (void)conn->Execute(ddeCommand);
-
- // ok, the command executed - return value indicating success,
- // making it up for async case as we really don't have any way to
- // get the real PID of the DDE server here
- return sync ? 0 : -1;
+ wxLogNull noErrors;
+ if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCommand) )
+ {
+ // a dummy PID - this is a hack, of course, but it's well worth
+ // it as we don't open a new server each time we're called
+ // which would be quite bad
+ return -1;
+ }
}
- //else: couldn't establish DDE conversation, now try launching the app
- // and sending the DDE request again
}
else
#endif // wxUSE_IPC
command = cmd;
}
-#if defined(__WIN32__) && !defined(__TWIN32__)
-
// the IO redirection is only supported with wxUSE_STREAMS
BOOL redirect = FALSE;
-#if wxUSE_STREAMS
- // the first elements are reading ends, the second are the writing ones
- HANDLE hpipeStdin[2],
- hpipeStdout[2],
- hpipeStderr[2];
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+ wxPipe pipeIn, pipeOut, pipeErr;
+
+ // we'll save here the copy of pipeIn[Write]
HANDLE hpipeStdinWrite = INVALID_HANDLE_VALUE;
// open the pipes to which child process IO will be redirected if needed
if ( handler && handler->IsRedirected() )
{
- // default secutiry attributes
- SECURITY_ATTRIBUTES security;
-
- security.nLength = sizeof(security);
- security.lpSecurityDescriptor = NULL;
- security.bInheritHandle = TRUE;
-
- // create stdin pipe
- if ( !::CreatePipe(&hpipeStdin[0], &hpipeStdin[1], &security, 0) )
+ // create pipes for redirecting stdin, stdout and stderr
+ if ( !pipeIn.Create() || !pipeOut.Create() || !pipeErr.Create() )
{
- wxLogSysError(_("Can't create the inter-process read pipe"));
+ wxLogSysError(_("Failed to redirect the child process IO"));
- // indicate failure in both cases
- return sync ? -1 : 0;
+ // indicate failure: we need to return different error code
+ // depending on the sync flag
+ return flags & wxEXEC_SYNC ? -1 : 0;
}
- // and a stdout one
- if ( !::CreatePipe(&hpipeStdout[0], &hpipeStdout[1], &security, 0) )
- {
- ::CloseHandle(hpipeStdin[0]);
- ::CloseHandle(hpipeStdin[1]);
-
- wxLogSysError(_("Can't create the inter-process write pipe"));
-
- return sync ? -1 : 0;
- }
-
- (void)::CreatePipe(&hpipeStderr[0], &hpipeStderr[1], &security, 0);
-
redirect = TRUE;
}
#endif // wxUSE_STREAMS
wxZeroMemory(si);
si.cb = sizeof(si);
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
if ( redirect )
{
- // when the std IO is redirected, we don't show the (console) process
- // window
- si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
+ si.dwFlags = STARTF_USESTDHANDLES;
- si.hStdInput = hpipeStdin[0];
- si.hStdOutput = hpipeStdout[1];
- si.hStdError = hpipeStderr[1];
-
- si.wShowWindow = SW_HIDE;
+ si.hStdInput = pipeIn[wxPipe::Read];
+ si.hStdOutput = pipeOut[wxPipe::Write];
+ si.hStdError = pipeErr[wxPipe::Write];
// we must duplicate the handle to the write side of stdin pipe to make
- // it non inheritable: indeed, we must close hpipeStdin[1] before
- // launching the child process as otherwise this handle will be
+ // it non inheritable: indeed, we must close the writing end of pipeIn
+ // before launching the child process as otherwise this handle will be
// inherited by the child which will never close it and so the pipe
// will never be closed and the child will be left stuck in ReadFile()
+ HANDLE pipeInWrite = pipeIn.Detach(wxPipe::Write);
if ( !::DuplicateHandle
(
- GetCurrentProcess(),
- hpipeStdin[1],
- GetCurrentProcess(),
+ ::GetCurrentProcess(),
+ pipeInWrite,
+ ::GetCurrentProcess(),
&hpipeStdinWrite,
0, // desired access: unused here
FALSE, // not inherited
DUPLICATE_SAME_ACCESS // same access as for src handle
) )
{
- wxLogLastError(_T("DuplicateHandle"));
+ wxLogLastError(wxT("DuplicateHandle"));
}
- ::CloseHandle(hpipeStdin[1]);
+ ::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_DEFAULT_ERROR_MODE | CREATE_SUSPENDED;
+ 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
+ // 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;
+ }
+ }
+
+ // Translate wxWidgets priority to Windows conventions.
+ if ( handler )
+ {
+ 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;
+ }
+ }
bool ok = ::CreateProcess
(
- NULL, // application name (use only cmd line)
- (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
+ // WinCE requires appname to be non null
+ // Win32 allows for null
+#ifdef __WXWINCE__
+ moduleName.t_str(), // application name
+ wxMSW_CONV_LPTSTR(arguments), // arguments
+#else
+ 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
+ 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
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
// we can close the pipe ends used by child anyhow
if ( redirect )
{
- ::CloseHandle(hpipeStdin[0]);
- ::CloseHandle(hpipeStdout[1]);
- ::CloseHandle(hpipeStderr[1]);
+ ::CloseHandle(pipeIn.Detach(wxPipe::Read));
+ ::CloseHandle(pipeOut.Detach(wxPipe::Write));
+ ::CloseHandle(pipeErr.Detach(wxPipe::Write));
}
#endif // wxUSE_STREAMS
if ( !ok )
{
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
// close the other handles too
if ( redirect )
{
- ::CloseHandle(hpipeStdout[0]);
- ::CloseHandle(hpipeStderr[0]);
+ ::CloseHandle(pipeOut.Detach(wxPipe::Read));
+ ::CloseHandle(pipeErr.Detach(wxPipe::Read));
}
#endif // wxUSE_STREAMS
wxLogSysError(_("Execution of command '%s' failed"), command.c_str());
- return sync ? -1 : 0;
+ return flags & wxEXEC_SYNC ? -1 : 0;
}
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+ // the input buffer bufOut is connected to stdout, this is why it is
+ // called bufOut and not bufIn
+ wxStreamTempInputBuffer bufOut,
+ bufErr;
+
if ( redirect )
{
// We can now initialize the wxStreams
- wxInputStream *inStream = new wxPipeInputStream(hpipeStdout[0]),
- *errStream = new wxPipeInputStream(hpipeStderr[0]);
- wxOutputStream *outStream = new wxPipeOutputStream(hpipeStdinWrite);
+ wxPipeInputStream *
+ outStream = new wxPipeInputStream(pipeOut.Detach(wxPipe::Read));
+ wxPipeInputStream *
+ errStream = new wxPipeInputStream(pipeErr.Detach(wxPipe::Read));
+ wxPipeOutputStream *
+ inStream = new wxPipeOutputStream(hpipeStdinWrite);
- handler->SetPipeStreams(inStream, outStream, errStream);
- }
-#endif // wxUSE_STREAMS
+ handler->SetPipeStreams(outStream, inStream, errStream);
- // register the class for the hidden window used for the notifications
- if ( !gs_classForHiddenWindow )
- {
- gs_classForHiddenWindow = _T("wxHiddenWindow");
-
- WNDCLASS wndclass;
- wxZeroMemory(wndclass);
- wndclass.lpfnWndProc = (WNDPROC)wxExecuteWindowCbk;
- wndclass.hInstance = wxGetInstance();
- wndclass.lpszClassName = gs_classForHiddenWindow;
-
- if ( !::RegisterClass(&wndclass) )
- {
- wxLogLastError(wxT("RegisterClass(hidden window)"));
- }
+ bufOut.Init(outStream);
+ bufErr.Init(errStream);
}
+#endif // wxUSE_STREAMS
// create a hidden window to receive notification about process
// termination
- HWND hwnd = ::CreateWindow(gs_classForHiddenWindow, NULL,
- WS_OVERLAPPEDWINDOW,
- 0, 0, 0, 0, NULL,
- (HMENU)NULL, wxGetInstance(), 0);
+ HWND hwnd = wxCreateHiddenWindow
+ (
+ &gs_classForHiddenWindow,
+ wxMSWEXEC_WNDCLASSNAME,
+ (WNDPROC)wxExecuteWindowCbk
+ );
+
wxASSERT_MSG( hwnd, wxT("can't create a hidden window for wxExecute") );
// Alloc data
data->hProcess = pi.hProcess;
data->dwProcessId = pi.dwProcessId;
data->hWnd = hwnd;
- data->state = sync;
- if ( sync )
+ data->state = (flags & wxEXEC_SYNC) != 0;
+ if ( flags & wxEXEC_SYNC )
{
// handler may be !NULL for capturing program output, but we don't use
// it wxExecuteData struct in this case
{
// may be NULL or not
data->handler = handler;
+
+ if (handler)
+ handler->SetPid(pi.dwProcessId);
}
DWORD tid;
HANDLE hThread = ::CreateThread(NULL,
0,
- (LPTHREAD_START_ROUTINE)wxExecuteThread,
+ wxExecuteThread,
(void *)data,
0,
&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
+#if wxUSE_IPC && !defined(__WXWINCE__)
// second part of DDE hack: now establish the DDE conversation with the
// just launched process
- if ( !!ddeServer )
+ if ( !ddeServer.empty() )
{
- wxDDEClient client;
- wxConnectionBase *conn;
-
+ bool ddeOK;
+
+ // give the process the time to init itself
+ //
+ // we use a very big timeout hoping that WaitForInputIdle() will return
+ // much sooner, but not INFINITE just in case the process hangs
+ // completely - like this we will regain control sooner or later
+ switch ( ::WaitForInputIdle(pi.hProcess, 10000 /* 10 seconds */) )
{
- // try doing it the first time without error messages
- wxLogNull nolog;
+ default:
+ wxFAIL_MSG( wxT("unexpected WaitForInputIdle() return code") );
+ // fall through
- conn = client.MakeConnection(_T(""), ddeServer, ddeTopic);
- }
+ case WAIT_FAILED:
+ wxLogLastError(wxT("WaitForInputIdle() in wxExecute"));
- if ( !conn )
- {
- // give the app some time to initialize itself: in fact, a common
- // reason for failure is that we tried to open DDE conversation too
- // soon (before the app had time to setup its DDE server), so wait
- // a bit and try again
- ::Sleep(2000);
+ case WAIT_TIMEOUT:
+ wxLogDebug(wxT("Timeout too small in WaitForInputIdle"));
- wxConnectionBase *conn = client.MakeConnection(_T(""),
- ddeServer,
- ddeTopic);
- if ( !conn )
- {
- wxLogError(_("Couldn't launch DDE server '%s'."), command.c_str());
- }
+ ddeOK = false;
+ break;
+
+ case 0:
+ // ok, process ready to accept DDE requests
+ ddeOK = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand);
}
- if ( conn )
+ if ( !ddeOK )
{
- // FIXME just as above we don't check Execute() return code
- wxLogNull nolog;
- (void)conn->Execute(ddeCommand);
+ wxLogDebug(wxT("Failed to send DDE request to the process \"%s\"."),
+ cmd.c_str());
}
}
#endif // wxUSE_IPC
- if ( !sync )
+ if ( !(flags & wxEXEC_SYNC) )
{
// clean up will be done when the process terminates
return pi.dwProcessId;
}
- // waiting until command executed (disable everything while doing it)
-#if wxUSE_GUI
- {
- wxBusyCursor bc;
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ wxCHECK_MSG( traits, -1, wxT("no wxAppTraits in wxExecute()?") );
- wxWindowDisabler wd;
-#endif // wxUSE_GUI
+ 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 )
- wxYield();
+ {
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+ 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);
+ }
+
+ // 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);
-#if wxUSE_GUI
+ // 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) )
+ {
+ // reenable disabled windows back
+ traits->AfterChildWaitLoop(cookie);
}
-#endif // wxUSE_GUI
DWORD dwExitCode = data->dwExitCode;
delete data;
// return the exit code
return dwExitCode;
-#else // Win16
- long instanceID = WinExec((LPCSTR) WXSTRINGCAST command, SW_SHOW);
- if (instanceID < 32) return(0);
-
- if (sync) {
- int running;
- do {
- wxYield();
- running = GetModuleUsage((HINSTANCE)instanceID);
- } while (running);
- }
-
- return(instanceID);
-#endif // Win16/32
}
-long wxExecute(char **argv, bool sync, wxProcess *handler)
+template <typename CharType>
+long wxExecuteImpl(CharType **argv, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
{
wxString command;
+ command.reserve(1024);
- while ( *argv != NULL )
+ wxString arg;
+ for ( ;; )
{
- command << *argv++ << ' ';
- }
-
- command.RemoveLast();
+ arg = *argv++;
- return wxExecute(command, sync, handler);
-}
+ 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 */);
-#if wxUSE_GUI
+ // and quote any arguments containing the spaces to prevent them from
+ // being broken down
+ quote = arg.find_first_of(" \t") != wxString::npos;
+ }
-// ----------------------------------------------------------------------------
-// Metafile helpers
-// ----------------------------------------------------------------------------
+ if ( quote )
+ command += '\"' + arg + '\"';
+ else
+ command += arg;
-extern void PixelToHIMETRIC(LONG *x, LONG *y)
-{
- ScreenHDC hdcRef;
+ if ( !*argv )
+ break;
- int iWidthMM = GetDeviceCaps(hdcRef, HORZSIZE),
- iHeightMM = GetDeviceCaps(hdcRef, VERTSIZE),
- iWidthPels = GetDeviceCaps(hdcRef, HORZRES),
- iHeightPels = GetDeviceCaps(hdcRef, VERTRES);
+ command += ' ';
+ }
- *x *= (iWidthMM * 100);
- *x /= iWidthPels;
- *y *= (iHeightMM * 100);
- *y /= iHeightPels;
+ return wxExecute(command, flags, handler, env);
}
-extern void HIMETRICToPixel(LONG *x, LONG *y)
+long wxExecute(char **argv, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
{
- ScreenHDC hdcRef;
+ return wxExecuteImpl(argv, flags, handler, env);
+}
- int iWidthMM = GetDeviceCaps(hdcRef, HORZSIZE),
- iHeightMM = GetDeviceCaps(hdcRef, VERTSIZE),
- iWidthPels = GetDeviceCaps(hdcRef, HORZRES),
- iHeightPels = GetDeviceCaps(hdcRef, VERTRES);
+#if wxUSE_UNICODE
- *x *= iWidthPels;
- *x /= (iWidthMM * 100);
- *y *= iHeightPels;
- *y /= (iHeightMM * 100);
+long wxExecute(wchar_t **argv, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
+{
+ return wxExecuteImpl(argv, flags, handler, env);
}
-#endif // wxUSE_GUI
+#endif // wxUSE_UNICODE
projects / wxWidgets.git / blobdiff