aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/vcsbase/baseannotationhighlighter.h
blob: 4b29697fe61f514443dcae9864f36347acc28d2b (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "vcsbase_global.h"

#include <texteditor/syntaxhighlighter.h>

#include <QRegularExpression>

namespace VcsBase {
class BaseAnnotationHighlighterPrivate;

class Annotation
{
public:
    QRegularExpression separatorPattern;
    QRegularExpression entryPattern;
};

class VCSBASE_EXPORT BaseAnnotationHighlighter : public TextEditor::SyntaxHighlighter
{
    Q_OBJECT

public:
    typedef  QSet<QString> ChangeNumbers;

    explicit BaseAnnotationHighlighter(const Annotation &annotation);
    ~BaseAnnotationHighlighter() override;


    void highlightBlock(const QString &text) override;

    void setFontSettings(const TextEditor::FontSettings &fontSettings) override;

public slots:
    void rehighlight() override;

protected:
    void documentChanged(QTextDocument *oldDoc, QTextDocument *newDoc) override;

private:
    // Implement this to return the change number of a line
    virtual QString changeNumber(const QString &block) const = 0;
    void setChangeNumbers(const ChangeNumbers &changeNumbers);
    void setChangeNumbersForAnnotation();

    BaseAnnotationHighlighterPrivate *const d;
    friend class BaseAnnotationHighlighterPrivate;
};

} // namespace VcsBase