qt-creator/src/plugins/texteditor/syntaxhighlighterrunner.h

// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include <texteditor/fontsettings.h>
#include <texteditor/syntaxhighlighter.h>
#include <texteditor/texteditorsettings.h>

#include <KSyntaxHighlighting/Definition>

#include <QObject>
#include <QPointer>

QT_BEGIN_NAMESPACE
class QTextDocument;
QT_END_NAMESPACE

namespace TextEditor {

class SyntaxHighlighterRunnerPrivate;

class TEXTEDITOR_EXPORT BaseSyntaxHighlighterRunner : public QObject
{
    Q_OBJECT
public:
    using SyntaxHighLighterCreator = std::function<SyntaxHighlighter *()>;
    struct BlockPreeditData {
        int position;
        QString text;
    };

    BaseSyntaxHighlighterRunner(SyntaxHighLighterCreator creator,
                                QTextDocument *document,
                                const TextEditor::FontSettings &fontSettings
                                = TextEditorSettings::fontSettings());
    virtual ~BaseSyntaxHighlighterRunner();

    void setExtraFormats(const QMap<int, QList<QTextLayout::FormatRange>> &formats);
    void clearExtraFormats(const QList<int> &blockNumbers);
    void clearAllExtraFormats();
    void setFontSettings(const TextEditor::FontSettings &fontSettings);
    void setLanguageFeaturesFlags(unsigned int flags);
    void setEnabled(bool enabled);
    void rehighlight();

    QString definitionName();
    void setDefinitionName(const QString &name);

    QTextDocument *document() const { return m_document; }
    SyntaxHighLighterCreator creator() const { return m_creator; }

    bool syntaxInfoUpdated() const { return m_syntaxInfoUpdated == SyntaxHighlighter::State::Done; }
signals:
    void highlightingFinished();

protected:
    std::unique_ptr<SyntaxHighlighterRunnerPrivate> d;
    QPointer<QTextDocument> m_document = nullptr;
    void applyFormatRanges(const SyntaxHighlighter::Result &result);
    void changeDocument(int from, int charsRemoved, int charsAdded);

    SyntaxHighlighter::State m_syntaxInfoUpdated = SyntaxHighlighter::State::Done;

private:
    SyntaxHighLighterCreator m_creator;
    QString m_definitionName;
};

class TEXTEDITOR_EXPORT ThreadedSyntaxHighlighterRunner : public BaseSyntaxHighlighterRunner
{
public:
    ThreadedSyntaxHighlighterRunner(SyntaxHighLighterCreator SyntaxHighLighterCreator,
                                    QTextDocument *document);
    ~ThreadedSyntaxHighlighterRunner();

private:
    QThread m_thread;
};

} // namespace TextEditor