/////////////////////////////////////////////////////////////////////////////
// Name: msw/utilsexec.cpp
-// Purpose: Various utilities
+// 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 wxWindows dev team
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
#include "wx/utils.h"
#include "wx/app.h"
#include "wx/intl.h"
+ #include "wx/log.h"
+ #if wxUSE_GUI // See 'dirty hack' below.
+ #include "wx/frame.h"
+ #endif
#endif
-#include "wx/log.h"
-
#ifdef __WIN32__
#include "wx/stream.h"
#include "wx/process.h"
#include <ctype.h>
-#if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__)
+#if !defined(__GNUWIN32__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__)
#include <direct.h>
#ifndef __MWERKS__
#include <dos.h>
#include <sys/stat.h>
#endif
-#if defined(__WIN32__) && !defined(__WXWINE__) && !defined(__WXMICROWIN__)
-#include <io.h>
+#if defined(__WIN32__) && !defined(__WXMICROWIN__)
+#ifndef __UNIX__
+ #include <io.h>
+#endif
#ifndef __GNUWIN32__
#include <shellapi.h>
{
public:
wxPipeInputStream(HANDLE hInput);
- ~wxPipeInputStream();
+ virtual ~wxPipeInputStream();
+
+ // returns TRUE if the pipe is still opened
+ bool IsOpened() const { return m_hInput != INVALID_HANDLE_VALUE; }
- virtual bool Eof() const;
+ // 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;
+
+ DECLARE_NO_COPY_CLASS(wxPipeInputStream)
};
class wxPipeOutputStream: public wxOutputStream
{
public:
wxPipeOutputStream(HANDLE hOutput);
- ~wxPipeOutputStream();
+ virtual ~wxPipeOutputStream();
protected:
size_t OnSysWrite(const void *buffer, size_t len);
protected:
HANDLE m_hOutput;
-};
-// ==================
-// wxPipeInputStream
-// ==================
+ DECLARE_NO_COPY_CLASS(wxPipeOutputStream)
+};
-wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
-{
- m_hInput = hInput;
-}
+// define this to let wxexec.cpp know that we know what we're doing
+#define _WX_USED_BY_WXEXECUTE_
+#include "../common/execcmn.cpp"
-wxPipeInputStream::~wxPipeInputStream()
-{
- ::CloseHandle(m_hInput);
-}
+// ----------------------------------------------------------------------------
+// wxPipe represents a Win32 anonymous pipe
+// ----------------------------------------------------------------------------
-bool wxPipeInputStream::Eof() const
+class wxPipe
{
- DWORD nAvailable;
+public:
+ // the symbolic names for the pipe ends
+ enum Direction
+ {
+ Read,
+ Write
+ };
- // 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
- );
+ // default ctor doesn't do anything
+ wxPipe() { m_handles[Read] = m_handles[Write] = INVALID_HANDLE_VALUE; }
- if ( !rc )
+ // create the pipe, return TRUE if ok, FALSE on error
+ bool Create()
{
- if ( ::GetLastError() != ERROR_BROKEN_PIPE )
+ // 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) )
{
- // unexpected error
- wxLogLastError(_T("PeekNamedPipe"));
+ wxLogSysError(_("Failed to create an anonymous pipe"));
+
+ return FALSE;
}
- // don't try to continue reading from a pipe if an error occured or if
- // it had been closed
return TRUE;
}
- else
- {
- 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() )
- return 0;
+ // return TRUE if we were created successfully
+ bool IsOk() const { return m_handles[Read] != INVALID_HANDLE_VALUE; }
- DWORD bytesRead;
- if ( !::ReadFile(m_hInput, buffer, len, &bytesRead, NULL) )
+ // return the descriptor for one of the pipe ends
+ HANDLE operator[](Direction which) const
{
- if ( ::GetLastError() == ERROR_BROKEN_PIPE )
- m_lasterror = wxSTREAM_EOF;
- else
- m_lasterror = wxSTREAM_READ_ERROR;
- }
-
- return bytesRead;
-}
+ wxASSERT_MSG( which >= 0 && (size_t)which < WXSIZEOF(m_handles),
+ _T("invalid pipe index") );
-// ==================
-// wxPipeOutputStream
-// ==================
+ return m_handles[which];
+ }
-wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput)
-{
- m_hOutput = hOutput;
-}
+ // 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") );
-wxPipeOutputStream::~wxPipeOutputStream()
-{
- ::CloseHandle(m_hOutput);
-}
+ HANDLE handle = m_handles[which];
+ m_handles[which] = INVALID_HANDLE_VALUE;
-size_t wxPipeOutputStream::OnSysWrite(const void *buffer, size_t len)
-{
- DWORD bytesRead;
+ return handle;
+ }
- m_lasterror = wxSTREAM_NOERROR;
- if ( !::WriteFile(m_hOutput, buffer, len, &bytesRead, NULL) )
+ // close the pipe descriptors
+ void Close()
{
- if ( ::GetLastError() == ERROR_BROKEN_PIPE )
- m_lasterror = wxSTREAM_EOF;
- else
- m_lasterror = wxSTREAM_READ_ERROR;
+ 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;
+ }
+ }
}
- return bytesRead;
-}
+ // dtor closes the pipe descriptors
+ ~wxPipe() { Close(); }
+
+private:
+ HANDLE m_handles[2];
+};
-#endif // __WIN32__
+#endif // wxUSE_STREAMS
// ============================================================================
// implementation
#ifdef __WIN32__
-static DWORD wxExecuteThread(wxExecuteData *data)
+// ----------------------------------------------------------------------------
+// process termination detecting support
+// ----------------------------------------------------------------------------
+
+// thread function for the thread monitoring the process termination
+static DWORD __stdcall wxExecuteThread(void *arg)
{
- WaitForSingleObject(data->hProcess, INFINITE);
+ wxExecuteData * const data = (wxExecuteData *)arg;
+
+ if ( ::WaitForSingleObject(data->hProcess, INFINITE) != WAIT_OBJECT_0 )
+ {
+ wxLogDebug(_T("Waiting for the process termination failed!"));
+ }
// get the exit code
- if ( !GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
+ if ( !::GetExitCodeProcess(data->hProcess, &data->dwExitCode) )
{
wxLogLastError(wxT("GetExitCodeProcess"));
}
wxT("process should have terminated") );
// send a message indicating process termination to the window
- SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
+ ::SendMessage(data->hWnd, wxWM_PROC_TERMINATED, 0, (LPARAM)data);
return 0;
}
{
DestroyWindow(hWnd); // we don't need it any more
- wxExecuteData *data = (wxExecuteData *)lParam;
+ wxExecuteData * const data = (wxExecuteData *)lParam;
if ( data->handler )
{
data->handler->OnTerminate((int)data->dwProcessId,
}
else
{
- return DefWindowProc(hWnd, message, wParam, lParam);
+ return ::DefWindowProc(hWnd, message, wParam, lParam);
}
}
+
+// ============================================================================
+// implementation of IO redirection support classes
+// ============================================================================
+
+#if wxUSE_STREAMS
+
+// ----------------------------------------------------------------------------
+// wxPipeInputStreams
+// ----------------------------------------------------------------------------
+
+wxPipeInputStream::wxPipeInputStream(HANDLE hInput)
+{
+ m_hInput = hInput;
+}
+
+wxPipeInputStream::~wxPipeInputStream()
+{
+ if ( m_hInput != INVALID_HANDLE_VALUE )
+ ::CloseHandle(m_hInput);
+}
+
+bool wxPipeInputStream::CanRead() const
+{
+ if ( !IsOpened() )
+ 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(_T("PeekNamedPipe"));
+ }
+
+ // don't try to continue reading from a pipe if an error occured 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;
+
+ 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 occured
+ return bytesRead;
+}
+
+// ----------------------------------------------------------------------------
+// wxPipeOutputStream
+// ----------------------------------------------------------------------------
+
+wxPipeOutputStream::wxPipeOutputStream(HANDLE hOutput)
+{
+ m_hOutput = hOutput;
+}
+
+wxPipeOutputStream::~wxPipeOutputStream()
+{
+ ::CloseHandle(m_hOutput);
+}
+
+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) )
+ {
+ m_lasterror = ::GetLastError() == ERROR_BROKEN_PIPE
+ ? wxSTREAM_EOF
+ : wxSTREAM_WRITE_ERROR;
+ }
+
+ return bytesWritten;
+}
+
+#endif // wxUSE_STREAMS
+
#endif // Win32
+// ============================================================================
+// wxExecute functions family
+// ============================================================================
+
#if wxUSE_IPC
// connect to the given server via DDE and ask it to execute the command
const wxString& ddeTopic,
const wxString& ddeCommand)
{
- bool ok;
+ bool ok = FALSE;
wxDDEClient client;
wxConnectionBase *conn = client.MakeConnection(_T(""),
// important ones - like IE and other MS stuff - use
// XTYP_REQUEST!
//
- // so we try it first and then the other one if it
+ // so we try one first and then the other one if it
// failed
{
wxLogNull noErrors;
- ok = conn->Request(ddeCommand) != NULL;
+ ok = conn->Execute(ddeCommand);
}
if ( !ok )
{
- // now try execute - but show the errors
- ok = conn->Execute(ddeCommand);
+ // now try request - but show the errors
+ ok = conn->Request(ddeCommand) != NULL;
}
}
#endif // wxUSE_IPC
-long wxExecute(const wxString& cmd, bool sync, wxProcess *handler)
+long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
{
wxCHECK_MSG( !!cmd, 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") );
+#endif // wxUSE_THREADS
+
wxString command;
#if wxUSE_IPC
// 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 ( !sync )
+ if ( !(flags & wxEXEC_SYNC) )
{
wxLogNull noErrors;
if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCommand) )
// 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];
+ 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
#if wxUSE_STREAMS
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.hStdInput = pipeIn[wxPipe::Read];
+ si.hStdOutput = pipeOut[wxPipe::Write];
+ si.hStdError = pipeErr[wxPipe::Write];
- si.wShowWindow = SW_HIDE;
+ // 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 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
wxLogLastError(_T("DuplicateHandle"));
}
- ::CloseHandle(hpipeStdin[1]);
+ ::CloseHandle(pipeInWrite);
}
#endif // wxUSE_STREAMS
// 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
// 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
+ // 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);
+ handler->SetPipeStreams(outStream, inStream, errStream);
+
+ bufOut.Init(outStream);
+ bufErr.Init(errStream);
}
#endif // wxUSE_STREAMS
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
DWORD tid;
HANDLE hThread = ::CreateThread(NULL,
0,
- (LPTHREAD_START_ROUTINE)wxExecuteThread,
+ wxExecuteThread,
(void *)data,
0,
&tid);
}
#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)
+ // disable all app windows while waiting for the child process to finish
#if wxUSE_GUI
+
+ /*
+ We use a dirty hack here to disable all application windows (which we
+ must do because otherwise the calls to wxYield() could lead to some very
+ unexpected reentrancies in the users code) but to avoid losing
+ focus/activation entirely when the child process terminates which would
+ happen if we simply disabled everything using wxWindowDisabler. Indeed,
+ remember that Windows will never activate a disabled window and when the
+ last childs window is closed and Windows looks for a window to activate
+ all our windows are still disabled. There is no way to enable them in
+ time because we don't know when the childs windows are going to be
+ closed, so the solution we use here is to keep one special tiny frame
+ enabled all the time. Then when the child terminates it will get
+ activated and when we close it below -- after reenabling all the other
+ windows! -- the previously active window becomes activated again and
+ everything is ok.
+ */
+ wxWindow *winActive;
{
wxBusyCursor bc;
+ // first disable all existing windows
wxWindowDisabler wd;
+
+ // then create an "invisible" frame: it has minimal size, is positioned
+ // (hopefully) outside the screen and doesn't appear on the taskbar
+ winActive = new wxFrame
+ (
+ wxTheApp->GetTopWindow(),
+ -1,
+ _T(""),
+ wxPoint(32600, 32600),
+ wxSize(1, 1),
+ wxDEFAULT_FRAME_STYLE | wxFRAME_NO_TASKBAR
+ );
+ winActive->Show();
#endif // wxUSE_GUI
- while ( data->state )
- wxYield();
+ // wait until the child process terminates
+ while ( data->state )
+ {
+#if wxUSE_STREAMS
+ 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);
+
+#if wxUSE_GUI
+ // repaint the GUI
+ wxYield();
+#else // !GUI
+ // dispatch the messages to the hidden window so that it could
+ // process the wxWM_PROC_TERMINATED notification
+ MSG msg;
+ ::PeekMessage(&msg, hwnd, 0, 0, PM_REMOVE);
+#endif // GUI/!GUI
+ }
#if wxUSE_GUI
}
+
+ // finally delete the dummy frame and, as wd has been already destroyed and
+ // the other windows reenabled, the activation is going to return to the
+ // window which had it before
+ winActive->Destroy();
#endif // wxUSE_GUI
DWORD dwExitCode = data->dwExitCode;
return dwExitCode;
#else // Win16
long instanceID = WinExec((LPCSTR) WXSTRINGCAST command, SW_SHOW);
- if (instanceID < 32) return(0);
+ if (instanceID < 32)
+ return flags & wxEXEC_SYNC ? -1 : 0;
- if (sync) {
+ if ( flags & wxEXEC_SYNC )
+ {
int running;
- do {
+ do
+ {
wxYield();
running = GetModuleUsage((HINSTANCE)instanceID);
} while (running);
}
- return(instanceID);
+ return instanceID;
#endif // Win16/32
}
-long wxExecute(char **argv, bool sync, wxProcess *handler)
+long wxExecute(wxChar **argv, int flags, wxProcess *handler)
{
wxString command;
- while ( *argv != NULL )
+ for ( ;; )
{
- command << *argv++ << ' ';
- }
+ command += *argv++;
+ if ( !*argv )
+ break;
- command.RemoveLast();
+ command += _T(' ');
+ }
- return wxExecute(command, sync, handler);
+ return wxExecute(command, flags, handler);
}
projects / wxWidgets.git / blobdiff