src/xmlpatterns/functions/qsubstringfns_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_SubStringFNs_H
  53 #define Patternist_SubStringFNs_H
  54
  55 #include <private/qcomparescaseaware_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/#substring.functions">XQuery 1.0 and
  61  * XPath 2.0 Functions and Operators, 7.5 Functions Based on Substring Matching</a>.
  62  * @ingroup Patternist_functions
  63  */
  64
  65 QT_BEGIN_HEADER
  66
  67 QT_BEGIN_NAMESPACE
  68
  69 namespace QPatternist
  70 {
  71     /**
  72      * @short Implements the function <tt>fn:contains()</tt>.
  73      *
  74      * @ingroup Patternist_functions
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      */
  77     class ContainsFN : public ComparesCaseAware
  78     {
  79     public:
  80         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  81     };
  82
  83     /**
  84      * @short Implements the function <tt>fn:starts-with()</tt>.
  85      *
  86      * @ingroup Patternist_functions
  87      * @author Frans Englich <frans.englich@nokia.com>
  88      */
  89     class StartsWithFN : public ComparesCaseAware
  90     {
  91     public:
  92         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  93     };
  94
  95     /**
  96      * @short Implements the function <tt>fn:ends-with()</tt>.
  97      *
  98      * @ingroup Patternist_functions
  99      * @author Frans Englich <frans.englich@nokia.com>
 100      */
 101     class EndsWithFN : public ComparesCaseAware
 102     {
 103     public:
 104         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 105     };
 106
 107     /**
 108      * @short Implements the function <tt>fn:substring-before()</tt>.
 109      *
 110      * @ingroup Patternist_functions
 111      * @author Frans Englich <frans.englich@nokia.com>
 112      */
 113     class SubstringBeforeFN : public FunctionCall
 114     {
 115     public:
 116         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 117     };
 118
 119     /**
 120      * @short Implements the function <tt>fn:substring-after()</tt>.
 121      *
 122      * @ingroup Patternist_functions
 123      * @author Frans Englich <frans.englich@nokia.com>
 124      */
 125     class SubstringAfterFN : public FunctionCall
 126     {
 127     public:
 128         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 129     };
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif