]> git.lyx.org Git - lyx.git/blobdiff - src/support/Systemcall.cpp
Less expensive OP first as this might be called often.
[lyx.git] / src / support / Systemcall.cpp
index 467f04bd8409db36c1f5fc60780082eb964bab1a..7c4eaabc979490ae61930b290425582e83e262e5 100644 (file)
 #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>
@@ -39,7 +39,7 @@
 
 struct Sleep : QThread
 {
-       static void millisec(unsigned long ms) 
+       static void millisec(unsigned long ms)
        {
                QThread::usleep(ms * 1000);
        }
@@ -54,31 +54,31 @@ namespace lyx {
 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 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)
 {
@@ -101,9 +101,11 @@ ProgressInterface * ProgressInterface::instance()
 // 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 command = to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path)))
+       string command =
+               to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
                       + commandPrep(what);
 
        if (how == DontWait) {
@@ -167,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;
 
@@ -203,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");
@@ -215,6 +217,21 @@ string const parsecmd(string const & incmd, string & infile, string & outfile,
                        }
                } else if (c == '<' && !(in_double_quote || escaped)) {
                        o = 3;
+#if defined (USE_MACOSX_PACKAGING)
+               } else if (o == 0 && i > 4 && c == ' ' && !(in_double_quote || escaped)) {
+                       // if a macOS app is detected with an additional argument
+                       // use open command as prefix to get it work
+                       const size_t apos = outcmd[o].rfind(".app");
+                       const size_t len = outcmd[o].length();
+                       const bool quoted = outcmd[o].at(len - 1) == '"' && outcmd[o].at(0) == '"';
+                       const string & ocmd = "open -a ";
+                       if (apos != string::npos &&
+                               (apos == (len - 4) || (apos == (len - 5) && quoted)) &&
+                               !prefixIs(trim(outcmd[o]), ocmd)) {
+                               outcmd[o] = ocmd + outcmd[o];
+                       }
+                       outcmd[o] += c;
+#endif
                } else {
                        if (escaped && in_double_quote)
                                outcmd[o] += '\\';
@@ -228,15 +245,24 @@ string const parsecmd(string const & incmd, string & infile, string & outfile,
        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)
 {
        string const what_ss = commandPrep(what);
-       LYXERR(Debug::INFO,"Running: " << what_ss);
+       if (verbose)
+               lyxerr << "\nRunning: " << what_ss << endl;
+       else
+               LYXERR(Debug::INFO,"Running: " << what_ss);
 
        string infile;
        string outfile;
@@ -245,42 +271,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, 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, how == DontWait);
+       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,
-                        os::timeout_min() * 60 * 1000)) {
+       if (!d.waitWhile(SystemcallPrivate::Running, do_events,
+                        os::timeout_ms())) {
+               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();
@@ -292,16 +310,13 @@ int Systemcall::startscript(Starttype how, string const & what,
 }
 
 
-SystemcallPrivate::SystemcallPrivate(std::string const & sf,
-                                    std::string const & of,
-                                    std::string const & ef) :
-                               process_(new QProcess), 
-                               out_index_(0),
-                               err_index_(0),
-                               in_file_(sf),
-                               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()));
@@ -354,18 +369,58 @@ SystemcallPrivate::SystemcallPrivate(std::string const & sf,
 
        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, bool detached)
+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.
+        *
+        * Another reason for doing that is that the Qt parser ignores
+        * empty "" arguments, which are needed in some instances (see
+        * e.g. the work around for modules in Converter:convert. See
+        * QTBUG-80640 for a discussion.
+       */
+       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;
-               if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path)) + cmd_)) {
+#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;
                }
@@ -373,23 +428,28 @@ void SystemcallPrivate::startProcess(QString const & cmd, string const & path, b
                delete released;
        } else if (process_) {
                state = SystemcallPrivate::Starting;
-               process_->start(toqstr(latexEnvCmdPrefix(path)) + cmd_);
-       }
-}
-
-
-void SystemcallPrivate::processEvents()
-{
-       if (process_events_) {
-               QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
+#if (QT_VERSION >= QT_VERSION_CHECK(5, 15, 0))
+               process_->start(command, arguments);
+#else
+               process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
+#endif
        }
 }
 
 
-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;
 }
 
 
@@ -404,7 +464,7 @@ bool queryStopCommand(QString const & cmd)
                        1, 1, _("&Stop it"), _("Let it &run")) == 0;
 }
 
-}
+} // namespace
 
 
 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
@@ -425,7 +485,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;
@@ -444,18 +504,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;
@@ -550,7 +615,7 @@ void SystemcallPrivate::processError(QProcess::ProcessError)
 }
 
 
-QString SystemcallPrivate::errorMessage() const 
+QString SystemcallPrivate::errorMessage() const
 {
        if (!process_)
                return "No QProcess available";
@@ -577,7 +642,7 @@ QString SystemcallPrivate::errorMessage() const
                        break;
                case QProcess::UnknownError:
                default:
-                       message = "An unknown error occured.";
+                       message = "An unknown error occurred.";
                        break;
        }
        return message;
@@ -607,7 +672,9 @@ QString SystemcallPrivate::exitStatusMessage() const
 
 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();
@@ -617,7 +684,7 @@ int SystemcallPrivate::exitCode()
 QProcess* SystemcallPrivate::releaseProcess()
 {
        QProcess* released = process_;
-       process_ = 0;
+       process_ = nullptr;
        return released;
 }