Added color support of ANSI escape codes

in compile and application output pane. Only simple font and background
controles added.

Task-number: QTCREATORBUG-9592
Task-number: QTCREATORBUG-5956
Change-Id: Ida010ed17d34bb73ae1364a77073ff435a03a060
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: hjk <hjk121@nokiamail.com>

src/libs/utils/ansiescapecodehandler.cpp

@@ -0,0 +1,200 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Petar Perisin <petar.perisin@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "ansiescapecodehandler.h"
+#include <utils/qtcassert.h>
+
+namespace Utils {
+
+/*!
+    \class Utils::AnsiEscapeCodeHandler
+
+    \brief The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it.
+
+    In order to preserve color information across text segments, an instance of this class
+    must be stored for the lifetime of a stream.
+    Also, one instance of this class should not handle multiple streams (at least not
+    at the same time).
+
+    Its main method is parseText(), which accepts text and default QTextCharFormat.
+    This method is designed to parse text and split colored text to smaller strings,
+    with their appropriate formatting information set inside QTextCharFormat.
+
+    Usage:
+    \list
+    \li Create new instance of AnsiEscapeCodeHandler for a stream.
+    \li To add new text, call parseText() with the text and a default QTextCharFormat.
+        The result of this method is a list of strings with formats set in appropriate
+        QTextCharFormat.
+    \endlist
+*/
+
+AnsiEscapeCodeHandler::AnsiEscapeCodeHandler() :
+    m_previousFormatClosed(true)
+{
+}
+
+static QColor ansiColor(uint code)
+{
+    QTC_ASSERT(code < 8, return QColor());
+
+    const int red   = code & 1 ? 170 : 0;
+    const int green = code & 2 ? 170 : 0;
+    const int blue  = code & 4 ? 170 : 0;
+    return QColor(red, green, blue);
+}
+
+QList<StringFormatPair> AnsiEscapeCodeHandler::parseText(const QString &text,
+                                                         const QTextCharFormat &defaultFormat)
+{
+    QList<StringFormatPair> outputData;
+
+    QTextCharFormat charFormat = m_previousFormatClosed ? defaultFormat : m_previousFormat;
+
+    const QString escape = QLatin1String("\e[");
+    if (!text.contains(escape)) {
+        outputData << StringFormatPair(text, charFormat);
+        return outputData;
+    } else if (!text.startsWith(escape)) {
+        outputData << StringFormatPair(text.left(text.indexOf(escape)), charFormat);
+    }
+
+    const QChar semicolon       = QLatin1Char(';');
+    const QChar colorTerminator = QLatin1Char('m');
+    // strippedText always starts with "\e["
+    QString strippedText = text.mid(text.indexOf(escape));
+    while (!strippedText.isEmpty()) {
+        while (strippedText.startsWith(escape)) {
+            strippedText.remove(0, 2);
+
+            // get the number
+            QString strNumber;
+            QStringList numbers;
+            while (strippedText.at(0).isDigit() || strippedText.at(0) == semicolon) {
+                if (strippedText.at(0).isDigit()) {
+                    strNumber += strippedText.at(0);
+                } else {
+                    numbers << strNumber;
+                    strNumber.clear();
+                }
+                strippedText.remove(0, 1);
+            }
+            if (!strNumber.isEmpty())
+                numbers << strNumber;
+
+            // remove terminating char
+            if (!strippedText.startsWith(colorTerminator)) {
+                strippedText.remove(0, 1);
+                continue;
+            }
+            strippedText.remove(0, 1);
+
+            for (int i = 0; i < numbers.size(); ++i) {
+                const int code = numbers.at(i).toInt();
+
+                if (code >= TextColorStart && code <= TextColorEnd) {
+                    charFormat.setForeground(ansiColor(code - TextColorStart));
+                    setFormatScope(charFormat);
+                } else if (code >= BackgroundColorStart && code <= BackgroundColorEnd) {
+                    charFormat.setBackground(ansiColor(code - BackgroundColorStart));
+                    setFormatScope(charFormat);
+                } else {
+                    switch (code) {
+                    case ResetFormat:
+                        charFormat = defaultFormat;
+                        endFormatScope();
+                        break;
+                    case BoldText:
+                        charFormat.setFontWeight(QFont::Bold);
+                        setFormatScope(charFormat);
+                        break;
+                    case DefaultTextColor:
+                        charFormat.setForeground(defaultFormat.foreground());
+                        setFormatScope(charFormat);
+                        break;
+                    case DefaultBackgroundColor:
+                        charFormat.setBackground(defaultFormat.background());
+                        setFormatScope(charFormat);
+                        break;
+                    case RgbTextColor:
+                    case RgbBackgroundColor:
+                        if (++i >= numbers.size())
+                            break;
+                        if (numbers.at(i).toInt() == 2) {
+                            // RGB set with format: 38;2;<r>;<g>;<b>
+                            if ((i + 3) < numbers.size()) {
+                                (code == RgbTextColor) ?
+                                      charFormat.setForeground(QColor(numbers.at(i + 1).toInt(),
+                                                                      numbers.at(i + 2).toInt(),
+                                                                      numbers.at(i + 3).toInt())) :
+                                      charFormat.setBackground(QColor(numbers.at(i + 1).toInt(),
+                                                                      numbers.at(i + 2).toInt(),
+                                                                      numbers.at(i + 3).toInt()));
+                                setFormatScope(charFormat);
+                            }
+                            i += 3;
+                        } else if (numbers.at(i).toInt() == 5) {
+                            // rgb set with format: 38;5;<i>
+                            // unsupported because of unclear documentation, so we just skip <i>
+                            ++i;
+                        }
+                        break;
+                    default:
+                        break;
+                    }
+                }
+            }
+        }
+
+        if (strippedText.isEmpty())
+            break;
+        int index = strippedText.indexOf(escape);
+        if (index > 0) {
+            outputData << StringFormatPair(strippedText.left(index), charFormat);
+            strippedText.remove(0, index);
+        } else if (index == -1) {
+            outputData << StringFormatPair(strippedText, charFormat);
+            break;
+        }
+    }
+    return outputData;
+}
+
+void AnsiEscapeCodeHandler::endFormatScope()
+{
+    m_previousFormatClosed = true;
+}
+
+void AnsiEscapeCodeHandler::setFormatScope(const QTextCharFormat &charFormat)
+{
+    m_previousFormat = charFormat;
+    m_previousFormatClosed = false;
+}
+
+} // namespace Utils

