src/xmlpatterns/janitors/quntypedatomicconverter_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_UntypedAtomicConverter_H
  53 #define Patternist_UntypedAtomicConverter_H
  54
  55 #include <private/qitem_p.h>
  56 #include <private/qsinglecontainer_p.h>
  57 #include <private/qcastingplatform_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Casts every item in a sequence obtained from
  67      * evaluating an Expression, to a requested atomic type.
  68      *
  69      * The atomic values it casts from are instances of xs:untypedAtomic(hence
  70      * the name). Typically, the items are from an Atomizer. UntypedAtomicConverter
  71      * implements the automatic conversion which typically is activated when XPath
  72      * is handling untyped data.
  73      *
  74      * @see <a href="http://www.w3.org/TR/xpath20/#id-function-calls">XML Path
  75      * Language (XPath) 2.0, 3.1.5 Function Calls, in particular the
  76      * Function Conversion Rules</a>
  77      * @author Frans Englich <frans.englich@nokia.com>
  78      * @ingroup Patternist_expressions
  79      */
  80     class UntypedAtomicConverter : public SingleContainer,
  81                                    public CastingPlatform<UntypedAtomicConverter, true>
  82     {
  83     public:
  84         UntypedAtomicConverter(const Expression::Ptr &operand,
  85                                const ItemType::Ptr &reqType,
  86                                const ReportContext::ErrorCode code = ReportContext::FORG0001);
  87
  88         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  89         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
  90
  91         virtual SequenceType::Ptr staticType() const;
  92         virtual SequenceType::List expectedOperandTypes() const;
  93
  94         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  95
  96         /**
  97          * Overridden to call CastingPlatform::typeCheck()
  98          */
  99         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 100                                           const SequenceType::Ptr &reqType);
 101
 102         inline Item mapToItem(const Item &item,
 103                               const DynamicContext::Ptr &context) const;
 104
 105         inline ItemType::Ptr targetType() const
 106         {
 107             return m_reqType;
 108         }
 109
 110         virtual const SourceLocationReflection *actualReflection() const;
 111
 112     private:
 113         typedef QExplicitlySharedDataPointer<const UntypedAtomicConverter> ConstPtr;
 114         const ItemType::Ptr m_reqType;
 115     };
 116
 117     Item UntypedAtomicConverter::mapToItem(const Item &item, const DynamicContext::Ptr &context) const
 118     {
 119         return cast(item, context);
 120     }
 121 }
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif