QPatternist::DelegatingDynamicContext Class Reference

Base class for dynamic contexts that are created from an existing one. More...

#include <qdelegatingdynamiccontext_p.h>

Inheritance diagram for QPatternist::DelegatingDynamicContext:

Public Functions
virtual void	addNodeModel (const QAbstractXmlNodeModel::Ptr &nm)
virtual Item	contextItem () const
virtual xsInteger	contextPosition () const
virtual xsInteger	contextSize ()
virtual QDateTime	currentDateTime () const
virtual Item	currentItem () const
	Returns the item that fn:current() returns. More...
virtual QExplicitlySharedDataPointer< TemplateMode >	currentTemplateMode () const
	Returns the current template mode that is in effect. More...
virtual Expression::Ptr	expressionVariable (const VariableSlotID slotNumber) const
virtual ExternalVariableLoader::Ptr	externalVariableLoader () const
virtual Item::Iterator::Ptr	focusIterator () const
virtual ItemCacheCell &	globalItemCacheCell (const VariableSlotID slot)
virtual ItemSequenceCacheCell::Vector &	globalItemSequenceCacheCells (const VariableSlotID slot)
virtual QExplicitlySharedDataPointer< DayTimeDuration >	implicitTimezone () const
virtual ItemCacheCell &	itemCacheCell (const VariableSlotID slot)
virtual ItemSequenceCacheCell::Vector &	itemSequenceCacheCells (const VariableSlotID slot)
virtual QSourceLocation	locationFor (const SourceLocationReflection *const reflection) const
	Returns the source location applying for reflection. More...
virtual QAbstractMessageHandler *	messageHandler () const
virtual NamePool::Ptr	namePool () const
virtual NodeBuilder::Ptr	nodeBuilder (const QUrl &baseURI) const
virtual QAbstractXmlReceiver *	outputReceiver () const
virtual Item::Iterator::Ptr	positionIterator (const VariableSlotID slot) const
virtual DynamicContext::Ptr	previousContext () const
	Returns the previous DynamicContext. If this context is the top-level one, null is returned. More...
virtual Item	rangeVariable (const VariableSlotID slotNumber) const
virtual ResourceLoader::Ptr	resourceLoader () const
virtual void	setExpressionVariable (const VariableSlotID slotNumber, const Expression::Ptr &newValue)
virtual void	setFocusIterator (const Item::Iterator::Ptr &it)
virtual void	setPositionIterator (const VariableSlotID slot, const Item::Iterator::Ptr &newValue)
virtual void	setRangeVariable (const VariableSlotID slotNumber, const Item &newValue)
virtual TemplateParameterHash &	templateParameterStore ()
	When a template is called, this member carries the template parameters. More...
virtual const QAbstractUriResolver *	uriResolver () const
	The URI resolver in use. More...
Public Functions inherited from QPatternist::DynamicContext
DynamicContext::Ptr	createFocus ()
DynamicContext::Ptr	createReceiverContext (QAbstractXmlReceiver *const receiver)
DynamicContext::Ptr	createStack ()
virtual void	setExpressionVariable (const VariableSlotID slot, const QExplicitlySharedDataPointer< Expression > &newValue)=0
virtual void	setFocusIterator (const Item::Iterator::Ptr &it)=0
virtual void	setPositionIterator (const VariableSlotID slot, const Item::Iterator::Ptr &newValue)=0
virtual	~DynamicContext ()
Public Functions inherited from QPatternist::ReportContext
void	error (const QString &message, const ReportContext::ErrorCode errorCode, const QSourceLocation &sourceLocation)
void	error (const QString &message, const ReportContext::ErrorCode errorCode, const SourceLocationReflection *const reflection)
void	error (const QString &message, const QXmlName qName, const SourceLocationReflection *const r)
	ReportContext ()
	Default constructors. More...
QUrl	resolveURI (const QUrl &relative, const QUrl &baseURI) const
void	warning (const QString &message, const QSourceLocation &sourceLocation=QSourceLocation())
virtual	~ReportContext ()
Public Functions inherited from QSharedData
	QSharedData ()
	Constructs a QSharedData object with a reference count of 0. More...
	QSharedData (const QSharedData &)
	Constructs a QSharedData object with reference count 0. More...

