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