]> git.lyx.org Git - lyx.git/blobdiff - src/support/Systemcall.cpp
TR1: check in cmake for GCC version, fallback in checktr1.h for other build systems...
[lyx.git] / src / support / Systemcall.cpp
index d4a3b514fbe84de697e4a213970e97384ed79a6a..98d8d125dea618b29523f795670bb042f8b410d3 100644 (file)
@@ -19,6 +19,7 @@
 #include "support/Systemcall.h"
 #include "support/SystemcallPrivate.h"
 #include "support/os.h"
+#include "support/ProgressInterface.h"
 
 
 #include <cstdlib>
@@ -43,16 +44,59 @@ struct Sleep : QThread
 
 
 
+
 using namespace std;
 
 namespace lyx {
 namespace support {
 
 
+class ProgressDummy : public ProgressInterface 
+{
+public:
+       ProgressDummy() {}
+
+       void processStarted(QString const &) {}
+       void processFinished(QString const &) {}
+       void appendMessage(QString const &) {}
+       void appendError(QString const &) {}
+       void clearMessages() {}
+       void lyxerrFlush() {}
+
+       void lyxerrConnect() {}
+       void lyxerrDisconnect() {}
+
+       void warning(QString const &, QString const &) {}
+       void toggleWarning(QString const &, QString const &, QString const &) {}
+       void error(QString const &, QString const &) {}
+       void information(QString const &, QString const &) {}
+};
+
+
+static ProgressInterface* progress_instance = 0;
+
+void ProgressInterface::setInstance(ProgressInterface* p)
+{
+       progress_instance = p;
+}
+
+
+ProgressInterface* ProgressInterface::instance()
+{
+       if (!progress_instance) {
+               static ProgressDummy dummy;
+               return &dummy;
+       }
+       return progress_instance;
+}
+
+
+
 
 // Reuse of instance
 #ifndef USE_QPROCESS
-int Systemcall::startscript(Starttype how, string const & what)
+int Systemcall::startscript(Starttype how, string const & what,
+                                                       bool /*process_events*/)
 {
        string command = what;
 
@@ -74,22 +118,83 @@ int Systemcall::startscript(Starttype how, string const & what)
 
 namespace {
 
-string const parsecmd(string const & cmd, string & outfile)
+/*
+ * This is a parser that (mostly) mimics the behavior of a posix shell but
+ * its output is tailored for being processed by QProcess.
+ *
+ * The escape character is the backslash.
+ * A backslash that is not quoted preserves the literal value of the following
+ * character, with the exception of a double-quote '"'. If a double-quote
+ * follows a backslash, it will be replaced by three consecutive double-quotes
+ * (this is how the QProcess parser recognizes a '"' as a simple character
+ * instead of a quoting character). Thus, for example:
+ *     \\  ->  \
+ *     \a  ->  a
+ *     \"  ->  """
+ *
+ * Single-quotes.
+ * Characters enclosed in single-quotes ('') have their literal value preserved.
+ * A single-quote cannot occur within single-quotes. Indeed, a backslash cannot
+ * be used to escape a single-quote in a single-quoted string. In other words,
+ * anything enclosed in single-quotes is passed as is, but the single-quotes
+ * themselves are eliminated. Thus, for example:
+ *    '\'    ->  \
+ *    '\\'   ->  \\
+ *    '\a'   ->  \a
+ *    'a\"b' ->  a\"b
+ *
+ * Double-quotes.
+ * Characters enclosed in double-quotes ("") have their literal value preserved,
+ * with the exception of the backslash. The backslash retains its special
+ * meaning as an escape character only when followed by a double-quote.
+ * Contrarily to the behavior of a posix shell, the double-quotes themselves
+ * are *not* eliminated. Thus, for example:
+ *    "\\"   ->  "\\"
+ *    "\a"   ->  "\a"
+ *    "a\"b" ->  "a"""b"
+ */
+string const parsecmd(string const & inputcmd, string & outfile)
 {
-       bool inquote = false;
+       bool in_single_quote = false;
+       bool in_double_quote = false;
        bool escaped = false;
-
-       for (size_t i = 0; i < cmd.length(); ++i) {
-               char c = cmd[i];
-               if (c == '"' && !escaped)
-                       inquote = !inquote;
-               else if (c == '\\' && !escaped)
+       string cmd;
+
+       for (size_t i = 0; i < inputcmd.length(); ++i) {
+               char c = inputcmd[i];
+               if (c == '\'') {
+                       if (in_double_quote || escaped) {
+                               if (in_double_quote && escaped)
+                                       cmd += '\\';
+                               cmd += c;
+                       } else
+                               in_single_quote = !in_single_quote;
+                       escaped = false;
+                       continue;
+               }
+               if (in_single_quote) {
+                       cmd += c;
+                       continue;
+               }
+               if (c == '"') {
+                       if (escaped) {
+                               cmd += "\"\"\"";
+                               escaped = false;
+                       } else {
+                               cmd += c;
+                               in_double_quote = !in_double_quote;
+                       }
+               } else if (c == '\\' && !escaped) {
                        escaped = !escaped;
-               else if (c == '>' && !(inquote || escaped)) {
-                       outfile = trim(cmd.substr(i + 1), " \"");
-                       return trim(cmd.substr(0, i));
-               } else
+               } else if (c == '>' && !(in_double_quote || escaped)) {
+                       outfile = trim(inputcmd.substr(i + 1), " \"");
+                       return trim(cmd);
+               } else {
+                       if (escaped && in_double_quote)
+                               cmd += '\\';
+                       cmd += c;
                        escaped = false;
+               }
        }
        outfile.erase();
        return cmd;
@@ -99,17 +204,17 @@ string const parsecmd(string const & cmd, string & outfile)
 
 
 
-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));
+
        SystemcallPrivate d(outfile);
 
-       bool process_events = true;
 
        d.startProcess(cmd);
-       if (!d.waitWhile(SystemcallPrivate::Starting, process_events, 3000)) {
-               LYXERR0("QProcess " << cmd << " did not start!");
+       if (!d.waitWhile(SystemcallPrivate::Starting, process_events, -1)) {
+               LYXERR0("Systemcall: '" << cmd << "' did not start!");
                LYXERR0("error " << d.errorMessage());
                return 10;
        }
@@ -121,7 +226,7 @@ int Systemcall::startscript(Starttype how, string const & what)
        }
 
        if (!d.waitWhile(SystemcallPrivate::Running, process_events, 180000)) {
-               LYXERR0("QProcess " << cmd << " did not finished!");
+               LYXERR0("Systemcall: '" << cmd << "' did not finished!");
                LYXERR0("error " << d.errorMessage());
                LYXERR0("status " << d.exitStatusMessage());
                return 20;
@@ -129,8 +234,7 @@ int Systemcall::startscript(Starttype how, string const & what)
 
        int const exit_code = d.exitCode();
        if (exit_code) {
-               LYXERR0("QProcess " << cmd << " finished!");
-               LYXERR0("error " << exit_code << ": " << d.errorMessage()); 
+               LYXERR0("Systemcall: '" << cmd << "' finished with exit code " << exit_code);
        }
 
        return exit_code;
@@ -138,17 +242,17 @@ int Systemcall::startscript(Starttype how, string const & what)
 
 
 SystemcallPrivate::SystemcallPrivate(const std::string& of) : 
-                               proc_(new QProcess), outindex_(0), process_events(false),
-                               errindex_(0), outfile(of), showout_(false), showerr_(false)
+                                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();
+               setShowOut(true);
        if (os::is_terminal(os::STDERR))
-               showerr();
+               setShowErr(true);
 
        connect(proc_, SIGNAL(readyReadStandardOutput()), SLOT(stdOut()));
        connect(proc_, SIGNAL(readyReadStandardError()), SLOT(stdErr()));
@@ -161,20 +265,22 @@ SystemcallPrivate::SystemcallPrivate(const std::string& of) :
 
 void SystemcallPrivate::startProcess(const QString& cmd)
 {
+       cmd_ = cmd;
        if (proc_) {
                state = SystemcallPrivate::Starting;
-               proc_->start(cmd);
+               proc_->start(cmd_);
        }
 }
 
+
 void SystemcallPrivate::processEvents()
 {
        if(process_events) {
-               //static int count = 0; qDebug() << count++ << ": waitAndProcessEvents";
-               QCoreApplication::processEvents(QEventLoop::AllEvents);
+               QCoreApplication::processEvents(/*QEventLoop::ExcludeUserInputEvents*/);
        }
 }
 
+
 void SystemcallPrivate::waitAndProcessEvents()
 {
        Sleep::millisec(100);
@@ -217,7 +323,6 @@ bool SystemcallPrivate::waitWhile(State waitwhile, bool proc_events, int timeout
 }
 
 
-
 SystemcallPrivate::~SystemcallPrivate()
 {
        flush();
@@ -225,13 +330,15 @@ SystemcallPrivate::~SystemcallPrivate()
        if (outindex_) {
                outdata_[outindex_] = '\0';
                outindex_ = 0;
-               cout << outdata_;
+               if (showout_)
+                       cout << outdata_;
        }
        cout.flush();
        if (errindex_) {
                errdata_[errindex_] = '\0';
                errindex_ = 0;
-               cerr << errdata_;
+               if (showerr_)
+                       cerr << errdata_;
        }
        cerr.flush();
 
@@ -245,18 +352,26 @@ void SystemcallPrivate::flush()
                // 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()));
+               
+               QString data = QString::fromLocal8Bit(proc_->readAllStandardOutput().data());
+               if (showout_) 
+                       ProgressInterface::instance()->appendMessage(data);
+               if (!os::is_terminal(os::STDOUT) && outfile.empty()) 
+                       cout << fromqstr(data);
+               
+               data = QString::fromLocal8Bit(proc_->readAllStandardError().data());
+               if (showerr_) 
+                       ProgressInterface::instance()->appendError(data);
+               if (!os::is_terminal(os::STDERR)) 
+                       cerr << fromqstr(data);                 
+               
        }
 }
 
+
 void SystemcallPrivate::stdOut()
 {
-       if (proc_ && showout_) {
+       if (proc_) {
                char c;
                proc_->setReadChannel(QProcess::StandardOutput);
                while (proc_->getChar(&c)) {
@@ -264,17 +379,19 @@ void SystemcallPrivate::stdOut()
                        if (c == '\n' || outindex_ + 1 == bufsize_) {
                                outdata_[outindex_] = '\0';
                                outindex_ = 0;
-                               cout << outdata_;
+                               if (showout_) {
+                                       cout << outdata_;
+                                       ProgressInterface::instance()->appendMessage(QString::fromLocal8Bit(outdata_));         
+                               }
                        }
                }
        }
-       processEvents();
 }
 
 
 void SystemcallPrivate::stdErr()
 {
-       if (proc_ && showerr_) {
+       if (proc_) {
                char c;
                proc_->setReadChannel(QProcess::StandardError);
                while (proc_->getChar(&c)) {
@@ -282,31 +399,38 @@ void SystemcallPrivate::stdErr()
                        if (c == '\n' || errindex_ + 1 == bufsize_) {
                                errdata_[errindex_] = '\0';
                                errindex_ = 0;
-                               cerr << errdata_;
+                               if (showerr_) {
+                                       cerr << errdata_;
+                                       ProgressInterface::instance()->appendError(QString::fromLocal8Bit(errdata_));
+                               }
                        }
                }
        }
-       processEvents();
 }
 
 
 void SystemcallPrivate::processStarted()
 {
-       state = Running;
-       // why do we get two started signals?
-       //disconnect(proc_, SIGNAL(started()), this, SLOT(processStarted()));
+       if (state != Running) {
+               state = Running;
+               ProgressInterface::instance()->processStarted(cmd_);
+       }
 }
 
 
-void SystemcallPrivate::processFinished(int, QProcess::ExitStatus status)
+void SystemcallPrivate::processFinished(int, QProcess::ExitStatus)
 {
-       state = Finished;
+       if (state != Finished) {
+               state = Finished;
+               ProgressInterface::instance()->processFinished(cmd_);
+       }
 }
 
 
-void SystemcallPrivate::processError(QProcess::ProcessError err)
+void SystemcallPrivate::processError(QProcess::ProcessError)
 {
        state = Error;
+       ProgressInterface::instance()->appendError(errorMessage());
 }
 
 
@@ -364,6 +488,7 @@ QString SystemcallPrivate::exitStatusMessage() const
        return message;
 }
 
+
 int SystemcallPrivate::exitCode()
 {
        if (!proc_)
@@ -386,6 +511,7 @@ void SystemcallPrivate::killProcess()
        killProcess(proc_);
 }
 
+
 void SystemcallPrivate::killProcess(QProcess * p)
 {
        if (p) {