Protected Functions
	DelegatingDynamicContext (const DynamicContext::Ptr &prevContext)

Protected Variables
const DynamicContext::Ptr	m_prevContext

Additional Inherited Members
Public Types inherited from QPatternist::DynamicContext
typedef QExplicitlySharedDataPointer< DynamicContext >	Ptr
typedef QHash< QXmlName, QExplicitlySharedDataPointer< Expression > >	TemplateParameterHash
	Carries template parameters at runtime. More...
Public Types inherited from QPatternist::ReportContext
enum	ErrorCode {   XSDError, XPST0001, XPDY0002, XPST0003,   XPTY0004, XPST0005, XPTY0006, XPTY0007,   XPST0008, XQST0009, XPST0010, XQST0012,   XQST0013, XQST0014, XQST0015, XQST0016,   XPST0017, XPTY0018, XPTY0019, XPTY0020,   XPDY0021, XQST0022, XQTY0023, XQTY0024,   XQDY0025, XQDY0026, XQDY0027, XQTY0028,   XQDY0029, XQTY0030, XQST0031, XQST0032,   XQST0033, XQST0034, XQST0035, XQST0036,   XQST0037, XQST0038, XQST0039, XQST0040,   XQDY0041, XQST0042, XQST0043, XQDY0044,   XQST0045, XQST0046, XQST0047, XQST0048,   XQST0049, XPDY0050, XPST0051, XQDY0052,   XQST0053, XQST0054, XQST0055, XQST0056,   XQST0057, XQST0058, XQST0059, XQST0060,   XQDY0061, XQDY0062, XQST0063, XQDY0064,   XQST0065, XQST0066, XQST0067, XQST0068,   XQST0069, XQST0070, XQST0071, XQDY0072,   XQST0073, XQDY0074, XQST0075, XQST0076,   XQST0077, XQST0078, XQST0079, XPST0080,   XPST0081, XQST0082, XPST0083, XQDY0084,   XQST0085, XQTY0086, XQST0087, XQST0088,   XQST0089, XQST0090, XQDY0091, XQDY0092,   XQST0093, FOER0000, FOAR0001, FOAR0002,   FOCA0001, FOCA0002, FOCA0003, FOCA0005,   FOCA0006, FOCH0001, FOCH0002, FOCH0003,   FOCH0004, FODC0001, FODC0002, FODC0003,   FODC0004, FODC0005, FODT0001, FODT0002,   FODT0003, FONS0004, FONS0005, FORG0001,   FORG0002, FORG0003, FORG0004, FORG0005,   FORG0006, FORG0008, FORG0009, FORX0001,   FORX0002, FORX0003, FORX0004, FOTY0012,   SENR0001, SERE0003, SEPM0004, SERE0005,   SERE0006, SESU0007, SERE0008, SEPM0009,   SEPM0010, SESU0011, SERE0012, SESU0013,   SERE0014, SERE0015, SEPM0016, XTSE0010,   XTSE0020, XTSE0080, XTSE0090, XTSE0110,   XTSE0120, XTSE0125, XTSE0130, XTSE0150,   XTSE0165, XTSE0170, XTSE0180, XTSE0190,   XTSE0200, XTSE0210, XTSE0215, XTSE0220,   XTSE0260, XTSE0265, XTSE0280, XTSE0340,   XTSE0350, XTSE0370, XTSE0500, XTSE0530,   XTSE0550, XTSE0580, XTSE0620, XTSE0630,   XTSE0650, XTSE0660, XTSE0670, XTSE0680,   XTSE0690, XTSE0710, XTSE0720, XTSE0740,   XTSE0760, XTSE0770, XTSE0805, XTSE0808,   XTSE0809, XTSE0810, XTSE0812, XTSE0840,   XTSE0870, XTSE0880, XTSE0910, XTSE0940,   XTTE0950, XTSE0975, XTSE1015, XTSE1017,   XTSE1040, XTSE1060, XTSE1070, XTSE1080,   XTSE1090, XTSE1130, XTSE1205, XTSE1210,   XTSE1220, XTSE1290, XTSE1295, XTSE1300,   XTSE1430, XTSE1505, XTSE1520, XTSE1530,   XTSE1560, XTSE1570, XTSE1580, XTSE1590,   XTSE1600, XTSE1650, XTSE1660, XTTE0505,   XTTE0510, XTTE0520, XTTE0570, XTTE0590,   XTTE0600, XTTE0780, XTTE0790, XTTE0990,   XTTE1000, XTTE1020, XTTE1100, XTTE1120,   XTTE1510, XTTE1512, XTTE1515, XTTE1540,   XTTE1545, XTTE1550, XTTE1555, XTDE0030,   XTDE0040, XTDE0045, XTDE0047, XTDE0050,   XTDE0060, XTDE0160, XTRE0270, XTDE0290,   XTDE0410, XTDE0420, XTDE0430, XTDE0440,   XTDE0485, XTRE0540, XTDE0560, XTDE0610,   XTDE0640, XTDE0700, XTRE0795, XTDE0820,   XTDE0830, XTDE0835, XTDE0850, XTDE0855,   XTDE0860, XTDE0865, XTDE0890, XTDE0905,   XTDE0920, XTDE0925, XTDE0930, XTDE0980,   XTDE1030, XTDE1035, XTDE1110, XTDE1140,   XTDE1145, XTDE1150, XTRE1160, XTDE1170,   XTDE1190, XTDE1200, XTDE1260, XTDE1270,   XTDE1280, XTDE1310, XTDE1340, XTDE1350,   XTDE1360, XTDE1370, XTDE1380, XTDE1390,   XTMM9000, XTDE1400, XTDE1420, XTDE1425,   XTDE1428, XTDE1440, XTDE1450, XTDE1460,   XTDE1480, XTDE1490, XTRE1495, XTRE1500,   XTRE1620, XTRE1630, XTDE1665 }
typedef QHash< const SourceLocationReflection *, QSourceLocation >	LocationHash
typedef QExplicitlySharedDataPointer< ReportContext >	Ptr
Static Public Functions inherited from QPatternist::ReportContext
static QString	codeFromURI (const QString &typeURI, QString &uri)
static QString	codeToString (const ReportContext::ErrorCode errorCode)
Public Variables inherited from QSharedData
QAtomicInt	ref
Related Functions inherited from QPatternist::ReportContext
typedef bool	Exception
	This is the class type that is being thrown when a query error occur. More...

