blob: c19cb798dd17f6ba34932826de74489852b79a18 (
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
63
64
65
66
67
68
69
|
/*
SPDX-FileCopyrightText: 2016 Volker Krause <vkrause@kde.org>
SPDX-License-Identifier: MIT
*/
#ifndef KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
#define KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
#include "ksyntaxhighlighting_export.h"
#include "abstracthighlighter.h"
#include <QSyntaxHighlighter>
namespace KSyntaxHighlighting
{
class SyntaxHighlighterPrivate;
/** A QSyntaxHighlighter implementation for use with QTextDocument.
* This supports partial re-highlighting during editing and
* tracks syntax-based code folding regions.
*
* @since 5.28
*/
class KSYNTAXHIGHLIGHTING_EXPORT SyntaxHighlighter : public QSyntaxHighlighter, public AbstractHighlighter
{
Q_OBJECT
public:
explicit SyntaxHighlighter(QObject *parent = nullptr);
explicit SyntaxHighlighter(QTextDocument *document);
~SyntaxHighlighter() override;
void setDefinition(const Definition &def) override;
void setTheme(const Theme &theme) override;
/** Returns whether there is a folding region beginning at @p startBlock.
* This only considers syntax-based folding regions,
* not indention-based ones as e.g. found in Python.
*
* @see findFoldingRegionEnd
*/
bool startsFoldingRegion(const QTextBlock &startBlock) const;
/** Finds the end of the folding region starting at @p startBlock.
* If multiple folding regions begin at @p startBlock, the end of
* the last/innermost one is returned.
* This returns an invalid block if no folding region end is found,
* which typically indicates an unterminated region and thus folding
* until the document end.
* This method performs a sequential search starting at @p startBlock
* for the matching folding region end, which is a potentially expensive
* operation.
*
* @see startsFoldingRegion
*/
QTextBlock findFoldingRegionEnd(const QTextBlock &startBlock) const;
protected:
void highlightBlock(const QString &text) override;
void applyFormat(int offset, int length, const Format &format) override;
void applyFolding(int offset, int length, FoldingRegion region) override;
private:
Q_DECLARE_PRIVATE_D(AbstractHighlighter::d_ptr, SyntaxHighlighter)
};
}
#endif // KSYNTAXHIGHLIGHTING_QSYNTAXHIGHLIGHTER_H
|
