Qt 4.8
Public Functions | List of all members
QPatternist::SumFN Class Reference

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

#include <qaggregatefns_p.h>

Inheritance diagram for QPatternist::SumFN:
QPatternist::AddingAggregate QPatternist::FunctionCall QPatternist::UnlimitedContainer QPatternist::Expression QSharedData QPatternist::CppCastingHelper< Expression > QPatternist::SourceLocationReflection

Public Functions

virtual Item evaluateSingleton (const DynamicContext::Ptr &context) const
 
virtual SequenceType::Ptr staticType () const
 
virtual Expression::Ptr typeCheck (const StaticContext::Ptr &context, const SequenceType::Ptr &reqType)
 
- 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
 
- 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 Item::Iterator::Ptr evaluateSequence (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::AddingAggregate
AtomicMathematician::Ptr m_mather
 
- Protected Variables inherited from QPatternist::UnlimitedContainer
Expression::List m_operands
 

Detailed Description

Implements the function fn:sum().

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

Definition at line 142 of file qaggregatefns_p.h.

Functions

◆ evaluateSingleton()

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

Reimplemented from QPatternist::Expression.

Definition at line 234 of file qaggregatefns.cpp.

235 {
236  const Item::Iterator::Ptr it(m_operands.first()->evaluateSequence(context));
237  Item sum(it->next());
238 
239  while(sum)
240  {
241  const Item next(it->next());
242  if(!next)
243  break;
244 
245  sum = ArithmeticExpression::flexiblyCalculate(sum, AtomicMathematician::Add,
246  next, m_mather, context, this,
247  ReportContext::FORG0006);
248  };
249 
250  if(!sum)
251  {
252  if(m_operands.count() == 1)
253  return CommonValues::IntegerZero;
254  else
255  return m_operands.last()->evaluateSingleton(context);
256  }
257 
258  return sum;
259 }
it
#define it(className, varName)
Definition: qbuiltintypes.cpp:95
QPatternist::AddingAggregate::m_mather
AtomicMathematician::Ptr m_mather
Definition: qaggregatefns_p.h:114
QExplicitlySharedDataPointer
The QExplicitlySharedDataPointer class represents a pointer to an explicitly shared object...
Definition: qshareddata.h:136
QList::count
int count(const T &t) const
Returns the number of occurrences of value in the list.
Definition: qlist.h:891
QPatternist::CommonValues::IntegerZero
static const Item IntegerZero
Definition: qcommonvalues_p.h:134
QList::first
T & first()
Returns a reference to the first item in the list.
Definition: qlist.h:282
QPatternist::Item
Represents an item in the XPath 2.0 Data Model.
Definition: qitem_p.h:182
QList::last
T & last()
Returns a reference to the last item in the list.
Definition: qlist.h:284
QPatternist::ArithmeticExpression::flexiblyCalculate
static Item flexiblyCalculate(const Item &op1, const AtomicMathematician::Operator op, const Item &op2, const AtomicMathematician::Ptr &mather, const DynamicContext::Ptr &context, const SourceLocationReflection *const reflection, const ReportContext::ErrorCode code=ReportContext::XPTY0004, const bool isCompat=false)
Definition: qarithmeticexpression.cpp:112
QPatternist::Expression::evaluateSingleton
virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const
Definition: qexpression.cpp:310
QPatternist::Expression::evaluateSequence
virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const
Definition: qexpression.cpp:300

◆ staticType()

SequenceType::Ptr SumFN::staticType ( ) const
virtual
Returns
the static type of this Expression. For example, an 'and' expression have as static type xs:boolean

Reimplemented from QPatternist::FunctionCall.

Definition at line 300 of file qaggregatefns.cpp.

301 {
302  const SequenceType::Ptr t(m_operands.first()->staticType());
303 
304  if(m_operands.count() == 1)
305  {
306  return makeGenericSequenceType(t->itemType() | BuiltinTypes::xsInteger,
307  Cardinality::exactlyOne());
308  }
309  else
310  {
311  return makeGenericSequenceType(t->itemType() | m_operands.at(1)->staticType()->itemType(),
312  t->cardinality().toWithoutMany());
313  }
314 }
QList::count
int count(const T &t) const
Returns the number of occurrences of value in the list.
Definition: qlist.h:891
QList::at
const T & at(int i) const
Returns the item at index position i in the list.
Definition: qlist.h:468
QList::first
T & first()
Returns a reference to the first item in the list.
Definition: qlist.h:282
QPatternist::Expression::staticType
virtual SequenceType::Ptr staticType() const =0
QPatternist::BuiltinTypes::xsInteger
static const AtomicType::Ptr xsInteger
Definition: qbuiltintypes_p.h:99
QPatternist::Cardinality::exactlyOne
static Cardinality exactlyOne()
Definition: qcardinality_p.h:137
QPatternist::SequenceType::itemType
virtual ItemType::Ptr itemType() const =0

◆ typeCheck()

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

This implementation guarantees to never rewrite away this Expression, but at most rewrite it as a child of another expression(that presumably have a type checking role). It is therefore always safe to override this function and call this implementation and not worry about that this Expression becomes deleted.

Many Expressions override typeCheck() and performs optimizations, as opposed to doing it in the compress() stage. This is due to that the design of those Expressions often are tied to that certain simplifications are done at the typeCheck() stage of the compilation process or that it in some other way is related to what the typeCheck() do. Also, the earlier the AST can be simplified, the better the chances are for subsequent optimizations.

It is important that the super class's typeCheck() is called before doing any custom type checking, since the call can change the children(notably, the childrens' static types). For example, if the Expression, MyExpression in the example, does not match the required type, typeCheck returns the Expression wrapped in for example ItemVerifier, CardinalityVerifier, or both.

