#include "support/Systemcall.h"
#include "support/SystemcallPrivate.h"
#include "support/os.h"
+#include "support/ProgressInterface.h"
#include <cstdlib>
+
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
#ifndef USE_QPROCESS
namespace {
-string const parsecmd(string const & cmd, string & outfile)
+/*
+ * 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 inquote = false;
+ bool in_single_quote = false;
+ bool in_double_quote = false;
bool escaped = false;
-
- for (size_t i = 0; i < cmd.length(); ++i) {
- char c = cmd[i];
- if ((c == '"' || c == '\'') && !escaped)
- inquote = !inquote;
- else if (c == '\\' && !escaped)
+ 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 == '>' && !(inquote || escaped)) {
- outfile = trim(cmd.substr(i + 1), " \"");
- return trim(cmd.substr(0, i));
- } else
+ } 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;
int Systemcall::startscript(Starttype how, string const & what, bool process_events)
{
string outfile;
- QString cmd = toqstr(parsecmd(what, outfile));
- if (cmd.contains("'")) {
- LYXERR0("Systemcall: '" << cmd << "' contains single quotes ', please check configuration, ' will be replaced by \"");
- cmd = cmd.replace("'","\"");
- }
+ QString cmd = toqstr(parsecmd(what, outfile));
SystemcallPrivate d(outfile);
}
-SystemcallPrivate::SystemcallPrivate(const std::string& of) :
- proc_(new QProcess), outindex_(0), errindex_(0),
- outfile(of), showout_(false), showerr_(false), process_events(false)
+SystemcallPrivate::SystemcallPrivate(const std::string& of) :
+ process_(new QProcess),
+ out_index_(0),
+ err_index_(0),
+ out_file_(of),
+ process_events_(false)
{
- if (!outfile.empty()) {
+ if (!out_file_.empty()) {
// Check whether we have to simply throw away the output.
- if (outfile != os::nulldev())
- proc_->setStandardOutputFile(toqstr(outfile));
- } else if (os::is_terminal(os::STDOUT))
- showout();
- if (os::is_terminal(os::STDERR))
- showerr();
-
- connect(proc_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
- connect(proc_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
- connect(proc_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
- connect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
- connect(proc_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
+ 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(const QString& cmd)
{
- if (proc_) {
+ cmd_ = cmd;
+ if (process_) {
state = SystemcallPrivate::Starting;
- proc_->start(cmd);
+ process_->start(cmd_);
}
}
void SystemcallPrivate::processEvents()
{
- if(process_events) {
- //static int count = 0; qDebug() << count++ << ": waitAndProcessEvents";
- QCoreApplication::processEvents(QEventLoop::AllEvents);
+ if(process_events_) {
+ QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
}
}
}
-bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout)
+bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
{
- if (!proc_)
+ if (!process_)
return false;
- process_events = proc_events;
+ process_events_ = process_events;
// Block GUI while waiting,
// relay on QProcess' wait functions
- if (!process_events) {
+ if (!process_events_) {
if (waitwhile == Starting)
- return proc_->waitForStarted(timeout);
+ return process_->waitForStarted(timeout);
if (waitwhile == Running)
- return proc_->waitForFinished(timeout);
+ return process_->waitForFinished(timeout);
return false;
}
SystemcallPrivate::~SystemcallPrivate()
{
- flush();
-
- if (outindex_) {
- outdata_[outindex_] = '\0';
- outindex_ = 0;
- cout << outdata_;
+ if (out_index_) {
+ out_data_[out_index_] = '\0';
+ out_index_ = 0;
+ cout << out_data_;
}
cout.flush();
- if (errindex_) {
- errdata_[errindex_] = '\0';
- errindex_ = 0;
- cerr << errdata_;
+ if (err_index_) {
+ err_data_[err_index_] = '\0';
+ err_index_ = 0;
+ cerr << err_data_;
}
cerr.flush();
}
-void SystemcallPrivate::flush()
-{
- if (proc_) {
- // If the output has been redirected, we write it all at once.
- // Even if we are not running in a terminal, the output could go
- // to some log file, for example ~/.xsession-errors on *nix.
- if (!os::is_terminal(os::STDOUT) && outfile.empty())
- cout << fromqstr(QString::fromLocal8Bit(
- proc_->readAllStandardOutput().data()));
- if (!os::is_terminal(os::STDERR))
- cerr << fromqstr(QString::fromLocal8Bit(
- proc_->readAllStandardError().data()));
- }
-}
-
-
void SystemcallPrivate::stdOut()
{
- if (proc_ && showout_) {
+ if (process_) {
char c;
- proc_->setReadChannel(QProcess::StandardOutput);
- while (proc_->getChar(&c)) {
- outdata_[outindex_++] = c;
- if (c == '\n' || outindex_ + 1 == bufsize_) {
- outdata_[outindex_] = '\0';
- outindex_ = 0;
- cout << outdata_;
+ 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_;
}
}
}
- processEvents();
}
void SystemcallPrivate::stdErr()
{
- if (proc_ && showerr_) {
+ if (process_) {
char c;
- proc_->setReadChannel(QProcess::StandardError);
- while (proc_->getChar(&c)) {
- errdata_[errindex_++] = c;
- if (c == '\n' || errindex_ + 1 == bufsize_) {
- errdata_[errindex_] = '\0';
- errindex_ = 0;
- cerr << errdata_;
+ 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_;
}
}
}
- processEvents();
}
void SystemcallPrivate::processStarted()
{
- state = Running;
- // why do we get two started signals?
- //disconnect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
+ if (state != Running) {
+ state = Running;
+ ProgressInterface::instance()->processStarted(cmd_);
+ }
}
void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
{
- state = Finished;
+ 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 (!proc_)
+ if (!process_)
return "No QProcess available";
QString message;
- switch (proc_->error()) {
+ 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.";
QString SystemcallPrivate::exitStatusMessage() const
{
- if (!proc_)
+ if (!process_)
return "No QProcess available";
QString message;
- switch (proc_->exitStatus()) {
+ switch (process_->exitStatus()) {
case QProcess::NormalExit:
message = "The process exited normally.";
break;
int SystemcallPrivate::exitCode()
{
- if (!proc_)
+ if (!process_)
return -1;
- return proc_->exitCode();
+ return process_->exitCode();
}
QProcess* SystemcallPrivate::releaseProcess()
{
- QProcess* released = proc_;
- proc_ = 0;
+ QProcess* released = process_;
+ process_ = 0;
return released;
}
void SystemcallPrivate::killProcess()
{
- killProcess(proc_);
+ killProcess(process_);
}