src/xmlpatterns/functions/qnodefns_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_NodeFNs_H
  53 #define Patternist_NodeFNs_H
  54
  55 #include <private/qfunctioncall_p.h>
  56 #include <private/qcastingplatform_p.h>
  57
  58 /**
  59  * @file
  60  * @short Contains classes implementing the functions found in
  61  * <a href="http://www.w3.org/TR/xpath-functions/#node-functions">XQuery 1.0 and
  62  * XPath 2.0 Functions and Operators, 14 Functions and Operators on Nodes</a>.
  63  *
  64  * @ingroup Patternist_functions
  65  */
  66
  67 QT_BEGIN_HEADER
  68
  69 QT_BEGIN_NAMESPACE
  70
  71 namespace QPatternist
  72 {
  73     /**
  74      * @short Implements the function <tt>fn:name()</tt>.
  75      *
  76      * @ingroup Patternist_functions
  77      * @author Frans Englich <frans.englich@nokia.com>
  78      */
  79     class NameFN : public FunctionCall
  80     {
  81     public:
  82         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  83     };
  84
  85     /**
  86      * @short Implements the function <tt>fn:local-name()</tt>.
  87      *
  88      * @ingroup Patternist_functions
  89      * @author Frans Englich <frans.englich@nokia.com>
  90      */
  91     class LocalNameFN : public FunctionCall
  92     {
  93     public:
  94         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  95     };
  96
  97     /**
  98      * @short Implements the function <tt>fn:namespace-uri()</tt>.
  99      *
 100      * @ingroup Patternist_functions
 101      * @author Frans Englich <frans.englich@nokia.com>
 102      */
 103     class NamespaceURIFN : public FunctionCall
 104     {
 105     public:
 106         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 107     };
 108
 109     /**
 110      * @short Implements the function <tt>fn:number()</tt>.
 111      *
 112      * NumberFN uses CastingPlatform for performing the actual casting.
 113      *
 114      * @ingroup Patternist_functions
 115      * @author Frans Englich <frans.englich@nokia.com>
 116      */
 117     class NumberFN : public FunctionCall,
 118                      public CastingPlatform<NumberFN, false>
 119     {
 120     public:
 121         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 122
 123         /**
 124          * Overridden in order to call CastingPlatform::prepareCasting(). It also
 125          * implements the optimization of rewriting to its operand if its
 126          * type is xs:double(since the <tt>fn:number()</tt> call is in that case superflorous).
 127          */
 128         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 129                                           const SequenceType::Ptr &reqType);
 130
 131         /**
 132          * @returns always BuiltinTypes::xsDouble.
 133          */
 134         inline ItemType::Ptr targetType() const
 135         {
 136             return BuiltinTypes::xsDouble;
 137         }
 138     };
 139
 140     /**
 141      * @short Implements the function <tt>fn:lang()</tt>.
 142      *
 143      * @ingroup Patternist_functions
 144      * @author Frans Englich <frans.englich@nokia.com>
 145      */
 146     class LangFN : public FunctionCall
 147     {
 148     public:
 149         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 150
 151     private:
 152         static inline bool isLangMatch(const QString &candidate, const QString &toMatch);
 153     };
 154
 155     /**
 156      * @short Implements the function <tt>fn:root()</tt>.
 157      *
 158      * @ingroup Patternist_functions
 159      * @author Frans Englich <frans.englich@nokia.com>
 160      */
 161     class RootFN : public FunctionCall
 162     {
 163     public:
 164         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 165         /**
 166          * Infers its cardinality from the argument.
 167          */
 168         virtual SequenceType::Ptr staticType() const;
 169     };
 170 }
 171
 172 QT_END_NAMESPACE
 173
 174 QT_END_HEADER
 175
 176 #endif