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_GenericSequenceType_H
51 #define Patternist_GenericSequenceType_H
52 
53 #include <private/qcommonsequencetypes_p.h>
54 #include <private/qsequencetype_p.h>
55 
56 QT_BEGIN_NAMESPACE
57 
58 namespace QPatternist
59 {
60     /**
61      * @todo Documentation is missing.
62      *
63      * @ingroup Patternist_types
64      * @author Frans Englich <frans.englich@nokia.com>
65      */
66     class GenericSequenceType : public SequenceType
67     {
68     public:
69         GenericSequenceType(const ItemType::Ptr &itemType, const Cardinality &card);
70 
71         /**
72          * Generates a name for the sequence type for display purposes. The
73          * prefix used for the QName identifying the schema type is conventional.
74          * An example of a display name for a GenericSequenceType is "xs:integer?".
75          */
76         QString displayName(const NamePool::Ptr &np) const override;
77 
78         Cardinality cardinality() const override;
79 
80         ItemType::Ptr itemType() const override;
81 
82     private:
83         const ItemType::Ptr m_itemType;
84         const Cardinality m_cardinality;
85     };
86 
87     /**
88      * @short An object generator for GenericSequenceType.
89      *
90      * makeGenericSequenceType() is a convenience function for avoiding invoking
91      * the @c new operator, and wrapping the result in GenericSequenceType::Ptr.
92      *
93      * @returns a smart pointer to to a GenericSequenceType instaniated from @p itemType and @p cardinality.
94      * @relates GenericSequenceType
95      */
96     static inline SequenceType::Ptr
makeGenericSequenceType(const ItemType::Ptr & itemType,const Cardinality & cardinality)97     makeGenericSequenceType(const ItemType::Ptr &itemType, const Cardinality &cardinality)
98     {
99         /* An empty sequence of say integers, is the empty-sequence(). */
100         if(cardinality.isEmpty())
101             return CommonSequenceTypes::Empty;
102         else
103             return SequenceType::Ptr(new GenericSequenceType(itemType, cardinality));
104     }
105 }
106 
107 QT_END_NAMESPACE
108 
109 #endif
110