src/libs/utils/ansiescapecodehandler.h

@@ -0,0 +1,72 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Petar Perisin <petar.perisin@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+
+#ifndef UTILS_ANSIESCAPECODEHANDLER_H
+#define UTILS_ANSIESCAPECODEHANDLER_H
+
+#include "utils_global.h"
+
+#include <QTextCharFormat>
+
+namespace Utils {
+
+typedef QPair<QString, QTextCharFormat> StringFormatPair;
+
+class QTCREATOR_UTILS_EXPORT AnsiEscapeCodeHandler
+{
+
+enum AnsiEscapeCodes {
+    ResetFormat            =  0,
+    BoldText               =  1,
+    TextColorStart         = 30,
+    TextColorEnd           = 37,
+    RgbTextColor           = 38,
+    DefaultTextColor       = 39,
+    BackgroundColorStart   = 40,
+    BackgroundColorEnd     = 47,
+    RgbBackgroundColor     = 48,
+    DefaultBackgroundColor = 49
+};
+
+public:
+    AnsiEscapeCodeHandler();
+    QList<StringFormatPair> parseText(const QString &text, const QTextCharFormat &defaultFormat);
+    void endFormatScope();
+
+private:
+    void setFormatScope(const QTextCharFormat &charFormat);
+
+    bool            m_previousFormatClosed;
+    QTextCharFormat m_previousFormat;
+};
+
+} // namespace Utils
+
+#endif // UTILS_ANSIESCAPECODEHANDLER_H

