forked from qt-creator/qt-creator
SyntaxHighlighter: Move SyntaxHighlighter to separate thread
This change involves the relocation of SyntaxHighlighter processing to another thread. The core idea is to create a duplicate of the original TextDocument using SyntaxHighlighterRunnerPrivate::cloneDocument. A new SyntaxHighlighter is then instantiated by SyntaxHighLighterCreator for the cloned document. The entire SyntaxHighLighterCreator class is moved to a new thread, where it performs highlighting on the cloned document. Upon completion of the highlighting process, the resultsReady signal is emitted, and the updated highlighting data is applied to the original document. This shift of SyntaxHighlighter to another thread enhances the user experience by preventing UI slowdowns during the highlighting process. - Introduction of BaseSyntaxHighlighterRunner as an interface class for future *SyntaxHighlighterRunner. - Inclusion of DirectSyntaxHighlighterRunner class for performing highlighting in the main thread, suitable for syntax highlighters that cannot be moved to another thread. - Introduction of ThreadedSyntaxHighlighterRunner class for highlighting in a separate thread, preventing UI blocking during the process. - Addition of Result data to the SyntaxHighlighter class to facilitate data exchange between threads. Task-number: QTCREATORBUG-28727 Change-Id: I4b6a38d15f5ec9b8828055d38d2a0c6f21a657b4 Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io> Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Artem Sokolovskii
255
src/plugins/texteditor/syntaxhighlighterrunner.cpp
Normal file
255
src/plugins/texteditor/syntaxhighlighterrunner.cpp
Normal file
@@ -0,0 +1,255 @@
|
||||
// Copyright (C) 2023 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
|
||||
|
||||
#include "syntaxhighlighterrunner.h"
|
||||
|
||||
#include <texteditor/fontsettings.h>
|
||||
#include <texteditor/textdocumentlayout.h>
|
||||
|
||||
#include <utils/textutils.h>
|
||||
|
||||
#include <QMetaObject>
|
||||
#include <QTextCursor>
|
||||
#include <QTextDocument>
|
||||
#include <QThread>
|
||||
|
||||
namespace TextEditor {
|
||||
|
||||
class SyntaxHighlighterRunnerPrivate : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
SyntaxHighlighterRunnerPrivate(BaseSyntaxHighlighterRunner::SyntaxHighLighterCreator creator,
|
||||
QTextDocument *document)
|
||||
: m_creator(creator)
|
||||
{
|
||||
m_highlighter.reset(m_creator());
|
||||
m_highlighter->setDocument(document);
|
||||
m_document = document;
|
||||
}
|
||||
|
||||
void create()
|
||||
{
|
||||
if (m_document != nullptr)
|
||||
return;
|
||||
|
||||
m_document = new QTextDocument(this);
|
||||
m_document->setDocumentLayout(new TextDocumentLayout(m_document));
|
||||
|
||||
m_highlighter.reset(m_creator());
|
||||
m_highlighter->setDocument(m_document);
|
||||
|
||||
connect(m_highlighter.get(),
|
||||
&SyntaxHighlighter::resultsReady,
|
||||
this,
|
||||
&SyntaxHighlighterRunnerPrivate::resultsReady);
|
||||
}
|
||||
|
||||
void cloneDocument(int from,
|
||||
int charsRemoved,
|
||||
const QString textAdded,
|
||||
const QMap<int, BaseSyntaxHighlighterRunner::BlockPreeditData> &blocksPreedit)
|
||||
{
|
||||
QTextCursor cursor(m_document);
|
||||
cursor.setPosition(qMin(m_document->characterCount() - 1, from + charsRemoved));
|
||||
cursor.setPosition(from, QTextCursor::KeepAnchor);
|
||||
cursor.insertText(textAdded);
|
||||
|
||||
for (auto it = blocksPreedit.cbegin(); it != blocksPreedit.cend(); ++it) {
|
||||
const QTextBlock block = m_document->findBlock(it.key());
|
||||
block.layout()->setPreeditArea(it.value().position, it.value().text);
|
||||
}
|
||||
}
|
||||
|
||||
void setExtraFormats(const QMap<int, QList<QTextLayout::FormatRange>> &formatMap)
|
||||
{
|
||||
for (auto it = formatMap.cbegin(); it != formatMap.cend(); ++it)
|
||||
m_highlighter->setExtraFormats(m_document->findBlockByNumber(it.key()), it.value());
|
||||
}
|
||||
|
||||
void clearExtraFormats(const QList<int> &blockNumbers)
|
||||
{
|
||||
for (auto it = blockNumbers.cbegin(); it != blockNumbers.cend(); ++it)
|
||||
m_highlighter->clearExtraFormats(m_document->findBlockByNumber(*it));
|
||||
}
|
||||
|
||||
void clearAllExtraFormats() { m_highlighter->clearAllExtraFormats(); }
|
||||
|
||||
void setFontSettings(const TextEditor::FontSettings &fontSettings)
|
||||
{
|
||||
m_highlighter->setFontSettings(fontSettings);
|
||||
m_highlighter->rehighlight();
|
||||
}
|
||||
|
||||
KSyntaxHighlighting::Definition getDefinition() { return m_highlighter->getDefinition(); }
|
||||
|
||||
void setLanguageFeaturesFlags(unsigned int flags)
|
||||
{
|
||||
m_highlighter->setLanguageFeaturesFlags(flags);
|
||||
}
|
||||
|
||||
void setEnabled(bool enabled) { m_highlighter->setEnabled(enabled); }
|
||||
|
||||
void rehighlight() { m_highlighter->rehighlight(); }
|
||||
|
||||
signals:
|
||||
void resultsReady(const QList<SyntaxHighlighter::Result> &result);
|
||||
|
||||
private:
|
||||
BaseSyntaxHighlighterRunner::SyntaxHighLighterCreator m_creator;
|
||||
std::unique_ptr<SyntaxHighlighter> m_highlighter;
|
||||
QTextDocument *m_document = nullptr;
|
||||
};
|
||||
|
||||
// ----------------------------- BaseSyntaxHighlighterRunner --------------------------------------
|
||||
|
||||
BaseSyntaxHighlighterRunner::BaseSyntaxHighlighterRunner(
|
||||
BaseSyntaxHighlighterRunner::SyntaxHighLighterCreator creator, QTextDocument *document)
|
||||
: d(new SyntaxHighlighterRunnerPrivate(creator, document))
|
||||
{
|
||||
m_document = document;
|
||||
}
|
||||
|
||||
BaseSyntaxHighlighterRunner::~BaseSyntaxHighlighterRunner() = default;
|
||||
|
||||
void BaseSyntaxHighlighterRunner::applyFormatRanges(const SyntaxHighlighter::Result &result)
|
||||
{
|
||||
QTextBlock docBlock = m_document->findBlock(result.m_blockNumber);
|
||||
if (!docBlock.isValid())
|
||||
return;
|
||||
|
||||
result.copyToBlock(docBlock);
|
||||
|
||||
if (!result.m_formatRanges.empty()) {
|
||||
TextDocumentLayout::FoldValidator foldValidator;
|
||||
foldValidator.setup(qobject_cast<TextDocumentLayout *>(m_document->documentLayout()));
|
||||
docBlock.layout()->setFormats(result.m_formatRanges);
|
||||
m_document->markContentsDirty(docBlock.position(), docBlock.length());
|
||||
foldValidator.process(docBlock);
|
||||
}
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::cloneDocumentData(int from, int charsRemoved, int charsAdded)
|
||||
{
|
||||
QMap<int, BaseSyntaxHighlighterRunner::BlockPreeditData> blocksPreedit;
|
||||
QTextBlock firstBlock = m_document->findBlock(from);
|
||||
QTextBlock endBlock = m_document->findBlock(from + charsAdded);
|
||||
while (firstBlock.isValid() && firstBlock.position() < endBlock.position()) {
|
||||
const int position = firstBlock.position();
|
||||
if (firstBlock.layout()) {
|
||||
const int preeditAreaPosition = firstBlock.layout()->preeditAreaPosition();
|
||||
const QString preeditAreaText = firstBlock.layout()->preeditAreaText();
|
||||
if (preeditAreaPosition != -1)
|
||||
blocksPreedit[position] = {preeditAreaPosition, preeditAreaText};
|
||||
}
|
||||
firstBlock = firstBlock.next();
|
||||
}
|
||||
|
||||
const QString text = Utils::Text::textAt(QTextCursor(m_document), from, charsAdded);
|
||||
cloneDocument(from, charsRemoved, text, blocksPreedit);
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::cloneDocument(int from,
|
||||
int charsRemoved,
|
||||
const QString textAdded,
|
||||
const QMap<int, BlockPreeditData> &blocksPreedit)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, from, charsRemoved, textAdded, blocksPreedit] {
|
||||
d->cloneDocument(from, charsRemoved, textAdded, blocksPreedit);
|
||||
});
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::setExtraFormats(
|
||||
const QMap<int, QList<QTextLayout::FormatRange>> &formatMap)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, formatMap] { d->setExtraFormats(formatMap); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::clearExtraFormats(const QList<int> &blockNumbers)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, blockNumbers] { d->clearExtraFormats(blockNumbers); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::clearAllExtraFormats()
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this] { d->clearAllExtraFormats(); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::setFontSettings(const TextEditor::FontSettings &fontSettings)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, fontSettings] { d->setFontSettings(fontSettings); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::setLanguageFeaturesFlags(unsigned int flags)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, flags] { d->setLanguageFeaturesFlags(flags); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::setEnabled(bool enabled)
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this, enabled] { d->setEnabled(enabled); });
|
||||
}
|
||||
|
||||
void BaseSyntaxHighlighterRunner::rehighlight()
|
||||
{
|
||||
QMetaObject::invokeMethod(d.get(), [this] { d->rehighlight(); });
|
||||
}
|
||||
|
||||
KSyntaxHighlighting::Definition BaseSyntaxHighlighterRunner::getDefinition()
|
||||
{
|
||||
return d->getDefinition();
|
||||
}
|
||||
|
||||
// --------------------------- ThreadedSyntaxHighlighterRunner ------------------------------------
|
||||
|
||||
ThreadedSyntaxHighlighterRunner::ThreadedSyntaxHighlighterRunner(SyntaxHighLighterCreator creator,
|
||||
QTextDocument *document)
|
||||
: BaseSyntaxHighlighterRunner(creator, nullptr)
|
||||
{
|
||||
QTC_ASSERT(document, return);
|
||||
|
||||
d->moveToThread(&m_thread);
|
||||
connect(&m_thread, &QThread::finished, d.get(), [this] { d.release()->deleteLater(); });
|
||||
m_thread.start();
|
||||
|
||||
QMetaObject::invokeMethod(d.get(), &SyntaxHighlighterRunnerPrivate::create);
|
||||
|
||||
m_document = document;
|
||||
connect(d.get(),
|
||||
&SyntaxHighlighterRunnerPrivate::resultsReady,
|
||||
document,
|
||||
[this](const QList<SyntaxHighlighter::Result> &result) {
|
||||
for (const SyntaxHighlighter::Result &res : result)
|
||||
applyFormatRanges(res);
|
||||
});
|
||||
cloneDocumentData(0, 0, document->characterCount());
|
||||
connect(document,
|
||||
&QTextDocument::contentsChange,
|
||||
this,
|
||||
[this](int from, int charsRemoved, int charsAdded) {
|
||||
if (!this->document())
|
||||
return;
|
||||
|
||||
cloneDocumentData(from, charsRemoved, charsAdded);
|
||||
});
|
||||
}
|
||||
|
||||
ThreadedSyntaxHighlighterRunner::~ThreadedSyntaxHighlighterRunner()
|
||||
{
|
||||
m_thread.quit();
|
||||
m_thread.wait();
|
||||
}
|
||||
|
||||
KSyntaxHighlighting::Definition ThreadedSyntaxHighlighterRunner::getDefinition()
|
||||
{
|
||||
KSyntaxHighlighting::Definition definition;
|
||||
QMetaObject::invokeMethod(
|
||||
d.get(),
|
||||
[this, &definition] { definition = d->getDefinition(); },
|
||||
Qt::BlockingQueuedConnection);
|
||||
return definition;
|
||||
}
|
||||
|
||||
} // namespace TextEditor
|
||||
|
||||
#include "syntaxhighlighterrunner.moc"
|
||||
Reference in New Issue
Block a user