Files
qt-creator/src/plugins/texteditor/syntaxhighlighter.h
Lucie Gérard a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00

96 lines
2.8 KiB
C++

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include "texteditor_global.h"
#include <texteditor/texteditorconstants.h>
#include <QObject>
#include <QTextLayout>
#include <functional>
#include <climits>
QT_BEGIN_NAMESPACE
class QTextDocument;
class QSyntaxHighlighterPrivate;
class QTextCharFormat;
class QFont;
class QColor;
class QTextBlockUserData;
class QTextEdit;
QT_END_NAMESPACE
namespace TextEditor {
class FontSettings;
class SyntaxHighlighterPrivate;
class TEXTEDITOR_EXPORT SyntaxHighlighter : public QObject
{
Q_OBJECT
Q_DECLARE_PRIVATE(SyntaxHighlighter)
public:
SyntaxHighlighter(QObject *parent = nullptr);
SyntaxHighlighter(QTextDocument *parent);
SyntaxHighlighter(QTextEdit *parent);
~SyntaxHighlighter() override;
void setDocument(QTextDocument *doc);
QTextDocument *document() const;
void setExtraFormats(const QTextBlock &block, QVector<QTextLayout::FormatRange> &&formats);
void clearExtraFormats(const QTextBlock &block);
void clearAllExtraFormats();
static QList<QColor> generateColors(int n, const QColor &background);
// Don't call in constructors of derived classes
virtual void setFontSettings(const TextEditor::FontSettings &fontSettings);
TextEditor::FontSettings fontSettings() const;
void setNoAutomaticHighlighting(bool noAutomatic);
public slots:
void rehighlight();
void rehighlightBlock(const QTextBlock &block);
protected:
void setDefaultTextFormatCategories();
void setTextFormatCategories(int count, std::function<TextStyle(int)> formatMapping);
QTextCharFormat formatForCategory(int categoryIndex) const;
// implement in subclasses
// default implementation highlights whitespace
virtual void highlightBlock(const QString &text);
void setFormat(int start, int count, const QTextCharFormat &format);
void setFormat(int start, int count, const QColor &color);
void setFormat(int start, int count, const QFont &font);
QTextCharFormat format(int pos) const;
void formatSpaces(const QString &text, int start = 0, int count = INT_MAX);
void setFormatWithSpaces(const QString &text, int start, int count,
const QTextCharFormat &format);
int previousBlockState() const;
int currentBlockState() const;
void setCurrentBlockState(int newState);
void setCurrentBlockUserData(QTextBlockUserData *data);
QTextBlockUserData *currentBlockUserData() const;
QTextBlock currentBlock() const;
private:
void setTextFormatCategories(const QVector<std::pair<int, TextStyle>> &categories);
void reformatBlocks(int from, int charsRemoved, int charsAdded);
void delayedRehighlight();
QScopedPointer<SyntaxHighlighterPrivate> d_ptr;
};
} // namespace TextEditor