typeCheck() may be called many times. typeCheck() must either raise an error if this Expression is an invalid expression. Thus, it is guaranteed that an Expression is valid after typeCheck() is called.

Parameters
contextsupplies information, such as namespace bindings and available function signatures, that can be needed at compilation time. context is guaranteed by the caller to never null.
reqTypethe static type that this Expression must match when evaluated. reqType is guaranteed by the caller to never null.
Returns
an Expression that can be this Expression, or another expression, which somehow is necessary for making this Expression conforming to reqType

Reimplemented from QPatternist::AddingAggregate.

Definition at line 261 of file qaggregatefns.cpp.

263 {
264  const Expression::Ptr me(AddingAggregate::typeCheck(context, reqType));
265 
266  if(*CommonSequenceTypes::Empty == *m_operands.first()->staticType()->itemType())
267  {
268  if(m_operands.count() == 1)
269  return wrapLiteral(CommonValues::IntegerZero, context, this);
270  else
271  return m_operands.at(1);
272  }
273 
274  if(m_operands.count() == 1)
275  return me;
276 
277  const ItemType::Ptr t(m_operands.at(1)->staticType()->itemType());
278 
279  if(!BuiltinTypes::numeric->xdtTypeMatches(t) &&
280  !BuiltinTypes::xsAnyAtomicType->xdtTypeMatches(t) &&
281  *CommonSequenceTypes::Empty != *t &&
282  !BuiltinTypes::xsDayTimeDuration->xdtTypeMatches(t) &&
283  !BuiltinTypes::xsYearMonthDuration->xdtTypeMatches(t))
284  {
285  context->error(QtXmlPatterns::tr("The second argument to %1 cannot be "
286  "of type %2. It must be of type %3, "
287  "%4, or %5.")
288  .arg(formatFunction(context->namePool(), signature()))
289  .arg(formatType(context->namePool(), m_operands.at(1)->staticType()))
290  .arg(formatType(context->namePool(), BuiltinTypes::numeric))
291  .arg(formatType(context->namePool(), BuiltinTypes::xsYearMonthDuration))
292  .arg(formatType(context->namePool(), BuiltinTypes::xsDayTimeDuration)),
293  ReportContext::FORG0006, this);
294  return me;
295  }
296 
297  return me;
298 }
QPatternist::BuiltinTypes::xsDayTimeDuration
static const AtomicType::Ptr xsDayTimeDuration
Definition: qbuiltintypes_p.h:90
QPatternist::formatType
QString formatType(const NamePool::Ptr &np, const T &type)
Formats ItemType and SequenceType.
Definition: qpatternistlocale_p.h:160
QPatternist::StaticContext::namePool
virtual NamePool::Ptr namePool() const =0
QList::count
int count(const T &t) const
Returns the number of occurrences of value in the list.
Definition: qlist.h:891
QPatternist::BuiltinTypes::xsYearMonthDuration
static const AtomicType::Ptr xsYearMonthDuration
Definition: qbuiltintypes_p.h:89
QPatternist::CommonValues::IntegerZero
static const Item IntegerZero
Definition: qcommonvalues_p.h:134
QPatternist::ReportContext::error
void error(const QString &message, const ReportContext::ErrorCode errorCode, const QSourceLocation &sourceLocation)
Definition: qreportcontext.cpp:81
QPatternist::formatFunction
static QString formatFunction(const NamePool::Ptr &np, const FunctionSignature::Ptr &func)
Formats FunctionSignature.
Definition: qfunctionsignature_p.h:201
QList::at
const T & at(int i) const
Returns the item at index position i in the list.
Definition: qlist.h:468
QPatternist::AddingAggregate::typeCheck
virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context, const SequenceType::Ptr &reqType)
Definition: qaggregatefns.cpp:98
QPatternist::FunctionCall::signature
virtual FunctionSignature::Ptr signature() const
Definition: qfunctioncall.cpp:114
QList::first
T & first()
Returns a reference to the first item in the list.
Definition: qlist.h:282
QPatternist::Expression::staticType
virtual SequenceType::Ptr staticType() const =0
QPatternist::CommonSequenceTypes::Empty
static const EmptySequenceType::Ptr Empty
Definition: qcommonsequencetypes_p.h:111
QPatternist::BuiltinTypes::numeric
static const AtomicType::Ptr numeric
Definition: qbuiltintypes_p.h:96
QPatternist::BuiltinTypes::xsAnyAtomicType
static const AtomicType::Ptr xsAnyAtomicType
Definition: qbuiltintypes_p.h:83
QPatternist::SequenceType::itemType
virtual ItemType::Ptr itemType() const =0
The documentation for this class was generated from the following files:
Qt 4.8 Source Code Browser