include/wx/process.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/process.h
   3 // Purpose:     wxProcess class
   4 // Author:      Guilhem Lavaux
   5 // Modified by: Vadim Zeitlin to check error codes, added Detach() method
   6 // Created:     24/06/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PROCESSH__
  13 #define _WX_PROCESSH__
  14
  15 #include "wx/event.h"
  16
  17 #if wxUSE_STREAMS
  18     #include "wx/stream.h"
  19 #endif
  20
  21 #include "wx/utils.h"       // for wxSignal
  22
  23 // the wxProcess creation flags
  24 enum
  25 {
  26     // no redirection
  27     wxPROCESS_DEFAULT = 0,
  28
  29     // redirect the IO of the child process
  30     wxPROCESS_REDIRECT = 1
  31 };
  32
  33 // ----------------------------------------------------------------------------
  34 // A wxProcess object should be passed to wxExecute - than its OnTerminate()
  35 // function will be called when the process terminates.
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLIMPEXP_BASE wxProcess : public wxEvtHandler
  39 {
  40 public:
  41     // kill the process with the given PID
  42     static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM, int flags = wxKILL_NOCHILDREN);
  43
  44     // test if the given process exists
  45     static bool Exists(int pid);
  46
  47     // this function replaces the standard popen() one: it launches a process
  48     // asynchronously and allows the caller to get the streams connected to its
  49     // std{in|out|err}
  50     //
  51     // on error NULL is returned, in any case the process object will be
  52     // deleted automatically when the process terminates and should *not* be
  53     // deleted by the caller
  54     static wxProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
  55
  56
  57     // ctors
  58     wxProcess(wxEvtHandler *parent = NULL, int nId = wxID_ANY)
  59         { Init(parent, nId, wxPROCESS_DEFAULT); }
  60
  61     wxProcess(int flags) { Init(NULL, wxID_ANY, flags); }
  62
  63     virtual ~wxProcess();
  64
  65     // get the process ID of the process executed by Open()
  66     long GetPid() const { return m_pid; }
  67
  68     // may be overridden to be notified about process termination
  69     virtual void OnTerminate(int pid, int status);
  70
  71     // call this before passing the object to wxExecute() to redirect the
  72     // launched process stdin/stdout, then use GetInputStream() and
  73     // GetOutputStream() to get access to them
  74     void Redirect() { m_redirect = true; }
  75     bool IsRedirected() const { return m_redirect; }
  76
  77     // detach from the parent - should be called by the parent if it's deleted
  78     // before the process it started terminates
  79     void Detach();
  80
  81 #if wxUSE_STREAMS
  82     // Pipe handling
  83     wxInputStream *GetInputStream() const { return m_inputStream; }
  84     wxInputStream *GetErrorStream() const { return m_errorStream; }
  85     wxOutputStream *GetOutputStream() const { return m_outputStream; }
  86
  87     // close the output stream indicating that nothing more will be written
  88     void CloseOutput() { delete m_outputStream; m_outputStream = NULL; }
  89
  90     // return true if the child process stdout is not closed
  91     bool IsInputOpened() const;
  92
  93     // return true if any input is available on the child process stdout/err
  94     bool IsInputAvailable() const;
  95     bool IsErrorAvailable() const;
  96
  97     // implementation only (for wxExecute)
  98     //
  99     // NB: the streams passed here should correspond to the child process
 100     //     stdout, stdin and stderr and here the normal naming convention is
 101     //     used unlike elsewhere in this class
 102     void SetPipeStreams(wxInputStream *outStream,
 103                         wxOutputStream *inStream,
 104                         wxInputStream *errStream);
 105 #endif // wxUSE_STREAMS
 106
 107     // priority
 108         // Sets the priority to the given value: see wxPRIORITY_XXX constants.
 109         //
 110         // NB: the priority can only be set before the process is created
 111     void SetPriority(unsigned priority);
 112
 113         // Get the current priority.
 114     unsigned GetPriority() const { return m_priority; }
 115
 116     // implementation only - don't use!
 117     // --------------------------------
 118
 119     // needs to be public since it needs to be used from wxExecute() global func
 120     void SetPid(long pid) { m_pid = pid; }
 121
 122 protected:
 123     void Init(wxEvtHandler *parent, int id, int flags);
 124
 125     int m_id;
 126     long m_pid;
 127
 128     unsigned m_priority;
 129
 130 #if wxUSE_STREAMS
 131     // these streams are connected to stdout, stderr and stdin of the child
 132     // process respectively (yes, m_inputStream corresponds to stdout -- very
 133     // confusing but too late to change now)
 134     wxInputStream  *m_inputStream,
 135                    *m_errorStream;
 136     wxOutputStream *m_outputStream;
 137 #endif // wxUSE_STREAMS
 138
 139     bool m_redirect;
 140
 141     DECLARE_DYNAMIC_CLASS(wxProcess)
 142     wxDECLARE_NO_COPY_CLASS(wxProcess);
 143 };
 144
 145 // ----------------------------------------------------------------------------
 146 // wxProcess events
 147 // ----------------------------------------------------------------------------
 148
 149 class WXDLLIMPEXP_FWD_BASE wxProcessEvent;
 150
 151 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_BASE, wxEVT_END_PROCESS, wxProcessEvent );
 152
 153 class WXDLLIMPEXP_BASE wxProcessEvent : public wxEvent
 154 {
 155 public:
 156     wxProcessEvent(int nId = 0, int pid = 0, int exitcode = 0) : wxEvent(nId)
 157     {
 158         m_eventType = wxEVT_END_PROCESS;
 159         m_pid = pid;
 160         m_exitcode = exitcode;
 161     }
 162
 163     // accessors
 164         // PID of process which terminated
 165     int GetPid() { return m_pid; }
 166
 167         // the exit code
 168     int GetExitCode() { return m_exitcode; }
 169
 170     // implement the base class pure virtual
 171     virtual wxEvent *Clone() const { return new wxProcessEvent(*this); }
 172
 173 public:
 174     int m_pid,
 175         m_exitcode;
 176
 177     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxProcessEvent)
 178 };
 179
 180 typedef void (wxEvtHandler::*wxProcessEventFunction)(wxProcessEvent&);
 181
 182 #define wxProcessEventHandler(func) \
 183     wxEVENT_HANDLER_CAST(wxProcessEventFunction, func)
 184
 185 #define EVT_END_PROCESS(id, func) \
 186    wx__DECLARE_EVT1(wxEVT_END_PROCESS, id, wxProcessEventHandler(func))
 187
 188 #endif // _WX_PROCESSH__