6 /// # valac --pkg gio-2.0 --pkg posix Spawn.vala -o /tmp/Spawn
9 ///using Gee; // for array list?
11 static int main (string[] args) {
12 // A reference to our file
14 var cfg = new SpawnConfig("", { "ls" } , { "" });
15 var spawn = new Spawn(cfg);
22 //var Gio = imports.gi.Gio;
23 //var GLib = imports.gi.GLib;
29 * Library to wrap GLib.spawn_async_with_pipes
34 *var output = new Spawn( SpawnConfig() {
35 cwd = "/home", // empty string to default to homedirectory.
38 ouput = (line) => { stdout.printf("%d\n", line); }
39 stderr = (line) => { stdout.printf("%d\n", line); }
40 input = () => { return "xxx"; }
45 public delegate void SpawnOutput(string line);
46 public delegate void SpawnErr(string line);
47 public delegate string SpawnInput();
51 public class SpawnConfig {
56 public bool exceptions; // fire exceptions.
57 public bool debug; // fire exceptions.
59 public SpawnOutput output;
60 public SpawnErr stderr;
61 public SpawnInput input;
63 public SpawnConfig(string cwd,
81 public void setOptions(
87 this.exceptions = exceptions;
90 public void setHandlers(
105 * @param cfg {SpawnConfig} settings - see properties.
107 * @arg cwd {String} working directory. (defaults to home directory)
108 * @arg args {Array} arguments eg. [ 'ls', '-l' ]
109 * @arg listeners {Object} (optional) handlers for output, stderr, input
110 * stderr/output both receive output line as argument
111 * input should return any standard input
112 * finish recieves result as argument.
113 * @arg env {Array} enviroment eg. [ 'GITDIR=/home/test' ]
114 * @arg async {Boolean} (optional)return instantly, or wait for exit. (default no)
115 * @arg exceptions {Boolean} throw exception on failure (default no)
116 * @arg debug {Boolean} print out what's going on.. (default no)
121 public class Spawn : Object
126 public Spawn(SpawnConfig cfg) throws Error
133 this.cfg.cwd = this.cfg.cwd.length || GLib.Enviroment.get_home_dir();
134 if (!this.cfg.args.length) {
135 throw new Error("No arguments");
142 bool ctx = false; // the mainloop ctx.
145 * @property output {String} resulting output
149 * @property stderr {String} resulting output from stderr
153 * @property result {Number} execution result.
157 * @property pid {Number} pid of child process (of false if it's not running)
161 * @property in_ch {GLib.IOChannel} input io channel
163 IOChannel in_ch = null;
165 * @property out_ch {GLib.IOChannel} output io channel
167 IOChannel out_ch = null;
169 * @property err_ch {GLib.IOChannel} stderr io channel
171 IOChannel err_ch = null;
173 * @property err_src {int} the watch for errors
178 * @property err_src {int} the watch for output
185 * Run the configured command.
186 * result is applied to object properties (eg. 'output' or 'stderr')
187 * @returns {Object} self.
202 if (this.cfg.debug) {
203 print("cd " + this.cfg.cwd +";" + string.joinv(" ", this.cfg.args));
206 Process.spawn_async_with_pipes (
210 SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
220 //print(JSON.stringify(gret));
222 if (this.cfg.debug) {
223 print("PID: " + this.pid);
226 ChildWatch.add (this.pid, (w_pid, result) => {
228 this.result = result;
230 print("child_watch_add : result: " + result);
233 this.read(this.out_ch);
234 this.read(this.err_ch);
237 Process.close_pid(this.pid);
243 //print("DONE TIDYUP");
244 if (this.cfg.finish) {
245 this.cfg.finish(this.result);
252 this.in_ch = new GLib.IOChannel.unix_new(ret.standard_input);
253 this.out_ch = new GLib.IOChannel.unix_new(ret.standard_output);
254 this.err_ch = new GLib.IOChannel.unix_new(ret.standard_error);
256 // make everything non-blocking!
260 // using NONBLOCKING only works if io_add_watch
261 //returns true/false in right conditions
262 this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
263 this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
264 this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
268 // add handlers for output and stderr.
270 this.out_src = this.out_ch.add_watch (
271 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
272 (channel, condition) => {
273 return this.read(_this.out_ch);
276 this.err_src = this.err_ch.add_watch (
277 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
278 (channel, condition) => {
279 return this.read(_this.err_ch);
286 // child can exit before 1we get this far..
287 if (this.cfg.input != null) {
288 if (this.cfg.debug) print("Trying to call listeners");
290 this.write(this.cfg.input());
291 // this probably needs to be a bit smarter...
292 //but... let's close input now..
305 // async - if running - return..
306 if (this.cfg.async && this.pid > -1) {
310 // start mainloop if not async..
313 if (this.cfg.debug) {
314 print("starting main loop");
316 this.ctx = new MainLoop ();
317 loop.run(); // wait fore exit?
319 //print("main_loop done!");
321 this.tidyup(); // tidyup get's called in main loop.
324 if (this.cfg.exceptions && this.result != 0) {
325 //this.toString = function() { return this.stderr; };
326 ///throw new Exception this; // we throw self...
329 // finally throw, or return self..
337 private void tidyup()
340 Process.close_pid(this.pid); // hopefully kills it..
343 if (this.in_ch) this.in_ch.close();
344 if (this.out_ch) this.out_ch.close();
345 if (this.err_ch) this.err_ch.close();
346 // blank out channels
350 // rmeove listeners !! important otherwise we kill the CPU
351 if (this.err_src > -1 ) GLib.source_remove(this.err_src);
352 if (this.out_src > -1 ) GLib.source_remove(this.out_src);
360 * write to stdin of process
361 * @arg str {String} string to write to stdin of process
362 * @returns GLib.IOStatus (0 == error, 1= NORMAL)
364 private int write(string str) // write a line to
366 if (this.in_ch == null) {
367 return 0; // input is closed
369 //print("write: " + str);
370 // NEEDS GIR FIX! for return value.. let's ignore for the time being..
372 //var res = this.in_ch.write_chars(str, str.length, ret);
373 var res = this.in_ch.write_chars(str, str.length);
375 //print("write_char retunred:" + JSON.stringify(res) + ' ' +JSON.stringify(ret) );
377 if (res != GLib.IOStatus.NORMAL) {
378 throw "Write failed";
386 * read from pipe and call appropriate listerner and add to output or stderr string.
387 * @arg giochannel to read from.
390 private bool read(IOChannel ch)
392 string prop = (ch == this.out_ch) ? "output" : "stderr";
393 // print("prop: " + prop);
397 //print(JSON.stringify(ch, null,4));
401 var status = ch.read_line( x);
402 // print('status: ' +JSON.stringify(status));
403 // print(JSON.stringify(x));
405 case GLib.IOStatus.NORMAL:
408 if (this.listeners[prop]) {
409 this.listeners[prop].call(this, x.str_return);
411 _this[prop] += x.str_return;
413 print(prop + ':' + x.str_return.replace(/\n/, ''));
417 if (imports.gi.Gtk.events_pending()) {
418 imports.gi.Gtk.main_iteration();
425 //this.ctx.iteration(true);
427 case GLib.IOStatus.AGAIN:
428 //print("Should be called again.. waiting for more data..");
431 case GLib.IOStatus.ERROR:
432 case GLib.IOStatus.EOF:
440 //print("RETURNING");
441 return false; // allow it to be called again..
449 args: ['ls', '/tmp'],
452 } catch (e) { print(JSON.stringify(e)); }
454 var secs = (new Date()).getSeconds()
458 args: ['/bin/touch', '/tmp/spawntest-' + secs ],
461 } catch (e) { print( 'Error: ' + JSON.stringify(e)); }