src/libs/utils/outputformatter.cpp

@@ -30,6 +30,7 @@
 #include "outputformatter.h"
 
 #include <QPlainTextEdit>
+#include <utils/ansiescapecodehandler.h>
 
 using namespace Utils;
 
@@ -37,6 +38,7 @@ OutputFormatter::OutputFormatter()
     : QObject()
     , m_plainTextEdit(0)
     , m_formats(0)
+    , m_escapeCodeHandler(new AnsiEscapeCodeHandler)
 {
 
 }
@@ -44,6 +46,7 @@ OutputFormatter::OutputFormatter()
 OutputFormatter::~OutputFormatter()
 {
     delete[] m_formats;
+    delete m_escapeCodeHandler;
 }
 
 QPlainTextEdit *OutputFormatter::plainTextEdit() const
@@ -61,7 +64,9 @@ void OutputFormatter::appendMessage(const QString &text, OutputFormat format)
 {
     QTextCursor cursor(m_plainTextEdit->document());
     cursor.movePosition(QTextCursor::End);
-    cursor.insertText(text, m_formats[format]);
+
+    foreach (const StringFormatPair &pair, m_escapeCodeHandler->parseText(text, m_formats[format]))
+        cursor.insertText(pair.first, pair.second);
 }
 
 QTextCharFormat OutputFormatter::charFormat(OutputFormat format) const
@@ -131,3 +136,9 @@ void OutputFormatter::setFont(const QFont &font)
     m_font = font;
     initFormats();
 }
+
+void OutputFormatter::flush()
+{
+    if (m_escapeCodeHandler)
+        m_escapeCodeHandler->endFormatScope();
+}

src/libs/utils/outputformatter.h

@@ -44,6 +44,8 @@ QT_END_NAMESPACE
 
 namespace Utils {
 
+class AnsiEscapeCodeHandler;
+
 class QTCREATOR_UTILS_EXPORT OutputFormatter : public QObject
 {
     Q_OBJECT
@@ -57,6 +59,7 @@ public:
 
     QFont font() const;
     void setFont(const QFont &font);
+    void flush();
 
     virtual void appendMessage(const QString &text, OutputFormat format);
     virtual void handleLink(const QString &href);
@@ -72,6 +75,7 @@ private:
     QPlainTextEdit *m_plainTextEdit;
     QTextCharFormat *m_formats;
     QFont m_font;
+    AnsiEscapeCodeHandler *m_escapeCodeHandler;
 };
 
 } // namespace Utils

src/libs/utils/utils-lib.pri

@@ -84,7 +84,8 @@ SOURCES += $$PWD/environment.cpp \
     $$PWD/tooltip/tips.cpp \
     $$PWD/tooltip/tipcontents.cpp \
     $$PWD/unixutils.cpp \
