1/****************************************************************************
2**
3** Copyright (C) 2014 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
48QT_BEGIN_HEADER
49
50QT_BEGIN_NAMESPACE
51
52QT_MODULE(Test)
53
54namespace 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//
65class Q_TESTLIB_EXPORT QBenchmarkIterationController
66{
67public:
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
89namespace QTest
90{
91 void Q_TESTLIB_EXPORT setBenchmarkResult(qreal result, QBenchmarkMetric metric);
92}
93
94// --- END public API ---
95
96QT_END_NAMESPACE
97
98QT_END_HEADER
99
100#endif // QBENCHMARK_H
101