Implements the function fn:trace(). More...

#include <qtracefn_p.h>

Inheritance diagram for QPatternist::TraceFN:

Public Functions
virtual Item::Iterator::Ptr	evaluateSequence (const DynamicContext::Ptr &context) const

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

virtual SequenceType::Ptr	staticType () const

Public Functions inherited from QPatternist::FunctionCall
virtual ExpressionVisitorResult::Ptr	accept (const ExpressionVisitor::Ptr &visitor) const

virtual SequenceType::List	expectedOperandTypes () const

virtual ID	id () const

virtual Expression::Properties	properties () const

virtual void	setSignature (const FunctionSignature::Ptr &sign)

virtual FunctionSignature::Ptr	signature () const

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

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

virtual Expression::List	operands () const

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

	UnlimitedContainer (const Expression::List &operands=Expression::List())

Public Functions inherited from QPatternist::Expression
virtual const SourceLocationReflection *	actualReflection () const
	Returns `this`. More...

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

bool	is (const ID id) const

bool	isEvaluated () const

virtual ItemType::Ptr	newFocusType () const

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

virtual PatternPriority	patternPriority () 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 ()

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 ()

Additional Inherited Members
Public Types inherited from QPatternist::FunctionCall
typedef QExplicitlySharedDataPointer< FunctionCall >	Ptr

Public Types inherited from QPatternist::UnlimitedContainer
enum	CardinalityComputation { ProductOfCardinality, UnionOfCardinality }

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::UnlimitedContainer
template<CardinalityComputation suppliedCard>
SequenceType::Ptr	operandsUnionType () const

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::UnlimitedContainer
Expression::List	m_operands

Detailed Description

Implements the function fn:trace().

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

Definition at line 68 of file qtracefn_p.h.

Functions

◆ evaluateSequence()

Item::Iterator::Ptr TraceFN::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 118 of file qtracefn.cpp.

 {
     const QString msg(m_operands.last()->evaluateSingleton(context).stringValue());
 
     return makeItemMappingIterator<Item>(TraceCallback::Ptr(new TraceCallback(msg)),
                                               m_operands.first()->evaluateSequence(context),
                                               context);
 }

◆ evaluateSingleton()

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

virtual

Reimplemented from QPatternist::Expression.

Definition at line 127 of file qtracefn.cpp.

 {
     const QString msg(m_operands.last()->evaluateSingleton(context).stringValue());
     const Item item(m_operands.first()->evaluateSingleton(context));
 
     return TraceCallback::Ptr(new TraceCallback(msg))->mapToItem(item, context);
 }

◆ staticType()

SequenceType::Ptr TraceFN::staticType ( ) const

virtual

Formally speaking, the type inference is:

statEnv |-  (FN-URI,"trace")(Type) : prime(Type) * quantifier(Type)

       @see <a href="http://www.w3.org/TR/xquery-semantics/#sec_fn_reverse">XQuery 1.0
       and XPath 2.0 Formal Semantics, 7.2.12 The fn:reverse function</a>, for
       an example of where the type inference is used
       @returns the static type of the function's first argument.

Reimplemented from QPatternist::FunctionCall.

Definition at line 135 of file qtracefn.cpp.

 {
     return m_operands.first()->staticType();
 }

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

/src/xmlpatterns/functions/qtracefn_p.h
/src/xmlpatterns/functions/qtracefn.cpp

Public Functions

Additional Inherited Members

Detailed Description

Functions

◆ evaluateSequence()

◆ evaluateSingleton()

◆ staticType()