logger.h Source File - ClanLib SDK
Description: logger.h Source File

logger.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 The ClanLib Team
4**
5** This software is provided 'as-is', without any express or implied
6** warranty. In no event will the authors be held liable for any damages
7** arising from the use of this software.
8**
9** Permission is granted to anyone to use this software for any purpose,
10** including commercial applications, and to alter it and redistribute it
11** freely, subject to the following restrictions:
12**
13** 1. The origin of this software must not be misrepresented; you must not
14** claim that you wrote the original software. If you use this software
15** in a product, an acknowledgment in the product documentation would be
16** appreciated but is not required.
17** 2. Altered source versions must be plainly marked as such, and must not be
18** misrepresented as being the original software.
19** 3. This notice may not be removed or altered from any source distribution.
20**
21** Note: Some of the libraries ClanLib may link to may have additional
22** requirements or restrictions.
23**
24** File Author(s):
25**
26** Magnus Norddahl
27*/
28
29#pragma once
30
31#include "string_format.h"
32#include "string_help.h"
33#include <mutex>
34
35namespace clan
36{
39
41 class Logger
42 {
43 public:
45 Logger();
46 virtual ~Logger();
47
49 static std::vector<Logger*> instances;
50
52 static std::recursive_mutex mutex;
53
55 void enable();
56
58 void disable();
59
61 virtual void log(const std::string &type, const std::string &text) = 0;
62
63 protected:
64 static StringFormat get_log_string(const std::string &type, const std::string &text);
65 };
66
69 void log_event(const std::string &type, const std::string &text);
70
71 template <class Arg1>
72 void log_event(const std::string &type, const std::string &format, Arg1 arg1)
73 {
74 StringFormat f(format); f.set_arg(1, arg1); log_event(type, f.get_result());
75 }
76
77 template <class Arg1, class Arg2>
78 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2)
79 {
80 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); log_event(type, f.get_result());
81 }
82
83 template <class Arg1, class Arg2, class Arg3>
84 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2, Arg3 arg3)
85 {
86 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); f.set_arg(3, arg3); log_event(type, f.get_result());
87 }
88
89 template <class Arg1, class Arg2, class Arg3, class Arg4>
90 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
91 {
92 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); f.set_arg(3, arg3); f.set_arg(4, arg4); log_event(type, f.get_result());
93 }
94
95 template <class Arg1, class Arg2, class Arg3, class Arg4, class Arg5>
96 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4, Arg5 arg5)
97 {
98 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); f.set_arg(3, arg3); f.set_arg(4, arg4); f.set_arg(5, arg5); log_event(type, f.get_result());
99 }
100
101 template <class Arg1, class Arg2, class Arg3, class Arg4, class Arg5, class Arg6>
102 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4, Arg5 arg5, Arg6 arg6)
103 {
104 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); f.set_arg(3, arg3); f.set_arg(4, arg4); f.set_arg(5, arg5); f.set_arg(6, arg6); log_event(type, f.get_result());
105 }
106
107 template <class Arg1, class Arg2, class Arg3, class Arg4, class Arg5, class Arg6, class Arg7>
108 void log_event(const std::string &type, const std::string &format, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4, Arg5 arg5, Arg6 arg6, Arg7 arg7)
109 {
110 StringFormat f(format); f.set_arg(1, arg1); f.set_arg(2, arg2); f.set_arg(3, arg3); f.set_arg(4, arg4); f.set_arg(5, arg5); f.set_arg(6, arg6); f.set_arg(7, arg7); log_event(type, f.get_result());
111 }
112
114}
115
clan::Logger::get_log_string
static StringFormat get_log_string(const std::string &type, const std::string &text)
clan::Logger::enable
void enable()
Enable logger for logging.
clan::Logger::instances
static std::vector< Logger * > instances
Pointers to currently enabled logger.
Definition logger.h:49
clan::Logger::log
virtual void log(const std::string &type, const std::string &text)=0
Log text.
clan::Logger::disable
void disable()
Disable logging.
clan::Logger::mutex
static std::recursive_mutex mutex
Logger mutex object.
Definition logger.h:52
clan::Logger::Logger
Logger()
Constructs a logger.
clan::Logger::~Logger
virtual ~Logger()
clan::StringFormat
String formatting class.
Definition string_format.h:71
clan::log_event
void log_event(const std::string &type, const std::string &text)
Log text to logger.
clan
Definition clanapp.h:36
clan::Key::f
@ f
Definition keys.h:86