1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** 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_AggregateFNs_H
53 #define Patternist_AggregateFNs_H
55 #include <private/qaggregator_p.h>
56 #include <private/qatomiccomparator_p.h>
57 #include <private/qatomicmathematician_p.h>
58 #include <private/qcomparisonplatform_p.h>
62 * @short Contains classes implementing the functions found in
63 * <a href="http://www.w3.org/TR/xpath-functions/#aggregate-functions">XQuery 1.0 and
64 * XPath 2.0 Functions and Operators, 15.4 Aggregate Functions</a>.
66 * @todo document that some functions have both eval funcs implented.
68 * @ingroup Patternist_functions
78 * @short Implements the function <tt>fn:count()</tt>.
80 * @ingroup Patternist_functions
81 * @author Frans Englich <frans.englich@nokia.com>
83 class CountFN : public FunctionCall
86 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
89 * If @p reqType is CommonSequenceTypes::EBV, this function call is rewritten
90 * into a call to <tt>fn:exists()</tt>. Hence, <tt>if(count(X)) then ...</tt> is
91 * rewritten into <tt>if(exists(X)) then ...</tt>.
93 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
94 const SequenceType::Ptr &reqType);
96 * If CountFN's operand has a Cardinality that is exact, as per Cardinality::isExact(),
97 * it is rewritten to the Cardinality's count.
99 virtual Expression::Ptr compress(const StaticContext::Ptr &context);
103 * @short Base class for the implementations of the <tt>fn:avg()</tt> and <tt>fn:sum()</tt> function.
105 * @ingroup Patternist_functions
106 * @author Frans Englich <frans.englich@nokia.com>
108 class AddingAggregate : public FunctionCall
111 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
112 const SequenceType::Ptr &reqType);
114 AtomicMathematician::Ptr m_mather;
118 * @short Implements the function <tt>fn:avg()</tt>.
120 * @ingroup Patternist_functions
121 * @author Frans Englich <frans.englich@nokia.com>
123 class AvgFN : public AddingAggregate
126 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
127 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
128 const SequenceType::Ptr &reqType);
130 virtual SequenceType::Ptr staticType() const;
132 AtomicMathematician::Ptr m_adder;
133 AtomicMathematician::Ptr m_divider;
137 * @short Implements the function <tt>fn:sum()</tt>.
139 * @ingroup Patternist_functions
140 * @author Frans Englich <frans.englich@nokia.com>
142 class SumFN : public AddingAggregate
145 virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
146 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
147 const SequenceType::Ptr &reqType);
148 virtual SequenceType::Ptr staticType() const;