Detailed Description

Base class for dynamic contexts that are created from an existing one.

In some cases multiple DynamicContext instances must be used in order to maintain somekind of scope. This class delegates the DynamicContext interface onto another DynamicContext instance, allowing the sub-class to only implement what it needs to.

Author

Frans Englich frans.nosp@m..eng.nosp@m.lich@.nosp@m.noki.nosp@m.a.com

Definition at line 75 of file qdelegatingdynamiccontext_p.h.

Constructors and Destructors

DelegatingDynamicContext()

DelegatingDynamicContext::DelegatingDynamicContext ( const DynamicContext::Ptr &  prevContext )

protected

Definition at line 53 of file qdelegatingdynamiccontext.cpp.

                                                  : m_prevContext(prevContext)
{
    Q_ASSERT(m_prevContext);
}

Functions

addNodeModel()

void DelegatingDynamicContext::addNodeModel ( const QAbstractXmlNodeModel::Ptr &  nm )

virtual

Whenever a tree gets built, this function is called. DynamicContext has the responsibility of keeping a copy of nm, such that it doesn't go out of scope, since no one else will reference nm.

I think this is currently only used for temporary node trees. In other cases they are stored in the ExternalResourceLoader.

The caller guarantees that nm is not null.

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::TemporaryTreesRedirectingContext.

Definition at line 172 of file qdelegatingdynamiccontext.cpp.

{
    m_prevContext->addNodeModel(nm);
}

contextItem()

Item DelegatingDynamicContext::contextItem ( ) const

virtual

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::Focus.

Definition at line 74 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->contextItem();
}

contextPosition()

xsInteger DelegatingDynamicContext::contextPosition ( ) const

virtual

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::Focus.

Definition at line 69 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->contextPosition();
}

contextSize()

xsInteger DelegatingDynamicContext::contextSize ( )

virtual

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::Focus.

Definition at line 79 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->contextSize();
}

currentDateTime()

QDateTime DelegatingDynamicContext::currentDateTime ( ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 137 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->currentDateTime();
}

currentItem()

Item DelegatingDynamicContext::currentItem ( ) const

virtual

