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 QABSTRACTTESTLOGGER_P_H
43#define QABSTRACTTESTLOGGER_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 <qglobal.h>
57
58QT_BEGIN_NAMESPACE
59
60class QBenchmarkResult;
61
62class QAbstractTestLogger
63{
64public:
65 enum IncidentTypes {
66 Pass,
67 XFail,
68 Fail,
69 XPass
70 };
71
72 enum MessageTypes {
73 Warn,
74 QWarning,
75 QDebug,
76 QSystem,
77 QFatal,
78 Skip,
79 Info
80 };
81
82 QAbstractTestLogger() {}
83 virtual ~QAbstractTestLogger() {}
84
85 virtual void startLogging();
86 virtual void stopLogging();
87
88 virtual void enterTestFunction(const char *function) = 0;
89 virtual void leaveTestFunction() = 0;
90
91 virtual void addIncident(IncidentTypes type, const char *description,
92 const char *file = 0, int line = 0) = 0;
93 virtual void addBenchmarkResult(const QBenchmarkResult &result) = 0;
94
95 virtual void addMessage(MessageTypes type, const char *message,
96 const char *file = 0, int line = 0) = 0;
97
98 virtual void registerRandomSeed(unsigned int seed) = 0;
99
100 static void outputString(const char *msg);
101 static bool isTtyOutput();
102};
103
104struct QTestCharBuffer
105{
106 enum { InitialSize = 512 };
107
108 inline QTestCharBuffer()
109 : _size(InitialSize), buf(staticBuf)
110 {
111 staticBuf[0] = '\0';
112 }
113
114 inline ~QTestCharBuffer()
115 {
116 if (buf != staticBuf)
117 qFree(buf);
118 }
119
120 inline char *data()
121 {
122 return buf;
123 }
124
125 inline char **buffer()
126 {
127 return &buf;
128 }
129
130 inline const char* constData() const
131 {
132 return buf;
133 }
134
135 inline int size() const
136 {
137 return _size;
138 }
139
140 inline bool reset(int newSize)
141 {
142 char *newBuf = 0;
143 if (buf == staticBuf) {
144 // if we point to our internal buffer, we need to malloc first
145 newBuf = reinterpret_cast<char *>(qMalloc(newSize));
146 } else {
147 // if we already malloc'ed, just realloc
148 newBuf = reinterpret_cast<char *>(qRealloc(buf, newSize));
149 }
150
151 // if the allocation went wrong (newBuf == 0), we leave the object as is
152 if (!newBuf)
153 return false;
154
155 _size = newSize;
156 buf = newBuf;
157 return true;
158 }
159
160private:
161 int _size;
162 char* buf;
163 char staticBuf[InitialSize];
164};
165
166namespace QTest
167{
168 int qt_asprintf(QTestCharBuffer *buf, const char *format, ...);
169}
170
171
172QT_END_NAMESPACE
173
174#endif
175