2 /// # valac --pkg gio-2.0 --pkg gtk+-3.0 --pkg posix Spawn.vala -o /tmp/Spawn
10 ///using Gee; // for array list?
12 static int main (string[] args) {
13 // A reference to our file
15 var cfg = new SpawnConfig("", { "ls" } , { "" });
18 stdout.printf("%s\n", line);
23 false, // exceptions?? needed??
30 stdout.printf("Error %s", e.message);
37 //var Gio = imports.gi.Gio;
38 //var GLib = imports.gi.GLib;
44 * Library to wrap GLib.spawn_async_with_pipes
49 *var output = new Spawn( SpawnConfig() {
50 cwd = "/home", // empty string to default to homedirectory.
53 ouput = (line) => { stdout.printf("%d\n", line); }
54 stderr = (line) => { stdout.printf("%d\n", line); }
55 input = () => { return "xxx"; }
60 public delegate void SpawnOutput(string line);
61 public delegate void SpawnErr(string line);
62 public delegate string SpawnInput();
63 public delegate void SpawnFinish(int result);
66 public class SpawnConfig {
71 public bool exceptions; // fire exceptions.
72 public bool debug; // fire exceptions.
74 public SpawnOutput output;
75 public SpawnErr stderr;
76 public SpawnInput input;
77 public SpawnFinish finish;
79 public SpawnConfig(string cwd,
97 public void setOptions(
103 this.exceptions = exceptions;
106 public void setHandlers(
112 this.output = output;
113 this.stderr = stderr;
115 this.finish = finish;
121 public errordomain SpawnError {
129 * @param cfg {SpawnConfig} settings - see properties.
131 * @arg cwd {String} working directory. (defaults to home directory)
132 * @arg args {Array} arguments eg. [ 'ls', '-l' ]
133 * @arg listeners {Object} (optional) handlers for output, stderr, input
134 * stderr/output both receive output line as argument
135 * input should return any standard input
136 * finish recieves result as argument.
137 * @arg env {Array} enviroment eg. [ 'GITDIR=/home/test' ]
138 * @arg async {Boolean} (optional)return instantly, or wait for exit. (default no)
139 * @arg exceptions {Boolean} throw exception on failure (default no)
140 * @arg debug {Boolean} print out what's going on.. (default no)
145 public class Spawn : Object
150 public Spawn(SpawnConfig cfg) throws Error
157 this.cfg.cwd = this.cfg.cwd.length < 1 ? GLib.Environment.get_home_dir() : this.cfg.cwd;
158 if (this.cfg.args.length < 0) {
159 throw new SpawnError.NO_ARGS("No arguments");
166 MainLoop ctx = null; // the mainloop ctx.
169 * @property output {String} resulting output
173 * @property stderr {String} resulting output from stderr
177 * @property result {Number} execution result.
181 * @property pid {Number} pid of child process (of false if it's not running)
185 * @property in_ch {GLib.IOChannel} input io channel
187 IOChannel in_ch = null;
189 * @property out_ch {GLib.IOChannel} output io channel
191 IOChannel out_ch = null;
193 * @property err_ch {GLib.IOChannel} stderr io channel
195 IOChannel err_ch = null;
197 * @property err_src {int} the watch for errors
202 * @property err_src {int} the watch for output
209 * Run the configured command.
210 * result is applied to object properties (eg. '?' or 'stderr')
211 * @returns {Object} self.
213 public void run() throws SpawnError, GLib.SpawnError, GLib.IOChannelError
225 if (this.cfg.debug) {
226 stdout.printf("cd %s; %s" , this.cfg.cwd , string.joinv(" ", this.cfg.args));
229 Process.spawn_async_with_pipes (
233 SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
243 //print(JSON.stringify(gret));
245 if (this.cfg.debug) {
247 stdout.printf("PID: %d" ,this.pid);
250 ChildWatch.add (this.pid, (w_pid, result) => {
252 this.result = result;
253 if (this.cfg.debug) {
254 stdout.printf("child_watch_add : result:%d ", result);
257 this.read(this.out_ch);
258 this.read(this.err_ch);
261 Process.close_pid(this.pid);
263 if (this.ctx != null) {
268 //print("DONE TIDYUP");
269 if (this.cfg.finish != null) {
270 this.cfg.finish(this.result);
277 this.in_ch = new GLib.IOChannel.unix_new(standard_input);
278 this.out_ch = new GLib.IOChannel.unix_new(standard_output);
279 this.err_ch = new GLib.IOChannel.unix_new(standard_error);
281 // make everything non-blocking!
285 // using NONBLOCKING only works if io_add_watch
286 //returns true/false in right conditions
287 this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
288 this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
289 this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
293 // add handlers for output and stderr.
295 this.out_src = (int) this.out_ch.add_watch (
296 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
297 (channel, condition) => {
298 return this.read(this.out_ch);
301 this.err_src = (int) this.err_ch.add_watch (
302 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
303 (channel, condition) => {
304 return this.read(this.err_ch);
311 // child can exit before we get this far..
312 if (this.cfg.input != null) {
313 if (this.cfg.debug) print("Trying to call listeners");
315 this.write(this.cfg.input());
316 // this probably needs to be a bit smarter...
317 //but... let's close input now..
318 this.in_ch.shutdown(true);
332 // async - if running - return..
333 if (this.cfg.async && this.pid > -1) {
337 // start mainloop if not async..
340 if (this.cfg.debug) {
341 print("starting main loop");
343 this.ctx = new MainLoop ();
344 this.ctx.run(); // wait fore exit?
346 //print("main_loop done!");
348 this.tidyup(); // tidyup get's called in main loop.
351 if (this.cfg.exceptions && this.result != 0) {
352 //this.toString = function() { return this.stderr; };
353 ///throw new Exception this; // we throw self...
356 // finally throw, or return self..
364 private void tidyup()
367 Process.close_pid(this.pid); // hopefully kills it..
371 if (this.in_ch != null) this.in_ch.shutdown(true);
372 if (this.out_ch != null) this.out_ch.shutdown(true);
373 if (this.err_ch != null) this.err_ch.shutdown(true);
375 // error shutting donw.
377 // blank out channels
381 // rmeove listeners !! important otherwise we kill the CPU
382 //if (this.err_src > -1 ) GLib.source_remove(this.err_src);
383 //if (this.out_src > -1 ) GLib.source_remove(this.out_src);
391 * write to stdin of process
392 * @arg str {String} string to write to stdin of process
393 * @returns GLib.IOStatus (0 == error, 1= NORMAL)
395 private int write(string str) throws Error // write a line to
397 if (this.in_ch == null) {
398 return 0; // input is closed
400 //print("write: " + str);
401 // NEEDS GIR FIX! for return value.. let's ignore for the time being..
404 var res = this.in_ch.write_chars(str.to_utf8(), out written);
406 //print("write_char retunred:" + JSON.stringify(res) + ' ' +JSON.stringify(ret) );
408 if (res != GLib.IOStatus.NORMAL) {
409 throw new SpawnError.WRITE_ERROR("Write failed");
417 * read from pipe and call appropriate listerner and add to output or stderr string.
418 * @arg giochannel to read from.
421 private bool read(IOChannel ch)
423 string prop = (ch == this.out_ch) ? "output" : "stderr";
424 // print("prop: " + prop);
427 //print(JSON.stringify(ch, null,4));
434 status = ch.read_line( out buffer, out len, out term_pos );
441 // print('status: ' +JSON.stringify(status));
442 // print(JSON.stringify(x));
444 case GLib.IOStatus.NORMAL:
448 //if (this.listeners[prop]) {
449 // this.listeners[prop].call(this, x.str_return);
451 if (ch == this.out_ch) {
452 this.output += buffer;
453 this.cfg.output( buffer);
455 this.stderr += buffer;
457 //_this[prop] += x.str_return;
458 if (this.cfg.debug) {
459 stdout.printf("%s : %s", prop , buffer);
461 if (this.cfg.async) {
463 if ( Gtk.events_pending()) {
464 Gtk.main_iteration();
469 //this.ctx.iteration(true);
471 case GLib.IOStatus.AGAIN:
472 //print("Should be called again.. waiting for more data..");
475 case GLib.IOStatus.ERROR:
476 case GLib.IOStatus.EOF:
484 //print("RETURNING");
485 return false; // allow it to be called again..
493 args: ['ls', '/tmp'],
496 } catch (e) { print(JSON.stringify(e)); }
498 var secs = (new Date()).getSeconds()
502 args: ['/bin/touch', '/tmp/spawntest-' + secs ],
505 } catch (e) { print( 'Error: ' + JSON.stringify(e)); }