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/lstrings.h"
18 #include "support/qstring_helpers.h"
19 #include "support/Systemcall.h"
20 #include "support/SystemcallPrivate.h"
21 #include "support/os.h"
30 #include <QCoreApplication>
36 struct Sleep : QThread
38 static void millisec(unsigned long ms)
40 QThread::usleep(ms * 1000);
55 int Systemcall::startscript(Starttype how, string const & what)
57 string command = what;
59 if (how == DontWait) {
60 switch (os::shell()) {
65 command = "start /min " + command;
70 return ::system(command.c_str());
77 string const parsecmd(string const & cmd, string & outfile)
82 for (size_t i = 0; i < cmd.length(); ++i) {
84 if (c == '"' && !escaped)
86 else if (c == '\\' && !escaped)
88 else if (c == '>' && !(inquote || escaped)) {
89 outfile = trim(cmd.substr(i + 1), " \"");
90 return trim(cmd.substr(0, i));
102 int Systemcall::startscript(Starttype how, string const & what, bool process_events)
105 QString cmd = toqstr(parsecmd(what, outfile));
106 SystemcallPrivate d(outfile);
110 if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
111 LYXERR0("QProcess " << cmd << " did not start!");
112 LYXERR0("error " << d.errorMessage());
116 if (how == DontWait) {
117 QProcess* released = d.releaseProcess();
118 (void) released; // TODO who deletes it?
122 if (!d.waitWhile(SystemcallPrivate::Running, process_events, 180000)) {
123 LYXERR0("QProcess " << cmd << " did not finished!");
124 LYXERR0("error " << d.errorMessage());
125 LYXERR0("status " << d.exitStatusMessage());
129 int const exit_code = d.exitCode();
131 LYXERR0("QProcess cmd: ' " << cmd << "' finished with exit code " << exit_code);
138 SystemcallPrivate::SystemcallPrivate(const std::string& of) :
139 proc_(new QProcess), outindex_(0), errindex_(0),
140 outfile(of), showout_(false), showerr_(false), process_events(false)
142 if (!outfile.empty()) {
143 // Check whether we have to simply throw away the output.
144 if (outfile != os::nulldev())
145 proc_->setStandardOutputFile(toqstr(outfile));
146 } else if (os::is_terminal(os::STDOUT))
148 if (os::is_terminal(os::STDERR))
151 connect(proc_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
152 connect(proc_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
153 connect(proc_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError)));
154 connect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
155 connect(proc_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus)));
160 void SystemcallPrivate::startProcess(const QString& cmd)
163 state = SystemcallPrivate::Starting;
169 void SystemcallPrivate::processEvents()
172 //static int count = 0; qDebug() << count++ << ": waitAndProcessEvents";
173 QCoreApplication::processEvents(QEventLoop::AllEvents);
178 void SystemcallPrivate::waitAndProcessEvents()
180 Sleep::millisec(100);
185 bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout)
190 process_events = proc_events;
192 // Block GUI while waiting,
193 // relay on QProcess' wait functions
194 if (!process_events) {
195 if (waitwhile == Starting)
196 return proc_->waitForStarted(timeout);
197 if (waitwhile == Running)
198 return proc_->waitForFinished(timeout);
202 // process events while waiting, no timeout
204 while (state == waitwhile && state != Error) {
205 waitAndProcessEvents();
207 return state != Error;
210 // process events while waiting whith timeout
213 while (state == waitwhile && state != Error && timer.elapsed() < timeout) {
214 waitAndProcessEvents();
216 return (state != Error) && (timer.elapsed() < timeout);
220 SystemcallPrivate::~SystemcallPrivate()
225 outdata_[outindex_] = '\0';
231 errdata_[errindex_] = '\0';
241 void SystemcallPrivate::flush()
244 // If the output has been redirected, we write it all at once.
245 // Even if we are not running in a terminal, the output could go
246 // to some log file, for example ~/.xsession-errors on *nix.
247 if (!os::is_terminal(os::STDOUT) && outfile.empty())
248 cout << fromqstr(QString::fromLocal8Bit(
249 proc_->readAllStandardOutput().data()));
250 if (!os::is_terminal(os::STDERR))
251 cerr << fromqstr(QString::fromLocal8Bit(
252 proc_->readAllStandardError().data()));
257 void SystemcallPrivate::stdOut()
259 if (proc_ && showout_) {
261 proc_->setReadChannel(QProcess::StandardOutput);
262 while (proc_->getChar(&c)) {
263 outdata_[outindex_++] = c;
264 if (c == '\n' || outindex_ + 1 == bufsize_) {
265 outdata_[outindex_] = '\0';
275 void SystemcallPrivate::stdErr()
277 if (proc_ && showerr_) {
279 proc_->setReadChannel(QProcess::StandardError);
280 while (proc_->getChar(&c)) {
281 errdata_[errindex_++] = c;
282 if (c == '\n' || errindex_ + 1 == bufsize_) {
283 errdata_[errindex_] = '\0';
293 void SystemcallPrivate::processStarted()
296 // why do we get two started signals?
297 //disconnect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
301 void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
307 void SystemcallPrivate::processError(QProcess::ProcessError)
313 QString SystemcallPrivate::errorMessage() const
316 return "No QProcess available";
319 switch (proc_->error()) {
320 case QProcess::FailedToStart:
321 message = "The process failed to start. Either the invoked program is missing, "
322 "or you may have insufficient permissions to invoke the program.";
324 case QProcess::Crashed:
325 message = "The process crashed some time after starting successfully.";
327 case QProcess::Timedout:
328 message = "The process timed out. It might be restarted automatically.";
330 case QProcess::WriteError:
331 message = "An error occurred when attempting to write to the process-> For example, "
332 "the process may not be running, or it may have closed its input channel.";
334 case QProcess::ReadError:
335 message = "An error occurred when attempting to read from the process-> For example, "
336 "the process may not be running.";
338 case QProcess::UnknownError:
340 message = "An unknown error occured.";
347 QString SystemcallPrivate::exitStatusMessage() const
350 return "No QProcess available";
353 switch (proc_->exitStatus()) {
354 case QProcess::NormalExit:
355 message = "The process exited normally.";
357 case QProcess::CrashExit:
358 message = "The process crashed.";
361 message = "Unknown exit state.";
368 int SystemcallPrivate::exitCode()
373 return proc_->exitCode();
377 QProcess* SystemcallPrivate::releaseProcess()
379 QProcess* released = proc_;
385 void SystemcallPrivate::killProcess()
391 void SystemcallPrivate::killProcess(QProcess * p)
395 p->closeReadChannel(QProcess::StandardOutput);
396 p->closeReadChannel(QProcess::StandardError);
404 #include "moc_SystemcallPrivate.cpp"
407 } // namespace support