src/xmlpatterns/functions/qaggregator_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  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.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_Aggregator_H
  53 #define Patternist_Aggregator_H
  54
  55 #include "qfunctioncall_p.h"
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Carries a staticType() implementation appropriate
  66      * for functions which returns a singleton value derived from its first argument.
  67      *
  68      * One example of such a function is FloorFN, implementing <tt>fn:floor()</tt>,
  69      * which returns a single value of the same type as the first argument, or the empty
  70      * sequence if the first argument evaluates to the empty sequence.
  71      *
  72      * Aggregator is abstract, and exists for saving code. It is inherited
  73      * by classes which needs the staticType() implementation this class provides.
  74      *
  75      * @see Piper
  76      * @ingroup Patternist_functions
  77      * @author Frans Englich <frans.englich@nokia.com>
  78      */
  79     class Aggregator : public FunctionCall
  80     {
  81     public:
  82         /**
  83          * @returns a static type where the ItemType is the same as this FunctionCall's first
  84          * argument, and the Cardinality is as return from Cardinality::toWithoutMany().
  85          */
  86         virtual SequenceType::Ptr staticType() const;
  87     };
  88 }
  89
  90 QT_END_NAMESPACE
  91
  92 QT_END_HEADER
  93
  94 #endif