1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
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.
52 #ifndef Patternist_GenericDynamicContext_H
53 #define Patternist_GenericDynamicContext_H
58 #include <private/qdaytimeduration_p.h>
59 #include <private/qstackcontextbase_p.h>
60 #include <private/qexpression_p.h>
69 * @short A DynamicContext supplying basic information that always is used.
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.
75 * @author Frans Englich <frans.englich@nokia.com>
77 class GenericDynamicContext : public StackContextBase<DynamicContext>
80 typedef QExplicitlySharedDataPointer<GenericDynamicContext> Ptr;
82 GenericDynamicContext(const NamePool::Ptr &np,
83 QAbstractMessageHandler *const messageHandler,
84 const LocationHash &locations);
86 virtual xsInteger contextPosition() const;
88 * @returns always @c null, the focus is always undefined when an GenericDynamicContext
91 virtual Item contextItem() const;
92 virtual xsInteger contextSize();
94 virtual void setFocusIterator(const Item::Iterator::Ptr &it);
95 virtual Item::Iterator::Ptr focusIterator() const;
97 virtual QAbstractMessageHandler * messageHandler() const;
98 virtual QExplicitlySharedDataPointer<DayTimeDuration> implicitTimezone() const;
99 virtual QDateTime currentDateTime() const;
101 virtual QAbstractXmlReceiver *outputReceiver() const;
102 void setOutputReceiver(QAbstractXmlReceiver *const receiver);
104 virtual NodeBuilder::Ptr nodeBuilder(const QUrl &baseURI) const;
105 void setNodeBuilder(NodeBuilder::Ptr &builder);
107 virtual ResourceLoader::Ptr resourceLoader() const;
108 void setResourceLoader(const ResourceLoader::Ptr &loader);
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);
119 void setUriResolver(const QAbstractUriResolver *const resolver);
122 * We return a null item, we have no focus.
124 virtual Item currentItem() const;
127 * @short Returns always @c null, since we're always
128 * a top-level context.
130 virtual DynamicContext::Ptr previousContext() const;
132 virtual QExplicitlySharedDataPointer<TemplateMode> currentTemplateMode() const;
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;