src/xmlpatterns/projection/qprojectedexpression_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  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_ProjectedExpression_H
  53 #define Patternist_ProjectedExpression_H
  54
  55 #include <private/qitem_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     class ProjectedExpression
  64     {
  65     public:
  66         typedef ProjectedExpression * Ptr;
  67         typedef QVector<ProjectedExpression::Ptr> Vector;
  68         virtual ~ProjectedExpression()
  69         {
  70         }
  71
  72         enum Action
  73         {
  74             Move = 0,
  75             Skip = 1,
  76             Keep = 2,
  77             KeepSubtree = 4 | Keep
  78         };
  79
  80         virtual Action actionForElement(const QXmlName name,
  81                                         ProjectedExpression::Ptr &next) const
  82         {
  83             Q_UNUSED(name);
  84             Q_UNUSED(next);
  85             return Skip;
  86         }
  87
  88     };
  89
  90     class ProjectedNodeTest
  91     {
  92     public:
  93         typedef ProjectedNodeTest * Ptr;
  94         virtual ~ProjectedNodeTest()
  95         {
  96         }
  97
  98         virtual bool isMatch(const QXmlNodeModelIndex::NodeKind kind) const
  99         {
 100             Q_UNUSED(kind);
 101             return false;
 102         }
 103     };
 104
 105     class ProjectedStep : public ProjectedExpression
 106     {
 107     public:
 108         ProjectedStep(const ProjectedNodeTest::Ptr test,
 109                       const QXmlNodeModelIndex::Axis axis) : m_test(test),
 110                                                m_axis(axis)
 111         {
 112             Q_ASSERT(m_test);
 113         }
 114
 115         virtual Action actionForElement(const QXmlName name,
 116                                         ProjectedExpression::Ptr &next) const
 117         {
 118             Q_UNUSED(name);
 119             Q_UNUSED(next);
 120             // TODO
 121             return Skip;
 122         }
 123
 124     private:
 125         const ProjectedNodeTest::Ptr    m_test;
 126         const QXmlNodeModelIndex::Axis                m_axis;
 127     };
 128
 129     class ProjectedPath : public ProjectedExpression
 130     {
 131     public:
 132         ProjectedPath(const ProjectedExpression::Ptr left,
 133                       const ProjectedExpression::Ptr right) : m_left(left),
 134                                                               m_right(right)
 135         {
 136             Q_ASSERT(m_left);
 137             Q_ASSERT(m_right);
 138         }
 139
 140         virtual Action actionForElement(const QXmlName name,
 141                                         ProjectedExpression::Ptr &next) const
 142         {
 143             ProjectedExpression::Ptr &candidateNext = next;
 144             const Action a = m_left->actionForElement(name, candidateNext);
 145
 146             if(a != Skip)
 147             {
 148                 /* The test accepted it, so let's replace us with the new step. */
 149                 next = candidateNext;
 150             }
 151
 152             return a;
 153         }
 154
 155     private:
 156         const ProjectedExpression::Ptr  m_left;
 157         const ProjectedExpression::Ptr  m_right;
 158     };
 159 }
 160
 161 QT_END_NAMESPACE
 162
 163 QT_END_HEADER
 164
 165 #endif