src/xmlpatterns/janitors/qatomizer_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_Atomizer_H
  53 #define Patternist_Atomizer_H
  54
  55 #include <private/qitem_p.h>
  56 #include <private/qsinglecontainer_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64
  65     /**
  66      * @short Performs atomization. Effectively, it is an implementation
  67      * of the <tt>fn:data()</tt> function.
  68      *
  69      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-data">XQuery 1.0 and XPath
  70      * 2.0 Functions and Operators, 2.4 fn:data</a>
  71      * @see <a href="http://www.w3.org/TR/xpath20/#id-atomization">XML
  72      * Path Language (XPath) 2.0, 2.4.2 Atomization</a>
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      * @ingroup Patternist_expressions
  75      */
  76     class Atomizer : public SingleContainer
  77     {
  78     public:
  79         Atomizer(const Expression::Ptr &operand);
  80
  81         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  82         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
  83
  84         virtual SequenceType::Ptr staticType() const;
  85
  86         virtual SequenceType::List expectedOperandTypes() const;
  87         virtual const SourceLocationReflection *actualReflection() const;
  88
  89         /**
  90          * Makes an early compression, by returning the result of
  91          * the type checked operand, if the operand has the static type
  92          * xs:anyAtomicType(no atomization needed).
  93          */
  94         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  95                                           const SequenceType::Ptr &reqType);
  96
  97         inline Item::Iterator::Ptr mapToSequence(const Item &item,
  98                                                  const DynamicContext::Ptr &context) const;
  99         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 100
 101     private:
 102         typedef QExplicitlySharedDataPointer<const Atomizer> ConstPtr;
 103     };
 104 }
 105
 106 QT_END_NAMESPACE
 107
 108 QT_END_HEADER
 109
 110 #endif