src/testlib/qtestcase.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/testlib/qtestcase.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,375 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtTest 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$
+**
+****************************************************************************/
+
+#ifndef QTESTCASE_H
+#define QTESTCASE_H
+
+#include <QtTest/qtest_global.h>
+
+#include <QtCore/qnamespace.h>
+#include <QtCore/qmetatype.h>
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+QT_MODULE(Test)
+
+#define QVERIFY(statement) \
+do {\
+    if (!QTest::qVerify((statement), #statement, "", __FILE__, __LINE__))\
+        return;\
+} while (0)
+
+#define QFAIL(message) \
+do {\
+    QTest::qFail(message, __FILE__, __LINE__);\
+    return;\
+} while (0)
+
+#define QVERIFY2(statement, description) \
+do {\
+    if (statement) {\
+        if (!QTest::qVerify(true, #statement, (description), __FILE__, __LINE__))\
+            return;\
+    } else {\
+        if (!QTest::qVerify(false, #statement, (description), __FILE__, __LINE__))\
+            return;\
+    }\
+} while (0)
+
+#define QCOMPARE(actual, expected) \
+do {\
+    if (!QTest::qCompare(actual, expected, #actual, #expected, __FILE__, __LINE__))\
+        return;\
+} while (0)
+
+#define QSKIP(statement, mode) \
+do {\
+    QTest::qSkip(statement, QTest::mode, __FILE__, __LINE__);\
+    return;\
+} while (0)
+
+#define QEXPECT_FAIL(dataIndex, comment, mode)\
+do {\
+    if (!QTest::qExpectFail(dataIndex, comment, QTest::mode, __FILE__, __LINE__))\
+        return;\
+} while (0)
+
+#define QFETCH(type, name)\
+    type name = *static_cast<type *>(QTest::qData(#name, ::qMetaTypeId<type >()))
+
+#define QFETCH_GLOBAL(type, name)\
+    type name = *static_cast<type *>(QTest::qGlobalData(#name, ::qMetaTypeId<type >()))
+
+#define DEPENDS_ON(funcName)
+
+#define QTEST(actual, testElement)\
+do {\
+    if (!QTest::qTest(actual, testElement, #actual, #testElement, __FILE__, __LINE__))\
+        return;\
+} while (0)
+
+#define QWARN(msg)\
+    QTest::qWarn(msg)
+
+class QObject;
+class QTestData;
+
+#define QTEST_COMPARE_DECL(KLASS)\
+    template<> Q_TESTLIB_EXPORT char *toString<KLASS >(const KLASS &);
+
+namespace QTest
+{
+    template <typename T>
+    inline char *toString(const T &)
+    {
+        return 0;
+    }
+
+
+    Q_TESTLIB_EXPORT char *toHexRepresentation(const char *ba, int length);
+    Q_TESTLIB_EXPORT char *toString(const char *);
+    Q_TESTLIB_EXPORT char *toString(const void *);
+
+    Q_TESTLIB_EXPORT int qExec(QObject *testObject, int argc = 0, char **argv = 0);
+    Q_TESTLIB_EXPORT int qExec(QObject *testObject, const QStringList &arguments);
+
+    Q_TESTLIB_EXPORT bool qVerify(bool statement, const char *statementStr, const char *description,
+                                 const char *file, int line);
+    Q_TESTLIB_EXPORT void qFail(const char *statementStr, const char *file, int line);
+    Q_TESTLIB_EXPORT void qSkip(const char *message, SkipMode mode, const char *file, int line);
+    Q_TESTLIB_EXPORT bool qExpectFail(const char *dataIndex, const char *comment, TestFailMode mode,
+                           const char *file, int line);
+    Q_TESTLIB_EXPORT void qWarn(const char *message);
+    Q_TESTLIB_EXPORT void ignoreMessage(QtMsgType type, const char *message);
+
+    Q_TESTLIB_EXPORT void *qData(const char *tagName, int typeId);
+    Q_TESTLIB_EXPORT void *qGlobalData(const char *tagName, int typeId);
+    Q_TESTLIB_EXPORT void *qElementData(const char *elementName, int metaTypeId);
+    Q_TESTLIB_EXPORT QObject *testObject();
+
+    Q_TESTLIB_EXPORT const char *currentTestFunction();
+    Q_TESTLIB_EXPORT const char *currentDataTag();
+    Q_TESTLIB_EXPORT bool currentTestFailed();
+
+    Q_TESTLIB_EXPORT Qt::Key asciiToKey(char ascii);
+    Q_TESTLIB_EXPORT char keyToAscii(Qt::Key key);
+
+    Q_TESTLIB_EXPORT bool compare_helper(bool success, const char *msg, const char *file,
+                                          int line);
+    Q_TESTLIB_EXPORT bool compare_helper(bool success, const char *msg, char *val1, char *val2,
+                                         const char *expected, const char *actual,
+                                         const char *file, int line);
+    Q_TESTLIB_EXPORT void qSleep(int ms);
+    Q_TESTLIB_EXPORT void addColumnInternal(int id, const char *name);
+
+    template <typename T>
+    inline void addColumn(const char *name, T * = 0)
+    {
+        addColumnInternal(qMetaTypeId<T>(), name);
+    }
+    Q_TESTLIB_EXPORT QTestData &newRow(const char *dataTag);
+
+    template <typename T>
+    inline bool qCompare(T const &t1, T const &t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return (t1 == t2)
+            ? compare_helper(true, "COMPARE()", file, line)
+            : compare_helper(false, "Compared values are not the same",
+                             toString<T>(t1), toString<T>(t2), actual, expected, file, line);
+    }
+
+
+    template <>
+    Q_TESTLIB_EXPORT bool qCompare<float>(float const &t1, float const &t2,
+                    const char *actual, const char *expected, const char *file, int line);
+
+    template <>
+    Q_TESTLIB_EXPORT bool qCompare<double>(double const &t1, double const &t2,
+                    const char *actual, const char *expected, const char *file, int line);
+
+    inline bool compare_ptr_helper(const void *t1, const void *t2, const char *actual,
+                                   const char *expected, const char *file, int line)
+    {
+        return (t1 == t2)
+            ? compare_helper(true, "COMPARE()", file, line)
+            : compare_helper(false, "Compared pointers are not the same",
+                             toString(t1), toString(t2), actual, expected, file, line);
+    }
+
+    Q_TESTLIB_EXPORT bool compare_string_helper(const char *t1, const char *t2, const char *actual,
+                                      const char *expected, const char *file, int line);
+
+#ifndef qdoc
+    QTEST_COMPARE_DECL(short)
+    QTEST_COMPARE_DECL(ushort)
+    QTEST_COMPARE_DECL(int)
+    QTEST_COMPARE_DECL(uint)
+    QTEST_COMPARE_DECL(long)
+    QTEST_COMPARE_DECL(ulong)
+    QTEST_COMPARE_DECL(qint64)
+    QTEST_COMPARE_DECL(quint64)
+
+    QTEST_COMPARE_DECL(float)
+    QTEST_COMPARE_DECL(double)
+    QTEST_COMPARE_DECL(char)
+    QTEST_COMPARE_DECL(bool)
+#endif
+
+#ifndef QTEST_NO_SPECIALIZATIONS
+    template <typename T1, typename T2>
+    bool qCompare(T1 const &, T2 const &, const char *, const char *, const char *, int);
+
+#if defined(QT_COORD_TYPE) && (defined(QT_ARCH_ARM) || defined(QT_NO_FPU) || defined(QT_ARCH_WINDOWSCE))
+    template <>
+    inline bool qCompare<qreal, float>(qreal const &t1, float const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<qreal>(t1, qreal(t2), actual, expected, file, line);
+    }
+
+    template <>
+    inline bool qCompare<float, qreal>(float const &t1, qreal const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<qreal>(qreal(t1), t2, actual, expected, file, line);
+    }
+
+#elif defined(QT_COORD_TYPE) || defined(QT_ARCH_ARM) || defined(QT_NO_FPU) || defined(QT_ARCH_WINDOWSCE) || defined(QT_ARCH_SYMBIAN)
+    template <>
+    inline bool qCompare<qreal, double>(qreal const &t1, double const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
+    }
+
+    template <>
+    inline bool qCompare<double, qreal>(double const &t1, qreal const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
+    }
+
+#endif
+
+    template <typename T>
+    inline bool qCompare(const T *t1, const T *t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return compare_ptr_helper(t1, t2, actual, expected, file, line);
+    }
+    template <typename T>
+    inline bool qCompare(T *t1, T *t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return compare_ptr_helper(t1, t2, actual, expected, file, line);
+    }
+
+    template <typename T1, typename T2>
+    inline bool qCompare(const T1 *t1, const T2 *t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return compare_ptr_helper(t1, static_cast<const T1 *>(t2), actual, expected, file, line);
+    }
+    template <typename T1, typename T2>
+    inline bool qCompare(T1 *t1, T2 *t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return compare_ptr_helper(const_cast<const T1 *>(t1),
+                static_cast<const T1 *>(const_cast<const T2 *>(t2)), actual, expected, file, line);
+    }
+    template<>
+    inline bool qCompare<char>(const char *t1, const char *t2, const char *actual,
+                                       const char *expected, const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+    template<>
+    inline bool qCompare<char>(char *t1, char *t2, const char *actual, const char *expected,
+                        const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+#else  /* QTEST_NO_SPECIALIZATIONS */
+
+// In Symbian we have QTEST_NO_SPECIALIZATIONS defined, but still float related specialization
+// should be used. If QTEST_NO_SPECIALIZATIONS is enabled we get ambiguous overload errors.
+#if defined(QT_ARCH_SYMBIAN)
+    template <typename T1, typename T2>
+    bool qCompare(T1 const &, T2 const &, const char *, const char *, const char *, int);
+
+    template <>
+    inline bool qCompare<qreal, double>(qreal const &t1, double const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
+    }
+
+    template <>
+    inline bool qCompare<double, qreal>(double const &t1, qreal const &t2, const char *actual,
+                                 const char *expected, const char *file, int line)
+    {
+        return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
+    }
+#endif
+
+    inline bool qCompare(const char *t1, const char *t2, const char *actual,
+                         const char *expected, const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+
+    inline bool qCompare(char *t1, char *t2, const char *actual, const char *expected,
+                         const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+#endif
+
+    /* The next two specializations are for MSVC that shows problems with implicit
+       conversions
+     */
+#ifndef QTEST_NO_SPECIALIZATIONS
+    template<>
+#endif
+    inline bool qCompare(char *t1, const char *t2, const char *actual,
+                         const char *expected, const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+#ifndef QTEST_NO_SPECIALIZATIONS
+    template<>
+#endif
+    inline bool qCompare(const char *t1, char *t2, const char *actual,
+                         const char *expected, const char *file, int line)
+    {
+        return compare_string_helper(t1, t2, actual, expected, file, line);
+    }
+
+    // NokiaX86 and RVCT do not like implicitly comparing bool with int
+#ifndef QTEST_NO_SPECIALIZATIONS
+    template <>
+#endif
+    inline bool qCompare(bool const &t1, int const &t2,
+                    const char *actual, const char *expected, const char *file, int line)
+    {
+        return qCompare<int>(int(t1), t2, actual, expected, file, line);
+    }
+
+
+    template <class T>
+    inline bool qTest(const T& actual, const char *elementName, const char *actualStr,
+                     const char *expected, const char *file, int line)
+    {
+        return qCompare(actual, *static_cast<const T *>(QTest::qElementData(elementName,
+                       qMetaTypeId<T>())), actualStr, expected, file, line);
+    }
+}
+
+#undef QTEST_COMPARE_DECL
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif