summaryrefslogtreecommitdiffstats
path: root/src/xmlpatterns/janitors/qcardinalityverifier_p.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/xmlpatterns/janitors/qcardinalityverifier_p.h')
-rw-r--r--src/xmlpatterns/janitors/qcardinalityverifier_p.h128
1 files changed, 128 insertions, 0 deletions
diff --git a/src/xmlpatterns/janitors/qcardinalityverifier_p.h b/src/xmlpatterns/janitors/qcardinalityverifier_p.h
new file mode 100644
index 0000000..c51f1e1
--- /dev/null
+++ b/src/xmlpatterns/janitors/qcardinalityverifier_p.h
@@ -0,0 +1,128 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//
+// W A R N I N G
+// -------------
+//
+// This file is not part of the Qt API. It exists purely as an
+// implementation detail. This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+
+#ifndef Patternist_CardinalityVerifier_H
+#define Patternist_CardinalityVerifier_H
+
+#include "qsinglecontainer_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+
+ /**
+ * @short Verifies that the sequence an Expression evaluates to conforms to a Cardinality.
+ *
+ * @see <a href="http://www.w3.org/TR/xpath-functions/#cardinality-funcs">XQuery 1.0 and
+ * XPath 2.0 Functions and Operators, 15.2 Functions That Test the Cardinality of Sequences</a>
+ * @author Frans Englich <fenglich@trolltech.com>
+ * @ingroup Patternist_expressions
+ */
+ class CardinalityVerifier : public SingleContainer
+ {
+ public:
+ CardinalityVerifier(const Expression::Ptr &operand,
+ const Cardinality &card,
+ const ReportContext::ErrorCode code);
+
+ virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
+ virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
+
+ virtual SequenceType::List expectedOperandTypes() const;
+ virtual SequenceType::Ptr staticType() const;
+
+ virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
+
+ /**
+ * If the static cardinality of the operand is within the required cardinality,
+ * the operand is returned as is, since results will always be valid and hence
+ * is not a CardinalityVerifier necessary.
+ */
+ virtual Expression::Ptr compress(const StaticContext::Ptr &context);
+
+ /**
+ * A utility function for determining whether the static type of an Expression matches
+ * a cardinality. More specifically, this function performs the cardinality verification
+ * part of the Function Conversion Rules.
+ *
+ * @todo Mention the rewrite and when exactly an error is issued via @p context
+ */
+ static Expression::Ptr
+ verifyCardinality(const Expression::Ptr &operand,
+ const Cardinality &card,
+ const StaticContext::Ptr &context,
+ const ReportContext::ErrorCode code = ReportContext::XPTY0004);
+
+ virtual const SourceLocationReflection *actualReflection() const;
+
+ ID id() const;
+ private:
+ /**
+ * Centralizes a message string in order to increase consistency and
+ * reduce work for translators.
+ */
+ static inline QString wrongCardinality(const Cardinality &req,
+ const Cardinality &got = Cardinality::empty());
+
+ const Cardinality m_reqCard;
+ const bool m_allowsMany;
+ const ReportContext::ErrorCode m_errorCode;
+ };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif