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_EBVType_H
51#define Patternist_EBVType_H
52
53#include <private/qatomictype_p.h>
54#include <private/qsequencetype_p.h>
55
56QT_BEGIN_NAMESPACE
57
58namespace QPatternist
59{
60
61 /**
62 * @short Represents the type for which a value of can an Effective %Boolean Value
63 * be extracted from.
64 *
65 * EBVType is an artificial type. It is not available to users of any host language
66 * or is specified in any specification. It is used for implementing static type
67 * checking for expressions such as IfThenClause and AndExpression.
68 *
69 * @ingroup Patternist_types
70 * @author Frans Englich <frans.englich@nokia.com>
71 */
72 class EBVType : public ItemType,
73 public SequenceType
74 {
75 public:
76 typedef QExplicitlySharedDataPointer<EBVType> Ptr;
77
78 /**
79 * @todo docs if it's an ebvable type, etc.
80 */
81 bool itemMatches(const Item &item) const override;
82 bool xdtTypeMatches(const ItemType::Ptr &other) const override;
83
84 QString displayName(const NamePool::Ptr &np) const override;
85
86 /**
87 * @note The semantical meaning of this type's item type can
88 * surely be discussed. The function is provided due to
89 * it being mandated by the SequenceType base class.
90 *
91 * @returns always 'this' since EBVType is also an ItemType
92 */
93 ItemType::Ptr itemType() const override;
94
95 /**
96 * @note The semantical meaning of this type's cardinality
97 * can surely be discussed. The function is provided due to
98 * it being mandated by the SequenceType base class.
99 *
100 * @returns always Cardinality::zeroOrMore()
101 */
102 Cardinality cardinality() const override;
103
104 bool isAtomicType() const override;
105
106 /**
107 * @returns always @c null
108 */
109 ItemType::Ptr atomizedType() const override;
110
111 /**
112 * @returns always BuiltinTypes::item
113 */
114 ItemType::Ptr xdtSuperType() const override;
115
116 /**
117 * @returns always @c false
118 */
119 bool isNodeType() const override;
120
121 protected:
122 friend class CommonSequenceTypes;
123 EBVType();
124 };
125}
126
127QT_END_NAMESPACE
128
129#endif
130

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