/////////////////////////////////////////////////////////////////////////////
-// Name: 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
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation
-#endif
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
#ifndef WX_PRECOMP
-#include "wx/setup.h"
-#include "wx/utils.h"
-#include "wx/app.h"
-#include "wx/intl.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"
-#include "wx/msw/private.h"
-#include <windows.h>
+#include "wx/msw/private.h"
#include <ctype.h>
-#if !defined(__GNUWIN32__) && !defined(__SALFORDC__)
-#include <direct.h>
-#ifndef __MWERKS__
-#include <dos.h>
-#endif
+#if !defined(__GNUWIN32__) && !defined(__WXMICROWIN__) && !defined(__WXWINCE__)
+ #include <direct.h>
+ #include <dos.h>
#endif
-#ifdef __GNUWIN32__
-#ifndef __TWIN32__
-#include <sys/unistd.h>
-#include <sys/stat.h>
-#endif
+#if defined(__GNUWIN32__)
+ #include <sys/unistd.h>
+ #include <sys/stat.h>
#endif
-#ifdef __WIN32__
-#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>
#endif
#include <stdarg.h>
-#define wxEXECUTE_WIN_MESSAGE 10000
+#if wxUSE_IPC
+ #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
+// ----------------------------------------------------------------------------
+
+// this message is sent when the process we're waiting for terminates
+#define wxWM_PROC_TERMINATED (WM_USER + 10000)
+
+// ----------------------------------------------------------------------------
+// this module globals
+// ----------------------------------------------------------------------------
+
+// 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
+// ----------------------------------------------------------------------------
+
+// structure describing the process we're being waiting for
+struct wxExecuteData
+{
+public:
+ ~wxExecuteData()
+ {
+ if ( !::CloseHandle(hProcess) )
+ {
+ wxLogLastError(wxT("CloseHandle(hProcess)"));
+ }
+ }
+
+ HWND hWnd; // window to send wxWM_PROC_TERMINATED to
+ HANDLE hProcess; // handle of the process
+ 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
+};
+
+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)"));
+ }
-struct wxExecuteData {
- HWND window;
- HINSTANCE process;
- wxProcess *handler;
- char state;
+ gs_classForHiddenWindow = NULL;
+ }
+ }
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxExecuteModule)
};
+IMPLEMENT_DYNAMIC_CLASS(wxExecuteModule, wxModule)
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
-#ifdef __WIN32__
-static DWORD wxExecuteThread(wxExecuteData *data)
+// ----------------------------------------------------------------------------
+// wxPipeStreams
+// ----------------------------------------------------------------------------
+
+class wxPipeInputStream: public wxInputStream
{
- WaitForSingleObject(data->process, INFINITE);
+public:
+ wxPipeInputStream(HANDLE hInput);
+ virtual ~wxPipeInputStream();
- // Send an implicit message to the window
- SendMessage(data->window, wxEXECUTE_WIN_MESSAGE, 0, (LPARAM)data);
+ // returns true if the pipe is still opened
+ bool IsOpened() const { return m_hInput != INVALID_HANDLE_VALUE; }
- return 0;
-}
-#endif
+ // 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);
+ 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];
+};
+
+#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)
{
- wxExecuteData *data = (wxExecuteData *)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 (message == wxEXECUTE_WIN_MESSAGE) {
- DestroyWindow(hWnd);
- if (data->handler)
- data->handler->OnTerminate((int)data->process, -1);
+ 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;
+ }
- if (data->state)
- data->state = 0;
+ return 0;
+ }
else
- delete data;
- }
- return 0;
+ {
+ return ::DefWindowProc(hWnd, message, wParam, lParam);
+ }
}
-extern char wxPanelClassName[];
+// ============================================================================
+// implementation of IO redirection support classes
+// ============================================================================
-long wxExecute(const wxString& command, bool sync, wxProcess *handler)
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+
+// ----------------------------------------------------------------------------
+// wxPipeInputStreams
+// ----------------------------------------------------------------------------
+
+wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
{
- if (command == "")
- return 0;
+ m_hInput = hInput;
+}
+
+wxPipeInputStream::~wxPipeInputStream()
+{
+ if ( m_hInput != INVALID_HANDLE_VALUE )
+ ::CloseHandle(m_hInput);
+}
+
+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
+ DWORD rc = ::PeekNamedPipe
+ (
+ m_hInput, // handle
+ NULL, 0, // ptr to buffer and its size
+ NULL, // [out] bytes read
+ &nAvailable, // [out] bytes available
+ NULL // [out] bytes left
+ );
+
+ if ( !rc )
+ {
+ if ( ::GetLastError() != ERROR_BROKEN_PIPE )
+ {
+ // unexpected error
+ 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);
+
+ 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)
+{
+ if ( !IsOpened() )
+ {
+ m_lasterror = wxSTREAM_EOF;
+
+ return 0;
+ }
+
+ DWORD bytesRead;
+ if ( !::ReadFile(m_hInput, buffer, len, &bytesRead, NULL) )
+ {
+ 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
+// ----------------------------------------------------------------------------
-#if defined(__WIN32__) && !defined(__TWIN32__)
- char * cl;
- char * argp;
- int clen;
- HINSTANCE result;
- DWORD dresult;
- HWND window;
- wxExecuteData *data;
- DWORD tid;
-
- // copy the command line
- clen = command.Length();
- if (!clen) return -1;
- cl = (char *) calloc( 1, 256);
- if (!cl) return -1;
- strcpy( cl, WXSTRINGCAST command);
-
- // isolate command and arguments
- argp = strchr( cl, ' ');
- if (argp)
- *argp++ = '\0';
-
-#ifdef __GNUWIN32__
- result = ShellExecute((HWND) (wxTheApp->GetTopWindow() ? (HWND) wxTheApp->GetTopWindow()->GetHWND() : NULL),
- (const wchar_t) "open", (const wchar_t) cl, (const wchar_t) argp,
- (const wchar_t) NULL, SW_SHOWNORMAL);
+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)"));
+ }
+}
+
+bool wxPipeOutputStream::Close()
+{
+ return ::CloseHandle(m_hOutput) != 0;
+}
+
+
+size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len)
+{
+ m_lasterror = wxSTREAM_NO_ERROR;
+
+ DWORD totalWritten = 0;
+ while ( len > 0 )
+ {
+ 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 totalWritten;
+}
+
+#endif // wxUSE_STREAMS
+
+// ============================================================================
+// wxExecute functions family
+// ============================================================================
+
+#if wxUSE_IPC
+
+// 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)
+{
+ bool ok wxDUMMY_INITIALIZE(false);
+
+ wxDDEClient client;
+ wxConnectionBase *
+ conn = client.MakeConnection(wxEmptyString, ddeServer, ddeTopic);
+ if ( !conn )
+ {
+ ok = false;
+ }
+ else // connected to DDE server
+ {
+ // 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
+ {
+ // we're prepared for this one to fail, so don't show errors
+ wxLogNull noErrors;
+
+ ok = conn->Request(ddeCommand) != NULL;
+ }
+
+ if ( !ok )
+ {
+ // now try execute -- but show the errors
+ ok = conn->Execute(ddeCommand);
+ }
+ }
+
+ return ok;
+}
+
+#endif // wxUSE_IPC
+
+long wxExecute(const wxString& cmd, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
+{
+ 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;
+
+#if wxUSE_IPC
+ // DDE hack: this is really not pretty, but we need to allow this for
+ // transparent handling of DDE servers in wxMimeTypesManager. Usually it
+ // returns the command which should be run to view/open/... a file of the
+ // given type. Sometimes, however, this command just launches the server
+ // and an additional DDE request must be made to really open the file. To
+ // keep all this well hidden from the application, we allow a special form
+ // of command: WX_DDE#<command>#DDE_SERVER#DDE_TOPIC#DDE_COMMAND in which
+ // 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) == 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 != wxT('#') )
+ {
+ command += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p && *p != wxT('#') )
+ {
+ ddeServer += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p && *p != wxT('#') )
+ {
+ ddeTopic += *p++;
+ }
+
+ if ( *p )
+ {
+ // skip '#'
+ p++;
+ }
+ else
+ {
+ wxFAIL_MSG(wxT("invalid WX_DDE command in wxExecute"));
+ }
+
+ while ( *p )
+ {
+ ddeCommand += *p++;
+ }
+
+ // 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) )
+ {
+ 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
+#endif // wxUSE_IPC
+ {
+ // no DDE
+ command = cmd;
+ }
+
+ // the IO redirection is only supported with wxUSE_STREAMS
+ BOOL redirect = FALSE;
+
+#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() )
+ {
+ // create pipes for redirecting stdin, stdout and stderr
+ if ( !pipeIn.Create() || !pipeOut.Create() || !pipeErr.Create() )
+ {
+ wxLogSysError(_("Failed to redirect the child process IO"));
+
+ // indicate failure: we need to return different error code
+ // depending on the sync flag
+ return flags & wxEXEC_SYNC ? -1 : 0;
+ }
+
+ redirect = TRUE;
+ }
+#endif // wxUSE_STREAMS
+
+ // create the process
+ STARTUPINFO si;
+ wxZeroMemory(si);
+ si.cb = sizeof(si);
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+ if ( redirect )
+ {
+ si.dwFlags = STARTF_USESTDHANDLES;
+
+ 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 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(),
+ pipeInWrite,
+ ::GetCurrentProcess(),
+ &hpipeStdinWrite,
+ 0, // desired access: unused here
+ FALSE, // not inherited
+ DUPLICATE_SAME_ACCESS // same access as for src handle
+ ) )
+ {
+ 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
- result = ShellExecute( (HWND) (wxTheApp->GetTopWindow() ? wxTheApp->GetTopWindow()->GetHWND() : NULL),
- "open", cl, argp, NULL, SW_SHOWNORMAL);
+ // we are assuming commands without spaces for now
+ wxString moduleName = command.BeforeFirst(wxT(' '));
+ wxString arguments = command.AfterFirst(wxT(' '));
#endif
- if (((long)result) <= 32) {
- free(cl);
+ 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
- wxLogSysError(_("Can't execute command '%s'"), command.c_str());
- return 0;
- }
+ wxEnvVariableHashMap::const_iterator it;
- // Alloc data
- data = new wxExecuteData;
+ 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;
+ }
- // Create window
- window = CreateWindow(wxPanelClassName, NULL, 0, 0, 0, 0, 0, NULL,
- (HMENU) NULL, wxGetInstance(), 0);
+ envBuffer.extend(envSz);
- FARPROC ExecuteWindowInstance = MakeProcInstance((FARPROC) wxExecuteWindowCbk,
- wxGetInstance());
+ wxChar *p = envBuffer.data();
+ for ( it = env->env.begin(); it != env->env.end(); ++it )
+ {
+ const wxString line = it->first + wxS("=") + it->second;
- SetWindowLong(window, GWL_WNDPROC, (LONG) ExecuteWindowInstance);
- SetWindowLong(window, GWL_USERDATA, (LONG) data);
+ // Include the trailing NUL which will always terminate the
+ // buffer returned by t_str().
+ const size_t len = line.length() + 1;
- data->process = result;
- data->window = window;
- data->state = sync;
- data->handler = (sync) ? NULL : handler;
+ wxTmemcpy(p, line.t_str(), len);
- dresult = (DWORD)CreateThread(NULL, 0,
- (LPTHREAD_START_ROUTINE)wxExecuteThread,
- (void *)data, 0, &tid);
- if (dresult == 0) {
- wxDebugMsg("wxExecute PANIC: I can't create the waiting thread !");
- DestroyWindow(window);
- return (long)result;
- }
+ p += len;
+ }
- if (!sync)
- {
- free(cl);
- return (long)result;
- }
+ // And another NUL to terminate the list of NUL-terminated strings.
+ *p = 0;
+ }
+ }
- // waiting until command executed
- while (data->state)
- wxYield();
+ // 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;
+ }
+ }
- free(cl);
- return 0;
+ bool ok = ::CreateProcess
+ (
+ // WinCE requires appname to be non null
+ // Win32 allows for null
+#ifdef __WXWINCE__
+ moduleName.t_str(), // application name
+ wxMSW_CONV_LPTSTR(arguments), // arguments
#else
- long instanceID = WinExec((LPCSTR) WXSTRINGCAST command, SW_SHOW);
- if (instanceID < 32) return(0);
-
- if (sync) {
- int running;
- do {
- wxYield();
- running = GetModuleUsage((HANDLE)instanceID);
- } while (running);
- }
- return(instanceID);
+ 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 && !defined(__WXWINCE__)
+ // we can close the pipe ends used by child anyhow
+ if ( redirect )
+ {
+ ::CloseHandle(pipeIn.Detach(wxPipe::Read));
+ ::CloseHandle(pipeOut.Detach(wxPipe::Write));
+ ::CloseHandle(pipeErr.Detach(wxPipe::Write));
+ }
+#endif // wxUSE_STREAMS
+
+ if ( !ok )
+ {
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+ // close the other handles too
+ if ( redirect )
+ {
+ ::CloseHandle(pipeOut.Detach(wxPipe::Read));
+ ::CloseHandle(pipeErr.Detach(wxPipe::Read));
+ }
+#endif // wxUSE_STREAMS
+
+ wxLogSysError(_("Execution of command '%s' failed"), command.c_str());
+
+ return flags & wxEXEC_SYNC ? -1 : 0;
+ }
+
+#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
+ wxPipeInputStream *
+ outStream = new wxPipeInputStream(pipeOut.Detach(wxPipe::Read));
+ wxPipeInputStream *
+ errStream = new wxPipeInputStream(pipeErr.Detach(wxPipe::Read));
+ wxPipeOutputStream *
+ inStream = new wxPipeOutputStream(hpipeStdinWrite);
+
+ handler->SetPipeStreams(outStream, inStream, errStream);
+
+ bufOut.Init(outStream);
+ bufErr.Init(errStream);
+ }
+#endif // wxUSE_STREAMS
+
+ // create a hidden window to receive notification about process
+ // termination
+ HWND hwnd = wxCreateHiddenWindow
+ (
+ &gs_classForHiddenWindow,
+ wxMSWEXEC_WNDCLASSNAME,
+ (WNDPROC)wxExecuteWindowCbk
+ );
+
+ wxASSERT_MSG( hwnd, wxT("can't create a hidden window for wxExecute") );
+
+ // Alloc data
+ wxExecuteData *data = new wxExecuteData;
+ data->hProcess = pi.hProcess;
+ data->dwProcessId = pi.dwProcessId;
+ data->hWnd = hwnd;
+ 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
+ data->handler = NULL;
+ }
+ else
+ {
+ // may be NULL or not
+ data->handler = handler;
+
+ if (handler)
+ handler->SetPid(pi.dwProcessId);
+ }
+
+ DWORD tid;
+ HANDLE hThread = ::CreateThread(NULL,
+ 0,
+ wxExecuteThread,
+ (void *)data,
+ 0,
+ &tid);
+
+ // resume process we created now - whether the thread creation succeeded or
+ // not
+ if ( ::ResumeThread(pi.hThread) == (DWORD)-1 )
+ {
+ // ignore it - what can we do?
+ wxLogLastError(wxT("ResumeThread in wxExecute"));
+ }
+
+ // close unneeded handle
+ if ( !::CloseHandle(pi.hThread) )
+ {
+ wxLogLastError(wxT("CloseHandle(hThread)"));
+ }
+
+ if ( !hThread )
+ {
+ wxLogLastError(wxT("CreateThread in wxExecute"));
+
+ DestroyWindow(hwnd);
+ delete data;
+
+ // the process still started up successfully...
+ return pi.dwProcessId;
+ }
+
+ 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 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 */) )
+ {
+ default:
+ wxFAIL_MSG( wxT("unexpected WaitForInputIdle() return code") );
+ // fall through
+
+ case WAIT_FAILED:
+ wxLogLastError(wxT("WaitForInputIdle() in wxExecute"));
+
+ case WAIT_TIMEOUT:
+ wxLogDebug(wxT("Timeout too small in WaitForInputIdle"));
+
+ ddeOK = false;
+ break;
+
+ case 0:
+ // ok, process ready to accept DDE requests
+ ddeOK = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand);
+ }
+
+ if ( !ddeOK )
+ {
+ wxLogDebug(wxT("Failed to send DDE request to the process \"%s\"."),
+ cmd.c_str());
+ }
+ }
+#endif // wxUSE_IPC
+
+ if ( !(flags & wxEXEC_SYNC) )
+ {
+ // clean up will be done when the process terminates
+
+ // return the pid
+ return pi.dwProcessId;
+ }
+
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ wxCHECK_MSG( traits, -1, wxT("no wxAppTraits in wxExecute()?") );
+
+ 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__)
+ 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);
+
+ // 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);
+ }
+
+ DWORD dwExitCode = data->dwExitCode;
+ delete data;
+
+ // return the exit code
+ return dwExitCode;
+}
+
+template <typename CharType>
+long wxExecuteImpl(CharType **argv, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
+{
+ wxString command;
+ command.reserve(1024);
+
+ wxString arg;
+ for ( ;; )
+ {
+ 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 += ' ';
+ }
+
+ return wxExecute(command, flags, handler, env);
}
-long wxExecute(char **argv, bool sync, wxProcess *handler)
+long wxExecute(char **argv, int flags, wxProcess *handler,
+ const wxExecuteEnv *env)
{
- wxString command = "";
+ return wxExecuteImpl(argv, flags, handler, env);
+}
- while (*argv != NULL) {
- command += *argv;
- command += ' ';
- argv++;
- }
- command.RemoveLast();
- return wxExecute(command, sync, handler);
+#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