daq::QTUtils::Highlighter Class Reference

#include <highlighter.hpp>

Inheritance diagram for daq::QTUtils::Highlighter:

Collaboration diagram for daq::QTUtils::Highlighter:

Classes
struct	FormatCache
struct	HighlightingRule

Public Member Functions
	Highlighter (QTextDocument *parent=0)
	ctor
void	setRule (QRegExp r, QTextCharFormat f)
void	highlightAll (const QString &txt, bool caseSensitivity)

Protected Member Functions
void	highlightBlock (const QString &text)

Private Attributes
QVector< HighlightingRule >	highlightingRules
	highlighting rules
QRegExp	highlightAllReg
	regexp containing text to highlight
QMutex *	mutex
	mutex to protect highlightBlock method
QHash< uint, QList< FormatCache > >	cache
	stores result of formatting for a given QString text (using uint qHash(QString) method)

Detailed Description

This class provides custom highlighting of textedits. It is possible to define any number of patterns (using regular expressions) and a format to be applied to the given pattern. It also provides functionality to highlight all occocurences of a given text using the

highlightAll(const QString &txt, bool caseSensitive) 

method. For example in dvs_gui it is used to highlight the log outputs. Usage:

Highlighter* hl = new Highlighter(textedit->document());
QTextCharFormat format;
format.setForeGround(Qt::darkRed);
pattern = QRegExp("FAILED");
hl->setRule(pattern,format);

Definition at line 29 of file highlighter.hpp.

Constructor & Destructor Documentation

Highlighter()

Highlighter::Highlighter

(

QTextDocument *

parent = 0

)

ctor

Creates highlighter. Initializes the mutex.

Definition at line 10 of file highlighter.cpp.

        : QSyntaxHighlighter(parent)
{
    mutex = new QMutex();
}

Member Function Documentation

highlightAll()

void daq::QTUtils::Highlighter::highlightAll ( const QString & txt, bool caseSensitivity )

inline

Updates the text to highlight and rechecks the entire text

Parameters

txt	The text to highlight
caseSensitivity	whether the highlighting is case sensitive or not

Definition at line 55 of file highlighter.hpp.

    {
        highlightAllReg.setPattern(txt);
        if(caseSensitivity)
            highlightAllReg.setCaseSensitivity(Qt::CaseSensitive);
        else
            highlightAllReg.setCaseSensitivity(Qt::CaseInsensitive);
        rehighlight();
    }

highlightBlock()

void Highlighter::highlightBlock ( const QString & text )

protected

Highlights a block of text according to the given rules (regexp + QTextCharFormat) Uses a cache for performance reasons. This way we do not have to run regexps every time.

Parameters

text	text to highlight. Used to calculate the hash and hence cache value

Reapply the stored formattings

Apply formatting using regexp and store it in cache for later use

Note. we should not cache highlighting as it changes all the time

Definition at line 21 of file highlighter.cpp.

{
    QMutexLocker locker(mutex);
    
    /*
     * check if we have formatted this text before
     * If so there is no need to run regexp again and we can simply reapply the cached formatting.
     * Remember to clear the cache if new rules are added after it has been filled (not likely)
     */
    uint hash = qHash(text);
    if(cache.contains(hash)) 
    {
        FormatCache form;
        foreach(form,cache.value(hash)){
            for(int i =0; i < form.indexes.size();i++)
            {
                setFormat(form.indexes.at(i), form.lengths.at(i), form.rule.format);
            }
        }
    }
    else
    {
        QList<FormatCache> forms; //list of all formatting being done
        foreach (HighlightingRule rule, highlightingRules)
        {
            FormatCache form;
            form.rule = rule; //store the rule 
            QRegExp expression(rule.pattern);
            int index = text.indexOf(expression);
            int length;
            while (index >= 0)
            {
 
                length = expression.matchedLength();
                form.indexes.append(index); //store index 
                form.lengths.append(length);//store length
                setFormat(index, length, rule.format);
                index = text.indexOf(expression, index + length);
            }
            forms.append(form); //append this formatting (rule, indexes and lengths) to the list
        }
        cache.insert(hash,forms);//store list in cache
 
    }
    if(!highlightAllReg.isEmpty())
    {
        int index = text.indexOf(highlightAllReg);
        while (index >= 0)
        {
            int length = highlightAllReg.matchedLength();
            QTextCharFormat format;
            format.setBackground(Qt::yellow);
            setFormat(index, length, format);
            index = text.indexOf(highlightAllReg, index + length);
        }
    }
   
}

setRule()

void daq::QTUtils::Highlighter::setRule ( QRegExp r, QTextCharFormat f )

inline

Adds a highlighting rule to the list. We need to clear the cache in this case (though normally rules are added very rarely)

Parameters

r	Regular expression to identify the text to highlight
f	format to apply to the text

Definition at line 41 of file highlighter.hpp.

    {
        HighlightingRule rule;
        rule.pattern = r;
        rule.format = f;
        highlightingRules.append(rule);
        cache.clear();
 
    }

Member Data Documentation

cache

QHash<uint, QList<FormatCache> > daq::QTUtils::Highlighter::cache

private

stores result of formatting for a given QString text (using uint qHash(QString) method)

Definition at line 88 of file highlighter.hpp.

highlightAllReg

QRegExp daq::QTUtils::Highlighter::highlightAllReg

private

regexp containing text to highlight

Definition at line 86 of file highlighter.hpp.

highlightingRules

QVector<HighlightingRule> daq::QTUtils::Highlighter::highlightingRules

private

highlighting rules

Definition at line 85 of file highlighter.hpp.

mutex

QMutex* daq::QTUtils::Highlighter::mutex

private

mutex to protect highlightBlock method

Definition at line 87 of file highlighter.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/highlighter.hpp
• /github/workspace/dunedaq/sourcecode/dbe/src/qtutils/highlighter.cpp