tests/auto/xmlpatternssdk/TestItem.h
branchRCL_3
changeset 7 3f74d0d4af4c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/auto/xmlpatternssdk/TestItem.h	Thu Apr 08 14:19:33 2010 +0300
@@ -0,0 +1,133 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the test suite 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$
+**
+****************************************************************************/
+
+#ifndef PatternistSDK_TestItem_H
+#define PatternistSDK_TestItem_H
+
+#include "TestResult.h"
+#include "TreeItem.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+template<typename A, typename B> struct QPair;
+
+namespace QPatternistSDK
+{
+    class XMLWriter;
+    class TestSuite;
+
+    /**
+     * @short base class for all classes which
+     * represent an element in an XQuery Test Suite catalog.
+     *
+     * @ingroup PatternistSDK
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class Q_PATTERNISTSDK_EXPORT TestItem : public TreeItem
+    {
+    public:
+
+        /**
+         * Determines how far an test case execution should go.
+         */
+        enum ExecutionStage
+        {
+            /**
+             * The query will not be run. It will only go through the (whole) compilation stage.
+             */
+            CompileOnly = 1,
+
+            /**
+             * The query will be compiled and run, as ordinary.
+             */
+            CompileAndRun
+        };
+
+        /**
+         * Represents a summary of test results for a collection
+         * of tests. QPair::first contains the amount of
+         * passed tests; QPair::second contains the count of
+         * all tests. For example TestCase::summary() returns
+         * ResultSummary(0, 1) or ResultSummary(1, 1) depending
+         * on whether the TestCase have succeeded or not.
+         */
+        typedef QPair<int, int> ResultSummary;
+
+        /**
+         * Executes the test case(s) this TestItem represents,
+         * and return the TestResult. For example, the TestGroup
+         * returns the result of its children concatenated, while
+         * TestCase always returns a list containing one
+         * TestResult(what it evaluated to).
+         */
+        virtual TestResult::List execute(const ExecutionStage stage,
+                                         TestSuite *ts) = 0;
+
+        /**
+         * @todo Rename this function. Perhaps create a type() hierarchy
+         * instead.
+         */
+        virtual bool isFinalNode() const = 0;
+
+        /**
+         * @returns a ResultSummary for this TestItem.
+         */
+        virtual ResultSummary resultSummary() const = 0;
+
+        /**
+         * Serializes into the corresponding elements attributes
+         * specified in XQTSCatalog.xsd.
+         *
+         * @note Sub-classes must assume the XQTSCatalog namespace
+         * is the default namespace, and not add any namespace declarations.
+         */
+        //virtual void toXML(XMLWriter &receiver) const = 0;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif
+// vim: et:ts=4:sw=4:sts=4