#include <BasicXMLSyntaxHighlighter.h>

Inheritance diagram for BasicXMLSyntaxHighlighter:

Public Member Functions
	BasicXMLSyntaxHighlighter (QObject *parent)

	BasicXMLSyntaxHighlighter (QTextDocument *parent)

	BasicXMLSyntaxHighlighter (QTextEdit *parent)

void	setFormats ()

Protected Member Functions
void	highlightBlock (const QString &text) override

Private Member Functions
void	highlightByRegex (const QTextCharFormat &format, const QRegularExpression &regex, const QString &text)

void	setRegexes ()

Private Attributes
QTextCharFormat	m_xmlAttributeFormat

QRegularExpression	m_xmlAttributeRegex

QTextCharFormat	m_xmlCommentFormat

QRegularExpression	m_xmlCommentRegex

QTextCharFormat	m_xmlElementFormat

QRegularExpression	m_xmlElementRegex

QTextCharFormat	m_xmlKeywordFormat

QList< QRegularExpression >	m_xmlKeywordRegexes

QTextCharFormat	m_xmlValueFormat

QRegularExpression	m_xmlValueRegex

Detailed Description

A Basic XML syntax highlighter in C++/Qt (subclass of QSyntaxHighlighter). Uses simple regexes to highlight not very complicated XML content.

The primary limitations are:
No specific handling for nested quotes within attributes
No handling for multi-line comments

See also: https://github.com/d1vanov/basic-xml-syntax-highlighter

Definition at line 24 of file BasicXMLSyntaxHighlighter.h.

Constructor & Destructor Documentation

◆ BasicXMLSyntaxHighlighter() [1/3]

BasicXMLSyntaxHighlighter::BasicXMLSyntaxHighlighter ( QObject * parent )

Definition at line 14 of file BasicXMLSyntaxHighlighter.cpp.

                                                                     :
    QSyntaxHighlighter(parent)
{
    setRegexes();
    setFormats();
}

References setFormats(), and setRegexes().

◆ BasicXMLSyntaxHighlighter() [2/3]

BasicXMLSyntaxHighlighter::BasicXMLSyntaxHighlighter ( QTextDocument * parent )

Definition at line 21 of file BasicXMLSyntaxHighlighter.cpp.

                                                                           :
    QSyntaxHighlighter(parent)
{
    setRegexes();
    setFormats();
}

References setFormats(), and setRegexes().

◆ BasicXMLSyntaxHighlighter() [3/3]

BasicXMLSyntaxHighlighter::BasicXMLSyntaxHighlighter ( QTextEdit * parent )

Definition at line 28 of file BasicXMLSyntaxHighlighter.cpp.

                                                                       :
    QSyntaxHighlighter(parent)
{
    setRegexes();
    setFormats();
}

References setFormats(), and setRegexes().

Member Function Documentation

◆ highlightBlock()

void BasicXMLSyntaxHighlighter::highlightBlock ( const QString & text )

overrideprotected

Definition at line 35 of file BasicXMLSyntaxHighlighter.cpp.

{
    // Special treatment for xml element regex as we use captured text to emulate lookbehind
    QRegularExpressionMatchIterator i = m_xmlElementRegex.globalMatch(text);
    while (i.hasNext()) {
        QRegularExpressionMatch match = i.next();
        setFormat(match.capturedStart(0), match.capturedLength(0), m_xmlElementFormat);
    } 
 
    // Highlight xml keywords *after* xml elements to fix any occasional / captured into the enclosing element
    typedef QList<QRegularExpression>::const_iterator Iter;
    Iter xmlKeywordRegexesEnd = m_xmlKeywordRegexes.constEnd();
    for(Iter it = m_xmlKeywordRegexes.constBegin(); it != xmlKeywordRegexesEnd; ++it) {
        const QRegularExpression & regex = *it;
        highlightByRegex(m_xmlKeywordFormat, regex, text);
    }
 
    highlightByRegex(m_xmlAttributeFormat, m_xmlAttributeRegex, text);
    highlightByRegex(m_xmlCommentFormat, m_xmlCommentRegex, text);
    highlightByRegex(m_xmlValueFormat, m_xmlValueRegex, text);
}

