Update obsolete contact address.
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / api / qxmlname.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: http://www.qt-project.org/
6 **
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QXMLNAME_H
43 #define QXMLNAME_H
44
45 #include <QtCore/QString>
46 #include <QtCore/QMetaType>
47
48 QT_BEGIN_HEADER
49
50 QT_BEGIN_NAMESPACE
51
52
53 class QXmlName;
54 class QXmlNamePool;
55 Q_XMLPATTERNS_EXPORT uint qHash(const QXmlName &name);
56
57 class Q_XMLPATTERNS_EXPORT QXmlName
58 {
59 private:
60     enum Constant
61     {
62         LocalNameOffset     = 0,
63         LocalNameLength     = 12,
64         NamespaceOffset     = LocalNameLength,
65         NamespaceLength     = 9,
66         PrefixLength        = 9,
67         InvalidCode         = 1 << 31,
68         NamespaceMask       = ((1 << ((NamespaceOffset + NamespaceLength) - NamespaceOffset)) - 1) << NamespaceOffset,
69         LocalNameMask       = ((1 << ((LocalNameOffset + LocalNameLength) - LocalNameOffset)) - 1) << LocalNameOffset,
70         PrefixOffset        = LocalNameLength + NamespaceLength,
71         PrefixMask          = ((1 << ((PrefixOffset + PrefixLength) - PrefixOffset)) - 1) << PrefixOffset,
72         MaximumPrefixes     = (PrefixMask >> PrefixOffset) - 1,
73         MaximumLocalNames   = (LocalNameMask >> LocalNameOffset) - 1,
74         MaximumNamespaces   = (NamespaceMask >> NamespaceOffset) - 1,
75         ExpandedNameMask    = LocalNameMask | NamespaceMask,
76         LexicalQNameMask    = LocalNameMask | PrefixMask
77     };
78
79 public:
80
81     typedef qint16 NamespaceCode;
82     typedef NamespaceCode PrefixCode;
83     typedef NamespaceCode LocalNameCode;
84
85     QXmlName();
86
87     QXmlName(QXmlNamePool &namePool,
88              const QString &localName,
89              const QString &namespaceURI = QString(),
90              const QString &prefix = QString());
91
92     QString namespaceUri(const QXmlNamePool &query) const;
93     QString prefix(const QXmlNamePool &query) const;
94     QString localName(const QXmlNamePool &query) const;
95     QString toClarkName(const QXmlNamePool &query) const;
96     bool operator==(const QXmlName &other) const;
97     bool operator!=(const QXmlName &other) const;
98     QXmlName &operator=(const QXmlName &other);
99     bool isNull() const;
100     static bool isNCName(const QString &candidate);
101     static QXmlName fromClarkName(const QString &clarkName,
102                                   const QXmlNamePool &namePool);
103
104     /* The members below are internal, not part of the public API, and
105      * unsupported. Using them leads to undefined behavior. */
106     typedef qint64 Code;
107
108     inline QXmlName(const NamespaceCode uri,
109                     const LocalNameCode ln,
110                     const PrefixCode p = 0);
111     /* The implementation for these functions are in utils/qnamepool_p.h. */
112     inline LocalNameCode localName() const;
113     inline PrefixCode prefix() const;
114     inline bool hasPrefix() const;
115     inline bool hasNamespace() const;
116     inline NamespaceCode namespaceURI() const;
117     inline bool isLexicallyEqual(const QXmlName &other) const;
118     inline void setPrefix(const PrefixCode c);
119     inline void setNamespaceURI(const NamespaceCode c);
120     inline void setLocalName(const LocalNameCode c);
121     inline Code code() const;
122
123     friend Q_XMLPATTERNS_EXPORT uint qHash(const QXmlName &);
124
125 private:
126     inline QXmlName(const int c) : m_qNameCode(c)
127     {
128     }
129
130     Code m_qNameCode;
131 };
132
133 Q_DECLARE_TYPEINFO(QXmlName, Q_MOVABLE_TYPE);
134
135 QT_END_NAMESPACE
136
137 Q_DECLARE_METATYPE(QXmlName) /* This macro must appear after QT_END_NAMESPACE. */
138
139 QT_END_HEADER
140
141 #endif