src/plugins/qmljseditor/qmljshighlighter.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef QSCRIPTSYNTAXHIGHLIGHTER_H
  35 #define QSCRIPTSYNTAXHIGHLIGHTER_H
  36
  37 #include "qmljseditor_global.h"
  38
  39 #include <qmljs/qmljsscanner.h>
  40
  41 #include <QtCore/QVector>
  42 #include <QtCore/QSet>
  43 #include <QtGui/QSyntaxHighlighter>
  44
  45 #include <texteditor/basetextdocumentlayout.h>
  46 #include <texteditor/syntaxhighlighter.h>
  47
  48 namespace QmlJSEditor {
  49
  50 class QMLJSEDITOR_EXPORT Highlighter : public TextEditor::SyntaxHighlighter
  51 {
  52     Q_OBJECT
  53
  54 public:
  55     Highlighter(QTextDocument *parent = 0);
  56     virtual ~Highlighter();
  57
  58     enum {
  59         NumberFormat,
  60         StringFormat,
  61         TypeFormat,
  62         KeywordFormat,
  63         FieldFormat,
  64         CommentFormat,
  65         VisualWhitespace,
  66         NumFormats
  67     };
  68
  69     bool isQmlEnabled() const;
  70     void setQmlEnabled(bool duiEnabled);
  71     void setFormats(const QVector<QTextCharFormat> &formats);
  72
  73 protected:
  74     virtual void highlightBlock(const QString &text);
  75
  76     int onBlockStart();
  77     void onBlockEnd(int state);
  78
  79     // The functions are notified whenever parentheses are encountered.
  80     // Custom behaviour can be added, for example storing info for indenting.
  81     void onOpeningParenthesis(QChar parenthesis, int pos, bool atStart);
  82     void onClosingParenthesis(QChar parenthesis, int pos, bool atEnd);
  83
  84     bool maybeQmlKeyword(const QStringRef &text) const;
  85     bool maybeQmlBuiltinType(const QStringRef &text) const;
  86
  87 private:
  88     typedef TextEditor::Parenthesis Parenthesis;
  89     typedef TextEditor::Parentheses Parentheses;
  90
  91     bool m_qmlEnabled;
  92     int m_braceDepth;
  93     int m_foldingIndent;
  94     bool m_inMultilineComment;
  95
  96     QmlJS::Scanner m_scanner;
  97     Parentheses m_currentBlockParentheses;
  98
  99     QTextCharFormat m_formats[NumFormats];
 100 };
 101
 102 } // end of namespace QmlJSEditor
 103
 104 #endif // QSCRIPTSYNTAXHIGHLIGHTER_H