1 
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29 
30 #pragma once
31 
32 // appleseed.foundation headers.
33 #include "foundation/core/concepts/iunknown.h"
34 
35 // appleseed.main headers.
36 #include "main/dllsymbol.h"
37 
38 // Standard headers.
39 #include <cstddef>
40 
41 // Forward declarations.
42 namespace foundation    { class BenchmarkSuite; }
43 namespace foundation    { class IBenchmarkCase; }
44 namespace foundation    { class TimingResult; }
45 
46 namespace foundation
47 {
48 
49 //
50 // Interface of a benchmark listener.
51 //
52 
53 class APPLESEED_DLLSYMBOL IBenchmarkListener
54   : public IUnknown
55 {
56   public:
57     // Called before each benchmark suite is run.
58     virtual void begin_suite(
59         const BenchmarkSuite&   benchmark_suite) = 0;
60 
61     // Called after each benchmark suite is run.
62     virtual void end_suite(
63         const BenchmarkSuite&   benchmark_suite) = 0;
64 
65     // Called before each benchmark case is run.
66     virtual void begin_case(
67         const BenchmarkSuite&   benchmark_suite,
68         const IBenchmarkCase&   benchmark_case) = 0;
69 
70     // Called after each benchmark case is run.
71     virtual void end_case(
72         const BenchmarkSuite&   benchmark_suite,
73         const IBenchmarkCase&   benchmark_case) = 0;
74 
75     // Write a message.
76     virtual void write(
77         const BenchmarkSuite&   benchmark_suite,
78         const IBenchmarkCase&   benchmark_case,
79         const char*             file,
80         const size_t            line,
81         const char*             message) = 0;
82 
83     // Write a timing result.
84     virtual void write(
85         const BenchmarkSuite&   benchmark_suite,
86         const IBenchmarkCase&   benchmark_case,
87         const char*             file,
88         const size_t            line,
89         const TimingResult&     timing_result) = 0;
90 };
91 
92 }   // namespace foundation
93