src/xmlpatterns/functions/qpatternplatform_p.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
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_PatternPlatform_H
       
    53 #define Patternist_PatternPlatform_H
       
    54 
       
    55 #include <QFlags>
       
    56 #include <QRegExp>
       
    57 
       
    58 #include "qfunctioncall_p.h"
       
    59 
       
    60 QT_BEGIN_HEADER
       
    61 
       
    62 QT_BEGIN_NAMESPACE
       
    63 
       
    64 namespace QPatternist
       
    65 {
       
    66     /**
       
    67      * @short Contains functionality for functions and expressions that
       
    68      * uses regular expressions.
       
    69      *
       
    70      * @ingroup Patternist_utils
       
    71      * @author Frans Englich <frans.englich@nokia.com>
       
    72      */
       
    73     class PatternPlatform : public FunctionCall
       
    74     {
       
    75     public:
       
    76         /**
       
    77          * @see <a href="http://www.w3.org/TR/xpath-functions/#flags">XQuery 1.0 and
       
    78          * XPath 2.0 Functions and Operators, 7.6.1.1 Flags</a>
       
    79          */
       
    80         enum Flag
       
    81         {
       
    82             /**
       
    83              * No flags are set. Default behavior is used.
       
    84              */
       
    85             NoFlags             = 0,
       
    86 
       
    87             /**
       
    88              * Flag @c s
       
    89              */
       
    90             DotAllMode          = 1,
       
    91 
       
    92             /**
       
    93              * Flag @c m
       
    94              */
       
    95             MultiLineMode       = 2,
       
    96 
       
    97             /**
       
    98              * Flag @c i
       
    99              */
       
   100             CaseInsensitive     = 4,
       
   101 
       
   102             /**
       
   103              * Flag @c x
       
   104              */
       
   105             SimplifyWhitespace  = 8
       
   106         };
       
   107         typedef QFlags<Flag> Flags;
       
   108 
       
   109         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
       
   110 
       
   111         /**
       
   112          * Retrieves the pattern supplied in the arguments, taking care of compiling it,
       
   113          * settings its flags, and everything else required for getting it ready to use. If an error
       
   114          * occurs, an appropriate error is raised via @p context.
       
   115          */
       
   116         const QRegExp pattern(const DynamicContext::Ptr &context) const;
       
   117 
       
   118         /**
       
   119          * @returns the number of captures, also called parenthesized sub-expressions, the pattern has.
       
   120          *
       
   121          * If the pattern isn't precompiled, -1 is returned.
       
   122          */
       
   123         inline int captureCount() const;
       
   124 
       
   125         /**
       
   126          * @short Parses pattern 
       
   127          */
       
   128         static QRegExp parsePattern(const QString &pattern,
       
   129                                     const ReportContext::Ptr &context,
       
   130                                     const SourceLocationReflection *const location);
       
   131 
       
   132 
       
   133     protected:
       
   134         /**
       
   135          * @short This constructor is protected, because this class is supposed to be sub-classed.
       
   136          *
       
   137          * @param flagsPosition an index position specifying the operand containing the pattern
       
   138          * flags.
       
   139          */
       
   140         PatternPlatform(const qint8 flagsPosition);
       
   141 
       
   142     private:
       
   143         /**
       
   144          * Enum telling whether the flags, pattern, or both
       
   145          * have been compiled at compile time.
       
   146          */
       
   147         enum PreCompiledPart
       
   148         {
       
   149             NoPart          = 0,
       
   150             PatternPrecompiled     = 1,
       
   151             FlagsPrecompiled       = 2,
       
   152             FlagsAndPattern = PatternPrecompiled | FlagsPrecompiled
       
   153 
       
   154         };
       
   155         typedef QFlags<PreCompiledPart> PreCompiledParts;
       
   156 
       
   157         /**
       
   158          * @short Calls the public parsePattern() function and passes in @c
       
   159          * this as the location.
       
   160          */
       
   161         inline QRegExp parsePattern(const QString &pattern,
       
   162                                     const ReportContext::Ptr &context) const;
       
   163 
       
   164         Q_DISABLE_COPY(PatternPlatform)
       
   165 
       
   166         Flags parseFlags(const QString &flags,
       
   167                          const DynamicContext::Ptr &context) const;
       
   168 
       
   169         static void applyFlags(const Flags flags, QRegExp &pattern);
       
   170 
       
   171         /**
       
   172          * The parts that have been pre-compiled at compile time.
       
   173          */
       
   174         PreCompiledParts    m_compiledParts;
       
   175         Flags               m_flags;
       
   176         QRegExp             m_pattern;
       
   177         const qint8         m_flagsPosition;
       
   178     };
       
   179 
       
   180     inline int PatternPlatform::captureCount() const
       
   181     {
       
   182         if(m_compiledParts.testFlag(PatternPrecompiled))
       
   183             return m_pattern.numCaptures();
       
   184         else
       
   185             return -1;
       
   186     }
       
   187 
       
   188     Q_DECLARE_OPERATORS_FOR_FLAGS(PatternPlatform::Flags)
       
   189 }
       
   190 
       
   191 QT_END_NAMESPACE
       
   192 
       
   193 QT_END_HEADER
       
   194 
       
   195 #endif