tests/auto/xmlpatternssdk/ASTItem.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  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, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef PatternistSDK_ASTItem_H
  43 #define PatternistSDK_ASTItem_H
  44
  45 #include <QList>
  46 #include <QString>
  47
  48 #include "TreeItem.h"
  49 #include "Global.h"
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 namespace QPatternistSDK
  56 {
  57     /**
  58      * @short Is a node in a ASTItem tree; each ASTItem contains
  59      * debug information about an QPatternist::Expression.
  60      *
  61      * ASTItem, by implementing TreeItem, leverages debug data about QPatternist::Expression
  62      * instances into Qt's model/view framework.
  63      *
  64      * @ingroup PatternistSDK
  65      * @author Frans Englich <frans.englich@nokia.com>
  66      */
  67     class Q_PATTERNISTSDK_EXPORT ASTItem : public TreeItem
  68     {
  69     public:
  70         virtual ~ASTItem();
  71         ASTItem(ASTItem *parent,
  72                 const QString &name,
  73                 const QString &details = QString(),
  74                 const QString &staticType = QString(),
  75                 const QString &reqType = QString());
  76
  77         virtual void appendChild(TreeItem *item);
  78         virtual TreeItem *child(const unsigned int row) const;
  79         virtual unsigned int childCount() const;
  80         virtual QVariant data(const Qt::ItemDataRole role, int column) const;
  81         virtual TreeItem::List children() const;
  82         virtual TreeItem *parent() const;
  83         int columnCount() const;
  84
  85         /**
  86          * Returns a string representation of this AST node, recursively including
  87          * children. For example, the query <tt>1 eq number()</tt> would result in the string:
  88          *
  89 @verbatim
  90 ValueComparison(eq)
  91   xs:integer(0)
  92   FunctionCall(fn:number)
  93     ContextItem
  94 @endverbatim
  95          */
  96         QString toString() const;
  97
  98     private:
  99         QString toString(const QString &indent) const;
 100
 101         const QString m_name;
 102         const QString m_details;
 103         const QString m_reqType;
 104         const QString m_staticType;
 105         TreeItem::List m_children;
 106         TreeItem *m_parent;
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif
 115 // vim: et:ts=4:sw=4:sts=4