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"
35 #include <QCoreApplication>
41 struct Sleep : QThread
43 static void millisec(unsigned long ms)
45 QThread::usleep(ms * 1000);
58 class ProgressDummy : public ProgressInterface
63 void processStarted(QString const &) {}
64 void processFinished(QString const &) {}
65 void appendMessage(QString const &) {}
66 void appendError(QString const &) {}
67 void clearMessages() {}
70 void lyxerrConnect() {}
71 void lyxerrDisconnect() {}
73 void warning(QString const &, QString const &) {}
74 void toggleWarning(QString const &, QString const &, QString const &) {}
75 void error(QString const &, QString const &, QString const &) {}
76 void information(QString const &, QString const &) {}
77 int prompt(docstring const &, docstring const &, int default_but, int,
78 docstring const &, docstring const &) { return default_but; }
82 static ProgressInterface * progress_instance = 0;
84 void ProgressInterface::setInstance(ProgressInterface* p)
86 progress_instance = p;
90 ProgressInterface * ProgressInterface::instance()
92 if (!progress_instance) {
93 static ProgressDummy dummy;
96 return progress_instance;
104 int Systemcall::startscript(Starttype how, string const & what,
105 string const & path, string const & lpath,
106 bool /*process_events*/)
109 to_filesystem8bit(from_utf8(latexEnvCmdPrefix(path, lpath)))
112 if (how == DontWait) {
113 switch (os::shell()) {
118 command = "start /min " + command;
121 } else if (os::shell() == os::CMD_EXE)
122 command = subst(command, "cmd /d /c ", "");
124 return ::system(command.c_str());
132 * This is a parser that (mostly) mimics the behavior of a posix shell as
133 * regards quoting, but its output is tailored for being processed by QProcess.
134 * Note that shell metacharacters are not parsed.
136 * The escape character is the backslash.
137 * A backslash that is not quoted preserves the literal value of the following
138 * character, with the exception of a double-quote '"'. If a double-quote
139 * follows a backslash, it will be replaced by three consecutive double-quotes
140 * (this is how the QProcess parser recognizes a '"' as a simple character
141 * instead of a quoting character). Thus, for example:
147 * Characters enclosed in single-quotes ('') have their literal value preserved.
148 * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
149 * be used to escape a single-quote in a single-quoted string. In other words,
150 * anything enclosed in single-quotes is passed as is, but the single-quotes
151 * themselves are eliminated. Thus, for example:
158 * Characters enclosed in double-quotes ("") have their literal value preserved,
159 * with the exception of the backslash. The backslash retains its special
160 * meaning as an escape character only when followed by a double-quote.
161 * Contrarily to the behavior of a posix shell, the double-quotes themselves
162 * are *not* eliminated. Thus, for example:
167 string const parsecmd(string const & incmd, string & infile, string & outfile,
170 bool in_single_quote = false;
171 bool in_double_quote = false;
172 bool escaped = false;
173 string const python_call = "python -tt";
174 vector<string> outcmd(4);
177 if (prefixIs(incmd, python_call)) {
178 outcmd[0] = os::python();
179 start = python_call.length();
182 for (size_t i = start, o = 0; i < incmd.length(); ++i) {
185 if (in_double_quote || escaped) {
186 if (in_double_quote && escaped)
190 in_single_quote = !in_single_quote;
194 if (in_single_quote) {
200 // Don't triple double-quotes for redirection
201 // files as these won't be parsed by QProcess
202 outcmd[o] += string(o ? "\"" : "\"\"\"");
206 in_double_quote = !in_double_quote;
208 } else if (c == '\\' && !escaped) {
210 } else if (c == '>' && !(in_double_quote || escaped)) {
211 if (suffixIs(outcmd[o], " 2")) {
212 outcmd[o] = rtrim(outcmd[o], "2");
215 if (suffixIs(outcmd[o], " 1"))
216 outcmd[o] = rtrim(outcmd[o], "1");
219 } else if (c == '<' && !(in_double_quote || escaped)) {
222 if (escaped && in_double_quote)
228 infile = trim(outcmd[3], " \"");
229 outfile = trim(outcmd[1], " \"");
230 errfile = trim(outcmd[2], " \"");
231 return trim(outcmd[0]);
238 int Systemcall::startscript(Starttype how, string const & what,
239 string const & path, string const & lpath,
242 string const what_ss = commandPrep(what);
244 lyxerr << "\nRunning: " << what_ss << endl;
246 LYXERR(Debug::INFO,"Running: " << what_ss);
251 QString const cmd = QString::fromLocal8Bit(
252 parsecmd(what_ss, infile, outfile, errfile).c_str());
254 SystemcallPrivate d(infile, outfile, errfile);
257 // QProcess::startDetached cannot provide environment variables. When the
258 // environment variables are set using the latexEnvCmdPrefix and the process
259 // is started with QProcess::startDetached, a console window is shown every
260 // time a viewer is started. To avoid this, we fall back on Windows to the
261 // original implementation that creates a QProcess object.
262 d.startProcess(cmd, path, lpath, false);
263 if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
264 LYXERR0("Systemcall: '" << cmd << "' did not start!");
265 LYXERR0("error " << d.errorMessage());
268 if (how == DontWait) {
273 d.startProcess(cmd, path, lpath, how == DontWait);
274 if (how == DontWait && d.state == SystemcallPrivate::Running)
277 if (d.state == SystemcallPrivate::Error
278 || !d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
279 LYXERR0("Systemcall: '" << cmd << "' did not start!");
280 LYXERR0("error " << d.errorMessage());
285 if (!d.waitWhile(SystemcallPrivate::Running, process_events,
286 os::timeout_min() * 60 * 1000)) {
287 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
288 LYXERR0("error " << d.errorMessage());
289 LYXERR0("status " << d.exitStatusMessage());
293 int const exit_code = d.exitCode();
295 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
302 SystemcallPrivate::SystemcallPrivate(std::string const & sf, std::string const & of,
303 std::string const & ef)
304 : state(Error), process_(new QProcess), out_index_(0), err_index_(0),
305 in_file_(sf), out_file_(of), err_file_(ef), process_events_(false)
307 if (!in_file_.empty())
308 process_->setStandardInputFile(QString::fromLocal8Bit(in_file_.c_str()));
309 if (!out_file_.empty()) {
310 if (out_file_[0] == '&') {
311 if (subst(out_file_, " ", "") == "&2"
312 && err_file_[0] != '&') {
313 out_file_ = err_file_;
314 process_->setProcessChannelMode(
315 QProcess::MergedChannels);
317 if (err_file_[0] == '&') {
318 // Leave alone things such as
319 // "1>&2 2>&1". Should not be harmful,
320 // but let's give anyway a warning.
321 LYXERR0("Unsupported stdout/stderr redirect.");
324 LYXERR0("Ambiguous stdout redirect: "
327 out_file_ = os::nulldev();
330 // Check whether we have to set the output file.
331 if (out_file_ != os::nulldev()) {
332 process_->setStandardOutputFile(QString::fromLocal8Bit(
336 if (!err_file_.empty()) {
337 if (err_file_[0] == '&') {
338 if (subst(err_file_, " ", "") == "&1"
339 && out_file_[0] != '&') {
340 process_->setProcessChannelMode(
341 QProcess::MergedChannels);
343 LYXERR0("Ambiguous stderr redirect: "
346 // In MergedChannels mode stderr goes to stdout.
347 err_file_ = os::nulldev();
349 // Check whether we have to set the error file.
350 if (err_file_ != os::nulldev()) {
351 process_->setStandardErrorFile(QString::fromLocal8Bit(
356 connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
357 connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
358 #if QT_VERSION >= 0x050600
359 connect(process_, SIGNAL(errorOccurred(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
361 connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
363 connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
364 connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
368 void SystemcallPrivate::startProcess(QString const & cmd, string const & path,
369 string const & lpath, bool detached)
373 state = SystemcallPrivate::Running;
374 if (!QProcess::startDetached(toqstr(latexEnvCmdPrefix(path, lpath)) + cmd_)) {
375 state = SystemcallPrivate::Error;
378 QProcess* released = releaseProcess();
380 } else if (process_) {
381 state = SystemcallPrivate::Starting;
382 process_->start(toqstr(latexEnvCmdPrefix(path, lpath)) + 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 occurred.";
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()
616 // From Qt's documentation, in regards to QProcess::exitCode(),
617 // "This value is not valid unless exitStatus() returns NormalExit"
618 if (!process_ || process_->exitStatus() != QProcess::NormalExit)
621 return process_->exitCode();
625 QProcess* SystemcallPrivate::releaseProcess()
627 QProcess* released = process_;
633 void SystemcallPrivate::killProcess()
635 killProcess(process_);
639 void SystemcallPrivate::killProcess(QProcess * p)
643 p->closeReadChannel(QProcess::StandardOutput);
644 p->closeReadChannel(QProcess::StandardError);
652 #include "moc_SystemcallPrivate.cpp"
655 } // namespace support