Verifies that the items in a sequence an Expression evaluates is of a certain ItemType. More...

#include <qitemverifier_p.h>

Inheritance diagram for QPatternist::ItemVerifier:

Public Functions
virtual ExpressionVisitorResult::Ptr	accept (const ExpressionVisitor::Ptr &visitor) const

virtual const SourceLocationReflection *	actualReflection () const
	Returns `this`. More...

virtual Item::Iterator::Ptr	evaluateSequence (const DynamicContext::Ptr &) const

virtual Item	evaluateSingleton (const DynamicContext::Ptr &) const

virtual SequenceType::List	expectedOperandTypes () const

	ItemVerifier (const Expression::Ptr &operand, const ItemType::Ptr &reqType, const ReportContext::ErrorCode errorCode)

Item	mapToItem (const Item &, const DynamicContext::Ptr &) const

virtual SequenceType::Ptr	staticType () const

Public Functions inherited from QPatternist::SingleContainer
virtual bool	compressOperands (const StaticContext::Ptr &)

virtual Expression::List	operands () const

virtual void	setOperands (const Expression::List &operands)

Public Functions inherited from QPatternist::Expression
virtual void	announceFocusType (const ItemType::Ptr &itemType)

virtual Expression::Ptr	compress (const StaticContext::Ptr &context)

Properties	deepProperties () const
	Computes the union of properties for this Expression and all its descending children. More...

virtual Properties	dependencies () const

virtual QString	description () const

virtual bool	evaluateEBV (const DynamicContext::Ptr &context) const

virtual void	evaluateToSequenceReceiver (const DynamicContext::Ptr &context) const

virtual ItemType::Ptr	expectedContextItemType () const

	Expression ()

bool	has (const Property prop) const

bool	hasDependency (const Property prop) const

virtual ID	id () const

bool	is (const ID id) const

bool	isEvaluated () const

virtual ItemType::Ptr	newFocusType () const

virtual QList< QExplicitlySharedDataPointer< OptimizationPass > >	optimizationPasses () const

virtual PatternPriority	patternPriority () const

virtual Properties	properties () const

const Expression::Ptr &	rewrite (const Expression::Ptr &to, const StaticContext::Ptr &context) const
	Rewrites this Expression to `to`, and return `to`. More...

virtual Expression::Ptr	typeCheck (const StaticContext::Ptr &context, const SequenceType::Ptr &reqType)

virtual	~Expression ()

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...

Public Functions inherited from QPatternist::CppCastingHelper< Expression >
const TCastTarget *	as () const

TCastTarget *	as ()

Public Functions inherited from QPatternist::SourceLocationReflection
virtual QSourceLocation	sourceLocation () const

	SourceLocationReflection ()

virtual	~SourceLocationReflection ()

Private Types
typedef QExplicitlySharedDataPointer< const ItemVerifier >	ConstPtr

Private Functions
void	verifyItem (const Item &item, const DynamicContext::Ptr &context) const

Properties
const ReportContext::ErrorCode	m_errorCode

const ItemType::Ptr	m_reqType

Additional Inherited Members
Public Types inherited from QPatternist::Expression
typedef QExplicitlySharedDataPointer< const Expression >	ConstPtr
	A smart pointer wrapping `const` Expression instances. More...

enum	ID { IDBooleanValue = 1, IDCountFN, IDEmptyFN, IDExistsFN, IDExpressionSequence, IDGeneralComparison, IDIfThenClause, IDIgnorableExpression, IDIntegerValue, IDPositionFN, IDStringValue, IDValueComparison, IDRangeVariableReference, IDContextItem, IDUserFunctionCallsite, IDExpressionVariableReference, IDAttributeConstructor, IDUpperCaseFN, IDLowerCaseFN, IDFirstItemPredicate, IDEmptySequence, IDReturnOrderBy, IDLetClause, IDForClause, IDPath, IDNamespaceConstructor, IDArgumentReference, IDGenericPredicate, IDAxisStep, IDFloat, IDCombineNodes, IDUnresolvedVariableReference, IDCardinalityVerifier }

