Doc tweaks

[wxWidgets.git] / src / common / process.cpp

diff --git a/src/common/process.cpp b/src/common/process.cpp
index d1c255ac95bc639c79543575a15074386234a162..518549e660f8571cb89841f3f3e22227fb64fb47 100644 (file)
--- a/src/common/process.cpp
+++ b/src/common/process.cpp
@@ -2,56 +2,180 @@
 // Name:        process.cpp
 // Purpose:     Process termination classes
 // Author:      Guilhem Lavaux
 // Name:        process.cpp
 // Purpose:     Process termination classes
 // Author:      Guilhem Lavaux

-// Modified by:
+// Modified by: Vadim Zeitlin to check error codes, added Detach() method

 // Created:     24/06/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Created:     24/06/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux

-// Licence:    wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "process.h"
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma implementation "process.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
-#endif
-
-#ifndef WX_PRECOMP
-#include "wx/defs.h"
+    #pragma hdrstop

 #endif
 
 #include "wx/process.h"
 
 #endif
 
 #include "wx/process.h"
 

-#if !USE_SHARED_LIBRARY
+// ----------------------------------------------------------------------------
+// event tables and such
+// ----------------------------------------------------------------------------
+
+DEFINE_EVENT_TYPE(wxEVT_END_PROCESS)
+

 IMPLEMENT_DYNAMIC_CLASS(wxProcess, wxEvtHandler)
 IMPLEMENT_DYNAMIC_CLASS(wxProcessEvent, wxEvent)
 IMPLEMENT_DYNAMIC_CLASS(wxProcess, wxEvtHandler)
 IMPLEMENT_DYNAMIC_CLASS(wxProcessEvent, wxEvent)

-#endif

 
 

-wxProcess::wxProcess(wxEvtHandler *parent, int id)
+// ============================================================================
+// wxProcess implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxProcess creation
+// ----------------------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_2
+
+wxProcess::wxProcess(wxEvtHandler *parent, bool redirect)

 {
 {

-  if (parent)
-    SetPreviousHandler(parent);
+    Init(parent, wxID_ANY, redirect ? wxPROCESS_REDIRECT : wxPROCESS_DEFAULT);
+}
+
+#endif // WXWIN_COMPATIBILITY_2_2

 
 

-  m_id = id;
+void wxProcess::Init(wxEvtHandler *parent, int id, int flags)
+{
+    if ( parent )
+        SetNextHandler(parent);
+
+    m_id         = id;
+    m_redirect   = (flags & wxPROCESS_REDIRECT) != 0;
+
+#if wxUSE_STREAMS
+    m_inputStream  = NULL;
+    m_errorStream  = NULL;
+    m_outputStream = NULL;
+#endif // wxUSE_STREAMS

 }
 
 }
 

+/* static */
+wxProcess *wxProcess::Open(const wxString& cmd, int flags)
+{
+    wxASSERT_MSG( !(flags & wxEXEC_SYNC), wxT("wxEXEC_SYNC should not be used." ));
+    wxProcess *process = new wxProcess(wxPROCESS_REDIRECT);
+    if ( !wxExecute(cmd, flags, process) )
+    {
+        // couldn't launch the process
+        delete process;
+        return NULL;
+    }
+
+    return process;
+}
+
+// ----------------------------------------------------------------------------
+// wxProcess termination
+// ----------------------------------------------------------------------------
+

 wxProcess::~wxProcess()
 {
 wxProcess::~wxProcess()
 {

+#if wxUSE_STREAMS
+    delete m_inputStream;
+    delete m_errorStream;
+    delete m_outputStream;
+#endif // wxUSE_STREAMS

 }
 
 }
 

-void wxProcess::OnTerminate(int pid)
+void wxProcess::OnTerminate(int pid, int status)

 {
 {

-  wxProcessEvent event(m_id, pid);
+    wxProcessEvent event(m_id, pid, status);

 
 

-  ProcessEvent(event);
+    if ( !ProcessEvent(event) )
+        delete this;
+    //else: the object which processed the event is responsible for deleting
+    //      us!

 }
 
 }
 

-wxProcessEvent::wxProcessEvent(int id, int pid):
-  wxEvent(id), m_pid(pid)
+void wxProcess::Detach()

 {
 {

+    SetNextHandler(NULL);
+}
+
+// ----------------------------------------------------------------------------
+// process IO redirection
+// ----------------------------------------------------------------------------
+
+#if wxUSE_STREAMS
+
+void wxProcess::SetPipeStreams(wxInputStream *inputSstream,
+                               wxOutputStream *outputStream,
+                               wxInputStream *errorStream)
+{
+    m_inputStream  = inputSstream;
+    m_errorStream  = errorStream;
+    m_outputStream = outputStream;
+}
+
+bool wxProcess::IsInputOpened() const
+{
+    return m_inputStream && m_inputStream->GetLastError() != wxSTREAM_EOF;
+}
+
+bool wxProcess::IsInputAvailable() const
+{
+    return m_inputStream && m_inputStream->CanRead();
+}
+
+bool wxProcess::IsErrorAvailable() const
+{
+    return m_errorStream && m_errorStream->CanRead();
+}
+
+#endif // wxUSE_STREAMS
+
+// ----------------------------------------------------------------------------
+// process killing
+// ----------------------------------------------------------------------------
+
+/* static */
+wxKillError wxProcess::Kill(int pid, wxSignal sig, int flags)
+{
+    wxKillError rc;
+    (void)wxKill(pid, sig, &rc, flags);
+
+    return rc;
+}
+
+/* static */
+bool wxProcess::Exists(int pid)
+{
+    switch ( Kill(pid, wxSIGNONE) )
+    {
+        case wxKILL_OK:
+        case wxKILL_ACCESS_DENIED:
+            return true;
+
+        default:
+        case wxKILL_ERROR:
+        case wxKILL_BAD_SIGNAL:
+            wxFAIL_MSG( _T("unexpected wxProcess::Kill() return code") );
+            // fall through
+
+        case wxKILL_NO_PROCESS:
+            return false;
+    }

 }
 
 }