2014-08-19 15:59:29 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
**
|
2016-01-15 14:57:40 +01:00
|
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
|
|
|
** Contact: https://www.qt.io/licensing/
|
2014-08-19 15:59:29 +02:00
|
|
|
**
|
|
|
|
|
** 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
|
2016-01-15 14:57:40 +01:00
|
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
|
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
|
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
2014-08-19 15:59:29 +02:00
|
|
|
**
|
2016-01-15 14:57:40 +01:00
|
|
|
** GNU General Public License Usage
|
|
|
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
|
|
|
** General Public License version 3 as published by the Free Software
|
|
|
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
|
|
|
** included in the packaging of this file. Please review the following
|
|
|
|
|
** information to ensure the GNU General Public License requirements will
|
|
|
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
2014-08-19 15:59:29 +02:00
|
|
|
**
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#include "semantichighlighter.h"
|
|
|
|
|
|
|
|
|
|
#include <texteditor/fontsettings.h>
|
2015-12-15 11:59:48 +01:00
|
|
|
#include <texteditor/semantichighlighter.h>
|
2014-08-19 15:59:29 +02:00
|
|
|
#include <texteditor/syntaxhighlighter.h>
|
2015-03-05 08:22:48 +01:00
|
|
|
#include <texteditor/textdocument.h>
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
#include <utils/qtcassert.h>
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
#include <QLoggingCategory>
|
2015-03-05 08:22:48 +01:00
|
|
|
#include <QTextDocument>
|
2014-08-19 15:59:29 +02:00
|
|
|
|
2016-03-08 22:37:27 +02:00
|
|
|
using namespace TextEditor;
|
|
|
|
|
|
|
|
|
|
using SemanticHighlighter::incrementalApplyExtraAdditionalFormats;
|
|
|
|
|
using SemanticHighlighter::clearExtraAdditionalFormatsUntilEnd;
|
2014-08-19 15:59:29 +02:00
|
|
|
|
2018-10-12 09:33:30 +03:00
|
|
|
static Q_LOGGING_CATEGORY(log, "qtc.cpptools.semantichighlighter", QtWarningMsg)
|
2014-10-23 12:39:59 +02:00
|
|
|
|
2014-08-19 15:59:29 +02:00
|
|
|
namespace CppTools {
|
|
|
|
|
|
2020-10-19 18:03:31 +02:00
|
|
|
static const QList<std::pair<HighlightingResult, QTextBlock>>
|
|
|
|
|
splitRawStringLiteral(const HighlightingResult &result, const QTextBlock &startBlock)
|
|
|
|
|
{
|
|
|
|
|
if (result.textStyles.mainStyle != C_STRING)
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
|
|
|
|
|
QTextCursor cursor(startBlock);
|
|
|
|
|
cursor.setPosition(cursor.position() + result.column - 1);
|
|
|
|
|
cursor.setPosition(cursor.position() + result.length, QTextCursor::KeepAnchor);
|
|
|
|
|
const QString theString = cursor.selectedText();
|
|
|
|
|
|
|
|
|
|
// Find all the components of a raw string literal. If we don't succeed, then it's
|
|
|
|
|
// something else.
|
|
|
|
|
if (!theString.endsWith('"'))
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
int rOffset = -1;
|
|
|
|
|
if (theString.startsWith("R\"")) {
|
|
|
|
|
rOffset = 0;
|
|
|
|
|
} else if (theString.startsWith("LR\"")
|
|
|
|
|
|| theString.startsWith("uR\"")
|
|
|
|
|
|| theString.startsWith("UR\"")) {
|
|
|
|
|
rOffset = 1;
|
|
|
|
|
} else if (theString.startsWith("u8R\"")) {
|
|
|
|
|
rOffset = 2;
|
|
|
|
|
}
|
|
|
|
|
if (rOffset == -1)
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
const int delimiterOffset = rOffset + 2;
|
|
|
|
|
const int openParenOffset = theString.indexOf('(', delimiterOffset);
|
|
|
|
|
if (openParenOffset == -1)
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
const QStringView delimiter = theString.mid(delimiterOffset, openParenOffset - delimiterOffset);
|
|
|
|
|
const int endDelimiterOffset = theString.length() - 1 - delimiter.length();
|
|
|
|
|
if (theString.mid(endDelimiterOffset, delimiter.length()) != delimiter)
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
if (theString.at(endDelimiterOffset - 1) != ')')
|
|
|
|
|
return {{result, startBlock}};
|
|
|
|
|
|
|
|
|
|
// Now split the result. For clarity, we display only the actual content as a string,
|
|
|
|
|
// and the rest (including the delimiter) as a keyword.
|
|
|
|
|
HighlightingResult prefix = result;
|
|
|
|
|
prefix.textStyles.mainStyle = C_KEYWORD;
|
|
|
|
|
prefix.textStyles.mixinStyles = {};
|
|
|
|
|
prefix.length = delimiterOffset + delimiter.length() + 1;
|
|
|
|
|
cursor.setPosition(startBlock.position() + result.column - 1 + prefix.length);
|
|
|
|
|
QTextBlock stringBlock = cursor.block();
|
|
|
|
|
HighlightingResult actualString = result;
|
|
|
|
|
actualString.line = stringBlock.blockNumber() + 1;
|
|
|
|
|
actualString.column = cursor.positionInBlock() + 1;
|
|
|
|
|
actualString.length = endDelimiterOffset - openParenOffset - 2;
|
|
|
|
|
cursor.setPosition(cursor.position() + actualString.length);
|
|
|
|
|
QTextBlock suffixBlock = cursor.block();
|
|
|
|
|
HighlightingResult suffix = result;
|
|
|
|
|
suffix.textStyles.mainStyle = C_KEYWORD;
|
|
|
|
|
suffix.textStyles.mixinStyles = {};
|
|
|
|
|
suffix.line = suffixBlock.blockNumber() + 1;
|
|
|
|
|
suffix.column = cursor.positionInBlock() + 1;
|
|
|
|
|
suffix.length = delimiter.length() + 2;
|
|
|
|
|
QTC_CHECK(prefix.length + actualString.length + suffix.length == result.length);
|
|
|
|
|
|
|
|
|
|
return {{prefix, startBlock}, {actualString, stringBlock}, {suffix, suffixBlock}};
|
|
|
|
|
}
|
|
|
|
|
|
2016-03-08 22:37:27 +02:00
|
|
|
SemanticHighlighter::SemanticHighlighter(TextDocument *baseTextDocument)
|
2014-08-19 15:59:29 +02:00
|
|
|
: QObject(baseTextDocument)
|
|
|
|
|
, m_baseTextDocument(baseTextDocument)
|
|
|
|
|
{
|
|
|
|
|
QTC_CHECK(m_baseTextDocument);
|
|
|
|
|
updateFormatMapFromFontSettings();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
SemanticHighlighter::~SemanticHighlighter()
|
|
|
|
|
{
|
|
|
|
|
if (m_watcher) {
|
|
|
|
|
disconnectWatcher();
|
|
|
|
|
m_watcher->cancel();
|
|
|
|
|
m_watcher->waitForFinished();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::setHighlightingRunner(HighlightingRunner highlightingRunner)
|
|
|
|
|
{
|
|
|
|
|
m_highlightingRunner = highlightingRunner;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::run()
|
|
|
|
|
{
|
|
|
|
|
QTC_ASSERT(m_highlightingRunner, return);
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
qCDebug(log) << "SemanticHighlighter: run()";
|
2014-08-19 15:59:29 +02:00
|
|
|
|
|
|
|
|
if (m_watcher) {
|
|
|
|
|
disconnectWatcher();
|
|
|
|
|
m_watcher->cancel();
|
|
|
|
|
}
|
2016-03-08 22:37:27 +02:00
|
|
|
m_watcher.reset(new QFutureWatcher<HighlightingResult>);
|
2014-08-19 15:59:29 +02:00
|
|
|
connectWatcher();
|
|
|
|
|
|
|
|
|
|
m_revision = documentRevision();
|
|
|
|
|
m_watcher->setFuture(m_highlightingRunner());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::onHighlighterResultAvailable(int from, int to)
|
|
|
|
|
{
|
|
|
|
|
if (documentRevision() != m_revision)
|
|
|
|
|
return; // outdated
|
2019-10-31 16:15:03 +01:00
|
|
|
if (!m_watcher || m_watcher->isCanceled())
|
2014-08-19 15:59:29 +02:00
|
|
|
return; // aborted
|
|
|
|
|
|
2014-10-23 12:39:59 +02:00
|
|
|
qCDebug(log) << "onHighlighterResultAvailable()" << from << to;
|
2014-08-19 15:59:29 +02:00
|
|
|
|
2016-03-08 22:37:27 +02:00
|
|
|
SyntaxHighlighter *highlighter = m_baseTextDocument->syntaxHighlighter();
|
2014-08-19 15:59:29 +02:00
|
|
|
QTC_ASSERT(highlighter, return);
|
2020-10-19 18:03:31 +02:00
|
|
|
incrementalApplyExtraAdditionalFormats(highlighter, m_watcher->future(), from, to, m_formatMap,
|
|
|
|
|
&splitRawStringLiteral);
|
2014-08-19 15:59:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::onHighlighterFinished()
|
|
|
|
|
{
|
|
|
|
|
QTC_ASSERT(m_watcher, return);
|
|
|
|
|
if (!m_watcher->isCanceled() && documentRevision() == m_revision) {
|
2016-03-08 22:37:27 +02:00
|
|
|
SyntaxHighlighter *highlighter = m_baseTextDocument->syntaxHighlighter();
|
2016-04-15 15:21:26 +02:00
|
|
|
if (QTC_GUARD(highlighter)) {
|
2014-10-23 12:39:59 +02:00
|
|
|
qCDebug(log) << "onHighlighterFinished() - clearing formats";
|
2014-08-19 15:59:29 +02:00
|
|
|
clearExtraAdditionalFormatsUntilEnd(highlighter, m_watcher->future());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
m_watcher.reset();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::connectWatcher()
|
|
|
|
|
{
|
2019-01-14 01:40:53 +01:00
|
|
|
using Watcher = QFutureWatcher<HighlightingResult>;
|
2014-08-19 15:59:29 +02:00
|
|
|
connect(m_watcher.data(), &Watcher::resultsReadyAt,
|
|
|
|
|
this, &SemanticHighlighter::onHighlighterResultAvailable);
|
|
|
|
|
connect(m_watcher.data(), &Watcher::finished,
|
|
|
|
|
this, &SemanticHighlighter::onHighlighterFinished);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::disconnectWatcher()
|
|
|
|
|
{
|
2019-01-14 01:40:53 +01:00
|
|
|
using Watcher = QFutureWatcher<HighlightingResult>;
|
2014-08-19 15:59:29 +02:00
|
|
|
disconnect(m_watcher.data(), &Watcher::resultsReadyAt,
|
|
|
|
|
this, &SemanticHighlighter::onHighlighterResultAvailable);
|
|
|
|
|
disconnect(m_watcher.data(), &Watcher::finished,
|
|
|
|
|
this, &SemanticHighlighter::onHighlighterFinished);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
unsigned SemanticHighlighter::documentRevision() const
|
|
|
|
|
{
|
|
|
|
|
return m_baseTextDocument->document()->revision();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SemanticHighlighter::updateFormatMapFromFontSettings()
|
|
|
|
|
{
|
2014-09-11 10:51:41 +02:00
|
|
|
QTC_ASSERT(m_baseTextDocument, return);
|
|
|
|
|
|
2016-03-08 22:37:27 +02:00
|
|
|
const FontSettings &fs = m_baseTextDocument->fontSettings();
|
|
|
|
|
|
|
|
|
|
m_formatMap[TypeUse] = fs.toTextCharFormat(C_TYPE);
|
|
|
|
|
m_formatMap[LocalUse] = fs.toTextCharFormat(C_LOCAL);
|
|
|
|
|
m_formatMap[FieldUse] = fs.toTextCharFormat(C_FIELD);
|
|
|
|
|
m_formatMap[EnumerationUse] = fs.toTextCharFormat(C_ENUMERATION);
|
|
|
|
|
m_formatMap[VirtualMethodUse] = fs.toTextCharFormat(C_VIRTUAL_METHOD);
|
|
|
|
|
m_formatMap[LabelUse] = fs.toTextCharFormat(C_LABEL);
|
|
|
|
|
m_formatMap[MacroUse] = fs.toTextCharFormat(C_PREPROCESSOR);
|
|
|
|
|
m_formatMap[FunctionUse] = fs.toTextCharFormat(C_FUNCTION);
|
2015-10-25 23:31:20 +02:00
|
|
|
m_formatMap[FunctionDeclarationUse] =
|
2017-05-24 10:09:30 +02:00
|
|
|
fs.toTextCharFormat(TextStyles::mixinStyle(C_FUNCTION, C_DECLARATION));
|
2015-10-25 23:31:20 +02:00
|
|
|
m_formatMap[VirtualFunctionDeclarationUse] =
|
2017-05-24 10:09:30 +02:00
|
|
|
fs.toTextCharFormat(TextStyles::mixinStyle(C_VIRTUAL_METHOD, C_DECLARATION));
|
2016-03-08 22:37:27 +02:00
|
|
|
m_formatMap[PseudoKeywordUse] = fs.toTextCharFormat(C_KEYWORD);
|
|
|
|
|
m_formatMap[StringUse] = fs.toTextCharFormat(C_STRING);
|
2014-08-19 15:59:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
} // namespace CppTools
|