src/testlib/qtestresult_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtTest module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTESTRESULT_P_H
  43 #define QTESTRESULT_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtTest/qtest_global.h>
  57
  58 QT_BEGIN_NAMESPACE
  59
  60 class QTestResultPrivate;
  61 class QTestData;
  62
  63 class QTestResult
  64 {
  65 public:
  66     enum TestLocation { NoWhere = 0, DataFunc = 1, InitFunc = 2, Func = 3, CleanupFunc = 4 };
  67
  68     static const char *currentTestObjectName();
  69     static bool currentTestFailed();
  70     static bool allDataPassed();
  71     static QTestData *currentTestData();
  72     static QTestData *currentGlobalTestData();
  73     static const char *currentTestFunction();
  74     static TestLocation currentTestLocation();
  75     static const char *currentDataTag();
  76     static const char *currentGlobalDataTag();
  77     static void finishedCurrentTestFunction();
  78     static void reset();
  79
  80     static int passCount();
  81     static int failCount();
  82     static int skipCount();
  83
  84     static void ignoreMessage(QtMsgType type, const char *msg);
  85
  86     static void addFailure(const char *message, const char *file, int line);
  87     static bool compare(bool success, const char *msg, const char *file, int line);
  88     static bool compare(bool success, const char *msg, char *val1, char *val2,
  89                         const char *actual, const char *expected, const char *file, int line);
  90
  91     static void setCurrentGlobalTestData(QTestData *data);
  92     static void setCurrentTestData(QTestData *data);
  93     static void setCurrentTestFunction(const char *func);
  94     static void setCurrentTestLocation(TestLocation loc);
  95     static void setCurrentTestObject(const char *name);
  96     static void addSkip(const char *message, QTest::SkipMode mode,
  97                         const char *file, int line);
  98     static bool expectFail(const char *dataIndex, const char *comment,
  99                            QTest::TestFailMode mode, const char *file, int line);
 100     static bool verify(bool statement, const char *statementStr, const char *extraInfo,
 101                        const char *file, int line);
 102     static bool testFailed();
 103     static void setSkipCurrentTest(bool value);
 104     static bool skipCurrentTest();
 105
 106 private:
 107     Q_DISABLE_COPY(QTestResult)
 108 };
 109
 110 QT_END_NAMESPACE
 111
 112 #endif