]> git.lyx.org Git - lyx.git/blobdiff - src/support/Systemcall.cpp
Add new placeholder $${python} to configure
[lyx.git] / src / support / Systemcall.cpp
index 2dbbba7c83010bdd6abcfdee2dc3accff12c33bc..6c96de1644792ba4038ecfe8dde6b67438edb937 100644 (file)
 #include "support/ProgressInterface.h"
 
 #include "LyX.h"
-#include "LyXRC.h"
 
 #include <cstdlib>
 #include <iostream>
 
 #include <QProcess>
-#include <QTime>
+#include <QElapsedTimer>
 #include <QThread>
 #include <QCoreApplication>
 #include <QDebug>
@@ -60,26 +59,26 @@ 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 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() {}
-       void lyxerrDisconnect() {}
+       void lyxerrConnect() override {}
+       void lyxerrDisconnect() override {}
 
-       void warning(QString const &, QString const &) {}
-       void toggleWarning(QString const &, QString const &, QString const &) {}
-       void error(QString const &, QString const &, QString const &) {}
-       void information(QString const &, QString const &) {}
+       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 &) { return default_but; }
+                  docstring const &, docstring const &) override { return default_but; }
 };
 
 
-static ProgressInterface * progress_instance = 0;
+static ProgressInterface * progress_instance = nullptr;
 
 void ProgressInterface::setInstance(ProgressInterface* p)
 {
@@ -170,7 +169,7 @@ string const parsecmd(string const & incmd, string & infile, string & outfile,
        bool in_single_quote = false;
        bool in_double_quote = false;
        bool escaped = false;
-       string const python_call = "python -tt";
+       string const python_call = os::python();
        vector<string> outcmd(4);
        size_t start = 0;
 
@@ -206,7 +205,7 @@ string const parsecmd(string const & incmd, string & infile, string & outfile,
                                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");
@@ -234,6 +233,12 @@ string const parsecmd(string const & incmd, string & infile, string & outfile,
 } // namespace
 
 
+void Systemcall::killscript()
+{
+       SystemcallPrivate::kill_script = true;
+}
+
+
 int Systemcall::startscript(Starttype how, string const & what,
                            string const & path, string const & lpath,
                            bool process_events)
@@ -251,42 +256,34 @@ int Systemcall::startscript(Starttype how, string const & what,
                        parsecmd(what_ss, infile, outfile, errfile).c_str());
 
        SystemcallPrivate d(infile, outfile, errfile);
+       bool do_events = process_events || how == WaitLoop;
 
-#ifdef Q_OS_WIN32
-       // QProcess::startDetached cannot provide environment variables. When the
-       // environment variables are set using the latexEnvCmdPrefix and the process
-       // is started with QProcess::startDetached, a console window is shown every
-       // time a viewer is started. To avoid this, we fall back on Windows to the
-       // original implementation that creates a QProcess object.
-       d.startProcess(cmd, path, lpath, false);
-       if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
-               LYXERR0("Systemcall: '" << cmd << "' did not start!");
-               LYXERR0("error " << d.errorMessage());
-               return 10;
-       }
-       if (how == DontWait) {
-               d.releaseProcess();
-               return 0;
-       }
-#else
        d.startProcess(cmd, path, lpath, how == DontWait);
        if (how == DontWait && d.state == SystemcallPrivate::Running)
-               return 0;
+               return OK;
 
        if (d.state == SystemcallPrivate::Error
-                       || !d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
-               LYXERR0("Systemcall: '" << cmd << "' did not start!");
-               LYXERR0("error " << d.errorMessage());
-               return 10;
+                       || !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;
+               }
        }
-#endif
 
-       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();
@@ -298,6 +295,9 @@ int Systemcall::startscript(Starttype how, string const & what,
 }
 
 
+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),
@@ -368,9 +368,39 @@ void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
                                      string const & lpath, bool detached)
 {
        cmd_ = cmd;
+#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;
                }
@@ -378,23 +408,28 @@ void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
                delete released;
        } else if (process_) {
                state = SystemcallPrivate::Starting;
+#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()
-{
-       if (process_events_) {
-               QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
-       }
-}
-
-
-void SystemcallPrivate::waitAndProcessEvents()
+bool SystemcallPrivate::waitAndCheck()
 {
        Sleep::millisec(100);
-       processEvents();
+       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;
 }
 
 
@@ -430,7 +465,7 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int time
                        while (!timedout) {
                                if (process_->waitForFinished(timeout))
                                        return true;
-                               bool stop = queryStopCommand(cmd_);
+                               bool const stop = queryStopCommand(cmd_);
                                // The command may have finished in the meantime
                                if (process_->state() == QProcess::NotRunning)
                                        return true;
@@ -449,18 +484,23 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int time
        // 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 with timeout
-       QTime timer;
+       QElapsedTimer timer;
        timer.start();
        while (state == waitwhile && state != Error && !timedout) {
-               waitAndProcessEvents();
+               // check for cancellation of background process
+               if (!waitAndCheck())
+                       return false;
+
                if (timer.elapsed() > timeout) {
-                       bool stop = queryStopCommand(cmd_);
+                       bool const stop = queryStopCommand(cmd_);
                        // The command may have finished in the meantime
                        if (process_->state() == QProcess::NotRunning)
                                break;
@@ -624,7 +664,7 @@ int SystemcallPrivate::exitCode()
 QProcess* SystemcallPrivate::releaseProcess()
 {
        QProcess* released = process_;
-       process_ = 0;
+       process_ = nullptr;
        return released;
 }