X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2FSystemcall.cpp;h=741feb233843834c95a596e06e2f361edfea39f7;hb=c48091f33a773732fa6c789927e5833e44108d9d;hp=22b042448f7b1cf3dc9f68522f0348327cf727f2;hpb=dc267d6dd9ed2bb5d6a405a64e74d71277bbd54c;p=lyx.git

diff --git a/src/support/Systemcall.cpp b/src/support/Systemcall.cpp
index 22b042448f..741feb2338 100644
--- a/src/support/Systemcall.cpp
+++ b/src/support/Systemcall.cpp
@@ -4,9 +4,9 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Asger Alstrup
- *
- * Interface cleaned up by
  * \author Angus Leeming
+ * \author Enrico Forestieri
+ * \author Peter Kuemmel
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -14,23 +14,111 @@
 #include <config.h>
 
 #include "support/debug.h"
+#include "support/environment.h"
+#include "support/filetools.h"
+#include "support/lstrings.h"
 #include "support/qstring_helpers.h"
 #include "support/Systemcall.h"
+#include "support/SystemcallPrivate.h"
 #include "support/os.h"
+#include "support/ProgressInterface.h"
+
+#include "LyXRC.h"
 
 #include <cstdlib>
+#include <iostream>
 
 #include <QProcess>
