reporter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2006 by Dr. Marc Boris Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 #ifndef CXXTOOLS_UNIT_REPORTER_H
29 #define CXXTOOLS_UNIT_REPORTER_H
30 
33 #include <cxxtools/signal.h>
34 #include <cxxtools/noncopyable.h>
35 #include <iosfwd>
36 #include <stdexcept>
37 
38 namespace cxxtools {
39 
40 namespace unit {
41 
49 class Reporter : protected NonCopyable
50 {
51  public:
54  virtual ~Reporter()
55  { destroyed.send(*this);}
56 
64  virtual void reportStart(const TestContext& test) = 0;
65 
73  virtual void reportFinish(const TestContext& test) = 0;
74 
82  virtual void reportMessage(const std::string& msg) = 0;
83 
90  virtual void reportSuccess(const TestContext& test) = 0;
91 
99  virtual void reportAssertion(const TestContext& test, const Assertion& a) = 0;
100 
109  virtual void reportException(const TestContext& test, const std::exception& ex) = 0;
110 
118  virtual void reportError(const TestContext& test) = 0;
119 
120  Signal<Reporter&> destroyed;
121 
122  protected:
126  {}
127 };
128 
129 
130 class BriefReporter : public Reporter
131 {
132  public:
133  explicit BriefReporter(std::ostream* out = &std::cout);
134 
135  virtual ~BriefReporter();
136 
137  void setOutput(std::ostream& out);
138 
139  virtual void reportStart(const TestContext& test);
140 
141  virtual void reportFinish(const TestContext& test);
142 
143  virtual void reportMessage(const std::string& msg);
144 
145  virtual void reportSuccess(const TestContext& test);
146 
147  virtual void reportAssertion(const TestContext& test, const Assertion& a);
148 
149  virtual void reportException(const TestContext& test, const std::exception& ex);
150 
151  virtual void reportError(const TestContext& test);
152 
153  private:
156  std::ostream* _out;
157 };
158 
159 } // namespace unit
160 
161 } // namespace cxxtools
162 
163 #endif