include/wx/process.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PROCESSH__
  13 #define _WX_PROCESSH__
  14
  15 #ifdef __GNUG__
  16     #pragma interface "process.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/object.h"
  21 #include "wx/event.h"
  22 #include "wx/stream.h"
  23
  24 // Process Event handling
  25 class WXDLLEXPORT wxProcessEvent : public wxEvent
  26 {
  27 DECLARE_DYNAMIC_CLASS(wxProcessEvent)
  28
  29 public:
  30     wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0) : wxEvent(id)
  31     {
  32         m_eventType = wxEVT_END_PROCESS;
  33         m_pid = pid;
  34         m_exitcode = exitcode;
  35     }
  36
  37     // accessors
  38         // PID of process which terminated
  39     int GetPid() { return m_pid; }
  40
  41         // the exit code
  42     int GetExitCode() { return m_exitcode; }
  43
  44 public:
  45     int m_pid, m_exitcode;
  46 };
  47
  48 // A wxProcess object should be passed to wxExecute - than its OnTerminate()
  49 // function will be called when the process terminates.
  50 class WXDLLEXPORT wxProcess : public wxEvtHandler
  51 {
  52 DECLARE_DYNAMIC_CLASS(wxProcess)
  53
  54 public:
  55     wxProcess(wxEvtHandler *parent = (wxEvtHandler *) NULL, int id = -1)
  56         { Init(parent, id, FALSE); }
  57     wxProcess(wxEvtHandler *parent, bool redirect)
  58         { Init(parent, -1, redirect); }
  59
  60     virtual ~wxProcess();
  61
  62     // may be overridden to be notified about process termination
  63     virtual void OnTerminate(int pid, int status);
  64
  65     // call this before passing the object to wxExecute() to redirect the
  66     // launched process stdin/stdout, then use GetInputStream() and
  67     // GetOutputStream() to get access to them
  68     void Redirect() { m_redirect = TRUE; }
  69     bool IsRedirected() const { return m_redirect; }
  70
  71     // detach from the parent - should be called by the parent if it's deleted
  72     // before the process it started terminates
  73     void Detach();
  74
  75     // Pipe handling
  76     wxInputStream *GetInputStream() const { return m_inputStream; }
  77     wxOutputStream *GetOutputStream() const { return m_outputStream; }
  78
  79     // implementation only (for wxExecute)
  80     void SetPipeStreams(wxInputStream *inStream, wxOutputStream *outStream);
  81
  82 protected:
  83     void Init(wxEvtHandler *parent, int id, bool redirect);
  84
  85     int m_id;
  86
  87     wxInputStream  *m_inputStream;
  88     wxOutputStream *m_outputStream;
  89
  90     bool m_redirect;
  91 };
  92
  93 typedef void (wxObject::*wxProcessEventFunction)(wxProcessEvent&);
  94
  95 #define EVT_END_PROCESS(id, func) { wxEVT_END_PROCESS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxProcessEventFunction) & func, NULL},
  96
  97 #endif
  98     // _WX_PROCESSH__