src/xmlpatterns/functions/qnodefns_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_NodeFNs_H
       
    53 #define Patternist_NodeFNs_H
       
    54 
       
    55 #include "qfunctioncall_p.h"
       
    56 #include "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