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