Reporter.h

/*
 * Copyright (C) 2005-2006 by Dr. Marc Boris Duerner
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef PT_UNIT_REPORTER_H
#define PT_UNIT_REPORTER_H

#include <Pt/Unit/Api.h>
#include <Pt/Unit/Assertion.h>
#include <Pt/Unit/TestContext.h>
#include <Pt/NonCopyable.h>
#include <vector>
#include <iosfwd>
#include <stdexcept>

namespace Pt {

namespace Unit {

class Test;

class PT_UNIT_API Reporter : protected NonCopyable
{
    friend class Test;

    public:
        virtual ~Reporter();

        virtual void reportStart(const TestContext& test) = 0;

        virtual void reportFinish(const TestContext& test) = 0;

        virtual void reportMessage(const std::string& msg) = 0;

        virtual void reportSuccess(const TestContext& test) = 0;

        virtual void reportAssertion(const TestContext& test, const Assertion& a) = 0;

        virtual void reportException(const TestContext& test, const std::exception& ex) = 0;

        virtual void reportError(const TestContext& test) = 0;

    protected:
        Reporter()
        {}

        void attachTest(Test& test);

        void detachTest(Test& test);

    private:
        std::vector<Test*> _attachedTests;
};


class PT_UNIT_API BriefReporter : public Reporter
{
    public:
        explicit BriefReporter(std::ostream* out = &std::cout);

        virtual ~BriefReporter();

        void setOutput(std::ostream& out);

        virtual void reportStart(const TestContext& test);

        virtual void reportFinish(const TestContext& test);

        virtual void reportMessage(const std::string& msg);

        virtual void reportSuccess(const TestContext& test);

        virtual void reportAssertion(const TestContext& test, const Assertion& a);

        virtual void reportException(const TestContext& test, const std::exception& ex);

        virtual void reportError(const TestContext& test);

    private:
        std::ostream* _out;
};

} // namespace Unit

} // namespace Pt

#endif