src/xmlpatterns/data/qcomparisonfactory_p.h
changeset 0 1918ee327afb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/data/qcomparisonfactory_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,121 @@
+/****************************************************************************
+**
+** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@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_ComparisonFactory_H
+#define Patternist_ComparisonFactory_H
+
+#include "qatomiccomparator_p.h"
+#include "qderivedstring_p.h"
+#include "qitem_p.h"
+#include "qreportcontext_p.h"
+#include "qschematype_p.h"
+
+QT_BEGIN_HEADER
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short Provides compare(), which is a high-level helper function for
+     * comparing atomic values.
+     *
+     * This class wraps the helper class ComparisonPlatform with a more specific,
+     * high-level API.
+     *
+     * @see ComparisonPlatform
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_schema
+     */
+    class ComparisonFactory
+    {
+    public:
+        /**
+         * @short Returns the result of evaluating operator @p op applied to the atomic
+         * values @p operand1 and @p operand2.
+         *
+         * The caller guarantees that both values are of type @p type.
+         *
+         * ComparisonFactory does not take ownership of @p sourceLocationReflection.
+         */
+        static bool compare(const AtomicValue::Ptr &operand1,
+                            const AtomicComparator::Operator op,
+                            const AtomicValue::Ptr &operand2,
+                            const SchemaType::Ptr &type,
+                            const ReportContext::Ptr &context,
+                            const SourceLocationReflection *const sourceLocationReflection);
+
+        /**
+         * @short Returns the result of evaluating operator @p op applied to the atomic
+         * values @p operand1 and @p operand2.
+         *
+         * In opposite to compare() it converts the operands from string type
+         * to @p type and compares these constructed types.
+         *
+         * The caller guarantees that both values are of type @p type.
+         *
+         * ComparisonFactory does not take ownership of @p sourceLocationReflection.
+         */
+        static bool constructAndCompare(const DerivedString<TypeString>::Ptr &operand1,
+                                        const AtomicComparator::Operator op,
+                                        const DerivedString<TypeString>::Ptr &operand2,
+                                        const SchemaType::Ptr &type,
+                                        const ReportContext::Ptr &context,
+                                        const SourceLocationReflection *const sourceLocationReflection);
+
+    private:
+        Q_DISABLE_COPY(ComparisonFactory)
+    };
+}
+
+QT_END_NAMESPACE
+QT_END_HEADER
+
+#endif