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