LEFT | RIGHT |
1 /* | 1 /* |
2 * This file is part of Adblock Plus <http://adblockplus.org/>, | 2 * This file is part of Adblock Plus <https://adblockplus.org/>, |
3 * Copyright (C) 2006-2014 Eyeo GmbH | 3 * Copyright (C) 2006-2015 Eyeo GmbH |
4 * | 4 * |
5 * Adblock Plus is free software: you can redistribute it and/or modify | 5 * Adblock Plus is free software: you can redistribute it and/or modify |
6 * it under the terms of the GNU General Public License version 3 as | 6 * it under the terms of the GNU General Public License version 3 as |
7 * published by the Free Software Foundation. | 7 * published by the Free Software Foundation. |
8 * | 8 * |
9 * Adblock Plus is distributed in the hope that it will be useful, | 9 * Adblock Plus is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
13 * | 13 * |
14 * You should have received a copy of the GNU General Public License | 14 * You should have received a copy of the GNU General Public License |
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. | 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
16 */ | 16 */ |
17 | 17 |
18 #ifndef ADBLOCK_PLUS_LOG_SYSTEM_H | 18 #ifndef ADBLOCK_PLUS_LOG_SYSTEM_H |
19 #define ADBLOCK_PLUS_LOG_SYSTEM_H | 19 #define ADBLOCK_PLUS_LOG_SYSTEM_H |
20 | 20 |
| 21 #include <string> |
21 #include <memory> | 22 #include <memory> |
22 #include <string> | |
23 | 23 |
24 namespace AdblockPlus | 24 namespace AdblockPlus |
25 { | 25 { |
| 26 /** |
| 27 * Logging interface. |
| 28 */ |
26 class LogSystem | 29 class LogSystem |
27 { | 30 { |
28 public: | 31 public: |
| 32 /** |
| 33 * Log level. |
| 34 */ |
29 enum LogLevel {LOG_LEVEL_TRACE, LOG_LEVEL_LOG, LOG_LEVEL_INFO, LOG_LEVEL_WAR
N, LOG_LEVEL_ERROR}; | 35 enum LogLevel {LOG_LEVEL_TRACE, LOG_LEVEL_LOG, LOG_LEVEL_INFO, LOG_LEVEL_WAR
N, LOG_LEVEL_ERROR}; |
30 | 36 |
31 virtual ~LogSystem() {} | 37 virtual ~LogSystem() {} |
| 38 |
| 39 /** |
| 40 * Writes a log message. |
| 41 * @param logLevel Log level. |
| 42 * @param message Log message. |
| 43 * @param source Source of the message, e.g. file name and line. |
| 44 * Ignored when empty. |
| 45 */ |
32 virtual void operator()(LogLevel logLevel, const std::string& message, | 46 virtual void operator()(LogLevel logLevel, const std::string& message, |
33 const std::string& source) = 0; | 47 const std::string& source) = 0; |
34 }; | 48 }; |
35 | 49 |
| 50 /** |
| 51 * Shared smart pointer to a `LogSystem` instance. |
| 52 */ |
36 typedef std::shared_ptr<LogSystem> LogSystemPtr; | 53 typedef std::shared_ptr<LogSystem> LogSystemPtr; |
37 } | 54 } |
38 | 55 |
39 #endif | 56 #endif |
LEFT | RIGHT |