1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 //
41 //  W A R N I N G
42 //  -------------
43 //
44 // This file is not part of the Qt API.  It exists purely as an
45 // implementation detail.  This header file may change from version to
46 // version without notice, or even be removed.
47 //
48 // We mean it.
49 
50 #ifndef Patternist_QuantifiedExpression_H
51 #define Patternist_QuantifiedExpression_H
52 
53 #include <private/qpaircontainer_p.h>
54 
55 QT_BEGIN_NAMESPACE
56 
57 namespace QPatternist
58 {
59     /**
60      * @short Implements XPath 2.0's quantification expressions @c some and @c every.
61      *
62      * @see <a href="http://www.w3.org/TR/xpath20/#id-quantified-expressions">XML Path Language
63      * (XPath) 2.0, 3.9 Quantified Expressions</a>
64      * @author Frans Englich <frans.englich@nokia.com>
65      * @ingroup Patternist_expressions
66      */
67     class Q_AUTOTEST_EXPORT QuantifiedExpression : public PairContainer
68     {
69     public:
70         enum Operator
71         {
72             Some    = 1,
73             Every
74         };
75 
76         QuantifiedExpression(const VariableSlotID varSlot,
77                              const Operator quantifier,
78                              const Expression::Ptr &inClause,
79                              const Expression::Ptr &testExpression);
80 
81         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
82         virtual SequenceType::Ptr staticType() const;
83         virtual SequenceType::List expectedOperandTypes() const;
84 
85         Operator operatorID() const;
86 
87         /**
88          * Determines the string representation for a quantification operator.
89          *
90          * @return "some" if @p quantifier is Some, or "every" if @p quantifier
91          * is Every
92          */
93         static QString displayName(const Operator quantifier);
94 
95         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
96 
97         inline Item mapToItem(const Item &item, const DynamicContext::Ptr &context) const;
98 
99     private:
100         typedef QExplicitlySharedDataPointer<const QuantifiedExpression> ConstPtr;
101         const VariableSlotID m_varSlot;
102         const Operator m_quantifier;
103     };
104 }
105 
106 QT_END_NAMESPACE
107 
108 #endif
109