]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_process.i
Version
[wxWidgets.git] / wxPython / src / _process.i
CommitLineData
d14a1e28
RD
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
24enum
25{
26 // no redirection
27 wxPROCESS_DEFAULT = 0,
28
29 // redirect the IO of the child process
30 wxPROCESS_REDIRECT = 1
31};
32
33enum 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
c1718b2c
RD
42enum wxKillFlags
43{
44 wxKILL_NOCHILDREN = 0, // don't kill children
45 wxKILL_CHILDREN = 1 // kill children
46};
47
48
d14a1e28
RD
49enum 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%{
77IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
78%}
79
80
1b8c7ba6
RD
81%rename(Process) wxPyProcess;
82class wxPyProcess : public wxEvtHandler {
d14a1e28
RD
83public:
84 // kill the process with the given PID
c1718b2c
RD
85 static wxKillError Kill(int pid,
86 wxSignal sig = wxSIGTERM,
87 int flags = wxKILL_NOCHILDREN);
d14a1e28
RD
88
89 // test if the given process exists
90 static bool Exists(int pid);
91
92 // this function replaces the standard popen() one: it launches a process
93 // asynchronously and allows the caller to get the streams connected to its
94 // std{in|out|err}
95 //
96 // on error NULL is returned, in any case the process object will be
97 // deleted automatically when the process terminates and should *not* be
98 // deleted by the caller
99 static wxPyProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
100
101
2b9048c5 102 %pythonAppend wxPyProcess "self._setCallbackInfo(self, Process)"
d14a1e28
RD
103 wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
104
105 void _setCallbackInfo(PyObject* self, PyObject* _class);
106
107 void base_OnTerminate(int pid, int status);
108
109 // call Redirect before passing the object to wxExecute() to redirect the
110 // launched process stdin/stdout, then use GetInputStream() and
111 // GetOutputStream() to get access to them
112 void Redirect();
113 bool IsRedirected();
114
115
116 // detach from the parent - should be called by the parent if it's deleted
117 // before the process it started terminates
118 void Detach();
119
120 wxInputStream *GetInputStream();
121 wxInputStream *GetErrorStream();
122 wxOutputStream *GetOutputStream();
123
124 void CloseOutput();
125
dd9f7fea 126 // return True if the child process stdout is not closed
d14a1e28
RD
127 bool IsInputOpened() const;
128
dd9f7fea 129 // return True if any input is available on the child process stdout/err
d14a1e28
RD
130 bool IsInputAvailable() const;
131 bool IsErrorAvailable() const;
132};
133
134//---------------------------------------------------------------------------
135
136
137class wxProcessEvent : public wxEvent {
138public:
139 wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
140 int GetPid();
141 int GetExitCode();
142 int m_pid, m_exitcode;
143};
144
145
146%constant wxEventType wxEVT_END_PROCESS;
147
148%pythoncode {
149EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 )
150}
151
152//---------------------------------------------------------------------------
153
154enum
155{
156 // execute the process asynchronously
157 wxEXEC_ASYNC = 0,
158
159 // execute it synchronously, i.e. wait until it finishes
160 wxEXEC_SYNC = 1,
161
162 // under Windows, don't hide the child even if it's IO is redirected (this
163 // is done by default)
164 wxEXEC_NOHIDE = 2,
165
166 // under Unix, if the process is the group leader then killing -pid kills
167 // all children as well as pid
9c7e3e86
RD
168 wxEXEC_MAKE_GROUP_LEADER = 4,
169
170 // by default synchronous execution disables all program windows to avoid
171 // that the user interacts with the program while the child process is
172 // running, you can use this flag to prevent this from happening
173 wxEXEC_NODISABLE = 8
d14a1e28
RD
174};
175
176
ab1f7d2a
RD
177MustHaveApp(wxExecute);
178
d14a1e28
RD
179long wxExecute(const wxString& command,
180 int flags = wxEXEC_ASYNC,
181 wxPyProcess *process = NULL);
182
183
c1718b2c
RD
184
185%typemap(in,numinputs=0) wxKillError* rc ( wxKillError temp ) { $1 = &temp; }
186%typemap(argout) wxKillError* rc
187{
188 PyObject* o;
189 o = PyInt_FromLong((long) (*$1));
190 $result = t_output_helper($result, o);
191}
192
193int wxKill(long pid, wxSignal sig = wxSIGTERM, wxKillError* rc, int flags = wxKILL_NOCHILDREN);
194
195
d14a1e28
RD
196//---------------------------------------------------------------------------
197%init %{
198 wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
199%}
200//---------------------------------------------------------------------------