src/xmlpatterns/functions/qsequencegeneratingfns_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_SequenceGeneratingFNs_H
  53 #define Patternist_SequenceGeneratingFNs_H
  54
  55 #include <private/qanyuri_p.h>
  56 #include <private/qcontextnodechecker_p.h>
  57 #include <private/qstaticbaseuricontainer_p.h>
  58
  59 /**
  60  * @file
  61  * @short Contains classes implementing the functions found in
  62  * <a href="http://www.w3.org/TR/xpath-functions/#fns-that-generate-sequences">XQuery 1.0 and
  63  * XPath 2.0 Functions and Operators, 15.5 Functions and Operators that Generate Sequences</a>.
  64  *
  65  * @ingroup Patternist_functions
  66  */
  67
  68 QT_BEGIN_HEADER
  69
  70 QT_BEGIN_NAMESPACE
  71
  72 namespace QPatternist
  73 {
  74     /**
  75      * @short Implements the function <tt>fn:id()</tt>.
  76      *
  77      * @ingroup Patternist_functions
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      */
  80     class IdFN : public ContextNodeChecker
  81     {
  82     public:
  83         IdFN();
  84         typedef QPair<DynamicContext::Ptr, const QAbstractXmlNodeModel *> IDContext;
  85
  86         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  87
  88         inline Item mapToItem(const QString &id,
  89                               const IDContext &context) const;
  90
  91         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  92                                           const SequenceType::Ptr &reqType);
  93
  94     private:
  95         typedef QExplicitlySharedDataPointer<const IdFN> ConstPtr;
  96         bool m_hasCreatedSorter;
  97     };
  98
  99     /**
 100      * @short Implements the function <tt>fn:idref()</tt>.
 101      *
 102      * @ingroup Patternist_functions
 103      * @author Frans Englich <frans.englich@nokia.com>
 104      */
 105     class IdrefFN : public ContextNodeChecker
 106     {
 107     public:
 108         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
 109     };
 110
 111     /**
 112      * @short Implements the function <tt>fn:doc()</tt>.
 113      *
 114      * @ingroup Patternist_functions
 115      * @author Frans Englich <frans.englich@nokia.com>
 116      */
 117     class DocFN : public StaticBaseUriContainer
 118     {
 119     public:
 120         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 121
 122         /**
 123          * The implementation of this function is placed in a different compilation unit,
 124          * namely qsequencefns.cpp, to workaround a compiler bug on
 125          * solaris-cc-64, suspected to be related to the instantiation of QUrl::toQUrl().
 126          *
 127          * @see <a
 128          * href="http://onesearch.sun.com/search/onesearch/index.jsp?qt=6532605&site=sunsolve&otf=ss&col=support-sunsolve&otf=sunsolve&site=ss&col=search-sunsolve">Sun,
 129          * multiply-defined label for template instance, bug 6532605</a>
 130          */
 131         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 132                                           const SequenceType::Ptr &reqType);
 133         virtual SequenceType::Ptr staticType() const;
 134
 135     private:
 136         SequenceType::Ptr m_type;
 137     };
 138
 139     /**
 140      * @short Implements the function <tt>fn:doc-available()</tt>.
 141      *
 142      * @ingroup Patternist_functions
 143      * @author Frans Englich <frans.englich@nokia.com>
 144      */
 145     class DocAvailableFN : public StaticBaseUriContainer
 146     {
 147     public:
 148         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
 149     };
 150
 151     /**
 152      * @short Implements the function <tt>fn:collection()</tt>.
 153      *
 154      * @ingroup Patternist_functions
 155      * @author Frans Englich <frans.englich@nokia.com>
 156      */
 157     class CollectionFN : public FunctionCall
 158     {
 159     public:
 160         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
 161     };
 162 }
 163
 164 QT_END_NAMESPACE
 165 QT_END_HEADER
 166
 167 #endif