X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2FSystemcall.cpp;h=69692aaa529f7e62fe31b794532f427c368084d3;hb=11020c50f1e8bd71e7546c82d9ef7b2ec8ff4afb;hp=058de000d895152f8e545eb630cfe0cbe0404d2a;hpb=a5a05e7dfc7446548b573f0b439606fc865708f9;p=lyx.git diff --git a/src/support/Systemcall.cpp b/src/support/Systemcall.cpp index 058de000d8..69692aaa52 100644 --- a/src/support/Systemcall.cpp +++ b/src/support/Systemcall.cpp @@ -4,9 +4,9 @@ * Licence details can be found in the file COPYING. * * \author Asger Alstrup - * - * Interface cleaned up by * \author Angus Leeming + * \author Enrico Forestieri + * \author Peter Kuemmel * * Full author contact details are available in file CREDITS. */ @@ -17,28 +17,37 @@ #include "support/lstrings.h" #include "support/qstring_helpers.h" #include "support/Systemcall.h" +#include "support/SystemcallPrivate.h" #include "support/os.h" + #include #include #include +#include +#include +#include +#include #define USE_QPROCESS + +struct Sleep : QThread +{ + static void millisec(unsigned long ms) + { + QThread::usleep(ms * 1000); + } +}; + + + using namespace std; namespace lyx { namespace support { -static void killProcess(QProcess * p) -{ - p->disconnect(); - p->closeReadChannel(QProcess::StandardOutput); - p->closeReadChannel(QProcess::StandardError); - p->close(); - delete p; -} // Reuse of instance @@ -89,75 +98,130 @@ string const parsecmd(string const & cmd, string & outfile) } // namespace anon -int Systemcall::startscript(Starttype how, string const & what) + +int Systemcall::startscript(Starttype how, string const & what, bool process_events) { string outfile; QString cmd = toqstr(parsecmd(what, outfile)); - QProcess * process = new QProcess; - ConOut console(process); - if (!outfile.empty()) { - // Check whether we have to simply throw away the output. - if (outfile != os::nulldev()) - process->setStandardOutputFile(toqstr(outfile)); - } else if (os::is_terminal(os::STDOUT)) - console.showout(); - if (os::is_terminal(os::STDERR)) - console.showerr(); - - process->start(cmd); - if (!process->waitForStarted(3000)) { - LYXERR0("Qprocess " << cmd << " did not start!"); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); + SystemcallPrivate d(outfile); + + + d.startProcess(cmd); + if (!d.waitWhile(SystemcallPrivate::Starting, process_events, 3000)) { + LYXERR0("QProcess " << cmd << " did not start!"); + LYXERR0("error " << d.errorMessage()); return 10; } + if (how == DontWait) { - // TODO delete process later + QProcess* released = d.releaseProcess(); + (void) released; // TODO who deletes it? return 0; } - if (!process->waitForFinished(180000)) { - LYXERR0("Qprocess " << cmd << " did not finished!"); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); + if (!d.waitWhile(SystemcallPrivate::Running, process_events, 180000)) { + LYXERR0("QProcess " << cmd << " did not finished!"); + LYXERR0("error " << d.errorMessage()); + LYXERR0("status " << d.exitStatusMessage()); return 20; } - int const exit_code = process->exitCode(); + + int const exit_code = d.exitCode(); if (exit_code) { - LYXERR0("Qprocess " << cmd << " finished!"); - LYXERR0("exitCode " << process->exitCode()); - LYXERR0("error " << process->error()); - LYXERR0("state " << process->state()); - LYXERR0("status " << process->exitStatus()); - } - - // If the output has been redirected, we write it all at once. - // Even if we are not running in a terminal, the output could go - // to some log file, for example ~/.xsession-errors on *nix. - if (!os::is_terminal(os::STDOUT) && outfile.empty()) - cout << fromqstr(QString::fromLocal8Bit( - process->readAllStandardOutput().data())); - if (!os::is_terminal(os::STDERR)) - cerr << fromqstr(QString::fromLocal8Bit( - process->readAllStandardError().data())); - - killProcess(process); + LYXERR0("QProcess " << cmd << " finished!"); + LYXERR0("error " << exit_code << ": " << d.errorMessage()); + } + return exit_code; } -ConOut::ConOut(QProcess * proc) : proc_(proc), outindex_(0), errindex_(0), - showout_(false), showerr_(false) +SystemcallPrivate::SystemcallPrivate(const std::string& of) : + proc_(new QProcess), outindex_(0), errindex_(0), + outfile(of), showout_(false), showerr_(false), process_events(false) +{ + if (!outfile.empty()) { + // Check whether we have to simply throw away the output. + if (outfile != os::nulldev()) + proc_->setStandardOutputFile(toqstr(outfile)); + } else if (os::is_terminal(os::STDOUT)) + showout(); + if (os::is_terminal(os::STDERR)) + showerr(); + + connect(proc_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut())); + connect(proc_, SIGNAL(readyReadStandardError()), SLOT(stdErr())); + connect(proc_, SIGNAL(error(QProcess::ProcessError)), SLOT(processError(QProcess::ProcessError))); + connect(proc_, SIGNAL(started()), this, SLOT(processStarted())); + connect(proc_, SIGNAL(finished(int, QProcess::ExitStatus)), SLOT(processFinished(int, QProcess::ExitStatus))); +} + + + +void SystemcallPrivate::startProcess(const QString& cmd) +{ + if (proc_) { + state = SystemcallPrivate::Starting; + proc_->start(cmd); + } +} + + +void SystemcallPrivate::processEvents() +{ + if(process_events) { + //static int count = 0; qDebug() << count++ << ": waitAndProcessEvents"; + QCoreApplication::processEvents(QEventLoop::AllEvents); + } +} + + +void SystemcallPrivate::waitAndProcessEvents() { - connect(proc, SIGNAL(readyReadStandardOutput()), SLOT(stdOut())); - connect(proc, SIGNAL(readyReadStandardError()), SLOT(stdErr())); + Sleep::millisec(100); + processEvents(); +} + + +bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout) +{ + if (!proc_) + return false; + + process_events = proc_events; + + // Block GUI while waiting, + // relay on QProcess' wait functions + if (!process_events) { + if (waitwhile == Starting) + return proc_->waitForStarted(timeout); + if (waitwhile == Running) + return proc_->waitForFinished(timeout); + return false; + } + + // process events while waiting, no timeout + if (timeout == -1) { + while (state == waitwhile && state != Error) { + waitAndProcessEvents(); + } + return state != Error; + } + + // process events while waiting whith timeout + QTime timer; + timer.start(); + while (state == waitwhile && state != Error && timer.elapsed() < timeout) { + waitAndProcessEvents(); + } + return (state != Error) && (timer.elapsed() < timeout); } -ConOut::~ConOut() +SystemcallPrivate::~SystemcallPrivate() { + flush(); + if (outindex_) { outdata_[outindex_] = '\0'; outindex_ = 0; @@ -170,12 +234,30 @@ ConOut::~ConOut() cerr << errdata_; } cerr.flush(); + + killProcess(); } -void ConOut::stdOut() +void SystemcallPrivate::flush() { - if (showout_) { + if (proc_) { + // If the output has been redirected, we write it all at once. + // Even if we are not running in a terminal, the output could go + // to some log file, for example ~/.xsession-errors on *nix. + if (!os::is_terminal(os::STDOUT) && outfile.empty()) + cout << fromqstr(QString::fromLocal8Bit( + proc_->readAllStandardOutput().data())); + if (!os::is_terminal(os::STDERR)) + cerr << fromqstr(QString::fromLocal8Bit( + proc_->readAllStandardError().data())); + } +} + + +void SystemcallPrivate::stdOut() +{ + if (proc_ && showout_) { char c; proc_->setReadChannel(QProcess::StandardOutput); while (proc_->getChar(&c)) { @@ -187,12 +269,13 @@ void ConOut::stdOut() } } } + processEvents(); } -void ConOut::stdErr() +void SystemcallPrivate::stdErr() { - if (showerr_) { + if (proc_ && showerr_) { char c; proc_->setReadChannel(QProcess::StandardError); while (proc_->getChar(&c)) { @@ -204,9 +287,122 @@ void ConOut::stdErr() } } } + processEvents(); +} + + +void SystemcallPrivate::processStarted() +{ + state = Running; + // why do we get two started signals? + //disconnect(proc_, SIGNAL(started()), this, SLOT(processStarted())); +} + + +void SystemcallPrivate::processFinished(int, QProcess::ExitStatus) +{ + state = Finished; +} + + +void SystemcallPrivate::processError(QProcess::ProcessError) +{ + state = Error; +} + + +QString SystemcallPrivate::errorMessage() const +{ + if (!proc_) + return "No QProcess available"; + + QString message; + switch (proc_->error()) { + case QProcess::FailedToStart: + message = "The process failed to start. Either the invoked program is missing, " + "or you may have insufficient permissions to invoke the program."; + break; + case QProcess::Crashed: + message = "The process crashed some time after starting successfully."; + break; + case QProcess::Timedout: + message = "The process timed out. It might be restarted automatically."; + break; + case QProcess::WriteError: + message = "An error occurred when attempting to write to the process-> For example, " + "the process may not be running, or it may have closed its input channel."; + break; + case QProcess::ReadError: + message = "An error occurred when attempting to read from the process-> For example, " + "the process may not be running."; + break; + case QProcess::UnknownError: + default: + message = "An unknown error occured."; + break; + } + return message; } -#include "moc_Systemcall.cpp" + +QString SystemcallPrivate::exitStatusMessage() const +{ + if (!proc_) + return "No QProcess available"; + + QString message; + switch (proc_->exitStatus()) { + case QProcess::NormalExit: + message = "The process exited normally."; + break; + case QProcess::CrashExit: + message = "The process crashed."; + break; + default: + message = "Unknown exit state."; + break; + } + return message; +} + + +int SystemcallPrivate::exitCode() +{ + if (!proc_) + return -1; + + return proc_->exitCode(); +} + + +QProcess* SystemcallPrivate::releaseProcess() +{ + QProcess* released = proc_; + proc_ = 0; + return released; +} + + +void SystemcallPrivate::killProcess() +{ + killProcess(proc_); +} + + +void SystemcallPrivate::killProcess(QProcess * p) +{ + if (p) { + p->disconnect(); + p->closeReadChannel(QProcess::StandardOutput); + p->closeReadChannel(QProcess::StandardError); + p->close(); + delete p; + } +} + + + +#include "moc_SystemcallPrivate.cpp" #endif } // namespace support