]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/utilsexc.cpp
support for Mac Help Button added (wxID_HELP) is automatically translated
[wxWidgets.git] / src / msw / utilsexc.cpp
index 3894aaeea704e9b6c63574a1fde7838844ba894c..4dcec53bde5bb06ccef8b037593a0af3886ae2f2 100644 (file)
@@ -5,8 +5,8 @@
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
-// Copyright:   (c) 1998-2002 wxWindows dev team
-// Licence:     wxWindows license
+// Copyright:   (c) 1998-2002 wxWidgets dev team
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation
 #endif
 
     #include "wx/utils.h"
     #include "wx/app.h"
     #include "wx/intl.h"
+    #include "wx/log.h"
 #endif
 
-#include "wx/log.h"
+#include "wx/stream.h"
+#include "wx/process.h"
 
-#ifdef __WIN32__
-    #include "wx/stream.h"
-    #include "wx/process.h"
-#endif
+#include "wx/apptrait.h"
+
+#include "wx/module.h"
 
 #include "wx/msw/private.h"
 
 #include <ctype.h>
 
-#if !defined(__GNUWIN32__) && !defined(__WXWINE__) && !defined(__SALFORDC__) && !defined(__WXMICROWIN__)
+#if !defined(__GNUWIN32__) && !defined(__SALFORDC__) && !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__) && !defined(__WXMICROWIN__)
-#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
 
+// implemented in utils.cpp
+extern "C" WXDLLIMPEXP_BASE HWND
+wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
+
 // ----------------------------------------------------------------------------
 // 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;
 
 // ----------------------------------------------------------------------------
@@ -105,12 +113,10 @@ struct wxExecuteData
 public:
     ~wxExecuteData()
     {
-#ifndef __WIN16__
         if ( !::CloseHandle(hProcess) )
         {
             wxLogLastError(wxT("CloseHandle(hProcess)"));
         }
-#endif
     }
 
     HWND       hWnd;          // window to send wxWM_PROC_TERMINATED to
@@ -121,7 +127,28 @@ public:
     bool       state;         // set to FALSE when the process finishes
 };
 
-#if defined(__WIN32__) && wxUSE_STREAMS
+class wxExecuteModule : public wxModule
+{
+public:
+    virtual bool OnInit() { return true; }
+    virtual void OnExit()
+    {
+        if ( *gs_classForHiddenWindow )
+        {
+            if ( !::UnregisterClass(wxMSWEXEC_WNDCLASSNAME, wxGetInstance()) )
+            {
+                wxLogLastError(_T("UnregisterClass(wxExecClass)"));
+            }
+
+            gs_classForHiddenWindow = NULL;
+        }
+    }
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxExecuteModule)
+};
+
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
 
 // ----------------------------------------------------------------------------
 // wxPipeStreams
@@ -137,13 +164,15 @@ public:
     bool IsOpened() const { return m_hInput != INVALID_HANDLE_VALUE; }
 
     // returns TRUE if there is any data to be read from the pipe
-    bool IsAvailable() const;
+    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
@@ -157,6 +186,8 @@ protected:
 
 protected:
     HANDLE m_hOutput;
+
+    DECLARE_NO_COPY_CLASS(wxPipeOutputStream)
 };
 
 // define this to let wxexec.cpp know that we know what we're doing
@@ -204,21 +235,12 @@ public:
     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;
 
@@ -251,8 +273,6 @@ private:
 // implementation
 // ============================================================================
 
-#ifdef __WIN32__
-
 // ----------------------------------------------------------------------------
 // process termination detecting support
 // ----------------------------------------------------------------------------
@@ -260,7 +280,7 @@ private:
 // thread function for the thread monitoring the process termination
 static DWORD __stdcall wxExecuteThread(void *arg)
 {
-    wxExecuteData *data = (wxExecuteData*)arg;
+    wxExecuteData * const data = (wxExecuteData *)arg;
 
     if ( ::WaitForSingleObject(data->hProcess, INFINITE) != WAIT_OBJECT_0 )
     {
@@ -291,7 +311,7 @@ LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
     {
         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,
@@ -314,7 +334,7 @@ LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
     }
     else
     {
-        return DefWindowProc(hWnd, message, wParam, lParam);
+        return ::DefWindowProc(hWnd, message, wParam, lParam);
     }
 }
 
@@ -322,7 +342,7 @@ LRESULT APIENTRY _EXPORT wxExecuteWindowCbk(HWND hWnd, UINT message,
 // implementation of IO redirection support classes
 // ============================================================================
 
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
 
 // ----------------------------------------------------------------------------
 // wxPipeInputStreams
@@ -339,7 +359,7 @@ wxPipeInputStream::~wxPipeInputStream()
         ::CloseHandle(m_hInput);
 }
 
-bool wxPipeInputStream::IsAvailable() const
+bool wxPipeInputStream::CanRead() const
 {
     if ( !IsOpened() )
         return FALSE;
@@ -368,9 +388,12 @@ bool wxPipeInputStream::IsAvailable() const
         // it had been closed
         ::CloseHandle(m_hInput);
 
-        wxConstCast(this, wxPipeInputStream)->m_hInput = INVALID_HANDLE_VALUE;
+        wxPipeInputStream *self = wxConstCast(this, wxPipeInputStream);
 
-        return FALSE;
+        self->m_hInput = INVALID_HANDLE_VALUE;
+        self->m_lasterror = wxSTREAM_EOF;
+
+        nAvailable = 0;
     }
 
     return nAvailable != 0;
@@ -378,26 +401,22 @@ bool wxPipeInputStream::IsAvailable() const
 
 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
-    if ( !IsAvailable() )
+    if ( !IsOpened() )
     {
         m_lasterror = wxSTREAM_EOF;
 
         return 0;
     }
 
-    m_lasterror = wxSTREAM_NOERROR;
-
     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 occured
     return bytesRead;
 }
 
