Always NUL-terminate wxPrintfConvSpec::m_szFlags.

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

diff --git a/include/wx/process.h b/include/wx/process.h
index ea2fc303d880e9f1d437ac7dcdec8ffa28ded5c9..2f1027ae64d76cd3999892e66d4a53b7c97f4014 100644 (file)
--- a/include/wx/process.h
+++ b/include/wx/process.h
@@ -1,74 +1,77 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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"
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"

 #include "wx/event.h"
 
 #if wxUSE_STREAMS
 #include "wx/event.h"
 
 #if wxUSE_STREAMS

-#include "wx/stream.h"
+    #include "wx/stream.h"

 #endif
 
 #endif
 

-// Process Event handling
-class WXDLLEXPORT wxProcessEvent : public wxEvent
-{
-DECLARE_DYNAMIC_CLASS(wxProcessEvent)
-
-public:
-    wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0) : wxEvent(id)
-    {
-        m_eventType = wxEVT_END_PROCESS;
-        m_pid = pid;
-        m_exitcode = exitcode;
-    }
-
-    // accessors
-        // PID of process which terminated
-    int GetPid() { return m_pid; }
+#include "wx/utils.h"       // for wxSignal

 
 

-        // the exit code
-    int GetExitCode() { return m_exitcode; }
+// the wxProcess creation flags
+enum
+{
+    // no redirection
+    wxPROCESS_DEFAULT = 0,

 
 

-public:
-    int m_pid, m_exitcode;
+    // 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.
 // 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)
+// ----------------------------------------------------------------------------

 
 

+class WXDLLIMPEXP_BASE wxProcess : public wxEvtHandler
+{

 public:
 public:

-    wxProcess(wxEvtHandler *parent = (wxEvtHandler *) NULL, int id = -1)
-        { Init(parent, id, FALSE); }
-    wxProcess(wxEvtHandler *parent, bool redirect)
-        { Init(parent, -1, redirect); }
+    // 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();
 
 
     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
     // 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; }
+    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
     bool IsRedirected() const { return m_redirect; }
 
     // detach from the parent - should be called by the parent if it's deleted


@@ -84,29 +87,91 @@ public:
     // close the output stream indicating that nothing more will be written
     void CloseOutput() { delete m_outputStream; m_outputStream = NULL; }
 
     // 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)
     // implementation only (for wxExecute)

-    void SetPipeStreams(wxInputStream *inStream,
-                        wxOutputStream *outStream,
+    //
+    // 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
 
                         wxInputStream *errStream);
 #endif // wxUSE_STREAMS
 

+    // implementation only - don't use!
+    // --------------------------------
+
+    // needs to be public since it needs to be used from wxExecute() global func
+    void SetPid(long pid) { m_pid = pid; }
+

 protected:
 protected:

-    void Init(wxEvtHandler *parent, int id, bool redirect);
+    void Init(wxEvtHandler *parent, int id, int flags);

 
     int m_id;
 
     int m_id;

+    long m_pid;

 
 #if wxUSE_STREAMS
 
 #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;
     wxInputStream  *m_inputStream,
                    *m_errorStream;
     wxOutputStream *m_outputStream;
 #endif // wxUSE_STREAMS
 
     bool m_redirect;

+
+    DECLARE_DYNAMIC_CLASS(wxProcess)
+    wxDECLARE_NO_COPY_CLASS(wxProcess);

 };
 
 };
 

-typedef void (wxObject::*wxProcessEventFunction)(wxProcessEvent&);
+// ----------------------------------------------------------------------------
+// wxProcess events
+// ----------------------------------------------------------------------------

 
 

-#define EVT_END_PROCESS(id, func) { wxEVT_END_PROCESS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxProcessEventFunction) & func, NULL},
+class WXDLLIMPEXP_FWD_BASE wxProcessEvent;

 
 

-#endif
-    // _WX_PROCESSH__
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, wxProcessEvent );
+
+class WXDLLIMPEXP_BASE wxProcessEvent : public wxEvent
+{
+public:
+    wxProcessEvent(int nId = 0, int pid = 0, int exitcode = 0) : wxEvent(nId)
+    {
+        m_eventType = wxEVT_END_PROCESS;
+        m_pid = pid;
+        m_exitcode = exitcode;
+    }
+
+    // accessors
+        // PID of process which terminated
+    int GetPid() { return m_pid; }
+
+        // the exit code
+    int GetExitCode() { return m_exitcode; }
+
+    // implement the base class pure virtual
+    virtual wxEvent *Clone() const { return new wxProcessEvent(*this); }
+
+public:
+    int m_pid,
+        m_exitcode;
+
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxProcessEvent)
+};
+
+typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
+
+#define wxProcessEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxProcessEventFunction, func)
+
+#define EVT_END_PROCESS(id, func) \
+   wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))
+
+#endif // _WX_PROCESSH__