aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/texteditor/syntaxhighlighterrunner.h
blob: ccb292ea08620d93c5d4d9b1ee3f7143c6edf511 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
// 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 <QObject>
#include <QPointer>

QT_BEGIN_NAMESPACE
class QTextDocument;
QT_END_NAMESPACE

namespace TextEditor {

class SyntaxHighlighterRunnerPrivate;

class TEXTEDITOR_EXPORT SyntaxHighlighterRunner : public QObject
{
    Q_OBJECT
public:
    using SyntaxHighlighterCreator = std::function<SyntaxHighlighter *()>;

    SyntaxHighlighterRunner(SyntaxHighlighter *highlighter, QTextDocument *document, bool async);
    virtual ~SyntaxHighlighterRunner();

    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; }
    bool useGenericHighlighter() const;

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

signals:
    void highlightingFinished();

private:
    void applyFormatRanges(const QList<SyntaxHighlighter::Result> &results);
    void changeDocument(int from, int charsRemoved, int charsAdded);

    SyntaxHighlighterRunnerPrivate *d;
    QPointer<QTextDocument> m_document = nullptr;
    SyntaxHighlighter::State m_syntaxInfoUpdated = SyntaxHighlighter::State::Done;
    bool m_useGenericHighlighter = false;
    QString m_definitionName;
    std::optional<QThread> m_thread;
};

} // namespace TextEditor