src/plugins/texteditor/generichighlighter/context.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 CONTEXT_H
  35 #define CONTEXT_H
  36
  37 #include "includerulesinstruction.h"
  38
  39 #include <QtCore/QString>
  40 #include <QtCore/QList>
  41 #include <QtCore/QSharedPointer>
  42
  43 namespace TextEditor {
  44 namespace Internal {
  45
  46 class Rule;
  47 class HighlightDefinition;
  48
  49 class Context
  50 {
  51 public:
  52     Context();
  53     Context(const Context &context);
  54     const Context &operator=(Context copy);
  55     ~Context();
  56
  57     void configureId(const int unique);
  58     const QString &id() const;
  59
  60     void setName(const QString &name);
  61     const QString &name() const;
  62
  63     void setLineBeginContext(const QString &context);
  64     const QString &lineBeginContext() const;
  65
  66     void setLineEndContext(const QString &context);
  67     const QString &lineEndContext() const;
  68
  69     void setFallthroughContext(const QString &context);
  70     const QString &fallthroughContext() const;
  71
  72     void setItemData(const QString &itemData);
  73     const QString &itemData() const;
  74
  75     void setFallthrough(const QString &fallthrough);
  76     bool isFallthrough() const;
  77
  78     void setDynamic(const QString &dynamic);
  79     bool isDynamic() const;
  80     void updateDynamicRules(const QStringList &captures) const;
  81
  82     void addRule(const QSharedPointer<Rule> &rule);
  83     void addRule(const QSharedPointer<Rule> &rule, int index);
  84     const QList<QSharedPointer<Rule> > &rules() const;
  85
  86     void addIncludeRulesInstruction(const IncludeRulesInstruction &instruction);
  87     const QList<IncludeRulesInstruction> &includeRulesInstructions() const;
  88     void clearIncludeRulesInstructions();
  89
  90     void setDefinition(const QSharedPointer<HighlightDefinition> &definition);
  91     const QSharedPointer<HighlightDefinition> &definition() const;
  92
  93     void swap(Context &context);
  94
  95 private:
  96     QString m_id;
  97     QString m_name;
  98     QString m_lineBeginContext;
  99     QString m_lineEndContext;
 100     QString m_fallthroughContext;
 101     QString m_itemData;
 102     bool m_fallthrough;
 103     bool m_dynamic;
 104
 105     QList<QSharedPointer<Rule> > m_rules;
 106     QList<IncludeRulesInstruction> m_instructions;
 107
 108     QSharedPointer<HighlightDefinition> m_definition;
 109 };
 110
 111 } // namespace Internal
 112 } // namespace TextEditor
 113
 114 #endif // CONTEXT_H