References highlightByRegex(), m_xmlAttributeFormat, m_xmlAttributeRegex, m_xmlCommentFormat, m_xmlCommentRegex, m_xmlElementFormat, m_xmlElementRegex, m_xmlKeywordFormat, m_xmlKeywordRegexes, m_xmlValueFormat, and m_xmlValueRegex.

◆ highlightByRegex()

void BasicXMLSyntaxHighlighter::highlightByRegex	(	const QTextCharFormat &	format,
		const QRegularExpression &	regex,
		const QString &	text )

private

Definition at line 57 of file BasicXMLSyntaxHighlighter.cpp.

{
    QRegularExpressionMatchIterator i = regex.globalMatch(text);
    while (i.hasNext()) {
        QRegularExpressionMatch match = i.next();
        setFormat(match.capturedStart(0), match.capturedLength(0), format);
    } 
}

◆ setFormats()

void BasicXMLSyntaxHighlighter::setFormats ( )

Definition at line 80 of file BasicXMLSyntaxHighlighter.cpp.

{
    KConfigGroup cfg(KSharedConfig::openConfig(), "SvgTextTool");
    QColor background = cfg.readEntry("colorEditorBackground", qApp->palette().window().color());
 
    m_xmlKeywordFormat.setForeground(cfg.readEntry("colorKeyword", QColor(background.value() < 100 ? Qt::cyan : Qt::blue)));
    m_xmlKeywordFormat.setFontWeight(cfg.readEntry("BoldKeyword", true) ? QFont::Bold : QFont::Normal);
    m_xmlKeywordFormat.setFontItalic((cfg.readEntry("ItalicKeyword", false)));
 
    m_xmlElementFormat.setForeground(cfg.readEntry("colorElement", QColor(background.value() < 100 ? Qt::magenta : Qt::darkMagenta)));
    m_xmlElementFormat.setFontWeight(cfg.readEntry("BoldElement", true) ? QFont::Bold : QFont::Normal);
    m_xmlElementFormat.setFontItalic((cfg.readEntry("ItalicElement", false)));
 
    m_xmlAttributeFormat.setForeground(cfg.readEntry("colorAttribute", QColor(background.value() < 100 ? Qt::green : Qt::darkGreen)));
    m_xmlAttributeFormat.setFontWeight(cfg.readEntry("BoldAttribute", true) ? QFont::Bold : QFont::Normal);
    m_xmlAttributeFormat.setFontItalic((cfg.readEntry("ItalicAttribute", true)));
 
    m_xmlValueFormat.setForeground(cfg.readEntry("colorValue", QColor(background.value() < 100 ? Qt::red: Qt::darkRed)));
    m_xmlValueFormat.setFontWeight(cfg.readEntry("BoldValue", true) ? QFont::Bold : QFont::Normal);
    m_xmlValueFormat.setFontItalic(cfg.readEntry("ItalicValue", false));
 
    m_xmlCommentFormat.setForeground(cfg.readEntry("colorComment", QColor(background.value() < 100 ? Qt::lightGray : Qt::gray)));
    m_xmlCommentFormat.setFontWeight(cfg.readEntry("BoldComment", false) ? QFont::Bold : QFont::Normal);
    m_xmlCommentFormat.setFontItalic(cfg.readEntry("ItalicComment", false));
 
}

References m_xmlAttributeFormat, m_xmlCommentFormat, m_xmlElementFormat, m_xmlKeywordFormat, and m_xmlValueFormat.

◆ setRegexes()

void BasicXMLSyntaxHighlighter::setRegexes ( )

private

Definition at line 67 of file BasicXMLSyntaxHighlighter.cpp.

{
    m_xmlElementRegex.setPattern("<[\\s]*[/]?[\\s]*([^\\n]\\w*)(?=[\\s/>])");
    m_xmlAttributeRegex.setPattern("[\\w\\-]+(?=\\=)");
    m_xmlValueRegex.setPattern("\"[^\\n\"]+\"(?=[\\s/>])");
    m_xmlCommentRegex.setPattern("<!--[^\\n]*-->");
 
    m_xmlKeywordRegexes = QList<QRegularExpression>()
                                << QRegularExpression("<\\?") << QRegularExpression("/>")
                                << QRegularExpression(">") << QRegularExpression("<") << QRegularExpression("</")
                                << QRegularExpression("\\?>");
}