+#include <QTime>
+#include <QThread>
+#include <QCoreApplication>
+#include <QDebug>
+
+#define USE_QPROCESS
+
+
+struct Sleep : QThread
+{
+	static void millisec(unsigned long ms) 
+	{
+		QThread::usleep(ms * 1000);
+	}
+};
+
+
+
 
 using namespace std;
 
 namespace lyx {
 namespace support {
 
+
+class ProgressDummy : public ProgressInterface 
+{
+public:
+	ProgressDummy() {}
+
+	void processStarted(QString const &) {}
+	void processFinished(QString const &) {}
+	void appendMessage(QString const &) {}
+	void appendError(QString const &) {}
+	void clearMessages() {}
+	void lyxerrFlush() {}
+
+	void lyxerrConnect() {}
+	void lyxerrDisconnect() {}
+
+	void warning(QString const &, QString const &) {}
+	void toggleWarning(QString const &, QString const &, QString const &) {}
+	void error(QString const &, QString const &) {}
+	void information(QString const &, QString const &) {}
+};
+
+
+static ProgressInterface* progress_instance = 0;
+
+void ProgressInterface::setInstance(ProgressInterface* p)
+{
+	progress_instance = p;
+}
+
+
+ProgressInterface* ProgressInterface::instance()
+{
+	if (!progress_instance) {
+		static ProgressDummy dummy;
+		return &dummy;
+	}
+	return progress_instance;
+}
+
+
+
+
 // Reuse of instance
-int Systemcall::startscript(Starttype how, string const & what)
+#ifndef USE_QPROCESS
+int Systemcall::startscript(Starttype how, string const & what,
+			    std::string const & path, bool /*process_events*/)
 {
-	string command = what;
+	string command;
+	string const texinputs = os::latex_path_list(
+			replaceCurdirPath(path, lyxrc.texinputs_prefix));
+	string const sep = string(1, os::path_separator(os::TEXENGINE));
+	string const env = getEnv("TEXINPUTS");
+
+	switch (os::shell()) {
+	case os::UNIX:
+		command = path.empty() || lyxrc.texinputs_prefix.empty() ? what
+			: "env TEXINPUTS='." + sep + texinputs
+					     + sep + env + "' " + what;
+		break;
+	case os::CMD_EXE:
+		command = path.empty() || lyxrc.texinputs_prefix.empty() ? what
+			: "set TEXINPUTS=." + sep + texinputs
+					    + sep + env + " & " + what;
+		break;
+	}
 
 	if (how == DontWait) {
 		switch (os::shell()) {
@@ -43,37 +131,411 @@ int Systemcall::startscript(Starttype how, string const & what)
 		}
 	}
 
-//#define DISABLE_EVALUATE_QPROCESS
-#ifndef DISABLE_EVALUATE_QPROCESS
-	QString cmd = QString::fromLocal8Bit(command.c_str());
-	QProcess process;
-	process.start(cmd);
-	if (!process.waitForStarted(1000)) {
-		LYXERR0("Qprocess " << cmd << " did not start!");
-		LYXERR0("error " << process.error());
-		LYXERR0("state " << process.state());
-		LYXERR0("status " << process.exitStatus());
+	return ::system(command.c_str());
+}
+
+#else
+
+namespace {
+
+/*
+ * This is a parser that (mostly) mimics the behavior of a posix shell but
+ * its output is tailored for being processed by QProcess.
+ *
+ * The escape character is the backslash.
+ * A backslash that is not quoted preserves the literal value of the following
+ * character, with the exception of a double-quote '"'. If a double-quote
+ * follows a backslash, it will be replaced by three consecutive double-quotes
+ * (this is how the QProcess parser recognizes a '"' as a simple character
+ * instead of a quoting character). Thus, for example:
+ *     \\  ->  \
+ *     \a  ->  a
+ *     \"  ->  """
+ *
+ * Single-quotes.
+ * Characters enclosed in single-quotes ('') have their literal value preserved.
+ * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
+ * be used to escape a single-quote in a single-quoted string. In other words,
+ * anything enclosed in single-quotes is passed as is, but the single-quotes
+ * themselves are eliminated. Thus, for example:
+ *    '\'    ->  \
+ *    '\\'   ->  \\
+ *    '\a'   ->  \a
+ *    'a\"b' ->  a\"b
+ *
+ * Double-quotes.
+ * Characters enclosed in double-quotes ("") have their literal value preserved,
+ * with the exception of the backslash. The backslash retains its special
+ * meaning as an escape character only when followed by a double-quote.
+ * Contrarily to the behavior of a posix shell, the double-quotes themselves
+ * are *not* eliminated. Thus, for example:
+ *    "\\"   ->  "\\"
+ *    "\a"   ->  "\a"
+ *    "a\"b" ->  "a"""b"
+ */
+string const parsecmd(string const & inputcmd, string & outfile)
+{
+	bool in_single_quote = false;
+	bool in_double_quote = false;
+	bool escaped = false;
+	string cmd;
+
+	for (size_t i = 0; i < inputcmd.length(); ++i) {
+		char c = inputcmd[i];
+		if (c == '\'') {
+			if (in_double_quote || escaped) {
+				if (in_double_quote && escaped)
+					cmd += '\\';
+				cmd += c;
+			} else
+				in_single_quote = !in_single_quote;
+			escaped = false;
+			continue;
+		}
+		if (in_single_quote) {
+			cmd += c;
+			continue;
+		}
+		if (c == '"') {
+			if (escaped) {
+				cmd += "\"\"\"";
+				escaped = false;
+			} else {
+				cmd += c;
+				in_double_quote = !in_double_quote;
+			}
+		} else if (c == '\\' && !escaped) {
+			escaped = !escaped;
+		} else if (c == '>' && !(in_double_quote || escaped)) {
+			outfile = trim(inputcmd.substr(i + 1), " \"");
+			return trim(cmd);
+		} else {
+			if (escaped && in_double_quote)
+				cmd += '\\';
+			cmd += c;
+			escaped = false;
+		}
+	}
+	outfile.erase();
+	return cmd;
+}
+
+} // namespace anon
+
+
+
+int Systemcall::startscript(Starttype how, string const & what,
+			    string const & path, bool process_events)
+{
+	string outfile;
+	QString cmd = toqstr(parsecmd(what, outfile));
+
+	SystemcallPrivate d(outfile);
+
+
+	d.startProcess(cmd, path);
+	if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
+		LYXERR0("Systemcall: '" << cmd << "' did not start!");
+		LYXERR0("error " << d.errorMessage());
 		return 10;
 	}
-	if (!process.waitForFinished(30000)) {
-		LYXERR0("Qprocess " << cmd << " did not finished!");
-		LYXERR0("error " << process.error());
-		LYXERR0("state " << process.state());
-		LYXERR0("status " << process.exitStatus());
+
+	if (how == DontWait) {
+		QProcess* released = d.releaseProcess();
+		(void) released; // TODO who deletes it?
+		return 0;
+	}
+
+	if (!d.waitWhile(SystemcallPrivate::Running, process_events,
+			 os::timeout_min() * 60 * 1000)) {
+		LYXERR0("Systemcall: '" << cmd << "' did not finish!");
+		LYXERR0("error " << d.errorMessage());
+		LYXERR0("status " << d.exitStatusMessage());
 		return 20;
 	}
-	if (process.exitCode()) {
-		LYXERR0("Qprocess " << cmd << " finished!");
-		LYXERR0("exitCode " << process.exitCode());
-		LYXERR0("error " << process.error());
-		LYXERR0("state " << process.state());
-		LYXERR0("status " << process.exitStatus());
+
+	int const exit_code = d.exitCode();
+	if (exit_code) {
+		LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
 	}
-	return process.exitCode();
-#endif
 
-	return ::system(command.c_str());
+	return exit_code;
+}
+
+
+SystemcallPrivate::SystemcallPrivate(const std::string& of) :
+                                process_(new QProcess), 
+                                out_index_(0),
+                                err_index_(0),
+                                out_file_(of), 
+                                texinputs_(getEnv("TEXINPUTS")),
+                                process_events_(false)
+{
+	if (!out_file_.empty()) {
+		// Check whether we have to simply throw away the output.
+		if (out_file_ != os::nulldev())
+			process_->setStandardOutputFile(toqstr(out_file_));
+	}
+
+	connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
+	connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
+	connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
+	connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
+	connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
+}
+
+
+
+void SystemcallPrivate::startProcess(QString const & cmd, string const & path)
+{
+	cmd_ = cmd;
+	if (process_) {
+		if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
+			string const texinputs = os::latex_path_list(
+				replaceCurdirPath(path, lyxrc.texinputs_prefix));
+			string const sep = string(1,
+					os::path_separator(os::TEXENGINE));
+			string const prefix = "." + sep + texinputs + sep;
+			if (prefixIs(texinputs_, prefix))
+				texinputs_.clear();
+			else
+				setEnv("TEXINPUTS", prefix + texinputs_);
+		}
+		state = SystemcallPrivate::Starting;
+		if (os::shell() == os::CMD_EXE)
+			process_->start(QLatin1String("cmd /d /c ") + cmd_);
+		else
+			process_->start(cmd_);
+	}
+}
+
+
+void SystemcallPrivate::processEvents()
+{
+	if(process_events_) {
+		QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
+	}
+}
+
+
+void SystemcallPrivate::waitAndProcessEvents()
+{
+	Sleep::millisec(100);
+	processEvents();
+}
+
+
+bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
+{
+	if (!process_)
+		return false;
+
+	process_events_ = process_events;
+
+	// Block GUI while waiting,
+	// relay on QProcess' wait functions
+	if (!process_events_) {
+		if (waitwhile == Starting)
+			return process_->waitForStarted(timeout);
+		if (waitwhile == Running)
+			return process_->waitForFinished(timeout);
+		return false;
+	}
+
+	// process events while waiting, no timeout
+	if (timeout == -1) {
+		while (state == waitwhile && state != Error) {
+			waitAndProcessEvents();
+		}
+		return state != Error;
+	} 
+
+	// process events while waiting whith timeout
+	QTime timer;
+	timer.start();
+	while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
+		waitAndProcessEvents();
+	}
+	return (state != Error) && (timer.elapsed() < timeout);
+}
+
+
+SystemcallPrivate::~SystemcallPrivate()
+{
+	if (!texinputs_.empty())
+		setEnv("TEXINPUTS", texinputs_);
+
+	if (out_index_) {
+		out_data_[out_index_] = '\0';
+		out_index_ = 0;
+		cout << out_data_;
+	}
+	cout.flush();
+	if (err_index_) {
+		err_data_[err_index_] = '\0';
+		err_index_ = 0;
+		cerr << err_data_;
+	}
+	cerr.flush();
+
+	killProcess();
+}
+
+
+void SystemcallPrivate::stdOut()
+{
+	if (process_) {
+		char c;
+		process_->setReadChannel(QProcess::StandardOutput);
+		while (process_->getChar(&c)) {
+			out_data_[out_index_++] = c;
+			if (c == '\n' || out_index_ + 1 == buffer_size_) {
+				out_data_[out_index_] = '\0';
+				out_index_ = 0;
+				ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
+				cout << out_data_;
+			}
+		}
+	}
+}
+
+
+void SystemcallPrivate::stdErr()
+{
+	if (process_) {
+		char c;
+		process_->setReadChannel(QProcess::StandardError);
+		while (process_->getChar(&c)) {
+			err_data_[err_index_++] = c;
+			if (c == '\n' || err_index_ + 1 == buffer_size_) {
+				err_data_[err_index_] = '\0';
+				err_index_ = 0;
+				ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
+				cerr << err_data_;
+			}
+		}
+	}
+}
+
+
+void SystemcallPrivate::processStarted()
+{
+	if (state != Running) {
+		state = Running;
+		ProgressInterface::instance()->processStarted(cmd_);
+	}
+}
+
+
+void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
+{
+	if (state != Finished) {
+		state = Finished;
+		ProgressInterface::instance()->processFinished(cmd_);
+	}
+}
+
+
+void SystemcallPrivate::processError(QProcess::ProcessError)
+{
+	state = Error;
+	ProgressInterface::instance()->appendError(errorMessage());
 }
 
+
+QString SystemcallPrivate::errorMessage() const 
+{
+	if (!process_)
+		return "No QProcess available";
+
+	QString message;
+	switch (process_->error()) {
+		case QProcess::FailedToStart:
+			message = "The process failed to start. Either the invoked program is missing, "
+				      "or you may have insufficient permissions to invoke the program.";
+			break;
+		case QProcess::Crashed:
+			message = "The process crashed some time after starting successfully.";
+			break;
+		case QProcess::Timedout:
+			message = "The process timed out. It might be restarted automatically.";
+			break;
+		case QProcess::WriteError:
+			message = "An error occurred when attempting to write to the process-> For example, "
+				      "the process may not be running, or it may have closed its input channel.";
+			break;
+		case QProcess::ReadError:
+			message = "An error occurred when attempting to read from the process-> For example, "
+				      "the process may not be running.";
+			break;
+		case QProcess::UnknownError:
+		default:
+			message = "An unknown error occured.";
+			break;
+	}
+	return message;
+}
+
+
+QString SystemcallPrivate::exitStatusMessage() const
+{
+	if (!process_)
+		return "No QProcess available";
+
+	QString message;
+	switch (process_->exitStatus()) {
+		case QProcess::NormalExit:
+			message = "The process exited normally.";
+			break;
+		case QProcess::CrashExit:
+			message = "The process crashed.";
+			break;
+		default:
+			message = "Unknown exit state.";
+			break;
+	}
+	return message;
+}
+
+
+int SystemcallPrivate::exitCode()
+{
+	if (!process_)
+		return -1;
+
+	return process_->exitCode();
+}
+
+
+QProcess* SystemcallPrivate::releaseProcess()
+{
+	QProcess* released = process_;
+	process_ = 0;
+	return released;
+}
+
+
+void SystemcallPrivate::killProcess()
+{
+	killProcess(process_);
+}
+
+
+void SystemcallPrivate::killProcess(QProcess * p)
+{
+	if (p) {
+		p->disconnect();
+		p->closeReadChannel(QProcess::StandardOutput);
+		p->closeReadChannel(QProcess::StandardError);
+		p->close();
+		delete p;
+	}
+}
+
+
+
+#include "moc_SystemcallPrivate.cpp"
+#endif
+
 } // namespace support
 } // namespace lyx