src/testlib/qbenchmark.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 QBENCHMARK_H
  43 #define QBENCHMARK_H
  44
  45 #include <QtTest/qtest_global.h>
  46 #include <QtTest/private/qbenchmarkmetric_p.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Test)
  53
  54 namespace QTest
  55 {
  56
  57 //
  58 //  W A R N I N G
  59 //  -------------
  60 //
  61 // The QBenchmarkIterationController class is not a part of the
  62 // QTestlib API. It exists purely as an implementation detail.
  63 //
  64 //
  65 class Q_TESTLIB_EXPORT QBenchmarkIterationController
  66 {
  67 public:
  68     enum RunMode { RepeatUntilValidMeasurement, RunOnce };
  69     QBenchmarkIterationController();
  70     QBenchmarkIterationController(RunMode runMode);
  71     ~QBenchmarkIterationController();
  72     bool isDone();
  73     void next();
  74     int i;
  75 };
  76
  77 }
  78
  79 // --- BEGIN public API ---
  80
  81 #define QBENCHMARK \
  82     for (QTest::QBenchmarkIterationController __iteration_controller; \
  83             __iteration_controller.isDone() == false; __iteration_controller.next())
  84
  85 #define QBENCHMARK_ONCE \
  86     for (QTest::QBenchmarkIterationController __iteration_controller(QTest::QBenchmarkIterationController::RunOnce); \
  87             __iteration_controller.isDone() == false; __iteration_controller.next())
  88
  89 namespace QTest
  90 {
  91     void Q_TESTLIB_EXPORT setBenchmarkResult(qreal result, QBenchmarkMetric metric);
  92 }
  93
  94 // --- END public API ---
  95
  96 QT_END_NAMESPACE
  97
  98 QT_END_HEADER
  99
 100 #endif // QBENCHMARK_H