src/plugins/texteditor/generichighlighter/progressdata.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 PROGRESSDATA_H
  35 #define PROGRESSDATA_H
  36
  37 #include <QtCore/QStringList>
  38
  39 namespace TextEditor {
  40 namespace Internal {
  41
  42 class Rule;
  43
  44 class ProgressData
  45 {
  46 public:
  47     ProgressData();
  48     ~ProgressData();
  49
  50     void setOffset(const int offset);
  51     int offset() const;
  52
  53     void incrementOffset();
  54     void incrementOffset(const int increment);
  55
  56     void saveOffset();
  57     void restoreOffset();
  58
  59     void setOnlySpacesSoFar(const bool onlySpaces);
  60     bool isOnlySpacesSoFar() const;
  61
  62     void setOpeningBraceMatchAtFirstNonSpace(const bool match);
  63     bool isOpeningBraceMatchAtFirstNonSpace() const;
  64
  65     void setClosingBraceMatchAtNonEnd(const bool match);
  66     bool isClosingBraceMatchAtNonEnd() const;
  67
  68     void clearBracesMatches();
  69
  70     void setWillContinueLine(const bool willContinue);
  71     bool isWillContinueLine() const;
  72
  73     void setCaptures(const QStringList &captures);
  74     const QStringList &captures() const;
  75
  76     void trackRule(Rule *rule);
  77
  78 private:
  79     int m_offset;
  80     int m_savedOffset;
  81     bool m_onlySpacesSoFar;
  82     bool m_openingBraceMatchAtFirstNonSpace;
  83     bool m_closingBraceMatchAtNonEnd;
  84     bool m_willContinueLine;
  85     QStringList m_captures;
  86     QList<Rule *> m_trackedRules;
  87 };
  88
  89 } // namespace Internal
  90 } // namespace TextEditor
  91
  92 #endif // PROGRESSDATA_H