typedef QList< Expression::Ptr >	List

typedef QFlags< Property >	Properties

enum	Property { UseContextItem = 1, DisableElimination = 1 << 1, IsEvaluated = 1 << 2, DisableTypingDeduction = 1 << 3, EmptynessFollowsChild = 1 << 4, RewriteToEmptyOnEmpty = 1 << 5, RequiresFocus = 1 << 6, AffectsOrderOnly = 1 << 7, RequiresContextItem = (1 << 8) \| RequiresFocus, CreatesFocusForLast = 1 << 9, LastOperandIsCollation = 1 << 10, DependsOnLocalVariable = (1 << 11) \| DisableElimination, EvaluationCacheRedundant = (1 << 12), IsNodeConstructor = 1 << 13, RequiresCurrentItem = 1 << 14 }

typedef QExplicitlySharedDataPointer< Expression >	Ptr
	A smart pointer wrapping mutable Expression instances. More...

typedef ::QAbstractXmlForwardIterator< Expression::Ptr >	QAbstractXmlForwardIterator

typedef QVector< Expression::Ptr >	Vector

Static Public Functions inherited from QPatternist::Expression
static void	rewrite (Expression::Ptr &old, const Expression::Ptr &New, const StaticContext::Ptr &context)

Public Variables inherited from QSharedData
QAtomicInt	ref

Protected Functions inherited from QPatternist::SingleContainer
	SingleContainer (const Expression::Ptr &operand)

Protected Functions inherited from QPatternist::Expression
void	typeCheckOperands (const StaticContext::Ptr &context)

Protected Functions inherited from QPatternist::CppCastingHelper< Expression >
	CppCastingHelper ()

Protected Variables inherited from QPatternist::SingleContainer
Expression::Ptr	m_operand

Detailed Description

Verifies that the items in a sequence an Expression evaluates is of a certain ItemType.

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

Definition at line 71 of file qitemverifier_p.h.

Typedefs

◆ ConstPtr

typedef QExplicitlySharedDataPointer<const ItemVerifier> QPatternist::ItemVerifier::ConstPtr

private

Definition at line 90 of file qitemverifier_p.h.

Constructors and Destructors

◆ ItemVerifier()

ItemVerifier::ItemVerifier	(	const Expression::Ptr &	operand,
		const ItemType::Ptr &	reqType,
		const ReportContext::ErrorCode	errorCode
	)

Definition at line 53 of file qitemverifier.cpp.

                                                                    : SingleContainer(operand),
                                                                        m_reqType(reqType),
                                                                        m_errorCode(errorCode)
 {
     Q_ASSERT(reqType);
 }

Functions

◆ accept()

ExpressionVisitorResult::Ptr ItemVerifier::accept ( const ExpressionVisitor::Ptr & visitor ) const

virtual

Implements QPatternist::Expression.

Definition at line 117 of file qitemverifier.cpp.

 {
     return visitor->visit(this);
 }

◆ actualReflection()

const SourceLocationReflection * ItemVerifier::actualReflection ( ) const

virtual

Returns this.

Reimplemented from QPatternist::Expression.

Definition at line 74 of file qitemverifier.cpp.

 {
     return m_operand->actualReflection();
 }

◆ evaluateSequence()

Item::Iterator::Ptr ItemVerifier::evaluateSequence ( const DynamicContext::Ptr & context ) const

virtual

Evaluate this Expression by iterating over it. This is a central function for evaluating expressions.

Expressions must always always return a valid QAbstractXmlForwardIterator and may never return 0. If an empty result is of interest to be returned, the EmptyIterator should be returned.

The default implementation returns a SingletonIterator over the item returned from evaluateSingleton().

Note: This function may raise an exception when calling, not only when QAbstractXmlForwardIterator::next() is called on the return value. This is because in some cases evaluateSingleton() is called directly.

Reimplemented from QPatternist::Expression.

