src/xmlpatterns/janitors/qcardinalityverifier_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_CardinalityVerifier_H
  53 #define Patternist_CardinalityVerifier_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     /**
  65      * @short Verifies that the sequence an Expression evaluates to conforms to a Cardinality.
  66      *
  67      * @see <a href="http://www.w3.org/TR/xpath-functions/#cardinality-funcs">XQuery 1.0 and
  68      * XPath 2.0 Functions and Operators, 15.2 Functions That Test the Cardinality of Sequences</a>
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @ingroup Patternist_expressions
  71      */
  72     class CardinalityVerifier : public SingleContainer
  73     {
  74     public:
  75         CardinalityVerifier(const Expression::Ptr &operand,
  76                             const Cardinality &card,
  77                             const ReportContext::ErrorCode code);
  78
  79         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  80         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  81
  82         virtual SequenceType::List expectedOperandTypes() const;
  83         virtual SequenceType::Ptr staticType() const;
  84
  85         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  86
  87         /**
  88          * If the static cardinality of the operand is within the required cardinality,
  89          * the operand is returned as is, since results will always be valid and hence
  90          * is not a CardinalityVerifier necessary.
  91          */
  92         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  93
  94         /**
  95          * A utility function for determining whether the static type of an Expression matches
  96          * a cardinality. More specifically, this function performs the cardinality verification
  97          * part of the Function Conversion Rules.
  98          *
  99          * @todo Mention the rewrite and when exactly an error is issued via @p context
 100          */
 101         static Expression::Ptr
 102         verifyCardinality(const Expression::Ptr &operand,
 103                           const Cardinality &card,
 104                           const StaticContext::Ptr &context,
 105                           const ReportContext::ErrorCode code = ReportContext::XPTY0004);
 106
 107         virtual const SourceLocationReflection *actualReflection() const;
 108
 109         ID id() const;
 110     private:
 111         /**
 112          * Centralizes a message string in order to increase consistency and
 113          * reduce work for translators.
 114          */
 115         static inline QString wrongCardinality(const Cardinality &req,
 116                                                const Cardinality &got = Cardinality::empty());
 117
 118         const Cardinality m_reqCard;
 119         const bool m_allowsMany;
 120         const ReportContext::ErrorCode m_errorCode;
 121     };
 122 }
 123
 124 QT_END_NAMESPACE
 125
 126 QT_END_HEADER
 127
 128 #endif