src/xmlpatterns/utils/qnamespaceresolver_p.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 //
  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_NamespaceResolver_H
  53 #define Patternist_NamespaceResolver_H
  54
  55 #include <QSharedData>
  56 #include <QXmlName>
  57
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 template<typename A, typename B> class QHash;
  64
  65 namespace QPatternist
  66 {
  67
  68     /**
  69      * @short Base class for namespace resolvers.
  70      *
  71      * @ingroup Patternist
  72      * @author Frans Englich <frans.englich@nokia.com>
  73      */
  74     class NamespaceResolver : public QSharedData
  75     {
  76     public:
  77         enum Constants
  78         {
  79             NoBinding = -1
  80         };
  81
  82         typedef QExplicitlySharedDataPointer<NamespaceResolver> Ptr;
  83
  84         /**
  85          * A list of namespace bindings. The key is the prefix, and the value is
  86          * the namespace URI.
  87          */
  88         typedef QHash<QXmlName::PrefixCode, QXmlName::NamespaceCode> Bindings;
  89
  90         NamespaceResolver();
  91         virtual ~NamespaceResolver();
  92
  93         /**
  94          * Adds the mapping from @p prefix to @p namespaceURI to
  95          * this NamespaceResolver. If this NamespaceResolver already contains
  96          * a binding involving @p prefix, the old binding is replaced.
  97          */
  98         virtual void addBinding(const QXmlName nb) = 0;
  99
 100         /**
 101          * Resolves the @p prefix to the corresponding namespace URI. If no binding
 102          * exists for @p prefix, NoBinding is returned.
 103          *
 104          * @returns the namespace corresponding to @p prefix.
 105          */
 106         virtual QXmlName::NamespaceCode lookupNamespaceURI(const QXmlName::PrefixCode prefix) const = 0;
 107
 108         /**
 109          * @returns all bindings this NamespaceResolver handles.
 110          */
 111         virtual Bindings bindings() const = 0;
 112     };
 113 }
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif