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, bool needPipe = FALSE, int id = -1);
  56     ~wxProcess();
  57
  58     virtual void OnTerminate(int pid, int status);
  59
  60     // detach from the parent - should be called by the parent if it's deleted
  61     // before the process it started terminates
  62     void Detach();
  63
  64     // Pipe handling
  65     wxInputStream *GetInputStream() const;
  66     wxOutputStream *GetOutputStream() const;
  67
  68     // These functions should not be called by the usual user. They are only
  69     // intended to be used by wxExecute.
  70     // Install pipes
  71     void SetPipeStreams(wxInputStream *in_stream, wxOutputStream *out_stream);
  72     bool NeedPipe() const;
  73
  74 protected:
  75     int m_id;
  76     bool m_needPipe;
  77     wxInputStream *m_in_stream;
  78     wxOutputStream *m_out_stream;
  79 };
  80
  81 typedef void (wxObject::*wxProcessEventFunction)(wxProcessEvent&);
  82
  83 #define EVT_END_PROCESS(id, func) { wxEVT_END_PROCESS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxProcessEventFunction) & func, NULL},
  84
  85 #endif
  86     // _WX_PROCESSH__