@@ -408,6 +427,21 @@ size_t wxPipeInputStream::OnSysRead(void *buffer, size_t len)
 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(_T("SetNamedPipeHandleState(PIPE_NOWAIT)"));
+    }
 }
 
 wxPipeOutputStream::~wxPipeOutputStream()
@@ -417,24 +451,33 @@ wxPipeOutputStream::~wxPipeOutputStream()
 
 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 // wxUSE_STREAMS
 
-#endif // Win32
-
 // ============================================================================
 // wxExecute functions family
 // ============================================================================
@@ -446,10 +489,10 @@ static bool wxExecuteDDE(const wxString& ddeServer,
                          const wxString& ddeTopic,
                          const wxString& ddeCommand)
 {
-    bool ok;
+    bool ok wxDUMMY_INITIALIZE(false);
 
     wxDDEClient client;
-    wxConnectionBase *conn = client.MakeConnection(_T(""),
+    wxConnectionBase *conn = client.MakeConnection(wxEmptyString,
                                                    ddeServer,
                                                    ddeTopic);
     if ( !conn )
@@ -458,21 +501,23 @@ static bool wxExecuteDDE(const wxString& ddeServer,
     }
     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 IE and other MS stuff - use
-        // XTYP_REQUEST!
+        // 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!
         //
-        // so we try it first and then the other one if it
-        // failed
+        // 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
+            // now try execute -- but show the errors
             ok = conn->Execute(ddeCommand);
         }
     }
@@ -486,6 +531,14 @@ 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
@@ -580,12 +633,10 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
         command = cmd;
     }
 
-#if defined(__WIN32__) && !defined(__TWIN32__)
-
     // the IO redirection is only supported with wxUSE_STREAMS
     BOOL redirect = FALSE;
 
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
     wxPipe pipeIn, pipeOut, pipeErr;
 
     // we'll save here the copy of pipeIn[Write]
@@ -613,7 +664,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
     wxZeroMemory(si);
     si.cb = sizeof(si);
 
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
     if ( redirect )
     {
         si.dwFlags = STARTF_USESTDHANDLES;
@@ -656,7 +707,10 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
 #endif // wxUSE_STREAMS
 
     PROCESS_INFORMATION pi;
-    DWORD dwFlags = CREATE_DEFAULT_ERROR_MODE | CREATE_SUSPENDED;
+    DWORD dwFlags = CREATE_SUSPENDED;
+#ifndef __WXWINCE__
+    dwFlags |= CREATE_DEFAULT_ERROR_MODE ;
+#endif
 
     bool ok = ::CreateProcess
                 (
@@ -673,7 +727,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
                  &pi                // process info
                 ) != 0;
 
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
     // we can close the pipe ends used by child anyhow
     if ( redirect )
     {
@@ -685,7 +739,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
 
     if ( !ok )
     {
-#if wxUSE_STREAMS
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
         // close the other handles too
         if ( redirect )
         {
@@ -699,7 +753,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
         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,
@@ -722,29 +776,15 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
     }
 #endif // wxUSE_STREAMS
 
-    // 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)"));
-        }
-    }
-
     // 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
@@ -798,7 +838,7 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
 
     ::CloseHandle(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.empty() )
@@ -829,6 +869,12 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
                 // ok, process ready to accept DDE requests
                 ok = wxExecuteDDE(ddeServer, ddeTopic, ddeCommand);
         }
+
+        if ( !ok )
+        {
+            wxLogDebug(_T("Failed to send DDE request to the process \"%s\"."),
+                       cmd.c_str());
+        }
     }
 #endif // wxUSE_IPC
 
@@ -840,56 +886,35 @@ long wxExecute(const wxString& cmd, int flags, wxProcess *handler)
         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, _T("no wxAppTraits in wxExecute()?") );
 
-        wxWindowDisabler wd;
-#endif // wxUSE_GUI
+    // disable all app windows while waiting for the child process to finish
+    void *cookie = traits->BeforeChildWaitLoop();
 
-        // wait until the child process terminates
-        while ( data->state )
-        {
-#if wxUSE_STREAMS
-            bufOut.Update();
-            bufErr.Update();
+    // wait until the child process terminates
+    while ( data->state )
+    {
+#if wxUSE_STREAMS && !defined(__WXWINCE__)
+        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);
 
-            // repaint the GUI
-            wxYield();
-        }
-
-#if wxUSE_GUI
+        // we must process messages or we'd never get wxWM_PROC_TERMINATED
+        traits->AlwaysYield();
     }
-#endif // wxUSE_GUI
+
+    traits->AfterChildWaitLoop(cookie);
 
     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 flags & wxEXEC_SYNC ? -1 : 0;
-
-    if ( flags & wxEXEC_SYNC )
-    {
-        int running;
-        do
-        {
-            wxYield();
-            running = GetModuleUsage((HINSTANCE)instanceID);
-        } while (running);
-    }
-
-    return instanceID;
-#endif // Win16/32
 }
 
 long wxExecute(wxChar **argv, int flags, wxProcess *handler)