src/xmlpatterns/environment/qgenericdynamiccontext_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  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_GenericDynamicContext_H
  53 #define Patternist_GenericDynamicContext_H
  54
  55 #include <QDateTime>
  56 #include <QVector>
  57
  58 #include <private/qdaytimeduration_p.h>
  59 #include <private/qstackcontextbase_p.h>
  60 #include <private/qexpression_p.h>
  61
  62 QT_BEGIN_HEADER
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 namespace QPatternist
  67 {
  68     /**
  69      * @short A DynamicContext supplying basic information that always is used.
  70      *
  71      * This DynamicContext is the first DynamicContext used during
  72      * a run and is always used. In addition, more contexts, such as
  73      * a Focus can be created.
  74      *
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      */
  77     class GenericDynamicContext : public StackContextBase<DynamicContext>
  78     {
  79     public:
  80         typedef QExplicitlySharedDataPointer<GenericDynamicContext> Ptr;
  81
  82         GenericDynamicContext(const NamePool::Ptr &np,
  83                               QAbstractMessageHandler *const messageHandler,
  84                               const LocationHash &locations);
  85
  86         virtual xsInteger contextPosition() const;
  87         /**
  88          * @returns always @c null, the focus is always undefined when an GenericDynamicContext
  89          * is used.
  90          */
  91         virtual Item contextItem() const;
  92         virtual xsInteger contextSize();
  93
  94         virtual void setFocusIterator(const Item::Iterator::Ptr &it);
  95         virtual Item::Iterator::Ptr focusIterator() const;
  96
  97         virtual QAbstractMessageHandler * messageHandler() const;
  98         virtual QExplicitlySharedDataPointer<DayTimeDuration> implicitTimezone() const;
  99         virtual QDateTime currentDateTime() const;
 100
 101         virtual QAbstractXmlReceiver *outputReceiver() const;
 102         void setOutputReceiver(QAbstractXmlReceiver *const receiver);
 103
 104         virtual NodeBuilder::Ptr nodeBuilder(const QUrl &baseURI) const;
 105         void setNodeBuilder(NodeBuilder::Ptr &builder);
 106
 107         virtual ResourceLoader::Ptr resourceLoader() const;
 108         void setResourceLoader(const ResourceLoader::Ptr &loader);
 109
 110         virtual ExternalVariableLoader::Ptr externalVariableLoader() const;
 111         void setExternalVariableLoader(const ExternalVariableLoader::Ptr &loader);
 112         virtual NamePool::Ptr namePool() const;
 113         virtual QSourceLocation locationFor(const SourceLocationReflection *const reflection) const;
 114         virtual void addNodeModel(const QAbstractXmlNodeModel::Ptr &nm);
 115         virtual const QAbstractUriResolver *uriResolver() const;
 116         virtual ItemCacheCell &globalItemCacheCell(const VariableSlotID slot);
 117         virtual ItemSequenceCacheCell::Vector &globalItemSequenceCacheCells(const VariableSlotID slot);
 118
 119         void setUriResolver(const QAbstractUriResolver *const resolver);
 120
 121         /**
 122          * We return a null item, we have no focus.
 123          */
 124         virtual Item currentItem() const;
 125
 126         /**
 127          * @short Returns always @c null, since we're always
 128          * a top-level context.
 129          */
 130         virtual DynamicContext::Ptr previousContext() const;
 131
 132         virtual QExplicitlySharedDataPointer<TemplateMode> currentTemplateMode() const;
 133
 134     private:
 135         QAbstractMessageHandler *       m_messageHandler;
 136         const QDateTime                 m_currentDateTime;
 137         const DayTimeDuration::Ptr      m_zoneOffset;
 138         QAbstractXmlReceiver *          m_outputReceiver;
 139         mutable NodeBuilder::Ptr        m_nodeBuilder;
 140         ExternalVariableLoader::Ptr     m_externalVariableLoader;
 141         ResourceLoader::Ptr             m_resourceLoader;
 142         NamePool::Ptr                   m_namePool;
 143         const LocationHash              m_locations;
 144         QAbstractXmlNodeModel::List     m_nodeModels;
 145         const QAbstractUriResolver *    m_uriResolver;
 146         ItemCacheCell::Vector           m_globalItemCacheCells;
 147         ItemSequenceCacheCell::Vector   m_globalItemSequenceCacheCells;
 148     };
 149 }
 150
 151 QT_END_NAMESPACE
 152
 153 QT_END_HEADER
 154
 155 #endif