X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0c85071392af92841050de11e1b71d0b155f749d..ef094fa075bc56bcbc33b12159c395ea28afda3b:/include/wx/process.h?ds=sidebyside diff --git a/include/wx/process.h b/include/wx/process.h index 34d54a50cb..142d18d8da 100644 --- a/include/wx/process.h +++ b/include/wx/process.h @@ -6,24 +6,34 @@ // Created: 24/06/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_PROCESSH__ #define _WX_PROCESSH__ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #pragma interface "process.h" #endif -#include "wx/defs.h" -#include "wx/object.h" #include "wx/event.h" #if wxUSE_STREAMS #include "wx/stream.h" #endif +#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. @@ -31,13 +41,28 @@ class WXDLLEXPORT wxProcess : public wxEvtHandler { -DECLARE_DYNAMIC_CLASS(wxProcess) - public: + // 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 id = -1) - { Init(parent, id, FALSE); } - wxProcess(wxEvtHandler *parent, bool redirect) - { Init(parent, -1, redirect); } + { Init(parent, id, wxPROCESS_DEFAULT); } + + wxProcess(int flags) { Init(NULL, -1, flags); } virtual ~wxProcess(); @@ -63,30 +88,57 @@ public: // 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) - 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 + // for backwards compatibility only, don't use +#if WXWIN_COMPATIBILITY_2_2 + wxProcess(wxEvtHandler *parent, bool redirect) + { Init(parent, -1, redirect ? wxPROCESS_REDIRECT : wxPROCESS_DEFAULT); } +#endif // WXWIN_COMPATIBILITY_2_2 + protected: - void Init(wxEvtHandler *parent, int id, bool redirect); + void Init(wxEvtHandler *parent, int id, int flags); 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; #endif // wxUSE_STREAMS bool m_redirect; + + DECLARE_DYNAMIC_CLASS(wxProcess) + DECLARE_NO_COPY_CLASS(wxProcess) }; // ---------------------------------------------------------------------------- // wxProcess events // ---------------------------------------------------------------------------- +BEGIN_DECLARE_EVENT_TYPES() + DECLARE_EVENT_TYPE(wxEVT_END_PROCESS, 440) +END_DECLARE_EVENT_TYPES() + class WXDLLEXPORT wxProcessEvent : public wxEvent { public: @@ -104,20 +156,24 @@ public: // 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; + int m_pid, + m_exitcode; DECLARE_DYNAMIC_CLASS(wxProcessEvent) }; -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EVENT_TYPE(wxEVT_END_PROCESS, 440) -END_DECLARE_EVENT_TYPES() - -typedef void (wxObject::*wxProcessEventFunction)(wxProcessEvent&); +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), + DECLARE_EVENT_TABLE_ENTRY( \ + wxEVT_END_PROCESS, id, -1, \ + (wxObjectEventFunction) \ + (wxEventFunction) \ + (wxProcessEventFunction) & func, NULL), #endif // _WX_PROCESSH__