/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtTest module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QABSTRACTTESTLOGGER_P_H

#define QABSTRACTTESTLOGGER_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include <qglobal.h>

QT_BEGIN_NAMESPACE

class QBenchmarkResult;

class QAbstractTestLogger

{

public:

    enum IncidentTypes {

        Pass,

        XFail,

        Fail,

        XPass

    };

    enum MessageTypes {

        Warn,

        QWarning,

        QDebug,

        QSystem,

        QFatal,

        Skip,

        Info

    };

    QAbstractTestLogger() {}

    virtual ~QAbstractTestLogger() {}

    virtual void startLogging();

    virtual void stopLogging();

    virtual void enterTestFunction(const char *function) = 0;

    virtual void leaveTestFunction() = 0;

    virtual void addIncident(IncidentTypes type, const char *description,

                             const char *file = 0, int line = 0) = 0;

    virtual void addBenchmarkResult(const QBenchmarkResult &result) = 0;

    virtual void addMessage(MessageTypes type, const char *message,

                            const char *file = 0, int line = 0) = 0;

    static void outputString(const char *msg);

    static bool isTtyOutput();

};

struct QTestCharBuffer

{

    enum { InitialSize = 512 };

    inline QTestCharBuffer()

            : _size(InitialSize), buf(staticBuf)

    {

        staticBuf[0] = '\0';

    }

    inline ~QTestCharBuffer()

    {

        if (buf != staticBuf)

            qFree(buf);

    }

    inline char *data()

    {

        return buf;

    }

    inline char **buffer()

    {

        return &buf;

    }

    inline const char* constData() const

    {

        return buf;

    }

    inline int size() const

    {

        return _size;

    }

    inline bool reset(int newSize)

    {

        char *newBuf = 0;

        if (buf == staticBuf) {

            // if we point to our internal buffer, we need to malloc first

            newBuf = reinterpret_cast<char *>(qMalloc(newSize));

        } else {

            // if we already malloc'ed, just realloc

            newBuf = reinterpret_cast<char *>(qRealloc(buf, newSize));

        }

        // if the allocation went wrong (newBuf == 0), we leave the object as is

        if (!newBuf)

            return false;

        _size = newSize;

        buf = newBuf;

        return true;

    }

private:

    int _size;

    char* buf;

    char staticBuf[InitialSize];

};

namespace QTest

{

    int qt_asprintf(QTestCharBuffer *buf, const char *format, ...);

}

QT_END_NAMESPACE

#endif