2 /// # valac --pkg gio-2.0 --pkg posix Spawn.vala -o /tmp/Spawn
10 * x = new Spawn( "/tmp", {"ls", "-l" })
12 * // these are optionall..
13 * x.env = ..... (if you need to set one...
14 * x.output_line.connect((string str) => {
15 * if ( Gtk.events_pending()) { Gtk.main_iteration(); }
17 * x.input_line.connect(() => { return string });
19 * x.run((int res, string output, string stderr) => { ... });
27 public errordomain SpawnError {
36 * @param cwd {String} working directory. (defaults to home directory)
37 * @param args {Array} arguments eg. [ 'ls', '-l' ]
40 * @arg env {Array} enviroment eg. [ 'GITDIR=/home/test' ]
41 * @arg is_async {Boolean} (optional)return instantly, or wait for exit. (default no)
42 * @arg trhow_exceptions {Boolean} throw exception on failure (default no)
47 public class Spawn : Object
50 * @signal input called at start to send input when process starts?
51 * @return the string or null
53 public signal string? input();
55 * @signal complete called at when the command has completed.
58 public signal void complete(int res, string str, string stderr);
60 * @signal output_line called when a line is recieved from the process.
61 * Note you may want to connect this and run
62 * if ( Gtk.events_pending()) { Gtk.main_iteration(); }
66 public signal void output_line(string str);
72 public bool is_async = true;
73 public bool throw_exceptions = false;
74 public bool detach = false;
76 public Spawn(string cwd, string[] args) throws Error
87 this.cwd = this.cwd.length < 1 ? GLib.Environment.get_home_dir() : this.cwd;
88 if (this.args.length < 0) {
89 throw new SpawnError.NO_ARGS("No arguments");
96 MainLoop ctx = null; // the mainloop ctx.
99 * @property output {String} resulting output
101 public string output;
103 * @property stderr {String} resulting output from stderr
105 public string stderr;
107 * @property result {Number} execution result.
109 public int result= 0;
111 * @property pid {Number} pid of child process (of false if it's not running)
115 * @property in_ch {GLib.IOChannel} input io channel
117 IOChannel in_ch = null;
119 * @property out_ch {GLib.IOChannel} output io channel
121 IOChannel out_ch = null;
123 * @property err_ch {GLib.IOChannel} stderr io channel
125 IOChannel err_ch = null;
127 * @property err_src {int} the watch for errors
132 * @property err_src {int} the watch for output
139 * Run the configured command.
140 * result is applied to object properties (eg. '?' or 'stderr')
141 * @returns {Object} self.
143 public void run( ) throws SpawnError, GLib.SpawnError, GLib.IOChannelError
155 GLib.debug("cd %s; %s" , this.cwd , string.joinv(" ", this.args));
158 Process.spawn_async_with_pipes (
161 this.env.length > 0 ? this.env : null,
162 SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
165 ChildWatch.add (this.pid, (pid, status) => {
166 // Triggered when the child indicated by child_pid exits
167 Process.close_pid (pid);
174 Process.spawn_async_with_pipes (
177 this.env.length > 0 ? this.env : null,
178 SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
188 //print(JSON.stringify(gret));
190 GLib.debug("PID: %d" ,this.pid);
193 this.in_ch = new GLib.IOChannel.unix_new(standard_input);
194 this.out_ch = new GLib.IOChannel.unix_new(standard_output);
195 this.err_ch = new GLib.IOChannel.unix_new(standard_error);
197 // make everything non-blocking!
201 // using NONBLOCKING only works if io_add_watch
202 //returns true/false in right conditions
203 this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
204 this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
205 this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
210 ChildWatch.add (this.pid, (w_pid, result) => {
212 this.result = result;
213 GLib.debug("child_watch_add : result:%d ", result);
216 this.read(this.out_ch);
217 this.read(this.err_ch);
220 Process.close_pid(this.pid);
222 if (this.ctx != null) {
227 //print("DONE TIDYUP");
229 this.complete(this.result, this.output, this.stderr);
238 // add handlers for output and stderr.
240 this.out_src = (int) this.out_ch.add_watch (
241 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
242 (channel, condition) => {
243 return this.read(this.out_ch);
246 this.err_src = (int) this.err_ch.add_watch (
247 IOCondition.OUT | IOCondition.IN | IOCondition.PRI | IOCondition.HUP | IOCondition.ERR ,
248 (channel, condition) => {
249 return this.read(this.err_ch);
256 // child can exit before we get this far..
257 var input = this.input();
262 // this probably needs to be a bit smarter...
263 //but... let's close input now..
264 this.in_ch.shutdown(true);
278 // async - if running - return..
279 if (this.is_async && this.pid > -1) {
283 // start mainloop if not async..
286 GLib.debug("starting main loop");
287 //if (this.cfg.debug) {
290 this.ctx = new MainLoop ();
291 this.ctx.run(); // wait fore exit?
293 GLib.debug("main_loop done!");
295 this.tidyup(); // tidyup get's called in main loop.
298 if (this.throw_exceptions && this.result != 0) {
300 throw new SpawnError.EXECUTE_ERROR(this.stderr);
301 //this.toString = function() { return this.stderr; };
302 ///throw new Exception this; // we throw self...
305 // finally throw, or return self..
313 private void tidyup()
316 Process.close_pid(this.pid); // hopefully kills it..
320 if (this.in_ch != null) this.in_ch.shutdown(true);
321 if (this.out_ch != null) this.out_ch.shutdown(true);
322 if (this.err_ch != null) this.err_ch.shutdown(true);
324 // error shutting donw.
326 // blank out channels
330 // rmeove listeners !! important otherwise we kill the CPU
331 //if (this.err_src > -1 ) GLib.source_remove(this.err_src);
332 //if (this.out_src > -1 ) GLib.source_remove(this.out_src);
340 * write to stdin of process
341 * @arg str {String} string to write to stdin of process
342 * @returns GLib.IOStatus (0 == error, 1= NORMAL)
344 private int write(string str) throws Error // write a line to
346 if (this.in_ch == null) {
347 return 0; // input is closed
349 //print("write: " + str);
350 // NEEDS GIR FIX! for return value.. let's ignore for the time being..
353 var res = this.in_ch.write_chars(str.to_utf8(), out written);
355 //print("write_char retunred:" + JSON.stringify(res) + ' ' +JSON.stringify(ret) );
357 if (res != GLib.IOStatus.NORMAL) {
358 throw new SpawnError.WRITE_ERROR("Write failed");
368 * read from pipe and call appropriate listerner and add to output or stderr string.
369 * @arg giochannel to read from.
372 private bool read(IOChannel ch)
374 // string prop = (ch == this.out_ch) ? "output" : "stderr";
375 // print("prop: " + prop);
378 //print(JSON.stringify(ch, null,4));
385 status = ch.read_line( out buffer, out len, out term_pos );
392 // print('status: ' +JSON.stringify(status));
393 // print(JSON.stringify(x));
395 case GLib.IOStatus.NORMAL:
399 //if (this.listeners[prop]) {
400 // this.listeners[prop].call(this, x.str_return);
402 if (ch == this.out_ch) {
403 this.output += buffer;
404 this.output_line( buffer);
407 this.stderr += buffer;
408 this.output_line( buffer);
410 //_this[prop] += x.str_return;
411 //if (this.cfg.debug) {
412 //GLib.debug("%s : %s", prop , buffer);
416 //if ( Gtk.events_pending()) {
417 // Gtk.main_iteration();
422 //this.ctx.iteration(true);
424 case GLib.IOStatus.AGAIN:
425 //print("Should be called again.. waiting for more data..");
428 case GLib.IOStatus.ERROR:
429 case GLib.IOStatus.EOF:
437 //print("RETURNING");
438 return false; // allow it to be called again..
444 int main (string[] args) {
445 GLib.Log.set_handler(null,
446 GLib.LogLevelFlags.LEVEL_DEBUG | GLib.LogLevelFlags.LEVEL_WARNING,
448 print("%s: %s\n", dom, msg);
451 var ctx = new GLib.MainLoop ();
452 var a = new Spawn("", { "ls" , "-l"});
453 a.run((res, str, stderr) => {
459 ctx.run(); // wait for exit?