src/xmlpatterns/api/qxmlname.h

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