1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
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.
52 #ifndef Patternist_PatternPlatform_H
53 #define Patternist_PatternPlatform_H
58 #include <private/qfunctioncall_p.h>
67 * @short Contains functionality for functions and expressions that
68 * uses regular expressions.
70 * @ingroup Patternist_utils
71 * @author Frans Englich <frans.englich@nokia.com>
73 class PatternPlatform : public FunctionCall
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>
83 * No flags are set. Default behavior is used.
105 SimplifyWhitespace = 8
107 typedef QFlags<Flag> Flags;
109 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
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.
116 QRegExp pattern(const DynamicContext::Ptr &context) const;
119 * @returns the number of captures, also called parenthesized sub-expressions, the pattern has.
121 * If the pattern isn't precompiled, -1 is returned.
123 inline int captureCount() const;
126 * @short Parses pattern
128 static QRegExp parsePattern(const QString &pattern,
129 const ReportContext::Ptr &context,
130 const SourceLocationReflection *const location);
135 * @short This constructor is protected, because this class is supposed to be sub-classed.
137 * @param flagsPosition an index position specifying the operand containing the pattern
140 PatternPlatform(const qint8 flagsPosition);
144 * Enum telling whether the flags, pattern, or both
145 * have been compiled at compile time.
150 PatternPrecompiled = 1,
151 FlagsPrecompiled = 2,
152 FlagsAndPattern = PatternPrecompiled | FlagsPrecompiled
155 typedef QFlags<PreCompiledPart> PreCompiledParts;
158 * @short Calls the public parsePattern() function and passes in @c
159 * this as the location.
161 inline QRegExp parsePattern(const QString &pattern,
162 const ReportContext::Ptr &context) const;
164 Q_DISABLE_COPY(PatternPlatform)
166 Flags parseFlags(const QString &flags,
167 const DynamicContext::Ptr &context) const;
169 static void applyFlags(const Flags flags, QRegExp &pattern);
172 * The parts that have been pre-compiled at compile time.
174 PreCompiledParts m_compiledParts;
177 const qint8 m_flagsPosition;
180 inline int PatternPlatform::captureCount() const
182 if(m_compiledParts.testFlag(PatternPrecompiled))
183 return m_pattern.captureCount();
188 Q_DECLARE_OPERATORS_FOR_FLAGS(PatternPlatform::Flags)