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_MultiItemType_H
51#define Patternist_MultiItemType_H
52
53#include <QList>
54
55#include <private/qitemtype_p.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61 /**
62 * @short Represents multiple types such as <tt>document()</tt> @em or <tt>xs:integer</tt>.
63 *
64 * In some situations two or more different types are allowed. For example, XQuery's
65 * @c validate expression accepts document or element nodes(but not attribute
66 * nodes, for example). MultiItemType is useful in such situations, its constructor
67 * takes a list of ItemType instances which its member functions treats as a wholeness.
68 *
69 * For example, xdtTypeMatches() returns @c true if any of the represented types matches.
70 *
71 * @ingroup Patternist_types
72 * @author Frans Englich <frans.englich@nokia.com>
73 */
74 class MultiItemType : public ItemType
75 {
76 public:
77 /**
78 * Creates a MultiItemType representing the types in @p typeList. @p typeList must
79 * contain two or more types.
80 */
81 MultiItemType(const ItemType::List &typeList);
82
83 /**
84 * The display name are the names concatenated with "|" as separator. For example,
85 * if this MultiItemType represents the types <tt>document()</tt>, <tt>xs:integer</tt>,
86 * and <tt>xs:anyAtomicType</tt>, the display name is
87 * "document() | xs:integer | xs:anyAtomicType".
88 */
89 QString displayName(const NamePool::Ptr &np) const override;
90
91 /**
92 * If any of the types this MultiItemType represents matches @p item, it is
93 * considered a match.
94 *
95 * @returns @c true if any of the housed ItemType instances matches @p item, otherwise @c false
96 */
97 bool itemMatches(const Item &item) const override;
98
99 /**
100 * If any of the types this MultiItemType represents matches @p other, it is
101 * considered a match.
102 *
103 * @returns @c true if any of the housed ItemType instances matches @p other, otherwise @c false
104 */
105 bool xdtTypeMatches(const ItemType::Ptr &other) const override;
106
107 /**
108 * @returns @c true if any of the represented types is a node type.
109 */
110 bool isNodeType() const override;
111
112 /**
113 * @returns @c true if any of the represented types is an atomic type.
114 */
115 bool isAtomicType() const override;
116
117 /**
118 * Determines the union type of all the represented types super types. For example,
119 * if the represented types are <tt>xs:integer</tt>, <tt>document()</tt>
120 * and <tt>xs:string</tt>, <tt>item()</tt> is returned.
121 */
122 ItemType::Ptr xdtSuperType() const override;
123
124 /**
125 * Determines the union type of all the represented types atomized types. For example,
126 * if the represented types are <tt>xs:integer</tt> and <tt>document()</tt>,
127 * <tt>xs:anyAtomicType</tt> is returned, because that's the super type of <tt>xs:integer</tt>
128 * and <tt>xs:untypedAtomic</tt>.
129 */
130 ItemType::Ptr atomizedType() const override;
131
132 private:
133 const ItemType::List m_types;
134 const ItemType::List::const_iterator m_end;
135 };
136}
137
138QT_END_NAMESPACE
139
140#endif
141

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