src/xmlpatterns/functions/qqnamefns_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_QNameFNs_H
  53 #define Patternist_QNameFNs_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/#QName-funcs">XQuery 1.0 and
  61  * XPath 2.0 Functions and Operators, 11 Functions Related to QNames</a>.
  62  *
  63  * @ingroup Patternist_functions
  64  */
  65
  66 QT_BEGIN_HEADER
  67
  68 QT_BEGIN_NAMESPACE
  69
  70 namespace QPatternist
  71 {
  72
  73     /**
  74      * @short Implements the function <tt>fn:QXmlName()</tt>.
  75      *
  76      * @ingroup Patternist_functions
  77      * @author Frans Englich <frans.englich@nokia.com>
  78      */
  79     class QNameFN : public FunctionCall
  80     {
  81     public:
  82         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  83     };
  84
  85     /**
  86      * @short Implements the function <tt>fn:resolve-QXmlName()</tt>.
  87      *
  88      * @ingroup Patternist_functions
  89      * @author Frans Englich <frans.englich@nokia.com>
  90      */
  91     class ResolveQNameFN : public FunctionCall
  92     {
  93     public:
  94         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  95     };
  96
  97     /**
  98      * @short Implements the function <tt>fn:prefix-from-QXmlName()</tt>.
  99      *
 100      * @ingroup Patternist_functions
 101      * @author Frans Englich <frans.englich@nokia.com>
 102      */
 103     class PrefixFromQNameFN : public FunctionCall
 104     {
 105     public:
 106         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 107     };
 108
 109     /**
 110      * @short Implements the function <tt>fn:local-name-from-QXmlName()</tt>.
 111      *
 112      * @ingroup Patternist_functions
 113      * @author Frans Englich <frans.englich@nokia.com>
 114      */
 115     class LocalNameFromQNameFN : public FunctionCall
 116     {
 117     public:
 118         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 119     };
 120
 121     /**
 122      * @short Implements the function <tt>fn:local-name-from-QXmlName()</tt>.
 123      *
 124      * @ingroup Patternist_functions
 125      * @author Frans Englich <frans.englich@nokia.com>
 126      */
 127     class NamespaceURIFromQNameFN : public FunctionCall
 128     {
 129     public:
 130         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 131     };
 132
 133     /**
 134      * @short Implements the function <tt>fn:namespace-uri-from-QXmlName()</tt>.
 135      *
 136      * @author Frans Englich <frans.englich@nokia.com>
 137      * @ingroup Patternist_functions
 138      */
 139     class NamespaceURIForPrefixFN : public FunctionCall
 140     {
 141     public:
 142         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 143     };
 144
 145     /**
 146      * @short Implements the function <tt>fn:in-scope-prefixes()</tt>.
 147      *
 148      * @ingroup Patternist_functions
 149      * @author Frans Englich <frans.englich@nokia.com>
 150      */
 151     class InScopePrefixesFN : public FunctionCall
 152     {
 153     public:
 154         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
 155     };
 156 }
 157
 158 QT_END_NAMESPACE
 159
 160 QT_END_HEADER
 161
 162 #endif