qt5base-lts/src/testlib/qtest.h
Marc Mutz 1ed8a7bff5 QTest: support nullptr in QCOMPARE
This allows to write
  QCOMPARE(ptr, nullptr);
instead of
  QVERIFY(ptr);

Task-number: QTBUG-49973
Change-Id: I6e1327d4327bcf17bd9b59de4352fdcaae98ac27
Reviewed-by: Olivier Goffart (Woboq GmbH) <ogoffart@woboq.com>
2016-04-08 05:38:33 +00:00

405 lines
12 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Copyright (C) 2016 Intel Corporation.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtTest module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTEST_H
#define QTEST_H
#include <QtTest/qtest_global.h>
#include <QtTest/qtestcase.h>
#include <QtTest/qtestdata.h>
#include <QtTest/qbenchmark.h>
#include <QtCore/qbytearray.h>
#include <QtCore/qstring.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qdatetime.h>
#include <QtCore/qobject.h>
#include <QtCore/qvariant.h>
#include <QtCore/qurl.h>
#include <QtCore/qpoint.h>
#include <QtCore/qsize.h>
#include <QtCore/qrect.h>
#ifdef QT_NETWORK_LIB
# include <QtNetwork/qhostaddress.h>
#endif
QT_BEGIN_NAMESPACE
namespace QTest
{
template<> inline char *toString(const QString &str)
{
return QTest::toPrettyUnicode(reinterpret_cast<const ushort *>(str.constData()), str.length());
}
template<> inline char *toString(const QLatin1String &str)
{
return toString(QString(str));
}
template<> inline char *toString(const QByteArray &ba)
{
return QTest::toPrettyCString(ba.constData(), ba.length());
}
#ifndef QT_NO_DATESTRING
template<> inline char *toString(const QTime &time)
{
return time.isValid()
? qstrdup(qPrintable(time.toString(QLatin1String("hh:mm:ss.zzz"))))
: qstrdup("Invalid QTime");
}
template<> inline char *toString(const QDate &date)
{
return date.isValid()
? qstrdup(qPrintable(date.toString(QLatin1String("yyyy/MM/dd"))))
: qstrdup("Invalid QDate");
}
template<> inline char *toString(const QDateTime &dateTime)
{
return dateTime.isValid()
? qstrdup(qPrintable(dateTime.toString(QLatin1String("yyyy/MM/dd hh:mm:ss.zzz[t]"))))
: qstrdup("Invalid QDateTime");
}
#endif // QT_NO_DATESTRING
template<> inline char *toString(const QChar &c)
{
return qstrdup(qPrintable(QString::fromLatin1("QChar: '%1' (0x%2)").arg(c).arg(QString::number(static_cast<int>(c.unicode()), 16))));
}
template<> inline char *toString(const QPoint &p)
{
return qstrdup(QString::fromLatin1("QPoint(%1,%2)").arg(p.x()).arg(p.y()).toLatin1().constData());
}
template<> inline char *toString(const QSize &s)
{
return qstrdup(QString::fromLatin1("QSize(%1x%2)").arg(s.width()).arg(s.height()).toLatin1().constData());
}
template<> inline char *toString(const QRect &s)
{
return qstrdup(QString::fromLatin1("QRect(%1,%2 %5x%6) (bottomright %3,%4)").arg(s.left()).arg(s.top()).arg(s.right()).arg(s.bottom()).arg(s.width()).arg(s.height()).toLatin1().constData());
}
template<> inline char *toString(const QPointF &p)
{
return qstrdup(QString::fromLatin1("QPointF(%1,%2)").arg(p.x()).arg(p.y()).toLatin1().constData());
}
template<> inline char *toString(const QSizeF &s)
{
return qstrdup(QString::fromLatin1("QSizeF(%1x%2)").arg(s.width()).arg(s.height()).toLatin1().constData());
}
template<> inline char *toString(const QRectF &s)
{
return qstrdup(QString::fromLatin1("QRectF(%1,%2 %5x%6) (bottomright %3,%4)").arg(s.left()).arg(s.top()).arg(s.right()).arg(s.bottom()).arg(s.width()).arg(s.height()).toLatin1().constData());
}
template<> inline char *toString(const QUrl &uri)
{
if (!uri.isValid())
return qstrdup(qPrintable(QStringLiteral("Invalid URL: ") + uri.errorString()));
return qstrdup(uri.toEncoded().constData());
}
template<> inline char *toString(const QVariant &v)
{
QByteArray vstring("QVariant(");
if (v.isValid()) {
QByteArray type(v.typeName());
if (type.isEmpty()) {
type = QByteArray::number(v.userType());
}
vstring.append(type);
if (!v.isNull()) {
vstring.append(',');
if (v.canConvert(QVariant::String)) {
vstring.append(qvariant_cast<QString>(v).toLocal8Bit());
}
else {
vstring.append("<value not representable as string>");
}
}
}
vstring.append(')');
return qstrdup(vstring.constData());
}
#ifdef QT_NETWORK_LIB
template<> inline char *toString(const QHostAddress &addr)
{
switch (addr.protocol()) {
case QAbstractSocket::UnknownNetworkLayerProtocol:
return qstrdup("<unknown address (parse error)>");
case QAbstractSocket::AnyIPProtocol:
return qstrdup("QHostAddress::Any");
case QAbstractSocket::IPv4Protocol:
case QAbstractSocket::IPv6Protocol:
break;
}
return qstrdup(addr.toString().toLatin1().constData());
}
#endif
inline char *toString(std::nullptr_t)
{
return toString(QLatin1String("nullptr"));
}
template<>
inline bool qCompare(QString const &t1, QLatin1String const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(t1, QString(t2), actual, expected, file, line);
}
template<>
inline bool qCompare(QLatin1String const &t1, QString const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(QString(t1), t2, actual, expected, file, line);
}
template <typename T>
inline bool qCompare(QList<T> const &t1, QList<T> const &t2, const char *actual, const char *expected,
const char *file, int line)
{
char msg[1024];
msg[0] = '\0';
bool isOk = true;
const int actualSize = t1.count();
const int expectedSize = t2.count();
if (actualSize != expectedSize) {
qsnprintf(msg, sizeof(msg), "Compared lists have different sizes.\n"
" Actual (%s) size: %d\n"
" Expected (%s) size: %d", actual, actualSize, expected, expectedSize);
isOk = false;
}
for (int i = 0; isOk && i < actualSize; ++i) {
if (!(t1.at(i) == t2.at(i))) {
char *val1 = toString(t1.at(i));
char *val2 = toString(t2.at(i));
qsnprintf(msg, sizeof(msg), "Compared lists differ at index %d.\n"
" Actual (%s): %s\n"
" Expected (%s): %s", i, actual, val1 ? val1 : "<null>",
expected, val2 ? val2 : "<null>");
isOk = false;
delete [] val1;
delete [] val2;
}
}
return compare_helper(isOk, msg, Q_NULLPTR, Q_NULLPTR, actual, expected, file, line);
}
template <>
inline bool qCompare(QStringList const &t1, QStringList const &t2, const char *actual, const char *expected,
const char *file, int line)
{
return qCompare<QString>(t1, t2, actual, expected, file, line);
}
template <typename T>
inline bool qCompare(QFlags<T> const &t1, T const &t2, const char *actual, const char *expected,
const char *file, int line)
{
return qCompare(int(t1), int(t2), actual, expected, file, line);
}
template <typename T>
inline bool qCompare(QFlags<T> const &t1, int const &t2, const char *actual, const char *expected,
const char *file, int line)
{
return qCompare(int(t1), t2, actual, expected, file, line);
}
template<>
inline bool qCompare(qint64 const &t1, qint32 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(t1, static_cast<qint64>(t2), actual, expected, file, line);
}
template<>
inline bool qCompare(qint64 const &t1, quint32 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(t1, static_cast<qint64>(t2), actual, expected, file, line);
}
template<>
inline bool qCompare(quint64 const &t1, quint32 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(t1, static_cast<quint64>(t2), actual, expected, file, line);
}
template<>
inline bool qCompare(qint32 const &t1, qint64 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(static_cast<qint64>(t1), t2, actual, expected, file, line);
}
template<>
inline bool qCompare(quint32 const &t1, qint64 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(static_cast<qint64>(t1), t2, actual, expected, file, line);
}
template<>
inline bool qCompare(quint32 const &t1, quint64 const &t2, const char *actual,
const char *expected, const char *file, int line)
{
return qCompare(static_cast<quint64>(t1), t2, actual, expected, file, line);
}
}
QT_END_NAMESPACE
#ifdef QT_TESTCASE_BUILDDIR
# define QTEST_SET_MAIN_SOURCE_PATH QTest::setMainSourcePath(__FILE__, QT_TESTCASE_BUILDDIR);
#else
# define QTEST_SET_MAIN_SOURCE_PATH QTest::setMainSourcePath(__FILE__);
#endif
#define QTEST_APPLESS_MAIN(TestObject) \
int main(int argc, char *argv[]) \
{ \
TestObject tc; \
QTEST_SET_MAIN_SOURCE_PATH \
return QTest::qExec(&tc, argc, argv); \
}
#include <QtTest/qtestsystem.h>
#include <set>
#ifndef QT_NO_OPENGL
# define QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS \
extern Q_TESTLIB_EXPORT std::set<QByteArray> *(*qgpu_features_ptr)(const QString &); \
extern Q_GUI_EXPORT std::set<QByteArray> *qgpu_features(const QString &);
# define QTEST_ADD_GPU_BLACKLIST_SUPPORT \
qgpu_features_ptr = qgpu_features;
#else
# define QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS
# define QTEST_ADD_GPU_BLACKLIST_SUPPORT
#endif
#if defined(QT_WIDGETS_LIB)
#include <QtTest/qtest_widgets.h>
#ifdef QT_KEYPAD_NAVIGATION
# define QTEST_DISABLE_KEYPAD_NAVIGATION QApplication::setNavigationMode(Qt::NavigationModeNone);
#else
# define QTEST_DISABLE_KEYPAD_NAVIGATION
#endif
#define QTEST_MAIN(TestObject) \
QT_BEGIN_NAMESPACE \
QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS \
QT_END_NAMESPACE \
int main(int argc, char *argv[]) \
{ \
QApplication app(argc, argv); \
app.setAttribute(Qt::AA_Use96Dpi, true); \
QTEST_DISABLE_KEYPAD_NAVIGATION \
QTEST_ADD_GPU_BLACKLIST_SUPPORT \
TestObject tc; \
QTEST_SET_MAIN_SOURCE_PATH \
return QTest::qExec(&tc, argc, argv); \
}
#elif defined(QT_GUI_LIB)
#include <QtTest/qtest_gui.h>
#define QTEST_MAIN(TestObject) \
QT_BEGIN_NAMESPACE \
QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS \
QT_END_NAMESPACE \
int main(int argc, char *argv[]) \
{ \
QGuiApplication app(argc, argv); \
app.setAttribute(Qt::AA_Use96Dpi, true); \
QTEST_ADD_GPU_BLACKLIST_SUPPORT \
TestObject tc; \
QTEST_SET_MAIN_SOURCE_PATH \
return QTest::qExec(&tc, argc, argv); \
}
#else
#define QTEST_MAIN(TestObject) \
int main(int argc, char *argv[]) \
{ \
QCoreApplication app(argc, argv); \
app.setAttribute(Qt::AA_Use96Dpi, true); \
TestObject tc; \
QTEST_SET_MAIN_SOURCE_PATH \
return QTest::qExec(&tc, argc, argv); \
}
#endif // QT_GUI_LIB
#define QTEST_GUILESS_MAIN(TestObject) \
int main(int argc, char *argv[]) \
{ \
QCoreApplication app(argc, argv); \
app.setAttribute(Qt::AA_Use96Dpi, true); \
TestObject tc; \
QTEST_SET_MAIN_SOURCE_PATH \
return QTest::qExec(&tc, argc, argv); \
}
#endif