src/libs/cplusplus/ASTPath.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 CPLUSPLUS_ASTPATH_H
  35 #define CPLUSPLUS_ASTPATH_H
  36
  37 #include <ASTfwd.h>
  38 #include <ASTVisitor.h>
  39
  40 #include "CppDocument.h"
  41
  42 #include <QtCore/QList>
  43 #include <QtGui/QTextCursor>
  44
  45 #undef DEBUG_AST_PATH
  46
  47 namespace CPlusPlus {
  48
  49 class CPLUSPLUS_EXPORT ASTPath: public ASTVisitor
  50 {
  51 public:
  52     ASTPath(Document::Ptr doc)
  53         : ASTVisitor(doc->translationUnit()),
  54           _doc(doc), _line(0), _column(0)
  55     {}
  56
  57     QList<AST *> operator()(const QTextCursor &cursor)
  58     { return this->operator()(cursor.blockNumber(), cursor.positionInBlock()); }
  59
  60     /// line and column are 0-based!
  61     QList<AST *> operator()(int line, int column);
  62
  63 #ifdef DEBUG_AST_PATH
  64     static void dump(const QList<AST *> nodes);
  65 #endif
  66
  67 protected:
  68     virtual bool preVisit(AST *ast);
  69
  70 private:
  71     Document::Ptr _doc;
  72     unsigned _line;
  73     unsigned _column;
  74     QList<AST *> _nodes;
  75 };
  76
  77 } // namespace CppTools
  78
  79 #endif // CPLUSPLUS_ASTPATH_H