src/xmlpatterns/functions/qaccessorfns_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_AccessorFNs_H
  53 #define Patternist_AccessorFNs_H
  54
  55 #include <private/qfunctioncall_p.h>
  56
  57 /**
  58  * @file
  59  * @short Contains classes implementing the functions found in
  60  * <a href="http://www.w3.org/TR/xpath-functions/#accessors">XQuery 1.0 and
  61  * XPath 2.0 Functions and Operators, 2 Accessors</a>.
  62  * @ingroup Patternist_functions
  63  */
  64
  65 QT_BEGIN_HEADER
  66
  67 QT_BEGIN_NAMESPACE
  68
  69 namespace QPatternist
  70 {
  71
  72     /**
  73      * @short Implements the function <tt>fn:node-name()</tt>.
  74      *
  75      * @ingroup Patternist_functions
  76      * @author Frans Englich <frans.englich@nokia.com>
  77      */
  78     class NodeNameFN : public FunctionCall
  79     {
  80     public:
  81         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  82     };
  83
  84     /**
  85      * @short Implements the function <tt>fn:nilled()</tt>.
  86      *
  87      * @ingroup Patternist_functions
  88      * @author Frans Englich <frans.englich@nokia.com>
  89      */
  90     class NilledFN : public FunctionCall
  91     {
  92     public:
  93         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  94     };
  95
  96     /**
  97      * @short Implements the function <tt>fn:string()</tt>.
  98      *
  99      * @ingroup Patternist_functions
 100      * @author Frans Englich <frans.englich@nokia.com>
 101      */
 102     class StringFN : public FunctionCall
 103     {
 104     public:
 105         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 106         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 107                                           const SequenceType::Ptr &reqType);
 108     };
 109
 110     /**
 111      * @short Implements the function <tt>fn:base-uri()</tt>.
 112      *
 113      * @author Frans Englich <frans.englich@nokia.com>
 114      */
 115     class BaseURIFN : public FunctionCall
 116     {
 117     public:
 118         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 119     };
 120
 121     /**
 122      * @short Implements the function <tt>fn:document-uri()</tt>.
 123      *
 124      * @ingroup Patternist_functions
 125      * @author Frans Englich <frans.englich@nokia.com>
 126      */
 127     class DocumentURIFN : public FunctionCall
 128     {
 129     public:
 130         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 131     };
 132 }
 133
 134 QT_END_NAMESPACE
 135
 136 QT_END_HEADER
 137
 138 #endif