/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QXMLNAME_H

#define QXMLNAME_H

#include <QtCore/QString>

#include <QtCore/QMetaType>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(XmlPatterns)

class QXmlName;

class QXmlNamePool;

Q_XMLPATTERNS_EXPORT uint qHash(const QXmlName &name);

class Q_XMLPATTERNS_EXPORT QXmlName

{

private:

    enum Constant

    {

        LocalNameOffset     = 0,

        LocalNameLength     = 12,

        NamespaceOffset     = LocalNameLength,

        NamespaceLength     = 9,

        PrefixLength        = 9,

        InvalidCode         = 1 << 31,

        NamespaceMask       = ((1 << ((NamespaceOffset + NamespaceLength) - NamespaceOffset)) - 1) << NamespaceOffset,

        LocalNameMask       = ((1 << ((LocalNameOffset + LocalNameLength) - LocalNameOffset)) - 1) << LocalNameOffset,

        PrefixOffset        = LocalNameLength + NamespaceLength,

        PrefixMask          = ((1 << ((PrefixOffset + PrefixLength) - PrefixOffset)) - 1) << PrefixOffset,

        MaximumPrefixes     = (PrefixMask >> PrefixOffset) - 1,

        MaximumLocalNames   = (LocalNameMask >> LocalNameOffset) - 1,

        MaximumNamespaces   = (NamespaceMask >> NamespaceOffset) - 1,

        ExpandedNameMask    = LocalNameMask | NamespaceMask,

        LexicalQNameMask    = LocalNameMask | PrefixMask

    };

public:

    typedef qint16 NamespaceCode;

    typedef NamespaceCode PrefixCode;

    typedef NamespaceCode LocalNameCode;

    QXmlName();

    QXmlName(QXmlNamePool &namePool,

             const QString &localName,

             const QString &namespaceURI = QString(),

             const QString &prefix = QString());

    QString namespaceUri(const QXmlNamePool &query) const;

    QString prefix(const QXmlNamePool &query) const;

    QString localName(const QXmlNamePool &query) const;

    QString toClarkName(const QXmlNamePool &query) const;

    bool operator==(const QXmlName &other) const;

    bool operator!=(const QXmlName &other) const;

    QXmlName &operator=(const QXmlName &other);

    bool isNull() const;

    static bool isNCName(const QString &candidate);

    static QXmlName fromClarkName(const QString &clarkName,

                                  const QXmlNamePool &namePool);

    /* The members below are internal, not part of the public API, and

     * unsupported. Using them leads to undefined behavior. */

    typedef qint64 Code;

    inline QXmlName(const NamespaceCode uri,

                    const LocalNameCode ln,

                    const PrefixCode p = 0);

    /* The implementation for these functions are in utils/qnamepool_p.h. */

    inline LocalNameCode localName() const;

    inline PrefixCode prefix() const;

    inline bool hasPrefix() const;

    inline bool hasNamespace() const;

    inline NamespaceCode namespaceURI() const;

    inline bool isLexicallyEqual(const QXmlName &other) const;

    inline void setPrefix(const PrefixCode c);

    inline void setNamespaceURI(const NamespaceCode c);

    inline void setLocalName(const LocalNameCode c);

    inline Code code() const;

    friend Q_XMLPATTERNS_EXPORT uint qHash(const QXmlName &);

private:

    inline QXmlName(const int c) : m_qNameCode(c)

    {

    }

    Code m_qNameCode;

};

Q_DECLARE_TYPEINFO(QXmlName, Q_MOVABLE_TYPE);

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QXmlName) /* This macro must appear after QT_END_NAMESPACE. */

QT_END_HEADER

#endif