-    $$PWD/function.cpp
+    $$PWD/function.cpp \
+    $$PWD/ansiescapecodehandler.cpp
 
 win32 {
     SOURCES += \
@@ -176,7 +177,8 @@ HEADERS += \
     $$PWD/tooltip/effects.h \
     $$PWD/unixutils.h \
     $$PWD/qtcoverride.h \
-    $$PWD/function.h
+    $$PWD/function.h \
+    $$PWD/ansiescapecodehandler.h
 
 FORMS += $$PWD/filewizardpage.ui \
     $$PWD/projectintropage.ui \

src/libs/utils/utils.qbs

@@ -25,6 +25,8 @@ QtcLibrary {
     files: [
         "annotateditemdelegate.cpp",
         "annotateditemdelegate.h",
+        "ansiescapecodehandler.cpp",
+        "ansiescapecodehandler.h",
         "appmainwindow.cpp",
         "appmainwindow.h",
         "basetreeview.cpp",

src/plugins/projectexplorer/appoutputpane.cpp

@@ -568,6 +568,7 @@ void AppOutputPane::slotRunControlFinished()
     ProjectExplorer::RunControl *rc = qobject_cast<RunControl *>(sender());
     QMetaObject::invokeMethod(this, "slotRunControlFinished2", Qt::QueuedConnection,
                               Q_ARG(ProjectExplorer::RunControl *, rc));
+    rc->outputFormatter()->flush();
 }
 
 void AppOutputPane::slotRunControlFinished2(RunControl *sender)

src/plugins/projectexplorer/buildmanager.cpp

@@ -371,6 +371,7 @@ void BuildManager::buildStepFinishedAsync()
 
 void BuildManager::nextBuildQueue()
 {
+    d->m_outputWindow->flush();
     if (d->m_canceling) {
         d->m_canceling = false;
         QTimer::singleShot(0, m_instance, SLOT(emitCancelMessage()));

src/plugins/projectexplorer/compileoutputwindow.cpp

@@ -40,6 +40,7 @@
 #include <extensionsystem/pluginmanager.h>
 #include <texteditor/texteditorsettings.h>
 #include <texteditor/fontsettings.h>
+#include <utils/ansiescapecodehandler.h>
 
 #include <QIcon>
 #include <QTextCharFormat>
@@ -103,7 +104,8 @@ private:
 } // namespace ProjectExplorer
 
 CompileOutputWindow::CompileOutputWindow(BuildManager * /*bm*/, QAction *cancelBuildAction) :
-    m_cancelBuildButton(new QToolButton)
+    m_cancelBuildButton(new QToolButton),
+    m_escapeCodeHandler(new Utils::AnsiEscapeCodeHandler)
 {
     Core::Context context(Constants::C_COMPILE_OUTPUT);
     m_outputWindow = new CompileOutputTextEdit(context);
@@ -142,6 +144,7 @@ CompileOutputWindow::~CompileOutputWindow()
     ExtensionSystem::PluginManager::removeObject(m_handler);
     delete m_handler;
     delete m_cancelBuildButton;
+    delete m_escapeCodeHandler;
 }
 
 void CompileOutputWindow::updateWordWrapMode()
@@ -203,7 +206,8 @@ void CompileOutputWindow::appendText(const QString &text, ProjectExplorer::Build
 
     }
 
-    m_outputWindow->appendText(text, textFormat);
+    foreach (const Utils::StringFormatPair &pair, m_escapeCodeHandler->parseText(text, textFormat))
+        m_outputWindow->appendText(pair.first, pair.second);
 }
 
 void CompileOutputWindow::clearContents()
@@ -271,4 +275,10 @@ void CompileOutputWindow::showPositionOf(const Task &task)
     m_outputWindow->setTextCursor(newCursor);
 }
 
+void CompileOutputWindow::flush()
+{
+    if (m_escapeCodeHandler)
+        m_escapeCodeHandler->endFormatScope();
+}
+
 #include "compileoutputwindow.moc"

src/plugins/projectexplorer/compileoutputwindow.h

@@ -41,6 +41,8 @@ class QTextCharFormat;
 class QToolButton;
 QT_END_NAMESPACE
 
+namespace Utils { class AnsiEscapeCodeHandler; }
+
 namespace ProjectExplorer {
 
 class BuildManager;
@@ -80,6 +82,8 @@ public:
     bool knowsPositionOf(const Task &task);
     void showPositionOf(const Task &task);
 
+    void flush();
+
 private slots:
     void updateWordWrapMode();
 
@@ -88,6 +92,7 @@ private:
     QHash<unsigned int, int> m_taskPositions;
     ShowOutputTaskHandler * m_handler;
     QToolButton *m_cancelBuildButton;
+    Utils::AnsiEscapeCodeHandler *m_escapeCodeHandler;
 };
 
 } // namespace Internal