1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QBENCHMARK_H
41 #define QBENCHMARK_H
42 
43 #include <QtTest/qttestglobal.h>
44 #include <QtTest/qbenchmarkmetric.h>
45 
46 QT_BEGIN_NAMESPACE
47 
48 
49 namespace QTest
50 {
51 
52 //
53 //  W A R N I N G
54 //  -------------
55 //
56 // The QBenchmarkIterationController class is not a part of the
57 // Qt Test API. It exists purely as an implementation detail.
58 //
59 //
60 class Q_TESTLIB_EXPORT QBenchmarkIterationController
61 {
62 public:
63     enum RunMode { RepeatUntilValidMeasurement, RunOnce };
64     QBenchmarkIterationController();
65     QBenchmarkIterationController(RunMode runMode);
66     ~QBenchmarkIterationController();
67     bool isDone();
68     void next();
69     int i;
70 };
71 
72 }
73 
74 // --- BEGIN public API ---
75 
76 #define QBENCHMARK \
77     for (QTest::QBenchmarkIterationController __iteration_controller; \
78             __iteration_controller.isDone() == false; __iteration_controller.next())
79 
80 #define QBENCHMARK_ONCE \
81     for (QTest::QBenchmarkIterationController __iteration_controller(QTest::QBenchmarkIterationController::RunOnce); \
82             __iteration_controller.isDone() == false; __iteration_controller.next())
83 
84 namespace QTest
85 {
86     void Q_TESTLIB_EXPORT setBenchmarkResult(qreal result, QBenchmarkMetric metric);
87 }
88 
89 // --- END public API ---
90 
91 QT_END_NAMESPACE
92 
93 #endif // QBENCHMARK_H
94