xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/core/utils/logging/IPrinter.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2019 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_LOGGING_PRINTER_H
25 #define ARM_COMPUTE_LOGGING_PRINTER_H
26 
27 #include "support/Mutex.h"
28 
29 namespace arm_compute
30 {
31 namespace logging
32 {
33 /** Base printer class to be inherited by other printer classes */
34 class Printer
35 {
36 public:
37     /** Default Constructor */
Printer()38     Printer() noexcept
39         : _mtx()
40     {
41     }
42     /** Prevent instances of this class from being copied */
43     Printer(const Printer &) = delete;
44     /** Prevent instances of this class from being copied */
45     Printer &operator=(const Printer &) = delete;
46     /** Prevent instances of this class from being moved */
47     Printer(Printer &&) = delete;
48     /** Prevent instances of this class from being moved */
49     Printer &operator=(Printer &&) = delete;
50     /** Defaults Destructor */
51     virtual ~Printer() = default;
52     /** Print message
53      *
54      * @param[in] msg Message to print
55      */
print(const std::string & msg)56     inline void print(const std::string &msg)
57     {
58         arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
59         print_internal(msg);
60     }
61 
62 private:
63     /** Interface to be implemented by the child to print a message
64      *
65      * @param[in] msg Message to print
66      */
67     virtual void print_internal(const std::string &msg) = 0;
68 
69 private:
70     arm_compute::Mutex _mtx;
71 };
72 } // namespace logging
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_LOGGING_PRINTER_H */
75