src/xmlpatterns/expr/qcopyof_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_CopyOf_H
  53 #define Patternist_CopyOf_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Does node copying in a parameterized way, in order to deal with
  65      * namespace preservation/inheritance.
  66      *
  67      * If someone tries to call evaluateEBV(), evaluateSingleton() or
  68      * evaluateSequence() on us, we will infinitely loop. But apparently
  69      * that's not possible because we're always a child of ElementConstructor,
  70      * currently.
  71      *
  72      * @author Frans Englich <frans.englich@nokia.com>
  73      * @ingroup Patternist_expressions
  74      */
  75     class CopyOf : public SingleContainer
  76     {
  77     public:
  78         /**
  79          * Creats a CopyOf where it is checked that the expression @p operand conforms
  80          * to the type @p reqType.
  81          */
  82         CopyOf(const Expression::Ptr &operand,
  83                const bool inheritNSS,
  84                const bool preserveNSS);
  85
  86         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
  87
  88         /**
  89          * @returns always the SequenceType passed in the constructor to this class. That is, the
  90          * SequenceType that the operand must conform to.
  91          */
  92         virtual SequenceType::Ptr staticType() const;
  93
  94         /**
  95          * @returns a list containing one CommonSequenceTypes::ZeroOrMoreItems
  96          */
  97         virtual SequenceType::List expectedOperandTypes() const;
  98
  99         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 100
 101         inline Item mapToItem(const Item &source,
 102                               const DynamicContext::Ptr &context) const;
 103
 104         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 105
 106         virtual Properties properties() const;
 107         virtual ItemType::Ptr expectedContextItemType() const;
 108
 109     private:
 110         typedef QExplicitlySharedDataPointer<const CopyOf> ConstPtr;
 111         const bool                                      m_inheritNamespaces;
 112         const bool                                      m_preserveNamespaces;
 113         const QAbstractXmlNodeModel::NodeCopySettings   m_settings;
 114     };
 115 }
 116
 117 QT_END_NAMESPACE
 118
 119 QT_END_HEADER
 120
 121 #endif