src/xmlpatterns/expr/qaxisstep_p.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 QtXmlPatterns module 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 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_AxisStep_H
  53 #define Patternist_AxisStep_H
  54
  55 #include <private/qemptycontainer_p.h>
  56 #include <private/qitem_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short A step in a path expression that with an axis and a node test evaluates
  66      * to a sequence of nodes from the context item.
  67      *
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      * @ingroup Patternist_expressions
  70      */
  71     class Q_AUTOTEST_EXPORT AxisStep : public EmptyContainer
  72     {
  73     public:
  74         AxisStep(const QXmlNodeModelIndex::Axis axis,
  75                  const ItemType::Ptr &nodeTest);
  76
  77         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
  78         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  79
  80         /**
  81          * Returns @p node if it matches the node test this step is using, otherwise @c null.
  82          */
  83         inline Item mapToItem(const QXmlNodeModelIndex &node,
  84                               const DynamicContext::Ptr &context) const;
  85
  86         virtual SequenceType::List expectedOperandTypes() const;
  87         virtual SequenceType::Ptr staticType() const;
  88
  89         /**
  90          * Rewrites to ParentNodeAxis, if possible.
  91          */
  92         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  93                                           const SequenceType::Ptr &reqType);
  94
  95         /**
  96          * @returns always BuiltinTypes::node;
  97          */
  98         virtual ItemType::Ptr expectedContextItemType() const;
  99
 100         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 101
 102         virtual Properties properties() const;
 103
 104         /**
 105          * @returns the axis this step is using.
 106          */
 107         QXmlNodeModelIndex::Axis axis() const;
 108
 109         /**
 110          * @returns the node test this step is using.
 111          */
 112         inline ItemType::Ptr nodeTest() const
 113         {
 114             return m_nodeTest;
 115         }
 116
 117         void setNodeTest(const ItemType::Ptr &nev)
 118         {
 119             m_nodeTest = nev;
 120         }
 121
 122         /**
 123          * @short Prints the EBNF name corresponding to @p axis.
 124          *
 125          * For instance, for QXmlNodeModelIndex::Child, "child" is returned.
 126          *
 127          * Apart from being used in this class, it is used in the SDK.
 128          */
 129         static QString axisName(const QXmlNodeModelIndex::Axis axis);
 130
 131         virtual ID id() const;
 132         virtual PatternPriority patternPriority() const;
 133
 134         inline void setAxis(const QXmlNodeModelIndex::Axis newAxis);
 135
 136     private:
 137         typedef QExplicitlySharedDataPointer<const AxisStep> ConstPtr;
 138
 139         static const QXmlNodeModelIndex::NodeKind s_whenAxisNodeKindEmpty[];
 140
 141         /**
 142          * @returns @c true when the axis @p axis and a node test testing node of
 143          * type @p nodeKind always produces an empty sequence. One such example
 144          * is <tt>attribute::comment()</tt>.
 145          */
 146         static bool isAlwaysEmpty(const QXmlNodeModelIndex::Axis axis,
 147                                   const QXmlNodeModelIndex::NodeKind nodeKind);
 148
 149         /**
 150          * The reason this variable is mutable, is that in the case of XSL-T patterns,
 151          * we do quite some reordering.
 152          */
 153         QXmlNodeModelIndex::Axis    m_axis;
 154         ItemType::Ptr               m_nodeTest;
 155     };
 156
 157     void AxisStep::setAxis(const QXmlNodeModelIndex::Axis newAxis)
 158     {
 159         m_axis = newAxis;
 160     }
 161
 162 }
 163
 164 QT_END_NAMESPACE
 165
 166 QT_END_HEADER
 167
 168 #endif