]> git.lyx.org Git - lyx.git/blobdiff - src/support/Systemcall.cpp
Account for old versions of Pygments
[lyx.git] / src / support / Systemcall.cpp
index 0753c590c8c0b5fe3b0454a6a5c2e1c9aa5a4f18..cc2c3814ab761c17ec360316f1b071e7ea5e21aa 100644 (file)
@@ -14,8 +14,8 @@
 #include <config.h>
 
 #include "support/debug.h"
-#include "support/environment.h"
 #include "support/filetools.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/qstring_helpers.h"
 #include "support/Systemcall.h"
@@ -23,6 +23,7 @@
 #include "support/os.h"
 #include "support/ProgressInterface.h"
 
+#include "LyX.h"
 #include "LyXRC.h"
 
 #include <cstdlib>
@@ -71,12 +72,14 @@ public:
 
        void warning(QString const &, QString const &) {}
        void toggleWarning(QString const &, QString const &, QString const &) {}
-       void error(QString const &, QString const &) {}
+       void error(QString const &, QString const &, QString const &) {}
        void information(QString const &, QString const &) {}
+       int prompt(docstring const &, docstring const &, int default_but, int,
+                  docstring const &, docstring const &) { return default_but; }
 };
 
 
-static ProgressInterface* progress_instance = 0;
+static ProgressInterface * progress_instance = 0;
 
 void ProgressInterface::setInstance(ProgressInterface* p)
 {
@@ -84,7 +87,7 @@ void ProgressInterface::setInstance(ProgressInterface* p)
 }
 
 
-ProgressInterface* ProgressInterface::instance()
+ProgressInterface * ProgressInterface::instance()
 {
        if (!progress_instance) {
                static ProgressDummy dummy;
@@ -99,26 +102,12 @@ 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;
-       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;
-       }
+       string command =
+               to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
+                      + commandPrep(what);
 
        if (how == DontWait) {
                switch (os::shell()) {
@@ -129,7 +118,8 @@ int Systemcall::startscript(Starttype how, string const & what,
                        command = "start /min " + command;
                        break;
                }
-       }
+       } else if (os::shell() == os::CMD_EXE)
+               command = subst(command, "cmd /d /c ", "");
 
        return ::system(command.c_str());
 }
@@ -139,8 +129,9 @@ int Systemcall::startscript(Starttype how, string const & what,
 namespace {
 
 /*
- * This is a parser that (mostly) mimics the behavior of a posix shell but
- * its output is tailored for being processed by QProcess.
+ * 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.
  *
  * The escape character is the backslash.
  * A backslash that is not quoted preserves the literal value of the following
@@ -173,51 +164,71 @@ namespace {
  *    "\a"   ->  "\a"
  *    "a\"b" ->  "a"""b"
  */
-string const parsecmd(string const & inputcmd, string & outfile)
+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 cmd;
+       string const python_call = "python -tt";
+       vector<string> outcmd(4);
+       size_t start = 0;
+
+       if (prefixIs(incmd, python_call)) {
+               outcmd[0] = os::python();
+               start = python_call.length();
+       }
 
-       for (size_t i = 0; i < inputcmd.length(); ++i) {
-               char c = inputcmd[i];
+       for (size_t i = start, o = 0; i < incmd.length(); ++i) {
+               char c = incmd[i];
                if (c == '\'') {
                        if (in_double_quote || escaped) {
                                if (in_double_quote && escaped)
-                                       cmd += '\\';
-                               cmd += c;
+                                       outcmd[o] += '\\';
+                               outcmd[o] += c;
                        } else
                                in_single_quote = !in_single_quote;
                        escaped = false;
                        continue;
                }
                if (in_single_quote) {
-                       cmd += c;
+                       outcmd[o] += c;
                        continue;
                }
                if (c == '"') {
                        if (escaped) {
-                               cmd += "\"\"\"";
+                               // Don't triple double-quotes for redirection
+                               // files as these won't be parsed by QProcess
+                               outcmd[o] += string(o ? "\"" : "\"\"\"");
                                escaped = false;
                        } else {
-                               cmd += c;
+                               outcmd[o] += 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);
+                       if (suffixIs(outcmd[o], " 2")) {
+                               outcmd[o] = rtrim(outcmd[o], "2");
+                               o = 2;
+                       } else {
+                               if (suffixIs(outcmd[o], " 1"))
+                                       outcmd[o] = rtrim(outcmd[o], "1");
+                               o = 1;
+                       }
+               } else if (c == '<' && !(in_double_quote || escaped)) {
+                       o = 3;
                } else {
                        if (escaped && in_double_quote)
-                               cmd += '\\';
-                       cmd += c;
+                               outcmd[o] += '\\';
+                       outcmd[o] += c;
                        escaped = false;
                }
        }
-       outfile.erase();
-       return cmd;
+       infile  = trim(outcmd[3], " \"");
+       outfile = trim(outcmd[1], " \"");
+       errfile = trim(outcmd[2], " \"");
+       return trim(outcmd[0]);
 }
 
 } // namespace anon
@@ -225,26 +236,51 @@ string const parsecmd(string const & inputcmd, string & outfile)
 
 
 int Systemcall::startscript(Starttype how, string const & what,
-                           string const & path, bool process_events)
+                           string const & path, string const & lpath,
+                           bool process_events)
 {
-       string outfile;
-       QString cmd = toqstr(parsecmd(what, outfile));
-
-       SystemcallPrivate d(outfile);
-
+       string const what_ss = commandPrep(what);
+       if (verbose)
+               lyxerr << "\nRunning: " << what_ss << endl;
+       else
+               LYXERR(Debug::INFO,"Running: " << what_ss);
 
-       d.startProcess(cmd, path);
+       string infile;
+       string outfile;
+       string errfile;
+       QString const cmd = QString::fromLocal8Bit(
+                       parsecmd(what_ss, infile, outfile, errfile).c_str());
+
+       SystemcallPrivate d(infile, outfile, errfile);
+
+#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) {
-               QProcess* released = d.releaseProcess();
-               (void) released; // TODO who deletes it?
+               d.releaseProcess();
                return 0;
        }
