3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Angus Leeming
8 * \author Enrico Forestieri
9 * \author Peter Kuemmel
11 * Full author contact details are available in file CREDITS.
16 #include "support/debug.h"
17 #include "support/filetools.h"
18 #include "support/gettext.h"
19 #include "support/lstrings.h"
20 #include "support/qstring_helpers.h"
21 #include "support/Systemcall.h"
22 #include "support/SystemcallPrivate.h"
23 #include "support/os.h"
24 #include "support/ProgressInterface.h"
34 #include <QCoreApplication>
40 struct Sleep : QThread
42 static void millisec(unsigned long ms)
44 QThread::usleep(ms * 1000);
57 class ProgressDummy : public ProgressInterface
62 void processStarted(QString const &) {}
63 void processFinished(QString const &) {}
64 void appendMessage(QString const &) {}
65 void appendError(QString const &) {}
66 void clearMessages() {}
69 void lyxerrConnect() {}
70 void lyxerrDisconnect() {}
72 void warning(QString const &, QString const &) {}
73 void toggleWarning(QString const &, QString const &, QString const &) {}
74 void error(QString const &, QString const &) {}
75 void information(QString const &, QString const &) {}
76 int prompt(docstring const &, docstring const &, int default_but, int,
77 docstring const &, docstring const &) { return default_but; }
81 static ProgressInterface * progress_instance = 0;
83 void ProgressInterface::setInstance(ProgressInterface* p)
85 progress_instance = p;
89 ProgressInterface * ProgressInterface::instance()
91 if (!progress_instance) {
92 static ProgressDummy dummy;
95 return progress_instance;
103 int Systemcall::startscript(Starttype how, string const & what,
104 std::string const & path, bool /*process_events*/)
106 string const python_call = "python -tt";
107 string command = to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path)));
108 string what_ss = libScriptSearch(what);
110 if (prefixIs(what_ss, python_call))
111 command += os::python() + what_ss.substr(python_call.length());
115 if (how == DontWait) {
116 switch (os::shell()) {
121 command = "start /min " + command;
124 } else if (os::shell() == os::CMD_EXE)
125 command = subst(command, "cmd /d /c ", "");
127 return ::system(command.c_str());
135 * This is a parser that (mostly) mimics the behavior of a posix shell as
136 * regards quoting, but its output is tailored for being processed by QProcess.
137 * Note that shell metacharacters are not parsed.
139 * The escape character is the backslash.
140 * A backslash that is not quoted preserves the literal value of the following
141 * character, with the exception of a double-quote '"'. If a double-quote
142 * follows a backslash, it will be replaced by three consecutive double-quotes
143 * (this is how the QProcess parser recognizes a '"' as a simple character
144 * instead of a quoting character). Thus, for example:
150 * Characters enclosed in single-quotes ('') have their literal value preserved.
151 * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
152 * be used to escape a single-quote in a single-quoted string. In other words,
153 * anything enclosed in single-quotes is passed as is, but the single-quotes
154 * themselves are eliminated. Thus, for example:
161 * Characters enclosed in double-quotes ("") have their literal value preserved,
162 * with the exception of the backslash. The backslash retains its special
163 * meaning as an escape character only when followed by a double-quote.
164 * Contrarily to the behavior of a posix shell, the double-quotes themselves
165 * are *not* eliminated. Thus, for example:
170 string const parsecmd(string const & incmd, string & infile, string & outfile,
173 bool in_single_quote = false;
174 bool in_double_quote = false;
175 bool escaped = false;
176 string const python_call = "python -tt";
177 vector<string> outcmd(4);
180 if (prefixIs(incmd, python_call)) {
181 outcmd[0] = os::python();
182 start = python_call.length();
185 for (size_t i = start, o = 0; i < incmd.length(); ++i) {
188 if (in_double_quote || escaped) {
189 if (in_double_quote && escaped)
193 in_single_quote = !in_single_quote;
197 if (in_single_quote) {
203 // Don't triple double-quotes for redirection
204 // files as these won't be parsed by QProcess
205 outcmd[o] += string(o ? "\"" : "\"\"\"");
209 in_double_quote = !in_double_quote;
211 } else if (c == '\\' && !escaped) {
213 } else if (c == '>' && !(in_double_quote || escaped)) {
214 if (suffixIs(outcmd[o], " 2")) {
215 outcmd[o] = rtrim(outcmd[o], "2");
218 if (suffixIs(outcmd[o], " 1"))
219 outcmd[o] = rtrim(outcmd[o], "1");
222 } else if (c == '<' && !(in_double_quote || escaped)) {
225 if (escaped && in_double_quote)
231 infile = trim(outcmd[3], " \"");
232 outfile = trim(outcmd[1], " \"");
233 errfile = trim(outcmd[2], " \"");
234 return trim(outcmd[0]);
241 int Systemcall::startscript(Starttype how, string const & what,
242 string const & path, bool process_events)
244 string const what_ss = libScriptSearch(what);
245 LYXERR(Debug::INFO,"Running: " << what_ss);
250 QString const cmd = QString::fromLocal8Bit(
251 parsecmd(what_ss, infile, outfile, errfile).c_str());
253 SystemcallPrivate d(infile, outfile, errfile);
256 // QProcess::startDetached cannot provide environment variables. When the
257 // environment variables are set using the latexEnvCmdPrefix and the process
258 // is started with QProcess::startDetached, a console window is shown every
259 // time a viewer is started. To avoid this, we fall back on Windows to the
260 // original implementation that creates a QProcess object.
261 d.startProcess(cmd, path, false);
262 if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
263 LYXERR0("Systemcall: '" << cmd << "' did not start!");
264 LYXERR0("error " << d.errorMessage());
267 if (how == DontWait) {
272 d.startProcess(cmd, path, how == DontWait);
273 if (how == DontWait && d.state == SystemcallPrivate::Running)
276 if (d.state == SystemcallPrivate::Error
277 || !d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
278 LYXERR0("Systemcall: '" << cmd << "' did not start!");
279 LYXERR0("error " << d.errorMessage());
284 if (!d.waitWhile(SystemcallPrivate::Running, process_events,
285 os::timeout_min() * 60 * 1000)) {
286 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
287 LYXERR0("error " << d.errorMessage());
288 LYXERR0("status " << d.exitStatusMessage());
292 int const exit_code = d.exitCode();
294 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
301 SystemcallPrivate::SystemcallPrivate(std::string const & sf,
302 std::string const & of,
303 std::string const & ef) :
304 process_(new QProcess),
310 process_events_(false)
312 if (!in_file_.empty())
313 process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
314 if (!out_file_.empty()) {
315 if (out_file_[0] == '&') {
316 if (subst(out_file_, " ", "") == "&2"
317 && err_file_[0] != '&') {
318 out_file_ = err_file_;
319 process_->setProcessChannelMode(
320 QProcess::MergedChannels);
322 if (err_file_[0] == '&') {
323 // Leave alone things such as
324 // "1>&2 2>&1". Should not be harmful,
325 // but let's give anyway a warning.
326 LYXERR0("Unsupported stdout/stderr redirect.");
329 LYXERR0("Ambiguous stdout redirect: "
332 out_file_ = os::nulldev();
335 // Check whether we have to set the output file.
336 if (out_file_ != os::nulldev()) {
337 process_->setStandardOutputFile(QString::fromLocal8Bit(
341 if (!err_file_.empty()) {
342 if (err_file_[0] == '&') {
343 if (subst(err_file_, " ", "") == "&1"
344 && out_file_[0] != '&') {
345 process_->setProcessChannelMode(
346 QProcess::MergedChannels);
348 LYXERR0("Ambiguous stderr redirect: "
351 // In MergedChannels mode stderr goes to stdout.
352 err_file_ = os::nulldev();
354 // Check whether we have to set the error file.
355 if (err_file_ != os::nulldev()) {
356 process_->setStandardErrorFile(QString::fromLocal8Bit(
361 connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
362 connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
363 connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
364 connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
365 connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
369 void SystemcallPrivate::startProcess(QString const & cmd, string const & path, bool detached)
373 state = SystemcallPrivate::Running;
374 if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path)) + cmd_)) {
375 state = SystemcallPrivate::Error;
378 QProcess* released = releaseProcess();
380 } else if (process_) {
381 state = SystemcallPrivate::Starting;
382 process_->start(toqstr(latexEnvCmdPrefix(path)) + cmd_);
387 void SystemcallPrivate::processEvents()
389 if (process_events_) {
390 QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
395 void SystemcallPrivate::waitAndProcessEvents()
397 Sleep::millisec(100);
404 bool queryStopCommand(QString const & cmd)
406 docstring text = bformat(_(
407 "The command\n%1$s\nhas not yet completed.\n\n"
408 "Do you want to stop it?"), qstring_to_ucs4(cmd));
409 return ProgressInterface::instance()->prompt(_("Stop command?"), text,
410 1, 1, _("&Stop it"), _("Let it &run")) == 0;
416 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
421 bool timedout = false;
422 process_events_ = process_events;
424 // Block GUI while waiting,
425 // relay on QProcess' wait functions
426 if (!process_events_) {
427 if (waitwhile == Starting)
428 return process_->waitForStarted(timeout);
429 if (waitwhile == Running) {
432 if (process_->waitForFinished(timeout))
434 bool stop = queryStopCommand(cmd_);
435 // The command may have finished in the meantime
436 if (process_->state() == QProcess::NotRunning)
450 // process events while waiting, no timeout
452 while (state == waitwhile && state != Error) {
453 waitAndProcessEvents();
455 return state != Error;
458 // process events while waiting with timeout
461 while (state == waitwhile && state != Error && !timedout) {
462 waitAndProcessEvents();
463 if (timer.elapsed() > timeout) {
464 bool stop = queryStopCommand(cmd_);
465 // The command may have finished in the meantime
466 if (process_->state() == QProcess::NotRunning)
475 return (state != Error) && !timedout;
479 SystemcallPrivate::~SystemcallPrivate()
482 out_data_[out_index_] = '\0';
488 err_data_[err_index_] = '\0';
498 void SystemcallPrivate::stdOut()
502 process_->setReadChannel(QProcess::StandardOutput);
503 while (process_->getChar(&c)) {
504 out_data_[out_index_++] = c;
505 if (c == '\n' || out_index_ + 1 == buffer_size_) {
506 out_data_[out_index_] = '\0';
508 ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
516 void SystemcallPrivate::stdErr()
520 process_->setReadChannel(QProcess::StandardError);
521 while (process_->getChar(&c)) {
522 err_data_[err_index_++] = c;
523 if (c == '\n' || err_index_ + 1 == buffer_size_) {
524 err_data_[err_index_] = '\0';
526 ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
534 void SystemcallPrivate::processStarted()
536 if (state != Running) {
538 ProgressInterface::instance()->processStarted(cmd_);
543 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
545 if (state != Finished) {
547 ProgressInterface::instance()->processFinished(cmd_);
552 void SystemcallPrivate::processError(QProcess::ProcessError)
555 ProgressInterface::instance()->appendError(errorMessage());
559 QString SystemcallPrivate::errorMessage() const
562 return "No QProcess available";
565 switch (process_->error()) {
566 case QProcess::FailedToStart:
567 message = "The process failed to start. Either the invoked program is missing, "
568 "or you may have insufficient permissions to invoke the program.";
570 case QProcess::Crashed:
571 message = "The process crashed some time after starting successfully.";
573 case QProcess::Timedout:
574 message = "The process timed out. It might be restarted automatically.";
576 case QProcess::WriteError:
577 message = "An error occurred when attempting to write to the process-> For example, "
578 "the process may not be running, or it may have closed its input channel.";
580 case QProcess::ReadError:
581 message = "An error occurred when attempting to read from the process-> For example, "
582 "the process may not be running.";
584 case QProcess::UnknownError:
586 message = "An unknown error occured.";
593 QString SystemcallPrivate::exitStatusMessage() const
596 return "No QProcess available";
599 switch (process_->exitStatus()) {
600 case QProcess::NormalExit:
601 message = "The process exited normally.";
603 case QProcess::CrashExit:
604 message = "The process crashed.";
607 message = "Unknown exit state.";
614 int SystemcallPrivate::exitCode()
619 return process_->exitCode();
623 QProcess* SystemcallPrivate::releaseProcess()
625 QProcess* released = process_;
631 void SystemcallPrivate::killProcess()
633 killProcess(process_);
637 void SystemcallPrivate::killProcess(QProcess * p)
641 p->closeReadChannel(QProcess::StandardOutput);
642 p->closeReadChannel(QProcess::StandardError);
650 #include "moc_SystemcallPrivate.cpp"
653 } // namespace support