1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
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_TemplateMode_H
53 #define Patternist_TemplateMode_H
54 
55 #include <QtCore/QSharedData>
56 #include <QXmlName>
57 
58 #include "qtemplatepattern_p.h"
59 
60 QT_BEGIN_HEADER
61 QT_BEGIN_NAMESPACE
62 
63 namespace QPatternist
64 {
65     /**
66      * @short Houses the data specific to the templates for a certain mode.
67      *
68      * @see Template
69      * @see TemplatePattern
70      * @author Frans Englich <frans.englich@nokia.com>
71      * @ingroup Patternist_expressions
72      * @since 4.5
73      */
74     class Q_AUTOTEST_EXPORT TemplateMode : public QSharedData
75     {
76     public:
77         typedef QExplicitlySharedDataPointer<TemplateMode> Ptr;
78 
TemplateMode(const QXmlName & modeName)79         inline TemplateMode(const QXmlName &modeName) : m_modeName(modeName)
80         {
81         }
82 
83         TemplatePattern::Vector templatePatterns;
84 
85         /**
86          * Adds the templates in @p mode to this TemplateMode.
87          *
88          * The existing name remains.
89          */
90         inline void addMode(const TemplateMode::Ptr &mode);
91 
92         inline const QXmlName &name() const;
93 
94         /**
95          * Orders its templates by priority such that the first lookup always
96          * returns the template with highest priority, and removes templates
97          * shadowed by import precedence.
98          */
99         void finalize();
100 
101     private:
102         const QXmlName m_modeName;
103         Q_DISABLE_COPY(TemplateMode)
104 
105         /**
106          * Operator for qSort().
107          */
108         static inline bool lessThanByPriority(const TemplatePattern::Ptr &t1,
109                                               const TemplatePattern::Ptr &t2);
110     };
111 
name()112     const QXmlName &TemplateMode::name() const
113     {
114         return m_modeName;
115     }
116 
addMode(const TemplateMode::Ptr & mode)117     void TemplateMode::addMode(const TemplateMode::Ptr &mode)
118     {
119         templatePatterns += mode->templatePatterns;
120     }
121 
122 }
123 
124 QT_END_NAMESPACE
125 
126 QT_END_HEADER
127 
128 #endif
129