qt-creator/src/shared/qscripthighlighter/qscripthighlighter.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "qscripthighlighter.h"

#include <QtCore/QSet>
#include <QtCore/QtAlgorithms>

using namespace SharedTools;

QScriptHighlighter::QScriptHighlighter(bool duiEnabled, QTextDocument *parent):
        QSyntaxHighlighter(parent),
        m_duiEnabled(duiEnabled)
{
    QVector<QTextCharFormat> rc;
    rc.resize(NumFormats);
    rc[NumberFormat].setForeground(Qt::blue);
    rc[StringFormat].setForeground(Qt::darkGreen);
    rc[TypeFormat].setForeground(Qt::darkMagenta);
    rc[KeywordFormat].setForeground(Qt::darkYellow);
    rc[LabelFormat].setForeground(Qt::darkRed);
    rc[CommentFormat].setForeground(Qt::red); rc[CommentFormat].setFontItalic(true);
    rc[PreProcessorFormat].setForeground(Qt::darkBlue);
    rc[VisualWhitespace].setForeground(Qt::lightGray); // for debug: rc[VisualWhitespace].setBackground(Qt::red);
    setFormats(rc);

    m_scanner.setKeywords(keywords());
}

bool QScriptHighlighter::isDuiEnabled() const
{ return m_duiEnabled; }

void QScriptHighlighter::highlightBlock(const QString &text)
{
    m_scanner(onBlockStart(), text);

    QTextCharFormat emptyFormat;
    int lastEnd = 0;
    const QList<QScriptIncrementalScanner::Token> tokens = m_scanner.tokens();
    for (int i = 0; i < tokens.size(); ++i) {
        const QScriptIncrementalScanner::Token token = tokens.at(i);

        if (token.offset != lastEnd)
            setFormat(lastEnd, token.offset - lastEnd, m_formats[VisualWhitespace]);

        switch (token.kind) {
            case QScriptIncrementalScanner::Token::Keyword:
                setFormat(token.offset, token.length, m_formats[KeywordFormat]);
                break;

            case QScriptIncrementalScanner::Token::String:
                highlightWhitespace(token, text, StringFormat);
                break;

            case QScriptIncrementalScanner::Token::Comment:
                highlightWhitespace(token, text, CommentFormat);
                break;

            case QScriptIncrementalScanner::Token::Number:
                highlightWhitespace(token, text, NumberFormat);
                break;

            case QScriptIncrementalScanner::Token::LeftParenthesis:
                onOpeningParenthesis('(', token.offset);
                break;

            case QScriptIncrementalScanner::Token::RightParenthesis:
                onClosingParenthesis(')', token.offset);
                break;

            case QScriptIncrementalScanner::Token::LeftBrace:
                onOpeningParenthesis('{', token.offset);
                break;

            case QScriptIncrementalScanner::Token::RightBrace:
                onClosingParenthesis('}', token.offset);
                break;

            case QScriptIncrementalScanner::Token::LeftBracket:
                onOpeningParenthesis('[', token.offset);
                break;

            case QScriptIncrementalScanner::Token::RightBracket:
                onClosingParenthesis(']', token.offset);
                break;

            case QScriptIncrementalScanner::Token::Identifier:
                if (m_duiEnabled && (i + 1 != tokens.size()) && tokens.at(i + 1).kind == QScriptIncrementalScanner::Token::Colon) {
                    setFormat(token.offset, token.length, m_formats[LabelFormat]);
                } else {
                    const QChar c = text.at(token.offset);

                    if (m_duiEnabled && c.isUpper() || !m_duiEnabled && c == QLatin1Char('Q'))
                        setFormat(token.offset, token.length, m_formats[TypeFormat]);
                    else
                        setFormat(token.offset, token.length, emptyFormat);
                }
                break;

            case QScriptIncrementalScanner::Token::Colon:
                if (m_duiEnabled && i > 0 && tokens.at(i - 1).kind == QScriptIncrementalScanner::Token::Identifier)
                    setFormat(token.offset, token.length, m_formats[LabelFormat]);
                else
                    setFormat(token.offset, token.length, emptyFormat);
                break;

            case QScriptIncrementalScanner::Token::Operator:
            case QScriptIncrementalScanner::Token::Dot:
                setFormat(token.offset, token.length, emptyFormat);
                break;

            default:
                break;
        }

        lastEnd = token.end();
    }

    const int firstNonSpace = m_scanner.firstNonSpace();
    if (firstNonSpace > lastEnd)
        setFormat(lastEnd, firstNonSpace - lastEnd, m_formats[VisualWhitespace]);
    else if (text.length() > lastEnd)
        setFormat(lastEnd, text.length() - lastEnd, m_formats[VisualWhitespace]);

    onBlockEnd(m_scanner.endState(), firstNonSpace);
}

