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_CardinalityVerifier_H |
51 | #define Patternist_CardinalityVerifier_H |
52 | |
53 | #include <private/qsinglecontainer_p.h> |
54 | |
55 | QT_BEGIN_NAMESPACE |
56 | |
57 | namespace QPatternist |
58 | { |
59 | |
60 | /** |
61 | * @short Verifies that the sequence an Expression evaluates to conforms to a Cardinality. |
62 | * |
63 | * @see <a href="http://www.w3.org/TR/xpath-functions/#cardinality-funcs">XQuery 1.0 and |
64 | * XPath 2.0 Functions and Operators, 15.2 Functions That Test the Cardinality of Sequences</a> |
65 | * @author Frans Englich <frans.englich@nokia.com> |
66 | * @ingroup Patternist_expressions |
67 | */ |
68 | class CardinalityVerifier : public SingleContainer |
69 | { |
70 | public: |
71 | CardinalityVerifier(const Expression::Ptr &operand, |
72 | const Cardinality &card, |
73 | const ReportContext::ErrorCode code); |
74 | |
75 | virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const; |
76 | virtual Item evaluateSingleton(const DynamicContext::Ptr &) const; |
77 | |
78 | virtual SequenceType::List expectedOperandTypes() const; |
79 | virtual SequenceType::Ptr staticType() const; |
80 | |
81 | virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const; |
82 | |
83 | /** |
84 | * If the static cardinality of the operand is within the required cardinality, |
85 | * the operand is returned as is, since results will always be valid and hence |
86 | * is not a CardinalityVerifier necessary. |
87 | */ |
88 | virtual Expression::Ptr compress(const StaticContext::Ptr &context); |
89 | |
90 | /** |
91 | * A utility function for determining whether the static type of an Expression matches |
92 | * a cardinality. More specifically, this function performs the cardinality verification |
93 | * part of the Function Conversion Rules. |
94 | * |
95 | * @todo Mention the rewrite and when exactly an error is issued via @p context |
96 | */ |
97 | static Expression::Ptr |
98 | verifyCardinality(const Expression::Ptr &operand, |
99 | const Cardinality &card, |
100 | const StaticContext::Ptr &context, |
101 | const ReportContext::ErrorCode code = ReportContext::XPTY0004); |
102 | |
103 | virtual const SourceLocationReflection *actualReflection() const; |
104 | |
105 | ID id() const; |
106 | private: |
107 | /** |
108 | * Centralizes a message string in order to increase consistency and |
109 | * reduce work for translators. |
110 | */ |
111 | static inline QString wrongCardinality(const Cardinality &req, |
112 | const Cardinality &got = Cardinality::empty()); |
113 | |
114 | const Cardinality m_reqCard; |
115 | const bool m_allowsMany; |
116 | const ReportContext::ErrorCode m_errorCode; |
117 | }; |
118 | } |
119 | |
120 | QT_END_NAMESPACE |
121 | |
122 | #endif |
123 | |