src/xmlpatterns/functions/qstaticnamespacescontainer_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_StaticNamespacesContainer_H
  53 #define Patternist_StaticNamespacesContainer_H
  54
  55 #include <private/qfunctioncall_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short A helper subclass that stores a NamespaceResolver for the static
  65      * namespaces.
  66      *
  67      * This is used by functionality which needs to resolve names against the
  68      * statically known namespaces, at runtime. A good example of this is @c
  69      * function-available().
  70      *
  71      * The resolver is accessed through staticNamespaces(), which will be
  72      * available after the typeCheck() stage.
  73      *
  74      * This class must be subclassed.
  75      *
  76      * @author Frans Englich <frans.englich@nokia.com>
  77      * @ingroup Patternist_functions
  78      */
  79     class StaticNamespacesContainer : public FunctionCall
  80     {
  81     public:
  82         /**
  83          * Reimplemented to store data from the @p context.
  84          */
  85         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  86                                           const SequenceType::Ptr &reqType);
  87
  88     protected:
  89         /**
  90          * Before typeCheck(), behavior of this function is undefined. After
  91          * typeCheck(), this function guarantees to return a valid pointer.
  92          */
  93         inline const NamespaceResolver::Ptr &staticNamespaces() const
  94         {
  95             Q_ASSERT(m_resolver);
  96             return m_resolver;
  97         }
  98
  99         /**
 100          * This constructor only exists to ensure this class is subclassed.
 101          */
 102         inline StaticNamespacesContainer()
 103         {
 104         }
 105
 106     private:
 107         NamespaceResolver::Ptr m_resolver;
 108     };
 109 }
 110
 111 QT_END_NAMESPACE
 112
 113 QT_END_HEADER
 114
 115 #endif