xref: /aosp_15_r20/external/ComputeLibrary/tests/framework/printers/PrettyPrinter.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017,2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_TEST_PRETTYPRINTER
25 #define ARM_COMPUTE_TEST_PRETTYPRINTER
26 
27 #include "Printer.h"
28 
29 namespace arm_compute
30 {
31 namespace test
32 {
33 namespace framework
34 {
35 /** Implementation of a @ref Printer that produces human readable output. */
36 class PrettyPrinter : public Printer
37 {
38 public:
39     using Printer::Printer;
40 
41     /** Set if the output is colored.
42      *
43      * @param[in] color_output True if the output is colored.
44      */
45     void set_color_output(bool color_output);
46 
47     void print_entry(const std::string &name, const std::string &value) override;
48     void print_global_header() override;
49     void print_global_footer() override;
50     void print_run_header() override;
51     void print_run_footer() override;
52     void print_test_header(const TestInfo &info) override;
53     void print_test_footer() override;
54     void print_errors_header() override;
55     void print_errors_footer() override;
56     void print_error(const std::exception &error, bool expected) override;
57     void print_info(const std::string &info) override;
58     void print_profiler_header(const std::string &header_data) override;
59     void print_measurements(const Profiler::MeasurementsMap &measurements) override;
60     void print_list_tests(const std::vector<TestInfo> &infos) override;
61 
62 private:
63     std::string begin_color(const std::string &color) const;
64     std::string end_color() const;
65 
66     bool _color_output{ true };
67 };
68 } // namespace framework
69 } // namespace test
70 } // namespace arm_compute
71 
72 #endif /* ARM_COMPUTE_TEST_PRETTYPRINTER */
73