src/testlib/qtestlog_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtTest module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTESTLOG_P_H
  43 #define QTESTLOG_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 QBenchmarkResult;
  61
  62 class Q_TESTLIB_EXPORT QTestLog
  63 {
  64 public:
  65     enum LogMode { Plain = 0, XML, LightXML, XunitXML };
  66
  67     static void enterTestFunction(const char* function);
  68     static void leaveTestFunction();
  69
  70     static void addPass(const char *msg);
  71     static void addFail(const char *msg, const char *file, int line);
  72     static void addXFail(const char *msg, const char *file, int line);
  73     static void addXPass(const char *msg, const char *file, int line);
  74     static void addSkip(const char *msg, const char *file, int line);
  75     static void addBenchmarkResult(const QBenchmarkResult &result);
  76
  77     static void ignoreMessage(QtMsgType type, const char *msg);
  78     static int unhandledIgnoreMessages();
  79     static void printUnhandledIgnoreMessages();
  80     static void clearIgnoreMessages();
  81
  82     static void warn(const char *msg, const char *file, int line);
  83     static void info(const char *msg, const char *file, int line);
  84
  85     static void startLogging();
  86     static void stopLogging();
  87
  88     static void addLogger(LogMode mode, const char *filename);
  89
  90     static int loggerCount();
  91     static bool loggerUsingStdout();
  92
  93     static void setVerboseLevel(int level);
  94     static int verboseLevel();
  95
  96     static void setMaxWarnings(int max);
  97
  98     static void setPrintAvailableTagsMode();
  99
 100     static int passCount();
 101     static int failCount();
 102     static int skipCount();
 103
 104     static void resetCounters();
 105
 106     static void setInstalledTestCoverage(bool installed);
 107     static bool installedTestCoverage();
 108
 109 private:
 110     QTestLog();
 111     ~QTestLog();
 112
 113     static bool printAvailableTags;
 114 };
 115
 116 QT_END_NAMESPACE
 117
 118 #endif