+#else
+       d.startProcess(cmd, path, lpath, how == DontWait);
+       if (how == DontWait && d.state == SystemcallPrivate::Running)
+               return 0;
+
+       if (d.state == SystemcallPrivate::Error
+                       || !d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
+               LYXERR0("Systemcall: '" << cmd << "' did not start!");
+               LYXERR0("error " << d.errorMessage());
+               return 10;
+       }
+#endif
 
        if (!d.waitWhile(SystemcallPrivate::Running, process_events,
                         os::timeout_min() * 60 * 1000)) {
@@ -263,55 +299,94 @@ int Systemcall::startscript(Starttype how, string const & what,
 }
 
 
-SystemcallPrivate::SystemcallPrivate(const std::string& of) :
-                                process_(new QProcess), 
-                                out_index_(0),
-                                err_index_(0),
-                                out_file_(of), 
-                                process_events_(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()) {
-               // Check whether we have to simply throw away the output.
-               if (out_file_ != os::nulldev())
-                       process_->setStandardOutputFile(toqstr(out_file_));
+               if (out_file_[0] == '&') {
+                       if (subst(out_file_, " ", "") == "&2"
+                           && err_file_[0] != '&') {
+                               out_file_ = err_file_;
+                               process_->setProcessChannelMode(
+                                               QProcess::MergedChannels);
+                       } else {
+                               if (err_file_[0] == '&') {
+                                       // Leave alone things such as
+                                       // "1>&2 2>&1". Should not be harmful,
+                                       // but let's give anyway a warning.
+                                       LYXERR0("Unsupported stdout/stderr redirect.");
+                                       err_file_.erase();
+                               } else {
+                                       LYXERR0("Ambiguous stdout redirect: "
+                                               << out_file_);
+                               }
+                               out_file_ = os::nulldev();
+                       }
+               }
+               // Check whether we have to set the output file.
+               if (out_file_ != os::nulldev()) {
+                       process_->setStandardOutputFile(QString::fromLocal8Bit(
+                                                       out_file_.c_str()));
+               }
+       }
+       if (!err_file_.empty()) {
+               if (err_file_[0] == '&') {
+                       if (subst(err_file_, " ", "") == "&1"
+                           && out_file_[0] != '&') {
+                               process_->setProcessChannelMode(
+                                               QProcess::MergedChannels);
+                       } else {
+                               LYXERR0("Ambiguous stderr redirect: "
+                                       << err_file_);
+                       }
+                       // In MergedChannels mode stderr goes to stdout.
+                       err_file_ = os::nulldev();
+               }
+               // Check whether we have to set the error file.
+               if (err_file_ != os::nulldev()) {
+                       process_->setStandardErrorFile(QString::fromLocal8Bit(
+                                                       err_file_.c_str()));
+               }
        }
 
        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 (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
-                       QString const texinputs = toqstr(os::latex_path_list(
-                               replaceCurdirPath(path, lyxrc.texinputs_prefix)));
-                       QChar const sep = os::path_separator(os::TEXENGINE);
-                       QString const prefix = QLatin1String("TEXINPUTS=.")
-                                               + sep + texinputs + sep;
-                       QStringList env = QProcess::systemEnvironment();
-                       if (env.filter("TEXINPUTS=").isEmpty())
-                               env << prefix;
-                       else
-                               env.replaceInStrings(QRegExp("^TEXINPUTS=(.*)"),
-                                                    prefix + "\\1");
-                       process_->setEnvironment(env);
+       if (detached) {
+               state = SystemcallPrivate::Running;
+               if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
+                       state = SystemcallPrivate::Error;
+                       return;
                }
+               QProcess* released = releaseProcess();
+               delete released;
+       } else if (process_) {
                state = SystemcallPrivate::Starting;
-               process_->start(cmd_);
+               process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_);
        }
 }
 
 
 void SystemcallPrivate::processEvents()
 {
-       if(process_events_) {
+       if (process_events_) {
                QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
        }
 }
@@ -324,11 +399,26 @@ void SystemcallPrivate::waitAndProcessEvents()
 }
 
 
+namespace {
+
+bool queryStopCommand(QString const & cmd)
+{
+       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;
+}
+
+}
+
+
 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,
@@ -336,8 +426,24 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int time
        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 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;
        }
 
@@ -349,13 +455,24 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int time
                return state != Error;
        } 
 
-       // process events while waiting whith timeout
+       // process events while waiting with timeout
        QTime timer;
        timer.start();
-       while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
+       while (state == waitwhile && state != Error && !timedout) {
                waitAndProcessEvents();
+               if (timer.elapsed() > timeout) {
+                       bool 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;
 }
 
 
@@ -466,7 +583,7 @@ QString SystemcallPrivate::errorMessage() const
                        break;
                case QProcess::UnknownError:
                default:
-                       message = "An unknown error occured.";
+                       message = "An unknown error occurred.";
                        break;
        }
        return message;
@@ -496,7 +613,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();