void QScriptHighlighter::setFormats(const QVector<QTextCharFormat> &s)
{
    Q_ASSERT(s.size() == NumFormats);
    qCopy(s.constBegin(), s.constEnd(), m_formats);
}

QSet<QString> QScriptHighlighter::keywords()
{
    QSet<QString> keywords;

    keywords << QLatin1String("Infinity");
    keywords << QLatin1String("NaN");
    keywords << QLatin1String("abstract");
    keywords << QLatin1String("boolean");
    keywords << QLatin1String("break");
    keywords << QLatin1String("byte");
    keywords << QLatin1String("case");
    keywords << QLatin1String("catch");
    keywords << QLatin1String("char");
    keywords << QLatin1String("class");
    keywords << QLatin1String("const");
    keywords << QLatin1String("constructor");
    keywords << QLatin1String("continue");
    keywords << QLatin1String("debugger");
    keywords << QLatin1String("default");
    keywords << QLatin1String("delete");
    keywords << QLatin1String("do");
    keywords << QLatin1String("double");
    keywords << QLatin1String("else");
    keywords << QLatin1String("enum");
    keywords << QLatin1String("export");
    keywords << QLatin1String("extends");
    keywords << QLatin1String("false");
    keywords << QLatin1String("final");
    keywords << QLatin1String("finally");
    keywords << QLatin1String("float");
    keywords << QLatin1String("for");
    keywords << QLatin1String("function");
    keywords << QLatin1String("goto");
    keywords << QLatin1String("if");
    keywords << QLatin1String("implements");
    keywords << QLatin1String("import");
    keywords << QLatin1String("in");
    keywords << QLatin1String("instanceof");
    keywords << QLatin1String("int");
    keywords << QLatin1String("interface");
    keywords << QLatin1String("long");
    keywords << QLatin1String("native");
    keywords << QLatin1String("new");
    keywords << QLatin1String("package");
    keywords << QLatin1String("private");
    keywords << QLatin1String("protected");
    keywords << QLatin1String("public");
    keywords << QLatin1String("return");
    keywords << QLatin1String("short");
    keywords << QLatin1String("static");
    keywords << QLatin1String("super");
    keywords << QLatin1String("switch");
    keywords << QLatin1String("synchronized");
    keywords << QLatin1String("this");
    keywords << QLatin1String("throw");
    keywords << QLatin1String("throws");
    keywords << QLatin1String("transient");
    keywords << QLatin1String("true");
    keywords << QLatin1String("try");
    keywords << QLatin1String("typeof");
    keywords << QLatin1String("undefined");
    keywords << QLatin1String("var");
    keywords << QLatin1String("void");
    keywords << QLatin1String("volatile");
    keywords << QLatin1String("while");
    keywords << QLatin1String("with");

    return keywords;
}

int QScriptHighlighter::onBlockStart()
{
    int state = 0;
    int previousState = previousBlockState();
    if (previousState != -1)
        state = previousState;
    return state;
}
void QScriptHighlighter::onOpeningParenthesis(QChar, int) {}
void QScriptHighlighter::onClosingParenthesis(QChar, int) {}
void QScriptHighlighter::onBlockEnd(int state, int) { return setCurrentBlockState(state); }

void QScriptHighlighter::highlightWhitespace(const QScriptIncrementalScanner::Token &token, const QString &text, int nonWhitespaceFormat)
{
    const QTextCharFormat normalFormat = m_formats[nonWhitespaceFormat];
    const QTextCharFormat visualSpaceFormat = m_formats[VisualWhitespace];

    const int end = token.end();
    int index = token.offset;

    while (index != end) {
        const bool isSpace = text.at(index).isSpace();
        const int start = index;

        do { ++index; }
        while (index != end && text.at(index).isSpace() == isSpace);

        const int tokenLength = index - start;
        setFormat(start, tokenLength, isSpace ? visualSpaceFormat : normalFormat);
    }
}