wxPython/src/_process.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _process.i
   3 // Purpose:     SWIG interface stuff for wxProcess and wxExecute
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     18-June-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 %{
  20 %}
  21
  22 //---------------------------------------------------------------------------
  23
  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 enum wxKillError
  34 {
  35     wxKILL_OK,              // no error
  36     wxKILL_BAD_SIGNAL,      // no such signal
  37     wxKILL_ACCESS_DENIED,   // permission denied
  38     wxKILL_NO_PROCESS,      // no such process
  39     wxKILL_ERROR            // another, unspecified error
  40 };
  41
  42 enum wxKillFlags
  43 {
  44     wxKILL_NOCHILDREN = 0,  // don't kill children
  45     wxKILL_CHILDREN = 1     // kill children
  46 };
  47
  48
  49 enum wxSignal
  50 {
  51     wxSIGNONE = 0,  // verify if the process exists under Unix
  52     wxSIGHUP,
  53     wxSIGINT,
  54     wxSIGQUIT,
  55     wxSIGILL,
  56     wxSIGTRAP,
  57     wxSIGABRT,
  58     wxSIGIOT = wxSIGABRT,   // another name
  59     wxSIGEMT,
  60     wxSIGFPE,
  61     wxSIGKILL,
  62     wxSIGBUS,
  63     wxSIGSEGV,
  64     wxSIGSYS,
  65     wxSIGPIPE,
  66     wxSIGALRM,
  67     wxSIGTERM
  68
  69     // further signals are different in meaning between different Unix systems
  70 };
  71
  72
  73 //---------------------------------------------------------------------------
  74
  75
  76 %{
  77 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
  78 %}
  79
  80
  81 %name(Process)class wxPyProcess : public wxEvtHandler {
  82 public:
  83     // kill the process with the given PID
  84     static wxKillError Kill(int pid,
  85                             wxSignal sig = wxSIGTERM,
  86                             int flags = wxKILL_NOCHILDREN);
  87
  88     // test if the given process exists
  89     static bool Exists(int pid);
  90
  91     // this function replaces the standard popen() one: it launches a process
  92     // asynchronously and allows the caller to get the streams connected to its
  93     // std{in|out|err}
  94     //
  95     // on error NULL is returned, in any case the process object will be
  96     // deleted automatically when the process terminates and should *not* be
  97     // deleted by the caller
  98     static wxPyProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
  99
 100
 101     %pythonAppend wxPyProcess  "self._setCallbackInfo(self, Process)"
 102     wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
 103
 104     void _setCallbackInfo(PyObject* self, PyObject* _class);
 105
 106     void base_OnTerminate(int pid, int status);
 107
 108     // call Redirect before passing the object to wxExecute() to redirect the
 109     // launched process stdin/stdout, then use GetInputStream() and
 110     // GetOutputStream() to get access to them
 111     void Redirect();
 112     bool IsRedirected();
 113
 114
 115     // detach from the parent - should be called by the parent if it's deleted
 116     // before the process it started terminates
 117     void Detach();
 118
 119     wxInputStream *GetInputStream();
 120     wxInputStream *GetErrorStream();
 121     wxOutputStream *GetOutputStream();
 122
 123     void CloseOutput();
 124
 125     // return True if the child process stdout is not closed
 126     bool IsInputOpened() const;
 127
 128     // return True if any input is available on the child process stdout/err
 129     bool IsInputAvailable() const;
 130     bool IsErrorAvailable() const;
 131 };
 132
 133 //---------------------------------------------------------------------------
 134
 135
 136 class wxProcessEvent : public wxEvent {
 137 public:
 138     wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
 139     int GetPid();
 140     int GetExitCode();
 141     int m_pid, m_exitcode;
 142 };
 143
 144
 145 %constant wxEventType wxEVT_END_PROCESS;
 146
 147 %pythoncode {
 148 EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 )
 149 }
 150
 151 //---------------------------------------------------------------------------
 152
 153 enum
 154 {
 155     // execute the process asynchronously
 156     wxEXEC_ASYNC    = 0,
 157
 158     // execute it synchronously, i.e. wait until it finishes
 159     wxEXEC_SYNC     = 1,
 160
 161     // under Windows, don't hide the child even if it's IO is redirected (this
 162     // is done by default)
 163     wxEXEC_NOHIDE   = 2,
 164
 165     // under Unix, if the process is the group leader then killing -pid kills
 166     // all children as well as pid
 167     wxEXEC_MAKE_GROUP_LEADER = 4,
 168
 169     // by default synchronous execution disables all program windows to avoid
 170     // that the user interacts with the program while the child process is
 171     // running, you can use this flag to prevent this from happening
 172     wxEXEC_NODISABLE = 8
 173 };
 174
 175
 176 MustHaveApp(wxExecute);
 177
 178 long wxExecute(const wxString& command,
 179                int flags = wxEXEC_ASYNC,
 180                wxPyProcess *process = NULL);
 181
 182
 183
 184 %typemap(in,numinputs=0) wxKillError* rc ( wxKillError temp ) { $1 = &temp; }
 185 %typemap(argout) wxKillError* rc
 186 {
 187     PyObject* o;
 188     o = PyInt_FromLong((long) (*$1));
 189     $result = t_output_helper($result, o);
 190 }
 191
 192 int wxKill(long pid, wxSignal sig = wxSIGTERM, wxKillError* rc, int flags = wxKILL_NOCHILDREN);
 193
 194
 195 //---------------------------------------------------------------------------
 196 %init %{
 197     wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
 198 %}
 199 //---------------------------------------------------------------------------