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_SequenceType_H
51#define Patternist_SequenceType_H
52
53template<typename T> class QList;
54
55#include <QSharedData>
56
57#include <private/qcardinality_p.h>
58#include <private/qitemtype_p.h>
59
60QT_BEGIN_NAMESPACE
61
62namespace QPatternist
63{
64 class ItemType;
65
66 /**
67 * @short A SequenceType instance represents the type of a sequence of Item
68 * instances.
69 *
70 * It carries a Cardinality and ItemType, and is hence conceptually
71 * identical to the SequenceType EBNF construct.
72 *
73 * @ingroup Patternist_types
74 * @author Frans Englich <frans.englich@nokia.com>
75 * @see <a href="http://www.w3.org/TR/xpath20/#id-sequencetype-syntax">XML
76 * Path Language (XPath) 2.0, 2.5.3 SequenceType Syntax</a>
77 */
78 class Q_AUTOTEST_EXPORT SequenceType : public virtual QSharedData
79 {
80 public:
81 inline SequenceType()
82 {
83 }
84
85 /**
86 * A smart pointer wrapping SequenceType instances.
87 */
88 typedef QExplicitlySharedDataPointer<const SequenceType> Ptr;
89
90 /**
91 * A list of SequenceType instances, each wrapped in a smart pointer.
92 */
93 typedef QList<SequenceType::Ptr> List;
94
95 virtual ~SequenceType();
96
97 /**
98 * Generates a name for the sequence type for display purposes. The
99 * prefix used for the QName identifying the schema type is conventional.
100 * An example of a display name for a SequenceType is "xs:integer?".
101 */
102 virtual QString displayName(const NamePool::Ptr &np) const = 0;
103
104 virtual Cardinality cardinality() const = 0;
105
106 virtual ItemType::Ptr itemType() const = 0;
107
108 /**
109 * Determines whether @p other is identical to, or a sub-type
110 * of this SequenceType. For example, if this SequenceType is
111 * <tt>xs:anyAtomicType</tt>, @c false is returned if @p other is <tt>element()</tt>,
112 * but @c true if @p other is <tt>xs:string</tt>.
113 *
114 * The return values of cardinality() and itemType() used with ItemType::xdtTypeMatches
115 * and Cardinality::isWithinScope() is used for achieving this.
116 *
117 * @see <a href="http://www.w3.org/TR/xquery/#id-sequencetype-matching">XQuery 1.0:
118 * An XML Query Language, 2.5.4 SequenceType Matching</a>
119 */
120 bool matches(const SequenceType::Ptr other) const;
121
122 bool is(const SequenceType::Ptr &other) const;
123 private:
124 Q_DISABLE_COPY(SequenceType)
125 };
126}
127
128Q_DECLARE_TYPEINFO(QPatternist::SequenceType::Ptr, Q_MOVABLE_TYPE);
129
130QT_END_NAMESPACE
131
132#endif
133

source code of qtxmlpatterns/src/xmlpatterns/type/qsequencetype_p.h