285414b4fe4c271d378ff00ae283a0b7671a2038
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / janitors / qitemverifier_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 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 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_ItemVerifier_H
53 #define Patternist_ItemVerifier_H
54
55 #include <private/qsinglecontainer_p.h>
56
57 QT_BEGIN_HEADER
58
59 QT_BEGIN_NAMESPACE
60
61 namespace QPatternist
62 {
63
64     /**
65      * @short Verifies that the items in a sequence an Expression evaluates
66      * is of a certain ItemType.
67      *
68      * @author Frans Englich <frans.englich@nokia.com>
69      * @ingroup Patternist_expressions
70      */
71     class ItemVerifier : public SingleContainer
72     {
73     public:
74
75         ItemVerifier(const Expression::Ptr &operand,
76                      const ItemType::Ptr &reqType,
77                      const ReportContext::ErrorCode errorCode);
78
79         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
80         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
81
82         virtual SequenceType::List expectedOperandTypes() const;
83         virtual SequenceType::Ptr staticType() const;
84
85         inline Item mapToItem(const Item &, const DynamicContext::Ptr &) const;
86         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
87         virtual const SourceLocationReflection *actualReflection() const;
88
89     private:
90         typedef QExplicitlySharedDataPointer<const ItemVerifier> ConstPtr;
91         inline void verifyItem(const Item &item,
92                                const DynamicContext::Ptr &context) const;
93
94         const ItemType::Ptr             m_reqType;
95         const ReportContext::ErrorCode  m_errorCode;
96     };
97 }
98
99 QT_END_NAMESPACE
100
101 QT_END_HEADER
102
103 #endif