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