| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** Contact: Qt Software Information (qt-info@nokia.com)
|
|---|
| 5 | **
|
|---|
| 6 | ** This file is part of the QtTest module of the Qt Toolkit.
|
|---|
| 7 | **
|
|---|
| 8 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 9 | ** Commercial Usage
|
|---|
| 10 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 11 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 12 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 13 | ** a written agreement between you and Nokia.
|
|---|
| 14 | **
|
|---|
| 15 | ** GNU Lesser General Public License Usage
|
|---|
| 16 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 17 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 18 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 19 | ** packaging of this file. Please review the following information to
|
|---|
| 20 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 21 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 22 | **
|
|---|
| 23 | ** In addition, as a special exception, Nokia gives you certain
|
|---|
| 24 | ** additional rights. These rights are described in the Nokia Qt LGPL
|
|---|
| 25 | ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
|
|---|
| 26 | ** package.
|
|---|
| 27 | **
|
|---|
| 28 | ** GNU General Public License Usage
|
|---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
|---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
|---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
|---|
| 32 | ** packaging of this file. Please review the following information to
|
|---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
|---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
|---|
| 35 | **
|
|---|
| 36 | ** If you are unsure which license is appropriate for your use, please
|
|---|
| 37 | ** contact the sales department at qt-sales@nokia.com.
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | #ifndef QTESTCASE_H
|
|---|
| 43 | #define QTESTCASE_H
|
|---|
| 44 |
|
|---|
| 45 | #include <QtTest/qtest_global.h>
|
|---|
| 46 |
|
|---|
| 47 | #include <QtCore/qnamespace.h>
|
|---|
| 48 | #include <QtCore/qmetatype.h>
|
|---|
| 49 |
|
|---|
| 50 | QT_BEGIN_HEADER
|
|---|
| 51 |
|
|---|
| 52 | QT_BEGIN_NAMESPACE
|
|---|
| 53 |
|
|---|
| 54 | QT_MODULE(Test)
|
|---|
| 55 |
|
|---|
| 56 | #define QVERIFY(statement) \
|
|---|
| 57 | do {\
|
|---|
| 58 | if (!QTest::qVerify((statement), #statement, "", __FILE__, __LINE__))\
|
|---|
| 59 | return;\
|
|---|
| 60 | } while (0)
|
|---|
| 61 |
|
|---|
| 62 | #define QFAIL(message) \
|
|---|
| 63 | do {\
|
|---|
| 64 | QTest::qFail(message, __FILE__, __LINE__);\
|
|---|
| 65 | return;\
|
|---|
| 66 | } while (0)
|
|---|
| 67 |
|
|---|
| 68 | #define QVERIFY2(statement, description) \
|
|---|
| 69 | do {\
|
|---|
| 70 | if (statement) {\
|
|---|
| 71 | if (!QTest::qVerify(true, #statement, (description), __FILE__, __LINE__))\
|
|---|
| 72 | return;\
|
|---|
| 73 | } else {\
|
|---|
| 74 | if (!QTest::qVerify(false, #statement, (description), __FILE__, __LINE__))\
|
|---|
| 75 | return;\
|
|---|
| 76 | }\
|
|---|
| 77 | } while (0)
|
|---|
| 78 |
|
|---|
| 79 | #define QCOMPARE(actual, expected) \
|
|---|
| 80 | do {\
|
|---|
| 81 | if (!QTest::qCompare(actual, expected, #actual, #expected, __FILE__, __LINE__))\
|
|---|
| 82 | return;\
|
|---|
| 83 | } while (0)
|
|---|
| 84 |
|
|---|
| 85 | #define QSKIP(statement, mode) \
|
|---|
| 86 | do {\
|
|---|
| 87 | QTest::qSkip(statement, QTest::mode, __FILE__, __LINE__);\
|
|---|
| 88 | return;\
|
|---|
| 89 | } while (0)
|
|---|
| 90 |
|
|---|
| 91 | #define QEXPECT_FAIL(dataIndex, comment, mode)\
|
|---|
| 92 | do {\
|
|---|
| 93 | if (!QTest::qExpectFail(dataIndex, comment, QTest::mode, __FILE__, __LINE__))\
|
|---|
| 94 | return;\
|
|---|
| 95 | } while (0)
|
|---|
| 96 |
|
|---|
| 97 | #define QFETCH(type, name)\
|
|---|
| 98 | type name = *static_cast<type *>(QTest::qData(#name, ::qMetaTypeId<type >()))
|
|---|
| 99 |
|
|---|
| 100 | #define QFETCH_GLOBAL(type, name)\
|
|---|
| 101 | type name = *static_cast<type *>(QTest::qGlobalData(#name, ::qMetaTypeId<type >()))
|
|---|
| 102 |
|
|---|
| 103 | #define DEPENDS_ON(funcName)
|
|---|
| 104 |
|
|---|
| 105 | #define QTEST(actual, testElement)\
|
|---|
| 106 | do {\
|
|---|
| 107 | if (!QTest::qTest(actual, testElement, #actual, #testElement, __FILE__, __LINE__))\
|
|---|
| 108 | return;\
|
|---|
| 109 | } while (0)
|
|---|
| 110 |
|
|---|
| 111 | #define QWARN(msg)\
|
|---|
| 112 | QTest::qWarn(msg)
|
|---|
| 113 |
|
|---|
| 114 | class QObject;
|
|---|
| 115 | class QTestData;
|
|---|
| 116 |
|
|---|
| 117 | #define QTEST_COMPARE_DECL(KLASS)\
|
|---|
| 118 | template<> Q_TESTLIB_EXPORT char *toString<KLASS >(const KLASS &);
|
|---|
| 119 |
|
|---|
| 120 | namespace QTest
|
|---|
| 121 | {
|
|---|
| 122 | template <typename T>
|
|---|
| 123 | inline char *toString(const T &)
|
|---|
| 124 | {
|
|---|
| 125 | return 0;
|
|---|
| 126 | }
|
|---|
| 127 |
|
|---|
| 128 | Q_TESTLIB_EXPORT char *toHexRepresentation(const char *ba, int length);
|
|---|
| 129 | Q_TESTLIB_EXPORT char *toString(const char *);
|
|---|
| 130 | Q_TESTLIB_EXPORT char *toString(const void *);
|
|---|
| 131 |
|
|---|
| 132 | Q_TESTLIB_EXPORT int qExec(QObject *testObject, int argc = 0, char **argv = 0);
|
|---|
| 133 | Q_TESTLIB_EXPORT int qExec(QObject *testObject, const QStringList &arguments);
|
|---|
| 134 |
|
|---|
| 135 | Q_TESTLIB_EXPORT bool qVerify(bool statement, const char *statementStr, const char *description,
|
|---|
| 136 | const char *file, int line);
|
|---|
| 137 | Q_TESTLIB_EXPORT void qFail(const char *statementStr, const char *file, int line);
|
|---|
| 138 | Q_TESTLIB_EXPORT void qSkip(const char *message, SkipMode mode, const char *file, int line);
|
|---|
| 139 | Q_TESTLIB_EXPORT bool qExpectFail(const char *dataIndex, const char *comment, TestFailMode mode,
|
|---|
| 140 | const char *file, int line);
|
|---|
| 141 | Q_TESTLIB_EXPORT void qWarn(const char *message);
|
|---|
| 142 | Q_TESTLIB_EXPORT void ignoreMessage(QtMsgType type, const char *message);
|
|---|
| 143 |
|
|---|
| 144 | Q_TESTLIB_EXPORT void *qData(const char *tagName, int typeId);
|
|---|
| 145 | Q_TESTLIB_EXPORT void *qGlobalData(const char *tagName, int typeId);
|
|---|
| 146 | Q_TESTLIB_EXPORT void *qElementData(const char *elementName, int metaTypeId);
|
|---|
| 147 | Q_TESTLIB_EXPORT QObject *testObject();
|
|---|
| 148 |
|
|---|
| 149 | Q_TESTLIB_EXPORT const char *currentTestFunction();
|
|---|
| 150 | Q_TESTLIB_EXPORT const char *currentDataTag();
|
|---|
| 151 | Q_TESTLIB_EXPORT bool currentTestFailed();
|
|---|
| 152 |
|
|---|
| 153 | Q_TESTLIB_EXPORT Qt::Key asciiToKey(char ascii);
|
|---|
| 154 | Q_TESTLIB_EXPORT char keyToAscii(Qt::Key key);
|
|---|
| 155 |
|
|---|
| 156 | Q_TESTLIB_EXPORT bool compare_helper(bool success, const char *msg, const char *file,
|
|---|
| 157 | int line);
|
|---|
| 158 | Q_TESTLIB_EXPORT bool compare_helper(bool success, const char *msg, char *val1, char *val2,
|
|---|
| 159 | const char *expected, const char *actual,
|
|---|
| 160 | const char *file, int line);
|
|---|
| 161 | Q_TESTLIB_EXPORT void qSleep(int ms);
|
|---|
| 162 | Q_TESTLIB_EXPORT void addColumnInternal(int id, const char *name);
|
|---|
| 163 |
|
|---|
| 164 | template <typename T>
|
|---|
| 165 | inline void addColumn(const char *name, T * = 0)
|
|---|
| 166 | {
|
|---|
| 167 | addColumnInternal(qMetaTypeId<T>(), name);
|
|---|
| 168 | }
|
|---|
| 169 | Q_TESTLIB_EXPORT QTestData &newRow(const char *dataTag);
|
|---|
| 170 |
|
|---|
| 171 | template <typename T>
|
|---|
| 172 | inline bool qCompare(T const &t1, T const &t2, const char *actual, const char *expected,
|
|---|
| 173 | const char *file, int line)
|
|---|
| 174 | {
|
|---|
| 175 | return (t1 == t2)
|
|---|
| 176 | ? compare_helper(true, "COMPARE()", file, line)
|
|---|
| 177 | : compare_helper(false, "Compared values are not the same",
|
|---|
| 178 | toString<T>(t1), toString<T>(t2), actual, expected, file, line);
|
|---|
| 179 | }
|
|---|
| 180 |
|
|---|
| 181 | template <>
|
|---|
| 182 | Q_TESTLIB_EXPORT bool qCompare<float>(float const &t1, float const &t2,
|
|---|
| 183 | const char *actual, const char *expected, const char *file, int line);
|
|---|
| 184 |
|
|---|
| 185 | template <>
|
|---|
| 186 | Q_TESTLIB_EXPORT bool qCompare<double>(double const &t1, double const &t2,
|
|---|
| 187 | const char *actual, const char *expected, const char *file, int line);
|
|---|
| 188 |
|
|---|
| 189 | inline bool compare_ptr_helper(const void *t1, const void *t2, const char *actual,
|
|---|
| 190 | const char *expected, const char *file, int line)
|
|---|
| 191 | {
|
|---|
| 192 | return (t1 == t2)
|
|---|
| 193 | ? compare_helper(true, "COMPARE()", file, line)
|
|---|
| 194 | : compare_helper(false, "Compared pointers are not the same",
|
|---|
| 195 | toString(t1), toString(t2), actual, expected, file, line);
|
|---|
| 196 | }
|
|---|
| 197 |
|
|---|
| 198 | Q_TESTLIB_EXPORT bool compare_string_helper(const char *t1, const char *t2, const char *actual,
|
|---|
| 199 | const char *expected, const char *file, int line);
|
|---|
| 200 |
|
|---|
| 201 | #ifndef qdoc
|
|---|
| 202 | QTEST_COMPARE_DECL(short)
|
|---|
| 203 | QTEST_COMPARE_DECL(ushort)
|
|---|
| 204 | QTEST_COMPARE_DECL(int)
|
|---|
| 205 | QTEST_COMPARE_DECL(uint)
|
|---|
| 206 | QTEST_COMPARE_DECL(long)
|
|---|
| 207 | QTEST_COMPARE_DECL(ulong)
|
|---|
| 208 | QTEST_COMPARE_DECL(qint64)
|
|---|
| 209 | QTEST_COMPARE_DECL(quint64)
|
|---|
| 210 |
|
|---|
| 211 | QTEST_COMPARE_DECL(float)
|
|---|
| 212 | QTEST_COMPARE_DECL(double)
|
|---|
| 213 | QTEST_COMPARE_DECL(char)
|
|---|
| 214 | QTEST_COMPARE_DECL(bool)
|
|---|
| 215 | #endif
|
|---|
| 216 |
|
|---|
| 217 | #ifndef QTEST_NO_SPECIALIZATIONS
|
|---|
| 218 | template <typename T1, typename T2>
|
|---|
| 219 | bool qCompare(T1 const &, T2 const &, const char *, const char *, const char *, int);
|
|---|
| 220 |
|
|---|
| 221 | #if defined(QT_ARCH_WINDOWSCE) && defined(QT_COORD_TYPE)
|
|---|
| 222 | template <>
|
|---|
| 223 | inline bool qCompare<qreal, float>(qreal const &t1, float const &t2, const char *actual,
|
|---|
| 224 | const char *expected, const char *file, int line)
|
|---|
| 225 | {
|
|---|
| 226 | return qCompare<qreal>(t1, qreal(t2), actual, expected, file, line);
|
|---|
| 227 | }
|
|---|
| 228 |
|
|---|
| 229 | template <>
|
|---|
| 230 | inline bool qCompare<float, qreal>(float const &t1, qreal const &t2, const char *actual,
|
|---|
| 231 | const char *expected, const char *file, int line)
|
|---|
| 232 | {
|
|---|
| 233 | return qCompare<qreal>(qreal(t1), t2, actual, expected, file, line);
|
|---|
| 234 | }
|
|---|
| 235 |
|
|---|
| 236 | #elif defined(QT_COORD_TYPE) || defined(QT_ARCH_ARM) || defined(QT_NO_FPU) || defined(QT_ARCH_WINDOWSCE)
|
|---|
| 237 | template <>
|
|---|
| 238 | inline bool qCompare<qreal, double>(qreal const &t1, double const &t2, const char *actual,
|
|---|
| 239 | const char *expected, const char *file, int line)
|
|---|
| 240 | {
|
|---|
| 241 | return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
|
|---|
| 242 | }
|
|---|
| 243 |
|
|---|
| 244 | template <>
|
|---|
| 245 | inline bool qCompare<double, qreal>(double const &t1, qreal const &t2, const char *actual,
|
|---|
| 246 | const char *expected, const char *file, int line)
|
|---|
| 247 | {
|
|---|
| 248 | return qCompare<float>(float(t1), float(t2), actual, expected, file, line);
|
|---|
| 249 | }
|
|---|
| 250 |
|
|---|
| 251 | #endif
|
|---|
| 252 |
|
|---|
| 253 | template <typename T>
|
|---|
| 254 | inline bool qCompare(const T *t1, const T *t2, const char *actual, const char *expected,
|
|---|
| 255 | const char *file, int line)
|
|---|
| 256 | {
|
|---|
| 257 | return compare_ptr_helper(t1, t2, actual, expected, file, line);
|
|---|
| 258 | }
|
|---|
| 259 | template <typename T>
|
|---|
| 260 | inline bool qCompare(T *t1, T *t2, const char *actual, const char *expected,
|
|---|
| 261 | const char *file, int line)
|
|---|
| 262 | {
|
|---|
| 263 | return compare_ptr_helper(t1, t2, actual, expected, file, line);
|
|---|
| 264 | }
|
|---|
| 265 |
|
|---|
| 266 | template <typename T1, typename T2>
|
|---|
| 267 | inline bool qCompare(const T1 *t1, const T2 *t2, const char *actual, const char *expected,
|
|---|
| 268 | const char *file, int line)
|
|---|
| 269 | {
|
|---|
| 270 | return compare_ptr_helper(t1, static_cast<const T1 *>(t2), actual, expected, file, line);
|
|---|
| 271 | }
|
|---|
| 272 | template <typename T1, typename T2>
|
|---|
| 273 | inline bool qCompare(T1 *t1, T2 *t2, const char *actual, const char *expected,
|
|---|
| 274 | const char *file, int line)
|
|---|
| 275 | {
|
|---|
| 276 | return compare_ptr_helper(const_cast<const T1 *>(t1),
|
|---|
| 277 | static_cast<const T1 *>(const_cast<const T2 *>(t2)), actual, expected, file, line);
|
|---|
| 278 | }
|
|---|
| 279 | template<>
|
|---|
| 280 | inline bool qCompare<char>(const char *t1, const char *t2, const char *actual,
|
|---|
| 281 | const char *expected, const char *file, int line)
|
|---|
| 282 | {
|
|---|
| 283 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 284 | }
|
|---|
| 285 | template<>
|
|---|
| 286 | inline bool qCompare<char>(char *t1, char *t2, const char *actual, const char *expected,
|
|---|
| 287 | const char *file, int line)
|
|---|
| 288 | {
|
|---|
| 289 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 290 | }
|
|---|
| 291 | #else /* QTEST_NO_SPECIALIZATIONS */
|
|---|
| 292 | inline bool qCompare(const char *t1, const char *t2, const char *actual,
|
|---|
| 293 | const char *expected, const char *file, int line)
|
|---|
| 294 | {
|
|---|
| 295 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 296 | }
|
|---|
| 297 |
|
|---|
| 298 | inline bool qCompare(char *t1, char *t2, const char *actual, const char *expected,
|
|---|
| 299 | const char *file, int line)
|
|---|
| 300 | {
|
|---|
| 301 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 302 | }
|
|---|
| 303 | #endif
|
|---|
| 304 |
|
|---|
| 305 | /* The next two specializations are for MSVC that shows problems with implicit
|
|---|
| 306 | conversions
|
|---|
| 307 | */
|
|---|
| 308 | #ifndef QTEST_NO_SPECIALIZATIONS
|
|---|
| 309 | template<>
|
|---|
| 310 | #endif
|
|---|
| 311 | inline bool qCompare(char *t1, const char *t2, const char *actual,
|
|---|
| 312 | const char *expected, const char *file, int line)
|
|---|
| 313 | {
|
|---|
| 314 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 315 | }
|
|---|
| 316 | #ifndef QTEST_NO_SPECIALIZATIONS
|
|---|
| 317 | template<>
|
|---|
| 318 | #endif
|
|---|
| 319 | inline bool qCompare(const char *t1, char *t2, const char *actual,
|
|---|
| 320 | const char *expected, const char *file, int line)
|
|---|
| 321 | {
|
|---|
| 322 | return compare_string_helper(t1, t2, actual, expected, file, line);
|
|---|
| 323 | }
|
|---|
| 324 |
|
|---|
| 325 | template <class T>
|
|---|
| 326 | inline bool qTest(const T& actual, const char *elementName, const char *actualStr,
|
|---|
| 327 | const char *expected, const char *file, int line)
|
|---|
| 328 | {
|
|---|
| 329 | return qCompare(actual, *static_cast<const T *>(QTest::qElementData(elementName,
|
|---|
| 330 | qMetaTypeId<T>())), actualStr, expected, file, line);
|
|---|
| 331 | }
|
|---|
| 332 | }
|
|---|
| 333 |
|
|---|
| 334 | #undef QTEST_COMPARE_DECL
|
|---|
| 335 |
|
|---|
| 336 | QT_END_NAMESPACE
|
|---|
| 337 |
|
|---|
| 338 | QT_END_HEADER
|
|---|
| 339 |
|
|---|
| 340 | #endif
|
|---|