Definition at line 98 of file qitemverifier.cpp.

 {
     return makeItemMappingIterator<Item>(ConstPtr(this),
                                          m_operand->evaluateSequence(context),
                                          context);
 }

◆ evaluateSingleton()

Item ItemVerifier::evaluateSingleton ( const DynamicContext::Ptr & context ) const

virtual

Reimplemented from QPatternist::Expression.

Definition at line 79 of file qitemverifier.cpp.

 {
     const Item item(m_operand->evaluateSingleton(context));
 
     if(item)
     {
         verifyItem(item, context);
         return item;
     }
     else
         return Item();
 }

◆ expectedOperandTypes()

SequenceType::List ItemVerifier::expectedOperandTypes ( ) const

virtual

Returns a list of Sequence Types, describing the type of each of the expression's operands. Hence, this function has a relationship to the operands() function:

- The lengths of the lists returned by expectedOperandTypes()
and operands() should always be equal in length, since one
cannot describe the type of a non-existent operand(and all
operands must have type information).
- A significant difference between the two functions is that while
the type of objects in the list returned by operands() may vary
between compilations/static context, simply because the particular
Expression is part of different XPath expressions, the
types in the list returned by expectedOperandTypes is always the same
since the function/operator signature never changes.

This function should not be confused with staticType(), which returns the static type of the expression itself, not its operands. The function call is an expression where this is clear: the type of the return value is not the same as the arguments' types. The static type of the operands supplied to the expression can be determined via the staticType() function of the instances returned by operands().

If the expression has no operands, an empty list should be returned.

Implements QPatternist::Expression.

Definition at line 110 of file qitemverifier.cpp.

 {
     SequenceType::List result;
     result.append(CommonSequenceTypes::ZeroOrMoreItems);
     return result;
 }

◆ mapToItem()

Item ItemVerifier::mapToItem	(	const Item &	item,
		const DynamicContext::Ptr &	context
	)		const

inline

Definition at line 92 of file qitemverifier.cpp.

 {
     verifyItem(item, context);
     return item;
 }

◆ staticType()

SequenceType::Ptr ItemVerifier::staticType ( ) const

virtual

Returns: the static type of this Expression. For example, an 'and' expression have as static type xs:boolean

Implements QPatternist::Expression.

Definition at line 105 of file qitemverifier.cpp.

 {
     return makeGenericSequenceType(m_reqType, m_operand->staticType()->cardinality());
 }

◆ verifyItem()

void ItemVerifier::verifyItem	(	const Item &	item,
		const DynamicContext::Ptr &	context
	)		const

inlineprivate

Definition at line 62 of file qitemverifier.cpp.

Referenced by evaluateSingleton(), and mapToItem().

 {
     if(m_reqType->itemMatches(item))
         return;
 
     context->error(QtXmlPatterns::tr("The item %1 did not match the required type %2.")
                                     .arg(formatData(item.stringValue()),
                                          formatType(context->namePool(), m_reqType)),
                    m_errorCode,
                    this);
 }

Properties

◆ m_errorCode

const ReportContext::ErrorCode QPatternist::ItemVerifier::m_errorCode

private

Definition at line 95 of file qitemverifier_p.h.

Referenced by verifyItem().

◆ m_reqType

const ItemType::Ptr QPatternist::ItemVerifier::m_reqType

private

Definition at line 94 of file qitemverifier_p.h.

Referenced by staticType(), and verifyItem().

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

/src/xmlpatterns/janitors/qitemverifier_p.h
/src/xmlpatterns/janitors/qitemverifier.cpp

Public Functions

Private Types

Private Functions

Properties

Additional Inherited Members

Detailed Description

Typedefs

◆ ConstPtr

Constructors and Destructors

◆ ItemVerifier()

Functions

◆ accept()

◆ actualReflection()

◆ evaluateSequence()

◆ evaluateSingleton()

◆ expectedOperandTypes()

◆ mapToItem()

◆ staticType()

◆ verifyItem()

Properties

◆ m_errorCode

◆ m_reqType