src/xmlpatterns/utils/qgenericnamespaceresolver_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_GenericNamespaceResolver_H
  53 #define Patternist_GenericNamespaceResolver_H
  54
  55 #include <QHash>
  56
  57 #include <private/qnamespaceresolver_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Generic namespace resolver which resolves lookups against entries in a QHash.
  67      *
  68      * @ingroup Patternist
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      */
  71     class GenericNamespaceResolver : public NamespaceResolver
  72     {
  73     public:
  74         GenericNamespaceResolver(const Bindings &list);
  75         virtual void addBinding(const QXmlName nb);
  76
  77         virtual QXmlName::NamespaceCode lookupNamespaceURI(const QXmlName::PrefixCode prefix) const;
  78
  79         /**
  80          * Returns a GenericNamespaceResolver containing the following bindings:
  81          *
  82          * - <tt>xml</tt> = <tt>http://www.w3.org/XML/1998/namespace</tt>
  83          * - <tt>xs</tt> = <tt>http://www.w3.org/2001/XMLSchema</tt>
  84          * - <tt>xsi</tt> = <tt>http://www.w3.org/2001/XMLSchema-instance</tt>
  85          * - <tt>fn</tt> = <tt>http://www.w3.org/2005/xpath-functions</tt>
  86          * - <tt>xdt</tt> = <tt>http://www.w3.org/2005/xpath-datatypes</tt>
  87          * - no prefix = empty namespace
  88          */
  89         static NamespaceResolver::Ptr defaultXQueryBindings();
  90
  91         /**
  92          * Returns a GenericNamespaceResolver containing the following bindings:
  93          *
  94          * - <tt>xml</tt> = <tt>http://www.w3.org/XML/1998/namespace</tt>
  95          * - no prefix = empty namespace
  96          */
  97         static NamespaceResolver::Ptr defaultXSLTBindings();
  98
  99         virtual Bindings bindings() const;
 100
 101     private:
 102         /**
 103          * The key is the prefix, the value the namespace URI.
 104          */
 105         Bindings m_bindings;
 106     };
 107 }
 108
 109 QT_END_NAMESPACE
 110
 111 QT_END_HEADER
 112
 113 #endif