Added wxPGChoices::Copy(), tweaked related documentation

[wxWidgets.git] / include / wx / process.h

diff --git a/include/wx/process.h b/include/wx/process.h
index b612306a661a2c313f557da3c16fe4547860af19..22be1732308380ba3de3dbd6928383a883f388a8 100644 (file)
--- a/include/wx/process.h
+++ b/include/wx/process.h
@@ -1,32 +1,143 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        process.h
+// Name:        wx/process.h

 // Purpose:     wxProcess class
 // Author:      Guilhem Lavaux
 // Modified by: Vadim Zeitlin to check error codes, added Detach() method
 // Created:     24/06/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Guilhem Lavaux
 // Purpose:     wxProcess class
 // Author:      Guilhem Lavaux
 // Modified by: Vadim Zeitlin to check error codes, added Detach() method
 // Created:     24/06/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Guilhem Lavaux

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

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROCESSH__
 #define _WX_PROCESSH__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_PROCESSH__
 #define _WX_PROCESSH__
 

-#ifdef __GNUG__
-    #pragma interface "process.h"
+#include "wx/event.h"
+
+#if wxUSE_STREAMS
+    #include "wx/stream.h"

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/event.h"
+#include "wx/utils.h"       // for wxSignal

 
 

-// Process Event handling
-class WXDLLEXPORT wxProcessEvent : public wxEvent
+// the wxProcess creation flags
+enum

 {
 {

-DECLARE_DYNAMIC_CLASS(wxProcessEvent)
+    // no redirection
+    wxPROCESS_DEFAULT = 0,
+
+    // redirect the IO of the child process
+    wxPROCESS_REDIRECT = 1
+};
+
+// ----------------------------------------------------------------------------
+// A wxProcess object should be passed to wxExecute - than its OnTerminate()
+// function will be called when the process terminates.
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxProcess : public wxEvtHandler
+{
+public:
+    // kill the process with the given PID
+    static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM, int flags = wxKILL_NOCHILDREN);
+
+    // test if the given process exists
+    static bool Exists(int pid);
+
+    // this function replaces the standard popen() one: it launches a process
+    // asynchronously and allows the caller to get the streams connected to its
+    // std{in|out|err}
+    //
+    // on error NULL is returned, in any case the process object will be
+    // deleted automatically when the process terminates and should *not* be
+    // deleted by the caller
+    static wxProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
+
+
+    // ctors
+    wxProcess(wxEvtHandler *parent = NULL, int nId = wxID_ANY)
+        { Init(parent, nId, wxPROCESS_DEFAULT); }
+
+    wxProcess(int flags) { Init(NULL, wxID_ANY, flags); }
+
+    virtual ~wxProcess();
+
+    // get the process ID of the process executed by Open()
+    long GetPid() const { return m_pid; }
+
+    // may be overridden to be notified about process termination
+    virtual void OnTerminate(int pid, int status);
+
+    // call this before passing the object to wxExecute() to redirect the
+    // launched process stdin/stdout, then use GetInputStream() and
+    // GetOutputStream() to get access to them
+    void Redirect() { m_redirect = true; }
+    bool IsRedirected() const { return m_redirect; }
+
+    // detach from the parent - should be called by the parent if it's deleted
+    // before the process it started terminates
+    void Detach();
+
+#if wxUSE_STREAMS
+    // Pipe handling
+    wxInputStream *GetInputStream() const { return m_inputStream; }
+    wxInputStream *GetErrorStream() const { return m_errorStream; }
+    wxOutputStream *GetOutputStream() const { return m_outputStream; }
+
+    // close the output stream indicating that nothing more will be written
+    void CloseOutput() { delete m_outputStream; m_outputStream = NULL; }
+
+    // return true if the child process stdout is not closed
+    bool IsInputOpened() const;
+
+    // return true if any input is available on the child process stdout/err
+    bool IsInputAvailable() const;
+    bool IsErrorAvailable() const;

 
 

+    // implementation only (for wxExecute)
+    //
+    // NB: the streams passed here should correspond to the child process
+    //     stdout, stdin and stderr and here the normal naming convention is
+    //     used unlike elsewhere in this class
+    void SetPipeStreams(wxInputStream *outStream,
+                        wxOutputStream *inStream,
+                        wxInputStream *errStream);
+#endif // wxUSE_STREAMS
+
+protected:
+    void Init(wxEvtHandler *parent, int id, int flags);
+    void SetPid(long pid) { m_pid = pid; }
+
+    int m_id;
+    long m_pid;
+
+#if wxUSE_STREAMS
+    // these streams are connected to stdout, stderr and stdin of the child
+    // process respectively (yes, m_inputStream corresponds to stdout -- very
+    // confusing but too late to change now)
+    wxInputStream  *m_inputStream,
+                   *m_errorStream;
+    wxOutputStream *m_outputStream;
+#endif // wxUSE_STREAMS
+
+    bool m_redirect;
+
+    DECLARE_DYNAMIC_CLASS(wxProcess)
+    DECLARE_NO_COPY_CLASS(wxProcess)
+};
+
+// ----------------------------------------------------------------------------
+// wxProcess events
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_FWD_BASE wxProcessEvent;
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, wxProcessEvent )
+
+class WXDLLIMPEXP_BASE wxProcessEvent : public wxEvent
+{

 public:
 public:

-    wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0) : wxEvent(id)
+    wxProcessEvent(int nId = 0, int pid = 0, int exitcode = 0) : wxEvent(nId)

     {
         m_eventType = wxEVT_END_PROCESS;
         m_pid = pid;
     {
         m_eventType = wxEVT_END_PROCESS;
         m_pid = pid;


@@ -40,32 +151,22 @@ public:
         // the exit code
     int GetExitCode() { return m_exitcode; }
 
         // the exit code
     int GetExitCode() { return m_exitcode; }
 

-public:
-    int m_pid, m_exitcode;
-};
-
-// A wxProcess object should be passed to wxExecute - than its OnTerminate()
-// function will be called when the process terminates.
-class WXDLLEXPORT wxProcess : public wxEvtHandler
-{
-DECLARE_DYNAMIC_CLASS(wxProcess)
+    // implement the base class pure virtual
+    virtual wxEvent *Clone() const { return new wxProcessEvent(*this); }

 
 public:
 
 public:

-    wxProcess(wxEvtHandler *parent = (wxEvtHandler *) NULL, int id = -1);
-
-    virtual void OnTerminate(int pid, int status);
-
-    // detach from the parent - should be called by the parent if it's deleted
-    // before the process it started terminates
-    void Detach();
+    int m_pid,
+        m_exitcode;

 
 

-protected:
-    int m_id;
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxProcessEvent)

 };
 
 };
 

-typedef void (wxObject::*wxProcessEventFunction)(wxProcessEvent&);
+typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);

 
 

-#define EVT_END_PROCESS(id, func) { wxEVT_END_PROCESS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxProcessEventFunction) & func, NULL},
+#define wxProcessEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxProcessEventFunction, func)

 
 

-#endif
-    // _WX_PROCESSH__
+#define EVT_END_PROCESS(id, func) \
+   wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))
+
+#endif // _WX_PROCESSH__