Returns the item that fn:current() returns.

Hence, this is not the focus, and very different from the focus.

See also

CurrentItemStore

CurrentFN

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::Focus, and QPatternist::CurrentItemContext.

Definition at line 192 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->currentItem();
}

currentTemplateMode()

QExplicitlySharedDataPointer< TemplateMode > DelegatingDynamicContext::currentTemplateMode ( ) const

virtual

Returns the current template mode that is in effect.

If null is returned, it means that the default mode should be used as the current mode.

Implements QPatternist::DynamicContext.

Definition at line 207 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->currentTemplateMode();
}

expressionVariable()

Expression::Ptr DelegatingDynamicContext::expressionVariable ( const VariableSlotID  slotNumber ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 122 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->expressionVariable(slotNumber);
}

externalVariableLoader()

ExternalVariableLoader::Ptr DelegatingDynamicContext::externalVariableLoader ( ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 157 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->externalVariableLoader();
}

focusIterator()

Item::Iterator::Ptr DelegatingDynamicContext::focusIterator ( ) const

virtual

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::Focus.

Definition at line 106 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->focusIterator();
}

globalItemCacheCell()

ItemCacheCell & DelegatingDynamicContext::globalItemCacheCell ( const VariableSlotID  slot )

virtual

Same as itemCacheCell(), but is only used for global varibles. This is needed because sometimes stack frames needs to be created for other kinds of variables(such as in the case of user function calls), while the global variable(s) needs to continue to use the same cache, instead of one for each new stack frame, typically an instance of StackContextBase.

This has two effects:

• It's an optimization. Instead of that a global variable gets evaluated each time a user function is called, think recursive functions, it's done only once.
• Query stability, hence affects things like node identity and therefore conformance. Hence affects for instance what nodes a query returns, since node identity affect node deduplication.

Implements QPatternist::DynamicContext.

Definition at line 182 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->globalItemCacheCell(slot);
}

globalItemSequenceCacheCells()

ItemSequenceCacheCell::Vector & DelegatingDynamicContext::globalItemSequenceCacheCells ( const VariableSlotID  slot )

virtual

Same as itemSequenceCacheCells() but applies only for global variables.

See also

globalItemCacheCell()

Implements QPatternist::DynamicContext.

Definition at line 187 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->globalItemSequenceCacheCells(slot);
}

implicitTimezone()

QExplicitlySharedDataPointer< DayTimeDuration > DelegatingDynamicContext::implicitTimezone ( ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 132 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->implicitTimezone();
}

itemCacheCell()

ItemCacheCell & DelegatingDynamicContext::itemCacheCell ( const VariableSlotID  slot )

virtual

This function intentionally returns by reference.

See also

globalItemCacheCell()

Implements QPatternist::DynamicContext.

Definition at line 59 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->itemCacheCell(slot);
}

itemSequenceCacheCells()

ItemSequenceCacheCell::Vector & DelegatingDynamicContext::itemSequenceCacheCells ( const VariableSlotID  slot )

virtual

This function intentionally returns by reference.

See also

globalItemSequenceCacheCells

Implements QPatternist::DynamicContext.

Definition at line 64 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->itemSequenceCacheCells(slot);
}

locationFor()

QSourceLocation DelegatingDynamicContext::locationFor ( const SourceLocationReflection *const  reflection ) const

virtual

Returns the source location applying for reflection.

Implements QPatternist::ReportContext.

Definition at line 167 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->locationFor(reflection);
}

messageHandler()

QAbstractMessageHandler * DelegatingDynamicContext::messageHandler ( ) const

virtual

Returns

the QAbstractMessageHandler which functions such as warning() and error() should submit messages to. This function may never return null; a valid QAbstractMessageHandler pointer must always be returned.

Implements QPatternist::ReportContext.

Definition at line 127 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->messageHandler();
}

namePool()

NamePool::Ptr DelegatingDynamicContext::namePool ( ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 162 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->namePool();
}

nodeBuilder()

NodeBuilder::Ptr DelegatingDynamicContext::nodeBuilder ( const QUrl &  baseURI ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 147 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->nodeBuilder(baseURI);
}

outputReceiver()

QAbstractXmlReceiver * DelegatingDynamicContext::outputReceiver ( ) const

virtual

Implements QPatternist::DynamicContext.

