src/xmlpatterns/expr/qfirstitempredicate_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   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.
  16 **
  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.
  20 **
  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.
  28 **
  29 ** Other Usage
  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.
  32 **
  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_FirstItemPredicate_H
  53 #define Patternist_FirstItemPredicate_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short A predicate that always selects the first item from its sequence.
  65      *
  66      * FirstItemPredicate corresponds exactly to the predicate
  67      * in the expression <tt>input[1]</tt>.
  68      *
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @ingroup Patternist_expressions
  71      */
  72     class FirstItemPredicate : public SingleContainer
  73     {
  74     public:
  75         /**
  76          * Creates a FirstItemPredicate that filters @p source.
  77          */
  78         FirstItemPredicate(const Expression::Ptr &source);
  79
  80         /**
  81          * @returns the first item, if any, from evaluating the source expression.
  82          */
  83         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  84
  85         /**
  86          * @returns a list containing one CommonSequenceTypes::ZeroOrMoreItems instance.
  87          */
  88         virtual SequenceType::List expectedOperandTypes() const;
  89
  90         /**
  91          * @returns a SequenceType where the item type is the same as the source expression
  92          * and where the cardinality is either Cardinality::zeroOrOne() or Cardinality::exactlyOne(),
  93          * depending on the source expression.
  94          */
  95         virtual SequenceType::Ptr staticType() const;
  96         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  97
  98         /**
  99          * Rewrites <tt>expression[1][1]</tt> into <tt>expression[1]</tt>.
 100          */
 101         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 102
 103         /**
 104          * @returns always IDFirstItemPredicate.
 105          */
 106         virtual ID id() const;
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif