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/noncopyable.h" 34 35 // appleseed.main headers. 36 #include "main/dllsymbol.h" 37 38 // Forward declarations. 39 namespace foundation { class BenchmarkResult; } 40 namespace foundation { class IBenchmarkCaseFactory; } 41 namespace foundation { class IFilter; } 42 43 namespace foundation 44 { 45 46 // 47 // A benchmark suite, as a collection of benchmarks. 48 // 49 50 class APPLESEED_DLLSYMBOL BenchmarkSuite 51 : public NonCopyable 52 { 53 public: 54 // Constructor. 55 explicit BenchmarkSuite(const char* name); 56 57 // Destructor. 58 ~BenchmarkSuite(); 59 60 // Return the name of the benchmark suite. 61 const char* get_name() const; 62 63 // Register a benchmark case (via its factory function). 64 void register_case(IBenchmarkCaseFactory* factory); 65 66 // Run all the registered benchmark cases. 67 void run(BenchmarkResult& suite_result) const; 68 69 // Run those benchmark cases whose name pass a given filter. 70 void run( 71 const IFilter& filter, 72 BenchmarkResult& suite_result) const; 73 74 private: 75 struct Impl; 76 Impl* impl; 77 }; 78 79 } // namespace foundation 80