editors/sc-ide/widgets/code_editor/highlighter.hpp

   1 /*
   2     SuperCollider Qt IDE
   3     Copyright (c) 2012 Jakob Leben & Tim Blechmann
   4     http://www.audiosynth.com
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  19 */
  20
  21 #ifndef SCIDE_SC_SYNTAX_HIGHLIGHTER_HPP_INCLUDED
  22 #define SCIDE_SC_SYNTAX_HIGHLIGHTER_HPP_INCLUDED
  23
  24 #include "tokens.hpp"
  25
  26 #include <QSyntaxHighlighter>
  27 #include <QVector>
  28
  29 namespace ScIDE {
  30
  31 namespace Settings { class Manager; }
  32
  33 class Main;
  34
  35 enum SyntaxFormat
  36 {
  37     PlainFormat,
  38     ClassFormat,
  39     KeywordFormat,
  40     BuiltinFormat,
  41     PrimitiveFormat,
  42     SymbolFormat,
  43     StringFormat,
  44     CharFormat,
  45     NumberFormat,
  46     EnvVarFormat,
  47     CommentFormat,
  48
  49     FormatCount
  50 };
  51
  52 struct SyntaxRule
  53 {
  54     SyntaxRule(): type(Token::Unknown) {}
  55     SyntaxRule( Token::Type t, const QString &s ): type(t), expr(s) {}
  56
  57     Token::Type type;
  58     QRegExp expr;
  59 };
  60
  61 class SyntaxHighlighterGlobals : public QObject
  62 {
  63     Q_OBJECT
  64
  65 public:
  66     SyntaxHighlighterGlobals( Main *, Settings::Manager * settings );
  67
  68     inline const QTextCharFormat * formats() const
  69     {
  70         return mFormats;
  71     }
  72
  73     inline const QTextCharFormat & format( SyntaxFormat type ) const
  74     {
  75         return mFormats[type];
  76     }
  77
  78     inline static const SyntaxHighlighterGlobals * instance() { Q_ASSERT(mInstance); return mInstance; }
  79
  80 public Q_SLOTS:
  81     void applySettings( Settings::Manager * );
  82
  83 Q_SIGNALS:
  84     void syntaxFormatsChanged();
  85
  86 private:
  87     friend class SyntaxHighlighter;
  88
  89     void initSyntaxRules();
  90     void initKeywords();
  91     void initBuiltins();
  92     void applySettings( Settings::Manager*, const QString &key, SyntaxFormat );
  93
  94     QTextCharFormat mFormats[FormatCount];
  95     QVector<SyntaxRule> mInCodeRules;
  96     QRegExp mInSymbolRegexp, mInStringRegexp;
  97
  98     static SyntaxHighlighterGlobals *mInstance;
  99 };
 100
 101 class SyntaxHighlighter:
 102     public QSyntaxHighlighter
 103 {
 104     Q_OBJECT
 105
 106     static const int inCode = 0;
 107     static const int inString = 1;
 108     static const int inSymbol = 2;
 109     static const int inComment = 100;
 110     // NOTE: Integers higher than inComment are reserved for multi line comments,
 111     // and indicate the comment nesting level!
 112
 113 public:
 114     SyntaxHighlighter(QTextDocument *parent = 0);
 115
 116 private:
 117     void highlightBlock(const QString &text);
 118     void highlightBlockInCode(const QString& text, int & currentIndex, int & currentState);
 119     void highlightBlockInString(const QString& text, int & currentIndex, int & currentState);
 120     void highlightBlockInSymbol(const QString& text, int & currentIndex, int & currentState);
 121     void highlightBlockInComment(const QString& text, int & currentIndex, int & currentState);
 122
 123     Token::Type findMatchingRule(QString const & text, int & currentIndex, int & lengthOfMatch);
 124
 125     const SyntaxHighlighterGlobals *mGlobals;
 126 };
 127
 128 }
 129
 130 #endif