src/xmlpatterns/functions/qpatternmatchingfns_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_PatternMatchingFNs_H
       
    53 #define Patternist_PatternMatchingFNs_H
       
    54 
       
    55 #include "qpatternplatform_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/#string.match">XQuery 1.0 and
       
    61  * XPath 2.0 Functions and Operators, 7.6 AtomicString Functions that Use Pattern Matching</a>.
       
    62  *
       
    63  * @ingroup Patternist_functions
       
    64  */
       
    65 
       
    66 QT_BEGIN_HEADER
       
    67 
       
    68 QT_BEGIN_NAMESPACE
       
    69 
       
    70 namespace QPatternist
       
    71 {
       
    72     /**
       
    73      * @short Implements the function <tt>fn:matches()</tt>.
       
    74      *
       
    75      * @ingroup Patternist_functions
       
    76      * @author Frans Englich <frans.englich@nokia.com>
       
    77      */
       
    78     class MatchesFN : public PatternPlatform
       
    79     {
       
    80     public:
       
    81         MatchesFN();
       
    82         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
       
    83     };
       
    84 
       
    85     /**
       
    86      * @short Implements the function <tt>fn:replace()</tt>.
       
    87      *
       
    88      * @ingroup Patternist_functions
       
    89      * @author Frans Englich <frans.englich@nokia.com>
       
    90      */
       
    91     class ReplaceFN : public PatternPlatform
       
    92     {
       
    93     public:
       
    94         ReplaceFN();
       
    95         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
       
    96         /**
       
    97          * Overridden to attempt to pre-compile the replacement string.
       
    98          */
       
    99         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
       
   100 
       
   101     private:
       
   102         /**
       
   103          * @short Centralizes the translation string.
       
   104          */
       
   105         static inline QString errorAtEnd(const char ch);
       
   106 
       
   107         /**
       
   108          * Reads the string in the third argument and converts it to a a QRegExp compatible
       
   109          * replacement string, containing sub-group references and so forth.
       
   110          */
       
   111         QString parseReplacement(const int captureCount,
       
   112                                  const DynamicContext::Ptr &context) const;
       
   113 
       
   114         QString m_replacementString;
       
   115     };
       
   116 
       
   117     /**
       
   118      * @short Implements the function <tt>fn:tokenize()</tt>.
       
   119      *
       
   120      * @ingroup Patternist_functions
       
   121      * @author Frans Englich <frans.englich@nokia.com>
       
   122      */
       
   123     class TokenizeFN : public PatternPlatform
       
   124     {
       
   125     public:
       
   126         TokenizeFN();
       
   127         inline Item mapToItem(const QString &subject, const DynamicContext::Ptr &) const;
       
   128         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
       
   129 
       
   130     private:
       
   131         typedef QExplicitlySharedDataPointer<const TokenizeFN> ConstPtr;
       
   132     };
       
   133 }
       
   134 
       
   135 QT_END_NAMESPACE
       
   136 
       
   137 QT_END_HEADER
       
   138 
       
   139 #endif