src/libs/cplusplus/BackwardsScanner.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 #ifndef CPLUSPLUS_BACKWARDSSCANNER_H
  34 #define CPLUSPLUS_BACKWARDSSCANNER_H
  35
  36 #include "SimpleLexer.h"
  37
  38 #include <QtGui/QTextCursor>
  39 #include <QtGui/QTextBlock>
  40
  41 namespace CPlusPlus {
  42
  43 class CPLUSPLUS_EXPORT BackwardsScanner
  44 {
  45     enum { MAX_BLOCK_COUNT = 10 };
  46
  47 public:
  48     explicit BackwardsScanner(const QTextCursor &cursor,
  49                               int maxBlockCount = MAX_BLOCK_COUNT,
  50                               const QString &suffix = QString(),
  51                               bool skipComments = true);
  52
  53     int startToken() const;
  54
  55     int startPosition() const;
  56
  57     QString text() const;
  58     QString mid(int index) const;
  59
  60     QString text(int index) const;
  61     QStringRef textRef(int index) const;
  62     // 1-based
  63     Token LA(int index) const;
  64
  65     // n-la token is [startToken - n]
  66     Token operator[](int index) const; // ### deprecate
  67
  68     QString indentationString(int index) const;
  69
  70     int startOfLine(int index) const;
  71     int startOfMatchingBrace(int index) const;
  72     int startOfBlock(int index) const;
  73
  74     int size() const;
  75
  76     static int previousBlockState(const QTextBlock &block);
  77
  78 private:
  79     const Token &fetchToken(int tokenIndex);
  80
  81 private:
  82     QList<Token> _tokens;
  83     int _offset;
  84     int _blocksTokenized;
  85     QTextBlock _block;
  86     SimpleLexer _tokenize;
  87     QString _text;
  88     int _maxBlockCount;
  89     int _startToken;
  90 };
  91
  92 } // end of namespace CPlusPlus
  93
  94 #endif // CPLUSPLUS_BACKWARDSSCANNER_H