1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gdk::Spawn Class Reference</h1>A C++ interface for the <a class="el" href="namespaceGFC_1_1Gdk.html">Gdk</a> spawn functions.
<a href="#_details">More...</a>
<p>
<code>#include <gfc/gdk/spawn.hh></code>
<p>
<p>Inheritance diagram for GFC::Gdk::Spawn:
<p><center><img src="classGFC_1_1Gdk_1_1Spawn.png" usemap="#GFC::Gdk::Spawn_map" border="0" alt=""></center>
<map name="GFC::Gdk::Spawn_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html" alt="GFC::G::Spawn" shape="rect" coords="0,56,112,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1StackObject.html" alt="GFC::StackObject" shape="rect" coords="0,0,112,24">
</map>
<a href="classGFC_1_1Gdk_1_1Spawn-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z203_0">Spawn</a> (const std::vector< std::string > &argv, <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a76">G::SpawnFlagsField</a> flags=0)
<dl class="el"><dd class="mdescRight">Constructs an asynchronous spawn object with the specified arguments <em>argv</em> and spawn <em>flags</em>. <a href="#z203_0"></a><br></dl><li><a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z203_1">Spawn</a> (const std::string &command_line, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error)
<dl class="el"><dd class="mdescRight">Constructs an asynchronous spawn object with the specified arguments in the <em>command_line</em> string. <a href="#z203_1"></a><br></dl><li><a class="anchor" name="z203_2" doxytag="GFC::Gdk::Spawn::~Spawn" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z203_2">~Spawn</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z204_0" doxytag="GFC::Gdk::Spawn::child_pid" ></a>
GPid <a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z204_0">child_pid</a> () const
<dl class="el"><dd class="mdescRight">Returns the child process ID or zero if an error occurs. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z205_0">execute</a> (const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> &screen, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Executes a child program asynchronously (that is, your program will not block waiting for the child to exit). <a href="#z205_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z205_1">execute</a> (const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> &screen, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html#w0">ChildSetupSlot</a> &slot, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Executes a child program asynchronously (that is, your program will not block waiting for the child to exit). <a href="#z205_1"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gdk_1_1Spawn.html#z205_2">execute</a> (const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> &screen, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html#w0">ChildSetupSlot</a> &slot, int *std_input, int *std_output, int *std_error, <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> *error=0)
<dl class="el"><dd class="mdescRight">Executes a child program asynchronously (that is, your program will not block waiting for the child to exit). <a href="#z205_2"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A C++ interface for the <a class="el" href="namespaceGFC_1_1Gdk.html">Gdk</a> spawn functions.
<p>
<a class="el" href="classGFC_1_1Gdk_1_1Spawn.html">Spawn</a> executes a child program asynchronously like <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SpawnAsync.html">G::SpawnAsync</a> except the child process is spawned in such an environment that on calling <a class="el" href="classGFC_1_1Gdk_1_1Display.html#e2">Gdk::Display::open()</a> it would be returned a <a class="el" href="classGFC_1_1Gdk_1_1Display.html">Gdk::Display</a> with screen as the default screen. For more details see the <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SpawnAsync.html">G::SpawnAsync</a> class documentation.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z203_0" doxytag="GFC::Gdk::Spawn::Spawn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gdk::Spawn::Spawn </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::vector< std::string > & </td>
<td class="mdname" nowrap> <em>argv</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a76">G::SpawnFlagsField</a> </td>
<td class="mdname" nowrap> <em>flags</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs an asynchronous spawn object with the specified arguments <em>argv</em> and spawn <em>flags</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>argv</em> </td><td>A reference to a vector of std::string that holds the child's argument strings. </td></tr>
<tr><td></td><td valign=top><em>flags</em> </td><td>One or more bitflags from the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121">G::SpawnFlags</a> enumeration.</td></tr>
</table>
</dl>
<br>
The first string in argv (argv[0]) is of course the name of the program to execute. By default, the name of the program must be a full path; the PATH shell variable will only be searched if you pass the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a79">G::SPAWN_SEARCH_PATH</a> flag. </td>
</tr>
</table>
<a class="anchor" name="z203_1" doxytag="GFC::Gdk::Spawn::Spawn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gdk::Spawn::Spawn </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname" nowrap> <em>command_line</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs an asynchronous spawn object with the specified arguments in the <em>command_line</em> string.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>command_line</em> </td><td>The command line string. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for a <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>.</td></tr>
</table>
</dl>
<br>
This constructor parses <em>command line</em> with g_shell_parse_argv() and passes it to GLib. If an error occurs it is set by the parsing function, and can be any of those from the G_SHELL_ERROR domain. Runs a <em>command_line</em> in the background. Unlike then other constructor, the <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a79">G::SPAWN_SEARCH_PATH</a> flag is enabled, other flags are not. Note that <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a79">G::SPAWN_SEARCH_PATH</a> can have security implications, so consider using the other constructor if appropriate.
<p>
Reimplemented from <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html#z91_1">GFC::G::Spawn</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z205_2" doxytag="GFC::Gdk::Spawn::execute" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Spawn::execute </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> & </td>
<td class="mdname" nowrap> <em>screen</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html#w0">ChildSetupSlot</a> & </td>
<td class="mdname" nowrap> <em>slot</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>std_input</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>std_output</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>std_error</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Executes a child program asynchronously (that is, your program will not block waiting for the child to exit).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>screen</em> </td><td>A <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Gdk::Screen</a>. </td></tr>
<tr><td></td><td valign=top><em>slot</em> </td><td>A sigc::slot to call in the child just before exec(). </td></tr>
<tr><td></td><td valign=top><em>std_input</em> </td><td>The return location for the file descriptor to write to child's stdin. </td></tr>
<tr><td></td><td valign=top><em>std_output</em> </td><td>The return location for the file descriptor to read child's stdout. </td></tr>
<tr><td></td><td valign=top><em>std_error</em> </td><td>The return location for the file descriptor to read child's stderr. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for a <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if successful, <em>false</em> if error is set.</dd></dl>
<br>
The file descriptors <em>std_input</em>, <em>std_output</em>, and <em>std_error</em> are used for writing to the child's standard input or reading from its standard output or standard error, and must be closed by calling close() when no longer required.<p>
If <em>std_input</em> is null the child's standard input is attached to /dev/null unless <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a82">G::SPAWN_CHILD_INHERITS_STDIN</a> is set. If <em>std_error</em> is null the child's standard error goes to the same location as the parent's standard error unless <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a81">G::SPAWN_STDERR_TO_DEV_NULL</a> is set. If <em>std_output</em> is not called the child's standard output goes to the same location as the parent's standard output unless <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC::G.html#a121a80">G::SPAWN_STDOUT_TO_DEV_NULL</a> is set. </td>
</tr>
</table>
<a class="anchor" name="z205_1" doxytag="GFC::Gdk::Spawn::execute" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Spawn::execute </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> & </td>
<td class="mdname" nowrap> <em>screen</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Spawn.html#w0">ChildSetupSlot</a> & </td>
<td class="mdname" nowrap> <em>slot</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Executes a child program asynchronously (that is, your program will not block waiting for the child to exit).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>screen</em> </td><td>A <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Gdk::Screen</a>. </td></tr>
<tr><td></td><td valign=top><em>slot</em> </td><td>A sigc::slot to call in the child just before exec(). </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for a <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if successful, <em>false</em> if error is set. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z205_0" doxytag="GFC::Gdk::Spawn::execute" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gdk::Spawn::execute </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Screen</a> & </td>
<td class="mdname" nowrap> <em>screen</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a> * </td>
<td class="mdname" nowrap> <em>error</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Executes a child program asynchronously (that is, your program will not block waiting for the child to exit).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>screen</em> </td><td>A <a class="el" href="classGFC_1_1Gdk_1_1Screen.html">Gdk::Screen</a>. </td></tr>
<tr><td></td><td valign=top><em>error</em> </td><td>The return location for a <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Error.html">G::Error</a>, or null to ignore errors. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if successful, <em>false</em> if error is set. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="spawn_8hh-source.html">spawn.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:36 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
