X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fexternaltask.h;h=cb8464beab873ef24146b49a5ab02bd6a9aaa21c;hb=a957405689fafa1afc233182a3756e36ea34281c;hp=1b330ff745afd235d31638c87e63ff23adf0bae3;hpb=b3851916ce08424fb5a28a57d70945e805d8d931;p=builder.git

diff --git a/source/externaltask.h b/source/externaltask.h
index 1b330ff..cb8464b 100644
--- a/source/externaltask.h
+++ b/source/externaltask.h
@@ -7,14 +7,19 @@
 #include <msp/io/pipe.h>
 #include "task.h"
 
+/**
+Runs an external command.  A zero exit status is translated to a SUCCESS status
+for the task, and anything else is treated as an error.  Output can optionally
+be captured.
+*/
 class ExternalTask: public Task
 {
 public:
 	enum Destination
 	{
-		PASSTHROUGH,
-		CAPTURE,
-		IGNORE
+		PASSTHROUGH,  //< Do not touch the stream
+		CAPTURE,      //< Capture the stream
+		IGNORE        //< Redirect the stream to oblivion
 	};
 
 	typedef std::vector<std::string> Arguments;
@@ -30,16 +35,34 @@ private:
 	std::string output;
 
 public:
+	/** Creates an ExternalTask with an argument array and an optional working
+	directory.  The first element of the argument array should be the command
+	name.  If the working directory is not specified, no chdir is done. */
 	ExternalTask(const Arguments &, const Msp::FS::Path & = Msp::FS::Path());
+
 	virtual ~ExternalTask();
 
 	virtual std::string get_command() const;
 	virtual void start();
 	virtual Status check();
+	virtual Status wait();
+private:
+	Status do_wait(bool);
 
+public:
+	/// Sets destination for stdout.  Has no effect after the task is started.
 	void set_stdout(Destination);
+
+	/// Sets destination for stderr.  Has no effect after the task is started.
 	void set_stderr(Destination);
+
+	/** Returns captured output, if any.  This may be called while the task is
+	still running, but it will always return all output. */
 	const std::string &get_output() const { return output; }
+
+	/** Executes a command and captures its output.  Stderr is ignored, but if
+	the command exits with a nonzero status, an exception is thrown. */
+	static std::string run_and_capture_output(const Arguments &, const Msp::FS::Path & = Msp::FS::Path());
 };
 
 #endif