#include "support/debug.h"
#include "support/filetools.h"
+#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/qstring_helpers.h"
#include "support/Systemcall.h"
#include "support/os.h"
#include "support/ProgressInterface.h"
-#include "LyXRC.h"
+#include "LyX.h"
#include <cstdlib>
#include <iostream>
#include <QProcess>
-#include <QTime>
+#include <QElapsedTimer>
#include <QThread>
#include <QCoreApplication>
#include <QDebug>
struct Sleep : QThread
{
- static void millisec(unsigned long ms)
+ static void millisec(unsigned long ms)
{
QThread::usleep(ms * 1000);
}
namespace support {
-class ProgressDummy : public ProgressInterface
+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 &) {}
+ void processStarted(QString const &) override {}
+ void processFinished(QString const &) override {}
+ void appendMessage(QString const &) override {}
+ void appendError(QString const &) override {}
+ void clearMessages() override {}
+ void lyxerrFlush() override {}
+
+ void lyxerrConnect() override {}
+ void lyxerrDisconnect() override {}
+
+ void warning(QString const &, QString const &) override {}
+ void toggleWarning(QString const &, QString const &, QString const &) override {}
+ void error(QString const &, QString const &, QString const &) override {}
+ void information(QString const &, QString const &) override {}
+ int prompt(docstring const &, docstring const &, int default_but, int,
+ docstring const &, docstring const &) override { return default_but; }
};
-static ProgressInterface* progress_instance = 0;
+static ProgressInterface * progress_instance = nullptr;
void ProgressInterface::setInstance(ProgressInterface* p)
{
}
-ProgressInterface* ProgressInterface::instance()
+ProgressInterface * ProgressInterface::instance()
{
if (!progress_instance) {
static ProgressDummy dummy;
// Reuse of instance
#ifndef USE_QPROCESS
int Systemcall::startscript(Starttype how, string const & what,
- std::string const & path, bool /*process_events*/)
+ string const & path, string const & lpath,
+ bool /*process_events*/)
{
- string const python_call = "python -tt";
- string command = to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path)));
-
- if (prefixIs(what, python_call))
- command += os::python() + what.substr(python_call.length());
- else
- command += what;
+ string command =
+ to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
+ + commandPrep(what);
if (how == DontWait) {
switch (os::shell()) {
/*
* This is a parser that (mostly) mimics the behavior of a posix shell as
* regards quoting, but its output is tailored for being processed by QProcess.
- * Note that shell metacharacters are not parsed and only output redirection
- * is taken into account.
+ * Note that shell metacharacters are not parsed.
*
* The escape character is the backslash.
* A backslash that is not quoted preserves the literal value of the following
* "\a" -> "\a"
* "a\"b" -> "a"""b"
*/
-string const parsecmd(string const & incmd, string & outfile, string & errfile)
+string const parsecmd(string const & incmd, string & infile, string & outfile,
+ string & errfile)
{
bool in_single_quote = false;
bool in_double_quote = false;
bool escaped = false;
string const python_call = "python -tt";
- vector<string> outcmd(3);
+ vector<string> outcmd(4);
size_t start = 0;
if (prefixIs(incmd, python_call)) {
in_double_quote = !in_double_quote;
}
} else if (c == '\\' && !escaped) {
- escaped = !escaped;
+ escaped = true;
} else if (c == '>' && !(in_double_quote || escaped)) {
if (suffixIs(outcmd[o], " 2")) {
outcmd[o] = rtrim(outcmd[o], "2");
outcmd[o] = rtrim(outcmd[o], "1");
o = 1;
}
+ } else if (c == '<' && !(in_double_quote || escaped)) {
+ o = 3;
} else {
if (escaped && in_double_quote)
outcmd[o] += '\\';
escaped = false;
}
}
+ infile = trim(outcmd[3], " \"");
outfile = trim(outcmd[1], " \"");
errfile = trim(outcmd[2], " \"");
return trim(outcmd[0]);
}
-} // namespace anon
+} // namespace
+void Systemcall::killscript()
+{
+ SystemcallPrivate::kill_script = true;
+}
+
int Systemcall::startscript(Starttype how, string const & what,
- string const & path, bool process_events)
+ string const & path, string const & lpath,
+ bool process_events)
{
- lyxerr << "\nRunning: " << what << endl;
+ string const what_ss = commandPrep(what);
+ if (verbose)
+ lyxerr << "\nRunning: " << what_ss << endl;
+ else
+ LYXERR(Debug::INFO,"Running: " << what_ss);
+ string infile;
string outfile;
string errfile;
- QString cmd = QString::fromLocal8Bit(
- parsecmd(what, outfile, errfile).c_str());
-
- SystemcallPrivate d(outfile, errfile);
-
-
- 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 (how == DontWait) {
- QProcess* released = d.releaseProcess();
- (void) released; // TODO who deletes it?
- return 0;
+ QString const cmd = QString::fromLocal8Bit(
+ parsecmd(what_ss, infile, outfile, errfile).c_str());
+
+ SystemcallPrivate d(infile, outfile, errfile);
+ bool do_events = process_events || how == WaitLoop;
+
+ d.startProcess(cmd, path, lpath, how == DontWait);
+ if (how == DontWait && d.state == SystemcallPrivate::Running)
+ return OK;
+
+ if (d.state == SystemcallPrivate::Error
+ || !d.waitWhile(SystemcallPrivate::Starting, do_events, -1)) {
+ if (d.state == SystemcallPrivate::Error) {
+ LYXERR0("Systemcall: '" << cmd << "' did not start!");
+ LYXERR0("error " << d.errorMessage());
+ return NOSTART;
+ } else if (d.state == SystemcallPrivate::Killed) {
+ LYXERR0("Killed: " << cmd);
+ return KILLED;
+ }
}
- if (!d.waitWhile(SystemcallPrivate::Running, process_events,
+ if (!d.waitWhile(SystemcallPrivate::Running, do_events,
os::timeout_min() * 60 * 1000)) {
+ if (d.state == SystemcallPrivate::Killed) {
+ LYXERR0("Killed: " << cmd);
+ return KILLED;
+ }
LYXERR0("Systemcall: '" << cmd << "' did not finish!");
LYXERR0("error " << d.errorMessage());
LYXERR0("status " << d.exitStatusMessage());
- return 20;
+ return TIMEOUT;
}
int const exit_code = d.exitCode();
}
-SystemcallPrivate::SystemcallPrivate(std::string const & of,
- std::string const & ef) :
- process_(new QProcess),
- out_index_(0),
- err_index_(0),
- out_file_(of),
- err_file_(ef),
- process_events_(false)
+bool SystemcallPrivate::kill_script = false;
+
+
+SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of,
+ std::string const & ef)
+ : state(Error), process_(new QProcess), out_index_(0), err_index_(0),
+ in_file_(sf), out_file_(of), err_file_(ef), process_events_(false)
{
+ if (!in_file_.empty())
+ process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
if (!out_file_.empty()) {
if (out_file_[0] == '&') {
if (subst(out_file_, " ", "") == "&2"
connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
+#if QT_VERSION >= 0x050600
+ connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
+#else
connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
+#endif
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)
+void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
+ string const & lpath, bool detached)
{
cmd_ = cmd;
- if (process_) {
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
+ // FIXME pass command and arguments separated in the first place
+ /* The versions of startDetached() and start() that accept a
+ * QStringList object exist since Qt4, but it is only in Qt 5.15
+ * that splitCommand() was introduced and the plain versions of
+ * start/startDetached() have been deprecated.
+ * The cleanest solution would be to have parsecmd() produce a
+ * QStringList for arguments, instead of transforming the string
+ * into something that the QProcess splitter accepts.
+ */
+ QStringList arguments = QProcess::splitCommand(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
+ QString command = (arguments.empty()) ? QString() : arguments.first();
+ if (arguments.size() == 1)
+ arguments.clear();
+ else if (!arguments.empty())
+ arguments.removeFirst();
+#endif
+ if (detached) {
+ state = SystemcallPrivate::Running;
+#ifdef Q_OS_WIN32
+ // Avoid opening a console window when a viewer is started
+ if (in_file_.empty())
+ process_->setStandardInputFile(QProcess::nullDevice());
+ if (out_file_.empty())
+ process_->setStandardOutputFile(QProcess::nullDevice());
+ if (err_file_.empty())
+ process_->setStandardErrorFile(QProcess::nullDevice());
+#endif
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
+ if (!QProcess::startDetached(command, arguments)) {
+#else
+ if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
+#endif
+ state = SystemcallPrivate::Error;
+ return;
+ }
+ QProcess* released = releaseProcess();
+ delete released;
+ } else if (process_) {
state = SystemcallPrivate::Starting;
- process_->start(toqstr(latexEnvCmdPrefix(path)) + cmd_);
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
+ process_->start(command, arguments);
+#else
+ process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
+#endif
}
}
-void SystemcallPrivate::processEvents()
+bool SystemcallPrivate::waitAndCheck()
{
- if(process_events_) {
- QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
+ Sleep::millisec(100);
+ if (kill_script) {
+ // is there a better place to reset this?
+ process_->kill();
+ state = Killed;
+ kill_script = false;
+ LYXERR0("Export Canceled!!");
+ return false;
}
+ QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
+ return true;
}
-void SystemcallPrivate::waitAndProcessEvents()
+namespace {
+
+bool queryStopCommand(QString const & cmd)
{
- Sleep::millisec(100);
- processEvents();
+ docstring text = bformat(_(
+ "The command\n%1$s\nhas not yet completed.\n\n"
+ "Do you want to stop it?"), qstring_to_ucs4(cmd));
+ return ProgressInterface::instance()->prompt(_("Stop command?"), text,
+ 1, 1, _("&Stop it"), _("Let it &run")) == 0;
}
+} // namespace
+
bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
{
if (!process_)
return false;
+ bool timedout = false;
process_events_ = process_events;
// Block GUI while waiting,
if (!process_events_) {
if (waitwhile == Starting)
return process_->waitForStarted(timeout);
- if (waitwhile == Running)
- return process_->waitForFinished(timeout);
+ if (waitwhile == Running) {
+ int bump = 2;
+ while (!timedout) {
+ if (process_->waitForFinished(timeout))
+ return true;
+ bool const stop = queryStopCommand(cmd_);
+ // The command may have finished in the meantime
+ if (process_->state() == QProcess::NotRunning)
+ return true;
+ if (stop) {
+ timedout = true;
+ process_->kill();
+ } else {
+ timeout *= bump;
+ bump = 3;
+ }
+ }
+ }
return false;
}
// process events while waiting, no timeout
if (timeout == -1) {
while (state == waitwhile && state != Error) {
- waitAndProcessEvents();
+ // check for cancellation of background process
+ if (!waitAndCheck())
+ return false;
}
return state != Error;
- }
+ }
- // process events while waiting whith timeout
- QTime timer;
+ // process events while waiting with timeout
+ QElapsedTimer timer;
timer.start();
- while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
- waitAndProcessEvents();
+ while (state == waitwhile && state != Error && !timedout) {
+ // check for cancellation of background process
+ if (!waitAndCheck())
+ return false;
+
+ if (timer.elapsed() > timeout) {
+ bool const stop = queryStopCommand(cmd_);
+ // The command may have finished in the meantime
+ if (process_->state() == QProcess::NotRunning)
+ break;
+ if (stop) {
+ timedout = true;
+ process_->kill();
+ } else
+ timeout *= 3;
+ }
}
- return (state != Error) && (timer.elapsed() < timeout);
+ return (state != Error) && !timedout;
}
}
-QString SystemcallPrivate::errorMessage() const
+QString SystemcallPrivate::errorMessage() const
{
if (!process_)
return "No QProcess available";
break;
case QProcess::UnknownError:
default:
- message = "An unknown error occured.";
+ message = "An unknown error occurred.";
break;
}
return message;
int SystemcallPrivate::exitCode()
{
- if (!process_)
+ // From Qt's documentation, in regards to QProcess::exitCode(),
+ // "This value is not valid unless exitStatus() returns NormalExit"
+ if (!process_ || process_->exitStatus() != QProcess::NormalExit)
return -1;
return process_->exitCode();
QProcess* SystemcallPrivate::releaseProcess()
{
QProcess* released = process_;
- process_ = 0;
+ process_ = nullptr;
return released;
}