Reimplemented in QPatternist::ReceiverDynamicContext.

Definition at line 142 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->outputReceiver();
}

positionIterator()

Item::Iterator::Ptr DelegatingDynamicContext::positionIterator ( const VariableSlotID  slot ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 89 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->positionIterator(slot);
}

previousContext()

DynamicContext::Ptr DelegatingDynamicContext::previousContext ( ) const

virtual

Returns the previous DynamicContext. If this context is the top-level one, null is returned.

Implements QPatternist::DynamicContext.

Definition at line 202 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext;
}

rangeVariable()

Item DelegatingDynamicContext::rangeVariable ( const VariableSlotID  slotNumber ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 111 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->rangeVariable(slotNumber);
}

resourceLoader()

ResourceLoader::Ptr DelegatingDynamicContext::resourceLoader ( ) const

virtual

Implements QPatternist::DynamicContext.

Definition at line 152 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->resourceLoader();
}

setExpressionVariable()

void DelegatingDynamicContext::setExpressionVariable ( const VariableSlotID  slotNumber, const Expression::Ptr &  newValue  )

virtual

Definition at line 116 of file qdelegatingdynamiccontext.cpp.

{
    m_prevContext->setExpressionVariable(slotNumber, newValue);
}

setFocusIterator()

void DelegatingDynamicContext::setFocusIterator ( const Item::Iterator::Ptr &  it )

virtual

Reimplemented in QPatternist::Focus.

Definition at line 84 of file qdelegatingdynamiccontext.cpp.

{
    m_prevContext->setFocusIterator(it);
}

setPositionIterator()

void DelegatingDynamicContext::setPositionIterator ( const VariableSlotID  slot, const Item::Iterator::Ptr &  newValue  )

virtual

Definition at line 94 of file qdelegatingdynamiccontext.cpp.

{
    m_prevContext->setPositionIterator(slot, newValue);
}

setRangeVariable()

void DelegatingDynamicContext::setRangeVariable ( const VariableSlotID  slotNumber, const Item &  newValue  )

virtual

Implements QPatternist::DynamicContext.

Definition at line 100 of file qdelegatingdynamiccontext.cpp.

{
    m_prevContext->setRangeVariable(slotNumber, newValue);
}

templateParameterStore()

DynamicContext::TemplateParameterHash & DelegatingDynamicContext::templateParameterStore ( )

virtual

When a template is called, this member carries the template parameters.

Hence this is similar to the other variable stack functions such as rangeVariable() and expressionVariable(), the difference being that the order of template parameters as well as its arguments can appear in arbitrary order. Hence the name is used to make the order insignificant.

Implements QPatternist::DynamicContext.

Definition at line 197 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->templateParameterStore();
}

uriResolver()

const QAbstractUriResolver * DelegatingDynamicContext::uriResolver ( ) const

virtual

The URI resolver in use.

If no URI resolver is in use, a null pointer is returned.

Note

You should probably use resolveURI(), which handles the case of when uriResolver() is null.

Implements QPatternist::ReportContext.

Definition at line 177 of file qdelegatingdynamiccontext.cpp.

{
    return m_prevContext->uriResolver();
}

Properties

m_prevContext

const DynamicContext::Ptr QPatternist::DelegatingDynamicContext::m_prevContext

protected

Definition at line 122 of file qdelegatingdynamiccontext_p.h.

Referenced by addNodeModel(), contextItem(), contextPosition(), contextSize(), currentDateTime(), QPatternist::Focus::currentItem(), currentItem(), currentTemplateMode(), DelegatingDynamicContext(), expressionVariable(), externalVariableLoader(), focusIterator(), globalItemCacheCell(), globalItemSequenceCacheCells(), implicitTimezone(), itemCacheCell(), itemSequenceCacheCells(), locationFor(), messageHandler(), namePool(), nodeBuilder(), outputReceiver(), positionIterator(), previousContext(), rangeVariable(), resourceLoader(), setExpressionVariable(), setFocusIterator(), setPositionIterator(), setRangeVariable(), templateParameterStore(), and uriResolver().

---

The documentation for this class was generated from the following files:

• /src/xmlpatterns/environment/qdelegatingdynamiccontext_p.h
• /src/xmlpatterns/environment/qdelegatingdynamiccontext.cpp