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/environment.h"
18 #include "support/filetools.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 &) {}
79 static ProgressInterface* progress_instance = 0;
81 void ProgressInterface::setInstance(ProgressInterface* p)
83 progress_instance = p;
87 ProgressInterface* ProgressInterface::instance()
89 if (!progress_instance) {
90 static ProgressDummy dummy;
93 return progress_instance;
101 int Systemcall::startscript(Starttype how, string const & what,
102 std::string const & path, bool /*process_events*/)
105 string const texinputs = os::latex_path_list(
106 replaceCurdirPath(path, lyxrc.texinputs_prefix));
107 string const sep = string(1, os::path_separator(os::TEXENGINE));
108 string const env = getEnv("TEXINPUTS");
110 switch (os::shell()) {
112 command = path.empty() || lyxrc.texinputs_prefix.empty() ? what
113 : "env TEXINPUTS='." + sep + texinputs
114 + sep + env + "' " + what;
117 command = path.empty() || lyxrc.texinputs_prefix.empty() ? what
118 : "set TEXINPUTS=." + sep + texinputs
119 + sep + env + " & " + what;
123 if (how == DontWait) {
124 switch (os::shell()) {
129 command = "start /min " + command;
134 return ::system(command.c_str());
142 * This is a parser that (mostly) mimics the behavior of a posix shell but
143 * its output is tailored for being processed by QProcess.
145 * The escape character is the backslash.
146 * A backslash that is not quoted preserves the literal value of the following
147 * character, with the exception of a double-quote '"'. If a double-quote
148 * follows a backslash, it will be replaced by three consecutive double-quotes
149 * (this is how the QProcess parser recognizes a '"' as a simple character
150 * instead of a quoting character). Thus, for example:
156 * Characters enclosed in single-quotes ('') have their literal value preserved.
157 * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
158 * be used to escape a single-quote in a single-quoted string. In other words,
159 * anything enclosed in single-quotes is passed as is, but the single-quotes
160 * themselves are eliminated. Thus, for example:
167 * Characters enclosed in double-quotes ("") have their literal value preserved,
168 * with the exception of the backslash. The backslash retains its special
169 * meaning as an escape character only when followed by a double-quote.
170 * Contrarily to the behavior of a posix shell, the double-quotes themselves
171 * are *not* eliminated. Thus, for example:
176 string const parsecmd(string const & inputcmd, string & outfile)
178 bool in_single_quote = false;
179 bool in_double_quote = false;
180 bool escaped = false;
183 for (size_t i = 0; i < inputcmd.length(); ++i) {
184 char c = inputcmd[i];
186 if (in_double_quote || escaped) {
187 if (in_double_quote && escaped)
191 in_single_quote = !in_single_quote;
195 if (in_single_quote) {
205 in_double_quote = !in_double_quote;
207 } else if (c == '\\' && !escaped) {
209 } else if (c == '>' && !(in_double_quote || escaped)) {
210 outfile = trim(inputcmd.substr(i + 1), " \"");
213 if (escaped && in_double_quote)
227 int Systemcall::startscript(Starttype how, string const & what,
228 string const & path, bool process_events)
231 QString cmd = toqstr(parsecmd(what, outfile));
233 SystemcallPrivate d(outfile);
236 d.startProcess(cmd, path);
237 if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
238 LYXERR0("Systemcall: '" << cmd << "' did not start!");
239 LYXERR0("error " << d.errorMessage());
243 if (how == DontWait) {
244 QProcess* released = d.releaseProcess();
245 (void) released; // TODO who deletes it?
249 if (!d.waitWhile(SystemcallPrivate::Running, process_events,
250 os::timeout_min() * 60 * 1000)) {
251 LYXERR0("Systemcall: '" << cmd << "' did not finish!");
252 LYXERR0("error " << d.errorMessage());
253 LYXERR0("status " << d.exitStatusMessage());
257 int const exit_code = d.exitCode();
259 LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
266 SystemcallPrivate::SystemcallPrivate(const std::string& of) :
267 process_(new QProcess),
271 texinputs_(getEnv("TEXINPUTS")),
272 process_events_(false)
274 if (!out_file_.empty()) {
275 // Check whether we have to simply throw away the output.
276 if (out_file_ != os::nulldev())
277 process_->setStandardOutputFile(toqstr(out_file_));
280 connect(process_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
281 connect(process_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
282 connect(process_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
283 connect(process_, SIGNAL(started()), this, SLOT(processStarted()));
284 connect(process_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
289 void SystemcallPrivate::startProcess(QString const & cmd, string const & path)
293 if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
294 string const texinputs = os::latex_path_list(
295 replaceCurdirPath(path, lyxrc.texinputs_prefix));
296 string const sep = string(1,
297 os::path_separator(os::TEXENGINE));
298 string const prefix = "." + sep + texinputs + sep;
299 if (prefixIs(texinputs_, prefix))
302 setEnv("TEXINPUTS", prefix + texinputs_);
304 state = SystemcallPrivate::Starting;
305 if (os::shell() == os::CMD_EXE)
306 process_->start(QLatin1String("cmd /d /c ") + cmd_);
308 process_->start(cmd_);
313 void SystemcallPrivate::processEvents()
315 if(process_events_) {
316 QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
321 void SystemcallPrivate::waitAndProcessEvents()
323 Sleep::millisec(100);
328 bool SystemcallPrivate::waitWhile(State waitwhile, bool process_events, int timeout)
333 process_events_ = process_events;
335 // Block GUI while waiting,
336 // relay on QProcess' wait functions
337 if (!process_events_) {
338 if (waitwhile == Starting)
339 return process_->waitForStarted(timeout);
340 if (waitwhile == Running)
341 return process_->waitForFinished(timeout);
345 // process events while waiting, no timeout
347 while (state == waitwhile && state != Error) {
348 waitAndProcessEvents();
350 return state != Error;
353 // process events while waiting whith timeout
356 while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
357 waitAndProcessEvents();
359 return (state != Error) && (timer.elapsed() < timeout);
363 SystemcallPrivate::~SystemcallPrivate()
365 if (!texinputs_.empty())
366 setEnv("TEXINPUTS", texinputs_);
369 out_data_[out_index_] = '\0';
375 err_data_[err_index_] = '\0';
385 void SystemcallPrivate::stdOut()
389 process_->setReadChannel(QProcess::StandardOutput);
390 while (process_->getChar(&c)) {
391 out_data_[out_index_++] = c;
392 if (c == '\n' || out_index_ + 1 == buffer_size_) {
393 out_data_[out_index_] = '\0';
395 ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(out_data_));
403 void SystemcallPrivate::stdErr()
407 process_->setReadChannel(QProcess::StandardError);
408 while (process_->getChar(&c)) {
409 err_data_[err_index_++] = c;
410 if (c == '\n' || err_index_ + 1 == buffer_size_) {
411 err_data_[err_index_] = '\0';
413 ProgressInterface::instance()->appendError(QString::fromLocal8Bit(err_data_));
421 void SystemcallPrivate::processStarted()
423 if (state != Running) {
425 ProgressInterface::instance()->processStarted(cmd_);
430 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
432 if (state != Finished) {
434 ProgressInterface::instance()->processFinished(cmd_);
439 void SystemcallPrivate::processError(QProcess::ProcessError)
442 ProgressInterface::instance()->appendError(errorMessage());
446 QString SystemcallPrivate::errorMessage() const
449 return "No QProcess available";
452 switch (process_->error()) {
453 case QProcess::FailedToStart:
454 message = "The process failed to start. Either the invoked program is missing, "
455 "or you may have insufficient permissions to invoke the program.";
457 case QProcess::Crashed:
458 message = "The process crashed some time after starting successfully.";
460 case QProcess::Timedout:
461 message = "The process timed out. It might be restarted automatically.";
463 case QProcess::WriteError:
464 message = "An error occurred when attempting to write to the process-> For example, "
465 "the process may not be running, or it may have closed its input channel.";
467 case QProcess::ReadError:
468 message = "An error occurred when attempting to read from the process-> For example, "
469 "the process may not be running.";
471 case QProcess::UnknownError:
473 message = "An unknown error occured.";
480 QString SystemcallPrivate::exitStatusMessage() const
483 return "No QProcess available";
486 switch (process_->exitStatus()) {
487 case QProcess::NormalExit:
488 message = "The process exited normally.";
490 case QProcess::CrashExit:
491 message = "The process crashed.";
494 message = "Unknown exit state.";
501 int SystemcallPrivate::exitCode()
506 return process_->exitCode();
510 QProcess* SystemcallPrivate::releaseProcess()
512 QProcess* released = process_;
518 void SystemcallPrivate::killProcess()
520 killProcess(process_);
524 void SystemcallPrivate::killProcess(QProcess * p)
528 p->closeReadChannel(QProcess::StandardOutput);
529 p->closeReadChannel(QProcess::StandardError);
537 #include "moc_SystemcallPrivate.cpp"
540 } // namespace support