src/xmlpatterns/expr/qtreatas_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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_TreatAs_H
       
    53 #define Patternist_TreatAs_H
       
    54 
       
    55 #include "qsinglecontainer_p.h"
       
    56 
       
    57 QT_BEGIN_HEADER
       
    58 
       
    59 QT_BEGIN_NAMESPACE
       
    60 
       
    61 namespace QPatternist
       
    62 {
       
    63     /**
       
    64      * @short Implements XPath 2.0's <tt>treat as</tt> expression.
       
    65      *
       
    66      * TreatAs is always a compile-time class only, and is always deallocated
       
    67      * by re-writing to CardinalityVerifier or ItemVerifier or both, by calling
       
    68      * TypeChecker::applyFunctionConversion().
       
    69      *
       
    70      *
       
    71      * One approach could be to skip instantiating TreatAs and simply let the
       
    72      * return value of TypeChecker::applyFunctionConversion() be inserted into
       
    73      * the AST, but that wouldn't handle type checking the context item
       
    74      * properly, which depends on that the StaticContext have been set by the
       
    75      * parent Expression.
       
    76      *
       
    77      * @see <a href="http://www.w3.org/TR/xpath20/#id-treat">XML Path Language
       
    78      * (XPath) 2.0, 3.10.5 Treat</a>
       
    79      * @author Frans Englich <frans.englich@nokia.com>
       
    80      * @ingroup Patternist_expressions
       
    81      */
       
    82     class TreatAs : public SingleContainer
       
    83     {
       
    84     public:
       
    85         /**
       
    86          * Creats a TreatAs where it is checked that the expression @p operand conforms
       
    87          * to the type @p reqType.
       
    88          */
       
    89         TreatAs(const Expression::Ptr &operand,
       
    90                 const SequenceType::Ptr &reqType);
       
    91 
       
    92         /**
       
    93          * This function rewrites always. First the type that this TreatAs expression tests for
       
    94          * is verified. Then, the type the <tt>treat as</tt> expression itself must match, @p reqType,
       
    95          * is verified.
       
    96          */
       
    97         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
       
    98                                           const SequenceType::Ptr &reqType);
       
    99 
       
   100         /**
       
   101          * @returns always the SequenceType passed in the constructor to this class. That is, the
       
   102          * SequenceType that the operand must conform to.
       
   103          */
       
   104         virtual SequenceType::Ptr staticType() const;
       
   105 
       
   106         /**
       
   107          * @returns a list containing one CommonSequenceTypes::ZeroOrMoreItems
       
   108          */
       
   109         virtual SequenceType::List expectedOperandTypes() const;
       
   110 
       
   111         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
       
   112 
       
   113     private:
       
   114         const SequenceType::Ptr m_reqType;
       
   115     };
       
   116 }
       
   117 
       
   118 QT_END_NAMESPACE
       
   119 
       
   120 QT_END_HEADER
       
   121 
       
   122 #endif