Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: include/AdblockPlus/LogSystem.h

Issue 5728380594946048: Issue 116 - Document the libadblockplus API (Closed)
Left Patch Set: Addressed comments Created Aug. 28, 2014, 10:54 p.m.
Right Patch Set: Write libadblockplus in lower case consistently Created Sept. 2, 2014, 2:18 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Right: Side by side diff | Download
« no previous file with change/comment | « include/AdblockPlus/JsValue.h ('k') | include/AdblockPlus/ReferrerMapping.h » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
(no file at all)
1 /* 1 /*
2 * This file is part of Adblock Plus <http://adblockplus.org/>, 2 * This file is part of Adblock Plus <http://adblockplus.org/>,
3 * Copyright (C) 2006-2014 Eyeo GmbH 3 * Copyright (C) 2006-2014 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 <string>
22 22
23 #include "tr1_memory.h" 23 #include "tr1_memory.h"
24 24
25 namespace AdblockPlus 25 namespace AdblockPlus
26 { 26 {
27 /**
28 * Logging interface.
29 */
27 class LogSystem 30 class LogSystem
28 { 31 {
29 public: 32 public:
33 /**
34 * Log level.
35 */
30 enum LogLevel {LOG_LEVEL_TRACE, LOG_LEVEL_LOG, LOG_LEVEL_INFO, LOG_LEVEL_WAR N, LOG_LEVEL_ERROR}; 36 enum LogLevel {LOG_LEVEL_TRACE, LOG_LEVEL_LOG, LOG_LEVEL_INFO, LOG_LEVEL_WAR N, LOG_LEVEL_ERROR};
31 37
32 virtual ~LogSystem() {} 38 virtual ~LogSystem() {}
39
40 /**
41 * Writes a log message.
42 * @param logLevel Log level.
43 * @param message Log message.
44 * @param source Source of the message, e.g. file name and line.
45 * Ignored when empty.
46 */
33 virtual void operator()(LogLevel logLevel, const std::string& message, 47 virtual void operator()(LogLevel logLevel, const std::string& message,
34 const std::string& source) = 0; 48 const std::string& source) = 0;
35 }; 49 };
36 50
51 /**
52 * Shared smart pointer to a `LogSystem` instance.
53 */
37 typedef std::tr1::shared_ptr<LogSystem> LogSystemPtr; 54 typedef std::tr1::shared_ptr<LogSystem> LogSystemPtr;
38 } 55 }
39 56
40 #endif 57 #endif
LEFTRIGHT

Powered by Google App Engine
This is Rietveld