clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/process.h b/include/wx/process.h
index 91c71032ebd3b171e7ceb3f40af4b9917ffeaf05..adefc2620a3db0ee8640d775bf648bab1c3a305b 100644 (file)
--- a/include/wx/process.h
+++ b/include/wx/process.h
@@ -6,13 +6,13 @@
 // Created:     24/06/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Guilhem Lavaux
 // 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "process.h"
 #endif
 
     #pragma interface "process.h"
 #endif
 


@@ -24,18 +24,45 @@
 
 #include "wx/utils.h"       // for wxSignal
 
 
 #include "wx/utils.h"       // for wxSignal
 

+// the wxProcess creation flags
+enum
+{
+    // 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.
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // A wxProcess object should be passed to wxExecute - than its OnTerminate()
 // function will be called when the process terminates.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxProcess : public wxEvtHandler
+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);
+
+    // 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 = (wxEvtHandler *) NULL, int nId = wxID_ANY)
+        { Init(parent, nId, wxPROCESS_DEFAULT); }
+
+    wxProcess(int flags) { Init(NULL, wxID_ANY, flags); }

 
     virtual ~wxProcess();
 
 
     virtual ~wxProcess();
 


@@ -45,7 +72,7 @@ public:
     // 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
     // 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


@@ -61,24 +88,38 @@ 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
 

-    // kill the process with the given PID
-    static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM);
-
-    // test if the given process exists
-    static bool Exists(int pid);
+    // for backwards compatibility only, don't use
+#if WXWIN_COMPATIBILITY_2_2
+    wxProcess(wxEvtHandler *parent, bool redirect)
+        { Init(parent, wxID_ANY, redirect ? wxPROCESS_REDIRECT : wxPROCESS_DEFAULT); }
+#endif // WXWIN_COMPATIBILITY_2_2

 
 protected:
 
 protected:

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

 
     int m_id;
 
 #if wxUSE_STREAMS
 
     int m_id;
 
 #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;
     wxInputStream  *m_inputStream,
                    *m_errorStream;
     wxOutputStream *m_outputStream;


@@ -87,6 +128,7 @@ protected:
     bool m_redirect;
 
     DECLARE_DYNAMIC_CLASS(wxProcess)
     bool m_redirect;
 
     DECLARE_DYNAMIC_CLASS(wxProcess)

+    DECLARE_NO_COPY_CLASS(wxProcess)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -94,13 +136,13 @@ protected:
 // ----------------------------------------------------------------------------
 
 BEGIN_DECLARE_EVENT_TYPES()
 // ----------------------------------------------------------------------------
 
 BEGIN_DECLARE_EVENT_TYPES()

-    DECLARE_EVENT_TYPE(wxEVT_END_PROCESS, 440)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, 440)

 END_DECLARE_EVENT_TYPES()
 
 END_DECLARE_EVENT_TYPES()
 

-class WXDLLEXPORT wxProcessEvent : public wxEvent
+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;


@@ -121,17 +163,15 @@ public:
     int m_pid,
         m_exitcode;
 
     int m_pid,
         m_exitcode;
 

-    DECLARE_DYNAMIC_CLASS(wxProcessEvent)
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxProcessEvent)

 };
 
 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 
 #define EVT_END_PROCESS(id, func) \
    DECLARE_EVENT_TABLE_ENTRY( \
 };
 
 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 
 #define EVT_END_PROCESS(id, func) \
    DECLARE_EVENT_TABLE_ENTRY( \

-           wxEVT_END_PROCESS, id, -1, \
-           (wxObjectEventFunction) \
-           (wxEventFunction) \
-           (wxProcessEventFunction) & func, NULL),
+           wxEVT_END_PROCESS, id, wxID_ANY, \
+           (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxProcessEventFunction, & func ), NULL),

 
 #endif
     // _WX_PROCESSH__
 
 #endif
     // _WX_PROCESSH__