Warning, file /education/cantor/src/lib/defaulthighlighter.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

 /*
     SPDX-License-Identifier: GPL-2.0-or-later
     SPDX-FileCopyrightText: 2009 Alexander Rieder <alexanderrieder@gmail.com>
 */
 
 #ifndef DEFAULTHIGHLIGHTER_H
 #define DEFAULTHIGHLIGHTER_H
 
 #include "cantor_export.h"
 
 #include <QRegularExpression>
 #include <QSyntaxHighlighter>
 
 class QGraphicsTextItem;
 
 namespace Cantor
 {
 class DefaultHighlighterPrivate;
 class Session;
 
 /**
  * The DefaultHighlighter is an implementation QSyntaxHighlighter.
  * It covers most common cases of syntax highlighting for Cantor's command entries.
  *
  * When creating a custom highlighter, for example for a new backend, you should use
  * the provided functions addPairs(), addRule() and/or addRules().
  *
  * If you need more specific functionality, subclass highlightBlock(). Usually it's a good idea to also call
  * DefaultHighlighter's implementation from it.
  *
  * @author Alexander Rieder
  */
 
 class CANTOR_EXPORT DefaultHighlighter : public QSyntaxHighlighter
 {
   Q_OBJECT
   public:
     explicit DefaultHighlighter(QObject* parent);
     explicit DefaultHighlighter(QObject* parent, Session* session);
     virtual ~DefaultHighlighter() override;
 
     /**
      * Change the item being highlighted.
      */
     void setTextItem(QGraphicsTextItem* item);
 
   public Q_SLOTS:
     /**
      * Called when the cursor moved. Rehighlights accordingly.
      */
     void positionChanged(const QTextCursor&);
 
   protected Q_SLOTS:
     /**
      * Convenience method, equivalent to @code addRules(functions, functionFormat()) @endcode
      */
     void addFunctions(const QStringList& functions);
     /**
      * Convenience method, equivalent to @code addRules(variables, variableFormat()) @endcode
      */
     void addVariables(const QStringList& variables);
     /**
      * Removes any rules previously added for the word @p word
      */
     void removeRule(const QString& word);
     /**
      * Convenience method, removes all rules with conditions from @p conditions
      * @sa removeRule, addRules
      */
     void removeRules(const QStringList& conditions);
 
   protected:
     /**
      * This method is called by Cantor's KTextEdit and is where all the highlighting must take place.
      * The default implementation calls highlightPairs(), highlightWords() and highlightRegExps().
      *
      */
     void highlightBlock(const QString& text) override;
 
     virtual QStringList parseBlockTextToWords(const QString& text);
 
     bool skipHighlighting(const QString& text);
 
     QTextCharFormat functionFormat() const;
     QTextCharFormat variableFormat() const;
     QTextCharFormat objectFormat() const;
     QTextCharFormat keywordFormat() const;
     QTextCharFormat numberFormat() const;
     QTextCharFormat operatorFormat() const;
     QTextCharFormat errorFormat() const;
     QTextCharFormat commentFormat() const;
     QTextCharFormat stringFormat() const;
     QTextCharFormat matchingPairFormat() const;
     QTextCharFormat mismatchingPairFormat() const;
 
     /**
      * Call this to add a pair of symbols for highlighting.
      * The default implementation of the class already adds (), {} and [], so no need to add those.
      * For example, if you wanted to highlight angle-brackets, you would use:
      * @code
      * addPair('<', '>');
      * @endcode
      * @param openSymbol the opening symbol of the pair
      * @param closeSymbol the closing symbol of the pair
      * @sa highlightPairs
      */
     void addPair(QChar openSymbol, QChar closeSymbol);
     /**
      * Highlights all instances of the @p word in the text with the specified @p format
      * @param word the word to highlight
      * @param format the format to be used for displaying the word
      */
     void addRule(const QString& word, const QTextCharFormat& format);
     /**
      * Highlights all parts of the text matched by the regular expression @p regexp in the text
      * with the specified @p format
      * @param regexp the regular expression used to look for matches
      * @param format the format used to display the matching parts of the text
      */
     void addRule(const QRegularExpression& regexp, const QTextCharFormat& format);
 
     /**
      * Convenience method, highlights all items in @p conditions with the specified @p format
      * @code
      * QStringList greenWords;
      * greenWords << "tree" << "forest" << "grass";
      * addRules(greenWords, greenWordFormat);
      * @endcode
      * @param conditions any Qt container of QRegularExpression or QString.
      * @param format the format used to display the matching parts of the text
      */
     void addRules(const QStringList& conditions, const QTextCharFormat& format);
     /**
      * Convenience method, equivalent to @code addRules(keywords, keywordFormat()) @endcode
      */
     void addKeywords(const QStringList& keywords);
     /**
      * Removes any rules previously added for the regular expression @p regexp
      */
     void removeRule(const QRegularExpression& regex);
 
     /**
      * Highlight pairs added with addPair()
      * @sa addPair
      */
     void highlightPairs(const QString& text);
     /**
      * Highlights words added with addRule()
      * @sa addRule, addRules
      */
     void highlightWords(const QString& text);
     /**
      * Highlights all matches from regular expressions added with addRule()
      * @sa addRule, addRules
      */
     void highlightRegExps(const QString& text);
 
     /**
      * Returns a string  that contains a regular expression that matches for characters thar are allowed inside
      * words for this backend. For example, maxima or scilab allow % at the beginning of variable names
      */
     virtual QString nonSeparatingCharacters() const;
 
   private Q_SLOTS:
     void updateFormats();
 
   Q_SIGNALS:
     void rulesChanged();
 
   private:
     DefaultHighlighterPrivate* d;
 };
 }
 
 #endif