src/xmlpatterns/expr/qcastas_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_CastAs_H
  53 #define Patternist_CastAs_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56 #include <private/qcastingplatform_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Implements XPath 2.0's <tt>cast as</tt> expression.
  66      *
  67      * Implements the casting expression, such as <tt>'3' cast as xs:integer</tt>. This class also
  68      * implements constructor functions, which are created in the ConstructorFunctionsFactory.
  69      *
  70      * CastAs uses CastingPlatform for carrying out the actual casting.
  71      *
  72      * @see <a href="http://www.w3.org/TR/xpath-functions/#casting">XQuery 1.0
  73      * and XPath 2.0 Functions and Operators, 7 Casting</a>
  74      * @see <a href="http://www.w3.org/TR/xpath20/#id-cast">XML Path Language
  75      * (XPath) 2.0, 3.10.2 Cast</a>
  76      * @author Frans Englich <frans.englich@nokia.com>
  77      * @ingroup Patternist_expressions
  78      */
  79     class CastAs : public SingleContainer,
  80                    public CastingPlatform<CastAs, true /* issueError */>
  81     {
  82     public:
  83
  84         /**
  85          * @todo Wrong/old documentation
  86          *
  87          * Creates a cast expression for the type @p name via the schema type
  88          * factory @p factory. This function is used by parser when creating
  89          * 'cast to' expressions, and the ConstructorFunctionsFactory, when creating
  90          * constructor functions.
  91          *
  92          * @param targetType the type which the CastAs should cast to
  93          * @param source the operand to evaluate and then cast from
  94          */
  95         CastAs(const Expression::Ptr &source,
  96                const SequenceType::Ptr &targetType);
  97
  98         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  99
 100         virtual SequenceType::List expectedOperandTypes() const;
 101
 102         /**
 103          * @returns a SequenceType where the ItemType is this CastAs's
 104          * target type, as per targetType(), and the Cardinality is inferred from the
 105          * source operand to reflect whether this CastAs always will evaluate to
 106          * exactly-one or zero-or-one values.
 107          */
 108         virtual SequenceType::Ptr staticType() const;
 109
 110         /**
 111          * Overridden in order to check that casting to an abstract type
 112          * is not attempted.
 113          */
 114         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 115                                           const SequenceType::Ptr &reqType);
 116
 117         /**
 118          * If the target type is the same as the source type, it is rewritten
 119          * to the operand.
 120          */
 121         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 122         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 123
 124         inline ItemType::Ptr targetType() const
 125         {
 126             return m_targetType->itemType();
 127         }
 128
 129         inline SequenceType::Ptr targetSequenceType() const
 130         {
 131             return m_targetType;
 132         }
 133
 134     private:
 135         /**
 136          * Performs casting to @c xs:QName. This case is special, and is always done at compile time.
 137          */
 138         Expression::Ptr castToQName(const StaticContext::Ptr &context) const;
 139
 140         const SequenceType::Ptr m_targetType;
 141     };
 142 }
 143
 144 QT_END_NAMESPACE
 145
 146 QT_END_HEADER
 147
 148 #endif